nodeinstanceserverproxy.cpp 19.9 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29

30 31 32 33 34 35 36
#include "nodeinstanceserverproxy.h"

#include <QLocalServer>
#include <QLocalSocket>
#include <QProcess>
#include <QCoreApplication>
#include <QUuid>
37
#include <QFileInfo>
38
#include <QDir>
39
#include <QTimer>
40
#include <QTextStream>
41
#include <QMessageBox>
42 43 44 45 46

#include "createinstancescommand.h"
#include "createscenecommand.h"
#include "changevaluescommand.h"
#include "changebindingscommand.h"
47
#include "changeauxiliarycommand.h"
48 49 50 51 52 53 54
#include "changefileurlcommand.h"
#include "removeinstancescommand.h"
#include "clearscenecommand.h"
#include "removepropertiescommand.h"
#include "reparentinstancescommand.h"
#include "changeidscommand.h"
#include "changestatecommand.h"
55
#include "completecomponentcommand.h"
56
#include "changenodesourcecommand.h"
57 58 59 60

#include "informationchangedcommand.h"
#include "pixmapchangedcommand.h"
#include "valueschangedcommand.h"
61
#include "childrenchangedcommand.h"
62
#include "statepreviewimagechangedcommand.h"
63
#include "componentcompletedcommand.h"
64
#include "tokencommand.h"
65
#include "removesharedmemorycommand.h"
66
#include "endpuppetcommand.h"
67
#include "synchronizecommand.h"
Marco Bubke's avatar
Marco Bubke committed
68
#include "debugoutputcommand.h"
69

70
#include "nodeinstanceview.h"
71 72

#include "import.h"
73

74 75
#include "qmldesignerplugin.h"

76 77
#include "puppetcreator.h"

78
#include <coreplugin/icore.h>
79
#include <utils/hostosinfo.h>
80 81 82 83
#include <projectexplorer/kit.h>
#include <qtsupport/qtkitinformation.h>
#include <qtsupport/baseqtversion.h>
#include <qtsupport/qtsupportconstants.h>
84

85 86 87

namespace QmlDesigner {

88 89 90 91 92 93 94 95 96 97 98 99
static bool hasQtQuick1(NodeInstanceView *nodeInstanceView)
{
    if (nodeInstanceView && nodeInstanceView->model()) {
        foreach (const Import &import ,nodeInstanceView->model()->imports()) {
            if (import.url() ==  "QtQuick" && import.version().toDouble() < 2.0)
                return true;
        }
    }

    return false;
}

100
NodeInstanceServerProxy::NodeInstanceServerProxy(NodeInstanceView *nodeInstanceView, RunModus runModus, ProjectExplorer::Kit *kit)
101 102 103
    : NodeInstanceServerInterface(nodeInstanceView),
      m_localServer(new QLocalServer(this)),
      m_nodeInstanceView(nodeInstanceView),
104
      m_firstBlockSize(0),
105
      m_secondBlockSize(0),
106
      m_thirdBlockSize(0),
107 108 109 110
      m_writeCommandCounter(0),
      m_firstLastReadCommandCounter(0),
      m_secondLastReadCommandCounter(0),
      m_thirdLastReadCommandCounter(0),
111 112
      m_runModus(runModus),
      m_synchronizeId(-1)
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
   PuppetCreator puppetCreator(kit, QString());

   QString socketToken(QUuid::createUuid().toString());
   m_localServer->listen(socketToken);
   m_localServer->setMaxPendingConnections(3);

   PuppetCreator::QmlPuppetVersion puppetVersion = hasQtQuick1(nodeInstanceView) ? PuppetCreator::Qml1Puppet : PuppetCreator::Qml2Puppet;

   m_qmlPuppetEditorProcess = puppetCreator.createPuppetProcess(puppetVersion,
                                                                "editormode",
                                                              socketToken,
                                                              this,
                                                              SLOT(printPreviewProcessOutput()),
                                                              SLOT(processFinished(int,QProcess::ExitStatus)));

