RSSAggregatorVersionHandler

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

import info.magnolia.migration.task.SimpleSTKRelatedModuleMigrationTask;
import info.magnolia.module.DefaultModuleVersionHandler;
import info.magnolia.module.InstallContext;
import info.magnolia.module.data.setup.RegisterNodeTypeTask;
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.CheckOrCreatePropertyTask;
import info.magnolia.module.delta.CreateNodeTask;
import info.magnolia.module.delta.DeltaBuilder;
import info.magnolia.module.delta.ModuleDependencyBootstrapTask;
import info.magnolia.module.delta.NodeExistsDelegateTask;
import info.magnolia.module.delta.Task;
import info.magnolia.module.model.Version;
import info.magnolia.repository.RepositoryConstants;

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

// import info.magnolia.module.delta.BootstrapResourcesTask;

/**
 * Version handler.
 *
 * @author had
 */
public class RSSAggregatorVersionHandler extends DefaultModuleVersionHandler {

    public RSSAggregatorVersionHandler() {

        register(DeltaBuilder.checkPrecondition("1.2.2", "1.3"));

        register(DeltaBuilder.update("1.3", "")
                .addTask(new SimpleSTKRelatedModuleMigrationTask("Migration task: Migrate RSS configuration repository", "Migrate configuration of templates, dialogs and site definitions", "rssaggregator", false, Arrays.asList("")))
                .addTask(new NodeExistsDelegateTask("Renamed modelClass", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/paragraphs",
                        new ArrayDelegateTask("Renamed modelClass ", "",
                                new CheckAndModifyPropertyValueTask("Renamed modelClass of the combinedFeedsParagraph node", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/paragraphs/combinedFeedsParagraph", "modelClass", "info.magnolia.module.rssaggregator.CombinedFeedAction", "info.magnolia.module.rssaggregator.templates.components.CombinedFeedModel"),
                                new CheckAndModifyPropertyValueTask("Renamed modelClass of the feedListParagraph node", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/paragraphs/feedListParagraph", "modelClass", "info.magnolia.module.rssaggregator.FeedListAction", "info.magnolia.module.rssaggregator.templates.components.FeedListModel")),
                        new ArrayDelegateTask("Renamed modelClass ", "",
                                new CheckAndModifyPropertyValueTask("Renamed modelClass of the combinedFeedsParagraph node", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph", "modelClass", "info.magnolia.module.rssaggregator.CombinedFeedAction", "info.magnolia.module.rssaggregator.templates.components.CombinedFeedModel"),
                                new CheckAndModifyPropertyValueTask("Renamed modelClass of the feedListParagraph node", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph", "modelClass", "info.magnolia.module.rssaggregator.FeedListAction", "info.magnolia.module.rssaggregator.templates.components.FeedListModel"))
                )
                )
        );

        register(DeltaBuilder.update("1.4", "")
                .addTask(new BootstrapSingleResource("Planet feed component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.planetFeeds.xml"))
                .addTask(new BootstrapSingleResource("Planet feed dialog.", "", "/mgnl-bootstrap/rssaggregator/dialogs/config.modules.rssaggregator.dialogs.planetFeeds.xml"))
                .addTask(new BootstrapSingleResource("Planet feed statistics component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedStatistics.xml"))
                .addTask(new BootstrapSingleResource("Planet feed statistics dialog.", "", "/mgnl-bootstrap/rssaggregator/dialogs/config.modules.rssaggregator.dialogs.feedStatistics.xml"))
                .addTask(new BootstrapSingleResource("Planet feed subcriptions component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedSubscriptions.xml"))
                .addTask(new BootstrapSingleResource("Planet feed subcriptions dialog.", "", "/mgnl-bootstrap/rssaggregator/dialogs/config.modules.rssaggregator.dialogs.feedSubscriptions.xml"))
                        // settings for feed syndication
                .addTask(new BootstrapSingleResource("Virtual URI mapping for planet feeds.", "", "/mgnl-bootstrap/rssaggregator/config.modules.adminInterface.virtualURIMapping.planetFeeds.xml"))
                .addTask(new BootstrapSingleResource("Feed generator for planet feeds.", "", "/mgnl-bootstrap/rssaggregator/config/feedGenerators/config.modules.rssaggregator.config.feedGenerators.planet.xml"))
                .addTask(new BootstrapSingleResource("Feed syndication component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedSyndication.xml"))
                .addTask(new BootstrapSingleResource("Feed syndication dialog.", "", "/mgnl-bootstrap/rssaggregator/dialogs/config.modules.rssaggregator.dialogs.feedSyndication.xml"))
                        // planet commands
                .addTask(new BootstrapConditionally("Commands for planet RSS.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.rssaggregator.commands.xml"))
                .addTask(new BootstrapConditionally("Scheduled job for planet archive.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.scheduler.config.jobs.generatePlanetData.xml"))
                .addTask(new BootstrapConditionally("Scheduled job for planet statistics.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.scheduler.config.jobs.collectPlanetStatistics.xml"))
                        // add planet feed option to RSSAggregator dialog
                .addTask(new CreateNodeTask("Planet feed option for combined RSS feeds.", "Add an option to check if an RSS feed is a planet feed.",
                        RepositoryConstants.CONFIG, "/modules/data/dialogs/RssAggregator/mainTab", "planetFeed", "mgnl:contentNode"))
                .addTask(new CheckOrCreatePropertyTask("Control property for planet option.", "",
                        RepositoryConstants.CONFIG, "/modules/data/dialogs/RssAggregator/mainTab/planetFeed", "controlType", "checkboxSwitch"))
                .addTask(new CheckOrCreatePropertyTask("Control property for planet option.", "Add a property for the RSS feed dialog.",
                        RepositoryConstants.CONFIG, "/modules/data/dialogs/RssAggregator/mainTab/planetFeed", "description", "rssaggregator.data.dialog.planetFeed.description"))
                .addTask(new CheckOrCreatePropertyTask("Control property for planet option.", "Add a property for the RSS feed dialog.",
                        RepositoryConstants.CONFIG, "/modules/data/dialogs/RssAggregator/mainTab/planetFeed", "label", "rssaggregator.data.dialog.planetFeed.label"))
                .addTask(new CheckOrCreatePropertyTask("Control property for planet option.", "Add a property for the RSS feed dialog.",
                        RepositoryConstants.CONFIG, "/modules/data/dialogs/RssAggregator/mainTab/planetFeed", "selected", "false"))
                .addTask(new CheckOrCreatePropertyTask("Control property for planet option.", "Add a property for the RSS feed dialog.",
                        RepositoryConstants.CONFIG, "/modules/data/dialogs/RssAggregator/mainTab/planetFeed", "type", "String"))
                        // add config options for planet
                .addTask(new CreateNodeTask("Planet feed options.", "Add options for planet feeds to the RSSAggregator module.",
                        RepositoryConstants.CONFIG, "/modules/rssaggregator/config", "planetOptions", "mgnl:contentNode"))
                .addTask(new CheckOrCreatePropertyTask("Option for relevant months to be included in statistics", "",
                        RepositoryConstants.CONFIG, "/modules/rssaggregator/config/planetOptions", "lastMonthsIncluded", "3"))
        );

    }

    @Override
    protected List<Task> getBasicInstallTasks(InstallContext installContext) {
        final List<Task> installTasks = new ArrayList<Task>();
        // make sure we register the type before doing anything else
        installTasks.add(new RegisterNodeTypeTask("RssAggregator"));
        installTasks.addAll(super.getBasicInstallTasks(installContext));
        return installTasks;
    }

    @Override
    protected List<Task> getExtraInstallTasks(InstallContext installContext) {
        List<Task> tasks = new ArrayList<Task>();
        tasks.add(new ModuleDependencyBootstrapTask("observation"));
        tasks.addAll(super.getExtraInstallTasks(installContext));
        return tasks;
    }

    @Override
    protected List<Task> getDefaultUpdateTasks(Version forVersion) {
        final List<Task> tasks = new ArrayList<Task>();
        tasks.addAll(super.getDefaultUpdateTasks(forVersion));
        return tasks;
    }
}