From ec36272bb48d445ac4a9f6a9ff26ae76b94e9a55 Mon Sep 17 00:00:00 2001 From: Thomas Sileo Date: Sun, 27 Nov 2022 12:11:42 +0100 Subject: [PATCH] Allow to disable certain notification type --- app/boxes.py | 190 ++++++++++++++++++++++++++------------------- app/config.py | 2 + app/webmentions.py | 40 +++++----- docs/user_guide.md | 33 ++++++++ 4 files changed, 167 insertions(+), 98 deletions(-) diff --git a/app/boxes.py b/app/boxes.py index 443f608..296844b 100644 --- a/app/boxes.py +++ b/app/boxes.py @@ -50,6 +50,17 @@ from app.utils.text import slugify AnyboxObject = models.InboxObject | models.OutboxObject +def is_notification_enabled(notification_type: models.NotificationType) -> bool: + """Checks if a given notification type is enabled.""" + if notification_type.value == "pending_incoming_follower": + # This one cannot be disabled as it would prevent manually reviewing + # follow requests. + return True + if notification_type.value in config.CONFIG.disabled_notifications: + return False + return True + + def allocate_outbox_id() -> str: return uuid.uuid4().hex @@ -168,12 +179,13 @@ async def send_block(db_session: AsyncSession, ap_actor_id: str) -> None: await new_outgoing_activity(db_session, actor.inbox_url, outbox_object.id) # 4. Create a notification - notif = models.Notification( - notification_type=models.NotificationType.BLOCK, - actor_id=actor.id, - outbox_object_id=outbox_object.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.BLOCK): + notif = models.Notification( + notification_type=models.NotificationType.BLOCK, + actor_id=actor.id, + outbox_object_id=outbox_object.id, + ) + db_session.add(notif) await db_session.commit() @@ -447,12 +459,13 @@ async def _send_undo(db_session: AsyncSession, ap_object_id: str) -> None: outbox_object.id, ) - notif = models.Notification( - notification_type=models.NotificationType.UNBLOCK, - actor_id=blocked_actor.id, - outbox_object_id=outbox_object.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.UNBLOCK): + notif = models.Notification( + notification_type=models.NotificationType.UNBLOCK, + actor_id=blocked_actor.id, + outbox_object_id=outbox_object.id, + ) + db_session.add(notif) else: raise ValueError("Should never happen") @@ -1525,11 +1538,12 @@ async def _send_accept( raise ValueError("Should never happen") await new_outgoing_activity(db_session, from_actor.inbox_url, outbox_activity.id) - notif = models.Notification( - notification_type=models.NotificationType.NEW_FOLLOWER, - actor_id=from_actor.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.NEW_FOLLOWER): + notif = models.Notification( + notification_type=models.NotificationType.NEW_FOLLOWER, + actor_id=from_actor.id, + ) + db_session.add(notif) async def send_reject( @@ -1568,11 +1582,12 @@ async def _send_reject( raise ValueError("Should never happen") await new_outgoing_activity(db_session, from_actor.inbox_url, outbox_activity.id) - notif = models.Notification( - notification_type=models.NotificationType.REJECTED_FOLLOWER, - actor_id=from_actor.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.REJECTED_FOLLOWER): + notif = models.Notification( + notification_type=models.NotificationType.REJECTED_FOLLOWER, + actor_id=from_actor.id, + ) + db_session.add(notif) async def _handle_undo_activity( @@ -1598,11 +1613,12 @@ async def _handle_undo_activity( models.Follower.inbox_object_id == ap_activity_to_undo.id ) ) - notif = models.Notification( - notification_type=models.NotificationType.UNFOLLOW, - actor_id=from_actor.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.UNFOLLOW): + notif = models.Notification( + notification_type=models.NotificationType.UNFOLLOW, + actor_id=from_actor.id, + ) + db_session.add(notif) elif ap_activity_to_undo.ap_type == "Like": if not ap_activity_to_undo.activity_object_ap_id: @@ -1618,14 +1634,21 @@ async def _handle_undo_activity( ) return - liked_obj.likes_count = models.OutboxObject.likes_count - 1 - notif = models.Notification( - notification_type=models.NotificationType.UNDO_LIKE, - actor_id=from_actor.id, - outbox_object_id=liked_obj.id, - inbox_object_id=ap_activity_to_undo.id, + liked_obj.likes_count = ( + await _get_outbox_likes_count( + db_session, + liked_obj, + ) + - 1 ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.UNDO_LIKE): + notif = models.Notification( + notification_type=models.NotificationType.UNDO_LIKE, + actor_id=from_actor.id, + outbox_object_id=liked_obj.id, + inbox_object_id=ap_activity_to_undo.id, + ) + db_session.add(notif) elif ap_activity_to_undo.ap_type == "Announce": if not ap_activity_to_undo.activity_object_ap_id: @@ -1643,20 +1666,22 @@ async def _handle_undo_activity( announced_obj_from_outbox.announces_count = ( models.OutboxObject.announces_count - 1 ) - notif = models.Notification( - notification_type=models.NotificationType.UNDO_ANNOUNCE, - actor_id=from_actor.id, - outbox_object_id=announced_obj_from_outbox.id, - inbox_object_id=ap_activity_to_undo.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.UNDO_ANNOUNCE): + notif = models.Notification( + notification_type=models.NotificationType.UNDO_ANNOUNCE, + actor_id=from_actor.id, + outbox_object_id=announced_obj_from_outbox.id, + inbox_object_id=ap_activity_to_undo.id, + ) + db_session.add(notif) elif ap_activity_to_undo.ap_type == "Block": - notif = models.Notification( - notification_type=models.NotificationType.UNBLOCKED, - actor_id=from_actor.id, - inbox_object_id=ap_activity_to_undo.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.UNBLOCKED): + notif = models.Notification( + notification_type=models.NotificationType.UNBLOCKED, + actor_id=from_actor.id, + inbox_object_id=ap_activity_to_undo.id, + ) + db_session.add(notif) else: logger.warning(f"Don't know how to undo {ap_activity_to_undo.ap_type} activity") @@ -1720,12 +1745,13 @@ async def _handle_move_activity( else: logger.info(f"Already following target {new_actor_id}") - notif = models.Notification( - notification_type=models.NotificationType.MOVE, - actor_id=new_actor.id, - inbox_object_id=move_activity.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.MOVE): + notif = models.Notification( + notification_type=models.NotificationType.MOVE, + actor_id=new_actor.id, + inbox_object_id=move_activity.id, + ) + db_session.add(notif) async def _handle_update_activity( @@ -1999,7 +2025,7 @@ async def _process_note_object( inbox_object_id=parent_activity.id, ) - if is_mention: + if is_mention and is_notification_enabled(models.NotificationType.MENTION): notif = models.Notification( notification_type=models.NotificationType.MENTION, actor_id=from_actor.id, @@ -2098,13 +2124,14 @@ async def _handle_announce_activity( models.OutboxObject.announces_count + 1 ) - notif = models.Notification( - notification_type=models.NotificationType.ANNOUNCE, - actor_id=actor.id, - outbox_object_id=relates_to_outbox_object.id, - inbox_object_id=announce_activity.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.ANNOUNCE): + notif = models.Notification( + notification_type=models.NotificationType.ANNOUNCE, + actor_id=actor.id, + outbox_object_id=relates_to_outbox_object.id, + inbox_object_id=announce_activity.id, + ) + db_session.add(notif) else: # Only show the announce in the stream if it comes from an actor # in the following collection @@ -2202,13 +2229,14 @@ async def _handle_like_activity( relates_to_outbox_object, ) - notif = models.Notification( - notification_type=models.NotificationType.LIKE, - actor_id=actor.id, - outbox_object_id=relates_to_outbox_object.id, - inbox_object_id=like_activity.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.LIKE): + notif = models.Notification( + notification_type=models.NotificationType.LIKE, + actor_id=actor.id, + outbox_object_id=relates_to_outbox_object.id, + inbox_object_id=like_activity.id, + ) + db_session.add(notif) async def _handle_block_activity( @@ -2225,12 +2253,13 @@ async def _handle_block_activity( return # Create a notification - notif = models.Notification( - notification_type=models.NotificationType.BLOCKED, - actor_id=actor.id, - inbox_object_id=block_activity.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.BLOCKED): + notif = models.Notification( + notification_type=models.NotificationType.BLOCKED, + actor_id=actor.id, + inbox_object_id=block_activity.id, + ) + db_session.add(notif) async def _process_transient_object( @@ -2433,12 +2462,13 @@ async def save_to_inbox( if activity_ro.ap_type == "Accept" else models.NotificationType.FOLLOW_REQUEST_REJECTED ) - notif = models.Notification( - notification_type=notif_type, - actor_id=actor.id, - inbox_object_id=inbox_object.id, - ) - db_session.add(notif) + if is_notification_enabled(notif_type): + notif = models.Notification( + notification_type=notif_type, + actor_id=actor.id, + inbox_object_id=inbox_object.id, + ) + db_session.add(notif) if activity_ro.ap_type == "Accept": following = models.Following( diff --git a/app/config.py b/app/config.py index e8e2a4d..60a4d9c 100644 --- a/app/config.py +++ b/app/config.py @@ -120,6 +120,8 @@ class Config(pydantic.BaseModel): session_timeout: int = 3600 * 24 * 3 # in seconds, 3 days by default + disabled_notifications: list[str] = [] + # Only set when the app is served on a non-root path id: str | None = None diff --git a/app/webmentions.py b/app/webmentions.py index 4f2ab4c..7c3ab72 100644 --- a/app/webmentions.py +++ b/app/webmentions.py @@ -17,6 +17,7 @@ from app.boxes import _get_outbox_likes_count from app.boxes import _get_outbox_replies_count from app.boxes import get_outbox_object_by_ap_id from app.boxes import get_outbox_object_by_slug_and_short_id +from app.boxes import is_notification_enabled from app.database import AsyncSession from app.database import get_db_session from app.utils import microformats @@ -118,12 +119,13 @@ async def webmention_endpoint( db_session, existing_webmention_in_db, mentioned_object ) - notif = models.Notification( - notification_type=models.NotificationType.DELETED_WEBMENTION, - outbox_object_id=mentioned_object.id, - webmention_id=existing_webmention_in_db.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.DELETED_WEBMENTION): + notif = models.Notification( + notification_type=models.NotificationType.DELETED_WEBMENTION, + outbox_object_id=mentioned_object.id, + webmention_id=existing_webmention_in_db.id, + ) + db_session.add(notif) await db_session.commit() @@ -144,12 +146,13 @@ async def webmention_endpoint( await db_session.flush() webmention = existing_webmention_in_db - notif = models.Notification( - notification_type=models.NotificationType.UPDATED_WEBMENTION, - outbox_object_id=mentioned_object.id, - webmention_id=existing_webmention_in_db.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.UPDATED_WEBMENTION): + notif = models.Notification( + notification_type=models.NotificationType.UPDATED_WEBMENTION, + outbox_object_id=mentioned_object.id, + webmention_id=existing_webmention_in_db.id, + ) + db_session.add(notif) else: new_webmention = models.Webmention( source=source, @@ -162,12 +165,13 @@ async def webmention_endpoint( await db_session.flush() webmention = new_webmention - notif = models.Notification( - notification_type=models.NotificationType.NEW_WEBMENTION, - outbox_object_id=mentioned_object.id, - webmention_id=new_webmention.id, - ) - db_session.add(notif) + if is_notification_enabled(models.NotificationType.NEW_WEBMENTION): + notif = models.Notification( + notification_type=models.NotificationType.NEW_WEBMENTION, + outbox_object_id=mentioned_object.id, + webmention_id=new_webmention.id, + ) + db_session.add(notif) # Determine the webmention type for item in data.get("items", []): diff --git a/docs/user_guide.md b/docs/user_guide.md index ec398f3..6bea721 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -98,6 +98,39 @@ privacy_replace = [ ] ``` +### Disabling certain notification types + +All notifications are enabled by default. + +You can disabled specific notifications by adding them to the `disabled_notifications` list. + +This example disables likes and shares notifications: + +``` +disabled_notifications = ["like", "announce"] +``` + +#### Available notification types + + - `new_follower` + - `rejected_follower` + - `unfollow` + - `follow_request_accepted` + - `follow_request_rejected` + - `move` + - `like` + - `undo_like` + - `announce` + - `undo_announce` + - `mention` + - `new_webmention` + - `updated_webmention` + - `deleted_webmention` + - `blocked` + - `unblocked` + - `block` + - `unblock` + ### Customization #### Default emoji