   if (runModus == NormalModus) {
       m_qmlPuppetRenderProcess = puppetCreator.createPuppetProcess(puppetVersion,
                                                                    "rendermode",
                                                                    socketToken,
                                                                    this,
                                                                    SLOT(printPreviewProcessOutput()),
                                                                    SLOT(processFinished(int,QProcess::ExitStatus)));
       m_qmlPuppetPreviewProcess = puppetCreator.createPuppetProcess(puppetVersion,
                                                                     "previewmode",
                                                                     socketToken,
                                                                     this,
                                                                     SLOT(printPreviewProcessOutput()),
                                                                     SLOT(processFinished(int,QProcess::ExitStatus)));
   }
143

144 145
   if (m_qmlPuppetEditorProcess->waitForStarted(10000)) {
       connect(m_qmlPuppetEditorProcess.data(), SIGNAL(finished(int)), m_qmlPuppetEditorProcess.data(),SLOT(deleteLater()));
146

147 148 149
       if (runModus == NormalModus) {
           m_qmlPuppetPreviewProcess->waitForStarted();
           connect(m_qmlPuppetPreviewProcess.data(), SIGNAL(finished(int)), m_qmlPuppetPreviewProcess.data(),SLOT(deleteLater()));
150

151 152
           m_qmlPuppetRenderProcess->waitForStarted();
           connect(m_qmlPuppetRenderProcess.data(), SIGNAL(finished(int)), m_qmlPuppetRenderProcess.data(),SLOT(deleteLater()));
153
       }
154

155 156
       if (!m_localServer->hasPendingConnections())
           m_localServer->waitForNewConnection(10000);
157

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
       m_firstSocket = m_localServer->nextPendingConnection();
       connect(m_firstSocket.data(), SIGNAL(readyRead()), this, SLOT(readFirstDataStream()));

       if (runModus == NormalModus) {
           if (!m_localServer->hasPendingConnections())
               m_localServer->waitForNewConnection(10000);

           m_secondSocket = m_localServer->nextPendingConnection();
           connect(m_secondSocket.data(), SIGNAL(readyRead()), this, SLOT(readSecondDataStream()));

           if (!m_localServer->hasPendingConnections())
               m_localServer->waitForNewConnection(10000);

           m_thirdSocket = m_localServer->nextPendingConnection();
           connect(m_thirdSocket.data(), SIGNAL(readyRead()), this, SLOT(readThirdDataStream()));
173
       }
174

175
   } else {
176 177
       QMessageBox::warning(Core::ICore::dialogParent(),
                            tr("Cannot Start QML Puppet Executable"),
178
                            tr("The executable of the QML Puppet process cannot be started or is hanging."));
179

180
       QmlDesignerPlugin::instance()->switchToTextModeDeferred();
181
   }
182

183 184 185
   m_localServer->close();


186 187 188 189 190 191
   int indexOfCapturePuppetStream = QCoreApplication::arguments().indexOf("-capture-puppet-stream");
   if (indexOfCapturePuppetStream > 0) {
       m_captureFileForTest.setFileName(QCoreApplication::arguments().at(indexOfCapturePuppetStream + 1));
       bool isOpen = m_captureFileForTest.open(QIODevice::WriteOnly);
       qDebug() << "file is open: " << isOpen;
   }
192 193 194 195
}

NodeInstanceServerProxy::~NodeInstanceServerProxy()
{
196 197
    disconnect(this, SLOT(processFinished(int,QProcess::ExitStatus)));

198 199
    writeCommand(QVariant::fromValue(EndPuppetCommand()));

200 201
    if (m_firstSocket) {
        m_firstSocket->waitForBytesWritten(1000);
202
        m_firstSocket->abort();
203
    }
204

205 206
    if (m_secondSocket) {
        m_secondSocket->waitForBytesWritten(1000);
207
        m_secondSocket->abort();
208
    }
209

210 211
    if (m_thirdSocket) {
        m_thirdSocket->waitForBytesWritten(1000);
212
        m_thirdSocket->abort();
213
    }
214

215
    if (m_qmlPuppetEditorProcess)
216
        QTimer::singleShot(3000, m_qmlPuppetEditorProcess.data(), SLOT(terminate()));
217

218
    if (m_qmlPuppetPreviewProcess)
219
        QTimer::singleShot(3000, m_qmlPuppetPreviewProcess.data(), SLOT(terminate()));
220 221

    if (m_qmlPuppetRenderProcess)
222
         QTimer::singleShot(3000, m_qmlPuppetRenderProcess.data(), SLOT(terminate()));
223 224 225 226 227 228 229
}

