overleaf/services/web/app/coffee/Features/Project/ProjectDetailsHandler.coffee

186 lines
7.9 KiB
CoffeeScript
Raw Normal View History

2014-02-12 05:23:40 -05:00
ProjectGetter = require("./ProjectGetter")
UserGetter = require("../User/UserGetter")
2014-02-12 05:23:40 -05:00
Project = require('../../models/Project').Project
ObjectId = require("mongojs").ObjectId
2014-02-12 05:23:40 -05:00
logger = require("logger-sharelatex")
tpdsUpdateSender = require '../ThirdPartyDataStore/TpdsUpdateSender'
_ = require("underscore")
2016-03-15 10:35:01 -04:00
PublicAccessLevels = require("../Authorization/PublicAccessLevels")
Errors = require("../Errors/Errors")
ProjectTokenGenerator = require('./ProjectTokenGenerator')
ProjectEntityHandler = require('./ProjectEntityHandler')
ProjectHelper = require('./ProjectHelper')
settings = require('settings-sharelatex')
2014-02-12 05:23:40 -05:00
module.exports = ProjectDetailsHandler =
2014-02-12 05:23:40 -05:00
getDetails: (project_id, callback)->
ProjectGetter.getProject project_id, {name:true, description:true, compiler:true, features:true, owner_ref:true, overleaf:true}, (err, project)->
if err?
2014-02-12 05:23:40 -05:00
logger.err err:err, project_id:project_id, "error getting project"
return callback(err)
return callback(new Errors.NotFoundError("project not found")) if !project?
UserGetter.getUser project.owner_ref, (err, user) ->
return callback(err) if err?
details =
name : project.name
description: project.description
compiler: project.compiler
features: user?.features or settings.defaultFeatures
if project.overleaf?
details.overleaf = project.overleaf
logger.log project_id:project_id, details: details, "getting project details"
callback(err, details)
2014-02-12 05:23:40 -05:00
getProjectDescription: (project_id, callback)->
ProjectGetter.getProject project_id, description: true, (err, project)->
callback(err, project?.description)
2014-02-12 05:23:40 -05:00
setProjectDescription: (project_id, description, callback)->
conditions = _id:project_id
update = description:description
logger.log conditions:conditions, update:update, project_id:project_id, description:description, "setting project description"
Project.update conditions, update, (err)->
if err?
logger.err err:err, "something went wrong setting project description"
callback(err)
transferOwnership: (project_id, user_id, suffix = "", callback)->
if typeof suffix is 'function'
callback = suffix
suffix = ''
ProjectGetter.getProject project_id, {owner_ref: true}, (err, project)->
return callback(err) if err?
return callback(new Errors.NotFoundError("project not found")) unless project?
return callback() if project.owner_ref == user_id
UserGetter.getUser user_id, (err, user) ->
return callback(err) if err?
return callback(new Errors.NotFoundError("user not found")) unless user?
ProjectDetailsHandler.generateUniqueName user_id, project.name + suffix, (err, name) ->
return callback(err) if err?
Project.update {_id: project_id},
{
$set: {
owner_ref: user_id,
name: name
},
$pull: {
readOnly_refs: user_id,
collaberator_refs: user_id,
tokenAccessReadAndWrite_refs: user_id,
tokenAccessReadOnly_refs: user_id
}}, (err) ->
return callback(err) if err?
ProjectEntityHandler.flushProjectToThirdPartyDataStore project_id, callback
renameProject: (project_id, newName, callback = ->)->
ProjectDetailsHandler.validateProjectName newName, (error) ->
return callback(error) if error?
logger.log project_id: project_id, newName:newName, "renaming project"
ProjectGetter.getProject project_id, {name:true}, (err, project)->
if err? or !project?
logger.err err:err, project_id:project_id, "error getting project or could not find it todo project rename"
return callback(err)
oldProjectName = project.name
Project.update _id:project_id, {name: newName}, (err, project)=>
if err?
return callback(err)
tpdsUpdateSender.moveEntity {project_id:project_id, project_name:oldProjectName, newProjectName:newName}, callback
MAX_PROJECT_NAME_LENGTH: 150
validateProjectName: (name, callback = (error) ->) ->
2017-10-12 11:03:12 -04:00
if !name? or name.length == 0
return callback(new Errors.InvalidNameError("Project name cannot be blank"))
else if name.length > @MAX_PROJECT_NAME_LENGTH
return callback(new Errors.InvalidNameError("Project name is too long"))
else if name.indexOf("/") > -1
return callback(new Errors.InvalidNameError("Project name cannot contain / characters"))
else if name.indexOf("\\") > -1
return callback(new Errors.InvalidNameError("Project name cannot contain \\ characters"))
else
return callback()
generateUniqueName: (user_id, name, suffixes = [], callback = (error, newName) -> ) ->
if arguments.length is 3 && typeof suffixes is 'function' # make suffixes an optional argument
callback = suffixes
suffixes = []
ProjectDetailsHandler.ensureProjectNameIsUnique user_id, name, suffixes, callback
# FIXME: we should put a lock around this to make it completely safe, but we would need to do that at
# the point of project creation, rather than just checking the name at the start of the import.
# If we later move this check into ProjectCreationHandler we can ensure all new projects are created
# with a unique name. But that requires thinking through how we would handle incoming projects from
# dropbox for example.
ensureProjectNameIsUnique: (user_id, name, suffixes = [], callback = (error, name, changed)->) ->
ProjectGetter.findAllUsersProjects user_id, {name: 1}, (error, allUsersProjectNames) ->
return callback(error) if error?
# allUsersProjectNames is returned as a hash {owned: [name1, name2, ...], readOnly: [....]}
# collect all of the names and flatten them into a single array
projectNameList = _.pluck(_.flatten(_.values(allUsersProjectNames)),'name')
ProjectHelper.ensureNameIsUnique projectNameList, name, suffixes, ProjectDetailsHandler.MAX_PROJECT_NAME_LENGTH, callback
fixProjectName: (name) ->
if name == "" || !name
name = "Untitled"
if name.indexOf('/') > -1
# v2 does not allow / in a project name
name = name.replace(/\//g, '-')
if name.indexOf('\\') > -1
# backslashes in project name will prevent syncing to dropbox
name = name.replace(/\\/g, '')
if name.length > @MAX_PROJECT_NAME_LENGTH
name = name.substr(0, @MAX_PROJECT_NAME_LENGTH)
return name
setPublicAccessLevel : (project_id, newAccessLevel, callback = ->)->
logger.log project_id: project_id, level: newAccessLevel, "set public access level"
# DEPRECATED: `READ_ONLY` and `READ_AND_WRITE` are still valid in, but should no longer
# be passed here. Remove after token-based access has been live for a while
if project_id? && newAccessLevel? and _.include [
PublicAccessLevels.READ_ONLY,
PublicAccessLevels.READ_AND_WRITE,
PublicAccessLevels.PRIVATE,
PublicAccessLevels.TOKEN_BASED
], newAccessLevel
Project.update {_id:project_id},{publicAccesLevel:newAccessLevel}, (err)->
callback(err)
ensureTokensArePresent: (project_id, callback=(err, tokens)->) ->
ProjectGetter.getProject project_id, {tokens: 1}, (err, project) ->
return callback(err) if err?
if project.tokens? and project.tokens.readOnly? and project.tokens.readAndWrite?
2017-10-12 06:25:16 -04:00
logger.log {project_id}, "project already has tokens"
return callback(null, project.tokens)
else
2017-10-12 06:25:16 -04:00
logger.log {
project_id,
has_tokens: project.tokens?,
has_readOnly: project?.tokens?.readOnly?,
has_readAndWrite: project?.tokens?.readAndWrite?
}, "generating tokens for project"
ProjectDetailsHandler._generateTokens project, (err) ->
return callback(err) if err?
Project.update {_id: project_id}, {$set: {tokens: project.tokens}}, (err) ->
return callback(err) if err?
callback(null, project.tokens)
_generateTokens: (project, callback=(err)->) ->
project.tokens ||= {}
tokens = project.tokens
if !tokens.readAndWrite?
{ token, numericPrefix } = ProjectTokenGenerator.readAndWriteToken()
tokens.readAndWrite = token
tokens.readAndWritePrefix = numericPrefix
if !tokens.readOnly?
ProjectTokenGenerator.generateUniqueReadOnlyToken (err, token) ->
return callback(err) if err?
tokens.readOnly = token
callback()
else
callback()