From eccbb7b234e7e21078b18935072c3f2a6c858eec Mon Sep 17 00:00:00 2001 From: jedi Date: Wed, 26 Jun 2024 18:42:56 +0200 Subject: [PATCH 01/36] stash --- core/authentication/admin.py | 3 + core/core/settings.py | 9 +- core/core/urls.py | 1 + core/mail/models.py | 4 + core/mail/protocol.py | 46 +++++-- core/mail/tests/v2/test_user_notifications.py | 20 ++++ core/notifications/__init__.py | 0 core/notifications/admin.py | 15 +++ core/notifications/api_v2.py | 37 ++++++ core/notifications/defaults.py | 16 +++ core/notifications/dispatch.py | 85 +++++++++++++ core/notifications/migrations/0001_initial.py | 51 ++++++++ core/notifications/migrations/__init__.py | 0 core/notifications/models.py | 29 +++++ core/notifications/templates.py | 69 +++++++++++ core/notifications/tests/__init__.py | 0 core/notify_sessions/decorators.py | 21 ++++ core/server.py | 7 ++ core/tickets/api_v2.py | 6 + core/tickets/models.py | 2 +- core/tickets/serializers.py | 4 +- core/tickets/tests/v2/test_tickets.py | 10 ++ .../ansible/playbooks/templates/django.env.j2 | 2 + web/package.json | 1 + web/src/components/CollapsableCards.vue | 32 +++++ web/src/components/SlotTable.vue | 105 ++++++++++++++++ web/src/components/Toast.vue | 48 ++++++++ web/src/components/inputs/FormatedText.vue | 112 ++++++++++++++++++ web/src/main.js | 2 + web/src/router.js | 13 ++ web/src/store.js | 51 ++++++++ web/src/views/Tickets.vue | 8 +- web/src/views/admin/Admin.vue | 6 + web/src/views/admin/Debug.vue | 87 ++++++++++++++ web/src/views/admin/Notifications.vue | 36 ++++++ web/src/views/admin/Settings.vue | 109 +++++++++++++++++ 36 files changed, 1029 insertions(+), 18 deletions(-) create mode 100644 core/mail/tests/v2/test_user_notifications.py create mode 100644 core/notifications/__init__.py create mode 100644 core/notifications/admin.py create mode 100644 core/notifications/api_v2.py create mode 100644 core/notifications/defaults.py create mode 100644 core/notifications/dispatch.py create mode 100644 core/notifications/migrations/0001_initial.py create mode 100644 core/notifications/migrations/__init__.py create mode 100644 core/notifications/models.py create mode 100644 core/notifications/templates.py create mode 100644 core/notifications/tests/__init__.py create mode 100644 core/notify_sessions/decorators.py mode change 100644 => 100755 core/server.py create mode 100644 web/src/components/SlotTable.vue create mode 100644 web/src/components/Toast.vue create mode 100644 web/src/components/inputs/FormatedText.vue create mode 100644 web/src/views/admin/Debug.vue create mode 100644 web/src/views/admin/Notifications.vue create mode 100644 web/src/views/admin/Settings.vue diff --git a/core/authentication/admin.py b/core/authentication/admin.py index 0024cb0..dfb4d20 100644 --- a/core/authentication/admin.py +++ b/core/authentication/admin.py @@ -10,5 +10,8 @@ class ExtendedUserAdmin(UserAdmin): ordering = ('username',) filter_horizontal = ('groups', 'user_permissions', 'permissions') +# def permissions(self, obj): +# return ', '.join(obj.get_all_permissions()) + admin.site.register(ExtendedUser, ExtendedUserAdmin) diff --git a/core/core/settings.py b/core/core/settings.py index db23180..80e2e3a 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -29,7 +29,9 @@ SECRET_KEY = 'django-insecure-tm*$w_14iqbiy-!7(8#ba7j+_@(7@rf2&a^!=shs&$03b%2*rv # SECURITY WARNING: don't run with debug turned on in production! DEBUG = True -ALLOWED_HOSTS = [os.getenv('HTTP_HOST', 'localhost')] +PRIMARY_HOST = os.getenv('HTTP_HOST', 'localhost') + +ALLOWED_HOSTS = [PRIMARY_HOST] MAIL_DOMAIN = os.getenv('MAIL_DOMAIN', 'localhost') @@ -40,6 +42,10 @@ LEGACY_USER_PASSWORD = os.getenv('LEGACY_API_PASSWORD', 'legacy_password') SYSTEM3_VERSION = "0.0.0-dev.0" +TELEGRAM_BOT_TOKEN = os.getenv('TELEGRAM_BOT_TOKEN', '1234567890:ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghi') + +TELEGRAM_GROUP_CHAT_ID = os.getenv('TELEGRAM_GROUP_CHAT_ID', '-1234567890') + # Application definition INSTALLED_APPS = [ @@ -55,6 +61,7 @@ INSTALLED_APPS = [ 'drf_yasg', 'channels', 'authentication', + 'notifications', 'files', 'tickets', 'inventory', diff --git a/core/core/urls.py b/core/core/urls.py index b0161bb..ba3e975 100644 --- a/core/core/urls.py +++ b/core/core/urls.py @@ -31,5 +31,6 @@ urlpatterns = [ path('api/2/', include('mail.api_v2')), path('api/2/', include('notify_sessions.api_v2')), path('api/2/', include('authentication.api_v2')), + path('api/2/', include('notifications.api_v2')), path('api/', get_info), ] diff --git a/core/mail/models.py b/core/mail/models.py index 378854b..21061b5 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -3,6 +3,7 @@ import random from django.db import models from django_softdelete.models import SoftDeleteModel +from authentication.models import ExtendedUser from core.settings import MAIL_DOMAIN from files.models import AbstractFile from inventory.models import Event @@ -38,3 +39,6 @@ class EventAddress(models.Model): class EmailAttachment(AbstractFile): email = models.ForeignKey(Email, models.CASCADE, related_name='attachments', null=True) name = models.CharField(max_length=255) + + + diff --git a/core/mail/protocol.py b/core/mail/protocol.py index a87f1a6..238a8af 100644 --- a/core/mail/protocol.py +++ b/core/mail/protocol.py @@ -7,6 +7,7 @@ from channels.db import database_sync_to_async from django.core.files.base import ContentFile from mail.models import Email, EventAddress, EmailAttachment +from notifications.templates import render_auto_reply from notify_sessions.models import SystemEvent from tickets.models import IssueThread @@ -87,6 +88,22 @@ def make_reply(reply_email, references=None, event=None): return reply +def make_notification(message, to, title): # TODO where should replies to this go + from email.message import EmailMessage + from core.settings import MAIL_DOMAIN + notification = EmailMessage() + notification["From"] = "notifications@%s" % MAIL_DOMAIN + notification["To"] = to + notification["Subject"] = f"[C3LF Notification]%s" % title + # notification["Reply-To"] = f"{event}@{MAIL_DOMAIN}" + # notification["In-Reply-To"] = email.reference + # notification["Message-ID"] = email.id + "@" + MAIL_DOMAIN + + notification.set_content(message) + + return notification + + async def send_smtp(message): await aiosmtplib.send(message, hostname="127.0.0.1", port=25, use_tls=False, start_tls=False) @@ -185,6 +202,16 @@ def receive_email(envelope, log=None): header_in_reply_to = parsed.get('In-Reply-To') header_message_id = parsed.get('Message-ID') + # if header_from != envelope.mail_from: + # log.warning("Header from does not match envelope from") + # log.info(f"Header from: {header_from}, envelope from: {envelope.mail_from}") + # + # if header_to != envelope.rcpt_tos[0]: + # log.warning("Header to does not match envelope to") + # log.info(f"Header to: {header_to}, envelope to: {envelope.rcpt_tos[0]}") + + # handle undelivered mail header_from : 'Mail Delivery System ") == "": log.warning("Ignoring mailer daemon") raise SpecialMailException("Ignoring mailer daemon") @@ -218,16 +245,7 @@ def receive_email(envelope, log=None): references = collect_references(active_issue_thread) if not sender.startswith('noreply'): subject = f"Re: {subject} [#{active_issue_thread.short_uuid()}]" - body = '''Your request (#{}) has been received and will be reviewed by our lost&found angels. - -We are reviewing incoming requests during the event and teardown. Immediately after the event, expect a delay as the \ -workload is high. We will not forget about your request and get back in touch once we have updated information on your \ -request. Requests for devices, wallets, credit cards or similar items will be handled with priority. - -If you happen to find your lost item or just want to add additional information, please reply to this email. Please \ -do not create a new request. - -Your c3lf (Cloakroom + Lost&Found) Team'''.format(active_issue_thread.short_uuid()) + body = render_auto_reply(active_issue_thread) reply_email = Email.objects.create( sender=recipient, recipient=sender, body=body, subject=subject, in_reply_to=header_message_id, event=target_event, issue_thread=active_issue_thread) @@ -270,11 +288,19 @@ class LMTPHandler: 'general', {"type": "generic.event", "name": "send_message_to_frontend", "event_id": systemevent.id, "message": "email received"}) log.info(f"Sent message to frontend") + if new and reply: log.info('Sending message to %s' % reply['To']) await send_smtp(reply) log.info("Sent auto reply") + if thread: + await channel_layer.group_send( + 'general', {"type": "generic.event", "name": "user_notification", "event_id": systemevent.id, + "ticket_id": thread.id, "new": new}) + else: + print("No thread found") + return '250 Message accepted for delivery' except SpecialMailException as e: import uuid diff --git a/core/mail/tests/v2/test_user_notifications.py b/core/mail/tests/v2/test_user_notifications.py new file mode 100644 index 0000000..c4db23f --- /dev/null +++ b/core/mail/tests/v2/test_user_notifications.py @@ -0,0 +1,20 @@ +from django.contrib.auth.models import Permission +from django.test import TestCase + +from authentication.models import ExtendedUser +from notifications.models import UserNotificationChannel + + +class UserNotificationTestCase(TestCase): + + def setUp(self): + super().setUp() + self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') + self.user.user_permissions.add(*Permission.objects.all()) + self.user.save() + self.channel = UserNotificationChannel.objects.create(user=self.user, channel_type='telegram', + channel_target='123456789', + event_filter='*', active=True) + + async def test_telegram_notify(self): + pass diff --git a/core/notifications/__init__.py b/core/notifications/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/core/notifications/admin.py b/core/notifications/admin.py new file mode 100644 index 0000000..69620a9 --- /dev/null +++ b/core/notifications/admin.py @@ -0,0 +1,15 @@ +from django.contrib import admin + +from notifications.models import MessageTemplate, UserNotificationChannel + + +class MessageTemplateAdmin(admin.ModelAdmin): + pass + + +class UserNotificationChannelAdmin(admin.ModelAdmin): + pass + + +admin.site.register(MessageTemplate, MessageTemplateAdmin) +admin.site.register(UserNotificationChannel, UserNotificationChannelAdmin) diff --git a/core/notifications/api_v2.py b/core/notifications/api_v2.py new file mode 100644 index 0000000..f50a453 --- /dev/null +++ b/core/notifications/api_v2.py @@ -0,0 +1,37 @@ +from django.contrib.auth.decorators import permission_required +from rest_framework import routers, viewsets +from django.urls import re_path +from rest_framework.decorators import api_view, permission_classes +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response + +from notifications.models import MessageTemplate +from rest_framework import serializers + +from notifications.templates import TEMPLATE_VARS + + +class MessageTemplateSerializer(serializers.ModelSerializer): + class Meta: + model = MessageTemplate + fields = '__all__' + + +class MessageTemplateViewSet(viewsets.ModelViewSet): + serializer_class = MessageTemplateSerializer + queryset = MessageTemplate.objects.all() + + +@api_view(['GET']) +@permission_classes([IsAuthenticated]) +@permission_required('tickets.add_issuethread_manual', raise_exception=True) # TDOO: change this permission +def get_template_vars(self): + return Response(TEMPLATE_VARS, status=200) + + +router = routers.SimpleRouter() +router.register(r'message_templates', MessageTemplateViewSet) + +urlpatterns = ([ + re_path('message_template_variables', get_template_vars), + ] + router.urls) diff --git a/core/notifications/defaults.py b/core/notifications/defaults.py new file mode 100644 index 0000000..812d93e --- /dev/null +++ b/core/notifications/defaults.py @@ -0,0 +1,16 @@ +auto_reply_body = '''Your request (#{{ ticket_uuid }}) has been received and will be reviewed by our lost&found angels. + +We are reviewing incoming requests during the event and teardown. Immediately after the event, expect a delay as the \ +workload is high. We will not forget about your request and get back in touch once we have updated information on your \ +request. Requests for devices, wallets, credit cards or similar items will be handled with priority. + +If you happen to find your lost item or just want to add additional information, please reply to this email. Please \ +do not create a new request. + +Your c3lf (Cloakroom + Lost&Found) Team''' + +new_issue_notification = '''New issue "{{ ticket_name | limit_length }}" [{{ ticket_uuid }}] created +{{ ticket_url }}''' + +reply_issue_notification = '''Reply to issue "{{ ticket_name }}" [{{ ticket_uuid }}] (was {{ previous_state_pretty }}) +{{ ticket_url }}''' diff --git a/core/notifications/dispatch.py b/core/notifications/dispatch.py new file mode 100644 index 0000000..752c342 --- /dev/null +++ b/core/notifications/dispatch.py @@ -0,0 +1,85 @@ +import asyncio + +from aiohttp.client import ClientSession +from channels.layers import get_channel_layer +from channels.db import database_sync_to_async +from urllib.parse import quote as urlencode + +from core.settings import TELEGRAM_BOT_TOKEN, TELEGRAM_GROUP_CHAT_ID +from mail.protocol import send_smtp, make_notification +from notifications.models import UserNotificationChannel +from notifications.templates import render_notification_new_ticket_async, render_notification_reply_ticket_async +from tickets.models import IssueThread + + +async def http_get(url): + async with ClientSession() as session: + async with session.get(url) as response: + return await response.text() + + +async def telegram_notify(message, chat_id): + encoded_message = urlencode(message) + url = f"https://api.telegram.org/bot{TELEGRAM_BOT_TOKEN}/sendMessage?chat_id={chat_id}&text={encoded_message}" + return await http_get(url) + + +async def email_notify(message, title, email): + mail = make_notification(message, email, title) + await send_smtp(mail) + + +class NotificationDispatcher: + channel_layer = None + room_group_name = "general" + + def __init__(self): + self.channel_layer = get_channel_layer('default') + if not self.channel_layer: + raise Exception("Could not get channel layer") + + @database_sync_to_async + def get_notification_targets(self): + channels = UserNotificationChannel.objects.filter(active=True) + return list(channels) + + @database_sync_to_async + def get_ticket(self, ticket_id): + return IssueThread.objects.filter(id=ticket_id).select_related('event').first() + + async def run_forever(self): + # Infinite loop to continuously listen for messages + print("Listening for messages...") + channel_name = await self.channel_layer.new_channel() + await self.channel_layer.group_add(self.room_group_name, channel_name) + print("Channel name:", channel_name) + while True: + # Blocking receive to get the message from the channel layer + message = await self.channel_layer.receive(channel_name) + + if (message and 'type' in message and message['type'] == 'generic.event' and 'name' in message and + message['name'] == 'user_notification'): + if 'ticket_id' in message and 'event_id' in message and 'new' in message: + ticket = await self.get_ticket(message['ticket_id']) + await self.dispatch(ticket, message['event_id'], message['new']) + else: + print("Error: Invalid message format") + + async def dispatch(self, ticket, event_id, new): + message = await render_notification_new_ticket_async( + ticket) if new else await render_notification_reply_ticket_async(ticket) + title = f"[#{ticket.short_uuid()}] {ticket.name}" + print("Dispatching message:", message, "with event_id:", event_id) + targets = await self.get_notification_targets() + jobs = [] + jobs.append(telegram_notify(message, TELEGRAM_GROUP_CHAT_ID)) + for target in targets: + if target.channel_type == 'telegram': + print("Sending telegram notification to:", target.channel_target) + jobs.append(telegram_notify(message, target.channel_target)) + elif target.channel_type == 'email': + print("Sending email notification to:", target.channel_target) + jobs.append(email_notify(message, title, target.channel_target)) + else: + print("Unknown channel type:", target.channel_type) + await asyncio.gather(*jobs) diff --git a/core/notifications/migrations/0001_initial.py b/core/notifications/migrations/0001_initial.py new file mode 100644 index 0000000..4d276eb --- /dev/null +++ b/core/notifications/migrations/0001_initial.py @@ -0,0 +1,51 @@ +# Generated by Django 4.2.7 on 2024-05-03 21:02 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + +from notifications.defaults import auto_reply_body, new_issue_notification, reply_issue_notification +from notifications.models import MessageTemplate + + +class Migration(migrations.Migration): + initial = True + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + def create_required_templates(apps, schema_editor): + MessageTemplate.objects.create(name='auto_reply', message=auto_reply_body, marked_required=True) + MessageTemplate.objects.create(name='new_issue_notification', message=new_issue_notification, + marked_required=True) + MessageTemplate.objects.create(name='reply_issue_notification', message=reply_issue_notification, + marked_required=True) + + operations = [ + migrations.CreateModel( + name='MessageTemplate', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(max_length=255)), + ('message', models.TextField()), + ('created', models.DateTimeField(auto_now_add=True)), + ('marked_confidential', models.BooleanField(default=False)), + ('marked_required', models.BooleanField(default=False)), + ], + ), + migrations.CreateModel( + name='UserNotificationChannel', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('channel_type', + models.CharField(choices=[('telegram', 'telegram'), ('email', 'email')], max_length=255)), + ('channel_target', models.CharField(max_length=255)), + ('event_filter', models.CharField(max_length=255)), + ('active', models.BooleanField(default=True)), + ('created', models.DateTimeField(auto_now_add=True)), + ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)), + ], + ), + migrations.RunPython(create_required_templates), + ] diff --git a/core/notifications/migrations/__init__.py b/core/notifications/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/core/notifications/models.py b/core/notifications/models.py new file mode 100644 index 0000000..9cbfbe5 --- /dev/null +++ b/core/notifications/models.py @@ -0,0 +1,29 @@ +from django.db import models + +from authentication.models import ExtendedUser + + +class MessageTemplate(models.Model): + name = models.CharField(max_length=255) + message = models.TextField() + created = models.DateTimeField(auto_now_add=True) + marked_confidential = models.BooleanField(default=False) + marked_required = models.BooleanField(default=False) # may not be deleted + + def __str__(self): + return self.name + + +class UserNotificationChannel(models.Model): + user = models.ForeignKey(ExtendedUser, models.CASCADE) + channel_type = models.CharField(choices=[('telegram', 'telegram'), ('email', 'email')], max_length=255) + channel_target = models.CharField(max_length=255) + event_filter = models.CharField(max_length=255) + active = models.BooleanField(default=True) + created = models.DateTimeField(auto_now_add=True) + + def validate_constraints(self, exclude=None): # TODO: email -> emailaddress, telegram -> chatid + return True + + def __str__(self): + return self.user.username + '(' + self.channel_type + ')' diff --git a/core/notifications/templates.py b/core/notifications/templates.py new file mode 100644 index 0000000..af77193 --- /dev/null +++ b/core/notifications/templates.py @@ -0,0 +1,69 @@ +import jinja2 +from channels.db import database_sync_to_async +from core.settings import PRIMARY_HOST + +from notifications.models import MessageTemplate + +TEMPLATE_VARS = ['ticket_name', 'ticket_uuid', 'ticket_id', 'ticket_url', + 'current_state', 'previous_state', 'current_state_pretty', 'previous_state_pretty', + 'event_slug', 'event_name', + 'username', 'user_nick', + 'web_host'] # TODO customer_name, tracking_code + + +def limit_length(s, length=50): + if len(s) > length: + return s[:(length - 3)] + "..." + return s + + +def ticket_url(ticket): + eventslug = ticket.event.slug if ticket.event else "37C3" # TODO 37C3 should not be hardcoded + return f"https://{PRIMARY_HOST}/{eventslug}/ticket/{ticket.id}/" + + +def render_template(template, **kwargs): + try: + environment = jinja2.Environment() + environment.filters['limit_length'] = limit_length + tmpl = MessageTemplate.objects.get(name=template) + template = environment.from_string(tmpl.message) + return template.render(**kwargs, web_host=PRIMARY_HOST) + except MessageTemplate.DoesNotExist: + return None + + +def get_ticket_vars(ticket): + states = list(ticket.state_changes.order_by('-timestamp')) + return { + 'ticket_name': ticket.name, + 'ticket_uuid': ticket.short_uuid(), + 'ticket_id': ticket.id, + 'ticket_url': ticket_url(ticket), + 'current_state': states[0].state if states else 'none', + 'previous_state': states[1].state if len(states) > 1 else 'none', + 'current_state_pretty': states[0].get_state_display() if states else 'none', + 'previous_state_pretty': states[1].get_state_display() if len(states) > 1 else 'none', + 'event_slug': ticket.event.slug if ticket.event else "37C3", # TODO 37C3 should not be hardcoded + 'event_name': ticket.event.name if ticket.event else "37C3", + } + + +def render_auto_reply(ticket): + return render_template('auto_reply', **get_ticket_vars(ticket)) + + +def render_notification_new_ticket(ticket): + return render_template('new_issue_notification', **get_ticket_vars(ticket)) + + +def render_notification_reply_ticket(ticket): + return render_template('reply_issue_notification', **get_ticket_vars(ticket)) + + +async def render_notification_new_ticket_async(ticket): + return await database_sync_to_async(render_notification_new_ticket)(ticket) + + +async def render_notification_reply_ticket_async(ticket): + return await database_sync_to_async(render_notification_reply_ticket)(ticket) diff --git a/core/notifications/tests/__init__.py b/core/notifications/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/core/notify_sessions/decorators.py b/core/notify_sessions/decorators.py new file mode 100644 index 0000000..c349c42 --- /dev/null +++ b/core/notify_sessions/decorators.py @@ -0,0 +1,21 @@ +from asgiref.sync import async_to_sync +from channels.layers import get_channel_layer + + +def notify_sessions(event, data): + def wrapper(func): + def wrapped(*args, **kwargs): + ret = func(*args, **kwargs) + channel_layer = get_channel_layer() + async_to_sync(channel_layer.group_send)( + event, + { + 'type': 'notify', + 'data': data, + } + ) + return ret + + return wrapped + + return wrapper diff --git a/core/server.py b/core/server.py old mode 100644 new mode 100755 index d08b595..a09e315 --- a/core/server.py +++ b/core/server.py @@ -12,6 +12,7 @@ django.setup() from helper import init_loop from mail.protocol import LMTPHandler from mail.socket import UnixSocketLMTPController +from notifications.dispatch import NotificationDispatcher class UvicornServer(uvicorn.Server): @@ -54,6 +55,11 @@ async def lmtp(loop): log.info("LMTP done") +async def notifications(loop): + dispatcher = NotificationDispatcher() + await dispatcher.run_forever() + + def main(): import sdnotify import setproctitle @@ -67,6 +73,7 @@ def main(): loop.create_task(web(loop)) # loop.create_task(tcp(loop)) loop.create_task(lmtp(loop)) + loop.create_task(notifications(loop)) n = sdnotify.SystemdNotifier() n.notify("READY=1") log.info("Server ready") diff --git a/core/tickets/api_v2.py b/core/tickets/api_v2.py index 596bd9b..e93b179 100644 --- a/core/tickets/api_v2.py +++ b/core/tickets/api_v2.py @@ -23,6 +23,11 @@ class IssueViewSet(viewsets.ModelViewSet): queryset = IssueThread.objects.all() +class CommentViewSet(viewsets.ModelViewSet): + serializer_class = CommentSerializer + queryset = Comment.objects.all() + + class ShippingVoucherViewSet(viewsets.ModelViewSet): serializer_class = ShippingVoucherSerializer queryset = ShippingVoucher.objects.all() @@ -119,6 +124,7 @@ def add_comment(request, pk): router = routers.SimpleRouter() router.register(r'tickets', IssueViewSet, basename='issues') +#router.register(r'comments', CommentViewSet, basename='comments') router.register(r'shipping_vouchers', ShippingVoucherViewSet, basename='shipping_vouchers') urlpatterns = ([ diff --git a/core/tickets/models.py b/core/tickets/models.py index db427fe..8a559ee 100644 --- a/core/tickets/models.py +++ b/core/tickets/models.py @@ -1,5 +1,5 @@ -from django.db import models from django.utils import timezone +from django.db import models from django_softdelete.models import SoftDeleteModel from authentication.models import ExtendedUser diff --git a/core/tickets/serializers.py b/core/tickets/serializers.py index a980b97..3d850c4 100644 --- a/core/tickets/serializers.py +++ b/core/tickets/serializers.py @@ -52,8 +52,8 @@ class IssueSerializer(serializers.ModelSerializer): ret = super().to_internal_value(data) if 'state' in data: ret['state'] = data['state'] -# if 'assigned_to' in data: -# ret['assigned_to'] = data['assigned_to'] + # if 'assigned_to' in data: + # ret['assigned_to'] = data['assigned_to'] return ret def validate(self, attrs): diff --git a/core/tickets/tests/v2/test_tickets.py b/core/tickets/tests/v2/test_tickets.py index 8223506..0fea3dc 100644 --- a/core/tickets/tests/v2/test_tickets.py +++ b/core/tickets/tests/v2/test_tickets.py @@ -247,6 +247,16 @@ class IssueApiTest(TestCase): self.assertEqual(timeline[1]['subject'], 'test issue') self.assertEqual(timeline[1]['body'], 'test') + #def test_post_comment(self): + # issue = IssueThread.objects.create( + # name="test issue", + # ) + # response = self.client.post('/api/2/comments/', {'comment': 'test', 'issue_thread': issue.id}) + # self.assertEqual(response.status_code, 201) + # self.assertEqual(response.json()['comment'], 'test') + # self.assertEqual(response.json()['issue_thread'], issue.id) + # self.assertEqual(response.json()['timestamp'], response.json()['timestamp']) + def test_post_comment_altenative(self): issue = IssueThread.objects.create( name="test issue", diff --git a/deploy/ansible/playbooks/templates/django.env.j2 b/deploy/ansible/playbooks/templates/django.env.j2 index 72a0c30..a8e0d83 100644 --- a/deploy/ansible/playbooks/templates/django.env.j2 +++ b/deploy/ansible/playbooks/templates/django.env.j2 @@ -9,3 +9,5 @@ LEGACY_API_USER={{ legacy_api_user }} LEGACY_API_PASSWORD={{ legacy_api_password }} MEDIA_ROOT=/var/www/c3lf-sys3/userfiles STATIC_ROOT=/var/www/c3lf-sys3/staticfiles +TELEGRAM_GROUP_CHAT_ID={{ telegram_group_chat_id }} +TELEGRAM_BOT_TOKEN={{ telegram_bot_token }} \ No newline at end of file diff --git a/web/package.json b/web/package.json index 87f6d71..09596d6 100644 --- a/web/package.json +++ b/web/package.json @@ -8,6 +8,7 @@ "lint": "vue-cli-service lint" }, "dependencies": { + "@chenfengyuan/vue-qrcode": "^2.0.0", "@fortawesome/fontawesome-svg-core": "^6.5.1", "@fortawesome/free-solid-svg-icons": "^6.5.1", "@fortawesome/vue-fontawesome": "^3.0.6", diff --git a/web/src/components/CollapsableCards.vue b/web/src/components/CollapsableCards.vue index d1edab7..554a960 100644 --- a/web/src/components/CollapsableCards.vue +++ b/web/src/components/CollapsableCards.vue @@ -1,6 +1,31 @@ - + Dashboard +
  • + Settings +
  • Events
    • +
  • + Notifications +
  • Shipping
    • diff --git a/web/src/views/admin/Debug.vue b/web/src/views/admin/Debug.vue new file mode 100644 index 0000000..0c83e76 --- /dev/null +++ b/web/src/views/admin/Debug.vue @@ -0,0 +1,87 @@ + + + + + \ No newline at end of file diff --git a/web/src/views/admin/Notifications.vue b/web/src/views/admin/Notifications.vue new file mode 100644 index 0000000..cc2b615 --- /dev/null +++ b/web/src/views/admin/Notifications.vue @@ -0,0 +1,36 @@ + + + + + \ No newline at end of file diff --git a/web/src/views/admin/Settings.vue b/web/src/views/admin/Settings.vue new file mode 100644 index 0000000..2f15a83 --- /dev/null +++ b/web/src/views/admin/Settings.vue @@ -0,0 +1,109 @@ + + + + + \ No newline at end of file From fe0dcbc134b28aa3622b2566d45411bb95b9a211 Mon Sep 17 00:00:00 2001 From: jedi Date: Wed, 26 Jun 2024 21:22:34 +0200 Subject: [PATCH 02/36] stash --- web/src/components/Timeline.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/src/components/Timeline.vue b/web/src/components/Timeline.vue index 88bfa94..f3ac1d8 100644 --- a/web/src/components/Timeline.vue +++ b/web/src/components/Timeline.vue @@ -73,7 +73,7 @@ import TimelineMail from "@/components/TimelineMail.vue"; import TimelineComment from "@/components/TimelineComment.vue"; import TimelineStateChange from "@/components/TimelineStateChange.vue"; -import {mapActions, mapGetters} from "vuex"; +import {mapGetters} from "vuex"; import TimelineAssignment from "@/components/TimelineAssignment.vue"; import TimelineRelatedItem from "@/components/TimelineRelatedItem.vue"; import TimelineShippingVoucher from "@/components/TimelineShippingVoucher.vue"; From 04aa44a2a0d973d14756cacf22775aa7bdbfe0a3 Mon Sep 17 00:00:00 2001 From: jedi Date: Fri, 28 Jun 2024 00:49:09 +0200 Subject: [PATCH 03/36] stash --- core/notifications/api_v2.py | 15 ++++++++++++-- web/src/store.js | 10 ++++++++- web/src/views/admin/Notifications.vue | 30 +++++++++------------------ 3 files changed, 32 insertions(+), 23 deletions(-) diff --git a/core/notifications/api_v2.py b/core/notifications/api_v2.py index f50a453..e459d01 100644 --- a/core/notifications/api_v2.py +++ b/core/notifications/api_v2.py @@ -5,7 +5,7 @@ from rest_framework.decorators import api_view, permission_classes from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response -from notifications.models import MessageTemplate +from notifications.models import MessageTemplate, UserNotificationChannel from rest_framework import serializers from notifications.templates import TEMPLATE_VARS @@ -17,11 +17,22 @@ class MessageTemplateSerializer(serializers.ModelSerializer): fields = '__all__' +class UserNotificationChannelSerializer(serializers.ModelSerializer): + class Meta: + model = UserNotificationChannel + fields = '__all__' + + class MessageTemplateViewSet(viewsets.ModelViewSet): serializer_class = MessageTemplateSerializer queryset = MessageTemplate.objects.all() +class UserNotificationChannelViewSet(viewsets.ModelViewSet): + serializer_class = UserNotificationChannelSerializer + queryset = UserNotificationChannel.objects.all() + + @api_view(['GET']) @permission_classes([IsAuthenticated]) @permission_required('tickets.add_issuethread_manual', raise_exception=True) # TDOO: change this permission @@ -31,7 +42,7 @@ def get_template_vars(self): router = routers.SimpleRouter() router.register(r'message_templates', MessageTemplateViewSet) - +router.register(r'user_notification_channels', UserNotificationChannelViewSet) urlpatterns = ([ re_path('message_template_variables', get_template_vars), ] + router.urls) diff --git a/web/src/store.js b/web/src/store.js index 6f650d5..b5fba1c 100644 --- a/web/src/store.js +++ b/web/src/store.js @@ -22,6 +22,7 @@ const store = createStore({ messageTemplates: [], messageTemplateVariables: [], shippingVouchers: [], + userNotificationChannels: [], lastEvent: '37C3', lastUsed: {}, @@ -532,7 +533,14 @@ const store = createStore({ state.fetchedData.tickets = 0; await Promise.all([dispatch('loadTickets'), dispatch('fetchShippingVouchers')]); } - } + }, + async fetchUserNotificationChannels({commit, state}) { + if (!state.user.token) return; + const {data, success} = await http.get('/2/user_notification_channels/', state.user.token); + if (data && success) { + state.userNotificationChannels = data; + } + }, }, plugins: [ persistentStatePlugin({ // TODO change remember to some kind of enable field diff --git a/web/src/views/admin/Notifications.vue b/web/src/views/admin/Notifications.vue index cc2b615..5a451fc 100644 --- a/web/src/views/admin/Notifications.vue +++ b/web/src/views/admin/Notifications.vue @@ -1,22 +1,9 @@ From de408202570408c862cb75c140d6a395b066c5f1 Mon Sep 17 00:00:00 2001 From: jedi Date: Sat, 29 Jun 2024 16:48:08 +0200 Subject: [PATCH 04/36] stash --- core/authentication/api_v2.py | 41 +++++---------------------- core/authentication/serializers.py | 32 +++++++++++++++++++++ core/notifications/api_v2.py | 3 ++ web/src/views/admin/Notifications.vue | 2 +- 4 files changed, 43 insertions(+), 35 deletions(-) create mode 100644 core/authentication/serializers.py diff --git a/core/authentication/api_v2.py b/core/authentication/api_v2.py index 514a697..2547b6d 100644 --- a/core/authentication/api_v2.py +++ b/core/authentication/api_v2.py @@ -12,25 +12,7 @@ from knox.models import AuthToken from knox.views import LoginView as KnoxLoginView from authentication.models import ExtendedUser - - -class UserSerializer(serializers.ModelSerializer): - permissions = serializers.SerializerMethodField() - groups = serializers.SlugRelatedField(many=True, read_only=True, slug_field='name') - - class Meta: - model = ExtendedUser - fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') - read_only_fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') - - def get_permissions(self, obj): - return list(set(obj.get_permissions())) - - -@receiver(post_save, sender=ExtendedUser) -def create_auth_token(sender, instance=None, created=False, **kwargs): - if created: - AuthToken.objects.create(user=instance) +from authentication.serializers import UserSerializer, GroupSerializer class UserViewSet(viewsets.ModelViewSet): @@ -38,26 +20,17 @@ class UserViewSet(viewsets.ModelViewSet): serializer_class = UserSerializer -class GroupSerializer(serializers.ModelSerializer): - permissions = serializers.SerializerMethodField() - members = serializers.SerializerMethodField() - - class Meta: - model = Group - fields = ('id', 'name', 'permissions', 'members') - - def get_permissions(self, obj): - return ["*:" + p.codename for p in obj.permissions.all()] - - def get_members(self, obj): - return [u.username for u in obj.user_set.all()] - - class GroupViewSet(viewsets.ModelViewSet): queryset = Group.objects.all() serializer_class = GroupSerializer +@receiver(post_save, sender=ExtendedUser) +def create_auth_token(sender, instance=None, created=False, **kwargs): + if created: + AuthToken.objects.create(user=instance) + + @api_view(['GET']) @permission_classes([IsAuthenticated]) def selfUser(request): diff --git a/core/authentication/serializers.py b/core/authentication/serializers.py new file mode 100644 index 0000000..0581865 --- /dev/null +++ b/core/authentication/serializers.py @@ -0,0 +1,32 @@ +from rest_framework import serializers +from django.contrib.auth.models import Group + +from authentication.models import ExtendedUser + + +class UserSerializer(serializers.ModelSerializer): + permissions = serializers.SerializerMethodField() + groups = serializers.SlugRelatedField(many=True, read_only=True, slug_field='name') + + class Meta: + model = ExtendedUser + fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') + read_only_fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') + + def get_permissions(self, obj): + return list(set(obj.get_permissions())) + + +class GroupSerializer(serializers.ModelSerializer): + permissions = serializers.SerializerMethodField() + members = serializers.SerializerMethodField() + + class Meta: + model = Group + fields = ('id', 'name', 'permissions', 'members') + + def get_permissions(self, obj): + return ["*:" + p.codename for p in obj.permissions.all()] + + def get_members(self, obj): + return [u.username for u in obj.user_set.all()] diff --git a/core/notifications/api_v2.py b/core/notifications/api_v2.py index e459d01..a9492f5 100644 --- a/core/notifications/api_v2.py +++ b/core/notifications/api_v2.py @@ -9,6 +9,7 @@ from notifications.models import MessageTemplate, UserNotificationChannel from rest_framework import serializers from notifications.templates import TEMPLATE_VARS +from authentication.serializers import UserSerializer class MessageTemplateSerializer(serializers.ModelSerializer): @@ -18,6 +19,8 @@ class MessageTemplateSerializer(serializers.ModelSerializer): class UserNotificationChannelSerializer(serializers.ModelSerializer): + user = UserSerializer() + class Meta: model = UserNotificationChannel fields = '__all__' diff --git a/web/src/views/admin/Notifications.vue b/web/src/views/admin/Notifications.vue index 5a451fc..312a902 100644 --- a/web/src/views/admin/Notifications.vue +++ b/web/src/views/admin/Notifications.vue @@ -1,7 +1,7 @@ From 88bcf3b39b450e805f38dfa425f648dce86c175a Mon Sep 17 00:00:00 2001 From: jedi Date: Sat, 13 Jul 2024 17:28:38 +0200 Subject: [PATCH 05/36] stash --- web/src/components/Timeline.vue | 2 +- web/src/store.js | 8 +++++- web/src/views/Tickets.vue | 2 +- web/src/views/admin/Notifications.vue | 37 +++++++++++++++++++++++---- 4 files changed, 41 insertions(+), 8 deletions(-) diff --git a/web/src/components/Timeline.vue b/web/src/components/Timeline.vue index f3ac1d8..88bfa94 100644 --- a/web/src/components/Timeline.vue +++ b/web/src/components/Timeline.vue @@ -73,7 +73,7 @@ import TimelineMail from "@/components/TimelineMail.vue"; import TimelineComment from "@/components/TimelineComment.vue"; import TimelineStateChange from "@/components/TimelineStateChange.vue"; -import {mapGetters} from "vuex"; +import {mapActions, mapGetters} from "vuex"; import TimelineAssignment from "@/components/TimelineAssignment.vue"; import TimelineRelatedItem from "@/components/TimelineRelatedItem.vue"; import TimelineShippingVoucher from "@/components/TimelineShippingVoucher.vue"; diff --git a/web/src/store.js b/web/src/store.js index b5fba1c..0724070 100644 --- a/web/src/store.js +++ b/web/src/store.js @@ -47,6 +47,7 @@ const store = createStore({ states: 0, messageTemplates: 0, shippingVouchers: 0, + userNotificationChannels: 0, }, persistent_loaded: false, shared_loaded: false, @@ -241,6 +242,10 @@ const store = createStore({ state.shippingVouchers = codes; state.fetchedData = {...state.fetchedData, shippingVouchers: Date.now()}; }, + setUserNotificationChannels(state, channels) { + state.userNotificationChannels = channels; + state.fetchedData = {...state.fetchedData, userNotificationChannels: Date.now()}; + }, }, actions: { async login({commit}, {username, password, remember}) { @@ -536,9 +541,10 @@ const store = createStore({ }, async fetchUserNotificationChannels({commit, state}) { if (!state.user.token) return; + if (state.fetchedData.userNotificationChannels > Date.now() - 1000 * 60 * 60 * 24) return; const {data, success} = await http.get('/2/user_notification_channels/', state.user.token); if (data && success) { - state.userNotificationChannels = data; + commit('setUserNotificationChannels', data); } }, }, diff --git a/web/src/views/Tickets.vue b/web/src/views/Tickets.vue index 55574c8..f1497bb 100644 --- a/web/src/views/Tickets.vue +++ b/web/src/views/Tickets.vue @@ -3,7 +3,7 @@
    - -
      -
    • - {{ channel.id }} - {{ channel.channel_type }} - {{ channel.channel_target }} - {{ channel.event_filter }} - {{ channel.active }} - {{ channel.created }} - {{ channel.user }} -
      • -
    +
    + + +
    +
    +
    +
    + + + + +
    + +
    +
    +
    +
    +
    + + \ No newline at end of file diff --git a/web/src/store.js b/web/src/store.js index 0724070..b29ffba 100644 --- a/web/src/store.js +++ b/web/src/store.js @@ -340,6 +340,13 @@ const store = createStore({ commit('replaceEvents', [...state.events.filter(e => e.eid !== event_id)]) } }, + async updateEvent({commit, dispatch, state}, {id, partial_event}){ + console.log(id, partial_event); + const {data, success} = await http.patch(`/2/events/${id}/`, partial_event, state.user.token); + if (success) { + commit('replaceEvents', [...state.events.filter(e => e.eid !== id), data]) + } + }, async fetchTicketStates({commit, state}) { if (!state.user.token) return; if (state.fetchedData.states > Date.now() - 1000 * 60 * 60 * 24) return; diff --git a/web/src/views/admin/Events.vue b/web/src/views/admin/Events.vue index 1aab608..e2ff952 100644 --- a/web/src/views/admin/Events.vue +++ b/web/src/views/admin/Events.vue @@ -1,50 +1,102 @@ \ No newline at end of file From 4d43eb5691f46cb0352b9bf8f6494fcc5d786134 Mon Sep 17 00:00:00 2001 From: jedi Date: Wed, 6 Nov 2024 07:25:10 +0100 Subject: [PATCH 14/36] stash --- core/inventory/serializers.py | 34 ++++++++++++++++--- core/inventory/tests/v2/test_events.py | 13 ++++++- .../0006_alter_eventaddress_address.py | 18 ++++++++++ core/mail/models.py | 2 +- 4 files changed, 60 insertions(+), 7 deletions(-) create mode 100644 core/mail/migrations/0006_alter_eventaddress_address.py diff --git a/core/inventory/serializers.py b/core/inventory/serializers.py index 4aef119..fc5d929 100644 --- a/core/inventory/serializers.py +++ b/core/inventory/serializers.py @@ -1,25 +1,49 @@ from django.utils import timezone from rest_framework import serializers +from rest_framework.relations import SlugRelatedField from files.models import File from inventory.models import Event, Container, Item from mail.models import EventAddress -class EventAdressSerializer(serializers.ModelSerializer): - class Meta: - model = EventAddress - fields = ['address'] +#class EventAdressSerializer(serializers.ModelSerializer): +# class Meta: +# model = EventAddress +# fields = ['address'] + +# def to_internal_value(self, data): +# if not isinstance(data, str): +# raise serializers.ValidationError('This field must be a string.') +# +# def create(self, validated_data): +# return EventAddress.objects.create(**validated_data) +# +# def validate(self, data): +# return isinstance(data, str) + class EventSerializer(serializers.ModelSerializer): - addresses = EventAdressSerializer(many=True, required=False) + #addresses = EventAdressSerializer(many=True, required=False) + addresses = SlugRelatedField(many=True, slug_field='address', queryset=EventAddress.objects.all()) class Meta: model = Event fields = ['eid', 'slug', 'name', 'start', 'end', 'pre_start', 'post_end', 'addresses'] read_only_fields = ['eid'] +# def update(self, instance, validated_data): +# addresses = validated_data.pop('addresses', None) +# instance.save(validated_data) +# if addresses: +# for address in addresses: +# nested_instance, created = EventAddress.objects.get_or_create(address=address) +# instance.addresses.add(nested_instance) +# +# return instance + + class ContainerSerializer(serializers.ModelSerializer): itemCount = serializers.SerializerMethodField() diff --git a/core/inventory/tests/v2/test_events.py b/core/inventory/tests/v2/test_events.py index affbd0e..6bbc701 100644 --- a/core/inventory/tests/v2/test_events.py +++ b/core/inventory/tests/v2/test_events.py @@ -47,6 +47,18 @@ class EventTestCase(TestCase): self.assertEqual(Event.objects.all()[0].slug, 'EVENT2') self.assertEqual(Event.objects.all()[0].name, 'Event 2 new') + def test_update_event(self): + from rest_framework.test import APIClient + event = Event.objects.create(slug='EVENT1', name='Event 1') + response = APIClient().patch(f'/api/2/events/{event.eid}/', {'addresses': ['foo@bar.baz', 'foo1@bar.baz']}) + self.assertEqual(response.status_code, 200) + self.assertEqual(response.json()['slug'], 'EVENT1') + self.assertEqual(response.json()['name'], 'Event 1') + self.assertEqual(len(Event.objects.all()), 1) + self.assertEqual(Event.objects.all()[0].slug, 'EVENT1') + self.assertEqual(Event.objects.all()[0].name, 'Event 1') + self.assertEqual(1, len(response.json()[0]['addresses'])) + def test_remove_event(self): event = Event.objects.create(slug='EVENT1', name='Event 1') Event.objects.create(slug='EVENT2', name='Event 2') @@ -65,4 +77,3 @@ class EventTestCase(TestCase): self.assertEqual('TEST1', response.json()[0]['slug']) self.assertEqual('Event', response.json()[0]['name']) self.assertEqual(1, len(response.json()[0]['addresses'])) - diff --git a/core/mail/migrations/0006_alter_eventaddress_address.py b/core/mail/migrations/0006_alter_eventaddress_address.py new file mode 100644 index 0000000..5a03261 --- /dev/null +++ b/core/mail/migrations/0006_alter_eventaddress_address.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2.7 on 2024-11-06 06:13 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('mail', '0005_alter_eventaddress_event'), + ] + + operations = [ + migrations.AlterField( + model_name='eventaddress', + name='address', + field=models.CharField(max_length=255, unique=True), + ), + ] diff --git a/core/mail/models.py b/core/mail/models.py index 2062eed..c5d3b38 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -33,7 +33,7 @@ class Email(SoftDeleteModel): class EventAddress(models.Model): id = models.AutoField(primary_key=True) event = models.ForeignKey(Event, models.SET_NULL, null=True, related_name='addresses') - address = models.CharField(max_length=255) + address = models.CharField(max_length=255, unique=True) class EmailAttachment(AbstractFile): From 269f02c2cecfd97b4f0620bc95b1ce17abfdb820 Mon Sep 17 00:00:00 2001 From: lagertonne Date: Wed, 6 Nov 2024 22:21:32 +0100 Subject: [PATCH 15/36] Add django standard metrics --- core/core/settings.py | 5 +++++ core/core/urls.py | 1 + core/requirements.prod.txt | 2 ++ 3 files changed, 8 insertions(+) diff --git a/core/core/settings.py b/core/core/settings.py index db23180..124fcad 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -50,6 +50,7 @@ INSTALLED_APPS = [ 'django.contrib.messages', 'django.contrib.staticfiles', 'django_extensions', + 'django_prometheus', 'rest_framework', 'knox', 'drf_yasg', @@ -85,6 +86,7 @@ SWAGGER_SETTINGS = { } MIDDLEWARE = [ + 'django_prometheus.middleware.PrometheusBeforeMiddleware', 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', @@ -92,6 +94,7 @@ MIDDLEWARE = [ 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'django_prometheus.middleware.PrometheusAfterMiddleware', ] ROOT_URLCONF = 'core.urls' @@ -210,4 +213,6 @@ CHANNEL_LAYERS = { } +PROMETHEUS_METRIC_NAMESPACE = 'c3lf' + TEST_RUNNER = 'core.test_runner.FastTestRunner' diff --git a/core/core/urls.py b/core/core/urls.py index b0161bb..df6e0d0 100644 --- a/core/core/urls.py +++ b/core/core/urls.py @@ -32,4 +32,5 @@ urlpatterns = [ path('api/2/', include('notify_sessions.api_v2')), path('api/2/', include('authentication.api_v2')), path('api/', get_info), + path('', include('django_prometheus.urls')), ] diff --git a/core/requirements.prod.txt b/core/requirements.prod.txt index 14bdc0f..ee69fe7 100644 --- a/core/requirements.prod.txt +++ b/core/requirements.prod.txt @@ -41,3 +41,5 @@ urllib3==2.1.0 uvicorn==0.24.0.post1 watchfiles==0.21.0 websockets==12.0 +django-prometheus==2.3.1 +prometheus_client==0.21.0 From f9fa7e0390e588ccf637ee78eeaf924169aafa9a Mon Sep 17 00:00:00 2001 From: jedi Date: Fri, 8 Nov 2024 20:04:43 +0100 Subject: [PATCH 16/36] add docker env for integration testing --- core/core/settings.py | 2 +- .../ansible/playbooks/templates/django.env.j2 | 1 + deploy/testing/Dockerfile.backend | 11 ++++ deploy/testing/Dockerfile.frontend | 6 ++ deploy/testing/docker-compose.yml | 55 +++++++++++++++++++ deploy/testing/vue.config.js | 27 +++++++++ 6 files changed, 101 insertions(+), 1 deletion(-) create mode 100644 deploy/testing/Dockerfile.backend create mode 100644 deploy/testing/Dockerfile.frontend create mode 100644 deploy/testing/docker-compose.yml create mode 100644 deploy/testing/vue.config.js diff --git a/core/core/settings.py b/core/core/settings.py index 6186032..c568fcc 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -212,7 +212,7 @@ CHANNEL_LAYERS = { 'default': { 'BACKEND': 'channels_redis.core.RedisChannelLayer', 'CONFIG': { - 'hosts': [('localhost', 6379)], + 'hosts': [(os.getenv('REDIS_HOST', 'localhost'), 6379)], }, } diff --git a/deploy/ansible/playbooks/templates/django.env.j2 b/deploy/ansible/playbooks/templates/django.env.j2 index a8e0d83..4526d10 100644 --- a/deploy/ansible/playbooks/templates/django.env.j2 +++ b/deploy/ansible/playbooks/templates/django.env.j2 @@ -1,3 +1,4 @@ +REDIS_HOST=localhost DB_HOST=localhost DB_PORT=3306 DB_NAME=c3lf_sys3 diff --git a/deploy/testing/Dockerfile.backend b/deploy/testing/Dockerfile.backend new file mode 100644 index 0000000..c968994 --- /dev/null +++ b/deploy/testing/Dockerfile.backend @@ -0,0 +1,11 @@ +FROM python:3.11-bookworm +LABEL authors="lagertonne" + +ENV PYTHONUNBUFFERED 1 +RUN mkdir /code +WORKDIR /code +COPY requirements.prod.txt /code/ +RUN apt update && apt install -y mariadb-client +RUN pip install -r requirements.prod.txt +RUN pip install mysqlclient +COPY .. /code/ \ No newline at end of file diff --git a/deploy/testing/Dockerfile.frontend b/deploy/testing/Dockerfile.frontend new file mode 100644 index 0000000..0a41d1a --- /dev/null +++ b/deploy/testing/Dockerfile.frontend @@ -0,0 +1,6 @@ +FROM docker.io/node:22 + +RUN mkdir /web +WORKDIR /web +COPY package.json /web/ +RUN npm install diff --git a/deploy/testing/docker-compose.yml b/deploy/testing/docker-compose.yml new file mode 100644 index 0000000..e93e901 --- /dev/null +++ b/deploy/testing/docker-compose.yml @@ -0,0 +1,55 @@ +services: + redis: + image: redis + ports: + - "6379:6379" + + db: + image: mariadb + environment: + MARIADB_RANDOM_ROOT_PASSWORD: true + MARIADB_DATABASE: system3 + MARIADB_USER: system3 + MARIADB_PASSWORD: system3 + volumes: + - mariadb_data:/var/lib/mysql + ports: + - "3306:3306" + + core: + build: + context: ../../core + dockerfile: ../deploy/testing/Dockerfile.backend + command: bash -c 'python manage.py migrate && python /code/server.py' + environment: + - HTTP_HOST=core + - REDIS_HOST=redis + - DB_HOST=db + - DB_PORT=3306 + - DB_NAME=system3 + - DB_USER=system3 + - DB_PASSWORD=system3 + volumes: + - ../../core:/code + ports: + - "8000:8000" + depends_on: + - db + - redis + + frontend: + build: + context: ../../web + dockerfile: ../deploy/testing/Dockerfile.frontend + command: npm run serve + volumes: + - ../../web:/web:ro + - /web/node_modules + - ./vue.config.js:/web/vue.config.js + ports: + - "8080:8080" + depends_on: + - core + +volumes: + mariadb_data: \ No newline at end of file diff --git a/deploy/testing/vue.config.js b/deploy/testing/vue.config.js new file mode 100644 index 0000000..f8f3c26 --- /dev/null +++ b/deploy/testing/vue.config.js @@ -0,0 +1,27 @@ +// vue.config.js + +module.exports = { + devServer: { + headers: { + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Headers": "*", + "Access-Control-Allow-Methods": "*" + }, + proxy: { + '^/media/2': { + target: 'http://core:8000/', + }, + '^/api/2': { + target: 'http://core:8000/', + }, + '^/api/1': { + target: 'http://core:8000/', + }, + '^/ws/2': { + target: 'http://core:8000/', + ws: true, + logLevel: 'debug', + }, + } + } +} \ No newline at end of file From 0c4995db2b1847e5cfe56fbcf00acf76fe4e028f Mon Sep 17 00:00:00 2001 From: jedi Date: Fri, 8 Nov 2024 20:04:43 +0100 Subject: [PATCH 17/36] add docker env for integration testing --- core/core/settings.py | 2 +- .../ansible/playbooks/templates/django.env.j2 | 1 + deploy/testing/Dockerfile.backend | 11 ++++ deploy/testing/Dockerfile.frontend | 6 ++ deploy/testing/docker-compose.yml | 55 +++++++++++++++++++ deploy/testing/vue.config.js | 27 +++++++++ 6 files changed, 101 insertions(+), 1 deletion(-) create mode 100644 deploy/testing/Dockerfile.backend create mode 100644 deploy/testing/Dockerfile.frontend create mode 100644 deploy/testing/docker-compose.yml create mode 100644 deploy/testing/vue.config.js diff --git a/core/core/settings.py b/core/core/settings.py index 124fcad..5b37ad8 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -207,7 +207,7 @@ CHANNEL_LAYERS = { 'default': { 'BACKEND': 'channels_redis.core.RedisChannelLayer', 'CONFIG': { - 'hosts': [('localhost', 6379)], + 'hosts': [(os.getenv('REDIS_HOST', 'localhost'), 6379)], }, } diff --git a/deploy/ansible/playbooks/templates/django.env.j2 b/deploy/ansible/playbooks/templates/django.env.j2 index 72a0c30..a1757db 100644 --- a/deploy/ansible/playbooks/templates/django.env.j2 +++ b/deploy/ansible/playbooks/templates/django.env.j2 @@ -1,3 +1,4 @@ +REDIS_HOST=localhost DB_HOST=localhost DB_PORT=3306 DB_NAME=c3lf_sys3 diff --git a/deploy/testing/Dockerfile.backend b/deploy/testing/Dockerfile.backend new file mode 100644 index 0000000..c968994 --- /dev/null +++ b/deploy/testing/Dockerfile.backend @@ -0,0 +1,11 @@ +FROM python:3.11-bookworm +LABEL authors="lagertonne" + +ENV PYTHONUNBUFFERED 1 +RUN mkdir /code +WORKDIR /code +COPY requirements.prod.txt /code/ +RUN apt update && apt install -y mariadb-client +RUN pip install -r requirements.prod.txt +RUN pip install mysqlclient +COPY .. /code/ \ No newline at end of file diff --git a/deploy/testing/Dockerfile.frontend b/deploy/testing/Dockerfile.frontend new file mode 100644 index 0000000..0a41d1a --- /dev/null +++ b/deploy/testing/Dockerfile.frontend @@ -0,0 +1,6 @@ +FROM docker.io/node:22 + +RUN mkdir /web +WORKDIR /web +COPY package.json /web/ +RUN npm install diff --git a/deploy/testing/docker-compose.yml b/deploy/testing/docker-compose.yml new file mode 100644 index 0000000..e93e901 --- /dev/null +++ b/deploy/testing/docker-compose.yml @@ -0,0 +1,55 @@ +services: + redis: + image: redis + ports: + - "6379:6379" + + db: + image: mariadb + environment: + MARIADB_RANDOM_ROOT_PASSWORD: true + MARIADB_DATABASE: system3 + MARIADB_USER: system3 + MARIADB_PASSWORD: system3 + volumes: + - mariadb_data:/var/lib/mysql + ports: + - "3306:3306" + + core: + build: + context: ../../core + dockerfile: ../deploy/testing/Dockerfile.backend + command: bash -c 'python manage.py migrate && python /code/server.py' + environment: + - HTTP_HOST=core + - REDIS_HOST=redis + - DB_HOST=db + - DB_PORT=3306 + - DB_NAME=system3 + - DB_USER=system3 + - DB_PASSWORD=system3 + volumes: + - ../../core:/code + ports: + - "8000:8000" + depends_on: + - db + - redis + + frontend: + build: + context: ../../web + dockerfile: ../deploy/testing/Dockerfile.frontend + command: npm run serve + volumes: + - ../../web:/web:ro + - /web/node_modules + - ./vue.config.js:/web/vue.config.js + ports: + - "8080:8080" + depends_on: + - core + +volumes: + mariadb_data: \ No newline at end of file diff --git a/deploy/testing/vue.config.js b/deploy/testing/vue.config.js new file mode 100644 index 0000000..f8f3c26 --- /dev/null +++ b/deploy/testing/vue.config.js @@ -0,0 +1,27 @@ +// vue.config.js + +module.exports = { + devServer: { + headers: { + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Headers": "*", + "Access-Control-Allow-Methods": "*" + }, + proxy: { + '^/media/2': { + target: 'http://core:8000/', + }, + '^/api/2': { + target: 'http://core:8000/', + }, + '^/api/1': { + target: 'http://core:8000/', + }, + '^/ws/2': { + target: 'http://core:8000/', + ws: true, + logLevel: 'debug', + }, + } + } +} \ No newline at end of file From ae4e52dfdb11e03f6844c3d4f33a3fc5572a654a Mon Sep 17 00:00:00 2001 From: jedi Date: Fri, 8 Nov 2024 22:23:52 +0100 Subject: [PATCH 18/36] save raw_mails as file --- core/mail/migrations/0007_email_raw_file.py | 36 +++++++++++++++++++++ core/mail/models.py | 2 +- core/mail/protocol.py | 2 +- 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 core/mail/migrations/0007_email_raw_file.py diff --git a/core/mail/migrations/0007_email_raw_file.py b/core/mail/migrations/0007_email_raw_file.py new file mode 100644 index 0000000..03d0db0 --- /dev/null +++ b/core/mail/migrations/0007_email_raw_file.py @@ -0,0 +1,36 @@ +# Generated by Django 4.2.7 on 2024-11-08 20:37 +from django.core.files.base import ContentFile +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('mail', '0006_alter_eventaddress_address'), + ] + + def move_raw_mails_to_file(apps, schema_editor): + Email = apps.get_model('mail', 'Email') + for email in Email.objects.all(): + raw_content = email.raw + email.raw_file = ContentFile(raw_content) + email.raw = None + email.save() + + operations = [ + migrations.AddField( + model_name='email', + name='raw_file', + field=models.FileField(null=True, upload_to='raw_mail/'), + ), + migrations.RunPython(move_raw_mails_to_file), + migrations.RemoveField( + model_name='email', + name='raw', + ), + migrations.AlterField( + model_name='email', + name='raw_file', + field=models.FileField(upload_to='raw_mail/'), + ), + ] diff --git a/core/mail/models.py b/core/mail/models.py index c5d3b38..2788e9d 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -19,7 +19,7 @@ class Email(SoftDeleteModel): recipient = models.CharField(max_length=255) reference = models.CharField(max_length=255, null=True, unique=True) in_reply_to = models.CharField(max_length=255, null=True) - raw = models.TextField() + raw_file = models.FileField(upload_to='raw_mail/') issue_thread = models.ForeignKey(IssueThread, models.SET_NULL, null=True, related_name='emails') event = models.ForeignKey(Event, models.SET_NULL, null=True) diff --git a/core/mail/protocol.py b/core/mail/protocol.py index 238a8af..fbfc0cd 100644 --- a/core/mail/protocol.py +++ b/core/mail/protocol.py @@ -233,7 +233,7 @@ def receive_email(envelope, log=None): email = Email.objects.create( sender=sender, recipient=recipient, body=body, subject=subject, reference=header_message_id, - in_reply_to=header_in_reply_to, raw=envelope.content, event=target_event, + in_reply_to=header_in_reply_to, raw_file=ContentFile(envelope.content), event=target_event, issue_thread=active_issue_thread) for attachment in attachments: email.attachments.add(attachment) From 4272aab6434b8bffd81d356bb387debcd33120f6 Mon Sep 17 00:00:00 2001 From: jedi Date: Fri, 8 Nov 2024 22:23:52 +0100 Subject: [PATCH 19/36] save raw_mails as file --- core/mail/migrations/0006_email_raw_file.py | 36 +++++++++++++++++++++ core/mail/models.py | 2 +- core/mail/protocol.py | 2 +- core/requirements.dev.txt | 2 ++ 4 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 core/mail/migrations/0006_email_raw_file.py diff --git a/core/mail/migrations/0006_email_raw_file.py b/core/mail/migrations/0006_email_raw_file.py new file mode 100644 index 0000000..1288bcf --- /dev/null +++ b/core/mail/migrations/0006_email_raw_file.py @@ -0,0 +1,36 @@ +# Generated by Django 4.2.7 on 2024-11-08 20:37 +from django.core.files.base import ContentFile +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('mail', '0005_alter_eventaddress_event'), + ] + + def move_raw_mails_to_file(apps, schema_editor): + Email = apps.get_model('mail', 'Email') + for email in Email.objects.all(): + raw_content = email.raw + email.raw_file = ContentFile(raw_content) + email.raw = None + email.save() + + operations = [ + migrations.AddField( + model_name='email', + name='raw_file', + field=models.FileField(null=True, upload_to='raw_mail/'), + ), + migrations.RunPython(move_raw_mails_to_file), + migrations.RemoveField( + model_name='email', + name='raw', + ), + migrations.AlterField( + model_name='email', + name='raw_file', + field=models.FileField(upload_to='raw_mail/'), + ), + ] diff --git a/core/mail/models.py b/core/mail/models.py index 378854b..65371fe 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -18,7 +18,7 @@ class Email(SoftDeleteModel): recipient = models.CharField(max_length=255) reference = models.CharField(max_length=255, null=True, unique=True) in_reply_to = models.CharField(max_length=255, null=True) - raw = models.TextField() + raw_file = models.FileField(upload_to='raw_mail/') issue_thread = models.ForeignKey(IssueThread, models.SET_NULL, null=True, related_name='emails') event = models.ForeignKey(Event, models.SET_NULL, null=True) diff --git a/core/mail/protocol.py b/core/mail/protocol.py index a87f1a6..926e8c2 100644 --- a/core/mail/protocol.py +++ b/core/mail/protocol.py @@ -206,7 +206,7 @@ def receive_email(envelope, log=None): email = Email.objects.create( sender=sender, recipient=recipient, body=body, subject=subject, reference=header_message_id, - in_reply_to=header_in_reply_to, raw=envelope.content, event=target_event, + in_reply_to=header_in_reply_to, raw_file=ContentFile(envelope.content), event=target_event, issue_thread=active_issue_thread) for attachment in attachments: email.attachments.add(attachment) diff --git a/core/requirements.dev.txt b/core/requirements.dev.txt index 146aa37..3807a6c 100644 --- a/core/requirements.dev.txt +++ b/core/requirements.dev.txt @@ -73,3 +73,5 @@ watchfiles==0.21.0 websockets==12.0 yarl==1.9.4 zope.interface==6.1 +django-prometheus==2.3.1 +prometheus_client==0.21.0 From a6a8b0defe4d435a855a3ea91bc6a646ed2c7f1f Mon Sep 17 00:00:00 2001 From: jedi Date: Sat, 9 Nov 2024 00:03:21 +0100 Subject: [PATCH 20/36] add functions to train mails as spam/ham --- core/core/settings.py | 9 +++++++-- core/mail/models.py | 14 +++++++++++++- deploy/ansible/inventory.yml.sample | 4 +++- deploy/ansible/playbooks/templates/django.env.j2 | 3 +++ 4 files changed, 26 insertions(+), 4 deletions(-) diff --git a/core/core/settings.py b/core/core/settings.py index 5b37ad8..2d4a818 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -15,6 +15,9 @@ import sys import dotenv from pathlib import Path +def truthy_str(s): + return s.lower() in ['true', '1', 't', 'y', 'yes', 'yeah', 'yup', 'certainly', 'sure', 'positive', 'uh-huh', '👍'] + # Build paths inside the project like this: BASE_DIR / 'subdir'. BASE_DIR = Path(__file__).resolve().parent.parent @@ -24,10 +27,10 @@ dotenv.load_dotenv(BASE_DIR / '.env') # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! -SECRET_KEY = 'django-insecure-tm*$w_14iqbiy-!7(8#ba7j+_@(7@rf2&a^!=shs&$03b%2*rv' +SECRET_KEY = os.getenv('DJANGO_SECRET_KEY', 'django-insecure-tm*$w_14iqbiy-!7(8#ba7j+_@(7@rf2&a^!=shs&$03b%2*rv') # SECURITY WARNING: don't run with debug turned on in production! -DEBUG = True +DEBUG = truthy_str(os.getenv('DEBUG_MODE_ACTIVE', 'False')) ALLOWED_HOSTS = [os.getenv('HTTP_HOST', 'localhost')] @@ -40,6 +43,8 @@ LEGACY_USER_PASSWORD = os.getenv('LEGACY_API_PASSWORD', 'legacy_password') SYSTEM3_VERSION = "0.0.0-dev.0" +ACTIVE_SPAM_TRAINING = truthy_str(os.getenv('ACTIVE_SPAM_TRAINING', 'False')) + # Application definition INSTALLED_APPS = [ diff --git a/core/mail/models.py b/core/mail/models.py index 65371fe..2215fbb 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -3,7 +3,7 @@ import random from django.db import models from django_softdelete.models import SoftDeleteModel -from core.settings import MAIL_DOMAIN +from core.settings import MAIL_DOMAIN, ACTIVE_SPAM_TRAINING from files.models import AbstractFile from inventory.models import Event from tickets.models import IssueThread @@ -28,6 +28,18 @@ class Email(SoftDeleteModel): self.reference = f'<{random.randint(0, 1000000000):09}@{MAIL_DOMAIN}>' self.save() + def train_spam(self): + if ACTIVE_SPAM_TRAINING: + import subprocess + path = self.raw_file.path + subprocess.run(["rspamc", "learn_spam", path]) + + def train_ham(self): + if ACTIVE_SPAM_TRAINING: + import subprocess + path = self.raw_file.path + subprocess.run(["rspamc", "learn_ham", path]) + class EventAddress(models.Model): id = models.AutoField(primary_key=True) diff --git a/deploy/ansible/inventory.yml.sample b/deploy/ansible/inventory.yml.sample index 6ba14ac..2a50efd 100644 --- a/deploy/ansible/inventory.yml.sample +++ b/deploy/ansible/inventory.yml.sample @@ -11,4 +11,6 @@ c3lf-nodes: mail_domain: main_email: legacy_api_user: - legacy_api_password: \ No newline at end of file + legacy_api_password: + debug_mode_active: false + django_secret_key: 'django-insecure-tm*$w_14iqbiy-!7(8#ba7j+_@(7@rf2&a^!=shs&$03b%2*rv' \ No newline at end of file diff --git a/deploy/ansible/playbooks/templates/django.env.j2 b/deploy/ansible/playbooks/templates/django.env.j2 index a1757db..c9b1c83 100644 --- a/deploy/ansible/playbooks/templates/django.env.j2 +++ b/deploy/ansible/playbooks/templates/django.env.j2 @@ -10,3 +10,6 @@ LEGACY_API_USER={{ legacy_api_user }} LEGACY_API_PASSWORD={{ legacy_api_password }} MEDIA_ROOT=/var/www/c3lf-sys3/userfiles STATIC_ROOT=/var/www/c3lf-sys3/staticfiles +ACTIVE_SPAM_TRAINING=True +DEBUG_MODE_ACTIVE={{ debug_mode_active }} +DJANGO_SECRET_KEY={{ django_secret_key }} From 5a6349c5d3d8bc9a47866901d9c0a0d5fce8910a Mon Sep 17 00:00:00 2001 From: jedi Date: Sat, 9 Nov 2024 01:00:53 +0100 Subject: [PATCH 21/36] train spam on state change to 'closed_spam' --- core/mail/migrations/0006_email_raw_file.py | 6 ++-- .../tickets/migrations/0011_train_old_spam.py | 31 +++++++++++++++++++ core/tickets/models.py | 2 ++ 3 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 core/tickets/migrations/0011_train_old_spam.py diff --git a/core/mail/migrations/0006_email_raw_file.py b/core/mail/migrations/0006_email_raw_file.py index 1288bcf..4086af8 100644 --- a/core/mail/migrations/0006_email_raw_file.py +++ b/core/mail/migrations/0006_email_raw_file.py @@ -4,7 +4,6 @@ from django.db import migrations, models class Migration(migrations.Migration): - dependencies = [ ('mail', '0005_alter_eventaddress_event'), ] @@ -13,8 +12,9 @@ class Migration(migrations.Migration): Email = apps.get_model('mail', 'Email') for email in Email.objects.all(): raw_content = email.raw - email.raw_file = ContentFile(raw_content) - email.raw = None + path = "mail_{}".format(email.id) + if len(raw_content): + email.raw_file.save(path, ContentFile(raw_content)) email.save() operations = [ diff --git a/core/tickets/migrations/0011_train_old_spam.py b/core/tickets/migrations/0011_train_old_spam.py new file mode 100644 index 0000000..206cbb4 --- /dev/null +++ b/core/tickets/migrations/0011_train_old_spam.py @@ -0,0 +1,31 @@ +# Generated by Django 4.2.7 on 2024-06-23 02:17 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + dependencies = [ + ('mail', '0006_email_raw_file'), + ('tickets', '0010_issuethread_event_itemrelation_and_more'), + ] + + def train_old_mails(apps, schema_editor): + from tickets.models import IssueThread + for t in IssueThread.objects.all(): + try: + state = t.state + i = 0 + for e in t.emails.all(): + if e.raw_file: + if state == 'closed_spam' and i == 0: + e.train_spam() + else: + e.train_ham() + i += 1 + except: + pass + + operations = [ + migrations.RunPython(train_old_mails), + ] diff --git a/core/tickets/models.py b/core/tickets/models.py index db427fe..aff5d6c 100644 --- a/core/tickets/models.py +++ b/core/tickets/models.py @@ -60,6 +60,8 @@ class IssueThread(SoftDeleteModel): if self.state == value: return self.state_changes.create(state=value) + if value == 'closed_spam' and self.emails.exists(): + self.emails.first().train_spam() @property def assigned_to(self): From 2552632a2bf426df8c23e07e577730c7e5b404be Mon Sep 17 00:00:00 2001 From: jedi Date: Wed, 26 Jun 2024 18:42:56 +0200 Subject: [PATCH 22/36] stash --- core/authentication/admin.py | 3 + core/core/settings.py | 9 +- core/core/urls.py | 1 + core/mail/models.py | 2 + core/mail/protocol.py | 46 +++++-- core/mail/tests/v2/test_user_notifications.py | 20 ++++ core/notifications/__init__.py | 0 core/notifications/admin.py | 15 +++ core/notifications/api_v2.py | 37 ++++++ core/notifications/defaults.py | 16 +++ core/notifications/dispatch.py | 85 +++++++++++++ core/notifications/migrations/0001_initial.py | 51 ++++++++ core/notifications/migrations/__init__.py | 0 core/notifications/models.py | 29 +++++ core/notifications/templates.py | 69 +++++++++++ core/notifications/tests/__init__.py | 0 core/notify_sessions/decorators.py | 21 ++++ core/server.py | 7 ++ core/tickets/api_v2.py | 6 + core/tickets/models.py | 2 +- core/tickets/serializers.py | 4 +- core/tickets/tests/v2/test_tickets.py | 10 ++ .../ansible/playbooks/templates/django.env.j2 | 2 + web/package.json | 1 + web/src/components/CollapsableCards.vue | 32 +++++ web/src/components/SlotTable.vue | 105 ++++++++++++++++ web/src/components/Toast.vue | 48 ++++++++ web/src/components/inputs/FormatedText.vue | 112 ++++++++++++++++++ web/src/main.js | 2 + web/src/router.js | 13 ++ web/src/store.js | 51 ++++++++ web/src/views/Tickets.vue | 8 +- web/src/views/admin/Admin.vue | 6 + web/src/views/admin/Debug.vue | 87 ++++++++++++++ web/src/views/admin/Notifications.vue | 36 ++++++ web/src/views/admin/Settings.vue | 109 +++++++++++++++++ 36 files changed, 1027 insertions(+), 18 deletions(-) create mode 100644 core/mail/tests/v2/test_user_notifications.py create mode 100644 core/notifications/__init__.py create mode 100644 core/notifications/admin.py create mode 100644 core/notifications/api_v2.py create mode 100644 core/notifications/defaults.py create mode 100644 core/notifications/dispatch.py create mode 100644 core/notifications/migrations/0001_initial.py create mode 100644 core/notifications/migrations/__init__.py create mode 100644 core/notifications/models.py create mode 100644 core/notifications/templates.py create mode 100644 core/notifications/tests/__init__.py create mode 100644 core/notify_sessions/decorators.py mode change 100644 => 100755 core/server.py create mode 100644 web/src/components/SlotTable.vue create mode 100644 web/src/components/Toast.vue create mode 100644 web/src/components/inputs/FormatedText.vue create mode 100644 web/src/views/admin/Debug.vue create mode 100644 web/src/views/admin/Notifications.vue create mode 100644 web/src/views/admin/Settings.vue diff --git a/core/authentication/admin.py b/core/authentication/admin.py index 0024cb0..dfb4d20 100644 --- a/core/authentication/admin.py +++ b/core/authentication/admin.py @@ -10,5 +10,8 @@ class ExtendedUserAdmin(UserAdmin): ordering = ('username',) filter_horizontal = ('groups', 'user_permissions', 'permissions') +# def permissions(self, obj): +# return ', '.join(obj.get_all_permissions()) + admin.site.register(ExtendedUser, ExtendedUserAdmin) diff --git a/core/core/settings.py b/core/core/settings.py index 2d4a818..7612fd4 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -32,7 +32,9 @@ SECRET_KEY = os.getenv('DJANGO_SECRET_KEY', 'django-insecure-tm*$w_14iqbiy-!7(8# # SECURITY WARNING: don't run with debug turned on in production! DEBUG = truthy_str(os.getenv('DEBUG_MODE_ACTIVE', 'False')) -ALLOWED_HOSTS = [os.getenv('HTTP_HOST', 'localhost')] +PRIMARY_HOST = os.getenv('HTTP_HOST', 'localhost') + +ALLOWED_HOSTS = [PRIMARY_HOST] MAIL_DOMAIN = os.getenv('MAIL_DOMAIN', 'localhost') @@ -45,6 +47,10 @@ SYSTEM3_VERSION = "0.0.0-dev.0" ACTIVE_SPAM_TRAINING = truthy_str(os.getenv('ACTIVE_SPAM_TRAINING', 'False')) +TELEGRAM_BOT_TOKEN = os.getenv('TELEGRAM_BOT_TOKEN', '1234567890:ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghi') + +TELEGRAM_GROUP_CHAT_ID = os.getenv('TELEGRAM_GROUP_CHAT_ID', '-1234567890') + # Application definition INSTALLED_APPS = [ @@ -61,6 +67,7 @@ INSTALLED_APPS = [ 'drf_yasg', 'channels', 'authentication', + 'notifications', 'files', 'tickets', 'inventory', diff --git a/core/core/urls.py b/core/core/urls.py index df6e0d0..228ef89 100644 --- a/core/core/urls.py +++ b/core/core/urls.py @@ -31,6 +31,7 @@ urlpatterns = [ path('api/2/', include('mail.api_v2')), path('api/2/', include('notify_sessions.api_v2')), path('api/2/', include('authentication.api_v2')), + path('api/2/', include('notifications.api_v2')), path('api/', get_info), path('', include('django_prometheus.urls')), ] diff --git a/core/mail/models.py b/core/mail/models.py index 2215fbb..8a0d153 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -4,6 +4,8 @@ from django.db import models from django_softdelete.models import SoftDeleteModel from core.settings import MAIL_DOMAIN, ACTIVE_SPAM_TRAINING +from authentication.models import ExtendedUser +from core.settings import MAIL_DOMAIN from files.models import AbstractFile from inventory.models import Event from tickets.models import IssueThread diff --git a/core/mail/protocol.py b/core/mail/protocol.py index 926e8c2..fbfc0cd 100644 --- a/core/mail/protocol.py +++ b/core/mail/protocol.py @@ -7,6 +7,7 @@ from channels.db import database_sync_to_async from django.core.files.base import ContentFile from mail.models import Email, EventAddress, EmailAttachment +from notifications.templates import render_auto_reply from notify_sessions.models import SystemEvent from tickets.models import IssueThread @@ -87,6 +88,22 @@ def make_reply(reply_email, references=None, event=None): return reply +def make_notification(message, to, title): # TODO where should replies to this go + from email.message import EmailMessage + from core.settings import MAIL_DOMAIN + notification = EmailMessage() + notification["From"] = "notifications@%s" % MAIL_DOMAIN + notification["To"] = to + notification["Subject"] = f"[C3LF Notification]%s" % title + # notification["Reply-To"] = f"{event}@{MAIL_DOMAIN}" + # notification["In-Reply-To"] = email.reference + # notification["Message-ID"] = email.id + "@" + MAIL_DOMAIN + + notification.set_content(message) + + return notification + + async def send_smtp(message): await aiosmtplib.send(message, hostname="127.0.0.1", port=25, use_tls=False, start_tls=False) @@ -185,6 +202,16 @@ def receive_email(envelope, log=None): header_in_reply_to = parsed.get('In-Reply-To') header_message_id = parsed.get('Message-ID') + # if header_from != envelope.mail_from: + # log.warning("Header from does not match envelope from") + # log.info(f"Header from: {header_from}, envelope from: {envelope.mail_from}") + # + # if header_to != envelope.rcpt_tos[0]: + # log.warning("Header to does not match envelope to") + # log.info(f"Header to: {header_to}, envelope to: {envelope.rcpt_tos[0]}") + + # handle undelivered mail header_from : 'Mail Delivery System ") == "": log.warning("Ignoring mailer daemon") raise SpecialMailException("Ignoring mailer daemon") @@ -218,16 +245,7 @@ def receive_email(envelope, log=None): references = collect_references(active_issue_thread) if not sender.startswith('noreply'): subject = f"Re: {subject} [#{active_issue_thread.short_uuid()}]" - body = '''Your request (#{}) has been received and will be reviewed by our lost&found angels. - -We are reviewing incoming requests during the event and teardown. Immediately after the event, expect a delay as the \ -workload is high. We will not forget about your request and get back in touch once we have updated information on your \ -request. Requests for devices, wallets, credit cards or similar items will be handled with priority. - -If you happen to find your lost item or just want to add additional information, please reply to this email. Please \ -do not create a new request. - -Your c3lf (Cloakroom + Lost&Found) Team'''.format(active_issue_thread.short_uuid()) + body = render_auto_reply(active_issue_thread) reply_email = Email.objects.create( sender=recipient, recipient=sender, body=body, subject=subject, in_reply_to=header_message_id, event=target_event, issue_thread=active_issue_thread) @@ -270,11 +288,19 @@ class LMTPHandler: 'general', {"type": "generic.event", "name": "send_message_to_frontend", "event_id": systemevent.id, "message": "email received"}) log.info(f"Sent message to frontend") + if new and reply: log.info('Sending message to %s' % reply['To']) await send_smtp(reply) log.info("Sent auto reply") + if thread: + await channel_layer.group_send( + 'general', {"type": "generic.event", "name": "user_notification", "event_id": systemevent.id, + "ticket_id": thread.id, "new": new}) + else: + print("No thread found") + return '250 Message accepted for delivery' except SpecialMailException as e: import uuid diff --git a/core/mail/tests/v2/test_user_notifications.py b/core/mail/tests/v2/test_user_notifications.py new file mode 100644 index 0000000..c4db23f --- /dev/null +++ b/core/mail/tests/v2/test_user_notifications.py @@ -0,0 +1,20 @@ +from django.contrib.auth.models import Permission +from django.test import TestCase + +from authentication.models import ExtendedUser +from notifications.models import UserNotificationChannel + + +class UserNotificationTestCase(TestCase): + + def setUp(self): + super().setUp() + self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') + self.user.user_permissions.add(*Permission.objects.all()) + self.user.save() + self.channel = UserNotificationChannel.objects.create(user=self.user, channel_type='telegram', + channel_target='123456789', + event_filter='*', active=True) + + async def test_telegram_notify(self): + pass diff --git a/core/notifications/__init__.py b/core/notifications/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/core/notifications/admin.py b/core/notifications/admin.py new file mode 100644 index 0000000..69620a9 --- /dev/null +++ b/core/notifications/admin.py @@ -0,0 +1,15 @@ +from django.contrib import admin + +from notifications.models import MessageTemplate, UserNotificationChannel + + +class MessageTemplateAdmin(admin.ModelAdmin): + pass + + +class UserNotificationChannelAdmin(admin.ModelAdmin): + pass + + +admin.site.register(MessageTemplate, MessageTemplateAdmin) +admin.site.register(UserNotificationChannel, UserNotificationChannelAdmin) diff --git a/core/notifications/api_v2.py b/core/notifications/api_v2.py new file mode 100644 index 0000000..f50a453 --- /dev/null +++ b/core/notifications/api_v2.py @@ -0,0 +1,37 @@ +from django.contrib.auth.decorators import permission_required +from rest_framework import routers, viewsets +from django.urls import re_path +from rest_framework.decorators import api_view, permission_classes +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response + +from notifications.models import MessageTemplate +from rest_framework import serializers + +from notifications.templates import TEMPLATE_VARS + + +class MessageTemplateSerializer(serializers.ModelSerializer): + class Meta: + model = MessageTemplate + fields = '__all__' + + +class MessageTemplateViewSet(viewsets.ModelViewSet): + serializer_class = MessageTemplateSerializer + queryset = MessageTemplate.objects.all() + + +@api_view(['GET']) +@permission_classes([IsAuthenticated]) +@permission_required('tickets.add_issuethread_manual', raise_exception=True) # TDOO: change this permission +def get_template_vars(self): + return Response(TEMPLATE_VARS, status=200) + + +router = routers.SimpleRouter() +router.register(r'message_templates', MessageTemplateViewSet) + +urlpatterns = ([ + re_path('message_template_variables', get_template_vars), + ] + router.urls) diff --git a/core/notifications/defaults.py b/core/notifications/defaults.py new file mode 100644 index 0000000..812d93e --- /dev/null +++ b/core/notifications/defaults.py @@ -0,0 +1,16 @@ +auto_reply_body = '''Your request (#{{ ticket_uuid }}) has been received and will be reviewed by our lost&found angels. + +We are reviewing incoming requests during the event and teardown. Immediately after the event, expect a delay as the \ +workload is high. We will not forget about your request and get back in touch once we have updated information on your \ +request. Requests for devices, wallets, credit cards or similar items will be handled with priority. + +If you happen to find your lost item or just want to add additional information, please reply to this email. Please \ +do not create a new request. + +Your c3lf (Cloakroom + Lost&Found) Team''' + +new_issue_notification = '''New issue "{{ ticket_name | limit_length }}" [{{ ticket_uuid }}] created +{{ ticket_url }}''' + +reply_issue_notification = '''Reply to issue "{{ ticket_name }}" [{{ ticket_uuid }}] (was {{ previous_state_pretty }}) +{{ ticket_url }}''' diff --git a/core/notifications/dispatch.py b/core/notifications/dispatch.py new file mode 100644 index 0000000..752c342 --- /dev/null +++ b/core/notifications/dispatch.py @@ -0,0 +1,85 @@ +import asyncio + +from aiohttp.client import ClientSession +from channels.layers import get_channel_layer +from channels.db import database_sync_to_async +from urllib.parse import quote as urlencode + +from core.settings import TELEGRAM_BOT_TOKEN, TELEGRAM_GROUP_CHAT_ID +from mail.protocol import send_smtp, make_notification +from notifications.models import UserNotificationChannel +from notifications.templates import render_notification_new_ticket_async, render_notification_reply_ticket_async +from tickets.models import IssueThread + + +async def http_get(url): + async with ClientSession() as session: + async with session.get(url) as response: + return await response.text() + + +async def telegram_notify(message, chat_id): + encoded_message = urlencode(message) + url = f"https://api.telegram.org/bot{TELEGRAM_BOT_TOKEN}/sendMessage?chat_id={chat_id}&text={encoded_message}" + return await http_get(url) + + +async def email_notify(message, title, email): + mail = make_notification(message, email, title) + await send_smtp(mail) + + +class NotificationDispatcher: + channel_layer = None + room_group_name = "general" + + def __init__(self): + self.channel_layer = get_channel_layer('default') + if not self.channel_layer: + raise Exception("Could not get channel layer") + + @database_sync_to_async + def get_notification_targets(self): + channels = UserNotificationChannel.objects.filter(active=True) + return list(channels) + + @database_sync_to_async + def get_ticket(self, ticket_id): + return IssueThread.objects.filter(id=ticket_id).select_related('event').first() + + async def run_forever(self): + # Infinite loop to continuously listen for messages + print("Listening for messages...") + channel_name = await self.channel_layer.new_channel() + await self.channel_layer.group_add(self.room_group_name, channel_name) + print("Channel name:", channel_name) + while True: + # Blocking receive to get the message from the channel layer + message = await self.channel_layer.receive(channel_name) + + if (message and 'type' in message and message['type'] == 'generic.event' and 'name' in message and + message['name'] == 'user_notification'): + if 'ticket_id' in message and 'event_id' in message and 'new' in message: + ticket = await self.get_ticket(message['ticket_id']) + await self.dispatch(ticket, message['event_id'], message['new']) + else: + print("Error: Invalid message format") + + async def dispatch(self, ticket, event_id, new): + message = await render_notification_new_ticket_async( + ticket) if new else await render_notification_reply_ticket_async(ticket) + title = f"[#{ticket.short_uuid()}] {ticket.name}" + print("Dispatching message:", message, "with event_id:", event_id) + targets = await self.get_notification_targets() + jobs = [] + jobs.append(telegram_notify(message, TELEGRAM_GROUP_CHAT_ID)) + for target in targets: + if target.channel_type == 'telegram': + print("Sending telegram notification to:", target.channel_target) + jobs.append(telegram_notify(message, target.channel_target)) + elif target.channel_type == 'email': + print("Sending email notification to:", target.channel_target) + jobs.append(email_notify(message, title, target.channel_target)) + else: + print("Unknown channel type:", target.channel_type) + await asyncio.gather(*jobs) diff --git a/core/notifications/migrations/0001_initial.py b/core/notifications/migrations/0001_initial.py new file mode 100644 index 0000000..4d276eb --- /dev/null +++ b/core/notifications/migrations/0001_initial.py @@ -0,0 +1,51 @@ +# Generated by Django 4.2.7 on 2024-05-03 21:02 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + +from notifications.defaults import auto_reply_body, new_issue_notification, reply_issue_notification +from notifications.models import MessageTemplate + + +class Migration(migrations.Migration): + initial = True + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + def create_required_templates(apps, schema_editor): + MessageTemplate.objects.create(name='auto_reply', message=auto_reply_body, marked_required=True) + MessageTemplate.objects.create(name='new_issue_notification', message=new_issue_notification, + marked_required=True) + MessageTemplate.objects.create(name='reply_issue_notification', message=reply_issue_notification, + marked_required=True) + + operations = [ + migrations.CreateModel( + name='MessageTemplate', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(max_length=255)), + ('message', models.TextField()), + ('created', models.DateTimeField(auto_now_add=True)), + ('marked_confidential', models.BooleanField(default=False)), + ('marked_required', models.BooleanField(default=False)), + ], + ), + migrations.CreateModel( + name='UserNotificationChannel', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('channel_type', + models.CharField(choices=[('telegram', 'telegram'), ('email', 'email')], max_length=255)), + ('channel_target', models.CharField(max_length=255)), + ('event_filter', models.CharField(max_length=255)), + ('active', models.BooleanField(default=True)), + ('created', models.DateTimeField(auto_now_add=True)), + ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)), + ], + ), + migrations.RunPython(create_required_templates), + ] diff --git a/core/notifications/migrations/__init__.py b/core/notifications/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/core/notifications/models.py b/core/notifications/models.py new file mode 100644 index 0000000..9cbfbe5 --- /dev/null +++ b/core/notifications/models.py @@ -0,0 +1,29 @@ +from django.db import models + +from authentication.models import ExtendedUser + + +class MessageTemplate(models.Model): + name = models.CharField(max_length=255) + message = models.TextField() + created = models.DateTimeField(auto_now_add=True) + marked_confidential = models.BooleanField(default=False) + marked_required = models.BooleanField(default=False) # may not be deleted + + def __str__(self): + return self.name + + +class UserNotificationChannel(models.Model): + user = models.ForeignKey(ExtendedUser, models.CASCADE) + channel_type = models.CharField(choices=[('telegram', 'telegram'), ('email', 'email')], max_length=255) + channel_target = models.CharField(max_length=255) + event_filter = models.CharField(max_length=255) + active = models.BooleanField(default=True) + created = models.DateTimeField(auto_now_add=True) + + def validate_constraints(self, exclude=None): # TODO: email -> emailaddress, telegram -> chatid + return True + + def __str__(self): + return self.user.username + '(' + self.channel_type + ')' diff --git a/core/notifications/templates.py b/core/notifications/templates.py new file mode 100644 index 0000000..af77193 --- /dev/null +++ b/core/notifications/templates.py @@ -0,0 +1,69 @@ +import jinja2 +from channels.db import database_sync_to_async +from core.settings import PRIMARY_HOST + +from notifications.models import MessageTemplate + +TEMPLATE_VARS = ['ticket_name', 'ticket_uuid', 'ticket_id', 'ticket_url', + 'current_state', 'previous_state', 'current_state_pretty', 'previous_state_pretty', + 'event_slug', 'event_name', + 'username', 'user_nick', + 'web_host'] # TODO customer_name, tracking_code + + +def limit_length(s, length=50): + if len(s) > length: + return s[:(length - 3)] + "..." + return s + + +def ticket_url(ticket): + eventslug = ticket.event.slug if ticket.event else "37C3" # TODO 37C3 should not be hardcoded + return f"https://{PRIMARY_HOST}/{eventslug}/ticket/{ticket.id}/" + + +def render_template(template, **kwargs): + try: + environment = jinja2.Environment() + environment.filters['limit_length'] = limit_length + tmpl = MessageTemplate.objects.get(name=template) + template = environment.from_string(tmpl.message) + return template.render(**kwargs, web_host=PRIMARY_HOST) + except MessageTemplate.DoesNotExist: + return None + + +def get_ticket_vars(ticket): + states = list(ticket.state_changes.order_by('-timestamp')) + return { + 'ticket_name': ticket.name, + 'ticket_uuid': ticket.short_uuid(), + 'ticket_id': ticket.id, + 'ticket_url': ticket_url(ticket), + 'current_state': states[0].state if states else 'none', + 'previous_state': states[1].state if len(states) > 1 else 'none', + 'current_state_pretty': states[0].get_state_display() if states else 'none', + 'previous_state_pretty': states[1].get_state_display() if len(states) > 1 else 'none', + 'event_slug': ticket.event.slug if ticket.event else "37C3", # TODO 37C3 should not be hardcoded + 'event_name': ticket.event.name if ticket.event else "37C3", + } + + +def render_auto_reply(ticket): + return render_template('auto_reply', **get_ticket_vars(ticket)) + + +def render_notification_new_ticket(ticket): + return render_template('new_issue_notification', **get_ticket_vars(ticket)) + + +def render_notification_reply_ticket(ticket): + return render_template('reply_issue_notification', **get_ticket_vars(ticket)) + + +async def render_notification_new_ticket_async(ticket): + return await database_sync_to_async(render_notification_new_ticket)(ticket) + + +async def render_notification_reply_ticket_async(ticket): + return await database_sync_to_async(render_notification_reply_ticket)(ticket) diff --git a/core/notifications/tests/__init__.py b/core/notifications/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/core/notify_sessions/decorators.py b/core/notify_sessions/decorators.py new file mode 100644 index 0000000..c349c42 --- /dev/null +++ b/core/notify_sessions/decorators.py @@ -0,0 +1,21 @@ +from asgiref.sync import async_to_sync +from channels.layers import get_channel_layer + + +def notify_sessions(event, data): + def wrapper(func): + def wrapped(*args, **kwargs): + ret = func(*args, **kwargs) + channel_layer = get_channel_layer() + async_to_sync(channel_layer.group_send)( + event, + { + 'type': 'notify', + 'data': data, + } + ) + return ret + + return wrapped + + return wrapper diff --git a/core/server.py b/core/server.py old mode 100644 new mode 100755 index d08b595..a09e315 --- a/core/server.py +++ b/core/server.py @@ -12,6 +12,7 @@ django.setup() from helper import init_loop from mail.protocol import LMTPHandler from mail.socket import UnixSocketLMTPController +from notifications.dispatch import NotificationDispatcher class UvicornServer(uvicorn.Server): @@ -54,6 +55,11 @@ async def lmtp(loop): log.info("LMTP done") +async def notifications(loop): + dispatcher = NotificationDispatcher() + await dispatcher.run_forever() + + def main(): import sdnotify import setproctitle @@ -67,6 +73,7 @@ def main(): loop.create_task(web(loop)) # loop.create_task(tcp(loop)) loop.create_task(lmtp(loop)) + loop.create_task(notifications(loop)) n = sdnotify.SystemdNotifier() n.notify("READY=1") log.info("Server ready") diff --git a/core/tickets/api_v2.py b/core/tickets/api_v2.py index 596bd9b..e93b179 100644 --- a/core/tickets/api_v2.py +++ b/core/tickets/api_v2.py @@ -23,6 +23,11 @@ class IssueViewSet(viewsets.ModelViewSet): queryset = IssueThread.objects.all() +class CommentViewSet(viewsets.ModelViewSet): + serializer_class = CommentSerializer + queryset = Comment.objects.all() + + class ShippingVoucherViewSet(viewsets.ModelViewSet): serializer_class = ShippingVoucherSerializer queryset = ShippingVoucher.objects.all() @@ -119,6 +124,7 @@ def add_comment(request, pk): router = routers.SimpleRouter() router.register(r'tickets', IssueViewSet, basename='issues') +#router.register(r'comments', CommentViewSet, basename='comments') router.register(r'shipping_vouchers', ShippingVoucherViewSet, basename='shipping_vouchers') urlpatterns = ([ diff --git a/core/tickets/models.py b/core/tickets/models.py index aff5d6c..be7c82c 100644 --- a/core/tickets/models.py +++ b/core/tickets/models.py @@ -1,5 +1,5 @@ -from django.db import models from django.utils import timezone +from django.db import models from django_softdelete.models import SoftDeleteModel from authentication.models import ExtendedUser diff --git a/core/tickets/serializers.py b/core/tickets/serializers.py index a980b97..3d850c4 100644 --- a/core/tickets/serializers.py +++ b/core/tickets/serializers.py @@ -52,8 +52,8 @@ class IssueSerializer(serializers.ModelSerializer): ret = super().to_internal_value(data) if 'state' in data: ret['state'] = data['state'] -# if 'assigned_to' in data: -# ret['assigned_to'] = data['assigned_to'] + # if 'assigned_to' in data: + # ret['assigned_to'] = data['assigned_to'] return ret def validate(self, attrs): diff --git a/core/tickets/tests/v2/test_tickets.py b/core/tickets/tests/v2/test_tickets.py index 8223506..0fea3dc 100644 --- a/core/tickets/tests/v2/test_tickets.py +++ b/core/tickets/tests/v2/test_tickets.py @@ -247,6 +247,16 @@ class IssueApiTest(TestCase): self.assertEqual(timeline[1]['subject'], 'test issue') self.assertEqual(timeline[1]['body'], 'test') + #def test_post_comment(self): + # issue = IssueThread.objects.create( + # name="test issue", + # ) + # response = self.client.post('/api/2/comments/', {'comment': 'test', 'issue_thread': issue.id}) + # self.assertEqual(response.status_code, 201) + # self.assertEqual(response.json()['comment'], 'test') + # self.assertEqual(response.json()['issue_thread'], issue.id) + # self.assertEqual(response.json()['timestamp'], response.json()['timestamp']) + def test_post_comment_altenative(self): issue = IssueThread.objects.create( name="test issue", diff --git a/deploy/ansible/playbooks/templates/django.env.j2 b/deploy/ansible/playbooks/templates/django.env.j2 index c9b1c83..748ecf4 100644 --- a/deploy/ansible/playbooks/templates/django.env.j2 +++ b/deploy/ansible/playbooks/templates/django.env.j2 @@ -13,3 +13,5 @@ STATIC_ROOT=/var/www/c3lf-sys3/staticfiles ACTIVE_SPAM_TRAINING=True DEBUG_MODE_ACTIVE={{ debug_mode_active }} DJANGO_SECRET_KEY={{ django_secret_key }} +TELEGRAM_GROUP_CHAT_ID={{ telegram_group_chat_id }} +TELEGRAM_BOT_TOKEN={{ telegram_bot_token }} \ No newline at end of file diff --git a/web/package.json b/web/package.json index 87f6d71..09596d6 100644 --- a/web/package.json +++ b/web/package.json @@ -8,6 +8,7 @@ "lint": "vue-cli-service lint" }, "dependencies": { + "@chenfengyuan/vue-qrcode": "^2.0.0", "@fortawesome/fontawesome-svg-core": "^6.5.1", "@fortawesome/free-solid-svg-icons": "^6.5.1", "@fortawesome/vue-fontawesome": "^3.0.6", diff --git a/web/src/components/CollapsableCards.vue b/web/src/components/CollapsableCards.vue index d1edab7..554a960 100644 --- a/web/src/components/CollapsableCards.vue +++ b/web/src/components/CollapsableCards.vue @@ -1,6 +1,31 @@ - +
    Dashboard +
  • + Settings +
  • Events
    • +
  • + Notifications +
  • Shipping
    • diff --git a/web/src/views/admin/Debug.vue b/web/src/views/admin/Debug.vue new file mode 100644 index 0000000..0c83e76 --- /dev/null +++ b/web/src/views/admin/Debug.vue @@ -0,0 +1,87 @@ + + + + + \ No newline at end of file diff --git a/web/src/views/admin/Notifications.vue b/web/src/views/admin/Notifications.vue new file mode 100644 index 0000000..cc2b615 --- /dev/null +++ b/web/src/views/admin/Notifications.vue @@ -0,0 +1,36 @@ + + + + + \ No newline at end of file diff --git a/web/src/views/admin/Settings.vue b/web/src/views/admin/Settings.vue new file mode 100644 index 0000000..2f15a83 --- /dev/null +++ b/web/src/views/admin/Settings.vue @@ -0,0 +1,109 @@ + + + + + \ No newline at end of file From 0a2c854b881b26f7982dd97aedae57203a35b139 Mon Sep 17 00:00:00 2001 From: jedi Date: Wed, 26 Jun 2024 21:22:34 +0200 Subject: [PATCH 23/36] stash --- web/src/components/Timeline.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/src/components/Timeline.vue b/web/src/components/Timeline.vue index 88bfa94..f3ac1d8 100644 --- a/web/src/components/Timeline.vue +++ b/web/src/components/Timeline.vue @@ -73,7 +73,7 @@ import TimelineMail from "@/components/TimelineMail.vue"; import TimelineComment from "@/components/TimelineComment.vue"; import TimelineStateChange from "@/components/TimelineStateChange.vue"; -import {mapActions, mapGetters} from "vuex"; +import {mapGetters} from "vuex"; import TimelineAssignment from "@/components/TimelineAssignment.vue"; import TimelineRelatedItem from "@/components/TimelineRelatedItem.vue"; import TimelineShippingVoucher from "@/components/TimelineShippingVoucher.vue"; From dfce7e7532d456eb73d8359f43978040c53e72d9 Mon Sep 17 00:00:00 2001 From: jedi Date: Fri, 28 Jun 2024 00:49:09 +0200 Subject: [PATCH 24/36] stash --- core/notifications/api_v2.py | 15 ++++++++++++-- web/src/store.js | 10 ++++++++- web/src/views/admin/Notifications.vue | 30 +++++++++------------------ 3 files changed, 32 insertions(+), 23 deletions(-) diff --git a/core/notifications/api_v2.py b/core/notifications/api_v2.py index f50a453..e459d01 100644 --- a/core/notifications/api_v2.py +++ b/core/notifications/api_v2.py @@ -5,7 +5,7 @@ from rest_framework.decorators import api_view, permission_classes from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response -from notifications.models import MessageTemplate +from notifications.models import MessageTemplate, UserNotificationChannel from rest_framework import serializers from notifications.templates import TEMPLATE_VARS @@ -17,11 +17,22 @@ class MessageTemplateSerializer(serializers.ModelSerializer): fields = '__all__' +class UserNotificationChannelSerializer(serializers.ModelSerializer): + class Meta: + model = UserNotificationChannel + fields = '__all__' + + class MessageTemplateViewSet(viewsets.ModelViewSet): serializer_class = MessageTemplateSerializer queryset = MessageTemplate.objects.all() +class UserNotificationChannelViewSet(viewsets.ModelViewSet): + serializer_class = UserNotificationChannelSerializer + queryset = UserNotificationChannel.objects.all() + + @api_view(['GET']) @permission_classes([IsAuthenticated]) @permission_required('tickets.add_issuethread_manual', raise_exception=True) # TDOO: change this permission @@ -31,7 +42,7 @@ def get_template_vars(self): router = routers.SimpleRouter() router.register(r'message_templates', MessageTemplateViewSet) - +router.register(r'user_notification_channels', UserNotificationChannelViewSet) urlpatterns = ([ re_path('message_template_variables', get_template_vars), ] + router.urls) diff --git a/web/src/store.js b/web/src/store.js index 6f650d5..b5fba1c 100644 --- a/web/src/store.js +++ b/web/src/store.js @@ -22,6 +22,7 @@ const store = createStore({ messageTemplates: [], messageTemplateVariables: [], shippingVouchers: [], + userNotificationChannels: [], lastEvent: '37C3', lastUsed: {}, @@ -532,7 +533,14 @@ const store = createStore({ state.fetchedData.tickets = 0; await Promise.all([dispatch('loadTickets'), dispatch('fetchShippingVouchers')]); } - } + }, + async fetchUserNotificationChannels({commit, state}) { + if (!state.user.token) return; + const {data, success} = await http.get('/2/user_notification_channels/', state.user.token); + if (data && success) { + state.userNotificationChannels = data; + } + }, }, plugins: [ persistentStatePlugin({ // TODO change remember to some kind of enable field diff --git a/web/src/views/admin/Notifications.vue b/web/src/views/admin/Notifications.vue index cc2b615..5a451fc 100644 --- a/web/src/views/admin/Notifications.vue +++ b/web/src/views/admin/Notifications.vue @@ -1,22 +1,9 @@ From 11cd752249eb65912e8b962f5e0732605d7038de Mon Sep 17 00:00:00 2001 From: jedi Date: Sat, 29 Jun 2024 16:48:08 +0200 Subject: [PATCH 25/36] stash --- core/authentication/api_v2.py | 41 +++++---------------------- core/authentication/serializers.py | 32 +++++++++++++++++++++ core/notifications/api_v2.py | 3 ++ web/src/views/admin/Notifications.vue | 2 +- 4 files changed, 43 insertions(+), 35 deletions(-) create mode 100644 core/authentication/serializers.py diff --git a/core/authentication/api_v2.py b/core/authentication/api_v2.py index 514a697..2547b6d 100644 --- a/core/authentication/api_v2.py +++ b/core/authentication/api_v2.py @@ -12,25 +12,7 @@ from knox.models import AuthToken from knox.views import LoginView as KnoxLoginView from authentication.models import ExtendedUser - - -class UserSerializer(serializers.ModelSerializer): - permissions = serializers.SerializerMethodField() - groups = serializers.SlugRelatedField(many=True, read_only=True, slug_field='name') - - class Meta: - model = ExtendedUser - fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') - read_only_fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') - - def get_permissions(self, obj): - return list(set(obj.get_permissions())) - - -@receiver(post_save, sender=ExtendedUser) -def create_auth_token(sender, instance=None, created=False, **kwargs): - if created: - AuthToken.objects.create(user=instance) +from authentication.serializers import UserSerializer, GroupSerializer class UserViewSet(viewsets.ModelViewSet): @@ -38,26 +20,17 @@ class UserViewSet(viewsets.ModelViewSet): serializer_class = UserSerializer -class GroupSerializer(serializers.ModelSerializer): - permissions = serializers.SerializerMethodField() - members = serializers.SerializerMethodField() - - class Meta: - model = Group - fields = ('id', 'name', 'permissions', 'members') - - def get_permissions(self, obj): - return ["*:" + p.codename for p in obj.permissions.all()] - - def get_members(self, obj): - return [u.username for u in obj.user_set.all()] - - class GroupViewSet(viewsets.ModelViewSet): queryset = Group.objects.all() serializer_class = GroupSerializer +@receiver(post_save, sender=ExtendedUser) +def create_auth_token(sender, instance=None, created=False, **kwargs): + if created: + AuthToken.objects.create(user=instance) + + @api_view(['GET']) @permission_classes([IsAuthenticated]) def selfUser(request): diff --git a/core/authentication/serializers.py b/core/authentication/serializers.py new file mode 100644 index 0000000..0581865 --- /dev/null +++ b/core/authentication/serializers.py @@ -0,0 +1,32 @@ +from rest_framework import serializers +from django.contrib.auth.models import Group + +from authentication.models import ExtendedUser + + +class UserSerializer(serializers.ModelSerializer): + permissions = serializers.SerializerMethodField() + groups = serializers.SlugRelatedField(many=True, read_only=True, slug_field='name') + + class Meta: + model = ExtendedUser + fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') + read_only_fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') + + def get_permissions(self, obj): + return list(set(obj.get_permissions())) + + +class GroupSerializer(serializers.ModelSerializer): + permissions = serializers.SerializerMethodField() + members = serializers.SerializerMethodField() + + class Meta: + model = Group + fields = ('id', 'name', 'permissions', 'members') + + def get_permissions(self, obj): + return ["*:" + p.codename for p in obj.permissions.all()] + + def get_members(self, obj): + return [u.username for u in obj.user_set.all()] diff --git a/core/notifications/api_v2.py b/core/notifications/api_v2.py index e459d01..a9492f5 100644 --- a/core/notifications/api_v2.py +++ b/core/notifications/api_v2.py @@ -9,6 +9,7 @@ from notifications.models import MessageTemplate, UserNotificationChannel from rest_framework import serializers from notifications.templates import TEMPLATE_VARS +from authentication.serializers import UserSerializer class MessageTemplateSerializer(serializers.ModelSerializer): @@ -18,6 +19,8 @@ class MessageTemplateSerializer(serializers.ModelSerializer): class UserNotificationChannelSerializer(serializers.ModelSerializer): + user = UserSerializer() + class Meta: model = UserNotificationChannel fields = '__all__' diff --git a/web/src/views/admin/Notifications.vue b/web/src/views/admin/Notifications.vue index 5a451fc..312a902 100644 --- a/web/src/views/admin/Notifications.vue +++ b/web/src/views/admin/Notifications.vue @@ -1,7 +1,7 @@ From 656cd330502deb3b82f606ec7a671ef4ec48ae1d Mon Sep 17 00:00:00 2001 From: jedi Date: Sat, 13 Jul 2024 17:28:38 +0200 Subject: [PATCH 26/36] stash --- web/src/components/Timeline.vue | 2 +- web/src/store.js | 8 +++++- web/src/views/Tickets.vue | 2 +- web/src/views/admin/Notifications.vue | 37 +++++++++++++++++++++++---- 4 files changed, 41 insertions(+), 8 deletions(-) diff --git a/web/src/components/Timeline.vue b/web/src/components/Timeline.vue index f3ac1d8..88bfa94 100644 --- a/web/src/components/Timeline.vue +++ b/web/src/components/Timeline.vue @@ -73,7 +73,7 @@ import TimelineMail from "@/components/TimelineMail.vue"; import TimelineComment from "@/components/TimelineComment.vue"; import TimelineStateChange from "@/components/TimelineStateChange.vue"; -import {mapGetters} from "vuex"; +import {mapActions, mapGetters} from "vuex"; import TimelineAssignment from "@/components/TimelineAssignment.vue"; import TimelineRelatedItem from "@/components/TimelineRelatedItem.vue"; import TimelineShippingVoucher from "@/components/TimelineShippingVoucher.vue"; diff --git a/web/src/store.js b/web/src/store.js index b5fba1c..0724070 100644 --- a/web/src/store.js +++ b/web/src/store.js @@ -47,6 +47,7 @@ const store = createStore({ states: 0, messageTemplates: 0, shippingVouchers: 0, + userNotificationChannels: 0, }, persistent_loaded: false, shared_loaded: false, @@ -241,6 +242,10 @@ const store = createStore({ state.shippingVouchers = codes; state.fetchedData = {...state.fetchedData, shippingVouchers: Date.now()}; }, + setUserNotificationChannels(state, channels) { + state.userNotificationChannels = channels; + state.fetchedData = {...state.fetchedData, userNotificationChannels: Date.now()}; + }, }, actions: { async login({commit}, {username, password, remember}) { @@ -536,9 +541,10 @@ const store = createStore({ }, async fetchUserNotificationChannels({commit, state}) { if (!state.user.token) return; + if (state.fetchedData.userNotificationChannels > Date.now() - 1000 * 60 * 60 * 24) return; const {data, success} = await http.get('/2/user_notification_channels/', state.user.token); if (data && success) { - state.userNotificationChannels = data; + commit('setUserNotificationChannels', data); } }, }, diff --git a/web/src/views/Tickets.vue b/web/src/views/Tickets.vue index 55574c8..f1497bb 100644 --- a/web/src/views/Tickets.vue +++ b/web/src/views/Tickets.vue @@ -3,7 +3,7 @@
    - -
      -
    • - {{ channel.id }} - {{ channel.channel_type }} - {{ channel.channel_target }} - {{ channel.event_filter }} - {{ channel.active }} - {{ channel.created }} - {{ channel.user }} -
      • -
    +
    + + +
    +
    +
    +
    + + + + +
    + +
    +
    +
    +
    +
    + + \ No newline at end of file diff --git a/web/src/store.js b/web/src/store.js index 0724070..b29ffba 100644 --- a/web/src/store.js +++ b/web/src/store.js @@ -340,6 +340,13 @@ const store = createStore({ commit('replaceEvents', [...state.events.filter(e => e.eid !== event_id)]) } }, + async updateEvent({commit, dispatch, state}, {id, partial_event}){ + console.log(id, partial_event); + const {data, success} = await http.patch(`/2/events/${id}/`, partial_event, state.user.token); + if (success) { + commit('replaceEvents', [...state.events.filter(e => e.eid !== id), data]) + } + }, async fetchTicketStates({commit, state}) { if (!state.user.token) return; if (state.fetchedData.states > Date.now() - 1000 * 60 * 60 * 24) return; diff --git a/web/src/views/admin/Events.vue b/web/src/views/admin/Events.vue index 1aab608..e2ff952 100644 --- a/web/src/views/admin/Events.vue +++ b/web/src/views/admin/Events.vue @@ -1,50 +1,102 @@ \ No newline at end of file From 7f7cf26a5dffd893a03f27c6c2fe02312582d898 Mon Sep 17 00:00:00 2001 From: jedi Date: Wed, 6 Nov 2024 07:25:10 +0100 Subject: [PATCH 35/36] stash --- core/inventory/serializers.py | 34 ++++++++++++++++--- core/inventory/tests/v2/test_events.py | 13 ++++++- .../0006_alter_eventaddress_address.py | 18 ++++++++++ core/mail/models.py | 2 +- 4 files changed, 60 insertions(+), 7 deletions(-) create mode 100644 core/mail/migrations/0006_alter_eventaddress_address.py diff --git a/core/inventory/serializers.py b/core/inventory/serializers.py index 4aef119..fc5d929 100644 --- a/core/inventory/serializers.py +++ b/core/inventory/serializers.py @@ -1,25 +1,49 @@ from django.utils import timezone from rest_framework import serializers +from rest_framework.relations import SlugRelatedField from files.models import File from inventory.models import Event, Container, Item from mail.models import EventAddress -class EventAdressSerializer(serializers.ModelSerializer): - class Meta: - model = EventAddress - fields = ['address'] +#class EventAdressSerializer(serializers.ModelSerializer): +# class Meta: +# model = EventAddress +# fields = ['address'] + +# def to_internal_value(self, data): +# if not isinstance(data, str): +# raise serializers.ValidationError('This field must be a string.') +# +# def create(self, validated_data): +# return EventAddress.objects.create(**validated_data) +# +# def validate(self, data): +# return isinstance(data, str) + class EventSerializer(serializers.ModelSerializer): - addresses = EventAdressSerializer(many=True, required=False) + #addresses = EventAdressSerializer(many=True, required=False) + addresses = SlugRelatedField(many=True, slug_field='address', queryset=EventAddress.objects.all()) class Meta: model = Event fields = ['eid', 'slug', 'name', 'start', 'end', 'pre_start', 'post_end', 'addresses'] read_only_fields = ['eid'] +# def update(self, instance, validated_data): +# addresses = validated_data.pop('addresses', None) +# instance.save(validated_data) +# if addresses: +# for address in addresses: +# nested_instance, created = EventAddress.objects.get_or_create(address=address) +# instance.addresses.add(nested_instance) +# +# return instance + + class ContainerSerializer(serializers.ModelSerializer): itemCount = serializers.SerializerMethodField() diff --git a/core/inventory/tests/v2/test_events.py b/core/inventory/tests/v2/test_events.py index affbd0e..6bbc701 100644 --- a/core/inventory/tests/v2/test_events.py +++ b/core/inventory/tests/v2/test_events.py @@ -47,6 +47,18 @@ class EventTestCase(TestCase): self.assertEqual(Event.objects.all()[0].slug, 'EVENT2') self.assertEqual(Event.objects.all()[0].name, 'Event 2 new') + def test_update_event(self): + from rest_framework.test import APIClient + event = Event.objects.create(slug='EVENT1', name='Event 1') + response = APIClient().patch(f'/api/2/events/{event.eid}/', {'addresses': ['foo@bar.baz', 'foo1@bar.baz']}) + self.assertEqual(response.status_code, 200) + self.assertEqual(response.json()['slug'], 'EVENT1') + self.assertEqual(response.json()['name'], 'Event 1') + self.assertEqual(len(Event.objects.all()), 1) + self.assertEqual(Event.objects.all()[0].slug, 'EVENT1') + self.assertEqual(Event.objects.all()[0].name, 'Event 1') + self.assertEqual(1, len(response.json()[0]['addresses'])) + def test_remove_event(self): event = Event.objects.create(slug='EVENT1', name='Event 1') Event.objects.create(slug='EVENT2', name='Event 2') @@ -65,4 +77,3 @@ class EventTestCase(TestCase): self.assertEqual('TEST1', response.json()[0]['slug']) self.assertEqual('Event', response.json()[0]['name']) self.assertEqual(1, len(response.json()[0]['addresses'])) - diff --git a/core/mail/migrations/0006_alter_eventaddress_address.py b/core/mail/migrations/0006_alter_eventaddress_address.py new file mode 100644 index 0000000..5a03261 --- /dev/null +++ b/core/mail/migrations/0006_alter_eventaddress_address.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2.7 on 2024-11-06 06:13 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('mail', '0005_alter_eventaddress_event'), + ] + + operations = [ + migrations.AlterField( + model_name='eventaddress', + name='address', + field=models.CharField(max_length=255, unique=True), + ), + ] diff --git a/core/mail/models.py b/core/mail/models.py index 8a0d153..8c95e6b 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -46,7 +46,7 @@ class Email(SoftDeleteModel): class EventAddress(models.Model): id = models.AutoField(primary_key=True) event = models.ForeignKey(Event, models.SET_NULL, null=True, related_name='addresses') - address = models.CharField(max_length=255) + address = models.CharField(max_length=255, unique=True) class EmailAttachment(AbstractFile): From 82b761e7f142696f26236c5a3526c66e89d720f1 Mon Sep 17 00:00:00 2001 From: jedi Date: Fri, 8 Nov 2024 22:23:52 +0100 Subject: [PATCH 36/36] save raw_mails as file --- core/mail/migrations/0007_email_raw_file.py | 36 +++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 core/mail/migrations/0007_email_raw_file.py diff --git a/core/mail/migrations/0007_email_raw_file.py b/core/mail/migrations/0007_email_raw_file.py new file mode 100644 index 0000000..03d0db0 --- /dev/null +++ b/core/mail/migrations/0007_email_raw_file.py @@ -0,0 +1,36 @@ +# Generated by Django 4.2.7 on 2024-11-08 20:37 +from django.core.files.base import ContentFile +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('mail', '0006_alter_eventaddress_address'), + ] + + def move_raw_mails_to_file(apps, schema_editor): + Email = apps.get_model('mail', 'Email') + for email in Email.objects.all(): + raw_content = email.raw + email.raw_file = ContentFile(raw_content) + email.raw = None + email.save() + + operations = [ + migrations.AddField( + model_name='email', + name='raw_file', + field=models.FileField(null=True, upload_to='raw_mail/'), + ), + migrations.RunPython(move_raw_mails_to_file), + migrations.RemoveField( + model_name='email', + name='raw', + ), + migrations.AlterField( + model_name='email', + name='raw_file', + field=models.FileField(upload_to='raw_mail/'), + ), + ]