2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
5 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
8 # This library is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU Lesser General Public
10 # License as published by the Free Software Foundation; either
11 # version 2.1 of the License, or (at your option) any later version.
13 # This library is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 # Lesser General Public License for more details.
18 # You should have received a copy of the GNU Lesser General Public
19 # License along with this library; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
26 # \brief Module that provides services to launch SALOME
29 import sys, os, string, glob, time, pickle, re
32 from launchConfigureParser import verbose
33 from server import process_id, Server
37 # -----------------------------------------------------------------------------
39 from killSalome import killAllPorts
43 kill servers from a previous SALOME exection, if needed,
44 on the CORBA port given in args of runSalome
47 from killSalomeWithPort import killMyPort
48 my_port=str(args['port'])
52 print "problem in killLocalPort()"
56 def givenPortKill(port):
58 kill servers from a previous SALOME exection, if needed,
59 on the same CORBA port
62 from killSalomeWithPort import killMyPort
67 print "problem in LocalPortKill(), killMyPort(%s)"%port
71 def kill_salome(args):
73 Kill servers from previous SALOME executions, if needed;
74 depending on args 'killall' or 'portkill', kill all executions,
75 or only execution on the same CORBA port
80 elif args['portkill']:
81 givenPortKill(str(args['port']))
83 # -----------------------------------------------------------------------------
85 # Class definitions to launch CORBA Servers
88 class InterpServer(Server):
89 def __init__(self,args):
91 if sys.platform != "win32":
92 env_ld_library_path=['env', 'LD_LIBRARY_PATH=' + os.getenv("LD_LIBRARY_PATH")]
93 self.CMD=['xterm', '-e']+ env_ld_library_path + ['python']
95 self.CMD=['cmd', '/c', 'start cmd.exe', '/K', 'python']
100 print "INTERPSERVER::command = ", command
101 if sys.platform == "win32":
103 pid = win32pm.spawnpid( string.join(command, " "),'-nc' )
105 pid = os.spawnvp(os.P_NOWAIT, command[0], command)
106 process_id[pid]=self.CMD
111 def get_cata_path(list_modules,modules_root_dir):
112 """Build a list of catalog paths (cata_path) to initialize the ModuleCatalog server
117 for module in list_modules:
118 if modules_root_dir.has_key(module):
119 module_root_dir=modules_root_dir[module]
120 module_cata=module+"Catalog.xml"
121 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources",module.lower(), module_cata)
123 if os.path.exists(cata_file):
124 cata_path.append(cata_file)
125 modules_cata[module]=cata_file
127 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources", module_cata)
128 if os.path.exists(cata_file):
129 cata_path.append(cata_file)
130 modules_cata[module]=cata_file
132 for path in os.getenv("SALOME_CATALOGS_PATH","").split(os.pathsep):
133 if os.path.exists(path):
134 for cata_file in glob.glob(os.path.join(path,"*Catalog.xml")):
135 module_name= os.path.basename(cata_file)[:-11]
136 if not modules_cata.has_key(module_name):
137 cata_path.append(cata_file)
138 modules_cata[module_name]=cata_file
143 def simanStudyName(args):
145 if _siman_name is None:
146 # siman session paramenters and checkout processing
150 for param in [ 'study', 'scenario', 'user']:
151 siman_param = "siman_%s"%param
152 if siman_param in args:
153 siman_data.append(args[siman_param])
155 print "SIMAN %s must be defined using parameter --siman-%s=XXX" % (siman_param, siman_param)
158 if len(siman_data) == 3:
159 _siman_name = "_".join(siman_data)
165 class CatalogServer(Server):
166 def __init__(self,args):
169 self.SCMD1=['SALOME_ModuleCatalog_Server','-common']
171 home_dir=os.getenv('HOME')
172 if home_dir is not None:
173 self.SCMD2=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
175 def setpath(self,modules_list,modules_root_dir):
176 list_modules = modules_list[:]
177 list_modules.reverse()
178 if self.args["gui"] :
179 list_modules = ["KERNEL", "GUI"] + list_modules
181 list_modules = ["KERNEL"] + list_modules
183 cata_path=get_cata_path(list_modules,modules_root_dir)
185 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
189 class SalomeDSServer(Server):
190 def __init__(self,args):
193 self.CMD=['SALOMEDS_Server']
197 class ConnectionManagerServer(Server):
198 def __init__(self,args):
201 self.CMD=['SALOME_ConnectionManagerServer']
205 class RegistryServer(Server):
206 def __init__(self,args):
209 self.CMD=['SALOME_Registry_Server', '--salome_session','theSession']
213 class ContainerCPPServer(Server):
214 def __init__(self,args):
217 self.CMD=['SALOME_Container','FactoryServer']
221 class LoggerServer(Server):
222 def __init__(self,args):
225 from salome_utils import generateFileName
226 if sys.platform == "win32": dirpath = os.environ["HOME"]
227 else: dirpath = "/tmp"
228 logfile = generateFileName( dirpath,
234 print "==========================================================="
235 print "Logger server: put log to the file:"
237 print "==========================================================="
238 self.CMD=['SALOME_Logger_Server', logfile]
240 pass # end of LoggerServer class
244 class SessionServer(Server):
245 def __init__(self,args,modules_list,modules_root_dir):
246 self.args = args.copy()
247 # Bug 11512 (Problems with runSalome --xterm on Mandrake and Debian Sarge)
248 #self.args['xterm']=0
251 self.SCMD1=['SALOME_Session_Server']
253 if 'registry' in self.args['embedded']:
254 self.SCMD1+=['--with','Registry',
255 '(','--salome_session','theSession',')']
256 if 'moduleCatalog' in self.args['embedded']:
257 self.SCMD1+=['--with','ModuleCatalog','(','-common']
258 home_dir=os.getenv('HOME')
259 if home_dir is not None:
260 self.SCMD2+=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
262 if 'study' in self.args['embedded']:
263 self.SCMD2+=['--with','SALOMEDS','(',')']
264 if 'cppContainer' in self.args['embedded']:
265 self.SCMD2+=['--with','Container','(','FactoryServer',')']
266 if 'SalomeAppEngine' in self.args['embedded']:
267 self.SCMD2+=['--with','SalomeAppEngine','(',')']
269 if 'cppContainer' in self.args['standalone'] or 'cppContainer' in self.args['embedded']:
271 if 'pyContainer' in self.args['standalone'] or 'pyContainer' in self.args['embedded']:
272 raise Exception('Python containers no longer supported')
275 if self.args.has_key('session_gui'):
276 session_gui = self.args['session_gui']
279 if self.args['splash']:
280 self.SCMD2+=['SPLASH']
282 if self.args['study_hdf'] is not None:
283 self.SCMD2+=['--study-hdf=%s'%self.args['study_hdf']]
285 if simanStudyName(self.args):
286 self.SCMD2+=['--siman-study=%s'%simanStudyName(self.args)]
289 if self.args.has_key('pyscript') and len(self.args['pyscript']) > 0:
290 msg = json.dumps(self.args['pyscript'])
291 self.SCMD2+=['--pyscript=%s'%(msg)]
295 if self.args['noexcepthandler']:
296 self.SCMD2+=['noexcepthandler']
297 if self.args.has_key('user_config'):
298 self.SCMD2+=['--resources=%s'%self.args['user_config']]
299 if self.args.has_key('modules'):
301 #keep only modules with GUI
302 for m in modules_list:
303 if m not in modules_root_dir:
304 list_modules.insert(0,m)
306 fr1 = os.path.join(modules_root_dir[m],"share","salome","resources",m.lower(),"SalomeApp.xml")
307 fr2 = os.path.join(modules_root_dir[m],"share","salome","resources","SalomeApp.xml")
308 if os.path.exists(fr1) or os.path.exists(fr2):
309 list_modules.insert(0,m)
310 list_modules.reverse()
311 self.SCMD2+=['--modules (%s)' % ":".join(list_modules)]
315 def setpath(self,modules_list,modules_root_dir):
316 list_modules = modules_list[:]
317 list_modules.reverse()
318 if self.args["gui"] :
319 list_modules = ["KERNEL", "GUI"] + list_modules
321 list_modules = ["KERNEL"] + list_modules
323 cata_path=get_cata_path(list_modules,modules_root_dir)
325 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
326 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
327 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
329 self.CMD=self.SCMD1 + self.SCMD2
330 if self.args.has_key('test'):
331 self.CMD+=['-test'] + self.args['test']
332 elif self.args.has_key('play'):
333 self.CMD+=['-play'] + self.args['play']
335 if self.args["gdb_session"] or self.args["ddd_session"]:
336 f = open(".gdbinit4salome", "w")
338 args = " ".join(self.CMD[1:])
339 args = args.replace("(", "\(")
340 args = args.replace(")", "\)")
344 if self.args["ddd_session"]:
345 self.CMD = ["ddd", "--command=.gdbinit4salome", self.CMD[0]]
346 elif self.args["gdb_session"]:
347 self.CMD = ["xterm", "-e", "gdb", "--command=.gdbinit4salome", self.CMD[0]]
351 if self.args["valgrind_session"]:
353 val = os.getenv("VALGRIND_OPTIONS")
357 self.CMD = l + self.CMD
362 class LauncherServer(Server):
363 def __init__(self,args):
366 self.SCMD1=['SALOME_LauncherServer']
369 if 'registry' in self.args['embedded']:
370 self.SCMD1+=['--with','Registry',
371 '(','--salome_session','theSession',')']
372 if 'moduleCatalog' in self.args['embedded']:
373 self.SCMD1+=['--with','ModuleCatalog','(','-common']
374 self.SCMD2+=['-personal',
375 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
376 if 'study' in self.args['embedded']:
377 self.SCMD2+=['--with','SALOMEDS','(',')']
378 if 'cppContainer' in self.args['embedded']:
379 self.SCMD2+=['--with','Container','(','FactoryServer',')']
381 def setpath(self,modules_list,modules_root_dir):
382 list_modules = modules_list[:]
383 list_modules.reverse()
384 if self.args["gui"] :
385 list_modules = ["KERNEL", "GUI"] + list_modules
387 list_modules = ["KERNEL"] + list_modules
389 cata_path=get_cata_path(list_modules,modules_root_dir)
391 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
392 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
393 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
395 self.CMD=self.SCMD1 + self.SCMD2
397 # -----------------------------------------------------------------------------
400 """Salome Session Graphic User Interface activation"""
404 import SALOME_ModuleCatalog
405 import SALOME_Session_idl
406 session=clt.waitNS("/Kernel/Session",SALOME.Session)
407 session.GetInterface()
409 # -----------------------------------------------------------------------------
411 def startSalome(args, modules_list, modules_root_dir):
412 """Launch all SALOME servers requested by args"""
413 init_time = os.times()
415 if verbose(): print "startSalome ", args
418 # Set server launch command
420 if args.has_key('server_launch_mode'):
421 Server.set_server_launch_mode(args['server_launch_mode'])
424 # Wake up session option
426 if args['wake_up_session']:
427 if "OMNIORB_CONFIG" not in os.environ:
428 from salome_utils import generateFileName
429 omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
431 if omniorbUserPath is not None:
432 kwargs["with_username"]=True
434 last_running_config = generateFileName(omniorbUserPath, prefix="omniORB",
439 os.environ['OMNIORB_CONFIG'] = last_running_config
444 # Initialisation ORB and Naming Service
447 clt=orbmodule.client(args)
450 # Wake up session option
452 if args['wake_up_session']:
456 import SALOME_ModuleCatalog
457 import SALOME_Session_idl
458 session = clt.waitNS("/Kernel/Session",SALOME.Session)
459 status = session.GetStatSession()
461 from salome_utils import getPortNumber
462 port = getPortNumber()
465 msg += "Session GUI for port number %s is already active."%(port)
467 msg += "If you which to wake up another session,"
469 msg += "please use variable OMNIORB_CONFIG"
471 msg += "to get the correct session object in naming service."
472 sys.stdout.write(msg+"\n")
475 session.GetInterface()
476 args["session_object"] = session
479 # Launch Logger Server (optional)
480 # and wait until it is registered in naming service
484 myServer=LoggerServer(args)
486 clt.waitLogger("Logger")
488 # set siman python path before the session server launching to import scripts inside python console
489 if simanStudyName(args):
490 # MPV: use os.environ here because session server is launched in separated process and sys.path is missed in this case
491 os.environ["PYTHONPATH"] = "/tmp/SimanSalome/" + args['siman_study'] + "/" + \
492 args['siman_scenario'] + "/" + args['siman_user'] + os.pathsep + os.environ["PYTHONPATH"];
494 # Launch Session Server (to show splash ASAP)
498 mySessionServ = SessionServer(args,args['modules'],modules_root_dir)
499 mySessionServ.setpath(modules_list,modules_root_dir)
503 # Launch Registry Server,
504 # and wait until it is registered in naming service
507 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
508 myServer=RegistryServer(args)
510 if sys.platform == "win32":
511 clt.waitNS("/Registry")
513 clt.waitNSPID("/Registry",myServer.PID)
516 # Launch Catalog Server,
517 # and wait until it is registered in naming service
520 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
521 cataServer=CatalogServer(args)
522 cataServer.setpath(modules_list,modules_root_dir)
524 import SALOME_ModuleCatalog
525 if sys.platform == "win32":
526 clt.waitNS("/Kernel/ModulCatalog",SALOME_ModuleCatalog.ModuleCatalog)
528 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
531 # Launch SalomeDS Server,
532 # and wait until it is registered in naming service
535 #print "ARGS = ",args
536 if ('study' not in args['embedded']) | (args["gui"] == 0):
538 myServer=SalomeDSServer(args)
540 if sys.platform == "win32":
541 clt.waitNS("/myStudyManager")
543 clt.waitNSPID("/myStudyManager",myServer.PID)
546 # Launch LauncherServer
549 myCmServer = LauncherServer(args)
550 myCmServer.setpath(modules_list,modules_root_dir)
554 # Launch ConnectionManagerServer
557 myConnectionServer = ConnectionManagerServer(args)
558 myConnectionServer.run()
561 from Utils_Identity import getShortHostName
563 if os.getenv("HOSTNAME") == None:
564 if os.getenv("HOST") == None:
565 os.environ["HOSTNAME"]=getShortHostName()
567 os.environ["HOSTNAME"]=os.getenv("HOST")
569 theComputer = getShortHostName()
572 # Launch local C++ Container (FactoryServer),
573 # and wait until it is registered in naming service
576 if ('cppContainer' in args['standalone']) | (args["gui"] == 0) :
577 myServer=ContainerCPPServer(args)
579 if sys.platform == "win32":
580 clt.waitNS("/Containers/" + theComputer + "/FactoryServer")
582 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
584 if 'pyContainer' in args['standalone']:
585 raise Exception('Python containers no longer supported')
588 # Wait until Session Server is registered in naming service
596 import SALOME_ModuleCatalog
597 import SALOME_Session_idl
598 if sys.platform == "win32":
599 session=clt.waitNS("/Kernel/Session",SALOME.Session)
601 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
602 args["session_object"] = session
603 end_time = os.times()
605 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
608 # ASV start GUI without Loader
610 # session.GetInterface()
613 # additionnal external python interpreters
619 nbaddi = args['interp']
622 traceback.print_exc()
623 print "-------------------------------------------------------------"
624 print "-- to get an external python interpreter:runSalome --interp=1"
625 print "-------------------------------------------------------------"
627 if verbose(): print "additional external python interpreters: ", nbaddi
629 for i in range(nbaddi):
631 anInterp=InterpServer(args)
634 # set PYTHONINSPECT variable (python interpreter in interactive mode)
636 os.environ["PYTHONINSPECT"]="1"
642 # siman session paramenters and checkout processing
643 if simanStudyName(args):
644 print '**********************************************'
645 print "Siman study name= '" + simanStudyName(args) + "'"
647 obj = clt.Resolve('myStudyManager')
648 myStudyManager = obj._narrow(SALOMEDS.StudyManager)
649 aNewStudy = myStudyManager.NewStudy(simanStudyName(args))
650 aSimS = myStudyManager.GetSimanStudy()
651 aSimS._set_StudyId(args['siman_study'])
652 aSimS._set_ScenarioId(args['siman_scenario'])
653 aSimS._set_UserId(args['siman_user'])
654 aSimS.CheckOut(aNewStudy)
655 # if session server is enabled, activate the created study
657 print "Activate the SIMAN study in the SALOME GUI"
658 obj = clt.Resolve('/Kernel/Session')
659 mySession = obj._narrow(SALOME.Session)
660 mySession.emitMessage("simanCheckoutDone " + simanStudyName(args))
661 print '**********************************************'
665 # -----------------------------------------------------------------------------
667 def useSalome(args, modules_list, modules_root_dir):
669 Launch all SALOME servers requested by args,
670 save list of process, give info to user,
671 show registered objects in Naming Service.
677 clt = startSalome(args, modules_list, modules_root_dir)
680 traceback.print_exc()
683 print "--- Error during Salome launch ---"
687 from addToKillList import addToKillList
688 from killSalomeWithPort import getPiDict
690 filedict = getPiDict(args['port'])
691 for pid, cmd in process_id.items():
692 addToKillList(pid, cmd, args['port'])
695 if verbose(): print """
696 Saving of the dictionary of Salome processes in %s
697 To kill SALOME processes from a console (kill all sessions from all ports):
699 To kill SALOME from the present interpreter, if it is not closed :
700 killLocalPort() --> kill this session
701 (use CORBA port from args of runSalome)
702 givenPortKill(port) --> kill a specific session with given CORBA port
703 killAllPorts() --> kill all sessions
705 runSalome, with --killall option, starts with killing
706 the processes resulting from the previous execution.
710 # Print Naming Service directory list
716 print " --- registered objects tree in Naming Service ---"
720 if not args['gui'] or not args['session_gui']:
721 if args['shutdown_servers']:
722 class __utils__(object):
723 def __init__(self, port):
725 import killSalomeWithPort
726 self.killSalomeWithPort = killSalomeWithPort
729 self.killSalomeWithPort.killMyPort(self.port)
735 atexit.register(func, __utils__(args['port']))
739 # run python scripts, passed as command line arguments
741 if args.has_key('gui') and args.has_key('session_gui'):
742 if not args['gui'] or not args['session_gui']:
743 if args.has_key('study_hdf'):
744 toopen = args['study_hdf']
747 salome.salome_init(toopen)
748 if args.has_key('pyscript'):
749 toimport = args['pyscript']
750 from salomeContextUtils import formatScriptsAndArgs
751 command = formatScriptsAndArgs(toimport)
753 proc = subprocess.Popen(command, shell=True)
754 addToKillList(proc.pid, command, args['port'])
756 if res: sys.exit(1) # if there's an error when executing script, we should explicitly exit
760 def execScript(script_path):
761 print 'executing', script_path
762 sys.path.insert(0, os.path.dirname(script_path))
763 execfile(script_path,globals())
766 # -----------------------------------------------------------------------------
768 def registerEnv(args, modules_list, modules_root_dir):
770 Register args, modules_list, modules_root_dir in a file
771 for further use, when SALOME is launched embedded in an other application.
773 if sys.platform == "win32":
774 fileEnv = os.getenv('TEMP')
778 fileEnv += os.getenv('USER') + "_" + str(args['port']) \
779 + '_' + args['appname'].upper() + '_env'
780 fenv=open(fileEnv,'w')
781 pickle.dump((args, modules_list, modules_root_dir),fenv)
783 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
785 # -----------------------------------------------------------------------------
788 """Salome Launch, when embedded in other application"""
789 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
790 fenv=open(fileEnv,'r')
791 args, modules_list, modules_root_dir = pickle.load(fenv)
794 from searchFreePort import searchFreePort
795 searchFreePort(args, 0)
796 clt = useSalome(args, modules_list, modules_root_dir)
799 # -----------------------------------------------------------------------------
802 """Salome launch as a main application"""
804 # define folder to store omniorb config (initially in virtual application folder)
806 from salomeContextUtils import setOmniOrbUserPath
812 from salome_utils import getHostName
813 args, modules_list, modules_root_dir = setenv.get_config()
814 print "runSalome running on %s" % getHostName()
818 if args.has_key('save_config'):
819 save_config = args['save_config']
822 if args['wake_up_session']:
826 from searchFreePort import searchFreePort
827 searchFreePort(args, save_config, args.get('useport'))
831 setenv.set_env(args, modules_list, modules_root_dir)
832 clt = useSalome(args, modules_list, modules_root_dir)
835 # -----------------------------------------------------------------------------
837 def foreGround(clt, args):
839 if "session_object" not in args:
841 session = args["session_object"]
843 # Wait until gui is arrived
852 status = session.GetStatSession()
853 gui_detected = status.activeGUI
858 from time import sleep
868 from salome_utils import getPortNumber
869 port = getPortNumber()
872 if sys.platform == "win32":
873 server.CMD = [os.getenv("PYTHONBIN"), "-m", "killSalomeWithPort", "--spy", "%s"%(os.getpid()), "%s"%(port)]
875 server.CMD = ["killSalomeWithPort.py", "--spy", "%s"%(os.getpid()), "%s"%(port)]
877 # os.system("killSalomeWithPort.py --spy %s %s &"%(os.getpid(), port))
883 status = session.GetStatSession()
884 assert status.activeGUI
887 from time import sleep
891 except KeyboardInterrupt:
892 from killSalomeWithPort import killMyPort
902 test = args['gui'] and args['session_gui']
903 test = test or args['wake_up_session']
905 # The next test covers the --pinter option or var PYTHONINSPECT setted
907 test = test and not os.environ.get('PYTHONINSPECT')
909 # The next test covers the python -i $KERNEL_ROOT_DIR/bin/salome/runSalome.py case
912 from ctypes import POINTER, c_int, cast, pythonapi
913 iflag_ptr = cast(pythonapi.Py_InteractiveFlag, POINTER(c_int))
914 test = test and not iflag_ptr.contents.value
918 test = test and os.getenv("SALOME_TEST_MODE", "0") != "1"
919 test = test and args['foreground']
922 foreGround(clt, args)
927 # -----------------------------------------------------------------------------
929 if __name__ == "__main__":