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.imaging.parameters;
35  
36  import info.magnolia.cms.core.HierarchyManager;
37  import info.magnolia.context.MgnlContext;
38  import info.magnolia.imaging.ParameterProvider;
39  import info.magnolia.imaging.ParameterProviderFactory;
40  import info.magnolia.imaging.util.PathSplitter;
41  
42  import javax.jcr.RepositoryException;
43  import javax.servlet.http.HttpServletRequest;
44  
45  /**
46   * Superclass for ParameterProviderFactories that are based on Workspace and Path.
47   *
48   * @param <PT> type of ParameterProvider's parameter
49   *
50   * @version $Id$
51   */
52  public abstract class AbstractWorkspaceAndPathParameterProviderFactory<PT> implements ParameterProviderFactory<HttpServletRequest, PT> {
53  
54      private boolean trimExtension = true;
55  
56      @Override
57      public ParameterProvider<PT> newParameterProviderFor(HttpServletRequest req) {
58          String pathInfo = req.getPathInfo();
59          if (pathInfo == null) {
60              throw new IllegalArgumentException("Can't determine node, no pathInfo is available for uri " + req.getRequestURI());
61          }
62  
63          // TODO - here we assume that the first path element is the ImageGenerator name, which is in fact something that is currently the business of the ImagingServlet.
64          // Can we do better ?
65          final PathSplitter pathSplitter = new PathSplitter(pathInfo, trimExtension);
66          if (pathSplitter.count() < 2) {
67              throw new IllegalArgumentException("Can't determine node from pathInfo: " + pathInfo);
68  
69          }
70          final String workspaceName = pathSplitter.skipTo(1);
71          final String path = "/" + pathSplitter.remaining();
72  
73          try {
74              final HierarchyManager hm = MgnlContext.getHierarchyManager(workspaceName);
75              return newParameterProviderForPath(hm, path);
76          } catch (RepositoryException e) {
77              throw new RuntimeException("Can't load source from " + path + " from workspace " + workspaceName, e); // TODO
78          }
79      }
80  
81      protected abstract ParameterProvider<PT> newParameterProviderForPath(final HierarchyManager hm, final String path) throws RepositoryException;
82  
83      public void setTrimExtension(boolean trimExtension) {
84          this.trimExtension = trimExtension;
85      }
86  
87  }