NodeBB/src/socket.io/index.js

"use strict";

var	SocketIO = require('socket.io');
var socketioWildcard = require('socketio-wildcard')();
var async = require('async');
var nconf = require('nconf');
var cookieParser = require('cookie-parser')(nconf.get('secret'));
var winston = require('winston');

var db = require('../database');
var user = require('../user');
var logger = require('../logger');
var ratelimit = require('../middleware/ratelimit');

var Sockets = {};
var Namespaces = {};

var io;

Sockets.init = function(server) {
	requireModules();

	io = new SocketIO({
		path: nconf.get('relative_path') + '/socket.io'
	});

	addRedisAdapter(io);

	io.use(socketioWildcard);
	io.use(authorize);

	io.on('connection', onConnection);

	io.listen(server, {
		transports: nconf.get('socket.io:transports')
	});

	Sockets.server = io;
};

function onConnection(socket) {
	socket.ip = socket.request.headers['x-forwarded-for'] || socket.request.connection.remoteAddress;

	logger.io_one(socket, socket.uid);

	cls.socket(socket, null, 'connection', function () {
		onConnect(socket);
	});

	socket.on('disconnect', function(payload) {
		cls.socket(socket, payload, 'disconnect', function () {
			onDisconnect(socket, payload);
		});
	});

	socket.on('*', function(payload) {
		cls.socket(socket, payload, null, function() {
			onMessage(socket, payload);
		});
	});
}

function onConnect(socket) {
	if (socket.uid) {
		socket.join('uid_' + socket.uid);
		socket.join('online_users');

		user.getUserFields(socket.uid, ['status'], function(err, userData) {
			if (err || !userData) {
				return;
			}

			if (userData.status !== 'offline') {
				socket.broadcast.emit('event:user_status_change', {uid: socket.uid, status: userData.status || 'online'});
			}
		});
	} else {
		socket.join('online_guests');
	}
}

function onDisconnect(socket) {
	if (socket.uid) {
		var socketCount = Sockets.getUserSocketCount(socket.uid);
		if (socketCount <= 1) {
			socket.broadcast.emit('event:user_status_change', {uid: socket.uid, status: 'offline'});
		}
	}
}

function onMessage(socket, payload) {
	if (!payload.data.length) {
		return winston.warn('[socket.io] Empty payload');
	}

	var eventName = payload.data[0];
	var params = payload.data[1];
	var callback = typeof payload.data[payload.data.length - 1] === 'function' ? payload.data[payload.data.length - 1] : function() {};

	if (!eventName) {
		return winston.warn('[socket.io] Empty method name');
	}

	var parts = eventName.toString().split('.');
	var namespace = parts[0];
	var methodToCall = parts.reduce(function(prev, cur) {
		if (prev !== null && prev[cur]) {
			return prev[cur];
		} else {
			return null;
		}
	}, Namespaces);

	if(!methodToCall) {
		if (process.env.NODE_ENV === 'development') {
			winston.warn('[socket.io] Unrecognized message: ' + eventName);
		}
		return;
	}

	socket.previousEvents = socket.previousEvents || [];
	socket.previousEvents.push(eventName);
	if (socket.previousEvents.length > 20) {
		socket.previousEvents.shift();
	}

	if (!eventName.startsWith('admin.') && ratelimit.isFlooding(socket)) {
		winston.warn('[socket.io] Too many emits! Disconnecting uid : ' + socket.uid + '. Events : ' + socket.previousEvents);
		return socket.disconnect();
	}

	async.waterfall([
		function (next) {
			validateSession(socket, next);
		},
		function (next) {
			if (Namespaces[namespace].before) {
				Namespaces[namespace].before(socket, eventName, params, next);
			} else {
				next();
			}
		},
		function (next) {
			methodToCall(socket, params, next);
		}
	], function(err, result) {
		callback(err ? {message: err.message} : null, result);
	});
}

