org.opencms.module.CmsModule Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* 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.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* 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
*/
package org.opencms.module;
import org.opencms.db.CmsExportPoint;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.types.I_CmsResourceType;
import org.opencms.main.CmsException;
import org.opencms.main.CmsIllegalArgumentException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.security.CmsRole;
import org.opencms.security.CmsRoleViolationException;
import org.opencms.util.CmsFileUtil;
import org.opencms.util.CmsStringUtil;
import org.opencms.workplace.explorer.CmsExplorerTypeSettings;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.SortedMap;
import java.util.StringTokenizer;
import java.util.TreeMap;
import org.apache.commons.logging.Log;
import com.google.common.collect.Lists;
/**
* Describes an OpenCms module.
*
* OpenCms modules provide a standard mechanism to extend the OpenCms functionality.
* Modules can contain VFS data, Java classes and a number of configuration options.
*
* @since 6.0.0
*
* @see org.opencms.module.I_CmsModuleAction
* @see org.opencms.module.A_CmsModuleAction
*/
public class CmsModule implements Comparable, Serializable {
/** The available module export modes. */
public enum ExportMode {
/** Default export mode. */
DEFAULT,
/** Reduced export, that omits last modification information (dates and users). */
REDUCED;
/**
* @see java.lang.Enum#toString()
*/
@Override
public String toString() {
return super.toString().toLowerCase();
}
}
/** The default date for module created / installed if not provided. */
public static final long DEFAULT_DATE = 0L;
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsModule.class);
/**
* The module property key name to specifiy additional resources which are
* part of a module outside of {system/modules}.
*/
private static final String MODULE_PROPERTY_ADDITIONAL_RESOURCES = "additionalresources";
/** Character to separate additional resources specified in the module properties. */
private static final String MODULE_PROPERTY_ADDITIONAL_RESOURCES_SEPARATOR = ";";
/** The serial version id. */
private static final long serialVersionUID = -2639349161445831665L;
/** The module action class name. */
private String m_actionClass;
/** Initialized module action instance. */
private transient I_CmsModuleAction m_actionInstance;
/** The email of the author of this module. */
private String m_authorEmail;
/** The name of the author of this module. */
private String m_authorName;
/** True if the module's version should be auto-incremented based on module resource changes in the VFS. */
private boolean m_autoIncrement;
/** Timestamp used for version auto-incrementing: if module resources have been modified after this timestamp, increment the version. */
private long m_checkpointTime;
/** Flag to create the classes folders when creating the module. */
private transient boolean m_createClassesFolder;
/** Flag to create the elements folder when creating the module. */
private transient boolean m_createElementsFolder;
/** Flag to create the formatters folder when creating the module. */
private transient boolean m_createFormattersFolder;
/** Flag to create the i18n folder when creating the module. */
private transient boolean m_createI18NFolder;
/** Flag to create the lib folder when creating the module. */
private transient boolean m_createLibFolder;
/** Flag to create the module folder when creating the module. */
private transient boolean m_createModuleFolder;
/** Flag to create the resources folder when creating the module. */
private transient boolean m_createResourcesFolder;
/** Flag to create the schemas folder when creating the module. */
private transient boolean m_createSchemasFolder;
/** Flag to create the template folder when creating the module. */
private transient boolean m_createTemplateFolder;
/** The date this module was created by the author. */
private long m_dateCreated;
/** The date this module was installed. */
private long m_dateInstalled;
/** List of dependencies of this module. */
private List m_dependencies;
/** The description of this module. */
private String m_description;
/** List of VFS resources that do not belong to this module.
* In particular used for files / folders in folders that belong to the module.
*/
private List m_excluderesources;
/** The explorer type settings. */
private List m_explorerTypeSettings;
/** The export mode to use for the module. */
private ExportMode m_exportMode;
/** List of export points added by this module. */
private List m_exportPoints;
/** The export version (this is only used for module objects which have been read from a zip file). */
private String m_exportVersion;
/** Indicates if this modules configuration has already been frozen. */
private transient boolean m_frozen;
/** The group of the module. */
private String m_group;
/** True if the module has a fixed import site. */
private boolean m_hasImportSite;
/** The script to execute when the module is imported. */
private String m_importScript;
/** The name of this module, must be a valid Java package name. */
private String m_name;
/** The "nice" display name of this module. */
private String m_niceName;
/** A timestamp from the time this object was created. */
private long m_objectCreateTime = System.currentTimeMillis();
/** The additional configuration parameters of this module. */
private SortedMap m_parameters;
/** List of VFS resources that belong to this module. */
private List m_resources;
/** The list of additional resource types. */
private transient List m_resourceTypes;
/** The module site. */
private String m_site;
/** The name of the user who installed this module. */
private String m_userInstalled;
/** The version of this module. */
private CmsModuleVersion m_version;
/**
* Creates a new, empty CmsModule object.
*/
public CmsModule() {
m_version = new CmsModuleVersion(CmsModuleVersion.DEFAULT_VERSION);
m_resources = Collections.emptyList();
m_excluderesources = Collections.emptyList();
m_exportPoints = Collections.emptyList();
m_dependencies = Collections.emptyList();
m_resourceTypes = Collections.emptyList();
m_explorerTypeSettings = Collections.emptyList();
m_parameters = new TreeMap();
m_exportMode = ExportMode.DEFAULT;
}
/**
* Creates a new module description with the specified values.
*
* @param name the name of this module, must be a valid Java package name
* @param niceName the "nice" display name of this module
* @param group the group of this module
* @param actionClass the (optional) module class name
* @param importScript the script to execute when the module is imported
* @param site the site the module belongs to
* @param isImportSite true if the module site should be used as a fixed import site
* @param exportMode the export mode that should be used for the module
* @param description the description of this module
* @param version the version of this module
* @param authorName the name of the author of this module
* @param authorEmail the email of the author of this module
* @param dateCreated the date this module was created by the author
* @param userInstalled the name of the user who uploaded this module
* @param dateInstalled the date this module was uploaded
* @param dependencies a list of dependencies of this module
* @param exportPoints a list of export point added by this module
* @param resources a list of VFS resources that belong to this module
* @param excluderesources a list of VFS resources that are exclude from the module's resources
* @param parameters the parameters for this module
*/
public CmsModule(
String name,
String niceName,
String group,
String actionClass,
String importScript,
String site,
boolean isImportSite,
ExportMode exportMode,
String description,
CmsModuleVersion version,
String authorName,
String authorEmail,
long dateCreated,
String userInstalled,
long dateInstalled,
List dependencies,
List exportPoints,
List resources,
List excluderesources,
Map parameters) {
super();
m_name = name;
setNiceName(niceName);
setActionClass(actionClass);
setGroup(group);
m_exportMode = null == exportMode ? ExportMode.DEFAULT : exportMode;
if (CmsStringUtil.isEmpty(description)) {
m_description = "";
} else {
m_description = description;
}
m_version = version;
if (CmsStringUtil.isEmpty(authorName)) {
m_authorName = "";
} else {
m_authorName = authorName;
}
if (CmsStringUtil.isEmpty(authorEmail)) {
m_authorEmail = "";
} else {
m_authorEmail = authorEmail;
}
// remove milisecounds
m_dateCreated = (dateCreated / 1000L) * 1000L;
if (CmsStringUtil.isEmpty(userInstalled)) {
m_userInstalled = "";
} else {
m_userInstalled = userInstalled;
}
m_dateInstalled = (dateInstalled / 1000L) * 1000L;
if (dependencies == null) {
m_dependencies = Collections.emptyList();
} else {
m_dependencies = Collections.unmodifiableList(dependencies);
}
if (exportPoints == null) {
m_exportPoints = Collections.emptyList();
} else {
m_exportPoints = Collections.unmodifiableList(exportPoints);
}
if (resources == null) {
m_resources = Collections.emptyList();
} else {
m_resources = Collections.unmodifiableList(resources);
}
if (excluderesources == null) {
m_excluderesources = Collections.emptyList();
} else {
m_excluderesources = Collections.unmodifiableList(excluderesources);
}
if (parameters == null) {
m_parameters = new TreeMap();
} else {
m_parameters = new TreeMap(parameters);
}
m_site = site;
m_hasImportSite = isImportSite;
m_importScript = importScript;
initOldAdditionalResources();
if (LOG.isDebugEnabled()) {
LOG.debug(Messages.get().getBundle().key(Messages.LOG_MODULE_INSTANCE_CREATED_1, m_name));
}
m_resourceTypes = Collections.emptyList();
m_explorerTypeSettings = Collections.emptyList();
}
/** Determines the resources that are:
*
* - accessible with the provided {@link CmsObject},
* - part of the
moduleResources (or in a folder of these resources) and
* - not contained in
excludedResources (or a folder of these resources).
*
* and adds the to result
*
* @param result the resource list, that gets extended by the calculated resources.
* @param cms the {@link CmsObject} used to read resources.
* @param moduleResources the resources to include.
* @param excludeResources the site paths of the resources to exclude.
* @throws CmsException thrown if reading resources fails.
*/
public static void addCalculatedModuleResources(
List result,
final CmsObject cms,
final List moduleResources,
final List excludeResources)
throws CmsException {
for (CmsResource resource : moduleResources) {
String sitePath = cms.getSitePath(resource);
List excludedSubResources = getExcludedForResource(sitePath, excludeResources);
// check if resources have to be excluded
if (excludedSubResources.isEmpty()) {
// no resource has to be excluded - add the whole resource
// (that is, also all resources in the folder, if the resource is a folder)
result.add(resource);
} else {
// cannot add the complete resource (i.e., including the whole sub-tree)
if (CmsStringUtil.comparePaths(sitePath, excludedSubResources.get(0))) {
// the resource itself is excluded -> do not add it and check the next resource
continue;
}
// try to include sub-resources.
List subResources = cms.readResources(sitePath, CmsResourceFilter.ALL, false);
addCalculatedModuleResources(result, cms, subResources, excludedSubResources);
}
}
}
/** Calculates the resources belonging to the module, taking excluded resources and readability of resources into account,
* and returns site paths of the module resources.
* For more details of the returned resource, see {@link #calculateModuleResources(CmsObject, CmsModule)}.
*
* @param cms the {@link CmsObject} used to read the resources.
* @param module the module, for which the resources should be calculated
* @return the calculated module resources
* @throws CmsException thrown if reading resources fails.
*/
public static List calculateModuleResourceNames(final CmsObject cms, final CmsModule module)
throws CmsException {
// adjust the site root, if necessary
CmsObject cmsClone = adjustSiteRootIfNecessary(cms, module);
// calculate the module resources
List moduleResources = calculateModuleResources(cmsClone, module);
// get the site paths
List moduleResouceNames = new ArrayList(moduleResources.size());
for (CmsResource resource : moduleResources) {
moduleResouceNames.add(cmsClone.getSitePath(resource));
}
return moduleResouceNames;
}
/** Calculates and returns the resources belonging to the module, taking excluded resources and readability of resources into account.
* The list of returned resources contains:
*
* - Only resources that are readable (present at the system and accessible with the provided {@link CmsObject}
* - Only the resource for a folder, if all resources in the folder belong to the module.
* - Only resources that are specified as module resources and not excluded by the module's exclude resources.
*
*
* @param cms the {@link CmsObject} used to read the resources.
* @param module the module, for which the resources should be calculated
* @return the calculated module resources
* @throws CmsException thrown if reading resources fails.
*/
public static List calculateModuleResources(final CmsObject cms, final CmsModule module)
throws CmsException {
CmsObject cmsClone = adjustSiteRootIfNecessary(cms, module);
List result = null;
List excluded = CmsFileUtil.removeRedundancies(module.getExcludeResources());
excluded = removeNonAccessible(cmsClone, excluded);
List resourceSitePaths = CmsFileUtil.removeRedundancies(module.getResources());
resourceSitePaths = removeNonAccessible(cmsClone, resourceSitePaths);
List moduleResources = new ArrayList(resourceSitePaths.size());
for (String resourceSitePath : resourceSitePaths) {
// assumes resources are accessible - already checked aboveremoveNonAccessible
CmsResource resource = cmsClone.readResource(resourceSitePath, CmsResourceFilter.IGNORE_EXPIRATION);
moduleResources.add(resource);
}
if (excluded.isEmpty()) {
result = moduleResources;
} else {
result = new ArrayList();
addCalculatedModuleResources(result, cmsClone, moduleResources, excluded);
}
return result;
}
/** Adjusts the site root and returns a cloned CmsObject, iff the module has set an import site that differs
* from the site root of the CmsObject provided as argument. Otherwise returns the provided CmsObject unchanged.
* @param cms The original CmsObject.
* @param module The module where the import site is read from.
* @return The original CmsObject, or, if necessary, a clone with adjusted site root
* @throws CmsException see {@link OpenCms#initCmsObject(CmsObject)}
*/
private static CmsObject adjustSiteRootIfNecessary(final CmsObject cms, final CmsModule module)
throws CmsException {
CmsObject cmsClone;
if ((null == module.getSite()) || cms.getRequestContext().getSiteRoot().equals(module.getSite())) {
cmsClone = cms;
} else {
cmsClone = OpenCms.initCmsObject(cms);
cmsClone.getRequestContext().setSiteRoot(module.getSite());
}
return cmsClone;
}
/** Returns only the resource names starting with the provided sitePath.
*
* @param sitePath the site relative path, all paths should start with.
* @param excluded the paths to filter.
* @return the paths from excluded, that start with sitePath.
*/
private static List getExcludedForResource(final String sitePath, final List excluded) {
List result = new ArrayList();
for (String exclude : excluded) {
if (CmsStringUtil.isPrefixPath(sitePath, exclude)) {
result.add(exclude);
}
}
return result;
}
/** Removes the resources not accessible with the provided {@link CmsObject}.
*
* @param cms the {@link CmsObject} used to read the resources.
* @param sitePaths site relative paths of the resources that should be checked for accessibility.
* @return site paths of the accessible resources.
*/
private static List removeNonAccessible(CmsObject cms, List sitePaths) {
List result = new ArrayList(sitePaths.size());
for (String sitePath : sitePaths) {
if (cms.existsResource(sitePath, CmsResourceFilter.IGNORE_EXPIRATION)) {
result.add(sitePath);
}
}
return result;
}
/**
* Checks if this module depends on another given module,
* will return the dependency, or null if no dependency was found.
*
* @param module the other module to check against
* @return the dependency, or null if no dependency was found
*/
public CmsModuleDependency checkDependency(CmsModule module) {
CmsModuleDependency otherDepdendency = new CmsModuleDependency(module.getName(), module.getVersion());
// loop through all the dependencies
for (int i = 0; i < m_dependencies.size(); i++) {
CmsModuleDependency dependency = m_dependencies.get(i);
if (dependency.dependesOn(otherDepdendency)) {
// short circuit here
return dependency;
}
}
// no dependency was found
return null;
}
/**
* Checks if all resources of the module are present.
*
* @param cms an initialized OpenCms user context which must have read access to all module resources
*
* @throws CmsIllegalArgumentException in case not all module resources exist or can be read with the given OpenCms user context
*/
public void checkResources(CmsObject cms) throws CmsIllegalArgumentException {
CmsFileUtil.checkResources(cms, getResources());
}
/**
* Clones a CmsModule which is not set to frozen.
* This clones module can be used to be update the module information.
*
* @see java.lang.Object#clone()
*/
@Override
public CmsModule clone() {
// create a copy of the module
CmsModule result = new CmsModule(
m_name,
m_niceName,
m_group,
m_actionClass,
m_importScript,
m_site,
m_hasImportSite,
m_exportMode,
m_description,
m_version,
m_authorName,
m_authorEmail,
m_dateCreated,
m_userInstalled,
m_dateInstalled,
m_dependencies,
m_exportPoints,
m_resources,
m_excluderesources,
m_parameters);
// and set its frozen state to false
result.m_frozen = false;
if (getExplorerTypes() != null) {
List settings = new ArrayList();
for (CmsExplorerTypeSettings setting : getExplorerTypes()) {
settings.add((CmsExplorerTypeSettings)setting.clone());
}
result.setExplorerTypes(settings);
}
if (getResourceTypes() != null) {
// TODO: The resource types must be cloned also, otherwise modification will effect the origin also
result.setResourceTypes(new ArrayList(getResourceTypes()));
}
if (getDependencies() != null) {
List deps = new ArrayList();
for (CmsModuleDependency dep : getDependencies()) {
deps.add((CmsModuleDependency)dep.clone());
}
result.setDependencies(new ArrayList(getDependencies()));
}
if (getExportPoints() != null) {
List exps = new ArrayList();
for (CmsExportPoint exp : getExportPoints()) {
exps.add((CmsExportPoint)exp.clone());
}
result.setExportPoints(exps);
}
result.setAutoIncrement(m_autoIncrement);
result.setCheckpointTime(m_checkpointTime);
result.setCreateClassesFolder(m_createClassesFolder);
result.setCreateElementsFolder(m_createElementsFolder);
result.setCreateLibFolder(m_createLibFolder);
result.setCreateModuleFolder(m_createModuleFolder);
result.setCreateResourcesFolder(m_createResourcesFolder);
result.setCreateSchemasFolder(m_createSchemasFolder);
result.setCreateTemplateFolder(m_createTemplateFolder);
result.setCreateFormattersFolder(m_createFormattersFolder);
result.setResources(new ArrayList(m_resources));
result.setExcludeResources(new ArrayList(m_excluderesources));
return result;
}
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
public int compareTo(CmsModule obj) {
if (obj == this) {
return 0;
}
return m_name.compareTo(obj.m_name);
}
/**
* Two instances of a module are considered equal if their name is equal.
*
* @param obj the object to compare
*
* @return true if the objects are equal
*
* @see java.lang.Object#equals(java.lang.Object)
* @see #isIdentical(CmsModule)
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof CmsModule) {
return ((CmsModule)obj).m_name.equals(m_name);
}
return false;
}
/**
* Returns the class name of this modules (optional) action class.
*
* If this module does not use an action class,
* null is returned.
*
* @return the class name of this modules (optional) action class
*/
public String getActionClass() {
return m_actionClass;
}
/**
* Returns the module action instance of this module, or null
* if no module action instance is configured.
*
* @return the module action instance of this module
*/
public I_CmsModuleAction getActionInstance() {
return m_actionInstance;
}
/**
* Returns the email of the module author.
*
* @return the email of the module author
*/
public String getAuthorEmail() {
return m_authorEmail;
}
/**
* Returns the name of the author of this module.
*
* @return the name of the author of this module
*/
public String getAuthorName() {
return m_authorName;
}
/**
* Gets the module checkpoint time.
*
* This timestamp is used for auto-incrementing the version: if module resources have been modified in the VFS after this timestamp, increment
* the version.
*
* Note: This is not exported in the manifest. *
*
* @return the checkpoint timestamp
*/
public long getCheckpointTime() {
return m_checkpointTime;
}
/**
* Gets the module configuration path.
*
* @return the module configuration path
*/
public String getConfigurationPath() {
String parameter = getParameter("config.sitemap");
if (parameter != null) {
return parameter;
} else {
return "/system/modules/" + getName() + "/.config";
}
}
/**
* Returns the date this module was created by the author.
*
* @return the date this module was created by the author
*/
public long getDateCreated() {
return m_dateCreated;
}
/**
* Returns the date this module was uploaded.
*
* @return the date this module was uploaded
*/
public long getDateInstalled() {
return m_dateInstalled;
}
/**
* Returns the list of dependencies of this module.
*
* @return the list of dependencies of this module
*/
public List getDependencies() {
return m_dependencies;
}
/**
* Returns the description of this module.
*
* @return the description of this module
*/
public String getDescription() {
return m_description;
}
/**
* Returns the list of VFS resources that do not belong to this module.
* In particular, files / folders that would be included otherwise,
* considering the module resources.
*
* @return the list of VFS resources that do not belong to this module
*/
public List getExcludeResources() {
return m_excluderesources;
}
/**
* Returns the list of explorer resource types that belong to this module.
*
* @return the list of explorer resource types that belong to this module
*/
public List getExplorerTypes() {
return m_explorerTypeSettings;
}
/** Returns the export mode specified for the module.
* @return the module's export mode.
*/
public ExportMode getExportMode() {
return m_exportMode;
}
/**
* Returns the list of export point added by this module.
*
* @return the list of export point added by this module
*/
public List getExportPoints() {
return m_exportPoints;
}
/**
* Gets the export version.
*
* This is only used for module objects which have been read from a zip file.
*
* @return the export version
*/
public String getExportVersion() {
return m_exportVersion;
}
/**
* Returns the group name of this module.
*
* @return the group name of this module
*/
public String getGroup() {
return m_group;
}
/**
* Returns true if the module has an import site set.
*
* @return true if the module has an import site set
*/
public boolean getHasImportSite() {
return hasImportSite();
}
/**
* Returns the importScript.
*
* @return the importScript
*/
public String getImportScript() {
return m_importScript;
}
/**
* Gets the import site.
*
* If this is not empty, then it will be used as the site root for importing and exporting this module.
*
* @return the import site
*/
public String getImportSite() {
if (m_hasImportSite) {
return m_site;
} else {
return null;
}
}
/**
* Returns the name of this module.
*
* The module name must be a valid java package name.
*
* @return the name of this module
*/
public String getName() {
return m_name;
}
/**
* Returns the "nice" display name of this module.
*
* @return the "nice" display name of this module
*/
public String getNiceName() {
return m_niceName;
}
/**
* Gets the timestamp of this object's creation time.
*
* @return the object creation timestamp
*/
public long getObjectCreateTime() {
return m_objectCreateTime;
}
/**
* Returns a parameter value from the module parameters.
*
* @param key the parameter to return the value for
* @return the parameter value from the module parameters
*/
public String getParameter(String key) {
return m_parameters.get(key);
}
/**
* Returns a parameter value from the module parameters,
* or a given default value in case the parameter is not set.
*
* @param key the parameter to return the value for
* @param defaultValue the default value in case there is no value stored for this key
* @return the parameter value from the module parameters
*/
public String getParameter(String key, String defaultValue) {
String value = m_parameters.get(key);
return (value != null) ? value : defaultValue;
}
/**
* Returns the configured (immutable) module parameters.
*
* @return the configured (immutable) module parameters
*/
public SortedMap getParameters() {
return m_parameters;
}
/**
* Returns the list of VFS resources that belong to this module.
*
* @return the list of VFS resources that belong to this module
*/
public List getResources() {
return m_resources;
}
/**
* Returns the list of additional resource types that belong to this module.
*
* @return the list of additional resource types that belong to this module
*/
public List getResourceTypes() {
return m_resourceTypes;
}
/**
* Gets the module's site.
*
* @return the site of the module
*/
public String getSite() {
return m_site;
}
/**
* Returns the name of the user who uploaded this module.
*
* @return the name of the user who uploaded this module
*/
public String getUserInstalled() {
return m_userInstalled;
}
/**
* Returns the version of this module.
*
* @return the version of this module
*/
public CmsModuleVersion getVersion() {
return m_version;
}
/**
* Gets the version number as a string.
*
* @return the version number as a string
*/
public String getVersionStr() {
return m_version.toString();
}
/**
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return m_name.hashCode();
}
/**
* Returns true if the module has a fixed import site.
*
* @return true if the module has a fixed import site
*/
public boolean hasImportSite() {
return m_hasImportSite;
}
/**
* Determines if the module haas resources whose site is undefined.
*
* @return true if there are module resources with an undefined site
*/
public boolean hasModuleResourcesWithUndefinedSite() {
if (getSite() == null) {
for (String modRes : getResources()) {
if (!CmsStringUtil.isPrefixPath("/system/", modRes)
&& !OpenCms.getSiteManager().startsWithShared(modRes)) {
return true;
}
}
}
return false;
}
/**
* Check if all module resources are under /system or the shared folder.
*
* @return true if the module only has resources under system or the shared folder
*/
public boolean hasOnlySystemAndSharedResources() {
for (String modRes : getResources()) {
if (!CmsStringUtil.isPrefixPath("/system/", modRes) && !OpenCms.getSiteManager().startsWithShared(modRes)) {
return false;
}
}
return true;
}
/**
* Returns true if version auto-incrementation is enabled for this module.
*
* @return true if version auto-incrementation is enabled for this module
*/
public boolean isAutoIncrement() {
return m_autoIncrement;
}
/**
* Returns the createClassesFolder flag.
*
* @return the createClassesFolder flag
*/
public boolean isCreateClassesFolder() {
return m_createClassesFolder;
}
/**
* Returns the createElementsFolder flag.
*
* @return the createElementsFolder flag
*/
public boolean isCreateElementsFolder() {
return m_createElementsFolder;
}
/**
* Returns the createFormattersFolder flag.
*
* @return the createFormattersFolder flag
*/
public boolean isCreateFormattersFolder() {
return m_createFormattersFolder;
}
/**
* Returns the createI18NFolder flag.
*
* @return boolean
*/
public boolean isCreateI18NFolder() {
return m_createI18NFolder;
}
/**
* Returns the createLibFolder flag.
*
* @return the createLibFolder flag
*/
public boolean isCreateLibFolder() {
return m_createLibFolder;
}
/**
* Returns the createModuleFolder flag.
*
* @return the createModuleFolder flag
*/
public boolean isCreateModuleFolder() {
return m_createModuleFolder;
}
/**
* Returns the createResourcesFolder flag.
*
* @return the createResourcesFolder flag
*/
public boolean isCreateResourcesFolder() {
return m_createResourcesFolder;
}
/**
* Returns the createSchemasFolder flag.
*
* @return the createSchemasFolder flag
*/
public boolean isCreateSchemasFolder() {
return m_createSchemasFolder;
}
/**
* Returns the createTemplateFolder flag.
*
* @return the createTemplateFolder flag
*/
public boolean isCreateTemplateFolder() {
return m_createTemplateFolder;
}
/**
* Checks if this module is identical with another module.
*
* Modules A, B are identical if all values of A are equal to B.
* The values from {@link #getUserInstalled()} and {@link #getDateInstalled()}
* are ignored for this test.
*
* Modules A, B are equal if just the name of A is equal to the name of B.
*
* @param other the module to compare with
*
* @return if the modules are identical
*
* @see #equals(Object)
*/
public boolean isIdentical(CmsModule other) {
// some code redundancy here but this is easier to debug
if (!isEqual(m_name, other.m_name)) {
return false;
}
if (!isEqual(m_niceName, other.m_niceName)) {
return false;
}
if (!isEqual(m_version, other.m_version)) {
return false;
}
if (!isEqual(m_actionClass, other.m_actionClass)) {
return false;
}
if (!isEqual(m_description, other.m_description)) {
return false;
}
if (!isEqual(m_authorName, other.m_authorName)) {
return false;
}
if (!isEqual(m_authorEmail, other.m_authorEmail)) {
return false;
}
if (m_dateCreated != other.m_dateCreated) {
return false;
}
return true;
}
/** Checks, if the module should use the reduced export mode.
* @return if reduce export mode should be used true, otherwise false.
*/
public boolean isReducedExportMode() {
return ExportMode.REDUCED.equals(m_exportMode);
}
/**
* Sets the class name of this modules (optional) action class.
*
* Providing null as a value indicates that this module does not use an action class.
*
* Please note:It's not possible to set the action class name once the module
* configuration has been frozen.
*
* @param value the class name of this modules (optional) action class to set
*/
public void setActionClass(String value) {
checkFrozen();
if (CmsStringUtil.isEmpty(value)) {
m_actionClass = null;
} else {
if (!CmsStringUtil.isValidJavaClassName(value)) {
throw new CmsIllegalArgumentException(
Messages.get().container(Messages.ERR_MODULE_ACTION_CLASS_2, value, getName()));
}
m_actionClass = value;
}
}
/**
* Sets the author email of this module.
*
*
* Please note:It's not possible to set the modules author email once the module
* configuration has been frozen.
*
* @param value the module description to set
*/
public void setAuthorEmail(String value) {
checkFrozen();
m_authorEmail = value.trim();
}
/**
* Sets the author name of this module.
*
*
* Please note:It's not possible to set the modules author name once the module
* configuration has been frozen.
*
* @param value the module description to set
*/
public void setAuthorName(String value) {
checkFrozen();
m_authorName = value.trim();
}
/**
* Sets auto-increment mode.
*
* @param autoIncrement true if version auto-incrementation should be enabled
*/
public void setAutoIncrement(boolean autoIncrement) {
m_autoIncrement = autoIncrement;
}
/**
* Sets the module checkpoint time.
*
* @param checkpointTime the module checkpoint time
*/
public void setCheckpointTime(long checkpointTime) {
m_checkpointTime = checkpointTime;
}
/**
* Sets the createClassesFolder flag.
*
* @param createClassesFolder the createClassesFolder flag to set
*/
public void setCreateClassesFolder(boolean createClassesFolder) {
m_createClassesFolder = createClassesFolder;
}
/**
* Sets the createElementsFolder flag.
*
* @param createElementsFolder the createElementsFolder flag to set
*/
public void setCreateElementsFolder(boolean createElementsFolder) {
m_createElementsFolder = createElementsFolder;
}
/**
* Sets the createFormattersFolder flag.
*
* @param createFormattersFolder the createFormattersFolder flag to set
*/
public void setCreateFormattersFolder(boolean createFormattersFolder) {
m_createFormattersFolder = createFormattersFolder;
}
/**
* Sets the createI18NFolder flag.
*
* @param createI18NFolder boolean
*/
public void setCreateI18NFolder(boolean createI18NFolder) {
m_createI18NFolder = createI18NFolder;
}
/**
* Sets the createLibFolder flag.
*
* @param createLibFolder the createLibFolder flag to set
*/
public void setCreateLibFolder(boolean createLibFolder) {
m_createLibFolder = createLibFolder;
}
/**
* Sets the createModuleFolder flag.
*
* @param createModuleFolder the createModuleFolder flag to set
*/
public void setCreateModuleFolder(boolean createModuleFolder) {
m_createModuleFolder = createModuleFolder;
}
/**
* Sets the createResourcesFolder flag.
*
* @param createResourcesFolder the createResourcesFolder flag to set
*/
public void setCreateResourcesFolder(boolean createResourcesFolder) {
m_createResourcesFolder = createResourcesFolder;
}
/**
* Sets the createSchemasFolder flag .
*
* @param createSchemasFolder the createSchemasFolder flag to set
*/
public void setCreateSchemasFolder(boolean createSchemasFolder) {
m_createSchemasFolder = createSchemasFolder;
}
/**
* Sets the createTemplateFolder flag .
*
* @param createTemplateFolder the createTemplateFolder flag to set
*/
public void setCreateTemplateFolder(boolean createTemplateFolder) {
m_createTemplateFolder = createTemplateFolder;
}
/**
* Sets the date created of this module.
*
*
* Please note:It's not possible to set the module date created once the module
* configuration has been frozen.
*
* @param value the date created to set
*/
public void setDateCreated(long value) {
checkFrozen();
m_dateCreated = value;
}
/**
* Sets the installation date of this module.
*
*
* Please note:It's not possible to set the installation date once the module
* configuration has been frozen.
*
* @param value the installation date this module
*/
public void setDateInstalled(long value) {
checkFrozen();
m_dateInstalled = value;
}
/**
* Sets the list of module dependencies.
*
* @param dependencies list of module dependencies
*/
public void setDependencies(List dependencies) {
checkFrozen();
m_dependencies = dependencies;
}
/**
* Sets the description of this module.
*
*
* Please note:It's not possible to set the modules description once the module
* configuration has been frozen.
*
* @param value the module description to set
*/
public void setDescription(String value) {
checkFrozen();
m_description = value.trim();
}
/**
* Sets the resources excluded from this module.
*
*
* Please note:It's not possible to set the module resources once the module
* configuration has been frozen.
*
* @param value the resources to exclude from the module
*/
public void setExcludeResources(List value) {
checkFrozen();
m_excluderesources = value;
}
/**
* Sets the additional explorer types that belong to this module.
*
* @param explorerTypeSettings the explorer type settings.
*/
public void setExplorerTypes(List explorerTypeSettings) {
m_explorerTypeSettings = explorerTypeSettings;
}
/**
* Sets the export points of this module.
*
* @param exportPoints the export points of this module.
*/
public void setExportPoints(List exportPoints) {
m_exportPoints = exportPoints;
}
/**
* Sets the export version.
*
* @param exportVersion the export version
*/
public void setExportVersion(String exportVersion) {
m_exportVersion = exportVersion;
}
/**
* Sets the group name of this module.
*
*
* Please note:It's not possible to set the modules group name once the module
* configuration has been frozen.
*
* @param value the module group name to set
*/
public void setGroup(String value) {
checkFrozen();
m_group = value;
}
/**
* Sets the hasImportSite flag, which determines whether the module site should be used as a fixed import site.
*
* @param isImportSite true if the module site should be treated as a fixed import site
*/
public void setHasImportSite(boolean isImportSite) {
checkFrozen();
m_hasImportSite = isImportSite;
}
/**
* Sets the importScript.
*
* @param importScript the importScript to set
*/
public void setImportScript(String importScript) {
checkFrozen();
m_importScript = importScript;
}
/**
* Sets the import site.
*
* @param importSite the import site
*/
public void setImportSite(String importSite) {
checkFrozen();
if (importSite != null) {
importSite = importSite.trim();
}
m_site = importSite;
m_hasImportSite = true;
}
/**
* Sets the name of this module.
*
* The module name must be a valid java package name.
*
* Please note:It's not possible to set the modules name once the module
* configuration has been frozen.
*
* @param value the module name to set
*/
public void setName(String value) {
checkFrozen();
if (!CmsStringUtil.isValidJavaClassName(value)) {
throw new CmsIllegalArgumentException(Messages.get().container(Messages.ERR_MODULE_NAME_1, value));
}
m_name = value;
}
/**
* Sets the "nice" display name of this module.
*
* Please note:It's not possible to set the modules "nice" name once the module
* configuration has been frozen.
*
* @param value the "nice" display name of this module to set
*/
public void setNiceName(String value) {
checkFrozen();
if (CmsStringUtil.isEmptyOrWhitespaceOnly(value)) {
m_niceName = getName();
} else {
m_niceName = value.trim();
}
}
/**
* Sets the parameters of this module.
*
*
* Please note:It's not possible to set the module parameters once the module
* configuration has been frozen.
*
* @param parameters the module parameters to set
*/
public void setParameters(SortedMap parameters) {
checkFrozen();
m_parameters = parameters;
}
/** Set/unset the reduced export mode.
* @param reducedExportMode if true, the export mode is set to {@link ExportMode#REDUCED}, otherwise to {@link ExportMode#DEFAULT}.
*/
public void setReducedExportMode(boolean reducedExportMode) {
m_exportMode = reducedExportMode ? ExportMode.REDUCED : ExportMode.DEFAULT;
}
/**
* Sets the resources of this module.
*
*
* Please note:It's not possible to set the module resources once the module
* configuration has been frozen.
*
* @param value the module resources to set
*/
public void setResources(List value) {
checkFrozen();
m_resources = value;
}
/**
* Sets the list of additional resource types that belong to this module.
*
* @param resourceTypes list of additional resource types that belong to this module
*/
public void setResourceTypes(List resourceTypes) {
m_resourceTypes = Collections.unmodifiableList(resourceTypes);
}
/**
* Sets the module site.
*
* @param siteRoot the module site root
*/
public void setSite(String siteRoot) {
if (siteRoot == null) {
m_hasImportSite = false;
}
m_site = siteRoot;
}
/**
* Sets the user who installed of this module.
*
*
* Please note:It's not possible to set the user installed once the module
* configuration has been frozen.
*
* @param value the user who installed this module
*/
public void setUserInstalled(String value) {
checkFrozen();
m_userInstalled = value.trim();
}
/**
* Sets the version number as a string.
*
* @param versionString the version number string
*/
public void setVersionStr(String versionString) {
checkFrozen();
m_version = new CmsModuleVersion(versionString);
}
/**
* Determines if the version should be incremented based on the module resources' modification dates.
*
* @param cms the CMS context
* @return true if the version number should be incremented
*
* @throws CmsException if something goes wrong
*/
public boolean shouldIncrementVersionBasedOnResources(CmsObject cms) throws CmsException {
if (m_checkpointTime == 0) {
return true;
}
// adjust the site root, if necessary
CmsObject cmsClone = adjustSiteRootIfNecessary(cms, this);
// calculate the module resources
List moduleResources = calculateModuleResources(cmsClone, this);
for (CmsResource resource : moduleResources) {
try {
List resourcesToCheck = Lists.newArrayList();
resourcesToCheck.add(resource);
if (resource.isFolder()) {
resourcesToCheck.addAll(cms.readResources(resource, CmsResourceFilter.IGNORE_EXPIRATION, true));
}
for (CmsResource resourceToCheck : resourcesToCheck) {
if (resourceToCheck.getDateLastModified() > m_checkpointTime) {
return true;
}
}
} catch (CmsException e) {
LOG.warn(e.getLocalizedMessage(), e);
continue;
}
}
return false;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
if (m_name != null) {
return "[CmsModule: " + m_name + "]";
}
return super.toString();
}
/**
* Checks if this modules configuration is frozen.
*
* @throws CmsIllegalArgumentException in case the configuration is already frozen
*/
protected void checkFrozen() throws CmsIllegalArgumentException {
if (m_frozen) {
throw new CmsIllegalArgumentException(Messages.get().container(Messages.ERR_MODULE_FROZEN_1, getName()));
}
}
/**
* Initializes this module, also freezing the module configuration.
*
* @param cms an initialized OpenCms user context
*
* @throws CmsRoleViolationException if the given users does not have the {@link CmsRole#DATABASE_MANAGER} role
*/
protected void initialize(CmsObject cms) throws CmsRoleViolationException {
checkFrozen();
// check if the user has the required permissions
OpenCms.getRoleManager().checkRole(cms, CmsRole.DATABASE_MANAGER);
m_frozen = true;
m_resources = Collections.unmodifiableList(m_resources);
m_excluderesources = Collections.unmodifiableList(m_excluderesources);
}
/**
* Sets the module action instance for this module.
*
* @param actionInstance the module action instance for this module
*/
/*package*/void setActionInstance(I_CmsModuleAction actionInstance) {
m_actionInstance = actionInstance;
}
/**
* Resolves the module property "additionalresources" to the resource list and
* vice versa.
*
* This "special" module property is required as long as we do not have a new
* GUI for editing of module resource entries. Once we have the new GUI, the
* handling of "additionalresources" will be moved to the import of the module
* and done only if the imported module is a 5.0 module.
*/
private void initOldAdditionalResources() {
SortedMap parameters = new TreeMap(m_parameters);
List resources = new ArrayList(m_resources);
String additionalResources;
additionalResources = parameters.get(MODULE_PROPERTY_ADDITIONAL_RESOURCES);
if (additionalResources != null) {
StringTokenizer tok = new StringTokenizer(
additionalResources,
MODULE_PROPERTY_ADDITIONAL_RESOURCES_SEPARATOR);
while (tok.hasMoreTokens()) {
String resource = tok.nextToken().trim();
if ((!"-".equals(resource)) && (!resources.contains(resource))) {
resources.add(resource);
}
}
}
m_resources = resources;
}
/**
* Checks if two objects are either both null, or equal.
*
* @param a the first object to check
* @param b the second object to check
* @return true if the two object are either both null, or equal
*/
private boolean isEqual(Object a, Object b) {
if (a == null) {
return (b == null);
}
if (b == null) {
return false;
}
return a.equals(b);
}
}