[processing] improved version detection mechanism for OTB

Author: volaya

python/plugins/processing/algs/otb/OTBAlgorithm.py

@@ -43,7 +43,7 @@
 from processing.core.ProcessingLog import ProcessingLog
 from processing.core.parameters import getParameterFromString
 from processing.core.outputs import getOutputFromString
-from OTBUtils import OTBUtils
+import OTBUtils
 from processing.core.parameters import ParameterExtent
 from processing.tools.system import getTempFilename
 import xml.etree.ElementTree as ET
@@ -77,12 +77,16 @@ def getIcon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'otb.png'))
 
     def help(self):
-        folder = os.path.join(OTBUtils.otbDescriptionPath(), 'doc')
+        version = OTBUtils.getInstalledVersion()
+        folder = OTBUtils.compatibleDescriptionPath(version)
+        if folder is None:
+            return False, None
+        folder = os.path.join(folder,  'doc')
         helpfile = os.path.join(unicode(folder), self.appkey + ".html")
         if os.path.exists(helpfile):
             return False, helpfile
         else:
-            raise False
+            return False, None
 
     def adapt_list_to_string(self, c_list):
         a_list = c_list[1:]
@@ -166,16 +170,9 @@ def defineCharacteristicsFromFile(self):
                                        self.tr('Could not open OTB algorithm: %s\n%s' % (self.descriptionFile, line)))
                 raise e
 
-    def checkBeforeOpeningParametersDialog(self):
-        return OTBUtils.checkOtbConfiguration()
-
     def processAlgorithm(self, progress):
         currentOs = os.name
 
-        msg = OTBUtils.checkOtbConfiguration()
-        if msg:
-            raise GeoAlgorithmExecutionException(msg)
-
         path = OTBUtils.otbPath()
 
         commands = []

python/plugins/processing/algs/otb/OTBAlgorithmProvider.py

@@ -32,7 +32,7 @@
 from PyQt4.QtGui import QIcon
 from processing.core.AlgorithmProvider import AlgorithmProvider
 from processing.core.ProcessingConfig import ProcessingConfig, Setting
-from OTBUtils import OTBUtils
+import OTBUtils
 from OTBAlgorithm import OTBAlgorithm
 from processing.core.ProcessingLog import ProcessingLog
 
@@ -45,7 +45,6 @@ class OTBAlgorithmProvider(AlgorithmProvider):
     def __init__(self):
         AlgorithmProvider.__init__(self)
         self.activate = True
-        self.createAlgsList()
 
     def getDescription(self):
         return self.tr("Orfeo Toolbox (Image analysis)")
@@ -57,18 +56,29 @@ def getIcon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'otb.png'))
 
     def _loadAlgorithms(self):
-        self.algs = self.preloadedAlgs
+        self.algs = []
+
+        version = OTBUtils.getInstalledVersion(True)
+        if version is None:
+            ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
+                                   self.tr('Problem with OTB installation: OTB was not found or is not correctly installed'))
+            return
+
+        folder = OTBUtils.compatibleDescriptionPath(version)
+        if folder is None:
+            ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
+                                    self.tr('Problem with OTB installation: installed OTB version (%s) is not supported' % version))
+            return
+
+
 
-    def createAlgsList(self):
-        self.preloadedAlgs = []
-        folder = OTBUtils.otbDescriptionPath()
         for descriptionFile in os.listdir(folder):
             if descriptionFile.endswith("xml"):
                 try:
                     alg = OTBAlgorithm(os.path.join(folder, descriptionFile))
 
                     if alg.name.strip() != "":
-                        self.preloadedAlgs.append(alg)
+                        self.algs.append(alg)
                     else:
                         ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
                                                self.tr("Could not open OTB algorithm: %s" % descriptionFile))
@@ -102,5 +112,3 @@ def unload(self):
         ProcessingConfig.removeSetting(OTBUtils.OTB_FOLDER)
         ProcessingConfig.removeSetting(OTBUtils.OTB_LIB_FOLDER)
 
-    def canBeActivated(self):
-        return not bool(OTBUtils.checkOtbConfiguration())

python/plugins/processing/algs/otb/OTBSpecific_XMLLoading.py

@@ -44,7 +44,7 @@
 
 from processing.core.ProcessingConfig import ProcessingConfig
 
-from OTBUtils import OTBUtils
+import OTBUtils
 
 
 def adaptBinaryMorphologicalOperation(commands_list):

python/plugins/processing/algs/otb/OTBUtils.py

@@ -39,125 +39,151 @@
 import logging
 import xml.etree.ElementTree as ET
 import traceback
+from processing.gui.SilentProgress import SilentProgress
 
 
-class OTBUtils:
+OTB_FOLDER = "OTB_FOLDER"
+OTB_LIB_FOLDER = "OTB_LIB_FOLDER"
+OTB_SRTM_FOLDER = "OTB_SRTM_FOLDER"
+OTB_GEOID_FILE = "OTB_GEOID_FILE"
 