function requireModules() {
	var modules = ['admin', 'categories', 'groups', 'meta', 'modules',
		'notifications', 'plugins', 'posts', 'topics', 'user'
	];

	modules.forEach(function(module) {
		Namespaces[module] = require('./' + module);
	});
}

function validateSession(socket, callback) {
	var req = socket.request;
	if (!req.signedCookies || !req.signedCookies['express.sid']) {
		return callback(new Error('[[error:invalid-session]]'));
	}
	db.sessionStore.get(req.signedCookies['express.sid'], function(err, sessionData) {
		if (err || !sessionData) {
			return callback(err || new Error('[[error:invalid-session]]'));
		}

		callback();
	});
}

function authorize(socket, callback) {
	var request = socket.request;

	if (!request) {
		return callback(new Error('[[error:not-authorized]]'));
	}

	async.waterfall([
		function(next) {
			cookieParser(request, {}, next);
		},
		function(next) {
			db.sessionStore.get(request.signedCookies['express.sid'], function(err, sessionData) {
				if (err) {
					return next(err);
				}
				if (sessionData && sessionData.passport && sessionData.passport.user) {
					socket.uid = parseInt(sessionData.passport.user, 10);
				} else {
					socket.uid = 0;
				}
				next();
			});
		}
	], callback);
}

function addRedisAdapter(io) {
	if (nconf.get('redis')) {
		var redisAdapter = require('socket.io-redis');
		var redis = require('../database/redis');
		var pub = redis.connect({return_buffers: true});
		var sub = redis.connect({return_buffers: true});

		io.adapter(redisAdapter({pubClient: pub, subClient: sub}));
	} else if (nconf.get('isCluster') === 'true') {
		winston.warn('[socket.io] Clustering detected, you are advised to configure Redis as a websocket store.');
	}
}

Sockets.in = function(room) {
	return io.in(room);
};

Sockets.getSocketCount = function() {
	if (!io) {
		return 0;
	}

	return Object.keys(io.sockets.sockets).length;
};

Sockets.getUserSocketCount = function(uid) {
	if (!io) {
		return 0;
	}
	var room = io.sockets.adapter.rooms['uid_' + uid];
	return room ? room.length : 0;
};

Sockets.getOnlineUserCount = function() {
	if (!io) {
		return 0;
	}
	var room = io.sockets.adapter.rooms.online_users;
	return room ? room.length : 0;
};

Sockets.getOnlineAnonCount = function () {
	if (!io) {
		return 0;
	}
	var room = io.sockets.adapter.rooms.online_guests;
	return room ? room.length : 0;
};

Sockets.reqFromSocket = function(socket, payload, event) {
	var headers = socket.request.headers;
	var host = headers.host;
	var referer = headers.referer || '';

	return {
		ip: headers['x-forwarded-for'] || socket.ip,
		host: host,
		uid: socket.uid,
		protocol: socket.request.connection.encrypted ? 'https' : 'http',
		secure: !!socket.request.connection.encrypted,
		url: referer,
		body: {event: event || ((payload || {}).data || [])[0], payload: payload},
		path: referer.substr(referer.indexOf(host) + host.length),
		headers: headers,
		_socket: socket
	};
};

Sockets.isUserOnline = function(uid) {
	winston.warn('[deprecated] Sockets.isUserOnline');
	return false;
};

Sockets.isUsersOnline = function(uids, callback) {
	winston.warn('[deprecated] Sockets.isUsersOnline');
	callback(null, uids.map(function() { return false; }));
};

Sockets.getUsersInRoom = function (uid, roomName, start, stop, callback) {
	winston.warn('[deprecated] Sockets.getUsersInRoom');
	callback(null, {
		users: [],
		room: roomName,
		total: 0,
		hidden: 0
	});
	return;
};

Sockets.getUidsInRoom = function(roomName, callback) {
	winston.warn('[deprecated] Sockets.getUidsInRoom');
	callback = callback || function() {};
	callback(null, []);
};


/* Exporting */
module.exports = Sockets;