sandwitches 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

sandwitches/settings.py

@@ -12,21 +12,45 @@ https://docs.djangoproject.com/en/5.2/ref/settings/
 
 from pathlib import Path
 import os
+from django.core.exceptions import ImproperlyConfigured
+from . import storage
 
+DEBUG = bool(os.environ.get("DEBUG", default=0))  # ty:ignore[no-matching-overload]
 
 SECRET_KEY = os.environ.get("SECRET_KEY")
-DEBUG = bool(os.environ.get("DEBUG", default=0))
-ALLOWED_HOSTS = os.environ.get("ALLOWED_HOSTS", "127.0.0.1").split(",")
+if not SECRET_KEY:
+    raise ImproperlyConfigured(
+        "The SECRET_KEY environment variable must be set in production."
+    )
+
+ALLOWED_HOSTS = os.environ.get("ALLOWED_HOSTS", "127.0.0.1, localhost").split(",")
 CSRF_TRUSTED_ORIGINS = os.environ.get("CSRF_TRUSTED_ORIGINS", "").split(",")
+DATABASE_FILE = Path(os.environ.get("DATABASE_FILE", default="/db/db.sqlite3"))  # ty:ignore[no-matching-overload]
+
+storage.is_database_readable(DATABASE_FILE)
+storage.is_database_writable(DATABASE_FILE)
 
-# RECAPTCHA_PROXY = {'http': 'http://127.0.0.1:8000', 'https': 'https://127.0.0.1:8000'}
-# RECAPTCHA_PUBLIC_KEY = os.environ.get("RECAPTCHA_PUBLIC_KEY")
-# RECAPTCHA_PRIVATE_KEY = os.environ.get("RECAPTCHA_PRIVATE_KEY")
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
-TASKS = {"default": {"BACKEND": "django.tasks.backends.immediate.ImmediateBackend"}}
+
+TASKS = {
+    "default": {
+        "BACKEND": "django_tasks.backends.database.DatabaseBackend",
+        "QUEUES": ["default", "emails"],
+        "OPTIONS": {
+            "queues": {
+                "low_priority": {
+                    "max_attempts": 5,
+                }
+            },
+            "max_attempts": 10,
+            "backoff_factor": 3,
+            "purge": {"finished": "10 days", "unfinished": "20 days"},
+        },
+    }
+}
 
 # Application definition
 INSTALLED_APPS = [
@@ -37,14 +61,18 @@ INSTALLED_APPS = [
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "sandwitches",
+    "django_tasks",
+    "django_tasks.backends.database",
     "debug_toolbar",
-    # "django_recaptcha",
+    "imagekit",
     "simple_history",
 ]
 
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.locale.LocaleMiddleware",
     "django.middleware.common.CommonMiddleware",
     "django.middleware.csrf.CsrfViewMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
@@ -67,6 +95,7 @@ TEMPLATES = [
                 "django.contrib.auth.context_processors.auth",
                 "django.contrib.messages.context_processors.messages",
                 "django.template.context_processors.csrf",
+                "django.template.context_processors.i18n",
             ],
         },
     },
@@ -74,17 +103,30 @@ TEMPLATES = [
 
 WSGI_APPLICATION = "sandwitches.wsgi.application"
 
-
-# Database
-# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
-
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": Path("/config/db.sqlite3"),
+        "NAME": DATABASE_FILE,
     }
 }
 
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+        },
+    },
+    "loggers": {
+        "django": {
+            "handlers": ["console"],
+            "level": os.getenv("LOG_LEVEL", "INFO"),
+            "propagate": False,
+        },
+    },
+}
+
 
 # Password validation
 # https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
@@ -111,16 +153,20 @@ MEDIA_ROOT = Path("/config/media")
 
 # Static (for CSS etc)
 STATIC_URL = "/static/"
