View Javadoc

1   /**
2    * This file Copyright (c) 2010-2011 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.groovy.support.classes;
35  
36  import groovy.lang.GroovyResourceLoader;
37  import info.magnolia.cms.core.Content;
38  import info.magnolia.cms.core.HierarchyManager;
39  import info.magnolia.cms.core.MetaData;
40  import info.magnolia.cms.core.NodeData;
41  import info.magnolia.module.groovy.support.HierarchyManagerProvider;
42  
43  import javax.jcr.RepositoryException;
44  import java.io.ByteArrayInputStream;
45  import java.io.IOException;
46  import java.io.InputStream;
47  import java.net.MalformedURLException;
48  import java.net.URL;
49  import java.net.URLConnection;
50  import java.net.URLStreamHandler;
51  import java.util.Calendar;
52  
53  /**
54   * A {@link GroovyResourceLoader} implementation which is able to load Groovy source from a given repository.
55   *
56   * <strong>Warning:</strong> this is based on URLs objects. It uses a custom "protocol", but this is only
57   * supported in as far as the URL object instance is passed around. Using the URL's string representation
58   * outside the context of this class will invariably fail, unless {@link info.magnolia.module.groovy.support.classes.MgnlGroovyResourceLoader.MagnoliaStreamHandler}
59   * is passed too.
60   *
61   * @author gjoseph
62   * @version $Revision: $ ($Author: $)
63   */
64  class MgnlGroovyResourceLoader implements GroovyResourceLoader {
65      private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(MgnlGroovyResourceLoader.class);
66  
67      private static final String PROTOCOL = "magnolia-repository://";
68      private final GroovyResourceLoader delegate;
69      private final HierarchyManagerProvider hmp;
70      private final String repoName;
71  
72      MgnlGroovyResourceLoader(GroovyResourceLoader delegate, HierarchyManagerProvider hmp, String repoName) {
73          this.delegate = delegate;
74          this.hmp = hmp;
75          this.repoName = repoName;
76      }
77  
78      @Override
79      public URL loadGroovySource(String name) throws MalformedURLException {
80          final URL url = loadGroovySourceFromRepository(name);
81          if (url == null) {
82              return delegate.loadGroovySource(name);
83          }
84          return url;
85      }
86  
87      /**
88       * Returns a URL <em>only if</em> the path to the source exits <strong>AND</strong> the enabled flag is <code>true</code>.
89       * In all other cases it <strong>must</strong> return <code>null</code>
90       */
91      private URL loadGroovySourceFromRepository(String name) throws MalformedURLException {
92          if (name.startsWith("[") || name.contains("$")) {
93              // we don't even try loading array classes or nested classes.
94              // see java.lang.Class#forName()
95              log.debug("Skipping {}, array or nested class.", name);
96              return null;
97          }
98  
99          final HierarchyManager hm;
100         try {
101             hm = hmp.getHierarchyManager(repoName);
102         } catch (Exception e) {
103             return null;
104         }
105         final String path = "/" + name.replace('.', '/');
106         try {
107             if (hm.isExist(path) && hm.getNodeData(path + "/enabled").getBoolean()) {
108                 return new URL(null, PROTOCOL + hm.getName() + path, new MagnoliaStreamHandler(hm));
109             } else {
110                 return null;
111             }
112         } catch (RepositoryException e) {
113             return null;
114         }
115     }
116 
117     /**
118      * Magnolia Stream Handler.
119      *
120      */
121     protected static class MagnoliaStreamHandler extends URLStreamHandler {
122         private final HierarchyManager hm;
123 
124         public MagnoliaStreamHandler(HierarchyManager hm) {
125             this.hm = hm;
126         }
127 
128         @Override
129         protected URLConnection openConnection(URL u) throws IOException {
130             if (!"magnolia-repository".equals(u.getProtocol())) {
131                 throw new IllegalStateException("Unsupported protocol: " + u.getProtocol() + " (only supports \"magnolia-repository\")");
132             }
133             return new MagnoliaURLConnection(u, hm);
134         }
135     }
136 
137     /**
138      * Magnolia URL Connection.
139      *
140      */
141     protected static class MagnoliaURLConnection extends URLConnection {
142         private final Content node;
143 
144         public MagnoliaURLConnection(URL u, HierarchyManager hm) throws IOException {
145             super(u);
146             // final String repository = u.getHost();
147             final String path = u.getPath();
148 
149             try {
150                 this.node = hm.getContent(path);
151             } catch (RepositoryException e) {
152                 throw new IOException("Can't get " + path + " from the " + hm.getName() + " repository: " + e.getClass().getSimpleName() + ": " + e.getMessage());
153             }
154         }
155 
156         @Override
157         public void connect() throws IOException {
158             // Nothing to do here.
159             // I'm assuming this could be needed for connections that can timeout, and/or when the URL object is
160             // used long after it's been instantiated. In our specific case, we know for a fact that it's used
161             // immediately, and not kept around, which is why we fetch the node from the repository straight from
162             // the constructor of this class.
163         }
164 
165         @Override
166         public InputStream getInputStream() throws IOException {
167             final NodeData prop = node.getNodeData("text");
168             if (!prop.isExist()) {
169                 throw new IOException(node.getHandle() + " has no 'text' property");
170             }
171 
172             // TODO - double check "enabled" flag ?
173             // TODO - doesn't work with MockNodeData: return prop.getStream();
174             final String sourceStr = prop.getString();
175             return new ByteArrayInputStream(sourceStr.getBytes());
176         }
177 
178         @Override
179         public long getLastModified() {
180             final MetaData md = node.getMetaData();
181             final Calendar date = md.getModificationDate();
182             return date.getTimeInMillis();
183         }
184     }
185 }