topic Re: Best Way to Uninstall a AMP Module in Alfresco Archive

Best Way to Uninstall a AMP Module

cgonzalez — Wed, 19 Mar 2008 12:42:47 GMT

Hi, I have developed a amp module than extends Alfresco, it works fine,but now i want to uninstall it. How can i do that?If have readed that there's no good way to do that. Any tip?

Re: Best Way to Uninstall a AMP Module

jbarmash — Sun, 23 Mar 2008 04:19:14 GMT

Yes, currently there is no way to uninstall an AMP.

Check out this forum post for a workaround.
http://forums.alfresco.com/viewtopic.php?f=36&t=11487&p=38155#p38155

Also, you can restore the backup file without the AMP that is made when you install the AMP.

This is something that has been bothering me and some customers, so I just modified the Module Management Tool code to handle uninstalling AMPs.   I will work with engineering to make this part of the releases, but in the meantime, below is the patch information.

The only file modified is ModuleManagementTool.java in projects\repository\source\java\org\alfresco\repo\module\tool\.

Index: ModuleManagementTool.java
===================================================================
— ModuleManagementTool.java   (revision 8575)
+++ ModuleManagementTool.java   (working copy)
@@ -77,8 +77,9 @@
     public static final String MODULE_DIR = "/WEB-INF/classes/alfresco/module";
     public static final String BACKUP_DIR = MODULE_DIR + "/backup";

-    /** Operations and options supperted via the command line interface to this class */
+    /** Operations and options supported via the command line interface to this class */
     private static final String OP_INSTALL = "install";
+    private static final String OP_UNINSTALL = "uninstall";
     private static final String OP_LIST = "list";
     private static final String OPTION_VERBOSE = "-verbose";
     private static final String OPTION_FORCE = "-force";
@@ -195,7 +196,7 @@
      * @param warFileLocation   the location of the WAR file into which the AMP file is to be installed.
      * @param preview           indicates whether this should be a preview install. This means that the process of
      *                          installation will be followed and reported, but the WAR file will not be modified.
-     * @param forceInstall      indicates whether the installed files will be replaces reguarless of the currently installed
+     * @param forceInstall      indicates whether the installed files will be replaces regardless of the currently installed
      *                          version of the AMP. Generally used during development of the AMP.
      * @param backupWAR         indicates whether we should backup the war we are modifying or not
      */
@@ -205,35 +206,7 @@
         {
             outputMessage("Installing AMP '" + ampFileLocation + "' into WAR '" + warFileLocation + "'");

-            if (preview == false)
-            {
-                // Make sure the module and backup directory exisits in the WAR file
-                File moduleDir = new File(warFileLocation + MODULE_DIR, DETECTOR_AMP_AND_WAR);
-                if (moduleDir.exists() == false)
-                {
-                    moduleDir.mkdir();
-                }
-                File backUpDir = new File(warFileLocation + BACKUP_DIR, DETECTOR_AMP_AND_WAR);
-                if (backUpDir.exists() == false)
-                {
-                    backUpDir.mkdir();
-                }
-
-                // Make a backup of the war we are going to modify
-                if (backupWAR == true)
-                {
-                    java.io.File warFile = new java.io.File(warFileLocation);
-                    if (warFile.exists() == false)
-                    {
-                        throw new ModuleManagementToolException("The war file '" + warFileLocation + "' does not exist.");
-                    }
-                    String backupLocation = warFileLocation + "-" + System.currentTimeMillis() + ".bak";
-                    java.io.File backup = new java.io.File(backupLocation);
-                    copyFile(warFile, backup);
-
-                    outputMessage("WAR has been backed up to '" + backupLocation + "'");
-                }
-            }
+            backupCurrentWar(warFileLocation, preview, backupWAR);

             // Get the details of the installing module
             String propertiesLocation = ampFileLocation + "/module.properties";
@@ -268,21 +241,7 @@
             ModuleDetails installedModuleDetails = ModuleDetailsHelper.createModuleDetailsFromWarAndId(warFileLocation, installingId);
             if (installedModuleDetails == null)
             {
-                // It might be there as one of the aliases
-                List<String> installingAliases = installingModuleDetails.getAliases();
-                for (String installingAlias : installingAliases)
-                {
-                    ModuleDetails installedAliasModuleDetails = ModuleDetailsHelper.createModuleDetailsFromWarAndId(warFileLocation, installingAlias);
-                    if (installedAliasModuleDetails == null)
-                    {
-                        // There is nothing by that alias
-                        continue;
-                    }
-                    // We found an alias and will treat it as the same module
-                    installedModuleDetails = installedAliasModuleDetails;
-                    outputMessage("Module '" + installingAlias + "' is installed and is an alias of '" + installingId + "'");
-                    break;
-                }
+                installedModuleDetails = findModuleAlias(warFileLocation, installingModuleDetails, installingId);
             }

             // Now clean up the old instance
@@ -413,6 +372,58 @@
             throw new ModuleManagementToolException("An IO error was encountered during deployment of the AEP into the WAR", exception);
         }
     }
