3 # Copyright (C) 2005 OPEN CASCADE, CEA, EDF R&D, LEG
4 # PRINCIPIA R&D, EADS CCR, Lip6, BV, CEDRAT
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
10 # This library is distributed in the hope that it will be useful
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 import sys, os, string, glob, time, pickle
27 # salome_subdir variable is used for composing paths like $KERNEL_ROOT_DIR/share/salome/resources/kernel, etc.
28 # before moving to SUIT-based gui, instead of salome_subdir there was args['appname'] used.
29 # but after - 'appname' = "SalomeApp", so using it in making the subdirectory is an error.
30 salome_subdir = "salome"
32 # -----------------------------------------------------------------------------
34 def add_path(directory, variable_name):
35 """Function helper to add environment variables"""
36 if not os.environ.has_key(variable_name):
37 os.environ[variable_name] = ""
39 if os.path.exists(directory):
41 for _dir in os.environ[variable_name].split(":"):
42 if os.path.exists(_dir):
43 if not os.path.samefile(_dir, directory):
46 if os.path.abspath(_dir) != os.path.abspath(directory):
50 newpath[:0] = [ directory ]
51 newpath = string.join(newpath,":")
52 os.environ[variable_name] = newpath
53 if variable_name == "PYTHONPATH":
54 sys.path[:0] = [directory]
56 # -----------------------------------------------------------------------------
60 if re.match(".*64.*", platform.machine()):
64 # -----------------------------------------------------------------------------
68 Get list of modules, paths.
70 Read args from launch configure xml file and command line options.
71 Check variables <module>_ROOT_DIR and set list of used modules.
72 Return args, modules_list, modules_root_dir
75 # read args from launch configure xml file and command line options
77 import launchConfigureParser
78 args = launchConfigureParser.args
80 # Check variables <module>_ROOT_DIR
81 # and set list of used modules (without KERNEL)
84 if args.has_key("modules"):
85 modules_list += args["modules"]
86 # KERNEL must be last in the list to locate it at the first place in PATH
88 modules_list[:0] = ["GUI"]
89 modules_list[:0] = ["KERNEL"]
90 modules_list.reverse()
95 for module in modules_list :
96 module_variable=module+"_ROOT_DIR"
97 if not os.environ.has_key(module_variable):
98 print "*******************************************************"
100 print "* Environment variable",module_variable,"must be set"
101 print "* Module", module, "will be not available"
103 print "********************************************************"
104 to_remove_list.append(module)
107 module_root_dir = os.environ[module_variable]
108 modules_root_dir[module]=module_root_dir
110 for to_remove in to_remove_list:
111 modules_list.remove(to_remove)
113 while "KERNEL" in modules_list:
114 modules_list.remove("KERNEL")
117 while "GUI" in modules_list:
118 modules_list.remove("GUI")
121 if "SUPERV" in modules_list and not 'superv' in args['standalone']:
122 args['standalone'].append("superv")
125 return args, modules_list, modules_root_dir
127 # -----------------------------------------------------------------------------
129 def set_env(args, modules_list, modules_root_dir):
130 """Add to the PATH-variables modules specific paths"""
132 python_version="python%d.%d" % sys.version_info[0:2]
133 modules_root_dir_list = []
135 modules_list = modules_list[:] + ["GUI"]
136 modules_list = modules_list[:] + ["KERNEL"]
137 for module in modules_list :
138 if modules_root_dir.has_key(module):
139 module_root_dir = modules_root_dir[module]
140 modules_root_dir_list[:0] = [module_root_dir]
141 add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
143 add_path(os.path.join(module_root_dir,"bin",salome_subdir),
145 if os.path.exists(module_root_dir + "/examples") :
146 add_path(os.path.join(module_root_dir,"examples"),
149 add_path(os.path.join(module_root_dir,"bin",salome_subdir),
151 add_path(os.path.join(module_root_dir,get_lib_dir(),
152 python_version,"site-packages",
155 add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
157 add_path(os.path.join(module_root_dir,get_lib_dir(),
158 python_version,"site-packages",
166 os.environ["SALOMEPATH"]=":".join(modules_root_dir_list)
168 # set trace environment variable
170 if not os.environ.has_key("SALOME_trace"):
171 os.environ["SALOME_trace"]="local"
173 os.environ["SALOME_trace"]="file:"+args['file'][0]
175 os.environ["SALOME_trace"]="with_logger"
177 # set environment for SMESH plugins
179 if "SMESH" in modules_list:
180 os.environ["SMESH_MeshersList"]="StdMeshers"
181 if not os.environ.has_key("SALOME_StdMeshersResources"):
182 os.environ["SALOME_StdMeshersResources"] \
183 = modules_root_dir["SMESH"]+"/share/"+args["appname"]+"/resources/smesh"
185 if args.has_key("SMESH_plugins"):
186 for plugin in args["SMESH_plugins"]:
188 if os.environ.has_key(plugin+"_ROOT_DIR"):
189 plugin_root = os.environ[plugin+"_ROOT_DIR"]
191 # workaround to avoid modifications of existing environment
192 if os.environ.has_key(plugin.upper()+"_ROOT_DIR"):
193 plugin_root = os.environ[plugin.upper()+"_ROOT_DIR"]
196 if plugin_root != "":
197 os.environ["SMESH_MeshersList"] \
198 = os.environ["SMESH_MeshersList"]+":"+plugin
199 if not os.environ.has_key("SALOME_"+plugin+"Resources"):
200 os.environ["SALOME_"+plugin+"Resources"] \
201 = plugin_root+"/share/"+args["appname"]+"/resources/"+plugin.lower()
202 add_path(os.path.join(plugin_root,get_lib_dir(),python_version,
203 "site-packages",salome_subdir),
205 add_path(os.path.join(plugin_root,get_lib_dir(),salome_subdir),
207 add_path(os.path.join(plugin_root,get_lib_dir(),salome_subdir),
209 add_path(os.path.join(plugin_root,"bin",salome_subdir),
211 add_path(os.path.join(plugin_root,"bin",salome_subdir),
216 # set environment for SUPERV module
217 os.environ["ENABLE_MACRO_NODE"]="1"
218 # set resources variables if not yet set
219 # Done now by launchConfigureParser.py
220 #if os.getenv("GUI_ROOT_DIR"):
221 #if not os.getenv("SalomeAppConfig"): os.environ["SalomeAppConfig"] = os.getenv("GUI_ROOT_DIR") + "/share/salome/resources/gui"
223 # set CSF_PluginDefaults variable only if it is not customized
225 if not os.getenv("CSF_PluginDefaults"):
226 os.environ["CSF_PluginDefaults"] \
227 = os.path.join(modules_root_dir["KERNEL"],"share",
228 salome_subdir,"resources","kernel")
229 os.environ["CSF_SALOMEDS_ResourcesDefaults"] \
230 = os.path.join(modules_root_dir["KERNEL"],"share",
231 salome_subdir,"resources","kernel")
233 if "GEOM" in modules_list:
234 print "GEOM OCAF Resources"
235 os.environ["CSF_GEOMDS_ResourcesDefaults"] \
236 = os.path.join(modules_root_dir["GEOM"],"share",
237 salome_subdir,"resources","geom")
238 print "GEOM Shape Healing Resources"
239 os.environ["CSF_ShHealingDefaults"] \
240 = os.path.join(modules_root_dir["GEOM"],"share",
241 salome_subdir,"resources","geom")
243 # -----------------------------------------------------------------------------
245 from killSalome import killAllPorts
249 kill servers from a previous SALOME exection, if needed,
250 on the CORBA port given in args of runSalome
253 from killSalomeWithPort import killMyPort
254 my_port=str(args['port'])
258 print "problem in killLocalPort()"
262 def givenPortKill(port):
264 kill servers from a previous SALOME exection, if needed,
265 on the same CORBA port
268 from killSalomeWithPort import killMyPort
273 print "problem in LocalPortKill(), killMyPort("<<port<<")"
277 def kill_salome(args):
279 Kill servers from previous SALOME executions, if needed;
280 depending on args 'killall' or 'portkill', kill all executions,
281 or only execution on the same CORBA port
286 elif args['portkill']:
287 givenPortKill(str(args['port']))
289 # -----------------------------------------------------------------------------
291 # Definition des classes d'objets pour le lancement des Server CORBA
295 """Generic class for CORBA server launch"""
301 if self.args['xterm']:
302 self.ARGS=['xterm', '-iconic', '-sb', '-sl', '500', '-hold']
304 def __init__(self,args):
312 if self.args['xterm']:
313 # (Debian) send LD_LIBRARY_PATH to children shells (xterm)
314 env_ld_library_path=['env', 'LD_LIBRARY_PATH='
315 + os.getenv("LD_LIBRARY_PATH")]
316 myargs = myargs +['-T']+self.CMD[:1]+['-e'] + env_ld_library_path
317 command = myargs + self.CMD
318 print "command = ", command
319 pid = os.spawnvp(os.P_NOWAIT, command[0], command)
320 process_id[pid]=self.CMD
324 class InterpServer(Server):
325 def __init__(self,args):
327 env_ld_library_path=['env', 'LD_LIBRARY_PATH=' + os.getenv("LD_LIBRARY_PATH")]
328 self.CMD=['xterm', '-e']+ env_ld_library_path + ['python']
329 #self.CMD=['xterm', '-e', 'python']
334 #print "command = ", command
335 pid = os.spawnvp(os.P_NOWAIT, command[0], command)
336 process_id[pid]=self.CMD
341 class CatalogServer(Server):
342 def __init__(self,args):
345 self.SCMD1=['SALOME_ModuleCatalog_Server','-common']
347 home_dir=os.getenv('HOME')
348 if home_dir is not None:
349 self.SCMD2=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
351 def setpath(self,modules_list,modules_root_dir):
353 list_modules = modules_list[:]
354 list_modules.reverse()
355 if self.args["gui"] :
356 list_modules = ["KERNEL", "GUI"] + list_modules
358 list_modules = ["KERNEL"] + list_modules
359 for module in list_modules:
360 if modules_root_dir.has_key(module):
361 module_root_dir=modules_root_dir[module]
362 module_cata=module+"Catalog.xml"
363 #print " ", module_cata
364 if os.path.exists(os.path.join(module_root_dir,
365 "share",salome_subdir,
366 "resources",module.lower(),
369 glob.glob(os.path.join(module_root_dir,
370 "share",salome_subdir,
371 "resources",module.lower(),
375 glob.glob(os.path.join(module_root_dir,
376 "share",salome_subdir,
381 self.CMD=self.SCMD1 + [string.join(cata_path,':')] + self.SCMD2
385 class SalomeDSServer(Server):
386 def __init__(self,args):
389 self.CMD=['SALOMEDS_Server']
393 class RegistryServer(Server):
394 def __init__(self,args):
397 self.CMD=['SALOME_Registry_Server', '--salome_session','theSession']
401 class ContainerCPPServer(Server):
402 def __init__(self,args):
405 self.CMD=['SALOME_Container','FactoryServer']
409 class ContainerPYServer(Server):
410 def __init__(self,args):
413 self.CMD=['SALOME_ContainerPy.py','FactoryServerPy']
417 class ContainerSUPERVServer(Server):
418 def __init__(self,args):
421 self.CMD=['SALOME_Container','SuperVisionContainer']
425 class LoggerServer(Server):
426 def __init__(self,args):
429 self.CMD=['SALOME_Logger_Server', 'logger.log']
433 class SessionServer(Server):
434 def __init__(self,args):
435 self.args = args.copy()
436 # Bug 11512 (Problems with runSalome --xterm on Mandrake and Debian Sarge)
440 self.SCMD1=['SALOME_Session_Server']
442 if 'registry' in self.args['embedded']:
443 self.SCMD1+=['--with','Registry',
444 '(','--salome_session','theSession',')']
445 if 'moduleCatalog' in self.args['embedded']:
446 self.SCMD1+=['--with','ModuleCatalog','(','-common']
447 home_dir=os.getenv('HOME')
448 if home_dir is not None:
449 self.SCMD2+=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
451 if 'study' in self.args['embedded']:
452 self.SCMD2+=['--with','SALOMEDS','(',')']
453 if 'cppContainer' in self.args['embedded']:
454 self.SCMD2+=['--with','Container','(','FactoryServer',')']
455 if 'SalomeAppEngine' in self.args['embedded']:
456 self.SCMD2+=['--with','SalomeAppEngine','(',')']
458 if 'cppContainer' in self.args['standalone'] or 'cppContainer' in self.args['embedded']:
460 if 'pyContainer' in self.args['standalone'] or 'pyContainer' in self.args['embedded']:
462 if 'supervContainer' in self.args['containers'] or 'supervContainer' in self.args['standalone']:
463 self.SCMD2+=['SUPERV']
466 if self.args['splash'] and self.args['gui']:
467 self.SCMD2+=['SPLASH']
468 if self.args['noexcepthandler']:
469 self.SCMD2+=['noexcepthandler']
470 if self.args.has_key('modules'):
471 self.SCMD2+=['--modules (']
472 for mod in self.args['modules']:
473 self.SCMD2+=[mod + ':']
476 def setpath(self,modules_list,modules_root_dir):
478 list_modules = modules_list[:]
479 list_modules.reverse()
480 if self.args["gui"] :
481 list_modules = ["KERNEL", "GUI"] + list_modules
483 list_modules = ["KERNEL"] + list_modules
484 for module in list_modules:
485 module_root_dir=modules_root_dir[module]
486 module_cata=module+"Catalog.xml"
487 #print " ", module_cata
488 if os.path.exists(os.path.join(module_root_dir,
489 "share",salome_subdir,
490 "resources",module.lower(),
493 glob.glob(os.path.join(module_root_dir,"share",
494 salome_subdir,"resources",
495 module.lower(),module_cata)))
498 glob.glob(os.path.join(module_root_dir,"share",
499 salome_subdir,"resources",
502 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
503 self.CMD=self.SCMD1 + [string.join(cata_path,':')] + self.SCMD2
505 self.CMD=self.SCMD1 + self.SCMD2
509 class ContainerManagerServer(Server):
510 def __init__(self,args):
513 self.SCMD1=['SALOME_ContainerManagerServer']
516 if 'registry' in self.args['embedded']:
517 self.SCMD1+=['--with','Registry',
518 '(','--salome_session','theSession',')']
519 if 'moduleCatalog' in self.args['embedded']:
520 self.SCMD1+=['--with','ModuleCatalog','(','-common']
521 self.SCMD2+=['-personal',
522 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
523 if 'study' in self.args['embedded']:
524 self.SCMD2+=['--with','SALOMEDS','(',')']
525 if 'cppContainer' in self.args['embedded']:
526 self.SCMD2+=['--with','Container','(','FactoryServer',')']
528 def setpath(self,modules_list,modules_root_dir):
530 list_modules = modules_list[:]
531 list_modules.reverse()
532 if self.args["gui"] :
533 list_modules = ["GUI"] + list_modules
534 for module in ["KERNEL"] + list_modules:
535 if modules_root_dir.has_key(module):
536 module_root_dir=modules_root_dir[module]
537 module_cata=module+"Catalog.xml"
538 #print " ", module_cata
539 if os.path.exists(os.path.join(module_root_dir,
540 "share",salome_subdir,
541 "resources",module.lower(),
544 glob.glob(os.path.join(module_root_dir,"share",
545 self.args['appname'],"resources",
546 module.lower(),module_cata)))
549 glob.glob(os.path.join(module_root_dir,"share",
550 self.args['appname'],"resources",
554 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
555 self.CMD=self.SCMD1 + [string.join(cata_path,':')] + self.SCMD2
557 self.CMD=self.SCMD1 + self.SCMD2
559 class NotifyServer(Server):
560 def __init__(self,args,modules_root_dir):
563 self.modules_root_dir=modules_root_dir
564 myLogName = os.environ["LOGNAME"]
565 self.CMD=['notifd','-c',
566 self.modules_root_dir["KERNEL"] +'/share/salome/resources/kernel/channel.cfg',
567 '-DFactoryIORFileName=/tmp/'+myLogName+'_rdifact.ior',
568 '-DChannelIORFileName=/tmp/'+myLogName+'_rdichan.ior',
569 '-DReportLogFile=/tmp/'+myLogName+'_notifd.report',
570 '-DDebugLogFile=/tmp/'+myLogName+'_notifd.debug',
574 # -----------------------------------------------------------------------------
577 """Salome Session Graphic User Interface activation"""
581 import SALOME_ModuleCatalog
585 import SALOME_Session_idl
586 session=clt.waitNS("/Kernel/Session",SALOME.Session)
587 session.GetInterface()
589 # -----------------------------------------------------------------------------
591 def startSalome(args, modules_list, modules_root_dir):
592 """Launch all SALOME servers requested by args"""
593 init_time = os.times()
595 print "startSalome ", args
598 # Initialisation ORB et Naming Service
601 clt=orbmodule.client()
603 # (non obligatoire) Lancement Logger Server
604 # et attente de sa disponibilite dans le naming service
608 myServer=LoggerServer(args)
610 clt.waitLogger("Logger")
612 # Notify Server launch
615 print "Notify Server to launch"
617 myServer=NotifyServer(args,modules_root_dir)
620 # Lancement Session Server (to show splash ASAP)
624 mySessionServ = SessionServer(args)
625 mySessionServ.setpath(modules_list,modules_root_dir)
629 # Lancement Registry Server,
630 # attente de la disponibilite du Registry dans le Naming Service
633 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
634 myServer=RegistryServer(args)
636 clt.waitNSPID("/Registry",myServer.PID)
639 # Lancement Catalog Server,
640 # attente de la disponibilite du Catalog Server dans le Naming Service
644 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
645 cataServer=CatalogServer(args)
646 cataServer.setpath(modules_list,modules_root_dir)
648 import SALOME_ModuleCatalog
649 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
652 # Lancement SalomeDS Server,
653 # attente de la disponibilite du SalomeDS dans le Naming Service
656 #print "ARGS = ",args
657 if ('study' not in args['embedded']) | (args["gui"] == 0):
659 myServer=SalomeDSServer(args)
661 clt.waitNSPID("/myStudyManager",myServer.PID)
664 # Lancement ContainerManagerServer
667 myCmServer = ContainerManagerServer(args)
668 myCmServer.setpath(modules_list,modules_root_dir)
672 from Utils_Identity import getShortHostName
674 if os.getenv("HOSTNAME") == None:
675 if os.getenv("HOST") == None:
676 os.environ["HOSTNAME"]=getShortHostName()
678 os.environ["HOSTNAME"]=os.getenv("HOST")
680 theComputer = getShortHostName()
683 # Lancement Container C++ local,
684 # attente de la disponibilite du Container C++ local dans le Naming Service
687 if 'cppContainer' in args['standalone']:
688 myServer=ContainerCPPServer(args)
690 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
693 # Lancement Container Python local,
694 # attente de la disponibilite du Container Python local
695 # dans le Naming Service
698 if 'pyContainer' in args['standalone']:
699 myServer=ContainerPYServer(args)
701 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServerPy",myServer.PID)
704 # Lancement Container Supervision local,
705 # attente de la disponibilite du Container Supervision local
706 # dans le Naming Service
709 if 'supervContainer' in args['standalone']:
710 myServer=ContainerSUPERVServer(args)
712 clt.waitNSPID("/Containers/" + theComputer + "/SuperVisionContainer",myServer.PID)
715 # Attente de la disponibilite du Session Server dans le Naming Service
723 import SALOME_ModuleCatalog
727 import SALOME_Session_idl
728 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
730 end_time = os.times()
732 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
735 # ASV start GUI without Loader
737 # session.GetInterface()
740 # additionnal external python interpreters
747 nbaddi = int(args['interp'][0])
750 traceback.print_exc()
751 print "-------------------------------------------------------------"
752 print "-- to get an external python interpreter:runSalome --interp=1"
753 print "-------------------------------------------------------------"
755 print "additional external python interpreters: ", nbaddi
757 for i in range(nbaddi):
759 anInterp=InterpServer(args)
764 # -----------------------------------------------------------------------------
766 def useSalome(args, modules_list, modules_root_dir):
768 Launch all SALOME servers requested by args,
769 save list of process, give info to user,
770 show registered objects in Naming Service.
775 clt = startSalome(args, modules_list, modules_root_dir)
778 traceback.print_exc()
781 print "--- erreur au lancement Salome ---"
785 from killSalomeWithPort import getPiDict
786 filedict = getPiDict(args['port'])
790 fpid=open(filedict, 'r')
791 process_ids=pickle.load(fpid)
796 fpid=open(filedict, 'w')
797 process_ids.append(process_id)
798 pickle.dump(process_ids,fpid)
802 Saving of the dictionary of Salome processes in %s
803 To kill SALOME processes from a console (kill all sessions from all ports):
805 To kill SALOME from the present interpreter, if it is not closed :
806 killLocalPort() --> kill this session
807 (use CORBA port from args of runSalome)
808 givenPortKill(port) --> kill a specific session with given CORBA port
809 killAllPorts() --> kill all sessions
811 runSalome, with --killall option, starts with killing
812 the processes resulting from the previous execution.
816 # Impression arborescence Naming Service
821 print " --- registered objects tree in Naming Service ---"
824 # run python scripts, passed via -t option
825 toimport = args['pyscript']
827 while i < len( toimport ) :
828 if toimport[ i ] == 'killall':
829 print "killall : option disabled"
832 print 'importing',toimport[ i ]
833 doimport = 'import ' + toimport[ i ]
839 # -----------------------------------------------------------------------------
841 def registerEnv(args, modules_list, modules_root_dir):
843 Register args, modules_list, modules_root_dir in a file
844 for further use, when SALOME is launched embedded in an other application.
846 fileEnv = '/tmp/' + os.getenv('USER') + "_" + str(args['port']) \
847 + '_' + args['appname'].upper() + '_env'
848 fenv=open(fileEnv,'w')
849 pickle.dump((args, modules_list, modules_root_dir),fenv)
851 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
853 # -----------------------------------------------------------------------------
856 """Salome Launch, when embedded in other application"""
857 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
858 fenv=open(fileEnv,'r')
859 args, modules_list, modules_root_dir = pickle.load(fenv)
862 clt = useSalome(args, modules_list, modules_root_dir)
865 # -----------------------------------------------------------------------------
868 """Salome launch as a main application"""
869 args, modules_list, modules_root_dir = get_config()
871 set_env(args, modules_list, modules_root_dir)
872 clt = useSalome(args, modules_list, modules_root_dir)
875 # -----------------------------------------------------------------------------
877 if __name__ == "__main__":