codimd/lib/realtime.js

759 lines
24 KiB
JavaScript
Raw Normal View History

2015-05-04 07:53:29 +00:00
//realtime
//external modules
var cookie = require('cookie');
var cookieParser = require('cookie-parser');
var url = require('url');
var async = require('async');
var LZString = require('lz-string');
var randomcolor = require("randomcolor");
2015-06-01 10:04:25 +00:00
var Chance = require('chance'),
chance = new Chance();
2015-07-01 16:10:20 +00:00
var moment = require('moment');
2015-05-04 07:53:29 +00:00
//core
var config = require("./config.js");
2015-07-01 16:10:20 +00:00
var logger = require("./logger.js");
var models = require("./models");
2015-05-04 07:53:29 +00:00
//ot
var ot = require("./ot/index.js");
2015-05-04 07:53:29 +00:00
//public
var realtime = {
io: null,
2015-06-01 10:04:25 +00:00
onAuthorizeSuccess: onAuthorizeSuccess,
onAuthorizeFail: onAuthorizeFail,
2015-05-04 07:53:29 +00:00
secure: secure,
connection: connection,
getStatus: getStatus,
isReady: isReady
2015-05-04 07:53:29 +00:00
};
2015-06-01 10:04:25 +00:00
function onAuthorizeSuccess(data, accept) {
accept();
2015-06-01 10:04:25 +00:00
}
function onAuthorizeFail(data, message, error, accept) {
accept(); //accept whether authorize or not to allow anonymous usage
2015-06-01 10:04:25 +00:00
}
//secure the origin by the cookie
2015-05-04 07:53:29 +00:00
function secure(socket, next) {
try {
var handshakeData = socket.request;
if (handshakeData.headers.cookie) {
handshakeData.cookie = cookie.parse(handshakeData.headers.cookie);
handshakeData.sessionID = cookieParser.signedCookie(handshakeData.cookie[config.sessionname], config.sessionsecret);
if (handshakeData.sessionID &&
handshakeData.cookie[config.sessionname] &&
handshakeData.cookie[config.sessionname] != handshakeData.sessionID) {
if (config.debug)
logger.info("AUTH success cookie: " + handshakeData.sessionID);
return next();
} else {
2015-05-04 07:53:29 +00:00
next(new Error('AUTH failed: Cookie is invalid.'));
}
} else {
next(new Error('AUTH failed: No cookie transmitted.'));
}
} catch (ex) {
next(new Error("AUTH failed:" + JSON.stringify(ex)));
}
}
function emitCheck(note) {
var out = {
updatetime: note.updatetime,
lastchangeuser: note.lastchangeuser,
lastchangeuserprofile: note.lastchangeuserprofile
};
realtime.io.to(note.id).emit('check', out);
}
2015-05-04 07:53:29 +00:00
//actions
var users = {};
var notes = {};
//update when the note is dirty
2015-05-04 07:53:29 +00:00
var updater = setInterval(function () {
async.each(Object.keys(notes), function (key, callback) {
var note = notes[key];
if (note.server.isDirty) {
if (config.debug) logger.info("updater found dirty note: " + key);
updateNote(note, function(err, _note) {
if (!_note) {
realtime.io.to(note.id).emit('info', {
code: 404
});
logger.error('note not found: ', note.id);
}
if (err || !_note) {
for (var i = 0, l = note.socks.length; i < l; i++) {
var sock = note.socks[i];
sock.disconnect(true);
}
return callback(err, null);
}
note.server.isDirty = false;
note.updatetime = moment(_note.lastchangeAt).valueOf();
emitCheck(note);
return callback(null, null);
});
} else {
return callback(null, null);
2015-05-04 07:53:29 +00:00
}
}, function (err) {
2015-07-01 16:10:20 +00:00
if (err) return logger.error('updater error', err);
2015-05-04 07:53:29 +00:00
});
}, 1000);
function updateNote(note, callback) {
models.Note.findOne({
where: {
id: note.id
}
}).then(function (_note) {
if (!_note) return callback(null, null);
if (note.lastchangeuser) {
if (_note.lastchangeuserId != note.lastchangeuser) {
models.User.findOne({
where: {
id: note.lastchangeuser
}
}).then(function (user) {
if (!user) return callback(null, null);
note.lastchangeuserprofile = models.User.parseProfile(user.profile);
return finishUpdateNote(note, _note, callback);
}).catch(function (err) {
logger.error(err);
return callback(err, null);
});
} else {
return finishUpdateNote(note, _note, callback);
}
} else {
note.lastchangeuserprofile = null;
return finishUpdateNote(note, _note, callback);
}
}).catch(function (err) {
logger.error(err);
return callback(err, null);
});
}
function finishUpdateNote(note, _note, callback) {
var body = note.server.document;
var title = models.Note.parseNoteTitle(body);
title = LZString.compressToBase64(title);
body = LZString.compressToBase64(body);
var values = {
title: title,
content: body,
lastchangeuserId: note.lastchangeuser,
lastchangeAt: Date.now()
};
_note.update(values).then(function (_note) {
saverSleep = false;
return callback(null, _note);
}).catch(function (err) {
logger.error(err);
return callback(err, null);
});
}
//clean when user not in any rooms or user not in connected list
var cleaner = setInterval(function () {
async.each(Object.keys(users), function (key, callback) {
var socket = realtime.io.sockets.connected[key];
if ((!socket && users[key]) ||
(socket && (!socket.rooms || socket.rooms.length <= 0))) {
if (config.debug)
logger.info("cleaner found redundant user: " + key);
if (!socket) {
socket = {
id: key
};
}
disconnectSocketQueue.push(socket);
disconnect(socket);
}
return callback(null, null);
}, function (err) {
if (err) return logger.error('cleaner error', err);
});
}, 60000);
var saverSleep = true;
// save note revision in interval
var saver = setInterval(function () {
if (saverSleep) return;
models.Revision.saveAllNotesRevision(function (err, notes) {
if (err) return logger.error('revision saver failed: ' + err);
if (notes.length <= 0) {
saverSleep = true;
return;
}
});
}, 60000 * 5);
2015-05-04 07:53:29 +00:00
function getStatus(callback) {
models.Note.count().then(function (notecount) {
2015-05-04 07:53:29 +00:00
var distinctaddresses = [];
2015-07-01 16:10:20 +00:00
var regaddresses = [];
var distinctregaddresses = [];
2015-05-04 07:53:29 +00:00
Object.keys(users).forEach(function (key) {
2015-07-01 16:10:20 +00:00
var user = users[key];
2015-05-04 07:53:29 +00:00
var found = false;
for (var i = 0; i < distinctaddresses.length; i++) {
2015-07-01 16:10:20 +00:00
if (user.address == distinctaddresses[i]) {
2015-05-04 07:53:29 +00:00
found = true;
break;
}
}
2015-05-15 04:58:13 +00:00
if (!found) {
2015-07-01 16:10:20 +00:00
distinctaddresses.push(user.address);
}
if (user.login) {
regaddresses.push(user.address);
var found = false;
for (var i = 0; i < distinctregaddresses.length; i++) {
if (user.address == distinctregaddresses[i]) {
found = true;
break;
}
}
if (!found) {
distinctregaddresses.push(user.address);
}
2015-06-01 10:04:25 +00:00
}
2015-05-04 07:53:29 +00:00
});
models.User.count().then(function (regcount) {
return callback ? callback({
onlineNotes: Object.keys(notes).length,
onlineUsers: Object.keys(users).length,
distinctOnlineUsers: distinctaddresses.length,
notesCount: notecount,
registeredUsers: regcount,
onlineRegisteredUsers: regaddresses.length,
distinctOnlineRegisteredUsers: distinctregaddresses.length,
isConnectionBusy: isConnectionBusy,
connectionSocketQueueLength: connectionSocketQueue.length,
isDisconnectBusy: isDisconnectBusy,
disconnectSocketQueueLength: disconnectSocketQueue.length
}) : null;
}).catch(function (err) {
return logger.error('count user failed: ' + err);
2015-05-04 07:53:29 +00:00
});
}).catch(function (err) {
return logger.error('count note failed: ' + err);
2015-05-04 07:53:29 +00:00
});
}
function isReady() {
return realtime.io
&& Object.keys(notes).length == 0 && Object.keys(users).length == 0
&& connectionSocketQueue.length == 0 && !isConnectionBusy
&& disconnectSocketQueue.length == 0 && !isDisconnectBusy;
}
function extractNoteIdFromSocket(socket) {
if (!socket || !socket.handshake || !socket.handshake.headers) {
return false;
}
var referer = socket.handshake.headers.referer;
if (!referer) {
return false;
}
var hostUrl = url.parse(referer);
var noteId = config.urlpath ? hostUrl.pathname.slice(config.urlpath.length + 1, hostUrl.pathname.length).split('/')[1] : hostUrl.pathname.split('/')[1];
return noteId;
}
function parseNoteIdFromSocket(socket, callback) {
var noteId = extractNoteIdFromSocket(socket);
if (!noteId) {
return callback(null, null);
2015-05-04 07:53:29 +00:00
}
models.Note.parseNoteId(noteId, function (err, id) {
if (err || !id) return callback(err, id);
return callback(null, id);
});
2015-05-04 07:53:29 +00:00
}
function emitOnlineUsers(socket) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
2015-05-04 07:53:29 +00:00
var users = [];
Object.keys(notes[noteId].users).forEach(function (key) {
var user = notes[noteId].users[key];
2015-05-04 07:53:29 +00:00
if (user)
2015-06-01 10:04:25 +00:00
users.push(buildUserOutData(user));
2015-05-04 07:53:29 +00:00
});
2015-07-01 16:10:20 +00:00
var out = {
users: users
};
out = LZString.compressToUTF16(JSON.stringify(out));
realtime.io.to(noteId).emit('online users', out);
2015-06-01 10:04:25 +00:00
}
function emitUserStatus(socket) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
2015-07-01 16:10:20 +00:00
var out = buildUserOutData(users[socket.id]);
socket.broadcast.to(noteId).emit('user status', out);
2015-07-01 16:10:20 +00:00
}
function emitRefresh(socket) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
var note = notes[noteId];
2015-07-01 16:10:20 +00:00
socket.emit('refresh', {
docmaxlength: config.documentmaxlength,
2015-07-01 16:10:20 +00:00
owner: note.owner,
ownerprofile: note.ownerprofile,
lastchangeuser: note.lastchangeuser,
lastchangeuserprofile: note.lastchangeuserprofile,
2015-07-01 16:10:20 +00:00
permission: note.permission,
createtime: note.createtime,
2015-07-01 16:10:20 +00:00
updatetime: note.updatetime
2015-05-04 07:53:29 +00:00
});
}
function clearSocketQueue(queue, socket) {
for (var i = 0; i < queue.length; i++) {
if (!queue[i] || queue[i].id == socket.id) {
queue.splice(i, 1);
i--;
}
}
}
2015-05-04 07:53:29 +00:00
var isConnectionBusy = false;
var connectionSocketQueue = [];
var isDisconnectBusy = false;
var disconnectSocketQueue = [];
function finishConnection(socket, note, user) {
if (!socket || !note || !user) {
2016-07-02 08:12:48 +00:00
if (note) delete note;
if (user) delete user;
connectionSocketQueue.pop();
isConnectionBusy = false;
return;
}
//check view permission
if (note.permission == 'private') {
if (socket.request.user && socket.request.user.logged_in && socket.request.user.id == note.owner) {
//na
} else {
return failConnection(403, 'connection forbidden', socket);
}
}
note.users[socket.id] = user;
note.socks.push(socket);
note.server.addClient(socket);
note.server.setName(socket, user.name);
note.server.setColor(socket, user.color);
2015-05-04 07:53:29 +00:00
emitOnlineUsers(socket);
2015-07-01 16:10:20 +00:00
emitRefresh(socket);
2015-05-04 07:53:29 +00:00
//clear finished socket in queue
clearSocketQueue(connectionSocketQueue, socket);
2015-05-04 07:53:29 +00:00
//seek for next socket
isConnectionBusy = false;
if (connectionSocketQueue.length > 0)
startConnection(connectionSocketQueue[0]);
if (config.debug) {
var noteId = socket.noteId;
logger.info('SERVER connected a client to [' + noteId + ']:');
logger.info(JSON.stringify(user));
2015-07-01 16:10:20 +00:00
//logger.info(notes);
2015-05-04 07:53:29 +00:00
getStatus(function (data) {
2015-07-01 16:10:20 +00:00
logger.info(JSON.stringify(data));
2015-05-04 07:53:29 +00:00
});
}
}
function startConnection(socket) {
if (isConnectionBusy) return;
isConnectionBusy = true;
var noteId = socket.noteId;
if (!noteId) {
return failConnection(404, 'note id not found', socket);
}
2015-05-04 07:53:29 +00:00
if (!notes[noteId]) {
var include = [{
model: models.User,
as: "owner"
}, {
model: models.User,
as: "lastchangeuser"
}];
models.Note.findOne({
where: {
id: noteId
},
include: include
}).then(function (note) {
if (!note) {
return failConnection(404, 'note not found', socket);
2015-05-04 07:53:29 +00:00
}
var owner = note.ownerId;
var ownerprofile = note.owner ? models.User.parseProfile(note.owner.profile) : null;
var lastchangeuser = note.lastchangeuserId;
var lastchangeuserprofile = note.lastchangeuser ? models.User.parseProfile(note.lastchangeuser.profile) : null;
var body = LZString.decompressFromBase64(note.content);
var createtime = note.createdAt;
var updatetime = note.lastchangeAt;
var server = new ot.EditorSocketIOServer(body, [], noteId, ifMayEdit);
notes[noteId] = {
id: noteId,
owner: owner,
ownerprofile: ownerprofile,
permission: note.permission,
lastchangeuser: lastchangeuser,
lastchangeuserprofile: lastchangeuserprofile,
socks: [],
users: {},
createtime: moment(createtime).valueOf(),
updatetime: moment(updatetime).valueOf(),
server: server
};
return finishConnection(socket, notes[noteId], users[socket.id]);
}).catch(function (err) {
return failConnection(500, err, socket);
2015-05-04 07:53:29 +00:00
});
} else {
return finishConnection(socket, notes[noteId], users[socket.id]);
2015-05-04 07:53:29 +00:00
}
}
function failConnection(code, err, socket) {
logger.error(err);
// clear error socket in queue
clearSocketQueue(connectionSocketQueue, socket);
isConnectionBusy = false;
// emit error info
socket.emit('info', {
code: code
});
return socket.disconnect(true);
}
2015-05-04 07:53:29 +00:00
function disconnect(socket) {
if (isDisconnectBusy) return;
isDisconnectBusy = true;
if (config.debug) {
2015-07-01 16:10:20 +00:00
logger.info("SERVER disconnected a client");
logger.info(JSON.stringify(users[socket.id]));
2015-05-04 07:53:29 +00:00
}
2015-05-04 07:53:29 +00:00
if (users[socket.id]) {
delete users[socket.id];
}
var noteId = socket.noteId;
var note = notes[noteId];
if (note) {
delete note.users[socket.id];
2015-07-01 16:10:20 +00:00
do {
var index = note.socks.indexOf(socket);
2015-07-01 16:10:20 +00:00
if (index != -1) {
note.socks.splice(index, 1);
2015-07-01 16:10:20 +00:00
}
} while (index != -1);
if (Object.keys(note.users).length <= 0) {
if (note.server.isDirty) {
updateNote(note, function (err, _note) {
if (err) return logger.error('disconnect note failed: ' + err);
delete notes[noteId];
if (config.debug) {
//logger.info(notes);
getStatus(function (data) {
logger.info(JSON.stringify(data));
});
}
});
2015-07-01 16:10:20 +00:00
} else {
delete notes[noteId];
2015-07-01 16:10:20 +00:00
}
2015-05-04 07:53:29 +00:00
}
}
emitOnlineUsers(socket);
//clear finished socket in queue
clearSocketQueue(disconnectSocketQueue, socket);
2015-05-04 07:53:29 +00:00
//seek for next socket
isDisconnectBusy = false;
if (disconnectSocketQueue.length > 0)
disconnect(disconnectSocketQueue[0]);
if (config.debug) {
2015-07-01 16:10:20 +00:00
//logger.info(notes);
2015-05-04 07:53:29 +00:00
getStatus(function (data) {
2015-07-01 16:10:20 +00:00
logger.info(JSON.stringify(data));
2015-05-04 07:53:29 +00:00
});
}
}
2015-06-01 10:04:25 +00:00
function buildUserOutData(user) {
var out = {
id: user.id,
login: user.login,
userid: user.userid,
2015-07-04 14:19:09 +00:00
photo: user.photo,
2015-06-01 10:04:25 +00:00
color: user.color,
cursor: user.cursor,
name: user.name,
idle: user.idle,
type: user.type
};
return out;
}
function updateUserData(socket, user) {
//retrieve user data from passport
if (socket.request.user && socket.request.user.logged_in) {
var profile = models.User.parseProfile(socket.request.user.profile);
user.photo = profile.photo;
user.name = profile.name;
user.userid = socket.request.user.id;
2015-06-01 10:04:25 +00:00
user.login = true;
} else {
user.userid = null;
user.name = 'Guest ' + chance.last();
user.login = false;
}
}
2015-05-04 07:53:29 +00:00
function ifMayEdit(socket, callback) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
var note = notes[noteId];
var mayEdit = true;
switch (note.permission) {
case "freely":
//not blocking anyone
break;
case "editable":
//only login user can change
if (!socket.request.user || !socket.request.user.logged_in)
mayEdit = false;
break;
case "locked": case "private":
//only owner can change
if (!note.owner || note.owner != socket.request.user.id)
mayEdit = false;
break;
}
//if user may edit and this note have owner (not anonymous usage)
if (socket.origin == 'operation' && mayEdit && note.owner) {
//save for the last change user id
if (socket.request.user && socket.request.user.logged_in) {
note.lastchangeuser = socket.request.user.id;
} else {
note.lastchangeuser = null;
}
}
return callback(mayEdit);
}
2015-05-04 07:53:29 +00:00
function connection(socket) {
if (config.maintenance) return;
parseNoteIdFromSocket(socket, function (err, noteId) {
if (err) {
return failConnection(500, err, socket);
}
if (!noteId) {
return failConnection(404, 'note id not found', socket);
}
// store noteId in this socket session
socket.noteId = noteId;
//initialize user data
//random color
var color = randomcolor({
luminosity: 'light'
});
//make sure color not duplicated or reach max random count
if (notes[noteId]) {
var randomcount = 0;
var maxrandomcount = 5;
var found = false;
do {
Object.keys(notes[noteId].users).forEach(function (user) {
if (user.color == color) {
found = true;
return;
}
2015-06-01 10:04:25 +00:00
});
if (found) {
color = randomcolor({
luminosity: 'light'
});
randomcount++;
}
} while (found && randomcount < maxrandomcount);
}
//create user data
users[socket.id] = {
id: socket.id,
address: socket.handshake.headers['x-forwarded-for'] || socket.handshake.address,
'user-agent': socket.handshake.headers['user-agent'],
color: color,
cursor: null,
login: false,
userid: null,
name: null,
idle: false,
type: null
};
updateUserData(socket, users[socket.id]);
2015-05-04 07:53:29 +00:00
//start connection
connectionSocketQueue.push(socket);
startConnection(socket);
});
2015-05-04 07:53:29 +00:00
2015-07-01 16:10:20 +00:00
//received client refresh request
socket.on('refresh', function () {
emitRefresh(socket);
});
2015-06-01 10:04:25 +00:00
//received user status
2015-05-04 07:53:29 +00:00
socket.on('user status', function (data) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
2015-06-01 10:04:25 +00:00
if (config.debug)
logger.info('SERVER received [' + noteId + '] user status from [' + socket.id + ']: ' + JSON.stringify(data));
2015-06-01 10:04:25 +00:00
if (data) {
var user = users[socket.id];
user.idle = data.idle;
user.type = data.type;
}
emitUserStatus(socket);
2015-05-04 07:53:29 +00:00
});
2015-07-01 16:10:20 +00:00
//received note permission change request
socket.on('permission', function (permission) {
//need login to do more actions
if (socket.request.user && socket.request.user.logged_in) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
var note = notes[noteId];
2015-07-01 16:10:20 +00:00
//Only owner can change permission
if (note.owner && note.owner == socket.request.user.id) {
2015-07-01 16:10:20 +00:00
note.permission = permission;
models.Note.update({
permission: permission
}, {
where: {
id: noteId
}
}).then(function (count) {
if (!count) {
2015-07-01 16:10:20 +00:00
return;
}
var out = {
permission: permission
};
realtime.io.to(note.id).emit('permission', out);
for (var i = 0, l = note.socks.length; i < l; i++) {
var sock = note.socks[i];
if (typeof sock !== 'undefined' && sock) {
//check view permission
if (permission == 'private') {
if (sock.request.user && sock.request.user.logged_in && sock.request.user.id == note.owner) {
//na
} else {
sock.emit('info', {
code: 403
});
return sock.disconnect(true);
}
}
}
}
}).catch(function (err) {
return logger.error('update note permission failed: ' + err);
2015-07-01 16:10:20 +00:00
});
}
}
});
2015-06-01 10:04:25 +00:00
//reveiced when user logout or changed
socket.on('user changed', function () {
2015-07-01 16:10:20 +00:00
logger.info('user changed');
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
updateUserData(socket, notes[noteId].users[socket.id]);
2015-05-04 07:53:29 +00:00
emitOnlineUsers(socket);
});
2015-06-01 10:04:25 +00:00
//received sync of online users request
socket.on('online users', function () {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
2015-06-01 10:04:25 +00:00
var users = [];
Object.keys(notes[noteId].users).forEach(function (key) {
var user = notes[noteId].users[key];
2015-06-01 10:04:25 +00:00
if (user)
users.push(buildUserOutData(user));
});
var out = {
users: users
};
out = LZString.compressToUTF16(JSON.stringify(out));
socket.emit('online users', out);
});
//check version
2015-05-04 07:53:29 +00:00
socket.on('version', function () {
socket.emit('version', {
version: config.version,
minimumCompatibleVersion: config.minimumCompatibleVersion
});
2015-05-04 07:53:29 +00:00
});
2015-06-01 10:04:25 +00:00
//received cursor focus
2015-05-04 07:53:29 +00:00
socket.on('cursor focus', function (data) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
2015-05-04 07:53:29 +00:00
users[socket.id].cursor = data;
2015-06-01 10:04:25 +00:00
var out = buildUserOutData(users[socket.id]);
socket.broadcast.to(noteId).emit('cursor focus', out);
2015-05-04 07:53:29 +00:00
});
2015-06-01 10:04:25 +00:00
//received cursor activity
2015-05-04 07:53:29 +00:00
socket.on('cursor activity', function (data) {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
2015-05-04 07:53:29 +00:00
users[socket.id].cursor = data;
2015-06-01 10:04:25 +00:00
var out = buildUserOutData(users[socket.id]);
socket.broadcast.to(noteId).emit('cursor activity', out);
2015-05-04 07:53:29 +00:00
});
2015-06-01 10:04:25 +00:00
//received cursor blur
2015-05-04 07:53:29 +00:00
socket.on('cursor blur', function () {
var noteId = socket.noteId;
if (!noteId || !notes[noteId]) return;
2015-05-04 07:53:29 +00:00
users[socket.id].cursor = null;
2015-06-01 10:04:25 +00:00
var out = {
id: socket.id
};
socket.broadcast.to(noteId).emit('cursor blur', out);
2015-05-04 07:53:29 +00:00
});
//when a new client disconnect
socket.on('disconnect', function () {
disconnectSocketQueue.push(socket);
disconnect(socket);
});
}
module.exports = realtime;