-    OTB_FOLDER = "OTB_FOLDER"
-    OTB_LIB_FOLDER = "OTB_LIB_FOLDER"
-    OTB_SRTM_FOLDER = "OTB_SRTM_FOLDER"
-    OTB_GEOID_FILE = "OTB_GEOID_FILE"
 
-    @staticmethod
-    def findOtbPath():
-        folder = None
-        #try to configure the path automatically
-        if isMac():
-            testfolder = os.path.join(unicode(QgsApplication.prefixPath()), "bin")
-            if os.path.exists(os.path.join(testfolder, "otbcli")):
-                folder = testfolder
-            else:
-                testfolder = "/usr/local/bin"
-                if os.path.exists(os.path.join(testfolder, "otbcli")):
-                    folder = testfolder
-        elif isWindows():
-            testfolder = os.path.join(os.path.dirname(QgsApplication.prefixPath()),
-                                      os.pardir, "bin")
-            if os.path.exists(os.path.join(testfolder, "otbcli.bat")):
-                folder = testfolder
+def findOtbPath():
+    folder = None
+    #try to configure the path automatically
+    if isMac():
+        testfolder = os.path.join(unicode(QgsApplication.prefixPath()), "bin")
+        if os.path.exists(os.path.join(testfolder, "otbcli")):
+            folder = testfolder
         else:
-            testfolder = "/usr/bin"
+            testfolder = "/usr/local/bin"
             if os.path.exists(os.path.join(testfolder, "otbcli")):
                 folder = testfolder
-        return folder
-
-    @staticmethod
-    def otbPath():
-        folder = OTBUtils.findOtbPath()
-        if folder is None:
-            folder = ProcessingConfig.getSetting(OTBUtils.OTB_FOLDER)
-        return folder
-
-    @staticmethod
-    def findOtbLibPath():
-        folder = None
-        #try to configure the path automatically
-        if isMac():
-            testfolder = os.path.join(unicode(QgsApplication.prefixPath()), "lib/otb/applications")
-            if os.path.exists(testfolder):
-                folder = testfolder
-            else:
-                testfolder = "/usr/local/lib/otb/applications"
-                if os.path.exists(testfolder):
-                    folder = testfolder
-        elif isWindows():
-            testfolder = os.path.join(os.path.dirname(QgsApplication.prefixPath()), "orfeotoolbox", "applications")
-            if os.path.exists(testfolder):
-                folder = testfolder
+    elif isWindows():
+        testfolder = os.path.join(os.path.dirname(QgsApplication.prefixPath()),
+                                  os.pardir, "bin")
+        if os.path.exists(os.path.join(testfolder, "otbcli.bat")):
+            folder = testfolder
+    else:
+        testfolder = "/usr/bin"
+        if os.path.exists(os.path.join(testfolder, "otbcli")):
+            folder = testfolder
+    return folder
+
+
+def otbPath():
+    folder = findOtbPath()
+    if folder is None:
+        folder = ProcessingConfig.getSetting(OTB_FOLDER)
+    return folder
+
+
+def findOtbLibPath():
+    folder = None
+    #try to configure the path automatically
+    if isMac():
+        testfolder = os.path.join(unicode(QgsApplication.prefixPath()), "lib/otb/applications")
+        if os.path.exists(testfolder):
+            folder = testfolder
         else:
-            testfolder = "/usr/lib/otb/applications"
+            testfolder = "/usr/local/lib/otb/applications"
             if os.path.exists(testfolder):
                 folder = testfolder
