bin/launchConfigureParser.py

   1 import os, glob, string, sys, re
   2 import xml.sax
   3
   4 # names of tags in XML configuration file
   5 doc_tag = "document"
   6 sec_tag = "section"
   7 par_tag = "parameter"
   8
   9 # names of attributes in XML configuration file
  10 nam_att = "name"
  11 val_att = "value"
  12
  13 # certain values in XML configuration file ("launch" section)
  14 lanch_nam      = "launch"
  15 gui_nam        = "gui"
  16 splash_nam     = "splash"
  17 logger_nam     = "logger"
  18 xterm_nam      = "xterm"
  19 file_nam       = "file"
  20 portkill_nam   = "portkill"
  21 killall_nam    = "killall"
  22 modules_nam    = "modules"
  23 pyModules_nam  = "pyModules"
  24 embedded_nam   = "embedded"
  25 standalone_nam = "standalone"
  26 containers_nam = "containers"
  27 key_nam        = "key"
  28 interp_nam     = "interp"
  29 except_nam     = "noexcepthandler"
  30
  31 # values in XML configuration file giving specific module parameters (<module_name> section)
  32 # which are stored in opts with key <module_name>_<parameter> (eg SMESH_plugins)
  33 plugins_nam    = "plugins"
  34
  35 # values passed as arguments, NOT read from XML config file, but set from within this script
  36 appname_nam    = "appname"
  37 port_nam       = "port"
  38 appname        = "SalomeApp"
  39
  40 # values of boolean type (must be '0' or '1').
  41 # xml_parser.boolValue() is used for correct setting
  42 boolKeys = ( gui_nam, splash_nam, logger_nam, file_nam, xterm_nam, portkill_nam, killall_nam, interp_nam, except_nam )
  43
  44 # values of list type
  45 listKeys = ( containers_nam, embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )
  46
  47 # return application version (uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION)
  48 def version():
  49     root_dir = os.environ.get( 'KERNEL_ROOT_DIR', '' )     # KERNEL_ROOT_DIR or "" if not found
  50     root_dir = os.environ.get( 'GUI_ROOT_DIR', root_dir )  # GUI_ROOT_DIR or KERNEL_ROOT_DIR or "" if both not found
  51     filename = root_dir+'/bin/salome/VERSION'
  52     str = open( filename, "r" ).readline() # str = "THIS IS SALOME - SALOMEGUI VERSION: 3.0.0"
  53     match = re.search( r':\s+([a-zA-Z0-9.]+)\s*$', str )
  54     if match :
  55         return match.group( 1 )
  56     return ''
  57
  58 # -----------------------------------------------------------------------------
  59
  60 ### xml reader for launch configuration file usage
  61
  62 section_to_skip = ""
  63
  64 class xml_parser:
  65     def __init__(self, fileName, _opts ):
  66         print "Processing ",fileName
  67         self.space = []
  68         self.opts = _opts
  69         self.section = section_to_skip
  70         parser = xml.sax.make_parser()
  71         parser.setContentHandler(self)
  72         parser.parse(fileName)
  73         pass
  74
  75     def boolValue( self, str ):
  76         if str in ("yes", "y", "1"):
  77             return 1
  78         elif str in ("no", "n", "0"):
  79             return 0
  80         else:
  81             return str
  82         pass
  83
  84     def startElement(self, name, attrs):
  85         self.space.append(name)
  86         self.current = None
  87
  88         # if we are analyzing "section" element and its "name" attribute is
  89         # either "launch" or module name -- set section_name
  90         if self.space == [doc_tag, sec_tag] and nam_att in attrs.getNames():
  91             section_name = attrs.getValue( nam_att )
  92             if section_name == lanch_nam:
  93                 self.section = section_name # launch section
  94             elif self.opts.has_key( modules_nam ) and \
  95                  section_name in self.opts[ modules_nam ]:
  96                 self.section = section_name # <module> section
  97             else:
  98                 self.section = section_to_skip # any other section
  99             pass
 100
 101         # if we are analyzing "parameter" elements - children of either
 102         # "section launch" or "section "<module>"" element, then store them
 103         # in self.opts assiciative array (key = [<module>_ + ] value of "name" attribute)
 104         elif self.section != section_to_skip           and \
 105              self.space == [doc_tag, sec_tag, par_tag] and \
 106              nam_att in attrs.getNames()               and \
 107              val_att in attrs.getNames():
 108             nam = attrs.getValue( nam_att )
 109             val = attrs.getValue( val_att )
 110             if self.section == lanch_nam: # key for launch section
 111                 key = nam
 112             else:                         # key for <module> section
 113                 key = self.section + "_" + nam
 114             if nam in boolKeys:
 115                 self.opts[key] = self.boolValue( val )  # assign boolean value: 0 or 1
 116             elif nam in listKeys:
 117                 self.opts[key] = val.split( ',' )       # assign list value: []
 118             else:
 119                 self.opts[key] = val;
 120             pass
 121         pass
 122
 123     def endElement(self, name):
 124         p = self.space.pop()
 125         self.current = None
 126         if self.section != section_to_skip and name == sec_tag:
 127             self.section = section_to_skip
 128         pass
 129
 130     def characters(self, content):
 131         pass
 132
 133     def processingInstruction(self, target, data):
 134         pass
 135
 136     def setDocumentLocator(self, locator):
 137         pass
 138
 139     def startDocument(self):
 140         self.read = None
 141         pass
 142
 143     def endDocument(self):
 144         self.read = None
 145         pass
 146
 147 # -----------------------------------------------------------------------------
 148
 149 ### searching for launch configuration files
 150 # the rule:
 151 # - environment variable {'appname'+'Config'} (SalomeAppConfig) contains list of directories (';' as devider)
 152 # - these directories contain 'appname'+'.xml' (SalomeApp.xml) configuration files
 153 # - these files are analyzed beginning with the last one (last directory in the list)
 154 # - if a key is found in next analyzed cofiguration file - it will be replaced
 155 # - the last configuration file to be analyzed - ~/.'appname'+'rc' (~/SalomeApprc) (if it exists)
 156 # - but anyway, if user specifies a certain option in a command line - it will replace the values
 157 # - specified in configuration file(s)
 158 # - once again the order of settings (next setting replaces the previous ones):
 159 # -     SalomeApp.xml files in directories specified by SalomeAppConfig env variable
 160 # -     .SalomeApprc file in user's catalogue
 161 # -     command line
 162
 163 config_var = appname+'Config'
 164 dirs = os.environ[config_var]
 165 dirs = re.split('[;|:]', dirs )
 166 dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
 167
 168 _opts = {} # assiciative array of options to be filled
 169
 170 # SalomeApp.xml files in directories specified by SalomeAppConfig env variable
 171 for dir in dirs:
 172     filename = dir+'/'+appname+'.xml'
 173     try:
 174         p = xml_parser(filename, _opts)
 175         _opts = p.opts
 176     except:
 177         print 'Can not read launch configuration file ', filename
 178         continue
 179
 180 # SalomeApprc file in user's catalogue
 181 filename = os.environ['HOME']+'/.'+appname+'rc.'+version()
 182 try:
 183     p = xml_parser(filename, _opts)
 184     _opts = p.opts
 185 except:
 186     print 'Can not read launch configuration file ', filename
 187
 188
 189 args = _opts
 190
 191 # --- setting default values of keys if they were NOT set in config files ---
 192 for aKey in listKeys:
 193     if not args.has_key( aKey ):
 194         args[aKey]=[]
 195
 196 for aKey in boolKeys:
 197     if not args.has_key( aKey ):
 198         args[aKey]=0
 199
 200 if args[file_nam]:
 201     afile=args[file_nam]
 202     args[file_nam]=[afile]
 203
 204 args[appname_nam] = appname
 205
 206 ### searching for my port
 207
 208 my_port = 2809
 209 try:
 210   file = open(os.environ["OMNIORB_CONFIG"], "r")
 211   s = file.read()
 212   while len(s):
 213     l = string.split(s, ":")
 214     if string.split(l[0], " ")[0] == "ORBInitRef" or string.split(l[0], " ")[0] == "InitRef" :
 215       my_port = int(l[len(l)-1])
 216       pass
 217     s = file.read()
 218     pass
 219 except:
 220   pass
 221
 222 args[port_nam] = my_port
 223
 224 # -----------------------------------------------------------------------------
 225
 226 ### command line options reader
 227
 228 def options_parser(line):
 229   source = line
 230   list = []
 231   for delimiter in [" ", ",", "="]:
 232     for o in source:
 233       list += string.split(o, delimiter)
 234       pass
 235     source = list
 236     list = []
 237     pass
 238
 239   #print "source=",source
 240
 241   result = {}
 242   i = 0
 243   while i < len(source):
 244     if source[i][0] != '-':
 245       key = None
 246     elif source[i][1] == '-':
 247       key = source[i][2]
 248     else:
 249       key = source[i][1]
 250       pass
 251
 252     result[key] = []
 253     if key:
 254       i += 1
 255       pass
 256     while i < len(source) and source[i][0] != '-':
 257       result[key].append(source[i])
 258       i += 1
 259       pass
 260     pass
 261   return result
 262
 263 # -----------------------------------------------------------------------------
 264
 265 ### read command-line options : each arg given in command line supersedes arg from xml config file
 266 cmd_opts = {}
 267 try:
 268     cmd_opts = options_parser(sys.argv[1:])
 269     #print "opts=",cmd_opts
 270     kernel_root_dir=os.environ["KERNEL_ROOT_DIR"]
 271 except:
 272     cmd_opts["h"] = 1
 273     pass
 274
 275 ### check all options are right
 276
 277 opterror=0
 278 for opt in cmd_opts:
 279     if not opt in ("h","g","l","f","x","m","e","s","c","p","k","t","i","r"):
 280         print "command line error: -", opt
 281         opterror=1
 282
 283 if opterror == 1:
 284     cmd_opts["h"] = 1
 285
 286 if cmd_opts.has_key("h"):
 287     print """USAGE: runSalome.py [options]
 288     [command line options] :
 289     --help or -h                  : print this help
 290     --gui or -g                   : launching with GUI
 291     --terminal -t                 : launching without gui (to deny --gui)
 292     --logger or -l                : redirect messages in a CORBA collector
 293     --file=filename or -f=filename: redirect messages in a log file
 294     --xterm or -x                 : execute servers in xterm console (messages appear in xterm windows)
 295     --modules=module1,module2,... : salome module list (modulen is the name of Salome module to load)
 296     or -m=module1,module2,...
 297     --embedded=registry,study,moduleCatalog,cppContainer
 298     or -e=registry,study,moduleCatalog,cppContainer
 299                                   : embedded CORBA servers (default: registry,study,moduleCatalog,cppContainer)
 300                                   : (logger,pyContainer,supervContainer can't be embedded
 301     --standalone=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer
 302     or -s=registry,study,moduleCatalog,cppContainer,pyContainer,supervContainer
 303                                   : standalone CORBA servers (default: pyContainer,supervContainer)
 304     --containers=cpp,python,superv: (obsolete) launching of containers cpp, python and supervision
 305     or -c=cpp,python,superv       : = get default from -e and -s
 306     --portkill or -p              : kill the salome with current port
 307     --killall or -k               : kill all salome sessions
 308     --interp=n or -i=n            : number of additional xterm to open, with session environment
 309     -z                            : display splash screen
 310     -r                            : disable centralized exception handling mechanism
 311
 312     For each Salome module, the environment variable <modulen>_ROOT_DIR must be set.
 313     The module name (<modulen>) must be uppercase.
 314     KERNEL_ROOT_DIR is mandatory.
 315     """
 316     sys.exit(1)
 317     pass
 318
 319 ### apply command-line options to the arguments
 320 for opt in cmd_opts:
 321     if opt == 'g':
 322         args[gui_nam] = 1
 323     elif opt == 'z':
 324         args[splash_nam] = 1
 325     elif opt == 'r':
 326         args[except_nam] = 1
 327     elif opt == 'l':
 328         args[logger_nam] = 1
 329     elif opt == 'f':
 330         args[file_nam] = cmd_opts['f']
 331     elif opt == 'x':
 332         args[xterm_nam] = 1
 333     elif opt == 'i':
 334         args[interp_nam] = cmd_opts['i']
 335     elif opt == 'm':
 336         args[modules_nam] = cmd_opts['m']
 337     elif opt == 'e':
 338         args[embedded_nam] = cmd_opts['e']
 339     elif opt == 's':
 340         args[standalone_nam] = cmd_opts['s']
 341     elif opt == 'c':
 342         args[containers_nam] = cmd_opts['c']
 343     elif opt == 'p':
 344         args[portkill_nam] = 1
 345     elif opt == 'k':
 346         args[killall_nam] = 1
 347         pass
 348     pass
 349
 350 # 'terminal' must be processed in the end: to deny any 'gui' options
 351 if 't' in cmd_opts:
 352     args[gui_nam] = 0
 353     pass
 354
 355 #print "args=",args