# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2011 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
+# 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.
+# 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.
#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
-# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
import os, glob, string, sys, re
import optparse
import types
+from salome_utils import verbose, setVerbose, getPortNumber, getHomeDir
+
# names of tags in XML configuration file
doc_tag = "document"
sec_tag = "section"
par_tag = "parameter"
+import_tag = "import"
# names of attributes in XML configuration file
nam_att = "name"
ddd_session_nam = "ddd_session"
valgrind_session_nam = "valgrind_session"
shutdown_servers_nam = "shutdown_servers"
+foreground_nam = "foreground"
+wake_up_session_nam = "wake_up_session"
# 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"
+salomecfgname = "salome"
salomeappname = "SalomeApp"
script_nam = "pyscript"
# Calculate and return configuration file unique ID
# For example: for SALOME version 3.1.0a1 the id is 300999701
###
-def version_id( fname ):
+def version_id(fname):
+ major = minor = release = dev1 = dev2 = 0
vers = fname.split(".")
- major = int(vers[0])
- minor = int(vers[1])
- mr = re.search(r'^([0-9]+)([A-Za-z]?)([0-9]*)',vers[2])
- release = dev = 0
- if mr:
- release = int(mr.group(1))
- dev1 = dev2 = 0
- if len(mr.group(2)): dev1 = ord(mr.group(2))
- if len(mr.group(3)): dev2 = int(mr.group(3))
- dev = dev1 * 100 + dev2
- else:
- return None
+ if len(vers) > 0: major = int(vers[0])
+ if len(vers) > 1: minor = int(vers[1])
+ if len(vers) > 2:
+ mr = re.search(r'^([0-9]+)([A-Za-z]?)([0-9]*)',vers[2])
+ if mr:
+ release = int(mr.group(1))
+ if mr.group(2).strip(): dev1 = ord(mr.group(2).strip())
+ if mr.group(3).strip(): dev2 = int(mr.group(3).strip())
+ pass
+ pass
+ dev = dev1 * 100 + dev2
ver = major
ver = ver * 100 + minor
ver = ver * 100 + release
return ver
###
-# Get user configuration file name
+# Get default user configuration file name
+# For SALOME, it is:
+# - on Linux: ~/.config/salome/.SalomeApprc.[version]
+# - on Windows: ~/SalomeApp.xml.[version]
+# where [version] is a version number
###
-def userFile(appname):
+def defaultUserFile(appname=salomeappname, cfgname=salomecfgname):
v = version()
- if not v:
- return "" # not unknown version
+ if v: v = ".%s" % v
if sys.platform == "win32":
- filename = "%s\%s.xml.%s" % (os.environ['HOME'], appname, v)
+ filename = os.path.join(getHomeDir(), "%s.xml%s" % (appname, v))
else:
- filename = "%s/.%src.%s" % (os.environ['HOME'], appname, v)
- if os.path.exists(filename):
- return filename # user preferences file for the current version exists
- # initial id
- id0 = version_id( v )
- # get all existing user preferences files
+ 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
+
+###
+# Get user configuration file name
+###
+def userFile(appname, cfgname):
+ # 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
+
+ # otherwise try to detect any appropriate user file
+
+ # ... 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.environ['HOME'] + "\." + appname + ".xml.*" )
+ files = glob.glob(os.path.join(getHomeDir(), "%s.xml.*" % appname))
else:
- files = glob.glob( os.environ['HOME'] + "/." + appname + "rc.*" )
- f2v = {}
- for file in files:
- match = re.search( r'\.%src\.([a-zA-Z0-9.]+)$'%appname, file )
- if match: f2v[file] = match.group(1)
- last_file = ""
- last_version = 0
- for file in f2v:
- ver = version_id( f2v[file] )
- if ver and abs(last_version-id0) > abs(ver-id0):
- last_version = ver
- last_file = file
- return last_file
-
-# --
-
-_verbose = None
-
-def verbose():
- global _verbose
- # verbose has already been called
- if _verbose is not None:
- return _verbose
- # first time
- try:
- from os import getenv
- _verbose = int(getenv('SALOME_VERBOSE'))
- except:
- _verbose = 0
+ files = []
+ if cfgname: files += glob.glob(os.path.join(getHomeDir(), ".config", cfgname, ".%src.*" % appname))
+ files += glob.glob(os.path.join(getHomeDir(), ".%src.*" % appname))
pass
- #
- return _verbose
-def setVerbose(level):
- global _verbose
- _verbose = level
- return
+ # ... loop through all files and find most appopriate file (with closest id)
+ appr_id = -1
+ appr_file = ""
+ for f in files:
+ if sys.platform == "win32":
+ match = re.search( r'%s\.xml\.([a-zA-Z0-9.]+)$'%appname, f )
+ else:
+ match = re.search( r'\.%src\.([a-zA-Z0-9.]+)$'%appname, f )
+ if match:
+ ver = version_id(match.group(1))
+ if not ver: continue # bad version id -> skip file
+ if appr_id < 0 or abs(appr_id-id0) > abs(ver-id0):
+ appr_id = ver
+ appr_file = f
+ pass
+ pass
+ pass
+ return appr_file
# --
section_to_skip = ""
class xml_parser:
- def __init__(self, fileName, _opts ):
+ def __init__(self, fileName, _opts, _importHistory=[] ):
if verbose(): print "Configure parser: processing %s ..." % fileName
+ self.fileName = os.path.abspath(fileName)
+ self.importHistory = _importHistory
+ self.importHistory.append(self.fileName)
self.space = []
self.opts = _opts
self.section = section_to_skip
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():
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) :
+ absfname += ext
+ if absfname in self.importHistory :
+ if verbose(): print "Configure parser: Warning : file %s is already imported" % absfname
+ return # already imported
+ break
+ pass
+ else:
+ if verbose(): print "Configure parser: Error : file %s does not exist" % absfname
+ return
+
+ # importing file
+ try:
+ # copy current options
+ import copy
+ opts = copy.deepcopy(self.opts)
+ # import file
+ imp = xml_parser(absfname, opts, self.importHistory)
+ # merge results
+ for key in imp.opts.keys():
+ if not self.opts.has_key(key):
+ self.opts[key] = imp.opts[key]
+ pass
+ pass
+ pass
+ except:
+ if verbose(): print "Configure parser: Error : can not read configuration file %s" % absfname
+ pass
+
# -----------------------------------------------------------------------------
dest="py_scripts",
help=help_str)
- # Configuration XML file. Default: $(HOME)/.SalomeApprc.$(version).
+ # Configuration XML file. Default: see defaultUserFile() function
help_str = "Parse application settings from the <file> "
- help_str += "instead of default $(HOME)/.SalomeApprc.$(version)"
+ help_str += "instead of default %s" % defaultUserFile()
o_r = optparse.Option("-r",
"--resources",
metavar="<file>",
dest="shutdown_servers",
help=help_str)
+ # foreground. Default: True.
+ help_str = "0 and runSalome exits after have launched the gui, "
+ help_str += "1 to launch runSalome in foreground mode [default]."
+ o_foreground = optparse.Option("--foreground",
+ metavar="<1/0>",
+ #type="choice", choices=boolean_choices,
+ type="string",
+ action="callback", callback=store_boolean, callback_args=('foreground',),
+ dest="foreground",
+ help=help_str)
+
+ # wake up session
+ help_str = "Wake up a previously closed session. "
+ help_str += "The session object is found in the naming service pointed by the variable OMNIORB_CONFIG. "
+ help_str += "If this variable is not setted, the last configuration is taken. "
+ o_wake_up = optparse.Option("--wake-up-session",
+ action="store_true",
+ dest="wake_up_session", default=False,
+ help=help_str)
+
+ # server launch mode
+ help_str = "Mode used to launch server processes (daemon or fork)."
+ o_slm = optparse.Option("--server-launch-mode",
+ metavar="<server_launch_mode>",
+ type="choice",
+ choices=["daemon","fork"],
+ action="store",
+ dest="server_launch_mode",
+ help=help_str)
+
# All options
opt_list = [o_t,o_g, # GUI/Terminal
o_d,o_o, # Desktop
o_ddd,
o_valgrind,
o_shutdown,
+ o_foreground,
+ o_wake_up,
+ o_slm, # Server launch mode
]
#std_options = ["gui", "desktop", "log_file", "py_scripts", "resources",
args = {}
#def get_env():
#args = []
-def get_env(theAdditionalOptions=[], appname="SalomeApp"):
+def get_env(theAdditionalOptions=[], appname=salomeappname, cfgname=salomecfgname):
###
# Collect launch configuration files:
# - The environment variable "<appname>Config" (SalomeAppConfig) which can
# has higher priority: it means that if some configuration options
# is found in the next analyzed cofiguration file - it will be replaced
# - The last configuration file which is parsed is user configuration file
- # situated in the home directory: "~/.<appname>rc[.<version>]" (~/SalomeApprc.3.2.0)
- # (if it exists)
+ # situated in the home directory (if it exists):
+ # * ~/.config/salome/.<appname>rc[.<version>]" for Linux (e.g. ~/.config/salome/.SalomeApprc.6.4.0)
+ # * ~/<appname>.xml[.<version>] for Windows (e.g. ~/SalomeApp.xml.6.4.0)
# - Command line options have the highest priority and replace options
# specified in configuration file(s)
###
# parse SalomeApp.xml files in directories specified by SalomeAppConfig env variable
for dir in dirs:
- #filename = dir+'/'+appname+'.xml'
- filename = dir+'/'+salomeappname+'.xml'
+ filename = os.path.join(dir, appname+'.xml')
if not os.path.exists(filename):
- print "Configure parser: Warning : could not find configuration file %s" % filename
+ if verbose(): print "Configure parser: Warning : can not find configuration file %s" % filename
else:
try:
p = xml_parser(filename, _opts)
_opts = p.opts
except:
- print "Configure parser: Error : can not read configuration file %s" % filename
+ if verbose(): print "Configure parser: Error : can not read configuration file %s" % filename
pass
# parse user configuration file
# It can be set via --resources=<file> command line option
- # or is given by default from ${HOME}/.<appname>rc.<version>
+ # or is given from default location (see defaultUserFile() function)
# If user file for the current version is not found the nearest to it is used
user_config = cmd_opts.resources
if not user_config:
- user_config = userFile(appname)
+ user_config = userFile(appname, cfgname)
+ if verbose(): print "Configure parser: user configuration file is", user_config
if not user_config or not os.path.exists(user_config):
- print "Configure parser: Warning : could not find user configuration file"
+ if verbose(): print "Configure parser: Warning : can not find user configuration file"
else:
try:
p = xml_parser(user_config, _opts)
_opts = p.opts
except:
- print 'Configure parser: Error : can not read user configuration file'
+ if verbose(): print 'Configure parser: Error : can not read user configuration file'
user_config = ""
args = _opts
args[appname_nam] = appname
# get the port number
- my_port = 2809
- try:
- file = open(os.environ["OMNIORB_CONFIG"], "r")
- s = file.read()
- while len(s):
- l = string.split(s, ":")
- if string.split(l[0], " ")[0] == "ORBInitRef" or string.split(l[0], " ")[0] == "InitRef" :
- my_port = int(l[len(l)-1])
- pass
- s = file.read()
- pass
- except:
- pass
+ my_port = getPortNumber()
args[port_nam] = my_port
args[shutdown_servers_nam] = cmd_opts.shutdown_servers
pass
+ # Foreground
+ if cmd_opts.foreground is None:
+ args[foreground_nam] = 1
+ else:
+ args[foreground_nam] = cmd_opts.foreground
+ pass
+
+ # wake up session
+ if cmd_opts.wake_up_session is not None:
+ args[wake_up_session_nam] = cmd_opts.wake_up_session
+
####################################################
# Add <theAdditionalOptions> values to args
for add_opt in theAdditionalOptions:
filename = cmd_opts.play_script_file
args[play_nam] += re.split( "[:;,]", filename )
+ # Server launch command
+ if cmd_opts.server_launch_mode is not None:
+ args["server_launch_mode"] = cmd_opts.server_launch_mode
+
# return arguments
os.environ[config_var] = separator.join(dirs)
#print "Args: ", args
