/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the qmake application of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** 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.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "symmake.h"

#include <qstring.h>

#include <qhash.h>

#include <qstringlist.h>

#include <qdir.h>

#include <qdatetime.h>

#include <stdlib.h>

#include <qdebug.h>

#include <qxmlstream.h>

#include <QSettings>

// Included from tools/shared

#include <symbian/epocroot.h>

#define RESOURCE_DIRECTORY_MMP "/resource/apps"

#define RESOURCE_DIRECTORY_RESOURCE "\\\\resource\\\\apps\\\\"

#define REGISTRATION_RESOURCE_DIRECTORY_HW "/private/10003a3f/import/apps"

#define PLUGIN_COMMON_DEF_FILE_FOR_MMP "./plugin_common.def"

#define PLUGIN_COMMON_DEF_FILE_ACTUAL "plugin_commonU.def"

#define BLD_INF_RULES_BASE "BLD_INF_RULES."

#define BLD_INF_TAG_PLATFORMS "prj_platforms"

#define BLD_INF_TAG_MMPFILES "prj_mmpfiles"

#define BLD_INF_TAG_TESTMMPFILES "prj_testmmpfiles"

#define BLD_INF_TAG_EXTENSIONS "prj_extensions"

#define BLD_INF_TAG_TESTEXTENSIONS "prj_testextensions"

#define RSS_RULES "RSS_RULES"

#define RSS_RULES_BASE "RSS_RULES."

#define RSS_TAG_NBROFICONS "number_of_icons"

#define RSS_TAG_ICONFILE "icon_file"

#define RSS_TAG_HEADER "header"

#define RSS_TAG_SERVICE_LIST "service_list"

#define RSS_TAG_FILE_OWNERSHIP_LIST "file_ownership_list"

#define RSS_TAG_DATATYPE_LIST "datatype_list"

#define RSS_TAG_FOOTER "footer"

#define RSS_TAG_DEFAULT "default_rules" // Same as just giving rules without tag

#define MMP_TARGET "TARGET"

#define MMP_TARGETTYPE "TARGETTYPE"

#define MMP_SECUREID "SECUREID"

#define MMP_OPTION "OPTION"

#define MMP_LINKEROPTION "LINKEROPTION"

#define MMP_CAPABILITY "CAPABILITY"

#define MMP_EPOCALLOWDLLDATA "EPOCALLOWDLLDATA"

#define MMP_EPOCHEAPSIZE "EPOCHEAPSIZE"

#define MMP_EPOCSTACKSIZE "EPOCSTACKSIZE"

#define MMP_UID "UID"

#define MMP_VENDORID "VENDORID"

#define MMP_VERSION "VERSION"

#define MMP_START_RESOURCE "START RESOURCE"

#define MMP_END_RESOURCE "END"

#define VAR_CXXFLAGS "QMAKE_CXXFLAGS"

#define VAR_CFLAGS "QMAKE_CFLAGS"

#define VAR_LFLAGS "QMAKE_LFLAGS"

#define SIS_TARGET "sis"

#define INSTALLER_SIS_TARGET "installer_sis"

#define ROM_STUB_SIS_TARGET "stub_sis"

#define OK_SIS_TARGET "ok_sis"

#define OK_INSTALLER_SIS_TARGET "ok_installer_sis"

#define OK_ROM_STUB_SIS_TARGET "ok_stub_sis"

#define FAIL_SIS_NOPKG_TARGET "fail_sis_nopkg"

#define FAIL_SIS_NOCACHE_TARGET "fail_sis_nocache"

#define PRINT_FILE_CREATE_ERROR(filename) fprintf(stderr, "Error: Could not create '%s'\n", qPrintable(filename));

#define MANUFACTURER_NOTE_FILE "manufacturer_note.txt"

#define DEFAULT_MANUFACTURER_NOTE \

    "The package is not supported for devices from this manufacturer. Please try the selfsigned " \

    "version of the package instead."

