malice

public

Star0

Fork 0

Watch0

78 commits 2 branches 0 tags 0 releases4.4 MiB

Commit `a4555a7eae2d`

tarball

atagen <boss@atagen.co>2026-10-25 10:10 UTC

15 files changed+197-6

keywords: highlight configured keywords like mentions

Keywords are Matrix push rule content patterns managed through macltok's notification keyword calls, so they follow the account to other clients. Rows matching one get the mention treatment, using the event's highlight flag once macltok provides it and a client-side match on the same word-boundary glob semantics until then. The mentions inbox accepts a Keyword reason, because its parser previously dropped entries with unknown reasons.

Modified file: crates/malice-core/src/feed.rs+2 additions−1 deletions@@ -29,6 +29,7 @@ pub enum WireEvent {
         room_id: String,
         state: RecentHistoryState,
     },
+    NotificationSettings,
     ImagePacks {
         packs: ImagePacks,
     },
@@ -198,6 +199,7 @@ pub fn wire_events(change: &StateChange) -> Vec<WireEvent> {
             room_id: room_id.as_str().to_owned(),
             state: state.clone(),
         }],
+        StateChange::NotificationSettings => vec![WireEvent::NotificationSettings],
         StateChange::Failed(failure) => vec![error(&failure.message)],
         StateChange::SessionSaveFailed(_) => {
             vec![error(
@@ -223,7 +225,6 @@ pub fn wire_events(change: &StateChange) -> Vec<WireEvent> {
         | StateChange::Session(_)
         | StateChange::SessionSaved
         | StateChange::VerificationTarget(_)
-        | StateChange::NotificationSettings
         | StateChange::History { .. }
         | StateChange::HistoryRepair(_)
         | StateChange::Typing(_) => vec![],

Modified file: crates/malice-core/src/request.rs+30 additions@@ -23,6 +23,16 @@ fn default_avatar_size() -> u32 {
     AVATAR_SIZE
 }
 
+fn parse_keyword(raw: &str) -> Result<String, CoreError> {
+    let keyword = raw.trim();
+    if keyword.is_empty() || keyword.chars().count() > 128 {
+        return Err(CoreError::bad_request(
+            "keyword must be 1 to 128 characters",
+        ));
+    }
+    Ok(keyword.to_owned())
+}
+
 #[derive(Debug, Deserialize)]
 #[serde(tag = "op", rename_all = "snake_case")]
 pub enum Request {
@@ -285,6 +295,13 @@ pub enum Request {
         user_id: String,
         muted: bool,
     },
+    NotificationKeywords,
+    AddNotificationKeyword {
+        keyword: String,
+    },
+    RemoveNotificationKeyword {
+        keyword: String,
+    },
     Ignore {
         user_id: String,
     },
@@ -1011,6 +1028,19 @@ pub async fn dispatch(
                 .await?;
             Ok(Reply::Done)
         }
+        Request::NotificationKeywords => Ok(Reply::Json(
+            json!({ "keywords": handle.notification_keywords().await }),
+        )),
+        Request::AddNotificationKeyword { keyword } => {
+            handle
+                .add_notification_keyword(parse_keyword(&keyword)?)
+                .await?;
+            Ok(Reply::Done)
+        }
+        Request::RemoveNotificationKeyword { keyword } => {
+            handle.remove_notification_keyword(keyword).await?;
+            Ok(Reply::Done)
+        }
         Request::UploadMedia { bytes } => {
             let content_type = image_upload_type(&bytes)?;
             let mxc = handle.upload_media(content_type, bytes).await?;

Modified file: crates/malice-server/src/routes.rs+3 additions@@ -581,6 +581,9 @@ async fn post_command(
             | Request::SetRoomDisplayName { .. }
             | Request::SetRoomAvatar { .. }
             | Request::Mute { .. }
+            | Request::NotificationKeywords
+            | Request::AddNotificationKeyword { .. }
+            | Request::RemoveNotificationKeyword { .. }
             | Request::Ignore { .. }
             | Request::Unignore { .. }
             | Request::PowerLevels { .. }

Modified file: web/src/App.svelte+4 additions@@ -87,6 +87,7 @@
   import { mentionQueryAt, mentionsFromHtml, rankPeople, resolveMentions } from './lib/mentions';
   import type { Mention, MentionQuery } from './lib/mentions';
   import { loadQuickReactions, quickReactions, saveQuickReactions } from './lib/quick-reactions';
+  import { loadKeywords } from './lib/keywords';
   import {
     linkPreviews,
     loadUrlPreviewSettings,
@@ -192,6 +193,7 @@
     const online = $connection === 'online';
     if (online && !wasOnline) {
       void loadQuickReactions();
+      void loadKeywords();
       void loadPackPreferences();
       void loadUrlPreviewSettings();
     }
@@ -415,6 +417,7 @@
         void loadProfile();
         void loadEncryption();
         void loadQuickReactions();
+        void loadKeywords();
         void loadPackPreferences();
         void loadUrlPreviewSettings();
       } else {
@@ -472,6 +475,7 @@
     void loadProfile();
     void loadEncryption();
     void loadQuickReactions();
+    void loadKeywords();
     void loadPackPreferences();
     void loadUrlPreviewSettings();
   }

Added file: web/src/lib/KeywordSettings.svelte+62 additions@@ -0,0 +1,62 @@
+<script lang="ts">
+  import { addKeyword, notificationKeywords, removeKeyword } from './keywords';
+  import { pushBanner } from './store';
+
+  let draft = '';
+  let busy = false;
+
+  $: trimmed = draft.trim();
+  $: duplicate = $notificationKeywords.some((k) => k.toLowerCase() === trimmed.toLowerCase());
+
+  async function run(action: () => Promise<void>, failure: string): Promise<void> {
+    if (busy) return;
+    busy = true;
+    try {
+      await action();
+    } catch (e) {
+      pushBanner(e instanceof Error ? e.message : failure);
+    } finally {
+      busy = false;
+    }
+  }
+
+  function add(): void {
+    if (!trimmed || duplicate) return;
+    const keyword = trimmed;
+    void run(async () => {
+      await addKeyword(keyword);
+      draft = '';
+    }, 'Adding the keyword failed');
+  }
+</script>
+
+<section aria-label="Keywords">
+  <h3 class="sec-h">Keywords</h3>
+  {#if $notificationKeywords.length}
+    <ul class="keywords">
+      {#each $notificationKeywords as keyword (keyword)}
+        <li>
+          <span>{keyword}</span>
+          <button type="button" class="icon-btn" aria-label={`Remove ${keyword}`} disabled={busy} on:click={() => void run(() => removeKeyword(keyword), 'Removing the keyword failed')}>
+            <span aria-hidden="true">✕</span>
+          </button>
+        </li>
+      {/each}
+    </ul>
+  {/if}
+  <form class="add" on:submit|preventDefault={add}>
+    <input type="text" placeholder="Keyword" bind:value={draft} maxlength="128" aria-label="New keyword" />
+    <button type="submit" class="ghost-btn" disabled={busy || !trimmed || duplicate}>Add</button>
+  </form>
+</section>
+
+<style>
+  section { margin-top: 18px; }
+  .sec-h { font-size: 12px; text-transform: uppercase; letter-spacing: 0.08em; color: var(--muted); margin: 0 0 6px; }
+  .keywords { list-style: none; margin: 0 0 8px; padding: 0; display: flex; flex-wrap: wrap; gap: 6px; }
+  .keywords li { display: inline-flex; align-items: center; gap: 2px; padding: 2px 2px 2px 8px; border: 1px solid var(--border); border-radius: var(--r-sm); background: var(--bg-soft); font-size: 13px; animation: pop-in var(--pop); }
+  .keywords .icon-btn { width: 22px; height: 22px; font-size: 11px; }
+  .add { display: flex; gap: 8px; }
+  .add input { flex: 1; min-width: 0; background: var(--bg-soft); border: 1px solid var(--border); border-radius: var(--r-sm); color: var(--text); padding: 6px 8px; }
+  .add input:focus { outline: none; border-color: var(--accent); }
+</style>

Modified file: web/src/lib/MentionsInbox.svelte+1−1

@@ -52,7 +52,7 @@

5252 return entry.room_name || joinedRooms.get(entry.key.room_id)?.name || entry.key.room_id;

5353 }

5454 function reasonLabel(reason: string): string {

55- return reason === 'Direct' ? 'Direct mention' : reason === 'Reply' ? 'Reply' : 'Room mention';

+    return reason === 'Direct' ? 'Direct mention' : reason === 'Reply' ? 'Reply' : reason === 'Keyword' ? 'Keyword' : 'Room mention';

5656 }

5757 function captureLabel(state: MentionEntry['capture']): string {

5858 if (state.kind === 'Failed') return state.message;

Modified file: web/src/lib/MessageRow.svelte+3 additions−1 deletions@@ -7,6 +7,7 @@
   import ReactionPicker from './ReactionPicker.svelte';
   import LinkCard from './LinkCard.svelte';
   import { mediaUrl, messageMediaUrl } from './api';
+  import { keywordMatcher } from './keywords';
   import type { ImagePack, LinkPreview, Person, QuickReaction, ReplyReference, SendState, TimelineContent, TimelineEvent } from './types';
   import { senderLabel } from './types';
   import { formatClock, formatDay, initialsOf, senderHue } from './format';
@@ -101,6 +102,7 @@
   $: linked = message ? [...mentionsFromHtml(message.formatted_body), ...stripped.mentions] : [];
   $: mentions = resolveMentions(stripped.text, linked);
   $: mentionsMe = self !== null && [...linked, ...mentions].some((m) => m.user_id === self);
+  $: keywordHit = !event.own && (event.highlight === true || (message !== null && ($keywordMatcher?.test(stripped.text) ?? false)));
   $: previews = findUrls(stripped.text);
   $: bundled = message ? message.link_previews : [];
   $: cards = previews
@@ -265,7 +267,7 @@
   class="msg"
   class:own={event.own}
   class:editing
-  class:mentioned={mentionsMe}
+  class:mentioned={mentionsMe || keywordHit}
   class:system={!interactive}
   class:has-readers={interactive && readers.length > 0}
   class:selected

Modified file: web/src/lib/SettingsPanel.svelte+3 additions@@ -13,6 +13,7 @@
   import { DEFAULT_QUICK_REACTIONS } from './quick-reactions';
   import ReactionPicker from './ReactionPicker.svelte';
   import ThemeSettings from './ThemeSettings.svelte';
+  import KeywordSettings from './KeywordSettings.svelte';
   import type { ImagePack, QuickReaction } from './types';
 
   export let quick: QuickReaction[];
@@ -79,6 +80,8 @@
     </div>
   </section>
 
+  <KeywordSettings />
+
   <section aria-label="Quick reactions">
     <div class="sec-head">
       <h3 class="sec-h">Quick reactions</h3>

Added file: web/src/lib/keyword-pattern.ts+13 additions@@ -0,0 +1,13 @@
+function escape(text: string): string {
+  return text.replace(/[.+^${}()|[\]\\]/g, '\\$&');
+}
+
+/** Push rule content patterns are case-insensitive globs that match whole words. */
+export function keywordPattern(keywords: string[]): RegExp | null {
+  const parts = keywords
+    .map((k) => k.trim())
+    .filter(Boolean)
+    .map((k) => escape(k).replace(/\*/g, '.*').replace(/\?/g, '.'));
+  if (parts.length === 0) return null;
+  return new RegExp(`(?<![\\p{L}\\p{N}_])(?:${parts.join('|')})(?![\\p{L}\\p{N}_])`, 'iu');
+}

Added file: web/src/lib/keywords.ts+35 additions@@ -0,0 +1,35 @@
+import { derived, writable } from 'svelte/store';
+import { runCommand } from './api';
+import { keywordPattern } from './keyword-pattern';
+
+export const notificationKeywords = writable<string[]>([]);
+
+export const keywordMatcher = derived(notificationKeywords, keywordPattern);
+
+function parse(raw: unknown): string[] {
+  if (typeof raw !== 'object' || raw === null) return [];
+  const list = (raw as Record<string, unknown>)['keywords'];
+  return Array.isArray(list) ? list.filter((k): k is string => typeof k === 'string') : [];
+}
+
+export async function loadKeywords(): Promise<void> {
+  try {
+    notificationKeywords.set(parse(await runCommand({ op: 'notification_keywords' })));
+  } catch {
+    notificationKeywords.set([]);
+  }
+}
+
+export async function addKeyword(keyword: string): Promise<void> {
+  await runCommand({ op: 'add_notification_keyword', keyword: keyword.trim() });
+  await loadKeywords();
+}
+
+export async function removeKeyword(keyword: string): Promise<void> {
+  await runCommand({ op: 'remove_notification_keyword', keyword });
+  await loadKeywords();
+}
+
+export function resetKeywords(): void {
+  notificationKeywords.set([]);
+}

Modified file: web/src/lib/mentions-model.ts+2 additions−2 deletions@@ -2,7 +2,7 @@ import { parseEventContext, parseTimelineItem } from './types';
 import type { EventContext, TimelineItem } from './types';
 
 export interface MentionKey { room_id: string; event_id: string }
-export type MentionReason = 'Direct' | 'Reply' | 'Room';
+export type MentionReason = 'Direct' | 'Reply' | 'Room' | 'Keyword';
 export type MentionCaptureState =
   | { kind: 'Pending' | 'Partial' | 'Ready' | 'Unavailable' }
   | { kind: 'Failed'; message: string; retry_at_ms: number };
@@ -41,7 +41,7 @@ function capture(v: unknown): MentionCaptureState | null {
 function entry(v: unknown): MentionEntry | null {
   if (!obj(v)) return null;
   const k = key(v.key), ev = parseTimelineItem(v.event), c = capture(v.capture);
-  if (!k || !ev || !c || !nat(v.timestamp_ms) || !nat(v.discovered_at_ms) || !nat(v.discovery_revision) || !nat(v.revision) || !Array.isArray(v.reasons) || !v.reasons.every(x => str(x) && ['Direct','Reply','Room'].includes(x)) || !bool(v.read) || !(v.room_name === null || str(v.room_name)) || !bool(v.notification_suppressed)) return null;
+  if (!k || !ev || !c || !nat(v.timestamp_ms) || !nat(v.discovered_at_ms) || !nat(v.discovery_revision) || !nat(v.revision) || !Array.isArray(v.reasons) || !v.reasons.every(x => str(x) && ['Direct','Reply','Room','Keyword'].includes(x)) || !bool(v.read) || !(v.room_name === null || str(v.room_name)) || !bool(v.notification_suppressed)) return null;
   return { key:k, timestamp_ms:v.timestamp_ms, discovered_at_ms:v.discovered_at_ms, discovery_revision:v.discovery_revision, revision:v.revision, event:ev, reasons:v.reasons as MentionReason[], read:v.read, capture:c, room_name:v.room_name, notification_suppressed:v.notification_suppressed };
 }
 function gap(v: unknown): MentionGap | null {

Modified file: web/src/lib/store.ts+6 additions@@ -5,6 +5,7 @@ import { getSession, subscribeEvents } from './api';
 import type { SoftLogout } from './api';
 import { isRecord } from './guards';
 import { observeArrivals } from './arrivals';
+import { loadKeywords, resetKeywords } from './keywords';
 import { resetLinkPreviews } from './link-previews';
 import { resetQuickReactions } from './quick-reactions';
 import { resetPackPreferences } from './pack-preferences';
@@ -97,6 +98,7 @@ export function resetClientState(): void {
   resetQuickReactions();
   resetPackPreferences();
   resetLinkPreviews();
+  resetKeywords();
   onlineSince = 0;
   liveSince = {};
 }
@@ -197,6 +199,10 @@ function handlePayload(text: string): void {
     if (typeof roomId === 'string' && state) recentHistory.update((all) => ({ ...all, [roomId]: state }));
     return;
   }
+  if (kind === 'notification_settings') {
+    void loadKeywords();
+    return;
+  }
   if (kind === 'image_packs') {
     imagePacks.set(parseImagePacks(data['packs']));
     return;

Modified file: web/src/lib/transport.ts+2

@@ -35,6 +35,8 @@ export type CommandRequest =

3535 | { op: 'set_room_display_name'; room_id: string; name: string | null }

3636 | { op: 'set_room_avatar'; room_id: string; mxc: string | null }

3737 | { op: 'mute'; room_id: string; user_id: string; muted: boolean }

38+ | { op: 'notification_keywords' }

39+ | { op: 'add_notification_keyword' | 'remove_notification_keyword'; keyword: string }

3840 | { op: 'ignore' | 'unignore'; user_id: string }

3941 | { op: 'power_levels'; room_id: string }

4042 | { op: 'open_pinned' | 'close_pinned'; room_id: string }

Modified file: web/src/lib/types.ts+3 additions−1 deletions@@ -609,6 +609,7 @@ export interface TimelineEvent {
   reactions: Reaction[];
   read_by: string[];
   editable: boolean;
+  highlight?: boolean;
   delivery_lag_ms?: number;
 }
 
@@ -644,7 +645,8 @@ function parseTimelineEvent(raw: Record<string, unknown>): TimelineEvent {
     thread_summary: parseThreadSummary(raw['thread_summary']),
     reactions: parseReactions(raw['reactions']),
     read_by: stringList(raw['read_by']),
-    editable: raw['editable'] === true
+    editable: raw['editable'] === true,
+    highlight: raw['highlight'] === true
   };
 }
 

Added file: web/test/keyword-pattern.test.ts+28 additions@@ -0,0 +1,28 @@
+import assert from 'node:assert/strict';
+import { test } from 'node:test';
+import { keywordPattern } from '../src/lib/keyword-pattern.ts';
+
+test('keywords match whole words without case', () => {
+  const pattern = keywordPattern(['bolt']);
+  assert.ok(pattern?.test('hey Bolt, look'));
+  assert.ok(pattern?.test('bolt'));
+  assert.equal(pattern?.test('thunderbolts'), false);
+  assert.equal(pattern?.test('bolt_two'), false);
+});
+
+test('keywords treat regex syntax literally and globs as wildcards', () => {
+  assert.ok(keywordPattern(['c++'])?.test('writing c++ today'));
+  assert.equal(keywordPattern(['a.b'])?.test('axb'), false);
+  assert.ok(keywordPattern(['deploy*'])?.test('deployment went out'));
+  assert.ok(keywordPattern(['gr?y'])?.test('grey skies'));
+});
+
+test('keywords outside latin script still respect word edges', () => {
+  const pattern = keywordPattern(['привет']);
+  assert.ok(pattern?.test('ну привет'));
+  assert.equal(pattern?.test('приветствую'), false);
+});
+
+test('an empty list matches nothing', () => {
+  assert.equal(keywordPattern([' ', '']), null);
+});

malice

Commit a4555a7eae2d

Commit `a4555a7eae2d`