View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.resources.mapping;
35  
36  import info.magnolia.cms.beans.config.URI2RepositoryMapping;
37  import info.magnolia.context.MgnlContext;
38  import info.magnolia.module.resources.ResourcesModule;
39  import info.magnolia.objectfactory.Components;
40  
41  import javax.jcr.RepositoryException;
42  import javax.jcr.Session;
43  
44  import org.apache.commons.lang3.StringUtils;
45  import org.slf4j.Logger;
46  import org.slf4j.LoggerFactory;
47  
48  /**
49   * Uri to repository mapping for resources. Extension in node name is taken into account and has
50   * precedence before extension defined in the property called extension.
51   *
52   * @deprecated since 2.4 Resources are now served through the {@link info.magnolia.resourceloader.ResourceOrigin} API and {@link info.magnolia.module.resources.ResourcesServlet}; URI2RepositoryMapping isn't involved anymore.
53   */
54  @Deprecated
55  public class URI2ResourcesRepositoryMapping extends URI2RepositoryMapping {
56  
57      private static Logger log = LoggerFactory.getLogger(URI2ResourcesRepositoryMapping.class);
58  
59      private final ResourcesModule resourcesModule;
60  
61      public URI2ResourcesRepositoryMapping() {
62          this(Components.getComponent(ResourcesModule.class));
63      }
64  
65      public URI2ResourcesRepositoryMapping(ResourcesModule resourcesModule) {
66          this.resourcesModule = resourcesModule;
67      }
68  
69      public URI2ResourcesRepositoryMapping(String uriPrefix, String repository, String handlePrefix) {
70          this(uriPrefix, repository, handlePrefix, Components.getComponent(ResourcesModule.class));
71      }
72  
73      public URI2ResourcesRepositoryMapping(String uriPrefix, String repository, String handlePrefix, ResourcesModule resourcesModule) {
74          super(uriPrefix, repository, handlePrefix);
75  
76          this.resourcesModule = resourcesModule;
77      }
78  
79      /**
80       * When no resource filter is defined in {@link ResourcesModule} or when given URI is white listed in filter it will
81       * delegate to {@link URI2RepositoryMapping#matches(String)}. Otherwise it considers given URI as no match (given
82       * URI is <em>not</em> white listed by resource filter).
83       */
84      @Override
85      public boolean matches(String uri) {
86          if (resourcesModule.getResourceFilter() == null || resourcesModule.getResourceFilter().vote(uri) > 0) {
87              return super.matches(uri);
88          }
89  
90          // If the URI is not white listed by the resourceFilter we consider it no match
91          return false;
92      }
93  
94      @Override
95      public String getHandle(String uri) {
96          String handle;
97          handle = StringUtils.removeStart(uri, getURIPrefix());
98          if (StringUtils.isNotEmpty(getHandlePrefix())) {
99              handle = StringUtils.removeStart(handle, "/");
100             handle = getHandlePrefix() + "/" + handle;
101         }
102 
103         handle = cleanHandle(handle);
104 
105         try {
106             final Session session = MgnlContext.getJCRSession(getRepository());
107             if (!session.itemExists(handle)) {
108                 String fileName = StringUtils.substringAfterLast(handle, "/");
109                 String extension = StringUtils.substringAfterLast(fileName, ".");
110                 handle = StringUtils.removeEnd(handle, "." + extension);
111                 if (!session.itemExists(handle)) {
112                     String maybeHandle = (getHandlePrefix().endsWith("/") ? "/" : "") + StringUtils.removeStart(handle, getHandlePrefix());
113                     // prefix might have been prepended incorrectly. Second part of the condition is there to match links to binary nodes
114                     if (session.itemExists(maybeHandle) || (maybeHandle.lastIndexOf("/") > 0 && session.itemExists(StringUtils.substringBeforeLast(maybeHandle, "/")))) {
115                         return maybeHandle;
116                     }
117                 }
118             }
119         } catch (RepositoryException e) {
120             //Log the exception and return handle
121             log.debug(e.getMessage(), e);
122         }
123         return handle;
124     }
125 }