router.coffee 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. AdminController = require('./Features/ServerAdmin/AdminController')
  2. ErrorController = require('./Features/Errors/ErrorController')
  3. ProjectController = require("./Features/Project/ProjectController")
  4. ProjectApiController = require("./Features/Project/ProjectApiController")
  5. SpellingController = require('./Features/Spelling/SpellingController')
  6. EditorController = require("./Features/Editor/EditorController")
  7. EditorRouter = require("./Features/Editor/EditorRouter")
  8. Settings = require('settings-sharelatex')
  9. TpdsController = require('./Features/ThirdPartyDataStore/TpdsController')
  10. SubscriptionRouter = require './Features/Subscription/SubscriptionRouter'
  11. UploadsRouter = require './Features/Uploads/UploadsRouter'
  12. metrics = require('./infrastructure/Metrics')
  13. ReferalController = require('./Features/Referal/ReferalController')
  14. ReferalMiddleware = require('./Features/Referal/ReferalMiddleware')
  15. AuthenticationController = require('./Features/Authentication/AuthenticationController')
  16. TagsController = require("./Features/Tags/TagsController")
  17. NotificationsController = require("./Features/Notifications/NotificationsController")
  18. CollaboratorsRouter = require('./Features/Collaborators/CollaboratorsRouter')
  19. UserInfoController = require('./Features/User/UserInfoController')
  20. UserController = require("./Features/User/UserController")
  21. UserPagesController = require('./Features/User/UserPagesController')
  22. DocumentController = require('./Features/Documents/DocumentController')
  23. CompileManager = require("./Features/Compile/CompileManager")
  24. CompileController = require("./Features/Compile/CompileController")
  25. HealthCheckController = require("./Features/HealthCheck/HealthCheckController")
  26. ProjectDownloadsController = require "./Features/Downloads/ProjectDownloadsController"
  27. FileStoreController = require("./Features/FileStore/FileStoreController")
  28. TrackChangesController = require("./Features/TrackChanges/TrackChangesController")
  29. PasswordResetRouter = require("./Features/PasswordReset/PasswordResetRouter")
  30. StaticPagesRouter = require("./Features/StaticPages/StaticPagesRouter")
  31. ChatController = require("./Features/Chat/ChatController")
  32. BlogController = require("./Features/Blog/BlogController")
  33. Modules = require "./infrastructure/Modules"
  34. RateLimiterMiddlewear = require('./Features/Security/RateLimiterMiddlewear')
  35. RealTimeProxyRouter = require('./Features/RealTimeProxy/RealTimeProxyRouter')
  36. InactiveProjectController = require("./Features/InactiveData/InactiveProjectController")
  37. ContactRouter = require("./Features/Contacts/ContactRouter")
  38. ReferencesController = require('./Features/References/ReferencesController')
  39. AuthorizationMiddlewear = require('./Features/Authorization/AuthorizationMiddlewear')
  40. BetaProgramController = require('./Features/BetaProgram/BetaProgramController')
  41. AnalyticsRouter = require('./Features/Analytics/AnalyticsRouter')
  42. logger = require("logger-sharelatex")
  43. _ = require("underscore")
  44. module.exports = class Router
  45. constructor: (webRouter, apiRouter)->
  46. if !Settings.allowPublicAccess
  47. webRouter.all '*', AuthenticationController.requireGlobalLogin
  48. webRouter.get '/login', UserPagesController.loginPage
  49. AuthenticationController.addEndpointToLoginWhitelist '/login'
  50. webRouter.post '/login', AuthenticationController.login
  51. webRouter.get '/logout', UserController.logout
  52. webRouter.get '/restricted', AuthorizationMiddlewear.restricted
  53. # Left as a placeholder for implementing a public register page
  54. webRouter.get '/register', UserPagesController.registerPage
  55. AuthenticationController.addEndpointToLoginWhitelist '/register'
  56. EditorRouter.apply(webRouter, apiRouter)
  57. CollaboratorsRouter.apply(webRouter, apiRouter)
  58. SubscriptionRouter.apply(webRouter, apiRouter)
  59. UploadsRouter.apply(webRouter, apiRouter)
  60. PasswordResetRouter.apply(webRouter, apiRouter)
  61. StaticPagesRouter.apply(webRouter, apiRouter)
  62. RealTimeProxyRouter.apply(webRouter, apiRouter)
  63. ContactRouter.apply(webRouter, apiRouter)
  64. AnalyticsRouter.apply(webRouter, apiRouter)
  65. Modules.applyRouter(webRouter, apiRouter)
  66. if Settings.enableSubscriptions
  67. webRouter.get '/user/bonus', AuthenticationController.requireLogin(), ReferalMiddleware.getUserReferalId, ReferalController.bonus
  68. webRouter.get '/blog', BlogController.getIndexPage
  69. webRouter.get '/blog/*', BlogController.getPage
  70. webRouter.get '/user/activate', UserPagesController.activateAccountPage
  71. AuthenticationController.addEndpointToLoginWhitelist '/user/activate'
  72. webRouter.get '/user/settings', AuthenticationController.requireLogin(), UserPagesController.settingsPage
  73. webRouter.post '/user/settings', AuthenticationController.requireLogin(), UserController.updateUserSettings
  74. webRouter.post '/user/password/update', AuthenticationController.requireLogin(), UserController.changePassword
  75. webRouter.delete '/user/newsletter/unsubscribe', AuthenticationController.requireLogin(), UserController.unsubscribe
  76. webRouter.delete '/user', AuthenticationController.requireLogin(), UserController.deleteUser
  77. webRouter.get '/user/personal_info', AuthenticationController.requireLogin(), UserInfoController.getLoggedInUsersPersonalInfo
  78. apiRouter.get '/user/:user_id/personal_info', AuthenticationController.httpAuth, UserInfoController.getPersonalInfo
  79. webRouter.get '/project', AuthenticationController.requireLogin(), ProjectController.projectListPage
  80. webRouter.post '/project/new', AuthenticationController.requireLogin(), ProjectController.newProject
  81. webRouter.get '/Project/:Project_id', RateLimiterMiddlewear.rateLimit({
  82. endpointName: "open-project"
  83. params: ["Project_id"]
  84. maxRequests: 10
  85. timeInterval: 60
  86. }), AuthorizationMiddlewear.ensureUserCanReadProject, ProjectController.loadEditor
  87. webRouter.get '/Project/:Project_id/file/:File_id', AuthorizationMiddlewear.ensureUserCanReadProject, FileStoreController.getFile
  88. webRouter.post '/project/:Project_id/settings', AuthorizationMiddlewear.ensureUserCanWriteProjectSettings, ProjectController.updateProjectSettings
  89. webRouter.post '/project/:Project_id/settings/admin', AuthorizationMiddlewear.ensureUserCanAdminProject, ProjectController.updateProjectAdminSettings
  90. webRouter.post '/project/:Project_id/compile', AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.compile
  91. webRouter.post '/project/:Project_id/compile/stop', AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.stopCompile
  92. # Used by the web download buttons, adds filename header
  93. webRouter.get '/project/:Project_id/output/output.pdf', AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.downloadPdf
  94. # Used by the pdf viewers
  95. webRouter.get /^\/project\/([^\/]*)\/output\/(.*)$/,
  96. ((req, res, next) ->
  97. params =
  98. "Project_id": req.params[0]
  99. "file": req.params[1]
  100. req.params = params
  101. next()
  102. ), AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.getFileFromClsi
  103. # direct url access to output files for a specific build (query string not required)
  104. webRouter.get /^\/project\/([^\/]*)\/build\/([0-9a-f-]+)\/output\/(.*)$/,
  105. ((req, res, next) ->
  106. params =
  107. "Project_id": req.params[0]
  108. "build_id": req.params[1]
  109. "file": req.params[2]
  110. req.params = params
  111. next()
  112. ), AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.getFileFromClsi
  113. # direct url access to output files for user but no build, to retrieve files when build fails
  114. webRouter.get /^\/project\/([^\/]*)\/user\/([0-9a-f-]+)\/output\/(.*)$/,
  115. ((req, res, next) ->
  116. params =
  117. "Project_id": req.params[0]
  118. "user_id": req.params[1]
  119. "file": req.params[2]
  120. req.params = params
  121. next()
  122. ), AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.getFileFromClsi
  123. # direct url access to output files for a specific user and build (query string not required)
  124. webRouter.get /^\/project\/([^\/]*)\/user\/([0-9a-f]+)\/build\/([0-9a-f-]+)\/output\/(.*)$/,
  125. ((req, res, next) ->
  126. params =
  127. "Project_id": req.params[0]
  128. "user_id": req.params[1]
  129. "build_id": req.params[2]
  130. "file": req.params[3]
  131. req.params = params
  132. next()
  133. ), AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.getFileFromClsi
  134. webRouter.delete "/project/:Project_id/output", AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.deleteAuxFiles
  135. webRouter.get "/project/:Project_id/sync/code", AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.proxySyncCode
  136. webRouter.get "/project/:Project_id/sync/pdf", AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.proxySyncPdf
  137. webRouter.get "/project/:Project_id/wordcount", AuthorizationMiddlewear.ensureUserCanReadProject, CompileController.wordCount
  138. webRouter.delete '/Project/:Project_id', AuthorizationMiddlewear.ensureUserCanAdminProject, ProjectController.deleteProject
  139. webRouter.post '/Project/:Project_id/restore', AuthorizationMiddlewear.ensureUserCanAdminProject, ProjectController.restoreProject
  140. webRouter.post '/Project/:Project_id/clone', AuthorizationMiddlewear.ensureUserCanReadProject, ProjectController.cloneProject
  141. webRouter.post '/project/:Project_id/rename', AuthorizationMiddlewear.ensureUserCanAdminProject, ProjectController.renameProject
  142. webRouter.get "/project/:Project_id/updates", AuthorizationMiddlewear.ensureUserCanReadProject, TrackChangesController.proxyToTrackChangesApi
  143. webRouter.get "/project/:Project_id/doc/:doc_id/diff", AuthorizationMiddlewear.ensureUserCanReadProject, TrackChangesController.proxyToTrackChangesApi
  144. webRouter.post "/project/:Project_id/doc/:doc_id/version/:version_id/restore", AuthorizationMiddlewear.ensureUserCanReadProject, TrackChangesController.proxyToTrackChangesApi
  145. webRouter.get '/Project/:Project_id/download/zip', AuthorizationMiddlewear.ensureUserCanReadProject, ProjectDownloadsController.downloadProject
  146. webRouter.get '/project/download/zip', AuthorizationMiddlewear.ensureUserCanReadMultipleProjects, ProjectDownloadsController.downloadMultipleProjects
  147. webRouter.get '/tag', AuthenticationController.requireLogin(), TagsController.getAllTags
  148. webRouter.post '/tag', AuthenticationController.requireLogin(), TagsController.createTag
  149. webRouter.post '/tag/:tag_id/rename', AuthenticationController.requireLogin(), TagsController.renameTag
  150. webRouter.delete '/tag/:tag_id', AuthenticationController.requireLogin(), TagsController.deleteTag
  151. webRouter.post '/tag/:tag_id/project/:project_id', AuthenticationController.requireLogin(), TagsController.addProjectToTag
  152. webRouter.delete '/tag/:tag_id/project/:project_id', AuthenticationController.requireLogin(), TagsController.removeProjectFromTag
  153. webRouter.get '/notifications', AuthenticationController.requireLogin(), NotificationsController.getAllUnreadNotifications
  154. webRouter.delete '/notifications/:notification_id', AuthenticationController.requireLogin(), NotificationsController.markNotificationAsRead
  155. # Deprecated in favour of /internal/project/:project_id but still used by versioning
  156. apiRouter.get '/project/:project_id/details', AuthenticationController.httpAuth, ProjectApiController.getProjectDetails
  157. # New 'stable' /internal API end points
  158. apiRouter.get '/internal/project/:project_id', AuthenticationController.httpAuth, ProjectApiController.getProjectDetails
  159. apiRouter.get '/internal/project/:Project_id/zip', AuthenticationController.httpAuth, ProjectDownloadsController.downloadProject
  160. apiRouter.get '/internal/project/:project_id/compile/pdf', AuthenticationController.httpAuth, CompileController.compileAndDownloadPdf
  161. apiRouter.post '/internal/deactivateOldProjects', AuthenticationController.httpAuth, InactiveProjectController.deactivateOldProjects
  162. apiRouter.post '/internal/project/:project_id/deactivate', AuthenticationController.httpAuth, InactiveProjectController.deactivateProject
  163. webRouter.get /^\/internal\/project\/([^\/]*)\/output\/(.*)$/,
  164. ((req, res, next) ->
  165. params =
  166. "Project_id": req.params[0]
  167. "file": req.params[1]
  168. req.params = params
  169. next()
  170. ), AuthenticationController.httpAuth, CompileController.getFileFromClsi
  171. apiRouter.get '/project/:Project_id/doc/:doc_id', AuthenticationController.httpAuth, DocumentController.getDocument
  172. apiRouter.post '/project/:Project_id/doc/:doc_id', AuthenticationController.httpAuth, DocumentController.setDocument
  173. apiRouter.post '/user/:user_id/update/*', AuthenticationController.httpAuth, TpdsController.mergeUpdate
  174. apiRouter.delete '/user/:user_id/update/*', AuthenticationController.httpAuth, TpdsController.deleteUpdate
  175. apiRouter.post '/project/:project_id/contents/*', AuthenticationController.httpAuth, TpdsController.updateProjectContents
  176. apiRouter.delete '/project/:project_id/contents/*', AuthenticationController.httpAuth, TpdsController.deleteProjectContents
  177. webRouter.post "/spelling/check", AuthenticationController.requireLogin(), SpellingController.proxyRequestToSpellingApi
  178. webRouter.post "/spelling/learn", AuthenticationController.requireLogin(), SpellingController.proxyRequestToSpellingApi
  179. webRouter.get "/project/:Project_id/messages", AuthorizationMiddlewear.ensureUserCanReadProject, ChatController.getMessages
  180. webRouter.post "/project/:Project_id/messages", AuthorizationMiddlewear.ensureUserCanReadProject, ChatController.sendMessage
  181. webRouter.post "/project/:Project_id/references/index", AuthorizationMiddlewear.ensureUserCanReadProject, ReferencesController.index
  182. webRouter.post "/project/:Project_id/references/indexAll", AuthorizationMiddlewear.ensureUserCanReadProject, ReferencesController.indexAll
  183. webRouter.get "/beta/participate", AuthenticationController.requireLogin(), BetaProgramController.optInPage
  184. webRouter.post "/beta/opt-in", AuthenticationController.requireLogin(), BetaProgramController.optIn
  185. webRouter.post "/beta/opt-out", AuthenticationController.requireLogin(), BetaProgramController.optOut
  186. #Admin Stuff
  187. webRouter.get '/admin', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.index
  188. webRouter.get '/admin/user', AuthorizationMiddlewear.ensureUserIsSiteAdmin, (req, res)-> res.redirect("/admin/register") #this gets removed by admin-panel addon
  189. webRouter.get '/admin/register', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.registerNewUser
  190. webRouter.post '/admin/register', AuthorizationMiddlewear.ensureUserIsSiteAdmin, UserController.register
  191. webRouter.post '/admin/closeEditor', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.closeEditor
  192. webRouter.post '/admin/dissconectAllUsers', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.dissconectAllUsers
  193. webRouter.post '/admin/syncUserToSubscription', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.syncUserToSubscription
  194. webRouter.post '/admin/flushProjectToTpds', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.flushProjectToTpds
  195. webRouter.post '/admin/pollDropboxForUser', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.pollDropboxForUser
  196. webRouter.post '/admin/messages', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.createMessage
  197. webRouter.post '/admin/messages/clear', AuthorizationMiddlewear.ensureUserIsSiteAdmin, AdminController.clearMessages
  198. apiRouter.get '/perfTest', (req,res)->
  199. res.send("hello")
  200. apiRouter.get '/status', (req,res)->
  201. res.send("websharelatex is up")
  202. webRouter.get '/dev/csrf', (req, res) ->
  203. res.send res.locals.csrfToken
  204. apiRouter.get '/health_check', HealthCheckController.check
  205. apiRouter.get '/health_check/redis', HealthCheckController.checkRedis
  206. apiRouter.get "/status/compiler/:Project_id", AuthorizationMiddlewear.ensureUserCanReadProject, (req, res) ->
  207. sendRes = _.once (statusCode, message)->
  208. res.writeHead statusCode
  209. res.end message
  210. CompileManager.compile req.params.Project_id, "test-compile", {}, () ->
  211. sendRes 200, "Compiler returned in less than 10 seconds"
  212. setTimeout (() ->
  213. sendRes 500, "Compiler timed out"
  214. ), 10000
  215. apiRouter.get "/ip", (req, res, next) ->
  216. res.send({
  217. ip: req.ip
  218. ips: req.ips
  219. headers: req.headers
  220. })
  221. webRouter.get '/oops-express', (req, res, next) -> next(new Error("Test error"))
  222. webRouter.get '/oops-internal', (req, res, next) -> throw new Error("Test error")
  223. webRouter.get '/oops-mongo', (req, res, next) ->
  224. require("./models/Project").Project.findOne {}, () ->
  225. throw new Error("Test error")
  226. apiRouter.get '/opps-small', (req, res, next)->
  227. logger.err "test error occured"
  228. res.send()
  229. webRouter.post '/error/client', (req, res, next) ->
  230. logger.warn err: req.body.error, meta: req.body.meta, "client side error"
  231. metrics.inc("client-side-error")
  232. res.sendStatus(204)
  233. webRouter.get '*', ErrorController.notFound