/**
    * This file Copyright (c) 2016 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.module.delta;
  
  import info.magnolia.cms.core.Path;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.module.InstallContext;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  import javax.jcr.Node;
  import javax.jcr.NodeIterator;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * A task to add a permission to all users under provided path.
   *
   */
  public class AddUsersPermissionTask extends NodeVisitorTask {
  
      public static final String USER_PATH_REPLACEMENT = "${USER_PATH}";
  
      private static final Logger log = LoggerFactory.getLogger(AddUsersPermissionTask.class);
  
      private final String workspaceName;
      private final String path;
      private final long permission;
      private List<String> excludedUserNames = new ArrayList<>();
  
      /**
       * @param pathToUsers path pointing to subtree (or a single user) in users workspace
       * @param workspace workspace to add permission for
       * @param workspacePath path in workspace to add permission for, string ${USER_PATH} will be replaced with path to user to whom is the permission added
       * @param permission permission value, see {@link info.magnolia.cms.security.Permission}
       */
      public AddUsersPermissionTask(String taskName, String pathToUsers, String workspace, String workspacePath, long permission) {
          super(taskName, String.format("Adds permission '%s:%s=%d' to users under the path '%s'", workspace, workspacePath, permission, pathToUsers), RepositoryConstants.USERS, pathToUsers);
          this.workspaceName = workspace;
          this.path = workspacePath;
          this.permission = permission;
      }
  
      public AddUsersPermissionTask exclude(String... excludedUserNames) {
          this.excludedUserNames = Arrays.asList(excludedUserNames);
          return this;
      }
  
      @Override
      protected boolean nodeMatches(Node node) {
          try {
              return NodeTypes.User.NAME.equals(node.getPrimaryNodeType().getName()) && !excludedUserNames.contains(node.getName());
          } catch (RepositoryException e) {
              log.error(e.getMessage(), e);
              return false;
          }
      }
  
      @Override
      protected void operateOnNode(InstallContext installContext, Node user) {
          try {
             final Node aclNode = NodeUtil.createPath(user, "acl_" + workspaceName, NodeTypes.ContentNode.NAME);
             final String path = StringUtils.replace(this.path, USER_PATH_REPLACEMENT, user.getPath());
 
             if (permissionExists(aclNode, path)) {
                 installContext.warn(String.format("User '%s' has already permission for '%s:%s'.", user.getPath(), workspaceName, path));
             } else {
                 final String nodeName = Path.getUniqueLabel(aclNode, "0");
                 final Node permissionNode = aclNode.addNode(nodeName, NodeTypes.ContentNode.NAME);
                 permissionNode.setProperty("path", path);
                 permissionNode.setProperty("permissions", permission);
             }
         } catch (RepositoryException e) {
             installContext.error(e.getMessage(), e);
         }
     }
 
     private boolean permissionExists(Node aclNode, String path) throws RepositoryException {
         NodeIterator children = aclNode.getNodes();
         while (children.hasNext()) {
             Node child = children.nextNode();
             if (child.hasProperty("path") && child.getProperty("path").getString().equals(path)) {
                 return true;
             }
         }
         return false;
     }
 }