UserController.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491
  1. const UserHandler = require('./UserHandler')
  2. const UserDeleter = require('./UserDeleter')
  3. const UserGetter = require('./UserGetter')
  4. const { User } = require('../../models/User')
  5. const NewsletterManager = require('../Newsletter/NewsletterManager')
  6. const UserRegistrationHandler = require('./UserRegistrationHandler')
  7. const logger = require('logger-sharelatex')
  8. const metrics = require('metrics-sharelatex')
  9. const AuthenticationManager = require('../Authentication/AuthenticationManager')
  10. const AuthenticationController = require('../Authentication/AuthenticationController')
  11. const Features = require('../../infrastructure/Features')
  12. const UserAuditLogHandler = require('./UserAuditLogHandler')
  13. const UserSessionsManager = require('./UserSessionsManager')
  14. const UserUpdater = require('./UserUpdater')
  15. const Errors = require('../Errors/Errors')
  16. const HttpErrorHandler = require('../Errors/HttpErrorHandler')
  17. const OError = require('@overleaf/o-error')
  18. const EmailHandler = require('../Email/EmailHandler')
  19. const UrlHelper = require('../Helpers/UrlHelper')
  20. const { promisify } = require('util')
  21. const { expressify } = require('../../util/promises')
  22. async function _sendSecurityAlertClearedSessions(user) {
  23. const emailOptions = {
  24. to: user.email,
  25. actionDescribed: `active sessions were cleared on your account ${
  26. user.email
  27. }`,
  28. action: 'active sessions cleared'
  29. }
  30. try {
  31. await EmailHandler.promises.sendEmail('securityAlert', emailOptions)
  32. } catch (error) {
  33. // log error when sending security alert email but do not pass back
  34. logger.error(
  35. { error, userId: user._id },
  36. 'could not send security alert email when sessions cleared'
  37. )
  38. }
  39. }
  40. function _sendSecurityAlertPasswordChanged(user) {
  41. const emailOptions = {
  42. to: user.email,
  43. actionDescribed: `your password has been changed on your account ${
  44. user.email
  45. }`,
  46. action: 'password changed'
  47. }
  48. EmailHandler.sendEmail('securityAlert', emailOptions, error => {
  49. if (error) {
  50. // log error when sending security alert email but do not pass back
  51. logger.error(
  52. { error, userId: user._id },
  53. 'could not send security alert email when password changed'
  54. )
  55. }
  56. })
  57. }
  58. async function _ensureAffiliation(userId, emailData) {
  59. if (emailData.samlProviderId) {
  60. await UserUpdater.promises.confirmEmail(userId, emailData.email)
  61. } else {
  62. await UserUpdater.promises.addAffiliationForNewUser(userId, emailData.email)
  63. }
  64. }
  65. async function changePassword(req, res, next) {
  66. metrics.inc('user.password-change')
  67. const userId = AuthenticationController.getLoggedInUserId(req)
  68. const user = await AuthenticationManager.promises.authenticate(
  69. { _id: userId },
  70. req.body.currentPassword
  71. )
  72. if (!user) {
  73. return HttpErrorHandler.badRequest(req, res, 'Your old password is wrong')
  74. }
  75. if (req.body.newPassword1 !== req.body.newPassword2) {
  76. return HttpErrorHandler.badRequest(
  77. req,
  78. res,
  79. req.i18n.translate('password_change_passwords_do_not_match')
  80. )
  81. }
  82. try {
  83. await AuthenticationManager.promises.setUserPassword(
  84. user,
  85. req.body.newPassword1
  86. )
  87. } catch (error) {
  88. if (error.name === 'InvalidPasswordError') {
  89. return HttpErrorHandler.badRequest(req, res, error.message)
  90. } else {
  91. throw error
  92. }
  93. }
  94. await UserAuditLogHandler.promises.addEntry(
  95. user._id,
  96. 'update-password',
  97. user._id,
  98. req.ip
  99. )
  100. // no need to wait, errors are logged and not passed back
  101. _sendSecurityAlertPasswordChanged(user)
  102. await UserSessionsManager.promises.revokeAllUserSessions(user, [
  103. req.sessionID
  104. ])
  105. return res.json({
  106. message: {
  107. type: 'success',
  108. email: user.email,
  109. text: req.i18n.translate('password_change_successful')
  110. }
  111. })
  112. }
  113. async function clearSessions(req, res, next) {
  114. metrics.inc('user.clear-sessions')
  115. const userId = AuthenticationController.getLoggedInUserId(req)
  116. const user = await UserGetter.promises.getUser(userId, { email: 1 })
  117. const sessions = await UserSessionsManager.promises.getAllUserSessions(user, [
  118. req.sessionID
  119. ])
  120. await UserAuditLogHandler.promises.addEntry(
  121. user._id,
  122. 'clear-sessions',
  123. user._id,
  124. req.ip,
  125. { sessions }
  126. )
  127. await UserSessionsManager.promises.revokeAllUserSessions(user, [
  128. req.sessionID
  129. ])
  130. await _sendSecurityAlertClearedSessions(user)
  131. res.sendStatus(201)
  132. }
  133. async function ensureAffiliation(user) {
  134. if (!Features.hasFeature('affiliations')) {
  135. return
  136. }
  137. const flaggedEmails = user.emails.filter(email => email.affiliationUnchecked)
  138. if (flaggedEmails.length === 0) {
  139. return
  140. }
  141. if (flaggedEmails.length > 1) {
  142. logger.error(
  143. { userId: user._id },
  144. `Unexpected number of flagged emails: ${flaggedEmails.length}`
  145. )
  146. }
  147. await _ensureAffiliation(user._id, flaggedEmails[0])
  148. }
  149. async function ensureAffiliationMiddleware(req, res, next) {
  150. let user
  151. if (!Features.hasFeature('affiliations') || !req.query.ensureAffiliation) {
  152. return next()
  153. }
  154. const userId = AuthenticationController.getLoggedInUserId(req)
  155. try {
  156. user = await UserGetter.promises.getUser(userId)
  157. } catch (error) {
  158. return new Errors.UserNotFoundError({ info: { userId } })
  159. }
  160. try {
  161. await ensureAffiliation(user)
  162. } catch (error) {
  163. return next(error)
  164. }
  165. return next()
  166. }
  167. const UserController = {
  168. clearSessions: expressify(clearSessions),
  169. tryDeleteUser(req, res, next) {
  170. const userId = AuthenticationController.getLoggedInUserId(req)
  171. const { password } = req.body
  172. if (password == null || password === '') {
  173. logger.err(
  174. { userId },
  175. 'no password supplied for attempt to delete account'
  176. )
  177. return res.sendStatus(403)
  178. }
  179. AuthenticationManager.authenticate(
  180. { _id: userId },
  181. password,
  182. (err, user) => {
  183. if (err != null) {
  184. OError.tag(
  185. err,
  186. 'error authenticating during attempt to delete account',
  187. {
  188. userId
  189. }
  190. )
  191. return next(err)
  192. }
  193. if (!user) {
  194. logger.err({ userId }, 'auth failed during attempt to delete account')
  195. return res.sendStatus(403)
  196. }
  197. UserDeleter.deleteUser(
  198. userId,
  199. { deleterUser: user, ipAddress: req.ip },
  200. err => {
  201. if (err) {
  202. let errorData = {
  203. message: 'error while deleting user account',
  204. info: { userId }
  205. }
  206. if (err instanceof Errors.SubscriptionAdminDeletionError) {
  207. // set info.public.error for JSON response so frontend can display
  208. // a specific message
  209. errorData.info.public = {
  210. error: 'SubscriptionAdminDeletionError'
  211. }
  212. logger.warn(OError.tag(err, errorData.message, errorData.info))
  213. return HttpErrorHandler.unprocessableEntity(
  214. req,
  215. res,
  216. errorData.message,
  217. errorData.info.public
  218. )
  219. } else {
  220. return next(OError.tag(err, errorData.message, errorData.info))
  221. }
  222. }
  223. const sessionId = req.sessionID
  224. if (typeof req.logout === 'function') {
  225. req.logout()
  226. }
  227. req.session.destroy(err => {
  228. if (err != null) {
  229. OError.tag(err, 'error destroying session')
  230. return next(err)
  231. }
  232. UserSessionsManager.untrackSession(user, sessionId)
  233. res.sendStatus(200)
  234. })
  235. }
  236. )
  237. }
  238. )
  239. },
  240. unsubscribe(req, res, next) {
  241. const userId = AuthenticationController.getLoggedInUserId(req)
  242. UserGetter.getUser(userId, (err, user) => {
  243. if (err != null) {
  244. return next(err)
  245. }
  246. NewsletterManager.unsubscribe(user, err => {
  247. if (err != null) {
  248. logger.warn(
  249. { err, user },
  250. 'Failed to unsubscribe user from newsletter'
  251. )
  252. }
  253. res.sendStatus(200)
  254. })
  255. })
  256. },
  257. updateUserSettings(req, res, next) {
  258. const userId = AuthenticationController.getLoggedInUserId(req)
  259. User.findById(userId, (err, user) => {
  260. if (err != null || user == null) {
  261. logger.err({ err, userId }, 'problem updaing user settings')
  262. return res.sendStatus(500)
  263. }
  264. if (req.body.first_name != null) {
  265. user.first_name = req.body.first_name.trim()
  266. }
  267. if (req.body.last_name != null) {
  268. user.last_name = req.body.last_name.trim()
  269. }
  270. if (req.body.role != null) {
  271. user.role = req.body.role.trim()
  272. }
  273. if (req.body.institution != null) {
  274. user.institution = req.body.institution.trim()
  275. }
  276. if (req.body.mode != null) {
  277. user.ace.mode = req.body.mode
  278. }
  279. if (req.body.editorTheme != null) {
  280. user.ace.theme = req.body.editorTheme
  281. }
  282. if (req.body.overallTheme != null) {
  283. user.ace.overallTheme = req.body.overallTheme
  284. }
  285. if (req.body.fontSize != null) {
  286. user.ace.fontSize = req.body.fontSize
  287. }
  288. if (req.body.autoComplete != null) {
  289. user.ace.autoComplete = req.body.autoComplete
  290. }
  291. if (req.body.autoPairDelimiters != null) {
  292. user.ace.autoPairDelimiters = req.body.autoPairDelimiters
  293. }
  294. if (req.body.spellCheckLanguage != null) {
  295. user.ace.spellCheckLanguage = req.body.spellCheckLanguage
  296. }
  297. if (req.body.pdfViewer != null) {
  298. user.ace.pdfViewer = req.body.pdfViewer
  299. }
  300. if (req.body.syntaxValidation != null) {
  301. user.ace.syntaxValidation = req.body.syntaxValidation
  302. }
  303. if (req.body.fontFamily != null) {
  304. user.ace.fontFamily = req.body.fontFamily
  305. }
  306. if (req.body.lineHeight != null) {
  307. user.ace.lineHeight = req.body.lineHeight
  308. }
  309. user.save(err => {
  310. if (err != null) {
  311. return next(err)
  312. }
  313. const newEmail =
  314. req.body.email != null
  315. ? req.body.email.trim().toLowerCase()
  316. : undefined
  317. if (
  318. newEmail == null ||
  319. newEmail === user.email ||
  320. req.externalAuthenticationSystemUsed()
  321. ) {
  322. // end here, don't update email
  323. AuthenticationController.setInSessionUser(req, {
  324. first_name: user.first_name,
  325. last_name: user.last_name
  326. })
  327. res.sendStatus(200)
  328. } else if (newEmail.indexOf('@') === -1) {
  329. // email invalid
  330. res.sendStatus(400)
  331. } else {
  332. // update the user email
  333. const auditLog = {
  334. initiatorId: userId,
  335. ipAddress: req.ip
  336. }
  337. UserUpdater.changeEmailAddress(userId, newEmail, auditLog, err => {
  338. if (err) {
  339. if (err instanceof Errors.EmailExistsError) {
  340. const translation = req.i18n.translate(
  341. 'email_already_registered'
  342. )
  343. return HttpErrorHandler.conflict(req, res, translation)
  344. } else {
  345. return HttpErrorHandler.legacyInternal(
  346. req,
  347. res,
  348. req.i18n.translate('problem_changing_email_address'),
  349. OError.tag(err, 'problem_changing_email_address', {
  350. userId,
  351. newEmail
  352. })
  353. )
  354. }
  355. }
  356. User.findById(userId, (err, user) => {
  357. if (err != null) {
  358. logger.err(
  359. { err, userId },
  360. 'error getting user for email update'
  361. )
  362. return res.sendStatus(500)
  363. }
  364. AuthenticationController.setInSessionUser(req, {
  365. email: user.email,
  366. first_name: user.first_name,
  367. last_name: user.last_name
  368. })
  369. UserHandler.populateTeamInvites(user, err => {
  370. // need to refresh this in the background
  371. if (err != null) {
  372. logger.err({ err }, 'error populateTeamInvites')
  373. }
  374. res.sendStatus(200)
  375. })
  376. })
  377. })
  378. }
  379. })
  380. })
  381. },
  382. doLogout(req, cb) {
  383. metrics.inc('user.logout')
  384. const user = AuthenticationController.getSessionUser(req)
  385. logger.log({ user }, 'logging out')
  386. const sessionId = req.sessionID
  387. if (typeof req.logout === 'function') {
  388. req.logout()
  389. } // passport logout
  390. req.session.destroy(err => {
  391. if (err) {
  392. OError.tag(err, 'error destroying session')
  393. return cb(err)
  394. }
  395. if (user != null) {
  396. UserSessionsManager.untrackSession(user, sessionId)
  397. }
  398. cb()
  399. })
  400. },
  401. logout(req, res, next) {
  402. const requestedRedirect = req.body.redirect
  403. ? UrlHelper.getSafeRedirectPath(req.body.redirect)
  404. : undefined
  405. const redirectUrl = requestedRedirect || '/login'
  406. UserController.doLogout(req, err => {
  407. if (err != null) {
  408. return next(err)
  409. }
  410. res.redirect(redirectUrl)
  411. })
  412. },
  413. expireDeletedUser(req, res, next) {
  414. const userId = req.params.userId
  415. UserDeleter.expireDeletedUser(userId, error => {
  416. if (error) {
  417. return next(error)
  418. }
  419. res.sendStatus(204)
  420. })
  421. },
  422. expireDeletedUsersAfterDuration(req, res, next) {
  423. UserDeleter.expireDeletedUsersAfterDuration(error => {
  424. if (error) {
  425. return next(error)
  426. }
  427. res.sendStatus(204)
  428. })
  429. },
  430. register(req, res, next) {
  431. const { email } = req.body
  432. if (email == null || email === '') {
  433. return res.sendStatus(422) // Unprocessable Entity
  434. }
  435. UserRegistrationHandler.registerNewUserAndSendActivationEmail(
  436. email,
  437. (error, user, setNewPasswordUrl) => {
  438. if (error != null) {
  439. return next(error)
  440. }
  441. res.json({
  442. email: user.email,
  443. setNewPasswordUrl
  444. })
  445. }
  446. )
  447. },
  448. changePassword: expressify(changePassword)
  449. }
  450. UserController.promises = {
  451. doLogout: promisify(UserController.doLogout),
  452. ensureAffiliation,
  453. ensureAffiliationMiddleware
  454. }
  455. module.exports = UserController