User.js 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. const Settings = require('@overleaf/settings')
  2. const mongoose = require('../infrastructure/Mongoose')
  3. const TokenGenerator = require('../Features/TokenGenerator/TokenGenerator')
  4. const { Schema } = mongoose
  5. const { ObjectId } = Schema
  6. // See https://stackoverflow.com/questions/386294/what-is-the-maximum-length-of-a-valid-email-address/574698#574698
  7. const MAX_EMAIL_LENGTH = 254
  8. const UserSchema = new Schema(
  9. {
  10. email: { type: String, default: '', maxlength: MAX_EMAIL_LENGTH },
  11. emails: [
  12. {
  13. email: { type: String, default: '', maxlength: MAX_EMAIL_LENGTH },
  14. reversedHostname: { type: String, default: '' },
  15. createdAt: {
  16. type: Date,
  17. default() {
  18. return new Date()
  19. },
  20. },
  21. confirmedAt: { type: Date },
  22. samlProviderId: { type: String },
  23. affiliationUnchecked: { type: Boolean },
  24. reconfirmedAt: { type: Date },
  25. },
  26. ],
  27. first_name: { type: String, default: '' },
  28. last_name: { type: String, default: '' },
  29. role: { type: String, default: '' },
  30. institution: { type: String, default: '' },
  31. hashedPassword: String,
  32. enrollment: {
  33. // sso: { type: Boolean, default: false },
  34. managedBy: {
  35. type: ObjectId,
  36. ref: 'Subscription',
  37. },
  38. enrolledAt: { type: Date },
  39. },
  40. isAdmin: { type: Boolean, default: false },
  41. staffAccess: {
  42. publisherMetrics: { type: Boolean, default: false },
  43. publisherManagement: { type: Boolean, default: false },
  44. institutionMetrics: { type: Boolean, default: false },
  45. institutionManagement: { type: Boolean, default: false },
  46. groupMetrics: { type: Boolean, default: false },
  47. groupManagement: { type: Boolean, default: false },
  48. adminMetrics: { type: Boolean, default: false },
  49. splitTestMetrics: { type: Boolean, default: false },
  50. splitTestManagement: { type: Boolean, default: false },
  51. },
  52. signUpDate: {
  53. type: Date,
  54. default() {
  55. return new Date()
  56. },
  57. },
  58. loginEpoch: { type: Number },
  59. lastActive: { type: Date },
  60. lastFailedLogin: { type: Date },
  61. lastLoggedIn: { type: Date },
  62. lastLoginIp: { type: String, default: '' },
  63. lastPrimaryEmailCheck: { type: Date },
  64. loginCount: { type: Number, default: 0 },
  65. holdingAccount: { type: Boolean, default: false },
  66. ace: {
  67. mode: { type: String, default: 'none' },
  68. theme: { type: String, default: 'textmate' },
  69. overallTheme: { type: String, default: '' },
  70. fontSize: { type: Number, default: '12' },
  71. autoComplete: { type: Boolean, default: true },
  72. autoPairDelimiters: { type: Boolean, default: true },
  73. spellCheckLanguage: { type: String, default: 'en' },
  74. pdfViewer: { type: String, default: 'pdfjs' },
  75. syntaxValidation: { type: Boolean },
  76. fontFamily: { type: String },
  77. lineHeight: { type: String },
  78. },
  79. features: {
  80. collaborators: {
  81. type: Number,
  82. default: Settings.defaultFeatures.collaborators,
  83. },
  84. versioning: {
  85. type: Boolean,
  86. default: Settings.defaultFeatures.versioning,
  87. },
  88. dropbox: { type: Boolean, default: Settings.defaultFeatures.dropbox },
  89. github: { type: Boolean, default: Settings.defaultFeatures.github },
  90. gitBridge: { type: Boolean, default: Settings.defaultFeatures.gitBridge },
  91. compileTimeout: {
  92. type: Number,
  93. default: Settings.defaultFeatures.compileTimeout,
  94. },
  95. compileGroup: {
  96. type: String,
  97. default: Settings.defaultFeatures.compileGroup,
  98. },
  99. templates: { type: Boolean, default: Settings.defaultFeatures.templates },
  100. references: {
  101. type: Boolean,
  102. default: Settings.defaultFeatures.references,
  103. },
  104. trackChanges: {
  105. type: Boolean,
  106. default: Settings.defaultFeatures.trackChanges,
  107. },
  108. mendeley: { type: Boolean, default: Settings.defaultFeatures.mendeley },
  109. zotero: { type: Boolean, default: Settings.defaultFeatures.zotero },
  110. referencesSearch: {
  111. type: Boolean,
  112. default: Settings.defaultFeatures.referencesSearch,
  113. },
  114. symbolPalette: {
  115. type: Boolean,
  116. default: Settings.defaultFeatures.symbolPalette,
  117. },
  118. },
  119. featuresOverrides: [
  120. {
  121. createdAt: {
  122. type: Date,
  123. default() {
  124. return new Date()
  125. },
  126. },
  127. expiresAt: { type: Date },
  128. note: { type: String },
  129. features: {
  130. collaborators: { type: Number },
  131. versioning: { type: Boolean },
  132. dropbox: { type: Boolean },
  133. github: { type: Boolean },
  134. gitBridge: { type: Boolean },
  135. compileTimeout: { type: Number },
  136. compileGroup: { type: String },
  137. templates: { type: Boolean },
  138. trackChanges: { type: Boolean },
  139. mendeley: { type: Boolean },
  140. zotero: { type: Boolean },
  141. referencesSearch: { type: Boolean },
  142. symbolPalette: { type: Boolean },
  143. },
  144. },
  145. ],
  146. featuresUpdatedAt: { type: Date },
  147. featuresEpoch: {
  148. type: String,
  149. },
  150. // when auto-merged from SL and must-reconfirm is set, we may end up using
  151. // `sharelatexHashedPassword` to recover accounts...
  152. sharelatexHashedPassword: String,
  153. must_reconfirm: { type: Boolean, default: false },
  154. referal_id: {
  155. type: String,
  156. default() {
  157. return TokenGenerator.generateReferralId()
  158. },
  159. },
  160. refered_users: [{ type: ObjectId, ref: 'User' }],
  161. refered_user_count: { type: Number, default: 0 },
  162. refProviders: {
  163. // The actual values are managed by third-party-references.
  164. mendeley: Schema.Types.Mixed,
  165. zotero: Schema.Types.Mixed,
  166. },
  167. alphaProgram: { type: Boolean, default: false }, // experimental features
  168. betaProgram: { type: Boolean, default: false },
  169. labsProgram: { type: Boolean, default: false },
  170. labsProgramGalileo: { type: Boolean, default: false },
  171. overleaf: {
  172. id: { type: Number },
  173. accessToken: { type: String },
  174. refreshToken: { type: String },
  175. },
  176. awareOfV2: { type: Boolean, default: false },
  177. samlIdentifiers: { type: Array, default: [] },
  178. thirdPartyIdentifiers: { type: Array, default: [] },
  179. migratedAt: { type: Date },
  180. twoFactorAuthentication: {
  181. createdAt: { type: Date },
  182. enrolledAt: { type: Date },
  183. secretEncrypted: { type: String },
  184. },
  185. onboardingEmailSentAt: { type: Date },
  186. splitTests: Schema.Types.Mixed,
  187. analyticsId: { type: String },
  188. surveyResponses: Schema.Types.Mixed,
  189. },
  190. { minimize: false }
  191. )
  192. function formatSplitTestsSchema(next) {
  193. if (this.splitTests) {
  194. for (const splitTestKey of Object.keys(this.splitTests)) {
  195. for (const variantIndex in this.splitTests[splitTestKey]) {
  196. this.splitTests[splitTestKey][variantIndex].assignedAt = new Date(
  197. this.splitTests[splitTestKey][variantIndex].assignedAt
  198. )
  199. }
  200. }
  201. }
  202. next()
  203. }
  204. UserSchema.pre('save', formatSplitTestsSchema)
  205. exports.User = mongoose.model('User', UserSchema)
  206. exports.UserSchema = UserSchema