EditorController.coffee 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. logger = require('logger-sharelatex')
  2. Metrics = require('../../infrastructure/Metrics')
  3. sanitize = require('sanitizer')
  4. ProjectEntityHandler = require('../Project/ProjectEntityHandler')
  5. ProjectOptionsHandler = require('../Project/ProjectOptionsHandler')
  6. ProjectDetailsHandler = require('../Project/ProjectDetailsHandler')
  7. ProjectDeleter = require("../Project/ProjectDeleter")
  8. DocumentUpdaterHandler = require('../DocumentUpdater/DocumentUpdaterHandler')
  9. EditorRealTimeController = require("./EditorRealTimeController")
  10. TrackChangesManager = require("../TrackChanges/TrackChangesManager")
  11. async = require('async')
  12. LockManager = require("../../infrastructure/LockManager")
  13. _ = require('underscore')
  14. module.exports = EditorController =
  15. setDoc: (project_id, doc_id, docLines, source, callback = (err)->)->
  16. DocumentUpdaterHandler.setDocument project_id, doc_id, docLines, source, (err)=>
  17. logger.log project_id:project_id, doc_id:doc_id, "notifying users that the document has been updated"
  18. DocumentUpdaterHandler.flushDocToMongo project_id, doc_id, callback
  19. addDoc: (project_id, folder_id, docName, docLines, source, callback = (error, doc)->)->
  20. LockManager.getLock project_id, (err)->
  21. if err?
  22. logger.err err:err, project_id:project_id, source:source, "could not get lock to addDoc"
  23. return callback(err)
  24. EditorController.addDocWithoutLock project_id, folder_id, docName, docLines, source, (error, doc)->
  25. LockManager.releaseLock project_id, ->
  26. callback(error, doc)
  27. addDocWithoutLock: (project_id, folder_id, docName, docLines, source, callback = (error, doc)->)->
  28. docName = docName.trim()
  29. logger.log {project_id, folder_id, docName, source}, "sending new doc to project"
  30. Metrics.inc "editor.add-doc"
  31. ProjectEntityHandler.addDoc project_id, folder_id, docName, docLines, (err, doc, folder_id)=>
  32. EditorRealTimeController.emitToRoom(project_id, 'reciveNewDoc', folder_id, doc, source)
  33. callback(err, doc)
  34. addFile: (project_id, folder_id, fileName, path, source, callback = (error, file)->)->
  35. LockManager.getLock project_id, (err)->
  36. if err?
  37. logger.err err:err, project_id:project_id, source:source, "could not get lock to addFile"
  38. return callback(err)
  39. EditorController.addFileWithoutLock project_id, folder_id, fileName, path, source, (error, file)->
  40. LockManager.releaseLock project_id, ->
  41. callback(error, file)
  42. addFileWithoutLock: (project_id, folder_id, fileName, path, source, callback = (error, file)->)->
  43. fileName = fileName.trim()
  44. logger.log {project_id, folder_id, fileName, path}, "sending new file to project"
  45. Metrics.inc "editor.add-file"
  46. ProjectEntityHandler.addFile project_id, folder_id, fileName, path, (err, fileRef, folder_id)=>
  47. EditorRealTimeController.emitToRoom(project_id, 'reciveNewFile', folder_id, fileRef, source)
  48. callback(err, fileRef)
  49. replaceFile: (project_id, file_id, fsPath, source, callback = (error) ->)->
  50. ProjectEntityHandler.replaceFile project_id, file_id, fsPath, callback
  51. addFolder : (project_id, folder_id, folderName, source, callback = (error, folder)->)->
  52. LockManager.getLock project_id, (err)->
  53. if err?
  54. logger.err err:err, project_id:project_id, source:source, "could not get lock to addFolder"
  55. return callback(err)
  56. EditorController.addFolderWithoutLock project_id, folder_id, folderName, source, (error, folder)->
  57. LockManager.releaseLock project_id, ->
  58. callback(error, folder)
  59. addFolderWithoutLock: (project_id, folder_id, folderName, source, callback = (error, folder)->)->
  60. folderName = folderName.trim()
  61. logger.log {project_id, folder_id, folderName, source}, "sending new folder to project"
  62. Metrics.inc "editor.add-folder"
  63. ProjectEntityHandler.addFolder project_id, folder_id, folderName, (err, folder, folder_id)=>
  64. @p.notifyProjectUsersOfNewFolder project_id, folder_id, folder, (error) ->
  65. callback error, folder
  66. mkdirp : (project_id, path, callback)->
  67. LockManager.getLock project_id, (err)->
  68. if err?
  69. logger.err err:err, project_id:project_id, "could not get lock to mkdirp"
  70. return callback(err)
  71. EditorController.mkdirpWithoutLock project_id, path, (err, newFolders, lastFolder)->
  72. LockManager.releaseLock project_id, ->
  73. callback(err, newFolders, lastFolder)
  74. mkdirpWithoutLock: (project_id, path, callback)->
  75. logger.log project_id:project_id, path:path, "making directories if they don't exist"
  76. ProjectEntityHandler.mkdirp project_id, path, (err, newFolders, lastFolder)=>
  77. self = @
  78. jobs = _.map newFolders, (folder, index)->
  79. return (cb)->
  80. self.p.notifyProjectUsersOfNewFolder project_id, folder.parentFolder_id, folder, cb
  81. async.series jobs, (err)->
  82. callback err, newFolders, lastFolder
  83. deleteEntity : (project_id, entity_id, entityType, source, callback)->
  84. LockManager.getLock project_id, (err)->
  85. if err?
  86. logger.err err:err, project_id:project_id, "could not get lock to deleteEntity"
  87. return callback(err)
  88. EditorController.deleteEntityWithoutLock project_id, entity_id, entityType, source, (err)->
  89. LockManager.releaseLock project_id, ()->
  90. callback(err)
  91. deleteEntityWithoutLock: (project_id, entity_id, entityType, source, callback)->
  92. logger.log {project_id, entity_id, entityType, source}, "start delete process of entity"
  93. Metrics.inc "editor.delete-entity"
  94. ProjectEntityHandler.deleteEntity project_id, entity_id, entityType, =>
  95. logger.log project_id:project_id, entity_id:entity_id, entityType:entityType, "telling users entity has been deleted"
  96. EditorRealTimeController.emitToRoom(project_id, 'removeEntity', entity_id, source)
  97. if callback?
  98. callback()
  99. getListOfDocPaths: (project_id, callback)->
  100. ProjectEntityHandler.getAllDocs project_id, (err, docs)->
  101. docList = _.map docs, (doc, path)->
  102. return {_id:doc._id, path:path.substring(1)}
  103. callback(null, docList)
  104. notifyUsersProjectHasBeenDeletedOrRenamed: (project_id, callback)->
  105. EditorRealTimeController.emitToRoom(project_id, 'projectRenamedOrDeletedByExternalSource')
  106. callback()
  107. updateProjectDescription: (project_id, description, callback = ->)->
  108. logger.log project_id:project_id, description:description, "updating project description"
  109. ProjectDetailsHandler.setProjectDescription project_id, description, (err)->
  110. if err?
  111. logger.err err:err, project_id:project_id, description:description, "something went wrong setting the project description"
  112. return callback(err)
  113. EditorRealTimeController.emitToRoom(project_id, 'projectDescriptionUpdated', description)
  114. callback()
  115. deleteProject: (project_id, callback)->
  116. Metrics.inc "editor.delete-project"
  117. logger.log project_id:project_id, "recived message to delete project"
  118. ProjectDeleter.deleteProject project_id, callback
  119. renameEntity: (project_id, entity_id, entityType, newName, callback)->
  120. newName = sanitize.escape(newName)
  121. Metrics.inc "editor.rename-entity"
  122. logger.log entity_id:entity_id, entity_id:entity_id, entity_id:entity_id, "reciving new name for entity for project"
  123. ProjectEntityHandler.renameEntity project_id, entity_id, entityType, newName, =>
  124. if newName.length > 0
  125. EditorRealTimeController.emitToRoom project_id, 'reciveEntityRename', entity_id, newName
  126. callback?()
  127. #
  128. moveEntity: (project_id, entity_id, folder_id, entityType, callback)->
  129. Metrics.inc "editor.move-entity"
  130. ProjectEntityHandler.moveEntity project_id, entity_id, folder_id, entityType, =>
  131. EditorRealTimeController.emitToRoom project_id, 'reciveEntityMove', entity_id, folder_id
  132. callback?()
  133. renameProject: (project_id, newName, callback = (err) ->) ->
  134. ProjectDetailsHandler.renameProject project_id, newName, =>
  135. EditorRealTimeController.emitToRoom project_id, 'projectNameUpdated', newName
  136. callback()
  137. setCompiler : (project_id, compiler, callback = (err) ->) ->
  138. ProjectOptionsHandler.setCompiler project_id, compiler, (err) ->
  139. return callback(err) if err?
  140. logger.log compiler:compiler, project_id:project_id, "setting compiler"
  141. EditorRealTimeController.emitToRoom project_id, 'compilerUpdated', compiler
  142. callback()
  143. setSpellCheckLanguage : (project_id, languageCode, callback = (err) ->) ->
  144. ProjectOptionsHandler.setSpellCheckLanguage project_id, languageCode, (err) ->
  145. return callback(err) if err?
  146. logger.log languageCode:languageCode, project_id:project_id, "setting languageCode for spell check"
  147. EditorRealTimeController.emitToRoom project_id, 'spellCheckLanguageUpdated', languageCode
  148. callback()
  149. setPublicAccessLevel : (project_id, newAccessLevel, callback = (err) ->) ->
  150. ProjectDetailsHandler.setPublicAccessLevel project_id, newAccessLevel, (err) ->
  151. return callback(err) if err?
  152. EditorRealTimeController.emitToRoom project_id, 'publicAccessLevelUpdated', newAccessLevel
  153. callback()
  154. setRootDoc: (project_id, newRootDocID, callback = (err) ->) ->
  155. ProjectEntityHandler.setRootDoc project_id, newRootDocID, (err) ->
  156. return callback(err) if err?
  157. EditorRealTimeController.emitToRoom project_id, 'rootDocUpdated', newRootDocID
  158. callback()
  159. p:
  160. notifyProjectUsersOfNewFolder: (project_id, folder_id, folder, callback = (error)->)->
  161. logger.log project_id:project_id, folder:folder, parentFolder_id:folder_id, "sending newly created folder out to users"
  162. EditorRealTimeController.emitToRoom(project_id, "reciveNewFolder", folder_id, folder)
  163. callback()