-STATIC_ROOT = Path("/config/staticfiles")
-
-# Internationalization
-# https://docs.djangoproject.com/en/5.2/topics/i18n/
+STATIC_ROOT = Path("/tmp/staticfiles")
+STATIC_URL = "static/"
 
-LANGUAGE_CODE = "en-us"
+STATICFILES_DIRS = [BASE_DIR / "static", MEDIA_ROOT]
 
+LANGUAGE_CODE = "en"
 TIME_ZONE = "UTC"
-
 USE_I18N = True
+LANGUAGES = [
+    ("en", "English"),
+    ("nl", "Nederlands"),
+]
+
+LOCALE_PATHS = [BASE_DIR / "locale"]
 
 USE_TZ = True
 
@@ -128,11 +174,32 @@ INTERNAL_IPS = [
     "127.0.0.1",
 ]
 
+STORAGES = {
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+    },
+}
 
-# Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/5.2/howto/static-files/
-
-STATIC_URL = "static/"
+EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
+EMAIL_USE_TLS = os.environ.get("SMTP_USE_TLS")
+EMAIL_HOST = os.environ.get("SMTP_HOST")
+EMAIL_HOST_USER = os.environ.get("SMTP_USER")
+EMAIL_HOST_PASSWORD = os.environ.get("SMTP_PASSWORD")
+EMAIL_PORT = os.environ.get("SMTP_PORT")
+EMAIL_FROM_ADDRESS = os.environ.get("SMTP_FROM_EMAIL")
+SEND_EMAIL = all(
+    v is not None
+    for v in [
+        EMAIL_HOST,
+        EMAIL_HOST_USER,
+        EMAIL_HOST_PASSWORD,
+        EMAIL_PORT,
+        EMAIL_FROM_ADDRESS,
+    ]
+)
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field

sandwitches/storage.py

@@ -2,6 +2,9 @@ import hashlib
 import os
 from django.core.files.base import ContentFile
 from django.core.files.storage import FileSystemStorage
+from pathlib import Path
+from django.conf import settings
+import logging
 
 
 class HashedFilenameStorage(FileSystemStorage):
