codimd/lib/realtime/realtime.ts
Raccoon 375de57af6
fix: guest note not save
Signed-off-by: Raccoon <raccoon@hackmd.io>
2021-06-16 18:35:33 +08:00

814 lines
22 KiB
TypeScript

// realtime
// external modules
import cookie from "cookie";
import cookieParser from "cookie-parser";
import url from "url";
import randomcolor from "randomcolor";
import Chance from "chance";
import moment from "moment";
import {get} from "lodash";
// core
import config from "../config";
import {logger} from "../logger";
import * as history from "../history";
import {Author, Note, User} from "../models";
// ot
import ot from "ot";
import {ProcessQueue} from "./processQueue";
import {RealtimeClientConnection} from "./realtimeClientConnection";
import {UpdateDirtyNoteJob} from "./realtimeUpdateDirtyNoteJob";
import {CleanDanglingUserJob} from "./realtimeCleanDanglingUserJob";
import {SaveRevisionJob} from "./realtimeSaveRevisionJob";
const chance = new Chance()
export let io = null
export let maintenance = true
export function setSocketIo(socketIO) {
io = socketIO
}
export function setMaintenance(isMaintenance) {
maintenance = isMaintenance
}
// public
const connectProcessQueue = new ProcessQueue({})
export const disconnectProcessQueue = new ProcessQueue({})
const updateDirtyNoteJob = new UpdateDirtyNoteJob(exports)
const cleanDanglingUserJob = new CleanDanglingUserJob(exports)
export const saveRevisionJob = new SaveRevisionJob(exports)
// TODO: test it
export function onAuthorizeSuccess(data, accept) {
accept()
}
// TODO: test it
export function onAuthorizeFail(data, message, error, accept) {
accept() // accept whether authorize or not to allow anonymous usage
}
// TODO: test it
// secure the origin by the cookie
export 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) {
if (config.debug) {
logger.info('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)))
}
}
// TODO: only use in `updateDirtyNote`
// TODO: test it
export function emitCheck(note) {
const out = {
title: note.title,
updatetime: note.updatetime,
lastchangeuser: note.lastchangeuser,
lastchangeuserprofile: note.lastchangeuserprofile,
authors: note.authors,
authorship: note.authorship
}
io.to(note.id).emit('check', out)
}
// actions
export const users = {}
export const notes = {}
export function getNotePool(): any {
return notes
}
export function isNoteExistsInPool(noteId) {
return !!notes[noteId]
}
export function addNote(note) {
if (exports.isNoteExistsInPool(note.id)) return false
notes[note.id] = note
return true
}
export function getNotePoolSize() {
return Object.keys(notes).length
}
export function deleteNoteFromPool(noteId) {
delete notes[noteId]
}
export function deleteAllNoteFromPool() {
Object.keys(notes).forEach(noteId => {
delete notes[noteId]
})
}
export function getNoteFromNotePool(noteId) {
return notes[noteId]
}
export function getUserPool() {
return users
}
export function getUserFromUserPool(userId) {
return users[userId]
}
disconnectProcessQueue.start()
updateDirtyNoteJob.start()
cleanDanglingUserJob.start()
saveRevisionJob.start()
export function disconnectSocketOnNote(note) {
note.socks.forEach((sock) => {
if (sock) {
sock.emit('delete')
setImmediate(() => {
sock.disconnect(true)
})
}
})
}
export function updateNote(note, callback) {
_updateNoteAsync(note).then(_note => {
callback(null, _note)
}).catch((err) => {
logger.error(err)
return callback(err, null)
})
}
function findNoteByIdAsync(id) {
return Note.findOne({
where: {
id: id
}
})
}
function updateHistoryForEveryUserCollaborateNote(note) {
// update history to every user in this note
const tempUsers = Object.assign({}, note.tempUsers)
note.tempUsers = {}
// update history should async function, but in there return values is not matter
Object.keys(tempUsers).forEach(function (key) {
exports.updateHistory(key, note, tempUsers[key])
})
}
async function getUserProfileByIdAsync(id) {
const user = await User.findOne({
where: {
id: id
}
})
if (!user) return null
return User.getProfile(user)
}
class UserNotFoundException extends Error {
constructor() {
super('user not found')
this.name = this.constructor.name
Error.captureStackTrace(this, this.constructor)
}
}
async function getLastChangeUserProfileAsync(currentLastChangeUserId, lastChangeUserIdInDatabase, lastChangeUserProfileInDatabase) {
if (!currentLastChangeUserId) return null
if (currentLastChangeUserId === lastChangeUserIdInDatabase) return lastChangeUserProfileInDatabase
const profile = await getUserProfileByIdAsync(currentLastChangeUserId)
if (!profile) {
throw new UserNotFoundException()
}
return profile
}
function buildNoteUpdateData(note) {
const body = note.server.document
const title = note.title = Note.parseNoteTitle(body)
return {
title: title,
content: body,
authorship: note.authorship,
lastchangeuserId: note.lastchangeuser,
lastchangeAt: Date.now()
}
}
async function _updateNoteAsync(note) {
let noteModel = await findNoteByIdAsync(note.id)
if (!noteModel) return null
updateHistoryForEveryUserCollaborateNote(note)
try {
note.lastchangeuserprofile = await getLastChangeUserProfileAsync(
note.lastchangeuser,
noteModel.lastchangeuserId,
noteModel.lastchangeuserprofile
)
} catch (err) {
if (err instanceof UserNotFoundException) {
return null
}
throw err
}
if (!note || !note.server) return null
noteModel = await noteModel.update(buildNoteUpdateData(note))
saveRevisionJob.setSaverSleep(false)
return noteModel
}
// TODO: test it
export function getStatus() {
return 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)
}
}
})
return User.count()
.then(function (regcount) {
return {
onlineNotes: Object.keys(notes).length,
onlineUsers: Object.keys(users).length,
distinctOnlineUsers: distinctaddresses.length,
notesCount: notecount,
registeredUsers: regcount,
onlineRegisteredUsers: regaddresses.length,
distinctOnlineRegisteredUsers: distinctregaddresses.length,
isConnectionBusy: connectProcessQueue.lock,
connectionSocketQueueLength: connectProcessQueue.queue.length,
isDisconnectBusy: disconnectProcessQueue.lock,
disconnectSocketQueueLength: disconnectProcessQueue.queue.length
}
})
.catch(function (err) {
logger.error('count user failed: ' + err)
return Promise.reject(new Error('count user failed: ' + err))
})
}).catch(function (err) {
logger.error('count note failed: ' + err)
return Promise.reject(new Error('count note failed: ' + err))
})
}
// TODO: test it
export function isReady() {
return io &&
Object.keys(notes).length === 0 && Object.keys(users).length === 0 &&
connectProcessQueue.queue.length === 0 && !connectProcessQueue.lock &&
disconnectProcessQueue.queue.length === 0 && !disconnectProcessQueue.lock
}
function parseUrl(data) {
try {
if (url.URL) {
return new url.URL(data)
} else {
// fallback legacy api
// eslint-disable-next-line
return url.parse(data)
}
} catch (e) {
// just ignore
}
return null
}
export function extractNoteIdFromSocket(socket) {
function extractNoteIdFromReferer(referer) {
if (referer) {
const hostUrl = parseUrl(referer)
if (!hostUrl) {
return false
}
if (config.urlPath) {
return hostUrl.pathname.slice(config.urlPath.length + 1, hostUrl.pathname.length).split('/')[1]
}
return hostUrl.pathname.split('/')[1]
}
return false
}
if (!socket || !socket.handshake) {
return false
}
if (get(socket, 'handshake.query.noteId')) {
return decodeURIComponent(socket.handshake.query.noteId)
}
const referer = get(socket, 'handshake.headers.referer')
if (referer) {
// this part is only for backward compatibility only; current code
// should be using noteId query parameter instead.
return extractNoteIdFromReferer(referer)
}
return false
}
export async function parseNoteIdFromSocketAsync(socket) {
const noteId = extractNoteIdFromSocket(socket)
if (!noteId) {
return null
}
return new Promise((resolve, reject) => {
Note.parseNoteId(noteId, function (err, id) {
if (err) {
reject(err)
}
if (!id) {
resolve(null)
}
resolve(id)
})
})
}
// TODO: test it
export 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: users
}
io.to(noteId).emit('online users', out)
}
// TODO: test it
export 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)
}
// TODO: test it
export 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)
}
export 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
}
}
// TODO: test it
async function fetchFullNoteAsync(noteId) {
return Note.findOne({
where: {
id: noteId
},
include: [{
model: User,
as: 'owner'
}, {
model: User,
as: 'lastchangeuser'
}, {
model: Author,
as: 'authors',
include: [{
model: User,
as: 'user'
}]
}]
})
}
function buildAuthorProfilesFromNote(noteAuthors) {
const authors = {}
noteAuthors.forEach((author) => {
const profile = User.getProfile(author.user)
if (profile) {
authors[author.userId] = {
userid: author.userId,
color: author.color,
photo: profile.photo,
name: profile.name
}
}
})
return authors
}
function makeNewServerNote(note) {
const authors = buildAuthorProfilesFromNote(note.authors)
const otServer = new ot.EditorSocketIOServer(note.content, [], note.id, ifMayEdit, operationCallback)
otServer.debug = config.debug
otServer.setLogger(logger)
otServer.setDocumentMaxLength(config.documentmaxlength)
return {
id: note.id,
alias: note.alias,
title: note.title,
owner: note.ownerId,
ownerprofile: note.owner ? User.getProfile(note.owner) : null,
permission: note.permission,
lastchangeuser: note.lastchangeuserId,
lastchangeuserprofile: note.lastchangeuser ? User.getProfile(note.lastchangeuser) : null,
socks: [],
users: {},
tempUsers: {},
createtime: moment(note.createdAt).valueOf(),
updatetime: moment(note.lastchangeAt).valueOf(),
server: otServer,
authors: authors,
authorship: note.authorship
}
}
// TODO: test it
export function failConnection(code, err, socket) {
logger.error(err)
// emit error info
socket.emit('info', {
code: code
})
return socket.disconnect(true)
}
export function queueForDisconnect(socket) {
disconnectProcessQueue.push(socket.id, async function () {
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) {
exports.updateNote(note, function (err, _note) {
if (err) {
logger.error('disconnect note failed: ' + err)
return
}
// clear server before delete to avoid memory leaks
note.server.document = ''
note.server.operations = []
delete note.server
delete notes[noteId]
})
} else {
delete note.server
delete notes[noteId]
}
}
}
exports.emitOnlineUsers(socket)
})
}
export 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
}
// TODO: test it
export function updateUserData(socket, user) {
// retrieve user data from passport
if (socket.request.user && socket.request.user.logged_in) {
const profile = 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.animal()
user.login = false
}
}
function canEditNote(notePermission, noteOwnerId, currentUserId) {
switch (notePermission) {
case 'freely':
return true
case 'editable':
case 'limited':
// only login user can change
return !!currentUserId
case 'locked':
case 'private':
case 'protected':
// only owner can change
return noteOwnerId === currentUserId
}
}
export function ifMayEdit(socket, callback) {
const note = getNoteFromNotePool(socket.noteId)
if (!note) return
const mayEdit = canEditNote(note.permission, note.owner, socket.request.user.id)
// 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)
}
// TODO: test it
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]) {
Author.findOrCreate({
where: {
noteId: noteId,
userId: userId
},
defaults: {
noteId: noteId,
userId: 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()
}
note.server.isDirty = true
// save authorship - use timer here because it's an O(n) complexity algorithm
setImmediate(function () {
note.authorship = Note.updateAuthorshipByOperation(operation, userId, note.authorship)
})
}
// TODO: test it
export function updateHistory(userId, note, time?: any) {
const noteId = note.alias ? note.alias : Note.encodeNoteId(note.id)
if (note.server) history.updateHistory(userId, noteId, note.server.document, time)
}
function getUniqueColorPerNote(noteId, maxAttempt = 10) {
// random color
let color = randomcolor()
if (!notes[noteId]) return color
const maxrandomcount = maxAttempt
let randomAttemp = 0
let found = false
do {
Object.keys(notes[noteId].users).forEach(userId => {
if (notes[noteId].users[userId].color === color) {
found = true
}
})
if (found) {
color = randomcolor()
randomAttemp++
}
} while (found && randomAttemp < maxrandomcount)
return color
}
function queueForConnect(socket) {
connectProcessQueue.push(socket.id, async function () {
try {
const noteId = await exports.parseNoteIdFromSocketAsync(socket) as string
if (!noteId) {
return exports.failConnection(404, 'note id not found', socket)
}
// store noteId in this socket session
socket.noteId = noteId
// initialize user data
// random color
const color = getUniqueColorPerNote(noteId)
// 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
}
exports.updateUserData(socket, users[socket.id])
try {
if (!isNoteExistsInPool(noteId)) {
const note = await fetchFullNoteAsync(noteId)
if (!note) {
logger.error('note not found')
// emit error info
socket.emit('info', {
code: 404
})
return socket.disconnect(true)
}
getNotePool()[noteId] = makeNewServerNote(note)
}
// if no valid info provided will drop the client
if (!socket || !notes[noteId] || !users[socket.id]) {
if (notes[noteId]) delete notes[noteId]
if (users[socket.id]) delete users[socket.id]
return
}
// check view permission
if (!exports.checkViewPermission(socket.request, notes[noteId])) {
if (notes[noteId]) delete notes[noteId]
if (users[socket.id]) delete users[socket.id]
logger.error('connection forbidden')
// emit error info
socket.emit('info', {
code: 403
})
return socket.disconnect(true)
}
const note = notes[noteId]
const user = users[socket.id]
// 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
exports.updateHistory(user.userid, note)
exports.emitOnlineUsers(socket)
exports.emitRefresh(socket)
const socketClient = new RealtimeClientConnection(socket)
socketClient.registerEventHandler()
if (config.debug) {
const noteId = socket.noteId
logger.info('SERVER connected a client to [' + noteId + ']:')
logger.info(JSON.stringify(user))
getStatus().then(function (data) {
logger.info(JSON.stringify(data))
})
}
} catch (err) {
logger.error(err)
// emit error info
socket.emit('info', {
code: 500
})
return socket.disconnect(true)
}
} catch (err) {
return exports.failConnection(500, err, socket)
}
})
}
export function connection(socket) {
if (maintenance) return
queueForConnect(socket)
}
// TODO: test it
export function terminate() {
disconnectProcessQueue.stop()
connectProcessQueue.stop()
updateDirtyNoteJob.stop()
}