View Javadoc
1   /**
2    * This file Copyright (c) 2016 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;
35  
36  import info.magnolia.voting.voters.AbstractBoolVoter;
37  
38  import javax.inject.Inject;
39  import javax.servlet.http.HttpServletRequest;
40  
41  import org.apache.commons.lang3.StringUtils;
42  
43  /**
44   * Delegates to {@link info.magnolia.voting.voters.VoterSet} configured in {@link ResourcesModule} upon each
45   * {@link HttpServletRequest}. Allows the request to reach {@link ResourcesServlet} or bypasses it when filter does
46   * <strong>NOT</strong> match (see
47   * <code>config:/server/filters/servlets/ResourcesServlet/bypasses/bypassWhenNotInResourceFilter@not=true</code>).
48   * When no filter is set at all, this voter considers everything white listed.
49   */
50  public class DelegateResourceVoter extends AbstractBoolVoter<HttpServletRequest> {
51  
52      private final ResourcesModule resourcesModule;
53  
54      @Inject
55      public DelegateResourceVoter(final ResourcesModule resourcesModule) {
56          this.resourcesModule = resourcesModule;
57      }
58  
59      @Override
60      protected boolean boolVote(HttpServletRequest httpServletRequest) {
61          // If the resource filter is not set, everything is considered white listed
62          if (resourcesModule.getResourceFilter() == null) {
63              return true;
64          }
65  
66          final String resourcePath = httpServletRequest.getRequestURI();
67          if (StringUtils.isNotBlank(resourcePath)) {
68              return resourcesModule.getResourceFilter().vote(resourcePath) > 0;
69          }
70  
71          return false;
72      }
73  
74  }