Files
zulip/zerver/webhooks/wordpress/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

# Webhooks for external integrations.
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.response import json_success
from zerver.lib.typed_endpoint import typed_endpoint
from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.models import UserProfile
PUBLISH_POST_OR_PAGE_TEMPLATE = """
New {type} published:
* [{title}]({url})
""".strip()
USER_REGISTER_TEMPLATE = """
New blog user registered:
* **Name**: {name}
* **Email**: {email}
""".strip()
WP_LOGIN_TEMPLATE = "User {name} logged in."
ALL_EVENT_TYPES = [
"publish_post",
"publish_page",
"user_register",
"wp_login",
]
@webhook_view("WordPress", notify_bot_owner_on_invalid_json=False, all_event_types=ALL_EVENT_TYPES)
@typed_endpoint
def api_wordpress_webhook(
request: HttpRequest,
user_profile: UserProfile,
*,
hook: str = "WordPress action",
post_title: str = "New WordPress post",
post_type: str = "post",
post_url: str = "WordPress post URL",
display_name: str = "New user name",
user_email: str = "New user email",
user_login: str = "Logged in user",
) -> HttpResponse:
# remove trailing whitespace (issue for some test fixtures)
hook = hook.rstrip()
if hook in ("publish_post", "publish_page"):
data = PUBLISH_POST_OR_PAGE_TEMPLATE.format(type=post_type, title=post_title, url=post_url)
elif hook == "user_register":
data = USER_REGISTER_TEMPLATE.format(name=display_name, email=user_email)
elif hook == "wp_login":
data = WP_LOGIN_TEMPLATE.format(name=user_login)
else:
raise JsonableError(_("Unknown WordPress webhook action: {hook}").format(hook=hook))
topic_name = "WordPress notification"
check_send_webhook_message(request, user_profile, topic_name, data, hook)
return json_success(request)