Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
GZipFilter	58	17	0%	6	4	0.8484%	Show methods
GZipFilter.GZipCacheResponseWrapper	109	6	26.7%	4	6	0.4545454745.5%	Show methods
GZipFilter.GZipCacheResponseWrapper.DeferredServletOutputStream	146	9	0%	6	5	0.705882470.6%	Show methods
GZipFilter.GzipThresholdingCacheOutputStream	179	1	0%	2	0	1.0100%	Show methods

Class GZipFilter

Class GZipFilter	Line # 58	Total Statements 17	% Filtered 0%	Complexity 6	Uncovered Elements 4	TOTAL Coverage 0.8484%
bypasses(HttpServletRequest) : boolean   bypasses(HttpServletRequest) : boolean	6060	1.01	0.00%	1.01	1.01	0.0 0.00%
doFilter(HttpServletRequest,HttpServletResponse,FilterChain) : void   doFilter(HttpServletRequest,HttpServletResponse,FilterChain) : void	6565	16.016	0.00%	5.05	2.02	0.90909094 0.9090909490.9%

 

Class GZipFilter.GZipCacheResponseWrapper

Class GZipFilter.GZipCacheResponseWrapper	Line # 109	Total Statements 6	% Filtered 26.7%	Complexity 4	Uncovered Elements 6	TOTAL Coverage 0.4545454745.5%
isGzipResponseDetected() : boolean   isGzipResponseDetected() : boolean	117117	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
GZipCacheResponseWrapper(HttpServletResponse,int,boolean)   GZipCacheResponseWrapper(HttpServletResponse,int,boolean)	121121	2.02	0.00%	1.01	0.00	1.0 1.0100%
addHeader(String,String) : void   addHeader(String,String) : void	126126	3.03	0.00%	2.02	5.05	0.0 0.00%
getWrappedOutputStream() : ServletOutputStream   getWrappedOutputStream() : ServletOutputStream	134134	1.01	0.00%	1.01	0.00	1.0 1.0100%
getOutputStream() : ServletOutputStream   getOutputStream() : ServletOutputStream	138138	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -

 

Class GZipFilter.GZipCacheResponseWrapper.DeferredServletOutputStream

Class GZipFilter.GZipCacheResponseWrapper.DeferredServletOutputStream	Line # 146	Total Statements 9	% Filtered 0%	Complexity 6	Uncovered Elements 5	TOTAL Coverage 0.705882470.6%
write(int) : void   write(int) : void	150150	1.01	0.00%	1.01	0.00	1.0 1.0100%
write(byte[]) : void   write(byte[]) : void	155155	1.01	0.00%	1.01	1.01	0.0 0.00%
write(byte[],int,int) : void   write(byte[],int,int) : void	160160	1.01	0.00%	1.01	0.00	1.0 1.0100%
getStream() : ServletOutputStream   getStream() : ServletOutputStream	165165	6.06	0.00%	3.03	3.03	0.7 0.770%

 

Class GZipFilter.GzipThresholdingCacheOutputStream

Class GZipFilter.GzipThresholdingCacheOutputStream	Line # 179	Total Statements 1	% Filtered 0%	Complexity 2	Uncovered Elements 0	TOTAL Coverage 1.0100%
GzipThresholdingCacheOutputStream(int)   GzipThresholdingCacheOutputStream(int)	181181	1.01	0.00%	1.01	0.00	1.0 1.0100%
thresholdReached() : void   thresholdReached() : void	185185	0.00	-1.0 -	1.01	0.00	-1.0 -1.0 -

 

Contributing tests

Contributing tests

Select all

	Test contribution	Test	Result	Actions
	0.66071427	info.magnolia.module.cache.filter.GZipFilterTest.testResponseIsGzippedWhenThresholdExceededinfo.magnolia.module.cache.filter.GZipFilterTest.testResponseIsGzippedWhenThresholdExceeded	1PASS
	0.64285713	info.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedProperlyWhenUsingWriterFurtherDownTheChainOfFiltersinfo.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedProperlyWhenUsingWriterFurtherDownTheChainOfFilters	1PASS
	0.5	info.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedAndGZipNotSetOnErrorinfo.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedAndGZipNotSetOnError	1PASS
	0.42857143	info.magnolia.module.cache.filter.GZipFilterTest.testCacheHeadersAreAddedToTheResponseinfo.magnolia.module.cache.filter.GZipFilterTest.testCacheHeadersAreAddedToTheResponse	1PASS

 

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.filter;
35
36		import info.magnolia.cms.filters.OncePerRequestAbstractMgnlFilter;
37		import info.magnolia.cms.util.RequestHeaderUtil;
38		import info.magnolia.module.cache.util.GZipUtil;
39
40		import java.io.IOException;
41
42		import javax.servlet.FilterChain;
43		import javax.servlet.ServletException;
44		import javax.servlet.ServletOutputStream;
45		import javax.servlet.http.HttpServletRequest;
46		import javax.servlet.http.HttpServletResponse;
47
48		/**
49		* This GZipFilter does not take care of the Accept-Encoding request header. The CacheFilter will
50		* take care of serving the unzipped content if appropriate.
51		* <strong>By default, the Magnolia main filter is not dispatched to in case of include requests - if
52		* this is the case this filter has to be bypassed for such requests !</strong>
53		*
54		* @see info.magnolia.module.cache.filter.StandaloneGZipFilter if the cache filter is not in use.
55		* @author gjoseph
56		* @version $Revision: $ ($Author: $)
57		*/
		84% Uncovered Elements: 4 (25) Complexity: 6 Complexity Density: 0.35
