Android: Decouple missing packages logic from UI

There is no need to modify UI selection in order to
execute installation / deinstallation.

Change-Id: I205477e5ff0e7b07bfbcd6b5f8f985fcb180884e
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>

src/plugins/android/androidsdkmanager.cpp

@@ -215,6 +215,32 @@ const AndroidSdkPackageList &AndroidSdkManager::allSdkPackages()
     return m_d->allPackages();
 }
 
+QStringList AndroidSdkManager::notFoundEssentialSdkPackages()
+{
+    QStringList essentials = androidConfig().allEssentials();
+    const AndroidSdkPackageList &packages = allSdkPackages();
+    for (AndroidSdkPackage *package : packages) {
+        essentials.removeOne(package->sdkStylePath());
+        if (essentials.isEmpty())
+            return {};
+    }
+    return essentials;
+}
+
+QStringList AndroidSdkManager::missingEssentialSdkPackages()
+{
+    const QStringList essentials = androidConfig().allEssentials();
+    const AndroidSdkPackageList &packages = allSdkPackages();
+    QStringList missingPackages;
+    for (AndroidSdkPackage *package : packages) {
+        if (essentials.contains(package->sdkStylePath())
+            && package->state() != AndroidSdkPackage::Installed) {
+            missingPackages.append(package->sdkStylePath());
+        }
+    }
+    return missingPackages;
+}
+
 AndroidSdkPackageList AndroidSdkManager::installedSdkPackages()
 {
     return m_d->filteredPackages(AndroidSdkPackage::Installed, AndroidSdkPackage::AnyValidType);

src/plugins/android/androidsdkmanager.h

@@ -52,6 +52,8 @@ public:
 
     SdkPlatformList installedSdkPlatforms();
     const AndroidSdkPackageList &allSdkPackages();
+    QStringList notFoundEssentialSdkPackages();
+    QStringList missingEssentialSdkPackages();
     AndroidSdkPackageList installedSdkPackages();
     SystemImageList installedSystemImages();
     NdkList installedNdkPackages();

src/plugins/android/androidsdkmanagerwidget.cpp

@@ -159,7 +159,7 @@ AndroidSdkManagerWidget::AndroidSdkManagerWidget(AndroidSdkManager *sdkManager,
     connect(m_sdkModel, &AndroidSdkModel::dataChanged, this, [this] {
         if (m_viewStack->currentWidget() == m_packagesStack)
             m_buttonBox->button(QDialogButtonBox::Apply)
-                ->setEnabled(!m_sdkModel->userSelection().isEmpty());
+                ->setEnabled(m_sdkModel->installationChange().count());
     });
 
     connect(m_sdkModel, &AndroidSdkModel::modelAboutToBeReset, this,
@@ -206,9 +206,8 @@ AndroidSdkManagerWidget::AndroidSdkManagerWidget(AndroidSdkManager *sdkManager,
         expandCheck->setChecked(!text.isEmpty());
     });
 
-    connect(m_buttonBox->button(QDialogButtonBox::Apply), &QAbstractButton::clicked, this, [this] {
+    connect(m_buttonBox->button(QDialogButtonBox::Apply), &QAbstractButton::clicked,
-        onApplyButton();
+            this, &AndroidSdkManagerWidget::onApplyButton);
-    });
     connect(m_buttonBox, &QDialogButtonBox::rejected, this, &AndroidSdkManagerWidget::onCancel);
 
     connect(optionsButton, &QPushButton::clicked,
@@ -273,19 +272,20 @@ AndroidSdkManagerWidget::~AndroidSdkManagerWidget()
     delete m_formatter;
 }
 
-void AndroidSdkManagerWidget::installEssentials()
+void AndroidSdkManagerWidget::installMissingEssentials()
 {
-    const QStringList missingEssentials = m_sdkModel->selectMissingEssentials();
+    const QStringList notFoundEssentials = m_sdkManager->notFoundEssentialSdkPackages();
-    if (!missingEssentials.isEmpty()) {
+    if (!notFoundEssentials.isEmpty()) {
         QMessageBox::warning(Core::ICore::dialogParent(),
                              Tr::tr("Android SDK Changes"),
                              Tr::tr("%1 cannot find the following essential packages: \"%2\".\n"
                                     "Install them manually after the current operation is done.\n")
                                  .arg(QGuiApplication::applicationDisplayName(),
-                                      missingEssentials.join("\", \"")));
+                                      notFoundEssentials.join("\", \"")));
     }
-    onApplyButton(Tr::tr("Android SDK installation is missing necessary packages. "
+    applyInstallationChange({m_sdkManager->missingEssentialSdkPackages()},
-                     "Do you want to install the missing packages?"));
+                            Tr::tr("Android SDK installation is missing necessary packages. "
+                                   "Do you want to install the missing packages?"));
 }
 
 void AndroidSdkManagerWidget::beginLicenseCheck()
@@ -298,45 +298,39 @@ void AndroidSdkManagerWidget::beginLicenseCheck()
     addPackageFuture(m_sdkManager->checkPendingLicenses());
 }
 