void NodeInstanceServerProxy::dispatchCommand(const QVariant &command)
{
    static const int informationChangedCommandType = QMetaType::type("InformationChangedCommand");
    static const int valuesChangedCommandType = QMetaType::type("ValuesChangedCommand");
    static const int pixmapChangedCommandType = QMetaType::type("PixmapChangedCommand");
230
    static const int childrenChangedCommandType = QMetaType::type("ChildrenChangedCommand");
231
    static const int statePreviewImageChangedCommandType = QMetaType::type("StatePreviewImageChangedCommand");
232
    static const int componentCompletedCommandType = QMetaType::type("ComponentCompletedCommand");
233
    static const int synchronizeCommandType = QMetaType::type("SynchronizeCommand");
234
    static const int tokenCommandType = QMetaType::type("TokenCommand");
Marco Bubke's avatar
Marco Bubke committed
235
    static const int debugOutputCommandType = QMetaType::type("DebugOutputCommand");
236

237
    if (command.userType() ==  informationChangedCommandType) {
238
        nodeInstanceClient()->informationChanged(command.value<InformationChangedCommand>());
239
    } else if (command.userType() ==  valuesChangedCommandType) {
240
        nodeInstanceClient()->valuesChanged(command.value<ValuesChangedCommand>());
241
    } else if (command.userType() ==  pixmapChangedCommandType) {
242
        nodeInstanceClient()->pixmapChanged(command.value<PixmapChangedCommand>());
243
    } else if (command.userType() == childrenChangedCommandType) {
244
        nodeInstanceClient()->childrenChanged(command.value<ChildrenChangedCommand>());
245
    } else if (command.userType() == statePreviewImageChangedCommandType) {
246
        nodeInstanceClient()->statePreviewImagesChanged(command.value<StatePreviewImageChangedCommand>());
247
    } else if (command.userType() == componentCompletedCommandType) {
248
        nodeInstanceClient()->componentCompleted(command.value<ComponentCompletedCommand>());
249
    } else if (command.userType() == tokenCommandType) {
250
        nodeInstanceClient()->token(command.value<TokenCommand>());
251
    } else if (command.userType() == debugOutputCommandType) {
Marco Bubke's avatar
Marco Bubke committed
252
        nodeInstanceClient()->debugOutput(command.value<DebugOutputCommand>());
253
    } else if (command.userType() == synchronizeCommandType) {
254 255 256
        SynchronizeCommand synchronizeCommand = command.value<SynchronizeCommand>();
        m_synchronizeId = synchronizeCommand.synchronizeId();
    }  else
257 258 259 260 261 262 263 264
        Q_ASSERT(false);
}

NodeInstanceClientInterface *NodeInstanceServerProxy::nodeInstanceClient() const
{
    return m_nodeInstanceView.data();
}

265
static void writeCommandToIODecive(const QVariant &command, QIODevice *ioDevice, unsigned int commandCounter)
266
{
267
    if (ioDevice) {
268 269
        QByteArray block;
        QDataStream out(&block, QIODevice::WriteOnly);
270
        out.setVersion(QDataStream::Qt_4_8);
271
        out << quint32(0);
272
        out << quint32(commandCounter);
273 274 275 276
        out << command;
        out.device()->seek(0);
        out << quint32(block.size() - sizeof(quint32));

277
        ioDevice->write(block);
278
    }
279 280 281 282
}

