View Javadoc
1   /**
2    * This file Copyright (c) 2009-2015 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.resources.setup;
35  
36  import info.magnolia.jcr.util.NodeTypes;
37  import info.magnolia.jcr.util.NodeUtil;
38  import info.magnolia.module.InstallContext;
39  import info.magnolia.module.delta.AbstractTask;
40  import info.magnolia.module.delta.TaskExecutionException;
41  import info.magnolia.module.resources.ResourcesModule;
42  
43  import javax.jcr.Node;
44  import javax.jcr.Session;
45  
46  import org.apache.commons.lang3.StringUtils;
47  
48  /**
49   * Task to install a referenced resource.
50   */
51  public class InstallReferenceResourceTask extends AbstractTask {
52      private final String resource;
53      private final String reference;
54      private final String template;
55      private final boolean stripExtension;
56  
57      public InstallReferenceResourceTask(String resource, String reference, String template) {
58          this(resource, reference, template, true);
59      }
60  
61      /**
62       * @param stripExtension by default this task used to assume referenced resources always had their extensions stripped;
63       * nowadays we discourage stripping resource extensions, so this may not be the case anymore.
64       * @see info.magnolia.module.resources.setup.ResourceCleanUpTask
65       */
66      public InstallReferenceResourceTask(String resource, String reference, String template, boolean stripExtension) {
67          super("Install referenced resource", "Creates the " + resource + " with a reference to "+reference);
68          this.resource = resource;
69          this.reference = reference;
70          this.template = template;
71          this.stripExtension = stripExtension;
72      }
73  
74      @Override
75      public void execute(InstallContext installContext) throws TaskExecutionException {
76          try {
77              String name = StringUtils.substringAfterLast(resource, "/");
78              String path = StringUtils.substringBeforeLast(resource, "/");
79  
80              Session session = installContext.getJCRSession(ResourcesModule.DEFAULT_WORKSPACE);
81              Node parent = NodeUtil.createPath(session.getRootNode(), path, NodeTypes.Folder.NAME);
82  
83              Node resource;
84              if(parent.hasNode(name)){
85                  resource = parent.getNode(name);
86                  resource.setPrimaryType(NodeTypes.Content.NAME);
87              } else {
88                  resource = parent.addNode(name, NodeTypes.Content.NAME);
89              }
90              NodeTypes.Renderable.set(resource, template);
91              resource.setProperty("reference", stripExtension ? StringUtils.substringBeforeLast(reference, ".") : reference);
92  
93          } catch (Exception e) {
94              throw new TaskExecutionException("Can't install resource [" + resource + "]", e);
95          }
96  
97      }
98  
99  }