feat: アンテナのエクスポート・インポート (#10754)

* feat: アンテナのエクスポートに対応 (misskey-dev/misskey#10690)

* feat: アンテナのインポートに対応 (misskey-dev/misskey#10690)

* fix: タイポを修正

* feat: ユーザーリストをサポート

* fix: バグを直した

* fix: バグを直した

* fix: 適当に決めた変数名を変更

* fix

* fix: 変数の変更、リファクタリング

packages/backend/src/queue/DbQueueProcessorsService.ts

@@ -9,11 +9,13 @@ import { ExportFollowingProcessorService } from './processors/ExportFollowingPro
 import { ExportMutingProcessorService } from './processors/ExportMutingProcessorService.js';
 import { ExportBlockingProcessorService } from './processors/ExportBlockingProcessorService.js';
 import { ExportUserListsProcessorService } from './processors/ExportUserListsProcessorService.js';
+import { ExportAntennasProcessorService } from './processors/ExportAntennasProcessorService.js';
 import { ImportFollowingProcessorService } from './processors/ImportFollowingProcessorService.js';
 import { ImportMutingProcessorService } from './processors/ImportMutingProcessorService.js';
 import { ImportBlockingProcessorService } from './processors/ImportBlockingProcessorService.js';
 import { ImportUserListsProcessorService } from './processors/ImportUserListsProcessorService.js';
 import { ImportCustomEmojisProcessorService } from './processors/ImportCustomEmojisProcessorService.js';
+import { ImportAntennasProcessorService } from './processors/ImportAntennasProcessorService.js';
 import { DeleteAccountProcessorService } from './processors/DeleteAccountProcessorService.js';
 import { ExportFavoritesProcessorService } from './processors/ExportFavoritesProcessorService.js';
 import type Bull from 'bull';
@@ -32,11 +34,13 @@ export class DbQueueProcessorsService {
 		private exportMutingProcessorService: ExportMutingProcessorService,
 		private exportBlockingProcessorService: ExportBlockingProcessorService,
 		private exportUserListsProcessorService: ExportUserListsProcessorService,
+		private exportAntennasProcessorService: ExportAntennasProcessorService,
 		private importFollowingProcessorService: ImportFollowingProcessorService,
 		private importMutingProcessorService: ImportMutingProcessorService,
 		private importBlockingProcessorService: ImportBlockingProcessorService,
 		private importUserListsProcessorService: ImportUserListsProcessorService,
 		private importCustomEmojisProcessorService: ImportCustomEmojisProcessorService,
+		private importAntennasProcessorService: ImportAntennasProcessorService,
 		private deleteAccountProcessorService: DeleteAccountProcessorService,
 	) {
 	}
@@ -51,6 +55,7 @@ export class DbQueueProcessorsService {
 		q.process('exportMuting', (job, done) => this.exportMutingProcessorService.process(job, done));
 		q.process('exportBlocking', (job, done) => this.exportBlockingProcessorService.process(job, done));
 		q.process('exportUserLists', (job, done) => this.exportUserListsProcessorService.process(job, done));
+		q.process('exportAntennas', (job, done) => this.exportAntennasProcessorService.process(job, done));
 		q.process('importFollowing', (job, done) => this.importFollowingProcessorService.process(job, done));
 		q.process('importFollowingToDb', (job) => this.importFollowingProcessorService.processDb(job));
 		q.process('importMuting', (job, done) => this.importMutingProcessorService.process(job, done));
@@ -58,6 +63,7 @@ export class DbQueueProcessorsService {
 		q.process('importBlockingToDb', (job) => this.importBlockingProcessorService.processDb(job));
 		q.process('importUserLists', (job, done) => this.importUserListsProcessorService.process(job, done));
 		q.process('importCustomEmojis', (job, done) => this.importCustomEmojisProcessorService.process(job, done));
+		q.process('importAntennas', (job, done) => this.importAntennasProcessorService.process(job, done));
 		q.process('deleteAccount', (job) => this.deleteAccountProcessorService.process(job));
 	}
 }

packages/backend/src/queue/QueueProcessorModule.ts

@@ -24,11 +24,13 @@ import { ExportFollowingProcessorService } from './processors/ExportFollowingPro
 import { ExportMutingProcessorService } from './processors/ExportMutingProcessorService.js';
 import { ExportNotesProcessorService } from './processors/ExportNotesProcessorService.js';
 import { ExportUserListsProcessorService } from './processors/ExportUserListsProcessorService.js';
+import { ExportAntennasProcessorService } from './processors/ExportAntennasProcessorService.js';
 import { ImportBlockingProcessorService } from './processors/ImportBlockingProcessorService.js';
 import { ImportCustomEmojisProcessorService } from './processors/ImportCustomEmojisProcessorService.js';
 import { ImportFollowingProcessorService } from './processors/ImportFollowingProcessorService.js';
 import { ImportMutingProcessorService } from './processors/ImportMutingProcessorService.js';
 import { ImportUserListsProcessorService } from './processors/ImportUserListsProcessorService.js';
+import { ImportAntennasProcessorService } from './processors/ImportAntennasProcessorService.js';
 import { ResyncChartsProcessorService } from './processors/ResyncChartsProcessorService.js';
 import { TickChartsProcessorService } from './processors/TickChartsProcessorService.js';
 import { AggregateRetentionProcessorService } from './processors/AggregateRetentionProcessorService.js';
@@ -55,11 +57,13 @@ import { RelationshipProcessorService } from './processors/RelationshipProcessor
 		ExportMutingProcessorService,
 		ExportBlockingProcessorService,
 		ExportUserListsProcessorService,
+		ExportAntennasProcessorService,
 		ImportFollowingProcessorService,
 		ImportMutingProcessorService,
 		ImportBlockingProcessorService,
 		ImportUserListsProcessorService,
 		ImportCustomEmojisProcessorService,
+		ImportAntennasProcessorService,
 		DeleteAccountProcessorService,
 		DeleteFileProcessorService,
 		CleanRemoteFilesProcessorService,

packages/backend/src/queue/processors/ExportAntennasProcessorService.ts

@@ -0,0 +1,99 @@
+import fs from 'node:fs';
+import { Inject, Injectable } from '@nestjs/common';
+import { format as DateFormat } from 'date-fns';
+import { In } from 'typeorm';
+import { DI } from '@/di-symbols.js';
+import type { AntennasRepository, UsersRepository, UserListJoiningsRepository, User } from '@/models/index.js';
+import type { Config } from '@/config.js';
+import Logger from '@/logger.js';
+import { DriveService } from '@/core/DriveService.js';
+import { bindThis } from '@/decorators.js';
+import { createTemp } from '@/misc/create-temp.js';
+import { QueueLoggerService } from '../QueueLoggerService.js';
+import type { DBExportAntennasData } from '../types.js';
+import type Bull from 'bull';
+import { UtilityService } from '@/core/UtilityService.js';
+
+@Injectable()
+export class ExportAntennasProcessorService {
+	private logger: Logger;
+
+	constructor (
+		@Inject(DI.config)
+		private config: Config,
+		@Inject(DI.usersRepository)
+		private usersRepository: UsersRepository,
+		@Inject(DI.antennasRepository)
+		private antennsRepository: AntennasRepository,
+		@Inject(DI.userListJoiningsRepository)
+		private userListJoiningsRepository: UserListJoiningsRepository,
+		private driveService: DriveService,
+		private utilityService: UtilityService,
+		private queueLoggerService: QueueLoggerService,
+	) {
+		this.logger = this.queueLoggerService.logger.createSubLogger('export-antennas');
+	}
+
+	@bindThis
+	public async process(job: Bull.Job<DBExportAntennasData>, done: () => void): Promise<void> {
+		const user = await this.usersRepository.findOneBy({ id: job.data.user.id });
+		if (user == null) {
+			done();
+			return;
+		}
+		const [path, cleanup] = await createTemp();
+		const stream = fs.createWriteStream(path, { flags: 'a' });
+		const write = (input: string): Promise<void> => {
+			return new Promise((resolve, reject) => {
+				stream.write(input, err => {
+					if (err) {
+						this.logger.error(err);
+						reject();
+					} else {
+						resolve();
+					}
+				});
+			});
+		};
+		try {
+			const antennas = await this.antennsRepository.findBy({ userId: job.data.user.id });
+			write('[');
+			for (const [index, antenna] of antennas.entries()) {
+				let users: User[] | undefined;
+				if (antenna.userListId !== null) {
+					const joinings = await this.userListJoiningsRepository.findBy({ userListId: antenna.userListId });
+					users = await this.usersRepository.findBy({
+						id: In(joinings.map(j => j.userId)),
+					});
+				}
+				write(JSON.stringify({
+					name: antenna.name,
+					src: antenna.src,
+					keywords: antenna.keywords,
+					excludeKeywords: antenna.excludeKeywords,
+					users: antenna.users,
+					userListAcct: typeof users !== 'undefined' ? users.map((u) => {
+						return this.utilityService.getFullApAccount(u.username, u.host); // acct
+					}) : null,
+					caseSensitive: antenna.caseSensitive,
+					withReplies: antenna.withReplies,
+					withFile: antenna.withFile,
+					notify: antenna.notify,
+				}));
+				if (antennas.length - 1 !== index) {
+					write(', ');
+				}
+			}
+			write(']');
+			stream.end();
+
+			const fileName = 'antennas-' + DateFormat(new Date(), 'yyyy-MM-dd-HH-mm-ss') + '.json';
+			const driveFile = await this.driveService.addFile({ user, path, name: fileName, force: true, ext: 'json' });
+			this.logger.succ('Exported to: ' + driveFile.id);
+		} finally {
+			cleanup();
+			done();
+		}
+	}
+}
+

packages/backend/src/queue/processors/ImportAntennasProcessorService.ts

@@ -0,0 +1,93 @@
+import { Injectable, Inject } from '@nestjs/common';
+import Ajv from 'ajv';
+import { IdService } from '@/core/IdService.js';
+import { GlobalEventService } from '@/core/GlobalEventService.js';
+import Logger from '@/logger.js';
+import type { AntennasRepository } from '@/models/index.js';
+import { DI } from '@/di-symbols.js';
+import { bindThis } from '@/decorators.js';
+import { QueueLoggerService } from '../QueueLoggerService.js';
+import { DBAntennaImportJobData } from '../types.js';
+import type Bull from 'bull';
+
+@Injectable()
+export class ImportAntennasProcessorService {
+	private logger: Logger;
+	constructor (
+		@Inject(DI.antennasRepository)
+		private antennasRepository: AntennasRepository,
+		private queueLoggerService: QueueLoggerService,
+		private idService: IdService,
+		private globalEventService: GlobalEventService,
+	) {
+		this.logger = this.queueLoggerService.logger.createSubLogger('import-antennas');
+	}
+
+	@bindThis
+	public async process(job: Bull.Job<DBAntennaImportJobData>, done: () => void): Promise<void> {
+		const now = new Date();
+		try {
+			const validate = new Ajv().compile({
+				type: 'object',
+				properties: {
+					name: { type: 'string', minLength: 1, maxLength: 100 },
+					src: { type: 'string', enum: ['home', 'all', 'users', 'list'] },
+					userListAcct: { 
+						type: 'array', 
+						items: {
+							type: 'string',
+						}, 
+						nullable: true,
+					},
+					keywords: { type: 'array', items: {
+						type: 'array', items: {
+							type: 'string',
+						},
+					} },
+					excludeKeywords: { type: 'array', items: {
+						type: 'array', items: {
+							type: 'string',
+						},
+					} },
+					users: { type: 'array', items: {
+						type: 'string',
+					} },
+					caseSensitive: { type: 'boolean' },
+					withReplies: { type: 'boolean' },
+					withFile: { type: 'boolean' },
+					notify: { type: 'boolean' },
+				},
+				required: ['name', 'src', 'keywords', 'excludeKeywords', 'users', 'caseSensitive', 'withReplies', 'withFile', 'notify'],
+			});
+			for (const antenna of job.data.antenna) {
+				if (antenna.keywords.length === 0 || antenna.keywords[0].every(x => x === '')) continue;
+				if (!validate(antenna)) {
+					this.logger.warn('Validation Failed');
+					continue;
+				}
+				const result = await this.antennasRepository.insert({
+					id: this.idService.genId(),
+					createdAt: now,
+					lastUsedAt: now,
+					userId: job.data.user.id,
+					name: antenna.name,
+					src: antenna.src === 'list' && antenna.userListAcct ? 'users' : antenna.src,
+					userListId: null,
+					keywords: antenna.keywords,
+					excludeKeywords: antenna.excludeKeywords,
+					users: (antenna.src === 'list' && antenna.userListAcct !== null ? antenna.userListAcct : antenna.users).filter(Boolean),
+					caseSensitive: antenna.caseSensitive,
+					withReplies: antenna.withReplies,
+					withFile: antenna.withFile,
+					notify: antenna.notify,
+				}).then(x => this.antennasRepository.findOneByOrFail(x.identifiers[0]));
+				this.logger.succ('Antenna created: ' + result.id);
+				this.globalEventService.publishInternalEvent('antennaCreated', result);
+			}
+		} catch (err: any) {
+			this.logger.error(err);
+		} finally {
+			done();
+		}
+	}
+}

packages/backend/src/queue/types.ts

@@ -1,3 +1,4 @@
+import type { Antenna } from '@/server/api/endpoints/i/import-antennas.js';
 import type { DriveFile } from '@/models/entities/DriveFile.js';
 import type { Note } from '@/models/entities/Note.js';
 import type { User } from '@/models/entities/User.js';
@@ -33,12 +34,14 @@ export type DbJobData<T extends keyof DbJobMap> = DbJobMap[T];
 export type DbJobMap = {
 	deleteDriveFiles: DbJobDataWithUser;
 	exportCustomEmojis: DbJobDataWithUser;
+	exportAntennas: DBExportAntennasData;
 	exportNotes: DbJobDataWithUser;
 	exportFavorites: DbJobDataWithUser;
 	exportFollowing: DbExportFollowingData;
 	exportMuting: DbJobDataWithUser;
 	exportBlocking: DbJobDataWithUser;
 	exportUserLists: DbJobDataWithUser;
+	importAntennas: DBAntennaImportJobData;
 	importFollowing: DbUserImportJobData;
 	importFollowingToDb: DbUserImportToDbJobData;
 	importMuting: DbUserImportJobData;
@@ -59,6 +62,10 @@ export type DbExportFollowingData = {
 	excludeInactive: boolean;
 };
 
+export type DBExportAntennasData = {
+	user: ThinUser
+}
+
 export type DbUserDeleteJobData = {
 	user: ThinUser;
 	soft?: boolean;
@@ -69,6 +76,11 @@ export type DbUserImportJobData = {
 	fileId: DriveFile['id'];
 };
 
+export type DBAntennaImportJobData = {
+	user: ThinUser,
+	antenna: Antenna
+}
+
 export type DbUserImportToDbJobData = {
 	user: ThinUser;
 	target: string;