src/KERNEL_PY/__init__.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
   3 #
   4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 #
   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, or (at your option) any later version.
  11 #
  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.
  16 #
  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
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23
  24 #  File   : salome.py renamed as __init__.py for python packaging (gboulant)
  25 #  Author : Paul RASCLE, EDF
  26 #  Module : SALOME
  27 #
  28 """
  29 Module salome gives access to Salome resources.
  30
  31 variables:
  32
  33   - salome.orb             : CORBA
  34   - salome.naming_service  : instance of naming Service class
  35       - methods:
  36           - Resolve(name)  : find a CORBA object (ior) by its pathname
  37           - Register(name) : register a CORBA object under a pathname
  38
  39   - salome.lcc             : instance of lifeCycleCORBA class
  40       - methods:
  41           - FindOrLoadComponent(server,name) :
  42                            obtain an Engine (CORBA object)
  43                            or launch the Engine if not found,
  44                            with a Server name and an Engine name
  45
  46   - salome.sg              : salome object to communicate with the graphical user interface (if any)
  47       - methods:
  48          - updateObjBrowser():
  49
  50          - SelectedCount():      returns number of selected objects
  51          - getSelected(i):       returns entry of selected object number i
  52          - getAllSelected():     returns list of entry of selected objects
  53          - AddIObject(Entry):    select an existing Interactive object
  54          - RemoveIObject(Entry): remove object from selection
  55          - ClearIObjects():      clear selection
  56
  57          - Display(*Entry):
  58          - DisplayOnly(Entry):
  59          - Erase(Entry):
  60          - DisplayAll():
  61          - EraseAll():
  62
  63          - IDToObject(Entry):    returns CORBA reference from entry
  64
  65   - salome.myStudyName     : active Study Name
  66   - salome.myStudy         : the active Study itself (CORBA ior)
  67       - methods : defined in SALOMEDS.idl
  68
  69 """
  70 ## @package salome
  71 # Module salome gives access to Salome resources.
  72 #
  73 #  \param salome.orb             : CORBA orb object
  74 #  \param salome.naming_service  : instance of naming Service class (SALOME_NamingServicePy::SALOME_NamingServicePy_i)
  75 #  \param salome.lcc             : instance of lifeCycleCORBA class (SALOME_LifeCycleCORBA)
  76 #  \param salome.sg              : Salome object to communicate with the graphical user interface, if running (see interface in salome_iapp::SalomeOutsideGUI)
  77 #  \param salome.myStudyName     : active Study Name
  78 #  \param salome.myStudy         : the active Study (interface SALOMEDS::Study)
  79
  80 #
  81 # ==========================================================================
  82 #
  83 # The function extend_path is used here to aggregate in a single
  84 # virtual python package all the python sub-packages embedded in each
  85 # SALOME modules (python "namespace" pattern).
  86 #
  87 ROOT_PYTHONPACKAGE_NAME="salome"
  88 #
  89 # This root package name is expected to be found as a directory in
  90 # some paths of the sys.path variable, especially the paths
  91 # <MODULE_ROOT_DIR>/lib/pythonX.Y/site-packages/salome where are
  92 # installed the python files. These paths are theorically appended by
  93 # the SALOME main runner and should be in the sys.path at this point
  94 # of the application. The extend_path is looking then for directories
  95 # of the type:
  96 #
  97 # <MODULE_ROOT_DIR>/lib/pythonX.Y/site-packages/salome/<ROOT_PYTHONPACKAGE_NAME>
  98 #
  99 # And append them to the sys.path. These directories are supposed to
 100 # be the pieces to be aggregated as a single virtual python package.
 101 #
 102 import os, sys
 103 from salome_utils import verbose
 104
 105 MATCH_ENDING_PATTERN="site-packages" + os.path.sep + "salome"
 106
 107 def extend_path(pname):
 108     for dir in sys.path:
 109         if not isinstance(dir, str) or not os.path.isdir(dir) or not dir.endswith(MATCH_ENDING_PATTERN):
 110             continue
 111         subdir = os.path.join(dir, pname)
 112         # XXX This may still add duplicate entries to path on
 113         # case-insensitive filesystems
 114         if os.path.isdir(subdir) and subdir not in __path__:
 115             if verbose(): print("INFO - The directory %s is appended to sys.path" % subdir)
 116             __path__.append(subdir)
 117
 118 extend_path(ROOT_PYTHONPACKAGE_NAME)
 119 # ==========================================================================
 120 #
 121
 122 from salome_kernel import *
 123 from salome_study import *
 124 from salome_iapp import *
 125 import salome_study
 126
 127 #
 128 # The next block is workaround for the problem of shared symbols loading for the extension modules (e.g. SWIG-generated)
 129 # that causes RTTI unavailable in some cases. To solve this problem, sys.setdlopenflags() function is used.
 130 # Depending on the Python version and platform, the dlopen flags can be defined in the dl, DLFUN or ctypes module.
 131 #
 132 import sys
 133 flags = None
 134 if not flags:
 135     try:
 136         # dl module can be unavailable
 137         import dl
 138         flags = dl.RTLD_NOW | dl.RTLD_GLOBAL
 139     except Exception:
 140         pass
 141     pass
 142 if not flags:
 143     try:
 144         # DLFCN module can be unavailable
 145         import DLFCN
 146         flags = DLFCN.RTLD_NOW | DLFCN.RTLD_GLOBAL
 147     except Exception:
 148         pass
 149     pass
 150 if not flags:
 151     try:
 152         # ctypes module can be unavailable
 153         import ctypes
 154         flags = ctypes.RTLD_GLOBAL
 155     except Exception:
 156         pass
 157     pass
 158
 159 # Disable -> bug with scipy, seems very dangerous to do that
 160 #if flags:
 161 #    sys.setdlopenflags(flags)
 162 #    pass
 163
 164 orb, lcc, naming_service, cm, sg, esm, dsm, logm, modulcat, rm = None,None,None,None,None,None,None,None,None,None
 165 myStudy, myStudyName = None,None
 166
 167 salome_initial=True
 168
 169 def standalone():
 170     pass
 171
 172 def withServers():
 173     import KernelBasis
 174     KernelBasis.setSSLMode(False)
 175
 176 def salome_init(path=None, embedded=False, iorfakensfile=None, forced=False):
 177     """
 178     Initialize SALOME client process (that can also be server).
 179     3 modes of initialization exists:
 180     - SSL mode (see salome_init_without_session)
 181     - SSL mode attached in the context of python execution inside SALOME_Container_No_NS_Serv server (typically YACS)
 182     - Classical mode (see salome_init_with_session)
 183     :param iorfakensfile: filename inside which IOR of fake NS will be written
 184     :param forced: tell if the multi-initialization protection mecanism of salome_init must be skiped of not
 185                    (typically in the context where a path to a study is given whereas a previous initialisation without it was done)
 186     """
 187     if not forced:
 188         if lcc is not None:# multi-initialization protection mecanism is based on lcc global var
 189             return
 190     PATH_TO_STUDY_FILE_TO_INITIATE = "PATH_TO_STUDY_FILE_TO_INITIATE"
 191     import KernelBasis
 192     if KernelBasis.getSSLMode():
 193         if KernelBasis.getIOROfEmbeddedNS() == "":
 194             import os
 195             # make runSalome.py -t study.hdf toto.py
 196             if path is None and PATH_TO_STUDY_FILE_TO_INITIATE in os.environ:
 197                 path = os.environ[PATH_TO_STUDY_FILE_TO_INITIATE]
 198             salome_init_without_session(path, embedded, iorfakensfile)
 199         else:
 200             salome_init_without_session_attached(path, embedded)
 201     else:
 202         salome_init_with_session(path, embedded)
 203
 204 def salome_init_without_session_common(path=None, embedded=False):
 205     from ORBConfigFile import writeORBConfigFileSSL
 206     OMNIORB_USER_PATH = "OMNIORB_USER_PATH"
 207     def RemoveOmniorbConfigFile():
 208         import os
 209         if "OMNIORB_CONFIG" in os.environ:
 210             fileToRemove = os.environ["OMNIORB_CONFIG"]
 211             if os.path.exists(fileToRemove):
 212                 os.unlink(fileToRemove)
 213
 214     if OMNIORB_USER_PATH in os.environ:
 215         import atexit
 216         writeORBConfigFileSSL(os.environ[OMNIORB_USER_PATH],kwargs={"with_pid":True})
 217         atexit.register(RemoveOmniorbConfigFile)
 218
 219     global lcc,naming_service,myStudy,myStudyName,orb,modulcat,sg
 220     import KernelBasis
 221     KernelBasis.setSSLMode(True)
 222     import KernelDS
 223     myStudy = KernelDS.myStudy()
 224     import CORBA
 225     orb=CORBA.ORB_init([''])
 226     import KernelModuleCatalog
 227     import SALOME_ModuleCatalog
 228     from salome_kernel import list_of_catalogs_regarding_environement
 229     modulcat = KernelModuleCatalog.myModuleCatalog( list_of_catalogs_regarding_environement() )
 230     #
 231     poa = orb.resolve_initial_references("RootPOA")
 232     poaManager = poa._get_the_POAManager()
 233     poaManager.activate()
 234     #
 235     sg = salome_iapp_init(embedded)
 236     salome_study_init_without_session(path)
 237     #
 238     from NamingService import NamingService
 239     naming_service = NamingService()
 240     myStudyName = myStudy.Name
 241
 242 def salome_init_without_session(path=None, embedded=False, iorfakensfile=None):
 243     """
 244     Force creation of all servants needed by SALOME session in the current process.
 245     A Fake NamingService is created storing reference of all servants in the current process.
 246     """
 247     salome_init_without_session_common(path,embedded)
 248     global lcc,cm,dsm,esm,rm,logm
 249     import KernelLauncher
 250     cm = KernelLauncher.myContainerManager()
 251     type(cm).SetOverrideEnvForContainersSimple = ContainerManagerSetOverrideEnvForContainersSimple
 252     rm = KernelLauncher.myResourcesManager()
 253     from LifeCycleCORBA import LifeCycleCORBASSL
 254     lcc = LifeCycleCORBASSL()
 255     # create a FactoryServer Container servant
 256     import KernelContainer
 257     KernelContainer.myContainer()
 258     # activate poaManager to accept co-localized CORBA calls.
 259     from KernelSDS import GetDSMInstance
 260     import sys
 261     if hasattr(sys, 'argv'):
 262       argv = sys.argv
 263     else:
 264       argv = ['']
 265     dsm = GetDSMInstance(argv)
 266     # esm inherits from SALOME_CPythonHelper singleton already initialized by GetDSMInstance
 267     # esm inherits also from SALOME_ResourcesManager creation/initialization (concerning SingleThreadPOA POA) when KernelLauncher.GetContainerManager() has been called
 268     esm = KernelLauncher.GetExternalServer()
 269     # idem for logm
 270     logm = KernelLauncher.myLogManager()
 271     type(logm).Fetch = LogManagerFetch
 272     #
 273     import KernelLogger
 274     naming_service.Register(KernelLogger.myLogger(),"/Logger")
 275     #
 276     from NamingService import NamingService
 277     if iorfakensfile is not None:
 278         with open(iorfakensfile,"w") as iorfakensf:
 279             iorfakensf.write(NamingService.IOROfNS())
 280
 281 def salome_init_without_session_attached(path=None, embedded=False):
 282     """
 283     Configuration SSL inside a python interpretor launched in the SALOME_Container_No_NS_Serv.
 284     In this configuration, a local FakeNamingService is created and remote objects are stored in it.
 285     lcc is pointing to the FakeNamingService above.
 286     """
 287     salome_init_without_session_common(path,embedded)
 288     global lcc,cm,dsm,esm,rm,logm
 289     import CORBA
 290     orb=CORBA.ORB_init([''])
 291     import Engines
 292     import KernelBasis
 293     nsAbroad = orb.string_to_object( KernelBasis.getIOROfEmbeddedNS() )
 294     import SALOME
 295     CM_NAME_IN_NS = "/ContainerManager"
 296     cm = orb.string_to_object( nsAbroad.Resolve(CM_NAME_IN_NS).decode() )
 297     type(cm).SetOverrideEnvForContainersSimple = ContainerManagerSetOverrideEnvForContainersSimple
 298     naming_service.Register(cm,CM_NAME_IN_NS)
 299     RM_NAME_IN_NS = "/ResourcesManager"
 300     rm = orb.string_to_object( nsAbroad.Resolve(RM_NAME_IN_NS).decode() )
 301     naming_service.Register(rm,RM_NAME_IN_NS)
 302     #
 303     from LifeCycleCORBA import LifeCycleCORBASSL
 304     lcc = LifeCycleCORBASSL()
 305     DSM_NAME_IN_NS = "/DataServerManager"
 306     dsm = orb.string_to_object( nsAbroad.Resolve(DSM_NAME_IN_NS).decode() )
 307     naming_service.Register(dsm,DSM_NAME_IN_NS)
 308     #
 309     ESM_NAME_IN_NS = "/ExternalServers"
 310     esm = orb.string_to_object( nsAbroad.Resolve(ESM_NAME_IN_NS).decode() )
 311     naming_service.Register(esm,ESM_NAME_IN_NS)
 312     #
 313     LOGM_NAME_IN_NS = "/LogManager"
 314     logm = orb.string_to_object( nsAbroad.Resolve(LOGM_NAME_IN_NS).decode() )
 315     naming_service.Register(logm,LOGM_NAME_IN_NS)
 316
 317 def salome_init_with_session(path=None, embedded=False):
 318     """
 319     Performs only once SALOME general purpose initialisation for scripts.
 320     Provides:
 321     orb             reference to CORBA
 322     lcc             a LifeCycleCorba instance
 323     naming_service  a naming service instance
 324     cm              reference to the container manager
 325     esm             reference to external server manager
 326     dsm             reference to shared dataserver manager
 327     modulcat        reference to modulecatalog instance
 328     sg              access to SALOME GUI (when linked with IAPP GUI)
 329     myStudy         active study itself (CORBA reference)
 330     myStudyName     active study name
 331     """
 332     global salome_initial
 333     global orb, lcc, naming_service, cm, esm, dsm, modulcat
 334     global sg
 335     global myStudy, myStudyName
 336     import KernelBasis
 337     KernelBasis.setSSLMode(False)
 338     try:
 339         if salome_initial:
 340             salome_initial=False
 341             sg = salome_iapp_init(embedded)
 342             orb, lcc, naming_service, cm, esm, dsm, modulcat = salome_kernel_init()
 343             myStudy, myStudyName = salome_study_init(path)
 344             pass
 345         pass
 346     except RuntimeError as inst:
 347         # wait a little to avoid trace mix
 348         import time
 349         time.sleep(0.2)
 350         x = inst
 351         print("salome.salome_init_with_session():", x)
 352         print("""
 353         ============================================
 354         May be there is no running SALOME session
 355         salome.salome_init() is intended to be used
 356         within an already running session
 357         ============================================
 358         """)
 359         raise
 360
 361 def salome_close():
 362     global salome_initial, myStudy, myStudyName, lcc
 363     try:
 364         # study can be clear either from GUI or directly with salome.myStudy.Clear()
 365         myStudy.Clear()
 366     except Exception:
 367         pass
 368     salome_initial=True
 369     salome_iapp_close()
 370     salome_study_close()
 371     myStudy, myStudyName = None, None
 372     lcc = None # to salome_init to rebuild all in case of salome_init after salome_close
 373     import KernelBasis
 374     if KernelBasis.getSSLMode() and not KernelBasis.getGUIMode():
 375         import KernelDS
 376         KernelDS.KillGlobalSessionInstance()
 377         import KernelSDS
 378         KernelSDS.KillCPythonHelper()
 379     pass
 380
 381 def salome_NS():
 382     import CORBA
 383     import CosNaming
 384     orb = CORBA.ORB_init()
 385     ns0 = orb.resolve_initial_references("NameService")
 386     return ns0._narrow(CosNaming.NamingContext)
 387
 388 def salome_walk_on_containers(ns,root):
 389     import CosNaming
 390     it = ns.list(0)[1]
 391     if not it:
 392         return
 393     cont = True
 394     while cont:
 395         cont,obj = it.next_one()
 396         if cont:
 397             if obj.binding_name[0].kind == "object":
 398                 import Engines
 399                 corbaObj = ns.resolve(obj.binding_name)
 400                 if isinstance(corbaObj,Engines._objref_Container):
 401                     yield corbaObj,(root,obj.binding_name[0].id)
 402             else:
 403                 father = ns.resolve([obj.binding_name[0]])
 404                 for elt,elt2 in salome_walk_on_containers(father,root+[obj.binding_name[0].id]):
 405                     yield elt,elt2
 406             pass
 407         pass
 408     pass
 409
 410 def salome_shutdown_containers_with_session():
 411     salome_init()
 412     ns=salome_NS()
 413     li = [elt for elt in salome_walk_on_containers(ns,[""])]
 414     print("Number of containers in NS : {}".format(len(li)))
 415     for cont,(root,cont_name) in li:
 416         try:
 417             cont.Shutdown()
 418         except Exception:
 419             pass
 420         ref_in_ns = "/".join(root+[cont_name])
 421         naming_service.Destroy_Name(ref_in_ns)
 422     print("Number of containers in NS after clean : {}".format( len( list(salome_walk_on_containers(ns,[""])) )))
 423
 424 def retrieve_containers_in_ns():
 425     return [elt for elt in naming_service.repr() if "/Containers/" == elt[:12]]
 426
 427 def salome_shutdown_containers_without_session():
 428     containersEntries = retrieve_containers_in_ns()
 429     for containerEntry in containersEntries:
 430         cont = naming_service.Resolve(containerEntry)
 431         try:
 432             cont.Shutdown()
 433         except:
 434             pass
 435
 436 def salome_shutdown_containers():
 437     import KernelBasis
 438     if KernelBasis.getSSLMode():
 439         salome_shutdown_containers_without_session()
 440     else:
 441         salome_shutdown_containers_with_session()
 442
 443 class SessionContextManager:
 444     def __enter__(self):
 445         standalone()
 446         salome_init()
 447     def __exit__(self, type, value, traceback):
 448         salome_close()
 449
 450 def ContainerManagerSetOverrideEnvForContainersSimple(self,env):
 451     envEff = [ Engines.KeyValPairString(key=k,val=v) for k,v in env ]
 452     return self.SetOverrideEnvForContainers( envEff )
 453
 454 def LogManagerFetch(self):
 455     import SALOME_ContainerHelper
 456     return [SALOME_ContainerHelper.ContainerLogInfo(elt) for elt in self.listOfContainerLogs()]
 457
 458 #to expose all objects to pydoc
 459 __all__=dir()