Implement profiles for plugin management.

Author: hsorby

src/mapclient/application.py

@@ -383,7 +383,7 @@ def _user_specified_environment_main(base_dir, directories):
             if os.path.isdir(d) and d not in plugin_directories:
                 plugin_directories.append(d)
 
-        pm.setDirectories(plugin_directories)
+        pm.set_directories(plugin_directories)
         model.writeSettings()
 
     logger.info(f"Set environment variable '{APPLICATION_ENVIRONMENT_CONFIG_DIR_VARIABLE}' to '{config_dir}' to use application with these settings.")

src/mapclient/core/managers/pluginmanager.py

@@ -39,7 +39,7 @@ def getVirtualEnvCandidates():
 
 
 def _get_app_profile_key():
-    return f'profile_name_{stable_hash(get_app_path())}'
+    return f'current_profile_{stable_hash(get_app_path())}'
 
 
 class PluginManager:
@@ -76,6 +76,12 @@ def getVirtualEnvDirectory(self):
     def directories(self):
         return self._profile_directories.get(self._current_profile, [])
 
+    def current_profile(self):
+        return self._current_profile
+
+    def set_current_profile(self, profile_name):
+        self._current_profile = profile_name
+
     def setReloadPlugins(self, state=True):
         self._reload_plugins = state
 
@@ -105,13 +111,12 @@ def list(self):
     def setOptions(self, options):
         self._virtualenv_dir = options[VIRTUAL_ENV_PATH]
 
-    def setDirectories(self, directories):
+    def set_directories(self, directories):
         """
         Set the list of directories to be searched for
         plugins.  Returns true if the directories listing
         was updated and false otherwise.
         """
-
         current_directories = self._profile_directories.get(self._current_profile, [])
         if current_directories != directories:
             self._profile_directories[self._current_profile] = directories
@@ -356,6 +361,7 @@ def readSettings(self, settings):
             self._profile_directories[profile_name] = directories
         settings.endArray()
         settings.endGroup()
+        self._profile_directories[CONST_DEFAULT_PROFILE] = self._profile_directories.get(CONST_DEFAULT_PROFILE, [])
         settings.beginGroup('Ignored Plugins')
         plugin_count = settings.beginReadArray('plugins')
         for i in range(plugin_count):
@@ -399,6 +405,7 @@ def writeSettings(self, settings):
                 settings.setArrayIndex(directory_index)
                 settings.setValue('directory', directory)
             settings.endArray()
+            profile_index += 1
         settings.endArray()
         settings.endGroup()
         settings.beginGroup('Ignored Plugins')
@@ -579,8 +586,8 @@ def checkForMissingPlugins(self, to_check):
         """
         missing_plugins = {}
         for plugin in to_check:
-            if not (plugin in self._database and \
-                    to_check[plugin]['author'] == self._database[plugin]['author'] and \
+            if not (plugin in self._database and
+                    to_check[plugin]['author'] == self._database[plugin]['author'] and
                     to_check[plugin]['version'] == self._database[plugin]['version']):
                 missing_plugins[plugin] = to_check[plugin]
 

src/mapclient/tools/pluginfinder/downloadtodirectorydialog.py

@@ -62,7 +62,7 @@ def _download_clicked(self):
                                                'directory. Do you wish to add this directory to the MAP-Client plugin search path?')
                 if add_dir == QMessageBox.StandardButton.Yes:
                     self._plugin_directories.append(self._selected_directory)
-                    self._plugin_manager.setDirectories(self._plugin_directories)
+                    self._plugin_manager.set_directories(self._plugin_directories)
 
             answer = QMessageBox.information(self, 'Download Successful', 'The selected plugin was successfully downloaded. '
                                              'You may need to restart the application to pick up newly downloaded plugins.')

src/mapclient/tools/pluginmanager/pluginmanagerdialog.py

@@ -19,8 +19,11 @@
 """
 import json
 import os
+from copy import deepcopy
 
 from PySide6 import QtGui, QtWidgets
+
+from mapclient.core.managers.pluginmanager import CONST_DEFAULT_PROFILE
 from mapclient.tools.pluginmanager.ui.ui_pluginmanagerdialog import Ui_PluginManagerDialog
 
 
@@ -34,8 +37,12 @@ def __init__(self, plugin_manager, parent=None):
         self._ui = Ui_PluginManagerDialog()
         self._ui.setupUi(self)
         self._ui.removeButton.setEnabled(False)
+        self._ui.advancedButton.setVisible(False)
 
         self._plugin_manager = plugin_manager
+        self._profile_directories = deepcopy(plugin_manager.profile_directories())
+        self._initialise_ui()
+        self._update_ui()
 
         self._make_connections()
 
@@ -61,16 +68,28 @@ def _show_advanced_dialog(self):
             self._updaterSettings = dlg._updaterSettings
             self.reload_plugins()
 
-    def _profile_changed(self, previous_text, current_text):
-        print("Update directory listing for profile:", self._ui.profileComboBox.currentText())
-        print(previous_text, current_text)
-        self._plugin_manager.set_profile_directories(previous_text, self.directories())
+    def _initialise_ui(self):
+        self._ui.profileComboBox.clear()
         self._ui.directoryListing.clear()
