diff --git a/.forgejo/workflows/deploy_staging.yml b/.forgejo/workflows/deploy_staging.yml index 3b44d24..881f31e 100644 --- a/.forgejo/workflows/deploy_staging.yml +++ b/.forgejo/workflows/deploy_staging.yml @@ -17,12 +17,15 @@ jobs: - name: Install dependencies working-directory: core run: pip3 install -r requirements.dev.txt - - name: Run django tests + - name: Run django tests with coverage working-directory: core - run: python3 manage.py test + run: coverage run manage.py test + - name: Evaluate coverage + working-directory: core + run: coverage report deploy: - needs: [test] + needs: [ test ] runs-on: docker steps: - uses: actions/checkout@v4 diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..f3f3038 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "web/extras"] + path = web/extras + url = https://git.neulandlabor.de/j3d1/vue-extras.git diff --git a/core/.coveragerc b/core/.coveragerc index 14c1fba..3091244 100644 --- a/core/.coveragerc +++ b/core/.coveragerc @@ -9,6 +9,9 @@ omit = */tests/* */migrations/* core/asgi.py - core/wsgi.py + core/globals.py core/settings.py - manage.py \ No newline at end of file + mail/socket.py + manage.py + server.py + helper.py \ No newline at end of file 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 5a8f20f..cfa395c 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -49,9 +49,14 @@ 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 = [ + *(['daphne'] if 'runserver' in sys.argv else []), 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', @@ -65,6 +70,7 @@ INSTALLED_APPS = [ 'drf_yasg', 'channels', 'authentication', + 'notifications', 'files', 'tickets', 'inventory', @@ -124,7 +130,7 @@ TEMPLATES = [ }, ] -WSGI_APPLICATION = 'core.wsgi.application' +ASGI_APPLICATION = 'core.asgi.application' # Database # https://docs.djangoproject.com/en/4.2/ref/settings/#databases diff --git a/core/core/urls.py b/core/core/urls.py index 1c5f158..d224e52 100644 --- a/core/core/urls.py +++ b/core/core/urls.py @@ -28,6 +28,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/inventory/admin.py b/core/inventory/admin.py index 2457b5b..24cd14a 100644 --- a/core/inventory/admin.py +++ b/core/inventory/admin.py @@ -1,6 +1,6 @@ from django.contrib import admin -from inventory.models import Item, Container, Event +from inventory.models import Item, Container, ItemPlacement, Comment, Event class ItemAdmin(admin.ModelAdmin): @@ -22,3 +22,17 @@ class EventAdmin(admin.ModelAdmin): admin.site.register(Event, EventAdmin) + + +class ItemPlacementAdmin(admin.ModelAdmin): + pass + + +admin.site.register(ItemPlacement, ItemPlacementAdmin) + + +class CommentAdmin(admin.ModelAdmin): + pass + + +admin.site.register(Comment, CommentAdmin) diff --git a/core/inventory/api_v2.py b/core/inventory/api_v2.py index e1f643e..e21bf22 100644 --- a/core/inventory/api_v2.py +++ b/core/inventory/api_v2.py @@ -1,15 +1,20 @@ from django.urls import re_path from django.contrib.auth.decorators import permission_required -from rest_framework import routers, viewsets +from rest_framework import routers, viewsets, status from rest_framework.decorators import api_view, permission_classes from rest_framework.response import Response from rest_framework.permissions import IsAuthenticated +from asgiref.sync import async_to_sync +from channels.layers import get_channel_layer -from inventory.models import Event, Container, Item -from inventory.serializers import EventSerializer, ContainerSerializer, ItemSerializer, SearchResultSerializer +from inventory.models import Event, Container, Item, Comment +from inventory.serializers import EventSerializer, ContainerSerializer, ItemSerializer, SearchResultSerializer, \ + CommentSerializer from base64 import b64decode +from notify_sessions.models import SystemEvent + class EventViewSet(viewsets.ModelViewSet): serializer_class = EventSerializer @@ -22,6 +27,17 @@ class ContainerViewSet(viewsets.ModelViewSet): queryset = Container.objects.all() +class ItemViewSet(viewsets.ModelViewSet): + serializer_class = ItemSerializer + + def get_queryset(self): + queryset = Item.objects.all() + serializer = self.get_serializer_class() + if hasattr(serializer, 'Meta') and hasattr(serializer.Meta, 'prefetch_related_fields'): + queryset = queryset.prefetch_related(*serializer.Meta.prefetch_related_fields) + return queryset + + def filter_items(items, query): query_tokens = query.split(' ') for item in items: @@ -49,6 +65,7 @@ def search_items(request, event_slug, query): @api_view(['GET', 'POST']) @permission_classes([IsAuthenticated]) def item(request, event_slug): + vs = ItemViewSet() try: event = None if event_slug != 'none': @@ -56,7 +73,7 @@ def item(request, event_slug): if request.method == 'GET': if not request.user.has_event_perm(event, 'view_item'): return Response(status=403) - return Response(ItemSerializer(Item.objects.filter(event=event), many=True).data) + return Response(ItemSerializer(vs.get_queryset().filter(event=event), many=True).data) elif request.method == 'POST': if not request.user.has_event_perm(event, 'add_item'): return Response(status=403) @@ -67,6 +84,33 @@ def item(request, event_slug): return Response(status=400) except Event.DoesNotExist: return Response(status=404) + except KeyError: + return Response(status=400) + + +@api_view(['POST']) +@permission_classes([IsAuthenticated]) +@permission_required('tickets.add_comment', raise_exception=True) +def add_comment(request, event_slug, id): + event = None + if event_slug != 'none': + event = Event.objects.get(slug=event_slug) + item = Item.objects.get(event=event, id=id) + if not request.user.has_event_perm(event, 'view_item'): + return Response(status=403) + if 'comment' not in request.data or request.data['comment'] == '': + return Response({'status': 'error', 'message': 'missing comment'}, status=status.HTTP_400_BAD_REQUEST) + comment = Comment.objects.create( + item=item, + comment=request.data['comment'], + ) + systemevent = SystemEvent.objects.create(type='comment added', reference=comment.id) + channel_layer = get_channel_layer() + async_to_sync(channel_layer.group_send)( + 'general', {"type": "generic.event", "name": "send_message_to_frontend", "event_id": systemevent.id, + "message": "comment added"} + ) + return Response(CommentSerializer(comment).data, status=status.HTTP_201_CREATED) @api_view(['GET', 'PUT', 'DELETE', 'PATCH']) @@ -74,7 +118,7 @@ def item(request, event_slug): def item_by_id(request, event_slug, id): try: event = Event.objects.get(slug=event_slug) - item = Item.objects.get(event=event, id=id) + item = ItemViewSet().get_queryset().get(event=event, id=id) if request.method == 'GET': if not request.user.has_event_perm(event, 'view_item'): return Response(status=403) @@ -115,5 +159,6 @@ urlpatterns = router.urls + [ re_path(r'^(?P[\w-]+)/items/$', item, name='item'), re_path(r'^(?P[\w-]+)/items/(?P[-A-Za-z0-9+/]*={0,3})/$', search_items, name='search_items'), re_path(r'^(?P[\w-]+)/item/$', item, name='item'), + re_path(r'^(?P[\w-]+)/item/(?P\d+)/comment/$', add_comment, name='add_comment'), re_path(r'^(?P[\w-]+)/item/(?P\d+)/$', item_by_id, name='item_by_id'), ] diff --git a/core/inventory/migrations/0007_remove_item_container_itemplacement_comment.py b/core/inventory/migrations/0007_remove_item_container_itemplacement_comment.py new file mode 100644 index 0000000..24c0f75 --- /dev/null +++ b/core/inventory/migrations/0007_remove_item_container_itemplacement_comment.py @@ -0,0 +1,36 @@ +# Generated by Django 4.2.7 on 2024-11-23 00:19 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('inventory', '0006_alter_event_table'), + ] + + operations = [ + migrations.RemoveField( + model_name='item', + name='container', + ), + migrations.CreateModel( + name='ItemPlacement', + fields=[ + ('id', models.AutoField(primary_key=True, serialize=False)), + ('timestamp', models.DateTimeField(auto_now_add=True)), + ('container', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='item_history', to='inventory.container')), + ('item', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='container_history', to='inventory.item')), + ], + ), + migrations.CreateModel( + name='Comment', + fields=[ + ('id', models.AutoField(primary_key=True, serialize=False)), + ('comment', models.TextField()), + ('timestamp', models.DateTimeField(auto_now_add=True)), + ('item', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='comments', to='inventory.item')), + ], + ), + ] diff --git a/core/inventory/migrations/0007_rename_container_item_container_old_itemplacement_and_more.py b/core/inventory/migrations/0007_rename_container_item_container_old_itemplacement_and_more.py new file mode 100644 index 0000000..918f636 --- /dev/null +++ b/core/inventory/migrations/0007_rename_container_item_container_old_itemplacement_and_more.py @@ -0,0 +1,52 @@ +# Generated by Django 4.2.7 on 2024-11-23 15:27 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + dependencies = [ + ('inventory', '0006_alter_event_table'), + ] + + def set_initial_container(apps, schema_editor): + Item = apps.get_model('inventory', 'Item') + for item in Item.objects.all(): + item.container_history.get_or_create(container=item.container_old) + item.save() + + operations = [ + migrations.RenameField( + model_name='item', + old_name='container', + new_name='container_old', + ), + migrations.CreateModel( + name='ItemPlacement', + fields=[ + ('id', models.AutoField(primary_key=True, serialize=False)), + ('timestamp', models.DateTimeField(auto_now_add=True)), + ('container', + models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='item_history', + to='inventory.container')), + ('item', + models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='container_history', + to='inventory.item')), + ], + ), + migrations.CreateModel( + name='Comment', + fields=[ + ('id', models.AutoField(primary_key=True, serialize=False)), + ('comment', models.TextField()), + ('timestamp', models.DateTimeField(auto_now_add=True)), + ('item', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='comments', + to='inventory.item')), + ], + ), + migrations.RunPython(set_initial_container), + migrations.RemoveField( + model_name='item', + name='container_old', + ), + ] diff --git a/core/inventory/models.py b/core/inventory/models.py index 3421680..10796e1 100644 --- a/core/inventory/models.py +++ b/core/inventory/models.py @@ -7,11 +7,14 @@ from django_softdelete.models import SoftDeleteModel, SoftDeleteManager class ItemManager(SoftDeleteManager): def create(self, **kwargs): + container = kwargs.pop('container') if 'uid_deprecated' in kwargs: raise ValueError('uid_deprecated must not be set manually') uid_deprecated = Item.all_objects.filter(event=kwargs['event']).count() + 1 kwargs['uid_deprecated'] = uid_deprecated - return super().create(**kwargs) + item = super().create(**kwargs) + item.container = container + return item def get_queryset(self): return super().get_queryset().filter(returned_at__isnull=True) @@ -22,18 +25,28 @@ class Item(SoftDeleteModel): uid_deprecated = models.IntegerField() description = models.TextField() event = models.ForeignKey('Event', models.CASCADE) - container = models.ForeignKey('Container', models.CASCADE) returned_at = models.DateTimeField(blank=True, null=True) created_at = models.DateTimeField(null=True, auto_now_add=True) updated_at = models.DateTimeField(blank=True, null=True) + @property + def container(self): + try: + return self.container_history.order_by('-timestamp').first().container + except AttributeError: + return None + + @container.setter + def container(self, value): + if self.container == value: + return + self.container_history.create(container=value) + @property def related_issues(self): groups = groupby(self.issue_relation_changes.all(), lambda rel: rel.issue_thread.id) return [sorted(v, key=lambda r: r.timestamp)[0].issue_thread for k, v in groups] - - objects = ItemManager() all_objects = models.Manager() @@ -53,10 +66,35 @@ class Container(SoftDeleteModel): created_at = models.DateTimeField(blank=True, null=True) updated_at = models.DateTimeField(blank=True, null=True) + @property + def items(self): + try: + history = self.item_history.order_by('-timestamp').all() + return [v for k, v in groupby(history, key=lambda item: item.item.id)] + except AttributeError: + return [] + def __str__(self): return '[' + str(self.id) + ']' + self.name +class ItemPlacement(models.Model): + id = models.AutoField(primary_key=True) + item = models.ForeignKey('Item', models.CASCADE, related_name='container_history') + container = models.ForeignKey('Container', models.CASCADE, related_name='item_history') + timestamp = models.DateTimeField(auto_now_add=True) + + +class Comment(models.Model): + id = models.AutoField(primary_key=True) + item = models.ForeignKey(Item, on_delete=models.CASCADE, related_name='comments') + comment = models.TextField() + timestamp = models.DateTimeField(auto_now_add=True) + + def __str__(self): + return str(self.item) + ' comment #' + str(self.id) + + class Event(models.Model): id = models.AutoField(primary_key=True) name = models.CharField(max_length=255) @@ -72,4 +110,4 @@ class Event(models.Model): return '[' + str(self.slug) + ']' + self.name class Meta: - db_table = 'common_event' \ No newline at end of file + db_table = 'common_event' diff --git a/core/inventory/serializers.py b/core/inventory/serializers.py index 2611ce3..90a75aa 100644 --- a/core/inventory/serializers.py +++ b/core/inventory/serializers.py @@ -3,7 +3,7 @@ from rest_framework import serializers from rest_framework.relations import SlugRelatedField from files.models import File -from inventory.models import Event, Container, Item +from inventory.models import Event, Container, Item, Comment from inventory.shared_serializers import BasicItemSerializer from mail.models import EventAddress from tickets.shared_serializers import BasicIssueSerializer @@ -35,17 +35,32 @@ class ContainerSerializer(serializers.ModelSerializer): read_only_fields = ['id', 'itemCount'] def get_itemCount(self, instance): - return Item.objects.filter(container=instance.id).count() + return len(instance.items) + + +class CommentSerializer(serializers.ModelSerializer): + + def validate(self, attrs): + if 'comment' not in attrs or attrs['comment'] == '': + raise serializers.ValidationError('comment cannot be empty') + return attrs + + class Meta: + model = Comment + fields = ('id', 'comment', 'timestamp', 'item') class ItemSerializer(BasicItemSerializer): + timeline = serializers.SerializerMethodField() dataImage = serializers.CharField(write_only=True, required=False) related_issues = BasicIssueSerializer(many=True, read_only=True) class Meta: model = Item - fields = ['cid', 'box', 'id', 'description', 'file', 'dataImage', 'returned', 'event', 'related_issues'] + fields = ['cid', 'box', 'id', 'description', 'file', 'dataImage', 'returned', 'event', 'related_issues', + 'timeline'] read_only_fields = ['id'] + prefetch_related_fields = ['comments', 'issue_relation_changes', 'container_history'] def to_internal_value(self, data): container = None @@ -86,6 +101,34 @@ class ItemSerializer(BasicItemSerializer): instance.files.add(file) return super().update(instance, validated_data) + @staticmethod + def get_timeline(obj): + timeline = [] + for comment in obj.comments.all(): + timeline.append({ + 'type': 'comment', + 'id': comment.id, + 'timestamp': comment.timestamp, + 'comment': comment.comment, + }) + for relation in (obj.issue_relation_changes.all()): + timeline.append({ + 'type': 'issue_relation', + 'id': relation.id, + 'status': relation.status, + 'timestamp': relation.timestamp, + 'issue_thread': BasicIssueSerializer(relation.issue_thread).data, + }) + for placement in (obj.container_history.all()): + timeline.append({ + 'type': 'placement', + 'id': placement.id, + 'timestamp': placement.timestamp, + 'cid': placement.container.id, + 'box': placement.container.name + }) + return sorted(timeline, key=lambda x: x['timestamp']) + class SearchResultSerializer(serializers.Serializer): search_score = serializers.IntegerField() diff --git a/core/inventory/tests/v2/test_items.py b/core/inventory/tests/v2/test_items.py index d289a70..0c85eb4 100644 --- a/core/inventory/tests/v2/test_items.py +++ b/core/inventory/tests/v2/test_items.py @@ -1,3 +1,5 @@ +from datetime import datetime, timedelta + from django.utils import timezone from django.test import TestCase, Client from django.contrib.auth.models import Permission @@ -5,52 +7,101 @@ from knox.models import AuthToken from authentication.models import ExtendedUser from files.models import File -from inventory.models import Event, Container, Item +from inventory.models import Event, Container, Item, Comment, ItemPlacement from base64 import b64encode +from tickets.models import IssueThread, ItemRelation + class ItemTestCase(TestCase): def setUp(self): super().setUp() self.event = Event.objects.create(slug='EVENT', name='Event') - self.box = Container.objects.create(name='BOX') + self.box1 = Container.objects.create(name='BOX1') + self.box2 = Container.objects.create(name='BOX2') self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') self.user.user_permissions.add(*Permission.objects.all()) self.token = AuthToken.objects.create(user=self.user) self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) + self.issue = IssueThread.objects.create( + name="test issue", + event=self.event, + ) def test_empty(self): response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(response.content, b'[]') - def test_members(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') + def test_members_and_timeline(self): + now = datetime.now() + item = Item.objects.create(container=self.box1, event=self.event, description='1') + comment = Comment.objects.create( + item=item, + comment="test", + timestamp=now + timedelta(seconds=3), + ) + match = ItemRelation.objects.create( + issue_thread=self.issue, + item=item, + timestamp=now + timedelta(seconds=4), + ) + placement = ItemPlacement.objects.create( + container=self.box2, + item=item, + timestamp=now + timedelta(seconds=5), + ) response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) self.assertEqual(response.json()[0]['id'], item.id) self.assertEqual(response.json()[0]['description'], '1') - self.assertEqual(response.json()[0]['box'], 'BOX') - self.assertEqual(response.json()[0]['cid'], self.box.id) + self.assertEqual(response.json()[0]['box'], 'BOX2') + self.assertEqual(response.json()[0]['cid'], self.box2.id) self.assertEqual(response.json()[0]['file'], None) self.assertEqual(response.json()[0]['returned'], False) self.assertEqual(response.json()[0]['event'], self.event.slug) - self.assertEqual(len(response.json()[0]['related_issues']), 0) + self.assertEqual(len(response.json()[0]['timeline']), 4) + self.assertEqual(response.json()[0]['timeline'][0]['type'], 'placement') + self.assertEqual(response.json()[0]['timeline'][1]['type'], 'comment') + self.assertEqual(response.json()[0]['timeline'][2]['type'], 'issue_relation') + self.assertEqual(response.json()[0]['timeline'][3]['type'], 'placement') + self.assertEqual(response.json()[0]['timeline'][1]['id'], comment.id) + self.assertEqual(response.json()[0]['timeline'][2]['id'], match.id) + self.assertEqual(response.json()[0]['timeline'][3]['id'], placement.id) + self.assertEqual(response.json()[0]['timeline'][0]['box'], 'BOX1') + self.assertEqual(response.json()[0]['timeline'][0]['cid'], self.box1.id) + self.assertEqual(response.json()[0]['timeline'][1]['comment'], 'test') + self.assertEqual(response.json()[0]['timeline'][1]['timestamp'], + comment.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(response.json()[0]['timeline'][2]['status'], 'possible') + self.assertEqual(response.json()[0]['timeline'][2]['timestamp'], + match.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(response.json()[0]['timeline'][2]['issue_thread']['name'], "test issue") + self.assertEqual(response.json()[0]['timeline'][2]['issue_thread']['event'], "EVENT") + self.assertEqual(response.json()[0]['timeline'][2]['issue_thread']['state'], "pending_new") + self.assertEqual(response.json()[0]['timeline'][3]['box'], 'BOX2') + self.assertEqual(response.json()[0]['timeline'][3]['cid'], self.box2.id) + self.assertEqual(response.json()[0]['timeline'][3]['timestamp'], + placement.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(len(response.json()[0]['related_issues']), 1) + self.assertEqual(response.json()[0]['related_issues'][0]['name'], "test issue") + self.assertEqual(response.json()[0]['related_issues'][0]['event'], "EVENT") + self.assertEqual(response.json()[0]['related_issues'][0]['state'], "pending_new") def test_members_with_file(self): import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') + item = Item.objects.create(container=self.box1, event=self.event, description='1') file = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) self.assertEqual(response.json()[0]['id'], item.id) self.assertEqual(response.json()[0]['description'], '1') - self.assertEqual(response.json()[0]['box'], 'BOX') - self.assertEqual(response.json()[0]['cid'], self.box.id) + self.assertEqual(response.json()[0]['box'], 'BOX1') + self.assertEqual(response.json()[0]['cid'], self.box1.id) self.assertEqual(response.json()[0]['file'], file.hash) self.assertEqual(response.json()[0]['returned'], False) self.assertEqual(response.json()[0]['event'], self.event.slug) @@ -58,36 +109,38 @@ class ItemTestCase(TestCase): def test_members_with_two_file(self): import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') - file1 = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - file2 = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"bar").decode('utf-8')) + item = Item.objects.create(container=self.box1, event=self.event, description='1') + file1 = File.objects.create(item=item, + data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) + file2 = File.objects.create(item=item, + data="data:text/plain;base64," + base64.b64encode(b"bar").decode('utf-8')) response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) self.assertEqual(response.json()[0]['id'], item.id) self.assertEqual(response.json()[0]['description'], '1') - self.assertEqual(response.json()[0]['box'], 'BOX') - self.assertEqual(response.json()[0]['cid'], self.box.id) + self.assertEqual(response.json()[0]['box'], 'BOX1') + self.assertEqual(response.json()[0]['cid'], self.box1.id) self.assertEqual(response.json()[0]['file'], file2.hash) self.assertEqual(response.json()[0]['returned'], False) self.assertEqual(response.json()[0]['event'], self.event.slug) self.assertEqual(len(response.json()[0]['related_issues']), 0) def test_multi_members(self): - Item.objects.create(container=self.box, event=self.event, description='1') - Item.objects.create(container=self.box, event=self.event, description='2') - Item.objects.create(container=self.box, event=self.event, description='3') + Item.objects.create(container=self.box1, event=self.event, description='1') + Item.objects.create(container=self.box1, event=self.event, description='2') + Item.objects.create(container=self.box1, event=self.event, description='3') response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 3) def test_create_item(self): - response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box.id, 'description': '1'}) + response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box1.id, 'description': '1'}) self.assertEqual(response.status_code, 201) self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['description'], '1') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.id) + self.assertEqual(response.json()['box'], 'BOX1') + self.assertEqual(response.json()['cid'], self.box1.id) self.assertEqual(response.json()['file'], None) self.assertEqual(response.json()['returned'], False) self.assertEqual(response.json()['event'], self.event.slug) @@ -95,43 +148,43 @@ class ItemTestCase(TestCase): self.assertEqual(len(Item.objects.all()), 1) self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.id, self.box.id) + self.assertEqual(Item.objects.all()[0].container.id, self.box1.id) def test_create_item_without_container(self): response = self.client.post(f'/api/2/{self.event.slug}/item/', {'description': '1'}) self.assertEqual(response.status_code, 400) def test_create_item_without_description(self): - response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box.id}) + response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box1.id}) self.assertEqual(response.status_code, 400) def test_create_item_with_file(self): import base64 response = self.client.post(f'/api/2/{self.event.slug}/item/', - {'cid': self.box.id, 'description': '1', + {'cid': self.box1.id, 'description': '1', 'dataImage': "data:text/plain;base64," + base64.b64encode(b"foo").decode( 'utf-8')}, content_type='application/json') self.assertEqual(response.status_code, 201) self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['description'], '1') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['id'], self.box.id) + self.assertEqual(response.json()['box'], 'BOX1') + self.assertEqual(response.json()['id'], self.box1.id) self.assertEqual(len(response.json()['file']), 64) self.assertEqual(len(Item.objects.all()), 1) self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.id, self.box.id) + self.assertEqual(Item.objects.all()[0].container.id, self.box1.id) self.assertEqual(len(File.objects.all()), 1) def test_update_item(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') + item = Item.objects.create(container=self.box1, event=self.event, description='1') response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.id}/', {'description': '2'}, - content_type='application/json') + content_type='application/json') self.assertEqual(response.status_code, 200) self.assertEqual(response.json()['id'], item.id) self.assertEqual(response.json()['description'], '2') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.id) + self.assertEqual(response.json()['box'], 'BOX1') + self.assertEqual(response.json()['cid'], self.box1.id) self.assertEqual(response.json()['file'], None) self.assertEqual(response.json()['returned'], False) self.assertEqual(response.json()['event'], self.event.slug) @@ -139,60 +192,62 @@ class ItemTestCase(TestCase): self.assertEqual(len(Item.objects.all()), 1) self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.id, self.box.id) + self.assertEqual(Item.objects.all()[0].container.id, self.box1.id) def test_update_item_with_file(self): import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') + item = Item.objects.create(container=self.box1, event=self.event, description='1') response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.id}/', - {'description': '2', - 'dataImage': "data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')}, - content_type='application/json') + {'description': '2', + 'dataImage': "data:text/plain;base64," + base64.b64encode(b"foo").decode( + 'utf-8')}, + content_type='application/json') self.assertEqual(response.status_code, 200) self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['description'], '2') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['id'], self.box.id) + self.assertEqual(response.json()['box'], 'BOX1') + self.assertEqual(response.json()['id'], self.box1.id) self.assertEqual(len(response.json()['file']), 64) self.assertEqual(len(Item.objects.all()), 1) self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.id, self.box.id) + self.assertEqual(Item.objects.all()[0].container.id, self.box1.id) self.assertEqual(len(File.objects.all()), 1) def test_delete_item(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') - Item.objects.create(container=self.box, event=self.event, description='2') + item = Item.objects.create(container=self.box1, event=self.event, description='1') + Item.objects.create(container=self.box1, event=self.event, description='2') self.assertEqual(len(Item.objects.all()), 2) response = self.client.delete(f'/api/2/{self.event.slug}/item/{item.id}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Item.objects.all()), 1) def test_delete_item2(self): - Item.objects.create(container=self.box, event=self.event, description='1') - item2 = Item.objects.create(container=self.box, event=self.event, description='2') + Item.objects.create(container=self.box1, event=self.event, description='1') + item2 = Item.objects.create(container=self.box1, event=self.event, description='2') self.assertEqual(len(Item.objects.all()), 2) response = self.client.delete(f'/api/2/{self.event.slug}/item/{item2.id}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Item.objects.all()), 1) - item3 = Item.objects.create(container=self.box, event=self.event, description='3') + item3 = Item.objects.create(container=self.box1, event=self.event, description='3') self.assertEqual(item3.id, 3) self.assertEqual(len(Item.objects.all()), 2) def test_item_count(self): - Item.objects.create(container=self.box, event=self.event, description='1') - Item.objects.create(container=self.box, event=self.event, description='2') + Item.objects.create(container=self.box1, event=self.event, description='1') + Item.objects.create(container=self.box1, event=self.event, description='2') response = self.client.get('/api/2/boxes/') self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 1) + self.assertEqual(len(response.json()), 2) self.assertEqual(response.json()[0]['itemCount'], 2) + self.assertEqual(response.json()[1]['itemCount'], 0) def test_item_nonexistent(self): response = self.client.get(f'/api/2/NOEVENT/item/') self.assertEqual(response.status_code, 404) def test_item_return(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') + item = Item.objects.create(container=self.box1, event=self.event, description='1') self.assertEqual(item.returned_at, None) response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) @@ -207,8 +262,8 @@ class ItemTestCase(TestCase): self.assertEqual(len(response.json()), 0) def test_item_show_not_returned(self): - item1 = Item.objects.create(container=self.box, event=self.event, description='1') - item2 = Item.objects.create(container=self.box, event=self.event, description='2') + item1 = Item.objects.create(container=self.box1, event=self.event, description='1') + item2 = Item.objects.create(container=self.box1, event=self.event, description='2') response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 2) @@ -225,15 +280,15 @@ class ItemSearchTestCase(TestCase): def setUp(self): super().setUp() self.event = Event.objects.create(slug='EVENT', name='Event') - self.box = Container.objects.create(name='BOX') + self.box1 = Container.objects.create(name='BOX1') self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') self.user.user_permissions.add(*Permission.objects.all()) self.token = AuthToken.objects.create(user=self.user) self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) - self.item1 = Item.objects.create(container=self.box, event=self.event, description='abc def') - self.item2 = Item.objects.create(container=self.box, event=self.event, description='def ghi') - self.item3 = Item.objects.create(container=self.box, event=self.event, description='jkl mno pqr') - self.item4 = Item.objects.create(container=self.box, event=self.event, description='stu vwx') + self.item1 = Item.objects.create(container=self.box1, event=self.event, description='abc def') + self.item2 = Item.objects.create(container=self.box1, event=self.event, description='def ghi') + self.item3 = Item.objects.create(container=self.box1, event=self.event, description='jkl mno pqr') + self.item4 = Item.objects.create(container=self.box1, event=self.event, description='stu vwx') def test_search(self): search_query = b64encode(b'abc').decode('utf-8') @@ -242,8 +297,8 @@ class ItemSearchTestCase(TestCase): self.assertEqual(1, len(response.json())) self.assertEqual(self.item1.id, response.json()[0]['id']) self.assertEqual('abc def', response.json()[0]['description']) - self.assertEqual('BOX', response.json()[0]['box']) - self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual('BOX1', response.json()[0]['box']) + self.assertEqual(self.box1.id, response.json()[0]['cid']) self.assertEqual(1, response.json()[0]['search_score']) def test_search2(self): @@ -253,13 +308,13 @@ class ItemSearchTestCase(TestCase): self.assertEqual(2, len(response.json())) self.assertEqual(self.item1.id, response.json()[0]['id']) self.assertEqual('abc def', response.json()[0]['description']) - self.assertEqual('BOX', response.json()[0]['box']) - self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual('BOX1', response.json()[0]['box']) + self.assertEqual(self.box1.id, response.json()[0]['cid']) self.assertEqual(1, response.json()[0]['search_score']) - self.assertEqual(self.box.id, response.json()[1]['cid']) + self.assertEqual(self.item2.id, response.json()[1]['id']) self.assertEqual('def ghi', response.json()[1]['description']) - self.assertEqual('BOX', response.json()[1]['box']) - self.assertEqual(self.box.id, response.json()[1]['cid']) + self.assertEqual('BOX1', response.json()[1]['box']) + self.assertEqual(self.box1.id, response.json()[1]['cid']) self.assertEqual(1, response.json()[0]['search_score']) def test_search3(self): @@ -269,8 +324,8 @@ class ItemSearchTestCase(TestCase): self.assertEqual(1, len(response.json())) self.assertEqual(self.item3.id, response.json()[0]['id']) self.assertEqual('jkl mno pqr', response.json()[0]['description']) - self.assertEqual('BOX', response.json()[0]['box']) - self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual('BOX1', response.json()[0]['box']) + self.assertEqual(self.box1.id, response.json()[0]['cid']) self.assertEqual(1, response.json()[0]['search_score']) def test_search4(self): @@ -280,12 +335,11 @@ class ItemSearchTestCase(TestCase): self.assertEqual(2, len(response.json())) self.assertEqual(self.item1.id, response.json()[0]['id']) self.assertEqual('abc def', response.json()[0]['description']) - self.assertEqual('BOX', response.json()[0]['box']) - self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual('BOX1', response.json()[0]['box']) + self.assertEqual(self.box1.id, response.json()[0]['cid']) self.assertEqual(2, response.json()[0]['search_score']) self.assertEqual(self.item2.id, response.json()[1]['id']) self.assertEqual('def ghi', response.json()[1]['description']) - self.assertEqual('BOX', response.json()[1]['box']) - self.assertEqual(self.box.id, response.json()[1]['cid']) + self.assertEqual('BOX1', response.json()[1]['box']) + self.assertEqual(self.box1.id, response.json()[1]['cid']) self.assertEqual(1, response.json()[1]['search_score']) - diff --git a/core/mail/migrations/0007_alter_eventaddress_address.py b/core/mail/migrations/0007_alter_eventaddress_address.py new file mode 100644 index 0000000..5d71449 --- /dev/null +++ b/core/mail/migrations/0007_alter_eventaddress_address.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2.7 on 2024-11-22 18:57 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('mail', '0006_email_raw_file'), + ] + + 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 36cd2b3..f8a3869 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 @@ -44,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): diff --git a/core/mail/protocol.py b/core/mail/protocol.py index c5aaa4a..02d87ab 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 @@ -70,7 +71,7 @@ def make_reply(reply_email, references=None, event=None): reply["From"] = reply_email.sender reply["To"] = reply_email.recipient reply["Subject"] = reply_email.subject - reply["Reply-To"] = f"{event}@{MAIL_DOMAIN}" + reply["Reply-To"] = f"{event.lower()}@{MAIL_DOMAIN}" if reply_email.in_reply_to: reply["In-Reply-To"] = reply_email.in_reply_to if reply_email.reference: @@ -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") @@ -221,16 +248,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) @@ -273,11 +291,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..a9492f5 --- /dev/null +++ b/core/notifications/api_v2.py @@ -0,0 +1,51 @@ +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, UserNotificationChannel +from rest_framework import serializers + +from notifications.templates import TEMPLATE_VARS +from authentication.serializers import UserSerializer + + +class MessageTemplateSerializer(serializers.ModelSerializer): + class Meta: + model = MessageTemplate + fields = '__all__' + + +class UserNotificationChannelSerializer(serializers.ModelSerializer): + user = UserSerializer() + + 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 +def get_template_vars(self): + return Response(TEMPLATE_VARS, status=200) + + +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/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/testdata.py b/core/testdata.py new file mode 100644 index 0000000..e69de29 diff --git a/core/tickets/api_v2.py b/core/tickets/api_v2.py index 415e045..4b01db0 100644 --- a/core/tickets/api_v2.py +++ b/core/tickets/api_v2.py @@ -21,7 +21,13 @@ from tickets.shared_serializers import RelationSerializer class IssueViewSet(viewsets.ModelViewSet): serializer_class = IssueSerializer - queryset = IssueThread.objects.all().prefetch_related('state_changes', 'comments', 'emails', 'emails__attachments', 'assignments', 'item_relation_changes', 'shipping_vouchers') + + def get_queryset(self): + queryset = IssueThread.objects.all() + serializer = self.get_serializer_class() + if hasattr(serializer, 'Meta') and hasattr(serializer.Meta, 'prefetch_related_fields'): + queryset = queryset.prefetch_related(*serializer.Meta.prefetch_related_fields) + return queryset class RelationViewSet(viewsets.ModelViewSet): @@ -165,11 +171,12 @@ router.register(r'tickets', IssueViewSet, basename='issues') router.register(r'matches', RelationViewSet, basename='matches') router.register(r'shipping_vouchers', ShippingVoucherViewSet, basename='shipping_vouchers') +# [-A-Za-z0-9+/]*={0,3} urlpatterns = ([ re_path(r'tickets/states/$', get_available_states, name='get_available_states'), re_path(r'^tickets/(?P\d+)/reply/$', reply, name='reply'), re_path(r'^tickets/(?P\d+)/comment/$', add_comment, name='add_comment'), re_path(r'^(?P[\w-]+)/tickets/manual/$', manual_ticket, name='manual_ticket'), re_path(r'^(?P[\w-]+)/tickets/(?P[-A-Za-z0-9+/]*={0,3})/$', search_issues, - name='search_issues'), + name='search_issues'), ] + router.urls) diff --git a/core/tickets/serializers.py b/core/tickets/serializers.py index b7d8b28..b382b38 100644 --- a/core/tickets/serializers.py +++ b/core/tickets/serializers.py @@ -47,6 +47,8 @@ class IssueSerializer(BasicIssueSerializer): model = IssueThread fields = ('id', 'timeline', 'name', 'state', 'assigned_to', 'last_activity', 'uuid', 'related_items', 'event') read_only_fields = ('id', 'timeline', 'last_activity', 'uuid', 'related_items') + prefetch_related_fields = ['state_changes', 'comments', 'emails', 'emails__attachments', 'assignments', + 'item_relation_changes', 'shipping_vouchers'] def to_internal_value(self, data): ret = super().to_internal_value(data) @@ -63,12 +65,14 @@ class IssueSerializer(BasicIssueSerializer): @staticmethod def get_last_activity(self): try: - last_state_change = max([t.timestamp for t in self.state_changes.all()]) if self.state_changes.exists() else None + last_state_change = max( + [t.timestamp for t in self.state_changes.all()]) if self.state_changes.exists() else None last_comment = max([t.timestamp for t in self.comments.all()]) if self.comments.exists() else None last_mail = max([t.timestamp for t in self.emails.all()]) if self.emails.exists() else None last_assignment = max([t.timestamp for t in self.assignments.all()]) if self.assignments.exists() else None - last_relation = max([t.timestamp for t in self.item_relation_changes.all()]) if self.item_relation_changes.exists() else None + last_relation = max([t.timestamp for t in + self.item_relation_changes.all()]) if self.item_relation_changes.exists() else None args = [x for x in [last_state_change, last_comment, last_mail, last_assignment, last_relation] if x is not None] return max(args) @@ -129,7 +133,6 @@ class IssueSerializer(BasicIssueSerializer): return sorted(timeline, key=lambda x: x['timestamp']) - class SearchResultSerializer(serializers.Serializer): search_score = serializers.IntegerField() item = IssueSerializer() diff --git a/core/tickets/tests/v2/test_tickets.py b/core/tickets/tests/v2/test_tickets.py index 9720625..8f72392 100644 --- a/core/tickets/tests/v2/test_tickets.py +++ b/core/tickets/tests/v2/test_tickets.py @@ -117,6 +117,7 @@ class IssueApiTest(TestCase): self.assertEqual(response.json()[0]['timeline'][5]['item']['description'], "foo") self.assertEqual(response.json()[0]['timeline'][5]['item']['event'], "evt") self.assertEqual(response.json()[0]['timeline'][5]['item']['box'], "box1") + self.assertEqual(len(response.json()[0]['related_items']), 1) self.assertEqual(response.json()[0]['related_items'][0]['description'], "foo") self.assertEqual(response.json()[0]['related_items'][0]['event'], "evt") self.assertEqual(response.json()[0]['related_items'][0]['box'], "box1") 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/deploy/ansible/playbooks/templates/nginx.conf.j2 b/deploy/ansible/playbooks/templates/nginx.conf.j2 index 3533f37..1bde29a 100644 --- a/deploy/ansible/playbooks/templates/nginx.conf.j2 +++ b/deploy/ansible/playbooks/templates/nginx.conf.j2 @@ -75,6 +75,14 @@ server { allow 127.0.0.1; allow ::1; deny all; + proxy_set_header Host $http_host; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection $connection_upgrade; + proxy_redirect off; + proxy_buffering off; + proxy_pass http://c3lf-sys3; } listen 443 ssl http2; # managed by Certbot diff --git a/deploy/dev/docker-compose.yml b/deploy/dev/docker-compose.yml index dff5ab3..64a15af 100644 --- a/deploy/dev/docker-compose.yml +++ b/deploy/dev/docker-compose.yml @@ -3,7 +3,7 @@ services: build: context: ../../core dockerfile: ../deploy/dev/Dockerfile.backend - command: bash -c 'python manage.py migrate && python manage.py runserver 0.0.0.0:8000' + command: bash -c 'python manage.py runserver 0.0.0.0:8000' environment: - HTTP_HOST=core - DB_HOST=db @@ -13,6 +13,7 @@ services: - DB_PASSWORD=system3 volumes: - ../../core:/code + - ./testdata.py:/code/testdata.py ports: - "8000:8000" depends_on: diff --git a/deploy/dev/testdata.py b/deploy/dev/testdata.py new file mode 100644 index 0000000..767f644 --- /dev/null +++ b/deploy/dev/testdata.py @@ -0,0 +1,87 @@ +import os + + +def setup(): + from authentication.models import ExtendedUser, EventPermission + from inventory.models import Event + from django.contrib.auth.models import Permission, Group + permissions = ['add_item', 'view_item', 'view_file', 'delete_item', 'change_item'] + if not ExtendedUser.objects.filter(username='admin').exists(): + admin = ExtendedUser.objects.create_superuser('admin', 'admin@example.com', 'admin') + admin.set_password('admin') + admin.user_permissions.add(*Permission.objects.all()) + admin.save() + + if not ExtendedUser.objects.filter(username='testuser').exists(): + testuser = ExtendedUser.objects.create_user('testuser', 'testuser@example.com', 'testuser') + testuser.set_password('testuser') + testuser.user_permissions.add(*Permission.objects.all()) + testuser.save() + + team = Group.objects.get(name='Team') + team.permissions.add( + *Permission.objects.all() + ) + + if not ExtendedUser.objects.filter(username='testuser2').exists(): + testuser2 = ExtendedUser.objects.create_user('testuser2', 'testuser2@example.com', 'testuser2') + testuser2.set_password('testuser2') + testuser2.groups.add(team) + testuser2.save() + + # hbug = ExtendedUser.objects.get(username='hbug') + + if not Event.objects.filter(slug='TEST1').exists(): + event1 = Event.objects.create(name='first test event', slug='TEST1', + start='2023-12-18 00:00:00.000000', end='2023-12-27 00:00:00.000000', + pre_start='2023-12-31 00:00:00.000000', post_end='2024-01-04 00:00:00.000000') + + if not Event.objects.filter(slug='TEST2').exists(): + event2 = Event.objects.create(name='second test event', slug='TEST2', + start='2024-12-18 00:00:00.000000', end='2024-12-27 00:00:00.000000', + pre_start='2024-12-31 00:00:00.000000', post_end='2025-01-04 00:00:00.000000') + + # for permission in permissions: + # EventPermission.objects.create(event=event_37c3, user=hbug, + # permission=Permission.objects.get(codename=permission)) + +# from tickets.models import IssueThread +# +# from mail.models import Email +# +# issue_thread = IssueThread.objects.create( +# name="test", +# event=Event.objects.get(slug='TEST1') +# ) +# mail1 = Email.objects.create( +# subject='test subject', +# body='test', +# sender='test1@test', +# recipient='test2@test', +# issue_thread=issue_thread, +# ) +# mail1_reply = Email.objects.create( +# subject='Message received', +# body='Thank you for your message.', +# sender='test2@test', +# recipient='test1@test', +# in_reply_to=mail1.reference, +# issue_thread=issue_thread, +# ) + + +def main(): + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings") + import django + + django.setup() + + from django.core.management import call_command + call_command('migrate') + + setup() + print('testdata initialised') + + +if __name__ == '__main__': + main() 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/App.vue b/web/src/App.vue index bd4956f..d2c9f7d 100644 --- a/web/src/App.vue +++ b/web/src/App.vue @@ -1,5 +1,6 @@ @@ -78,12 +56,20 @@ import TimelineAssignment from "@/components/TimelineAssignment.vue"; import TimelineRelatedItem from "@/components/TimelineRelatedItem.vue"; import TimelineShippingVoucher from "@/components/TimelineShippingVoucher.vue"; import AsyncButton from "@/components/inputs/AsyncButton.vue"; +import TimelinePlacement from "@/components/TimelinePlacement.vue"; +import TimelineRelatedTicket from "@/components/TimelineRelatedTicket.vue"; export default { name: 'Timeline', components: { - TimelineShippingVoucher, AsyncButton, - TimelineRelatedItem, TimelineAssignment, TimelineStateChange, TimelineComment, TimelineMail + TimelineRelatedTicket, + TimelinePlacement, + TimelineShippingVoucher, + TimelineRelatedItem, + TimelineAssignment, + TimelineStateChange, + TimelineComment, + TimelineMail }, props: { timeline: { @@ -91,33 +77,13 @@ export default { default: () => [] } }, - emits: ['sendMail', 'addComment'], - data: () => ({ - newMail: "", - newComment: "" - }), computed: { - ...mapGetters(['stateInfo']), - newestMailSubject() { - const mail = this.timeline.filter(item => item.type === 'mail').pop(); - return mail ? mail.subject : ""; - }, + ...mapGetters(['stateInfo']) }, - methods: { - ...mapActions(['sendMail', 'postComment']), - sendMailAndClear: async function () { - await this.sendMail(this.newMail); - this.newMail = ""; - }, - addCommentAndClear: async function () { - await this.postComment(this.newComment); - this.newComment = ""; - } - } }; - \ No newline at end of file diff --git a/web/src/components/TimelineRelatedItem.vue b/web/src/components/TimelineRelatedItem.vue index c17a3a8..77f50ce 100644 --- a/web/src/components/TimelineRelatedItem.vue +++ b/web/src/components/TimelineRelatedItem.vue @@ -1,12 +1,15 @@ + + \ No newline at end of file diff --git a/web/src/components/inputs/FormatedText.vue b/web/src/components/inputs/FormatedText.vue new file mode 100644 index 0000000..114fbf3 --- /dev/null +++ b/web/src/components/inputs/FormatedText.vue @@ -0,0 +1,112 @@ + + + \ No newline at end of file diff --git a/web/src/components/inputs/InputCombo.vue b/web/src/components/inputs/InputCombo.vue index 50b5459..ed08c8d 100644 --- a/web/src/components/inputs/InputCombo.vue +++ b/web/src/components/inputs/InputCombo.vue @@ -1,6 +1,4 @@ + + diff --git a/web/src/views/Items.vue b/web/src/views/Items.vue index 2f9e5ed..21b11d1 100644 --- a/web/src/views/Items.vue +++ b/web/src/views/Items.vue @@ -1,26 +1,13 @@