mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-06 00:05:02 -05:00
0c3cb558a8
GRASS GIS, in addition to importing data in its native formats via `r.in.gdal`/`v.in.ogr` (and likewise `r.import`/v.import`), also supports `r.external`/`v.external` which only link the data into the GRASS DB. Nevertheless, both `r.external` and `v.external` occasionally have problems, especially on windows. E.g.: - https://trac.osgeo.org/grass/ticket/3927 GRASS 7 Processing Plugin already has a setting that controls whether `v.external` is used (disabled by default). With this commit the complementary setting for `r.external` gets added too. Usage of `r.external` is disabled by default. This is changing the existing behavior, which was to use r`r.external`. The downsides of this change should be the somewhat lower import speed + higher disk usage. Nevertheless this way we have the same default value as `v.external` + we circumvent the `r.import/v.import` shortcomings.
184 lines
7.2 KiB
Python
184 lines
7.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
Grass7AlgorithmProvider.py
|
|
---------------------
|
|
Date : April 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__ = 'April 2014'
|
|
__copyright__ = '(C) 2014, Victor Olaya'
|
|
|
|
import os
|
|
from qgis.PyQt.QtCore import QCoreApplication
|
|
from qgis.core import (Qgis,
|
|
QgsApplication,
|
|
QgsProcessingProvider,
|
|
QgsVectorFileWriter,
|
|
QgsMessageLog,
|
|
QgsProcessingUtils)
|
|
from processing.core.ProcessingConfig import (ProcessingConfig, Setting)
|
|
from .Grass7Utils import Grass7Utils
|
|
from .Grass7Algorithm import Grass7Algorithm
|
|
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 Grass7AlgorithmProvider(QgsProcessingProvider):
|
|
|
|
descriptionFolder = Grass7Utils.grassDescriptionPath()
|
|
activateSetting = "ACTIVATE_GRASS7"
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
self.algs = []
|
|
|
|
def load(self):
|
|
ProcessingConfig.settingIcons[self.name()] = self.icon()
|
|
if self.activateSetting:
|
|
ProcessingConfig.addSetting(Setting(self.name(), self.activateSetting,
|
|
self.tr('Activate'), True))
|
|
if isMac():
|
|
ProcessingConfig.addSetting(Setting(
|
|
self.name(),
|
|
Grass7Utils.GRASS_FOLDER, self.tr('GRASS7 folder'),
|
|
Grass7Utils.grassPath(), valuetype=Setting.FOLDER))
|
|
ProcessingConfig.addSetting(Setting(
|
|
self.name(),
|
|
Grass7Utils.GRASS_LOG_COMMANDS,
|
|
self.tr('Log execution commands'), False))
|
|
ProcessingConfig.addSetting(Setting(
|
|
self.name(),
|
|
Grass7Utils.GRASS_LOG_CONSOLE,
|
|
self.tr('Log console output'), False))
|
|
ProcessingConfig.addSetting(Setting(
|
|
self.name(),
|
|
Grass7Utils.GRASS_HELP_PATH,
|
|
self.tr('Location of GRASS docs'),
|
|
Grass7Utils.grassHelpPath()))
|
|
# Add settings for using r.external/v.external instead of r.in.gdal/v.in.ogr
|
|
# but set them to False by default because the {r,v}.external implementations
|
|
# have some bugs on windows + there are algorithms that can't be used with
|
|
# external data (need a solid r.in.gdal/v.in.ogr).
|
|
# For more info have a look at e.g. https://trac.osgeo.org/grass/ticket/3927
|
|
ProcessingConfig.addSetting(Setting(
|
|
self.name(),
|
|
Grass7Utils.GRASS_USE_REXTERNAL,
|
|
self.tr('For raster layers, use r.external (faster) instead of r.in.gdal'),
|
|
False))
|
|
ProcessingConfig.addSetting(Setting(
|
|
self.name(),
|
|
Grass7Utils.GRASS_USE_VEXTERNAL,
|
|
self.tr('For vector layers, use v.external (faster) instead of v.in.ogr'),
|
|
False))
|
|
ProcessingConfig.readSettings()
|
|
self.refreshAlgorithms()
|
|
return True
|
|
|
|
def unload(self):
|
|
if self.activateSetting:
|
|
ProcessingConfig.removeSetting(self.activateSetting)
|
|
if isMac():
|
|
ProcessingConfig.removeSetting(Grass7Utils.GRASS_FOLDER)
|
|
ProcessingConfig.removeSetting(Grass7Utils.GRASS_LOG_COMMANDS)
|
|
ProcessingConfig.removeSetting(Grass7Utils.GRASS_LOG_CONSOLE)
|
|
ProcessingConfig.removeSetting(Grass7Utils.GRASS_HELP_PATH)
|
|
ProcessingConfig.removeSetting(Grass7Utils.GRASS_USE_REXTERNAL)
|
|
ProcessingConfig.removeSetting(Grass7Utils.GRASS_USE_VEXTERNAL)
|
|
|
|
def isActive(self):
|
|
if self.activateSetting:
|
|
return ProcessingConfig.getSetting(self.activateSetting)
|
|
return True
|
|
|
|
def setActive(self, active):
|
|
if self.activateSetting:
|
|
ProcessingConfig.setSettingValue(self.activateSetting, active)
|
|
|
|
def createAlgsList(self):
|
|
algs = []
|
|
folder = self.descriptionFolder
|
|
for descriptionFile in os.listdir(folder):
|
|
if descriptionFile.endswith('txt'):
|
|
try:
|
|
alg = Grass7Algorithm(os.path.join(folder, descriptionFile))
|
|
if alg.name().strip() != '':
|
|
algs.append(alg)
|
|
else:
|
|
QgsMessageLog.logMessage(self.tr('Could not open GRASS GIS 7 algorithm: {0}').format(descriptionFile), self.tr('Processing'), Qgis.Critical)
|
|
except Exception as e:
|
|
QgsMessageLog.logMessage(
|
|
self.tr('Could not open GRASS GIS 7 algorithm: {0}\n{1}').format(descriptionFile, str(e)), self.tr('Processing'), Qgis.Critical)
|
|
return algs
|
|
|
|
def loadAlgorithms(self):
|
|
self.algs = self.createAlgsList()
|
|
for a in self.algs:
|
|
self.addAlgorithm(a)
|
|
|
|
def name(self):
|
|
return 'GRASS'
|
|
|
|
def longName(self):
|
|
version = Grass7Utils.installedVersion()
|
|
return 'GRASS GIS ({})'.format(version) if version is not None else "GRASS GIS"
|
|
|
|
def id(self):
|
|
return 'grass7'
|
|
|
|
def helpId(self):
|
|
return 'grass7'
|
|
|
|
def icon(self):
|
|
return QgsApplication.getThemeIcon("/providerGrass.svg")
|
|
|
|
def svgIconPath(self):
|
|
return QgsApplication.iconPath("/providerGrass.svg")
|
|
|
|
def defaultVectorFileExtension(self, hasGeometry=True):
|
|
# By default,'gpkg', but if OGR has not been compiled with sqlite3, then
|
|
# we take "SHP"
|
|
if 'GPKG' in [o.driverName for o in
|
|
QgsVectorFileWriter.ogrDriverList()]:
|
|
return 'gpkg'
|
|
else:
|
|
return 'shp' if hasGeometry else 'dbf'
|
|
|
|
def supportsNonFileBasedOutput(self):
|
|
"""
|
|
GRASS7 Provider doesn't support non file based outputs
|
|
"""
|
|
return False
|
|
|
|
def supportedOutputVectorLayerExtensions(self):
|
|
# We use the same extensions than QGIS because:
|
|
# - QGIS is using OGR like GRASS
|
|
# - There are very chances than OGR version used in GRASS is
|
|
# different from QGIS OGR version.
|
|
return QgsVectorFileWriter.supportedFormatExtensions()
|
|
|
|
def supportedOutputRasterLayerExtensions(self):
|
|
return Grass7Utils.getSupportedOutputRasterExtensions()
|
|
|
|
def canBeActivated(self):
|
|
return not bool(Grass7Utils.checkGrassIsInstalled())
|
|
|
|
def tr(self, string, context=''):
|
|
if context == '':
|
|
context = 'Grass7AlgorithmProvider'
|
|
return QCoreApplication.translate(context, string)
|