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);
71 chain.doFilter(request, wrapper);
74 catch (NotModifiedException nm) {
75 log.trace("Not modified: {}", httpRequest.getRequestURI());
80 public void init(FilterConfig filterConfig) throws ServletException {
84 public void destroy() {
88 class AccelerationWrapper implements HttpServletResponse, CacheMethodHandle {
90 private final HttpServletRequest request;
91 private final HttpServletResponse response;
93 private final AcceleratorServletOutputStream out;
95 private ServletOutputStream stream;
96 private PrintWriter writer;
98 private boolean guessing = true;
99 protected boolean zipped = false; // << CacheControll greift direkt auf diese Variable zu!
103 private int cacheSeconds;
104 private boolean cacheSecondsSet = false;
105 private long lastModified, expires = 0l;
107 private boolean weak;
108 private Map<String,String> cacheParams;
110 /** Für den AcceleratorOutputStream */
111 private boolean committed = false;
112 private OutputStream os = null;
113 private int bufferSize;
114 private byte[] buffer;
116 private int size = 0;
120 AccelerationWrapper(HttpServletRequest request, HttpServletResponse response) throws IOException {
122 this.request = request;
123 this.response = response;
125 now = System.currentTimeMillis();
126 status = HttpServletResponse.SC_OK;
127 cacheSeconds = AcceleratorFilter.this.cacheSeconds;
128 lastModified = AcceleratorFilter.this.lastModified;
129 eTag = AcceleratorFilter.this.eTag;
130 weak = AcceleratorFilter.this.weak;
131 cacheParams = new HashMap<String,String>();
133 Enumeration values = request.getHeaders(Headers.HEADER_ACCEPT_ENCODING);
134 while (values.hasMoreElements()) {
135 String value = (String) values.nextElement();
136 if (value.indexOf("gzip") != -1) {
142 out = new AcceleratorServletOutputStream();
146 private void finish() throws IOException {
152 public void setStatus(int sc) {
153 response.setStatus(sc);
158 public void setStatus(int sc, String sm) {
159 response.setStatus(sc,sm);
164 public void addDateHeader(String name, long value) {
167 response.addDateHeader(name, value);
171 if (Headers.HEADER_DATE.equalsIgnoreCase(name)) {
173 calculateCacheSeconds();
177 if (Headers.HEADER_EXPIRES.equalsIgnoreCase(name)) {
179 calculateCacheSeconds();
183 if (Headers.HEADER_LAST_MODIFIED.equalsIgnoreCase(name)) {
184 lastModified = value;
188 /** Unknown header: pass throug! */
189 response.addDateHeader(name, value);
193 public void addHeader(String name, String value) {
196 response.addHeader(name, value);
202 analyzeHeader(name, value, false);
206 public void addIntHeader(String name, int value) {
209 response.addIntHeader(name, value);
213 analyzeHeader(name, Integer.toString(value), false);
217 public void setDateHeader(String name, long value) {
220 response.setDateHeader(name, value);
224 if (Headers.HEADER_DATE.equalsIgnoreCase(name)) {
226 calculateCacheSeconds();
230 if (Headers.HEADER_EXPIRES.equalsIgnoreCase(name)) {
232 calculateCacheSeconds();
236 if (Headers.HEADER_LAST_MODIFIED.equalsIgnoreCase(name)) {
237 lastModified = value;
241 /** Unknown header: pass throug! */
242 response.setDateHeader(name, value);
246 public void setHeader(String name, String value) {
249 response.setHeader(name, value);
253 analyzeHeader(name, value, true);
257 public void setIntHeader(String name, int value) {
260 response.setIntHeader(name, value);
264 analyzeHeader(name, Integer.toString(value), true);
268 public ServletOutputStream getOutputStream() throws IOException {
271 throw new IllegalStateException("ServletOutputStream and PrintWriter cannot be requested both!");
273 if (stream == null) {
281 public PrintWriter getWriter() throws IOException {
284 throw new IllegalStateException("ServletOutputStream and PrintWriter cannot be requested both!");
286 if (writer == null) {
287 writer = new PrintWriter(new OutputStreamWriter(out, response.getCharacterEncoding()));
294 public void setContentLength(int len) {
296 log.info("Supressing explicit content-length {} for request {}, because content will be zipped!", len, request.getRequestURI());
298 response.setContentLength(len);
302 public int getBufferSize() {
307 public void setBufferSize(int size) {
309 throw new IllegalStateException("cannot change buffer size, because content was already written!");
311 buffer = new byte[size];
315 public void resetBuffer() {
317 throw new IllegalStateException("cannot reset buffer, because response is already commited!");
324 public void reset() {
326 throw new IllegalStateException("cannot reset response, because response is already commited!");
328 * Da committed==false gilt, wurde die Dekoration noch nicht angestßen
329 * und muss entsprechend auch nicht rückgängig gemacht werden!
339 public void flushBuffer() throws IOException {
342 else if (stream != null)
347 public void addCookie(Cookie cookie) {
348 // TODO: Je nach Vary-Einstellung ETag anpassen?
349 response.addCookie(cookie);
353 public boolean containsHeader(String name) {
354 return response.containsHeader(name);
358 public String encodeURL(String url) {
359 return response.encodeURL(url);
363 public String encodeRedirectURL(String url) {
364 return response.encodeRedirectURL(url);
368 public String encodeUrl(String url) {
369 return response.encodeUrl(url);
373 public String encodeRedirectUrl(String url) {
374 return response.encodeRedirectUrl(url);
378 public void sendError(int sc, String msg) throws IOException {
379 response.sendError(sc,msg);
383 public void sendError(int sc) throws IOException {
384 response.sendError(sc);
388 public void sendRedirect(String location) throws IOException {
389 response.sendRedirect(location);
393 public String getCharacterEncoding() {
394 return response.getCharacterEncoding();
398 public String getContentType() {
399 return response.getContentType();
403 public void setCharacterEncoding(String charset) {
404 // TODO: Je nach Vary-Einstellung ETag anpassen?
405 response.setCharacterEncoding(charset);
409 public void setContentType(String type) {
410 // TODO: Je nach Vary-Einstellung ETag anpassen?
411 response.setContentType(type);
415 public boolean isCommitted() {
420 public void setLocale(Locale loc) {
421 // TODO: Je nach Vary-Einstellung ETag anpassen?
422 response.setLocale(loc);
426 public Locale getLocale() {
433 public boolean isZipped() {
438 public long getTimestamp() {
443 public int accepts(HttpServletRequest request) {
448 public int getCacheSeconds(HttpServletRequest request) {
453 public long getLastModified(HttpServletRequest request) {
458 public String getETag(HttpServletRequest request) {
463 public boolean isETagWeak() {
468 public void cacheControl(HttpServletRequest request, Map<String, String> cacheControlMap) {
469 cacheControlMap.putAll(cacheParams);
473 public Map<String,String> getAdditionalHeaders(HttpServletRequest request) {
477 public void supressGuessing() {
482 private void analyzeHeader(String name, String value, boolean overwrite) {
487 if (name.equalsIgnoreCase(Headers.HEADER_DATE)) {
490 now = System.currentTimeMillis();
491 cacheSeconds = AcceleratorFilter.this.cacheSeconds;
496 SimpleDateFormat parser = new SimpleDateFormat(Headers.RFC_1123_DATE_FORMAT, Locale.US);
497 now = parser.parse(value).getTime();
498 calculateCacheSeconds();
500 catch (ParseException e) {
501 log.warn("ignoring date for header \"Date\" in invalid format: {}", value);
506 if (name.equalsIgnoreCase(Headers.HEADER_EXPIRES)) {
510 cacheSeconds = AcceleratorFilter.this.cacheSeconds;
515 SimpleDateFormat parser = new SimpleDateFormat(Headers.RFC_1123_DATE_FORMAT, Locale.US);
516 expires = parser.parse(value).getTime();
517 calculateCacheSeconds();
519 catch (ParseException e) {
520 log.warn("ignoring date for header \"Expires\" in invalid format: {}", value);
525 if (name.equalsIgnoreCase(Headers.HEADER_LAST_MODIFIED)) {
528 lastModified = AcceleratorFilter.this.lastModified;
532 SimpleDateFormat parser = new SimpleDateFormat(Headers.RFC_1123_DATE_FORMAT, Locale.US);
533 lastModified = parser.parse(value).getTime();
535 catch (ParseException e) {
536 log.warn("ignoring date for header \"Last-Modified\" in invalid format: {}", value);
541 if (name.equalsIgnoreCase(Headers.HEADER_ETAG)) {
544 eTag = AcceleratorFilter.this.eTag;
545 weak = AcceleratorFilter.this.weak;
549 value = value.trim();
551 int end = value.length();
552 if (value.startsWith("W/")) {
559 if (value.charAt(start) == '"')
562 log.warn("Quote at the beginning ov ETag is missing: {}", value);
563 if (value.charAt(end -1) == '"')
566 log.warn("Quote at the end of ETag is missing: {}", value);
567 eTag = value.substring(start, end);
568 String filtered = eTag.replaceAll("[^\\x00-\\x21\\x23-\\x7F]+","");
569 if (filtered.length() < eTag.length()) {
570 log.warn("filtering out illegal characters in ETag: \"{}\" -> \"{}\"", eTag, filtered);
575 if (name.equalsIgnoreCase(Headers.HEADER_CACHE_CONTROL)) {
580 for (String param : value.split(",")) {
581 param = param.trim();
582 int pos = param.indexOf("=");
584 cacheParams.put(param, null);
587 String paramName = param.substring(0, pos).trim();
588 if (paramName.equalsIgnoreCase("max-age")) {
590 cacheSeconds = Integer.parseInt(param.substring(pos + 1));
591 cacheSecondsSet = true;
593 catch (NumberFormatException e) {
594 log.warn("illegal value for Header \"Cache-Control\":", param);
598 cacheParams.put(paramName, param.substring(pos + 1));
605 if (name.equalsIgnoreCase(Headers.HEADER_PRAGMA)) {
606 if (value != null && value.trim().equalsIgnoreCase("no-cache"))
611 /** Pass header through, if no value from intrest was found */
613 response.setHeader(name, value);
615 response.addHeader(name, value);
618 private void calculateCacheSeconds() {
619 if (!cacheSecondsSet && expires >= now) {
620 cacheSeconds = (int)(expires/1000 - now/1000);
621 log.debug("calculating cache-seconds from DATE and EXPIRES: {}", cacheSeconds);
626 private class AcceleratorServletOutputStream extends ServletOutputStream {
628 private final ServletOutputStream sos;
631 private AcceleratorServletOutputStream() throws IOException {
632 bufferSize = defaultBufferSize;
633 buffer = new byte[bufferSize];
634 sos = AccelerationWrapper.this.response.getOutputStream();
638 private OutputStream out() throws IOException {
640 os = zipped ? new GZIPOutputStream(sos) : sos;
645 public void write(int i) throws IOException {
646 if (pos == bufferSize) {
649 /** Dekoration nur beim ersten Schreib-Schub anstoßen */
651 if (!cacheControl.decorate(request, response)) {
655 throw new NotModifiedException();
660 buffer[pos++] = (byte) i;
665 public void flush() throws IOException {
670 /** Dekoration nur beim ersten Schreib-Schub anstoßen */
672 if (!cacheControl.decorate(request, response)) {
676 throw new NotModifiedException();
679 out().write(buffer, 0, pos);
685 public void close() throws IOException {
689 if (!cacheControl.decorate(request, response))
690 throw new NotModifiedException();
702 class NotModifiedException extends IOException {}