+
+   private void backupCurrentWar(String warFileLocation, boolean preview,
+         boolean backupWAR) throws IOException {
+      if (preview == false)
+      {
+          // Make sure the module and backup directory exists in the WAR file
+          File moduleDir = new File(warFileLocation + MODULE_DIR, DETECTOR_AMP_AND_WAR);
+          if (moduleDir.exists() == false)
+          {
+              moduleDir.mkdir();
+          }
+          File backUpDir = new File(warFileLocation + BACKUP_DIR, DETECTOR_AMP_AND_WAR);
+          if (backUpDir.exists() == false)
+          {
+              backUpDir.mkdir();
+          }
+
+          // Make a backup of the war we are going to modify
+          if (backupWAR == true)
+          {
+              java.io.File warFile = new java.io.File(warFileLocation);
+              if (warFile.exists() == false)
+              {
+                  throw new ModuleManagementToolException("The war file '" + warFileLocation + "' does not exist.");
+              }
+              String backupLocation = warFileLocation + "-" + System.currentTimeMillis() + ".bak";
+              java.io.File backup = new java.io.File(backupLocation);
+              copyFile(warFile, backup);
+
+              outputMessage("WAR has been backed up to '" + backupLocation + "'");
+          }
+      }
+   }
+
+   private ModuleDetails findModuleAlias(String warFileLocation,
+         ModuleDetails installingModuleDetails, String installingId) {
+      // It might be there as one of the aliases
+      List<String> installingAliases = installingModuleDetails.getAliases();
+      for (String installingAlias : installingAliases)
+      {
+          ModuleDetails installedAliasModuleDetails = ModuleDetailsHelper.createModuleDetailsFromWarAndId(warFileLocation, installingAlias);
+          if (installedAliasModuleDetails == null)
+          {
+              // There is nothing by that alias
+              continue;
+          }
+          // We found an alias and will treat it as the same module
+          outputMessage("Module '" + installingAlias + "' is installed and is an alias of '" + installingId + "'");
+          return installedAliasModuleDetails;
+      }
+      return null;
+   }

     /**
      * @return Returns the custom file mapping properties or null if they weren't overwritten
@@ -623,11 +634,39 @@
     }

     /**
-     * @throws UnsupportedOperationException
+     * Uninstalls the module from the war file. Does NOT do dependency checks.
      */
