/**
    * 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.util.NodeTypes;
  import info.magnolia.module.DefaultModuleVersionHandler;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.cache.ehcache.EhCacheFactory;
  import info.magnolia.module.delta.AbstractRepositoryTask;
  import info.magnolia.module.delta.ArrayDelegateTask;
  import info.magnolia.module.delta.BootstrapSingleResource;
  import info.magnolia.module.delta.CreateNodeTask;
  import info.magnolia.module.delta.MoveNodeTask;
  import info.magnolia.module.delta.NodeExistsDelegateTask;
  import info.magnolia.module.delta.PropertyValueDelegateTask;
  import info.magnolia.module.delta.Task;
  import info.magnolia.module.delta.TaskExecutionException;
  import info.magnolia.module.delta.WarnTask;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import javax.jcr.Node;
  import javax.jcr.Property;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  /**
   * <code>VersionHandler</code> implementation for the {@link info.magnolia.module.cache.EhCacheModule}.
   */
  public class EhCacheModuleVersionHandler extends DefaultModuleVersionHandler {
  
      @Override
      protected List<Task> getExtraInstallTasks(InstallContext installContext) {
          final List<Task> tasks = new ArrayList<Task>();
          tasks.add(new NodeExistsDelegateTask("EhCache configuration", "/modules/cache/config/cacheFactory/defaultCacheConfiguration",
                  //update
                  new ArrayDelegateTask("Ehcache upgrade",
                          new PropertyValueDelegateTask("EhCache default config", "Moves config:/modules/cache/config/cacheFactory/defaultCacheConfiguration to /modules/cache/config/cacheFactory/caches/default.",
                                  RepositoryConstants.CONFIG, "/modules/cache/config/cacheFactory", "class", EhCacheFactory.class.getName(), true,
                                  new ArrayDelegateTask("",
                                          new CreateNodeTask("Default cache config", "/modules/cache/config/cacheFactory/", "caches", NodeTypes.ContentNode.NAME),
                                          new MoveNodeTask("Default cache config", "/modules/cache/config/cacheFactory/defaultCacheConfiguration", "/modules/cache/config/cacheFactory/caches/default", false),
                                          new EhCache28PersistenceConfigSettingsTask()
                                  ), new WarnTask("Please update cache default settings", "Please update cache default settings. You are not using " + EhCacheFactory.class.getName() + ", so we did not update your configuration."))),
                  //clean install
                  new BootstrapSingleResource("EhCache clean install", "EhCache clean install", "/info/magnolia/module/ehcache/setup/config.modules.cache.config.cacheFactory.xml")
          ));
          return tasks;
      }
  
      private static class EhCache28PersistenceConfigSettingsTask extends AbstractRepositoryTask {
          public EhCache28PersistenceConfigSettingsTask() {
              super("EhCache persistence settings", "");
          }
  
          @Override
          protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
              final Session session = ctx.getConfigJCRSession();
              final Node defaultCache = session.getNode("/modules/cache/config/cacheFactory/caches/default");
              final Node persistence = defaultCache.addNode("persistence", NodeTypes.ContentNode.NAME);
              persistence.setProperty("synchronousWrites", "false");
              final boolean overflowToDisk = getBooleanAndRemove(defaultCache, "overflowToDisk", true);
              final boolean diskPersistent = getBooleanAndRemove(defaultCache, "diskPersistent", true);
              if (overflowToDisk && diskPersistent) {
                  // persistence.setProperty("strategy", "localRestartable"); // Needs ehcacheee  see MGNLCACHE67
                  persistence.setProperty("strategy", "localTempSwap");
                 ctx.warn("EhCache: needs ehcache enterprise edition / BigMemory for persistence. Disabling persistance for the time beeing.");
             } else if (overflowToDisk) {
                 persistence.setProperty("strategy", "localTempSwap");
             } else {
                 ctx.warn("EhCache: overflowToDisk or diskPersistent was set to false, so we'll set the persistent strategy to 'none'");
                 persistence.setProperty("strategy", "none");
             }
         }
 
         private boolean getBooleanAndRemove(Node node, String propertyName, boolean defaultValue) throws RepositoryException {
             if (node.hasProperty(propertyName)) {
                 final Property property = node.getProperty(propertyName);
                 final boolean val = property.getBoolean();
                 property.remove();
                 return val;
             }
             return defaultValue;
         }
     }
 }