s60devicerunconfiguration.cpp 40 KB
Newer Older
con's avatar
con committed
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
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** 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.
**
** GNU Lesser General Public License Usage
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27 28 29
**
**************************************************************************/

30
#include "s60devicerunconfiguration.h"
31
#include "s60devicerunconfigurationwidget.h"
32
#include "qt4project.h"
Tobias Hunger's avatar
Tobias Hunger committed
33
#include "qt4target.h"
34 35 36 37
#include "qtversionmanager.h"
#include "profilereader.h"
#include "s60manager.h"
#include "s60devices.h"
38 39
#include "s60runconfigbluetoothstarter.h"
#include "bluetoothlistener_gui.h"
40
#include "symbiandevicemanager.h"
41
#include "qt4buildconfiguration.h"
42 43 44

#include <coreplugin/icore.h>
#include <coreplugin/messagemanager.h>
45
#include <coreplugin/progressmanager/progressmanager.h>
46
#include <utils/qtcassert.h>
con's avatar
con committed
47
#include <utils/pathchooser.h>
48 49
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/project.h>
con's avatar
con committed
50
#include <projectexplorer/buildconfiguration.h>
51

52 53
#include <debugger/debuggermanager.h>

54 55 56
#include <QtGui/QMessageBox>
#include <QtGui/QMainWindow>

57
using namespace ProjectExplorer;
dt's avatar
dt committed
58
using namespace Qt4ProjectManager;
59 60
using namespace Qt4ProjectManager::Internal;

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
namespace {
const char * const S60_DEVICE_RC_ID("Qt4ProjectManager.S60DeviceRunConfiguration");
const char * const S60_DEVICE_RC_PREFIX("Qt4ProjectManager.S60DeviceRunConfiguration.");

const char * const PRO_FILE_KEY("Qt4ProjectManager.S60DeviceRunConfiguration.ProFile");
const char * const SIGNING_MODE_KEY("Qt4ProjectManager.S60DeviceRunConfiguration.SigningMode");
const char * const CUSTOM_SIGNATURE_PATH_KEY("Qt4ProjectManager.S60DeviceRunConfiguration.CustomSignaturePath");
const char * const CUSTOM_KEY_PATH_KEY("Qt4ProjectManager.S60DeviceRunConfiguration.CustomKeyPath");
const char * const SERIAL_PORT_NAME_KEY("Qt4ProjectManager.S60DeviceRunConfiguration.SerialPortName");
const char * const COMMUNICATION_TYPE_KEY("Qt4ProjectManager.S60DeviceRunConfiguration.CommunicationType");
const char * const COMMAND_LINE_ARGUMENTS_KEY("Qt4ProjectManager.S60DeviceRunConfiguration.CommandLineArguments");

const int    PROGRESS_PACKAGECREATED = 100;
const int    PROGRESS_PACKAGESIGNED = 200;
const int    PROGRESS_DEPLOYBASE = 200;
const int    PROGRESS_PACKAGEDEPLOYED = 300;
const int    PROGRESS_PACKAGEINSTALLED = 400;
const int    PROGRESS_MAX = 400;

80
enum { debug = 0 };
81

82
// Format information about a file
83
static inline QString msgListFile(const QString &f)
84 85 86 87
{
    QString rc;
    const QFileInfo fi(f);
    QTextStream str(&rc);
88 89 90 91 92
    if (fi.exists()) {
        str << fi.size() << ' ' << fi.lastModified().toString(Qt::ISODate) << ' ' << QDir::toNativeSeparators(fi.absoluteFilePath());
    } else {
        str << "<non-existent> " << QDir::toNativeSeparators(fi.absoluteFilePath());
    }
93 94
    return rc;
}
95

96 97 98 99 100 101 102 103 104 105 106 107 108 109
QString pathFromId(const QString &id)
{
    if (!id.startsWith(QLatin1String(S60_DEVICE_RC_PREFIX)))
        return QString();
    return id.mid(QString::fromLatin1(S60_DEVICE_RC_PREFIX).size());
}

QString pathToId(const QString &path)
{
    return QString::fromLatin1(S60_DEVICE_RC_PREFIX) + path;
}

}

110
// ======== S60DeviceRunConfiguration
111

Tobias Hunger's avatar
Tobias Hunger committed
112 113
S60DeviceRunConfiguration::S60DeviceRunConfiguration(Target *parent, const QString &proFilePath) :
    RunConfiguration(parent,  QLatin1String(S60_DEVICE_RC_ID)),
114
    m_proFilePath(proFilePath),
con's avatar
con committed
115
    m_cachedTargetInformationValid(false),
116 117 118
#ifdef Q_OS_WIN
    m_serialPortName(QLatin1String("COM5")),
#else
119
    m_serialPortName(QLatin1String(SymbianUtils::SymbianDeviceManager::linuxBlueToothDeviceRootC) + QLatin1Char('0')),
120
#endif
con's avatar
con committed
121
    m_signingMode(SignSelf)
122 123 124 125
{
    ctor();
}

Tobias Hunger's avatar
Tobias Hunger committed
126 127
S60DeviceRunConfiguration::S60DeviceRunConfiguration(Target *target, S60DeviceRunConfiguration *source) :
    RunConfiguration(target, source),
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
    m_proFilePath(source->m_proFilePath),
    m_cachedTargetInformationValid(false),
    m_serialPortName(source->m_serialPortName),
    m_signingMode(source->m_signingMode),
    m_customSignaturePath(source->m_customSignaturePath),
    m_customKeyPath(source->m_customKeyPath)
{
    ctor();
}

