router.js 43 KB

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