typo

Update .env.template

.dockerignore

@@ -7,4 +7,11 @@ docker-compose*
 .gitignore
 README.md
 LICENSE
-.vscode
+.vscode
+.env
+.env.template
+.github
+.idea
+LICENSE.md
+docs
+update.sh

.env.template

@@ -1,14 +1,59 @@
-VIRTUAL_HOST=
-LETSENCRYPT_HOST=
-LETSENCRYPT_EMAIL=
+# only set this to true when testing/debugging
+# when unset: 1 (true) - dont unset this, just for development
+DEBUG=0
 
-DEBUG=1
+# hosts the application can run under e.g. recipes.mydomain.com,cooking.mydomain.com,...
 ALLOWED_HOSTS=*
+
+# random secret key, use for example `base64 /dev/urandom | head -c50` to generate one
 SECRET_KEY=
 
-DB_ENGINE=django.db.backends.postgresql_psycopg2
+# your default timezone See https://timezonedb.com/time-zones for a list of timezones
+TIMEZONE=Europe/Berlin
+
+# add only a database password if you want to run with the default postgres, otherwise change settings accordingly
+DB_ENGINE=django.db.backends.postgresql
 POSTGRES_HOST=db_recipes
 POSTGRES_PORT=5432
-POSTGRES_USER=djangodb
+POSTGRES_USER=djangouser
 POSTGRES_PASSWORD=
-POSTGRES_DB=djangodb
+POSTGRES_DB=djangodb
+
+# the default value for the user preference 'fractions' (enable/disable fraction support)
+# default: disabled=0
+FRACTION_PREF_DEFAULT=0
+
+# the default value for the user preference 'comments' (enable/disable commenting system)
+# default comments enabled=1
+COMMENT_PREF_DEFAULT=1
+
+# Users can set a amount of time after which the shopping list is refreshed when they are in viewing mode
+# This is the minimum interval users can set. Setting this to low will allow users to refresh very frequently which
+# might cause high load on the server. (Technically they can obviously refresh as often as they want with their own scripts)
+SHOPPING_MIN_AUTOSYNC_INTERVAL=5
+
+# Default for user setting sticky navbar
+#STICKY_NAV_PREF_DEFAULT=1
+
+# If staticfiles are stored at a different location uncomment and change accordingly
+# STATIC_URL=/static/
+
+# If mediafiles are stored at a different location uncomment and change accordingly
+# MEDIA_URL=/media/
+
+# Serve mediafiles directly using gunicorn. Basically everyone recommends not doing this. Please use any of the examples
+# provided that include an additional nxginx container to handle media file serving.
+# If you know what you are doing turn this back on (1) to serve media files using djangos serve() method.
+# when unset: 1 (true) - this is temporary until an appropriate amount of time has passed for everyone to migrate
+GUNICORN_MEDIA=0
+
+# 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/
+# when unset: 0 (false)
+REVERSE_PROXY_AUTH=0
+
+
+# allows you to setup OAuth providers
+# see docs for more information https://vabene1111.github.io/recipes/features/authentication/
+# SOCIAL_PROVIDERS = allauth.socialaccount.providers.github, allauth.socialaccount.providers.nextcloud,
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,15 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Version
+Please provide your current version (can be found on the system page since v0.8.4)
+Version: 
+
+### Bug description
+A clear and concise description of what the bug is.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/help-request.md

@@ -0,0 +1,27 @@
+---
+name: Help request
+about: If there is anything wrong with your setup
+title: ''
+labels: setup issue
+assignees: ''
+
+---
+
+### Version
+Please provide your current version (can be found on the system page since v0.8.4)
+Version: 
+
+### Issue
+Please describe your problem here
+
+### `.env`
+Please include your `.env` config file (**make sure to remove/replace all secrets**)
+```
+env content
+```
+
+### `docker-compose.yml`
+When running with docker compose please provide your `docker-compose.yml`
+```
+docker-compose.yml content
+```

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Continous Integration
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        python3 manage.py collectstatic --noinput
+        python3 manage.py collectstatic_js_reverse
+    - name: Django Testing project
+      run: |
+        python3 manage.py test

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,51 @@
+name: "Code scanning - action"
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 13 * * 2'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+      
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    # - name: Autobuild
+    #  uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/docker-publish-beta.yml

@@ -0,0 +1,26 @@
+name: publish beta image docker
+on:
+  push:
+    branches:
+      - 'beta'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Update version file
+        uses: DamianReeves/write-file-action@v1.0
+        with:
+          path: recipes/version.py
+          contents: |
+            VERSION_NUMBER = 'beta'
+            BUILD_REF = '${{ github.sha }}'
+          write-mode: overwrite
+      - name: Build and publish image
+        uses: ilteoood/docker_buildx@master
+        with:
+          publish: true
+          imageName: vabene1111/recipes
+          tag: beta
+          dockerHubUser: ${{ secrets.DOCKER_USERNAME }}
+          dockerHubPassword: ${{ secrets.DOCKER_PASSWORD }}

.github/workflows/docker-publish-dev.yml

@@ -0,0 +1,26 @@
+name: publish dev image docker
+on:
+  push:
+    branches:
+      - '*'
+      - '*/*'
+      - '!master'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Update version file
+        uses: DamianReeves/write-file-action@v1.0
+        with:
+          path: recipes/version.py
+          contents: |
+            VERSION_NUMBER = 'develop'
+            BUILD_REF = '${{ github.sha }}'
+          write-mode: overwrite
+      - name: Publish to Registry
+        uses: elgohr/Publish-Docker-Github-Action@2.13
+        with:
+          name: vabene1111/recipes
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}

.github/workflows/docker-publish-latest.yml

@@ -0,0 +1,30 @@
+name: publish latest image docker
+on:
+  push:
+    tags:
+    - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Get version number
+        id: get_version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+      - name: Update version file
+        uses: DamianReeves/write-file-action@v1.0
+        with:
+          path: recipes/version.py
+          contents: |
+            VERSION_NUMBER = '${{ steps.get_version.outputs.VERSION }}'
+            BUILD_REF = '${{ github.sha }}'
+          write-mode: overwrite
+      - name: Build and publish image
+        uses: ilteoood/docker_buildx@master
+        with:
+          publish: true
+          imageName: vabene1111/recipes
+          tag: latest
+          dockerHubUser: ${{ secrets.DOCKER_USERNAME }}
+          dockerHubPassword: ${{ secrets.DOCKER_PASSWORD }}

.github/workflows/docker-publish-release.yml

@@ -0,0 +1,33 @@
+name: publish tagged release docker
+
+on:
+  push:
+    tags:
+    - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Build image job
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@master
+      - name: Get version number
+        id: get_version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+      - name: Update version file
+        uses: DamianReeves/write-file-action@v1.0
+        with:
+          path: recipes/version.py
+          contents: |
+            VERSION_NUMBER = '${{ steps.get_version.outputs.VERSION }}'
+            BUILD_REF = '${{ github.sha }}'
+          write-mode: overwrite
+      - name: Build and publish image
+        uses: ilteoood/docker_buildx@master
+        with:
+          publish: true
+          imageName: vabene1111/recipes
+          tag: ${{ steps.get_version.outputs.VERSION }}
+          dockerHubUser: ${{ secrets.DOCKER_USERNAME }}
+          dockerHubPassword: ${{ secrets.DOCKER_PASSWORD }}

.github/workflows/docs.yml

@@ -0,0 +1,17 @@
+name: Make Docs
+on:
+  push:
+    branches:
+      - master
+      - develop
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -63,35 +63,18 @@ venv/
 
 mediafiles/
 
-*.sqlite3
+*.sqlite3*
 
 \.idea/workspace\.xml
 
 \.idea/misc\.xml
 
-\.idea/recipes\.iml
-
 # Deployment
 
 \.env
 staticfiles/
- postgresql/
+postgresql/
 
-# User-specific stuff
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
 
-# Generated files
-.idea/**/contentModel.xml
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
+/docker-compose.override.yml
+vue/node_modules

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
+  </state>
+</component>

.idea/dictionaries/vabene1111_PC.xml

@@ -0,0 +1,14 @@
+<component name="ProjectDictionaryState">
+  <dictionary name="vabene1111-PC">
+    <words>
+      <w>autosync</w>
+      <w>chowdown</w>
+      <w>csrftoken</w>
+      <w>gunicorn</w>
+      <w>ical</w>
+      <w>mealie</w>
+      <w>safron</w>
+      <w>traefik</w>
+    </words>
+  </dictionary>
+</component>

.idea/inspectionProfiles/Project_Default.xml

@@ -1,14 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="PyPackageRequirementsInspection" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="ignoredPackages">
-        <value>
-          <list size="1">
-            <item index="0" class="java.lang.String" itemvalue="psycopg2" />
-          </list>
-        </value>
-      </option>
-    </inspection_tool>
-  </profile>
-</component>

.idea/inspectionProfiles/profiles_settings.xml

@@ -1,6 +1,5 @@
 <component name="InspectionProjectProfileManager">
   <settings>
-    <option name="PROJECT_PROFILE" value="Default" />
     <option name="USE_PROJECT_PROFILE" value="false" />
     <version value="1.0" />
   </settings>

.idea/jsLibraryMappings.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JavaScriptLibraryMappings">
-    <file url="file://$PROJECT_DIR$" libraries="{pretty-checkbox}" />
-  </component>
-</project>

.idea/recipes.iml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="django" name="Django">
+      <configuration>
+        <option name="rootFolder" value="$MODULE_DIR$" />
+        <option name="settingsModule" value="recipes/settings.py" />
+        <option name="manageScript" value="$MODULE_DIR$/manage.py" />
+        <option name="environment" value="&lt;map/&gt;" />
+        <option name="doNotUseTestRunner" value="false" />
+        <option name="trackFilePattern" value="migrations" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/cookbook/tests/resources" />
+      <excludeFolder url="file://$MODULE_DIR$/staticfiles" />
+      <excludeFolder url="file://$MODULE_DIR$/venv" />
+    </content>
+    <orderEntry type="jdk" jdkName="Python 3.8 (recipes)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="TemplatesService">
+    <option name="TEMPLATE_CONFIGURATION" value="Django" />
+    <option name="TEMPLATE_FOLDERS">
+      <list>
+        <option value="$MODULE_DIR$/cookbook/templates" />
+      </list>
+    </option>
+  </component>
+</module>

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: local
+    hooks:
+      - id: pre-commit-yarn-build
+        name: Build javascript files
+        entry: yarn --cwd ./vue build
+        always_run: true
+        language: system
+        types: [ python ]
+        pass_filenames: false
+
+#- id: pre-commit-django-migrations
+#        name: Check django migrations
+#        entry: bash -c './venv/bin/activate && ./manage.py makemigrations --check'
+#        language: system
+#        types: [ python ]
+#        pass_filenames: false
+#      - id: pre-commit-django-make-messages
+#        name: Make messages if necessary
+#        entry: ./manage.py makemessages -i venv -a
+#        language: system
+#        types: [ python ]
+#        pass_filenames: false
+#      - id: pre-commit-django-compile-messages
+#        name: Compile messages if necessary
+#        entry: ./manage.py compilemessages -i venv
+#        language: system
+#        types: [ python ]
+#        pass_filenames: false

CONTRIBUTERS.md

