zulip/zerver/views/hotspots.py

from django.http import HttpRequest, HttpResponse
from django.utils.translation import gettext as _

from zerver.decorator import human_users_only
from zerver.lib.actions import do_mark_hotspot_as_read
from zerver.lib.hotspots import ALL_HOTSPOTS
from zerver.lib.request import REQ, has_request_variables
from zerver.lib.response import json_error, json_success
from zerver.lib.validator import check_string
from zerver.models import UserProfile


@human_users_only
@has_request_variables
def mark_hotspot_as_read(
    request: HttpRequest, user: UserProfile, hotspot: str = REQ(json_validator=check_string)
) -> HttpResponse:
    if hotspot not in ALL_HOTSPOTS:
        return json_error(_("Unknown hotspot: {}").format(hotspot))
    do_mark_hotspot_as_read(user, hotspot)
    return json_success()