ProjectEntityUpdateHandler.coffee 25 KB

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