QString SymbianMakefileGenerator::fixPathForMmp(const QString& origPath, const QDir& parentDir)

{

    static QString epocRootStr;

    if (epocRootStr.isEmpty()) {

        epocRootStr = epocRoot();

        QFileInfo efi(epocRootStr);

        if (!efi.exists() || epocRootStr.isEmpty()) {

            fprintf(stderr, "Unable to resolve epocRoot '%s' to real dir on current drive, defaulting to '/' for mmp paths\n", qPrintable(epocRoot()));

            epocRootStr = "/";

        } else {

            epocRootStr = efi.absoluteFilePath();

        }

        if (!epocRootStr.endsWith("/"))

            epocRootStr += "/";

        epocRootStr += "epoc32/";

    }

    QString resultPath = origPath;

    // Make it relative, unless it starts with "%epocroot%/epoc32/"

    if (resultPath.startsWith(epocRootStr, Qt::CaseInsensitive)) {

        resultPath.replace(epocRootStr, "/epoc32/", Qt::CaseInsensitive);

    } else {

        resultPath = parentDir.relativeFilePath(resultPath);

    }

    resultPath = QDir::cleanPath(resultPath);

    if (resultPath.isEmpty())

        resultPath = ".";

    return resultPath;

}

QString SymbianMakefileGenerator::absolutizePath(const QString& origPath)

{

    // Prepend epocroot to any paths beginning with "/epoc32/"

    QString resultPath = QDir::fromNativeSeparators(origPath);

    if (resultPath.startsWith("/epoc32/", Qt::CaseInsensitive))

        resultPath = QDir::fromNativeSeparators(epocRoot()) + resultPath.mid(1);

    QFileInfo fi(fileInfo(resultPath));

    // Since origPath can be something given in HEADERS, we need to check if we are dealing

    // with a file or a directory. In case the origPath doesn't yet exist, isFile() returns

    // false and we default to assuming it is a dir.

    if (fi.isFile()) {

        resultPath = fi.absolutePath();

    } else {

        resultPath = fi.absoluteFilePath();

    }

    resultPath = QDir::cleanPath(resultPath);

    return resultPath;

}

SymbianMakefileGenerator::SymbianMakefileGenerator() : MakefileGenerator() { }

SymbianMakefileGenerator::~SymbianMakefileGenerator() { }

void SymbianMakefileGenerator::writeHeader(QTextStream &t)

{

    t << "// ============================================================================" << endl;

    t << "// * Makefile for building: " << escapeFilePath(var("TARGET")) << endl;

    t << "// * Generated by qmake (" << qmake_version() << ") (Qt " QT_VERSION_STR ") on: ";

    t << QDateTime::currentDateTime().toString(Qt::ISODate) << endl;

    t << "// * This file is generated by qmake and should not be modified by the" << endl;

    t << "// * user." << endl;

    t << "// * Project:  " << fileFixify(project->projectFile()) << endl;

    t << "// * Template: " << var("TEMPLATE") << endl;

    t << "// ============================================================================" << endl;

    t << endl;

    // Defining define for bld.inf

    QString shortProFilename = project->projectFile();

    shortProFilename.replace(0, shortProFilename.lastIndexOf("/") + 1, QString(""));

    shortProFilename.replace(Option::pro_ext, QString(""));

    QString bldinfDefine = shortProFilename;

    bldinfDefine.append("_");

    bldinfDefine.append(generate_uid(project->projectFile()));

    bldinfDefine.prepend("BLD_INF_");

    removeSpecialCharacters(bldinfDefine);

    t << "#define " << bldinfDefine.toUpper() << endl << endl;

}

bool SymbianMakefileGenerator::writeMakefile(QTextStream &t)

