consoleprocess_unix.cpp 6.33 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6 7 8
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
9
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
25 26
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30 31
#include "consoleprocess.h"

32 33 34 35 36 37 38 39 40 41 42
#include <QtCore/QCoreApplication>
#include <QtCore/QTemporaryFile>

#include <QtNetwork/QLocalSocket>

#include <sys/stat.h>
#include <sys/types.h>
#include <errno.h>
#include <string.h>
#include <unistd.h>

43
using namespace Core::Utils;
con's avatar
con committed
44 45 46 47

ConsoleProcess::ConsoleProcess(QObject *parent)
    : QObject(parent)
{
48 49 50
    m_debug = false;
    m_appPid = 0;
    m_stubSocket = 0;
con's avatar
con committed
51

52 53 54 55 56
    connect(&m_stubServer, SIGNAL(newConnection()), SLOT(stubConnectionAvailable()));

    m_process.setProcessChannelMode(QProcess::ForwardedChannels);
    connect(&m_process, SIGNAL(finished(int, QProcess::ExitStatus)),
            SLOT(stubExited()));
con's avatar
con committed
57 58
}

59
ConsoleProcess::~ConsoleProcess()
60
{
61
    stop();
62 63
}

con's avatar
con committed
64 65
bool ConsoleProcess::start(const QString &program, const QStringList &args)
{
66
    if (isRunning())
con's avatar
con committed
67 68
        return false;

69 70 71 72 73
    QString err = stubServerListen();
    if (!err.isEmpty()) {
        emit processError(tr("Cannot set up comm channel: %1").arg(err));
        return false;
    }
con's avatar
con committed
74

75 76 77 78 79 80 81
    QStringList xtermArgs;
    xtermArgs << "-e" << (QCoreApplication::applicationDirPath() + "/qtcreator_process_stub")
              << (m_debug ? "debug" : "exec")
              << m_stubServer.fullServerName()
              << tr("Press <RETURN> to close this window...")
              << workingDirectory() << environment() << ""
              << program << args;
con's avatar
con committed
82

83 84 85 86
    m_process.start(QLatin1String("xterm"), xtermArgs);
    if (!m_process.waitForStarted()) {
        stubServerShutdown();
        emit processError(tr("Cannot start console emulator xterm."));
con's avatar
con committed
87
        return false;
88 89 90
    }
    m_executable = program;
    emit wrapperStarted();
con's avatar
con committed
91 92 93
    return true;
}

94
void ConsoleProcess::stop()
con's avatar
con committed
95
{
96 97 98 99 100 101 102 103
    if (!isRunning())
        return;
    stubServerShutdown();
    m_appPid = 0;
    m_process.terminate();
    if (!m_process.waitForFinished(1000))
        m_process.kill();
    m_process.waitForFinished();
con's avatar
con committed
104 105 106 107
}

bool ConsoleProcess::isRunning() const
{
108
    return m_process.state() != QProcess::NotRunning;
con's avatar
con committed
109 110
}

111
QString ConsoleProcess::stubServerListen()
con's avatar
con committed
112
{
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    // We need to put the socket in a private directory, as some systems simply do not
    // check the file permissions of sockets.
    QString stubFifoDir;
    forever {
        {
            QTemporaryFile tf;
            if (!tf.open())
                return tr("Cannot create temporary file: %2").arg(tf.errorString());
            stubFifoDir = QFile::encodeName(tf.fileName());
        }
        // By now the temp file was deleted again
        m_stubServerDir = QFile::encodeName(stubFifoDir);
        if (!::mkdir(m_stubServerDir.constData(), 0700))
            break;
        if (errno != EEXIST)
            return tr("Cannot create temporary directory %1: %2").arg(stubFifoDir, strerror(errno));
    }
    QString stubServer  = stubFifoDir + "/stub-socket";
    if (!m_stubServer.listen(stubServer)) {
        ::rmdir(m_stubServerDir.constData());
        return tr("Cannot create socket %1: %2").arg(stubServer, m_stubServer.errorString());
    }
    return QString();
}

void ConsoleProcess::stubServerShutdown()
{
    delete m_stubSocket;
    m_stubSocket = 0;
    if (m_stubServer.isListening()) {
        m_stubServer.close();
        ::rmdir(m_stubServerDir.constData());
    }
}

void ConsoleProcess::stubConnectionAvailable()
{
    m_stubSocket = m_stubServer.nextPendingConnection();
    connect(m_stubSocket, SIGNAL(readyRead()), SLOT(readStubOutput()));
con's avatar
con committed
152 153
}

154
static QString errorMsg(int code)
con's avatar
con committed
155
{
156
    return QString::fromLocal8Bit(strerror(code));
con's avatar
con committed
157 158
}

159
void ConsoleProcess::readStubOutput()
con's avatar
con committed
160
{
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    while (m_stubSocket->canReadLine()) {
        QByteArray out = m_stubSocket->readLine();
        out.chop(1); // \n
        if (out.startsWith("err:chdir ")) {
            emit processError(tr("Cannot change to working directory %1: %2")
                              .arg(workingDirectory(), errorMsg(out.mid(10).toInt())));
        } else if (out.startsWith("err:exec ")) {
            emit processError(tr("Cannot execute %1: %2")
                              .arg(m_executable, errorMsg(out.mid(9).toInt())));
        } else if (out.startsWith("pid ")) {
            m_appPid = out.mid(4).toInt();
            emit processStarted();
        } else if (out.startsWith("exit ")) {
            m_appStatus = QProcess::NormalExit;
            m_appCode = out.mid(5).toInt();
            m_appPid = 0;
            emit processStopped();
        } else if (out.startsWith("crash ")) {
            m_appStatus = QProcess::CrashExit;
            m_appCode = out.mid(6).toInt();
            m_appPid = 0;
            emit processStopped();
        } else {
            emit processError(tr("Unexpected output from helper program."));
            m_process.terminate();
            break;
        }
    }
con's avatar
con committed
189 190
}

191 192 193 194 195 196 197 198 199 200 201 202 203 204
void ConsoleProcess::stubExited()
{
    // The stub exit might get noticed before we read the error status.
    if (m_stubSocket && m_stubSocket->state() == QLocalSocket::ConnectedState)
        m_stubSocket->waitForDisconnected();
    stubServerShutdown();
    if (m_appPid) {
        m_appStatus = QProcess::CrashExit;
        m_appCode = -1;
        m_appPid = 0;
        emit processStopped(); // Maybe it actually did not, but keep state consistent
    }
    emit wrapperStopped();
}