void S60DeviceRunConfiguration::proFileUpdate(Qt4ProjectManager::Internal::Qt4ProFileNode *pro)
{
    if (m_proFilePath == pro->path())
        invalidateCachedTargetInformation();
}

void S60DeviceRunConfiguration::ctor()
145 146
{
    if (!m_proFilePath.isEmpty())
147
        setDisplayName(tr("%1 on Symbian Device").arg(QFileInfo(m_proFilePath).completeBaseName()));
148
    else
149
        setDisplayName(tr("QtS60DeviceRunConfiguration"));
150

Tobias Hunger's avatar
Tobias Hunger committed
151
    connect(target(), SIGNAL(targetInformationChanged()),
152
            this, SLOT(invalidateCachedTargetInformation()));
153

Tobias Hunger's avatar
Tobias Hunger committed
154
    connect(qt4Target()->qt4Project(), SIGNAL(proFileUpdated(Qt4ProjectManager::Internal::Qt4ProFileNode*)),
155
            this, SLOT(proFileUpdate(Qt4ProjectManager::Internal::Qt4ProFileNode*)));
156 157
}

158

159 160 161 162
S60DeviceRunConfiguration::~S60DeviceRunConfiguration()
{
}

Tobias Hunger's avatar
Tobias Hunger committed
163
Qt4Target *S60DeviceRunConfiguration::qt4Target() const
dt's avatar
dt committed
164
{
Tobias Hunger's avatar
Tobias Hunger committed
165
    return static_cast<Qt4Target *>(target());
dt's avatar
dt committed
166 167
}

168 169 170
ProjectExplorer::ToolChain::ToolChainType S60DeviceRunConfiguration::toolChainType(
        ProjectExplorer::BuildConfiguration *configuration) const
{
171 172
    if (Qt4BuildConfiguration *bc = qobject_cast<Qt4BuildConfiguration *>(configuration))
        return bc->toolChainType();
173 174 175
    return ProjectExplorer::ToolChain::INVALID;
}

176 177
ProjectExplorer::ToolChain::ToolChainType S60DeviceRunConfiguration::toolChainType() const
{
Tobias Hunger's avatar
Tobias Hunger committed
178
    if (Qt4BuildConfiguration *bc = qobject_cast<Qt4BuildConfiguration *>(target()->activeBuildConfiguration()))
179
        return bc->toolChainType();
180
    return ProjectExplorer::ToolChain::INVALID;
181 182
}

183
bool S60DeviceRunConfiguration::isEnabled(ProjectExplorer::BuildConfiguration *configuration) const
184
{
185 186 187 188 189 190 191 192 193 194 195 196
    const Qt4BuildConfiguration *qt4bc = static_cast<const Qt4BuildConfiguration *>(configuration);
    switch (qt4bc->toolChainType()) {
    case ToolChain::GCCE:
    case ToolChain::RVCT_ARMV5:
    case ToolChain::RVCT_ARMV6:
    case ToolChain::GCCE_GNUPOC:
    case ToolChain::RVCT_ARMV5_GNUPOC:
        return true;
    default:
        break;
    }
    return false;
197 198 199 200 201 202 203
}

QWidget *S60DeviceRunConfiguration::configurationWidget()
{
    return new S60DeviceRunConfigurationWidget(this);
}

204
QVariantMap S60DeviceRunConfiguration::toMap() const
205
{
206
    QVariantMap map(ProjectExplorer::RunConfiguration::toMap());
Tobias Hunger's avatar
Tobias Hunger committed
207
    const QDir projectDir = QFileInfo(target()->project()->file()->fileName()).absoluteDir();
208 209 210 211 212 213 214 215 216

    map.insert(QLatin1String(PRO_FILE_KEY), projectDir.relativeFilePath(m_proFilePath));
    map.insert(QLatin1String(SIGNING_MODE_KEY), (int)m_signingMode);
    map.insert(QLatin1String(CUSTOM_SIGNATURE_PATH_KEY), m_customSignaturePath);
    map.insert(QLatin1String(CUSTOM_KEY_PATH_KEY), m_customKeyPath);
    map.insert(QLatin1String(SERIAL_PORT_NAME_KEY), m_serialPortName);
    map.insert(QLatin1String(COMMAND_LINE_ARGUMENTS_KEY), m_commandLineArguments);

    return map;
217 218
}

219
bool S60DeviceRunConfiguration::fromMap(const QVariantMap &map)
220
{
Tobias Hunger's avatar
Tobias Hunger committed
221
    const QDir projectDir = QFileInfo(target()->project()->file()->fileName()).absoluteDir();
222 223 224 225 226 227 228 229 230

    m_proFilePath = projectDir.filePath(map.value(QLatin1String(PRO_FILE_KEY)).toString());
    m_signingMode = static_cast<SigningMode>(map.value(QLatin1String(SIGNING_MODE_KEY)).toInt());
    m_customSignaturePath = map.value(QLatin1String(CUSTOM_SIGNATURE_PATH_KEY)).toString();
    m_customKeyPath = map.value(QLatin1String(CUSTOM_KEY_PATH_KEY)).toString();
    m_serialPortName = map.value(QLatin1String(SERIAL_PORT_NAME_KEY)).toString().trimmed();
    m_commandLineArguments = map.value(QLatin1String(COMMAND_LINE_ARGUMENTS_KEY)).toStringList();

    return RunConfiguration::fromMap(map);
con's avatar
con committed
231 232 233 234 235 236 237 238 239
}

