ProjectEntityUpdateHandler.coffee 24 KB

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