mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-28 14:10:57 -05:00
2eb4c8e05f
Connection forbidden errors cause cleanup of note state without first
checking if other clients are still connected to the note. This leads
to inconsistent pad content and changes not being saved properly.
This change reverts parts of 725e982 (Fix realtime on forbidden not clean
up properly ...). The call to `interruptConnection()` on permission errors
is redundant, since `failConnection()` and `disconnect()` already perform
all required cleanup in this case. The other call to `interruptConnection()`
only happens when a client (the first client for a note) disconnects while
the note is being loaded from the database. It is refactored for clarity.
Fixes #3894
Co-authored-by: David Mehren <git@herrmehren.de>
Signed-off-by: Julian Rother <julian@jrother.eu>
921 lines
26 KiB
JavaScript
921 lines
26 KiB
JavaScript
'use strict'
|
|
// realtime
|
|
// external modules
|
|
const cookie = require('cookie')
|
|
const cookieParser = require('cookie-parser')
|
|
const async = require('async')
|
|
const randomcolor = require('randomcolor')
|
|
const Chance = require('chance')
|
|
const chance = new Chance()
|
|
const moment = require('moment')
|
|
|
|
// core
|
|
const config = require('./config')
|
|
const logger = require('./logger')
|
|
const history = require('./history')
|
|
const models = require('./models')
|
|
|
|
// ot
|
|
const ot = require('./ot')
|
|
|
|
// public
|
|
const realtime = {
|
|
io: null,
|
|
onAuthorizeSuccess,
|
|
onAuthorizeFail,
|
|
secure,
|
|
connection,
|
|
getStatus,
|
|
isReady,
|
|
maintenance: true
|
|
}
|
|
|
|
function onAuthorizeSuccess (data, accept) {
|
|
accept()
|
|
}
|
|
|
|
function onAuthorizeFail (data, message, error, accept) {
|
|
accept() // accept whether authorize or not to allow anonymous usage
|
|
}
|
|
|
|
// secure the origin by the cookie
|
|
function secure (socket, next) {
|
|
try {
|
|
const 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) {
|
|
logger.debug(`AUTH success cookie: ${handshakeData.sessionID}`)
|
|
return next()
|
|
} else {
|
|
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) {
|
|
const out = {
|
|
title: note.title,
|
|
updatetime: note.updatetime,
|
|
lastchangeuser: note.lastchangeuser,
|
|
lastchangeuserprofile: note.lastchangeuserprofile,
|
|
authors: note.authors,
|
|
authorship: note.authorship
|
|
}
|
|
realtime.io.to(note.id).emit('check', out)
|
|
}
|
|
|
|
// actions
|
|
const users = {}
|
|
const notes = {}
|
|
// update when the note is dirty
|
|
setInterval(function () {
|
|
async.each(Object.keys(notes), function (key, callback) {
|
|
const note = notes[key]
|
|
if (note.server.isDirty) {
|
|
logger.debug(`updater found dirty note: ${key}`)
|
|
note.server.isDirty = false
|
|
updateNote(note, function (err, _note) {
|
|
// handle when note already been clean up
|
|
if (!notes[key] || !notes[key].server) return callback(null, null)
|
|
if (!_note) {
|
|
realtime.io.to(note.id).emit('info', {
|
|
code: 404
|
|
})
|
|
logger.error('note not found: ', note.id)
|
|
}
|
|
if (err || !_note) {
|
|
for (let i = 0, l = note.socks.length; i < l; i++) {
|
|
const sock = note.socks[i]
|
|
if (typeof sock !== 'undefined' && sock) {
|
|
setTimeout(function () {
|
|
sock.disconnect(true)
|
|
}, 0)
|
|
}
|
|
}
|
|
return callback(err, null)
|
|
}
|
|
note.updatetime = moment(_note.lastchangeAt).valueOf()
|
|
emitCheck(note)
|
|
return callback(null, null)
|
|
})
|
|
} else {
|
|
return callback(null, null)
|
|
}
|
|
}, function (err) {
|
|
if (err) return logger.error('updater error', err)
|
|
})
|
|
}, 1000)
|
|
|
|
function updateNote (note, callback) {
|
|
models.Note.findOne({
|
|
where: {
|
|
id: note.id
|
|
}
|
|
}).then(function (_note) {
|
|
if (!_note) return callback(null, null)
|
|
// update user note history
|
|
const tempUsers = Object.assign({}, note.tempUsers)
|
|
note.tempUsers = {}
|
|
Object.keys(tempUsers).forEach(function (key) {
|
|
updateHistory(key, note, tempUsers[key])
|
|
})
|
|
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.getProfile(user)
|
|
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) {
|
|
if (!note || !note.server) return callback(null, null)
|
|
const body = note.server.document
|
|
const title = note.title = models.Note.parseNoteTitle(body)
|
|
const values = {
|
|
title,
|
|
content: body,
|
|
authorship: note.authorship,
|
|
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
|
|
setInterval(function () {
|
|
async.each(Object.keys(users), function (key, callback) {
|
|
let socket = realtime.io.sockets.connected[key]
|
|
if ((!socket && users[key]) ||
|
|
(socket && (!socket.rooms || socket.rooms.length <= 0))) {
|
|
logger.debug(`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)
|
|
|
|
let saverSleep = false
|
|
// save note revision in interval
|
|
setInterval(function () {
|
|
if (saverSleep) return
|
|
models.Revision.saveAllNotesRevision(function (err, notes) {
|
|
if (err) return logger.error('revision saver failed: ' + err)
|
|
if (notes && notes.length <= 0) {
|
|
saverSleep = true
|
|
}
|
|
})
|
|
}, 60000 * 5)
|
|
|
|
function getStatus (callback) {
|
|
models.Note.count().then(function (notecount) {
|
|
const distinctaddresses = []
|
|
const regaddresses = []
|
|
const distinctregaddresses = []
|
|
Object.keys(users).forEach(function (key) {
|
|
const user = users[key]
|
|
if (!user) return
|
|
let found = false
|
|
for (let i = 0; i < distinctaddresses.length; i++) {
|
|
if (user.address === distinctaddresses[i]) {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
if (!found) {
|
|
distinctaddresses.push(user.address)
|
|
}
|
|
if (user.login) {
|
|
regaddresses.push(user.address)
|
|
let found = false
|
|
for (let i = 0; i < distinctregaddresses.length; i++) {
|
|
if (user.address === distinctregaddresses[i]) {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
if (!found) {
|
|
distinctregaddresses.push(user.address)
|
|
}
|
|
}
|
|
})
|
|
models.User.count().then(function (regcount) {
|
|
return callback
|
|
// eslint-disable-next-line n/no-callback-literal
|
|
? 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,
|
|
connectionSocketQueueLength: connectionSocketQueue.length,
|
|
isDisconnectBusy,
|
|
disconnectSocketQueueLength: disconnectSocketQueue.length
|
|
})
|
|
: null
|
|
}).catch(function (err) {
|
|
return logger.error('count user failed: ' + err)
|
|
})
|
|
}).catch(function (err) {
|
|
return logger.error('count note failed: ' + err)
|
|
})
|
|
}
|
|
|
|
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) {
|
|
return false
|
|
}
|
|
if (socket.handshake.query && socket.handshake.query.noteId) {
|
|
return socket.handshake.query.noteId
|
|
} else {
|
|
return false
|
|
}
|
|
}
|
|
|
|
function parseNoteIdFromSocket (socket, callback) {
|
|
const noteId = extractNoteIdFromSocket(socket)
|
|
if (!noteId) {
|
|
return callback(null, null)
|
|
}
|
|
models.Note.parseNoteId(noteId, function (err, id) {
|
|
if (err || !id) return callback(err, id)
|
|
return callback(null, id)
|
|
})
|
|
}
|
|
|
|
function emitOnlineUsers (socket) {
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const users = []
|
|
Object.keys(notes[noteId].users).forEach(function (key) {
|
|
const user = notes[noteId].users[key]
|
|
if (user) { users.push(buildUserOutData(user)) }
|
|
})
|
|
const out = {
|
|
users
|
|
}
|
|
realtime.io.to(noteId).emit('online users', out)
|
|
}
|
|
|
|
function emitUserStatus (socket) {
|
|
const noteId = socket.noteId
|
|
const user = users[socket.id]
|
|
if (!noteId || !notes[noteId] || !user) return
|
|
const out = buildUserOutData(user)
|
|
socket.broadcast.to(noteId).emit('user status', out)
|
|
}
|
|
|
|
function emitRefresh (socket) {
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const note = notes[noteId]
|
|
const out = {
|
|
title: note.title,
|
|
docmaxlength: config.documentMaxLength,
|
|
owner: note.owner,
|
|
ownerprofile: note.ownerprofile,
|
|
lastchangeuser: note.lastchangeuser,
|
|
lastchangeuserprofile: note.lastchangeuserprofile,
|
|
authors: note.authors,
|
|
authorship: note.authorship,
|
|
permission: note.permission,
|
|
createtime: note.createtime,
|
|
updatetime: note.updatetime
|
|
}
|
|
socket.emit('refresh', out)
|
|
}
|
|
|
|
function isDuplicatedInSocketQueue (queue, socket) {
|
|
for (let i = 0; i < queue.length; i++) {
|
|
if (queue[i] && queue[i].id === socket.id) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
function clearSocketQueue (queue, socket) {
|
|
for (let i = 0; i < queue.length; i++) {
|
|
if (!queue[i] || queue[i].id === socket.id) {
|
|
queue.splice(i, 1)
|
|
i--
|
|
}
|
|
}
|
|
}
|
|
|
|
function connectNextSocket () {
|
|
setTimeout(function () {
|
|
isConnectionBusy = false
|
|
if (connectionSocketQueue.length > 0) {
|
|
startConnection(connectionSocketQueue[0])
|
|
}
|
|
}, 1)
|
|
}
|
|
|
|
function checkViewPermission (req, note) {
|
|
if (note.permission === 'private') {
|
|
if (req.user && req.user.logged_in && req.user.id === note.owner) { return true } else { return false }
|
|
} else if (note.permission === 'limited' || note.permission === 'protected') {
|
|
if (req.user && req.user.logged_in) { return true } else { return false }
|
|
} else {
|
|
return true
|
|
}
|
|
}
|
|
|
|
let isConnectionBusy = false
|
|
const connectionSocketQueue = []
|
|
let isDisconnectBusy = false
|
|
const disconnectSocketQueue = []
|
|
|
|
function finishConnection (socket, noteId, socketId) {
|
|
// check view permission
|
|
if (!checkViewPermission(socket.request, notes[noteId])) {
|
|
return failConnection(403, 'connection forbidden', socket)
|
|
}
|
|
const note = notes[noteId]
|
|
const user = users[socketId]
|
|
// update user color to author color
|
|
if (note.authors[user.userid]) {
|
|
user.color = users[socket.id].color = note.authors[user.userid].color
|
|
}
|
|
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)
|
|
|
|
// update user note history
|
|
updateHistory(user.userid, note)
|
|
|
|
emitOnlineUsers(socket)
|
|
emitRefresh(socket)
|
|
|
|
// clear finished socket in queue
|
|
clearSocketQueue(connectionSocketQueue, socket)
|
|
// seek for next socket
|
|
connectNextSocket()
|
|
|
|
if (config.debug) {
|
|
const noteId = socket.noteId
|
|
logger.debug(`SERVER connected a client to [${noteId}]:`)
|
|
logger.debug(JSON.stringify(user))
|
|
logger.debug(notes)
|
|
getStatus(function (data) {
|
|
logger.debug(JSON.stringify(data))
|
|
})
|
|
}
|
|
}
|
|
|
|
function startConnection (socket) {
|
|
if (isConnectionBusy) return
|
|
isConnectionBusy = true
|
|
|
|
const noteId = socket.noteId
|
|
if (!noteId) {
|
|
return failConnection(404, 'note id not found', socket)
|
|
}
|
|
|
|
if (!notes[noteId]) {
|
|
const include = [{
|
|
model: models.User,
|
|
as: 'owner'
|
|
}, {
|
|
model: models.User,
|
|
as: 'lastchangeuser'
|
|
}, {
|
|
model: models.Author,
|
|
as: 'authors',
|
|
include: [{
|
|
model: models.User,
|
|
as: 'user'
|
|
}]
|
|
}]
|
|
|
|
models.Note.findOne({
|
|
where: {
|
|
id: noteId
|
|
},
|
|
include
|
|
}).then(function (note) {
|
|
// if client disconnected while we waited for the note, disconnect() cleaned up users[socket.id]
|
|
if (!users[socket.id]) {
|
|
clearSocketQueue(connectionSocketQueue, socket)
|
|
connectNextSocket()
|
|
return
|
|
}
|
|
|
|
if (!note) {
|
|
return failConnection(404, 'note not found', socket)
|
|
}
|
|
const owner = note.ownerId
|
|
const ownerprofile = note.owner ? models.User.getProfile(note.owner) : null
|
|
|
|
const lastchangeuser = note.lastchangeuserId
|
|
const lastchangeuserprofile = note.lastchangeuser ? models.User.getProfile(note.lastchangeuser) : null
|
|
|
|
const body = note.content
|
|
const createtime = note.createdAt
|
|
const updatetime = note.lastchangeAt
|
|
const server = new ot.EditorSocketIOServer(body, [], noteId, ifMayEdit, operationCallback)
|
|
|
|
const authors = {}
|
|
for (let i = 0; i < note.authors.length; i++) {
|
|
const author = note.authors[i]
|
|
const profile = models.User.getProfile(author.user)
|
|
if (profile) {
|
|
authors[author.userId] = {
|
|
userid: author.userId,
|
|
color: author.color,
|
|
photo: profile.photo,
|
|
name: profile.name
|
|
}
|
|
}
|
|
}
|
|
|
|
notes[noteId] = {
|
|
id: noteId,
|
|
alias: note.alias,
|
|
title: note.title,
|
|
owner,
|
|
ownerprofile,
|
|
permission: note.permission,
|
|
lastchangeuser,
|
|
lastchangeuserprofile,
|
|
socks: [],
|
|
users: {},
|
|
tempUsers: {},
|
|
createtime: moment(createtime).valueOf(),
|
|
updatetime: moment(updatetime).valueOf(),
|
|
server,
|
|
authors,
|
|
authorship: note.authorship
|
|
}
|
|
|
|
return finishConnection(socket, noteId, socket.id)
|
|
}).catch(function (err) {
|
|
return failConnection(500, err, socket)
|
|
})
|
|
} else {
|
|
return finishConnection(socket, noteId, socket.id)
|
|
}
|
|
}
|
|
|
|
function failConnection (code, err, socket) {
|
|
logger.error(err)
|
|
// clear error socket in queue
|
|
clearSocketQueue(connectionSocketQueue, socket)
|
|
connectNextSocket()
|
|
// emit error info
|
|
socket.emit('info', {
|
|
code
|
|
})
|
|
return socket.disconnect(true)
|
|
}
|
|
|
|
function disconnect (socket) {
|
|
if (isDisconnectBusy) return
|
|
isDisconnectBusy = true
|
|
|
|
logger.debug('SERVER disconnected a client')
|
|
logger.debug(JSON.stringify(users[socket.id]))
|
|
|
|
if (users[socket.id]) {
|
|
delete users[socket.id]
|
|
}
|
|
const noteId = socket.noteId
|
|
const note = notes[noteId]
|
|
if (note) {
|
|
// delete user in users
|
|
if (note.users[socket.id]) {
|
|
delete note.users[socket.id]
|
|
}
|
|
// remove sockets in the note socks
|
|
let index
|
|
do {
|
|
index = note.socks.indexOf(socket)
|
|
if (index !== -1) {
|
|
note.socks.splice(index, 1)
|
|
}
|
|
} while (index !== -1)
|
|
// remove note in notes if no user inside
|
|
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)
|
|
// clear server before delete to avoid memory leaks
|
|
note.server.document = ''
|
|
note.server.operations = []
|
|
delete note.server
|
|
delete notes[noteId]
|
|
if (config.debug) {
|
|
logger.debug(notes)
|
|
getStatus(function (data) {
|
|
logger.debug(JSON.stringify(data))
|
|
})
|
|
}
|
|
})
|
|
} else {
|
|
delete note.server
|
|
delete notes[noteId]
|
|
}
|
|
}
|
|
}
|
|
emitOnlineUsers(socket)
|
|
|
|
// clear finished socket in queue
|
|
clearSocketQueue(disconnectSocketQueue, socket)
|
|
// seek for next socket
|
|
isDisconnectBusy = false
|
|
if (disconnectSocketQueue.length > 0) { disconnect(disconnectSocketQueue[0]) }
|
|
|
|
if (config.debug) {
|
|
logger.debug(notes)
|
|
getStatus(function (data) {
|
|
logger.debug(JSON.stringify(data))
|
|
})
|
|
}
|
|
}
|
|
|
|
function buildUserOutData (user) {
|
|
const out = {
|
|
id: user.id,
|
|
login: user.login,
|
|
userid: user.userid,
|
|
photo: user.photo,
|
|
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) {
|
|
const profile = models.User.getProfile(socket.request.user)
|
|
user.photo = profile.photo
|
|
user.name = profile.name
|
|
user.userid = socket.request.user.id
|
|
user.login = true
|
|
} else {
|
|
user.userid = null
|
|
user.name = 'Guest ' + chance.last()
|
|
user.login = false
|
|
}
|
|
}
|
|
|
|
function ifMayEdit (socket, callback) {
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const note = notes[noteId]
|
|
let mayEdit = true
|
|
switch (note.permission) {
|
|
case 'freely':
|
|
// not blocking anyone
|
|
break
|
|
case 'editable': case 'limited':
|
|
// only login user can change
|
|
if (!socket.request.user || !socket.request.user.logged_in) { mayEdit = false }
|
|
break
|
|
case 'locked': case 'private': case 'protected':
|
|
// only owner can change
|
|
if (!note.owner || note.owner !== socket.request.user.id) { mayEdit = false }
|
|
break
|
|
}
|
|
// if user may edit and this is a text operation
|
|
if (socket.origin === 'operation' && mayEdit) {
|
|
// 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)
|
|
}
|
|
|
|
function operationCallback (socket, operation) {
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const note = notes[noteId]
|
|
let userId = null
|
|
// save authors
|
|
if (socket.request.user && socket.request.user.logged_in) {
|
|
const user = users[socket.id]
|
|
if (!user) return
|
|
userId = socket.request.user.id
|
|
if (!note.authors[userId]) {
|
|
models.Author.findOrCreate({
|
|
where: {
|
|
noteId,
|
|
userId
|
|
},
|
|
defaults: {
|
|
noteId,
|
|
userId,
|
|
color: user.color
|
|
}
|
|
}).spread(function (author, created) {
|
|
if (author) {
|
|
note.authors[author.userId] = {
|
|
userid: author.userId,
|
|
color: author.color,
|
|
photo: user.photo,
|
|
name: user.name
|
|
}
|
|
}
|
|
}).catch(function (err) {
|
|
return logger.error('operation callback failed: ' + err)
|
|
})
|
|
}
|
|
note.tempUsers[userId] = Date.now()
|
|
}
|
|
// save authorship - use timer here because it's an O(n) complexity algorithm
|
|
setImmediate(function () {
|
|
note.authorship = models.Note.updateAuthorshipByOperation(operation, userId, note.authorship)
|
|
})
|
|
}
|
|
|
|
function updateHistory (userId, note, time) {
|
|
const noteId = note.alias ? note.alias : models.Note.encodeNoteId(note.id)
|
|
if (note.server) history.updateHistory(userId, noteId, note.server.document, time)
|
|
}
|
|
|
|
function connection (socket) {
|
|
if (realtime.maintenance) return
|
|
parseNoteIdFromSocket(socket, function (err, noteId) {
|
|
if (err) {
|
|
return failConnection(500, err, socket)
|
|
}
|
|
if (!noteId) {
|
|
return failConnection(404, 'note id not found', socket)
|
|
}
|
|
|
|
if (isDuplicatedInSocketQueue(connectionSocketQueue, socket)) return
|
|
|
|
// store noteId in this socket session
|
|
socket.noteId = noteId
|
|
|
|
// initialize user data
|
|
// random color
|
|
let color = randomcolor()
|
|
// make sure color not duplicated or reach max random count
|
|
if (notes[noteId]) {
|
|
let randomcount = 0
|
|
const maxrandomcount = 10
|
|
let found = false
|
|
do {
|
|
Object.keys(notes[noteId].users).forEach(function (userId) {
|
|
if (notes[noteId].users[userId].color === color) {
|
|
found = true
|
|
}
|
|
})
|
|
if (found) {
|
|
color = randomcolor()
|
|
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,
|
|
cursor: null,
|
|
login: false,
|
|
userid: null,
|
|
name: null,
|
|
idle: false,
|
|
type: null
|
|
}
|
|
updateUserData(socket, users[socket.id])
|
|
|
|
// start connection
|
|
connectionSocketQueue.push(socket)
|
|
startConnection(socket)
|
|
})
|
|
|
|
// received client refresh request
|
|
socket.on('refresh', function () {
|
|
emitRefresh(socket)
|
|
})
|
|
|
|
// received user status
|
|
socket.on('user status', function (data) {
|
|
const noteId = socket.noteId
|
|
const user = users[socket.id]
|
|
if (!noteId || !notes[noteId] || !user) return
|
|
logger.debug(`SERVER received [${noteId}] user status from [${socket.id}]: ${JSON.stringify(data)}`)
|
|
if (data) {
|
|
user.idle = data.idle
|
|
user.type = data.type
|
|
}
|
|
emitUserStatus(socket)
|
|
})
|
|
|
|
// 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) {
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const note = notes[noteId]
|
|
// Only owner can change permission
|
|
if (note.owner && note.owner === socket.request.user.id) {
|
|
if (permission === 'freely' && !config.allowAnonymous && !config.allowAnonymousEdits) return
|
|
note.permission = permission
|
|
models.Note.update({
|
|
permission
|
|
}, {
|
|
where: {
|
|
id: noteId
|
|
}
|
|
}).then(function (count) {
|
|
if (!count) {
|
|
return
|
|
}
|
|
const out = {
|
|
permission
|
|
}
|
|
realtime.io.to(note.id).emit('permission', out)
|
|
for (let i = 0, l = note.socks.length; i < l; i++) {
|
|
const sock = note.socks[i]
|
|
if (typeof sock !== 'undefined' && sock) {
|
|
// check view permission
|
|
if (!checkViewPermission(sock.request, note)) {
|
|
sock.emit('info', {
|
|
code: 403
|
|
})
|
|
setTimeout(function () {
|
|
sock.disconnect(true)
|
|
}, 0)
|
|
}
|
|
}
|
|
}
|
|
}).catch(function (err) {
|
|
return logger.error('update note permission failed: ' + err)
|
|
})
|
|
}
|
|
}
|
|
})
|
|
|
|
// delete a note
|
|
socket.on('delete', function () {
|
|
// need login to do more actions
|
|
if (socket.request.user && socket.request.user.logged_in) {
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const note = notes[noteId]
|
|
// Only owner can delete note
|
|
if (note.owner && note.owner === socket.request.user.id) {
|
|
models.Note.destroy({
|
|
where: {
|
|
id: noteId
|
|
}
|
|
}).then(function (count) {
|
|
if (!count) return
|
|
for (let i = 0, l = note.socks.length; i < l; i++) {
|
|
const sock = note.socks[i]
|
|
if (typeof sock !== 'undefined' && sock) {
|
|
sock.emit('delete')
|
|
setTimeout(function () {
|
|
sock.disconnect(true)
|
|
}, 0)
|
|
}
|
|
}
|
|
}).catch(function (err) {
|
|
return logger.error('delete note failed: ' + err)
|
|
})
|
|
}
|
|
}
|
|
})
|
|
|
|
// reveiced when user logout or changed
|
|
socket.on('user changed', function () {
|
|
logger.info('user changed')
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const user = notes[noteId].users[socket.id]
|
|
if (!user) return
|
|
updateUserData(socket, user)
|
|
emitOnlineUsers(socket)
|
|
})
|
|
|
|
// received sync of online users request
|
|
socket.on('online users', function () {
|
|
const noteId = socket.noteId
|
|
if (!noteId || !notes[noteId]) return
|
|
const users = []
|
|
Object.keys(notes[noteId].users).forEach(function (key) {
|
|
const user = notes[noteId].users[key]
|
|
if (user) { users.push(buildUserOutData(user)) }
|
|
})
|
|
const out = {
|
|
users
|
|
}
|
|
socket.emit('online users', out)
|
|
})
|
|
|
|
// check version
|
|
socket.on('version', function () {
|
|
socket.emit('version', {
|
|
version: config.fullversion,
|
|
minimumCompatibleVersion: config.minimumCompatibleVersion
|
|
})
|
|
})
|
|
|
|
// received cursor focus
|
|
socket.on('cursor focus', function (data) {
|
|
const noteId = socket.noteId
|
|
const user = users[socket.id]
|
|
if (!noteId || !notes[noteId] || !user) return
|
|
user.cursor = data
|
|
const out = buildUserOutData(user)
|
|
socket.broadcast.to(noteId).emit('cursor focus', out)
|
|
})
|
|
|
|
// received cursor activity
|
|
socket.on('cursor activity', function (data) {
|
|
const noteId = socket.noteId
|
|
const user = users[socket.id]
|
|
if (!noteId || !notes[noteId] || !user) return
|
|
user.cursor = data
|
|
const out = buildUserOutData(user)
|
|
socket.broadcast.to(noteId).emit('cursor activity', out)
|
|
})
|
|
|
|
// received cursor blur
|
|
socket.on('cursor blur', function () {
|
|
const noteId = socket.noteId
|
|
const user = users[socket.id]
|
|
if (!noteId || !notes[noteId] || !user) return
|
|
user.cursor = null
|
|
const out = {
|
|
id: socket.id
|
|
}
|
|
socket.broadcast.to(noteId).emit('cursor blur', out)
|
|
})
|
|
|
|
// when a new client disconnect
|
|
socket.on('disconnect', function () {
|
|
if (isDuplicatedInSocketQueue(socket, disconnectSocketQueue)) return
|
|
disconnectSocketQueue.push(socket)
|
|
disconnect(socket)
|
|
})
|
|
}
|
|
|
|
module.exports = realtime
|