1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
"""
***************************************************************************
GdalAlgorithm.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"
import os
import re
from typing import Dict
from qgis.PyQt.QtCore import QUrl, QCoreApplication
from qgis.core import (
QgsApplication,
QgsVectorFileWriter,
QgsProcessingFeatureSourceDefinition,
QgsProcessingAlgorithm,
QgsProcessingContext,
QgsProcessingFeedback,
QgsProviderRegistry,
QgsDataSourceUri,
)
from processing.algs.gdal.GdalAlgorithmDialog import GdalAlgorithmDialog
from processing.algs.gdal.GdalUtils import GdalUtils, GdalConnectionDetails
pluginPath = os.path.normpath(
os.path.join(os.path.split(os.path.dirname(__file__))[0], os.pardir)
)
class GdalAlgorithm(QgsProcessingAlgorithm):
def __init__(self):
super().__init__()
self.output_values = {}
def icon(self):
return QgsApplication.getThemeIcon("/providerGdal.svg")
def tags(self):
return ["ogr", "gdal", self.commandName()]
def svgIconPath(self):
return QgsApplication.iconPath("providerGdal.svg")
def createInstance(self, config={}):
return self.__class__()
def createCustomParametersWidget(self, parent):
return GdalAlgorithmDialog(self, parent=parent)
def getConsoleCommands(self, parameters, context, feedback, executing=True):
return None
def getOgrCompatibleSource(
self,
parameter_name: str,
parameters: dict,
context: QgsProcessingContext,
feedback: QgsProcessingFeedback,
executing: bool,
) -> GdalConnectionDetails:
"""
Interprets a parameter as a GDAL connection details
"""
if (
not executing
and parameter_name in parameters
and isinstance(
parameters[parameter_name], QgsProcessingFeatureSourceDefinition
)
):
# if not executing, then we throw away all 'selected features only' settings
# since these have no meaning for command line gdal use, and we don't want to force
# an export of selected features only to a temporary file just to show the command!
parameters = {parameter_name: parameters[parameter_name].source}
input_layer = self.parameterAsVectorLayer(parameters, parameter_name, context)
if input_layer is None or input_layer.providerType() in (
"memory",
"grass",
"virtual",
):
if executing:
# parameter is not a vector layer - try to convert to a source compatible with OGR
# and extract selection if required
ogr_data_path = self.parameterAsCompatibleSourceLayerPath(
parameters,
parameter_name,
context,
QgsVectorFileWriter.supportedFormatExtensions(),
QgsVectorFileWriter.supportedFormatExtensions()[0],
feedback=feedback,
)
return GdalConnectionDetails(
connection_string=ogr_data_path,
layer_name=GdalUtils.ogrLayerName(ogr_data_path),
geometry_column_name="geom",
)
else:
# not executing - don't waste time converting incompatible sources, just return dummy strings
# for the command preview (since the source isn't compatible with OGR, it has no meaning anyway and can't
# be run directly in the command line)
return GdalConnectionDetails(
connection_string="path_to_data_file",
layer_name="layer_name",
geometry_column_name="geom",
)
elif input_layer.providerType() == "ogr":
if (
executing
and (
isinstance(
parameters[parameter_name], QgsProcessingFeatureSourceDefinition
)
and parameters[parameter_name].selectedFeaturesOnly
)
or input_layer.subsetString()
):
# parameter is a vector layer, with OGR data provider
# so extract selection if required
ogr_data_path = self.parameterAsCompatibleSourceLayerPath(
parameters,
parameter_name,
context,
QgsVectorFileWriter.supportedFormatExtensions(),
feedback=feedback,
)
parts = QgsProviderRegistry.instance().decodeUri("ogr", ogr_data_path)
ogr_data_path = parts["path"]
if "layerName" in parts and parts["layerName"]:
ogr_layer_name = parts["layerName"]
else:
ogr_layer_name = GdalUtils.ogrLayerName(ogr_data_path)
return GdalConnectionDetails(
connection_string=ogr_data_path,
layer_name=ogr_layer_name,
open_options=parts.get("openOptions", None),
credential_options=parts.get("credentialOptions", None),
)
else:
# either not using the selection, or
# not executing - don't worry about 'selected features only' handling. It has no meaning
# for the command line preview since it has no meaning outside of a QGIS session!
connection_details = GdalUtils.gdal_connection_details_from_layer(
input_layer
)
connection_details.layer_name = GdalUtils.ogrLayerName(
input_layer.source()
)
return connection_details
elif input_layer.providerType().lower() == "wfs":
uri = QgsDataSourceUri(input_layer.source())
baseUrl = uri.param("url").split("?")[0]
return GdalConnectionDetails(
connection_string=f"WFS:{baseUrl}", layer_name=uri.param("typename")
)
# vector layer, but not OGR - get OGR compatible path
# TODO - handle "selected features only" mode!!
connection_details = GdalUtils.gdal_connection_details_from_layer(input_layer)
connection_details.layer_name = GdalUtils.ogrLayerName(input_layer.source())
return connection_details
def setOutputValue(self, name, value):
self.output_values[name] = value
def processAlgorithm(self, parameters, context, feedback):
commands = self.getConsoleCommands(
parameters, context, feedback, executing=True
)
GdalUtils.runGdal(commands, feedback)
# auto generate outputs
results = {}
for o in self.outputDefinitions():
if o.name() in parameters:
results[o.name()] = parameters[o.name()]
for k, v in self.output_values.items():
results[k] = v
return results
def commandName(self):
parameters = {param.name(): "1" for param in self.parameterDefinitions()}
context = QgsProcessingContext()
feedback = QgsProcessingFeedback()
name = self.getConsoleCommands(parameters, context, feedback, executing=False)[
0
]
if name.endswith(".py"):
name = name[:-3]
return name
def tr(self, string, context=""):
if context == "":
context = self.__class__.__name__
return QCoreApplication.translate(context, string)
|
