/**
    * This file Copyright (c) 2017-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.cache.ehcache3.setup;
  
  import info.magnolia.init.MagnoliaConfigurationProperties;
  import info.magnolia.init.MagnoliaInitPaths;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.module.DefaultModuleVersionHandler;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.cache.setup.MigrateEhcache15ConfigurationTask;
  import info.magnolia.module.delta.BootstrapSingleResource;
  import info.magnolia.module.delta.DeltaBuilder;
  import info.magnolia.module.delta.NodeExistsDelegateTask;
  import info.magnolia.module.delta.NodeVisitorTask;
  import info.magnolia.module.delta.Task;
  import info.magnolia.module.delta.WarnCondition;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import javax.inject.Inject;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  /**
   * <code>VersionHandler</code> implementation for the EhCache3 module.
   */
  public class EhCache3ModuleVersionHandler extends DefaultModuleVersionHandler {
  
      @Inject
      public EhCache3ModuleVersionHandler(MagnoliaConfigurationProperties configurationProperties, MagnoliaInitPaths magnoliaInitPaths) {
          register(DeltaBuilder.update("5.5.5", "")
                  .addTask(new MoveDiskStoreDirectoryTask())
          );
  
          register(DeltaBuilder.update("5.8", "")
                  .addTask(new NodeExistsDelegateTask("Rename 'expiry' in ehcache3 configuration to 'expiryPolicy'", "/modules/cache/config/cacheFactory/delegateFactories/ehcache3",
                          new NodeVisitorTask("Rename 'expiry' in ehcache3 configuration to 'expiryPolicy'", "Expiry configuration was deprecated", RepositoryConstants.CONFIG, "/modules/cache/config/cacheFactory/delegateFactories/ehcache3") {
                              @Override
                              protected boolean nodeMatches(Node node) {
                                  return NodeUtil.getName(node).equals("expiry");
                              }
  
                              @Override
                              protected void operateOnNode(InstallContext installContext, Node node) {
                                  try {
                                      NodeUtil.renameNode(node, "expiryPolicy");
                                  } catch (RepositoryException e) {
                                      installContext.error(e.getMessage(), e);
                                  }
                              }
                          })
                  )
                  .addCondition(new WarnCondition("Cached items persisted on disk will be removed!", "Cached items persisted on disk will be removed!", "Persisted cached items removed."))
                  .addTask(new CleanUpDiskStoreDirectoryTask(configurationProperties, magnoliaInitPaths))
          );
      }
  
      @Override
      protected List<Task> getExtraInstallTasks(InstallContext installContext) {
          final List<Task> tasks = new ArrayList<>();
          //update from 1.x
          tasks.add(new NodeExistsDelegateTask("EhCache configuration", "/modules/cache/config/cacheFactory/delegateFactories/ehcache/defaultCacheConfiguration",
                  new MigrateEhcache15ConfigurationTask()
          ));
          tasks.add(new NodeExistsDelegateTask("Configure EhCache3", "/modules/cache/config/cacheFactory/delegateFactories/ehcache",
                  //update from 2.x
                 new MigrateEhCache2ConfigurationTask(),
                 //clean install
                 new BootstrapSingleResource("EhCache3 clean install", "EhCache3 clean install", "/info/magnolia/module/ehcache3/setup/config.modules.cache.config.cacheFactory.delegateFactories.ehcache3.xml")
         ));
         return tasks;
     }
 }