@@ -11,19 +14,69 @@ class HashedFilenameStorage(FileSystemStorage):
     """
 
     def _save(self, name, content):
-        # ensure we read bytes
         try:
             content.seek(0)
         except Exception:
             pass
 
         data = content.read()
-        # compute hash (use first 32 hex chars to keep names shorter)
         h = hashlib.sha256(data).hexdigest()[:32]
         ext = os.path.splitext(name)[1].lower() or ""
-        # store all recipe images under recipes/
         name = f"recipes/{h}{ext}"
 
-        # wrap bytes into a ContentFile so Django storage works consistently
         content = ContentFile(data)
         return super()._save(name, content)
+
+
+def is_database_readable(path=None) -> bool:
+    """
+    Check whether the database file exists and is readable.
+
+    If `path` is None, uses `django.conf.settings.DATABASE_FILE` by default.
+
+    Returns:
+        bool: True if the file exists and is readable by the current process, False otherwise.
+    """
+
+    if path is None:
+        path = getattr(settings, "DATABASE_FILE", None)
+
+    if not path:
+        return False
+
+    p = Path(path)
+    logging.debug(f"Checking database file readability at: {p}")
+    readable = p.is_file() and os.access(p, os.R_OK)
+    if not readable:
+        logging.error(f"Database file at {p} is not readable or does not exist.")
+        return False
+    else:
+        logging.debug(f"Database file at {p} is readable.")
+        return readable
+
+
+def is_database_writable(path=None) -> bool:
+    """
+    Check whether the database file exists and is writable.
+
+    If `path` is None, uses `django.conf.settings.DATABASE_FILE` by default.
+
+    Returns:
+        bool: True if the file exists and is writable by the current process, False otherwise.
+    """
+
+    if path is None:
+        path = getattr(settings, "DATABASE_FILE", None)
+
+    if not path:
+        return False
+
+    p = Path(path)
+    logging.debug(f"Checking database file writability at: {p}")
+    writable = p.is_file() and os.access(p, os.W_OK)
+    if not writable:
+        logging.error(f"Database file at {p} is not writable or does not exist.")
+        return False
+    else:
+        logging.debug(f"Database file at {p} is writable.")
+    return writable

sandwitches/tasks.py

@@ -1,16 +1,99 @@
+# from gunicorn.http.wsgi import log
 import logging
-from django.core.mail import send_mail
-from django.tasks import task
 
+# from django.core.mail import send_mail
+from django_tasks import task
+from django.contrib.auth import get_user_model
 
-logger = logging.getLogger(__name__)
+from django.core.mail import EmailMultiAlternatives
+from django.conf import settings
+
+
+import textwrap
 
 
 @task(takes_context=True, priority=2, queue_name="emails")
-def email_users(context, emails, subject, message):
-    logger.debug(
-        f"Attempt {context.attempt} to send user email. Task result id: {context.task_result.id}."
+def email_users(context, recipe_id):
+    logging.debug(
+        f"Attempt {context.attempt} to send users an email. Task result id: {context.task_result.id}."
     )
-    return send_mail(
-        subject=subject, message=message, from_email=None, recipient_list=emails
+
+    User = get_user_model()
+    emails = list(
+        User.objects.exclude(email__isnull=True)
+        .exclude(email="")
+        .values_list("email", flat=True)
+    )
+
+    if not emails:
+        logging.warning("No users with valid emails found.")
+        return 0
+
+    send_emails(recipe_id, emails)
+
+    return True
+
+
+def send_emails(recipe_id, emails):
+    from .models import Recipe
+
+    logging.debug(f"Preparing to send email to: {emails}")
+    recipe = Recipe.objects.get(pk=recipe_id)  # ty:ignore[unresolved-attribute]
+    from_email = getattr(settings, "EMAIL_FROM_ADDRESS")
+
+    recipe_slug = recipe.get_absolute_url()
+    base_url = (
+        settings.CSRF_TRUSTED_ORIGINS[0]
+        if settings.CSRF_TRUSTED_ORIGINS
+        else "http://localhost"
+    ).rstrip("/")
+
+    raw_message = f"""
+    Hungry? We just added <strong>{recipe.title}</strong> to our collection.
+    
+    It's a delicious recipe that you won't want to miss!
+    {recipe.description}
+
+    Check out the full recipe, ingredients, and steps here:
+    {base_url}{recipe_slug}
+
+    Happy Cooking!
+
+    The Sandwitches Team
+    """
+    wrapped_message = textwrap.fill(textwrap.dedent(raw_message), width=70)
+
+    html_content = f"""
+    <div style="font-family: 'Helvetica', sans-serif; max-width: 600px; margin: auto; border: 1px solid #eee; padding: 20px;">
+        <h2 style="color: #d35400; text-align: center;">New Recipe: {recipe.title} by {recipe.uploaded_by}</h2>
+        <div style="text-align: center; margin: 20px 0;">
+            <img src="{base_url}{recipe.image.url}" alt="{recipe.title}" style="width: 100%; border-radius: 8px;">
+        </div>
+        <p style="font-size: 16px; line-height: 1.5; color: #333;">
+            Hungry? We just added <strong>{recipe.title}</strong> to our collection.
+            <br>
+            It's a delicious recipe that you won't want to miss!
+            <br>
+            {recipe.description}
+            <br>
+            Check out the full recipe, ingredients, and steps here:
+            Click the button below to see how to make it!
+            <br>
+            Happy Cooking!
+            <br>
+            The Sandwitches Team
+        </p>
+        <div style="text-align: center; margin-top: 30px;">
+            <a href="{base_url}{recipe_slug}" style="background-color: #e67e22; color: white; padding: 12px 25px; text-decoration: none; border-radius: 5px; font-weight: bold;">VIEW RECIPE</a>
+        </div>
+    </div>
+    """
+
+    msg = EmailMultiAlternatives(
+        subject=f"Sandwitches - New Recipe: {recipe.title} by {recipe.uploaded_by}",
+        body=wrapped_message,
+        from_email=from_email,
+        bbc=emails,
     )
+    msg.attach_alternative(html_content, "text/html")
+    msg.send()

sandwitches/templates/base.html

@@ -1,5 +1,6 @@
+{% load i18n %}
 <!DOCTYPE html>
-<html lang="en">
+<html lang="{% get_current_language as LANGUAGE_CODE %}{{ LANGUAGE_CODE }}">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />

sandwitches/templates/base_pico.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %} {% block extra_head %}
+{% extends "base.html" %} {% load i18n static %} {% block extra_head %}
 <!-- Pico.css (CDN) -->
 <link
   rel="stylesheet"
@@ -128,6 +128,7 @@
     }
   }
 </style>
+<link rel="icon" type="image/svg+xml" href="{% static "icons/favicon.svg" %}">
 {% endblock %} {% block navbar %}
 <header class="container">
   <nav>
@@ -168,13 +169,26 @@
       </li>
     </ul>
     <ul>
-      <li><a href="api/docs">Docs</a></li>
+      <li>
+        <form method="post" action="{% url 'set_language' %}">
+          {% csrf_token %}
+          <select name="language" onchange="this.form.submit()" aria-label="{% trans 'Language' %}">
+            {% get_current_language as LANGUAGE_CODE %}
+            {% get_available_languages as LANGUAGES %}
+            {% for code,name in LANGUAGES %}
+              <option value="{{ code }}"{% if code == LANGUAGE_CODE %} selected{% endif %}>{{ name }}</option>
+            {% endfor %}
+          </select>
+          <input type="hidden" name="next" value="{{ request.get_full_path }}" />
+        </form>
+      </li>
+      <li><a href="api/docs">{% trans "Docs" %}</a></li>
       {% if user.is_authenticated %}
-      <li><a href="{% url 'admin:index' %}">Admin</a></li>
-      <li><a href="{% url 'admin:logout' %}">Logout</a></li>
+      <li><a href="{% url 'admin:index' %}">{% trans "Admin" %}</a></li>
+      <li><a href="{% url 'admin:logout' %}">{% trans "Logout" %}</a></li>
       {% else %}
-      <li><a href="{% url 'admin:login' %}">Login</a></li>
-      <li><a href="{% url 'signup' %}">Sign up</a></li>
+      <li><a href="{% url 'admin:login' %}">{% trans "Login" %}</a></li>
+      <li><a href="{% url 'signup' %}">{% trans "Sign up" %}</a></li>
       {% endif %}
     </ul>
   </nav>

sandwitches/templates/detail.html

@@ -1,31 +1,50 @@
 {% extends "base_pico.html" %}
 {% block title %}{{ recipe.title }} — Sandwitch{% endblock %}
-
 {% block content %}
 
-{% load markdown_extras %}
+{% load i18n markdown_extras %}
 <nav aria-label="breadcrumb" class="container">
-  <a href="{% url 'index' %}">&larr; Back to all</a>
+  <a href="{% url 'index' %}">&larr; {% trans "Back to all" %}</a>
 </nav>
 
 <div class="grid">
   <article class="card">
     <figure>
       {% if recipe.image %}
-        <img src="{{ recipe.image.url }}" alt="{{ recipe.title }}">
+        <img src="{{ recipe.image_large.url }}" 
+             srcset="{{ recipe.image_medium.url }} 700w, {{ recipe.image_large.url }} 1200w" 
+             sizes="(max-width: 768px) 95vw, 900px"
+             alt="{{ recipe.title }}" 
+             loading="lazy">
       {% endif %}
     </figure>
+{% trans "Description" %}
     <header>
       {{ recipe.title }}
+      {% if recipe.uploaded_by %}
+        <small>{% trans "Uploaded by" %}: {{ recipe.uploaded_by.get_full_name|default:recipe.uploaded_by.username }}</small>
+      {% endif %}
     </header>
-      <h4>Description</h4>
-      {{ recipe.description|convert_markdown|safe|default:"No description yet." }}
+      <h4>{% trans "Description" %}</h4>
+      {% if recipe.description %}
+        {{ recipe.description|convert_markdown|safe }}
+      {% else %}
+        <p>{% trans "No description yet." %}</p>
+      {% endif %}
 
-      <h4>Ingredients</h4>
-      {{ recipe.ingredients|convert_markdown|safe|default:"No ingredients listed." }}
+      <h4>{% trans "Ingredients" %}</h4>
+      {% if recipe.ingredients %}
+        {{ recipe.ingredients|convert_markdown|safe }}
+      {% else %}
+        <p>{% trans "No ingredients listed." %}</p>
+      {% endif %}
 
-      <h4>Instructions</h4>
-      {{ recipe.instructions|convert_markdown|safe|default:"No instructions yet." }}
+      <h4>{% trans "Instructions" %}</h4>
+      {% if recipe.instructions %}
+        {{ recipe.instructions|convert_markdown|safe }}
+      {% else %}
+        <p>{% trans "No instructions yet." %}</p>
+      {% endif %}
     
     <div class="tags-row">
       <div style="margin-top:12px;">
@@ -36,22 +55,22 @@
     </div>
 
     <div style="margin-top:1rem;">
-      <h4>Rating</h4>
+      <h4>{% trans "Rating" %}</h4>
       {% if rating_count %}
-        <p>Average: {{ avg_rating|floatformat:1 }} ({{ rating_count }} vote{% if rating_count %}s{% endif %})</p>
+        <p>{% trans "Average:" %} {{ avg_rating|floatformat:1 }} ({{ rating_count }} {% trans "vote" %}{% if rating_count %}s{% endif %})</p>
       {% else %}
-        <p>No ratings yet.</p>
+        <p>{% trans "No ratings yet." %}</p>
       {% endif %}
 
       {% if user.is_authenticated %}
           {% if user_rating %}
-            <p>Your rating: {{ user_rating.score }}</p>
+            <p>{% trans "Your rating:" %} {{ user_rating.score }}</p>
           {% else %}
             <form method="post" action="{% url 'recipe_rate' pk=recipe.pk %}">
                       {% csrf_token %}
 
                       <fieldset>
-                        <legend>What would you rate this sandwich?</legend>
+                        <legend>{% trans "What would you rate this sandwich?" %}</legend>
 
                         {% if rating_form.score.errors %}
                           <div class="card-panel" role="alert">
@@ -85,12 +104,12 @@
                         </div>
                       </fieldset>
                       <p style="margin-top:0.5rem;">
-                        <button type="submit">{% if user_rating %}Update{% else %}Rate{% endif %}</button>
+                        <button type="submit">{% if user_rating %}{% trans "Update" %}{% else %}{% trans "Rate" %}{% endif %}</button>
                       </p>
                     </form>
           {% endif %}        
       {% else %}
-        <p><a href="{% url 'admin:login' %}">Log in</a> to rate this recipe.</p>
+        <p><a href="{% url 'admin:login' %}">{% trans "Log in" %}</a> {% trans "to rate this recipe." %}</p>
       {% endif %}
     </div>
 

sandwitches/templates/form.html

@@ -2,14 +2,15 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <title>Edit</title>
+    <title>{% trans "Edit" %}</title>
   </head>
   <body>
-    <h1>Edit Recipe: {{ recipe.title }}</h1>
+    {% load i18n %}
+    <h1>{% trans "Edit Recipe:" %} {{ recipe.title }}</h1>
     <form method="post" enctype="multipart/form-data">
       {% csrf_token %} {{ form.as_p }}
-      <button type="submit">Save</button>
-      <a href="{% url 'recipes:admin_list' %}">Cancel</a>
+      <button type="submit">{% trans "Save" %}</button>
+      <a href="{% url 'recipes:admin_list' %}">{% trans "Cancel" %}</a>
     </form>
   </body>
 </html>

sandwitches/templates/index.html

@@ -1,15 +1,15 @@
-{% extends "base_pico.html" %}
+{% extends "base_pico.html" %} {% load i18n static %}
 
 {% block title %}Sandwitches{% endblock %}
 
 {% block content %}
 <div class="grid search-row">
   <div>
-    <h4>Sandwitches: sandwiches so good, they haunt you!</h4>
+    <h4>{% trans 'Sandwitches: sandwiches so good, they haunt you!' %}</h4>
   </div>
   <div>
     <form role="search" onsubmit="return false;">
-      <input id="search" type="search" placeholder="Search by title or tag" aria-label="Search">
+      <input id="search" type="search" placeholder="{% trans "Search by title or tag" %}" aria-label="{% trans "Search" %}">
     </form>
   </div>
 </div>
@@ -19,7 +19,11 @@
     <article class="card" onclick="location.href='{% url 'recipe_detail' recipe.slug %}';" style="cursor:pointer;">
       {% if recipe.image %}
       <figure class="recipe-figure">
-          <img src="{{ recipe.image.url }}" alt="{{ recipe.title }}">
+          <img src="{{ recipe.image_medium.url }}" 
+               srcset="{{ recipe.image_thumbnail.url }} 150w, {{ recipe.image_medium.url }} 700w" 
+               sizes="(max-width: 640px) 90vw, 45vw"
+               alt="{{ recipe.title }}" 
+               loading="lazy">
       </figure>
       {% endif %}
 
@@ -35,7 +39,7 @@
 
       {% if user.is_authenticated and user.is_staff %}
       <footer>            
-          <a href="/admin/sandwitches/recipe/{{ recipe.pk }}/change/" rel="noopener">Edit</a>
+          <a href="/admin/sandwitches/recipe/{{ recipe.pk }}/change/" rel="noopener">{% trans "Edit" %}</a>
       </footer>
       {% endif %}
     </article>
@@ -43,7 +47,7 @@
   {% empty %}
     <article class="card">
       <div class="card-body">
-        <p>No sandwitches yet, please stay tuned.</p>
+        <p>{% trans "No sandwitches yet, please stay tuned." %}</p>
       </div>
     </article>
   {% endfor %}

sandwitches/templates/setup.html

@@ -1,15 +1,17 @@
 {% extends "base_pico.html" %}
-{% load static %}
-{% block title %}Initial setup — Create admin{% endblock %}
+{% load static i18n %}
+{% block title %}{% trans "Initial setup — Create admin" %}{% endblock %}
 
 {% block content %}
 <div class="container" style="max-width:720px; margin:2rem auto;">
   <article class="card">
     <div class="card-body">
-      <h2>Create initial administrator</h2>
+      <h2>{% trans "Create initial administrator" %}</h2>
       <p>
-        This page is only available when there are no admin users in the database.
-        After creating the account you will be logged in and redirected to the admin.
+        {% trans "This page is only available when there are no admin users in the database." %}
+      </p>
+      <p>
+        {% trans "After creating the account you will be logged in and redirected to the admin." %}
       </p>
 
       <form method="post" novalidate>
@@ -43,8 +45,8 @@
         {{ form.password2 }}
 
         <p style="margin-top:1rem;">
-          <button type="submit">Create admin</button>
-          <a class="contrast" href="{% url 'index' %}">Cancel</a>
+          <button type="submit">{% trans "Create admin" %}</button>
+          <a class="contrast" href="{% url 'index' %}">{% trans "Cancel" %}</a>
         </p>
       </form>
     </div>