snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/openproject/view.py

@@ -0,0 +1,123 @@
+import regex as re
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+from zerver.lib.exceptions import UnsupportedWebhookEventTypeError
+from zerver.lib.response import json_success
+from zerver.lib.typed_endpoint import JsonBodyPayload, 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
+
+ALL_EVENT_TYPES: list[str] = [
+    "project:created",
+    "project:updated",
+    "work_package:created",
+    "work_package:updated",
+    "time_entry:created",
+    "attachment:created",
+]
+
+PROJECT_MESSAGE_TEMPLATE = "Project **{name}** was {action}{parent_project_message}."
+
+WORK_PACKAGE_MESSAGE_TEMPLATE = (
+    "**{subject}** (work package **{type}**) was {action} by **{author}**."
+)
+
+ATTACHMENT_MESSAGE_TEMPLATE = "**{author}** uploaded **{filename}** in **{container_name}**."
+
+TIME_ENTRY_MESSAGE_TEMPLATE = "**{user}** logged {duration_message}{parent_message}."
+
+
+def format_duration(iso_duration: str) -> str:
+    duration = re.fullmatch(
+        r"P(?:(?P<days>\d+)D)?(?:T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds>\d+)S)?)?",
+        iso_duration,
+    )
+    if duration is None:
+        raise ValueError(f"Invalid ISO 8601 duration format: {iso_duration}")
+
+    time_units = ["days", "hours", "minutes", "seconds"]
+    formatted_duration = [
+        f"{int(duration.group(unit))} {unit[:-1] if int(duration.group(unit)) == 1 else unit}"
+        for unit in time_units
+        if duration.group(unit)
+    ]
+
+    if len(formatted_duration) > 1:
+        return ", ".join(formatted_duration[:-1]) + " and " + formatted_duration[-1]
+    return formatted_duration[0]
+
+
+@webhook_view("OpenProject", all_event_types=ALL_EVENT_TYPES)
+@typed_endpoint
+def api_openproject_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    event_type: str = payload["action"].tame(check_string)
+    item, action = event_type.split(":")
+    action_data: WildValue = payload[item]
+
+    if item == "project":
+        parent_project_message: str = ""
+        parent_project: str = (
+            action_data.get("_embedded", {}).get("parent", {}).get("name", "").tame(check_string)
+        )
+        if parent_project and action == "created":
+            parent_project_message = f" as a sub-project of **{parent_project}**"
+        message = PROJECT_MESSAGE_TEMPLATE.format(
+            name=action_data["name"].tame(check_string),
+            action=action,
+            parent_project_message=parent_project_message,
+        )
+        topic = action_data["name"].tame(check_string)
+    elif item == "work_package":
+        message = WORK_PACKAGE_MESSAGE_TEMPLATE.format(
+            subject=action_data["subject"].tame(check_string),
+            type=action_data["_embedded"]["type"]["name"].tame(check_string),
+            action=action,
+            author=action_data["_embedded"]["author"]["name"].tame(check_string),
+        )
+        topic = action_data["_embedded"]["project"]["name"].tame(check_string)
+    elif item == "attachment":
+        message = ATTACHMENT_MESSAGE_TEMPLATE.format(
+            filename=action_data["fileName"].tame(check_string),
+            author=action_data["_embedded"]["author"]["name"].tame(check_string),
+            container_name=action_data["_embedded"]["container"]["subject"].tame(check_string),
+        )
+        topic = action_data["_embedded"]["container"]["_links"]["project"]["title"].tame(
+            check_string
+        )
+    elif item == "time_entry":
+        parent_message: str = (
+            f" on **{action_data['_embedded']['project']['name'].tame(check_string)}**"
+        )
+        workpackage: str = (
+            action_data.get("_embedded", {})
+            .get("workPackage", {})
+            .get("subject", "")
+            .tame(check_string)
+        )
+        if workpackage:
+            parent_message = f" on **{workpackage}**"
+
+        try:
+            formatted_duration = format_duration(action_data["hours"].tame(check_string))
+            duration_message = f"**{formatted_duration}**"
+        except ValueError:
+            duration_message = "a time entry"
+
+        message = TIME_ENTRY_MESSAGE_TEMPLATE.format(
+            duration_message=duration_message,
+            user=action_data["_embedded"]["user"]["name"].tame(check_string),
+            parent_message=parent_message,
+        )
+        topic = action_data["_embedded"]["project"]["name"].tame(check_string)
+    else:
+        raise UnsupportedWebhookEventTypeError(event_type)
+
+    check_send_webhook_message(request, user_profile, topic, message)
+    return json_success(request)