Sith/sas/api.py

from typing import Any, Literal

from django.conf import settings
from django.core.exceptions import ValidationError
from django.db.models import F
from django.shortcuts import get_list_or_404
from django.urls import reverse
from ninja import Body, Query, UploadedFile
from ninja.errors import HttpError
from ninja_extra import ControllerBase, api_controller, paginate, route
from ninja_extra.exceptions import NotFound, PermissionDenied
from ninja_extra.pagination import PageNumberPaginationExtra
from ninja_extra.permissions import IsAuthenticated
from ninja_extra.schemas import PaginatedResponseSchema
from pydantic import NonNegativeInt

from core.auth.api_permissions import (
    CanAccessLookup,
    CanEdit,
    CanView,
    HasPerm,
    IsInGroup,
    IsRoot,
)
from core.models import Notification, User
from core.utils import get_list_exact_or_404
from sas.models import Album, PeoplePictureRelation, Picture
from sas.schemas import (
    AlbumAutocompleteSchema,
    AlbumFilterSchema,
    AlbumSchema,
    IdentifiedUserSchema,
    ModerationRequestSchema,
    MoveAlbumSchema,
    PictureFilterSchema,
    PictureSchema,
)

IsSasAdmin = IsRoot | IsInGroup(settings.SITH_GROUP_SAS_ADMIN_ID)


@api_controller("/sas/album")
class AlbumController(ControllerBase):
    @route.get(
        "/search",
        response=PaginatedResponseSchema[AlbumSchema],
        permissions=[IsAuthenticated],
        url_name="search-album",
    )
    @paginate(PageNumberPaginationExtra, page_size=50)
    def fetch_album(self, filters: Query[AlbumFilterSchema]):
        """General-purpose album search."""
        return filters.filter(
            Album.objects.viewable_by(self.context.request.user).order_by("-date")
        )

    @route.get(
        "/autocomplete-search",
        response=PaginatedResponseSchema[AlbumAutocompleteSchema],
        permissions=[CanAccessLookup],
    )
    @paginate(PageNumberPaginationExtra, page_size=50)
    def autocomplete_album(self, filters: Query[AlbumFilterSchema]):
        """Search route to use exclusively on autocomplete input fields.

        This route is separated from `GET /sas/album/search` because
        getting the path of an album may need an absurd amount of db queries.

        If you don't need the path of the albums,
        do NOT use this route.
        """
        return filters.filter(
            Album.objects.viewable_by(self.context.request.user).order_by("-date")
        )

    @route.patch("/parent", permissions=[IsAuthenticated])
    def change_album_parent(self, payload: list[MoveAlbumSchema]):
        """Change parents of albums

        Note:
            For this operation to work, the user must be authorized
            to edit both the moved albums and their new parent.
        """
        user: User = self.context.request.user
        albums: list[Album] = get_list_exact_or_404(
            Album, pk__in={a.id for a in payload}
        )
        if not user.has_perm("sas.change_album"):
            unauthorized = [a.id for a in albums if not user.can_edit(a)]
            raise PermissionDenied(
                f"You can't move the following albums : {unauthorized}"
            )
        parents: list[Album] = get_list_exact_or_404(
            Album, pk__in={a.new_parent_id for a in payload}
        )
        if not user.has_perm("sas.change_album"):
            unauthorized = [a.id for a in parents if not user.can_edit(a)]
            raise PermissionDenied(
                f"You can't move to the following albums : {unauthorized}"
            )
        id_to_new_parent = {i.id: i.new_parent_id for i in payload}
        for album in albums:
            album.parent_id = id_to_new_parent[album.id]
        # known caveat : moving an album won't move it's thumbnail.
        # E.g. if the album foo/bar is moved to foo/baz,
        # the thumbnail will still be foo/bar/thumb.webp
        # This has no impact for the end user
        # and doing otherwise would be hard for us to implement,
        # because we would then have to manage rollbacks on fail.
        Album.objects.bulk_update(albums, fields=["parent_id"])

    @route.delete("", permissions=[HasPerm("sas.delete_album")])
    def delete_album(self, album_ids: list[int]):
        # known caveat : deleting an album doesn't delete the pictures on the disk.
        # It's a db only operation.
        albums: list[Album] = get_list_or_404(Album, pk__in=album_ids)


