zulip/zerver/webhooks/beanstalk/view.py

94 lines
3.4 KiB
Python

# Webhooks for external integrations.
import re
from typing import Dict, List, Optional, Tuple
from django.http import HttpRequest, HttpResponse
from zerver.decorator import authenticated_rest_api_view
from zerver.lib.request import REQ, has_request_variables
from zerver.lib.response import json_success
from zerver.lib.validator import WildValue, check_int, check_string, to_wild_value
from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.lib.webhooks.git import TOPIC_WITH_BRANCH_TEMPLATE, get_push_commits_event_message
from zerver.models import UserProfile
def build_message_from_gitlog(
user_profile: UserProfile,
name: str,
ref: str,
commits: WildValue,
before: str,
after: str,
url: str,
pusher: str,
forced: Optional[str] = None,
created: Optional[str] = None,
deleted: bool = False,
) -> Tuple[str, str]:
short_ref = re.sub(r"^refs/heads/", "", ref)
topic = TOPIC_WITH_BRANCH_TEMPLATE.format(repo=name, branch=short_ref)
commits_data = _transform_commits_list_to_common_format(commits)
content = get_push_commits_event_message(pusher, url, short_ref, commits_data, deleted=deleted)
return topic, content
def _transform_commits_list_to_common_format(commits: WildValue) -> List[Dict[str, str]]:
new_commits_list = []
for commit in commits:
new_commits_list.append(
{
"name": commit["author"]["name"].tame(check_string),
"sha": commit["id"].tame(check_string),
"url": commit["url"].tame(check_string),
"message": commit["message"].tame(check_string),
}
)
return new_commits_list
@authenticated_rest_api_view(
webhook_client_name="Beanstalk",
# Beanstalk's web hook UI rejects URL with a @ in the username section
# So we ask the user to replace them with %40
beanstalk_email_decode=True,
)
@has_request_variables
def api_beanstalk_webhook(
request: HttpRequest,
user_profile: UserProfile,
payload: WildValue = REQ(converter=to_wild_value),
branches: Optional[str] = REQ(default=None),
) -> HttpResponse:
# Beanstalk supports both SVN and Git repositories
# We distinguish between the two by checking for a
# 'uri' key that is only present for Git repos
git_repo = "uri" in payload
if git_repo:
if branches is not None and branches.find(payload["branch"].tame(check_string)) == -1:
return json_success(request)
topic, content = build_message_from_gitlog(
user_profile,
payload["repository"]["name"].tame(check_string),
payload["ref"].tame(check_string),
payload["commits"],
payload["before"].tame(check_string),
payload["after"].tame(check_string),
payload["repository"]["url"].tame(check_string),
payload["pusher_name"].tame(check_string),
)
else:
author = payload["author_full_name"].tame(check_string)
url = payload["changeset_url"].tame(check_string)
revision = payload["revision"].tame(check_int)
(short_commit_msg, _, _) = payload["message"].tame(check_string).partition("\n")
topic = f"svn r{revision}"
content = f"{author} pushed [revision {revision}]({url}):\n\n> {short_commit_msg}"
check_send_webhook_message(request, user_profile, topic, content)
return json_success(request)