Merge pull request #4 from torden/dev/fix-broken-reponse-body

Dev/fix broken reponse body

Author: torden

.astylerc

@@ -0,0 +1,22 @@
+# astylerc
+align-pointer=name
+align-reference=name
+break-after-logical
+#indent=spaces=2
+max-code-length=120
+style=google
+suffix=none
+
+# Indent
+indent-preproc-block
+
+# Padding
+pad-header
+unpad-paren
+
+# Formatting:
+add-brackets
+#convert-tabs
+
+# Output:
+formatted

.format.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# Search in the script folder
+pushd "$(dirname $0)" >/dev/null
+CWD="$(pwd -P)"
+popd >/dev/null
+FILES='ngx_cache_purge_module.c'
+
+# The file format in accordance with the style defined in .astylerc
+astyle -v --options='.astylerc' ${FILES} || (echo 'astyle failed'; exit 1);
+
+# To correct this, the issuance dos2unix on each file
+# sometimes adds in Windows as a string-endins (\r\n).
+dos2unix --quiet ${FILES} || (echo 'dos2unix failed'; exit 2);

.gitattributes

@@ -0,0 +1 @@
+*.t linguist-language=Text

.travis.yml

@@ -0,0 +1,50 @@
+sudo: required
+os: linux
+dist: trusty
+language: c
+compiler:
+  - gcc
+  - clang
+cache:
+  apt: true
+  directories:
+    - download-cache
+env:
+  global:
+    - JOBS=4
+    - NGINX_VERSION=1.12.0
+    - NGINX_PREFIX=/opt/nginx
+    - OPENSSL_PREFIX=/opt/ssl
+    - OPENSSL_LIB=$OPENSSL_PREFIX/lib
+    - OPENSSL_INC=$OPENSSL_PREFIX/include
+    - OPENSSL_VER=1.0.2k
+
+before_install:
+  - sudo apt-get install -qq -y cpanminus
+
+install:
+  - if [ ! -d /opt ]; then mkdir /opt; fi
+  - if [ ! -d download-cache ]; then mkdir download-cache; fi
+  - if [ ! -f download-cache/nginx-$NGINX_VERSION.tar.gz ]; then wget -O download-cache/nginx-$NGINX_VERSION.tar.gz http://nginx.org/download/nginx-$NGINX_VERSION.tar.gz; fi
+  - if [ ! -f download-cache/openssl-$OPENSSL_VER.tar.gz ]; then wget -O download-cache/openssl-$OPENSSL_VER.tar.gz https://www.openssl.org/source/openssl-$OPENSSL_VER.tar.gz; fi
+  - git clone https://github.com/openresty/test-nginx.git
+
+script:
+  - cd test-nginx/ && sudo cpanm . && cd ..
+  - tar zxf download-cache/openssl-$OPENSSL_VER.tar.gz
+  - cd openssl-$OPENSSL_VER/
+  - ./config shared --prefix=$OPENSSL_PREFIX -DPURIFY > build.log 2>&1 || (cat build.log && exit 1)
+  - make -j$JOBS > build.log 2>&1 || (cat build.log && exit 1)
+  - sudo make PATH=$PATH install_sw > build.log 2>&1 || (cat build.log && exit 1)
+  - cd ..
+  - tar zxf download-cache/nginx-$NGINX_VERSION.tar.gz
+  - cd nginx-$NGINX_VERSION/
+  - ./configure --prefix=$NGINX_PREFIX --with-debug --add-module=$PWD/.. > build.log 2>&1 || (cat build.log && exit 1)
+  - make -j$JOBS > build.log 2>&1 || (cat build.log && exit 1)
+  - sudo make install > build.log 2>&1 || (cat build.log && exit 1)
+  - cd ..
+  - export PATH=$NGINX_PREFIX/sbin:$PATH
+#  - export LD_LIBRARY_PATH=$LD_LIBRARY_PATH
+  - nginx -V
+  - ldd `which nginx`
+  - prove t

CHANGES

@@ -1,3 +1,24 @@
+2017-02-21    VERSION 2.4.1
+    * Fix compatibility with nginx-1.11.6+, Sułowicz Paweł
+
+2016-11-20    VERSION 2.4
+    * Fix compatibility with nginx-1.7.12+.
+    * explain the purge logic
+    * feat(purge all): Include option to purge all the cached files
+      This option can be slow if a lot of content is cached, or if the
+      storage used for the cache is slow. But you really should be using
+      RAM as your cache storage.
+    * feat(partial keys): Support partial keys to purge multiple keys.
+      Put an '*' at the end of your purge cache URL.
+      e.g:
+          proxy_cache_key $scheme$host$uri$is_args$args$cookie_JSESSIONID;
+          curl -X PURGE https://example.com/pass*
+      This will remove every cached page whose key cache starting with:
+          httpsexample.com/pass*
+      Be careful not passing any value for the values after the $uri, or put
+      it at the end of your cache key.
+    * Convert a config file to build a dynamic module
+
 2014-12-23    VERSION 2.3
     * Fix compatibility with nginx-1.7.9+.
 

README.md

@@ -1,7 +1,8 @@
 About
 =====
 `ngx_cache_purge` is `nginx` module which adds ability to purge content from
-`FastCGI`, `proxy`, `SCGI` and `uWSGI` caches.
+`FastCGI`, `proxy`, `SCGI` and `uWSGI` caches. A purge operation removes the 
+content with the same cache key as the purge request has.
 
 
 Sponsors
@@ -18,7 +19,7 @@ Configuration directives (same location syntax)
 ===============================================
 fastcgi_cache_purge
 -------------------
