mirror of
https://github.com/zulip/zulip.git
synced 2025-11-06 06:53:25 +00:00
f844cb6dad
In order to support different types of topic visibility policies, this renames 'add_topic_mute' to 'set_user_topic_visibility_policy_in_database' and refactors it to accept a parameter 'visibility_policy'. Create a corresponding UserTopic row for any visibility policy, not just muting topics. When a UserTopic row for (user_profile, stream, topic, recipient_id) exists already, it updates the row with the new visibility_policy. In the event of a duplicate request, raises a JsonableError. i.e., new_visibility_policy == existing_visibility_policy. There is an increase in the database query count in the message-edit code path. Reason: Earlier, 'add_topic_mute' used 'bulk_create' which either creates or raises IntegrityError -- 1 query. Now, 'set_user_topic_visibility_policy' uses get_or_create -- 2 queries in the case of creating new row. We can't use the previous approach, because now we have to handle the case of updating the visibility_policy too. Also, using bulk_* for a single row is not the correct way. Co-authored-by: Kartik Srivastava <kaushiksri0908@gmail.com> Co-authored-by: Prakhar Pratyush <prakhar841301@gmail.com>
90 lines
2.7 KiB
Python
90 lines
2.7 KiB
Python
import datetime
|
|
from typing import Optional
|
|
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.timezone import now as timezone_now
|
|
from django.utils.translation import gettext as _
|
|
|
|
from zerver.actions.user_topics import do_set_user_topic_visibility_policy
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.streams import (
|
|
access_stream_by_id,
|
|
access_stream_by_name,
|
|
access_stream_for_unmute_topic_by_id,
|
|
access_stream_for_unmute_topic_by_name,
|
|
check_for_exactly_one_stream_arg,
|
|
)
|
|
from zerver.lib.validator import check_int, check_string_in
|
|
from zerver.models import UserProfile, UserTopic
|
|
|
|
|
|
def mute_topic(
|
|
user_profile: UserProfile,
|
|
stream_id: Optional[int],
|
|
stream_name: Optional[str],
|
|
topic_name: str,
|
|
date_muted: datetime.datetime,
|
|
) -> None:
|
|
if stream_name is not None:
|
|
(stream, sub) = access_stream_by_name(user_profile, stream_name)
|
|
else:
|
|
assert stream_id is not None
|
|
(stream, sub) = access_stream_by_id(user_profile, stream_id)
|
|
|
|
do_set_user_topic_visibility_policy(
|
|
user_profile,
|
|
stream,
|
|
topic_name,
|
|
visibility_policy=UserTopic.MUTED,
|
|
last_updated=date_muted,
|
|
)
|
|
|
|
|
|
def unmute_topic(
|
|
user_profile: UserProfile,
|
|
stream_id: Optional[int],
|
|
stream_name: Optional[str],
|
|
topic_name: str,
|
|
) -> None:
|
|
error = _("Topic is not muted")
|
|
|
|
if stream_name is not None:
|
|
stream = access_stream_for_unmute_topic_by_name(user_profile, stream_name, error)
|
|
else:
|
|
assert stream_id is not None
|
|
stream = access_stream_for_unmute_topic_by_id(user_profile, stream_id, error)
|
|
|
|
do_set_user_topic_visibility_policy(
|
|
user_profile, stream, topic_name, visibility_policy=UserTopic.VISIBILITY_POLICY_INHERIT
|
|
)
|
|
|
|
|
|
@has_request_variables
|
|
def update_muted_topic(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
stream_id: Optional[int] = REQ(json_validator=check_int, default=None),
|
|
stream: Optional[str] = REQ(default=None),
|
|
topic: str = REQ(),
|
|
op: str = REQ(str_validator=check_string_in(["add", "remove"])),
|
|
) -> HttpResponse:
|
|
check_for_exactly_one_stream_arg(stream_id=stream_id, stream=stream)
|
|
|
|
if op == "add":
|
|
mute_topic(
|
|
user_profile=user_profile,
|
|
stream_id=stream_id,
|
|
stream_name=stream,
|
|
topic_name=topic,
|
|
date_muted=timezone_now(),
|
|
)
|
|
elif op == "remove":
|
|
unmute_topic(
|
|
user_profile=user_profile,
|
|
stream_id=stream_id,
|
|
stream_name=stream,
|
|
topic_name=topic,
|
|
)
|
|
return json_success(request)
|