Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add images to ingredients

Roland Geiderc961283a3b1f
diff --git a/docs/changelog.rst b/docs/changelog.rst
index 4aa1b663c..efb77d793 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -16,6 +16,7 @@ Upgrade steps from 2.0:
* New gallery where users can upload pictures to track their progress `#572`_
* Add templates / centrally managed workouts (thanks `@qwert45hi`_) `#639`_
+* Add ingredient images (thanks `@qwert45hi`_)
* Add comment filed to set for user notes `#702`_
diff --git a/wger/exercises/management/commands/download-exercise-images.py b/wger/exercises/management/commands/download-exercise-images.py
index bed9f3e86..d7c3cb5c1 100644
--- a/wger/exercises/management/commands/download-exercise-images.py
+++ b/wger/exercises/management/commands/download-exercise-images.py
@@ -114,29 +114,9 @@ class Command(BaseCommand):
continue
except ExerciseImage.DoesNotExist:
self.stdout.write(' Image not found in local DB, creating now...')
- image = ExerciseImage()
- image.uuid = image_uuid
-
- # Save the downloaded image
- # http://stackoverflow.com/questions/1308386/programmatically-saving-image-to-
- retrieved_image = requests.get(image_data['image'], headers=headers)
-
- # Temporary files on windows don't support the delete attribute
- if os.name == 'nt':
- img_temp = NamedTemporaryFile()
- else:
- img_temp = NamedTemporaryFile(delete=True)
- img_temp.write(retrieved_image.content)
- img_temp.flush()
-
- image.exercise_base = exercise_base
- image.is_main = image_data['is_main']
- image.status = image_data['status']
- image.image.save(
- os.path.basename(os.path.basename(image_data['image'])),
- File(img_temp),
- )
- image.save()
+ retrieved_image = requests.get(image_data['image'], headers=headers)
+ ExerciseImage.from_json(exercise_base, retrieved_image, image_data, headers)
+
self.stdout.write(self.style.SUCCESS(' successfully saved'))
if result['next']:
diff --git a/wger/nutrition/api/serializers.py b/wger/nutrition/api/serializers.py
index 5eed35cae..323700dae 100644
--- a/wger/nutrition/api/serializers.py
+++ b/wger/nutrition/api/serializers.py
@@ -26,7 +26,7 @@ from wger.nutrition.models import (
Meal,
MealItem,
NutritionPlan,
- WeightUnit,
+ WeightUnit, Image,
)
@@ -71,6 +71,30 @@ class WeightUnitSerializer(serializers.ModelSerializer):
fields = ['language', 'name']
+class ImageSerializer(serializers.ModelSerializer):
+ """
+ Image serializer
+ """
+
+ ingredient_uuid = serializers.CharField(source='ingredient.uuid', read_only=True)
+ ingredient_id = serializers.CharField(source='ingredient.id', read_only=True)
+
+ class Meta:
+ model = Image
+ fields = [
+ 'id',
+ 'uuid',
+ 'ingredient_id',
+ 'ingredient_uuid',
+ 'image',
+ 'last_update',
+ 'size',
+ 'source_url',
+ 'license',
+ 'license_author',
+ ]
+
+
class IngredientSerializer(serializers.ModelSerializer):
"""
Ingredient serializer
diff --git a/wger/nutrition/api/views.py b/wger/nutrition/api/views.py
index 0368900e0..2f00fa38d 100644
--- a/wger/nutrition/api/views.py
+++ b/wger/nutrition/api/views.py
@@ -39,7 +39,7 @@ from wger.nutrition.api.serializers import (
MealSerializer,
NutritionPlanInfoSerializer,
NutritionPlanSerializer,
- WeightUnitSerializer,
+ WeightUnitSerializer, ImageSerializer,
)
from wger.nutrition.forms import UnitChooserForm
from wger.nutrition.models import (
@@ -49,7 +49,7 @@ from wger.nutrition.models import (
Meal,
MealItem,
NutritionPlan,
- WeightUnit,
+ WeightUnit, Image,
)
from wger.utils.language import (
load_ingredient_languages,
@@ -177,6 +177,16 @@ def search(request):
return Response(json_response)
+class ImageViewSet(viewsets.ReadOnlyModelViewSet):
+ """
+ API endpoint for ingredient images
+ """
+ queryset = Image.objects.all()
+ serializer_class = ImageSerializer
+ ordering_fields = '__all__'
+ filterset_fields = ('uuid', 'source_url')
+
+
class WeightUnitViewSet(viewsets.ReadOnlyModelViewSet):
"""
API endpoint for weight unit objects
diff --git a/wger/nutrition/models/__init__.py b/wger/nutrition/models/__init__.py
index b9455d3c0..d91a98078 100644
--- a/wger/nutrition/models/__init__.py
+++ b/wger/nutrition/models/__init__.py
@@ -15,6 +15,7 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Local
+from .image import Image
from .ingredient import Ingredient
from .ingredient_category import IngredientCategory
from .ingredient_weight_unit import IngredientWeightUnit
diff --git a/wger/nutrition/models/ingredient.py b/wger/nutrition/models/ingredient.py
index 0d60fcd7c..1fef89936 100644
--- a/wger/nutrition/models/ingredient.py
+++ b/wger/nutrition/models/ingredient.py
@@ -16,21 +16,29 @@
# Standard Library
import logging
+import os
+import pathlib
from decimal import Decimal
# Django
+import uuid as uuid
+
+import requests
from django.conf import settings
from django.contrib.auth.models import User
from django.contrib.sites.models import Site
from django.core import mail
from django.core.cache import cache
from django.core.exceptions import ValidationError
+from django.core.files import File
+from django.core.files.temp import NamedTemporaryFile
from django.core.validators import (
MaxValueValidator,
MinLengthValidator,
MinValueValidator,
)
from django.db import models
+from django.http import HttpRequest
from django.template.loader import render_to_string
from django.urls import reverse
from django.utils import translation
@@ -38,7 +46,9 @@ from django.utils.text import slugify
from django.utils.translation import gettext_lazy as _
# wger
-from wger.core.models import Language
+from requests.utils import default_user_agent
+
+from wger.core.models import Language, License
from wger.utils.cache import cache_mapper
from wger.utils.constants import TWOPLACES
from wger.utils.managers import SubmissionManager
@@ -50,7 +60,8 @@ from wger.utils.models import (
# Local
from ..consts import ENERGY_FACTOR
from .ingredient_category import IngredientCategory
-
+from .image import Image
+from ... import get_version
logger = logging.getLogger(__name__)
@@ -82,13 +93,34 @@ class Ingredient(AbstractSubmissionModel, AbstractLicenseModel, models.Model):
on_delete=models.CASCADE,
)
- creation_date = models.DateField(_('Date'), auto_now_add=True)
+ creation_date = models.DateField(
+ _('Date'),
+ auto_now_add=True,
+ )
+ """Date when the ingredient was created"""
+
+
update_date = models.DateField(
_('Date'),
auto_now=True,
blank=True,
editable=False,
)
+ """Last update time"""
+
+ uuid = models.UUIDField(
+ default=uuid.uuid4,
+ editable=False,
+ verbose_name='UUID',
+ )
+ """Globally unique ID, to identify the ingredient across installations"""
+
+ image = models.OneToOneField(
+ Image,
+ null=True,
+ on_delete=models.CASCADE,
+ )
+ """Image for this ingredient"""
# Product infos
name = models.CharField(
@@ -228,9 +260,9 @@ class Ingredient(AbstractSubmissionModel, AbstractLicenseModel, models.Model):
"""
slug = slugify(self.name)
if not slug:
- return reverse('nutrition:ingredient:view', kwargs={'id': self.id})
+ return reverse('nutrition:ingredient:view', kwargs={'pk': self.id})
else:
- return reverse('nutrition:ingredient:view', kwargs={'id': self.id, 'slug': slug})
+ return reverse('nutrition:ingredient:view', kwargs={'pk': self.id, 'slug': slug})
def clean(self):
"""
@@ -401,3 +433,47 @@ class Ingredient(AbstractSubmissionModel, AbstractLicenseModel, models.Model):
return Decimal(self.energy * 4.184).quantize(TWOPLACES)
else:
return 0
+
+ def get_image(self, request: HttpRequest):
+ """
+ TODO: write this
+ """
+ if self.image:
+ return self.image
+
+ if not request.user.is_authenticated:
+ return
+
+ if self.source_name != 'Open Food Facts':
+ return
+
+ if not settings.WGER_SETTINGS['DOWNLOAD_FROM_OFF']:
+ return
+
+ headers = {'User-agent': default_user_agent(f'wger/{get_version()} - https://github.com/wger-project/flutter')}
+
+ product_data = requests.get(self.source_url, headers=headers).json()
+ image_url: Optional[str] = product_data['product'].get('image_front_url')
+ if not image_url:
+ return
+
+ image_data = product_data['product']['images']
+
+ # Parse the file name: https://images.openfoodfacts.org/images/products/00975957/front_en.5.400.jpg
+ downloaded_image: requests.Response = requests.get(image_url, headers=headers)
+ if downloaded_image.status_code != 200:
+ return
+
+ image_name: str = image_url.rpartition("/")[2].partition(".")[0]
+ try:
+ image_id: str = image_data[image_name]['imgid']
+ uploader_name: str = image_data[image_id]['uploader']
+ except KeyError:
+ return
+
+ #
+ image_data: dict = {'image': os.path.basename(image_url),
+ 'license_author': uploader_name,
+ 'size': len(downloaded_image.content)}
+
+ return Image.from_json(self, downloaded_image, image_data, headers, generate_uuid=True)
diff --git a/wger/nutrition/templates/ingredient/view.html b/wger/nutrition/templates/ingredient/view.html
index 2964a6737..5dc69a050 100644
--- a/wger/nutrition/templates/ingredient/view.html
+++ b/wger/nutrition/templates/ingredient/view.html
@@ -207,6 +207,9 @@ the search.{% endblocktranslate %}
{% endif %}
{% endif %}
+{% if image %}
+ <img src="{{ image.image.url }}" class="img-fluid">
+{% endif %}
{% license_sidebar ingredient.license ingredient.license_author %}
{% endblock %}
diff --git a/wger/nutrition/tests/test_ingredient.py b/wger/nutrition/tests/test_ingredient.py
index 4d3472f0e..22c71f9d6 100644
--- a/wger/nutrition/tests/test_ingredient.py
+++ b/wger/nutrition/tests/test_ingredient.py
@@ -185,7 +185,7 @@ class IngredientDetailTestCase(WgerTestCase):
Tests the ingredient details page
"""
- response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'id': 6}))
+ response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'pk': 6}))
self.assertEqual(response.status_code, 200)
# Correct tab is selected
@@ -203,7 +203,7 @@ class IngredientDetailTestCase(WgerTestCase):
self.assertNotContains(response, 'pending review')
# Non-existent ingredients throw a 404.
- response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'id': 42}))
+ response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'pk': 42}))
self.assertEqual(response.status_code, 404)
def test_ingredient_detail_editor(self):
diff --git a/wger/nutrition/tests/test_submitted_ingredient.py b/wger/nutrition/tests/test_submitted_ingredient.py
index a3be7bc70..233fecd2c 100644
--- a/wger/nutrition/tests/test_submitted_ingredient.py
+++ b/wger/nutrition/tests/test_submitted_ingredient.py
@@ -70,7 +70,7 @@ class IngredientsPendingDetailTestCase(WgerTestCase):
"""
Helper function
"""
- response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'id': 7}))
+ response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'pk': 7}))
self.assertContains(response, 'pending review')
if not fail:
diff --git a/wger/nutrition/urls.py b/wger/nutrition/urls.py
index 299f069e7..4a7abbe4e 100644
--- a/wger/nutrition/urls.py
+++ b/wger/nutrition/urls.py
@@ -157,12 +157,12 @@ patterns_ingredient = [
name='decline',
),
path(
- '<int:id>/view/',
+ '<int:pk>/view/',
ingredient.view,
name='view',
),
path(
- '<int:id>/view/<slug:slug>/',
+ '<int:pk>/view/<slug:slug>/',
ingredient.view,
name='view',
),
diff --git a/wger/nutrition/views/ingredient.py b/wger/nutrition/views/ingredient.py
index e1df021a8..2e73708a7 100644
--- a/wger/nutrition/views/ingredient.py
+++ b/wger/nutrition/views/ingredient.py
@@ -62,7 +62,6 @@ from wger.utils.language import (
load_language,
)
-
logger = logging.getLogger(__name__)
@@ -97,24 +96,25 @@ class IngredientListView(ListView):
return context
-def view(request, id, slug=None):
- template_data = {}
+def view(request, pk, slug=None):
+ context = {}
- ingredient = cache.get(cache_mapper.get_ingredient_key(int(id)))
+ ingredient = cache.get(cache_mapper.get_ingredient_key(int(pk)))
if not ingredient:
- ingredient = get_object_or_404(Ingredient, pk=id)
+ ingredient = get_object_or_404(Ingredient, pk=pk)
cache.set(cache_mapper.get_ingredient_key(ingredient), ingredient)
- template_data['ingredient'] = ingredient
- template_data['form'] = UnitChooserForm(
+ context['ingredient'] = ingredient
+ context['image'] = ingredient.get_image(request)
+ context['form'] = UnitChooserForm(
data={
'ingredient_id': ingredient.id,
'amount': 100,
'unit': None
}
)
- template_data['show_shariff'] = True
- return render(request, 'ingredient/view.html', template_data)
+ context['show_shariff'] = True
+ return render(request, 'ingredient/view.html', context)
class IngredientDeleteView(
@@ -181,7 +181,6 @@ class IngredientCreateView(WgerFormMixin, CreateView):
title = gettext_lazy('Add a new ingredient')
def form_valid(self, form):
-
form.instance.language = load_language()
form.instance.set_author(self.request)
return super(IngredientCreateView, self).form_valid(form)
diff --git a/wger/nutrition/views/unit_ingredient.py b/wger/nutrition/views/unit_ingredient.py
index 852ee4f1a..f348dc97e 100644
--- a/wger/nutrition/views/unit_ingredient.py
+++ b/wger/nutrition/views/unit_ingredient.py
@@ -70,7 +70,7 @@ class WeightUnitIngredientCreateView(
permission_required = 'nutrition.add_ingredientweightunit'
def get_success_url(self):
- return reverse('nutrition:ingredient:view', kwargs={'id': self.kwargs['ingredient_pk']})
+ return reverse('nutrition:ingredient:view', kwargs={'pk': self.kwargs['ingredient_pk']})
def form_valid(self, form):
ingredient = get_object_or_404(Ingredient, pk=self.kwargs['ingredient_pk'])
@@ -107,7 +107,7 @@ class WeightUnitIngredientUpdateView(
permission_required = 'nutrition.add_ingredientweightunit'
def get_success_url(self):
- return reverse('nutrition:ingredient:view', kwargs={'id': self.object.ingredient.id})
+ return reverse('nutrition:ingredient:view', kwargs={'pk': self.object.ingredient.id})
def get_form_class(self):
"""
@@ -140,4 +140,4 @@ class WeightUnitIngredientDeleteView(
permission_required = 'nutrition.add_ingredientweightunit'
def get_success_url(self):
- return reverse('nutrition:ingredient:view', kwargs={'id': self.object.ingredient.id})
+ return reverse('nutrition:ingredient:view', kwargs={'pk': self.object.ingredient.id})
diff --git a/wger/settings_global.py b/wger/settings_global.py
index c432a393e..d2f30614b 100644
--- a/wger/settings_global.py
+++ b/wger/settings_global.py
@@ -428,5 +428,6 @@ WGER_SETTINGS = {
'ALLOW_REGISTRATION': True,
'ALLOW_GUEST_USERS': True,
'EMAIL_FROM': 'wger Workout Manager <[email protected]>',
- 'TWITTER': False
+ 'TWITTER': False,
+ 'DOWNLOAD_FROM_OFF': False
}
diff --git a/wger/urls.py b/wger/urls.py
index f9542cf8c..2fd335e0f 100644
--- a/wger/urls.py
+++ b/wger/urls.py
@@ -122,6 +122,7 @@ router.register(
router.register(r'nutritiondiary', nutrition_api_views.LogItemViewSet, basename='nutritiondiary')
router.register(r'meal', nutrition_api_views.MealViewSet, basename='meal')
router.register(r'mealitem', nutrition_api_views.MealItemViewSet, basename='mealitem')
+router.register(r'ingredientimage', nutrition_api_views.ImageViewSet, basename='ingredientimage')
# Weight app
router.register(r'weightentry', weight_api_views.WeightEntryViewSet, basename='weightentry')
diff --git a/wger/utils/tests/test_middleware.py b/wger/utils/tests/test_middleware.py
index 9750abec4..ae84f8820 100644
--- a/wger/utils/tests/test_middleware.py
+++ b/wger/utils/tests/test_middleware.py
@@ -64,7 +64,7 @@ class RobotsExclusionMiddlewareTestCase(WgerTestCase):
response = self.client.get(reverse('nutrition:ingredient:list'))
self.assertFalse(response.get('X-Robots-Tag'))
- response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'id': 1}))
+ response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'pk': 1}))
self.assertFalse(response.get('X-Robots-Tag'))
response = self.client.get(reverse('nutrition:plan:overview'))