QString S60DeviceRunConfiguration::serialPortName() const
{
    return m_serialPortName;
}

void S60DeviceRunConfiguration::setSerialPortName(const QString &name)
{
con's avatar
con committed
240 241 242 243 244
    const QString &candidate = name.trimmed();
    if (m_serialPortName == candidate)
        return;
    m_serialPortName = candidate;
    emit serialPortNameChanged();
245 246
}

247 248 249 250 251 252
QString S60DeviceRunConfiguration::targetName() const
{
    const_cast<S60DeviceRunConfiguration *>(this)->updateTarget();
    return m_targetName;
}

con's avatar
con committed
253
QString S60DeviceRunConfiguration::basePackageFilePath() const
254 255
{
    const_cast<S60DeviceRunConfiguration *>(this)->updateTarget();
con's avatar
con committed
256
    return m_baseFileName;
257 258
}

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
QString S60DeviceRunConfiguration::symbianPlatform() const
{
    const_cast<S60DeviceRunConfiguration *>(this)->updateTarget();
    return m_platform;
}

QString S60DeviceRunConfiguration::symbianTarget() const
{
    const_cast<S60DeviceRunConfiguration *>(this)->updateTarget();
    return m_target;
}

QString S60DeviceRunConfiguration::packageTemplateFileName() const
{
    const_cast<S60DeviceRunConfiguration *>(this)->updateTarget();
    return m_packageTemplateFileName;
}

con's avatar
con committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
S60DeviceRunConfiguration::SigningMode S60DeviceRunConfiguration::signingMode() const
{
    return m_signingMode;
}

void S60DeviceRunConfiguration::setSigningMode(SigningMode mode)
{
    m_signingMode = mode;
}

QString S60DeviceRunConfiguration::customSignaturePath() const
{
    return m_customSignaturePath;
}

void S60DeviceRunConfiguration::setCustomSignaturePath(const QString &path)
{
    m_customSignaturePath = path;
}

QString S60DeviceRunConfiguration::customKeyPath() const
{
    return m_customKeyPath;
}

void S60DeviceRunConfiguration::setCustomKeyPath(const QString &path)
{
    m_customKeyPath = path;
}

307 308 309 310 311 312 313 314
QString S60DeviceRunConfiguration::packageFileName() const
{
    QString rc = basePackageFilePath();
    if (!rc.isEmpty())
        rc += QLatin1String(".pkg");
    return rc;
}

315 316 317 318 319 320 321 322
/* Grep a package file for the '.exe' file. Curently for use on Linux only
 * as the '.pkg'-files on Windows do not contain drive letters, which is not
 * handled here. \code
; Executable and default resource files
"./foo.exe"    - "!:\sys\bin\foo.exe"
\endcode  */

static inline QString executableFromPackageUnix(const QString &packageFileName)
323
{
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
    QFile packageFile(packageFileName);
    if (!packageFile.open(QIODevice::ReadOnly|QIODevice::Text))
        return QString();
    QRegExp pattern(QLatin1String("^\"(.*.exe)\" *- \"!:.*.exe\"$"));
    QTC_ASSERT(pattern.isValid(), return QString());
    foreach(const QString &line, QString::fromLocal8Bit(packageFile.readAll()).split(QLatin1Char('\n')))
        if (pattern.exactMatch(line)) {
            // Expand relative paths by package file paths
            QString rc = pattern.cap(1);
            if (rc.startsWith(QLatin1String("./")))
                rc.remove(0, 2);
            const QFileInfo fi(rc);
            if (fi.isAbsolute())
                return rc;
            return QFileInfo(packageFileName).absolutePath() + QLatin1Char('/') + rc;
        }
    return QString();
}
342

343 344 345 346 347 348 349 350
const QtVersion *S60DeviceRunConfiguration::qtVersion() const
{
    if (const BuildConfiguration *bc = target()->activeBuildConfiguration())
        if (const Qt4BuildConfiguration *qt4bc = qobject_cast<const Qt4BuildConfiguration *>(bc))
            return qt4bc->qtVersion();
    return 0;
}

351 352 353 354 355 356 357 358 359
QString S60DeviceRunConfiguration::localExecutableFileName() const
{
    QString localExecutable;
    switch (toolChainType()) {
    case ToolChain::GCCE_GNUPOC:
    case ToolChain::RVCT_ARMV5_GNUPOC:
        localExecutable = executableFromPackageUnix(packageTemplateFileName());
        break;
    default: {
360 361 362
            const QtVersion *qtv = qtVersion();
            QTC_ASSERT(qtv, return QString());
            const S60Devices::Device device = S60Manager::instance()->deviceForQtVersion(qtv);
363 364 365 366 367 368 369 370
            QTextStream(&localExecutable) << device.epocRoot << "/epoc32/release/"
                    << symbianPlatform() << '/' << symbianTarget() << '/' << targetName()
                    << ".exe";
        }
        break;
    }
    if (debug)
        qDebug() << "Local executable" << localExecutable;
371
    return QDir::toNativeSeparators(localExecutable);
372 373
}

374 375 376 377 378 379
QString S60DeviceRunConfiguration::signedPackage() const
{
    const_cast<S60DeviceRunConfiguration *>(this)->updateTarget();
    return QDir::toNativeSeparators(m_baseFileName + QLatin1String(".sis"));
}

