CLI: improvements to 'search' and 'install' command output

Previously subcomponents of a virtual component were shown on
search results, and trying to install these would print a bit
vague message: 'Component not found'. As the sub-branches of
virtual component nodes are hidden on GUI, we should also hide
them when using CLI search, and give a more appropriate error
message why the component cannot be explicitly selected for
installation, if the user still tries to do so.

Also some minor refactoring to the handling of supplemental
information about binary type of the running installer/mt.

This change does not fix the possible case of an install script
changing the 'virtual'-state of a component, as it would require
downloading and evaluating the full metadata for repositories (or
components), which would impose a performance penalty to search.

Task-number: QTIFW-2168
Change-Id: Ibacaca23c38f5ea98967955d91849cefc1f11f61
Reviewed-by: Katja Marttila <katja.marttila@qt.io>

6 files changed, 86 insertions, 17 deletions

diff --git a/src/libs/installer/binarycontent.h b/src/libs/installer/binarycontent.h
index a21cd69e7..7d50c0e28 100644
--- a/src/libs/installer/binarycontent.h
+++ b/src/libs/installer/binarycontent.h
@@ -1,6 +1,6 @@
 /**************************************************************************
 **
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Installer Framework.
@@ -48,6 +48,13 @@ public:
     static const qint64 MagicUpdaterMarker = 0x12023235UL;
     static const qint64 MagicPackageManagerMarker = 0x12023236UL;
 
+    // additional distinguishers only used at runtime, not written to the binary itself
+    enum MagicMarkerSupplement {
+        Default = 0x0,
+        OfflineGenerator = 0x1,
+        PackageViewer = 0x2
+    };
+
     // the cookie put at the end of the file
     static const quint64 MagicCookie = 0xc2630a1c99d668f8LL;  // binary
     static const quint64 MagicCookieDat = 0xc2630a1c99d668f9LL; // data
diff --git a/src/libs/installer/component.cpp b/src/libs/installer/component.cpp
index c5d74cdfa..8142cd4e1 100644
--- a/src/libs/installer/component.cpp
+++ b/src/libs/installer/component.cpp
@@ -306,6 +306,8 @@ void Component::loadDataFromPackage(const KDUpdater::LocalPackage &package)
 /*!
     Sets variables according to the values set in the package.xml file of \a package.
     Also loads UI files, licenses and translations if they are referenced in the package.xml.
+    If the \c PackageManagerCore object of this component is run as package viewer, then
+    only sets the variables without loading referenced files.
 */
 void Component::loadDataFromPackage(const Package &package)
 {
@@ -344,6 +346,9 @@ void Component::loadDataFromPackage(const Package &package)
     setValue(scForcedInstallation, forced);
     setValue(scContentSha1, package.data(scContentSha1).toString());
 
+    if (d->m_core->isPackageViewer())
+        return;
+
     setLocalTempPath(QInstaller::pathFromUrl(package.packageSource().url));
     const QStringList uis = package.data(QLatin1String("UserInterfaces")).toString()
         .split(QInstaller::commaRegExp(), QString::SkipEmptyParts);
diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp
index d619c1182..e03179ebb 100644
--- a/src/libs/installer/packagemanagercore.cpp
+++ b/src/libs/installer/packagemanagercore.cpp
@@ -2177,21 +2177,32 @@ ComponentModel *PackageManagerCore::updaterComponentModel() const
 */
 void PackageManagerCore::listAvailablePackages(const QString &regexp)
 {
+    setPackageViewer();
     qCDebug(QInstaller::lcInstallerInstallLog)
         << "Searching packages with regular expression:" << regexp;
+
+    ComponentModel *model = defaultComponentModel();
     d->fetchMetaInformationFromRepositories(DownloadType::UpdatesXML);
 
     d->addUpdateResourcesFromRepositories(true);
     QRegularExpression re(regexp);
     const PackagesList &packages = d->remotePackages();
+    if (!fetchAllPackages(packages, LocalPackagesHash())) {
+        qCWarning(QInstaller::lcInstallerInstallLog)
+            << "There was a problem with loading the package data.";
+        return;
+    }
 
     PackagesList matchedPackages;
     foreach (Package *package, packages) {
         const QString name = package->data(scName).toString();
-        if (re.match(name).hasMatch() &&
-                (virtualComponentsVisible() ? true : !package->data(scVirtual, false).toBool())) {
+        Component *component = componentByName(name);
+        if (!component)
+            continue;
+
+        const QModelIndex &idx = model->indexFromComponentName(component->treeName());
+        if (idx.isValid() && re.match(name).hasMatch())
             matchedPackages.append(package);
-        }
     }
     if (matchedPackages.count() == 0)
         qCDebug(QInstaller::lcInstallerInstallLog) << "No matching packages found.";
@@ -2267,10 +2278,26 @@ bool PackageManagerCore::checkComponentsForInstallation(const QStringList &compo
                 model->setData(idx, Qt::Checked, Qt::CheckStateRole);
                 installComponentsFound = true;
             }
-        } else { // idx is invalid and component valid when we have invisible virtual component
-            component->isVirtual()
-                ? errorMessage.append(tr("Cannot install %1. Component is virtual.\n").arg(name))
-                : errorMessage.append(tr("Cannot install %1. Component not found.\n").arg(name));
+        } else {
+            auto isDescendantOfVirtual = [&]() {
+                Component *trace = component;
+                forever {
+                    trace = trace->parentComponent();
+                    if (!trace) {
+                        // We already checked the root component if there is no parent
+                        return false;
+                    } else if (trace->isVirtual()) {
+                        errorMessage.append(tr("Cannot install %1. Component is descendant "
+                            "of a virtual component %2.\n").arg(name, trace->name()));
+                        return true;
+                    }
+                }
+            };
+            // idx is invalid and component valid when we have invisible virtual component
+            if (component->isVirtual())
+                errorMessage.append(tr("Cannot install %1. Component is virtual.\n").arg(name));
+            else if (!isDescendantOfVirtual())
+                errorMessage.append(tr("Cannot install %1. Component not found.\n").arg(name));
         }
     }
     if (!installComponentsFound)
