/
user.js
751 lines (631 loc) · 20.3 KB
/
user.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
/*
* . .o8 oooo
* .o8 "888 `888
* .o888oo oooo d8b oooo oooo .oooo888 .ooooo. .oooo.o 888 oooo
* 888 `888""8P `888 `888 d88' `888 d88' `88b d88( "8 888 .8P'
* 888 888 888 888 888 888 888ooo888 `"Y88b. 888888.
* 888 . 888 888 888 888 888 888 .o o. )88b 888 `88b.
* "888" d888b `V88V"V8P' `Y8bod88P" `Y8bod8P' 8""888P' o888o o888o
* ========================================================================
* Author: Chris Brame
* Updated: 1/20/19 4:43 PM
* Copyright (c) 2014-2019. All rights reserved.
*/
var async = require('async')
var mongoose = require('mongoose')
var winston = require('winston')
var bcrypt = require('bcrypt')
var _ = require('lodash')
var Chance = require('chance')
const utils = require('../helpers/utils')
// Required for linkage
require('./role')
var SALT_FACTOR = 10
var COLLECTION = 'accounts'
/**
* User Schema
* @module models/user
* @class User
*
* @property {object} _id ```Required``` ```unique``` MongoDB Object ID
* @property {String} username ```Required``` ```unique``` Username of user
* @property {String} password ```Required``` Bcrypt password
* @property {String} fullname ```Required``` Full name of user
* @property {String} email ```Required``` ```unique``` Email Address of user
* @property {String} role ```Required``` Permission role of the given user. See {@link Permissions}
* @property {Date} lastOnline Last timestamp given user was online.
* @property {String} title Job Title of user
* @property {String} image Filename of user image
* @property {String} resetPassHash Password reset has for recovery password link.
* @property {Date} resetPassExpire Date when the password recovery link will expire
* @property {String} tOTPKey One Time Password Secret Key
* @property {Number} tOTPPeriod One Time Password Key Length (Time) - Default 30 Seconds
* @property {String} accessToken API Access Token
* @property {Array} iOSDeviceTokens Array of String based device Ids for Apple iOS devices. *push notifications*
* @property {Object} preferences Object to hold user preferences
* @property {Boolean} preferences.autoRefreshTicketGrid Enable the auto refresh of the ticket grid.
* @property {Boolean} deleted Account Deleted
*/
var userSchema = mongoose.Schema({
username: { type: String, required: true, unique: true, lowercase: true },
password: { type: String, required: true, select: false },
fullname: { type: String, required: true, index: true },
email: { type: String, required: true, unique: true, lowercase: true },
role: { type: mongoose.Schema.Types.ObjectId, ref: 'roles', required: true },
lastOnline: Date,
title: String,
image: String,
resetPassHash: { type: String, select: false },
resetPassExpire: { type: Date, select: false },
tOTPKey: { type: String, select: false },
tOTPPeriod: { type: Number, select: false },
resetL2AuthHash: { type: String, select: false },
resetL2AuthExpire: { type: Date, select: false },
hasL2Auth: { type: Boolean, required: true, default: false },
accessToken: { type: String, sparse: true, select: false },
preferences: {
tourCompleted: { type: Boolean, default: false },
autoRefreshTicketGrid: { type: Boolean, default: true },
openChatWindows: [{ type: String, default: [] }]
},
deleted: { type: Boolean, default: false }
})
userSchema.set('toObject', { getters: true })
var autoPopulateRole = function (next) {
this.populate('role', 'name description normalized _id')
next()
}
userSchema.pre('findOne', autoPopulateRole).pre('find', autoPopulateRole)
userSchema.pre('save', function (next) {
var user = this
user.username = utils.applyMaxShortTextLength(utils.sanitizeFieldPlainText(user.username.toLowerCase().trim()))
user.email = utils.sanitizeFieldPlainText(user.email.trim())
if (user.fullname) user.fullname = utils.applyMaxShortTextLength(utils.sanitizeFieldPlainText(user.fullname.trim()))
if (user.title) user.title = utils.applyMaxShortTextLength(utils.sanitizeFieldPlainText(user.title.trim()))
if (!user.isModified('password')) {
return next()
}
bcrypt.genSalt(SALT_FACTOR, function (err, salt) {
if (err) return next(err)
bcrypt.hash(user.password, salt, function (err, hash) {
if (err) return next(err)
user.password = hash
return next()
})
})
})
userSchema.methods.addAccessToken = function (callback) {
var user = this
var date = new Date()
var salt = user.username.toString() + date.toISOString()
var chance = new Chance(salt)
user.accessToken = chance.hash()
user.save(function (err) {
if (err) return callback(err, null)
return callback(null, user.accessToken)
})
}
userSchema.methods.removeAccessToken = function (callback) {
var user = this
if (!user.accessToken) return callback()
user.accessToken = undefined
user.save(function (err) {
if (err) return callback(err, null)
return callback()
})
}
userSchema.methods.generateL2Auth = function (callback) {
var user = this
if (_.isUndefined(user.tOTPKey) || _.isNull(user.tOTPKey)) {
var chance = new Chance()
var base32 = require('thirty-two')
var genOTPKey = chance.string({
length: 7,
pool: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ23456789'
})
var base32GenOTPKey = base32
.encode(genOTPKey)
.toString()
.replace(/=/g, '')
user.tOTPKey = base32GenOTPKey
user.hasL2Auth = true
user.save(function (err) {
if (err) return callback(err)
return callback(null, base32GenOTPKey)
})
} else {
return callback()
}
}
userSchema.methods.removeL2Auth = function (callback) {
var user = this
user.tOTPKey = undefined
user.hasL2Auth = false
user.save(function (err) {
if (err) return callback(err, null)
return callback()
})
}
userSchema.methods.addDeviceToken = function (token, type, callback) {
if (_.isUndefined(token)) return callback('Invalid token')
var user = this
// type 1 = iOS
// type 2 = Android
if (type === 1) {
if (hasDeviceToken(user, token, type)) return callback(null, token)
user.iOSDeviceTokens.push(token)
user.save(function (err) {
if (err) return callback(err, null)
callback(null, token)
})
}
}
userSchema.methods.removeDeviceToken = function (token, type, callback) {
var user = this
if (type === 1) {
if (!hasDeviceToken(user, token, type)) return callback()
winston.debug('Removing Device: ' + token)
user.iOSDeviceTokens.splice(_.indexOf(this.iOSDeviceTokens, token), 1)
user.save(function (err, u) {
if (err) return callback(err, null)
return callback(null, u.iOSDeviceTokens)
})
}
}
userSchema.methods.addOpenChatWindow = function (convoId, callback) {
if (convoId === undefined) {
if (!_.isFunction(callback)) return false
return callback('Invalid convoId')
}
var user = this
var hasChatWindow =
_.filter(user.preferences.openChatWindows, function (value) {
return value.toString() === convoId.toString()
}).length > 0
if (hasChatWindow) {
if (!_.isFunction(callback)) return false
return callback()
}
user.preferences.openChatWindows.push(convoId.toString())
user.save(function (err, u) {
if (err) {
if (!_.isFunction(callback)) return false
return callback(err)
}
if (!_.isFunction(callback)) return false
return callback(null, u.preferences.openChatWindows)
})
}
userSchema.methods.removeOpenChatWindow = function (convoId, callback) {
if (convoId === undefined) {
if (!_.isFunction(callback)) return false
return callback('Invalid convoId')
}
var user = this
var hasChatWindow =
_.filter(user.preferences.openChatWindows, function (value) {
return value.toString() === convoId.toString()
}).length > 0
if (!hasChatWindow) {
if (!_.isFunction(callback)) return false
return callback()
}
user.preferences.openChatWindows.splice(
_.findIndex(user.preferences.openChatWindows, function (item) {
return item.toString() === convoId.toString()
}),
1
)
user.save(function (err, u) {
if (err) {
if (!_.isFunction(callback)) return false
return callback(err)
}
if (!_.isFunction(callback)) return false
return callback(null, u.preferences.openChatWindows)
})
}
userSchema.methods.softDelete = function (callback) {
var user = this
user.deleted = true
user.save(function (err) {
if (err) return callback(err, false)
callback(null, true)
})
}
userSchema.statics.validate = function (password, dbPass) {
return bcrypt.compareSync(password, dbPass)
}
/**
* Gets all users
*
* @memberof User
* @static
* @method findAll
*
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.findAll = function (callback) {
return this.model(COLLECTION).find({}, callback)
}
/**
* Gets user via object _id
*
* @memberof User
* @static
* @method getUser
*
* @param {Object} oId Object _id to Query MongoDB
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.getUser = function (oId, callback) {
if (_.isUndefined(oId)) {
return callback('Invalid ObjectId - UserSchema.GetUser()', null)
}
return this.model(COLLECTION).findOne({ _id: oId }, callback)
}
/**
* Gets user via username
*
* @memberof User
* @static
* @method getUserByUsername
*
* @param {String} user Username to Query MongoDB
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.getUserByUsername = function (user, callback) {
if (_.isUndefined(user)) {
return callback('Invalid Username - UserSchema.GetUserByUsername()', null)
}
return this.model(COLLECTION)
.findOne({ username: new RegExp('^' + user + '$', 'i') })
.select('+password +accessToken')
.exec(callback)
}
userSchema.statics.getByUsername = userSchema.statics.getUserByUsername
/**
* Gets user via email
*
* @memberof User
* @static
* @method getUserByEmail
*
* @param {String} email Email to Query MongoDB
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.getUserByEmail = function (email, callback) {
if (_.isUndefined(email)) {
return callback('Invalid Email - UserSchema.GetUserByEmail()', null)
}
return this.model(COLLECTION).findOne({ email: email.toLowerCase() }, callback)
}
/**
* Gets user via reset password hash
*
* @memberof User
* @static
* @method getUserByResetHash
*
* @param {String} hash Hash to Query MongoDB
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.getUserByResetHash = function (hash, callback) {
if (_.isUndefined(hash)) {
return callback('Invalid Hash - UserSchema.GetUserByResetHash()', null)
}
return this.model(COLLECTION).findOne(
{ resetPassHash: hash, deleted: false },
'+resetPassHash +resetPassExpire',
callback
)
}
userSchema.statics.getUserByL2ResetHash = function (hash, callback) {
if (_.isUndefined(hash)) {
return callback('Invalid Hash - UserSchema.GetUserByL2ResetHash()', null)
}
return this.model(COLLECTION).findOne(
{ resetL2AuthHash: hash, deleted: false },
'+resetL2AuthHash +resetL2AuthExpire',
callback
)
}
/**
* Gets user via API Access Token
*
* @memberof User
* @static
* @method getUserByAccessToken
*
* @param {String} token Access Token to Query MongoDB
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.getUserByAccessToken = function (token, callback) {
if (_.isUndefined(token)) {
return callback('Invalid Token - UserSchema.GetUserByAccessToken()', null)
}
return this.model(COLLECTION).findOne({ accessToken: token, deleted: false }, '+password', callback)
}
userSchema.statics.getUserWithObject = function (object, callback) {
if (!_.isObject(object)) {
return callback('Invalid Object (Must be of type Object) - UserSchema.GetUserWithObject()', null)
}
var self = this
var limit = object.limit === null ? 10 : object.limit
var page = object.page === null ? 0 : object.page
var search = object.search === null ? '' : object.search
var q = self
.model(COLLECTION)
.find({}, '-password -resetPassHash -resetPassExpire')
.sort({ fullname: 1 })
.skip(page * limit)
if (limit !== -1) {
q.limit(limit)
}
if (!object.showDeleted) q.where({ deleted: false })
if (!_.isEmpty(search)) {
q.where({ fullname: new RegExp('^' + search.toLowerCase(), 'i') })
}
return q.exec(callback)
}
/**
* Gets users based on permissions > mod
*
* @memberof User
* @static
* @method getAssigneeUsers
*
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.getAssigneeUsers = function (callback) {
var roles = global.roles
if (_.isUndefined(roles)) return callback(null, [])
var assigneeRoles = []
async.each(roles, function (role) {
if (role.isAgent) assigneeRoles.push(role._id)
})
assigneeRoles = _.uniq(assigneeRoles)
this.model(COLLECTION).find({ role: { $in: assigneeRoles }, deleted: false }, function (err, users) {
if (err) {
winston.warn(err)
return callback(err, null)
}
return callback(null, _.sortBy(users, 'fullname'))
})
}
/**
* Gets users based on roles
*
* @memberof User
* @static
* @method getUsersByRoles
*
* @param {Array} roles Array of role ids
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.getUsersByRoles = function (roles, callback) {
if (_.isUndefined(roles)) return callback('Invalid roles array', null)
if (!_.isArray(roles)) {
roles = [roles]
}
var q = this.model(COLLECTION).find({ role: { $in: roles }, deleted: false })
return q.exec(callback)
}
/**
* Creates a user with the given data object
*
* @memberof User
* @static
* @method createUser
*
* @param {User} data JSON data object of new User
* @param {QueryCallback} callback MongoDB Query Callback
*/
userSchema.statics.createUser = function (data, callback) {
if (_.isUndefined(data) || _.isUndefined(data.username)) {
return callback('Invalid User Data - UserSchema.CreateUser()', null)
}
var self = this
self.model(COLLECTION).find({ username: data.username }, function (err, items) {
if (err) {
return callback(err, null)
}
if (_.size(items) > 0) {
return callback('Username Already Exists', null)
}
return self.collection.insert(data, callback)
})
}
/**
* Creates a user with only Email address. Emails user password.
*
* @param email
* @param callback
*/
userSchema.statics.createUserFromEmail = function (email, callback) {
if (_.isUndefined(email)) {
return callback('Invalid User Data - UserSchema.CreatePublicUser()', null)
}
var self = this
var settingSchema = require('./setting')
settingSchema.getSetting('role:user:default', function (err, userRoleDefault) {
if (err || !userRoleDefault) return callback('Invalid Setting - UserRoleDefault')
var Chance = require('chance')
var chance = new Chance()
var plainTextPass = chance.string({
length: 6,
pool: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890'
})
var user = new self({
username: email,
email: email,
password: plainTextPass,
fullname: email,
role: userRoleDefault.value
})
self.model(COLLECTION).find({ username: user.username }, function (err, items) {
if (err) return callback(err)
if (_.size(items) > 0) return callback('Username already exists')
user.save(function (err, savedUser) {
if (err) return callback(err)
// Create a group for this user
var GroupSchema = require('./group')
var group = new GroupSchema({
name: savedUser.email,
members: [savedUser._id],
sendMailTo: [savedUser._id],
public: true
})
group.save(function (err, group) {
if (err) return callback(err)
// Send welcome email
var path = require('path')
var mailer = require('../mailer')
var Email = require('email-templates')
var templateDir = path.resolve(__dirname, '..', 'mailer', 'templates')
var email = new Email({
views: {
root: templateDir,
options: {
extension: 'handlebars'
}
}
})
var settingSchema = require('./setting')
settingSchema.getSetting('gen:siteurl', function (err, setting) {
if (err) return callback(err)
if (!setting) {
setting = { value: '' }
}
var dataObject = {
user: savedUser,
plainTextPassword: plainTextPass,
baseUrl: setting.value
}
email
.render('public-account-created', dataObject)
.then(function (html) {
var mailOptions = {
to: savedUser.email,
subject: 'Welcome to trudesk! - Here are your account details.',
html: html,
generateTextFromHTML: true
}
mailer.sendMail(mailOptions, function (err) {
if (err) {
winston.warn(err)
return callback(err)
}
return callback(null, { user: savedUser, group: group })
})
})
.catch(function (err) {
winston.warn(err)
return callback(err)
})
})
})
})
})
})
}
userSchema.statics.getCustomers = function (obj, callback) {
var limit = obj.limit || 10
var page = obj.page || 0
var self = this
return self
.model(COLLECTION)
.find({}, '-password -resetPassHash -resetPassExpire')
.exec(function (err, accounts) {
if (err) return callback(err)
var customerRoleIds = _.filter(accounts, function (a) {
return !a.role.isAdmin && !a.role.isAgent
}).map(function (a) {
return a.role._id
})
var q = self
.find({ role: { $in: customerRoleIds } }, '-password -resetPassHash -resetPassExpire')
.sort({ fullname: 1 })
.skip(page * limit)
.limit(limit)
if (!obj.showDeleted) q.where({ deleted: false })
q.exec(callback)
})
}
userSchema.statics.getAgents = function (obj, callback) {
var limit = obj.limit || 10
var page = obj.page || 0
var self = this
return self
.model(COLLECTION)
.find({})
.exec(function (err, accounts) {
if (err) return callback(err)
var agentRoleIds = _.filter(accounts, function (a) {
return a.role.isAgent
}).map(function (a) {
return a.role._id
})
var q = self
.model(COLLECTION)
.find({ role: { $in: agentRoleIds } }, '-password -resetPassHash -resetPassExpire')
.sort({ fullname: 1 })
.skip(page * limit)
.limit(limit)
if (!obj.showDeleted) q.where({ deleted: false })
q.exec(callback)
})
}
userSchema.statics.getAdmins = function (obj, callback) {
var limit = obj.limit || 10
var page = obj.page || 0
var self = this
return self
.model(COLLECTION)
.find({})
.exec(function (err, accounts) {
if (err) return callback(err)
var adminRoleIds = _.filter(accounts, function (a) {
return a.role.isAdmin
}).map(function (a) {
return a.role._id
})
var q = self
.model(COLLECTION)
.find({ role: { $in: adminRoleIds } }, '-password -resetPassHash -resetPassExpire')
.sort({ fullname: 1 })
.skip(page * limit)
.limit(limit)
if (!obj.showDeleted) q.where({ deleted: false })
q.exec(callback)
})
}
/**
* Checks if a user has device token already
*
* @memberof User
* @instance
* @method hasDeviceToken
*
* @param {User} user User to check against
* @param {String} token token to check for in given user
* @param {Number} type Type of Device token to check.
* @return {Boolean}
* @example
* type:
* 1: iOS
* 2: Android
* 3: Windows
*/
function hasDeviceToken (user, token, type) {
if (type === 1) {
var matches = _.filter(user.iOSDeviceTokens, function (value) {
if (value === token) {
return value
}
})
return matches.length > 0
}
return false
}
module.exports = mongoose.model(COLLECTION, userSchema)