380 381 382 383 384 385 386 387 388 389
QStringList S60DeviceRunConfiguration::commandLineArguments() const
{
    return m_commandLineArguments;
}

void S60DeviceRunConfiguration::setCommandLineArguments(const QStringList &args)
{
    m_commandLineArguments = args;
}

390 391 392 393 394 395 396 397 398 399 400
// Fix up target specification for "make sis":
// "udeb"-> "debug", "urel" -> "release"
static inline QString fixBaseNameTarget(const QString &in)
{
    if (in == QLatin1String("udeb"))
        return QLatin1String("debug");
    if (in == QLatin1String("urel"))
        return QLatin1String("release");
    return in;
}

401 402 403 404
void S60DeviceRunConfiguration::updateTarget()
{
    if (m_cachedTargetInformationValid)
        return;
Tobias Hunger's avatar
Tobias Hunger committed
405
    Qt4TargetInformation info = qt4Target()->targetInformation(qt4Target()->activeBuildConfiguration(),
406 407 408 409
                                                                m_proFilePath);
    if (info.error != Qt4TargetInformation::NoError) {
        if (info.error == Qt4TargetInformation::ProParserError) {
            Core::ICore::instance()->messageManager()->printToOutputPane(
410
                    tr("Could not parse %1. The Qt Symbian Device run configuration %2 can not be started.")
411
                    .arg(m_proFilePath).arg(displayName()));
412
        }
413 414 415 416
        m_targetName.clear();
        m_baseFileName.clear();
        m_packageTemplateFileName.clear();
        m_platform.clear();
417 418 419 420
        m_cachedTargetInformationValid = true;
        emit targetInformationChanged();
        return;
    }
421

422
    m_targetName = info.target;
dt's avatar
dt committed
423

424
    m_baseFileName = info.workingDir + QLatin1Char('/') + m_targetName;
425
    m_packageTemplateFileName = m_baseFileName + QLatin1String("_template.pkg");
426

Tobias Hunger's avatar
Tobias Hunger committed
427
    Qt4BuildConfiguration *qt4bc = qt4Target()->activeBuildConfiguration();
428
    switch (qt4bc->toolChainType()) {
429 430
    case ToolChain::GCCE:
    case ToolChain::GCCE_GNUPOC:
431
        m_platform = QLatin1String("gcce");
432 433
        break;
    case ToolChain::RVCT_ARMV5:
434
    case ToolChain::RVCT_ARMV5_GNUPOC:
435
        m_platform = QLatin1String("armv5");
436
        break;
437
    default:
438
        m_platform = QLatin1String("armv6");
439 440
        break;
    }
441
    if (qt4bc->qmakeBuildConfiguration() & QtVersion::DebugBuild)
442
        m_target = QLatin1String("udeb");
con's avatar
con committed
443
    else
444
        m_target = QLatin1String("urel");
445 446
    m_baseFileName += QLatin1Char('_') + fixBaseNameTarget(m_target)
                      + QLatin1Char('-') + m_platform;
447 448 449 450 451 452 453 454 455 456
    m_cachedTargetInformationValid = true;
    emit targetInformationChanged();
}

void S60DeviceRunConfiguration::invalidateCachedTargetInformation()
{
    m_cachedTargetInformationValid = false;
    emit targetInformationChanged();
}

con's avatar
con committed
457

458 459
// ======== S60DeviceRunConfigurationFactory

460 461
S60DeviceRunConfigurationFactory::S60DeviceRunConfigurationFactory(QObject *parent) :
    IRunConfigurationFactory(parent)
462 463 464 465 466 467 468
{
}

S60DeviceRunConfigurationFactory::~S60DeviceRunConfigurationFactory()
{
}

Tobias Hunger's avatar
Tobias Hunger committed
469
QStringList S60DeviceRunConfigurationFactory::availableCreationIds(Target *parent) const
470
{
Tobias Hunger's avatar
Tobias Hunger committed
471 472 473
    Qt4Target *target = qobject_cast<Qt4Target *>(parent);
    if (!target ||
        target->id() != QLatin1String(S60_DEVICE_TARGET_ID))
474 475
        return QStringList();

Tobias Hunger's avatar
Tobias Hunger committed
476
    return target->qt4Project()->applicationProFilePathes(QLatin1String(S60_DEVICE_RC_PREFIX));
477 478
}

479
QString S60DeviceRunConfigurationFactory::displayNameForId(const QString &id) const
480
{
481 482 483
    if (!pathFromId(id).isEmpty())
        return tr("%1 on Symbian Device").arg(QFileInfo(pathFromId(id)).completeBaseName());
    return QString();
484 485
}

Tobias Hunger's avatar
Tobias Hunger committed
486
bool S60DeviceRunConfigurationFactory::canCreate(Target *parent, const QString &id) const
487
{
Tobias Hunger's avatar
Tobias Hunger committed
488 489 490
    Qt4Target * t(qobject_cast<Qt4Target *>(parent));
    if (!t ||
        t->id() != QLatin1String(S60_DEVICE_TARGET_ID))
491
        return false;
Tobias Hunger's avatar
Tobias Hunger committed
492
    return t->qt4Project()->hasApplicationProFile(pathFromId(id));
493 494
}

Tobias Hunger's avatar
Tobias Hunger committed
495
RunConfiguration *S60DeviceRunConfigurationFactory::create(Target *parent, const QString &id)
496
{
497 498 499
    if (!canCreate(parent, id))
        return 0;

Tobias Hunger's avatar
Tobias Hunger committed
500 501
    Qt4Target *t(static_cast<Qt4Target *>(parent));
    return new S60DeviceRunConfiguration(t, pathFromId(id));
502 503
}

