diff --git a/.forgejo/issue_template/bug.yml b/.forgejo/issue_template/bug.yml new file mode 100644 index 0000000..8b227a0 --- /dev/null +++ b/.forgejo/issue_template/bug.yml @@ -0,0 +1,35 @@ +name: Bug Report +about: File a bug report +labels: + - Kind/Bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox (Windows) + - Firefox (MacOS) + - Firefox (Linux) + - Firefox (Android) + - Firefox (iOS) + - Chrome (Windows) + - Chrome (MacOS) + - Chrome (Linux) + - Chrome (Android) + - Chrome (iOS) + - Safari + - Microsoft Edge \ No newline at end of file diff --git a/.forgejo/issue_template/feature.yml b/.forgejo/issue_template/feature.yml new file mode 100644 index 0000000..c8cf794 --- /dev/null +++ b/.forgejo/issue_template/feature.yml @@ -0,0 +1,27 @@ +name: 'New Feature' +about: 'This template is for new features' +labels: + - Kind/Feature +body: + - type: markdown + attributes: + value: | + Before creating a Feature Ticket, please check for duplicates. + - type: markdown + attributes: + value: | + ### Implementation Checklist + - [ ] concept + - [ ] frontend + - [ ] backend + - [ ] unittests + - [ ] tested on staging + visible: [ content ] + - type: textarea + id: description + attributes: + label: 'Feature Description' + description: 'Explain the the feature.' + placeholder: Description + validations: + required: true \ No newline at end of file diff --git a/.forgejo/workflows/testing.yml b/.forgejo/workflows/deploy_staging.yml similarity index 100% rename from .forgejo/workflows/testing.yml rename to .forgejo/workflows/deploy_staging.yml diff --git a/.forgejo/workflows/pull_request.yml b/.forgejo/workflows/test.yml similarity index 98% rename from .forgejo/workflows/pull_request.yml rename to .forgejo/workflows/test.yml index 1171616..480e590 100644 --- a/.forgejo/workflows/pull_request.yml +++ b/.forgejo/workflows/test.yml @@ -1,5 +1,6 @@ on: pull_request: + push: jobs: test: 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/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/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/core/settings.py b/core/core/settings.py index 2d4a818..94f15eb 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -15,9 +15,11 @@ 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 @@ -32,7 +34,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 +49,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 +69,7 @@ INSTALLED_APPS = [ 'drf_yasg', 'channels', 'authentication', + 'notifications', 'files', 'tickets', 'inventory', @@ -142,7 +151,8 @@ else: 'USER': os.getenv('DB_USER', 'system3'), 'PASSWORD': os.getenv('DB_PASSWORD', 'system3'), 'OPTIONS': { - 'charset': 'utf8mb4' + 'charset': 'utf8mb4', + 'init_command': "SET sql_mode='STRICT_TRANS_TABLES'" } } } diff --git a/core/core/urls.py b/core/core/urls.py index df6e0d0..d224e52 100644 --- a/core/core/urls.py +++ b/core/core/urls.py @@ -21,9 +21,6 @@ from .version import get_info urlpatterns = [ path('djangoadmin/', admin.site.urls), - path('api/1/', include('inventory.api_v1')), - path('api/1/', include('files.api_v1')), - path('api/1/', include('files.media_v1')), path('api/2/', include('inventory.api_v2')), path('api/2/', include('files.api_v2')), path('media/2/', include('files.media_v2')), @@ -31,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/core/wsgi.py b/core/core/wsgi.py deleted file mode 100644 index f44964d..0000000 --- a/core/core/wsgi.py +++ /dev/null @@ -1,16 +0,0 @@ -""" -WSGI config for core project. - -It exposes the WSGI callable as a module-level variable named ``application``. - -For more information on this file, see -https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/ -""" - -import os - -from django.core.wsgi import get_wsgi_application - -os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'core.settings') - -application = get_wsgi_application() diff --git a/core/files/api_v1.py b/core/files/api_v1.py deleted file mode 100644 index ce9730f..0000000 --- a/core/files/api_v1.py +++ /dev/null @@ -1,27 +0,0 @@ -from rest_framework import serializers, viewsets, routers - -from files.models import File - - -class FileSerializer(serializers.ModelSerializer): - data = serializers.CharField(max_length=1000000, write_only=True) - - class Meta: - model = File - fields = ['hash', 'data'] - read_only_fields = ['hash'] - - -class FileViewSet(viewsets.ModelViewSet): - serializer_class = FileSerializer - queryset = File.objects.all() - lookup_field = 'hash' - permission_classes = [] - authentication_classes = [] - - -router = routers.SimpleRouter(trailing_slash=False) -router.register(r'files', FileViewSet, basename='files') -router.register(r'file', FileViewSet, basename='files') - -urlpatterns = router.urls diff --git a/core/files/media_v1.py b/core/files/media_v1.py deleted file mode 100644 index d80ce64..0000000 --- a/core/files/media_v1.py +++ /dev/null @@ -1,65 +0,0 @@ -import os -from django.http import HttpResponse -from django.urls import path -from drf_yasg.utils import swagger_auto_schema -from rest_framework import status -from rest_framework.decorators import api_view, permission_classes, authentication_classes -from rest_framework.response import Response - -from core.settings import MEDIA_ROOT -from files.models import File - - -@swagger_auto_schema(method='GET', auto_schema=None) -@api_view(['GET']) -@permission_classes([]) -@authentication_classes([]) -def media_urls(request, hash): - try: - file = File.objects.get(hash=hash) - hash_path = file.file - return HttpResponse(status=status.HTTP_200_OK, - content_type=file.mime_type, - headers={ - 'X-Accel-Redirect': f'/redirect_media/{hash_path}', - 'Access-Control-Allow-Origin': '*', - }) # TODO Expires and Cache-Control - - except File.DoesNotExist: - return Response(status=status.HTTP_404_NOT_FOUND) - - -@swagger_auto_schema(method='GET', auto_schema=None) -@api_view(['GET']) -@permission_classes([]) -@authentication_classes([]) -def thumbnail_urls(request, hash): - size = 200 - try: - file = File.objects.get(hash=hash) - hash_path = file.file - if not os.path.exists(MEDIA_ROOT + f'/thumbnails/{size}/{hash_path}'): - from PIL import Image - image = Image.open(file.file) - image.thumbnail((size, size)) - rgb_image = image.convert('RGB') - thumb_dir = os.path.dirname(MEDIA_ROOT + f'/thumbnails/{size}/{hash_path}') - if not os.path.exists(thumb_dir): - os.makedirs(thumb_dir) - rgb_image.save(MEDIA_ROOT + f'/thumbnails/{size}/{hash_path}', 'jpeg', quality=90) - - return HttpResponse(status=status.HTTP_200_OK, - content_type="image/jpeg", - headers={ - 'X-Accel-Redirect': f'/redirect_thumbnail/{size}/{hash_path}', - 'Access-Control-Allow-Origin': '*', - }) # TODO Expires and Cache-Control - - except File.DoesNotExist: - return Response(status=status.HTTP_404_NOT_FOUND) - - -urlpatterns = [ - path('thumbs/', thumbnail_urls), - path('images/', media_urls), -] diff --git a/core/files/tests/v1/test_files.py b/core/files/tests/v1/test_files.py deleted file mode 100644 index ce59b2c..0000000 --- a/core/files/tests/v1/test_files.py +++ /dev/null @@ -1,68 +0,0 @@ -from django.test import TestCase, Client -from django.core.files.base import ContentFile - -from files.models import File -from inventory.models import Event, Container, Item - -client = Client() - - -class FileTestCase(TestCase): - - def setUp(self): - super().setUp() - self.event = Event.objects.create(slug='EVENT', name='Event') - self.box = Container.objects.create(name='BOX') - - def test_create_file_raw(self): - from hashlib import sha256 - content = b"foo" - chash = sha256(content).hexdigest() - item = Item.objects.create(container=self.box, event=self.event, description='1') - file = File.objects.create(file=ContentFile(b"foo"), mime_type='text/plain', hash=chash, item=item) - file.save() - self.assertEqual(1, len(File.objects.all())) - self.assertEqual(content, File.objects.all()[0].file.read()) - self.assertEqual(chash, File.objects.all()[0].hash) - - def test_list_files(self): - import base64 - - item = File.objects.create(data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - response = client.get('/api/1/files') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()[0]['hash'], item.hash) - self.assertEqual(len(response.json()[0]['hash']), 64) - self.assertEqual(len(File.objects.all()), 1) - self.assertEqual(File.objects.all()[0].file.read(), b"foo") - - def test_one_file(self): - import base64 - item = File.objects.create(data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - response = client.get(f'/api/1/file/{item.hash}') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['hash'], item.hash) - self.assertEqual(len(response.json()['hash']), 64) - self.assertEqual(len(File.objects.all()), 1) - self.assertEqual(File.objects.all()[0].file.read(), b"foo") - - def test_create_file(self): - import base64 - Item.objects.create(container=self.box, event=self.event, description='1') - item = Item.objects.create(container=self.box, event=self.event, description='2') - response = client.post('/api/1/file', - {'data': "data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')}, - content_type='application/json') - self.assertEqual(response.status_code, 201) - self.assertEqual(len(response.json()['hash']), 64) - self.assertEqual(len(File.objects.all()), 1) - self.assertEqual(File.objects.all()[0].file.read(), b"foo") - - def test_delete_file(self): - import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') - File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - file = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"bar").decode('utf-8')) - self.assertEqual(len(File.objects.all()), 2) - response = client.delete(f'/api/1/file/{file.hash}') - self.assertEqual(response.status_code, 204) diff --git a/core/inventory/api_v1.py b/core/inventory/api_v1.py deleted file mode 100644 index e9e670d..0000000 --- a/core/inventory/api_v1.py +++ /dev/null @@ -1,150 +0,0 @@ -from django.utils import timezone -from django.urls import re_path -from rest_framework import routers, viewsets, serializers -from rest_framework.decorators import api_view, permission_classes, authentication_classes -from rest_framework.response import Response - -from files.models import File -from inventory.models import Event, Container, Item -from inventory.serializers import EventSerializer, ContainerSerializer - - -class EventViewSet(viewsets.ModelViewSet): - serializer_class = EventSerializer - queryset = Event.objects.all() - permission_classes = [] - authentication_classes = [] - - -class ContainerViewSet(viewsets.ModelViewSet): - serializer_class = ContainerSerializer - queryset = Container.objects.all() - permission_classes = [] - authentication_classes = [] - - -class ItemSerializer(serializers.ModelSerializer): - dataImage = serializers.CharField(write_only=True, required=False) - cid = serializers.SerializerMethodField() - box = serializers.SerializerMethodField() - file = serializers.SerializerMethodField() - - class Meta: - model = Item - fields = ['cid', 'box', 'uid', 'description', 'file', 'dataImage'] - read_only_fields = ['uid'] - - def get_cid(self, instance): - return instance.container.cid - - def get_box(self, instance): - return instance.container.name - - def get_file(self, instance): - if len(instance.files.all()) > 0: - return instance.files.all().order_by('-created_at')[0].hash - return None - - def to_internal_value(self, data): - if 'cid' in data: - container = Container.objects.get(cid=data['cid']) - internal = super().to_internal_value(data) - internal['container'] = container - return internal - return super().to_internal_value(data) - - def validate(self, attrs): - return super().validate(attrs) - - def create(self, validated_data): - if 'dataImage' in validated_data: - file = File.objects.create(data=validated_data['dataImage']) - validated_data.pop('dataImage') - item = Item.objects.create(**validated_data) - item.files.set([file]) - return item - return Item.objects.create(**validated_data) - - def update(self, instance, validated_data): - if 'returned' in validated_data: - if validated_data['returned']: - validated_data['returned_at'] = timezone.now() - validated_data.pop('returned') - if 'dataImage' in validated_data: - file = File.objects.create(data=validated_data['dataImage']) - validated_data.pop('dataImage') - instance.files.add(file) - return super().update(instance, validated_data) - - -@api_view(['GET']) -@permission_classes([]) -@authentication_classes([]) -def search_items(request, event_slug, query): - try: - event = Event.objects.get(slug=event_slug) - query_tokens = query.split(' ') - q = Item.objects.filter(event=event) - for token in query_tokens: - if token: - q = q.filter(description__icontains=token) - return Response(ItemSerializer(q, many=True).data) - except Event.DoesNotExist: - return Response(status=404) - - -@api_view(['GET', 'POST']) -@permission_classes([]) -@authentication_classes([]) -def item(request, event_slug): - try: - event = Event.objects.get(slug=event_slug) - if request.method == 'GET': - return Response(ItemSerializer(Item.objects.filter(event=event), many=True).data) - elif request.method == 'POST': - validated_data = ItemSerializer(data=request.data) - if validated_data.is_valid(): - validated_data.save(event=event) - return Response(validated_data.data, status=201) - except Event.DoesNotExist: - return Response(status=404) - - -@api_view(['GET', 'PUT', 'DELETE']) -@permission_classes([]) -@authentication_classes([]) -def item_by_id(request, event_slug, id): - try: - event = Event.objects.get(slug=event_slug) - item = Item.objects.get(event=event, uid=id) - if request.method == 'GET': - return Response(ItemSerializer(item).data) - elif request.method == 'PUT': - validated_data = ItemSerializer(item, data=request.data) - if validated_data.is_valid(): - validated_data.save() - return Response(validated_data.data) - elif request.method == 'DELETE': - item.delete() - return Response(status=204) - except Item.DoesNotExist: - return Response(status=404) - except Event.DoesNotExist: - return Response(status=404) - - -urlpatterns = [ - re_path('events/?$', EventViewSet.as_view({'get': 'list', 'post': 'create'})), - re_path('events/(?P[0-9]+)/?$', - EventViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})), - re_path('boxes/?$', ContainerViewSet.as_view({'get': 'list', 'post': 'create'})), - re_path('boxes/(?P[0-9]+)/?$', - ContainerViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})), - re_path('box/?$', ContainerViewSet.as_view({'get': 'list', 'post': 'create'})), - re_path('box/(?P[0-9]+)/?$', - ContainerViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})), - re_path('(?P[a-zA-Z0-9]+)/items/?$', item), - re_path('(?P[a-zA-Z0-9]+)/items/(?P[^/]+)/?$', search_items), - re_path('(?P[a-zA-Z0-9]+)/item/?$', item), - re_path('(?P[a-zA-Z0-9]+)/item/(?P[0-9]+)/?$', item_by_id), -] diff --git a/core/inventory/api_v2.py b/core/inventory/api_v2.py index 0a34140..f2de844 100644 --- a/core/inventory/api_v2.py +++ b/core/inventory/api_v2.py @@ -1,4 +1,4 @@ -from django.urls import path +from django.urls import re_path from django.contrib.auth.decorators import permission_required from rest_framework import routers, viewsets from rest_framework.decorators import api_view, permission_classes @@ -6,7 +6,9 @@ from rest_framework.response import Response from rest_framework.permissions import IsAuthenticated from inventory.models import Event, Container, Item -from inventory.serializers import EventSerializer, ContainerSerializer, ItemSerializer +from inventory.serializers import EventSerializer, ContainerSerializer, ItemSerializer, SearchResultSerializer + +from base64 import b64decode class EventViewSet(viewsets.ModelViewSet): @@ -20,18 +22,26 @@ class ContainerViewSet(viewsets.ModelViewSet): queryset = Container.objects.all() +def filter_items(items, query): + query_tokens = query.split(' ') + for item in items: + value = 0 + for token in query_tokens: + if token in item.description: + value += 1 + if value > 0: + yield {'search_score': value, 'item': item} + + @api_view(['GET']) @permission_classes([IsAuthenticated]) -@permission_required('view_item', raise_exception=True) def search_items(request, event_slug, query): try: event = Event.objects.get(slug=event_slug) - query_tokens = query.split(' ') - q = Item.objects.filter(event=event) - for token in query_tokens: - if token: - q = q.filter(description__icontains=token) - return Response(ItemSerializer(q, many=True).data) + if not request.user.has_event_perm(event, 'view_item'): + return Response(status=403) + items = filter_items(Item.objects.filter(event=event), b64decode(query).decode('utf-8')) + return Response(SearchResultSerializer(items, many=True).data) except Event.DoesNotExist: return Response(status=404) @@ -40,7 +50,9 @@ def search_items(request, event_slug, query): @permission_classes([IsAuthenticated]) def item(request, event_slug): try: - event = Event.objects.get(slug=event_slug) + event = None + if event_slug != 'none': + event = Event.objects.get(slug=event_slug) if request.method == 'GET': if not request.user.has_event_perm(event, 'view_item'): return Response(status=403) @@ -52,8 +64,11 @@ def item(request, event_slug): if validated_data.is_valid(): validated_data.save(event=event) return Response(validated_data.data, status=201) + return Response(status=400) except Event.DoesNotExist: return Response(status=404) + except KeyError: + return Response(status=400) @api_view(['GET', 'PUT', 'DELETE', 'PATCH']) @@ -61,7 +76,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, uid=id) + item = Item.objects.get(event=event, id=id) if request.method == 'GET': if not request.user.has_event_perm(event, 'view_item'): return Response(status=403) @@ -99,8 +114,12 @@ router.register(r'boxes', ContainerViewSet, basename='boxes') router.register(r'box', ContainerViewSet, basename='boxes') urlpatterns = router.urls + [ - path('/items/', item), - path('/items//', search_items), - path('/item/', item), - path('/item//', item_by_id), + # path('/items/', item), + # path('/items//', search_items), + # path('/item/', item), + # path('/item//', item_by_id), + 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+)/$', item_by_id, name='item_by_id'), ] diff --git a/core/inventory/migrations/0005_rename_cid_container_id_rename_iid_item_id_and_more.py b/core/inventory/migrations/0005_rename_cid_container_id_rename_iid_item_id_and_more.py new file mode 100644 index 0000000..81d27b5 --- /dev/null +++ b/core/inventory/migrations/0005_rename_cid_container_id_rename_iid_item_id_and_more.py @@ -0,0 +1,46 @@ +# Generated by Django 4.2.7 on 2024-11-19 22:02 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('inventory', '0004_alter_event_created_at_alter_item_created_at'), + ] + + operations = [ + migrations.RenameField( + model_name='container', + old_name='cid', + new_name='id', + ), + migrations.RenameField( + model_name='item', + old_name='iid', + new_name='id', + ), + migrations.RenameField( + model_name='item', + old_name='uid', + new_name='uid_deprecated', + ), + migrations.AlterUniqueTogether( + name='item', + unique_together={('uid_deprecated', 'event')}, + ), + migrations.CreateModel( + name='ItemPlacement', + fields=[ + ('id', models.AutoField(primary_key=True, serialize=False)), + ('timestamp', models.DateTimeField(auto_now_add=True)), + ('container', models.ForeignKey(db_column='cid', on_delete=django.db.models.deletion.CASCADE, related_name='item_history', to='inventory.container')), + ('item', models.ForeignKey(db_column='iid', on_delete=django.db.models.deletion.CASCADE, related_name='container_history', to='inventory.item')), + ], + ), + migrations.RemoveField( + model_name='item', + name='container', + ), + ] diff --git a/core/inventory/models.py b/core/inventory/models.py index 8b3d018..2718639 100644 --- a/core/inventory/models.py +++ b/core/inventory/models.py @@ -1,3 +1,5 @@ +from itertools import groupby + from django.core.files.base import ContentFile from django.db import models, IntegrityError from django_softdelete.models import SoftDeleteModel, SoftDeleteManager @@ -6,47 +8,79 @@ from django_softdelete.models import SoftDeleteModel, SoftDeleteManager class ItemManager(SoftDeleteManager): def create(self, **kwargs): - if 'uid' in kwargs: - raise ValueError('uid must not be set manually') - uid = Item.all_objects.filter(event=kwargs['event']).count() + 1 - kwargs['uid'] = uid - return super().create(**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 + item = super().create(**kwargs) + item.container = container + return item def get_queryset(self): return super().get_queryset().filter(returned_at__isnull=True) class Item(SoftDeleteModel): - iid = models.AutoField(primary_key=True) - uid = models.IntegerField() + id = models.AutoField(primary_key=True) + uid_deprecated = models.IntegerField() description = models.TextField() event = models.ForeignKey('Event', models.CASCADE, db_column='eid') - container = models.ForeignKey('Container', models.CASCADE, db_column='cid') + # container = models.ForeignKey('Container', models.CASCADE, db_column='cid') 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) + #related_issues = models.ManyToManyField('IssueThread', through='ItemRelation') + + @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) objects = ItemManager() all_objects = models.Manager() class Meta: - unique_together = (('uid', 'event'),) + unique_together = (('uid_deprecated', 'event'),) permissions = [ ('match_item', 'Can match item') ] def __str__(self): - return '[' + str(self.uid) + ']' + self.description + return '[' + str(self.id) + ']' + self.description class Container(SoftDeleteModel): - cid = models.AutoField(primary_key=True) + id = models.AutoField(primary_key=True) name = models.CharField(max_length=255) 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.cid) + ']' + self.name + return '[' + str(self.id) + ']' + self.name + + +class ItemPlacement(models.Model): + id = models.AutoField(primary_key=True) + item = models.ForeignKey('Item', models.CASCADE, db_column='iid', related_name='container_history') + container = models.ForeignKey('Container', models.CASCADE, db_column='cid', related_name='item_history') + timestamp = models.DateTimeField(auto_now_add=True) class Event(models.Model): diff --git a/core/inventory/serializers.py b/core/inventory/serializers.py index 5a26623..09d9caa 100644 --- a/core/inventory/serializers.py +++ b/core/inventory/serializers.py @@ -1,19 +1,31 @@ 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 @@ -21,16 +33,27 @@ class EventSerializer(serializers.ModelSerializer): 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() class Meta: model = Container - fields = ['cid', 'name', 'itemCount'] - read_only_fields = ['cid', 'itemCount'] + fields = ['id', 'name', 'itemCount'] + read_only_fields = ['id', 'itemCount'] def get_itemCount(self, instance): - return Item.objects.filter(container=instance.cid).count() + return len(instance.items) class ItemSerializer(serializers.ModelSerializer): @@ -39,17 +62,19 @@ class ItemSerializer(serializers.ModelSerializer): box = serializers.SerializerMethodField() file = serializers.SerializerMethodField() returned = serializers.SerializerMethodField(required=False) + event = serializers.SlugRelatedField(slug_field='slug', queryset=Event.objects.all(), + allow_null=True, required=False) class Meta: model = Item - fields = ['cid', 'box', 'uid', 'description', 'file', 'dataImage', 'returned'] - read_only_fields = ['uid'] + fields = ['cid', 'box', 'id', 'description', 'file', 'dataImage', 'returned', 'event'] + read_only_fields = ['id'] def get_cid(self, instance): - return instance.container.cid + return instance.container.id if instance.container else None def get_box(self, instance): - return instance.container.name + return instance.container.name if instance.container else None def get_file(self, instance): if len(instance.files.all()) > 0: @@ -63,7 +88,7 @@ class ItemSerializer(serializers.ModelSerializer): container = None returned = False if 'cid' in data: - container = Container.objects.get(cid=data['cid']) + container = Container.objects.get(id=data['cid']) if 'returned' in data: returned = data['returned'] internal = super().to_internal_value(data) @@ -95,3 +120,14 @@ class ItemSerializer(serializers.ModelSerializer): validated_data.pop('dataImage') instance.files.add(file) return super().update(instance, validated_data) + + +class SearchResultSerializer(serializers.Serializer): + search_score = serializers.IntegerField() + item = ItemSerializer() + + def to_representation(self, instance): + return {**ItemSerializer(instance['item']).data, 'search_score': instance['search_score']} + + class Meta: + model = Item diff --git a/core/inventory/tests/v1/test_api.py b/core/inventory/tests/v1/test_api.py deleted file mode 100644 index db1df0a..0000000 --- a/core/inventory/tests/v1/test_api.py +++ /dev/null @@ -1,34 +0,0 @@ -from django.test import TestCase, Client - -client = Client() - - -class ApiTest(TestCase): - - def test_root(self): - from core.settings import SYSTEM3_VERSION - response = client.get('/api/') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()["framework_version"], SYSTEM3_VERSION) - - def test_events(self): - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_containers(self): - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_files(self): - response = client.get('/api/1/files') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_items(self): - from inventory.models import Event - Event.objects.create(slug='TEST1', name='Event') - response = client.get('/api/1/TEST1/items') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) diff --git a/core/inventory/tests/v1/test_containers.py b/core/inventory/tests/v1/test_containers.py deleted file mode 100644 index 78b82c1..0000000 --- a/core/inventory/tests/v1/test_containers.py +++ /dev/null @@ -1,59 +0,0 @@ -from django.test import TestCase, Client -from inventory.models import Container - -client = Client() - - -class ContainerTestCase(TestCase): - - def test_empty(self): - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_members(self): - Container.objects.create(name='BOX') - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['cid'], 1) - self.assertEqual(response.json()[0]['name'], 'BOX') - self.assertEqual(response.json()[0]['itemCount'], 0) - - def test_multi_members(self): - Container.objects.create(name='BOX 1') - Container.objects.create(name='BOX 2') - Container.objects.create(name='BOX 3') - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 3) - - def test_create_container(self): - response = client.post('/api/1/box', {'name': 'BOX'}) - self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['cid'], 1) - self.assertEqual(response.json()['name'], 'BOX') - self.assertEqual(response.json()['itemCount'], 0) - self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) - self.assertEqual(Container.objects.all()[0].name, 'BOX') - - def test_update_container(self): - from rest_framework.test import APIClient - box = Container.objects.create(name='BOX 1') - response = APIClient().put(f'/api/1/box/{box.cid}', {'name': 'BOX 2'}) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['cid'], 1) - self.assertEqual(response.json()['name'], 'BOX 2') - self.assertEqual(response.json()['itemCount'], 0) - self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) - self.assertEqual(Container.objects.all()[0].name, 'BOX 2') - - def test_delete_container(self): - box = Container.objects.create(name='BOX 1') - Container.objects.create(name='BOX 2') - self.assertEqual(len(Container.objects.all()), 2) - response = client.delete(f'/api/1/box/{box.cid}') - self.assertEqual(response.status_code, 204) - self.assertEqual(len(Container.objects.all()), 1) diff --git a/core/inventory/tests/v1/test_events.py b/core/inventory/tests/v1/test_events.py deleted file mode 100644 index a861f12..0000000 --- a/core/inventory/tests/v1/test_events.py +++ /dev/null @@ -1,56 +0,0 @@ -from django.test import TestCase, Client -from inventory.models import Event - -client = Client() - - -class EventTestCase(TestCase): - - def test_empty(self): - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_members(self): - Event.objects.create(slug='EVENT', name='Event') - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['slug'], 'EVENT') - self.assertEqual(response.json()[0]['name'], 'Event') - - def test_multi_members(self): - Event.objects.create(slug='EVENT1', name='Event 1') - Event.objects.create(slug='EVENT2', name='Event 2') - Event.objects.create(slug='EVENT3', name='Event 3') - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 3) - - def test_create_event(self): - response = client.post('/api/1/events', {'slug': 'EVENT', 'name': 'Event'}) - self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['slug'], 'EVENT') - self.assertEqual(response.json()['name'], 'Event') - self.assertEqual(len(Event.objects.all()), 1) - self.assertEqual(Event.objects.all()[0].slug, 'EVENT') - self.assertEqual(Event.objects.all()[0].name, 'Event') - - def test_update_event(self): - from rest_framework.test import APIClient - event = Event.objects.create(slug='EVENT1', name='Event 1') - response = APIClient().put(f'/api/1/events/{event.eid}', {'slug': 'EVENT2', 'name': 'Event 2 new'}) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['slug'], 'EVENT2') - self.assertEqual(response.json()['name'], 'Event 2 new') - self.assertEqual(len(Event.objects.all()), 1) - self.assertEqual(Event.objects.all()[0].slug, 'EVENT2') - self.assertEqual(Event.objects.all()[0].name, 'Event 2 new') - - def test_remove_event(self): - event = Event.objects.create(slug='EVENT1', name='Event 1') - Event.objects.create(slug='EVENT2', name='Event 2') - self.assertEqual(len(Event.objects.all()), 2) - response = client.delete(f'/api/1/events/{event.eid}') - self.assertEqual(response.status_code, 204) - self.assertEqual(len(Event.objects.all()), 1) diff --git a/core/inventory/tests/v1/test_items.py b/core/inventory/tests/v1/test_items.py deleted file mode 100644 index e13bcba..0000000 --- a/core/inventory/tests/v1/test_items.py +++ /dev/null @@ -1,133 +0,0 @@ -from django.test import TestCase, Client - -from files.models import File -from inventory.models import Event, Container, Item - -client = Client() - - -class ItemTestCase(TestCase): - - def setUp(self): - super().setUp() - self.event = Event.objects.create(slug='EVENT', name='Event') - self.box = Container.objects.create(name='BOX') - - def test_empty(self): - response = client.get(f'/api/1/{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') - response = client.get(f'/api/1/{self.event.slug}/item') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}]) - - def test_members_with_file(self): - import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') - file = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - response = client.get(f'/api/1/{self.event.slug}/item') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': file.hash}]) - - 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') - response = client.get(f'/api/1/{self.event.slug}/item') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 3) - - def test_create_item(self): - response = client.post(f'/api/1/{self.event.slug}/item', {'cid': self.box.cid, 'description': '1'}) - self.assertEqual(response.status_code, 201) - self.assertEqual(response.json(), - {'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - - def test_create_item_with_file(self): - import base64 - response = client.post(f'/api/1/{self.event.slug}/item', - {'cid': self.box.cid, '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()['uid'], 1) - self.assertEqual(response.json()['description'], '1') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.cid) - self.assertEqual(len(response.json()['file']), 64) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - self.assertEqual(len(File.objects.all()), 1) - - def test_update_item(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') - response = client.put(f'/api/1/{self.event.slug}/item/{item.uid}', {'description': '2'}, - content_type='application/json') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - {'uid': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.cid, 'file': None}) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - - def test_update_item_with_file(self): - import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') - response = client.put(f'/api/1/{self.event.slug}/item/{item.uid}', - {'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()['uid'], 1) - self.assertEqual(response.json()['description'], '2') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.cid) - self.assertEqual(len(response.json()['file']), 64) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - 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') - self.assertEqual(len(Item.objects.all()), 2) - response = client.delete(f'/api/1/{self.event.slug}/item/{item.uid}') - 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') - self.assertEqual(len(Item.objects.all()), 2) - response = client.delete(f'/api/1/{self.event.slug}/item/{item2.uid}') - 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') - self.assertEqual(item3.uid, 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') - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['itemCount'], 2) - - def test_item_nonexistent(self): - response = client.get(f'/api/1/NOEVENT/item') - self.assertEqual(response.status_code, 404) diff --git a/core/inventory/tests/v2/test_containers.py b/core/inventory/tests/v2/test_containers.py index 58322cc..b74a4a7 100644 --- a/core/inventory/tests/v2/test_containers.py +++ b/core/inventory/tests/v2/test_containers.py @@ -24,7 +24,7 @@ class ContainerTestCase(TestCase): response = self.client.get('/api/2/boxes/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['cid'], 1) + self.assertEqual(response.json()[0]['id'], 1) self.assertEqual(response.json()[0]['name'], 'BOX') self.assertEqual(response.json()[0]['itemCount'], 0) @@ -39,28 +39,28 @@ class ContainerTestCase(TestCase): def test_create_container(self): response = self.client.post('/api/2/box/', {'name': 'BOX'}) self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['cid'], 1) + self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['name'], 'BOX') self.assertEqual(response.json()['itemCount'], 0) self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) + self.assertEqual(Container.objects.all()[0].id, 1) self.assertEqual(Container.objects.all()[0].name, 'BOX') def test_update_container(self): box = Container.objects.create(name='BOX 1') - response = self.client.put(f'/api/2/box/{box.cid}/', {'name': 'BOX 2'}, content_type='application/json') + response = self.client.put(f'/api/2/box/{box.id}/', {'name': 'BOX 2'}, content_type='application/json') self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['cid'], 1) + self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['name'], 'BOX 2') self.assertEqual(response.json()['itemCount'], 0) self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) + self.assertEqual(Container.objects.all()[0].id, 1) self.assertEqual(Container.objects.all()[0].name, 'BOX 2') def test_delete_container(self): box = Container.objects.create(name='BOX 1') Container.objects.create(name='BOX 2') self.assertEqual(len(Container.objects.all()), 2) - response = self.client.delete(f'/api/2/box/{box.cid}/') + response = self.client.delete(f'/api/2/box/{box.id}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Container.objects.all()), 1) diff --git a/core/inventory/tests/v2/test_events.py b/core/inventory/tests/v2/test_events.py index affbd0e..d59ec06 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/inventory/tests/v2/test_items.py b/core/inventory/tests/v2/test_items.py index 056b38c..02c5085 100644 --- a/core/inventory/tests/v2/test_items.py +++ b/core/inventory/tests/v2/test_items.py @@ -7,6 +7,8 @@ from authentication.models import ExtendedUser from files.models import File from inventory.models import Event, Container, Item +from base64 import b64encode + class ItemTestCase(TestCase): @@ -29,8 +31,8 @@ class ItemTestCase(TestCase): response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None, - 'returned': False}]) + [{'id': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.id, 'file': None, + 'returned': False, 'event': self.event.slug}]) def test_members_with_file(self): import base64 @@ -39,8 +41,8 @@ class ItemTestCase(TestCase): response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': file.hash, - 'returned': False}]) + [{'id': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.id, 'file': file.hash, + 'returned': False, 'event': self.event.slug}]) def test_multi_members(self): Item.objects.create(container=self.box, event=self.event, description='1') @@ -51,71 +53,79 @@ class ItemTestCase(TestCase): 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.cid, 'description': '1'}) + response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box.id, 'description': '1'}) self.assertEqual(response.status_code, 201) self.assertEqual(response.json(), - {'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None, - 'returned': False}) + {'id': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.id, 'file': None, + 'returned': False, 'event': self.event.slug}) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.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}) + 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.cid, 'description': '1', + {'cid': self.box.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()['uid'], 1) + 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.cid) + self.assertEqual(response.json()['id'], self.box.id) self.assertEqual(len(response.json()['file']), 64) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.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') - response = self.client.put(f'/api/2/{self.event.slug}/item/{item.uid}/', {'description': '2'}, + response = self.client.put(f'/api/2/{self.event.slug}/item/{item.id}/', {'description': '2'}, content_type='application/json') self.assertEqual(response.status_code, 200) self.assertEqual(response.json(), - {'uid': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.cid, 'file': None, - 'returned': False}) + {'id': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.id, 'file': None, + 'returned': False, 'event': self.event.slug}) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.id) def test_update_item_with_file(self): import base64 item = Item.objects.create(container=self.box, event=self.event, description='1') - response = self.client.put(f'/api/2/{self.event.slug}/item/{item.uid}/', + response = self.client.put(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') self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['uid'], 1) + self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['description'], '2') self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.cid) + self.assertEqual(response.json()['id'], self.box.id) self.assertEqual(len(response.json()['file']), 64) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.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') self.assertEqual(len(Item.objects.all()), 2) - response = self.client.delete(f'/api/2/{self.event.slug}/item/{item.uid}/') + 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) @@ -123,11 +133,11 @@ class ItemTestCase(TestCase): Item.objects.create(container=self.box, event=self.event, description='1') item2 = Item.objects.create(container=self.box, event=self.event, description='2') self.assertEqual(len(Item.objects.all()), 2) - response = self.client.delete(f'/api/2/{self.event.slug}/item/{item2.uid}/') + 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') - self.assertEqual(item3.uid, 3) + self.assertEqual(item3.id, 3) self.assertEqual(len(Item.objects.all()), 2) def test_item_count(self): @@ -148,7 +158,7 @@ class ItemTestCase(TestCase): response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) - response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.uid}/', {'returned': True}, + response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.id}/', {'returned': True}, content_type='application/json') self.assertEqual(response.status_code, 200) item.refresh_from_db() @@ -168,4 +178,75 @@ class ItemTestCase(TestCase): 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]['uid'], item1.uid) + self.assertEqual(response.json()[0]['id'], item1.id) + + +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.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') + + def test_search(self): + search_query = b64encode(b'abc').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + 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(1, response.json()[0]['search_score']) + + def test_search2(self): + search_query = b64encode(b'def').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + 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]['id']) + self.assertEqual(1, 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(1, response.json()[0]['search_score']) + + def test_search3(self): + search_query = b64encode(b'jkl').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + 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(1, response.json()[0]['search_score']) + + def test_search4(self): + search_query = b64encode(b'abc def').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + 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]['id']) + 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(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..7b979a5 --- /dev/null +++ b/core/mail/migrations/0007_alter_eventaddress_address.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2.7 on 2024-11-18 01:50 + +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 2215fbb..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 @@ -29,13 +31,13 @@ class Email(SoftDeleteModel): self.save() def train_spam(self): - if ACTIVE_SPAM_TRAINING: + if ACTIVE_SPAM_TRAINING and self.raw_file.path: import subprocess path = self.raw_file.path subprocess.run(["rspamc", "learn_spam", path]) def train_ham(self): - if ACTIVE_SPAM_TRAINING: + if ACTIVE_SPAM_TRAINING and self.raw_file.path: import subprocess path = self.raw_file.path subprocess.run(["rspamc", "learn_ham", path]) @@ -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 926e8c2..6b4dc6d 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,11 +88,27 @@ 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) -def find_active_issue_thread(in_reply_to, address, subject): +def find_active_issue_thread(in_reply_to, address, subject, event): from re import match uuid_match = match(r'^ticket\+([a-f0-9-]{36})@', address) if uuid_match: @@ -102,7 +119,7 @@ def find_active_issue_thread(in_reply_to, address, subject): if reply_to.exists(): return reply_to.first().issue_thread, False else: - issue = IssueThread.objects.create(name=subject) + issue = IssueThread.objects.create(name=subject, event=event) return issue, True @@ -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") @@ -202,11 +229,14 @@ def receive_email(envelope, log=None): subject = unescape_and_decode_base64(subject) target_event = find_target_event(recipient) - active_issue_thread, new = find_active_issue_thread(header_in_reply_to, recipient, subject) + active_issue_thread, new = find_active_issue_thread(header_in_reply_to, recipient, subject, target_event) + + from hashlib import sha256 + random_filename = 'mail-' + sha256(envelope.content).hexdigest() email = Email.objects.create( sender=sender, recipient=recipient, body=body, subject=subject, reference=header_message_id, - in_reply_to=header_in_reply_to, raw_file=ContentFile(envelope.content), event=target_event, + in_reply_to=header_in_reply_to, raw_file=ContentFile(envelope.content, name=random_filename), event=target_event, issue_thread=active_issue_thread) for attachment in attachments: email.attachments.add(attachment) @@ -218,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) @@ -270,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_mails.py b/core/mail/tests/v2/test_mails.py index 3df56ca..3b358ca 100644 --- a/core/mail/tests/v2/test_mails.py +++ b/core/mail/tests/v2/test_mails.py @@ -142,6 +142,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test aiosmtplib.send.assert_called_once() self.assertEqual('test ä', Email.objects.all()[0].subject) self.assertEqual('Text mit Quoted-Printable-Kodierung: äöüß', Email.objects.all()[0].body) + self.assertTrue( Email.objects.all()[0].raw_file.path) def test_handle_quoted_printable_2(self): from aiosmtpd.smtp import Envelope @@ -162,6 +163,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test aiosmtplib.send.assert_called_once() self.assertEqual('suche_Mütze', Email.objects.all()[0].subject) self.assertEqual('Text mit Quoted-Printable-Kodierung: äöüß', Email.objects.all()[0].body) + self.assertTrue( Email.objects.all()[0].raw_file.path) def test_handle_base64(self): from aiosmtpd.smtp import Envelope @@ -182,6 +184,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test aiosmtplib.send.assert_called_once() self.assertEqual('test', Email.objects.all()[0].subject) self.assertEqual('Text mit Base64-Kodierung: äöüß', Email.objects.all()[0].body) + self.assertTrue( Email.objects.all()[0].raw_file.path) def test_handle_client_reply(self): issue_thread = IssueThread.objects.create( @@ -229,6 +232,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test self.assertEqual(IssueThread.objects.all()[0].name, 'test') self.assertEqual(IssueThread.objects.all()[0].state, 'pending_new') self.assertEqual(IssueThread.objects.all()[0].assigned_to, None) + self.assertTrue( Email.objects.all()[2].raw_file.path) def test_handle_client_reply_2(self): issue_thread = IssueThread.objects.create( @@ -281,6 +285,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test self.assertEqual(IssueThread.objects.all()[0].name, 'test') self.assertEqual(IssueThread.objects.all()[0].state, 'pending_open') self.assertEqual(IssueThread.objects.all()[0].assigned_to, None) + self.assertTrue( Email.objects.all()[2].raw_file.path) def test_mail_reply(self): issue_thread = IssueThread.objects.create( @@ -384,6 +389,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test states = StateChange.objects.filter(issue_thread=IssueThread.objects.all()[0]) self.assertEqual(1, len(states)) self.assertEqual('pending_new', states[0].state) + self.assertEqual(event, IssueThread.objects.all()[0].event) def test_mail_html_body(self): from aiosmtpd.smtp import Envelope 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/tickets/api_v2.py b/core/tickets/api_v2.py index 596bd9b..382e350 100644 --- a/core/tickets/api_v2.py +++ b/core/tickets/api_v2.py @@ -1,4 +1,5 @@ import logging +from base64 import b64decode from django.urls import re_path from django.contrib.auth.decorators import permission_required @@ -15,7 +16,7 @@ from mail.models import Email from mail.protocol import send_smtp, make_reply, collect_references from notify_sessions.models import SystemEvent from tickets.models import IssueThread, Comment, STATE_CHOICES, ShippingVoucher -from tickets.serializers import IssueSerializer, CommentSerializer, ShippingVoucherSerializer +from tickets.serializers import IssueSerializer, CommentSerializer, ShippingVoucherSerializer, SearchResultSerializer class IssueViewSet(viewsets.ModelViewSet): @@ -23,6 +24,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() @@ -56,7 +62,7 @@ def reply(request, pk): @api_view(['POST']) @permission_classes([IsAuthenticated]) @permission_required('tickets.add_issuethread_manual', raise_exception=True) -def manual_ticket(request): +def manual_ticket(request, event_slug): if 'name' not in request.data: return Response({'status': 'error', 'message': 'missing name'}, status=status.HTTP_400_BAD_REQUEST) if 'sender' not in request.data: @@ -66,8 +72,16 @@ def manual_ticket(request): if 'body' not in request.data: return Response({'status': 'error', 'message': 'missing body'}, status=status.HTTP_400_BAD_REQUEST) + event = None + if event_slug != 'none': + try: + event = Event.objects.get(slug=event_slug) + except: + return Response({'status': 'error', 'message': 'invalid event'}, status=status.HTTP_400_BAD_REQUEST) + issue = IssueThread.objects.create( name=request.data['name'], + event=event, manually_created=True, ) email = Email.objects.create( @@ -117,13 +131,42 @@ def add_comment(request, pk): return Response(CommentSerializer(comment).data, status=status.HTTP_201_CREATED) +def filter_issues(issues, query): + query_tokens = query.split(' ') + for issue in issues: + value = 0 + for token in query_tokens: + if token in issue.description: + value += 1 + if value > 0: + yield {'search_score': value, 'issue': issue} + + +@api_view(['GET']) +@permission_classes([IsAuthenticated]) +def search_issues(request, event_slug, query): + try: + event = Event.objects.get(slug=event_slug) + if not request.user.has_event_perm(event, 'view_issuethread'): + return Response(status=403) + items = filter_issues(IssueThread.objects.filter(event=event), b64decode(query).decode('utf-8')) + return Response(SearchResultSerializer(items, many=True).data) + except Event.DoesNotExist: + return Response(status=404) + + 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') + +# [-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'^tickets/manual/$', manual_ticket, name='manual_ticket'), - re_path(r'^tickets/states/$', get_available_states, name='get_available_states'), + 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'), ] + router.urls) diff --git a/core/tickets/migrations/0012_alter_itemrelation_item.py b/core/tickets/migrations/0012_alter_itemrelation_item.py new file mode 100644 index 0000000..fe2d7d0 --- /dev/null +++ b/core/tickets/migrations/0012_alter_itemrelation_item.py @@ -0,0 +1,20 @@ +# Generated by Django 4.2.7 on 2024-11-19 22:02 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('inventory', '0005_rename_cid_container_id_rename_iid_item_id_and_more'), + ('tickets', '0011_train_old_spam'), + ] + + operations = [ + migrations.AlterField( + model_name='itemrelation', + name='item', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='issue_relations', to='inventory.item'), + ), + ] diff --git a/core/tickets/models.py b/core/tickets/models.py index aff5d6c..03b528c 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 @@ -133,7 +133,7 @@ class Assignment(models.Model): class ItemRelation(models.Model): id = models.AutoField(primary_key=True) issue_thread = models.ForeignKey(IssueThread, on_delete=models.CASCADE, related_name='item_relations') - item = models.ForeignKey(Item, on_delete=models.CASCADE, related_name='issues') + item = models.ForeignKey(Item, on_delete=models.CASCADE, related_name='issue_relations') timestamp = models.DateTimeField(auto_now_add=True) status = models.CharField(max_length=255, choices=RELATION_STATUS_CHOICES, default='possible') diff --git a/core/tickets/serializers.py b/core/tickets/serializers.py index a980b97..9779bc5 100644 --- a/core/tickets/serializers.py +++ b/core/tickets/serializers.py @@ -1,6 +1,7 @@ from rest_framework import serializers from authentication.models import ExtendedUser +from inventory.models import Event from mail.api_v2 import AttachmentSerializer from tickets.models import IssueThread, Comment, STATE_CHOICES, ShippingVoucher from inventory.serializers import ItemSerializer @@ -41,19 +42,21 @@ class IssueSerializer(serializers.ModelSerializer): last_activity = serializers.SerializerMethodField() assigned_to = serializers.SlugRelatedField(slug_field='username', queryset=ExtendedUser.objects.all(), allow_null=True, required=False) + event = serializers.SlugRelatedField(slug_field='slug', queryset=Event.objects.all(), + allow_null=True, required=False) related_items = ItemSerializer(many=True, read_only=True) class Meta: model = IssueThread - fields = ('id', 'timeline', 'name', 'state', 'assigned_to', 'last_activity', 'uuid', 'related_items') + fields = ('id', 'timeline', 'name', 'state', 'assigned_to', 'last_activity', 'uuid', 'related_items', 'event') read_only_fields = ('id', 'timeline', 'last_activity', 'uuid', 'related_items') def to_internal_value(self, data): 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): @@ -134,3 +137,14 @@ class IssueSerializer(serializers.ModelSerializer): def get_queryset(self): return IssueThread.objects.all().order_by('-last_activity') + + +class SearchResultSerializer(serializers.Serializer): + search_score = serializers.IntegerField() + item = IssueSerializer() + + def to_representation(self, instance): + return {**IssueSerializer(instance['item']).data, 'search_score': instance['search_score']} + + class Meta: + model = IssueThread diff --git a/core/tickets/tests/v2/test_tickets.py b/core/tickets/tests/v2/test_tickets.py index 8223506..6b7f90d 100644 --- a/core/tickets/tests/v2/test_tickets.py +++ b/core/tickets/tests/v2/test_tickets.py @@ -3,11 +3,14 @@ from datetime import datetime, timedelta from django.test import TestCase, Client from authentication.models import ExtendedUser +from inventory.models import Event from mail.models import Email, EmailAttachment from tickets.models import IssueThread, StateChange, Comment from django.contrib.auth.models import Permission from knox.models import AuthToken +from base64 import b64encode + class IssueApiTest(TestCase): @@ -16,6 +19,7 @@ class IssueApiTest(TestCase): self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') self.user.user_permissions.add(*Permission.objects.all()) self.user.save() + self.event = Event.objects.create(slug='evt') self.token = AuthToken.objects.create(user=self.user) self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) @@ -28,6 +32,7 @@ class IssueApiTest(TestCase): now = datetime.now() issue = IssueThread.objects.create( name="test issue", + event=self.event, ) mail1 = Email.objects.create( subject='test', @@ -61,6 +66,7 @@ class IssueApiTest(TestCase): self.assertEqual(response.json()[0]['id'], issue.id) self.assertEqual(response.json()[0]['name'], "test issue") self.assertEqual(response.json()[0]['state'], "pending_new") + self.assertEqual(response.json()[0]['event'], "evt") self.assertEqual(response.json()[0]['assigned_to'], None) self.assertEqual(response.json()[0]['uuid'], issue.uuid) self.assertEqual(response.json()[0]['last_activity'], comment.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) @@ -93,12 +99,15 @@ class IssueApiTest(TestCase): now = datetime.now() issue1 = IssueThread.objects.create( name="test issue", + event=self.event, ) issue2 = IssueThread.objects.create( name="test issue", + event=self.event, ) issue3 = IssueThread.objects.create( name="test issue", + event=self.event, ) mail1 = Email.objects.create( subject='test', @@ -118,8 +127,11 @@ class IssueApiTest(TestCase): self.assertEqual(200, response.status_code) self.assertEqual(3, len(response.json())) self.assertEqual(issue1.id, response.json()[0]['id']) + self.assertEqual("evt", response.json()[0]['event']) self.assertEqual(issue2.id, response.json()[1]['id']) + self.assertEqual("evt", response.json()[1]['event']) self.assertEqual(issue3.id, response.json()[2]['id']) + self.assertEqual("evt", response.json()[2]['event']) self.assertEqual(issue1.state_changes.first().timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), response.json()[0]['last_activity']) self.assertEqual(mail1.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), @@ -153,6 +165,7 @@ class IssueApiTest(TestCase): now = datetime.now() issue = IssueThread.objects.create( name="test issue", + event=self.event, ) mail1 = Email.objects.create( subject='test', @@ -189,6 +202,7 @@ class IssueApiTest(TestCase): self.assertEqual(200, response.status_code) self.assertEqual(1, len(response.json())) self.assertEqual(issue.id, response.json()[0]['id']) + self.assertEqual("evt", response.json()[0]['event']) self.assertEqual('pending_new', response.json()[0]['state']) self.assertEqual('test issue', response.json()[0]['name']) self.assertEqual(None, response.json()[0]['assigned_to']) @@ -230,13 +244,14 @@ class IssueApiTest(TestCase): self.assertEqual(file2.hash, response.json()[0]['timeline'][1]['attachments'][1]['hash']) def test_manual_creation(self): - response = self.client.post('/api/2/tickets/manual/', + response = self.client.post('/api/2/evt/tickets/manual/', {'name': 'test issue', 'sender': 'test', 'recipient': 'test', 'body': 'test'}, content_type='application/json') self.assertEqual(response.status_code, 201) self.assertEqual(response.json()['state'], 'pending_new') self.assertEqual(response.json()['name'], 'test issue') self.assertEqual(response.json()['assigned_to'], None) + self.assertEqual("evt", response.json()['event']) timeline = response.json()['timeline'] self.assertEqual(len(timeline), 2) self.assertEqual(timeline[0]['type'], 'state') @@ -247,9 +262,46 @@ class IssueApiTest(TestCase): self.assertEqual(timeline[1]['subject'], 'test issue') self.assertEqual(timeline[1]['body'], 'test') + def test_manual_creation_none(self): + response = self.client.post('/api/2/none/tickets/manual/', + {'name': 'test issue', 'sender': 'test', 'recipient': 'test', 'body': 'test'}, + content_type='application/json') + self.assertEqual(response.status_code, 201) + self.assertEqual(response.json()['state'], 'pending_new') + self.assertEqual(response.json()['name'], 'test issue') + self.assertEqual(response.json()['assigned_to'], None) + self.assertEqual(None, response.json()['event']) + timeline = response.json()['timeline'] + self.assertEqual(len(timeline), 2) + self.assertEqual(timeline[0]['type'], 'state') + self.assertEqual(timeline[0]['state'], 'pending_new') + self.assertEqual(timeline[1]['type'], 'mail') + self.assertEqual(timeline[1]['sender'], 'test') + self.assertEqual(timeline[1]['recipient'], 'test') + self.assertEqual(timeline[1]['subject'], 'test issue') + self.assertEqual(timeline[1]['body'], 'test') + + def test_manual_creation_invalid(self): + response = self.client.post('/api/2/foobar/tickets/manual/', + {'name': 'test issue', 'sender': 'test', 'recipient': 'test', 'body': 'test'}, + content_type='application/json') + self.assertEqual(response.status_code, 400) + + + #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", + event=self.event, ) response = self.client.post(f'/api/2/tickets/{issue.id}/comment/', {'comment': 'test'}) self.assertEqual(response.status_code, 201) @@ -260,6 +312,7 @@ class IssueApiTest(TestCase): def test_post_alt_comment_empty(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.post(f'/api/2/tickets/{issue.id}/comment/', {'comment': ''}) self.assertEqual(response.status_code, 400) @@ -267,6 +320,7 @@ class IssueApiTest(TestCase): def test_state_change(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.patch(f'/api/2/tickets/{issue.id}/', {'state': 'pending_open'}, content_type='application/json') @@ -284,6 +338,7 @@ class IssueApiTest(TestCase): def test_state_change_invalid_state(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.patch(f'/api/2/tickets/{issue.id}/', {'state': 'invalid'}, content_type='application/json') @@ -292,12 +347,14 @@ class IssueApiTest(TestCase): def test_assign_user(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.patch(f'/api/2/tickets/{issue.id}/', {'assigned_to': self.user.username}, content_type='application/json') self.assertEqual(200, response.status_code) self.assertEqual('pending_new', response.json()['state']) self.assertEqual('test issue', response.json()['name']) + self.assertEqual("evt", response.json()['event']) self.assertEqual(self.user.username, response.json()['assigned_to']) timeline = response.json()['timeline'] self.assertEqual(2, len(timeline)) @@ -305,3 +362,21 @@ class IssueApiTest(TestCase): self.assertEqual('pending_new', timeline[0]['state']) self.assertEqual('assignment', timeline[1]['type']) self.assertEqual(self.user.username, timeline[1]['assigned_to']) + + +class IssueSearchTest(TestCase): + + def setUp(self): + super().setUp() + self.event = Event.objects.create(slug='EVENT', name='Event') + self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') + self.user.user_permissions.add(*Permission.objects.all()) + self.user.save() + self.token = AuthToken.objects.create(user=self.user) + self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) + + def test_search(self): + search_query = b64encode(b'abc').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/tickets/{search_query}/') + self.assertEqual(200, response.status_code) + self.assertEqual([], response.json()) 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 608ffd5..3533f37 100644 --- a/deploy/ansible/playbooks/templates/nginx.conf.j2 +++ b/deploy/ansible/playbooks/templates/nginx.conf.j2 @@ -70,6 +70,13 @@ server { alias /var/www/c3lf-sys3/staticfiles/; } + location /metrics { + allow 95.156.226.90; + allow 127.0.0.1; + allow ::1; + deny all; + } + listen 443 ssl http2; # managed by Certbot ssl_certificate /etc/letsencrypt/live/{{ web_domain }}/fullchain.pem; # managed by Certbot ssl_certificate_key /etc/letsencrypt/live/{{ web_domain }}/privkey.pem; # managed by Certbot 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..c91420d 100644 --- a/web/src/components/CollapsableCards.vue +++ b/web/src/components/CollapsableCards.vue @@ -1,6 +1,31 @@ + + + + \ No newline at end of file diff --git a/web/src/components/Navbar.vue b/web/src/components/Navbar.vue index 686f324..ccfb0f0 100644 --- a/web/src/components/Navbar.vue +++ b/web/src/components/Navbar.vue @@ -6,7 +6,8 @@ {{ getEventSlug }} @@ -48,12 +49,12 @@ @@ -64,19 +65,6 @@