[processing] configurable URL for scripts and models repository

Author: alexbruy

python/plugins/processing/core/ProcessingConfig.py

@@ -64,7 +64,8 @@ class ProcessingConfig(object):
     WARN_UNMATCHING_EXTENT_CRS = 'WARN_UNMATCHING_EXTENT_CRS'
     DEFAULT_OUTPUT_RASTER_LAYER_EXT = 'DEFAULT_OUTPUT_RASTER_LAYER_EXT'
     DEFAULT_OUTPUT_VECTOR_LAYER_EXT = 'DEFAULT_OUTPUT_VECTOR_LAYER_EXT'
-    SHOW_PROVIDERS_TOOLTIP = "SHOW_PROVIDERS_TOOLTIP"
+    SHOW_PROVIDERS_TOOLTIP = 'SHOW_PROVIDERS_TOOLTIP'
+    MODELS_SCRIPTS_REPO = 'MODELS_SCRIPTS_REPO'
 
     settings = {}
     settingIcons = {}
@@ -156,6 +157,11 @@ def initialize():
             ProcessingConfig.tr('General'),
             ProcessingConfig.RECENT_ALGORITHMS,
             ProcessingConfig.tr('Recent algorithms'), '', hidden=True))
+        ProcessingConfig.addSetting(Setting(
+            ProcessingConfig.tr('General'),
+            ProcessingConfig.MODELS_SCRIPTS_REPO,
+            ProcessingConfig.tr('Scripts and models repository'),
+            'https://raw.githubusercontent.com/qgis/QGIS-Processing/master'))
         extensions = processing.tools.dataobjects.getSupportedOutputVectorLayerExtensions()
         ProcessingConfig.addSetting(Setting(
             ProcessingConfig.tr('General'),

python/plugins/processing/gui/GetScriptsAndModels.py

@@ -35,14 +35,15 @@
 from qgis.PyQt import uic
 from qgis.PyQt.QtCore import Qt, QCoreApplication, QUrl
 from qgis.PyQt.QtGui import QIcon, QCursor
-from qgis.PyQt.QtWidgets import QApplication, QTreeWidgetItem, QPushButton
+from qgis.PyQt.QtWidgets import QApplication, QTreeWidgetItem, QPushButton, QMessageBox
 from qgis.PyQt.QtNetwork import QNetworkReply, QNetworkRequest
 
 from qgis.utils import iface, show_message_log
 from qgis.core import QgsNetworkAccessManager, QgsMessageLog
 from qgis.gui import QgsMessageBar
 
 from processing.core.alglist import algList
+from processing.core.ProcessingConfig import ProcessingConfig
 from processing.gui.ToolboxAction import ToolboxAction
 from processing.gui import Help2Html
 from processing.gui.Help2Html import getDescription, ALG_DESC, ALG_VERSION, ALG_CREATOR
@@ -65,6 +66,12 @@ def getIcon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'script.svg'))
 
     def execute(self):
+        repoUrl = ProcessingConfig.getSetting(ProcessingConfig.MODELS_SCRIPTS_REPO)
+        if repoUrl is None or repoUrl == '':
+            QMessageBox.warning(None,
+                                self.tr('Repository error'),
+                                self.tr('Scripts and models repository is not configured.'))
+            return
         dlg = GetScriptsAndModelsDialog(GetScriptsAndModelsDialog.SCRIPTS)
         dlg.exec_()
         if dlg.updateProvider:
@@ -81,6 +88,13 @@ def getIcon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'r.svg'))
 
     def execute(self):
+        repoUrl = ProcessingConfig.getSetting(ProcessingConfig.MODELS_SCRIPTS_REPO)
+        if repoUrl is None or repoUrl == '':
+            QMessageBox.warning(None,
+                                self.tr('Repository error'),
+                                self.tr('Scripts and models repository is not configured.'))
+            return
+
         dlg = GetScriptsAndModelsDialog(GetScriptsAndModelsDialog.RSCRIPTS)
         dlg.exec_()
         if dlg.updateProvider:
@@ -97,6 +111,13 @@ def getIcon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'model.svg'))
 
     def execute(self):
+        repoUrl = ProcessingConfig.getSetting(ProcessingConfig.MODELS_SCRIPTS_REPO)
+        if repoUrl is None or repoUrl == '':
+            QMessageBox.warning(None,
+                                self.tr('Repository error'),
+                                self.tr('Scripts and models repository is not configured.'))
+            return
+
         dlg = GetScriptsAndModelsDialog(GetScriptsAndModelsDialog.MODELS)
         dlg.exec_()
         if dlg.updateProvider:
@@ -133,18 +154,20 @@ def __init__(self, resourceType):
 
         self.manager = QgsNetworkAccessManager.instance()
 
+        repoUrl = ProcessingConfig.getSetting(ProcessingConfig.MODELS_SCRIPTS_REPO)
+
         self.resourceType = resourceType
         if self.resourceType == self.MODELS:
             self.folder = ModelerUtils.modelsFolders()[0]
-            self.urlBase = 'https://raw.githubusercontent.com/qgis/QGIS-Processing/master/models/'
+            self.urlBase = '{}/models/'.format(repoUrl)
             self.icon = QIcon(os.path.join(pluginPath, 'images', 'model.svg'))
         elif self.resourceType == self.SCRIPTS:
             self.folder = ScriptUtils.scriptsFolders()[0]
-            self.urlBase = 'https://raw.githubusercontent.com/qgis/QGIS-Processing/master/scripts/'
+            self.urlBase = '{}/scripts/'.format(repoUrl)
             self.icon = QIcon(os.path.join(pluginPath, 'images', 'script.svg'))
         else:
             self.folder = RUtils.RScriptsFolders()[0]
-            self.urlBase = 'https://raw.githubusercontent.com/qgis/QGIS-Processing/master/rscripts/'
+            self.urlBase = '{}/rscripts/'.format(repoUrl)
             self.icon = QIcon(os.path.join(pluginPath, 'images', 'r.svg'))
 
         self.lastSelectedItem = None

python/plugins/processing/script/ScriptAlgorithmProvider.py

@@ -50,7 +50,7 @@ def __init__(self):
                                                    CreateNewScriptAction.SCRIPT_PYTHON),
                              AddScriptFromFileAction(),
                              GetScriptsAction(),
-                             CreateScriptCollectionPluginAction(), ])
+                             CreateScriptCollectionPluginAction()])
         self.contextMenuActions = \
             [EditScriptAction(EditScriptAction.SCRIPT_PYTHON),
              DeleteScriptAction(DeleteScriptAction.SCRIPT_PYTHON)]