/**
    * This file Copyright (c) 2013-2018 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.setup.for5_2;
  
  import info.magnolia.cms.security.Permission;
  import info.magnolia.cms.security.Role;
  import info.magnolia.cms.security.RoleManager;
  import info.magnolia.cms.security.SecuritySupport;
  import info.magnolia.cms.security.auth.ACL;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.QueryTask;
  import info.magnolia.module.delta.TaskExecutionException;
  import info.magnolia.repository.RepositoryConstants;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  /**
   * Add a read permission to role itself if not already defined.
   */
  public class GrantReadPermissionToRolesTask extends QueryTask {
  
      private RoleManager roleManager;
  
      public GrantReadPermissionToRolesTask(String name, String description) {
          super(name, description, RepositoryConstants.USER_ROLES, "select * from [" + NodeTypes.Role.NAME + "] as t ");
      }
  
      @Override
      protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
          SecuritySupport securitySupport = SecuritySupport.Factory.getInstance();
          roleManager = securitySupport.getRoleManager();
          super.doExecute(installContext);
      }
  
      @Override
      protected void operateOnNode(InstallContext installContext, Node node) {
          try {
              String roleName = node.getName();
              String roleNamePattern = "/" + roleName;
              Role role = roleManager.getRole(roleName);
              // Check if the role has already access to himself
              ACL aclUserroles = roleManager.getACLs(roleName).get(RepositoryConstants.USER_ROLES);
  
              if (aclUserroles == null || !hasReadPermission(aclUserroles, roleNamePattern)) {
                  roleManager.addPermission(role, RepositoryConstants.USER_ROLES, roleNamePattern, Permission.READ);
              }
  
          } catch (RepositoryException e) {
              installContext.warn("Not able to add read permission to the following role: " + NodeUtil.getNodePathIfPossible(node));
          }
      }
  
      /**
       * Check if the ACLs have a matching permission.
       */
      private boolean hasReadPermission(ACL aclUserroles, String pattern) {
          for (Permission permission : aclUserroles.getList()) {
              if (permission.match(pattern)) {
                  return true;
              }
          }
          return false;
      }
  
  }