1 /**
2 * This file Copyright (c) 2011-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.channel.ChannelResolver;
37 import info.magnolia.jcr.RuntimeRepositoryException;
38 import info.magnolia.jcr.decoration.NodePredicateContentDecorator;
39 import info.magnolia.jcr.predicate.AbstractPredicate;
40
41 import javax.jcr.Node;
42 import javax.jcr.Property;
43 import javax.jcr.RepositoryException;
44 import javax.jcr.Value;
45
46 import org.apache.commons.lang3.StringUtils;
47
48 /**
49 * ContentDecorator that hides content based on a multi-value property called <code>excludeChannels</code>.
50 * <p/>The node is filtered out if all the these requirements are fulfilled:
51 * <ul>
52 * <li>it has a property named "excludeChannels"</li>
53 * <li>the property is a multi-value property</li>
54 * <li>it has at least one value</li>
55 * <li>one of the values matches the current channel</li>
56 * </ul>
57 * <p/>
58 * If the current channel is null or equal to "all" (case-insensitive) nothing is filtered out.
59 */
60 public class ChannelVisibilityContentDecorator extends NodePredicateContentDecorator {
61
62 public static final String EXCLUDE_CHANNEL_PROPERTY_NAME = "excludeChannels";
63
64 private static class ChannelVisibilityPredicate extends AbstractPredicate<Node> {
65
66 private final String currentChannel;
67
68 private ChannelVisibilityPredicate(String currentChannel) {
69 this.currentChannel = currentChannel;
70 }
71
72 @Override
73 public boolean evaluateTyped(Node node) {
74 try {
75 if (StringUtils.isNotEmpty(currentChannel) && !currentChannel.equalsIgnoreCase(ChannelResolver.ALL)) {
76 if (node.hasProperty(EXCLUDE_CHANNEL_PROPERTY_NAME)) {
77 Property channel = node.getProperty(EXCLUDE_CHANNEL_PROPERTY_NAME);
78 if (channel.isMultiple()) {
79 Value[] values = channel.getValues();
80 if (values.length == 0) {
81 return true;
82 }
83 for (Value value : values) {
84 if (value.getString().equals(currentChannel)) {
85 return false;
86 }
87 }
88 return true;
89 }
90 }
91 }
92 return true;
93
94 } catch (RepositoryException e) {
95 throw new RuntimeRepositoryException(e);
96 }
97 }
98 }
99
100 public ChannelVisibilityContentDecorator(String currentChannel) {
101 super(new ChannelVisibilityPredicate(currentChannel));
102 }
103 }