/**
    * This file Copyright (c) 2003-2014 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.setup;
  
  import info.magnolia.cms.security.Permission;
  import info.magnolia.commands.impl.MarkNodeAsDeletedCommand;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.module.AbstractModuleVersionHandler;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AddURIPermissionTask;
  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.Condition;
  import info.magnolia.module.delta.CreateNodeTask;
  import info.magnolia.module.delta.DeltaBuilder;
  import info.magnolia.module.delta.FindAndChangeTemplateIdTask;
  import info.magnolia.module.delta.MoveAndRenamePropertyTask;
  import info.magnolia.module.delta.NoSameNameSiblingsCondition;
  import info.magnolia.module.delta.NodeExistsDelegateTask;
  import info.magnolia.module.delta.OrderFilterBeforeTask;
  import info.magnolia.module.delta.PartialBootstrapTask;
  import info.magnolia.module.delta.PropertyExistsDelegateTask;
  import info.magnolia.module.delta.RemoveInstallFilesTask;
  import info.magnolia.module.delta.RemoveNodeTask;
  import info.magnolia.module.delta.RemovePermissionTask;
  import info.magnolia.module.delta.Task;
  import info.magnolia.module.delta.WarnTask;
  import info.magnolia.module.delta.WebXmlConditionsUtil;
  import info.magnolia.module.delta.WorkspaceXmlConditionsUtil;
  import info.magnolia.repository.RepositoryConstants;
  import info.magnolia.setup.for5_0.CheckOrCreateLastActivatedPropertyTask;
  import info.magnolia.setup.for5_0.ConvertMetaDataUpdateTask;
  import info.magnolia.setup.for5_0.Register50NodeTypeTask;
  import info.magnolia.setup.for5_0.RemoveMetaDataInNodeTypeDefinitionTask;
  import info.magnolia.setup.for5_2.AddActivatableMixinForContentNodeTask;
  import info.magnolia.setup.for5_2.GrantReadPermissionToRolesTask;
  import info.magnolia.setup.for5_2.IsNotAProblematicEnvironmentCondition;
  import info.magnolia.setup.for5_2.RemoveOpenWFEPermissionsTask;
  import info.magnolia.setup.initial.GenericTasks;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import javax.jcr.ImportUUIDBehavior;
  
  /**
   * Special VersionHandler for the core module. As it does not extend {@link info.magnolia.module.DefaultModuleVersionHandler} it has a special getBasicInstallTasks(InstallContext) that
   * e.g. will not automatically bootstrap xml-files placed in mgnl-bootstrap/core.
   */
  public class CoreModuleVersionHandler extends AbstractModuleVersionHandler {
      public static final String BOOTSTRAP_AUTHOR_INSTANCE_PROPERTY = "magnolia.bootstrap.authorInstance";
      protected static final String SECURITY_BASE_ROLE = "security-base";
  
      // TODO : why is this a BootstrapConditionally and not a BootstrapSingleResource ?
      private final BootstrapConditionally auditTrailManagerTask = new BootstrapConditionally("New auditory log configuration", "Install new configuration for auditory log manager.", "/mgnl-bootstrap/core/config.server.auditLogging.xml");
      private final BootstrapSingleResource bootstrapFreemarker = new BootstrapSingleResource("Freemarker configuration", "Freemarker template loaders can now be configured in Magnolia. Adds default configuration", "/mgnl-bootstrap/core/config.server.rendering.freemarker.xml");
      private final CreateNodeTask addFreemarkerSharedVariables = new CreateNodeTask("Freemarker configuration", "Adds sharedVariables node to the Freemarker configuration",
              RepositoryConstants.CONFIG, "/server/rendering/freemarker", "sharedVariables", NodeTypes.ContentNode.NAME);
      private final BootstrapSingleResource bootstrapWebContainerResources = new BootstrapSingleResource("Web container resources configuration", "Global configuration which resources are not meant to be handled by Magnolia. For instance JSP files.", "/mgnl-bootstrap/core/config.server.webContainerResources.xml");
      private final BootstrapSingleModuleResource bootstrapChannelManagement = new BootstrapSingleModuleResource("ChannelManagement configuration", "", "config.server.rendering.channelManagement.xml");
  
      private final BootstrapSingleModuleResource bootstrapChannelFilter = new BootstrapSingleModuleResource("ChannelFilter configuration", "", "config.server.filters.channel.xml");
      private final Task placeChannelBeforeLogout = new OrderFilterBeforeTask("channel", new String[] { "logout" });
      private final Task updateSecurityBaseRole = updateSecurityBaseRole();
  
     private final Task removeObsoleteInstallFiles = new RemoveInstallFilesTask("Remove obsolete dms templates install files", "templates/dms");
     private final Task adjustSecurityBaseRole = new ArrayDelegateTask("",
             new RemovePermissionTask("Remove 'security-base' role permission", SECURITY_BASE_ROLE,
                     RepositoryConstants.USER_ROLES, "/" + SECURITY_BASE_ROLE, Permission.READ),
             new RemovePermissionTask("Remove obsolete 'security-base' role permission", SECURITY_BASE_ROLE,
                     "uri", "/.magnolia/pages/sendMail*", AddURIPermissionTask.DENY),
             new RemovePermissionTask("Remove obsolete 'security-base' role permission", SECURITY_BASE_ROLE,
                     "uri", "/.magnolia/pages/groovyInteractiveConsole*", AddURIPermissionTask.DENY)
             );
 
     private Task updateSecurityBaseRole() {
         ArrayDelegateTask permissionsTask = new ArrayDelegateTask("Update security-base role", "Disallow access to view configuration/tools pages");
         permissionsTask.addTask(new RemovePermissionTask("", "", SECURITY_BASE_ROLE, "uri", "/.magnolia/pages/installedModulesList.html", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new RemovePermissionTask("", "", SECURITY_BASE_ROLE, "uri", "/.magnolia/pages/jcrUtils.html", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new RemovePermissionTask("", "", SECURITY_BASE_ROLE, "uri", "/.magnolia/pages/configuration.html", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new RemovePermissionTask("", "", SECURITY_BASE_ROLE, "uri", "/.magnolia/pages/logViewer.html", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new RemovePermissionTask("", "", SECURITY_BASE_ROLE, "uri", "/.magnolia/pages/sendMail.html", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/installedModulesList*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/jcrUtils*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/configuration*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/logViewer*", AddURIPermissionTask.DENY));
 
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/users*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/import*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/export*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/messages*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/permission*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/developmentUtils*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/activationTools*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/migrationReport*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/backup*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/activationMonitor*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/installedModulesList*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/allModulesList*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/cacheTools*", AddURIPermissionTask.DENY));
         permissionsTask.addTask(new AddURIPermissionTask("", "", SECURITY_BASE_ROLE, "/.magnolia/pages/flows*", AddURIPermissionTask.DENY));
         return permissionsTask;
     }
 
     public CoreModuleVersionHandler() {
         super();
 
         register(DeltaBuilder.checkPrecondition("4.5", "5.0"));
 
         register(DeltaBuilder.update("4.5.2", "")
                 .addTask(new PropertyExistsDelegateTask("Fix property name", "", RepositoryConstants.CONFIG, "/server/security/userManagers/system", "realName", new MoveAndRenamePropertyTask("Fix propertyName", "/server/security/userManagers/system", "realName", "/server/security/userManagers/system", "realmName")))
                 .addTask(new PropertyExistsDelegateTask("Fix property name", "", RepositoryConstants.CONFIG, "/server/security/userManagers/admin", "realName", new MoveAndRenamePropertyTask("Fix propertyName", "/server/security/userManagers/admin", "realName", "/server/security/userManagers/admin", "realmName"))));
 
         register((DeltaBuilder.update("4.5.9", ""))
                 .addTask(new NodeExistsDelegateTask("AuditLogging configurations", "Add auditLogging configurations for delete action", "config", "/server/auditLogging/logConfigurations/delete", null, new PartialBootstrapTask("", "", "/mgnl-bootstrap/core/config.server.auditLogging.xml", "/auditLogging/logConfigurations/delete", ImportUUIDBehavior.IMPORT_UUID_CREATE_NEW)))
                 .addTask(new CheckAndModifyPropertyValueTask("AuditLogging configurations", "Change auditLogging class", "config", "/server/auditLogging", "class", "info.magnolia.logging.AuditLoggingManager", "info.magnolia.audit.AuditLoggingManager"))
                 .addTask(updateSecurityBaseRole));
         register(DeltaBuilder.update("5.0", "")
                 .addTask(new Register50NodeTypeTask("Register the new M5 node Type", "", RepositoryConstants.CONFIG))
                 .addTask(new RemoveMetaDataInNodeTypeDefinitionTask("Un register the metaData child node", "", RepositoryConstants.CONFIG))
                 .addTask(new ConvertMetaDataUpdateTask("Convert MetaData Task", "Remove the metaData sub node and replace them with mixIn when appropriate"))
                 .addTask(new RemoveNodeTask("Remove PageEditorServlet", "Remove obsolete PageEditorServlet configuration.", RepositoryConstants.CONFIG, "/server/filters/servlets/PageEditorServlet"))
                 .addTask(new RemoveNodeTask("Remove obsolete 'templating-editor' configuration", "", RepositoryConstants.CONFIG, "/modules/magnolia-templating-editor"))
                 .addTask(new PartialBootstrapTask("Bootstrap link transformers", "Bootstrap 'server/rendering/linkManagement/transformers", "/mgnl-bootstrap/core/config.server.rendering.linkManagement.xml", "/linkManagement/transformers")));
         register((DeltaBuilder.update("5.0.1", ""))
                 .addTask(new CheckAndModifyPropertyValueTask("MIMEMapping", "Change xsl extension mime-type from text/xml to application/xml", RepositoryConstants.CONFIG, "/server/MIMEMapping/xsl", "mime-type", "text/xml", "application/xml"))
                 .addTask(new CheckAndModifyPropertyValueTask("MIMEMapping", "Change xml extension mime-type from text/xml to application/xml", RepositoryConstants.CONFIG, "/server/MIMEMapping/xml", "mime-type", "text/xml", "application/xml")));
         register((DeltaBuilder.update("5.0.3", ""))
                 .addTask(new PartialBootstrapTask("JSON", "Add JSON mime-type", "/mgnl-bootstrap/core/config.server.MIMEMapping.xml", "/MIMEMapping/json")));
         register((DeltaBuilder.update("5.1", ""))
                 .addTask(new WarnTask("respectOrderDocument parameter", "As of Magnolia 5.1, the respectOrderDocument parameter has been reintroduced in repo config files and set to true by default. You will need to set it manually for each workspace in your installation. Please, refer to the release notes for more details."))
                 .addTask(new RemoveNodeTask("Remove intercept filter", "Removes no longer used intercept filter.", RepositoryConstants.CONFIG, "/server/filters/cms/intercept")));
         register((DeltaBuilder.update("5.1.1", ""))
                 .addTask(new NodeExistsDelegateTask("Set mgnl:lastActivated date of the user superuser", "Set mgnl:lastActivated date of the user superuser (if not set yet)", RepositoryConstants.USERS, "/system/superuser",
                         new CheckOrCreateLastActivatedPropertyTask("", "", RepositoryConstants.USERS, "/system/superuser")))
                 .addTask(new NodeExistsDelegateTask("Set mgnl:lastActivated date of the user anonymous", "Set mgnl:lastActivated date of the user anonymous (if not set yet)", RepositoryConstants.USERS, "/system/anonymous",
                         new CheckOrCreateLastActivatedPropertyTask("", "", RepositoryConstants.USERS, "/system/anonymous")))
                 .addTask(new NodeExistsDelegateTask("Set mgnl:lastActivated date of the superuser role", "Set mgnl:lastActivated date of the superuser role (if not set yet)", RepositoryConstants.USER_ROLES, "/superuser",
                         new CheckOrCreateLastActivatedPropertyTask("", "", RepositoryConstants.USER_ROLES, "/superuser")))
                 .addTask(new NodeExistsDelegateTask("Set mgnl:lastActivated date of the anonymous role", "Set mgnl:lastActivated date of the anonymous role (if not set yet)", RepositoryConstants.USER_ROLES, "/anonymous",
                         new CheckOrCreateLastActivatedPropertyTask("", "", RepositoryConstants.USER_ROLES, "/anonymous")))
                 .addTask(new NodeExistsDelegateTask("Set mgnl:lastActivated date of the security-base role", "Set mgnl:lastActivated date of the security-base role (if not set yet)", RepositoryConstants.USER_ROLES, "/security-base",
                         new CheckOrCreateLastActivatedPropertyTask("", "", RepositoryConstants.USER_ROLES, "/security-base")))
                 .addTask(new FindAndChangeTemplateIdTask("Change template id mgnlDelete", "Change template id mgnlDeleted to ui-admincentral:deleted for all content marked as deleted in website repository", RepositoryConstants.WEBSITE, "mgnlDeleted", MarkNodeAsDeletedCommand.DELETED_NODE_TEMPLATE))
                 .addTask(new FindAndChangeTemplateIdTask("Change template id adminInterface:mgnlDeleted", "Change template id adminInterface:mgnlDeleted to ui-admincentral:deleted for all content marked as deleted in website repository", RepositoryConstants.WEBSITE, "adminInterface:mgnlDeleted", MarkNodeAsDeletedCommand.DELETED_NODE_TEMPLATE)));
         register((DeltaBuilder.update("5.1.2", ""))
                 .addTask(new ChangeNodeTypeOfSubAppsTask("Change primary node type of subapps", "If primary node type of subapps node is set to " + NodeTypes.Content.NAME + " then change it to " + NodeTypes.ContentNode.NAME))
                 .addTask(new PartialBootstrapTask("Anonymous user", "Change anonymous user permission. He can't have write access to himself.", "/mgnl-bootstrap/core/users.system.anonymous.xml", "/anonymous/acl_users")));
         register((DeltaBuilder.update("5.2.1", ""))
                 .addTask(new RemoveOpenWFEPermissionsTask("Find and remove all openWFE permissions from the userroles workspace", ""))
                 .addTask(new GrantReadPermissionToRolesTask("Set read-permission to role itself", "If a role do not have a read permission to itself, add it")));
         register((DeltaBuilder.update("5.2.2", ""))
                 .addTask(removeObsoleteInstallFiles)
                 .addTask(new AddActivatableMixinForContentNodeTask("Add the mixIn '" + NodeTypes.Activatable.NAME + "' to the '" + NodeTypes.ContentNode.NAME + "' node type definition", "", RepositoryConstants.CONFIG)));
         register((DeltaBuilder.update("5.2.3", ""))
                 .addTask(new RemovePermissionTask("Remove 'anonymous' role permission", "anonymous",
                         RepositoryConstants.USER_ROLES, "/anonymous", Permission.READ))
                 .addTask(adjustSecurityBaseRole));
     }
 
     @Override
     protected List<Task> getBasicInstallTasks(InstallContext ctx) {
         final List<Task> tasks = new ArrayList<Task>();
         tasks.addAll(GenericTasks.genericTasksForNewInstallation());
         tasks.add(auditTrailManagerTask);
         tasks.add(bootstrapFreemarker);
         tasks.add(addFreemarkerSharedVariables);
         tasks.add(bootstrapWebContainerResources);
         tasks.add(new BootstrapConditionally("Security", "Bootstraps security-base role.", "/mgnl-bootstrap/core/userroles.security-base.xml"));
         // always hash passwords. Task will not re-hash so it is safe to run this op at any time, multiple times.
         tasks.add(new HashUsersPasswords());
         tasks.add(bootstrapChannelManagement);
         tasks.add(bootstrapChannelFilter);
         tasks.add(placeChannelBeforeLogout);
 
         return tasks;
     }
 
     @Override
     protected List<Condition> getInstallConditions() {
         final ArrayList<Condition> conditions = new ArrayList<Condition>();
 
         conditions.add(new IsNotAProblematicEnvironmentCondition());
 
         final WebXmlConditionsUtil u = new WebXmlConditionsUtil(conditions);
         u.servletIsNowWrapped("ActivationHandler");
         u.servletIsNowWrapped("AdminTreeServlet");
         u.servletIsNowWrapped("classpathspool");
         u.servletIsNowWrapped("DialogServlet");
         u.servletIsNowWrapped("PageServlet");
         u.servletIsNowWrapped("log4j");
         u.servletIsNowWrapped("FCKEditorSimpleUploadServlet");
         u.servletIsDeprecated("uuidRequestDispatcher");
         u.filterIsDeprecated("info.magnolia.cms.filters.MagnoliaManagedFilter", "info.magnolia.cms.filters.MgnlMainFilter");
         u.filterMustBeRegisteredWithCorrectDispatchers("info.magnolia.cms.filters.MgnlMainFilter");
         u.listenerIsDeprecated("info.magnolia.cms.servlets.PropertyInitializer", "info.magnolia.cms.servlets.MgnlServletContextListener");
         u.listenerIsDeprecated("info.magnolia.cms.beans.config.ShutdownManager", "info.magnolia.cms.servlets.MgnlServletContextListener");
         final WorkspaceXmlConditionsUtil u2 = new WorkspaceXmlConditionsUtil(conditions);
         u2.textFilterClassesAreNotSet();
 
         conditions.add(new SystemTmpDirCondition());
         conditions.add(new NoSameNameSiblingsCondition());
 
         return conditions;
     }
 }