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