| /* |
| * 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.cocoon.transformation; |
| |
| import java.io.IOException; |
| import java.util.Map; |
| |
| import org.apache.avalon.framework.activity.Disposable; |
| import org.apache.avalon.framework.parameters.Parameters; |
| import org.apache.avalon.framework.service.ServiceException; |
| import org.apache.avalon.framework.service.ServiceSelector; |
| import org.apache.cocoon.ProcessingException; |
| import org.apache.cocoon.environment.ObjectModelHelper; |
| import org.apache.cocoon.environment.Request; |
| import org.apache.cocoon.environment.SourceResolver; |
| import org.apache.cocoon.transformation.AbstractSAXTransformer; |
| import org.apache.lenya.ac.AccessControlException; |
| import org.apache.lenya.ac.AccessController; |
| import org.apache.lenya.ac.AccessControllerResolver; |
| import org.apache.lenya.ac.AccreditableManager; |
| import org.apache.lenya.ac.Authorizer; |
| import org.apache.lenya.ac.Policy; |
| import org.apache.lenya.ac.PolicyManager; |
| import org.apache.lenya.ac.impl.DefaultAccessController; |
| import org.apache.lenya.ac.impl.PolicyAuthorizer; |
| import org.apache.lenya.cms.proxy.Proxy; |
| import org.apache.lenya.cms.publication.Document; |
| import org.apache.lenya.cms.publication.DocumentBuildException; |
| import org.apache.lenya.cms.publication.DocumentException; |
| import org.apache.lenya.cms.publication.DocumentIdentityMap; |
| import org.apache.lenya.cms.publication.Publication; |
| import org.apache.lenya.cms.repository.RepositoryUtil; |
| import org.apache.lenya.cms.repository.Session; |
| import org.apache.lenya.util.ServletHelper; |
| import org.xml.sax.Attributes; |
| import org.xml.sax.SAXException; |
| import org.xml.sax.helpers.AttributesImpl; |
| |
| /** |
| * <p> |
| * Link rewriting transformer. |
| * </p> |
| * |
| * <p> |
| * This transformer is applied to an XHMTL document. It processes |
| * <code><xhtml:a href="..."></code> attributes of the following form: |
| * </p> |
| * <p> |
| * <code>{context-prefix}/{publication-id}/{area}{document-url}</code> |
| * </p> |
| * <p> |
| * These links are rewritten using the following rules: |
| * </p> |
| * <ul> |
| * <li>The area is replaced by the current area (obtained from the page envelope).</li> |
| * <li>A URL prefix is added depending on the proxy configuration of the publication.</li> |
| * <li>If the target document does not exist and is in the authoring area, the href attribute is |
| * removed and a class="brokenlink" attribute is added to the <code><a/></code> element</li> |
| * <li>If the target document does not exist and is in the live area, the <code><a/></code> |
| * element is removed to disable the link.</li> |
| * </ul> |
| * |
| * $Id: LinkRewritingTransformer.java,v 1.7 2004/03/16 11:12:16 gregor |
| */ |
| public class LinkRewritingTransformer extends AbstractSAXTransformer implements Disposable { |
| |
| protected static final String BROKEN_ATTRIB = "class"; |
| protected static final String BROKEN_VALUE = "brokenlink"; |
| |
| private boolean ignoreAElement = false; |
| private ServiceSelector serviceSelector; |
| private PolicyManager policyManager; |
| private AccessControllerResolver acResolver; |
| private AccreditableManager accreditableManager; |
| |
| private Document currentDocument; |
| |
| private DocumentIdentityMap identityMap; |
| |
| /** |
| * @see org.apache.cocoon.sitemap.SitemapModelComponent#setup(org.apache.cocoon.environment.SourceResolver, |
| * java.util.Map, java.lang.String, org.apache.avalon.framework.parameters.Parameters) |
| */ |
| public void setup(SourceResolver _resolver, Map _objectModel, String _source, |
| Parameters _parameters) throws ProcessingException, SAXException, IOException { |
| super.setup(_resolver, _objectModel, _source, _parameters); |
| |
| Request _request = ObjectModelHelper.getRequest(_objectModel); |
| |
| try { |
| Session session = RepositoryUtil.getSession(_request, getLogger()); |
| this.identityMap = new DocumentIdentityMap(session, this.manager, getLogger()); |
| String url = ServletHelper.getWebappURI(_request); |
| this.currentDocument = this.identityMap.getFromURL(url); |
| } catch (final Exception e1) { |
| throw new ProcessingException(e1); |
| } |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug("Setting up transformer"); |
| getLogger().debug(" Processed version: [" + getCurrentDocument() + "]"); |
| } |
| |
| this.serviceSelector = null; |
| this.acResolver = null; |
| this.policyManager = null; |
| |
| try { |
| this.serviceSelector = (ServiceSelector) this.manager |
| .lookup(AccessControllerResolver.ROLE + "Selector"); |
| this.acResolver = (AccessControllerResolver) this.serviceSelector |
| .select(AccessControllerResolver.DEFAULT_RESOLVER); |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(" Resolved AC resolver [" + this.acResolver + "]"); |
| } |
| String webappUrl = ServletHelper.getWebappURI(_request); |
| AccessController accessController = this.acResolver.resolveAccessController(webappUrl); |
| if (accessController instanceof DefaultAccessController) { |
| DefaultAccessController defaultAccessController = (DefaultAccessController) accessController; |
| this.accreditableManager = defaultAccessController.getAccreditableManager(); |
| Authorizer[] authorizers = defaultAccessController.getAuthorizers(); |
| for (int i = 0; i < authorizers.length; i++) { |
| if (authorizers[i] instanceof PolicyAuthorizer) { |
| PolicyAuthorizer policyAuthorizer = (PolicyAuthorizer) authorizers[i]; |
| this.policyManager = policyAuthorizer.getPolicyManager(); |
| } |
| } |
| } |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(" Using policy manager [" + this.policyManager + "]"); |
| } |
| } catch (final ServiceException e) { |
| throw new ProcessingException(e); |
| } catch (final AccessControlException e) { |
| throw new ProcessingException(e); |
| } |
| } |
| |
| /** |
| * Returns the currently processed document. |
| * @return A document. |
| */ |
| protected Document getCurrentDocument() { |
| return this.currentDocument; |
| } |
| |
| /** |
| * The local name of the HTML <a> href attribute. |
| */ |
| public static final String ATTRIBUTE_HREF = "href"; |
| |
| private String indent = ""; |
| |
| /** |
| * @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String, |
| * java.lang.String, org.xml.sax.Attributes) |
| */ |
| public void startElement(String uri, String name, String qname, Attributes attrs) |
| throws SAXException { |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "<" + qname + "> (ignoreAElement = " |
| + this.ignoreAElement + ")"); |
| this.indent += " "; |
| } |
| |
| AttributesImpl newAttrs = null; |
| if (lookingAtAElement(name)) { |
| |
| this.ignoreAElement = false; |
| |
| String href = attrs.getValue(ATTRIBUTE_HREF); |
| if (href != null) { |
| |
| Publication publication = getCurrentDocument().getPublication(); |
| |
| try { |
| newAttrs = new AttributesImpl(attrs); |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "href URL: [" + href + "]"); |
| } |
| |
| String _context = this.request.getContextPath(); |
| |
| if (href.startsWith(_context + "/" + publication.getId())) { |
| |
| final String webappUrlWithQueryString = href.substring(_context.length()); |
| String webappUrlWithAnchor; |
| |
| String queryString = null; |
| int queryStringIndex = webappUrlWithQueryString.indexOf("?"); |
| if (queryStringIndex > -1) { |
| webappUrlWithAnchor = webappUrlWithQueryString.substring(0, queryStringIndex); |
| queryString = webappUrlWithQueryString.substring(queryStringIndex + 1); |
| } |
| else { |
| webappUrlWithAnchor = webappUrlWithQueryString; |
| } |
| |
| String anchor = null; |
| String webappUrl = null; |
| |
| int anchorIndex = webappUrlWithAnchor.indexOf("#"); |
| if (anchorIndex > -1) { |
| webappUrl = webappUrlWithAnchor.substring(0, anchorIndex); |
| anchor = webappUrlWithAnchor.substring(anchorIndex + 1); |
| } |
| else { |
| webappUrl = webappUrlWithAnchor; |
| } |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "webapp URL: [" + webappUrl + "]"); |
| getLogger().debug(this.indent + "anchor: [" + anchor + "]"); |
| } |
| if (this.identityMap.isDocument(webappUrl)) { |
| |
| Document targetDocument = this.identityMap.getFromURL(webappUrl); |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "Resolved target document: [" |
| + targetDocument + "]"); |
| } |
| |
| targetDocument = this.identityMap.get(publication, getCurrentDocument() |
| .getArea(), targetDocument.getId(), targetDocument |
| .getLanguage()); |
| |
| if (targetDocument.exists()) { |
| rewriteLink(newAttrs, targetDocument, anchor, queryString); |
| } else if (getCurrentDocument().getArea().equals(Publication.AUTHORING_AREA)) { |
| markBrokenLink(newAttrs, href); |
| } else { |
| this.ignoreAElement = true; |
| } |
| } |
| } |
| } catch (final DocumentBuildException e) { |
| getLogger().error("startElement failed: ", e); |
| throw new SAXException(e); |
| } catch (final DocumentException e) { |
| getLogger().error("startElement failed: ", e); |
| throw new SAXException(e); |
| } catch (final AccessControlException e) { |
| getLogger().error("startElement failed: ", e); |
| throw new SAXException(e); |
| } |
| } |
| |
| } |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "ignoreAElement: " + this.ignoreAElement); |
| } |
| |
| if (!(lookingAtAElement(name) && this.ignoreAElement)) { |
| if (newAttrs != null) { |
| attrs = newAttrs; |
| } |
| super.startElement(uri, name, qname, attrs); |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "<" + qname + "> sent"); |
| } |
| } |
| } |
| |
| /** |
| * Marks a <code><a/></code> element as broken and removes href attribute. |
| * |
| * @param newAttrs The new attributes. |
| * @throws AccessControlException when something went wrong. |
| */ |
| protected void markBrokenLink(AttributesImpl newAttrs, String brokenHref) |
| throws AccessControlException { |
| if(newAttrs.getIndex(BROKEN_ATTRIB) > -1) |
| newAttrs.removeAttribute(newAttrs.getIndex(BROKEN_ATTRIB)); |
| if(newAttrs.getIndex("title") > -1) |
| newAttrs.removeAttribute(newAttrs.getIndex("title")); |
| if(newAttrs.getIndex("href") > -1) |
| newAttrs.setAttribute(newAttrs.getIndex("href"),"","href","href","CDATA",""); |
| String warning = "Broken Link: " + brokenHref; |
| newAttrs.addAttribute("","title","title","CDATA",warning); |
| newAttrs.addAttribute("",BROKEN_ATTRIB,BROKEN_ATTRIB,"CDATA",BROKEN_VALUE); |
| } |
| |
| /** |
| * Rewrites a link. |
| * |
| * @param newAttrs The new attributes. |
| * @param targetDocument The target document. |
| * @param anchor The anchor (the string after the # character in the URL). |
| * @param queryString The query string without question mark. |
| * @throws AccessControlException when something went wrong. |
| */ |
| protected void rewriteLink(AttributesImpl newAttrs, Document targetDocument, String anchor, String queryString) |
| throws AccessControlException { |
| |
| String webappUrl = targetDocument.getCanonicalWebappURL(); |
| Policy policy = this.policyManager.getPolicy(this.accreditableManager, webappUrl); |
| |
| Proxy proxy = targetDocument.getPublication().getProxy(targetDocument, |
| policy.isSSLProtected()); |
| |
| String rewrittenURL; |
| if (proxy == null) { |
| rewrittenURL = this.request.getContextPath() + webappUrl; |
| } else { |
| rewrittenURL = proxy.getURL(targetDocument); |
| } |
| |
| if (anchor != null) { |
| rewrittenURL += "#" + anchor; |
| } |
| |
| if (queryString != null) { |
| rewrittenURL += "?" + queryString; |
| } |
| |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "SSL protection: [" + policy.isSSLProtected() + "]"); |
| getLogger().debug(this.indent + "Resolved proxy: [" + proxy + "]"); |
| getLogger().debug(this.indent + "Rewriting URL to: [" + rewrittenURL + "]"); |
| } |
| |
| setHrefAttribute(newAttrs, rewrittenURL); |
| } |
| |
| /** |
| * Sets the value of the href attribute. |
| * |
| * @param attr The attributes. |
| * @param value The value. |
| * @throws IllegalArgumentException if the href attribute is not contained in this attributes. |
| */ |
| protected void setHrefAttribute(AttributesImpl attr, String value) { |
| int position = attr.getIndex(ATTRIBUTE_HREF); |
| if (position == -1) { |
| throw new IllegalArgumentException("The href attribute is not available!"); |
| } |
| attr.setValue(position, value); |
| } |
| |
| /** |
| * @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String, |
| * java.lang.String) |
| */ |
| public void endElement(String uri, String name, String qname) throws SAXException { |
| if (getLogger().isDebugEnabled()) { |
| this.indent = this.indent.substring(2); |
| getLogger().debug(this.indent + "</" + qname + ">"); |
| } |
| if (lookingAtAElement(name) && this.ignoreAElement) { |
| this.ignoreAElement = false; |
| } else { |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug(this.indent + "</" + qname + "> sent"); |
| } |
| super.endElement(uri, name, qname); |
| } |
| } |
| |
| private boolean lookingAtAElement(String name) { |
| return name.equals("a"); |
| } |
| |
| /** |
| * @see org.apache.avalon.framework.activity.Disposable#dispose() |
| */ |
| public void dispose() { |
| if (getLogger().isDebugEnabled()) { |
| getLogger().debug("Disposing transformer"); |
| } |
| if (this.serviceSelector != null) { |
| if (this.acResolver != null) { |
| this.serviceSelector.release(this.acResolver); |
| } |
| this.manager.release(this.serviceSelector); |
| } |
| } |
| |
| /** |
| * @see org.apache.avalon.excalibur.pool.Recyclable#recycle() |
| */ |
| public void recycle() { |
| this.ignoreAElement = false; |
| } |
| } |
