ProjectEntityMongoUpdateHandler.coffee 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. _ = require('underscore')
  2. async = require 'async'
  3. logger = require('logger-sharelatex')
  4. path = require('path')
  5. settings = require('settings-sharelatex')
  6. CooldownManager = require '../Cooldown/CooldownManager'
  7. Errors = require '../Errors/Errors'
  8. Folder = require('../../models/Folder').Folder
  9. Project = require('../../models/Project').Project
  10. ProjectEntityHandler = require('./ProjectEntityHandler')
  11. ProjectGetter = require('./ProjectGetter')
  12. ProjectLocator = require('./ProjectLocator')
  13. SafePath = require './SafePath'
  14. module.exports = ProjectEntityMongoUpdateHandler = self =
  15. addDoc: (project_id, folder_id, doc, callback = (err, result) ->) ->
  16. ProjectGetter.getProject project_id, {rootFolder:true, name:true}, (err, project) ->
  17. if err?
  18. logger.err project_id:project_id, err:err, "error getting project for add doc"
  19. return callback(err)
  20. logger.log project_id: project_id, folder_id: folder_id, doc_name: doc.name, "adding doc to project with project"
  21. self._confirmFolder project, folder_id, (folder_id) =>
  22. self._putElement project, folder_id, doc, "doc", callback
  23. addFile: (project_id, folder_id, fileRef, callback = (error, result, project) ->)->
  24. ProjectGetter.getProject project_id, {rootFolder:true, name:true}, (err, project) ->
  25. if err?
  26. logger.err project_id:project_id, err:err, "error getting project for add file"
  27. return callback(err)
  28. logger.log project_id: project._id, folder_id: folder_id, file_name: fileRef.name, "adding file"
  29. self._confirmFolder project, folder_id, (folder_id)->
  30. self._putElement project, folder_id, fileRef, "file", callback
  31. replaceFile: (project_id, file_id, callback) ->
  32. ProjectGetter.getProject project_id, {rootFolder: true, name:true}, (err, project) ->
  33. return callback(err) if err?
  34. ProjectLocator.findElement {project:project, element_id: file_id, type: 'file'}, (err, fileRef, path)=>
  35. return callback(err) if err?
  36. conditions = _id:project._id
  37. inc = {}
  38. inc["#{path.mongo}.rev"] = 1
  39. set = {}
  40. set["#{path.mongo}.created"] = new Date()
  41. update =
  42. "$inc": inc
  43. "$set": set
  44. Project.update conditions, update, {}, (err) ->
  45. return callback(err) if err?
  46. callback null, fileRef, project, path
  47. mkdirp: (project_id, path, callback) ->
  48. folders = path.split('/')
  49. folders = _.select folders, (folder)->
  50. return folder.length != 0
  51. ProjectGetter.getProjectWithOnlyFolders project_id, (err, project)=>
  52. if path == '/'
  53. logger.log project_id: project._id, "mkdir is only trying to make path of / so sending back root folder"
  54. return callback(null, [], project.rootFolder[0])
  55. logger.log project_id: project._id, path:path, folders:folders, "running mkdirp"
  56. builtUpPath = ''
  57. procesFolder = (previousFolders, folderName, callback)=>
  58. previousFolders = previousFolders || []
  59. parentFolder = previousFolders[previousFolders.length-1]
  60. if parentFolder?
  61. parentFolder_id = parentFolder._id
  62. builtUpPath = "#{builtUpPath}/#{folderName}"
  63. ProjectLocator.findElementByPath project, builtUpPath, (err, foundFolder)=>
  64. if !foundFolder?
  65. logger.log path:path, project_id:project._id, folderName:folderName, "making folder from mkdirp"
  66. self.addFolder project_id, parentFolder_id, folderName, (err, newFolder, parentFolder_id)->
  67. return callback(err) if err?
  68. newFolder.parentFolder_id = parentFolder_id
  69. previousFolders.push newFolder
  70. callback null, previousFolders
  71. else
  72. foundFolder.filterOut = true
  73. previousFolders.push foundFolder
  74. callback null, previousFolders
  75. async.reduce folders, [], procesFolder, (err, folders) ->
  76. return callback(err) if err?
  77. lastFolder = folders[folders.length-1]
  78. folders = _.select folders, (folder)->
  79. !folder.filterOut
  80. callback null, folders, lastFolder
  81. moveEntity: (project_id, entity_id, destFolderId, entityType, callback = (error) ->) ->
  82. ProjectGetter.getProject project_id, {rootFolder:true, name:true}, (err, project) ->
  83. return callback(err) if err?
  84. ProjectLocator.findElement {project, element_id: entity_id, type: entityType}, (err, entity, entityPath)->
  85. return callback(err) if err?
  86. self._checkValidMove project, entityType, entity, entityPath, destFolderId, (error) ->
  87. return callback(error) if error?
  88. ProjectEntityHandler.getAllEntitiesFromProject project, (error, oldDocs, oldFiles) ->
  89. return callback(error) if error?
  90. self._removeElementFromMongoArray Project, project_id, entityPath.mongo, (err, newProject)->
  91. return callback(err) if err?
  92. self._putElement newProject, destFolderId, entity, entityType, (err, result, newProject)->
  93. return callback(err) if err?
  94. ProjectEntityHandler.getAllEntitiesFromProject newProject, (err, newDocs, newFiles) ->
  95. return callback(err) if err?
  96. startPath = entityPath.fileSystem
  97. endPath = result.path.fileSystem
  98. changes = {oldDocs, newDocs, oldFiles, newFiles}
  99. callback null, project.name, startPath, endPath, entity.rev, changes, callback
  100. deleteEntity: (project_id, entity_id, entityType, callback) ->
  101. ProjectGetter.getProject project_id, {name:true, rootFolder:true}, (error, project) ->
  102. return callback(error) if error?
  103. ProjectLocator.findElement {project: project, element_id: entity_id, type: entityType}, (error, entity, path) ->
  104. return callback(error) if error?
  105. self._removeElementFromMongoArray Project, project_id, path.mongo, (error) ->
  106. return callback(error) if error?
  107. callback null, entity, path, project
  108. renameEntity: (project_id, entity_id, entityType, newName, callback) ->
  109. ProjectGetter.getProject project_id, {rootFolder:true, name:true}, (error, project)=>
  110. return callback(error) if error?
  111. ProjectEntityHandler.getAllEntitiesFromProject project, (error, oldDocs, oldFiles) =>
  112. return callback(error) if error?
  113. ProjectLocator.findElement {project:project, element_id:entity_id, type:entityType}, (error, entity, entPath, parentFolder)=>
  114. return callback(error) if error?
  115. # check if the new name already exists in the current folder
  116. self._checkValidElementName parentFolder, newName, (error) =>
  117. return callback(error) if error?
  118. endPath = path.join(path.dirname(entPath.fileSystem), newName)
  119. conditions = {_id:project_id}
  120. update = "$set":{}
  121. namePath = entPath.mongo+".name"
  122. update["$set"][namePath] = newName
  123. Project.findOneAndUpdate conditions, update, { "new": true}, (error, newProject) ->
  124. return callback(error) if error?
  125. ProjectEntityHandler.getAllEntitiesFromProject newProject, (error, newDocs, newFiles) =>
  126. return callback(error) if error?
  127. startPath = entPath.fileSystem
  128. changes = {oldDocs, newDocs, oldFiles, newFiles}
  129. callback null, project.name, startPath, endPath, entity.rev, changes, callback
  130. addFolder: (project_id, parentFolder_id, folderName, callback) ->
  131. ProjectGetter.getProject project_id, {rootFolder:true, name:true}, (err, project) ->
  132. if err?
  133. logger.err project_id:project_id, err:err, "error getting project for add folder"
  134. return callback(err)
  135. self._confirmFolder project, parentFolder_id, (parentFolder_id) =>
  136. folder = new Folder name: folderName
  137. logger.log project: project._id, parentFolder_id:parentFolder_id, folderName:folderName, "adding new folder"
  138. self._putElement project, parentFolder_id, folder, "folder", (err)=>
  139. if err?
  140. logger.err err:err, project_id:project._id, "error adding folder to project"
  141. return callback(err)
  142. callback null, folder, parentFolder_id
  143. _removeElementFromMongoArray: (model, model_id, path, callback = (err, project) ->)->
  144. conditions = {_id:model_id}
  145. update = {"$unset":{}}
  146. update["$unset"][path] = 1
  147. model.update conditions, update, {}, (err)->
  148. pullUpdate = {"$pull":{}}
  149. nonArrayPath = path.slice(0, path.lastIndexOf("."))
  150. pullUpdate["$pull"][nonArrayPath] = null
  151. model.findOneAndUpdate conditions, pullUpdate, {"new": true}, callback
  152. _countElements: (project)->
  153. countFolder = (folder)->
  154. total = 0
  155. for subfolder in folder?.folders or []
  156. total += countFolder(subfolder)
  157. if folder?.folders?.length?
  158. total += folder.folders.length
  159. if folder?.docs?.length?
  160. total += folder.docs.length
  161. if folder?.fileRefs?.length?
  162. total += folder.fileRefs.length
  163. total
  164. countFolder project.rootFolder[0]
  165. _putElement: (project, folder_id, element, type, callback = (err, path, project)->)->
  166. sanitizeTypeOfElement = (elementType)->
  167. lastChar = elementType.slice -1
  168. if lastChar != "s"
  169. elementType +="s"
  170. if elementType == "files"
  171. elementType = "fileRefs"
  172. return elementType
  173. if !element? or !element._id?
  174. e = new Error("no element passed to be inserted")
  175. logger.err project_id:project._id, folder_id:folder_id, element:element, type:type, "failed trying to insert element as it was null"
  176. return callback(e)
  177. type = sanitizeTypeOfElement type
  178. # original check path.resolve("/", element.name) isnt "/#{element.name}" or element.name.match("/")
  179. # check if name is allowed
  180. if not SafePath.isCleanFilename element.name
  181. e = new Errors.InvalidNameError("invalid element name")
  182. logger.err project_id:project._id, folder_id:folder_id, element:element, type:type, "failed trying to insert element as name was invalid"
  183. return callback(e)
  184. if !folder_id?
  185. folder_id = project.rootFolder[0]._id
  186. if self._countElements(project) > settings.maxEntitiesPerProject
  187. logger.warn project_id:project._id, "project too big, stopping insertions"
  188. CooldownManager.putProjectOnCooldown(project._id)
  189. return callback("project_has_to_many_files")
  190. ProjectLocator.findElement {project:project, element_id:folder_id, type:"folders"}, (err, folder, path)=>
  191. if err?
  192. logger.err err:err, project_id:project._id, folder_id:folder_id, type:type, element:element, "error finding folder for _putElement"
  193. return callback(err)
  194. newPath =
  195. fileSystem: "#{path.fileSystem}/#{element.name}"
  196. mongo: path.mongo
  197. # check if the path would be too long
  198. if not SafePath.isAllowedLength newPath.fileSystem
  199. return callback new Errors.InvalidNameError("path too long")
  200. self._checkValidElementName folder, element.name, (err) =>
  201. return callback(err) if err?
  202. id = element._id+''
  203. element._id = require('mongoose').Types.ObjectId(id)
  204. conditions = _id:project._id
  205. mongopath = "#{path.mongo}.#{type}"
  206. update = "$push":{}
  207. update["$push"][mongopath] = element
  208. logger.log project_id: project._id, element_id: element._id, fileType: type, folder_id: folder_id, mongopath:mongopath, "adding element to project"
  209. Project.findOneAndUpdate conditions, update, {"new": true}, (err, project)->
  210. if err?
  211. logger.err err: err, project_id: project._id, 'error saving in putElement project'
  212. return callback(err)
  213. callback(err, {path:newPath}, project)
  214. _checkValidElementName: (folder, name, callback = (err) ->) ->
  215. # check if the name is already taken by a doc, file or
  216. # folder. If so, return an error "file already exists".
  217. err = new Errors.InvalidNameError("file already exists")
  218. for doc in folder?.docs or []
  219. return callback(err) if doc.name is name
  220. for file in folder?.fileRefs or []
  221. return callback(err) if file.name is name
  222. for folder in folder?.folders or []
  223. return callback(err) if folder.name is name
  224. callback()
  225. _confirmFolder: (project, folder_id, callback)->
  226. logger.log folder_id:folder_id, project_id:project._id, "confirming folder in project"
  227. if folder_id+'' == 'undefined'
  228. callback(project.rootFolder[0]._id)
  229. else if folder_id != null
  230. callback folder_id
  231. else
  232. callback(project.rootFolder[0]._id)
  233. _checkValidMove: (project, entityType, entity, entityPath, destFolderId, callback = (error) ->) ->
  234. ProjectLocator.findElement { project, element_id: destFolderId, type:"folder"}, (err, destEntity, destFolderPath) ->
  235. return callback(err) if err?
  236. # check if there is already a doc/file/folder with the same name
  237. # in the destination folder
  238. self._checkValidElementName destEntity, entity.name, (err)->
  239. return callback(err) if err?
  240. if entityType.match(/folder/)
  241. logger.log destFolderPath: destFolderPath.fileSystem, folderPath: entityPath.fileSystem, "checking folder is not moving into child folder"
  242. isNestedFolder = destFolderPath.fileSystem.slice(0, entityPath.fileSystem.length) == entityPath.fileSystem
  243. if isNestedFolder
  244. return callback(new Errors.InvalidNameError("destination folder is a child folder of me"))
  245. callback()