]>
Commit | Line | Data |
---|---|---|
5600def4 | 1 | import { col, FindOptions, fn, literal, Op, QueryTypes, where, WhereOptions } from 'sequelize' |
3fd3ab2d | 2 | import { |
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 | 22 | import { hasUserRight, MyUser, USER_ROLE_LABELS, UserRight, VideoAbuseState, VideoPlaylistType, VideoPrivacy } from '../../../shared' |
ba75d268 | 23 | import { User, UserRole } from '../../../shared/models/users' |
65fcc311 | 24 | import { |
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 | 44 | import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto' |
3fd3ab2d C |
45 | import { OAuthTokenModel } from '../oauth/oauth-token' |
46 | import { getSort, throwIfNotValid } from '../utils' | |
47 | import { VideoChannelModel } from '../video/video-channel' | |
29128b2f | 48 | import { VideoPlaylistModel } from '../video/video-playlist' |
3fd3ab2d | 49 | import { AccountModel } from './account' |
0883b324 C |
50 | import { NSFWPolicyType } from '../../../shared/models/videos/nsfw-policy.type' |
51 | import { values } from 'lodash' | |
3f87a46f | 52 | import { DEFAULT_USER_THEME_NAME, NSFW_POLICY_TYPES } from '../../initializers/constants' |
f201a749 | 53 | import { clearCacheByUserId } from '../../lib/oauth-model' |
cef534ed C |
54 | import { UserNotificationSettingModel } from './user-notification-setting' |
55 | import { VideoModel } from '../video/video' | |
56 | import { ActorModel } from '../activitypub/actor' | |
57 | import { ActorFollowModel } from '../activitypub/actor-follow' | |
dc133480 | 58 | import { VideoImportModel } from '../video/video-import' |
1eddc9a7 | 59 | import { UserAdminFlag } from '../../../shared/models/users/user-flag.model' |
503c6f44 | 60 | import { isThemeNameValid } from '../../helpers/custom-validators/plugins' |
7cd4d2ba | 61 | import { getThemeOrDefault } from '../../lib/plugins/theme-utils' |
453e83ea | 62 | import * as Bluebird from 'bluebird' |
1ca9f7c3 | 63 | import { |
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 | 73 | enum 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 | }) |
222 | export 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 | ||
3cc665f4 C |
356 | @AllowNull(true) |
357 | @Default(null) | |
358 | @Column | |
359 | lastLoginDate: Date | |
360 | ||
3fd3ab2d C |
361 | @CreatedAt |
362 | createdAt: Date | |
363 | ||
364 | @UpdatedAt | |
365 | updatedAt: Date | |
366 | ||
367 | @HasOne(() => AccountModel, { | |
368 | foreignKey: 'userId', | |
f05a1c30 C |
369 | onDelete: 'cascade', |
370 | hooks: true | |
3fd3ab2d C |
371 | }) |
372 | Account: AccountModel | |
69b0a27c | 373 | |
cef534ed C |
374 | @HasOne(() => UserNotificationSettingModel, { |
375 | foreignKey: 'userId', | |
376 | onDelete: 'cascade', | |
377 | hooks: true | |
378 | }) | |
379 | NotificationSetting: UserNotificationSettingModel | |
380 | ||
dc133480 C |
381 | @HasMany(() => VideoImportModel, { |
382 | foreignKey: 'userId', | |
383 | onDelete: 'cascade' | |
384 | }) | |
385 | VideoImports: VideoImportModel[] | |
386 | ||
3fd3ab2d C |
387 | @HasMany(() => OAuthTokenModel, { |
388 | foreignKey: 'userId', | |
389 | onDelete: 'cascade' | |
390 | }) | |
391 | OAuthTokens: OAuthTokenModel[] | |
392 | ||
393 | @BeforeCreate | |
394 | @BeforeUpdate | |
395 | static cryptPasswordIfNeeded (instance: UserModel) { | |
e1c55031 | 396 | if (instance.changed('password') && instance.password) { |
3fd3ab2d C |
397 | return cryptPassword(instance.password) |
398 | .then(hash => { | |
399 | instance.password = hash | |
400 | return undefined | |
401 | }) | |
402 | } | |
59557c46 | 403 | } |
26d7d31b | 404 | |
f201a749 | 405 | @AfterUpdate |
d175a6f7 | 406 | @AfterDestroy |
f201a749 C |
407 | static removeTokenCache (instance: UserModel) { |
408 | return clearCacheByUserId(instance.id) | |
409 | } | |
410 | ||
3fd3ab2d C |
411 | static countTotal () { |
412 | return this.count() | |
413 | } | |
954605a8 | 414 | |
24b9417c | 415 | static listForApi (start: number, count: number, sort: string, search?: string) { |
a1587156 C |
416 | let where: WhereOptions |
417 | ||
24b9417c C |
418 | if (search) { |
419 | where = { | |
3acc5084 | 420 | [Op.or]: [ |
24b9417c C |
421 | { |
422 | email: { | |
3acc5084 | 423 | [Op.iLike]: '%' + search + '%' |
24b9417c C |
424 | } |
425 | }, | |
426 | { | |
427 | username: { | |
a1587156 | 428 | [Op.iLike]: '%' + search + '%' |
24b9417c C |
429 | } |
430 | } | |
431 | ] | |
432 | } | |
433 | } | |
434 | ||
3acc5084 | 435 | const query: FindOptions = { |
a76138ff | 436 | attributes: { |
5600def4 C |
437 | include: [ |
438 | [ | |
439 | literal( | |
440 | '(' + | |
441 | UserModel.generateUserQuotaBaseSQL({ | |
442 | withSelect: false, | |
443 | whereUserId: '"UserModel"."id"' | |
444 | }) + | |
445 | ')' | |
446 | ), | |
447 | 'videoQuotaUsed' | |
448 | ] as any // FIXME: typings | |
449 | ] | |
a76138ff | 450 | }, |
3fd3ab2d C |
451 | offset: start, |
452 | limit: count, | |
24b9417c C |
453 | order: getSort(sort), |
454 | where | |
3fd3ab2d | 455 | } |
72c7248b | 456 | |
3fd3ab2d | 457 | return UserModel.findAndCountAll(query) |
a1587156 C |
458 | .then(({ rows, count }) => { |
459 | return { | |
460 | data: rows, | |
461 | total: count | |
462 | } | |
463 | }) | |
72c7248b C |
464 | } |
465 | ||
453e83ea | 466 | static listWithRight (right: UserRight): Bluebird<MUserDefault[]> { |
ba75d268 | 467 | const roles = Object.keys(USER_ROLE_LABELS) |
a1587156 C |
468 | .map(k => parseInt(k, 10) as UserRole) |
469 | .filter(role => hasUserRight(role, right)) | |
ba75d268 | 470 | |
ba75d268 | 471 | const query = { |
ba75d268 C |
472 | where: { |
473 | role: { | |
3acc5084 | 474 | [Op.in]: roles |
ba75d268 C |
475 | } |
476 | } | |
477 | } | |
478 | ||
cef534ed C |
479 | return UserModel.findAll(query) |
480 | } | |
481 | ||
453e83ea | 482 | static listUserSubscribersOf (actorId: number): Bluebird<MUserWithNotificationSetting[]> { |
cef534ed C |
483 | const query = { |
484 | include: [ | |
485 | { | |
486 | model: UserNotificationSettingModel.unscoped(), | |
487 | required: true | |
488 | }, | |
489 | { | |
490 | attributes: [ 'userId' ], | |
491 | model: AccountModel.unscoped(), | |
492 | required: true, | |
493 | include: [ | |
494 | { | |
a1587156 | 495 | attributes: [], |
cef534ed C |
496 | model: ActorModel.unscoped(), |
497 | required: true, | |
498 | where: { | |
499 | serverId: null | |
500 | }, | |
501 | include: [ | |
502 | { | |
a1587156 | 503 | attributes: [], |
cef534ed C |
504 | as: 'ActorFollowings', |
505 | model: ActorFollowModel.unscoped(), | |
506 | required: true, | |
507 | where: { | |
508 | targetActorId: actorId | |
509 | } | |
510 | } | |
511 | ] | |
512 | } | |
513 | ] | |
514 | } | |
515 | ] | |
516 | } | |
517 | ||
518 | return UserModel.unscoped().findAll(query) | |
ba75d268 C |
519 | } |
520 | ||
453e83ea | 521 | static listByUsernames (usernames: string[]): Bluebird<MUserDefault[]> { |
f7cc67b4 C |
522 | const query = { |
523 | where: { | |
524 | username: usernames | |
525 | } | |
526 | } | |
527 | ||
528 | return UserModel.findAll(query) | |
529 | } | |
530 | ||
76314386 RK |
531 | static loadById (id: number, withStats = false): Bluebird<MUserDefault> { |
532 | const scopes = [ | |
533 | ScopeNames.WITH_VIDEOCHANNELS | |
534 | ] | |
535 | ||
536 | if (withStats) scopes.push(ScopeNames.WITH_STATS) | |
537 | ||
538 | return UserModel.scope(scopes).findByPk(id) | |
3fd3ab2d | 539 | } |
feb4bdfd | 540 | |
453e83ea | 541 | static loadByUsername (username: string): Bluebird<MUserDefault> { |
3fd3ab2d C |
542 | const query = { |
543 | where: { | |
a1587156 | 544 | username: { [Op.iLike]: username } |
d48ff09d | 545 | } |
3fd3ab2d | 546 | } |
089ff2f2 | 547 | |
3fd3ab2d | 548 | return UserModel.findOne(query) |
feb4bdfd C |
549 | } |
550 | ||
ac0868bc | 551 | static loadForMeAPI (username: string): Bluebird<MUserNotifSettingChannelDefault> { |
3fd3ab2d C |
552 | const query = { |
553 | where: { | |
a1587156 | 554 | username: { [Op.iLike]: username } |
d48ff09d | 555 | } |
3fd3ab2d | 556 | } |
9bd26629 | 557 | |
ac0868bc | 558 | return UserModel.scope(ScopeNames.FOR_ME_API).findOne(query) |
feb4bdfd C |
559 | } |
560 | ||
453e83ea | 561 | static loadByEmail (email: string): Bluebird<MUserDefault> { |
ecb4e35f C |
562 | const query = { |
563 | where: { | |
564 | ||
565 | } | |
566 | } | |
567 | ||
568 | return UserModel.findOne(query) | |
569 | } | |
570 | ||
453e83ea | 571 | static loadByUsernameOrEmail (username: string, email?: string): Bluebird<MUserDefault> { |
ba12e8b3 C |
572 | if (!email) email = username |
573 | ||
3fd3ab2d | 574 | const query = { |
3fd3ab2d | 575 | where: { |
a1587156 | 576 | [Op.or]: [ |
c4a1811e C |
577 | where(fn('lower', col('username')), fn('lower', username)), |
578 | ||
579 | { email } | |
580 | ] | |
3fd3ab2d | 581 | } |
6fcd19ba | 582 | } |
69b0a27c | 583 | |
d48ff09d | 584 | return UserModel.findOne(query) |
72c7248b C |
585 | } |
586 | ||
453e83ea | 587 | static loadByVideoId (videoId: number): Bluebird<MUserDefault> { |
cef534ed C |
588 | const query = { |
589 | include: [ | |
590 | { | |
591 | required: true, | |
592 | attributes: [ 'id' ], | |
593 | model: AccountModel.unscoped(), | |
594 | include: [ | |
595 | { | |
596 | required: true, | |
597 | attributes: [ 'id' ], | |
598 | model: VideoChannelModel.unscoped(), | |
599 | include: [ | |
600 | { | |
601 | required: true, | |
602 | attributes: [ 'id' ], | |
603 | model: VideoModel.unscoped(), | |
604 | where: { | |
605 | id: videoId | |
606 | } | |
607 | } | |
608 | ] | |
609 | } | |
610 | ] | |
611 | } | |
612 | ] | |
613 | } | |
614 | ||
615 | return UserModel.findOne(query) | |
616 | } | |
617 | ||
453e83ea | 618 | static loadByVideoImportId (videoImportId: number): Bluebird<MUserDefault> { |
dc133480 C |
619 | const query = { |
620 | include: [ | |
621 | { | |
622 | required: true, | |
623 | attributes: [ 'id' ], | |
624 | model: VideoImportModel.unscoped(), | |
625 | where: { | |
626 | id: videoImportId | |
627 | } | |
628 | } | |
629 | ] | |
630 | } | |
631 | ||
632 | return UserModel.findOne(query) | |
633 | } | |
634 | ||
453e83ea | 635 | static loadByChannelActorId (videoChannelActorId: number): Bluebird<MUserDefault> { |
f7cc67b4 C |
636 | const query = { |
637 | include: [ | |
638 | { | |
639 | required: true, | |
640 | attributes: [ 'id' ], | |
641 | model: AccountModel.unscoped(), | |
642 | include: [ | |
643 | { | |
644 | required: true, | |
645 | attributes: [ 'id' ], | |
646 | model: VideoChannelModel.unscoped(), | |
647 | where: { | |
648 | actorId: videoChannelActorId | |
649 | } | |
650 | } | |
651 | ] | |
652 | } | |
653 | ] | |
654 | } | |
655 | ||
656 | return UserModel.findOne(query) | |
657 | } | |
658 | ||
453e83ea | 659 | static loadByAccountActorId (accountActorId: number): Bluebird<MUserDefault> { |
f7cc67b4 C |
660 | const query = { |
661 | include: [ | |
662 | { | |
663 | required: true, | |
664 | attributes: [ 'id' ], | |
665 | model: AccountModel.unscoped(), | |
666 | where: { | |
667 | actorId: accountActorId | |
668 | } | |
669 | } | |
670 | ] | |
671 | } | |
672 | ||
673 | return UserModel.findOne(query) | |
674 | } | |
675 | ||
453e83ea | 676 | static getOriginalVideoFileTotalFromUser (user: MUserId) { |
3fd3ab2d | 677 | // Don't use sequelize because we need to use a sub query |
5600def4 C |
678 | const query = UserModel.generateUserQuotaBaseSQL({ |
679 | withSelect: true, | |
680 | whereUserId: '$userId' | |
681 | }) | |
bee0abff | 682 | |
8b604880 | 683 | return UserModel.getTotalRawQuery(query, user.id) |
bee0abff FA |
684 | } |
685 | ||
8b604880 | 686 | // Returns cumulative size of all video files uploaded in the last 24 hours. |
453e83ea | 687 | static getOriginalVideoFileTotalDailyFromUser (user: MUserId) { |
bee0abff | 688 | // Don't use sequelize because we need to use a sub query |
5600def4 C |
689 | const query = UserModel.generateUserQuotaBaseSQL({ |
690 | withSelect: true, | |
691 | whereUserId: '$userId', | |
692 | where: '"video"."createdAt" > now() - interval \'24 hours\'' | |
693 | }) | |
68a3b9f2 | 694 | |
8b604880 | 695 | return UserModel.getTotalRawQuery(query, user.id) |
72c7248b C |
696 | } |
697 | ||
09cababd | 698 | static async getStats () { |
3cc665f4 C |
699 | function getActiveUsers (days: number) { |
700 | const query = { | |
701 | where: { | |
702 | [Op.and]: [ | |
703 | literal(`"lastLoginDate" > NOW() - INTERVAL '${days}d'`) | |
704 | ] | |
705 | } | |
706 | } | |
707 | ||
708 | return UserModel.count(query) | |
709 | } | |
710 | ||
09cababd | 711 | const totalUsers = await UserModel.count() |
3cc665f4 C |
712 | const totalDailyActiveUsers = await getActiveUsers(1) |
713 | const totalWeeklyActiveUsers = await getActiveUsers(7) | |
714 | const totalMonthlyActiveUsers = await getActiveUsers(30) | |
09cababd C |
715 | |
716 | return { | |
3cc665f4 C |
717 | totalUsers, |
718 | totalDailyActiveUsers, | |
719 | totalWeeklyActiveUsers, | |
720 | totalMonthlyActiveUsers | |
09cababd C |
721 | } |
722 | } | |
723 | ||
5cf84858 C |
724 | static autoComplete (search: string) { |
725 | const query = { | |
726 | where: { | |
727 | username: { | |
a1587156 | 728 | [Op.like]: `%${search}%` |
5cf84858 C |
729 | } |
730 | }, | |
731 | limit: 10 | |
732 | } | |
733 | ||
734 | return UserModel.findAll(query) | |
735 | .then(u => u.map(u => u.username)) | |
736 | } | |
737 | ||
22a73cb8 | 738 | canGetVideo (video: MVideoFullLight) { |
2a5518a6 | 739 | const videoUserId = video.VideoChannel.Account.userId |
22a73cb8 | 740 | |
2a5518a6 C |
741 | if (video.isBlacklisted()) { |
742 | return videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST) | |
22a73cb8 C |
743 | } |
744 | ||
2a5518a6 C |
745 | if (video.privacy === VideoPrivacy.PRIVATE) { |
746 | return video.VideoChannel && videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST) | |
22a73cb8 C |
747 | } |
748 | ||
2a5518a6 C |
749 | if (video.privacy === VideoPrivacy.INTERNAL) return true |
750 | ||
22a73cb8 C |
751 | return false |
752 | } | |
753 | ||
3fd3ab2d C |
754 | hasRight (right: UserRight) { |
755 | return hasUserRight(this.role, right) | |
756 | } | |
72c7248b | 757 | |
1eddc9a7 C |
758 | hasAdminFlag (flag: UserAdminFlag) { |
759 | return this.adminFlags & flag | |
760 | } | |
761 | ||
3fd3ab2d C |
762 | isPasswordMatch (password: string) { |
763 | return comparePassword(password, this.password) | |
feb4bdfd C |
764 | } |
765 | ||
ac0868bc | 766 | toFormattedJSON (this: MUserFormattable, parameters: { withAdminFlags?: boolean } = {}): User { |
a76138ff | 767 | const videoQuotaUsed = this.get('videoQuotaUsed') |
bee0abff | 768 | const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily') |
76314386 RK |
769 | const videosCount = this.get('videosCount') |
770 | const [ videoAbusesCount, videoAbusesAcceptedCount ] = (this.get('videoAbusesCount') as string || ':').split(':') | |
771 | const videoAbusesCreatedCount = this.get('videoAbusesCreatedCount') | |
772 | const videoCommentsCount = this.get('videoCommentsCount') | |
a76138ff | 773 | |
ac0868bc | 774 | const json: User = { |
3fd3ab2d C |
775 | id: this.id, |
776 | username: this.username, | |
777 | email: this.email, | |
43d0ea7f C |
778 | theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME), |
779 | ||
d1ab89de | 780 | pendingEmail: this.pendingEmail, |
d9eaee39 | 781 | emailVerified: this.emailVerified, |
43d0ea7f | 782 | |
0883b324 | 783 | nsfwPolicy: this.nsfwPolicy, |
ed638e53 | 784 | webTorrentEnabled: this.webTorrentEnabled, |
276d9652 | 785 | videosHistoryEnabled: this.videosHistoryEnabled, |
7efe153b | 786 | autoPlayVideo: this.autoPlayVideo, |
6aa54148 | 787 | autoPlayNextVideo: this.autoPlayNextVideo, |
bee29df8 | 788 | autoPlayNextVideoPlaylist: this.autoPlayNextVideoPlaylist, |
3caf77d3 | 789 | videoLanguages: this.videoLanguages, |
43d0ea7f | 790 | |
3fd3ab2d | 791 | role: this.role, |
a1587156 | 792 | roleLabel: USER_ROLE_LABELS[this.role], |
43d0ea7f | 793 | |
3fd3ab2d | 794 | videoQuota: this.videoQuota, |
bee0abff | 795 | videoQuotaDaily: this.videoQuotaDaily, |
43d0ea7f C |
796 | videoQuotaUsed: videoQuotaUsed !== undefined |
797 | ? parseInt(videoQuotaUsed + '', 10) | |
798 | : undefined, | |
799 | videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined | |
800 | ? parseInt(videoQuotaUsedDaily + '', 10) | |
801 | : undefined, | |
76314386 RK |
802 | videosCount: videosCount !== undefined |
803 | ? parseInt(videosCount + '', 10) | |
804 | : undefined, | |
805 | videoAbusesCount: videoAbusesCount | |
806 | ? parseInt(videoAbusesCount, 10) | |
807 | : undefined, | |
808 | videoAbusesAcceptedCount: videoAbusesAcceptedCount | |
809 | ? parseInt(videoAbusesAcceptedCount, 10) | |
810 | : undefined, | |
811 | videoAbusesCreatedCount: videoAbusesCreatedCount !== undefined | |
812 | ? parseInt(videoAbusesCreatedCount + '', 10) | |
813 | : undefined, | |
814 | videoCommentsCount: videoCommentsCount !== undefined | |
815 | ? parseInt(videoCommentsCount + '', 10) | |
816 | : undefined, | |
43d0ea7f C |
817 | |
818 | noInstanceConfigWarningModal: this.noInstanceConfigWarningModal, | |
819 | noWelcomeModal: this.noWelcomeModal, | |
820 | ||
eacb25c4 C |
821 | blocked: this.blocked, |
822 | blockedReason: this.blockedReason, | |
43d0ea7f | 823 | |
c5911fd3 | 824 | account: this.Account.toFormattedJSON(), |
43d0ea7f C |
825 | |
826 | notificationSettings: this.NotificationSetting | |
827 | ? this.NotificationSetting.toFormattedJSON() | |
828 | : undefined, | |
829 | ||
a76138ff | 830 | videoChannels: [], |
43d0ea7f | 831 | |
8bb71f2e C |
832 | createdAt: this.createdAt, |
833 | ||
3cc665f4 C |
834 | pluginAuth: this.pluginAuth, |
835 | ||
836 | lastLoginDate: this.lastLoginDate | |
3fd3ab2d C |
837 | } |
838 | ||
1eddc9a7 C |
839 | if (parameters.withAdminFlags) { |
840 | Object.assign(json, { adminFlags: this.adminFlags }) | |
841 | } | |
842 | ||
3fd3ab2d | 843 | if (Array.isArray(this.Account.VideoChannels) === true) { |
c5911fd3 | 844 | json.videoChannels = this.Account.VideoChannels |
a1587156 C |
845 | .map(c => c.toFormattedJSON()) |
846 | .sort((v1, v2) => { | |
847 | if (v1.createdAt < v2.createdAt) return -1 | |
848 | if (v1.createdAt === v2.createdAt) return 0 | |
ad4a8a1c | 849 | |
a1587156 C |
850 | return 1 |
851 | }) | |
ad4a8a1c | 852 | } |
3fd3ab2d C |
853 | |
854 | return json | |
ad4a8a1c C |
855 | } |
856 | ||
ac0868bc C |
857 | toMeFormattedJSON (this: MMyUserFormattable): MyUser { |
858 | const formatted = this.toFormattedJSON() | |
859 | ||
860 | const specialPlaylists = this.Account.VideoPlaylists | |
a1587156 | 861 | .map(p => ({ id: p.id, name: p.name, type: p.type })) |
ac0868bc C |
862 | |
863 | return Object.assign(formatted, { specialPlaylists }) | |
864 | } | |
865 | ||
bee0abff FA |
866 | async isAbleToUploadVideo (videoFile: { size: number }) { |
867 | if (this.videoQuota === -1 && this.videoQuotaDaily === -1) return Promise.resolve(true) | |
b0f9f39e | 868 | |
bee0abff FA |
869 | const [ totalBytes, totalBytesDaily ] = await Promise.all([ |
870 | UserModel.getOriginalVideoFileTotalFromUser(this), | |
871 | UserModel.getOriginalVideoFileTotalDailyFromUser(this) | |
872 | ]) | |
873 | ||
874 | const uploadedTotal = videoFile.size + totalBytes | |
875 | const uploadedDaily = videoFile.size + totalBytesDaily | |
bee0abff | 876 | |
3acc5084 C |
877 | if (this.videoQuotaDaily === -1) return uploadedTotal < this.videoQuota |
878 | if (this.videoQuota === -1) return uploadedDaily < this.videoQuotaDaily | |
879 | ||
880 | return uploadedTotal < this.videoQuota && uploadedDaily < this.videoQuotaDaily | |
b0f9f39e | 881 | } |
8b604880 | 882 | |
5600def4 C |
883 | private static generateUserQuotaBaseSQL (options: { |
884 | whereUserId: '$userId' | '"UserModel"."id"' | |
885 | withSelect: boolean | |
886 | where?: string | |
887 | }) { | |
888 | const andWhere = options.where | |
889 | ? 'AND ' + options.where | |
890 | : '' | |
8b604880 | 891 | |
5600def4 | 892 | const videoChannelJoin = 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' + |
a1587156 | 893 | 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' + |
5600def4 C |
894 | `WHERE "account"."userId" = ${options.whereUserId} ${andWhere}` |
895 | ||
896 | const webtorrentFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' + | |
897 | 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' + | |
898 | videoChannelJoin | |
899 | ||
900 | const hlsFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' + | |
901 | 'INNER JOIN "videoStreamingPlaylist" ON "videoFile"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id ' + | |
902 | 'INNER JOIN "video" ON "videoStreamingPlaylist"."videoId" = "video"."id" ' + | |
903 | videoChannelJoin | |
904 | ||
905 | return 'SELECT COALESCE(SUM("size"), 0) AS "total" ' + | |
906 | 'FROM (' + | |
907 | `SELECT MAX("t1"."size") AS "size" FROM (${webtorrentFiles} UNION ${hlsFiles}) t1 ` + | |
908 | 'GROUP BY "t1"."videoId"' + | |
909 | ') t2' | |
8b604880 C |
910 | } |
911 | ||
912 | private static getTotalRawQuery (query: string, userId: number) { | |
913 | const options = { | |
914 | bind: { userId }, | |
3acc5084 | 915 | type: QueryTypes.SELECT as QueryTypes.SELECT |
8b604880 C |
916 | } |
917 | ||
3acc5084 | 918 | return UserModel.sequelize.query<{ total: string }>(query, options) |
8b604880 C |
919 | .then(([ { total } ]) => { |
920 | if (total === null) return 0 | |
921 | ||
3acc5084 | 922 | return parseInt(total, 10) |
8b604880 C |
923 | }) |
924 | } | |
b0f9f39e | 925 | } |