bin/searchFreePort.py

   1 #!/usr/bin/env python3
   2 #  -*- coding: iso-8859-1 -*-
   3 # Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   4 #
   5 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   7 #
   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.
  12 #
  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.
  17 #
  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
  21 #
  22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  23 #
  24
  25 import os
  26 import sys
  27
  28 def __setup_config(nsport, args, save_config):
  29   #
  30   from salome_utils import generateFileName, getHostName
  31   hostname = getHostName()
  32   #
  33   omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
  34   kwargs={}
  35   if omniorbUserPath is not None:
  36     kwargs["with_username"]=True
  37   #
  38   from ORBConfigFile import writeORBConfigFile
  39   omniorb_config, giopsize = writeORBConfigFile(omniorbUserPath, hostname, nsport, kwargs)
  40   args['port'] = os.environ['NSPORT']
  41   #
  42   if save_config:
  43     last_running_config = generateFileName(omniorbUserPath, prefix="omniORB",
  44                                            suffix="last",
  45                                            extension="cfg",
  46                                            hidden=True,
  47                                            **kwargs)
  48     os.environ['LAST_RUNNING_CONFIG'] = last_running_config
  49     try:
  50       if sys.platform == "win32":
  51         import shutil
  52         shutil.copyfile(omniorb_config, last_running_config)
  53       else:
  54         try:
  55           if os.access(last_running_config, os.F_OK):
  56             os.remove(last_running_config)
  57         except OSError:
  58           pass
  59         os.symlink(omniorb_config, last_running_config)
  60         pass
  61       pass
  62     except:
  63       pass
  64   #
  65 #
  66
  67 def searchFreePort_withPortManager(queue, args={}, save_config=1, use_port=None):
  68   from PortManager import getPort
  69   port = getPort(use_port)
  70
  71   if use_port:
  72     print("Check if port can be used: %d" % use_port, end=' ')
  73     if port == use_port and port != -1:
  74       print("- OK")
  75       __setup_config(use_port, args, save_config)
  76       queue.put([os.environ['OMNIORB_CONFIG'],
  77                  os.environ['NSPORT'],
  78                  os.environ['NSHOST']])
  79       return
  80     else:
  81       print("- KO: port is busy")
  82       pass
  83   #
  84   print("Searching for a free port for naming service:", end=' ')
  85   if port == -1: # try again
  86     port = getPort(use_port)
  87
  88   if port != -1:
  89     print("%s - OK"%(port))
  90     __setup_config(port, args, save_config)
  91   else:
  92     print("Unable to obtain port")
  93
  94   queue.put([os.environ['OMNIORB_CONFIG'],
  95              os.environ['NSPORT'],
  96              os.environ['NSHOST']])
  97 #
  98
  99 def __savePortToFile(args):
 100   # Save Naming service port name into
 101   # the file args["ns_port_log_file"]
 102   if 'ns_port_log_file' in args:
 103     omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
 104     file_name = os.path.join(omniorbUserPath, args["ns_port_log_file"])
 105     with open(file_name, "w") as f:
 106       f.write(os.environ['NSPORT'])
 107 #
 108
 109 def searchFreePort(args={}, save_config=1, use_port=None):
 110   """
 111   Search free port for SALOME session.
 112   Returns first found free port number.
 113   """
 114   try:
 115     import PortManager # mandatory
 116     from multiprocessing import Process, Queue
 117     queue = Queue()
 118     p = Process(target = searchFreePort_withPortManager, args=(queue, args, save_config, use_port,))
 119     p.start()
 120     info = queue.get()
 121
 122     os.environ['OMNIORB_CONFIG'] = info[0]
 123     os.environ['NSPORT'] = info[1]
 124     args['port'] = os.environ['NSPORT']
 125     os.environ['NSHOST'] = info[2]
 126     __savePortToFile(args)
 127
 128     p.join() # this blocks until the process terminates
 129   except ImportError:
 130     raise Exception('PortManager module not found')
 131 #