{

    writeHeader(t);

    QString numberOfIcons;

    QString iconFile;

    QMap<QString, QStringList> userRssRules;

    readRssRules(numberOfIcons, iconFile, userRssRules);

    // Get the application translations and convert to symbian OS lang code, i.e. decical number

    QStringList symbianLangCodes = symbianLangCodesFromTsFiles();

    // Generate pkg files if there are any actual files to deploy

    bool generatePkg = false;

    DeploymentList depList;

    if (targetType == TypeExe) {

        generatePkg = true;

    } else {

        foreach(QString item, project->values("DEPLOYMENT")) {

            if (!project->values(item + ".sources").isEmpty()) {

                generatePkg = true;

                break;

            }

        }

    }

    if (generatePkg) {

        generatePkgFile(iconFile, depList);

    }

    writeBldInfContent(t, generatePkg, iconFile, depList);

    // Generate empty wrapper makefile here, because wrapper makefile must exist before writeMkFile,

    // but all required data is not yet available.

    bool isPrimaryMakefile = true;

    QString wrapperFileName("Makefile");

    QString outputFileName = fileInfo(Option::output.fileName()).fileName();

    if (outputFileName != BLD_INF_FILENAME) {

        wrapperFileName.append(".").append(outputFileName.startsWith(BLD_INF_FILENAME)

                                           ? outputFileName.mid(sizeof(BLD_INF_FILENAME))

                                           : outputFileName);

        isPrimaryMakefile = false;

    }

    QFile wrapperMakefile(wrapperFileName);

    if (wrapperMakefile.open(QIODevice::WriteOnly)) {

        generatedFiles << wrapperFileName;

        if (Option::mkfile::listgen) {

            generatePrint(fileInfo(wrapperMakefile.fileName()).absoluteFilePath());

        }

    } else {

        PRINT_FILE_CREATE_ERROR(wrapperFileName);

        return false;

    }

    if (targetType == TypeSubdirs) {

        // If we have something to deploy, generate extension makefile for just that, since

        // normal extension makefile is not getting generated and we need emulator deployment to be done.

        if (generatePkg)

            writeMkFile(wrapperFileName, true);

        writeWrapperMakefile(wrapperMakefile, isPrimaryMakefile);

        return true;

    }

    writeMkFile(wrapperFileName, false);

    QString shortProFilename = project->projectFile();

    shortProFilename.replace(0, shortProFilename.lastIndexOf("/") + 1, QString(""));

    shortProFilename.replace(Option::pro_ext, QString(""));

    QString mmpFilename = shortProFilename;

    mmpFilename.append("_");

    mmpFilename.append(uid3);

    mmpFilename.append(Option::mmp_ext);

    writeMmpFile(mmpFilename, symbianLangCodes);

    if (targetType == TypeExe) {

        if (!project->isActiveConfig("no_icon")) {

            writeRegRssFile(userRssRules);

            writeRssFile(numberOfIcons, iconFile);

            writeLocFile(symbianLangCodes);

            if (!project->values("SYMBIANTRANSLATIONS").isEmpty())

                writeSymbianLocFile(symbianLangCodes);        

        }

    }

    writeCustomDefFile();

    writeWrapperMakefile(wrapperMakefile, isPrimaryMakefile);

    return true;

}

void SymbianMakefileGenerator::generatePkgFile(const QString &iconFile, DeploymentList &depList)

