Compare commits

..

4 Commits

Author SHA1 Message Date
GitHub Actions
3940441d9b chore: bump version to 4.11.135 [skip ci] 2026-07-24 04:47:38 +00:00
cfabcc5fbf Show decrypted notification bodies and authenticated sender avatars.
All checks were successful
Build / increment-version (push) Successful in 5s
Build / build-android (push) Successful in 5m8s
Wait for E2EE cleartext before building tray text, and post Android notifications natively so dynamic avatars fetched with secure media auth can appear as large icons.
2026-07-24 14:47:32 +10:00
GitHub Actions
a40319e8c8 chore: bump version to 4.11.134 [skip ci] 2026-07-24 04:36:18 +00:00
45bc475340 Group Android notifications by space and clear them on read.
All checks were successful
Build / increment-version (push) Successful in 5s
Build / build-android (push) Successful in 4m52s
Use stable per-room notification IDs with Directs/Spaces/Home channels and space group summaries so the shade nests deeper than a flat Messages list, and dismiss those tray entries when a room is marked read.
2026-07-24 14:36:11 +10:00
6 changed files with 988 additions and 124 deletions

View File

@@ -10,6 +10,7 @@ import android.content.Context
import android.content.Intent
import android.net.Uri
import android.os.Build
import android.util.Base64
import android.util.Log
import android.graphics.Bitmap
import android.graphics.BitmapFactory
@@ -172,7 +173,7 @@ class MatrixSyncService : Service() {
val token = prefs.getString(EXTRA_TOKEN, null) ?: return
val joinedRooms = sync.optJSONObject("rooms")?.optJSONObject("join") ?: return
val nm = getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
ensureMessageChannel(nm)
ensureMessageChannels(nm)
val notifyCtx = loadNotifyContext(homeserver, token, myUserId)
@@ -220,12 +221,21 @@ class MatrixSyncService : Service() {
val inlineImage: Bitmap? = if (
(msgtype == "m.image" || msgtype == "m.sticker") && !content.has("file")
) {
content.optString("url").takeIf { it.startsWith("mxc://") }
?.let { mxcToDownloadUrl(it, homeserver) }
?.let { downloadBitmap(it, token) }
content.optString("url").takeIf { it.startsWith("mxc://") }?.let { mxc ->
mxcToDownloadUrls(mxc, homeserver)
.firstNotNullOfOrNull { downloadBitmap(it, token) }
}
} else null
showMessageNotification(nm, profile.displayName, body, profile.avatar, inlineImage)
showMessageNotification(
nm,
roomId,
profile.displayName,
body,
profile.avatar,
inlineImage,
resolveGroupInfo(roomId, notifyCtx),
)
}
}
}
@@ -396,9 +406,7 @@ class MatrixSyncService : Service() {
conn.disconnect()
}
displayNameCache[mxid] = displayName
val avatar = avatarMxc
?.let { mxcToThumbnailUrl(it, homeserver, size = 96) }
?.let { downloadBitmap(it, token) }
val avatar = avatarMxc?.let { downloadAvatarBitmap(it, homeserver, token, size = 96) }
avatarCache[mxid] = avatar
UserProfile(displayName, avatar)
} catch (e: Exception) {
@@ -409,24 +417,47 @@ class MatrixSyncService : Service() {
}
}
private fun mxcToThumbnailUrl(mxcUrl: String, homeserver: String, size: Int): String? {
private fun mxcToThumbnailUrls(mxcUrl: String, homeserver: String, size: Int): List<String> {
val withoutScheme = mxcUrl.removePrefix("mxc://")
val slash = withoutScheme.indexOf('/')
if (slash < 0) return null
if (slash < 0) return emptyList()
val serverName = withoutScheme.substring(0, slash)
val mediaId = withoutScheme.substring(slash + 1)
return "$homeserver/_matrix/media/v3/thumbnail/$serverName/$mediaId?width=$size&height=$size&method=crop"
val query = "width=$size&height=$size&method=crop"
// Prefer MSC3916 authenticated media, fall back to legacy media repo.
return listOf(
"$homeserver/_matrix/client/v1/media/thumbnail/$serverName/$mediaId?$query",
"$homeserver/_matrix/media/v3/thumbnail/$serverName/$mediaId?$query",
)
}
private fun mxcToDownloadUrl(mxcUrl: String, homeserver: String): String? {
private fun mxcToDownloadUrls(mxcUrl: String, homeserver: String): List<String> {
val withoutScheme = mxcUrl.removePrefix("mxc://")
val slash = withoutScheme.indexOf('/')
if (slash < 0) return null
if (slash < 0) return emptyList()
val serverName = withoutScheme.substring(0, slash)
val mediaId = withoutScheme.substring(slash + 1)
return "$homeserver/_matrix/media/v3/download/$serverName/$mediaId"
return listOf(
"$homeserver/_matrix/client/v1/media/download/$serverName/$mediaId",
"$homeserver/_matrix/media/v3/download/$serverName/$mediaId",
)
}
private fun downloadAvatarBitmap(
mxcUrl: String,
homeserver: String,
token: String,
size: Int,
): Bitmap? {
for (url in mxcToThumbnailUrls(mxcUrl, homeserver, size)) {
downloadBitmap(url, token)?.let { return it }
}
return null
}
private fun mxcToDownloadUrl(mxcUrl: String, homeserver: String): String? =
mxcToDownloadUrls(mxcUrl, homeserver).firstOrNull()
private fun downloadBitmap(urlString: String, token: String): Bitmap? {
return try {
val conn = URL(urlString).openConnection() as HttpURLConnection
@@ -445,39 +476,83 @@ class MatrixSyncService : Service() {
}
}
private data class NotificationGroupInfo(
val groupId: String,
val groupName: String,
val roomName: String,
val kind: String,
)
private fun resolveGroupInfo(roomId: String, ctx: NotifyContext): NotificationGroupInfo {
val mapped = loadNotificationGroupMap()[roomId]
if (mapped != null) return mapped
return if (ctx.directRoomIds.contains(roomId)) {
NotificationGroupInfo(
groupId = GROUP_DIRECTS,
groupName = "Direct messages",
roomName = roomId,
kind = "direct",
)
} else {
NotificationGroupInfo(
groupId = GROUP_HOME,
groupName = "Home",
roomName = roomId,
kind = "home",
)
}
}
private fun loadNotificationGroupMap(): Map<String, NotificationGroupInfo> {
val prefs = applicationContext.getSharedPreferences(SyncServicePlugin.PREFS, Context.MODE_PRIVATE)
val raw = prefs.getString(KEY_NOTIFICATION_GROUPS, null) ?: return emptyMap()
return try {
val root = JSONObject(raw)
val out = mutableMapOf<String, NotificationGroupInfo>()
val keys = root.keys()
while (keys.hasNext()) {
val roomId = keys.next()
val obj = root.optJSONObject(roomId) ?: continue
out[roomId] = NotificationGroupInfo(
groupId = obj.optString("groupId").ifBlank { GROUP_HOME },
groupName = obj.optString("groupName").ifBlank { "Home" },
roomName = obj.optString("roomName").ifBlank { roomId },
kind = obj.optString("kind").ifBlank { "home" },
)
}
out
} catch (e: Exception) {
Log.w(TAG, "Failed to parse notification group map: ${e.message}")
emptyMap()
}
}
private fun channelIdForKind(kind: String): String = channelIdForKindStatic(kind)
private fun showMessageNotification(
nm: NotificationManager,
roomId: String,
sender: String,
body: String,
largeIcon: Bitmap? = null,
inlineImage: Bitmap? = null,
groupInfo: NotificationGroupInfo,
) {
val launchIntent = packageManager.getLaunchIntentForPackage(packageName)
?: Intent(this, MainActivity::class.java)
val pi = PendingIntent.getActivity(
this, 0, launchIntent,
PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
val isDm = groupInfo.kind == "direct"
val title = if (isDm) sender else groupInfo.roomName.ifBlank { sender }
val text = if (isDm) body else "$sender: $body"
postMessageNotification(
this,
roomId = roomId,
title = title,
body = text,
groupId = groupInfo.groupId,
groupName = groupInfo.groupName,
kind = groupInfo.kind,
largeIcon = largeIcon,
inlineImage = inlineImage,
)
val builder = NotificationCompat.Builder(this, CHANNEL_MESSAGES)
.setSmallIcon(R.drawable.ic_stat_paarrot)
.setContentTitle(sender)
.setContentText(body)
.setAutoCancel(true)
.setContentIntent(pi)
.setPriority(NotificationCompat.PRIORITY_HIGH)
if (largeIcon != null) builder.setLargeIcon(largeIcon)
if (inlineImage != null) {
builder.setStyle(
NotificationCompat.BigPictureStyle()
.bigPicture(inlineImage)
.bigLargeIcon(null as Bitmap?)
)
}
nm.notify(System.currentTimeMillis().toInt(), builder.build())
}
private fun buildStatusNotification(): Notification {
@@ -511,24 +586,8 @@ class MatrixSyncService : Service() {
}
}
private fun ensureMessageChannel(nm: NotificationManager) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
val soundUri = Uri.parse("android.resource://$packageName/${R.raw.paarrot_notification}")
val channel = NotificationChannel(
CHANNEL_MESSAGES, "Messages",
NotificationManager.IMPORTANCE_HIGH,
).apply {
description = "Matrix message notifications"
setSound(
soundUri,
AudioAttributes.Builder()
.setUsage(AudioAttributes.USAGE_NOTIFICATION)
.setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
.build(),
)
}
nm.createNotificationChannel(channel)
}
private fun ensureMessageChannels(nm: NotificationManager) {
ensureMessageChannels(this)
}
companion object {
@@ -537,16 +596,202 @@ class MatrixSyncService : Service() {
const val EXTRA_TOKEN = "access_token"
const val EXTRA_USER_ID = "user_id"
const val EXTRA_DEVICE_ID = "device_id"
const val EXTRA_ROOM_ID = "room_id"
const val EXTRA_GROUP_ID = "group_id"
const val EXTRA_TRIGGER_REASON = "trigger_reason"
const val KEY_NOTIFICATION_GROUPS = "notification_groups"
const val PREFS = "matrix_sync_prefs"
const val KEY_SINCE = "since_token"
private const val KEY_LAST_WAKE_MS = "last_wake_ms"
private const val NOTIF_ID_STATUS = 1001
private const val CHANNEL_STATUS = "sync_status"
private const val CHANNEL_MESSAGES = "messages_paarrot"
private const val CHANNEL_DIRECTS = "messages_directs"
private const val CHANNEL_SPACES = "messages_spaces"
private const val CHANNEL_HOME = "messages_home"
private const val GROUP_DIRECTS = "paarrot_directs"
private const val GROUP_HOME = "paarrot_home"
private const val MIN_WAKE_INTERVAL_MS = 7_500L
const val MODE_ONE_SHOT = "one_shot"
/** Same hashing scheme as JS `notificationIdForRoom` so clear-on-read hits both paths. */
fun notificationIdForRoom(roomId: String): Int {
var hash = 0
for (ch in roomId) {
hash = (hash shl 5) - hash + ch.code
}
// Match JS Math.abs(...); avoid Int.MIN_VALUE abs edge case.
val positive = if (hash == Int.MIN_VALUE) 0 else kotlin.math.abs(hash)
var id = positive % 2147483647
if (id == 0 || id == NOTIF_ID_STATUS) {
id = NOTIF_ID_STATUS + 1
}
return id
}
fun notificationIdForGroupSummary(groupId: String): Int =
notificationIdForRoom("summary:$groupId")
private fun channelIdForKindStatic(kind: String): String = when (kind) {
"direct" -> CHANNEL_DIRECTS
"space" -> CHANNEL_SPACES
else -> CHANNEL_HOME
}
fun ensureMessageChannels(context: Context) {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) return
val nm = context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
val soundUri = Uri.parse("android.resource://${context.packageName}/${R.raw.paarrot_notification}")
val soundAttrs = AudioAttributes.Builder()
.setUsage(AudioAttributes.USAGE_NOTIFICATION)
.setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
.build()
val channels = listOf(
Triple(CHANNEL_DIRECTS, "Direct messages", "One-to-one Matrix conversations"),
Triple(CHANNEL_SPACES, "Spaces", "Messages from rooms inside Spaces"),
Triple(CHANNEL_HOME, "Other rooms", "Rooms that are not in a Space"),
Triple(CHANNEL_MESSAGES, "Messages", "Legacy message channel"),
)
for ((id, name, description) in channels) {
val channel = NotificationChannel(id, name, NotificationManager.IMPORTANCE_HIGH).apply {
this.description = description
setSound(soundUri, soundAttrs)
}
nm.createNotificationChannel(channel)
}
}
fun decodeBase64Bitmap(base64: String?): Bitmap? {
if (base64.isNullOrBlank()) return null
return try {
val raw = if (base64.contains(',')) base64.substringAfter(',') else base64
val bytes = Base64.decode(raw, Base64.DEFAULT)
BitmapFactory.decodeByteArray(bytes, 0, bytes.size)
} catch (e: Exception) {
Log.w(TAG, "Failed to decode notification icon: ${e.message}")
null
}
}
/**
* Posts a room notification (+ space/DM group summary) for both background sync
* and JS-driven Capacitor notifications (with optional avatar bitmap).
*/
fun postMessageNotification(
context: Context,
roomId: String,
title: String,
body: String,
groupId: String,
groupName: String,
kind: String,
largeIcon: Bitmap? = null,
inlineImage: Bitmap? = null,
) {
val nm = context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
ensureMessageChannels(context)
val launchIntent = context.packageManager.getLaunchIntentForPackage(context.packageName)
?: Intent(context, MainActivity::class.java)
val roomNotifId = notificationIdForRoom(roomId)
val pi = PendingIntent.getActivity(
context, roomNotifId, launchIntent,
PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
)
val channelId = channelIdForKindStatic(kind)
val builder = NotificationCompat.Builder(context, channelId)
.setSmallIcon(R.drawable.ic_stat_paarrot)
.setContentTitle(title)
.setContentText(body)
.setAutoCancel(true)
.setContentIntent(pi)
.setPriority(NotificationCompat.PRIORITY_HIGH)
.setCategory(NotificationCompat.CATEGORY_MESSAGE)
.setGroup(groupId)
.setOnlyAlertOnce(true)
.setSubText(groupName)
builder.extras.putString(EXTRA_ROOM_ID, roomId)
builder.extras.putString(EXTRA_GROUP_ID, groupId)
if (largeIcon != null) builder.setLargeIcon(largeIcon)
if (inlineImage != null) {
builder.setStyle(
NotificationCompat.BigPictureStyle()
.bigPicture(inlineImage)
.bigLargeIcon(null as Bitmap?)
)
} else {
builder.setStyle(
NotificationCompat.BigTextStyle()
.bigText(body)
.setSummaryText(groupName)
)
}
nm.notify(roomNotifId, builder.build())
val summaryId = notificationIdForGroupSummary(groupId)
val summary = NotificationCompat.Builder(context, channelId)
.setSmallIcon(R.drawable.ic_stat_paarrot)
.setContentTitle(groupName)
.setContentText("New messages")
.setAutoCancel(true)
.setContentIntent(pi)
.setPriority(NotificationCompat.PRIORITY_HIGH)
.setCategory(NotificationCompat.CATEGORY_MESSAGE)
.setGroup(groupId)
.setGroupSummary(true)
.setStyle(
NotificationCompat.InboxStyle()
.setBigContentTitle(groupName)
.setSummaryText(groupName)
)
summary.extras.putString(EXTRA_GROUP_ID, groupId)
nm.notify(summaryId, summary.build())
}
/** Cancel the tray notification posted for [roomId], if any. */
fun clearRoomNotifications(context: Context, roomId: String) {
if (roomId.isBlank()) return
val nm = context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
val roomNotifId = notificationIdForRoom(roomId)
var groupId: String? = null
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
groupId = nm.activeNotifications
.firstOrNull { it.id == roomNotifId }
?.notification?.extras?.getString(EXTRA_GROUP_ID)
}
nm.cancel(roomNotifId)
// Also drop any legacy stacked notifications that still carry this room id.
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
for (active in nm.activeNotifications) {
val tagged = active.notification.extras.getString(EXTRA_ROOM_ID)
if (tagged == roomId && active.id != roomNotifId) {
nm.cancel(active.id)
}
}
if (!groupId.isNullOrBlank()) {
val summaryId = notificationIdForGroupSummary(groupId)
val siblingsRemain = nm.activeNotifications.any { active ->
active.id != summaryId &&
active.notification.extras.getString(EXTRA_GROUP_ID) == groupId
}
if (!siblingsRemain) {
nm.cancel(summaryId)
}
}
}
}
/** Set by [SyncServicePlugin] — true when the Capacitor WebView UI is visible. */
@Volatile
var appInForeground = false

View File

@@ -17,6 +17,9 @@ import com.getcapacitor.annotation.CapacitorPlugin
* - `stop()` — clear persisted credentials and unregister UnifiedPush
* - `setAppForeground({ foreground })` — tell the service whether the app UI is visible
* - `getStatus()` — returns current fetch and UnifiedPush state
* - `clearRoomNotifications({ roomId })` — dismiss native tray notifs for a room
* - `setNotificationGroups({ rooms })` — persist space/DM grouping for tray nesting
* - `showNotification({ title, body, roomId, groupId, groupName, kind, largeIconBase64 })`
*/
@CapacitorPlugin(name = "MatrixBackgroundSync")
class SyncServicePlugin : Plugin() {
@@ -97,6 +100,59 @@ class SyncServicePlugin : Plugin() {
call.resolve(result)
}
/**
* Cancels native tray notifications for a Matrix room after it has been marked as read.
*/
@PluginMethod
fun clearRoomNotifications(call: PluginCall) {
val roomId = call.getString("roomId")
?: return call.reject("roomId required")
MatrixSyncService.clearRoomNotifications(context, roomId)
call.resolve(JSObject().put("cleared", true))
}
/**
* Persists room → space/group metadata from the JS layer so background
* notifications can nest under Direct messages / Space name / Home.
*/
@PluginMethod
fun setNotificationGroups(call: PluginCall) {
val rooms = call.getObject("rooms")
?: return call.reject("rooms required")
context.getSharedPreferences(PREFS, Context.MODE_PRIVATE).edit()
.putString(MatrixSyncService.KEY_NOTIFICATION_GROUPS, rooms.toString())
.apply()
call.resolve(JSObject().put("success", true))
}
/**
* Shows a message notification from the JS layer (supports dynamic avatar icons).
* Capacitor LocalNotifications cannot load authenticated/dynamic large icons, so
* we post through the same native NotificationManager path as background sync.
*/
@PluginMethod
fun showNotification(call: PluginCall) {
val title = call.getString("title") ?: return call.reject("title required")
val body = call.getString("body") ?: return call.reject("body required")
val roomId = call.getString("roomId") ?: return call.reject("roomId required")
val groupId = call.getString("groupId") ?: "paarrot_home"
val groupName = call.getString("groupName") ?: "Home"
val kind = call.getString("kind") ?: "home"
val largeIconBase64 = call.getString("largeIconBase64")
MatrixSyncService.postMessageNotification(
context = context,
roomId = roomId,
title = title,
body = body,
groupId = groupId,
groupName = groupName,
kind = kind,
largeIcon = MatrixSyncService.decodeBase64Bitmap(largeIconBase64),
)
call.resolve(JSObject().put("shown", true))
}
companion object {
const val PREFS = "sync_service_prefs"
}

View File

@@ -1,7 +1,7 @@
import { useAtomValue, useStore } from 'jotai';
import React, { ReactNode, useCallback, useEffect, useRef, useState, Fragment } from 'react';
import { useNavigate } from 'react-router-dom';
import { RoomEvent, RoomEventHandlerMap } from 'matrix-js-sdk';
import { RoomEvent, RoomEventHandlerMap, MatrixClient, MatrixEvent, MatrixEventEvent } from 'matrix-js-sdk';
import { roomToUnreadAtom, unreadEqual, unreadInfoToUnread } from '../../state/room/roomToUnread';
import LogoSVG from '../../../../public/res/svg/paarrot.svg';
import LogoUnreadSVG from '../../../../public/res/svg/paarrot-unread.svg';
@@ -15,6 +15,7 @@ import { useMatrixClient } from '../../hooks/useMatrixClient';
import { getDirectRoomPath, getHomeRoomPath, getSpaceRoomPath, getInboxInvitesPath } from '../pathUtils';
import {
getMemberDisplayName,
getMemberAvatarMxc,
getNotificationType,
getUnreadInfo,
isNotificationEvent,
@@ -22,7 +23,13 @@ import {
guessPerfectParent,
} from '../../utils/room';
import { NotificationType, UnreadInfo } from '../../../types/matrix/room';
import { getMxIdLocalPart, mxcUrlToHttp, getCanonicalAliasOrRoomId, encryptFile } from '../../utils/matrix';
import {
getMxIdLocalPart,
mxcUrlToHttp,
getCanonicalAliasOrRoomId,
encryptFile,
downloadMedia,
} from '../../utils/matrix';
import { mDirectAtom } from '../../state/mDirectList';
import { roomToParentsAtom } from '../../state/room/roomToParents';
import { useSelectedRoom } from '../../hooks/router/useSelectedRoom';
@@ -35,12 +42,17 @@ import {
isCapacitorNative,
sendNotification,
setupNotificationTapListener,
clearNotificationsForRoom,
NOTIF_GROUP_DIRECTS,
NOTIF_GROUP_HOME,
type NotificationGroupInfo,
} from '../../utils/tauri';
import { setPaarrotNavigate, initPaarrotAPI } from '../../paarrot-api';
import {
startBackgroundSync,
stopBackgroundSync,
setAppForegroundState,
syncNotificationGroupMap,
} from '../../utils/backgroundSync';
import {
TUploadItem,
@@ -57,6 +69,92 @@ import {
materializeSharedFile,
} from '../../utils/androidShare';
/** Wait briefly for an encrypted event to decrypt before reading its body. */
async function waitForEventDecryption(mx: MatrixClient, mEvent: MatrixEvent) {
if (!mEvent.isEncrypted() || mEvent.getClearContent() || mEvent.isDecryptionFailure()) {
return;
}
const crypto = mx.getCrypto();
if (crypto) {
try {
await mEvent.attemptDecryption(crypto as any, { isRetry: true });
} catch {
// Decryption may complete asynchronously via the Decrypted listener below.
}
}
if (mEvent.getClearContent() || mEvent.isDecryptionFailure()) return;
await new Promise<void>((resolve) => {
const timeout = window.setTimeout(() => {
mEvent.removeListener(MatrixEventEvent.Decrypted, onDecrypted);
resolve();
}, 2000);
const onDecrypted = () => {
window.clearTimeout(timeout);
mEvent.removeListener(MatrixEventEvent.Decrypted, onDecrypted);
resolve();
};
mEvent.once(MatrixEventEvent.Decrypted, onDecrypted);
});
}
/** Build a human-readable notification body from (possibly decrypted) event content. */
function notificationBodyFromEvent(mEvent: MatrixEvent): string | undefined {
const content = mEvent.getClearContent() ?? mEvent.getContent();
const eventType = mEvent.getType();
if (eventType === 'm.reaction') {
const reactionKey = content['m.relates_to']?.key;
return reactionKey ? `reacted with ${reactionKey}` : 'reacted to a message';
}
if (eventType === 'm.room.encrypted' || mEvent.isDecryptionFailure()) {
return 'Encrypted message';
}
const rawBody = typeof content.body === 'string' ? content.body : undefined;
switch (content.msgtype) {
case 'm.image':
return rawBody ? `📷 ${rawBody}` : '📷 Photo';
case 'm.video':
return rawBody ? `🎥 ${rawBody}` : '🎥 Video';
case 'm.audio':
return rawBody ? `🎵 ${rawBody}` : '🎵 Audio';
case 'm.file':
return rawBody ? `📎 ${rawBody}` : '📎 File';
case 'm.sticker':
return rawBody ? `🖼️ ${rawBody}` : '🖼️ Sticker';
default:
return rawBody;
}
}
/** Download an authenticated media URL to a base64 string for native notification icons. */
async function mediaUrlToBase64(
url: string,
accessToken: string | null | undefined
): Promise<string | undefined> {
try {
const blob = await downloadMedia(url, accessToken);
const buffer = await blob.arrayBuffer();
const bytes = new Uint8Array(buffer);
let binary = '';
const chunk = 0x8000;
for (let i = 0; i < bytes.length; i += chunk) {
binary += String.fromCharCode(...bytes.subarray(i, i + chunk));
}
const mime = blob.type || 'image/jpeg';
return `data:${mime};base64,${btoa(binary)}`;
} catch (err) {
console.warn('[Notifications] Failed to fetch avatar for notification icon:', err);
return undefined;
}
}
/**
* Applies the selected emoji style font to the document.
* - System: Uses the native OS emoji font
@@ -226,10 +324,25 @@ function MessageNotifications() {
});
}, [navigate]);
const roomToUnread = useAtomValue(roomToUnreadAtom);
const previousUnreadRoomsRef = useRef<Set<string>>(new Set());
// Dismiss OS notifications when a room's unread is cleared (local read or receipt).
useEffect(() => {
const currentRooms = new Set(roomToUnread.keys());
for (const roomId of previousUnreadRoomsRef.current) {
if (!currentRooms.has(roomId)) {
void clearNotificationsForRoom(roomId);
}
}
previousUnreadRoomsRef.current = currentRooms;
}, [roomToUnread]);
const notify = useCallback(
({
roomName,
roomAvatar,
iconBase64,
username,
messageBody,
roomId,
@@ -238,14 +351,49 @@ function MessageNotifications() {
}: {
roomName: string;
roomAvatar?: string;
iconBase64?: string;
username: string;
messageBody?: string;
roomId: string;
eventId: string;
isDm: boolean;
}) => {
const notificationTitle = username;
const notificationBody = messageBody || 'New message';
let group: NotificationGroupInfo;
if (isDm) {
group = {
groupId: NOTIF_GROUP_DIRECTS,
groupName: 'Direct messages',
kind: 'direct',
roomName,
};
} else {
const orphanParents = getOrphanParents(roomToParents, roomId);
if (orphanParents.length > 0 && mx) {
const parentSpace = guessPerfectParent(mx, roomId, orphanParents) ?? orphanParents[0];
const spaceRoom = mx.getRoom(parentSpace);
group = {
groupId: parentSpace,
groupName: spaceRoom?.name || 'Space',
kind: 'space',
roomName,
};
} else {
group = {
groupId: NOTIF_GROUP_HOME,
groupName: 'Home',
kind: 'home',
roomName,
};
}
}
// DMs: sender as title. Rooms: room name as title, sender in body.
const notificationTitle = isDm ? username : roomName || username;
const notificationBody = isDm
? messageBody || 'New message'
: messageBody
? `${username}: ${messageBody}`
: `${username} sent a message`;
/** Replicates TitleBar click navigation logic */
const navigateToRoom = () => {
@@ -291,6 +439,10 @@ function MessageNotifications() {
title: notificationTitle,
body: notificationBody,
path: roomPath,
roomId,
group,
icon: roomAvatar,
iconBase64,
onClick: () => {
if (!window.closed) navigate(roomPath);
},
@@ -388,34 +540,35 @@ function MessageNotifications() {
showNotifications &&
((isTauri() && !isElectron()) || isCapacitorNative() || notificationPermission('granted'))
) {
const avatarMxc =
room.getAvatarFallbackMember()?.getMxcAvatarUrl() ?? room.getMxcAvatarUrl();
const content = mEvent.getContent();
let messageBody: string | undefined;
if (mEvent.getType() === 'm.reaction') {
// For reactions, show "reacted with {emoji}"
const reactionKey = content['m.relates_to']?.key;
if (reactionKey) {
messageBody = `reacted with ${reactionKey}`;
} else {
messageBody = 'reacted to a message';
}
} else {
messageBody = typeof content.body === 'string' ? content.body : undefined;
}
notify({
roomName: room.name ?? 'Unknown',
roomAvatar: avatarMxc
void (async () => {
await waitForEventDecryption(mx, mEvent);
const avatarMxc =
getMemberAvatarMxc(room, sender) ??
room.getAvatarFallbackMember()?.getMxcAvatarUrl() ??
room.getMxcAvatarUrl();
const roomAvatar = avatarMxc
? mxcUrlToHttp(mx, avatarMxc, useAuthentication, 96, 96, 'crop') ?? undefined
: undefined,
username: getMemberDisplayName(room, sender) ?? getMxIdLocalPart(sender) ?? sender,
messageBody,
roomId: room.roomId,
eventId,
isDm,
});
: undefined;
let iconBase64: string | undefined;
if (roomAvatar && isCapacitorNative()) {
iconBase64 = await mediaUrlToBase64(roomAvatar, mx.getAccessToken());
}
const messageBody = notificationBodyFromEvent(mEvent);
notify({
roomName: room.name ?? 'Unknown',
roomAvatar,
iconBase64,
username: getMemberDisplayName(room, sender) ?? getMxIdLocalPart(sender) ?? sender,
messageBody,
roomId: room.roomId,
eventId,
isDm,
});
})();
}
if (notificationSound) {
@@ -449,6 +602,9 @@ function MessageNotifications() {
*/
function BackgroundSyncSetup() {
const mx = useMatrixClient();
const mDirects = useAtomValue(mDirectAtom);
const roomToParents = useAtomValue(roomToParentsAtom);
// Try to make a simple fetch to verify component is rendering
try {
fetch('/_matrix/client/v3/sync', { method: 'HEAD' }).catch(() => {});
@@ -468,6 +624,49 @@ function BackgroundSyncSetup() {
};
}, [mx]);
// Keep native background notifier informed of space → room grouping.
useEffect(() => {
const rooms: Record<
string,
{ groupId: string; groupName: string; roomName: string; kind: 'direct' | 'space' | 'home' }
> = {};
for (const room of mx.getRooms()) {
if (room.isSpaceRoom()) continue;
const roomId = room.roomId;
const roomName = room.name || roomId;
if (mDirects.has(roomId)) {
rooms[roomId] = {
groupId: NOTIF_GROUP_DIRECTS,
groupName: 'Direct messages',
roomName,
kind: 'direct',
};
continue;
}
const orphanParents = getOrphanParents(roomToParents, roomId);
if (orphanParents.length > 0) {
const parentSpace = guessPerfectParent(mx, roomId, orphanParents) ?? orphanParents[0];
const spaceRoom = mx.getRoom(parentSpace);
rooms[roomId] = {
groupId: parentSpace,
groupName: spaceRoom?.name || 'Space',
roomName,
kind: 'space',
};
} else {
rooms[roomId] = {
groupId: NOTIF_GROUP_HOME,
groupName: 'Home',
roomName,
kind: 'home',
};
}
}
void syncNotificationGroupMap(rooms);
}, [mx, mDirects, roomToParents]);
return null;
}

View File

@@ -10,6 +10,10 @@ type UnifiedPushStatus = {
distributors: string[] | string;
};
type ClearRoomNotificationsResult = {
cleared: boolean;
};
type UnifiedPushEndpointEvent = {
endpoint: string;
previousEndpoint: string;
@@ -48,6 +52,28 @@ interface MatrixBackgroundSyncPlugin {
setAppForeground(options: { foreground: boolean }): Promise<void>;
/** Returns fetch state and current UnifiedPush registration details. */
getStatus(): Promise<UnifiedPushStatus>;
/** Cancel native tray notifications posted for a Matrix room. */
clearRoomNotifications(options: { roomId: string }): Promise<ClearRoomNotificationsResult>;
/**
* Persist room → space/group metadata so background notifications can nest
* under Direct messages / Space name / Home.
*/
setNotificationGroups(options: {
rooms: Record<
string,
{ groupId: string; groupName: string; roomName: string; kind: string }
>;
}): Promise<{ success: boolean }>;
/** Post a message notification with optional avatar (base64) from the JS layer. */
showNotification(options: {
title: string;
body: string;
roomId: string;
groupId: string;
groupName: string;
kind: string;
largeIconBase64?: string;
}): Promise<{ shown: boolean }>;
addListener(
eventName: 'unifiedPushNewEndpoint',
listenerFunc: (event: UnifiedPushEndpointEvent) => void
@@ -516,3 +542,59 @@ export const getBackgroundSyncStatus = async (): Promise<UnifiedPushStatus | und
return undefined;
}
};
/**
* Clears native (MatrixSyncService) tray notifications for a room after it is read.
* No-op when background sync / native Android is unavailable.
*/
export const clearNativeRoomNotifications = async (roomId: string): Promise<void> => {
if (!isBackgroundSyncSupported() || !roomId) return;
try {
await MatrixBackgroundSync.clearRoomNotifications({ roomId });
} catch (err) {
console.warn('[BackgroundSync] clearRoomNotifications failed:', err);
}
};
/**
* Syncs space/DM grouping metadata to the native layer for background notifications.
*/
export const syncNotificationGroupMap = async (
rooms: Record<
string,
{ groupId: string; groupName: string; roomName: string; kind: string }
>
): Promise<void> => {
if (!isBackgroundSyncSupported()) return;
try {
await MatrixBackgroundSync.setNotificationGroups({ rooms });
} catch (err) {
console.warn('[BackgroundSync] setNotificationGroups failed:', err);
}
};
/**
* Posts a native tray notification (supports dynamic/authenticated avatar icons).
* Prefer this over Capacitor LocalNotifications on Android.
*/
export const showNativeNotification = async (options: {
title: string;
body: string;
roomId: string;
groupId: string;
groupName: string;
kind: string;
largeIconBase64?: string;
}): Promise<boolean> => {
if (!isBackgroundSyncSupported()) return false;
try {
await MatrixBackgroundSync.showNotification(options);
return true;
} catch (err) {
console.warn('[BackgroundSync] showNotification failed:', err);
return false;
}
};

View File

@@ -351,24 +351,7 @@ const ensureNotificationChannel = async (): Promise<void> => {
};
const ensureCapacitorNotificationChannel = async (): Promise<void> => {
if (notificationChannelCreated || !isAndroid()) return;
try {
const { LocalNotifications } = await import('@capacitor/local-notifications');
await LocalNotifications.createChannel({
id: 'messages',
name: 'Messages',
description: 'Message notifications from Matrix',
importance: 5,
sound: 'default',
visibility: 1,
vibration: true,
lights: true,
});
notificationChannelCreated = true;
} catch (err) {
console.warn('Failed to create Capacitor notification channel:', err);
}
await ensureCapacitorNotificationChannels();
};
/**
@@ -422,6 +405,225 @@ export const getSystemNotificationPermissionState = async (): Promise<Permission
return 'denied';
};
/** Foreground sync status notification — must not collide with room message IDs. */
const ANDROID_STATUS_NOTIFICATION_ID = 1001;
/** Android notification group keys for rooms outside a space. */
export const NOTIF_GROUP_DIRECTS = 'paarrot_directs';
export const NOTIF_GROUP_HOME = 'paarrot_home';
/** Capacitor / native channel ids (under the Paarrot app). */
export const NOTIF_CHANNEL_DIRECTS = 'messages_directs';
export const NOTIF_CHANNEL_SPACES = 'messages_spaces';
export const NOTIF_CHANNEL_HOME = 'messages_home';
/** Legacy channel — kept so older installs still receive. */
export const NOTIF_CHANNEL_MESSAGES_LEGACY = 'messages';
export type NotificationGroupKind = 'direct' | 'space' | 'home';
export type NotificationGroupInfo = {
groupId: string;
groupName: string;
kind: NotificationGroupKind;
roomName?: string;
};
/**
* Stable Android notification id for a Matrix room.
* Re-using the same id replaces the previous tray entry instead of stacking.
*/
export const notificationIdForRoom = (roomId: string): number => {
let hash = 0;
for (let i = 0; i < roomId.length; i += 1) {
hash = (hash << 5) - hash + roomId.charCodeAt(i);
hash |= 0;
}
let id = Math.abs(hash) % 2147483647;
if (id === 0 || id === ANDROID_STATUS_NOTIFICATION_ID) {
id = ANDROID_STATUS_NOTIFICATION_ID + 1;
}
return id;
};
/** Stable id for a space/group summary notification. */
export const notificationIdForGroupSummary = (groupId: string): number =>
notificationIdForRoom(`summary:${groupId}`);
const channelIdForKind = (kind: NotificationGroupKind): string => {
switch (kind) {
case 'direct':
return NOTIF_CHANNEL_DIRECTS;
case 'space':
return NOTIF_CHANNEL_SPACES;
default:
return NOTIF_CHANNEL_HOME;
}
};
const ensureCapacitorNotificationChannels = async (): Promise<void> => {
if (!isAndroid()) return;
try {
const { LocalNotifications } = await import('@capacitor/local-notifications');
const channels: Array<{
id: string;
name: string;
description: string;
}> = [
{
id: NOTIF_CHANNEL_DIRECTS,
name: 'Direct messages',
description: 'One-to-one Matrix conversations',
},
{
id: NOTIF_CHANNEL_SPACES,
name: 'Spaces',
description: 'Messages from rooms inside Spaces',
},
{
id: NOTIF_CHANNEL_HOME,
name: 'Other rooms',
description: 'Rooms that are not in a Space',
},
{
id: NOTIF_CHANNEL_MESSAGES_LEGACY,
name: 'Messages',
description: 'Legacy message channel',
},
];
await Promise.all(
channels.map((channel) =>
LocalNotifications.createChannel({
id: channel.id,
name: channel.name,
description: channel.description,
importance: 5,
sound: 'default',
visibility: 1,
vibration: true,
lights: true,
})
)
);
notificationChannelCreated = true;
} catch (err) {
console.warn('Failed to create Capacitor notification channels:', err);
}
};
const notificationBelongsToRoom = (
notification: { id?: number; extra?: Record<string, unknown> },
roomId: string
): boolean => {
if (notification.id === notificationIdForRoom(roomId)) return true;
const extra = notification.extra;
if (!extra || typeof extra !== 'object') return false;
if (extra.roomId === roomId) return true;
const path = extra.path;
if (typeof path === 'string') {
return path.includes(encodeURIComponent(roomId)) || path.includes(roomId);
}
return false;
};
const clearCapacitorGroupSummaryIfEmpty = async (
LocalNotifications: {
getDeliveredNotifications: () => Promise<{ notifications: Array<{ id?: number; extra?: Record<string, unknown>; group?: string }> }>;
cancel: (opts: { notifications: Array<{ id: number }> }) => Promise<void>;
removeDeliveredNotifications: (opts: { notifications: unknown[] }) => Promise<void>;
},
groupId: string
): Promise<void> => {
const summaryId = notificationIdForGroupSummary(groupId);
const delivered = await LocalNotifications.getDeliveredNotifications().catch(() => null);
if (!delivered?.notifications) return;
const siblings = delivered.notifications.filter((n) => {
if (n.id === summaryId) return false;
if (n.group === groupId) return true;
return n.extra?.groupId === groupId;
});
if (siblings.length > 0) return;
await LocalNotifications.cancel({ notifications: [{ id: summaryId }] }).catch(() => undefined);
const summary = delivered.notifications.find((n) => n.id === summaryId);
if (summary) {
await LocalNotifications.removeDeliveredNotifications({
notifications: [summary],
}).catch(() => undefined);
}
};
/**
* Dismiss system notifications tied to a room (after mark-as-read / receipt).
* Clears Capacitor LocalNotifications and native MatrixSyncService tray entries.
* Also drops the space/group summary when no child notifications remain.
*/
export const clearNotificationsForRoom = async (roomId: string): Promise<void> => {
if (!roomId) return;
if (isCapacitorNative()) {
try {
const { LocalNotifications } = await import('@capacitor/local-notifications');
const id = notificationIdForRoom(roomId);
const deliveredBefore = await LocalNotifications.getDeliveredNotifications().catch(() => null);
const roomNotif = deliveredBefore?.notifications?.find((n: { id?: number; extra?: Record<string, unknown> }) =>
notificationBelongsToRoom(n, roomId)
);
const groupId =
(typeof roomNotif?.extra?.groupId === 'string' && roomNotif.extra.groupId) ||
(typeof (roomNotif as { group?: string } | undefined)?.group === 'string'
? (roomNotif as { group?: string }).group
: undefined);
await LocalNotifications.cancel({ notifications: [{ id }] }).catch(() => undefined);
if (deliveredBefore?.notifications?.length) {
const matching = deliveredBefore.notifications.filter((n: { id?: number; extra?: Record<string, unknown> }) =>
notificationBelongsToRoom(n, roomId)
);
if (matching.length > 0) {
await LocalNotifications.removeDeliveredNotifications({
notifications: matching,
}).catch(() => undefined);
}
}
if (groupId) {
await clearCapacitorGroupSummaryIfEmpty(LocalNotifications, groupId);
}
} catch (err) {
console.warn('Failed to clear Capacitor notifications for room:', err);
}
try {
const { clearNativeRoomNotifications } = await import('./backgroundSync');
await clearNativeRoomNotifications(roomId);
} catch (err) {
console.warn('Failed to clear native room notifications:', err);
}
return;
}
if (isTauri() && !isElectron()) {
try {
const { cancel, removeActive } = await import('@tauri-apps/plugin-notification');
const id = notificationIdForRoom(roomId);
if (typeof cancel === 'function') {
await cancel([id]).catch(() => undefined);
}
if (typeof removeActive === 'function') {
await removeActive([{ id }]).catch(() => undefined);
}
} catch (err) {
console.warn('Failed to clear Tauri notifications for room:', err);
}
}
};
/**
* Send a notification using Tauri's notification plugin
* Falls back to browser Notification API if not in Tauri
@@ -430,10 +632,22 @@ export const sendNotification = async (options: {
title: string;
body: string;
icon?: string;
iconBase64?: string;
path?: string;
roomId?: string;
group?: NotificationGroupInfo;
onClick?: () => void;
}): Promise<void> => {
const { title, body, icon, path, onClick } = options;
const { title, body, icon, iconBase64, path, roomId, group, onClick } = options;
const extra = {
...(path ? { path } : {}),
...(roomId ? { roomId } : {}),
...(group?.groupId ? { groupId: group.groupId, groupName: group.groupName, groupKind: group.kind } : {}),
};
const hasExtra = Object.keys(extra).length > 0;
const channelId = group ? channelIdForKind(group.kind) : NOTIF_CHANNEL_HOME;
const groupId = group?.groupId;
const groupName = group?.groupName;
// Use Electron's native notification API if in Electron
if (isElectron()) {
@@ -475,11 +689,27 @@ export const sendNotification = async (options: {
await tauriSendNotification({
title,
body,
// Stable per-room id replaces prior tray entry instead of stacking
id: roomId ? notificationIdForRoom(roomId) : undefined,
// Use the channel on Android
channelId: isAndroid() ? 'messages' : undefined,
// Store path in extra data for notification tap handling
extra: path ? { path } : undefined,
channelId: isAndroid() ? channelId : undefined,
group: groupId,
icon,
// Store path/roomId in extra data for tap handling + clear-on-read
extra: hasExtra ? extra : undefined,
});
if (isAndroid() && groupId && groupName) {
await tauriSendNotification({
title: groupName,
body: 'New messages',
id: notificationIdForGroupSummary(groupId),
channelId,
group: groupId,
groupSummary: true,
extra: { groupId, groupName, isGroupSummary: true },
}).catch(() => undefined);
}
}
return;
} catch (err) {
@@ -488,6 +718,26 @@ export const sendNotification = async (options: {
}
if (isCapacitorNative()) {
// Prefer native NotificationManager so we can set dynamic/authenticated avatars.
// Capacitor LocalNotifications only supports drawable resource largeIcon names.
if (roomId && groupId && groupName && group) {
try {
const { showNativeNotification } = await import('./backgroundSync');
const shown = await showNativeNotification({
title,
body,
roomId,
groupId,
groupName,
kind: group.kind,
largeIconBase64: iconBase64,
});
if (shown) return;
} catch (err) {
console.warn('Native showNotification failed, falling back to LocalNotifications:', err);
}
}
try {
const { LocalNotifications } = await import('@capacitor/local-notifications');
let perm = await LocalNotifications.checkPermissions();
@@ -496,21 +746,53 @@ export const sendNotification = async (options: {
}
if (perm.display === 'granted') {
await ensureCapacitorNotificationChannel();
await ensureCapacitorNotificationChannels();
// One notification per room: same id updates the existing tray entry.
const id = roomId
? notificationIdForRoom(roomId)
: Math.floor(Date.now() % 2147483647);
const roomNotification: Record<string, unknown> = {
id,
title,
body,
channelId: isAndroid() ? channelId : undefined,
smallIcon: isAndroid() ? ANDROID_NOTIFICATION_SMALL_ICON : undefined,
iconColor: isAndroid() ? ANDROID_NOTIFICATION_ICON_COLOR : undefined,
extra: hasExtra ? extra : undefined,
threadIdentifier: groupId,
};
if (isAndroid() && groupId) {
roomNotification.group = groupId;
if (groupName) {
roomNotification.summaryText = groupName;
}
if (group?.roomName && group.roomName !== title) {
roomNotification.largeBody = body;
}
}
const notifications: Array<Record<string, unknown>> = [roomNotification];
// Nest rooms under a space / Directs / Home summary in the shade.
if (isAndroid() && groupId && groupName) {
notifications.push({
id: notificationIdForGroupSummary(groupId),
title: groupName,
body: 'New messages',
channelId,
smallIcon: ANDROID_NOTIFICATION_SMALL_ICON,
iconColor: ANDROID_NOTIFICATION_ICON_COLOR,
group: groupId,
groupSummary: true,
extra: { groupId, groupName, isGroupSummary: true },
});
}
const id = Math.floor(Date.now() % 2147483647);
await LocalNotifications.schedule({
notifications: [
{
id,
title,
body,
channelId: isAndroid() ? 'messages' : undefined,
smallIcon: isAndroid() ? ANDROID_NOTIFICATION_SMALL_ICON : undefined,
iconColor: isAndroid() ? ANDROID_NOTIFICATION_ICON_COLOR : undefined,
extra: path ? { path } : undefined,
},
],
notifications: notifications as any,
});
}
return;

View File

@@ -1,6 +1,6 @@
{
"name": "paarrot",
"version": "4.11.133",
"version": "4.11.135",
"description": "Paarrot - A Matrix client based on Cinny",
"engines": {
"node": ">=18.0.0"