Files
zulip/zerver/webhooks/papertrail/view.py
Prakhar Pratyush 3afc8ed7ae webhooks: Rename *topic local variables to *topic_name.
This is preparatory work towards adding a Topic model.
We plan to use the local variable name as 'topic' for
the Topic model objects.

Currently, we use *topic as the local variable name for
topic names.

We rename local variables of the form *topic to *topic_name
so that we don't need to think about type collisions in
individual code paths where we might want to talk about both
Topic objects and strings for the topic name.
2024-01-17 08:35:29 -08:00

63 lines
1.9 KiB
Python

from django.http import HttpRequest, HttpResponse
from django.utils.translation import gettext as _
from pydantic import Json
from zerver.decorator import webhook_view
from zerver.lib.exceptions import JsonableError
from zerver.lib.response import json_success
from zerver.lib.typed_endpoint import typed_endpoint
from zerver.lib.validator import WildValue, check_string
from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.models import UserProfile
MATCHES_TEMPLATE = '[Search for "{name}"]({url}) found **{number}** matches:\n'
SEARCH_TEMPLATE = """
{timestamp} - {source} - {query}:
``` quote
{message}
```
""".strip()
@webhook_view("Papertrail")
@typed_endpoint
def api_papertrail_webhook(
request: HttpRequest,
user_profile: UserProfile,
*,
payload: Json[WildValue],
) -> HttpResponse:
if "events" not in payload:
raise JsonableError(_("Events key is missing from payload"))
matches = MATCHES_TEMPLATE.format(
name=payload["saved_search"]["name"].tame(check_string),
url=payload["saved_search"]["html_search_url"].tame(check_string),
number=str(len(payload["events"])),
)
message = [matches]
for i, event in enumerate(payload["events"]):
event_text = SEARCH_TEMPLATE.format(
timestamp=event["display_received_at"].tame(check_string),
source=event["source_name"].tame(check_string),
query=payload["saved_search"]["query"].tame(check_string),
message=event["message"].tame(check_string),
)
message.append(event_text)
if i >= 3:
message.append(
"[See more]({})".format(
payload["saved_search"]["html_search_url"].tame(check_string)
)
)
break
post = "\n".join(message)
topic_name = "logs"
check_send_webhook_message(request, user_profile, topic_name, post)
return json_success(request)