blob: c614f31efb59da56f166c3c386dc531b48e48842 [file] [log] [blame]
/*
* Copyright 1999-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.lenya.cms.publication.templating;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.avalon.framework.logger.Logger;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.avalon.framework.service.ServiceSelector;
import org.apache.avalon.framework.service.Serviceable;
import org.apache.excalibur.source.Source;
import org.apache.excalibur.source.SourceResolver;
import org.apache.lenya.cms.repo.Publication;
import org.apache.lenya.cms.repo.RepositoryException;
/**
* Manager for publication templates.
*
* @version $Id$
*/
public class PublicationTemplateManagerImpl extends AbstractLogEnabled implements
PublicationTemplateManager, Serviceable {
/**
* Ctor.
*/
public PublicationTemplateManagerImpl() {
}
/**
* @see org.apache.lenya.cms.publication.templating.PublicationTemplateManager#visit(org.apache.lenya.cms.repo.Publication,
* java.lang.String, org.apache.lenya.cms.publication.templating.SourceVisitor)
*/
public void visit(Publication publication, String path, SourceVisitor visitor) {
SourceResolver resolver = null;
try {
resolver = (SourceResolver) this.manager.lookup(SourceResolver.ROLE);
String[] baseUris = getBaseURIs(publication);
for (int i = 0; i < baseUris.length; i++) {
String uri = baseUris[i] + "/" + path;
if (getLogger().isDebugEnabled()) {
getLogger().debug("Trying to resolve URI [" + uri + "]");
}
Source source = null;
try {
source = resolver.resolveURI(uri);
visitor.visit(source);
} catch (Exception e) {
getLogger().error("Could not resolve URI [" + uri + "]: ", e);
throw e;
} finally {
if (source != null) {
resolver.release(source);
}
}
}
} catch (Exception e) {
throw new TemplatingException("Visiting path [" + path + "] failed: ", e);
} finally {
if (resolver != null) {
this.manager.release(resolver);
}
}
}
private ServiceManager manager;
/**
* @see org.apache.avalon.framework.service.Serviceable#service(org.apache.avalon.framework.service.ServiceManager)
*/
public void service(ServiceManager _manager) throws ServiceException {
this.manager = _manager;
}
/**
* Returns the publication.
* @return A publication. protected Publication getPublication1() { return this.publication; }
*/
/**
* Returns the base URIs in traversing order.
* @param publication The original publication.
* @return An array of strings.
*/
protected String[] getBaseURIs(Publication publication) {
List uris = new ArrayList();
Publication[] publications = getPublications(publication);
for (int i = 0; i < publications.length; i++) {
uris.add(getBaseURI(publications[i]));
}
String coreBaseURI = "context://";
uris.add(coreBaseURI);
return (String[]) uris.toArray(new String[uris.size()]);
}
/**
* Returns the base URI for a certain publication.
* @param publication The publication.
* @return A string.
*/
public static String getBaseURI(Publication publication) {
try {
return "context://lenya/pubs/" + publication.getPublicationId();
} catch (RepositoryException e) {
throw new RuntimeException(e);
}
}
/**
* @see org.apache.lenya.cms.publication.templating.PublicationTemplateManager#visit(org.apache.lenya.cms.repo.Publication,
* org.apache.lenya.cms.publication.templating.PublicationVisitor)
*/
public void visit(Publication publication, PublicationVisitor visitor) {
SourceResolver resolver = null;
try {
resolver = (SourceResolver) this.manager.lookup(SourceResolver.ROLE);
Publication[] publications = getPublications(publication);
for (int i = 0; i < publications.length; i++) {
if (getLogger().isDebugEnabled()) {
getLogger().debug("Visiting publication [" + publications[i] + "]");
}
visitor.visit(publications[i]);
}
} catch (Exception e) {
throw new TemplatingException("Visiting publications failed: ", e);
} finally {
if (resolver != null) {
this.manager.release(resolver);
}
}
}
/**
* Returns the publications in traversing order.
* @param publication The original publication.
* @return An array of strings.
*/
protected Publication[] getPublications(Publication publication) {
List publications = new ArrayList();
publications.add(publication);
String[] templateIds = publication.getTemplateIds();
for (int i = 0; i < templateIds.length; i++) {
try {
Publication template = publication.getSession().getPublication(templateIds[i]);
Publication[] templateTemplates = getPublications(template);
publications.addAll(Arrays.asList(templateTemplates));
} catch (RepositoryException e) {
throw new RuntimeException(e);
}
}
return (Publication[]) publications.toArray(new Publication[publications.size()]);
}
/**
* @see org.apache.lenya.cms.publication.templating.PublicationTemplateManager#getSelectableHint(org.apache.lenya.cms.repo.Publication,
* org.apache.avalon.framework.service.ServiceSelector, java.lang.String)
*/
public Object getSelectableHint(Publication publication, ServiceSelector selector,
final String originalHint) throws ServiceException {
PublicationTemplateManager templateManager = null;
Object selectableHint = null;
try {
ExistingServiceVisitor resolver = new ExistingServiceVisitor(selector,
originalHint,
getLogger());
visit(publication, resolver);
selectableHint = resolver.getSelectableHint();
if (selectableHint == null) {
selectableHint = originalHint;
}
} catch (Exception e) {
String message = "Resolving hint [" + originalHint + "] failed: ";
getLogger().error(message, e);
throw new RuntimeException(message, e);
} finally {
if (templateManager != null) {
this.manager.release(templateManager);
}
}
return selectableHint;
}
/**
* Searches for a declared service of the form "publicationId/service".
*/
public class ExistingServiceVisitor implements PublicationVisitor {
/**
* Ctor.
* @param selector The service selector to use.
* @param hint The hint to check.
* @param logger The logger.
*/
public ExistingServiceVisitor(ServiceSelector selector, Object hint, Logger logger) {
this.selector = selector;
this.hint = hint;
this.logger = logger;
}
private ServiceSelector selector;
private Object hint;
private Object selectableHint = null;
private Logger logger;
/**
* @see org.apache.lenya.cms.publication.templating.PublicationVisitor#visit(org.apache.lenya.cms.repo.Publication)
*/
public void visit(Publication publication) {
String publicationHint;
try {
publicationHint = publication.getPublicationId() + "/" + this.hint;
} catch (RepositoryException e) {
throw new RuntimeException(e);
}
boolean success = false;
if (this.selector.isSelectable(publicationHint)) {
this.selectableHint = publicationHint;
success = true;
}
if (this.logger.isDebugEnabled()) {
this.logger.debug("Checking hint [" + publicationHint + "]: " + success);
}
}
/**
* @return The publication hint that could be selected or <code>null</code> if no hint
* could be selected.
*/
public Object getSelectableHint() {
return this.selectableHint;
}
}
}