mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 21:43:21 +00:00
ab4e6a94c5
View that handled `PATCH user_groups/<int:user_group_id>` required both name and description parameters to be passed. Due to this clients had to pass values for both these parameters even if one of them was changed. To resolve this name description parameters to `PATCH user_groups/<int:user_group_id>` are made optional.
280 lines
10 KiB
Python
280 lines
10 KiB
Python
from typing import Optional, Sequence
|
|
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import gettext as _
|
|
|
|
from zerver.actions.user_groups import (
|
|
add_subgroups_to_user_group,
|
|
bulk_add_members_to_user_group,
|
|
check_add_user_group,
|
|
check_delete_user_group,
|
|
do_update_user_group_description,
|
|
do_update_user_group_name,
|
|
remove_members_from_user_group,
|
|
remove_subgroups_from_user_group,
|
|
)
|
|
from zerver.decorator import require_member_or_admin, require_user_group_edit_permission
|
|
from zerver.lib.exceptions import JsonableError
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.user_groups import (
|
|
access_user_group_by_id,
|
|
access_user_groups_as_potential_subgroups,
|
|
get_direct_memberships_of_users,
|
|
get_subgroup_ids,
|
|
get_user_group_direct_member_ids,
|
|
get_user_group_member_ids,
|
|
is_user_in_group,
|
|
user_groups_in_realm_serialized,
|
|
)
|
|
from zerver.lib.users import access_user_by_id, user_ids_to_users
|
|
from zerver.lib.validator import check_bool, check_int, check_list
|
|
from zerver.models import UserProfile
|
|
from zerver.views.streams import compose_views
|
|
|
|
|
|
@require_user_group_edit_permission
|
|
@has_request_variables
|
|
def add_user_group(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
name: str = REQ(),
|
|
members: Sequence[int] = REQ(json_validator=check_list(check_int), default=[]),
|
|
description: str = REQ(),
|
|
) -> HttpResponse:
|
|
user_profiles = user_ids_to_users(members, user_profile.realm)
|
|
check_add_user_group(
|
|
user_profile.realm, name, user_profiles, description, acting_user=user_profile
|
|
)
|
|
return json_success(request)
|
|
|
|
|
|
@require_member_or_admin
|
|
@has_request_variables
|
|
def get_user_group(request: HttpRequest, user_profile: UserProfile) -> HttpResponse:
|
|
user_groups = user_groups_in_realm_serialized(user_profile.realm)
|
|
return json_success(request, data={"user_groups": user_groups})
|
|
|
|
|
|
@require_user_group_edit_permission
|
|
@has_request_variables
|
|
def edit_user_group(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
user_group_id: int = REQ(json_validator=check_int, path_only=True),
|
|
name: Optional[str] = REQ(default=None),
|
|
description: Optional[str] = REQ(default=None),
|
|
) -> HttpResponse:
|
|
if name is None and description is None:
|
|
raise JsonableError(_("No new data supplied"))
|
|
|
|
user_group = access_user_group_by_id(user_group_id, user_profile)
|
|
|
|
if name is not None and name != user_group.name:
|
|
do_update_user_group_name(user_group, name, acting_user=user_profile)
|
|
|
|
if description is not None and description != user_group.description:
|
|
do_update_user_group_description(user_group, description, acting_user=user_profile)
|
|
|
|
return json_success(request)
|
|
|
|
|
|
@require_user_group_edit_permission
|
|
@has_request_variables
|
|
def delete_user_group(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
user_group_id: int = REQ(json_validator=check_int, path_only=True),
|
|
) -> HttpResponse:
|
|
check_delete_user_group(user_group_id, user_profile, acting_user=user_profile)
|
|
return json_success(request)
|
|
|
|
|
|
@require_user_group_edit_permission
|
|
@has_request_variables
|
|
def update_user_group_backend(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
user_group_id: int = REQ(json_validator=check_int, path_only=True),
|
|
delete: Sequence[int] = REQ(json_validator=check_list(check_int), default=[]),
|
|
add: Sequence[int] = REQ(json_validator=check_list(check_int), default=[]),
|
|
) -> HttpResponse:
|
|
if not add and not delete:
|
|
raise JsonableError(_('Nothing to do. Specify at least one of "add" or "delete".'))
|
|
|
|
thunks = [
|
|
lambda: add_members_to_group_backend(
|
|
request, user_profile, user_group_id=user_group_id, members=add
|
|
),
|
|
lambda: remove_members_from_group_backend(
|
|
request, user_profile, user_group_id=user_group_id, members=delete
|
|
),
|
|
]
|
|
data = compose_views(thunks)
|
|
|
|
return json_success(request, data)
|
|
|
|
|
|
def add_members_to_group_backend(
|
|
request: HttpRequest, user_profile: UserProfile, user_group_id: int, members: Sequence[int]
|
|
) -> HttpResponse:
|
|
if not members:
|
|
return json_success(request)
|
|
|
|
user_group = access_user_group_by_id(user_group_id, user_profile)
|
|
user_profiles = user_ids_to_users(members, user_profile.realm)
|
|
existing_member_ids = set(get_direct_memberships_of_users(user_group, user_profiles))
|
|
|
|
for user_profile in user_profiles:
|
|
if user_profile.id in existing_member_ids:
|
|
raise JsonableError(
|
|
_("User {user_id} is already a member of this group").format(
|
|
user_id=user_profile.id,
|
|
)
|
|
)
|
|
|
|
user_profile_ids = [user.id for user in user_profiles]
|
|
bulk_add_members_to_user_group(user_group, user_profile_ids, acting_user=user_profile)
|
|
return json_success(request)
|
|
|
|
|
|
def remove_members_from_group_backend(
|
|
request: HttpRequest, user_profile: UserProfile, user_group_id: int, members: Sequence[int]
|
|
) -> HttpResponse:
|
|
if not members:
|
|
return json_success(request)
|
|
|
|
user_profiles = user_ids_to_users(members, user_profile.realm)
|
|
user_group = access_user_group_by_id(user_group_id, user_profile)
|
|
group_member_ids = get_user_group_direct_member_ids(user_group)
|
|
for member in members:
|
|
if member not in group_member_ids:
|
|
raise JsonableError(_("There is no member '{}' in this user group").format(member))
|
|
|
|
user_profile_ids = [user.id for user in user_profiles]
|
|
remove_members_from_user_group(user_group, user_profile_ids, acting_user=user_profile)
|
|
return json_success(request)
|
|
|
|
|
|
def add_subgroups_to_group_backend(
|
|
request: HttpRequest, user_profile: UserProfile, user_group_id: int, subgroup_ids: Sequence[int]
|
|
) -> HttpResponse:
|
|
if not subgroup_ids:
|
|
return json_success(request)
|
|
|
|
subgroups = access_user_groups_as_potential_subgroups(subgroup_ids, user_profile)
|
|
user_group = access_user_group_by_id(user_group_id, user_profile)
|
|
existing_direct_subgroup_ids = user_group.direct_subgroups.all().values_list("id", flat=True)
|
|
for group in subgroups:
|
|
if group.id in existing_direct_subgroup_ids:
|
|
raise JsonableError(
|
|
_("User group {group_id} is already a subgroup of this group.").format(
|
|
group_id=group.id
|
|
)
|
|
)
|
|
|
|
add_subgroups_to_user_group(user_group, subgroups, acting_user=user_profile)
|
|
return json_success(request)
|
|
|
|
|
|
def remove_subgroups_from_group_backend(
|
|
request: HttpRequest, user_profile: UserProfile, user_group_id: int, subgroup_ids: Sequence[int]
|
|
) -> HttpResponse:
|
|
if not subgroup_ids:
|
|
return json_success(request)
|
|
|
|
subgroups = access_user_groups_as_potential_subgroups(subgroup_ids, user_profile)
|
|
user_group = access_user_group_by_id(user_group_id, user_profile)
|
|
existing_direct_subgroup_ids = user_group.direct_subgroups.all().values_list("id", flat=True)
|
|
for group in subgroups:
|
|
if group.id not in existing_direct_subgroup_ids:
|
|
raise JsonableError(
|
|
_("User group {group_id} is not a subgroup of this group.").format(
|
|
group_id=group.id
|
|
)
|
|
)
|
|
|
|
remove_subgroups_from_user_group(user_group, subgroups, acting_user=user_profile)
|
|
return json_success(request)
|
|
|
|
|
|
@require_user_group_edit_permission
|
|
@has_request_variables
|
|
def update_subgroups_of_user_group(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
user_group_id: int = REQ(json_validator=check_int, path_only=True),
|
|
delete: Sequence[int] = REQ(json_validator=check_list(check_int), default=[]),
|
|
add: Sequence[int] = REQ(json_validator=check_list(check_int), default=[]),
|
|
) -> HttpResponse:
|
|
if not add and not delete:
|
|
raise JsonableError(_('Nothing to do. Specify at least one of "add" or "delete".'))
|
|
|
|
thunks = [
|
|
lambda: add_subgroups_to_group_backend(
|
|
request, user_profile, user_group_id=user_group_id, subgroup_ids=add
|
|
),
|
|
lambda: remove_subgroups_from_group_backend(
|
|
request, user_profile, user_group_id=user_group_id, subgroup_ids=delete
|
|
),
|
|
]
|
|
data = compose_views(thunks)
|
|
|
|
return json_success(request, data)
|
|
|
|
|
|
@require_member_or_admin
|
|
@has_request_variables
|
|
def get_is_user_group_member(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
user_group_id: int = REQ(json_validator=check_int, path_only=True),
|
|
user_id: int = REQ(json_validator=check_int, path_only=True),
|
|
direct_member_only: bool = REQ(json_validator=check_bool, default=False),
|
|
) -> HttpResponse:
|
|
user_group = access_user_group_by_id(user_group_id, user_profile, for_read=True)
|
|
target_user = access_user_by_id(user_profile, user_id, for_admin=False)
|
|
|
|
return json_success(
|
|
request,
|
|
data={
|
|
"is_user_group_member": is_user_in_group(
|
|
user_group, target_user, direct_member_only=direct_member_only
|
|
)
|
|
},
|
|
)
|
|
|
|
|
|
@require_member_or_admin
|
|
@has_request_variables
|
|
def get_user_group_members(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
user_group_id: int = REQ(json_validator=check_int, path_only=True),
|
|
direct_member_only: bool = REQ(json_validator=check_bool, default=False),
|
|
) -> HttpResponse:
|
|
user_group = access_user_group_by_id(user_group_id, user_profile, for_read=True)
|
|
|
|
return json_success(
|
|
request,
|
|
data={
|
|
"members": get_user_group_member_ids(user_group, direct_member_only=direct_member_only)
|
|
},
|
|
)
|
|
|
|
|
|
@require_member_or_admin
|
|
@has_request_variables
|
|
def get_subgroups_of_user_group(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
user_group_id: int = REQ(json_validator=check_int, path_only=True),
|
|
direct_subgroup_only: bool = REQ(json_validator=check_bool, default=False),
|
|
) -> HttpResponse:
|
|
user_group = access_user_group_by_id(user_group_id, user_profile, for_read=True)
|
|
|
|
return json_success(
|
|
request,
|
|
data={"subgroups": get_subgroup_ids(user_group, direct_subgroup_only=direct_subgroup_only)},
|
|
)
|