server/lib/activitypub/actor.ts

   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'
  27 import {
  28   MAccount,
  29   MAccountDefault,
  30   MActor,
  31   MActorAccountChannelId,
  32   MActorAccountChannelIdActor,
  33   MActorAccountId,
  34   MActorFull,
  35   MActorFullActor,
  36   MActorId,
  37   MActorImage,
  38   MActorImages,
  39   MChannel
  40 } from '../../types/models'
  41 import { JobQueue } from '../job-queue'
  42
  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()
  46
  47   actor.publicKey = publicKey
  48   actor.privateKey = privateKey
  49
  50   return actor.save()
  51 }
  52
  53 function getOrCreateActorAndServerAndModel (
  54   activityActor: string | ActivityPubActor,
  55   fetchType: 'all',
  56   recurseIfNeeded?: boolean,
  57   updateCollections?: boolean
  58 ): Promise<MActorFullActor>
  59
  60 function getOrCreateActorAndServerAndModel (
  61   activityActor: string | ActivityPubActor,
  62   fetchType?: 'association-ids',
  63   recurseIfNeeded?: boolean,
  64   updateCollections?: boolean
  65 ): Promise<MActorAccountChannelId>
  66
  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)
  74   let created = false
  75   let accountPlaylistsUrl: string
  76
  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)) {
  80     await actor.destroy()
  81     actor = null
  82   }
  83
  84   // We don't have this actor in our database, fetch it on remote
  85   if (!actor) {
  86     const { result } = await fetchRemoteActor(actorUrl)
  87     if (result === undefined) throw new Error('Cannot fetch remote actor ' + actorUrl)
  88
  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)
  95
  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}`)
  98       }
  99
 100       try {
 101         // Don't recurse another time
 102         const recurseIfNeeded = false
 103         ownerActor = await getOrCreateActorAndServerAndModel(accountAttributedTo.id, 'all', recurseIfNeeded)
 104       } catch (err) {
 105         logger.error('Cannot get or create account attributed to video channel ' + actorUrl)
 106         throw new Error(err)
 107       }
 108     }
 109
 110     actor = await retryTransactionWrapper(saveActorAndServerAndModelIfNotExist, result, ownerActor)
 111     created = true
 112     accountPlaylistsUrl = result.playlists
 113   }
 114
 115   if (actor.Account) (actor as MActorAccountChannelIdActor).Account.Actor = actor
 116   if (actor.VideoChannel) (actor as MActorAccountChannelIdActor).VideoChannel.Actor = actor
 117
 118   const { actor: actorRefreshed, refreshed } = await retryTransactionWrapper(refreshActorIfNeeded, actor, fetchType)
 119   if (!actorRefreshed) throw new Error('Actor ' + actor.url + ' does not exist anymore.')
 120
 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 })
 124   }
 125
 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 })
 130   }
 131
 132   return actorRefreshed
 133 }
 134
 135 function buildActorInstance (type: ActivityPubActorType, url: string, preferredUsername: string, uuid?: string) {
 136   return new ActorModel({
 137     type,
 138     url,
 139     preferredUsername,
 140     uuid,
 141     publicKey: null,
 142     privateKey: null,
 143     followersCount: 0,
 144     followingCount: 0,
 145     inboxUrl: url + '/inbox',
 146     outboxUrl: url + '/outbox',
 147     sharedInboxUrl: WEBSERVER.URL + '/inbox',
 148     followersUrl: url + '/followers',
 149     followingUrl: url + '/following'
 150   }) as MActor
 151 }
 152
 153 async function updateActorInstance (actorInstance: ActorModel, attributes: ActivityPubActor) {
 154   const followersCount = await fetchActorTotalItems(attributes.followers)
 155   const followingCount = await fetchActorTotalItems(attributes.following)
 156
 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
 167
 168   if (attributes.endpoints?.sharedInbox) {
 169     actorInstance.sharedInboxUrl = attributes.endpoints.sharedInbox
 170   }
 171 }
 172
 173 type ImageInfo = {
 174   name: string
 175   fileUrl: string
 176   height: number
 177   width: number
 178   onDisk?: boolean
 179 }
 180 async function updateActorImageInstance (actor: MActorImages, type: ActorImageType, imageInfo: ImageInfo | null, t: Transaction) {
 181   const oldImageModel = type === ActorImageType.AVATAR
 182     ? actor.Avatar
 183     : actor.Banner
 184
 185   if (oldImageModel) {
 186     // Don't update the avatar if the file URL did not change
 187     if (imageInfo?.fileUrl && oldImageModel.fileUrl === imageInfo.fileUrl) return actor
 188
 189     try {
 190       await oldImageModel.destroy({ transaction: t })
 191
 192       setActorImage(actor, type, null)
 193     } catch (err) {
 194       logger.error('Cannot remove old actor image of actor %s.', actor.url, { err })
 195     }
 196   }
 197
 198   if (imageInfo) {
 199     const imageModel = await ActorImageModel.create({
 200       filename: imageInfo.name,
 201       onDisk: imageInfo.onDisk ?? false,
 202       fileUrl: imageInfo.fileUrl,
 203       height: imageInfo.height,
 204       width: imageInfo.width,
 205       type
 206     }, { transaction: t })
 207
 208     setActorImage(actor, type, imageModel)
 209   }
 210
 211   return actor
 212 }
 213
 214 async function deleteActorImageInstance (actor: MActorImages, type: ActorImageType, t: Transaction) {
 215   try {
 216     if (type === ActorImageType.AVATAR) {
 217       await actor.Avatar.destroy({ transaction: t })
 218
 219       actor.avatarId = null
 220       actor.Avatar = null
 221     } else {
 222       await actor.Banner.destroy({ transaction: t })
 223
 224       actor.bannerId = null
 225       actor.Banner = null
 226     }
 227   } catch (err) {
 228     logger.error('Cannot remove old image of actor %s.', actor.url, { err })
 229   }
 230
 231   return actor
 232 }
 233
 234 async function fetchActorTotalItems (url: string) {
 235   try {
 236     const { body } = await doJSONRequest<ActivityPubOrderedCollection<unknown>>(url, { activityPub: true })
 237
 238     return body.totalItems || 0
 239   } catch (err) {
 240     logger.warn('Cannot fetch remote actor count %s.', url, { err })
 241     return 0
 242   }
 243 }
 244
 245 function getImageInfoIfExists (actorJSON: ActivityPubActor, type: ActorImageType) {
 246   const mimetypes = MIMETYPES.IMAGE
 247   const icon = type === ActorImageType.AVATAR
 248     ? actorJSON.icon
 249     : actorJSON.image
 250
 251   if (!icon || icon.type !== 'Image' || !isActivityPubUrlValid(icon.url)) return undefined
 252
 253   let extension: string
 254
 255   if (icon.mediaType) {
 256     extension = mimetypes.MIMETYPE_EXT[icon.mediaType]
 257   } else {
 258     const tmp = extname(icon.url)
 259
 260     if (mimetypes.EXT_MIMETYPE[tmp] !== undefined) extension = tmp
 261   }
 262
 263   if (!extension) return undefined
 264
 265   return {
 266     name: uuidv4() + extension,
 267     fileUrl: icon.url,
 268     height: icon.height,
 269     width: icon.width,
 270     type
 271   }
 272 }
 273
 274 async function addFetchOutboxJob (actor: Pick<ActorModel, 'id' | 'outboxUrl'>) {
 275   // Don't fetch ourselves
 276   const serverActor = await getServerActor()
 277   if (serverActor.id === actor.id) {
 278     logger.error('Cannot fetch our own outbox!')
 279     return undefined
 280   }
 281
 282   const payload = {
 283     uri: actor.outboxUrl,
 284     type: 'activity' as 'activity'
 285   }
 286
 287   return JobQueue.Instance.createJob({ type: 'activitypub-http-fetcher', payload })
 288 }
 289
 290 async function refreshActorIfNeeded <T extends MActorFull | MActorAccountChannelId> (
 291   actorArg: T,
 292   fetchedType: ActorFetchByUrlType
 293 ): Promise<{ actor: T | MActorFull, refreshed: boolean }> {
 294   if (!actorArg.isOutdated()) return { actor: actorArg, refreshed: false }
 295
 296   // We need more attributes
 297   const actor = fetchedType === 'all'
 298     ? actorArg as MActorFull
 299     : await ActorModel.loadByUrlAndPopulateAccountAndChannel(actorArg.url)
 300
 301   try {
 302     let actorUrl: string
 303     try {
 304       actorUrl = await getUrlFromWebfinger(actor.preferredUsername + '@' + actor.getHost())
 305     } catch (err) {
 306       logger.warn('Cannot get actor URL from webfinger, keeping the old one.', err)
 307       actorUrl = actor.url
 308     }
 309
 310     const { result } = await fetchRemoteActor(actorUrl)
 311
 312     if (result === undefined) {
 313       logger.warn('Cannot fetch remote actor in refresh actor.')
 314       return { actor, refreshed: false }
 315     }
 316
 317     return sequelizeTypescript.transaction(async t => {
 318       updateInstanceWithAnother(actor, result.actor)
 319
 320       await updateActorImageInstance(actor, ActorImageType.AVATAR, result.avatar, t)
 321       await updateActorImageInstance(actor, ActorImageType.BANNER, result.banner, t)
 322
 323       // Force update
 324       actor.setDataValue('updatedAt', new Date())
 325       await actor.save({ transaction: t })
 326
 327       if (actor.Account) {
 328         actor.Account.name = result.name
 329         actor.Account.description = result.summary
 330
 331         await actor.Account.save({ transaction: t })
 332       } else if (actor.VideoChannel) {
 333         actor.VideoChannel.name = result.name
 334         actor.VideoChannel.description = result.summary
 335         actor.VideoChannel.support = result.support
 336
 337         await actor.VideoChannel.save({ transaction: t })
 338       }
 339
 340       return { refreshed: true, actor }
 341     })
 342   } catch (err) {
 343     if ((err as PeerTubeRequestError).statusCode === HttpStatusCode.NOT_FOUND_404) {
 344       logger.info('Deleting actor %s because there is a 404 in refresh actor.', actor.url)
 345       actor.Account
 346         ? await actor.Account.destroy()
 347         : await actor.VideoChannel.destroy()
 348
 349       return { actor: undefined, refreshed: false }
 350     }
 351
 352     logger.warn('Cannot refresh actor %s.', actor.url, { err })
 353     return { actor, refreshed: false }
 354   }
 355 }
 356
 357 export {
 358   getOrCreateActorAndServerAndModel,
 359   buildActorInstance,
 360   generateAndSaveActorKeys,
 361   fetchActorTotalItems,
 362   getImageInfoIfExists,
 363   updateActorInstance,
 364   deleteActorImageInstance,
 365   refreshActorIfNeeded,
 366   updateActorImageInstance,
 367   addFetchOutboxJob
 368 }
 369
 370 // ---------------------------------------------------------------------------
 371
 372 function setActorImage (actorModel: MActorImages, type: ActorImageType, imageModel: MActorImage) {
 373   const id = imageModel
 374     ? imageModel.id
 375     : null
 376
 377   if (type === ActorImageType.AVATAR) {
 378     actorModel.avatarId = id
 379     actorModel.Avatar = imageModel
 380   } else {
 381     actorModel.bannerId = id
 382     actorModel.Banner = imageModel
 383   }
 384
 385   return actorModel
 386 }
 387
 388 function saveActorAndServerAndModelIfNotExist (
 389   result: FetchRemoteActorResult,
 390   ownerActor?: MActorFullActor,
 391   t?: Transaction
 392 ): Bluebird<MActorFullActor> | Promise<MActorFullActor> {
 393   const actor = result.actor
 394
 395   if (t !== undefined) return save(t)
 396
 397   return sequelizeTypescript.transaction(t => save(t))
 398
 399   async function save (t: Transaction) {
 400     const actorHost = new URL(actor.url).host
 401
 402     const serverOptions = {
 403       where: {
 404         host: actorHost
 405       },
 406       defaults: {
 407         host: actorHost
 408       },
 409       transaction: t
 410     }
 411     const [ server ] = await ServerModel.findOrCreate(serverOptions)
 412
 413     // Save our new account in database
 414     actor.serverId = server.id
 415
 416     // Avatar?
 417     if (result.avatar) {
 418       const avatar = await ActorImageModel.create({
 419         filename: result.avatar.name,
 420         fileUrl: result.avatar.fileUrl,
 421         width: result.avatar.width,
 422         height: result.avatar.height,
 423         onDisk: false,
 424         type: ActorImageType.AVATAR
 425       }, { transaction: t })
 426
 427       actor.avatarId = avatar.id
 428     }
 429
 430     // Banner?
 431     if (result.banner) {
 432       const banner = await ActorImageModel.create({
 433         filename: result.banner.name,
 434         fileUrl: result.banner.fileUrl,
 435         width: result.banner.width,
 436         height: result.banner.height,
 437         onDisk: false,
 438         type: ActorImageType.BANNER
 439       }, { transaction: t })
 440
 441       actor.bannerId = banner.id
 442     }
 443
 444     // Force the actor creation, sometimes Sequelize skips the save() when it thinks the instance already exists
 445     // (which could be false in a retried query)
 446     const [ actorCreated, created ] = await ActorModel.findOrCreate<MActorFullActor>({
 447       defaults: actor.toJSON(),
 448       where: {
 449         [Op.or]: [
 450           {
 451             url: actor.url
 452           },
 453           {
 454             serverId: actor.serverId,
 455             preferredUsername: actor.preferredUsername
 456           }
 457         ]
 458       },
 459       transaction: t
 460     })
 461
 462     // Try to fix non HTTPS accounts of remote instances that fixed their URL afterwards
 463     if (created !== true && actorCreated.url !== actor.url) {
 464       // Only fix http://example.com/account/djidane to https://example.com/account/djidane
 465       if (actorCreated.url.replace(/^http:\/\//, '') !== actor.url.replace(/^https:\/\//, '')) {
 466         throw new Error(`Actor from DB with URL ${actorCreated.url} does not correspond to actor ${actor.url}`)
 467       }
 468
 469       actorCreated.url = actor.url
 470       await actorCreated.save({ transaction: t })
 471     }
 472
 473     if (actorCreated.type === 'Person' || actorCreated.type === 'Application') {
 474       actorCreated.Account = await saveAccount(actorCreated, result, t) as MAccountDefault
 475       actorCreated.Account.Actor = actorCreated
 476     } else if (actorCreated.type === 'Group') { // Video channel
 477       const channel = await saveVideoChannel(actorCreated, result, ownerActor, t)
 478       actorCreated.VideoChannel = Object.assign(channel, { Actor: actorCreated, Account: ownerActor.Account })
 479     }
 480
 481     actorCreated.Server = server
 482
 483     return actorCreated
 484   }
 485 }
 486
 487 type ImageResult = {
 488   name: string
 489   fileUrl: string
 490   height: number
 491   width: number
 492 }
 493
 494 type FetchRemoteActorResult = {
 495   actor: MActor
 496   name: string
 497   summary: string
 498   support?: string
 499   playlists?: string
 500   avatar?: ImageResult
 501   banner?: ImageResult
 502   attributedTo: ActivityPubAttributedTo[]
 503 }
 504 async function fetchRemoteActor (actorUrl: string): Promise<{ statusCode?: number, result: FetchRemoteActorResult }> {
 505   logger.info('Fetching remote actor %s.', actorUrl)
 506
 507   const requestResult = await doJSONRequest<ActivityPubActor>(actorUrl, { activityPub: true })
 508   const actorJSON = requestResult.body
 509
 510   if (sanitizeAndCheckActorObject(actorJSON) === false) {
 511     logger.debug('Remote actor JSON is not valid.', { actorJSON })
 512     return { result: undefined, statusCode: requestResult.statusCode }
 513   }
 514
 515   if (checkUrlsSameHost(actorJSON.id, actorUrl) !== true) {
 516     logger.warn('Actor url %s has not the same host than its AP id %s', actorUrl, actorJSON.id)
 517     return { result: undefined, statusCode: requestResult.statusCode }
 518   }
 519
 520   const followersCount = await fetchActorTotalItems(actorJSON.followers)
 521   const followingCount = await fetchActorTotalItems(actorJSON.following)
 522
 523   const actor = new ActorModel({
 524     type: actorJSON.type,
 525     preferredUsername: actorJSON.preferredUsername,
 526     url: actorJSON.id,
 527     publicKey: actorJSON.publicKey.publicKeyPem,
 528     privateKey: null,
 529     followersCount: followersCount,
 530     followingCount: followingCount,
 531     inboxUrl: actorJSON.inbox,
 532     outboxUrl: actorJSON.outbox,
 533     followersUrl: actorJSON.followers,
 534     followingUrl: actorJSON.following,
 535
 536     sharedInboxUrl: actorJSON.endpoints?.sharedInbox
 537       ? actorJSON.endpoints.sharedInbox
 538       : null
 539   })
 540
 541   const avatarInfo = getImageInfoIfExists(actorJSON, ActorImageType.AVATAR)
 542   const bannerInfo = getImageInfoIfExists(actorJSON, ActorImageType.BANNER)
 543
 544   const name = actorJSON.name || actorJSON.preferredUsername
 545   return {
 546     statusCode: requestResult.statusCode,
 547     result: {
 548       actor,
 549       name,
 550       avatar: avatarInfo,
 551       banner: bannerInfo,
 552       summary: actorJSON.summary,
 553       support: actorJSON.support,
 554       playlists: actorJSON.playlists,
 555       attributedTo: actorJSON.attributedTo
 556     }
 557   }
 558 }
 559
 560 async function saveAccount (actor: MActorId, result: FetchRemoteActorResult, t: Transaction) {
 561   const [ accountCreated ] = await AccountModel.findOrCreate({
 562     defaults: {
 563       name: result.name,
 564       description: result.summary,
 565       actorId: actor.id
 566     },
 567     where: {
 568       actorId: actor.id
 569     },
 570     transaction: t
 571   })
 572
 573   return accountCreated as MAccount
 574 }
 575
 576 async function saveVideoChannel (actor: MActorId, result: FetchRemoteActorResult, ownerActor: MActorAccountId, t: Transaction) {
 577   const [ videoChannelCreated ] = await VideoChannelModel.findOrCreate({
 578     defaults: {
 579       name: result.name,
 580       description: result.summary,
 581       support: result.support,
 582       actorId: actor.id,
 583       accountId: ownerActor.Account.id
 584     },
 585     where: {
 586       actorId: actor.id
 587     },
 588     transaction: t
 589   })
 590
 591   return videoChannelCreated as MChannel
 592 }