bin/salomeContextUtils.py.in

   1 #! /usr/bin/env python
   2
   3 # Copyright (C) 2013-2014  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   if searchPathList is None or len(searchPathList) == 0:
  96     return None
  97
  98   for path in searchPathList:
  99     fullName = os.path.join(path, scriptName)
 100     if os.path.isfile(fullName) or os.path.isfile(fullName+".py"):
 101       return fullName
 102
 103   return None
 104 #
 105
 106 class ScriptAndArgs:
 107   # script: the command to be run, e.g. python <script.py>
 108   # args: its input parameters
 109   # out: its output parameters
 110   def __init__(self, script = None, args = None, out = None):
 111     self.script = script
 112     self.args = args
 113     self.out = out
 114 #
 115 class ScriptAndArgsObjectEncoder(json.JSONEncoder):
 116   def default(self, obj):
 117     if isinstance(obj, ScriptAndArgs):
 118       # to be easily parsed in GUI module (SalomeApp_Application)
 119       # Do not export output arguments
 120       return {obj.script:obj.args or []}
 121     else:
 122       return json.JSONEncoder.default(self, obj)
 123 #
 124
 125 # Return an array of ScriptAndArgs objects
 126 def getScriptsAndArgs(args=None, searchPathList=None):
 127   if args is None:
 128     args = []
 129   if searchPathList is None:
 130     searchPathList = sys.path
 131
 132   # Syntax of args: script.py [args:a1,a2=val,an] ... script.py [args:a1,a2=val,an]
 133   scriptArgs = []
 134   currentKey = None
 135   argsPrefix = "args:"
 136   outPrefix = "out:"
 137   callPython = False
 138   afterArgs = False
 139   currentScript = None
 140
 141   for i in range(len(args)):
 142     elt = args[i]
 143
 144     if elt.startswith(argsPrefix):
 145       if not currentKey or callPython:
 146         raise SalomeContextException("args list must follow corresponding script file in command line.")
 147       elt = elt.replace(argsPrefix, '')
 148       scriptArgs[len(scriptArgs)-1].args = elt.split(",")
 149       currentKey = None
 150       callPython = False
 151       afterArgs = True
 152     elif elt.startswith(outPrefix):
 153       if (not currentKey and not afterArgs) or callPython:
 154         raise SalomeContextException("out list must follow both corresponding script file and its args in command line.")
 155       elt = elt.replace(outPrefix, '')
 156       scriptArgs[len(scriptArgs)-1].out = elt.split(",")
 157       currentKey = None
 158       callPython = False
 159       afterArgs = False
 160     elif elt.startswith("python"):
 161       callPython = True
 162       afterArgs = False
 163     else:
 164       if not os.path.isfile(elt) and not os.path.isfile(elt+".py"):
 165         eltInSearchPath = __getScriptPath(elt, searchPathList)
 166         if eltInSearchPath is None or (not os.path.isfile(eltInSearchPath) and not os.path.isfile(eltInSearchPath+".py")):
 167           if elt[-3:] == ".py":
 168             raise SalomeContextException("Script not found: %s"%elt)
 169           continue
 170         elt = eltInSearchPath
 171
 172       if elt[-4:] != ".hdf":
 173         if elt[-3:] == ".py":
 174           currentScript = os.path.abspath(elt)
 175         elif os.path.isfile(elt+".py"):
 176           currentScript = os.path.abspath(elt+".py")
 177         else:
 178           currentScript = os.path.abspath(elt) # python script not necessary has .py extension
 179         pass
 180       if currentScript and callPython:
 181         currentKey = "@PYTHONBIN@ "+currentScript
 182         scriptArgs.append(ScriptAndArgs(script=currentKey))
 183         callPython = False
 184       elif currentScript:
 185         if not os.access(currentScript, os.X_OK):
 186           currentKey = "@PYTHONBIN@ "+currentScript
 187           scriptArgs.append(ScriptAndArgs(script=currentKey))
 188         else:
 189           ispython = False
 190           try:
 191             fn = open(currentScript)
 192             for i in xrange(10): # read only 10 first lines
 193               ln = fn.readline()
 194               if re.search("#!.*python"):
 195                 ispython = True
 196                 break
 197               pass
 198             fn.close()
 199           except:
 200             pass
 201           if not ispython and currentScript[-3:] == ".py":
 202             currentKey = "@PYTHONBIN@ "+currentScript
 203           else:
 204             currentKey = currentScript
 205             pass
 206           scriptArgs.append(ScriptAndArgs(script=currentKey))
 207       # CLOSE elif currentScript
 208       afterArgs = False
 209   # end for loop
 210   return scriptArgs
 211 #
 212
 213 # Formatting scripts and args as a Bash-like command-line:
 214 # script1.py [args] ; script2.py [args] ; ...
 215 # scriptArgs is a list of ScriptAndArgs objects; their output parameters are omitted
 216 def formatScriptsAndArgs(scriptArgs=None):
 217     if scriptArgs is None:
 218       return ""
 219     commands = []
 220     for sa_obj in scriptArgs:
 221       cmd = sa_obj.script
 222       if sa_obj.args:
 223         cmd = " ".join([cmd]+sa_obj.args)
 224       commands.append(cmd)
 225
 226     sep = " ; "
 227     if sys.platform == "win32":
 228       sep = " & "
 229     command = sep.join(["%s"%x for x in commands])
 230     return command
 231 #
 232
 233 # Ensure OMNIORB_USER_PATH is defined. This variable refers to a the folder in which
 234 # SALOME will write omniOrb configuration files.
 235 # If OMNIORB_USER_PATH is already set, only checks write access to associated directory ;
 236 # an exception is raised if check fails. It allows users for choosing a specific folder.
 237 # Else the function sets OMNIORB_USER_PATH this way:
 238 # - If APPLI environment variable is set, OMNIORB_USER_PATH is set to ${APPLI}/USERS.
 239 #   The function does not check USERS folder existence or write access. This folder
 240 #   must exist ; this is the case if SALOME virtual application has been created using
 241 #   appli_gen.py script.
 242 # - Else OMNIORB_USER_PATH is set to user home directory.
 243 def setOmniOrbUserPath():
 244   omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
 245   if omniorbUserPath:
 246     if not os.access(omniorbUserPath, os.W_OK):
 247       raise Exception("Unable to get write access to directory: %s"%omniorbUserPath)
 248     pass
 249   else:
 250     homePath = os.path.realpath(os.path.expanduser('~'))
 251     #defaultOmniorbUserPath = os.path.join(homePath, ".salomeConfig/USERS")
 252     defaultOmniorbUserPath = homePath
 253     if os.getenv("APPLI"):
 254       defaultOmniorbUserPath = os.path.join(homePath, os.getenv("APPLI"), "USERS")
 255       pass
 256     os.environ["OMNIORB_USER_PATH"] = defaultOmniorbUserPath
 257 #
 258
 259 def getHostname():
 260   return socket.gethostname().split('.')[0]
 261 #