2023-07-31 07:34:36 -05:00
|
|
|
import { Transaction } from 'sequelize'
|
|
|
|
import {
|
|
|
|
ActivityPubActorType,
|
|
|
|
UserAdminFlag,
|
|
|
|
UserAdminFlagType,
|
|
|
|
UserNotificationSetting,
|
|
|
|
UserNotificationSettingValue,
|
|
|
|
UserRole,
|
|
|
|
UserRoleType
|
|
|
|
} from '@peertube/peertube-models'
|
|
|
|
import { logger } from '@server/helpers/logger.js'
|
|
|
|
import { CONFIG } from '@server/initializers/config.js'
|
|
|
|
import { UserModel } from '@server/models/user/user.js'
|
|
|
|
import { MActorDefault } from '@server/types/models/actor/index.js'
|
|
|
|
import { SERVER_ACTOR_NAME, WEBSERVER } from '../initializers/constants.js'
|
|
|
|
import { sequelizeTypescript } from '../initializers/database.js'
|
|
|
|
import { AccountModel } from '../models/account/account.js'
|
|
|
|
import { UserNotificationSettingModel } from '../models/user/user-notification-setting.js'
|
|
|
|
import { MAccountDefault, MChannelActor } from '../types/models/index.js'
|
|
|
|
import { MRegistration, MUser, MUserDefault, MUserId } from '../types/models/user/index.js'
|
|
|
|
import { generateAndSaveActorKeys } from './activitypub/actors/index.js'
|
|
|
|
import { getLocalAccountActivityPubUrl } from './activitypub/url.js'
|
|
|
|
import { Emailer } from './emailer.js'
|
|
|
|
import { LiveQuotaStore } from './live/live-quota-store.js'
|
|
|
|
import { buildActorInstance, findAvailableLocalActorName } from './local-actor.js'
|
|
|
|
import { Redis } from './redis.js'
|
|
|
|
import { createLocalVideoChannel } from './video-channel.js'
|
|
|
|
import { createWatchLaterPlaylist } from './video-playlist.js'
|
2020-09-25 09:19:35 -05:00
|
|
|
|
2019-05-28 03:46:32 -05:00
|
|
|
type ChannelNames = { name: string, displayName: string }
|
2019-08-15 04:53:26 -05:00
|
|
|
|
2022-03-04 03:57:36 -06:00
|
|
|
function buildUser (options: {
|
|
|
|
username: string
|
|
|
|
password: string
|
|
|
|
email: string
|
|
|
|
|
2023-07-31 07:34:36 -05:00
|
|
|
role?: UserRoleType // Default to UserRole.User
|
|
|
|
adminFlags?: UserAdminFlagType // Default to UserAdminFlag.NONE
|
2022-03-04 03:57:36 -06:00
|
|
|
|
|
|
|
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,
|
2023-04-07 03:09:54 -05:00
|
|
|
videosHistoryEnabled: CONFIG.USER.HISTORY.VIDEOS.ENABLED,
|
|
|
|
|
2022-03-04 03:57:36 -06:00
|
|
|
autoPlayVideo: true,
|
|
|
|
|
|
|
|
role,
|
|
|
|
emailVerified,
|
|
|
|
adminFlags,
|
|
|
|
|
2022-07-13 04:58:01 -05:00
|
|
|
videoQuota,
|
|
|
|
videoQuotaDaily,
|
2022-03-04 03:57:36 -06:00
|
|
|
|
|
|
|
pluginAuth
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2022-08-03 03:10:26 -05:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2019-06-07 09:59:53 -05:00
|
|
|
async function createUserAccountAndChannelAndPlaylist (parameters: {
|
2020-01-31 09:56:52 -06:00
|
|
|
userToCreate: MUser
|
|
|
|
userDisplayName?: string
|
|
|
|
channelNames?: ChannelNames
|
2019-06-07 09:59:53 -05:00
|
|
|
validateUser?: boolean
|
2019-08-20 12:05:31 -05:00
|
|
|
}): Promise<{ user: MUserDefault, account: MAccountDefault, videoChannel: MChannelActor }> {
|
2019-06-07 09:59:53 -05:00
|
|
|
const { userToCreate, userDisplayName, channelNames, validateUser = true } = parameters
|
|
|
|
|
2018-01-18 03:53:54 -06:00
|
|
|
const { user, account, videoChannel } = await sequelizeTypescript.transaction(async t => {
|
2017-10-24 12:41:09 -05:00
|
|
|
const userOptions = {
|
|
|
|
transaction: t,
|
|
|
|
validate: validateUser
|
|
|
|
}
|
|
|
|
|
2019-08-20 12:05:31 -05:00
|
|
|
const userCreated: MUserDefault = await userToCreate.save(userOptions)
|
2018-12-26 03:36:24 -06:00
|
|
|
userCreated.NotificationSetting = await createDefaultUserNotificationSettings(userCreated, t)
|
|
|
|
|
2019-06-07 09:59:53 -05:00
|
|
|
const accountCreated = await createLocalAccountWithoutKeys({
|
|
|
|
name: userCreated.username,
|
|
|
|
displayName: userDisplayName,
|
|
|
|
userId: userCreated.id,
|
|
|
|
applicationId: null,
|
2021-06-15 02:17:19 -05:00
|
|
|
t
|
2019-06-07 09:59:53 -05:00
|
|
|
})
|
2018-07-31 07:04:26 -05:00
|
|
|
userCreated.Account = accountCreated
|
2017-10-25 09:03:33 -05:00
|
|
|
|
2023-01-19 02:27:16 -06:00
|
|
|
const channelAttributes = await buildChannelAttributes({ user: userCreated, transaction: t, channelNames })
|
2019-08-20 12:05:31 -05:00
|
|
|
const videoChannel = await createLocalVideoChannel(channelAttributes, accountCreated, t)
|
2017-10-25 09:03:33 -05:00
|
|
|
|
2019-03-05 03:58:44 -06:00
|
|
|
const videoPlaylist = await createWatchLaterPlaylist(accountCreated, t)
|
|
|
|
|
|
|
|
return { user: userCreated, account: accountCreated, videoChannel, videoPlaylist }
|
2017-10-24 12:41:09 -05:00
|
|
|
})
|
2017-10-25 09:03:33 -05:00
|
|
|
|
2019-08-15 04:53:26 -05:00
|
|
|
const [ accountActorWithKeys, channelActorWithKeys ] = await Promise.all([
|
2021-02-26 07:22:25 -06:00
|
|
|
generateAndSaveActorKeys(account.Actor),
|
|
|
|
generateAndSaveActorKeys(videoChannel.Actor)
|
2018-11-19 08:21:09 -06:00
|
|
|
])
|
|
|
|
|
2019-08-15 04:53:26 -05:00
|
|
|
account.Actor = accountActorWithKeys
|
|
|
|
videoChannel.Actor = channelActorWithKeys
|
2017-11-16 11:40:50 -06:00
|
|
|
|
2019-08-15 04:53:26 -05:00
|
|
|
return { user, account, videoChannel }
|
2017-10-24 12:41:09 -05:00
|
|
|
}
|
|
|
|
|
2019-06-07 09:59:53 -05:00
|
|
|
async function createLocalAccountWithoutKeys (parameters: {
|
2020-01-31 09:56:52 -06:00
|
|
|
name: string
|
|
|
|
displayName?: string
|
|
|
|
userId: number | null
|
|
|
|
applicationId: number | null
|
|
|
|
t: Transaction | undefined
|
2019-06-07 09:59:53 -05:00
|
|
|
type?: ActivityPubActorType
|
|
|
|
}) {
|
|
|
|
const { name, displayName, userId, applicationId, t, type = 'Person' } = parameters
|
2020-11-20 04:21:08 -06:00
|
|
|
const url = getLocalAccountActivityPubUrl(name)
|
2017-11-10 10:27:49 -06:00
|
|
|
|
2017-12-14 10:38:41 -06:00
|
|
|
const actorInstance = buildActorInstance(type, url, name)
|
2019-08-20 12:05:31 -05:00
|
|
|
const actorInstanceCreated: MActorDefault = await actorInstance.save({ transaction: t })
|
2017-12-14 04:18:49 -06:00
|
|
|
|
|
|
|
const accountInstance = new AccountModel({
|
2019-06-07 09:59:53 -05:00
|
|
|
name: displayName || name,
|
2017-11-10 10:27:49 -06:00
|
|
|
userId,
|
|
|
|
applicationId,
|
2018-03-13 10:00:39 -05:00
|
|
|
actorId: actorInstanceCreated.id
|
2019-04-18 04:28:17 -05:00
|
|
|
})
|
2017-11-10 10:27:49 -06:00
|
|
|
|
2019-08-20 12:05:31 -05:00
|
|
|
const accountInstanceCreated: MAccountDefault = await accountInstance.save({ transaction: t })
|
2017-12-14 04:18:49 -06:00
|
|
|
accountInstanceCreated.Actor = actorInstanceCreated
|
|
|
|
|
|
|
|
return accountInstanceCreated
|
2017-11-10 10:27:49 -06:00
|
|
|
}
|
|
|
|
|
2017-12-14 10:38:41 -06:00
|
|
|
async function createApplicationActor (applicationId: number) {
|
2019-06-07 09:59:53 -05:00
|
|
|
const accountCreated = await createLocalAccountWithoutKeys({
|
|
|
|
name: SERVER_ACTOR_NAME,
|
|
|
|
userId: null,
|
2022-07-13 04:58:01 -05:00
|
|
|
applicationId,
|
2019-06-07 09:59:53 -05:00
|
|
|
t: undefined,
|
|
|
|
type: 'Application'
|
|
|
|
})
|
2017-12-14 10:38:41 -06:00
|
|
|
|
2021-02-26 07:22:25 -06:00
|
|
|
accountCreated.Actor = await generateAndSaveActorKeys(accountCreated.Actor)
|
2017-12-14 10:38:41 -06:00
|
|
|
|
|
|
|
return accountCreated
|
|
|
|
}
|
|
|
|
|
2022-08-03 03:10:26 -05:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2019-08-15 04:53:26 -05:00
|
|
|
async function sendVerifyUserEmail (user: MUser, isPendingEmail = false) {
|
2023-01-19 02:27:16 -06:00
|
|
|
const verificationString = await Redis.Instance.setUserVerifyEmailVerificationString(user.id)
|
|
|
|
let verifyEmailUrl = `${WEBSERVER.URL}/verify-account/email?userId=${user.id}&verificationString=${verificationString}`
|
2019-06-11 04:54:33 -05:00
|
|
|
|
2023-01-19 02:27:16 -06:00
|
|
|
if (isPendingEmail) verifyEmailUrl += '&isPendingEmail=true'
|
|
|
|
|
|
|
|
const to = isPendingEmail
|
|
|
|
? user.pendingEmail
|
|
|
|
: user.email
|
2019-06-11 04:54:33 -05:00
|
|
|
|
2020-07-20 07:58:58 -05:00
|
|
|
const username = user.username
|
2019-06-11 04:54:33 -05:00
|
|
|
|
2023-01-19 02:27:16 -06:00
|
|
|
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 })
|
2019-06-11 04:54:33 -05:00
|
|
|
}
|
|
|
|
|
2022-08-03 03:10:26 -05:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2020-09-25 09:19:35 -05:00
|
|
|
async function getOriginalVideoFileTotalFromUser (user: MUserId) {
|
2024-02-12 03:47:52 -06:00
|
|
|
const base = await UserModel.getUserQuota({ userId: user.id, daily: false })
|
2020-09-25 09:19:35 -05:00
|
|
|
|
2021-06-16 08:14:41 -05:00
|
|
|
return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id)
|
2020-09-25 09:19:35 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Returns cumulative size of all video files uploaded in the last 24 hours.
|
|
|
|
async function getOriginalVideoFileTotalDailyFromUser (user: MUserId) {
|
2024-02-12 03:47:52 -06:00
|
|
|
const base = await UserModel.getUserQuota({ userId: user.id, daily: true })
|
2020-09-25 09:19:35 -05:00
|
|
|
|
2021-06-16 08:14:41 -05:00
|
|
|
return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id)
|
2020-09-25 09:19:35 -05:00
|
|
|
}
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
async function isUserQuotaValid (options: {
|
|
|
|
userId: number
|
|
|
|
uploadSize: number
|
|
|
|
checkDaily?: boolean // default true
|
|
|
|
}) {
|
|
|
|
const { userId, uploadSize, checkDaily = true } = options
|
2020-09-25 09:19:35 -05:00
|
|
|
const user = await UserModel.loadById(userId)
|
|
|
|
|
|
|
|
if (user.videoQuota === -1 && user.videoQuotaDaily === -1) return Promise.resolve(true)
|
|
|
|
|
|
|
|
const [ totalBytes, totalBytesDaily ] = await Promise.all([
|
2020-11-03 08:33:30 -06:00
|
|
|
getOriginalVideoFileTotalFromUser(user),
|
|
|
|
getOriginalVideoFileTotalDailyFromUser(user)
|
2020-09-25 09:19:35 -05:00
|
|
|
])
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
const uploadedTotal = uploadSize + totalBytes
|
|
|
|
const uploadedDaily = uploadSize + totalBytesDaily
|
2020-09-25 09:19:35 -05:00
|
|
|
|
2022-02-11 03:51:33 -06:00
|
|
|
logger.debug(
|
2024-02-12 03:47:52 -06:00
|
|
|
'Check user %d quota to upload content.', userId,
|
|
|
|
{ totalBytes, totalBytesDaily, videoQuota: user.videoQuota, videoQuotaDaily: user.videoQuotaDaily, uploadSize }
|
2022-02-11 03:51:33 -06:00
|
|
|
)
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
if (checkDaily && user.videoQuotaDaily !== -1 && uploadedDaily >= user.videoQuotaDaily) return false
|
|
|
|
if (user.videoQuota !== -1 && uploadedTotal >= user.videoQuota) return false
|
2020-09-25 09:19:35 -05:00
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
return true
|
2020-09-25 09:19:35 -05:00
|
|
|
}
|
|
|
|
|
2017-10-24 12:41:09 -05:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
export {
|
2020-09-25 09:19:35 -05:00
|
|
|
getOriginalVideoFileTotalFromUser,
|
|
|
|
getOriginalVideoFileTotalDailyFromUser,
|
2017-12-14 10:38:41 -06:00
|
|
|
createApplicationActor,
|
2019-03-05 03:58:44 -06:00
|
|
|
createUserAccountAndChannelAndPlaylist,
|
2019-06-11 04:54:33 -05:00
|
|
|
createLocalAccountWithoutKeys,
|
2023-01-19 02:27:16 -06:00
|
|
|
|
2020-09-25 09:19:35 -05:00
|
|
|
sendVerifyUserEmail,
|
2023-01-19 02:27:16 -06:00
|
|
|
sendVerifyRegistrationEmail,
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
isUserQuotaValid,
|
2022-03-04 03:57:36 -06:00
|
|
|
buildUser
|
2017-10-24 12:41:09 -05:00
|
|
|
}
|
2018-12-26 03:36:24 -06:00
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2019-08-15 04:53:26 -05:00
|
|
|
function createDefaultUserNotificationSettings (user: MUserId, t: Transaction | undefined) {
|
2019-01-04 01:56:20 -06:00
|
|
|
const values: UserNotificationSetting & { userId: number } = {
|
2018-12-26 03:36:24 -06:00
|
|
|
userId: user.id,
|
2019-01-08 04:26:41 -06:00
|
|
|
newVideoFromSubscription: UserNotificationSettingValue.WEB,
|
|
|
|
newCommentOnMyVideo: UserNotificationSettingValue.WEB,
|
|
|
|
myVideoImportFinished: UserNotificationSettingValue.WEB,
|
|
|
|
myVideoPublished: UserNotificationSettingValue.WEB,
|
2020-07-07 07:34:16 -05:00
|
|
|
abuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
|
2019-04-02 04:26:47 -05:00
|
|
|
videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
|
2019-01-08 04:26:41 -06:00
|
|
|
blacklistOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
|
|
|
|
newUserRegistration: UserNotificationSettingValue.WEB,
|
|
|
|
commentMention: UserNotificationSettingValue.WEB,
|
2019-04-08 10:26:01 -05:00
|
|
|
newFollow: UserNotificationSettingValue.WEB,
|
2019-08-30 09:50:12 -05:00
|
|
|
newInstanceFollower: UserNotificationSettingValue.WEB,
|
2020-07-27 09:26:25 -05:00
|
|
|
abuseNewMessage: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
|
|
|
|
abuseStateChange: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
|
2021-03-11 09:54:52 -06:00
|
|
|
autoInstanceFollowing: UserNotificationSettingValue.WEB,
|
|
|
|
newPeerTubeVersion: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
|
2022-03-22 08:35:04 -05:00
|
|
|
newPluginVersion: UserNotificationSettingValue.WEB,
|
2022-03-22 10:58:49 -05:00
|
|
|
myVideoStudioEditionFinished: UserNotificationSettingValue.WEB
|
2019-01-04 01:56:20 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
return UserNotificationSettingModel.create(values, { transaction: t })
|
2018-12-26 03:36:24 -06:00
|
|
|
}
|
2019-05-28 03:46:32 -05:00
|
|
|
|
2023-01-19 02:27:16 -06:00
|
|
|
async function buildChannelAttributes (options: {
|
|
|
|
user: MUser
|
|
|
|
transaction?: Transaction
|
|
|
|
channelNames?: ChannelNames
|
|
|
|
}) {
|
|
|
|
const { user, transaction, channelNames } = options
|
|
|
|
|
2019-05-28 03:46:32 -05:00
|
|
|
if (channelNames) return channelNames
|
|
|
|
|
2022-08-03 03:10:26 -05:00
|
|
|
const channelName = await findAvailableLocalActorName(user.username + '_channel', transaction)
|
2023-10-19 08:22:00 -05:00
|
|
|
const videoChannelDisplayName = CONFIG.USER.DEFAULT_CHANNEL_NAME.replace('$1', user.username)
|
2019-05-28 03:46:32 -05:00
|
|
|
|
|
|
|
return {
|
|
|
|
name: channelName,
|
|
|
|
displayName: videoChannelDisplayName
|
|
|
|
}
|
|
|
|
}
|