/**
    * This file Copyright (c) 2014-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.module.delta;
  
  import info.magnolia.module.InstallContext;
  import info.magnolia.repository.RepositoryConstants;
  
  import javax.jcr.Node;
  import javax.jcr.NodeIterator;
  import javax.jcr.PropertyType;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  import javax.jcr.Value;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Task to fix permissions property of a user role.
   */
  public class FixUserRolePermissionsPropertyTask extends AbstractTask {
  
      private static final Logger log = LoggerFactory.getLogger(FixUserRolePermissionsPropertyTask.class);
  
      protected static final String PERMISSIONS_PROPERTY_NAME = "permissions";
  
      private final String path;
  
      private Session session;
  
      public FixUserRolePermissionsPropertyTask(String path) {
          super(String.format("Fix the type of the permissions property for role '%s'", path),
                  String.format("Checks that every permissions property of role '%s' is of type Long and will try to update if required.", path));
          this.path = path;
      }
  
      @Override
      public void execute(InstallContext installContext) throws TaskExecutionException {
          try {
              session = installContext.getJCRSession(RepositoryConstants.USER_ROLES);
              Node start = session.getNode(path);
              handleNode(start);
          } catch (RepositoryException e) {
              log.error("Error getting node [{}] of workspace [{}].", this.path, RepositoryConstants.USER_ROLES, e);
          }
      }
  
      /**
       * If a node has the <code>permissions</code> property (see: {@link #PERMISSIONS_PROPERTY_NAME}) and
       * when its {@link PropertyType} is not of type {@link PropertyType#LONG} try to update it accordingly.
       */
      private void handleNode(Node start) throws RepositoryException {
          NodeIterator iterator = start.getNodes();
          while (iterator.hasNext()) {
              Node node = iterator.nextNode();
              if (node.hasProperty(PERMISSIONS_PROPERTY_NAME) && node.getProperty(PERMISSIONS_PROPERTY_NAME).getType() != PropertyType.LONG) {
                  try {
                      Long longValue = node.getProperty(PERMISSIONS_PROPERTY_NAME).getLong();
                      Value value = session.getValueFactory().createValue(longValue);
                      node.setProperty(PERMISSIONS_PROPERTY_NAME, value);
                  } catch (RepositoryException e) {
                      log.error("Error updating permission property for node [{}]. Please make sure the property type is Long.", node, e);
                  }
              }
              if (node.hasNodes()) {
                  handleNode(node);
              }
          }
     }
 
 }