org.opencms.importexport.CmsImportVersion5 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.CmsParameterConfiguration;
import org.opencms.file.CmsFile;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProperty;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.types.CmsResourceTypePlain;
import org.opencms.file.types.I_CmsResourceType;
import org.opencms.i18n.CmsMessageContainer;
import org.opencms.loader.CmsLoaderException;
import org.opencms.main.CmsException;
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.CmsRole;
import org.opencms.security.I_CmsPasswordHandler;
import org.opencms.security.I_CmsPrincipal;
import org.opencms.util.CmsDateUtil;
import org.opencms.util.CmsUUID;
import org.opencms.xml.CmsXmlException;
import org.opencms.xml.CmsXmlUtils;
import java.io.File;
import java.io.IOException;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.zip.ZipFile;
import org.apache.commons.logging.Log;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.Node;
/**
* Implementation of the OpenCms Import Interface ({@link org.opencms.importexport.I_CmsImport}) for
* the import version 5.
*
* This import format is used in OpenCms since 6.3.0.
*
* @since 6.3.0
*
* @see org.opencms.importexport.A_CmsImport
*
* @deprecated this import class is no longer in use and should only be used to import old export files
*/
@Deprecated
public class CmsImportVersion5 extends A_CmsImport {
/** The version number of this import implementation.
*/
public static final int IMPORT_VERSION = 5;
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsImportVersion5.class);
/** Stores all relations defined in the import file to be created after all resources has been imported. */
protected Map> m_importedRelations;
/** Stores all resources of any type that implements the {@link I_CmsLinkParseable} interface. */
protected List m_parseables;
/** The keep permissions flag. */
protected boolean m_keepPermissions;
/**
* Creates a new CmsImportVerion7 object.
*/
public CmsImportVersion5() {
m_convertToXmlPage = true;
}
/**
* @see org.opencms.importexport.I_CmsImport#getVersion()
*/
public int getVersion() {
return CmsImportVersion5.IMPORT_VERSION;
}
/**
* @see org.opencms.importexport.I_CmsImport#importData(CmsObject, I_CmsReport, CmsImportParameters)
*/
public void importData(CmsObject cms, I_CmsReport report, CmsImportParameters params)
throws CmsImportExportException, CmsXmlException {
// initialize the import
initialize();
m_cms = cms;
m_importPath = params.getDestinationPath();
m_report = report;
m_keepPermissions = params.isKeepPermissions();
m_linkStorage = new HashMap();
m_linkPropertyStorage = new HashMap>();
m_parseables = new ArrayList();
m_importedRelations = new HashMap>();
CmsImportHelper helper = new CmsImportHelper(params);
try {
helper.openFile();
m_importResource = helper.getFolder();
m_importZip = helper.getZipFile();
m_docXml = CmsXmlUtils.unmarshalHelper(helper.getFileBytes(CmsImportExportManager.EXPORT_MANIFEST), null);
// first import the user information
if (OpenCms.getRoleManager().hasRole(m_cms, CmsRole.ACCOUNT_MANAGER)) {
importGroups();
importUsers();
}
// now import the VFS resources
readResourcesFromManifest();
convertPointerToSiblings();
rewriteParseables();
importRelations();
} catch (IOException 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 {
helper.closeFile();
cleanUp();
}
}
/**
* @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)
throws CmsImportExportException {
CmsImportParameters params = new CmsImportParameters(
importResource != null ? importResource.getAbsolutePath() : importZip.getName(),
importPath,
false);
try {
importData(cms, report, params);
} catch (CmsXmlException e) {
throw new CmsImportExportException(e.getMessageContainer(), e);
}
}
/**
* 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 (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 (ParseException pe) {
value = System.currentTimeMillis();
}
}
return value;
}
/**
* Imports the relations.
*/
protected void importRelations() {
if (m_importedRelations.isEmpty()) {
return;
}
m_report.println(Messages.get().container(Messages.RPT_START_IMPORT_RELATIONS_0), I_CmsReport.FORMAT_HEADLINE);
int i = 0;
Iterator>> it = m_importedRelations.entrySet().iterator();
while (it.hasNext()) {
Entry> entry = it.next();
String resourcePath = entry.getKey();
List relations = entry.getValue();
m_report.print(
org.opencms.report.Messages.get().container(
org.opencms.report.Messages.RPT_SUCCESSION_2,
String.valueOf(i + 1),
String.valueOf(m_importedRelations.size())),
I_CmsReport.FORMAT_NOTE);
m_report.print(
Messages.get().container(
Messages.RPT_IMPORTING_RELATIONS_FOR_2,
resourcePath,
new Integer(relations.size())),
I_CmsReport.FORMAT_NOTE);
m_report.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
m_cms.importRelation(
m_cms.getSitePath(relation.getSource(m_cms, CmsResourceFilter.ALL)),
m_cms.getSitePath(relation.getTarget(m_cms, CmsResourceFilter.ALL)),
relation.getType().getName());
} catch (CmsException e) {
m_report.addWarning(e);
withErrors = true;
if (LOG.isWarnEnabled()) {
LOG.warn(e.getLocalizedMessage());
}
if (LOG.isDebugEnabled()) {
LOG.debug(e.getLocalizedMessage(), e);
}
}
}
if (!withErrors) {
m_report.println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
} else {
m_report.println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_FAILED_0),
I_CmsReport.FORMAT_ERROR);
}
i++;
}
m_report.println(Messages.get().container(Messages.RPT_END_IMPORT_RELATIONS_0), I_CmsReport.FORMAT_HEADLINE);
}
/**
* Reads all the relations of the resource from the manifest.xml
file
* and adds them to the according resource.
*
* @param resource the resource to import the relations for
* @param parentElement the current element
*/
protected void importRelations(CmsResource resource, Element parentElement) {
// Get the nodes for the relations
@SuppressWarnings("unchecked")
List relationElements = parentElement.selectNodes(
"./" + A_CmsImport.N_RELATIONS + "/" + A_CmsImport.N_RELATION);
List relations = new ArrayList();
// iterate over the nodes
Iterator itRelations = relationElements.iterator();
while (itRelations.hasNext()) {
Element relationElement = (Element)itRelations.next();
String structureID = getChildElementTextValue(relationElement, A_CmsImport.N_RELATION_ATTRIBUTE_ID);
String targetPath = getChildElementTextValue(relationElement, A_CmsImport.N_RELATION_ATTRIBUTE_PATH);
String relationType = getChildElementTextValue(relationElement, A_CmsImport.N_RELATION_ATTRIBUTE_TYPE);
CmsUUID targetId = new CmsUUID(structureID);
CmsRelationType type = CmsRelationType.valueOf(relationType);
CmsRelation relation = new CmsRelation(
resource.getStructureId(),
resource.getRootPath(),
targetId,
targetPath,
type);
relations.add(relation);
}
if (!relations.isEmpty()) {
m_importedRelations.put(resource.getRootPath(), relations);
}
}
/**
* Imports a resource (file or folder) into the cms.
*
* @param source the path to the source-file
* @param destination the path to the destination-file in the cms
* @param type the resource type name of the file
* @param uuidstructure the structure uuid of the resource
* @param uuidresource the resource uuid of the resource
* @param datelastmodified the last modification date of the resource
* @param userlastmodified the user who made the last modifications to the resource
* @param datecreated the creation date of the resource
* @param usercreated the user who created
* @param datereleased the release date of the resource
* @param dateexpired the expire date of the resource
* @param flags the flags of the resource
* @param properties a list with properties for this resource
*
* @return imported resource
*/
protected CmsResource importResource(
String source,
String destination,
I_CmsResourceType type,
String uuidstructure,
String uuidresource,
long datelastmodified,
String userlastmodified,
long datecreated,
String usercreated,
long datereleased,
long dateexpired,
String flags,
List properties) {
byte[] content = null;
CmsResource result = null;
try {
// get the file content
if (source != null) {
content = getFileBytes(source);
}
int size = 0;
if (content != null) {
size = content.length;
}
// get UUIDs for the user
CmsUUID newUserlastmodified;
CmsUUID newUsercreated;
// check if user created and user last modified are valid users in this system.
// if not, use the current user
try {
newUserlastmodified = m_cms.readUser(userlastmodified).getId();
} catch (CmsException e) {
newUserlastmodified = m_cms.getRequestContext().getCurrentUser().getId();
// datelastmodified = System.currentTimeMillis();
}
try {
newUsercreated = m_cms.readUser(usercreated).getId();
} catch (CmsException e) {
newUsercreated = m_cms.getRequestContext().getCurrentUser().getId();
// datecreated = System.currentTimeMillis();
}
// get UUID for the structure
CmsUUID newUuidstructure = null;
if (uuidstructure != null) {
// create a UUID from the provided string
newUuidstructure = new CmsUUID(uuidstructure);
} else {
// if null generate a new structure id
newUuidstructure = new CmsUUID();
}
// get UUIDs for the resource and content
CmsUUID newUuidresource = null;
if ((uuidresource != null) && (!type.isFolder())) {
// create a UUID from the provided string
newUuidresource = new CmsUUID(uuidresource);
} else {
// folders get always a new resource record UUID
newUuidresource = new CmsUUID();
}
// create a new CmsResource
CmsResource resource = new CmsResource(
newUuidstructure,
newUuidresource,
destination,
type.getTypeId(),
type.isFolder(),
new Integer(flags).intValue(),
m_cms.getRequestContext().getCurrentProject().getUuid(),
CmsResource.STATE_NEW,
datecreated,
newUsercreated,
datelastmodified,
newUserlastmodified,
datereleased,
dateexpired,
1,
size,
System.currentTimeMillis(),
0);
// import this resource in the VFS
result = m_cms.importResource(destination, resource, content, properties);
if (result != null) {
m_report.println(
org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
I_CmsReport.FORMAT_OK);
}
} catch (Exception exc) {
// an error while importing the file
m_report.println(exc);
try {
// Sleep some time after an error so that the report output has a chance to keep up
Thread.sleep(1000);
} catch (Exception e) {
//
}
}
return result;
}
/**
* @see org.opencms.importexport.A_CmsImport#importUser(String, String, String, String, String, String, long, Map, List)
*/
@Override
protected void importUser(
String name,
String flags,
String password,
String firstname,
String lastname,
String email,
long dateCreated,
Map userInfo,
List userGroups)
throws CmsImportExportException {
boolean convert = false;
CmsParameterConfiguration config = OpenCms.getPasswordHandler().getConfiguration();
if ((config != null) && config.containsKey(I_CmsPasswordHandler.CONVERT_DIGEST_ENCODING)) {
convert = config.getBoolean(I_CmsPasswordHandler.CONVERT_DIGEST_ENCODING, false);
}
if (convert) {
password = convertDigestEncoding(password);
}
super.importUser(name, flags, password, firstname, lastname, email, dateCreated, userInfo, userGroups);
}
/**
* Reads all file nodes plus their meta-information (properties, ACL)
* from the manifest.xml
and imports them as Cms resources to the VFS.
*
* @throws CmsImportExportException if something goes wrong
*/
@SuppressWarnings("unchecked")
protected void readResourcesFromManifest() throws CmsImportExportException {
String source = null, destination = null, uuidstructure = null, uuidresource = null, userlastmodified = null,
usercreated = null, flags = null, timestamp = null;
long datelastmodified = 0, datecreated = 0, datereleased = 0, dateexpired = 0;
List fileNodes = null, acentryNodes = null;
Element currentElement = null, currentEntry = null;
List properties = null;
// get list of immutable resources
List immutableResources = OpenCms.getImportExportManager().getImmutableResources();
if (immutableResources == null) {
immutableResources = Collections.emptyList();
}
if (LOG.isDebugEnabled()) {
LOG.debug(
Messages.get().getBundle().key(
Messages.LOG_IMPORTEXPORT_IMMUTABLE_RESOURCES_SIZE_1,
Integer.toString(immutableResources.size())));
}
// get list of ignored properties
List ignoredProperties = OpenCms.getImportExportManager().getIgnoredProperties();
if (ignoredProperties == null) {
ignoredProperties = Collections.emptyList();
}
// get the desired page type for imported pages
m_convertToXmlPage = OpenCms.getImportExportManager().convertToXmlPage();
try {
// get all file-nodes
fileNodes = m_docXml.selectNodes("//" + A_CmsImport.N_FILE);
int importSize = fileNodes.size();
// walk through all files in manifest
for (int i = 0; i < fileNodes.size(); i++) {
m_report.print(
org.opencms.report.Messages.get().container(
org.opencms.report.Messages.RPT_SUCCESSION_2,
String.valueOf(i + 1),
String.valueOf(importSize)),
I_CmsReport.FORMAT_NOTE);
currentElement = (Element)fileNodes.get(i);
//