mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-14 00:07:35 -04:00
Merge pull request #6257 from alexbruy/processing-sharing
[processing][needs-docs] remove Get scripts and models functionality
This commit is contained in:
Alexander Bruy
GitHub
commit
6841c52210
@ -1,343 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
"""
|
||||
***************************************************************************
|
||||
GetScriptsAndModels.py
|
||||
---------------------
|
||||
Date : June 2014
|
||||
Copyright : (C) 2014 by Victor Olaya
|
||||
Email : volayaf at gmail dot com
|
||||
***************************************************************************
|
||||
* *
|
||||
* This program is free software; you can redistribute it and/or modify *
|
||||
* it under the terms of the GNU General Public License as published by *
|
||||
* the Free Software Foundation; either version 2 of the License, or *
|
||||
* (at your option) any later version. *
|
||||
* *
|
||||
***************************************************************************
|
||||
"""
|
||||
|
||||
__author__ = 'Victor Olaya'
|
||||
__date__ = 'June 2014'
|
||||
__copyright__ = '(C) 2014, Victor Olaya'
|
||||
|
||||
# This will get replaced with a git SHA1 when you do a git archive
|
||||
|
||||
__revision__ = '$Format:%H$'
|
||||
|
||||
import os
|
||||
import json
|
||||
from functools import partial
|
||||
|
||||
from qgis.PyQt import uic
|
||||
from qgis.PyQt.QtCore import Qt, QCoreApplication, QUrl
|
||||
from qgis.PyQt.QtGui import QCursor
|
||||
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,
|
||||
QgsApplication)
|
||||
from qgis.gui import QgsMessageBar
|
||||
|
||||
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
|
||||
from processing.script.ScriptUtils import ScriptUtils
|
||||
from processing.modeler.ModelerUtils import ModelerUtils
|
||||
|
||||
pluginPath = os.path.split(os.path.dirname(__file__))[0]
|
||||
WIDGET, BASE = uic.loadUiType(
|
||||
os.path.join(pluginPath, 'ui', 'DlgGetScriptsAndModels.ui'))
|
||||
|
||||
|
||||
class GetScriptsAction(ToolboxAction):
|
||||
|
||||
def __init__(self):
|
||||
self.name, self.i18n_name = self.trAction('Get scripts from on-line scripts collection')
|
||||
self.group, self.i18n_group = self.trAction('Tools')
|
||||
|
||||
def getIcon(self):
|
||||
return QgsApplication.getThemeIcon("/processingScript.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:
|
||||
QgsApplication.processingRegistry().providerById('script').refreshAlgorithms()
|
||||
|
||||
|
||||
class GetModelsAction(ToolboxAction):
|
||||
|
||||
def __init__(self):
|
||||
self.name, self.i18n_name = self.trAction('Get models from on-line scripts collection')
|
||||
self.group, self.i18n_group = self.trAction('Tools')
|
||||
|
||||
def getIcon(self):
|
||||
return QgsApplication.getThemeIcon("/processingModel.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:
|
||||
QgsApplication.processingRegistry().providerById('model').refreshAlgorithms()
|
||||
|
||||
|
||||
class GetScriptsAndModelsDialog(BASE, WIDGET):
|
||||
|
||||
HELP_TEXT = QCoreApplication.translate('GetScriptsAndModelsDialog',
|
||||
'<h3> Processing resources manager </h3>'
|
||||
'<p>Check/uncheck algorithms in the tree to select the ones that you '
|
||||
'want to install or remove</p>'
|
||||
'<p>Algorithms are divided in 3 groups:</p>'
|
||||
'<ul><li><b>Installed:</b> Algorithms already in your system, with '
|
||||
'the latest version available</li>'
|
||||
'<li><b>Updatable:</b> Algorithms already in your system, but with '
|
||||
'a newer version available in the server</li>'
|
||||
'<li><b>Not installed:</b> Algorithms not installed in your '
|
||||
'system</li></ul>')
|
||||
MODELS = 0
|
||||
SCRIPTS = 1
|
||||
|
||||
tr_disambiguation = {0: 'GetModelsAction',
|
||||
1: 'GetScriptsAction'}
|
||||
|
||||
def __init__(self, resourceType):
|
||||
super(GetScriptsAndModelsDialog, self).__init__(iface.mainWindow())
|
||||
self.setupUi(self)
|
||||
|
||||
if hasattr(self.leFilter, 'setPlaceholderText'):
|
||||
self.leFilter.setPlaceholderText(self.tr('Search...'))
|
||||
|
||||
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 = '{}/models/'.format(repoUrl)
|
||||
self.icon = QgsApplication.getThemeIcon("/processingModel.svg")
|
||||
elif self.resourceType == self.SCRIPTS:
|
||||
self.folder = ScriptUtils.scriptsFolders()[0]
|
||||
self.urlBase = '{}/scripts/'.format(repoUrl)
|
||||
self.icon = QgsApplication.getThemeIcon("/processingScript.svg")
|
||||
|
||||
self.lastSelectedItem = None
|
||||
self.updateProvider = False
|
||||
self.data = None
|
||||
|
||||
self.populateTree()
|
||||
self.buttonBox.accepted.connect(self.okPressed)
|
||||
self.buttonBox.rejected.connect(self.cancelPressed)
|
||||
self.tree.currentItemChanged.connect(self.currentItemChanged)
|
||||
self.leFilter.textChanged.connect(self.fillTree)
|
||||
|
||||
def popupError(self, error=None, url=None):
|
||||
"""Popups an Error message bar for network errors."""
|
||||
disambiguation = self.tr_disambiguation[self.resourceType]
|
||||
widget = iface.messageBar().createMessage(self.tr('Connection problem', disambiguation),
|
||||
self.tr('Could not connect to scripts/models repository', disambiguation))
|
||||
if error and url:
|
||||
QgsMessageLog.logMessage(self.tr(u"Network error code: {} on URL: {}").format(error, url), self.tr(u"Processing"), QgsMessageLog.CRITICAL)
|
||||
button = QPushButton(QCoreApplication.translate("Python", "View message log"), pressed=show_message_log)
|
||||
widget.layout().addWidget(button)
|
||||
|
||||
iface.messageBar().pushWidget(widget, level=QgsMessageBar.CRITICAL, duration=5)
|
||||
|
||||
def grabHTTP(self, url, loadFunction, arguments=None):
|
||||
"""Grab distant content via QGIS internal classes and QtNetwork."""
|
||||
QApplication.setOverrideCursor(Qt.WaitCursor)
|
||||
request = QUrl(url)
|
||||
reply = self.manager.get(QNetworkRequest(request))
|
||||
if arguments:
|
||||
reply.finished.connect(partial(loadFunction, reply, arguments))
|
||||
else:
|
||||
reply.finished.connect(partial(loadFunction, reply))
|
||||
|
||||
while not reply.isFinished():
|
||||
QCoreApplication.processEvents()
|
||||
|
||||
def populateTree(self):
|
||||
self.grabHTTP(self.urlBase + 'list.txt', self.treeLoaded)
|
||||
|
||||
def treeLoaded(self, reply):
|
||||
"""
|
||||
update the tree of scripts/models whenever
|
||||
HTTP request is finished
|
||||
"""
|
||||
QApplication.restoreOverrideCursor()
|
||||
if reply.error() != QNetworkReply.NoError:
|
||||
self.popupError(reply.error(), reply.request().url().toString())
|
||||
else:
|
||||
resources = bytes(reply.readAll()).decode('utf8').splitlines()
|
||||
resources = [r.split(',', 2) for r in resources]
|
||||
self.resources = {f: (v, n) for f, v, n in resources}
|
||||
|
||||
reply.deleteLater()
|
||||
self.fillTree()
|
||||
|
||||
def fillTree(self):
|
||||
self.tree.clear()
|
||||
|
||||
self.uptodateItem = QTreeWidgetItem()
|
||||
self.uptodateItem.setText(0, self.tr('Installed'))
|
||||
self.toupdateItem = QTreeWidgetItem()
|
||||
self.toupdateItem.setText(0, self.tr('Updatable'))
|
||||
self.notinstalledItem = QTreeWidgetItem()
|
||||
self.notinstalledItem.setText(0, self.tr('Not installed'))
|
||||
self.toupdateItem.setIcon(0, self.icon)
|
||||
self.uptodateItem.setIcon(0, self.icon)
|
||||
self.notinstalledItem.setIcon(0, self.icon)
|
||||
|
||||
text = str(self.leFilter.text())
|
||||
|
||||
for i in sorted(list(self.resources.keys()), key=lambda kv: kv[2].lower()):
|
||||
filename = i
|
||||
version = self.resources[filename][0]
|
||||
name = self.resources[filename][1]
|
||||
treeBranch = self.getTreeBranchForState(filename, float(version))
|
||||
if text == '' or text.lower() in filename.lower():
|
||||
item = TreeItem(filename, name, self.icon)
|
||||
treeBranch.addChild(item)
|
||||
if treeBranch != self.notinstalledItem:
|
||||
item.setCheckState(0, Qt.Checked)
|
||||
|
||||
self.tree.addTopLevelItem(self.toupdateItem)
|
||||
self.tree.addTopLevelItem(self.notinstalledItem)
|
||||
self.tree.addTopLevelItem(self.uptodateItem)
|
||||
|
||||
if text != '':
|
||||
self.tree.expandAll()
|
||||
|
||||
self.txtHelp.setHtml(self.HELP_TEXT)
|
||||
|
||||
def setHelp(self, reply, item):
|
||||
"""Change the HTML content"""
|
||||
QApplication.restoreOverrideCursor()
|
||||
if reply.error() != QNetworkReply.NoError:
|
||||
html = self.tr('<h2>No detailed description available for this script</h2>')
|
||||
else:
|
||||
content = bytes(reply.readAll()).decode('utf8')
|
||||
try:
|
||||
descriptions = json.loads(content)
|
||||
except json.decoder.JSONDecodeError:
|
||||
html = self.tr('<h2>JSON Decoding Error - could not load help</h2>')
|
||||
except Exception:
|
||||
html = self.tr('<h2>Unspecified Error - could not load help</h2>')
|
||||
|
||||
html = '<h2>%s</h2>' % item.name
|
||||
html += self.tr('<p><b>Description:</b> {0}</p>').format(getDescription(ALG_DESC, descriptions))
|
||||
html += self.tr('<p><b>Created by:</b> {0}').format(getDescription(ALG_CREATOR, descriptions))
|
||||
html += self.tr('<p><b>Version:</b> {0}').format(getDescription(ALG_VERSION, descriptions))
|
||||
reply.deleteLater()
|
||||
self.txtHelp.setHtml(html)
|
||||
|
||||
def currentItemChanged(self, item, prev):
|
||||
if isinstance(item, TreeItem):
|
||||
url = self.urlBase + item.filename.replace(' ', '%20') + '.help'
|
||||
self.grabHTTP(url, self.setHelp, item)
|
||||
else:
|
||||
self.txtHelp.setHtml(self.HELP_TEXT)
|
||||
|
||||
def getTreeBranchForState(self, filename, version):
|
||||
if not os.path.exists(os.path.join(self.folder, filename)):
|
||||
return self.notinstalledItem
|
||||
else:
|
||||
helpFile = os.path.join(self.folder, filename + '.help')
|
||||
try:
|
||||
with open(helpFile) as f:
|
||||
helpContent = json.load(f)
|
||||
currentVersion = float(helpContent[Help2Html.ALG_VERSION])
|
||||
except Exception:
|
||||
currentVersion = 0
|
||||
if version > currentVersion:
|
||||
return self.toupdateItem
|
||||
else:
|
||||
return self.uptodateItem
|
||||
|
||||
def cancelPressed(self):
|
||||
super(GetScriptsAndModelsDialog, self).reject()
|
||||
|
||||
def storeFile(self, reply, filename):
|
||||
"""store a script/model that has been downloaded"""
|
||||
QApplication.restoreOverrideCursor()
|
||||
if reply.error() != QNetworkReply.NoError:
|
||||
if os.path.splitext(filename)[1].lower() == '.help':
|
||||
content = '{"ALG_VERSION" : %s}' % self.resources[filename[:-5]][0]
|
||||
else:
|
||||
self.popupError(reply.error(), reply.request().url().toString())
|
||||
content = None
|
||||
else:
|
||||
content = bytes(reply.readAll()).decode('utf8')
|
||||
|
||||
reply.deleteLater()
|
||||
if content:
|
||||
path = os.path.join(self.folder, filename)
|
||||
with open(path, 'w') as f:
|
||||
f.write(content)
|
||||
|
||||
self.progressBar.setValue(self.progressBar.value() + 1)
|
||||
|
||||
def okPressed(self):
|
||||
toDownload = []
|
||||
for i in range(self.toupdateItem.childCount()):
|
||||
item = self.toupdateItem.child(i)
|
||||
if item.checkState(0) == Qt.Checked:
|
||||
toDownload.append(item.filename)
|
||||
for i in range(self.notinstalledItem.childCount()):
|
||||
item = self.notinstalledItem.child(i)
|
||||
if item.checkState(0) == Qt.Checked:
|
||||
toDownload.append(item.filename)
|
||||
|
||||
if toDownload:
|
||||
self.progressBar.setMaximum(len(toDownload) * 2)
|
||||
for i, filename in enumerate(toDownload):
|
||||
QCoreApplication.processEvents()
|
||||
url = self.urlBase + filename.replace(' ', '%20')
|
||||
self.grabHTTP(url, self.storeFile, filename)
|
||||
|
||||
url += '.help'
|
||||
self.grabHTTP(url, self.storeFile, filename + '.help')
|
||||
|
||||
toDelete = []
|
||||
for i in range(self.uptodateItem.childCount()):
|
||||
item = self.uptodateItem.child(i)
|
||||
if item.checkState(0) == Qt.Unchecked:
|
||||
toDelete.append(item.filename)
|
||||
|
||||
# Remove py and help files if they exist
|
||||
for filename in toDelete:
|
||||
for pathname in (filename, filename + u".help"):
|
||||
path = os.path.join(self.folder, pathname)
|
||||
if os.path.exists(path):
|
||||
os.remove(path)
|
||||
|
||||
self.updateProvider = len(toDownload) + len(toDelete) > 0
|
||||
super(GetScriptsAndModelsDialog, self).accept()
|
||||
|
||||
|
||||
class TreeItem(QTreeWidgetItem):
|
||||
|
||||
def __init__(self, filename, name, icon):
|
||||
QTreeWidgetItem.__init__(self)
|
||||
self.name = name
|
||||
self.filename = filename
|
||||
self.setText(0, name)
|
||||
self.setIcon(0, icon)
|
||||
self.setCheckState(0, Qt.Unchecked)
|
||||
@ -43,7 +43,6 @@ from processing.modeler.EditModelAction import EditModelAction
|
||||
from processing.modeler.CreateNewModelAction import CreateNewModelAction
|
||||
from processing.modeler.DeleteModelAction import DeleteModelAction
|
||||
from processing.modeler.AddModelFromFileAction import AddModelFromFileAction
|
||||
from processing.gui.GetScriptsAndModels import GetModelsAction
|
||||
from processing.gui.ProviderActions import (ProviderActions,
|
||||
ProviderContextMenuActions)
|
||||
|
||||
@ -54,7 +53,7 @@ class ModelerAlgorithmProvider(QgsProcessingProvider):
|
||||
|
||||
def __init__(self):
|
||||
super().__init__()
|
||||
self.actions = [CreateNewModelAction(), AddModelFromFileAction(), GetModelsAction()]
|
||||
self.actions = [CreateNewModelAction(), AddModelFromFileAction()]
|
||||
self.contextMenuActions = [EditModelAction(), DeleteModelAction()]
|
||||
self.algs = []
|
||||
|
||||
|
||||
@ -36,7 +36,6 @@ from processing.gui.DeleteScriptAction import DeleteScriptAction
|
||||
from processing.gui.CreateNewScriptAction import CreateNewScriptAction
|
||||
from processing.script.ScriptUtils import ScriptUtils
|
||||
from processing.script.AddScriptFromFileAction import AddScriptFromFileAction
|
||||
from processing.gui.GetScriptsAndModels import GetScriptsAction
|
||||
from processing.gui.ProviderActions import (ProviderActions,
|
||||
ProviderContextMenuActions)
|
||||
from processing.script.CreateScriptCollectionPluginAction import CreateScriptCollectionPluginAction
|
||||
@ -53,7 +52,6 @@ class ScriptAlgorithmProvider(QgsProcessingProvider):
|
||||
self.actions = [CreateNewScriptAction('Create new script',
|
||||
CreateNewScriptAction.SCRIPT_PYTHON),
|
||||
AddScriptFromFileAction(),
|
||||
GetScriptsAction(),
|
||||
CreateScriptCollectionPluginAction()]
|
||||
self.contextMenuActions = \
|
||||
[EditScriptAction(EditScriptAction.SCRIPT_PYTHON),
|
||||
|
||||
@ -1,121 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ui version="4.0">
|
||||
<class>DlgGetScriptsAndModels</class>
|
||||
<widget class="QDialog" name="DlgGetScriptsAndModels">
|
||||
<property name="geometry">
|
||||
<rect>
|
||||
<x>0</x>
|
||||
<y>0</y>
|
||||
<width>504</width>
|
||||
<height>523</height>
|
||||
</rect>
|
||||
</property>
|
||||
<property name="windowTitle">
|
||||
<string>Get scripts and models</string>
|
||||
</property>
|
||||
<layout class="QGridLayout" name="gridLayout">
|
||||
<item row="0" column="0" colspan="2">
|
||||
<widget class="QSplitter" name="splitter">
|
||||
<property name="orientation">
|
||||
<enum>Qt::Horizontal</enum>
|
||||
</property>
|
||||
<widget class="QWidget" name="">
|
||||
<layout class="QVBoxLayout" name="verticalLayout">
|
||||
<item>
|
||||
<widget class="QgsFilterLineEdit" name="leFilter">
|
||||
<property name="qgisRelation" stdset="0">
|
||||
<string notr="true"/>
|
||||
</property>
|
||||
</widget>
|
||||
</item>
|
||||
<item>
|
||||
<widget class="QTreeWidget" name="tree">
|
||||
<property name="selectionMode">
|
||||
<enum>QAbstractItemView::SingleSelection</enum>
|
||||
</property>
|
||||
<attribute name="headerVisible">
|
||||
<bool>false</bool>
|
||||
</attribute>
|
||||
<attribute name="headerCascadingSectionResizes">
|
||||
<bool>false</bool>
|
||||
</attribute>
|
||||
<attribute name="headerDefaultSectionSize">
|
||||
<number>350</number>
|
||||
</attribute>
|
||||
<attribute name="headerHighlightSections">
|
||||
<bool>false</bool>
|
||||
</attribute>
|
||||
<attribute name="headerShowSortIndicator" stdset="0">
|
||||
<bool>true</bool>
|
||||
</attribute>
|
||||
<attribute name="headerStretchLastSection">
|
||||
<bool>true</bool>
|
||||
</attribute>
|
||||
<column>
|
||||
<property name="text">
|
||||
<string notr="true">1</string>
|
||||
</property>
|
||||
</column>
|
||||
</widget>
|
||||
</item>
|
||||
</layout>
|
||||
</widget>
|
||||
<widget class="QTextEdit" name="txtHelp"/>
|
||||
</widget>
|
||||
</item>
|
||||
<item row="1" column="0">
|
||||
<widget class="QProgressBar" name="progressBar">
|
||||
<property name="sizePolicy">
|
||||
<sizepolicy hsizetype="MinimumExpanding" vsizetype="Fixed">
|
||||
<horstretch>0</horstretch>
|
||||
<verstretch>0</verstretch>
|
||||
</sizepolicy>
|
||||
</property>
|
||||
<property name="minimumSize">
|
||||
<size>
|
||||
<width>0</width>
|
||||
<height>0</height>
|
||||
</size>
|
||||
</property>
|
||||
<property name="value">
|
||||
<number>0</number>
|
||||
</property>
|
||||
<property name="invertedAppearance">
|
||||
<bool>false</bool>
|
||||
</property>
|
||||
</widget>
|
||||
</item>
|
||||
<item row="1" column="1">
|
||||
<widget class="QDialogButtonBox" name="buttonBox">
|
||||
<property name="sizePolicy">
|
||||
<sizepolicy hsizetype="MinimumExpanding" vsizetype="Fixed">
|
||||
<horstretch>0</horstretch>
|
||||
<verstretch>0</verstretch>
|
||||
</sizepolicy>
|
||||
</property>
|
||||
<property name="maximumSize">
|
||||
<size>
|
||||
<width>200</width>
|
||||
<height>16777215</height>
|
||||
</size>
|
||||
</property>
|
||||
<property name="orientation">
|
||||
<enum>Qt::Horizontal</enum>
|
||||
</property>
|
||||
<property name="standardButtons">
|
||||
<set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
|
||||
</property>
|
||||
</widget>
|
||||
</item>
|
||||
</layout>
|
||||
</widget>
|
||||
<customwidgets>
|
||||
<customwidget>
|
||||
<class>QgsFilterLineEdit</class>
|
||||
<extends>QLineEdit</extends>
|
||||
<header>qgis.gui</header>
|
||||
</customwidget>
|
||||
</customwidgets>
|
||||
<resources/>
|
||||
<connections/>
|
||||
</ui>
|
||||
Loading…
x
Reference in New Issue
Block a user