Tobias Hunger's avatar
Tobias Hunger committed
504
bool S60DeviceRunConfigurationFactory::canRestore(Target *parent, const QVariantMap &map) const
505
{
Tobias Hunger's avatar
Tobias Hunger committed
506 507 508
    Qt4Target * t(qobject_cast<Qt4Target *>(parent));
    if (!t ||
        t->id() != QLatin1String(S60_DEVICE_TARGET_ID))
509 510 511 512 513
        return false;
    QString id(ProjectExplorer::idFromMap(map));
    return id == QLatin1String(S60_DEVICE_RC_ID);
}

Tobias Hunger's avatar
Tobias Hunger committed
514
RunConfiguration *S60DeviceRunConfigurationFactory::restore(Target *parent, const QVariantMap &map)
515 516 517
{
    if (!canRestore(parent, map))
        return 0;
Tobias Hunger's avatar
Tobias Hunger committed
518 519
    Qt4Target *t(static_cast<Qt4Target *>(parent));
    S60DeviceRunConfiguration *rc(new S60DeviceRunConfiguration(t, QString()));
520 521 522 523 524 525 526
    if (rc->fromMap(map))
        return rc;

    delete rc;
    return 0;
}

Tobias Hunger's avatar
Tobias Hunger committed
527
bool S60DeviceRunConfigurationFactory::canClone(Target *parent, RunConfiguration *source) const
528
{
Tobias Hunger's avatar
Tobias Hunger committed
529
    if (!qobject_cast<Qt4Target *>(parent))
530 531 532 533
        return false;
    return source->id() == QLatin1String(S60_DEVICE_RC_ID);
}

Tobias Hunger's avatar
Tobias Hunger committed
534
RunConfiguration *S60DeviceRunConfigurationFactory::clone(Target *parent, RunConfiguration *source)
535 536 537
{
    if (!canClone(parent, source))
        return 0;
Tobias Hunger's avatar
Tobias Hunger committed
538
    Qt4Target *t = static_cast<Qt4Target *>(parent);
539
    S60DeviceRunConfiguration * old(static_cast<S60DeviceRunConfiguration *>(source));
Tobias Hunger's avatar
Tobias Hunger committed
540
    return new S60DeviceRunConfiguration(t, old);
541 542
}

543
// ======== S60DeviceRunControlBase
Friedemann Kleint's avatar
Friedemann Kleint committed
544

545
S60DeviceRunControlBase::S60DeviceRunControlBase(RunConfiguration *runConfiguration) :
546
    RunControl(runConfiguration),
547
    m_toolChain(ProjectExplorer::ToolChain::INVALID),
548
    m_makesisProcess(new QProcess(this)),
549 550
    m_releaseDeviceAfterLauncherFinish(false),
    m_handleDeviceRemoval(true),
551
    m_launcher(0)
552 553 554 555
{
    // connect for automatically reporting the "finished deploy" state to the progress manager
    connect(this, SIGNAL(finished()), this, SLOT(reportDeployFinished()));

556
    connect(m_makesisProcess, SIGNAL(readyReadStandardError()),
con's avatar
con committed
557
            this, SLOT(readStandardError()));
558
    connect(m_makesisProcess, SIGNAL(readyReadStandardOutput()),
con's avatar
con committed
559
            this, SLOT(readStandardOutput()));
560
    connect(m_makesisProcess, SIGNAL(error(QProcess::ProcessError)),
con's avatar
con committed
561
            this, SLOT(makesisProcessFailed()));
562
    connect(m_makesisProcess, SIGNAL(finished(int,QProcess::ExitStatus)),
con's avatar
con committed
563
            this, SLOT(makesisProcessFinished()));
564

565
    S60DeviceRunConfiguration *s60runConfig = qobject_cast<S60DeviceRunConfiguration *>(runConfiguration);
566
    const Qt4BuildConfiguration *activeBuildConf = s60runConfig->qt4Target()->activeBuildConfiguration();
dt's avatar
dt committed
567

568
    QTC_ASSERT(s60runConfig, return);
569
    m_toolChain = s60runConfig->toolChainType();
570
    m_serialPortName = s60runConfig->serialPortName();
571
    m_serialPortFriendlyName = SymbianUtils::SymbianDeviceManager::instance()->friendlyNameForPort(m_serialPortName);
572 573
    m_targetName = s60runConfig->targetName();
    m_baseFileName = s60runConfig->basePackageFilePath();
574
    m_signedPackage = s60runConfig->signedPackage();
575
    m_commandLineArguments = s60runConfig->commandLineArguments();
con's avatar
con committed
576
    m_workingDirectory = QFileInfo(m_baseFileName).absolutePath();
577
    m_qtDir = activeBuildConf->qtVersion()->versionInfo().value("QT_INSTALL_DATA");
578 579 580
    m_useCustomSignature = (s60runConfig->signingMode() == S60DeviceRunConfiguration::SignCustom);
    m_customSignaturePath = s60runConfig->customSignaturePath();
    m_customKeyPath = s60runConfig->customKeyPath();
581 582 583
    if (const QtVersion *qtv = s60runConfig->qtVersion())
        m_qtBinPath = qtv->versionInfo().value(QLatin1String("QT_INSTALL_BINS"));
    QTC_ASSERT(!m_qtBinPath.isEmpty(), return);
584
    const S60Devices::Device device = S60Manager::instance()->deviceForQtVersion(activeBuildConf->qtVersion());
585 586 587 588 589 590 591 592
    // 'sis' is a make target. Set up with correct environment
    // Also add $QTDIR/bin, since it needs to find 'createpackage'.
    ProjectExplorer::ToolChain *toolchain = activeBuildConf->toolChain();
    m_makeTool = toolchain->makeCommand();
    ProjectExplorer::Environment env = ProjectExplorer::Environment::systemEnvironment();
    toolchain->addToEnvironment(env);
    env.prependOrSetPath(m_qtBinPath);
    m_makesisProcess->setEnvironment(env.toStringList());
593
    m_executableFileName = s60runConfig->localExecutableFileName();
594 595
    m_packageFilePath = s60runConfig->packageFileName();
    m_packageFile = QFileInfo(m_packageFilePath).fileName();
596
    if (debug)
597
        qDebug() << "S60DeviceRunControlBase::CT" << m_targetName << ProjectExplorer::ToolChain::toolChainName(m_toolChain)
598
                 << m_serialPortName << m_workingDirectory;
599
}
600

