mirror of
https://github.com/zulip/zulip.git
synced 2025-10-26 09:34:02 +00:00
e763d065a3
This commit renames the 'send_event' function to 'send_event_rollback_unsafe' to reflect the fact that it doesn't wait for the db transaction (within which it gets called, if any) to commit and sends event irrespective of commit or rollback. In most of the cases we don't want to send event in the case of rollbacks, so the caller should be aware that calling the function directly is rollback unsafe.
102 lines
3.6 KiB
Python
102 lines
3.6 KiB
Python
from django.conf import settings
|
|
from django.utils.translation import gettext as _
|
|
|
|
from zerver.lib.exceptions import JsonableError
|
|
from zerver.lib.stream_subscription import get_active_subscriptions_for_stream_id
|
|
from zerver.models import Realm, Stream, UserProfile
|
|
from zerver.models.users import get_user_by_id_in_realm_including_cross_realm
|
|
from zerver.tornado.django_api import send_event_rollback_unsafe
|
|
|
|
|
|
def do_send_typing_notification(
|
|
realm: Realm, sender: UserProfile, recipient_user_profiles: list[UserProfile], operator: str
|
|
) -> None:
|
|
sender_dict = {"user_id": sender.id, "email": sender.email}
|
|
|
|
# Include a list of recipients in the event body to help identify where the typing is happening
|
|
recipient_dicts = [
|
|
{"user_id": profile.id, "email": profile.email} for profile in recipient_user_profiles
|
|
]
|
|
event = dict(
|
|
type="typing",
|
|
message_type="direct",
|
|
op=operator,
|
|
sender=sender_dict,
|
|
recipients=recipient_dicts,
|
|
)
|
|
|
|
# Only deliver the notification to active user recipients
|
|
user_ids_to_notify = [
|
|
user.id
|
|
for user in recipient_user_profiles
|
|
if user.is_active and user.receives_typing_notifications
|
|
]
|
|
|
|
send_event_rollback_unsafe(realm, event, user_ids_to_notify)
|
|
|
|
|
|
# check_send_typing_notification:
|
|
# Checks the typing notification and sends it
|
|
def check_send_typing_notification(sender: UserProfile, user_ids: list[int], operator: str) -> None:
|
|
realm = sender.realm
|
|
|
|
if sender.id not in user_ids:
|
|
user_ids.append(sender.id)
|
|
|
|
# If any of the user_ids being sent in are invalid, we will
|
|
# just reject the whole request, since a partial list of user_ids
|
|
# can create confusion related to direct message groups. Plus it's
|
|
# a good sign that a client is confused (or possibly even malicious)
|
|
# if we get bad user_ids.
|
|
user_profiles = []
|
|
for user_id in user_ids:
|
|
try:
|
|
# We include cross-bot realms as possible recipients,
|
|
# so that clients can know which direct message group
|
|
# conversation is relevant here.
|
|
user_profile = get_user_by_id_in_realm_including_cross_realm(user_id, sender.realm)
|
|
except UserProfile.DoesNotExist:
|
|
raise JsonableError(_("Invalid user ID {user_id}").format(user_id=user_id))
|
|
user_profiles.append(user_profile)
|
|
|
|
do_send_typing_notification(
|
|
realm=realm,
|
|
sender=sender,
|
|
recipient_user_profiles=user_profiles,
|
|
operator=operator,
|
|
)
|
|
|
|
|
|
def do_send_stream_typing_notification(
|
|
sender: UserProfile, operator: str, stream: Stream, topic_name: str
|
|
) -> None:
|
|
sender_dict = {"user_id": sender.id, "email": sender.email}
|
|
|
|
event = dict(
|
|
type="typing",
|
|
message_type="stream",
|
|
op=operator,
|
|
sender=sender_dict,
|
|
stream_id=stream.id,
|
|
topic=topic_name,
|
|
)
|
|
|
|
# We don't notify long_term_idle subscribers.
|
|
subscriptions_query = get_active_subscriptions_for_stream_id(
|
|
stream.id, include_deactivated_users=False
|
|
)
|
|
|
|
total_subscriptions = subscriptions_query.count()
|
|
if total_subscriptions > settings.MAX_STREAM_SIZE_FOR_TYPING_NOTIFICATIONS:
|
|
# TODO: Stream typing notifications are disabled in streams
|
|
# with too many subscribers for performance reasons.
|
|
return
|
|
|
|
user_ids_to_notify = set(
|
|
subscriptions_query.exclude(user_profile__long_term_idle=True)
|
|
.exclude(user_profile__receives_typing_notifications=False)
|
|
.values_list("user_profile_id", flat=True)
|
|
)
|
|
|
|
send_event_rollback_unsafe(sender.realm, event, user_ids_to_notify)
|