Initial Commit

Author: mistralol

.gitignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -0,0 +1,43 @@
+
+# nginx-cache-purge
+
+* Gets a list of urls from one or more sitemaps.
+* Send a PURGE request to list url's found
+
+# Install / Running
+
+## From npm
+
+npm install -g nginx-cache-purge
+
+## Run from git clone
+
+git clone https://guthub.com/mistralol/nginx-cache-purge
+cd nginx-cache-purge && npm install
+node index.js http://www.example.com/sitemap.xml
+
+## Server configuration
+
+In order for this to work properly nginx must have the proxy_cache_purge configured correctly. If it does not then this program will not be able to purge the cache. Typical system like debian / ubuntu have this by default when using the nginx-extras package. It has not currently been tested with any other type of server.
+
+# Additional ideas / roadmap / todo list
+
+* Needs support for more input formats
+  1. stdin
+  2. json format
+  3. other xml formats
+  4. Read a flat text format
+* Needs limited pipelined request support aka run multiple concurrent requests
+* Optional send a GET (multiple?) to each url to get nginx to cache it again
+* Stats etc...
+* Better error reporting
+
+For bugs / ideas please use the issue list on github
+
+# Credits
+
+Original Author: James Stevenson
+E-Mail: james@stev.org
+BLOG: https://www.stev.org
+
+

index.js

@@ -0,0 +1,103 @@
+'use strict;'
+var debug = false;
+
+var fs = require('fs');
+var request = require('request');
+var xmlparse = require('xml-parser');
+var inspect = require('util').inspect;
+
+var opt = require('node-getopt').create([
+    ['h', 'help', 'Print this help'],
+    ['d', 'debug', 'Debug mode. Print more messages'],
+    ['n', 'dry-run', 'Simulated - Does not actually send purge command'],
+    ['w', 'wait=ARG', 'Add a delay between requests in ms'],
+]).bindHelp();
+
+var args = opt.parse(process.argv.slice(2));
+
+if (args["options"]["debug"])
+    debug = true;
+
+if (args["options"]["wait"] == undefined)
+	args["options"]["wait"] = 0;
+
+if (debug)
+	console.log(args);
+
+//Do the purge
+function DoPurge(origin, urls) {
+    console.log('Remaining:', urls.length);
+    if (urls.length == 0) {
+        console.log('Completed Purge', origin);
+        return;
+    }
+
+    if (args["options"]["dry-run"]) {
+        var url = urls.pop();
+        setTimeout(function() {
+            console.log('Purge Completed URL:', url, 'PURGED');
+            DoPurge(origin, urls);
+        }, args["options"]["wait"]);
+        return;
+    }
+
+    var url = urls.pop();
+    request({
+        uri : url,
+        method: "PURGE",
+        timeout: 10000
+    }, function(err, res, body) {
+        if (err) {
+            console.log('Purge Failed URL:', url, 'Error:', err);
+        } else {
+            console.log('Purge Completed URL:', url, 'PURGED:', res.statusCode);
+        }
+        if (args["options"]["wait"] > 0) {
+            setTimeout(function() { DoPurge(origin, urls); }, args["options"]["wait"]);
+        } else {
+            DoPurge(origin, urls);
+        }
+    });
+}
+
+
+//Convert xml to list of url's
+function ParseSiteMap(origin, data) {
+    var obj = xmlparse(data);
+    var urls = [];
+    var root = obj['root'];
+    var urlset = root['children'];
+    for(var i=0;i<urlset.length;i++) {
+        var info = urlset[i];
+        urls.push(info['children'][0]['content']);
+    }
+    return urls;
+}
+
+for(var i=0;i<args['argv'].length;i++) {
+    var url = args['argv'][i];
+    console.log("Trying:", url);
+
+    //Covers both http and https
+    if (url.startsWith('http')) {
+        console.log('Fetching:', url);
+        request(url, function (error, res, body) {
+            if (error) {
+                console.log('Failed to get:', url);
+            } else {
+                var urls = ParseSiteMap(url, body);
+                DoPurge(url, urls);
+            }
+        });
+    } else {
+        console.log('Reading:', url);
+        try {
+            var body = fs.readFileSync(url, 'utf8');
+            ParseSiteMap(url, body);
+        } catch(err) {
+            console.log('Cannot open file:', url, ' Error:', err);
+        }
+    }
+}
+
+

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "nginx-cache-purge",
+  "version": "1.0.0",
+  "description": "Sends PURGE requests to nginx",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "nginx",
+    "purge"
+  ],
+  "author": "James Stevenson",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/mistralol/nginx-cache-purge.git"
+  },
+  "dependencies": {
+    "node-getopt": "^0.2.3",
+    "request": "^2.81.0",
+    "xml-parser": "^1.2.1"
+  }
+}