Merge pull request '# Bcc mail sending' (#527) from 526_BCC_mail_sending into master

Reviewed-on: #527

Dockerfile

@@ -1,36 +0,0 @@
-# Nutze ein schlankes Python-Image
-FROM python:3.11-slim-bullseye
-
-ENV PYTHONUNBUFFERED 1
-
-WORKDIR /konova
-
-# Installiere System-Abhängigkeiten
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    gdal-bin redis-server nginx \
-    && rm -rf /var/lib/apt/lists/*  # Platz sparen
-
-# Erstelle benötigte Verzeichnisse & setze Berechtigungen
-RUN mkdir -p /var/log/nginx /var/log/gunicorn /var/lib/nginx /tmp/nginx_client_body \
-    && touch /var/log/nginx/access.log /var/log/nginx/error.log \
-    && chown -R root:root /var/log/nginx /var/lib/nginx /tmp/nginx_client_body
-
-# Kopiere und installiere Python-Abhängigkeiten
-COPY ./requirements.txt /konova/
-RUN pip install --upgrade pip && pip install --no-cache-dir -r requirements.txt
-
-# Entferne Standard-Nginx-Site und ersetze sie durch eigene Config
-RUN rm -rf /etc/nginx/sites-enabled/default
-COPY ./nginx.conf /etc/nginx/conf.d
-
-# Kopiere restliche Projektdateien
-COPY . /konova/
-
-# Sammle statische Dateien
-RUN python manage.py collectstatic --noinput
-
-# Exponiere Ports
-#EXPOSE 80 6379 8000
-
-# Setze Entrypoint
-ENTRYPOINT ["/konova/docker-entrypoint.sh"]

README.md

@@ -4,7 +4,6 @@ the database postgresql and the css library bootstrap as well as the icon packag
 fontawesome for a modern look, following best practices from the industry.
 
 ## Background processes
-### !!! For non-docker run
 Konova uses celery for background processing. To start the worker you need to run
 ```shell
 $ celery -A konova worker -l INFO
@@ -19,58 +18,3 @@ Technical documention is provided in the projects git wiki.
 A user documentation is not available (and not needed, yet). 
 
 
-# Docker 
-To run the docker-compose as expected, you need to take the following steps:
-
-1. Create a database containing docker, using an appropriate Dockerfile, e.g. the following
-```
-version: '3.3'
-services:
-  postgis:
-    image: postgis/postgis
-    restart: always
-    container_name: postgis-docker
-    ports: 
-      - 5433:5432
-    volumes:
-      - db-volume:/var/lib/postgresql/data
-    environment:
-      - POSTGRES_PASSWORD=postgres
-      - POSTGRES_USER=postgres
-    networks:
-      - db-network-bridge
-
-networks:
-  db-network-bridge:
-    driver: "bridge"
-
-volumes:
-  db-volume:
-```
-This Dockerfile creates a Docker container running postgresql and postgis, creates the default superuser postgres, 
-creates a named volume for persisting the database and creates a new network bridge, which **must be used by any other
-container, which wants to write/read on this database**. 
-
-2. Make sure the name of the network bridge above matches the network in the konova docker-compose.yml  
-3. Get into the running postgis container (`docker exec -it postgis-docker bash`) and create new databases, users and so on. Make sure the database `konova` exists now!
-4. Replace all `CHANGE_ME_xy` values inside of konova/docker-compose.yml for your installation. Make sure the `SSO_HOST` holds the proper SSO host, e.g. for the arnova project `arnova.example.org` (Arnova must be installed and the webserver configured as well, of course)
-5. Take a look on konova/settings.py and konova/sub_settings/django_settings.py. Again: Replace all occurences of `CHANGE_ME` with proper values for your installation.
-   1. Make sure you have the proper host strings added to `ALLOWED_HOSTS` inside of django_settings.py.  
-6. Build and run the docker setup using `docker-compose build` and `docker-compose start` from the main directory of this project (where the docker-compose.yml lives)
-7. Run migrations! To do so, get into the konova service container (`docker exec -it konova-docker bash`) and run the needed commands (`python manage.py makemigrations LIST_OF_ALL_MIGRATABLE_APPS`, then `python manage.py migrate`)
-8. Run the setup command `python manage.py setup` and follow the instructions on the CLI
-9. To enable **SMTP** mail support, make sure your host machine (the one where the docker container run) has the postfix service configured properly. Make sure the `mynetworks` variable is xtended using the docker network bridge ip, created in the postgis container and used by the konova services.
-   1. **Hint**: You can find out this easily by trying to perform a test mail in the running konova web application (which will fail, of course). Then take a look to the latest entries in `/var/log/mail.log` on your host machine. The failed IP will be displayed there.
-   2. **Please note**: This installation guide is based on SMTP using postfix! 
-   3. Restart the postfix service on your host machine to reload the new configuration (`service postfix restart`)
-10. Finally, make sure your host machine webserver passes incoming requests properly to the docker nginx webserver of konova. A proper nginx config for the host machine may look like this:
-```
-server {
-    server_name konova.domain.org;
-
-    location / {
-        proxy_pass http://localhost:KONOVA_NGINX_DOCKER_PORT/;
-        proxy_set_header Host $host;
-    }
-}
-```

docker-compose.yml

@@ -1,21 +0,0 @@
-services:
-  konova:
-    external_links:
-      - postgis:db
-      - arnova-nginx-server:arnova
-    build: .
-    image: "ksp/konova:x.y"
-    container_name: "konova-docker"
-    command: ./docker-entrypoint.sh
-    restart: always
-    volumes:
-      - /data/apps/konova/uploaded_files:/konova_uploaded_files
-    ports:
-      - "1337:80"
-
-# Instead of an own, new network, we need to connect to the existing one, which is provided by the postgis container
-# NOTE: THIS NETWORK MUST EXIST
-networks:
-  default:
-    name: postgis_nat_it_backend
-    external: true

docker-entrypoint.sh

@@ -1,27 +0,0 @@
-#!/bin/bash
-
-set -e  # Beende Skript bei Fehlern
-set -o pipefail  # Fehler in Pipelines nicht ignorieren
-
-# Starte Redis
-redis-server --daemonize yes
-
-# Starte Celery Worker im Hintergrund
-celery -A konova worker --loglevel=info &
-
-# Starte Nginx als Hintergrundprozess
-nginx -g "daemon off;" &
-
-# Setze Gunicorn Worker-Anzahl (Standard: (2*CPUs)+1)
-WORKERS=${GUNICORN_WORKERS:-$((2 * $(nproc) + 1))}
-
-# Stelle sicher, dass Logs existieren
-mkdir -p /var/log/gunicorn
-touch /var/log/gunicorn/access.log /var/log/gunicorn/error.log
-
-# Starte Gunicorn als Hauptprozess
-exec gunicorn --workers="$WORKERS" konova.wsgi:application \
-    --bind=0.0.0.0:8000 \
-    --access-logfile /var/log/gunicorn/access.log \
-    --error-logfile /var/log/gunicorn/error.log \
-    --access-logformat '%({x-real-ip}i)s via %(h)s %(l)s %(u)s %(t)s "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s"'

konova/sub_settings/django_settings.py

@@ -191,10 +191,11 @@ STATICFILES_DIRS = [
 ]
 
 # EMAIL (see https://docs.djangoproject.com/en/dev/topics/email/)
+
+# CHANGE_ME !!! ONLY FOR DEVELOPMENT !!!
 if DEBUG:
-    # ONLY FOR DEVELOPMENT NEEDED
     EMAIL_BACKEND = 'django.core.mail.backends.filebased.EmailBackend'
-    EMAIL_FILE_PATH = '/tmp/app-messages'
+    EMAIL_FILE_PATH = '/tmp/app-messages' # change this to a proper location
 
 DEFAULT_FROM_EMAIL = env("DEFAULT_FROM_EMAIL")  # The default email address for the 'from' element
 SERVER_EMAIL = DEFAULT_FROM_EMAIL  # The default email sender address, which is used by Django to send errors via mail

konova/utils/mailer.py

@@ -5,7 +5,7 @@ Contact: michel.peltriaux@sgdnord.rlp.de
 Created on: 09.11.20
 
 """
-from django.core.mail import send_mail
+from django.core.mail import send_mail, EmailMultiAlternatives
 from django.template.loader import render_to_string
 from django.utils.translation import gettext_lazy as _
 
@@ -45,6 +45,19 @@ class Mailer:
             auth_password=self.auth_password
         )
 
+    def send_via_bcc(self, recipient_list: list, subject: str, msg: str):
+        """
+        Sends a mail with subject and message where recipients will be masked via bcc
+        """
+        email_obj = EmailMultiAlternatives(
+            subject,
+            msg,
+            self.from_mail,
+            bcc=recipient_list,
+        )
+        email_obj.attach_alternative(msg, "text/html")
+        return email_obj.send(fail_silently=self.fail_silently)
+
     def send_mail_shared_access_removed(self, obj, user, municipals_names):
         """ Send a mail if user has no access to the object anymore
 
@@ -115,7 +128,7 @@ class Mailer:
         }
         msg = render_to_string("email/sharing/shared_access_given_team.html", context)
         user_mail_address = users_to_notify.values_list("email", flat=True)
-        self.send(
+        self.send_via_bcc(
             user_mail_address,
             _("{} - Shared access given").format(obj.identifier),
             msg
@@ -141,7 +154,7 @@ class Mailer:
         }
         msg = render_to_string("email/sharing/shared_access_removed_team.html", context)
         user_mail_address = users_to_notify.values_list("email", flat=True)
-        self.send(
+        self.send_via_bcc(
             user_mail_address,
             _("{} - Shared access removed").format(obj.identifier),
             msg
@@ -167,7 +180,7 @@ class Mailer:
         }
         msg = render_to_string("email/recording/shared_data_unrecorded_team.html", context)
         user_mail_address = users_to_notify.values_list("email", flat=True)
-        self.send(
+        self.send_via_bcc(
             user_mail_address,
             _("{} - Shared data unrecorded").format(obj.identifier),
             msg
@@ -193,7 +206,7 @@ class Mailer:
         }
         msg = render_to_string("email/recording/shared_data_recorded_team.html", context)
         user_mail_address = users_to_notify.values_list("email", flat=True)
-        self.send(
+        self.send_via_bcc(
             user_mail_address,
             _("{} - Shared data recorded").format(obj.identifier),
             msg
@@ -219,7 +232,7 @@ class Mailer:
         }
         msg = render_to_string("email/checking/shared_data_checked_team.html", context)
         user_mail_address = users_to_notify.values_list("email", flat=True)
-        self.send(
+        self.send_via_bcc(
             user_mail_address,
             _("{} - Shared data checked").format(obj.identifier),
             msg
@@ -244,7 +257,7 @@ class Mailer:
         }
         msg = render_to_string("email/other/deduction_changed_team.html", context)
         user_mail_address = users_to_notify.values_list("email", flat=True)
-        self.send(
+        self.send_via_bcc(
             user_mail_address,
             _("{} - Deduction changed").format(obj.identifier),
             msg
@@ -270,7 +283,7 @@ class Mailer:
         }
         msg = render_to_string("email/deleting/shared_data_deleted_team.html", context)
         user_mail_address = users_to_notify.values_list("email", flat=True)
-        self.send(
+        self.send_via_bcc(
             user_mail_address,
             _("{} - Shared data deleted").format(obj.identifier),
             msg

nginx.conf

@@ -1,25 +0,0 @@
-server {
-    listen 80;
-    client_max_body_size 25M;
-
-    location / {
-        proxy_pass http://127.0.0.1:8000;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header Host $host;
-        proxy_redirect off;
-        proxy_cache_bypass $http_upgrade;
-    }
-
-    location /static/ {
-        alias /konova/static/;
-        access_log /var/log/nginx/access.log;
-        autoindex off;
-        types {
-            text/css css;
-            application/javascript js;
-        }
-    }
-
-    error_log /var/log/nginx/error.log;
-}

requirements.txt

@@ -48,7 +48,7 @@ pytz==2024.2
 PyYAML==6.0.2
 qrcode==7.3.1
 redis==5.1.0b6
-requests<2.32.0
+requests==2.32.3
 six==1.16.0
 soupsieve==2.5
 sqlparse==0.5.1

templates/400.html

@@ -5,7 +5,7 @@
     <div class="jumbotron">
         <div class="row">
             <div class="col-auto">
-                <img src="{% static 'images/error_imgs/croc_technician_400.png' %}" style="max-width: 150px">
+                <img src="{% static 'images/error_imgs/croc_technician_400_sm.png' %}" style="max-width: 150px">
             </div>
             <div class="col-sm-12 col-md-9 col-lg-9 col-xl-10">
                 <h1 class="display-4">{% fa5_icon 'question-circle' %}400</h1>

templates/500.html

@@ -5,7 +5,7 @@
     <div class="jumbotron">
         <div class="row">
             <div class="col-auto">
-                <img src="{% static 'images/error_imgs/croc_technician_500.png' %}" style="max-width: 150px">
+                <img src="{% static 'images/error_imgs/croc_technician_500_sm.png' %}" style="max-width: 150px">
             </div>
             <div class="col-sm-12 col-md-9 col-lg-9 col-xl-10">
                 <h1 class="display-4">{% fa5_icon 'fire-alt' %} 500</h1>