1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
4 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License, or (at your option) any later version.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 import os, glob, string, sys, re
29 from salome_utils import verbose, getPortNumber, getHomeDir
31 # names of tags in XML configuration file
37 # names of attributes in XML configuration file
41 # certain values in XML configuration file ("launch" section)
49 portkill_nam = "portkill"
50 killall_nam = "killall"
51 modules_nam = "modules"
52 embedded_nam = "embedded"
53 standalone_nam = "standalone"
55 terminal_nam = "terminal"
57 except_nam = "noexcepthandler"
58 terminal_nam = "terminal"
63 gdb_session_nam = "gdb_session"
64 ddd_session_nam = "ddd_session"
65 valgrind_session_nam = "valgrind_session"
66 shutdown_servers_nam = "shutdown_servers"
67 foreground_nam = "foreground"
68 wake_up_session_nam = "wake_up_session"
70 siman_study_nam = "siman_study"
71 siman_scenario_nam = "siman_scenario"
72 siman_user_nam = "siman_user"
74 # values in XML configuration file giving specific module parameters (<module_name> section)
75 # which are stored in opts with key <module_name>_<parameter> (eg SMESH_plugins)
76 plugins_nam = "plugins"
78 # values passed as arguments, NOT read from XML config file, but set from within this script
79 appname_nam = "appname"
81 useport_nam = "useport"
82 salomecfgname = "salome"
83 salomeappname = "SalomeApp"
84 script_nam = "pyscript"
86 # possible choices for the "embedded" and "standalone" parameters
87 embedded_choices = [ "registry", "study", "moduleCatalog", "cppContainer", "SalomeAppEngine" ]
88 standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer"]
90 # values of boolean type (must be '0' or '1').
91 # xml_parser.boolValue() is used for correct setting
92 boolKeys = ( gui_nam, splash_nam, logger_nam, file_nam, xterm_nam, portkill_nam, killall_nam, except_nam, pinter_nam, shutdown_servers_nam )
93 intKeys = ( interp_nam, )
96 listKeys = ( embedded_nam, key_nam, modules_nam, standalone_nam, plugins_nam )
99 # Get the application version
100 # Uses GUI_ROOT_DIR (or KERNEL_ROOT_DIR in batch mode) +/bin/salome/VERSION file
105 root_dir = os.environ.get( 'KERNEL_ROOT_DIR', '' ) # KERNEL_ROOT_DIR or "" if not found
106 version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
107 if root_dir and os.path.exists( version_file ):
108 filename = version_file
109 root_dir = os.environ.get( 'GUI_ROOT_DIR', '' ) # GUI_ROOT_DIR "" if not found
110 version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
111 if root_dir and os.path.exists( version_file ):
112 filename = version_file
114 str = open( filename, "r" ).readline() # str = "THIS IS SALOME - SALOMEGUI VERSION: 3.0.0"
115 match = re.search( r':\s+([a-zA-Z0-9.]+)\s*$', str )
117 return match.group( 1 )
123 # Calculate and return configuration file unique ID
124 # For example: for SALOME version 3.1.0a1 the id is 300999701
126 def version_id(fname):
127 major = minor = release = dev1 = dev2 = 0
128 vers = fname.split(".")
133 # If salome version given is DEV, the call to int('DEV') will fail with
134 # a ValueError exception
137 if len(vers) > 1: minor = int(vers[1])
139 # If salome version given is 7.DEV, the call to int('DEV') will fail with
140 # a ValueError exception
143 mr = re.search(r'^([0-9]+)([A-Z]|RC)?([0-9]*)',vers[2], re.I)
145 release = int(mr.group(1))
147 tag = mr.group(2).strip().lower()
149 dev1 = 49 # release candidate
151 dev1 = ord(tag)-ord('a')+1
154 dev2 = int(mr.group(3).strip())
157 dev = dev1 * 100 + dev2
159 ver = ver * 100 + minor
160 ver = ver * 100 + release
162 if dev > 0: ver = ver - dev
166 # Get default user configuration file name
168 # - on Linux: ~/.config/salome/SalomeApprc[.<version>]
169 # - on Windows: ~/SalomeApp.xml[.<version>]
170 # where <version> is an optional version number
172 def defaultUserFile(appname=salomeappname, cfgname=salomecfgname):
174 filetmpl = sys.platform == "win32" and "{0}.xml.{1}" or "{0}rc.{1}"
176 paths.append(getHomeDir())
177 paths.append(".config")
178 if cfgname: paths.append(cfgname)
179 paths.append(filetmpl.format(appname, v))
180 return os.path.join(*paths)
183 # Get user configuration file name
185 def userFile(appname, cfgname):
188 if not v: return None # unknown version
190 # get default user file name
191 filename = defaultUserFile(appname, cfgname)
192 if not filename: return None # default user file name is bad
194 # check that default user file exists
195 if os.path.exists(filename): return filename # user file is found
197 # otherwise try to detect any appropriate user file
199 # ... calculate default version id
201 if not id0: return None # bad version id -> can't detect appropriate file
203 # ... get all existing user preferences files
204 filetmpl1 = sys.platform == "win32" and "{0}.xml.*" or "{0}rc.*"
205 filetmpl2 = sys.platform == "win32" and filetmpl1 or "." + filetmpl1
208 # Since v6.6.0 - in ~/.config/salome directory, without dot prefix
209 files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl1.format(appname)))
210 # Since v6.5.0 - in ~/.config/salome directory, dot-prefixed (backward compatibility)
211 if filetmpl2 and filetmpl2 != filetmpl1:
212 files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl2.format(appname)))
214 # old style (before v6.5.0) - in ~ directory, dot-prefixed
215 if filetmpl2 and filetmpl2 != filetmpl1:
216 files += glob.glob(os.path.join(getHomeDir(), filetmpl2.format(appname)))
219 # ... loop through all files and find most appopriate file (with closest id)
223 ff = os.path.basename( f )
224 if sys.platform == "win32":
225 match = re.search( r'^{0}\.xml\.([a-zA-Z0-9.]+)$'.format(appname), ff )
227 match = re.search( r'^\.?{0}rc\.([a-zA-Z0-9.]+)$'.format(appname), ff )
229 ver = version_id(match.group(1))
230 if not ver: continue # bad version id -> skip file
231 if appr_id < 0 or abs(appr_id-id0) > abs(ver-id0):
235 elif abs(appr_id-id0) == abs(ver-id0):
236 if not os.path.basename(f).startswith("."): appr_file = f
244 def process_containers_params( standalone, embedded ):
245 # 1. filter inappropriate containers names
246 if standalone is not None:
247 standalone = filter( lambda x: x in standalone_choices, standalone )
248 if embedded is not None:
249 embedded = filter( lambda x: x in embedded_choices, embedded )
251 # 2. remove containers appearing in 'standalone' parameter from the 'embedded'
252 # parameter --> i.e. 'standalone' parameter has higher priority
253 if standalone is not None and embedded is not None:
254 embedded = filter( lambda x: x not in standalone, embedded )
256 # 3. return corrected parameters values
257 return standalone, embedded
259 # -----------------------------------------------------------------------------
262 # XML reader for launch configuration file usage
268 def __init__(self, fileName, _opts, _importHistory):
269 #warning _importHistory=[] is NOT good: is NOT empty,reinitialized after first call
270 if verbose(): print "Configure parser: processing %s ..." % fileName
271 self.fileName = os.path.abspath(fileName)
272 self.importHistory = _importHistory
273 self.importHistory.append(self.fileName)
276 self.section = section_to_skip
277 parser = xml.sax.make_parser()
278 parser.setContentHandler(self)
279 parser.parse(fileName)
280 standalone, embedded = process_containers_params( self.opts.get( standalone_nam ),
281 self.opts.get( embedded_nam ) )
282 if standalone is not None:
283 self.opts[ standalone_nam ] = standalone
284 if embedded is not None:
285 self.opts[ embedded_nam ] = embedded
288 def boolValue( self, str ):
290 if isinstance(strloc, types.UnicodeType):
291 strloc = strloc.encode().strip()
292 if isinstance(strloc, types.StringType):
293 strlow = strloc.lower()
294 if strlow in ("1", "yes", "y", "on", "true", "ok"):
296 elif strlow in ("0", "no", "n", "off", "false", "cancel"):
301 def intValue( self, str ):
303 if isinstance(strloc, types.UnicodeType):
304 strloc = strloc.encode().strip()
305 if isinstance(strloc, types.StringType):
306 strlow = strloc.lower()
307 if strlow in ("1", "yes", "y", "on", "true", "ok"):
309 elif strlow in ("0", "no", "n", "off", "false", "cancel"):
312 return string.atoi(strloc)
316 def startElement(self, name, attrs):
317 self.space.append(name)
320 # if we are importing file
321 if self.space == [doc_tag, import_tag] and nam_att in attrs.getNames():
322 self.importFile( attrs.getValue(nam_att) )
324 # if we are analyzing "section" element and its "name" attribute is
325 # either "launch" or module name -- set section_name
326 if self.space == [doc_tag, sec_tag] and nam_att in attrs.getNames():
327 section_name = attrs.getValue( nam_att )
328 if section_name == lanch_nam:
329 self.section = section_name # launch section
330 elif self.opts.has_key( modules_nam ) and \
331 section_name in self.opts[ modules_nam ]:
332 self.section = section_name # <module> section
334 self.section = section_to_skip # any other section
337 # if we are analyzing "parameter" elements - children of either
338 # "section launch" or "section "<module>"" element, then store them
339 # in self.opts assiciative array (key = [<module>_ + ] value of "name" attribute)
340 elif self.section != section_to_skip and \
341 self.space == [doc_tag, sec_tag, par_tag] and \
342 nam_att in attrs.getNames() and \
343 val_att in attrs.getNames():
344 nam = attrs.getValue( nam_att )
345 val = attrs.getValue( val_att )
346 if self.section == lanch_nam: # key for launch section
348 else: # key for <module> section
349 key = self.section + "_" + nam
351 self.opts[key] = self.boolValue( val ) # assign boolean value: 0 or 1
353 self.opts[key] = self.intValue( val ) # assign integer value
354 elif nam in listKeys:
355 self.opts[key] = filter( lambda a: a.strip(), re.split( "[:;,]", val ) ) # assign list value: []
361 def endElement(self, name):
364 if self.section != section_to_skip and name == sec_tag:
365 self.section = section_to_skip
368 def characters(self, content):
371 def processingInstruction(self, target, data):
374 def setDocumentLocator(self, locator):
377 def startDocument(self):
381 def endDocument(self):
385 def importFile(self, fname):
387 if os.path.isabs (fname) :
390 absfname = os.path.join(os.path.dirname(self.fileName), fname)
392 # check existing and registry file
393 for ext in ["", ".xml", ".XML"] :
394 if os.path.exists(absfname + ext) :
396 if absfname in self.importHistory :
397 if verbose(): print "Configure parser: Warning : file %s is already imported" % absfname
398 return # already imported
402 if verbose(): print "Configure parser: Error : file %s does not exist" % absfname
407 # copy current options
409 opts = copy.deepcopy(self.opts)
411 imp = xml_parser(absfname, opts, self.importHistory)
413 for key in imp.opts.keys():
414 if not self.opts.has_key(key):
415 self.opts[key] = imp.opts[key]
420 if verbose(): print "Configure parser: Error : can not read configuration file %s" % absfname
424 # -----------------------------------------------------------------------------
426 booleans = { '1': True , 'yes': True , 'y': True , 'on' : True , 'true' : True , 'ok' : True,
427 '0': False, 'no' : False, 'n': False, 'off': False, 'false': False, 'cancel' : False }
429 boolean_choices = booleans.keys()
431 def check_embedded(option, opt, value, parser):
432 from optparse import OptionValueError
433 assert value is not None
434 if parser.values.embedded:
435 embedded = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.embedded ) )
438 if parser.values.standalone:
439 standalone = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.standalone ) )
442 vals = filter( lambda a: a.strip(), re.split( "[:;,]", value ) )
444 if v not in embedded_choices:
445 raise OptionValueError( "option %s: invalid choice: %r (choose from %s)" % ( opt, v, ", ".join( map( repr, embedded_choices ) ) ) )
446 if v not in embedded:
449 del standalone[ standalone.index( v ) ]
451 parser.values.embedded = ",".join( embedded )
452 parser.values.standalone = ",".join( standalone )
455 def check_standalone(option, opt, value, parser):
456 from optparse import OptionValueError
457 assert value is not None
458 if parser.values.embedded:
459 embedded = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.embedded ) )
462 if parser.values.standalone:
463 standalone = filter( lambda a: a.strip(), re.split( "[:;,]", parser.values.standalone ) )
466 vals = filter( lambda a: a.strip(), re.split( "[:;,]", value ) )
468 if v not in standalone_choices:
469 raise OptionValueError( "option %s: invalid choice: %r (choose from %s)" % ( opt, v, ", ".join( map( repr, standalone_choices ) ) ) )
470 if v not in standalone:
471 standalone.append( v )
473 del embedded[ embedded.index( v ) ]
475 parser.values.embedded = ",".join( embedded )
476 parser.values.standalone = ",".join( standalone )
479 def store_boolean (option, opt, value, parser, *args):
480 if isinstance(value, types.StringType):
482 value_conv = booleans[value.strip().lower()]
483 for attribute in args:
484 setattr(parser.values, attribute, value_conv)
486 raise optparse.OptionValueError(
487 "option %s: invalid boolean value: %s (choose from %s)"
488 % (opt, value, boolean_choices))
490 for attribute in args:
491 setattr(parser.values, attribute, value)
493 def CreateOptionParser (theAdditionalOptions=None):
494 if theAdditionalOptions is None:
495 theAdditionalOptions = []
496 # GUI/Terminal. Default: GUI
497 help_str = "Launch without GUI (in the terminal mode)."
498 o_t = optparse.Option("-t",
500 action="store_false",
504 help_str = "Launch in Batch Mode. (Without GUI on batch machine)"
505 o_b = optparse.Option("-b",
511 help_str = "Launch in GUI mode [default]."
512 o_g = optparse.Option("-g",
518 # Show Desktop (inly in GUI mode). Default: True
519 help_str = "1 to activate GUI desktop [default], "
520 help_str += "0 to not activate GUI desktop (Session_Server starts, but GUI is not shown). "
521 help_str += "Ignored in the terminal mode."
522 o_d = optparse.Option("-d",
525 #type="choice", choices=boolean_choices,
527 action="callback", callback=store_boolean, callback_args=('desktop',),
530 help_str = "Do not activate GUI desktop (Session_Server starts, but GUI is not shown). "
531 help_str += "The same as --show-desktop=0."
532 o_o = optparse.Option("-o",
534 action="store_false",
538 # Use logger or log-file. Default: nothing.
539 help_str = "Redirect messages to the CORBA collector."
540 #o4 = optparse.Option("-l", "--logger", action="store_true", dest="logger", help=help_str)
541 o_l = optparse.Option("-l",
543 action="store_const", const="CORBA",
546 help_str = "Redirect messages to the <log-file>"
547 o_f = optparse.Option("-f",
549 metavar="<log-file>",
555 # Configuration XML file. Default: see defaultUserFile() function
556 help_str = "Parse application settings from the <file> "
557 help_str += "instead of default %s" % defaultUserFile()
558 o_r = optparse.Option("-r",
566 # Use own xterm for each server. Default: False.
567 help_str = "Launch each SALOME server in own xterm console"
568 o_x = optparse.Option("-x",
574 # Modules. Default: Like in configuration files.
575 help_str = "SALOME modules list (where <module1>, <module2> are the names "
576 help_str += "of SALOME modules which should be available in the SALOME session)"
577 o_m = optparse.Option("-m",
579 metavar="<module1,module2,...>",
585 # Embedded servers. Default: Like in configuration files.
586 help_str = "CORBA servers to be launched in the Session embedded mode. "
587 help_str += "Valid values for <serverN>: %s " % ", ".join( embedded_choices )
588 help_str += "[by default the value from the configuration files is used]"
589 o_e = optparse.Option("-e",
591 metavar="<server1,server2,...>",
595 callback=check_embedded,
598 # Standalone servers. Default: Like in configuration files.
599 help_str = "CORBA servers to be launched in the standalone mode (as separate processes). "
600 help_str += "Valid values for <serverN>: %s " % ", ".join( standalone_choices )
601 help_str += "[by default the value from the configuration files is used]"
602 o_s = optparse.Option("-s",
604 metavar="<server1,server2,...>",
608 callback=check_standalone,
611 # Kill with port. Default: False.
612 help_str = "Kill SALOME with the current port"
613 o_p = optparse.Option("-p",
619 # Kill all. Default: False.
620 help_str = "Kill all running SALOME sessions"
621 o_k = optparse.Option("-k",
627 # Additional python interpreters. Default: 0.
628 help_str = "The number of additional external python interpreters to run. "
629 help_str += "Each additional python interpreter is run in separate "
630 help_str += "xterm session with properly set SALOME environment"
631 o_i = optparse.Option("-i",
639 # Splash. Default: True.
640 help_str = "1 to display splash screen [default], "
641 help_str += "0 to disable splash screen. "
642 help_str += "This option is ignored in the terminal mode. "
643 help_str += "It is also ignored if --show-desktop=0 option is used."
644 o_z = optparse.Option("-z",
647 #type="choice", choices=boolean_choices,
649 action="callback", callback=store_boolean, callback_args=('splash',),
653 # Catch exceptions. Default: True.
654 help_str = "1 (yes,true,on,ok) to enable centralized exception handling [default], "
655 help_str += "0 (no,false,off,cancel) to disable centralized exception handling."
656 o_c = optparse.Option("-c",
657 "--catch-exceptions",
659 #type="choice", choices=boolean_choices,
661 action="callback", callback=store_boolean, callback_args=('catch_exceptions',),
662 dest="catch_exceptions",
665 # Print free port and exit
666 help_str = "Print free port and exit"
667 o_a = optparse.Option("--print-port",
669 dest="print_port", default=False,
672 # Do not relink ${HOME}/.omniORB_last.cfg
673 help_str = "Do not save current configuration ${HOME}/.omniORB_last.cfg"
674 o_n = optparse.Option("--nosave-config",
675 action="store_false",
676 dest="save_config", default=True,
679 # Launch with interactive python console. Default: False.
680 help_str = "Launch with interactive python console."
681 o_pi = optparse.Option("--pinter",
686 # Print Naming service port into a user file. Default: False.
687 help_str = "Print Naming Service Port into a user file."
688 o_nspl = optparse.Option("--ns-port-log",
689 metavar="<ns_port_log_file>",
692 dest="ns_port_log_file",
695 # Write/read test script file with help of TestRecorder. Default: False.
696 help_str = "Write/read test script file with help of TestRecorder."
697 o_test = optparse.Option("--test",
698 metavar="<test_script_file>",
701 dest="test_script_file",
704 # Reproducing test script with help of TestRecorder. Default: False.
705 help_str = "Reproducing test script with help of TestRecorder."
706 o_play = optparse.Option("--play",
707 metavar="<play_script_file>",
710 dest="play_script_file",
714 help_str = "Launch session with gdb"
715 o_gdb = optparse.Option("--gdb-session",
717 dest="gdb_session", default=False,
721 help_str = "Launch session with ddd"
722 o_ddd = optparse.Option("--ddd-session",
724 dest="ddd_session", default=False,
729 help_str = "Launch session with valgrind $VALGRIND_OPTIONS"
730 o_valgrind = optparse.Option("--valgrind-session",
732 dest="valgrind_session", default=False,
735 # shutdown-servers. Default: False.
736 help_str = "1 to shutdown standalone servers when leaving python interpreter, "
737 help_str += "0 to keep the standalone servers as daemon [default]. "
738 help_str += "This option is only useful in batchmode "
739 help_str += "(terminal mode or without showing desktop)."
740 o_shutdown = optparse.Option("-w",
741 "--shutdown-servers",
743 #type="choice", choices=boolean_choices,
745 action="callback", callback=store_boolean, callback_args=('shutdown_servers',),
746 dest="shutdown_servers",
749 # foreground. Default: True.
750 help_str = "0 and runSalome exits after have launched the gui, "
751 help_str += "1 to launch runSalome in foreground mode [default]."
752 o_foreground = optparse.Option("--foreground",
754 #type="choice", choices=boolean_choices,
756 action="callback", callback=store_boolean, callback_args=('foreground',),
761 help_str = "Wake up a previously closed session. "
762 help_str += "The session object is found in the naming service pointed by the variable OMNIORB_CONFIG. "
763 help_str += "If this variable is not setted, the last configuration is taken. "
764 o_wake_up = optparse.Option("--wake-up-session",
766 dest="wake_up_session", default=False,
770 help_str = "Mode used to launch server processes (daemon or fork)."
771 o_slm = optparse.Option("--server-launch-mode",
772 metavar="<server_launch_mode>",
774 choices=["daemon","fork"],
776 dest="server_launch_mode",
780 help_str = "Preferable port SALOME to be started on. "
781 help_str += "If specified port is not busy, SALOME session will start on it; "
782 help_str += "otherwise, any available port will be searched and used."
783 o_port = optparse.Option("--port",
791 help_str = "Special mode for interacting with SIMAN."
792 o_siman = optparse.Option("--siman",
798 help_str = "SIMAN study identifier."
799 o_siman_study = optparse.Option("--siman-study",
807 help_str = "SIMAN scenario identifier."
808 o_siman_scenario = optparse.Option("--siman-scenario",
812 dest="siman_scenario",
816 help_str = "SIMAN user identifier."
817 o_siman_user = optparse.Option("--siman-user",
825 opt_list = [o_t,o_g, # GUI/Terminal
828 o_l,o_f, # Use logger or log-file
829 o_r, # Configuration XML file
832 o_e, # Embedded servers
833 o_s, # Standalone servers
834 o_p, # Kill with port
836 o_i, # Additional python interpreters
838 o_c, # Catch exceptions
839 o_a, # Print free port and exit
840 o_n, # --nosave-config
841 o_pi, # Interactive python console
843 o_test, # Write/read test script file with help of TestRecorder
844 o_play, # Reproducing test script with help of TestRecorder
851 o_slm, # Server launch mode
853 o_siman, # Siman launch mode
854 o_siman_study, # Siman study
855 o_siman_scenario,# Siman scenario
856 o_siman_user, # Siman user
859 #std_options = ["gui", "desktop", "log_file", "resources",
860 # "xterm", "modules", "embedded", "standalone",
861 # "portkill", "killall", "interp", "splash",
862 # "catch_exceptions", "print_port", "save_config", "ns_port_log_file"]
864 opt_list += theAdditionalOptions
866 a_usage = """%prog [options] [STUDY_FILE] [PYTHON_FILE [args] [PYTHON_FILE [args]...]]
867 Python file arguments, if any, must be comma-separated (without blank characters) and prefixed by "args:" (without quotes), e.g. myscript.py args:arg1,arg2=val,...
869 version_str = "Salome %s" % version()
870 pars = optparse.OptionParser(usage=a_usage, version=version_str, option_list=opt_list)
874 # -----------------------------------------------------------------------------
877 # Get the environment
880 # this attribute is obsolete
884 def get_env(theAdditionalOptions=None, appname=salomeappname, cfgname=salomecfgname):
886 # Collect launch configuration files:
887 # - The environment variable "<appname>Config" (SalomeAppConfig) which can
888 # define a list of directories (separated by ':' or ';' symbol) is checked
889 # - If the environment variable "<appname>Config" is not set, only
890 # ${GUI_ROOT_DIR}/share/salome/resources/gui is inspected
891 # - ${GUI_ROOT_DIR}/share/salome/resources/gui directory is always inspected
892 # so it is not necessary to put it in the "<appname>Config" variable
893 # - The directories which are inspected are checked for files "<appname?salomeappname>.xml"
894 # (SalomeApp.xml) which define SALOME configuration
895 # - These directories are analyzed beginning from the last one in the list,
896 # so the first directory listed in "<appname>Config" environment variable
897 # has higher priority: it means that if some configuration options
898 # is found in the next analyzed cofiguration file - it will be replaced
899 # - The last configuration file which is parsed is user configuration file
900 # situated in the home directory (if it exists):
901 # * ~/.config/salome/.<appname>rc[.<version>]" for Linux (e.g. ~/.config/salome/.SalomeApprc.6.4.0)
902 # * ~/<appname>.xml[.<version>] for Windows (e.g. ~/SalomeApp.xml.6.4.0)
903 # - Command line options have the highest priority and replace options
904 # specified in configuration file(s)
907 if theAdditionalOptions is None:
908 theAdditionalOptions = []
911 config_var = appname+'Config'
913 # check KERNEL_ROOT_DIR
914 kernel_root_dir = os.environ.get("KERNEL_ROOT_DIR", None)
915 if kernel_root_dir is None:
917 For each SALOME module, the environment variable <moduleN>_ROOT_DIR must be set.
918 KERNEL_ROOT_DIR is mandatory.
922 ############################
923 # parse command line options
924 pars = CreateOptionParser(theAdditionalOptions)
925 (cmd_opts, cmd_args) = pars.parse_args(sys.argv[1:])
926 ############################
928 # Process --print-port option
929 if cmd_opts.print_port:
930 from searchFreePort import searchFreePort
932 print "port:%s"%(os.environ['NSPORT'])
936 PortManager.releasePort(os.environ['NSPORT'])
943 # set resources variable SalomeAppConfig if it is not set yet
945 if os.getenv(config_var):
946 if sys.platform == 'win32':
947 dirs += re.split(os.pathsep, os.getenv(config_var))
949 dirs += re.split('[;|:]', os.getenv(config_var))
951 gui_available = False
952 if os.getenv("GUI_ROOT_DIR"):
953 gui_resources_dir = os.path.join(os.getenv("GUI_ROOT_DIR"),'share','salome','resources','gui')
954 if os.path.isdir( gui_resources_dir ):
956 dirs.append(gui_resources_dir)
958 if not gui_available:
959 kernel_resources_dir = os.path.join(os.getenv("KERNEL_ROOT_DIR"),'bin','salome','appliskel')
960 if os.getenv("KERNEL_ROOT_DIR") and os.path.isdir( kernel_resources_dir ):
961 dirs.append(kernel_resources_dir)
963 os.environ[config_var] = os.pathsep.join(dirs)
965 dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
968 dirs.remove('') # to remove empty dirs if the variable terminate by ":" or if there are "::" inside
972 _opts = {} # associative array of options to be filled
974 # parse SalomeApp.xml files in directories specified by SalomeAppConfig env variable
976 filename = os.path.join(dir, appname+'.xml')
977 if not os.path.exists(filename):
978 if verbose(): print "Configure parser: Warning : can not find configuration file %s" % filename
981 p = xml_parser(filename, _opts, [])
984 if verbose(): print "Configure parser: Error : can not read configuration file %s" % filename
987 # parse user configuration file
988 # It can be set via --resources=<file> command line option
989 # or is given from default location (see defaultUserFile() function)
990 # If user file for the current version is not found the nearest to it is used
991 user_config = cmd_opts.resources
993 user_config = userFile(appname, cfgname)
994 if verbose(): print "Configure parser: user configuration file is", user_config
995 if not user_config or not os.path.exists(user_config):
996 if verbose(): print "Configure parser: Warning : can not find user configuration file"
999 p = xml_parser(user_config, _opts, [])
1002 if verbose(): print 'Configure parser: Error : can not read user configuration file'
1007 args['user_config'] = user_config
1008 #print "User Configuration file: ", args['user_config']
1010 # set default values for options which are NOT set in config files
1011 for aKey in listKeys:
1012 if not args.has_key( aKey ):
1015 for aKey in boolKeys:
1016 if not args.has_key( aKey ):
1020 afile=args[file_nam]
1021 args[file_nam] = [afile]
1023 args[appname_nam] = appname
1025 # get the port number
1026 my_port = getPortNumber()
1028 args[port_nam] = my_port
1030 ####################################################
1031 # apply command-line options to the arguments
1032 # each option given in command line overrides the option from xml config file
1034 # Options: gui, desktop, log_file, resources,
1035 # xterm, modules, embedded, standalone,
1036 # portkill, killall, interp, splash,
1037 # catch_exceptions, pinter
1039 # GUI/Terminal, Desktop, Splash, STUDY_HDF
1040 args["session_gui"] = False
1041 args[batch_nam] = False
1042 args["study_hdf"] = None
1043 if cmd_opts.gui is not None:
1044 args[gui_nam] = cmd_opts.gui
1045 if cmd_opts.batch is not None:
1046 args[batch_nam] = True
1048 if not gui_available:
1049 args[gui_nam] = False
1052 args["session_gui"] = True
1053 if cmd_opts.desktop is not None:
1054 args["session_gui"] = cmd_opts.desktop
1055 args[splash_nam] = cmd_opts.desktop
1056 if args["session_gui"]:
1057 if cmd_opts.splash is not None:
1058 args[splash_nam] = cmd_opts.splash
1060 args["session_gui"] = False
1061 args[splash_nam] = False
1064 if cmd_opts.log_file is not None:
1065 if cmd_opts.log_file == 'CORBA':
1066 args[logger_nam] = True
1068 args[file_nam] = [cmd_opts.log_file]
1070 # Naming Service port log file
1071 if cmd_opts.ns_port_log_file is not None:
1072 args["ns_port_log_file"] = cmd_opts.ns_port_log_file
1075 for arg in cmd_args:
1076 if arg[-4:] == ".hdf" and not args["study_hdf"]:
1077 args["study_hdf"] = arg
1080 from salomeContextUtils import getScriptsAndArgs, ScriptAndArgs
1081 args[script_nam] = getScriptsAndArgs(cmd_args)
1082 if args[gui_nam] and args["session_gui"]:
1084 for sa_obj in args[script_nam]: # args[script_nam] is a list of ScriptAndArgs objects
1085 script = re.sub(r'^python.*\s+', r'', sa_obj.script)
1086 new_args.append(ScriptAndArgs(script=script, args=sa_obj.args, out=sa_obj.out))
1088 args[script_nam] = new_args
1091 if cmd_opts.xterm is not None: args[xterm_nam] = cmd_opts.xterm
1094 if cmd_opts.modules is not None:
1095 args[modules_nam] = []
1096 listlist = cmd_opts.modules
1097 for listi in listlist:
1098 args[modules_nam] += re.split( "[:;,]", listi)
1100 # if --modules (-m) command line option is not given
1101 # try SALOME_MODULES environment variable
1102 if os.getenv( "SALOME_MODULES" ):
1103 args[modules_nam] = re.split( "[:;,]", os.getenv( "SALOME_MODULES" ) )
1107 if cmd_opts.embedded is not None:
1108 args[embedded_nam] = filter( lambda a: a.strip(), re.split( "[:;,]", cmd_opts.embedded ) )
1111 if cmd_opts.standalone is not None:
1112 args[standalone_nam] = filter( lambda a: a.strip(), re.split( "[:;,]", cmd_opts.standalone ) )
1114 # Normalize the '--standalone' and '--embedded' parameters
1115 standalone, embedded = process_containers_params( args.get( standalone_nam ),
1116 args.get( embedded_nam ) )
1117 if standalone is not None:
1118 args[ standalone_nam ] = standalone
1119 if embedded is not None:
1120 args[ embedded_nam ] = embedded
1123 if cmd_opts.portkill is not None: args[portkill_nam] = cmd_opts.portkill
1124 if cmd_opts.killall is not None: args[killall_nam] = cmd_opts.killall
1127 if cmd_opts.interp is not None:
1128 args[interp_nam] = cmd_opts.interp
1131 if cmd_opts.catch_exceptions is not None:
1132 args[except_nam] = not cmd_opts.catch_exceptions
1134 # Relink config file
1135 if cmd_opts.save_config is not None:
1136 args['save_config'] = cmd_opts.save_config
1138 # Interactive python console
1139 if cmd_opts.pinter is not None:
1140 args[pinter_nam] = cmd_opts.pinter
1142 # Gdb session in xterm
1143 if cmd_opts.gdb_session is not None:
1144 args[gdb_session_nam] = cmd_opts.gdb_session
1146 # Ddd session in xterm
1147 if cmd_opts.ddd_session is not None:
1148 args[ddd_session_nam] = cmd_opts.ddd_session
1151 if cmd_opts.valgrind_session is not None:
1152 args[valgrind_session_nam] = cmd_opts.valgrind_session
1155 if cmd_opts.shutdown_servers is None:
1156 args[shutdown_servers_nam] = 0
1158 args[shutdown_servers_nam] = cmd_opts.shutdown_servers
1162 if cmd_opts.foreground is None:
1163 args[foreground_nam] = 1
1165 args[foreground_nam] = cmd_opts.foreground
1169 if cmd_opts.wake_up_session is not None:
1170 args[wake_up_session_nam] = cmd_opts.wake_up_session
1173 if cmd_opts.siman is not None:
1174 args[siman_nam] = cmd_opts.siman
1175 if cmd_opts.siman_study is not None:
1176 args[siman_study_nam] = cmd_opts.siman_study
1177 if cmd_opts.siman_scenario is not None:
1178 args[siman_scenario_nam] = cmd_opts.siman_scenario
1179 if cmd_opts.siman_user is not None:
1180 args[siman_user_nam] = cmd_opts.siman_user
1182 ####################################################
1183 # Add <theAdditionalOptions> values to args
1184 for add_opt in theAdditionalOptions:
1185 cmd = "args[\"{0}\"] = cmd_opts.{0}".format(add_opt.dest)
1187 ####################################################
1189 # disable signals handling
1190 if args[except_nam] == 1:
1191 os.environ["NOT_INTERCEPT_SIGNALS"] = "1"
1194 # now modify SalomeAppConfig environment variable
1195 # to take into account the SALOME modules
1196 if os.sys.platform == 'win32':
1197 dirs = re.split('[;]', os.environ[config_var] )
1199 dirs = re.split('[;|:]', os.environ[config_var] )
1200 for module in args[modules_nam]:
1201 if module not in ["KERNEL", "GUI", ""] and os.getenv("{0}_ROOT_DIR".format(module)):
1202 d1 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources",module.lower())
1203 d2 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources")
1204 #if os.path.exists( "%s/%s.xml"%(d1, appname) ):
1205 if os.path.exists( os.path.join(d1,"{0}.xml".format(salomeappname)) ):
1207 #elif os.path.exists( "%s/%s.xml"%(d2, appname) ):
1208 elif os.path.exists( os.path.join(d2,"{0}.xml".format(salomeappname)) ):
1211 #print "* '"+m+"' should be deleted from ",args[modules_nam]
1215 if cmd_opts.test_script_file is not None:
1217 filename = cmd_opts.test_script_file
1218 args[test_nam] += re.split( "[:;,]", filename )
1221 if cmd_opts.play_script_file is not None:
1223 filename = cmd_opts.play_script_file
1224 args[play_nam] += re.split( "[:;,]", filename )
1226 # Server launch command
1227 if cmd_opts.server_launch_mode is not None:
1228 args["server_launch_mode"] = cmd_opts.server_launch_mode
1230 # Server launch command
1231 if cmd_opts.use_port is not None:
1233 max_port = min_port + 100
1234 if cmd_opts.use_port not in xrange(min_port, max_port+1):
1235 print "Error: port number should be in range [%d, %d])" % (min_port, max_port)
1237 args[useport_nam] = cmd_opts.use_port
1240 os.environ[config_var] = os.pathsep.join(dirs)
1241 #print "Args: ", args