Improve views/viewers documentation

[github/Chocobozzz/PeerTube.git] / server / lib / user.ts

diff --git a/server/lib/user.ts b/server/lib/user.ts
index 9b0a0a2f111cd46b64a834ac6bf8ba61c28f2e1b..310a3c30cc9c5a241b329c1642d3267529d68a81 100644 (file)
--- a/server/lib/user.ts
+++ b/server/lib/user.ts
@@ -1,25 +1,76 @@
 import { Transaction } from 'sequelize/types'
-import { v4 as uuidv4 } from 'uuid'
-import { UserModel } from '@server/models/account/user'
+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 { buildUUID } from '@shared/extra-utils'
 import { ActivityPubActorType } from '../../shared/models/activitypub'
-import { UserNotificationSetting, UserNotificationSettingValue } from '../../shared/models/users'
+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 { UserNotificationSettingModel } from '../models/account/user-notification-setting'
-import { ActorModel } from '../models/activitypub/actor'
-import { MAccountDefault, MActorDefault, MChannelActor } from '../types/models'
+import { ActorModel } from '../models/actor/actor'
+import { UserNotificationSettingModel } from '../models/user/user-notification-setting'
+import { MAccountDefault, MChannelActor } from '../types/models'
 import { MUser, MUserDefault, MUserId } from '../types/models/user'
-import { buildActorInstance, generateAndSaveActorKeys } from './activitypub/actor'
+import { generateAndSaveActorKeys } from './activitypub/actors'
 import { getLocalAccountActivityPubUrl } from './activitypub/url'
 import { Emailer } from './emailer'
-import { LiveManager } from './live-manager'
+import { LiveQuotaStore } from './live/live-quota-store'
+import { buildActorInstance } from './local-actor'
 import { Redis } from './redis'
 import { createLocalVideoChannel } from './video-channel'
 import { createWatchLaterPlaylist } from './video-playlist'
 
 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: videoQuota,
+    videoQuotaDaily: videoQuotaDaily,
+
+    pluginAuth
+  })
+}
+
 async function createUserAccountAndChannelAndPlaylist (parameters: {
   userToCreate: MUser
   userDisplayName?: string
@@ -42,11 +93,11 @@ async function createUserAccountAndChannelAndPlaylist (parameters: {
       displayName: userDisplayName,
       userId: userCreated.id,
       applicationId: null,
-      t: t
+      t
     })
     userCreated.Account = accountCreated
 
-    const channelAttributes = await buildChannelAttributes(userCreated, channelNames)
+    const channelAttributes = await buildChannelAttributes(userCreated, t, channelNames)
     const videoChannel = await createLocalVideoChannel(channelAttributes, accountCreated, t)
 
     const videoPlaylist = await createWatchLaterPlaylist(accountCreated, t)
@@ -115,7 +166,7 @@ async function sendVerifyUserEmail (user: MUser, isPendingEmail = false) {
   const email = isPendingEmail ? user.pendingEmail : user.email
   const username = user.username
 
-  await Emailer.Instance.addVerifyEmailJob(username, email, url)
+  Emailer.Instance.addVerifyEmailJob(username, email, url)
 }
 
 async function getOriginalVideoFileTotalFromUser (user: MUserId) {
@@ -127,7 +178,7 @@ async function getOriginalVideoFileTotalFromUser (user: MUserId) {
 
   const base = await UserModel.getTotalRawQuery(query, user.id)
 
-  return base + LiveManager.Instance.getLiveQuotaUsedByUser(user.id)
+  return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id)
 }
 
 // Returns cumulative size of all video files uploaded in the last 24 hours.
@@ -141,10 +192,10 @@ async function getOriginalVideoFileTotalDailyFromUser (user: MUserId) {
 
   const base = await UserModel.getTotalRawQuery(query, user.id)
 
-  return base + LiveManager.Instance.getLiveQuotaUsedByUser(user.id)
+  return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id)
 }
 
-async function isAbleToUploadVideo (userId: number, size: number) {
+async function isAbleToUploadVideo (userId: number, newVideoSize: number) {
   const user = await UserModel.loadById(userId)
 
   if (user.videoQuota === -1 && user.videoQuotaDaily === -1) return Promise.resolve(true)
@@ -154,8 +205,13 @@ async function isAbleToUploadVideo (userId: number, size: number) {
     getOriginalVideoFileTotalDailyFromUser(user)
   ])
 
-  const uploadedTotal = size + totalBytes
-  const uploadedDaily = size + totalBytesDaily
+  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
@@ -172,7 +228,8 @@ export {
   createUserAccountAndChannelAndPlaylist,
   createLocalAccountWithoutKeys,
   sendVerifyUserEmail,
-  isAbleToUploadVideo
+  isAbleToUploadVideo,
+  buildUser
 }
 
 // ---------------------------------------------------------------------------
@@ -195,20 +252,21 @@ function createDefaultUserNotificationSettings (user: MUserId, t: Transaction |
     abuseStateChange: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
     autoInstanceFollowing: UserNotificationSettingValue.WEB,
     newPeerTubeVersion: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
-    newPluginVersion: UserNotificationSettingValue.WEB
+    newPluginVersion: UserNotificationSettingValue.WEB,
+    myVideoStudioEditionFinished: UserNotificationSettingValue.WEB
   }
 
   return UserNotificationSettingModel.create(values, { transaction: t })
 }
 
-async function buildChannelAttributes (user: MUser, channelNames?: ChannelNames) {
+async function buildChannelAttributes (user: MUser, transaction?: Transaction, channelNames?: ChannelNames) {
   if (channelNames) return channelNames
 
   let channelName = user.username + '_channel'
 
   // Conflict, generate uuid instead
-  const actor = await ActorModel.loadLocalByName(channelName)
-  if (actor) channelName = uuidv4()
+  const actor = await ActorModel.loadLocalByName(channelName, transaction)
+  if (actor) channelName = buildUUID()
 
   const videoChannelDisplayName = `Main ${user.username} channel`