hedgedoc/lib/realtime.js

516 lines
16 KiB
JavaScript
Raw Normal View History

2015-05-04 03:53:29 -04: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 shortId = require('shortid');
var randomcolor = require("randomcolor");
2015-06-01 06:04:25 -04:00
var Chance = require('chance'),
chance = new Chance();
2015-05-04 03:53:29 -04:00
//core
var config = require("../config.js");
//others
var db = require("./db.js");
var Note = require("./note.js");
var User = require("./user.js");
//public
var realtime = {
2015-06-01 06:04:25 -04:00
onAuthorizeSuccess: onAuthorizeSuccess,
onAuthorizeFail: onAuthorizeFail,
2015-05-04 03:53:29 -04:00
secure: secure,
connection: connection,
getStatus: getStatus
};
2015-06-01 06:04:25 -04:00
function onAuthorizeSuccess(data, accept) {
accept(null, true);
}
function onAuthorizeFail(data, message, error, accept) {
if (error) throw new Error(message);
accept(null, true);
}
2015-05-04 03:53:29 -04: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.cookie[config.sessionname] == handshakeData.sessionID) {
next(new Error('AUTH failed: Cookie is invalid.'));
}
} else {
next(new Error('AUTH failed: No cookie transmitted.'));
}
if (config.debug)
console.log("AUTH success cookie: " + handshakeData.sessionID);
next();
} catch (ex) {
next(new Error("AUTH failed:" + JSON.stringify(ex)));
}
}
//actions
var users = {};
var notes = {};
var updater = setInterval(function () {
async.each(Object.keys(notes), function (key, callback) {
var note = notes[key];
if (note.isDirty) {
if (config.debug)
console.log("updater found dirty note: " + key);
2015-06-01 06:04:25 -04:00
var body = LZString.decompressFromUTF16(note.body);
var title = Note.getNoteTitle(body);
body = LZString.compressToBase64(body);
db.saveToDB(key, title, body,
2015-05-04 03:53:29 -04:00
function (err, result) {});
note.isDirty = false;
}
callback();
}, function (err) {
if (err) return console.error('updater error', err);
});
}, 5000);
function getStatus(callback) {
db.countFromDB(function (err, data) {
if (err) return console.log(err);
var regusers = 0;
var distinctregusers = 0;
var distinctaddresses = [];
Object.keys(users).forEach(function (key) {
var value = users[key];
2015-06-01 06:04:25 -04:00
if (value.login)
2015-05-04 03:53:29 -04:00
regusers++;
var found = false;
for (var i = 0; i < distinctaddresses.length; i++) {
if (value.address == distinctaddresses[i]) {
found = true;
break;
}
}
2015-05-15 00:58:13 -04:00
if (!found) {
2015-05-04 03:53:29 -04:00
distinctaddresses.push(value.address);
2015-06-01 06:04:25 -04:00
if (value.login)
2015-05-15 00:58:13 -04:00
distinctregusers++;
2015-06-01 06:04:25 -04:00
}
2015-05-04 03:53:29 -04:00
});
User.getUserCount(function (err, regcount) {
if (err) {
console.log('get status failed: ' + err);
return;
}
if (callback)
callback({
onlineNotes: Object.keys(notes).length,
onlineUsers: Object.keys(users).length,
distinctOnlineUsers: distinctaddresses.length,
notesCount: data.rows[0].count,
registeredUsers: regcount,
onlineRegisteredUsers: regusers,
distinctOnlineRegisteredUsers: distinctregusers
});
});
});
}
function getNotenameFromSocket(socket) {
var hostUrl = url.parse(socket.handshake.headers.referer);
var notename = hostUrl.pathname.split('/')[1];
if (notename == config.featuresnotename) {
return notename;
}
if (!Note.checkNoteIdValid(notename)) {
socket.emit('info', {
code: 404
});
return socket.disconnect();
}
notename = LZString.decompressFromBase64(notename);
return notename;
}
function emitOnlineUsers(socket) {
var notename = getNotenameFromSocket(socket);
if (!notename || !notes[notename]) return;
var users = [];
Object.keys(notes[notename].users).forEach(function (key) {
var user = notes[notename].users[key];
if (user)
2015-06-01 06:04:25 -04:00
users.push(buildUserOutData(user));
2015-05-04 03:53:29 -04:00
});
notes[notename].socks.forEach(function (sock) {
2015-06-01 06:04:25 -04:00
var out = {
2015-05-04 03:53:29 -04:00
users: users
2015-06-01 06:04:25 -04:00
};
out = LZString.compressToUTF16(JSON.stringify(out));
sock.emit('online users', out);
});
}
function emitUserStatus(socket) {
var notename = getNotenameFromSocket(socket);
if (!notename || !notes[notename]) return;
notes[notename].socks.forEach(function (sock) {
if (sock != socket) {
var out = buildUserOutData(users[socket.id]);
sock.emit('user status', out);
}
2015-05-04 03:53:29 -04:00
});
}
var isConnectionBusy = false;
var connectionSocketQueue = [];
var isDisconnectBusy = false;
var disconnectSocketQueue = [];
function finishConnection(socket, notename) {
notes[notename].users[socket.id] = users[socket.id];
notes[notename].socks.push(socket);
emitOnlineUsers(socket);
socket.emit('refresh', {
body: notes[notename].body
});
//clear finished socket in queue
for (var i = 0; i < connectionSocketQueue.length; i++) {
if (connectionSocketQueue[i].id == socket.id)
connectionSocketQueue.splice(i, 1);
}
//seek for next socket
isConnectionBusy = false;
if (connectionSocketQueue.length > 0)
startConnection(connectionSocketQueue[0]);
if (config.debug) {
console.log('SERVER connected a client to [' + notename + ']:');
console.log(JSON.stringify(users[socket.id]));
//console.log(notes);
getStatus(function (data) {
console.log(JSON.stringify(data));
});
}
}
function startConnection(socket) {
if (isConnectionBusy) return;
isConnectionBusy = true;
var notename = getNotenameFromSocket(socket);
if (!notename) return;
if (!notes[notename]) {
db.readFromDB(notename, function (err, data) {
if (err) {
socket.emit('info', {
code: 404
});
socket.disconnect();
//clear err socket in queue
for (var i = 0; i < connectionSocketQueue.length; i++) {
if (connectionSocketQueue[i].id == socket.id)
connectionSocketQueue.splice(i, 1);
}
isConnectionBusy = false;
return console.error(err);
}
2015-06-01 06:04:25 -04:00
var body = LZString.decompressFromBase64(data.rows[0].content);
body = LZString.compressToUTF16(body);
2015-05-04 03:53:29 -04:00
notes[notename] = {
socks: [],
body: body,
isDirty: false,
users: {}
};
finishConnection(socket, notename);
});
} else {
finishConnection(socket, notename);
}
}
function disconnect(socket) {
if (isDisconnectBusy) return;
isDisconnectBusy = true;
if (config.debug) {
console.log("SERVER disconnected a client");
console.log(JSON.stringify(users[socket.id]));
}
var notename = getNotenameFromSocket(socket);
if (!notename) return;
if (users[socket.id]) {
delete users[socket.id];
}
if (notes[notename]) {
delete notes[notename].users[socket.id];
var index = notes[notename].socks.indexOf(socket);
if (index > -1) {
notes[notename].socks.splice(index, 1);
}
if (Object.keys(notes[notename].users).length <= 0) {
2015-06-01 06:04:25 -04:00
var body = LZString.decompressFromUTF16(notes[notename].body);
var title = Note.getNoteTitle(body);
body = LZString.compressToBase64(body);
db.saveToDB(notename, title, body,
2015-05-04 03:53:29 -04:00
function (err, result) {
delete notes[notename];
if (config.debug) {
//console.log(notes);
getStatus(function (data) {
console.log(JSON.stringify(data));
});
}
});
}
}
emitOnlineUsers(socket);
//clear finished socket in queue
for (var i = 0; i < disconnectSocketQueue.length; i++) {
if (disconnectSocketQueue[i].id == socket.id)
disconnectSocketQueue.splice(i, 1);
}
//seek for next socket
isDisconnectBusy = false;
if (disconnectSocketQueue.length > 0)
disconnect(disconnectSocketQueue[0]);
if (config.debug) {
//console.log(notes);
getStatus(function (data) {
console.log(JSON.stringify(data));
});
}
}
2015-06-01 06:04:25 -04:00
function buildUserOutData(user) {
var out = {
id: user.id,
login: user.login,
userid: user.userid,
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 = JSON.parse(socket.request.user.profile);
user.name = profile.displayName || profile.username;
user.userid = socket.request.user._id;
user.login = true;
} else {
user.userid = null;
user.name = 'Guest ' + chance.last();
user.login = false;
}
}
2015-05-04 03:53:29 -04:00
function connection(socket) {
2015-06-01 06:04:25 -04:00
//split notename from socket
var notename = getNotenameFromSocket(socket);
//initialize user data
//random color
var color = randomcolor({
luminosity: 'light'
});
//make sure color not duplicated or reach max random count
if (notename && notes[notename]) {
var randomcount = 0;
var maxrandomcount = 5;
var found = false;
do {
Object.keys(notes[notename].users).forEach(function (user) {
if (user.color == color) {
found = true;
return;
}
});
if (found) {
color = randomcolor({
luminosity: 'light'
});
randomcount++;
}
} while (found && randomcount < maxrandomcount);
}
//create user data
2015-05-04 03:53:29 -04:00
users[socket.id] = {
id: socket.id,
address: socket.handshake.address,
'user-agent': socket.handshake.headers['user-agent'],
otk: shortId.generate(),
2015-06-01 06:04:25 -04:00
color: color,
2015-05-04 03:53:29 -04:00
cursor: null,
2015-06-01 06:04:25 -04:00
login: false,
userid: null,
name: null,
idle: false,
type: null
2015-05-04 03:53:29 -04:00
};
2015-06-01 06:04:25 -04:00
updateUserData(socket, users[socket.id]);
2015-05-04 03:53:29 -04:00
2015-06-01 06:04:25 -04:00
//start connection
2015-05-04 03:53:29 -04:00
connectionSocketQueue.push(socket);
startConnection(socket);
//when a new client coming or received a client refresh request
socket.on('refresh', function (body_) {
var notename = getNotenameFromSocket(socket);
if (!notename) return;
if (config.debug)
console.log('SERVER received [' + notename + '] data updated: ' + socket.id);
if (notes[notename].body != body_) {
notes[notename].body = body_;
notes[notename].isDirty = true;
}
});
2015-06-01 06:04:25 -04:00
//received user status
2015-05-04 03:53:29 -04:00
socket.on('user status', function (data) {
2015-06-01 06:04:25 -04:00
var notename = getNotenameFromSocket(socket);
if (!notename) return;
if (config.debug)
console.log('SERVER received [' + notename + '] user status from [' + socket.id + ']: ' + JSON.stringify(data));
if (data) {
var user = users[socket.id];
user.idle = data.idle;
user.type = data.type;
}
emitUserStatus(socket);
2015-05-04 03:53:29 -04:00
});
2015-06-01 06:04:25 -04:00
//reveiced when user logout or changed
socket.on('user changed', function () {
console.log('user changed');
var notename = getNotenameFromSocket(socket);
if (!notename || !notes[notename]) return;
updateUserData(socket, notes[notename].users[socket.id]);
2015-05-04 03:53:29 -04:00
emitOnlineUsers(socket);
});
2015-06-01 06:04:25 -04:00
//received sync of online users request
socket.on('online users', function () {
var notename = getNotenameFromSocket(socket);
if (!notename || !notes[notename]) return;
var users = [];
Object.keys(notes[notename].users).forEach(function (key) {
var user = notes[notename].users[key];
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 03:53:29 -04:00
socket.on('version', function () {
socket.emit('version', config.version);
});
2015-06-01 06:04:25 -04:00
//received cursor focus
2015-05-04 03:53:29 -04:00
socket.on('cursor focus', function (data) {
var notename = getNotenameFromSocket(socket);
if (!notename || !notes[notename]) return;
users[socket.id].cursor = data;
2015-06-01 06:04:25 -04:00
var out = buildUserOutData(users[socket.id]);
2015-05-04 03:53:29 -04:00
notes[notename].socks.forEach(function (sock) {
if (sock != socket) {
sock.emit('cursor focus', out);
}
});
});
2015-06-01 06:04:25 -04:00
//received cursor activity
2015-05-04 03:53:29 -04:00
socket.on('cursor activity', function (data) {
var notename = getNotenameFromSocket(socket);
if (!notename || !notes[notename]) return;
users[socket.id].cursor = data;
2015-06-01 06:04:25 -04:00
var out = buildUserOutData(users[socket.id]);
2015-05-04 03:53:29 -04:00
notes[notename].socks.forEach(function (sock) {
if (sock != socket) {
sock.emit('cursor activity', out);
}
});
});
2015-06-01 06:04:25 -04:00
//received cursor blur
2015-05-04 03:53:29 -04:00
socket.on('cursor blur', function () {
var notename = getNotenameFromSocket(socket);
if (!notename || !notes[notename]) return;
users[socket.id].cursor = null;
2015-06-01 06:04:25 -04:00
var out = {
id: socket.id
};
2015-05-04 03:53:29 -04:00
notes[notename].socks.forEach(function (sock) {
if (sock != socket) {
if (sock != socket) {
sock.emit('cursor blur', out);
}
}
});
});
//when a new client disconnect
socket.on('disconnect', function () {
disconnectSocketQueue.push(socket);
disconnect(socket);
});
//when received client change data request
socket.on('change', function (op) {
var notename = getNotenameFromSocket(socket);
if (!notename) return;
2015-06-01 06:04:25 -04:00
op = LZString.decompressFromUTF16(op);
2015-05-04 03:53:29 -04:00
if (op)
op = JSON.parse(op);
if (config.debug)
console.log('SERVER received [' + notename + '] data changed: ' + socket.id + ', op:' + JSON.stringify(op));
switch (op.origin) {
case '+input':
case '+delete':
2015-05-15 00:58:13 -04:00
case '+transpose':
2015-05-04 03:53:29 -04:00
case 'paste':
case 'cut':
case 'undo':
case 'redo':
case 'drag':
2015-05-15 00:58:13 -04:00
case '*compose':
case 'case':
case '+insertLine':
case '+swapLine':
case '+joinLines':
case '+duplicateLine':
case '+sortLines':
2015-05-04 03:53:29 -04:00
notes[notename].socks.forEach(function (sock) {
if (sock != socket) {
if (config.debug)
console.log('SERVER emit sync data out [' + notename + ']: ' + sock.id + ', op:' + JSON.stringify(op));
2015-06-01 06:04:25 -04:00
sock.emit('change', LZString.compressToUTF16(JSON.stringify(op)));
2015-05-04 03:53:29 -04:00
}
});
break;
2015-06-01 06:04:25 -04:00
default:
console.log('SERVER received uncaught [' + notename + '] data changed: ' + socket.id + ', op:' + JSON.stringify(op));
2015-05-04 03:53:29 -04:00
}
});
}
module.exports = realtime;