View Javadoc
1   /*
2    * Copyright (c) 2002-2017, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.document.web;
35  
36  import java.io.IOException;
37  import java.util.Map.Entry;
38  
39  import javax.servlet.Filter;
40  import javax.servlet.FilterChain;
41  import javax.servlet.FilterConfig;
42  import javax.servlet.ServletException;
43  import javax.servlet.ServletRequest;
44  import javax.servlet.ServletResponse;
45  import javax.servlet.http.HttpServletRequest;
46  import javax.servlet.http.HttpServletResponse;
47  
48  import fr.paris.lutece.portal.service.util.AppPropertiesService;
49  import fr.paris.lutece.util.url.UrlItem;
50  
51  /**
52   * DocumentLegacyServletRedirectFilter, a filter to redirect previous style of URLs
53   * for document resources (changed in lutece V6) to the new urls.
54   *
55   * By default it will redirect like this:
56   *     document?id=XXX -> servlet/plugins/document/resource?id=xxx
57   *
58   */
59  public class DocumentLegacyServletRedirectFilter implements Filter
60  {
61  
62      private static final String PROPERTY_RESOURCE_PROVIDER_URL = "document.resource.provider.url";
63      private static final String DEFAULT_RESOURCE_SERVLET =  "servlet/plugins/document/resource";
64  
65      /**
66       * {@inheritDoc}
67       */
68      public void doFilter( ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain ) throws IOException, ServletException
69      {
70          HttpServletRequest httpServletRequest = ( HttpServletRequest ) servletRequest;
71          HttpServletResponse httpServletResponse = ( HttpServletResponse ) servletResponse;
72          String strNewServletResource = AppPropertiesService.getProperty( PROPERTY_RESOURCE_PROVIDER_URL );
73          if ( strNewServletResource != null ) {
74              int nIdx = strNewServletResource.indexOf( '?' );
75              if ( nIdx != -1 ) {
76                  strNewServletResource = strNewServletResource.substring( 0, nIdx );
77              }
78          } else {
79              strNewServletResource = DEFAULT_RESOURCE_SERVLET;
80          }
81  
82          UrlItem urlItem = new UrlItem( strNewServletResource );
83          for ( Entry<String, String[]> entryParameter: httpServletRequest.getParameterMap( ).entrySet( ) ) {
84              for ( String value: entryParameter.getValue( ) ) {
85                  urlItem.addParameter( entryParameter.getKey( ), value );
86              }
87          }
88  
89          httpServletResponse.setStatus( HttpServletResponse.SC_MOVED_PERMANENTLY );
90          httpServletResponse.setHeader( "Location", urlItem.getUrl( ) );
91      }
92  
93      @Override
94      public void destroy( ) {
95          //Do Nothing
96      }
97  
98      @Override
99      public void init( FilterConfig filterConfig ) throws ServletException {
100         //Do Nothing
101     }
102 }