]>
Commit | Line | Data |
---|---|---|
fb719404 | 1 | import { Transaction } from 'sequelize/types' |
d3d3deaa C |
2 | import { logger } from '@server/helpers/logger' |
3 | import { CONFIG } from '@server/initializers/config' | |
7d9ba5c0 C |
4 | import { UserModel } from '@server/models/user/user' |
5 | import { MActorDefault } from '@server/types/models/actor' | |
50d6de9c | 6 | import { ActivityPubActorType } from '../../shared/models/activitypub' |
d3d3deaa | 7 | import { UserAdminFlag, UserNotificationSetting, UserNotificationSettingValue, UserRole } from '../../shared/models/users' |
d1ab89de | 8 | import { SERVER_ACTOR_NAME, WEBSERVER } from '../initializers/constants' |
fb719404 | 9 | import { sequelizeTypescript } from '../initializers/database' |
3fd3ab2d | 10 | import { AccountModel } from '../models/account/account' |
7d9ba5c0 C |
11 | import { UserNotificationSettingModel } from '../models/user/user-notification-setting' |
12 | import { MAccountDefault, MChannelActor } from '../types/models' | |
e364e31e | 13 | import { MRegistration, MUser, MUserDefault, MUserId } from '../types/models/user' |
136d7efd | 14 | import { generateAndSaveActorKeys } from './activitypub/actors' |
de94ac86 | 15 | import { getLocalAccountActivityPubUrl } from './activitypub/url' |
fb719404 | 16 | import { Emailer } from './emailer' |
8ebf2a5d | 17 | import { LiveQuotaStore } from './live/live-quota-store' |
0b6f5316 | 18 | import { buildActorInstance, findAvailableLocalActorName } from './local-actor' |
fb719404 C |
19 | import { Redis } from './redis' |
20 | import { createLocalVideoChannel } from './video-channel' | |
21 | import { createWatchLaterPlaylist } from './video-playlist' | |
22 | ||
e590b4a5 | 23 | type ChannelNames = { name: string, displayName: string } |
453e83ea | 24 | |
d3d3deaa C |
25 | function buildUser (options: { |
26 | username: string | |
27 | password: string | |
28 | email: string | |
29 | ||
30 | role?: UserRole // Default to UserRole.User | |
31 | adminFlags?: UserAdminFlag // Default to UserAdminFlag.NONE | |
32 | ||
33 | emailVerified: boolean | null | |
34 | ||
35 | videoQuota?: number // Default to CONFIG.USER.VIDEO_QUOTA | |
36 | videoQuotaDaily?: number // Default to CONFIG.USER.VIDEO_QUOTA_DAILY | |
37 | ||
38 | pluginAuth?: string | |
39 | }): MUser { | |
40 | const { | |
41 | username, | |
42 | password, | |
43 | email, | |
44 | role = UserRole.USER, | |
45 | emailVerified, | |
46 | videoQuota = CONFIG.USER.VIDEO_QUOTA, | |
47 | videoQuotaDaily = CONFIG.USER.VIDEO_QUOTA_DAILY, | |
48 | adminFlags = UserAdminFlag.NONE, | |
49 | pluginAuth | |
50 | } = options | |
51 | ||
52 | return new UserModel({ | |
53 | username, | |
54 | password, | |
55 | email, | |
56 | ||
57 | nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
58 | p2pEnabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED, | |
b302c80d W |
59 | videosHistoryEnabled: CONFIG.USER.HISTORY.VIDEOS.ENABLED, |
60 | ||
d3d3deaa C |
61 | autoPlayVideo: true, |
62 | ||
63 | role, | |
64 | emailVerified, | |
65 | adminFlags, | |
66 | ||
ba2684ce C |
67 | videoQuota, |
68 | videoQuotaDaily, | |
d3d3deaa C |
69 | |
70 | pluginAuth | |
71 | }) | |
72 | } | |
73 | ||
0b6f5316 C |
74 | // --------------------------------------------------------------------------- |
75 | ||
1f20622f | 76 | async function createUserAccountAndChannelAndPlaylist (parameters: { |
a1587156 C |
77 | userToCreate: MUser |
78 | userDisplayName?: string | |
79 | channelNames?: ChannelNames | |
1f20622f | 80 | validateUser?: boolean |
1ca9f7c3 | 81 | }): Promise<{ user: MUserDefault, account: MAccountDefault, videoChannel: MChannelActor }> { |
1f20622f C |
82 | const { userToCreate, userDisplayName, channelNames, validateUser = true } = parameters |
83 | ||
f05a1c30 | 84 | const { user, account, videoChannel } = await sequelizeTypescript.transaction(async t => { |
72c7248b C |
85 | const userOptions = { |
86 | transaction: t, | |
87 | validate: validateUser | |
88 | } | |
89 | ||
1ca9f7c3 | 90 | const userCreated: MUserDefault = await userToCreate.save(userOptions) |
cef534ed C |
91 | userCreated.NotificationSetting = await createDefaultUserNotificationSettings(userCreated, t) |
92 | ||
1f20622f C |
93 | const accountCreated = await createLocalAccountWithoutKeys({ |
94 | name: userCreated.username, | |
95 | displayName: userDisplayName, | |
96 | userId: userCreated.id, | |
97 | applicationId: null, | |
eae0365b | 98 | t |
1f20622f | 99 | }) |
80e36cd9 | 100 | userCreated.Account = accountCreated |
f5028693 | 101 | |
e364e31e | 102 | const channelAttributes = await buildChannelAttributes({ user: userCreated, transaction: t, channelNames }) |
1ca9f7c3 | 103 | const videoChannel = await createLocalVideoChannel(channelAttributes, accountCreated, t) |
f5028693 | 104 | |
df0b219d C |
105 | const videoPlaylist = await createWatchLaterPlaylist(accountCreated, t) |
106 | ||
107 | return { user: userCreated, account: accountCreated, videoChannel, videoPlaylist } | |
72c7248b | 108 | }) |
f5028693 | 109 | |
453e83ea | 110 | const [ accountActorWithKeys, channelActorWithKeys ] = await Promise.all([ |
8795d6f2 C |
111 | generateAndSaveActorKeys(account.Actor), |
112 | generateAndSaveActorKeys(videoChannel.Actor) | |
0b2f03d3 C |
113 | ]) |
114 | ||
453e83ea C |
115 | account.Actor = accountActorWithKeys |
116 | videoChannel.Actor = channelActorWithKeys | |
47e0652b | 117 | |
453e83ea | 118 | return { user, account, videoChannel } |
72c7248b C |
119 | } |
120 | ||
1f20622f | 121 | async function createLocalAccountWithoutKeys (parameters: { |
a1587156 C |
122 | name: string |
123 | displayName?: string | |
124 | userId: number | null | |
125 | applicationId: number | null | |
126 | t: Transaction | undefined | |
1f20622f C |
127 | type?: ActivityPubActorType |
128 | }) { | |
129 | const { name, displayName, userId, applicationId, t, type = 'Person' } = parameters | |
de94ac86 | 130 | const url = getLocalAccountActivityPubUrl(name) |
571389d4 | 131 | |
50d6de9c | 132 | const actorInstance = buildActorInstance(type, url, name) |
1ca9f7c3 | 133 | const actorInstanceCreated: MActorDefault = await actorInstance.save({ transaction: t }) |
fadf619a C |
134 | |
135 | const accountInstance = new AccountModel({ | |
1f20622f | 136 | name: displayName || name, |
571389d4 C |
137 | userId, |
138 | applicationId, | |
c39ea24b | 139 | actorId: actorInstanceCreated.id |
1735c825 | 140 | }) |
571389d4 | 141 | |
1ca9f7c3 | 142 | const accountInstanceCreated: MAccountDefault = await accountInstance.save({ transaction: t }) |
fadf619a C |
143 | accountInstanceCreated.Actor = actorInstanceCreated |
144 | ||
145 | return accountInstanceCreated | |
571389d4 C |
146 | } |
147 | ||
50d6de9c | 148 | async function createApplicationActor (applicationId: number) { |
1f20622f C |
149 | const accountCreated = await createLocalAccountWithoutKeys({ |
150 | name: SERVER_ACTOR_NAME, | |
151 | userId: null, | |
ba2684ce | 152 | applicationId, |
1f20622f C |
153 | t: undefined, |
154 | type: 'Application' | |
155 | }) | |
50d6de9c | 156 | |
8795d6f2 | 157 | accountCreated.Actor = await generateAndSaveActorKeys(accountCreated.Actor) |
50d6de9c C |
158 | |
159 | return accountCreated | |
160 | } | |
161 | ||
0b6f5316 C |
162 | // --------------------------------------------------------------------------- |
163 | ||
453e83ea | 164 | async function sendVerifyUserEmail (user: MUser, isPendingEmail = false) { |
e364e31e C |
165 | const verificationString = await Redis.Instance.setUserVerifyEmailVerificationString(user.id) |
166 | let verifyEmailUrl = `${WEBSERVER.URL}/verify-account/email?userId=${user.id}&verificationString=${verificationString}` | |
d1ab89de | 167 | |
e364e31e C |
168 | if (isPendingEmail) verifyEmailUrl += '&isPendingEmail=true' |
169 | ||
170 | const to = isPendingEmail | |
171 | ? user.pendingEmail | |
172 | : user.email | |
d1ab89de | 173 | |
963023ab | 174 | const username = user.username |
d1ab89de | 175 | |
e364e31e C |
176 | Emailer.Instance.addVerifyEmailJob({ username, to, verifyEmailUrl, isRegistrationRequest: false }) |
177 | } | |
178 | ||
179 | async function sendVerifyRegistrationEmail (registration: MRegistration) { | |
180 | const verificationString = await Redis.Instance.setRegistrationVerifyEmailVerificationString(registration.id) | |
181 | const verifyEmailUrl = `${WEBSERVER.URL}/verify-account/email?registrationId=${registration.id}&verificationString=${verificationString}` | |
182 | ||
183 | const to = registration.email | |
184 | const username = registration.username | |
185 | ||
186 | Emailer.Instance.addVerifyEmailJob({ username, to, verifyEmailUrl, isRegistrationRequest: true }) | |
d1ab89de C |
187 | } |
188 | ||
0b6f5316 C |
189 | // --------------------------------------------------------------------------- |
190 | ||
fb719404 C |
191 | async function getOriginalVideoFileTotalFromUser (user: MUserId) { |
192 | // Don't use sequelize because we need to use a sub query | |
193 | const query = UserModel.generateUserQuotaBaseSQL({ | |
194 | withSelect: true, | |
9a82ce24 C |
195 | whereUserId: '$userId', |
196 | daily: false | |
fb719404 C |
197 | }) |
198 | ||
199 | const base = await UserModel.getTotalRawQuery(query, user.id) | |
200 | ||
8ebf2a5d | 201 | return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id) |
fb719404 C |
202 | } |
203 | ||
204 | // Returns cumulative size of all video files uploaded in the last 24 hours. | |
205 | async function getOriginalVideoFileTotalDailyFromUser (user: MUserId) { | |
206 | // Don't use sequelize because we need to use a sub query | |
207 | const query = UserModel.generateUserQuotaBaseSQL({ | |
208 | withSelect: true, | |
209 | whereUserId: '$userId', | |
9a82ce24 | 210 | daily: true |
fb719404 C |
211 | }) |
212 | ||
213 | const base = await UserModel.getTotalRawQuery(query, user.id) | |
214 | ||
8ebf2a5d | 215 | return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id) |
fb719404 C |
216 | } |
217 | ||
8ebf2a5d | 218 | async function isAbleToUploadVideo (userId: number, newVideoSize: number) { |
fb719404 C |
219 | const user = await UserModel.loadById(userId) |
220 | ||
221 | if (user.videoQuota === -1 && user.videoQuotaDaily === -1) return Promise.resolve(true) | |
222 | ||
223 | const [ totalBytes, totalBytesDaily ] = await Promise.all([ | |
97969c4e C |
224 | getOriginalVideoFileTotalFromUser(user), |
225 | getOriginalVideoFileTotalDailyFromUser(user) | |
fb719404 C |
226 | ]) |
227 | ||
8ebf2a5d C |
228 | const uploadedTotal = newVideoSize + totalBytes |
229 | const uploadedDaily = newVideoSize + totalBytesDaily | |
fb719404 | 230 | |
c729caf6 C |
231 | logger.debug( |
232 | 'Check user %d quota to upload another video.', userId, | |
233 | { totalBytes, totalBytesDaily, videoQuota: user.videoQuota, videoQuotaDaily: user.videoQuotaDaily, newVideoSize } | |
234 | ) | |
235 | ||
fb719404 C |
236 | if (user.videoQuotaDaily === -1) return uploadedTotal < user.videoQuota |
237 | if (user.videoQuota === -1) return uploadedDaily < user.videoQuotaDaily | |
238 | ||
239 | return uploadedTotal < user.videoQuota && uploadedDaily < user.videoQuotaDaily | |
240 | } | |
241 | ||
72c7248b C |
242 | // --------------------------------------------------------------------------- |
243 | ||
244 | export { | |
fb719404 C |
245 | getOriginalVideoFileTotalFromUser, |
246 | getOriginalVideoFileTotalDailyFromUser, | |
50d6de9c | 247 | createApplicationActor, |
df0b219d | 248 | createUserAccountAndChannelAndPlaylist, |
d1ab89de | 249 | createLocalAccountWithoutKeys, |
e364e31e | 250 | |
fb719404 | 251 | sendVerifyUserEmail, |
e364e31e C |
252 | sendVerifyRegistrationEmail, |
253 | ||
d3d3deaa C |
254 | isAbleToUploadVideo, |
255 | buildUser | |
72c7248b | 256 | } |
cef534ed C |
257 | |
258 | // --------------------------------------------------------------------------- | |
259 | ||
453e83ea | 260 | function createDefaultUserNotificationSettings (user: MUserId, t: Transaction | undefined) { |
f7cc67b4 | 261 | const values: UserNotificationSetting & { userId: number } = { |
cef534ed | 262 | userId: user.id, |
2f1548fd C |
263 | newVideoFromSubscription: UserNotificationSettingValue.WEB, |
264 | newCommentOnMyVideo: UserNotificationSettingValue.WEB, | |
265 | myVideoImportFinished: UserNotificationSettingValue.WEB, | |
266 | myVideoPublished: UserNotificationSettingValue.WEB, | |
4f32032f | 267 | abuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, |
7ccddd7b | 268 | videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, |
2f1548fd C |
269 | blacklistOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, |
270 | newUserRegistration: UserNotificationSettingValue.WEB, | |
271 | commentMention: UserNotificationSettingValue.WEB, | |
883993c8 | 272 | newFollow: UserNotificationSettingValue.WEB, |
8424c402 | 273 | newInstanceFollower: UserNotificationSettingValue.WEB, |
594d3e48 C |
274 | abuseNewMessage: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, |
275 | abuseStateChange: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, | |
32a18cbf C |
276 | autoInstanceFollowing: UserNotificationSettingValue.WEB, |
277 | newPeerTubeVersion: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, | |
1808a1f8 | 278 | newPluginVersion: UserNotificationSettingValue.WEB, |
92e66e04 | 279 | myVideoStudioEditionFinished: UserNotificationSettingValue.WEB |
f7cc67b4 C |
280 | } |
281 | ||
282 | return UserNotificationSettingModel.create(values, { transaction: t }) | |
cef534ed | 283 | } |
e590b4a5 | 284 | |
e364e31e C |
285 | async function buildChannelAttributes (options: { |
286 | user: MUser | |
287 | transaction?: Transaction | |
288 | channelNames?: ChannelNames | |
289 | }) { | |
290 | const { user, transaction, channelNames } = options | |
291 | ||
e590b4a5 C |
292 | if (channelNames) return channelNames |
293 | ||
0b6f5316 | 294 | const channelName = await findAvailableLocalActorName(user.username + '_channel', transaction) |
e590b4a5 C |
295 | const videoChannelDisplayName = `Main ${user.username} channel` |
296 | ||
297 | return { | |
298 | name: channelName, | |
299 | displayName: videoChannelDisplayName | |
300 | } | |
301 | } |