/**
    * 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 java.util.Arrays;
  import java.util.List;
  
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Removes a list of properties referenced by their absolute paths.<br>
   * In case property does not exist, logs an info message if the flag {@link #displayInfoMessageForMissingNodes} is set to true.<br>
   * Otherwise just continues with the next absolute path from the list.
   */
  public class RemovePropertiesTask extends AbstractRepositoryTask {
  
      private static final Logger log = LoggerFactory.getLogger(RemovePropertiesTask.class);
  
      private final String workspaceName;
      private final List<String> pathsToRemove;
      private final boolean displayInfoMessageForMissingNodes;
  
      public RemovePropertiesTask(String name, String workspaceName, List<String> pathsToRemove, boolean displayInfoMessageForMissingNodes) {
          this(name, String.format("Remove properties: '%s' from '%s' workspace.", Arrays.toString(pathsToRemove.toArray()), workspaceName),
                  workspaceName, pathsToRemove, displayInfoMessageForMissingNodes);
      }
  
      public RemovePropertiesTask(String name, String description, String workspaceName, List<String> pathsToRemove, boolean displayInfoMessageForMissingNodes) {
          super(name, description);
          this.pathsToRemove = pathsToRemove;
          this.workspaceName = workspaceName;
          this.displayInfoMessageForMissingNodes = displayInfoMessageForMissingNodes;
      }
  
      @Override
      protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
          Session session = ctx.getJCRSession(this.workspaceName);
  
          for (String path : this.pathsToRemove) {
              if (!session.propertyExists(path)) {
                  if (this.displayInfoMessageForMissingNodes) {
                      ctx.info("Could not remove property '" + path + "' from workspace '" + this.workspaceName + "'. Property does not exist.");
                  }
                  log.debug("Could not remove property '{}' from workspace '{}'. Property does not exist.", path, this.workspaceName);
              } else {
                  session.getProperty(path).remove();
              }
          }
      }
  }