58		public class GZipFilter extends OncePerRequestAbstractMgnlFilter {
59
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
60	0	@Override...
61		public boolean bypasses(HttpServletRequest request) {
62	0	return !GZipUtil.isAcceptsGzip(request) || super.bypasses(request);
63		}
64
		90.9% Uncovered Elements: 2 (22) Complexity: 5 Complexity Density: 0.31
65	4	@Override...
66		public void doFilter(HttpServletRequest request, final HttpServletResponse response, FilterChain chain) throws IOException, ServletException {
67		// we need to setContentLength before writing content ...
68		// (otherwise Tomcat adds a Transfer-Encoding: chunked header, which seems to cause trouble
69		// to browsers ...)
70
71	4	final GZipCacheResponseWrapper responseWrapper = new GZipCacheResponseWrapper(response, CacheResponseWrapper.DEFAULT_THRESHOLD, true);
72
73	4	chain.doFilter(request, responseWrapper);
74
75		// flush only internal buffers, not the actual response's !
76	4	responseWrapper.flush();
77
78		// otherwise the content was already streamed
79	4	if (!responseWrapper.isGzipResponseDetected()) {
80	4	byte[] array = responseWrapper.getBufferedContent();
81
82		// GZIP only 200 SC_OK responses as in other cases response might be already committed - only dump bytes and flush ...
83	4	int statusCode = responseWrapper.getStatus();
84	4	if (statusCode == HttpServletResponse.SC_OK && !GZipUtil.isGZipped(array)) {
85	3	responseWrapper.replayHeadersAndStatus(response);
86
87	3	RequestHeaderUtil.addAndVerifyHeader(response, "Content-Encoding", "gzip");
88	3	RequestHeaderUtil.addAndVerifyHeader(response, "Vary", "Accept-Encoding"); // needed for proxies
89
90	3	array = GZipUtil.gzip(array);
91	3	response.setContentLength(array.length);
92	3	if (array.length > 0) {
93	3	response.getOutputStream().write(array);
94		}
95		}
96		else {
97	1	responseWrapper.replay(response);
98		}
99
100	4	response.flushBuffer();
101		}
102		}
103
104		/**
105		* Detects if the response has the "Content-Encoding" header set. If so it will stream it through.
106		*
107		* @version $Id$
108		*/
		45.5% Uncovered Elements: 6 (11) Complexity: 4 Complexity Density: 0.67
109		public static final class GZipCacheResponseWrapper extends CacheResponseWrapper {
110
111		private final HttpServletResponse response;
112
113		private boolean gzipResponseDetected;
114
115		private ServletOutputStream deferredOutputStream = new DeferredServletOutputStream();
116
		- Uncovered Elements: 0 (0) Complexity: 1 Complexity Density: -
117		public boolean isGzipResponseDetected() {...
118		return gzipResponseDetected;
119		}
120
		100% Uncovered Elements: 0 (2) Complexity: 1 Complexity Density: 0.5
121	4	private GZipCacheResponseWrapper(HttpServletResponse response, int threshold, boolean serveIfThresholdReached) {...
122	4	super(response, threshold, serveIfThresholdReached, new GzipThresholdingCacheOutputStream(threshold));
123	4	this.response = response;
124		}
125
		0% Uncovered Elements: 5 (5) Complexity: 2 Complexity Density: 0.67
126	0	@Override...
127		public void addHeader(String name, String value) {
128	0	if (name.equals("Content-Encoding")) {
129	0	gzipResponseDetected = true;
130		}
131	0	super.addHeader(name, value);
132		}
133
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
134	3	private ServletOutputStream getWrappedOutputStream() throws IOException {...
135	3	return super.getOutputStream();
136		}
137
		- Uncovered Elements: 0 (0) Complexity: 1 Complexity Density: -
138		@Override...
139		public ServletOutputStream getOutputStream() {
140		return deferredOutputStream;
141		}
142
143		/**
144		* Only gets the real output stream once we are writing. If we have detected a gzip response we will just stream it through.
145		*/
		70.6% Uncovered Elements: 5 (17) Complexity: 6 Complexity Density: 0.67
146		private final class DeferredServletOutputStream extends ServletOutputStream {
147
148		private ServletOutputStream stream;
149
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
150	1016217	@Override...
151		public void write(int b) throws IOException {
152	1016217	getStream().write(b);
153		}
154
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
155	0	@Override...
156		public void write(byte[] b) throws IOException {
157	0	getStream().write(b);
158		}
159
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
160	8	@Override...
161		public void write(byte[] b, int off, int len) throws IOException {
162	8	getStream().write(b, off, len);
163		}
164
		70% Uncovered Elements: 3 (10) Complexity: 3 Complexity Density: 0.5
165	1016225	private ServletOutputStream getStream() throws IOException {...
166	1016225	if (stream == null) {
167	3	if (gzipResponseDetected) {
168	0	replayHeadersAndStatus(response);
169	0	stream = response.getOutputStream();
170		} else {
171	3	stream = getWrappedOutputStream();
172		}
173		}
174	1016225	return stream;
175		}
176		}
177		}
178
		100% Uncovered Elements: 0 (3) Complexity: 2 Complexity Density: 2
179		private final static class GzipThresholdingCacheOutputStream extends AbstractThresholdingCacheOutputStream {
180
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
181	4	public GzipThresholdingCacheOutputStream(int threshold) {...
182	4	super(threshold);
183		}
184
		- Uncovered Elements: 0 (0) Complexity: 1 Complexity Density: -
185	1	@Override...
186		protected void thresholdReached() throws IOException {
187		// do nothing
188		}
189		}
190
191		}