Skip to content

Commit

Permalink
feat: add ObjectTag view permissions and filters
Browse files Browse the repository at this point in the history
  • Loading branch information
rpenido committed Oct 9, 2023
1 parent ce85d72 commit 3087faa
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 6 deletions.
2 changes: 1 addition & 1 deletion openedx_learning/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
Open edX Learning ("Learning Core").
"""
__version__ = "0.2.2"
__version__ = "0.2.3"
19 changes: 19 additions & 0 deletions openedx_tagging/core/tagging/rest_api/v1/filters.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
API Filters for content
"""

from rest_framework.filters import BaseFilterBackend

from ... import rules as oel_tagging


class ObjectTagTaxonomyFilterBackend(BaseFilterBackend):
"""
Filter for ObjectTagViewSet to only show taxonomies that the user can view.
"""

def filter_queryset(self, request, queryset, _):
if oel_tagging.is_taxonomy_admin(request.user):
return queryset

return queryset.filter(taxonomy__enabled=True)
16 changes: 15 additions & 1 deletion openedx_tagging/core/tagging/rest_api/v1/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from ...models import Taxonomy
from ...rules import ChangeObjectTagPermissionItem
from ..paginators import SEARCH_TAGS_THRESHOLD, TAGS_THRESHOLD, DisabledTagsPagination, TagsPagination
from .filters import ObjectTagTaxonomyFilterBackend
from .permissions import ObjectTagObjectPermissions, TagListPermissions, TaxonomyObjectPermissions
from .serializers import (
ObjectTagListQueryParamsSerializer,
Expand Down Expand Up @@ -228,6 +229,7 @@ class ObjectTagView(

serializer_class = ObjectTagSerializer
permission_classes = [ObjectTagObjectPermissions]
filter_backends = [ObjectTagTaxonomyFilterBackend]
lookup_field = "object_id"

def get_queryset(self) -> models.QuerySet:
Expand All @@ -242,6 +244,18 @@ def get_queryset(self) -> models.QuerySet:
)
query_params.is_valid(raise_exception=True)
taxonomy_id = query_params.data.get("taxonomy", None)

# Checks the permission for the object_id
objectid_perm = self.request.user.has_perm(
"oel_tagging.view_objecttag_objectid",
# The obj arg expects an object, but we are passing a string
object_id, # type: ignore[arg-type]
)

if not objectid_perm:
raise PermissionDenied(
"You do not have permission to view object tags for this object_id."
)
return get_object_tags(object_id, taxonomy_id)

def retrieve(self, request, *args, **kwargs):
Expand All @@ -255,7 +269,7 @@ def retrieve(self, request, *args, **kwargs):
path and returns a it as a single result however that is not
behavior we want.
"""
object_tags = self.get_queryset()
object_tags = self.filter_queryset(self.get_queryset())
serializer = ObjectTagSerializer(object_tags, many=True)
return Response(serializer.data)

Expand Down
12 changes: 11 additions & 1 deletion openedx_tagging/core/tagging/rules.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ def can_change_tag(user: UserType, tag: Tag | None = None) -> bool:
)


@rules.predicate
def can_view_object_tag_objectid(_user: UserType, _object_id: str) -> bool:
"""
Nobody can view object tags without checking the permission for the tagged object.
This rule should be defined in other apps for proper permission checking.
"""
return False


@rules.predicate
def can_change_object_tag_objectid(_user: UserType, _object_id: str) -> bool:
"""
Expand All @@ -74,7 +84,6 @@ def can_change_object_tag_objectid(_user: UserType, _object_id: str) -> bool:
"""
return False


@rules.predicate
def can_change_object_tag(
user: UserType, perm_obj: ChangeObjectTagPermissionItem | None = None
Expand Down Expand Up @@ -124,5 +133,6 @@ def can_change_object_tag(
rules.add_perm("oel_tagging.view_objecttag", rules.always_allow)

# Users can tag objects using tags from any taxonomy that they have permission to view
rules.add_perm("oel_tagging.view_objecttag_taxonomy", can_view_taxonomy)
rules.add_perm("oel_tagging.change_objecttag_taxonomy", can_view_taxonomy)
rules.add_perm("oel_tagging.change_objecttag_objectid", can_change_object_tag_objectid)
7 changes: 4 additions & 3 deletions tests/openedx_tagging/core/tagging/test_views.py
Original file line number Diff line number Diff line change
Expand Up @@ -479,14 +479,15 @@ def _object_permission(_user, object_id: str) -> bool:

# Override the object permission for the test
rules.set_perm("oel_tagging.change_objecttag_objectid", _object_permission)
rules.set_perm("oel_tagging.view_objecttag_objectid", _object_permission)

@ddt.data(
(None, "abc", status.HTTP_403_FORBIDDEN, None),
("user", "abc", status.HTTP_200_OK, 81),
("user", "abc", status.HTTP_200_OK, 51),
("staff", "abc", status.HTTP_200_OK, 81),
(None, "non-existing-id", status.HTTP_403_FORBIDDEN, None),
("user", "non-existing-id", status.HTTP_200_OK, 0),
("staff", "non-existing-id", status.HTTP_200_OK, 0),
("user", "non-existing-id", status.HTTP_403_FORBIDDEN, None),
("staff", "non-existing-id", status.HTTP_403_FORBIDDEN, None),
)
@ddt.unpack
def test_retrieve_object_tags(self, user_attr, object_id, expected_status, expected_count):
Expand Down

0 comments on commit 3087faa

Please sign in to comment.