router.mjs 39 KB

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