-        profile_name = self._ui.profileComboBox.currentText()
-        if profile_name:
-            directories = self._plugin_manager.profile_directories(profile_name)
-            if directories:
-                self._set_directories(directories)
+
+        # Add profiles to the combo box.
+        current_profile = self._plugin_manager.current_profile()
+        for profile in self._profile_directories:
+            self._ui.profileComboBox.addItem(profile)
+            if profile == current_profile:
+                self._ui.profileComboBox.setCurrentText(profile)
+
+        self._set_directories(self._profile_directories.get(current_profile, []))
+
+    def _update_ui(self):
+        editable_profile = self._ui.profileComboBox.currentText() != CONST_DEFAULT_PROFILE
+        self._ui.profileEditButton.setEnabled(editable_profile)
+        self._ui.profileDeleteButton.setEnabled(editable_profile)
+
+    def _profile_changed(self, current_index):
+        current_profile = self._ui.profileComboBox.currentText()
+        self._set_directories(self._profile_directories.get(current_profile, []))
+        self._update_ui()
 
     def _directory_selection_changed(self):
         self._ui.removeButton.setEnabled(len(self._ui.directoryListing.selectedItems()) > 0)
@@ -85,7 +104,7 @@ def _create_new_profile(self):
                 self._ui.profileComboBox.addItem(new_profile)
                 self._ui.profileComboBox.setCurrentText(new_profile)
                 self._ui.directoryListing.clear()
-                self._plugin_manager.add_profile(new_profile)
+                self._profile_directories[new_profile] = []
 
     def _edit_current_profile(self):
         from mapclient.tools.pluginmanager.editprofiledialog import EditProfileDialog
@@ -94,22 +113,27 @@ def _edit_current_profile(self):
         if dlg.exec():
             current_profile = self._ui.profileComboBox.currentText()
             edited_profile = dlg.getProfileName()
-            if edited_profile:
+            if edited_profile and edited_profile != current_profile and edited_profile not in self._profile_directories.keys():
                 current_index = self._ui.profileComboBox.currentIndex()
                 self._ui.profileComboBox.setItemText(current_index, edited_profile)
-                self._plugin_manager.rename_profile(current_profile, edited_profile)
+                self._profile_directories[edited_profile] = self._profile_directories[current_profile]
+                del self._profile_directories[current_profile]
 
     def _delete_current_profile(self):
+        current_profile = self._ui.profileComboBox.currentText()
         self._ui.profileComboBox.removeItem(self._ui.profileComboBox.currentIndex())
-        self._plugin_manager.remove_profile(self._ui.profileComboBox.currentText())
+        self._profile_directories.pop(current_profile)
+        self._update_ui()
 
     def _remove_button_clicked(self):
         for item in self._ui.directoryListing.selectedItems():
-            self._ui.directoryListing.takeItem(self._ui.directoryListing.row(item))
+            row = self._ui.directoryListing.row(item)
+            current_profile = self._ui.profileComboBox.currentText()
+            del self._profile_directories[current_profile][row]
+            self._ui.directoryListing.takeItem(row)
 
     def _add_directory_clicked(self):
         selected_items = self._ui.directoryListing.selectedItems()
-        last = ''
         if selected_items:
             last_selected_item = selected_items[-1]
             last = last_selected_item
@@ -121,6 +145,8 @@ def _add_directory_clicked(self):
 
         directory = QtWidgets.QFileDialog.getExistingDirectory(self, caption='Select External Plugin Directory', dir=last, options=QtWidgets.QFileDialog.ShowDirsOnly | QtWidgets.QFileDialog.DontResolveSymlinks | QtWidgets.QFileDialog.ReadOnly)
         if len(directory) > 0:
+            current_profile = self._ui.profileComboBox.currentText()
+            self._profile_directories[current_profile].append(directory)
             self._ui.directoryListing.addItem(directory)
 
     def _get_profile_directories(self, profile_name):
@@ -161,6 +187,7 @@ def profile(self):
         return self._ui.profileComboBox.currentText()
 
     def _set_directories(self, directories):
+        self._ui.directoryListing.clear()
         self._ui.directoryListing.addItems([directory for directory in directories if os.path.exists(directory)])
 
     def directories(self):
@@ -170,6 +197,10 @@ def directories(self):
 
         return directories
 
+    def save_profile_data(self):
+        self._plugin_manager.set_current_profile(self._ui.profileComboBox.currentText())
+        self._plugin_manager.set_profile_directories(self._profile_directories)
+
 # import sys
 # import json
 # import os

src/mapclient/tools/pluginmanager/qt/pluginmanagerdialog.ui

@@ -38,27 +38,17 @@
       </widget>
      </item>
      <item>
-      <spacer name="horizontalSpacer_2">
-       <property name="orientation">
-        <enum>Qt::Horizontal</enum>
-       </property>
-       <property name="sizeHint" stdset="0">
-        <size>
-         <width>40</width>
-         <height>20</height>
-        </size>
-       </property>
-      </spacer>
-     </item>
-     <item>
-      <widget class="QPushButton" name="profileDeleteButton">
+      <widget class="QPushButton" name="profileNewButton">
        <property name="text">