@@ -0,0 +1,63 @@
+Many thanks to everyone who contributed to this project! If you add something or help out feel free to add yourself
+to this list.
+
+## Code/Features
+Please have a look at the [list of pull requests](https://github.com/vabene1111/recipes/pulls) for 
+a complete list of contributions.
+Below are some of the larger contributions made yet.
+
+
+- @tourn provided the serving feature and **several** other improvements!
+- @l0c4lh057 provided a much improved ingredient text parser in [#277](https://github.com/vabene1111/recipes/pull/277)
+- @sebimarkgraf added nutritional information [#199](https://github.com/vabene1111/recipes/pull/199)
+- @cazier added reverse proxy authentication [#88](https://github.com/vabene1111/recipes/pull/88)
+
+## Translations
+
+### Catalan 
+[Rubenix](https://www.transifex.com/user/profile/rubenix/)
+
+### Dutch
+[D0T1X](https://www.transifex.com/user/profile/D0T1X/)  
+[ikbenfrank](https://www.transifex.com/user/profile/ikbenfrank/)  
+[kampsj](https://www.transifex.com/user/profile/kampsj/)  
+
+### French
+[jt117](https://www.transifex.com/user/profile/jt117/)  
+[nerdinator](https://www.transifex.com/user/profile/nerdinator/)  
+[agaume](https://www.transifex.com/user/profile/agaume/)  
+
+### German
+[eTaurus](https://www.transifex.com/user/profile/eTaurus/)
+[l0c4lh057](https://www.transifex.com/user/profile/l0c4lh057/)
+
+### Hungarian
+[igazka](https://www.transifex.com/user/profile/igazka/)
+
+### Italian
+[SK3LA](https://www.transifex.com/user/profile/SK3LA/)  
+[auanasgheps](https://www.transifex.com/user/profile/auanasgheps/)  
+
+### Latvian
+[melkypie](https://github.com/melkypie)
+
+### Portuguese
+
+[hds](https://www.transifex.com/user/profile/hds/)  
+[mlopezifu](https://www.transifex.com/user/profile/mlopezifu/)  
+[stormsz](https://www.transifex.com/user/profile/stormsz/)  
+
+### Spanish
+
+[albertocp](https://www.transifex.com/user/profile/albertocp/)  
+[alfa5](https://www.transifex.com/user/profile/alfa5/)  
+[mlopezifu](https://www.transifex.com/user/profile/mlopezifu/)  
+[sergio.laya](https://www.transifex.com/user/profile/sergio.laya/)  
+
+### Turkish
+
+[batmanisnaked](https://www.transifex.com/user/profile/batmanisnaked/)
+
+### Vietnamese
+
+[vuongtrunghieu](https://www.transifex.com/user/profile/vuongtrunghieu/)

Dockerfile

@@ -1,24 +1,18 @@
-FROM ubuntu:18.04
-
-RUN mkdir /Recipes
-WORKDIR /Recipes
-
-ADD . /Recipes/
-
-RUN apt-get update
-RUN apt-get -y upgrade
-RUN apt-get install -y \
-    python3 \
-    python3-pip \
-    postgresql-client \
-    gettext
-
-RUN pip3 install --upgrade pip
-
-RUN pip3 install -r requirements.txt
-
-RUN apt-get autoremove -y
+FROM python:3.8-alpine
 
+RUN apk add --no-cache postgresql-libs gettext zlib libjpeg libxml2-dev libxslt-dev
 ENV PYTHONUNBUFFERED 1
+EXPOSE 8080
 
-EXPOSE 8080
+RUN mkdir /opt/recipes
+WORKDIR /opt/recipes
+COPY . ./
+RUN chmod +x boot.sh
+
+RUN apk add --no-cache --virtual .build-deps gcc musl-dev postgresql-dev zlib-dev jpeg-dev libressl-dev libffi-dev cargo && \
+    python -m venv venv && \
+    /opt/recipes/venv/bin/python -m pip install --upgrade pip && \
+    venv/bin/pip install -r requirements.txt --no-cache-dir &&\
+    apk --purge del .build-deps
+
+ENTRYPOINT ["/opt/recipes/boot.sh"]

LICENSE.md

@@ -1,22 +1,690 @@
+“Commons Clause” License Condition v1.0
+
+The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+
+For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+
+Software: https://github.com/vabene1111/recipes
+
+License:  GNU AFFERO GENERAL PUBLIC LICENSE v3
+
+Licensor: https://github.com/vabene1111
+               
+               
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program 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.
+
+    This program 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 <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.
+
+---
+### Prior 0.10.0
+> All versions released before version 0.10. or 29.06.2020 were licensed under the following license
 
 The MIT License (MIT)
 
-Copyright (c) 2018 
+Copyright (c) 2018
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,68 +1,70 @@
-# Recipes
-Recipes is a django application to manage, tag and search recipes using either built in models or external storage providers hosting PDF's, Images or other files.
+<h1 align="center">
+  <br>
+  <a href="https://app.tandoor.dev"><img src="https://github.com/vabene1111/recipes/raw/develop/docs/logo_color.svg" height="256px" width="256px"></a>
+  <br>
+  Tandoor Recipes
+  <br>
+</h1>
 
-![Preview](preview.png)
+<h4 align="center">The recipe manager that allows you to manage your ever growing collection of digital recipes.</h4>
 
-### Features
+<p align="center">
 
-- :package: Sync files with Dropbox and Nextcloud (more can easily be added)
-- :mag: Powerful search with djangos [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity)
-- :label: Create and search for tags, assign them in batch to all files matching certain filters
-- :page_facing_up: Create recipes locally within a nice, standardized webinterface 
-- :person_with_blond_hair: Share recipes with friends and comment on them to suggest or remember changes you made
-- :whale: Easy setup with Docker
+<img src="https://github.com/vabene1111/recipes/workflows/Continous%20Integration/badge.svg?branch=develop" >
+<img src="https://img.shields.io/github/stars/vabene1111/recipes" >
+<img src="https://img.shields.io/github/forks/vabene1111/recipes" >
+<img src="https://img.shields.io/docker/pulls/vabene1111/recipes" >
 
-This application is meant for people with a collection of recipes they want to share with family and friends or simply store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as a public page.
+</p>
 
-# Documentation
+<p align="center">
+<a href="https://docs.tandoor.dev/install/docker/" target="_blank" rel="noopener noreferrer">Installation</a> •
+<a href="https://docs.tandoor.dev/" target="_blank" rel="noopener noreferrer">Documentation</a> •
+<a href="https://app.tandoor.dev/" target="_blank" rel="noopener noreferrer">Demo</a>
+</p>
 
-Most things should be straight forward but there are some more complicated things.
-##### Storage Backends
-A `Storage Backend` is a remote storage location where files are stored. To add a new backend klick on `Storage Data` and then on `Storage Backends`. There click the plus button.
+![Preview](docs/preview.png)
 
-Enter a name (just a display name for you to identify it) and an API access Token for the account you want to use.
-Dropboxes API tokens can be found on the [Dropboxes API explorer](https://dropbox.github.io/dropbox-api-v2-explorer/#auth_token/from_oauth1)
-with the button on the top right. For Nextcloud you can use a App apssword created in the settings.
+## Features
 
-##### Adding Synced Path's
-To add a new path from your Storage backend to the sync list, go to `Storage Data >> Configure Sync` and select the storage backend you want to use.
-Then enter the path you want to monitor starting at the storage root (e.g. `/Folder/RecipesFolder`) and save it.
+- 📦 **Sync** files with Dropbox and Nextcloud (more can easily be added)
+- 🔍 Powerful **search** with Djangos [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity)
+- 🏷️ Create and search for **tags**, assign them in batch to all files matching certain filters
+- 📄 **Create recipes** locally within a nice, standardized web interface
+- ⬇️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe)
+- 📱 Optimized for use on **mobile** devices like phones and tablets
+- 🛒 Generate **shopping** lists from recipes
+- 📆 Create a **Plan** on what to eat when
+- 👪 **Share** recipes with friends and comment on them to suggest or remember changes you made
+- ➗ automatically convert decimal units to **fractions** for those who like this
+- 🐳 Easy setup with **Docker** and included examples for Kubernetes, Unraid and Synology
+- 🎨 Customize your interface with **themes**
+- ✉️ Export and import recipes from other users
+- 🌍 localized in many languages thanks to the awesome community
+- ➕ Many more like recipe scaling, image compression, cookbooks, printing views, ...
 
-##### Syncing Data
-To sync the recipes app with the storage backends press `Sync now` under `Storage Data >> Configure Sync`.
-##### Import Recipes
-All files found by the sync can be found under `Manage Data >> Import recipes`. There you can either import all at once without modifying them or import one by one, adding tags while importing.
-##### Batch Edit
-If you have many untagged recipes you may want to edit them all at once. For this go to
-`Storage Data >> Batch Edit`. Enter a word which should be contained in the recipe name and select the tags you want to apply.
-When clicking submit every recipe containing the word will be updated (tags are added).
-
-> Currently the only option is word contains, maybe some more SQL like operators will be added later.
-
-## Installation
-
-### Docker-Compose
-When cloning this repository a simple docker-compose file is included. It is made for setups already running an nginx-reverse proxy network with lets encrypt companion but can be changed easily. Copy `.env.template` to `.env` and fill in the missing values accordingly.  
-Now simply start the containers and run the `update.sh` script which will apply all migrations and collect static files.
-Create a default user by executing into the container with `docker-compose exec web_recipes sh` and run `python3 manage.py createsuperuser`.
-
-### Manual
-Copy `.env.template` to `.env` and fill in the missing values accordingly.  
-You can leave out the docker specific variables (VIRTUAL_HOST, LETSENCRYPT_HOST, LETSENCRYPT_EMAIL). 
-Make sure all variables are available to whatever servers your application.
-
-Otherwise simply follow the instructions for any django based deployment
-(for example this one http://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html).
-
-To start developing:
-1. Clone the repository using your preferred method
-2. Install requirements from `requirements.txt` either globally or in a virtual environment
-3. Run migrations with `manage.py migrate`
-4. Create a first user with `manage.py createsuperuser`
-5. Start development server with `manage.py runserver`
-
-## Contributing
-Pull Requests and ideas are welcome, feel free to contribute in any way.
+This application is meant for people with a collection of recipes they want to share with family and friends or simply
+store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as 
+a public page.
+Documentation can be found [here](https://docs.tandoor.dev/).
 
+While this application has been around for a while and is actively used by many (including myself), it is still considered
+**beta** software that has a lot of rough edges and unpolished parts.
 ## License
-This project is licensed under the MIT license. Even though it is not required to publish derivatives i highly encourage pushing changes upstream and letting people profit from any work done on this project.
+
+Beginning with version 0.10.0 the code in this repository is licensed under the [GNU AGPL v3](https://www.gnu.org/licenses/agpl-3.0.de.html) license with an
+[common clause](https://commonsclause.com/) selling exception. See [LICENSE.md](https://github.com/vabene1111/recipes/blob/develop/LICENSE.md) for details.
+
+> NOTE: There appears to be a whole range of legal issues with licensing anything else then the standard completely open licenses.
+> I am in the process of getting some professional legal advice to sort out these issues. 
+> Please also see [Issue 238](https://github.com/vabene1111/recipes/issues/238) for some discussion and **reasoning** regarding the topic.
+
+**Reasoning**  
+**This software and *all* its features are and will always be free for everyone to use and enjoy.**
+
+The reason for the selling exception is that a significant amount of time was spend over multiple years to develop this software.
+A payed hosted version which will be identical in features and code base to the software offered in this repository will
+likely be released in the future (including all features needed to sell a hosted version as they might also be useful for personal use).
+This will not only benefit me personally but also everyone who self-hosts this software as any profits made trough selling the hosted option
+allow me to spend more time developing and improving the software for everyone. Selling exceptions are [approved by Richard Stallman](http://www.gnu.org/philosophy/selling-exceptions.en.html) and the
+common clause license is very permissive (see the [FAQ](https://commonsclause.com/)).

SECURITY.md

@@ -0,0 +1,10 @@
+# Security Policy
+
+## Supported Versions
+
+Since this software is still considered beta/WIP support is always only given for the latest version. There are no backports of security or any other fixes.
+
+## 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 communitcation there (since GitHub does not allow everyone to create a security advisory :/).

boot.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+source venv/bin/activate
+
+echo "Updating database"
+python manage.py migrate
+python manage.py collectstatic_js_reverse
+python manage.py collectstatic --noinput
+echo "Done"
+
+chmod -R 755 /opt/recipes/mediafiles
+
+exec gunicorn -b :8080 --access-logfile - --error-logfile - --log-level INFO recipes.wsgi

cookbook/admin.py

@@ -1,11 +1,205 @@
 from django.contrib import admin
-from .models import *
+
+from .models import (Comment, CookLog, Food, Ingredient, InviteLink, Keyword,
+                     MealPlan, MealType, NutritionInformation, Recipe,
+                     RecipeBook, RecipeBookEntry, RecipeImport, ShareLink,
+                     ShoppingList, ShoppingListEntry, ShoppingListRecipe,
+                     Space, Step, Storage, Sync, SyncLog, Unit, UserPreference,
+                     ViewLog, Supermarket, SupermarketCategory, SupermarketCategoryRelation)
 
 
-admin.site.register(Recipe)
+class SpaceAdmin(admin.ModelAdmin):
+    list_display = ('name', 'message')
+
+
+admin.site.register(Space, SpaceAdmin)
+
+
+class UserPreferenceAdmin(admin.ModelAdmin):
+    list_display = (
+        'name', 'theme', 'nav_color',
+        'default_page', 'search_style', 'comments'
+    )
+
+    @staticmethod
+    def name(obj):
+        return obj.user.get_user_name()
+
+
+admin.site.register(UserPreference, UserPreferenceAdmin)
+
+
+class StorageAdmin(admin.ModelAdmin):
+    list_display = ('name', 'method')
+
+
+admin.site.register(Storage, StorageAdmin)
+
+
+class SyncAdmin(admin.ModelAdmin):
+    list_display = ('storage', 'path', 'active', 'last_checked')
+
+
+admin.site.register(Sync, SyncAdmin)
+
+
+class SupermarketCategoryInline(admin.TabularInline):
+    model = SupermarketCategoryRelation
+
+
+class SupermarketAdmin(admin.ModelAdmin):
+    inlines = (SupermarketCategoryInline,)
+
+
+admin.site.register(Supermarket, SupermarketAdmin)
+admin.site.register(SupermarketCategory)
+
+
+class SyncLogAdmin(admin.ModelAdmin):
+    list_display = ('sync', 'status', 'msg', 'created_at')
+
+
+admin.site.register(SyncLog, SyncLogAdmin)
+
 admin.site.register(Keyword)
 
-admin.site.register(Sync)
-admin.site.register(SyncLog)
-admin.site.register(RecipeImport)
-admin.site.register(Storage)
+
+class StepAdmin(admin.ModelAdmin):
+    list_display = ('name', 'type', 'order')
+
+
+admin.site.register(Step, StepAdmin)
+
+
+class RecipeAdmin(admin.ModelAdmin):
+    list_display = ('name', 'internal', 'created_by', 'storage')
+
+    @staticmethod
+    def created_by(obj):
+        return obj.created_by.get_user_name()
+
+
+admin.site.register(Recipe, RecipeAdmin)
+
+admin.site.register(Unit)
+admin.site.register(Food)
+
+
+class IngredientAdmin(admin.ModelAdmin):
+    list_display = ('food', 'amount', 'unit')
+
+
+admin.site.register(Ingredient, IngredientAdmin)
+
+
+class CommentAdmin(admin.ModelAdmin):
+    list_display = ('recipe', 'name', 'created_at')
+
+    @staticmethod
+    def name(obj):
+        return obj.created_by.get_user_name()
+
+
+admin.site.register(Comment, CommentAdmin)
+
+
+class RecipeImportAdmin(admin.ModelAdmin):
+    list_display = ('name', 'storage', 'file_path')
+
+
+admin.site.register(RecipeImport, RecipeImportAdmin)
+
+
+class RecipeBookAdmin(admin.ModelAdmin):
+    list_display = ('name', 'user_name')
+
+    @staticmethod
+    def user_name(obj):
+        return obj.created_by.get_user_name()
+
+
+admin.site.register(RecipeBook, RecipeBookAdmin)
+
+
+class RecipeBookEntryAdmin(admin.ModelAdmin):
+    list_display = ('book', 'recipe')
+
+
+admin.site.register(RecipeBookEntry, RecipeBookEntryAdmin)
+
+
+class MealPlanAdmin(admin.ModelAdmin):
+    list_display = ('user', 'recipe', 'meal_type', 'date')
+
+    @staticmethod
+    def user(obj):
+        return obj.created_by.get_user_name()
+
+
+admin.site.register(MealPlan, MealPlanAdmin)
+
+
+class MealTypeAdmin(admin.ModelAdmin):
+    list_display = ('name', 'created_by', 'order')
+
+
+admin.site.register(MealType, MealTypeAdmin)
+
+
+class ViewLogAdmin(admin.ModelAdmin):
+    list_display = ('recipe', 'created_by', 'created_at')
+
+
+admin.site.register(ViewLog, ViewLogAdmin)
+
+
+class InviteLinkAdmin(admin.ModelAdmin):
+    list_display = (
+        'username', 'group', 'valid_until',
+        'created_by', 'created_at', 'used_by'
+    )
+
+
+admin.site.register(InviteLink, InviteLinkAdmin)
+
+
+class CookLogAdmin(admin.ModelAdmin):
+    list_display = ('recipe', 'created_by', 'created_at', 'rating', 'servings')
+
+
+admin.site.register(CookLog, CookLogAdmin)
+
+
+class ShoppingListRecipeAdmin(admin.ModelAdmin):
+    list_display = ('id', 'recipe', 'servings')
+
+
+admin.site.register(ShoppingListRecipe, ShoppingListRecipeAdmin)
+
+
+class ShoppingListEntryAdmin(admin.ModelAdmin):
+    list_display = ('id', 'food', 'unit', 'list_recipe', 'checked')
+
+
+admin.site.register(ShoppingListEntry, ShoppingListEntryAdmin)
+
+
+class ShoppingListAdmin(admin.ModelAdmin):
+    list_display = ('id', 'created_by', 'created_at')
+
+
+admin.site.register(ShoppingList, ShoppingListAdmin)
+
+
+class ShareLinkAdmin(admin.ModelAdmin):
+    list_display = ('recipe', 'created_by', 'uuid', 'created_at',)
+
+
+admin.site.register(ShareLink, ShareLinkAdmin)
+
+
+class NutritionInformationAdmin(admin.ModelAdmin):
+    list_display = ('id',)
+
+
+admin.site.register(NutritionInformation, NutritionInformationAdmin)

cookbook/filters.py

@@ -1,15 +1,26 @@
 import django_filters
+from django.conf import settings
 from django.contrib.postgres.search import TrigramSimilarity
 from django.db.models import Q
+from django.utils.translation import gettext as _
+
 from cookbook.forms import MultiSelectWidget
-from cookbook.models import Recipe, Keyword
-from django.conf import settings
+from cookbook.models import Food, Keyword, Recipe, ShoppingList
 
 
 class RecipeFilter(django_filters.FilterSet):
     name = django_filters.CharFilter(method='filter_name')
-    keywords = django_filters.ModelMultipleChoiceFilter(queryset=Keyword.objects.all(), widget=MultiSelectWidget,
-                                                        method='filter_keywords')
+    keywords = django_filters.ModelMultipleChoiceFilter(
+        queryset=Keyword.objects.all(),
+        widget=MultiSelectWidget,
+        method='filter_keywords'
+    )
+    foods = django_filters.ModelMultipleChoiceFilter(
+        queryset=Food.objects.all(),
+        widget=MultiSelectWidget,
+        method='filter_foods',
+        label=_('Ingredients')
+    )
 
     @staticmethod
     def filter_keywords(queryset, name, value):
@@ -19,27 +30,50 @@ class RecipeFilter(django_filters.FilterSet):
             queryset = queryset.filter(keywords=x)
         return queryset
 
+    @staticmethod
+    def filter_foods(queryset, name, value):
+        if not name == 'foods':
+            return queryset
+        for x in value:
+            queryset = queryset.filter(
+                steps__ingredients__food__name=x
+            ).distinct()
+        return queryset
+
     @staticmethod
     def filter_name(queryset, name, value):
         if not name == 'name':
             return queryset
-        if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.postgresql_psycopg2':
-            queryset = queryset.annotate(similarity=TrigramSimilarity('name', value), ).filter(
-                Q(similarity__gt=0.1) | Q(name__icontains=value)).order_by('-similarity')
+        if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.postgresql_psycopg2':  # noqa: E501
+            queryset = queryset \
+                .annotate(similarity=TrigramSimilarity('name', value), ) \
+                .filter(Q(similarity__gt=0.1) | Q(name__unaccent__icontains=value)) \
+                .order_by('-similarity')
         else:
             queryset = queryset.filter(name__icontains=value)
         return queryset
 
     class Meta:
         model = Recipe
-        fields = ['name', 'keywords']
+        fields = ['name', 'keywords', 'foods', 'internal']
 
 
-class QuickRecipeFilter(django_filters.FilterSet):
-    name = django_filters.CharFilter(lookup_expr='contains')
-    keywords = django_filters.ModelMultipleChoiceFilter(queryset=Keyword.objects.all(), widget=MultiSelectWidget,
-                                                        method='filter_keywords')
+class IngredientFilter(django_filters.FilterSet):
+    name = django_filters.CharFilter(lookup_expr='icontains')
 
     class Meta:
-        model = Recipe
-        fields = ['name', 'keywords']
+        model = Food
+        fields = ['name']
+
+
+class ShoppingListFilter(django_filters.FilterSet):
+
+    def __init__(self, data=None, *args, **kwargs):
+        if data is not None:
+            data = data.copy()
+            data.setdefault("finished", False)
+        super(ShoppingListFilter, self).__init__(data, *args, **kwargs)
+
+    class Meta:
+        model = ShoppingList
+        fields = ['finished']

cookbook/forms.py

@@ -1,9 +1,16 @@
 from django import forms
 from django.forms import widgets
-from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy as _
 from emoji_picker.widgets import EmojiPickerTextInput
 
-from .models import *
+from .models import (Comment, Food, InviteLink, Keyword, MealPlan, Recipe,
+                     RecipeBook, RecipeBookEntry, Storage, Sync, Unit, User,
+                     UserPreference)
+
+
+class SelectWidget(widgets.Select):
+    class Media:
+        js = ('custom/js/form_select.js',)
 
 
 class MultiSelectWidget(widgets.SelectMultiple):
@@ -11,14 +18,75 @@ class MultiSelectWidget(widgets.SelectMultiple):
         js = ('custom/js/form_multiselect.js',)
 
 
+# Yes there are some stupid browsers that still dont support this but
+# I dont support people using these browsers.
+class DateWidget(forms.DateInput):
+    input_type = 'date'
+
+    def __init__(self, **kwargs):
+        kwargs["format"] = "%Y-%m-%d"
+        super().__init__(**kwargs)
+
+
+class UserPreferenceForm(forms.ModelForm):
+    prefix = 'preference'
+
+    class Meta:
+        model = UserPreference
+        fields = (
+            'default_unit', 'use_fractions', 'theme', 'nav_color',
+            'sticky_navbar', 'default_page', 'show_recent', 'search_style',
+            'plan_share', 'ingredient_decimals', 'shopping_auto_sync',
+            'comments'
+        )
+
+        help_texts = {
+            'nav_color': _('Color of the top navigation bar. Not all colors work with all themes, just try them out!'),  # noqa: E501
+            'default_unit': _('Default Unit to be used when inserting a new ingredient into a recipe.'),  # noqa: E501
+            'use_fractions': _('Enables support for fractions in ingredient amounts (e.g. convert decimals to fractions automatically)'),  # noqa: E501
+            'plan_share': _('Users with whom newly created meal plan/shopping list entries should be shared by default.'),  # noqa: E501
+            'show_recent': _('Show recently viewed recipes on search page.'),  # noqa: E501
+            'ingredient_decimals': _('Number of decimals to round ingredients.'),  # noqa: E501
+            'comments': _('If you want to be able to create and see comments underneath recipes.'),  # noqa: E501
+            'shopping_auto_sync': _(
+                'Setting to 0 will disable auto sync. When viewing a shopping list the list is updated every set seconds to sync changes someone else might have made. Useful when shopping with multiple people but might use a little bit '  # noqa: E501
+                'of mobile data. If lower than instance limit it is reset when saving.'  # noqa: E501
+            ),
+            'sticky_navbar': _('Makes the navbar stick to the top of the page.')  # noqa: E501
+        }
+
+        widgets = {
+            'plan_share': MultiSelectWidget
+        }
+
+
+class UserNameForm(forms.ModelForm):
+    prefix = 'name'
+
+    class Meta:
+        model = User
+        fields = ('first_name', 'last_name')
+
+        help_texts = {
+            'first_name': _('Both fields are optional. If none are given the username will be displayed instead')  # noqa: E501
+        }
+
+
 class ExternalRecipeForm(forms.ModelForm):
     file_path = forms.CharField(disabled=True, required=False)
-    storage = forms.ModelChoiceField(queryset=Storage.objects.all(), disabled=True, required=False)
+    storage = forms.ModelChoiceField(
+        queryset=Storage.objects.all(),
+        disabled=True,
+        required=False
+    )
     file_uid = forms.CharField(disabled=True, required=False)
 
     class Meta:
         model = Recipe
-        fields = ('name', 'keywords', 'working_time', 'waiting_time', 'file_path', 'storage', 'file_uid')
+        fields = (
+            'name', 'keywords', 'description', 'servings', 'working_time', 'waiting_time',
+            'file_path', 'storage', 'file_uid'
+        )
 
         labels = {
             'name': _('Name'),
@@ -32,20 +100,93 @@ class ExternalRecipeForm(forms.ModelForm):
 
 
 class InternalRecipeForm(forms.ModelForm):
+    ingredients = forms.CharField(widget=forms.HiddenInput(), required=False)
+
     class Meta:
         model = Recipe
-        fields = ('name', 'instructions', 'image', 'working_time', 'waiting_time', 'keywords')
+        fields = (
+            'name', 'image', 'working_time',
+            'waiting_time', 'servings', 'keywords'
+        )
 
         labels = {
             'name': _('Name'),
             'keywords': _('Keywords'),
-            'instructions': _('Instructions'),
             'working_time': _('Preparation time in minutes'),
             'waiting_time': _('Waiting time (cooking/baking) in minutes'),
+            'servings': _('Number of servings'),
         }
         widgets = {'keywords': MultiSelectWidget}
 
 
+class ShoppingForm(forms.Form):
+    recipe = forms.ModelMultipleChoiceField(
+        queryset=Recipe.objects.filter(internal=True).all(),
+        widget=MultiSelectWidget
+    )
+    markdown_format = forms.BooleanField(
+        help_text=_('Include <code>- [ ]</code> in list for easier usage in markdown based documents.'),  # noqa: E501
+        required=False,
+        initial=False
+    )
+
+
+class ImportExportBase(forms.Form):
+    DEFAULT = 'DEFAULT'
+    PAPRIKA = 'PAPRIKA'
+    NEXTCLOUD = 'NEXTCLOUD'
+    MEALIE = 'MEALIE'
+    CHOWDOWN = 'CHOWDOWN'
+    SAFRON = 'SAFRON'
+
+    type = forms.ChoiceField(choices=(
+        (DEFAULT, _('Default')), (PAPRIKA, 'Paprika'), (NEXTCLOUD, 'Nextcloud Cookbook'),
+        (MEALIE, 'Mealie'), (CHOWDOWN, 'Chowdown'), (SAFRON, 'Safron'),
+    ))
+
+
+class ImportForm(ImportExportBase):
+    files = forms.FileField(required=True, widget=forms.ClearableFileInput(attrs={'multiple': True}))
+
+
+class ExportForm(ImportExportBase):
+    recipes = forms.ModelMultipleChoiceField(queryset=Recipe.objects.filter(internal=True).all(), widget=MultiSelectWidget)
+
+
+class UnitMergeForm(forms.Form):
+    prefix = 'unit'
+
+    new_unit = forms.ModelChoiceField(
+        queryset=Unit.objects.all(),
+        widget=SelectWidget,
+        label=_('New Unit'),
+        help_text=_('New unit that other gets replaced by.'),
+    )
+    old_unit = forms.ModelChoiceField(
+        queryset=Unit.objects.all(),
+        widget=SelectWidget,
+        label=_('Old Unit'),
+        help_text=_('Unit that should be replaced.'),
+    )
+
+
+class FoodMergeForm(forms.Form):
+    prefix = 'food'
+
+    new_food = forms.ModelChoiceField(
+        queryset=Food.objects.all(),
+        widget=SelectWidget,
+        label=_('New Food'),
+        help_text=_('New food that other gets replaced by.'),
+    )
+    old_food = forms.ModelChoiceField(
+        queryset=Food.objects.all(),
+        widget=SelectWidget,
+        label=_('Old Food'),
+        help_text=_('Food that should be replaced.'),
+    )
+
+
 class CommentForm(forms.ModelForm):
     prefix = 'comment'
 
@@ -68,22 +209,40 @@ class KeywordForm(forms.ModelForm):
         widgets = {'icon': EmojiPickerTextInput}
 
 
+class FoodForm(forms.ModelForm):
+    class Meta:
+        model = Food
+        fields = ('name', 'description', 'ignore_shopping', 'recipe', 'supermarket_category')
+        widgets = {'recipe': SelectWidget}
+
+
 class StorageForm(forms.ModelForm):
-    username = forms.CharField(widget=forms.TextInput(attrs={'autocomplete': 'new-password'}), required=False)
-    password = forms.CharField(widget=forms.TextInput(attrs={'autocomplete': 'new-password', 'type': 'password'}),
-                               required=False)
-    token = forms.CharField(widget=forms.TextInput(attrs={'autocomplete': 'new-password', 'type': 'password'}),
-                            required=False)
+    username = forms.CharField(
+        widget=forms.TextInput(attrs={'autocomplete': 'new-password'}),
+        required=False
+    )
+    password = forms.CharField(
+        widget=forms.TextInput(
+            attrs={'autocomplete': 'new-password', 'type': 'password'}
+        ),
+        required=False,
+        help_text=_('Leave empty for dropbox and enter app password for nextcloud.')  # noqa: E501
+    )
+    token = forms.CharField(
+        widget=forms.TextInput(
+            attrs={'autocomplete': 'new-password', 'type': 'password'}
+        ),
+        required=False,
+        help_text=_('Leave empty for nextcloud and enter api token for dropbox.')  # noqa: E501
+    )
 
     class Meta:
         model = Storage
-        fields = ('name', 'method', 'username', 'password', 'token', 'url')
+        fields = ('name', 'method', 'username', 'password', 'token', 'url', 'path')
 
-
-class RecipeBookForm(forms.ModelForm):
-    class Meta:
-        model = RecipeBook
-        fields = ('name',)
+        help_texts = {
+            'url': _('Leave empty for dropbox and enter only base url for nextcloud (<code>/remote.php/webdav/</code> is added automatically)'),  # noqa: E501
+        }
 
 
 class RecipeBookEntryForm(forms.ModelForm):
@@ -102,8 +261,11 @@ class SyncForm(forms.ModelForm):
 
 class BatchEditForm(forms.Form):
     search = forms.CharField(label=_('Search String'))
-    keywords = forms.ModelMultipleChoiceField(queryset=Keyword.objects.all().order_by('id'), required=False,
-                                              widget=MultiSelectWidget)
+    keywords = forms.ModelMultipleChoiceField(
+        queryset=Keyword.objects.all().order_by('id'),
+        required=False,
+        widget=MultiSelectWidget
+    )
 
 
 class ImportRecipeForm(forms.ModelForm):
@@ -118,3 +280,64 @@ class ImportRecipeForm(forms.ModelForm):
             'file_uid': _('File ID'),
         }
         widgets = {'keywords': MultiSelectWidget}
+
+
+class RecipeBookForm(forms.ModelForm):
+    class Meta:
+        model = RecipeBook
+        fields = ('name', 'icon', 'description', 'shared')
+        widgets = {'icon': EmojiPickerTextInput, 'shared': MultiSelectWidget}
+
+
+class MealPlanForm(forms.ModelForm):
+
+    def clean(self):
+        cleaned_data = super(MealPlanForm, self).clean()
+
+        if cleaned_data['title'] == '' and cleaned_data['recipe'] is None:
+            raise forms.ValidationError(
+                _('You must provide at least a recipe or a title.')
+            )
+
+        return cleaned_data
+
+    class Meta:
+        model = MealPlan
+        fields = (
+            'recipe', 'title', 'meal_type', 'note',
+            'servings', 'date', 'shared'
+        )
+
+        help_texts = {
+            'shared': _('You can list default users to share recipes with in the settings.'),  # noqa: E501
+            'note': _('You can use markdown to format this field. See the <a href="/docs/markdown/">docs here</a>')  # noqa: E501
+        }
+
+        widgets = {
+            'recipe': SelectWidget,
+            'date': DateWidget,
+            'shared': MultiSelectWidget
+        }
+
+
+class InviteLinkForm(forms.ModelForm):
+    class Meta:
+        model = InviteLink
+        fields = ('username', 'group', 'valid_until')
+        help_texts = {
+            'username': _('A username is not required, if left blank the new user can choose one.')  # noqa: E501
+        }
+
+
+class UserCreateForm(forms.Form):
+    name = forms.CharField(label='Username')
+    password = forms.CharField(
+        widget=forms.TextInput(
+            attrs={'autocomplete': 'new-password', 'type': 'password'}
+        )
+    )
+    password_confirm = forms.CharField(
+        widget=forms.TextInput(
+            attrs={'autocomplete': 'new-password', 'type': 'password'}
+        )
+    )

cookbook/helper/AllAuthCustomAdapter.py

@@ -0,0 +1,19 @@
+from django.conf import settings
+
+from allauth.account.adapter import DefaultAccountAdapter
+
+
+class AllAuthCustomAdapter(DefaultAccountAdapter):
+
+    def is_open_for_signup(self, request):
+        """
+        Whether to allow sign ups.
+        """
+        if request.resolver_match.view_name == 'account_signup':
+            return False
+        else:
+            return super(AllAuthCustomAdapter, self).is_open_for_signup(request)
+
+    # disable password reset for now
+    def send_mail(self, template_prefix, email, context):
+        pass

cookbook/helper/__init__.py

@@ -1 +1,6 @@
-from cookbook.helper.dal import *
+import cookbook.helper.dal
+from cookbook.helper.AllAuthCustomAdapter import AllAuthCustomAdapter
+
+__all__ = [
+    'dal',
+]

cookbook/helper/dal.py

@@ -1,29 +1,34 @@
+from cookbook.models import Food, Keyword, Recipe, Unit
+
 from dal import autocomplete
 
-from cookbook.models import Keyword, RecipeIngredients
 
+class BaseAutocomplete(autocomplete.Select2QuerySetView):
+    model = None
 
-class KeywordAutocomplete(autocomplete.Select2QuerySetView):
     def get_queryset(self):
         if not self.request.user.is_authenticated:
-            return Keyword.objects.none()
+            return self.model.objects.none()
 
-        qs = Keyword.objects.all()
+        qs = self.model.objects.all()
 
         if self.q:
-            qs = qs.filter(name__istartswith=self.q)
+            qs = qs.filter(name__icontains=self.q)
 
         return qs
 
 
-class IngredientsAutocomplete(autocomplete.Select2QuerySetView):
-    def get_queryset(self):
-        if not self.request.user.is_authenticated:
-            return RecipeIngredients.objects.none()
+class KeywordAutocomplete(BaseAutocomplete):
+    model = Keyword
 
-        qs = RecipeIngredients.objects.all()
 
-        if self.q:
-            qs = qs.filter(name__istartswith=self.q)
+class IngredientsAutocomplete(BaseAutocomplete):
+    model = Food
 
-        return qs
+
+class RecipeAutocomplete(BaseAutocomplete):
+    model = Recipe
+
+
+class UnitAutocomplete(BaseAutocomplete):
+    model = Unit

cookbook/helper/ingredient_parser.py

@@ -0,0 +1,159 @@
+import string
+import unicodedata
+
+
+def parse_fraction(x):
+    if len(x) == 1 and 'fraction' in unicodedata.decomposition(x):
+        frac_split = unicodedata.decomposition(x[-1:]).split()
+        return (float((frac_split[1]).replace('003', ''))
+                / float((frac_split[3]).replace('003', '')))
+    else:
+        frac_split = x.split('/')
+        if not len(frac_split) == 2:
+            raise ValueError
+        try:
+            return int(frac_split[0]) / int(frac_split[1])
+        except ZeroDivisionError:
+            raise ValueError
+
+
+def parse_amount(x):
+    amount = 0
+    unit = ''
+
+    did_check_frac = False
+    end = 0
+    while (
+            end < len(x)
+            and (
+                    x[end] in string.digits
+                    or (
+                            (x[end] == '.' or x[end] == ',' or x[end] == '/')
+                            and end + 1 < len(x)
+                            and x[end + 1] in string.digits
+                    )
+            )
+    ):
+        end += 1
+    if end > 0:
+        if "/" in x[:end]:
+            amount = parse_fraction(x[:end])
+        else:
+            amount = float(x[:end].replace(',', '.'))
+    else:
+        amount = parse_fraction(x[0])
+        end += 1
+        did_check_frac = True
+    if end < len(x):
+        if did_check_frac:
+            unit = x[end:]
+        else:
+            try:
+                amount += parse_fraction(x[end])
+                unit = x[end + 1:]
+            except ValueError:
+                unit = x[end:]
+    return amount, unit
+
+
+def parse_ingredient_with_comma(tokens):
+    ingredient = ''
+    note = ''
+    start = 0
+    # search for first occurrence of an argument ending in a comma
+    while start < len(tokens) and not tokens[start].endswith(','):
+        start += 1
+    if start == len(tokens):
+        # no token ending in a comma found -> use everything as ingredient
+        ingredient = ' '.join(tokens)
+    else:
+        ingredient = ' '.join(tokens[:start + 1])[:-1]
+        note = ' '.join(tokens[start + 1:])
+    return ingredient, note
+
+
+def parse_ingredient(tokens):
+    ingredient = ''
+    note = ''
+    if tokens[-1].endswith(')'):
+        # Check if the matching opening bracket is in the same token
+        if (not tokens[-1].startswith('(')) and ('(' in tokens[-1]):
+            return parse_ingredient_with_comma(tokens)
+        # last argument ends with closing bracket -> look for opening bracket
+        start = len(tokens) - 1
+        while not tokens[start].startswith('(') and not start == 0:
+            start -= 1
+        if start == 0:
+            # the whole list is wrapped in brackets -> assume it is an error (e.g. assumed first argument was the unit)  # noqa: E501
+            raise ValueError
+        elif start < 0:
+            # no opening bracket anywhere -> just ignore the last bracket
+            ingredient, note = parse_ingredient_with_comma(tokens)
+        else:
+            # opening bracket found -> split in ingredient and note, remove brackets from note  # noqa: E501
+            note = ' '.join(tokens[start:])[1:-1]
+            ingredient = ' '.join(tokens[:start])
+    else:
+        ingredient, note = parse_ingredient_with_comma(tokens)
+    return ingredient, note
+
+
+def parse(x):
+    # initialize default values
+    amount = 0
+    unit = ''
+    ingredient = ''
+    note = ''
+
+    tokens = x.split()
+    if len(tokens) == 1:
+        # there only is one argument, that must be the ingredient
+        ingredient = tokens[0]
+    else:
+        try:
+            # try to parse first argument as amount
+            amount, unit = parse_amount(tokens[0])
+            # only try to parse second argument as amount if there are at least
+            # three arguments if it already has a unit there can't be
+            # a fraction for the amount
+            if len(tokens) > 2:
+                try:
+                    if not unit == '':
+                        # a unit is already found, no need to try the second argument for a fraction  # noqa: E501
+                        # probably not the best method to do it, but I didn't want to make an if check and paste the exact same thing in the else as already is in the except  # noqa: E501
+                        raise ValueError
+                    # try to parse second argument as amount and add that, in case of '2 1/2' or '2 ½'  # noqa: E501
+                    amount += parse_fraction(tokens[1])
+                    # assume that units can't end with a comma
+                    if len(tokens) > 3 and not tokens[2].endswith(','):
+                        # try to use third argument as unit and everything else as ingredient, use everything as ingredient if it fails  # noqa: E501
+                        try:
+                            ingredient, note = parse_ingredient(tokens[3:])
+                            unit = tokens[2]
+                        except ValueError:
+                            ingredient, note = parse_ingredient(tokens[2:])
+                    else:
+                        ingredient, note = parse_ingredient(tokens[2:])
+                except ValueError:
+                    # assume that units can't end with a comma
+                    if not tokens[1].endswith(','):
+                        # try to use second argument as unit and everything else as ingredient, use everything as ingredient if it fails  # noqa: E501
+                        try:
+                            ingredient, note = parse_ingredient(tokens[2:])
+                            unit = tokens[1]
+                        except ValueError:
+                            ingredient, note = parse_ingredient(tokens[1:])
+                    else:
+                        ingredient, note = parse_ingredient(tokens[1:])
+            else:
+                # only two arguments, first one is the amount
+                # which means this is the ingredient
+                ingredient = tokens[1]
+        except ValueError:
+            try:
+                # can't parse first argument as amount
+                # -> no unit -> parse everything as ingredient
+                ingredient, note = parse_ingredient(tokens)
+            except ValueError:
+                ingredient = ' '.join(tokens[1:])
+    return amount, unit.strip(), ingredient.strip(), note.strip()

cookbook/helper/mdx_attributes.py

@@ -0,0 +1,27 @@
+import markdown
+from markdown.treeprocessors import Treeprocessor
+
+
+class StyleTreeprocessor(Treeprocessor):
+
+    def run_processor(self, node):
+        for child in node:
+            if child.tag == "table":
+                child.set("class", "table table-bordered")
+            if child.tag == "img":
+                child.set("class", "img-fluid")
+            self.run_processor(child)
+        return node
+
+    def run(self, root):
+        self.run_processor(root)
+        return root
+
+
+class MarkdownFormatExtension(markdown.Extension):
+    def extendMarkdown(self, md, md_globals):
+        md.treeprocessors.register(
+            StyleTreeprocessor(),
+            'StyleTreeprocessor',
+            10
+        )

cookbook/helper/mdx_urlize.py

@@ -0,0 +1,88 @@
+"""
+A more liberal autolinker
+
+Inspired by Django's urlize function.
+
+Positive examples:
+
+>>> import markdown
+>>> md = markdown.Markdown(extensions=['urlize'])
+
+>>> md.convert('http://example.com/')
+u'<p><a href="http://example.com/">http://example.com/</a></p>'
+
+>>> md.convert('go to http://example.com')
+u'<p>go to <a href="http://example.com">http://example.com</a></p>'
+
+>>> md.convert('example.com')
+u'<p><a href="http://example.com">example.com</a></p>'
+
+>>> md.convert('example.net')
+u'<p><a href="http://example.net">example.net</a></p>'
+
+>>> md.convert('www.example.us')
+u'<p><a href="http://www.example.us">www.example.us</a></p>'
+
+>>> md.convert('(www.example.us/path/?name=val)')
+u'<p>(<a href="http://www.example.us/path/?name=val">www.example.us/path/?name=val</a>)</p>'
+
+>>> md.convert('go to <http://example.com> now!')
+u'<p>go to <a href="http://example.com">http://example.com</a> now!</p>'
+
+Negative examples:
+
+>>> md.convert('del.icio.us')
+u'<p>del.icio.us</p>'
+
+"""
+
+import markdown
+
+# Global Vars
+URLIZE_RE = '(%s)' % '|'.join([
+    r'<(?:f|ht)tps?://[^>]*>',
+    r'\b(?:f|ht)tps?://[^)<>\s]+[^.,)<>\s]',
+    r'\bwww\.[^)<>\s]+[^.,)<>\s]',
+    r'[^(<\s]+\.(?:com|net|org)\b',
+])
+
+
+class UrlizePattern(markdown.inlinepatterns.Pattern):
+    """ Return a link Element given an autolink (`http://example/com`). """
+
+    def handleMatch(self, m):
+        url = m.group(2)
+
+        if url.startswith('<'):
+            url = url[1:-1]
+
+        text = url
+
+        if not url.split('://')[0] in ('http', 'https', 'ftp'):
+            if '@' in url and '/' not in url:
+                url = 'mailto:' + url
+            else:
+                url = 'http://' + url
+
+        el = markdown.util.etree.Element("a")
+        el.set('href', url)
+        el.text = markdown.util.AtomicString(text)
+        return el
+
+
+class UrlizeExtension(markdown.Extension):
+    """ Urlize Extension for Python-Markdown. """
+
+    def extendMarkdown(self, md, md_globals):
+        """ Replace autolink with UrlizePattern """
+        md.inlinePatterns['autolink'] = UrlizePattern(URLIZE_RE, md)
+
+
+def makeExtension(*args, **kwargs):
+    return UrlizeExtension(*args, **kwargs)
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

cookbook/helper/permission_config.py

@@ -0,0 +1,9 @@
+from cookbook.helper.permission_helper import CustomIsUser
+
+
+class PermissionConfig:
+    BOOKS = {
+        'owner': True,
+        'groups': ['user'],
+        'drf': [CustomIsUser],
+    }

cookbook/helper/permission_helper.py

@@ -0,0 +1,251 @@
+"""
+Source: https://djangosnippets.org/snippets/1703/
+"""
+from cookbook.models import ShareLink
+from django.contrib import messages
+from django.contrib.auth.decorators import user_passes_test
+from django.core.exceptions import ValidationError
+from django.http import HttpResponseRedirect
+from django.urls import reverse, reverse_lazy
+from django.utils.translation import gettext as _
+from rest_framework import permissions
+from rest_framework.permissions import SAFE_METHODS
+
+
+def get_allowed_groups(groups_required):
+    """
+    Builds a list of all groups equal or higher to the provided groups
+    This means checking for guest will also allow admins to access
+    :param groups_required: list or tuple of groups
+    :return: tuple of groups
+    """
+    groups_allowed = tuple(groups_required)
+    if 'guest' in groups_required:
+        groups_allowed = groups_allowed + ('user', 'admin')
+    if 'user' in groups_required:
+        groups_allowed = groups_allowed + ('admin',)
+    return groups_allowed
+
+
+def has_group_permission(user, groups):
+    """
+    Tests if a given user is member of a certain group (or any higher group)
+    Superusers always bypass permission checks.
+    Unauthenticated users cant be member of any group thus always return false.
+    :param user: django auth user object
+    :param groups: list or tuple of groups the user should be checked for
+    :return: True if user is in allowed groups, false otherwise
+    """
+    if not user.is_authenticated:
+        return False
+    groups_allowed = get_allowed_groups(groups)
+    if user.is_authenticated:
+        if (user.is_superuser
+                | bool(user.groups.filter(name__in=groups_allowed))):
+            return True
+    return False
+
+
+def is_object_owner(user, obj):
+    """
+    Tests if a given user is the owner of a given object
+    test performed by checking user against the objects user
+    and create_by field (if exists)
+    superusers bypass all checks, unauthenticated users cannot own anything
+    :param user django auth user object
+    :param obj any object that should be tested
+    :return: true if user is owner of object, false otherwise
+    """
+    # TODO this could be improved/cleaned up by adding
+    #      get_owner methods to all models that allow owner checks
+    if not user.is_authenticated:
+        return False
+    if user.is_superuser:
+        return True
+    if owner := getattr(obj, 'created_by', None):
+        return owner == user
+    if owner := getattr(obj, 'user', None):
+        return owner == user
+    if getattr(obj, 'get_owner', None):
+        return obj.get_owner() == user
+    return False
+
+
+def is_object_shared(user, obj):
+    """
+    Tests if a given user is shared for a given object
+    test performed by checking user against the objects shared table
+    superusers bypass all checks, unauthenticated users cannot own anything
+    :param user django auth user object
+    :param obj any object that should be tested
+    :return: true if user is shared for object, false otherwise
+    """
+    # TODO this could be improved/cleaned up by adding
+    #      share checks for relevant objects
+    if not user.is_authenticated:
+        return False
+    if user.is_superuser:
+        return True
+    return user in obj.shared.all()
+
+
+def share_link_valid(recipe, share):
+    """
+    Verifies the validity of a share uuid
+    :param recipe: recipe object
+    :param share: share uuid
+    :return: true if a share link with the given recipe and uuid exists
+    """
+    try:
+        return (
+            True
+            if ShareLink.objects.filter(recipe=recipe, uuid=share).exists()
+            else False
+        )
+    except ValidationError:
+        return False
+
+
+# Django Views
+
+def group_required(*groups_required):
+    """
+    Decorator that tests the requesting user to be member
+    of at least one of the provided groups or higher level groups
+    :param groups_required: list of required groups
+    :return: true if member of group, false otherwise
+    """
+
+    def in_groups(u):
+        return has_group_permission(u, groups_required)
+
+    return user_passes_test(in_groups, login_url='view_no_group')
+
+
+class GroupRequiredMixin(object):
+    """
+        groups_required - list of strings, required param
+    """
+
+    groups_required = None
+
+    def dispatch(self, request, *args, **kwargs):
+        if not has_group_permission(request.user, self.groups_required):
+            messages.add_message(
+                request,
+                messages.ERROR,
+                _('You do not have the required permissions to view this page!')  # noqa: E501
+            )
+            return HttpResponseRedirect(reverse_lazy('index'))
+
+        return super(GroupRequiredMixin, self).dispatch(request, *args, **kwargs)
+
+
+class OwnerRequiredMixin(object):
+
+    def dispatch(self, request, *args, **kwargs):
+        if not request.user.is_authenticated:
+            messages.add_message(
+                request,
+                messages.ERROR,
+                _('You are not logged in and therefore cannot view this page!')
+            )
+            return HttpResponseRedirect(
+                reverse_lazy('account_login') + '?next=' + request.path
+            )
+        else:
+            if not is_object_owner(request.user, self.get_object()):
+                messages.add_message(
+                    request,
+                    messages.ERROR,
+                    _('You cannot interact with this object as it is not owned by you!')  # noqa: E501
+                )
+                return HttpResponseRedirect(reverse('index'))
+
+        return super(OwnerRequiredMixin, self) \
+            .dispatch(request, *args, **kwargs)
+
+
+# Django Rest Framework Permission classes
+
+class CustomIsOwner(permissions.BasePermission):
+    """
+    Custom permission class for django rest framework views
+    verifies user has ownership over object
+    (either user or created_by or user is request user)
+    """
+    message = _('You cannot interact with this object as it is not owned by you!')  # noqa: E501
+
+    def has_permission(self, request, view):
+        return request.user.is_authenticated
+
+    def has_object_permission(self, request, view, obj):
+        return is_object_owner(request.user, obj)
+
+
+# TODO function duplicate/too similar name
+class CustomIsShared(permissions.BasePermission):
+    """
+    Custom permission class for django rest framework views
+    verifies user is shared for the object he is trying to access
+    """
+    message = _('You cannot interact with this object as it is not owned by you!')  # noqa: E501
+
+    def has_permission(self, request, view):
+        return request.user.is_authenticated
+
+    def has_object_permission(self, request, view, obj):
+        return is_object_shared(request.user, obj)
+
+
+class CustomIsGuest(permissions.BasePermission):
+    """
+    Custom permission class for django rest framework views
+    verifies the user is member of at least the group: guest
+    """
+    message = _('You do not have the required permissions to view this page!')
+
+    def has_permission(self, request, view):
+        return has_group_permission(request.user, ['guest'])
+
+    def has_object_permission(self, request, view, obj):
+        return has_group_permission(request.user, ['guest'])
+
+
+class CustomIsUser(permissions.BasePermission):
+    """
+    Custom permission class for django rest framework views
+    verifies the user is member of at least the group: user
+    """
+    message = _('You do not have the required permissions to view this page!')
+
+    def has_permission(self, request, view):
+        return has_group_permission(request.user, ['user'])
+
+
+class CustomIsAdmin(permissions.BasePermission):
+    """
+    Custom permission class for django rest framework views
+    verifies the user is member of at least the group: admin
+    """
+    message = _('You do not have the required permissions to view this page!')
+
+    def has_permission(self, request, view):
+        return has_group_permission(request.user, ['admin'])
+
+
+class CustomIsShare(permissions.BasePermission):
+    """
+    Custom permission class for django rest framework views
+    verifies the requesting user provided a valid share link
+    """
+    message = _('You do not have the required permissions to view this page!')
+
+    def has_permission(self, request, view):
+        return request.method in SAFE_METHODS and 'pk' in view.kwargs
+
+    def has_object_permission(self, request, view, obj):
+        share = request.query_params.get('share', None)
+        if share:
+            return share_link_valid(obj, share)
+        return False

cookbook/helper/recipe_url_import.py

@@ -0,0 +1,236 @@
+import json
+import random
+import re
+from json import JSONDecodeError
+
+import microdata
+from bs4 import BeautifulSoup
+from cookbook.helper.ingredient_parser import parse as parse_ingredient
+from cookbook.models import Keyword
+from django.http import JsonResponse
+from django.utils.dateparse import parse_duration
+from django.utils.translation import gettext as _
+
+
+def get_from_html(html_text, url):
+    soup = BeautifulSoup(html_text, "html.parser")
+
+    # first try finding ld+json as its most common
+    for ld in soup.find_all('script', type='application/ld+json'):
+        try:
+            ld_json = json.loads(ld.string.replace('\n', ''))
+            if type(ld_json) != list:
+                ld_json = [ld_json]
+
+            for ld_json_item in ld_json:
+                # recipes type might be wrapped in @graph type
+                if '@graph' in ld_json_item:
+                    for x in ld_json_item['@graph']:
+                        if '@type' in x and x['@type'] == 'Recipe':
+                            ld_json_item = x
+
+                if ('@type' in ld_json_item
+                        and ld_json_item['@type'] == 'Recipe'):
+                    return JsonResponse(find_recipe_json(ld_json_item, url))
+        except JSONDecodeError:
+            return JsonResponse(
+                {
+                    'error': True,
+                    'msg': _('The requested site provided malformed data and cannot be read.')  # noqa: E501
+                },
+                status=400)
+
+    # now try to find microdata
+    items = microdata.get_items(html_text)
+    for i in items:
+        md_json = json.loads(i.json())
+        if 'schema.org/Recipe' in str(md_json['type']):
+            return JsonResponse(find_recipe_json(md_json['properties'], url))
+
+    return JsonResponse(
+        {
+            'error': True,
+            'msg': _('The requested site does not provide any recognized data format to import the recipe from.')  # noqa: E501
+        },
+        status=400)
+
+
+def find_recipe_json(ld_json, url):
+    if type(ld_json['name']) == list:
+        try:
+            ld_json['name'] = ld_json['name'][0]
+        except Exception:
+            ld_json['name'] = 'ERROR'
+
+    # some sites use ingredients instead of recipeIngredients
+    if 'recipeIngredient' not in ld_json and 'ingredients' in ld_json:
+        ld_json['recipeIngredient'] = ld_json['ingredients']
+
+    if 'recipeIngredient' in ld_json:
+        # some pages have comma separated ingredients in a single array entry
+        if (len(ld_json['recipeIngredient']) == 1
+                and len(ld_json['recipeIngredient'][0]) > 30):
+            ld_json['recipeIngredient'] = ld_json['recipeIngredient'][0].split(',')  # noqa: E501
+
+        for x in ld_json['recipeIngredient']:
+            if '\n' in x:
+                ld_json['recipeIngredient'].remove(x)
+                for i in x.split('\n'):
+                    ld_json['recipeIngredient'].insert(0, i)
+
+        ingredients = []
+
+        for x in ld_json['recipeIngredient']:
+            if x.replace(' ', '') != '':
+                try:
+                    amount, unit, ingredient, note = parse_ingredient(x)
+                    if ingredient:
+                        ingredients.append(
+                            {
+                                'amount': amount,
+                                'unit': {
+                                    'text': unit,
+                                    'id': random.randrange(10000, 99999)
+                                },
+                                'ingredient': {
+                                    'text': ingredient,
+                                    'id': random.randrange(10000, 99999)
+                                },
+                                'note': note,
+                                'original': x
+                            }
+                        )
+                except Exception:
+                    ingredients.append(
+                        {
+                            'amount': 0,
+                            'unit': {
+                                'text': '',
+                                'id': random.randrange(10000, 99999)
+                            },
+                            'ingredient': {
+                                'text': x,
+                                'id': random.randrange(10000, 99999)
+                            },
+                            'note': '',
+                            'original': x
+                        }
+                    )
+
+        ld_json['recipeIngredient'] = ingredients
+    else:
+        ld_json['recipeIngredient'] = []
+
+    if 'keywords' in ld_json:
+        keywords = []
+
+        # keywords as string
+        if type(ld_json['keywords']) == str:
+            ld_json['keywords'] = ld_json['keywords'].split(',')
+
+        # keywords as string in list
+        if (type(ld_json['keywords']) == list
+                and len(ld_json['keywords']) == 1
+                and ',' in ld_json['keywords'][0]):
+            ld_json['keywords'] = ld_json['keywords'][0].split(',')
+
+        # keywords as list
+        for kw in ld_json['keywords']:
+            if k := Keyword.objects.filter(name=kw).first():
+                keywords.append({'id': str(k.id), 'text': str(k).strip()})
+            else:
+                keywords.append({'id': random.randrange(1111111, 9999999, 1), 'text': kw.strip()})
+
+        ld_json['keywords'] = keywords
+    else:
+        ld_json['keywords'] = []
+
+    if 'recipeInstructions' in ld_json:
+        instructions = ''
+
+        # flatten instructions if they are in a list
+        if type(ld_json['recipeInstructions']) == list:
+            for i in ld_json['recipeInstructions']:
+                if type(i) == str:
+                    instructions += i
+                else:
+                    if 'text' in i:
+                        instructions += i['text'] + '\n\n'
+                    elif 'itemListElement' in i:
+                        for ile in i['itemListElement']:
+                            if type(ile) == str:
+                                instructions += ile + '\n\n'
+                            elif 'text' in ile:
+                                instructions += ile['text'] + '\n\n'
+                    else:
+                        instructions += str(i)
+            ld_json['recipeInstructions'] = instructions
+
+        ld_json['recipeInstructions'] = re.sub(r'\n\s*\n', '\n\n', ld_json['recipeInstructions'])  # noqa: E501
+        ld_json['recipeInstructions'] = re.sub(' +', ' ', ld_json['recipeInstructions'])  # noqa: E501
+        ld_json['recipeInstructions'] = ld_json['recipeInstructions'].replace('<p>', '')  # noqa: E501
+        ld_json['recipeInstructions'] = ld_json['recipeInstructions'].replace('</p>', '')  # noqa: E501
+    else:
+        ld_json['recipeInstructions'] = ''
+
+    if url != '':
+        ld_json['recipeInstructions'] += '\n\n' + _('Imported from') + ' ' + url
+
+    if 'image' in ld_json:
+        # check if list of images is returned, take first if so
+        if (type(ld_json['image'])) == list:
+            if type(ld_json['image'][0]) == str:
+                ld_json['image'] = ld_json['image'][0]
+            elif 'url' in ld_json['image'][0]:
+                ld_json['image'] = ld_json['image'][0]['url']
+
+        # ignore relative image paths
+        if 'http' not in ld_json['image']:
+            ld_json['image'] = ''
+
+    if 'cookTime' in ld_json:
+        try:
+            if (type(ld_json['cookTime']) == list
+                    and len(ld_json['cookTime']) > 0):
+                ld_json['cookTime'] = ld_json['cookTime'][0]
+            ld_json['cookTime'] = round(
+                parse_duration(
+                    ld_json['cookTime']
+                ).seconds / 60
+            )
+        except TypeError:
+            ld_json['cookTime'] = 0
+    else:
+        ld_json['cookTime'] = 0
+
+    if 'prepTime' in ld_json:
+        try:
+            if (type(ld_json['prepTime']) == list
+                    and len(ld_json['prepTime']) > 0):
+                ld_json['prepTime'] = ld_json['prepTime'][0]
+            ld_json['prepTime'] = round(
+                parse_duration(
+                    ld_json['prepTime']
+                ).seconds / 60
+            )
+        except TypeError:
+            ld_json['prepTime'] = 0
+    else:
+        ld_json['prepTime'] = 0
+
+    try:
+        if 'recipeYield' in ld_json:
+            if type(ld_json['recipeYield']) == str:
+                ld_json['servings'] = int(re.findall(r'\b\d+\b', ld_json['recipeYield'])[0])
+    except Exception as e:
+        print(e)
+        ld_json['servings'] = 1
+
+    for key in list(ld_json):
+        if key not in [
+            'prepTime', 'cookTime', 'image', 'recipeInstructions',
+            'keywords', 'name', 'recipeIngredient', 'servings'
+        ]:
+            ld_json.pop(key, None)
+
+    return ld_json

cookbook/helper/template_helper.py

@@ -0,0 +1,62 @@
+import bleach
+import markdown as md
+from bleach_whitelist import markdown_attrs, markdown_tags
+from cookbook.helper.mdx_attributes import MarkdownFormatExtension
+from cookbook.helper.mdx_urlize import UrlizeExtension
+from jinja2 import Template, TemplateSyntaxError
+
+
+class IngredientObject(object):
+    amount = ""
+    unit = ""
+    food = ""
+    note = ""
+
+    def __init__(self, ingredient):
+        if ingredient.no_amount:
+            self.amount = ""
+        else:
+            self.amount = f"<scalable-number v-bind:number='{bleach.clean(str(ingredient.amount))}' v-bind:factor='ingredient_factor'></scalable-number>"
+        if ingredient.unit:
+            self.unit = bleach.clean(str(ingredient.unit))
+        else:
+            self.unit = ""
+        self.food = bleach.clean(str(ingredient.food))
+        self.note = bleach.clean(str(ingredient.note))
+
+    def __str__(self):
+        ingredient = self.amount
+        if self.unit != "":
+            ingredient += f' {self.unit}'
+        return f'{ingredient} {self.food}'
+
+
+def render_instructions(step):  # TODO deduplicate markdown cleanup code
+    instructions = step.instruction
+
+    tags = markdown_tags + [
+        'pre', 'table', 'td', 'tr', 'th', 'tbody', 'style', 'thead'
+    ]
+    parsed_md = md.markdown(
+        instructions,
+        extensions=[
+            'markdown.extensions.fenced_code', 'tables',
+            UrlizeExtension(), MarkdownFormatExtension()
+        ]
+    )
+    markdown_attrs['*'] = markdown_attrs['*'] + ['class']
+
+    instructions = bleach.clean(parsed_md, tags, markdown_attrs)
+
+    ingredients = []
+
+    for i in step.ingredients.all():
+        ingredients.append(IngredientObject(i))
+
+    try:
+        template = Template(instructions)
+        instructions = template.render(ingredients=ingredients)
+    except TemplateSyntaxError:
+        pass
+
+    return instructions

cookbook/integration/chowdown.py

@@ -0,0 +1,79 @@
+import json
+import re
+from io import BytesIO
+from zipfile import ZipFile
+
+from cookbook.helper.ingredient_parser import parse
+from cookbook.integration.integration import Integration
+from cookbook.models import Recipe, Step, Food, Unit, Ingredient, Keyword
+
+
+class Chowdown(Integration):
+
+    def import_file_name_filter(self, zip_info_object):
+        print("testing", zip_info_object.filename)
+        return re.match(r'^_recipes/([A-Za-z\d\s-])+.md$', zip_info_object.filename)
+
+    def get_recipe_from_file(self, file):
+        ingredient_mode = False
+        direction_mode = False
+        description_mode = False
+
+        ingredients = []
+        directions = []
+        descriptions = []
+        for fl in file.readlines():
+            line = fl.decode("utf-8")
+            if 'title:' in line:
+                title = line.replace('title:', '').replace('"', '').strip()
+            if 'image:' in line:
+                image = line.replace('image:', '').strip()
+            if 'tags:' in line:
+                tags = line.replace('tags:', '').strip()
+            if ingredient_mode:
+                if len(line) > 2 and 'directions:' not in line:
+                    ingredients.append(line[2:])
+            if '---' in line and direction_mode:
+                direction_mode = False
+                description_mode = True
+            if direction_mode:
+                if len(line) > 2:
+                    directions.append(line[2:])
+            if 'ingredients:' in line:
+                ingredient_mode = True
+            if 'directions:' in line:
+                ingredient_mode = False
+                direction_mode = True
+            if description_mode and len(line) > 3 and '---' not in line:
+                descriptions.append(line)
+
+        recipe = Recipe.objects.create(name=title, created_by=self.request.user, internal=True, )
+
+        for k in tags.split(','):
+            keyword, created = Keyword.objects.get_or_create(name=k.strip())
+            recipe.keywords.add(keyword)
+
+        step = Step.objects.create(
+            instruction='\n'.join(directions) + '\n\n' + '\n'.join(descriptions)
+        )
+
+        for ingredient in ingredients:
+            amount, unit, ingredient, note = parse(ingredient)
+            f, created = Food.objects.get_or_create(name=ingredient)
+            u, created = Unit.objects.get_or_create(name=unit)
+            step.ingredients.add(Ingredient.objects.create(
+                food=f, unit=u, amount=amount, note=note
+            ))
+        recipe.steps.add(step)
+
+        for f in self.files:
+            if '.zip' in f.name:
+                import_zip = ZipFile(f.file)
+                for z in import_zip.filelist:
+                    if re.match(f'^images/{image}$', z.filename):
+                        self.import_recipe_image(recipe, BytesIO(import_zip.read(z.filename)))
+
+        return recipe
+
+    def get_file_from_recipe(self, recipe):
+        raise NotImplementedError('Method not implemented in storage integration')

cookbook/integration/default.py

@@ -0,0 +1,34 @@
+import json
+from io import BytesIO
+from zipfile import ZipFile
+
+from rest_framework.renderers import JSONRenderer
+
+from cookbook.integration.integration import Integration
+from cookbook.serializer import RecipeExportSerializer
+
+
+class Default(Integration):
+
+    def get_recipe_from_file(self, file):
+        recipe_zip = ZipFile(file)
+
+        recipe_string = recipe_zip.read('recipe.json').decode("utf-8")
+        recipe = self.decode_recipe(recipe_string)
+        if 'image.png' in recipe_zip.namelist():
+            self.import_recipe_image(recipe, BytesIO(recipe_zip.read('image.png')))
+        return recipe
+
+    def decode_recipe(self, string):
+        data = json.loads(string)
+        serialized_recipe = RecipeExportSerializer(data=data, context={'request': self.request})
+        if serialized_recipe.is_valid():
+            recipe = serialized_recipe.save()
+            return recipe
+
+        return None
+
+    def get_file_from_recipe(self, recipe):
+        export = RecipeExportSerializer(recipe).data
+
+        return 'recipe.json', JSONRenderer().render(export).decode("utf-8")

cookbook/integration/integration.py

@@ -0,0 +1,128 @@
+import datetime
+import uuid
+
+from io import BytesIO, StringIO
+from zipfile import ZipFile, BadZipFile
+
+from django.contrib import messages
+from django.core.files import File
+from django.http import HttpResponseRedirect, HttpResponse
+from django.urls import reverse
+from django.utils.formats import date_format
+from django.utils.translation import gettext as _
+from cookbook.models import Keyword
+
+
+class Integration:
+    request = None
+    keyword = None
+    files = None
+
+    def __init__(self, request):
+        """
+        Integration for importing and exporting recipes
+        :param request: request context of import session (used to link user to created objects)
+        """
+        self.request = request
+        self.keyword = Keyword.objects.create(
+            name=f'Import {date_format(datetime.datetime.now(), "DATETIME_FORMAT")}.{datetime.datetime.now().strftime("%S")}',
+            description=f'Imported by {request.user.get_user_name()} at {date_format(datetime.datetime.now(), "DATETIME_FORMAT")}',
+            icon='📥'
+        )
+
+    def do_export(self, recipes):
+        """
+        Perform the export based on a list of recipes
+        :param recipes: list of recipe objects
+        :return: HttpResponse with a ZIP file that is directly downloaded
+        """
+        export_zip_stream = BytesIO()
+        export_zip_obj = ZipFile(export_zip_stream, 'w')
+
+        for r in recipes:
+            if r.internal:
+                recipe_zip_stream = BytesIO()
+                recipe_zip_obj = ZipFile(recipe_zip_stream, 'w')
+
+                recipe_stream = StringIO()
+                filename, data = self.get_file_from_recipe(r)
+                recipe_stream.write(data)
+                recipe_zip_obj.writestr(filename, recipe_stream.getvalue())
+                recipe_stream.close()
+
+                try:
+                    recipe_zip_obj.write(r.image.path, 'image.png')
+                except ValueError:
+                    pass
+
+                recipe_zip_obj.close()
+                export_zip_obj.writestr(str(r.pk) + '.zip', recipe_zip_stream.getvalue())
+
+        export_zip_obj.close()
+
+        response = HttpResponse(export_zip_stream.getvalue(), content_type='application/force-download')
+        response['Content-Disposition'] = 'attachment; filename="export.zip"'
+        return response
+
+    def import_file_name_filter(self, zip_info_object):
+        """
+        Since zipfile.namelist() returns all files in all subdirectories this function allows filtering of files
+        If false is returned the file will be ignored
+        By default all files are included
+        :param zip_info_object: ZipInfo object
+        :return: Boolean if object should be included
+        """
+        return True
+
+    def do_import(self, files):
+        """
+        Imports given files
+        :param files: List of in memory files
+        :return: HttpResponseRedirect to the recipe search showing all imported recipes
+        """
+        try:
+            self.files = files
+            for f in files:
+                if '.zip' in f.name:
+                    import_zip = ZipFile(f.file)
+                    for z in import_zip.filelist:
+                        if self.import_file_name_filter(z):
+                            recipe = self.get_recipe_from_file(BytesIO(import_zip.read(z.filename)))
+                            recipe.keywords.add(self.keyword)
+                    import_zip.close()
+                else:
+                    recipe = self.get_recipe_from_file(f.file)
+                    recipe.keywords.add(self.keyword)
+        except BadZipFile:
+            messages.add_message(self.request, messages.ERROR, _('Importer expected a .zip file. Did you choose the correct importer type for your data ?'))
+
+        return HttpResponseRedirect(reverse('view_search') + '?keywords=' + str(self.keyword.pk))
+
+    @staticmethod
+    def import_recipe_image(recipe, image_file):
+        """
+        Adds an image to a recipe naming it correctly
+        :param recipe: Recipe object
+        :param image_file: ByteIO stream containing the image
+        """
+        recipe.image = File(image_file, name=f'{uuid.uuid4()}_{recipe.pk}.png')
+        recipe.save()
+
+    def get_recipe_from_file(self, file):
+        """
+        Takes any file like object and converts it into a recipe
+        :param file: ByteIO or any file like object, depends on provider
+        :return: Recipe object
+        """
+        raise NotImplementedError('Method not implemented in storage integration')
+
+    def get_file_from_recipe(self, recipe):
+        """
+        Takes a recipe object and converts it to a string (depending on the format)
+        returns both the filename of the exported file and the file contents
+        :param recipe: Recipe object that should be converted
+        :returns:
+            - name - file name in export
+            - data - string content for file to get created in export zip
+        """
+        raise NotImplementedError('Method not implemented in storage integration')

cookbook/integration/mealie.py

@@ -0,0 +1,52 @@
+import json
+import re
+from io import BytesIO
+from zipfile import ZipFile
+
+from cookbook.helper.ingredient_parser import parse
+from cookbook.integration.integration import Integration
+from cookbook.models import Recipe, Step, Food, Unit, Ingredient
+
+
+class Mealie(Integration):
+
+    def import_file_name_filter(self, zip_info_object):
+        return re.match(r'^recipes/([A-Za-z\d-])+.json$', zip_info_object.filename)
+
+    def get_recipe_from_file(self, file):
+        recipe_json = json.loads(file.getvalue().decode("utf-8"))
+
+        recipe = Recipe.objects.create(
+            name=recipe_json['name'].strip(), description=recipe_json['description'].strip(),
+            created_by=self.request.user, internal=True)
+
+        # TODO parse times (given in PT2H3M )
+
+        ingredients_added = False
+        for s in recipe_json['recipeInstructions']:
+            step = Step.objects.create(
+                instruction=s['text']
+            )
+            if not ingredients_added:
+                ingredients_added = True
+
+                for ingredient in recipe_json['recipeIngredient']:
+                    amount, unit, ingredient, note = parse(ingredient)
+                    f, created = Food.objects.get_or_create(name=ingredient)
+                    u, created = Unit.objects.get_or_create(name=unit)
+                    step.ingredients.add(Ingredient.objects.create(
+                        food=f, unit=u, amount=amount, note=note
+                    ))
+            recipe.steps.add(step)
+
+        for f in self.files:
+            if '.zip' in f.name:
+                import_zip = ZipFile(f.file)
+                for z in import_zip.filelist:
+                    if re.match(f'^images/{recipe_json["slug"]}.jpg$', z.filename):
+                        self.import_recipe_image(recipe, BytesIO(import_zip.read(z.filename)))
+
+        return recipe
+
+    def get_file_from_recipe(self, recipe):
+        raise NotImplementedError('Method not implemented in storage integration')

cookbook/integration/nextcloud_cookbook.py

@@ -0,0 +1,54 @@
+import json
+import re
+from io import BytesIO
+from zipfile import ZipFile
+
+from cookbook.helper.ingredient_parser import parse
+from cookbook.integration.integration import Integration
+from cookbook.models import Recipe, Step, Food, Unit, Ingredient
+
+
+class NextcloudCookbook(Integration):
+
+    def import_file_name_filter(self, zip_info_object):
+        return re.match(r'^Recipes/([A-Za-z\d\s])+/recipe.json$', zip_info_object.filename)
+
+    def get_recipe_from_file(self, file):
+        recipe_json = json.loads(file.getvalue().decode("utf-8"))
+
+        recipe = Recipe.objects.create(
+            name=recipe_json['name'].strip(), description=recipe_json['description'].strip(),
+            created_by=self.request.user, internal=True,
+            servings=recipe_json['recipeYield'])
+
+        # TODO parse times (given in PT2H3M )
+        # TODO parse keywords
+
+        ingredients_added = False
+        for s in recipe_json['recipeInstructions']:
+            step = Step.objects.create(
+                instruction=s
+            )
+            if not ingredients_added:
+                ingredients_added = True
+
+                for ingredient in recipe_json['recipeIngredient']:
+                    amount, unit, ingredient, note = parse(ingredient)
+                    f, created = Food.objects.get_or_create(name=ingredient)
+                    u, created = Unit.objects.get_or_create(name=unit)
+                    step.ingredients.add(Ingredient.objects.create(
+                        food=f, unit=u, amount=amount, note=note
+                    ))
+            recipe.steps.add(step)
+
+        for f in self.files:
+            if '.zip' in f.name:
+                import_zip = ZipFile(f.file)
+                for z in import_zip.filelist:
+                    if re.match(f'^Recipes/{recipe.name}/full.jpg$', z.filename):
+                        self.import_recipe_image(recipe, BytesIO(import_zip.read(z.filename)))
+
+        return recipe
+
+    def get_file_from_recipe(self, recipe):
+        raise NotImplementedError('Method not implemented in storage integration')

cookbook/integration/paprika.py

@@ -0,0 +1,56 @@
+import json
+import re
+from io import BytesIO
+from zipfile import ZipFile
+
+import microdata
+from bs4 import BeautifulSoup
+
+from cookbook.helper.recipe_url_import import find_recipe_json
+from cookbook.integration.integration import Integration
+from cookbook.models import Recipe, Step, Food, Ingredient, Unit
+
+
+class Paprika(Integration):
+
+    def import_file_name_filter(self, zip_info_object):
+        print("testing", zip_info_object.filename)
+        return re.match(r'^Recipes/([A-Za-z\s])+.html$', zip_info_object.filename)
+
+    def get_file_from_recipe(self, recipe):
+        raise NotImplementedError('Method not implemented in storage integration')
+
+    def get_recipe_from_file(self, file):
+        html_text = file.getvalue().decode("utf-8")
+
+        items = microdata.get_items(html_text)
+        for i in items:
+            md_json = json.loads(i.json())
+            if 'schema.org/Recipe' in str(md_json['type']):
+                recipe_json = find_recipe_json(md_json['properties'], '')
+                recipe = Recipe.objects.create(name=recipe_json['name'].strip(), created_by=self.request.user, internal=True)
+                step = Step.objects.create(
+                    instruction=recipe_json['recipeInstructions']
+                )
+
+                for ingredient in recipe_json['recipeIngredient']:
+                    f, created = Food.objects.get_or_create(name=ingredient['ingredient']['text'])
+                    u, created = Unit.objects.get_or_create(name=ingredient['unit']['text'])
+                    step.ingredients.add(Ingredient.objects.create(
+                        food=f, unit=u, amount=ingredient['amount'], note=ingredient['note']
+                    ))
+
+                recipe.steps.add(step)
+
+                soup = BeautifulSoup(html_text, "html.parser")
+                image = soup.find('img')
+                image_name = image.attrs['src'].strip().replace('Images/', '')
+
+                for f in self.files:
+                    if '.zip' in f.name:
+                        import_zip = ZipFile(f.file)
+                        for z in import_zip.filelist:
+                            if re.match(f'^Recipes/Images/{image_name}$', z.filename):
+                                self.import_recipe_image(recipe, BytesIO(import_zip.read(z.filename)))
+
+                return recipe

cookbook/integration/safron.py

@@ -0,0 +1,60 @@
+from django.utils.translation import gettext as _
+
+from cookbook.helper.ingredient_parser import parse
+from cookbook.integration.integration import Integration
+from cookbook.models import Recipe, Step, Food, Unit, Ingredient
+
+
+class Safron(Integration):
+
+    def get_recipe_from_file(self, file):
+        ingredient_mode = False
+        direction_mode = False
+
+        ingredients = []
+        directions = []
+        for fl in file.readlines():
+            line = fl.decode("utf-8")
+            if 'Title:' in line:
+                title = line.replace('Title:', '').strip()
+            if 'Description:' in line:
+                description = line.replace('Description:', '').strip()
+            if 'Yield:' in line:
+                directions.append(_('Servings') + ' ' + line.replace('Yield:', '').strip() + '\n')
+            if 'Cook:' in line:
+                directions.append(_('Waiting time') + ' ' + line.replace('Cook:', '').strip() + '\n')
+            if 'Prep:' in line:
+                directions.append(_('Preparation Time') + ' ' + line.replace('Prep:', '').strip() + '\n')
+            if 'Cookbook:' in line:
+                directions.append(_('Cookbook') + ' ' + line.replace('Cookbook:', '').strip() + '\n')
+            if 'Section:' in line:
+                directions.append(_('Section') + ' ' + line.replace('Section:', '').strip() + '\n')
+            if ingredient_mode:
+                if len(line) > 2 and 'Instructions:' not in line:
+                    ingredients.append(line.strip())
+            if direction_mode:
+                if len(line) > 2:
+                    directions.append(line.strip())
+            if 'Ingredients:' in line:
+                ingredient_mode = True
+            if 'Instructions:' in line:
+                ingredient_mode = False
+                direction_mode = True
+
+        recipe = Recipe.objects.create(name=title, description=description, created_by=self.request.user, internal=True, )
+
+        step = Step.objects.create(instruction='\n'.join(directions))
+
+        for ingredient in ingredients:
+            amount, unit, ingredient, note = parse(ingredient)
+            f, created = Food.objects.get_or_create(name=ingredient)
+            u, created = Unit.objects.get_or_create(name=unit)
+            step.ingredients.add(Ingredient.objects.create(
+                food=f, unit=u, amount=amount, note=note
+            ))
+        recipe.steps.add(step)
+
+        return recipe
+
+    def get_file_from_recipe(self, recipe):
+        raise NotImplementedError('Method not implemented in storage integration')

cookbook/migrations/0008_mealplan.py

@@ -0,0 +1,27 @@
+# Generated by Django 3.0.2 on 2020-01-17 14:55
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('cookbook', '0007_auto_20191226_0852'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MealPlan',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('meal', models.CharField(choices=[('BREAKFAST', 'Breakfast'), ('LUNCH', 'Lunch'), ('DINNER', 'Dinner'), ('OTHER', 'Other')], default='BREAKFAST', max_length=128)),
+                ('note', models.TextField(blank=True)),
+                ('date', models.DateField()),
+                ('recipe', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='cookbook.Recipe')),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

cookbook/migrations/0009_auto_20200130_1056.py

@@ -0,0 +1,27 @@
+# Generated by Django 3.0.2 on 2020-01-30 09:56
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0008_mealplan'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Unit',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=128, unique=True)),
+                ('description', models.TextField(blank=True, null=True)),
+            ],
+        ),
+        migrations.AddField(
+            model_name='recipeingredients',
+            name='unit_key',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.PROTECT, to='cookbook.Unit'),
+        ),
+    ]

cookbook/migrations/0010_auto_20200130_1059.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.0.2 on 2020-01-30 09:59
+
+from django.db import migrations
+
+
+def migrate_ingredient_units(apps, schema_editor):
+    Unit = apps.get_model('cookbook', 'Unit')
+    RecipeIngredients = apps.get_model('cookbook', 'RecipeIngredients')
+
+    for u in RecipeIngredients.objects.values('unit').distinct():
+        unit = Unit()
+        unit.name = u['unit']
+        unit.save()
+
+    for i in RecipeIngredients.objects.all():
+        i.unit_key = Unit.objects.get(name=i.unit)
+        i.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0009_auto_20200130_1056'),
+    ]
+
+    operations = [
+        migrations.RunPython(migrate_ingredient_units),
+    ]

cookbook/migrations/0011_remove_recipeingredients_unit.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.0.2 on 2020-01-30 10:16
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0010_auto_20200130_1059'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='recipeingredients',
+            name='unit',
+        ),
+    ]

cookbook/migrations/0012_auto_20200130_1116.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.2 on 2020-01-30 10:16
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0011_remove_recipeingredients_unit'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='recipeingredients',
+            old_name='unit_key',
+            new_name='unit',
+        ),
+    ]

cookbook/migrations/0013_userpreference.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.0.2 on 2020-02-13 22:15
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('cookbook', '0012_auto_20200130_1116'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='UserPreference',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('theme', models.CharField(choices=[('BOOTSTRAP', 'Bootstrap'), ('DARKLY', 'Darkly'), ('FLATLY', 'Flatly')], default='BOOTSTRAP', max_length=128)),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

cookbook/migrations/0014_auto_20200213_2332.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.0.2 on 2020-02-13 22:32
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('cookbook', '0013_userpreference'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='userpreference',
+            name='theme',
+            field=models.CharField(choices=[('BOOTSTRAP', 'Bootstrap'), ('DARKLY', 'Darkly'), ('FLATLY', 'Flatly'), ('SUPERHERO', 'Superhero')], default='BOOTSTRAP', max_length=128),
+        ),
+        migrations.AlterField(
+            model_name='userpreference',
+            name='user',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL, unique=True),
+        ),
+    ]

cookbook/migrations/0015_auto_20200213_2334.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.0.2 on 2020-02-13 22:34
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('cookbook', '0014_auto_20200213_2332'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='userpreference',
+            name='user',
+            field=models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
+        ),
+    ]

cookbook/migrations/0016_auto_20200213_2335.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.0.2 on 2020-02-13 22:35
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('cookbook', '0015_auto_20200213_2334'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='userpreference',
+            name='id',
+        ),
+        migrations.AlterField(
+            model_name='userpreference',
+            name='user',
+            field=models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to=settings.AUTH_USER_MODEL),
+        ),
+    ]

cookbook/migrations/0017_auto_20200216_2257.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.2 on 2020-02-16 21:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0016_auto_20200213_2335'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='userpreference',
+            name='theme',
+            field=models.CharField(choices=[('BOOTSTRAP', 'Bootstrap'), ('DARKLY', 'Darkly'), ('FLATLY', 'Flatly'), ('SUPERHERO', 'Superhero')], default='FLATLY', max_length=128),
+        ),
+    ]

cookbook/migrations/0018_auto_20200216_2303.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.0.2 on 2020-02-16 22:03
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0017_auto_20200216_2257'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='RecipeIngredients',
+            new_name='RecipeIngredient',
+        ),
+    ]

cookbook/migrations/0019_ingredient.py

@@ -0,0 +1,20 @@
+# Generated by Django 3.0.2 on 2020-02-16 22:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0018_auto_20200216_2303'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Ingredient',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=128, unique=True)),
+            ],
+        ),
+    ]

cookbook/migrations/0020_recipeingredient_ingredient.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.0.2 on 2020-02-16 22:08
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0019_ingredient'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='recipeingredient',
+            name='ingredient',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.PROTECT, to='cookbook.Ingredient'),
+        ),
+    ]

cookbook/migrations/0021_auto_20200216_2309.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.0.2 on 2020-02-16 22:09
+from django.db import migrations
+
+
+def migrate_ingredients(apps, schema_editor):
+    Ingredient = apps.get_model('cookbook', 'Ingredient')
+    RecipeIngredient = apps.get_model('cookbook', 'RecipeIngredient')
+
+    for u in RecipeIngredient.objects.values('name').distinct():
+        ingredient = Ingredient()
+        ingredient.name = u['name']
+        ingredient.save()
+
+    for i in RecipeIngredient.objects.all():
+        i.ingredient = Ingredient.objects.get(name=i.name)
+        i.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('cookbook', '0020_recipeingredient_ingredient'),
+    ]
+
+    operations = [
+        migrations.RunPython(migrate_ingredients),
+    ]

cookbook/migrations/0022_remove_recipeingredient_name.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.0.2 on 2020-02-16 22:11
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0021_auto_20200216_2309'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='recipeingredient',
+            name='name',
+        ),
+    ]

cookbook/migrations/0023_auto_20200216_2311.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.2 on 2020-02-16 22:11
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0022_remove_recipeingredient_name'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='recipeingredient',
+            old_name='ingredient',
+            new_name='name',
+        ),
+    ]

cookbook/migrations/0024_auto_20200216_2313.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.2 on 2020-02-16 22:13
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0023_auto_20200216_2311'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='recipeingredient',
+            old_name='name',
+            new_name='ingredient',
+        ),
+    ]

cookbook/migrations/0025_userpreference_nav_color.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.2 on 2020-02-16 23:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0024_auto_20200216_2313'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='userpreference',
+            name='nav_color',
+            field=models.CharField(choices=[('PRIMARY', 'Primary'), ('SECONDARY', 'Secondary'), ('SUCCESS', 'Success'), ('INFO', 'Info'), ('WARNING', 'Warning'), ('DANGER', 'Danger'), ('LIGHT', 'Light'), ('DARK', 'Dark')], default='PRIMARY', max_length=128),
+        ),
+    ]

