mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 22:13:26 +00:00
76b49459f8
This commit strengthens types by typing the webhook's incoming payload as WildValue, which eradicates the use of Any within the Zabbix incoming webhook integration. The KeyError exception has been replaced to catch a ValidationError instead now, since the incoming payload's keys will be tamed before usage and the non-existence of the key is raised as a ValidationError in the taming function.
77 lines
2.7 KiB
Python
77 lines
2.7 KiB
Python
from django.core.exceptions import ValidationError
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import gettext as _
|
|
|
|
from zerver.actions.message_send import send_rate_limited_pm_notification_to_bot_owner
|
|
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.send_email import FromAddress
|
|
from zerver.lib.validator import WildValue, check_string, to_wild_value
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
MISCONFIGURED_PAYLOAD_ERROR_MESSAGE = """
|
|
Hi there! Your bot {bot_name} just received a Zabbix payload that is missing
|
|
some data that Zulip requires. This usually indicates a configuration issue
|
|
in your Zabbix webhook settings. Please make sure that you set the
|
|
script correctly and provide all the required parameters
|
|
when configuring the Zabbix webhook. Contact {support_email} if you
|
|
need further help!
|
|
"""
|
|
|
|
ZABBIX_TOPIC_TEMPLATE = "{hostname}"
|
|
ZABBIX_MESSAGE_TEMPLATE = """
|
|
{status} ({severity}) alert on [{hostname}]({link}):
|
|
* {trigger}
|
|
* {item}
|
|
""".strip()
|
|
|
|
|
|
@webhook_view("Zabbix")
|
|
@has_request_variables
|
|
def api_zabbix_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
payload: WildValue = REQ(argument_type="body", converter=to_wild_value),
|
|
) -> HttpResponse:
|
|
|
|
try:
|
|
body = get_body_for_http_request(payload)
|
|
subject = get_subject_for_http_request(payload)
|
|
except ValidationError:
|
|
message = MISCONFIGURED_PAYLOAD_ERROR_MESSAGE.format(
|
|
bot_name=user_profile.full_name,
|
|
support_email=FromAddress.SUPPORT,
|
|
).strip()
|
|
send_rate_limited_pm_notification_to_bot_owner(user_profile, user_profile.realm, message)
|
|
|
|
raise JsonableError(_("Invalid payload"))
|
|
|
|
check_send_webhook_message(request, user_profile, subject, body)
|
|
return json_success(request)
|
|
|
|
|
|
def get_subject_for_http_request(payload: WildValue) -> str:
|
|
return ZABBIX_TOPIC_TEMPLATE.format(hostname=payload["hostname"].tame(check_string))
|
|
|
|
|
|
def get_body_for_http_request(payload: WildValue) -> str:
|
|
hostname = payload["hostname"].tame(check_string)
|
|
severity = payload["severity"].tame(check_string)
|
|
status = payload["status"].tame(check_string)
|
|
item = payload["item"].tame(check_string)
|
|
trigger = payload["trigger"].tame(check_string)
|
|
link = payload["link"].tame(check_string)
|
|
|
|
data = {
|
|
"hostname": hostname,
|
|
"severity": severity,
|
|
"status": status,
|
|
"item": item,
|
|
"trigger": trigger,
|
|
"link": link,
|
|
}
|
|
return ZABBIX_MESSAGE_TEMPLATE.format(**data)
|