Files
zulip/zerver/views/realm_linkifiers.py
akshatdalton 6509c4f8f4 linkifiers: Add an API to support the editing of linkifier.
This commit adds an API to `zproject/urls.py` to edit/update
the realm linkifier. Its helper function to update the
database is added in `zerver/lib/actions.py`.

`zulip.yaml` is documented accordingly as well, clearly
stating that this API updates one linkifier at a time.

The tests are added for the API and helper function which
updates the realm linkifier.

Fixes #10830.
2021-04-19 18:01:45 -07:00

69 lines
2.1 KiB
Python

from django.core.exceptions import ValidationError
from django.http import HttpRequest, HttpResponse
from django.utils.translation import gettext as _
from zerver.decorator import require_realm_admin
from zerver.lib.actions import do_add_linkifier, do_remove_linkifier, do_update_linkifier
from zerver.lib.request import REQ, has_request_variables
from zerver.lib.response import json_error, json_success
from zerver.models import RealmFilter, UserProfile, linkifiers_for_realm
# Custom realm linkifiers
def list_linkifiers(request: HttpRequest, user_profile: UserProfile) -> HttpResponse:
linkifiers = linkifiers_for_realm(user_profile.realm_id)
return json_success({"linkifiers": linkifiers})
@require_realm_admin
@has_request_variables
def create_linkifier(
request: HttpRequest,
user_profile: UserProfile,
pattern: str = REQ(),
url_format_string: str = REQ(),
) -> HttpResponse:
try:
linkifier_id = do_add_linkifier(
realm=user_profile.realm,
pattern=pattern,
url_format_string=url_format_string,
)
return json_success({"id": linkifier_id})
except ValidationError as e:
return json_error(e.messages[0], data={"errors": dict(e)})
@require_realm_admin
def delete_linkifier(
request: HttpRequest, user_profile: UserProfile, filter_id: int
) -> HttpResponse:
try:
do_remove_linkifier(realm=user_profile.realm, id=filter_id)
except RealmFilter.DoesNotExist:
return json_error(_("Linkifier not found."))
return json_success()
@require_realm_admin
@has_request_variables
def update_linkifier(
request: HttpRequest,
user_profile: UserProfile,
filter_id: int,
pattern: str = REQ(),
url_format_string: str = REQ(),
) -> HttpResponse:
try:
do_update_linkifier(
realm=user_profile.realm,
id=filter_id,
pattern=pattern,
url_format_string=url_format_string,
)
return json_success()
except RealmFilter.DoesNotExist:
return json_error(_("Linkifier not found."))
except ValidationError as e:
return json_error(e.messages[0], data={"errors": dict(e)})