BlossomVersionHandler

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

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

import info.magnolia.module.AbstractModuleVersionHandler;
import info.magnolia.module.InstallContext;
import info.magnolia.module.admininterface.dialogs.ParagraphEditDialog;
import info.magnolia.module.admininterface.dialogs.ParagraphSelectDialog;
import info.magnolia.module.blossom.preexecution.BlossomFilter;
import info.magnolia.module.delta.BootstrapSingleResource;
import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
import info.magnolia.module.delta.DeltaBuilder;
import info.magnolia.module.delta.MoveNodeTask;
import info.magnolia.module.delta.OrderNodeBeforeTask;
import info.magnolia.module.delta.RemoveNodeTask;
import info.magnolia.module.delta.Task;
import info.magnolia.module.delta.WarnTask;
import info.magnolia.repository.RepositoryConstants;

/**
 * VersionHandler for upgrading and installing the module. Note that this VersionHandler does not inherit from
 * DefaultModuleVersionHandler and has no default behaviour such as installing all bootstrap xml files. They need to
 * be explicitly installed.
 *
 * @since 0.5
 */
public class BlossomVersionHandler extends AbstractModuleVersionHandler {

    public BlossomVersionHandler() {

        // 2.0.1 adds a warning about the migration steps necessary
        register(DeltaBuilder.update("2.0.1", "")
                .addTask(new WarnTask("Blossom templates", "Naming convention for Blossom templates changed between versions 1.x and 2.0. It is not possible to automatically convert between them using a migration script. You can write an update task to change the old names to the new ones. Have a look at http://wiki.magnolia-cms.com/display/WIKI/Migrating+content+when+upgrading+to+Blossom+2"))
        );

        // 2.0 adds new renderer for Magnolia 4.5 rendering, removes the old renderers the placeholder paragraph and the blossom dialog
        register(DeltaBuilder.update("2.0", "")
                .addTask(new BootstrapSingleResource(
                        "New renderer",
                        "Bootstraps the Blossom renderer.",
                        "/mgnl-bootstrap/blossom/config.modules.blossom.renderers.blossom.xml"))
                .addTask(new OrderNodeBeforeTask(
                        "Order Blossom filter",
                        "",
                        RepositoryConstants.CONFIG,
                        "/server/filters/cms/blossom",
                        "rendering"))
                .addTask(new RemoveNodeTask(
                        "Remove obsolete template renderer",
                        "",
                        RepositoryConstants.CONFIG,
                        "/modules/blossom/template-renderers"))
                .addTask(new RemoveNodeTask(
                        "Remove obsolete paragraph renderer",
                        "",
                        RepositoryConstants.CONFIG,
                        "/modules/blossom/paragraph-renderers"))
                .addTask(new RemoveNodeTask(
                        "Remove paragraphs folder",
                        "",
                        RepositoryConstants.CONFIG,
                        "/modules/blossom/paragraphs"))
                .addTask(new RemoveNodeTask(
                        "Remove dialogs folder",
                        "",
                        RepositoryConstants.CONFIG,
                        "/modules/blossom/dialogs"))

                        // Restores the edit dialog for paragraphs to the original value. In earlier versions Blossom customized this dialog
                        // and the class name changed twice so we check if its any of the three variations used and change it back.
                .addTask(new MultiCheckAndModifyPropertyValueTask(
                        "Uninstall custom dialog for editing paragraphs",
                        "Changes to the default Magnolia dialog",
                        "/modules/adminInterface/dialogs/editParagraph",
                        "class",
                        new String[]{
                                "se.issi.magnolia.module.blossom.gui.BlossomParagraphEditDialog",
                                "info.magnolia.module.blossom.gui.BlossomParagraphEditDialog",
                                "info.magnolia.module.blossom.paragraph.BlossomParagraphEditDialog"},
                        ParagraphEditDialog.class.getName()
                ))
        );

        // 1.2 Moves the blossom filter deeper in the chain and removes the custom ParagraphEditDialog
        register(DeltaBuilder.update("1.2", "")
                .addTask(new MoveNodeTask(
                        "Move the Blossom filter in chain",
                        "",
                        RepositoryConstants.CONFIG,
                        "/server/filters/blossom",
                        "/server/filters/cms/blossom",
                        false))
        );

        // 1.1.1 adds support for VirtualUriMappings and multipart
        register(DeltaBuilder.update("1.1.1", "")
                .addTask(new BootstrapSingleResource(
                        "VirtualURIMapping",
                        "Bootstraps the Blossom VirtualURIMapping.",
                        "/mgnl-bootstrap/blossom/config.modules.blossom.virtualURIMapping.xml"))
        );

        // 1.1 changes package names to info.magnolia and removes the custom ParagraphSelectDialog
        register(DeltaBuilder.update("1.1", "")
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Uninstall custom dialog for selecting paragraphs",
                        "Changes to the default Magnolia select dialog",
                        RepositoryConstants.CONFIG,
                        "/modules/adminInterface/dialogs/selectParagraph",
                        "class",
                        "se.issi.magnolia.module.blossom.gui.BlossomParagraphSelectDialog",
                        ParagraphSelectDialog.class.getName()))
                .addTask(new CheckAndModifyPropertyValueTask(
                        "Update class name for BlossomFilter",
                        "Changes the class name of the BlossomFilter",
                        RepositoryConstants.CONFIG,
                        "/server/filters/blossom",
                        "class",
                        "se.issi.magnolia.module.blossom.preexecution.BlossomFilter",
                        BlossomFilter.class.getName()))
        );
    }

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

        tasks.add(new BootstrapSingleResource(
                "New filter",
                "Bootstraps the Blossom pre-execution filter.",
                "/mgnl-bootstrap/blossom/config.server.filters.cms.blossom.xml"));
        tasks.add(new OrderNodeBeforeTask(
                "Order Blossom filter",
                "",
                RepositoryConstants.CONFIG,
                "/server/filters/cms/blossom",
                "rendering"));
        tasks.add(new BootstrapSingleResource(
                "New renderer",
                "Bootstraps the Blossom renderer.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.renderers.blossom.xml"));
        tasks.add(new BootstrapSingleResource(
                "VirtualURIMapping",
                "Bootstraps the Blossom VirtualURIMapping.",
                "/mgnl-bootstrap/blossom/config.modules.blossom.virtualURIMapping.xml"));

        return tasks;
    }

}