1 import * as Bluebird from 'bluebird'
2 import { extname } from 'path'
3 import { Op, Transaction } from 'sequelize'
4 import { URL } from 'url'
5 import { v4 as uuidv4 } from 'uuid'
6 import { getServerActor } from '@server/models/application/application'
7 import { ActorImageType } from '@shared/models'
8 import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
9 import { ActivityPubActor, ActivityPubActorType, ActivityPubOrderedCollection } from '../../../shared/models/activitypub'
10 import { ActivityPubAttributedTo } from '../../../shared/models/activitypub/objects'
11 import { checkUrlsSameHost, getAPId } from '../../helpers/activitypub'
12 import { ActorFetchByUrlType, fetchActorByUrl } from '../../helpers/actor'
13 import { sanitizeAndCheckActorObject } from '../../helpers/custom-validators/activitypub/actor'
14 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
15 import { retryTransactionWrapper, updateInstanceWithAnother } from '../../helpers/database-utils'
16 import { logger } from '../../helpers/logger'
17 import { createPrivateAndPublicKeys } from '../../helpers/peertube-crypto'
18 import { doJSONRequest, PeerTubeRequestError } from '../../helpers/requests'
19 import { getUrlFromWebfinger } from '../../helpers/webfinger'
20 import { MIMETYPES, WEBSERVER } from '../../initializers/constants'
21 import { sequelizeTypescript } from '../../initializers/database'
22 import { AccountModel } from '../../models/account/account'
23 import { ActorImageModel } from '../../models/account/actor-image'
24 import { ActorModel } from '../../models/activitypub/actor'
25 import { ServerModel } from '../../models/server/server'
26 import { VideoChannelModel } from '../../models/video/video-channel'
31 MActorAccountChannelId,
32 MActorAccountChannelIdActor,
40 } from '../../types/models'
41 import { JobQueue } from '../job-queue'
43 // Set account keys, this could be long so process after the account creation and do not block the client
44 async function generateAndSaveActorKeys <T extends MActor> (actor: T) {
45 const { publicKey, privateKey } = await createPrivateAndPublicKeys()
47 actor.publicKey = publicKey
48 actor.privateKey = privateKey
53 function getOrCreateActorAndServerAndModel (
54 activityActor: string | ActivityPubActor,
56 recurseIfNeeded?: boolean,
57 updateCollections?: boolean
58 ): Promise<MActorFullActor>
60 function getOrCreateActorAndServerAndModel (
61 activityActor: string | ActivityPubActor,
62 fetchType?: 'association-ids',
63 recurseIfNeeded?: boolean,
64 updateCollections?: boolean
65 ): Promise<MActorAccountChannelId>
67 async function getOrCreateActorAndServerAndModel (
68 activityActor: string | ActivityPubActor,
69 fetchType: ActorFetchByUrlType = 'association-ids',
70 recurseIfNeeded = true,
71 updateCollections = false
72 ): Promise<MActorFullActor | MActorAccountChannelId> {
73 const actorUrl = getAPId(activityActor)
75 let accountPlaylistsUrl: string
77 let actor = await fetchActorByUrl(actorUrl, fetchType)
78 // Orphan actor (not associated to an account of channel) so recreate it
79 if (actor && (!actor.Account && !actor.VideoChannel)) {
84 // We don't have this actor in our database, fetch it on remote
86 const { result } = await fetchRemoteActor(actorUrl)
87 if (result === undefined) throw new Error('Cannot fetch remote actor ' + actorUrl)
89 // Create the attributed to actor
90 // In PeerTube a video channel is owned by an account
91 let ownerActor: MActorFullActor
92 if (recurseIfNeeded === true && result.actor.type === 'Group') {
93 const accountAttributedTo = result.attributedTo.find(a => a.type === 'Person')
94 if (!accountAttributedTo) throw new Error('Cannot find account attributed to video channel ' + actor.url)
96 if (checkUrlsSameHost(accountAttributedTo.id, actorUrl) !== true) {
97 throw new Error(`Account attributed to ${accountAttributedTo.id} does not have the same host than actor url ${actorUrl}`)
101 // Don't recurse another time
102 const recurseIfNeeded = false
103 ownerActor = await getOrCreateActorAndServerAndModel(accountAttributedTo.id, 'all', recurseIfNeeded)
105 logger.error('Cannot get or create account attributed to video channel ' + actorUrl)
110 actor = await retryTransactionWrapper(saveActorAndServerAndModelIfNotExist, result, ownerActor)
112 accountPlaylistsUrl = result.playlists
115 if (actor.Account) (actor as MActorAccountChannelIdActor).Account.Actor = actor
116 if (actor.VideoChannel) (actor as MActorAccountChannelIdActor).VideoChannel.Actor = actor
118 const { actor: actorRefreshed, refreshed } = await retryTransactionWrapper(refreshActorIfNeeded, actor, fetchType)
119 if (!actorRefreshed) throw new Error('Actor ' + actor.url + ' does not exist anymore.')
121 if ((created === true || refreshed === true) && updateCollections === true) {
122 const payload = { uri: actor.outboxUrl, type: 'activity' as 'activity' }
123 await JobQueue.Instance.createJobWithPromise({ type: 'activitypub-http-fetcher', payload })
126 // We created a new account: fetch the playlists
127 if (created === true && actor.Account && accountPlaylistsUrl) {
128 const payload = { uri: accountPlaylistsUrl, accountId: actor.Account.id, type: 'account-playlists' as 'account-playlists' }
129 await JobQueue.Instance.createJobWithPromise({ type: 'activitypub-http-fetcher', payload })
132 return actorRefreshed
135 function buildActorInstance (type: ActivityPubActorType, url: string, preferredUsername: string, uuid?: string) {
136 return new ActorModel({
145 inboxUrl: url + '/inbox',
146 outboxUrl: url + '/outbox',
147 sharedInboxUrl: WEBSERVER.URL + '/inbox',
148 followersUrl: url + '/followers',
149 followingUrl: url + '/following'
153 async function updateActorInstance (actorInstance: ActorModel, attributes: ActivityPubActor) {
154 const followersCount = await fetchActorTotalItems(attributes.followers)
155 const followingCount = await fetchActorTotalItems(attributes.following)
157 actorInstance.type = attributes.type
158 actorInstance.preferredUsername = attributes.preferredUsername
159 actorInstance.url = attributes.id
160 actorInstance.publicKey = attributes.publicKey.publicKeyPem
161 actorInstance.followersCount = followersCount
162 actorInstance.followingCount = followingCount
163 actorInstance.inboxUrl = attributes.inbox
164 actorInstance.outboxUrl = attributes.outbox
165 actorInstance.followersUrl = attributes.followers
166 actorInstance.followingUrl = attributes.following
168 if (attributes.endpoints?.sharedInbox) {
169 actorInstance.sharedInboxUrl = attributes.endpoints.sharedInbox
173 type ImageInfo = { name: string, onDisk?: boolean, fileUrl: string }
174 async function updateActorImageInstance (actor: MActorImages, type: ActorImageType, imageInfo: ImageInfo | null, t: Transaction) {
175 const oldImageModel = type === ActorImageType.AVATAR
180 // Don't update the avatar if the file URL did not change
181 if (imageInfo?.fileUrl && oldImageModel.fileUrl === imageInfo.fileUrl) return actor
184 await oldImageModel.destroy({ transaction: t })
186 setActorImage(actor, type, null)
188 logger.error('Cannot remove old actor image of actor %s.', actor.url, { err })
193 const imageModel = await ActorImageModel.create({
194 filename: imageInfo.name,
195 onDisk: imageInfo.onDisk ?? false,
196 fileUrl: imageInfo.fileUrl,
198 }, { transaction: t })
200 setActorImage(actor, type, imageModel)
206 async function deleteActorImageInstance (actor: MActorImages, type: ActorImageType, t: Transaction) {
208 if (type === ActorImageType.AVATAR) {
209 await actor.Avatar.destroy({ transaction: t })
211 actor.avatarId = null
214 await actor.Banner.destroy({ transaction: t })
216 actor.bannerId = null
220 logger.error('Cannot remove old image of actor %s.', actor.url, { err })
226 async function fetchActorTotalItems (url: string) {
228 const { body } = await doJSONRequest<ActivityPubOrderedCollection<unknown>>(url, { activityPub: true })
230 return body.totalItems || 0
232 logger.warn('Cannot fetch remote actor count %s.', url, { err })
237 function getImageInfoIfExists (actorJSON: ActivityPubActor, type: ActorImageType) {
238 const mimetypes = MIMETYPES.IMAGE
239 const icon = type === ActorImageType.AVATAR
243 if (!icon || icon.type !== 'Image' || !isActivityPubUrlValid(icon.url)) return undefined
245 let extension: string
247 if (icon.mediaType) {
248 extension = mimetypes.MIMETYPE_EXT[icon.mediaType]
250 const tmp = extname(icon.url)
252 if (mimetypes.EXT_MIMETYPE[tmp] !== undefined) extension = tmp
255 if (!extension) return undefined
258 name: uuidv4() + extension,
264 async function addFetchOutboxJob (actor: Pick<ActorModel, 'id' | 'outboxUrl'>) {
265 // Don't fetch ourselves
266 const serverActor = await getServerActor()
267 if (serverActor.id === actor.id) {
268 logger.error('Cannot fetch our own outbox!')
273 uri: actor.outboxUrl,
274 type: 'activity' as 'activity'
277 return JobQueue.Instance.createJob({ type: 'activitypub-http-fetcher', payload })
280 async function refreshActorIfNeeded <T extends MActorFull | MActorAccountChannelId> (
282 fetchedType: ActorFetchByUrlType
283 ): Promise<{ actor: T | MActorFull, refreshed: boolean }> {
284 if (!actorArg.isOutdated()) return { actor: actorArg, refreshed: false }
286 // We need more attributes
287 const actor = fetchedType === 'all'
288 ? actorArg as MActorFull
289 : await ActorModel.loadByUrlAndPopulateAccountAndChannel(actorArg.url)
294 actorUrl = await getUrlFromWebfinger(actor.preferredUsername + '@' + actor.getHost())
296 logger.warn('Cannot get actor URL from webfinger, keeping the old one.', err)
300 const { result } = await fetchRemoteActor(actorUrl)
302 if (result === undefined) {
303 logger.warn('Cannot fetch remote actor in refresh actor.')
304 return { actor, refreshed: false }
307 return sequelizeTypescript.transaction(async t => {
308 updateInstanceWithAnother(actor, result.actor)
310 await updateActorImageInstance(actor, ActorImageType.AVATAR, result.avatar, t)
311 await updateActorImageInstance(actor, ActorImageType.BANNER, result.banner, t)
314 actor.setDataValue('updatedAt', new Date())
315 await actor.save({ transaction: t })
318 actor.Account.name = result.name
319 actor.Account.description = result.summary
321 await actor.Account.save({ transaction: t })
322 } else if (actor.VideoChannel) {
323 actor.VideoChannel.name = result.name
324 actor.VideoChannel.description = result.summary
325 actor.VideoChannel.support = result.support
327 await actor.VideoChannel.save({ transaction: t })
330 return { refreshed: true, actor }
333 if ((err as PeerTubeRequestError).statusCode === HttpStatusCode.NOT_FOUND_404) {
334 logger.info('Deleting actor %s because there is a 404 in refresh actor.', actor.url)
336 ? await actor.Account.destroy()
337 : await actor.VideoChannel.destroy()
339 return { actor: undefined, refreshed: false }
342 logger.warn('Cannot refresh actor %s.', actor.url, { err })
343 return { actor, refreshed: false }
348 getOrCreateActorAndServerAndModel,
350 generateAndSaveActorKeys,
351 fetchActorTotalItems,
352 getImageInfoIfExists,
354 deleteActorImageInstance,
355 refreshActorIfNeeded,
356 updateActorImageInstance,
360 // ---------------------------------------------------------------------------
362 function setActorImage (actorModel: MActorImages, type: ActorImageType, imageModel: MActorImage) {
363 const id = imageModel
367 if (type === ActorImageType.AVATAR) {
368 actorModel.avatarId = id
369 actorModel.Avatar = imageModel
371 actorModel.bannerId = id
372 actorModel.Banner = imageModel
378 function saveActorAndServerAndModelIfNotExist (
379 result: FetchRemoteActorResult,
380 ownerActor?: MActorFullActor,
382 ): Bluebird<MActorFullActor> | Promise<MActorFullActor> {
383 const actor = result.actor
385 if (t !== undefined) return save(t)
387 return sequelizeTypescript.transaction(t => save(t))
389 async function save (t: Transaction) {
390 const actorHost = new URL(actor.url).host
392 const serverOptions = {
401 const [ server ] = await ServerModel.findOrCreate(serverOptions)
403 // Save our new account in database
404 actor.serverId = server.id
408 const avatar = await ActorImageModel.create({
409 filename: result.avatar.name,
410 fileUrl: result.avatar.fileUrl,
412 type: ActorImageType.AVATAR
413 }, { transaction: t })
415 actor.avatarId = avatar.id
420 const banner = await ActorImageModel.create({
421 filename: result.banner.name,
422 fileUrl: result.banner.fileUrl,
424 type: ActorImageType.BANNER
425 }, { transaction: t })
427 actor.bannerId = banner.id
430 // Force the actor creation, sometimes Sequelize skips the save() when it thinks the instance already exists
431 // (which could be false in a retried query)
432 const [ actorCreated, created ] = await ActorModel.findOrCreate<MActorFullActor>({
433 defaults: actor.toJSON(),
440 serverId: actor.serverId,
441 preferredUsername: actor.preferredUsername
448 // Try to fix non HTTPS accounts of remote instances that fixed their URL afterwards
449 if (created !== true && actorCreated.url !== actor.url) {
450 // Only fix http://example.com/account/djidane to https://example.com/account/djidane
451 if (actorCreated.url.replace(/^http:\/\//, '') !== actor.url.replace(/^https:\/\//, '')) {
452 throw new Error(`Actor from DB with URL ${actorCreated.url} does not correspond to actor ${actor.url}`)
455 actorCreated.url = actor.url
456 await actorCreated.save({ transaction: t })
459 if (actorCreated.type === 'Person' || actorCreated.type === 'Application') {
460 actorCreated.Account = await saveAccount(actorCreated, result, t) as MAccountDefault
461 actorCreated.Account.Actor = actorCreated
462 } else if (actorCreated.type === 'Group') { // Video channel
463 const channel = await saveVideoChannel(actorCreated, result, ownerActor, t)
464 actorCreated.VideoChannel = Object.assign(channel, { Actor: actorCreated, Account: ownerActor.Account })
467 actorCreated.Server = server
473 type FetchRemoteActorResult = {
487 attributedTo: ActivityPubAttributedTo[]
489 async function fetchRemoteActor (actorUrl: string): Promise<{ statusCode?: number, result: FetchRemoteActorResult }> {
490 logger.info('Fetching remote actor %s.', actorUrl)
492 const requestResult = await doJSONRequest<ActivityPubActor>(actorUrl, { activityPub: true })
493 const actorJSON = requestResult.body
495 if (sanitizeAndCheckActorObject(actorJSON) === false) {
496 logger.debug('Remote actor JSON is not valid.', { actorJSON })
497 return { result: undefined, statusCode: requestResult.statusCode }
500 if (checkUrlsSameHost(actorJSON.id, actorUrl) !== true) {
501 logger.warn('Actor url %s has not the same host than its AP id %s', actorUrl, actorJSON.id)
502 return { result: undefined, statusCode: requestResult.statusCode }
505 const followersCount = await fetchActorTotalItems(actorJSON.followers)
506 const followingCount = await fetchActorTotalItems(actorJSON.following)
508 const actor = new ActorModel({
509 type: actorJSON.type,
510 preferredUsername: actorJSON.preferredUsername,
512 publicKey: actorJSON.publicKey.publicKeyPem,
514 followersCount: followersCount,
515 followingCount: followingCount,
516 inboxUrl: actorJSON.inbox,
517 outboxUrl: actorJSON.outbox,
518 followersUrl: actorJSON.followers,
519 followingUrl: actorJSON.following,
521 sharedInboxUrl: actorJSON.endpoints?.sharedInbox
522 ? actorJSON.endpoints.sharedInbox
526 const avatarInfo = getImageInfoIfExists(actorJSON, ActorImageType.AVATAR)
527 const bannerInfo = getImageInfoIfExists(actorJSON, ActorImageType.BANNER)
529 const name = actorJSON.name || actorJSON.preferredUsername
531 statusCode: requestResult.statusCode,
537 summary: actorJSON.summary,
538 support: actorJSON.support,
539 playlists: actorJSON.playlists,
540 attributedTo: actorJSON.attributedTo
545 async function saveAccount (actor: MActorId, result: FetchRemoteActorResult, t: Transaction) {
546 const [ accountCreated ] = await AccountModel.findOrCreate({
549 description: result.summary,
558 return accountCreated as MAccount
561 async function saveVideoChannel (actor: MActorId, result: FetchRemoteActorResult, ownerActor: MActorAccountId, t: Transaction) {
562 const [ videoChannelCreated ] = await VideoChannelModel.findOrCreate({
565 description: result.summary,
566 support: result.support,
568 accountId: ownerActor.Account.id
576 return videoChannelCreated as MChannel