View Javadoc
1   /**
2    * This file Copyright (c) 2018-2020 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.content.setup;
35  
36  import info.magnolia.content.observer.ContentImporterModule;
37  import info.magnolia.init.MagnoliaConfigurationProperties;
38  import info.magnolia.jcr.nodebuilder.task.ErrorHandling;
39  import info.magnolia.jcr.nodebuilder.task.NodeBuilderTask;
40  import info.magnolia.jcr.util.NodeTypes;
41  import info.magnolia.module.DefaultModuleVersionHandler;
42  import info.magnolia.module.InstallContext;
43  import info.magnolia.module.delta.DeltaBuilder;
44  import info.magnolia.module.delta.NodeExistsDelegateTask;
45  import info.magnolia.module.delta.PartialBootstrapTask;
46  import info.magnolia.module.delta.SetPropertyTask;
47  import info.magnolia.module.delta.Task;
48  import info.magnolia.repository.RepositoryConstants;
49  
50  import javax.inject.Inject;
51  import javax.jcr.ImportUUIDBehavior;
52  
53  import java.util.ArrayList;
54  import java.util.List;
55  
56  import static info.magnolia.jcr.nodebuilder.Ops.addNode;
57  import static info.magnolia.jcr.nodebuilder.Ops.addProperty;
58  
59  /**
60   * Version handler for the Magnolia content importer module.
61   */
62  public class ContentImporterModuleVersionHandler extends DefaultModuleVersionHandler {
63  
64      private final Task initialBootstrapTask;
65  
66      @Inject
67      public ContentImporterModuleVersionHandler(MagnoliaConfigurationProperties properties) {
68          initialBootstrapTask = new IsOnlyInstallBootstrapAllowedTask("Initial bootstrap of content", "Import content on first installation if initial bootstrap is allowed.", properties,
69                  new NodeExistsDelegateTask("", "/modules/content-importer/config",
70                          new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/content-importer/config", ContentImporterModule.CONTENT_BOOTSTRAP_INSTALL_PROPERTY_KEY, "true"),
71                          new NodeBuilderTask("", "", ErrorHandling.strict, RepositoryConstants.CONFIG, "/modules/content-importer",
72                                  addNode("config", NodeTypes.Content.NAME).then(
73                                          addProperty(ContentImporterModule.CONTENT_BOOTSTRAP_INSTALL_PROPERTY_KEY, "true")
74                                  ))));
75  
76          register(DeltaBuilder.update("1.0.2", "")
77                  .addTask(new PartialBootstrapTask("Replace content task configuration", "Replaces incorrect content task configuration", "/mgnl-bootstrap/content-importer/config.modules.content-importer.tasks.xml", "/tasks/content", ImportUUIDBehavior.IMPORT_UUID_COLLISION_REMOVE_EXISTING)));
78      }
79  
80      @Override
81      protected List<Task> getExtraInstallTasks(InstallContext installContext) {
82          final List<Task> extraInstallTasks = new ArrayList<>(super.getExtraInstallTasks(installContext));
83          // as extra install tasks are only run at updates, removing the task here ensures it happens only on fresh install.
84          getBasicInstallTasks(installContext).remove(initialBootstrapTask);
85          return extraInstallTasks;
86      }
87  
88      @Override
89      protected List<Task> getBasicInstallTasks(InstallContext installContext) {
90          final List<Task> basicInstallTasks = new ArrayList<>(super.getBasicInstallTasks(installContext));
91          basicInstallTasks.add(initialBootstrapTask);
92          return basicInstallTasks;
93      }
94  }