1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34 package info.magnolia.module.cache.filter;
35
36 import info.magnolia.cms.util.RequestHeaderUtil;
37 import info.magnolia.module.cache.util.GZipUtil;
38
39 import java.io.IOException;
40 import java.io.ObjectInputStream;
41 import java.io.ObjectOutputStream;
42 import java.io.Serializable;
43 import java.util.ArrayList;
44 import java.util.Collection;
45 import java.util.HashMap;
46 import java.util.Iterator;
47 import java.util.Map;
48 import java.util.Map.Entry;
49
50 import javax.servlet.FilterChain;
51 import javax.servlet.ServletException;
52 import javax.servlet.http.HttpServletRequest;
53 import javax.servlet.http.HttpServletResponse;
54
55 import org.apache.commons.collections.MultiMap;
56 import org.apache.commons.collections.map.MultiValueMap;
57 import org.apache.commons.lang.builder.ToStringBuilder;
58 import org.apache.commons.lang.builder.ToStringStyle;
59
60
61
62
63
64
65
66
67
68 public abstract class ContentCachedEntry implements CachedEntry, Serializable {
69
70 private static final ToStringStyle BYTE_ARRAY_SIZE_STYLE = new ToStringStyle() {
71 @Override
72 protected void appendDetail(StringBuffer buffer, String fieldName,
73 byte[] array) {
74 super.appendDetail(buffer, fieldName, array.length + " bytes");
75 }
76 };
77
78 private final String contentType;
79 private final String characterEncoding;
80 private final int statusCode;
81 private transient MultiMap headers;
82 private Map serializableHeadersBackingList;
83 private final long lastModificationTime;
84 private String originalUrl;
85
86
87
88
89
90
91
92
93
94
95
96 public ContentCachedEntry(String contentType, String characterEncoding, int statusCode, MultiMap headers, long modificationDate, String originalUrl) throws IOException {
97 this.contentType = contentType;
98 this.characterEncoding = characterEncoding;
99 this.statusCode = statusCode;
100 this.headers = headers;
101 this.lastModificationTime = modificationDate;
102 this.originalUrl = originalUrl;
103 }
104
105 @Override
106 public String getOriginalURL() {
107 return this.originalUrl;
108 }
109
110
111
112
113
114
115
116
117 public String getContentType() {
118 return contentType;
119 }
120
121 public String getCharacterEncoding() {
122 return characterEncoding;
123 }
124
125 public int getStatusCode() {
126 return statusCode;
127 }
128
129 public MultiMap getHeaders() {
130 return headers;
131 }
132
133 @Override
134 public long getLastModificationTime() {
135 return lastModificationTime;
136 }
137
138 @Override
139 public String toString() {
140 return ToStringBuilder.reflectionToString(this, BYTE_ARRAY_SIZE_STYLE);
141 }
142
143
144 private void writeObject(ObjectOutputStream out) throws IOException {
145 serializableHeadersBackingList = new HashMap();
146 Iterator iter = headers.entrySet().iterator();
147 while (iter.hasNext()) {
148 Map.Entry entry = (Entry) iter.next();
149 serializableHeadersBackingList.put(entry.getKey(), new ArrayList((Collection)entry.getValue()));
150 }
151 out.defaultWriteObject();
152 }
153
154 private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
155 in.defaultReadObject();
156 headers = new MultiValueMap();
157 Iterator iter = serializableHeadersBackingList.entrySet().iterator();
158 while (iter.hasNext()) {
159 Map.Entry entry = (Entry) iter.next();
160 Collection c = (Collection) entry.getValue();
161 for (Iterator ic = c.iterator(); ic.hasNext();) {
162 headers.put(entry.getKey(), ic.next());
163 }
164 }
165 serializableHeadersBackingList = null;
166 }
167
168 @Override
169 public void replay(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException {
170 response.setStatus(getStatusCode());
171
172 boolean acceptsGzipEncoding = isAcceptsGzip(request) && canServeGzipContent();
173 addHeaders(acceptsGzipEncoding, response);
174
175
176 response.setContentType(getContentType());
177 response.setCharacterEncoding(getCharacterEncoding());
178
179 writeContent(request, response, chain, acceptsGzipEncoding);
180 }
181
182 protected abstract void writeContent(HttpServletRequest request, HttpServletResponse response, FilterChain chain, boolean acceptsGzipEncoding) throws IOException, ServletException;
183
184
185
186
187 protected void addHeaders(final boolean acceptsGzipEncoding, final HttpServletResponse response) {
188 final MultiMap headers = getHeaders();
189
190 final Iterator it = headers.keySet().iterator();
191 while (it.hasNext()) {
192 final String header = (String) it.next();
193 if (!acceptsGzipEncoding) {
194
195 if ("Content-Encoding".equals(header) || "Vary".equals(header)) {
196 continue;
197 }
198 }
199 if (response.containsHeader(header)) {
200
201 continue;
202 }
203
204 final Collection values = (Collection) headers.get(header);
205 final Iterator valIt = values.iterator();
206 while (valIt.hasNext()) {
207 final Object val = valIt.next();
208 RequestHeaderUtil.setHeader(response, header, val);
209 }
210 }
211
212 if(acceptsGzipEncoding){
213
214 if (!response.containsHeader("Content-Encoding")) {
215 RequestHeaderUtil.addAndVerifyHeader(response, "Content-Encoding", "gzip");
216 RequestHeaderUtil.addAndVerifyHeader(response, "Vary", "Accept-Encoding");
217 }
218 }
219 }
220
221 protected boolean isAcceptsGzip(HttpServletRequest request){
222 return GZipUtil.isAcceptsGzip(request);
223 }
224
225 abstract protected boolean canServeGzipContent();
226
227 }