mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 21:43:21 +00:00
73 lines
2.8 KiB
Python
73 lines
2.8 KiB
Python
import re
|
|
from typing import Annotated
|
|
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import gettext as _
|
|
from pydantic import AfterValidator
|
|
|
|
from zerver.actions.realm_playgrounds import check_add_realm_playground, do_remove_realm_playground
|
|
from zerver.actions.realm_settings import do_set_realm_property
|
|
from zerver.decorator import require_realm_admin
|
|
from zerver.lib.exceptions import JsonableError
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.typed_endpoint import PathOnly, typed_endpoint
|
|
from zerver.lib.validator import check_capped_string
|
|
from zerver.models import Realm, RealmPlayground, UserProfile
|
|
|
|
|
|
def check_pygments_language(var_name: str, val: object) -> str:
|
|
s = check_capped_string(RealmPlayground.MAX_PYGMENTS_LANGUAGE_LENGTH)(var_name, val)
|
|
# We don't want to restrict the language here to be only from the list of valid
|
|
# Pygments languages. Keeping it open would allow us to hook up a "playground"
|
|
# for custom "languages" that aren't known to Pygments. We use a similar strategy
|
|
# even in our fenced_code Markdown processor.
|
|
valid_pygments_language = re.compile(r"^[ a-zA-Z0-9_+-./#]*$")
|
|
matched_results = valid_pygments_language.match(s)
|
|
if not matched_results:
|
|
raise JsonableError(_("Invalid characters in pygments language"))
|
|
return s
|
|
|
|
|
|
def access_playground_by_id(realm: Realm, playground_id: int) -> RealmPlayground:
|
|
try:
|
|
realm_playground = RealmPlayground.objects.get(id=playground_id, realm=realm)
|
|
except RealmPlayground.DoesNotExist:
|
|
raise JsonableError(_("Invalid playground"))
|
|
return realm_playground
|
|
|
|
|
|
@require_realm_admin
|
|
@typed_endpoint
|
|
def add_realm_playground(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
*,
|
|
name: str,
|
|
pygments_language: Annotated[
|
|
str, AfterValidator(lambda x: check_pygments_language("pygments_language", x))
|
|
],
|
|
url_template: str,
|
|
) -> HttpResponse:
|
|
playground_id = check_add_realm_playground(
|
|
realm=user_profile.realm,
|
|
acting_user=user_profile,
|
|
name=name.strip(),
|
|
pygments_language=pygments_language.strip(),
|
|
url_template=url_template.strip(),
|
|
)
|
|
return json_success(request, data={"id": playground_id})
|
|
|
|
|
|
@require_realm_admin
|
|
@typed_endpoint
|
|
def delete_realm_playground(
|
|
request: HttpRequest, user_profile: UserProfile, *, playground_id: PathOnly[int]
|
|
) -> HttpResponse:
|
|
realm_playground = access_playground_by_id(user_profile.realm, playground_id)
|
|
if user_profile.realm.default_code_block_language == realm_playground.pygments_language:
|
|
do_set_realm_property(
|
|
user_profile.realm, "default_code_block_language", "", acting_user=user_profile
|
|
)
|
|
do_remove_realm_playground(user_profile.realm, realm_playground, acting_user=user_profile)
|
|
return json_success(request)
|