[FEATURE] Show processing models in browser

nyalldawson · nyalldawson · commit 6e1c5c4d7544 · 2017-09-20T14:09:03.000+10:00
And allow them to be executed and edited directly from there
diff --git a/python/plugins/processing/ProcessingPlugin.py b/python/plugins/processing/ProcessingPlugin.py
@@ -33,10 +33,14 @@
 
 from qgis.core import (QgsApplication,
                        QgsProcessingUtils,
-                       QgsProcessingModelAlgorithm)
+                       QgsProcessingModelAlgorithm,
+                       QgsDataItemProvider,
+                       QgsDataProvider,
+                       QgsDataItem,
+                       QgsMimeDataUtils)
 from qgis.gui import (QgsOptionsWidgetFactory,
                       QgsCustomDropHandler)
-from qgis.PyQt.QtCore import Qt, QCoreApplication, QDir
+from qgis.PyQt.QtCore import Qt, QCoreApplication, QDir, QFileInfo
 from qgis.PyQt.QtWidgets import QMenu, QAction
 from qgis.PyQt.QtGui import QIcon
 
@@ -74,7 +78,10 @@ class ProcessingDropHandler(QgsCustomDropHandler):
     def handleFileDrop(self, file):
         if not file.lower().endswith('.model3'):
             return False
+        self.runAlg(file)
 
+    @staticmethod
+    def runAlg(file):
         alg = QgsProcessingModelAlgorithm()
         if not alg.fromFile(file):
             return False
@@ -85,6 +92,72 @@ def handleFileDrop(self, file):
         dlg.show()
         return True
 
+    def customUriProviderKey(self):
+        return 'processing'
+
+    def handleCustomUriDrop(self, uri):
+        path = uri.uri
+        self.runAlg(path)
+
+
+class ProcessingModelItem(QgsDataItem):
+
+    def __init__(self, parent, name, path):
+        super(ProcessingModelItem, self).__init__(QgsDataItem.Custom,parent,name,path)
+        self.setState(QgsDataItem.Populated ) #no children
+        self.setIconName(":/images/themes/default/processingModel.svg")
+        self.setToolTip(QDir.toNativeSeparators(path) )
+
+    def hasDragEnabled(self):
+        return True
+
+    def handleDoubleClick(self):
+        self.runModel()
+        return True
+
+    def mimeUri(self):
+        u = QgsMimeDataUtils.Uri()
+        u.layerType = "custom"
+        u.providerKey = "processing"
+        u.name = self.name()
+        u.uri = self.path()
+        return u
+
+    def runModel(self):
+        ProcessingDropHandler.runAlg(self.path())
+
+    def editModel(self):
+        dlg = ModelerDialog()
+        dlg.loadModel(self.path())
+        dlg.show()
+
+    def actions(self):
+        run_model_action = QAction(self.tr('&Run Model…'), self)
+        run_model_action.triggered.connect(self.runModel)
+        edit_model_action = QAction(self.tr('&Edit Model…'), self)
+        edit_model_action.triggered.connect(self.editModel)
+        return [run_model_action, edit_model_action]
+
+
+class ProcessingDataItemProvider(QgsDataItemProvider):
+
+    def __init__(self):
+        super(ProcessingDataItemProvider, self).__init__()
+
+    def name(self):
+        return 'processing'
+
+    def capabilities(self):
+        return QgsDataProvider.File
+
+    def createDataItem(self, path, parentItem):
+        file_info = QFileInfo(path)
+
+        if file_info.suffix().lower() == 'model3':
+            alg = QgsProcessingModelAlgorithm()
+            if alg.fromFile(path):
+                return ProcessingModelItem(parentItem, alg.name(), path)
+        return None
 
 class ProcessingPlugin(object):
 
@@ -95,6 +168,8 @@ def __init__(self, iface):
         iface.registerOptionsWidgetFactory(self.options_factory)
         self.drop_handler = ProcessingDropHandler()
         iface.registerCustomDropHandler(self.drop_handler)
+        self.item_provider = ProcessingDataItemProvider()
+        QgsApplication.dataItemProviderRegistry().addProvider(self.item_provider)
         self.locator_filter = AlgorithmLocatorFilter()
         iface.registerLocatorFilter(self.locator_filter)
         Processing.initialize()
@@ -182,6 +257,7 @@ def unload(self):
         self.iface.unregisterOptionsWidgetFactory(self.options_factory)
         self.iface.deregisterLocatorFilter(self.locator_filter)
         self.iface.unregisterCustomDropHandler(self.drop_handler)
+        QgsApplication.dataItemProviderRegistry().removeProvider(self.item_provider)
 
         removeMenus()
         Processing.deinitialize()
diff --git a/python/plugins/processing/modeler/ModelerDialog.py b/python/plugins/processing/modeler/ModelerDialog.py
@@ -503,23 +503,26 @@ def openModel(self):
                                                                 ModelerUtils.modelsFolders()[0],
                                                                 self.tr('Processing models (*.model3 *.MODEL3)'))
         if filename:
-            alg = QgsProcessingModelAlgorithm()
-            if alg.fromFile(filename):
-                self.model = alg
-                self.model.setProvider(QgsApplication.processingRegistry().providerById('model'))
-                self.textGroup.setText(alg.group())
-                self.textName.setText(alg.name())
-                self.repaintModel()
+            self.loadModel(filename)
 
-                self.view.centerOn(0, 0)
-                self.hasChanged = False
-            else:
-                QgsMessageLog.logMessage(self.tr('Could not load model {0}').format(filename),
-                                         self.tr('Processing'),
-                                         QgsMessageLog.CRITICAL)
-                QMessageBox.critical(self, self.tr('Could not open model'),
-                                     self.tr('The selected model could not be loaded.\n'
-                                             'See the log for more information.'))
+    def loadModel(self, filename):
+        alg = QgsProcessingModelAlgorithm()
+        if alg.fromFile(filename):
+            self.model = alg
+            self.model.setProvider(QgsApplication.processingRegistry().providerById('model'))
+            self.textGroup.setText(alg.group())
+            self.textName.setText(alg.name())
+            self.repaintModel()
+
+            self.view.centerOn(0, 0)
+            self.hasChanged = False
+        else:
+            QgsMessageLog.logMessage(self.tr('Could not load model {0}').format(filename),
+                                     self.tr('Processing'),
+                                     QgsMessageLog.CRITICAL)
+            QMessageBox.critical(self, self.tr('Could not open model'),
+                                 self.tr('The selected model could not be loaded.\n'
+                                         'See the log for more information.'))
 
     def repaintModel(self, controls=True):
         self.scene = ModelerScene(self, dialog=self)
