/*
<License>
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Lenya" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Michael Wechner <michi@apache.org>. For more information on the Apache Soft-
ware Foundation, please see <http://www.apache.org/>.
Lenya includes software developed by the Apache Software Foundation, W3C,
DOM4J Project, BitfluxEditor, Xopus, and WebSHPINX.
</License>
*/
package org.apache.lenya.cms.publication;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
import org.apache.lenya.cms.publishing.PublishingEnvironment;
import org.apache.log4j.Category;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
/**
* A publication.
*
* @author <a href="mailto:andreas.hartmann@wyona.org">Andreas Hartmann</a>
* @version $Id: AbstractPublication.java,v 1.11 2004/01/19 18:00:48 andreas Exp $
*/
public abstract class AbstractPublication implements Publication {
private static Category log = Category.getInstance(AbstractPublication.class);
private static final String[] areas =
{ AUTHORING_AREA, STAGING_AREA, LIVE_AREA, ADMIN_AREA, ARCHIVE_AREA, TRASH_AREA };
private String id;
private PublishingEnvironment environment;
private File servletContext;
private DocumentIdToPathMapper mapper = null;
private ArrayList languages = new ArrayList();
private String defaultLanguage = null;
private String breadcrumbprefix = null;
private HashMap siteTrees = new HashMap();
private boolean hasSitetree = true;
/**
* Creates a new instance of Publication
*
* @param id the publication id
* @param servletContextPath the servlet context of this publication
*
* @throws PublicationException if there was a problem reading the config file
*/
protected AbstractPublication(String id, String servletContextPath)
throws PublicationException {
assert id != null;
this.id = id;
assert servletContextPath != null;
File servletContext = new File(servletContextPath);
assert servletContext.exists();
this.servletContext = servletContext;
// FIXME: remove PublishingEnvironment from publication
environment = new PublishingEnvironment(servletContextPath, id);
File configFile = new File(getDirectory(), CONFIGURATION_FILE);
DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder();
Configuration config;
String pathMapperClassName = null;
String documentBuilderClassName = null;
try {
config = builder.buildFromFile(configFile);
try {
pathMapperClassName = config.getChild(ELEMENT_PATH_MAPPER).getValue();
Class pathMapperClass = Class.forName(pathMapperClassName);
this.mapper = (DocumentIdToPathMapper) pathMapperClass.newInstance();
} catch (ClassNotFoundException e) {
throw new PublicationException(
"Cannot instantiate documentToPathMapper: [" + pathMapperClassName + "]",
e);
}
try {
Configuration documentBuilderConfiguration =
config.getChild(ELEMENT_DOCUMENT_BUILDER, false);
if (documentBuilderConfiguration != null) {
documentBuilderClassName = documentBuilderConfiguration.getValue();
Class documentBuilderClass = Class.forName(documentBuilderClassName);
this.documentBuilder = (DocumentBuilder) documentBuilderClass.newInstance();
}
} catch (ClassNotFoundException e) {
throw new PublicationException(
"Cannot instantiate document builder: [" + pathMapperClassName + "]",
e);
}
Configuration[] languages = config.getChild(LANGUAGES).getChildren();
for (int i = 0; i < languages.length; i++) {
Configuration languageConfig = languages[i];
String language = languageConfig.getValue();
this.languages.add(language);
if (languageConfig.getAttribute(DEFAULT_LANGUAGE_ATTR, null) != null) {
defaultLanguage = language;
}
}
Configuration siteStructureConfiguration =
config.getChild(ELEMENT_SITE_STRUCTURE, false);
if (siteStructureConfiguration != null) {
String siteStructureType = siteStructureConfiguration.getAttribute(ATTRIBUTE_TYPE);
if (!siteStructureType.equals("sitetree")) {
hasSitetree = false;
}
}
} catch (PublicationException e) {
throw e;
} catch (Exception e) {
log.error(e);
throw new PublicationException("Problem with config file: " + configFile.getAbsolutePath(), e);
}
breadcrumbprefix = config.getChild(BREADCRUMB_PREFIX).getValue("");
}
/**
* Returns the publication ID.
* @return A string value.
*/
public String getId() {
return id;
}
/**
* Returns the publishing environment of this publication.
* @return A {@link PublishingEnvironment} object.
* @deprecated It is planned to decouple the environments from the publication.
*/
public PublishingEnvironment getEnvironment() {
return environment;
}
/**
* Returns the servlet context this publication belongs to
* (usually, the <code>webapps/lenya</code> directory).
* @return A <code>File</code> object.
*/
public File getServletContext() {
return servletContext;
}
/**
* Returns the publication directory.
* @return A <code>File</code> object.
*/
public File getDirectory() {
return new File(getServletContext(), PUBLICATION_PREFIX + File.separator + getId());
}
/**
* Return the directory of a specific area.
*
* @param area a <code>File</code> representing the root of the area content directory.
*
* @return the directory of the given content area.
*/
public File getContentDirectory(String area) {
return new File(getDirectory(), CONTENT_PATH + File.separator + area);
}
/**
* DOCUMENT ME!
*
* @param mapper DOCUMENT ME!
*/
public void setPathMapper(DefaultDocumentIdToPathMapper mapper) {
assert mapper != null;
this.mapper = mapper;
}
/**
* Returns the path mapper.
*
* @return a <code>DocumentIdToPathMapper</code>
*/
public DocumentIdToPathMapper getPathMapper() {
return mapper;
}
/**
* Returns if a given string is a valid area name.
* @param area The area string to test.
* @return A boolean value.
*/
public static boolean isValidArea(String area) {
return area != null && Arrays.asList(areas).contains(area);
}
/**
* Get the default language
*
* @return the default language
*/
public String getDefaultLanguage() {
return defaultLanguage;
}
/**
* Set the default language
*
* @param language the default language
*/
public void setDefaultLanguage(String language) {
defaultLanguage = language;
}
/**
* Get all available languages for this publication
*
* @return an <code>Array</code> of languages
*/
public String[] getLanguages() {
return (String[]) languages.toArray(new String[languages.size()]);
}
/**
* Get the breadcrumb prefix. It can be used as a prefix if a publication is part of a larger site
*
* @return the breadcrumb prefix
*/
public String getBreadcrumbPrefix() {
return breadcrumbprefix;
}
/**
* Get the sitetree for a specific area of this publication.
* Sitetrees are created on demand and are cached.
*
* @param area the area
* @return the sitetree for the specified area
*
* @throws SiteTreeException if an error occurs
*/
public DefaultSiteTree getSiteTree(String area) throws SiteTreeException {
DefaultSiteTree sitetree = null;
if (hasSitetree) {
if (siteTrees.containsKey(area)) {
sitetree = (DefaultSiteTree) siteTrees.get(area);
} else {
sitetree = new DefaultSiteTree(getDirectory(), area);
siteTrees.put(area, sitetree);
}
}
return sitetree;
}
private DocumentBuilder documentBuilder;
/**
* Returns the document builder of this instance.
* @return A document builder.
*/
public DocumentBuilder getDocumentBuilder() {
if (documentBuilder == null) {
throw new IllegalStateException("The document builder was not defined in publication.xconf!");
}
return documentBuilder;
}
/**
* Creates a version of the document object in another area.
* @param document The document to clone.
* @param area The destination area.
* @return A document.
* @throws PublicationException when an error occurs.
*/
public Document getAreaVersion(Document document, String area) throws PublicationException {
DocumentBuilder builder = getDocumentBuilder();
String url =
builder.buildCanonicalUrl(this, area, document.getId(), document.getLanguage());
Document destinationDocument = builder.buildDocument(this, url);
return destinationDocument;
}
/**
* This method does not use the sitetree object, but it calculates the
* parent using the document ID. The reason for this is that the
* actual documents don't have to exist.
* @see org.apache.lenya.cms.publication.Publication#getRequiredDocuments(org.apache.lenya.cms.publication.Document)
*/
public Document[] getRequiredDocuments(Document document) throws PublicationException {
Document[] documents;
// remove leading slash
String id = document.getId().substring(1);
int slashIndex = id.lastIndexOf("/");
if (slashIndex == -1) {
documents = new Document[0];
} else {
String parentId = "/" + id.substring(0, slashIndex);
String parentUrl =
getDocumentBuilder().buildCanonicalUrl(
this,
document.getArea(),
parentId,
document.getLanguage());
Document parent = getDocumentBuilder().buildDocument(this, parentUrl);
documents = new Document[1];
documents[0] = parent;
}
return documents;
}
/**
* @see org.apache.lenya.cms.publication.Publication#dependsOn(org.apache.lenya.cms.publication.Document, org.apache.lenya.cms.publication.Document)
*/
public boolean dependsOn(Document dependingDocument, Document requiredDocument)
throws PublicationException {
Document[] requiredDocuments = getRequiredDocuments(dependingDocument);
List requiredList = Arrays.asList(requiredDocuments);
return requiredList.contains(requiredDocument);
}
/**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals(Object object) {
boolean equals = false;
if (getClass().isInstance(object)) {
Publication publication = (Publication) object;
equals =
getId().equals(publication.getId())
&& getServletContext().equals(publication.getServletContext());
}
return equals;
}
/**
* @see java.lang.Object#hashCode()
*/
public int hashCode() {
String key = getServletContext() + ":" + getId();
return key.hashCode();
}
/**
* Template method to copy a document. Override {@link #copyDocumentSource(Document, Document)}
* to implement access to a custom repository.
* @see org.apache.lenya.cms.publication.Publication#copyDocument(org.apache.lenya.cms.publication.Document, org.apache.lenya.cms.publication.Document)
*/
public void copyDocument(Document sourceDocument, Document destinationDocument)
throws PublicationException {
copyDocumentSource(sourceDocument, destinationDocument);
copySiteStructure(sourceDocument, destinationDocument);
}
/**
* Copies a document in the site structure.
* @param sourceDocument The source document.
* @param destinationDocument The destination document.
* @throws PublicationException when something went wrong.
*/
protected void copySiteStructure(Document sourceDocument, Document destinationDocument)
throws PublicationException {
if (hasSitetree) {
try {
SiteTree sourceTree = getSiteTree(sourceDocument.getArea());
SiteTree destinationTree = getSiteTree(destinationDocument.getArea());
SiteTreeNode sourceNode = sourceTree.getNode(sourceDocument.getId());
if (sourceNode == null) {
throw new PublicationException(
"The node for source document ["
+ sourceDocument.getId()
+ "] doesn't exist!");
} else {
SiteTreeNode[] siblings = sourceNode.getNextSiblings();
String parentId = sourceNode.getAbsoluteParentId();
SiteTreeNode sibling = null;
String siblingDocId = null;
// same document ID -> insert at the same position
if (sourceDocument.getId().equals(destinationDocument.getId())) {
for (int i = 0; i < siblings.length; i++) {
String docId = parentId + "/" + siblings[i].getId();
sibling = destinationTree.getNode(docId);
if (sibling != null) {
siblingDocId = docId;
break;
}
}
}
Label label = sourceNode.getLabel(sourceDocument.getLanguage());
if (label == null) {
// the node that we're trying to publish
// doesn't have this language
throw new PublicationException(
"The node "
+ sourceDocument.getId()
+ " doesn't contain a label for language "
+ sourceDocument.getLanguage());
} else {
SiteTreeNode destinationNode =
destinationTree.getNode(destinationDocument.getId());
if (destinationNode == null) {
Label[] labels = { label };
if (siblingDocId == null) {
destinationTree.addNode(
destinationDocument.getId(),
labels,
sourceNode.getHref(),
sourceNode.getSuffix(),
sourceNode.hasLink());
} else {
destinationTree.addNode(
destinationDocument.getId(),
labels,
sourceNode.getHref(),
sourceNode.getSuffix(),
sourceNode.hasLink(),
siblingDocId);
}
} else {
// if the node already exists in the live
// tree simply insert the label in the
// live tree
destinationTree.setLabel(destinationDocument.getId(), label);
}
}
}
destinationTree.save();
} catch (SiteTreeException e) {
throw new PublicationException(e);
}
}
}
/**
* Copies a document source.
* @param sourceDocument The source document.
* @param destinationDocument The destination document.
* @throws PublicationException when something went wrong.
*/
protected abstract void copyDocumentSource(
Document sourceDocument,
Document destinationDocument)
throws PublicationException;
/**
* @see org.apache.lenya.cms.publication.Publication#deleteDocument(org.apache.lenya.cms.publication.Document)
*/
public void deleteDocument(Document document) throws PublicationException {
if (!document.exists()) {
throw new PublicationException(
"Document [" + document + "] does not exist!");
}
deleteFromSiteStructure(document);
deleteDocumentSource(document);
}
/**
* Deletes a document from the site structure.
* @param document The document to remove.
* @throws PublicationException when something went wrong.
*/
protected void deleteFromSiteStructure(Document document) throws PublicationException {
if (hasSitetree) {
SiteTree tree;
try {
tree = getSiteTree(document.getArea());
} catch (SiteTreeException e) {
throw new PublicationException(e);
}
SiteTreeNode node = tree.getNode(document.getId());
if (node == null) {
throw new PublicationException(
"Sitetree node for document [" + document + "] does not exist!");
}
Label label = node.getLabel(document.getLanguage());
if (label == null) {
throw new PublicationException(
"Sitetree label for document ["
+ document
+ "] in language ["
+ document.getLanguage()
+ "]does not exist!");
}
if (node.getLabels().length == 1 && node.getChildren().length > 0) {
throw new PublicationException(
"Cannot delete last language version of document ["
+ document
+ "] because this node has children.");
}
node.removeLabel(label);
if (node.getLabels().length == 0) {
tree.removeNode(document.getId());
}
try {
tree.save();
} catch (SiteTreeException e) {
throw new PublicationException(e);
}
}
}
/**
* Deletes the source of a document.
* @param document The document to delete.
* @throws PublicationException when something went wrong.
*/
protected abstract void deleteDocumentSource(Document document) throws PublicationException;
/**
* @see org.apache.lenya.cms.publication.Publication#moveDocument(org.apache.lenya.cms.publication.Document, org.apache.lenya.cms.publication.Document)
*/
public void moveDocument(Document sourceDocument, Document destinationDocument)
throws PublicationException {
copyDocument(sourceDocument, destinationDocument);
deleteDocument(sourceDocument);
}
}