bin/salomeContextUtils.py.in

   1 #! /usr/bin/env python
   2
   3 # Copyright (C) 2013-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   4 #
   5 # This library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2.1 of the License, or (at your option) any later version.
   9 #
  10 # This library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with this library; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21
  22 import os
  23 import sys
  24 import glob
  25 import subprocess
  26 import re
  27 import socket
  28 import json
  29
  30 """
  31 Define a specific exception class to manage exceptions related to SalomeContext
  32 """
  33 class SalomeContextException(Exception):
  34   """Report error messages to the user interface of SalomeContext."""
  35 #
  36
  37 def __listDirectory(path):
  38   allFiles = []
  39   for root, dirs, files in os.walk(path):
  40     cfgFiles = glob.glob(os.path.join(root,'*.cfg'))
  41     allFiles += cfgFiles
  42
  43     shFiles = glob.glob(os.path.join(root,'*.sh'))
  44     for f in shFiles:
  45       no_ext = os.path.splitext(f)[0]
  46       if not os.path.isfile(no_ext+".cfg"):
  47         allFiles.append(f)
  48
  49   return allFiles
  50 #
  51
  52 def __getConfigFileNamesDefault():
  53   absoluteAppliPath = os.getenv('ABSOLUTE_APPLI_PATH','')
  54   if not absoluteAppliPath:
  55     return []
  56
  57   envdDir = absoluteAppliPath + '/env.d'
  58   if not os.path.isdir(envdDir):
  59     return []
  60
  61   return __listDirectory(envdDir)
  62 #
  63
  64 def getConfigFileNames(args, checkExistence=False):
  65   # special case: configuration files are provided by user
  66   # Search for command-line argument(s) --config=file1,file2,..., filen
  67   # Search for command-line argument(s) --config=dir1,dir2,..., dirn
  68   configOptionPrefix = "--config="
  69   configArgs = [ str(x) for x in args if str(x).startswith(configOptionPrefix) ]
  70
  71   if len(configArgs) == 0:
  72     return __getConfigFileNamesDefault(), args, []
  73
  74   args = [ x for x in args if not x.startswith(configOptionPrefix) ]
  75   allLists = [ x.replace(configOptionPrefix, '') for x in configArgs ]
  76
  77   configFileNames = []
  78   unexisting = []
  79   for currentList in allLists:
  80     elements = currentList.split(',')
  81     for elt in elements:
  82       elt = os.path.realpath(os.path.expanduser(elt))
  83       if os.path.isdir(elt):
  84         configFileNames += __listDirectory(elt)
  85       else:
  86         if checkExistence and not os.path.isfile(elt):
  87           unexisting += [elt]
  88         else:
  89           configFileNames += [elt]
  90
  91   return configFileNames, args, unexisting
  92 #
  93
  94 def __getScriptPath(scriptName, searchPathList):
  95   scriptName = os.path.expanduser(scriptName)
  96   if os.path.isabs(scriptName):
  97     return scriptName
  98
  99   if searchPathList is None or len(searchPathList) == 0:
 100     return None
 101
 102   for path in searchPathList:
 103     fullName = os.path.join(path, scriptName)
 104     if os.path.isfile(fullName) or os.path.isfile(fullName+".py"):
 105       return fullName
 106
 107   return None
 108 #
 109
 110 class ScriptAndArgs:
 111   # script: the command to be run, e.g. python <script.py>
 112   # args: its input parameters
 113   # out: its output parameters
 114   def __init__(self, script = None, args = None, out = None):
 115     self.script = script
 116     self.args = args
 117     self.out = out
 118   #
 119   def __repr__(self):
 120     msg = "\n# Script: %s\n"%self.script
 121     msg += "     * Input: %s\n"%self.args
 122     msg += "     * Output: %s\n"%self.out
 123     return msg
 124   #
 125 #
 126 class ScriptAndArgsObjectEncoder(json.JSONEncoder):
 127   def default(self, obj):
 128     if isinstance(obj, ScriptAndArgs):
 129       # to be easily parsed in GUI module (SalomeApp_Application)
 130       # Do not export output arguments
 131       return {obj.script:obj.args or []}
 132     else:
 133       return json.JSONEncoder.default(self, obj)
 134 #
 135
 136 def getShortAndExtraArgs(args=[]):
 137   try:
 138     pos = args.index("--") # raise a ValueError if not found
 139     short_args = args[:pos]
 140     extra_args = args[pos:] # include "--"
 141   except ValueError:
 142     short_args = args
 143     extra_args = []
 144     pass
 145
 146   return short_args, extra_args
 147 #
 148
 149 # Return an array of ScriptAndArgs objects
 150 def getScriptsAndArgs(args=[], searchPathList=None):
 151   short_args, extra_args = getShortAndExtraArgs(args)
 152   args = short_args
 153
 154   if searchPathList is None:
 155     searchPathList = sys.path
 156
 157   # Syntax of args: script.py [args:a1,a2=val,an] ... script.py [args:a1,a2=val,an]
 158   scriptArgs = []
 159   currentKey = None
 160   argsPrefix = "args:"
 161   outPrefix = "out:"
 162   callPython = False
 163   afterArgs = False
 164   currentScript = None
 165
 166   for i in range(len(args)):
 167     elt = os.path.expanduser(args[i])
 168     isDriver = (elt == "driver") # special case for YACS scheme execution
 169
 170     if elt.startswith(argsPrefix):
 171       if not currentKey or callPython:
 172         raise SalomeContextException("args list must follow corresponding script file in command line.")
 173       elt = elt.replace(argsPrefix, '')
 174       scriptArgs[len(scriptArgs)-1].args = [os.path.expanduser(x) for x in elt.split(",")]
 175       currentKey = None
 176       callPython = False
 177       afterArgs = True
 178     elif elt.startswith(outPrefix):
 179       if (not currentKey and not afterArgs) or callPython:
 180         raise SalomeContextException("out list must follow both corresponding script file and its args in command line.")
 181       elt = elt.replace(outPrefix, '')
 182       scriptArgs[len(scriptArgs)-1].out = [os.path.expanduser(x) for x in elt.split(",")]
 183       currentKey = None
 184       callPython = False
 185       afterArgs = False
 186     elif elt.startswith("python"):
 187       callPython = True
 188       afterArgs = False
 189     else:
 190       if not os.path.isfile(elt) and not os.path.isfile(elt+".py"):
 191         eltInSearchPath = __getScriptPath(elt, searchPathList)
 192         if eltInSearchPath is None or (not os.path.isfile(eltInSearchPath) and not os.path.isfile(eltInSearchPath+".py")):
 193           if elt[-3:] == ".py":
 194             raise SalomeContextException("Script not found: %s"%elt)
 195           scriptArgs.append(ScriptAndArgs(script=elt))
 196           continue
 197         elt = eltInSearchPath
 198
 199       if elt[-4:] != ".hdf":
 200         if elt[-3:] == ".py" or isDriver:
 201           currentScript = os.path.abspath(elt)
 202         elif os.path.isfile(elt+".py"):
 203           currentScript = os.path.abspath(elt+".py")
 204         else:
 205           currentScript = os.path.abspath(elt) # python script not necessary has .py extension
 206         pass
 207
 208       if currentScript and callPython:
 209         currentKey = "@PYTHONBIN@ "+currentScript
 210         scriptArgs.append(ScriptAndArgs(script=currentKey))
 211         callPython = False
 212       elif currentScript:
 213         if isDriver:
 214           currentKey = currentScript
 215           scriptArgs.append(ScriptAndArgs(script=currentKey))
 216           callPython = False
 217         elif not os.access(currentScript, os.X_OK):
 218           currentKey = "@PYTHONBIN@ "+currentScript
 219           scriptArgs.append(ScriptAndArgs(script=currentKey))
 220         else:
 221           ispython = False
 222           try:
 223             fn = open(currentScript)
 224             for i in xrange(10): # read only 10 first lines
 225               ln = fn.readline()
 226               if re.search("#!.*python"):
 227                 ispython = True
 228                 break
 229               pass
 230             fn.close()
 231           except:
 232             pass
 233           if not ispython and currentScript[-3:] == ".py":
 234             currentKey = "@PYTHONBIN@ "+currentScript
 235           else:
 236             currentKey = currentScript
 237             pass
 238           scriptArgs.append(ScriptAndArgs(script=currentKey))
 239       # CLOSE elif currentScript
 240       afterArgs = False
 241   # end for loop
 242
 243   if len(extra_args) > 1: # syntax: -- program [options] [arguments]
 244     command = extra_args[1]
 245     command_args = extra_args[2:]
 246     scriptArgs.append(ScriptAndArgs(script=command, args=command_args))
 247     pass
 248
 249   return scriptArgs
 250 #
 251
 252 # Formatting scripts and args as a Bash-like command-line:
 253 # script1.py [args] ; script2.py [args] ; ...
 254 # scriptArgs is a list of ScriptAndArgs objects; their output parameters are omitted
 255 def formatScriptsAndArgs(scriptArgs=None):
 256     if scriptArgs is None:
 257       return ""
 258     commands = []
 259     for sa_obj in scriptArgs:
 260       cmd = sa_obj.script
 261       if sa_obj.args:
 262         cmd = " ".join([cmd]+sa_obj.args)
 263       commands.append(cmd)
 264
 265     sep = " ; "
 266     if sys.platform == "win32":
 267       sep = " & "
 268     command = sep.join(["%s"%x for x in commands])
 269     return command
 270 #
 271
 272 # Ensure OMNIORB_USER_PATH is defined. This variable refers to a the folder in which
 273 # SALOME will write omniOrb configuration files.
 274 # If OMNIORB_USER_PATH is already set, only checks write access to associated directory ;
 275 # an exception is raised if check fails. It allows users for choosing a specific folder.
 276 # Else the function sets OMNIORB_USER_PATH this way:
 277 # - If APPLI environment variable is set, OMNIORB_USER_PATH is set to ${APPLI}/USERS.
 278 #   The function does not check USERS folder existence or write access. This folder
 279 #   must exist ; this is the case if SALOME virtual application has been created using
 280 #   appli_gen.py script.
 281 # - Else OMNIORB_USER_PATH is set to user home directory.
 282 def setOmniOrbUserPath():
 283   omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
 284   if omniorbUserPath:
 285     if not os.access(omniorbUserPath, os.W_OK):
 286       raise Exception("Unable to get write access to directory: %s"%omniorbUserPath)
 287     pass
 288   else:
 289     homePath = os.path.realpath(os.path.expanduser('~'))
 290     #defaultOmniorbUserPath = os.path.join(homePath, ".salomeConfig/USERS")
 291     defaultOmniorbUserPath = homePath
 292     if os.getenv("APPLI"):
 293       defaultOmniorbUserPath = os.path.join(homePath, os.getenv("APPLI"), "USERS")
 294       pass
 295     os.environ["OMNIORB_USER_PATH"] = defaultOmniorbUserPath
 296 #
 297
 298 def getHostname():
 299   return socket.gethostname().split('.')[0]
 300 #