View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 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.module.delta;
35  
36  import info.magnolia.importexport.DataTransporter;
37  
38  import org.apache.commons.lang3.StringUtils;
39  
40  /**
41   * A Task which bootstraps if the node targeted by the bootstrap file does not exist.
42   * (see constructors for details)
43   */
44  public class BootstrapConditionally extends NodeExistsDelegateTask {
45  
46      /**
47       * Bootstraps the given resource if the corresponding node does not exist yet, does nothing otherwise.
48       * Task description gets auto-generated.
49       */
50      public BootstrapConditionally(String taskName, String resourceToBootstrap) {
51          super(taskName,
52                  String.format("Bootstraps file '%s' into '%s:%s' if the path doesn't exist yet.", resourceToBootstrap, determineRepository(resourceToBootstrap), determinePath(resourceToBootstrap)),
53                  determineRepository(resourceToBootstrap),
54                  determinePath(resourceToBootstrap),
55                  null,
56                  new BootstrapSingleResource(taskName, String.format("Bootstraps file '%s' into '%s:%s'.", resourceToBootstrap, determineRepository(resourceToBootstrap), determinePath(resourceToBootstrap)), resourceToBootstrap));
57      }
58  
59      /**
60       * Bootstraps the given resource if the corresponding node does not exist yet, does nothing otherwise.
61       */
62      public BootstrapConditionally(String taskName, String taskDescription, String resourceToBootstrap) {
63          super(taskName, taskDescription, determineRepository(resourceToBootstrap), determinePath(resourceToBootstrap), null, new BootstrapSingleResource(taskName, taskDescription, resourceToBootstrap));
64      }
65  
66      /**
67       * Bootstraps the given resource if the corresponding node does not exist yet, executes the given task otherwise.
68       */
69      public BootstrapConditionally(String taskName, String taskDescription, String resourceToBootstrap, Task ifNodeExists) {
70          super(taskName, taskDescription, determineRepository(resourceToBootstrap), determinePath(resourceToBootstrap), ifNodeExists, new BootstrapSingleResource(taskName, taskDescription, resourceToBootstrap));
71      }
72  
73      /**
74       * Executes the given task if the specified node exists in the specific repository, bootstraps the given resource otherwise.
75       */
76      public BootstrapConditionally(String taskName, String taskDescription, String repositoryName, String pathToCheck, String resourceToBootstrap, Task ifNodeExists) {
77          super(taskName, taskDescription, repositoryName, pathToCheck, ifNodeExists, new BootstrapSingleResource(taskName, taskDescription, resourceToBootstrap));
78      }
79  
80      // TODO --- these are copied from BootstrapUtil which has been removed with r12086
81      private static String determineRepository(String filename) {
82          return StringUtils.substringBefore(cleanupFilename(filename), ".");
83      }
84  
85      private static String determinePath(String filename) {
86          String withoutExtensionAndRepository = StringUtils.substringAfter(cleanupFilename(filename), ".");
87          String path = StringUtils.replace(withoutExtensionAndRepository, ".", "/");
88          return (StringUtils.isEmpty(path) ? "/" : "/" + path);
89      }
90  
91      private static String cleanupFilename(String filename) {
92          filename = StringUtils.replace(filename, "\\", "/");
93          filename = StringUtils.substringAfterLast(filename, "/");
94          filename = StringUtils.substringBeforeLast(filename, ".");
95  
96          return StringUtils.removeEnd(filename, DataTransporter.XML);
97      }
98  }