Fix glob in exclude check.

README.md

@@ -1,5 +1,5 @@
 # nginx-cache-purge
-A tool to help purge Nginx cache. It can either run locally with the purge command, or run as a local unix service to allow for purging by Nginx http requests.
+A tool to help purge Nginx cache. It can either run locally with the purge command, or run as a local unix service to allow for purging by Nginx http requests. The tool supports using wildcard/glob syntax in the purge key to match multiple keys from the cache.
 
 ## Install
 You can install either by downloading the latest binary release, or by building.
@@ -10,6 +10,29 @@ Building should be as simple as running:
 go build
 ```
 
+## Usage
+The following are some examples of ways to purge cache 
+
+### Purge a specific key
+```
+$ nginx-cache-purge purge /var/nginx/proxy_temp/cache example.com/index.html
+```
+
+### Purge all keys for a domain
+```
+$ nginx-cache-purge purge /var/nginx/proxy_temp/cache 'example.com/*'
+```
+
+### Purge all keys for jpeg and png files
+```
+$ nginx-cache-purge purge /var/nginx/proxy_temp/cache 'example.com/*.{jpg,jpeg,png}'
+```
+
+### Purge all keys
+```
+$ nginx-cache-purge purge /var/nginx/proxy_temp/cache '*'
+```
+
 ## Running as a service
 If you want to run as a service to allow purge requests via http requests, you'll need to create a systemd service file and place it in `/etc/systemd/system/nginx-cache-purge.service`.
 ```
@@ -21,7 +44,6 @@ After=network.target
 User=nginx
 Group=nginx
 RuntimeDirectory=nginx-cache-purge
-PIDFile=/var/run/nginx-cache-purge/service.pid
 ExecStart=/usr/local/bin/nginx-cache-purge server
 Restart=always
 RestartSec=3s
@@ -48,13 +70,14 @@ http {
     }
 
     proxy_cache_path /var/nginx/proxy_temp/cache levels=1:2 keys_zone=my_cache:10m;
