path: root/src/plugins/qt4projectmanager/qt-maemo/maemoglobal.cpp

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** No Commercial Usage
**
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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.
**
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/

#include "maemoglobal.h"

#include "maemoconstants.h"
#include "maemodeviceconfigurations.h"

#include <projectexplorer/projectexplorerconstants.h>

#include <coreplugin/filemanager.h>
#include <coreplugin/ssh/sshconnection.h>
#include <qt4projectmanager/qt4projectmanagerconstants.h>
#include <qt4projectmanager/qtversionmanager.h>
#include <utils/environment.h>

#include <QtGui/QDesktopServices>
#include <QtCore/QDir>
#include <QtCore/QProcess>
#include <QtCore/QString>

namespace Qt4ProjectManager {
namespace Internal {
namespace {
static const QLatin1String binQmake("/bin/qmake" EXEC_SUFFIX);
}

bool MaemoGlobal::isMaemoTargetId(const QString &id)
{
    return id == QLatin1String(Constants::MAEMO5_DEVICE_TARGET_ID)
        || id == QLatin1String(Constants::HARMATTAN_DEVICE_TARGET_ID)
        || id == QLatin1String(Constants::MEEGO_DEVICE_TARGET_ID);
}

bool MaemoGlobal::isValidMaemo5QtVersion(const QtVersion *version)
{
    return isValidMaemoQtVersion(version, Maemo5);
}

bool MaemoGlobal::isValidHarmattanQtVersion(const QtVersion *version)
{
    return isValidMaemoQtVersion(version, Maemo6);
}

bool MaemoGlobal::isValidMeegoQtVersion(const Qt4ProjectManager::QtVersion *version)
{
    return isValidMaemoQtVersion(version, Meego);
}

bool MaemoGlobal::isValidMaemoQtVersion(const QtVersion *qtVersion,
    MaemoVersion maemoVersion)
{
    if (version(qtVersion) != maemoVersion)
        return false;
    QProcess madAdminProc;
    const QStringList arguments(QLatin1String("list"));
    if (!callMadAdmin(madAdminProc, arguments, qtVersion, false))
        return false;
    if (!madAdminProc.waitForStarted() || !madAdminProc.waitForFinished())
        return false;

    madAdminProc.setReadChannel(QProcess::StandardOutput);
    const QByteArray tgtName = targetName(qtVersion).toAscii();
    while (madAdminProc.canReadLine()) {
        const QByteArray &line = madAdminProc.readLine();
        if (line.contains(tgtName)
            && (line.contains("(installed)") || line.contains("(default)")))
            return true;
    }
    return false;
}


QString MaemoGlobal::homeDirOnDevice(const QString &uname)
{
    return uname == QLatin1String("root")
        ? QString::fromLatin1("/root")
        : QLatin1String("/home/") + uname;
}

QString MaemoGlobal::remoteSudo()
{
    return QLatin1String("/usr/lib/mad-developer/devrootsh");
}

QString MaemoGlobal::remoteCommandPrefix(const QString &commandFilePath)
{
    return QString::fromLocal8Bit("%1 chmod a+x %2; %3; ")
        .arg(remoteSudo(), commandFilePath, remoteSourceProfilesCommand());
}

QString MaemoGlobal::remoteSourceProfilesCommand()
{
    const QList<QByteArray> profiles = QList<QByteArray>() << "/etc/profile"
        << "/home/user/.profile" << "~/.profile";
    QByteArray remoteCall(":");
    foreach (const QByteArray &profile, profiles)
        remoteCall += "; test -f " + profile + " && source " + profile;
    return QString::fromAscii(remoteCall);
}

QString MaemoGlobal::remoteEnvironment(const QList<Utils::EnvironmentItem> &list)
{
    QString env;
    QString placeHolder = QLatin1String("%1=%2 ");
    foreach (const Utils::EnvironmentItem &item, list)
        env.append(placeHolder.arg(item.name).arg(item.value));
    return env.mid(0, env.size() - 1);
}

QString MaemoGlobal::failedToConnectToServerMessage(const Core::SshConnection::Ptr &connection,
    const MaemoDeviceConfig::ConstPtr &deviceConfig)
{
    QString errorMsg = tr("Could not connect to host: %1")
        .arg(connection->errorString());

    if (deviceConfig->type() == MaemoDeviceConfig::Simulator) {
        if (connection->errorState() == Core::SshTimeoutError
                || connection->errorState() == Core::SshSocketError) {
            errorMsg += tr("\nDid you start Qemu?");
        }
    } else if (connection->errorState() == Core::SshTimeoutError) {
        errorMsg += tr("\nIs the device connected and set up for network access?");
    }
    return errorMsg;
}

QString MaemoGlobal::deviceConfigurationName(const MaemoDeviceConfig::ConstPtr &devConf)
{
    return devConf ? devConf->name() : tr("(No device)");
}

QString MaemoGlobal::maddeRoot(const QtVersion *qtVersion)
{
    QDir dir(targetRoot(qtVersion));
    dir.cdUp(); dir.cdUp();
    return dir.absolutePath();
}

QString MaemoGlobal::targetRoot(const QtVersion *qtVersion)
{
    return QDir::cleanPath(qtVersion->qmakeCommand()).remove(binQmake);
}

QString MaemoGlobal::targetName(const QtVersion *qtVersion)
{
    return QDir(targetRoot(qtVersion)).dirName();
}

QString MaemoGlobal::madAdminCommand(const QtVersion *qtVersion)
{
    return maddeRoot(qtVersion) + QLatin1String("/bin/mad-admin");
}

QString MaemoGlobal::madCommand(const QtVersion *qtVersion)
{
    return maddeRoot(qtVersion) + QLatin1String("/bin/mad");
}

MaemoGlobal::MaemoVersion MaemoGlobal::version(const QtVersion *qtVersion)
{
    const QString &name = targetName(qtVersion);
    if (name.startsWith(QLatin1String("fremantle")))
        return Maemo5;
    if (name.startsWith(QLatin1String("harmattan")))
        return Maemo6;
    if (name.startsWith(QLatin1String("meego")))
        return Meego;
    return static_cast<MaemoVersion>(-1);
}

QString MaemoGlobal::architecture(const QtVersion *qtVersion)
{
    QProcess proc;
    const QStringList args = QStringList() << QLatin1String("uname")
        << QLatin1String("-m");
    if (!callMad(proc, args, qtVersion, true))
        return QString();
    if (!proc.waitForFinished())
        return QString();
    QString arch = QString::fromUtf8(proc.readAllStandardOutput());
    arch.chop(1); // Newline
    return arch;
}

bool MaemoGlobal::removeRecursively(const QString &filePath, QString &error)
{
    error.clear();
    QFileInfo fileInfo(filePath);
    if (!fileInfo.exists())
        return true;
    QFile::setPermissions(filePath, fileInfo.permissions() | QFile::WriteUser);
    if (fileInfo.isDir()) {
        QDir dir(filePath);
        QStringList fileNames = dir.entryList(QDir::Files | QDir::Hidden
            | QDir::System | QDir::Dirs | QDir::NoDotAndDotDot);
        foreach (const QString &fileName, fileNames) {
            if (!removeRecursively(filePath + QLatin1Char('/') + fileName, error))
                return false;
        }
        dir.cdUp();
        if (!dir.rmdir(fileInfo.fileName())) {
            error = tr("Failed to remove directory '%1'.")
                .arg(QDir::toNativeSeparators(filePath));
            return false;
        }
    } else {
        if (!QFile::remove(filePath)) {
            error = tr("Failed to remove file '%1'.")
                .arg(QDir::toNativeSeparators(filePath));
            return false;
        }
    }
    return true;
}

bool MaemoGlobal::callMad(QProcess &proc, const QStringList &args,
    const QtVersion *qtVersion, bool useTarget)
{
    return callMaddeShellScript(proc, qtVersion, madCommand(qtVersion), args,
        useTarget);
}

bool MaemoGlobal::callMadAdmin(QProcess &proc, const QStringList &args,
    const QtVersion *qtVersion, bool useTarget)
{
    return callMaddeShellScript(proc, qtVersion, madAdminCommand(qtVersion),
        args, useTarget);
}

bool MaemoGlobal::callMaddeShellScript(QProcess &proc,
    const QtVersion *qtVersion, const QString &command, const QStringList &args,
    bool useTarget)
{
    if (!QFileInfo(command).exists())
        return false;
    QString actualCommand = command;
    QStringList actualArgs = targetArgs(qtVersion, useTarget) + args;
#ifdef Q_OS_WIN
    Utils::Environment env(proc.systemEnvironment());
    const QString root = maddeRoot(qtVersion);
    env.prependOrSetPath(root + QLatin1String("/bin"));
    env.prependOrSet(QLatin1String("HOME"),
        QDesktopServices::storageLocation(QDesktopServices::HomeLocation));
    proc.setEnvironment(env.toStringList());
    actualArgs.prepend(command);
    actualCommand = root + QLatin1String("/bin/sh.exe");
#endif
    proc.start(actualCommand, actualArgs);
    return true;
}

QStringList MaemoGlobal::targetArgs(const QtVersion *qtVersion, bool useTarget)
{
    QStringList args;
    if (useTarget) {
        args << QLatin1String("-t") << targetName(qtVersion);
    }
    return args;
}

QString MaemoGlobal::maemoVersionToString(MaemoVersion version)
{
    switch (version) {
    case Maemo5: return QLatin1String("Maemo 5 (Fremantle)");
    case Maemo6: return QLatin1String("Maemo 6 (Harmattan)");
    case Meego: return QLatin1String("Meego");
    }
    Q_ASSERT(false);
    return QString();
}


MaemoGlobal::FileUpdate::FileUpdate(const QString &fileName)
    : m_fileName(fileName)
{
    Core::FileManager::instance()->expectFileChange(fileName);
}

MaemoGlobal::FileUpdate::~FileUpdate()
{
    Core::FileManager::instance()->unexpectFileChange(m_fileName);
}

} // namespace Internal
} // namespace Qt4ProjectManager