info.magnolia.cms.taglibs.Include.java Source code

Introduction

Here is the source code for info.magnolia.cms.taglibs.Include.java

Source

/**
 *
 * Magnolia and its source-code is licensed under the LGPL.
 * You may copy, adapt, and redistribute this file for commercial or non-commercial use.
 * When copying, adapting, or redistributing this document in keeping with the guidelines above,
 * you are required to provide proper attribution to obinary.
 * If you reproduce or distribute the document without making any substantive modifications to its content,
 * please use the following attribution line:
 *
 * Copyright 1993-2006 obinary Ltd. (http://www.obinary.com) All rights reserved.
 *
 */
package info.magnolia.cms.taglibs;

import info.magnolia.cms.beans.config.Paragraph;
import info.magnolia.cms.beans.config.ParagraphManager;
import info.magnolia.cms.core.Content;
import info.magnolia.cms.util.Resource;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.tagext.BodyTagSupport;

import org.apache.commons.lang.exception.NestableRuntimeException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author marcel Salathe
 * @author Sameer Charles
 * @author Fabrizio Giustina
 * @version $Revision: 2790 $ ($Author: fgiust $)
 */
public class Include extends BodyTagSupport {

    /**
     * Stable serialVersionUID.
     */
    private static final long serialVersionUID = 222L;

    /**
     * Logger.
     */
    private static Logger log = LoggerFactory.getLogger(Include.class);

    /**
     * file to be included (e.g. /templates/jsp/x.jsp).
     */
    private String path;

    /**
     * Attributes to be passed to the included template (set by nested Attribute tags)
     */
    private transient List attributes;

    /**
     * the instance contentNode (i.e. paragraph) you wish to show.
     */
    private transient Content contentNode;

    /**
     * the name of the contentNode (i.e. paragraph) you wish to show.
     */
    private String contentNodeName;

    /**
     * @deprecated
     * @see #setContentNode(Content)
     */
    public void setContainer(Content contentNode) {
        this.setContentNode(contentNode);
    }

    /**
     * Set the content object.
     * @param contentNode the instance contentNode (i.e. paragraph) you wish to show
     */
    public void setContentNode(Content contentNode) {
        this.contentNode = contentNode;
    }

    /**
     * Set the file to be included.
     * @param path file to be included (e.g. /templates/jsp/x.jsp)
     */
    public void setPath(String path) {
        this.path = path;
    }

    /**
     * If this parameter is passed the include tag uses the defined node of the page
     * @param contentNodeName the name of the contentNode (i.e. paragraph) you wish to show
     */
    public void setContentNodeName(String contentNodeName) {
        this.contentNodeName = contentNodeName;
    }

    /**
     * @param name name of attribute to pass with the include
     * @param value value of attribute to pass with the include
     */
    public void setAttribute(String name, Object value) {
        if (attributes == null) {
            attributes = new ArrayList();
        }
        Object[] attributesArray = new Object[] { name, value };
        attributes.add(attributesArray);
    }

    /**
     * @see javax.servlet.jsp.tagext.IterationTag#doAfterBody()
     */
    public int doAfterBody() {
        HttpServletRequest req = (HttpServletRequest) pageContext.getRequest();
        if ((attributes != null) && (attributes.size() > 0)) {
            Iterator i = attributes.iterator();
            while (i.hasNext()) {
                Object[] s = (Object[]) i.next();
                req.setAttribute((String) s[0], s[1]);
            }
        }
        return SKIP_BODY;
    }

    /**
     * @see javax.servlet.jsp.tagext.Tag#doEndTag()
     */
    public int doEndTag() {
        try {
            HttpServletRequest req = (HttpServletRequest) pageContext.getRequest();
            // get content
            Content content = this.contentNode;
            if (content == null) {
                // was there a node name passed
                if (this.contentNodeName != null) {
                    content = Resource.getCurrentActivePage(req).getContent(this.contentNodeName);
                    if (content != null) {
                        Resource.setLocalContentNode(req, content);
                    }
                }
                // use current (first local then global)
                else {
                    content = Resource.getLocalContentNode(req);
                    if (content == null) {
                        content = Resource.getGlobalContentNode(req);
                        if (content != null) {
                            Resource.setLocalContentNode(req, content);
                        }
                    }
                }
                if (content == null) {
                    throw new Exception("no content node found"); //$NON-NLS-1$
                }
            }

            String jspPage = this.path;

            if (jspPage == null) {
                String paragraphName = content.getMetaData().getTemplate();
                Paragraph paragraph = ParagraphManager.getInstance().getInfo(paragraphName);

                if (paragraph == null) {
                    log.error("Paragraph {} not found for page {}", //$NON-NLS-1$
                            paragraphName, content.getHandle());
                } else {
                    jspPage = paragraph.getTemplatePath();
                }

                if (jspPage == null) {
                    log.error("Unable to render paragraph {} in page {}: templatePath not set.", //$NON-NLS-1$
                            paragraphName, content.getHandle());
                }
            }
            if (jspPage != null) {
                pageContext.include(jspPage);
            }
        } catch (IOException e) {
            // should never happen
            throw new NestableRuntimeException(e);
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }

        // finally {
        // commented out because the node should be present after the tag
        // following tags are else not able to get the current node
        // Resource.removeLocalContentNode((HttpServletRequest) pageContext.getRequest());
        // }

        this.removeAttributes();
        return EVAL_PAGE;
    }

    /**
     *
     */
    private void removeAttributes() {
        HttpServletRequest req = (HttpServletRequest) pageContext.getRequest();
        if ((attributes != null) && (attributes.size() > 0)) {
            Iterator i = attributes.iterator();
            while (i.hasNext()) {
                Object[] s = (Object[]) i.next();
                req.removeAttribute((String) s[0]);
            }
        }
        attributes = null;
    }

    /**
     * @see javax.servlet.jsp.tagext.BodyTagSupport#release()
     */
    public void release() {
        this.path = null;
        this.attributes = null;
        this.contentNode = null;
        super.release();
    }

}