1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34 package info.magnolia.module.rssaggregator.setup;
35
36 import info.magnolia.dam.app.setup.migration.ChangeDataDmsReferenceToDamMigrationTask;
37 import info.magnolia.module.DefaultModuleVersionHandler;
38 import info.magnolia.module.InstallContext;
39 import info.magnolia.module.cache.RegisterWorkspaceForCacheFlushingTask;
40 import info.magnolia.module.delta.ArrayDelegateTask;
41 import info.magnolia.module.delta.BootstrapConditionally;
42 import info.magnolia.module.delta.BootstrapSingleModuleResource;
43 import info.magnolia.module.delta.BootstrapSingleResource;
44 import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
45 import info.magnolia.module.delta.CheckOrCreatePropertyTask;
46 import info.magnolia.module.delta.CreateNodeTask;
47 import info.magnolia.module.delta.DeltaBuilder;
48 import info.magnolia.module.delta.ModuleDependencyBootstrapTask;
49 import info.magnolia.module.delta.MoveNodeTask;
50 import info.magnolia.module.delta.NewPropertyTask;
51 import info.magnolia.module.delta.NodeExistsDelegateTask;
52 import info.magnolia.module.delta.OrderNodeBeforeTask;
53 import info.magnolia.module.delta.PartialBootstrapTask;
54 import info.magnolia.module.delta.PropertyExistsDelegateTask;
55 import info.magnolia.module.delta.RemoveNodeTask;
56 import info.magnolia.module.delta.SetPropertyTask;
57 import info.magnolia.module.delta.SetupModuleRepositoriesTask;
58 import info.magnolia.module.delta.Task;
59 import info.magnolia.module.model.Version;
60 import info.magnolia.module.rssaggregator.RSSAggregatorConstants;
61 import info.magnolia.repository.RepositoryConstants;
62 import info.magnolia.ui.admincentral.setup.ConvertAclToAppPermissionTask;
63 import info.magnolia.ui.contentapp.setup.for5_3.ContentAppMigrationTask;
64
65 import java.util.ArrayList;
66 import java.util.Arrays;
67 import java.util.List;
68
69 import javax.jcr.ImportUUIDBehavior;
70
71
72
73
74 public class RSSAggregatorVersionHandler extends DefaultModuleVersionHandler {
75
76 private final ArrayDelegateTask setDefaultValues = new ArrayDelegateTask("Default RSS config", "Creates default config used for RSS scheduling",
77 new PropertyExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/config", "automatedImport", null, new NewPropertyTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/config", "automatedImport", "false")),
78 new PropertyExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/config", "cron", null, new NewPropertyTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/config", "cron", "0 0 0/1 1/1 * ? *")));
79
80 public RSSAggregatorVersionHandler() {
81
82 register(DeltaBuilder.checkPrecondition("1.3", "2.0"));
83
84 register(DeltaBuilder.update("1.4", "")
85 .addTask(new BootstrapSingleResource("Planet feed component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.planetFeeds.xml"))
86 .addTask(new BootstrapSingleResource("Planet feed statistics component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedStatistics.xml"))
87 .addTask(new BootstrapSingleResource("Planet feed subcriptions component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedSubscriptions.xml"))
88
89 .addTask(new BootstrapSingleResource("Virtual URI mapping for planet feeds.", "", "/mgnl-bootstrap/rssaggregator/config.modules.rssaggregator.virtualURIMapping.planetFeeds.xml"))
90 .addTask(new BootstrapSingleResource("Feed generator for planet feeds.", "", "/mgnl-bootstrap/rssaggregator/config/feedGenerators/config.modules.rssaggregator.config.feedGenerators.planet.xml"))
91 .addTask(new BootstrapSingleResource("Feed syndication component.", "", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedSyndication.xml"))
92
93 .addTask(new BootstrapConditionally("Commands for planet RSS.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.rssaggregator.commands.xml"))
94 .addTask(new BootstrapConditionally("Scheduled job for planet archive.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.scheduler.config.jobs.generatePlanetData.xml"))
95 .addTask(new BootstrapConditionally("Scheduled job for planet statistics.", "", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.scheduler.config.jobs.collectPlanetStatistics.xml"))
96
97 .addTask(new CreateNodeTask("Planet feed options.", "Add options for planet feeds to the RSSAggregator module.",
98 RepositoryConstants.CONFIG, "/modules/rssaggregator/config", "planetOptions", "mgnl:contentNode"))
99 .addTask(new CheckOrCreatePropertyTask("Option for relevant months to be included in statistics", "",
100 RepositoryConstants.CONFIG, "/modules/rssaggregator/config/planetOptions", "lastMonthsIncluded", "3"))
101
102 .addTask(new MoveNodeTask("Move rssFeeds node.", "Move rssFeeds node to rssaggregator module.", "config", "/modules/adminInterface/virtualURIMapping/rssFeeds", "/modules/rssaggregator/virtualURIMapping/rssFeeds", false)));
103
104 register(DeltaBuilder.update("1.4.3", "")
105 .addTask(new ArrayDelegateTask("Bootstrap missing components",
106 new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph",
107 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of combinedFeedsParagraphs", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/combinedFeed.ftl", "/rssaggregator/components/combinedFeed.ftl"),
108 new BootstrapSingleResource("Bootstrap component", "Bootstrap combinedFeedsParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.combinedFeedsParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
109 ),
110 new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph",
111 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of feedListParagraph", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/feedList.ftl", "/rssaggregator/components/feedList.ftl"),
112 new BootstrapSingleResource("Bootstrap component", "Bootstrap feedListParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedListParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
113 )
114 )
115 )
116 .addTask(new NodeExistsDelegateTask("Add property", "Add property backup to rssaggregator importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator",
117 new PropertyExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", null,
118 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", Boolean.TRUE)
119 )
120 )
121 ));
122
123 register(DeltaBuilder.update("2.0", "")
124 .addTask(new RemoveNodeTask("Remove old page", "Remove old adminInterface page", RepositoryConstants.CONFIG, "/modules/adminInterface/pages/rssaggregator"))
125 .addTask(new RemoveNodeTask("Remove old menu", "Remove old adminInterface menu", RepositoryConstants.CONFIG, "/modules/adminInterface/config/menu/coonfiguration/rssaggregator")));
126
127 register(DeltaBuilder.update("2.0.2", "")
128 .addTask(new ArrayDelegateTask("Bootstrap missing components",
129 new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph",
130 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of combinedFeedsParagraphs", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/combinedFeedsParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/combinedFeed.ftl", "/rssaggregator/components/combinedFeed.ftl"),
131 new BootstrapSingleResource("Bootstrap component", "Bootstrap combinedFeedsParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.combinedFeedsParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
132 ),
133 new NodeExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph",
134 new CheckAndModifyPropertyValueTask("Change templateScript", "Change templateScript of feedListParagraph", RepositoryConstants.CONFIG, "/modules/rssaggregator/templates/components/feedListParagraph", "templateScript", "/info/magnolia/module/rssaggregator/paragraphs/feedList.ftl", "/rssaggregator/components/feedList.ftl"),
135 new BootstrapSingleResource("Bootstrap component", "Bootstrap feedListParagraph", "/mgnl-bootstrap/rssaggregator/templates/components/config.modules.rssaggregator.templates.components.feedListParagraph.xml", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)
136 )
137 )
138 )
139
140 );
141 register(DeltaBuilder.update("2.0.3", "")
142 .addTask(new NodeExistsDelegateTask("Add property", "Add property backup to rssaggregator importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator",
143 new PropertyExistsDelegateTask("", "", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", null,
144 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", Boolean.TRUE)
145 )
146 )));
147 register(DeltaBuilder.update("2.2", "")
148 .addTask(new PropertyExistsDelegateTask("Add property", "Add property backup to rssaggregator importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", null,
149 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "backup", Boolean.TRUE)))
150
151 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for scheduler jobs", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/generatePlanetData/params", "repository",
152 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/generatePlanetData/params", "repository", RSSAggregatorConstants.WORKSPACE), null))
153
154 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for scheduler jobs", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/collectPlanetStatistics/params", "repository",
155 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/scheduler/config/jobs/collectPlanetStatistics/params", "repository", RSSAggregatorConstants.WORKSPACE), null))
156
157 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for rss importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator/targets/main", "targetPath",
158 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator/targets/main", "targetPath", "/"), null))
159
160 .addTask(new PropertyExistsDelegateTask("Set property", "Set workspace for rss importer", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "repository",
161 new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/data/config/importers/rssaggregator", "repository", RSSAggregatorConstants.WORKSPACE), null))
162
163
164 .addTask(new RemoveNodeTask("Remove page", "Remove old adminInterface page", "config", "/modules/rssaggregator/pages"))
165 .addTask(new RemoveNodeTask("Remove old app", "Delete old app from app launcher if exists", "config", "/modules/ui-admincentral/config/appLauncherLayout/data/apps/RssAggregatorApp"))
166 .addTask(new RemoveNodeTask("Remove old dialogs", "Remove old adminInterface dialogs", "config", "/modules/rssaggregator/dialogs"))
167 .addTask(new RemoveNodeTask("Remove old dialogs", "Remove RSSAggregator dialog from data", "config", "/modules/data/dialogs/RssAggregator"))
168 .addTask(new RemoveNodeTask("Remove rss aggregator tree", "Remove RSSAggregator tree from data module", "config", "/modules/data/trees/RssAggregator"))
169 .addTask(new RemoveNodeTask("Remove rss aggregator type", "Remove RSSAggregator type from data module", "config", "/modules/data/config/types/RssAggregator"))
170 .addTask(new RemoveNodeTask("Remove rss aggregator menu", "Remove RSSAggregator menu from adminInterface-legacy module", "config", "/modules/adminInterface/config/menu/data/RssAggregator"))
171
172
173 .addTask(new BootstrapSingleModuleResource("Bootstrap app", "Bootstrap rssaggregator app", "app/config.modules.rssaggregator.apps.xml"))
174 .addTask(new BootstrapSingleModuleResource("Add app to app-launcher", "Add rssaggregator app to App Launcher", "app/config.modules.ui-admincentral.config.appLauncherLayout.groups.manage.apps.rssAggregator.xml"))
175 .addTask(new BootstrapSingleModuleResource("Bootstrap dialogs", "Remove old adminInterface dialogs", "dialogs/config.modules.rssaggregator.dialogs.xml"))
176 .addTask(new RSSAggregatorDataTypeMigrationTask("Migrate data", "Migrate RSS Aggregator data to RSS workspace", "/rssaggregator", "/", RSSAggregatorConstants.WORKSPACE))
177 .addTask(new ChangeDataDmsReferenceToDamMigrationTask("Migrate Hackergotchi user pics", "Migrate user pics from DMS to DAM", RSSAggregatorConstants.WORKSPACE, Arrays.asList("/"), "", ""))
178 .addTask(new SetupModuleRepositoriesTask())
179 .addTask(new ConvertAclToAppPermissionTask("Convert ACLs to permissions for 'rssAggregator' app", "Convert ACL permissions to dms to new 'assets' app permissions",
180 "/modules/adminInterface/config/menu/data/RssAggregator", "/modules/rssaggregator/apps/rssAggregator", false))
181 .addTask(new NodeExistsDelegateTask("Reorder RSS in MANAGE group", "This reorders the RSS app before Config in the Manage group of the applauncher.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/configuration",
182 new OrderNodeBeforeTask("", "", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/rssAggregator", "configuration"))));
183
184 register(DeltaBuilder.update("2.2.1", "")
185 .addTask(new RemovePropertyIfExists("Forbid nested RSS-Aggregators in 'add action' availability", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/browser/actions/addRSSAggregator/availability/nodeTypes/", "rssFeed")));
186
187 register(DeltaBuilder.update("2.2.2", "")
188 .addTask(new NodeExistsDelegateTask("Delete old app from app launcher if exists", "Delete old app from app launcher if exists", RepositoryConstants.CONFIG,
189 "/modules/ui-admincentral/config/appLauncherLayout/groups/data/apps/RssAggregatorApp",
190 new RemoveNodeTask("Delete old app from app launcher", "Delete old app from app launcher", RepositoryConstants.CONFIG,
191 "/modules/ui-admincentral/config/appLauncherLayout/groups/data/apps/RssAggregatorApp"))));
192 register(DeltaBuilder.update("2.3", "")
193 .addTask(new ContentAppMigrationTask("/modules/rssaggregator"))
194 .addTask(new BootstrapSingleModuleResource("Bootstrap button", "Bootstrap button for immediate import", "config.modules.rssaggregator.fieldTypes.xml"))
195 .addTask(new BootstrapSingleModuleResource("Bootstrap fetcher", "Bootstrap default rss fetcher", "config/config.modules.rssaggregator.config.fetcher.xml"))
196 .addTask(setDefaultValues)
197 .addTask(new PartialBootstrapTask("Bootstrap schedule tab", "Updates app with tab enabling RSS scheduling", "/mgnl-bootstrap/rssaggregator/app/config.modules.rssaggregator.apps.xml", "/apps/rssAggregator/subApps/detail/editor/form/tabs/scheduleTab", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
198 .addTask(new PartialBootstrapTask("Bootstrap command", "Bootstraps default rss import command", "/mgnl-bootstrap/rssaggregator/config/commands/config.modules.rssaggregator.commands.xml", "/commands/rss", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
199 .addTask(new RemoveNodeTask("Remove config", "Remove old configuration app co the new one can be bootstrapen", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/config"))
200 .addTask(new PartialBootstrapTask("Bootstrap new config", "Bootstraps new configuration sub-app", "/mgnl-bootstrap/rssaggregator/app/config.modules.rssaggregator.apps.xml", "/apps/rssAggregator/subApps/config", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
201 .addTask(new PartialBootstrapTask("Bootstrap action", "Bootstraps import action", "/mgnl-bootstrap/rssaggregator/app/config.modules.rssaggregator.apps.xml", "/apps/rssAggregator/subApps/browser/actions/runImport", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
202 .addTask(new PartialBootstrapTask("Bootstrap action", "Bootstraps import all action", "/mgnl-bootstrap/rssaggregator/app/config.modules.rssaggregator.apps.xml", "/apps/rssAggregator/subApps/browser/actions/runImportOnAllRSS", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
203 .addTask(new PartialBootstrapTask("Bootstrap action", "Place import all action to action bar", "/mgnl-bootstrap/rssaggregator/app/config.modules.rssaggregator.apps.xml", "/apps/rssAggregator/subApps/browser/actionbar/sections/root/groups/feedImportActions", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
204 .addTask(new PartialBootstrapTask("Bootstrap action", "Place import action to action bar", "/mgnl-bootstrap/rssaggregator/app/config.modules.rssaggregator.apps.xml", "/apps/rssAggregator/subApps/browser/actionbar/sections/rssAggregator/groups/feedImportActions", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW))
205 .addTask(new OrderNodeBeforeTask("Order action bar", "Place import feed action to proper place", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/browser/actionbar/sections/rssAggregator/groups/feedImportActions", "importExportActions"))
206 .addTask(new NodeExistsDelegateTask("Add property", "Add property for vertical layout of fields", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/editor/form/tabs/mainTab/fields/feeds/field", new NewPropertyTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/editor/form/tabs/mainTab/fields/feeds/field", "layout", "vertical")))
207 .addTask(new NodeExistsDelegateTask("Add property", "Add property for vertical layout of fields", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/editor/form/tabs/mainTab/fields/filters/field", new NewPropertyTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/editor/form/tabs/mainTab/fields/filters/field", "layout", "vertical")))
208 .addTask(new NodeExistsDelegateTask("Change save action", "Replace form save action with RSS specific one.", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/actions/commit", new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/actions/commit", "implementationClass", "info.magnolia.module.rssaggregator.action.SaveRSSAction")))
209 .addTask(new NodeExistsDelegateTask("Add transformer", "Add proper transformer class for name field.", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/editor/form/tabs/mainTab/fields/name", new SetPropertyTask("", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/detail/editor/form/tabs/mainTab/fields/name", "transformerClass", "info.magnolia.module.rssaggregator.action.RSSBasicTransformer")))
210 .addTask(new NodeExistsDelegateTask("JCR agnostic remove node", "Remove nodeTypes node.", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/browser/actions/editRSSAggregator/availability/nodeTypes", new RemoveNodeTask("", "", RepositoryConstants.CONFIG, "/modules/rssaggregator/apps/rssAggregator/subApps/browser/actions/editRSSAggregator/availability/nodeTypes")))
211 .addTask(new RegisterWorkspaceForCacheFlushingTask("rss"))
212 .addTask(new RenameFilterFieldsPropertiesTask())
213 );
214 }
215
216 @Override
217 protected List<Task> getExtraInstallTasks(InstallContext installContext) {
218 List<Task> tasks = new ArrayList<Task>();
219 tasks.add(new ModuleDependencyBootstrapTask("observation"));
220 tasks.addAll(super.getExtraInstallTasks(installContext));
221 tasks.add(new NodeExistsDelegateTask("Reorder RSS in MANAGE group", "This reorders the RSS app before Config in the Manage group of the applauncher.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/configuration",
222 new OrderNodeBeforeTask("", "", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/manage/apps/rssAggregator", "configuration")));
223 tasks.add(setDefaultValues);
224 tasks.add(new RegisterWorkspaceForCacheFlushingTask("rss"));
225 return tasks;
226 }
227
228 @Override
229 protected List<Task> getDefaultUpdateTasks(Version forVersion) {
230 final List<Task> tasks = new ArrayList<Task>();
231 tasks.addAll(super.getDefaultUpdateTasks(forVersion));
232 return tasks;
233 }
234 }