feat: アンテナでセンシティブなチャンネルからのノートを除外できるように

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 2025.2.1
 
 ### General
+- Enhance: アンテナでセンシティブなチャンネルのノートを除外できるように `#14177`
 - Feat: アクセストークン発行時に通知するように
 - 依存関係の更新
 

locales/en-US.yml

@@ -425,6 +425,7 @@ antennaExcludeBots: "Exclude bot accounts"
 antennaKeywordsDescription: "Separate with spaces for an AND condition or with line breaks for an OR condition."
 notifyAntenna: "Notify about new notes"
 withFileAntenna: "Only notes with files"
+hideNotesInSensitiveChannel: "Hide notes in sensitive channels"
 enableServiceworker: "Enable Push-Notifications for your Browser"
 antennaUsersDescription: "List one username per line"
 caseSensitive: "Case sensitive"

locales/index.d.ts

@@ -1718,6 +1718,10 @@ export interface Locale extends ILocale {
      * ファイルが添付されたノートのみ
      */
     "withFileAntenna": string;
+    /**
+     * センシティブなチャンネルのノートを非表示
+     */
+    "hideNotesInSensitiveChannel": string;
     /**
      * ブラウザへのプッシュ通知を有効にする
      */

locales/ja-JP.yml

@@ -425,6 +425,7 @@ antennaExcludeBots: "Botアカウントを除外"
 antennaKeywordsDescription: "スペースで区切るとAND指定になり、改行で区切るとOR指定になります"
 notifyAntenna: "新しいノートを通知する"
 withFileAntenna: "ファイルが添付されたノートのみ"
+hideNotesInSensitiveChannel: "センシティブなチャンネルのノートを非表示"
 enableServiceworker: "ブラウザへのプッシュ通知を有効にする"
 antennaUsersDescription: "ユーザー名を改行で区切って指定します"
 caseSensitive: "大文字小文字を区別する"

packages/backend/migration/1736230492103-addAntennaHideNotesInSensitiveChannel.js

@@ -0,0 +1,16 @@
+/*
+ * SPDX-FileCopyrightText: syuilo and misskey-project
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+export class AddAntennaHideNotesInSensitiveChannel1736230492103 {
+    name = 'AddAntennaHideNotesInSensitiveChannel1736230492103'
+
+    async up(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "antenna" ADD "hideNotesInSensitiveChannel" boolean NOT NULL DEFAULT false`);
+    }
+
+    async down(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "antenna" DROP COLUMN "hideNotesInSensitiveChannel"`);
+    }
+}

packages/backend/src/core/AntennaService.ts

@@ -114,6 +114,8 @@ export class AntennaService implements OnApplicationShutdown {
 		if (note.visibility === 'specified') return false;
 		if (note.visibility === 'followers') return false;
 
+		if (antenna.hideNotesInSensitiveChannel && note.channel?.isSensitive) return false;
+
 		if (antenna.excludeBots && noteUser.isBot) return false;
 
 		if (antenna.localOnly && noteUser.host != null) return false;

packages/backend/src/core/NoteCreateService.ts

@@ -410,6 +410,7 @@ export class NoteCreateService implements OnApplicationShutdown {
 			replyId: data.reply ? data.reply.id : null,
 			renoteId: data.renote ? data.renote.id : null,
 			channelId: data.channel ? data.channel.id : null,
+			channel: data.channel,
 			threadId: data.reply
 				? data.reply.threadId
 					? data.reply.threadId

packages/backend/src/core/entities/AntennaEntityService.ts

@@ -41,6 +41,7 @@ export class AntennaEntityService {
 			excludeBots: antenna.excludeBots,
 			withReplies: antenna.withReplies,
 			withFile: antenna.withFile,
+			hideNotesInSensitiveChannel: antenna.hideNotesInSensitiveChannel,
 			isActive: antenna.isActive,
 			hasUnreadNote: false, // TODO
 			notify: false, // 後方互換性のため

packages/backend/src/models/Antenna.ts

@@ -100,4 +100,9 @@ export class MiAntenna {
 		default: false,
 	})
 	public localOnly: boolean;
+
+	@Column('boolean', {
+		default: false,
+	})
+	public hideNotesInSensitiveChannel: boolean;
 }

packages/backend/src/models/json-schema/antenna.ts

@@ -100,5 +100,10 @@ export const packedAntennaSchema = {
 			optional: false, nullable: false,
 			default: false,
 		},
+		hideNotesInSensitiveChannel: {
+			type: 'boolean',
+			optional: false, nullable: false,
+			default: false,
+		},
 	},
 } as const;

packages/backend/src/server/api/endpoints/antennas/create.ts

@@ -73,6 +73,7 @@ export const paramDef = {
 		excludeBots: { type: 'boolean' },
 		withReplies: { type: 'boolean' },
 		withFile: { type: 'boolean' },
+		hideNotesInSensitiveChannel: { type: 'boolean' },
 	},
 	required: ['name', 'src', 'keywords', 'excludeKeywords', 'users', 'caseSensitive', 'withReplies', 'withFile'],
 } as const;
@@ -133,6 +134,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 				excludeBots: ps.excludeBots,
 				withReplies: ps.withReplies,
 				withFile: ps.withFile,
+				hideNotesInSensitiveChannel: ps.hideNotesInSensitiveChannel,
 			});
 
 			this.globalEventService.publishInternalEvent('antennaCreated', antenna);

packages/backend/src/server/api/endpoints/antennas/notes.ts

@@ -113,6 +113,9 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 				.leftJoinAndSelect('reply.user', 'replyUser')
 				.leftJoinAndSelect('renote.user', 'renoteUser');
 
+			// NOTE: センシティブ除外の設定はこのエンドポイントでは無視する。
+			// https://github.com/misskey-dev/misskey/pull/15346#discussion_r1929950255
+
 			this.queryService.generateVisibilityQuery(query, me);
 			this.queryService.generateMutedUserQuery(query, me);
 			this.queryService.generateBlockedUserQuery(query, me);

packages/backend/src/server/api/endpoints/antennas/update.ts

@@ -72,6 +72,7 @@ export const paramDef = {
 		excludeBots: { type: 'boolean' },
 		withReplies: { type: 'boolean' },
 		withFile: { type: 'boolean' },
+		hideNotesInSensitiveChannel: { type: 'boolean' },
 	},
 	required: ['antennaId'],
 } as const;
@@ -129,6 +130,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 				excludeBots: ps.excludeBots,
 				withReplies: ps.withReplies,
 				withFile: ps.withFile,
+				hideNotesInSensitiveChannel: ps.hideNotesInSensitiveChannel,
 				isActive: true,
 				lastUsedAt: new Date(),
 			});

packages/backend/test/e2e/antennas.ts

@@ -146,6 +146,7 @@ describe('アンテナ', () => {
 			caseSensitive: false,
 			createdAt: new Date(response.createdAt).toISOString(),
 			excludeKeywords: [['']],
+			hideNotesInSensitiveChannel: false,
 			hasUnreadNote: false,
 			isActive: true,
 			keywords: [['keyword']],
@@ -217,6 +218,8 @@ describe('アンテナ', () => {
 		{ parameters: () => ({ withReplies: true }) },
 		{ parameters: () => ({ withFile: false }) },
 		{ parameters: () => ({ withFile: true }) },
+		{ parameters: () => ({ hideNotesInSensitiveChannel: false }) },
+		{ parameters: () => ({ hideNotesInSensitiveChannel: true }) },
 	];
 	test.each(antennaParamPattern)('を作成できること($#)', async ({ parameters }) => {
 		const response = await successfulApiCall({
@@ -626,6 +629,42 @@ describe('アンテナ', () => {
 			assert.deepStrictEqual(response, expected);
 		});
 
+		test('が取得できること（センシティブチャンネルのノートを除く）', async () => {
+			const keyword = 'キーワード';
+			const antenna = await successfulApiCall({
+				endpoint: 'antennas/create',
+				parameters: { ...defaultParam, keywords: [[keyword]], hideNotesInSensitiveChannel: true },
+				user: alice,
+			});
+			const nonSensitiveChannel = await successfulApiCall({
+				endpoint: 'channels/create',
+				parameters: { name: 'test', isSensitive: false },
+				user: alice,
+			});
+			const sensitiveChannel = await successfulApiCall({
+				endpoint: 'channels/create',
+				parameters: { name: 'test', isSensitive: true },
+				user: alice,
+			});
+
+			const noteInLocal = await post(bob, { text: `test ${keyword}` });
+			const noteInNonSensitiveChannel = await post(bob, { text: `test ${keyword}`, channelId: nonSensitiveChannel.id });
+			await post(bob, { text: `test ${keyword}`, channelId: sensitiveChannel.id });
+
+			const response = await successfulApiCall({
+				endpoint: 'antennas/notes',
+				parameters: { antennaId: antenna.id },
+				user: alice,
+			});
+			// 最後に投稿したものが先頭に来る。
+			const expected = [
+				noteInNonSensitiveChannel,
+				noteInLocal,
+			];
+			assert.deepStrictEqual(response, expected);
+		});
+
+
 		test.skip('が取得でき、日付指定のPaginationに一貫性があること', async () => { });
 		test.each([
 			{ label: 'ID指定', offsetBy: 'id' },

packages/frontend/src/components/MkAntennaEditor.vue

@@ -39,6 +39,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 			<MkSwitch v-model="localOnly">{{ i18n.ts.localOnly }}</MkSwitch>
 			<MkSwitch v-model="caseSensitive">{{ i18n.ts.caseSensitive }}</MkSwitch>
 			<MkSwitch v-model="withFile">{{ i18n.ts.withFileAntenna }}</MkSwitch>
+			<MkSwitch v-model="hideNotesInSensitiveChannel">{{ i18n.ts.hideNotesInSensitiveChannel }}</MkSwitch>
 		</div>
 		<div :class="$style.actions">
 			<div class="_buttons">
@@ -86,6 +87,7 @@ const initialAntenna = deepMerge<PartialAllowedAntenna>(props.antenna ?? {}, {
 	caseSensitive: false,
 	localOnly: false,
 	withFile: false,
+	hideNotesInSensitiveChannel: false,
 	isActive: true,
 	hasUnreadNote: false,
 	notify: false,
@@ -108,6 +110,7 @@ const localOnly = ref<boolean>(initialAntenna.localOnly);
 const excludeBots = ref<boolean>(initialAntenna.excludeBots);
 const withReplies = ref<boolean>(initialAntenna.withReplies);
 const withFile = ref<boolean>(initialAntenna.withFile);
+const hideNotesInSensitiveChannel = ref<boolean>(initialAntenna.hideNotesInSensitiveChannel);
 const userLists = ref<Misskey.entities.UserList[] | null>(null);
 
 watch(() => src.value, async () => {
@@ -124,6 +127,7 @@ async function saveAntenna() {
 		excludeBots: excludeBots.value,
 		withReplies: withReplies.value,
 		withFile: withFile.value,
+		hideNotesInSensitiveChannel: hideNotesInSensitiveChannel.value,
 		caseSensitive: caseSensitive.value,
 		localOnly: localOnly.value,
 		users: users.value.trim().split('\n').map(x => x.trim()),

packages/misskey-js/src/autogen/types.ts

@@ -4661,6 +4661,8 @@ export type components = {
       hasUnreadNote: boolean;
       /** @default false */
       notify: boolean;
+      /** @default false */
+      hideNotesInSensitiveChannel: boolean;
     };
     Clip: {
       /**
@@ -10926,6 +10928,7 @@ export type operations = {
           excludeBots?: boolean;
           withReplies: boolean;
           withFile: boolean;
+          hideNotesInSensitiveChannel?: boolean;
         };
       };
     };
@@ -11207,6 +11210,7 @@ export type operations = {
           excludeBots?: boolean;
           withReplies?: boolean;
           withFile?: boolean;
+          hideNotesInSensitiveChannel?: boolean;
         };
       };
     };