void NodeInstanceServerProxy::writeCommand(const QVariant &command)
{
283 284 285 286 287 288 289 290 291 292
    writeCommandToIODecive(command, m_firstSocket.data(), m_writeCommandCounter);
    writeCommandToIODecive(command, m_secondSocket.data(), m_writeCommandCounter);
    writeCommandToIODecive(command, m_thirdSocket.data(), m_writeCommandCounter);

    if (m_captureFileForTest.isWritable()) {
        qDebug() << "Write strean to file: " << m_captureFileForTest.fileName();
        writeCommandToIODecive(command, &m_captureFileForTest, m_writeCommandCounter);
        qDebug() << "\twrite file: " << m_captureFileForTest.pos();
    }

293
    m_writeCommandCounter++;
294 295 296 297 298
    if (m_runModus == TestModus) {
        static int synchronizeId = 0;
        synchronizeId++;
        SynchronizeCommand synchronizeCommand(synchronizeId);

299
        writeCommandToIODecive(QVariant::fromValue(synchronizeCommand), m_firstSocket.data(), m_writeCommandCounter);
300
        m_writeCommandCounter++;
301

302
        while (m_firstSocket->waitForReadyRead(100)) {
303 304 305 306 307
                readFirstDataStream();
                if (m_synchronizeId == synchronizeId)
                    return;
        }
    }
308 309
}

310
void NodeInstanceServerProxy::processFinished(int /*exitCode*/, QProcess::ExitStatus exitStatus)
311
{
312
    qDebug() << "Process finished:" << sender();
313

314 315 316
    if (m_captureFileForTest.isOpen()) {
        m_captureFileForTest.close();
        m_captureFileForTest.remove();
317 318 319
        QMessageBox::warning(Core::ICore::dialogParent(), tr("QML Puppet Crashed"),
                             tr("You are recording a puppet stream and the puppet crashed. "
                                "It is recommended to reopen the Qt Quick Designer and start again."));
320 321 322
    }


323 324
    writeCommand(QVariant::fromValue(EndPuppetCommand()));

325 326
    if (m_firstSocket) {
        m_firstSocket->waitForBytesWritten(1000);
327
        m_firstSocket->abort();
328 329 330 331
    }

    if (m_secondSocket) {
        m_secondSocket->waitForBytesWritten(1000);
332
        m_secondSocket->abort();
333 334 335 336
    }

    if (m_thirdSocket) {
        m_thirdSocket->waitForBytesWritten(1000);
337
        m_thirdSocket->abort();
338
    }
339

340 341
    if (exitStatus == QProcess::CrashExit)
        emit processCrashed();
342 343
}

344

345 346 347 348 349 350 351 352 353
void NodeInstanceServerProxy::readFirstDataStream()
{
    QList<QVariant> commandList;

    while (!m_firstSocket->atEnd()) {
        if (m_firstSocket->bytesAvailable() < int(sizeof(quint32)))
            break;

        QDataStream in(m_firstSocket.data());
354
        in.setVersion(QDataStream::Qt_4_8);
355

356
        if (m_firstBlockSize == 0)
357 358 359 360 361
            in >> m_firstBlockSize;

        if (m_firstSocket->bytesAvailable() < m_firstBlockSize)
            break;

362 363 364 365 366 367 368 369
        quint32 commandCounter;
        in >> commandCounter;
        bool commandLost = !((m_firstLastReadCommandCounter == 0 && commandCounter == 0) || (m_firstLastReadCommandCounter + 1 == commandCounter));
        if (commandLost)
            qDebug() << "server command lost: " << m_firstLastReadCommandCounter <<  commandCounter;
        m_firstLastReadCommandCounter = commandCounter;


370 371 372 373 374 375 376 377 378 379 380 381 382
        QVariant command;
        in >> command;
        m_firstBlockSize = 0;

        commandList.append(command);
    }

    foreach (const QVariant &command, commandList) {
        dispatchCommand(command);
    }
}

void NodeInstanceServerProxy::readSecondDataStream()
383 384 385
{
    QList<QVariant> commandList;

386 387
    while (!m_secondSocket->atEnd()) {
        if (m_secondSocket->bytesAvailable() < int(sizeof(quint32)))
388 389
            break;

390
        QDataStream in(m_secondSocket.data());
391
        in.setVersion(QDataStream::Qt_4_8);
392

393
        if (m_secondBlockSize == 0)
394
            in >> m_secondBlockSize;
395

396
        if (m_secondSocket->bytesAvailable() < m_secondBlockSize)
397 398
            break;

399 400 401 402 403 404 405 406
        quint32 commandCounter;
        in >> commandCounter;
        bool commandLost = !((m_secondLastReadCommandCounter == 0 && commandCounter == 0) || (m_secondLastReadCommandCounter + 1 == commandCounter));
        if (commandLost)
            qDebug() << "server command lost: " << m_secondLastReadCommandCounter <<  commandCounter;
        m_secondLastReadCommandCounter = commandCounter;


407 408
        QVariant command;
        in >> command;
409
        m_secondBlockSize = 0;
410 411 412 413 414 415 416 417 418

        commandList.append(command);
    }

    foreach (const QVariant &command, commandList) {
        dispatchCommand(command);
    }
}

