/**
    * 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.module.googlesitemap.setup.migration;
  
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.jcr.util.NodeVisitor;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AbstractRepositoryTask;
  import info.magnolia.module.delta.TaskExecutionException;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.util.Arrays;
  
  import javax.jcr.Node;
  import javax.jcr.Property;
  import javax.jcr.PropertyIterator;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  
  /**
   * Remove all i18n properties from the migrated dialog definitions.
   */
  public class Removei18nKeysInSiteMapMigrationTask extends AbstractRepositoryTask {
      private static final Logger log = LoggerFactory.getLogger(Removei18nKeysInSiteMapMigrationTask.class);
  
      private String[] properties = { "label", "description", "i18nBasename", "buttonLabel" };
  
      public Removei18nKeysInSiteMapMigrationTask(String name, String description) {
          super(name, description);
      }
  
      @Override
      protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
          try {
              Session configSession = installContext.getJCRSession(RepositoryConstants.CONFIG);
              Node rootNode = configSession.getNode("/modules/google-sitemap/dialogs");
              NodeUtil.visit(rootNode, createI18NVisitor());
  
          } catch (RepositoryException re) {
              installContext.error("Unable to perform Migration task " + getName(), re);
              throw new TaskExecutionException(re.getMessage());
          }
      }
  
      private NodeVisitor createI18NVisitor() {
          NodeVisitor visitor = new NodeVisitor() {
  
              @Override
              public void visit(Node node) throws RepositoryException {
                  if (hasI18NKeys(node)) {
                      handleNode(node);
                  }
              }
          };
          return visitor;
      }
  
      private boolean hasI18NKeys(Node node) {
          try {
              return node.getProperties(this.properties).hasNext();
          } catch (RepositoryException re) {
              log.warn("Got exception by checking if '{}' has i18n properties", NodeUtil.getName(node), re);
              return false;
          }
     }
 
     private void handleNode(Node node) throws RepositoryException {
         PropertyIterator propertyIterator = node.getProperties(this.properties);
         while (propertyIterator.hasNext()) {
             Property property = propertyIterator.nextProperty();
             if (Arrays.asList(this.properties).contains(property.getName())) {
                 log.info("SiteMap i18n property removed: '{}' ", property.getPath());
                 property.remove();
             }
         }
     }
 }