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