egirlskey/packages/backend/src/server/ActivityPubServerService.ts

645 lines
19 KiB
TypeScript
Raw Normal View History

2023-02-09 01:46:01 +00:00
import { IncomingMessage } from 'node:http';
2022-09-17 18:27:08 +00:00
import { Inject, Injectable } from '@nestjs/common';
import fastifyAccepts from '@fastify/accepts';
2022-09-17 18:27:08 +00:00
import httpSignature from '@peertube/http-signature';
import { Brackets, In, IsNull, LessThan, Not } from 'typeorm';
import accepts from 'accepts';
import vary from 'vary';
2022-09-17 18:27:08 +00:00
import { DI } from '@/di-symbols.js';
2022-09-22 21:21:31 +00:00
import type { FollowingsRepository, NotesRepository, EmojisRepository, NoteReactionsRepository, UserProfilesRepository, UserNotePiningsRepository, UsersRepository } from '@/models/index.js';
2022-09-17 18:27:08 +00:00
import * as url from '@/misc/prelude/url.js';
2022-09-20 20:33:11 +00:00
import type { Config } from '@/config.js';
2022-12-04 01:16:03 +00:00
import { ApRendererService } from '@/core/activitypub/ApRendererService.js';
2022-09-17 18:27:08 +00:00
import { QueueService } from '@/core/QueueService.js';
2023-02-13 06:50:22 +00:00
import type { LocalUser, User } from '@/models/entities/User.js';
2022-09-17 18:27:08 +00:00
import { UserKeypairStoreService } from '@/core/UserKeypairStoreService.js';
import type { Following } from '@/models/entities/Following.js';
import { countIf } from '@/misc/prelude/array.js';
import type { Note } from '@/models/entities/Note.js';
import { QueryService } from '@/core/QueryService.js';
import { UtilityService } from '@/core/UtilityService.js';
import { UserEntityService } from '@/core/entities/UserEntityService.js';
import { bindThis } from '@/decorators.js';
2023-02-09 01:46:01 +00:00
import { IActivity } from '@/core/activitypub/type.js';
import type { FastifyInstance, FastifyRequest, FastifyReply, FastifyPluginOptions } from 'fastify';
2022-09-17 18:27:08 +00:00
import type { FindOptionsWhere } from 'typeorm';
const ACTIVITY_JSON = 'application/activity+json; charset=utf-8';
const LD_JSON = 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"; charset=utf-8';
@Injectable()
export class ActivityPubServerService {
constructor(
@Inject(DI.config)
private config: Config,
@Inject(DI.usersRepository)
private usersRepository: UsersRepository,
@Inject(DI.userProfilesRepository)
private userProfilesRepository: UserProfilesRepository,
@Inject(DI.notesRepository)
private notesRepository: NotesRepository,
@Inject(DI.noteReactionsRepository)
private noteReactionsRepository: NoteReactionsRepository,
@Inject(DI.emojisRepository)
private emojisRepository: EmojisRepository,
@Inject(DI.userNotePiningsRepository)
private userNotePiningsRepository: UserNotePiningsRepository,
@Inject(DI.followingsRepository)
private followingsRepository: FollowingsRepository,
private utilityService: UtilityService,
private userEntityService: UserEntityService,
private apRendererService: ApRendererService,
private queueService: QueueService,
private userKeypairStoreService: UserKeypairStoreService,
private queryService: QueryService,
) {
//this.createServer = this.createServer.bind(this);
2022-09-17 18:27:08 +00:00
}
@bindThis
private setResponseType(request: FastifyRequest, reply: FastifyReply): void {
const accept = request.accepts().type([ACTIVITY_JSON, LD_JSON]);
2022-09-17 18:27:08 +00:00
if (accept === LD_JSON) {
reply.type(LD_JSON);
2022-09-17 18:27:08 +00:00
} else {
reply.type(ACTIVITY_JSON);
2022-09-17 18:27:08 +00:00
}
}
/**
* Pack Create<Note> or Announce Activity
* @param note Note
*/
@bindThis
2022-09-18 18:11:50 +00:00
private async packActivity(note: Note): Promise<any> {
2022-09-17 18:27:08 +00:00
if (note.renoteId && note.text == null && !note.hasPoll && (note.fileIds == null || note.fileIds.length === 0)) {
2022-09-22 21:21:31 +00:00
const renote = await this.notesRepository.findOneByOrFail({ id: note.renoteId });
2022-09-17 18:27:08 +00:00
return this.apRendererService.renderAnnounce(renote.uri ? renote.uri : `${this.config.url}/notes/${renote.id}`, note);
}
return this.apRendererService.renderCreate(await this.apRendererService.renderNote(note, false), note);
}
@bindThis
private inbox(request: FastifyRequest, reply: FastifyReply) {
2022-12-25 05:53:50 +00:00
let signature;
2022-09-17 18:27:08 +00:00
try {
signature = httpSignature.parseRequest(request.raw, { 'headers': [] });
2022-09-17 18:27:08 +00:00
} catch (e) {
reply.code(401);
2022-09-17 18:27:08 +00:00
return;
}
2023-02-09 01:46:01 +00:00
// TODO: request.bodyのバリデーション
this.queueService.inbox(request.body as IActivity, signature);
2022-09-17 18:27:08 +00:00
reply.code(202);
2022-09-17 18:27:08 +00:00
}
@bindThis
private async followers(
request: FastifyRequest<{ Params: { user: string; }; Querystring: { cursor?: string; page?: string; }; }>,
reply: FastifyReply,
) {
const userId = request.params.user;
2022-09-17 18:27:08 +00:00
const cursor = request.query.cursor;
2022-09-17 18:27:08 +00:00
if (cursor != null && typeof cursor !== 'string') {
reply.code(400);
2022-09-17 18:27:08 +00:00
return;
}
const page = request.query.page === 'true';
2022-09-17 18:27:08 +00:00
const user = await this.usersRepository.findOneBy({
id: userId,
host: IsNull(),
});
if (user == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
//#region Check ff visibility
const profile = await this.userProfilesRepository.findOneByOrFail({ userId: user.id });
if (profile.ffVisibility === 'private') {
reply.code(403);
reply.header('Cache-Control', 'public, max-age=30');
2022-09-17 18:27:08 +00:00
return;
} else if (profile.ffVisibility === 'followers') {
reply.code(403);
reply.header('Cache-Control', 'public, max-age=30');
2022-09-17 18:27:08 +00:00
return;
}
//#endregion
const limit = 10;
const partOf = `${this.config.url}/users/${userId}/followers`;
if (page) {
const query = {
followeeId: user.id,
} as FindOptionsWhere<Following>;
// カーソルが指定されている場合
if (cursor) {
query.id = LessThan(cursor);
}
// Get followers
const followings = await this.followingsRepository.find({
where: query,
take: limit + 1,
order: { id: -1 },
});
// 「次のページ」があるかどうか
const inStock = followings.length === limit + 1;
if (inStock) followings.pop();
const renderedFollowers = await Promise.all(followings.map(following => this.apRendererService.renderFollowUser(following.followerId)));
const rendered = this.apRendererService.renderOrderedCollectionPage(
`${partOf}?${url.query({
page: 'true',
cursor,
})}`,
user.followersCount, renderedFollowers, partOf,
undefined,
inStock ? `${partOf}?${url.query({
page: 'true',
cursor: followings[followings.length - 1].id,
})}` : undefined,
);
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(rendered));
2022-09-17 18:27:08 +00:00
} else {
// index page
const rendered = this.apRendererService.renderOrderedCollection(partOf, user.followersCount, `${partOf}?page=true`);
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(rendered));
2022-09-17 18:27:08 +00:00
}
}
@bindThis
private async following(
request: FastifyRequest<{ Params: { user: string; }; Querystring: { cursor?: string; page?: string; }; }>,
reply: FastifyReply,
) {
const userId = request.params.user;
2022-09-17 18:27:08 +00:00
const cursor = request.query.cursor;
2022-09-17 18:27:08 +00:00
if (cursor != null && typeof cursor !== 'string') {
reply.code(400);
2022-09-17 18:27:08 +00:00
return;
}
const page = request.query.page === 'true';
2022-09-17 18:27:08 +00:00
const user = await this.usersRepository.findOneBy({
id: userId,
host: IsNull(),
});
if (user == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
//#region Check ff visibility
const profile = await this.userProfilesRepository.findOneByOrFail({ userId: user.id });
if (profile.ffVisibility === 'private') {
reply.code(403);
reply.header('Cache-Control', 'public, max-age=30');
2022-09-17 18:27:08 +00:00
return;
} else if (profile.ffVisibility === 'followers') {
reply.code(403);
reply.header('Cache-Control', 'public, max-age=30');
2022-09-17 18:27:08 +00:00
return;
}
//#endregion
const limit = 10;
const partOf = `${this.config.url}/users/${userId}/following`;
if (page) {
const query = {
followerId: user.id,
} as FindOptionsWhere<Following>;
// カーソルが指定されている場合
if (cursor) {
query.id = LessThan(cursor);
}
// Get followings
const followings = await this.followingsRepository.find({
where: query,
take: limit + 1,
order: { id: -1 },
});
// 「次のページ」があるかどうか
const inStock = followings.length === limit + 1;
if (inStock) followings.pop();
const renderedFollowees = await Promise.all(followings.map(following => this.apRendererService.renderFollowUser(following.followeeId)));
const rendered = this.apRendererService.renderOrderedCollectionPage(
`${partOf}?${url.query({
page: 'true',
cursor,
})}`,
user.followingCount, renderedFollowees, partOf,
undefined,
inStock ? `${partOf}?${url.query({
page: 'true',
cursor: followings[followings.length - 1].id,
})}` : undefined,
);
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(rendered));
2022-09-17 18:27:08 +00:00
} else {
// index page
const rendered = this.apRendererService.renderOrderedCollection(partOf, user.followingCount, `${partOf}?page=true`);
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(rendered));
2022-09-17 18:27:08 +00:00
}
}
@bindThis
private async featured(request: FastifyRequest<{ Params: { user: string; }; }>, reply: FastifyReply) {
const userId = request.params.user;
2022-09-17 18:27:08 +00:00
const user = await this.usersRepository.findOneBy({
id: userId,
host: IsNull(),
});
if (user == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
const pinings = await this.userNotePiningsRepository.find({
where: { userId: user.id },
order: { id: 'DESC' },
});
const pinnedNotes = await Promise.all(pinings.map(pining =>
this.notesRepository.findOneByOrFail({ id: pining.noteId })));
const renderedNotes = await Promise.all(pinnedNotes.map(note => this.apRendererService.renderNote(note)));
const rendered = this.apRendererService.renderOrderedCollection(
`${this.config.url}/users/${userId}/collections/featured`,
renderedNotes.length, undefined, undefined, renderedNotes,
);
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(rendered));
2022-09-17 18:27:08 +00:00
}
@bindThis
private async outbox(
request: FastifyRequest<{
Params: { user: string; };
Querystring: { since_id?: string; until_id?: string; page?: string; };
}>,
reply: FastifyReply,
) {
const userId = request.params.user;
2022-09-17 18:27:08 +00:00
const sinceId = request.query.since_id;
2022-09-17 18:27:08 +00:00
if (sinceId != null && typeof sinceId !== 'string') {
reply.code(400);
2022-09-17 18:27:08 +00:00
return;
}
const untilId = request.query.until_id;
2022-09-17 18:27:08 +00:00
if (untilId != null && typeof untilId !== 'string') {
reply.code(400);
2022-09-17 18:27:08 +00:00
return;
}
const page = request.query.page === 'true';
2022-09-17 18:27:08 +00:00
if (countIf(x => x != null, [sinceId, untilId]) > 1) {
reply.code(400);
2022-09-17 18:27:08 +00:00
return;
}
const user = await this.usersRepository.findOneBy({
id: userId,
host: IsNull(),
});
if (user == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
const limit = 20;
const partOf = `${this.config.url}/users/${userId}/outbox`;
if (page) {
const query = this.queryService.makePaginationQuery(this.notesRepository.createQueryBuilder('note'), sinceId, untilId)
.andWhere('note.userId = :userId', { userId: user.id })
.andWhere(new Brackets(qb => { qb
.where('note.visibility = \'public\'')
.orWhere('note.visibility = \'home\'');
}))
.andWhere('note.localOnly = FALSE');
const notes = await query.take(limit).getMany();
if (sinceId) notes.reverse();
2022-09-18 18:11:50 +00:00
const activities = await Promise.all(notes.map(note => this.packActivity(note)));
2022-09-17 18:27:08 +00:00
const rendered = this.apRendererService.renderOrderedCollectionPage(
`${partOf}?${url.query({
page: 'true',
since_id: sinceId,
until_id: untilId,
})}`,
user.notesCount, activities, partOf,
notes.length ? `${partOf}?${url.query({
page: 'true',
since_id: notes[0].id,
})}` : undefined,
notes.length ? `${partOf}?${url.query({
page: 'true',
until_id: notes[notes.length - 1].id,
})}` : undefined,
);
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(rendered));
2022-09-17 18:27:08 +00:00
} else {
// index page
const rendered = this.apRendererService.renderOrderedCollection(partOf, user.notesCount,
`${partOf}?page=true`,
`${partOf}?page=true&since_id=000000000000000000000000`,
);
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(rendered));
2022-09-17 18:27:08 +00:00
}
}
@bindThis
private async userInfo(request: FastifyRequest, reply: FastifyReply, user: User | null) {
2022-09-17 18:27:08 +00:00
if (user == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-13 06:50:22 +00:00
return (this.apRendererService.addContext(await this.apRendererService.renderPerson(user as LocalUser)));
2022-09-17 18:27:08 +00:00
}
@bindThis
public createServer(fastify: FastifyInstance, options: FastifyPluginOptions, done: (err?: Error) => void) {
2023-02-09 01:46:01 +00:00
// addConstraintStrategy の型定義がおかしいため
(fastify.addConstraintStrategy as any)({
name: 'apOrHtml',
storage() {
2023-02-09 01:46:01 +00:00
const store = {} as any;
return {
2023-02-09 01:46:01 +00:00
get(key: string) {
return store[key] ?? null;
},
2023-02-09 01:46:01 +00:00
set(key: string, value: any) {
store[key] = value;
},
};
},
2023-02-09 01:46:01 +00:00
deriveConstraint(request: IncomingMessage) {
const accepted = accepts(request).type(['html', ACTIVITY_JSON, LD_JSON]);
const isAp = typeof accepted === 'string' && !accepted.match(/html/);
return isAp ? 'ap' : 'html';
},
});
2022-09-17 18:27:08 +00:00
fastify.register(fastifyAccepts);
fastify.addContentTypeParser('application/activity+json', { parseAs: 'string' }, fastify.getDefaultJsonParser('ignore', 'ignore'));
fastify.addContentTypeParser('application/ld+json', { parseAs: 'string' }, fastify.getDefaultJsonParser('ignore', 'ignore'));
2022-09-17 18:27:08 +00:00
fastify.addHook('onRequest', (request, reply, done) => {
reply.header('Access-Control-Allow-Headers', 'Accept');
reply.header('Access-Control-Allow-Methods', 'GET, OPTIONS');
reply.header('Access-Control-Allow-Origin', '*');
reply.header('Access-Control-Expose-Headers', 'Vary');
done();
});
//#region Routing
2022-12-25 05:56:59 +00:00
// inbox (limit: 64kb)
fastify.post('/inbox', { bodyLimit: 1024 * 64 }, async (request, reply) => await this.inbox(request, reply));
fastify.post('/users/:user/inbox', { bodyLimit: 1024 * 64 }, async (request, reply) => await this.inbox(request, reply));
2022-09-17 18:27:08 +00:00
// note
fastify.get<{ Params: { note: string; } }>('/notes/:note', { constraints: { apOrHtml: 'ap' } }, async (request, reply) => {
vary(reply.raw, 'Accept');
2022-09-17 18:27:08 +00:00
const note = await this.notesRepository.findOneBy({
id: request.params.note,
visibility: In(['public', 'home']),
2022-09-17 18:27:08 +00:00
localOnly: false,
});
if (note == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
// リモートだったらリダイレクト
if (note.userHost != null) {
if (note.uri == null || this.utilityService.isSelfHost(note.userHost)) {
reply.code(500);
2022-09-17 18:27:08 +00:00
return;
}
reply.redirect(note.uri);
2022-09-17 18:27:08 +00:00
return;
}
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return this.apRendererService.addContext(await this.apRendererService.renderNote(note, false));
2022-09-17 18:27:08 +00:00
});
// note activity
fastify.get<{ Params: { note: string; } }>('/notes/:note/activity', async (request, reply) => {
vary(reply.raw, 'Accept');
2022-09-17 18:27:08 +00:00
const note = await this.notesRepository.findOneBy({
id: request.params.note,
2022-09-17 18:27:08 +00:00
userHost: IsNull(),
visibility: In(['public', 'home']),
2022-09-17 18:27:08 +00:00
localOnly: false,
});
if (note == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(await this.packActivity(note)));
2022-09-17 18:27:08 +00:00
});
// outbox
fastify.get<{
Params: { user: string; };
Querystring: { since_id?: string; until_id?: string; page?: string; };
}>('/users/:user/outbox', async (request, reply) => await this.outbox(request, reply));
2022-09-17 18:27:08 +00:00
// followers
fastify.get<{
Params: { user: string; };
Querystring: { cursor?: string; page?: string; };
}>('/users/:user/followers', async (request, reply) => await this.followers(request, reply));
2022-09-17 18:27:08 +00:00
// following
fastify.get<{
Params: { user: string; };
Querystring: { cursor?: string; page?: string; };
}>('/users/:user/following', async (request, reply) => await this.following(request, reply));
2022-09-17 18:27:08 +00:00
// featured
fastify.get<{ Params: { user: string; }; }>('/users/:user/collections/featured', async (request, reply) => await this.featured(request, reply));
2022-09-17 18:27:08 +00:00
// publickey
fastify.get<{ Params: { user: string; } }>('/users/:user/publickey', async (request, reply) => {
const userId = request.params.user;
2022-09-17 18:27:08 +00:00
const user = await this.usersRepository.findOneBy({
id: userId,
host: IsNull(),
});
if (user == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
const keypair = await this.userKeypairStoreService.getUserKeypair(user.id);
if (this.userEntityService.isLocalUser(user)) {
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(this.apRendererService.renderKey(user, keypair)));
2022-09-17 18:27:08 +00:00
} else {
reply.code(400);
2023-02-09 02:02:37 +00:00
return;
2022-09-17 18:27:08 +00:00
}
});
fastify.get<{ Params: { user: string; } }>('/users/:user', { constraints: { apOrHtml: 'ap' } }, async (request, reply) => {
const userId = request.params.user;
2022-09-17 18:27:08 +00:00
const user = await this.usersRepository.findOneBy({
id: userId,
host: IsNull(),
isSuspended: false,
});
return await this.userInfo(request, reply, user);
2022-09-17 18:27:08 +00:00
});
fastify.get<{ Params: { user: string; } }>('/@:user', { constraints: { apOrHtml: 'ap' } }, async (request, reply) => {
2022-09-17 18:27:08 +00:00
const user = await this.usersRepository.findOneBy({
usernameLower: request.params.user.toLowerCase(),
2022-09-17 18:27:08 +00:00
host: IsNull(),
isSuspended: false,
});
return await this.userInfo(request, reply, user);
2022-09-17 18:27:08 +00:00
});
//#endregion
// emoji
fastify.get<{ Params: { emoji: string; } }>('/emojis/:emoji', async (request, reply) => {
2022-09-17 18:27:08 +00:00
const emoji = await this.emojisRepository.findOneBy({
host: IsNull(),
name: request.params.emoji,
2022-09-17 18:27:08 +00:00
});
if (emoji == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(await this.apRendererService.renderEmoji(emoji)));
2022-09-17 18:27:08 +00:00
});
// like
fastify.get<{ Params: { like: string; } }>('/likes/:like', async (request, reply) => {
const reaction = await this.noteReactionsRepository.findOneBy({ id: request.params.like });
2022-09-17 18:27:08 +00:00
if (reaction == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
const note = await this.notesRepository.findOneBy({ id: reaction.noteId });
if (note == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(await this.apRendererService.renderLike(reaction, note)));
2022-09-17 18:27:08 +00:00
});
// follow
fastify.get<{ Params: { follower: string; followee: string; } }>('/follows/:follower/:followee', async (request, reply) => {
2022-09-17 18:27:08 +00:00
// This may be used before the follow is completed, so we do not
// check if the following exists.
const [follower, followee] = await Promise.all([
this.usersRepository.findOneBy({
id: request.params.follower,
2022-09-17 18:27:08 +00:00
host: IsNull(),
}),
this.usersRepository.findOneBy({
id: request.params.followee,
2022-09-17 18:27:08 +00:00
host: Not(IsNull()),
}),
]);
if (follower == null || followee == null) {
reply.code(404);
2022-09-17 18:27:08 +00:00
return;
}
reply.header('Cache-Control', 'public, max-age=180');
this.setResponseType(request, reply);
2023-02-12 09:47:30 +00:00
return (this.apRendererService.addContext(this.apRendererService.renderFollow(follower, followee)));
2022-09-17 18:27:08 +00:00
});
done();
2022-09-17 18:27:08 +00:00
}
}