ResourcesModuleVersionHandler

/**
 * This file Copyright (c) 2008-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.resources.setup;

import info.magnolia.cms.security.Permission;
import info.magnolia.cms.security.Role;
import info.magnolia.cms.security.RoleManager;
import info.magnolia.cms.security.Security;
import info.magnolia.module.InstallContext;
import info.magnolia.module.delta.AbstractTask;
import info.magnolia.module.delta.ArrayDelegateTask;
import info.magnolia.module.delta.BootstrapConditionally;
import info.magnolia.module.delta.BootstrapSingleResource;
import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
import info.magnolia.module.delta.DeltaBuilder;
import info.magnolia.module.delta.ModuleDependencyBootstrapTask;
import info.magnolia.module.delta.NodeExistsDelegateTask;
import info.magnolia.module.delta.PropertyValueDelegateTask;
import info.magnolia.module.delta.RegisterServletTask;
import info.magnolia.module.delta.RemoveNodeTask;
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.model.ServletDefinition;
import info.magnolia.module.resources.ResourceTypes;
import info.magnolia.module.resources.ResourcesModule;
import info.magnolia.repository.RepositoryConstants;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Version handler of resources module.
 */
public class ResourcesModuleVersionHandler extends ResourcesVersionHandler {

    protected static final String INPLACE_TEMPLATING_APP_LAUNCHER_CONFIG = "/modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/inplace-templating";

