]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/models/user/user.ts
Add missing player translation
[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'
6b5f72be 34import { AttributesOnly } from '@shared/typescript-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,
9d8ef212 51 isUserP2PEnabledValid,
a73c582e
C
52 isUserPasswordValid,
53 isUserRoleValid,
54 isUserUsernameValid,
3caf77d3 55 isUserVideoLanguages,
5cf84858 56 isUserVideoQuotaDailyValid,
64cc5e85 57 isUserVideoQuotaValid,
9d8ef212 58 isUserVideosHistoryEnabledValid
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,
d0800f76 109 as: 'Banners',
cdeddff1
C
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)
a9bfa85d 270 @Is('p2pEnabled', value => throwIfNotValid(value, isUserP2PEnabledValid, 'P2P enabled'))
ed638e53 271 @Column
a9bfa85d 272 p2pEnabled: boolean
64cc5e85 273
8b9a525a
C
274 @AllowNull(false)
275 @Default(true)
276 @Is('UserVideosHistoryEnabled', value => throwIfNotValid(value, isUserVideosHistoryEnabledValid, 'Videos history enabled'))
277 @Column
278 videosHistoryEnabled: boolean
279
7efe153b
AL
280 @AllowNull(false)
281 @Default(true)
282 @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
283 @Column
284 autoPlayVideo: boolean
285
6aa54148
L
286 @AllowNull(false)
287 @Default(false)
288 @Is('UserAutoPlayNextVideo', value => throwIfNotValid(value, isUserAutoPlayNextVideoValid, 'auto play next video boolean'))
289 @Column
290 autoPlayNextVideo: boolean
291
bee29df8
RK
292 @AllowNull(false)
293 @Default(true)
a1587156
C
294 @Is(
295 'UserAutoPlayNextVideoPlaylist',
296 value => throwIfNotValid(value, isUserAutoPlayNextVideoPlaylistValid, 'auto play next video for playlists boolean')
297 )
bee29df8
RK
298 @Column
299 autoPlayNextVideoPlaylist: boolean
300
3caf77d3
C
301 @AllowNull(true)
302 @Default(null)
303 @Is('UserVideoLanguages', value => throwIfNotValid(value, isUserVideoLanguages, 'video languages'))
304 @Column(DataType.ARRAY(DataType.STRING))
305 videoLanguages: string[]
306
1eddc9a7
C
307 @AllowNull(false)
308 @Default(UserAdminFlag.NONE)
309 @Is('UserAdminFlags', value => throwIfNotValid(value, isUserAdminFlagsValid, 'user admin flags'))
310 @Column
311 adminFlags?: UserAdminFlag
312
e6921918
C
313 @AllowNull(false)
314 @Default(false)
315 @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
316 @Column
317 blocked: boolean
318
eacb25c4
C
319 @AllowNull(true)
320 @Default(null)
1735c825 321 @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason', true))
eacb25c4
C
322 @Column
323 blockedReason: string
324
3fd3ab2d
C
325 @AllowNull(false)
326 @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
327 @Column
328 role: number
329
330 @AllowNull(false)
331 @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota'))
332 @Column(DataType.BIGINT)
333 videoQuota: number
334
bee0abff
FA
335 @AllowNull(false)
336 @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
337 @Column(DataType.BIGINT)
338 videoQuotaDaily: number
339
7cd4d2ba 340 @AllowNull(false)
3f87a46f 341 @Default(DEFAULT_USER_THEME_NAME)
503c6f44 342 @Is('UserTheme', value => throwIfNotValid(value, isThemeNameValid, 'theme'))
7cd4d2ba
C
343 @Column
344 theme: string
345
43d0ea7f
C
346 @AllowNull(false)
347 @Default(false)
348 @Is(
349 'UserNoInstanceConfigWarningModal',
8f581725 350 value => throwIfNotValid(value, isUserNoModal, 'no instance config warning modal')
43d0ea7f
C
351 )
352 @Column
353 noInstanceConfigWarningModal: boolean
354
355 @AllowNull(false)
356 @Default(false)
357 @Is(
8f581725
C
358 'UserNoWelcomeModal',
359 value => throwIfNotValid(value, isUserNoModal, 'no welcome modal')
43d0ea7f
C
360 )
361 @Column
362 noWelcomeModal: boolean
363
8f581725
C
364 @AllowNull(false)
365 @Default(false)
366 @Is(
367 'UserNoAccountSetupWarningModal',
368 value => throwIfNotValid(value, isUserNoModal, 'no account setup warning modal')
369 )
370 @Column
371 noAccountSetupWarningModal: boolean
372
7fed6375
C
373 @AllowNull(true)
374 @Default(null)
375 @Column
376 pluginAuth: string
377
afff310e
RK
378 @AllowNull(false)
379 @Default(DataType.UUIDV4)
380 @IsUUID(4)
381 @Column(DataType.UUID)
382 feedToken: string
383
3cc665f4
C
384 @AllowNull(true)
385 @Default(null)
386 @Column
387 lastLoginDate: Date
388
3fd3ab2d
C
389 @CreatedAt
390 createdAt: Date
391
392 @UpdatedAt
393 updatedAt: Date
394
395 @HasOne(() => AccountModel, {
396 foreignKey: 'userId',
f05a1c30
C
397 onDelete: 'cascade',
398 hooks: true
3fd3ab2d
C
399 })
400 Account: AccountModel
69b0a27c 401
cef534ed
C
402 @HasOne(() => UserNotificationSettingModel, {
403 foreignKey: 'userId',
404 onDelete: 'cascade',
405 hooks: true
406 })
407 NotificationSetting: UserNotificationSettingModel
408
dc133480
C
409 @HasMany(() => VideoImportModel, {
410 foreignKey: 'userId',
411 onDelete: 'cascade'
412 })
413 VideoImports: VideoImportModel[]
414
3fd3ab2d
C
415 @HasMany(() => OAuthTokenModel, {
416 foreignKey: 'userId',
417 onDelete: 'cascade'
418 })
419 OAuthTokens: OAuthTokenModel[]
420
421 @BeforeCreate
422 @BeforeUpdate
423 static cryptPasswordIfNeeded (instance: UserModel) {
e1c55031 424 if (instance.changed('password') && instance.password) {
3fd3ab2d
C
425 return cryptPassword(instance.password)
426 .then(hash => {
427 instance.password = hash
428 return undefined
429 })
430 }
59557c46 431 }
26d7d31b 432
f201a749 433 @AfterUpdate
d175a6f7 434 @AfterDestroy
f201a749 435 static removeTokenCache (instance: UserModel) {
f43db2f4 436 return TokensCache.Instance.clearCacheByUserId(instance.id)
f201a749
C
437 }
438
3fd3ab2d
C
439 static countTotal () {
440 return this.count()
441 }
954605a8 442
8491293b
RK
443 static listForApi (parameters: {
444 start: number
445 count: number
446 sort: string
447 search?: string
448 blocked?: boolean
449 }) {
450 const { start, count, sort, search, blocked } = parameters
451 const where: WhereOptions = {}
a1587156 452
24b9417c 453 if (search) {
8491293b 454 Object.assign(where, {
3acc5084 455 [Op.or]: [
24b9417c
C
456 {
457 email: {
3acc5084 458 [Op.iLike]: '%' + search + '%'
24b9417c
C
459 }
460 },
461 {
462 username: {
a1587156 463 [Op.iLike]: '%' + search + '%'
24b9417c
C
464 }
465 }
466 ]
8491293b
RK
467 })
468 }
469
470 if (blocked !== undefined) {
471 Object.assign(where, {
472 blocked: blocked
473 })
24b9417c
C
474 }
475
3acc5084 476 const query: FindOptions = {
a76138ff 477 attributes: {
5600def4
C
478 include: [
479 [
480 literal(
481 '(' +
482 UserModel.generateUserQuotaBaseSQL({
483 withSelect: false,
484 whereUserId: '"UserModel"."id"'
485 }) +
486 ')'
487 ),
488 'videoQuotaUsed'
0c691a18 489 ]
5600def4 490 ]
a76138ff 491 },
3fd3ab2d
C
492 offset: start,
493 limit: count,
24b9417c
C
494 order: getSort(sort),
495 where
3fd3ab2d 496 }
72c7248b 497
d0800f76 498 return Promise.all([
499 UserModel.unscoped().count(query),
500 UserModel.findAll(query)
501 ]).then(([ total, data ]) => ({ total, data }))
72c7248b
C
502 }
503
b49f22d8 504 static listWithRight (right: UserRight): Promise<MUserDefault[]> {
ba75d268 505 const roles = Object.keys(USER_ROLE_LABELS)
a1587156
C
506 .map(k => parseInt(k, 10) as UserRole)
507 .filter(role => hasUserRight(role, right))
ba75d268 508
ba75d268 509 const query = {
ba75d268
C
510 where: {
511 role: {
3acc5084 512 [Op.in]: roles
ba75d268
C
513 }
514 }
515 }
516
cef534ed
C
517 return UserModel.findAll(query)
518 }
519
b49f22d8 520 static listUserSubscribersOf (actorId: number): Promise<MUserWithNotificationSetting[]> {
cef534ed
C
521 const query = {
522 include: [
523 {
524 model: UserNotificationSettingModel.unscoped(),
525 required: true
526 },
527 {
528 attributes: [ 'userId' ],
529 model: AccountModel.unscoped(),
530 required: true,
531 include: [
532 {
a1587156 533 attributes: [],
cef534ed
C
534 model: ActorModel.unscoped(),
535 required: true,
536 where: {
537 serverId: null
538 },
539 include: [
540 {
a1587156 541 attributes: [],
cef534ed
C
542 as: 'ActorFollowings',
543 model: ActorFollowModel.unscoped(),
544 required: true,
545 where: {
546 targetActorId: actorId
547 }
548 }
549 ]
550 }
551 ]
552 }
553 ]
554 }
555
556 return UserModel.unscoped().findAll(query)
ba75d268
C
557 }
558
b49f22d8 559 static listByUsernames (usernames: string[]): Promise<MUserDefault[]> {
f7cc67b4
C
560 const query = {
561 where: {
562 username: usernames
563 }
564 }
565
566 return UserModel.findAll(query)
567 }
568
b49f22d8 569 static loadById (id: number): Promise<MUser> {
fb719404
C
570 return UserModel.unscoped().findByPk(id)
571 }
572
b31d7262
C
573 static loadByIdFull (id: number): Promise<MUserDefault> {
574 return UserModel.findByPk(id)
575 }
576
b49f22d8 577 static loadByIdWithChannels (id: number, withStats = false): Promise<MUserDefault> {
76314386
RK
578 const scopes = [
579 ScopeNames.WITH_VIDEOCHANNELS
580 ]
581
582 if (withStats) scopes.push(ScopeNames.WITH_STATS)
583
584 return UserModel.scope(scopes).findByPk(id)
3fd3ab2d 585 }
feb4bdfd 586
b49f22d8 587 static loadByUsername (username: string): Promise<MUserDefault> {
3fd3ab2d
C
588 const query = {
589 where: {
1acb9475 590 username
d48ff09d 591 }
3fd3ab2d 592 }
089ff2f2 593
3fd3ab2d 594 return UserModel.findOne(query)
feb4bdfd
C
595 }
596
1acb9475 597 static loadForMeAPI (id: number): Promise<MUserNotifSettingChannelDefault> {
3fd3ab2d
C
598 const query = {
599 where: {
1acb9475 600 id
d48ff09d 601 }
3fd3ab2d 602 }
9bd26629 603
ac0868bc 604 return UserModel.scope(ScopeNames.FOR_ME_API).findOne(query)
feb4bdfd
C
605 }
606
b49f22d8 607 static loadByEmail (email: string): Promise<MUserDefault> {
ecb4e35f
C
608 const query = {
609 where: {
610 email
611 }
612 }
613
614 return UserModel.findOne(query)
615 }
616
b49f22d8 617 static loadByUsernameOrEmail (username: string, email?: string): Promise<MUserDefault> {
ba12e8b3
C
618 if (!email) email = username
619
3fd3ab2d 620 const query = {
3fd3ab2d 621 where: {
a1587156 622 [Op.or]: [
9d8ef212 623 where(fn('lower', col('username')), fn('lower', username) as any),
c4a1811e
C
624
625 { email }
626 ]
3fd3ab2d 627 }
6fcd19ba 628 }
69b0a27c 629
d48ff09d 630 return UserModel.findOne(query)
72c7248b
C
631 }
632
b49f22d8 633 static loadByVideoId (videoId: number): Promise<MUserDefault> {
cef534ed
C
634 const query = {
635 include: [
636 {
637 required: true,
638 attributes: [ 'id' ],
639 model: AccountModel.unscoped(),
640 include: [
641 {
642 required: true,
643 attributes: [ 'id' ],
644 model: VideoChannelModel.unscoped(),
645 include: [
646 {
647 required: true,
648 attributes: [ 'id' ],
649 model: VideoModel.unscoped(),
650 where: {
651 id: videoId
652 }
653 }
654 ]
655 }
656 ]
657 }
658 ]
659 }
660
661 return UserModel.findOne(query)
662 }
663
b49f22d8 664 static loadByVideoImportId (videoImportId: number): Promise<MUserDefault> {
dc133480
C
665 const query = {
666 include: [
667 {
668 required: true,
669 attributes: [ 'id' ],
670 model: VideoImportModel.unscoped(),
671 where: {
672 id: videoImportId
673 }
674 }
675 ]
676 }
677
678 return UserModel.findOne(query)
679 }
680
b49f22d8 681 static loadByChannelActorId (videoChannelActorId: number): Promise<MUserDefault> {
f7cc67b4
C
682 const query = {
683 include: [
684 {
685 required: true,
686 attributes: [ 'id' ],
687 model: AccountModel.unscoped(),
688 include: [
689 {
690 required: true,
691 attributes: [ 'id' ],
692 model: VideoChannelModel.unscoped(),
693 where: {
694 actorId: videoChannelActorId
695 }
696 }
697 ]
698 }
699 ]
700 }
701
702 return UserModel.findOne(query)
703 }
704
b49f22d8 705 static loadByAccountActorId (accountActorId: number): Promise<MUserDefault> {
f7cc67b4
C
706 const query = {
707 include: [
708 {
709 required: true,
710 attributes: [ 'id' ],
711 model: AccountModel.unscoped(),
712 where: {
713 actorId: accountActorId
714 }
715 }
716 ]
717 }
718
719 return UserModel.findOne(query)
720 }
721
b49f22d8 722 static loadByLiveId (liveId: number): Promise<MUser> {
fb719404
C
723 const query = {
724 include: [
725 {
726 attributes: [ 'id' ],
727 model: AccountModel.unscoped(),
728 required: true,
729 include: [
730 {
731 attributes: [ 'id' ],
732 model: VideoChannelModel.unscoped(),
733 required: true,
734 include: [
735 {
736 attributes: [ 'id' ],
737 model: VideoModel.unscoped(),
738 required: true,
739 include: [
740 {
31c82cd9 741 attributes: [],
fb719404
C
742 model: VideoLiveModel.unscoped(),
743 required: true,
744 where: {
745 id: liveId
746 }
747 }
748 ]
749 }
750 ]
751 }
752 ]
753 }
754 ]
755 }
756
31c82cd9 757 return UserModel.unscoped().findOne(query)
fb719404
C
758 }
759
760 static generateUserQuotaBaseSQL (options: {
761 whereUserId: '$userId' | '"UserModel"."id"'
762 withSelect: boolean
763 where?: string
764 }) {
765 const andWhere = options.where
766 ? 'AND ' + options.where
767 : ''
768
769 const videoChannelJoin = 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
770 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
771 `WHERE "account"."userId" = ${options.whereUserId} ${andWhere}`
772
773 const webtorrentFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
774 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
775 videoChannelJoin
776
777 const hlsFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
778 'INNER JOIN "videoStreamingPlaylist" ON "videoFile"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id ' +
779 'INNER JOIN "video" ON "videoStreamingPlaylist"."videoId" = "video"."id" ' +
780 videoChannelJoin
bee0abff 781
fb719404
C
782 return 'SELECT COALESCE(SUM("size"), 0) AS "total" ' +
783 'FROM (' +
784 `SELECT MAX("t1"."size") AS "size" FROM (${webtorrentFiles} UNION ${hlsFiles}) t1 ` +
785 'GROUP BY "t1"."videoId"' +
786 ') t2'
bee0abff
FA
787 }
788
fb719404
C
789 static getTotalRawQuery (query: string, userId: number) {
790 const options = {
791 bind: { userId },
792 type: QueryTypes.SELECT as QueryTypes.SELECT
793 }
794
795 return UserModel.sequelize.query<{ total: string }>(query, options)
796 .then(([ { total } ]) => {
797 if (total === null) return 0
68a3b9f2 798
fb719404
C
799 return parseInt(total, 10)
800 })
72c7248b
C
801 }
802
09cababd 803 static async getStats () {
3cc665f4
C
804 function getActiveUsers (days: number) {
805 const query = {
806 where: {
807 [Op.and]: [
808 literal(`"lastLoginDate" > NOW() - INTERVAL '${days}d'`)
809 ]
810 }
811 }
812
813 return UserModel.count(query)
814 }
815
09cababd 816 const totalUsers = await UserModel.count()
3cc665f4
C
817 const totalDailyActiveUsers = await getActiveUsers(1)
818 const totalWeeklyActiveUsers = await getActiveUsers(7)
819 const totalMonthlyActiveUsers = await getActiveUsers(30)
47d8e266 820 const totalHalfYearActiveUsers = await getActiveUsers(180)
09cababd
C
821
822 return {
3cc665f4
C
823 totalUsers,
824 totalDailyActiveUsers,
825 totalWeeklyActiveUsers,
47d8e266
C
826 totalMonthlyActiveUsers,
827 totalHalfYearActiveUsers
09cababd
C
828 }
829 }
830
5cf84858
C
831 static autoComplete (search: string) {
832 const query = {
833 where: {
834 username: {
a1587156 835 [Op.like]: `%${search}%`
5cf84858
C
836 }
837 },
838 limit: 10
839 }
840
841 return UserModel.findAll(query)
842 .then(u => u.map(u => u.username))
843 }
844
d7df188f 845 canGetVideo (video: MVideoWithRights) {
2a5518a6 846 const videoUserId = video.VideoChannel.Account.userId
22a73cb8 847
2a5518a6
C
848 if (video.isBlacklisted()) {
849 return videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST)
22a73cb8
C
850 }
851
2a5518a6
C
852 if (video.privacy === VideoPrivacy.PRIVATE) {
853 return video.VideoChannel && videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST)
22a73cb8
C
854 }
855
2a5518a6
C
856 if (video.privacy === VideoPrivacy.INTERNAL) return true
857
22a73cb8
C
858 return false
859 }
860
3fd3ab2d
C
861 hasRight (right: UserRight) {
862 return hasUserRight(this.role, right)
863 }
72c7248b 864
1eddc9a7
C
865 hasAdminFlag (flag: UserAdminFlag) {
866 return this.adminFlags & flag
867 }
868
3fd3ab2d
C
869 isPasswordMatch (password: string) {
870 return comparePassword(password, this.password)
feb4bdfd
C
871 }
872
ac0868bc 873 toFormattedJSON (this: MUserFormattable, parameters: { withAdminFlags?: boolean } = {}): User {
a76138ff 874 const videoQuotaUsed = this.get('videoQuotaUsed')
bee0abff 875 const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
76314386 876 const videosCount = this.get('videosCount')
4f32032f
C
877 const [ abusesCount, abusesAcceptedCount ] = (this.get('abusesCount') as string || ':').split(':')
878 const abusesCreatedCount = this.get('abusesCreatedCount')
76314386 879 const videoCommentsCount = this.get('videoCommentsCount')
a76138ff 880
ac0868bc 881 const json: User = {
3fd3ab2d
C
882 id: this.id,
883 username: this.username,
884 email: this.email,
43d0ea7f
C
885 theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME),
886
d1ab89de 887 pendingEmail: this.pendingEmail,
d9eaee39 888 emailVerified: this.emailVerified,
43d0ea7f 889
0883b324 890 nsfwPolicy: this.nsfwPolicy,
a9bfa85d
C
891
892 // FIXME: deprecated in 4.1
893 webTorrentEnabled: this.p2pEnabled,
894 p2pEnabled: this.p2pEnabled,
895
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}