419 420 421 422 423 424 425 426 427
void NodeInstanceServerProxy::readThirdDataStream()
{
    QList<QVariant> commandList;

    while (!m_thirdSocket->atEnd()) {
        if (m_thirdSocket->bytesAvailable() < int(sizeof(quint32)))
            break;

        QDataStream in(m_thirdSocket.data());
428
        in.setVersion(QDataStream::Qt_4_8);
429

430
        if (m_thirdBlockSize == 0)
431 432 433 434 435
            in >> m_thirdBlockSize;

        if (m_thirdSocket->bytesAvailable() < m_thirdBlockSize)
            break;

436 437 438 439 440 441 442 443
        quint32 commandCounter;
        in >> commandCounter;
        bool commandLost = !((m_thirdLastReadCommandCounter == 0 && commandCounter == 0) || (m_thirdLastReadCommandCounter + 1 == commandCounter));
        if (commandLost)
            qDebug() << "server command lost: " << m_thirdLastReadCommandCounter <<  commandCounter;
        m_thirdLastReadCommandCounter = commandCounter;


444 445 446 447 448 449 450 451 452 453 454 455
        QVariant command;
        in >> command;
        m_thirdBlockSize = 0;

        commandList.append(command);
    }

    foreach (const QVariant &command, commandList) {
        dispatchCommand(command);
    }
}

456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
void NodeInstanceServerProxy::printEditorProcessOutput()
{
    while (m_qmlPuppetEditorProcess->canReadLine()) {
        QByteArray line = m_qmlPuppetEditorProcess->readLine();
        line.chop(1);
        qDebug().nospace() << "Editor Puppet: " << qPrintable(line);
    }
    qDebug() << "\n";
}

void NodeInstanceServerProxy::printPreviewProcessOutput()
{
    while (m_qmlPuppetPreviewProcess->canReadLine()) {
        QByteArray line = m_qmlPuppetPreviewProcess->readLine();
        line.chop(1);
        qDebug().nospace() << "Preview Puppet: " << qPrintable(line);
    }
    qDebug() << "\n";
}

void NodeInstanceServerProxy::printRenderProcessOutput()
{
    while (m_qmlPuppetRenderProcess->canReadLine()) {
        QByteArray line = m_qmlPuppetRenderProcess->readLine();
        line.chop(1);
        qDebug().nospace() << "Render Puppet: " << qPrintable(line);
    }

    qDebug() << "\n";
}

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
void NodeInstanceServerProxy::createInstances(const CreateInstancesCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::changeFileUrl(const ChangeFileUrlCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::createScene(const CreateSceneCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::clearScene(const ClearSceneCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::removeInstances(const RemoveInstancesCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::removeProperties(const RemovePropertiesCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::changePropertyBindings(const ChangeBindingsCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::changePropertyValues(const ChangeValuesCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

527 528 529 530 531
void NodeInstanceServerProxy::changeAuxiliaryValues(const ChangeAuxiliaryCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
void NodeInstanceServerProxy::reparentInstances(const ReparentInstancesCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::changeIds(const ChangeIdsCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

void NodeInstanceServerProxy::changeState(const ChangeStateCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

547 548 549 550
void NodeInstanceServerProxy::completeComponent(const CompleteComponentCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}
551

552
void NodeInstanceServerProxy::changeNodeSource(const ChangeNodeSourceCommand &command)
553 554 555 556
{
    writeCommand(QVariant::fromValue(command));
}

557 558 559 560 561
void NodeInstanceServerProxy::token(const TokenCommand &command)
{
    writeCommand(QVariant::fromValue(command));
}

562 563 564 565 566
void NodeInstanceServerProxy::removeSharedMemory(const RemoveSharedMemoryCommand &command)
{
   writeCommand(QVariant::fromValue(command));
}

567
} // namespace QmlDesigner