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.TemplateDefinition;
38  import info.magnolia.templating.elements.ComponentElement;
39  
40  import java.util.Optional;
41  
42  import javax.inject.Provider;
43  
44  /**
45   * {@link ElementAttribute} for
46   * {@link info.magnolia.rendering.template.TemplateDefinition#getMoveable()},
47   * {@link info.magnolia.rendering.template.TemplateDefinition#getWritable()},
48   * {@link info.magnolia.rendering.template.TemplateDefinition#getMoveable()}.
49   */
50  public abstract class Permission implements ElementAttribute<ComponentElement> {
51  
52      @Override
53      public Optional<String> getValue(ComponentElement element) {
54          return Optional.ofNullable(resolvePermission(element))
55                  .map(Object::toString);
56      }
57  
58      private Boolean resolvePermission(ComponentElement componentElement) {
59          TemplateDefinition templateDefinition = componentElement.getTemplateDefinition();
60          Boolean permission = templateDefinition != null && getPermission(templateDefinition) != null ? getPermission(templateDefinition) : null;
61          if (permission != null || componentElement.getPermissions() == null) {
62              return permission;
63          }
64          return hasPermission(componentElement);
65      }
66  
67      abstract Boolean getPermission(TemplateDefinition templateDefinition);
68  
69      abstract Boolean hasPermission(ComponentElement element);
70  
71      /**
72       * {@link ElementAttribute} for {@link info.magnolia.rendering.template.TemplateDefinition#getMoveable()}.
73       */
74      public static class Movable extends Permission {
75  
76          private final Provider<Context> contextProvider;
77  
78          public  Movable(Provider<Context> contextProvider) {
79              this.contextProvider = contextProvider;
80          }
81  
82          Boolean getPermission(TemplateDefinition templateDefinition) {
83              return templateDefinition.getMoveable();
84          }
85  
86          @Override
87          Boolean hasPermission(ComponentElement element) {
88              return element.getPermissions().canMove(contextProvider.get().getUser());
89          }
90      }
91  
92      /**
93       * {@link ElementAttribute} for {@link info.magnolia.rendering.template.TemplateDefinition#getDeletable()}.
94       */
95      public static class Deletable extends Permission {
96  
97          private final Provider<Context> contextProvider;
98  
99          public Deletable(Provider<Context> contextProvider) {
100             this.contextProvider = contextProvider;
101         }
102 
103         Boolean getPermission(TemplateDefinition templateDefinition) {
104             return templateDefinition.getDeletable();
105         }
106 
107         @Override
108         Boolean hasPermission(ComponentElement element) {
109             return element.getPermissions().canDelete(contextProvider.get().getUser());
110         }
111     }
112 
113     /**
114      * {@link ElementAttribute} for {@link info.magnolia.rendering.template.TemplateDefinition#getWritable()}.
115      */
116     public static class Writable extends Permission {
117 
118         private final Provider<Context> contextProvider;
119 
120         public  Writable(Provider<Context> contextProvider) {
121             this.contextProvider = contextProvider;
122         }
123 
124         Boolean getPermission(TemplateDefinition templateDefinition) {
125             return templateDefinition.getWritable();
126         }
127 
128         @Override
129         Boolean hasPermission(ComponentElement element) {
130             return element.getPermissions().canWrite(contextProvider.get().getUser());
131         }
132     }
133 }