PeerTube/server/lib/activitypub/actor.ts

382 lines
12 KiB
TypeScript
Raw Normal View History

2017-12-14 17:38:41 +01:00
import * as Bluebird from 'bluebird'
2017-12-29 19:10:13 +01:00
import { join } from 'path'
2017-12-14 17:38:41 +01:00
import { Transaction } from 'sequelize'
import * as url from 'url'
2017-12-29 19:10:13 +01:00
import * as uuidv4 from 'uuid/v4'
2017-12-14 17:38:41 +01:00
import { ActivityPubActor, ActivityPubActorType } from '../../../shared/models/activitypub'
import { ActivityPubAttributedTo } from '../../../shared/models/activitypub/objects'
2018-01-03 16:38:50 +01:00
import { isActorObjectValid } from '../../helpers/custom-validators/activitypub/actor'
2017-12-29 19:10:13 +01:00
import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
2018-01-04 14:04:02 +01:00
import { retryTransactionWrapper, updateInstanceWithAnother } from '../../helpers/database-utils'
2017-12-28 11:16:08 +01:00
import { logger } from '../../helpers/logger'
import { createPrivateAndPublicKeys } from '../../helpers/peertube-crypto'
2017-12-29 19:10:13 +01:00
import { doRequest, doRequestAndSaveToFile } from '../../helpers/requests'
2018-01-04 14:04:02 +01:00
import { getUrlFromWebfinger } from '../../helpers/webfinger'
import { IMAGE_MIMETYPE_EXT, CONFIG, sequelizeTypescript } from '../../initializers'
2017-12-14 17:38:41 +01:00
import { AccountModel } from '../../models/account/account'
import { ActorModel } from '../../models/activitypub/actor'
2017-12-29 19:10:13 +01:00
import { AvatarModel } from '../../models/avatar/avatar'
2017-12-14 17:38:41 +01:00
import { ServerModel } from '../../models/server/server'
import { VideoChannelModel } from '../../models/video/video-channel'
2017-12-19 10:34:56 +01:00
// Set account keys, this could be long so process after the account creation and do not block the client
2017-12-14 17:38:41 +01:00
function setAsyncActorKeys (actor: ActorModel) {
return createPrivateAndPublicKeys()
.then(({ publicKey, privateKey }) => {
actor.set('publicKey', publicKey)
actor.set('privateKey', privateKey)
return actor.save()
})
.catch(err => {
logger.error('Cannot set public/private keys of actor %d.', actor.uuid, err)
return actor
})
}
async function getOrCreateActorAndServerAndModel (actorUrl: string, recurseIfNeeded = true) {
let actor = await ActorModel.loadByUrl(actorUrl)
// We don't have this actor in our database, fetch it on remote
if (!actor) {
const result = await fetchRemoteActor(actorUrl)
if (result === undefined) throw new Error('Cannot fetch remote actor.')
// Create the attributed to actor
// In PeerTube a video channel is owned by an account
let ownerActor: ActorModel = undefined
if (recurseIfNeeded === true && result.actor.type === 'Group') {
const accountAttributedTo = result.attributedTo.find(a => a.type === 'Person')
if (!accountAttributedTo) throw new Error('Cannot find account attributed to video channel ' + actor.url)
try {
// Assert we don't recurse another time
ownerActor = await getOrCreateActorAndServerAndModel(accountAttributedTo.id, false)
} catch (err) {
logger.error('Cannot get or create account attributed to video channel ' + actor.url)
throw new Error(err)
}
}
const options = {
arguments: [ result, ownerActor ],
errorMessage: 'Cannot save actor and server with many retries.'
}
actor = await retryTransactionWrapper(saveActorAndServerAndModelIfNotExist, options)
}
const options = {
arguments: [ actor ],
errorMessage: 'Cannot refresh actor if needed with many retries.'
}
return retryTransactionWrapper(refreshActorIfNeeded, options)
2017-12-14 17:38:41 +01:00
}
2017-12-29 19:10:13 +01:00
function buildActorInstance (type: ActivityPubActorType, url: string, preferredUsername: string, uuid?: string) {
return new ActorModel({
type,
url,
preferredUsername,
uuid,
publicKey: null,
privateKey: null,
followersCount: 0,
followingCount: 0,
inboxUrl: url + '/inbox',
outboxUrl: url + '/outbox',
sharedInboxUrl: CONFIG.WEBSERVER.URL + '/inbox',
followersUrl: url + '/followers',
followingUrl: url + '/following'
})
}
2018-01-04 14:04:02 +01:00
async function updateActorInstance (actorInstance: ActorModel, attributes: ActivityPubActor) {
const followersCount = await fetchActorTotalItems(attributes.followers)
const followingCount = await fetchActorTotalItems(attributes.following)
actorInstance.set('type', attributes.type)
actorInstance.set('uuid', attributes.uuid)
actorInstance.set('preferredUsername', attributes.preferredUsername)
actorInstance.set('url', attributes.id)
actorInstance.set('publicKey', attributes.publicKey.publicKeyPem)
actorInstance.set('followersCount', followersCount)
actorInstance.set('followingCount', followingCount)
actorInstance.set('inboxUrl', attributes.inbox)
actorInstance.set('outboxUrl', attributes.outbox)
actorInstance.set('sharedInboxUrl', attributes.endpoints.sharedInbox)
actorInstance.set('followersUrl', attributes.followers)
actorInstance.set('followingUrl', attributes.following)
}
async function updateActorAvatarInstance (actorInstance: ActorModel, avatarName: string, t: Transaction) {
if (avatarName !== undefined) {
if (actorInstance.avatarId) {
try {
await actorInstance.Avatar.destroy({ transaction: t })
} catch (err) {
logger.error('Cannot remove old avatar of actor %s.', actorInstance.url, err)
}
}
const avatar = await AvatarModel.create({
filename: avatarName
}, { transaction: t })
actorInstance.set('avatarId', avatar.id)
actorInstance.Avatar = avatar
}
return actorInstance
}
2018-01-03 16:38:50 +01:00
async function fetchActorTotalItems (url: string) {
const options = {
uri: url,
method: 'GET',
json: true,
activityPub: true
}
try {
2018-01-15 09:46:46 +01:00
const { body } = await doRequest(options)
return body.totalItems ? body.totalItems : 0
2018-01-03 16:38:50 +01:00
} catch (err) {
logger.warn('Cannot fetch remote actor count %s.', url, err)
2018-01-15 09:46:46 +01:00
return 0
2018-01-03 16:38:50 +01:00
}
}
async function fetchAvatarIfExists (actorJSON: ActivityPubActor) {
if (
actorJSON.icon && actorJSON.icon.type === 'Image' && IMAGE_MIMETYPE_EXT[actorJSON.icon.mediaType] !== undefined &&
2018-01-03 16:38:50 +01:00
isActivityPubUrlValid(actorJSON.icon.url)
) {
const extension = IMAGE_MIMETYPE_EXT[actorJSON.icon.mediaType]
2018-01-03 16:38:50 +01:00
const avatarName = uuidv4() + extension
const destPath = join(CONFIG.STORAGE.AVATARS_DIR, avatarName)
await doRequestAndSaveToFile({
method: 'GET',
uri: actorJSON.icon.url
}, destPath)
return avatarName
}
return undefined
}
2017-12-29 19:10:13 +01:00
export {
getOrCreateActorAndServerAndModel,
buildActorInstance,
2018-01-03 16:38:50 +01:00
setAsyncActorKeys,
fetchActorTotalItems,
2018-01-04 14:04:02 +01:00
fetchAvatarIfExists,
updateActorInstance,
updateActorAvatarInstance
2017-12-29 19:10:13 +01:00
}
// ---------------------------------------------------------------------------
2017-12-14 17:38:41 +01:00
function saveActorAndServerAndModelIfNotExist (
result: FetchRemoteActorResult,
ownerActor?: ActorModel,
t?: Transaction
): Bluebird<ActorModel> | Promise<ActorModel> {
let actor = result.actor
if (t !== undefined) return save(t)
return sequelizeTypescript.transaction(t => save(t))
async function save (t: Transaction) {
const actorHost = url.parse(actor.url).host
const serverOptions = {
where: {
host: actorHost
},
defaults: {
host: actorHost
},
transaction: t
}
const [ server ] = await ServerModel.findOrCreate(serverOptions)
// Save our new account in database
actor.set('serverId', server.id)
2017-12-29 19:10:13 +01:00
// Avatar?
if (result.avatarName) {
const avatar = await AvatarModel.create({
filename: result.avatarName
}, { transaction: t })
actor.set('avatarId', avatar.id)
}
2017-12-14 17:38:41 +01:00
// Force the actor creation, sometimes Sequelize skips the save() when it thinks the instance already exists
// (which could be false in a retried query)
const [ actorCreated ] = await ActorModel.findOrCreate({
defaults: actor.toJSON(),
where: {
url: actor.url
},
transaction: t
})
2017-12-14 17:38:41 +01:00
if (actorCreated.type === 'Person' || actorCreated.type === 'Application') {
actorCreated.Account = await saveAccount(actorCreated, result, t)
2017-12-14 17:38:41 +01:00
actorCreated.Account.Actor = actorCreated
} else if (actorCreated.type === 'Group') { // Video channel
actorCreated.VideoChannel = await saveVideoChannel(actorCreated, result, ownerActor, t)
2017-12-14 17:38:41 +01:00
actorCreated.VideoChannel.Actor = actorCreated
}
return actorCreated
}
}
type FetchRemoteActorResult = {
actor: ActorModel
2017-12-19 10:34:56 +01:00
name: string
2017-12-14 17:38:41 +01:00
summary: string
support?: string
2017-12-29 19:10:13 +01:00
avatarName?: string
2017-12-14 17:38:41 +01:00
attributedTo: ActivityPubAttributedTo[]
}
async function fetchRemoteActor (actorUrl: string): Promise<FetchRemoteActorResult> {
const options = {
uri: actorUrl,
method: 'GET',
2017-12-28 11:16:08 +01:00
json: true,
activityPub: true
2017-12-14 17:38:41 +01:00
}
logger.info('Fetching remote actor %s.', actorUrl)
2017-12-28 11:16:08 +01:00
const requestResult = await doRequest(options)
const actorJSON: ActivityPubActor = normalizeActor(requestResult.body)
2017-12-14 17:38:41 +01:00
2018-01-03 16:38:50 +01:00
if (isActorObjectValid(actorJSON) === false) {
2017-12-14 17:38:41 +01:00
logger.debug('Remote actor JSON is not valid.', { actorJSON: actorJSON })
return undefined
}
const followersCount = await fetchActorTotalItems(actorJSON.followers)
const followingCount = await fetchActorTotalItems(actorJSON.following)
const actor = new ActorModel({
type: actorJSON.type,
uuid: actorJSON.uuid,
2017-12-19 10:34:56 +01:00
preferredUsername: actorJSON.preferredUsername,
url: actorJSON.id,
2017-12-14 17:38:41 +01:00
publicKey: actorJSON.publicKey.publicKeyPem,
privateKey: null,
followersCount: followersCount,
followingCount: followingCount,
inboxUrl: actorJSON.inbox,
outboxUrl: actorJSON.outbox,
sharedInboxUrl: actorJSON.endpoints.sharedInbox,
followersUrl: actorJSON.followers,
followingUrl: actorJSON.following
})
2018-01-03 16:38:50 +01:00
const avatarName = await fetchAvatarIfExists(actorJSON)
2017-12-29 19:10:13 +01:00
2017-12-19 10:34:56 +01:00
const name = actorJSON.name || actorJSON.preferredUsername
2017-12-14 17:38:41 +01:00
return {
actor,
2017-12-19 10:34:56 +01:00
name,
2017-12-29 19:10:13 +01:00
avatarName,
2017-12-14 17:38:41 +01:00
summary: actorJSON.summary,
support: actorJSON.support,
2017-12-14 17:38:41 +01:00
attributedTo: actorJSON.attributedTo
}
}
async function saveAccount (actor: ActorModel, result: FetchRemoteActorResult, t: Transaction) {
const [ accountCreated ] = await AccountModel.findOrCreate({
defaults: {
name: result.name,
description: result.summary,
actorId: actor.id
},
where: {
actorId: actor.id
},
transaction: t
2017-12-14 17:38:41 +01:00
})
return accountCreated
2017-12-14 17:38:41 +01:00
}
async function saveVideoChannel (actor: ActorModel, result: FetchRemoteActorResult, ownerActor: ActorModel, t: Transaction) {
const [ videoChannelCreated ] = await VideoChannelModel.findOrCreate({
defaults: {
name: result.name,
description: result.summary,
support: result.support,
actorId: actor.id,
accountId: ownerActor.Account.id
},
where: {
actorId: actor.id
},
transaction: t
2017-12-14 17:38:41 +01:00
})
return videoChannelCreated
2017-12-14 17:38:41 +01:00
}
2018-01-04 14:04:02 +01:00
async function refreshActorIfNeeded (actor: ActorModel) {
if (!actor.isOutdated()) return actor
try {
const actorUrl = await getUrlFromWebfinger(actor.preferredUsername, actor.getHost())
const result = await fetchRemoteActor(actorUrl)
if (result === undefined) {
logger.warn('Cannot fetch remote actor in refresh actor.')
return actor
2018-01-04 14:04:02 +01:00
}
return sequelizeTypescript.transaction(async t => {
updateInstanceWithAnother(actor, result.actor)
2018-01-04 14:04:02 +01:00
if (result.avatarName !== undefined) {
await updateActorAvatarInstance(actor, result.avatarName, t)
}
2018-01-04 14:04:02 +01:00
// Force update
actor.setDataValue('updatedAt', new Date())
2018-01-04 14:04:02 +01:00
await actor.save({ transaction: t })
if (actor.Account) {
await actor.save({ transaction: t })
actor.Account.set('name', result.name)
actor.Account.set('description', result.summary)
await actor.Account.save({ transaction: t })
} else if (actor.VideoChannel) {
await actor.save({ transaction: t })
actor.VideoChannel.set('name', result.name)
actor.VideoChannel.set('description', result.summary)
actor.VideoChannel.set('support', result.support)
await actor.VideoChannel.save({ transaction: t })
}
2018-01-04 14:04:02 +01:00
return actor
})
} catch (err) {
logger.warn('Cannot refresh actor.', err)
2018-01-04 14:04:02 +01:00
return actor
}
2018-01-04 14:04:02 +01:00
}
function normalizeActor (actor: any) {
if (actor && actor.url && typeof actor.url === 'string') return actor
actor.url = actor.url.href || actor.url.url
return actor
}