001/**
002 * Copyright 2005-2015 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.edl.impl;
017
018import org.apache.commons.lang.StringUtils;
019import org.apache.logging.log4j.Logger;
020import org.apache.logging.log4j.LogManager;
021import org.kuali.rice.core.api.util.xml.XmlJotter;
022import org.kuali.rice.kim.api.identity.Person;
023import org.kuali.rice.krad.util.GlobalVariables;
024import org.w3c.dom.Document;
025
026import javax.servlet.http.HttpServletResponse;
027import javax.xml.transform.OutputKeys;
028import javax.xml.transform.Transformer;
029import javax.xml.transform.dom.DOMSource;
030import javax.xml.transform.stream.StreamResult;
031import javax.xml.xpath.XPathFactory;
032import java.util.Stack;
033
034
035/**
036 * Contains a stack of EDLControllers.  Allows EDL components to add new controllers to the chain runtime.  The idea
037 * being that this is how you would page between edls.  Uses the template associated with the last edl controller
038 * to render the dom of the last edl controller.
039 *
040 * @author Kuali Rice Team (rice.collab@kuali.org)
041 *
042 */
043public class EDLControllerChain {
044
045        private static final Logger LOG = LogManager.getLogger(EDLControllerChain.class);
046
047        private Stack<EDLController> edlControllers = new Stack<EDLController>();
048
049        public void renderEDL(RequestParser requestParser, HttpServletResponse response) throws Exception {
050                EDLController edlController = edlControllers.pop();
051                edlController.setEdlContext(getInitialEDLContext(edlController, requestParser, edlController.getStyle().newTransformer()));
052
053                Document dom = edlController.notifyComponents();
054                if (edlControllers.isEmpty()) {
055                        transform(edlController.getEdlContext(), dom, response);
056                } else {
057                        renderEDL(requestParser, response);
058                }
059        }
060
061        public void addEdlController(EDLController edlController) {
062                edlControllers.add(edlController);
063        }
064
065        private void transform(EDLContext edlContext, Document dom, HttpServletResponse response) throws Exception {
066                if (StringUtils.isNotBlank(edlContext.getRedirectUrl())) {
067                        response.sendRedirect(edlContext.getRedirectUrl());
068                        return;
069                }
070            response.setContentType("text/html; charset=UTF-8");
071                Transformer transformer = edlContext.getTransformer();
072
073        transformer.setOutputProperty("indent", "yes");
074        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
075        String user = null;
076        String loggedInUser = null;
077        if (edlContext.getUserSession() != null) {
078            Person wu = edlContext.getUserSession().getPerson();
079            if (wu != null) user = wu.getPrincipalId();
080            wu = edlContext.getUserSession().getPerson();
081            if (wu != null) loggedInUser = wu.getPrincipalId();
082        }
083        transformer.setParameter("user", user);
084        transformer.setParameter("loggedInUser", loggedInUser);
085        if (LOG.isDebugEnabled()) {
086                LOG.debug("Transforming dom " + XmlJotter.jotNode(dom, true));
087        }
088        transformer.transform(new DOMSource(dom), new StreamResult(response.getOutputStream()));
089        }
090
091        private EDLContext getInitialEDLContext(EDLController edlController, RequestParser requestParser, Transformer transformer) {
092                EDLContext edlContext = new EDLContext();
093                edlContext.setEdlControllerChain(this);
094                edlContext.setEdocLiteAssociation(edlController.getEdocLiteAssociation());
095                edlContext.setUserSession(GlobalVariables.getUserSession());
096                edlContext.setTransformer(transformer);
097                edlContext.setRequestParser(requestParser);
098        edlContext.setXpath(XPathFactory.newInstance().newXPath());
099        return edlContext;
100        }
101
102}