|
| 1 | +"""Views for the Open edX AuthZ REST API.""" |
| 2 | + |
| 3 | +import logging |
| 4 | + |
| 5 | +from common.djangoapps.student.models.user import get_user_by_username_or_email |
| 6 | +from django.contrib.auth import get_user_model |
| 7 | +from rest_framework import status |
| 8 | +from rest_framework.permissions import IsAuthenticated |
| 9 | +from rest_framework.response import Response |
| 10 | +from rest_framework.views import APIView |
| 11 | + |
| 12 | +from openedx_authz.api.data import ActionData, ScopeData, UserData |
| 13 | +from openedx_authz.api.permissions import has_permission |
| 14 | +from openedx_authz.api.roles import get_role_definitions_in_scope |
| 15 | +from openedx_authz.api.users import ( |
| 16 | + assign_role_to_user_in_scope, |
| 17 | + get_user_role_assignments_for_role_in_scope, |
| 18 | + unassign_role_from_user, |
| 19 | +) |
| 20 | +from openedx_authz.rest_api.v1.serializers import ( |
| 21 | + AddUserToRoleWithScopeSerializer, |
| 22 | + ListRolesWithScopeSerializer, |
| 23 | + ListUsersInRoleWithScopeSerializer, |
| 24 | + PermissionValidationSerializer, |
| 25 | + RemoveUserFromRoleWithScopeSerializer, |
| 26 | +) |
| 27 | + |
| 28 | +logger = logging.getLogger(__name__) |
| 29 | + |
| 30 | +User = get_user_model() |
| 31 | + |
| 32 | + |
| 33 | +class PermissionValidationView(APIView): |
| 34 | + """ |
| 35 | + Validate permissions for the authenticated user. |
| 36 | + """ |
| 37 | + |
| 38 | + permission_classes = [IsAuthenticated] |
| 39 | + |
| 40 | + def post(self, request): |
| 41 | + """Validate permissions for the authenticated user.""" |
| 42 | + serializer = PermissionValidationSerializer(data=request.data, many=True) |
| 43 | + serializer.is_valid(raise_exception=True) |
| 44 | + |
| 45 | + username = request.user.username |
| 46 | + subject = UserData(username=username) |
| 47 | + |
| 48 | + for perm in serializer.validated_data: |
| 49 | + try: |
| 50 | + action = ActionData(name=perm["action"]) |
| 51 | + scope = ScopeData(name=perm["scope"]) |
| 52 | + allowed = has_permission(subject, action, scope) |
| 53 | + perm["allowed"] = allowed |
| 54 | + except Exception as e: # pylint: disable=broad-exception-caught |
| 55 | + logger.error(f"Error validating permission for user {username}: {e}") |
| 56 | + |
| 57 | + return Response(serializer.validated_data, status=status.HTTP_200_OK) |
| 58 | + |
| 59 | + |
| 60 | +class RoleUserAPIView(APIView): |
| 61 | + """ |
| 62 | + APIView for managing users and their roles. |
| 63 | + Handles GET (list), PUT (add), and DELETE (remove) operations. |
| 64 | + """ |
| 65 | + |
| 66 | + permission_classes = [IsAuthenticated] |
| 67 | + |
| 68 | + def get(self, request): |
| 69 | + """ |
| 70 | + Get list of users in the role. |
| 71 | + """ |
| 72 | + serializer = ListUsersInRoleWithScopeSerializer(data=request.query_params) |
| 73 | + serializer.is_valid(raise_exception=True) |
| 74 | + |
| 75 | + role_name = serializer.validated_data["role"] |
| 76 | + scope = serializer.validated_data["scope"] |
| 77 | + |
| 78 | + response_data = [] |
| 79 | + role_assignments = get_user_role_assignments_for_role_in_scope(role_name, scope) |
| 80 | + for assignment in role_assignments: |
| 81 | + # TODO: Should we get all users at once instead of one by one? |
| 82 | + user = get_user_by_username_or_email(assignment.subject.username) |
| 83 | + response_data.append( |
| 84 | + { |
| 85 | + "username": assignment.subject.username, |
| 86 | + "full_name": user.profile.name, |
| 87 | + "email": user.email, |
| 88 | + } |
| 89 | + ) |
| 90 | + |
| 91 | + return Response(response_data, status=status.HTTP_200_OK) |
| 92 | + |
| 93 | + def put(self, request): |
| 94 | + """ |
| 95 | + Add users to the role. |
| 96 | + """ |
| 97 | + serializer = AddUserToRoleWithScopeSerializer(data=request.data) |
| 98 | + serializer.is_valid(raise_exception=True) |
| 99 | + |
| 100 | + completed, errors = [], [] |
| 101 | + role_name = serializer.validated_data["role"] |
| 102 | + scope = serializer.validated_data["scope"] |
| 103 | + |
| 104 | + for user_identifier in serializer.validated_data["users"]: |
| 105 | + try: |
| 106 | + user = get_user_by_username_or_email(user_identifier) |
| 107 | + assign_role_to_user_in_scope(user.username, role_name, scope) |
| 108 | + completed.append({"user": user_identifier, "status": "role_added"}) |
| 109 | + except User.DoesNotExist: |
| 110 | + errors.append({"user": user_identifier, "error": "user_not_found"}) |
| 111 | + except Exception as e: # pylint: disable=broad-exception-caught |
| 112 | + logger.error(f"Error assigning role to user {user_identifier}: {e}") |
| 113 | + errors.append({"user": user_identifier, "error": "assignment_failed"}) |
| 114 | + |
| 115 | + response_data = {"completed": completed, "errors": errors} |
| 116 | + return Response(response_data, status=status.HTTP_207_MULTI_STATUS) |
| 117 | + |
| 118 | + def delete(self, request): |
| 119 | + """ |
| 120 | + Remove user role from the role. |
| 121 | + """ |
| 122 | + serializer = RemoveUserFromRoleWithScopeSerializer(data=request.query_params) |
| 123 | + serializer.is_valid(raise_exception=True) |
| 124 | + |
| 125 | + user_identifier = serializer.validated_data["user"] |
| 126 | + role_name = serializer.validated_data["role"] |
| 127 | + scope = serializer.validated_data["scope"] |
| 128 | + |
| 129 | + try: |
| 130 | + user = get_user_by_username_or_email(user_identifier) |
| 131 | + unassign_role_from_user(user.username, role_name, scope) |
| 132 | + return Response({"message": "Role successfully removed from user"}, status=status.HTTP_200_OK) |
| 133 | + except User.DoesNotExist: |
| 134 | + return Response({"error": "User not found"}, status=status.HTTP_404_NOT_FOUND) |
| 135 | + except Exception as e: # pylint: disable=broad-exception-caught |
| 136 | + logger.error(f"Error removing role from user {user_identifier}: {e}") |
| 137 | + return Response({"error": "Internal server error"}, status=status.HTTP_500_INTERNAL_SERVER_ERROR) |
| 138 | + |
| 139 | + |
| 140 | +class RoleListView(APIView): |
| 141 | + """ |
| 142 | + Get list of roles with their permissions for a scope. |
| 143 | + """ |
| 144 | + |
| 145 | + permission_classes = [IsAuthenticated] |
| 146 | + |
| 147 | + def get(self, request): |
| 148 | + """Get list of roles with their permissions for a library.""" |
| 149 | + serializer = ListRolesWithScopeSerializer(data=request.query_params) |
| 150 | + serializer.is_valid(raise_exception=True) |
| 151 | + |
| 152 | + scope = ScopeData(name=serializer.validated_data["scope"]) |
| 153 | + |
| 154 | + response_data = [] |
| 155 | + roles = get_role_definitions_in_scope(scope) |
| 156 | + |
| 157 | + for role in roles: |
| 158 | + response_data.append( |
| 159 | + { |
| 160 | + "role": role.name, |
| 161 | + "permissions": [perm.action.name for perm in role.permissions] if role.permissions else [], |
| 162 | + # TODO: Get user count using a api function |
| 163 | + "user_count": 0, |
| 164 | + } |
| 165 | + ) |
| 166 | + |
| 167 | + return Response(response_data, status=status.HTTP_200_OK) |
0 commit comments