-    public void uninstallModule(String moduleId, String warLocation)
+    public void uninstallModule(String moduleId, String warFileLocation, boolean preview)
     {
-        throw new UnsupportedOperationException("Uninstall module is not currently supported");
+       try {
+
+        outputMessage("Uninstalling module '" + moduleId + "' from WAR '" + warFileLocation + "'");
+        backupCurrentWar(warFileLocation, preview, true);
+
+       // Try to find an installed module by the ID
+        ModuleDetails installedModuleDetails = ModuleDetailsHelper.createModuleDetailsFromWarAndId(warFileLocation, moduleId);
+        //outputMessage(installedModuleDetails.getTitle());
+
+        // Now clean up the old instance
+        if (installedModuleDetails != null)
+        {
+            String installedId = installedModuleDetails.getId();
+            VersionNumber installedVersion = installedModuleDetails.getVersion();
+
+            outputMessage("Clearing out files relating to version '" + installedVersion + "' of module '" + installedId + "' in war '" + warFileLocation + "'" );
+            outputMessage("WARNING: No dependencies checks are currently done during the uninstall");
+
+            cleanWAR(warFileLocation, installedId, preview);
+        } else {
+            outputMessage("ERROR: Module '" + moduleId + "' was not found in the war.");
+        }
+
+       } catch (IOException exception)
+        {
+            throw new ModuleManagementToolException("An IO error was encountered during deployment of the AEP into the WAR", exception);
+        }
+
+
     }

     /**
@@ -795,6 +834,23 @@
             String warFileLocation = args[1];
             manager.listModules(warFileLocation);
         }
+        else if (OP_UNINSTALL.equals(operation) == true && (args.length == 3 || args.length ==4)) {
+            manager.setVerbose(true);
+           String moduleId = args[1];
+            String warLocation = args[2];
+
+           boolean preview = false;
+            manager.setVerbose(true);
+
+           if (args.length==4) {
+               if (OPTION_PREVIEW.equals(args[3]) == true)
+               {
+                   preview = true;
+                   manager.outputMessage("PREVIEW mode enabled");
+               }
+           }
+           manager.uninstallModule(moduleId, warLocation, preview);
+       }
         else
         {
             outputUsage();
@@ -810,7 +866,7 @@
     }

     /**
-     * Code borrowed directly from the Springframework FileCopyUtils.
+     * Code borrowed directly from the Spring Framework FileCopyUtils.
      */
     private static void copyFile(java.io.File in, java.io.File out) throws IOException
     {
@@ -857,6 +913,10 @@
         System.out.println("   -preview   : previews installation of AMP without modifying WAR file");
         System.out.println("   -nobackup : indicates that no backup should be made of the WAR\n");
         System.out.println("———————————————————–\n");
+        System.out.println("uninstall: Uninstalls the module a AMP file(s) from an Alfresco WAR file.");
+        System.out.println("usage: uninstall <moduleName> <WARFileLocation> [options] \n");
+        System.out.println("   -preview   : previews uninstallation of AMP without modifying WAR file");
+        System.out.println("———————————————————–\n");
         System.out.println("list: Lists all the modules currently installed in an Alfresco WAR file.");
         System.out.println("usage: list <WARFileLocation>\n");
         System.out.println("———————————————————–\n");

Re: Best Way to Uninstall a AMP Module

cgonzalez — Wed, 26 Mar 2008 10:03:25 GMT

But if i do that when i start alfresco i receive the following WARNING:

WARN [org.alfresco.repo.module.ModuleServiceImpl] A previously-installed module 'myModule (version 0.0)is not present in your distribution.

Re: Best Way to Uninstall a AMP Module

zomurn — Thu, 16 Apr 2009 08:26:11 GMT

Same message.
Can't we still uninstall an AMP ? (I change the name of the module and the old "named" module still appears in the startup logs).

Re: Best Way to Uninstall a AMP Module

cerberos — Mon, 14 Sep 2009 10:10:12 GMT

Hi all,
same message here trying to uninstall a module. I restore an old backup, but the log warns about some missing module. Is possible to avoid this annoying message?

Thanks

Re: Best Way to Uninstall a AMP Module

cerberos — Tue, 15 Sep 2009 10:57:25 GMT

Hi, i discovered that Alfresco creates nodes in the repository about installed modules. In example i found using the query browser this node:


Primary Path:   /{http://www.alfresco.org/model/system/1.0}system-registry/{http://www.alfresco.org/system/modules/1.0}modules 
‍‍‍

with 4 children, corrisponding to my old 4 modules, now uninstalled.
So, how can i try to delete this nodes? Cant'use the UI, because it's not possible to browse the "system store". Probably using the REST API, but don't know how to send quickly a DELETE request via http.

Someone can help me?

Thank you

Re: Best Way to Uninstall a AMP Module

manish — Fri, 20 Nov 2009 07:34:21 GMT

OK. I was looking for this, but seems that it's not yet implemented.

Re: Best Way to Uninstall a AMP Module

vjalilov — Thu, 27 Jan 2011 03:28:19 GMT

To downgrade a module:
After you install an "older" version of the module into alfresco.war, when you start alfresco it will throw an error saying downgrading modules is not supported and not start.

To "fix" this problem, connect to your database (mine was a MySQL DB) and run these SQL commands(at your own risk, after you have backed up your DB )
1. This is so you know what the qname_id means in the latter tables:


mysql> SELECT * FROM alf_qname WHERE alf_qname.id IN (34, 59, 62, 101, 102 );
+—–+———+——-+——————+
| id  | version | ns_id | local_name       |
+—–+———+——-+——————+
|  34 |       1 |     3 | name             |
|  59 |       1 |     5 | container        |
|  62 |       1 |     5 | store_root       |
| 101 |       1 |     8 | currentVersion   |
| 102 |       1 |     8 | installedVersion |
+—–+———+——-+——————+
5 rows in set (0.00 sec)
‍‍‍‍‍‍‍‍‍‍‍‍‍

2. Dig deeper into the 101 and 102 qname_ids:


mysql> SELECT node_id, qname_id, locale_id, string_value FROM alf_node_properties WHERE qname_id IN (101, 102) ORDER BY node_id;
+———+———-+———–+————–+
| node_id | qname_id | locale_id | string_value |
+———+———-+———–+————–+
| 2345995 |      101 |         1 | 2.1.13       |
| 2345995 |      102 |         1 | 2.1.13       |
| 3216313 |      101 |         1 | 2.4.0        |
| 3216313 |      102 |         1 | 2.4.0        |
| 3216314 |      101 |         1 | 2.4.0        |
| 3216314 |      102 |         1 | 2.4.0        |
| 3216315 |      101 |         1 | 2.4.0        |
| 3216315 |      102 |         1 | 2.4.0        |
+———+———-+———–+————–+
8 rows in set (0.00 sec)
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

I want to change 2.4.0 version of my module, so the first 2 lines are irrelevant. I have 3 node_ids of interest (3216313, 3216314, 3216315). Yours will/should be different.

3. See what modules they are:


mysql> SELECT node_id, qname_id, locale_id, string_value FROM alf_node_properties WHERE node_id IN (3216313, 3216314, 3216315) ;
+———+———-+———–+——————-+
| node_id | qname_id | locale_id | string_value      |
+———+———-+———–+——————-+
| 3216313 |       34 |         1 | content-********* |
| 3216313 |      101 |         1 | 2.4.0             |
| 3216313 |      102 |         1 | 2.4.0             |
| 3216314 |       34 |         1 | ******-content    |
| 3216314 |      101 |         1 | 2.4.0             |
| 3216314 |      102 |         1 | 2.4.0             |
| 3216315 |       34 |         1 | ******-alfresco   |
| 3216315 |      101 |         1 | 2.4.0             |
| 3216315 |      102 |         1 | 2.4.0             |
+———+———-+———–+——————-+
9 rows in set (0.00 sec)
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

So, I have 3 modules installed. ******-alfresco is the one I want to change/downgrade to version 2.1.1

4. update the DB. You should by now have Alfresco down, and your database backed up!


mysql> UPDATE alf_node_properties SET string_value = '2.1.1' WHERE node_id = 3216315 AND qname_id IN (101, 102);
Query OK, 2 rows affected (0.00 sec)
Rows matched: 2  Changed: 2  Warnings: 0
‍‍‍‍‍

5. Verify the glory of our achievement 😎 :


mysql> SELECT node_id, qname_id, locale_id, string_value FROM alf_node_properties WHERE node_id = 3216315 ;
+———+———-+———–+—————–+
| node_id | qname_id | locale_id | string_value    |
+———+———-+———–+—————–+
| 3216315 |       34 |         1 | ******-alfresco |
| 3216315 |      101 |         1 | 2.1.1           |
| 3216315 |      102 |         1 | 2.1.1           |
+———+———-+———–+—————–+
3 rows in set (0.00 sec)
‍‍‍‍‍‍‍‍‍‍‍

Re: Best Way to Uninstall a AMP Module

mpeters — Mon, 30 Jun 2014 18:47:17 GMT

This made my day. Thanks!!!

Re: Best Way to Uninstall a AMP Module

dbiggins — Mon, 25 Aug 2014 16:29:34 GMT

This worked great for me with the exception of the 'currentVersion' and 'installedVersion' id. Instead of 101 and 102, my vals were 222 and 223. After that, everything worked great.

I got the different IDs by running:


select local_name, id from alf_qname where  local_name in ('currentVersion', 'installedVersion')
‍‍‍

FWIW, I am running 4.2.f CE against a Postgres database.

Thanks for sharing this solution!!

Re: Best Way to Uninstall a AMP Module

heiko_robert — Tue, 28 Jul 2015 20:52:31 GMT

In Alfresco 5.x the version is stored as a serialized object - so no fun in the database. Instead you could just remove all module registrations using java script and restart. If you can't even start you need to restore the original war first:


var searchString = "/sys:system-registry/module:modules/*"; // XPath search string
var store = "system://system";
var nodes = search.selectNodes(store, searchString);

for each (var node in nodes) {
logger.log("removing entry for module: " + node.name);
   node.addAspect("sys:temporary");
    node.remove();
}
‍‍‍‍‍‍‍‍‍‍‍

Re: Best Way to Uninstall a AMP Module

heiko_robert — Wed, 29 Jul 2015 07:50:19 GMT

There was an ongoing discussion in JIRA about the module registry cleanup: "uninstalling an AMP should remove the module nodes in the repository"
unfortunately the issue "RA-44" has been removed from public access …
Any comments on that from Alfresco side?

Anyway - we have a solution with the java script for the hard coded removal but would expect a more consistent way which also includes an API for model migration.

I created a new issue in JIRA as a requirement for module management:
ALF-21399 support for document model migration and downgrade https://issues.alfresco.com/jira/browse/ALF-21399

Please vote this issue if you think this is relevant for you also!

Thanks

Re: Best Way to Uninstall a AMP Module

jpotts — Wed, 29 Nov 2017 00:16:07 GMT

Old thread, but in case it is helpful, in 5.x you can also use the Node Browser at /alfresco to browse the same path and delete exactly the module you need to.

Re: Best Way to Uninstall a AMP Module

heiko_robert — Thu, 15 Mar 2018 10:50:44 GMT

Since the issue ALF-21399 has been closed as "not a bug" I'd like to share that we worked around this long story by implementing a hardcore Alfresco extension which is able to migrate, up- and downgrade Alfresco Types. The implementation has a javascript binding to call a migration batch job for specific types and expects a function (getting the old property array as argument) which takes care how to save the old values in other properties, jdbc datasources ...

If anybody is interested, please send me a pm. We decided not to publish this extension (yet) since it will be very easy to loose data if you have bugs in the custom function. But as always: With great power comes great responsibility!

Re: Best Way to Uninstall a AMP Module

AlfrescoZZZ — Tue, 05 Feb 2019 15:07:22 GMT

HI can you be more specific on how do that on the path /alfresco ?

Re: Best Way to Uninstall a AMP Module

sercama — Tue, 05 Feb 2019 15:56:53 GMT

Hi Marco Tenti‌,

You can access to Node Browser named by Jeff Potts‌ in the following URL http://{alfrescoIP}:{alfrescoPort}/alfresco/s/admin/admin-communitysummary. In this page, you can select Node Browser tool and search "/sys:system-registry/module:modules/*" with option "selectnodes". After that, you can view all modules installed in your system and the modules which have been installed and removed from your Alfresco.

Regards,

Sergio.

Re: Best Way to Uninstall a AMP Module

AlfrescoZZZ — Wed, 06 Feb 2019 08:42:51 GMT

Ty very much, save me a lot of time.

Re: Best Way to Uninstall a AMP Module

heiko_robert — Wed, 06 Feb 2019 09:27:52 GMT

Please make sure your removed amp did not provide a document model which is referenced by existing nodes (by document type and/or aspects). Alfresco will not complain until you open or modify an affected node or version and errors occur months or years later when you don't expect them.

Re: Best Way to Uninstall a AMP Module

sercama — Wed, 06 Feb 2019 10:34:42 GMT

It’s a very important note!!!

Re: Best Way to Uninstall a AMP Module

AlfrescoZZZ — Thu, 27 Jun 2019 16:11:12 GMT

Hi Heiko i'm interested to try out the extension you talk it about, i can't send you a pm because i'm must be friend or follow by you for send the message.

Ty.

Greeting.