router.mjs 40 KB

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