601 602 603 604 605 606 607 608
S60DeviceRunControlBase::~S60DeviceRunControlBase()
{
    if (m_launcher) {
        m_launcher->deleteLater();
        m_launcher = 0;
    }
}

609 610 611 612 613
void S60DeviceRunControlBase::setReleaseDeviceAfterLauncherFinish(bool v)
{
    m_releaseDeviceAfterLauncherFinish = v;
}

614 615 616 617 618 619 620 621 622 623 624 625 626 627
QString S60DeviceRunControlBase::signSisKey() const
{
    const QString key = m_useCustomSignature ? m_customKeyPath:
                        m_qtDir + QLatin1String("/src/s60installs/selfsigned.key");
    return QDir::toNativeSeparators(key);
}

QString S60DeviceRunControlBase::signSisCertificate() const
{
    const QString cert = m_useCustomSignature ? m_customSignaturePath :
                         m_qtDir + QLatin1String("/src/s60installs/selfsigned.cer");
    return QDir::toNativeSeparators(cert);
}

628 629 630 631 632 633 634
// Format a message with command line
static inline QString msgRun(const QString &cmd, const QStringList &args)
{
    const QChar blank = QLatin1Char(' ');
    return QDir::toNativeSeparators(cmd) + blank + args.join(QString(blank));
}

635 636 637 638 639 640 641 642 643 644
static inline bool ensureDeleteFile(const QString &fileName, QString *errorMessage)
{
    QFile file(fileName);
    if (file.exists() && !file.remove()) {
        *errorMessage = S60DeviceRunControlBase::tr("Unable to remove existing file '%1': %2").arg(fileName, file.errorString());
        return false;
    }
    return true;
}

645
void S60DeviceRunControlBase::start()
646
{
647 648 649 650 651 652 653
    m_deployProgress = new QFutureInterface<void>;
    Core::ICore::instance()->progressManager()->addTask(m_deployProgress->future(),
                                                        tr("Deploying"),
                                                        QLatin1String("Symbian.Deploy"));
    m_deployProgress->setProgressRange(0, PROGRESS_MAX);
    m_deployProgress->setProgressValue(0);
    m_deployProgress->reportStarted();
654
    emit started();
655 656 657 658 659
    if (m_serialPortName.isEmpty()) {
        error(this, tr("There is no device plugged in."));
        emit finished();
        return;
    }
660

661
    emit addToOutputWindow(this, tr("Creating %1 ...").arg(m_signedPackage));
662
    emit addToOutputWindow(this, tr("Executable file: %1").arg(msgListFile(m_executableFileName)));
con's avatar
con committed
663

664 665 666 667 668 669
    QString errorMessage;
    QString settingsCategory;
    QString settingsPage;
    if (!checkConfiguration(&errorMessage, &settingsCategory, &settingsPage)) {
        error(this, errorMessage);
        emit finished();
670 671
        Core::ICore::instance()->showWarningWithOptions(tr("Debugger for Symbian Platform"),
                                                        errorMessage, QString(),
672 673 674
                                                        settingsCategory, settingsPage);
        return;
    }
675 676 677 678 679
    // Be sure to delete old files
    if (!ensureDeleteFile(m_signedPackage, &errorMessage)) {
        error(this, errorMessage);
        emit finished();
    }
680

681
    QStringList makeSisArgs;
682 683 684
    makeSisArgs << QLatin1String("sis")
            << (QLatin1String("QT_SIS_CERTIFICATE=") + signSisCertificate())
            << (QLatin1String("QT_SIS_KEY=") + signSisKey());
685
    m_makesisProcess->setWorkingDirectory(m_workingDirectory);
686
    emit addToOutputWindow(this, msgRun(m_makeTool, makeSisArgs));
687
    if (debug)
688
        qDebug() << m_makeTool <<  makeSisArgs << m_workingDirectory;
689

690 691
    m_makesisProcess->start(m_makeTool, makeSisArgs, QIODevice::ReadOnly);
    m_makesisProcess->closeWriteChannel();
692 693
}

694 695 696 697 698 699 700 701 702 703 704
static inline void stopProcess(QProcess *p)
{
    const int timeOutMS = 200;
    if (p->state() != QProcess::Running)
        return;
    p->terminate();
    if (p->waitForFinished(timeOutMS))
        return;
    p->kill();
}

