mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-28 00:17:30 -05:00
415 lines
18 KiB
Python
415 lines
18 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
ModelerDialog.py
|
|
---------------------
|
|
Date : August 2012
|
|
Copyright : (C) 2012 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. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
from sextante.core.SextanteConfig import SextanteConfig
|
|
from sextante.core.GeoAlgorithm import GeoAlgorithm
|
|
from sextante.gui.AlgorithmClassification import AlgorithmDecorator
|
|
|
|
__author__ = 'Victor Olaya'
|
|
__date__ = 'August 2012'
|
|
__copyright__ = '(C) 2012, Victor Olaya'
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
__revision__ = '$Format:%H$'
|
|
|
|
from PyQt4.QtCore import *
|
|
from PyQt4.QtGui import *
|
|
|
|
import codecs
|
|
import pickle
|
|
|
|
from sextante.core.SextanteUtils import SextanteUtils
|
|
|
|
from sextante.gui.HelpEditionDialog import HelpEditionDialog
|
|
from sextante.gui.ParametersDialog import ParametersDialog
|
|
|
|
from sextante.modeler.ModelerParameterDefinitionDialog import ModelerParameterDefinitionDialog
|
|
from sextante.modeler.ModelerAlgorithm import ModelerAlgorithm
|
|
from sextante.modeler.ModelerParametersDialog import ModelerParametersDialog
|
|
from sextante.modeler.ModelerUtils import ModelerUtils
|
|
from sextante.modeler.WrongModelException import WrongModelException
|
|
from sextante.modeler.ModelerScene import ModelerScene
|
|
from sextante.modeler.Providers import Providers
|
|
|
|
from sextante.ui.ui_DlgModeler import Ui_DlgModeler
|
|
|
|
class ModelerDialog(QDialog, Ui_DlgModeler):
|
|
def __init__(self, alg=None):
|
|
QDialog.__init__(self)
|
|
|
|
self.setupUi(self)
|
|
|
|
self.setWindowFlags(self.windowFlags() | Qt.WindowSystemMenuHint |
|
|
Qt.WindowMinMaxButtonsHint)
|
|
|
|
self.tabWidget.setCurrentIndex(0)
|
|
|
|
self.scene = ModelerScene(self)
|
|
self.scene.setSceneRect(QRectF(0, 0, 4000, 4000))
|
|
self.view.setScene(self.scene)
|
|
self.view.ensureVisible(0, 0, 10, 10)
|
|
|
|
# additional buttons
|
|
self.editHelpButton = QPushButton(self.tr("Edit model help"))
|
|
self.buttonBox.addButton(self.editHelpButton, QDialogButtonBox.ActionRole)
|
|
self.runButton = QPushButton(self.tr("Run"))
|
|
self.runButton.setToolTip(self.tr("Execute current model"))
|
|
self.buttonBox.addButton(self.runButton, QDialogButtonBox.ActionRole)
|
|
self.openButton = QPushButton(self.tr("Open"))
|
|
self.openButton.setToolTip(self.tr("Open existing model"))
|
|
self.buttonBox.addButton(self.openButton, QDialogButtonBox.ActionRole)
|
|
self.saveButton = QPushButton(self.tr("Save"))
|
|
self.saveButton.setToolTip(self.tr("Save current model"))
|
|
self.buttonBox.addButton(self.saveButton, QDialogButtonBox.ActionRole)
|
|
self.saveAsButton = QPushButton(self.tr("Save as ..."))
|
|
self.saveAsButton.setToolTip(self.tr("Save current model as"))
|
|
self.buttonBox.addButton(self.saveAsButton, QDialogButtonBox.ActionRole)
|
|
|
|
# fill trees with inputs and algorithms
|
|
self.fillInputsTree()
|
|
self.fillAlgorithmTree()
|
|
|
|
if hasattr(self.searchBox, 'setPlaceholderText'):
|
|
self.searchBox.setPlaceholderText(self.tr("Search..."))
|
|
if hasattr(self.textName, 'setPlaceholderText'):
|
|
self.textName.setPlaceholderText("[Enter model name here]")
|
|
if hasattr(self.textGroup, 'setPlaceholderText'):
|
|
self.textGroup.setPlaceholderText("[Enter group name here]")
|
|
|
|
# connect signals and slots
|
|
self.inputsTree.doubleClicked.connect(self.addInput)
|
|
|
|
self.searchBox.textChanged.connect(self.fillAlgorithmTree)
|
|
self.algorithmTree.doubleClicked.connect(self.addAlgorithm)
|
|
|
|
self.openButton.clicked.connect(self.openModel)
|
|
self.saveButton.clicked.connect(self.save)
|
|
self.saveAsButton.clicked.connect(self.saveAs)
|
|
self.runButton.clicked.connect(self.runModel)
|
|
self.editHelpButton.clicked.connect(self.editHelp)
|
|
|
|
if alg is not None:
|
|
self.alg = alg
|
|
self.textGroup.setText(alg.group)
|
|
self.textName.setText(alg.name)
|
|
self.repaintModel()
|
|
else:
|
|
self.alg = ModelerAlgorithm()
|
|
|
|
self.view.centerOn(0, 0)
|
|
self.alg.setModelerView(self)
|
|
self.help = None
|
|
self.update = False #indicates whether to update or not the toolbox after closing this dialog
|
|
|
|
|
|
def editHelp(self):
|
|
dlg = HelpEditionDialog(self.alg)
|
|
dlg.exec_()
|
|
#We store the description string in case there were not saved because there was no
|
|
#filename defined yet
|
|
if self.alg.descriptionFile is None and dlg.descriptions:
|
|
self.help = dlg.descriptions
|
|
|
|
def runModel(self):
|
|
##TODO: enable alg cloning without saving to file
|
|
if len(self.alg.algs) == 0:
|
|
QMessageBox.warning(self,
|
|
self.tr("Empty model"),
|
|
self.tr("Model doesn't contains any algorithms and/or parameters and can't be executed")
|
|
)
|
|
return
|
|
|
|
if self.alg.descriptionFile is None:
|
|
self.alg.descriptionFile = SextanteUtils.getTempFilename("model")
|
|
text = self.alg.serialize()
|
|
fout = open(self.alg.descriptionFile, "w")
|
|
fout.write(text)
|
|
fout.close()
|
|
self.alg.provider = Providers.providers["model"]
|
|
alg = self.alg.getCopy()
|
|
dlg = ParametersDialog(alg)
|
|
dlg.exec_()
|
|
self.alg.descriptionFile = None
|
|
alg.descriptionFile = None
|
|
else:
|
|
if self.alg.provider is None: # might happen if model is opened from modeler dialog
|
|
self.alg.provider = Providers.providers["model"]
|
|
alg = self.alg.getCopy()
|
|
dlg = ParametersDialog(alg)
|
|
dlg.exec_()
|
|
|
|
def save(self):
|
|
self.saveModel(False)
|
|
|
|
def saveAs(self):
|
|
self.saveModel(True)
|
|
|
|
def saveModel(self, saveAs):
|
|
if unicode(self.textGroup.text()).strip() == "" or unicode(self.textName.text()).strip() == "":
|
|
QMessageBox.warning(self,
|
|
self.tr("Warning"),
|
|
self.tr("Please enter group and model names before saving")
|
|
)
|
|
return
|
|
self.alg.setPositions(self.scene.getParameterPositions(), self.scene.getAlgorithmPositions())
|
|
self.alg.name = unicode(self.textName.text())
|
|
self.alg.group = unicode(self.textGroup.text())
|
|
if self.alg.descriptionFile != None and not saveAs:
|
|
filename = self.alg.descriptionFile
|
|
else:
|
|
filename = unicode(QFileDialog.getSaveFileName(self, self.tr("Save Model"), ModelerUtils.modelsFolder(), self.tr("SEXTANTE models (*.model)")))
|
|
if filename:
|
|
if not filename.endswith(".model"):
|
|
filename += ".model"
|
|
self.alg.descriptionFile = filename
|
|
if filename:
|
|
text = self.alg.serialize()
|
|
fout = codecs.open(filename, "w", encoding='utf-8')
|
|
#fout = open(filename, "w")
|
|
fout.write(text)
|
|
fout.close()
|
|
self.update = True
|
|
#if help strings were defined before saving the model for the first time, we do it here
|
|
if self.help:
|
|
f = open(self.alg.descriptionFile + ".help", "wb")
|
|
pickle.dump(self.help, f)
|
|
f.close()
|
|
self.help = None
|
|
QMessageBox.information(self,
|
|
self.tr("Model saved"),
|
|
self.tr("Model was correctly saved.")
|
|
)
|
|
|
|
def openModel(self):
|
|
filename = unicode(QFileDialog.getOpenFileName(self, self.tr("Open Model"), ModelerUtils.modelsFolder(), self.tr("SEXTANTE models (*.model)")))
|
|
if filename:
|
|
try:
|
|
alg = ModelerAlgorithm()
|
|
alg.openModel(filename)
|
|
self.alg = alg;
|
|
self.alg.setModelerView(self)
|
|
self.textGroup.setText(alg.group)
|
|
self.textName.setText(alg.name)
|
|
self.repaintModel()
|
|
self.view.ensureVisible(self.scene.getLastAlgorithmItem())
|
|
self.view.centerOn(0,0)
|
|
except WrongModelException, e:
|
|
QMessageBox.critical(self,
|
|
self.tr("Could not open model"),
|
|
self.tr("The selected model could not be loaded.\nWrong line: %1").arg(e.msg)
|
|
)
|
|
|
|
def repaintModel(self):
|
|
self.scene = ModelerScene()
|
|
self.scene.setSceneRect(QRectF(0, 0, ModelerAlgorithm.CANVAS_SIZE, ModelerAlgorithm.CANVAS_SIZE))
|
|
self.scene.paintModel(self.alg)
|
|
self.view.setScene(self.scene)
|
|
|
|
def addInput(self):
|
|
item = self.inputsTree.currentItem()
|
|
paramType = str(item.text(0))
|
|
if paramType in ModelerParameterDefinitionDialog.paramTypes:
|
|
dlg = ModelerParameterDefinitionDialog(self.alg, paramType)
|
|
dlg.exec_()
|
|
if dlg.param != None:
|
|
self.alg.setPositions(self.scene.getParameterPositions(), self.scene.getAlgorithmPositions())
|
|
self.alg.addParameter(dlg.param)
|
|
self.repaintModel()
|
|
self.view.ensureVisible(self.scene.getLastParameterItem())
|
|
|
|
def fillInputsTree(self):
|
|
parametersItem = QTreeWidgetItem()
|
|
parametersItem.setText(0, self.tr("Parameters"))
|
|
for paramType in ModelerParameterDefinitionDialog.paramTypes:
|
|
paramItem = QTreeWidgetItem()
|
|
paramItem.setText(0, paramType)
|
|
parametersItem.addChild(paramItem)
|
|
self.inputsTree.addTopLevelItem(parametersItem)
|
|
parametersItem.setExpanded(True)
|
|
|
|
def addAlgorithm(self):
|
|
item = self.algorithmTree.currentItem()
|
|
if isinstance(item, TreeAlgorithmItem):
|
|
alg = ModelerUtils.getAlgorithm(item.alg.commandLineName())
|
|
alg = alg.getCopy()
|
|
dlg = alg.getCustomModelerParametersDialog(self.alg)
|
|
if not dlg:
|
|
dlg = ModelerParametersDialog(alg, self.alg)
|
|
dlg.exec_()
|
|
if dlg.params != None:
|
|
self.alg.setPositions(self.scene.getParameterPositions(), self.scene.getAlgorithmPositions())
|
|
self.alg.addAlgorithm(alg, dlg.params, dlg.values, dlg.outputs, dlg.dependencies)
|
|
self.repaintModel()
|
|
self.view.ensureVisible(self.scene.getLastAlgorithmItem())
|
|
|
|
def fillAlgorithmTree(self):
|
|
useCategories = SextanteConfig.getSetting(SextanteConfig.USE_CATEGORIES)
|
|
if useCategories:
|
|
self.fillAlgorithmTreeUsingCategories()
|
|
else:
|
|
self.fillAlgorithmTreeUsingProviders()
|
|
|
|
self.algorithmTree.sortItems(0, Qt.AscendingOrder)
|
|
|
|
text = unicode(self.searchBox.text())
|
|
if (text != ""):
|
|
self.algorithmTree.expandAll()
|
|
|
|
def fillAlgorithmTreeUsingCategories(self):
|
|
providersToExclude = ["model", "script"]
|
|
self.algorithmTree.clear()
|
|
text = unicode(self.searchBox.text())
|
|
groups = {}
|
|
allAlgs = ModelerUtils.getAlgorithms()
|
|
for providerName in allAlgs.keys():
|
|
provider = allAlgs[providerName]
|
|
name = "ACTIVATE_" + providerName.upper().replace(" ", "_")
|
|
if not SextanteConfig.getSetting(name):
|
|
continue
|
|
if providerName in providersToExclude or len(Providers.providers[providerName].actions) != 0:
|
|
continue
|
|
algs = provider.values()
|
|
#add algorithms
|
|
for alg in algs:
|
|
if not alg.showInModeler:
|
|
continue
|
|
altgroup, altsubgroup, altname = AlgorithmDecorator.getGroupsAndName(alg)
|
|
if altgroup is None:
|
|
continue
|
|
if text =="" or text.lower() in altname.lower():
|
|
if altgroup not in groups:
|
|
groups[altgroup] = {}
|
|
group = groups[altgroup]
|
|
if altsubgroup not in group:
|
|
groups[altgroup][altsubgroup] = []
|
|
subgroup = groups[altgroup][altsubgroup]
|
|
subgroup.append(alg)
|
|
|
|
if len(groups) > 0:
|
|
mainItem = QTreeWidgetItem()
|
|
mainItem.setText(0, "Geoalgorithms")
|
|
mainItem.setIcon(0, GeoAlgorithm.getDefaultIcon())
|
|
mainItem.setToolTip(0, mainItem.text(0))
|
|
for groupname, group in groups.items():
|
|
groupItem = QTreeWidgetItem()
|
|
groupItem.setText(0, groupname)
|
|
groupItem.setIcon(0, GeoAlgorithm.getDefaultIcon())
|
|
groupItem.setToolTip(0, groupItem.text(0))
|
|
mainItem.addChild(groupItem)
|
|
for subgroupname, subgroup in group.items():
|
|
subgroupItem = QTreeWidgetItem()
|
|
subgroupItem.setText(0, subgroupname)
|
|
subgroupItem.setIcon(0, GeoAlgorithm.getDefaultIcon())
|
|
subgroupItem.setToolTip(0, subgroupItem.text(0))
|
|
groupItem.addChild(subgroupItem)
|
|
for alg in subgroup:
|
|
algItem = TreeAlgorithmItem(alg)
|
|
subgroupItem.addChild(algItem)
|
|
self.algorithmTree.addTopLevelItem(mainItem)
|
|
|
|
for providerName in allAlgs.keys():
|
|
groups = {}
|
|
provider = allAlgs[providerName]
|
|
name = "ACTIVATE_" + providerName.upper().replace(" ", "_")
|
|
if not SextanteConfig.getSetting(name):
|
|
continue
|
|
if providerName not in providersToExclude:
|
|
continue
|
|
algs = provider.values()
|
|
#add algorithms
|
|
for alg in algs:
|
|
if not alg.showInModeler:
|
|
continue
|
|
if text =="" or text.lower() in alg.name.lower():
|
|
if alg.group in groups:
|
|
groupItem = groups[alg.group]
|
|
else:
|
|
groupItem = QTreeWidgetItem()
|
|
groupItem.setText(0, alg.group)
|
|
groupItem.setToolTip(0, alg.group)
|
|
groups[alg.group] = groupItem
|
|
algItem = TreeAlgorithmItem(alg)
|
|
groupItem.addChild(algItem)
|
|
|
|
if len(groups) > 0:
|
|
providerItem = QTreeWidgetItem()
|
|
providerItem.setText(0, Providers.providers[providerName].getDescription())
|
|
providerItem.setIcon(0, Providers.providers[providerName].getIcon())
|
|
providerItem.setToolTip(0, providerItem.text(0))
|
|
for groupItem in groups.values():
|
|
providerItem.addChild(groupItem)
|
|
self.algorithmTree.addTopLevelItem(providerItem)
|
|
providerItem.setExpanded(text!="")
|
|
for groupItem in groups.values():
|
|
if text != "":
|
|
groupItem.setExpanded(True)
|
|
|
|
|
|
def fillAlgorithmTreeUsingProviders(self):
|
|
self.algorithmTree.clear()
|
|
text = str(self.searchBox.text())
|
|
allAlgs = ModelerUtils.getAlgorithms()
|
|
for providerName in allAlgs.keys():
|
|
groups = {}
|
|
provider = allAlgs[providerName]
|
|
algs = provider.values()
|
|
#add algorithms
|
|
for alg in algs:
|
|
if not alg.showInModeler:
|
|
continue
|
|
if text == "" or text.lower() in alg.name.lower():
|
|
if alg.group in groups:
|
|
groupItem = groups[alg.group]
|
|
else:
|
|
groupItem = QTreeWidgetItem()
|
|
groupItem.setText(0, alg.group)
|
|
groupItem.setToolTip(0, alg.group)
|
|
groups[alg.group] = groupItem
|
|
algItem = TreeAlgorithmItem(alg)
|
|
groupItem.addChild(algItem)
|
|
|
|
if len(groups) > 0:
|
|
providerItem = QTreeWidgetItem()
|
|
providerItem.setText(0, Providers.providers[providerName].getDescription())
|
|
providerItem.setToolTip(0, Providers.providers[providerName].getDescription())
|
|
providerItem.setIcon(0, Providers.providers[providerName].getIcon())
|
|
for groupItem in groups.values():
|
|
providerItem.addChild(groupItem)
|
|
self.algorithmTree.addTopLevelItem(providerItem)
|
|
providerItem.setExpanded(text!="")
|
|
for groupItem in groups.values():
|
|
if text != "":
|
|
groupItem.setExpanded(True)
|
|
|
|
self.algorithmTree.sortItems(0, Qt.AscendingOrder)
|
|
|
|
class TreeAlgorithmItem(QTreeWidgetItem):
|
|
|
|
def __init__(self, alg):
|
|
useCategories = SextanteConfig.getSetting(SextanteConfig.USE_CATEGORIES)
|
|
QTreeWidgetItem.__init__(self)
|
|
self.alg = alg
|
|
icon = alg.getIcon()
|
|
name = alg.name
|
|
if useCategories:
|
|
icon = GeoAlgorithm.getDefaultIcon()
|
|
group, subgroup, name = AlgorithmDecorator.getGroupsAndName(alg)
|
|
self.setIcon(0, icon)
|
|
self.setToolTip(0, name)
|
|
self.setText(0, name)
|
|
|