Merge pull request #922 from compas-dev/rhino-legacy-install

tomvanmele · web-flow · commit 786d4d581e42 · 2021-11-04T10:20:39.000+01:00
Update (un)install procedures
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Fixed bug in directions of `compas.datastructures.Mesh.from_meshgrid`.
 * Fixed bug in Rhino mesh face drawing.
+* Fixed bug related to legacy uninstall on Rhino for Mac.
 
 ### Removed
 
diff --git a/src/compas_rhino/__init__.py b/src/compas_rhino/__init__.py
@@ -72,7 +72,12 @@ def _get_ironpython_lib_path(version):
         raise Exception('Unsupported platform')
 
     if not os.path.exists(ironpython_lib_path):
-        raise Exception("The lib folder for IronPython does not exist in this location: {}".format(ironpython_lib_path))
+        # This does not always work.
+        # Especially not on (new) macs.
+        # However, since it is only used to clean up potential old installations
+        # it does not seem crucial anymore.
+        ironpython_lib_path = None
+        print("The lib folder for IronPython does not exist in this location: {}".format(ironpython_lib_path))
 
     return ironpython_lib_path
 
@@ -213,6 +218,7 @@ def _try_remove_bootstrapper(path):
 
 
 __all__ = [name for name in dir() if not name.startswith('_')]
