1 import * as Bluebird from 'bluebird'
2 import { Transaction } from 'sequelize'
3 import * as 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 MChannelAccountDefault
38 } from '../../typings/models'
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.createJob({ 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.createJob({ 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.sharedInboxUrl = attributes.endpoints.sharedInbox
167 actorInstance.followersUrl = attributes.followers
168 actorInstance.followingUrl = attributes.following
171 type AvatarInfo = { name: string, onDisk: boolean, fileUrl: string }
172 async function updateActorAvatarInstance (actor: MActorDefault, info: AvatarInfo, t: Transaction) {
173 if (info.name !== undefined) {
174 if (actor.avatarId) {
176 await actor.Avatar.destroy({ transaction: t })
178 logger.error('Cannot remove old avatar of actor %s.', actor.url, { err })
182 const avatar = await AvatarModel.create({
185 fileUrl: info.fileUrl
186 }, { transaction: t })
188 actor.avatarId = avatar.id
189 actor.Avatar = avatar
195 async function fetchActorTotalItems (url: string) {
204 const { body } = await doRequest(options)
205 return body.totalItems ? body.totalItems : 0
207 logger.warn('Cannot fetch remote actor count %s.', url, { err })
212 async function getAvatarInfoIfExists (actorJSON: ActivityPubActor) {
214 actorJSON.icon && actorJSON.icon.type === 'Image' && MIMETYPES.IMAGE.MIMETYPE_EXT[actorJSON.icon.mediaType] !== undefined &&
215 isActivityPubUrlValid(actorJSON.icon.url)
217 const extension = MIMETYPES.IMAGE.MIMETYPE_EXT[actorJSON.icon.mediaType]
220 name: uuidv4() + extension,
221 fileUrl: actorJSON.icon.url
228 async function addFetchOutboxJob (actor: Pick<ActorModel, 'id' | 'outboxUrl'>) {
229 // Don't fetch ourselves
230 const serverActor = await getServerActor()
231 if (serverActor.id === actor.id) {
232 logger.error('Cannot fetch our own outbox!')
237 uri: actor.outboxUrl,
238 type: 'activity' as 'activity'
241 return JobQueue.Instance.createJob({ type: 'activitypub-http-fetcher', payload })
244 async function refreshActorIfNeeded <T extends MActorFull | MActorAccountChannelId> (
246 fetchedType: ActorFetchByUrlType
247 ): Promise<{ actor: T | MActorFull, refreshed: boolean }> {
248 if (!actorArg.isOutdated()) return { actor: actorArg, refreshed: false }
250 // We need more attributes
251 const actor = fetchedType === 'all'
252 ? actorArg as MActorFull
253 : await ActorModel.loadByUrlAndPopulateAccountAndChannel(actorArg.url)
258 actorUrl = await getUrlFromWebfinger(actor.preferredUsername + '@' + actor.getHost())
260 logger.warn('Cannot get actor URL from webfinger, keeping the old one.', err)
264 const { result, statusCode } = await fetchRemoteActor(actorUrl)
266 if (statusCode === 404) {
267 logger.info('Deleting actor %s because there is a 404 in refresh actor.', actor.url)
268 actor.Account ? actor.Account.destroy() : actor.VideoChannel.destroy()
269 return { actor: undefined, refreshed: false }
272 if (result === undefined) {
273 logger.warn('Cannot fetch remote actor in refresh actor.')
274 return { actor, refreshed: false }
277 return sequelizeTypescript.transaction(async t => {
278 updateInstanceWithAnother(actor, result.actor)
280 if (result.avatar !== undefined) {
282 name: result.avatar.name,
283 fileUrl: result.avatar.fileUrl,
287 await updateActorAvatarInstance(actor, avatarInfo, t)
291 actor.setDataValue('updatedAt', new Date())
292 await actor.save({ transaction: t })
295 actor.Account.name = result.name
296 actor.Account.description = result.summary
298 await actor.Account.save({ transaction: t })
299 } else if (actor.VideoChannel) {
300 actor.VideoChannel.name = result.name
301 actor.VideoChannel.description = result.summary
302 actor.VideoChannel.support = result.support
304 await actor.VideoChannel.save({ transaction: t })
307 return { refreshed: true, actor }
310 logger.warn('Cannot refresh actor %s.', actor.url, { err })
311 return { actor, refreshed: false }
316 getOrCreateActorAndServerAndModel,
319 fetchActorTotalItems,
320 getAvatarInfoIfExists,
322 refreshActorIfNeeded,
323 updateActorAvatarInstance,
327 // ---------------------------------------------------------------------------
329 function saveActorAndServerAndModelIfNotExist (
330 result: FetchRemoteActorResult,
331 ownerActor?: MActorFullActor,
333 ): Bluebird<MActorFullActor> | Promise<MActorFullActor> {
334 let actor = result.actor
336 if (t !== undefined) return save(t)
338 return sequelizeTypescript.transaction(t => save(t))
340 async function save (t: Transaction) {
341 const actorHost = url.parse(actor.url).host
343 const serverOptions = {
352 const [ server ] = await ServerModel.findOrCreate(serverOptions)
354 // Save our new account in database
355 actor.serverId = server.id
359 const avatar = await AvatarModel.create({
360 filename: result.avatar.name,
361 fileUrl: result.avatar.fileUrl,
363 }, { transaction: t })
365 actor.avatarId = avatar.id
368 // Force the actor creation, sometimes Sequelize skips the save() when it thinks the instance already exists
369 // (which could be false in a retried query)
370 const [ actorCreated ] = await ActorModel.findOrCreate<MActorFullActor>({
371 defaults: actor.toJSON(),
378 if (actorCreated.type === 'Person' || actorCreated.type === 'Application') {
379 actorCreated.Account = await saveAccount(actorCreated, result, t) as MAccountDefault
380 actorCreated.Account.Actor = actorCreated
381 } else if (actorCreated.type === 'Group') { // Video channel
382 const channel = await saveVideoChannel(actorCreated, result, ownerActor, t)
383 actorCreated.VideoChannel = Object.assign(channel, { Actor: actorCreated, Account: ownerActor.Account })
386 actorCreated.Server = server
392 type FetchRemoteActorResult = {
402 attributedTo: ActivityPubAttributedTo[]
404 async function fetchRemoteActor (actorUrl: string): Promise<{ statusCode?: number, result: FetchRemoteActorResult }> {
412 logger.info('Fetching remote actor %s.', actorUrl)
414 const requestResult = await doRequest<ActivityPubActor>(options)
415 const actorJSON = requestResult.body
417 if (sanitizeAndCheckActorObject(actorJSON) === false) {
418 logger.debug('Remote actor JSON is not valid.', { actorJSON })
419 return { result: undefined, statusCode: requestResult.response.statusCode }
422 if (checkUrlsSameHost(actorJSON.id, actorUrl) !== true) {
423 logger.warn('Actor url %s has not the same host than its AP id %s', actorUrl, actorJSON.id)
424 return { result: undefined, statusCode: requestResult.response.statusCode }
427 const followersCount = await fetchActorTotalItems(actorJSON.followers)
428 const followingCount = await fetchActorTotalItems(actorJSON.following)
430 const actor = new ActorModel({
431 type: actorJSON.type,
432 preferredUsername: actorJSON.preferredUsername,
434 publicKey: actorJSON.publicKey.publicKeyPem,
436 followersCount: followersCount,
437 followingCount: followingCount,
438 inboxUrl: actorJSON.inbox,
439 outboxUrl: actorJSON.outbox,
440 sharedInboxUrl: actorJSON.endpoints.sharedInbox,
441 followersUrl: actorJSON.followers,
442 followingUrl: actorJSON.following
445 const avatarInfo = await getAvatarInfoIfExists(actorJSON)
447 const name = actorJSON.name || actorJSON.preferredUsername
449 statusCode: requestResult.response.statusCode,
454 summary: actorJSON.summary,
455 support: actorJSON.support,
456 playlists: actorJSON.playlists,
457 attributedTo: actorJSON.attributedTo
462 async function saveAccount (actor: MActorId, result: FetchRemoteActorResult, t: Transaction) {
463 const [ accountCreated ] = await AccountModel.findOrCreate({
466 description: result.summary,
475 return accountCreated as MAccount
478 async function saveVideoChannel (actor: MActorId, result: FetchRemoteActorResult, ownerActor: MActorAccountId, t: Transaction) {
479 const [ videoChannelCreated ] = await VideoChannelModel.findOrCreate({
482 description: result.summary,
483 support: result.support,
485 accountId: ownerActor.Account.id
493 return videoChannelCreated as MChannel