mirror of
https://github.com/overleaf/overleaf.git
synced 2024-12-27 12:01:55 +00:00
369 lines
17 KiB
CoffeeScript
369 lines
17 KiB
CoffeeScript
logger = require('logger-sharelatex')
|
|
Metrics = require('../../infrastructure/Metrics')
|
|
sanitize = require('sanitizer')
|
|
ProjectEditorHandler = require('../Project/ProjectEditorHandler')
|
|
ProjectEntityHandler = require('../Project/ProjectEntityHandler')
|
|
ProjectOptionsHandler = require('../Project/ProjectOptionsHandler')
|
|
ProjectDetailsHandler = require('../Project/ProjectDetailsHandler')
|
|
ProjectDeleter = require("../Project/ProjectDeleter")
|
|
ProjectGetter = require('../Project/ProjectGetter')
|
|
UserGetter = require('../User/UserGetter')
|
|
CollaboratorsHandler = require("../Collaborators/CollaboratorsHandler")
|
|
DocumentUpdaterHandler = require('../DocumentUpdater/DocumentUpdaterHandler')
|
|
LimitationsManager = require("../Subscription/LimitationsManager")
|
|
AuthorizationManager = require("../Security/AuthorizationManager")
|
|
EditorRealTimeController = require("./EditorRealTimeController")
|
|
TrackChangesManager = require("../TrackChanges/TrackChangesManager")
|
|
Settings = require('settings-sharelatex')
|
|
async = require('async')
|
|
ConnectedUsersManager = require("../ConnectedUsers/ConnectedUsersManager")
|
|
LockManager = require("../../infrastructure/LockManager")
|
|
_ = require('underscore')
|
|
redis = require("redis-sharelatex")
|
|
rclientPub = redis.createClient(Settings.redis.web)
|
|
rclientSub = redis.createClient(Settings.redis.web)
|
|
|
|
module.exports = EditorController =
|
|
protocolVersion: 2
|
|
|
|
reportError: (client, clientError, callback = () ->) ->
|
|
client.get "project_id", (error, project_id) ->
|
|
client.get "user_id", (error, user_id) ->
|
|
logger.error err: clientError, project_id: project_id, user_id: user_id, "client error"
|
|
callback()
|
|
|
|
joinProject: (client, user, project_id, callback) ->
|
|
logger.log user_id:user._id, project_id:project_id, "user joining project"
|
|
Metrics.inc "editor.join-project"
|
|
EditorController.buildJoinProjectView project_id, user._id, (error, project, privilegeLevel, protocolVersion) ->
|
|
return callback(error) if error?
|
|
if !privilegeLevel
|
|
callback new Error("Not authorized")
|
|
else
|
|
client.join(project_id)
|
|
client.set("project_id", project_id)
|
|
client.set("owner_id", project.owner._id)
|
|
client.set("user_id", user._id)
|
|
client.set("first_name", user.first_name)
|
|
client.set("last_name", user.last_name)
|
|
client.set("email", user.email)
|
|
client.set("connected_time", new Date())
|
|
client.set("signup_date", user.signUpDate)
|
|
client.set("login_count", user.loginCount)
|
|
AuthorizationManager.setPrivilegeLevelOnClient client, privilegeLevel
|
|
|
|
callback null, project, privilegeLevel, EditorController.protocolVersion
|
|
|
|
# can be done after the connection has happened
|
|
ConnectedUsersManager.updateUserPosition project_id, client.id, user, null, ->
|
|
|
|
# Only show the 'renamed or deleted' message once
|
|
if project.deletedByExternalDataSource
|
|
ProjectDeleter.unmarkAsDeletedByExternalSource project_id
|
|
|
|
buildJoinProjectView: (project_id, user_id, callback = (error, project, privilegeLevel) ->) ->
|
|
ProjectGetter.getProjectWithoutDocLines project_id, (error, project) ->
|
|
return callback(error) if error?
|
|
return callback(new Error("not found")) if !project?
|
|
ProjectGetter.populateProjectWithUsers project, (error, project) ->
|
|
return callback(error) if error?
|
|
UserGetter.getUser user_id, { isAdmin: true }, (error, user) ->
|
|
return callback(error) if error?
|
|
AuthorizationManager.getPrivilegeLevelForProject project, user, (error, canAccess, privilegeLevel) ->
|
|
return callback(error) if error?
|
|
if !canAccess
|
|
callback null, null, false
|
|
else
|
|
callback(null,
|
|
ProjectEditorHandler.buildProjectModelView(project),
|
|
privilegeLevel
|
|
)
|
|
|
|
leaveProject: (client, user) ->
|
|
self = @
|
|
client.get "project_id", (error, project_id) ->
|
|
return if error? or !project_id?
|
|
EditorRealTimeController.emitToRoom(project_id, "clientTracking.clientDisconnected", client.id)
|
|
ConnectedUsersManager.markUserAsDisconnected project_id, client.id, ->
|
|
logger.log user_id:user._id, project_id:project_id, "user leaving project"
|
|
self.flushProjectIfEmpty(project_id)
|
|
|
|
joinDoc: (client, project_id, doc_id, fromVersion, callback = (error, docLines, version) ->) ->
|
|
# fromVersion is optional
|
|
if typeof fromVersion == "function"
|
|
callback = fromVersion
|
|
fromVersion = -1
|
|
|
|
client.get "user_id", (error, user_id) ->
|
|
logger.log user_id: user_id, project_id: project_id, doc_id: doc_id, "user joining doc"
|
|
Metrics.inc "editor.join-doc"
|
|
client.join doc_id
|
|
DocumentUpdaterHandler.getDocument project_id, doc_id, fromVersion, (err, docLines, version, ops)->
|
|
# Encode any binary bits of data so it can go via WebSockets
|
|
# See http://ecmanaut.blogspot.co.uk/2006/07/encoding-decoding-utf8-in-javascript.html
|
|
if docLines?
|
|
docLines = for line in docLines
|
|
if line.text?
|
|
try
|
|
line.text = unescape(encodeURIComponent(line.text))
|
|
catch err
|
|
logger.err err:err, project_id:project_id, doc_id:doc_id, fromVersion:fromVersion, line:line, "error encoding line.text uri component"
|
|
else
|
|
try
|
|
line = unescape(encodeURIComponent(line))
|
|
catch err
|
|
logger.err err:err, project_id:project_id, doc_id:doc_id, fromVersion:fromVersion, line:line, "error encoding line uri component"
|
|
line
|
|
callback(err, docLines, version, ops)
|
|
|
|
leaveDoc: (client, project_id, doc_id, callback = (error) ->) ->
|
|
client.get "user_id", (error, user_id) ->
|
|
logger.log user_id: user_id, project_id: project_id, doc_id: doc_id, "user leaving doc"
|
|
Metrics.inc "editor.leave-doc"
|
|
client.leave doc_id
|
|
callback()
|
|
|
|
flushProjectIfEmpty: (project_id, callback = ->)->
|
|
setTimeout (->
|
|
io = require('../../infrastructure/Server').io
|
|
peopleStillInProject = io.sockets.clients(project_id).length
|
|
logger.log project_id: project_id, connectedCount: peopleStillInProject, "flushing if empty"
|
|
if peopleStillInProject == 0
|
|
DocumentUpdaterHandler.flushProjectToMongoAndDelete(project_id)
|
|
TrackChangesManager.flushProject(project_id)
|
|
callback()
|
|
), 500
|
|
|
|
updateClientPosition: (client, cursorData, callback = (error) ->) ->
|
|
async.parallel {
|
|
project_id: (cb)-> client.get "project_id", cb
|
|
first_name: (cb)-> client.get "first_name", cb
|
|
last_name: (cb)-> client.get "last_name", cb
|
|
email: (cb)-> client.get "email", cb
|
|
user_id: (cb)-> client.get "user_id", cb
|
|
}, (err, results)->
|
|
{first_name, last_name, user_id, email, project_id} = results
|
|
cursorData.id = client.id
|
|
cursorData.user_id = user_id if user_id?
|
|
cursorData.email = email if email?
|
|
if first_name? and last_name?
|
|
cursorData.name = first_name + " " + last_name
|
|
ConnectedUsersManager.updateUserPosition(project_id, client.id, {
|
|
first_name: first_name,
|
|
last_name: last_name,
|
|
email: email,
|
|
user_id: user_id
|
|
}, {
|
|
row: cursorData.row,
|
|
column: cursorData.column,
|
|
doc_id: cursorData.doc_id
|
|
}, ->)
|
|
else
|
|
cursorData.name = "Anonymous"
|
|
EditorRealTimeController.emitToRoom(project_id, "clientTracking.clientUpdated", cursorData)
|
|
|
|
addUserToProject: (project_id, email, privileges, callback = (error, collaborator_added)->)->
|
|
email = email.toLowerCase()
|
|
LimitationsManager.isCollaboratorLimitReached project_id, (error, limit_reached) =>
|
|
if error?
|
|
logger.error err:error, "error adding user to to project when checking if collaborator limit has been reached"
|
|
return callback(new Error("Something went wrong"))
|
|
|
|
if limit_reached
|
|
callback null, false
|
|
else
|
|
CollaboratorsHandler.addUserToProject project_id, email, privileges, (err, user)=>
|
|
return callback(err) if error?
|
|
# Flush to TPDS to add files to collaborator's Dropbox
|
|
ProjectEntityHandler.flushProjectToThirdPartyDataStore project_id, ->
|
|
EditorRealTimeController.emitToRoom(project_id, 'userAddedToProject', user, privileges)
|
|
callback null, ProjectEditorHandler.buildUserModelView(user, privileges)
|
|
|
|
removeUserFromProject: (project_id, user_id, callback = (error) ->)->
|
|
CollaboratorsHandler.removeUserFromProject project_id, user_id, (error) =>
|
|
return callback(error) if error?
|
|
EditorRealTimeController.emitToRoom(project_id, 'userRemovedFromProject', user_id)
|
|
callback()
|
|
|
|
setDoc: (project_id, doc_id, docLines, source, callback = (err)->)->
|
|
DocumentUpdaterHandler.setDocument project_id, doc_id, docLines, source, (err)=>
|
|
logger.log project_id:project_id, doc_id:doc_id, "notifying users that the document has been updated"
|
|
DocumentUpdaterHandler.flushDocToMongo project_id, doc_id, callback
|
|
|
|
|
|
addDoc: (project_id, folder_id, docName, docLines, source, callback = (error, doc)->)->
|
|
LockManager.getLock project_id, (err)->
|
|
if err?
|
|
logger.err err:err, project_id:project_id, source:source, "could not get lock to addDoc"
|
|
return callback(err)
|
|
EditorController.addDocWithoutLock project_id, folder_id, docName, docLines, source, (error, doc)->
|
|
LockManager.releaseLock project_id, ->
|
|
callback(error, doc)
|
|
|
|
addDocWithoutLock: (project_id, folder_id, docName, docLines, source, callback = (error, doc)->)->
|
|
docName = docName.trim()
|
|
logger.log {project_id, folder_id, docName, source}, "sending new doc to project"
|
|
Metrics.inc "editor.add-doc"
|
|
ProjectEntityHandler.addDoc project_id, folder_id, docName, docLines, (err, doc, folder_id)=>
|
|
EditorRealTimeController.emitToRoom(project_id, 'reciveNewDoc', folder_id, doc, source)
|
|
callback(err, doc)
|
|
|
|
|
|
addFile: (project_id, folder_id, fileName, path, source, callback = (error, file)->)->
|
|
LockManager.getLock project_id, (err)->
|
|
if err?
|
|
logger.err err:err, project_id:project_id, source:source, "could not get lock to addFile"
|
|
return callback(err)
|
|
EditorController.addFileWithoutLock project_id, folder_id, fileName, path, source, (error, file)->
|
|
LockManager.releaseLock project_id, ->
|
|
callback(error, file)
|
|
|
|
|
|
addFileWithoutLock: (project_id, folder_id, fileName, path, source, callback = (error, file)->)->
|
|
fileName = fileName.trim()
|
|
logger.log {project_id, folder_id, fileName, path}, "sending new file to project"
|
|
Metrics.inc "editor.add-file"
|
|
ProjectEntityHandler.addFile project_id, folder_id, fileName, path, (err, fileRef, folder_id)=>
|
|
EditorRealTimeController.emitToRoom(project_id, 'reciveNewFile', folder_id, fileRef, source)
|
|
callback(err, fileRef)
|
|
|
|
replaceFile: (project_id, file_id, fsPath, source, callback = (error) ->)->
|
|
ProjectEntityHandler.replaceFile project_id, file_id, fsPath, callback
|
|
|
|
|
|
|
|
addFolder : (project_id, folder_id, folderName, source, callback = (error, folder)->)->
|
|
LockManager.getLock project_id, (err)->
|
|
if err?
|
|
logger.err err:err, project_id:project_id, source:source, "could not get lock to addFolder"
|
|
return callback(err)
|
|
EditorController.addFolderWithoutLock project_id, folder_id, folderName, source, (error, folder)->
|
|
LockManager.releaseLock project_id, ->
|
|
callback(error, folder)
|
|
|
|
addFolderWithoutLock: (project_id, folder_id, folderName, source, callback = (error, folder)->)->
|
|
folderName = folderName.trim()
|
|
logger.log {project_id, folder_id, folderName, source}, "sending new folder to project"
|
|
Metrics.inc "editor.add-folder"
|
|
ProjectEntityHandler.addFolder project_id, folder_id, folderName, (err, folder, folder_id)=>
|
|
@p.notifyProjectUsersOfNewFolder project_id, folder_id, folder, (error) ->
|
|
callback error, folder
|
|
|
|
|
|
mkdirp : (project_id, path, callback)->
|
|
LockManager.getLock project_id, (err)->
|
|
if err?
|
|
logger.err err:err, project_id:project_id, "could not get lock to mkdirp"
|
|
return callback(err)
|
|
EditorController.mkdirpWithoutLock project_id, path, (err, newFolders, lastFolder)->
|
|
LockManager.releaseLock project_id, ->
|
|
callback(err, newFolders, lastFolder)
|
|
|
|
mkdirpWithoutLock: (project_id, path, callback)->
|
|
logger.log project_id:project_id, path:path, "making directories if they don't exist"
|
|
ProjectEntityHandler.mkdirp project_id, path, (err, newFolders, lastFolder)=>
|
|
self = @
|
|
jobs = _.map newFolders, (folder, index)->
|
|
return (cb)->
|
|
self.p.notifyProjectUsersOfNewFolder project_id, folder.parentFolder_id, folder, cb
|
|
async.series jobs, (err)->
|
|
callback err, newFolders, lastFolder
|
|
|
|
deleteEntity : (project_id, entity_id, entityType, source, callback)->
|
|
LockManager.getLock project_id, (err)->
|
|
if err?
|
|
logger.err err:err, project_id:project_id, "could not get lock to deleteEntity"
|
|
return callback(err)
|
|
EditorController.deleteEntityWithoutLock project_id, entity_id, entityType, source, (err)->
|
|
LockManager.releaseLock project_id, ()->
|
|
callback(err)
|
|
|
|
deleteEntityWithoutLock: (project_id, entity_id, entityType, source, callback)->
|
|
logger.log {project_id, entity_id, entityType, source}, "start delete process of entity"
|
|
Metrics.inc "editor.delete-entity"
|
|
ProjectEntityHandler.deleteEntity project_id, entity_id, entityType, =>
|
|
logger.log project_id:project_id, entity_id:entity_id, entityType:entityType, "telling users entity has been deleted"
|
|
EditorRealTimeController.emitToRoom(project_id, 'removeEntity', entity_id, source)
|
|
if callback?
|
|
callback()
|
|
|
|
getListOfDocPaths: (project_id, callback)->
|
|
ProjectEntityHandler.getAllDocs project_id, (err, docs)->
|
|
docList = _.map docs, (doc, path)->
|
|
return {_id:doc._id, path:path.substring(1)}
|
|
callback(null, docList)
|
|
|
|
forceResyncOfDropbox: (project_id, callback)->
|
|
ProjectEntityHandler.flushProjectToThirdPartyDataStore project_id, callback
|
|
|
|
notifyUsersProjectHasBeenDeletedOrRenamed: (project_id, callback)->
|
|
EditorRealTimeController.emitToRoom(project_id, 'projectRenamedOrDeletedByExternalSource')
|
|
callback()
|
|
|
|
updateProjectDescription: (project_id, description, callback = ->)->
|
|
logger.log project_id:project_id, description:description, "updating project description"
|
|
ProjectDetailsHandler.setProjectDescription project_id, description, (err)->
|
|
if err?
|
|
logger.err err:err, project_id:project_id, description:description, "something went wrong setting the project description"
|
|
return callback(err)
|
|
EditorRealTimeController.emitToRoom(project_id, 'projectDescriptionUpdated', description)
|
|
callback()
|
|
|
|
deleteProject: (project_id, callback)->
|
|
Metrics.inc "editor.delete-project"
|
|
logger.log project_id:project_id, "recived message to delete project"
|
|
ProjectDeleter.deleteProject project_id, callback
|
|
|
|
renameEntity: (project_id, entity_id, entityType, newName, callback)->
|
|
newName = sanitize.escape(newName)
|
|
Metrics.inc "editor.rename-entity"
|
|
logger.log entity_id:entity_id, entity_id:entity_id, entity_id:entity_id, "reciving new name for entity for project"
|
|
ProjectEntityHandler.renameEntity project_id, entity_id, entityType, newName, =>
|
|
if newName.length > 0
|
|
EditorRealTimeController.emitToRoom project_id, 'reciveEntityRename', entity_id, newName
|
|
callback?()
|
|
#
|
|
moveEntity: (project_id, entity_id, folder_id, entityType, callback)->
|
|
Metrics.inc "editor.move-entity"
|
|
ProjectEntityHandler.moveEntity project_id, entity_id, folder_id, entityType, =>
|
|
EditorRealTimeController.emitToRoom project_id, 'reciveEntityMove', entity_id, folder_id
|
|
callback?()
|
|
|
|
renameProject: (project_id, newName, callback = (err) ->) ->
|
|
ProjectDetailsHandler.renameProject project_id, newName, =>
|
|
EditorRealTimeController.emitToRoom project_id, 'projectNameUpdated', newName
|
|
callback()
|
|
|
|
setCompiler : (project_id, compiler, callback = (err) ->) ->
|
|
ProjectOptionsHandler.setCompiler project_id, compiler, (err) ->
|
|
return callback(err) if err?
|
|
logger.log compiler:compiler, project_id:project_id, "setting compiler"
|
|
EditorRealTimeController.emitToRoom project_id, 'compilerUpdated', compiler
|
|
callback()
|
|
|
|
setSpellCheckLanguage : (project_id, languageCode, callback = (err) ->) ->
|
|
ProjectOptionsHandler.setSpellCheckLanguage project_id, languageCode, (err) ->
|
|
return callback(err) if err?
|
|
logger.log languageCode:languageCode, project_id:project_id, "setting languageCode for spell check"
|
|
EditorRealTimeController.emitToRoom project_id, 'spellCheckLanguageUpdated', languageCode
|
|
callback()
|
|
|
|
setPublicAccessLevel : (project_id, newAccessLevel, callback = (err) ->) ->
|
|
ProjectDetailsHandler.setPublicAccessLevel project_id, newAccessLevel, (err) ->
|
|
return callback(err) if err?
|
|
EditorRealTimeController.emitToRoom project_id, 'publicAccessLevelUpdated', newAccessLevel
|
|
callback()
|
|
|
|
setRootDoc: (project_id, newRootDocID, callback = (err) ->) ->
|
|
ProjectEntityHandler.setRootDoc project_id, newRootDocID, (err) ->
|
|
return callback(err) if err?
|
|
EditorRealTimeController.emitToRoom project_id, 'rootDocUpdated', newRootDocID
|
|
callback()
|
|
|
|
|
|
p:
|
|
notifyProjectUsersOfNewFolder: (project_id, folder_id, folder, callback = (error)->)->
|
|
logger.log project_id:project_id, folder:folder, parentFolder_id:folder_id, "sending newly created folder out to users"
|
|
EditorRealTimeController.emitToRoom(project_id, "reciveNewFolder", folder_id, folder)
|
|
callback()
|
|
|