-        <string>Delete</string>
+        <string>New</string>
+       </property>
+       <property name="default">
+        <bool>true</bool>
        </property>
       </widget>
      </item>
      <item>
-      <spacer name="horizontalSpacer_3">
+      <spacer name="horizontalSpacer_2">
        <property name="orientation">
         <enum>Qt::Horizontal</enum>
        </property>
@@ -78,12 +68,9 @@
       </widget>
      </item>
      <item>
-      <widget class="QPushButton" name="profileNewButton">
+      <widget class="QPushButton" name="profileDeleteButton">
        <property name="text">
-        <string>New</string>
-       </property>
-       <property name="default">
-        <bool>true</bool>
+        <string>Delete</string>
        </property>
       </widget>
      </item>

src/mapclient/tools/pluginmanager/ui/ui_pluginmanagerdialog.py

@@ -3,7 +3,7 @@
 ################################################################################
 ## Form generated from reading UI file 'pluginmanagerdialog.ui'
 ##
-## Created by: Qt User Interface Compiler version 6.8.1
+## Created by: Qt User Interface Compiler version 6.9.1
 ##
 ## WARNING! All changes made in this file will be lost when recompiling UI file!
 ################################################################################
@@ -47,28 +47,24 @@ def setupUi(self, PluginManagerDialog):
 
         self.horizontalLayout_3.addWidget(self.profileComboBox)
 
-        self.horizontalSpacer_2 = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
-
-        self.horizontalLayout_3.addItem(self.horizontalSpacer_2)
-
-        self.profileDeleteButton = QPushButton(PluginManagerDialog)
-        self.profileDeleteButton.setObjectName(u"profileDeleteButton")
+        self.profileNewButton = QPushButton(PluginManagerDialog)
+        self.profileNewButton.setObjectName(u"profileNewButton")
 
-        self.horizontalLayout_3.addWidget(self.profileDeleteButton)
+        self.horizontalLayout_3.addWidget(self.profileNewButton)
 
-        self.horizontalSpacer_3 = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+        self.horizontalSpacer_2 = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
 
-        self.horizontalLayout_3.addItem(self.horizontalSpacer_3)
+        self.horizontalLayout_3.addItem(self.horizontalSpacer_2)
 
         self.profileEditButton = QPushButton(PluginManagerDialog)
         self.profileEditButton.setObjectName(u"profileEditButton")
 
         self.horizontalLayout_3.addWidget(self.profileEditButton)
 
-        self.profileNewButton = QPushButton(PluginManagerDialog)
-        self.profileNewButton.setObjectName(u"profileNewButton")
+        self.profileDeleteButton = QPushButton(PluginManagerDialog)
+        self.profileDeleteButton.setObjectName(u"profileDeleteButton")
 
-        self.horizontalLayout_3.addWidget(self.profileNewButton)
+        self.horizontalLayout_3.addWidget(self.profileDeleteButton)
 
 
         self.verticalLayout.addLayout(self.horizontalLayout_3)
@@ -164,9 +160,9 @@ def setupUi(self, PluginManagerDialog):
     def retranslateUi(self, PluginManagerDialog):
         PluginManagerDialog.setWindowTitle(QCoreApplication.translate("PluginManagerDialog", u"Plugin Manager", None))
         self.profileLabel.setText(QCoreApplication.translate("PluginManagerDialog", u"Profile:", None))
-        self.profileDeleteButton.setText(QCoreApplication.translate("PluginManagerDialog", u"Delete", None))
-        self.profileEditButton.setText(QCoreApplication.translate("PluginManagerDialog", u"Edit", None))
         self.profileNewButton.setText(QCoreApplication.translate("PluginManagerDialog", u"New", None))
+        self.profileEditButton.setText(QCoreApplication.translate("PluginManagerDialog", u"Edit", None))
+        self.profileDeleteButton.setText(QCoreApplication.translate("PluginManagerDialog", u"Delete", None))
         self.groupBox.setTitle("")
         self.label.setText(QCoreApplication.translate("PluginManagerDialog", u"Plugin directories:", None))
         self.addButton.setText(QCoreApplication.translate("PluginManagerDialog", u"Add Directory", None))

src/mapclient/view/mainwindow.py

@@ -456,7 +456,7 @@ def _plugin_manager_load_plugins(self):
         # Are we currently using the plugin manager dialog?
         if self._plugin_manager_dlg is not None:
             pm.setReloadPlugins()
-            pm.setDirectories(self._plugin_manager_dlg.directories())
+            pm.set_directories(self._plugin_manager_dlg.directories())
 
         if pm.reloadPlugins():
             pm.load()

src/mapclient/view/workflow/workflowwidget.py

@@ -390,7 +390,7 @@ def installMissingPlugins(self, plugins):
             pluginDirs = pm.directories()
             if directory not in pluginDirs:
                 pluginDirs.append(directory)
-                pm.setDirectories(pluginDirs)
+                pm.set_directories(pluginDirs)
         dlg = PluginProgress(plugins, directory, self)
         dlg.show()
         dlg.run()