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

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 0d79436e..19a60b51 100644
--- a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java
+++ b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java
@@ -5,7 +5,6 @@ import de.halbekunst.juplo.cachecontrol.annotations.Accepts;
 import de.halbekunst.juplo.cachecontrol.annotations.LastModified;
 import de.halbekunst.juplo.cachecontrol.annotations.ETag;
 import java.lang.annotation.Annotation;
-import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.util.Date;
 import java.util.Map;
@@ -23,31 +22,25 @@ import org.slf4j.LoggerFactory;
 public class CacheControl {
   private final static Logger log = LoggerFactory.getLogger(CacheControl.class);
 
-  public static final String HEADER_DATE = "Date";
-  public static final String HEADER_CACHE_CONTROL = "Cache-Control";
-  public static final String HEADER_LAST_MODIFIED = "Last-Modified";
-  public static final String HEADER_ETAG = "ETag";
-  public static final String HEADER_EXPIRES = "Expires";
-  public static final String HEADER_PRAGMA = "Pragma";
-  public static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since";
-  public static final String HEADER_IF_NONE_MATCH = "If-None-Match";
-
   private static final ThreadLocal<CacheMethodHandle> tl = new ThreadLocal<CacheMethodHandle>();
 
   private Integer defaultCacheSeconds;
   private Long defaultLastModified;
 
 
-  public void init(Object handler) throws Exception {
-    if (CacheControl.tl.get() == null)
-      CacheControl.tl.set(new ReflectionCacheMethodHandle(handler));
+  public void init(CacheMethodHandle handle) {
+    CacheControl.tl.set(handle);
+  }
+
+  public void init(Object handler) throws NoSuchMethodException {
+    CacheControl.tl.set(new ReflectionCacheMethodHandle(handler));
   }
 
   public boolean decorate(
       HttpServletRequest request,
       HttpServletResponse response,
       Object handler
-      ) throws Exception
+      )
   {
     try {
     CacheMethodHandle controller = CacheControl.tl.get();
@@ -63,7 +56,7 @@ 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(HEADER_DATE, controller.getTimestamp());
+    response.setDateHeader(HeaderNames.HEADER_DATE, controller.getTimestamp());
 
     /** Besondere Maßnahmen für besondere HTTP-Status-Codes ?!? */
     int status = controller.accepts(request);
@@ -94,11 +87,6 @@ public class CacheControl {
       case HttpServletResponse.SC_NOT_IMPLEMENTED: // 501
       case HttpServletResponse.SC_SERVICE_UNAVAILABLE: // 503
       case HttpServletResponse.SC_HTTP_VERSION_NOT_SUPPORTED: // 505
-        /**
-         * Ein Fehlercode kann stellvertretend für den Handler gesendet werden,
-         * da im Fehlerfall eh keine weiteren Daten ausgegeben werden!
-         */
-        response.sendError(status);
         return true;
       default:
         /**
@@ -125,20 +113,20 @@ public class CacheControl {
     int cacheSeconds = controller.getCacheSeconds(request);
     if (cacheSeconds < 1) {
       log.debug("{}: caching disabled!", url);
-      response.setDateHeader(HEADER_DATE, controller.getTimestamp());
-      response.setDateHeader(HEADER_EXPIRES, 0);
-      response.addHeader(HEADER_PRAGMA, "no-cache");
-      response.addHeader(HEADER_CACHE_CONTROL, "private");
-      response.addHeader(HEADER_CACHE_CONTROL, "no-cache");
-      response.addHeader(HEADER_CACHE_CONTROL, "no-store");
-      response.addHeader(HEADER_CACHE_CONTROL, "max-age=0");
-      response.addHeader(HEADER_CACHE_CONTROL, "s-max-age=0");
+      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");
       return true;
     }
 
     long ifModifiedSince = -1;
     try {
-      ifModifiedSince = request.getDateHeader(HEADER_IF_MODIFIED_SINCE);
+      ifModifiedSince = request.getDateHeader(HeaderNames.HEADER_IF_MODIFIED_SINCE);
     }
     catch (Exception e) {
       log.error("Exception while fetching If-Modified-Since: {}", e);
@@ -153,7 +141,7 @@ public class CacheControl {
      */
     lastModified = lastModified - (lastModified % 1000);
 
-    String ifNoneMatch = request.getHeader(HEADER_IF_NONE_MATCH);
+    String ifNoneMatch = request.getHeader(HeaderNames.HEADER_IF_NONE_MATCH);
     String eTag = controller.getETag(request);
 
     /**
@@ -162,8 +150,15 @@ public class CacheControl {
      * 2616, Abschnitt 10.3.5} einen ETag-Header enthalten, wenn auch die
      * 200-Antwort einen enthalten hätte.
      */
-    if (eTag != null)
-      response.setHeader(HEADER_ETAG, eTag);
+    if (eTag != null) {
+      StringBuilder builder = new StringBuilder();
+      if (controller.isETagWeak())
+        builder.append("W/");
+      builder.append('"');
+      builder.append(eTag);
+      builder.append('"');
+      response.setHeader(HeaderNames.HEADER_ETAG, builder.toString());
+    }
 
 
     if (ifModifiedSince >= lastModified && lastModified > 0) {
@@ -186,17 +181,38 @@ public class CacheControl {
       }
     }
 
-    if (ifNoneMatch != null && ifNoneMatch.equals(eTag)) {
-      log.debug("{}: ETag {} not changed -> 304 ", url, ifNoneMatch);
-      response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
-      return false;
+    if (ifNoneMatch != null) {
+      boolean weak = false;
+      if (ifNoneMatch.startsWith("W/")) {
+        weak = true;
+        ifNoneMatch = ifNoneMatch.substring(3, ifNoneMatch.length() - 1);
+      }
+      else {
+        ifNoneMatch = ifNoneMatch.substring(1, ifNoneMatch.length() - 1);
+      }
+
+      if (!weak || (request.getMethod().equals("GET") && request.getHeader(HeaderNames.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)) {
+          log.debug("{}: ETag {} not changed -> 304 ", url, ifNoneMatch);
+          response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
+          return false;
+        }
+      }
+      else {
+        log.warn("{}: ignoring weak ETag W/\"{}\", because the request was no GET-request or the Range-Header was present!", url, ifNoneMatch);
+      }
     }
 
 
     log.debug("{}: first up!", url);
 
     /** HTTP/1.1-Caching-Header richtig setzen!! */
-    response.setDateHeader(HEADER_LAST_MODIFIED, lastModified);
+    response.setDateHeader(HeaderNames.HEADER_LAST_MODIFIED, lastModified);
 
     /** Cache-Control für HTTP/1.1-Clients generieren */
     Map<String, String> cacheControl = new TreeMap<String, String>();
@@ -219,7 +235,7 @@ public class CacheControl {
        * <code>Expires</code>-Header für HTTP/1.0-Clients setzen.
        */
       cacheControl.put("max-age", Integer.toString(cacheSeconds));
-      response.setDateHeader(HEADER_EXPIRES, (controller.getTimestamp() + (long) cacheSeconds * 1000));
+      response.setDateHeader(HeaderNames.HEADER_EXPIRES, (controller.getTimestamp() + (long) cacheSeconds * 1000));
     }
 
     /** Dem Handler die Gelegenheit geben, den Cache-Controll-Header anzupassen */
@@ -235,8 +251,8 @@ public class CacheControl {
        * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32
        * Abschnitt 14.32})
        */
-      response.setDateHeader(HEADER_EXPIRES, 0l);
-      response.addHeader(HEADER_PRAGMA, "no-cache");
+      response.setDateHeader(HeaderNames.HEADER_EXPIRES, 0l);
+      response.addHeader(HeaderNames.HEADER_PRAGMA, "no-cache");
     }
 
     StringBuilder builder = new StringBuilder();
@@ -247,7 +263,7 @@ public class CacheControl {
         builder.append('=');
         builder.append(entry.getValue());
       }
-      response.addHeader(HEADER_CACHE_CONTROL, builder.toString());
+      response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, builder.toString());
     }
 
     return true;
@@ -267,13 +283,14 @@ public class CacheControl {
   }
 
 
-  interface CacheMethodHandle {
+  public interface CacheMethodHandle {
     long getTimestamp();
-    int accepts(HttpServletRequest request) throws Exception;
-    int getCacheSeconds(HttpServletRequest request) throws Exception;
-    long getLastModified(HttpServletRequest request) throws Exception;
-    String getETag(HttpServletRequest request) throws Exception;
-    void cacheControl(HttpServletRequest request, Map<String, String> cacheControlMap) throws Exception;
+    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);
   }
 
 
@@ -294,6 +311,7 @@ public class CacheControl {
     private boolean isLastModifiedMethodDefined;
     private boolean isETagMethodDefined;
     private boolean isCacheControlMethodDefined;
+    private boolean weak;
 
 
     ReflectionCacheMethodHandle(Object handler) throws NoSuchMethodException {
@@ -302,7 +320,7 @@ public class CacheControl {
 
       cacheSeconds = CacheControl.this.defaultCacheSeconds;
       lastModified = CacheControl.this.defaultLastModified;
-      eTag = null;
+      eTag = "";
 
       /** Class-Level-Annotations auslesen */
       for (Annotation annotation : handler.getClass().getAnnotations()) {
@@ -325,7 +343,9 @@ public class CacheControl {
           continue;
         }
         if (annotation.annotationType().equals(ETag.class)) {
-          eTag = ((ETag)annotation).value();
+          ETag eTagAnnotation = (ETag)annotation;
+          eTag = eTagAnnotation.value();
+          weak = eTagAnnotation.weak();
           isETagMethodDefined = true;
           continue;
         }
@@ -359,6 +379,7 @@ public class CacheControl {
             if (isETagMethodDefined)
               throw new IllegalArgumentException("Die Annotation @ETag wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
             eTagMethod = method;
+            weak = ((ETag)annotation).weak();
             isETagMethodDefined = true;
             continue;
           }
@@ -380,51 +401,68 @@ public class CacheControl {
     }
 
     @Override
-    public int accepts(HttpServletRequest request)
-        throws IllegalAccessException,
-               IllegalArgumentException,
-               InvocationTargetException
-    {
-      if (acceptsMethod == null)
+    public int accepts(HttpServletRequest request) throws IllegalArgumentException {
+      if (acceptsMethod == null) {
         return HttpServletResponse.SC_OK;
-      else
-        return (Integer)acceptsMethod.invoke(handler, request);
+      }
+      else {
+        try {
+          return (Integer)acceptsMethod.invoke(handler, request);
+        }
+        catch (Exception e) {
+          throw new IllegalArgumentException(e);
+        }
+      }
     }
 
     @Override
-    public int getCacheSeconds(HttpServletRequest request)
-        throws IllegalAccessException,
-               IllegalArgumentException,
-               InvocationTargetException
-    {
-      if (cacheSecondsMethod == null)
+    public int getCacheSeconds(HttpServletRequest request) throws IllegalArgumentException {
+      if (cacheSecondsMethod == null) {
         return cacheSeconds;
-      else
-        return (Integer)cacheSecondsMethod.invoke(handler, request);
+      }
+      else {
+        try {
+          return (Integer)cacheSecondsMethod.invoke(handler, request);
+        }
+        catch (Exception e) {
+          throw new IllegalArgumentException(e);
+        }
+      }
     }
 
     @Override
-    public long getLastModified(HttpServletRequest request)
-        throws IllegalAccessException,
-               IllegalArgumentException,
-               InvocationTargetException
-    {
-      if (lastModifiedMethod == null)
+    public long getLastModified(HttpServletRequest request) throws IllegalArgumentException {
+      if (lastModifiedMethod == null) {
         return lastModified;
-      else
-        return (Long)lastModifiedMethod.invoke(handler, request);
+      }
+      else {
+        try {
+          return (Long)lastModifiedMethod.invoke(handler, request);
+        }
+        catch (Exception e) {
+          throw new IllegalArgumentException(e);
+        }
+      }
     }
 
     @Override
-    public String getETag(HttpServletRequest request)
-        throws IllegalAccessException,
-               IllegalArgumentException,
-               InvocationTargetException
-    {
-      if (eTagMethod == null)
+    public String getETag(HttpServletRequest request) throws IllegalArgumentException {
+      if (eTagMethod == null) {
         return eTag;
-      else
-        return (String)eTagMethod.invoke(handler, request);
+      }
+      else {
+        try {
+          return (String)eTagMethod.invoke(handler, request);
+        }
+        catch (Exception e) {
+          throw new IllegalArgumentException(e);
+        }
+      }
+    }
+
+    @Override
+    public boolean isETagWeak() {
+      return weak;
     }
 
     @Override
@@ -432,12 +470,16 @@ public class CacheControl {
         HttpServletRequest request,
         Map<String, String> cacheControlMap
         )
-        throws IllegalAccessException,
-               IllegalArgumentException,
-               InvocationTargetException
+        throws IllegalArgumentException
     {
-      if (cacheControlMethod != null)
-        cacheControlMethod.invoke(handler, request, cacheControlMap);
+      if (cacheControlMethod != null) {
+        try {
+          cacheControlMethod.invoke(handler, request, cacheControlMap);
+        }
+        catch (Exception e) {
+          throw new IllegalArgumentException(e);
+        }
+      }
     }
   }