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 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 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):
195 self.CMD=['SALOME_Container','FactoryServer']
199 class LoggerServer(Server):
200 def __init__(self,args):
203 from salome_utils import generateFileName, getLogDir
204 logfile = generateFileName( getLogDir(),
210 print "==========================================================="
211 print "Logger server: put log to the file:"
213 print "==========================================================="
214 self.CMD=['SALOME_Logger_Server', logfile]
216 pass # end of LoggerServer class
220 class SessionServer(Server):
221 def __init__(self,args,modules_list,modules_root_dir):
222 self.args = args.copy()
223 # Bug 11512 (Problems with runSalome --xterm on Mandrake and Debian Sarge)
224 #self.args['xterm']=0
227 self.SCMD1=['SALOME_Session_Server']
229 if 'registry' in self.args['embedded']:
230 self.SCMD1+=['--with','Registry',
231 '(','--salome_session','theSession',')']
232 if 'moduleCatalog' in self.args['embedded']:
233 self.SCMD1+=['--with','ModuleCatalog','(','-common']
234 home_dir=os.getenv('HOME')
235 if home_dir is not None:
236 self.SCMD2+=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
238 if 'study' in self.args['embedded']:
239 self.SCMD2+=['--with','SALOMEDS','(',')']
240 if 'cppContainer' in self.args['embedded']:
241 self.SCMD2+=['--with','Container','(','FactoryServer',')']
242 if 'SalomeAppEngine' in self.args['embedded']:
243 self.SCMD2+=['--with','SalomeAppEngine','(',')']
245 if 'cppContainer' in self.args['standalone'] or 'cppContainer' in self.args['embedded']:
247 if 'pyContainer' in self.args['standalone'] or 'pyContainer' in self.args['embedded']:
248 raise Exception('Python containers no longer supported')
251 if self.args.has_key('session_gui'):
252 session_gui = self.args['session_gui']
255 if self.args['splash']:
256 self.SCMD2+=['SPLASH']
258 if self.args['study_hdf'] is not None:
259 self.SCMD2+=['--study-hdf=%s'%self.args['study_hdf']]
262 if self.args.has_key('pyscript') and len(self.args['pyscript']) > 0:
263 msg = json.dumps(self.args['pyscript'], cls=ScriptAndArgsObjectEncoder)
264 self.SCMD2+=['--pyscript=%s'%(msg)]
268 if self.args['noexcepthandler']:
269 self.SCMD2+=['noexcepthandler']
270 if self.args.has_key('user_config'):
271 self.SCMD2+=['--resources=%s'%self.args['user_config']]
272 if self.args.has_key('modules'):
274 #keep only modules with GUI
275 for m in modules_list:
276 if m not in modules_root_dir:
277 list_modules.insert(0,m)
279 fr1 = os.path.join(modules_root_dir[m],"share","salome","resources",m.lower(),"SalomeApp.xml")
280 fr2 = os.path.join(modules_root_dir[m],"share","salome","resources","SalomeApp.xml")
281 if os.path.exists(fr1) or os.path.exists(fr2):
282 list_modules.insert(0,m)
283 list_modules.reverse()
284 self.SCMD2+=['--modules (%s)' % ":".join(list_modules)]
286 if self.args.has_key('language'):
287 self.SCMD2+=['--language=%s' % self.args['language']]
290 def setpath(self,modules_list,modules_root_dir):
291 list_modules = modules_list[:]
292 list_modules.reverse()
293 if self.args["gui"] :
294 list_modules = ["KERNEL", "GUI"] + list_modules
296 list_modules = ["KERNEL"] + list_modules
298 cata_path=get_cata_path(list_modules,modules_root_dir)
300 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
301 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
302 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
304 self.CMD=self.SCMD1 + self.SCMD2
305 if self.args.has_key('test'):
306 self.CMD+=['-test'] + self.args['test']
307 elif self.args.has_key('play'):
308 self.CMD+=['-play'] + self.args['play']
310 if self.args["gdb_session"] or self.args["ddd_session"]:
311 f = open(".gdbinit4salome", "w")
313 args = " ".join(self.CMD[1:])
314 args = args.replace("(", "\(")
315 args = args.replace(")", "\)")
319 if self.args["ddd_session"]:
320 self.CMD = ["ddd", "--command=.gdbinit4salome", self.CMD[0]]
321 elif self.args["gdb_session"]:
322 self.CMD = ["xterm", "-e", "gdb", "--command=.gdbinit4salome", self.CMD[0]]
326 if self.args["valgrind_session"]:
328 val = os.getenv("VALGRIND_OPTIONS")
332 self.CMD = l + self.CMD
337 class LauncherServer(Server):
338 def __init__(self,args):
341 self.SCMD1=['SALOME_LauncherServer']
344 if 'registry' in self.args['embedded']:
345 self.SCMD1+=['--with','Registry',
346 '(','--salome_session','theSession',')']
347 if 'moduleCatalog' in self.args['embedded']:
348 self.SCMD1+=['--with','ModuleCatalog','(','-common']
349 self.SCMD2+=['-personal',
350 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
351 if 'study' in self.args['embedded']:
352 self.SCMD2+=['--with','SALOMEDS','(',')']
353 if 'cppContainer' in self.args['embedded']:
354 self.SCMD2+=['--with','Container','(','FactoryServer',')']
356 def setpath(self,modules_list,modules_root_dir):
357 list_modules = modules_list[:]
358 list_modules.reverse()
359 if self.args["gui"] :
360 list_modules = ["KERNEL", "GUI"] + list_modules
362 list_modules = ["KERNEL"] + list_modules
364 cata_path=get_cata_path(list_modules,modules_root_dir)
366 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
367 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
368 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
370 self.CMD=self.SCMD1 + self.SCMD2
372 # -----------------------------------------------------------------------------
375 """Salome Session Graphic User Interface activation"""
379 import SALOME_ModuleCatalog
380 import SALOME_Session_idl
381 session=clt.waitNS("/Kernel/Session",SALOME.Session)
382 session.GetInterface()
384 # -----------------------------------------------------------------------------
386 def startSalome(args, modules_list, modules_root_dir):
387 """Launch all SALOME servers requested by args"""
388 init_time = os.times()
390 if verbose(): print "startSalome ", args
393 # Set server launch command
395 if args.has_key('server_launch_mode'):
396 Server.set_server_launch_mode(args['server_launch_mode'])
399 # Wake up session option
401 if args['wake_up_session']:
402 if "OMNIORB_CONFIG" not in os.environ:
403 from salome_utils import generateFileName
404 omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
406 if omniorbUserPath is not None:
407 kwargs["with_username"]=True
409 last_running_config = generateFileName(omniorbUserPath, prefix="omniORB",
414 os.environ['OMNIORB_CONFIG'] = last_running_config
419 # Initialisation ORB and Naming Service
422 clt=orbmodule.client(args)
425 # Wake up session option
427 if args['wake_up_session']:
431 import SALOME_ModuleCatalog
432 import SALOME_Session_idl
433 session = clt.waitNS("/Kernel/Session",SALOME.Session)
434 status = session.GetStatSession()
436 from salome_utils import getPortNumber
437 port = getPortNumber()
440 msg += "Session GUI for port number %s is already active."%(port)
442 msg += "If you which to wake up another session,"
444 msg += "please use variable OMNIORB_CONFIG"
446 msg += "to get the correct session object in naming service."
447 sys.stdout.write(msg+"\n")
450 session.GetInterface()
451 args["session_object"] = session
454 # Launch Logger Server (optional)
455 # and wait until it is registered in naming service
459 myServer=LoggerServer(args)
461 clt.waitLogger("Logger")
463 # Launch Session Server (to show splash ASAP)
467 mySessionServ = SessionServer(args,args['modules'],modules_root_dir)
468 mySessionServ.setpath(modules_list,modules_root_dir)
472 # Launch Registry Server,
473 # and wait until it is registered in naming service
476 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
477 myServer=RegistryServer(args)
479 if sys.platform == "win32":
480 clt.waitNS("/Registry")
482 clt.waitNSPID("/Registry",myServer.PID)
485 # Launch Catalog Server,
486 # and wait until it is registered in naming service
489 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
490 cataServer=CatalogServer(args)
491 cataServer.setpath(modules_list,modules_root_dir)
493 import SALOME_ModuleCatalog
494 if sys.platform == "win32":
495 clt.waitNS("/Kernel/ModulCatalog",SALOME_ModuleCatalog.ModuleCatalog)
497 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
500 # Launch SalomeDS Server,
501 # and wait until it is registered in naming service
504 #print "ARGS = ",args
505 if ('study' not in args['embedded']) | (args["gui"] == 0):
507 myServer=SalomeDSServer(args)
509 if sys.platform == "win32":
510 clt.waitNS("/myStudyManager")
512 clt.waitNSPID("/myStudyManager",myServer.PID)
515 # Launch LauncherServer
518 myCmServer = LauncherServer(args)
519 myCmServer.setpath(modules_list,modules_root_dir)
523 # Launch ConnectionManagerServer
526 myConnectionServer = ConnectionManagerServer(args)
527 myConnectionServer.run()
530 from Utils_Identity import getShortHostName
532 if os.getenv("HOSTNAME") == None:
533 if os.getenv("HOST") == None:
534 os.environ["HOSTNAME"]=getShortHostName()
536 os.environ["HOSTNAME"]=os.getenv("HOST")
538 theComputer = getShortHostName()
541 # Launch local C++ Container (FactoryServer),
542 # and wait until it is registered in naming service
545 if ('cppContainer' in args['standalone']) | (args["gui"] == 0) :
546 myServer=ContainerCPPServer(args)
548 if sys.platform == "win32":
549 clt.waitNS("/Containers/" + theComputer + "/FactoryServer")
551 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
553 if 'pyContainer' in args['standalone']:
554 raise Exception('Python containers no longer supported')
557 # Wait until Session Server is registered in naming service
565 import SALOME_ModuleCatalog
566 import SALOME_Session_idl
567 if sys.platform == "win32":
568 session=clt.waitNS("/Kernel/Session",SALOME.Session)
570 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
571 args["session_object"] = session
572 end_time = os.times()
574 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
577 # ASV start GUI without Loader
579 # session.GetInterface()
582 # additionnal external python interpreters
588 nbaddi = args['interp']
591 traceback.print_exc()
592 print "-------------------------------------------------------------"
593 print "-- to get an external python interpreter:runSalome --interp=1"
594 print "-------------------------------------------------------------"
596 if verbose(): print "additional external python interpreters: ", nbaddi
598 for i in range(nbaddi):
600 anInterp=InterpServer(args)
603 # set PYTHONINSPECT variable (python interpreter in interactive mode)
605 os.environ["PYTHONINSPECT"]="1"
613 # -----------------------------------------------------------------------------
615 def useSalome(args, modules_list, modules_root_dir):
617 Launch all SALOME servers requested by args,
618 save list of process, give info to user,
619 show registered objects in Naming Service.
625 clt = startSalome(args, modules_list, modules_root_dir)
628 traceback.print_exc()
631 print "--- Error during Salome launch ---"
635 from addToKillList import addToKillList
636 from killSalomeWithPort import getPiDict
638 filedict = getPiDict(args['port'])
639 for pid, cmd in process_id.items():
640 addToKillList(pid, cmd, args['port'])
643 if verbose(): print """
644 Saving of the dictionary of Salome processes in %s
645 To kill SALOME processes from a console (kill all sessions from all ports):
647 To kill SALOME from the present interpreter, if it is not closed :
648 killLocalPort() --> kill this session
649 (use CORBA port from args of runSalome)
650 givenPortKill(port) --> kill a specific session with given CORBA port
651 killAllPorts() --> kill all sessions
653 runSalome, with --killall option, starts with killing
654 the processes resulting from the previous execution.
658 # Print Naming Service directory list
664 print " --- registered objects tree in Naming Service ---"
668 if not args['gui'] or not args['session_gui']:
669 if args['shutdown_servers']:
670 class __utils__(object):
671 def __init__(self, port):
673 import killSalomeWithPort
674 self.killSalomeWithPort = killSalomeWithPort
677 self.killSalomeWithPort.killMyPort(self.port)
683 atexit.register(func, __utils__(args['port']))
687 # run python scripts, passed as command line arguments
689 if args.has_key('gui') and args.has_key('session_gui'):
690 if not args['gui'] or not args['session_gui']:
691 if args.has_key('study_hdf'):
692 toopen = args['study_hdf']
695 salome.salome_init(toopen)
696 if args.has_key('pyscript'):
697 toimport = args['pyscript']
698 from salomeContextUtils import formatScriptsAndArgs
699 command = formatScriptsAndArgs(toimport)
701 proc = subprocess.Popen(command, shell=True)
702 addToKillList(proc.pid, command, args['port'])
704 if res: sys.exit(1) # if there's an error when executing script, we should explicitly exit
708 def execScript(script_path):
709 print 'executing', script_path
710 sys.path.insert(0, os.path.realpath(os.path.dirname(script_path)))
711 execfile(script_path,globals())
714 # -----------------------------------------------------------------------------
716 def registerEnv(args, modules_list, modules_root_dir):
718 Register args, modules_list, modules_root_dir in a file
719 for further use, when SALOME is launched embedded in an other application.
721 from salome_utils import getTmpDir
722 fileEnv = getTmpDir()
723 from salome_utils import getUserName
724 fileEnv += getUserName() + "_" + str(args['port']) \
725 + '_' + args['appname'].upper() + '_env'
726 fenv=open(fileEnv,'w')
727 pickle.dump((args, modules_list, modules_root_dir),fenv)
729 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
731 # -----------------------------------------------------------------------------
734 """Salome Launch, when embedded in other application"""
735 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
736 fenv=open(fileEnv,'r')
737 args, modules_list, modules_root_dir = pickle.load(fenv)
740 from searchFreePort import searchFreePort
741 searchFreePort(args, 0)
742 clt = useSalome(args, modules_list, modules_root_dir)
745 # -----------------------------------------------------------------------------
747 def main(exeName=None):
748 """Salome launch as a main application"""
750 # define folder to store omniorb config (initially in virtual application folder)
752 from salomeContextUtils import setOmniOrbUserPath
758 from salome_utils import getHostName
759 args, modules_list, modules_root_dir = setenv.get_config(exeName=exeName)
760 print "runSalome running on %s" % getHostName()
764 if args.has_key('save_config'):
765 save_config = args['save_config']
768 if args['wake_up_session']:
772 from searchFreePort import searchFreePort
773 searchFreePort(args, save_config, args.get('useport'))
777 setenv.set_env(args, modules_list, modules_root_dir)
778 clt = useSalome(args, modules_list, modules_root_dir)
781 # -----------------------------------------------------------------------------
783 def foreGround(clt, args):
785 if "session_object" not in args:
787 session = args["session_object"]
789 # Wait until gui is arrived
798 status = session.GetStatSession()
799 gui_detected = status.activeGUI
804 from time import sleep
814 from salome_utils import getPortNumber
815 port = getPortNumber()
818 if sys.platform == "win32":
819 server.CMD = [os.getenv("PYTHONBIN"), "-m", "killSalomeWithPort", "--spy", "%s"%(os.getpid()), "%s"%(port)]
821 server.CMD = ["killSalomeWithPort.py", "--spy", "%s"%(os.getpid()), "%s"%(port)]
823 # os.system("killSalomeWithPort.py --spy %s %s &"%(os.getpid(), port))
829 status = session.GetStatSession()
830 assert status.activeGUI
833 from time import sleep
837 except KeyboardInterrupt:
838 from killSalomeWithPort import killMyPort
848 test = args['gui'] and args['session_gui']
849 test = test or args['wake_up_session']
851 # The next test covers the --pinter option or var PYTHONINSPECT setted
853 test = test and not os.environ.get('PYTHONINSPECT')
855 # The next test covers the python -i $KERNEL_ROOT_DIR/bin/salome/runSalome.py case
858 from ctypes import POINTER, c_int, cast, pythonapi
859 iflag_ptr = cast(pythonapi.Py_InteractiveFlag, POINTER(c_int))
860 test = test and not iflag_ptr.contents.value
864 test = test and os.getenv("SALOME_TEST_MODE", "0") != "1"
865 test = test and args['foreground']
868 foreGround(clt, args)
873 # -----------------------------------------------------------------------------
875 if __name__ == "__main__":