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
|
# -*- coding: utf-8 -*-
"""
***************************************************************************
SagaUtils.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
import stat
import traceback
import subprocess
from PyQt4.QtCore import *
from qgis.core import *
from processing.core.ProcessingConfig import ProcessingConfig
from processing.core.ProcessingLog import ProcessingLog
from processing.tools.system import *
from processing.tests.TestData import polygons
class SagaUtils:
SAGA_208 = 'SAGA_208'
SAGA_LOG_COMMANDS = 'SAGA_LOG_COMMANDS'
SAGA_LOG_CONSOLE = 'SAGA_LOG_CONSOLE'
SAGA_FOLDER = 'SAGA_FOLDER'
SAGA_IMPORT_EXPORT_OPTIMIZATION = 'SAGA_IMPORT_EXPORT_OPTIMIZATION'
isSagaInstalled = False
@staticmethod
def sagaBatchJobFilename():
if isWindows():
filename = 'saga_batch_job.bat'
else:
filename = 'saga_batch_job.sh'
batchfile = userFolder() + os.sep + filename
return batchfile
@staticmethod
def findSagaFolder():
folder = None
if isMac():
testfolder = os.path.join(QgsApplication.prefixPath(), 'bin')
if os.path.exists(os.path.join(testfolder, 'saga_cmd')):
folder = testfolder
else:
testfolder = '/usr/local/bin'
if os.path.exists(os.path.join(testfolder, 'saga_cmd')):
folder = testfolder
elif isWindows():
testfolder = os.path.join(os.path.dirname(QgsApplication.prefixPath()), 'saga')
if os.path.exists(os.path.join(testfolder, 'saga_cmd.exe')):
folder = testfolder
return folder
@staticmethod
def sagaPath():
folder = SagaUtils.findSagaFolder()
if folder is None:
folder = ProcessingConfig.getSetting(SagaUtils.SAGA_FOLDER)
return folder or ''
@staticmethod
def isSaga208():
if SagaUtils.findSagaFolder() is not None:
return not isMac();
else:
return ProcessingConfig.getSetting(SagaUtils.SAGA_208)
@staticmethod
def sagaDescriptionPath():
return os.path.join(os.path.dirname(__file__), 'description')
@staticmethod
def createSagaBatchJobFileFromSagaCommands(commands):
fout = open(SagaUtils.sagaBatchJobFilename(), 'w')
if isWindows():
fout.write('set SAGA=' + SagaUtils.sagaPath() + '\n')
fout.write('set SAGA_MLB=' + SagaUtils.sagaPath() + os.sep
+ 'modules' + '\n')
fout.write('PATH=PATH;%SAGA%;%SAGA_MLB%\n')
elif isMac():
fout.write('export SAGA_MLB=' + SagaUtils.sagaPath()
+ '/../lib/saga\n')
fout.write('export PATH=' + SagaUtils.sagaPath() + ':$PATH\n')
else:
pass
for command in commands:
fout.write('saga_cmd ' + command.encode('utf8') + '\n')
fout.write('exit')
fout.close()
@staticmethod
def executeSaga(progress):
if isWindows():
command = ['cmd.exe', '/C ', SagaUtils.sagaBatchJobFilename()]
else:
os.chmod(SagaUtils.sagaBatchJobFilename(), stat.S_IEXEC
| stat.S_IREAD | stat.S_IWRITE)
command = [SagaUtils.sagaBatchJobFilename()]
loglines = []
loglines.append('SAGA execution console output')
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 '%' in line:
s = ''.join([x for x in line if x.isdigit()])
try:
progress.setPercentage(int(s))
except:
pass
else:
line = line.strip()
if line != '/' and line != '-' and line != '\\' and line \
!= '|':
loglines.append(line)
progress.setConsoleInfo(line)
if ProcessingConfig.getSetting(SagaUtils.SAGA_LOG_CONSOLE):
ProcessingLog.addToLog(ProcessingLog.LOG_INFO, loglines)
@staticmethod
def checkSagaIsInstalled(ignorePreviousState=False):
if isWindows():
path = SagaUtils.sagaPath()
if path == '':
return 'SAGA folder is not configured.\nPlease configure it \
before running SAGA algorithms.'
cmdpath = os.path.join(path, 'saga_cmd.exe')
if not os.path.exists(cmdpath):
return 'The specified SAGA folder does not contain a valid \
SAGA executable.\n' \
+ 'Please, go to the processing settings dialog, and \
check that the SAGA\n' \
+ 'folder is correctly configured'
if not ignorePreviousState:
if SagaUtils.isSagaInstalled:
return
try:
from processing import runalg
result = runalg('saga:polygoncentroids', polygons(), 0, None)
if result is None or not os.path.exists(result['CENTROIDS']):
return 'It seems that SAGA is not correctly installed in \
your system.\nPlease install it before running SAGA \
algorithms.'
except:
s = traceback.format_exc()
return 'Error while checking SAGA installation. SAGA might not \
be correctly configured.\n' + s
SagaUtils.isSagaInstalled = True
|