X-Git-Url: https://juplo.de/gitweb/?p=percentcodec;a=blobdiff_plain;f=cachecontrol%2Fsrc%2Fmain%2Fjava%2Fde%2Fhalbekunst%2Fjuplo%2Fcachecontrol%2FCacheControl.java;h=0512de4a0a84cd7301e78c2c015dc6ab21e7580b;hp=19a60b51f9dd6ac24eb5403d42ede80d6d2a2523;hb=2ae9a9d1011d3cb6cb0a172b629cb390c4fdf0ea;hpb=3324545626f8f93c43e3b54cf56004d19af17da2

diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java
index 19a60b51..0512de4a 100644
--- a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java
+++ b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java
@@ -1,12 +1,15 @@
 package de.halbekunst.juplo.cachecontrol;
 
+import de.halbekunst.juplo.cachecontrol.AcceleratorFilter.AccelerationWrapper;
 import de.halbekunst.juplo.cachecontrol.annotations.CacheSeconds;
 import de.halbekunst.juplo.cachecontrol.annotations.Accepts;
+import de.halbekunst.juplo.cachecontrol.annotations.AdditionalHeaders;
 import de.halbekunst.juplo.cachecontrol.annotations.LastModified;
 import de.halbekunst.juplo.cachecontrol.annotations.ETag;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
 import java.util.Date;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.TreeMap;
@@ -14,26 +17,30 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Component;
 
 /**
  *
  * @author kai
  */