-    proxy_cache_key $host$request_uri;
+    proxy_cache_key $server_name$request_uri;
 
     server {
         location / {
+            proxy_cache_bypass $is_purge;
             if ($is_purge) {
-                proxy_pass http://unix:/var/run/nginx-cache-purge/http.sock;
+                proxy_pass http://unix:/run/nginx-cache-purge/http.sock;
-                rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$host$request_uri break;
+                rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$server_name$request_uri break;
             }
 
             proxy_cache my_cache;
@@ -73,13 +96,14 @@ http {
     }
 
     proxy_cache_path /var/nginx/proxy_temp/cache levels=1:2 keys_zone=my_cache:10m;
-    proxy_cache_key $host$request_uri;
+    proxy_cache_key $server_name$request_uri;
 
     server {
         location / {
+            proxy_cache_bypass $is_purge;
             if ($is_purge) {
-                proxy_pass http://unix:/var/run/nginx-cache-purge/http.sock;
+                proxy_pass http://unix:/run/nginx-cache-purge/http.sock;
-                rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$host$request_uri break;
+                rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$server_name$request_uri break;
             }
 
             proxy_cache my_cache;
@@ -98,13 +122,50 @@ http {
     }
 
     proxy_cache_path /var/nginx/proxy_temp/cache levels=1:2 keys_zone=my_cache:10m;
-    proxy_cache_key $host$request_uri;
+    proxy_cache_key $server_name$request_uri;
 
     server {
         location / {
+            proxy_cache_bypass $is_purge;
             if ($is_purge) {
-                proxy_pass http://unix:/var/run/nginx-cache-purge/http.sock;
+                proxy_pass http://unix:/run/nginx-cache-purge/http.sock;
-                rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$host$request_uri break;
+                rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$server_name$request_uri break;
+            }
+
+            proxy_cache my_cache;
+            proxy_pass http://upstream;
+        }
+    }
+}
+```
+
+### Auth via header and IP white list.
+```
+http {
+    map $http_purge_token $is_purge {
+        default 0;
+        nnCgKUx1p2bIABXR 1;
+    }
+
+    geo $purge_allowed {
+        default 0;
+        127.0.0.1 1;
+        192.168.0.0/24 1;
+    }
+
+    proxy_cache_path /var/nginx/proxy_temp/cache levels=1:2 keys_zone=my_cache:10m;
+    proxy_cache_key $server_name$request_uri;
+
+    server {
+        location / {
+            set $should_purge $purge_allowed;
+            if ($is_purge != 1) {
+                set $should_purge 0;
+            }
+            proxy_cache_bypass $should_purge;
+            if ($should_purge) {
+                proxy_pass http://unix:/run/nginx-cache-purge/http.sock;
+                rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$server_name$request_uri break;
             }
 
             proxy_cache my_cache;
@@ -118,7 +179,7 @@ http {
 ```
 http {
     proxy_cache_path /var/nginx/proxy_temp/cache levels=1:2 keys_zone=my_cache:10m;
-    proxy_cache_key $host$request_uri;
+    proxy_cache_key $server_name$request_uri;
 
     server {
         location / {
@@ -128,9 +189,53 @@ http {
         location ~ /purge(/.*) {
             allow 127.0.0.1;
             deny all;
-            proxy_pass http://unix:/var/run/nginx-cache-purge/http.sock;
+            proxy_pass http://unix:/run/nginx-cache-purge/http.sock;
-            rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$host$1 break;
+            rewrite ^ /?path=/var/nginx/proxy_temp/cache&key=$server_name$1 break;
         }
     }
 }
 ```
+
+## Help
+```
+$ nginx-cache-purge --help  
+Usage: nginx-cache-purge <command> [flags]
+
+Tool to help purge cache from Nginx
+
+Flags:
+  -h, --help       Show context-sensitive help.
+      --version    Print version information and quit
+
+Commands:
+  server (s)    Run the server
+  purge (p)     Purge cache now
+
+Run "nginx-cache-purge <command> --help" for more information on a command.
+
+$ nginx-cache-purge p --help
+Usage: nginx-cache-purge purge (p) <cache-path> <key> [flags]
+
+Purge cache now
+
+Arguments:
+  <cache-path>    Path to cache directory.
+  <key>           Cache key or wildcard match.
+
+Flags:
+  -h, --help                           Show context-sensitive help.
+      --version                        Print version information and quit
+
+      --exclude-key=EXCLUDE-KEY,...    Key to exclude, can be wild card and can add multiple excludes.
+
+$ nginx-cache-purge s --help
+Usage: nginx-cache-purge server (s) [flags]
+
+Run the server
+
+Flags:
+  -h, --help             Show context-sensitive help.
+      --version          Print version information and quit
+
+      --socket=STRING    Socket path for HTTP communication.
+``

main.go

@@ -5,6 +5,7 @@ import (
 	"crypto/md5"
 	"encoding/hex"
 	"fmt"
+	"log"
 	"os"
 	"path/filepath"
 	"regexp"
@@ -17,7 +18,7 @@ import (
 const (
 	serviceName        = "nginx-cache-purge"
 	serviceDescription = "Tool to help purge Nginx cache "
-	serviceVersion     = "0.1"
+	serviceVersion     = "0.1.4"
 )
 
 // App structure to access global app variables.
@@ -42,7 +43,7 @@ func (a *App) PurgeCache(CachePath string, Key string, ExcludeKeys []string) err
 		for _, exclude := range ExcludeKeys {
 			if globRegex.MatchString(exclude) {
 				g, err := glob.Compile(exclude)
-				if err != nil && g != nil && g.Match(Key) {
+				if err == nil && g != nil && g.Match(Key) {
 					return true
 				}
 			}
@@ -62,7 +63,7 @@ func (a *App) PurgeCache(CachePath string, Key string, ExcludeKeys []string) err
 	if !globRegex.MatchString(Key) {
 		// If excluded, skip the key.
 		if keyIsExcluded(Key) {
-			fmt.Println("Key", Key, "is excluded, will not purge.")
+			log.Println("Key", Key, "is excluded, will not purge.")
 			return nil
 		}
 
@@ -82,7 +83,7 @@ func (a *App) PurgeCache(CachePath string, Key string, ExcludeKeys []string) err
 			}
 			// If this file matches our key hash then delete.
 			if info.Name() == keyHash {
-				fmt.Printf("Purging %s as it matches the key %s requested to be purged.\n", filePath, Key)
+				log.Printf("Purging %s as it matches the key %s requested to be purged.\n", filePath, Key)
 				err := os.Remove(filePath)
 				if err != nil {
 					return err
@@ -118,12 +119,21 @@ func (a *App) PurgeCache(CachePath string, Key string, ExcludeKeys []string) err
 			}
 			defer file.Close()
 			scanner := bufio.NewScanner(file)
+			// Scan file for the key.
 			for scanner.Scan() {
 				line := scanner.Text()
+				// If line is the key, check if it matches our glob pattern and delete.
 				if strings.HasPrefix(line, "KEY: ") {
-					key := line[5:]
+					keyRead := line[5:]
-					if g.Match(key) {
+					if g.Match(keyRead) {
-						fmt.Printf("Purging %s as it matches the key %s requested to be purged.\n", filePath, Key)
+						// If excluded, skip the key.
+						if keyIsExcluded(keyRead) {
+							log.Println("Key", keyRead, "is excluded, will not purge.")
+							return nil
+						}
+
+						// Delete the file.
+						log.Printf("Purging %s as it matches the key %s requested to be purged.\n", filePath, Key)
 						err := os.Remove(filePath)
 						if err != nil {
 							return err

serverCmd.go

@@ -3,6 +3,7 @@ package main
 import (
 	"fmt"
 	"io"
+	"log"
 	"net"
 	"net/http"
 	"os"
@@ -50,7 +51,7 @@ func (a *ServerCmd) Run() error {
 	// Determine UNIX socket path.
 	unixSocket := a.Socket
 	if unixSocket == "" {
-		unixSocket = "/var/run/nginx-cache-purge/http.sock"
+		unixSocket = "/run/nginx-cache-purge/http.sock"
 	}
 
 	// If socket exists, remove it.
@@ -66,7 +67,7 @@ func (a *ServerCmd) Run() error {
 	defer listener.Close()
 
 	// Start the FastCGI server.
-	fmt.Println("Starting server at", unixSocket)
+	log.Println("Starting server at", unixSocket)
 	http.HandleFunc("/", a.ServeHTTP)
 	err = http.Serve(listener, nil)