@@ -2284,6 +2311,7 @@ bool PackageManagerCore::checkComponentsForInstallation(const QStringList &compo
 */
 void PackageManagerCore::listInstalledPackages(const QString &regexp)
 {
+    setPackageViewer();
     LocalPackagesHash installedPackages = this->localInstalledPackages();
 
     if (!regexp.isEmpty()) {
@@ -3372,11 +3400,11 @@ bool PackageManagerCore::isPackageManager() const
 }
 
 /*!
-    Sets current installer to be offline generator based on \a offlineGenerator.
+    Sets current installer to be offline generator.
 */
-void PackageManagerCore::setOfflineGenerator(bool offlineGenerator)
+void PackageManagerCore::setOfflineGenerator()
 {
-    d->m_offlineGenerator = offlineGenerator;
+    d->m_magicMarkerSupplement = BinaryContent::OfflineGenerator;
 }
 
 /*!
@@ -3390,6 +3418,24 @@ bool PackageManagerCore::isOfflineGenerator() const
 }
 
 /*!
+    Sets the current installer as the package viewer.
+*/
+void PackageManagerCore::setPackageViewer()
+{
+    d->m_magicMarkerSupplement = BinaryContent::PackageViewer;
+}
+
+/*!
+    Returns \c true if the current installer is executed as package viewer.
+
+    \sa {installer::isPackageViewer}{installer.isPackageViewer}
+*/
+bool PackageManagerCore::isPackageViewer() const
+{
+    return d->isPackageViewer();
+}
+
+/*!
     Sets the installer magic binary marker based on \a magicMarker and
     userSetBinaryMarker to \c true.
 */
diff --git a/src/libs/installer/packagemanagercore.h b/src/libs/installer/packagemanagercore.h
index c845fb1fa..a5554782d 100644
--- a/src/libs/installer/packagemanagercore.h
+++ b/src/libs/installer/packagemanagercore.h
@@ -264,9 +264,12 @@ public:
     Q_INVOKABLE void setPackageManager();
     Q_INVOKABLE bool isPackageManager() const;
 
-    void setOfflineGenerator(bool offlineGenerator = true);
+    void setOfflineGenerator();
     Q_INVOKABLE bool isOfflineGenerator() const;
 
+    void setPackageViewer();
+    Q_INVOKABLE bool isPackageViewer() const;
+
     void setUserSetBinaryMarker(qint64 magicMarker);
     Q_INVOKABLE bool isUserSetBinaryMarker() const;
 
diff --git a/src/libs/installer/packagemanagercore_p.cpp b/src/libs/installer/packagemanagercore_p.cpp
index e6220ba35..1b14c306b 100644
--- a/src/libs/installer/packagemanagercore_p.cpp
+++ b/src/libs/installer/packagemanagercore_p.cpp
@@ -225,6 +225,7 @@ PackageManagerCorePrivate::PackageManagerCorePrivate(PackageManagerCore *core)
     , m_repoFetched(false)
     , m_updateSourcesAdded(false)
     , m_magicBinaryMarker(0) // initialize with pseudo marker
+    , m_magicMarkerSupplement(BinaryContent::Default)
     , m_componentsToInstallCalculated(false)
     , m_componentScriptEngine(nullptr)
     , m_controlScriptEngine(nullptr)
@@ -243,7 +244,6 @@ PackageManagerCorePrivate::PackageManagerCorePrivate(PackageManagerCore *core)
     , m_autoAcceptLicenses(false)
     , m_disableWriteMaintenanceTool(false)
     , m_autoConfirmCommand(false)
-    , m_offlineGenerator(false)
 {
 }
 
@@ -264,6 +264,7 @@ PackageManagerCorePrivate::PackageManagerCorePrivate(PackageManagerCore *core, q
     , m_repoFetched(false)
     , m_updateSourcesAdded(false)
     , m_magicBinaryMarker(magicInstallerMaker)
+    , m_magicMarkerSupplement(BinaryContent::Default)
     , m_componentsToInstallCalculated(false)
     , m_componentScriptEngine(nullptr)
     , m_controlScriptEngine(nullptr)
@@ -282,7 +283,6 @@ PackageManagerCorePrivate::PackageManagerCorePrivate(PackageManagerCore *core, q
     , m_autoAcceptLicenses(false)
     , m_disableWriteMaintenanceTool(false)
     , m_autoConfirmCommand(false)
-    , m_offlineGenerator(false)
 {
     foreach (const OperationBlob &operation, performedOperations) {
         QScopedPointer<QInstaller::Operation> op(KDUpdater::UpdateOperationFactory::instance()
@@ -717,7 +717,12 @@ bool PackageManagerCorePrivate::isPackageManager() const
 
 bool PackageManagerCorePrivate::isOfflineGenerator() const
 {
-    return m_offlineGenerator;
+    return m_magicMarkerSupplement == BinaryContent::OfflineGenerator;
+}
+
+bool PackageManagerCorePrivate::isPackageViewer() const
+{
+    return m_magicMarkerSupplement == BinaryContent::PackageViewer;
 }
 
 bool PackageManagerCorePrivate::statusCanceledOrFailed() const
diff --git a/src/libs/installer/packagemanagercore_p.h b/src/libs/installer/packagemanagercore_p.h
index 4d5021471..b29808228 100644
--- a/src/libs/installer/packagemanagercore_p.h
+++ b/src/libs/installer/packagemanagercore_p.h
@@ -132,6 +132,8 @@ public:
     bool runOfflineGenerator();
     bool isOfflineGenerator() const;
 
+    bool isPackageViewer() const;
+
     QString replaceVariables(const QString &str) const;
     QByteArray replaceVariables(const QByteArray &str) const;
 
@@ -265,9 +267,10 @@ private:
     bool m_repoFetched;
     bool m_updateSourcesAdded;
     qint64 m_magicBinaryMarker;
+    int m_magicMarkerSupplement;
+
     bool m_componentsToInstallCalculated;
-    bool m_foundEssentialUpdate;
-    bool m_offlineGenerator;
+    bool m_foundEssentialUpdate;;
 
     mutable ScriptEngine *m_componentScriptEngine;
     mutable ScriptEngine *m_controlScriptEngine;