/**
    * This file Copyright (c) 2013 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.i18nsystem.setup;
  
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AbstractRepositoryTask;
  import info.magnolia.module.delta.TaskExecutionException;
  
  import java.util.Arrays;
  import java.util.Iterator;
  import java.util.List;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  /**
   * Removes some well-known deprecated i18n properties whose keys are now generated via the {@link info.magnolia.i18nsystem.I18nizer} mechanism.
   * The properties are defined by {@link AbstractRemoveHardcodedI18nPropertiesTask#DEPRECATED_I18N_PROPERTIES}.
   * <p>
   * Subclasses will need to implement {@link #getAppRelativePaths()} to provide the paths relative to the module name under which one wants to remove such properties. All sub nodes under the provided paths will be searched recursively for the deprecated i18n properties.
   */
  public abstract class AbstractRemoveHardcodedI18nPropertiesTask extends AbstractRepositoryTask {
  
      public static final List<String> DEPRECATED_I18N_PROPERTIES = Arrays.asList(new String[] { "label", "confirmationMessage", "errorMessage", "i18nBasename", "description" });
      private String appName;
      private List<String> additionalDeprecatedProperties;
  
      public AbstractRemoveHardcodedI18nPropertiesTask(final String appName, final String description) {
          this(appName, description, null);
      }
  
      public AbstractRemoveHardcodedI18nPropertiesTask(final String appName, final String description, List<String> additionalDeprecatedProperties) {
          super("Remove hardcoded i18n properties", description);
          this.appName = appName;
          this.additionalDeprecatedProperties = additionalDeprecatedProperties;
      }
  
  
  
      @Override
      public void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
          final Session session = installContext.getConfigJCRSession();
          final Node module = session.getNode("/modules/" + appName);
          removeProperty(module);
          for (String path : getAppRelativePaths()) {
              if (module.hasNode(path)){
                  Node node = module.getNode(path);
                  final Iterator<Node> iter = NodeUtil.collectAllChildren(node).iterator();
                  while (iter.hasNext()) {
                      removeProperty(iter.next());
                  }
              }
          }
  
          session.save();
      }
  
      abstract protected String[] getAppRelativePaths();
  
      private void removeProperty(final Node node) throws RepositoryException {
          for (String propertyName : DEPRECATED_I18N_PROPERTIES) {
              if (node.hasProperty(propertyName)) {
                  node.getProperty(propertyName).remove();
              }
          }
          if(additionalDeprecatedProperties!=null){
             for (String propertyName : additionalDeprecatedProperties) {
                 if (node.hasProperty(propertyName)) {
                     node.getProperty(propertyName).remove();
                 }
             }
         }
     }
 }