router.js 43 KB

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