Clover icon

Magnolia Module Cache 5.5.9

  1. Project Clover database Mon Nov 25 2019 16:46:50 CET
  2. Package info.magnolia.module.cache.executor

File SetExpirationHeaders.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart7.png
45% of files have more coverage

Code metrics

10
16
1
1
85
39
8
0.5
16
1
8

Classes

Class Line # Actions
SetExpirationHeaders 53 16 0% 8 9
0.666666766.7%
 

Contributing tests

This file is covered by 2 tests. .

Source view

1    /**
2    * This file Copyright (c) 2008-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.cache.executor;
35   
36    import info.magnolia.cms.cache.CacheConstants;
37    import info.magnolia.module.cache.BrowserCachePolicy;
38    import info.magnolia.module.cache.BrowserCachePolicyResult;
39    import info.magnolia.module.cache.Cache;
40    import info.magnolia.module.cache.CachePolicyResult;
41    import info.magnolia.module.cache.filter.CachedEntry;
42   
43    import java.io.IOException;
44   
45    import javax.servlet.FilterChain;
46    import javax.servlet.ServletException;
47    import javax.servlet.http.HttpServletRequest;
48    import javax.servlet.http.HttpServletResponse;
49   
50    /**
51    * Executor for setting expiration headers to response.
52    */
 
53    public class SetExpirationHeaders extends AbstractExecutor {
54   
 
55  2 toggle @Override
56    public void processCacheRequest(HttpServletRequest request,
57    HttpServletResponse response, FilterChain chain, Cache cache,
58    CachePolicyResult cachePolicyResult) throws IOException, ServletException {
59   
60  2 BrowserCachePolicy browserCachePolicy = this.getContentCachingConfiguration().getBrowserCachePolicy();
61  2 BrowserCachePolicyResult clientCacheResult = browserCachePolicy.canCacheOnClient(cachePolicyResult);
62   
63  2 if (clientCacheResult != null) {
64  2 if (clientCacheResult.getExpirationDate() == BrowserCachePolicyResult.NO_CACHE.getExpirationDate()) {
65  1 response.setHeader(CacheConstants.HEADER_PRAGMA, CacheConstants.HEADER_VALUE_NO_CACHE);
66  1 response.setHeader(CacheConstants.HEADER_CACHE_CONTROL, CacheConstants.HEADER_CACHE_CONTROL_VALUE_DISABLE_CACHE);
67  1 response.setDateHeader(CacheConstants.HEADER_EXPIRES, 0L);
68    } else {
69  1 long maxAgeSeconds = (clientCacheResult.getExpirationDate() - System.currentTimeMillis()) / 1000L;
70   
71    // browser cache policy cannot set expires longer than what we cached the response for
72  1 Object cachedEntry = cachePolicyResult != null ? cachePolicyResult.getCachedEntry() : null;
73  1 if (cachedEntry != null && (cachedEntry instanceof CachedEntry)) {
74  0 CachedEntry e = (CachedEntry) cachedEntry;
75  0 int maxAgeFromCachedContent = e.getTimeToLiveInSeconds();
76  0 if (maxAgeFromCachedContent != -1 && maxAgeFromCachedContent < maxAgeSeconds)
77  0 maxAgeSeconds = maxAgeFromCachedContent;
78    }
79   
80  1 response.setHeader(CacheConstants.HEADER_CACHE_CONTROL, CacheConstants.HEADER_VALUE_MAX_AGE + "=" + maxAgeSeconds + ", " + CacheConstants.HEADER_VALUE_PUBLIC);
81  1 response.setDateHeader(CacheConstants.HEADER_EXPIRES, System.currentTimeMillis() + maxAgeSeconds * 1000);
82    }
83    }
84    }
85    }