/**
    * This file Copyright (c) 2008-2017 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.templatingkit.setup;
  
  import info.magnolia.cms.core.Content;
  import info.magnolia.cms.util.ContentUtil;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.module.DefaultModuleVersionHandler;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AbstractRepositoryTask;
  import info.magnolia.module.delta.ArrayDelegateTask;
  import info.magnolia.module.delta.BootstrapSingleResource;
  import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
  import info.magnolia.module.delta.CheckOrCreatePropertyTask;
  import info.magnolia.module.delta.CopyNodeTask;
  import info.magnolia.module.delta.CreateNodePathTask;
  import info.magnolia.module.delta.CreateNodeTask;
  import info.magnolia.module.delta.DeltaBuilder;
  import info.magnolia.module.delta.IsModuleInstalledOrRegistered;
  import info.magnolia.module.delta.ModuleDependencyBootstrapTask;
  import info.magnolia.module.delta.NodeExistsDelegateTask;
  import info.magnolia.module.delta.OrderNodeAfterTask;
  import info.magnolia.module.delta.PartialBootstrapTask;
  import info.magnolia.module.delta.PropertyExistsDelegateTask;
  import info.magnolia.module.delta.RemovePropertiesTask;
  import info.magnolia.module.delta.RemovePropertyTask;
  import info.magnolia.module.delta.SetPropertyTask;
  import info.magnolia.module.delta.Task;
  import info.magnolia.module.delta.TaskExecutionException;
  import info.magnolia.module.delta.WarnTask;
  import info.magnolia.module.model.Version;
  import info.magnolia.module.site.setup.DefaultSiteExistsDelegateTask;
  import info.magnolia.module.templatingkit.setup.for2_7.ReorderSTKAppsTask;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  import javax.jcr.ImportUUIDBehavior;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  /**
   * STK Module VersionHandler.
   */
  public class STKModuleVersionHandler extends DefaultModuleVersionHandler {
  
      private final Task setStkSiteAsActiveInSiteModule = new NodeExistsDelegateTask("Set STK site as an active site if possible", "/modules/standard-templating-kit/config/site",
              new ArrayDelegateTask("",
                      new NodeExistsDelegateTask("Check if any site already exists", "/modules/site/config/site",
                              new PropertyExistsDelegateTask("Check extends property and update or create it", "/modules/site/config/site", "extends",
                                      new CheckAndModifyPropertyValueTask("/modules/site/config/site", "extends", "/modules/travel-demo/config/travel", "/modules/standard-templating-kit/config/site"),
                                      new DefaultSiteExistsDelegateTask("", "",
                                              new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/site/config/site", "extends", "/modules/standard-templating-kit/config/site"))),
                              new ArrayDelegateTask("",
                                      new CreateNodeTask("Create site node", "/modules/site/config", "site", NodeTypes.ContentNode.NAME),
                                      new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/site/config/site", "extends", "/modules/standard-templating-kit/config/site"))),
                      new CheckOrCreatePropertyTask("Set correct site class for stk site", "/modules/standard-templating-kit/config/site", "class", "info.magnolia.module.templatingkit.sites.Site"),
                      new CheckOrCreatePropertyTask("Set correct class for stk prototype", "/modules/standard-templating-kit/config/site/templates/prototype", "class", "info.magnolia.module.templatingkit.templates.pages.STKPage")));
  
      public STKModuleVersionHandler() {
  
          register(DeltaBuilder.checkPrecondition("3.0", "3.1"));
  
          register(DeltaBuilder.update("3.0.1", "")
                  .addTask(new NodeExistsDelegateTask("Update 'tabLogin' in dialog 'stkPURLoginForm'", "/modules/standard-templating-kit/dialogs/components/pur/stkPURLoginForm",
                          new BootstrapSingleResource("", "", "/mgnl-bootstrap/standard-templating-kit/dialogs/components/pur/config.modules.standard-templating-kit.dialogs.components.pur.stkPURLoginForm.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REPLACE_EXISTING)))
 
                 .addTask(new PropertyExistsDelegateTask("Update template 'stkPURAuthSubmit'", "/modules/standard-templating-kit/templates/components/pur/stkPURAuthSubmit", "modelClass",
                         new RemovePropertyTask("", "/modules/standard-templating-kit/templates/components/pur/stkPURAuthSubmit", "modelClass")))
                 .addTask(new PropertyExistsDelegateTask("Update template 'stkPURNotAuthSubmit'", "/modules/standard-templating-kit/templates/components/pur/stkPURNotAuthSubmit", "modelClass",
                         new RemovePropertyTask("", "/modules/standard-templating-kit/templates/components/pur/stkPURNotAuthSubmit", "modelClass")))
                 .addTask(new PropertyExistsDelegateTask("Update template 'stkPURIntranet'", "/modules/standard-templating-kit/templates/components/pur/stkPURIntranet", "modelClass",
                         new RemovePropertyTask("", "/modules/standard-templating-kit/templates/components/pur/stkPURIntranet", "modelClass")))
 
                 .addTask(new PropertyExistsDelegateTask("Update template 'stkPURLoginForm'", "/modules/standard-templating-kit/templates/components/pur/stkPURLoginForm", "modelClass",
                         new RemovePropertyTask("", "/modules/standard-templating-kit/templates/components/pur/stkPURLoginForm", "modelClass")))
 
                 .addTask(new NodeExistsDelegateTask("Update template 'stkPURPasswordChangeForm'", "/modules/standard-templating-kit/templates/components/pur/stkPURPasswordChangeForm",
                         new CheckAndModifyPropertyValueTask("/modules/standard-templating-kit/templates/components/pur/stkPURPasswordChangeForm", "modelClass",
                                 "info.magnolia.module.publicuserregistration.frontend.action.RegistrationModel", "info.magnolia.module.form.templates.components.FormModel")))
                 .addTask(new NodeExistsDelegateTask("Update template 'stkPURPasswordForm'", "/modules/standard-templating-kit/templates/components/pur/stkPURPasswordForm",
                         new CheckAndModifyPropertyValueTask("/modules/standard-templating-kit/templates/components/pur/stkPURPasswordForm", "modelClass",
                                 "info.magnolia.module.publicuserregistration.frontend.action.RegistrationModel", "info.magnolia.module.form.templates.components.FormModel")))
                 .addTask(new NodeExistsDelegateTask("Update template 'stkPURRegistrationForm'", "/modules/standard-templating-kit/templates/components/pur/stkPURRegistrationForm",
                         new CheckAndModifyPropertyValueTask("/modules/standard-templating-kit/templates/components/pur/stkPURRegistrationForm", "modelClass",
                                 "info.magnolia.module.publicuserregistration.frontend.action.RegistrationModel", "info.magnolia.module.form.templates.components.FormModel")))
                 .addTask(new NodeExistsDelegateTask("Update template 'stkPURUpdateForm'", "/modules/standard-templating-kit/templates/components/pur/stkPURUpdateForm",
                         new CheckAndModifyPropertyValueTask("/modules/standard-templating-kit/templates/components/pur/stkPURUpdateForm", "modelClass",
                                 "info.magnolia.module.publicuserregistration.frontend.action.RegistrationModel", "info.magnolia.module.form.templates.components.FormModel")))
 
                 .addTask(new NodeExistsDelegateTask("Add new double-opt-in form template", "/modules/standard-templating-kit/templates/components/pur/stkPURDoubleOptInForm", null,
                         new BootstrapSingleResource("", "", "/mgnl-bootstrap/standard-templating-kit/templates/components/pur/config.modules.standard-templating-kit.templates.components.pur.stkPURDoubleOptInForm.xml")))
                 .addTask(new NodeExistsDelegateTask("Add new double-opt-in form dialog", "/modules/standard-templating-kit/dialogs/components/pur/stkPURDoubleOptInForm", null,
                         new BootstrapSingleResource("", "", "/mgnl-bootstrap/standard-templating-kit/dialogs/components/pur/config.modules.standard-templating-kit.dialogs.components.pur.stkPURDoubleOptInForm.xml")))
                 .addTask(new NodeExistsDelegateTask("Add new double-opt-in form to component availability of PUR page template", "/modules/standard-templating-kit/templates/pages/stkPublicUserRegistration/areas/main/areas/content/availableComponents/stkPURDoubleOptInForm", null,
                         new PartialBootstrapTask("", "/mgnl-bootstrap/standard-templating-kit/templates/pages/config.modules.standard-templating-kit.templates.pages.stkPublicUserRegistration.xml",
                                 "/stkPublicUserRegistration/areas/main/areas/content/availableComponents/stkPURDoubleOptInForm")))
 
                 .addTask(new RemovePropertiesTask("Remove legacy properties from configuration", RepositoryConstants.CONFIG, Arrays.asList(
                         "/modules/standard-templating-kit/dialogs/generic/controls/inheritable/selected",
                         "/modules/standard-templating-kit/dialogs/generic/controls/hideInNav/selected",
                         "/modules/standard-templating-kit/dialogs/generic/teasers/hideTeaserImage/selected",
                         "/modules/standard-templating-kit/dialogs/generic/teasers/highlighted/selected",
                         "/modules/standard-templating-kit/dialogs/functional/stkRedirect/form/tabs/tabRedirect/fields/hideInNav/selected",
                         "/modules/standard-templating-kit/dialogs/components/teasers/stkTeaserEventsList/form/tabs/tabTeaser/fields/showAbstract/selected",
                         "/modules/standard-templating-kit/dialogs/components/teasers/stkTeaserNewsList/form/tabs/tabTeaser/fields/hideTeaserImage/selected",
                         "/modules/standard-templating-kit/dialogs/components/features/stkEventsOverview/form/tabs/tabTeaser/fields/showAbstract/selected",
                         "/modules/standard-templating-kit/dialogs/components/features/stkFAQ/form/tabs/tabMain/fields/useIndex/selected",
                         "/modules/standard-templating-kit/dialogs/components/features/stkNewsOverview/form/tabs/tabTeaser/fields/hideTeaserImage/selected",
                         "/modules/standard-templating-kit/dialogs/components/features/stkSiteMap/form/tabs/tabMain/fields/showSiteMapRoot/selected",
 
                         "/modules/standard-templating-kit/dialogs/components/features/stkFAQ/form/tabs/tabMain/fields/indexString/lineSemi",
                         "/modules/standard-templating-kit/dialogs/components/features/stkSiteMap/form/tabs/tabMain/fields/link/lineSemi",
 
                         "/modules/standard-templating-kit/dialogs/pages/home/stkHomeProperties/form/tabs/tabMain/fields/searchUUID/labelDescription",
                         "/modules/standard-templating-kit/dialogs/components/features/stkSiteMap/form/tabs/tabMain/fields/link/labelDescription",
                         "/modules/standard-templating-kit/dialogs/components/features/stkSiteMap/form/tabs/tabMain/fields/showSiteMapRoot/labelDescription",
                         "/modules/standard-templating-kit/dialogs/components/features/stkFAQ/form/tabs/tabMain/fields/indexString/labelDescription",
                         "/modules/standard-templating-kit/dialogs/components/features/stkFAQ/form/tabs/tabMain/fields/useIndex/labelDescription",
 
                         "/modules/standard-templating-kit/dialogs/components/teasers/stkTeaserContact/form/tabs/tabTeaser/fields/contact/tree",
 
                         "/modules/standard-templating-kit/dialogs/pages/home/stkHomeProperties/form/tabs/tabMain/fields/searchUUID/path",
 
                         "/modules/standard-templating-kit/dialogs/components/features/stkSiteMap/form/tabs/tabMain/fields/titleToUse/cols"
                 ), true))
         );
     }
 
     @Override
     protected List<Task> getExtraInstallTasks(InstallContext ctx) {
         final List<Task> tasks = new ArrayList<>();
         tasks.addAll(super.getExtraInstallTasks(ctx));
         tasks.add(new InstallSTKResourcesTask());
 
         // order templates
         tasks.add(new AbstractRepositoryTask("Order templates", "") {
             @Override
             protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
                 Node templatesNodes = ctx.getConfigJCRSession().getNode("/modules/standard-templating-kit/templates/pages");
                 Content templatesContent = ContentUtil.asContent(templatesNodes);
                 ContentUtil.orderNodes(templatesContent, new String[]{"stkHome", "stkSection", "stkArticle", "stkLargeArticle", "stkNews", "stkEvent", "stkImageGallery", "stkFAQ", "stkForm", "stkSearchResult", "stkSiteMap", "stkRedirect"});
             }
         });
 
         tasks.add(new RemoveETKParagraphs());
 
         tasks.add(new WarnTask("SMTP Configuration", "Please set the config: /modules/mail/config/smtp to a valid smtp configuration"));
         tasks.add(new IsModuleInstalledOrRegistered("Use of commenting module", "Use of commenting module by default in STK", "commenting",
                 new CheckAndModifyPropertyValueTask("", "", RepositoryConstants.CONFIG, "/modules/standard-templating-kit/config/site/templates/prototype/areas/main/areas/comments/availableComponents/stkComments", "id", "standard-templating-kit:components/features/stkComments", "commenting:components/comments")));
         tasks.add(new STKLegacyUiToMagnolia5AppProviderTask("Provide STK with a Magnolia 5 UI", "Turns legacy UI into a Magnolia 5 browser app."));
         tasks.add(new OrderNodeAfterTask("STK AppLauncher group ordering", "Moves the stk app group after the tools group", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/stk", "tools"));
         tasks.add(new ReorderSTKAppsTask());
         tasks.add(new ModuleDependencyBootstrapTask("contacts"));
         tasks.add(new ModuleDependencyBootstrapTask("categorization"));
         tasks.add(setStkSiteAsActiveInSiteModule);
         tasks.add(new IsModuleInstalledOrRegistered("Configure STK site for multisite", "multisite",
                 new NodeExistsDelegateTask("Check if stk can be moved to the multisite", "/modules/standard-templating-kit/config/site",
                         new ArrayDelegateTask("", "",
                                 new NodeExistsDelegateTask("Check for default site", "Check whether default site already exists or not - if no, site from stk will be copied to multisite", RepositoryConstants.CONFIG, "/modules/multisite/config/sites/default",
                                         new WarnTask("Default already site exists", "Default site already exists. No actions will be taken."),
                                         new ArrayDelegateTask("", "",
                                                 new CreateNodePathTask("", "/modules/multisite/config/sites/", NodeTypes.ContentNode.NAME),
                                                 new CopyNodeTask("Default site configuration", "Copy the configuration of the STK site", "config", "/modules/standard-templating-kit/config/site", "/modules/multisite/config/sites/default", false),
                                                 new ModuleDependencyBootstrapTask("multisite"),
                                                 new CheckOrCreatePropertyTask("Add class property to legacy site", "/modules/multisite/config/sites/default", "class", "info.magnolia.module.templatingkit.sites.Site"),
                                                 new SetPropertyTask("config", "/modules/multisite/config/sites/default", "label", "Default"))),
                                 new NodeExistsDelegateTask("", "/modules/multisite/config/sites/fallback",
                                         new NodeExistsDelegateTask("", "/modules/multisite/config/sites/default",
                                                 new PropertyExistsDelegateTask("name", "/modules/multisite/config/sites/fallback", "extends",
                                                         new CheckAndModifyPropertyValueTask("/modules/multisite/config/sites/fallback", "extends", "../travel", "../default"),
                                                         new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/multisite/config/sites/fallback", "extends", "../default"))))))));
         tasks.add(new AddSTKRolesToRelevantAppsTask());
         return tasks;
     }
 
     @Override
     protected List<Task> getDefaultUpdateTasks(Version forVersion) {
         final List<Task> tasks = new ArrayList<>();
         tasks.addAll(super.getDefaultUpdateTasks(forVersion));
         return tasks;
     }
 }