FoundKey/packages/backend/src/remote/activitypub/models/note.ts

import promiseLimit from 'promise-limit';

import config from '@/config/index.js';
import post from '@/services/note/create.js';
import { IRemoteUser } from '@/models/entities/user.js';
import { unique, toArray, toSingle } from '@/prelude/array.js';
import { vote } from '@/services/note/polls/vote.js';
import { DriveFile } from '@/models/entities/drive-file.js';
import { deliverQuestionUpdate } from '@/services/note/polls/update.js';
import { extractDbHost } from '@/misc/convert-host.js';
import { Polls, MessagingMessages } from '@/models/index.js';
import { Note } from '@/models/entities/note.js';
import { Emoji } from '@/models/entities/emoji.js';
import { genId } from '@/misc/gen-id.js';
import { getApLock } from '@/misc/app-lock.js';
import { createMessage } from '@/services/messages/create.js';
import { StatusError } from '@/misc/fetch.js';
import { fromHtml } from '@/mfm/from-html.js';
import { shouldBlockInstance } from '@/misc/should-block-instance.js';
import { Resolver } from '@/remote/activitypub/resolver.js';
import { parseAudience } from '../audience.js';
import { IObject, getOneApId, getApId, getOneApHrefNullable, isPost, IPost, getApType } from '../type.js';
import { DbResolver } from '../db-resolver.js';
import { apLogger } from '../logger.js';
import { resolvePerson } from './person.js';
import { resolveImage } from './image.js';
import { extractApHashtags, extractQuoteUrl, extractEmojis } from './tag.js';
import { extractPollFromQuestion } from './question.js';
import { extractApMentions } from './mention.js';

export function validateNote(object: IObject): Error | null {
	if (object == null) {
		return new Error('invalid Note: object is null');
	}

	if (!isPost(object)) {
		return new Error(`invalid Note: invalid object type ${getApType(object)}`);
	}

	const id = getApId(object);
	if (id == null) {
		// Only transient objects or anonymous objects may not have an id or an id that is explicitly null.
		// We consider all Notes as not transient and not anonymous so require ids for them.
		return new Error(`invalid Note: id required but not present`);
	}

	// Check that the server is authorized to act on behalf of this author.
	const expectHost = extractDbHost(id);
	const attributedToHost = object.attributedTo
		? extractDbHost(getOneApId(object.attributedTo))
		: null;
	if (attributedToHost !== expectHost) {
		return new Error(`invalid Note: attributedTo has different host. expected: ${expectHost}, actual: ${attributedToHost}`);
	}
	if (attributedToHost === config.hostname) {
		return new Error('invalid Note: by local author');
	}

	return null;
}

/**
 * Function to process the content of a note, reusable in createNote and updateNote.
 */
async function processContent(note: IPost, quoteUri: string | null):
	Promise<{
		cw: string | null,
		files: DriveFile[],
		text: string | null,
		apEmoji: Emoji[],
		apHashtags: string[],
		url: string,
		name: string
	}>
{
	// Attachments handling
	// TODO: attachments are not necessarily images
	const limit = promiseLimit(2);

	const attachments = toArray(note.attachment);
	const files = note.attachment
		// If the note is marked as sensitive, the images should be marked sensitive too.
		.map(attach => attach.sensitive |= note.sensitive)
		? (await Promise.all(note.attachment.map(x => limit(() => resolveImage(actor, x, resolver)) as Promise<DriveFile>)))
			.filter(image => image != null)
		: [];

	// text parsing
	let text: string | null = null;
	if (note.source?.mediaType === 'text/x.misskeymarkdown' && typeof note.source.content === 'string') {
		text = note.source.content;
	} else if (typeof note.content === 'string') {
		text = fromHtml(note.content, quoteUri);
	}

	const emojis = await extractEmojis(note.tag || [], extractDbHost(getApId(note))).catch(e => {
		apLogger.info(`extractEmojis: ${e}`);
		return [] as Emoji[];
	});

	return {
		cw: note.summary === '' ? null : note.summary,
		files,
		text,
		apEmojis: emojis.map(emoji => emoji.name),
		apHashtags: await extractApHashtags(note.tag),
		url: getOneApHrefNullable(note.url),
		name: note.name,
	};
}

/**
 * Fetch Note.
 *
 * Returns the target Note if it is registered in FoundKey.
 */
export async function fetchNote(object: string | IObject): Promise<Note | null> {
	const dbResolver = new DbResolver();
	return await dbResolver.getNoteFromApId(object);
}

/**
 * Noteを作成します。
 */
