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  
77          // setting Last-Modified to when this resource was stored in the cache. This value might get overridden by further filters or servlets.
78          final long cacheStorageDate = System.currentTimeMillis();
79          responseWrapper.setDateHeader("Last-Modified", cacheStorageDate);
80          chain.doFilter(request, responseWrapper);
81  
82          if (responseWrapper.getStatus() == HttpServletResponse.SC_NOT_MODIFIED) {
83              response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
84          }
85          else {
86              responseWrapper.flushBuffer();
87              cachedEntry = makeCachedEntry(request, responseWrapper);
88          }
89  
90          if (cachedEntry == null) {
91              // put null to unblock the cache
92              cache.put(key, null);
93              return;
94          }
95  
96          cachePolicyResult.setCachedEntry(cachedEntry);
97  
98          int timeToLiveInSeconds = cachedEntry.getTimeToLiveInSeconds();
99          if (timeToLiveInSeconds == 0) {
100             // put null to unblock the cache
101             cache.put(key, null);
102 
103             // stream the response directly
104             cachedEntry.replay(request, response, chain);
105             response.flushBuffer();
106 
107             return;
108         }
109 
110         if (timeToLiveInSeconds == -1) {
111             cache.put(key, cachedEntry);
112         } else {
113             cache.put(key, cachedEntry, timeToLiveInSeconds);
114         }
115 
116         // let policy know the uuid in case it wants to do something with it
117         final Content currentContent = MgnlContext.getAggregationState().getCurrentContent();
118         final Node content = currentContent != null ? currentContent.getJCRNode() : null;
119         try {
120             if (content != null && NodeUtil.isNodeType(content, "mix:referenceable")) {
121                 final String uuid = content.getIdentifier();
122                 String repo = content.getSession().getWorkspace().getName();
123                 getCachePolicy(cache).persistCacheKey(repo, uuid, key);
124             }
125         } catch (RepositoryException e) {
126             // TODO dlipp: apply consistent ExceptionHandling
127             throw new RuntimeException(e);
128         }
129     }
130 
131     protected CachedEntry makeCachedEntry(HttpServletRequest request, CacheResponseWrapper cachedResponse) throws IOException {
132         // query params are handled by the cache key
133         final String originalUrl = request.getRequestURL().toString();
134         int status = cachedResponse.getStatus();
135         int timeToLiveInSeconds = cachedResponse.getTimeToLiveInSeconds();
136 
137         // TODO : handle more of the 30x codes - although CacheResponseWrapper currently only sets the 302 or 304.
138         if (cachedResponse.getRedirectionLocation() != null) {
139             return new CachedRedirect(cachedResponse.getStatus(), cachedResponse.getRedirectionLocation(), originalUrl, timeToLiveInSeconds);
140         }
141 
142         if (cachedResponse.isError()) {
143             return new CachedError(cachedResponse.getStatus(), originalUrl, timeToLiveInSeconds);
144         }
145 
146         final long modificationDate = cachedResponse.getLastModified();
147         final String contentType = cachedResponse.getContentType();
148 
149         ContentCachedEntry cacheEntry;
150         if(!cachedResponse.isThresholdExceeded()){
151             cacheEntry = new InMemoryCachedEntry(cachedResponse.getBufferedContent(),
152                     contentType,
153                     cachedResponse.getCharacterEncoding(),
154                     status,
155                     cachedResponse.getHeaders(),
156                     modificationDate,
157                     originalUrl,
158                     timeToLiveInSeconds);
159         }
160         else{
161             cacheEntry = new DelegatingBlobCachedEntry(cachedResponse.getContentLength(),
162                     contentType,
163                     cachedResponse.getCharacterEncoding(),
164                     status,
165                     cachedResponse.getHeaders(),
166                     modificationDate,
167                     originalUrl,
168                     timeToLiveInSeconds);
169 
170             // TODO remove this once we use a blob store
171             // the file will be deleted once served in this request
172             ((DelegatingBlobCachedEntry)cacheEntry).bindContentFileToCurrentRequest(request, cachedResponse.getContentFile());
173             cachedResponse.getThresholdingOutputStream().close();
174         }
175 
176         return cacheEntry;
177     }
178 
179     protected CachePolicy getCachePolicy(Cache cache) {
180         return getModule().getConfiguration(cache.getName()).getCachePolicy();
181     }
182 
183     /**
184      * @deprecated since 4.5, use IoC/CDI
185      */
186     @Deprecated
187     protected CacheModule getModule() {
188         return CacheModule.getInstance();
189     }
190 }