View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.module.delta;
35  
36  import info.magnolia.cms.security.Role;
37  import info.magnolia.cms.security.RoleManager;
38  import info.magnolia.cms.security.SecuritySupport;
39  import info.magnolia.module.InstallContext;
40  
41  import javax.jcr.RepositoryException;
42  
43  /**
44   * A task to remove a permission from a role, using {@link info.magnolia.cms.security.RoleManager}.
45   * Removes the permission to the given path, as well as "path/*".
46   */
47  public class RemovePermissionTask extends AbstractRepositoryTask {
48  
49      private final String roleName;
50      private final String workspaceName;
51      private final String pathToRemove;
52      private final long permission;
53  
54      public RemovePermissionTask(String taskName, String roleName, String workspaceName, String pathToRemove, long permission) {
55          this(taskName, String.format("Remove permission '%s:%s=%d' from role '%s'.", workspaceName, pathToRemove + "*", permission, roleName),
56                  roleName, workspaceName, pathToRemove, permission);
57      }
58  
59      public RemovePermissionTask(String taskName, String taskDescription, String roleName, String workspaceName, String pathToRemove, long permission) {
60          super(taskName, taskDescription);
61          this.roleName = roleName;
62          this.workspaceName = workspaceName;
63          this.pathToRemove = pathToRemove;
64          this.permission = permission;
65      }
66  
67      @Override
68      protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
69          try {
70              final SecuritySupport securitySupport = SecuritySupport.Factory.getInstance();
71              final RoleManager roleManager = securitySupport.getRoleManager();
72              final Role role = roleManager.getRole(roleName);
73  
74              if (role != null) {
75                  roleManager.removePermission(role, workspaceName, pathToRemove, permission);
76                  roleManager.removePermission(role, workspaceName, pathToRemove + "/*", permission);
77              } else {
78                  ctx.warn("Role \"" + roleName + "\" not found, can't remove its ACL permission.");
79              }
80          } catch (UnsupportedOperationException e1) {
81              ctx.warn("Can't update role \"" + roleName + "\" due to an unsupported operation exception. This is most likely the case if the roles are managed externally.");
82          }
83      }
84  }