#!/usr/bin/env python # -*- coding: utf-8 -*- """ *************************************************************************** AlgorithmExecutionDialog.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. * * * *************************************************************************** """ __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$' # -*- coding: latin-1 -*- from PyQt4.QtCore import * from PyQt4.QtGui import * from PyQt4 import QtCore, QtGui, QtWebKit from sextante.core.QGisLayers import QGisLayers from sextante.parameters.ParameterRaster import ParameterRaster from sextante.parameters.ParameterVector import ParameterVector from sextante.parameters.ParameterBoolean import ParameterBoolean from sextante.parameters.ParameterSelection import ParameterSelection from sextante.parameters.ParameterMultipleInput import ParameterMultipleInput from sextante.parameters.ParameterFixedTable import ParameterFixedTable from sextante.parameters.ParameterTableField import ParameterTableField from sextante.parameters.ParameterTable import ParameterTable from sextante.gui.AlgorithmExecutor import AlgorithmExecutor from sextante.core.SextanteLog import SextanteLog from sextante.gui.SextantePostprocessing import SextantePostprocessing from sextante.parameters.ParameterRange import ParameterRange from sextante.parameters.ParameterNumber import ParameterNumber from sextante.parameters.ParameterFile import ParameterFile from sextante.parameters.ParameterCrs import ParameterCrs from sextante.core.SextanteConfig import SextanteConfig from sextante.parameters.ParameterExtent import ParameterExtent from sextante.outputs.OutputHTML import OutputHTML from sextante.outputs.OutputRaster import OutputRaster from sextante.outputs.OutputVector import OutputVector from sextante.outputs.OutputTable import OutputTable from sextante.core.WrongHelpFileException import WrongHelpFileException import os from sextante.gui.UnthreadedAlgorithmExecutor import UnthreadedAlgorithmExecutor from sextante.parameters.ParameterString import ParameterString try: _fromUtf8 = QtCore.QString.fromUtf8 except AttributeError: _fromUtf8 = lambda s: s class AlgorithmExecutionDialog(QtGui.QDialog): class InvalidParameterValue(Exception): def __init__(self, param, widget): self.parameter, self.widget = param, widget '''Base class for dialogs that execute algorithms''' def __init__(self, alg, mainWidget): QtGui.QDialog.__init__(self, None, QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowTitleHint) self.executed = False self.mainWidget = mainWidget self.alg = alg self.resize(650, 450) self.buttonBox = QtGui.QDialogButtonBox() self.buttonBox.setOrientation(QtCore.Qt.Horizontal) self.buttonBox.setStandardButtons( QtGui.QDialogButtonBox.Cancel|QtGui.QDialogButtonBox.Close|QtGui.QDialogButtonBox.Ok) self.buttonBox.button(QtGui.QDialogButtonBox.Cancel).setEnabled(False) self.scrollArea = QtGui.QScrollArea() if self.mainWidget: self.scrollArea.setWidget(self.mainWidget) self.scrollArea.setWidgetResizable(True) self.setWindowTitle(self.alg.name) self.progressLabel = QtGui.QLabel() self.progress = QtGui.QProgressBar() self.progress.setMinimum(0) self.progress.setMaximum(100) self.progress.setValue(0) self.verticalLayout = QtGui.QVBoxLayout(self) self.verticalLayout.setSpacing(2) self.verticalLayout.setMargin(0) self.tabWidget = QtGui.QTabWidget() self.tabWidget.setMinimumWidth(300) self.tabWidget.addTab(self.scrollArea, "Parameters") self.verticalLayout.addWidget(self.tabWidget) self.logText = QTextEdit() self.logText.readOnly = True useThreads = SextanteConfig.getSetting(SextanteConfig.USE_THREADS) keepOpen = SextanteConfig.getSetting(SextanteConfig.KEEP_DIALOG_OPEN) if useThreads or keepOpen: self.tabWidget.addTab(self.logText, "Log") self.webView = QtWebKit.QWebView() cssUrl = QtCore.QUrl(os.path.join(os.path.dirname(__file__), "help", "help.css")) self.webView.settings().setUserStyleSheetUrl(cssUrl) html = None try: if self.alg.helpFile(): helpFile = self.alg.helpFile() else: html = "

Sorry, no help is available for this algorithm.