705
void S60DeviceRunControlBase::stop()
706
{
707 708
    if (m_makesisProcess)
        stopProcess(m_makesisProcess);
709 710
    if (m_launcher)
        m_launcher->terminate();
711 712
}

713
bool S60DeviceRunControlBase::isRunning() const
714
{
715
    return m_makesisProcess->state() != QProcess::NotRunning;
716 717
}

718
void S60DeviceRunControlBase::readStandardError()
719
{
con's avatar
con committed
720 721 722
    QProcess *process = static_cast<QProcess *>(sender());
    QByteArray data = process->readAllStandardError();
    emit addToOutputWindowInline(this, QString::fromLocal8Bit(data.constData(), data.length()));
723 724
}

725
void S60DeviceRunControlBase::readStandardOutput()
726
{
con's avatar
con committed
727 728 729 730 731
    QProcess *process = static_cast<QProcess *>(sender());
    QByteArray data = process->readAllStandardOutput();
    emit addToOutputWindowInline(this, QString::fromLocal8Bit(data.constData(), data.length()));
}

732
void S60DeviceRunControlBase::makesisProcessFailed()
733
{
734
    processFailed(m_makeTool, m_makesisProcess->error());
735 736
}

737 738 739
static inline bool renameFile(const QString &sourceName, const QString &targetName,
                              QString *errorMessage)
{
740 741
    if (sourceName == targetName)
        return true;
742
    if (!ensureDeleteFile(targetName, errorMessage))
743 744 745 746 747 748 749 750 751 752
        return false;
    QFile source(sourceName);
    if (!source.rename(targetName)) {
        *errorMessage = S60DeviceRunControlBase::tr("Unable to rename file '%1' to '%2': %3")
                        .arg(sourceName, targetName, source.errorString());
        return false;
    }
    return true;
}

753
void S60DeviceRunControlBase::makesisProcessFinished()
754
{
755
    if (m_makesisProcess->exitCode() != 0) {
756
        error(this, tr("An error occurred while creating the package."));
757
        stop();
758 759 760
        emit finished();
        return;
    }
761
    m_deployProgress->setProgressValue(PROGRESS_PACKAGECREATED);
762 763
    QString errorMessage;
    bool ok = false;
764 765
    switch (m_toolChain) {
    case ProjectExplorer::ToolChain::GCCE_GNUPOC:
766 767 768 769 770 771
    case ProjectExplorer::ToolChain::RVCT_ARMV5_GNUPOC: {
        // 'make sis' creates 'targetname.sis'. Rename to full name
        // 'targetname_armX_udeb.sis'.
        const QString oldName = m_workingDirectory + QLatin1Char('/') + m_targetName + QLatin1String(".sis");
        ok = renameFile(oldName, m_signedPackage, &errorMessage);
    }
772 773
        break;
    default:
774 775 776 777
        // ABLD: Check on file 'targetname_armX_udeb.sis'.
        ok = QFileInfo(m_signedPackage).isFile();
        if (!ok)
            errorMessage = tr("Failed to create '%1'").arg(m_signedPackage);
778 779
        break;
    }
780 781 782
    if (ok) {
        startDeployment();
    } else {
783 784 785 786
        error(this, errorMessage);
        stop();
        emit finished();
    }
787 788 789 790
}

void S60DeviceRunControlBase::startDeployment()
{
791
    QString errorMessage;
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
    bool success = false;
    do {
        connect(SymbianUtils::SymbianDeviceManager::instance(), SIGNAL(deviceRemoved(const SymbianUtils::SymbianDevice)),
                this, SLOT(deviceRemoved(SymbianUtils::SymbianDevice)));
        m_launcher = trk::Launcher::acquireFromDeviceManager(m_serialPortName, 0, &errorMessage);
        if (!m_launcher)
            break;

        connect(m_launcher, SIGNAL(finished()), this, SLOT(launcherFinished()));
        connect(m_launcher, SIGNAL(canNotConnect(QString)), this, SLOT(printConnectFailed(QString)));
        connect(m_launcher, SIGNAL(copyingStarted()), this, SLOT(printCopyingNotice()));
        connect(m_launcher, SIGNAL(canNotCreateFile(QString,QString)), this, SLOT(printCreateFileFailed(QString,QString)));
        connect(m_launcher, SIGNAL(canNotWriteFile(QString,QString)), this, SLOT(printWriteFileFailed(QString,QString)));
        connect(m_launcher, SIGNAL(canNotCloseFile(QString,QString)), this, SLOT(printCloseFileFailed(QString,QString)));
        connect(m_launcher, SIGNAL(installingStarted()), this, SLOT(printInstallingNotice()));
        connect(m_launcher, SIGNAL(canNotInstall(QString,QString)), this, SLOT(printInstallFailed(QString,QString)));
        connect(m_launcher, SIGNAL(installingFinished()), this, SLOT(printInstallingFinished()));
        connect(m_launcher, SIGNAL(copyProgress(int)), this, SLOT(printCopyProgress(int)));
        connect(m_launcher, SIGNAL(stateChanged(int)), this, SLOT(slotLauncherStateChanged(int)));
        connect(m_launcher, SIGNAL(processStopped(uint,uint,uint,QString)),
                this, SLOT(processStopped(uint,uint,uint,QString)));

        //TODO sisx destination and file path user definable
        if (!m_commandLineArguments.isEmpty())
            m_launcher->setCommandLineArgs(m_commandLineArguments);
817
        const QString copyDst = QString::fromLatin1("C:\\Data\\%1.sis").arg(QFileInfo(m_baseFileName).fileName());
818
        const QString runFileName = QString::fromLatin1("C:\\sys\\bin\\%1.exe").arg(m_targetName);
819
        m_launcher->setCopyFileName(m_signedPackage, copyDst);
820 821
        m_launcher->setInstallFileName(copyDst);
        initLauncher(runFileName, m_launcher);
822
        emit addToOutputWindow(this, tr("Package: %1\nDeploying application to '%2'...").arg(msgListFile(m_signedPackage), m_serialPortFriendlyName));
823 824
        // Prompt the user to start up the Blue tooth connection
        const trk::PromptStartCommunicationResult src =
825
            S60RunConfigBluetoothStarter::startCommunication(m_launcher->trkDevice(),
826 827 828 829 830 831 832 833 834 835
                                                             0, &errorMessage);
        if (src != trk::PromptStartCommunicationConnected)
            break;
        if (!m_launcher->startServer(&errorMessage)) {
            errorMessage = tr("Could not connect to phone on port '%1': %2\n"
                              "Check if the phone is connected and App TRK is running.").arg(m_serialPortName, errorMessage);
            break;
        }
        success = true;
    } while (false);
836

837 838 839
    if (!success) {
        if (!errorMessage.isEmpty())
            error(this, errorMessage);
840
        stop();
con's avatar
con committed
841 842
        emit finished();
    }
843 844
}

