From af02ca704436ad732db655dfe3f90db9fbbaf79c Mon Sep 17 00:00:00 2001 From: Fabien O'Carroll Date: Tue, 23 Apr 2024 17:00:06 +0700 Subject: [PATCH] Initial wire up of Posts -> Outbox flow ref https://linear.app/tryghost/issue/MOM-29 This is very rough, and all still behind a flag. The idea is that any public post which is published gets added to the Outbox of the site Actor. We also dispatch an event, which will be used to deliver the Activity to any relevant inboxes, but that is outside the scope of this commit. --- ghost/core/core/boot.js | 6 ++++ .../src/core/activitypub/activity.service.ts | 36 +++++++++++++++++++ .../src/core/activitypub/article.object.ts | 10 +----- .../src/core/activitypub/jsonld.service.ts | 14 ++++++++ .../src/core/activitypub/post.repository.ts | 13 +++++++ .../in-memory/actor.repository.in-memory.ts | 1 - .../ghost/src/db/knex/post.repository.knex.ts | 32 +++++++++++++++++ .../controllers/activitypub.controller.ts | 11 ++++++ .../src/nestjs/modules/activitypub.module.ts | 10 ++++++ ghost/posts-service/lib/PostsService.js | 9 +++++ 10 files changed, 132 insertions(+), 10 deletions(-) create mode 100644 ghost/ghost/src/core/activitypub/activity.service.ts create mode 100644 ghost/ghost/src/core/activitypub/post.repository.ts create mode 100644 ghost/ghost/src/db/knex/post.repository.knex.ts diff --git a/ghost/core/core/boot.js b/ghost/core/core/boot.js index a11fad8a26..575b31cbc2 100644 --- a/ghost/core/core/boot.js +++ b/ghost/core/core/boot.js @@ -408,6 +408,12 @@ async function initNestDependencies() { }, { provide: 'SettingsCache', useValue: require('./shared/settings-cache') + }, { + provide: 'knex', + useValue: require('./server/data/db').knex + }, { + provide: 'UrlUtils', + useValue: require('./shared/url-utils') }); for (const provider of providers) { GhostNestApp.addProvider(provider); diff --git a/ghost/ghost/src/core/activitypub/activity.service.ts b/ghost/ghost/src/core/activitypub/activity.service.ts new file mode 100644 index 0000000000..098ff71679 --- /dev/null +++ b/ghost/ghost/src/core/activitypub/activity.service.ts @@ -0,0 +1,36 @@ +import ObjectID from 'bson-objectid'; +import {ActorRepository} from './actor.repository'; +import {Article} from './article.object'; +import {PostRepository} from './post.repository'; +import {Inject} from '@nestjs/common'; + +export class ActivityService { + constructor( + @Inject('ActorRepository') private readonly actorRepository: ActorRepository, + @Inject('PostRepository') private readonly postRepository: PostRepository + ) {} + + async createArticleForPost(postId: ObjectID) { + const actor = await this.actorRepository.getOne('index'); + + if (!actor) { + throw new Error('Actor not found'); + } + + const post = await this.postRepository.getOne(postId); + + if (!post) { + throw new Error('Post not found'); + } + + if (post.visibility !== 'public') { + return; + } + + const article = Article.fromPost(post); + + actor.createArticle(article); + + await this.actorRepository.save(actor); + } +} diff --git a/ghost/ghost/src/core/activitypub/article.object.ts b/ghost/ghost/src/core/activitypub/article.object.ts index eb4bef4668..3ea3045e49 100644 --- a/ghost/ghost/src/core/activitypub/article.object.ts +++ b/ghost/ghost/src/core/activitypub/article.object.ts @@ -1,5 +1,6 @@ import ObjectID from 'bson-objectid'; import {ActivityPub} from './types'; +import {Post} from './post.repository'; type ArticleData = { id: ObjectID @@ -8,15 +9,6 @@ type ArticleData = { url: URL }; -type Post = { - id: ObjectID; - title: string; - slug: string; - html: string; - lexical: string; - status: 'draft' | 'published' | 'scheduled' | 'sent'; -}; - export class Article { constructor(private readonly attr: ArticleData) {} diff --git a/ghost/ghost/src/core/activitypub/jsonld.service.ts b/ghost/ghost/src/core/activitypub/jsonld.service.ts index a13e8e4e10..7380cd8eee 100644 --- a/ghost/ghost/src/core/activitypub/jsonld.service.ts +++ b/ghost/ghost/src/core/activitypub/jsonld.service.ts @@ -1,10 +1,13 @@ import {Inject} from '@nestjs/common'; import {ActorRepository} from './actor.repository'; import ObjectID from 'bson-objectid'; +import {PostRepository} from './post.repository'; +import {Article} from './article.object'; export class JSONLDService { constructor( @Inject('ActorRepository') private repository: ActorRepository, + @Inject('PostRepository') private postRepository: PostRepository, @Inject('ActivityPubBaseURL') private url: URL ) {} @@ -28,4 +31,15 @@ export class JSONLDService { orderedItems: actor.outbox.map(activity => activity.getJSONLD(this.url)) }; } + + async getArticle(id: ObjectID) { + const post = await this.postRepository.getOne(id); + if (!post) { + throw new Error('Not found'); + } + if (post.visibility !== 'public') { + throw new Error('Cannot view'); + } + return Article.fromPost(post).getJSONLD(this.url); + } } diff --git a/ghost/ghost/src/core/activitypub/post.repository.ts b/ghost/ghost/src/core/activitypub/post.repository.ts new file mode 100644 index 0000000000..da66e99369 --- /dev/null +++ b/ghost/ghost/src/core/activitypub/post.repository.ts @@ -0,0 +1,13 @@ +import ObjectID from 'bson-objectid'; + +export type Post = { + id: ObjectID; + title: string; + slug: string; + html: string; + visibility: string; +}; + +export interface PostRepository { + getOne(id: ObjectID): Promise +} diff --git a/ghost/ghost/src/db/in-memory/actor.repository.in-memory.ts b/ghost/ghost/src/db/in-memory/actor.repository.in-memory.ts index add740e6d9..55daf9d948 100644 --- a/ghost/ghost/src/db/in-memory/actor.repository.in-memory.ts +++ b/ghost/ghost/src/db/in-memory/actor.repository.in-memory.ts @@ -3,7 +3,6 @@ import {ActorRepository} from '../../core/activitypub/actor.repository'; import ObjectID from 'bson-objectid'; import {Inject} from '@nestjs/common'; import {SettingsCache} from '../../common/types/settings-cache.type'; -import {Activity} from '../../core/activitypub/activity.object'; interface DomainEvents { dispatch(event: unknown): void diff --git a/ghost/ghost/src/db/knex/post.repository.knex.ts b/ghost/ghost/src/db/knex/post.repository.knex.ts new file mode 100644 index 0000000000..c010247e6d --- /dev/null +++ b/ghost/ghost/src/db/knex/post.repository.knex.ts @@ -0,0 +1,32 @@ +import {Inject} from '@nestjs/common'; +import ObjectID from 'bson-objectid'; +import {PostRepository} from '../../core/activitypub/post.repository'; + +type UrlUtils = { + transformReadyToAbsolute(html: string): string +} + +export class KnexPostRepository implements PostRepository { + constructor( + // eslint-disable-next-line @typescript-eslint/no-explicit-any + @Inject('knex') private readonly knex: any, + @Inject('UrlUtils') private readonly urlUtils: UrlUtils + ) {} + async getOne(identifier: ObjectID) { + return this.getOneById(identifier); + } + + async getOneById(id: ObjectID) { + const row = await this.knex('posts').where('id', id.toHexString()).first(); + if (!row) { + return null; + } + return { + id, + title: row.title, + html: this.urlUtils.transformReadyToAbsolute(row.html), + slug: row.slug, + visibility: row.visibility + }; + } +}; diff --git a/ghost/ghost/src/http/frontend/controllers/activitypub.controller.ts b/ghost/ghost/src/http/frontend/controllers/activitypub.controller.ts index 77ecf28011..f89e3661f2 100644 --- a/ghost/ghost/src/http/frontend/controllers/activitypub.controller.ts +++ b/ghost/ghost/src/http/frontend/controllers/activitypub.controller.ts @@ -30,4 +30,15 @@ export class ActivityPubController { } return this.service.getOutbox(ObjectID.createFromHexString(owner)); } + + @Header('Cache-Control', 'no-store') + @Header('Content-Type', 'application/activity+json') + @Roles(['Anon']) + @Get('article/:id') + async getArticle(@Param('id') id: unknown) { + if (typeof id !== 'string') { + throw new Error('Bad Request'); + } + return this.service.getArticle(ObjectID.createFromHexString(id)); + } } diff --git a/ghost/ghost/src/nestjs/modules/activitypub.module.ts b/ghost/ghost/src/nestjs/modules/activitypub.module.ts index 1bbfc7b391..c81a6ee282 100644 --- a/ghost/ghost/src/nestjs/modules/activitypub.module.ts +++ b/ghost/ghost/src/nestjs/modules/activitypub.module.ts @@ -4,6 +4,8 @@ import {ActivityPubController} from '../../http/frontend/controllers/activitypub import {WebFingerService} from '../../core/activitypub/webfinger.service'; import {JSONLDService} from '../../core/activitypub/jsonld.service'; import {WebFingerController} from '../../http/frontend/controllers/webfinger.controller'; +import {ActivityService} from '../../core/activitypub/activity.service'; +import {KnexPostRepository} from '../../db/knex/post.repository.knex'; @Module({ controllers: [ActivityPubController, WebFingerController], @@ -13,6 +15,14 @@ import {WebFingerController} from '../../http/frontend/controllers/webfinger.con provide: 'ActorRepository', useClass: ActorRepositoryInMemory }, + { + provide: 'ActivityService', + useClass: ActivityService + }, + { + provide: 'PostRepository', + useClass: KnexPostRepository + }, WebFingerService, JSONLDService ] diff --git a/ghost/posts-service/lib/PostsService.js b/ghost/posts-service/lib/PostsService.js index 67f22d328b..3bc97b19d1 100644 --- a/ghost/posts-service/lib/PostsService.js +++ b/ghost/posts-service/lib/PostsService.js @@ -12,6 +12,8 @@ const { PostsBulkUnfeaturedEvent, PostsBulkAddTagsEvent } = require('@tryghost/post-events'); +const GhostNestApp = require('@tryghost/ghost'); +const {default: ObjectID} = require('bson-objectid'); const messages = { invalidVisibilityFilter: 'Invalid visibility filter.', @@ -207,6 +209,13 @@ class PostsService { } } + if (this.isSet('ActivityPub')) { + if (model.previous('status') !== model.get('status') && model.get('status') === 'published') { + const activityService = await GhostNestApp.resolve('ActivityService'); + await activityService.createArticleForPost(ObjectID.createFromHexString(model.id)); + } + } + if (typeof options?.eventHandler === 'function') { await options.eventHandler(this.getChanges(model), dto); }