View Javadoc

1   /**
2    * This file Copyright (c) 2008-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.cache.executor;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.context.MgnlContext;
38  import info.magnolia.jcr.util.NodeUtil;
39  import info.magnolia.module.cache.Cache;
40  import info.magnolia.module.cache.CacheModule;
41  import info.magnolia.module.cache.CachePolicy;
42  import info.magnolia.module.cache.CachePolicyResult;
43  import info.magnolia.module.cache.filter.CacheResponseWrapper;
44  import info.magnolia.module.cache.filter.CachedEntry;
45  import info.magnolia.module.cache.filter.CachedError;
46  import info.magnolia.module.cache.filter.CachedRedirect;
47  import info.magnolia.module.cache.filter.ContentCachedEntry;
48  import info.magnolia.module.cache.filter.DelegatingBlobCachedEntry;
49  import info.magnolia.module.cache.filter.InMemoryCachedEntry;
50  
51  import java.io.IOException;
52  
53  import javax.jcr.Node;
54  import javax.jcr.RepositoryException;
55  import javax.servlet.FilterChain;
56  import javax.servlet.ServletException;
57  import javax.servlet.http.HttpServletRequest;
58  import javax.servlet.http.HttpServletResponse;
59  
60  /**
61   * Wraps the response and stores the content in a cache Entry.
62   *
63   * @author pbracher
64   * @version $Revision: $ ($Author: $)
65   */
66  public class Store extends AbstractExecutor {
67  
68      private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(Store.class);
69  
70      @Override
71      public void processCacheRequest(HttpServletRequest request, HttpServletResponse response, FilterChain chain, Cache cache, CachePolicyResult cachePolicyResult) throws IOException, ServletException {
72          CachedEntry cachedEntry = null;
73          final Object key = cachePolicyResult.getCacheKey();
74  
75          final CacheResponseWrapper responseWrapper = new CacheResponseWrapper(response, CacheResponseWrapper.DEFAULT_THRESHOLD, false);
76          responseWrapper.setResponseExpirationDetectionEnabled();
77  
78          // setting Last-Modified to when this resource was stored in the cache. This value might get overridden by further filters or servlets.
79          final long cacheStorageDate = System.currentTimeMillis();
80          responseWrapper.setDateHeader("Last-Modified", cacheStorageDate);
81          chain.doFilter(request, responseWrapper);
82  
83          if (responseWrapper.getStatus() == HttpServletResponse.SC_NOT_MODIFIED) {
84              response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
85          }
86          else {
87              responseWrapper.flushBuffer();
88              cachedEntry = makeCachedEntry(request, responseWrapper);
89          }
90  
91          if (cachedEntry == null) {
92              // put null to unblock the cache
93              cache.put(key, null);
94              return;
95          }
96  
97          cachePolicyResult.setCachedEntry(cachedEntry);
98  
99          int timeToLiveInSeconds = cachedEntry.getTimeToLiveInSeconds();
100         if (timeToLiveInSeconds == 0) {
101             // put null to unblock the cache
102             cache.put(key, null);
103 
104             // stream the response directly
105             cachedEntry.replay(request, response, chain);
106             response.flushBuffer();
107 
108             return;
109         }
110 
111         if (timeToLiveInSeconds == -1) {
112             cache.put(key, cachedEntry);
113         } else {
114             cache.put(key, cachedEntry, timeToLiveInSeconds);
115         }
116 
117         // let policy know the uuid in case it wants to do something with it
118         final Content currentContent = MgnlContext.getAggregationState().getCurrentContent();
119         final Node content = currentContent != null ? currentContent.getJCRNode() : null;
120         try {
121             if (content != null && NodeUtil.isNodeType(content, "mix:referenceable")) {
122                 final String uuid = content.getIdentifier();
123                 String repo = content.getSession().getWorkspace().getName();
124                 getCachePolicy(cache).persistCacheKey(repo, uuid, key);
125             }
126         } catch (RepositoryException e) {
127             // TODO dlipp: apply consistent ExceptionHandling
128             throw new RuntimeException(e);
129         }
130     }
131 
132     protected CachedEntry makeCachedEntry(HttpServletRequest request, CacheResponseWrapper cachedResponse) throws IOException {
133         // query params are handled by the cache key
134         final String originalUrl = request.getRequestURL().toString();
135         int status = cachedResponse.getStatus();
136         int timeToLiveInSeconds = cachedResponse.getTimeToLiveInSeconds();
137 
138         // TODO : handle more of the 30x codes - although CacheResponseWrapper currently only sets the 302 or 304.
139         if (cachedResponse.getRedirectionLocation() != null) {
140             return new CachedRedirect(cachedResponse.getStatus(), cachedResponse.getRedirectionLocation(), originalUrl, timeToLiveInSeconds);
141         }
142 
143         if (cachedResponse.isError()) {
144             return new CachedError(cachedResponse.getStatus(), originalUrl, timeToLiveInSeconds);
145         }
146 
147         final long modificationDate = cachedResponse.getLastModified();
148         final String contentType = cachedResponse.getContentType();
149 
150         ContentCachedEntry cacheEntry;
151         if(!cachedResponse.isThresholdExceeded()){
152             cacheEntry = new InMemoryCachedEntry(cachedResponse.getBufferedContent(),
153                     contentType,
154                     cachedResponse.getCharacterEncoding(),
155                     status,
156                     cachedResponse.getHeaders(),
157                     modificationDate,
158                     originalUrl,
159                     timeToLiveInSeconds);
160         }
161         else{
162             cacheEntry = new DelegatingBlobCachedEntry(cachedResponse.getContentLength(),
163                     contentType,
164                     cachedResponse.getCharacterEncoding(),
165                     status,
166                     cachedResponse.getHeaders(),
167                     modificationDate,
168                     originalUrl,
169                     timeToLiveInSeconds);
170 
171             // TODO remove this once we use a blob store
172             // the file will be deleted once served in this request
173             ((DelegatingBlobCachedEntry)cacheEntry).bindContentFileToCurrentRequest(request, cachedResponse.getContentFile());
174             cachedResponse.getThresholdingOutputStream().close();
175         }
176 
177         return cacheEntry;
178     }
179 
180     protected CachePolicy getCachePolicy(Cache cache) {
181         return getModule().getConfiguration(cache.getName()).getCachePolicy();
182     }
183 
184     /**
185      * @deprecated since 4.5, use IoC/CDI
186      */
187     @Deprecated
188     protected CacheModule getModule() {
189         return CacheModule.getInstance();
190     }
191 }