-        return folder
-
-    @staticmethod
-    def otbLibPath():
-        folder = OTBUtils.findOtbLibPath()
-        if folder is None:
-            folder = ProcessingConfig.getSetting(OTBUtils.OTB_LIB_FOLDER)
-        return folder
-
-    @staticmethod
-    def otbSRTMPath():
-        folder = ProcessingConfig.getSetting(OTBUtils.OTB_SRTM_FOLDER)
-        if folder is None:
-            folder = ""
-        return folder
-
-    @staticmethod
-    def otbGeoidPath():
-        filepath = ProcessingConfig.getSetting(OTBUtils.OTB_GEOID_FILE)
-        if filepath is None:
-            filepath = ""
-        return filepath
-
-    @staticmethod
-    def otbDescriptionPath():
-        return os.path.join(os.path.dirname(__file__), "description")
-
-    @staticmethod
-    def executeOtb(commands, progress):
-        loglines = []
-        loglines.append(OTBUtils.tr("OTB execution console output"))
-        os.putenv('ITK_AUTOLOAD_PATH', OTBUtils.otbLibPath())
-        fused_command = ''.join(['"%s" ' % re.sub(r'^"|"$', '', c) for c in commands])
-        proc = subprocess.Popen(fused_command, shell=True, stdout=subprocess.PIPE, stdin=open(os.devnull), stderr=subprocess.STDOUT, universal_newlines=True).stdout
-        for line in iter(proc.readline, ""):
-            if "[*" in line:
-                idx = line.find("[*")
-                perc = int(line[idx - 4:idx - 2].strip(" "))
-                if perc != 0:
-                    progress.setPercentage(perc)
-            else:
-                loglines.append(line)
-                progress.setConsoleInfo(line)
+    elif isWindows():
+        testfolder = os.path.join(os.path.dirname(QgsApplication.prefixPath()), "orfeotoolbox", "applications")
+        if os.path.exists(testfolder):
+            folder = testfolder
+    else:
+        testfolder = "/usr/lib/otb/applications"
+        if os.path.exists(testfolder):
+            folder = testfolder
+    return folder
+
+
+def otbLibPath():
+    folder = findOtbLibPath()
+    if folder is None:
+        folder = ProcessingConfig.getSetting(OTB_LIB_FOLDER)
+    return folder
+
+
+def otbSRTMPath():
+    folder = ProcessingConfig.getSetting(OTB_SRTM_FOLDER)
+    if folder is None:
+        folder = ""
+    return folder
+
+
+def otbGeoidPath():
+    filepath = ProcessingConfig.getSetting(OTB_GEOID_FILE)
+    if filepath is None:
+        filepath = ""
+    return filepath
+
+
+def otbDescriptionPath():
+    return os.path.join(os.path.dirname(__file__), "description")
+
+_installedVersion = None
+_installedVersionFound = False
+
+
+def getInstalledVersion(runOtb=False):
+    global _installedVersion
+    global _installedVersionFound
+
+    if _installedVersionFound and not runOtb:
+        return _installedVersion
+
+    commands =[os.path.join(otbPath(), "otbcli_Smoothing")]
+    progress = SilentProgress()
+    out = executeOtb(commands, progress, False)
+    for line in out:
+        if "version" in line:
+            _installedVersionFound = True
+            _installedVersion = line.split("version")[-1].strip()
+            break
+    return _installedVersion
+
+def compatibleDescriptionPath(version):
+    supportedVersions = {"5.0.0": "5.0.0"}
+    if version is None:
+        return None
+    if version not in supportedVersions:
+        lastVersion = sorted(supportedVersions.keys())[-1]
+        if version > lastVersion:
+            version = lastVersion
+        else:
+            return None
+
+    return os.path.join(otbDescriptionPath(), supportedVersions[version])
+
+def executeOtb(commands, progress, addToLog = True):
+    loglines = []
+    loglines.append(tr("OTB execution console output"))
+    os.putenv('ITK_AUTOLOAD_PATH', otbLibPath())
+    fused_command = ''.join(['"%s" ' % re.sub(r'^"|"$', '', c) for c in commands])
+    proc = subprocess.Popen(fused_command, shell=True, stdout=subprocess.PIPE, stdin=open(os.devnull), stderr=subprocess.STDOUT, universal_newlines=True).stdout
+    for line in iter(proc.readline, ""):
+        if "[*" in line:
+            idx = line.find("[*")
+            perc = int(line[idx - 4:idx - 2].strip(" "))
+            if perc != 0:
+                progress.setPercentage(perc)
+        else:
+            loglines.append(line)
+            progress.setConsoleInfo(line)
 
+    if addToLog:
         ProcessingLog.addToLog(ProcessingLog.LOG_INFO, loglines)
 
-    @staticmethod
-    def checkOtbConfiguration():
-        path = OTBUtils.otbPath()
-        libpath = OTBUtils.otbLibPath()
-        configurationOk = bool(path) and bool(libpath)
-        if not configurationOk:
-            return OTBUtils.tr('OTB folder is not configured. Please configure it '
-                               'before running OTB algorithms.')
-
-    @staticmethod
-    def tr(string, context=''):
-        if context == '':
-            context = 'OTBUtils'
-        return QCoreApplication.translate(context, string)
+    return loglines
+
+
+def tr(string, context=''):
+    if context == '':
+        context = 'OTBUtils'
+    return QCoreApplication.translate(context, string)
 
 
 def get_choices_of(doc, parameter):

python/plugins/processing/algs/otb/description/BandMath.xml python/plugins/processing/algs/otb/description/5.0.0/BandMath.xml

@@ -17,6 +17,7 @@
 ***************************************************************************
 """
 
+
 __author__ = 'Victor Olaya'
 __date__ = 'May 2015'
 __copyright__ = '(C) 2015, Victor Olaya'
@@ -35,7 +36,7 @@
 from processing.algs.saga.SagaUtils import *
 from processing.core.ProcessingConfig import ProcessingConfig
 from processing.algs.grass.GrassUtils import GrassUtils
-from processing.algs.otb.OTBUtils import OTBUtils
+from processing.algs.otb import OTBUtils
 
 
 class PackageTests(unittest.TestCase):