Injection-Annotations in AcceleratorFilter ergänzt
[percentcodec] / cachecontrol / src / main / java / de / halbekunst / juplo / cachecontrol / AcceleratorFilter.java
index 992d9dc..71c799c 100644 (file)
@@ -2,6 +2,7 @@ package de.halbekunst.juplo.cachecontrol;
 
 import java.io.IOException;
 import java.io.OutputStream;
+import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
@@ -18,14 +19,15 @@ import javax.servlet.ServletException;
 import javax.servlet.ServletOutputStream;
 import javax.servlet.ServletRequest;
 import javax.servlet.ServletResponse;
+import javax.servlet.http.Cookie;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
-import javax.servlet.http.HttpServletResponseWrapper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowire;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Configurable;
+import org.springframework.beans.factory.annotation.Qualifier;
 
 
 
@@ -39,16 +41,17 @@ public class AcceleratorFilter implements Filter {
 
   private final static Map<String,String> EMPTY = Collections.unmodifiableMap(new HashMap<String,String>());
 
+  public final static Integer DEFAULT_BUFFER_SIZE = 1024;
   public final static String REQUEST_URI_ATTRIBUTE = "javax.servlet.include.request_uri";
   public final static String RESPONSE_WRAPPER = AcceleratorFilter.class.getName() + ".RESPONSE_WRAPPER";
 
 
   @Autowired CacheControl cacheControl;
-  @Autowired(required=true) Integer buffer;
-  @Autowired(required=true) String eTag;
-  @Autowired(required=true) Boolean weak;
-  @Autowired(required=true) Long lastModified;
-  @Autowired(required=true) Integer cacheSeconds;
+  @Autowired(required=false) @Qualifier("defaultBufferSize") Integer defaultBufferSize = DEFAULT_BUFFER_SIZE;
+  @Autowired String eTag;
+  @Autowired Boolean weak;
+  @Autowired Long lastModified;
+  @Autowired Integer cacheSeconds;
 
 
   @Override
@@ -59,6 +62,7 @@ public class AcceleratorFilter implements Filter {
       return;
     }
 
+    // TODO: Das macht so wahrscheinlich keinen Sinn...
     /** Prüfen, ob es sich um eine Anfrage für einen JSP-Include handelt */
     if (request.getAttribute(REQUEST_URI_ATTRIBUTE) != null) {
       log.debug("Includes cannot be accelerated");
@@ -72,8 +76,6 @@ public class AcceleratorFilter implements Filter {
     httpRequest.setAttribute(RESPONSE_WRAPPER, wrapper);
     cacheControl.init(wrapper);
     chain.doFilter(request, wrapper);
-    /** Dekoration auslösen, falls sie bisher nicht ausgelöst wurde... */
-    cacheControl.decorate(httpRequest, httpResponse, wrapper);
     wrapper.finish();
   }
 
@@ -86,19 +88,18 @@ public class AcceleratorFilter implements Filter {
   }
 
 
-  class AccelerationWrapper extends HttpServletResponseWrapper implements CacheMethodHandle {
+  class AccelerationWrapper implements HttpServletResponse, CacheMethodHandle {
 
     private final HttpServletRequest request;
     private final HttpServletResponse response;
 
-    boolean zipped; // CacheControll greift direkt auf dieses Flag zu!
+    private final AcceleratorServletOutputStream out;
 
-    private int buffer;
-    private GZIPServletOutputStream out;
     private ServletOutputStream stream;
     private PrintWriter writer;
 
     private boolean guessing = true;
+    protected boolean zipped = false; // << CacheControll greift direkt auf diese Variable zu!
 
     private long now;
     private int status;
@@ -109,9 +110,17 @@ public class AcceleratorFilter implements Filter {
     private boolean weak;
     private Map<String,String> cacheParams;
 
+    /** Für den AcceleratorOutputStream */
+    private boolean committed = false;
+    private OutputStream os = null;
+    private int bufferSize;
+    private byte[] buffer;
+    private int pos = 0;
+    private int size = 0;
+
+
 
     AccelerationWrapper(HttpServletRequest request, HttpServletResponse response) throws IOException {
-      super(response);
 
       this.request = request;
       this.response = response;
@@ -124,8 +133,6 @@ public class AcceleratorFilter implements Filter {
       weak = AcceleratorFilter.this.weak;
       cacheParams = new HashMap<String,String>();
 
-      buffer = AcceleratorFilter.this.buffer;
-      zipped = false;
       Enumeration values = request.getHeaders(Headers.HEADER_ACCEPT_ENCODING);
       while (values.hasMoreElements()) {
         String value = (String) values.nextElement();
@@ -134,44 +141,33 @@ public class AcceleratorFilter implements Filter {
           break;
         }
       }
+
+      out = new AcceleratorServletOutputStream();
     }
 
 
-    public void finish() throws IOException {
-      if (zipped && out != null)
-        out.zout.finish();
+    private void finish() throws IOException {
+      flushBuffer();
+      out.close();
     }
 
-
     @Override
     public void setStatus(int sc) {
       response.setStatus(sc);
       status = sc;
-      try {
-        cacheControl.decorate(request, response, this);
-      }
-      catch (Exception e) {
-        log.error("Error while decorating response", e);
-      }
     }
 
     @Override
     public void setStatus(int sc, String sm) {
       response.setStatus(sc,sm);
       status = sc;
-      try {
-        cacheControl.decorate(request, response, this);
-      }
-      catch (Exception e) {
-        log.error("Error while decorating response", e);
-      }
     }
 
     @Override
     public void addDateHeader(String name, long value) {
 
       if (!guessing) {
-        super.addDateHeader(name, value);
+        response.addDateHeader(name, value);
         return;
       }
 
@@ -193,14 +189,14 @@ public class AcceleratorFilter implements Filter {
       }
 
       /** Unknown header: pass throug! */
-      super.addDateHeader(name, value);
+      response.addDateHeader(name, value);
     }
 
     @Override
     public void addHeader(String name, String value) {
 
       if (!guessing) {
-        super.addHeader(name, value);
+        response.addHeader(name, value);
         return;
       }
 
@@ -213,7 +209,7 @@ public class AcceleratorFilter implements Filter {
     public void addIntHeader(String name, int value) {
 
       if (!guessing) {
-        super.addIntHeader(name, value);
+        response.addIntHeader(name, value);
         return;
       }
 
@@ -224,7 +220,7 @@ public class AcceleratorFilter implements Filter {
     public void setDateHeader(String name, long value) {
 
       if (!guessing) {
-        super.setDateHeader(name, value);
+        response.setDateHeader(name, value);
         return;
       }
 
@@ -246,14 +242,14 @@ public class AcceleratorFilter implements Filter {
       }
 
       /** Unknown header: pass throug! */
-      super.setDateHeader(name, value);
+      response.setDateHeader(name, value);
     }
 
     @Override
     public void setHeader(String name, String value) {
 
       if (!guessing) {
-        super.setHeader(name, value);
+        response.setHeader(name, value);
         return;
       }
 
@@ -264,7 +260,7 @@ public class AcceleratorFilter implements Filter {
     public void setIntHeader(String name, int value) {
 
       if (!guessing) {
-        super.setIntHeader(name, value);
+        response.setIntHeader(name, value);
         return;
       }
 
@@ -278,7 +274,6 @@ public class AcceleratorFilter implements Filter {
         throw new IllegalStateException("ServletOutputStream and PrintWriter cannot be requested both!");
 
       if (stream == null) {
-        out = new GZIPServletOutputStream();
         stream = out;
       }
 
@@ -292,8 +287,7 @@ public class AcceleratorFilter implements Filter {
         throw new IllegalStateException("ServletOutputStream and PrintWriter cannot be requested both!");
 
       if (writer == null) {
-        out = new GZIPServletOutputStream();
-        writer = new PrintWriter(out);
+        writer = new PrintWriter(new OutputStreamWriter(out, response.getCharacterEncoding()));
       }
 
       return writer;
@@ -308,52 +302,140 @@ public class AcceleratorFilter implements Filter {
     }
 
     @Override
-    public void setBufferSize(int size) {
-
-      if (out != null && this.buffer != out.left)
-        throw new IllegalStateException("setBufferSize() cannot be called after content has been written!");
-
-      if (size < 0)
-        size = 0;
-
-      this.buffer = size;
-      if (out != null)
-        out.left = size;
-      response.setBufferSize(size);
+    public int getBufferSize() {
+      return bufferSize;
     }
 
     @Override
-    public void flushBuffer() throws IOException {
-
-      cacheControl.decorate(request, response, this);
-      response.flushBuffer();
+    public void setBufferSize(int size) {
+      if (this.size > 0)
+        throw new IllegalStateException("cannot change buffer size, because content was already written!");
+      bufferSize = size;
+      buffer = new byte[size];
     }
 
     @Override
     public void resetBuffer() {
-
-      response.resetBuffer();
+      if (committed)
+        throw new IllegalStateException("cannot reset buffer, because response is already commited!");
+      pos = 0;
       stream = null;
       writer = null;
     }
 
     @Override
     public void reset() {
-
+      if (committed)
+        throw new IllegalStateException("cannot reset response, because response is already commited!");
+      /**
+       * Da committed==false gilt, wurde die Dekoration noch nicht angestßen
+       * und muss entsprechend auch nicht rückgängig gemacht werden!
+       */
       response.reset();
-      out = null;
+      pos = 0;
       stream = null;
       writer = null;
+    }
+
+    @Override
+    public void flushBuffer() throws IOException {
+      if (writer != null)
+        writer.flush();
+      else if (stream != null)
+        stream.flush();
+
+      out.flush();
+    }
+
+    @Override
+    public void addCookie(Cookie cookie) {
+      // TODO: Je nach Vary-Einstellung ETag anpassen?
+      response.addCookie(cookie);
+    }
+
+    @Override
+    public boolean containsHeader(String name) {
+      return response.containsHeader(name);
+    }
+
+    @Override
+    public String encodeURL(String url) {
+      return response.encodeURL(url);
+    }
+
+    @Override
+    public String encodeRedirectURL(String url) {
+      return response.encodeRedirectURL(url);
+    }
+
+    @Override
+    public String encodeUrl(String url) {
+      return response.encodeUrl(url);
+    }
+
+    @Override
+    public String encodeRedirectUrl(String url) {
+      return response.encodeRedirectUrl(url);
+    }
+
+    @Override
+    public void sendError(int sc, String msg) throws IOException {
+      response.sendError(sc,msg);
+    }
 
-      /** Cookies has been cleared! Reinitialize decorator... */
-      cacheControl.init(this);
+    @Override
+    public void sendError(int sc) throws IOException {
+      response.sendError(sc);
+    }
+
+    @Override
+    public void sendRedirect(String location) throws IOException {
+      response.sendRedirect(location);
+    }
+
+    @Override
+    public String getCharacterEncoding() {
+      return response.getCharacterEncoding();
+    }
+
+    @Override
+    public String getContentType() {
+      return response.getContentType();
+    }
+
+    @Override
+    public void setCharacterEncoding(String charset) {
+      // TODO: Je nach Vary-Einstellung ETag anpassen?
+      response.setCharacterEncoding(charset);
+    }
+
+    @Override
+    public void setContentType(String type) {
+      // TODO: Je nach Vary-Einstellung ETag anpassen?
+      response.setContentType(type);
+    }
+
+    @Override
+    public boolean isCommitted() {
+      return committed;
+    }
+
+    @Override
+    public void setLocale(Locale loc) {
+      // TODO: Je nach Vary-Einstellung ETag anpassen?
+      response.setLocale(loc);
+    }
+
+    @Override
+    public Locale getLocale() {
+      return getLocale();
     }
 
 
 
     @Override
     public boolean isZipped() {
-      return zipped && out != null && !out.empty;
+      return zipped;
     }
 
     @Override
@@ -532,9 +614,9 @@ public class AcceleratorFilter implements Filter {
 
       /** Pass header through, if no value from intrest was found */
       if (overwrite)
-        super.setHeader(name, value);
+        response.setHeader(name, value);
       else
-        super.addHeader(name, value);
+        response.addHeader(name, value);
     }
 
     private void calculateCacheSeconds() {
@@ -545,69 +627,60 @@ public class AcceleratorFilter implements Filter {
     }
 
 
-    class GZIPServletOutputStream extends ServletOutputStream {
+    private class AcceleratorServletOutputStream extends ServletOutputStream  {
 
-      private final OutputStream out;
-      private final GZIPOutputStream zout;
-      int left;
-      boolean empty;
+      private final ServletOutputStream sos;
 
-      public GZIPServletOutputStream() throws IOException {
-        if (zipped) {
-          this.zout = new GZIPOutputStream(response.getOutputStream(), buffer);
-          this.out = this.zout;
-        }
-        else {
-          this.zout = null;
-          this.out = response.getOutputStream();
-        }
-        empty = true;
-        left = buffer;
+
+      private AcceleratorServletOutputStream() throws IOException {
+        bufferSize = defaultBufferSize;
+        buffer = new byte[bufferSize];
+        sos = AccelerationWrapper.this.response.getOutputStream();
       }
 
 
+      private OutputStream out() throws IOException {
+        if (os == null)
+          os = zipped ? new GZIPOutputStream(sos) : sos;
+        return os;
+      }
+
       @Override
-      public void close() throws IOException {
-        try {
-          AcceleratorFilter.this.cacheControl.decorate(AccelerationWrapper.this.request, response, buffer);
-        }
-        catch (Exception e) {
-          log.error("Error while guessing Cache-Header's", e);
-          response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
+      public void write(int i) throws IOException {
+        if (pos == bufferSize) {
+          out().write(buffer);
+          pos = 0;
+          committed = true;
+          cacheControl.decorate(request, response, this);
         }
-
-        if (!empty && zout != null)
-          zout.finish();
-        out.close();
+        buffer[pos++] = (byte) i;
+        size++;
       }
 
       @Override
       public void flush() throws IOException {
-        try {
-          AcceleratorFilter.this.cacheControl.decorate(AccelerationWrapper.this.request, response, buffer);
-        }
-        catch (Exception e) {
-          log.error("Error while guessing Cache-Header's", e);
-          response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
-        }
+        if (pos == 0)
+          return;
 
-        out.flush();
+        committed = true;
+        cacheControl.decorate(request, response, this);
+        out().write(buffer, 0, pos);
+        out().flush();
+        pos = 0;
       }
 
       @Override
-      public void write(int i) throws IOException {
-        if (left == 0) {
-          try {
-            AcceleratorFilter.this.cacheControl.decorate(AccelerationWrapper.this.request, response, buffer);
-          }
-          catch (Exception e) {
-            log.error("Error while guessing Cache-Header's", e);
-            response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
-          }
+      public void close() throws IOException {
+        if (size == 0) {
+          committed = true;
+          zipped = false;
+          cacheControl.decorate(request, response, this);
+          sos.close();
+        }
+        else {
+          flush();
+          out().close();
         }
-        empty = false;
-        left--;
-        out.write(i);
       }
     }
   }