View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.templating.elements.attribute;
35  
36  import info.magnolia.context.Context;
37  import info.magnolia.rendering.template.ComponentAvailability;
38  import info.magnolia.templating.elements.AreaElement;
39  
40  import java.util.ArrayList;
41  import java.util.Collection;
42  import java.util.Iterator;
43  import java.util.List;
44  import java.util.Optional;
45  
46  import javax.inject.Inject;
47  import javax.inject.Provider;
48  
49  import org.apache.commons.collections4.CollectionUtils;
50  import org.apache.commons.lang3.StringUtils;
51  
52  /**
53   * {@link ElementAttribute} for {@link info.magnolia.rendering.template.AreaDefinition#getAvailableComponents()}.
54   */
55  public class AvailableComponents implements ElementAttribute<AreaElement> {
56  
57      private final Provider<Context> contextProvider;
58  
59      @Inject
60      public AvailableComponents(Provider<Context> contextProvider) {
61          this.contextProvider = contextProvider;
62      }
63  
64      @Override
65      public Optional<String> getValue(AreaElement element) {
66          return Optional.ofNullable(resolveAvailableComponents(element));
67      }
68  
69      private String resolveAvailableComponents(AreaElement element) {
70          if (StringUtils.isNotEmpty(element.getAvailableComponents())) {
71              return StringUtils.remove(element.getAvailableComponents(), " ");
72          }
73          if (element.getAreaDefinition() != null && element.getAreaDefinition().getAvailableComponents().size() > 0) {
74              Iterator<ComponentAvailability> iterator = element.getAreaDefinition().getAvailableComponents().values().iterator();
75              List<String> componentIds = new ArrayList<>();
76              final Collection<String> userRoles = contextProvider.get().getUser().getAllRoles();
77              while (iterator.hasNext()) {
78                  ComponentAvailability availableComponent = iterator.next();
79                  if (availableComponent.isEnabled()) {
80                      // check roles
81                      final Collection<String> roles = availableComponent.getRoles();
82                      if (!roles.isEmpty()) {
83                          if (CollectionUtils.containsAny(userRoles, roles)) {
84                              componentIds.add(availableComponent.getId());
85                          }
86                      } else {
87                          componentIds.add(availableComponent.getId());
88                      }
89                  }
90              }
91              return StringUtils.join(componentIds, ',');
92          }
93          return "";
94      }
95  }