]>
Commit | Line | Data |
---|---|---|
e02643f3 | 1 | import * as Sequelize from 'sequelize' |
3fd3ab2d | 2 | import { |
50d6de9c C |
3 | AllowNull, BeforeCreate, BeforeUpdate, Column, CreatedAt, DataType, Default, DefaultScope, HasMany, HasOne, Is, IsEmail, Model, |
4 | Scopes, Table, UpdatedAt | |
3fd3ab2d | 5 | } from 'sequelize-typescript' |
e34c85e5 | 6 | import { hasUserRight, USER_ROLE_LABELS, UserRight } from '../../../shared' |
ba75d268 | 7 | import { User, UserRole } from '../../../shared/models/users' |
65fcc311 | 8 | import { |
50d6de9c C |
9 | isUserAutoPlayVideoValid, isUserDisplayNSFWValid, isUserPasswordValid, isUserRoleValid, isUserUsernameValid, |
10 | isUserVideoQuotaValid | |
3fd3ab2d | 11 | } from '../../helpers/custom-validators/users' |
da854ddd | 12 | import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto' |
3fd3ab2d C |
13 | import { OAuthTokenModel } from '../oauth/oauth-token' |
14 | import { getSort, throwIfNotValid } from '../utils' | |
15 | import { VideoChannelModel } from '../video/video-channel' | |
09cababd | 16 | import { VideoCommentModel } from '../video/video-comment' |
3fd3ab2d C |
17 | import { AccountModel } from './account' |
18 | ||
d48ff09d C |
19 | @DefaultScope({ |
20 | include: [ | |
21 | { | |
22 | model: () => AccountModel, | |
23 | required: true | |
24 | } | |
25 | ] | |
26 | }) | |
27 | @Scopes({ | |
28 | withVideoChannel: { | |
29 | include: [ | |
30 | { | |
31 | model: () => AccountModel, | |
32 | required: true, | |
33 | include: [ () => VideoChannelModel ] | |
34 | } | |
35 | ] | |
36 | } | |
37 | }) | |
3fd3ab2d C |
38 | @Table({ |
39 | tableName: 'user', | |
40 | indexes: [ | |
feb4bdfd | 41 | { |
3fd3ab2d C |
42 | fields: [ 'username' ], |
43 | unique: true | |
feb4bdfd C |
44 | }, |
45 | { | |
3fd3ab2d C |
46 | fields: [ 'email' ], |
47 | unique: true | |
feb4bdfd | 48 | } |
e02643f3 | 49 | ] |
3fd3ab2d C |
50 | }) |
51 | export class UserModel extends Model<UserModel> { | |
52 | ||
53 | @AllowNull(false) | |
54 | @Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password')) | |
55 | @Column | |
56 | password: string | |
57 | ||
58 | @AllowNull(false) | |
59 | @Is('UserPassword', value => throwIfNotValid(value, isUserUsernameValid, 'user name')) | |
60 | @Column | |
61 | username: string | |
62 | ||
63 | @AllowNull(false) | |
64 | @IsEmail | |
65 | @Column(DataType.STRING(400)) | |
66 | email: string | |
67 | ||
68 | @AllowNull(false) | |
69 | @Default(false) | |
70 | @Is('UserDisplayNSFW', value => throwIfNotValid(value, isUserDisplayNSFWValid, 'display NSFW boolean')) | |
71 | @Column | |
72 | displayNSFW: boolean | |
73 | ||
7efe153b AL |
74 | @AllowNull(false) |
75 | @Default(true) | |
76 | @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean')) | |
77 | @Column | |
78 | autoPlayVideo: boolean | |
79 | ||
3fd3ab2d C |
80 | @AllowNull(false) |
81 | @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role')) | |
82 | @Column | |
83 | role: number | |
84 | ||
85 | @AllowNull(false) | |
86 | @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota')) | |
87 | @Column(DataType.BIGINT) | |
88 | videoQuota: number | |
89 | ||
90 | @CreatedAt | |
91 | createdAt: Date | |
92 | ||
93 | @UpdatedAt | |
94 | updatedAt: Date | |
95 | ||
96 | @HasOne(() => AccountModel, { | |
97 | foreignKey: 'userId', | |
f05a1c30 C |
98 | onDelete: 'cascade', |
99 | hooks: true | |
3fd3ab2d C |
100 | }) |
101 | Account: AccountModel | |
69b0a27c | 102 | |
3fd3ab2d C |
103 | @HasMany(() => OAuthTokenModel, { |
104 | foreignKey: 'userId', | |
105 | onDelete: 'cascade' | |
106 | }) | |
107 | OAuthTokens: OAuthTokenModel[] | |
108 | ||
109 | @BeforeCreate | |
110 | @BeforeUpdate | |
111 | static cryptPasswordIfNeeded (instance: UserModel) { | |
112 | if (instance.changed('password')) { | |
113 | return cryptPassword(instance.password) | |
114 | .then(hash => { | |
115 | instance.password = hash | |
116 | return undefined | |
117 | }) | |
118 | } | |
59557c46 | 119 | } |
26d7d31b | 120 | |
3fd3ab2d C |
121 | static countTotal () { |
122 | return this.count() | |
123 | } | |
954605a8 | 124 | |
3fd3ab2d C |
125 | static listForApi (start: number, count: number, sort: string) { |
126 | const query = { | |
127 | offset: start, | |
128 | limit: count, | |
6ff9c676 | 129 | order: getSort(sort) |
3fd3ab2d | 130 | } |
72c7248b | 131 | |
3fd3ab2d C |
132 | return UserModel.findAndCountAll(query) |
133 | .then(({ rows, count }) => { | |
134 | return { | |
135 | data: rows, | |
136 | total: count | |
137 | } | |
72c7248b | 138 | }) |
72c7248b C |
139 | } |
140 | ||
ba75d268 C |
141 | static listEmailsWithRight (right: UserRight) { |
142 | const roles = Object.keys(USER_ROLE_LABELS) | |
143 | .map(k => parseInt(k, 10) as UserRole) | |
144 | .filter(role => hasUserRight(role, right)) | |
145 | ||
146 | console.log(roles) | |
147 | ||
148 | const query = { | |
149 | attribute: [ 'email' ], | |
150 | where: { | |
151 | role: { | |
152 | [Sequelize.Op.in]: roles | |
153 | } | |
154 | } | |
155 | } | |
156 | ||
157 | return UserModel.unscoped() | |
158 | .findAll(query) | |
159 | .then(u => u.map(u => u.email)) | |
160 | } | |
161 | ||
3fd3ab2d | 162 | static loadById (id: number) { |
d48ff09d | 163 | return UserModel.findById(id) |
3fd3ab2d | 164 | } |
feb4bdfd | 165 | |
3fd3ab2d C |
166 | static loadByUsername (username: string) { |
167 | const query = { | |
168 | where: { | |
169 | username | |
d48ff09d | 170 | } |
3fd3ab2d | 171 | } |
089ff2f2 | 172 | |
3fd3ab2d | 173 | return UserModel.findOne(query) |
feb4bdfd C |
174 | } |
175 | ||
3fd3ab2d C |
176 | static loadByUsernameAndPopulateChannels (username: string) { |
177 | const query = { | |
178 | where: { | |
179 | username | |
d48ff09d | 180 | } |
3fd3ab2d | 181 | } |
9bd26629 | 182 | |
d48ff09d | 183 | return UserModel.scope('withVideoChannel').findOne(query) |
feb4bdfd C |
184 | } |
185 | ||
ecb4e35f C |
186 | static loadByEmail (email: string) { |
187 | const query = { | |
188 | where: { | |
189 | ||
190 | } | |
191 | } | |
192 | ||
193 | return UserModel.findOne(query) | |
194 | } | |
195 | ||
ba12e8b3 C |
196 | static loadByUsernameOrEmail (username: string, email?: string) { |
197 | if (!email) email = username | |
198 | ||
3fd3ab2d | 199 | const query = { |
3fd3ab2d C |
200 | where: { |
201 | [ Sequelize.Op.or ]: [ { username }, { email } ] | |
202 | } | |
6fcd19ba | 203 | } |
69b0a27c | 204 | |
d48ff09d | 205 | return UserModel.findOne(query) |
72c7248b C |
206 | } |
207 | ||
ce5496d6 | 208 | static getOriginalVideoFileTotalFromUser (user: UserModel) { |
3fd3ab2d C |
209 | // Don't use sequelize because we need to use a sub query |
210 | const query = 'SELECT SUM("size") AS "total" FROM ' + | |
211 | '(SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' + | |
212 | 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' + | |
213 | 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' + | |
214 | 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' + | |
215 | 'INNER JOIN "user" ON "account"."userId" = "user"."id" ' + | |
216 | 'WHERE "user"."id" = $userId GROUP BY "video"."id") t' | |
217 | ||
218 | const options = { | |
219 | bind: { userId: user.id }, | |
220 | type: Sequelize.QueryTypes.SELECT | |
221 | } | |
222 | return UserModel.sequelize.query(query, options) | |
223 | .then(([ { total } ]) => { | |
224 | if (total === null) return 0 | |
68a3b9f2 | 225 | |
3fd3ab2d C |
226 | return parseInt(total, 10) |
227 | }) | |
72c7248b C |
228 | } |
229 | ||
09cababd C |
230 | static async getStats () { |
231 | const totalUsers = await UserModel.count() | |
232 | ||
233 | return { | |
234 | totalUsers | |
235 | } | |
236 | } | |
237 | ||
3fd3ab2d C |
238 | hasRight (right: UserRight) { |
239 | return hasUserRight(this.role, right) | |
240 | } | |
72c7248b | 241 | |
3fd3ab2d C |
242 | isPasswordMatch (password: string) { |
243 | return comparePassword(password, this.password) | |
feb4bdfd C |
244 | } |
245 | ||
c5911fd3 | 246 | toFormattedJSON (): User { |
3fd3ab2d C |
247 | const json = { |
248 | id: this.id, | |
249 | username: this.username, | |
250 | email: this.email, | |
251 | displayNSFW: this.displayNSFW, | |
7efe153b | 252 | autoPlayVideo: this.autoPlayVideo, |
3fd3ab2d C |
253 | role: this.role, |
254 | roleLabel: USER_ROLE_LABELS[ this.role ], | |
255 | videoQuota: this.videoQuota, | |
256 | createdAt: this.createdAt, | |
c5911fd3 C |
257 | account: this.Account.toFormattedJSON(), |
258 | videoChannels: [] | |
3fd3ab2d C |
259 | } |
260 | ||
261 | if (Array.isArray(this.Account.VideoChannels) === true) { | |
c5911fd3 | 262 | json.videoChannels = this.Account.VideoChannels |
3fd3ab2d C |
263 | .map(c => c.toFormattedJSON()) |
264 | .sort((v1, v2) => { | |
265 | if (v1.createdAt < v2.createdAt) return -1 | |
266 | if (v1.createdAt === v2.createdAt) return 0 | |
ad4a8a1c | 267 | |
3fd3ab2d C |
268 | return 1 |
269 | }) | |
ad4a8a1c | 270 | } |
3fd3ab2d C |
271 | |
272 | return json | |
ad4a8a1c C |
273 | } |
274 | ||
3fd3ab2d C |
275 | isAbleToUploadVideo (videoFile: Express.Multer.File) { |
276 | if (this.videoQuota === -1) return Promise.resolve(true) | |
b0f9f39e | 277 | |
3fd3ab2d C |
278 | return UserModel.getOriginalVideoFileTotalFromUser(this) |
279 | .then(totalBytes => { | |
280 | return (videoFile.size + totalBytes) < this.videoQuota | |
281 | }) | |
b0f9f39e | 282 | } |
b0f9f39e | 283 | } |