mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-24 00:06:24 -04:00
bb24dfe245
Nothing particularly exciting here yet, but this commit moves the definition of the provider base class to a c++ QgsProcessingProvider abstract base class. As part of this some existing python methods were renamed to make their use clearer and to fit with the QGIS c++ api conventions: - getName was renamed to id - getDescription was renamed to name - getIcon was renamed to icon These API breaks are documented
141 lines
6.0 KiB
Python
141 lines
6.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
SagaAlgorithmProvider.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 builtins import str
|
|
|
|
__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$'
|
|
|
|
import os
|
|
from qgis.PyQt.QtGui import QIcon
|
|
from processing.core.AlgorithmProvider import AlgorithmProvider
|
|
from processing.core.ProcessingConfig import ProcessingConfig, Setting
|
|
from processing.core.ProcessingLog import ProcessingLog
|
|
from .SagaAlgorithm212 import SagaAlgorithm212
|
|
from .SagaAlgorithm213 import SagaAlgorithm213
|
|
from .SagaAlgorithm214 import SagaAlgorithm214
|
|
from .SplitRGBBands import SplitRGBBands
|
|
from . import SagaUtils
|
|
from processing.tools.system import isWindows, isMac
|
|
|
|
|
|
pluginPath = os.path.normpath(os.path.join(
|
|
os.path.split(os.path.dirname(__file__))[0], os.pardir))
|
|
|
|
|
|
class SagaAlgorithmProvider(AlgorithmProvider):
|
|
|
|
supportedVersions = {"2.1.2": ("2.1.2", SagaAlgorithm212),
|
|
"2.1.3": ("2.1.3", SagaAlgorithm213),
|
|
"2.1.4": ("2.1.4", SagaAlgorithm214),
|
|
"2.2.0": ("2.2.0", SagaAlgorithm214),
|
|
"2.2.1": ("2.2.0", SagaAlgorithm214),
|
|
"2.2.2": ("2.2.2", SagaAlgorithm214),
|
|
"2.2.3": ("2.2.3", SagaAlgorithm214)}
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
self.activate = True
|
|
|
|
def initializeSettings(self):
|
|
if (isWindows() or isMac()):
|
|
ProcessingConfig.addSetting(Setting("SAGA",
|
|
SagaUtils.SAGA_FOLDER, self.tr('SAGA folder'),
|
|
'',
|
|
valuetype=Setting.FOLDER))
|
|
ProcessingConfig.addSetting(Setting("SAGA",
|
|
SagaUtils.SAGA_IMPORT_EXPORT_OPTIMIZATION,
|
|
self.tr('Enable SAGA Import/Export optimizations'), False))
|
|
ProcessingConfig.addSetting(Setting("SAGA",
|
|
SagaUtils.SAGA_LOG_COMMANDS,
|
|
self.tr('Log execution commands'), True))
|
|
ProcessingConfig.addSetting(Setting("SAGA",
|
|
SagaUtils.SAGA_LOG_CONSOLE,
|
|
self.tr('Log console output'), True))
|
|
ProcessingConfig.settingIcons["SAGA"] = self.icon()
|
|
ProcessingConfig.addSetting(Setting("SAGA", "ACTIVATE_SAGA",
|
|
self.tr('Activate'), self.activate))
|
|
|
|
def unload(self):
|
|
AlgorithmProvider.unload(self)
|
|
if (isWindows() or isMac()):
|
|
ProcessingConfig.removeSetting(SagaUtils.SAGA_FOLDER)
|
|
|
|
ProcessingConfig.removeSetting(SagaUtils.SAGA_LOG_CONSOLE)
|
|
ProcessingConfig.removeSetting(SagaUtils.SAGA_LOG_COMMANDS)
|
|
|
|
def _loadAlgorithms(self):
|
|
self.algs = []
|
|
version = SagaUtils.getInstalledVersion(True)
|
|
if version is None:
|
|
ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
|
|
self.tr('Problem with SAGA installation: SAGA was not found or is not correctly installed'))
|
|
return
|
|
if version not in self.supportedVersions:
|
|
lastVersion = sorted(self.supportedVersions.keys())[-1]
|
|
if version > lastVersion:
|
|
version = lastVersion
|
|
else:
|
|
ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
|
|
self.tr('Problem with SAGA installation: installed SAGA version (%s) is not supported' % version))
|
|
return
|
|
|
|
folder = SagaUtils.sagaDescriptionPath()
|
|
folder = os.path.join(folder, self.supportedVersions[version][0])
|
|
for descriptionFile in os.listdir(folder):
|
|
if descriptionFile.endswith('txt'):
|
|
f = os.path.join(folder, descriptionFile)
|
|
self._loadAlgorithm(f, version)
|
|
self.algs.append(SplitRGBBands())
|
|
|
|
def _loadAlgorithm(self, descriptionFile, version):
|
|
try:
|
|
alg = self.supportedVersions[version][1](descriptionFile)
|
|
if alg.name.strip() != '':
|
|
self.algs.append(alg)
|
|
else:
|
|
ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
|
|
self.tr('Could not open SAGA algorithm: %s' % descriptionFile))
|
|
except Exception as e:
|
|
ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
|
|
self.tr('Could not open SAGA algorithm: %s\n%s' % (descriptionFile, str(e))))
|
|
|
|
def name(self):
|
|
version = SagaUtils.getInstalledVersion()
|
|
return 'SAGA ({})'.format(version) if version is not None else 'SAGA'
|
|
|
|
def id(self):
|
|
return 'saga'
|
|
|
|
def getSupportedOutputVectorLayerExtensions(self):
|
|
return ['shp']
|
|
|
|
def getSupportedOutputRasterLayerExtensions(self):
|
|
return ['sdat']
|
|
|
|
def getSupportedOutputTableLayerExtensions(self):
|
|
return ['dbf']
|
|
|
|
def icon(self):
|
|
return QIcon(os.path.join(pluginPath, 'images', 'saga.png'))
|