Merge pull request MisskeyIO#264 from feat-mute-hide-option

feat: ワードミュートに該当したノートを非表示にできるように

locales/en-US.yml

@@ -1735,6 +1735,7 @@ _wordMute:
   muteWords: "Muted words"
   muteWordsDescription: "Separate with spaces for an AND condition or with line breaks for an OR condition."
   muteWordsDescription2: "Surround keywords with slashes to use regular expressions."
+  hideMutedNotes: "Hide notes containing muted words"
 _instanceMute:
   instanceMuteDescription: "This will mute any notes/renotes from the listed instances, including those of users replying to a user from a muted instance."
   instanceMuteDescription2: "Separate with newlines"

locales/index.d.ts

@@ -644,7 +644,6 @@ export interface Locale {
     "smtpSecureInfo": string;
     "testEmail": string;
     "wordMute": string;
-    "hardWordMute": string;
     "regexpError": string;
     "regexpErrorDescription": string;
     "instanceMute": string;
@@ -1866,6 +1865,7 @@ export interface Locale {
         "muteWords": string;
         "muteWordsDescription": string;
         "muteWordsDescription2": string;
+        "hideMutedNotes": string;
     };
     "_instanceMute": {
         "instanceMuteDescription": string;

locales/ja-JP.yml

@@ -641,7 +641,6 @@ smtpSecure: "SMTP 接続に暗黙的なSSL/TLSを使用する"
 smtpSecureInfo: "STARTTLS使用時はオフにします。"
 testEmail: "配信テスト"
 wordMute: "ワードミュート"
-hardWordMute: "ハードワードミュート"
 regexpError: "正規表現エラー"
 regexpErrorDescription: "{tab}ワードミュートの{line}行目の正規表現にエラーが発生しました:"
 instanceMute: "サーバーミュート"
@@ -1771,6 +1770,7 @@ _wordMute:
   muteWords: "ミュートするワード"
   muteWordsDescription: "スペースで区切るとAND指定になり、改行で区切るとOR指定になります。"
   muteWordsDescription2: "キーワードをスラッシュで囲むと正規表現になります。"
+  hideMutedNotes: "ミュートされた単語を含むノートを非表示にする"
 
 _instanceMute:
   instanceMuteDescription: "ミュートしたサーバーのユーザーへの返信を含めて、設定したサーバーの全てのノートとRenoteをミュートします。"

packages/backend/migration/1700383825690-hard-mute.js

@@ -1,11 +1,11 @@
 export class HardMute1700383825690 {
-    name = 'HardMute1700383825690'
+	name = 'HardMute1700383825690'
 
-    async up(queryRunner) {
-        await queryRunner.query(`ALTER TABLE "user_profile" ADD "hardMutedWords" jsonb NOT NULL DEFAULT '[]'`);
-    }
+	async up(queryRunner) {
+		await queryRunner.query(`ALTER TABLE "user_profile" ADD "hardMutedWords" jsonb NOT NULL DEFAULT '[]'`);
+	}
 
-    async down(queryRunner) {
-        await queryRunner.query(`ALTER TABLE "user_profile" DROP COLUMN "hardMutedWords"`);
-    }
+	async down(queryRunner) {
+		await queryRunner.query(`ALTER TABLE "user_profile" DROP COLUMN "hardMutedWords"`);
+	}
 }

packages/backend/migration/1700880703631-revert-hard-mute.js

@@ -0,0 +1,35 @@
+/*
+ * SPDX-FileCopyrightText: syuilo and other misskey contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+export class RevertHardMute1700880703631 {
+	name = 'RevertHardMute1700880703631';
+
+	async up(queryRunner) {
+		// migrate hardMutedWords to mutedWords
+		await queryRunner.query(`
+			update "user_profile"
+			set "mutedWords" = (
+				select jsonb_agg(elem order by ord)
+				from (
+					select elem, ord
+					from (
+						select elem, row_number() over () as ord
+						from jsonb_array_elements("mutedWords") as elem
+					) as muted
+					union
+					select elem, 1000000 + row_number() over ()
+					from jsonb_array_elements("hardMutedWords") as elem
+					where elem not in (select jsonb_array_elements("mutedWords"))
+				) as combined
+			)
+			where "hardMutedWords" <> '[]'
+		`);
+		await queryRunner.query(`ALTER TABLE "user_profile" DROP COLUMN "hardMutedWords"`);
+	}
+
+	async down(queryRunner) {
+		await queryRunner.query(`ALTER TABLE "user_profile" ADD "hardMutedWords" jsonb NOT NULL DEFAULT '[]'`);
+	}
+}

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

@@ -473,7 +473,6 @@ export class UserEntityService implements OnModuleInit {
 				hasPendingReceivedFollowRequest: this.getHasPendingReceivedFollowRequest(user.id),
 				unreadNotificationsCount: notificationsInfo?.unreadCount,
 				mutedWords: profile!.mutedWords,
-				hardMutedWords: profile!.hardMutedWords,
 				mutedInstances: profile!.mutedInstances,
 				mutingNotificationTypes: [], // 後方互換性のため
 				notificationRecieveConfig: profile!.notificationRecieveConfig,

packages/backend/src/models/UserProfile.ts

@@ -217,11 +217,6 @@ export class MiUserProfile {
 	})
 	public mutedWords: (string[] | string)[];
 
-	@Column('jsonb', {
-		default: [],
-	})
-	public hardMutedWords: (string[] | string)[];
-
 	@Column('jsonb', {
 		default: [],
 		comment: 'List of instances muted by the user.',

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

@@ -534,18 +534,6 @@ export const packedMeDetailedOnlySchema = {
 				},
 			},
 		},
-		hardMutedWords: {
-			type: 'array',
-			nullable: false, optional: false,
-			items: {
-				type: 'array',
-				nullable: false, optional: false,
-				items: {
-					type: 'string',
-					nullable: false, optional: false,
-				},
-			},
-		},
 		mutedInstances: {
 			type: 'array',
 			nullable: true, optional: false,

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

@@ -15,7 +15,6 @@ import type { UsersRepository, DriveFilesRepository, UserProfilesRepository, Pag
 import type { MiLocalUser, MiUser } from '@/models/User.js';
 import { birthdaySchema, descriptionSchema, locationSchema, nameSchema } from '@/models/User.js';
 import type { MiUserProfile } from '@/models/UserProfile.js';
-import { notificationTypes } from '@/types.js';
 import { normalizeForSearch } from '@/misc/normalize-for-search.js';
 import { langmap } from '@/misc/langmap.js';
 import { Endpoint } from '@/server/api/endpoint-base.js';
@@ -124,11 +123,6 @@ export const meta = {
 	},
 } as const;
 
-const muteWordsType = { type: 'array', items: { oneOf: [
-	{ type: 'array', items: { type: 'string' } },
-	{ type: 'string' }
-] } } as const;
-
 export const paramDef = {
 	type: 'object',
 	properties: {
@@ -177,8 +171,12 @@ export const paramDef = {
 		autoSensitive: { type: 'boolean' },
 		ffVisibility: { type: 'string', enum: ['public', 'followers', 'private'] },
 		pinnedPageId: { type: 'string', format: 'misskey:id', nullable: true },
-		mutedWords: muteWordsType,
-		hardMutedWords: muteWordsType,
+		mutedWords: { type: 'array', items: {
+			oneOf: [
+				{ type: 'array', items: { type: 'string' } },
+				{ type: 'string' }
+			]
+		} },
 		mutedInstances: { type: 'array', items: {
 			type: 'string',
 		} },
@@ -241,19 +239,15 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 			if (ps.location !== undefined) profileUpdates.location = ps.location;
 			if (ps.birthday !== undefined) profileUpdates.birthday = ps.birthday;
 			if (ps.ffVisibility !== undefined) profileUpdates.ffVisibility = ps.ffVisibility;
-
-			function checkMuteWordCount(mutedWords: (string[] | string)[], limit: number) {
-				const length = mutedWords.length;
-				if (length > limit) {
+			if (ps.mutedWords !== undefined) {
+				const length = ps.mutedWords.length;
+				if (length > (await this.roleService.getUserPolicies(user.id)).wordMuteLimit) {
 					throw new ApiError(meta.errors.tooManyMutedWords);
 				}
-			}
 
-			function validateMuteWordRegex(mutedWords: (string[] | string)[]) {
-				for (const mutedWord of mutedWords) {
-					if (typeof mutedWord !== "string") continue;
-
-					const regexp = mutedWord.match(/^\/(.+)\/(.*)$/);
+				// validate regular expression syntax
+				ps.mutedWords.filter(x => !Array.isArray(x)).forEach(x => {
+					const regexp = RegExp(/^\/(.+)\/(.*)$/).exec(x as string);
 					if (!regexp) throw new ApiError(meta.errors.invalidRegexp);
 
 					try {
@@ -261,21 +255,11 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 					} catch (err) {
 						throw new ApiError(meta.errors.invalidRegexp);
 					}
-				}
-			}
-
-			if (ps.mutedWords !== undefined) {
-				checkMuteWordCount(ps.mutedWords, (await this.roleService.getUserPolicies(user.id)).wordMuteLimit);
-				validateMuteWordRegex(ps.mutedWords);
+				});
 
 				profileUpdates.mutedWords = ps.mutedWords;
 				profileUpdates.enableWordMute = ps.mutedWords.length > 0;
 			}
-			if (ps.hardMutedWords !== undefined) {
-				checkMuteWordCount(ps.hardMutedWords, (await this.roleService.getUserPolicies(user.id)).wordMuteLimit);
-				validateMuteWordRegex(ps.hardMutedWords);
-				profileUpdates.hardMutedWords = ps.hardMutedWords;
-			}
 			if (ps.mutedInstances !== undefined) profileUpdates.mutedInstances = ps.mutedInstances;
 			if (ps.notificationRecieveConfig !== undefined) profileUpdates.notificationRecieveConfig = ps.notificationRecieveConfig;
 			if (typeof ps.isLocked === 'boolean') updates.isLocked = ps.isLocked;

packages/backend/test/e2e/users.ts

@@ -169,7 +169,6 @@ describe('ユーザー', () => {
 			hasPendingReceivedFollowRequest: user.hasPendingReceivedFollowRequest,
 			unreadAnnouncements: user.unreadAnnouncements,
 			mutedWords: user.mutedWords,
-			hardMutedWords: user.hardMutedWords,
 			mutedInstances: user.mutedInstances,
 			mutingNotificationTypes: user.mutingNotificationTypes,
 			notificationRecieveConfig: user.notificationRecieveConfig,

packages/frontend/src/components/MkNote.vue

@@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 
 <template>
 <div
-	v-if="!hardMuted && !muted"
+	v-if="!muted"
 	v-show="!isDeleted"
 	ref="el"
 	v-hotkey="keymap"
@@ -133,7 +133,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 		</div>
 	</article>
 </div>
-<div v-else-if="!hardMuted" :class="$style.muted" @click="muted = false">
+<div v-else :class="$style.muted" :style="hideMutedNotes ? 'display: none' : undefined" @click="muted = false">
 	<I18n :src="i18n.ts.userSaysSomething" tag="small">
 		<template #name>
 			<MkA v-user-preview="appearNote.userId" :to="userPage(appearNote.user)">
@@ -183,7 +183,6 @@ const props = withDefaults(defineProps<{
 	note: Misskey.entities.Note;
 	pinned?: boolean;
 	mock?: boolean;
-	withHardMute?: boolean;
 }>(), {
 	mock: false,
 });
@@ -241,11 +240,11 @@ const isLong = shouldCollapsed(appearNote, urls ?? []);
 const collapsed = ref(appearNote.cw == null && isLong);
 const isDeleted = ref(false);
 const muted = ref(checkMute(appearNote, $i?.mutedWords));
-const hardMuted = ref(props.withHardMute && checkMute(appearNote, $i?.hardMutedWords));
 const translation = ref<any>(null);
 const translating = ref(false);
 const showTicker = (defaultStore.state.instanceTicker === 'always') || (defaultStore.state.instanceTicker === 'remote' && appearNote.user.instance);
 const canRenote = computed(() => ['public', 'home'].includes(appearNote.visibility) || (appearNote.visibility === 'followers' && appearNote.userId === $i.id));
+const hideMutedNotes = defaultStore.state.hideMutedNotes;
 let renoteCollapsed = $ref(defaultStore.state.collapseRenotes && isRenote && (($i && ($i.id === note.userId || $i.id === appearNote.userId)) || (appearNote.myReaction != null)));
 
 function checkMute(note: Misskey.entities.Note, mutedWords: Array<string | string[]> | undefined | null): boolean {

packages/frontend/src/components/MkNotes.vue

@@ -24,7 +24,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 				:ad="true"
 				:class="$style.notes"
 			>
-				<MkNote :key="note._featuredId_ || note._prId_ || note.id" :class="$style.note" :note="note" :withHardMute="true"/>
+				<MkNote :key="note._featuredId_ || note._prId_ || note.id" :class="$style.note" :note="note"/>
 			</MkDateSeparatedList>
 		</div>
 	</template>

packages/frontend/src/components/MkNotifications.vue

@@ -15,7 +15,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 
 		<template #default="{ items: notifications }">
 			<MkDateSeparatedList v-slot="{ item: notification }" :class="$style.list" :items="notifications" :noGap="true">
-				<MkNote v-if="['reply', 'quote', 'mention'].includes(notification.type)" :key="notification.id" :note="notification.note" :withHardMute="true"/>
+				<MkNote v-if="['reply', 'quote', 'mention'].includes(notification.type)" :key="notification.id" :note="notification.note"/>
 				<XNotification v-else :key="notification.id" :notification="notification" :withTime="true" :full="true" class="_panel"/>
 			</MkDateSeparatedList>
 		</template>

packages/frontend/src/pages/settings/general.vue

@@ -46,6 +46,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 				<MkSwitch v-model="showNoteActionsOnlyHover">{{ i18n.ts.showNoteActionsOnlyHover }}</MkSwitch>
 				<MkSwitch v-model="showClipButtonInNoteFooter">{{ i18n.ts.showClipButtonInNoteFooter }}</MkSwitch>
 				<MkSwitch v-model="collapseRenotes">{{ i18n.ts.collapseRenotes }}</MkSwitch>
+				<MkSwitch v-model="hideMutedNotes">{{ i18n.ts._wordMute.hideMutedNotes }}</MkSwitch>
 				<MkSwitch v-model="advancedMfm">{{ i18n.ts.enableAdvancedMfm }}</MkSwitch>
 				<MkSwitch v-if="advancedMfm" v-model="animatedMfm">{{ i18n.ts.enableAnimatedMfm }}</MkSwitch>
 				<MkSwitch v-model="showGapBetweenNotesInTimeline">{{ i18n.ts.showGapBetweenNotesInTimeline }}</MkSwitch>
@@ -229,6 +230,7 @@ const showClipButtonInNoteFooter = computed(defaultStore.makeGetterSetter('showC
 const reactionsDisplaySize = computed(defaultStore.makeGetterSetter('reactionsDisplaySize'));
 const limitWidthOfReaction = computed(defaultStore.makeGetterSetter('limitWidthOfReaction'));
 const collapseRenotes = computed(defaultStore.makeGetterSetter('collapseRenotes'));
+const hideMutedNotes = computed(defaultStore.makeGetterSetter('hideMutedNotes'));
 const reduceAnimation = computed(defaultStore.makeGetterSetter('animation', v => !v, v => !v));
 const useBlurEffectForModal = computed(defaultStore.makeGetterSetter('useBlurEffectForModal'));
 const useBlurEffect = computed(defaultStore.makeGetterSetter('useBlurEffect'));
@@ -295,6 +297,7 @@ watch([
 	limitWidthOfReaction,
 	highlightSensitiveMedia,
 	keepScreenOn,
+    hideMutedNotes,
 	disableStreamingTimeline,
 ], async () => {
 	await reloadAsk();

packages/frontend/src/pages/settings/mute-block.vue

@@ -9,14 +9,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 		<template #icon><i class="ti ti-message-off"></i></template>
 		<template #label>{{ i18n.ts.wordMute }}</template>
 
-		<XWordMute :muted="$i!.mutedWords" @save="saveMutedWords"/>
-	</MkFolder>
-
-	<MkFolder>
-		<template #icon><i class="ti ti-message-off"></i></template>
-		<template #label>{{ i18n.ts.hardWordMute }}</template>
-
-		<XWordMute :muted="$i!.hardMutedWords" @save="saveHardMutedWords"/>
+		<XWordMute/>
 	</MkFolder>
 
 	<MkFolder>
@@ -136,7 +129,6 @@ import { definePageMetadata } from '@/scripts/page-metadata.js';
 import MkUserCardMini from '@/components/MkUserCardMini.vue';
 import * as os from '@/os.js';
 import { infoImageUrl } from '@/instance.js';
-import { $i } from '@/account.js';
 import MkFolder from '@/components/MkFolder.vue';
 
 const renoteMutingPagination = {
@@ -215,14 +207,6 @@ async function toggleBlockItem(item) {
 	}
 }
 
-async function saveMutedWords(mutedWords: (string | string[])[]) {
-	await os.api('i/update', { mutedWords });
-}
-
-async function saveHardMutedWords(hardMutedWords: (string | string[])[]) {
-	await os.api('i/update', { hardMutedWords });
-}
-
 const headerActions = $computed(() => []);
 
 const headerTabs = $computed(() => []);

packages/frontend/src/pages/settings/mute-block.word-mute.vue

@@ -20,17 +20,10 @@ import { ref, watch } from 'vue';
 import MkTextarea from '@/components/MkTextarea.vue';
 import MkButton from '@/components/MkButton.vue';
 import * as os from '@/os.js';
+import { $i } from '@/account.js';
 import { i18n } from '@/i18n.js';
 
-const props = defineProps<{
-	muted: (string[] | string)[];
-}>();
-
-const emit = defineEmits<{
-	(ev: 'save', value: (string[] | string)[]): void;
-}>();
-
-const render = (mutedWords) => mutedWords.map(x => {
+const render = (mutedWords?: (string | string[])[]) => mutedWords?.map(x => {
 	if (Array.isArray(x)) {
 		return x.join(' ');
 	} else {
@@ -38,7 +31,7 @@ const render = (mutedWords) => mutedWords.map(x => {
 	}
 }).join('\n');
 
-const mutedWords = ref(render(props.muted));
+const mutedWords = ref(render($i?.mutedWords));
 const changed = ref(false);
 
 watch(mutedWords, () => {
@@ -46,14 +39,14 @@ watch(mutedWords, () => {
 });
 
 async function save() {
-	const parseMutes = (mutes) => {
-		// split into lines, remove empty lines and unnecessary whitespace
-		let lines = mutes.trim().split('\n').map(line => line.trim()).filter(line => line !== '');
+	const parseMutes = (mutes?: string): (string | string[])[] => {
+		const parsed: (string | string[])[] = [];
+		if (!mutes) return parsed;
 
+		// split into lines, remove empty lines and unnecessary whitespace
 		// check each line if it is a RegExp or not
-		for (let i = 0; i < lines.length; i++) {
-			const line = lines[i];
-			const regexp = line.match(/^\/(.+)\/(.*)$/);
+		for (const [i, line] of mutes.trim().split('\n').map(line => line.trim()).filter(line => line !== '').entries()) {
+			const regexp = RegExp(/^\/(.+)\/(.*)$/).exec(line);
 			if (regexp) {
 				// check that the RegExp is valid
 				try {
@@ -69,15 +62,16 @@ async function save() {
 					// re-throw error so these invalid settings are not saved
 					throw err;
 				}
+				parsed.push(line);
 			} else {
-				lines[i] = line.split(' ');
+				parsed.push(line.split(' '));
 			}
 		}
 
-		return lines;
+		return parsed;
 	};
 
-	let parsed;
+	let parsed: (string | string[])[];
 	try {
 		parsed = parseMutes(mutedWords.value);
 	} catch (err) {
@@ -85,7 +79,9 @@ async function save() {
 		return;
 	}
 
-	emit('save', parsed);
+	await os.api('i/update', {
+		mutedWords: parsed,
+	});
 
 	changed.value = false;
 }

packages/frontend/src/store.ts

@@ -370,6 +370,10 @@ export const defaultStore = markRaw(new Storage('base', {
 		where: 'device',
 		default: false,
 	},
+	hideMutedNotes: {
+		where: 'device',
+		default: false,
+	},
 	tlWithReplies: {
 		where: 'device',
 		default: false,

packages/misskey-js/etc/misskey-js.api.md

@@ -1588,7 +1588,6 @@ export type Endpoints = {
             receiveAnnouncementEmail?: boolean;
             alwaysMarkNsfw?: boolean;
             mutedWords?: (string[] | string)[];
-            hardMutedWords?: (string[] | string)[];
             notificationRecieveConfig?: any;
             emailNotificationTypes?: string[];
             alsoKnownAs?: string[];
@@ -2545,7 +2544,6 @@ type MeDetailed = UserDetailed & {
     isDeleted: boolean;
     isExplorable: boolean;
     mutedWords: (string[] | string)[];
-    hardMutedWords: (string[] | string)[];
     notificationRecieveConfig: {
         [notificationType in typeof notificationTypes_2[number]]?: {
             type: 'all';
@@ -3084,9 +3082,9 @@ type UserSorting = '+follower' | '-follower' | '+createdAt' | '-createdAt' | '+u
 //
 // src/api.types.ts:16:32 - (ae-forgotten-export) The symbol "TODO" needs to be exported by the entry point index.d.ts
 // src/api.types.ts:20:25 - (ae-forgotten-export) The symbol "NoParams" needs to be exported by the entry point index.d.ts
-// src/api.types.ts:639:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts
-// src/entities.ts:120:2 - (ae-forgotten-export) The symbol "notificationTypes_2" needs to be exported by the entry point index.d.ts
-// src/entities.ts:638:2 - (ae-forgotten-export) The symbol "ModerationLogPayloads" needs to be exported by the entry point index.d.ts
+// src/api.types.ts:638:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts
+// src/entities.ts:119:2 - (ae-forgotten-export) The symbol "notificationTypes_2" needs to be exported by the entry point index.d.ts
+// src/entities.ts:637:2 - (ae-forgotten-export) The symbol "ModerationLogPayloads" needs to be exported by the entry point index.d.ts
 // src/streaming.types.ts:33:4 - (ae-forgotten-export) The symbol "FIXME" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)

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

@@ -437,7 +437,6 @@ export type Endpoints = {
 		receiveAnnouncementEmail?: boolean;
 		alwaysMarkNsfw?: boolean;
 		mutedWords?: (string[] | string)[];
-		hardMutedWords?: (string[] | string)[];
 		notificationRecieveConfig?: any;
 		emailNotificationTypes?: string[];
 		alsoKnownAs?: string[];

packages/misskey-js/src/entities.ts

@@ -116,7 +116,6 @@ export type MeDetailed = UserDetailed & {
 	isDeleted: boolean;
 	isExplorable: boolean;
 	mutedWords: (string[] | string)[];
-	hardMutedWords: (string[] | string)[];
 	notificationRecieveConfig: {
 		[notificationType in typeof notificationTypes[number]]?: {
 			type: 'all';