1 import * as Bluebird from 'bluebird'
2 import { Transaction } from 'sequelize'
3 import { URL } from 'url'
4 import * as uuidv4 from 'uuid/v4'
5 import { ActivityPubActor, ActivityPubActorType } from '../../../shared/models/activitypub'
6 import { ActivityPubAttributedTo } from '../../../shared/models/activitypub/objects'
7 import { checkUrlsSameHost, getAPId } from '../../helpers/activitypub'
8 import { sanitizeAndCheckActorObject } from '../../helpers/custom-validators/activitypub/actor'
9 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
10 import { retryTransactionWrapper, updateInstanceWithAnother } from '../../helpers/database-utils'
11 import { logger } from '../../helpers/logger'
12 import { createPrivateAndPublicKeys } from '../../helpers/peertube-crypto'
13 import { doRequest } from '../../helpers/requests'
14 import { getUrlFromWebfinger } from '../../helpers/webfinger'
15 import { MIMETYPES, WEBSERVER } from '../../initializers/constants'
16 import { AccountModel } from '../../models/account/account'
17 import { ActorModel } from '../../models/activitypub/actor'
18 import { AvatarModel } from '../../models/avatar/avatar'
19 import { ServerModel } from '../../models/server/server'
20 import { VideoChannelModel } from '../../models/video/video-channel'
21 import { JobQueue } from '../job-queue'
22 import { getServerActor } from '../../helpers/utils'
23 import { ActorFetchByUrlType, fetchActorByUrl } from '../../helpers/actor'
24 import { sequelizeTypescript } from '../../initializers/database'
29 MActorAccountChannelId,
30 MActorAccountChannelIdActor,
37 } from '../../typings/models'
38 import { extname } from 'path'
40 // Set account keys, this could be long so process after the account creation and do not block the client
41 function setAsyncActorKeys <T extends MActor> (actor: T) {
42 return createPrivateAndPublicKeys()
43 .then(({ publicKey, privateKey }) => {
44 actor.publicKey = publicKey
45 actor.privateKey = privateKey
49 logger.error('Cannot set public/private keys of actor %d.', actor.url, { err })
54 function getOrCreateActorAndServerAndModel (
55 activityActor: string | ActivityPubActor,
57 recurseIfNeeded?: boolean,
58 updateCollections?: boolean
59 ): Promise<MActorFullActor>
61 function getOrCreateActorAndServerAndModel (
62 activityActor: string | ActivityPubActor,
63 fetchType?: 'association-ids',
64 recurseIfNeeded?: boolean,
65 updateCollections?: boolean
66 ): Promise<MActorAccountChannelId>
68 async function getOrCreateActorAndServerAndModel (
69 activityActor: string | ActivityPubActor,
70 fetchType: ActorFetchByUrlType = 'association-ids',
71 recurseIfNeeded = true,
72 updateCollections = false
73 ): Promise<MActorFullActor | MActorAccountChannelId> {
74 const actorUrl = getAPId(activityActor)
76 let accountPlaylistsUrl: string
78 let actor = await fetchActorByUrl(actorUrl, fetchType)
79 // Orphan actor (not associated to an account of channel) so recreate it
80 if (actor && (!actor.Account && !actor.VideoChannel)) {
85 // We don't have this actor in our database, fetch it on remote
87 const { result } = await fetchRemoteActor(actorUrl)
88 if (result === undefined) throw new Error('Cannot fetch remote actor ' + actorUrl)
90 // Create the attributed to actor
91 // In PeerTube a video channel is owned by an account
92 let ownerActor: MActorFullActor
93 if (recurseIfNeeded === true && result.actor.type === 'Group') {
94 const accountAttributedTo = result.attributedTo.find(a => a.type === 'Person')
95 if (!accountAttributedTo) throw new Error('Cannot find account attributed to video channel ' + actor.url)
97 if (checkUrlsSameHost(accountAttributedTo.id, actorUrl) !== true) {
98 throw new Error(`Account attributed to ${accountAttributedTo.id} does not have the same host than actor url ${actorUrl}`)
102 // Don't recurse another time
103 const recurseIfNeeded = false
104 ownerActor = await getOrCreateActorAndServerAndModel(accountAttributedTo.id, 'all', recurseIfNeeded)
106 logger.error('Cannot get or create account attributed to video channel ' + actor.url)
111 actor = await retryTransactionWrapper(saveActorAndServerAndModelIfNotExist, result, ownerActor)
113 accountPlaylistsUrl = result.playlists
116 if (actor.Account) (actor as MActorAccountChannelIdActor).Account.Actor = actor
117 if (actor.VideoChannel) (actor as MActorAccountChannelIdActor).VideoChannel.Actor = actor
119 const { actor: actorRefreshed, refreshed } = await retryTransactionWrapper(refreshActorIfNeeded, actor, fetchType)
120 if (!actorRefreshed) throw new Error('Actor ' + actorRefreshed.url + ' does not exist anymore.')
122 if ((created === true || refreshed === true) && updateCollections === true) {
123 const payload = { uri: actor.outboxUrl, type: 'activity' as 'activity' }
124 await JobQueue.Instance.createJobWithPromise({ type: 'activitypub-http-fetcher', payload })
127 // We created a new account: fetch the playlists
128 if (created === true && actor.Account && accountPlaylistsUrl) {
129 const payload = { uri: accountPlaylistsUrl, accountId: actor.Account.id, type: 'account-playlists' as 'account-playlists' }
130 await JobQueue.Instance.createJobWithPromise({ type: 'activitypub-http-fetcher', payload })
133 return actorRefreshed
136 function buildActorInstance (type: ActivityPubActorType, url: string, preferredUsername: string, uuid?: string) {
137 return new ActorModel({
146 inboxUrl: url + '/inbox',
147 outboxUrl: url + '/outbox',
148 sharedInboxUrl: WEBSERVER.URL + '/inbox',
149 followersUrl: url + '/followers',
150 followingUrl: url + '/following'
154 async function updateActorInstance (actorInstance: ActorModel, attributes: ActivityPubActor) {
155 const followersCount = await fetchActorTotalItems(attributes.followers)
156 const followingCount = await fetchActorTotalItems(attributes.following)
158 actorInstance.type = attributes.type
159 actorInstance.preferredUsername = attributes.preferredUsername
160 actorInstance.url = attributes.id
161 actorInstance.publicKey = attributes.publicKey.publicKeyPem
162 actorInstance.followersCount = followersCount
163 actorInstance.followingCount = followingCount
164 actorInstance.inboxUrl = attributes.inbox
165 actorInstance.outboxUrl = attributes.outbox
166 actorInstance.followersUrl = attributes.followers
167 actorInstance.followingUrl = attributes.following
169 if (attributes.endpoints && attributes.endpoints.sharedInbox) {
170 actorInstance.sharedInboxUrl = attributes.endpoints.sharedInbox
174 type AvatarInfo = { name: string, onDisk: boolean, fileUrl: string }
175 async function updateActorAvatarInstance (actor: MActorDefault, info: AvatarInfo, t: Transaction) {
176 if (!info.name) return actor
179 // Don't update the avatar if the filename did not change
180 if (actor.Avatar.fileUrl === info.fileUrl) return actor
183 await actor.Avatar.destroy({ transaction: t })
185 logger.error('Cannot remove old avatar of actor %s.', actor.url, { err })
189 const avatar = await AvatarModel.create({
192 fileUrl: info.fileUrl
193 }, { transaction: t })
195 actor.avatarId = avatar.id
196 actor.Avatar = avatar
201 async function fetchActorTotalItems (url: string) {
210 const { body } = await doRequest(options)
211 return body.totalItems ? body.totalItems : 0
213 logger.warn('Cannot fetch remote actor count %s.', url, { err })
218 function getAvatarInfoIfExists (actorJSON: ActivityPubActor) {
219 const mimetypes = MIMETYPES.IMAGE
220 const icon = actorJSON.icon
222 if (!icon || icon.type !== 'Image' || !isActivityPubUrlValid(icon.url)) return undefined
224 const extension = icon.mediaType
225 ? mimetypes.MIMETYPE_EXT[icon.mediaType]
228 if (!extension) return undefined
231 name: uuidv4() + extension,
236 async function addFetchOutboxJob (actor: Pick<ActorModel, 'id' | 'outboxUrl'>) {
237 // Don't fetch ourselves
238 const serverActor = await getServerActor()
239 if (serverActor.id === actor.id) {
240 logger.error('Cannot fetch our own outbox!')
245 uri: actor.outboxUrl,
246 type: 'activity' as 'activity'
249 return JobQueue.Instance.createJob({ type: 'activitypub-http-fetcher', payload })
252 async function refreshActorIfNeeded <T extends MActorFull | MActorAccountChannelId> (
254 fetchedType: ActorFetchByUrlType
255 ): Promise<{ actor: T | MActorFull, refreshed: boolean }> {
256 if (!actorArg.isOutdated()) return { actor: actorArg, refreshed: false }
258 // We need more attributes
259 const actor = fetchedType === 'all'
260 ? actorArg as MActorFull
261 : await ActorModel.loadByUrlAndPopulateAccountAndChannel(actorArg.url)
266 actorUrl = await getUrlFromWebfinger(actor.preferredUsername + '@' + actor.getHost())
268 logger.warn('Cannot get actor URL from webfinger, keeping the old one.', err)
272 const { result, statusCode } = await fetchRemoteActor(actorUrl)
274 if (statusCode === 404) {
275 logger.info('Deleting actor %s because there is a 404 in refresh actor.', actor.url)
277 ? await actor.Account.destroy()
278 : await actor.VideoChannel.destroy()
280 return { actor: undefined, refreshed: false }
283 if (result === undefined) {
284 logger.warn('Cannot fetch remote actor in refresh actor.')
285 return { actor, refreshed: false }
288 return sequelizeTypescript.transaction(async t => {
289 updateInstanceWithAnother(actor, result.actor)
291 if (result.avatar !== undefined) {
293 name: result.avatar.name,
294 fileUrl: result.avatar.fileUrl,
298 await updateActorAvatarInstance(actor, avatarInfo, t)
302 actor.setDataValue('updatedAt', new Date())
303 await actor.save({ transaction: t })
306 actor.Account.name = result.name
307 actor.Account.description = result.summary
309 await actor.Account.save({ transaction: t })
310 } else if (actor.VideoChannel) {
311 actor.VideoChannel.name = result.name
312 actor.VideoChannel.description = result.summary
313 actor.VideoChannel.support = result.support
315 await actor.VideoChannel.save({ transaction: t })
318 return { refreshed: true, actor }
321 logger.warn('Cannot refresh actor %s.', actor.url, { err })
322 return { actor, refreshed: false }
327 getOrCreateActorAndServerAndModel,
330 fetchActorTotalItems,
331 getAvatarInfoIfExists,
333 refreshActorIfNeeded,
334 updateActorAvatarInstance,
338 // ---------------------------------------------------------------------------
340 function saveActorAndServerAndModelIfNotExist (
341 result: FetchRemoteActorResult,
342 ownerActor?: MActorFullActor,
344 ): Bluebird<MActorFullActor> | Promise<MActorFullActor> {
345 const actor = result.actor
347 if (t !== undefined) return save(t)
349 return sequelizeTypescript.transaction(t => save(t))
351 async function save (t: Transaction) {
352 const actorHost = new URL(actor.url).host
354 const serverOptions = {
363 const [ server ] = await ServerModel.findOrCreate(serverOptions)
365 // Save our new account in database
366 actor.serverId = server.id
370 const avatar = await AvatarModel.create({
371 filename: result.avatar.name,
372 fileUrl: result.avatar.fileUrl,
374 }, { transaction: t })
376 actor.avatarId = avatar.id
379 // Force the actor creation, sometimes Sequelize skips the save() when it thinks the instance already exists
380 // (which could be false in a retried query)
381 const [ actorCreated ] = await ActorModel.findOrCreate<MActorFullActor>({
382 defaults: actor.toJSON(),
389 if (actorCreated.type === 'Person' || actorCreated.type === 'Application') {
390 actorCreated.Account = await saveAccount(actorCreated, result, t) as MAccountDefault
391 actorCreated.Account.Actor = actorCreated
392 } else if (actorCreated.type === 'Group') { // Video channel
393 const channel = await saveVideoChannel(actorCreated, result, ownerActor, t)
394 actorCreated.VideoChannel = Object.assign(channel, { Actor: actorCreated, Account: ownerActor.Account })
397 actorCreated.Server = server
403 type FetchRemoteActorResult = {
413 attributedTo: ActivityPubAttributedTo[]
415 async function fetchRemoteActor (actorUrl: string): Promise<{ statusCode?: number, result: FetchRemoteActorResult }> {
423 logger.info('Fetching remote actor %s.', actorUrl)
425 const requestResult = await doRequest<ActivityPubActor>(options)
426 const actorJSON = requestResult.body
428 if (sanitizeAndCheckActorObject(actorJSON) === false) {
429 logger.debug('Remote actor JSON is not valid.', { actorJSON })
430 return { result: undefined, statusCode: requestResult.response.statusCode }
433 if (checkUrlsSameHost(actorJSON.id, actorUrl) !== true) {
434 logger.warn('Actor url %s has not the same host than its AP id %s', actorUrl, actorJSON.id)
435 return { result: undefined, statusCode: requestResult.response.statusCode }
438 const followersCount = await fetchActorTotalItems(actorJSON.followers)
439 const followingCount = await fetchActorTotalItems(actorJSON.following)
441 const actor = new ActorModel({
442 type: actorJSON.type,
443 preferredUsername: actorJSON.preferredUsername,
445 publicKey: actorJSON.publicKey.publicKeyPem,
447 followersCount: followersCount,
448 followingCount: followingCount,
449 inboxUrl: actorJSON.inbox,
450 outboxUrl: actorJSON.outbox,
451 followersUrl: actorJSON.followers,
452 followingUrl: actorJSON.following,
454 sharedInboxUrl: actorJSON.endpoints && actorJSON.endpoints.sharedInbox
455 ? actorJSON.endpoints.sharedInbox
459 const avatarInfo = await getAvatarInfoIfExists(actorJSON)
461 const name = actorJSON.name || actorJSON.preferredUsername
463 statusCode: requestResult.response.statusCode,
468 summary: actorJSON.summary,
469 support: actorJSON.support,
470 playlists: actorJSON.playlists,
471 attributedTo: actorJSON.attributedTo
476 async function saveAccount (actor: MActorId, result: FetchRemoteActorResult, t: Transaction) {
477 const [ accountCreated ] = await AccountModel.findOrCreate({
480 description: result.summary,
489 return accountCreated as MAccount
492 async function saveVideoChannel (actor: MActorId, result: FetchRemoteActorResult, ownerActor: MActorAccountId, t: Transaction) {
493 const [ videoChannelCreated ] = await VideoChannelModel.findOrCreate({
496 description: result.summary,
497 support: result.support,
499 accountId: ownerActor.Account.id
507 return videoChannelCreated as MChannel