+@Component
 public class CacheControl {
   private final static Logger log = LoggerFactory.getLogger(CacheControl.class);
 
   private static final ThreadLocal<CacheMethodHandle> tl = new ThreadLocal<CacheMethodHandle>();
 
-  private Integer defaultCacheSeconds;
-  private Long defaultLastModified;
+  @Autowired @Qualifier("cacheSeconds") private Integer defaultCacheSeconds;
+  @Autowired @Qualifier("lastModified") private Long defaultLastModified;
 
 
   public void init(CacheMethodHandle handle) {
     CacheControl.tl.set(handle);
   }
 
-  public void init(Object handler) throws NoSuchMethodException {
-    CacheControl.tl.set(new ReflectionCacheMethodHandle(handler));
+  void init(Object handler, AccelerationWrapper wrapper) throws NoSuchMethodException {
+    CacheControl.tl.set(new ReflectionCacheMethodHandle(handler, wrapper == null ? false : wrapper.zipped));
   }
 
   public boolean decorate(
@@ -43,10 +50,10 @@ public class CacheControl {
       )
   {
     try {
-    CacheMethodHandle controller = CacheControl.tl.get();
+    CacheMethodHandle handle = CacheControl.tl.get();
 
     /** Doppelte Ausführung verhindern... */
-    if (controller == null) {
+    if (handle == null) {
       /** Dekoration wurde bereits durchgeführt! */
       return true;
     }
@@ -56,10 +63,10 @@ public class CacheControl {
      * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18 RFC 2616,
      * Abschnitt 14.18} einen Date-Header enthalten
      */
-    response.setDateHeader(HeaderNames.HEADER_DATE, controller.getTimestamp());
+    response.setDateHeader(Headers.HEADER_DATE, handle.getTimestamp());
 
     /** Besondere Maßnahmen für besondere HTTP-Status-Codes ?!? */
-    int status = controller.accepts(request);
+    int status = handle.accepts(request);
     switch (status) {
       case HttpServletResponse.SC_OK: // 200
       case HttpServletResponse.SC_NO_CONTENT: // 204
@@ -96,6 +103,13 @@ public class CacheControl {
         return false;
     }
 
+    if (handle.isZipped())
+      response.addHeader(Headers.HEADER_CONTENT_ENCODING, "gzip");
+
+    Map<String,String> headers = handle.getAdditionalHeaders(request);
+    for (String name : headers.keySet())
+      response.addHeader(name, headers.get(name));
+
     String url = null;
     if (log.isDebugEnabled()) {
       if (request.getQueryString() == null) {
@@ -110,29 +124,29 @@ public class CacheControl {
       }
     }
 
-    int cacheSeconds = controller.getCacheSeconds(request);
+    int cacheSeconds = handle.getCacheSeconds(request);
     if (cacheSeconds < 1) {
       log.debug("{}: caching disabled!", url);
-      response.setDateHeader(HeaderNames.HEADER_DATE, controller.getTimestamp());
-      response.setDateHeader(HeaderNames.HEADER_EXPIRES, 0);
-      response.addHeader(HeaderNames.HEADER_PRAGMA, "no-cache");
-      response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "private");
-      response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "no-cache");
-      response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "no-store");
-      response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "max-age=0");
-      response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "s-max-age=0");
+      response.setDateHeader(Headers.HEADER_DATE, handle.getTimestamp());
+      response.setDateHeader(Headers.HEADER_EXPIRES, 0);
+      response.addHeader(Headers.HEADER_PRAGMA, "no-cache");
+      response.addHeader(Headers.HEADER_CACHE_CONTROL, "private");
+      response.addHeader(Headers.HEADER_CACHE_CONTROL, "no-cache");
+      response.addHeader(Headers.HEADER_CACHE_CONTROL, "no-store");
+      response.addHeader(Headers.HEADER_CACHE_CONTROL, "max-age=0");
+      response.addHeader(Headers.HEADER_CACHE_CONTROL, "s-max-age=0");
       return true;
     }
 
     long ifModifiedSince = -1;
     try {
-      ifModifiedSince = request.getDateHeader(HeaderNames.HEADER_IF_MODIFIED_SINCE);
+      ifModifiedSince = request.getDateHeader(Headers.HEADER_IF_MODIFIED_SINCE);
     }
     catch (Exception e) {
       log.error("Exception while fetching If-Modified-Since: {}", e);
     }
 
-    long lastModified = controller.getLastModified(request);
+    long lastModified = handle.getLastModified(request);
 
     /**
      * Sicherstellen, dass der Wert keine Millisekunden enthält, da die
@@ -141,8 +155,8 @@ public class CacheControl {
      */
     lastModified = lastModified - (lastModified % 1000);
 
-    String ifNoneMatch = request.getHeader(HeaderNames.HEADER_IF_NONE_MATCH);
-    String eTag = controller.getETag(request);
+    String ifNoneMatch = request.getHeader(Headers.HEADER_IF_NONE_MATCH);
+    String eTag = handle.getETag(request);
 
     /**
      * 304-Antworten sollen nach dem {@plainlink
@@ -152,12 +166,12 @@ public class CacheControl {
      */
     if (eTag != null) {
       StringBuilder builder = new StringBuilder();
-      if (controller.isETagWeak())
+      if (handle.isETagWeak())
         builder.append("W/");
       builder.append('"');
       builder.append(eTag);
       builder.append('"');
-      response.setHeader(HeaderNames.HEADER_ETAG, builder.toString());
+      response.setHeader(Headers.HEADER_ETAG, builder.toString());
     }
 
 
@@ -191,13 +205,13 @@ public class CacheControl {
         ifNoneMatch = ifNoneMatch.substring(1, ifNoneMatch.length() - 1);
       }
 
-      if (!weak || (request.getMethod().equals("GET") && request.getHeader(HeaderNames.HEADER_RANGE) == null)) {
+      if (!weak || (request.getMethod().equals("GET") && request.getHeader(Headers.HEADER_RANGE) == null)) {
         /**
          * Die Gleichheit gilt nur, wenn die ETag's der Anfrage _und_ der
          * Antwort stark sind (starke Gleichheit!), oder wenn die Antwort nur
          * schwache Gleichheit fordert...
          */
-        if (ifNoneMatch.equals(eTag) && (controller.isETagWeak() || !weak)) {
+        if (ifNoneMatch.equals(eTag) && (handle.isETagWeak() || !weak)) {
           log.debug("{}: ETag {} not changed -> 304 ", url, ifNoneMatch);
           response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
           return false;
@@ -212,7 +226,7 @@ public class CacheControl {
     log.debug("{}: first up!", url);
 
     /** HTTP/1.1-Caching-Header richtig setzen!! */
-    response.setDateHeader(HeaderNames.HEADER_LAST_MODIFIED, lastModified);
+    response.setDateHeader(Headers.HEADER_LAST_MODIFIED, lastModified);
 
     /** Cache-Control für HTTP/1.1-Clients generieren */
     Map<String, String> cacheControl = new TreeMap<String, String>();
@@ -235,11 +249,11 @@ public class CacheControl {
        * <code>Expires</code>-Header für HTTP/1.0-Clients setzen.
        */
       cacheControl.put("max-age", Integer.toString(cacheSeconds));
-      response.setDateHeader(HeaderNames.HEADER_EXPIRES, (controller.getTimestamp() + (long) cacheSeconds * 1000));
+      response.setDateHeader(Headers.HEADER_EXPIRES, (handle.getTimestamp() + (long) cacheSeconds * 1000));
     }
 
     /** Dem Handler die Gelegenheit geben, den Cache-Controll-Header anzupassen */
-    controller.cacheControl(request, cacheControl);
+    handle.cacheControl(request, cacheControl);
 
 
     if (cacheControl.containsKey("private")) {
@@ -251,8 +265,8 @@ public class CacheControl {
        * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32
        * Abschnitt 14.32})
        */
-      response.setDateHeader(HeaderNames.HEADER_EXPIRES, 0l);
-      response.addHeader(HeaderNames.HEADER_PRAGMA, "no-cache");
+      response.setDateHeader(Headers.HEADER_EXPIRES, 0l);
+      response.addHeader(Headers.HEADER_PRAGMA, "no-cache");
     }
 
     StringBuilder builder = new StringBuilder();
@@ -263,7 +277,7 @@ public class CacheControl {
         builder.append('=');
         builder.append(entry.getValue());
       }
-      response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, builder.toString());
+      response.addHeader(Headers.HEADER_CACHE_CONTROL, builder.toString());
     }
 
     return true;
@@ -283,17 +297,6 @@ public class CacheControl {
   }
 
 
-  public interface CacheMethodHandle {
-    long getTimestamp();
-    int accepts(HttpServletRequest request);
-    int getCacheSeconds(HttpServletRequest request);
-    long getLastModified(HttpServletRequest request);
-    String getETag(HttpServletRequest request);
-    boolean isETagWeak();
-    void cacheControl(HttpServletRequest request, Map<String, String> cacheControlMap);
-  }
-
-
   class ReflectionCacheMethodHandle implements CacheMethodHandle {
 
     private Object handler;
@@ -301,22 +304,27 @@ public class CacheControl {
     private Integer cacheSeconds;
     private Long lastModified;
     private String eTag;
+    private Map<String,String> additionalHeaders;
     private Method acceptsMethod;
     private Method cacheSecondsMethod;
     private Method lastModifiedMethod;
     private Method eTagMethod;
     private Method cacheControlMethod;
+    private Method additionalHeadersMethod;
     private boolean isAcceptsMethodDefined;
     private boolean isCacheSecondsMethodDefined;
     private boolean isLastModifiedMethodDefined;
     private boolean isETagMethodDefined;
     private boolean isCacheControlMethodDefined;
+    private boolean isAdditionalHeadersMethodDefined;
     private boolean weak;
+    private boolean zipped;
 
 
-    ReflectionCacheMethodHandle(Object handler) throws NoSuchMethodException {
+    ReflectionCacheMethodHandle(Object handler, boolean zipped) throws NoSuchMethodException {
 
       this.handler = handler;
+      this.zipped = zipped;
 
       cacheSeconds = CacheControl.this.defaultCacheSeconds;
       lastModified = CacheControl.this.defaultLastModified;
@@ -349,6 +357,23 @@ public class CacheControl {
           isETagMethodDefined = true;
           continue;
         }
+        if (annotation.annotationType().equals(AdditionalHeaders.class)) {
+          AdditionalHeaders additionalHeadersAnnotation = (AdditionalHeaders)annotation;
+          additionalHeaders = new HashMap<String,String>();
+          for (String header : additionalHeadersAnnotation.value()) {
+            int i = header.indexOf(':');
+            if (i < 0) {
+              log.error("invalid header: [{}]", header);
+            }
+            else {
+              String name = header.substring(0,i).trim();
+              String value = header.substring(i+1,header.length()).trim();
+              additionalHeaders.put(name, value);
+            }
+          }
+          isAdditionalHeadersMethodDefined = true;
+          continue;
+        }
       }
 
       /** Method-Level-Annotations auslesen */
@@ -390,11 +415,26 @@ public class CacheControl {
             isCacheControlMethodDefined = true;
             continue;
           }
+          if (annotation.annotationType().equals(AdditionalHeaders.class)) {
+            if (isAdditionalHeadersMethodDefined)
+              throw new IllegalArgumentException("Die Annotation @AdditionalHeaders wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
+            additionalHeadersMethod = method;
+            isAdditionalHeadersMethodDefined = true;
+            continue;
+          }
         }
       }
+
+      if (!isAdditionalHeadersMethodDefined)
+        additionalHeaders = new HashMap<String,String>();
     }
 
 
+    @Override
+    public boolean isZipped() {
+      return zipped;
+    }
+
     @Override
     public long getTimestamp() {
       return now;
@@ -481,14 +521,20 @@ public class CacheControl {
         }
       }
     }
-  }
-
-
-  public void setDefaultCacheSeconds(Integer defaultCacheSeconds) {
-    this.defaultCacheSeconds = defaultCacheSeconds;
-  }
 
-  public void setDefaultLastModified(Long defaultLastModified) {
-    this.defaultLastModified = defaultLastModified;
+    @Override
+    public Map<String,String> getAdditionalHeaders(HttpServletRequest request) throws IllegalArgumentException {
+      if (additionalHeadersMethod == null) {
+        return additionalHeaders;
+      }
+      else {
+        try {
+          return (Map<String,String>)additionalHeadersMethod.invoke(handler, request);
+        }
+        catch (Exception e) {
+          throw new IllegalArgumentException(e);
+        }
+      }
+    }
   }
 }