summaryrefslogtreecommitdiffstats
path: root/src/core/pipeprocessbackendfactory.cpp
blob: d69fd46200b2dbfe3e752de3097d7dcdabe96a79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
152
153
154
155
156
157
158
159
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
189
190
191
192
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "pipeprocessbackendfactory.h"
#include "remoteprocessbackend.h"
#include "remoteprotocol.h"

#include <QDebug>
#include <QJsonDocument>
#include <QFileInfo>
#include <QtEndian>

QT_BEGIN_NAMESPACE_PROCESSMANAGER

const int kPipeTimerInterval = 1000;

/*!
  \class PipeProcessBackendFactory
  \brief The PipeProcessBackendFactory class forks a new process to launch applications.

  The PipeProcessBackendFactory launches a persistent pipe process.
  The factory communicates with the pipe process by sending and receiving
  messages over stdin/stdout.
*/

/*!
  Construct a PipeProcessBackendFactory with optional \a parent.
  The \a info ProcessInfo is used to start the pipe process.
*/

PipeProcessBackendFactory::PipeProcessBackendFactory(const ProcessInfo& info,
                                                     QObject *parent)
    : RemoteProcessBackendFactory(parent)
    , m_process(NULL)
{
    m_process = new QProcess;  // Note that we do NOT own the pipe process
    m_process->setReadChannel(QProcess::StandardOutput);
    connect(m_process, SIGNAL(readyReadStandardOutput()),
            this, SLOT(pipeReadyReadStandardOutput()));
    connect(m_process, SIGNAL(readyReadStandardError()),
            this, SLOT(pipeReadyReadStandardError()));
    connect(m_process, SIGNAL(started()), this, SLOT(pipeStarted()));
    connect(m_process,SIGNAL(error(QProcess::ProcessError)),
            this,SLOT(pipeError(QProcess::ProcessError)));
    connect(m_process,SIGNAL(finished(int, QProcess::ExitStatus)),
            this,SLOT(pipeFinished(int, QProcess::ExitStatus)));
    connect(m_process, SIGNAL(stateChanged(QProcess::ProcessState)),
            this,SLOT(pipeStateChanged(QProcess::ProcessState)));

    QProcessEnvironment env;
    QMapIterator<QString, QVariant> it(info.environment());
    while (it.hasNext()) {
        it.next();
        env.insert(it.key(), it.value().toString());
    }
    m_process->setProcessEnvironment(env);
    m_process->setWorkingDirectory(info.workingDirectory());
    m_process->start(info.program(), info.arguments());
}

/*!
   Destroy this and child objects.
*/

PipeProcessBackendFactory::~PipeProcessBackendFactory()
{
    // ### Note: The m_process process is NOT a child of the
    //           factory to avoid stranding grandchildren
    //           However, we do send it a "stop" message before we exit
    if (m_process) {
        QJsonObject object;
        object.insert(RemoteProtocol::remote(), RemoteProtocol::stop());
        m_process->write(QJsonDocument(object).toBinaryData());
        m_process->waitForBytesWritten();  // Block until they have been written
        m_process = NULL;
    }
}

/*!
  If there is a pipe process running, it will be returned here.
 */

QList<Q_PID> PipeProcessBackendFactory::internalProcesses()
{
    QList<Q_PID> list;
    if (m_process && m_process->state() == QProcess::Running)
        list << m_process->pid();
    return list;
}

/*!
  Send \a message to a pipe process.
 */
bool PipeProcessBackendFactory::send(const QJsonObject& message)
{
    if (m_process->state() != QProcess::Running) {
        qCritical("Pipe process not running");
        return false;
    }
    if (m_process->write(QJsonDocument(message).toBinaryData()) == -1)  {
        qCritical("Unable to write to pipe process");
        return false;
    }
    return true;
}


void PipeProcessBackendFactory::pipeReadyReadStandardOutput()
{
    m_buffer.append(m_process->readAllStandardOutput());
    while (m_buffer.size() >= 12) {   // QJsonDocuments are at least this large
        if (QJsonDocument::BinaryFormatTag != *((uint *) m_buffer.data()))
            qFatal("ERROR in receive buffer: %s", m_buffer.data());
        qint32 message_size = qFromLittleEndian(((qint32 *)m_buffer.data())[2]) + 8;
        if (m_buffer.size() < message_size)
            break;
        QByteArray msg = m_buffer.left(message_size);
        m_buffer = m_buffer.mid(message_size);
        receive(QJsonDocument::fromBinaryData(msg).object());
    }
}

void PipeProcessBackendFactory::pipeReadyReadStandardError()
{
    const QByteArray byteArray = m_process->readAllStandardError();
    QList<QByteArray> lines = byteArray.split('\n');
    foreach (const QByteArray& line, lines) {
        if (line.size())
            qDebug() << "PIPE STDERR" << line;
    }
}

void PipeProcessBackendFactory::pipeStarted()
{
}

void PipeProcessBackendFactory::pipeError(QProcess::ProcessError error)
{
    qWarning("Pipe process error: %d", error);
}

void PipeProcessBackendFactory::pipeFinished(int exitCode, QProcess::ExitStatus exitStatus)
{
    qCritical("Pipe process died, exit code=%d status=%d", exitCode, exitStatus);
    delete m_process;
    m_process = NULL;
}

void PipeProcessBackendFactory::pipeStateChanged(QProcess::ProcessState state)
{
    Q_UNUSED(state);
}

#include "moc_pipeprocessbackendfactory.cpp"

QT_END_NAMESPACE_PROCESSMANAGER