1 /**
2 * This file Copyright (c) 2013-2015 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.context;
35
36 import info.magnolia.context.MgnlContext;
37 import info.magnolia.rendering.engine.FilteringResponseOutputProvider;
38 import info.magnolia.rendering.engine.OutputProvider;
39 import info.magnolia.rendering.engine.ResponseOutputProvider;
40 import info.magnolia.rendering.template.RenderableDefinition;
41
42 import java.util.Map;
43
44 import javax.jcr.Node;
45 import javax.jcr.RepositoryException;
46
47 import org.apache.commons.lang3.StringUtils;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
50
51 /**
52 * Area rendering listener for enabling/disabling output according to rendered content.
53 *
54 * @deprecated since 5.4, use {@link info.magnolia.rendering.listeners.AreaFilteringListener} instead.
55 */
56 @Deprecated
57 public class AreaFilteringListener implements RenderingListener {
58
59 private boolean insideOfTargetArea = false;
60 private String targetArea = null;
61 private int depth = 0; // check if not inside of nested area with same name
62 private static final Logger log = LoggerFactory.getLogger(AreaFilteringListener.class);
63 private FilteringResponseOutputProvider output = null;
64
65 /**
66 * @deprecated since 5.4, use {@link info.magnolia.rendering.listeners.AreaFilteringListener} instead.
67 */
68 @Deprecated
69 public AreaFilteringListener(ResponseOutputProvider out) {
70 if (!(out instanceof FilteringResponseOutputProvider)) {
71 return; // can filter only with FilteringResponseOutputProvider, don't filter with different provider
72 }
73 targetArea = MgnlContext.getAttribute("mgnlArea");
74 output = (FilteringResponseOutputProvider) out;
75 }
76
77 @Override
78 public void before(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out) {
79 try {
80 if (StringUtils.isEmpty(targetArea)) {
81 return;
82 }
83
84 if (insideOfTargetArea) {
85 depth++;
86 } else if (content != null && targetArea.equals(content.getName())) {
87 output.setWriteEnabled(true);
88 insideOfTargetArea = true;
89 } else {
90 output.setWriteEnabled(false);
91 }
92
93 } catch (RepositoryException e) {
94 log.error("Exception when trying to find the start point for direct rendering of area '{}'.", targetArea, e);
95 }
96 }
97
98 @Override
99 public void after(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out) {
100 if (!insideOfTargetArea) {
101 return;
102 }
103 if (depth == 0) {
104 output.setWriteEnabled(false);
105 insideOfTargetArea = false;
106 depth = 0;
107 } else {
108 depth--;
109 }
110 }
111 }