/**
    * This file Copyright (c) 2003-2012 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.forum.setup;
  
  import info.magnolia.cms.security.Permission;
  import info.magnolia.module.DefaultModuleVersionHandler;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AddPermissionTask;
  import info.magnolia.module.delta.AddRoleToUserTask;
  import info.magnolia.module.delta.ArrayDelegateTask;
  import info.magnolia.module.delta.BootstrapSingleModuleResource;
  import info.magnolia.module.delta.DeltaBuilder;
  import info.magnolia.module.delta.MoveNodeTask;
  import info.magnolia.module.delta.NodeExistsDelegateTask;
  import info.magnolia.module.delta.PropertyExistsDelegateTask;
  import info.magnolia.module.delta.RemoveNodeWoChildren;
  import info.magnolia.module.delta.RemoveNodesTask;
  import info.magnolia.module.delta.RemovePermissionTask;
  import info.magnolia.module.delta.RemovePropertyTask;
  import info.magnolia.module.delta.SetPropertyTask;
  import info.magnolia.module.delta.Task;
  import info.magnolia.module.delta.WarnTask;
  import info.magnolia.module.forum.DefaultForumManager;
  import info.magnolia.repository.RepositoryConstants;
  import info.magnolia.ui.admincentral.setup.AppLauncherReorderingTask;
  import info.magnolia.ui.admincentral.setup.AppLauncherReorderingTask.Order;
  import info.magnolia.ui.contentapp.setup.for5_3.ContentAppMigrationTask;
  import info.magnolia.ui.dialog.setup.migration.ControlMigratorsRegistry;
  import info.magnolia.ui.framework.setup.SetWritePermissionForActionsTask;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  import javax.inject.Inject;
  import javax.jcr.ImportUUIDBehavior;
  
  /**
   * Version handler for forum module.
   */
  public class ForumModuleVersionHandler extends DefaultModuleVersionHandler {
  
      protected static final String FORUM_APP_ACTIONS = "/modules/forum/apps/forum/subApps/browser/actions/";
      private final AddRoleToUserTask grantAllToSuperuser = new AddRoleToUserTask("Grant all forum permissions to superuser", "superuser", DefaultForumManager.ROLE_FORUM_ALL_ADMIN);
  
      private final Task removeObsoleteConfiguration = new ArrayDelegateTask("Removing custom-security-config from 4.5 which is no more working/supported by M5",
              new RemoveNodesTask("Remove obsolete configuration", RepositoryConstants.CONFIG, Arrays.asList(
                      "/modules/forum/trees/forum",
                      "/modules/adminInterface/config/securityConfiguration/repositories/forum"
                      ), false),
              new NodeExistsDelegateTask("Remove deprecated tree if exists", "/modules/forum/trees",
                      new RemoveNodeWoChildren("Remove deprecated tree", "/modules/forum/trees"))
              );
  
      private final Task fixObsoletePermissions = new ArrayDelegateTask("Fix obsolete permissions which are not supported",
              new RemovePermissionTask("", DefaultForumManager.ROLE_FORUM_ALL_USER, DefaultForumManager.FORUM_WORKSPACE, "/*", Permission.WRITE),
              new RemovePermissionTask("", DefaultForumManager.ROLE_FORUM_ALL_ADMIN, DefaultForumManager.FORUM_WORKSPACE, "/*", 111L),
              new RemovePermissionTask("", DefaultForumManager.ROLE_FORUM_ALL_MODERATOR, DefaultForumManager.FORUM_WORKSPACE, "/*", 79L),
  
              new AddPermissionTask("", DefaultForumManager.ROLE_FORUM_ALL_USER, DefaultForumManager.FORUM_WORKSPACE, "/*", Permission.ALL, false),
              new AddPermissionTask("", DefaultForumManager.ROLE_FORUM_ALL_ADMIN, DefaultForumManager.FORUM_WORKSPACE, "/*", Permission.ALL, false),
              new AddPermissionTask("", DefaultForumManager.ROLE_FORUM_ALL_MODERATOR, DefaultForumManager.FORUM_WORKSPACE, "/*", Permission.ALL, false)
              );
  
      @Inject
      public ForumModuleVersionHandler(ControlMigratorsRegistry controlMigratorsRegistry) {
  
          ForumDialogMigrationTask dialogMigrationTask = new ForumDialogMigrationTask("forum");
         controlMigratorsRegistry.register("checkboxSwitch", dialogMigrationTask.new ForumCheckBoxSwitchControlMigrator());
         controlMigratorsRegistry.register("info.magnolia.module.forum.admin.dialog.NodeNameControl", dialogMigrationTask.new RemoveControlMigrator());
         controlMigratorsRegistry.register("info.magnolia.module.forum.admin.dialog.ReferenceControl", dialogMigrationTask.new ForumEditControlMigrator());
         controlMigratorsRegistry.register("uuidLink", dialogMigrationTask.new ForumLinkControlMigrator());
 
         register(DeltaBuilder.checkPrecondition("1.3", "3.0"));
 
         register(DeltaBuilder.update("3.0.1", "")
                 .addTask(new PropertyExistsDelegateTask("Rename property", "", RepositoryConstants.CONFIG, "/modules/forum/dialogs/forumEdit/tabForum/allowsNestingMessages", "checked",
                         new ArrayDelegateTask("",
                                 new RemovePropertyTask("", "", RepositoryConstants.CONFIG, "/modules/forum/dialogs/forumEdit/tabForum/allowsNestingMessages", "checked"),
                                 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/forum/dialogs/forumEdit/tabForum/allowsNestingMessages", "selected", Boolean.FALSE)
                         )
                         )));
 
         register(DeltaBuilder.update("3.3", "")
                 .addTask(new WarnTask(String.format("Roles '%s' and '%s' aren't used anymore.", DefaultForumManager.ROLE_FORUM_BASE, DefaultForumManager.ROLE_FORUM_MODERATOR_BASE),
                         String.format("The roles '%s and '%s' aren't used anymore in the forum module. Check your users and groups; you may want to remove theses roles from users and groups and delete them.",
                                 DefaultForumManager.ROLE_FORUM_BASE, DefaultForumManager.ROLE_FORUM_MODERATOR_BASE)))
                 //
                 // => add applauncher-conf. for the new forum-app
                 .addTask(new BootstrapSingleModuleResource("Bootstrap appLaucnher-layout conf.", "Bootstraping the applauncher-layout config.", "config.modules.ui-admincentral.config.appLauncherLayout.groups.edit.apps.forum.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 //
                 // adding the complete apps-conf for both subApps
                 // ... we do not expect to find /modules/forum/apps ... but if there are, we move it
                 .addTask(moveExistingApps("/modules/forum/apps_old"))
                 // now adding app and subapps
                 .addTask(new BootstrapSingleModuleResource("Bootstrap apps into forum.", "Bootstrapping the apps into the forum conf.", "apps/config.modules.forum.apps.forum.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap subApp-folder.", "Bootstrapping subApp-folder into forum conf.", "apps/config.modules.forum.apps.forum.subApps.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 // subApp browser
                 .addTask(new BootstrapSingleModuleResource("Bootstrap subApp browser (rootNode).", "Bootstrapping browser-subApp-rootNode into forum conf.", "apps/config.modules.forum.apps.forum.subApps.browser.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap actionbar for browser-subApp.", "Bootstrapping actionbar for browser-subApp.", "apps/config.modules.forum.apps.forum.subApps.browser.actionbar.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap actions for browser-subApp.", "Bootstrapping action for browser-subApp.", "apps/config.modules.forum.apps.forum.subApps.browser.actions.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap workbench for browser-subApp.", "Bootstrapping workbench for browser-subApp.", "apps/config.modules.forum.apps.forum.subApps.browser.workbench.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 // subApp moderation
                 .addTask(new BootstrapSingleModuleResource("Bootstrap subApp moderation (rootNode).", "Bootstrapping moderation-subApprootNode into forum conf.", "apps/config.modules.forum.apps.forum.subApps.moderation.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap actionbar for moderation-subApp.", "Bootstrapping actionbar for moderation-subApp.", "apps/config.modules.forum.apps.forum.subApps.moderation.actionbar.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap actions for moderation-subApp.", "Bootstrapping action for moderation-subApp.", "apps/config.modules.forum.apps.forum.subApps.moderation.actions.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap workbench for moderation-subApp.", "Bootstrapping workbench for moderation-subApp.", "apps/config.modules.forum.apps.forum.subApps.moderation.workbench.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 //
                 // dialogs
                 // migrating the existing dialogs
                 .addTask(dialogMigrationTask)
                 // adding 2 new dialogs
                 .addTask(new BootstrapSingleModuleResource("Bootstrap dialog addForum.", "Bootstrap dialog addForum.", "dialogs/config.modules.forum.dialogs.forumAdd.xml", ImportUUIDBehavior.IMPORT_UUID_CREATE_NEW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap dialog threadNewUIA.", "Bootstrapping dialog threadNewUIA.", "dialogs/config.modules.forum.dialogs.threadNewUIA.xml", ImportUUIDBehavior.IMPORT_UUID_CREATE_NEW))
 
                 // activate-command
                 .addTask(new BootstrapSingleModuleResource("Bootstrap activation command.", "Bootstraping activation command.", "commands/forum/config.modules.forum.commands.forum.activate.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
 
                 .addTask(removeObsoleteConfiguration)
                 .addTask(fixObsoletePermissions));
 
         register(DeltaBuilder.update("3.4", "")
                 .addTask(new BootstrapSingleModuleResource("Bootstrap browser sub-app content connector.", "Bootstrapping browser sub-app content connector into forum conf.", "apps/config.modules.forum.apps.forum.subApps.browser.contentConnector.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap moderation sub-app content connector.", "Bootstrapping moderation sub-app content connector into forum conf.", "apps/config.modules.forum.apps.forum.subApps.moderation.contentConnector.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
                 .addTask(new ContentAppMigrationTask("/modules/forum"))
                 .addTask(new AppLauncherReorderingTask("forum", "edit", Order.AFTER, "assets"))
         );
         register(DeltaBuilder.update("3.4.1", "")
                 .addTask(new SetWritePermissionForActionsTask(FORUM_APP_ACTIONS, new String[] { "addForum", "deleteForum", "lockForum", "unlockForum", "createThread", "confirmDeleteForum", "confirmDeleteThread", "deleteThread", "editThread", "editForum",
                         "editMessage", "confirmDeleteMessage", "deleteMessage", "validateMessage", "invalidateMessage", "lockThread", "unlockThread", "activate", "deactivate" }))
                 .addTask(new BootstrapSingleModuleResource("Bootstrap actions for moderation-subApp.", "Bootstrapping action for moderation-subApp.", "apps/config.modules.forum.apps.forum.subApps.moderation.actions.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW)));
 
     }
 
     @Override
     protected List<Task> getExtraInstallTasks(InstallContext installContext) {
         final List<Task> tasks = new ArrayList<Task>();
         tasks.add(grantAllToSuperuser);
         tasks.add(new AppLauncherReorderingTask("forum", "edit", Order.AFTER, "assets"));
         return tasks;
     }
 
     /*
      * moves the app-folder (/modules/forum/apps) if it already exists
      */
     private Task moveExistingApps(String dest) {
         String src = "/modules/forum/apps";
         Task moveAppsTask = new MoveNodeTask("Move " + src + " to " + dest, "Moving " + src + " to " + dest, RepositoryConstants.CONFIG, src, dest, false);
         Task checkNodeTask = new NodeExistsDelegateTask("Check if " + src + " exists.", "Check if " + src + " exists.", RepositoryConstants.CONFIG, "/modules/forum/apps", moveAppsTask);
         return checkNodeTask;
     }
 
 }