/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmlutils.h"
#include "utils.h"

#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QCoreApplication>
#include <QtCore/QJsonDocument>
#include <QtCore/QJsonObject>
#include <QtCore/QJsonArray>
#include <QtCore/QJsonParseError>

QT_BEGIN_NAMESPACE

// Return the relative install path, that is, for example for
// module "QtQuick.Controls.Styles" in "path/qtbase/qml/QtQuick/Controls/Styles.3"
// --> "QtQuick/Controls" suitable for updateFile() (cp -r semantics).
QString QmlImportScanResult::Module::relativeInstallPath() const
{
    const QChar dot = QLatin1Char('.');
    const QChar slash = QLatin1Char('/');

    // Find relative path by module name.
    if (!name.contains(dot))
        return QString(); // "QtQuick.2" -> flat folder.
    QString result = sourcePath;
    QString pathComponent = name;
    pathComponent.replace(dot, slash);
    const int pos = result.lastIndexOf(pathComponent);
    if (pos < 0)
        return QString();
    result.remove(0, pos);
    // return base name.
    const int lastSlash = result.lastIndexOf(slash);
    if (lastSlash >= 0)
        result.truncate(lastSlash);
    return result;
}

QString QmlImportScanResult::Module::installPath(const QString &root) const
{
    QString result = root;
    const QString relPath = relativeInstallPath();
    if (!relPath.isEmpty())
        result += QLatin1Char('/');
    result += relPath;
    return result;
}

static QString qmlDirectoryRecursion(Platform platform, const QString &path)
{
    QDir dir(path);
    if (!dir.entryList(QStringList(QStringLiteral("*.qml")), QDir::Files, QDir::NoSort).isEmpty())
        return dir.path();
    foreach (const QString &subDir, dir.entryList(QStringList(), QDir::Dirs | QDir::NoDotAndDotDot, QDir::NoSort)) {
        if (!isBuildDirectory(platform, subDir)) {
            const QString subPath = qmlDirectoryRecursion(platform, dir.path() +  QLatin1Char('/') + subDir);
            if (!subPath.isEmpty())
                return subPath;
        }
    }
    return QString();
}

// Find a directory containing QML files in the project
QString findQmlDirectory(int platform, const QString &startDirectoryName)
{
    QDir startDirectory(startDirectoryName);
    if (isBuildDirectory(Platform(platform), startDirectory.dirName()))
        startDirectory.cdUp();
    return qmlDirectoryRecursion(Platform(platform), startDirectory.path());
}

static void findFileRecursion(const QDir &directory, Platform platform,
                              DebugMatchMode debugMatchMode, QStringList *matches)
{
    foreach (const QString &dll, findSharedLibraries(directory, platform, debugMatchMode))
        matches->append(directory.filePath(dll));
    foreach (const QString &subDir, directory.entryList(QStringList(), QDir::Dirs | QDir::NoDotAndDotDot | QDir::NoSymLinks)) {
        QDir subDirectory = directory;
        if (subDirectory.cd(subDir))
            findFileRecursion(subDirectory, platform, debugMatchMode, matches);
    }
}

QmlImportScanResult runQmlImportScanner(const QString &directory, const QString &qmlImportPath,
                                        bool usesWidgets, int platform, DebugMatchMode debugMatchMode,
                                        QString *errorMessage)
{
    bool quickControlsHandled = false;
    QmlImportScanResult result;
    QStringList arguments;
    arguments << QStringLiteral("-importPath") << qmlImportPath << QStringLiteral("-rootPath") << directory;
    unsigned long exitCode;
    QByteArray stdOut;
    QByteArray stdErr;
    const QString binary = QStringLiteral("qmlimportscanner");
    if (!runProcess(binary, arguments, QDir::currentPath(), &exitCode, &stdOut, &stdErr, errorMessage))
        return result;
    if (exitCode) {
        *errorMessage = binary + QStringLiteral(" returned ") + QString::number(exitCode)
                        + QStringLiteral(": ") + QString::fromLocal8Bit(stdErr);
        return result;
    }
    QJsonParseError jsonParseError;
    const QJsonDocument data = QJsonDocument::fromJson(stdOut, &jsonParseError);
    if (data.isNull() ) {
        *errorMessage = binary + QStringLiteral(" returned invalid JSON output: ")
                        + jsonParseError.errorString() + QStringLiteral(" :\"")
                        + QString::fromLocal8Bit(stdOut) + QLatin1Char('"');
        return result;
    }
    const QJsonArray array = data.array();
    const int childCount = array.count();
    for (int c = 0; c < childCount; ++c) {
        const QJsonObject object = array.at(c).toObject();
        if (object.value(QStringLiteral("type")).toString() == QLatin1String("module")) {
            const QString path = object.value(QStringLiteral("path")).toString();
            if (!path.isEmpty()) {
                QmlImportScanResult::Module module;
                module.name = object.value(QStringLiteral("name")).toString();
                module.className = object.value(QStringLiteral("classname")).toString();
                module.sourcePath = path;
                result.modules.append(module);
                findFileRecursion(QDir(path), Platform(platform), debugMatchMode, &result.plugins);
                // QTBUG-48424, QTBUG-45977: In release mode, qmlimportscanner does not report
                // the dependency of QtQuick.Controls on QtQuick.PrivateWidgets due to missing files.
                // Recreate the run-time logic here as best as we can - deploy it if
                //      1) QtWidgets is used
                //      2) QtQuick.Controls is used
                if (!quickControlsHandled && usesWidgets && module.name == QLatin1String("QtQuick.Controls")) {
                    quickControlsHandled = true;
                    QmlImportScanResult::Module privateWidgetsModule;
                    privateWidgetsModule.name = QStringLiteral("QtQuick.PrivateWidgets");
                    privateWidgetsModule.className = QStringLiteral("QtQuick2PrivateWidgetsPlugin");
                    privateWidgetsModule.sourcePath = QFileInfo(path).absolutePath() + QStringLiteral("/PrivateWidgets");
                    result.modules.append(privateWidgetsModule);
                    findFileRecursion(QDir(privateWidgetsModule.sourcePath), Platform(platform), debugMatchMode, &result.plugins);
                }
            }
        }
    }
    result.ok = true;
    return result;
}

static inline bool contains(const QList<QmlImportScanResult::Module> &modules, const QString &name)
{
    foreach (const QmlImportScanResult::Module &m, modules) {
        if (m.name == name)
            return true;
    }
    return false;
}

void QmlImportScanResult::append(const QmlImportScanResult &other)
{
    foreach (const QmlImportScanResult::Module &module, other.modules) {
        if (!contains(modules, module.name))
            modules.append(module);
    }
    foreach (const QString &plugin, other.plugins) {
        if (!plugins.contains(plugin))
            plugins.append(plugin);
    }
}

QT_END_NAMESPACE
