ProjectController.js 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926
  1. const _ = require('lodash')
  2. const OError = require('@overleaf/o-error')
  3. const crypto = require('crypto')
  4. const { setTimeout } = require('timers/promises')
  5. const pProps = require('p-props')
  6. const logger = require('@overleaf/logger')
  7. const { expressify } = require('@overleaf/promise-utils')
  8. const { ObjectId } = require('mongodb')
  9. const ProjectDeleter = require('./ProjectDeleter')
  10. const ProjectDuplicator = require('./ProjectDuplicator')
  11. const ProjectCreationHandler = require('./ProjectCreationHandler')
  12. const EditorController = require('../Editor/EditorController')
  13. const ProjectHelper = require('./ProjectHelper')
  14. const metrics = require('@overleaf/metrics')
  15. const { User } = require('../../models/User')
  16. const SubscriptionLocator = require('../Subscription/SubscriptionLocator')
  17. const LimitationsManager = require('../Subscription/LimitationsManager')
  18. const Settings = require('@overleaf/settings')
  19. const AuthorizationManager = require('../Authorization/AuthorizationManager')
  20. const InactiveProjectManager = require('../InactiveData/InactiveProjectManager')
  21. const ProjectUpdateHandler = require('./ProjectUpdateHandler')
  22. const ProjectGetter = require('./ProjectGetter')
  23. const PrivilegeLevels = require('../Authorization/PrivilegeLevels')
  24. const SessionManager = require('../Authentication/SessionManager')
  25. const Sources = require('../Authorization/Sources')
  26. const TokenAccessHandler = require('../TokenAccess/TokenAccessHandler')
  27. const CollaboratorsGetter = require('../Collaborators/CollaboratorsGetter')
  28. const ProjectEntityHandler = require('./ProjectEntityHandler')
  29. const TpdsProjectFlusher = require('../ThirdPartyDataStore/TpdsProjectFlusher')
  30. const Features = require('../../infrastructure/Features')
  31. const BrandVariationsHandler = require('../BrandVariations/BrandVariationsHandler')
  32. const UserController = require('../User/UserController')
  33. const AnalyticsManager = require('../Analytics/AnalyticsManager')
  34. const SplitTestHandler = require('../SplitTests/SplitTestHandler')
  35. const SplitTestSessionHandler = require('../SplitTests/SplitTestSessionHandler')
  36. const FeaturesUpdater = require('../Subscription/FeaturesUpdater')
  37. const SpellingHandler = require('../Spelling/SpellingHandler')
  38. const { hasAdminAccess } = require('../Helpers/AdminAuthorizationHelper')
  39. const InstitutionsFeatures = require('../Institutions/InstitutionsFeatures')
  40. const ProjectAuditLogHandler = require('./ProjectAuditLogHandler')
  41. const PublicAccessLevels = require('../Authorization/PublicAccessLevels')
  42. const TagsHandler = require('../Tags/TagsHandler')
  43. const TutorialHandler = require('../Tutorial/TutorialHandler')
  44. /**
  45. * @typedef {import("./types").GetProjectsRequest} GetProjectsRequest
  46. * @typedef {import("./types").GetProjectsResponse} GetProjectsResponse
  47. * @typedef {import("./types").Project} Project
  48. */
  49. const _ProjectController = {
  50. _isInPercentageRollout(rolloutName, objectId, percentage) {
  51. if (Settings.bypassPercentageRollouts === true) {
  52. return true
  53. }
  54. const data = `${rolloutName}:${objectId.toString()}`
  55. const md5hash = crypto.createHash('md5').update(data).digest('hex')
  56. const counter = parseInt(md5hash.slice(26, 32), 16)
  57. return counter % 100 < percentage
  58. },
  59. async updateProjectSettings(req, res) {
  60. const projectId = req.params.Project_id
  61. if (req.body.compiler != null) {
  62. await EditorController.promises.setCompiler(projectId, req.body.compiler)
  63. }
  64. if (req.body.imageName != null) {
  65. await EditorController.promises.setImageName(
  66. projectId,
  67. req.body.imageName
  68. )
  69. }
  70. if (req.body.name != null) {
  71. await EditorController.promises.renameProject(projectId, req.body.name)
  72. }
  73. if (req.body.spellCheckLanguage != null) {
  74. await EditorController.promises.setSpellCheckLanguage(
  75. projectId,
  76. req.body.spellCheckLanguage
  77. )
  78. }
  79. if (req.body.rootDocId != null) {
  80. await EditorController.promises.setRootDoc(projectId, req.body.rootDocId)
  81. }
  82. res.sendStatus(204)
  83. },
  84. async updateProjectAdminSettings(req, res) {
  85. const projectId = req.params.Project_id
  86. const user = SessionManager.getSessionUser(req.session)
  87. const publicAccessLevel = req.body.publicAccessLevel
  88. const publicAccessLevels = [
  89. PublicAccessLevels.READ_ONLY,
  90. PublicAccessLevels.READ_AND_WRITE,
  91. PublicAccessLevels.PRIVATE,
  92. PublicAccessLevels.TOKEN_BASED,
  93. ]
  94. if (
  95. req.body.publicAccessLevel != null &&
  96. publicAccessLevels.includes(publicAccessLevel)
  97. ) {
  98. await EditorController.promises.setPublicAccessLevel(
  99. projectId,
  100. req.body.publicAccessLevel
  101. )
  102. await ProjectAuditLogHandler.promises.addEntry(
  103. projectId,
  104. 'toggle-access-level',
  105. user._id,
  106. req.ip,
  107. { publicAccessLevel: req.body.publicAccessLevel, status: 'OK' }
  108. )
  109. res.sendStatus(204)
  110. } else {
  111. res.sendStatus(500)
  112. }
  113. },
  114. async deleteProject(req, res) {
  115. const projectId = req.params.Project_id
  116. const user = SessionManager.getSessionUser(req.session)
  117. await ProjectDeleter.promises.deleteProject(projectId, {
  118. deleterUser: user,
  119. ipAddress: req.ip,
  120. })
  121. res.sendStatus(200)
  122. },
  123. async archiveProject(req, res) {
  124. const projectId = req.params.Project_id
  125. const userId = SessionManager.getLoggedInUserId(req.session)
  126. await ProjectDeleter.promises.archiveProject(projectId, userId)
  127. res.sendStatus(200)
  128. },
  129. async unarchiveProject(req, res) {
  130. const projectId = req.params.Project_id
  131. const userId = SessionManager.getLoggedInUserId(req.session)
  132. await ProjectDeleter.promises.unarchiveProject(projectId, userId)
  133. res.sendStatus(200)
  134. },
  135. async trashProject(req, res) {
  136. const projectId = req.params.project_id
  137. const userId = SessionManager.getLoggedInUserId(req.session)
  138. await ProjectDeleter.promises.trashProject(projectId, userId)
  139. res.sendStatus(200)
  140. },
  141. async untrashProject(req, res) {
  142. const projectId = req.params.project_id
  143. const userId = SessionManager.getLoggedInUserId(req.session)
  144. await ProjectDeleter.promises.untrashProject(projectId, userId)
  145. res.sendStatus(200)
  146. },
  147. async expireDeletedProjectsAfterDuration(_req, res) {
  148. await ProjectDeleter.promises.expireDeletedProjectsAfterDuration()
  149. res.sendStatus(200)
  150. },
  151. async expireDeletedProject(req, res) {
  152. const { projectId } = req.params
  153. await ProjectDeleter.promises.expireDeletedProject(projectId)
  154. res.sendStatus(200)
  155. },
  156. async restoreProject(req, res) {
  157. const projectId = req.params.Project_id
  158. await ProjectDeleter.promises.restoreProject(projectId)
  159. res.sendStatus(200)
  160. },
  161. async cloneProject(req, res, next) {
  162. res.setTimeout(5 * 60 * 1000) // allow extra time for the copy to complete
  163. metrics.inc('cloned-project')
  164. const projectId = req.params.Project_id
  165. const { projectName, tags } = req.body
  166. logger.debug({ projectId, projectName }, 'cloning project')
  167. if (!SessionManager.isUserLoggedIn(req.session)) {
  168. return res.json({ redir: '/register' })
  169. }
  170. const currentUser = SessionManager.getSessionUser(req.session)
  171. const { first_name: firstName, last_name: lastName, email } = currentUser
  172. try {
  173. const project = await ProjectDuplicator.promises.duplicate(
  174. currentUser,
  175. projectId,
  176. projectName,
  177. tags
  178. )
  179. res.json({
  180. name: project.name,
  181. lastUpdated: project.lastUpdated,
  182. project_id: project._id,
  183. owner_ref: project.owner_ref,
  184. owner: {
  185. first_name: firstName,
  186. last_name: lastName,
  187. email,
  188. _id: currentUser._id,
  189. },
  190. })
  191. } catch (err) {
  192. OError.tag(err, 'error cloning project', {
  193. projectId,
  194. userId: currentUser._id,
  195. })
  196. return next(err)
  197. }
  198. },
  199. async newProject(req, res) {
  200. const currentUser = SessionManager.getSessionUser(req.session)
  201. const {
  202. first_name: firstName,
  203. last_name: lastName,
  204. email,
  205. _id: userId,
  206. } = currentUser
  207. const projectName =
  208. req.body.projectName != null ? req.body.projectName.trim() : undefined
  209. const { template } = req.body
  210. const project = await (template === 'example'
  211. ? ProjectCreationHandler.promises.createExampleProject(
  212. userId,
  213. projectName
  214. )
  215. : ProjectCreationHandler.promises.createBasicProject(userId, projectName))
  216. res.json({
  217. project_id: project._id,
  218. owner_ref: project.owner_ref,
  219. owner: {
  220. first_name: firstName,
  221. last_name: lastName,
  222. email,
  223. _id: userId,
  224. },
  225. })
  226. },
  227. async renameProject(req, res) {
  228. const projectId = req.params.Project_id
  229. const newName = req.body.newProjectName
  230. await EditorController.promises.renameProject(projectId, newName)
  231. res.sendStatus(200)
  232. },
  233. async userProjectsJson(req, res) {
  234. const userId = SessionManager.getLoggedInUserId(req.session)
  235. let projects = await ProjectGetter.promises.findAllUsersProjects(
  236. userId,
  237. 'name lastUpdated publicAccesLevel archived trashed owner_ref'
  238. )
  239. // _buildProjectList already converts archived/trashed to booleans so isArchivedOrTrashed should not be used here
  240. projects = ProjectController._buildProjectList(projects, userId)
  241. .filter(p => !(p.archived || p.trashed))
  242. .map(p => ({ _id: p.id, name: p.name, accessLevel: p.accessLevel }))
  243. res.json({ projects })
  244. },
  245. async projectEntitiesJson(req, res) {
  246. const projectId = req.params.Project_id
  247. const project = await ProjectGetter.promises.getProject(projectId)
  248. const { docs, files } =
  249. ProjectEntityHandler.getAllEntitiesFromProject(project)
  250. const entities = docs
  251. .concat(files)
  252. // Sort by path ascending
  253. .sort((a, b) => (a.path > b.path ? 1 : a.path < b.path ? -1 : 0))
  254. .map(e => ({
  255. path: e.path,
  256. type: e.doc != null ? 'doc' : 'file',
  257. }))
  258. res.json({ project_id: projectId, entities })
  259. },
  260. async loadEditor(req, res, next) {
  261. const timer = new metrics.Timer('load-editor')
  262. if (!Settings.editorIsOpen) {
  263. return res.render('general/closed', { title: 'updating_site' })
  264. }
  265. let anonymous, userId, sessionUser
  266. if (SessionManager.isUserLoggedIn(req.session)) {
  267. sessionUser = SessionManager.getSessionUser(req.session)
  268. userId = SessionManager.getLoggedInUserId(req.session)
  269. anonymous = false
  270. } else {
  271. sessionUser = null
  272. anonymous = true
  273. userId = null
  274. }
  275. const projectId = req.params.Project_id
  276. // should not be used in place of split tests query param overrides (?my-split-test-name=my-variant)
  277. function shouldDisplayFeature(name, variantFlag) {
  278. if (req.query && req.query[name]) {
  279. return req.query[name] === 'true'
  280. } else {
  281. return variantFlag === true
  282. }
  283. }
  284. const splitTests = [
  285. !anonymous && 'bib-file-tpr-prompt',
  286. 'compile-log-events',
  287. 'null-test-share-modal',
  288. 'paywall-cta',
  289. 'pdf-caching-cached-url-lookup',
  290. 'pdf-caching-mode',
  291. 'pdf-caching-prefetch-large',
  292. 'pdf-caching-prefetching',
  293. 'pdf-controls',
  294. 'pdf-presentation-mode',
  295. 'pdfjs-40',
  296. 'personal-access-token',
  297. 'revert-file',
  298. 'track-pdf-download',
  299. !anonymous && 'writefull-oauth-promotion',
  300. 'ieee-stylesheet',
  301. ].filter(Boolean)
  302. const getUserValues = async userId =>
  303. pProps(
  304. _.mapValues({
  305. user: (async () => {
  306. const user = await User.findById(
  307. userId,
  308. 'email first_name last_name referal_id signUpDate featureSwitches features featuresEpoch refProviders alphaProgram betaProgram isAdmin ace labsProgram completedTutorials writefull'
  309. ).exec()
  310. // Handle case of deleted user
  311. if (!user) {
  312. UserController.logout(req, res, next)
  313. return
  314. }
  315. logger.debug({ projectId, userId }, 'got user')
  316. return FeaturesUpdater.featuresEpochIsCurrent(user)
  317. ? user
  318. : await ProjectController._refreshFeatures(req, user)
  319. })(),
  320. learnedWords: SpellingHandler.promises.getUserDictionary(userId),
  321. projectTags: TagsHandler.promises.getTagsForProject(
  322. userId,
  323. projectId
  324. ),
  325. userHasInstitutionLicence: InstitutionsFeatures.promises
  326. .hasLicence(userId)
  327. .catch(err => {
  328. logger.error({ err, userId }, 'failed to get institution licence')
  329. return false
  330. }),
  331. subscription:
  332. SubscriptionLocator.promises.getUsersSubscription(userId),
  333. isTokenMember: CollaboratorsGetter.promises.userIsTokenMember(
  334. userId,
  335. projectId
  336. ),
  337. isInvitedMember:
  338. CollaboratorsGetter.promises.isUserInvitedMemberOfProject(
  339. userId,
  340. projectId
  341. ),
  342. })
  343. )
  344. const splitTestAssignments = {}
  345. try {
  346. const responses = await pProps({
  347. userValues: userId ? getUserValues(userId) : defaultUserValues(),
  348. splitTestAssignments: Promise.all(
  349. splitTests.map(async splitTest => {
  350. splitTestAssignments[splitTest] =
  351. await SplitTestHandler.promises.getAssignment(req, res, splitTest)
  352. })
  353. ),
  354. project: ProjectGetter.promises.getProject(projectId, {
  355. name: 1,
  356. lastUpdated: 1,
  357. track_changes: 1,
  358. owner_ref: 1,
  359. brandVariationId: 1,
  360. overleaf: 1,
  361. tokens: 1,
  362. }),
  363. userIsMemberOfGroupSubscription: sessionUser
  364. ? LimitationsManager.promises.userIsMemberOfGroupSubscription(
  365. sessionUser
  366. )
  367. : false,
  368. _flushToTpds:
  369. TpdsProjectFlusher.promises.flushProjectToTpdsIfNeeded(projectId),
  370. _activate:
  371. InactiveProjectManager.promises.reactivateProjectIfRequired(
  372. projectId
  373. ),
  374. })
  375. const { project, userValues, userIsMemberOfGroupSubscription } = responses
  376. const {
  377. user,
  378. learnedWords,
  379. projectTags,
  380. userHasInstitutionLicence,
  381. subscription,
  382. isTokenMember,
  383. isInvitedMember,
  384. } = userValues
  385. const brandVariation = project?.brandVariationId
  386. ? await BrandVariationsHandler.promises.getBrandVariationById(
  387. project.brandVariationId
  388. )
  389. : undefined
  390. const anonRequestToken = TokenAccessHandler.getRequestToken(
  391. req,
  392. projectId
  393. )
  394. const allowedImageNames = ProjectHelper.getAllowedImagesForUser(user)
  395. const privilegeLevel =
  396. await AuthorizationManager.promises.getPrivilegeLevelForProject(
  397. userId,
  398. projectId,
  399. anonRequestToken
  400. )
  401. let allowedFreeTrial = true
  402. if (privilegeLevel == null || privilegeLevel === PrivilegeLevels.NONE) {
  403. return res.sendStatus(401)
  404. }
  405. if (subscription != null) {
  406. allowedFreeTrial = false
  407. }
  408. let wsUrl = Settings.wsUrl
  409. let metricName = 'load-editor-ws'
  410. if (user.betaProgram && Settings.wsUrlBeta !== undefined) {
  411. wsUrl = Settings.wsUrlBeta
  412. metricName += '-beta'
  413. } else if (
  414. Settings.wsUrlV2 &&
  415. Settings.wsUrlV2Percentage > 0 &&
  416. (new ObjectId(projectId).getTimestamp() / 1000) % 100 <
  417. Settings.wsUrlV2Percentage
  418. ) {
  419. wsUrl = Settings.wsUrlV2
  420. metricName += '-v2'
  421. }
  422. if (req.query && req.query.ws === 'fallback') {
  423. // `?ws=fallback` will connect to the bare origin, and ignore
  424. // the custom wsUrl. Hence it must load the client side
  425. // javascript from there too.
  426. // Not resetting it here would possibly load a socket.io v2
  427. // client and connect to a v0 endpoint.
  428. wsUrl = undefined
  429. metricName += '-fallback'
  430. }
  431. metrics.inc(metricName)
  432. // don't need to wait for these to complete
  433. ProjectUpdateHandler.promises
  434. .markAsOpened(projectId)
  435. .catch(err =>
  436. logger.error({ err, projectId }, 'failed to mark project as opened')
  437. )
  438. SplitTestSessionHandler.promises
  439. .sessionMaintenance(req, userId ? user : null)
  440. .catch(err =>
  441. logger.error({ err }, 'failed to update split test info in session')
  442. )
  443. if (userId) {
  444. AnalyticsManager.recordEventForUserInBackground(
  445. userId,
  446. 'project-opened',
  447. {
  448. projectId: project._id,
  449. }
  450. )
  451. User.updateOne(
  452. { _id: new ObjectId(userId) },
  453. { $set: { lastActive: new Date() } }
  454. )
  455. .exec()
  456. .catch(err =>
  457. logger.error(
  458. { err, userId },
  459. 'failed to update lastActive for user'
  460. )
  461. )
  462. }
  463. const isAdminOrTemplateOwner =
  464. hasAdminAccess(user) || Settings.templates?.user_id === userId
  465. const showTemplatesServerPro =
  466. Features.hasFeature('templates-server-pro') && isAdminOrTemplateOwner
  467. const debugPdfDetach = shouldDisplayFeature('debug_pdf_detach')
  468. const detachRole = req.params.detachRole
  469. const showSymbolPalette =
  470. !Features.hasFeature('saas') ||
  471. (user.features && user.features.symbolPalette)
  472. // Persistent upgrade prompts
  473. // in header & in share project modal
  474. const showUpgradePrompt =
  475. Features.hasFeature('saas') &&
  476. userId &&
  477. !subscription &&
  478. !userIsMemberOfGroupSubscription &&
  479. !userHasInstitutionLicence
  480. const showPersonalAccessToken =
  481. userId &&
  482. (!Features.hasFeature('saas') ||
  483. req.query?.personal_access_token === 'true')
  484. const optionalPersonalAccessToken =
  485. userId &&
  486. !showPersonalAccessToken &&
  487. splitTestAssignments['personal-access-token'].variant === 'enabled' // `?personal-access-token=enabled`
  488. const showAiErrorAssistant =
  489. userId &&
  490. Features.hasFeature('saas') &&
  491. (user.features?.aiErrorAssistant || user.alphaProgram) &&
  492. (privilegeLevel === PrivilegeLevels.READ_AND_WRITE ||
  493. privilegeLevel === PrivilegeLevels.OWNER)
  494. const template =
  495. detachRole === 'detached'
  496. ? 'project/ide-react-detached'
  497. : 'project/ide-react'
  498. res.render(template, {
  499. title: project.name,
  500. priority_title: true,
  501. bodyClasses: ['editor'],
  502. project_id: project._id,
  503. projectName: project.name,
  504. user: {
  505. id: userId,
  506. email: user.email,
  507. first_name: user.first_name,
  508. last_name: user.last_name,
  509. referal_id: user.referal_id,
  510. signUpDate: user.signUpDate,
  511. allowedFreeTrial,
  512. featureSwitches: user.featureSwitches,
  513. features: user.features,
  514. refProviders: _.mapValues(user.refProviders, Boolean),
  515. writefull: {
  516. enabled: Boolean(user.writefull?.enabled),
  517. },
  518. alphaProgram: user.alphaProgram,
  519. betaProgram: user.betaProgram,
  520. labsProgram: user.labsProgram,
  521. inactiveTutorials: TutorialHandler.getInactiveTutorials(user),
  522. isAdmin: hasAdminAccess(user),
  523. },
  524. userSettings: {
  525. mode: user.ace.mode,
  526. editorTheme: user.ace.theme,
  527. fontSize: user.ace.fontSize,
  528. autoComplete: user.ace.autoComplete,
  529. autoPairDelimiters: user.ace.autoPairDelimiters,
  530. pdfViewer: user.ace.pdfViewer,
  531. syntaxValidation: user.ace.syntaxValidation,
  532. fontFamily: user.ace.fontFamily || 'lucida',
  533. lineHeight: user.ace.lineHeight || 'normal',
  534. overallTheme: user.ace.overallTheme,
  535. },
  536. privilegeLevel,
  537. anonymous,
  538. isTokenMember,
  539. isRestrictedTokenMember: AuthorizationManager.isRestrictedUser(
  540. userId,
  541. privilegeLevel,
  542. isTokenMember,
  543. isInvitedMember
  544. ),
  545. languages: Settings.languages,
  546. learnedWords,
  547. editorThemes: THEME_LIST,
  548. legacyEditorThemes: LEGACY_THEME_LIST,
  549. maxDocLength: Settings.max_doc_length,
  550. brandVariation,
  551. allowedImageNames,
  552. gitBridgePublicBaseUrl: Settings.gitBridgePublicBaseUrl,
  553. gitBridgeEnabled: Features.hasFeature('git-bridge'),
  554. wsUrl,
  555. showSupport: Features.hasFeature('support'),
  556. showTemplatesServerPro,
  557. pdfjsVariant: splitTestAssignments['pdfjs-40'].variant,
  558. debugPdfDetach,
  559. showSymbolPalette,
  560. symbolPaletteAvailable: Features.hasFeature('symbol-palette'),
  561. showAiErrorAssistant,
  562. detachRole,
  563. metadata: { viewport: false },
  564. showUpgradePrompt,
  565. fixedSizeDocument: true,
  566. useOpenTelemetry: Settings.useOpenTelemetryClient,
  567. showPersonalAccessToken,
  568. optionalPersonalAccessToken,
  569. hasTrackChangesFeature: Features.hasFeature('track-changes'),
  570. projectTags,
  571. })
  572. timer.done()
  573. } catch (err) {
  574. OError.tag(err, 'error getting details for project page')
  575. return next(err)
  576. }
  577. },
  578. async _refreshFeatures(req, user) {
  579. // If the feature refresh has failed in this session, don't retry
  580. // it - require the user to log in again.
  581. if (req.session.feature_refresh_failed) {
  582. metrics.inc('features-refresh', 1, {
  583. path: 'load-editor',
  584. status: 'skipped',
  585. })
  586. return user
  587. }
  588. // If the refresh takes too long then return the current
  589. // features. Note that the user.features property may still be
  590. // updated in the background after the promise is resolved.
  591. const abortController = new AbortController()
  592. const refreshTimeoutHandler = async () => {
  593. await setTimeout(5000, { signal: abortController.signal })
  594. req.session.feature_refresh_failed = {
  595. reason: 'timeout',
  596. at: new Date(),
  597. }
  598. metrics.inc('features-refresh', 1, {
  599. path: 'load-editor',
  600. status: 'timeout',
  601. })
  602. return user
  603. }
  604. // try to refresh user features now
  605. const timer = new metrics.Timer('features-refresh-on-load-editor')
  606. return Promise.race([
  607. refreshTimeoutHandler(),
  608. (async () => {
  609. try {
  610. user.features = await FeaturesUpdater.promises.refreshFeatures(
  611. user._id,
  612. 'load-editor'
  613. )
  614. metrics.inc('features-refresh', 1, {
  615. path: 'load-editor',
  616. status: 'success',
  617. })
  618. } catch (err) {
  619. // keep a record to prevent unneceary retries and leave
  620. // the original features unmodified if the refresh failed
  621. req.session.feature_refresh_failed = {
  622. reason: 'error',
  623. at: new Date(),
  624. }
  625. metrics.inc('features-refresh', 1, {
  626. path: 'load-editor',
  627. status: 'error',
  628. })
  629. }
  630. abortController.abort()
  631. timer.done()
  632. return user
  633. })(),
  634. ])
  635. },
  636. _buildProjectList(allProjects, userId) {
  637. let project
  638. const { owned, readAndWrite, readOnly, tokenReadAndWrite, tokenReadOnly } =
  639. allProjects
  640. const projects = []
  641. for (project of owned) {
  642. projects.push(
  643. ProjectController._buildProjectViewModel(
  644. project,
  645. 'owner',
  646. Sources.OWNER,
  647. userId
  648. )
  649. )
  650. }
  651. // Invite-access
  652. for (project of readAndWrite) {
  653. projects.push(
  654. ProjectController._buildProjectViewModel(
  655. project,
  656. 'readWrite',
  657. Sources.INVITE,
  658. userId
  659. )
  660. )
  661. }
  662. for (project of readOnly) {
  663. projects.push(
  664. ProjectController._buildProjectViewModel(
  665. project,
  666. 'readOnly',
  667. Sources.INVITE,
  668. userId
  669. )
  670. )
  671. }
  672. // Token-access
  673. // Only add these projects if they're not already present, this gives us cascading access
  674. // from 'owner' => 'token-read-only'
  675. for (project of tokenReadAndWrite) {
  676. if (
  677. projects.filter(p => p.id.toString() === project._id.toString())
  678. .length === 0
  679. ) {
  680. projects.push(
  681. ProjectController._buildProjectViewModel(
  682. project,
  683. 'readAndWrite',
  684. Sources.TOKEN,
  685. userId
  686. )
  687. )
  688. }
  689. }
  690. for (project of tokenReadOnly) {
  691. if (
  692. projects.filter(p => p.id.toString() === project._id.toString())
  693. .length === 0
  694. ) {
  695. projects.push(
  696. ProjectController._buildProjectViewModel(
  697. project,
  698. 'readOnly',
  699. Sources.TOKEN,
  700. userId
  701. )
  702. )
  703. }
  704. }
  705. return projects
  706. },
  707. _buildProjectViewModel(project, accessLevel, source, userId) {
  708. const archived = ProjectHelper.isArchived(project, userId)
  709. // If a project is simultaneously trashed and archived, we will consider it archived but not trashed.
  710. const trashed = ProjectHelper.isTrashed(project, userId) && !archived
  711. const model = {
  712. id: project._id,
  713. name: project.name,
  714. lastUpdated: project.lastUpdated,
  715. lastUpdatedBy: project.lastUpdatedBy,
  716. publicAccessLevel: project.publicAccesLevel,
  717. accessLevel,
  718. source,
  719. archived,
  720. trashed,
  721. owner_ref: project.owner_ref,
  722. isV1Project: false,
  723. }
  724. if (accessLevel === PrivilegeLevels.READ_ONLY && source === Sources.TOKEN) {
  725. model.owner_ref = null
  726. model.lastUpdatedBy = null
  727. }
  728. return model
  729. },
  730. _buildPortalTemplatesList(affiliations) {
  731. if (affiliations == null) {
  732. affiliations = []
  733. }
  734. const portalTemplates = []
  735. for (const aff of affiliations) {
  736. if (
  737. aff.portal &&
  738. aff.portal.slug &&
  739. aff.portal.templates_count &&
  740. aff.portal.templates_count > 0
  741. ) {
  742. const portalPath = aff.institution.isUniversity ? '/edu/' : '/org/'
  743. portalTemplates.push({
  744. name: aff.institution.name,
  745. url: Settings.siteUrl + portalPath + aff.portal.slug,
  746. })
  747. }
  748. }
  749. return portalTemplates
  750. },
  751. }
  752. const defaultSettingsForAnonymousUser = userId => ({
  753. id: userId,
  754. ace: {
  755. mode: 'none',
  756. theme: 'textmate',
  757. fontSize: '12',
  758. autoComplete: true,
  759. spellCheckLanguage: '',
  760. pdfViewer: '',
  761. syntaxValidation: true,
  762. },
  763. subscription: {
  764. freeTrial: {
  765. allowed: true,
  766. },
  767. },
  768. featureSwitches: {
  769. github: false,
  770. },
  771. alphaProgram: false,
  772. betaProgram: false,
  773. writefull: {
  774. enabled: false,
  775. },
  776. })
  777. const defaultUserValues = () => ({
  778. user: defaultSettingsForAnonymousUser(null),
  779. learnedWords: [],
  780. projectTags: [],
  781. userHasInstitutionLicence: false,
  782. subscription: undefined,
  783. isTokenMember: false,
  784. isInvitedMember: false,
  785. })
  786. const THEME_LIST = [
  787. 'cobalt',
  788. 'dracula',
  789. 'eclipse',
  790. 'monokai',
  791. 'overleaf',
  792. 'textmate',
  793. ]
  794. const LEGACY_THEME_LIST = [
  795. 'ambiance',
  796. 'chaos',
  797. 'chrome',
  798. 'clouds',
  799. 'clouds_midnight',
  800. 'crimson_editor',
  801. 'dawn',
  802. 'dreamweaver',
  803. 'github',
  804. 'gob',
  805. 'gruvbox',
  806. 'idle_fingers',
  807. 'iplastic',
  808. 'katzenmilch',
  809. 'kr_theme',
  810. 'kuroir',
  811. 'merbivore',
  812. 'merbivore_soft',
  813. 'mono_industrial',
  814. 'nord_dark',
  815. 'pastel_on_dark',
  816. 'solarized_dark',
  817. 'solarized_light',
  818. 'sqlserver',
  819. 'terminal',
  820. 'tomorrow',
  821. 'tomorrow_night',
  822. 'tomorrow_night_blue',
  823. 'tomorrow_night_bright',
  824. 'tomorrow_night_eighties',
  825. 'twilight',
  826. 'vibrant_ink',
  827. 'xcode',
  828. ]
  829. const ProjectController = {
  830. archiveProject: expressify(_ProjectController.archiveProject),
  831. cloneProject: expressify(_ProjectController.cloneProject),
  832. deleteProject: expressify(_ProjectController.deleteProject),
  833. expireDeletedProject: expressify(_ProjectController.expireDeletedProject),
  834. expireDeletedProjectsAfterDuration: expressify(
  835. _ProjectController.expireDeletedProjectsAfterDuration
  836. ),
  837. loadEditor: expressify(_ProjectController.loadEditor),
  838. newProject: expressify(_ProjectController.newProject),
  839. projectEntitiesJson: expressify(_ProjectController.projectEntitiesJson),
  840. renameProject: expressify(_ProjectController.renameProject),
  841. restoreProject: expressify(_ProjectController.restoreProject),
  842. trashProject: expressify(_ProjectController.trashProject),
  843. unarchiveProject: expressify(_ProjectController.unarchiveProject),
  844. untrashProject: expressify(_ProjectController.untrashProject),
  845. updateProjectAdminSettings: expressify(
  846. _ProjectController.updateProjectAdminSettings
  847. ),
  848. updateProjectSettings: expressify(_ProjectController.updateProjectSettings),
  849. userProjectsJson: expressify(_ProjectController.userProjectsJson),
  850. _buildProjectList: _ProjectController._buildProjectList,
  851. _buildProjectViewModel: _ProjectController._buildProjectViewModel,
  852. _injectProjectUsers: _ProjectController._injectProjectUsers,
  853. _isInPercentageRollout: _ProjectController._isInPercentageRollout,
  854. _refreshFeatures: _ProjectController._refreshFeatures,
  855. }
  856. module.exports = ProjectController