Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Allow users with right permissions to delete exercise entries over the API

Roland Geider15eac4cefb3d
diff --git a/wger/core/api/views.py b/wger/core/api/views.py
index f5b1861fe..28c02c565 100644
--- a/wger/core/api/views.py
+++ b/wger/core/api/views.py
@@ -31,7 +31,10 @@ from rest_framework import (
viewsets,
)
from rest_framework.decorators import action
-from rest_framework.permissions import AllowAny, IsAuthenticated
+from rest_framework.permissions import (
+ AllowAny,
+ IsAuthenticated,
+)
from rest_framework.response import Response
# wger
@@ -75,7 +78,10 @@ class UserProfileViewSet(viewsets.ModelViewSet):
the profile, use a POST request with the new data, not a PATCH.
"""
serializer_class = UserprofileSerializer
- permission_classes = (IsAuthenticated, WgerPermission, )
+ permission_classes = (
+ IsAuthenticated,
+ WgerPermission,
+ )
def get_queryset(self):
"""
diff --git a/wger/core/api/viewsets.py b/wger/core/api/viewsets.py
deleted file mode 100644
index b5377f53c..000000000
--- a/wger/core/api/viewsets.py
+++ /dev/null
@@ -1,32 +0,0 @@
-# This file is part of wger Workout Manager <https://github.com/wger-project>.
-# Copyright (C) 2013 - 2021 wger Team
-#
-# wger Workout Manager is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# wger Workout Manager is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-# Third Party
-from rest_framework import mixins
-from rest_framework.viewsets import GenericViewSet
-
-
-class CreateUpdateModelViewSet(
- mixins.CreateModelMixin,
- mixins.RetrieveModelMixin,
- mixins.UpdateModelMixin,
- mixins.ListModelMixin,
- GenericViewSet,
-):
- """
- This is basically a copy of ModelViewSet, but without support for DELETE
- """
- pass
diff --git a/wger/core/templatetags/wger_extras.py b/wger/core/templatetags/wger_extras.py
index f6b215095..15f51bccd 100644
--- a/wger/core/templatetags/wger_extras.py
+++ b/wger/core/templatetags/wger_extras.py
@@ -48,7 +48,7 @@ def get_current_settings(exercise, set_id):
the template, and we are only interested on the settings that belong to the current
set
"""
- return exercise.setting_set.filter(set_id=set_id)
+ return exercise.exercise_base.setting_set.filter(set_id=set_id)
@register.inclusion_tag('tags/render_day.html')
diff --git a/wger/exercises/api/permissions.py b/wger/exercises/api/permissions.py
index 919eadef0..c54b7bafb 100644
--- a/wger/exercises/api/permissions.py
+++ b/wger/exercises/api/permissions.py
@@ -17,14 +17,22 @@
from rest_framework.permissions import BasePermission
-class CanEditExercises(BasePermission):
+class CanContributeExercises(BasePermission):
"""
Checks that users are allowed to create or edit an exercise.
Regular users that are "trustworthy" (see Userprofile model for details) and
- administrator users with the appropriate exercise permission are allowed.
+ administrator users with the appropriate exercise permission are allowed to
+ perform CRUD operations
+
+ TODO: at the moment the "exercises.delete_exercise" is hard coded here
+ and while it is enough and works, ideally we would want to set the
+ individual permissions for e.g. aliases or videos.
"""
+
SAFE_METHODS = ['GET', 'HEAD', 'OPTIONS']
+ ADD_METHODS = ['POST', 'PUT', 'PATCH']
+ DELETE_METHODS = ['DELETE']
def has_permission(self, request, view):
@@ -32,12 +40,17 @@ class CanEditExercises(BasePermission):
if request.method in self.SAFE_METHODS:
return True
- # Only logged-in users can edit
+ # Only logged-in users can perform CRUD operations
if not request.user.is_authenticated:
return False
- # Only "trustworthy" users can edit
- return (
- request.user.userprofile.is_trustworthy
- or request.user.has_perm('exercises.add_exercise')
- )
+ # Creating or updating
+ if request.method in self.ADD_METHODS:
+ return (
+ request.user.userprofile.is_trustworthy
+ or request.user.has_perm('exercises.add_exercise')
+ )
+
+ # Only admins are allowed to delete entries
+ if request.method in self.DELETE_METHODS:
+ return request.user.has_perm('exercises.delete_exercise')
diff --git a/wger/exercises/api/serializers.py b/wger/exercises/api/serializers.py
index 6a5c4ed24..368bbaac9 100644
--- a/wger/exercises/api/serializers.py
+++ b/wger/exercises/api/serializers.py
@@ -234,15 +234,8 @@ class ExerciseTranslationBaseInfoSerializer(serializers.ModelSerializer):
class Meta:
model = Exercise
fields = (
- "id",
- "uuid",
- "name",
- "exercise_base",
- "description",
- "creation_date",
- "language",
- "aliases",
- "notes"
+ "id", "uuid", "name", "exercise_base", "description", "creation_date", "language",
+ "aliases", "notes"
)
diff --git a/wger/exercises/api/views.py b/wger/exercises/api/views.py
index 158439c3d..e936ac908 100644
--- a/wger/exercises/api/views.py
+++ b/wger/exercises/api/views.py
@@ -36,11 +36,11 @@ from rest_framework.decorators import (
api_view,
)
from rest_framework.response import Response
+from rest_framework.viewsets import ModelViewSet
# wger
from wger.config.models import LanguageConfig
-from wger.core.api.viewsets import CreateUpdateModelViewSet
-from wger.exercises.api.permissions import CanEditExercises
+from wger.exercises.api.permissions import CanContributeExercises
from wger.exercises.api.serializers import (
EquipmentSerializer,
ExerciseAliasSerializer,
@@ -80,14 +80,14 @@ from wger.utils.language import load_item_languages
logger = logging.getLogger(__name__)
-class ExerciseBaseViewSet(CreateUpdateModelViewSet):
+class ExerciseBaseViewSet(ModelViewSet):
"""
API endpoint for exercise base objects. For a read-only endpoint with all
the information of an exercise, see /api/v2/exercisebaseinfo/
"""
queryset = ExerciseBase.objects.all()
serializer_class = ExerciseBaseSerializer
- permission_classes = (CanEditExercises, )
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = (
'category',
@@ -119,12 +119,12 @@ class ExerciseBaseViewSet(CreateUpdateModelViewSet):
)
-class ExerciseTranslationViewSet(CreateUpdateModelViewSet):
+class ExerciseTranslationViewSet(ModelViewSet):
"""
API endpoint for editing or adding exercise objects.
"""
queryset = Exercise.objects.all()
- permission_classes = (CanEditExercises, )
+ permission_classes = (CanContributeExercises, )
serializer_class = ExerciseTranslationSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -193,7 +193,7 @@ class ExerciseViewSet(viewsets.ReadOnlyModelViewSet):
the information of an exercise, see /api/v2/exerciseinfo/
"""
queryset = Exercise.objects.all()
- permission_classes = (CanEditExercises, )
+ permission_classes = (CanContributeExercises, )
serializer_class = ExerciseSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -379,14 +379,14 @@ class ExerciseCategoryViewSet(viewsets.ReadOnlyModelViewSet):
return super().dispatch(request, *args, **kwargs)
-class ExerciseImageViewSet(CreateUpdateModelViewSet):
+class ExerciseImageViewSet(ModelViewSet):
"""
API endpoint for exercise image objects
"""
queryset = ExerciseImage.objects.all()
serializer_class = ExerciseImageSerializer
- permission_classes = (CanEditExercises, )
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = (
'is_main',
@@ -458,12 +458,12 @@ class ExerciseVideoViewSet(viewsets.ReadOnlyModelViewSet):
)
-class ExerciseCommentViewSet(CreateUpdateModelViewSet):
+class ExerciseCommentViewSet(ModelViewSet):
"""
API endpoint for exercise comment objects
"""
serializer_class = ExerciseCommentSerializer
- permission_classes = (CanEditExercises, )
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = ('comment', 'exercise')
@@ -499,24 +499,24 @@ class ExerciseCommentViewSet(CreateUpdateModelViewSet):
)
-class ExerciseAliasViewSet(CreateUpdateModelViewSet):
+class ExerciseAliasViewSet(ModelViewSet):
"""
API endpoint for exercise aliases objects
"""
serializer_class = ExerciseAliasSerializer
queryset = Alias.objects.all()
- permission_classes = (CanEditExercises, )
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = ('alias', 'exercise')
-class ExerciseVariationViewSet(CreateUpdateModelViewSet):
+class ExerciseVariationViewSet(ModelViewSet):
"""
API endpoint for exercise variation objects
"""
serializer_class = ExerciseVariationSerializer
queryset = Variation.objects.all()
- permission_classes = (CanEditExercises, )
+ permission_classes = (CanContributeExercises, )
class MuscleViewSet(viewsets.ReadOnlyModelViewSet):
diff --git a/wger/exercises/models/exercise_alias.py b/wger/exercises/models/exercise_alias.py
index c5b08edc9..fa9d6a384 100644
--- a/wger/exercises/models/exercise_alias.py
+++ b/wger/exercises/models/exercise_alias.py
@@ -51,7 +51,7 @@ class Alias(models.Model):
"""
Reset cached workouts
"""
- for setting in self.exercise.setting_set.all():
+ for setting in self.exercise.exercise_base.setting_set.all():
reset_workout_canonical_form(setting.set.exerciseday.training.pk)
super(Alias, self).delete(*args, **kwargs)
diff --git a/wger/exercises/tests/test_exercise_comments.py b/wger/exercises/tests/test_exercise_comments.py
index 0b7a1e69a..0ca16b7fe 100644
--- a/wger/exercises/tests/test_exercise_comments.py
+++ b/wger/exercises/tests/test_exercise_comments.py
@@ -17,7 +17,7 @@ from django.core.cache import cache
from django.urls import reverse
# wger
-from wger.core.tests import api_base_test
+from wger.core.tests.api_base_test import ExerciseCrudApiTestCase
from wger.core.tests.base_testcase import (
WgerAddTestCase,
WgerEditTestCase,
@@ -154,14 +154,12 @@ class WorkoutCacheTestCase(WgerTestCase):
self.assertFalse(cache.get(cache_mapper.get_workout_canonical(workout_id)))
-class ExerciseCommentApiTestCase(api_base_test.ApiBaseResourceTestCase):
+class ExerciseCommentApiTestCase(ExerciseCrudApiTestCase):
"""
Tests the exercise comment overview resource
"""
pk = 1
resource = ExerciseComment
- private_resource = False
- protected_resource = True
data = {
"comment": "a cool comment",
"exercise": "1",