Add possibility to post load install scripts

This change adds attribute, postLoad, to existing <Script> -element.
Using <Script postLoad="True"> will call the script loading and
evaluation only to those components which are selected for install or
update right before the components installation start.

Task-number: QTIFW-2820
Change-Id: Ic1967d329cbb5de6a0216ff3f76cc2ede178db80
Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>

2 files changed, 48 insertions, 34 deletions

diff --git a/src/libs/ifwtools/repositorygen.cpp b/src/libs/ifwtools/repositorygen.cpp
index a5e015299..8c629edc4 100644
--- a/src/libs/ifwtools/repositorygen.cpp
+++ b/src/libs/ifwtools/repositorygen.cpp
@@ -367,39 +367,8 @@ void QInstallerTools::copyMetaData(const QString &_targetDir, const QString &met
 
             root.appendChild(update);
 
-            // copy script file
-            const QString script = package.firstChildElement(QLatin1String("Script")).text();
-            if (!script.isEmpty()) {
-                QFile scriptFile(QString::fromLatin1("%1/meta/%2").arg(info.directory, script));
-                if (!scriptFile.open(QIODevice::ReadOnly | QIODevice::Text)) {
-                    throw QInstaller::Error(QString::fromLatin1("Cannot open component script at \"%1\".")
-                                            .arg(QDir::toNativeSeparators(scriptFile.fileName())));
-                }
-
-                const QString scriptContent = QLatin1String("(function() {")
-                        + QString::fromUtf8(scriptFile.readAll())
-                        + QLatin1String(";"
-                                        "    if (typeof Component == \"undefined\")"
-                                        "        throw \"Missing Component constructor. Please check your script.\";"
-                                        "})();");
-
-                // if the user isn't aware of the downloadable archives value we will add it automatically later
-                foundDownloadableArchives |= scriptContent.contains(QLatin1String("addDownloadableArchive"))
-                        || scriptContent.contains(QLatin1String("removeDownloadableArchive"));
-
-                static QInstaller::ScriptEngine testScriptEngine;
-                const QJSValue value = testScriptEngine.evaluate(scriptContent, scriptFile.fileName());
-                if (value.isError()) {
-                    throw QInstaller::Error(QString::fromLatin1("Exception while loading component "
-                        "script at \"%1\": %2").arg(QDir::toNativeSeparators(scriptFile.fileName()),
-                                value.toString().isEmpty() ? QString::fromLatin1("Unknown error.") :
-                                value.toString() + QStringLiteral(" on line number: ") +
-                                    value.property(QStringLiteral("lineNumber")).toString()));
-                }
-
-                const QString toLocation(QString::fromLatin1("%1/%2/%3").arg(targetDir, info.name, script));
-                copyWithException(scriptFile.fileName(), toLocation, QInstaller::scScript);
-            }
+            // copy script files
+            copyScriptFiles(childNodes, info, foundDownloadableArchives, targetDir);
 
             // write DownloadableArchives tag if that is missed by the user
             if (!foundDownloadableArchives && !info.copiedFiles.isEmpty()) {
@@ -977,6 +946,50 @@ void QInstallerTools::splitMetadata(const QStringList &entryList, const QString
     }
 }
 
+void QInstallerTools::copyScriptFiles(const QDomNodeList &childNodes, const PackageInfo &info, bool &foundDownloadableArchives, const QString &targetDir)
+{
+    for (int i = 0; i < childNodes.count(); ++i) {
+        const QDomNode node = childNodes.at(i);
+        const QString key = node.nodeName();
+
+        if (key != QLatin1String("Script"))
+            continue;
+        const QString script = node.toElement().text();
+        if (script.isEmpty())
+            continue;
+
+        QFile scriptFile(QString::fromLatin1("%1/meta/%2").arg(info.directory, script));
+        if (!scriptFile.open(QIODevice::ReadOnly | QIODevice::Text)) {
+            throw QInstaller::Error(QString::fromLatin1("Cannot open component script at \"%1\".")
+                                        .arg(QDir::toNativeSeparators(scriptFile.fileName())));
+        }
+
+        const QString scriptContent = QLatin1String("(function() {")
+                                      + QString::fromUtf8(scriptFile.readAll())
+                                      + QLatin1String(";"
+                                                      "    if (typeof Component == \"undefined\")"
+                                                      "        throw \"Missing Component constructor. Please check your script.\";"
+                                                      "})();");
+
+        // if the user isn't aware of the downloadable archives value we will add it automatically later
+        foundDownloadableArchives |= scriptContent.contains(QLatin1String("addDownloadableArchive"))
+                                     || scriptContent.contains(QLatin1String("removeDownloadableArchive"));
+
+        static QInstaller::ScriptEngine testScriptEngine;
+        const QJSValue value = testScriptEngine.evaluate(scriptContent, scriptFile.fileName());
+        if (value.isError()) {
+            throw QInstaller::Error(QString::fromLatin1("Exception while loading component "
+                        "script at \"%1\": %2").arg(QDir::toNativeSeparators(scriptFile.fileName()),
+                        value.toString().isEmpty() ? QString::fromLatin1("Unknown error.") :
+                        value.toString() + QStringLiteral(" on line number: ") +
+                        value.property(QStringLiteral("lineNumber")).toString()));
+        }
+
+        const QString toLocation(QString::fromLatin1("%1/%2/%3").arg(targetDir, info.name, script));
+        copyWithException(scriptFile.fileName(), toLocation, QInstaller::scScript);
+    }
+}
+
 void QInstallerTools::copyComponentData(const QStringList &packageDirs, const QString &repoDir,
     PackageInfoVector *const infos, const QString &archiveSuffix, Compression compression)
 {
diff --git a/src/libs/ifwtools/repositorygen.h b/src/libs/ifwtools/repositorygen.h
index 054c023f4..7ad3dd073 100644
--- a/src/libs/ifwtools/repositorygen.h
+++ b/src/libs/ifwtools/repositorygen.h
@@ -1,6 +1,6 @@
 /**************************************************************************
 **
-** Copyright (C) 2021 The Qt Company Ltd.
+** Copyright (C) 2022 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Installer Framework.
@@ -88,6 +88,7 @@ void IFWTOOLS_EXPORT compressMetaDirectories(const QString &repoDir, const QStri
 QStringList unifyMetadata(const QString &repoDir, const QString &existingRepoDir, QDomDocument doc);
 void splitMetadata(const QStringList &entryList, const QString &repoDir, QDomDocument doc,
                    const QHash<QString, QString> &versionMapping);
+void copyScriptFiles(const QDomNodeList &childNodes, const PackageInfo &info, bool &foundDownloadableArchives, const QString &targetDir);
 
 void IFWTOOLS_EXPORT copyMetaData(const QString &outDir, const QString &dataDir, const PackageInfoVector &packages,
     const QString &appName, const QString& appVersion, const QStringList &uniteMetadatas);