export async function createNote(value: string | IObject, resolver: Resolver, silent = false): Promise<Note | null> {
	const object: IObject = await resolver.resolve(value);

	const err = validateNote(object);
	if (err) {
		apLogger.error(`${err.message}`);
		throw new Error('invalid note');
	}

	const note: IPost = object;

	apLogger.debug(`Note fetched: ${JSON.stringify(note, null, 2)}`);

	apLogger.info(`Creating the Note: ${note.id}`);

	// 投稿者をフェッチ
	const actor = await resolvePerson(getOneApId(note.attributedTo), resolver) as IRemoteUser;

	// 投稿者が凍結されていたらスキップ
	if (actor.isSuspended) {
		throw new Error('actor has been suspended');
	}

	const noteAudience = await parseAudience(actor, note.to, note.cc);
	let visibility = noteAudience.visibility;
	const visibleUsers = noteAudience.visibleUsers;

	// If audience(to,cc) was not specified
	if (visibility === 'specified' && visibleUsers.length === 0) {
		// TODO derive audience from context (e.g. whose inbox this was in?)
		throw new Error('audience not understood');
	}

	let isTalk = note._misskey_talk && visibility === 'specified';

	const apMentions = await extractApMentions(note.tag, resolver);

	// Reply handling
	const reply: Note | null = note.inReplyTo
		? await resolveNote(note.inReplyTo, resolver).then(x => {
			if (x == null) {
				apLogger.warn('Specified inReplyTo, but nout found');
				throw new Error('inReplyTo not found');
			} else {
				return x;
			}
		}).catch(async e => {
			// ignore inReplyTo if it is a messaging message
			const uri = getApId(note.inReplyTo);
			if (uri.startsWith(config.url + '/')) {
				const id = uri.split('/').pop();
				const talk = await MessagingMessages.countBy({ id });
				if (talk) {
					isTalk = true;
					return null;
				}
			}

			apLogger.warn(`Error in inReplyTo ${note.inReplyTo} - ${e.statusCode || e}`);
			throw e;
		})
		: null;

	let quote: Note | undefined | null;
	const quoteUrl = extractQuoteUrl(note.tag);

	if (quoteUrl || note._misskey_quote || note.quoteUri) {
		const tryResolveNote = async (uri: string): Promise<{
			status: 'ok';
			res: Note | null;
		} | {
			status: 'permerror' | 'temperror';
		}> => {
			if (typeof uri !== 'string' || !uri.match(/^https?:/)) return { status: 'permerror' };
			try {
				const res = await resolveNote(uri, resolver);
				if (res) {
					return {
						status: 'ok',
						res,
					};
				} else {
					return {
						status: 'permerror',
					};
				}
			} catch (e) {
				return {
					status: (e instanceof StatusError && e.isClientError) ? 'permerror' : 'temperror',
				};
			}
		};

		const uris = unique([quoteUrl, note._misskey_quote, note.quoteUri].filter((x): x is string => typeof x === 'string'));
		let temperror = false;
		// check the urls sequentially and abort early to not do unnecessary HTTP requests
		// picks the first one that works
		for (const uri of uris) {
			const res = await tryResolveNote(uri);
			if (res.status === 'ok') {
				quote = res.res;
				break;
			} else if (res.status === 'temperror') {
				temperror = true;
			}
		}
		if (!quote && temperror) {
			// could not resolve quote, try again later
			throw new Error('quote resolve failed');
		}
	}

	// vote
	if (reply && reply.hasPoll) {
		const poll = await Polls.findOneByOrFail({ noteId: reply.id });

		const tryCreateVote = async (name: string, index: number): Promise<null> => {
			if (poll.expiresAt && Date.now() > new Date(poll.expiresAt).getTime()) {
				apLogger.warn(`vote to expired poll from AP: actor=${actor.username}@${actor.host}, note=${note.id}, choice=${name}`);
			} else if (index >= 0) {
				apLogger.info(`vote from AP: actor=${actor.username}@${actor.host}, note=${note.id}, choice=${name}`);
				await vote(actor, reply, index);

				// Federate an Update to other servers
				deliverQuestionUpdate(reply.id);
			}
			return null;
		};

		if (note.name) {
			return await tryCreateVote(note.name, poll.choices.findIndex(x => x === note.name));
		}
	}

	const poll = await extractPollFromQuestion(note, resolver).catch(() => undefined);

	const processedContent = await processContent(note, quote?.uri);

	if (isTalk) {
		for (const recipient of visibleUsers) {
			await createMessage(
				actor,
				recipient,
				undefined,
				processedContent.text,
				processedContent.files[0] ?? null,
				object.id
			);
		}
		return null;
	} else {
		return await post(actor, {
			...processedContent,
			createdAt: note.published ? new Date(note.published) : null,
			reply,
			renote: quote,
			localOnly: false,
			visibility,
			visibleUsers,
			apMentions,
			poll,
			uri: note.id,
		}, silent);
	}
}

/**
 * Resolve Note.
 *
 * If the target Note is registered in FoundKey, return it; otherwise, fetch it from a remote server and return it.
 * Fetch the Note from the remote server, register it in FoundKey, and return it.
 */
export async function resolveNote(value: string | IObject, resolver: Resolver): Promise<Note | null> {
	const uri = typeof value === 'string' ? value : value.id;
	if (uri == null) throw new Error('missing uri');

	// Interrupt if blocked.
	if (await shouldBlockInstance(extractDbHost(uri))) throw new StatusError('host blocked', 451, `host ${extractDbHost(uri)} is blocked`);

	const unlock = await getApLock(uri);

	try {
		//#region If already registered on this server, return it.
		const exist = await fetchNote(uri);

		if (exist) {
			return exist;
		}
		//#endregion

		if (uri.startsWith(config.url)) {
			throw new StatusError('cannot resolve local note', 400, 'cannot resolve local note');
		}

		// リモートサーバーからフェッチしてきて登録
		// ここでuriの代わりに添付されてきたNote Objectが指定されていると、サーバーフェッチを経ずにノートが生成されるが
		// 添付されてきたNote Objectは偽装されている可能性があるため、常にuriを指定してサーバーフェッチを行う。
		return await createNote(uri, resolver, true);
	} finally {
		unlock();
	}
}