001    /**
002     * Copyright 2005-2012 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     */
016    package org.kuali.rice.edl.impl;
017    
018    import org.apache.commons.lang.StringUtils;
019    import org.apache.log4j.Logger;
020    import org.kuali.rice.core.api.util.xml.XmlJotter;
021    import org.kuali.rice.kim.api.identity.Person;
022    import org.kuali.rice.krad.util.GlobalVariables;
023    import org.w3c.dom.Document;
024    
025    import javax.servlet.http.HttpServletResponse;
026    import javax.xml.transform.OutputKeys;
027    import javax.xml.transform.Transformer;
028    import javax.xml.transform.dom.DOMSource;
029    import javax.xml.transform.stream.StreamResult;
030    import java.util.Stack;
031    
032    
033    /**
034     * Contains a stack of EDLControllers.  Allows EDL components to add new controllers to the chain runtime.  The idea
035     * being that this is how you would page between edls.  Uses the template associated with the last edl controller
036     * to render the dom of the last edl controller.
037     *
038     * @author Kuali Rice Team (rice.collab@kuali.org)
039     *
040     */
041    public class EDLControllerChain {
042    
043            private static final Logger LOG = Logger.getLogger(EDLControllerChain.class);
044    
045            private Stack<EDLController> edlControllers = new Stack<EDLController>();
046    
047            public void renderEDL(RequestParser requestParser, HttpServletResponse response) throws Exception {
048                    EDLController edlController = edlControllers.pop();
049                    edlController.setEdlContext(getInitialEDLContext(edlController, requestParser, edlController.getStyle().newTransformer()));
050    
051                    Document dom = edlController.notifyComponents();
052                    if (edlControllers.isEmpty()) {
053                            transform(edlController.getEdlContext(), dom, response);
054                    } else {
055                            renderEDL(requestParser, response);
056                    }
057            }
058    
059            public void addEdlController(EDLController edlController) {
060                    edlControllers.add(edlController);
061            }
062    
063            private void transform(EDLContext edlContext, Document dom, HttpServletResponse response) throws Exception {
064                    if (StringUtils.isNotBlank(edlContext.getRedirectUrl())) {
065                            response.sendRedirect(edlContext.getRedirectUrl());
066                            return;
067                    }
068                response.setContentType("text/html; charset=UTF-8");
069                    Transformer transformer = edlContext.getTransformer();
070    
071            transformer.setOutputProperty("indent", "yes");
072            transformer.setOutputProperty(OutputKeys.INDENT, "yes");
073            String user = null;
074            String loggedInUser = null;
075            if (edlContext.getUserSession() != null) {
076                Person wu = edlContext.getUserSession().getPerson();
077                if (wu != null) user = wu.getPrincipalId();
078                wu = edlContext.getUserSession().getPerson();
079                if (wu != null) loggedInUser = wu.getPrincipalId();
080            }
081            transformer.setParameter("user", user);
082            transformer.setParameter("loggedInUser", loggedInUser);
083            if (LOG.isDebugEnabled()) {
084                    LOG.debug("Transforming dom " + XmlJotter.jotNode(dom, true));
085            }
086            transformer.transform(new DOMSource(dom), new StreamResult(response.getOutputStream()));
087            }
088    
089            private EDLContext getInitialEDLContext(EDLController edlController, RequestParser requestParser, Transformer transformer) {
090                    EDLContext edlContext = new EDLContext();
091                    edlContext.setEdlControllerChain(this);
092                    edlContext.setEdocLiteAssociation(edlController.getEdocLiteAssociation());
093                    edlContext.setUserSession(GlobalVariables.getUserSession());
094                    edlContext.setTransformer(transformer);
095                    edlContext.setRequestParser(requestParser);
096                    return edlContext;
097            }
098    
099    }