1 package de.juplo.accelerator;
3 import de.juplo.accelerator.AcceleratorFilter.AccelerationWrapper;
4 import de.juplo.accelerator.annotations.CacheSeconds;
5 import de.juplo.accelerator.annotations.Accepts;
6 import de.juplo.accelerator.annotations.AdditionalHeaders;
7 import de.juplo.accelerator.annotations.LastModified;
8 import de.juplo.accelerator.annotations.ETag;
9 import java.lang.annotation.Annotation;
10 import java.lang.reflect.Method;
11 import java.util.Date;
12 import java.util.HashMap;
14 import java.util.Map.Entry;
15 import java.util.TreeMap;
16 import javax.servlet.http.HttpServletRequest;
17 import javax.servlet.http.HttpServletResponse;
18 import org.slf4j.Logger;
19 import org.slf4j.LoggerFactory;
20 import org.springframework.beans.factory.annotation.Autowired;
21 import org.springframework.beans.factory.annotation.Qualifier;
22 import org.springframework.stereotype.Component;
29 public class CacheControl {
30 private final static Logger log = LoggerFactory.getLogger(CacheControl.class);
32 private static final ThreadLocal<CacheMethodHandle> tl = new ThreadLocal<CacheMethodHandle>();
34 @Autowired @Qualifier("cacheSeconds") private Integer defaultCacheSeconds;
35 @Autowired @Qualifier("lastModified") private Long defaultLastModified;
38 public void init(CacheMethodHandle handle) {
39 CacheControl.tl.set(handle);
42 void init(Object handler, AccelerationWrapper wrapper) throws NoSuchMethodException {
43 CacheControl.tl.set(new ReflectionCacheMethodHandle(handler, wrapper == null ? false : wrapper.zipped));
46 public boolean decorate(
47 HttpServletRequest request,
48 HttpServletResponse response
52 CacheMethodHandle handle = CacheControl.tl.get();
54 /** Doppelte Ausführung verhindern... */
56 /** Dekoration wurde bereits durchgeführt! */
61 * Alle Antworten (insbesondere auch 304) sollen nach dem {@plainlink
62 * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18 RFC 2616,
63 * Abschnitt 14.18} einen Date-Header enthalten
65 response.setDateHeader(Headers.HEADER_DATE, handle.getTimestamp());
67 /** Besondere Maßnahmen für besondere HTTP-Status-Codes ?!? */
68 int status = handle.accepts(request);
70 case HttpServletResponse.SC_OK: // 200
71 case HttpServletResponse.SC_NO_CONTENT: // 204
72 case HttpServletResponse.SC_PARTIAL_CONTENT: // 206
73 /** Normale Antwort! Antwort dekorieren... */
75 case HttpServletResponse.SC_MOVED_PERMANENTLY: // 301
76 case HttpServletResponse.SC_MOVED_TEMPORARILY: // 302
77 case HttpServletResponse.SC_SEE_OTHER: // 303
78 case HttpServletResponse.SC_NOT_MODIFIED: // 304
79 case HttpServletResponse.SC_USE_PROXY: // 305
80 case HttpServletResponse.SC_TEMPORARY_REDIRECT: // 307
81 /** Redirect-Antwort! Antwort dekodieren... */
82 // TODO: Kann das wirklich nicht zu Protokoll-Verletzungen führen?
84 case HttpServletResponse.SC_BAD_REQUEST: // 400
85 case HttpServletResponse.SC_UNAUTHORIZED: // 401
86 case HttpServletResponse.SC_PAYMENT_REQUIRED: // 402
87 case HttpServletResponse.SC_FORBIDDEN: // 403
88 case HttpServletResponse.SC_NOT_FOUND: // 404
89 case HttpServletResponse.SC_METHOD_NOT_ALLOWED: // 405
90 case HttpServletResponse.SC_NOT_ACCEPTABLE: // 406
91 case HttpServletResponse.SC_PROXY_AUTHENTICATION_REQUIRED: // 407
92 case HttpServletResponse.SC_REQUEST_TIMEOUT: // 408
93 case HttpServletResponse.SC_CONFLICT: // 409
94 case HttpServletResponse.SC_GONE: // 410
95 case HttpServletResponse.SC_LENGTH_REQUIRED: // 411
96 case HttpServletResponse.SC_PRECONDITION_FAILED: // 412
97 case HttpServletResponse.SC_REQUEST_ENTITY_TOO_LARGE: // 413
98 case HttpServletResponse.SC_REQUEST_URI_TOO_LONG: // 414
99 case HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE: // 415
100 case HttpServletResponse.SC_REQUESTED_RANGE_NOT_SATISFIABLE: // 416
101 case HttpServletResponse.SC_INTERNAL_SERVER_ERROR: // 500
102 case HttpServletResponse.SC_NOT_IMPLEMENTED: // 501
103 case HttpServletResponse.SC_SERVICE_UNAVAILABLE: // 503
104 case HttpServletResponse.SC_HTTP_VERSION_NOT_SUPPORTED: // 505
107 * Es ist nicht klar, was der Handler noch machen wird/muss:
108 * Antwort nicht dekorieren und Kontroller an den Handler übergeben...
113 Map<String,String> headers = handle.getAdditionalHeaders(request);
114 for (String name : headers.keySet())
115 response.addHeader(name, headers.get(name));
118 if (log.isDebugEnabled()) {
119 if (request.getQueryString() == null) {
120 url = request.getRequestURI();
123 StringBuilder builder = new StringBuilder();
124 builder.append(request.getRequestURI());
126 builder.append(request.getQueryString());
127 url = builder.toString();
131 int cacheSeconds = handle.getCacheSeconds(request);
132 if (cacheSeconds < 0) {
133 log.debug("{}: caching disabled!", url);
134 response.setDateHeader(Headers.HEADER_DATE, handle.getTimestamp());
135 response.setDateHeader(Headers.HEADER_EXPIRES, 0);
136 response.addHeader(Headers.HEADER_PRAGMA, "no-cache");
137 response.addHeader(Headers.HEADER_CACHE_CONTROL, "private");
138 response.addHeader(Headers.HEADER_CACHE_CONTROL, "no-cache");
139 response.addHeader(Headers.HEADER_CACHE_CONTROL, "no-store");
140 response.addHeader(Headers.HEADER_CACHE_CONTROL, "max-age=0");
141 response.addHeader(Headers.HEADER_CACHE_CONTROL, "s-max-age=0");
142 if (handle.isZipped())
143 response.addHeader(Headers.HEADER_CONTENT_ENCODING, "gzip");
147 long ifModifiedSince = -1;
149 ifModifiedSince = request.getDateHeader(Headers.HEADER_IF_MODIFIED_SINCE);
151 catch (Exception e) {
152 log.error("Exception while fetching If-Modified-Since: {}", e);
155 long lastModified = handle.getLastModified(request);
158 * Sicherstellen, dass der Wert keine Millisekunden enthält, da die
159 * Zeitangabe aus dem Modified-Since-Header keine Millisekunden enthalten
160 * kann und der Test unten dann stets fehlschlagen würde!
162 lastModified = lastModified - (lastModified % 1000);
164 String ifNoneMatch = request.getHeader(Headers.HEADER_IF_NONE_MATCH);
165 String eTag = handle.getETag(request);
168 * 304-Antworten sollen nach dem {@plainlink
169 * http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5 RFC
170 * 2616, Abschnitt 10.3.5} einen ETag-Header enthalten, wenn auch die
171 * 200-Antwort einen enthalten hätte.
174 StringBuilder builder = new StringBuilder();
175 if (handle.isETagWeak())
176 builder.append("W/");
178 builder.append(eTag);
180 response.setHeader(Headers.HEADER_ETAG, builder.toString());
184 if (ifModifiedSince >= lastModified && lastModified > 0) {
186 * request.getDateHeader liefert die Zeit als long, oder -1, wenn der
187 * Header nicht existiert. D.h., wenn "If-Modified-Since" nicht gesetzt
188 * ist, wird die komplette Seite ausgeliefert.
189 * Der zusätzliche Test, ob lastModified größer 0 ist, ist nötig, um
190 * Fehler auszuschließen, wenn die Implementierung von Cachable
191 * negative Werte für Last-Modified zurückliefert.
193 if (log.isDebugEnabled())
194 log.debug("{}: Not modified since {}", url, new Date(ifModifiedSince));
196 if (ifNoneMatch == null) {
197 /** Neue Anfrage oder HTTP/1.0 Client! */
198 log.debug("{}: ETag nicht gesetzt -> 304", url);
199 response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
204 if (ifNoneMatch != null) {
205 boolean weak = false;
206 if (ifNoneMatch.startsWith("W/")) {
208 ifNoneMatch = ifNoneMatch.substring(3, ifNoneMatch.length() - 1);
211 ifNoneMatch = ifNoneMatch.substring(1, ifNoneMatch.length() - 1);
214 if (!weak || (request.getMethod().equals("GET") && request.getHeader(Headers.HEADER_RANGE) == null)) {
216 * Die Gleichheit gilt nur, wenn die ETag's der Anfrage _und_ der
217 * Antwort stark sind (starke Gleichheit!), oder wenn die Antwort nur
218 * schwache Gleichheit fordert...
220 if (ifNoneMatch.equals(eTag) && (handle.isETagWeak() || !weak)) {
221 log.debug("{}: ETag {} not changed -> 304 ", url, ifNoneMatch);
222 response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
227 log.warn("{}: ignoring weak ETag W/\"{}\", because the request was no GET-request or the Range-Header was present!", url, ifNoneMatch);
232 log.debug("{}: first up!", url);
234 if (handle.isZipped())
235 response.addHeader(Headers.HEADER_CONTENT_ENCODING, "gzip");
237 /** HTTP/1.1-Caching-Header richtig setzen!! */
238 response.setDateHeader(Headers.HEADER_LAST_MODIFIED, lastModified);
240 /** Cache-Control für HTTP/1.1-Clients generieren */
241 Map<String, String> cacheControl = new TreeMap<String, String>();
244 * Wenn eins JSESSIONID in der URL enthalten ist, darf die Anfrage nur vom
245 * Browser gecached werden!
247 if (request.isRequestedSessionIdFromURL()) {
248 cacheControl.put("private", null);
252 * Hier muss nicht geprüft werden, ob cacheSeconds > 0 gilt, da in diesem
253 * Fall oben bereits No-Cache-Header generiert und <code>false</code>
254 * zurückgeliefert werden!
256 * Den Wert als <code>max-age</code> zu den Schlüssel-Wert-Paaren für den
257 * <code>Cache-Control</code>-Header hinzufügen und einen entsprechenden
258 * <code>Expires</code>-Header für HTTP/1.0-Clients setzen.
260 cacheControl.put("max-age", Integer.toString(cacheSeconds));
261 response.setDateHeader(Headers.HEADER_EXPIRES, (handle.getTimestamp() + (long) cacheSeconds * 1000));
264 /** Dem Handler die Gelegenheit geben, den Cache-Controll-Header anzupassen */
265 handle.cacheControl(request, cacheControl);
268 if (cacheControl.containsKey("private")) {
270 * HTTP/1.0 Caches davon abhalten, die Ressource zu cachen (vgl.: RFC
272 * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3
273 * Abschnitt 14.9.3} und {@plainlink
274 * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32
277 response.setDateHeader(Headers.HEADER_EXPIRES, 0l);
278 response.addHeader(Headers.HEADER_PRAGMA, "no-cache");
281 StringBuilder builder = new StringBuilder();
282 for (Entry<String, String> entry : cacheControl.entrySet()) {
283 builder.setLength(0);
284 builder.append(entry.getKey());
285 if (entry.getValue() != null) {
287 builder.append(entry.getValue());
289 response.addHeader(Headers.HEADER_CACHE_CONTROL, builder.toString());
296 * Thread-Locale-Variable zurücksetzen, damit
297 * 1.) ein doppelter Aufruf dieser Methode pro Request erkannt werden kann
298 * 2.) der nächste Request nicht mit dem selben Handle weiterarbeitet
300 CacheControl.tl.set(null);
304 public void release() {
305 CacheControl.tl.set(null);
309 class ReflectionCacheMethodHandle implements CacheMethodHandle {
311 private Object handler;
312 private long now = System.currentTimeMillis();
313 private Integer cacheSeconds;
314 private Long lastModified;
316 private Map<String,String> additionalHeaders;
317 private Method acceptsMethod;
318 private Method cacheSecondsMethod;
319 private Method lastModifiedMethod;
320 private Method eTagMethod;
321 private Method cacheControlMethod;
322 private Method additionalHeadersMethod;
323 private boolean isAcceptsMethodDefined;
324 private boolean isCacheSecondsMethodDefined;
325 private boolean isLastModifiedMethodDefined;
326 private boolean isETagMethodDefined;
327 private boolean isCacheControlMethodDefined;
328 private boolean isAdditionalHeadersMethodDefined;
329 private boolean weak;
330 private boolean zipped;
333 ReflectionCacheMethodHandle(Object handler, boolean zipped) throws NoSuchMethodException {
335 this.handler = handler;
336 this.zipped = zipped;
338 cacheSeconds = CacheControl.this.defaultCacheSeconds;
339 lastModified = CacheControl.this.defaultLastModified;
341 /** Class-Level-Annotations auslesen */
342 for (Annotation annotation : handler.getClass().getAnnotations()) {
343 if (annotation.annotationType().equals(CacheSeconds.class)) {
344 cacheSeconds = ((CacheSeconds)annotation).value();
345 isCacheSecondsMethodDefined = true;
348 if (annotation.annotationType().equals(LastModified.class)) {
349 lastModified = ((LastModified)annotation).value();
350 if (lastModified < 1) {
352 * Ein Last-Modified-Header wurde angefordert, aber es wurde kein
353 * statischer Wert spezifiziert:
354 * globalen statischen Default-Wert benutzen!
356 lastModified = defaultLastModified;
358 isLastModifiedMethodDefined = true;
361 if (annotation.annotationType().equals(ETag.class)) {
362 ETag eTagAnnotation = (ETag)annotation;
363 eTag = eTagAnnotation.value();
364 weak = eTagAnnotation.weak();
365 isETagMethodDefined = true;
368 if (annotation.annotationType().equals(AdditionalHeaders.class)) {
369 AdditionalHeaders additionalHeadersAnnotation = (AdditionalHeaders)annotation;
370 additionalHeaders = new HashMap<String,String>();
371 for (String header : additionalHeadersAnnotation.value()) {
372 int i = header.indexOf(':');
374 log.error("invalid header: [{}]", header);
377 String name = header.substring(0,i).trim();
378 String value = header.substring(i+1,header.length()).trim();
379 additionalHeaders.put(name, value);
382 isAdditionalHeadersMethodDefined = true;
387 /** Method-Level-Annotations auslesen */
388 for (Method method : handler.getClass().getMethods()) {
389 for (Annotation annotation : method.getAnnotations()) {
390 if (annotation.annotationType().equals(Accepts.class)) {
391 if (isAcceptsMethodDefined)
392 throw new IllegalArgumentException("Die Annotation @Accept wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
393 acceptsMethod = method;
394 isAcceptsMethodDefined = true;
397 if (annotation.annotationType().equals(CacheSeconds.class)) {
398 if (isCacheSecondsMethodDefined)
399 throw new IllegalArgumentException("Die Annotation @CacheSeconds wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
400 cacheSecondsMethod = method;
401 isCacheSecondsMethodDefined = true;
404 if (annotation.annotationType().equals(LastModified.class)) {
405 if (isLastModifiedMethodDefined)
406 throw new IllegalArgumentException("Die Annotation @LastModified wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
407 lastModifiedMethod = method;
408 isLastModifiedMethodDefined = true;
411 if (annotation.annotationType().equals(ETag.class)) {
412 if (isETagMethodDefined)
413 throw new IllegalArgumentException("Die Annotation @ETag wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
415 weak = ((ETag)annotation).weak();
416 isETagMethodDefined = true;
419 if (annotation.annotationType().equals(de.juplo.accelerator.annotations.CacheControl.class)) {
420 if (isCacheControlMethodDefined)
421 throw new IllegalArgumentException("Die Annotation @CacheControl wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
422 cacheControlMethod = method;
423 isCacheControlMethodDefined = true;
426 if (annotation.annotationType().equals(AdditionalHeaders.class)) {
427 if (isAdditionalHeadersMethodDefined)
428 throw new IllegalArgumentException("Die Annotation @AdditionalHeaders wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
429 additionalHeadersMethod = method;
430 isAdditionalHeadersMethodDefined = true;
436 if (!isAdditionalHeadersMethodDefined)
437 additionalHeaders = new HashMap<String,String>();
442 public boolean isZipped() {
447 public long getTimestamp() {
452 public int accepts(HttpServletRequest request) throws IllegalArgumentException {
453 if (acceptsMethod == null) {
454 return HttpServletResponse.SC_OK;
458 return (Integer)acceptsMethod.invoke(handler, request);
460 catch (Exception e) {
461 throw new IllegalArgumentException(e);
467 public int getCacheSeconds(HttpServletRequest request) throws IllegalArgumentException {
468 if (cacheSecondsMethod == null) {
473 return (Integer)cacheSecondsMethod.invoke(handler, request);
475 catch (Exception e) {
476 throw new IllegalArgumentException(e);
482 public long getLastModified(HttpServletRequest request) throws IllegalArgumentException {
483 if (lastModifiedMethod == null) {
488 return (Long)lastModifiedMethod.invoke(handler, request);
490 catch (Exception e) {
491 throw new IllegalArgumentException(e);
497 public String getETag(HttpServletRequest request) throws IllegalArgumentException {
498 if (eTagMethod == null) {
503 return (String)eTagMethod.invoke(handler, request);
505 catch (Exception e) {
506 throw new IllegalArgumentException(e);
512 public boolean isETagWeak() {
517 public void cacheControl(
518 HttpServletRequest request,
519 Map<String, String> cacheControlMap
521 throws IllegalArgumentException
523 if (cacheControlMethod != null) {
525 cacheControlMethod.invoke(handler, request, cacheControlMap);
527 catch (Exception e) {
528 throw new IllegalArgumentException(e);
534 public Map<String,String> getAdditionalHeaders(HttpServletRequest request) throws IllegalArgumentException {
535 if (additionalHeadersMethod == null) {
536 return additionalHeaders;
540 return (Map<String,String>)additionalHeadersMethod.invoke(handler, request);
542 catch (Exception e) {
543 throw new IllegalArgumentException(e);