    private final Task removeResourcesLegacyApp = new ArrayDelegateTask("Remove Legacy Resources app", "Removes old UI pages tree, dialogs and app launcher configuration.",
            new RemoveNodeTask("Remove old UI", "Removes old UI pages.", RepositoryConstants.CONFIG, "/modules/resources/pages"),
            new RemoveNodeTask("Remove old UI", "Removes old UI tree.", RepositoryConstants.CONFIG, "/modules/resources/trees"),
            new RemoveNodeTask("Remove old UI", "Removes old UI edit dialog.", RepositoryConstants.CONFIG, "/modules/resources/dialogs"),
            new RemovePropertyTask("Remove versionOnSave property", "", RepositoryConstants.CONFIG, "/modules/resources/config", "versionOnSave"),
            new RemoveNodeTask("Remove old UI", "Remove legacy resources app config from ui-admincentral", RepositoryConstants.CONFIG, "/modules/ui-admincentral/apps/resourcesApp"),
            new RemoveNodeTask("Remove old UI", "Remove legacy resources app from applauncher layout", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/resourcesApp"));

    private Task addResourcesServletMapping() {
        ServletDefinition servletDefinition = new ServletDefinition();
        servletDefinition.setName("ResourcesServlet");
        servletDefinition.setClassName("info.magnolia.module.resources.ResourcesServlet");
        servletDefinition.setComment("a servlet used by the resources module");
        servletDefinition.addMapping("/.resources/*");
        return new RegisterServletTask(servletDefinition);
    }

    public ResourcesModuleVersionHandler() {

        register(DeltaBuilder.checkPrecondition("1.5", "2.0"));

        register(DeltaBuilder.update("1.5.1", "")
                .addTask(new NodeExistsDelegateTask("Update samples", "Update samples if they should be installed", ResourcesModule.DEFAULT_WORKSPACE, "/sample-css/MetaData",
                        new CheckAndModifyPropertyValueTask("Update template", "Update template to new name", ResourcesModule.DEFAULT_WORKSPACE, "/sample-css/MetaData", "mgnl:template", ResourceTypes.PROCESSED_CSS_SUFFIX, ResourceTypes.PROCESSED_CSS))));

        register(DeltaBuilder.update("1.5.4", "")
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Update component class", "Update cms context attribute/componentClass in text resource renderer", "config",
                        "/modules/resources/renderers/textResource/contextAttributes/cms/", "componentClass", "info.magnolia.templating.freemarker.Directives",
                        "info.magnolia.templating.freemarker.ReadOnlyDirectives")));

        register(DeltaBuilder.update("1.5.5", "")
                .addTask(new BootstrapConditionally("Register resource loader", "Allow registration of resource loaders under config/resourceLoaders node.", "/mgnl-bootstrap/resources/config/config.modules.resources.config.xml")));
        register(DeltaBuilder.update("1.5.8", "")
                .addTask(new BootstrapSingleResource("Config", "Commands configuration", "/mgnl-bootstrap/resources/commands/config.modules.resources.commands.xml")));


        register(DeltaBuilder.update("2.0.1", "")
                .addTask(new NodeExistsDelegateTask("Bootstrap Commands configuration if needed", "", RepositoryConstants.CONFIG, "/modules/resources/commands", null,
                        new BootstrapSingleResource("Bootstrap Commands configuration", "", "/mgnl-bootstrap/resources/commands/config.modules.resources.commands.xml")))
                .addTask(new NodeExistsDelegateTask("Remove version command if existing", "", RepositoryConstants.CONFIG, "/modules/resources/commands/resources/versionResources/version",
                        new RemoveNodeTask("Remove version command", "", RepositoryConstants.CONFIG, "/modules/resources/commands/resources/versionResources/version"))));

        register(DeltaBuilder.update("2.0.2", "")
                .addTask(new NodeExistsDelegateTask("Change extractComment commands class if existing", "", RepositoryConstants.CONFIG, "/modules/resources/commands/resources/versionResources/extractComment",
                        new CheckAndModifyPropertyValueTask("Update extractComment commands class", "Commands configuration", RepositoryConstants.CONFIG, "/modules/resources/commands/resources/versionResources/extractComment", "class",
                                Arrays.asList("info.magnolia.module.resources.commands.ExtractCommentCommand", "info.magnolia.module.admininterface.commands.ExtractCommentCommand"),
                                "info.magnolia.commands.impl.ExtractCommentCommand"))));

        register(DeltaBuilder.update("2.2", "")
                .addTask(removeResourcesLegacyApp));

        register(DeltaBuilder.update("2.2.1", "")
                .addTask(new RemoveNodeTask("Remove obsolete command", "Remove obsolete version command configuration", RepositoryConstants.CONFIG,
                        "/modules/resources/commands/resources/versionResources/version")));

        register(DeltaBuilder.update("2.2.2", "")
                .addTask(new NodeExistsDelegateTask("Register observation for resources if not configured", "Register observation for resources if not configured", RepositoryConstants.CONFIG,
                        "/modules/observation/config/listenerConfigurations/versionResourcesOnChange", null,
                                new ModuleDependencyBootstrapTask("observation"))
                ));

        register(DeltaBuilder.update("2.4", "")
                .addTask(new NodeExistsDelegateTask("Yaml file resources template", "/modules/resources/templates",
                        new BootstrapSingleResource("", "Register template for Yaml file resources.", "/mgnl-bootstrap/resources/templates/config.modules.resources.templates.yaml.xml")))

                .addTask(new RemoveNodeTask("Removes ClasspathSpool servlet", "Removes ClasspathSpool servlet for URL mapping '/.resources'.", RepositoryConstants.CONFIG, "/server/filters/servlets/ClasspathSpoolServlet"))
                .addTask(addResourcesServletMapping())
        );

        register(DeltaBuilder.update("2.4.2", "")
                .addTask(new ArrayDelegateTask("Change content type of JavaScript resources",
                        new PropertyValueDelegateTask("", "/modules/resources/templates/js", "contentType", "application/x-javascript", false,
                                new SetPropertyTask("config", "/modules/resources/templates/js", "contentType", "application/javascript")),
                        new PropertyValueDelegateTask("", "/modules/resources/templates/processedJs", "contentType", "application/x-javascript", false,
                                new SetPropertyTask("config", "/modules/resources/templates/processedJs", "contentType", "application/javascript"))))
                .addTask(new TemplateMigrationTask(new NodeExistsDelegateTask("Remove app launcher configuration for inplace templating", INPLACE_TEMPLATING_APP_LAUNCHER_CONFIG,
                        new RemoveNodeTask("", INPLACE_TEMPLATING_APP_LAUNCHER_CONFIG))))
        );
    }

    @Override
    protected List<Task> getExtraInstallTasks(InstallContext installContext) {
        final List<Task> tasks = new ArrayList<Task>();

        tasks.add(new AbstractTask("Anonymous permissions for resources", "Grants the anonymous user the read permission to the resources repository.") {
            @Override
            public void execute(InstallContext ignored) throws TaskExecutionException {
                RoleManager roleMan = Security.getRoleManager();
                Role anonymous = roleMan.getRole("anonymous");
                roleMan.addPermission(anonymous, "resources", "/*", Permission.READ);
            }
        });
        tasks.add(new ModuleDependencyBootstrapTask("observation"));

        return tasks;
    }

}