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 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
103 pid = subprocess.Popen(command).pid
104 process_id[pid]=self.CMD
109 def get_cata_path(list_modules,modules_root_dir):
110 """Build a list of catalog paths (cata_path) to initialize the ModuleCatalog server
115 for module in list_modules:
116 if modules_root_dir.has_key(module):
117 module_root_dir=modules_root_dir[module]
118 module_cata=module+"Catalog.xml"
119 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources",module.lower(), module_cata)
121 if os.path.exists(cata_file):
122 cata_path.append(cata_file)
123 modules_cata[module]=cata_file
125 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources", module_cata)
126 if os.path.exists(cata_file):
127 cata_path.append(cata_file)
128 modules_cata[module]=cata_file
130 for path in os.getenv("SALOME_CATALOGS_PATH","").split(os.pathsep):
131 if os.path.exists(path):
132 for cata_file in glob.glob(os.path.join(path,"*Catalog.xml")):
133 module_name= os.path.basename(cata_file)[:-11]
134 if not modules_cata.has_key(module_name):
135 cata_path.append(cata_file)
136 modules_cata[module_name]=cata_file
140 class CatalogServer(Server):
141 def __init__(self,args):
144 self.SCMD1=['SALOME_ModuleCatalog_Server','-common']
146 home_dir=os.getenv('HOME')
147 if home_dir is not None:
148 self.SCMD2=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
150 def setpath(self,modules_list,modules_root_dir):
151 list_modules = modules_list[:]
152 list_modules.reverse()
153 if self.args["gui"] :
154 list_modules = ["KERNEL", "GUI"] + list_modules
156 list_modules = ["KERNEL"] + list_modules
158 cata_path=get_cata_path(list_modules,modules_root_dir)
160 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
164 class SalomeDSServer(Server):
165 def __init__(self,args):
168 self.CMD=['SALOMEDS_Server']
172 class ConnectionManagerServer(Server):
173 def __init__(self,args):
176 self.CMD=['SALOME_ConnectionManagerServer']
180 class RegistryServer(Server):
181 def __init__(self,args):
184 self.CMD=['SALOME_Registry_Server', '--salome_session','theSession']
188 class ContainerCPPServer(Server):
189 def __init__(self,args):
192 self.CMD=['SALOME_Container','FactoryServer']
196 class LoggerServer(Server):
197 def __init__(self,args):
200 from salome_utils import generateFileName, getLogDir
201 logfile = generateFileName( getLogDir(),
207 print "==========================================================="
208 print "Logger server: put log to the file:"
210 print "==========================================================="
211 self.CMD=['SALOME_Logger_Server', logfile]
213 pass # end of LoggerServer class
217 class SessionServer(Server):
218 def __init__(self,args,modules_list,modules_root_dir):
219 self.args = args.copy()
220 # Bug 11512 (Problems with runSalome --xterm on Mandrake and Debian Sarge)
221 #self.args['xterm']=0
224 self.SCMD1=['SALOME_Session_Server']
226 if 'registry' in self.args['embedded']:
227 self.SCMD1+=['--with','Registry',
228 '(','--salome_session','theSession',')']
229 if 'moduleCatalog' in self.args['embedded']:
230 self.SCMD1+=['--with','ModuleCatalog','(','-common']
231 home_dir=os.getenv('HOME')
232 if home_dir is not None:
233 self.SCMD2+=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
235 if 'study' in self.args['embedded']:
236 self.SCMD2+=['--with','SALOMEDS','(',')']
237 if 'cppContainer' in self.args['embedded']:
238 self.SCMD2+=['--with','Container','(','FactoryServer',')']
239 if 'SalomeAppEngine' in self.args['embedded']:
240 self.SCMD2+=['--with','SalomeAppEngine','(',')']
242 if 'cppContainer' in self.args['standalone'] or 'cppContainer' in self.args['embedded']:
244 if 'pyContainer' in self.args['standalone'] or 'pyContainer' in self.args['embedded']:
245 raise Exception('Python containers no longer supported')
248 if self.args.has_key('session_gui'):
249 session_gui = self.args['session_gui']
252 if self.args['splash']:
253 self.SCMD2+=['SPLASH']
255 if self.args['study_hdf'] is not None:
256 self.SCMD2+=['--study-hdf=%s'%self.args['study_hdf']]
259 if self.args.has_key('pyscript') and len(self.args['pyscript']) > 0:
260 msg = json.dumps(self.args['pyscript'], cls=ScriptAndArgsObjectEncoder)
261 self.SCMD2+=['--pyscript=%s'%(msg)]
265 if self.args['noexcepthandler']:
266 self.SCMD2+=['noexcepthandler']
267 if self.args.has_key('user_config'):
268 self.SCMD2+=['--resources=%s'%self.args['user_config']]
269 if self.args.has_key('modules'):
271 #keep only modules with GUI
272 for m in modules_list:
273 if m not in modules_root_dir:
274 list_modules.insert(0,m)
276 fr1 = os.path.join(modules_root_dir[m],"share","salome","resources",m.lower(),"SalomeApp.xml")
277 fr2 = os.path.join(modules_root_dir[m],"share","salome","resources","SalomeApp.xml")
278 if os.path.exists(fr1) or os.path.exists(fr2):
279 list_modules.insert(0,m)
280 list_modules.reverse()
281 self.SCMD2+=['--modules (%s)' % ":".join(list_modules)]
283 if self.args.has_key('language'):
284 self.SCMD2+=['--language=%s' % self.args['language']]
287 def setpath(self,modules_list,modules_root_dir):
288 list_modules = modules_list[:]
289 list_modules.reverse()
290 if self.args["gui"] :
291 list_modules = ["KERNEL", "GUI"] + list_modules
293 list_modules = ["KERNEL"] + list_modules
295 cata_path=get_cata_path(list_modules,modules_root_dir)
297 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
298 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
299 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
301 self.CMD=self.SCMD1 + self.SCMD2
302 if self.args.has_key('test'):
303 self.CMD+=['-test'] + self.args['test']
304 elif self.args.has_key('play'):
305 self.CMD+=['-play'] + self.args['play']
307 if self.args["gdb_session"] or self.args["ddd_session"]:
308 f = open(".gdbinit4salome", "w")
310 args = " ".join(self.CMD[1:])
311 args = args.replace("(", "\(")
312 args = args.replace(")", "\)")
316 if self.args["ddd_session"]:
317 self.CMD = ["ddd", "--command=.gdbinit4salome", self.CMD[0]]
318 elif self.args["gdb_session"]:
319 self.CMD = ["xterm", "-e", "gdb", "--command=.gdbinit4salome", self.CMD[0]]
323 if self.args["valgrind_session"]:
325 val = os.getenv("VALGRIND_OPTIONS")
329 self.CMD = l + self.CMD
334 class LauncherServer(Server):
335 def __init__(self,args):
338 self.SCMD1=['SALOME_LauncherServer']
341 if 'registry' in self.args['embedded']:
342 self.SCMD1+=['--with','Registry',
343 '(','--salome_session','theSession',')']
344 if 'moduleCatalog' in self.args['embedded']:
345 self.SCMD1+=['--with','ModuleCatalog','(','-common']
346 self.SCMD2+=['-personal',
347 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
348 if 'study' in self.args['embedded']:
349 self.SCMD2+=['--with','SALOMEDS','(',')']
350 if 'cppContainer' in self.args['embedded']:
351 self.SCMD2+=['--with','Container','(','FactoryServer',')']
353 def setpath(self,modules_list,modules_root_dir):
354 list_modules = modules_list[:]
355 list_modules.reverse()
356 if self.args["gui"] :
357 list_modules = ["KERNEL", "GUI"] + list_modules
359 list_modules = ["KERNEL"] + list_modules
361 cata_path=get_cata_path(list_modules,modules_root_dir)
363 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
364 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
365 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
367 self.CMD=self.SCMD1 + self.SCMD2
369 # -----------------------------------------------------------------------------
372 """Salome Session Graphic User Interface activation"""
376 import SALOME_ModuleCatalog
377 import SALOME_Session_idl
378 session=clt.waitNS("/Kernel/Session",SALOME.Session)
379 session.GetInterface()
381 # -----------------------------------------------------------------------------
383 def startSalome(args, modules_list, modules_root_dir):
384 """Launch all SALOME servers requested by args"""
385 init_time = os.times()
387 if verbose(): print "startSalome ", args
390 # Set server launch command
392 if args.has_key('server_launch_mode'):
393 Server.set_server_launch_mode(args['server_launch_mode'])
396 # Wake up session option
398 if args['wake_up_session']:
399 if "OMNIORB_CONFIG" not in os.environ:
400 from salome_utils import generateFileName
401 omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
403 if omniorbUserPath is not None:
404 kwargs["with_username"]=True
406 last_running_config = generateFileName(omniorbUserPath, prefix="omniORB",
411 os.environ['OMNIORB_CONFIG'] = last_running_config
416 # Initialisation ORB and Naming Service
419 clt=orbmodule.client(args)
422 # Wake up session option
424 if args['wake_up_session']:
428 import SALOME_ModuleCatalog
429 import SALOME_Session_idl
430 session = clt.waitNS("/Kernel/Session",SALOME.Session)
431 status = session.GetStatSession()
433 from salome_utils import getPortNumber
434 port = getPortNumber()
437 msg += "Session GUI for port number %s is already active."%(port)
439 msg += "If you which to wake up another session,"
441 msg += "please use variable OMNIORB_CONFIG"
443 msg += "to get the correct session object in naming service."
444 sys.stdout.write(msg+"\n")
447 session.GetInterface()
448 args["session_object"] = session
451 # Launch Logger Server (optional)
452 # and wait until it is registered in naming service
456 myServer=LoggerServer(args)
458 clt.waitLogger("Logger")
460 # Launch Session Server (to show splash ASAP)
464 mySessionServ = SessionServer(args,args['modules'],modules_root_dir)
465 mySessionServ.setpath(modules_list,modules_root_dir)
469 # Launch Registry Server,
470 # and wait until it is registered in naming service
473 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
474 myServer=RegistryServer(args)
476 if sys.platform == "win32":
477 clt.waitNS("/Registry")
479 clt.waitNSPID("/Registry",myServer.PID)
482 # Launch Catalog Server,
483 # and wait until it is registered in naming service
486 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
487 cataServer=CatalogServer(args)
488 cataServer.setpath(modules_list,modules_root_dir)
490 import SALOME_ModuleCatalog
491 if sys.platform == "win32":
492 clt.waitNS("/Kernel/ModulCatalog",SALOME_ModuleCatalog.ModuleCatalog)
494 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
497 # Launch SalomeDS Server,
498 # and wait until it is registered in naming service
501 #print "ARGS = ",args
502 if ('study' not in args['embedded']) | (args["gui"] == 0):
504 myServer=SalomeDSServer(args)
506 if sys.platform == "win32":
507 clt.waitNS("/myStudyManager")
509 clt.waitNSPID("/myStudyManager",myServer.PID)
512 # Launch LauncherServer
515 myCmServer = LauncherServer(args)
516 myCmServer.setpath(modules_list,modules_root_dir)
520 # Launch ConnectionManagerServer
523 myConnectionServer = ConnectionManagerServer(args)
524 myConnectionServer.run()
527 from Utils_Identity import getShortHostName
529 if os.getenv("HOSTNAME") == None:
530 if os.getenv("HOST") == None:
531 os.environ["HOSTNAME"]=getShortHostName()
533 os.environ["HOSTNAME"]=os.getenv("HOST")
535 theComputer = getShortHostName()
538 # Launch local C++ Container (FactoryServer),
539 # and wait until it is registered in naming service
542 if ('cppContainer' in args['standalone']) | (args["gui"] == 0) :
543 myServer=ContainerCPPServer(args)
545 if sys.platform == "win32":
546 clt.waitNS("/Containers/" + theComputer + "/FactoryServer")
548 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
550 if 'pyContainer' in args['standalone']:
551 raise Exception('Python containers no longer supported')
554 # Wait until Session Server is registered in naming service
562 import SALOME_ModuleCatalog
563 import SALOME_Session_idl
564 if sys.platform == "win32":
565 session=clt.waitNS("/Kernel/Session",SALOME.Session)
567 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
568 args["session_object"] = session
569 end_time = os.times()
571 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
574 # ASV start GUI without Loader
576 # session.GetInterface()
579 # additionnal external python interpreters
585 nbaddi = args['interp']
588 traceback.print_exc()
589 print "-------------------------------------------------------------"
590 print "-- to get an external python interpreter:runSalome --interp=1"
591 print "-------------------------------------------------------------"
593 if verbose(): print "additional external python interpreters: ", nbaddi
595 for i in range(nbaddi):
597 anInterp=InterpServer(args)
600 # set PYTHONINSPECT variable (python interpreter in interactive mode)
602 os.environ["PYTHONINSPECT"]="1"
610 # -----------------------------------------------------------------------------
612 def useSalome(args, modules_list, modules_root_dir):
614 Launch all SALOME servers requested by args,
615 save list of process, give info to user,
616 show registered objects in Naming Service.
622 clt = startSalome(args, modules_list, modules_root_dir)
625 traceback.print_exc()
628 print "--- Error during Salome launch ---"
632 from addToKillList import addToKillList
633 from killSalomeWithPort import getPiDict
635 filedict = getPiDict(args['port'])
636 for pid, cmd in process_id.items():
637 addToKillList(pid, cmd, args['port'])
640 if verbose(): print """
641 Saving of the dictionary of Salome processes in %s
642 To kill SALOME processes from a console (kill all sessions from all ports):
644 To kill SALOME from the present interpreter, if it is not closed :
645 killLocalPort() --> kill this session
646 (use CORBA port from args of runSalome)
647 givenPortKill(port) --> kill a specific session with given CORBA port
648 killAllPorts() --> kill all sessions
650 runSalome, with --killall option, starts with killing
651 the processes resulting from the previous execution.
655 # Print Naming Service directory list
661 print " --- registered objects tree in Naming Service ---"
665 if not args['gui'] or not args['session_gui']:
666 if args['shutdown_servers']:
667 class __utils__(object):
668 def __init__(self, port):
670 import killSalomeWithPort
671 self.killSalomeWithPort = killSalomeWithPort
674 self.killSalomeWithPort.killMyPort(self.port)
680 atexit.register(func, __utils__(args['port']))
684 # run python scripts, passed as command line arguments
686 if args.has_key('gui') and args.has_key('session_gui'):
687 if not args['gui'] or not args['session_gui']:
688 if args.has_key('study_hdf'):
689 toopen = args['study_hdf']
692 salome.salome_init(toopen)
693 if args.has_key('pyscript'):
694 toimport = args['pyscript']
695 from salomeContextUtils import formatScriptsAndArgs
696 command = formatScriptsAndArgs(toimport)
698 proc = subprocess.Popen(command, shell=True)
699 addToKillList(proc.pid, command, args['port'])
701 if res: sys.exit(1) # if there's an error when executing script, we should explicitly exit
705 def execScript(script_path):
706 print 'executing', script_path
707 sys.path.insert(0, os.path.realpath(os.path.dirname(script_path)))
708 execfile(script_path,globals())
711 # -----------------------------------------------------------------------------
713 def registerEnv(args, modules_list, modules_root_dir):
715 Register args, modules_list, modules_root_dir in a file
716 for further use, when SALOME is launched embedded in an other application.
718 from salome_utils import getTmpDir
719 fileEnv = getTmpDir()
720 from salome_utils import getUserName
721 fileEnv += getUserName() + "_" + str(args['port']) \
722 + '_' + args['appname'].upper() + '_env'
723 fenv=open(fileEnv,'w')
724 pickle.dump((args, modules_list, modules_root_dir),fenv)
726 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
728 # -----------------------------------------------------------------------------
731 """Salome Launch, when embedded in other application"""
732 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
733 fenv=open(fileEnv,'r')
734 args, modules_list, modules_root_dir = pickle.load(fenv)
737 from searchFreePort import searchFreePort
738 searchFreePort(args, 0)
739 clt = useSalome(args, modules_list, modules_root_dir)
742 # -----------------------------------------------------------------------------
744 def main(exeName=None):
745 """Salome launch as a main application"""
747 # define folder to store omniorb config (initially in virtual application folder)
749 from salomeContextUtils import setOmniOrbUserPath
755 from salome_utils import getHostName
756 args, modules_list, modules_root_dir = setenv.get_config(exeName=exeName)
757 print "runSalome running on %s" % getHostName()
761 if args.has_key('save_config'):
762 save_config = args['save_config']
765 if args['wake_up_session']:
769 from searchFreePort import searchFreePort
770 searchFreePort(args, save_config, args.get('useport'))
774 setenv.set_env(args, modules_list, modules_root_dir)
775 clt = useSalome(args, modules_list, modules_root_dir)
778 # -----------------------------------------------------------------------------
780 def foreGround(clt, args):
782 if "session_object" not in args:
784 session = args["session_object"]
786 # Wait until gui is arrived
795 status = session.GetStatSession()
796 gui_detected = status.activeGUI
801 from time import sleep
811 from salome_utils import getPortNumber
812 port = getPortNumber()
815 if sys.platform == "win32":
816 server.CMD = [os.getenv("PYTHONBIN"), "-m", "killSalomeWithPort", "--spy", "%s"%(os.getpid()), "%s"%(port)]
818 server.CMD = ["killSalomeWithPort.py", "--spy", "%s"%(os.getpid()), "%s"%(port)]
820 # os.system("killSalomeWithPort.py --spy %s %s &"%(os.getpid(), port))
826 status = session.GetStatSession()
827 assert status.activeGUI
830 from time import sleep
834 except KeyboardInterrupt:
835 from killSalomeWithPort import killMyPort
845 test = args['gui'] and args['session_gui']
846 test = test or args['wake_up_session']
848 # The next test covers the --pinter option or var PYTHONINSPECT setted
850 test = test and not os.environ.get('PYTHONINSPECT')
852 # The next test covers the python -i $KERNEL_ROOT_DIR/bin/salome/runSalome.py case
855 from ctypes import POINTER, c_int, cast, pythonapi
856 iflag_ptr = cast(pythonapi.Py_InteractiveFlag, POINTER(c_int))
857 test = test and not iflag_ptr.contents.value
861 test = test and os.getenv("SALOME_TEST_MODE", "0") != "1"
862 test = test and args['foreground']
865 foreGround(clt, args)
870 # -----------------------------------------------------------------------------
872 if __name__ == "__main__":