2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2007-2016 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 execution, 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 execution, 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 self.CMD=['cmd', '/c', 'start cmd.exe', '/K', 'python']
94 elif sys.platform == "darwin":
95 env_ld_library_path=['env', 'DYLD_LIBRARY_PATH=' + os.getenv("LD_LIBRARY_PATH")]
96 self.CMD=['xterm', '-e'] + env_ld_library_path + ['python']
98 env_ld_library_path=['env', 'LD_LIBRARY_PATH=' + os.getenv("LD_LIBRARY_PATH")]
99 self.CMD=['xterm', '-e'] + env_ld_library_path + ['python']
104 print "INTERPSERVER::command = ", command
106 pid = subprocess.Popen(command).pid
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
143 class CatalogServer(Server):
144 def __init__(self,args):
147 self.SCMD1=['SALOME_ModuleCatalog_Server','-common']
149 home_dir=os.getenv('HOME')
150 if home_dir is not None:
151 self.SCMD2=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
153 def setpath(self,modules_list,modules_root_dir):
154 list_modules = modules_list[:]
155 list_modules.reverse()
156 if self.args["gui"] :
157 list_modules = ["KERNEL", "GUI"] + list_modules
159 list_modules = ["KERNEL"] + list_modules
161 cata_path=get_cata_path(list_modules,modules_root_dir)
163 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
167 class SalomeDSServer(Server):
168 def __init__(self,args):
171 self.CMD=['SALOMEDS_Server']
175 class ConnectionManagerServer(Server):
176 def __init__(self,args):
179 self.CMD=['SALOME_ConnectionManagerServer']
183 class RegistryServer(Server):
184 def __init__(self,args):
187 self.CMD=['SALOME_Registry_Server', '--salome_session','theSession']
191 class ContainerCPPServer(Server):
192 def __init__(self,args,with_gui=False):
195 self.CMD=['SALOME_Container','FactoryServer']
196 if not with_gui and self.args["valgrind_session"]:
198 val = os.getenv("VALGRIND_OPTIONS")
202 self.CMD = l + self.CMD
207 class LoggerServer(Server):
208 def __init__(self,args):
211 from salome_utils import generateFileName, getLogDir
212 logfile = generateFileName( getLogDir(),
218 print "==========================================================="
219 print "Logger server: put log to the file:"
221 print "==========================================================="
222 self.CMD=['SALOME_Logger_Server', logfile]
224 pass # end of LoggerServer class
228 class SessionServer(Server):
229 def __init__(self,args,modules_list,modules_root_dir):
230 self.args = args.copy()
231 # Bug 11512 (Problems with runSalome --xterm on Mandrake and Debian Sarge)
232 #self.args['xterm']=0
235 self.SCMD1=['SALOME_Session_Server']
237 if 'registry' in self.args['embedded']:
238 self.SCMD1+=['--with','Registry',
239 '(','--salome_session','theSession',')']
240 if 'moduleCatalog' in self.args['embedded']:
241 self.SCMD1+=['--with','ModuleCatalog','(','-common']
242 home_dir=os.getenv('HOME')
243 if home_dir is not None:
244 self.SCMD2+=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
246 if 'study' in self.args['embedded']:
247 self.SCMD2+=['--with','SALOMEDS','(',')']
248 if 'cppContainer' in self.args['embedded']:
249 self.SCMD2+=['--with','Container','(','FactoryServer',')']
250 if 'SalomeAppEngine' in self.args['embedded']:
251 self.SCMD2+=['--with','SalomeAppEngine','(',')']
253 if 'cppContainer' in self.args['standalone'] or 'cppContainer' in self.args['embedded']:
255 if 'pyContainer' in self.args['standalone'] or 'pyContainer' in self.args['embedded']:
256 raise Exception('Python containers no longer supported')
259 if self.args.has_key('session_gui'):
260 session_gui = self.args['session_gui']
263 if self.args['splash']:
264 self.SCMD2+=['SPLASH']
266 if self.args['study_hdf'] is not None:
267 self.SCMD2+=['--study-hdf=%s'%self.args['study_hdf']]
270 if self.args.has_key('pyscript') and len(self.args['pyscript']) > 0:
271 msg = json.dumps(self.args['pyscript'], cls=ScriptAndArgsObjectEncoder)
272 self.SCMD2+=['--pyscript=%s'%(msg)]
276 if self.args['noexcepthandler']:
277 self.SCMD2+=['noexcepthandler']
278 if self.args.has_key('user_config'):
279 self.SCMD2+=['--resources=%s'%self.args['user_config']]
280 if self.args.has_key('modules'):
282 #keep only modules with GUI
283 for m in modules_list:
284 if m not in modules_root_dir:
285 list_modules.insert(0,m)
287 fr1 = os.path.join(modules_root_dir[m],"share","salome","resources",m.lower(),"SalomeApp.xml")
288 fr2 = os.path.join(modules_root_dir[m],"share","salome","resources","SalomeApp.xml")
289 if os.path.exists(fr1) or os.path.exists(fr2):
290 list_modules.insert(0,m)
291 list_modules.reverse()
292 self.SCMD2+=['--modules (%s)' % ":".join(list_modules)]
294 if self.args.has_key('language'):
295 self.SCMD2+=['--language=%s' % self.args['language']]
298 def setpath(self,modules_list,modules_root_dir):
299 list_modules = modules_list[:]
300 list_modules.reverse()
301 if self.args["gui"] :
302 list_modules = ["KERNEL", "GUI"] + list_modules
304 list_modules = ["KERNEL"] + list_modules
306 cata_path=get_cata_path(list_modules,modules_root_dir)
308 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
309 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
310 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
312 self.CMD=self.SCMD1 + self.SCMD2
313 if self.args.has_key('test'):
314 self.CMD+=['-test'] + self.args['test']
315 elif self.args.has_key('play'):
316 self.CMD+=['-play'] + self.args['play']
318 if self.args["gdb_session"] or self.args["ddd_session"]:
319 f = open(".gdbinit4salome", "w")
321 args = " ".join(self.CMD[1:])
322 args = args.replace("(", "\(")
323 args = args.replace(")", "\)")
327 if self.args["ddd_session"]:
328 self.CMD = ["ddd", "--command=.gdbinit4salome", self.CMD[0]]
329 elif self.args["gdb_session"]:
330 self.CMD = ["xterm", "-e", "gdb", "--command=.gdbinit4salome", self.CMD[0]]
334 if self.args["valgrind_session"]:
336 val = os.getenv("VALGRIND_OPTIONS")
340 self.CMD = l + self.CMD
345 class LauncherServer(Server):
346 def __init__(self,args):
349 self.SCMD1=['SALOME_LauncherServer']
352 if 'registry' in self.args['embedded']:
353 self.SCMD1+=['--with','Registry',
354 '(','--salome_session','theSession',')']
355 if 'moduleCatalog' in self.args['embedded']:
356 self.SCMD1+=['--with','ModuleCatalog','(','-common']
357 self.SCMD2+=['-personal',
358 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
359 if 'study' in self.args['embedded']:
360 self.SCMD2+=['--with','SALOMEDS','(',')']
361 if 'cppContainer' in self.args['embedded']:
362 self.SCMD2+=['--with','Container','(','FactoryServer',')']
364 def setpath(self,modules_list,modules_root_dir):
365 list_modules = modules_list[:]
366 list_modules.reverse()
367 if self.args["gui"] :
368 list_modules = ["KERNEL", "GUI"] + list_modules
370 list_modules = ["KERNEL"] + list_modules
372 cata_path=get_cata_path(list_modules,modules_root_dir)
374 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
375 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
376 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
378 self.CMD=self.SCMD1 + self.SCMD2
380 # -----------------------------------------------------------------------------
383 """Salome Session Graphic User Interface activation"""
387 import SALOME_ModuleCatalog
388 import SALOME_Session_idl
389 session=clt.waitNS("/Kernel/Session",SALOME.Session)
390 session.GetInterface()
392 # -----------------------------------------------------------------------------
394 def startSalome(args, modules_list, modules_root_dir):
395 """Launch all SALOME servers requested by args"""
396 init_time = os.times()
398 if verbose(): print "startSalome ", args
401 # Set server launch command
403 if args.has_key('server_launch_mode'):
404 Server.set_server_launch_mode(args['server_launch_mode'])
407 # Wake up session option
409 if args['wake_up_session']:
410 if "OMNIORB_CONFIG" not in os.environ:
411 from salome_utils import generateFileName
412 omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
414 if omniorbUserPath is not None:
415 kwargs["with_username"]=True
417 last_running_config = generateFileName(omniorbUserPath, prefix="omniORB",
422 os.environ['OMNIORB_CONFIG'] = last_running_config
427 # Initialisation ORB and Naming Service
430 clt=orbmodule.client(args)
433 # Wake up session option
435 if args['wake_up_session']:
439 import SALOME_ModuleCatalog
440 import SALOME_Session_idl
441 session = clt.waitNS("/Kernel/Session",SALOME.Session)
442 status = session.GetStatSession()
444 from salome_utils import getPortNumber
445 port = getPortNumber()
448 msg += "Session GUI for port number %s is already active."%(port)
450 msg += "If you which to wake up another session,"
452 msg += "please use variable OMNIORB_CONFIG"
454 msg += "to get the correct session object in naming service."
455 sys.stdout.write(msg+"\n")
458 session.GetInterface()
459 args["session_object"] = session
462 # Launch Logger Server (optional)
463 # and wait until it is registered in naming service
467 myServer=LoggerServer(args)
469 clt.waitLogger("Logger")
471 # Launch Session Server (to show splash ASAP)
475 mySessionServ = SessionServer(args,args['modules'],modules_root_dir)
476 mySessionServ.setpath(modules_list,modules_root_dir)
480 # Launch Registry Server,
481 # and wait until it is registered in naming service
484 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
485 myServer=RegistryServer(args)
487 if sys.platform == "win32":
488 clt.waitNS("/Registry")
490 clt.waitNSPID("/Registry",myServer.PID)
493 # Launch Catalog Server,
494 # and wait until it is registered in naming service
497 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
498 cataServer=CatalogServer(args)
499 cataServer.setpath(modules_list,modules_root_dir)
501 import SALOME_ModuleCatalog
502 if sys.platform == "win32":
503 clt.waitNS("/Kernel/ModulCatalog",SALOME_ModuleCatalog.ModuleCatalog)
505 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
508 # Launch SalomeDS Server,
509 # and wait until it is registered in naming service
512 #print "ARGS = ",args
513 if ('study' not in args['embedded']) | (args["gui"] == 0):
515 myServer=SalomeDSServer(args)
517 if sys.platform == "win32":
518 clt.waitNS("/myStudyManager")
520 clt.waitNSPID("/myStudyManager",myServer.PID)
523 # Launch LauncherServer
526 myCmServer = LauncherServer(args)
527 myCmServer.setpath(modules_list,modules_root_dir)
531 # Launch ConnectionManagerServer
534 myConnectionServer = ConnectionManagerServer(args)
535 myConnectionServer.run()
538 from Utils_Identity import getShortHostName
540 if os.getenv("HOSTNAME") == None:
541 if os.getenv("HOST") == None:
542 os.environ["HOSTNAME"]=getShortHostName()
544 os.environ["HOSTNAME"]=os.getenv("HOST")
546 theComputer = getShortHostName()
549 # Launch local C++ Container (FactoryServer),
550 # and wait until it is registered in naming service
553 if ('cppContainer' in args['standalone']) | (args["gui"] == 0) :
554 myServer=ContainerCPPServer(args, with_gui=args["gui"]!=0)
556 if sys.platform == "win32":
557 clt.waitNS("/Containers/" + theComputer + "/FactoryServer")
559 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
561 if 'pyContainer' in args['standalone']:
562 raise Exception('Python containers no longer supported')
565 # Wait until Session Server is registered in naming service
573 import SALOME_ModuleCatalog
574 import SALOME_Session_idl
575 if sys.platform == "win32":
576 session=clt.waitNS("/Kernel/Session",SALOME.Session)
578 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
579 args["session_object"] = session
580 end_time = os.times()
582 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
585 # ASV start GUI without Loader
587 # session.GetInterface()
590 # additional external python interpreters
596 nbaddi = args['interp']
599 traceback.print_exc()
600 print "-------------------------------------------------------------"
601 print "-- to get an external python interpreter:runSalome --interp=1"
602 print "-------------------------------------------------------------"
604 if verbose(): print "additional external python interpreters: ", nbaddi
606 for i in range(nbaddi):
608 anInterp=InterpServer(args)
611 # set PYTHONINSPECT variable (python interpreter in interactive mode)
613 os.environ["PYTHONINSPECT"]="1"
621 # -----------------------------------------------------------------------------
623 def useSalome(args, modules_list, modules_root_dir):
625 Launch all SALOME servers requested by args,
626 save list of process, give info to user,
627 show registered objects in Naming Service.
633 clt = startSalome(args, modules_list, modules_root_dir)
636 traceback.print_exc()
639 print "--- Error during Salome launch ---"
643 from addToKillList import addToKillList
644 from killSalomeWithPort import getPiDict
646 filedict = getPiDict(args['port'])
647 for pid, cmd in process_id.items():
648 addToKillList(pid, cmd, args['port'])
651 if verbose(): print """
652 Saving of the dictionary of Salome processes in %s
653 To kill SALOME processes from a console (kill all sessions from all ports):
655 To kill SALOME from the present interpreter, if it is not closed :
656 killLocalPort() --> kill this session
657 (use CORBA port from args of runSalome)
658 givenPortKill(port) --> kill a specific session with given CORBA port
659 killAllPorts() --> kill all sessions
661 runSalome, with --killall option, starts with killing
662 the processes resulting from the previous execution.
666 # Print Naming Service directory list
672 print " --- registered objects tree in Naming Service ---"
676 if not args['gui'] or not args['session_gui']:
677 if args['shutdown_servers']:
678 class __utils__(object):
679 def __init__(self, port):
681 import killSalomeWithPort
682 self.killSalomeWithPort = killSalomeWithPort
685 self.killSalomeWithPort.killMyPort(self.port)
691 atexit.register(func, __utils__(args['port']))
695 # run python scripts, passed as command line arguments
697 if args.has_key('gui') and args.has_key('session_gui'):
698 if not args['gui'] or not args['session_gui']:
699 if args.has_key('study_hdf'):
700 toopen = args['study_hdf']
703 salome.salome_init(toopen)
704 if args.has_key('pyscript'):
705 toimport = args['pyscript']
706 from salomeContextUtils import formatScriptsAndArgs
707 command = formatScriptsAndArgs(toimport)
709 proc = subprocess.Popen(command, shell=True)
710 addToKillList(proc.pid, command, args['port'])
712 if res: sys.exit(1) # if there's an error when executing script, we should explicitly exit
716 def execScript(script_path):
717 print 'executing', script_path
718 sys.path.insert(0, os.path.realpath(os.path.dirname(script_path)))
719 execfile(script_path,globals())
722 # -----------------------------------------------------------------------------
724 def registerEnv(args, modules_list, modules_root_dir):
726 Register args, modules_list, modules_root_dir in a file
727 for further use, when SALOME is launched embedded in an other application.
729 from salome_utils import getTmpDir
730 fileEnv = getTmpDir()
731 from salome_utils import getUserName
732 fileEnv += getUserName() + "_" + str(args['port']) \
733 + '_' + args['appname'].upper() + '_env'
734 fenv=open(fileEnv,'w')
735 pickle.dump((args, modules_list, modules_root_dir),fenv)
737 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
739 # -----------------------------------------------------------------------------
742 """Salome Launch, when embedded in other application"""
743 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
744 fenv=open(fileEnv,'r')
745 args, modules_list, modules_root_dir = pickle.load(fenv)
748 from searchFreePort import searchFreePort
749 searchFreePort(args, 0)
750 clt = useSalome(args, modules_list, modules_root_dir)
753 # -----------------------------------------------------------------------------
755 def main(exeName=None):
756 """Salome launch as a main application"""
758 # define folder to store omniorb config (initially in virtual application folder)
760 from salomeContextUtils import setOmniOrbUserPath
766 from salome_utils import getHostName
767 args, modules_list, modules_root_dir = setenv.get_config(exeName=exeName)
768 print "runSalome running on %s" % getHostName()
772 if args.has_key('save_config'):
773 save_config = args['save_config']
776 if args['wake_up_session']:
780 from searchFreePort import searchFreePort
781 searchFreePort(args, save_config, args.get('useport'))
785 setenv.set_env(args, modules_list, modules_root_dir)
786 clt = useSalome(args, modules_list, modules_root_dir)
789 # -----------------------------------------------------------------------------
791 def foreGround(clt, args):
793 if "session_object" not in args:
795 session = args["session_object"]
797 # Wait until gui is arrived
806 status = session.GetStatSession()
807 gui_detected = status.activeGUI
812 from time import sleep
822 from salome_utils import getPortNumber
823 port = getPortNumber()
826 if sys.platform == "win32":
827 server.CMD = [os.getenv("PYTHONBIN"), "-m", "killSalomeWithPort", "--spy", "%s"%(os.getpid()), "%s"%(port)]
829 server.CMD = ["killSalomeWithPort.py", "--spy", "%s"%(os.getpid()), "%s"%(port)]
831 # os.system("killSalomeWithPort.py --spy %s %s &"%(os.getpid(), port))
837 status = session.GetStatSession()
838 assert status.activeGUI
841 from time import sleep
845 except KeyboardInterrupt:
846 from killSalomeWithPort import killMyPort
856 test = args['gui'] and args['session_gui']
857 test = test or args['wake_up_session']
859 # The next test covers the --pinter option or if var PYTHONINSPECT is set
861 test = test and not os.environ.get('PYTHONINSPECT')
863 # The next test covers the python -i $KERNEL_ROOT_DIR/bin/salome/runSalome.py case
866 from ctypes import POINTER, c_int, cast, pythonapi
867 iflag_ptr = cast(pythonapi.Py_InteractiveFlag, POINTER(c_int))
868 test = test and not iflag_ptr.contents.value
872 test = test and os.getenv("SALOME_TEST_MODE", "0") != "1"
873 test = test and args['foreground']
876 foreGround(clt, args)
881 # -----------------------------------------------------------------------------
883 if __name__ == "__main__":