Merge pull request #739 from ghutchis/enh-load-packages

Add code to load new packages out of directories for install

Author: ghutchis

avogadro/mainwindow.cpp

@@ -27,12 +27,14 @@
 #include <avogadro/qtgui/molecule.h>
 #include <avogadro/qtgui/moleculemodel.h>
 #include <avogadro/qtgui/multiviewwidget.h>
+#include <avogadro/qtgui/packagemanager.h>
 #include <avogadro/qtgui/periodictableview.h>
 #include <avogadro/qtgui/richtextdelegate.h>
 #include <avogadro/qtgui/rwmolecule.h>
 #include <avogadro/qtgui/sceneplugin.h>
 #include <avogadro/qtgui/scenepluginmodel.h>
 #include <avogadro/qtgui/toolplugin.h>
+#include <avogadro/qtgui/utilities.h>
 #include <avogadro/qtopengl/activeobjects.h>
 #include <avogadro/qtopengl/glwidget.h>
 #include <avogadro/qtplugins/pluginmanager.h>
@@ -316,12 +318,18 @@ MainWindow::MainWindow(const QStringList& fileNames, bool disableSettings)
       connect(extension, &QtGui::ExtensionPlugin::registerCommand, this,
               &MainWindow::registerExtensionCommand);
       extension->registerCommands();
-
-      buildMenu(extension);
       m_extensions.append(extension);
     }
   }
 
+  // Scan for pyproject.toml-based plugin packages.
+  loadPackages();
+
+  // now we can build the menus for extensions
+  foreach (ExtensionPlugin* extension, m_extensions) {
+    buildMenu(extension);
+  }
+
   // Now set up the interface.
 #ifdef Q_OS_WIN
   qDebug() << " setting interface ";
@@ -1268,6 +1276,73 @@ void MainWindow::cleanupCurrentAutosave()
   }
 }
 
+void MainWindow::loadPackages()
+{
+  QStringList dirs;
+
+  // Add the standard install locations
+  QStringList stdPaths =
+    QStandardPaths::standardLocations(QStandardPaths::AppLocalDataLocation);
+  foreach (const QString& dirStr, stdPaths) {
+    QString path = dirStr + "/packages";
+    dirs << path;
+  }
+
+  // Add the install-relative library path
+  dirs << QCoreApplication::applicationDirPath() + "/../" +
+            QtGui::Utilities::libraryDirectory() + "/avogadro2/packages";
+
+  // Check the directories for new packages
+  QtGui::PackageManager* pkgManager = QtGui::PackageManager::instance();
+  QStringList newPackages;
+  foreach (const QString& dir, dirs) {
+#ifndef NDEBUG
+    qDebug() << "Checking for packages in" << dir;
+#endif
+    newPackages.append(pkgManager->scanDirectory(dir));
+  }
+
+  // If there are new or updated packages, ask the user before installing
+  if (!newPackages.isEmpty()) {
+    QStringList packageNames;
+    foreach (const QString& dir, newPackages) {
+      packageNames << QFileInfo(dir).baseName();
+    }
+
+    // TODO: list the packages and count, maybe the versions
+    auto reply =
+      QMessageBox::question(this, tr("Install New Packages"),
+                            tr("New or updated packages were found.\n"
+                               "Would you like to install them now?"),
+                            QMessageBox::Yes | QMessageBox::No);
+    if (reply != QMessageBox::Yes) {
+      // Still need to replay cached registrations for already-installed
+      // packages
+      pkgManager->loadRegisteredPackages();
+      return;
+    }
+
+    // TODO: show a dialog listing the new packages and let the user
+    // choose which to install
+    connect(pkgManager, &QtGui::PackageManager::packagesInstalled, this,
+            [this, pkgManager]() {
+              disconnect(pkgManager, &QtGui::PackageManager::packagesInstalled,
+                         this, nullptr);
+              foreach (ExtensionPlugin* ext, m_extensions)
+                buildMenu(ext);
+              m_menuBuilder->buildMenuBar(menuBar());
+            });
+    pkgManager->installPackages(newPackages);
+    return; // Registration and loadRegisteredPackages run in PackageManager
+  }
+
+  // Load cached registrations so consumer plugins get their signals
+#ifndef DEBUG
+  qDebug() << "Load cached packages";
+#endif
+  pkgManager->loadRegisteredPackages();
+}
+
 void MainWindow::checkAutosaveRecovery()
 {
   QString autosaveDirPath =

avogadro/mainwindow.h

@@ -148,6 +148,11 @@ public slots:
    */
   void checkAutosaveRecovery();
 
+  /**
+   * Scan standard directories for pyproject.toml-based plugin packages.
+   */
+  void loadPackages();
+
   void startAutosaveTimer();
 
   QString autosaveFilePath() const;

avogadro/menubuilder.cpp

@@ -68,6 +68,8 @@ void MenuBuilder::addAction(const QStringList& pathList, QAction* action,
 {
   QString path(pathList.join("|"));
   if (m_menuActions.contains(path)) {
+    if (m_menuActions[path].contains(action))
+      return; // already registered, skip duplicate
 #ifdef Q_OS_MAC
     // If we're on Mac, don't show icons by default
     if (!m_showIcons) {
@@ -206,9 +208,11 @@ void MenuBuilder::buildMenu(QMenu* menu, const QString& path)
       bool replacedItem = false;
       foreach (QAction* action, menu->actions()) {
         if (action->text() == text.text) {
-          // insert the new action and then remove the old one
-          menu->insertAction(action, actions[text.text]);
-          menu->removeAction(action);
+          if (action != actions[text.text]) {
+            // insert the new action and then remove the old one
+            menu->insertAction(action, actions[text.text]);
+            menu->removeAction(action);
+          }
           replacedItem = true;
           break;
         }