Self hosted FLOSS fitness/workout, nutrition and weight tracker
Add permissions and endpoints to manage routine templates
Roland Geider2387f337c36f
diff --git a/wger/manager/api/permissions.py b/wger/manager/api/permissions.pynew file mode 100644index 000000000..167d81f28--- /dev/null+++ b/wger/manager/api/permissions.py@@ -0,0 +1,41 @@+# This file is part of wger Workout Manager.+#+# 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 General Public License for more details.+#+# You should have received a copy of the GNU Affero General Public License+# along with Workout Manager. If not, see <http://www.gnu.org/licenses/>.++# Third Party+from rest_framework import permissions+++class RoutinePermission(permissions.BasePermission):+ """+ Custom routine permissions+ """++ def has_permission(self, request, view):+ """Only allow access to authenticated users"""++ return request.user and request.user.is_authenticated++ def has_object_permission(self, request, view, obj):+ """+ If the routine is a public template, allow read-only access for everyone.+ Otherwise, only the user who created the routine has access.+ """+ if obj.user == request.user:+ return True++ if obj.is_template:+ return request.method in permissions.SAFE_METHODS++ return Falsediff --git a/wger/manager/api/serializers.py b/wger/manager/api/serializers.pyindex 2c1423f29..2abeb2247 100644--- a/wger/manager/api/serializers.py+++ b/wger/manager/api/serializers.py@@ -56,6 +56,8 @@ class RoutineSerializer(serializers.ModelSerializer):'start','end','fit_in_week',+ 'is_template',+ 'is_public',)diff --git a/wger/manager/api/views.py b/wger/manager/api/views.pyindex 04db2e266..7ebb570c6 100644--- a/wger/manager/api/views.py+++ b/wger/manager/api/views.py@@ -22,6 +22,7 @@ from datetime import datetime# Djangofrom django.conf import settingsfrom django.core.cache import cache+from django.db.models import Qfrom django.shortcuts import get_object_or_404# Third Party@@ -36,6 +37,7 @@ from wger.manager.api.filtersets import (BaseConfigFilterSet,WorkoutLogFilterSet,)+from wger.manager.api.permissions import RoutinePermissionfrom wger.manager.api.serializers import (DaySerializer,LogDisplaySerializer,@@ -90,7 +92,7 @@ class RoutineViewSet(viewsets.ModelViewSet):"""serializer_class = RoutineSerializer- is_private = True+ permission_classes = [RoutinePermission]ordering_fields = '__all__'filterset_fields = ('name',@@ -98,6 +100,8 @@ class RoutineViewSet(viewsets.ModelViewSet):'created','start','end',+ 'is_public',+ 'is_template',)def get_queryset(self):@@ -108,7 +112,7 @@ class RoutineViewSet(viewsets.ModelViewSet):if getattr(self, 'swagger_fake_view', False):return Routine.objects.none()- return Routine.objects.filter(user=self.request.user)+ return Routine.objects.filter(Q(user=self.request.user) | Q(is_public=True))def perform_create(self, serializer):"""@@ -287,15 +291,15 @@ class WorkoutViewSet(viewsets.ModelViewSet):return Response({'chart_data': json.loads(chart_data), 'logs': serialized_logs})-class UserWorkoutTemplateViewSet(viewsets.ReadOnlyModelViewSet):+class UserRoutineTemplateViewSet(viewsets.ReadOnlyModelViewSet):"""API endpoint for routine template objects"""- serializer_class = WorkoutTemplateSerializer+ serializer_class = RoutineSerializeris_private = Trueordering_fields = '__all__'- filterset_fields = ('name', 'description', 'creation_date')+ filterset_fields = ('name', 'description', 'created')def get_queryset(self):"""@@ -307,34 +311,22 @@ class UserWorkoutTemplateViewSet(viewsets.ReadOnlyModelViewSet):return Routine.templates.filter(user=self.request.user)- def perform_create(self, serializer):- """- Set the owner- """- serializer.save(user=self.request.user)--class PublicWorkoutTemplateViewSet(viewsets.ModelViewSet):+class PublicRoutineTemplateViewSet(viewsets.ReadOnlyModelViewSet):"""- API endpoint for public workout templates objects+ API endpoint for public routine templates objects"""- serializer_class = WorkoutSerializer+ serializer_class = RoutineSerializeris_private = Trueordering_fields = '__all__'- filterset_fields = ('name', 'description', 'creation_date')+ filterset_fields = ('name', 'description', 'created')def get_queryset(self):"""Only allow access to appropriate objects"""- return Routine.templates.filter(is_public=True)-- def perform_create(self, serializer):- """- Set the owner- """- serializer.save(user=self.request.user)+ return Routine.public.all()class WorkoutSessionViewSet(WgerOwnerObjectModelViewSet):diff --git a/wger/manager/fixtures/test-routine-data.json b/wger/manager/fixtures/test-routine-data.jsonindex 361efc0b2..a63fce556 100644--- a/wger/manager/fixtures/test-routine-data.json+++ b/wger/manager/fixtures/test-routine-data.json@@ -9,7 +9,9 @@"created": "2024-03-01T23:34:30+01:00","start": "2024-03-01","end": "2024-06-01",- "fit_in_week": false+ "fit_in_week": false,+ "is_template": false,+ "is_public": false}},{@@ -22,7 +24,9 @@"created": "2024-03-01T23:34:30+01:00","start": "2024-03-01","end": "2024-03-01",- "fit_in_week": false+ "fit_in_week": false,+ "is_template": false,+ "is_public": false}},{@@ -35,7 +39,39 @@"created": "2024-03-01T23:34:30+01:00","start": "2024-03-01","end": "2024-03-01",- "fit_in_week": false+ "fit_in_week": false,+ "is_template": false,+ "is_public": false+ }+ },+ {+ "pk": 4,+ "model": "manager.routine",+ "fields": {+ "user": 2,+ "name": "Private template",+ "description": "",+ "created": "2024-03-01T23:34:30+01:00",+ "start": "2024-03-01",+ "end": "2024-03-01",+ "fit_in_week": false,+ "is_template": true,+ "is_public": false+ }+ },+ {+ "pk": 5,+ "model": "manager.routine",+ "fields": {+ "user": 5,+ "name": "Public template",+ "description": "",+ "created": "2024-03-01T23:34:30+01:00",+ "start": "2024-03-01",+ "end": "2024-03-01",+ "fit_in_week": false,+ "is_template": true,+ "is_public": true}},{diff --git a/wger/manager/managers.py b/wger/manager/managers.pyindex 90f50be79..cce286c48 100644--- a/wger/manager/managers.py+++ b/wger/manager/managers.py@@ -58,16 +58,16 @@ class WorkoutLogManager(models.Manager):return self.get_queryset().reps()-class WorkoutManager(models.Manager):+class RoutineManager(models.Manager):def get_queryset(self):- return super().get_queryset().filter(is_template=False)+ return super().get_queryset()-class WorkoutTemplateManager(models.Manager):+class RoutineTemplateManager(models.Manager):def get_queryset(self):return super().get_queryset().filter(is_template=True)-class WorkoutAndTemplateManager(models.Manager):+class PublicRoutineTemplateManager(models.Manager):def get_queryset(self):- return super().get_queryset()+ return super().get_queryset().filter(is_template=True, is_public=True)diff --git a/wger/manager/models/routine.py b/wger/manager/models/routine.pyindex 86129b396..eefa60dd1 100644--- a/wger/manager/models/routine.py+++ b/wger/manager/models/routine.py@@ -36,6 +36,11 @@ from wger.manager.dataclasses import (RoutineLogData,WorkoutDayData,)+from wger.manager.managers import (+ PublicRoutineTemplateManager,+ RoutineManager,+ RoutineTemplateManager,+)from wger.utils.cache import CacheKeyMapper@@ -44,9 +49,9 @@ class Routine(models.Model):Model for a routine"""- # objects = WorkoutManager()- # templates = WorkoutTemplateManager()- # both = WorkoutAndTemplateManager()+ objects = RoutineManager()+ templates = RoutineTemplateManager()+ public = PublicRoutineTemplateManager()class Meta:ordering = [@@ -94,6 +99,7 @@ class Routine(models.Model):default=False,null=False,)+ """Marking a workout as a template will freeze it and allow you to make copies of it"""is_public = models.BooleanField(verbose_name=_('Public template'),@@ -101,6 +107,7 @@ class Routine(models.Model):default=False,null=False,)+ """A public template is available to other users"""fit_in_week = models.BooleanField(default=False,@@ -136,6 +143,13 @@ class Routine(models.Model):if self.end and self.start and self.start > self.end:raise ValidationError(_('The start time cannot be after the end time.'))+ def save(self, *args, **kwargs):+ """The is_public flag cannot be set if the routine is not a template"""+ if self.is_public and not self.is_template:+ self.is_public = False++ super().save(*args, **kwargs)+@propertydef day_sequence(self):"""diff --git a/wger/manager/tests/test_templates.py b/wger/manager/tests/test_templates.pynew file mode 100644index 000000000..578ceab54--- /dev/null+++ b/wger/manager/tests/test_templates.py@@ -0,0 +1,66 @@+# This file is part of wger Workout Manager.+#+# 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 General Public License for more details.+#+# You should have received a copy of the GNU Affero General Public License++# Django+from django.contrib.auth.models import User+from django.urls import reverse++# Third Party+from rest_framework import status++# wger+from wger.core.tests.base_testcase import WgerTestCase+from wger.manager.models.routine import Routine+++class RoutineTemplatesTestCase(WgerTestCase):+ """+ Test the different template access methods+ """++ def test_managers(self):+ """+ Test the db managers on the model+ """+ self.assertEqual(Routine.objects.all().count(), 5)+ self.assertEqual(Routine.templates.all().count(), 2)+ self.assertEqual(Routine.public.all().count(), 1)++ def test_routine_api(self):+ self.client.force_login(User.objects.get(username='test'))+ response = self.client.get(reverse('routine-list'))+ self.assertEqual(response.status_code, status.HTTP_200_OK)+ self.assertEqual(response.data['count'], 4)++ def test_private_template_api(self):+ self.client.force_login(User.objects.get(username='test'))+ response = self.client.get(reverse('templates-list'))+ self.assertEqual(response.status_code, status.HTTP_200_OK)+ self.assertEqual(response.data['count'], 1)++ def test_post_template_api(self):+ self.client.force_login(User.objects.get(username='test'))+ response = self.client.post(reverse('templates-list'), data={})+ self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)++ def test_public_template_api(self):+ self.client.force_login(User.objects.get(username='test'))+ response = self.client.get(reverse('public-templates-list'))+ self.assertEqual(response.status_code, status.HTTP_200_OK)+ self.assertEqual(response.data['count'], 1)++ def test_post_public_template_api(self):+ self.client.force_login(User.objects.get(username='test'))+ response = self.client.post(reverse('public-templates-list'), data={})+ self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)diff --git a/wger/manager/tests/test_weight_log.py b/wger/manager/tests/test_weight_log.pyindex 5d46ce57e..ca4dbb550 100644--- a/wger/manager/tests/test_weight_log.py+++ b/wger/manager/tests/test_weight_log.py@@ -20,6 +20,7 @@ import loggingfrom wger.core.tests import api_base_testfrom wger.manager.models import WorkoutLog+logger = logging.getLogger(__name__)diff --git a/wger/manager/urls.py b/wger/manager/urls.pyindex 93fd99d00..3a1591f91 100644--- a/wger/manager/urls.py+++ b/wger/manager/urls.py@@ -28,6 +28,7 @@ from wger.manager.views import (workout,)+# sub patterns for templatespatterns_templates = [path(diff --git a/wger/manager/views/routine.py b/wger/manager/views/routine.pyindex 83d1f3fce..78b38cdda 100644--- a/wger/manager/views/routine.py+++ b/wger/manager/views/routine.py@@ -45,7 +45,7 @@ def copy_routine(request, pk):"""routine = get_object_or_404(Routine, pk=pk)- if request.user != routine.user:+ if request.user != routine.user and not routine.is_public:return HttpResponseForbidden()def copy_config(configs: List[AbstractChangeConfig], slot_entry: SlotEntry):diff --git a/wger/urls.py b/wger/urls.pyindex f6ebf759f..740802882 100644--- a/wger/urls.py+++ b/wger/urls.py@@ -64,10 +64,10 @@ router = routers.DefaultRouter()# Manager approuter.register(r'workout', manager_api_views.WorkoutViewSet, basename='workout')router.register(r'routine', manager_api_views.RoutineViewSet, basename='routine')-router.register(r'templates', manager_api_views.UserWorkoutTemplateViewSet, basename='templates')+router.register(r'templates', manager_api_views.UserRoutineTemplateViewSet, basename='templates')router.register(r'public-templates',- manager_api_views.PublicWorkoutTemplateViewSet,+ manager_api_views.PublicRoutineTemplateViewSet,basename='public-templates',)router.register(