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