845
void S60DeviceRunControlBase::printCreateFileFailed(const QString &filename, const QString &errorMessage)
con's avatar
con committed
846
{
847
    emit addToOutputWindow(this, tr("Could not create file %1 on device: %2").arg(filename, errorMessage));
con's avatar
con committed
848 849
}

850 851 852 853 854
void S60DeviceRunControlBase::printWriteFileFailed(const QString &filename, const QString &errorMessage)
{
    emit addToOutputWindow(this, tr("Could not write to file %1 on device: %2").arg(filename, errorMessage));
}

855 856 857 858 859 860
void S60DeviceRunControlBase::printCloseFileFailed(const QString &filename, const QString &errorMessage)
{
    const QString msg = tr("Could not close file %1 on device: %2. It will be closed when App TRK is closed.");
    emit addToOutputWindow(this, msg.arg(filename, errorMessage));
}

861 862 863 864 865
void S60DeviceRunControlBase::printConnectFailed(const QString &errorMessage)
{
    emit addToOutputWindow(this, tr("Could not connect to App TRK on device: %1. Restarting App TRK might help.").arg(errorMessage));
}

866
void S60DeviceRunControlBase::printCopyingNotice()
867
{
868
    emit addToOutputWindow(this, tr("Copying install file..."));
869 870
}

871
void S60DeviceRunControlBase::printCopyProgress(int progress)
con's avatar
con committed
872
{
873
    m_deployProgress->setProgressValue(PROGRESS_DEPLOYBASE + progress);
con's avatar
con committed
874 875
}

876
void S60DeviceRunControlBase::printInstallingNotice()
con's avatar
con committed
877
{
878
    m_deployProgress->setProgressValue(PROGRESS_PACKAGEDEPLOYED);
con's avatar
con committed
879 880 881
    emit addToOutputWindow(this, tr("Installing application..."));
}

882 883 884 885 886 887 888 889
void S60DeviceRunControlBase::printInstallingFinished()
{
    m_deployProgress->setProgressValue(PROGRESS_PACKAGEINSTALLED);
    m_deployProgress->reportFinished();
    delete m_deployProgress;
    m_deployProgress = 0;
}

890 891 892 893 894
void S60DeviceRunControlBase::printInstallFailed(const QString &filename, const QString &errorMessage)
{
    emit addToOutputWindow(this, tr("Could not install from package %1 on device: %2").arg(filename, errorMessage));
}

895 896
void S60DeviceRunControlBase::launcherFinished()
{
897 898 899 900
    if (m_releaseDeviceAfterLauncherFinish) {
        m_handleDeviceRemoval = false;
        trk::Launcher::releaseToDeviceManager(m_launcher);
    }
901 902 903 904 905
    m_launcher->deleteLater();
    m_launcher = 0;
    handleLauncherFinished();
}

906 907 908 909 910 911 912 913 914
void S60DeviceRunControlBase::reportDeployFinished()
{
    if (m_deployProgress) {
        m_deployProgress->reportFinished();
        delete m_deployProgress;
        m_deployProgress = 0;
    }
}

915 916 917 918 919 920
void S60DeviceRunControlBase::processStopped(uint pc, uint pid, uint tid, const QString& reason)
{
    emit addToOutputWindow(this, trk::Launcher::msgStopped(pid, tid, pc, reason));
    m_launcher->terminate();
}

921 922 923
QMessageBox *S60DeviceRunControlBase::createTrkWaitingMessageBox(const QString &port, QWidget *parent)
{
    const QString title  = QCoreApplication::translate("Qt4ProjectManager::Internal::S60DeviceRunControlBase",
Robert Loehning's avatar
Robert Loehning committed
924
                                                       "Waiting for App TRK");
925
    const QString text = QCoreApplication::translate("Qt4ProjectManager::Internal::S60DeviceRunControlBase",
Robert Loehning's avatar
Robert Loehning committed
926
                                                     "Please start App TRK on %1.").arg(port);
927 928