from django.db.models import Prefetch from drf_spectacular.utils import extend_schema from rest_framework import mixins, status, viewsets from rest_framework.decorators import action from rest_framework.response import Response from config import plugins from funkwhale_api.activity import record from funkwhale_api.common import fields, permissions from funkwhale_api.music import utils as music_utils from funkwhale_api.music.models import Track from funkwhale_api.users.oauth import permissions as oauth_permissions from . import filters, models, serializers class TrackFavoriteViewSet( mixins.CreateModelMixin, mixins.DestroyModelMixin, mixins.ListModelMixin, viewsets.GenericViewSet, ): filterset_class = filters.TrackFavoriteFilter serializer_class = serializers.UserTrackFavoriteSerializer queryset = models.TrackFavorite.objects.all().select_related( "user__actor__attachment_icon" ) permission_classes = [ oauth_permissions.ScopePermission, permissions.OwnerPermission, ] required_scope = "favorites" anonymous_policy = "setting" owner_checks = ["write"] def get_serializer_class(self): if self.request.method.lower() in ["head", "get", "options"]: return serializers.UserTrackFavoriteSerializer return serializers.UserTrackFavoriteWriteSerializer @extend_schema(operation_id="favorite_track") def create(self, request, *args, **kwargs): serializer = self.get_serializer(data=request.data) serializer.is_valid(raise_exception=True) instance = self.perform_create(serializer) serializer = self.get_serializer(instance=instance) headers = self.get_success_headers(serializer.data) plugins.trigger_hook( plugins.FAVORITE_CREATED, track_favorite=serializer.instance, confs=plugins.get_confs(self.request.user), ) record.send(instance) return Response( serializer.data, status=status.HTTP_201_CREATED, headers=headers ) def get_queryset(self): queryset = super().get_queryset() queryset = queryset.filter( fields.privacy_level_query(self.request.user, "user__privacy_level") ) tracks = Track.objects.with_playable_uploads( music_utils.get_actor_from_request(self.request) ).select_related( "artist", "album__artist", "attributed_to", "album__attachment_cover" ) queryset = queryset.prefetch_related(Prefetch("track", queryset=tracks)) return queryset def perform_create(self, serializer): track = Track.objects.get(pk=serializer.data["track"]) favorite = models.TrackFavorite.add(track=track, user=self.request.user) return favorite @extend_schema(operation_id="unfavorite_track") @action(methods=["delete", "post"], detail=False) def remove(self, request, *args, **kwargs): try: pk = int(request.data["track"]) favorite = request.user.track_favorites.get(track__pk=pk) except (AttributeError, ValueError, models.TrackFavorite.DoesNotExist): return Response({}, status=400) favorite.delete() plugins.trigger_hook( plugins.FAVORITE_DELETED, track_favorite=favorite, confs=plugins.get_confs(self.request.user), ) return Response([], status=status.HTTP_204_NO_CONTENT) @extend_schema( responses=serializers.AllFavoriteSerializer(), operation_id="get_all_favorite_tracks", ) @action(methods=["get"], detail=False) def all(self, request, *args, **kwargs): """ Return all the favorites of the current user, with only limited data to have a performant endpoint and avoid lots of queries just to display favorites status in the UI """ if not request.user.is_authenticated: return Response({"results": [], "count": 0}, status=401) favorites = request.user.track_favorites.values("id", "track").order_by("id") payload = serializers.AllFavoriteSerializer(favorites).data return Response(payload, status=200)