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

zerver/actions/realm_playgrounds.py

@@ -0,0 +1,87 @@
+from django.core.exceptions import ValidationError
+from django.db import transaction
+from django.utils.timezone import now as timezone_now
+
+from zerver.lib.exceptions import ValidationFailureError
+from zerver.lib.types import RealmPlaygroundDict
+from zerver.models import Realm, RealmAuditLog, RealmPlayground, UserProfile
+from zerver.models.realm_audit_logs import AuditLogEventType
+from zerver.models.realm_playgrounds import get_realm_playgrounds
+from zerver.models.users import active_user_ids
+from zerver.tornado.django_api import send_event_on_commit
+
+
+def notify_realm_playgrounds(realm: Realm, realm_playgrounds: list[RealmPlaygroundDict]) -> None:
+    event = dict(type="realm_playgrounds", realm_playgrounds=realm_playgrounds)
+    send_event_on_commit(realm, event, active_user_ids(realm.id))
+
+
+@transaction.atomic(durable=True)
+def check_add_realm_playground(
+    realm: Realm,
+    *,
+    acting_user: UserProfile | None,
+    name: str,
+    pygments_language: str,
+    url_template: str,
+) -> int:
+    realm_playground = RealmPlayground(
+        realm=realm,
+        name=name,
+        pygments_language=pygments_language,
+        url_template=url_template,
+    )
+    # The additional validations using url_template_validation
+    # check_pygments_language, etc are included in full_clean.
+    # Because we want to avoid raising ValidationError from this check_*
+    # function, we do error handling here to turn it into a JsonableError.
+    try:
+        realm_playground.full_clean()
+    except ValidationError as e:
+        raise ValidationFailureError(e)
+    realm_playground.save()
+    realm_playgrounds = get_realm_playgrounds(realm)
+    RealmAuditLog.objects.create(
+        realm=realm,
+        acting_user=acting_user,
+        event_type=AuditLogEventType.REALM_PLAYGROUND_ADDED,
+        event_time=timezone_now(),
+        extra_data={
+            "realm_playgrounds": realm_playgrounds,
+            "added_playground": RealmPlaygroundDict(
+                id=realm_playground.id,
+                name=realm_playground.name,
+                pygments_language=realm_playground.pygments_language,
+                url_template=realm_playground.url_template,
+            ),
+        },
+    )
+    notify_realm_playgrounds(realm, realm_playgrounds)
+    return realm_playground.id
+
+
+@transaction.atomic(durable=True)
+def do_remove_realm_playground(
+    realm: Realm, realm_playground: RealmPlayground, *, acting_user: UserProfile | None
+) -> None:
+    removed_playground = {
+        "name": realm_playground.name,
+        "pygments_language": realm_playground.pygments_language,
+        "url_template": realm_playground.url_template,
+    }
+
+    realm_playground.delete()
+    realm_playgrounds = get_realm_playgrounds(realm)
+
+    RealmAuditLog.objects.create(
+        realm=realm,
+        acting_user=acting_user,
+        event_type=AuditLogEventType.REALM_PLAYGROUND_REMOVED,
+        event_time=timezone_now(),
+        extra_data={
+            "realm_playgrounds": realm_playgrounds,
+            "removed_playground": removed_playground,
+        },
+    )
+
+    notify_realm_playgrounds(realm, realm_playgrounds)