-* **syntax**: `fastcgi_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]`
+* **syntax**: `fastcgi_cache_purge on|off|<method> [purge_all] [from all|<ip> [.. <ip>]]`
 * **default**: `none`
 * **context**: `http`, `server`, `location`
 
@@ -27,7 +28,7 @@ Allow purging of selected pages from `FastCGI`'s cache.
 
 proxy_cache_purge
 -----------------
-* **syntax**: `proxy_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]`
+* **syntax**: `proxy_cache_purge on|off|<method> [purge_all] [from all|<ip> [.. <ip>]]`
 * **default**: `none`
 * **context**: `http`, `server`, `location`
 
@@ -36,7 +37,7 @@ Allow purging of selected pages from `proxy`'s cache.
 
 scgi_cache_purge
 ----------------
-* **syntax**: `scgi_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]`
+* **syntax**: `scgi_cache_purge on|off|<method> [purge_all] [from all|<ip> [.. <ip>]]`
 * **default**: `none`
 * **context**: `http`, `server`, `location`
 
@@ -45,7 +46,7 @@ Allow purging of selected pages from `SCGI`'s cache.
 
 uwsgi_cache_purge
 -----------------
-* **syntax**: `uwsgi_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]`
+* **syntax**: `uwsgi_cache_purge on|off|<method> [purge_all] [from all|<ip> [.. <ip>]]`
 * **default**: `none`
 * **context**: `http`, `server`, `location`
 
@@ -89,6 +90,29 @@ uwsgi_cache_purge
 
 Sets area and key used for purging selected pages from `uWSGI`'s cache.
 
+Configuration directives (Optional)
+===================================================
+
+cache_purge_response_type
+-----------------
+* **syntax**: `cache_purge_response_type html|json|xml|text`
+* **default**: `html`
+* **context**: `http`, `server`, `location`
+
+Sets a response type of purging result.
+
+
+
+Partial Keys
+============
+Sometimes it's not possible to pass the exact key cache to purge a page. For example; when the content of a cookie or the params are part of the key.
+You can specify a partial key adding an asterisk at the end of the URL.
+
+    curl -X PURGE /page*
+
+The asterisk must be the last character of the key, so you **must** put the $uri variable at the end.
+
+
 
 Sample configuration (same location syntax)
 ===========================================
@@ -106,6 +130,22 @@ Sample configuration (same location syntax)
     }
 
 
+Sample configuration (same location syntax - purge all cached files)
+====================================================================
+    http {
+        proxy_cache_path  /tmp/cache  keys_zone=tmpcache:10m;
+
+        server {
+            location / {
+                proxy_pass         http://127.0.0.1:8000;
+                proxy_cache        tmpcache;
+                proxy_cache_key    $uri$is_args$args;
+                proxy_cache_purge  PURGE purge_all from 127.0.0.1;
+            }
+        }
+    }
+
+
 Sample configuration (separate location syntax)
 ===============================================
     http {
@@ -126,6 +166,61 @@ Sample configuration (separate location syntax)
         }
     }
 
+Sample configuration (Optional)
+===============================================
+    http {
+        proxy_cache_path  /tmp/cache  keys_zone=tmpcache:10m;
+
+        cache_purge_response_type text;
+
+        server {
+
+            cache_purge_response_type json;
+
+            location / { #json
+                proxy_pass         http://127.0.0.1:8000;
+                proxy_cache        tmpcache;
+                proxy_cache_key    $uri$is_args$args;
+            }
+
+            location ~ /purge(/.*) { #xml
+                allow              127.0.0.1;
+                deny               all;
+                proxy_cache_purge  tmpcache $1$is_args$args;
+                cache_purge_response_type xml;
+            }
+
+            location ~ /purge2(/.*) { # json
+                allow              127.0.0.1;
+                deny               all;
+                proxy_cache_purge  tmpcache $1$is_args$args;
+            }
+        }
+
+        server {
+
+            location / { #text
+                proxy_pass         http://127.0.0.1:8000;
+                proxy_cache        tmpcache;
+                proxy_cache_key    $uri$is_args$args;
+            }
+
+            location ~ /purge(/.*) { #text
+                allow              127.0.0.1;
+                deny               all;
+                proxy_cache_purge  tmpcache $1$is_args$args;
+            }
+
+            location ~ /purge2(/.*) { #html
+                allow              127.0.0.1;
+                deny               all;
+                proxy_cache_purge  tmpcache $1$is_args$args;
+                cache_purge_response_type html;
+            }
+        }
+    }
+
+
 
 Testing
 =======

config

@@ -15,7 +15,17 @@ if [ "$HTTP_UWSGI" = "YES" ]; then
 fi
 
 ngx_addon_name=ngx_http_cache_purge_module
-HTTP_MODULES="$HTTP_MODULES ngx_http_cache_purge_module"
-NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_cache_purge_module.c"
+CACHE_PURGE_SRCS="$ngx_addon_dir/ngx_cache_purge_module.c"
+
+if [ -n "$ngx_module_link" ]; then
+    ngx_module_type=HTTP
+    ngx_module_name="$ngx_addon_name"
+    ngx_module_srcs="$CACHE_PURGE_SRCS"
+
+    . auto/module
+else
+    HTTP_MODULES="$HTTP_MODULES $ngx_addon_name"
+    NGX_ADDON_SRCS="$NGX_ADDON_SRCS $CACHE_PURGE_SRCS"
+fi
 
 have=NGX_CACHE_PURGE_MODULE . auto/have