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   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 # Return an array of ScriptAndArgs objects
 137 def getScriptsAndArgs(args=None, searchPathList=None):
 138   if args is None:
 139     args = []
 140   if searchPathList is None:
 141     searchPathList = sys.path
 142
 143   # Syntax of args: script.py [args:a1,a2=val,an] ... script.py [args:a1,a2=val,an]
 144   scriptArgs = []
 145   currentKey = None
 146   argsPrefix = "args:"
 147   outPrefix = "out:"
 148   callPython = False
 149   afterArgs = False
 150   currentScript = None
 151
 152   for i in range(len(args)):
 153     elt = os.path.expanduser(args[i])
 154     isDriver = (elt == "driver") # special case for YACS scheme execution
 155
 156     if elt.startswith(argsPrefix):
 157       if not currentKey or callPython:
 158         raise SalomeContextException("args list must follow corresponding script file in command line.")
 159       elt = elt.replace(argsPrefix, '')
 160       scriptArgs[len(scriptArgs)-1].args = [os.path.expanduser(x) for x in elt.split(",")]
 161       currentKey = None
 162       callPython = False
 163       afterArgs = True
 164     elif elt.startswith(outPrefix):
 165       if (not currentKey and not afterArgs) or callPython:
 166         raise SalomeContextException("out list must follow both corresponding script file and its args in command line.")
 167       elt = elt.replace(outPrefix, '')
 168       scriptArgs[len(scriptArgs)-1].out = [os.path.expanduser(x) for x in elt.split(",")]
 169       currentKey = None
 170       callPython = False
 171       afterArgs = False
 172     elif elt.startswith("python"):
 173       callPython = True
 174       afterArgs = False
 175     else:
 176       if not os.path.isfile(elt) and not os.path.isfile(elt+".py"):
 177         eltInSearchPath = __getScriptPath(elt, searchPathList)
 178         if eltInSearchPath is None or (not os.path.isfile(eltInSearchPath) and not os.path.isfile(eltInSearchPath+".py")):
 179           if elt[-3:] == ".py":
 180             raise SalomeContextException("Script not found: %s"%elt)
 181           continue
 182         elt = eltInSearchPath
 183
 184       if elt[-4:] != ".hdf":
 185         if elt[-3:] == ".py" or isDriver:
 186           currentScript = os.path.abspath(elt)
 187         elif os.path.isfile(elt+".py"):
 188           currentScript = os.path.abspath(elt+".py")
 189         else:
 190           currentScript = os.path.abspath(elt) # python script not necessary has .py extension
 191         pass
 192
 193       if currentScript and callPython:
 194         currentKey = "@PYTHONBIN@ "+currentScript
 195         scriptArgs.append(ScriptAndArgs(script=currentKey))
 196         callPython = False
 197       elif currentScript:
 198         if isDriver:
 199           currentKey = currentScript
 200           scriptArgs.append(ScriptAndArgs(script=currentKey))
 201           callPython = False
 202         elif not os.access(currentScript, os.X_OK):
 203           currentKey = "@PYTHONBIN@ "+currentScript
 204           scriptArgs.append(ScriptAndArgs(script=currentKey))
 205         else:
 206           ispython = False
 207           try:
 208             fn = open(currentScript)
 209             for i in xrange(10): # read only 10 first lines
 210               ln = fn.readline()
 211               if re.search("#!.*python"):
 212                 ispython = True
 213                 break
 214               pass
 215             fn.close()
 216           except:
 217             pass
 218           if not ispython and currentScript[-3:] == ".py":
 219             currentKey = "@PYTHONBIN@ "+currentScript
 220           else:
 221             currentKey = currentScript
 222             pass
 223           scriptArgs.append(ScriptAndArgs(script=currentKey))
 224       # CLOSE elif currentScript
 225       afterArgs = False
 226   # end for loop
 227   return scriptArgs
 228 #
 229
 230 # Formatting scripts and args as a Bash-like command-line:
 231 # script1.py [args] ; script2.py [args] ; ...
 232 # scriptArgs is a list of ScriptAndArgs objects; their output parameters are omitted
 233 def formatScriptsAndArgs(scriptArgs=None):
 234     if scriptArgs is None:
 235       return ""
 236     commands = []
 237     for sa_obj in scriptArgs:
 238       cmd = sa_obj.script
 239       if sa_obj.args:
 240         cmd = " ".join([cmd]+sa_obj.args)
 241       commands.append(cmd)
 242
 243     sep = " ; "
 244     if sys.platform == "win32":
 245       sep = " & "
 246     command = sep.join(["%s"%x for x in commands])
 247     return command
 248 #
 249
 250 # Ensure OMNIORB_USER_PATH is defined. This variable refers to a the folder in which
 251 # SALOME will write omniOrb configuration files.
 252 # If OMNIORB_USER_PATH is already set, only checks write access to associated directory ;
 253 # an exception is raised if check fails. It allows users for choosing a specific folder.
 254 # Else the function sets OMNIORB_USER_PATH this way:
 255 # - If APPLI environment variable is set, OMNIORB_USER_PATH is set to ${APPLI}/USERS.
 256 #   The function does not check USERS folder existence or write access. This folder
 257 #   must exist ; this is the case if SALOME virtual application has been created using
 258 #   appli_gen.py script.
 259 # - Else OMNIORB_USER_PATH is set to user home directory.
 260 def setOmniOrbUserPath():
 261   omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
 262   if omniorbUserPath:
 263     if not os.access(omniorbUserPath, os.W_OK):
 264       raise Exception("Unable to get write access to directory: %s"%omniorbUserPath)
 265     pass
 266   else:
 267     homePath = os.path.realpath(os.path.expanduser('~'))
 268     #defaultOmniorbUserPath = os.path.join(homePath, ".salomeConfig/USERS")
 269     defaultOmniorbUserPath = homePath
 270     if os.getenv("APPLI"):
 271       defaultOmniorbUserPath = os.path.join(homePath, os.getenv("APPLI"), "USERS")
 272       pass
 273     os.environ["OMNIORB_USER_PATH"] = defaultOmniorbUserPath
 274 #
 275
 276 def getHostname():
 277   return socket.gethostname().split('.')[0]
 278 #