ProjectEntityUpdateHandler.coffee 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  1. _ = require 'lodash'
  2. async = require 'async'
  3. logger = require('logger-sharelatex')
  4. path = require('path')
  5. Doc = require('../../models/Doc').Doc
  6. DocstoreManager = require('../Docstore/DocstoreManager')
  7. DocumentUpdaterHandler = require('../../Features/DocumentUpdater/DocumentUpdaterHandler')
  8. Errors = require '../Errors/Errors'
  9. File = require('../../models/File').File
  10. FileStoreHandler = require('../FileStore/FileStoreHandler')
  11. LockManager = require('../../infrastructure/LockManager')
  12. Project = require('../../models/Project').Project
  13. ProjectEntityHandler = require('./ProjectEntityHandler')
  14. ProjectGetter = require('./ProjectGetter')
  15. ProjectLocator = require('./ProjectLocator')
  16. ProjectUpdateHandler = require('./ProjectUpdateHandler')
  17. ProjectEntityMongoUpdateHandler = require('./ProjectEntityMongoUpdateHandler')
  18. SafePath = require './SafePath'
  19. TpdsUpdateSender = require('../ThirdPartyDataStore/TpdsUpdateSender')
  20. LOCK_NAMESPACE = "sequentialProjectStructureUpdateLock"
  21. wrapWithLock = (methodWithoutLock) ->
  22. # This lock is used to make sure that the project structure updates are made
  23. # sequentially. In particular the updates must be made in mongo and sent to
  24. # the doc-updater in the same order.
  25. if typeof methodWithoutLock is 'function'
  26. methodWithLock = (project_id, args..., callback) ->
  27. LockManager.runWithLock LOCK_NAMESPACE, project_id,
  28. (cb) -> methodWithoutLock project_id, args..., cb
  29. callback
  30. methodWithLock.withoutLock = methodWithoutLock
  31. methodWithLock
  32. else
  33. # handle case with separate setup and locked stages
  34. wrapWithSetup = methodWithoutLock.beforeLock # a function to set things up before the lock
  35. mainTask = methodWithoutLock.withLock # function to execute inside the lock
  36. methodWithLock = wrapWithSetup (project_id, args..., callback) ->
  37. LockManager.runWithLock(LOCK_NAMESPACE, project_id, (cb) ->
  38. mainTask(project_id, args..., cb)
  39. callback)
  40. methodWithLock.withoutLock = wrapWithSetup mainTask
  41. methodWithLock.beforeLock = methodWithoutLock.beforeLock
  42. methodWithLock.mainTask = methodWithoutLock.withLock
  43. methodWithLock
  44. module.exports = ProjectEntityUpdateHandler = self =
  45. copyFileFromExistingProjectWithProject: wrapWithLock
  46. beforeLock: (next) ->
  47. (project, folder_id, originalProject_id, origonalFileRef, userId, callback = (error, fileRef, folder_id) ->)->
  48. project_id = project._id
  49. logger.log { project_id, folder_id, originalProject_id, origonalFileRef }, "copying file in s3 with project"
  50. ProjectEntityMongoUpdateHandler._confirmFolder project, folder_id, (folder_id) ->
  51. if !origonalFileRef?
  52. logger.err { project_id, folder_id, originalProject_id, origonalFileRef }, "file trying to copy is null"
  53. return callback()
  54. # convert any invalid characters in original file to '_'
  55. fileProperties = name : SafePath.clean(origonalFileRef.name)
  56. if origonalFileRef.linkedFileData?
  57. fileProperties.linkedFileData = origonalFileRef.linkedFileData
  58. fileRef = new File(fileProperties)
  59. FileStoreHandler.copyFile originalProject_id, origonalFileRef._id, project._id, fileRef._id, (err, fileStoreUrl)->
  60. if err?
  61. logger.err { err, project_id, folder_id, originalProject_id, origonalFileRef }, "error coping file in s3"
  62. return callback(err)
  63. next(project, folder_id, originalProject_id, origonalFileRef, userId, fileRef, fileStoreUrl, callback)
  64. withLock: (project, folder_id, originalProject_id, origonalFileRef, userId, fileRef, fileStoreUrl, callback = (error, fileRef, folder_id) ->)->
  65. project_id = project._id
  66. projectHistoryId = project.overleaf?.history?.id
  67. ProjectEntityMongoUpdateHandler._putElement project, folder_id, fileRef, "file", (err, result, newProject) ->
  68. if err?
  69. logger.err { err, project_id, folder_id }, "error putting element as part of copy"
  70. return callback(err)
  71. TpdsUpdateSender.addFile { project_id, file_id:fileRef._id, path:result?.path?.fileSystem, rev:fileRef.rev, project_name:project.name}, (err) ->
  72. if err?
  73. logger.err { err, project_id, folder_id, originalProject_id, origonalFileRef }, "error sending file to tpds worker"
  74. newFiles = [
  75. file: fileRef
  76. path: result?.path?.fileSystem
  77. url: fileStoreUrl
  78. ]
  79. DocumentUpdaterHandler.updateProjectStructure project_id, projectHistoryId, userId, {newFiles, newProject}, (error) ->
  80. return callback(error) if error?
  81. callback null, fileRef, folder_id
  82. updateDocLines: (project_id, doc_id, lines, version, ranges, callback = (error) ->)->
  83. ProjectGetter.getProjectWithoutDocLines project_id, (err, project)->
  84. return callback(err) if err?
  85. return callback(new Errors.NotFoundError("project not found")) if !project?
  86. logger.log project_id: project_id, doc_id: doc_id, "updating doc lines"
  87. ProjectLocator.findElement {project:project, element_id:doc_id, type:"docs"}, (err, doc, path)->
  88. isDeletedDoc = false
  89. if err?
  90. if err instanceof Errors.NotFoundError
  91. # We need to be able to update the doclines of deleted docs. This is
  92. # so the doc-updater can flush a doc's content to the doc-store after
  93. # the doc is deleted.
  94. isDeletedDoc = true
  95. doc = _.find project.deletedDocs, (doc) ->
  96. doc._id.toString() == doc_id.toString()
  97. else
  98. return callback(err)
  99. if !doc?
  100. # Do not allow an update to a doc which has never exist on this project
  101. logger.error {doc_id, project_id, lines}, "doc not found while updating doc lines"
  102. return callback(new Errors.NotFoundError('doc not found'))
  103. logger.log {project_id, doc_id}, "telling docstore manager to update doc"
  104. DocstoreManager.updateDoc project_id, doc_id, lines, version, ranges, (err, modified, rev) ->
  105. if err?
  106. logger.error {err, doc_id, project_id, lines}, "error sending doc to docstore"
  107. return callback(err)
  108. logger.log {project_id, doc_id, modified}, "finished updating doc lines"
  109. # path will only be present if the doc is not deleted
  110. if modified && !isDeletedDoc
  111. # Don't need to block for marking as updated
  112. ProjectUpdateHandler.markAsUpdated project_id
  113. TpdsUpdateSender.addDoc {project_id:project_id, path:path.fileSystem, doc_id:doc_id, project_name:project.name, rev:rev}, callback
  114. else
  115. callback()
  116. setRootDoc: (project_id, newRootDocID, callback = (error) ->)->
  117. logger.log project_id: project_id, rootDocId: newRootDocID, "setting root doc"
  118. Project.update {_id:project_id}, {rootDoc_id:newRootDocID}, {}, callback
  119. unsetRootDoc: (project_id, callback = (error) ->) ->
  120. logger.log project_id: project_id, "removing root doc"
  121. Project.update {_id:project_id}, {$unset: {rootDoc_id: true}}, {}, callback
  122. _addDocAndSendToTpds: (project_id, folder_id, doc, callback = (error, result, project) ->)->
  123. ProjectEntityMongoUpdateHandler.addDoc project_id, folder_id, doc, (err, result, project) ->
  124. if err?
  125. logger.err err:err, project_id: project_id, folder_id: folder_id, doc_name: doc?.name, doc_id:doc?._id, "error adding file with project"
  126. return callback(err)
  127. TpdsUpdateSender.addDoc {
  128. project_id: project_id,
  129. doc_id: doc?._id,
  130. path: result?.path?.fileSystem,
  131. project_name: project.name,
  132. rev: 0
  133. }, (err) ->
  134. return callback(err) if err?
  135. callback(null, result, project)
  136. addDoc: wrapWithLock
  137. beforeLock: (next) ->
  138. (project_id, folder_id, docName, docLines, userId, callback = (error, doc, folder_id) ->) ->
  139. if not SafePath.isCleanFilename docName
  140. return callback new Errors.InvalidNameError("invalid element name")
  141. # Put doc in docstore first, so that if it errors, we don't have a doc_id in the project
  142. # which hasn't been created in docstore.
  143. doc = new Doc name: docName
  144. DocstoreManager.updateDoc project_id.toString(), doc._id.toString(), docLines, 0, {}, (err, modified, rev) ->
  145. return callback(err) if err?
  146. next(project_id, folder_id, doc, docName, docLines, userId, callback)
  147. withLock: (project_id, folder_id, doc, docName, docLines, userId, callback = (error, doc, folder_id) ->) ->
  148. ProjectEntityUpdateHandler._addDocAndSendToTpds project_id, folder_id, doc, (err, result, project) ->
  149. return callback(err) if err?
  150. docPath = result?.path?.fileSystem
  151. projectHistoryId = project.overleaf?.history?.id
  152. newDocs = [
  153. doc: doc
  154. path: docPath
  155. docLines: docLines.join('\n')
  156. ]
  157. DocumentUpdaterHandler.updateProjectStructure project_id, projectHistoryId, userId, {newDocs}, (error) ->
  158. return callback(error) if error?
  159. callback null, doc, folder_id
  160. _uploadFile: (project_id, folder_id, fileName, fsPath, linkedFileData, callback = (error, fileRef, fileStoreUrl) ->)->
  161. if not SafePath.isCleanFilename fileName
  162. return callback new Errors.InvalidNameError("invalid element name")
  163. fileRef = new File(
  164. name: fileName
  165. linkedFileData: linkedFileData
  166. )
  167. FileStoreHandler.uploadFileFromDisk project_id, fileRef._id, fsPath, (err, fileStoreUrl)->
  168. if err?
  169. logger.err err:err, project_id: project_id, folder_id: folder_id, file_name: fileName, fileRef:fileRef, "error uploading image to s3"
  170. return callback(err)
  171. callback(null, fileRef, fileStoreUrl)
  172. _addFileAndSendToTpds: (project_id, folder_id, fileRef, callback = (error) ->)->
  173. ProjectEntityMongoUpdateHandler.addFile project_id, folder_id, fileRef, (err, result, project) ->
  174. if err?
  175. logger.err err:err, project_id: project_id, folder_id: folder_id, file_name: fileRef.name, fileRef:fileRef, "error adding file with project"
  176. return callback(err)
  177. TpdsUpdateSender.addFile {project_id:project_id, file_id:fileRef._id, path:result?.path?.fileSystem, project_name:project.name, rev:fileRef.rev}, (err) ->
  178. return callback(err) if err?
  179. callback(null, result, project)
  180. addFile: wrapWithLock
  181. beforeLock: (next) ->
  182. (project_id, folder_id, fileName, fsPath, linkedFileData, userId, callback) ->
  183. if not SafePath.isCleanFilename fileName
  184. return callback new Errors.InvalidNameError("invalid element name")
  185. ProjectEntityUpdateHandler._uploadFile project_id, folder_id, fileName, fsPath, linkedFileData, (error, fileRef, fileStoreUrl) ->
  186. return callback(error) if error?
  187. next(project_id, folder_id, fileName, fsPath, linkedFileData, userId, fileRef, fileStoreUrl, callback)
  188. withLock: (project_id, folder_id, fileName, fsPath, linkedFileData, userId, fileRef, fileStoreUrl, callback = (error, fileRef, folder_id) ->)->
  189. ProjectEntityUpdateHandler._addFileAndSendToTpds project_id, folder_id, fileRef, (err, result, project) ->
  190. return callback(err) if err?
  191. projectHistoryId = project.overleaf?.history?.id
  192. newFiles = [
  193. file: fileRef
  194. path: result?.path?.fileSystem
  195. url: fileStoreUrl
  196. ]
  197. DocumentUpdaterHandler.updateProjectStructure project_id, projectHistoryId, userId, {newFiles}, (error) ->
  198. return callback(error) if error?
  199. callback(null, fileRef, folder_id)
  200. replaceFile: wrapWithLock
  201. beforeLock: (next) ->
  202. (project_id, file_id, fsPath, linkedFileData, userId, callback)->
  203. # create a new file
  204. fileRef = new File(
  205. name: "dummy-upload-filename"
  206. linkedFileData: linkedFileData
  207. )
  208. FileStoreHandler.uploadFileFromDisk project_id, fileRef._id, fsPath, (err, fileStoreUrl)->
  209. return callback(err) if err?
  210. next project_id, file_id, fsPath, linkedFileData, userId, fileRef, fileStoreUrl, callback
  211. withLock: (project_id, file_id, fsPath, linkedFileData, userId, newFileRef, fileStoreUrl, callback)->
  212. ProjectEntityMongoUpdateHandler.replaceFileWithNew project_id, file_id, newFileRef, (err, oldFileRef, project, path) ->
  213. return callback(err) if err?
  214. oldFiles = [
  215. file: oldFileRef
  216. path: path.fileSystem
  217. ]
  218. newFiles = [
  219. file: newFileRef
  220. path: path.fileSystem
  221. url: fileStoreUrl
  222. ]
  223. projectHistoryId = project.overleaf?.history?.id
  224. TpdsUpdateSender.addFile {project_id:project._id, file_id:newFileRef._id, path:path.fileSystem, rev:newFileRef.rev+1, project_name:project.name}, (err) ->
  225. return callback(err) if err?
  226. DocumentUpdaterHandler.updateProjectStructure project_id, projectHistoryId, userId, {oldFiles, newFiles}, callback
  227. upsertDoc: wrapWithLock (project_id, folder_id, docName, docLines, source, userId, callback = (err, doc, folder_id, isNewDoc)->)->
  228. if not SafePath.isCleanFilename docName
  229. return callback new Errors.InvalidNameError("invalid element name")
  230. ProjectLocator.findElement project_id: project_id, element_id: folder_id, type: "folder", (error, folder) ->
  231. return callback(error) if error?
  232. return callback(new Error("Couldn't find folder")) if !folder?
  233. existingDoc = null
  234. for doc in folder.docs
  235. if doc.name == docName
  236. existingDoc = doc
  237. break
  238. if existingDoc?
  239. DocumentUpdaterHandler.setDocument project_id, existingDoc._id, userId, docLines, source, (err)=>
  240. logger.log project_id:project_id, doc_id:existingDoc._id, "notifying users that the document has been updated"
  241. DocumentUpdaterHandler.flushDocToMongo project_id, existingDoc._id, (err) ->
  242. return callback(err) if err?
  243. callback null, existingDoc, !existingDoc?
  244. else
  245. self.addDoc.withoutLock project_id, folder_id, docName, docLines, userId, (err, doc) ->
  246. return callback(err) if err?
  247. callback null, doc, !existingDoc?
  248. upsertFile: wrapWithLock
  249. beforeLock: (next) ->
  250. (project_id, folder_id, fileName, fsPath, linkedFileData, userId, callback)->
  251. if not SafePath.isCleanFilename fileName
  252. return callback new Errors.InvalidNameError("invalid element name")
  253. # create a new file
  254. fileRef = new File(
  255. name: fileName
  256. linkedFileData: linkedFileData
  257. )
  258. FileStoreHandler.uploadFileFromDisk project_id, fileRef._id, fsPath, (err, fileStoreUrl)->
  259. return callback(err) if err?
  260. next(project_id, folder_id, fileName, fsPath, linkedFileData, userId, fileRef, fileStoreUrl, callback)
  261. withLock: (project_id, folder_id, fileName, fsPath, linkedFileData, userId, newFileRef, fileStoreUrl, callback = (err, file, isNewFile, existingFile)->)->
  262. ProjectLocator.findElement project_id: project_id, element_id: folder_id, type: "folder", (error, folder) ->
  263. return callback(error) if error?
  264. return callback(new Error("Couldn't find folder")) if !folder?
  265. existingFile = null
  266. for fileRef in folder.fileRefs
  267. if fileRef.name == fileName
  268. existingFile = fileRef
  269. break
  270. if existingFile?
  271. # this calls directly into the replaceFile main task (without the beforeLock part)
  272. self.replaceFile.mainTask project_id, existingFile._id, fsPath, linkedFileData, userId, newFileRef, fileStoreUrl, (err) ->
  273. return callback(err) if err?
  274. callback null, newFileRef, !existingFile?, existingFile
  275. else
  276. # this calls directly into the addFile main task (without the beforeLock part)
  277. self.addFile.mainTask project_id, folder_id, fileName, fsPath, linkedFileData, userId, newFileRef, fileStoreUrl, (err) ->
  278. return callback(err) if err?
  279. callback null, newFileRef, !existingFile?, existingFile
  280. upsertDocWithPath: wrapWithLock (project_id, elementPath, docLines, source, userId, callback) ->
  281. if not SafePath.isCleanPath elementPath
  282. return callback new Errors.InvalidNameError("invalid element name")
  283. docName = path.basename(elementPath)
  284. folderPath = path.dirname(elementPath)
  285. self.mkdirp.withoutLock project_id, folderPath, (err, newFolders, folder) ->
  286. return callback(err) if err?
  287. self.upsertDoc.withoutLock project_id, folder._id, docName, docLines, source, userId, (err, doc, isNewDoc) ->
  288. return callback(err) if err?
  289. callback null, doc, isNewDoc, newFolders, folder
  290. upsertFileWithPath: wrapWithLock
  291. beforeLock: (next) ->
  292. (project_id, elementPath, fsPath, linkedFileData, userId, callback)->
  293. if not SafePath.isCleanPath elementPath
  294. return callback new Errors.InvalidNameError("invalid element name")
  295. fileName = path.basename(elementPath)
  296. folderPath = path.dirname(elementPath)
  297. # create a new file
  298. fileRef = new File(
  299. name: fileName
  300. linkedFileData: linkedFileData
  301. )
  302. FileStoreHandler.uploadFileFromDisk project_id, fileRef._id, fsPath, (err, fileStoreUrl)->
  303. return callback(err) if err?
  304. next project_id, folderPath, fileName, fsPath, linkedFileData, userId, fileRef, fileStoreUrl, callback
  305. withLock: (project_id, folderPath, fileName, fsPath, linkedFileData, userId, fileRef, fileStoreUrl, callback) ->
  306. self.mkdirp.withoutLock project_id, folderPath, (err, newFolders, folder) ->
  307. return callback(err) if err?
  308. # this calls directly into the upsertFile main task (without the beforeLock part)
  309. self.upsertFile.mainTask project_id, folder._id, fileName, fsPath, linkedFileData, userId, fileRef, fileStoreUrl, (err, newFile, isNewFile, existingFile) ->
  310. return callback(err) if err?
  311. callback null, newFile, isNewFile, existingFile, newFolders, folder
  312. deleteEntity: wrapWithLock (project_id, entity_id, entityType, userId, callback = (error) ->)->
  313. logger.log entity_id:entity_id, entityType:entityType, project_id:project_id, "deleting project entity"
  314. if !entityType?
  315. logger.err err: "No entityType set", project_id: project_id, entity_id: entity_id
  316. return callback("No entityType set")
  317. entityType = entityType.toLowerCase()
  318. ProjectEntityMongoUpdateHandler.deleteEntity project_id, entity_id, entityType, (error, entity, path, projectBeforeDeletion) ->
  319. return callback(error) if error?
  320. self._cleanUpEntity projectBeforeDeletion, entity, entityType, path.fileSystem, userId, (error) ->
  321. return callback(error) if error?
  322. TpdsUpdateSender.deleteEntity project_id:project_id, path:path.fileSystem, project_name:projectBeforeDeletion.name, (error) ->
  323. return callback(error) if error?
  324. callback null, entity_id
  325. deleteEntityWithPath: wrapWithLock (project_id, path, userId, callback) ->
  326. ProjectLocator.findElementByPath project_id: project_id, path: path, (err, element, type)->
  327. return callback(err) if err?
  328. return callback(new Errors.NotFoundError("project not found")) if !element?
  329. self.deleteEntity.withoutLock project_id, element._id, type, userId, callback
  330. mkdirp: wrapWithLock (project_id, path, callback = (err, newlyCreatedFolders, lastFolderInPath)->)->
  331. for folder in path.split('/')
  332. if folder.length > 0 and not SafePath.isCleanFilename folder
  333. return callback new Errors.InvalidNameError("invalid element name")
  334. ProjectEntityMongoUpdateHandler.mkdirp project_id, path, callback
  335. addFolder: wrapWithLock (project_id, parentFolder_id, folderName, callback) ->
  336. if not SafePath.isCleanFilename folderName
  337. return callback new Errors.InvalidNameError("invalid element name")
  338. ProjectEntityMongoUpdateHandler.addFolder project_id, parentFolder_id, folderName, callback
  339. moveEntity: wrapWithLock (project_id, entity_id, destFolderId, entityType, userId, callback = (error) ->)->
  340. logger.log {entityType, entity_id, project_id, destFolderId}, "moving entity"
  341. if !entityType?
  342. logger.err {err: "No entityType set", project_id, entity_id}
  343. return callback("No entityType set")
  344. entityType = entityType.toLowerCase()
  345. ProjectEntityMongoUpdateHandler.moveEntity project_id, entity_id, destFolderId, entityType, (err, project, startPath, endPath, rev, changes) ->
  346. return callback(err) if err?
  347. projectHistoryId = project.overleaf?.history?.id
  348. TpdsUpdateSender.moveEntity { project_id, project_name: project.name, startPath, endPath, rev }
  349. DocumentUpdaterHandler.updateProjectStructure project_id, projectHistoryId, userId, changes, callback
  350. renameEntity: wrapWithLock (project_id, entity_id, entityType, newName, userId, callback)->
  351. if not SafePath.isCleanFilename newName
  352. return callback new Errors.InvalidNameError("invalid element name")
  353. logger.log(entity_id: entity_id, project_id: project_id, ('renaming '+entityType))
  354. if !entityType?
  355. logger.err err: "No entityType set", project_id: project_id, entity_id: entity_id
  356. return callback("No entityType set")
  357. entityType = entityType.toLowerCase()
  358. ProjectEntityMongoUpdateHandler.renameEntity project_id, entity_id, entityType, newName, (err, project, startPath, endPath, rev, changes) ->
  359. return callback(err) if err?
  360. projectHistoryId = project.overleaf?.history?.id
  361. TpdsUpdateSender.moveEntity { project_id, project_name: project.name, startPath, endPath, rev }
  362. DocumentUpdaterHandler.updateProjectStructure project_id, projectHistoryId, userId, changes, callback
  363. # This doesn't directly update project structure but we need to take the lock
  364. # to prevent anything else being queued before the resync update
  365. resyncProjectHistory: wrapWithLock (project_id, callback) ->
  366. ProjectGetter.getProject project_id, rootFolder: true, overleaf: true, (error, project) ->
  367. return callback(error) if error?
  368. projectHistoryId = project?.overleaf?.history?.id
  369. if !projectHistoryId?
  370. error = new Errors.ProjectHistoryDisabledError("project history not enabled for #{project_id}")
  371. return callback(error)
  372. ProjectEntityHandler.getAllEntitiesFromProject project, (error, docs, files) ->
  373. return callback(error) if error?
  374. docs = _.map docs, (doc) ->
  375. doc: doc.doc._id
  376. path: doc.path
  377. files = _.map files, (file) ->
  378. file: file.file._id
  379. path: file.path
  380. url: FileStoreHandler._buildUrl(project_id, file.file._id)
  381. DocumentUpdaterHandler.resyncProjectHistory project_id, projectHistoryId, docs, files, callback
  382. _cleanUpEntity: (project, entity, entityType, path, userId, callback = (error) ->) ->
  383. self._updateProjectStructureWithDeletedEntity project, entity, entityType, path, userId, (error) ->
  384. return callback(error) if error?
  385. if(entityType.indexOf("file") != -1)
  386. self._cleanUpFile project, entity, path, userId, callback
  387. else if (entityType.indexOf("doc") != -1)
  388. self._cleanUpDoc project, entity, path, userId, callback
  389. else if (entityType.indexOf("folder") != -1)
  390. self._cleanUpFolder project, entity, path, userId, callback
  391. else
  392. callback()
  393. # Note: the _cleanUpEntity code and _updateProjectStructureWithDeletedEntity
  394. # methods both need to recursively iterate over the entities in folder.
  395. # These are currently using separate implementations of the recursion. In
  396. # future, these could be simplified using a common project entity iterator.
  397. _updateProjectStructureWithDeletedEntity: (project, entity, entityType, entityPath, userId, callback = (error) ->) ->
  398. # compute the changes to the project structure
  399. if(entityType.indexOf("file") != -1)
  400. changes = oldFiles: [ {file: entity, path: entityPath} ]
  401. else if (entityType.indexOf("doc") != -1)
  402. changes = oldDocs: [ {doc: entity, path: entityPath} ]
  403. else if (entityType.indexOf("folder") != -1)
  404. changes = {oldDocs: [], oldFiles: []}
  405. _recurseFolder = (folder, folderPath) ->
  406. for doc in folder.docs
  407. changes.oldDocs.push {doc, path: path.join(folderPath, doc.name)}
  408. for file in folder.fileRefs
  409. changes.oldFiles.push {file, path: path.join(folderPath, file.name)}
  410. for childFolder in folder.folders
  411. _recurseFolder(childFolder, path.join(folderPath, childFolder.name))
  412. _recurseFolder entity, entityPath
  413. # now send the project structure changes to the docupdater
  414. project_id = project._id.toString()
  415. projectHistoryId = project.overleaf?.history?.id
  416. DocumentUpdaterHandler.updateProjectStructure project_id, projectHistoryId, userId, changes, callback
  417. _cleanUpDoc: (project, doc, path, userId, callback = (error) ->) ->
  418. project_id = project._id.toString()
  419. doc_id = doc._id.toString()
  420. unsetRootDocIfRequired = (callback) =>
  421. if project.rootDoc_id? and project.rootDoc_id.toString() == doc_id
  422. @unsetRootDoc project_id, callback
  423. else
  424. callback()
  425. unsetRootDocIfRequired (error) ->
  426. return callback(error) if error?
  427. ProjectEntityMongoUpdateHandler._insertDeletedDocReference project._id, doc, (error) ->
  428. return callback(error) if error?
  429. DocumentUpdaterHandler.deleteDoc project_id, doc_id, (error) ->
  430. return callback(error) if error?
  431. DocstoreManager.deleteDoc project_id, doc_id, callback
  432. _cleanUpFile: (project, file, path, userId, callback = (error) ->) ->
  433. ProjectEntityMongoUpdateHandler._insertDeletedFileReference project._id, file, callback
  434. _cleanUpFolder: (project, folder, folderPath, userId, callback = (error) ->) ->
  435. jobs = []
  436. for doc in folder.docs
  437. do (doc) ->
  438. docPath = path.join(folderPath, doc.name)
  439. jobs.push (callback) -> self._cleanUpDoc project, doc, docPath, userId, callback
  440. for file in folder.fileRefs
  441. do (file) ->
  442. filePath = path.join(folderPath, file.name)
  443. jobs.push (callback) -> self._cleanUpFile project, file, filePath, userId, callback
  444. for childFolder in folder.folders
  445. do (childFolder) ->
  446. folderPath = path.join(folderPath, childFolder.name)
  447. jobs.push (callback) -> self._cleanUpFolder project, childFolder, folderPath, userId, callback
  448. async.series jobs, callback