File indexing completed on 2024-05-12 03:54:55

 /*
     This file is part of the KDE libraries
 
     SPDX-FileCopyrightText: 2007 Oswald Buddenhagen <ossi@kde.org>
     SPDX-FileCopyrightText: 2022 Harald Sitter <sitter@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #include "kcoreaddons_debug.h"
 #include "kprocess_p.h"
 
 #include <QStandardPaths>
 #include <kshell.h>
 #include <qplatformdefs.h>
 #ifdef Q_OS_WIN
 #include <kshell_p.h>
 #include <qt_windows.h>
 #endif
 
 #include <QFile>
 
 /////////////////////////////
 // public member functions //
 /////////////////////////////
 
 KProcess::KProcess(QObject *parent)
     : QProcess(parent)
     , d_ptr(new KProcessPrivate(this))
 {
     setOutputChannelMode(ForwardedChannels);
 }
 
 KProcess::KProcess(KProcessPrivate *d, QObject *parent)
     : QProcess(parent)
     , d_ptr(d)
 {
     d_ptr->q_ptr = this;
     setOutputChannelMode(ForwardedChannels);
 }
 
 KProcess::~KProcess() = default;
 
 void KProcess::setOutputChannelMode(OutputChannelMode mode)
 {
     QProcess::setProcessChannelMode(static_cast<ProcessChannelMode>(mode));
 }
 
 KProcess::OutputChannelMode KProcess::outputChannelMode() const
 {
     return static_cast<OutputChannelMode>(QProcess::processChannelMode());
 }
 
 void KProcess::setNextOpenMode(QIODevice::OpenMode mode)
 {
     Q_D(KProcess);
 
     d->openMode = mode;
 }
 
 #define DUMMYENV "_KPROCESS_DUMMY_="
 
 void KProcess::clearEnvironment()
 {
     setEnvironment(QStringList{QStringLiteral(DUMMYENV)});
 }
 
 void KProcess::setEnv(const QString &name, const QString &value, bool overwrite)
 {
     QStringList env = environment();
     if (env.isEmpty()) {
         env = systemEnvironment();
         env.removeAll(QStringLiteral(DUMMYENV));
     }
     QString fname(name);
     fname.append(QLatin1Char('='));
     auto it = std::find_if(env.begin(), env.end(), [&fname](const QString &s) {
         return s.startsWith(fname);
     });
     if (it != env.end()) {
         if (overwrite) {
             *it = fname.append(value);
             setEnvironment(env);
         }
         return;
     }
 
     env.append(fname.append(value));
     setEnvironment(env);
 }
 
 void KProcess::unsetEnv(const QString &name)
 {
     QStringList env = environment();
     if (env.isEmpty()) {
         env = systemEnvironment();
         env.removeAll(QStringLiteral(DUMMYENV));
     }
     QString fname(name);
     fname.append(QLatin1Char('='));
 
     auto it = std::find_if(env.begin(), env.end(), [&fname](const QString &s) {
         return s.startsWith(fname);
     });
     if (it != env.end()) {
         env.erase(it);
         if (env.isEmpty()) {
             env.append(QStringLiteral(DUMMYENV));
         }
         setEnvironment(env);
     }
 }
 
 void KProcess::setProgram(const QString &exe, const QStringList &args)
 {
     QProcess::setProgram(exe);
     QProcess::setArguments(args);
 #ifdef Q_OS_WIN
     setNativeArguments(QString());
 #endif
 }
 
 void KProcess::setProgram(const QStringList &argv)
 {
     if (argv.isEmpty()) {
         qCWarning(KCOREADDONS_DEBUG) << "KProcess::setProgram(const QStringList &argv) called on an empty string list, no process will be started.";
         clearProgram();
         return;
     }
 
     QStringList args = argv;
     QProcess::setProgram(args.takeFirst());
     QProcess::setArguments(args);
 #ifdef Q_OS_WIN
     setNativeArguments(QString());
 #endif
 }
 
 KProcess &KProcess::operator<<(const QString &arg)
 {
     if (QProcess::program().isEmpty()) {
         QProcess::setProgram(arg);
     } else {
         setArguments(arguments() << arg);
     }
     return *this;
 }
 
 KProcess &KProcess::operator<<(const QStringList &args)
 {
     if (QProcess::program().isEmpty()) {
         setProgram(args);
     } else {
         setArguments(arguments() << args);
     }
     return *this;
 }
 
 void KProcess::clearProgram()
 {
     QProcess::setProgram({});
     QProcess::setArguments({});
 #ifdef Q_OS_WIN
     setNativeArguments(QString());
 #endif
 }
 
 // #ifdef NON_FREE // ... as they ship non-POSIX /bin/sh
 #if !defined(__linux__) && !defined(__FreeBSD__) && !defined(__NetBSD__) && !defined(__OpenBSD__) && !defined(__DragonFly__) && !defined(__GNU__)              \
     && !defined(__APPLE__)
 const static bool s_nonFreeUnix = true;
 #else
 const static bool s_nonFreeUnix = false;
 #endif
 
 void KProcess::setShellCommand(const QString &cmd)
 {
     KShell::Errors err = KShell::NoError;
     auto args = KShell::splitArgs(cmd, KShell::AbortOnMeta | KShell::TildeExpand, &err);
     if (err == KShell::NoError && !args.isEmpty()) {
         QProcess::setProgram(QStandardPaths::findExecutable(args.takeFirst()));
         if (!QProcess::program().isEmpty()) {
             setArguments(args);
 #ifdef Q_OS_WIN
             setNativeArguments(QString());
 #endif
             return;
         }
     }
 
     setArguments({});
 
 #ifdef Q_OS_UNIX
     if (s_nonFreeUnix) {
         // If /bin/sh is a symlink, we can be pretty sure that it points to a
         // POSIX shell - the original bourne shell is about the only non-POSIX
         // shell still in use and it is always installed natively as /bin/sh.
         QString shell = QFile::symLinkTarget(QStringLiteral("/bin/sh"));
         if (shell.isEmpty()) {
             // Try some known POSIX shells.
             static const char *s_knownShells[] = {"ksh", "ash", "bash", "zsh"};
             for (const auto str : s_knownShells) {
                 shell = QStandardPaths::findExecutable(QLatin1String(str));
                 if (!shell.isEmpty()) {
                     break;
                 }
             }
         }
         if (shell.isEmpty()) { // We're pretty much screwed, to be honest ...
             shell = QStringLiteral("/bin/sh");
         }
         QProcess::setProgram(shell);
     } else {
         QProcess::setProgram((QStringLiteral("/bin/sh")));
     }
 
     setArguments(arguments() << QStringLiteral("-c") << cmd);
 #else // Q_OS_UNIX
     // KMacroExpander::expandMacrosShellQuote(), KShell::quoteArg() and
     // KShell::joinArgs() may generate these for security reasons.
     setEnv(PERCENT_VARIABLE, QStringLiteral("%"));
 
 #ifndef _WIN32_WCE
     WCHAR sysdir[MAX_PATH + 1];
     UINT size = GetSystemDirectoryW(sysdir, MAX_PATH + 1);
     QProcess::setProgram(QString::fromUtf16((const char16_t *)sysdir, size) + QLatin1String("\\cmd.exe"));
     setNativeArguments(QLatin1String("/V:OFF /S /C \"") + cmd + QLatin1Char('"'));
 #else
     QProcess::setProgram(QStringLiteral("\\windows\\cmd.exe"));
     setNativeArguments(QStringLiteral("/S /C \"") + cmd + QLatin1Char('"'));
 #endif
 #endif
 }
 
 QStringList KProcess::program() const
 {
     QStringList argv = arguments();
     argv.prepend(QProcess::program());
     return argv;
 }
 
 void KProcess::start()
 {
     Q_D(KProcess);
 
     QProcess::start(d->openMode);
 }
 
 int KProcess::execute(int msecs)
 {
     start();
     if (!waitForFinished(msecs)) {
         kill();
         waitForFinished(-1);
         return -2;
     }
     return (exitStatus() == QProcess::NormalExit) ? exitCode() : -1;
 }
 
 // static
 int KProcess::execute(const QString &exe, const QStringList &args, int msecs)
 {
     KProcess p;
     p.setProgram(exe, args);
     return p.execute(msecs);
 }
 
 // static
 int KProcess::execute(const QStringList &argv, int msecs)
 {
     KProcess p;
     p.setProgram(argv);
     return p.execute(msecs);
 }
 
 int KProcess::startDetached()
 {
     qint64 pid;
     if (!QProcess::startDetached(QProcess::program(), QProcess::arguments(), workingDirectory(), &pid)) {
         return 0;
     }
     return static_cast<int>(pid);
 }
 
 // static
 int KProcess::startDetached(const QString &exe, const QStringList &args)
 {
     qint64 pid;
     if (!QProcess::startDetached(exe, args, QString(), &pid)) {
         return 0;
     }
     return static_cast<int>(pid);
 }
 
 // static
 int KProcess::startDetached(const QStringList &argv)
 {
     if (argv.isEmpty()) {
         qCWarning(KCOREADDONS_DEBUG) << "KProcess::startDetached(const QStringList &argv) called on an empty string list, no process will be started.";
         return 0;
     }
 
     QStringList args = argv;
     QString prog = args.takeFirst();
     return startDetached(prog, args);
 }
 
 #include "moc_kprocess.cpp"