/**
    * This file Copyright (c) 2003-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 java.util.Arrays;
  import java.util.Collection;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  /**
   * If the specified property (NodeData) has the expected value, then it will be replaced by the new value.
   */
  public class CheckAndModifyPropertyValueTask extends PropertyValuesTask {
      private final String workspaceName;
      private final String nodePath;
      private final String propertyName;
      private final Collection<String> expectedCurrentValues;
      private final String newValue;
  
      public CheckAndModifyPropertyValueTask(String nodePath, String propertyName, String expectedCurrentValue, String newValue) {
          this("Change property value if it has certain value", String.format("Changes property '%s' to '%s' if it has value '%s'.", nodePath + "/" + propertyName, newValue, expectedCurrentValue),
                  RepositoryConstants.CONFIG, nodePath, propertyName, Arrays.asList(expectedCurrentValue), newValue);
      }
  
      public CheckAndModifyPropertyValueTask(String workspaceName, String nodePath, String propertyName, Collection<String> expectedCurrentValues, String newValue) {
          this("Change property if it has certain value", String.format("Changes property '%s' to '%s if it has one of expected values.", nodePath + "/" + propertyName, newValue),
                  workspaceName, nodePath, propertyName, expectedCurrentValues, newValue);
      }
  
      public CheckAndModifyPropertyValueTask(String name, String description, String workspaceName, String nodePath, String propertyName, String expectedCurrentValue, String newValue) {
          this(name, description, workspaceName, nodePath, propertyName, Arrays.asList(expectedCurrentValue), newValue);
      }
  
      public CheckAndModifyPropertyValueTask(String name, String description, String workspaceName, String nodePath, String propertyName, Collection<String> expectedCurrentValues, String newValue) {
          super(name, description);
          this.workspaceName = workspaceName;
          this.nodePath = nodePath;
          this.propertyName = propertyName;
          this.expectedCurrentValues = expectedCurrentValues;
          this.newValue = newValue;
      }
  
      @Override
      public void execute(InstallContext ctx) {
          try {
              final Session session = ctx.getJCRSession(workspaceName);
              final Node node = session.getNode(nodePath);
              checkAndModifyPropertyValue(ctx, node, propertyName, expectedCurrentValues, newValue);
          } catch (RepositoryException e) {
              ctx.error(format("Could not check property {0} of node at {1}. Please create it with value {2}.", propertyName, nodePath, newValue), e);
          }
      }
  }