org.opencms.importexport.CmsImportVersion10 Maven / Gradle / Ivy
Show all versions of opencms-test 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.importexport;
import org.opencms.configuration.CmsConfigurationManager;
import org.opencms.configuration.CmsParameterConfiguration;
import org.opencms.db.CmsDbEntryNotFoundException;
import org.opencms.db.log.CmsLogEntry;
import org.opencms.file.CmsDataAccessException;
import org.opencms.file.CmsFile;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProject;
import org.opencms.file.CmsProperty;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.CmsUser;
import org.opencms.file.CmsVfsResourceNotFoundException;
import org.opencms.file.types.CmsResourceTypePlain;
import org.opencms.file.types.CmsResourceTypeXmlContainerPage;
import org.opencms.file.types.I_CmsResourceType;
import org.opencms.i18n.CmsMessageContainer;
import org.opencms.importexport.CmsImportExportManager.TimestampMode;
import org.opencms.loader.CmsLoaderException;
import org.opencms.lock.CmsLock;
import org.opencms.main.CmsException;
import org.opencms.main.CmsIllegalStateException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.relations.CmsRelation;
import org.opencms.relations.CmsRelationType;
import org.opencms.relations.I_CmsLinkParseable;
import org.opencms.report.I_CmsReport;
import org.opencms.security.CmsAccessControlEntry;
import org.opencms.security.CmsOrganizationalUnit;
import org.opencms.security.CmsRole;
import org.opencms.security.I_CmsPasswordHandler;
import org.opencms.security.I_CmsPrincipal;
import org.opencms.util.CmsCollectionsGenericWrapper;
import org.opencms.util.CmsDataTypeUtil;
import org.opencms.util.CmsDateUtil;
import org.opencms.util.CmsMacroResolver;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsUUID;
import org.opencms.xml.CmsXmlEntityResolver;
import org.opencms.xml.CmsXmlErrorHandler;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.zip.ZipFile;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.digester.Digester;
import org.apache.commons.logging.Log;
import org.dom4j.Document;
import org.xml.sax.SAXException;
import com.google.common.collect.ComparisonChain;
/**
* Adds the XML handler rules for import and export of resources and accounts.
*
* @since 7.0.4
*/
public class CmsImportVersion10 implements I_CmsImport {
/** Tag for the "userinfo / entry name" attribute, contains the additional user info entry name. */
public static final String A_NAME = "name";
/** Tag for the "type" attribute, contains the property type. */
public static final String A_TYPE = "type";
/** The name of the DTD for this import version. */
public static final String DTD_FILENAME = "opencms-import10.dtd";
/** The location of the OpenCms configuration DTD if the default prefix is the system ID. */
public static final String DTD_LOCATION = "org/opencms/importexport/";
/** The version number of this import implementation.
*/
public static final int IMPORT_VERSION10 = 10;
/** Tag for the "allowed" node, to identify allowed user permissions. */
public static final String N_ACCESSCONTROL_ALLOWEDPERMISSIONS = "allowed";
/** Tag for the "denied" node, to identify denied user permissions. */
public static final String N_ACCESSCONTROL_DENIEDPERMISSIONS = "denied";
/** Tag for the "accesscontrol" node, to identify access control entries. */
public static final String N_ACCESSCONTROL_ENTRIES = "accesscontrol";
/** Tag for the "accessentry" node, to identify a single access control entry. */
public static final String N_ACCESSCONTROL_ENTRY = "accessentry";
/** Tag for the "permissionset" node, to identify a permission set. */
public static final String N_ACCESSCONTROL_PERMISSIONSET = "permissionset";
/** Tag for the "uuidprincipal" node, to identify a principal UUID. */
public static final String N_ACCESSCONTROL_PRINCIPAL = "uuidprincipal";
/** Tag for the "accounts" node. */
public static final String N_ACCOUNTS = "accounts";
/** Tag for the "datecreated" node, contains the date created VFS file attribute. */
public static final String N_DATECREATED = "datecreated";
/** Tag for the "dateexpired" node, contains the expiration date VFS file attribute. */
public static final String N_DATEEXPIRED = "dateexpired";
/** Tag for the "datelastmodified" node, contains the date last modified VFS file attribute. */
public static final String N_DATELASTMODIFIED = "datelastmodified";
/** Tag for the "datereleased" node, contains the release date VFS file attribute. */
public static final String N_DATERELEASED = "datereleased";
/** Tag for the "description" node, contains a users description test. */
public static final String N_DESCRIPTION = "description";
/** Tag for the "destination" node, contains target VFS file name. */
public static final String N_DESTINATION = "destination";
/** Tag for the "email" node, contains a users email. */
public static final String N_EMAIL = "email";
/** Tag for the "file" node, container node for all VFS resources. */
public static final String N_FILE = "file";
/** Tag for the "files" node, container node for all VFS resources. */
public static final String N_FILES = "files";
/** Tag for the "firstname" node, contains a users first name. */
public static final String N_FIRSTNAME = "firstname";
/** Tag for the "flags" node, contains the flags of a VFS resource. */
public static final String N_FLAGS = "flags";
/** Tag for the "group" node, contains a group name. */
public static final String N_GROUP = "group";
/** Tag for the "groups" node, contains a users group data. */
public static final String N_GROUPS = "groups";
/** Tag for the "id" relation attribute, contains the structure id of the target resource of the relation. */
public static final String N_ID = "id";
/** Tag for the "lastname" node, contains a users last name. */
public static final String N_LASTNAME = "lastname";
/** Tag for the "managersgroup" node, contains name of the managers group of the project. */
public static final String N_MANAGERSGROUP = "managersgroup";
/** Tag for the "name" node, contains the name of a property. */
public static final String N_NAME = "name";
/** Tag for the "orgunit" node, starts the organizational unit data. */
public static final String N_ORGUNIT = "orgunit";
/** Tag for the "orgunits" node, starts the organizational unit data. */
public static final String N_ORGUNITS = "orgunits";
/** Tag for the "parentgroup" node, contains a groups parent group fqn. */
public static final String N_PARENTGROUP = "parentgroup";
/** Tag for the "password" node, contains a users encrypted password. */
public static final String N_PASSWORD = "password";
/** Tag for the "path" relation attribute, contains the path to the target resource of the relation. */
public static final String N_PATH = "path";
/** Tag for the "project" node, starts the project data. */
public static final String N_PROJECT = "project";
/** Tag for the "projects" node, starts the project data. */
public static final String N_PROJECTS = "projects";
/** Tag for the "properties" node, starts the list of properties of a VFS resource. */
public static final String N_PROPERTIES = "properties";
/** Tag for the "property" node, starts a property for a VFS resource. */
public static final String N_PROPERTY = "property";
/** Tag in the {@link CmsImportExportManager#EXPORT_MANIFEST} for the "relation" node, starts a relation for a VFS resource. */
public static final String N_RELATION = "relation";
/** Tag for the "relations" node, starts the list of relations of a VFS resources. */
public static final String N_RELATIONS = "relations";
/** Tag for the "resource" node, contains the a organizational unit resource name. */
public static final String N_RESOURCE = "resource";
/** Tag for the "resources" node, contains the list of organizational unit resources. */
public static final String N_RESOURCES = "resources";
/** Tag for the "source" node, contains the source path of a VFS resource in the import zip (or folder). */
public static final String N_SOURCE = "source";
/** Tag for the "type" node, the resource type name of a VFS resource. */
public static final String N_TYPE = "type";
/** Tag for the "user" node, starts the user data. */
public static final String N_USER = "user";
/** Tag for the "usercreated" node, contains the name of the user who created the VFS resource. */
public static final String N_USERCREATED = "usercreated";
/** Tag for the "usergroup" node, the name of a users group. */
public static final String N_USERGROUP = "usergroup";
/** Tag for the "usergroups" node, starts the users group data. */
public static final String N_USERGROUPS = "usergroups";
/** Tag for the "userinfo" node, contains the additional user info. */
public static final String N_USERINFO = "userinfo";
/** Tag for the "userinfo/entry" node, contains the additional user info entry value. */
public static final String N_USERINFO_ENTRY = "entry";
/** Tag for the "userlastmodified" node, contains the name of the user who last modified the VFS resource. */
public static final String N_USERLASTMODIFIED = "userlastmodified";
/** Tag for the "userrole" node, contains an users role name. */
public static final String N_USERROLE = "userrole";
/** Tag for the "userroles" node, starts the users role data. */
public static final String N_USERROLES = "userroles";
/** Tag for the "users" node, starts the list of users. */
public static final String N_USERS = "users";
/** Tag for the "usersgroup" node, contains name of the users group of the project. */
public static final String N_USERSGROUP = "usersgroup";
/** Tag for the "uuidresource" node, contains a the resource UUID of a VFS resource. */
public static final String N_UUIDRESOURCE = "uuidresource";
/** Tag for the "uuidstructure" node, only required for backward compatibility with import version 2. */
public static final String N_UUIDSTRUCTURE = "uuidstructure";
/** Tag for the "value" node, contains the value of a property. */
public static final String N_VALUE = "value";
/** Value for the "shared" property type attribute value. */
public static final String PROPERTY_ATTRIB_TYPE_SHARED = "shared";
/** Constant for an unspecified last modification date. */
private static final long DATE_LAST_MODIFICATION_UNSPECIFIED = -2;
/** Constant for using file time as last modification date on file import. */
private static final long DATE_LAST_MODIFICATION_FILETIME = -1;
/** Constant for the unspecified creation date. */
private static final long DATE_CREATED_UNSPECIFIED = -1;
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsImportVersion10.class);
/** The ACE flags value. */
private int m_aceFlags;
/** The ACE allowed permissions value. */
private int m_acePermissionsAllowed;
/** The ACE denied permissions value. */
private int m_acePermissionsDenied;
/** The ACE principal id value. */
private CmsUUID m_acePrincipalId;
/** The list of ACEs for the current imported resource. */
private List m_aces;
/** The cms object. */
private CmsObject m_cms;
/** The set of resource ids of files which actually are contained in the zip file. */
private Set m_contentFiles = new HashSet();
/** The date created value. */
private long m_dateCreated = DATE_CREATED_UNSPECIFIED;
/** The date expired value. */
private long m_dateExpired = CmsResource.DATE_EXPIRED_DEFAULT;
/** The date last modified value. */
private long m_dateLastModified = DATE_LAST_MODIFICATION_UNSPECIFIED;
/** The date released value. */
private long m_dateReleased = CmsResource.DATE_RELEASED_DEFAULT;
/** The destination value. */
private String m_destination;
/** The current file counter. */
private int m_fileCounter;
/** The flags value. */
private int m_flags;
/** The description of the current group to import. */
private String m_groupDescription;
/** The flags of the current group to import. */
private int m_groupFlags;
/** The name of the current group to import. */
private String m_groupName;
/** The parent of the current group to import. */
private String m_groupParent;
/** Map of all parent groups that could not be set immediately, because of the import order. */
private Map> m_groupParents;
/** The import helper. */
private CmsImportHelper m_helper;
/** List of ignored properties. */
private List m_ignoredProperties;
/** List of immutable resources. */
private List m_immutables;
/** The flag to import ACEs. */
private boolean m_importACEs;
/** The membership structure. */
private Map>> m_membership;
/** The current imported organizational unit. */
private CmsOrganizationalUnit m_orgUnit;
/** The organizational unit description. */
private String m_orgUnitDescription;
/** The organizational unit flags. */
private int m_orgUnitFlags;
/** The organizational unit fqn. */
private String m_orgUnitName;
/** The map of organizational unit resources, this is a global field that will be use at the end of the import. */
private Map> m_orgUnitResources;
/** The import parameters to use. */
private CmsImportParameters m_parameters;
/** The list of resource to be parsed, this is a global list, which will be handled at the end of the import. */
private List m_parseables;
/** The project description. */
private String m_projectDescription;
/** The project managers group name. */
private String m_projectManagers;
/** The project fqn. */
private String m_projectName;
/** The current read project resources. */
private List m_projectResources;
/** The project users group name. */
private String m_projectUsers;
/** The map of properties for current imported resource. */
private Map m_properties;
/** The property name value. */
private String m_propertyName;
/** The property value value. */
private String m_propertyValue;
/** The relation id value. */
private CmsUUID m_relationId;
/** The relation path value. */
private String m_relationPath;
/** The map of relations to be created, this is a global map, which will be handled at the end of the import. */
private Map> m_relations;
/** The relation type value. */
private CmsRelationType m_relationType;
/** The report. */
private I_CmsReport m_report;
/** The current imported resource. */
private CmsResource m_resource;
/** The resource id value. */
private CmsUUID m_resourceId;
/** The source value. */
private String m_source;
/** The structure id value. */
private CmsUUID m_structureId;
/** Possible exception during xml parsing. */
private Throwable m_throwable;
/** The total number of files to import. */
private int m_totalFiles;
/** The type value. */
private I_CmsResourceType m_type;
/** The current imported user. */
private CmsUser m_user;
/** The user created value. */
private CmsUUID m_userCreated = CmsUUID.getNullUUID();
/** The current user date created. */
private long m_userDateCreated;
/** The current user email. */
private String m_userEmail;
/** The current user first name. */
private String m_userFirstname;
/** The current user flags. */
private int m_userFlags;
/** The additional information for the current imported user. */
private Map m_userInfos;
/** The user last modified value. */
private CmsUUID m_userLastModified;
/** The current user last name. */
private String m_userLastname;
/** The current user name. */
private String m_userName;
/** The current user password. */
private String m_userPassword;
/** The export version. */
private int m_version;
/**
* Public constructor.
*/
public CmsImportVersion10() {
// empty
}
/**
* Adds an ACE from the current xml data.
*
* @see #addResourceAceRules(Digester, String)
*/
public void addAccessControlEntry() {
try {
if ((m_resource == null) || !m_importACEs) {
// skip ace import if not intended or the import of the resource failed
return;
}
if (m_throwable != null) {
// user or group of ACE might not exist in target system, ignore ACE
if (LOG.isWarnEnabled()) {
LOG.warn(
Messages.get().getBundle().key(
Messages.LOG_IMPORTEXPORT_ERROR_IMPORTING_ACE_1,
getCms().getRequestContext().removeSiteRoot(m_resource.getRootPath())),
m_throwable);
}
getReport().println(m_throwable);
getReport().addError(m_throwable);
m_throwable = null;
return;
}
if (m_aces == null) {
// this list will be used and clean up in the importResource and importAccessControlEntries methods
m_aces = new ArrayList();
}
m_aces.add(
new CmsAccessControlEntry(
m_resource.getResourceId(),
m_acePrincipalId,
m_acePermissionsAllowed,
m_acePermissionsDenied,
m_aceFlags));
} finally {
m_acePrincipalId = null;
m_acePermissionsAllowed = 0;
m_acePermissionsDenied = 0;
m_aceFlags = 0;
}
}
/**
* Registers a file whose contents are contained in the zip file.
*
* @param source the path in the zip file
*
* @param resourceId the resource id
*/
public void addContentFile(String source, String resourceId) {
if ((source != null) && (resourceId != null)) {
try {
m_helper.getFileBytes(source);
m_contentFiles.add(new CmsUUID(resourceId));
} catch (@SuppressWarnings("unused") CmsImportExportException e) {
LOG.info("File not found in import: " + source);
}
}
}
/**
* Adds a new resource to be associated to the current organizational unit.
*
* @param resourceName the resource name to add
*/
public void addOrgUnitResource(String resourceName) {
if ((m_throwable != null) || (m_orgUnitName == null)) {
return;
}
if (m_orgUnitResources == null) {
m_orgUnitResources = new HashMap>();
}
List resources = m_orgUnitResources.get(m_orgUnitName);
if (resources == null) {
resources = new ArrayList();
m_orgUnitResources.put(m_orgUnitName, resources);
}
resources.add(resourceName);
}
/**
* Adds a new resource to be associated to the current project.
*
* @param resourceName the resource name to add
*/
public void addProjectResource(String resourceName) {
if ((m_throwable != null) || (m_projectName == null)) {
return;
}
if (m_projectResources == null) {
m_projectResources = new ArrayList();
}
m_projectResources.add(resourceName);
}
/**
* Adds a property from the current xml data, in case the type is implicit given.
*
* @see #addResourcePropertyRules(Digester, String)
*/
public void addProperty() {
addProperty("individual");
}
/**
* Adds a property from the current xml data, in case the type is explicit given.
*
* @param propertyType the type of the property to be added
*
* @see #addResourcePropertyRules(Digester, String)
*/
public void addProperty(String propertyType) {
if (m_properties == null) {
// this list will be used and clean up in the importResource method
m_properties = new HashMap();
}
try {
if ((m_propertyName == null) || getIgnoredProperties().contains(m_propertyName)) {
// continue if the current property (name) should be ignored or is null
return;
}
CmsProperty property = m_properties.get(m_propertyName);
if (property == null) {
property = new CmsProperty();
property.setName(m_propertyName);
property.setAutoCreatePropertyDefinition(true);
m_properties.put(m_propertyName, property);
}
if (m_propertyValue == null) {
m_propertyValue = "";
}
if ((propertyType != null) && propertyType.equals(PROPERTY_ATTRIB_TYPE_SHARED)) {
// it is a shared/resource property value
property.setResourceValue(m_propertyValue);
} else {
// it is an individual/structure value
property.setStructureValue(m_propertyValue);
}
} finally {
m_propertyName = null;
m_propertyValue = null;
}
}
/**
* Adds a relation to be imported from the current xml data.
*
* @see #addResourceRelationRules(Digester, String)
*/
public void addRelation() {
if (m_relations == null) {
m_relations = new HashMap>();
}
try {
if (m_resource == null) {
// skip relation import if the import of the resource failed
return;
}
if (m_throwable != null) {
// relation data is corrupt, ignore relation
if (LOG.isWarnEnabled()) {
LOG.warn(
Messages.get().getBundle().key(
Messages.LOG_IMPORTEXPORT_ERROR_IMPORTING_RELATION_1,
getCms().getRequestContext().removeSiteRoot(m_resource.getRootPath())),
m_throwable);
}
getReport().println(m_throwable);
getReport().addError(m_throwable);
m_throwable = null;
return;
}
List currentRelations = m_relations.get(m_resource.getRootPath());
if (currentRelations == null) {
currentRelations = new ArrayList();
m_relations.put(m_resource.getRootPath(), currentRelations);
}
currentRelations.add(
new CmsRelation(
m_resource.getStructureId(),
m_resource.getRootPath(),
m_relationId,
m_relationPath,
m_relationType));
} finally {
m_relationId = null;
m_relationPath = null;
m_relationType = null;
}
}
/**
* Adds the XML digester rules for a single import file.
*
* @param digester the digester to add the rules to
*/
public void addXmlDigesterRules(Digester digester) {
// first accounts
String xpath = CmsImportExportManager.N_EXPORT + "/" + N_ACCOUNTS + "/" + N_ORGUNITS + "/" + N_ORGUNIT + "/";
addAccountsOrgunitRules(digester, xpath);
addAccountsGroupRules(digester, xpath);
addAccountsUserRules(digester, xpath);
digester.addCallMethod(
CmsImportExportManager.N_EXPORT + "/" + N_ACCOUNTS + "/" + N_ORGUNITS + "/" + N_ORGUNIT,
"setMembership");
// then resources
xpath = CmsImportExportManager.N_EXPORT + "/" + N_FILES + "/" + N_FILE + "/";
addResourceAttributesRules(digester, xpath);
addResourcePropertyRules(digester, xpath);
addResourceRelationRules(digester, xpath);
addResourceAceRules(digester, xpath);
digester.addCallMethod(CmsImportExportManager.N_EXPORT + "/" + N_FILES + "/" + N_FILE, "increaseCounter");
digester.addCallMethod(CmsImportExportManager.N_EXPORT + "/" + N_FILES, "importRelations");
digester.addCallMethod(CmsImportExportManager.N_EXPORT + "/" + N_FILES, "rewriteParseables");
// and now the organizational unit resources
digester.addCallMethod(CmsImportExportManager.N_EXPORT + "/" + N_FILES, "associateOrgUnitResources");
// then projects
xpath = CmsImportExportManager.N_EXPORT + "/" + N_PROJECTS + "/" + N_PROJECT + "/";
addProjectRules(digester, xpath);
}
/**
* Adds the XML digester rules for pre-processing a single import file.
*
* @param digester the digester to add the rules to
*/
public void addXmlPreprocessingDigesterRules(Digester digester) {
digester.addCallMethod(CmsImportExportManager.N_EXPORT + "/" + N_FILES + "/" + N_FILE, "increaseTotalFiles");
digester.addCallMethod(
CmsImportExportManager.N_EXPORT
+ "/"
+ CmsImportExportManager.N_INFO
+ "/"
+ CmsImportExportManager.N_VERSION,
"setVersion",
0);
}
/**
* Associates the stored resources to the created organizational units.
*
* This is a global process that occurs only once at the end of the import,
* after all resources have been imported, to make sure that the resources
* of the organizational units are available.
*
* @see #addAccountsOrgunitRules(Digester, String)
* @see #addXmlDigesterRules(Digester)
*/
public void associateOrgUnitResources() {
if ((m_orgUnitResources == null) || m_orgUnitResources.isEmpty()) {
// no organizational resources to associate
return;
}
String site = getCms().getRequestContext().getSiteRoot();
try {
getCms().getRequestContext().setSiteRoot("");
List orgUnits = new ArrayList(m_orgUnitResources.keySet());
Collections.sort(orgUnits);
Iterator it = orgUnits.iterator();
while (it.hasNext()) {
String orgUnitName = it.next();
List resources = m_orgUnitResources.get(orgUnitName);
if (orgUnitName.equals("")) {
continue;
}
Iterator itResources = resources.iterator();
while (itResources.hasNext()) {
String resourceName = itResources.next();
try {
// Add the resource to the organizational unit
OpenCms.getOrgUnitManager().addResourceToOrgUnit(getCms(), orgUnitName, resourceName);
} catch (CmsException e) {
getReport().addWarning(e);
if (LOG.isWarnEnabled()) {
LOG.warn(e.getLocalizedMessage());
}
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
// remove the meanwhile used first resource of the parent organizational unit
try {
String resName = (OpenCms.getOrgUnitManager().getResourcesForOrganizationalUnit(
getCms(),
CmsOrganizationalUnit.getParentFqn(orgUnitName)).get(0)).getRootPath();
if (!resources.contains(resName)) {
OpenCms.getOrgUnitManager().removeResourceFromOrgUnit(getCms(), orgUnitName, resName);
}
} catch (CmsException e) {
getReport().addWarning(e);
if (LOG.isWarnEnabled()) {
LOG.warn(e.getLocalizedMessage());
}
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
} finally {
getCms().getRequestContext().setSiteRoot(site);
}
m_orgUnitResources = null;
}
/**
* Returns the ace Flags.
*
* @return the ace Flags
*
* @see #N_FLAGS
* @see #addResourceAceRules(Digester, String)
*/
public int getAceFlags() {
return m_aceFlags;
}
/**
* Returns the ace Permissions Allowed.
*
* @return the ace Permissions Allowed
*
* @see #N_ACCESSCONTROL_ALLOWEDPERMISSIONS
* @see #addResourceAceRules(Digester, String)
*/
public int getAcePermissionsAllowed() {
return m_acePermissionsAllowed;
}
/**
* Returns the acePermissionsDenied.
*
* @return the acePermissionsDenied
*
* @see #N_ACCESSCONTROL_DENIEDPERMISSIONS
* @see #addResourceAceRules(Digester, String)
*/
public int getAcePermissionsDenied() {
return m_acePermissionsDenied;
}
/**
* Returns the acePrincipalId.
*
* @return the acePrincipalId
*
* @see #N_ACCESSCONTROL_PRINCIPAL
* @see #addResourceAceRules(Digester, String)
*/
public CmsUUID getAcePrincipalId() {
return m_acePrincipalId;
}
/**
* Returns the cms object.
*
* @return the cms object
*/
public CmsObject getCms() {
return m_cms;
}
/**
* Returns the dateCreated.
*
* @return the dateCreated
*
* @see #N_DATECREATED
* @see #addResourceAttributesRules(Digester, String)
*/
public long getDateCreated() {
return m_dateCreated;
}
/**
* Returns the dateExpired.
*
* @return the dateExpired
*
* @see #N_DATEEXPIRED
* @see #addResourceAttributesRules(Digester, String)
*/
public long getDateExpired() {
return m_dateExpired;
}
/**
* Returns the dateLastModified.
*
* @return the dateLastModified
*
* @see #N_DATELASTMODIFIED
* @see #addResourceAttributesRules(Digester, String)
*/
public long getDateLastModified() {
return m_dateLastModified;
}
/**
* Returns the dateReleased.
*
* @return the dateReleased
*
* @see #N_DATERELEASED
* @see #addResourceAttributesRules(Digester, String)
*/
public long getDateReleased() {
return m_dateReleased;
}
/**
* Returns the destination.
*
* @return the destination
*
* @see #N_DESTINATION
* @see #addResourceAttributesRules(Digester, String)
*/
public String getDestination() {
return m_destination;
}
/**
* Returns the flags.
*
* @return the flags
*
* @see #N_FLAGS
* @see #addResourceAttributesRules(Digester, String)
*/
public int getFlags() {
return m_flags;
}
/**
* Returns the group Description.
*
* @return the group Description
*/
public String getGroupDescription() {
return m_groupDescription;
}
/**
* Returns the group Flags.
*
* @return the group Flags
*/
public int getGroupFlags() {
return m_groupFlags;
}
/**
* Returns the group Name.
*
* @return the group Name
*/
public String getGroupName() {
return m_groupName;
}
/**
* Returns the group Parent.
*
* @return the group Parent
*/
public String getGroupParent() {
return m_groupParent;
}
/**
* Returns the organizational unit description.
*
* @return the organizational unit description
*/
public String getOrgUnitDescription() {
return m_orgUnitDescription;
}
/**
* Returns the organizational unit flags.
*
* @return the organizational unit flags
*/
public int getOrgUnitFlags() {
return m_orgUnitFlags;
}
/**
* Returns the organizational unit name.
*
* @return the organizational unit name
*/
public String getOrgUnitName() {
return m_orgUnitName;
}
/**
* Returns the project Description.
*
* @return the project Description
*/
public String getProjectDescription() {
return m_projectDescription;
}
/**
* Returns the project Managers group name.
*
* @return the project Managers group name
*/
public String getProjectManagers() {
return m_projectManagers;
}
/**
* Returns the project Name.
*
* @return the project Name
*/
public String getProjectName() {
return m_projectName;
}
/**
* Returns the project Users group name.
*
* @return the project Users group name
*/
public String getProjectUsers() {
return m_projectUsers;
}
/**
* Returns the propertyName.
*
* @return the propertyName
*
* @see #N_NAME
* @see #addResourcePropertyRules(Digester, String)
*/
public String getPropertyName() {
return m_propertyName;
}
/**
* Returns the propertyValue.
*
* @return the propertyValue
*
* @see #N_VALUE
* @see #addResourcePropertyRules(Digester, String)
*/
public String getPropertyValue() {
return m_propertyValue;
}
/**
* Returns the relationId.
*
* @return the relationId
*
* @see #N_ID
* @see #addResourceRelationRules(Digester, String)
*/
public CmsUUID getRelationId() {
return m_relationId;
}
/**
* Returns the relationPath.
*
* @return the relationPath
*
* @see #N_PATH
* @see #addResourceRelationRules(Digester, String)
*/
public String getRelationPath() {
return m_relationPath;
}
/**
* Returns the relationType.
*
* @return the relationType
*
* @see #N_TYPE
* @see #addResourceRelationRules(Digester, String)
*/
public CmsRelationType getRelationType() {
return m_relationType;
}
/**
* Returns the report.
*
* @return the report
*/
public I_CmsReport getReport() {
return m_report;
}
/**
* Returns the resourceId.
*
* @return the resourceId
*
* @see #N_UUIDRESOURCE
* @see #addResourceAttributesRules(Digester, String)
*/
public CmsUUID getResourceId() {
return m_resourceId;
}
/**
* Returns the source.
*
* @return the source
*
* @see #N_SOURCE
* @see #addResourceAttributesRules(Digester, String)
*/
public String getSource() {
return m_source;
}
/**
* Returns the structureId.
*
* @return the structureId
*
* @see #N_UUIDSTRUCTURE
* @see #addResourceAttributesRules(Digester, String)
*/
public CmsUUID getStructureId() {
return m_structureId;
}
/**
* Returns the throwable.
*
* @return the throwable
*/
public Throwable getThrowable() {
return m_throwable;
}
/**
* Returns the type.
*
* @return the type
*
* @see #N_TYPE
* @see #addResourceAttributesRules(Digester, String)
*/
public I_CmsResourceType getType() {
return m_type;
}
/**
* Returns the userCreated.
*
* @return the userCreated
*
* @see #N_USERCREATED
* @see #addResourceAttributesRules(Digester, String)
*/
public CmsUUID getUserCreated() {
return m_userCreated;
}
/**
* Returns the user Date Created.
*
* @return the user Date Created
*/
public long getUserDateCreated() {
return m_userDateCreated;
}
/**
* Returns the user Email address.
*
* @return the user Email address
*/
public String getUserEmail() {
return m_userEmail;
}
/**
* Returns the user First name.
*
* @return the user First name
*/
public String getUserFirstname() {
return m_userFirstname;
}
/**
* Returns the user Flags.
*
* @return the user Flags
*/
public int getUserFlags() {
return m_userFlags;
}
/**
* Returns the userLastModified.
*
* @return the userLastModified
*
* @see #N_USERLASTMODIFIED
* @see #addResourceAttributesRules(Digester, String)
*/
public CmsUUID getUserLastModified() {
return m_userLastModified;
}
/**
* Returns the user Last name.
*
* @return the user Last name
*/
public String getUserLastname() {
return m_userLastname;
}
/**
* Returns the user Name.
*
* @return the user Name
*/
public String getUserName() {
return m_userName;
}
/**
* Returns the user Password.
*
* @return the user Password
*/
public String getUserPassword() {
return m_userPassword;
}
/**
* @see org.opencms.importexport.I_CmsImport#getVersion()
*/
public int getVersion() {
return IMPORT_VERSION10;
}
/**
* Imports an ACE from the current xml data.
*
* @see #addResourceAceRules(Digester, String)
*/
public void importAccessControlEntries() {
// only set permissions if the resource did not exists or if the keep permissions flag is not set
if ((m_resource == null) || !m_importACEs) {
return;
}
if ((m_aces == null) || (m_aces.size() == 0)) {
// no ACE in the list
return;
}
// if the resource was imported add the access control entries if available
try {
getCms().importAccessControlEntries(m_resource, m_aces);
} catch (@SuppressWarnings("unused") CmsException exc) {
getReport().println(
Messages.get().container(Messages.RPT_IMPORT_ACL_DATA_FAILED_0),
I_CmsReport.FORMAT_WARNING);
} finally {
m_aces = null;
}
}
/**
* @see org.opencms.importexport.I_CmsImport#importData(CmsObject, I_CmsReport, CmsImportParameters)
*/
public void importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) {
m_cms = cms;
m_report = report;
m_parameters = parameters;
// instantiate Digester and enable XML validation
Digester digester = new Digester();
digester.setUseContextClassLoader(true);
digester.setValidating(m_parameters.isXmlValidation());
digester.setEntityResolver(new CmsXmlEntityResolver(null));
digester.setRuleNamespaceURI(null);
digester.setErrorHandler(new CmsXmlErrorHandler(CmsImportExportManager.EXPORT_MANIFEST));
// add this object to the Digester
digester.push(this);
addXmlDigesterRules(digester);
InputStream stream = null;
m_helper = new CmsImportHelper(m_parameters);
try {
m_helper.openFile();
m_helper.cacheDtdSystemId(DTD_LOCATION, DTD_FILENAME, CmsConfigurationManager.DEFAULT_DTD_PREFIX);
findContentFiles();
// start the parsing process
stream = m_helper.getFileStream(CmsImportExportManager.EXPORT_MANIFEST);
digester.parse(stream);
} catch (Exception ioe) {
if (LOG.isErrorEnabled()) {
LOG.error(
Messages.get().getBundle().key(
Messages.ERR_IMPORTEXPORT_ERROR_READING_FILE_1,
CmsImportExportManager.EXPORT_MANIFEST),
ioe);
}
getReport().println(ioe);
} finally {
try {
if (stream != null) {
stream.close();
}
} catch (@SuppressWarnings("unused") Exception e) {
// noop
}
m_helper.closeFile();
}
}
/**
* Import the current group from xml data.
*/
public void importGroup() {
if (m_orgUnit == null) {
return;
}
if (m_groupDescription == null) {
m_groupDescription = "";
}
if (m_groupParents == null) {
m_groupParents = new HashMap>();
}
String groupName = m_orgUnit.getName() + m_groupName;
try {
if (m_throwable != null) {
getReport().println(m_throwable);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_GROUP_1,
groupName);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), m_throwable);
}
m_throwable = null;
return;
}
getReport().print(Messages.get().container(Messages.RPT_IMPORT_GROUP_0), I_CmsReport.FORMAT_NOTE);
getReport().print(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_ARGUMENT_1, groupName));
getReport().print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));
try {
getCms().readGroup(groupName);
// the group already exists and will not be created
getReport().println(Messages.get().container(Messages.RPT_NOT_CREATED_0), I_CmsReport.FORMAT_OK);
} catch (@SuppressWarnings("unused") CmsDbEntryNotFoundException e) {
// ok, let's create it
// first check the parent group
CmsUUID parentGroupId = null;
if (CmsStringUtil.isNotEmpty(m_groupParent)) {
try {
// parent group exists
parentGroupId = getCms().readGroup(m_groupParent).getId();
} catch (@SuppressWarnings("unused") CmsDbEntryNotFoundException exc) {
// parent group does not exist, remember to set the parent group later
List childs = m_groupParents.get(m_groupParent);
if (childs == null) {
childs = new ArrayList();
m_groupParents.put(m_groupParent, childs);
}
childs.add(groupName);
}
}
getCms().createGroup(
groupName,
m_groupDescription,
m_groupFlags,
parentGroupId == null ? null : m_groupParent);
getReport().println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
// set parents that could not be set before
List childs = m_groupParents.remove(groupName);
if (childs != null) {
Iterator it = childs.iterator();
while (it.hasNext()) {
String childGroup = it.next();
getCms().setParentGroup(childGroup, groupName);
}
}
}
} catch (Exception e) {
getReport().println(e);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_GROUP_1,
groupName);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), e);
}
} finally {
m_groupDescription = null;
m_groupFlags = 0;
m_groupName = null;
m_groupParent = null;
m_throwable = null;
}
}
/**
* Imports the current organizational unit.
*/
public void importOrgUnit() {
try {
if (m_throwable != null) {
getReport().println(m_throwable);
getReport().addError(m_throwable);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_ORGUNITS_0);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), m_throwable);
}
m_throwable = null;
m_orgUnit = null;
return;
}
getReport().print(Messages.get().container(Messages.RPT_IMPORT_ORGUNIT_0), I_CmsReport.FORMAT_NOTE);
getReport().print(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_ARGUMENT_1, m_orgUnitName));
getReport().print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));
try {
m_orgUnit = OpenCms.getOrgUnitManager().readOrganizationalUnit(getCms(), m_orgUnitName);
// the organizational unit already exists and will not be created
getReport().println(Messages.get().container(Messages.RPT_NOT_CREATED_0), I_CmsReport.FORMAT_OK);
m_orgUnitResources.remove(m_orgUnitName);
return;
} catch (@SuppressWarnings("unused") CmsDataAccessException e) {
// ok, continue creating the ou
}
// get the resources that already exist for the organizational unit
// if there are resources that does not exist jet, there will be a second try after importing resources
List resources = new ArrayList();
String site = getCms().getRequestContext().getSiteRoot();
try {
getCms().getRequestContext().setSiteRoot("");
boolean remove = true;
List ouResources = CmsCollectionsGenericWrapper.list(m_orgUnitResources.get(m_orgUnitName));
if (ouResources != null) {
Iterator itResNames = ouResources.iterator();
while (itResNames.hasNext()) {
String resName = itResNames.next();
try {
resources.add(getCms().readResource(resName, CmsResourceFilter.ALL));
itResNames.remove();
} catch (@SuppressWarnings("unused") CmsVfsResourceNotFoundException e) {
// resource does not exist yet, skip it for now
remove = false;
}
}
}
if (remove) {
m_orgUnitResources.remove(m_orgUnitName);
}
} finally {
getCms().getRequestContext().setSiteRoot(site);
}
// if no resource available
if (resources.isEmpty()) {
// meanwhile use the first one of the parent organizational unit
resources.add(
OpenCms.getOrgUnitManager().getResourcesForOrganizationalUnit(
getCms(),
CmsOrganizationalUnit.getParentFqn(m_orgUnitName)).get(0));
}
// create the organizational unit with a dummy resource, which will be corrected later
m_orgUnit = OpenCms.getOrgUnitManager().createOrganizationalUnit(
getCms(),
m_orgUnitName,
m_orgUnitDescription,
m_orgUnitFlags,
resources.get(0).getRootPath());
for (int i = 1; i < resources.size(); i++) {
OpenCms.getOrgUnitManager().addResourceToOrgUnit(
getCms(),
m_orgUnitName,
resources.get(i).getRootPath());
}
getReport().println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
} catch (CmsException e) {
getReport().println(e);
getReport().addError(e);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_ORGUNITS_0);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), e);
}
m_throwable = null;
m_orgUnit = null;
} finally {
m_orgUnitName = null;
m_orgUnitDescription = null;
m_orgUnitFlags = 0;
}
}
/**
* Imports the current project.
*/
public void importProject() {
try {
if (m_throwable != null) {
getReport().println(m_throwable);
getReport().addError(m_throwable);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_PROJECTS_0);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), m_throwable);
}
m_throwable = null;
return;
}
getReport().print(Messages.get().container(Messages.RPT_IMPORT_PROJECT_0), I_CmsReport.FORMAT_NOTE);
getReport().print(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_ARGUMENT_1, m_projectName));
getReport().print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));
try {
getCms().readProject(m_projectName);
// the project already exists and will not be created
getReport().println(Messages.get().container(Messages.RPT_NOT_CREATED_0), I_CmsReport.FORMAT_OK);
return;
} catch (@SuppressWarnings("unused") CmsDataAccessException e) {
// ok, continue creating the project
}
// create the project
CmsProject project = getCms().createProject(
m_projectName,
m_projectDescription,
m_projectUsers,
m_projectManagers,
CmsProject.PROJECT_TYPE_NORMAL);
// set the resources
if (m_projectResources != null) {
String site = getCms().getRequestContext().getSiteRoot();
CmsProject currentProject = getCms().getRequestContext().getCurrentProject();
try {
getCms().getRequestContext().setSiteRoot("");
getCms().getRequestContext().setCurrentProject(project);
Iterator itResNames = m_projectResources.iterator();
while (itResNames.hasNext()) {
String resName = itResNames.next();
try {
getCms().copyResourceToProject(resName);
} catch (@SuppressWarnings("unused") CmsVfsResourceNotFoundException e) {
// resource does not exist, skip
}
}
} finally {
getCms().getRequestContext().setSiteRoot(site);
getCms().getRequestContext().setCurrentProject(currentProject);
}
}
getReport().println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
} catch (CmsException e) {
getReport().println(e);
getReport().addError(e);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_PROJECTS_0);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), e);
}
m_throwable = null;
} finally {
m_projectName = null;
m_projectDescription = null;
m_projectManagers = null;
m_projectUsers = null;
m_projectResources = null;
}
}
/**
* Imports all relations from the current xml data.
*
* This is a global process that occurs only once at the end of the import,
* after all resources have been imported, to make sure that both resources
* of the relations are available.
*
* @see #addResourceRelationRules(Digester, String)
* @see #addXmlDigesterRules(Digester)
*/
public void importRelations() {
if ((m_relations == null) || m_relations.isEmpty()) {
// no relations to add
return;
}
getReport().println(
Messages.get().container(Messages.RPT_START_IMPORT_RELATIONS_0),
I_CmsReport.FORMAT_HEADLINE);
int i = 0;
Iterator>> it = m_relations.entrySet().iterator();
while (it.hasNext()) {
Entry> entry = it.next();
String resourcePath = entry.getKey();
List relations = entry.getValue();
if (checkImmutable(resourcePath)) {
continue;
}
getReport().print(org.opencms.report.Messages.get().container(
org.opencms.report.Messages.RPT_SUCCESSION_2,
String.valueOf(i + 1),
String.valueOf(m_relations.size())), I_CmsReport.FORMAT_NOTE);
getReport().print(
Messages.get().container(
Messages.RPT_IMPORTING_RELATIONS_FOR_2,
resourcePath,
new Integer(relations.size())),
I_CmsReport.FORMAT_NOTE);
getReport().print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));
boolean withErrors = false;
Iterator itRelations = relations.iterator();
while (itRelations.hasNext()) {
CmsRelation relation = itRelations.next();
try {
// Add the relation to the resource
getCms().importRelation(
getCms().getSitePath(relation.getSource(getCms(), CmsResourceFilter.ALL)),
getCms().getSitePath(relation.getTarget(getCms(), CmsResourceFilter.ALL)),
relation.getType().getName());
} catch (CmsException e) {
getReport().addWarning(e);
withErrors = true;
if (LOG.isWarnEnabled()) {
LOG.warn(e.getLocalizedMessage());
}
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
if (!withErrors) {
getReport().println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
} else {
getReport().println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_FAILED_0),
I_CmsReport.FORMAT_ERROR);
}
i++;
}
getReport().println(Messages.get().container(Messages.RPT_END_IMPORT_RELATIONS_0), I_CmsReport.FORMAT_HEADLINE);
m_relations = null;
}
/**
* Imports a resource from the current xml data.
*
* @see #addResourceAttributesRules(Digester, String)
* @see #addResourcePropertyRules(Digester, String)
*/
public void importResource() {
boolean resourceIdWasNull = false;
try {
if (m_throwable != null) {
getReport().println(m_throwable);
getReport().addError(m_throwable);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_RESOURCES_0);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), m_throwable);
}
m_throwable = null;
m_importACEs = false;
m_resource = null;
return;
}
// apply name translation and import path
String translatedName = getCms().getRequestContext().addSiteRoot(
m_parameters.getDestinationPath() + m_destination);
boolean resourceImmutable = checkImmutable(translatedName);
translatedName = getCms().getRequestContext().removeSiteRoot(translatedName);
// if the resource is not immutable and not on the exclude list, import it
if (!resourceImmutable) {
// print out the information to the report
getReport().print(Messages.get().container(Messages.RPT_IMPORTING_0), I_CmsReport.FORMAT_NOTE);
getReport().print(
org.opencms.report.Messages.get().container(
org.opencms.report.Messages.RPT_ARGUMENT_1,
translatedName));
getReport().print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));
boolean exists = getCms().existsResource(translatedName, CmsResourceFilter.ALL);
byte[] content = null;
// get the file content
if (m_source != null) {
content = m_helper.getFileBytes(m_source);
}
int size = 0;
if (content != null) {
size = content.length;
}
// get UUID for the structure
if (m_structureId == null) {
// if null generate a new structure id
m_structureId = new CmsUUID();
}
// get UUIDs for the resource
if ((m_resourceId == null) || (m_type.isFolder())) {
// folders get always a new resource UUID
m_resourceId = new CmsUUID();
resourceIdWasNull = true;
}
// read date last modified from the resource, default to currentTime for folders
if (m_dateLastModified == DATE_LAST_MODIFICATION_FILETIME) {
if (null != m_source) {
m_dateLastModified = m_helper.getFileModification(m_source);
} else {
m_dateLastModified = System.currentTimeMillis();
}
}
if (m_dateLastModified == DATE_LAST_MODIFICATION_UNSPECIFIED) {
m_dateLastModified = System.currentTimeMillis();
}
if (null == m_userLastModified) {
m_userLastModified = m_cms.getRequestContext().getCurrentUser().getId();
}
if (m_dateCreated == DATE_CREATED_UNSPECIFIED) {
m_dateCreated = System.currentTimeMillis();
}
if (m_userCreated.isNullUUID()) {
m_userCreated = getCms().getRequestContext().getCurrentUser().getId();
}
// create a new CmsResource
CmsResource resource = new CmsResource(
m_structureId,
m_resourceId,
translatedName,
m_type,
m_flags,
getCms().getRequestContext().getCurrentProject().getUuid(),
CmsResource.STATE_NEW,
m_dateCreated,
m_userCreated,
m_dateLastModified,
m_userLastModified,
m_dateReleased,
m_dateExpired,
1,
size,
System.currentTimeMillis(),
0);
if (m_properties == null) {
m_properties = new HashMap();
}
if (m_type.isFolder() || resourceIdWasNull || hasContentInVfsOrImport(resource)) {
// import this resource in the VFS
m_resource = getCms().importResource(
translatedName,
resource,
content,
new ArrayList(m_properties.values()));
}
// only set permissions if the resource did not exists or if the keep permissions flag is not set
m_importACEs = (m_resource != null) && (!exists || !m_parameters.isKeepPermissions());
if (m_resource != null) {
getReport().println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
if (OpenCms.getResourceManager().getResourceType(
m_resource.getTypeId()) instanceof I_CmsLinkParseable) {
// store for later use
m_parseables.add(m_resource);
}
if (LOG.isInfoEnabled()) {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_IMPORTING_4,
new Object[] {
String.valueOf(m_fileCounter),
String.valueOf(m_totalFiles),
translatedName,
m_destination}));
}
} else {
// resource import failed, since no CmsResource was created
getReport().print(Messages.get().container(Messages.RPT_SKIPPING_0), I_CmsReport.FORMAT_NOTE);
getReport().println(
org.opencms.report.Messages.get().container(
org.opencms.report.Messages.RPT_ARGUMENT_1,
translatedName));
if (LOG.isInfoEnabled()) {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_SKIPPING_3,
String.valueOf(m_fileCounter),
String.valueOf(m_totalFiles),
translatedName));
}
}
} else {
m_resource = null;
// skip the file import, just print out the information to the report
getReport().print(Messages.get().container(Messages.RPT_SKIPPING_0), I_CmsReport.FORMAT_NOTE);
getReport().println(
org.opencms.report.Messages.get().container(
org.opencms.report.Messages.RPT_ARGUMENT_1,
translatedName));
if (LOG.isInfoEnabled()) {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_SKIPPING_3,
String.valueOf(m_fileCounter),
String.valueOf(m_totalFiles),
translatedName));
}
// do not import ACEs
m_importACEs = false;
}
} catch (Exception e) {
m_resource = null;
m_importACEs = false;
getReport().println(e);
getReport().addError(e);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_RESOURCES_0);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), e);
}
return;
} finally {
m_structureId = null;
m_resourceId = null;
m_destination = null;
m_source = null;
m_type = null;
m_flags = 0;
m_dateCreated = DATE_CREATED_UNSPECIFIED;
m_dateLastModified = DATE_LAST_MODIFICATION_UNSPECIFIED;
m_dateReleased = CmsResource.DATE_RELEASED_DEFAULT;
m_dateExpired = CmsResource.DATE_EXPIRED_DEFAULT;
m_properties = null;
m_throwable = null;
m_aces = null;
m_properties = null;
}
}
/**
* @see org.opencms.importexport.I_CmsImport#importResources(org.opencms.file.CmsObject, java.lang.String, org.opencms.report.I_CmsReport, java.io.File, java.util.zip.ZipFile, org.dom4j.Document)
*
* @deprecated use {@link #importData(CmsObject, I_CmsReport, CmsImportParameters)} instead
*/
@Deprecated
public void importResources(
CmsObject cms,
String importPath,
I_CmsReport report,
File importResource,
ZipFile importZip,
Document docXml) {
CmsImportParameters params = new CmsImportParameters(importResource.getAbsolutePath(), importPath, true);
importData(cms, report, params);
}
/**
* Imports a new user from the current xml data.
*/
public void importUser() {
// create a new user id
String userName = m_orgUnit.getName() + m_userName;
try {
if (m_throwable != null) {
m_user = null;
getReport().println(m_throwable);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_USER_1,
userName);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), m_throwable);
}
m_throwable = null;
return;
}
getReport().print(Messages.get().container(Messages.RPT_IMPORT_USER_0), I_CmsReport.FORMAT_NOTE);
getReport().print(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_ARGUMENT_1, userName));
getReport().print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));
try {
getCms().readUser(userName);
// user exists already
getReport().println(Messages.get().container(Messages.RPT_NOT_CREATED_0), I_CmsReport.FORMAT_OK);
m_user = null;
return;
} catch (@SuppressWarnings("unused") CmsDbEntryNotFoundException e) {
// user does not exist
}
CmsParameterConfiguration config = OpenCms.getPasswordHandler().getConfiguration();
if ((config != null) && config.containsKey(I_CmsPasswordHandler.CONVERT_DIGEST_ENCODING)) {
if (config.getBoolean(I_CmsPasswordHandler.CONVERT_DIGEST_ENCODING, false)) {
m_userPassword = convertDigestEncoding(m_userPassword);
}
}
m_user = getCms().importUser(
new CmsUUID().toString(),
userName,
m_userPassword,
m_userFirstname,
m_userLastname,
m_userEmail,
m_userFlags,
m_userDateCreated,
m_userInfos);
getReport().println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
} catch (Throwable e) {
m_user = null;
getReport().println(e);
CmsMessageContainer message = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_IMPORTING_USER_1,
userName);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), e);
}
} finally {
m_userName = null;
m_userPassword = null;
m_userFirstname = null;
m_userLastname = null;
m_userEmail = null;
m_userFlags = 0;
m_userDateCreated = 0;
m_userInfos = null;
}
}
/**
* Sets the current user as member of the given group.
*
* It can happen that the organizational unit has not been imported jet,
* in this case, the data is kept for later.
*
* @param groupName the name of the group to set
*
* @see #setMembership()
*/
public void importUserGroup(String groupName) {
if ((m_throwable != null) || (m_user == null)) {
return;
}
groupName = OpenCms.getImportExportManager().translateGroup(groupName);
try {
String ouName = CmsOrganizationalUnit.getParentFqn(groupName);
try {
// check if the organizational unit exists
OpenCms.getOrgUnitManager().readOrganizationalUnit(getCms(), ouName);
// set the user group
getCms().addUserToGroup(m_user.getName(), groupName);
return;
} catch (@SuppressWarnings("unused") CmsDbEntryNotFoundException e) {
// organizational unit does not exist
}
// remember the user and group for later
Map> membership = m_membership.get(ouName);
if (membership == null) {
membership = new HashMap>();
m_membership.put(ouName, membership);
}
Map groups = membership.get(I_CmsPrincipal.PRINCIPAL_GROUP);
if (groups == null) {
groups = new HashMap();
membership.put(I_CmsPrincipal.PRINCIPAL_GROUP, groups);
}
groups.put(m_user.getName(), groupName);
} catch (Throwable e) {
getReport().println(
Messages.get().container(Messages.RPT_USER_COULDNT_BE_ADDED_TO_GROUP_2, m_user.getName(), groupName),
I_CmsReport.FORMAT_WARNING);
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
/**
* Creates a new additional information entry for the current user.
*
* @param infoName the name of the additional information entry
* @param infoType the type of the additional information entry
* @param infoValue the value of the additional information entry
*/
public void importUserInfo(String infoName, String infoType, String infoValue) {
if (m_userInfos == null) {
m_userInfos = new HashMap();
}
try {
m_userInfos.put(infoName, CmsDataTypeUtil.dataImport(infoValue, infoType));
} catch (Throwable e) {
if (LOG.isErrorEnabled()) {
LOG.error(e.getLocalizedMessage(), e);
}
}
}
/**
* Sets the current user as member of the given role.
*
* It can happen that the organizational unit has not been imported jet,
* in this case, the data is kept for later.
*
* @param roleName the name of the role to set
*
* @see #setMembership()
*/
public void importUserRole(String roleName) {
if ((m_throwable != null) || (m_user == null)) {
return;
}
try {
CmsRole role = CmsRole.valueOfRoleName(roleName);
try {
// check if the organizational unit exists
OpenCms.getOrgUnitManager().readOrganizationalUnit(getCms(), role.getOuFqn());
// set the user role
OpenCms.getRoleManager().addUserToRole(getCms(), role, m_user.getName());
return;
} catch (@SuppressWarnings("unused") CmsDbEntryNotFoundException e) {
// organizational unit does not exist
}
// remember the user and role for later
Map> membership = m_membership.get(role.getOuFqn());
if (membership == null) {
membership = new HashMap>();
m_membership.put(role.getOuFqn(), membership);
}
Map roles = membership.get(I_CmsPrincipal.PRINCIPAL_USER);
if (roles == null) {
roles = new HashMap();
membership.put(I_CmsPrincipal.PRINCIPAL_USER, roles);
}
roles.put(m_user.getName(), role.getFqn());
} catch (Throwable e) {
getReport().println(
Messages.get().container(Messages.RPT_USER_COULDNT_BE_ADDED_TO_ROLE_2, m_user.getName(), roleName),
I_CmsReport.FORMAT_WARNING);
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
/**
* Increases the file counter.
*/
public void increaseCounter() {
m_fileCounter++;
}
/**
* Increases the total number of files.
*/
public void increaseTotalFiles() {
m_totalFiles++;
}
/**
* @see org.opencms.importexport.I_CmsImport#matches(org.opencms.importexport.CmsImportParameters)
*/
@SuppressWarnings("resource") //stream is closed always in finally block - don't know why the compiler complains
public boolean matches(CmsImportParameters parameters) throws CmsImportExportException {
m_fileCounter = 1;
m_totalFiles = 0;
m_parseables = new ArrayList();
m_parameters = parameters;
// instantiate Digester and enable XML validation
Digester digester = new Digester();
digester.setUseContextClassLoader(true);
digester.setValidating(m_parameters.isXmlValidation());
digester.setEntityResolver(new CmsXmlEntityResolver(null));
digester.setRuleNamespaceURI(null);
digester.setErrorHandler(new CmsXmlErrorHandler(CmsImportExportManager.EXPORT_MANIFEST));
// add this object to the Digester
digester.push(this);
addXmlPreprocessingDigesterRules(digester);
InputStream stream = null;
m_helper = new CmsImportHelper(m_parameters);
m_helper.cacheDtdSystemId(DTD_LOCATION, DTD_FILENAME, CmsConfigurationManager.DEFAULT_DTD_PREFIX);
try {
m_helper.openFile();
// start the parsing process
// this will set the version attribute
stream = m_helper.getFileStream(CmsImportExportManager.EXPORT_MANIFEST);
digester.parse(stream);
} catch (Exception ioe) {
CmsMessageContainer msg = Messages.get().container(
Messages.ERR_IMPORTEXPORT_ERROR_READING_FILE_1,
CmsImportExportManager.EXPORT_MANIFEST);
if (LOG.isErrorEnabled()) {
LOG.error(msg.key(), ioe);
}
throw new CmsImportExportException(msg, ioe);
} finally {
try {
if (stream != null) {
stream.close();
}
} catch (@SuppressWarnings("unused") Exception e) {
// noop
}
m_helper.closeFile();
}
return (m_version == getVersion());
}
/**
* Rewrites all parseable files, to assure link check.
*
* This is a global process, that is executed only once at the
* end of the import to be sure that all link targets are
* available.
*
* @see #addXmlDigesterRules(Digester)
*/
public void rewriteParseables() {
if (m_parseables.isEmpty()) {
return;
}
I_CmsReport report = getReport();
CmsObject cms = getCms();
cms.getRequestContext().setAttribute(CmsLogEntry.ATTR_LOG_ENTRY, Boolean.FALSE);
report.println(Messages.get().container(Messages.RPT_START_PARSE_LINKS_0), I_CmsReport.FORMAT_HEADLINE);
parseLinks(cms, report);
report.println(Messages.get().container(Messages.RPT_END_PARSE_LINKS_0), I_CmsReport.FORMAT_HEADLINE);
m_parseables = null;
}
/**
* Sets the aceFlags.
*
* @param aceFlags the aceFlags to set
*
* @see #N_FLAGS
* @see #addResourceAceRules(Digester, String)
*/
public void setAceFlags(String aceFlags) {
try {
m_aceFlags = Integer.parseInt(aceFlags);
} catch (Throwable e) {
m_throwable = e;
}
}
/**
* Sets the acePermissionsAllowed.
*
* @param acePermissionsAllowed the acePermissionsAllowed to set
*
* @see #N_ACCESSCONTROL_ALLOWEDPERMISSIONS
* @see #addResourceAceRules(Digester, String)
*/
public void setAcePermissionsAllowed(String acePermissionsAllowed) {
try {
m_acePermissionsAllowed = Integer.parseInt(acePermissionsAllowed);
} catch (Throwable e) {
m_throwable = e;
}
}
/**
* Sets the acePermissionsDenied.
*
* @param acePermissionsDenied the acePermissionsDenied to set
*
* @see #N_ACCESSCONTROL_DENIEDPERMISSIONS
* @see #addResourceAceRules(Digester, String)
*/
public void setAcePermissionsDenied(String acePermissionsDenied) {
try {
m_acePermissionsDenied = Integer.parseInt(acePermissionsDenied);
} catch (Throwable e) {
m_throwable = e;
}
}
/**
* Sets the acePrincipalId.
*
* @param acePrincipalId the acePrincipalId to set
*
* @see #N_ACCESSCONTROL_PRINCIPAL
* @see #addResourceAceRules(Digester, String)
*/
public void setAcePrincipalId(String acePrincipalId) {
try {
CmsUUID principalId = null;
String principal = acePrincipalId.substring(acePrincipalId.indexOf('.') + 1, acePrincipalId.length());
if (acePrincipalId.startsWith(I_CmsPrincipal.PRINCIPAL_GROUP)) {
principal = OpenCms.getImportExportManager().translateGroup(principal);
principalId = getCms().readGroup(principal).getId();
} else if (acePrincipalId.startsWith(I_CmsPrincipal.PRINCIPAL_USER)) {
principal = OpenCms.getImportExportManager().translateUser(principal);
principalId = getCms().readUser(principal).getId();
} else if (acePrincipalId.startsWith(CmsRole.PRINCIPAL_ROLE)) {
principalId = CmsRole.valueOfRoleName(principal).getId();
} else if (acePrincipalId.equalsIgnoreCase(CmsAccessControlEntry.PRINCIPAL_ALL_OTHERS_NAME)) {
principalId = CmsAccessControlEntry.PRINCIPAL_ALL_OTHERS_ID;
} else if (acePrincipalId.equalsIgnoreCase(CmsAccessControlEntry.PRINCIPAL_OVERWRITE_ALL_NAME)) {
principalId = CmsAccessControlEntry.PRINCIPAL_OVERWRITE_ALL_ID;
} else {
if (LOG.isWarnEnabled()) {
LOG.warn(
Messages.get().getBundle().key(
Messages.LOG_IMPORTEXPORT_ERROR_IMPORTING_ACE_1,
acePrincipalId));
}
throw new CmsIllegalStateException(
Messages.get().container(Messages.LOG_IMPORTEXPORT_ERROR_IMPORTING_ACE_1, acePrincipalId));
}
m_acePrincipalId = principalId;
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the dateCreated.
*
* @param dateCreated the dateCreated to set
*
* @see #N_DATECREATED
* @see #addResourceAttributesRules(Digester, String)
*/
public void setDateCreated(String dateCreated) {
try {
if (dateCreated != null) {
m_dateCreated = convertTimestamp(dateCreated);
} else {
m_dateCreated = System.currentTimeMillis();
}
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the dateExpired.
*
* @param dateExpired the dateExpired to set
*
* @see #N_DATEEXPIRED
* @see #addResourceAttributesRules(Digester, String)
*/
public void setDateExpired(String dateExpired) {
try {
if (dateExpired != null) {
m_dateExpired = convertTimestamp(dateExpired);
} else {
m_dateExpired = CmsResource.DATE_EXPIRED_DEFAULT;
}
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the dateLastModified.
*
* @param dateLastModified the dateLastModified to set
*
* @see #N_DATELASTMODIFIED
* @see #addResourceAttributesRules(Digester, String)
*/
public void setDateLastModified(String dateLastModified) {
try {
if (dateLastModified != null) {
TimestampMode timeMode = TimestampMode.getEnum(CmsMacroResolver.stripMacro(dateLastModified));
switch (timeMode) {
case FILETIME:
m_dateLastModified = -1; //Can't get the information right now, must set it afterward.
break;
case IMPORTTIME:
m_dateLastModified = System.currentTimeMillis();
break;
case VFSTIME:
default:
m_dateLastModified = convertTimestamp(dateLastModified);
break;
}
} else {
m_dateLastModified = System.currentTimeMillis();
}
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the dateReleased.
*
* @param dateReleased the dateReleased to set
*
* @see #N_DATERELEASED
* @see #addResourceAttributesRules(Digester, String)
*/
public void setDateReleased(String dateReleased) {
try {
if (dateReleased != null) {
m_dateReleased = convertTimestamp(dateReleased);
} else {
m_dateReleased = CmsResource.DATE_RELEASED_DEFAULT;
}
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the destination.
*
* @param destination the destination to set
*
* @see #N_DESTINATION
* @see #addResourceAttributesRules(Digester, String)
*/
public void setDestination(String destination) {
m_destination = destination;
}
/**
* Sets the flags.
*
* @param flags the flags to set
*
* @see #N_FLAGS
* @see #addResourceAttributesRules(Digester, String)
*/
public void setFlags(String flags) {
try {
m_flags = Integer.parseInt(flags);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the group Description.
*
* @param groupDescription the description to set
*/
public void setGroupDescription(String groupDescription) {
m_groupDescription = groupDescription;
}
/**
* Sets the group Flags.
*
* @param groupFlags the flags to set
*/
public void setGroupFlags(String groupFlags) {
try {
m_groupFlags = Integer.parseInt(groupFlags);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the group Name.
*
* @param groupName the name to set
*/
public void setGroupName(String groupName) {
m_groupName = OpenCms.getImportExportManager().translateGroup(groupName);
}
/**
* Sets the group Parent.
*
* @param groupParent the group Parent to set
*/
public void setGroupParent(String groupParent) {
m_groupParent = OpenCms.getImportExportManager().translateGroup(groupParent);
}
/**
* Sets the membership information that could not been set immediately,
* because of import order issues.
*/
public void setMembership() {
if ((m_orgUnit == null) || (m_membership == null)) {
return;
}
// get the membership data to set
Map> membership = m_membership.get(m_orgUnit.getName());
if (membership == null) {
return;
}
// set group membership
Map groups = membership.get(I_CmsPrincipal.PRINCIPAL_GROUP);
if (groups != null) {
Iterator> it = groups.entrySet().iterator();
while (it.hasNext()) {
Entry entry = it.next();
String userName = entry.getKey();
String groupName = entry.getValue();
// set the users group
try {
getCms().addUserToGroup(userName, groupName);
} catch (Throwable e) {
getReport().println(
Messages.get().container(Messages.RPT_USER_COULDNT_BE_ADDED_TO_GROUP_2, userName, groupName),
I_CmsReport.FORMAT_WARNING);
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
}
// set role membership
Map roles = membership.get(I_CmsPrincipal.PRINCIPAL_USER);
if (roles != null) {
Iterator> it = roles.entrySet().iterator();
while (it.hasNext()) {
Entry entry = it.next();
String userName = entry.getKey();
String roleName = entry.getValue();
// set the users roles
CmsRole role = CmsRole.valueOfRoleName(roleName);
try {
// set the user role
OpenCms.getRoleManager().addUserToRole(getCms(), role, userName);
return;
} catch (Throwable e) {
getReport().println(
Messages.get().container(Messages.RPT_USER_COULDNT_BE_ADDED_TO_ROLE_2, userName, roleName),
I_CmsReport.FORMAT_WARNING);
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
}
}
/**
* Sets the organizational unit description.
*
* @param orgUnitDescription the description to set
*/
public void setOrgUnitDescription(String orgUnitDescription) {
m_orgUnitDescription = orgUnitDescription;
}
/**
* Sets the organizational unit flags.
*
* @param orgUnitFlags the flags to set
*/
public void setOrgUnitFlags(String orgUnitFlags) {
try {
m_orgUnitFlags = Integer.parseInt(orgUnitFlags);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the organizational unit name.
*
* @param orgUnitName the name to set
*/
public void setOrgUnitName(String orgUnitName) {
m_orgUnitName = orgUnitName;
}
/**
* Sets the project Description.
*
* @param projectDescription the description to set
*/
public void setProjectDescription(String projectDescription) {
m_projectDescription = projectDescription;
}
/**
* Sets the project Managers group name.
*
* @param projectManagers the managers group to set
*/
public void setProjectManagers(String projectManagers) {
m_projectManagers = projectManagers;
}
/**
* Sets the project Name.
*
* @param projectName the name to set
*/
public void setProjectName(String projectName) {
m_projectName = projectName;
}
/**
* Sets the project Users group name.
*
* @param projectUsers the Users group to set
*/
public void setProjectUsers(String projectUsers) {
m_projectUsers = projectUsers;
}
/**
* Sets the propertyName.
*
* @param propertyName the propertyName to set
*
* @see #N_NAME
* @see #addResourcePropertyRules(Digester, String)
*/
public void setPropertyName(String propertyName) {
m_propertyName = propertyName;
}
/**
* Sets the propertyValue.
*
* @param propertyValue the propertyValue to set
*
* @see #N_VALUE
* @see #addResourcePropertyRules(Digester, String)
*/
public void setPropertyValue(String propertyValue) {
m_propertyValue = propertyValue;
}
/**
* Sets the relationId.
*
* @param relationId the relationId to set
*
* @see #N_ID
* @see #addResourceRelationRules(Digester, String)
*/
public void setRelationId(String relationId) {
try {
m_relationId = new CmsUUID(relationId);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the relationPath.
*
* @param relationPath the relationPath to set
*
* @see #N_PATH
* @see #addResourceRelationRules(Digester, String)
*/
public void setRelationPath(String relationPath) {
m_relationPath = relationPath;
}
/**
* Sets the relationType.
*
* @param relationType the relationType to set
*
* @see #N_TYPE
* @see #addResourceRelationRules(Digester, String)
*/
public void setRelationType(String relationType) {
try {
m_relationType = CmsRelationType.valueOf(relationType);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the resourceId.
*
* @param resourceId the resourceId to set
*
* @see #N_UUIDRESOURCE
* @see #addResourceAttributesRules(Digester, String)
*/
public void setResourceId(String resourceId) {
try {
if (!m_type.isFolder()) {
m_resourceId = new CmsUUID(resourceId);
} else {
m_resourceId = new CmsUUID();
}
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the source.
*
* @param source the source to set
*
* @see #N_SOURCE
* @see #addResourceAttributesRules(Digester, String)
*/
public void setSource(String source) {
m_source = source;
}
/**
* Sets the structureId.
*
* @param structureId the structureId to set
*
* @see #N_UUIDSTRUCTURE
* @see #addResourceAttributesRules(Digester, String)
*/
public void setStructureId(String structureId) {
try {
m_structureId = new CmsUUID(structureId);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the throwable.
*
* @param throwable the throwable to set
*/
public void setThrowable(Throwable throwable) {
m_throwable = throwable;
}
/**
* Sets the type.
*
* @param typeName the type to set
*
* @see #N_TYPE
* @see #addResourceAttributesRules(Digester, String)
*/
public void setType(String typeName) {
try {
try {
m_type = OpenCms.getResourceManager().getResourceType(typeName);
} catch (@SuppressWarnings("unused") CmsLoaderException e) {
// TODO: what happens if the resource type is a specialized folder and is not configured??
try {
m_type = OpenCms.getResourceManager().getResourceType(CmsResourceTypePlain.getStaticTypeName());
} catch (@SuppressWarnings("unused") CmsLoaderException e1) {
// this should really never happen
m_type = OpenCms.getResourceManager().getResourceType(CmsResourceTypePlain.getStaticTypeName());
}
}
if (m_type.isFolder()) {
// ensure folders end with a "/"
if (!CmsResource.isFolder(m_destination)) {
m_destination += "/";
}
}
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the user Created.
*
* @param userCreated the user Created to set
*/
public void setUserCreated(CmsUUID userCreated) {
m_userCreated = userCreated;
}
/**
* Sets the userCreated.
*
* @param userCreated the userCreated to set
*
* @see #N_USERCREATED
* @see #addResourceAttributesRules(Digester, String)
*/
public void setUserCreated(String userCreated) {
try {
String userCreatedName = OpenCms.getImportExportManager().translateUser(userCreated);
try {
m_userCreated = getCms().readUser(userCreatedName).getId();
} catch (@SuppressWarnings("unused") CmsDbEntryNotFoundException e) {
m_userCreated = getCms().getRequestContext().getCurrentUser().getId();
}
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the user Date Created.
*
* @param userDateCreated the date to set
*/
public void setUserDateCreated(String userDateCreated) {
try {
m_userDateCreated = convertTimestamp(userDateCreated);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the user email address.
*
* @param userEmail the email address to set
*/
public void setUserEmail(String userEmail) {
m_userEmail = userEmail;
}
/**
* Sets the user First name.
*
* @param userFirstname the first name to set
*/
public void setUserFirstname(String userFirstname) {
m_userFirstname = userFirstname;
}
/**
* Sets the user Flags.
*
* @param userFlags the flags to set
*/
public void setUserFlags(String userFlags) {
try {
m_userFlags = Integer.parseInt(userFlags);
} catch (Throwable e) {
setThrowable(e);
}
}
/**
* Sets the user Last Modified.
*
* @param userLastModified the user Last Modified to set
*/
public void setUserLastModified(CmsUUID userLastModified) {
m_userLastModified = userLastModified;
}
/**
* Sets the userLastModified.
*
* @param userLastModified the userLastModified to set
*
* @see #N_USERLASTMODIFIED
* @see #addResourceAttributesRules(Digester, String)
*/
public void setUserLastModified(String userLastModified) {
if (null == userLastModified) { // The optional user last modified information is not provided
m_userLastModified = m_cms.getRequestContext().getCurrentUser().getId();
} else { // use the user last modified information from the manifest
try {
String userLastModifiedName = OpenCms.getImportExportManager().translateUser(userLastModified);
try {
m_userLastModified = getCms().readUser(userLastModifiedName).getId();
} catch (@SuppressWarnings("unused") CmsDbEntryNotFoundException e) {
m_userLastModified = getCms().getRequestContext().getCurrentUser().getId();
}
} catch (Throwable e) {
setThrowable(e);
}
}
}
/**
* Sets the user Last name.
*
* @param userLastname the last name to set
*/
public void setUserLastname(String userLastname) {
m_userLastname = userLastname;
}
/**
* Sets the user Name.
*
* @param userName the name to set
*/
public void setUserName(String userName) {
m_userName = OpenCms.getImportExportManager().translateUser(userName);
}
/**
* Sets the user Password.
*
* @param userPassword the password to set
*/
public void setUserPassword(String userPassword) {
m_userPassword = new String(Base64.decodeBase64(userPassword.trim().getBytes()));
}
/**
* Sets the export version from the manifest file.
*
* @param version the export version to set
*/
public void setVersion(String version) {
m_version = Integer.parseInt(version);
}
/**
* Adds the XML digester rules for groups.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addAccountsGroupRules(Digester digester, String xpath) {
String xp_group = xpath + N_GROUPS + "/" + N_GROUP;
digester.addCallMethod(xp_group, "importGroup");
xp_group += "/";
digester.addCallMethod(xp_group + N_NAME, "setGroupName", 0);
digester.addCallMethod(xp_group + N_DESCRIPTION, "setGroupDescription", 0);
digester.addCallMethod(xp_group + N_FLAGS, "setGroupFlags", 0);
digester.addCallMethod(xp_group + N_PARENTGROUP, "setGroupParent", 0);
}
/**
* Adds the XML digester rules for organizational units.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addAccountsOrgunitRules(Digester digester, String xpath) {
digester.addCallMethod(xpath + N_NAME, "setOrgUnitName", 0);
digester.addCallMethod(xpath + N_DESCRIPTION, "setOrgUnitDescription", 0);
digester.addCallMethod(xpath + N_FLAGS, "setOrgUnitFlags", 0);
digester.addCallMethod(xpath + N_RESOURCES + "/" + N_RESOURCE, "addOrgUnitResource", 0);
digester.addCallMethod(xpath + N_RESOURCES, "importOrgUnit");
}
/**
* Adds the XML digester rules for users.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addAccountsUserRules(Digester digester, String xpath) {
String xp_user = xpath + N_USERS + "/" + N_USER + "/";
digester.addCallMethod(xp_user + N_NAME, "setUserName", 0);
digester.addCallMethod(xp_user + N_PASSWORD, "setUserPassword", 0);
digester.addCallMethod(xp_user + N_FIRSTNAME, "setUserFirstname", 0);
digester.addCallMethod(xp_user + N_LASTNAME, "setUserLastname", 0);
digester.addCallMethod(xp_user + N_EMAIL, "setUserEmail", 0);
digester.addCallMethod(xp_user + N_FLAGS, "setUserFlags", 0);
digester.addCallMethod(xp_user + N_DATECREATED, "setUserDateCreated", 0);
digester.addCallMethod(xp_user + N_USERINFO, "importUser");
String xp_info = xp_user + N_USERINFO + "/" + N_USERINFO_ENTRY;
digester.addCallMethod(xp_info, "importUserInfo", 3);
digester.addCallParam(xp_info, 0, A_NAME);
digester.addCallParam(xp_info, 1, A_TYPE);
digester.addCallParam(xp_info, 2);
digester.addCallMethod(xp_user + N_USERROLES + "/" + N_USERROLE, "importUserRole", 0);
digester.addCallMethod(xp_user + N_USERGROUPS + "/" + N_USERGROUP, "importUserGroup", 0);
}
/**
* Adds the XML digester rules for projects.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addProjectRules(Digester digester, String xpath) {
digester.addCallMethod(xpath + N_NAME, "setProjectName", 0);
digester.addCallMethod(xpath + N_DESCRIPTION, "setProjectDescription", 0);
digester.addCallMethod(xpath + N_MANAGERSGROUP, "setProjectManagers", 0);
digester.addCallMethod(xpath + N_USERSGROUP, "setProjectUsers", 0);
digester.addCallMethod(xpath + N_RESOURCES + "/" + N_RESOURCE, "addProjectResource", 0);
digester.addCallMethod(xpath + N_RESOURCES, "importProject");
}
/**
* Adds the XML digester rules for resource access control entries.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addResourceAceRules(Digester digester, String xpath) {
String xp_ace = xpath + N_ACCESSCONTROL_ENTRIES + "/" + N_ACCESSCONTROL_ENTRY;
digester.addCallMethod(xpath + N_ACCESSCONTROL_ENTRIES, "importAccessControlEntries");
digester.addCallMethod(xp_ace, "addAccessControlEntry");
digester.addCallMethod(xp_ace + "/" + N_ACCESSCONTROL_PRINCIPAL, "setAcePrincipalId", 0);
digester.addCallMethod(xp_ace + "/" + N_FLAGS, "setAceFlags", 0);
String xp_perms = xp_ace + "/" + N_ACCESSCONTROL_PERMISSIONSET + "/";
digester.addCallMethod(xp_perms + N_ACCESSCONTROL_ALLOWEDPERMISSIONS, "setAcePermissionsAllowed", 0);
digester.addCallMethod(xp_perms + N_ACCESSCONTROL_DENIEDPERMISSIONS, "setAcePermissionsDenied", 0);
}
/**
* Adds the XML digester rules for resource attributes.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addResourceAttributesRules(Digester digester, String xpath) {
digester.addCallMethod(xpath + N_SOURCE, "setSource", 0);
digester.addCallMethod(xpath + N_DESTINATION, "setDestination", 0);
digester.addCallMethod(xpath + N_TYPE, "setType", 0);
digester.addCallMethod(xpath + N_UUIDSTRUCTURE, "setStructureId", 0);
digester.addCallMethod(xpath + N_UUIDRESOURCE, "setResourceId", 0);
digester.addCallMethod(xpath + N_DATELASTMODIFIED, "setDateLastModified", 0);
digester.addCallMethod(xpath + N_USERLASTMODIFIED, "setUserLastModified", 0);
digester.addCallMethod(xpath + N_DATECREATED, "setDateCreated", 0);
digester.addCallMethod(xpath + N_USERCREATED, "setUserCreated", 0);
digester.addCallMethod(xpath + N_DATERELEASED, "setDateReleased", 0);
digester.addCallMethod(xpath + N_DATEEXPIRED, "setDateExpired", 0);
digester.addCallMethod(xpath + N_FLAGS, "setFlags", 0);
}
/**
* Adds the XML digester rules for resource properties.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addResourcePropertyRules(Digester digester, String xpath) {
String xp_props = xpath + N_PROPERTIES + "/" + N_PROPERTY;
// first rule in case the type is implicit
digester.addCallMethod(xp_props, "addProperty");
// second rule in case the type is given
digester.addCallMethod(xp_props, "addProperty", 1);
digester.addCallParam(xp_props, 0, A_TYPE);
digester.addCallMethod(xp_props + "/" + N_NAME, "setPropertyName", 0);
digester.addCallMethod(xp_props + "/" + N_VALUE, "setPropertyValue", 0);
digester.addCallMethod(xpath + N_PROPERTIES, "importResource");
}
/**
* Adds the XML digester rules for resource relations.
*
* @param digester the digester to add the rules to
* @param xpath the base xpath for the rules
*/
protected void addResourceRelationRules(Digester digester, String xpath) {
String xp_rels = xpath + N_RELATIONS + "/" + N_RELATION;
digester.addCallMethod(xp_rels, "addRelation");
digester.addCallMethod(xp_rels + "/" + N_ID, "setRelationId", 0);
digester.addCallMethod(xp_rels + "/" + N_PATH, "setRelationPath", 0);
digester.addCallMethod(xp_rels + "/" + N_TYPE, "setRelationType", 0);
}
/**
* Checks if the resources is in the list of immutable resources.
*
* @param resourceName the name of the resource
*
* @return true or false
*/
protected boolean checkImmutable(String resourceName) {
boolean resourceImmutable = false;
if (getImmutableResources().contains(resourceName)) {
if (LOG.isDebugEnabled()) {
LOG.debug(
Messages.get().getBundle().key(Messages.LOG_IMPORTEXPORT_RESOURCENAME_IMMUTABLE_1, resourceName));
}
// this resource must not be modified by an import if it already exists
String storedSiteRoot = getCms().getRequestContext().getSiteRoot();
try {
getCms().getRequestContext().setSiteRoot("/");
getCms().readResource(resourceName);
resourceImmutable = true;
if (LOG.isDebugEnabled()) {
LOG.debug(
Messages.get().getBundle().key(Messages.LOG_IMPORTEXPORT_IMMUTABLE_FLAG_SET_1, resourceName));
}
} catch (CmsException e) {
// resourceNotImmutable will be true
if (LOG.isDebugEnabled()) {
LOG.debug(
Messages.get().getBundle().key(
Messages.LOG_IMPORTEXPORT_ERROR_ON_TEST_IMMUTABLE_1,
resourceName),
e);
}
} finally {
getCms().getRequestContext().setSiteRoot(storedSiteRoot);
}
}
return resourceImmutable;
}
/**
* Converts a given digest to base64 encoding.
*
* @param value the digest value in the legacy encoding
*
* @return the digest in the new encoding
*/
protected String convertDigestEncoding(String value) {
byte[] data = new byte[value.length() / 2];
for (int i = 0; i < data.length; i++) {
data[i] = (byte)(Integer.parseInt(value.substring(i * 2, (i * 2) + 2), 16) - 128);
}
return new String(Base64.encodeBase64(data));
}
/**
* Convert a given time stamp from a String format to a long value.
*
* The time stamp is either the string representation of a long value (old export format)
* or a user-readable string format.
*
* @param timestamp time stamp to convert
*
* @return long value of the time stamp
*/
protected long convertTimestamp(String timestamp) {
long value = 0;
// try to parse the time stamp string
// if it successes, its an old style long value
try {
value = Long.parseLong(timestamp);
} catch (@SuppressWarnings("unused") NumberFormatException e) {
// the time stamp was in in a user-readable string format, create the long value form it
try {
value = CmsDateUtil.parseHeaderDate(timestamp);
} catch (@SuppressWarnings("unused") ParseException pe) {
value = System.currentTimeMillis();
}
}
return value;
}
/**
* This method goes through the manifest, records all files from the manifest for which the content also
* exists in the zip file, and stores their resource ids in m_contentFiles.
*
* @throws CmsImportExportException thrown when the manifest.xml can't be opened as stream.
* @throws IOException thrown if the manifest.xml stream causes problems during parsing and/or closing.
* @throws SAXException thrown if parsing the manifest.xml fails
*/
protected void findContentFiles() throws CmsImportExportException, IOException, SAXException {
Digester digester = new Digester();
digester.setUseContextClassLoader(true);
digester.setValidating(false);
digester.setEntityResolver(new CmsXmlEntityResolver(null));
digester.setRuleNamespaceURI(null);
digester.setErrorHandler(new CmsXmlErrorHandler(CmsImportExportManager.EXPORT_MANIFEST));
digester.addCallMethod("export/files/file", "addContentFile", 2);
digester.addCallParam("export/files/file/source", 0);
digester.addCallParam("export/files/file/uuidresource", 1);
m_contentFiles.clear();
digester.push(this);
InputStream stream = null;
try {
stream = m_helper.getFileStream(CmsImportExportManager.EXPORT_MANIFEST);
digester.parse(stream);
} finally {
if (stream != null) {
stream.close();
}
}
}
/**
* Gets the import helper instance.
*
* @return the import helper
*/
protected CmsImportHelper getHelper() {
return m_helper;
}
/**
* Returns the list of properties to ignore during import.
*
* @return the list of properties to ignore during import
*/
protected List getIgnoredProperties() {
if (m_ignoredProperties == null) {
// get list of ignored properties
m_ignoredProperties = OpenCms.getImportExportManager().getIgnoredProperties();
if (m_ignoredProperties == null) {
m_ignoredProperties = Collections.emptyList();
}
}
return m_ignoredProperties;
}
/**
* Returns the list of immutable resources.
*
* @return the list of immutable resources
*/
protected List getImmutableResources() {
if (m_immutables == null) {
// get list of immutable resources
m_immutables = OpenCms.getImportExportManager().getImmutableResources();
if (m_immutables == null) {
m_immutables = Collections.emptyList();
}
if (LOG.isDebugEnabled()) {
LOG.debug(
Messages.get().getBundle().key(
Messages.LOG_IMPORTEXPORT_IMMUTABLE_RESOURCES_SIZE_1,
Integer.toString(m_immutables.size())));
}
}
return m_immutables;
}
/**
* Sorts the parsealble resources before we actually parse the links.
*
* This is needed because we may, for example, have resources A and B such that A has a link to B, and B requires
* the relation corresponding to that link to be present for some functionality (e.g. the page_title macro in gallery name
* mappings), so we need to parse the links for A first to create the relation before B is processed.
*
* @param parseables the list of parseable resources which should be sorted in place
*
*/
protected void sortParseableResources(List parseables) {
Collections.sort(parseables, new Comparator() {
public int compare(CmsResource a, CmsResource b) {
return ComparisonChain.start().compare(getRank(a), getRank(b)).compare(
a.getRootPath(),
b.getRootPath()).result();
}
int getRank(CmsResource res) {
if (CmsResourceTypeXmlContainerPage.isContainerPage(res)) {
return 0;
} else {
return 1;
}
}
});
}
/**
* Checks whether the content for the resource being imported exists either in the VFS or in the import file.
*
* @param resource the resource which should be checked
*
* @return true if the content exists in the VFS or import file
*/
private boolean hasContentInVfsOrImport(CmsResource resource) {
if (m_contentFiles.contains(resource.getResourceId())) {
return true;
}
try {
List resources = getCms().readSiblings(resource, CmsResourceFilter.ALL);
if (!resources.isEmpty()) {
return true;
}
} catch (CmsException e) {
LOG.warn(e.getLocalizedMessage(), e);
}
return false;
}
/**
* Parses the links.
*
* @param cms the CMS context to use
* @param report the report
*/
private void parseLinks(CmsObject cms, I_CmsReport report) {
int i = 0;
sortParseableResources(m_parseables);
for (CmsResource parsableRes : m_parseables) {
String resName = cms.getSitePath(parsableRes);
report.print(
org.opencms.report.Messages.get().container(
org.opencms.report.Messages.RPT_SUCCESSION_2,
String.valueOf(i + 1),
String.valueOf(m_parseables.size())),
I_CmsReport.FORMAT_NOTE);
LOG.info("Rewriting parsable resource: " + resName);
report.print(Messages.get().container(Messages.RPT_PARSE_LINKS_FOR_1, resName), I_CmsReport.FORMAT_NOTE);
report.print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));
try {
CmsFile file = cms.readFile(resName);
// make sure the date last modified is kept...
file.setDateLastModified(file.getDateLastModified());
// make sure the file is locked
CmsLock lock = cms.getLock(file);
if (lock.isUnlocked()) {
cms.lockResource(resName);
} else if (!lock.isDirectlyOwnedInProjectBy(cms)) {
cms.changeLock(resName);
}
// rewrite the file
cms.writeFile(file);
report.println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
} catch (Throwable e) {
report.addWarning(e);
report.println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_FAILED_0),
I_CmsReport.FORMAT_ERROR);
if (LOG.isWarnEnabled()) {
LOG.warn(Messages.get().getBundle().key(Messages.LOG_IMPORTEXPORT_REWRITING_1, resName));
LOG.warn(e.getMessage(), e);
}
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
i++;
}
cms.getRequestContext().removeAttribute(CmsLogEntry.ATTR_LOG_ENTRY);
}
}