src/KERNEL_PY/__init__.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2022  CEA/DEN, EDF R&D, 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, modulcat = 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
 249     import KernelLauncher
 250     cm = KernelLauncher.myContainerManager()
 251     from LifeCycleCORBA import LifeCycleCORBASSL
 252     lcc = LifeCycleCORBASSL()
 253     # create a FactoryServer Container servant
 254     import KernelContainer
 255     KernelContainer.myContainer()
 256     # activate poaManager to accept co-localized CORBA calls.
 257     from KernelSDS import GetDSMInstance
 258     import sys
 259     if hasattr(sys, 'argv'):
 260       argv = sys.argv
 261     else:
 262       argv = ['']
 263     dsm = GetDSMInstance(argv)
 264     # esm inherits from SALOME_CPythonHelper singleton already initialized by GetDSMInstance
 265     # esm inherits also from SALOME_ResourcesManager creation/initialization (concerning SingleThreadPOA POA) when KernelLauncher.GetContainerManager() has been called
 266     esm = KernelLauncher.GetExternalServer()
 267     #
 268     import KernelLogger
 269     naming_service.Register(KernelLogger.myLogger(),"/Logger")
 270     #
 271     from NamingService import NamingService
 272     if iorfakensfile is not None:
 273         with open(iorfakensfile,"w") as iorfakensf:
 274             iorfakensf.write(NamingService.IOROfNS())
 275
 276 def salome_init_without_session_attached(path=None, embedded=False):
 277     """
 278     Configuration SSL inside a python interpretor launched in the SALOME_Container_No_NS_Serv.
 279     In this configuration, a local FakeNamingService is created and remote objects are stored in it.
 280     lcc is pointing to the FakeNamingService above.
 281     """
 282     salome_init_without_session_common(path,embedded)
 283     global lcc,cm,dsm,esm
 284     import CORBA
 285     orb=CORBA.ORB_init([''])
 286     import Engines
 287     import KernelBasis
 288     nsAbroad = orb.string_to_object( KernelBasis.getIOROfEmbeddedNS() )
 289     import SALOME
 290     CM_NAME_IN_NS = "/ContainerManager"
 291     cm = orb.string_to_object( nsAbroad.Resolve(CM_NAME_IN_NS).decode() )
 292     naming_service.Register(cm,CM_NAME_IN_NS)
 293     RM_NAME_IN_NS = "/ResourcesManager"
 294     rm = orb.string_to_object( nsAbroad.Resolve(RM_NAME_IN_NS).decode() )
 295     naming_service.Register(rm,RM_NAME_IN_NS)
 296     #
 297     from LifeCycleCORBA import LifeCycleCORBASSL
 298     lcc = LifeCycleCORBASSL()
 299     DSM_NAME_IN_NS = "/DataServerManager"
 300     dsm = orb.string_to_object( nsAbroad.Resolve(DSM_NAME_IN_NS).decode() )
 301     naming_service.Register(dsm,DSM_NAME_IN_NS)
 302     #
 303     ESM_NAME_IN_NS = "/ExternalServers"
 304     esm = orb.string_to_object( nsAbroad.Resolve(ESM_NAME_IN_NS).decode() )
 305     naming_service.Register(esm,ESM_NAME_IN_NS)
 306
 307 def salome_init_with_session(path=None, embedded=False):
 308     """
 309     Performs only once SALOME general purpose initialisation for scripts.
 310     Provides:
 311     orb             reference to CORBA
 312     lcc             a LifeCycleCorba instance
 313     naming_service  a naming service instance
 314     cm              reference to the container manager
 315     esm             reference to external server manager
 316     dsm             reference to shared dataserver manager
 317     modulcat        reference to modulecatalog instance
 318     sg              access to SALOME GUI (when linked with IAPP GUI)
 319     myStudy         active study itself (CORBA reference)
 320     myStudyName     active study name
 321     """
 322     global salome_initial
 323     global orb, lcc, naming_service, cm, esm, dsm, modulcat
 324     global sg
 325     global myStudy, myStudyName
 326     import KernelBasis
 327     KernelBasis.setSSLMode(False)
 328     try:
 329         if salome_initial:
 330             salome_initial=False
 331             sg = salome_iapp_init(embedded)
 332             orb, lcc, naming_service, cm, esm, dsm, modulcat = salome_kernel_init()
 333             myStudy, myStudyName = salome_study_init(path)
 334             pass
 335         pass
 336     except RuntimeError as inst:
 337         # wait a little to avoid trace mix
 338         import time
 339         time.sleep(0.2)
 340         x = inst
 341         print("salome.salome_init_with_session():", x)
 342         print("""
 343         ============================================
 344         May be there is no running SALOME session
 345         salome.salome_init() is intended to be used
 346         within an already running session
 347         ============================================
 348         """)
 349         raise
 350
 351 def salome_close():
 352     global salome_initial, myStudy, myStudyName, lcc
 353     try:
 354         # study can be clear either from GUI or directly with salome.myStudy.Clear()
 355         myStudy.Clear()
 356     except Exception:
 357         pass
 358     salome_initial=True
 359     salome_iapp_close()
 360     salome_study_close()
 361     myStudy, myStudyName = None, None
 362     lcc = None # to salome_init to rebuild all in case of salome_init after salome_close
 363     import KernelBasis
 364     if KernelBasis.getSSLMode() and not KernelBasis.getGUIMode():
 365         import KernelDS
 366         KernelDS.KillGlobalSessionInstance()
 367         import KernelSDS
 368         KernelSDS.KillCPythonHelper()
 369     pass
 370
 371 def salome_NS():
 372     import CORBA
 373     import CosNaming
 374     orb = CORBA.ORB_init()
 375     ns0 = orb.resolve_initial_references("NameService")
 376     return ns0._narrow(CosNaming.NamingContext)
 377
 378 def salome_walk_on_containers(ns,root):
 379     import CosNaming
 380     it = ns.list(0)[1]
 381     if not it:
 382         return
 383     cont = True
 384     while cont:
 385         cont,obj = it.next_one()
 386         if cont:
 387             if obj.binding_name[0].kind == "object":
 388                 import Engines
 389                 corbaObj = ns.resolve(obj.binding_name)
 390                 if isinstance(corbaObj,Engines._objref_Container):
 391                     yield corbaObj,(root,obj.binding_name[0].id)
 392             else:
 393                 father = ns.resolve([obj.binding_name[0]])
 394                 for elt,elt2 in salome_walk_on_containers(father,root+[obj.binding_name[0].id]):
 395                     yield elt,elt2
 396             pass
 397         pass
 398     pass
 399
 400 def salome_shutdown_containers_with_session():
 401     salome_init()
 402     ns=salome_NS()
 403     li = [elt for elt in salome_walk_on_containers(ns,[""])]
 404     print("Number of containers in NS : {}".format(len(li)))
 405     for cont,(root,cont_name) in li:
 406         try:
 407             cont.Shutdown()
 408         except Exception:
 409             pass
 410         ref_in_ns = "/".join(root+[cont_name])
 411         naming_service.Destroy_Name(ref_in_ns)
 412     print("Number of containers in NS after clean : {}".format( len( list(salome_walk_on_containers(ns,[""])) )))
 413
 414 def salome_shutdown_containers_without_session():
 415     containersEntries = [elt for elt in naming_service.repr() if "/Containers/" == elt[:12]]
 416     for containerEntry in containersEntries:
 417         cont = naming_service.Resolve(containerEntry)
 418         try:
 419             cont.Shutdown()
 420         except:
 421             pass
 422
 423 def salome_shutdown_containers():
 424     import KernelBasis
 425     if KernelBasis.getSSLMode():
 426         salome_shutdown_containers_without_session()
 427     else:
 428         salome_shutdown_containers_with_session()
 429
 430 class SessionContextManager:
 431     def __enter__(self):
 432         standalone()
 433         salome_init()
 434     def __exit__(self, type, value, traceback):
 435         salome_close()
 436
 437 #to expose all objects to pydoc
 438 __all__=dir()