juplo.de Git - percentcodec/blob - accelerator/src/main/java/de/juplo/accelerator/CacheControl.java

   1 package de.juplo.accelerator;
   2
   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;
  13 import java.util.Map;
  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;
  23
  24 /**
  25  *
  26  * @author kai
  27  */
  28 @Component
  29 public class CacheControl {
  30   private final static Logger log = LoggerFactory.getLogger(CacheControl.class);
  31
  32   private static final ThreadLocal<CacheMethodHandle> tl = new ThreadLocal<CacheMethodHandle>();
  33
  34   @Autowired @Qualifier("cacheSeconds") private Integer defaultCacheSeconds;
  35   @Autowired @Qualifier("lastModified") private Long defaultLastModified;
  36
  37
  38   public void init(CacheMethodHandle handle) {
  39     CacheControl.tl.set(handle);
  40   }
  41
  42   void init(Object handler, AccelerationWrapper wrapper) throws NoSuchMethodException {
  43     CacheControl.tl.set(new ReflectionCacheMethodHandle(handler, wrapper == null ? false : wrapper.zipped));
  44   }
  45
  46   public boolean decorate(
  47       HttpServletRequest request,
  48       HttpServletResponse response
  49       )
  50   {
  51     try {
  52     CacheMethodHandle handle = CacheControl.tl.get();
  53
  54     /** Doppelte Ausführung verhindern... */
  55     if (handle == null) {
  56       /** Dekoration wurde bereits durchgeführt! */
  57       return true;
  58     }
  59
  60     /**
  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
  64      */
  65     response.setDateHeader(Headers.HEADER_DATE, handle.getTimestamp());
  66
  67     /** Besondere Maßnahmen für besondere HTTP-Status-Codes ?!? */
  68     int status = handle.accepts(request);
  69     switch (status) {
  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... */
  74         break;
  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?
  83         break;
  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
 105       default:
 106         /**
 107          * Es ist nicht klar, was der Handler noch machen wird/muss:
 108          * Antwort nicht dekorieren und Kontroller an den Handler übergeben...
 109          */
 110         return true;
 111     }
 112
 113     Map<String,String> headers = handle.getAdditionalHeaders(request);
 114     for (String name : headers.keySet())
 115       response.addHeader(name, headers.get(name));
 116
 117     String url = null;
 118     if (log.isDebugEnabled()) {
 119       if (request.getQueryString() == null) {
 120         url = request.getRequestURI();
 121       }
 122       else {
 123         StringBuilder builder = new StringBuilder();
 124         builder.append(request.getRequestURI());
 125         builder.append('?');
 126         builder.append(request.getQueryString());
 127         url = builder.toString();
 128       }
 129     }
 130
 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");
 144       return true;
 145     }
 146
 147     long ifModifiedSince = -1;
 148     try {
 149       ifModifiedSince = request.getDateHeader(Headers.HEADER_IF_MODIFIED_SINCE);
 150     }
 151     catch (Exception e) {
 152       log.error("Exception while fetching If-Modified-Since: {}", e);
 153     }
 154
 155     long lastModified = handle.getLastModified(request);
 156
 157     /**
 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!
 161      */
 162     lastModified = lastModified - (lastModified % 1000);
 163
 164     String ifNoneMatch = request.getHeader(Headers.HEADER_IF_NONE_MATCH);
 165     String eTag = handle.getETag(request);
 166
 167     /**
 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.
 172      */
 173     if (eTag != null) {
 174       StringBuilder builder = new StringBuilder();
 175       if (handle.isETagWeak())
 176         builder.append("W/");
 177       builder.append('"');
 178       builder.append(eTag);
 179       builder.append('"');
 180       response.setHeader(Headers.HEADER_ETAG, builder.toString());
 181     }
 182
 183
 184     if (ifModifiedSince >= lastModified && lastModified > 0) {
 185       /**
 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.
 192        */
 193       if (log.isDebugEnabled())
 194         log.debug("{}: Not modified since {}", url, new Date(ifModifiedSince));
 195
 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);
 200         return false;
 201       }
 202     }
 203
 204     if (ifNoneMatch != null) {
 205       boolean weak = false;
 206       if (ifNoneMatch.startsWith("W/")) {
 207         weak = true;
 208         ifNoneMatch = ifNoneMatch.substring(3, ifNoneMatch.length() - 1);
 209       }
 210       else {
 211         ifNoneMatch = ifNoneMatch.substring(1, ifNoneMatch.length() - 1);
 212       }
 213
 214       if (!weak || (request.getMethod().equals("GET") && request.getHeader(Headers.HEADER_RANGE) == null)) {
 215         /**
 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...
 219          */
 220         if (ifNoneMatch.equals(eTag) && (handle.isETagWeak() || !weak)) {
 221           log.debug("{}: ETag {} not changed -> 304 ", url, ifNoneMatch);
 222           response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
 223           return false;
 224         }
 225       }
 226       else {
 227         log.warn("{}: ignoring weak ETag W/\"{}\", because the request was no GET-request or the Range-Header was present!", url, ifNoneMatch);
 228       }
 229     }
 230
 231
 232     log.debug("{}: first up!", url);
 233
 234     if (handle.isZipped())
 235       response.addHeader(Headers.HEADER_CONTENT_ENCODING, "gzip");
 236
 237     /** HTTP/1.1-Caching-Header richtig setzen!! */
 238     response.setDateHeader(Headers.HEADER_LAST_MODIFIED, lastModified);
 239
 240     /** Cache-Control für HTTP/1.1-Clients generieren */
 241     Map<String, String> cacheControl = new TreeMap<String, String>();
 242
 243     /**
 244      * Wenn eins JSESSIONID in der URL enthalten ist, darf die Anfrage nur vom
 245      * Browser gecached werden!
 246      */
 247     if (request.isRequestedSessionIdFromURL()) {
 248       cacheControl.put("private", null);
 249     }
 250     else {
 251       /**
 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!
 255        *
 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.
 259        */
 260       cacheControl.put("max-age", Integer.toString(cacheSeconds));
 261       response.setDateHeader(Headers.HEADER_EXPIRES, (handle.getTimestamp() + (long) cacheSeconds * 1000));
 262     }
 263
 264     /** Dem Handler die Gelegenheit geben, den Cache-Controll-Header anzupassen */
 265     handle.cacheControl(request, cacheControl);
 266
 267
 268     if (cacheControl.containsKey("private")) {
 269       /**
 270        * HTTP/1.0 Caches davon abhalten, die Ressource zu cachen (vgl.: RFC
 271        * 2616, {@plainlink
 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
 275        * Abschnitt 14.32})
 276        */
 277       response.setDateHeader(Headers.HEADER_EXPIRES, 0l);
 278       response.addHeader(Headers.HEADER_PRAGMA, "no-cache");
 279     }
 280
 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) {
 286         builder.append('=');
 287         builder.append(entry.getValue());
 288       }
 289       response.addHeader(Headers.HEADER_CACHE_CONTROL, builder.toString());
 290     }
 291
 292     return true;
 293     }
 294     finally {
 295       /**
 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
 299        */
 300       CacheControl.tl.set(null);
 301     }
 302   }
 303
 304   public void release() {
 305     CacheControl.tl.set(null);
 306   }
 307
 308
 309   class ReflectionCacheMethodHandle implements CacheMethodHandle {
 310
 311     private Object handler;
 312     private long now = System.currentTimeMillis();
 313     private Integer cacheSeconds;
 314     private Long lastModified;
 315     private String eTag;
 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;
 331
 332
 333     ReflectionCacheMethodHandle(Object handler, boolean zipped) throws NoSuchMethodException {
 334
 335       this.handler = handler;
 336       this.zipped = zipped;
 337
 338       cacheSeconds = CacheControl.this.defaultCacheSeconds;
 339       lastModified = CacheControl.this.defaultLastModified;
 340
 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;
 346           continue;
 347         }
 348         if (annotation.annotationType().equals(LastModified.class)) {
 349           lastModified = ((LastModified)annotation).value();
 350           if (lastModified < 1) {
 351             /**
 352              * Ein Last-Modified-Header wurde angefordert, aber es wurde kein
 353              * statischer Wert spezifiziert:
 354              * globalen statischen Default-Wert benutzen!
 355              */
 356             lastModified = defaultLastModified;
 357           }
 358           isLastModifiedMethodDefined = true;
 359           continue;
 360         }
 361         if (annotation.annotationType().equals(ETag.class)) {
 362           ETag eTagAnnotation = (ETag)annotation;
 363           eTag = eTagAnnotation.value();
 364           weak = eTagAnnotation.weak();
 365           isETagMethodDefined = true;
 366           continue;
 367         }
 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(':');
 373             if (i < 0) {
 374               log.error("invalid header: [{}]", header);
 375             }
 376             else {
 377               String name = header.substring(0,i).trim();
 378               String value = header.substring(i+1,header.length()).trim();
 379               additionalHeaders.put(name, value);
 380             }
 381           }
 382           isAdditionalHeadersMethodDefined = true;
 383           continue;
 384         }
 385       }
 386
 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;
 395             continue;
 396           }
 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;
 402             continue;
 403           }
 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;
 409             continue;
 410           }
 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!");
 414             eTagMethod = method;
 415             weak = ((ETag)annotation).weak();
 416             isETagMethodDefined = true;
 417             continue;
 418           }
 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;
 424             continue;
 425           }
 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;
 431             continue;
 432           }
 433         }
 434       }
 435
 436       if (!isAdditionalHeadersMethodDefined)
 437         additionalHeaders = new HashMap<String,String>();
 438     }
 439
 440
 441     @Override
 442     public boolean isZipped() {
 443       return zipped;
 444     }
 445
 446     @Override
 447     public long getTimestamp() {
 448       return now;
 449     }
 450
 451     @Override
 452     public int accepts(HttpServletRequest request) throws IllegalArgumentException {
 453       if (acceptsMethod == null) {
 454         return HttpServletResponse.SC_OK;
 455       }
 456       else {
 457         try {
 458           return (Integer)acceptsMethod.invoke(handler, request);
 459         }
 460         catch (Exception e) {
 461           throw new IllegalArgumentException(e);
 462         }
 463       }
 464     }
 465
 466     @Override
 467     public int getCacheSeconds(HttpServletRequest request) throws IllegalArgumentException {
 468       if (cacheSecondsMethod == null) {
 469         return cacheSeconds;
 470       }
 471       else {
 472         try {
 473           return (Integer)cacheSecondsMethod.invoke(handler, request);
 474         }
 475         catch (Exception e) {
 476           throw new IllegalArgumentException(e);
 477         }
 478       }
 479     }
 480
 481     @Override
 482     public long getLastModified(HttpServletRequest request) throws IllegalArgumentException {
 483       if (lastModifiedMethod == null) {
 484         return lastModified;
 485       }
 486       else {
 487         try {
 488           return (Long)lastModifiedMethod.invoke(handler, request);
 489         }
 490         catch (Exception e) {
 491           throw new IllegalArgumentException(e);
 492         }
 493       }
 494     }
 495
 496     @Override
 497     public String getETag(HttpServletRequest request) throws IllegalArgumentException {
 498       if (eTagMethod == null) {
 499         return eTag;
 500       }
 501       else {
 502         try {
 503           return (String)eTagMethod.invoke(handler, request);
 504         }
 505         catch (Exception e) {
 506           throw new IllegalArgumentException(e);
 507         }
 508       }
 509     }
 510
 511     @Override
 512     public boolean isETagWeak() {
 513       return weak;
 514     }
 515
 516     @Override
 517     public void cacheControl(
 518         HttpServletRequest request,
 519         Map<String, String> cacheControlMap
 520         )
 521         throws IllegalArgumentException
 522     {
 523       if (cacheControlMethod != null) {
 524         try {
 525           cacheControlMethod.invoke(handler, request, cacheControlMap);
 526         }
 527         catch (Exception e) {
 528           throw new IllegalArgumentException(e);
 529         }
 530       }
 531     }
 532
 533     @Override
 534     public Map<String,String> getAdditionalHeaders(HttpServletRequest request) throws IllegalArgumentException {
 535       if (additionalHeadersMethod == null) {
 536         return additionalHeaders;
 537       }
 538       else {
 539         try {
 540           return (Map<String,String>)additionalHeadersMethod.invoke(handler, request);
 541         }
 542         catch (Exception e) {
 543           throw new IllegalArgumentException(e);
 544         }
 545       }
 546     }
 547   }
 548 }