View Javadoc

1   /**
2    * This file Copyright (c) 2010-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.rendering.engine;
35  
36  import info.magnolia.cms.beans.config.ServerConfiguration;
37  import info.magnolia.context.MgnlContext;
38  
39  import java.io.PrintWriter;
40  import java.io.Writer;
41  
42  import javax.inject.Inject;
43  
44  /**
45   * Exception handler providing different output based on the configuration of the current instance. Full stacktrace gets
46   * rendered on the author instance only, while ignoring the stacktraces in preview mode and on public instances.
47   *
48   * @version $Id$
49   */
50  public class ModeDependentRenderExceptionHandler implements RenderExceptionHandler {
51  
52      public static final String RENDER_ERROR_MESSAGE_BEGIN =
53              "<!-- ERROR MESSAGE STARTS HERE --><script language=javascript>//\"></script><script language=javascript>//\'></script><script language=javascript>//\"></script><script language=javascript>//\'></script></title></xmp></script></noscript></style></object></head></pre></table></form></table></table></table></a></u></i></b><div align=left style='background-color:#FFFF00; color:#FF0000; display:block; border-top:double; padding:2pt; font-size:medium; font-family:Arial,sans-serif; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none'><b style='font-size:medium'>FreeMarker template error!</b><pre><xmp>";
54  
55      public static final String RENDER_ERROR_MESSAGE_END = "</xmp></pre></div></html>";
56  
57      private ServerConfiguration serverConfiguration;
58  
59      @Inject
60      public ModeDependentRenderExceptionHandler(ServerConfiguration config) {
61          this.serverConfiguration = config;
62      }
63  
64      @Override
65      public void handleException(RenderException renderException, Writer out) {
66          if ( serverConfiguration.isAdmin() && !MgnlContext.getAggregationState().isPreviewMode()) {
67              inEditMode(renderException, out);
68          } else {
69              inPublicMode(renderException, out);
70          }
71      }
72  
73      private PrintWriter getPrintWriterFor(Writer out) {
74          return (out instanceof PrintWriter) ? (PrintWriter) out : new PrintWriter(out);
75      }
76  
77      protected void inPublicMode(RenderException renderException, Writer out) {
78          final PrintWriter pw = getPrintWriterFor(out);
79          renderException.printStackTrace(pw);
80          pw.flush();
81  
82      }
83  
84      protected void inEditMode(RenderException renderException, Writer out) {
85          final PrintWriter pw = getPrintWriterFor(out);
86          pw.println(RENDER_ERROR_MESSAGE_BEGIN);
87          renderException.printStackTrace(pw);
88          pw.println(RENDER_ERROR_MESSAGE_END);
89          pw.flush();
90      }
91  }