server/lib/user.ts

   1 import * as uuidv4 from 'uuid/v4'
   2 import { ActivityPubActorType } from '../../shared/models/activitypub'
   3 import { SERVER_ACTOR_NAME, WEBSERVER } from '../initializers/constants'
   4 import { AccountModel } from '../models/account/account'
   5 import { UserModel } from '../models/account/user'
   6 import { buildActorInstance, getAccountActivityPubUrl, setAsyncActorKeys } from './activitypub'
   7 import { createVideoChannel } from './video-channel'
   8 import { VideoChannelModel } from '../models/video/video-channel'
   9 import { ActorModel } from '../models/activitypub/actor'
  10 import { UserNotificationSettingModel } from '../models/account/user-notification-setting'
  11 import { UserNotificationSetting, UserNotificationSettingValue } from '../../shared/models/users'
  12 import { createWatchLaterPlaylist } from './video-playlist'
  13 import { sequelizeTypescript } from '../initializers/database'
  14 import { Transaction } from 'sequelize/types'
  15 import { Redis } from './redis'
  16 import { Emailer } from './emailer'
  17
  18 type ChannelNames = { name: string, displayName: string }
  19 async function createUserAccountAndChannelAndPlaylist (parameters: {
  20   userToCreate: UserModel,
  21   userDisplayName?: string,
  22   channelNames?: ChannelNames,
  23   validateUser?: boolean
  24 }) {
  25   const { userToCreate, userDisplayName, channelNames, validateUser = true } = parameters
  26
  27   const { user, account, videoChannel } = await sequelizeTypescript.transaction(async t => {
  28     const userOptions = {
  29       transaction: t,
  30       validate: validateUser
  31     }
  32
  33     const userCreated = await userToCreate.save(userOptions)
  34     userCreated.NotificationSetting = await createDefaultUserNotificationSettings(userCreated, t)
  35
  36     const accountCreated = await createLocalAccountWithoutKeys({
  37       name: userCreated.username,
  38       displayName: userDisplayName,
  39       userId: userCreated.id,
  40       applicationId: null,
  41       t: t
  42     })
  43     userCreated.Account = accountCreated
  44
  45     const channelAttributes = await buildChannelAttributes(userCreated, channelNames)
  46     const videoChannel = await createVideoChannel(channelAttributes, accountCreated, t)
  47
  48     const videoPlaylist = await createWatchLaterPlaylist(accountCreated, t)
  49
  50     return { user: userCreated, account: accountCreated, videoChannel, videoPlaylist }
  51   })
  52
  53   const [ accountKeys, channelKeys ] = await Promise.all([
  54     setAsyncActorKeys(account.Actor),
  55     setAsyncActorKeys(videoChannel.Actor)
  56   ])
  57
  58   account.Actor = accountKeys
  59   videoChannel.Actor = channelKeys
  60
  61   return { user, account, videoChannel } as { user: UserModel, account: AccountModel, videoChannel: VideoChannelModel }
  62 }
  63
  64 async function createLocalAccountWithoutKeys (parameters: {
  65   name: string,
  66   displayName?: string,
  67   userId: number | null,
  68   applicationId: number | null,
  69   t: Transaction | undefined,
  70   type?: ActivityPubActorType
  71 }) {
  72   const { name, displayName, userId, applicationId, t, type = 'Person' } = parameters
  73   const url = getAccountActivityPubUrl(name)
  74
  75   const actorInstance = buildActorInstance(type, url, name)
  76   const actorInstanceCreated = await actorInstance.save({ transaction: t })
  77
  78   const accountInstance = new AccountModel({
  79     name: displayName || name,
  80     userId,
  81     applicationId,
  82     actorId: actorInstanceCreated.id
  83   })
  84
  85   const accountInstanceCreated = await accountInstance.save({ transaction: t })
  86   accountInstanceCreated.Actor = actorInstanceCreated
  87
  88   return accountInstanceCreated
  89 }
  90
  91 async function createApplicationActor (applicationId: number) {
  92   const accountCreated = await createLocalAccountWithoutKeys({
  93     name: SERVER_ACTOR_NAME,
  94     userId: null,
  95     applicationId: applicationId,
  96     t: undefined,
  97     type: 'Application'
  98   })
  99
 100   accountCreated.Actor = await setAsyncActorKeys(accountCreated.Actor)
 101
 102   return accountCreated
 103 }
 104
 105 async function sendVerifyUserEmail (user: UserModel, isPendingEmail = false) {
 106   const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
 107   let url = WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
 108
 109   if (isPendingEmail) url += '&isPendingEmail=true'
 110
 111   const email = isPendingEmail ? user.pendingEmail : user.email
 112
 113   await Emailer.Instance.addVerifyEmailJob(email, url)
 114 }
 115
 116 // ---------------------------------------------------------------------------
 117
 118 export {
 119   createApplicationActor,
 120   createUserAccountAndChannelAndPlaylist,
 121   createLocalAccountWithoutKeys,
 122   sendVerifyUserEmail
 123 }
 124
 125 // ---------------------------------------------------------------------------
 126
 127 function createDefaultUserNotificationSettings (user: UserModel, t: Transaction | undefined) {
 128   const values: UserNotificationSetting & { userId: number } = {
 129     userId: user.id,
 130     newVideoFromSubscription: UserNotificationSettingValue.WEB,
 131     newCommentOnMyVideo: UserNotificationSettingValue.WEB,
 132     myVideoImportFinished: UserNotificationSettingValue.WEB,
 133     myVideoPublished: UserNotificationSettingValue.WEB,
 134     videoAbuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 135     videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 136     blacklistOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
 137     newUserRegistration: UserNotificationSettingValue.WEB,
 138     commentMention: UserNotificationSettingValue.WEB,
 139     newFollow: UserNotificationSettingValue.WEB,
 140     newInstanceFollower: UserNotificationSettingValue.WEB
 141   }
 142
 143   return UserNotificationSettingModel.create(values, { transaction: t })
 144 }
 145
 146 async function buildChannelAttributes (user: UserModel, channelNames?: ChannelNames) {
 147   if (channelNames) return channelNames
 148
 149   let channelName = user.username + '_channel'
 150
 151   // Conflict, generate uuid instead
 152   const actor = await ActorModel.loadLocalByName(channelName)
 153   if (actor) channelName = uuidv4()
 154
 155   const videoChannelDisplayName = `Main ${user.username} channel`
 156
 157   return {
 158     name: channelName,
 159     displayName: videoChannelDisplayName
 160   }
 161 }