@jesec/flood 0.0.0-master.ee0257a → 0.0.0-master.ee5f837

package/node_modules/geoip-country/README.md

@@ -0,0 +1,129 @@
+# geoip-country [![NPM version](https://badge.fury.io/js/geoip-country.svg)](https://badge.fury.io/js/geoip-country)
+
+Less memory usage version of [geoip-lite](https://github.com/bluesmoon/node-geoip) by limiting to country information.
+This product includes GeoLite2 ipv4 and ipv6 country data which created by MaxMind, available from https://www.maxmind.com.
+The database of this product **updates weekly**.
+
+**You should read this README and the LICENSE and EULA files carefully before deciding to use this product.**<br>
+**After v4, LICENSE for the database was changed. If you need to use this product with previous LICENSE, please use v3.**
+
+
+## Synopsis
+
+```javascript
+var geoip = require('geoip-country');
+
+var ip = "207.97.227.239";
+var geo = geoip.lookup(ip);
+
+console.log(geo);
+{ range: [ 3479299040, 3479299071 ],
+  country: 'US'}
+```
+
+
+## Installation
+
+### 1. Install the library
+
+    $ npm install geoip-country
+
+### 2. Update MaxMind's geoip data
+
+    $ npm run-script updatedb --license_key=YOUR_GEOLITE2_LICENSE_KEY
+		or
+    $ GEOLITE2_LICENSE_KEY=YOUR_GEOLITE2_LICENSE_KEY node scripts/updatedb.js
+
+_YOUR_GEOLITE2_LICENSE_KEY should be replaced by a valid GeoLite2 license key. Please [follow instructions](https://dev.maxmind.com/geoip/geoip2/geolite2/) provided by MaxMind to obtain a license key._
+
+
+## API
+
+geoip-country is completely synchronous.  There are no callbacks involved.  All blocking file IO is done at startup time, so all runtime
+calls are executed in-memory and are fast.  Startup may take up to 20ms while it reads into memory and indexes data files.
+
+### Looking up an IP address ###
+
+If you have an IP address in dotted quad notation, IPv6 colon notation, or a 32 bit unsigned integer (treated
+as an IPv4 address), pass it to the `lookup` method.  Note that you should remove any `[` and `]` around an
+IPv6 address before passing it to this method.
+
+```javascript
+var geo = geoip.lookup(ip);
+```
+
+If the IP address was found, the `lookup` method returns an object with the following structure:
+
+```javascript
+{
+   range: [ <low bound of IP block>, <high bound of IP block> ],
+   country: 'XX' // 2 letter ISO-3166-1 country code
+}
+```
+
+The actual values for the `range` array depend on whether the IP is IPv4 or IPv6 and should be
+considered internal to `geoip-country`.  To get a human readable format, pass them to `geoip.pretty()`
+
+If the IP address was not found, the `lookup` returns `null`
+
+### Update database API [Added at v4.1.0]
+
+You can update country database with `updateDatabase` method.
+
+```javascript
+    geoip.updateDatabase(license_key, callback);
+```
+
+`license_key` is a license key which provided by MaxMind. You can get GeoLite2 license key as [instructions](https://dev.maxmind.com/geoip/geoip2/geolite2/).
+
+### Pretty printing an IP address ###
+
+If you have a 32 bit unsigned integer, or a number returned as part of the `range` array from the `lookup` method,
+the `pretty` method can be used to turn it into a human readable string.
+
+```javascript
+    console.log("The IP is %s", geoip.pretty(ip));
+```
+
+This method returns a string if the input was in a format that `geoip-country` can recognize, else it returns the
+input itself.
+
+
+## Built-in Updater
+
+This package contains an update script that can pull the files from MaxMind and handle the conversion from CSV.
+A npm script alias has been setup to make this process easy. Please keep in mind this requires internet and MaxMind
+rate limits that amount of downloads on their servers.
+
+```shell
+npm run-script updatedb --license_key=YOUR_GEOLITE2_LICENSE_KEY
+	or
+GEOLITE2_LICENSE_KEY=YOUR_GEOLITE2_LICENSE_KEY node scripts/updatedb.js
+```
+
+_YOUR_GEOLITE2_LICENSE_KEY should be replaced by a valid GeoLite2 license key. Please [follow instructions](https://dev.maxmind.com/geoip/geoip2/geolite2/) provided by MaxMind to obtain a license key._
+
+
+## Custom Directory for database files
+
+You can store the database files in custom directory with the environment variable `GEODATADIR` or CLI parameter `--geodatadir=XXXXX`.
+For creating or updating the database files in custom directory, you need to run built-in updater as documented above with setting the environment variable `GEODATADIR` or CLI parameter `--geodatadir=XXXXX`.
+If you have no write-access to the `geoip-country` directory, it would be better to set the environment `GEOTMPDATADIR` or CLI parameter `--geotmpdatadir=YYYYY` for temporary directory when updating the database files.
+
+
+## License and EULA
+
+Please carefully read the LICENSE and EULA files. This package comes with certain restrictions and obligations, most notably:
+ - You cannot prevent the library from updating the databases.
+ - You cannot use the GeoLite2 data:
+   - for FCRA purposes,
+   - to identify specific households or individuals.
+
+You can read [the latest version of GeoLite2 EULA](https://www.maxmind.com/en/geolite2/eula).
+
+
+## References
+  - <a href="https://www.maxmind.com/en/geolite2/eula">GeoLite2 EULA</a>
+  - <a href="https://www.maxmind.com/app/iso3166">Documentation from MaxMind</a>
+  - <a href="https://en.wikipedia.org/wiki/ISO_3166">ISO 3166 (1 & 2) codes</a>
+  - <a href="https://en.wikipedia.org/wiki/List_of_FIPS_region_codes">FIPS region codes</a>

package/node_modules/geoip-country/lib/fsWatcher.js

@@ -0,0 +1,78 @@
+var fs = require('fs'),
+    path = require('path'),
+    FSWatcher = {};
+
+/**
+ * Takes a directory/file and watch for change. Upon change, call the
+ * callback.
+ *
+ * @param {String} name: name of this watcher
+ * @param {String} directory: path to the directory to watch
+ * @param {String} [filename]: (optional) specific filename to watch for,
+ *     watches for all files in the directory if unspecified
+ * @param {Integer} cooldownDelay: delay to wait before triggering the callback
+ * @param {Function} callback: function () : called when changes are detected
+**/
+function makeFsWatchFilter(name, directory, filename, cooldownDelay, callback) {
+	var cooldownId = null;
+
+	//Delete the cooldownId and callback the outer function
+	function timeoutCallback() {
+		cooldownId = null;
+		callback();
+	}
+
+	//This function is called when there is a change in the data directory
+	//It sets a timer to wait for the change to be completed
+	function onWatchEvent(event, changedFile) {
+		var filePath = path.join(directory, changedFile);
+
+		if (!filename || filename === changedFile) {
+			fs.exists(filePath, function onExists(exists) {
+				if (!exists) {
+					// if the changed file no longer exists, it was a deletion.
+					// we ignore deleted files
+					return;
+				}
+
+				//At this point, a new file system activity has been detected,
+				//We have to wait for file transfert to be finished before moving on.
+
+				//If a cooldownId already exists, we delete it
+				if (cooldownId !== null) {
+					clearTimeout(cooldownId);
+					cooldownId = null;
+				}
+
+				//Once the cooldownDelay has passed, the timeoutCallback function will be called
+				cooldownId = setTimeout(timeoutCallback, cooldownDelay);
+			});
+		}
+	}
+
+	//Manage the case where filename is missing (because it's optionnal)
+	if (typeof cooldownDelay === 'function') {
+		callback = cooldownDelay;
+		cooldownDelay = filename;
+		filename = null;
+	}
+
+	if (FSWatcher[name]) {
+		stopWatching(name);
+	}
+
+	FSWatcher[name] = fs.watch(directory, onWatchEvent);
+}
+
+/**
+ * Take a FSWatcher object and close it.
+ *
+ * @param {string} name: name of the watcher to close
+ *
+**/
+function stopWatching(name) {
+	FSWatcher[name].close();
+}
+
+module.exports.makeFsWatchFilter = makeFsWatchFilter;
+module.exports.stopWatching = stopWatching;

package/node_modules/geoip-country/lib/geoip.js

@@ -0,0 +1,491 @@
+var fs = require('fs');
+var net = require('net');
+var path = require('path');
+var exec = require('child_process').exec;
+
+fs.existsSync = fs.existsSync || path.existsSync;
+
+var utils = require('./utils');
+var fsWatcher = require('./fsWatcher');
+var async = require('async');
+
+var watcherName = 'dataWatcher';
+var geodatadir = global.geodatadir || process.env.npm_config_geodatadir || process.env.GEODATADIR;
+if(!geodatadir && process.argv) {
+	for(var i = 0; i < process.argv.length; ++i){
+		if(process.argv[i].indexOf('--geodatadir=') === 0){
+			geodatadir = process.argv[i].slice(13);
+			break;
+		}
+	}
+}
+geodatadir = path.resolve(
+	__dirname,
+	geodatadir || '../data/'
+);
+
+var dataFiles = {
+	city: path.join(geodatadir, 'geoip-city.dat'),
+	city6: path.join(geodatadir, 'geoip-city6.dat'),
+	cityNames: path.join(geodatadir, 'geoip-city-names.dat'),
+	country: path.join(geodatadir, 'geoip-country.dat'),
+	country6: path.join(geodatadir, 'geoip-country6.dat')
+};
+
+var privateRange4 = [
+		[utils.aton4('10.0.0.0'), utils.aton4('10.255.255.255')],
+		[utils.aton4('172.16.0.0'), utils.aton4('172.31.255.255')],
+		[utils.aton4('192.168.0.0'), utils.aton4('192.168.255.255')]
+	]
+
+var cache4 = {
+	firstIP: null,
+	lastIP: null,
+	lastLine: 0,
+	locationBuffer: null,
+	locationRecordSize: 64,
+	mainBuffer: null,
+	recordSize: 12
+};
+
+var cache6 = {
+	firstIP: null,
+	lastIP: null,
+	lastLine: 0,
+	mainBuffer: null,
+	recordSize: 58
+};
+
+var RECORD_SIZE = 10;
+var RECORD_SIZE6 = 34
+
+function lookup4(ip) {
+	var fline = 0;
+	var floor = cache4.lastIP;
+	var cline = cache4.lastLine;
+	var ceil = cache4.firstIP;
+	var line;
+	var locId;
+
+	var buffer = cache4.mainBuffer;
+	var locBuffer = cache4.locationBuffer;
+	var privateRange = privateRange4;
+	var recordSize = cache4.recordSize;
+	var locRecordSize = cache4.locationRecordSize;
+
+	var i;
+
+	var geodata = {
+		range: '',
+		country: '',
+	};
+
+	// outside IPv4 range
+	if (ip > cache4.lastIP || ip < cache4.firstIP) {
+		return null;
+	}
+
+	// private IP
+	for (i = 0; i < privateRange.length; i++) {
+		if (ip >= privateRange[i][0] && ip <= privateRange[i][1]) {
+			return null;
+		}
+	}
+
+	do {
+		line = Math.round((cline - fline) / 2) + fline;
+		floor = buffer.readUInt32BE(line * recordSize);
+		ceil  = buffer.readUInt32BE((line * recordSize) + 4);
+
+		if (floor <= ip && ceil >= ip) {
+			geodata.range = [floor, ceil];
+			geodata.country = buffer.toString('utf8', (line * recordSize) + 8, (line * recordSize) + 10);
+			return geodata;
+		} else if (fline === cline) {
+			return null;
+		} else if (fline === (cline - 1)) {
+			if (line === fline) {
+				fline = cline;
+			} else {
+				cline = fline;
+			}
+		} else if (floor > ip) {
+			cline = line;
+		} else if (ceil < ip) {
+			fline = line;
+		}
+	} while(1);
+}
+
+function lookup6(ip) {
+	var buffer = cache6.mainBuffer;
+	var recordSize = cache6.recordSize;
+
+	var geodata = {
+		range: '',
+		country: '',
+	};
+
+	// XXX We only use the first 8 bytes of an IPv6 address
+	// This identifies the network, but not the host within
+	// the network.  Unless at some point of time we have a
+	// global peace treaty and single subnets span multiple
+	// countries, this should not be a problem.
+	function readip(line, offset) {
+		var ii = 0;
+		var ip = [];
+
+		for (ii = 0; ii < 2; ii++) {
+			ip.push(buffer.readUInt32BE((line * recordSize) + (offset * 16) + (ii * 4)));
+		}
+
+		return ip;
+	}
+
+	cache6.lastIP = readip(cache6.lastLine, 1);
+	cache6.firstIP = readip(0, 0);
+
+	var fline = 0;
+	var floor = cache6.lastIP;
+	var cline = cache6.lastLine;
+	var ceil = cache6.firstIP;
+	var line;
+
+	if (utils.cmp6(ip, cache6.lastIP) > 0 || utils.cmp6(ip, cache6.firstIP) < 0) {
+		return null;
+	}
+
+	do {
+		line = Math.round((cline - fline) / 2) + fline;
+		floor = readip(line, 0);
+		ceil  = readip(line, 1);
+
+		if (utils.cmp6(floor, ip) <= 0 && utils.cmp6(ceil, ip) >= 0) {
+			geodata.range = [floor, ceil];
+			geodata.country = buffer.toString('utf8', (line * recordSize) + 32, (line * recordSize) + 34).replace(/\u0000.*/, '');
+
+			// We do not currently have detailed region/city info for IPv6, but finally have coords
+			return geodata;
+		} else if (fline === cline) {
+			return null;
+		} else if (fline === (cline - 1)) {
+			if (line === fline) {
+				fline = cline;
+			} else {
+				cline = fline;
+			}
+		} else if (utils.cmp6(floor, ip) > 0) {
+			cline = line;
+		} else if (utils.cmp6(ceil, ip) < 0) {
+			fline = line;
+		}
+	} while(1);
+}
+
+function get4mapped(ip) {
+    var ipv6 = ip.toUpperCase();
+    var v6prefixes = ['0:0:0:0:0:FFFF:', '::FFFF:'];
+    for (var i = 0; i < v6prefixes.length; i++) {
+        var v6prefix = v6prefixes[i];
+        if (ipv6.indexOf(v6prefix) == 0) {
+            return ipv6.substring(v6prefix.length);
+        }
+    }
+    return null;
+}
+
+function preload(callback) {
+	var datFile;
+	var datSize;
+	var asyncCache = {
+		firstIP: null,
+		lastIP: null,
+		lastLine: 0,
+		locationBuffer: null,
+		locationRecordSize: 64,
+		mainBuffer: null,
+		recordSize: 12
+	};
+
+	//when the preload function receives a callback, do the task asynchronously
+	if (typeof arguments[0] === 'function') {
+		async.series([
+			function (cb) {
+				async.series([
+					function (cb2) {
+						fs.open(dataFiles.cityNames, 'r', function (err, file) {
+							datFile = file;
+							cb2(err);
+						});
+					},
+					function (cb2) {
+						fs.fstat(datFile, function (err, stats) {
+							datSize = stats.size;
+							asyncCache.locationBuffer = Buffer.alloc ? Buffer.alloc(datSize) : new Buffer(datSize);
+							cb2(err);
+						});
+					},
+					function (cb2) {
+						fs.read(datFile, asyncCache.locationBuffer, 0, datSize, 0, cb2);
+					},
+					function (cb2) {
+						fs.close(datFile, cb2);
+					},
+					function (cb2) {
+						fs.open(dataFiles.city, 'r', function (err, file) {
+							datFile = file;
+							cb2(err);
+						});
+					},
+					function (cb2) {
+						fs.fstat(datFile, function (err, stats) {
+							datSize = stats.size;
+							cb2(err);
+						});
+					}
+				], function (err) {
+					if (err) {
+						if (err.code !== 'ENOENT' && err.code !== 'EBADF') {
+							throw err;
+						}
+
+						fs.open(dataFiles.country, 'r', function (err, file) {
+							if (err) {
+								cb(err);
+							} else {
+								datFile = file;
+								fs.fstat(datFile, function (err, stats) {
+									datSize = stats.size;
+									asyncCache.recordSize = RECORD_SIZE;
+
+									cb();
+								});
+							}
+						});
+						
+					} else {
+						cb();
+					}
+				});
+			},
+			function () {
+				asyncCache.mainBuffer = Buffer.alloc ? Buffer.alloc(datSize) : new Buffer(datSize);
+				
+				async.series([
+					function (cb2) {
+						fs.read(datFile, asyncCache.mainBuffer, 0, datSize, 0, cb2);
+					},
+					function (cb2) {
+						fs.close(datFile, cb2);
+					}
+				], function (err) {
+					if (err) {
+						//keep old cache
+					} else {
+						asyncCache.lastLine = (datSize / asyncCache.recordSize) - 1;
+						asyncCache.lastIP = asyncCache.mainBuffer.readUInt32BE((asyncCache.lastLine * asyncCache.recordSize) + 4);
+						cache4 = asyncCache;
+					}
+					callback(err);
+				});
+			}
+		]);
+	} else {
+		datFile = fs.openSync(dataFiles.country, 'r');
+		datSize = fs.fstatSync(datFile).size;
+		cache4.recordSize = RECORD_SIZE;
+
+		cache4.mainBuffer = Buffer.alloc ? Buffer.alloc(datSize) : new Buffer(datSize);
+		fs.readSync(datFile, cache4.mainBuffer, 0, datSize, 0);
+
+		fs.closeSync(datFile);
+
+		cache4.lastLine = (datSize / cache4.recordSize) - 1;
+		cache4.lastIP = cache4.mainBuffer.readUInt32BE((cache4.lastLine * cache4.recordSize) + 4);
+		cache4.firstIP = cache4.mainBuffer.readUInt32BE(0);
+	}
+}
+
+function preload6(callback) {
+	var datFile;
+	var datSize;
+	var asyncCache6 = {
+		firstIP: null,
+		lastIP: null,
+		lastLine: 0,
+		mainBuffer: null,
+		recordSize: 58
+	};
+
+	//when the preload function receives a callback, do the task asynchronously
+	if (typeof arguments[0] === 'function') {
+		async.series([
+			function (cb) {
+				async.series([
+					function (cb2) {
+						fs.open(dataFiles.city6, 'r', function (err, file) {
+							datFile = file;
+							cb2(err);
+						});
+					},
+					function (cb2) {
+						fs.fstat(datFile, function (err, stats) {
+							datSize = stats.size;
+							cb2(err);
+						});
+					}
+				], function (err) {
+					if (err) {
+						if (err.code !== 'ENOENT' && err.code !== 'EBADF') {
+							throw err;
+						}
+
+						fs.open(dataFiles.country6, 'r', function (err, file) {
+							if (err) {
+								cb(err);
+							} else {
+								datFile = file;
+								fs.fstat(datFile, function (err, stats) {
+									datSize = stats.size;
+									asyncCache6.recordSize = RECORD_SIZE6;
+
+									cb();
+								});
+							}
+						});
+					} else {
+						cb();
+					}
+				});
+			},
+			function () {
+				asyncCache6.mainBuffer = Buffer.alloc ? Buffer.alloc(datSize) : new Buffer(datSize);
+				
+				async.series([
+					function (cb2) {
+						fs.read(datFile, asyncCache6.mainBuffer, 0, datSize, 0, cb2);
+					},
+					function (cb2) {
+						fs.close(datFile, cb2);
+					}
+				], function (err) {
+					if (err) {
+						//keep old cache
+					} else {
+						asyncCache6.lastLine = (datSize / asyncCache6.recordSize) - 1;
+						cache6 = asyncCache6;
+					}
+					callback(err);
+				});
+			}
+		]);
+	} else {
+		datFile = fs.openSync(dataFiles.country6, 'r');
+		datSize = fs.fstatSync(datFile).size;
+		cache6.recordSize = RECORD_SIZE6;
+
+		cache6.mainBuffer = Buffer.alloc ? Buffer.alloc(datSize) : new Buffer(datSize);
+		fs.readSync(datFile, cache6.mainBuffer, 0, datSize, 0);
+
+		fs.closeSync(datFile);
+
+		cache6.lastLine = (datSize / cache6.recordSize) - 1;
+	}
+}
+
+module.exports = {
+	cmp: utils.cmp,
+
+	lookup: function(ip) {
+		if (!ip) {
+			return null;
+		} else if (typeof ip === 'number') {
+			return lookup4(ip);
+		} else if (net.isIP(ip) === 4) {
+			return lookup4(utils.aton4(ip));
+		} else if (net.isIP(ip) === 6) {
+			var ipv4 = get4mapped(ip);
+			if (ipv4) {
+				return lookup4(utils.aton4(ipv4));
+			} else {
+				return lookup6(utils.aton6(ip));
+			}
+		}
+
+		return null;
+	},
+
+	pretty: function(n) {
+		if (typeof n === 'string') {
+			return n;
+		} else if (typeof n === 'number') {
+			return utils.ntoa4(n);
+		} else if (n instanceof Array) {
+			return utils.ntoa6(n);
+		}
+
+		return n;
+	},
+
+	/**
+	 * @param {string} [license_key]
+	 * 		Without license_key, you need to set GEOLITE2_LICENSE_KEY as environmental variable
+	 * @param {function} [callback]
+	 */
+	updateDatabase(license_key, callback){
+		var command = 'node ' + path.join(__dirname, '..', 'scripts', 'updatedb.js')
+		var options = {encoding: 'utf-8'}
+		if(typeof license_key === 'function'){
+			callback = license_key
+		} else {
+			options.env = Object.assign({},
+					process.env || {},
+					{GEOLITE2_LICENSE_KEY: license_key})
+		}
+		if(!callback){
+			callback = function(){}
+		}
+
+		exec(command, options, function(error, stdout, stderr){
+			if(error){
+				return callback(error, stdout, stderr);
+			}
+			//Reload data
+			async.series([
+				function (cb) {
+					preload(cb);
+				},
+				function (cb) {
+					preload6(cb);
+				}
+			], callback);
+		});
+	},
+
+	// Start watching for data updates. The watcher waits one minute for file transfer to 
+	// completete before triggering the callback.
+	startWatchingDataUpdate: function (callback) {
+		fsWatcher.makeFsWatchFilter(watcherName, geodatadir, 60*1000, function () {
+			//Reload data
+			async.series([
+				function (cb) {
+					preload(cb);
+				},
+				function (cb) {
+					preload6(cb);
+				}
+			], callback);
+		});
+	},
+
+	// Stop watching for data updates.
+	stopWatchingDataUpdate: function () {
+		fsWatcher.stopWatching(watcherName);
+	}
+};
+
+preload();
+preload6();
+
+//lookup4 = gen_lookup('geoip-country.dat', 4);
+//lookup6 = gen_lookup('geoip-country6.dat', 16);