" except WrongHelpFileException, e: html = e.msg self.webView.setHtml("

Could not open help file :-(

") try: if html: self.webView.setHtml(html) else: url = QtCore.QUrl(helpFile) self.webView.load(url) except: self.webView.setHtml("

Could not open help file :-(

") self.tabWidget.addTab(self.webView, "Help") self.verticalLayout.addWidget(self.progressLabel) self.verticalLayout.addWidget(self.progress) self.verticalLayout.addWidget(self.buttonBox) self.setLayout(self.verticalLayout) self.buttonBox.accepted.connect(self.accept) self.buttonBox.rejected.connect(self.close) self.buttonBox.button(QtGui.QDialogButtonBox.Cancel).clicked.connect(self.cancel) #~ QtCore.QMetaObject.connectSlotsByName(self) def setParamValues(self): params = self.alg.parameters outputs = self.alg.outputs for param in params: if param.hidden: continue if isinstance(param, ParameterExtent): continue if not self.setParamValue(param, self.paramTable.valueItems[param.name]): raise AlgorithmExecutionDialog.InvalidParameterValue(param, self.paramTable.valueItems[param.name]) for param in params: if isinstance(param, ParameterExtent): value = self.paramTable.valueItems[param.name].getValue() if value is not None: param.value = value else: raise AlgorithmExecutionDialog.InvalidParameterValue(param, self.paramTable.valueItems[param.name]) for output in outputs: if output.hidden: continue output.value = self.paramTable.valueItems[output.name].getValue() if not SextanteConfig.getSetting(SextanteConfig.TABLE_LIKE_PARAM_PANEL): if isinstance(output, (OutputRaster, OutputVector, OutputTable, OutputHTML)): output.open = self.paramTable.checkBoxes[output.name].isChecked() return True def setParamValue(self, param, widget): if isinstance(param, ParameterRaster): return param.setValue(widget.getValue()) elif isinstance(param, (ParameterVector, ParameterTable)): try: return param.setValue(widget.itemData(widget.currentIndex()).toPyObject()) except: return param.setValue(widget.getValue()) elif isinstance(param, ParameterBoolean): return param.setValue(widget.currentIndex() == 0) elif isinstance(param, ParameterSelection): return param.setValue(widget.currentIndex()) elif isinstance(param, ParameterFixedTable): return param.setValue(widget.table) elif isinstance(param, ParameterRange): return param.setValue(widget.getValue()) if isinstance(param, ParameterTableField): return param.setValue(widget.currentText()) elif isinstance(param, ParameterMultipleInput): if param.datatype == ParameterMultipleInput.TYPE_VECTOR_ANY: options = QGisLayers.getVectorLayers() else: options = QGisLayers.getRasterLayers() value = [] for index in widget.selectedoptions: value.append(options[index]) return param.setValue(value) elif isinstance(param, (ParameterNumber, ParameterFile, ParameterCrs, ParameterExtent)): return param.setValue(widget.getValue()) elif isinstance(param, ParameterString): if param.multiline: return param.setValue(unicode(widget.toPlainText())) else: return param.setValue(unicode(widget.text())) else: return param.setValue(unicode(widget.text())) @pyqtSlot() def accept(self): keepOpen = SextanteConfig.getSetting(SextanteConfig.KEEP_DIALOG_OPEN) useThread = SextanteConfig.getSetting(SextanteConfig.USE_THREADS) try: self.setParamValues() msg = self.alg.checkParameterValuesBeforeExecuting() if msg: if keepOpen or useThread: self.setInfo("Unable to execute algorithm: %s" % msg, True) self.tabWidget.setCurrentIndex(1) # log tab else: QMessageBox.critical(self, "Unable to execute algorithm", msg) return self.buttonBox.button(QtGui.QDialogButtonBox.Ok).setEnabled(False) self.buttonBox.button(QtGui.QDialogButtonBox.Close).setEnabled(False) buttons = self.paramTable.iterateButtons iterateParam = None for i in range(len(buttons.values())): button = buttons.values()[i] if button.isChecked(): iterateParam = buttons.keys()[i] break self.progress.setMaximum(0) self.progressLabel.setText("Processing algorithm...") QApplication.setOverrideCursor(QCursor(Qt.WaitCursor)) if useThread: if iterateParam: self.algEx = AlgorithmExecutor(self.alg, iterateParam) else: command = self.alg.getAsCommand() if command: SextanteLog.addToLog(SextanteLog.LOG_ALGORITHM, command) self.algEx = AlgorithmExecutor(self.alg) self.algEx.finished.connect(self.finish) self.algEx.error.connect(self.error) self.algEx.percentageChanged.connect(self.setPercentage) self.algEx.textChanged.connect(self.setText) self.algEx.iterated.connect(self.iterate) self.algEx.infoSet.connect(self.setInfo) if SextanteConfig.getSetting(SextanteConfig.SHOW_DEBUG_IN_DIALOG): self.algEx.commandSet.connect(self.setCommand) self.algEx.debugInfoSet.connect(self.setDebugInfo) self.algEx.consoleInfoSet.connect(self.setConsoleInfo) self.algEx.start() self.setInfo("Algorithm %s started" % self.alg.name) self.buttonBox.button(QtGui.QDialogButtonBox.Cancel).setEnabled(True) else: self.setInfo("Algorithm %s starting..." % self.alg.name) if iterateParam: UnthreadedAlgorithmExecutor.runalgIterating(self.alg, iterateParam, self) else: command = self.alg.getAsCommand() if command: SextanteLog.addToLog(SextanteLog.LOG_ALGORITHM, command) if UnthreadedAlgorithmExecutor.runalg(self.alg, self): self.finish() else: QApplication.restoreOverrideCursor() if not keepOpen: self.close() else: self.resetGUI() self.tabWidget.setCurrentIndex(1) # log tab except AlgorithmExecutionDialog.InvalidParameterValue as ex: try: self.buttonBox.accepted.connect(lambda: ex.widget.setPalette(QPalette())) palette = ex.widget.palette() palette.setColor(QPalette.Base, QColor(255, 255, 0)) ex.widget.setPalette(palette) self.progressLabel.setText("Missing parameter value") return except: QMessageBox.critical(self, "Unable to execute algorithm", "Wrong or missing parameter values") @pyqtSlot() def finish(self): keepOpen = SextanteConfig.getSetting(SextanteConfig.KEEP_DIALOG_OPEN) SextantePostprocessing.handleAlgorithmResults(self.alg, not keepOpen) self.executed = True self.setInfo("Algorithm %s finished" % self.alg.name) QApplication.restoreOverrideCursor() if not keepOpen: self.close() else: self.resetGUI() @pyqtSlot(str) def error(self, msg): QApplication.restoreOverrideCursor() keepOpen = SextanteConfig.getSetting(SextanteConfig.KEEP_DIALOG_OPEN) self.setInfo(msg, True) self.algEx.finished.disconnect() if not keepOpen: QMessageBox.critical(self, "Error", msg) self.close() else: self.resetGUI() self.setInfo(msg, True) self.tabWidget.setCurrentIndex(1) # log tab @pyqtSlot(int) def iterate(self, i): self.setInfo("Algorithm %s iteration #%i completed" % (self.alg.name, i)) @pyqtSlot() def cancel(self): self.setInfo("Algorithm %s canceled" % self.alg.name) try: self.algEx.finished.disconnect() self.algEx.terminate() except: pass self.resetGUI() def resetGUI(self): QApplication.restoreOverrideCursor() self.progressLabel.setText("") self.progress.setValue(0) self.progress.setMaximum(100) self.buttonBox.button(QtGui.QDialogButtonBox.Ok).setEnabled(True) self.buttonBox.button(QtGui.QDialogButtonBox.Close).setEnabled(True) self.buttonBox.button(QtGui.QDialogButtonBox.Cancel).setEnabled(False) @pyqtSlot(str) @pyqtSlot(str, bool) def setInfo(self, msg, error = False): if error: self.logText.append('' + msg + '') else: self.logText.append(msg) @pyqtSlot(str) def setCommand(self, cmd): self.setInfo('' + cmd + '') @pyqtSlot(str) def setDebugInfo(self, msg): self.setInfo('' + msg + '') @pyqtSlot(str) def setConsoleInfo(self, msg): self.setCommand('' + msg + '') def setPercentage(self, i): if self.progress.maximum() == 0: self.progress.setMaximum(100) self.progress.setValue(i) def setText(self, text): self.progressLabel.setText(text) self.setInfo(text, False)