Merge branch 'develop'

Author: vabene1111

.env.template

@@ -97,7 +97,7 @@ GUNICORN_MEDIA=0
 # ACCOUNT_EMAIL_SUBJECT_PREFIX=
 
 # allow authentication via reverse proxy (e.g. authelia), leave off if you dont know what you are doing
-# see docs for more information https://vabene1111.github.io/recipes/features/authentication/
+# see docs for more information https://docs.tandoor.dev/features/authentication/
 # when unset: 0 (false)
 REVERSE_PROXY_AUTH=0
 
@@ -126,7 +126,7 @@ REVERSE_PROXY_AUTH=0
 # ENABLE_METRICS=0
 
 # allows you to setup OAuth providers
-# see docs for more information https://vabene1111.github.io/recipes/features/authentication/
+# see docs for more information https://docs.tandoor.dev/features/authentication/
 # SOCIAL_PROVIDERS = allauth.socialaccount.providers.github, allauth.socialaccount.providers.nextcloud,
 
 # Should a newly created user from a social provider get assigned to the default space and given permission by default ?

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: Continuous Integration
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:
@@ -14,13 +14,13 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python 3.10
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: '3.10'
     # Build Vue frontend
-    - uses: actions/setup-node@v2
+    - uses: actions/setup-node@v3
       with:
-        node-version: '14'
+        node-version: '16'
     - name: Install Vue dependencies
       working-directory: ./vue
       run: yarn install
@@ -30,7 +30,7 @@ jobs:
     - name: Install Django dependencies
       run: |
         sudo apt-get -y update
-        sudo apt-get install -y libsasl2-dev python-dev libldap2-dev libssl-dev
+        sudo apt-get install -y libsasl2-dev python3-dev libldap2-dev libssl-dev
         python -m pip install --upgrade pip
         pip install -r requirements.txt
         python3 manage.py collectstatic --noinput

.gitignore

@@ -84,3 +84,4 @@ cookbook/static/vue
 vue/webpack-stats.json
 cookbook/templates/sw.js
 .prettierignore
+vue/.yarn

.idea/recipes.iml

@@ -6,4 +6,4 @@ Since this software is still considered beta/WIP support is always only given fo
 
 ## Reporting a Vulnerability
 
-Please open a normal public issue if you have any security related concerns. If you feel like the issue should not be discussed in public just open a generic issue and we will discuss further communication there (since GitHub does not allow everyone to create a security advisory :/).
+Please use GitHub Security Advisories to report any kind of security vulnerabilities.

SECURITY.md

@@ -36,7 +36,7 @@ def delete_space_action(modeladmin, request, queryset):
 
 
 class SpaceAdmin(admin.ModelAdmin):
-    list_display = ('name', 'created_by', 'max_recipes', 'max_users', 'max_file_storage_mb', 'allow_sharing')
+    list_display = ('name', 'created_by', 'max_recipes', 'max_users', 'max_file_storage_mb', 'allow_sharing', 'use_plural')
     search_fields = ('name', 'created_by__username')
     list_filter = ('max_recipes', 'max_users', 'max_file_storage_mb', 'allow_sharing')
     date_hierarchy = 'created_at'

cookbook/admin.py

@@ -154,6 +154,7 @@ class ImportExportBase(forms.Form):
     COOKBOOKAPP = 'COOKBOOKAPP'
     COPYMETHAT = 'COPYMETHAT'
     COOKMATE = 'COOKMATE'
+    REZEPTSUITEDE = 'REZEPTSUITEDE'
     PDF = 'PDF'
 
     type = forms.ChoiceField(choices=(
@@ -162,7 +163,7 @@ class ImportExportBase(forms.Form):
         (PEPPERPLATE, 'Pepperplate'), (RECETTETEK, 'RecetteTek'), (RECIPESAGE, 'Recipe Sage'), (DOMESTICA, 'Domestica'),
         (MEALMASTER, 'MealMaster'), (REZKONV, 'RezKonv'), (OPENEATS, 'Openeats'), (RECIPEKEEPER, 'Recipe Keeper'),
         (PLANTOEAT, 'Plantoeat'), (COOKBOOKAPP, 'CookBookApp'), (COPYMETHAT, 'CopyMeThat'), (PDF, 'PDF'), (MELARECIPES, 'Melarecipes'),
-        (COOKMATE, 'Cookmate')
+        (COOKMATE, 'Cookmate'), (REZEPTSUITEDE, 'Recipesuite.de')
     ))
 
 
