-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
GrassUtils.py
344 lines (298 loc) · 14.4 KB
/
GrassUtils.py
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# -*- coding: utf-8 -*-
"""
***************************************************************************
GrassUtils.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$'
import os
from qgis.core import QgsApplication
from PyQt4.QtCore import *
import traceback
import subprocess
from sextante.tests.TestData import points
from sextante.core.SextanteConfig import SextanteConfig
from sextante.core.SextanteUtils import SextanteUtils, mkdir
from sextante.core.SextanteLog import SextanteLog
import stat
import shutil
class GrassUtils:
GRASS_REGION_XMIN = "GRASS_REGION_XMIN"
GRASS_REGION_YMIN = "GRASS_REGION_YMIN"
GRASS_REGION_XMAX = "GRASS_REGION_XMAX"
GRASS_REGION_YMAX = "GRASS_REGION_YMAX"
GRASS_REGION_CELLSIZE = "GRASS_REGION_CELLSIZE"
GRASS_FOLDER = "GRASS_FOLDER"
GRASS_WIN_SHELL = "GRASS_WIN_SHELL"
GRASS_LOG_COMMANDS = "GRASS_LOG_COMMANDS"
GRASS_LOG_CONSOLE = "GRASS_LOG_CONSOLE"
sessionRunning = False
sessionLayers = {}
projectionSet = False
@staticmethod
def grassBatchJobFilename():
'''This is used in linux. This is the batch job that we assign to
GRASS_BATCH_JOB and then call GRASS and let it do the work'''
filename = "grass_batch_job.sh"
batchfile = SextanteUtils.userFolder() + os.sep + filename
return batchfile
@staticmethod
def grassScriptFilename():
'''this is used in windows. We create a script that initializes
GRASS and then uses grass commands'''
filename = "grass_script.bat"
filename = SextanteUtils.userFolder() + os.sep + filename
return filename
@staticmethod
def grassPath():
if not SextanteUtils.isWindows() and not SextanteUtils.isMac():
return ""
folder = SextanteConfig.getSetting(GrassUtils.GRASS_FOLDER)
if folder == None:
if SextanteUtils.isWindows():
testfolder = os.path.dirname(str(QgsApplication.prefixPath()))
testfolder = os.path.join(testfolder, "grass")
if os.path.isdir(testfolder):
for subfolder in os.listdir(testfolder):
if subfolder.startswith("grass"):
folder = os.path.join(testfolder, subfolder)
break
else:
folder = os.path.join(str(QgsApplication.prefixPath()), "grass")
if not os.path.isdir(folder):
folder = "/Applications/GRASS-6.4.app/Contents/MacOS"
return folder
@staticmethod
def grassWinShell():
folder = SextanteConfig.getSetting(GrassUtils.GRASS_WIN_SHELL)
if folder == None:
folder = os.path.dirname(str(QgsApplication.prefixPath()))
folder = os.path.join(folder, "msys")
return folder
@staticmethod
def grassDescriptionPath():
return os.path.join(os.path.dirname(__file__), "description")
@staticmethod
def createGrassScript(commands):
folder = GrassUtils.grassPath()
shell = GrassUtils.grassWinShell()
script = GrassUtils.grassScriptFilename()
gisrc = SextanteUtils.userFolder() + os.sep + "sextante.gisrc"
#temporary gisrc file
output = open(gisrc, "w")
location = "temp_location"
gisdbase = GrassUtils.grassDataFolder()
#gisdbase = os.path.join(os.path.expanduser("~"), "sextante", "tempdata", "grassdata")
output.write("GISDBASE: " + gisdbase + "\n");
output.write("LOCATION_NAME: " + location + "\n");
output.write("MAPSET: PERMANENT \n");
output.write("GRASS_GUI: text\n");
output.close()
output=open(script, "w")
output.write("set HOME=" + os.path.expanduser("~") + "\n");
output.write("set GISRC=" + gisrc + "\n")
output.write("set GRASS_SH=" + shell + "\\bin\\sh.exe\n")
output.write("set PATH=" + shell + os.sep + "bin;" + shell + os.sep + "lib;" + "%PATH%\n")
output.write("set WINGISBASE=" + folder + "\n")
output.write("set GISBASE=" + folder + "\n");
output.write("set GRASS_PROJSHARE=" + folder + os.sep + "share" + os.sep + "proj" + "\n")
output.write("set GRASS_MESSAGE_FORMAT=gui\n")
#Replacement code for etc/Init.bat
output.write("if \"%GRASS_ADDON_PATH%\"==\"\" set PATH=%WINGISBASE%\\bin;%WINGISBASE%\\lib;%PATH%\n")
output.write("if not \"%GRASS_ADDON_PATH%\"==\"\" set PATH=%WINGISBASE%\\bin;%WINGISBASE%\\lib;%GRASS_ADDON_PATH%;%PATH%\n")
output.write("\n")
output.write("set GRASS_VERSION=" + GrassUtils.getGrassVersion() + "\n")
output.write("if not \"%LANG%\"==\"\" goto langset\n")
output.write("FOR /F \"usebackq delims==\" %%i IN (`\"%WINGISBASE%\\etc\\winlocale\"`) DO @set LANG=%%i\n")
output.write(":langset\n")
output.write("\n")
output.write("set PATHEXT=%PATHEXT%;.PY\n")
output.write("set PYTHONPATH=%PYTHONPATH%;%WINGISBASE%\\etc\\python;%WINGISBASE%\\etc\\wxpython\\n")
output.write("\n")
output.write("g.gisenv.exe set=\"MAPSET=PERMANENT\"\n")
output.write("g.gisenv.exe set=\"LOCATION=" + location + "\"\n")
output.write("g.gisenv.exe set=\"LOCATION_NAME=" + location + "\"\n")
output.write("g.gisenv.exe set=\"GISDBASE=" + gisdbase + "\"\n")
output.write("g.gisenv.exe set=\"GRASS_GUI=text\"\n")
for command in commands:
output.write(command + "\n")
output.write("\n");
output.write("exit\n");
output.close();
@staticmethod
def createGrassBatchJobFileFromGrassCommands(commands):
fout = open(GrassUtils.grassBatchJobFilename(), "w")
for command in commands:
fout.write(command + "\n")
fout.write("exit")
fout.close()
@staticmethod
def grassMapsetFolder():
folder = os.path.join(GrassUtils.grassDataFolder(), "temp_location")
mkdir(folder)
return folder
@staticmethod
def grassDataFolder():
tempfolder = os.path.join(SextanteUtils.tempFolder(), "grassdata")
mkdir(tempfolder)
return tempfolder
@staticmethod
def createTempMapset():
'''Creates a temporary location and mapset(s) for GRASS data processing. A minimal set of folders and files is created in the
system's default temporary directory. The settings files are written with sane defaults, so GRASS can do its work. The mapset
projection will be set later, based on the projection of the first input image or vector'''
folder = GrassUtils.grassMapsetFolder()
mkdir(os.path.join(folder, "PERMANENT"))
mkdir(os.path.join(folder, "PERMANENT", ".tmp"))
GrassUtils.writeGrassWindow(os.path.join(folder, "PERMANENT", "DEFAULT_WIND"));
outfile = open(os.path.join(folder, "PERMANENT", "MYNAME"), "w")
outfile.write("SEXTANTE GRASS interface: temporary data processing location.\n");
outfile.close();
GrassUtils.writeGrassWindow(os.path.join(folder, "PERMANENT", "WIND"))
mkdir(os.path.join(folder, "PERMANENT", "dbf"))
outfile = open(os.path.join(folder, "PERMANENT", "VAR"), "w")
outfile.write("DB_DRIVER: dbf\n")
outfile.write("DB_DATABASE: $GISDBASE/$LOCATION_NAME/$MAPSET/dbf/\n")
outfile.close()
@staticmethod
def writeGrassWindow(filename):
out = open(filename, "w")
out.write("proj: 0\n")
out.write("zone: 0\n")
out.write("north: 1\n")
out.write("south: 0\n")
out.write("east: 1\n")
out.write("west: 0\n")
out.write("cols: 1\n")
out.write("rows: 1\n")
out.write("e-w resol: 1\n")
out.write("n-s resol: 1\n")
out.write("top: 1\n")
out.write("bottom: 0\n")
out.write("cols3: 1\n")
out.write("rows3: 1\n")
out.write("depths: 1\n")
out.write("e-w resol3: 1\n")
out.write("n-s resol3: 1\n")
out.write("t-b resol: 1\n")
out.close()
@staticmethod
def prepareGrassExecution(commands):
if SextanteUtils.isWindows():
GrassUtils.createGrassScript(commands)
command = ["cmd.exe", "/C ", GrassUtils.grassScriptFilename()]
else:
gisrc = SextanteUtils.userFolder() + os.sep + "sextante.gisrc"
os.putenv("GISRC", gisrc)
os.putenv("GRASS_MESSAGE_FORMAT", "gui")
os.putenv("GRASS_BATCH_JOB", GrassUtils.grassBatchJobFilename())
GrassUtils.createGrassBatchJobFileFromGrassCommands(commands)
os.chmod(GrassUtils.grassBatchJobFilename(), stat.S_IEXEC | stat.S_IREAD | stat.S_IWRITE)
if SextanteUtils.isMac():
command = GrassUtils.grassPath() + os.sep + "grass.sh " + GrassUtils.grassMapsetFolder() + "/PERMANENT"
else:
command = "grass64 " + GrassUtils.grassMapsetFolder() + "/PERMANENT"
return command
@staticmethod
def executeGrass(commands, progress, outputCommands = None):
loglines = []
loglines.append("GRASS execution console output")
grassOutDone = False
command = GrassUtils.prepareGrassExecution(commands)
proc = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE,stderr=subprocess.STDOUT, universal_newlines=True).stdout
for line in iter(proc.readline, ""):
if "GRASS_INFO_PERCENT" in line:
try:
progress.setPercentage(int(line[len("GRASS_INFO_PERCENT")+ 2:]))
except:
pass
else:
if "r.out" in line or "v.out" in line:
grassOutDone = True
loglines.append(line)
progress.setConsoleInfo(line)
# Some GRASS scripts, like r.mapcalculator or r.fillnulls, call other GRASS scripts during execution. This may override any commands that are
# still to be executed by the subprocess, which are usually the output ones. If that is the case runs the output commands again.
if not grassOutDone and outputCommands:
command = GrassUtils.prepareGrassExecution(outputCommands)
proc = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE,stderr=subprocess.STDOUT, universal_newlines=True).stdout
for line in iter(proc.readline, ""):
if "GRASS_INFO_PERCENT" in line:
try:
progress.setPercentage(int(line[len("GRASS_INFO_PERCENT")+ 2:]))
except:
pass
else:
loglines.append(line)
progress.setConsoleInfo(line)
if SextanteConfig.getSetting(GrassUtils.GRASS_LOG_CONSOLE):
SextanteLog.addToLog(SextanteLog.LOG_INFO, loglines)
return loglines;
@staticmethod
def getGrassVersion():
#I do not know if this should be removed or let the user enter it
#or something like that... This is just a temporary thing
return "6.4.0"
# GRASS session is used to hold the layers already exported or produced in GRASS
# between multiple calls to GRASS algorithms. This way they don't have
# to be loaded multiple times and following algorithms can use the results
# of the previous ones.
# Starting a session just involves creating the temp mapset structure
@staticmethod
def startGrassSession():
if not GrassUtils.sessionRunning:
GrassUtils.createTempMapset()
GrassUtils.sessionRunning = True
# End session by removing the temporary GRASS mapset and all the layers.
@staticmethod
def endGrassSession():
shutil.rmtree(GrassUtils.grassMapsetFolder(), True)
GrassUtils.sessionRunning = False
GrassUtils.sessionLayers = {}
GrassUtils.projectionSet = False
@staticmethod
def getSessionLayers():
return GrassUtils.sessionLayers
@staticmethod
def addSessionLayers(exportedLayers):
GrassUtils.sessionLayers = dict(GrassUtils.sessionLayers.items() + exportedLayers.items())
@staticmethod
def checkGrassIsInstalled(ignoreRegistrySettings=False):
if SextanteUtils.isWindows():
path = GrassUtils.grassPath()
if path == "":
return "GRASS folder is not configured.\nPlease configure it before running SAGA algorithms."
cmdpath = os.path.join(path, "bin","r.out.gdal.exe")
if not os.path.exists(cmdpath):
return ("The specified GRASS folder does not contain a valid set of GRASS modules.\n"
+ "Please, go to the SEXTANTE settings dialog, and check that the GRASS\n"
+ "folder is correctly configured")
settings = QSettings()
GRASS_INSTALLED = "/SextanteQGIS/GrassInstalled"
if not ignoreRegistrySettings:
if settings.contains(GRASS_INSTALLED):
return
try:
from sextante import runalg
result = runalg("grass:v.voronoi", points(),False,False,"270778.60198,270855.745301,4458921.97814,4458983.8488",-1,0.0001, 0, None)
if not os.path.exists(result['output']):
return "It seems that GRASS is not correctly installed and configured in your system.\nPlease install it before running GRASS algorithms."
except:
s = traceback.format_exc()
return "Error while checking GRASS installation. GRASS might not be correctly configured.\n" + s;
settings.setValue(GRASS_INSTALLED, True)