aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/utils/terminalprocess.cpp
diff options
context:
space:
mode:
authorJarek Kobus <jaroslaw.kobus@qt.io>2022-01-21 15:01:01 +0100
committerJarek Kobus <jaroslaw.kobus@qt.io>2022-01-21 15:13:15 +0000
commit89fb9e6b2bff3ff698c7b1abb49570b85f701768 (patch)
treecb93683428a29c783408afbda0b50902821d3895 /src/libs/utils/terminalprocess.cpp
parent1f0ecd600e7ddf184ef248c64aad6444462950ec (diff)
Make a copy of ConsoleProcess class
This is needed for transition period. Make a copy of ConsoleProcess and name it TerminalProcess. Make it a private, non-exported class. The ConsoleProcess is going to be removed after unification of TerminalProcess and QtcProcess classes is over. Change-Id: Ib2d4bc8e8fd7ff714d891c57f695dd0debcb5a11 Reviewed-by: hjk <hjk@qt.io>
Diffstat (limited to 'src/libs/utils/terminalprocess.cpp')
-rw-r--r--src/libs/utils/terminalprocess.cpp863
1 files changed, 863 insertions, 0 deletions
diff --git a/src/libs/utils/terminalprocess.cpp b/src/libs/utils/terminalprocess.cpp
new file mode 100644
index 0000000000..d362743a2f
--- /dev/null
+++ b/src/libs/utils/terminalprocess.cpp
@@ -0,0 +1,863 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#include "terminalprocess_p.h"
+
+#include <utils/environment.h>
+#include <utils/hostosinfo.h>
+#include <utils/commandline.h>
+#include <utils/qtcassert.h>
+#include <utils/qtcprocess.h>
+#include <utils/terminalcommand.h>
+#include <utils/winutils.h>
+
+#include <QAbstractEventDispatcher>
+#include <QCoreApplication>
+#include <QDir>
+#include <QLocalServer>
+#include <QLocalSocket>
+#include <QRegularExpression>
+#include <QTemporaryFile>
+#include <QTextCodec>
+#include <QTimer>
+#include <QWinEventNotifier>
+
+#ifdef Q_OS_WIN
+
+# include <windows.h>
+# include <stdlib.h>
+# include <cstring>
+
+#else
+
+# include <sys/stat.h>
+# include <sys/types.h>
+# include <errno.h>
+# include <string.h>
+# include <unistd.h>
+
+#endif
+
+namespace Utils {
+namespace Internal {
+
+static QString modeOption(TerminalProcess::Mode m)
+{
+ switch (m) {
+ case TerminalProcess::Debug:
+ return QLatin1String("debug");
+ case TerminalProcess::Suspend:
+ return QLatin1String("suspend");
+ case TerminalProcess::Run:
+ break;
+ }
+ return QLatin1String("run");
+}
+
+static QString msgCommChannelFailed(const QString &error)
+{
+ return TerminalProcess::tr("Cannot set up communication channel: %1").arg(error);
+}
+
+static QString msgPromptToClose()
+{
+ // Shown in a terminal which might have a different character set on Windows.
+ return TerminalProcess::tr("Press <RETURN> to close this window...");
+}
+
+static QString msgCannotCreateTempFile(const QString &why)
+{
+ return TerminalProcess::tr("Cannot create temporary file: %1").arg(why);
+}
+
+static QString msgCannotWriteTempFile()
+{
+ return TerminalProcess::tr("Cannot write temporary file. Disk full?");
+}
+
+static QString msgCannotCreateTempDir(const QString & dir, const QString &why)
+{
+ return TerminalProcess::tr("Cannot create temporary directory \"%1\": %2").arg(dir, why);
+}
+
+static QString msgUnexpectedOutput(const QByteArray &what)
+{
+ return TerminalProcess::tr("Unexpected output from helper program (%1).").arg(QString::fromLatin1(what));
+}
+
+static QString msgCannotChangeToWorkDir(const FilePath &dir, const QString &why)
+{
+ return TerminalProcess::tr("Cannot change to working directory \"%1\": %2").arg(dir.toString(), why);
+}
+
+static QString msgCannotExecute(const QString & p, const QString &why)
+{
+ return TerminalProcess::tr("Cannot execute \"%1\": %2").arg(p, why);
+}
+
+class TerminalProcessPrivate
+{
+public:
+ TerminalProcessPrivate() = default;
+
+ TerminalProcess::Mode m_mode = TerminalProcess::Run;
+ FilePath m_workingDir;
+ Environment m_environment;
+ qint64 m_processId = 0;
+ int m_exitCode = 0;
+ CommandLine m_commandLine;
+ QProcess::ExitStatus m_appStatus = QProcess::NormalExit;
+ QLocalServer m_stubServer;
+ QLocalSocket *m_stubSocket = nullptr;
+ QTemporaryFile *m_tempFile = nullptr;
+ QProcess::ProcessError m_error = QProcess::UnknownError;
+ QString m_errorString;
+ bool m_abortOnMetaChars = true;
+ bool m_runAsRoot = false;
+
+ // Used on Unix only
+ QtcProcess m_process;
+ QTimer *m_stubConnectTimer = nullptr;
+ QByteArray m_stubServerDir;
+
+ // Used on Windows only
+ qint64 m_appMainThreadId = 0;
+
+#ifdef Q_OS_WIN
+ PROCESS_INFORMATION *m_pid = nullptr;
+ HANDLE m_hInferior = NULL;
+ QWinEventNotifier *inferiorFinishedNotifier = nullptr;
+ QWinEventNotifier *processFinishedNotifier = nullptr;
+#endif
+};
+
+TerminalProcess::TerminalProcess(QObject *parent) :
+ QObject(parent), d(new TerminalProcessPrivate)
+{
+ connect(&d->m_stubServer, &QLocalServer::newConnection,
+ this, &TerminalProcess::stubConnectionAvailable);
+
+ d->m_process.setProcessChannelMode(QProcess::ForwardedChannels);
+}
+
+TerminalProcess::~TerminalProcess()
+{
+ stopProcess();
+ delete d;
+}
+
+void TerminalProcess::setCommand(const CommandLine &command)
+{
+ d->m_commandLine = command;
+}
+
+const CommandLine &TerminalProcess::commandLine() const
+{
+ return d->m_commandLine;
+}
+
+static QString quoteWinCommand(const QString &program)
+{
+ const QChar doubleQuote = QLatin1Char('"');
+
+ // add the program as the first arg ... it works better
+ QString programName = program;
+ programName.replace(QLatin1Char('/'), QLatin1Char('\\'));
+ if (!programName.startsWith(doubleQuote) && !programName.endsWith(doubleQuote)
+ && programName.contains(QLatin1Char(' '))) {
+ programName.prepend(doubleQuote);
+ programName.append(doubleQuote);
+ }
+ return programName;
+}
+
+static QString quoteWinArgument(const QString &arg)
+{
+ if (arg.isEmpty())
+ return QString::fromLatin1("\"\"");
+
+ QString ret(arg);
+ // Quotes are escaped and their preceding backslashes are doubled.
+ ret.replace(QRegularExpression("(\\\\*)\""), "\\1\\1\\\"");
+ if (ret.contains(QRegularExpression("\\s"))) {
+ // The argument must not end with a \ since this would be interpreted
+ // as escaping the quote -- rather put the \ behind the quote: e.g.
+ // rather use "foo"\ than "foo\"
+ int i = ret.length();
+ while (i > 0 && ret.at(i - 1) == QLatin1Char('\\'))
+ --i;
+ ret.insert(i, QLatin1Char('"'));
+ ret.prepend(QLatin1Char('"'));
+ }
+ return ret;
+}
+
+// Quote a Windows command line correctly for the "CreateProcess" API
+static QString createWinCommandline(const QString &program, const QStringList &args)
+{
+ QString programName = quoteWinCommand(program);
+ for (const QString &arg : args) {
+ programName += QLatin1Char(' ');
+ programName += quoteWinArgument(arg);
+ }
+ return programName;
+}
+
+static QString createWinCommandline(const QString &program, const QString &args)
+{
+ QString programName = quoteWinCommand(program);
+ if (!args.isEmpty()) {
+ programName += QLatin1Char(' ');
+ programName += args;
+ }
+ return programName;
+}
+
+bool TerminalProcess::startTerminalEmulator(const QString &workingDir, const Environment &env)
+{
+#ifdef Q_OS_WIN
+ STARTUPINFO si;
+ ZeroMemory(&si, sizeof(si));
+ si.cb = sizeof(si);
+
+ PROCESS_INFORMATION pinfo;
+ ZeroMemory(&pinfo, sizeof(pinfo));
+
+ QString cmdLine = createWinCommandline(
+ QString::fromLocal8Bit(qgetenv("COMSPEC")), QString());
+ // cmdLine is assumed to be detached -
+ // https://blogs.msdn.microsoft.com/oldnewthing/20090601-00/?p=18083
+
+ QString totalEnvironment = env.toStringList().join(QChar(QChar::Null)) + QChar(QChar::Null);
+ LPVOID envPtr = (env != Environment::systemEnvironment())
+ ? (WCHAR *)(totalEnvironment.utf16()) : nullptr;
+
+ bool success = CreateProcessW(0, (WCHAR *)cmdLine.utf16(),
+ 0, 0, FALSE, CREATE_NEW_CONSOLE | CREATE_UNICODE_ENVIRONMENT,
+ envPtr, workingDir.isEmpty() ? 0 : (WCHAR *)workingDir.utf16(),
+ &si, &pinfo);
+
+ if (success) {
+ CloseHandle(pinfo.hThread);
+ CloseHandle(pinfo.hProcess);
+ }
+
+ return success;
+#else
+ const TerminalCommand term = TerminalCommand::terminalEmulator();
+ QProcess process;
+ process.setProgram(term.command);
+ process.setArguments(ProcessArgs::splitArgs(term.openArgs));
+ process.setProcessEnvironment(env.toProcessEnvironment());
+ process.setWorkingDirectory(workingDir);
+
+ return process.startDetached();
+#endif
+}
+
+void TerminalProcess::setAbortOnMetaChars(bool abort)
+{
+ d->m_abortOnMetaChars = abort;
+}
+
+qint64 TerminalProcess::applicationMainThreadID() const
+{
+ if (HostOsInfo::isWindowsHost())
+ return d->m_appMainThreadId;
+ return -1;
+}
+
+void TerminalProcess::start()
+{
+ if (isRunning())
+ return;
+
+ d->m_errorString.clear();
+ d->m_error = QProcess::UnknownError;
+
+#ifdef Q_OS_WIN
+
+ QString pcmd;
+ QString pargs;
+ if (d->m_mode != Run) { // The debugger engines already pre-process the arguments.
+ pcmd = d->m_commandLine.executable().toString();
+ pargs = d->m_commandLine.arguments();
+ } else {
+ ProcessArgs outArgs;
+ ProcessArgs::prepareCommand(d->m_commandLine, &pcmd, &outArgs,
+ &d->m_environment, &d->m_workingDir);
+ pargs = outArgs.toWindowsArgs();
+ }
+
+ const QString err = stubServerListen();
+ if (!err.isEmpty()) {
+ emitError(QProcess::FailedToStart, msgCommChannelFailed(err));
+ return;
+ }
+
+ QStringList env = d->m_environment.toStringList();
+ if (!env.isEmpty()) {
+ d->m_tempFile = new QTemporaryFile();
+ if (!d->m_tempFile->open()) {
+ cleanupAfterStartFailure(msgCannotCreateTempFile(d->m_tempFile->errorString()));
+ return;
+ }
+ QString outString;
+ QTextStream out(&outString);
+ // Add PATH and SystemRoot environment variables in case they are missing
+ const QStringList fixedEnvironment = [env] {
+ QStringList envStrings = env;
+ // add PATH if necessary (for DLL loading)
+ if (envStrings.filter(QRegularExpression("^PATH=.*", QRegularExpression::CaseInsensitiveOption)).isEmpty()) {
+ QByteArray path = qgetenv("PATH");
+ if (!path.isEmpty())
+ envStrings.prepend(QString::fromLatin1("PATH=%1").arg(QString::fromLocal8Bit(path)));
+ }
+ // add systemroot if needed
+ if (envStrings.filter(QRegularExpression("^SystemRoot=.*", QRegularExpression::CaseInsensitiveOption)).isEmpty()) {
+ QByteArray systemRoot = qgetenv("SystemRoot");
+ if (!systemRoot.isEmpty())
+ envStrings.prepend(QString::fromLatin1("SystemRoot=%1").arg(QString::fromLocal8Bit(systemRoot)));
+ }
+ return envStrings;
+ }();
+
+ for (const QString &var : fixedEnvironment)
+ out << var << QChar(0);
+ out << QChar(0);
+ const QTextCodec *textCodec = QTextCodec::codecForName("UTF-16LE");
+ QTC_CHECK(textCodec);
+ const QByteArray outBytes = textCodec ? textCodec->fromUnicode(outString) : QByteArray();
+ if (!textCodec || d->m_tempFile->write(outBytes) < 0) {
+ cleanupAfterStartFailure(msgCannotWriteTempFile());
+ return;
+ }
+ d->m_tempFile->flush();
+ }
+
+ STARTUPINFO si;
+ ZeroMemory(&si, sizeof(si));
+ si.cb = sizeof(si);
+
+ d->m_pid = new PROCESS_INFORMATION;
+ ZeroMemory(d->m_pid, sizeof(PROCESS_INFORMATION));
+
+ QString workDir = workingDirectory().toUserOutput();
+ if (!workDir.isEmpty() && !workDir.endsWith(QLatin1Char('\\')))
+ workDir.append(QLatin1Char('\\'));
+
+ QStringList stubArgs;
+ stubArgs << modeOption(d->m_mode)
+ << d->m_stubServer.fullServerName()
+ << workDir
+ << (d->m_tempFile ? d->m_tempFile->fileName() : QString())
+ << createWinCommandline(pcmd, pargs)
+ << msgPromptToClose();
+
+ const QString cmdLine = createWinCommandline(
+ QCoreApplication::applicationDirPath() + QLatin1String("/qtcreator_process_stub.exe"), stubArgs);
+
+ bool success = CreateProcessW(0, (WCHAR*)cmdLine.utf16(),
+ 0, 0, FALSE, CREATE_NEW_CONSOLE,
+ 0, 0,
+ &si, d->m_pid);
+
+ if (!success) {
+ delete d->m_pid;
+ d->m_pid = nullptr;
+ const QString msg = tr("The process \"%1\" could not be started: %2")
+ .arg(cmdLine, winErrorMessage(GetLastError()));
+ cleanupAfterStartFailure(msg);
+ return;
+ }
+
+ d->processFinishedNotifier = new QWinEventNotifier(d->m_pid->hProcess, this);
+ connect(d->processFinishedNotifier, &QWinEventNotifier::activated,
+ this, &TerminalProcess::stubExited);
+
+#else
+
+ ProcessArgs::SplitError perr;
+ ProcessArgs pargs = ProcessArgs::prepareArgs(d->m_commandLine.arguments(),
+ &perr,
+ HostOsInfo::hostOs(),
+ &d->m_environment,
+ &d->m_workingDir,
+ d->m_abortOnMetaChars);
+
+ QString pcmd;
+ if (perr == ProcessArgs::SplitOk) {
+ pcmd = d->m_commandLine.executable().toString();
+ } else {
+ if (perr != ProcessArgs::FoundMeta) {
+ emitError(QProcess::FailedToStart, tr("Quoting error in command."));
+ return;
+ }
+ if (d->m_mode == Debug) {
+ // FIXME: QTCREATORBUG-2809
+ emitError(QProcess::FailedToStart, tr("Debugging complex shell commands in a terminal"
+ " is currently not supported."));
+ return;
+ }
+ pcmd = qEnvironmentVariable("SHELL", "/bin/sh");
+ pargs = ProcessArgs::createUnixArgs(
+ {"-c", (ProcessArgs::quoteArg(d->m_commandLine.executable().toString())
+ + ' ' + d->m_commandLine.arguments())});
+ }
+
+ ProcessArgs::SplitError qerr;
+ const TerminalCommand terminal = TerminalCommand::terminalEmulator();
+ const ProcessArgs terminalArgs = ProcessArgs::prepareArgs(terminal.executeArgs,
+ &qerr,
+ HostOsInfo::hostOs(),
+ &d->m_environment,
+ &d->m_workingDir);
+ if (qerr != ProcessArgs::SplitOk) {
+ emitError(QProcess::FailedToStart, qerr == ProcessArgs::BadQuoting
+ ? tr("Quoting error in terminal command.")
+ : tr("Terminal command may not be a shell command."));
+ return;
+ }
+
+ const QString err = stubServerListen();
+ if (!err.isEmpty()) {
+ emitError(QProcess::FailedToStart, msgCommChannelFailed(err));
+ return;
+ }
+
+ d->m_environment.unset(QLatin1String("TERM"));
+
+ const QStringList env = d->m_environment.toStringList();
+ if (!env.isEmpty()) {
+ d->m_tempFile = new QTemporaryFile();
+ if (!d->m_tempFile->open()) {
+ cleanupAfterStartFailure(msgCannotCreateTempFile(d->m_tempFile->errorString()));
+ return;
+ }
+ QByteArray contents;
+ for (const QString &var : env) {
+ const QByteArray l8b = var.toLocal8Bit();
+ contents.append(l8b.constData(), l8b.size() + 1);
+ }
+ if (d->m_tempFile->write(contents) != contents.size() || !d->m_tempFile->flush()) {
+ cleanupAfterStartFailure(msgCannotWriteTempFile());
+ return;
+ }
+ }
+
+ const QString stubPath = QCoreApplication::applicationDirPath()
+ + QLatin1String("/" RELATIVE_LIBEXEC_PATH "/qtcreator_process_stub");
+
+ QStringList allArgs = terminalArgs.toUnixArgs();
+ if (d->m_runAsRoot)
+ allArgs << "sudo" << "-A";
+
+ allArgs << stubPath
+ << modeOption(d->m_mode)
+ << d->m_stubServer.fullServerName()
+ << msgPromptToClose()
+ << workingDirectory().path()
+ << (d->m_tempFile ? d->m_tempFile->fileName() : QString())
+ << QString::number(getpid())
+ << pcmd
+ << pargs.toUnixArgs();
+
+ if (terminal.needsQuotes)
+ allArgs = QStringList { ProcessArgs::joinArgs(allArgs) };
+
+ d->m_process.setEnvironment(d->m_environment);
+ d->m_process.setCommand({FilePath::fromString(terminal.command), allArgs});
+ d->m_process.start();
+ if (!d->m_process.waitForStarted()) {
+ const QString msg = tr("Cannot start the terminal emulator \"%1\", change the setting in the "
+ "Environment options.").arg(terminal.command);
+ cleanupAfterStartFailure(msg);
+ return;
+ }
+ d->m_stubConnectTimer = new QTimer(this);
+ connect(d->m_stubConnectTimer, &QTimer::timeout, this, &TerminalProcess::stopProcess);
+ d->m_stubConnectTimer->setSingleShot(true);
+ d->m_stubConnectTimer->start(10000);
+
+#endif
+}
+
+void TerminalProcess::cleanupAfterStartFailure(const QString &errorMessage)
+{
+ stubServerShutdown();
+ emitError(QProcess::FailedToStart, errorMessage);
+ delete d->m_tempFile;
+ d->m_tempFile = nullptr;
+}
+
+void TerminalProcess::finish(int exitCode, QProcess::ExitStatus exitStatus)
+{
+ d->m_processId = 0;
+ d->m_exitCode = exitCode;
+ d->m_appStatus = exitStatus;
+ emit finished();
+}
+
+void TerminalProcess::kickoffProcess()
+{
+#ifdef Q_OS_WIN
+ // Not used.
+#else
+ if (d->m_stubSocket && d->m_stubSocket->isWritable()) {
+ d->m_stubSocket->write("c", 1);
+ d->m_stubSocket->flush();
+ }
+#endif
+}
+
+void TerminalProcess::interruptProcess()
+{
+#ifdef Q_OS_WIN
+ // Not used.
+#else
+ if (d->m_stubSocket && d->m_stubSocket->isWritable()) {
+ d->m_stubSocket->write("i", 1);
+ d->m_stubSocket->flush();
+ }
+#endif
+}
+
+void TerminalProcess::killProcess()
+{
+#ifdef Q_OS_WIN
+ if (d->m_hInferior != NULL) {
+ TerminateProcess(d->m_hInferior, (unsigned)-1);
+ cleanupInferior();
+ }
+#else
+ if (d->m_stubSocket && d->m_stubSocket->isWritable()) {
+ d->m_stubSocket->write("k", 1);
+ d->m_stubSocket->flush();
+ }
+#endif
+ d->m_processId = 0;
+}
+
+void TerminalProcess::killStub()
+{
+#ifdef Q_OS_WIN
+ if (d->m_pid) {
+ TerminateProcess(d->m_pid->hProcess, (unsigned)-1);
+ WaitForSingleObject(d->m_pid->hProcess, INFINITE);
+ cleanupStub();
+ }
+#else
+ if (d->m_stubSocket && d->m_stubSocket->isWritable()) {
+ d->m_stubSocket->write("s", 1);
+ d->m_stubSocket->flush();
+ }
+ stubServerShutdown();
+#endif
+}
+
+void TerminalProcess::stopProcess()
+{
+ killProcess();
+ killStub();
+ if (isRunning() && HostOsInfo::isAnyUnixHost()) {
+ d->m_process.terminate();
+ if (!d->m_process.waitForFinished(1000) && d->m_process.state() == QProcess::Running) {
+ d->m_process.kill();
+ d->m_process.waitForFinished();
+ }
+ }
+}
+
+bool TerminalProcess::isRunning() const
+{
+#ifdef Q_OS_WIN
+ return d->m_pid != nullptr;
+#else
+ return d->m_process.state() != QProcess::NotRunning
+ || (d->m_stubSocket && d->m_stubSocket->isOpen());
+#endif
+}
+
+QString TerminalProcess::stubServerListen()
+{
+#ifdef Q_OS_WIN
+ if (d->m_stubServer.listen(QString::fromLatin1("creator-%1-%2")
+ .arg(QCoreApplication::applicationPid())
+ .arg(rand())))
+ return QString();
+ return d->m_stubServer.errorString();
+#else
+ // We need to put the socket in a private directory, as some systems simply do not
+ // check the file permissions of sockets.
+ QString stubFifoDir;
+ while (true) {
+ {
+ QTemporaryFile tf;
+ if (!tf.open())
+ return msgCannotCreateTempFile(tf.errorString());
+ stubFifoDir = tf.fileName();
+ }
+ // By now the temp file was deleted again
+ d->m_stubServerDir = QFile::encodeName(stubFifoDir);
+ if (!::mkdir(d->m_stubServerDir.constData(), 0700))
+ break;
+ if (errno != EEXIST)
+ return msgCannotCreateTempDir(stubFifoDir, QString::fromLocal8Bit(strerror(errno)));
+ }
+ const QString stubServer = stubFifoDir + QLatin1String("/stub-socket");
+ if (!d->m_stubServer.listen(stubServer)) {
+ ::rmdir(d->m_stubServerDir.constData());
+ return tr("Cannot create socket \"%1\": %2").arg(stubServer, d->m_stubServer.errorString());
+ }
+ return QString();
+#endif
+}
+
+void TerminalProcess::stubServerShutdown()
+{
+#ifdef Q_OS_WIN
+ delete d->m_stubSocket;
+ d->m_stubSocket = nullptr;
+ if (d->m_stubServer.isListening())
+ d->m_stubServer.close();
+#else
+ if (d->m_stubSocket) {
+ readStubOutput(); // we could get the shutdown signal before emptying the buffer
+ d->m_stubSocket->disconnect(); // avoid getting queued readyRead signals
+ d->m_stubSocket->deleteLater(); // we might be called from the disconnected signal of m_stubSocket
+ }
+ d->m_stubSocket = nullptr;
+ if (d->m_stubServer.isListening()) {
+ d->m_stubServer.close();
+ ::rmdir(d->m_stubServerDir.constData());
+ }
+#endif
+}
+
+void TerminalProcess::stubConnectionAvailable()
+{
+ if (d->m_stubConnectTimer) {
+ delete d->m_stubConnectTimer;
+ d->m_stubConnectTimer = nullptr;
+ }
+
+ d->m_stubSocket = d->m_stubServer.nextPendingConnection();
+ connect(d->m_stubSocket, &QIODevice::readyRead, this, &TerminalProcess::readStubOutput);
+
+ if (HostOsInfo::isAnyUnixHost())
+ connect(d->m_stubSocket, &QLocalSocket::disconnected, this, &TerminalProcess::stubExited);
+}
+
+static QString errorMsg(int code)
+{
+ return QString::fromLocal8Bit(strerror(code));
+}
+
+void TerminalProcess::readStubOutput()
+{
+ while (d->m_stubSocket->canReadLine()) {
+ QByteArray out = d->m_stubSocket->readLine();
+#ifdef Q_OS_WIN
+ out.chop(2); // \r\n
+ if (out.startsWith("err:chdir ")) {
+ emitError(QProcess::FailedToStart, msgCannotChangeToWorkDir(workingDirectory(), winErrorMessage(out.mid(10).toInt())));
+ } else if (out.startsWith("err:exec ")) {
+ emitError(QProcess::FailedToStart, msgCannotExecute(d->m_commandLine.executable().toUserOutput(), winErrorMessage(out.mid(9).toInt())));
+ } else if (out.startsWith("thread ")) { // Windows only
+ d->m_appMainThreadId = out.mid(7).toLongLong();
+ } else if (out.startsWith("pid ")) {
+ // Will not need it any more
+ delete d->m_tempFile;
+ d->m_tempFile = nullptr;
+ d->m_processId = out.mid(4).toLongLong();
+
+ d->m_hInferior = OpenProcess(
+ SYNCHRONIZE | PROCESS_QUERY_INFORMATION | PROCESS_TERMINATE,
+ FALSE, d->m_processId);
+ if (d->m_hInferior == NULL) {
+ emitError(QProcess::FailedToStart, tr("Cannot obtain a handle to the inferior: %1")
+ .arg(winErrorMessage(GetLastError())));
+ // Uhm, and now what?
+ continue;
+ }
+ d->inferiorFinishedNotifier = new QWinEventNotifier(d->m_hInferior, this);
+ connect(d->inferiorFinishedNotifier, &QWinEventNotifier::activated, this, [this] {
+ DWORD chldStatus;
+
+ if (!GetExitCodeProcess(d->m_hInferior, &chldStatus))
+ emitError(QProcess::UnknownError, tr("Cannot obtain exit status from inferior: %1")
+ .arg(winErrorMessage(GetLastError())));
+ cleanupInferior();
+ finish(chldStatus, QProcess::NormalExit);
+ });
+
+ emit started();
+ } else {
+ emitError(QProcess::UnknownError, msgUnexpectedOutput(out));
+ TerminateProcess(d->m_pid->hProcess, (unsigned)-1);
+ break;
+ }
+#else
+ out.chop(1); // \n
+ if (out.startsWith("err:chdir ")) {
+ emitError(QProcess::FailedToStart, msgCannotChangeToWorkDir(workingDirectory(), errorMsg(out.mid(10).toInt())));
+ } else if (out.startsWith("err:exec ")) {
+ emitError(QProcess::FailedToStart, msgCannotExecute(d->m_commandLine.executable().toString(), errorMsg(out.mid(9).toInt())));
+ } else if (out.startsWith("spid ")) {
+ delete d->m_tempFile;
+ d->m_tempFile = nullptr;
+ } else if (out.startsWith("pid ")) {
+ d->m_processId = out.mid(4).toInt();
+ emit started();
+ } else if (out.startsWith("exit ")) {
+ finish(out.mid(5).toInt(), QProcess::NormalExit);
+ } else if (out.startsWith("crash ")) {
+ finish(out.mid(6).toInt(), QProcess::CrashExit);
+ } else {
+ emitError(QProcess::UnknownError, msgUnexpectedOutput(out));
+ d->m_process.terminate();
+ break;
+ }
+#endif
+ } // while
+}
+
+void TerminalProcess::stubExited()
+{
+ // The stub exit might get noticed before we read the pid for the kill on Windows
+ // or the error status elsewhere.
+ if (d->m_stubSocket && d->m_stubSocket->state() == QLocalSocket::ConnectedState)
+ d->m_stubSocket->waitForDisconnected();
+
+#ifdef Q_OS_WIN
+ cleanupStub();
+ if (d->m_hInferior != NULL) {
+ TerminateProcess(d->m_hInferior, (unsigned)-1);
+ cleanupInferior();
+ finish(-1, QProcess::CrashExit);
+ }
+#else
+ stubServerShutdown();
+ delete d->m_tempFile;
+ d->m_tempFile = nullptr;
+ if (d->m_processId)
+ finish(-1, QProcess::CrashExit);
+#endif
+}
+
+void TerminalProcess::cleanupInferior()
+{
+#ifdef Q_OS_WIN
+ delete d->inferiorFinishedNotifier;
+ d->inferiorFinishedNotifier = nullptr;
+ CloseHandle(d->m_hInferior);
+ d->m_hInferior = NULL;
+#endif
+}
+
+void TerminalProcess::cleanupStub()
+{
+#ifdef Q_OS_WIN
+ stubServerShutdown();
+ delete d->processFinishedNotifier;
+ d->processFinishedNotifier = nullptr;
+ CloseHandle(d->m_pid->hThread);
+ CloseHandle(d->m_pid->hProcess);
+ delete d->m_pid;
+ d->m_pid = nullptr;
+ delete d->m_tempFile;
+ d->m_tempFile = nullptr;
+#endif
+}
+
+void TerminalProcess::setMode(Mode m)
+{
+ d->m_mode = m;
+}
+
+TerminalProcess::Mode TerminalProcess::mode() const
+{
+ return d->m_mode;
+}
+
+qint64 TerminalProcess::processId() const
+{
+ return d->m_processId;
+}
+
+int TerminalProcess::exitCode() const
+{
+ return d->m_exitCode;
+} // This will be the signal number if exitStatus == CrashExit
+
+QProcess::ExitStatus TerminalProcess::exitStatus() const
+{
+ return d->m_appStatus;
+}
+
+void TerminalProcess::setWorkingDirectory(const FilePath &dir)
+{
+ d->m_workingDir = dir;
+}
+
+FilePath TerminalProcess::workingDirectory() const
+{
+ return d->m_workingDir;
+}
+
+void TerminalProcess::setEnvironment(const Environment &env)
+{
+ d->m_environment = env;
+}
+
+const Environment &TerminalProcess::environment() const
+{
+ return d->m_environment;
+}
+
+void TerminalProcess::setRunAsRoot(bool on)
+{
+ d->m_runAsRoot = on;
+}
+
+QProcess::ProcessError TerminalProcess::error() const
+{
+ return d->m_error;
+}
+
+QString TerminalProcess::errorString() const
+{
+ return d->m_errorString;
+}
+
+void TerminalProcess::emitError(QProcess::ProcessError err, const QString &errorString)
+{
+ d->m_error = err;
+ d->m_errorString = errorString;
+ emit errorOccurred(err);
+}
+
+} // Internal
+} // Utils