@@ -533,11 +534,13 @@ def __init__(self, *args, **kwargs):
     class Meta:
         model = Space
 
-        fields = ('food_inherit', 'reset_food_inherit', 'show_facet_count')
+        fields = ('food_inherit', 'reset_food_inherit', 'show_facet_count', 'use_plural')
 
         help_texts = {
             'food_inherit': _('Fields on food that should be inherited by default.'),
-            'show_facet_count': _('Show recipe counts on search filters'), }
+            'show_facet_count': _('Show recipe counts on search filters'), 
+            'use_plural': _('Use the plural form for units and food inside this space.'),
+        }
 
         widgets = {
             'food_inherit': MultiSelectWidget

cookbook/forms.py

@@ -28,7 +28,7 @@ def __init__(self, request, cache_mode, ignore_automations=False):
                 self.food_aliases = c
                 caches['default'].touch(FOOD_CACHE_KEY, 30)
             else:
-                for a in Automation.objects.filter(space=self.request.space, disabled=False, type=Automation.FOOD_ALIAS).only('param_1', 'param_2').all():
+                for a in Automation.objects.filter(space=self.request.space, disabled=False, type=Automation.FOOD_ALIAS).only('param_1', 'param_2').order_by('order').all():
                     self.food_aliases[a.param_1] = a.param_2
                 caches['default'].set(FOOD_CACHE_KEY, self.food_aliases, 30)
 
@@ -37,7 +37,7 @@ def __init__(self, request, cache_mode, ignore_automations=False):
                 self.unit_aliases = c
                 caches['default'].touch(UNIT_CACHE_KEY, 30)
             else:
-                for a in Automation.objects.filter(space=self.request.space, disabled=False, type=Automation.UNIT_ALIAS).only('param_1', 'param_2').all():
+                for a in Automation.objects.filter(space=self.request.space, disabled=False, type=Automation.UNIT_ALIAS).only('param_1', 'param_2').order_by('order').all():
                     self.unit_aliases[a.param_1] = a.param_2
                 caches['default'].set(UNIT_CACHE_KEY, self.unit_aliases, 30)
         else:
@@ -59,7 +59,7 @@ def apply_food_automation(self, food):
                 except KeyError:
                     return food
             else:
-                if automation := Automation.objects.filter(space=self.request.space, type=Automation.FOOD_ALIAS, param_1=food, disabled=False).first():
+                if automation := Automation.objects.filter(space=self.request.space, type=Automation.FOOD_ALIAS, param_1=food, disabled=False).order_by('order').first():
                     return automation.param_2
         return food
 
@@ -78,7 +78,7 @@ def apply_unit_automation(self, unit):
                 except KeyError:
                     return unit
             else:
-                if automation := Automation.objects.filter(space=self.request.space, type=Automation.UNIT_ALIAS, param_1=unit, disabled=False).first():
+                if automation := Automation.objects.filter(space=self.request.space, type=Automation.UNIT_ALIAS, param_1=unit, disabled=False).order_by('order').first():
                     return automation.param_2
         return unit
 
@@ -235,6 +235,10 @@ def parse(self, ingredient):
         # leading spaces before commas result in extra tokens, clean them out
         ingredient = ingredient.replace(' ,', ',')
 
+        # handle "(from) - (to)" amounts by using the minimum amount and adding the range to the description
+        # "10.5 - 200 g XYZ" => "100 g XYZ (10.5 - 200)"
+        ingredient = re.sub("^(\d+|\d+[\\.,]\d+) - (\d+|\d+[\\.,]\d+) (.*)", "\\1 \\3 (\\1 - \\2)", ingredient)
+
         # if amount and unit are connected add space in between
         if re.match('([0-9])+([A-z])+\s', ingredient):
             ingredient = re.sub(r'(?<=([a-z])|\d)(?=(?(1)\d|[a-z]))', ' ', ingredient)

cookbook/helper/ingredient_parser.py

@@ -35,6 +35,7 @@
 u'<p>del.icio.us</p>'
 
 """
+from xml.etree.ElementTree import Element
 
 import markdown
 
@@ -64,7 +65,7 @@ def handleMatch(self, m):
             else:
                 url = 'http://' + url
 
-        el = markdown.util.etree.Element("a")
+        el = Element("a")
         el.set('href', url)
         el.text = markdown.util.AtomicString(text)
         return el

cookbook/helper/mdx_urlize.py

@@ -12,7 +12,8 @@
 
 from cookbook.helper import recipe_url_import as helper
 from cookbook.helper.ingredient_parser import IngredientParser
-from cookbook.models import Keyword
+from cookbook.models import Keyword, Automation
+
 
 # from recipe_scrapers._utils import get_minutes  ## temporary until/unless upstream incorporates get_minutes() PR
 
@@ -121,7 +122,13 @@ def get_from_scraper(scrape, request):
         try:
             keywords.append(source_url.replace('http://', '').replace('https://', '').split('/')[0])
         except Exception:
-            pass
+            recipe_json['source_url'] = ''
+
+    try:
+        if scrape.author():
+            keywords.append(scrape.author())
+    except:
+        pass
 
     try:
         recipe_json['keywords'] = parse_keywords(list(set(map(str.casefold, keywords))), request.space)
@@ -139,42 +146,58 @@ def get_from_scraper(scrape, request):
     if len(recipe_json['steps']) == 0:
         recipe_json['steps'].append({'instruction': '', 'ingredients': [], })
 
-    if len(parse_description(description)) > 256:  # split at 256 as long descriptions dont look good on recipe cards
-        recipe_json['steps'][0]['instruction'] = f'*{parse_description(description)}*  \n\n' + recipe_json['steps'][0]['instruction']
+    parsed_description = parse_description(description)
+    # TODO notify user about limit if reached
+    # limits exist to limit the attack surface for dos style attacks
+    automations = Automation.objects.filter(type=Automation.DESCRIPTION_REPLACE, space=request.space, disabled=False).only('param_1', 'param_2', 'param_3').all().order_by('order')[:512]
+    for a in automations:
+        if re.match(a.param_1, (recipe_json['source_url'])[:512]):
+            parsed_description = re.sub(a.param_2, a.param_3, parsed_description, count=1)
+
+    if len(parsed_description) > 256:  # split at 256 as long descriptions don't look good on recipe cards
+        recipe_json['steps'][0]['instruction'] = f'*{parsed_description}*  \n\n' + recipe_json['steps'][0]['instruction']
     else:
-        recipe_json['description'] = parse_description(description)[:512]
+        recipe_json['description'] = parsed_description[:512]
 
     try:
         for x in scrape.ingredients():
-            try:
-                amount, unit, ingredient, note = ingredient_parser.parse(x)
-                ingredient = {
-                    'amount': amount,
-                    'food': {
-                        'name': ingredient,
-                    },
-                    'unit': None,
-                    'note': note,
-                    'original_text': x
-                }
-                if unit:
-                    ingredient['unit'] = {'name': unit, }
-                recipe_json['steps'][0]['ingredients'].append(ingredient)
-            except Exception:
-                recipe_json['steps'][0]['ingredients'].append(
-                    {
-                        'amount': 0,
-                        'unit': None,
+            if x.strip() != '':
+                try:
+                    amount, unit, ingredient, note = ingredient_parser.parse(x)
+                    ingredient = {
+                        'amount': amount,
                         'food': {
-                            'name': x,
+                            'name': ingredient,
                         },
-                        'note': '',
+                        'unit': None,
+                        'note': note,
                         'original_text': x
                     }
-                )
+                    if unit:
+                        ingredient['unit'] = {'name': unit, }
+                    recipe_json['steps'][0]['ingredients'].append(ingredient)
+                except Exception:
+                    recipe_json['steps'][0]['ingredients'].append(
+                        {
+                            'amount': 0,
+                            'unit': None,
+                            'food': {
+                                'name': x,
+                            },
+                            'note': '',
+                            'original_text': x
+                        }
+                    )
     except Exception:
         pass
 
+    if recipe_json['source_url']:
+        automations = Automation.objects.filter(type=Automation.INSTRUCTION_REPLACE, space=request.space, disabled=False).only('param_1', 'param_2', 'param_3').order_by('order').all()[:512]
+        for a in automations:
+            if re.match(a.param_1, (recipe_json['source_url'])[:512]):
+                for s in recipe_json['steps']:
+                    s['instruction'] = re.sub(a.param_2, a.param_3, s['instruction'])
+
     return recipe_json