Skip to content

Commit

Permalink
Initial commit on first outwardly functional version.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Magnitus-
Magnitus- committed Oct 30, 2014
0 parents commit 453764c
Show file tree
Hide file tree
Showing 3 changed files with 342 additions and 0 deletions.
19 changes: 19 additions & 0 deletions License.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2014 Eric Vallee <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
297 changes: 297 additions & 0 deletions TrafficCounter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,297 @@
/*
Copyright (c) 2014 Eric Vallee <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

var MongoDB = require('mongodb');
var Assert = require('assert');
var Events = require('events');
var Util = require('util');

var TimeUnit = {'Minute': 0, 'Hour': 1, 'Day': 2, 'Month': 3};
var Event = {'SetupFinished': 'SetupFinished', 'Error': 'error', 'RequestError': 'RequestError'}

function TruncateNow(TimeUnitParam)
{
var Now = new Date();
if(TimeUnitParam==TimeUnit.Month)
{
return(new Date(Now.getFullYear(), Now.getMonth()));
}
else if(TimeUnitParam==TimeUnit.Day)
{
return(new Date(Now.getFullYear(), Now.getMonth(), Now.getDate()));
}
else if(TimeUnitParam==TimeUnit.Hour)
{
return(new Date(Now.getFullYear(), Now.getMonth(), Now.getDate(), Now.getHours()));
}
else
{
return(new Date(Now.getFullYear(), Now.getMonth(), Now.getDate(), Now.getHours(), Now.getMinutes()));
}

}

function GetDiscreteSteps(Before, After, TimeUnitParam) //Assumes truncated time input
{
var Result = [];
//Probably should eventually be shortened by exploiting the symmetry in the branches
if(TimeUnitParam==TimeUnit.Month)
{
var Index = new Date(Before.getFullYear(), Before.getMonth());
while(Index<After)
{
Index.setMonth(Index.getMonth()+1);
Result.push(new Date(Index.getFullYear(), Index.getMonth()));
}
}
else if(TimeUnitParam==TimeUnit.Day)
{
var Index = new Date(Before.getFullYear(), Before.getMonth(), Before.getDate());
while(Index<After)
{
Index.setDate(Index.getDate()+1);
Result.push(new Date(Index.getFullYear(), Index.getMonth(), Index.getDate()));
}
}
else if(TimeUnitParam==TimeUnit.Hour)
{
var Index = new Date(Before.getFullYear(), Before.getMonth(), Before.getDate(), Before.getHours());
while(Index<After)
{
Index.setHours(Index.getHours()+1);
Result.push(new Date(Index.getFullYear(), Index.getMonth(), Index.getDate(), Index.getHours()));
}
}
else
{
var Index = new Date(Before.getFullYear(), Before.getMonth(), Before.getDate(), Before.getHours(), Before.getMinutes());
while(Index<After)
{
Index.setMinutes(Index.getMinutes()+1);
Result.push(new Date(Index.getFullYear(), Index.getMonth(), Index.getDate(), Index.getHours(), Index.getMinutes()));
}
}
return(Result);
}

function GenerateTCConstructor() {//Closure simulates private/internal class members
LastDateByPath = {};
function HandleError(Err, ErrCallback, OkCallback, ErrEmitKey)
{
if(Err)
{
if(ErrEmitKey)
{
this.emit(ErrEmitKey, Err);
}
if(ErrCallback)
{
ErrCallback(Err);
}
}
else
{
OkCallback();
}
}

function EnsureSharedDependencies(Callback)
{
var Context = this;
var DB = this.DB;
DB.createCollection('ViewsByPath', {'w': 1}, function(Err, ViewsByPathCollection) {
HandleError.call(Context, Err, Callback, function() {
DB.createCollection('DefinedPaths', {'w': 1}, function(Err, DefinedPathsCollection) {
HandleError.call(Context, Err, Callback, function() {
DefinedPathsCollection.ensureIndex({'Path': 1}, {'unique': true}, function(Err, Index) {});
if(Callback)
{
Callback();
}
}, Event.Error);
});
}, Event.Error);
});
}

function EnsurePathCoreDependencies(Params, Callback)
{
var Context = this;
var DB = this.DB;
DB.collection('DefinedPaths', function(Err, DefinedPathsCollection) {
HandleError.call(Context, Err, Callback, function() {
DefinedPathsCollection.findAndModify({'Path': Params['Path']}, [['Path', 1]], {'$setOnInsert': {'Path': Params['Path']}}, {'w': 1, 'upsert': true, 'new': true}, function(Err, Item) {
HandleError.call(Context, Err, Callback, function() {
SizeCalcDummy = {'Views': 1, 'Date': new Date(), '_id': new MongoDB.ObjectID()};
DB.createCollection(Params['Path']+':TrafficCounter', {"capped" : true, "size" : MongoDB.BSON.calculateObjectSize(SizeCalcDummy)*Params['Length']*2, "max" : Params['Length'], 'w': 1}, function(Err, ViewsCounterCollection) {
HandleError.call(Context, Err, Callback, function() {
ViewsCounterCollection.ensureIndex({'Date': 1}, {'unique': true}, function(Err, Index) {});
if(Callback)
{
Callback();
}
}, Event.RequestError);
});
}, Event.RequestError);
});
}, Event.RequestError);
});
}

function EnsurePathDependencies(Params, Callback)
{
var Context = this;
var Now = Params['Now'];
var DB = this.DB;
var Path = Params['Path'];
if(LastDateByPath[Path]===undefined)
{
EnsurePathCoreDependencies.call(Context, Params, function(Err) {
HandleError.call(Context, Err, Callback, function() {
DB.collection(Params['Path']+':TrafficCounter', function(Err, ViewsCounterCollection) {
HandleError.call(Context, Err, Callback, function() {
ViewsCounterCollection.findAndModify({'Date': Now}, [['Date', 1]], {'$setOnInsert': {'Views': 0, 'Date': Now}}, {'w': 1, 'upsert': true, 'new': true}, function(Err, Item) {
HandleError.call(Context, Err, Callback, function() {
if((LastDateByPath[Path]===undefined)||(Now > LastDateByPath[Path]))
{
LastDateByPath[Path] = Now;
}
if(Callback)
{
Callback();
}
}, Event.RequestError);
});
}, Event.RequestError);
});
});
});
}
else if(Now != LastDateByPath[Path])
{
DB.collection(Path+':TrafficCounter', {'strict': true}, function(Err, ViewsCounterCollection) {
HandleError.call(Context, Err, Callback, function() {
ViewsCounterCollection.findAndModify({'Date': Now}, [['Date', 1]], {'$setOnInsert': {'Views': 0, 'Date': Now}}, {'w': 1, 'upsert': true, 'new': true}, function(Err, Item) {
HandleError.call(Context, Err, Callback, function() {
if(Now > LastDateByPath[Path])
{
LastDateByPath[Path] = Now;
}
if(Callback)
{
Callback();
}
}, Event.RequestError);
});
}, Event.RequestError);
});
}
else
{
if(Callback)
{
Callback();
}
}

}

function Increment(Params, Callback)
{
var Context = this;
var DB = this.DB;
var Event = this.Event;
DB.collection(Params['Path']+':TrafficCounter', {'strict': true}, function(Err, ViewsCounterCollection) {
HandleError.call(Context, Err, Callback, function() {
ViewsCounterCollection.update({'Date': Params['Now']}, {"$inc" : {"Views" : 1}}, {'w': 0});
if(Callback)
{
Callback();
}
}, Event.RequestError)
});
}

function BuildFullPath(Req, App)
{
var ToReturn = Req.route ? Req.route.path : App.mountpath.toString();
var CurrentApp = Req.route ? App : App.parent;
while(CurrentApp)
{
if(App.mountpath != '/')
{
ToReturn = App.mountpath.toString() + ToReturn;
}
CurrentApp = CurrentApp.parent;
}
return(ToReturn);
}

function GetTraffic(TimeUnitParam, Length, Path, Cumulative, Callback)
{
//To be implemented
}

function TrafficCounter()
{
Events.EventEmitter.call(this);
this.Setup = function(DB, Callback) {
var Context = this;
this.DB = DB;
EnsureSharedDependencies.call(Context, function(Err) {
HandleError.call(Context, Err, Callback, function() {
Context.CountTraffic = function(TimeUnitParam, Length, App, PathParam) {
return(function(Req, Res, Next) {
Params = {'Length': Length, 'TimeUnit': TimeUnitParam, 'Now': TruncateNow(TimeUnitParam)};
if(!PathParam)
{
PathParam = BuildFullPath(Req, App);
}
Params['Path'] = PathParam;
EnsurePathDependencies.call(Context, Params, function(Err) {
HandleError.call(Context, Err, Next, function() {
Increment.call(Context, Params, Next);
});
});
});
};
Context.GetTraffic = GetTraffic;
if(Callback)
{
Context.emit(Event.SetupFinished);
Callback();
}
});
});
};
}

Util.inherits(TrafficCounter, Events.EventEmitter);
TrafficCounter.prototype.TimeUnit = TimeUnit;
TrafficCounter.prototype.Event = Event;
return TrafficCounter;
}

var TrafficCounter = GenerateTCConstructor();

module.exports = new TrafficCounter();

26 changes: 26 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"name": "TrafficCounter",
"description": "Express.js Middleware To Count Requests on Paths",
"keywords": [
"express",
"mongo",
"middleware"
],
"author": {
"name": "Eric Vallee",
"email": "[email protected]"
},
"repository": {
"type": "git",
"url": "http://github.com/Magnitus-/TrafficCounter"
},
"licenses": [
{
"type": "MIT License",
"url": "http://mit-license.org/"
}
],
"dependencies": {
"mongodb": "~1.4.19"
}
}

0 comments on commit 453764c

Please sign in to comment.