server/lib/user.ts

   1 import { Transaction } from 'sequelize/types'
   2 import { v4 as uuidv4 } from 'uuid'
   3 import { UserModel } from '@server/models/account/user'
   4 import { ActivityPubActorType } from '../../shared/models/activitypub'
   5 import { UserNotificationSetting, UserNotificationSettingValue } from '../../shared/models/users'
   6 import { SERVER_ACTOR_NAME, WEBSERVER } from '../initializers/constants'
   7 import { sequelizeTypescript } from '../initializers/database'
   8 import { AccountModel } from '../models/account/account'
   9 import { UserNotificationSettingModel } from '../models/account/user-notification-setting'
  10 import { ActorModel } from '../models/activitypub/actor'
  11 import { MAccountDefault, MActorDefault, MChannelActor } from '../types/models'
  12 import { MUser, MUserDefault, MUserId } from '../types/models/user'
  13 import { buildActorInstance, setAsyncActorKeys } from './activitypub/actor'
  14 import { getAccountActivityPubUrl } from './activitypub/url'
  15 import { Emailer } from './emailer'
  16 import { LiveManager } from './live-manager'
  17 import { Redis } from './redis'
  18 import { createLocalVideoChannel } from './video-channel'
  19 import { createWatchLaterPlaylist } from './video-playlist'
  20
  21 import memoizee = require('memoizee')
  22
  23 type ChannelNames = { name: string, displayName: string }
  24
  25 async function createUserAccountAndChannelAndPlaylist (parameters: {
  26   userToCreate: MUser
  27   userDisplayName?: string
  28   channelNames?: ChannelNames
  29   validateUser?: boolean
  30 }): Promise<{ user: MUserDefault, account: MAccountDefault, videoChannel: MChannelActor }> {
  31   const { userToCreate, userDisplayName, channelNames, validateUser = true } = parameters
  32
  33   const { user, account, videoChannel } = await sequelizeTypescript.transaction(async t => {
  34     const userOptions = {
  35       transaction: t,
  36       validate: validateUser
  37     }
  38
  39     const userCreated: MUserDefault = await userToCreate.save(userOptions)
  40     userCreated.NotificationSetting = await createDefaultUserNotificationSettings(userCreated, t)
  41
  42     const accountCreated = await createLocalAccountWithoutKeys({
  43       name: userCreated.username,
  44       displayName: userDisplayName,
  45       userId: userCreated.id,
  46       applicationId: null,
  47       t: t
  48     })
  49     userCreated.Account = accountCreated
  50
  51     const channelAttributes = await buildChannelAttributes(userCreated, channelNames)
  52     const videoChannel = await createLocalVideoChannel(channelAttributes, accountCreated, t)
  53
  54     const videoPlaylist = await createWatchLaterPlaylist(accountCreated, t)
  55
  56     return { user: userCreated, account: accountCreated, videoChannel, videoPlaylist }
  57   })
  58
  59   const [ accountActorWithKeys, channelActorWithKeys ] = await Promise.all([
  60     setAsyncActorKeys(account.Actor),
  61     setAsyncActorKeys(videoChannel.Actor)
  62   ])
  63
  64   account.Actor = accountActorWithKeys
  65   videoChannel.Actor = channelActorWithKeys
  66
  67   return { user, account, videoChannel }
  68 }
  69
  70 async function createLocalAccountWithoutKeys (parameters: {
  71   name: string
  72   displayName?: string
  73   userId: number | null
  74   applicationId: number | null
  75   t: Transaction | undefined
  76   type?: ActivityPubActorType
  77 }) {
  78   const { name, displayName, userId, applicationId, t, type = 'Person' } = parameters
  79   const url = getAccountActivityPubUrl(name)
  80
  81   const actorInstance = buildActorInstance(type, url, name)
  82   const actorInstanceCreated: MActorDefault = await actorInstance.save({ transaction: t })
  83
  84   const accountInstance = new AccountModel({
  85     name: displayName || name,
  86     userId,
  87     applicationId,
  88     actorId: actorInstanceCreated.id
  89   })
  90
  91   const accountInstanceCreated: MAccountDefault = await accountInstance.save({ transaction: t })
  92   accountInstanceCreated.Actor = actorInstanceCreated
  93
  94   return accountInstanceCreated
  95 }
  96
  97 async function createApplicationActor (applicationId: number) {
  98   const accountCreated = await createLocalAccountWithoutKeys({
  99     name: SERVER_ACTOR_NAME,
 100     userId: null,
 101     applicationId: applicationId,
 102     t: undefined,
 103     type: 'Application'
 104   })
 105
 106   accountCreated.Actor = await setAsyncActorKeys(accountCreated.Actor)
 107
 108   return accountCreated
 109 }
 110
 111 async function sendVerifyUserEmail (user: MUser, isPendingEmail = false) {
 112   const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
 113   let url = WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
 114
 115   if (isPendingEmail) url += '&isPendingEmail=true'
 116
 117   const email = isPendingEmail ? user.pendingEmail : user.email
 118   const username = user.username
 119
 120   await Emailer.Instance.addVerifyEmailJob(username, email, url)
 121 }
 122
 123 async function getOriginalVideoFileTotalFromUser (user: MUserId) {
 124   // Don't use sequelize because we need to use a sub query
 125   const query = UserModel.generateUserQuotaBaseSQL({
 126     withSelect: true,
 127     whereUserId: '$userId'
 128   })
 129
 130   const base = await UserModel.getTotalRawQuery(query, user.id)
 131
 132   return base + LiveManager.Instance.getLiveQuotaUsedByUser(user.id)
 133 }
 134
 135 // Returns cumulative size of all video files uploaded in the last 24 hours.
 136 async function getOriginalVideoFileTotalDailyFromUser (user: MUserId) {
 137   // Don't use sequelize because we need to use a sub query
 138   const query = UserModel.generateUserQuotaBaseSQL({
 139     withSelect: true,
 140     whereUserId: '$userId',
 141     where: '"video"."createdAt" > now() - interval \'24 hours\''
 142   })
 143
 144   const base = await UserModel.getTotalRawQuery(query, user.id)
 145
 146   return base + LiveManager.Instance.getLiveQuotaUsedByUser(user.id)
 147 }
 148
 149 async function isAbleToUploadVideo (userId: number, size: number) {
 150   const user = await UserModel.loadById(userId)
 151
 152   if (user.videoQuota === -1 && user.videoQuotaDaily === -1) return Promise.resolve(true)
 153
 154   const [ totalBytes, totalBytesDaily ] = await Promise.all([
 155     getOriginalVideoFileTotalFromUser(user.id),
 156     getOriginalVideoFileTotalDailyFromUser(user.id)
 157   ])
 158
 159   const uploadedTotal = size + totalBytes
 160   const uploadedDaily = size + totalBytesDaily
 161
 162   if (user.videoQuotaDaily === -1) return uploadedTotal < user.videoQuota
 163   if (user.videoQuota === -1) return uploadedDaily < user.videoQuotaDaily
 164
 165   return uploadedTotal < user.videoQuota && uploadedDaily < user.videoQuotaDaily
 166 }
 167
 168 // ---------------------------------------------------------------------------
 169
 170 export {
 171   getOriginalVideoFileTotalFromUser,
 172   getOriginalVideoFileTotalDailyFromUser,
 173   createApplicationActor,
 174   createUserAccountAndChannelAndPlaylist,
 175   createLocalAccountWithoutKeys,
 176   sendVerifyUserEmail,
 177   isAbleToUploadVideo
 178 }
 179
 180 // ---------------------------------------------------------------------------
 181
 182 function createDefaultUserNotificationSettings (user: MUserId, t: Transaction | undefined) {
 183   const values: UserNotificationSetting & { userId: number } = {
 184     userId: user.id,
 185     newVideoFromSubscription: UserNotificationSettingValue.WEB,
 186     newCommentOnMyVideo: UserNotificationSettingValue.WEB,
 187     myVideoImportFinished: UserNotificationSettingValue.WEB,
 188     myVideoPublished: UserNotificationSettingValue.WEB,
 189     abuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 190     videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 191     blacklistOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 192     newUserRegistration: UserNotificationSettingValue.WEB,
 193     commentMention: UserNotificationSettingValue.WEB,
 194     newFollow: UserNotificationSettingValue.WEB,
 195     newInstanceFollower: UserNotificationSettingValue.WEB,
 196     abuseNewMessage: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 197     abuseStateChange: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 198     autoInstanceFollowing: UserNotificationSettingValue.WEB
 199   }
 200
 201   return UserNotificationSettingModel.create(values, { transaction: t })
 202 }
 203
 204 async function buildChannelAttributes (user: MUser, channelNames?: ChannelNames) {
 205   if (channelNames) return channelNames
 206
 207   let channelName = user.username + '_channel'
 208
 209   // Conflict, generate uuid instead
 210   const actor = await ActorModel.loadLocalByName(channelName)
 211   if (actor) channelName = uuidv4()
 212
 213   const videoChannelDisplayName = `Main ${user.username} channel`
 214
 215   return {
 216     name: channelName,
 217     displayName: videoChannelDisplayName
 218   }
 219 }