aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/models/user/user.ts
diff options
context:
space:
mode:
Diffstat (limited to 'server/models/user/user.ts')
-rw-r--r--server/models/user/user.ts967
1 files changed, 967 insertions, 0 deletions
diff --git a/server/models/user/user.ts b/server/models/user/user.ts
new file mode 100644
index 000000000..8d2564e54
--- /dev/null
+++ b/server/models/user/user.ts
@@ -0,0 +1,967 @@
1import { values } from 'lodash'
2import { col, FindOptions, fn, literal, Op, QueryTypes, where, WhereOptions } from 'sequelize'
3import {
4 AfterDestroy,
5 AfterUpdate,
6 AllowNull,
7 BeforeCreate,
8 BeforeUpdate,
9 Column,
10 CreatedAt,
11 DataType,
12 Default,
13 DefaultScope,
14 HasMany,
15 HasOne,
16 Is,
17 IsEmail,
18 IsUUID,
19 Model,
20 Scopes,
21 Table,
22 UpdatedAt
23} from 'sequelize-typescript'
24import { TokensCache } from '@server/lib/auth/tokens-cache'
25import {
26 MMyUserFormattable,
27 MUser,
28 MUserDefault,
29 MUserFormattable,
30 MUserNotifSettingChannelDefault,
31 MUserWithNotificationSetting,
32 MVideoWithRights
33} from '@server/types/models'
34import { hasUserRight, USER_ROLE_LABELS } from '../../../shared/core-utils/users'
35import { AbuseState, MyUser, UserRight, VideoPlaylistType, VideoPrivacy } from '../../../shared/models'
36import { User, UserRole } from '../../../shared/models/users'
37import { UserAdminFlag } from '../../../shared/models/users/user-flag.model'
38import { NSFWPolicyType } from '../../../shared/models/videos/nsfw-policy.type'
39import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
40import {
41 isNoInstanceConfigWarningModal,
42 isNoWelcomeModal,
43 isUserAdminFlagsValid,
44 isUserAutoPlayNextVideoPlaylistValid,
45 isUserAutoPlayNextVideoValid,
46 isUserAutoPlayVideoValid,
47 isUserBlockedReasonValid,
48 isUserBlockedValid,
49 isUserEmailVerifiedValid,
50 isUserNSFWPolicyValid,
51 isUserPasswordValid,
52 isUserRoleValid,
53 isUserUsernameValid,
54 isUserVideoLanguages,
55 isUserVideoQuotaDailyValid,
56 isUserVideoQuotaValid,
57 isUserVideosHistoryEnabledValid,
58 isUserWebTorrentEnabledValid
59} from '../../helpers/custom-validators/users'
60import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto'
61import { DEFAULT_USER_THEME_NAME, NSFW_POLICY_TYPES } from '../../initializers/constants'
62import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
63import { AccountModel } from '../account/account'
64import { ActorModel } from '../actor/actor'
65import { ActorFollowModel } from '../actor/actor-follow'
66import { ActorImageModel } from '../actor/actor-image'
67import { OAuthTokenModel } from '../oauth/oauth-token'
68import { getSort, throwIfNotValid } from '../utils'
69import { VideoModel } from '../video/video'
70import { VideoChannelModel } from '../video/video-channel'
71import { VideoImportModel } from '../video/video-import'
72import { VideoLiveModel } from '../video/video-live'
73import { VideoPlaylistModel } from '../video/video-playlist'
74import { UserNotificationSettingModel } from './user-notification-setting'
75
76enum ScopeNames {
77 FOR_ME_API = 'FOR_ME_API',
78 WITH_VIDEOCHANNELS = 'WITH_VIDEOCHANNELS',
79 WITH_STATS = 'WITH_STATS'
80}
81
82@DefaultScope(() => ({
83 include: [
84 {
85 model: AccountModel,
86 required: true
87 },
88 {
89 model: UserNotificationSettingModel,
90 required: true
91 }
92 ]
93}))
94@Scopes(() => ({
95 [ScopeNames.FOR_ME_API]: {
96 include: [
97 {
98 model: AccountModel,
99 include: [
100 {
101 model: VideoChannelModel.unscoped(),
102 include: [
103 {
104 model: ActorModel,
105 required: true,
106 include: [
107 {
108 model: ActorImageModel,
109 as: 'Banner',
110 required: false
111 }
112 ]
113 }
114 ]
115 },
116 {
117 attributes: [ 'id', 'name', 'type' ],
118 model: VideoPlaylistModel.unscoped(),
119 required: true,
120 where: {
121 type: {
122 [Op.ne]: VideoPlaylistType.REGULAR
123 }
124 }
125 }
126 ]
127 },
128 {
129 model: UserNotificationSettingModel,
130 required: true
131 }
132 ]
133 },
134 [ScopeNames.WITH_VIDEOCHANNELS]: {
135 include: [
136 {
137 model: AccountModel,
138 include: [
139 {
140 model: VideoChannelModel
141 },
142 {
143 attributes: [ 'id', 'name', 'type' ],
144 model: VideoPlaylistModel.unscoped(),
145 required: true,
146 where: {
147 type: {
148 [Op.ne]: VideoPlaylistType.REGULAR
149 }
150 }
151 }
152 ]
153 }
154 ]
155 },
156 [ScopeNames.WITH_STATS]: {
157 attributes: {
158 include: [
159 [
160 literal(
161 '(' +
162 UserModel.generateUserQuotaBaseSQL({
163 withSelect: false,
164 whereUserId: '"UserModel"."id"'
165 }) +
166 ')'
167 ),
168 'videoQuotaUsed'
169 ],
170 [
171 literal(
172 '(' +
173 'SELECT COUNT("video"."id") ' +
174 'FROM "video" ' +
175 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
176 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
177 'WHERE "account"."userId" = "UserModel"."id"' +
178 ')'
179 ),
180 'videosCount'
181 ],
182 [
183 literal(
184 '(' +
185 `SELECT concat_ws(':', "abuses", "acceptedAbuses") ` +
186 'FROM (' +
187 'SELECT COUNT("abuse"."id") AS "abuses", ' +
188 `COUNT("abuse"."id") FILTER (WHERE "abuse"."state" = ${AbuseState.ACCEPTED}) AS "acceptedAbuses" ` +
189 'FROM "abuse" ' +
190 'INNER JOIN "account" ON "account"."id" = "abuse"."flaggedAccountId" ' +
191 'WHERE "account"."userId" = "UserModel"."id"' +
192 ') t' +
193 ')'
194 ),
195 'abusesCount'
196 ],
197 [
198 literal(
199 '(' +
200 'SELECT COUNT("abuse"."id") ' +
201 'FROM "abuse" ' +
202 'INNER JOIN "account" ON "account"."id" = "abuse"."reporterAccountId" ' +
203 'WHERE "account"."userId" = "UserModel"."id"' +
204 ')'
205 ),
206 'abusesCreatedCount'
207 ],
208 [
209 literal(
210 '(' +
211 'SELECT COUNT("videoComment"."id") ' +
212 'FROM "videoComment" ' +
213 'INNER JOIN "account" ON "account"."id" = "videoComment"."accountId" ' +
214 'WHERE "account"."userId" = "UserModel"."id"' +
215 ')'
216 ),
217 'videoCommentsCount'
218 ]
219 ]
220 }
221 }
222}))
223@Table({
224 tableName: 'user',
225 indexes: [
226 {
227 fields: [ 'username' ],
228 unique: true
229 },
230 {
231 fields: [ 'email' ],
232 unique: true
233 }
234 ]
235})
236export class UserModel extends Model {
237
238 @AllowNull(true)
239 @Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password', true))
240 @Column
241 password: string
242
243 @AllowNull(false)
244 @Is('UserUsername', value => throwIfNotValid(value, isUserUsernameValid, 'user name'))
245 @Column
246 username: string
247
248 @AllowNull(false)
249 @IsEmail
250 @Column(DataType.STRING(400))
251 email: string
252
253 @AllowNull(true)
254 @IsEmail
255 @Column(DataType.STRING(400))
256 pendingEmail: string
257
258 @AllowNull(true)
259 @Default(null)
260 @Is('UserEmailVerified', value => throwIfNotValid(value, isUserEmailVerifiedValid, 'email verified boolean', true))
261 @Column
262 emailVerified: boolean
263
264 @AllowNull(false)
265 @Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
266 @Column(DataType.ENUM(...values(NSFW_POLICY_TYPES)))
267 nsfwPolicy: NSFWPolicyType
268
269 @AllowNull(false)
270 @Default(true)
271 @Is('UserWebTorrentEnabled', value => throwIfNotValid(value, isUserWebTorrentEnabledValid, 'WebTorrent enabled'))
272 @Column
273 webTorrentEnabled: boolean
274
275 @AllowNull(false)
276 @Default(true)
277 @Is('UserVideosHistoryEnabled', value => throwIfNotValid(value, isUserVideosHistoryEnabledValid, 'Videos history enabled'))
278 @Column
279 videosHistoryEnabled: boolean
280
281 @AllowNull(false)
282 @Default(true)
283 @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
284 @Column
285 autoPlayVideo: boolean
286
287 @AllowNull(false)
288 @Default(false)
289 @Is('UserAutoPlayNextVideo', value => throwIfNotValid(value, isUserAutoPlayNextVideoValid, 'auto play next video boolean'))
290 @Column
291 autoPlayNextVideo: boolean
292
293 @AllowNull(false)
294 @Default(true)
295 @Is(
296 'UserAutoPlayNextVideoPlaylist',
297 value => throwIfNotValid(value, isUserAutoPlayNextVideoPlaylistValid, 'auto play next video for playlists boolean')
298 )
299 @Column
300 autoPlayNextVideoPlaylist: boolean
301
302 @AllowNull(true)
303 @Default(null)
304 @Is('UserVideoLanguages', value => throwIfNotValid(value, isUserVideoLanguages, 'video languages'))
305 @Column(DataType.ARRAY(DataType.STRING))
306 videoLanguages: string[]
307
308 @AllowNull(false)
309 @Default(UserAdminFlag.NONE)
310 @Is('UserAdminFlags', value => throwIfNotValid(value, isUserAdminFlagsValid, 'user admin flags'))
311 @Column
312 adminFlags?: UserAdminFlag
313
314 @AllowNull(false)
315 @Default(false)
316 @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
317 @Column
318 blocked: boolean
319
320 @AllowNull(true)
321 @Default(null)
322 @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason', true))
323 @Column
324 blockedReason: string
325
326 @AllowNull(false)
327 @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
328 @Column
329 role: number
330
331 @AllowNull(false)
332 @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota'))
333 @Column(DataType.BIGINT)
334 videoQuota: number
335
336 @AllowNull(false)
337 @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
338 @Column(DataType.BIGINT)
339 videoQuotaDaily: number
340
341 @AllowNull(false)
342 @Default(DEFAULT_USER_THEME_NAME)
343 @Is('UserTheme', value => throwIfNotValid(value, isThemeNameValid, 'theme'))
344 @Column
345 theme: string
346
347 @AllowNull(false)
348 @Default(false)
349 @Is(
350 'UserNoInstanceConfigWarningModal',
351 value => throwIfNotValid(value, isNoInstanceConfigWarningModal, 'no instance config warning modal')
352 )
353 @Column
354 noInstanceConfigWarningModal: boolean
355
356 @AllowNull(false)
357 @Default(false)
358 @Is(
359 'UserNoInstanceConfigWarningModal',
360 value => throwIfNotValid(value, isNoWelcomeModal, 'no welcome modal')
361 )
362 @Column
363 noWelcomeModal: boolean
364
365 @AllowNull(true)
366 @Default(null)
367 @Column
368 pluginAuth: string
369
370 @AllowNull(false)
371 @Default(DataType.UUIDV4)
372 @IsUUID(4)
373 @Column(DataType.UUID)
374 feedToken: string
375
376 @AllowNull(true)
377 @Default(null)
378 @Column
379 lastLoginDate: Date
380
381 @CreatedAt
382 createdAt: Date
383
384 @UpdatedAt
385 updatedAt: Date
386
387 @HasOne(() => AccountModel, {
388 foreignKey: 'userId',
389 onDelete: 'cascade',
390 hooks: true
391 })
392 Account: AccountModel
393
394 @HasOne(() => UserNotificationSettingModel, {
395 foreignKey: 'userId',
396 onDelete: 'cascade',
397 hooks: true
398 })
399 NotificationSetting: UserNotificationSettingModel
400
401 @HasMany(() => VideoImportModel, {
402 foreignKey: 'userId',
403 onDelete: 'cascade'
404 })
405 VideoImports: VideoImportModel[]
406
407 @HasMany(() => OAuthTokenModel, {
408 foreignKey: 'userId',
409 onDelete: 'cascade'
410 })
411 OAuthTokens: OAuthTokenModel[]
412
413 @BeforeCreate
414 @BeforeUpdate
415 static cryptPasswordIfNeeded (instance: UserModel) {
416 if (instance.changed('password') && instance.password) {
417 return cryptPassword(instance.password)
418 .then(hash => {
419 instance.password = hash
420 return undefined
421 })
422 }
423 }
424
425 @AfterUpdate
426 @AfterDestroy
427 static removeTokenCache (instance: UserModel) {
428 return TokensCache.Instance.clearCacheByUserId(instance.id)
429 }
430
431 static countTotal () {
432 return this.count()
433 }
434
435 static listForApi (parameters: {
436 start: number
437 count: number
438 sort: string
439 search?: string
440 blocked?: boolean
441 }) {
442 const { start, count, sort, search, blocked } = parameters
443 const where: WhereOptions = {}
444
445 if (search) {
446 Object.assign(where, {
447 [Op.or]: [
448 {
449 email: {
450 [Op.iLike]: '%' + search + '%'
451 }
452 },
453 {
454 username: {
455 [Op.iLike]: '%' + search + '%'
456 }
457 }
458 ]
459 })
460 }
461
462 if (blocked !== undefined) {
463 Object.assign(where, {
464 blocked: blocked
465 })
466 }
467
468 const query: FindOptions = {
469 attributes: {
470 include: [
471 [
472 literal(
473 '(' +
474 UserModel.generateUserQuotaBaseSQL({
475 withSelect: false,
476 whereUserId: '"UserModel"."id"'
477 }) +
478 ')'
479 ),
480 'videoQuotaUsed'
481 ] as any // FIXME: typings
482 ]
483 },
484 offset: start,
485 limit: count,
486 order: getSort(sort),
487 where
488 }
489
490 return UserModel.findAndCountAll(query)
491 .then(({ rows, count }) => {
492 return {
493 data: rows,
494 total: count
495 }
496 })
497 }
498
499 static listWithRight (right: UserRight): Promise<MUserDefault[]> {
500 const roles = Object.keys(USER_ROLE_LABELS)
501 .map(k => parseInt(k, 10) as UserRole)
502 .filter(role => hasUserRight(role, right))
503
504 const query = {
505 where: {
506 role: {
507 [Op.in]: roles
508 }
509 }
510 }
511
512 return UserModel.findAll(query)
513 }
514
515 static listUserSubscribersOf (actorId: number): Promise<MUserWithNotificationSetting[]> {
516 const query = {
517 include: [
518 {
519 model: UserNotificationSettingModel.unscoped(),
520 required: true
521 },
522 {
523 attributes: [ 'userId' ],
524 model: AccountModel.unscoped(),
525 required: true,
526 include: [
527 {
528 attributes: [],
529 model: ActorModel.unscoped(),
530 required: true,
531 where: {
532 serverId: null
533 },
534 include: [
535 {
536 attributes: [],
537 as: 'ActorFollowings',
538 model: ActorFollowModel.unscoped(),
539 required: true,
540 where: {
541 targetActorId: actorId
542 }
543 }
544 ]
545 }
546 ]
547 }
548 ]
549 }
550
551 return UserModel.unscoped().findAll(query)
552 }
553
554 static listByUsernames (usernames: string[]): Promise<MUserDefault[]> {
555 const query = {
556 where: {
557 username: usernames
558 }
559 }
560
561 return UserModel.findAll(query)
562 }
563
564 static loadById (id: number): Promise<MUser> {
565 return UserModel.unscoped().findByPk(id)
566 }
567
568 static loadByIdFull (id: number): Promise<MUserDefault> {
569 return UserModel.findByPk(id)
570 }
571
572 static loadByIdWithChannels (id: number, withStats = false): Promise<MUserDefault> {
573 const scopes = [
574 ScopeNames.WITH_VIDEOCHANNELS
575 ]
576
577 if (withStats) scopes.push(ScopeNames.WITH_STATS)
578
579 return UserModel.scope(scopes).findByPk(id)
580 }
581
582 static loadByUsername (username: string): Promise<MUserDefault> {
583 const query = {
584 where: {
585 username
586 }
587 }
588
589 return UserModel.findOne(query)
590 }
591
592 static loadForMeAPI (id: number): Promise<MUserNotifSettingChannelDefault> {
593 const query = {
594 where: {
595 id
596 }
597 }
598
599 return UserModel.scope(ScopeNames.FOR_ME_API).findOne(query)
600 }
601
602 static loadByEmail (email: string): Promise<MUserDefault> {
603 const query = {
604 where: {
605 email
606 }
607 }
608
609 return UserModel.findOne(query)
610 }
611
612 static loadByUsernameOrEmail (username: string, email?: string): Promise<MUserDefault> {
613 if (!email) email = username
614
615 const query = {
616 where: {
617 [Op.or]: [
618 where(fn('lower', col('username')), fn('lower', username)),
619
620 { email }
621 ]
622 }
623 }
624
625 return UserModel.findOne(query)
626 }
627
628 static loadByVideoId (videoId: number): Promise<MUserDefault> {
629 const query = {
630 include: [
631 {
632 required: true,
633 attributes: [ 'id' ],
634 model: AccountModel.unscoped(),
635 include: [
636 {
637 required: true,
638 attributes: [ 'id' ],
639 model: VideoChannelModel.unscoped(),
640 include: [
641 {
642 required: true,
643 attributes: [ 'id' ],
644 model: VideoModel.unscoped(),
645 where: {
646 id: videoId
647 }
648 }
649 ]
650 }
651 ]
652 }
653 ]
654 }
655
656 return UserModel.findOne(query)
657 }
658
659 static loadByVideoImportId (videoImportId: number): Promise<MUserDefault> {
660 const query = {
661 include: [
662 {
663 required: true,
664 attributes: [ 'id' ],
665 model: VideoImportModel.unscoped(),
666 where: {
667 id: videoImportId
668 }
669 }
670 ]
671 }
672
673 return UserModel.findOne(query)
674 }
675
676 static loadByChannelActorId (videoChannelActorId: number): Promise<MUserDefault> {
677 const query = {
678 include: [
679 {
680 required: true,
681 attributes: [ 'id' ],
682 model: AccountModel.unscoped(),
683 include: [
684 {
685 required: true,
686 attributes: [ 'id' ],
687 model: VideoChannelModel.unscoped(),
688 where: {
689 actorId: videoChannelActorId
690 }
691 }
692 ]
693 }
694 ]
695 }
696
697 return UserModel.findOne(query)
698 }
699
700 static loadByAccountActorId (accountActorId: number): Promise<MUserDefault> {
701 const query = {
702 include: [
703 {
704 required: true,
705 attributes: [ 'id' ],
706 model: AccountModel.unscoped(),
707 where: {
708 actorId: accountActorId
709 }
710 }
711 ]
712 }
713
714 return UserModel.findOne(query)
715 }
716
717 static loadByLiveId (liveId: number): Promise<MUser> {
718 const query = {
719 include: [
720 {
721 attributes: [ 'id' ],
722 model: AccountModel.unscoped(),
723 required: true,
724 include: [
725 {
726 attributes: [ 'id' ],
727 model: VideoChannelModel.unscoped(),
728 required: true,
729 include: [
730 {
731 attributes: [ 'id' ],
732 model: VideoModel.unscoped(),
733 required: true,
734 include: [
735 {
736 attributes: [],
737 model: VideoLiveModel.unscoped(),
738 required: true,
739 where: {
740 id: liveId
741 }
742 }
743 ]
744 }
745 ]
746 }
747 ]
748 }
749 ]
750 }
751
752 return UserModel.unscoped().findOne(query)
753 }
754
755 static generateUserQuotaBaseSQL (options: {
756 whereUserId: '$userId' | '"UserModel"."id"'
757 withSelect: boolean
758 where?: string
759 }) {
760 const andWhere = options.where
761 ? 'AND ' + options.where
762 : ''
763
764 const videoChannelJoin = 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
765 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
766 `WHERE "account"."userId" = ${options.whereUserId} ${andWhere}`
767
768 const webtorrentFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
769 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
770 videoChannelJoin
771
772 const hlsFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
773 'INNER JOIN "videoStreamingPlaylist" ON "videoFile"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id ' +
774 'INNER JOIN "video" ON "videoStreamingPlaylist"."videoId" = "video"."id" ' +
775 videoChannelJoin
776
777 return 'SELECT COALESCE(SUM("size"), 0) AS "total" ' +
778 'FROM (' +
779 `SELECT MAX("t1"."size") AS "size" FROM (${webtorrentFiles} UNION ${hlsFiles}) t1 ` +
780 'GROUP BY "t1"."videoId"' +
781 ') t2'
782 }
783
784 static getTotalRawQuery (query: string, userId: number) {
785 const options = {
786 bind: { userId },
787 type: QueryTypes.SELECT as QueryTypes.SELECT
788 }
789
790 return UserModel.sequelize.query<{ total: string }>(query, options)
791 .then(([ { total } ]) => {
792 if (total === null) return 0
793
794 return parseInt(total, 10)
795 })
796 }
797
798 static async getStats () {
799 function getActiveUsers (days: number) {
800 const query = {
801 where: {
802 [Op.and]: [
803 literal(`"lastLoginDate" > NOW() - INTERVAL '${days}d'`)
804 ]
805 }
806 }
807
808 return UserModel.count(query)
809 }
810
811 const totalUsers = await UserModel.count()
812 const totalDailyActiveUsers = await getActiveUsers(1)
813 const totalWeeklyActiveUsers = await getActiveUsers(7)
814 const totalMonthlyActiveUsers = await getActiveUsers(30)
815 const totalHalfYearActiveUsers = await getActiveUsers(180)
816
817 return {
818 totalUsers,
819 totalDailyActiveUsers,
820 totalWeeklyActiveUsers,
821 totalMonthlyActiveUsers,
822 totalHalfYearActiveUsers
823 }
824 }
825
826 static autoComplete (search: string) {
827 const query = {
828 where: {
829 username: {
830 [Op.like]: `%${search}%`
831 }
832 },
833 limit: 10
834 }
835
836 return UserModel.findAll(query)
837 .then(u => u.map(u => u.username))
838 }
839
840 canGetVideo (video: MVideoWithRights) {
841 const videoUserId = video.VideoChannel.Account.userId
842
843 if (video.isBlacklisted()) {
844 return videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST)
845 }
846
847 if (video.privacy === VideoPrivacy.PRIVATE) {
848 return video.VideoChannel && videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST)
849 }
850
851 if (video.privacy === VideoPrivacy.INTERNAL) return true
852
853 return false
854 }
855
856 hasRight (right: UserRight) {
857 return hasUserRight(this.role, right)
858 }
859
860 hasAdminFlag (flag: UserAdminFlag) {
861 return this.adminFlags & flag
862 }
863
864 isPasswordMatch (password: string) {
865 return comparePassword(password, this.password)
866 }
867
868 toFormattedJSON (this: MUserFormattable, parameters: { withAdminFlags?: boolean } = {}): User {
869 const videoQuotaUsed = this.get('videoQuotaUsed')
870 const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
871 const videosCount = this.get('videosCount')
872 const [ abusesCount, abusesAcceptedCount ] = (this.get('abusesCount') as string || ':').split(':')
873 const abusesCreatedCount = this.get('abusesCreatedCount')
874 const videoCommentsCount = this.get('videoCommentsCount')
875
876 const json: User = {
877 id: this.id,
878 username: this.username,
879 email: this.email,
880 theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME),
881
882 pendingEmail: this.pendingEmail,
883 emailVerified: this.emailVerified,
884
885 nsfwPolicy: this.nsfwPolicy,
886 webTorrentEnabled: this.webTorrentEnabled,
887 videosHistoryEnabled: this.videosHistoryEnabled,
888 autoPlayVideo: this.autoPlayVideo,
889 autoPlayNextVideo: this.autoPlayNextVideo,
890 autoPlayNextVideoPlaylist: this.autoPlayNextVideoPlaylist,
891 videoLanguages: this.videoLanguages,
892
893 role: this.role,
894 roleLabel: USER_ROLE_LABELS[this.role],
895
896 videoQuota: this.videoQuota,
897 videoQuotaDaily: this.videoQuotaDaily,
898 videoQuotaUsed: videoQuotaUsed !== undefined
899 ? parseInt(videoQuotaUsed + '', 10)
900 : undefined,
901 videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined
902 ? parseInt(videoQuotaUsedDaily + '', 10)
903 : undefined,
904 videosCount: videosCount !== undefined
905 ? parseInt(videosCount + '', 10)
906 : undefined,
907 abusesCount: abusesCount
908 ? parseInt(abusesCount, 10)
909 : undefined,
910 abusesAcceptedCount: abusesAcceptedCount
911 ? parseInt(abusesAcceptedCount, 10)
912 : undefined,
913 abusesCreatedCount: abusesCreatedCount !== undefined
914 ? parseInt(abusesCreatedCount + '', 10)
915 : undefined,
916 videoCommentsCount: videoCommentsCount !== undefined
917 ? parseInt(videoCommentsCount + '', 10)
918 : undefined,
919
920 noInstanceConfigWarningModal: this.noInstanceConfigWarningModal,
921 noWelcomeModal: this.noWelcomeModal,
922
923 blocked: this.blocked,
924 blockedReason: this.blockedReason,
925
926 account: this.Account.toFormattedJSON(),
927
928 notificationSettings: this.NotificationSetting
929 ? this.NotificationSetting.toFormattedJSON()
930 : undefined,
931
932 videoChannels: [],
933
934 createdAt: this.createdAt,
935
936 pluginAuth: this.pluginAuth,
937
938 lastLoginDate: this.lastLoginDate
939 }
940
941 if (parameters.withAdminFlags) {
942 Object.assign(json, { adminFlags: this.adminFlags })
943 }
944
945 if (Array.isArray(this.Account.VideoChannels) === true) {
946 json.videoChannels = this.Account.VideoChannels
947 .map(c => c.toFormattedJSON())
948 .sort((v1, v2) => {
949 if (v1.createdAt < v2.createdAt) return -1
950 if (v1.createdAt === v2.createdAt) return 0
951
952 return 1
953 })
954 }
955
956 return json
957 }
958
959 toMeFormattedJSON (this: MMyUserFormattable): MyUser {
960 const formatted = this.toFormattedJSON()
961
962 const specialPlaylists = this.Account.VideoPlaylists
963 .map(p => ({ id: p.id, name: p.name, type: p.type }))
964
965 return Object.assign(formatted, { specialPlaylists })
966 }
967}
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-03 13:15:50 +0000