cookbook/migrations/0026_auto_20200219_1605.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.0.2 on 2020-02-19 15:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0025_userpreference_nav_color'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='recipe',
+            name='cors_link',
+            field=models.CharField(blank=True, max_length=1024, null=True),
+        ),
+        migrations.AlterField(
+            model_name='recipe',
+            name='link',
+            field=models.CharField(blank=True, max_length=512, null=True),
+        ),
+    ]

cookbook/migrations/0027_ingredient_recipe.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.0.4 on 2020-03-17 17:31
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0026_auto_20200219_1605'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='ingredient',
+            name='recipe',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='cookbook.Recipe'),
+        ),
+    ]

cookbook/migrations/0028_auto_20200317_1901.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.0.4 on 2020-03-17 18:01
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0027_ingredient_recipe'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='recipeingredient',
+            name='ingredient',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='cookbook.Ingredient'),
+        ),
+    ]

cookbook/migrations/0029_auto_20200317_1901.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.0.4 on 2020-03-17 18:01
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0028_auto_20200317_1901'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='recipeingredient',
+            name='unit',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='cookbook.Unit'),
+        ),
+    ]

cookbook/migrations/0030_recipeingredient_note.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.4 on 2020-03-17 18:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0029_auto_20200317_1901'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='recipeingredient',
+            name='note',
+            field=models.CharField(blank=True, max_length=64, null=True),
+        ),
+    ]

cookbook/migrations/0031_auto_20200407_1841.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.4 on 2020-04-07 16:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0030_recipeingredient_note'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='keyword',
+            name='icon',
+            field=models.CharField(blank=True, max_length=16, null=True),
+        ),
+    ]

cookbook/migrations/0032_userpreference_default_unit.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.4 on 2020-04-13 20:34
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0031_auto_20200407_1841'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='userpreference',
+            name='default_unit',
+            field=models.CharField(default='g', max_length=32),
+        ),
+    ]