BlossomVersionHandler

/**
 * This file Copyright (c) 2003-2010 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.blossom;

import info.magnolia.cms.beans.config.ContentRepository;
import info.magnolia.module.AbstractModuleVersionHandler;
import info.magnolia.module.InstallContext;
import info.magnolia.module.admininterface.dialogs.ParagraphSelectDialog;
import info.magnolia.module.blossom.gui.BlossomParagraphEditDialog;
import info.magnolia.module.blossom.preexecution.BlossomFilter;
import info.magnolia.module.blossom.render.BlossomParagraphRenderer;
import info.magnolia.module.blossom.render.BlossomTemplateRenderer;
import info.magnolia.module.delta.BootstrapSingleResource;
import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
import info.magnolia.module.delta.DeltaBuilder;
import info.magnolia.module.delta.FilterOrderingTask;
import info.magnolia.module.delta.Task;

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

/**
 * VersionHandler for upgrading and installing the module.
 */
public class BlossomVersionHandler extends AbstractModuleVersionHandler {

    public BlossomVersionHandler() {
        register(DeltaBuilder.update("1.1.1", "")
                .addTask(new FilterOrderingTask(
                        "blossom",
                        "Places the Blossom filter in chain.",
                        new String[]{"context", "multipartRequest"}))
                .addTask(new BootstrapSingleResource(
                        "VirtualURIMapping",
                        "Bootstraps the Blossom VirtualURIMapping.",
                        "/mgnl-bootstrap/blossom/config.modules.blossom.virtualURIMapping.xml"))
        );
        register(DeltaBuilder.update("1.0", "")
                .addTask(new BootstrapSingleResource(
                "Template renderer",
                "Bootstraps the Blossom template renderer.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.template-renderers.xml"))
        );
        register(DeltaBuilder.update("1.1", "")
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Uninstall custom dialog for selecting paragraphs",
                        "Changes to the default Magnolia select dialog",
                        ContentRepository.CONFIG,
                        "/modules/adminInterface/dialogs/selectParagraph",
                        "class",
                        "se.issi.magnolia.module.blossom.gui.BlossomParagraphSelectDialog",
                        ParagraphSelectDialog.class.getName()))
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Update class name of custom dialog for editing paragraphs",
                        "Changes the class name of BlossomParagraphEditDialog",
                        ContentRepository.CONFIG,
                        "/modules/adminInterface/dialogs/editParagraph",
                        "class",
                        "se.issi.magnolia.module.blossom.gui.BlossomParagraphEditDialog",
                        BlossomParagraphEditDialog.class.getName()))
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Update class name for ParagraphRenderer",
                        "Changes the class name of the ParagraphRenderer",
                        ContentRepository.CONFIG,
                        "/modules/blossom/paragraph-renderers/blossom",
                        "class",
                        "se.issi.magnolia.module.blossom.render.BlossomParagraphRenderer",
                        BlossomParagraphRenderer.class.getName()))
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Update class name for TemplateRenderer",
                        "Changes the class name of the TemplateRenderer",
                        ContentRepository.CONFIG,
                        "/modules/blossom/template-renderers/blossom",
                        "renderer",
                        "se.issi.magnolia.module.blossom.render.BlossomTemplateRenderer",
                        BlossomTemplateRenderer.class.getName()))
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Update class name for BlossomFilter",
                        "Changes the class name of the BlossomFilter",
                        ContentRepository.CONFIG,
                        "/server/filters/blossom",
                        "class",
                        "se.issi.magnolia.module.blossom.preexecution.BlossomFilter",
                        BlossomFilter.class.getName()))
        );
    }

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

        tasks.add(new BootstrapSingleResource(
                "New paragraph renderer",
                "Bootstraps the Blossom paragraph renderer.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.paragraph-renderers.xml"));

        tasks.add(new BootstrapSingleResource(
                "New dialog",
                "Bootstraps the Blossom dialog.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.dialogs.xml"));

        tasks.add(new BootstrapSingleResource(
                "New paragraph",
                "Bootstraps the Blossom paragraph.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.paragraphs.xml"));

        tasks.add(new CheckAndModifyPropertyValueTask(
                "Custom dialog for editing paragraphs",
                "Changes the default Magnolia edit dialog",
                ContentRepository.CONFIG,
                "/modules/adminInterface/dialogs/editParagraph",
                "class",
                "info.magnolia.module.admininterface.dialogs.ParagraphEditDialog",
                BlossomParagraphEditDialog.class.getName()));

        tasks.add(new BootstrapSingleResource(
                "New filter",
                "Bootstraps the Blossom pre-execution filter.",
                "/mgnl-bootstrap/blossom/config.server.filters.blossom.xml"));

        tasks.add(new FilterOrderingTask(
                "blossom",
                "Places the Blossom filter in chain.",
                new String[]{"context", "multipartRequest"}));

        tasks.add(new BootstrapSingleResource(
                "Template renderer",
                "Bootstraps the Blossom template renderer.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.template-renderers.xml"));

        tasks.add(new BootstrapSingleResource(
                "VirtualURIMapping",
                "Bootstraps the Blossom VirtualURIMapping.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.virtualURIMapping.xml"));

        return tasks;
    }
}