X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fuser.ts;h=ffb57944a3bccbc1ebb941a0a49d26ed466fb24a;hb=a2be43f5700460d3afdc194abc788690b79e66cd;hp=5588b0f7695a0b333b9cea391e5b0978b2b117fb;hpb=7ccddd7b5250bd25a917a6e77e58b87b9484a2a4;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/user.ts b/server/lib/user.ts index 5588b0f76..ffb57944a 100644 --- a/server/lib/user.ts +++ b/server/lib/user.ts @@ -1,117 +1,299 @@ -import * as Sequelize from 'sequelize' -import * as uuidv4 from 'uuid/v4' +import { Transaction } from 'sequelize/types' +import { logger } from '@server/helpers/logger' +import { CONFIG } from '@server/initializers/config' +import { UserModel } from '@server/models/user/user' +import { MActorDefault } from '@server/types/models/actor' import { ActivityPubActorType } from '../../shared/models/activitypub' -import { sequelizeTypescript, SERVER_ACTOR_NAME } from '../initializers' +import { UserAdminFlag, UserNotificationSetting, UserNotificationSettingValue, UserRole } from '../../shared/models/users' +import { SERVER_ACTOR_NAME, WEBSERVER } from '../initializers/constants' +import { sequelizeTypescript } from '../initializers/database' import { AccountModel } from '../models/account/account' -import { UserModel } from '../models/account/user' -import { buildActorInstance, getAccountActivityPubUrl, setAsyncActorKeys } from './activitypub' -import { createVideoChannel } from './video-channel' -import { VideoChannelModel } from '../models/video/video-channel' -import { FilteredModelAttributes } from 'sequelize-typescript/lib/models/Model' -import { ActorModel } from '../models/activitypub/actor' -import { UserNotificationSettingModel } from '../models/account/user-notification-setting' -import { UserNotificationSetting, UserNotificationSettingValue } from '../../shared/models/users' +import { UserNotificationSettingModel } from '../models/user/user-notification-setting' +import { MAccountDefault, MChannelActor } from '../types/models' +import { MRegistration, MUser, MUserDefault, MUserId } from '../types/models/user' +import { generateAndSaveActorKeys } from './activitypub/actors' +import { getLocalAccountActivityPubUrl } from './activitypub/url' +import { Emailer } from './emailer' +import { LiveQuotaStore } from './live/live-quota-store' +import { buildActorInstance, findAvailableLocalActorName } from './local-actor' +import { Redis } from './redis' +import { createLocalVideoChannel } from './video-channel' import { createWatchLaterPlaylist } from './video-playlist' -async function createUserAccountAndChannelAndPlaylist (userToCreate: UserModel, validateUser = true) { +type ChannelNames = { name: string, displayName: string } + +function buildUser (options: { + username: string + password: string + email: string + + role?: UserRole // Default to UserRole.User + adminFlags?: UserAdminFlag // Default to UserAdminFlag.NONE + + emailVerified: boolean | null + + videoQuota?: number // Default to CONFIG.USER.VIDEO_QUOTA + videoQuotaDaily?: number // Default to CONFIG.USER.VIDEO_QUOTA_DAILY + + pluginAuth?: string +}): MUser { + const { + username, + password, + email, + role = UserRole.USER, + emailVerified, + videoQuota = CONFIG.USER.VIDEO_QUOTA, + videoQuotaDaily = CONFIG.USER.VIDEO_QUOTA_DAILY, + adminFlags = UserAdminFlag.NONE, + pluginAuth + } = options + + return new UserModel({ + username, + password, + email, + + nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, + p2pEnabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED, + autoPlayVideo: true, + + role, + emailVerified, + adminFlags, + + videoQuota, + videoQuotaDaily, + + pluginAuth + }) +} + +// --------------------------------------------------------------------------- + +async function createUserAccountAndChannelAndPlaylist (parameters: { + userToCreate: MUser + userDisplayName?: string + channelNames?: ChannelNames + validateUser?: boolean +}): Promise<{ user: MUserDefault, account: MAccountDefault, videoChannel: MChannelActor }> { + const { userToCreate, userDisplayName, channelNames, validateUser = true } = parameters + const { user, account, videoChannel } = await sequelizeTypescript.transaction(async t => { const userOptions = { transaction: t, validate: validateUser } - const userCreated = await userToCreate.save(userOptions) + const userCreated: MUserDefault = await userToCreate.save(userOptions) userCreated.NotificationSetting = await createDefaultUserNotificationSettings(userCreated, t) - const accountCreated = await createLocalAccountWithoutKeys(userCreated.username, userCreated.id, null, t) + const accountCreated = await createLocalAccountWithoutKeys({ + name: userCreated.username, + displayName: userDisplayName, + userId: userCreated.id, + applicationId: null, + t + }) userCreated.Account = accountCreated - let channelName = userCreated.username + '_channel' - - // Conflict, generate uuid instead - const actor = await ActorModel.loadLocalByName(channelName) - if (actor) channelName = uuidv4() - - const videoChannelDisplayName = `Main ${userCreated.username} channel` - const videoChannelInfo = { - name: channelName, - displayName: videoChannelDisplayName - } - const videoChannel = await createVideoChannel(videoChannelInfo, accountCreated, t) + const channelAttributes = await buildChannelAttributes({ user: userCreated, transaction: t, channelNames }) + const videoChannel = await createLocalVideoChannel(channelAttributes, accountCreated, t) const videoPlaylist = await createWatchLaterPlaylist(accountCreated, t) return { user: userCreated, account: accountCreated, videoChannel, videoPlaylist } }) - const [ accountKeys, channelKeys ] = await Promise.all([ - setAsyncActorKeys(account.Actor), - setAsyncActorKeys(videoChannel.Actor) + const [ accountActorWithKeys, channelActorWithKeys ] = await Promise.all([ + generateAndSaveActorKeys(account.Actor), + generateAndSaveActorKeys(videoChannel.Actor) ]) - account.Actor = accountKeys - videoChannel.Actor = channelKeys + account.Actor = accountActorWithKeys + videoChannel.Actor = channelActorWithKeys - return { user, account, videoChannel } as { user: UserModel, account: AccountModel, videoChannel: VideoChannelModel } + return { user, account, videoChannel } } -async function createLocalAccountWithoutKeys ( - name: string, - userId: number | null, - applicationId: number | null, - t: Sequelize.Transaction | undefined, - type: ActivityPubActorType= 'Person' -) { - const url = getAccountActivityPubUrl(name) +async function createLocalAccountWithoutKeys (parameters: { + name: string + displayName?: string + userId: number | null + applicationId: number | null + t: Transaction | undefined + type?: ActivityPubActorType +}) { + const { name, displayName, userId, applicationId, t, type = 'Person' } = parameters + const url = getLocalAccountActivityPubUrl(name) const actorInstance = buildActorInstance(type, url, name) - const actorInstanceCreated = await actorInstance.save({ transaction: t }) + const actorInstanceCreated: MActorDefault = await actorInstance.save({ transaction: t }) const accountInstance = new AccountModel({ - name, + name: displayName || name, userId, applicationId, actorId: actorInstanceCreated.id - } as FilteredModelAttributes) + }) - const accountInstanceCreated = await accountInstance.save({ transaction: t }) + const accountInstanceCreated: MAccountDefault = await accountInstance.save({ transaction: t }) accountInstanceCreated.Actor = actorInstanceCreated return accountInstanceCreated } async function createApplicationActor (applicationId: number) { - const accountCreated = await createLocalAccountWithoutKeys(SERVER_ACTOR_NAME, null, applicationId, undefined, 'Application') + const accountCreated = await createLocalAccountWithoutKeys({ + name: SERVER_ACTOR_NAME, + userId: null, + applicationId, + t: undefined, + type: 'Application' + }) - accountCreated.Actor = await setAsyncActorKeys(accountCreated.Actor) + accountCreated.Actor = await generateAndSaveActorKeys(accountCreated.Actor) return accountCreated } // --------------------------------------------------------------------------- +async function sendVerifyUserEmail (user: MUser, isPendingEmail = false) { + const verificationString = await Redis.Instance.setUserVerifyEmailVerificationString(user.id) + let verifyEmailUrl = `${WEBSERVER.URL}/verify-account/email?userId=${user.id}&verificationString=${verificationString}` + + if (isPendingEmail) verifyEmailUrl += '&isPendingEmail=true' + + const to = isPendingEmail + ? user.pendingEmail + : user.email + + const username = user.username + + Emailer.Instance.addVerifyEmailJob({ username, to, verifyEmailUrl, isRegistrationRequest: false }) +} + +async function sendVerifyRegistrationEmail (registration: MRegistration) { + const verificationString = await Redis.Instance.setRegistrationVerifyEmailVerificationString(registration.id) + const verifyEmailUrl = `${WEBSERVER.URL}/verify-account/email?registrationId=${registration.id}&verificationString=${verificationString}` + + const to = registration.email + const username = registration.username + + Emailer.Instance.addVerifyEmailJob({ username, to, verifyEmailUrl, isRegistrationRequest: true }) +} + +// --------------------------------------------------------------------------- + +async function getOriginalVideoFileTotalFromUser (user: MUserId) { + // Don't use sequelize because we need to use a sub query + const query = UserModel.generateUserQuotaBaseSQL({ + withSelect: true, + whereUserId: '$userId', + daily: false + }) + + const base = await UserModel.getTotalRawQuery(query, user.id) + + return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id) +} + +// Returns cumulative size of all video files uploaded in the last 24 hours. +async function getOriginalVideoFileTotalDailyFromUser (user: MUserId) { + // Don't use sequelize because we need to use a sub query + const query = UserModel.generateUserQuotaBaseSQL({ + withSelect: true, + whereUserId: '$userId', + daily: true + }) + + const base = await UserModel.getTotalRawQuery(query, user.id) + + return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id) +} + +async function isAbleToUploadVideo (userId: number, newVideoSize: number) { + const user = await UserModel.loadById(userId) + + if (user.videoQuota === -1 && user.videoQuotaDaily === -1) return Promise.resolve(true) + + const [ totalBytes, totalBytesDaily ] = await Promise.all([ + getOriginalVideoFileTotalFromUser(user), + getOriginalVideoFileTotalDailyFromUser(user) + ]) + + const uploadedTotal = newVideoSize + totalBytes + const uploadedDaily = newVideoSize + totalBytesDaily + + logger.debug( + 'Check user %d quota to upload another video.', userId, + { totalBytes, totalBytesDaily, videoQuota: user.videoQuota, videoQuotaDaily: user.videoQuotaDaily, newVideoSize } + ) + + if (user.videoQuotaDaily === -1) return uploadedTotal < user.videoQuota + if (user.videoQuota === -1) return uploadedDaily < user.videoQuotaDaily + + return uploadedTotal < user.videoQuota && uploadedDaily < user.videoQuotaDaily +} + +// --------------------------------------------------------------------------- + export { + getOriginalVideoFileTotalFromUser, + getOriginalVideoFileTotalDailyFromUser, createApplicationActor, createUserAccountAndChannelAndPlaylist, - createLocalAccountWithoutKeys + createLocalAccountWithoutKeys, + + sendVerifyUserEmail, + sendVerifyRegistrationEmail, + + isAbleToUploadVideo, + buildUser } // --------------------------------------------------------------------------- -function createDefaultUserNotificationSettings (user: UserModel, t: Sequelize.Transaction | undefined) { +function createDefaultUserNotificationSettings (user: MUserId, t: Transaction | undefined) { const values: UserNotificationSetting & { userId: number } = { userId: user.id, newVideoFromSubscription: UserNotificationSettingValue.WEB, newCommentOnMyVideo: UserNotificationSettingValue.WEB, myVideoImportFinished: UserNotificationSettingValue.WEB, myVideoPublished: UserNotificationSettingValue.WEB, - videoAbuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, + abuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, blacklistOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, newUserRegistration: UserNotificationSettingValue.WEB, commentMention: UserNotificationSettingValue.WEB, - newFollow: UserNotificationSettingValue.WEB + newFollow: UserNotificationSettingValue.WEB, + newInstanceFollower: UserNotificationSettingValue.WEB, + abuseNewMessage: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, + abuseStateChange: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, + autoInstanceFollowing: UserNotificationSettingValue.WEB, + newPeerTubeVersion: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL, + newPluginVersion: UserNotificationSettingValue.WEB, + myVideoStudioEditionFinished: UserNotificationSettingValue.WEB } return UserNotificationSettingModel.create(values, { transaction: t }) } + +async function buildChannelAttributes (options: { + user: MUser + transaction?: Transaction + channelNames?: ChannelNames +}) { + const { user, transaction, channelNames } = options + + if (channelNames) return channelNames + + const channelName = await findAvailableLocalActorName(user.username + '_channel', transaction) + const videoChannelDisplayName = `Main ${user.username} channel` + + return { + name: channelName, + displayName: videoChannelDisplayName + } +}