-void AndroidSdkManagerWidget::onApplyButton(const QString &extraMessage)
+void AndroidSdkManagerWidget::applyInstallationChange(const InstallationChange &change,
+                                                      const QString &extraMessage)
 {
-    QTC_ASSERT(m_currentView == PackageListing, return);
+    m_installationChange = change;
 
     if (m_sdkManager->isBusy()) {
         m_formatter->appendMessage("\n" + Tr::tr("SDK Manager is busy."), StdErrFormat);
         return;
     }
 
-    const QList<const AndroidSdkPackage *> packagesToUpdate = m_sdkModel->userSelection();
+    if (m_installationChange.count() == 0)
-    if (packagesToUpdate.isEmpty())
         return;
 
-    QStringList installPackages, uninstallPackages;
+    QString message = Tr::tr("%n Android SDK packages shall be updated.", "", change.count());
-    for (auto package : packagesToUpdate) {
-        QString str = QString("   %1").arg(package->descriptionText());
-        if (package->state() == AndroidSdkPackage::Installed)
-            uninstallPackages << str;
-        else
-            installPackages << str;
-    }
-
-    QString message = Tr::tr("%n Android SDK packages shall be updated.", "", packagesToUpdate.count());
     if (!extraMessage.isEmpty())
         message.prepend(extraMessage + "\n\n");
-    QMessageBox messageDlg(QMessageBox::Information,
+
-                           Tr::tr("Android SDK Changes"),
+    QMessageBox messageDlg(QMessageBox::Information, Tr::tr("Android SDK Changes"),
-                           message,
+                           message, QMessageBox::Ok | QMessageBox::Cancel,
-                           QMessageBox::Ok | QMessageBox::Cancel,
                            Core::ICore::dialogParent());
 
     QString details;
-    if (!uninstallPackages.isEmpty())
+    if (!change.toUninstall.isEmpty()) {
-        details = Tr::tr("[Packages to be uninstalled:]\n").append(uninstallPackages.join("\n"));
+        QStringList toUninstall = {Tr::tr("[Packages to be uninstalled:]")};
-
+        toUninstall += change.toUninstall;
-    if (!installPackages.isEmpty()) {
+        details += toUninstall.join("\n   ");
-        if (!uninstallPackages.isEmpty())
+    }
+    if (!change.toInstall.isEmpty()) {
+        if (!change.toUninstall.isEmpty())
             details.append("\n\n");
-        details.append("[Packages to be installed:]\n").append(installPackages.join("\n"));
+        QStringList toInstall = {Tr::tr("[Packages to be installed:]")};
+        toInstall += change.toInstall;
+        details += toInstall.join("\n   ");
     }
     messageDlg.setDetailedText(details);
     if (messageDlg.exec() == QMessageBox::Cancel)
@@ -348,7 +342,7 @@ void AndroidSdkManagerWidget::onApplyButton(const QString &extraMessage)
     switchView(Operations);
     m_pendingCommand = AndroidSdkManager::UpdatePackage;
     // User agreed with the selection. Check for licenses.
-    if (!installPackages.isEmpty()) {
+    if (!change.toInstall.isEmpty()) {
         // Pending license affects installtion only.
         beginLicenseCheck();
     } else {
@@ -357,6 +351,12 @@ void AndroidSdkManagerWidget::onApplyButton(const QString &extraMessage)
     }
 }
 
+void AndroidSdkManagerWidget::onApplyButton()
+{
+    QTC_ASSERT(m_currentView == PackageListing, return);
+    applyInstallationChange(m_sdkModel->installationChange());
+}
+
 void AndroidSdkManagerWidget::onUpdatePackages()
 {
     if (m_sdkManager->isBusy()) {
@@ -432,19 +432,11 @@ void AndroidSdkManagerWidget::addPackageFuture(const QFuture<AndroidSdkManager::
 
 void AndroidSdkManagerWidget::beginExecution()
 {
-    const QList<const AndroidSdkPackage *> packagesToUpdate = m_sdkModel->userSelection();
+    if (m_installationChange.count() == 0) {
-    if (packagesToUpdate.isEmpty()) {
         switchView(PackageListing);
         return;
     }
 
-    QStringList installSdkPaths, uninstallSdkPaths;
-    for (auto package : packagesToUpdate) {
-        if (package->state() == AndroidSdkPackage::Installed)
-            uninstallSdkPaths << package->sdkStylePath();
-        else
-            installSdkPaths << package->sdkStylePath();
-    }
     m_formatter->appendMessage(Tr::tr("Installing/Uninstalling selected packages...\n"),
                                NormalMessageFormat);
     m_formatter->appendMessage(Tr::tr("Closing the %1 dialog will cancel the running and scheduled SDK "
@@ -452,7 +444,8 @@ void AndroidSdkManagerWidget::beginExecution()
                                                            Tr::tr("preferences") : Tr::tr("options")),
                                LogMessageFormat);
 
-    addPackageFuture(m_sdkManager->update({installSdkPaths, uninstallSdkPaths}));
+    addPackageFuture(m_sdkManager->update(m_installationChange));
+    m_installationChange = {};
 }
 
 void AndroidSdkManagerWidget::beginUpdate()

src/plugins/android/androidsdkmanagerwidget.h

@@ -70,10 +70,11 @@ public:
     AndroidSdkManagerWidget(AndroidSdkManager *sdkManager, QWidget *parent = nullptr);
     ~AndroidSdkManagerWidget() override;
 
-    void installEssentials();
+    void installMissingEssentials();
 
 private:
-    void onApplyButton(const QString &extraMessage = {});
+    void applyInstallationChange(const InstallationChange &change, const QString &extraMessage = {});
+    void onApplyButton();
     void onUpdatePackages();
     void onCancel();
     void onOperationResult(int index);
@@ -97,6 +98,7 @@ private:
     Utils::OutputFormatter *m_formatter = nullptr;
     QFutureWatcher<AndroidSdkManager::OperationOutput> *m_currentOperation = nullptr;
 
+    InstallationChange m_installationChange;
     QStackedWidget *m_viewStack;
     QWidget *m_packagesStack;
     QWidget *m_outputStack;

src/plugins/android/androidsdkmodel.cpp

@@ -11,11 +11,6 @@
 #include <utils/utilsicons.h>
 
 #include <QIcon>
-#include <QLoggingCategory>
-
-namespace {
-static Q_LOGGING_CATEGORY(androidSdkModelLog, "qtc.android.sdkmodel", QtWarningMsg)
-}
 
 namespace Android {
 namespace Internal {
@@ -258,51 +253,19 @@ bool AndroidSdkModel::setData(const QModelIndex &index, const QVariant &value, i
     return false;
 }
 
-QStringList AndroidSdkModel::selectMissingEssentials()
+InstallationChange AndroidSdkModel::installationChange() const
 {
-    resetSelection();
+    if (m_changeState.isEmpty())
-    QStringList pendingPkgs(androidConfig().allEssentials());
+        return {};
-    auto addTool = [this](QList<const AndroidSdkPackage *>::const_iterator itr) {
-        if ((*itr)->installedLocation().isEmpty()) {
-            m_changeState << *itr;
-            auto i = index(std::distance(m_tools.cbegin(), itr), 0, index(0, 0));
-            emit dataChanged(i, i, {Qt::CheckStateRole});
-        }
-    };
-    for (auto tool = m_tools.cbegin(); tool != m_tools.cend(); ++tool) {
-        if (!pendingPkgs.contains((*tool)->sdkStylePath()))
-            continue;
 
-        addTool(tool);
+    InstallationChange change;
-        pendingPkgs.removeOne((*tool)->sdkStylePath());
+    for (const AndroidSdkPackage *package : m_changeState) {
-
+        if (package->state() == AndroidSdkPackage::Installed)
-        if (pendingPkgs.isEmpty())
+            change.toUninstall << package->sdkStylePath();
-            break;
+        else
+            change.toInstall << package->sdkStylePath();
     }
-
+    return change;
-    // Select SDK platform
-    for (const SdkPlatform *platform : std::as_const(m_sdkPlatforms)) {
-        if (!platform->installedLocation().isEmpty()) {
-            pendingPkgs.removeOne(platform->sdkStylePath());
-        } else if (pendingPkgs.contains(platform->sdkStylePath()) &&
-            platform->installedLocation().isEmpty()) {
-            auto i = index(0, 0, index(1, 0));
-            m_changeState << platform;
-            emit dataChanged(i, i, {Qt::CheckStateRole});
-            pendingPkgs.removeOne(platform->sdkStylePath());
-        }
-        if (pendingPkgs.isEmpty())
-            break;
-    }
-
-    if (!pendingPkgs.isEmpty())
-        qCDebug(androidSdkModelLog) << "Couldn't find some essential packages:" << pendingPkgs;
-    return pendingPkgs;
-}
-
-QList<const AndroidSdkPackage *> AndroidSdkModel::userSelection() const
-{
-    return Utils::toList(m_changeState);
 }
 
 void AndroidSdkModel::resetSelection()

src/plugins/android/androidsdkmodel.h

@@ -41,9 +41,8 @@ public:
     Qt::ItemFlags flags(const QModelIndex &index) const override;
     bool setData(const QModelIndex &index, const QVariant &value, int role) override;
 
-    QStringList selectMissingEssentials();
-    QList<const AndroidSdkPackage *> userSelection() const;
     void resetSelection();
+    InstallationChange installationChange() const;
 
 private:
     void clearContainers();

src/plugins/android/androidsettingswidget.cpp

@@ -669,7 +669,7 @@ void AndroidSettingsWidget::validateSdk()
                                                         AllEssentialsInstalledRow});
     androidConfig().setSdkFullyConfigured(sdkToolsOk && componentsOk);
     if (sdkToolsOk && !componentsOk)
-        m_sdkManagerWidget->installEssentials();
+        m_sdkManagerWidget->installMissingEssentials();
 
     updateNdkList();
     updateUI();