sandwitches 2.2.0__py3-none-any.whl

sandwitches/settings.py

@@ -0,0 +1,220 @@
+"""
+Django settings for sandwitches project.
+
+Generated by 'django-admin startproject' using Django 5.2.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/topics/settings/
+
+For the full list of settings and their values, see
+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))
+
+SECRET_KEY = os.environ.get("SECRET_KEY")
+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"))
+
+storage.is_database_readable(DATABASE_FILE)
+storage.is_database_writable(DATABASE_FILE)
+
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+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 = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "sandwitches",
+    "django_tasks",
+    "django_tasks.backends.database",
+    "debug_toolbar",
+    "imagekit",
+    "import_export",
+    "simple_history",
+    "solo",
+]
+
+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",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "debug_toolbar.middleware.DebugToolbarMiddleware",
+    "simple_history.middleware.HistoryRequestMiddleware",
+]
+
+ROOT_URLCONF = "sandwitches.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+                "django.template.context_processors.csrf",
+                "django.template.context_processors.i18n",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "sandwitches.wsgi.application"
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.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,
+        },
+    },
+}
+
+LOGIN_REDIRECT_URL = "index"
+LOGOUT_REDIRECT_URL = "index"
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
+
+AUTH_USER_MODEL = "sandwitches.User"
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Media files (for uploaded images)
+MEDIA_URL = "/media/"
+MEDIA_ROOT = Path(os.environ.get("MEDIA_ROOT", default=BASE_DIR / "media"))
+
+# Static (for CSS etc)
+STATIC_URL = "/static/"
+STATIC_ROOT = Path("/tmp/staticfiles")
+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
+
+# EU Date formats
+DATE_FORMAT = "d/m/Y"
+DATETIME_FORMAT = "d/m/Y H:i:s"
+SHORT_DATE_FORMAT = "d/m/Y"
+SHORT_DATETIME_FORMAT = "d/m/Y H:i"
+
+INTERNAL_IPS = [
+    "127.0.0.1",
+]
+
+STORAGES = {
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+    },
+}
+
+
+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
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

sandwitches/storage.py

@@ -0,0 +1,114 @@
+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):
+    """
+    Save uploaded files under a hash of their contents + original extension.
+    Example output: media/recipes/3f8a9d...png
+    """
+
+    def _save(self, name, content):
+        try:
+            content.seek(0)
+        except Exception:
+            pass
+
+        data = content.read()
+        h = hashlib.sha256(data).hexdigest()[:32]
+        ext = os.path.splitext(name)[1].lower() or ""
+        name = f"recipes/{h}{ext}"
+
+        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}")
+    try:
+        if p.is_file():
+            with open(p, "r"):  # Removed 'as f'
+                # If we can open it, it's readable. No need to read content.
+                pass
+            logging.debug(f"Database file at {p} is readable.")
+            return True
+        else:
+            logging.error(f"Database file at {p} does not exist.")
+            return False
+    except IOError:
+        logging.error(
+            f"Database file at {p} is not readable due to permission or other IO error."
+        )
+        return False
+
+
+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}")
+    try:
+        # If the file exists, try to open it for appending
+        if p.is_file():
+            with open(p, "a"):  # Removed 'as f'
+                pass
+            logging.debug(f"Database file at {p} is writable.")
+            return True
+        else:
+            # If file does not exist, check if its parent directory is writable
+            if p.parent.is_dir() and os.access(p.parent, os.W_OK):
+                # Try creating a dummy file to confirm writability
+                dummy_file = p.parent / f".tmp_writable_test_{os.getpid()}"
+                try:
+                    dummy_file.touch()
+                    dummy_file.unlink()
+                    logging.debug(f"Database path at {p.parent} is writable.")
+                    return True
+                except IOError:
+                    logging.error(f"Cannot create dummy file in {p.parent}.")
+                    return False
+            else:
+                logging.error(
+                    f"Parent directory {p.parent} is not writable or does not exist."
+                )
+                return False
+
+    except IOError:
+        logging.error(
+            f"Database file at {p} is not writable due to permission or other IO error."
+        )
+        return False

sandwitches/tasks.py

@@ -0,0 +1,115 @@
+# from gunicorn.http.wsgi import log
+import logging
+
+# from django.core.mail import send_mail
+from django_tasks import task
+from django.contrib.auth import get_user_model
+
+from django.core.mail import EmailMultiAlternatives
+from django.conf import settings
+from django.utils.translation import gettext as _
+
+
+import textwrap
+
+
+@task(takes_context=True, priority=2, queue_name="emails")
+def email_users(context, recipe_id):
+    logging.debug(
+        f"Attempt {context.attempt} to send users an email. Task result id: {context.task_result.id}."
+    )
+
+    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_fmt = _("""
+    Hungry? We just added <strong>%(title)s</strong> to our collection.
+
+    It's a delicious recipe that you won't want to miss!
+    %(description)s
+
+    Check out the full recipe, ingredients, and steps here:
+    %(url)s
+
+    Happy Cooking!
+
+    The Sandwitches Team
+    """)
+
+    context_data = {
+        "title": recipe.title,
+        "uploaded_by": recipe.uploaded_by,
+        "description": recipe.description,
+        "url": f"{base_url}{recipe_slug}",
+        "image_url": f"{base_url}{recipe.image.url}" if recipe.image else "",
+    }
+
+    wrapped_message = textwrap.fill(
+        textwrap.dedent(raw_message_fmt) % context_data, width=70
+    )
+
+    html_content_fmt = _("""
+    <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: %(title)s by %(uploaded_by)s</h2>
+        <div style="text-align: center; margin: 20px 0;">
+            <img src="%(image_url)s" alt="%(title)s" style="width: 100%%; border-radius: 8px;">
+        </div>
+        <p style="font-size: 16px; line-height: 1.5; color: #333;">
+            Hungry? We just added <strong>%(title)s</strong> to our collection.
+            <br>
+            It's a delicious recipe that you won't want to miss!
+            <br>
+            %(description)s
+            <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="%(url)s" style="background-color: #e67e22; color: white; padding: 12px 25px; text-decoration: none; border-radius: 5px; font-weight: bold;">VIEW RECIPE</a>
+        </div>
+    </div>
+    """)
+
+    html_content = html_content_fmt % context_data
+
+    subject = _("Sandwitches - New Recipe: %(title)s by %(uploaded_by)s") % context_data
+    for email in emails:
+        msg = EmailMultiAlternatives(
+            subject=subject,
+            body=wrapped_message,
+            from_email=from_email,
+            to=[email],
+        )
+        msg.attach_alternative(html_content, "text/html")
+        msg.send()

sandwitches/templates/admin/admin_base.html

@@ -0,0 +1,118 @@
+{% extends "base.html" %}
+{% load i18n static %}
+
+{% block extra_head %}
+<link href="https://cdn.jsdelivr.net/npm/beercss@3.7.12/dist/cdn/beer.min.css" rel="stylesheet">
+<script type="module" src="https://cdn.jsdelivr.net/npm/beercss@3.7.12/dist/cdn/beer.min.js"></script>
+<script type="module" src="https://cdn.jsdelivr.net/npm/material-dynamic-colors@1.1.2/dist/cdn/material-dynamic-colors.min.js"></script>
+<script src="https://unpkg.com/htmx.org@2.0.8/dist/htmx.min.js"></script>
+<link rel="icon" type="image/svg+xml" href="{% static "icons/favicon.svg" %}">
+<style>
+    main.container {
+        padding-top: 2rem;
+        padding-bottom: 2rem;
+    }
+    .admin-thumb {
+        width: 80px;
+        height: 80px;
+        object-fit: cover;
+    }
+</style>
+{% endblock %}
+
+{% block navbar %}
+<nav class="top primary-container">
+  <button class="circle transparent" data-ui="#admin-menu">
+    <i>menu</i>
+  </button>
+  <a href="{% url 'admin_dashboard' %}" class="row align-center">
+    <img src="{% static 'icons/icon.svg' %}" class="circle small">
+    <h6 class="max">{% block admin_title %}{% trans "Sandwitches Admin" %}{% endblock %}</h6>
+  </a>
+  <div class="max"></div>
+  <button class="circle transparent" onclick="toggleMode()">
+    <i>dark_mode</i>
+  </button>
+
+  {% if user.avatar %}
+  <img src="{{ user.avatar.url }}" class="circle" data-ui="#user-menu">
+  {% else %}
+  <img src="https://www.w3schools.com/howto/img_avatar.png" class="circle" data-ui="#user-menu">
+  {% endif %}
+</nav>
+
+<dialog id="admin-menu" class="left">
+    <nav class="drawer vertical">
+        <header>
+            <img src="{% static 'icons/icon.svg' %}" class="circle large">
+            <h5 class="max">{% trans "Admin" %}</h5>
+        </header>
+        <div class="space"></div>
+        <a href="{% url 'admin_dashboard' %}" class="{% if request.resolver_match.url_name == 'admin_dashboard' %}active{% endif %}">
+            <i>dashboard</i>
+            <span>{% trans "Dashboard" %}</span>
+        </a>
+        <a href="{% url 'admin_recipe_list' %}" class="{% if request.resolver_match.url_name == 'admin_recipe_list' %}active{% endif %}">
+            <i>restaurant</i>
+            <span>{% trans "Recipes" %}</span>
+        </a>
+        <a href="{% url 'admin_user_list' %}" class="{% if request.resolver_match.url_name == 'admin_user_list' %}active{% endif %}">
+            <i>people</i>
+            <span>{% trans "Users" %}</span>
+        </a>
+        <a href="{% url 'admin_tag_list' %}" class="{% if request.resolver_match.url_name == 'admin_tag_list' %}active{% endif %}">
+            <i>label</i>
+            <span>{% trans "Tags" %}</span>
+        </a>
+        <a href="{% url 'admin_rating_list' %}" class="{% if request.resolver_match.url_name == 'admin_rating_list' %}active{% endif %}">
+            <i>star</i>
+            <span>{% trans "Ratings" %}</span>
+        </a>
+        <a href="{% url 'admin_task_list' %}" class="{% if request.resolver_match.url_name == 'admin_task_list' %}active{% endif %}">
+            <i>assignment</i>
+            <span>{% trans "Tasks" %}</span>
+        </a>
+        <div class="divider"></div>
+        <a href="{% url 'index' %}">
+            <i>home</i>
+            <span>{% trans "Public Site" %}</span>
+        </a>
+    </nav>
+</dialog>
+
+{% if user.is_authenticated %}
+<menu id="user-menu" class="no-wrap left">
+  <a href="{% url 'admin:logout' %}" class="row"><i>logout</i>{% trans "Logout" %}</a>
+</menu>
+{% endif %}
+
+{% if messages %}
+<div class="padding">
+    {% for message in messages %}
+    <div class="snackbar active {% if message.tags == 'error' %}error{% else %}primary{% endif %}">
+        <i>{% if message.tags == 'error' %}error{% else %}info{% endif %}</i>
+        <span>{{ message }}</span>
+    </div>
+    {% endfor %}
+</div>
+{% endif %}
+{% endblock %}
+
+{% block footer %}
+<footer class="padding">
+    <div class="row align-center">
+        <div class="max">
+            <h6 class="small">Sandwitches Admin</h6>
+            <div class="small-text">© {% now "Y" %} Sandwitches Inc.</div>
+        </div>
+        <nav>
+            version {{ version }}
+        </nav>
+    </div>
+</footer>
+{% endblock %}
+
+{% block extra_scripts %}
+{{ block.super }}
+{% block admin_scripts %}{% endblock %}
+{% endblock %}

sandwitches/templates/admin/confirm_delete.html

@@ -0,0 +1,23 @@
+{% extends "admin/admin_base.html" %}
+{% load i18n %}
+
+{% block admin_title %}{% trans "Confirm Delete" %}{% endblock %}
+
+{% block content %}
+<article class="round padding center-align">
+    <i class="extra error-text">warning</i>
+    <h5>{% trans "Are you sure?" %}</h5>
+    <p>{% trans "You are about to delete the following" %} {{ type }}: <b>{{ object }}</b></p>
+    <p>{% trans "This action cannot be undone." %}</p>
+
+    <div class="space"></div>
+
+    <form method="post">
+        {% csrf_token %}
+        <nav class="center-align">
+            <button type="button" class="button transparent" onclick="history.back()">{% trans "Cancel" %}</button>
+            <button type="submit" class="button error round">{% trans "Yes, Delete" %}</button>
+        </nav>
+    </form>
+</article>
+{% endblock %}