+#! /usr/bin/env python3
+# -*- coding: iso-8859-1 -*-
+# Copyright (C) 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
+#
+# Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+## @file killSalomeWithPort.py
+# @brief Forcibly stop %SALOME processes from given session(s).
+#
+# The sessions are indicated by their ports on the command line as in below example:
+# @code
+# killSalomeWithPort.py 2811 2815
+# @endcode
+
+"""
+Forcibly stop given SALOME session(s).
+
+To stop one or more SALOME sessions, specify network ports they are bound to,
+for example:
+
+* in shell
+
+ $ killSalomeWithPort.py 2811 2815
+
+* in Python script:
+
+ from killSalomeWithPort import killMyPort
+ killMyPort(2811, 2815)
+
+"""
+
+# pragma pylint: disable=invalid-name
+
+import itertools
+import os
+import os.path as osp
+import pickle
+import re
+import shutil
+import sys
+from contextlib import suppress
+from glob import glob
+from threading import Thread
+from time import sleep
+
+import psutil
+
+from salome_utils import (generateFileName, getHostName, getLogDir, getShortHostName,
+ getUserName, killOmniNames, killPid, verbose)
+
+def getPiDict(port, appname='salome', full=True, hidden=True, hostname=None):
+ """
+ Get path to the file that stores the list of SALOME processes.
+
+ This file is located in the user's home directory
+ and named .<user>_<host>_<port>_SALOME_pidict
+ where
+
+ - <user> is user name
+ - <host> is host name
+ - <port> is port number
+
+ :param port : port number
+ :param appname : application name (default: 'salome')
+ :param full : if True, full path to the file is returned,
+ otherwise only file name is returned
+ :param hidden : if True, file name is prefixed with . (dot) symbol;
+ this internal parameter is only used to support
+ compatibility with older versions of SALOME
+ :param hostname : host name (if not given, it is auto-detected)
+ :return pidict file's name or path
+ """
+ # ensure port is an integer
+ # warning: this function is also called with port='#####'!!!
+ with suppress(ValueError):
+ port = int(port)
+
+ # hostname (if not specified via parameter)
+ with suppress(AttributeError):
+ hostname = hostname or os.getenv('NSHOST').split('.')[0]
+
+ # directory to store pidict file (if `full` is True)
+ # old style: pidict files aren't dot-prefixed, stored in the user's home directory
+ # new style: pidict files are dot-prefixed, stored in the system-dependant temporary directory
+ pidict_dir = getLogDir() if hidden else osp.expanduser('~')
+
+ return generateFileName(pidict_dir if full else '',
+ suffix='pidict',
+ hidden=hidden,
+ with_username=True,
+ with_hostname=(hostname or True),
+ with_port=port,
+ with_app=appname.upper())
+
+def appliCleanOmniOrbConfig(port):
+ """
+ Remove omniorb config files related to given `port` in SALOME application:
+ - ${OMNIORB_USER_PATH}/.omniORB_${USER}_${HOSTNAME}_${NSPORT}.cfg
+ - ${OMNIORB_USER_PATH}/.omniORB_${USER}_last.cfg
+ the last is removed only if the link points to the first file.
+ :param port : port number
+ """
+ omniorb_user_path = os.getenv('OMNIORB_USER_PATH')
+ if not omniorb_user_path:
+ # outside application context
+ return
+
+ if verbose():
+ print("Cleaning OmniOrb config for port {}".format(port))
+
+ omniorb_config = generateFileName(omniorb_user_path,
+ prefix='omniORB',
+ extension='cfg',
+ hidden=True,
+ with_username=True,
+ with_hostname=True,
+ with_port=port)
+ last_running_config = generateFileName(omniorb_user_path,
+ prefix='omniORB',
+ suffix='last',
+ extension='cfg',
+ hidden=True,
+ with_username=True)
+
+ if os.access(last_running_config, os.F_OK):
+ if sys.platform == 'win32' or osp.samefile(last_running_config, omniorb_config):
+ os.remove(last_running_config)
+
+ if os.access(omniorb_config, os.F_OK):
+ os.remove(omniorb_config)
+
+ if osp.lexists(last_running_config):
+ return
+
+ # try to relink last.cfg to an existing config file if any
+ cfg_files = [(cfg_file, os.stat(cfg_file)) for cfg_file in \
+ glob(osp.join(omniorb_user_path,
+ '.omniORB_{}_*.cfg'.format(getUserName())))]
+ next_config = next((i[0] for i in sorted(cfg_files, key=lambda i: i[1])), None)
+ if next_config:
+ if sys.platform == 'win32':
+ shutil.copyfile(osp.normpath(next_config), last_running_config)
+ else:
+ os.symlink(osp.normpath(next_config), last_running_config)
+
+def shutdownMyPort(port, cleanup=True):
+ """
+ Shutdown SALOME session running on the specified port.
+ :param port : port number
+ :param cleanup : perform additional cleanup actions (kill omniNames, etc.)
+ """
+ if not port:
+ return
+
+ # ensure port is an integer
+ with suppress(ValueError):
+ port = int(port)
+
+ # release port
+ with suppress(ImportError):
+ # DO NOT REMOVE NEXT LINE: it tests PortManager availability!
+ from PortManager import releasePort
+ releasePort(port)
+
+ # set OMNIORB_CONFIG variable to the proper file (if not set yet)
+ omniorb_user_path = os.getenv('OMNIORB_USER_PATH')
+ kwargs = {}
+ if omniorb_user_path is not None:
+ kwargs['with_username'] = True
+ else:
+ omniorb_user_path = osp.realpath(osp.expanduser('~'))
+ omniorb_config = generateFileName(omniorb_user_path,
+ prefix='omniORB',
+ extension='cfg',
+ hidden=True,
+ with_hostname=True,
+ with_port=port,
+ **kwargs)
+ os.environ['OMNIORB_CONFIG'] = omniorb_config
+ os.environ['NSPORT'] = str(port)
+
+ # give the chance to the servers to shutdown properly
+ with suppress(Exception):
+ from omniORB import CORBA
+ from LifeCycleCORBA import LifeCycleCORBA
+ orb = CORBA.ORB_init([''], CORBA.ORB_ID)
+ lcc = LifeCycleCORBA(orb) # see (1) below
+ # shutdown all
+ if verbose():
+ print("Terminating SALOME session on port {}...".format(port))
+ lcc.shutdownServers()
+ # give some time to shutdown to complete
+ sleep(1)
+ # shutdown omniNames
+ if cleanup:
+ killOmniNames(port)
+ __killMyPort(port, getPiDict(port))
+ # DO NOT REMOVE NEXT LINE: it tests PortManager availability!
+ from PortManager import releasePort
+ releasePort(port)
+ sleep(1)
+ sys.exit(0) # see (1) below
+
+# (1) If --shutdown-servers option is set to 1, session close procedure is
+# called twice: first explicitly by salome command, second by automatic
+# atexit to handle Ctrl-C. During second call, LCC does not exist anymore and
+# a RuntimeError is raised; we explicitly exit this function with code 0 to
+# prevent parent thread from crashing.
+
+def __killProcesses(processes):
+ '''
+ Terminate and kill all given processes (inernal).
+ :param processes : list of processes, each one is an instance of psutil.Process
+ '''
+ # terminate processes
+ for process in processes:
+ process.terminate()
+ # wait a little, then check for alive
+ _, alive = psutil.wait_procs(processes, timeout=5)
+ # finally kill alive
+ for process in alive:
+ process.kill()
+
+def __killPids(pids):
+ """
+ Kill processes with given `pids`.
+ :param pids : processes IDs
+ """
+ processes = []
+ for pid in pids: