2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2007-2015 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
36 from salomeContextUtils import ScriptAndArgsObjectEncoder
38 # -----------------------------------------------------------------------------
40 from killSalome import killAllPorts
44 kill servers from a previous SALOME exection, if needed,
45 on the CORBA port given in args of runSalome
48 from killSalomeWithPort import killMyPort
49 my_port=str(args['port'])
53 print "problem in killLocalPort()"
57 def givenPortKill(port):
59 kill servers from a previous SALOME exection, if needed,
60 on the same CORBA port
63 from killSalomeWithPort import killMyPort
68 print "problem in LocalPortKill(), killMyPort(%s)"%port
72 def kill_salome(args):
74 Kill servers from previous SALOME executions, if needed;
75 depending on args 'killall' or 'portkill', kill all executions,
76 or only execution on the same CORBA port
81 elif args['portkill']:
82 givenPortKill(str(args['port']))
84 # -----------------------------------------------------------------------------
86 # Class definitions to launch CORBA Servers
89 class InterpServer(Server):
90 def __init__(self,args):
92 if sys.platform != "win32":
93 env_ld_library_path=['env', 'LD_LIBRARY_PATH=' + os.getenv("LD_LIBRARY_PATH")]
94 self.CMD=['xterm', '-e']+ env_ld_library_path + ['python']
96 self.CMD=['cmd', '/c', 'start cmd.exe', '/K', 'python']
101 print "INTERPSERVER::command = ", command
102 if sys.platform == "win32":
104 pid = win32pm.spawnpid( string.join(command, " "),'-nc' )
106 pid = os.spawnvp(os.P_NOWAIT, command[0], command)
107 process_id[pid]=self.CMD
112 def get_cata_path(list_modules,modules_root_dir):
113 """Build a list of catalog paths (cata_path) to initialize the ModuleCatalog server
118 for module in list_modules:
119 if modules_root_dir.has_key(module):
120 module_root_dir=modules_root_dir[module]
121 module_cata=module+"Catalog.xml"
122 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources",module.lower(), module_cata)
124 if os.path.exists(cata_file):
125 cata_path.append(cata_file)
126 modules_cata[module]=cata_file
128 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources", module_cata)
129 if os.path.exists(cata_file):
130 cata_path.append(cata_file)
131 modules_cata[module]=cata_file
133 for path in os.getenv("SALOME_CATALOGS_PATH","").split(os.pathsep):
134 if os.path.exists(path):
135 for cata_file in glob.glob(os.path.join(path,"*Catalog.xml")):
136 module_name= os.path.basename(cata_file)[:-11]
137 if not modules_cata.has_key(module_name):
138 cata_path.append(cata_file)
139 modules_cata[module_name]=cata_file
144 def simanStudyName(args):
146 if _siman_name is None:
147 # siman session paramenters and checkout processing
151 for param in [ 'study', 'scenario', 'user']:
152 siman_param = "siman_%s"%param
153 if siman_param in args:
154 siman_data.append(args[siman_param])
156 print "SIMAN %s must be defined using parameter --siman-%s=XXX" % (siman_param, siman_param)
159 if len(siman_data) == 3:
160 _siman_name = "_".join(siman_data)
166 class CatalogServer(Server):
167 def __init__(self,args):
170 self.SCMD1=['SALOME_ModuleCatalog_Server','-common']
172 home_dir=os.getenv('HOME')
173 if home_dir is not None:
174 self.SCMD2=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
176 def setpath(self,modules_list,modules_root_dir):
177 list_modules = modules_list[:]
178 list_modules.reverse()
179 if self.args["gui"] :
180 list_modules = ["KERNEL", "GUI"] + list_modules
182 list_modules = ["KERNEL"] + list_modules
184 cata_path=get_cata_path(list_modules,modules_root_dir)
186 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
190 class SalomeDSServer(Server):
191 def __init__(self,args):
194 self.CMD=['SALOMEDS_Server']
198 class ConnectionManagerServer(Server):
199 def __init__(self,args):
202 self.CMD=['SALOME_ConnectionManagerServer']
206 class RegistryServer(Server):
207 def __init__(self,args):
210 self.CMD=['SALOME_Registry_Server', '--salome_session','theSession']
214 class ContainerCPPServer(Server):
215 def __init__(self,args):
218 self.CMD=['SALOME_Container','FactoryServer']
222 class LoggerServer(Server):
223 def __init__(self,args):
226 from salome_utils import generateFileName, getLogDir
227 logfile = generateFileName( getLogDir(),
233 print "==========================================================="
234 print "Logger server: put log to the file:"
236 print "==========================================================="
237 self.CMD=['SALOME_Logger_Server', logfile]
239 pass # end of LoggerServer class
243 class SessionServer(Server):
244 def __init__(self,args,modules_list,modules_root_dir):
245 self.args = args.copy()
246 # Bug 11512 (Problems with runSalome --xterm on Mandrake and Debian Sarge)
247 #self.args['xterm']=0
250 self.SCMD1=['SALOME_Session_Server']
252 if 'registry' in self.args['embedded']:
253 self.SCMD1+=['--with','Registry',
254 '(','--salome_session','theSession',')']
255 if 'moduleCatalog' in self.args['embedded']:
256 self.SCMD1+=['--with','ModuleCatalog','(','-common']
257 home_dir=os.getenv('HOME')
258 if home_dir is not None:
259 self.SCMD2+=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
261 if 'study' in self.args['embedded']:
262 self.SCMD2+=['--with','SALOMEDS','(',')']
263 if 'cppContainer' in self.args['embedded']:
264 self.SCMD2+=['--with','Container','(','FactoryServer',')']
265 if 'SalomeAppEngine' in self.args['embedded']:
266 self.SCMD2+=['--with','SalomeAppEngine','(',')']
268 if 'cppContainer' in self.args['standalone'] or 'cppContainer' in self.args['embedded']:
270 if 'pyContainer' in self.args['standalone'] or 'pyContainer' in self.args['embedded']:
271 raise Exception('Python containers no longer supported')
274 if self.args.has_key('session_gui'):
275 session_gui = self.args['session_gui']
278 if self.args['splash']:
279 self.SCMD2+=['SPLASH']
281 if self.args['study_hdf'] is not None:
282 self.SCMD2+=['--study-hdf=%s'%self.args['study_hdf']]
284 if simanStudyName(self.args):
285 self.SCMD2+=['--siman-study=%s'%simanStudyName(self.args)]
288 if self.args.has_key('pyscript') and len(self.args['pyscript']) > 0:
289 msg = json.dumps(self.args['pyscript'], cls=ScriptAndArgsObjectEncoder)
290 self.SCMD2+=['--pyscript=%s'%(msg)]
294 if self.args['noexcepthandler']:
295 self.SCMD2+=['noexcepthandler']
296 if self.args.has_key('user_config'):
297 self.SCMD2+=['--resources=%s'%self.args['user_config']]
298 if self.args.has_key('modules'):
300 #keep only modules with GUI
301 for m in modules_list:
302 if m not in modules_root_dir:
303 list_modules.insert(0,m)
305 fr1 = os.path.join(modules_root_dir[m],"share","salome","resources",m.lower(),"SalomeApp.xml")
306 fr2 = os.path.join(modules_root_dir[m],"share","salome","resources","SalomeApp.xml")
307 if os.path.exists(fr1) or os.path.exists(fr2):
308 list_modules.insert(0,m)
309 list_modules.reverse()
310 self.SCMD2+=['--modules (%s)' % ":".join(list_modules)]
314 def setpath(self,modules_list,modules_root_dir):
315 list_modules = modules_list[:]
316 list_modules.reverse()
317 if self.args["gui"] :
318 list_modules = ["KERNEL", "GUI"] + list_modules
320 list_modules = ["KERNEL"] + list_modules
322 cata_path=get_cata_path(list_modules,modules_root_dir)
324 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
325 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
326 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
328 self.CMD=self.SCMD1 + self.SCMD2
329 if self.args.has_key('test'):
330 self.CMD+=['-test'] + self.args['test']
331 elif self.args.has_key('play'):
332 self.CMD+=['-play'] + self.args['play']
334 if self.args["gdb_session"] or self.args["ddd_session"]:
335 f = open(".gdbinit4salome", "w")
337 args = " ".join(self.CMD[1:])
338 args = args.replace("(", "\(")
339 args = args.replace(")", "\)")
343 if self.args["ddd_session"]:
344 self.CMD = ["ddd", "--command=.gdbinit4salome", self.CMD[0]]
345 elif self.args["gdb_session"]:
346 self.CMD = ["xterm", "-e", "gdb", "--command=.gdbinit4salome", self.CMD[0]]
350 if self.args["valgrind_session"]:
352 val = os.getenv("VALGRIND_OPTIONS")
356 self.CMD = l + self.CMD
361 class LauncherServer(Server):
362 def __init__(self,args):
365 self.SCMD1=['SALOME_LauncherServer']
368 if 'registry' in self.args['embedded']:
369 self.SCMD1+=['--with','Registry',
370 '(','--salome_session','theSession',')']
371 if 'moduleCatalog' in self.args['embedded']:
372 self.SCMD1+=['--with','ModuleCatalog','(','-common']
373 self.SCMD2+=['-personal',
374 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
375 if 'study' in self.args['embedded']:
376 self.SCMD2+=['--with','SALOMEDS','(',')']
377 if 'cppContainer' in self.args['embedded']:
378 self.SCMD2+=['--with','Container','(','FactoryServer',')']
380 def setpath(self,modules_list,modules_root_dir):
381 list_modules = modules_list[:]
382 list_modules.reverse()
383 if self.args["gui"] :
384 list_modules = ["KERNEL", "GUI"] + list_modules
386 list_modules = ["KERNEL"] + list_modules
388 cata_path=get_cata_path(list_modules,modules_root_dir)
390 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
391 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
392 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
394 self.CMD=self.SCMD1 + self.SCMD2
396 # -----------------------------------------------------------------------------
399 """Salome Session Graphic User Interface activation"""
403 import SALOME_ModuleCatalog
404 import SALOME_Session_idl
405 session=clt.waitNS("/Kernel/Session",SALOME.Session)
406 session.GetInterface()
408 # -----------------------------------------------------------------------------
410 def startSalome(args, modules_list, modules_root_dir):
411 """Launch all SALOME servers requested by args"""
412 init_time = os.times()
414 if verbose(): print "startSalome ", args
417 # Set server launch command
419 if args.has_key('server_launch_mode'):
420 Server.set_server_launch_mode(args['server_launch_mode'])
423 # Wake up session option
425 if args['wake_up_session']:
426 if "OMNIORB_CONFIG" not in os.environ:
427 from salome_utils import generateFileName
428 omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
430 if omniorbUserPath is not None:
431 kwargs["with_username"]=True
433 last_running_config = generateFileName(omniorbUserPath, prefix="omniORB",
438 os.environ['OMNIORB_CONFIG'] = last_running_config
443 # Initialisation ORB and Naming Service
446 clt=orbmodule.client(args)
449 # Wake up session option
451 if args['wake_up_session']:
455 import SALOME_ModuleCatalog
456 import SALOME_Session_idl
457 session = clt.waitNS("/Kernel/Session",SALOME.Session)
458 status = session.GetStatSession()
460 from salome_utils import getPortNumber
461 port = getPortNumber()
464 msg += "Session GUI for port number %s is already active."%(port)
466 msg += "If you which to wake up another session,"
468 msg += "please use variable OMNIORB_CONFIG"
470 msg += "to get the correct session object in naming service."
471 sys.stdout.write(msg+"\n")
474 session.GetInterface()
475 args["session_object"] = session
478 # Launch Logger Server (optional)
479 # and wait until it is registered in naming service
483 myServer=LoggerServer(args)
485 clt.waitLogger("Logger")
487 # set siman python path before the session server launching to import scripts inside python console
488 if simanStudyName(args):
489 # MPV: use os.environ here because session server is launched in separated process and sys.path is missed in this case
490 from salome_utils import getTmpDir
491 ppath = os.path.join(getTmpDir, "SimanSalome", args['siman_study'],
492 args['siman_scenario'], args['siman_user'])
493 os.environ["PYTHONPATH"] = ppath + os.pathsep + os.environ["PYTHONPATH"]
495 # Launch Session Server (to show splash ASAP)
499 mySessionServ = SessionServer(args,args['modules'],modules_root_dir)
500 mySessionServ.setpath(modules_list,modules_root_dir)
504 # Launch Registry Server,
505 # and wait until it is registered in naming service
508 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
509 myServer=RegistryServer(args)
511 if sys.platform == "win32":
512 clt.waitNS("/Registry")
514 clt.waitNSPID("/Registry",myServer.PID)
517 # Launch Catalog Server,
518 # and wait until it is registered in naming service
521 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
522 cataServer=CatalogServer(args)
523 cataServer.setpath(modules_list,modules_root_dir)
525 import SALOME_ModuleCatalog
526 if sys.platform == "win32":
527 clt.waitNS("/Kernel/ModulCatalog",SALOME_ModuleCatalog.ModuleCatalog)
529 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
532 # Launch SalomeDS Server,
533 # and wait until it is registered in naming service
536 #print "ARGS = ",args
537 if ('study' not in args['embedded']) | (args["gui"] == 0):
539 myServer=SalomeDSServer(args)
541 if sys.platform == "win32":
542 clt.waitNS("/myStudyManager")
544 clt.waitNSPID("/myStudyManager",myServer.PID)
547 # Launch LauncherServer
550 myCmServer = LauncherServer(args)
551 myCmServer.setpath(modules_list,modules_root_dir)
555 # Launch ConnectionManagerServer
558 myConnectionServer = ConnectionManagerServer(args)
559 myConnectionServer.run()
562 from Utils_Identity import getShortHostName
564 if os.getenv("HOSTNAME") == None:
565 if os.getenv("HOST") == None:
566 os.environ["HOSTNAME"]=getShortHostName()
568 os.environ["HOSTNAME"]=os.getenv("HOST")
570 theComputer = getShortHostName()
573 # Launch local C++ Container (FactoryServer),
574 # and wait until it is registered in naming service
577 if ('cppContainer' in args['standalone']) | (args["gui"] == 0) :
578 myServer=ContainerCPPServer(args)
580 if sys.platform == "win32":
581 clt.waitNS("/Containers/" + theComputer + "/FactoryServer")
583 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
585 if 'pyContainer' in args['standalone']:
586 raise Exception('Python containers no longer supported')
589 # Wait until Session Server is registered in naming service
597 import SALOME_ModuleCatalog
598 import SALOME_Session_idl
599 if sys.platform == "win32":
600 session=clt.waitNS("/Kernel/Session",SALOME.Session)
602 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
603 args["session_object"] = session
604 end_time = os.times()
606 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
609 # ASV start GUI without Loader
611 # session.GetInterface()
614 # additionnal external python interpreters
620 nbaddi = args['interp']
623 traceback.print_exc()
624 print "-------------------------------------------------------------"
625 print "-- to get an external python interpreter:runSalome --interp=1"
626 print "-------------------------------------------------------------"
628 if verbose(): print "additional external python interpreters: ", nbaddi
630 for i in range(nbaddi):
632 anInterp=InterpServer(args)
635 # set PYTHONINSPECT variable (python interpreter in interactive mode)
637 os.environ["PYTHONINSPECT"]="1"
643 # siman session paramenters and checkout processing
644 if simanStudyName(args):
645 print '**********************************************'
646 print "Siman study name= '" + simanStudyName(args) + "'"
648 obj = clt.Resolve('myStudyManager')
649 myStudyManager = obj._narrow(SALOMEDS.StudyManager)
650 aNewStudy = myStudyManager.NewStudy(simanStudyName(args))
651 aSimS = myStudyManager.GetSimanStudy()
652 aSimS._set_StudyId(args['siman_study'])
653 aSimS._set_ScenarioId(args['siman_scenario'])
654 aSimS._set_UserId(args['siman_user'])
655 aSimS.CheckOut(aNewStudy)
656 # if session server is enabled, activate the created study
658 print "Activate the SIMAN study in the SALOME GUI"
659 obj = clt.Resolve('/Kernel/Session')
660 mySession = obj._narrow(SALOME.Session)
661 mySession.emitMessage("simanCheckoutDone " + simanStudyName(args))
662 print '**********************************************'
666 # -----------------------------------------------------------------------------
668 def useSalome(args, modules_list, modules_root_dir):
670 Launch all SALOME servers requested by args,
671 save list of process, give info to user,
672 show registered objects in Naming Service.
678 clt = startSalome(args, modules_list, modules_root_dir)
681 traceback.print_exc()
684 print "--- Error during Salome launch ---"
688 from addToKillList import addToKillList
689 from killSalomeWithPort import getPiDict
691 filedict = getPiDict(args['port'])
692 for pid, cmd in process_id.items():
693 addToKillList(pid, cmd, args['port'])
696 if verbose(): print """
697 Saving of the dictionary of Salome processes in %s
698 To kill SALOME processes from a console (kill all sessions from all ports):
700 To kill SALOME from the present interpreter, if it is not closed :
701 killLocalPort() --> kill this session
702 (use CORBA port from args of runSalome)
703 givenPortKill(port) --> kill a specific session with given CORBA port
704 killAllPorts() --> kill all sessions
706 runSalome, with --killall option, starts with killing
707 the processes resulting from the previous execution.
711 # Print Naming Service directory list
717 print " --- registered objects tree in Naming Service ---"
721 if not args['gui'] or not args['session_gui']:
722 if args['shutdown_servers']:
723 class __utils__(object):
724 def __init__(self, port):
726 import killSalomeWithPort
727 self.killSalomeWithPort = killSalomeWithPort
730 self.killSalomeWithPort.killMyPort(self.port)
736 atexit.register(func, __utils__(args['port']))
740 # run python scripts, passed as command line arguments
742 if args.has_key('gui') and args.has_key('session_gui'):
743 if not args['gui'] or not args['session_gui']:
744 if args.has_key('study_hdf'):
745 toopen = args['study_hdf']
748 salome.salome_init(toopen)
749 if args.has_key('pyscript'):
750 toimport = args['pyscript']
751 from salomeContextUtils import formatScriptsAndArgs
752 command = formatScriptsAndArgs(toimport)
754 proc = subprocess.Popen(command, shell=True)
755 addToKillList(proc.pid, command, args['port'])
757 if res: sys.exit(1) # if there's an error when executing script, we should explicitly exit
761 def execScript(script_path):
762 print 'executing', script_path
763 sys.path.insert(0, os.path.realpath(os.path.dirname(script_path)))
764 execfile(script_path,globals())
767 # -----------------------------------------------------------------------------
769 def registerEnv(args, modules_list, modules_root_dir):
771 Register args, modules_list, modules_root_dir in a file
772 for further use, when SALOME is launched embedded in an other application.
774 from salome_utils import getTmpDir
775 fileEnv = getTmpDir()
776 fileEnv += os.getenv('USER') + "_" + str(args['port']) \
777 + '_' + args['appname'].upper() + '_env'
778 fenv=open(fileEnv,'w')
779 pickle.dump((args, modules_list, modules_root_dir),fenv)
781 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
783 # -----------------------------------------------------------------------------
786 """Salome Launch, when embedded in other application"""
787 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
788 fenv=open(fileEnv,'r')
789 args, modules_list, modules_root_dir = pickle.load(fenv)
792 from searchFreePort import searchFreePort
793 searchFreePort(args, 0)
794 clt = useSalome(args, modules_list, modules_root_dir)
797 # -----------------------------------------------------------------------------
800 """Salome launch as a main application"""
802 # define folder to store omniorb config (initially in virtual application folder)
804 from salomeContextUtils import setOmniOrbUserPath
810 from salome_utils import getHostName
811 args, modules_list, modules_root_dir = setenv.get_config()
812 print "runSalome running on %s" % getHostName()
816 if args.has_key('save_config'):
817 save_config = args['save_config']
820 if args['wake_up_session']:
824 from searchFreePort import searchFreePort
825 searchFreePort(args, save_config, args.get('useport'))
829 setenv.set_env(args, modules_list, modules_root_dir)
830 clt = useSalome(args, modules_list, modules_root_dir)
833 # -----------------------------------------------------------------------------
835 def foreGround(clt, args):
837 if "session_object" not in args:
839 session = args["session_object"]
841 # Wait until gui is arrived
850 status = session.GetStatSession()
851 gui_detected = status.activeGUI
856 from time import sleep
866 from salome_utils import getPortNumber
867 port = getPortNumber()
870 if sys.platform == "win32":
871 server.CMD = [os.getenv("PYTHONBIN"), "-m", "killSalomeWithPort", "--spy", "%s"%(os.getpid()), "%s"%(port)]
873 server.CMD = ["killSalomeWithPort.py", "--spy", "%s"%(os.getpid()), "%s"%(port)]
875 # os.system("killSalomeWithPort.py --spy %s %s &"%(os.getpid(), port))
881 status = session.GetStatSession()
882 assert status.activeGUI
885 from time import sleep
889 except KeyboardInterrupt:
890 from killSalomeWithPort import killMyPort
900 test = args['gui'] and args['session_gui']
901 test = test or args['wake_up_session']
903 # The next test covers the --pinter option or var PYTHONINSPECT setted
905 test = test and not os.environ.get('PYTHONINSPECT')
907 # The next test covers the python -i $KERNEL_ROOT_DIR/bin/salome/runSalome.py case
910 from ctypes import POINTER, c_int, cast, pythonapi
911 iflag_ptr = cast(pythonapi.Py_InteractiveFlag, POINTER(c_int))
912 test = test and not iflag_ptr.contents.value
916 test = test and os.getenv("SALOME_TEST_MODE", "0") != "1"
917 test = test and args['foreground']
920 foreGround(clt, args)
925 # -----------------------------------------------------------------------------
927 if __name__ == "__main__":