]>
Commit | Line | Data |
---|---|---|
e02643f3 | 1 | import * as Sequelize from 'sequelize' |
3fd3ab2d | 2 | import { |
f201a749 C |
3 | AfterDelete, |
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' |
e34c85e5 | 22 | import { hasUserRight, USER_ROLE_LABELS, UserRight } from '../../../shared' |
ba75d268 | 23 | import { User, UserRole } from '../../../shared/models/users' |
65fcc311 | 24 | import { |
a73c582e | 25 | isUserAutoPlayVideoValid, |
eacb25c4 | 26 | isUserBlockedReasonValid, |
e6921918 | 27 | isUserBlockedValid, |
d9eaee39 | 28 | isUserEmailVerifiedValid, |
5cf84858 | 29 | isUserNSFWPolicyValid, |
a73c582e C |
30 | isUserPasswordValid, |
31 | isUserRoleValid, | |
32 | isUserUsernameValid, | |
5cf84858 C |
33 | isUserVideoQuotaDailyValid, |
34 | isUserVideoQuotaValid | |
3fd3ab2d | 35 | } from '../../helpers/custom-validators/users' |
da854ddd | 36 | import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto' |
3fd3ab2d C |
37 | import { OAuthTokenModel } from '../oauth/oauth-token' |
38 | import { getSort, throwIfNotValid } from '../utils' | |
39 | import { VideoChannelModel } from '../video/video-channel' | |
40 | import { AccountModel } from './account' | |
0883b324 C |
41 | import { NSFWPolicyType } from '../../../shared/models/videos/nsfw-policy.type' |
42 | import { values } from 'lodash' | |
43 | import { NSFW_POLICY_TYPES } from '../../initializers' | |
f201a749 | 44 | import { clearCacheByUserId } from '../../lib/oauth-model' |
3fd3ab2d | 45 | |
9c2e0dbf C |
46 | enum ScopeNames { |
47 | WITH_VIDEO_CHANNEL = 'WITH_VIDEO_CHANNEL' | |
48 | } | |
49 | ||
d48ff09d C |
50 | @DefaultScope({ |
51 | include: [ | |
52 | { | |
53 | model: () => AccountModel, | |
54 | required: true | |
55 | } | |
56 | ] | |
57 | }) | |
58 | @Scopes({ | |
9c2e0dbf | 59 | [ScopeNames.WITH_VIDEO_CHANNEL]: { |
d48ff09d C |
60 | include: [ |
61 | { | |
62 | model: () => AccountModel, | |
63 | required: true, | |
64 | include: [ () => VideoChannelModel ] | |
65 | } | |
66 | ] | |
67 | } | |
68 | }) | |
3fd3ab2d C |
69 | @Table({ |
70 | tableName: 'user', | |
71 | indexes: [ | |
feb4bdfd | 72 | { |
3fd3ab2d C |
73 | fields: [ 'username' ], |
74 | unique: true | |
feb4bdfd C |
75 | }, |
76 | { | |
3fd3ab2d C |
77 | fields: [ 'email' ], |
78 | unique: true | |
feb4bdfd | 79 | } |
e02643f3 | 80 | ] |
3fd3ab2d C |
81 | }) |
82 | export class UserModel extends Model<UserModel> { | |
83 | ||
84 | @AllowNull(false) | |
85 | @Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password')) | |
86 | @Column | |
87 | password: string | |
88 | ||
89 | @AllowNull(false) | |
90 | @Is('UserPassword', value => throwIfNotValid(value, isUserUsernameValid, 'user name')) | |
91 | @Column | |
92 | username: string | |
93 | ||
94 | @AllowNull(false) | |
95 | @IsEmail | |
96 | @Column(DataType.STRING(400)) | |
97 | email: string | |
98 | ||
d9eaee39 JM |
99 | @AllowNull(true) |
100 | @Default(null) | |
101 | @Is('UserEmailVerified', value => throwIfNotValid(value, isUserEmailVerifiedValid, 'email verified boolean')) | |
102 | @Column | |
103 | emailVerified: boolean | |
104 | ||
3fd3ab2d | 105 | @AllowNull(false) |
0883b324 C |
106 | @Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy')) |
107 | @Column(DataType.ENUM(values(NSFW_POLICY_TYPES))) | |
108 | nsfwPolicy: NSFWPolicyType | |
3fd3ab2d | 109 | |
7efe153b AL |
110 | @AllowNull(false) |
111 | @Default(true) | |
112 | @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean')) | |
113 | @Column | |
114 | autoPlayVideo: boolean | |
115 | ||
e6921918 C |
116 | @AllowNull(false) |
117 | @Default(false) | |
118 | @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean')) | |
119 | @Column | |
120 | blocked: boolean | |
121 | ||
eacb25c4 C |
122 | @AllowNull(true) |
123 | @Default(null) | |
124 | @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason')) | |
125 | @Column | |
126 | blockedReason: string | |
127 | ||
3fd3ab2d C |
128 | @AllowNull(false) |
129 | @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role')) | |
130 | @Column | |
131 | role: number | |
132 | ||
133 | @AllowNull(false) | |
134 | @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota')) | |
135 | @Column(DataType.BIGINT) | |
136 | videoQuota: number | |
137 | ||
bee0abff FA |
138 | @AllowNull(false) |
139 | @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily')) | |
140 | @Column(DataType.BIGINT) | |
141 | videoQuotaDaily: number | |
142 | ||
3fd3ab2d C |
143 | @CreatedAt |
144 | createdAt: Date | |
145 | ||
146 | @UpdatedAt | |
147 | updatedAt: Date | |
148 | ||
149 | @HasOne(() => AccountModel, { | |
150 | foreignKey: 'userId', | |
f05a1c30 C |
151 | onDelete: 'cascade', |
152 | hooks: true | |
3fd3ab2d C |
153 | }) |
154 | Account: AccountModel | |
69b0a27c | 155 | |
3fd3ab2d C |
156 | @HasMany(() => OAuthTokenModel, { |
157 | foreignKey: 'userId', | |
158 | onDelete: 'cascade' | |
159 | }) | |
160 | OAuthTokens: OAuthTokenModel[] | |
161 | ||
162 | @BeforeCreate | |
163 | @BeforeUpdate | |
164 | static cryptPasswordIfNeeded (instance: UserModel) { | |
165 | if (instance.changed('password')) { | |
166 | return cryptPassword(instance.password) | |
167 | .then(hash => { | |
168 | instance.password = hash | |
169 | return undefined | |
170 | }) | |
171 | } | |
59557c46 | 172 | } |
26d7d31b | 173 | |
f201a749 C |
174 | @AfterUpdate |
175 | @AfterDelete | |
176 | static removeTokenCache (instance: UserModel) { | |
177 | return clearCacheByUserId(instance.id) | |
178 | } | |
179 | ||
3fd3ab2d C |
180 | static countTotal () { |
181 | return this.count() | |
182 | } | |
954605a8 | 183 | |
3fd3ab2d C |
184 | static listForApi (start: number, count: number, sort: string) { |
185 | const query = { | |
a76138ff C |
186 | attributes: { |
187 | include: [ | |
188 | [ | |
189 | Sequelize.literal( | |
190 | '(' + | |
8b604880 C |
191 | 'SELECT COALESCE(SUM("size"), 0) ' + |
192 | 'FROM (' + | |
a76138ff C |
193 | 'SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' + |
194 | 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' + | |
195 | 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' + | |
196 | 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' + | |
197 | 'WHERE "account"."userId" = "UserModel"."id" GROUP BY "video"."id"' + | |
198 | ') t' + | |
199 | ')' | |
200 | ), | |
201 | 'videoQuotaUsed' | |
202 | ] as any // FIXME: typings | |
203 | ] | |
204 | }, | |
3fd3ab2d C |
205 | offset: start, |
206 | limit: count, | |
6ff9c676 | 207 | order: getSort(sort) |
3fd3ab2d | 208 | } |
72c7248b | 209 | |
3fd3ab2d C |
210 | return UserModel.findAndCountAll(query) |
211 | .then(({ rows, count }) => { | |
212 | return { | |
213 | data: rows, | |
214 | total: count | |
215 | } | |
72c7248b | 216 | }) |
72c7248b C |
217 | } |
218 | ||
ba75d268 C |
219 | static listEmailsWithRight (right: UserRight) { |
220 | const roles = Object.keys(USER_ROLE_LABELS) | |
221 | .map(k => parseInt(k, 10) as UserRole) | |
222 | .filter(role => hasUserRight(role, right)) | |
223 | ||
ba75d268 C |
224 | const query = { |
225 | attribute: [ 'email' ], | |
226 | where: { | |
227 | role: { | |
228 | [Sequelize.Op.in]: roles | |
229 | } | |
230 | } | |
231 | } | |
232 | ||
233 | return UserModel.unscoped() | |
234 | .findAll(query) | |
235 | .then(u => u.map(u => u.email)) | |
236 | } | |
237 | ||
3fd3ab2d | 238 | static loadById (id: number) { |
d48ff09d | 239 | return UserModel.findById(id) |
3fd3ab2d | 240 | } |
feb4bdfd | 241 | |
3fd3ab2d C |
242 | static loadByUsername (username: string) { |
243 | const query = { | |
244 | where: { | |
245 | username | |
d48ff09d | 246 | } |
3fd3ab2d | 247 | } |
089ff2f2 | 248 | |
3fd3ab2d | 249 | return UserModel.findOne(query) |
feb4bdfd C |
250 | } |
251 | ||
3fd3ab2d C |
252 | static loadByUsernameAndPopulateChannels (username: string) { |
253 | const query = { | |
254 | where: { | |
255 | username | |
d48ff09d | 256 | } |
3fd3ab2d | 257 | } |
9bd26629 | 258 | |
9c2e0dbf | 259 | return UserModel.scope(ScopeNames.WITH_VIDEO_CHANNEL).findOne(query) |
feb4bdfd C |
260 | } |
261 | ||
ecb4e35f C |
262 | static loadByEmail (email: string) { |
263 | const query = { | |
264 | where: { | |
265 | ||
266 | } | |
267 | } | |
268 | ||
269 | return UserModel.findOne(query) | |
270 | } | |
271 | ||
ba12e8b3 C |
272 | static loadByUsernameOrEmail (username: string, email?: string) { |
273 | if (!email) email = username | |
274 | ||
3fd3ab2d | 275 | const query = { |
3fd3ab2d C |
276 | where: { |
277 | [ Sequelize.Op.or ]: [ { username }, { email } ] | |
278 | } | |
6fcd19ba | 279 | } |
69b0a27c | 280 | |
d48ff09d | 281 | return UserModel.findOne(query) |
72c7248b C |
282 | } |
283 | ||
ce5496d6 | 284 | static getOriginalVideoFileTotalFromUser (user: UserModel) { |
3fd3ab2d | 285 | // Don't use sequelize because we need to use a sub query |
8b604880 | 286 | const query = UserModel.generateUserQuotaBaseSQL() |
bee0abff | 287 | |
8b604880 | 288 | return UserModel.getTotalRawQuery(query, user.id) |
bee0abff FA |
289 | } |
290 | ||
8b604880 | 291 | // Returns cumulative size of all video files uploaded in the last 24 hours. |
bee0abff FA |
292 | static getOriginalVideoFileTotalDailyFromUser (user: UserModel) { |
293 | // Don't use sequelize because we need to use a sub query | |
8b604880 | 294 | const query = UserModel.generateUserQuotaBaseSQL('"video"."createdAt" > now() - interval \'24 hours\'') |
68a3b9f2 | 295 | |
8b604880 | 296 | return UserModel.getTotalRawQuery(query, user.id) |
72c7248b C |
297 | } |
298 | ||
09cababd C |
299 | static async getStats () { |
300 | const totalUsers = await UserModel.count() | |
301 | ||
302 | return { | |
303 | totalUsers | |
304 | } | |
305 | } | |
306 | ||
5cf84858 C |
307 | static autoComplete (search: string) { |
308 | const query = { | |
309 | where: { | |
310 | username: { | |
311 | [ Sequelize.Op.like ]: `%${search}%` | |
312 | } | |
313 | }, | |
314 | limit: 10 | |
315 | } | |
316 | ||
317 | return UserModel.findAll(query) | |
318 | .then(u => u.map(u => u.username)) | |
319 | } | |
320 | ||
3fd3ab2d C |
321 | hasRight (right: UserRight) { |
322 | return hasUserRight(this.role, right) | |
323 | } | |
72c7248b | 324 | |
3fd3ab2d C |
325 | isPasswordMatch (password: string) { |
326 | return comparePassword(password, this.password) | |
feb4bdfd C |
327 | } |
328 | ||
c5911fd3 | 329 | toFormattedJSON (): User { |
a76138ff | 330 | const videoQuotaUsed = this.get('videoQuotaUsed') |
bee0abff | 331 | const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily') |
a76138ff | 332 | |
3fd3ab2d C |
333 | const json = { |
334 | id: this.id, | |
335 | username: this.username, | |
336 | email: this.email, | |
d9eaee39 | 337 | emailVerified: this.emailVerified, |
0883b324 | 338 | nsfwPolicy: this.nsfwPolicy, |
7efe153b | 339 | autoPlayVideo: this.autoPlayVideo, |
3fd3ab2d C |
340 | role: this.role, |
341 | roleLabel: USER_ROLE_LABELS[ this.role ], | |
342 | videoQuota: this.videoQuota, | |
bee0abff | 343 | videoQuotaDaily: this.videoQuotaDaily, |
3fd3ab2d | 344 | createdAt: this.createdAt, |
eacb25c4 C |
345 | blocked: this.blocked, |
346 | blockedReason: this.blockedReason, | |
c5911fd3 | 347 | account: this.Account.toFormattedJSON(), |
a76138ff | 348 | videoChannels: [], |
bee0abff FA |
349 | videoQuotaUsed: videoQuotaUsed !== undefined |
350 | ? parseInt(videoQuotaUsed, 10) | |
351 | : undefined, | |
352 | videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined | |
353 | ? parseInt(videoQuotaUsedDaily, 10) | |
354 | : undefined | |
3fd3ab2d C |
355 | } |
356 | ||
357 | if (Array.isArray(this.Account.VideoChannels) === true) { | |
c5911fd3 | 358 | json.videoChannels = this.Account.VideoChannels |
3fd3ab2d C |
359 | .map(c => c.toFormattedJSON()) |
360 | .sort((v1, v2) => { | |
361 | if (v1.createdAt < v2.createdAt) return -1 | |
362 | if (v1.createdAt === v2.createdAt) return 0 | |
ad4a8a1c | 363 | |
3fd3ab2d C |
364 | return 1 |
365 | }) | |
ad4a8a1c | 366 | } |
3fd3ab2d C |
367 | |
368 | return json | |
ad4a8a1c C |
369 | } |
370 | ||
bee0abff FA |
371 | async isAbleToUploadVideo (videoFile: { size: number }) { |
372 | if (this.videoQuota === -1 && this.videoQuotaDaily === -1) return Promise.resolve(true) | |
b0f9f39e | 373 | |
bee0abff FA |
374 | const [ totalBytes, totalBytesDaily ] = await Promise.all([ |
375 | UserModel.getOriginalVideoFileTotalFromUser(this), | |
376 | UserModel.getOriginalVideoFileTotalDailyFromUser(this) | |
377 | ]) | |
378 | ||
379 | const uploadedTotal = videoFile.size + totalBytes | |
380 | const uploadedDaily = videoFile.size + totalBytesDaily | |
381 | if (this.videoQuotaDaily === -1) { | |
382 | return uploadedTotal < this.videoQuota | |
383 | } | |
384 | if (this.videoQuota === -1) { | |
385 | return uploadedDaily < this.videoQuotaDaily | |
386 | } | |
387 | ||
388 | return (uploadedTotal < this.videoQuota) && | |
389 | (uploadedDaily < this.videoQuotaDaily) | |
b0f9f39e | 390 | } |
8b604880 C |
391 | |
392 | private static generateUserQuotaBaseSQL (where?: string) { | |
393 | const andWhere = where ? 'AND ' + where : '' | |
394 | ||
395 | return 'SELECT SUM("size") AS "total" ' + | |
396 | 'FROM (' + | |
397 | 'SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' + | |
398 | 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' + | |
399 | 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' + | |
400 | 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' + | |
401 | 'WHERE "account"."userId" = $userId ' + andWhere + | |
402 | 'GROUP BY "video"."id"' + | |
403 | ') t' | |
404 | } | |
405 | ||
406 | private static getTotalRawQuery (query: string, userId: number) { | |
407 | const options = { | |
408 | bind: { userId }, | |
409 | type: Sequelize.QueryTypes.SELECT | |
410 | } | |
411 | ||
412 | return UserModel.sequelize.query(query, options) | |
413 | .then(([ { total } ]) => { | |
414 | if (total === null) return 0 | |
415 | ||
416 | return parseInt(total, 10) | |
417 | }) | |
418 | } | |
b0f9f39e | 419 | } |