1 /**
2 * This file Copyright (c) 2003-2011 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.admininterface;
35
36 import info.magnolia.freemarker.FreemarkerUtil;
37
38 import java.io.IOException;
39 import java.io.PrintWriter;
40 import java.util.HashMap;
41 import java.util.Map;
42
43 import javax.servlet.http.HttpServletRequest;
44 import javax.servlet.http.HttpServletResponse;
45
46 import org.apache.commons.lang.StringUtils;
47
48
49 /**
50 * A default page (handler) using a freemarker template to render. The default template name is following the class name.
51 * You can overwrite the getTemplateName() method which can return a template per view.
52 * @author Philipp Bracher
53 * @version $Revision: 41137 $ ($Author: gjoseph $)
54 */
55 public class TemplatedMVCHandler extends PageMVCHandler {
56
57 /**
58 * @param name
59 * @param request
60 * @param response
61 */
62 public TemplatedMVCHandler(String name, HttpServletRequest request, HttpServletResponse response) {
63 super(name, request, response);
64 }
65
66 /**
67 * Returns the template name for the rendering. The standard implementation used the classname to build the path.
68 * @param viewName the view name to render
69 * @return the template name (including path)
70 */
71 protected String getTemplateName(String viewName) {
72 String template = FreemarkerUtil.createTemplateName(this.getClass(), "html");
73 if(StringUtils.isNotEmpty(viewName) && !viewName.equals(VIEW_SHOW)){
74 String subtemplate = StringUtils.replace(template, ".html", StringUtils.capitalize(viewName + ".html"));
75 // add postfix only in case the resource exists
76 if(this.getClass().getResource(subtemplate) != null){
77 template = subtemplate;
78 }
79 }
80 return template;
81 }
82
83 /**
84 * Renders the template. The handlers is passed with the name 'this'.
85 */
86 public void renderHtml(String view) throws IOException {
87 // no rendering if view is null
88 if(StringUtils.isEmpty(view)){
89 return;
90 }
91
92 String template = this.getTemplateName(view);
93 if (template != null) {
94
95 Map data = new HashMap();
96 data.put("this", this);
97 data.put("view", view);
98
99 PrintWriter writer;
100
101 try {
102 writer = getResponse().getWriter();
103 }
104 catch (IllegalStateException e) {
105 // getResponse().getOutputStream() has already been called
106 writer = new PrintWriter(getResponse().getOutputStream());
107 }
108 FreemarkerUtil.process(template, data, writer);
109 }
110 }
111
112 }