View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 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.jcr.wrapper;
35  
36  import info.magnolia.jcr.decoration.AbstractContentDecorator;
37  import info.magnolia.util.EscapeUtil;
38  
39  import javax.jcr.Node;
40  import javax.jcr.Property;
41  
42  import org.apache.commons.lang3.StringUtils;
43  
44  /**
45   * HTML escaping content decorator for use by node and property wrapper classes.
46   */
47  public class HTMLEscapingContentDecorator extends AbstractContentDecorator {
48  
49      private final boolean transformLineBreaks;
50  
51      public HTMLEscapingContentDecorator(boolean transformLineBreaks) {
52          this.transformLineBreaks = transformLineBreaks;
53      }
54  
55      @Override
56      public Node wrapNode(Node node) {
57          if (node == null) {
58              return null;
59          }
60          return new HTMLEscapingNodeWrapper(node, this);
61      }
62  
63      @Override
64      public Property wrapProperty(Property property) {
65          return new HTMLEscapingPropertyWrapper(property, this);
66      }
67  
68      public boolean getTransformLineBreaks() {
69          return transformLineBreaks;
70      }
71  
72      public String decorate(String raw) {
73          String str = EscapeUtil.escapeXss(raw);
74          if (transformLineBreaks) {
75              return StringUtils.replace(str, "\n", "<br/>");
76          }
77          return str;
78  
79      }
80  
81      @Override
82      public boolean isMultipleWrapEnabled() {
83          return false;
84      }
85  }