@api_controller("/sas/picture")
class PicturesController(ControllerBase):
    @route.get(
        "",
        response=PaginatedResponseSchema[PictureSchema],
        permissions=[IsAuthenticated],
        url_name="pictures",
    )
    @paginate(PageNumberPaginationExtra, page_size=100)
    def fetch_pictures(self, filters: Query[PictureFilterSchema]):
        """Find pictures viewable by the user corresponding to the given filters.

        A user with an active subscription can see any picture, as long
        as it has been moderated and not asked for removal.
        An unsubscribed user can see the pictures he has been identified on
        (only the moderated ones, too).

        Notes:
            Trying to fetch the pictures of another user with this route
            while being unsubscribed will just result in an empty response.

        Notes:
            Unsubscribed users who are identified is not a rare case.
            They can be UTT students, faluchards from other schools,
            or even Richard Stallman (that ain't no joke,
            cf. https://ae.utbm.fr/user/32663/pictures/)
        """
        user: User = self.context.request.user
        return (
            filters.filter(Picture.objects.viewable_by(user))
            .distinct()
            .order_by("-parent__event_date", "created_at")
            .select_related("owner")
            .annotate(album=F("parent__name"))
        )

    @route.post(
        "",
        permissions=[CanEdit],
        response={
            200: None,
            409: dict[Literal["detail"], dict[str, list[str]]],
            422: dict[Literal["detail"], list[dict[str, Any]]],
        },
        url_name="upload_picture",
    )
    def upload_picture(self, album_id: Body[int], picture: UploadedFile):
        album = self.get_object_or_exception(Album, pk=album_id)
        user = self.context.request.user
        self_moderate = user.has_perm("sas.moderate_sasfile")
        new = Picture(
            parent=album,
            name=picture.name,
            original=picture,
            owner=user,
            is_moderated=self_moderate,
        )
        if self_moderate:
            new.moderator = user
        new.generate_thumbnails()
        try:
            new.full_clean()
        except ValidationError as e:
            raise HttpError(status_code=409, message=str(e)) from e
        new.save()

    @route.get(
        "/{picture_id}/identified",
        permissions=[IsAuthenticated, CanView],
        response=list[IdentifiedUserSchema],
    )
    def fetch_identifications(self, picture_id: int):
        """Fetch the users that have been identified on the given picture."""
        picture = self.get_object_or_exception(Picture, pk=picture_id)
        return picture.people.select_related("user")

    @route.put("/{picture_id}/identified", permissions=[IsAuthenticated, CanView])
    def identify_users(self, picture_id: NonNegativeInt, users: set[NonNegativeInt]):
        picture = self.get_object_or_exception(Picture, pk=picture_id)
        db_users = list(User.objects.filter(id__in=users))
        if len(users) != len(db_users):
            raise NotFound
        already_identified = set(
            picture.people.filter(user_id__in=users).values_list("user_id", flat=True)
        )
        identified = [u for u in db_users if u.pk not in already_identified]
        relations = [
            PeoplePictureRelation(user=u, picture_id=picture_id) for u in identified
        ]
        PeoplePictureRelation.objects.bulk_create(relations)
        for u in identified:
            Notification.objects.get_or_create(
                user=u,
                viewed=False,
                type="NEW_PICTURES",
                defaults={
                    "url": reverse("sas:user_pictures", kwargs={"user_id": u.id})
                },
            )

    @route.delete("/{picture_id}", permissions=[IsSasAdmin])
    def delete_picture(self, picture_id: int):
        self.get_object_or_exception(Picture, pk=picture_id).delete()

    @route.patch(
        "/{picture_id}/moderation",
        permissions=[IsSasAdmin],
        url_name="picture_moderate",
    )
    def moderate_picture(self, picture_id: int):
        """Mark a picture as moderated and remove its pending moderation requests."""
        picture = self.get_object_or_exception(Picture, pk=picture_id)
        picture.moderation_requests.all().delete()
        picture.is_moderated = True
        picture.moderator = self.context.request.user
        picture.asked_for_removal = False
        picture.save()

    @route.get(
        "/{picture_id}/moderation",
        permissions=[IsSasAdmin],
        response=list[ModerationRequestSchema],
        url_name="picture_moderation_requests",
    )
    def fetch_moderation_requests(self, picture_id: int):
        """Fetch the moderation requests issued on this picture."""
        picture = self.get_object_or_exception(Picture, pk=picture_id)
        return picture.moderation_requests.select_related("author")


@api_controller("/sas/relation", tags="User identification on SAS pictures")
class UsersIdentifiedController(ControllerBase):
    @route.delete("/{relation_id}", permissions=[IsAuthenticated])
    def delete_relation(self, relation_id: NonNegativeInt):
        """Untag a user from a SAS picture.

        Root and SAS admins can delete any picture identification.
        All other users can delete their own identification.
        """
        relation = self.get_object_or_exception(PeoplePictureRelation, pk=relation_id)
        user: User = self.context.request.user
        if (
            relation.user_id != user.id
            and not user.is_root
            and not user.is_in_group(pk=settings.SITH_GROUP_SAS_ADMIN_ID)
        ):
            raise PermissionDenied
        relation.delete()