2 # Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
4 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 # \brief Module that provides services to launch SALOME
28 import sys, os, string, glob, time, pickle, re
32 from launchConfigureParser import verbose
33 from server import process_id
35 # -----------------------------------------------------------------------------
37 from killSalome import killAllPorts
41 kill servers from a previous SALOME exection, if needed,
42 on the CORBA port given in args of runSalome
45 from killSalomeWithPort import killMyPort
46 my_port=str(args['port'])
50 print "problem in killLocalPort()"
54 def givenPortKill(port):
56 kill servers from a previous SALOME exection, if needed,
57 on the same CORBA port
60 from killSalomeWithPort import killMyPort
65 print "problem in LocalPortKill(), killMyPort("<<port<<")"
69 def kill_salome(args):
71 Kill servers from previous SALOME executions, if needed;
72 depending on args 'killall' or 'portkill', kill all executions,
73 or only execution on the same CORBA port
78 elif args['portkill']:
79 givenPortKill(str(args['port']))
81 # -----------------------------------------------------------------------------
83 # Class definitions to launch CORBA Servers
86 class InterpServer(Server):
87 def __init__(self,args):
89 env_ld_library_path=['env', 'LD_LIBRARY_PATH=' + os.getenv("LD_LIBRARY_PATH")]
90 self.CMD=['xterm', '-e']+ env_ld_library_path + ['python']
95 print "INTERPSERVER::command = ", command
96 if sys.platform == "win32":
98 pid = win32pm.spawnpid( string.join(command, " "),'-nc' )
100 pid = os.spawnvp(os.P_NOWAIT, command[0], command)
101 process_id[pid]=self.CMD
106 class CatalogServer(Server):
107 def __init__(self,args):
110 #if sys.platform == "win32":
111 # self.SCMD1=[os.environ["KERNEL_ROOT_DIR"] + "/win32/" + os.environ["BIN_ENV"] + "/" + 'SALOME_ModuleCatalog_Server' + ".exe",'-common']
113 self.SCMD1=['SALOME_ModuleCatalog_Server','-common']
115 home_dir=os.getenv('HOME')
116 if home_dir is not None:
117 self.SCMD2=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
119 def setpath(self,modules_list,modules_root_dir):
121 list_modules = modules_list[:]
122 list_modules.reverse()
123 if self.args["gui"] :
124 list_modules = ["KERNEL", "GUI"] + list_modules
126 list_modules = ["KERNEL"] + list_modules
127 for module in list_modules:
128 if modules_root_dir.has_key(module):
129 module_root_dir=modules_root_dir[module]
130 module_cata=module+"Catalog.xml"
131 #print " ", module_cata
132 if os.path.exists(os.path.join(module_root_dir,
133 "share",setenv.salome_subdir,
134 "resources",module.lower(),
137 glob.glob(os.path.join(module_root_dir,
138 "share",setenv.salome_subdir,
139 "resources",module.lower(),
143 glob.glob(os.path.join(module_root_dir,
144 "share",setenv.salome_subdir,
149 #self.CMD=self.SCMD1 + ['\"']+[string.join(cata_path,'\"::\"')] + ['\"'] + self.SCMD2
150 self.CMD=self.SCMD1 + ['\"' + string.join(cata_path,'\"::\"') + '\"'] + self.SCMD2
154 class SalomeDSServer(Server):
155 def __init__(self,args):
158 self.CMD=['SALOMEDS_Server']
162 class ConnectionManagerServer(Server):
163 def __init__(self,args):
166 self.CMD=['SALOME_ConnectionManagerServer']
170 class RegistryServer(Server):
171 def __init__(self,args):
174 self.CMD=['SALOME_Registry_Server', '--salome_session','theSession']
178 class ContainerCPPServer(Server):
179 def __init__(self,args):
182 self.CMD=['SALOME_Container','FactoryServer']
186 class ContainerPYServer(Server):
187 def __init__(self,args):
190 if sys.platform == "win32":
191 self.CMD=[os.environ["PYTHONBIN"], '\"'+os.environ["KERNEL_ROOT_DIR"] + '/bin/salome/SALOME_ContainerPy.py'+'\"','FactoryServerPy']
193 self.CMD=['SALOME_ContainerPy.py','FactoryServerPy']
197 class LoggerServer(Server):
198 def __init__(self,args):
201 from salome_utils import generateFileName
202 if sys.platform == "win32": dirpath = os.environ["HOME"]
203 else: dirpath = "/tmp"
204 logfile = generateFileName( dirpath,
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):
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']:
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']]
263 if self.args['noexcepthandler']:
264 self.SCMD2+=['noexcepthandler']
265 if self.args.has_key('user_config'):
266 self.SCMD2+=['--resources=%s'%self.args['user_config']]
267 if self.args.has_key('modules'):
268 self.SCMD2+=['--modules (%s)'%":".join(self.args['modules'])]
269 if self.args.has_key('pyscript') and len(self.args['pyscript']) > 0:
270 self.SCMD2+=['--pyscript=%s'%(",".join(self.args['pyscript']))]
272 def setpath(self,modules_list,modules_root_dir):
274 list_modules = modules_list[:]
275 list_modules.reverse()
276 if self.args["gui"] :
277 list_modules = ["KERNEL", "GUI"] + list_modules
279 list_modules = ["KERNEL"] + list_modules
280 for module in list_modules:
281 module_root_dir=modules_root_dir[module]
282 module_cata=module+"Catalog.xml"
283 #print " ", module_cata
284 if os.path.exists(os.path.join(module_root_dir,
285 "share",setenv.salome_subdir,
286 "resources",module.lower(),
289 glob.glob(os.path.join(module_root_dir,"share",
290 setenv.salome_subdir,"resources",
291 module.lower(),module_cata)))
294 glob.glob(os.path.join(module_root_dir,"share",
295 setenv.salome_subdir,"resources",
298 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
299 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
300 #self.CMD=self.SCMD1 + ['\"']+[string.join(cata_path,'\"::\"')] + ['\"'] + self.SCMD2
301 self.CMD=self.SCMD1 + ['\"' + string.join(cata_path,'\"::\"') + '\"'] + self.SCMD2
303 self.CMD=self.SCMD1 + self.SCMD2
304 if self.args.has_key('test'):
305 self.CMD+=['-test'] + self.args['test']
306 elif self.args.has_key('play'):
307 self.CMD+=['-play'] + self.args['play']
309 if self.args["gdb_session"] or self.args["ddd_session"]:
310 f = open(".gdbinit4salome", "w")
312 args = " ".join(self.CMD[1:])
313 args = args.replace("(", "\(")
314 args = args.replace(")", "\)")
318 if self.args["ddd_session"]:
319 self.CMD = ["ddd", "--command=.gdbinit4salome", self.CMD[0]]
320 elif self.args["gdb_session"]:
321 self.CMD = ["xterm", "-e", "gdb", "--command=.gdbinit4salome", self.CMD[0]]
327 class LauncherServer(Server):
328 def __init__(self,args):
331 self.SCMD1=['SALOME_LauncherServer']
334 if 'registry' in self.args['embedded']:
335 self.SCMD1+=['--with','Registry',
336 '(','--salome_session','theSession',')']
337 if 'moduleCatalog' in self.args['embedded']:
338 self.SCMD1+=['--with','ModuleCatalog','(','-common']
339 self.SCMD2+=['-personal',
340 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
341 if 'study' in self.args['embedded']:
342 self.SCMD2+=['--with','SALOMEDS','(',')']
343 if 'cppContainer' in self.args['embedded']:
344 self.SCMD2+=['--with','Container','(','FactoryServer',')']
346 def setpath(self,modules_list,modules_root_dir):
348 list_modules = modules_list[:]
349 list_modules.reverse()
350 if self.args["gui"] :
351 list_modules = ["GUI"] + list_modules
352 for module in ["KERNEL"] + list_modules:
353 if modules_root_dir.has_key(module):
354 module_root_dir=modules_root_dir[module]
355 module_cata=module+"Catalog.xml"
356 #print " ", module_cata
357 if os.path.exists(os.path.join(module_root_dir,
358 "share",setenv.salome_subdir,
359 "resources",module.lower(),
362 glob.glob(os.path.join(module_root_dir,"share",
363 setenv.salome_subdir,"resources",
364 module.lower(),module_cata)))
367 glob.glob(os.path.join(module_root_dir,"share",
368 setenv.salome_subdir,"resources",
372 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
373 self.CMD=self.SCMD1 + [string.join(cata_path,':')] + self.SCMD2
375 self.CMD=self.SCMD1 + self.SCMD2
377 class NotifyServer(Server):
378 def __init__(self,args,modules_root_dir):
381 self.modules_root_dir=modules_root_dir
382 myLogName = os.environ["LOGNAME"]
383 self.CMD=['notifd','-c',
384 self.modules_root_dir["KERNEL"] +'/share/salome/resources/kernel/channel.cfg',
385 '-DFactoryIORFileName=/tmp/'+myLogName+'_rdifact.ior',
386 '-DChannelIORFileName=/tmp/'+myLogName+'_rdichan.ior',
387 '-DReportLogFile=/tmp/'+myLogName+'_notifd.report',
388 '-DDebugLogFile=/tmp/'+myLogName+'_notifd.debug',
392 # -----------------------------------------------------------------------------
395 """Salome Session Graphic User Interface activation"""
399 import SALOME_ModuleCatalog
400 import SALOME_Session_idl
401 session=clt.waitNS("/Kernel/Session",SALOME.Session)
402 session.GetInterface()
404 # -----------------------------------------------------------------------------
406 def startSalome(args, modules_list, modules_root_dir):
407 """Launch all SALOME servers requested by args"""
408 init_time = os.times()
410 if verbose(): print "startSalome ", args
413 # Initialisation ORB and Naming Service
416 clt=orbmodule.client(args)
417 # Save Naming service port name into
418 # the file args["ns_port_log_file"]
419 if args.has_key('ns_port_log_file'):
420 home = os.environ['HOME']
421 appli= os.environ.get("APPLI")
422 if appli is not None:
423 home='%s/%s'%(home,appli)
425 file_name= '%s/%s'%(home, args["ns_port_log_file"])
426 f = open(file_name, "w")
427 f.write(os.environ['NSPORT'])
430 # Launch Logger Server (optional)
431 # and wait until it is registered in naming service
435 myServer=LoggerServer(args)
437 clt.waitLogger("Logger")
439 # Notify Server launch
442 if sys.platform != "win32":
443 if verbose(): print "Notify Server to launch"
445 myServer=NotifyServer(args,modules_root_dir)
448 # Launch Session Server (to show splash ASAP)
452 mySessionServ = SessionServer(args)
453 mySessionServ.setpath(modules_list,modules_root_dir)
457 # Launch Registry Server,
458 # and wait until it is registered in naming service
461 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
462 myServer=RegistryServer(args)
464 if sys.platform == "win32":
465 clt.waitNS("/Registry")
467 clt.waitNSPID("/Registry",myServer.PID)
470 # Launch Catalog Server,
471 # and wait until it is registered in naming service
474 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
475 cataServer=CatalogServer(args)
476 cataServer.setpath(modules_list,modules_root_dir)
478 import SALOME_ModuleCatalog
479 if sys.platform == "win32":
480 clt.waitNS("/Kernel/ModulCatalog",SALOME_ModuleCatalog.ModuleCatalog)
482 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
485 # Launch SalomeDS Server,
486 # and wait until it is registered in naming service
489 #print "ARGS = ",args
490 if ('study' not in args['embedded']) | (args["gui"] == 0):
492 myServer=SalomeDSServer(args)
494 if sys.platform == "win32":
495 clt.waitNS("/myStudyManager")
497 clt.waitNSPID("/myStudyManager",myServer.PID)
500 # Launch LauncherServer
503 myCmServer = LauncherServer(args)
504 myCmServer.setpath(modules_list,modules_root_dir)
508 # Launch ConnectionManagerServer
511 myConnectionServer = ConnectionManagerServer(args)
512 myConnectionServer.run()
515 from Utils_Identity import getShortHostName
517 if os.getenv("HOSTNAME") == None:
518 if os.getenv("HOST") == None:
519 os.environ["HOSTNAME"]=getShortHostName()
521 os.environ["HOSTNAME"]=os.getenv("HOST")
523 theComputer = getShortHostName()
526 # Launch local C++ Container (FactoryServer),
527 # and wait until it is registered in naming service
530 if ('cppContainer' in args['standalone']) | (args["gui"] == 0) :
531 myServer=ContainerCPPServer(args)
533 if sys.platform == "win32":
534 clt.waitNS("/Containers/" + theComputer + "/FactoryServer")
536 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
539 # Launch local Python Container (FactoryServerPy),
540 # and wait until it is registered in naming service
543 if 'pyContainer' in args['standalone']:
544 myServer=ContainerPYServer(args)
546 if sys.platform == "win32":
547 clt.waitNS("/Containers/" + theComputer + "/FactoryServerPy")
549 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServerPy",myServer.PID)
552 # Wait until Session Server is registered in naming service
560 import SALOME_ModuleCatalog
561 import SALOME_Session_idl
562 if sys.platform == "win32":
563 session=clt.waitNS("/Kernel/Session",SALOME.Session)
565 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
566 end_time = os.times()
568 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
571 # ASV start GUI without Loader
573 # session.GetInterface()
576 # additionnal external python interpreters
582 nbaddi = args['interp']
585 traceback.print_exc()
586 print "-------------------------------------------------------------"
587 print "-- to get an external python interpreter:runSalome --interp=1"
588 print "-------------------------------------------------------------"
590 print "additional external python interpreters: ", nbaddi
592 for i in range(nbaddi):
594 anInterp=InterpServer(args)
597 # set PYTHONINSPECT variable (python interpreter in interactive mode)
599 os.environ["PYTHONINSPECT"]="1"
604 # -----------------------------------------------------------------------------
606 def useSalome(args, modules_list, modules_root_dir):
608 Launch all SALOME servers requested by args,
609 save list of process, give info to user,
610 show registered objects in Naming Service.
616 clt = startSalome(args, modules_list, modules_root_dir)
619 traceback.print_exc()
622 print "--- Error during Salome launch ---"
626 from addToKillList import addToKillList
627 from killSalomeWithPort import getPiDict
629 filedict = getPiDict(args['port'])
630 for pid, cmd in process_id.items():
631 addToKillList(pid, cmd, args['port'])
634 if verbose(): print """
635 Saving of the dictionary of Salome processes in %s
636 To kill SALOME processes from a console (kill all sessions from all ports):
638 To kill SALOME from the present interpreter, if it is not closed :
639 killLocalPort() --> kill this session
640 (use CORBA port from args of runSalome)
641 givenPortKill(port) --> kill a specific session with given CORBA port
642 killAllPorts() --> kill all sessions
644 runSalome, with --killall option, starts with killing
645 the processes resulting from the previous execution.
649 # Print Naming Service directory list
655 print " --- registered objects tree in Naming Service ---"
659 if not args['gui'] or not args['session_gui']:
660 if args['shutdown_servers']:
661 class __utils__(object):
662 def __init__(self, port):
664 import killSalomeWithPort
665 self.killSalomeWithPort = killSalomeWithPort
668 self.killSalomeWithPort.killMyPort(self.port)
671 args['shutdown_servers'] = __utils__(args['port'])
675 # run python scripts, passed via --execute option
677 if args.has_key('pyscript'):
678 if args.has_key('gui') and args.has_key('session_gui'):
679 if not args['gui'] or not args['session_gui']:
680 toimport = args['pyscript']
682 while i < len( toimport ) :
683 if toimport[ i ] == 'killall':
688 scrname = toimport[ i ]
689 if len(scrname) > 2 and (len(scrname) - string.rfind(scrname, ".py") == 3):
690 print 'executing',scrname
691 sys.path.insert( 0, os.path.dirname(scrname))
692 execfile(scrname,globals())
695 print 'importing',scrname
696 doimport = 'import ' + scrname
702 # -----------------------------------------------------------------------------
704 def registerEnv(args, modules_list, modules_root_dir):
706 Register args, modules_list, modules_root_dir in a file
707 for further use, when SALOME is launched embedded in an other application.
709 if sys.platform == "win32":
710 fileEnv = os.getenv('TEMP')
714 fileEnv += os.getenv('USER') + "_" + str(args['port']) \
715 + '_' + args['appname'].upper() + '_env'
716 fenv=open(fileEnv,'w')
717 pickle.dump((args, modules_list, modules_root_dir),fenv)
719 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
721 # -----------------------------------------------------------------------------
723 def searchFreePort(args, save_config=1):
724 print "Searching for a free port for naming service:",
726 if sys.platform == "win32":
727 tmp_file = os.getenv('TEMP');
730 tmp_file = os.path.join(tmp_file, '.netstat_%s'%os.getpid())
732 ###status = os.system("netstat -ltn | grep -E :%s > /dev/null 2>&1"%(NSPORT))
733 os.system( "netstat -a -n > %s" % tmp_file );
734 f = open( tmp_file, 'r' );
735 ports = f.readlines();
737 os.remove( tmp_file );
739 def portIsUsed(port, data):
740 regObj = re.compile( ".*tcp.*:([0-9]+).*:.*listen", re.IGNORECASE );
743 p = int(regObj.match(item).group(1))
744 if p == port: return True
755 if not portIsUsed(NSPORT, ports):
756 print "%s - OK"%(NSPORT)
758 from salome_utils import generateFileName, getHostName
759 hostname = getHostName()
761 home = os.getenv("HOME")
762 appli = os.getenv("APPLI")
764 if appli is not None:
765 home = os.path.join(home, appli,"USERS")
766 kwargs["with_username"]=True
768 omniorb_config = generateFileName(home, prefix="omniORB",
775 initref = "NameService=corbaname::%s:%s"%(hostname, NSPORT)
776 from omniORB import CORBA
777 if CORBA.ORB_ID == "omniORB4":
778 orbdata.append("InitRef = %s"%(initref))
779 orbdata.append("giopMaxMsgSize = 2097152000 # 2 GBytes")
780 orbdata.append("traceLevel = 0 # critical errors only")
782 orbdata.append("ORBInitRef %s"%(initref))
783 orbdata.append("ORBgiopMaxMsgSize = 2097152000 # 2 GBytes")
784 orbdata.append("ORBtraceLevel = 0 # critical errors only")
787 f = open(omniorb_config, "w")
788 f.write("\n".join(orbdata))
791 os.environ['OMNIORB_CONFIG'] = omniorb_config
792 os.environ['NSPORT'] = "%s"%(NSPORT)
793 os.environ['NSHOST'] = "%s"%(hostname)
794 args['port'] = os.environ['NSPORT']
797 last_running_config = generateFileName(home, prefix="omniORB",
803 if sys.platform == "win32":
805 shutil.copyfile(omniorb_config, last_running_config)
808 os.remove(last_running_config)
811 os.symlink(omniorb_config, last_running_config)
820 msg += "Can't find a free port to launch omniNames\n"
821 msg += "Try to kill the running servers and then launch SALOME again.\n"
822 raise RuntimeError, msg
827 # -----------------------------------------------------------------------------
830 """Salome Launch, when embedded in other application"""
831 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
832 fenv=open(fileEnv,'r')
833 args, modules_list, modules_root_dir = pickle.load(fenv)
836 searchFreePort(args, 0)
837 clt = useSalome(args, modules_list, modules_root_dir)
840 # -----------------------------------------------------------------------------
843 """Salome launch as a main application"""
844 from salome_utils import getHostName
845 print "runSalome running on %s" % getHostName()
846 args, modules_list, modules_root_dir = setenv.get_config()
849 if args.has_key('save_config'):
850 save_config = args['save_config']
851 searchFreePort(args, save_config)
853 setenv.set_env(args, modules_list, modules_root_dir)
854 clt = useSalome(args, modules_list, modules_root_dir)
857 # -----------------------------------------------------------------------------
859 if __name__ == "__main__":