1 package de.halbekunst.juplo.cachecontrol;
3 import java.io.IOException;
4 import java.io.OutputStream;
5 import java.io.OutputStreamWriter;
6 import java.io.PrintWriter;
7 import java.text.ParseException;
8 import java.text.SimpleDateFormat;
9 import java.util.Collections;
10 import java.util.Enumeration;
11 import java.util.HashMap;
12 import java.util.Locale;
14 import java.util.zip.GZIPOutputStream;
15 import javax.servlet.Filter;
16 import javax.servlet.FilterChain;
17 import javax.servlet.FilterConfig;
18 import javax.servlet.ServletException;
19 import javax.servlet.ServletOutputStream;
20 import javax.servlet.ServletRequest;
21 import javax.servlet.ServletResponse;
22 import javax.servlet.http.Cookie;
23 import javax.servlet.http.HttpServletRequest;
24 import javax.servlet.http.HttpServletResponse;
25 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory;
27 import org.springframework.beans.factory.annotation.Autowire;
28 import org.springframework.beans.factory.annotation.Autowired;
29 import org.springframework.beans.factory.annotation.Configurable;
30 import org.springframework.beans.factory.annotation.Qualifier;
38 @Configurable(autowire=Autowire.BY_NAME)
39 public class AcceleratorFilter implements Filter {
40 private final static Logger log = LoggerFactory.getLogger(AcceleratorFilter.class);
42 private final static Map<String,String> EMPTY = Collections.unmodifiableMap(new HashMap<String,String>());
44 public final static Integer DEFAULT_BUFFER_SIZE = 1024;
45 public final static String REQUEST_URI_ATTRIBUTE = "javax.servlet.include.request_uri";
46 public final static String RESPONSE_WRAPPER = AcceleratorFilter.class.getName() + ".RESPONSE_WRAPPER";
49 @Autowired CacheControl cacheControl;
50 @Autowired(required=false) @Qualifier("defaultBufferSize") Integer defaultBufferSize = DEFAULT_BUFFER_SIZE;
51 @Autowired String eTag;
52 @Autowired Boolean weak;
53 @Autowired Long lastModified;
54 @Autowired Integer cacheSeconds;
58 public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
59 if (!(request instanceof HttpServletRequest)) {
60 log.error("AcceleratorFilter can only handle HTTP-requests");
61 chain.doFilter(request, response);
65 HttpServletRequest httpRequest = (HttpServletRequest)request;
66 HttpServletResponse httpResponse = (HttpServletResponse)response;
67 AccelerationWrapper wrapper = new AccelerationWrapper(httpRequest, httpResponse);
68 httpRequest.setAttribute(RESPONSE_WRAPPER, wrapper);
69 cacheControl.init(wrapper);
70 chain.doFilter(request, wrapper);
75 public void init(FilterConfig filterConfig) throws ServletException {
79 public void destroy() {
83 class AccelerationWrapper implements HttpServletResponse, CacheMethodHandle {
85 private final HttpServletRequest request;
86 private final HttpServletResponse response;
88 private final AcceleratorServletOutputStream out;
90 private ServletOutputStream stream;
91 private PrintWriter writer;
93 private boolean guessing = true;
94 protected boolean zipped = false; // << CacheControll greift direkt auf diese Variable zu!
98 private int cacheSeconds;
99 private boolean cacheSecondsSet = false;
100 private long lastModified, expires = 0l;
102 private boolean weak;
103 private Map<String,String> cacheParams;
105 /** Für den AcceleratorOutputStream */
106 private boolean committed = false;
107 private OutputStream os = null;
108 private int bufferSize;
109 private byte[] buffer;
111 private int size = 0;
115 AccelerationWrapper(HttpServletRequest request, HttpServletResponse response) throws IOException {
117 this.request = request;
118 this.response = response;
120 now = System.currentTimeMillis();
121 status = HttpServletResponse.SC_OK;
122 cacheSeconds = AcceleratorFilter.this.cacheSeconds;
123 lastModified = AcceleratorFilter.this.lastModified;
124 eTag = AcceleratorFilter.this.eTag;
125 weak = AcceleratorFilter.this.weak;
126 cacheParams = new HashMap<String,String>();
128 Enumeration values = request.getHeaders(Headers.HEADER_ACCEPT_ENCODING);
129 while (values.hasMoreElements()) {
130 String value = (String) values.nextElement();
131 if (value.indexOf("gzip") != -1) {
137 out = new AcceleratorServletOutputStream();
141 private void finish() throws IOException {
147 public void setStatus(int sc) {
148 response.setStatus(sc);
153 public void setStatus(int sc, String sm) {
154 response.setStatus(sc,sm);
159 public void addDateHeader(String name, long value) {
162 response.addDateHeader(name, value);
166 if (Headers.HEADER_DATE.equalsIgnoreCase(name)) {
168 calculateCacheSeconds();
172 if (Headers.HEADER_EXPIRES.equalsIgnoreCase(name)) {
174 calculateCacheSeconds();
178 if (Headers.HEADER_LAST_MODIFIED.equalsIgnoreCase(name)) {
179 lastModified = value;
183 /** Unknown header: pass throug! */
184 response.addDateHeader(name, value);
188 public void addHeader(String name, String value) {
191 response.addHeader(name, value);
197 analyzeHeader(name, value, false);
201 public void addIntHeader(String name, int value) {
204 response.addIntHeader(name, value);
208 analyzeHeader(name, Integer.toString(value), false);
212 public void setDateHeader(String name, long value) {
215 response.setDateHeader(name, value);
219 if (Headers.HEADER_DATE.equalsIgnoreCase(name)) {
221 calculateCacheSeconds();
225 if (Headers.HEADER_EXPIRES.equalsIgnoreCase(name)) {
227 calculateCacheSeconds();
231 if (Headers.HEADER_LAST_MODIFIED.equalsIgnoreCase(name)) {
232 lastModified = value;
236 /** Unknown header: pass throug! */
237 response.setDateHeader(name, value);
241 public void setHeader(String name, String value) {
244 response.setHeader(name, value);
248 analyzeHeader(name, value, true);
252 public void setIntHeader(String name, int value) {
255 response.setIntHeader(name, value);
259 analyzeHeader(name, Integer.toString(value), true);
263 public ServletOutputStream getOutputStream() throws IOException {
266 throw new IllegalStateException("ServletOutputStream and PrintWriter cannot be requested both!");
268 if (stream == null) {
276 public PrintWriter getWriter() throws IOException {
279 throw new IllegalStateException("ServletOutputStream and PrintWriter cannot be requested both!");
281 if (writer == null) {
282 writer = new PrintWriter(new OutputStreamWriter(out, response.getCharacterEncoding()));
289 public void setContentLength(int len) {
291 log.info("Supressing explicit content-length {} for request {}, because content will be zipped!", len, request.getRequestURI());
293 response.setContentLength(len);
297 public int getBufferSize() {
302 public void setBufferSize(int size) {
304 throw new IllegalStateException("cannot change buffer size, because content was already written!");
306 buffer = new byte[size];
310 public void resetBuffer() {
312 throw new IllegalStateException("cannot reset buffer, because response is already commited!");
319 public void reset() {
321 throw new IllegalStateException("cannot reset response, because response is already commited!");
323 * Da committed==false gilt, wurde die Dekoration noch nicht angestßen
324 * und muss entsprechend auch nicht rückgängig gemacht werden!
334 public void flushBuffer() throws IOException {
337 else if (stream != null)
344 public void addCookie(Cookie cookie) {
345 // TODO: Je nach Vary-Einstellung ETag anpassen?
346 response.addCookie(cookie);
350 public boolean containsHeader(String name) {
351 return response.containsHeader(name);
355 public String encodeURL(String url) {
356 return response.encodeURL(url);
360 public String encodeRedirectURL(String url) {
361 return response.encodeRedirectURL(url);
365 public String encodeUrl(String url) {
366 return response.encodeUrl(url);
370 public String encodeRedirectUrl(String url) {
371 return response.encodeRedirectUrl(url);
375 public void sendError(int sc, String msg) throws IOException {
376 response.sendError(sc,msg);
380 public void sendError(int sc) throws IOException {
381 response.sendError(sc);
385 public void sendRedirect(String location) throws IOException {
386 response.sendRedirect(location);
390 public String getCharacterEncoding() {
391 return response.getCharacterEncoding();
395 public String getContentType() {
396 return response.getContentType();
400 public void setCharacterEncoding(String charset) {
401 // TODO: Je nach Vary-Einstellung ETag anpassen?
402 response.setCharacterEncoding(charset);
406 public void setContentType(String type) {
407 // TODO: Je nach Vary-Einstellung ETag anpassen?
408 response.setContentType(type);
412 public boolean isCommitted() {
417 public void setLocale(Locale loc) {
418 // TODO: Je nach Vary-Einstellung ETag anpassen?
419 response.setLocale(loc);
423 public Locale getLocale() {
430 public boolean isZipped() {
435 public long getTimestamp() {
440 public int accepts(HttpServletRequest request) {
445 public int getCacheSeconds(HttpServletRequest request) {
450 public long getLastModified(HttpServletRequest request) {
455 public String getETag(HttpServletRequest request) {
460 public boolean isETagWeak() {
465 public void cacheControl(HttpServletRequest request, Map<String, String> cacheControlMap) {
466 cacheControlMap.putAll(cacheParams);
470 public Map<String,String> getAdditionalHeaders(HttpServletRequest request) {
474 public void supressGuessing() {
479 private void analyzeHeader(String name, String value, boolean overwrite) {
484 if (name.equalsIgnoreCase(Headers.HEADER_DATE)) {
487 now = System.currentTimeMillis();
488 cacheSeconds = AcceleratorFilter.this.cacheSeconds;
493 SimpleDateFormat parser = new SimpleDateFormat(Headers.RFC_1123_DATE_FORMAT, Locale.US);
494 now = parser.parse(value).getTime();
495 calculateCacheSeconds();
497 catch (ParseException e) {
498 log.warn("ignoring date for header \"Date\" in invalid format: {}", value);
503 if (name.equalsIgnoreCase(Headers.HEADER_EXPIRES)) {
507 cacheSeconds = AcceleratorFilter.this.cacheSeconds;
512 SimpleDateFormat parser = new SimpleDateFormat(Headers.RFC_1123_DATE_FORMAT, Locale.US);
513 expires = parser.parse(value).getTime();
514 calculateCacheSeconds();
516 catch (ParseException e) {
517 log.warn("ignoring date for header \"Expires\" in invalid format: {}", value);
522 if (name.equalsIgnoreCase(Headers.HEADER_LAST_MODIFIED)) {
525 lastModified = AcceleratorFilter.this.lastModified;
529 SimpleDateFormat parser = new SimpleDateFormat(Headers.RFC_1123_DATE_FORMAT, Locale.US);
530 lastModified = parser.parse(value).getTime();
532 catch (ParseException e) {
533 log.warn("ignoring date for header \"Last-Modified\" in invalid format: {}", value);
538 if (name.equalsIgnoreCase(Headers.HEADER_ETAG)) {
541 eTag = AcceleratorFilter.this.eTag;
542 weak = AcceleratorFilter.this.weak;
546 value = value.trim();
548 int end = value.length();
549 if (value.startsWith("W/")) {
556 if (value.charAt(start) == '"')
559 log.warn("Quote at the beginning ov ETag is missing: {}", value);
560 if (value.charAt(end -1) == '"')
563 log.warn("Quote at the end of ETag is missing: {}", value);
564 eTag = value.substring(start, end);
565 String filtered = eTag.replaceAll("[^\\x00-\\x21\\x23-\\x7F]+","");
566 if (filtered.length() < eTag.length()) {
567 log.warn("filtering out illegal characters in ETag: \"{}\" -> \"{}\"", eTag, filtered);
572 if (name.equalsIgnoreCase(Headers.HEADER_CACHE_CONTROL)) {
577 for (String param : value.split(",")) {
578 param = param.trim();
579 int pos = param.indexOf("=");
581 cacheParams.put(param, null);
584 String paramName = param.substring(0, pos).trim();
585 if (paramName.equalsIgnoreCase("max-age")) {
587 cacheSeconds = Integer.parseInt(param.substring(pos + 1));
588 cacheSecondsSet = true;
590 catch (NumberFormatException e) {
591 log.warn("illegal value for Header \"Cache-Control\":", param);
595 cacheParams.put(paramName, param.substring(pos + 1));
602 if (name.equalsIgnoreCase(Headers.HEADER_PRAGMA)) {
603 if (value != null && value.trim().equalsIgnoreCase("no-cache"))
608 /** Pass header through, if no value from intrest was found */
610 response.setHeader(name, value);
612 response.addHeader(name, value);
615 private void calculateCacheSeconds() {
616 if (!cacheSecondsSet && expires >= now) {
617 cacheSeconds = (int)(expires/1000 - now/1000);
618 log.debug("calculating cache-seconds from DATE and EXPIRES: {}", cacheSeconds);
623 private class AcceleratorServletOutputStream extends ServletOutputStream {
625 private final ServletOutputStream sos;
628 private AcceleratorServletOutputStream() throws IOException {
629 bufferSize = defaultBufferSize;
630 buffer = new byte[bufferSize];
631 sos = AccelerationWrapper.this.response.getOutputStream();
635 private OutputStream out() throws IOException {
637 os = zipped ? new GZIPOutputStream(sos) : sos;
642 public void write(int i) throws IOException {
643 if (pos == bufferSize) {
646 /** Dekoration nur beim ersten Schreib-Schub anstoßen */
648 cacheControl.decorate(request, response);
651 buffer[pos++] = (byte) i;
656 public void flush() throws IOException {
661 /** Dekoration nur beim ersten Schreib-Schub anstoßen */
663 cacheControl.decorate(request, response);
664 out().write(buffer, 0, pos);
670 public void close() throws IOException {
674 cacheControl.decorate(request, response);