{

    QString pkgFilename = QString("%1_template.%2")

                          .arg(fixedTarget)

                          .arg("pkg");

    QFile pkgFile(pkgFilename);

    if (!pkgFile.open(QIODevice::WriteOnly | QIODevice::Text)) {

        PRINT_FILE_CREATE_ERROR(pkgFilename);

        return;

    }

    if (Option::mkfile::listgen) {

        generatePrint(fileInfo(pkgFile.fileName()).absoluteFilePath());

    }

    generatedFiles << pkgFile.fileName();

    QTextStream t(&pkgFile);

    QString installerSisHeader = project->values("DEPLOYMENT.installer_header").join("\n");

    if (installerSisHeader.isEmpty())

        installerSisHeader = "0xA000D7CE"; // Use default self-signable UID if not defined

    QString wrapperStreamBuffer;

    QTextStream tw(&wrapperStreamBuffer);

    QString dateStr = QDateTime::currentDateTime().toString(Qt::ISODate);

    // Header info

    QString wrapperPkgFilename = QString("%1_installer.%2")

                                .arg(fixedTarget)

                                .arg("pkg");

    QString headerComment = "; %1 generated by qmake at %2\n"

        "; This file is generated by qmake and should not be modified by the user\n"

        ";\n\n";

    t << headerComment.arg(pkgFilename).arg(dateStr);

    tw << headerComment.arg(wrapperPkgFilename).arg(dateStr);

    // Construct QStringList from pkg_prerules since we need search it before printed to file

    // Note: Though there can't be more than one language or header line, use stringlists

    // in case user wants comments to go with the rules.

    QStringList rawPkgPreRules;

    QStringList languageRules;

    QStringList headerRules;

    foreach(QString deploymentItem, project->values("DEPLOYMENT")) {

        foreach(QString pkgrulesItem, project->values(deploymentItem + ".pkg_prerules")) {

            QStringList pkgrulesValue = project->values(pkgrulesItem);

            // If there is no stringlist defined for a rule, use rule name directly

            // This is convenience for defining single line mmp statements

            if (pkgrulesValue.isEmpty()) {

                if (pkgrulesItem.startsWith("&"))

                    languageRules << pkgrulesItem;

                else if (pkgrulesItem.startsWith("#"))

                    headerRules << pkgrulesItem;

                else

                    rawPkgPreRules << pkgrulesItem;

            } else {

                if (containsStartWithItem('&', pkgrulesValue)) {

                    foreach(QString pkgrule, pkgrulesValue) {

                        languageRules << pkgrule;

                    }

                } else if (containsStartWithItem('#', pkgrulesValue)) {

                    foreach(QString pkgrule, pkgrulesValue) {

                        headerRules << pkgrule;

                    }

                } else {

                    foreach(QString pkgrule, pkgrulesValue) {

                        rawPkgPreRules << pkgrule;

                    }

                }

            }

        }

    }

    // Apply some defaults if specific data does not exist in PKG pre-rules

    if (languageRules.isEmpty()) {

        // language, (*** hardcoded to english atm, should be parsed from TRANSLATIONS)

        languageRules << "; Language\n&EN\n\n";

    } else if (headerRules.isEmpty()) {

        // In case user defines langs, he must take care also about SIS header

        fprintf(stderr, "Warning: If language is defined with DEPLOYMENT pkg_prerules, also the SIS header must be defined\n");

    }

    t << languageRules.join("\n") << endl;

    tw << languageRules.join("\n") << endl;

    // name of application, UID and version

    QString applicationVersion = project->first("VERSION").isEmpty() ? "1,0,0" : project->first("VERSION").replace('.', ',');

    QString sisHeader = "; SIS header: name, uid, version\n#{\"%1\"},(%2),%3\n\n";

    QString visualTarget = escapeFilePath(fileFixify(project->first("TARGET")));

    visualTarget = removePathSeparators(visualTarget);

    QString wrapperTarget = visualTarget + " installer";

    if (installerSisHeader.startsWith("0x", Qt::CaseInsensitive)) {

        tw << sisHeader.arg(wrapperTarget).arg(installerSisHeader).arg(applicationVersion);

    } else {

        tw << installerSisHeader << endl;

    }

    if (headerRules.isEmpty())

        t << sisHeader.arg(visualTarget).arg(uid3).arg(applicationVersion);

    else

        t << headerRules.join("\n") << endl;

    // Localized vendor name

    QString vendorName;

    if (!containsStartWithItem('%', rawPkgPreRules)) {

        vendorName += "; Localised Vendor name\n%{\"Vendor\"}\n\n";

    }

    // Unique vendor name

    if (!containsStartWithItem(':', rawPkgPreRules)) {

        vendorName += "; Unique Vendor name\n:\"Vendor\"\n\n";

    }

    t << vendorName;

    tw << vendorName;

    // PKG pre-rules - these are added before actual file installations i.e. SIS package body

    if (rawPkgPreRules.size()) {

        QString comment = "\n; Manual PKG pre-rules from PRO files\n";

        t << comment;

        tw << comment;

        foreach(QString item, rawPkgPreRules) {

            // Only regular pkg file should have package dependencies or pkg header if that is

            // defined using prerules.

            if (!item.startsWith("(") && !item.startsWith("#")) {

                tw << item << endl;

            }

            t << item << endl;

        }

        t << endl;

        tw << endl;

    }

    // Begin Manufacturer block

    if (!project->values("DEPLOYMENT.manufacturers").isEmpty()) {

        QString manufacturerStr("IF ");

        foreach(QString manufacturer, project->values("DEPLOYMENT.manufacturers")) {

            manufacturerStr.append(QString("(MANUFACTURER)=(%1) OR \n   ").arg(manufacturer));

        }

        // Remove the final OR

        manufacturerStr.chop(8);

        t << manufacturerStr << endl;

    }

    // Install paths on the phone *** should be dynamic at some point

    QString installPathBin = "!:\\sys\\bin";

    QString installPathResource = "!:\\resource\\apps";

    QString installPathRegResource = "!:\\private\\10003a3f\\import\\apps";

    // Find location of builds

    QString epocReleasePath = QString("%1epoc32/release/$(PLATFORM)/$(TARGET)")

                              .arg(epocRoot());

    if (targetType == TypeExe) {

        // deploy .exe file

        t << "; Executable and default resource files" << endl;

        QString exeFile = fixedTarget + ".exe";

        t << QString("\"%1/%2\"    - \"%3\\%4\"")

             .arg(epocReleasePath)

             .arg(exeFile)

             .arg(installPathBin)

             .arg(exeFile) << endl;

        // deploy rsc & reg_rsc file

        if (!project->isActiveConfig("no_icon")) {

            t << QString("\"%1epoc32/data/z/resource/apps/%2\"    - \"%3\\%4\"")

                 .arg(epocRoot())

                 .arg(fixedTarget + ".rsc")

                 .arg(installPathResource)

                 .arg(fixedTarget + ".rsc") << endl;

            t << QString("\"%1epoc32/data/z/private/10003a3f/import/apps/%2\"    - \"%3\\%4\"")

                 .arg(epocRoot())

                 .arg(fixedTarget + "_reg.rsc")

                 .arg(installPathRegResource)

                 .arg(fixedTarget + "_reg.rsc") << endl;

            if (!iconFile.isEmpty())  {

                t << QString("\"%1epoc32/data/z%2\"    - \"!:%3\"")

                     .arg(epocRoot())

                     .arg(iconFile)

                     .arg(QDir::toNativeSeparators(iconFile)) << endl << endl;

            }

        }

    }

    // deploy any additional DEPLOYMENT  files

    QString remoteTestPath;

    remoteTestPath = QString("!:\\private\\%1").arg(privateDirUid);

    QString zDir = epocRoot() + QLatin1String("epoc32/data/z");

    initProjectDeploySymbian(project, depList, remoteTestPath, true, "$(PLATFORM)", "$(TARGET)", generatedDirs, generatedFiles);

    if (depList.size())

        t << "; DEPLOYMENT" << endl;

    for (int i = 0; i < depList.size(); ++i)  {

        QString from = depList.at(i).from;

        QString to = depList.at(i).to;

        // Deploy anything not already deployed from under epoc32 instead from under

        // \epoc32\data\z\ to enable using pkg file without rebuilding

        // the project, which can be useful for some binary only distributions.

        if (!from.contains(QLatin1String("epoc32"), Qt::CaseInsensitive)) {

            from = to;

            if (from.size() > 1 && from.at(1) == QLatin1Char(':'))

                from = from.mid(2);

            from.prepend(zDir);

        } else {

            if (from.size() > 1 && from.at(1) == QLatin1Char(':'))

                from = from.mid(2);

        }