mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 21:43:21 +00:00
dcbb2a78ca
JsonableError has two major benefits over json_error: * It can be raised from anywhere in the codebase, rather than being a return value, which is much more convenient for refactoring, as one doesn't potentially need to change error handling style when extracting a bit of view code to a function. * It is guaranteed to contain the `code` property, which is helpful for API consistency. Various stragglers are not updated because JsonableError requires subclassing in order to specify custom data or HTTP status codes.
154 lines
5.0 KiB
Python
154 lines
5.0 KiB
Python
from typing import Any, Dict, Tuple
|
|
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import gettext as _
|
|
|
|
from zerver.decorator import webhook_view
|
|
from zerver.lib.exceptions import JsonableError
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
|
|
def get_message_data(payload: Dict[str, Any]) -> Tuple[str, str, str, str]:
|
|
link = "https://app.frontapp.com/open/" + payload["target"]["data"]["id"]
|
|
outbox = payload["conversation"]["recipient"]["handle"]
|
|
inbox = payload["source"]["data"][0]["address"]
|
|
subject = payload["conversation"]["subject"]
|
|
return link, outbox, inbox, subject
|
|
|
|
|
|
def get_source_name(payload: Dict[str, Any]) -> str:
|
|
first_name = payload["source"]["data"]["first_name"]
|
|
last_name = payload["source"]["data"]["last_name"]
|
|
return f"{first_name} {last_name}"
|
|
|
|
|
|
def get_target_name(payload: Dict[str, Any]) -> str:
|
|
first_name = payload["target"]["data"]["first_name"]
|
|
last_name = payload["target"]["data"]["last_name"]
|
|
return f"{first_name} {last_name}"
|
|
|
|
|
|
def get_inbound_message_body(payload: Dict[str, Any]) -> str:
|
|
link, outbox, inbox, subject = get_message_data(payload)
|
|
return (
|
|
"[Inbound message]({link}) from **{outbox}** to **{inbox}**:\n"
|
|
"```quote\n*Subject*: {subject}\n```".format(
|
|
link=link, outbox=outbox, inbox=inbox, subject=subject
|
|
)
|
|
)
|
|
|
|
|
|
def get_outbound_message_body(payload: Dict[str, Any]) -> str:
|
|
link, outbox, inbox, subject = get_message_data(payload)
|
|
return (
|
|
"[Outbound message]({link}) from **{inbox}** to **{outbox}**:\n"
|
|
"```quote\n*Subject*: {subject}\n```".format(
|
|
link=link, inbox=inbox, outbox=outbox, subject=subject
|
|
)
|
|
)
|
|
|
|
|
|
def get_outbound_reply_body(payload: Dict[str, Any]) -> str:
|
|
link, outbox, inbox, subject = get_message_data(payload)
|
|
return "[Outbound reply]({link}) from **{inbox}** to **{outbox}**.".format(
|
|
link=link, inbox=inbox, outbox=outbox
|
|
)
|
|
|
|
|
|
def get_comment_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
comment = payload["target"]["data"]["body"]
|
|
return "**{name}** left a comment:\n```quote\n{comment}\n```".format(name=name, comment=comment)
|
|
|
|
|
|
def get_conversation_assigned_body(payload: Dict[str, Any]) -> str:
|
|
source_name = get_source_name(payload)
|
|
target_name = get_target_name(payload)
|
|
|
|
if source_name == target_name:
|
|
return "**{source_name}** assigned themselves.".format(source_name=source_name)
|
|
|
|
return "**{source_name}** assigned **{target_name}**.".format(
|
|
source_name=source_name, target_name=target_name
|
|
)
|
|
|
|
|
|
def get_conversation_unassigned_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
return f"Unassigned by **{name}**."
|
|
|
|
|
|
def get_conversation_archived_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
return f"Archived by **{name}**."
|
|
|
|
|
|
def get_conversation_reopened_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
return f"Reopened by **{name}**."
|
|
|
|
|
|
def get_conversation_deleted_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
return f"Deleted by **{name}**."
|
|
|
|
|
|
def get_conversation_restored_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
return f"Restored by **{name}**."
|
|
|
|
|
|
def get_conversation_tagged_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
tag = payload["target"]["data"]["name"]
|
|
return f"**{name}** added tag **{tag}**."
|
|
|
|
|
|
def get_conversation_untagged_body(payload: Dict[str, Any]) -> str:
|
|
name = get_source_name(payload)
|
|
tag = payload["target"]["data"]["name"]
|
|
return f"**{name}** removed tag **{tag}**."
|
|
|
|
|
|
EVENT_FUNCTION_MAPPER = {
|
|
"inbound": get_inbound_message_body,
|
|
"outbound": get_outbound_message_body,
|
|
"out_reply": get_outbound_reply_body,
|
|
"comment": get_comment_body,
|
|
"mention": get_comment_body,
|
|
"assign": get_conversation_assigned_body,
|
|
"unassign": get_conversation_unassigned_body,
|
|
"archive": get_conversation_archived_body,
|
|
"reopen": get_conversation_reopened_body,
|
|
"trash": get_conversation_deleted_body,
|
|
"restore": get_conversation_restored_body,
|
|
"tag": get_conversation_tagged_body,
|
|
"untag": get_conversation_untagged_body,
|
|
}
|
|
|
|
|
|
def get_body_based_on_event(event: str) -> Any:
|
|
return EVENT_FUNCTION_MAPPER[event]
|
|
|
|
|
|
@webhook_view("Front")
|
|
@has_request_variables
|
|
def api_front_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
payload: Dict[str, Any] = REQ(argument_type="body"),
|
|
) -> HttpResponse:
|
|
|
|
event = payload["type"]
|
|
if event not in EVENT_FUNCTION_MAPPER:
|
|
raise JsonableError(_("Unknown webhook request"))
|
|
|
|
topic = payload["conversation"]["id"]
|
|
body = get_body_based_on_event(event)(payload)
|
|
check_send_webhook_message(request, user_profile, topic, body)
|
|
|
|
return json_success()
|