User.js 32 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295
  1. const OError = require('@overleaf/o-error')
  2. const request = require('./request')
  3. const settings = require('@overleaf/settings')
  4. const { db, ObjectId } = require('../../../../app/src/infrastructure/mongodb')
  5. const UserModel = require('../../../../app/src/models/User').User
  6. const UserUpdater = require('../../../../app/src/Features/User/UserUpdater')
  7. const AuthenticationManager = require('../../../../app/src/Features/Authentication/AuthenticationManager')
  8. const { promisifyClass } = require('@overleaf/promise-utils')
  9. const fs = require('fs')
  10. const Path = require('path')
  11. const { Cookie } = require('tough-cookie')
  12. const COOKIE_DOMAIN = settings.cookieDomain
  13. // The cookie domain has a leading '.' but the cookie jar stores it without.
  14. const DEFAULT_COOKIE_URL = `https://${COOKIE_DOMAIN.replace(/^\./, '')}/`
  15. let count = settings.test.counterInit
  16. class User {
  17. constructor(options) {
  18. if (options == null) {
  19. options = {}
  20. }
  21. this.emails = [
  22. {
  23. email: options.email || `acceptance-test-${count}@example.com`,
  24. createdAt: new Date(),
  25. confirmedAt: options.confirmedAt,
  26. },
  27. ]
  28. this.email = this.emails[0].email
  29. this.password = `a-terrible-secret-${count}`
  30. count++
  31. this.jar = request.jar()
  32. this.request = request.defaults({
  33. jar: this.jar,
  34. })
  35. }
  36. getSession(options, callback) {
  37. if (typeof options === 'function') {
  38. callback = options
  39. options = {}
  40. }
  41. this.request.get(
  42. {
  43. url: '/dev/session',
  44. qs: options.set,
  45. },
  46. (err, response, body) => {
  47. if (err != null) {
  48. return callback(err)
  49. }
  50. if (response.statusCode !== 200) {
  51. return callback(
  52. new Error(
  53. `get session failed: status=${
  54. response.statusCode
  55. } body=${JSON.stringify(body)}`
  56. )
  57. )
  58. }
  59. const session = JSON.parse(response.body)
  60. callback(null, session)
  61. }
  62. )
  63. }
  64. setInSession(params, callback) {
  65. this.getCsrfToken(error => {
  66. if (error != null) {
  67. return callback(error)
  68. }
  69. this.request.post(
  70. {
  71. url: '/dev/set_in_session',
  72. json: params,
  73. },
  74. (err, response, body) => {
  75. if (err != null) {
  76. return callback(err)
  77. }
  78. if (response.statusCode !== 200) {
  79. return callback(
  80. new Error(
  81. `post set in session failed: status=${
  82. response.statusCode
  83. } body=${JSON.stringify(body)}`
  84. )
  85. )
  86. }
  87. callback(null)
  88. }
  89. )
  90. })
  91. }
  92. getSplitTestAssignment(splitTestName, query, callback) {
  93. if (!callback) {
  94. callback = query
  95. }
  96. const params = new URLSearchParams({
  97. splitTestName,
  98. ...query,
  99. }).toString()
  100. this.request.get(
  101. {
  102. url: `/dev/split_test/get_assignment?${params}`,
  103. },
  104. (err, response, body) => {
  105. if (err != null) {
  106. return callback(err)
  107. }
  108. if (response.statusCode !== 200) {
  109. return callback(
  110. new Error(
  111. `get split test assignment failed: status=${
  112. response.statusCode
  113. } body=${JSON.stringify(body)}`
  114. )
  115. )
  116. }
  117. const assignment = JSON.parse(response.body)
  118. callback(null, assignment)
  119. }
  120. )
  121. }
  122. doSessionMaintenance(callback) {
  123. this.request.post(
  124. {
  125. url: `/dev/split_test/session_maintenance`,
  126. },
  127. (err, response, body) => {
  128. if (err != null) {
  129. return callback(err)
  130. }
  131. if (response.statusCode !== 200) {
  132. return callback(
  133. new Error(
  134. `post session maintenance failed: status=${
  135. response.statusCode
  136. } body=${JSON.stringify(body)}`
  137. )
  138. )
  139. }
  140. callback(null)
  141. }
  142. )
  143. }
  144. optIntoBeta(callback) {
  145. this.request.post(
  146. {
  147. url: '/beta/opt-in',
  148. },
  149. (err, response, body) => {
  150. if (err != null) {
  151. return callback(err)
  152. }
  153. if (response.statusCode !== 302) {
  154. return callback(
  155. new Error(
  156. `post beta opt-in failed: status=${
  157. response.statusCode
  158. } body=${JSON.stringify(body)}`
  159. )
  160. )
  161. }
  162. callback(null)
  163. }
  164. )
  165. }
  166. optOutOfBeta(callback) {
  167. this.request.post(
  168. {
  169. url: '/beta/opt-out',
  170. },
  171. (err, response, body) => {
  172. if (err != null) {
  173. return callback(err)
  174. }
  175. if (response.statusCode !== 302) {
  176. return callback(
  177. new Error(
  178. `post beta opt-out failed: status=${
  179. response.statusCode
  180. } body=${JSON.stringify(body)}`
  181. )
  182. )
  183. }
  184. callback(null)
  185. }
  186. )
  187. }
  188. /* Return the session cookie, url decoded. Use the option {raw:true} to get the original undecoded value */
  189. sessionCookie(options) {
  190. const cookie = Cookie.parse(this.jar.getCookieString(DEFAULT_COOKIE_URL))
  191. if (cookie?.value && !options?.raw) {
  192. cookie.value = decodeURIComponent(cookie.value)
  193. }
  194. return cookie
  195. }
  196. /* Set the session cookie from a string and store it in the cookie jar, so that it will be used
  197. for subsequent requests. */
  198. setSessionCookie(cookie) {
  199. const sessionCookie = request.cookie(
  200. `${settings.cookieName}=${cookie}; Domain=${COOKIE_DOMAIN}; Max-age=3600; Path=/; SameSite=Lax`
  201. )
  202. this.jar.setCookie(sessionCookie, DEFAULT_COOKIE_URL)
  203. }
  204. getEmailConfirmationCode(callback) {
  205. this.getSession((err, session) => {
  206. if (err != null) {
  207. return callback(err)
  208. }
  209. const code = session.pendingUserRegistration?.confirmCode
  210. if (!code) {
  211. return callback(new Error('No confirmation code found in session'))
  212. }
  213. callback(null, code)
  214. })
  215. }
  216. resetCookies() {
  217. this.jar = request.jar()
  218. this.request = request.defaults({
  219. jar: this.jar,
  220. })
  221. }
  222. setExtraAttributes(user) {
  223. if ((user != null ? user._id : undefined) == null) {
  224. throw new Error('User does not exist')
  225. }
  226. this.id = user._id.toString()
  227. this._id = user._id.toString()
  228. this.first_name = user.first_name
  229. this.referal_id = user.referal_id
  230. this.enrollment = user.enrollment
  231. }
  232. get(callback) {
  233. db.users.findOne({ _id: new ObjectId(this._id) }, callback)
  234. }
  235. getAuditLog(callback) {
  236. this.get((error, user) => {
  237. if (error) return callback(error)
  238. if (!user) return callback(new Error('User not found'))
  239. db.userAuditLogEntries
  240. .find({ userId: new ObjectId(this._id) })
  241. .toArray((error, auditLog) => {
  242. if (error) return callback(error)
  243. callback(null, auditLog || [])
  244. })
  245. })
  246. }
  247. getAuditLogWithoutNoise(callback) {
  248. this.getAuditLog((error, auditLog) => {
  249. if (error) return callback(error)
  250. callback(
  251. null,
  252. auditLog.filter(entry => {
  253. return entry.operation !== 'login'
  254. })
  255. )
  256. })
  257. }
  258. mongoUpdate(updateOp, callback) {
  259. db.users.updateOne({ _id: new ObjectId(this._id) }, updateOp, callback)
  260. }
  261. register(callback) {
  262. this.registerWithQuery('', callback)
  263. }
  264. registerWithQuery(query, callback) {
  265. if (this._id != null) {
  266. return callback(new Error('User already registered'))
  267. }
  268. this.getCsrfToken(error => {
  269. if (error != null) {
  270. return callback(error)
  271. }
  272. this.request.post(
  273. {
  274. url: `/register${query}`,
  275. json: { email: this.email, password: this.password },
  276. },
  277. (error, response, body) => {
  278. if (error != null) {
  279. return callback(error)
  280. }
  281. if (response.statusCode !== 200) {
  282. return callback(
  283. new Error(
  284. `register failed: status=${
  285. response.statusCode
  286. } body=${JSON.stringify(body)}`
  287. )
  288. )
  289. }
  290. this.getEmailConfirmationCode((error, code) => {
  291. if (error != null) {
  292. return callback(error)
  293. }
  294. this.request.post(
  295. {
  296. url: '/registration/confirm-email',
  297. json: { code },
  298. },
  299. (error, response, body) => {
  300. if (error != null) {
  301. return callback(error)
  302. }
  303. if (response.statusCode !== 200) {
  304. return callback(
  305. new Error(
  306. `email confirmation failed: status=${
  307. response.statusCode
  308. } body=${JSON.stringify(body)}`
  309. )
  310. )
  311. }
  312. db.users.findOne({ email: this.email }, (error, user) => {
  313. if (error != null) {
  314. return callback(error)
  315. }
  316. this.setExtraAttributes(user)
  317. callback(null, user, response)
  318. })
  319. }
  320. )
  321. })
  322. }
  323. )
  324. })
  325. }
  326. login(callback) {
  327. this.loginWith(this.email, callback)
  328. }
  329. loginWith(email, callback) {
  330. this.ensureUserExists(error => {
  331. if (error != null) {
  332. return callback(error)
  333. }
  334. this.loginWithEmailPassword(email, this.password, callback)
  335. })
  336. }
  337. loginNoUpdate(callback) {
  338. this.loginWithEmailPassword(this.email, this.password, callback)
  339. }
  340. loginWithEmailPassword(email, password, callback) {
  341. this.getCsrfToken(error => {
  342. if (error != null) {
  343. return callback(error)
  344. }
  345. this.request.post(
  346. {
  347. url: settings.enableLegacyLogin ? '/login/legacy' : '/login',
  348. json: {
  349. email,
  350. password,
  351. 'g-recaptcha-response': 'valid',
  352. },
  353. },
  354. (error, response, body) => {
  355. if (error != null) {
  356. return callback(error)
  357. }
  358. if (response.statusCode !== 200) {
  359. return callback(
  360. new OError(
  361. `login failed: status=${
  362. response.statusCode
  363. } body=${JSON.stringify(body)}`,
  364. { response, body }
  365. )
  366. )
  367. }
  368. // get new csrf token, then return result of login
  369. this.getCsrfToken(err => {
  370. if (err) {
  371. return callback(OError.tag(err, 'after login'))
  372. }
  373. callback(null, response, body)
  374. })
  375. }
  376. )
  377. })
  378. }
  379. ensureUserExists(callback) {
  380. const filter = { email: this.email }
  381. const options = { upsert: true, new: true, setDefaultsOnInsert: true }
  382. AuthenticationManager.hashPassword(
  383. this.password,
  384. (error, hashedPassword) => {
  385. if (error != null) {
  386. return callback(error)
  387. }
  388. UserModel.findOneAndUpdate(
  389. filter,
  390. { $set: { hashedPassword, emails: this.emails } },
  391. options
  392. )
  393. .then(user => {
  394. this.setExtraAttributes(user)
  395. callback(null, this.password)
  396. })
  397. .catch(callback)
  398. }
  399. )
  400. }
  401. setFeatures(features, callback) {
  402. const update = {}
  403. for (const key in features) {
  404. const value = features[key]
  405. update[`features.${key}`] = value
  406. }
  407. UserModel.updateOne({ _id: this.id }, update)
  408. .then((...args) => callback(null, ...args))
  409. .catch(callback)
  410. }
  411. setFeaturesOverride(featuresOverride, callback) {
  412. const update = { $push: { featuresOverrides: featuresOverride } }
  413. UserModel.updateOne({ _id: this.id }, update)
  414. .then((...args) => callback(null, ...args))
  415. .catch(callback)
  416. }
  417. setOverleafId(overleafId, callback) {
  418. UserModel.updateOne({ _id: this.id }, { 'overleaf.id': overleafId })
  419. .then((...args) => callback(null, ...args))
  420. .catch(callback)
  421. }
  422. setEmails(emails, callback) {
  423. UserModel.updateOne({ _id: this.id }, { emails })
  424. .then((...args) => callback(null, ...args))
  425. .catch(callback)
  426. }
  427. setSuspended(suspended, callback) {
  428. UserModel.updateOne({ _id: this.id }, { suspended })
  429. .then((...args) => callback(null, ...args))
  430. .catch(callback)
  431. }
  432. logout(callback) {
  433. this.getCsrfToken(error => {
  434. if (error != null) {
  435. return callback(error)
  436. }
  437. this.request.post(
  438. {
  439. url: '/logout',
  440. },
  441. (error, response, body) => {
  442. if (error != null) {
  443. return callback(error)
  444. }
  445. if (response.statusCode >= 400) {
  446. return callback(
  447. new Error(
  448. `logout failed: status=${
  449. response.statusCode
  450. } body=${JSON.stringify(body)}`
  451. )
  452. )
  453. }
  454. db.users.findOne({ email: this.email }, (error, user) => {
  455. if (error != null) {
  456. return callback(error)
  457. }
  458. if (user == null) {
  459. return callback()
  460. }
  461. this.id = user._id.toString()
  462. this._id = user._id.toString()
  463. callback()
  464. })
  465. }
  466. )
  467. })
  468. }
  469. addEmail(email, callback) {
  470. this.emails.push({ email, createdAt: new Date() })
  471. UserUpdater.addEmailAddress(
  472. this.id,
  473. email,
  474. {},
  475. { initiatorId: this._id, ipAddress: '127:0:0:0' },
  476. callback
  477. )
  478. }
  479. confirmEmail(email, callback) {
  480. for (let idx = 0; idx < this.emails.length; idx++) {
  481. const emailData = this.emails[idx]
  482. if (emailData.email === email) {
  483. this.emails[idx].confirmedAt = new Date()
  484. }
  485. }
  486. UserUpdater.confirmEmail(this.id, email, callback)
  487. }
  488. ensureAdmin(callback) {
  489. this.mongoUpdate({ $set: { isAdmin: true } }, callback)
  490. }
  491. ensureStaffAccess(flag, callback) {
  492. const update = { $set: {} }
  493. update.$set[`staffAccess.${flag}`] = true
  494. this.mongoUpdate(update, callback)
  495. }
  496. upgradeFeatures(callback) {
  497. const features = {
  498. collaborators: -1, // Infinite
  499. versioning: true,
  500. dropbox: true,
  501. compileTimeout: 60,
  502. compileGroup: 'priority',
  503. references: true,
  504. trackChanges: true,
  505. trackChangesVisible: true,
  506. }
  507. this.mongoUpdate({ $set: { features } }, callback)
  508. }
  509. downgradeFeatures(callback) {
  510. const features = {
  511. collaborators: 1,
  512. versioning: false,
  513. dropbox: false,
  514. compileTimeout: 60,
  515. compileGroup: 'standard',
  516. references: false,
  517. trackChanges: false,
  518. trackChangesVisible: false,
  519. }
  520. this.mongoUpdate({ $set: { features } }, callback)
  521. }
  522. defaultFeatures(callback) {
  523. const features = settings.defaultFeatures
  524. this.mongoUpdate({ $set: { features } }, callback)
  525. }
  526. getFeatures(callback) {
  527. db.users.findOne(
  528. { _id: new ObjectId(this.id) },
  529. { projection: { features: 1 } },
  530. (error, user) => callback(error, user && user.features)
  531. )
  532. }
  533. fullDeleteUser(email, callback) {
  534. db.users.findOne({ email }, (error, user) => {
  535. if (error != null) {
  536. return callback(error)
  537. }
  538. if (user == null) {
  539. return callback()
  540. }
  541. const userId = user._id
  542. db.projects.deleteMany({ owner_ref: new ObjectId(userId) }, err => {
  543. if (err != null) {
  544. callback(err)
  545. }
  546. db.users.deleteOne({ _id: new ObjectId(userId) }, callback)
  547. })
  548. })
  549. }
  550. deleteUser(callback) {
  551. this.getCsrfToken(error => {
  552. if (error) {
  553. return callback(error)
  554. }
  555. this.request.post(
  556. {
  557. url: '/user/delete',
  558. json: { password: this.password },
  559. },
  560. (err, response, body) => {
  561. if (err) {
  562. return callback(err)
  563. }
  564. if (response.statusCode !== 200) {
  565. return callback(
  566. new Error(
  567. `user deletion failed: status=${
  568. response.statusCode
  569. } body=${JSON.stringify(body)}`
  570. )
  571. )
  572. }
  573. callback()
  574. }
  575. )
  576. })
  577. }
  578. getProject(projectId, callback) {
  579. db.projects.findOne({ _id: new ObjectId(projectId.toString()) }, callback)
  580. }
  581. saveProject(project, callback) {
  582. db.projects.updateOne({ _id: project._id }, { $set: project }, callback)
  583. }
  584. createProject(name, options, callback) {
  585. if (typeof options === 'function') {
  586. callback = options
  587. options = {}
  588. }
  589. this.request.post(
  590. {
  591. url: '/project/new',
  592. json: Object.assign({ projectName: name }, options),
  593. },
  594. (error, response, body) => {
  595. if (error != null) {
  596. return callback(error)
  597. }
  598. if (response.statusCode !== 200) {
  599. return callback(
  600. new Error(
  601. `project creation failed: status=${
  602. response.statusCode
  603. } body=${JSON.stringify(body)}`
  604. )
  605. )
  606. }
  607. if ((body != null ? body.project_id : undefined) == null) {
  608. error = new Error(
  609. JSON.stringify([
  610. 'SOMETHING WENT WRONG CREATING PROJECT',
  611. name,
  612. options,
  613. response.statusCode,
  614. response.headers.location,
  615. body,
  616. ])
  617. )
  618. callback(error)
  619. } else {
  620. callback(null, body.project_id)
  621. }
  622. }
  623. )
  624. }
  625. deleteProject(projectId, callback) {
  626. this.request.delete(
  627. {
  628. url: `/project/${projectId}`,
  629. },
  630. (error, response, body) => {
  631. if (error != null) {
  632. return callback(error)
  633. }
  634. if (response.statusCode !== 200) {
  635. return callback(
  636. new Error(
  637. `project deletion failed: status=${
  638. response.statusCode
  639. } body=${JSON.stringify(body)}`
  640. )
  641. )
  642. }
  643. callback(null)
  644. }
  645. )
  646. }
  647. undeleteProject(projectId, callback) {
  648. this.request.post(
  649. {
  650. url: `/admin/project/${projectId}/undelete`,
  651. },
  652. (error, response, body) => {
  653. if (error) {
  654. return callback(error)
  655. }
  656. if (response.statusCode !== 204) {
  657. return callback(
  658. new Error(
  659. `project un-deletion failed: status=${
  660. response.statusCode
  661. } body=${JSON.stringify(body)}`
  662. )
  663. )
  664. }
  665. callback(null)
  666. }
  667. )
  668. }
  669. deleteProjects(callback) {
  670. db.projects.deleteMany({ owner_ref: new ObjectId(this.id) }, callback)
  671. }
  672. openProject(projectId, callback) {
  673. this.request.get(
  674. {
  675. url: `/project/${projectId}`,
  676. },
  677. (error, response, body) => {
  678. if (error != null) {
  679. return callback(error)
  680. }
  681. if (response.statusCode !== 200) {
  682. return callback(
  683. new Error(
  684. `opening project failed: status=${
  685. response.statusCode
  686. } body=${JSON.stringify(body)}`
  687. )
  688. )
  689. }
  690. callback(null)
  691. }
  692. )
  693. }
  694. createDocInProject(projectId, parentFolderId, name, callback) {
  695. this.getCsrfToken(error => {
  696. if (error != null) {
  697. return callback(error)
  698. }
  699. this.request.post(
  700. {
  701. url: `/project/${projectId}/doc`,
  702. json: {
  703. name,
  704. parentFolderId,
  705. },
  706. },
  707. (error, response, body) => {
  708. if (error != null) {
  709. return callback(error)
  710. }
  711. if (response.statusCode !== 200) {
  712. return callback(
  713. new Error(
  714. `doc creation in project failed: status=${
  715. response.statusCode
  716. } body=${JSON.stringify(body)}`
  717. )
  718. )
  719. }
  720. callback(null, body._id)
  721. }
  722. )
  723. })
  724. }
  725. uploadFileInProject(projectId, folderId, file, name, contentType, callback) {
  726. this.uploadFileInProjectFull(
  727. projectId,
  728. folderId,
  729. file,
  730. name,
  731. contentType,
  732. (err, body) => callback(err, body?.entity_id)
  733. )
  734. }
  735. uploadFileInProjectFull(
  736. projectId,
  737. folderId,
  738. file,
  739. name,
  740. contentType,
  741. callback
  742. ) {
  743. const fileStream = fs.createReadStream(
  744. Path.resolve(Path.join(__dirname, '..', '..', 'files', file))
  745. )
  746. this.request.post(
  747. {
  748. uri: `project/${projectId}/upload`,
  749. qs: {
  750. folder_id: String(folderId),
  751. },
  752. formData: {
  753. name,
  754. qqfile: {
  755. value: fileStream,
  756. options: {
  757. filename: name,
  758. contentType,
  759. },
  760. },
  761. },
  762. },
  763. (error, response, body) => {
  764. if (error) {
  765. return callback(error)
  766. }
  767. if (response.statusCode !== 200) {
  768. return callback(
  769. new Error(
  770. `uploading file failed: status=${
  771. response.statusCode
  772. } body=${JSON.stringify(body)}`
  773. )
  774. )
  775. }
  776. callback(null, JSON.parse(body))
  777. }
  778. )
  779. }
  780. uploadExampleFileInProject(projectId, folderId, name, callback) {
  781. this.uploadFileInProject(
  782. projectId,
  783. folderId,
  784. '1pixel.png',
  785. name,
  786. 'image/png',
  787. callback
  788. )
  789. }
  790. moveItemInProject(projectId, type, itemId, folderId, callback) {
  791. this.request.post(
  792. {
  793. uri: `project/${projectId}/${type}/${itemId}/move`,
  794. json: {
  795. folder_id: folderId,
  796. },
  797. },
  798. (error, response, body) => {
  799. if (error) {
  800. return callback(error)
  801. }
  802. if (response.statusCode !== 200) {
  803. return callback(
  804. new Error(
  805. `move item in project failed: type=${type} status=${
  806. response.statusCode
  807. } body=${JSON.stringify(body)}`
  808. )
  809. )
  810. }
  811. callback()
  812. }
  813. )
  814. }
  815. renameItemInProject(projectId, type, itemId, name, callback) {
  816. this.request.post(
  817. {
  818. uri: `project/${projectId}/${type}/${itemId}/rename`,
  819. json: {
  820. name,
  821. },
  822. },
  823. (error, response, body) => {
  824. if (error) {
  825. return callback(error)
  826. }
  827. if (response.statusCode !== 204) {
  828. return callback(
  829. new Error(
  830. `rename item in project failed: type=${type} status=${
  831. response.statusCode
  832. } body=${JSON.stringify(body)}`
  833. )
  834. )
  835. }
  836. callback()
  837. }
  838. )
  839. }
  840. deleteItemInProject(projectId, type, itemId, callback) {
  841. this.request.delete(
  842. `project/${projectId}/${type}/${itemId}`,
  843. (error, response, body) => {
  844. if (error) {
  845. return callback(error)
  846. }
  847. if (response.statusCode !== 204) {
  848. return callback(
  849. new Error(
  850. `delete item in project failed: type=${type} status=${
  851. response.statusCode
  852. } body=${JSON.stringify(body)}`
  853. )
  854. )
  855. }
  856. callback()
  857. }
  858. )
  859. }
  860. joinProject(projectId, callback) {
  861. this.request.post(
  862. {
  863. url: `/project/${projectId}/join`,
  864. auth: {
  865. user: settings.apis.web.user,
  866. pass: settings.apis.web.pass,
  867. sendImmediately: true,
  868. },
  869. json: { userId: this._id },
  870. jar: false,
  871. },
  872. (error, response, body) => {
  873. if (error) {
  874. return callback(error)
  875. }
  876. if (response.statusCode !== 200) {
  877. return callback(
  878. new Error(
  879. `join project failed: status=${
  880. response.statusCode
  881. } body=${JSON.stringify(body)}`
  882. )
  883. )
  884. }
  885. callback(null, body)
  886. }
  887. )
  888. }
  889. addUserToProject(projectId, user, privileges, callback) {
  890. let updateOp
  891. if (privileges === 'readAndWrite') {
  892. updateOp = { $addToSet: { collaberator_refs: user._id } }
  893. } else if (privileges === 'readOnly') {
  894. updateOp = { $addToSet: { readOnly_refs: user._id } }
  895. } else if (privileges === 'pendingEditor') {
  896. updateOp = {
  897. $addToSet: { readOnly_refs: user._id, pendingEditor_refs: user._id },
  898. }
  899. }
  900. db.projects.updateOne({ _id: new ObjectId(projectId) }, updateOp, callback)
  901. }
  902. makePublic(projectId, level, callback) {
  903. // A fudge, to get around the fact that `readOnly` and `readAndWrite` are now disallowed
  904. // via the API, but we still need to test the behaviour of projects with these values set.
  905. db.projects.updateOne(
  906. { _id: new ObjectId(projectId) },
  907. // NOTE: Yes, there is a typo in the db schema.
  908. { $set: { publicAccesLevel: level } },
  909. callback
  910. )
  911. }
  912. makePrivate(projectId, callback) {
  913. this.request.post(
  914. {
  915. url: `/project/${projectId}/settings/admin`,
  916. json: {
  917. publicAccessLevel: 'private',
  918. },
  919. },
  920. (error, response, body) => {
  921. if (error != null) {
  922. return callback(error)
  923. }
  924. if (response.statusCode !== 204) {
  925. return callback(
  926. new Error(
  927. `disable link sharing failed: status=${
  928. response.statusCode
  929. } body=${JSON.stringify(body)}`
  930. )
  931. )
  932. }
  933. callback(null)
  934. }
  935. )
  936. }
  937. makeTokenBased(projectId, callback) {
  938. this.request.post(
  939. {
  940. url: `/project/${projectId}/settings/admin`,
  941. json: {
  942. publicAccessLevel: 'tokenBased',
  943. },
  944. },
  945. (error, response, body) => {
  946. if (error != null) {
  947. return callback(error)
  948. }
  949. if (response.statusCode !== 204) {
  950. return callback(
  951. new Error(
  952. `enable link sharing failed: status=${
  953. response.statusCode
  954. } body=${JSON.stringify(body)}`
  955. )
  956. )
  957. }
  958. callback(null)
  959. }
  960. )
  961. }
  962. getCsrfToken(callback) {
  963. this.request.get(
  964. {
  965. url: '/dev/csrf',
  966. },
  967. (err, response, body) => {
  968. if (err != null) {
  969. return callback(err)
  970. }
  971. if (response.statusCode !== 200) {
  972. return callback(
  973. new Error(
  974. `get csrf token failed: status=${
  975. response.statusCode
  976. } body=${JSON.stringify(body)}`
  977. )
  978. )
  979. }
  980. this.csrfToken = body
  981. this.request = this.request.defaults({
  982. headers: {
  983. 'x-csrf-token': this.csrfToken,
  984. },
  985. })
  986. callback()
  987. }
  988. )
  989. }
  990. changePassword(newPassword, callback) {
  991. this.getCsrfToken(error => {
  992. if (error != null) {
  993. return callback(error)
  994. }
  995. this.request.post(
  996. {
  997. url: '/user/password/update',
  998. json: {
  999. currentPassword: this.password,
  1000. newPassword1: newPassword,
  1001. newPassword2: newPassword,
  1002. },
  1003. },
  1004. (err, response, body) => {
  1005. if (err) {
  1006. return callback(err)
  1007. }
  1008. if (response.statusCode !== 200) {
  1009. return callback(
  1010. new Error(
  1011. `change password failed: status=${
  1012. response.statusCode
  1013. } body=${JSON.stringify(body)}`
  1014. )
  1015. )
  1016. }
  1017. this.password = newPassword
  1018. callback()
  1019. }
  1020. )
  1021. })
  1022. }
  1023. reconfirmAccountRequest(userEmail, callback) {
  1024. this.getCsrfToken(error => {
  1025. if (error != null) {
  1026. return callback(error)
  1027. }
  1028. this.request.post(
  1029. {
  1030. url: '/user/reconfirm',
  1031. json: {
  1032. email: userEmail,
  1033. },
  1034. },
  1035. (error, response) => {
  1036. callback(error, response)
  1037. }
  1038. )
  1039. })
  1040. }
  1041. getUserSettingsPage(callback) {
  1042. this.getCsrfToken(error => {
  1043. if (error != null) {
  1044. return callback(error)
  1045. }
  1046. this.request.get(
  1047. {
  1048. url: '/user/settings',
  1049. },
  1050. (error, response, body) => {
  1051. if (error != null) {
  1052. return callback(error)
  1053. }
  1054. if (response.statusCode !== 200) {
  1055. return callback(
  1056. new Error(
  1057. `open settings page failed: status=${
  1058. response.statusCode
  1059. } body=${JSON.stringify(body)}`
  1060. )
  1061. )
  1062. }
  1063. callback(null, response.statusCode)
  1064. }
  1065. )
  1066. })
  1067. }
  1068. updateSettings(newSettings, callback) {
  1069. this.getCsrfToken(error => {
  1070. if (error != null) {
  1071. return callback(error)
  1072. }
  1073. this.request.post(
  1074. {
  1075. url: '/user/settings',
  1076. json: newSettings,
  1077. },
  1078. (err, response, body) => {
  1079. if (err) return callback(err)
  1080. if (response.statusCode !== 200) {
  1081. return callback(
  1082. new Error(
  1083. `update settings failed: status=${
  1084. response.statusCode
  1085. } body=${JSON.stringify(body)}`
  1086. )
  1087. )
  1088. }
  1089. callback()
  1090. }
  1091. )
  1092. })
  1093. }
  1094. getProjectListPage(callback) {
  1095. this.request.get('/project', (error, response) => {
  1096. if (error != null) {
  1097. return callback(error)
  1098. }
  1099. callback(null, response.statusCode)
  1100. })
  1101. }
  1102. isLoggedIn(callback) {
  1103. this.request.get('/user/personal_info', (error, response, body) => {
  1104. if (error != null) {
  1105. return callback(error)
  1106. }
  1107. if (response.statusCode === 200) {
  1108. callback(null, true)
  1109. } else if (response.statusCode === 302) {
  1110. callback(null, false)
  1111. } else {
  1112. callback(
  1113. new Error(
  1114. `unexpected status code from /user/personal_info: status=${response.statusCode} body=${body}`
  1115. )
  1116. )
  1117. }
  1118. })
  1119. }
  1120. transferProjectOwnership(projectId, userId, callback) {
  1121. this.getCsrfToken(err => {
  1122. if (err != null) {
  1123. return callback(err)
  1124. }
  1125. this.request.post(
  1126. {
  1127. url: `/project/${projectId.toString()}/transfer-ownership`,
  1128. json: {
  1129. user_id: userId.toString(),
  1130. },
  1131. },
  1132. (err, response, body) => {
  1133. if (err != null) {
  1134. return callback(err)
  1135. }
  1136. if (response.statusCode !== 204) {
  1137. return callback(
  1138. new Error(
  1139. `transfer project ownership failed: status=${
  1140. response.statusCode
  1141. } body=${JSON.stringify(body)}`
  1142. )
  1143. )
  1144. }
  1145. callback()
  1146. }
  1147. )
  1148. })
  1149. }
  1150. setV1Id(v1Id, callback) {
  1151. UserModel.updateOne(
  1152. {
  1153. _id: this._id,
  1154. },
  1155. {
  1156. overleaf: {
  1157. id: v1Id,
  1158. },
  1159. }
  1160. )
  1161. .then((...args) => callback(null, ...args))
  1162. .catch(callback)
  1163. }
  1164. setCollaboratorInfo(projectId, userId, info, callback) {
  1165. this.getCsrfToken(err => {
  1166. if (err != null) {
  1167. return callback(err)
  1168. }
  1169. this.request.put(
  1170. {
  1171. url: `/project/${projectId.toString()}/users/${userId.toString()}`,
  1172. json: info,
  1173. },
  1174. (err, response, body) => {
  1175. if (err != null) {
  1176. return callback(err)
  1177. }
  1178. if (response.statusCode !== 204) {
  1179. return callback(
  1180. new Error(
  1181. `update collaborator access failed: status=${
  1182. response.statusCode
  1183. } body=${JSON.stringify(body)}`
  1184. )
  1185. )
  1186. }
  1187. callback()
  1188. }
  1189. )
  1190. })
  1191. }
  1192. }
  1193. User.promises = promisifyClass(User, {
  1194. without: ['setExtraAttributes', 'sessionCookie', 'setSessionCookie'],
  1195. })
  1196. User.promises.prototype.doRequest = async function (method, params) {
  1197. return new Promise((resolve, reject) => {
  1198. this.request[method.toLowerCase()](params, (err, response, body) => {
  1199. if (err) {
  1200. reject(err)
  1201. } else {
  1202. resolve({ response, body })
  1203. }
  1204. })
  1205. })
  1206. }
  1207. module.exports = User