actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
265 lines (234 loc) • 7.96 kB
JavaScript
var net = require('net');
var tls = require('tls');
var initialize = function(api, options, next){
//////////
// INIT //
//////////
var type = 'socket';
var attributes = {
canChat: true,
logConnections: true,
logExits: true,
pendingShutdownWaitLimit: 5000,
sendWelcomeMessage: true,
verbs: [
'quit',
'exit',
'documentation',
'paramAdd',
'paramDelete',
'paramView',
'paramsView',
'paramsDelete',
'roomAdd',
'roomLeave',
'roomView',
'detailsView',
'say'
]
};
var server = new api.genericServer(type, options, attributes);
//////////////////////
// REQUIRED METHODS //
//////////////////////
server.start = function(next){
if(options.secure === false){
server.server = net.createServer(api.config.servers.socket.serverOptions, function(rawConnection){
handleConnection(rawConnection);
});
}else{
server.server = tls.createServer(api.config.servers.socket.serverOptions, function(rawConnection){
handleConnection(rawConnection);
});
}
server.server.on('error', function(e){
return next(new Error('Cannot start socket server @ ' + options.bindIP + ':' + options.port + ' => ' + e.message));
});
server.server.listen(options.port, options.bindIP, function(){
process.nextTick(function(){
next();
});
});
};
server.stop = function(next){
gracefulShutdown(next);
};
server.sendMessage = function(connection, message, messageCount){
if(message.error){
message.error = api.config.errors.serializers.servers.socket(message.error);
}
if(connection.respondingTo){
message.messageCount = messageCount;
connection.respondingTo = null;
}else if(message.context === 'response'){
if(messageCount){
message.messageCount = messageCount;
}else{
message.messageCount = connection.messageCount;
}
}
try{
connection.rawConnection.write(JSON.stringify(message) + '\r\n');
}catch(e){
api.log(['socket write error: %s', e], 'error');
}
};
server.goodbye = function(connection){
try{
connection.rawConnection.end(JSON.stringify({status: connection.localize(api.config.servers.socket.goodbyeMessage), context: 'api'}) + '\r\n');
}catch(e){}
};
server.sendFile = function(connection, error, fileStream){
if(error){
server.sendMessage(connection, error, connection.messageCount);
}else{
fileStream.pipe(connection.rawConnection, {end: false});
}
};
////////////
// EVENTS //
////////////
server.on('connection', function(connection){
connection.params = {};
var parseLine = function(line){
if(api.config.servers.socket.maxDataLength > 0){
var blen = Buffer.byteLength(line, 'utf8');
if(blen > api.config.servers.socket.maxDataLength){
var error = api.config.errors.dataLengthTooLarge(api.config.servers.socket.maxDataLength, blen);
server.log(error, 'error');
return server.sendMessage(connection, {status:'error', error: error, context: 'response'});
}
}
if(line.length > 0){
// increment at the start of the request so that responses can be caught in order on the client
// this is not handled by the genericServer
connection.messageCount++;
parseRequest(connection, line);
}
};
connection.rawConnection.on('data', function(chunk){
if(checkBreakChars(chunk)){
connection.destroy();
}else{
// Replace all carriage returns with newlines.
connection.rawConnection.socketDataString += chunk.toString('utf-8').replace(/\r/g, '\n');
var index;
var d = String(api.config.servers.socket.delimiter);
while((index = connection.rawConnection.socketDataString.indexOf(d)) > -1){
var data = connection.rawConnection.socketDataString.slice(0, index);
connection.rawConnection.socketDataString = connection.rawConnection.socketDataString.slice(index + d.length);
data.split(d).forEach(parseLine);
}
}
});
connection.rawConnection.on('end', function(){
if(connection.destroyed !== true){
try{ connection.rawConnection.end(); }catch(e){}
connection.destroy();
}
});
connection.rawConnection.on('error', function(e){
if(connection.destroyed !== true){
server.log('socket error: ' + e, 'error');
try{ connection.rawConnection.end(); }catch(e){}
connection.destroy();
}
});
});
server.on('actionComplete', function(data){
if(data.toRender === true){
data.response.context = 'response';
server.sendMessage(data.connection, data.response, data.messageCount);
}
});
/////////////
// HELPERS //
/////////////
var parseRequest = function(connection, line){
var words = line.split(' ');
var verb = words.shift();
if(verb === 'file'){
if(words.length > 0){
connection.params.file = words[0];
}
server.processFile(connection);
}else{
connection.verbs(verb, words, function(error, data){
if(!error){
server.sendMessage(connection, {status: 'OK', context: 'response', data: data});
}else if(error.match('verb not found or not allowed')){
// check for and attempt to check single-use params
try{
var requestHash = JSON.parse(line);
if(requestHash.params !== undefined){
connection.params = {};
for(var v in requestHash.params){
connection.params[v] = requestHash.params[v];
}
}
if(requestHash.action){
connection.params.action = requestHash.action;
}
}catch(e){
connection.params.action = verb;
}
connection.error = null;
connection.response = {};
server.processAction(connection);
}else{
server.sendMessage(connection, {status: error, context: 'response', data: data});
}
});
}
};
var handleConnection = function(rawConnection){
if(api.config.servers.socket.setKeepAlive === true){
rawConnection.setKeepAlive(true);
}
rawConnection.socketDataString = '';
server.buildConnection({
rawConnection : rawConnection,
remoteAddress : rawConnection.remoteAddress,
remotePort : rawConnection.remotePort
}); // will emit 'connection'
};
// I check for ctrl+c in the stream
var checkBreakChars = function(chunk){
var found = false;
var hexChunk = chunk.toString('hex', 0, chunk.length);
if(hexChunk === 'fff4fffd06'){
found = true; // CTRL + C
}else if(hexChunk === '04'){
found = true; // CTRL + D
}
return found;
};
var gracefulShutdown = function(next, alreadyShutdown){
if(!alreadyShutdown || alreadyShutdown === false){
server.server.close();
}
var pendingConnections = 0;
server.connections().forEach(function(connection){
if(connection.pendingActions === 0){
connection.destroy();
}else{
pendingConnections++;
if(!connection.rawConnection.shutDownTimer){
connection.rawConnection.shutDownTimer = setTimeout(function(){
connection.destroy();
}, attributes.pendingShutdownWaitLimit);
}
}
});
if(pendingConnections > 0){
server.log('waiting on shutdown, there are still ' + pendingConnections + ' connected clients waiting on a response', 'notice');
setTimeout(function(){
gracefulShutdown(next, true);
}, 1000);
}else if(typeof next === 'function'){ next(); }
};
next(server);
};
/////////////////////////////////////////////////////////////////////
// exports
exports.initialize = initialize;