/**
    * This file Copyright (c) 2008-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.rssaggregator.setup;
  
  import info.magnolia.dam.setup.migration.ChangeDataDmsReferenceToDamMigrationTask;
  import info.magnolia.module.DefaultModuleVersionHandler;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.cache.RegisterWorkspaceForCacheFlushingTask;
  import info.magnolia.module.delta.ArrayDelegateTask;
  import info.magnolia.module.delta.BootstrapConditionally;
  import info.magnolia.module.delta.BootstrapSingleModuleResource;
  import info.magnolia.module.delta.BootstrapSingleResource;
  import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
  import info.magnolia.module.delta.CheckOrCreatePropertyTask;
  import info.magnolia.module.delta.CreateNodeTask;
  import info.magnolia.module.delta.DeltaBuilder;
  import info.magnolia.module.delta.ModuleDependencyBootstrapTask;
  import info.magnolia.module.delta.MoveNodeTask;
  import info.magnolia.module.delta.NodeExistsDelegateTask;
  import info.magnolia.module.delta.OrderNodeBeforeTask;
  import info.magnolia.module.delta.PropertyExistsDelegateTask;
  import info.magnolia.module.delta.RemoveNodeTask;
  import info.magnolia.module.delta.SetPropertyTask;
  import info.magnolia.module.delta.SetupModuleRepositoriesTask;
  import info.magnolia.module.delta.Task;
  import info.magnolia.module.model.Version;
  import info.magnolia.module.rssaggregator.RSSAggregatorConstants;
  import info.magnolia.repository.RepositoryConstants;
  import info.magnolia.ui.admincentral.setup.ConvertAclToAppPermissionTask;
  import info.magnolia.ui.framework.setup.SetWritePermissionForActionsTask;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  import javax.jcr.ImportUUIDBehavior;
  
  /**
   * Version handler.
   */
  public class RSSAggregatorVersionHandler extends DefaultModuleVersionHandler {
  
      protected static final String RSSAGGREGATOR_APP_ACTIONS = "/modules/rssaggregator/apps/rssAggregator/subApps/browser/actions/";
  
      public RSSAggregatorVersionHandler() {
  
          register(DeltaBuilder.checkPrecondition("1.3", "2.0"));
  
          register(DeltaBuilder.update("1.4", "")
                  .addTask(new BootstrapSingleResource("Planet feed component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.planetFeeds.xml"))
                  .addTask(new BootstrapSingleResource("Planet feed statistics component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedStatistics.xml"))
                  .addTask(new BootstrapSingleResource("Planet feed subcriptions component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedSubscriptions.xml"))
                  // settings for feed syndication
                  .addTask(new BootstrapSingleResource("Virtual URI mapping for planet feeds.", "", "/mgnl-bootstrap/rssaggregator/config.modules.rssaggregator.virtualURIMapping.planetFeeds.xml"))
                  .addTask(new BootstrapSingleResource("Feed generator for planet feeds.", "", "/mgnl-bootstrap/rssaggregator/config/feedGenerators/config.modules.rssaggregator.config.feedGenerators.planet.xml"))
                  .addTask(new BootstrapSingleResource("Feed syndication component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedSyndication.xml"))
                  // planet commands
                  .addTask(new BootstrapConditionally("Commands for planet RSS.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.rssaggregator.commands.xml"))
                  .addTask(new BootstrapConditionally("Scheduled job for planet archive.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.scheduler.config.jobs.generatePlanetData.xml"))
                  .addTask(new BootstrapConditionally("Scheduled job for planet statistics.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.scheduler.config.jobs.collectPlanetStatistics.xml"))
                  // add config options for planet
                  .addTask(new CreateNodeTask("Planet feed options.", "Add options for planet feeds to the RSSAggregator module.",
                          RepositoryConstants.CONFIG, "/modules/rssaggregator/config", "planetOptions", "mgnl:contentNode"))
                  .addTask(new CheckOrCreatePropertyTask("Option for relevant months to be included in statistics", "",
                          RepositoryConstants.CONFIG, "/modules/rssaggregator/config/planetOptions", "lastMonthsIncluded", "3"))
                  // move virtualURImappings to rssaggregator module from adminInterface
                  .addTask(new MoveNodeTask("Move rssFeeds node.", "Move rssFeeds node to rssaggregator module.", "config", "/modules/adminInterface/virtualURIMapping/rssFeeds", "/modules/rssaggregator/virtualURIMapping/rssFeeds", false)));
  
         register(DeltaBuilder.update("1.4.3", "")
                 .addTask(new ArrayDelegateTask("Bootstrap missing components",
                         new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph",
                                 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of combinedFeedsParagraphs", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/combinedFeed.ftl", "/rssaggregator/components/combinedFeed.ftl"),
                                 new BootstrapSingleResource("Bootstrap component", "Bootstrap combinedFeedsParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.combinedFeedsParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
                         ),
                         new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph",
                                 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of feedListParagraph", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/feedList.ftl", "/rssaggregator/components/feedList.ftl"),
                                 new BootstrapSingleResource("Bootstrap component", "Bootstrap feedListParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedListParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
                         )
                         )
                 )
                 .addTask(new NodeExistsDelegateTask("Add property", "Add property backup to rssaggregator importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator",
                         new PropertyExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", null,
                                 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", Boolean.TRUE)
                         )
                         )
                 ));
 
         register(DeltaBuilder.update("2.0", "")
                 .addTask(new RemoveNodeTask("Remove old page", "Remove old adminInterface page", RepositoryConstants.CONFIG, "/modules/adminInterface/pages/rssaggregator"))
                 .addTask(new RemoveNodeTask("Remove old menu", "Remove old adminInterface menu", RepositoryConstants.CONFIG, "/modules/adminInterface/config/menu/coonfiguration/rssaggregator")));
 
         register(DeltaBuilder.update("2.0.2", "")
                 .addTask(new ArrayDelegateTask("Bootstrap missing components",
                         new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph",
                                 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of combinedFeedsParagraphs", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/combinedFeed.ftl", "/rssaggregator/components/combinedFeed.ftl"),
                                 new BootstrapSingleResource("Bootstrap component", "Bootstrap combinedFeedsParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.combinedFeedsParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
                         ),
                         new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph",
                                 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of feedListParagraph", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/feedList.ftl", "/rssaggregator/components/feedList.ftl"),
                                 new BootstrapSingleResource("Bootstrap component", "Bootstrap feedListParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedListParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
                         )
                         )
                 )
 
         );
         register(DeltaBuilder.update("2.0.3", "")
                 .addTask(new NodeExistsDelegateTask("Add property", "Add property backup to rssaggregator importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator",
                         new PropertyExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", null,
                                 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", Boolean.TRUE)
                         )
                         )));
         register(DeltaBuilder.update("2.2", "")
                 .addTask(new PropertyExistsDelegateTask("Add property", "Add property backup to rssaggregator importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", null,
                         new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", Boolean.TRUE)))
 
                 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for scheduler jobs", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/generatePlanetData/params", "repository",
                         new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/generatePlanetData/params", "repository", RSSAggregatorConstants.WORKSPACE), null))
 
                 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for scheduler jobs", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/collectPlanetStatistics/params", "repository",
                         new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/collectPlanetStatistics/params", "repository", RSSAggregatorConstants.WORKSPACE), null))
 
                 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for rss importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator/targets/main", "targetPath",
                         new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator/targets/main", "targetPath", "/"), null))
 
                 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for rss importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "repository",
                         new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "repository", RSSAggregatorConstants.WORKSPACE), null))
 
                 // Get rid of old artifacts
                 .addTask(new RemoveNodeTask("Remove page", "Remove old adminInterface page", "config", "/modules/rssaggregator/pages"))
                 .addTask(new RemoveNodeTask("Remove old app", "Delete old app from app launcher if exists", "config", "/modules/ui-admincentral/config/appLauncherLayout/data/apps/RssAggregatorApp"))
                 .addTask(new RemoveNodeTask("Remove old dialogs", "Remove old adminInterface dialogs", "config", "/modules/rssaggregator/dialogs"))
                 .addTask(new RemoveNodeTask("Remove old dialogs", "Remove RSSAggregator dialog from data", "config", "/modules/data/dialogs/RssAggregator"))
                 .addTask(new RemoveNodeTask("Remove rss aggregator tree", "Remove RSSAggregator tree from data module", "config", "/modules/data/trees/RssAggregator"))
                 .addTask(new RemoveNodeTask("Remove rss aggregator type", "Remove RSSAggregator type from data module", "config", "/modules/data/config/types/RssAggregator"))
                 .addTask(new RemoveNodeTask("Remove rss aggregator menu", "Remove RSSAggregator menu from adminInterface-legacy module", "config", "/modules/adminInterface/config/menu/data/RssAggregator"))
 
                 // Bootstrap new rssaggregator app
                 .addTask(new BootstrapSingleModuleResource("Bootstrap app", "Bootstrap rssaggregator app", "app/config.modules.rssaggregator.apps.xml"))
                 .addTask(new BootstrapSingleModuleResource("Add app to app-launcher", "Add rssaggregator app to App Launcher", "app/config.modules.ui-admincentral.config.appLauncherLayout.groups.manage.apps.rssAggregator.xml"))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap dialogs", "Remove old adminInterface dialogs", "dialogs/config.modules.rssaggregator.dialogs.xml"))
                 .addTask(new RSSAggregatorDataTypeMigrationTask("Migrate data", "Migrate RSS Aggregator data to RSS workspace", "/rssaggregator", "/", RSSAggregatorConstants.WORKSPACE))
                 .addTask(new ChangeDataDmsReferenceToDamMigrationTask("Migrate Hackergotchi user pics", "Migrate user pics from DMS to DAM", RSSAggregatorConstants.WORKSPACE, Arrays.asList("/"), "", ""))
                 .addTask(new SetupModuleRepositoriesTask())
                 .addTask(new ConvertAclToAppPermissionTask("Convert ACLs to permissions for 'rssAggregator' app", "Convert ACL permissions to dms to new 'assets' app permissions",
                         "/modules/adminInterface/config/menu/data/RssAggregator", "/modules/rssaggregator/apps/rssAggregator", false))
                 .addTask(new NodeExistsDelegateTask("Reorder RSS in MANAGE group", "This reorders the RSS app before Config in the Manage group of the applauncher.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/configuration",
                         new OrderNodeBeforeTask("", "", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/rssAggregator", "configuration"))));
 
         register(DeltaBuilder.update("2.2.1", "")
                 .addTask(new RemovePropertyIfExists("Forbid nested RSS-Aggregators in 'add action' availability", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/browser/actions/addRSSAggregator/availability/nodeTypes/", "rssFeed")));
 
         register(DeltaBuilder.update("2.2.2", "")
                 .addTask(new NodeExistsDelegateTask("Delete old app from app launcher if exists", "Delete old app from app launcher if exists", RepositoryConstants.CONFIG,
                         "/modules/ui-admincentral/config/appLauncherLayout/groups/data/apps/RssAggregatorApp",
                         new RemoveNodeTask("Delete old app from app launcher", "Delete old app from app launcher", RepositoryConstants.CONFIG,
                                 "/modules/ui-admincentral/config/appLauncherLayout/groups/data/apps/RssAggregatorApp"))));
 
         register(DeltaBuilder.update("2.2.4", "")
                 .addTask(new RegisterWorkspaceForCacheFlushingTask("rss"))
                 .addTask(new RenameFilterFieldsPropertiesTask())
                 .addTask(new SetWritePermissionForActionsTask(RSSAGGREGATOR_APP_ACTIONS, new String[] { "addFolder", "editFolder", "addRSSAggregator", "delete", "editRSSAggregator", "import", "restorePreviousVersion", "confirmDeleteRSSAggregator", "activate", "deactivate", "activateDeleted" })));
 
     }
 
     @Override
     protected List<Task> getExtraInstallTasks(InstallContext installContext) {
         List<Task> tasks = new ArrayList<Task>();
         tasks.add(new ModuleDependencyBootstrapTask("observation"));
         tasks.addAll(super.getExtraInstallTasks(installContext));
         tasks.add(new NodeExistsDelegateTask("Reorder RSS in MANAGE group", "This reorders the RSS app before Config in the Manage group of the applauncher.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/configuration",
                 new OrderNodeBeforeTask("", "", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/rssAggregator", "configuration")));
         tasks.add(new RegisterWorkspaceForCacheFlushingTask("rss"));
         return tasks;
     }
 
     @Override
     protected List<Task> getDefaultUpdateTasks(Version forVersion) {
         final List<Task> tasks = new ArrayList<Task>();
         tasks.addAll(super.getDefaultUpdateTasks(forVersion));
         return tasks;
     }
 }