router.js 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364
  1. const AdminController = require('./Features/ServerAdmin/AdminController')
  2. const ErrorController = require('./Features/Errors/ErrorController')
  3. const ProjectController = require('./Features/Project/ProjectController')
  4. const ProjectApiController = require('./Features/Project/ProjectApiController')
  5. const ProjectListController = require('./Features/Project/ProjectListController')
  6. const SpellingController = require('./Features/Spelling/SpellingController')
  7. const EditorRouter = require('./Features/Editor/EditorRouter')
  8. const Settings = require('@overleaf/settings')
  9. const TpdsController = require('./Features/ThirdPartyDataStore/TpdsController')
  10. const SubscriptionRouter = require('./Features/Subscription/SubscriptionRouter')
  11. const UploadsRouter = require('./Features/Uploads/UploadsRouter')
  12. const metrics = require('@overleaf/metrics')
  13. const ReferalController = require('./Features/Referal/ReferalController')
  14. const AuthenticationController = require('./Features/Authentication/AuthenticationController')
  15. const PermissionsController = require('./Features/Authorization/PermissionsController')
  16. const SessionManager = require('./Features/Authentication/SessionManager')
  17. const TagsController = require('./Features/Tags/TagsController')
  18. const NotificationsController = require('./Features/Notifications/NotificationsController')
  19. const CollaboratorsRouter = require('./Features/Collaborators/CollaboratorsRouter')
  20. const UserInfoController = require('./Features/User/UserInfoController')
  21. const UserController = require('./Features/User/UserController')
  22. const UserEmailsController = require('./Features/User/UserEmailsController')
  23. const UserPagesController = require('./Features/User/UserPagesController')
  24. const DocumentController = require('./Features/Documents/DocumentController')
  25. const CompileManager = require('./Features/Compile/CompileManager')
  26. const CompileController = require('./Features/Compile/CompileController')
  27. const ClsiCookieManager = require('./Features/Compile/ClsiCookieManager')(
  28. Settings.apis.clsi != null ? Settings.apis.clsi.backendGroupName : undefined
  29. )
  30. const HealthCheckController = require('./Features/HealthCheck/HealthCheckController')
  31. const ProjectDownloadsController = require('./Features/Downloads/ProjectDownloadsController')
  32. const FileStoreController = require('./Features/FileStore/FileStoreController')
  33. const HistoryController = require('./Features/History/HistoryController')
  34. const ExportsController = require('./Features/Exports/ExportsController')
  35. const PasswordResetRouter = require('./Features/PasswordReset/PasswordResetRouter')
  36. const StaticPagesRouter = require('./Features/StaticPages/StaticPagesRouter')
  37. const ChatController = require('./Features/Chat/ChatController')
  38. const Modules = require('./infrastructure/Modules')
  39. const {
  40. RateLimiter,
  41. openProjectRateLimiter,
  42. } = require('./infrastructure/RateLimiter')
  43. const RateLimiterMiddleware = require('./Features/Security/RateLimiterMiddleware')
  44. const InactiveProjectController = require('./Features/InactiveData/InactiveProjectController')
  45. const ContactRouter = require('./Features/Contacts/ContactRouter')
  46. const ReferencesController = require('./Features/References/ReferencesController')
  47. const AuthorizationMiddleware = require('./Features/Authorization/AuthorizationMiddleware')
  48. const BetaProgramController = require('./Features/BetaProgram/BetaProgramController')
  49. const AnalyticsRouter = require('./Features/Analytics/AnalyticsRouter')
  50. const MetaController = require('./Features/Metadata/MetaController')
  51. const TokenAccessController = require('./Features/TokenAccess/TokenAccessController')
  52. const Features = require('./infrastructure/Features')
  53. const LinkedFilesRouter = require('./Features/LinkedFiles/LinkedFilesRouter')
  54. const TemplatesRouter = require('./Features/Templates/TemplatesRouter')
  55. const InstitutionsController = require('./Features/Institutions/InstitutionsController')
  56. const UserMembershipRouter = require('./Features/UserMembership/UserMembershipRouter')
  57. const SystemMessageController = require('./Features/SystemMessages/SystemMessageController')
  58. const AnalyticsRegistrationSourceMiddleware = require('./Features/Analytics/AnalyticsRegistrationSourceMiddleware')
  59. const AnalyticsUTMTrackingMiddleware = require('./Features/Analytics/AnalyticsUTMTrackingMiddleware')
  60. const CaptchaMiddleware = require('./Features/Captcha/CaptchaMiddleware')
  61. const { Joi, validate } = require('./infrastructure/Validation')
  62. const {
  63. renderUnsupportedBrowserPage,
  64. unsupportedBrowserMiddleware,
  65. } = require('./infrastructure/UnsupportedBrowserMiddleware')
  66. const logger = require('@overleaf/logger')
  67. const _ = require('underscore')
  68. const { plainTextResponse } = require('./infrastructure/Response')
  69. const PublicAccessLevels = require('./Features/Authorization/PublicAccessLevels')
  70. const rateLimiters = {
  71. addEmail: new RateLimiter('add-email', {
  72. points: 10,
  73. duration: 60,
  74. }),
  75. addProjectToTag: new RateLimiter('add-project-to-tag', {
  76. points: 30,
  77. duration: 60,
  78. }),
  79. addProjectsToTag: new RateLimiter('add-projects-to-tag', {
  80. points: 30,
  81. duration: 60,
  82. }),
  83. canSkipCaptcha: new RateLimiter('can-skip-captcha', {
  84. points: 20,
  85. duration: 60,
  86. }),
  87. changePassword: new RateLimiter('change-password', {
  88. points: 10,
  89. duration: 60,
  90. }),
  91. compileProjectHttp: new RateLimiter('compile-project-http', {
  92. points: 800,
  93. duration: 60 * 60,
  94. }),
  95. confirmEmail: new RateLimiter('confirm-email', {
  96. points: 10,
  97. duration: 60,
  98. }),
  99. confirmUniversityDomain: new RateLimiter('confirm-university-domain', {
  100. points: 1,
  101. duration: 60,
  102. }),
  103. createProject: new RateLimiter('create-project', {
  104. points: 20,
  105. duration: 60,
  106. }),
  107. createTag: new RateLimiter('create-tag', {
  108. points: 30,
  109. duration: 60,
  110. }),
  111. deleteEmail: new RateLimiter('delete-email', {
  112. points: 10,
  113. duration: 60,
  114. }),
  115. deleteTag: new RateLimiter('delete-tag', {
  116. points: 30,
  117. duration: 60,
  118. }),
  119. deleteUser: new RateLimiter('delete-user', {
  120. points: 10,
  121. duration: 60,
  122. }),
  123. downloadProjectRevision: new RateLimiter('download-project-revision', {
  124. points: 30,
  125. duration: 60 * 60,
  126. }),
  127. endorseEmail: new RateLimiter('endorse-email', {
  128. points: 30,
  129. duration: 60,
  130. }),
  131. getProjects: new RateLimiter('get-projects', {
  132. points: 30,
  133. duration: 60,
  134. }),
  135. grantTokenAccessReadOnly: new RateLimiter('grant-token-access-read-only', {
  136. points: 10,
  137. duration: 60,
  138. }),
  139. grantTokenAccessReadWrite: new RateLimiter('grant-token-access-read-write', {
  140. points: 10,
  141. duration: 60,
  142. }),
  143. indexAllProjectReferences: new RateLimiter('index-all-project-references', {
  144. points: 30,
  145. duration: 60,
  146. }),
  147. indexProjectReferences: new RateLimiter('index-project-references', {
  148. points: 30,
  149. duration: 60,
  150. }),
  151. miscOutputDownload: new RateLimiter('misc-output-download', {
  152. points: 1000,
  153. duration: 60 * 60,
  154. }),
  155. multipleProjectsZipDownload: new RateLimiter(
  156. 'multiple-projects-zip-download',
  157. {
  158. points: 10,
  159. duration: 60,
  160. }
  161. ),
  162. openDashboard: new RateLimiter('open-dashboard', {
  163. points: 30,
  164. duration: 60,
  165. }),
  166. readAndWriteToken: new RateLimiter('read-and-write-token', {
  167. points: 15,
  168. duration: 60,
  169. }),
  170. readOnlyToken: new RateLimiter('read-only-token', {
  171. points: 15,
  172. duration: 60,
  173. }),
  174. removeProjectFromTag: new RateLimiter('remove-project-from-tag', {
  175. points: 30,
  176. duration: 60,
  177. }),
  178. removeProjectsFromTag: new RateLimiter('remove-projects-from-tag', {
  179. points: 30,
  180. duration: 60,
  181. }),
  182. renameTag: new RateLimiter('rename-tag', {
  183. points: 30,
  184. duration: 60,
  185. }),
  186. resendConfirmation: new RateLimiter('resend-confirmation', {
  187. points: 10,
  188. duration: 60,
  189. }),
  190. sendChatMessage: new RateLimiter('send-chat-message', {
  191. points: 100,
  192. duration: 60,
  193. }),
  194. statusCompiler: new RateLimiter('status-compiler', {
  195. points: 10,
  196. duration: 60,
  197. }),
  198. zipDownload: new RateLimiter('zip-download', {
  199. points: 10,
  200. duration: 60,
  201. }),
  202. }
  203. function initialize(webRouter, privateApiRouter, publicApiRouter) {
  204. webRouter.use(unsupportedBrowserMiddleware)
  205. if (!Settings.allowPublicAccess) {
  206. webRouter.all('*', AuthenticationController.requireGlobalLogin)
  207. }
  208. webRouter.get('*', AnalyticsRegistrationSourceMiddleware.setInbound())
  209. webRouter.get('*', AnalyticsUTMTrackingMiddleware.recordUTMTags())
  210. // Mount onto /login in order to get the deviceHistory cookie.
  211. webRouter.post(
  212. '/login/can-skip-captcha',
  213. // Keep in sync with the overleaf-login options.
  214. RateLimiterMiddleware.rateLimit(rateLimiters.canSkipCaptcha),
  215. CaptchaMiddleware.canSkipCaptcha
  216. )
  217. webRouter.get('/login', UserPagesController.loginPage)
  218. AuthenticationController.addEndpointToLoginWhitelist('/login')
  219. webRouter.post(
  220. '/login',
  221. CaptchaMiddleware.validateCaptcha('login'),
  222. AuthenticationController.passportLogin
  223. )
  224. if (Settings.enableLegacyLogin) {
  225. AuthenticationController.addEndpointToLoginWhitelist('/login/legacy')
  226. webRouter.get('/login/legacy', UserPagesController.loginPage)
  227. webRouter.post(
  228. '/login/legacy',
  229. CaptchaMiddleware.validateCaptcha('login'),
  230. AuthenticationController.passportLogin
  231. )
  232. }
  233. webRouter.get(
  234. '/read-only/one-time-login',
  235. UserPagesController.oneTimeLoginPage
  236. )
  237. AuthenticationController.addEndpointToLoginWhitelist(
  238. '/read-only/one-time-login'
  239. )
  240. webRouter.post('/logout', UserController.logout)
  241. webRouter.get('/restricted', AuthorizationMiddleware.restricted)
  242. if (Features.hasFeature('registration-page')) {
  243. webRouter.get('/register', UserPagesController.registerPage)
  244. AuthenticationController.addEndpointToLoginWhitelist('/register')
  245. }
  246. EditorRouter.apply(webRouter, privateApiRouter)
  247. CollaboratorsRouter.apply(webRouter, privateApiRouter)
  248. SubscriptionRouter.apply(webRouter, privateApiRouter, publicApiRouter)
  249. UploadsRouter.apply(webRouter, privateApiRouter)
  250. PasswordResetRouter.apply(webRouter, privateApiRouter)
  251. StaticPagesRouter.apply(webRouter, privateApiRouter)
  252. ContactRouter.apply(webRouter, privateApiRouter)
  253. AnalyticsRouter.apply(webRouter, privateApiRouter, publicApiRouter)
  254. LinkedFilesRouter.apply(webRouter, privateApiRouter, publicApiRouter)
  255. TemplatesRouter.apply(webRouter)
  256. UserMembershipRouter.apply(webRouter)
  257. Modules.applyRouter(webRouter, privateApiRouter, publicApiRouter)
  258. if (Settings.enableSubscriptions) {
  259. webRouter.get(
  260. '/user/bonus',
  261. AuthenticationController.requireLogin(),
  262. ReferalController.bonus
  263. )
  264. }
  265. // .getMessages will generate an empty response for anonymous users.
  266. webRouter.get('/system/messages', SystemMessageController.getMessages)
  267. webRouter.get(
  268. '/user/settings',
  269. AuthenticationController.requireLogin(),
  270. UserPagesController.settingsPage
  271. )
  272. webRouter.post(
  273. '/user/settings',
  274. AuthenticationController.requireLogin(),
  275. UserController.updateUserSettings
  276. )
  277. webRouter.post(
  278. '/user/password/update',
  279. AuthenticationController.requireLogin(),
  280. RateLimiterMiddleware.rateLimit(rateLimiters.changePassword),
  281. UserController.changePassword
  282. )
  283. webRouter.get(
  284. '/user/emails',
  285. AuthenticationController.requireLogin(),
  286. PermissionsController.useCapabilities(),
  287. UserController.promises.ensureAffiliationMiddleware,
  288. UserEmailsController.list
  289. )
  290. webRouter.get('/user/emails/confirm', UserEmailsController.showConfirm)
  291. webRouter.post(
  292. '/user/emails/confirm',
  293. RateLimiterMiddleware.rateLimit(rateLimiters.confirmEmail),
  294. UserEmailsController.confirm
  295. )
  296. webRouter.post(
  297. '/user/emails/resend_confirmation',
  298. AuthenticationController.requireLogin(),
  299. RateLimiterMiddleware.rateLimit(rateLimiters.resendConfirmation),
  300. UserEmailsController.resendConfirmation
  301. )
  302. webRouter.get(
  303. '/user/emails/primary-email-check',
  304. AuthenticationController.requireLogin(),
  305. UserEmailsController.primaryEmailCheckPage
  306. )
  307. webRouter.post(
  308. '/user/emails/primary-email-check',
  309. AuthenticationController.requireLogin(),
  310. UserEmailsController.primaryEmailCheck
  311. )
  312. if (Features.hasFeature('affiliations')) {
  313. webRouter.post(
  314. '/user/emails',
  315. AuthenticationController.requireLogin(),
  316. PermissionsController.requirePermission('add-secondary-email'),
  317. RateLimiterMiddleware.rateLimit(rateLimiters.addEmail),
  318. CaptchaMiddleware.validateCaptcha('addEmail'),
  319. UserEmailsController.add
  320. )
  321. webRouter.post(
  322. '/user/emails/delete',
  323. AuthenticationController.requireLogin(),
  324. RateLimiterMiddleware.rateLimit(rateLimiters.deleteEmail),
  325. UserEmailsController.remove
  326. )
  327. webRouter.post(
  328. '/user/emails/default',
  329. AuthenticationController.requireLogin(),
  330. UserEmailsController.setDefault
  331. )
  332. webRouter.post(
  333. '/user/emails/endorse',
  334. AuthenticationController.requireLogin(),
  335. PermissionsController.requirePermission('endorse-email'),
  336. RateLimiterMiddleware.rateLimit(rateLimiters.endorseEmail),
  337. UserEmailsController.endorse
  338. )
  339. }
  340. webRouter.get(
  341. '/user/sessions',
  342. AuthenticationController.requireLogin(),
  343. UserPagesController.sessionsPage
  344. )
  345. webRouter.post(
  346. '/user/sessions/clear',
  347. AuthenticationController.requireLogin(),
  348. UserController.clearSessions
  349. )
  350. // deprecated
  351. webRouter.delete(
  352. '/user/newsletter/unsubscribe',
  353. AuthenticationController.requireLogin(),
  354. UserController.unsubscribe
  355. )
  356. webRouter.post(
  357. '/user/newsletter/unsubscribe',
  358. AuthenticationController.requireLogin(),
  359. UserController.unsubscribe
  360. )
  361. webRouter.post(
  362. '/user/newsletter/subscribe',
  363. AuthenticationController.requireLogin(),
  364. UserController.subscribe
  365. )
  366. webRouter.get(
  367. '/user/email-preferences',
  368. AuthenticationController.requireLogin(),
  369. UserPagesController.emailPreferencesPage
  370. )
  371. webRouter.post(
  372. '/user/delete',
  373. RateLimiterMiddleware.rateLimit(rateLimiters.deleteUser),
  374. AuthenticationController.requireLogin(),
  375. PermissionsController.requirePermission('delete-own-account'),
  376. UserController.tryDeleteUser
  377. )
  378. webRouter.get(
  379. '/user/personal_info',
  380. AuthenticationController.requireLogin(),
  381. UserInfoController.getLoggedInUsersPersonalInfo
  382. )
  383. privateApiRouter.get(
  384. '/user/:user_id/personal_info',
  385. AuthenticationController.requirePrivateApiAuth(),
  386. UserInfoController.getPersonalInfo
  387. )
  388. webRouter.get(
  389. '/user/reconfirm',
  390. UserPagesController.renderReconfirmAccountPage
  391. )
  392. // for /user/reconfirm POST, see password router
  393. webRouter.get(
  394. '/user/tpds/queues',
  395. AuthenticationController.requireLogin(),
  396. TpdsController.getQueues
  397. )
  398. webRouter.get(
  399. '/user/projects',
  400. AuthenticationController.requireLogin(),
  401. ProjectController.userProjectsJson
  402. )
  403. webRouter.get(
  404. '/project/:Project_id/entities',
  405. AuthenticationController.requireLogin(),
  406. AuthorizationMiddleware.ensureUserCanReadProject,
  407. ProjectController.projectEntitiesJson
  408. )
  409. webRouter.get(
  410. '/project',
  411. AuthenticationController.requireLogin(),
  412. RateLimiterMiddleware.rateLimit(rateLimiters.openDashboard),
  413. ProjectListController.projectListPage
  414. )
  415. webRouter.post(
  416. '/project/new',
  417. AuthenticationController.requireLogin(),
  418. RateLimiterMiddleware.rateLimit(rateLimiters.createProject),
  419. ProjectController.newProject
  420. )
  421. webRouter.post(
  422. '/api/project',
  423. AuthenticationController.requireLogin(),
  424. RateLimiterMiddleware.rateLimit(rateLimiters.getProjects),
  425. ProjectListController.getProjectsJson
  426. )
  427. for (const route of [
  428. // Keep the old route for continuous metrics
  429. '/Project/:Project_id',
  430. // New route for pdf-detach
  431. '/Project/:Project_id/:detachRole(detacher|detached)',
  432. ]) {
  433. webRouter.get(
  434. route,
  435. RateLimiterMiddleware.rateLimit(openProjectRateLimiter, {
  436. params: ['Project_id'],
  437. }),
  438. AuthenticationController.validateUserSession(),
  439. AuthorizationMiddleware.ensureUserCanReadProject,
  440. ProjectController.loadEditor
  441. )
  442. }
  443. webRouter.head(
  444. '/Project/:Project_id/file/:File_id',
  445. AuthorizationMiddleware.ensureUserCanReadProject,
  446. FileStoreController.getFileHead
  447. )
  448. webRouter.get(
  449. '/Project/:Project_id/file/:File_id',
  450. AuthorizationMiddleware.ensureUserCanReadProject,
  451. FileStoreController.getFile
  452. )
  453. webRouter.post(
  454. '/project/:Project_id/settings',
  455. validate({
  456. body: Joi.object({
  457. publicAccessLevel: Joi.string()
  458. .valid(PublicAccessLevels.PRIVATE, PublicAccessLevels.TOKEN_BASED)
  459. .optional(),
  460. }),
  461. }),
  462. AuthorizationMiddleware.ensureUserCanWriteProjectSettings,
  463. ProjectController.updateProjectSettings
  464. )
  465. webRouter.post(
  466. '/project/:Project_id/settings/admin',
  467. AuthenticationController.requireLogin(),
  468. AuthorizationMiddleware.ensureUserCanAdminProject,
  469. ProjectController.updateProjectAdminSettings
  470. )
  471. webRouter.post(
  472. '/project/:Project_id/compile',
  473. RateLimiterMiddleware.rateLimit(rateLimiters.compileProjectHttp, {
  474. params: ['Project_id'],
  475. }),
  476. AuthorizationMiddleware.ensureUserCanReadProject,
  477. CompileController.compile
  478. )
  479. webRouter.post(
  480. '/project/:Project_id/compile/stop',
  481. AuthorizationMiddleware.ensureUserCanReadProject,
  482. CompileController.stopCompile
  483. )
  484. // LEGACY: Used by the web download buttons, adds filename header, TODO: remove at some future date
  485. webRouter.get(
  486. '/project/:Project_id/output/output.pdf',
  487. AuthorizationMiddleware.ensureUserCanReadProject,
  488. CompileController.downloadPdf
  489. )
  490. // PDF Download button
  491. webRouter.get(
  492. /^\/download\/project\/([^/]*)\/output\/output\.pdf$/,
  493. function (req, res, next) {
  494. const params = { Project_id: req.params[0] }
  495. req.params = params
  496. next()
  497. },
  498. AuthorizationMiddleware.ensureUserCanReadProject,
  499. CompileController.downloadPdf
  500. )
  501. // PDF Download button for specific build
  502. webRouter.get(
  503. /^\/download\/project\/([^/]*)\/build\/([0-9a-f-]+)\/output\/output\.pdf$/,
  504. function (req, res, next) {
  505. const params = {
  506. Project_id: req.params[0],
  507. build_id: req.params[1],
  508. }
  509. req.params = params
  510. next()
  511. },
  512. AuthorizationMiddleware.ensureUserCanReadProject,
  513. CompileController.downloadPdf
  514. )
  515. // Align with limits defined in CompileController.downloadPdf
  516. const rateLimiterMiddlewareOutputFiles = RateLimiterMiddleware.rateLimit(
  517. rateLimiters.miscOutputDownload,
  518. { params: ['Project_id'] }
  519. )
  520. // Used by the pdf viewers
  521. webRouter.get(
  522. /^\/project\/([^/]*)\/output\/(.*)$/,
  523. function (req, res, next) {
  524. const params = {
  525. Project_id: req.params[0],
  526. file: req.params[1],
  527. }
  528. req.params = params
  529. next()
  530. },
  531. rateLimiterMiddlewareOutputFiles,
  532. AuthorizationMiddleware.ensureUserCanReadProject,
  533. CompileController.getFileFromClsi
  534. )
  535. // direct url access to output files for a specific build (query string not required)
  536. webRouter.get(
  537. /^\/project\/([^/]*)\/build\/([0-9a-f-]+)\/output\/(.*)$/,
  538. function (req, res, next) {
  539. const params = {
  540. Project_id: req.params[0],
  541. build_id: req.params[1],
  542. file: req.params[2],
  543. }
  544. req.params = params
  545. next()
  546. },
  547. rateLimiterMiddlewareOutputFiles,
  548. AuthorizationMiddleware.ensureUserCanReadProject,
  549. CompileController.getFileFromClsi
  550. )
  551. // direct url access to output files for user but no build, to retrieve files when build fails
  552. webRouter.get(
  553. /^\/project\/([^/]*)\/user\/([0-9a-f-]+)\/output\/(.*)$/,
  554. function (req, res, next) {
  555. const params = {
  556. Project_id: req.params[0],
  557. user_id: req.params[1],
  558. file: req.params[2],
  559. }
  560. req.params = params
  561. next()
  562. },
  563. rateLimiterMiddlewareOutputFiles,
  564. AuthorizationMiddleware.ensureUserCanReadProject,
  565. CompileController.getFileFromClsi
  566. )
  567. // direct url access to output files for a specific user and build (query string not required)
  568. webRouter.get(
  569. /^\/project\/([^/]*)\/user\/([0-9a-f]+)\/build\/([0-9a-f-]+)\/output\/(.*)$/,
  570. function (req, res, next) {
  571. const params = {
  572. Project_id: req.params[0],
  573. user_id: req.params[1],
  574. build_id: req.params[2],
  575. file: req.params[3],
  576. }
  577. req.params = params
  578. next()
  579. },
  580. rateLimiterMiddlewareOutputFiles,
  581. AuthorizationMiddleware.ensureUserCanReadProject,
  582. CompileController.getFileFromClsi
  583. )
  584. webRouter.delete(
  585. '/project/:Project_id/output',
  586. validate({ query: { clsiserverid: Joi.string() } }),
  587. AuthorizationMiddleware.ensureUserCanReadProject,
  588. CompileController.deleteAuxFiles
  589. )
  590. webRouter.get(
  591. '/project/:Project_id/sync/code',
  592. AuthorizationMiddleware.ensureUserCanReadProject,
  593. CompileController.proxySyncCode
  594. )
  595. webRouter.get(
  596. '/project/:Project_id/sync/pdf',
  597. AuthorizationMiddleware.ensureUserCanReadProject,
  598. CompileController.proxySyncPdf
  599. )
  600. webRouter.get(
  601. '/project/:Project_id/wordcount',
  602. validate({ query: { clsiserverid: Joi.string() } }),
  603. AuthorizationMiddleware.ensureUserCanReadProject,
  604. CompileController.wordCount
  605. )
  606. webRouter.post(
  607. '/Project/:Project_id/archive',
  608. AuthenticationController.requireLogin(),
  609. AuthorizationMiddleware.ensureUserCanReadProject,
  610. ProjectController.archiveProject
  611. )
  612. webRouter.delete(
  613. '/Project/:Project_id/archive',
  614. AuthenticationController.requireLogin(),
  615. AuthorizationMiddleware.ensureUserCanReadProject,
  616. ProjectController.unarchiveProject
  617. )
  618. webRouter.post(
  619. '/project/:project_id/trash',
  620. AuthenticationController.requireLogin(),
  621. AuthorizationMiddleware.ensureUserCanReadProject,
  622. ProjectController.trashProject
  623. )
  624. webRouter.delete(
  625. '/project/:project_id/trash',
  626. AuthenticationController.requireLogin(),
  627. AuthorizationMiddleware.ensureUserCanReadProject,
  628. ProjectController.untrashProject
  629. )
  630. webRouter.delete(
  631. '/Project/:Project_id',
  632. AuthenticationController.requireLogin(),
  633. AuthorizationMiddleware.ensureUserCanAdminProject,
  634. ProjectController.deleteProject
  635. )
  636. webRouter.post(
  637. '/Project/:Project_id/restore',
  638. AuthenticationController.requireLogin(),
  639. AuthorizationMiddleware.ensureUserCanAdminProject,
  640. ProjectController.restoreProject
  641. )
  642. webRouter.post(
  643. '/Project/:Project_id/clone',
  644. AuthorizationMiddleware.ensureUserCanReadProject,
  645. ProjectController.cloneProject
  646. )
  647. webRouter.post(
  648. '/project/:Project_id/rename',
  649. AuthenticationController.requireLogin(),
  650. AuthorizationMiddleware.ensureUserCanAdminProject,
  651. ProjectController.renameProject
  652. )
  653. webRouter.get(
  654. '/project/:Project_id/updates',
  655. AuthorizationMiddleware.blockRestrictedUserFromProject,
  656. AuthorizationMiddleware.ensureUserCanReadProject,
  657. HistoryController.proxyToHistoryApiAndInjectUserDetails
  658. )
  659. webRouter.get(
  660. '/project/:Project_id/doc/:doc_id/diff',
  661. AuthorizationMiddleware.blockRestrictedUserFromProject,
  662. AuthorizationMiddleware.ensureUserCanReadProject,
  663. HistoryController.proxyToHistoryApi
  664. )
  665. webRouter.get(
  666. '/project/:Project_id/diff',
  667. AuthorizationMiddleware.blockRestrictedUserFromProject,
  668. AuthorizationMiddleware.ensureUserCanReadProject,
  669. HistoryController.proxyToHistoryApiAndInjectUserDetails
  670. )
  671. webRouter.get(
  672. '/project/:Project_id/filetree/diff',
  673. AuthorizationMiddleware.blockRestrictedUserFromProject,
  674. AuthorizationMiddleware.ensureUserCanReadProject,
  675. HistoryController.proxyToHistoryApi
  676. )
  677. webRouter.post(
  678. '/project/:Project_id/doc/:doc_id/version/:version_id/restore',
  679. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  680. HistoryController.proxyToHistoryApi
  681. )
  682. webRouter.post(
  683. '/project/:project_id/doc/:doc_id/restore',
  684. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  685. HistoryController.restoreDocFromDeletedDoc
  686. )
  687. webRouter.post(
  688. '/project/:project_id/restore_file',
  689. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  690. HistoryController.restoreFileFromV2
  691. )
  692. webRouter.get(
  693. '/project/:project_id/version/:version/zip',
  694. RateLimiterMiddleware.rateLimit(rateLimiters.downloadProjectRevision),
  695. AuthorizationMiddleware.blockRestrictedUserFromProject,
  696. AuthorizationMiddleware.ensureUserCanReadProject,
  697. HistoryController.downloadZipOfVersion
  698. )
  699. privateApiRouter.post(
  700. '/project/:Project_id/history/resync',
  701. AuthenticationController.requirePrivateApiAuth(),
  702. HistoryController.resyncProjectHistory
  703. )
  704. webRouter.get(
  705. '/project/:Project_id/labels',
  706. AuthorizationMiddleware.blockRestrictedUserFromProject,
  707. AuthorizationMiddleware.ensureUserCanReadProject,
  708. HistoryController.getLabels
  709. )
  710. webRouter.post(
  711. '/project/:Project_id/labels',
  712. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  713. HistoryController.createLabel
  714. )
  715. webRouter.delete(
  716. '/project/:Project_id/labels/:label_id',
  717. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  718. HistoryController.deleteLabel
  719. )
  720. webRouter.post(
  721. '/project/:project_id/export/:brand_variation_id',
  722. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  723. ExportsController.exportProject
  724. )
  725. webRouter.get(
  726. '/project/:project_id/export/:export_id',
  727. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  728. ExportsController.exportStatus
  729. )
  730. webRouter.get(
  731. '/project/:project_id/export/:export_id/:type',
  732. AuthorizationMiddleware.ensureUserCanWriteProjectContent,
  733. ExportsController.exportDownload
  734. )
  735. webRouter.get(
  736. '/Project/:Project_id/download/zip',
  737. RateLimiterMiddleware.rateLimit(rateLimiters.zipDownload, {
  738. params: ['Project_id'],
  739. }),
  740. AuthorizationMiddleware.ensureUserCanReadProject,
  741. ProjectDownloadsController.downloadProject
  742. )
  743. webRouter.get(
  744. '/project/download/zip',
  745. AuthenticationController.requireLogin(),
  746. RateLimiterMiddleware.rateLimit(rateLimiters.multipleProjectsZipDownload),
  747. AuthorizationMiddleware.ensureUserCanReadMultipleProjects,
  748. ProjectDownloadsController.downloadMultipleProjects
  749. )
  750. webRouter.get(
  751. '/project/:project_id/metadata',
  752. AuthorizationMiddleware.ensureUserCanReadProject,
  753. Settings.allowAnonymousReadAndWriteSharing
  754. ? (req, res, next) => {
  755. next()
  756. }
  757. : AuthenticationController.requireLogin(),
  758. MetaController.getMetadata
  759. )
  760. webRouter.post(
  761. '/project/:project_id/doc/:doc_id/metadata',
  762. AuthorizationMiddleware.ensureUserCanReadProject,
  763. Settings.allowAnonymousReadAndWriteSharing
  764. ? (req, res, next) => {
  765. next()
  766. }
  767. : AuthenticationController.requireLogin(),
  768. MetaController.broadcastMetadataForDoc
  769. )
  770. privateApiRouter.post(
  771. '/internal/expire-deleted-projects-after-duration',
  772. AuthenticationController.requirePrivateApiAuth(),
  773. ProjectController.expireDeletedProjectsAfterDuration
  774. )
  775. privateApiRouter.post(
  776. '/internal/expire-deleted-users-after-duration',
  777. AuthenticationController.requirePrivateApiAuth(),
  778. UserController.expireDeletedUsersAfterDuration
  779. )
  780. privateApiRouter.post(
  781. '/internal/project/:projectId/expire-deleted-project',
  782. AuthenticationController.requirePrivateApiAuth(),
  783. ProjectController.expireDeletedProject
  784. )
  785. privateApiRouter.post(
  786. '/internal/users/:userId/expire',
  787. AuthenticationController.requirePrivateApiAuth(),
  788. UserController.expireDeletedUser
  789. )
  790. privateApiRouter.get(
  791. '/user/:userId/tag',
  792. AuthenticationController.requirePrivateApiAuth(),
  793. TagsController.apiGetAllTags
  794. )
  795. webRouter.get(
  796. '/tag',
  797. AuthenticationController.requireLogin(),
  798. TagsController.getAllTags
  799. )
  800. webRouter.post(
  801. '/tag',
  802. AuthenticationController.requireLogin(),
  803. RateLimiterMiddleware.rateLimit(rateLimiters.createTag),
  804. validate({
  805. body: Joi.object({
  806. name: Joi.string().required(),
  807. color: Joi.string(),
  808. }),
  809. }),
  810. TagsController.createTag
  811. )
  812. webRouter.post(
  813. '/tag/:tagId/rename',
  814. AuthenticationController.requireLogin(),
  815. RateLimiterMiddleware.rateLimit(rateLimiters.renameTag),
  816. validate({
  817. body: Joi.object({
  818. name: Joi.string().required(),
  819. }),
  820. }),
  821. TagsController.renameTag
  822. )
  823. webRouter.post(
  824. '/tag/:tagId/edit',
  825. AuthenticationController.requireLogin(),
  826. RateLimiterMiddleware.rateLimit(rateLimiters.renameTag),
  827. validate({
  828. body: Joi.object({
  829. name: Joi.string().required(),
  830. color: Joi.string(),
  831. }),
  832. }),
  833. TagsController.editTag
  834. )
  835. webRouter.delete(
  836. '/tag/:tagId',
  837. AuthenticationController.requireLogin(),
  838. RateLimiterMiddleware.rateLimit(rateLimiters.deleteTag),
  839. TagsController.deleteTag
  840. )
  841. webRouter.post(
  842. '/tag/:tagId/project/:projectId',
  843. AuthenticationController.requireLogin(),
  844. RateLimiterMiddleware.rateLimit(rateLimiters.addProjectToTag),
  845. TagsController.addProjectToTag
  846. )
  847. webRouter.post(
  848. '/tag/:tagId/projects',
  849. AuthenticationController.requireLogin(),
  850. RateLimiterMiddleware.rateLimit(rateLimiters.addProjectsToTag),
  851. validate({
  852. body: Joi.object({
  853. projectIds: Joi.array().items(Joi.string()).required(),
  854. }),
  855. }),
  856. TagsController.addProjectsToTag
  857. )
  858. webRouter.delete(
  859. '/tag/:tagId/project/:projectId',
  860. AuthenticationController.requireLogin(),
  861. RateLimiterMiddleware.rateLimit(rateLimiters.removeProjectFromTag),
  862. TagsController.removeProjectFromTag
  863. )
  864. webRouter.delete(
  865. '/tag/:tagId/projects',
  866. AuthenticationController.requireLogin(),
  867. RateLimiterMiddleware.rateLimit(rateLimiters.removeProjectsFromTag),
  868. validate({
  869. body: Joi.object({
  870. projectIds: Joi.array().items(Joi.string()).required(),
  871. }),
  872. }),
  873. TagsController.removeProjectsFromTag
  874. )
  875. webRouter.get(
  876. '/notifications',
  877. AuthenticationController.requireLogin(),
  878. NotificationsController.getAllUnreadNotifications
  879. )
  880. webRouter.delete(
  881. '/notifications/:notificationId',
  882. AuthenticationController.requireLogin(),
  883. NotificationsController.markNotificationAsRead
  884. )
  885. // Deprecated in favour of /internal/project/:project_id but still used by versioning
  886. privateApiRouter.get(
  887. '/project/:project_id/details',
  888. AuthenticationController.requirePrivateApiAuth(),
  889. ProjectApiController.getProjectDetails
  890. )
  891. // New 'stable' /internal API end points
  892. privateApiRouter.get(
  893. '/internal/project/:project_id',
  894. AuthenticationController.requirePrivateApiAuth(),
  895. ProjectApiController.getProjectDetails
  896. )
  897. privateApiRouter.get(
  898. '/internal/project/:Project_id/zip',
  899. AuthenticationController.requirePrivateApiAuth(),
  900. ProjectDownloadsController.downloadProject
  901. )
  902. privateApiRouter.get(
  903. '/internal/project/:project_id/compile/pdf',
  904. AuthenticationController.requirePrivateApiAuth(),
  905. CompileController.compileAndDownloadPdf
  906. )
  907. privateApiRouter.post(
  908. '/internal/deactivateOldProjects',
  909. AuthenticationController.requirePrivateApiAuth(),
  910. InactiveProjectController.deactivateOldProjects
  911. )
  912. privateApiRouter.post(
  913. '/internal/project/:project_id/deactivate',
  914. AuthenticationController.requirePrivateApiAuth(),
  915. InactiveProjectController.deactivateProject
  916. )
  917. privateApiRouter.get(
  918. /^\/internal\/project\/([^/]*)\/output\/(.*)$/,
  919. function (req, res, next) {
  920. const params = {
  921. Project_id: req.params[0],
  922. file: req.params[1],
  923. }
  924. req.params = params
  925. next()
  926. },
  927. AuthenticationController.requirePrivateApiAuth(),
  928. CompileController.getFileFromClsi
  929. )
  930. privateApiRouter.get(
  931. '/project/:Project_id/doc/:doc_id',
  932. AuthenticationController.requirePrivateApiAuth(),
  933. DocumentController.getDocument
  934. )
  935. privateApiRouter.post(
  936. '/project/:Project_id/doc/:doc_id',
  937. AuthenticationController.requirePrivateApiAuth(),
  938. DocumentController.setDocument
  939. )
  940. privateApiRouter.post(
  941. '/user/:user_id/project/new',
  942. AuthenticationController.requirePrivateApiAuth(),
  943. TpdsController.createProject
  944. )
  945. privateApiRouter.post(
  946. '/tpds/folder-update',
  947. AuthenticationController.requirePrivateApiAuth(),
  948. TpdsController.updateFolder
  949. )
  950. privateApiRouter.post(
  951. '/user/:user_id/update/*',
  952. AuthenticationController.requirePrivateApiAuth(),
  953. TpdsController.mergeUpdate
  954. )
  955. privateApiRouter.delete(
  956. '/user/:user_id/update/*',
  957. AuthenticationController.requirePrivateApiAuth(),
  958. TpdsController.deleteUpdate
  959. )
  960. privateApiRouter.post(
  961. '/project/:project_id/user/:user_id/update/*',
  962. AuthenticationController.requirePrivateApiAuth(),
  963. TpdsController.mergeUpdate
  964. )
  965. privateApiRouter.delete(
  966. '/project/:project_id/user/:user_id/update/*',
  967. AuthenticationController.requirePrivateApiAuth(),
  968. TpdsController.deleteUpdate
  969. )
  970. privateApiRouter.post(
  971. '/project/:project_id/contents/*',
  972. AuthenticationController.requirePrivateApiAuth(),
  973. TpdsController.updateProjectContents
  974. )
  975. privateApiRouter.delete(
  976. '/project/:project_id/contents/*',
  977. AuthenticationController.requirePrivateApiAuth(),
  978. TpdsController.deleteProjectContents
  979. )
  980. webRouter.post(
  981. '/spelling/check',
  982. AuthenticationController.requireLogin(),
  983. SpellingController.proxyRequestToSpellingApi
  984. )
  985. webRouter.post(
  986. '/spelling/learn',
  987. validate({
  988. body: Joi.object({
  989. word: Joi.string().required(),
  990. }),
  991. }),
  992. AuthenticationController.requireLogin(),
  993. SpellingController.learn
  994. )
  995. webRouter.post(
  996. '/spelling/unlearn',
  997. validate({
  998. body: Joi.object({
  999. word: Joi.string().required(),
  1000. }),
  1001. }),
  1002. AuthenticationController.requireLogin(),
  1003. SpellingController.unlearn
  1004. )
  1005. webRouter.get(
  1006. '/project/:project_id/messages',
  1007. AuthorizationMiddleware.blockRestrictedUserFromProject,
  1008. AuthorizationMiddleware.ensureUserCanReadProject,
  1009. ChatController.getMessages
  1010. )
  1011. webRouter.post(
  1012. '/project/:project_id/messages',
  1013. AuthorizationMiddleware.blockRestrictedUserFromProject,
  1014. AuthorizationMiddleware.ensureUserCanReadProject,
  1015. RateLimiterMiddleware.rateLimit(rateLimiters.sendChatMessage),
  1016. ChatController.sendMessage
  1017. )
  1018. webRouter.post(
  1019. '/project/:Project_id/references/index',
  1020. AuthorizationMiddleware.ensureUserCanReadProject,
  1021. RateLimiterMiddleware.rateLimit(rateLimiters.indexProjectReferences),
  1022. ReferencesController.index
  1023. )
  1024. webRouter.post(
  1025. '/project/:Project_id/references/indexAll',
  1026. AuthorizationMiddleware.ensureUserCanReadProject,
  1027. RateLimiterMiddleware.rateLimit(rateLimiters.indexAllProjectReferences),
  1028. ReferencesController.indexAll
  1029. )
  1030. // disable beta program while v2 is in beta
  1031. webRouter.get(
  1032. '/beta/participate',
  1033. AuthenticationController.requireLogin(),
  1034. BetaProgramController.optInPage
  1035. )
  1036. webRouter.post(
  1037. '/beta/opt-in',
  1038. AuthenticationController.requireLogin(),
  1039. BetaProgramController.optIn
  1040. )
  1041. webRouter.post(
  1042. '/beta/opt-out',
  1043. AuthenticationController.requireLogin(),
  1044. BetaProgramController.optOut
  1045. )
  1046. // New "api" endpoints. Started as a way for v1 to call over to v2 (for
  1047. // long-term features, as opposed to the nominally temporary ones in the
  1048. // overleaf-integration module), but may expand beyond that role.
  1049. publicApiRouter.post(
  1050. '/api/clsi/compile/:submission_id',
  1051. AuthenticationController.requirePrivateApiAuth(),
  1052. CompileController.compileSubmission
  1053. )
  1054. publicApiRouter.get(
  1055. /^\/api\/clsi\/compile\/([^/]*)\/build\/([0-9a-f-]+)\/output\/(.*)$/,
  1056. function (req, res, next) {
  1057. const params = {
  1058. submission_id: req.params[0],
  1059. build_id: req.params[1],
  1060. file: req.params[2],
  1061. }
  1062. req.params = params
  1063. next()
  1064. },
  1065. AuthenticationController.requirePrivateApiAuth(),
  1066. CompileController.getFileFromClsiWithoutUser
  1067. )
  1068. publicApiRouter.post(
  1069. '/api/institutions/confirm_university_domain',
  1070. RateLimiterMiddleware.rateLimit(rateLimiters.confirmUniversityDomain),
  1071. AuthenticationController.requirePrivateApiAuth(),
  1072. InstitutionsController.confirmDomain
  1073. )
  1074. webRouter.get('/chrome', function (req, res, next) {
  1075. // Match v1 behaviour - this is used for a Chrome web app
  1076. if (SessionManager.isUserLoggedIn(req.session)) {
  1077. res.redirect('/project')
  1078. } else {
  1079. res.redirect('/register')
  1080. }
  1081. })
  1082. webRouter.get(
  1083. '/admin',
  1084. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1085. AdminController.index
  1086. )
  1087. if (!Features.hasFeature('saas')) {
  1088. webRouter.post(
  1089. '/admin/openEditor',
  1090. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1091. AdminController.openEditor
  1092. )
  1093. webRouter.post(
  1094. '/admin/closeEditor',
  1095. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1096. AdminController.closeEditor
  1097. )
  1098. webRouter.post(
  1099. '/admin/disconnectAllUsers',
  1100. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1101. AdminController.disconnectAllUsers
  1102. )
  1103. }
  1104. webRouter.post(
  1105. '/admin/flushProjectToTpds',
  1106. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1107. AdminController.flushProjectToTpds
  1108. )
  1109. webRouter.post(
  1110. '/admin/pollDropboxForUser',
  1111. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1112. AdminController.pollDropboxForUser
  1113. )
  1114. webRouter.post(
  1115. '/admin/messages',
  1116. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1117. AdminController.createMessage
  1118. )
  1119. webRouter.post(
  1120. '/admin/messages/clear',
  1121. AuthorizationMiddleware.ensureUserIsSiteAdmin,
  1122. AdminController.clearMessages
  1123. )
  1124. privateApiRouter.get('/perfTest', (req, res) => {
  1125. plainTextResponse(res, 'hello')
  1126. })
  1127. publicApiRouter.get('/status', (req, res) => {
  1128. if (Settings.shuttingDown) {
  1129. res.sendStatus(503) // Service unavailable
  1130. } else if (!Settings.siteIsOpen) {
  1131. plainTextResponse(res, 'web site is closed (web)')
  1132. } else if (!Settings.editorIsOpen) {
  1133. plainTextResponse(res, 'web editor is closed (web)')
  1134. } else {
  1135. plainTextResponse(res, 'web sharelatex is alive (web)')
  1136. }
  1137. })
  1138. privateApiRouter.get('/status', (req, res) => {
  1139. plainTextResponse(res, 'web sharelatex is alive (api)')
  1140. })
  1141. // used by kubernetes health-check and acceptance tests
  1142. webRouter.get('/dev/csrf', (req, res) => {
  1143. plainTextResponse(res, res.locals.csrfToken)
  1144. })
  1145. publicApiRouter.get(
  1146. '/health_check',
  1147. HealthCheckController.checkActiveHandles,
  1148. HealthCheckController.check
  1149. )
  1150. privateApiRouter.get(
  1151. '/health_check',
  1152. HealthCheckController.checkActiveHandles,
  1153. HealthCheckController.checkApi
  1154. )
  1155. publicApiRouter.get(
  1156. '/health_check/api',
  1157. HealthCheckController.checkActiveHandles,
  1158. HealthCheckController.checkApi
  1159. )
  1160. privateApiRouter.get(
  1161. '/health_check/api',
  1162. HealthCheckController.checkActiveHandles,
  1163. HealthCheckController.checkApi
  1164. )
  1165. publicApiRouter.get(
  1166. '/health_check/full',
  1167. HealthCheckController.checkActiveHandles,
  1168. HealthCheckController.check
  1169. )
  1170. privateApiRouter.get(
  1171. '/health_check/full',
  1172. HealthCheckController.checkActiveHandles,
  1173. HealthCheckController.check
  1174. )
  1175. publicApiRouter.get('/health_check/redis', HealthCheckController.checkRedis)
  1176. privateApiRouter.get('/health_check/redis', HealthCheckController.checkRedis)
  1177. publicApiRouter.get('/health_check/mongo', HealthCheckController.checkMongo)
  1178. privateApiRouter.get('/health_check/mongo', HealthCheckController.checkMongo)
  1179. webRouter.get(
  1180. '/status/compiler/:Project_id',
  1181. RateLimiterMiddleware.rateLimit(rateLimiters.statusCompiler),
  1182. AuthorizationMiddleware.ensureUserCanReadProject,
  1183. function (req, res) {
  1184. const projectId = req.params.Project_id
  1185. // use a valid user id for testing
  1186. const testUserId = '123456789012345678901234'
  1187. const sendRes = _.once(function (statusCode, message) {
  1188. res.status(statusCode)
  1189. plainTextResponse(res, message)
  1190. ClsiCookieManager.clearServerId(projectId, testUserId, () => {})
  1191. }) // force every compile to a new server
  1192. // set a timeout
  1193. let handler = setTimeout(function () {
  1194. sendRes(500, 'Compiler timed out')
  1195. handler = null
  1196. }, 10000)
  1197. // run the compile
  1198. CompileManager.compile(
  1199. projectId,
  1200. testUserId,
  1201. {},
  1202. function (error, status) {
  1203. if (handler) {
  1204. clearTimeout(handler)
  1205. }
  1206. if (error) {
  1207. sendRes(500, `Compiler returned error ${error.message}`)
  1208. } else if (status === 'success') {
  1209. sendRes(200, 'Compiler returned in less than 10 seconds')
  1210. } else {
  1211. sendRes(500, `Compiler returned failure ${status}`)
  1212. }
  1213. }
  1214. )
  1215. }
  1216. )
  1217. webRouter.get('/no-cache', function (req, res, next) {
  1218. res.header('Cache-Control', 'max-age=0')
  1219. res.sendStatus(404)
  1220. })
  1221. webRouter.get('/oops-express', (req, res, next) =>
  1222. next(new Error('Test error'))
  1223. )
  1224. webRouter.get('/oops-internal', function (req, res, next) {
  1225. throw new Error('Test error')
  1226. })
  1227. webRouter.get('/oops-mongo', (req, res, next) =>
  1228. require('./models/Project').Project.findOne({}, function () {
  1229. throw new Error('Test error')
  1230. })
  1231. )
  1232. privateApiRouter.get('/opps-small', function (req, res, next) {
  1233. logger.err('test error occured')
  1234. res.sendStatus(200)
  1235. })
  1236. webRouter.post('/error/client', function (req, res, next) {
  1237. logger.warn(
  1238. { err: req.body.error, meta: req.body.meta },
  1239. 'client side error'
  1240. )
  1241. metrics.inc('client-side-error')
  1242. res.sendStatus(204)
  1243. })
  1244. webRouter.get(
  1245. `/read/:token(${TokenAccessController.READ_ONLY_TOKEN_PATTERN})`,
  1246. RateLimiterMiddleware.rateLimit(rateLimiters.readOnlyToken),
  1247. AnalyticsRegistrationSourceMiddleware.setSource(
  1248. 'collaboration',
  1249. 'link-sharing'
  1250. ),
  1251. TokenAccessController.tokenAccessPage,
  1252. AnalyticsRegistrationSourceMiddleware.clearSource()
  1253. )
  1254. webRouter.get(
  1255. `/:token(${TokenAccessController.READ_AND_WRITE_TOKEN_PATTERN})`,
  1256. RateLimiterMiddleware.rateLimit(rateLimiters.readAndWriteToken),
  1257. AnalyticsRegistrationSourceMiddleware.setSource(
  1258. 'collaboration',
  1259. 'link-sharing'
  1260. ),
  1261. TokenAccessController.tokenAccessPage,
  1262. AnalyticsRegistrationSourceMiddleware.clearSource()
  1263. )
  1264. webRouter.post(
  1265. `/:token(${TokenAccessController.READ_AND_WRITE_TOKEN_PATTERN})/grant`,
  1266. RateLimiterMiddleware.rateLimit(rateLimiters.grantTokenAccessReadWrite),
  1267. TokenAccessController.grantTokenAccessReadAndWrite
  1268. )
  1269. webRouter.post(
  1270. `/read/:token(${TokenAccessController.READ_ONLY_TOKEN_PATTERN})/grant`,
  1271. RateLimiterMiddleware.rateLimit(rateLimiters.grantTokenAccessReadOnly),
  1272. TokenAccessController.grantTokenAccessReadOnly
  1273. )
  1274. webRouter.get('/unsupported-browser', renderUnsupportedBrowserPage)
  1275. webRouter.get('*', ErrorController.notFound)
  1276. }
  1277. module.exports = { initialize, rateLimiters }