3 # Copyright (C) 2007-2022 CEA/DEN, EDF R&D, OPEN CASCADE
5 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
22 # See https://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
25 # File : extension_remover.py
26 # Author : Konstantin Leontev, Open Cascade
28 # @package SalomeOnDemandTK
29 # @brief Set of utility to remove SALOME python extensions.
31 """Set of utility to remove SALOME python extensions.
37 from traceback import format_exc
39 from .extension_utilities import logger, \
40 SALOME_EXTDIR, EXTCOMPONENT_KEY, \
41 isvalid_dirname, list_dependants, is_empty_dir, \
42 find_envpy, value_from_salomexd, check_if_installed
45 def remove_if_empty(top_dir, directory):
47 Recursively remove empty directories from the given one to the top.
50 top_dir - top parent directory that can be removed as well
51 directory - the given directory
57 #logger.debug('Check if %s is empty...', directory)
58 if not is_empty_dir(directory):
61 logger.debug('Directory %s is empty. Remove it.', directory)
64 # Don't go up than top root
65 if top_dir == directory:
68 # Remove the parent dir as well
69 parent_dir = os.path.abspath(os.path.join(directory, os.pardir))
70 remove_if_empty(top_dir, parent_dir)
73 def remove_bylist(root_dir, salomexc):
75 Remove files and directories listed in the given salomexc file.
78 root_dir - a root dir for listed files
79 salomexc - file that contents a list of files to remove.
82 True if all the files were deleted without critical errors.
85 logger.debug('Remove files from %s dir listed in %s...',
89 with open(salomexc, 'r', encoding='UTF-8') as file:
91 path_to_remove = os.path.join(root_dir, line.strip())
92 logger.debug('Remove file %s...', path_to_remove)
94 if os.path.isfile(path_to_remove):
95 os.remove(path_to_remove)
97 # Remove the parent folder if empty
98 parent_dir = os.path.dirname(path_to_remove)
99 remove_if_empty(root_dir, parent_dir)
101 elif os.path.islink(path_to_remove):
102 os.unlink(path_to_remove)
104 # Remove the parent folder if empty
105 parent_dir = os.path.dirname(path_to_remove)
106 remove_if_empty(root_dir, parent_dir)
108 elif os.path.isdir(path_to_remove):
109 logger.warning('Directories are not expected to be listed in %s file! '
111 salomexc, path_to_remove)
112 # Use instead of rmdir here, because dir can be not empty
113 shutil.rmtree(path_to_remove)
116 logger.warning('Unexpected path %s!'
117 'It is not a file or directory. Skip.',
121 logger.error(format_exc())
126 def remove_salomex(install_dir, salomex_name):
128 Remove a salome extension from SALOME install root.
131 salome_root - path to SALOME install root directory.
132 salomex_name - a name of salome extension to remove.
135 List of deleted components or None if the functions fails.
138 logger.debug('Starting remove a salome extension %s', salomex_name)
143 # Check if provided dirname is valid
144 if not isvalid_dirname(install_dir):
147 # Check if the given extension is installed
148 salomexd, salomexc = check_if_installed(install_dir, salomex_name)
150 logger.debug('Going to exit from extension removing process.')
153 # Check if we cannot remove an extension because of dependencies
154 dependants = list_dependants(install_dir, salomex_name)
155 if len(dependants) > 0:
156 logger.error('Cannot remove an extension %s because followed extensions depend on it: %s! '
157 'Going to exit from extension removing process.',
158 salomex_name, dependants)
161 # Try to remove all the files listed in the control file
162 if not remove_bylist(os.path.join(install_dir, SALOME_EXTDIR), salomexc):
165 # Remove control file
169 env_py = find_envpy(install_dir, salomex_name)
173 logger.warning('Cannot find and remove %s file! ', env_py)
175 # Remove description file
177 # Get components to deactivate in UI if the case
178 components = value_from_salomexd(salomexd, EXTCOMPONENT_KEY)
181 logger.debug('An extension %s was removed from %s',
182 salomex_name, install_dir)
184 return components if components else []
187 if __name__ == '__main__':
188 if len(sys.argv) == 3:
189 arg_1, arg_2 = sys.argv[1:] # pylint: disable=unbalanced-tuple-unpacking
190 remove_salomex(arg_1, arg_2)
192 logger.error('You must provide all the arguments!')
193 logger.info(remove_salomex.__doc__)