# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
#
# Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
-# version 2.1 of the License.
+# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
import optparse
import types
-from salome_utils import verbose, setVerbose, getPortNumber, getHomeDir
+from salome_utils import verbose, getPortNumber, getHomeDir
+
+from salomeContextUtils import getScriptsAndArgs
# names of tags in XML configuration file
doc_tag = "document"
shutdown_servers_nam = "shutdown_servers"
foreground_nam = "foreground"
wake_up_session_nam = "wake_up_session"
+siman_nam = "siman"
+siman_study_nam = "siman_study"
+siman_scenario_nam = "siman_scenario"
+siman_user_nam = "siman_user"
# values in XML configuration file giving specific module parameters (<module_name> section)
# which are stored in opts with key <module_name>_<parameter> (eg SMESH_plugins)
# values passed as arguments, NOT read from XML config file, but set from within this script
appname_nam = "appname"
port_nam = "port"
+useport_nam = "useport"
salomecfgname = "salome"
salomeappname = "SalomeApp"
script_nam = "pyscript"
# possible choices for the "embedded" and "standalone" parameters
embedded_choices = [ "registry", "study", "moduleCatalog", "cppContainer", "SalomeAppEngine" ]
-standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer", "pyContainer"]
+standalone_choices = [ "registry", "study", "moduleCatalog", "cppContainer"]
# values of boolean type (must be '0' or '1').
# xml_parser.boolValue() is used for correct setting
try:
filename = None
root_dir = os.environ.get( 'KERNEL_ROOT_DIR', '' ) # KERNEL_ROOT_DIR or "" if not found
- if root_dir and os.path.exists( root_dir + "/bin/salome/VERSION" ):
- filename = root_dir + "/bin/salome/VERSION"
+ version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
+ if root_dir and os.path.exists( version_file ):
+ filename = version_file
root_dir = os.environ.get( 'GUI_ROOT_DIR', '' ) # GUI_ROOT_DIR "" if not found
- if root_dir and os.path.exists( root_dir + "/bin/salome/VERSION" ):
- filename = root_dir + "/bin/salome/VERSION"
+ version_file = os.path.join(root_dir, 'bin', 'salome', 'VERSION')
+ if root_dir and os.path.exists( version_file ):
+ filename = version_file
if filename:
str = open( filename, "r" ).readline() # str = "THIS IS SALOME - SALOMEGUI VERSION: 3.0.0"
match = re.search( r':\s+([a-zA-Z0-9.]+)\s*$', str )
major = minor = release = dev1 = dev2 = 0
vers = fname.split(".")
if len(vers) > 0: major = int(vers[0])
- if len(vers) > 1: minor = int(vers[1])
+ try:
+ if len(vers) > 1: minor = int(vers[1])
+ except ValueError:
+ # If salome version given is 7.DEV, the call to int('DEV') will fail with
+ # a ValueError exception
+ pass
if len(vers) > 2:
mr = re.search(r'^([0-9]+)([A-Z]|RC)?([0-9]*)',vers[2], re.I)
if mr:
###
def defaultUserFile(appname=salomeappname, cfgname=salomecfgname):
v = version()
- if v: v = ".%s" % v
- if sys.platform == "win32":
- filename = os.path.join(getHomeDir(), "%s.xml%s" % (appname, v))
- else:
- if cfgname:
- filename = os.path.join(getHomeDir(), ".config", cfgname, "%src%s" % (appname, v))
- pass
- else:
- filename = os.path.join(getHomeDir(), ".%src%s" % (appname, v))
- pass
- pass
- return filename
+ filetmpl = sys.platform == "win32" and "{0}.xml.{1}" or "{0}rc.{1}"
+ paths = []
+ paths.append(getHomeDir())
+ paths.append(".config")
+ if cfgname: paths.append(cfgname)
+ paths.append(filetmpl.format(appname, v))
+ return os.path.join(*paths)
###
# Get user configuration file name
# get app version
v = version()
if not v: return None # unknown version
-
+
# get default user file name
filename = defaultUserFile(appname, cfgname)
if not filename: return None # default user file name is bad
-
+
# check that default user file exists
if os.path.exists(filename): return filename # user file is found
# ... calculate default version id
id0 = version_id(v)
if not id0: return None # bad version id -> can't detect appropriate file
-
+
# ... get all existing user preferences files
- if sys.platform == "win32":
- files = glob.glob(os.path.join(getHomeDir(), "%s.xml.*" % appname))
- else:
- files = []
- if cfgname:
- # Since v6.6.0 - in ~/.config/salome directory, without dot prefix
- files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, "%src.*" % appname))
+ filetmpl = sys.platform == "win32" and "{0}.xml.*" or "{0}rc.*"
+ files = []
+ if cfgname:
+ # Since v6.6.0 - in ~/.config/salome directory, without dot prefix
+ files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl.format(appname)))
# Since v6.5.0 - in ~/.config/salome directory, dot-prefixed (backward compatibility)
- files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, ".%src.*" % appname))
- pass
- # old style (before v6.5.0) - in ~ directory, dot-prefixed
- files += glob.glob(os.path.join(getHomeDir(), ".%src.*" % appname))
+ files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, filetmpl.format(appname)))
pass
+ # old style (before v6.5.0) - in ~ directory, dot-prefixed
+ files += glob.glob(os.path.join(getHomeDir(), filetmpl.format(appname)))
+ pass
# ... loop through all files and find most appopriate file (with closest id)
appr_id = -1
for f in files:
ff = os.path.basename( f )
if sys.platform == "win32":
- match = re.search( r'^%s\.xml\.([a-zA-Z0-9.]+)$'%appname, ff )
+ match = re.search( r'^{0}\.xml\.([a-zA-Z0-9.]+)$'.format(appname), ff )
else:
- match = re.search( r'^\.?%src\.([a-zA-Z0-9.]+)$'%appname, ff )
+ match = re.search( r'^\.?{0}rc\.([a-zA-Z0-9.]+)$'.format(appname), ff )
if match:
ver = version_id(match.group(1))
if not ver: continue # bad version id -> skip file
section_to_skip = ""
class xml_parser:
- def __init__(self, fileName, _opts, _importHistory=[] ):
+ def __init__(self, fileName, _opts, _importHistory):
+ #warning _importHistory=[] is NOT good: is NOT empty,reinitialized after first call
if verbose(): print "Configure parser: processing %s ..." % fileName
self.fileName = os.path.abspath(fileName)
self.importHistory = _importHistory
def startElement(self, name, attrs):
self.space.append(name)
self.current = None
-
+
# if we are importing file
if self.space == [doc_tag, import_tag] and nam_att in attrs.getNames():
self.importFile( attrs.getValue(nam_att) )
-
+
# if we are analyzing "section" element and its "name" attribute is
# either "launch" or module name -- set section_name
if self.space == [doc_tag, sec_tag] and nam_att in attrs.getNames():
pass
def endElement(self, name):
- p = self.space.pop()
+ self.space.pop()
self.current = None
if self.section != section_to_skip and name == sec_tag:
self.section = section_to_skip
def endDocument(self):
self.read = None
pass
-
+
def importFile(self, fname):
# get absolute name
if os.path.isabs (fname) :
absfname = fname
else:
absfname = os.path.join(os.path.dirname(self.fileName), fname)
-
+
# check existing and registry file
for ext in ["", ".xml", ".XML"] :
if os.path.exists(absfname + ext) :
else:
if verbose(): print "Configure parser: Error : file %s does not exist" % absfname
return
-
+
# importing file
try:
# copy current options
except:
if verbose(): print "Configure parser: Error : can not read configuration file %s" % absfname
pass
-
+
# -----------------------------------------------------------------------------
for attribute in args:
setattr(parser.values, attribute, value)
-def CreateOptionParser (theAdditionalOptions=[]):
+def CreateOptionParser (theAdditionalOptions=None):
+ if theAdditionalOptions is None:
+ theAdditionalOptions = []
# GUI/Terminal. Default: GUI
help_str = "Launch without GUI (in the terminal mode)."
o_t = optparse.Option("-t",
dest="log_file",
help=help_str)
- # Execute python scripts. Default: None.
- help_str = "Python script(s) to be imported. Python scripts are imported "
- help_str += "in the order of their appearance. In GUI mode python scripts "
- help_str += "are imported in the embedded python interpreter of current study, "
- help_str += "otherwise in an external python interpreter. "
- help_str += "Note: this option is obsolete. Instead you can pass Python script(s) "
- help_str += "directly as positional parameter."
- o_u = optparse.Option("-u",
- "--execute",
- metavar="<script1,script2,...>",
- type="string",
- action="append",
- dest="py_scripts",
- help=help_str)
-
# Configuration XML file. Default: see defaultUserFile() function
help_str = "Parse application settings from the <file> "
help_str += "instead of default %s" % defaultUserFile()
help_str += "0 to keep the standalone servers as daemon [default]. "
help_str += "This option is only useful in batchmode "
help_str += "(terminal mode or without showing desktop)."
- o_shutdown = optparse.Option("--shutdown-servers",
+ o_shutdown = optparse.Option("-w",
+ "--shutdown-servers",
metavar="<1/0>",
#type="choice", choices=boolean_choices,
type="string",
dest="server_launch_mode",
help=help_str)
+ # use port
+ help_str = "Preferable port SALOME to be started on. "
+ help_str += "If specified port is not busy, SALOME session will start on it; "
+ help_str += "otherwise, any available port will be searched and used."
+ o_port = optparse.Option("--port",
+ metavar="<port>",
+ type="int",
+ action="store",
+ dest="use_port",
+ help=help_str)
+
+ # SIMAN launch mode
+ help_str = "Special mode for interacting with SIMAN."
+ o_siman = optparse.Option("--siman",
+ action="store_true",
+ dest="siman",
+ help=help_str)
+
+ # SIMAN study
+ help_str = "SIMAN study identifier."
+ o_siman_study = optparse.Option("--siman-study",
+ metavar="<id>",
+ type="string",
+ action="store",
+ dest="siman_study",
+ help=help_str)
+
+ # SIMAN scenario
+ help_str = "SIMAN scenario identifier."
+ o_siman_scenario = optparse.Option("--siman-scenario",
+ metavar="<id>",
+ type="string",
+ action="store",
+ dest="siman_scenario",
+ help=help_str)
+
+ # SIMAN user
+ help_str = "SIMAN user identifier."
+ o_siman_user = optparse.Option("--siman-user",
+ metavar="<id>",
+ type="string",
+ action="store",
+ dest="siman_user",
+ help=help_str)
+
# All options
opt_list = [o_t,o_g, # GUI/Terminal
o_d,o_o, # Desktop
o_b, # Batch
o_l,o_f, # Use logger or log-file
- o_u, # Execute python scripts
o_r, # Configuration XML file
o_x, # xterm
o_m, # Modules
o_foreground,
o_wake_up,
o_slm, # Server launch mode
+ o_port, # Use port
+ o_siman, # Siman launch mode
+ o_siman_study, # Siman study
+ o_siman_scenario,# Siman scenario
+ o_siman_user, # Siman user
]
- #std_options = ["gui", "desktop", "log_file", "py_scripts", "resources",
+ #std_options = ["gui", "desktop", "log_file", "resources",
# "xterm", "modules", "embedded", "standalone",
# "portkill", "killall", "interp", "splash",
# "catch_exceptions", "print_port", "save_config", "ns_port_log_file"]
opt_list += theAdditionalOptions
- a_usage = "%prog [options] [STUDY_FILE] [PYTHON_FILE [PYTHON_FILE ...]]"
+ a_usage = """%prog [options] [STUDY_FILE] [PYTHON_FILE [args] [PYTHON_FILE [args]...]]
+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,...
+"""
version_str = "Salome %s" % version()
pars = optparse.OptionParser(usage=a_usage, version=version_str, option_list=opt_list)
args = {}
#def get_env():
#args = []
-def get_env(theAdditionalOptions=[], appname=salomeappname, cfgname=salomecfgname):
+def get_env(theAdditionalOptions=None, appname=salomeappname, cfgname=salomecfgname):
###
# Collect launch configuration files:
# - The environment variable "<appname>Config" (SalomeAppConfig) which can
# specified in configuration file(s)
###
+ if theAdditionalOptions is None:
+ theAdditionalOptions = []
+
global args
config_var = appname+'Config'
- separator = ":"
- if os.sys.platform == 'win32':
- separator = ";"
-
# check KERNEL_ROOT_DIR
- try:
- kernel_root_dir=os.environ["KERNEL_ROOT_DIR"]
- except:
+ kernel_root_dir = os.environ.get("KERNEL_ROOT_DIR", None)
+ if kernel_root_dir is None:
print """
For each SALOME module, the environment variable <moduleN>_ROOT_DIR must be set.
KERNEL_ROOT_DIR is mandatory.
"""
sys.exit(1)
- pass
############################
# parse command line options
# Process --print-port option
if cmd_opts.print_port:
- from runSalome import searchFreePort
+ from searchFreePort import searchFreePort
searchFreePort({})
print "port:%s"%(os.environ['NSPORT'])
+
+ try:
+ import PortManager
+ PortManager.releasePort(os.environ['NSPORT'])
+ except ImportError:
+ pass
+
sys.exit(0)
pass
dirs = []
if os.getenv(config_var):
if sys.platform == 'win32':
- dirs += re.split(';', os.getenv(config_var))
+ dirs += re.split(os.pathsep, os.getenv(config_var))
else:
dirs += re.split('[;|:]', os.getenv(config_var))
gui_available = True
- if os.getenv("GUI_ROOT_DIR") and os.path.isdir( os.getenv("GUI_ROOT_DIR") + "/share/salome/resources/gui" ):
- dirs += [os.getenv("GUI_ROOT_DIR") + "/share/salome/resources/gui"]
+ gui_resources_dir = os.path.join(os.getenv("GUI_ROOT_DIR"),'share','salome','resources','gui')
+ if os.getenv("GUI_ROOT_DIR") and os.path.isdir( gui_resources_dir ):
+ dirs.append(gui_resources_dir)
pass
else:
gui_available = False
- if os.getenv("KERNEL_ROOT_DIR") and os.path.isdir( os.getenv("KERNEL_ROOT_DIR") + "/bin/salome/appliskel" ):
- dirs += [os.getenv("KERNEL_ROOT_DIR") + "/bin/salome/appliskel"]
+ kernel_resources_dir = os.path.join(os.getenv("KERNEL_ROOT_DIR"),'bin','salome','appliskel')
+ if os.getenv("KERNEL_ROOT_DIR") and os.path.isdir( kernel_resources_dir ):
+ dirs.append(kernel_resources_dir)
pass
- os.environ[config_var] = separator.join(dirs)
+ os.environ[config_var] = os.pathsep.join(dirs)
dirs.reverse() # reverse order, like in "path" variable - FILO-style processing
if verbose(): print "Configure parser: Warning : can not find configuration file %s" % filename
else:
try:
- p = xml_parser(filename, _opts)
+ p = xml_parser(filename, _opts, [])
_opts = p.opts
except:
if verbose(): print "Configure parser: Error : can not read configuration file %s" % filename
if verbose(): print "Configure parser: Warning : can not find user configuration file"
else:
try:
- p = xml_parser(user_config, _opts)
+ p = xml_parser(user_config, _opts, [])
_opts = p.opts
except:
if verbose(): print 'Configure parser: Error : can not read user configuration file'
# set default values for options which are NOT set in config files
for aKey in listKeys:
if not args.has_key( aKey ):
- args[aKey]=[]
+ args[aKey] = []
for aKey in boolKeys:
if not args.has_key( aKey ):
- args[aKey]=0
+ args[aKey] = 0
if args[file_nam]:
afile=args[file_nam]
- args[file_nam]=[afile]
+ args[file_nam] = [afile]
args[appname_nam] = appname
# apply command-line options to the arguments
# each option given in command line overrides the option from xml config file
#
- # Options: gui, desktop, log_file, py_scripts, resources,
+ # Options: gui, desktop, log_file, resources,
# xterm, modules, embedded, standalone,
# portkill, killall, interp, splash,
# catch_exceptions, pinter
if cmd_opts.ns_port_log_file is not None:
args["ns_port_log_file"] = cmd_opts.ns_port_log_file
- # Python scripts
- args[script_nam] = []
- if cmd_opts.py_scripts is not None:
- listlist = cmd_opts.py_scripts
- for listi in listlist:
- if os.sys.platform == 'win32':
- args[script_nam] += re.split( "[;,]", listi)
- else:
- args[script_nam] += re.split( "[:;,]", listi)
+ # Study files
for arg in cmd_args:
- if arg[-3:] == ".py":
- args[script_nam].append(arg)
- elif not args["study_hdf"]:
+ if arg[-4:] == ".hdf" and not args["study_hdf"]:
args["study_hdf"] = arg
- pass
- pass
+
+ # Python scripts
+ args[script_nam] = getScriptsAndArgs(cmd_args)
+ new_args = []
+ if args[gui_nam] and args["session_gui"]:
+ from salomeContextUtils import ScriptAndArgs
+ for sa_obj in args[script_nam]: # args[script_nam] is a list of ScriptAndArgs objects
+ script = re.sub(r'^python.*\s+', r'', sa_obj.script)
+ new_args.append(ScriptAndArgs(script=script, args=sa_obj.args, out=sa_obj.out))
+ #
+ args[script_nam] = new_args
# xterm
if cmd_opts.xterm is not None: args[xterm_nam] = cmd_opts.xterm
if cmd_opts.wake_up_session is not None:
args[wake_up_session_nam] = cmd_opts.wake_up_session
+ # siman options
+ if cmd_opts.siman is not None:
+ args[siman_nam] = cmd_opts.siman
+ if cmd_opts.siman_study is not None:
+ args[siman_study_nam] = cmd_opts.siman_study
+ if cmd_opts.siman_scenario is not None:
+ args[siman_scenario_nam] = cmd_opts.siman_scenario
+ if cmd_opts.siman_user is not None:
+ args[siman_user_nam] = cmd_opts.siman_user
+
####################################################
# Add <theAdditionalOptions> values to args
for add_opt in theAdditionalOptions:
- cmd = "args[\"%s\"] = cmd_opts.%s"%(add_opt.dest,add_opt.dest)
+ cmd = "args[\"{0}\"] = cmd_opts.{0}".format(add_opt.dest)
exec(cmd)
####################################################
dirs = re.split('[;]', os.environ[config_var] )
else:
dirs = re.split('[;|:]', os.environ[config_var] )
- for m in args[modules_nam]:
- if m not in ["KERNEL", "GUI", ""] and os.getenv("%s_ROOT_DIR"%m):
- d1 = os.getenv("%s_ROOT_DIR"%m) + "/share/salome/resources/" + m.lower()
- d2 = os.getenv("%s_ROOT_DIR"%m) + "/share/salome/resources"
+ for module in args[modules_nam]:
+ if module not in ["KERNEL", "GUI", ""] and os.getenv("{0}_ROOT_DIR".format(module)):
+ d1 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources",module.lower())
+ d2 = os.path.join(os.getenv("{0}_ROOT_DIR".format(module)),"share","salome","resources")
#if os.path.exists( "%s/%s.xml"%(d1, appname) ):
- if os.path.exists( "%s/%s.xml"%(d1, salomeappname) ):
+ if os.path.exists( os.path.join(d1,"{0}.xml".format(salomeappname)) ):
dirs.append( d1 )
#elif os.path.exists( "%s/%s.xml"%(d2, appname) ):
- elif os.path.exists( "%s/%s.xml"%(d2, salomeappname) ):
+ elif os.path.exists( os.path.join(d2,"{0}.xml".format(salomeappname)) ):
dirs.append( d2 )
+ else:
+ #print "* '"+m+"' should be deleted from ",args[modules_nam]
+ pass
# Test
if cmd_opts.test_script_file is not None:
# Server launch command
if cmd_opts.server_launch_mode is not None:
- args["server_launch_mode"] = cmd_opts.server_launch_mode
+ args["server_launch_mode"] = cmd_opts.server_launch_mode
+
+ # Server launch command
+ if cmd_opts.use_port is not None:
+ min_port = 2810
+ max_port = min_port + 100
+ if cmd_opts.use_port not in xrange(min_port, max_port+1):
+ print "Error: port number should be in range [%d, %d])" % (min_port, max_port)
+ sys.exit(1)
+ args[useport_nam] = cmd_opts.use_port
# return arguments
- os.environ[config_var] = separator.join(dirs)
+ os.environ[config_var] = os.pathsep.join(dirs)
#print "Args: ", args
return args