+
 __all_plugins__ = [
     'compas_rhino.geometry.booleans',
     'compas_rhino.geometry.trimesh',
diff --git a/src/compas_rhino/install.py b/src/compas_rhino/install.py
@@ -50,27 +50,33 @@ def install(version=None, packages=None):
     packages = _filter_installable_packages(version, packages)
 
     ipylib_path = compas_rhino._get_ironpython_lib_path(version)
+    # We install COMPAS packages in the scripts folder
+    # instead of directly as IPy module.
     scripts_path = compas_rhino._get_scripts_path(version)
 
     print('Installing COMPAS packages to Rhino {0} scripts folder:'.format(version))
-    print('Location scripts folder: {}'.format(scripts_path))
-    print()
+    print('{}\n'.format(scripts_path))
 
     results = []
     symlinks_to_install = []
     symlinks_to_uninstall = []
     exit_code = 0
 
     for package in packages:
-        package_path = compas_rhino._get_package_path(importlib.import_module(package))
         symlink_path = os.path.join(scripts_path, package)
+        if os.path.exists(symlink_path):
+            symlinks_to_uninstall.append(dict(name=package, link=symlink_path))
+
+        package_path = compas_rhino._get_package_path(importlib.import_module(package))
         symlinks_to_install.append(dict(name=package, source_path=package_path, link=symlink_path))
-        symlinks_to_uninstall.append(dict(name=package, link=symlink_path))
 
         # Handle legacy install location
-        legacy_path = os.path.join(ipylib_path, package)
-        if os.path.exists(legacy_path):
-            symlinks_to_uninstall.append(dict(name=package, link=legacy_path))
+        # This does not always work,
+        # and especially not in cases where it is in any case not necessary :)
+        if ipylib_path:
+            legacy_path = os.path.join(ipylib_path, package)
+            if os.path.exists(legacy_path):
+                symlinks_to_uninstall.append(dict(name=package, link=legacy_path))
 
     # First uninstall existing copies of packages requested for installation
     symlinks = [link['link'] for link in symlinks_to_uninstall]
@@ -81,8 +87,10 @@ def install(version=None, packages=None):
             results.append((uninstall_data['name'], 'ERROR: Cannot remove symlink, try to run as administrator.'))
 
     # Handle legacy bootstrapper
-    if not compas_rhino._try_remove_bootstrapper(ipylib_path):
-        results.append(('compas_bootstrapper', 'ERROR: Cannot remove legacy compas_bootstrapper, try to run as administrator.'))
+    # Again, only if possible...
+    if ipylib_path:
+        if not compas_rhino._try_remove_bootstrapper(ipylib_path):
+            results.append(('compas_bootstrapper', 'ERROR: Cannot remove legacy compas_bootstrapper, try to run as administrator.'))
 
     # Ready to start installing
     symlinks = [(link['source_path'], link['link']) for link in symlinks_to_install]
@@ -116,13 +124,11 @@ def install(version=None, packages=None):
             exit_code = -1
 
     if exit_code == 0 and len(installed_packages):
-        print()
-        print('Running post-installation steps...')
-        print()
+        print('\nRunning post-installation steps...\n')
         if not _run_post_execution_steps(after_rhino_install(installed_packages)):
             exit_code = -1
 
-    print('\nCompleted.')
+    print('\nInstall completed.')
     if exit_code != 0:
         sys.exit(exit_code)
 
@@ -147,9 +153,7 @@ def _run_post_execution_steps(steps_generator):
                 post_execution_errors.append(ValueError('Step ran without errors but result is wrongly formatted: {}'.format(str(item))))
 
     if post_execution_errors:
-        print()
-        print('One or more errors occurred:')
-        print()
+        print('\nOne or more errors occurred:\n')
         for error in post_execution_errors:
             print('   - {}'.format(repr(error)))
 
diff --git a/src/compas_rhino/uninstall.py b/src/compas_rhino/uninstall.py
@@ -48,13 +48,11 @@ def uninstall(version=None, packages=None):
     packages = _filter_installed_packages(version, packages)
 
     ipylib_path = compas_rhino._get_ironpython_lib_path(version)
+    # We install COMPAS packages in the scripts folder
+    # instead of directly as IPy module.
     scripts_path = compas_rhino._get_scripts_path(version)
 
-    print('Uninstalling COMPAS packages from Rhino {0} scripts folder:'.format(version))
-    print('Location scripts folder: {}'.format(scripts_path))
-    print()
-
-    print('The following packages have been detected and will be uninstalled:')
+    print('Uninstalling COMPAS packages from Rhino {0} scripts folder: \n{1}'.format(version, scripts_path))
 
     results = []
     symlinks_to_uninstall = []
@@ -65,50 +63,66 @@ def uninstall(version=None, packages=None):
         if os.path.exists(symlink_path):
             symlinks_to_uninstall.append(dict(name=package, link=symlink_path))
 
-        legacy_path = os.path.join(ipylib_path, package)
-        if os.path.exists(legacy_path):
-            symlinks_to_uninstall.append(dict(name=package, link=legacy_path))
+        # Handle legacy install location
+        # This does not always work,
+        # and especially not in cases where it is in any case not necessary :)
+        if ipylib_path:
+            legacy_path = os.path.join(ipylib_path, package)
+            if os.path.exists(legacy_path):
+                symlinks_to_uninstall.append(dict(name=package, link=legacy_path))
 
-    symlinks = [link['link'] for link in symlinks_to_uninstall]
-    uninstall_results = compas._os.remove_symlinks(symlinks)
+    if not symlinks_to_uninstall:
+        print('\nNo packages to uninstall.')
 
-    uninstalled_packages = []
-    for uninstall_data, success in zip(symlinks_to_uninstall, uninstall_results):
-        if success:
-            uninstalled_packages.append(uninstall_data['name'])
-            result = 'OK'
-        else:
-            result = 'ERROR: Cannot remove symlink, try to run as administrator.'
-        results.append((uninstall_data['name'], result))
+    else:
+        uninstalled_packages = []
 
-    if not all(uninstall_results):
-        exit_code = -1
+        symlinks = [link['link'] for link in symlinks_to_uninstall]
+        uninstall_results = compas._os.remove_symlinks(symlinks)
+
+        for uninstall_data, success in zip(symlinks_to_uninstall, uninstall_results):
+            if success:
+                uninstalled_packages.append(uninstall_data['name'])
+                result = 'OK'
+            else:
+                result = 'ERROR: Cannot remove symlink, try to run as administrator.'
+
+            results.append((uninstall_data['name'], result))
+
+        if not all(uninstall_results):
+            exit_code = -1
+
+        if exit_code == -1:
+            results.append(('compas_bootstrapper', 'WARNING: One or more packages failed, will not uninstall bootstrapper.'))
 
-    if exit_code == -1:
-        results.append(('compas_bootstrapper', 'WARNING: One or more packages failed, will not uninstall bootstrapper.'))
-    else:
-        if compas_rhino._try_remove_bootstrapper(scripts_path):
-            results.append(('compas_bootstrapper', 'OK'))
         else:
-            results.append(('compas_bootstrapper', 'ERROR: Cannot remove compas_bootstrapper, try to run as administrator.'))
+            if compas_rhino._try_remove_bootstrapper(scripts_path):
+                results.append(('compas_bootstrapper', 'OK'))
+            else:
+                results.append(('compas_bootstrapper', 'ERROR: Cannot remove compas_bootstrapper, try to run as administrator.'))
 
-        if not compas_rhino._try_remove_bootstrapper(ipylib_path):
-            results.append(('compas_bootstrapper', 'ERROR: Cannot remove legacy compas_bootstrapper, try to run as administrator.'))
+            # Handle legacy bootstrapper
+            # Again, only if possible...
+            if ipylib_path:
+                if not compas_rhino._try_remove_bootstrapper(ipylib_path):
+                    results.append(('compas_bootstrapper', 'ERROR: Cannot remove legacy compas_bootstrapper, try to run as administrator.'))
 
-    for package, status in results:
-        print('   {} {}'.format(package.ljust(20), status))
+        print('\nThe following packages have been detected and will be uninstalled:\n')
 
-        if status != 'OK':
-            exit_code = -1
+        for package, status in results:
+            print('   {} {}'.format(package.ljust(20), status))
 
-    if exit_code == 0 and len(uninstalled_packages):
-        print()
-        print('Running post-uninstallation steps...')
-        print()
-        if not _run_post_execution_steps(after_rhino_uninstall(uninstalled_packages)):
-            exit_code = -1
+            if status != 'OK':
+                exit_code = -1
+
+        if exit_code == 0 and uninstalled_packages:
+            print('\nRunning post-uninstallation steps...\n')
+
+            if not _run_post_execution_steps(after_rhino_uninstall(uninstalled_packages)):
+                exit_code = -1
 
     print('\nUninstall completed.')
+
     if exit_code != 0:
         sys.exit(exit_code)
 
@@ -131,13 +145,14 @@ def _filter_installed_packages(version, packages):
             packages = list(itertools.chain.from_iterable(installable_rhino_packages()))
 
     # Handle legacy install
-    legacy_bootstrapper = compas_rhino._get_bootstrapper_path(ipylib_path)
-    if os.path.exists(legacy_bootstrapper):
-        bootstrapper_data = compas_rhino._get_bootstrapper_data(legacy_bootstrapper)
-        legacy_packages = bootstrapper_data.get('INSTALLED_PACKAGES', None)
-
-        if legacy_packages:
-            packages.extend(legacy_packages)
+    if ipylib_path:
+        legacy_bootstrapper = compas_rhino._get_bootstrapper_path(ipylib_path)
+        if os.path.exists(legacy_bootstrapper):
+            bootstrapper_data = compas_rhino._get_bootstrapper_data(legacy_bootstrapper)
+            legacy_packages = bootstrapper_data.get('INSTALLED_PACKAGES', None)
+
+            if legacy_packages:
+                packages.extend(legacy_packages)
 
     return packages
 
diff --git a/src/compas_rhino/uninstall_plugin.py b/src/compas_rhino/uninstall_plugin.py
@@ -38,14 +38,39 @@ def uninstall_plugin(plugin, version=None):
         version = '6.0'
 
     python_plugins_path = compas_rhino._get_python_plugins_path(version)
+    plugin_name = plugin.split('{')[0]
 
-    destination = os.path.join(python_plugins_path, plugin)
+    symlinks = []
+    dirs = []
 
-    print('Uninstalling PlugIn {} from Rhino PythonPlugIns.'.format(plugin))
+    for name in os.listdir(python_plugins_path):
+        path = os.path.join(python_plugins_path, name)
 
-    remove_symlink(destination)
+        if os.path.islink(path):
+            if name.split('{')[0] == plugin_name:
+                symlinks.append(name)
 
-    print('PlugIn {} Uninstalled.'.format(plugin))
+        elif os.path.isdir(path):
+            if name.split('{')[0] == plugin_name:
+                dirs.append(name)
+
+    print('\nUninstalling PlugIn {} from Rhino PythonPlugIns:'.format(plugin_name))
+
+    if not symlinks and not dirs:
+        print('Nothing to uninstall...\n')
+
+    else:
+        for name in symlinks:
+            print('- {}'.format(name))
+            destination = os.path.join(python_plugins_path, name)
+            remove_symlink(destination)
+
+        for name in dirs:
+            print('- {}'.format(name))
+            destination = os.path.join(python_plugins_path, name)
+            os.rmdir(destination)
+
+        print('\nPlugIn {} Uninstalled.\n'.format(plugin_name))
 
 
 # ==============================================================================
