mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-30 18:15:39 +00:00
d69bfa23af
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5653 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
856 lines
37 KiB
Java
856 lines
37 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.module.tool;
|
|
|
|
import java.io.BufferedInputStream;
|
|
import java.io.BufferedOutputStream;
|
|
import java.io.FileOutputStream;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.io.OutputStream;
|
|
import java.util.ArrayList;
|
|
import java.util.Date;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.Properties;
|
|
|
|
import org.alfresco.error.AlfrescoRuntimeException;
|
|
import org.alfresco.service.cmr.module.ModuleDependency;
|
|
import org.alfresco.service.cmr.module.ModuleDetails;
|
|
import org.alfresco.service.cmr.module.ModuleInstallState;
|
|
import org.alfresco.util.VersionNumber;
|
|
import org.doomdark.uuid.UUIDGenerator;
|
|
|
|
import de.schlichtherle.io.DefaultRaesZipDetector;
|
|
import de.schlichtherle.io.File;
|
|
import de.schlichtherle.io.FileInputStream;
|
|
import de.schlichtherle.io.ZipControllerException;
|
|
import de.schlichtherle.io.ZipDetector;
|
|
import de.schlichtherle.io.ZipWarningException;
|
|
|
|
/**
|
|
* Module management tool.
|
|
* <p>
|
|
* Manages the modules installed in a war file. Allows modules to be installed, updated, enabled, disabled and
|
|
* uninstalled. Information about the module installed is also available.
|
|
*
|
|
* @since 2.0
|
|
*
|
|
* @author Roy Wetherall
|
|
* @author Derek Hulley
|
|
*/
|
|
public class ModuleManagementTool
|
|
{
|
|
/** Location of the default mapping properties file */
|
|
private static final String DEFAULT_FILE_MAPPING_PROPERTIES = "org/alfresco/repo/module/tool/default-file-mapping.properties";
|
|
/** Location of the AMP-specific mappings file */
|
|
private static final String FILE_MAPPING_PROPERTIES = "file-mapping.properties";
|
|
/**
|
|
* The property to add to a custom {@link #FILE_MAPPING_PROPERTIES file-mapping.properties} to inherit the default values.
|
|
* The default is <code>true</code>.
|
|
*/
|
|
private static final String PROP_INHERIT_DEFAULT = "include.default";
|
|
|
|
/** Standard directories found in the alfresco war */
|
|
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 */
|
|
private static final String OP_INSTALL = "install";
|
|
private static final String OP_LIST = "list";
|
|
private static final String OPTION_VERBOSE = "-verbose";
|
|
private static final String OPTION_FORCE = "-force";
|
|
private static final String OPTION_PREVIEW = "-preview";
|
|
private static final String OPTION_NOBACKUP = "-nobackup";
|
|
private static final String OPTION_DIRECTORY = "-directory";
|
|
|
|
/** Default zip detector */
|
|
public static final ZipDetector DETECTOR_AMP_AND_WAR = new DefaultRaesZipDetector("amp|war");
|
|
|
|
/** File mapping properties */
|
|
private Properties defaultFileMappingProperties;
|
|
|
|
/** Indicates the current verbose setting */
|
|
private boolean verbose = false;
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public ModuleManagementTool()
|
|
{
|
|
// Load the default file mapping properties
|
|
this.defaultFileMappingProperties = new Properties();
|
|
InputStream is = this.getClass().getClassLoader().getResourceAsStream(DEFAULT_FILE_MAPPING_PROPERTIES);
|
|
try
|
|
{
|
|
this.defaultFileMappingProperties.load(is);
|
|
}
|
|
catch (IOException exception)
|
|
{
|
|
throw new ModuleManagementToolException("Unable to load default extension file mapping properties.", exception);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Indicates whether the management tool is currently in verbose reporting mode.
|
|
*
|
|
* @return true if verbose, false otherwise
|
|
*/
|
|
public boolean isVerbose()
|
|
{
|
|
return verbose;
|
|
}
|
|
|
|
/**
|
|
* Sets the verbose setting for the mangement tool
|
|
*
|
|
* @param verbose true if verbose, false otherwise
|
|
*/
|
|
public void setVerbose(boolean verbose)
|
|
{
|
|
this.verbose = verbose;
|
|
}
|
|
|
|
/**
|
|
* Installs all modules within a folder into the given WAR file.
|
|
*
|
|
* @see #installModule(String, String, boolean, boolean, boolean)
|
|
*/
|
|
public void installModules(String directory, String warFileLocation)
|
|
{
|
|
installModules(directory, warFileLocation, false, false, true);
|
|
}
|
|
|
|
public void installModules(String directoryLocation, String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)
|
|
{
|
|
java.io.File dir = new java.io.File(directoryLocation);
|
|
if (dir.exists() == true)
|
|
{
|
|
installModules(dir, warFileLocation, preview, forceInstall,backupWAR);
|
|
}
|
|
else
|
|
{
|
|
throw new ModuleManagementToolException("Invalid directory '" + directoryLocation + "'");
|
|
}
|
|
}
|
|
|
|
private void installModules(java.io.File dir, String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)
|
|
{
|
|
java.io.File[] children = dir.listFiles();
|
|
if (children != null)
|
|
{
|
|
for (java.io.File child : children)
|
|
{
|
|
if (child.isFile() == true && child.getName().toLowerCase().endsWith(".amp") == true)
|
|
{
|
|
installModule(child.getPath(), warFileLocation, preview, forceInstall, backupWAR);
|
|
}
|
|
else
|
|
{
|
|
installModules(child, warFileLocation, preview, forceInstall, backupWAR);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Installs a given AMP file into a given WAR file.
|
|
*
|
|
* @see ModuleManagementTool.installModule(String, String, boolean, boolean, boolean)
|
|
*
|
|
* @param ampFileLocation the location of the AMP file to be installed
|
|
* @param warFileLocation the location of the WAR file into which the AMP file is to be installed
|
|
*/
|
|
public void installModule(String ampFileLocation, String warFileLocation)
|
|
{
|
|
installModule(ampFileLocation, warFileLocation, false, false, true);
|
|
}
|
|
|
|
/**
|
|
* Installs a given AMP file into a given WAR file.
|
|
*
|
|
* @param ampFileLocation the location of the AMP file to be installed
|
|
* @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
|
|
* 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
|
|
*/
|
|
public void installModule(String ampFileLocation, String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)
|
|
{
|
|
try
|
|
{
|
|
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 + "'");
|
|
}
|
|
}
|
|
|
|
// Get the details of the installing module
|
|
String propertiesLocation = ampFileLocation + "/module.properties";
|
|
ModuleDetails installingModuleDetails = ModuleDetailsHelper.createModuleDetailsFromPropertyLocation(propertiesLocation);
|
|
if (installingModuleDetails == null)
|
|
{
|
|
throw new ModuleManagementToolException("No module.properties file has been found in the installing .amp file '" + ampFileLocation + "'");
|
|
}
|
|
String installingId = installingModuleDetails.getId();
|
|
VersionNumber installingVersion = installingModuleDetails.getVersion();
|
|
|
|
// Check that the target war has the necessary dependencies for this install
|
|
List<ModuleDependency> installingModuleDependencies = installingModuleDetails.getDependencies();
|
|
List<ModuleDependency> missingDependencies = new ArrayList<ModuleDependency>(0);
|
|
for (ModuleDependency dependency : installingModuleDependencies)
|
|
{
|
|
String dependencyId = dependency.getDependencyId();
|
|
ModuleDetails dependencyModuleDetails = ModuleDetailsHelper.createModuleDetailsFromWarAndId(warFileLocation, dependencyId);
|
|
// Check the dependency. The API specifies that a null returns false, so no null check is required
|
|
if (!dependency.isValidDependency(dependencyModuleDetails))
|
|
{
|
|
missingDependencies.add(dependency);
|
|
continue;
|
|
}
|
|
}
|
|
if (missingDependencies.size() > 0)
|
|
{
|
|
throw new ModuleManagementToolException("The following modules must first be installed: " + missingDependencies);
|
|
}
|
|
|
|
// Try to find an installed module by the ID
|
|
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;
|
|
}
|
|
}
|
|
|
|
// Now clean up the old instance
|
|
if (installedModuleDetails != null)
|
|
{
|
|
String installedId = installedModuleDetails.getId();
|
|
VersionNumber installedVersion = installedModuleDetails.getVersion();
|
|
|
|
int compareValue = installedVersion.compareTo(installingVersion);
|
|
if (forceInstall == true || compareValue == -1)
|
|
{
|
|
if (forceInstall == true)
|
|
{
|
|
// Warn of forced install
|
|
outputMessage("WARNING: The installation of this module is being forced. All files will be removed and replaced regardless of exiting versions present.");
|
|
}
|
|
|
|
// Trying to update the extension, old files need to cleaned before we proceed
|
|
outputMessage("Clearing out files relating to version '" + installedVersion + "' of module '" + installedId + "'");
|
|
cleanWAR(warFileLocation, installedId, preview);
|
|
}
|
|
else if (compareValue == 0)
|
|
{
|
|
// Trying to install the same extension version again
|
|
outputMessage("WARNING: This version of this module is already installed in the WAR");
|
|
throw new ModuleManagementToolException("This version of this module is alreay installed. Use the 'force' parameter if you want to overwrite the current installation.");
|
|
}
|
|
else if (compareValue == 1)
|
|
{
|
|
// Trying to install an earlier version of the extension
|
|
outputMessage("WARNING: A later version of this module is already installed in the WAR");
|
|
throw new ModuleManagementToolException("A later version of this module is already installed. You must first unistall the current version before installing this version of the module.");
|
|
}
|
|
}
|
|
|
|
// Check if a custom mapping file has been defined
|
|
Properties fileMappingProperties = null;
|
|
Properties customFileMappingProperties = getCustomFileMappings(ampFileLocation);
|
|
if (customFileMappingProperties == null)
|
|
{
|
|
fileMappingProperties = defaultFileMappingProperties;
|
|
}
|
|
else
|
|
{
|
|
fileMappingProperties = new Properties();
|
|
// A custom mapping file was present. Check if it must inherit the default mappings.
|
|
String inheritDefaultStr = customFileMappingProperties.getProperty(PROP_INHERIT_DEFAULT, "true");
|
|
if (inheritDefaultStr.equalsIgnoreCase("true"))
|
|
{
|
|
fileMappingProperties.putAll(defaultFileMappingProperties);
|
|
}
|
|
fileMappingProperties.putAll(customFileMappingProperties);
|
|
fileMappingProperties.remove(PROP_INHERIT_DEFAULT);
|
|
}
|
|
|
|
// Copy the files from the AMP file into the WAR file
|
|
outputMessage("Adding files relating to version '" + installingVersion + "' of module '" + installingId + "'");
|
|
InstalledFiles installedFiles = new InstalledFiles(warFileLocation, installingId);
|
|
for (Map.Entry<Object, Object> entry : fileMappingProperties.entrySet())
|
|
{
|
|
// The file mappings are expected to start with "/"
|
|
String mappingSource = (String) entry.getKey();
|
|
if (mappingSource.length() == 0 || !mappingSource.startsWith("/"))
|
|
{
|
|
throw new AlfrescoRuntimeException("File mapping sources must start with '/', but was: " + mappingSource);
|
|
}
|
|
String mappingTarget = (String) entry.getValue();
|
|
if (mappingTarget.length() == 0 || !mappingTarget.startsWith("/"))
|
|
{
|
|
throw new AlfrescoRuntimeException("File mapping targets must start with '/' but was '" + mappingTarget + "'");
|
|
}
|
|
|
|
// Run throught the files one by one figuring out what we are going to do during the copy
|
|
copyToWar(ampFileLocation, warFileLocation, mappingSource, mappingTarget, installedFiles, preview);
|
|
|
|
if (preview == false)
|
|
{
|
|
// Get a reference to the source folder (if it isn't present don't do anything)
|
|
File source = new File(ampFileLocation + "/" + mappingSource, DETECTOR_AMP_AND_WAR);
|
|
if (source != null && source.list() != null)
|
|
{
|
|
// Get a reference to the destination folder
|
|
File destination = new File(warFileLocation + "/" + mappingTarget, DETECTOR_AMP_AND_WAR);
|
|
if (destination == null)
|
|
{
|
|
throw new ModuleManagementToolException("The destination folder '" + mappingTarget + "' as specified in mapping properties does not exist in the war");
|
|
}
|
|
// Do the bulk copy since this is quicker than copying files one by one
|
|
destination.copyAllFrom(source);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (preview == false)
|
|
{
|
|
// Save the installed file list
|
|
installedFiles.save();
|
|
|
|
// Update the installed module details
|
|
installingModuleDetails.setInstallState(ModuleInstallState.INSTALLED);
|
|
installingModuleDetails.setInstallDate(new Date());
|
|
ModuleDetailsHelper.saveModuleDetails(warFileLocation, installingModuleDetails);
|
|
|
|
// Update the zip files
|
|
File.update();
|
|
|
|
// Set the modified date
|
|
java.io.File warFile = new java.io.File(warFileLocation);
|
|
if (warFile.exists())
|
|
{
|
|
warFile.setLastModified(System.currentTimeMillis());
|
|
}
|
|
}
|
|
}
|
|
catch (ZipWarningException ignore)
|
|
{
|
|
// Only instances of the class ZipWarningException exist in the chain of
|
|
// exceptions. We choose to ignore this.
|
|
}
|
|
catch (ZipControllerException exception)
|
|
{
|
|
// At least one exception occured which is not just a ZipWarningException.
|
|
// This is a severe situation that needs to be handled.
|
|
throw new ModuleManagementToolException("A Zip error was encountered during deployment of the AEP into the WAR", exception);
|
|
}
|
|
catch (IOException exception)
|
|
{
|
|
throw new ModuleManagementToolException("An IO error was encountered during deployment of the AEP into the WAR", exception);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return Returns the custom file mapping properties or null if they weren't overwritten
|
|
*/
|
|
private Properties getCustomFileMappings(String ampFileLocation)
|
|
{
|
|
File file = new File(ampFileLocation + "/" + FILE_MAPPING_PROPERTIES, ModuleManagementTool.DETECTOR_AMP_AND_WAR);
|
|
if (!file.exists())
|
|
{
|
|
// Nothing there
|
|
return null;
|
|
}
|
|
Properties mappingProperties = new Properties();
|
|
InputStream is = null;
|
|
try
|
|
{
|
|
is = new BufferedInputStream(new FileInputStream(file));
|
|
mappingProperties.load(is);
|
|
}
|
|
catch (IOException exception)
|
|
{
|
|
throw new ModuleManagementToolException("Unable to load default extension file mapping properties.", exception);
|
|
}
|
|
finally
|
|
{
|
|
if (is != null)
|
|
{
|
|
try { is.close(); } catch (Throwable e ) {}
|
|
}
|
|
}
|
|
return mappingProperties;
|
|
}
|
|
|
|
/**
|
|
* Cleans the WAR file of all files relating to the currently installed version of the the AMP.
|
|
*
|
|
* @param warFileLocatio the war file location
|
|
* @param moduleId the module id
|
|
* @param preview indicates whether this is a preview installation
|
|
*/
|
|
private void cleanWAR(String warFileLocation, String moduleId, boolean preview)
|
|
{
|
|
InstalledFiles installedFiles = new InstalledFiles(warFileLocation, moduleId);
|
|
installedFiles.load();
|
|
|
|
for (String add : installedFiles.getAdds())
|
|
{
|
|
// Remove file
|
|
removeFile(warFileLocation, add, preview);
|
|
}
|
|
for (String mkdir : installedFiles.getMkdirs())
|
|
{
|
|
// Remove folder
|
|
removeFile(warFileLocation, mkdir, preview);
|
|
}
|
|
for (Map.Entry<String, String> update : installedFiles.getUpdates().entrySet())
|
|
{
|
|
if (preview == false)
|
|
{
|
|
// Recover updated file and delete backups
|
|
File modified = new File(warFileLocation + update.getKey(), DETECTOR_AMP_AND_WAR);
|
|
File backup = new File(warFileLocation + update.getValue(), DETECTOR_AMP_AND_WAR);
|
|
modified.copyFrom(backup);
|
|
backup.delete();
|
|
}
|
|
|
|
outputMessage("Recovering file '" + update.getKey() + "' from backup '" + update.getValue() + "'", true);
|
|
}
|
|
// Now remove the installed files list
|
|
String installedFilesPathInWar = installedFiles.getFilePathInWar();
|
|
removeFile(warFileLocation, installedFilesPathInWar, preview);
|
|
// Remove the module properties
|
|
String modulePropertiesFileLocationInWar = ModuleDetailsHelper.getModulePropertiesFilePathInWar(moduleId);
|
|
removeFile(warFileLocation, modulePropertiesFileLocationInWar, preview);
|
|
}
|
|
|
|
/**
|
|
* Removes a file from the given location in the war file.
|
|
*
|
|
* @param warLocation the war file location
|
|
* @param filePath the path to the file that is to be deleted
|
|
* @param preview indicates whether this is a preview install
|
|
*/
|
|
private void removeFile(String warLocation, String filePath, boolean preview)
|
|
{
|
|
File removeFile = new File(warLocation + filePath, DETECTOR_AMP_AND_WAR);
|
|
if (removeFile.exists() == true)
|
|
{
|
|
outputMessage("Removing file '" + filePath + "' from war", true);
|
|
if (preview == false)
|
|
{
|
|
removeFile.delete();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
outputMessage("The file '" + filePath + "' was expected for removal but was not present in the war", true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Copies a file from the AMP location to the correct location in the WAR, interating on directories where appropraite.
|
|
*
|
|
* @param ampFileLocation the AMP file location
|
|
* @param warFileLocation the WAR file location
|
|
* @param sourceDir the directory in the AMP to copy from. It must start with "/".
|
|
* @param destinationDir the directory in the WAR to copy to. It must start with "/".
|
|
* @param installedFiles a list of the currently installed files
|
|
* @param preview indicates whether this is a preview install or not
|
|
* @throws IOException throws any IOExpceptions thar are raised
|
|
*/
|
|
private void copyToWar(String ampFileLocation, String warFileLocation, String sourceDir, String destinationDir, InstalledFiles installedFiles, boolean preview)
|
|
throws IOException
|
|
{
|
|
if (sourceDir.length() == 0 || !sourceDir.startsWith("/"))
|
|
{
|
|
throw new IllegalArgumentException("sourceDir must start with '/'");
|
|
}
|
|
if (destinationDir.length() == 0 || !destinationDir.startsWith("/"))
|
|
{
|
|
throw new IllegalArgumentException("destinationDir must start with '/'");
|
|
}
|
|
|
|
// Handle source and destination if they are just the root '/'
|
|
if (sourceDir.equals("/"))
|
|
{
|
|
sourceDir = "";
|
|
}
|
|
if (destinationDir.equals("/"))
|
|
{
|
|
destinationDir = "";
|
|
}
|
|
|
|
String sourceLocation = ampFileLocation + sourceDir;
|
|
File ampConfig = new File(sourceLocation, DETECTOR_AMP_AND_WAR);
|
|
|
|
java.io.File[] files = ampConfig.listFiles();
|
|
if (files != null)
|
|
{
|
|
for (java.io.File sourceChild : files)
|
|
{
|
|
String destinationFileLocation = warFileLocation + destinationDir + "/" + sourceChild.getName();
|
|
File destinationChild = new File(destinationFileLocation, DETECTOR_AMP_AND_WAR);
|
|
if (sourceChild.isFile() == true)
|
|
{
|
|
String backupLocation = null;
|
|
boolean createFile = false;
|
|
if (destinationChild.exists() == false)
|
|
{
|
|
createFile = true;
|
|
}
|
|
else
|
|
{
|
|
// Backup file about to be updated
|
|
backupLocation = BACKUP_DIR + "/" + generateGuid() + ".bin";
|
|
if (preview == false)
|
|
{
|
|
File backupFile = new File(warFileLocation + backupLocation, DETECTOR_AMP_AND_WAR);
|
|
backupFile.copyFrom(destinationChild);
|
|
}
|
|
}
|
|
|
|
if (createFile == true)
|
|
{
|
|
installedFiles.addAdd(destinationDir + "/" + sourceChild.getName());
|
|
this.outputMessage("File '" + destinationDir + "/" + sourceChild.getName() + "' added to war from amp", true);
|
|
}
|
|
else
|
|
{
|
|
installedFiles.addUpdate(destinationDir + "/" + sourceChild.getName(), backupLocation);
|
|
this.outputMessage("WARNING: The file '" + destinationDir + "/" + sourceChild.getName() + "' is being updated by this module and has been backed-up to '" + backupLocation + "'", true);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
boolean mkdir = false;
|
|
if (destinationChild.exists() == false)
|
|
{
|
|
mkdir = true;
|
|
}
|
|
|
|
copyToWar(ampFileLocation, warFileLocation, sourceDir + "/" + sourceChild.getName(),
|
|
destinationDir + "/" + sourceChild.getName(), installedFiles, preview);
|
|
if (mkdir == true)
|
|
{
|
|
installedFiles.addMkdir(destinationDir + "/" + sourceChild.getName());
|
|
this.outputMessage("Directory '" + destinationDir + "/" + sourceChild.getName() + "' added to war", true);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @throws UnsupportedOperationException
|
|
*/
|
|
public void disableModule(String moduleId, String warLocation)
|
|
{
|
|
throw new UnsupportedOperationException("Disable module is not currently supported");
|
|
}
|
|
|
|
/**
|
|
* @throws UnsupportedOperationException
|
|
*/
|
|
public void enableModule(String moduleId, String warLocation)
|
|
{
|
|
throw new UnsupportedOperationException("Enable module is not currently supported");
|
|
}
|
|
|
|
/**
|
|
* @throws UnsupportedOperationException
|
|
*/
|
|
public void uninstallModule(String moduleId, String warLocation)
|
|
{
|
|
throw new UnsupportedOperationException("Uninstall module is not currently supported");
|
|
}
|
|
|
|
/**
|
|
* Lists all the currently installed modules in the WAR
|
|
*
|
|
* @param warLocation the war location
|
|
*/
|
|
public void listModules(String warLocation)
|
|
{
|
|
ModuleDetails moduleDetails = null;
|
|
boolean previous = this.verbose;
|
|
this.verbose = true;
|
|
try
|
|
{
|
|
File moduleDir = new File(warLocation + MODULE_DIR, DETECTOR_AMP_AND_WAR);
|
|
if (moduleDir.exists() == false)
|
|
{
|
|
outputMessage("No modules are installed in this WAR file");
|
|
}
|
|
|
|
java.io.File[] dirs = moduleDir.listFiles();
|
|
if (dirs != null && dirs.length != 0)
|
|
{
|
|
for (java.io.File dir : dirs)
|
|
{
|
|
if (dir.isDirectory() == true)
|
|
{
|
|
File moduleProperties = new File(dir.getPath() + "/module.properties", DETECTOR_AMP_AND_WAR);
|
|
if (moduleProperties.exists() == true)
|
|
{
|
|
try
|
|
{
|
|
InputStream is = new FileInputStream(moduleProperties);
|
|
moduleDetails = ModuleDetailsHelper.createModuleDetailsFromPropertiesStream(is);
|
|
}
|
|
catch (IOException exception)
|
|
{
|
|
throw new ModuleManagementToolException("Unable to open module properties file '" + moduleProperties.getPath() + "'", exception);
|
|
}
|
|
|
|
outputMessage("Module '" + moduleDetails.getId() + "' installed in '" + warLocation + "'");
|
|
outputMessage(" Title: " + moduleDetails.getTitle(), true);
|
|
outputMessage(" Version: " + moduleDetails.getVersion(), true);
|
|
outputMessage(" Install Date: " + moduleDetails.getInstallDate(), true);
|
|
outputMessage(" Desription: " + moduleDetails.getDescription(), true);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
outputMessage("No modules are installed in this WAR file");
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
this.verbose = previous;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Outputs a message the console (in verbose mode) and the logger.
|
|
*
|
|
* @param message the message to output
|
|
*/
|
|
private void outputMessage(String message)
|
|
{
|
|
outputMessage(message, false);
|
|
}
|
|
|
|
/**
|
|
* Outputs a message the console (in verbose mode) and the logger.
|
|
*
|
|
* @param message the message to output
|
|
* @prarm indent indicates that the message should be formated with an indent
|
|
*/
|
|
private void outputMessage(String message, boolean indent)
|
|
{
|
|
if (indent == true)
|
|
{
|
|
message = " - " + message;
|
|
}
|
|
if (this.verbose == true)
|
|
{
|
|
System.out.println(message);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Main
|
|
*
|
|
* @param args command line interface arguments
|
|
*/
|
|
public static void main(String[] args)
|
|
{
|
|
if (args.length <= 1)
|
|
{
|
|
outputUsage();
|
|
return;
|
|
}
|
|
ModuleManagementTool manager = new ModuleManagementTool();
|
|
|
|
String operation = args[0];
|
|
if (operation.equals(OP_INSTALL) == true && args.length >= 3)
|
|
{
|
|
String aepFileLocation = args[1];
|
|
String warFileLocation = args[2];
|
|
boolean forceInstall = false;
|
|
boolean previewInstall = false;
|
|
boolean backup = true;
|
|
boolean directory = false;
|
|
|
|
if (args.length > 3)
|
|
{
|
|
for (int i = 3; i < args.length; i++)
|
|
{
|
|
String option = args[i];
|
|
if (OPTION_VERBOSE.equals(option) == true)
|
|
{
|
|
manager.setVerbose(true);
|
|
}
|
|
else if (OPTION_FORCE.equals(option) == true)
|
|
{
|
|
forceInstall = true;
|
|
}
|
|
else if (OPTION_PREVIEW.equals(option) == true)
|
|
{
|
|
previewInstall = true;
|
|
manager.setVerbose(true);
|
|
}
|
|
else if (OPTION_NOBACKUP.equals(option) == true)
|
|
{
|
|
backup = false;
|
|
}
|
|
else if (OPTION_DIRECTORY.equals(option) == true)
|
|
{
|
|
directory = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (directory == false)
|
|
{
|
|
// Install the module
|
|
manager.installModule(aepFileLocation, warFileLocation, previewInstall, forceInstall, backup);
|
|
}
|
|
else
|
|
{
|
|
// Install the modules from the directory
|
|
manager.installModules(aepFileLocation, warFileLocation, previewInstall, forceInstall, backup);
|
|
}
|
|
}
|
|
else if (OP_LIST.equals(operation) == true && args.length == 2)
|
|
{
|
|
// List the installed modules
|
|
String warFileLocation = args[1];
|
|
manager.listModules(warFileLocation);
|
|
}
|
|
else
|
|
{
|
|
outputUsage();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates a GUID, avoiding undesired imports.
|
|
*/
|
|
private static String generateGuid()
|
|
{
|
|
return UUIDGenerator.getInstance().generateTimeBasedUUID().toString();
|
|
}
|
|
|
|
/**
|
|
* Code borrowed directly from the Springframework FileCopyUtils.
|
|
*/
|
|
private static void copyFile(java.io.File in, java.io.File out) throws IOException
|
|
{
|
|
InputStream is = new BufferedInputStream(new FileInputStream(in));
|
|
OutputStream os = new BufferedOutputStream(new FileOutputStream(out));
|
|
try
|
|
{
|
|
int byteCount = 0;
|
|
byte[] buffer = new byte[4096];
|
|
int bytesRead = -1;
|
|
while ((bytesRead = is.read(buffer)) != -1) {
|
|
os.write(buffer, 0, bytesRead);
|
|
byteCount += bytesRead;
|
|
}
|
|
os.flush();
|
|
}
|
|
finally
|
|
{
|
|
if (is != null)
|
|
{
|
|
try { is.close(); } catch (Throwable e) { e.printStackTrace(); }
|
|
}
|
|
if (os != null)
|
|
{
|
|
try { os.close(); } catch (Throwable e) { e.printStackTrace(); }
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Outputs the module management tool usage
|
|
*/
|
|
private static void outputUsage()
|
|
{
|
|
System.out.println("Module managment tool available commands:");
|
|
System.out.println("-----------------------------------------------------------\n");
|
|
System.out.println("install: Installs a AMP file(s) into an Alfresco WAR file, updates if an older version is already installed.");
|
|
System.out.println("usage: install <AMPFileLocation> <WARFileLocation> [options]");
|
|
System.out.println("valid options: ");
|
|
System.out.println(" -verbose : enable verbose output");
|
|
System.out.println(" -directory : indicates that the amp file location specified is a directory.");
|
|
System.out.println(" All amp files found in the directory and its sub directories are installed.");
|
|
System.out.println(" -force : forces installation of AMP regardless of currently installed module version");
|
|
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("list: Lists all the modules currently installed in an Alfresco WAR file.");
|
|
System.out.println("usage: list <WARFileLocation>\n");
|
|
System.out.println("-----------------------------------------------------------\n");
|
|
}
|
|
}
|