/**
    * This file Copyright (c) 2015 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.cache.setup;
  
  import info.magnolia.jcr.iterator.FilteringPropertyIterator;
  import info.magnolia.jcr.predicate.JCRMgnlPropertyHidingPredicate;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.cache.AbstractListeningFlushPolicy;
  import info.magnolia.module.cache.FlushAllListeningPolicy;
  import info.magnolia.module.delta.NodeVisitorTask;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.repository.RepositoryConstants;
  import info.magnolia.repository.RepositoryManager;
  
  import java.util.ArrayList;
  import java.util.Collection;
  
  import javax.jcr.Node;
  import javax.jcr.PropertyIterator;
  import javax.jcr.RepositoryException;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Migrates configuration of {@link FlushAllListeningPolicy}.
   */
  public class MigrateFlushListeningPolicyTask extends NodeVisitorTask {
  
      private static final Logger log = LoggerFactory.getLogger(MigrateFlushListeningPolicyTask.class);
  
      protected static final String EXCLUDED_WORKSPACES = "excludedWorkspaces";
      protected static final String REPOSITORIES = "repositories";
      private static final String TASK_NAME = String.format("Migrate '%s' configuration.", FlushAllListeningPolicy.class.getName());
      private final String abstractListeningFlushPolicyClassName;
  
      public MigrateFlushListeningPolicyTask(String path, Class<? extends AbstractListeningFlushPolicy> abstractListeningFlushPolicyClass) {
          super(TASK_NAME, TASK_NAME, RepositoryConstants.CONFIG, "/" + path);
          this.abstractListeningFlushPolicyClassName = abstractListeningFlushPolicyClass.getName();
      }
  
      @Override
      protected boolean nodeMatches(Node node) {
          try {
              return node.hasProperty("class") && abstractListeningFlushPolicyClassName.equals(node.getProperty("class").getString());
          } catch (RepositoryException e) {
              log.error("Cannot check if '{}' matches.", node, e);
          }
          return false;
      }
  
      @Override
      protected void operateOnNode(InstallContext installContext, Node node) {
          Collection<String> includedRepositories = new ArrayList<String>();
          Collection<String> includedWorkspaces = Components.getComponent(RepositoryManager.class).getWorkspaceNames();
          try {
              if (node.hasNode(REPOSITORIES)) {
                  Node repositores = node.getNode(REPOSITORIES);
                  PropertyIterator propertyIterator = new FilteringPropertyIterator(repositores.getProperties(), new JCRMgnlPropertyHidingPredicate());
                  while (propertyIterator.hasNext()) {
                      includedRepositories.add(propertyIterator.nextProperty().getString());
                  }
                  repositores.remove();
              }
              includedWorkspaces.removeAll(includedRepositories);
              Node excludedWorkspaces = node.addNode(EXCLUDED_WORKSPACES, NodeTypes.ContentNode.NAME);
  
             for (String workspace : includedWorkspaces) {
                 excludedWorkspaces.setProperty(workspace, workspace);
             }
             installContext.info(String.format("The configuration '%s' was migrated. All workspaces are now registered by default except those defined under '%s'. "
                     + "The obsolete property '%s' was removed.", node, EXCLUDED_WORKSPACES, REPOSITORIES));
 
         } catch (RepositoryException e) {
             installContext.error(String.format("Cannot execute task '%s' for node '%s'", this.getDescription(), node), e);
         }
     }
 }