ada2456d00d52ec571ce9d153f51ed5a8cf4902d to main · KIF / AKPlanning

Some changes are not shown.

For a faster browsing experience, only 86 of 635 files are shown. Download one of the files below to see all changes.

.docker/entrypoint.sh

0 → 100644

+46 −0

Original line number	Original line	Diff line number	Diff line
			#!/bin/sh

			function wait_for_db()
			{
			while ! ./manage.py sqlflush > /dev/null 2>&1 ;do
			echo "Waiting for the db to be ready."
			sleep 1
			done
			}

			if [ "$SECRET_KEY" == "" ] ;then
			echo "Need the environment variable SECRET_KEY."
			exit 1
			fi

			echo "" > ./AKPlanning/settings_secrets.py # Reset file in case we ran before
			echo "SECRET_KEY = '$SECRET_KEY'" >> ./AKPlanning/settings_secrets.py
			echo "HOSTS = $HOSTS" >> ./AKPlanning/settings_secrets.py
			echo "DB_NAME = '$DB_NAME'" >> ./AKPlanning/settings_secrets.py
			echo "DB_USER = '$DB_USER'" >> ./AKPlanning/settings_secrets.py
			echo "DB_PASSWORD = '$DB_PASSWORD'" >> ./AKPlanning/settings_secrets.py
			echo "DB_HOST = '$DB_HOST'" >> ./AKPlanning/settings_secrets.py

			if [ "$AUTO_MIGRATE_DB" == "true" ] ;then
			wait_for_db
			echo "Applying DB migrations"
			./manage.py migrate
			fi

			if [ "$DJANGO_SUPERUSER_PASSWORD" != "" ] ;then
			wait_for_db
			echo "Trying to create superuser."
			./manage.py createsuperuser --noinput
			fi

			env \| while IFS= read -r line; do
			value=${line#*=}
			name=${line%%=*}
			case $name in EXTRA_DJANGO_SETTING*)
			echo -e "$value" > "./AKPlanning/settings/$name.py"
			esac
			done

			./manage.py collectstatic --noinput
			./manage.py compilemessages -l de_DE
			uwsgi --ini .docker/uwsgi.ini

.docker/extra_requirements.txt

0 → 100644

+1 −0

Original line number	Original line	Diff line number	Diff line
			uwsgi==2.0.30

.docker/uwsgi.ini

0 → 100644

+6 −0

Original line number	Original line	Diff line number	Diff line
			[uwsgi]
			socket = 0.0.0.0:3035
			wsgi-file = AKPlanning/wsgi.py
			env = DJANGO_SETTINGS_MODULE=AKPlanning.settings_production
			processes = 4
			threads = 2

.dockerignore

0 → 100644

+11 −0

Original line number	Original line	Diff line number	Diff line
			apache-akplanning.conf
			CODE_OF_CONDUCT.md
			CONTRIBUTING.md
			CONTRIBUTORS.md
			.git
			.gitignore
			.gitlab-ci.yml
			INSTALL.md
			LICENSE.md
			README.md
			uwsgi-akplanning.ini

.gitignore

+3 −0

Original line number	Original line	Diff line number	Diff line
	@@ -10,6 +10,9 @@ AKPlanning/settings/
	# static files generated by django		# static files generated by django
	/static/		/static/

			# Database backups
			backups/

	# Created by https://www.gitignore.io/api/python,django,virtualenv,pycharm+all		# Created by https://www.gitignore.io/api/python,django,virtualenv,pycharm+all
	# Edit at https://www.gitignore.io/?templates=python,django,virtualenv,pycharm+all		# Edit at https://www.gitignore.io/?templates=python,django,virtualenv,pycharm+all

.gitlab-ci.yml

0 → 100644

+93 −0

Original line number	Original line	Diff line number	Diff line
			image: python:3.11

			services:
			- mysql

			variables:
			MYSQL_DATABASE: "test"
			MYSQL_ROOT_PASSWORD: "mysql"
			MYSQL_USER: "django"
			MYSQL_PASSWORD: "mysql"
			MYSQL_HOST: "mysql"

			cache:
			paths:
			- ~/.cache/pip/

			.before_script_template:
			before_script:
			- python -V # Print out python version for debugging
			- apt-get -qq update
			- apt-get -qq install -y python3-virtualenv python3 python3-dev python3-pip gettext default-mysql-client default-libmysqlclient-dev
			- ./Utils/setup.sh --ci
			- mkdir -p public/badges public/lint
			- echo undefined > public/badges/$CI_JOB_NAME.score
			- source venv/bin/activate
			- pip install pylint-gitlab pylint-django
			- mysql --version

			migrations:
			extends: .before_script_template
			script:
			- source venv/bin/activate
			- ./manage.py makemigrations --dry-run --check

			test:
			extends: .before_script_template
			script:
			- source venv/bin/activate
			- echo "GRANT ALL on . to '${MYSQL_USER}';"\| mysql -u root --password="${MYSQL_ROOT_PASSWORD}" -h mysql
			- pip install pytest-cov
			- coverage run --source='.' manage.py test --settings AKPlanning.settings_ci
			after_script:
			- source venv/bin/activate
			- coverage report
			- coverage xml
			coverage: '/(?i)total.*? (100(?:\.0+)?\%\|[1-9]?\d(?:\.\d+)?\%)$/'
			artifacts:
			reports:
			coverage_report:
			coverage_format: cobertura
			path: coverage.xml
			junit: unit.xml

			lint:
			extends: .before_script_template
			stage: test
			script:
			- pylint --load-plugins pylint_django --django-settings-module=AKPlanning.settings_ci --rcfile pylintrc --exit-zero --output-format=text AK* \| tee /tmp/pylint.txt
			- sed -n 's/^Your code has been rated at $[-0-9.]$\/./\1/p' /tmp/pylint.txt > public/badges/$CI_JOB_NAME.score
			- pylint --load-plugins pylint_django --django-settings-module=AKPlanning.settings_ci --rcfile pylintrc --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter AK* > codeclimate.json
			- pylint --load-plugins pylint_django --django-settings-module=AKPlanning.settings_ci --rcfile pylintrc --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter AK* > public/lint/index.html
			after_script:
			- \|
			echo "Linting score: $(cat public/badges/$CI_JOB_NAME.score)"
			artifacts:
			paths:
			- public
			reports:
			codequality: codeclimate.json
			when: always

			doc:
			extends: .before_script_template
			stage: test
			script:
			- cd docs
			- make html
			- cd ..
			artifacts:
			paths:
			- docs/_build/html

			pages:
			stage: deploy
			image: alpine:latest
			script:
			- echo
			artifacts:
			paths:
			- public
			only:
			refs:
			- main

AKDashboard/admin.py

+3 −0

Original line number	Original line	Diff line number	Diff line
	@@ -4,6 +4,9 @@ from AKDashboard.models import DashboardButton

	@admin.register(DashboardButton)		@admin.register(DashboardButton)
	class DashboardButtonAdmin(admin.ModelAdmin):		class DashboardButtonAdmin(admin.ModelAdmin):
			"""
			Admin interface for dashboard buttons
			"""
	list_display = ['text', 'url', 'event']		list_display = ['text', 'url', 'event']
	list_filter = ['event']		list_filter = ['event']
	search_fields = ['text', 'url']		search_fields = ['text', 'url']

AKDashboard/apps.py

+3 −0

Original line number	Original line	Diff line number	Diff line
	@@ -2,4 +2,7 @@ from django.apps import AppConfig


	class AkdashboardConfig(AppConfig):		class AkdashboardConfig(AppConfig):
			"""
			App configuration for dashboard (default)
			"""
	name = 'AKDashboard'		name = 'AKDashboard'

AKDashboard/fixtures/dashboard.json

0 → 100644

+13 −0

Original line number	Original line	Diff line number	Diff line
			[
			{
			"model": "AKDashboard.dashboardbutton",
			"pk": 1,
			"fields": {
			"text": "Wiki",
			"url": "http://wiki.kif.rocks",
			"icon": "fab,wikipedia-w",
			"color": 2,
			"event": 2
			}
			}
			]

AKDashboard/locale/de_DE/LC_MESSAGES/django.po

+77 −32

Original line number	Original line	Diff line number	Diff line
	@@ -8,7 +8,7 @@ msgid ""
	msgstr ""		msgstr ""
	"Project-Id-Version: PACKAGE VERSION\n"		"Project-Id-Version: PACKAGE VERSION\n"
	"Report-Msgid-Bugs-To: \n"		"Report-Msgid-Bugs-To: \n"
	"POT-Creation-Date: 2020-05-10 16:22+0000\n"		"POT-Creation-Date: 2025-06-21 18:09+0000\n"
	"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"		"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
	"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"		"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
	"Language-Team: LANGUAGE <LL@li.org>\n"		"Language-Team: LANGUAGE <LL@li.org>\n"
	@@ -17,77 +17,122 @@ msgstr ""
	"Content-Type: text/plain; charset=UTF-8\n"		"Content-Type: text/plain; charset=UTF-8\n"
	"Content-Transfer-Encoding: 8bit\n"		"Content-Transfer-Encoding: 8bit\n"

	#: AKDashboard/models.py:10		#: AKDashboard/models.py:21
	msgid "Dashboard Button"		msgid "Dashboard Button"
	msgstr "Dashboard-Button"		msgstr "Dashboard-Button"

	#: AKDashboard/models.py:11		#: AKDashboard/models.py:22
	msgid "Dashboard Buttons"		msgid "Dashboard Buttons"
	msgstr "Dashboard-Buttons"		msgstr "Dashboard-Buttons"

	#: AKDashboard/models.py:21		#: AKDashboard/models.py:32
	msgid "Text"		msgid "Text"
	msgstr "Text"		msgstr "Text"

	#: AKDashboard/models.py:22		#: AKDashboard/models.py:33
	msgid "Text that will be shown on the button"		msgid "Text that will be shown on the button"
	msgstr "Text, der auf dem Button angezeigt wird"		msgstr "Text, der auf dem Button angezeigt wird"

	#: AKDashboard/models.py:23		#: AKDashboard/models.py:34
	msgid "Link URL"		msgid "Link URL"
	msgstr "Link URL"		msgstr "Link-URL"

	#: AKDashboard/models.py:23		#: AKDashboard/models.py:34
	msgid "URL this button links to"		msgid "URL this button links to"
	msgstr "URL auf die der Button verweist"		msgstr "URL auf die der Button verweist"

	#: AKDashboard/models.py:24		#: AKDashboard/models.py:35
	msgid "Icon"		msgid "Icon"
	msgstr "Symbol"		msgstr "Symbol"

	#: AKDashboard/models.py:26		#: AKDashboard/models.py:37
	msgid "Button Style"		msgid "Button Style"
	msgstr "Stil des Buttons"		msgstr "Stil des Buttons"

	#: AKDashboard/models.py:26		#: AKDashboard/models.py:37
	msgid "Style (Color) of this button (bootstrap class)"		msgid "Style (Color) of this button (bootstrap class)"
	msgstr "Stiel (Farbe) des Buttons (Bootstrap-Klasse)"		msgstr "Stiel (Farbe) des Buttons (Bootstrap-Klasse)"

	#: AKDashboard/models.py:28		#: AKDashboard/models.py:39
	msgid "Event"		msgid "Event"
	msgstr "Veranstaltung"		msgstr "Veranstaltung"

	#: AKDashboard/models.py:28		#: AKDashboard/models.py:39
	msgid "Event this button belongs to"		msgid "Event this button belongs to"
	msgstr "Veranstaltung, zu der dieser Button gehört"		msgstr "Veranstaltung, zu der dieser Button gehört"

	#: AKDashboard/templates/AKDashboard/dashboard.html:30		#: AKDashboard/templates/AKDashboard/dashboard.html:19
	msgid "AK List"		#: AKDashboard/templates/AKDashboard/dashboard_event.html:30
	msgstr "AK Liste"		#: AKDashboard/templates/AKDashboard/dashboard_row_old_event.html:53

	#: AKDashboard/templates/AKDashboard/dashboard.html:40
	msgid "Current AKs"
	msgstr "Aktuelle AKs"

	#: AKDashboard/templates/AKDashboard/dashboard.html:47
	msgid "AK Wall"
	msgstr "AK-Wall"

	#: AKDashboard/templates/AKDashboard/dashboard.html:56
	msgid "AK Submission"
	msgstr "AK-Submission"

	#: AKDashboard/templates/AKDashboard/dashboard.html:72
	msgid "Write to organizers of this event for questions and comments"		msgid "Write to organizers of this event for questions and comments"
	msgstr ""		msgstr ""
	"Kontaktiere die Organisator*innen des Events bei Fragen oder Kommentaren"		"Kontaktiere die Organisator*innen des Events bei Fragen oder Kommentaren"

	#: AKDashboard/templates/AKDashboard/dashboard.html:79		#: AKDashboard/templates/AKDashboard/dashboard.html:25
			msgid "Old events"
			msgstr "Frühere Veranstaltungen"

			#: AKDashboard/templates/AKDashboard/dashboard.html:35
	msgid "Currently, there are no Events!"		msgid "Currently, there are no Events!"
	msgstr "Aktuell gibt es keine Events!"		msgstr "Aktuell gibt es keine Events!"

	#: AKDashboard/templates/AKDashboard/dashboard.html:82		#: AKDashboard/templates/AKDashboard/dashboard.html:38
	msgid "Please contact an administrator if you want to use AKPlanning."		msgid "Please contact an administrator if you want to use AKPlanning."
	msgstr ""		msgstr ""
	"Bitte kontaktiere einen Administratorin, falls du AKPlanning verwenden "		"Bitte kontaktiere einen Administratorin, falls du AKPlanning verwenden "
	"möchtest."		"möchtest."

			#: AKDashboard/templates/AKDashboard/dashboard_event.html:20
			msgid "Recent"
			msgstr "Kürzlich"

			#: AKDashboard/templates/AKDashboard/dashboard_row.html:18
			#: AKDashboard/templates/AKDashboard/dashboard_row_old_event.html:20
			msgid "AK List"
			msgstr "AK-Liste"

			#: AKDashboard/templates/AKDashboard/dashboard_row.html:29
			msgid "Current AKs"
			msgstr "Aktuelle AKs"

			#: AKDashboard/templates/AKDashboard/dashboard_row.html:36
			msgid "AK Wall"
			msgstr "AK-Wall"

			#: AKDashboard/templates/AKDashboard/dashboard_row.html:44
			#: AKDashboard/templates/AKDashboard/dashboard_row_old_event.html:30
			msgid "Schedule"
			msgstr "AK-Plan"

			#: AKDashboard/templates/AKDashboard/dashboard_row.html:55
			msgid "AK Submission"
			msgstr "AK-Einreichung"

			#: AKDashboard/templates/AKDashboard/dashboard_row.html:63
			#: AKDashboard/templates/AKDashboard/dashboard_row_old_event.html:39
			msgid "AK History"
			msgstr "AK-Verlauf"

			#: AKDashboard/templates/AKDashboard/dashboard_row.html:72
			msgid "AK Preferences"
			msgstr "AK-Präferenzen"

			#: AKDashboard/views.py:70
			#, python-format
			msgid "New AK: %(ak)s."
			msgstr "Neuer AK: %(ak)s."

			#: AKDashboard/views.py:73
			#, python-format
			msgid "AK \"%(ak)s\" edited."
			msgstr "AK \"%(ak)s\" bearbeitet."

			#: AKDashboard/views.py:76
			#, python-format
			msgid "AK \"%(ak)s\" deleted."
			msgstr "AK \"%(ak)s\" gelöscht."

			#: AKDashboard/views.py:91
			#, python-format
			msgid "AK \"%(ak)s\" (re-)scheduled."
			msgstr "AK \"%(ak)s\" (um-)geplant."

AKDashboard/migrations/0001_initial.py

+2 −2

Original line number	Original line	Diff line number	Diff line
	@@ -2,7 +2,7 @@

	from django.db import migrations, models		from django.db import migrations, models
	import django.db.models.deletion		import django.db.models.deletion
	import fontawesome_5.fields		import fontawesome_6.fields


	class Migration(migrations.Migration):		class Migration(migrations.Migration):
	@@ -20,7 +20,7 @@ class Migration(migrations.Migration):
	('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),		('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
	('text', models.CharField(help_text='Text that will be shown on the button', max_length=50, verbose_name='Text')),		('text', models.CharField(help_text='Text that will be shown on the button', max_length=50, verbose_name='Text')),
	('url', models.URLField(help_text='URL this button links to', verbose_name='Link URL')),		('url', models.URLField(help_text='URL this button links to', verbose_name='Link URL')),
	('icon', fontawesome_5.fields.IconField(blank=True, default='external-link-alt', help_text='Symbol represeting this button.', max_length=60, verbose_name='Icon')),		('icon', fontawesome_6.fields.IconField(blank=True, default='external-link-alt', help_text='Symbol represeting this button.', max_length=60, verbose_name='Icon')),
	('color', models.PositiveSmallIntegerField(choices=[(0, 'primary'), (1, 'success'), (2, 'info'), (3, 'warning'), (4, 'danger')], default=0, help_text='Style (Color) of this button (bootstrap class)', verbose_name='Button Style')),		('color', models.PositiveSmallIntegerField(choices=[(0, 'primary'), (1, 'success'), (2, 'info'), (3, 'warning'), (4, 'danger')], default=0, help_text='Style (Color) of this button (bootstrap class)', verbose_name='Button Style')),
	('event', models.ForeignKey(help_text='Event this button belongs to', on_delete=django.db.models.deletion.CASCADE, to='AKModel.Event', verbose_name='Event')),		('event', models.ForeignKey(help_text='Event this button belongs to', on_delete=django.db.models.deletion.CASCADE, to='AKModel.Event', verbose_name='Event')),
	],		],

AKDashboard/migrations/0002_update_fa.py

0 → 100644

+19 −0

Original line number	Original line	Diff line number	Diff line
			# Generated by Django 3.2.16 on 2023-01-03 16:50

			from django.db import migrations
			import fontawesome_6.fields


			class Migration(migrations.Migration):

			dependencies = [
			('AKDashboard', '0001_initial'),
			]

			operations = [
			migrations.AlterField(
			model_name='dashboardbutton',
			name='icon',
			field=fontawesome_6.fields.IconField(blank=True, default='external-link-alt', help_text='Symbol represeting this button.', max_length=60, verbose_name='Icon'),
			),
			]

AKDashboard/models.py

+12 −1

Original line number	Original line	Diff line number	Diff line
	from django.db import models		from django.db import models
	from django.utils.translation import gettext_lazy as _		from django.utils.translation import gettext_lazy as _
	from fontawesome_5.fields import IconField		from fontawesome_6.fields import IconField

	from AKModel.models import Event		from AKModel.models import Event


	class DashboardButton(models.Model):		class DashboardButton(models.Model):
			"""
			Model for a single dashboard button

			Allows to specify
			* a text (currently without possibility to translate),
			* a color (based on predefined design colors)
			* a url the button should point to (internal or external)
			* an icon (from the collection of fontawesome)

			Each button is associated with a single event and will be deleted when the event is deleted.
			"""
	class Meta:		class Meta:
	verbose_name = _("Dashboard Button")		verbose_name = _("Dashboard Button")
	verbose_name_plural = _("Dashboard Buttons")		verbose_name_plural = _("Dashboard Buttons")

AKDashboard/static/AKDashboard/style.css

+22 −1

Original line number	Original line	Diff line number	Diff line
	@@ -2,6 +2,10 @@
	margin-bottom: 5em;		margin-bottom: 5em;
	}		}

			.dashboard-row-small {
			margin-bottom: 3em;
			}

	.dashboard-row > .row {		.dashboard-row > .row {
	margin-left: 0;		margin-left: 0;
	padding-bottom: 1em;		padding-bottom: 1em;
	@@ -18,13 +22,30 @@
	}		}

	.dashboard-box {		.dashboard-box {
	display: block;
	padding: 2em;		padding: 2em;
	margin-right: 1em;		margin-right: 1em;
	min-width: 15em;		min-width: 15em;
			margin-bottom: 1em;
	}		}

	.dashboard-button {		.dashboard-button {
	display: inline;		display: inline;
	padding: 0;		padding: 0;
	}		}

			#recent-changes-list {
			list-style-type:none;
			padding-left: 0;
			line-height: 220%;
			}

			#recent-changes-list li {
			font-size: 120%;
			font-family:monospace;
			}

			#recent-changes-list a {
			text-decoration: none;
			color: #555555;
			font-weight: bold;
			}

AKDashboard/templates/AKDashboard/dashboard.html

+21 −65

Original line number	Original line	Diff line number	Diff line
	{% extends 'base.html' %}		{% extends 'base.html' %}

	{% load fontawesome_5 %}		{% load fontawesome_6 %}
	{% load i18n %}		{% load i18n %}
	{% load static %}		{% load static %}
	{% load tags_AKModel %}

	{% block imports %}

	{{ block.super }}

	<link rel="stylesheet" href="{% static 'AKDashboard/style.css' %}">

	{% endblock %}

	{% block breadcrumbs %}		{% block breadcrumbs %}
	<li class="breadcrumb-item">AKPlanning</li>		<li class="breadcrumb-item">AKPlanning</li>
	{% endblock %}		{% endblock %}

	{% block content %}		{% block content %}
	{% for event in events %}		{% include "messages.html" %}
			{% if total_event_count > 0 %}
			{% for event in active_and_current_events %}
	<div class="dashboard-row">		<div class="dashboard-row">
	<h2> {{ event.name }} </h2>		{% include "AKDashboard/dashboard_row.html" %}
	<div class="row">
	{% if 'AKSubmission'\|check_app_installed %}
	<a class="dashboard-box btn btn-primary"
	href="{% url 'submit:ak_list' event_slug=event.slug %}">
	<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
	<span class="fa fa-list-ul"></span>
	<span class='text'>{% trans 'AK List' %}</span>
	</div>
	</a>
	{% endif %}
	{% if 'AKPlan'\|check_app_installed %}

	<a class="dashboard-box btn btn-primary"
	href="{% url 'plan:plan_overview' event_slug=event.slug %}">
	<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
	<span class="fa fa-clock"></span>
	<span class='text'>{% trans 'Current AKs' %}</span>
	</div>
	</a>
	<a class="dashboard-box btn btn-primary"
	href="{% url 'plan:plan_wall' event_slug=event.slug %}">
	<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
	<span class="fa fa-calendar"></span>
	<span class='text'>{% trans 'AK Wall' %}</span>
	</div>
	</a>
	{% endif %}
	{% if 'AKSubmission'\|check_app_installed %}
	<a class="dashboard-box btn btn-primary"
	href="{% url 'submit:submission_overview' event_slug=event.slug %}">
	<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
	<span class="fa fa-pencil-alt"></span>
	<span class='text'>{% trans 'AK Submission' %}</span>
	</div>
	</a>
	{% endif %}
	{% for button in event.dashboardbutton_set.all %}
	<a class="dashboard-box btn btn-{{ button.get_color_display }}"
	href="{{ button.url }}">
	<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
	{% if button.icon %}<span class="fa">{{ button.icon.as_html }}</span>{% endif %}
	<span class='text'>{{ button.text }}</span>
	</div>
	</a>
	{% endfor %}
	</div>
	{% if event.contact_email %}		{% if event.contact_email %}
	<p>		<p>
	<a href="mailto:{{ event.contact_email }}">{% fa5_icon "envelope" "fas" %} {% trans "Write to organizers of this event for questions and comments" %}</a>		<a href="mailto:{{ event.contact_email }}">{% fa6_icon "envelope" "fas" %} {% trans "Write to organizers of this event for questions and comments" %}</a>
	</p>		</p>
	{% endif %}		{% endif %}
	</div>		</div>
	{% empty %}		{% endfor %}
			{% if old_event_count > 0 %}
			<h2 class="mb-3">{% trans "Old events" %}</h2>
			{% for event in old_events %}
			<div class="dashboard-row-small">
			{% include "AKDashboard/dashboard_row_old_event.html" %}
			</div>
			{% endfor %}
			{% endif %}
			{% else %}
	<div class="jumbotron">		<div class="jumbotron">
	<h2 class="display-4">		<h2 class="display-4">
	{% trans 'Currently, there are no Events!' %}		{% trans 'Currently, there are no Events!' %}
	@@ -82,5 +38,5 @@
	{% trans 'Please contact an administrator if you want to use AKPlanning.' %}		{% trans 'Please contact an administrator if you want to use AKPlanning.' %}
	</p>		</p>
	</div>		</div>
	{% endfor %}		{% endif %}
	{% endblock %}		{% endblock %}

AKDashboard/templates/AKDashboard/dashboard_event.html

0 → 100644

+34 −0

Original line number	Original line	Diff line number	Diff line
			{% extends 'base.html' %}

			{% load fontawesome_6 %}
			{% load i18n %}
			{% load static %}
			{% load tags_AKModel %}
			{% load tz %}

			{% block breadcrumbs %}
			<li class="breadcrumb-item"><a href="{% url 'dashboard:dashboard' %}">AKPlanning</a></li>
			<li class="breadcrumb-item active">{{ event }}</li>
			{% endblock %}

			{% block content %}
			{% include "messages.html" %}
			<div class="dashboard-row">
			{% include "AKDashboard/dashboard_row.html" %}

			{% if recent_changes\|length > 0 %}
			<h3 class="mt-1" id="history">{% trans "Recent" %}:</h3>
			<ul id="recent-changes-list">
			{% for recent in recent_changes %}
			<li><a href="{{ recent.link }}">{% fa6_icon recent.icon.0 recent.icon.1 %} {{ recent.text }}</a> <span style="color: #999999;">{{ recent.timestamp \| timezone:event.timezone \| date:"d.m. H:i" }}</span></li>
			{% endfor %}
			</ul>
			{% endif %}

			{% if event.contact_email %}
			<p>
			<a href="mailto:{{ event.contact_email }}">{% fa6_icon "envelope" "fas" %} {% trans "Write to organizers of this event for questions and comments" %}</a>
			</p>
			{% endif %}
			</div>
			{% endblock %}

AKDashboard/templates/AKDashboard/dashboard_row.html

0 → 100644

+86 −0

Original line number	Original line	Diff line number	Diff line
			{% load i18n %}
			{% load tags_AKModel %}
			{% load fontawesome_6 %}

			<h2><a href="{% url 'dashboard:dashboard_event' slug=event.slug %}">{{ event.name }}</a></h2>
			<h4 class="text-muted">
			{% if event.place %}
			<b>{{ event.place }} ·</b>
			{% endif %}
			{{ event \| event_month_year }}
			</h4>
			<div class="mt-2">
			{% if 'AKSubmission'\|check_app_installed %}
			<a class="dashboard-box btn btn-primary"
			href="{% url 'submit:ak_list' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-list-ul"></span>
			<span class='text'>{% trans 'AK List' %}</span>
			</div>
			</a>
			{% endif %}
			{% if 'AKPlan'\|check_app_installed %}
			{% if not event.plan_hidden or user.is_staff %}
			{% if event.active %}
			<a class="dashboard-box btn btn-primary"
			href="{% url 'plan:plan_overview' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-clock"></span>
			<span class='text'>{% trans 'Current AKs' %}</span>
			</div>
			</a>
			<a class="dashboard-box btn btn-primary"
			href="{% url 'plan:plan_wall' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-calendar"></span>
			<span class='text'>{% trans 'AK Wall' %}</span>
			</div>
			</a>
			{% else %}
			<a class="dashboard-box btn btn-primary"
			href="{% url 'plan:plan_overview' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-calendar-alt"></span>
			<span class='text'>{% trans 'Schedule' %}</span>
			</div>
			</a>
			{% endif %}
			{% endif %}
			{% endif %}
			{% if 'AKSubmission'\|check_app_installed and event.active %}
			<a class="dashboard-box btn btn-primary"
			href="{% url 'submit:submission_overview' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-pencil-alt"></span>
			<span class='text'>{% trans 'AK Submission' %}</span>
			</div>
			</a>
			{% endif %}
			<a class="dashboard-box btn btn-primary"
			href="{% url 'dashboard:dashboard_event' slug=event.slug %}#history">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-history"></span>
			<span class='text'>{% trans 'AK History' %}</span>
			</div>
			</a>
			{% if 'AKPreference'\|check_app_installed and event.active %}
			{% if not event.poll_hidden or user.is_staff %}
			<a class="dashboard-box btn btn-primary"
			href="{% url 'poll:poll' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-poll"></span>
			<span class='text'>{% trans 'AK Preferences' %}</span>
			</div>
			</a>
			{% endif %}
			{% endif %}
			{% for button in event.dashboardbutton_set.all %}
			<a class="dashboard-box btn btn-{{ button.get_color_display }}"
			href="{{ button.url }}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			{% if button.icon %}<span class="fa">{{ button.icon.as_html }}</span>{% endif %}
			<span class='text'>{{ button.text }}</span>
			</div>
			</a>
			{% endfor %}
			</div>

AKDashboard/templates/AKDashboard/dashboard_row_old_event.html

0 → 100644

+56 −0

Original line number	Original line	Diff line number	Diff line
			{% load i18n %}
			{% load tags_AKModel %}
			{% load fontawesome_6 %}

			<h3><a href="{% url 'dashboard:dashboard_event' slug=event.slug %}">{{ event.name }}</a>
			<span class="text-muted">
			·
			{% if event.place %}
			{{ event.place }} ·
			{% endif %}
			{{ event \| event_month_year }}
			</span>
			</h3>
			<div class="mt-2">
			{% if 'AKSubmission'\|check_app_installed %}
			<a class="btn btn-primary"
			href="{% url 'submit:ak_list' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-list-ul"></span>
			<span class='text'>{% trans 'AK List' %}</span>
			</div>
			</a>
			{% endif %}
			{% if 'AKPlan'\|check_app_installed %}
			{% if not event.plan_hidden or user.is_staff %}
			<a class="btn btn-primary"
			href="{% url 'plan:plan_overview' event_slug=event.slug %}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-calendar-alt"></span>
			<span class='text'>{% trans 'Schedule' %}</span>
			</div>
			</a>
			{% endif %}
			{% endif %}
			<a class="btn btn-primary"
			href="{% url 'dashboard:dashboard_event' slug=event.slug %}#history">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			<span class="fa fa-history"></span>
			<span class='text'>{% trans 'AK History' %}</span>
			</div>
			</a>
			{% for button in event.dashboardbutton_set.all %}
			<a class="btn btn-{{ button.get_color_display }}"
			href="{{ button.url }}">
			<div class="col-sm-12 col-md-3 col-lg-2 dashboard-button">
			{% if button.icon %}<span class="fa">{{ button.icon.as_html }}</span>{% endif %}
			<span class='text'>{{ button.text }}</span>
			</div>
			</a>
			{% endfor %}
			<a class="btn btn-info"
			href=mailto:{{ event.contact_email }}"
			title="{% trans 'Write to organizers of this event for questions and comments' %}">
			{% fa6_icon "envelope" "fas" %}
			</a>
			</div>

AKDashboard/tests.py

+199 −1

Original line number	Original line	Diff line number	Diff line
	# Create your tests here.		import zoneinfo

			from django.apps import apps
			from django.test import override_settings, TestCase
			from django.urls import reverse
			from django.utils.timezone import now

			from AKDashboard.models import DashboardButton
			from AKModel.models import AK, AKCategory, Event
			from AKModel.tests.test_views import BasicViewTests


			class DashboardTests(TestCase):
			"""
			Specific Dashboard Tests
			"""

			@classmethod
			def setUpTestData(cls):
			"""
			Initialize Test database
			"""
			super().setUpTestData()
			cls.event = Event.objects.create(
			name="Dashboard Test Event",
			slug="dashboardtest",
			timezone=zoneinfo.ZoneInfo("Europe/Berlin"),
			start=now(),
			end=now(),
			active=True,
			plan_hidden=False,
			poll_hidden=False,
			)
			cls.default_category = AKCategory.objects.create(
			name="Test Category",
			event=cls.event,
			)

			def test_dashboard_view(self):
			"""
			Check that the main dashboard is reachable
			(would also be covered by generic view testcase below)
			"""
			url = reverse('dashboard:dashboard_event', kwargs={"slug": self.event.slug})
			response = self.client.get(url)
			self.assertEqual(response.status_code, 200)

			def test_nonexistent_dashboard_view(self):
			"""
			Make sure there is no dashboard for an non-existing event
			"""
			url = reverse('dashboard:dashboard_event', kwargs={"slug": "nonexistent-event"})
			response = self.client.get(url)
			self.assertEqual(response.status_code, 404)

			@override_settings(DASHBOARD_SHOW_RECENT=True)
			def test_history(self):
			"""
			Test displaying of history

			For the sake of that test, the setting to show recent events in dashboard is enforced to be true
			regardless of the default configuration currently in place
			"""
			url = reverse('dashboard:dashboard_event', kwargs={"slug": self.event.slug})

			# History should be empty
			response = self.client.get(url)
			self.assertQuerySetEqual(response.context["recent_changes"], [])

			AK.objects.create(
			name="Test AK",
			category=self.default_category,
			event=self.event,
			)

			# History should now contain one AK (Test AK)
			response = self.client.get(url)
			self.assertEqual(len(response.context["recent_changes"]), 1)
			self.assertEqual(response.context["recent_changes"][0]['text'], "New AK: Test AK.")

			def test_public(self):
			"""
			Test handling of public and private events
			(only public events should be part of the standard dashboard,
			but there should be an individual dashboard for both public and private events)
			"""
			url_dashboard_index = reverse('dashboard:dashboard')
			url_event_dashboard = reverse('dashboard:dashboard_event', kwargs={"slug": self.event.slug})

			# Non-Public event (should not be part of the global dashboard
			# but should have an individual dashboard page for those knowing the url)
			self.event.public = False
			self.event.save()
			response = self.client.get(url_dashboard_index)
			self.assertEqual(response.status_code, 200)
			self.assertFalse(self.event in response.context["active_and_current_events"])
			self.assertFalse(self.event in response.context["old_events"])
			response = self.client.get(url_event_dashboard)
			self.assertEqual(response.status_code, 200)
			self.assertEqual(response.context["event"], self.event)

			# Public event -- should be part of the global dashboard
			self.event.public = True
			self.event.save()
			response = self.client.get(url_dashboard_index)
			self.assertEqual(response.status_code, 200)
			self.assertTrue(self.event in response.context["active_and_current_events"])

			def test_active(self):
			"""
			Test existence of buttons with regard to activity status of the given event
			"""
			url_event_dashboard = reverse('dashboard:dashboard_event', kwargs={"slug": self.event.slug})

			if apps.is_installed('AKSubmission'):
			# Non-active event -> No submission
			self.event.active = False
			self.event.save()
			response = self.client.get(url_event_dashboard)
			self.assertNotContains(response, "AK Submission")

			# Active event -> Submission should be open
			self.event.active = True
			self.event.save()
			response = self.client.get(url_event_dashboard)
			self.assertContains(response, "AK Submission")

			def test_plan_hidden(self):
			"""
			Test visibility of plan buttons with regard to plan visibility status for a given event
			"""
			url_event_dashboard = reverse('dashboard:dashboard_event', kwargs={"slug": self.event.slug})

			if apps.is_installed('AKPlan'):
			# Plan hidden? No buttons should show up
			self.event.plan_hidden = True
			self.event.save()
			response = self.client.get(url_event_dashboard)
			self.assertNotContains(response, "Current AKs")
			self.assertNotContains(response, "AK Wall")

			# Plan not hidden?
			# Buttons for current AKs and AK Wall should be on the page
			self.event.plan_hidden = False
			self.event.save()
			response = self.client.get(url_event_dashboard)
			self.assertContains(response, "Current AKs")
			self.assertContains(response, "AK Wall")

			def test_poll_hidden(self):
			"""
			Test visibility of poll buttons with regard to poll visibility status for a given event
			"""
			url_event_dashboard = reverse('dashboard:dashboard_event', kwargs={"slug": self.event.slug})

			if apps.is_installed('AKPreference'):
			# Poll hidden? No buttons should show up
			self.event.poll_hidden = True
			self.event.save()
			response = self.client.get(url_event_dashboard)
			self.assertNotContains(response, "AK Preferences")

			# Poll not hidden?
			# Buttons to preference poll should be on the page
			self.event.poll_hidden = False
			self.event.save()
			response = self.client.get(url_event_dashboard)
			self.assertContains(response, "AK Preferences")

			def test_dashboard_buttons(self):
			"""
			Make sure manually added buttons are displayed correctly
			"""
			url_event_dashboard = reverse('dashboard:dashboard_event', kwargs={"slug": self.event.slug})

			response = self.client.get(url_event_dashboard)
			self.assertNotContains(response, "Dashboard Button Test")

			DashboardButton.objects.create(
			text="Dashboard Button Test",
			event=self.event
			)

			response = self.client.get(url_event_dashboard)
			self.assertContains(response, "Dashboard Button Test")


			class DashboardViewTests(BasicViewTests, TestCase):
			"""
			Generic view tests, based on :class:`AKModel.BasicViewTests` as specified in this class in VIEWS
			"""
			fixtures = ['model.json', 'dashboard.json']

			APP_NAME = 'dashboard'

			VIEWS = [
			('dashboard', {}),
			('dashboard_event', {'slug': 'kif42'}),
			]

AKDashboard/urls.py

+1 −0

Original line number	Original line	Diff line number	Diff line
	@@ -6,4 +6,5 @@ app_name = "dashboard"

	urlpatterns = [		urlpatterns = [
	path('', views.DashboardView.as_view(), name="dashboard"),		path('', views.DashboardView.as_view(), name="dashboard"),
			path('<slug:slug>/', views.DashboardEventView.as_view(), name='dashboard_event'),
	]		]

AKDashboard/views.py

+87 −3

Original line number	Original line	Diff line number	Diff line
			from django.apps import apps
	from django.utils.decorators import method_decorator		from django.utils.decorators import method_decorator
	from django.views.decorators.csrf import ensure_csrf_cookie		from django.views.decorators.csrf import ensure_csrf_cookie
	from django.views.generic import TemplateView		from django.views.generic import TemplateView, DetailView
			from django.utils.translation import gettext_lazy as _

	from AKModel.models import Event		from AKModel.models import Event, AK, AKSlot
			from AKPlanning import settings


	class DashboardView(TemplateView):		class DashboardView(TemplateView):
			"""
			Index view of dashboard and therefore the main entry point for AKPlanning

			Displays information and buttons for all public events
			"""
	template_name = 'AKDashboard/dashboard.html'		template_name = 'AKDashboard/dashboard.html'

	@method_decorator(ensure_csrf_cookie)		@method_decorator(ensure_csrf_cookie)
	@@ -14,5 +22,81 @@ class DashboardView(TemplateView):

	def get_context_data(self, **kwargs):		def get_context_data(self, **kwargs):
	context = super().get_context_data(**kwargs)		context = super().get_context_data(**kwargs)
	context['events'] = Event.objects.all()		# Load events and split between active and current/featured events and those that should show smaller below
			context["active_and_current_events"] = []
			context["old_events"] = []
			events = Event.objects.filter(public=True).order_by("-active", "-pk").prefetch_related('dashboardbutton_set')
			for event in events:
			if event.active or len(context["active_and_current_events"]) < settings.DASHBOARD_MAX_FEATURED_EVENTS:
			context["active_and_current_events"].append(event)
			else:
			context["old_events"].append(event)
			context["active_event_count"] = len(context["active_and_current_events"])
			context["old_event_count"] = len(context["old_events"])
			context["total_event_count"] = context["active_event_count"] + context["old_event_count"]
			return context


			class DashboardEventView(DetailView):
			"""
			Dashboard view for a single event

			In addition to the basic information and the buttons,
			an overview over recent events (new and changed AKs, moved AKSlots) for the given event is shown.

			The event dashboard also exists for non-public events (one only needs to know the URL/slug of the event).
			"""
			template_name = 'AKDashboard/dashboard_event.html'
			context_object_name = 'event'
			model = Event

			def get_context_data(self, **kwargs):
			context = super().get_context_data(**kwargs)

			# Show feed of recent changes (if activated)
			if settings.DASHBOARD_SHOW_RECENT:
			# Create a list of chronically sorted events (both AK and plan changes):
			recent_changes = []

			# Newest AKs (if AKSubmission is used)
			if apps.is_installed("AKSubmission"):
			# Get the latest x changes (if there are that many),
			# where x corresponds to the entry threshold configured in the settings
			# (such that the list will be completely filled even if there are no (newer) plan changes)
			submission_changes = AK.history.filter(event=context['event'])[:int(settings.DASHBOARD_RECENT_MAX)] # pylint: disable=no-member, line-too-long
			# Create textual representation including icons
			for s in submission_changes:
			if s.history_type == '+':
			text = _('New AK: %(ak)s.') % {'ak': s.name}
			icon = ('plus-square', 'far')
			elif s.history_type == '~':
			text = _('AK "%(ak)s" edited.') % {'ak': s.name}
			icon = ('pen-square', 'fas')
			else:
			text = _('AK "%(ak)s" deleted.') % {'ak': s.name}
			icon = ('times', 'fas')

			# Store representation in change list (still unsorted)
			recent_changes.append(
			{'icon': icon, 'text': text, 'link': s.instance.detail_url, 'timestamp': s.history_date}
			)

			# Changes in plan (if AKPlan is used and plan is publicly visible)
			if apps.is_installed("AKPlan") and not context['event'].plan_hidden:
			# Get the latest plan changes (again using a threshold, see above)
			last_changed_slots = AKSlot.objects.select_related('ak').filter(event=context['event'], start__isnull=False).order_by('-updated')[:int(settings.DASHBOARD_RECENT_MAX)] #pylint: disable=line-too-long
			for changed_slot in last_changed_slots:
			# Create textual representation including icons and links and store in list (still unsorted)
			recent_changes.append({'icon': ('clock', 'far'),
			'text': _('AK "%(ak)s" (re-)scheduled.') % {'ak': changed_slot.ak.name},
			'link': changed_slot.ak.detail_url,
			'timestamp': changed_slot.updated})

			# Sort by change date...
			recent_changes.sort(key=lambda x: x['timestamp'], reverse=True)
			# ... and restrict to the latest 25 changes
			context['recent_changes'] = recent_changes[:int(settings.DASHBOARD_RECENT_MAX)]
			else:
			context['recent_changes'] = []

	return context		return context

AKModel/admin.py

+643 −55

File changed.

Preview size limit exceeded, changes collapsed.

AKModel/apps.py

+12 −0

Original line number	Original line	Diff line number	Diff line
	from django.apps import AppConfig		from django.apps import AppConfig
			from django.contrib.admin.apps import AdminConfig


	class AkmodelConfig(AppConfig):		class AkmodelConfig(AppConfig):
			"""
			App configuration (default, only specifies name of the app)
			"""
	name = 'AKModel'		name = 'AKModel'


			class AKAdminConfig(AdminConfig):
			"""
			App configuration for admin
			Loading a custom version here allows to add additional contex and further adapt the behavior of the admin interface
			"""
			default_site = 'AKModel.site.AKAdminSite'

AKModel/availability/init.py

0 → 100644

+0 −0

Original line number	Original line	Diff line number	Diff line

AKModel/availability/forms.py

0 → 100644

+208 −0

Original line number	Original line	Diff line number	Diff line
			# This part of the code was adapted from pretalx (https://github.com/pretalx/pretalx)
			# Copyright 2017-2019, Tobias Kunze
			# Original Copyrights licensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
			# Documentation was mainly added by us, other changes are marked in the code
			import datetime
			import json

			from django import forms
			from django.db import transaction
			from django.db.models.signals import post_save
			from django.utils.dateparse import parse_datetime
			from django.utils.translation import gettext_lazy as _

			from AKModel.availability.models import Availability
			from AKModel.availability.serializers import AvailabilityFormSerializer
			from AKModel.models import Event


			class AvailabilitiesFormMixin(forms.Form):
			"""
			Mixin for forms to add availabilities functionality to it
			Will handle the rendering and population of an availabilities field
			"""
			availabilities = forms.CharField(
			label=_('Availability'),
			help_text=_(
			'Click and drag to mark the availability during the event, double-click to delete. '
			'Or use the start and end inputs to add entries to the calendar view.' # Adapted help text
			),
			widget=forms.TextInput(attrs={'class': 'availabilities-editor-data'}),
			required=False,
			)

			def _serialize(self, event, instance):
			"""
			Serialize relevant availabilities into a JSON format to populate the text field in the form

			:param event: event the availabilities belong to (relevant for start and end times)
			:param instance: the entity availabilities in this form should belong to (e.g., an AK, or a Room)
			:return: JSON serializiation of the relevant availabilities
			:rtype: str
			"""
			if instance:
			availabilities = instance.availabilities.all()
			else:
			availabilities = []

			return json.dumps(AvailabilityFormSerializer((availabilities, event)).data)

			def __init__(self, args, *kwargs):
			super().__init__(args, *kwargs)
			# Load event information and populate availabilities text field
			self.event = self.initial.get('event')
			if isinstance(self.event, int):
			self.event = Event.objects.get(pk=self.event)
			initial = kwargs.pop('initial', {})
			if 'availabilities' not in initial:
			initial['availabilities'] = self._serialize(self.event, kwargs.get('instance'))
			if not isinstance(self, forms.BaseModelForm):
			kwargs.pop('instance', None)
			kwargs['initial'] = initial

			def _parse_availabilities_json(self, jsonavailabilities):
			"""
			Turn raw JSON availabilities into a list of model instances

			:param jsonavailabilities: raw json input
			:return: a list of availability objects corresponding to the raw input
			:rtype: List[Availability]
			"""
			try:
			rawdata = json.loads(jsonavailabilities)
			except ValueError as exc:
			raise forms.ValidationError("Submitted availabilities are not valid json.") from exc
			if not isinstance(rawdata, dict):
			raise forms.ValidationError(
			"Submitted json does not comply with expected format, should be object."
			)
			availabilities = rawdata.get('availabilities')
			if not isinstance(availabilities, list):
			raise forms.ValidationError(
			"Submitted json does not comply with expected format, missing or malformed availabilities field"
			)
			return availabilities

			def _parse_datetime(self, strdate):
			"""
			Parse input date string
			This will try to correct timezone information if needed

			:param strdate: string representing a timestamp
			:return: a timestamp object
			"""
			tz = self.event.timezone # adapt to our event model

			obj = parse_datetime(strdate)
			if not obj:
			raise TypeError
			if obj.tzinfo is None:
			# Adapt to new python timezone interface
			obj = obj.replace(tzinfo=tz)

			return obj

			def _validate_availability(self, rawavail):
			"""
			Validate a raw availability instance input by making sure the relevant fields are present and can be parsed
			The cleaned up values that are produced to test the validity of the input are stored in-place in the input
			object for later usage in cleaning/parsing to availability objects

			:param rawavail: object to validate/clean
			"""
			message = _("The submitted availability does not comply with the required format.")
			if not isinstance(rawavail, dict):
			raise forms.ValidationError(message)
			rawavail.pop('id', None)
			rawavail.pop('allDay', None)
			if not set(rawavail.keys()) == {'start', 'end'}:
			raise forms.ValidationError(message)

			try:
			rawavail['start'] = self._parse_datetime(rawavail['start'])
			rawavail['end'] = self._parse_datetime(rawavail['end'])
			# Adapt: Better error handling
			except (TypeError, ValueError) as exc:
			raise forms.ValidationError(
			_("The submitted availability contains an invalid date.")
			) from exc

			timeframe_start = self.event.start # adapt to our event model
			if rawavail['start'] < timeframe_start:
			rawavail['start'] = timeframe_start

			# add 1 day, not 24 hours, https://stackoverflow.com/a/25427822/2486196
			timeframe_end = self.event.end # adapt to our event model
			timeframe_end = timeframe_end + datetime.timedelta(days=1)
			if rawavail['end'] > timeframe_end:
			# If the submitted availability ended outside the event timeframe, fix it silently
			rawavail['end'] = timeframe_end

			def clean_availabilities(self):
			"""
			Turn raw availabilities into real availability objects
			:return:
			"""
			data = self.cleaned_data.get('availabilities')
			required = (
			'availabilities' in self.fields and self.fields['availabilities'].required
			)
			if not data:
			if required:
			raise forms.ValidationError(_('Please fill in your availabilities!'))
			return None

			rawavailabilities = self._parse_availabilities_json(data)
			availabilities = []

			for rawavail in rawavailabilities:
			self._validate_availability(rawavail)
			availabilities.append(Availability(event_id=self.event.id, **rawavail))
			if not availabilities and required:
			raise forms.ValidationError(_('Please fill in your availabilities!'))
			return availabilities

			def _set_foreignkeys(self, instance, availabilities):
			"""
			Set the reference to `instance` in each given availability.
			For example, set the availabilitiy.room_id to instance.id, in
			case instance of type Room.
			"""
			reference_name = instance.availabilities.field.name + '_id'

			for avail in availabilities:
			setattr(avail, reference_name, instance.id)

			def _replace_availabilities(self, instance, availabilities: list[Availability]):
			"""
			Replace the existing list of availabilities belonging to an entity with a new, updated one

			This will trigger a post_save signal for usage in constraint violation checking

			:param instance: entity the availabilities belong to
			:param availabilities: list of new availabilities
			"""
			with transaction.atomic():
			# TODO: do not recreate objects unnecessarily, give the client the IDs, so we can track modifications and
			# leave unchanged objects alone
			instance.availabilities.all().delete()
			Availability.objects.bulk_create(availabilities)
			# Adaption:
			# Trigger post save signal manually to make sure constraints are updated accordingly
			# Doing this one time is sufficient, since this will nevertheless update all availability constraint
			# violations of the corresponding AK
			if len(availabilities) > 0:
			post_save.send(Availability, instance=availabilities[0], created=True)

			def save(self, args, *kwargs):
			"""
			Override the saving method of the (model) form
			"""
			instance = super().save(args, *kwargs)
			availabilities = self.cleaned_data.get('availabilities')

			if availabilities is not None:
			self._set_foreignkeys(instance, availabilities)
			self._replace_availabilities(instance, availabilities)

			return instance # adapt to our forms

AKModel/availability.py→AKModel/availability/models.py

+113 −8

Original line number	Original line	Diff line number	Diff line
	@@ -11,6 +11,8 @@ from django.utils.functional import cached_property
	from django.utils.translation import gettext_lazy as _		from django.utils.translation import gettext_lazy as _

	from AKModel.models import Event, AKOwner, Room, AK, AKCategory		from AKModel.models import Event, AKOwner, Room, AK, AKCategory
			# TODO: Decouple from AKPreference app
			from AKPreference.models import EventParticipant

	zero_time = datetime.time(0, 0)		zero_time = datetime.time(0, 0)

	@@ -21,8 +23,12 @@ zero_time = datetime.time(0, 0)
	# remove serialization as requirements are not covered		# remove serialization as requirements are not covered
	# add translation		# add translation
	# add meta class		# add meta class
	# enable availabilites for AKs and AKCategories		# enable availabilities for AKs and AKCategories
	# add verbose names and help texts to model attributes		# add verbose names and help texts to model attributes
			# adapt or extemd documentation
			# add participants


	class Availability(models.Model):		class Availability(models.Model):
	"""The Availability class models when people or rooms are available for.		"""The Availability class models when people or rooms are available for.

	@@ -31,6 +37,8 @@ class Availability(models.Model):
	span multiple days, but due to our choice of input widget, it will		span multiple days, but due to our choice of input widget, it will
	usually only span a single day at most.		usually only span a single day at most.
	"""		"""
			# pylint: disable=broad-exception-raised

	event = models.ForeignKey(		event = models.ForeignKey(
	to=Event,		to=Event,
	related_name='availabilities',		related_name='availabilities',
	@@ -74,20 +82,48 @@ class Availability(models.Model):
	verbose_name=_('AK Category'),		verbose_name=_('AK Category'),
	help_text=_('AK Category whose availability this is'),		help_text=_('AK Category whose availability this is'),
	)		)
			participant = models.ForeignKey(
			to=EventParticipant,
			related_name='availabilities',
			on_delete=models.CASCADE,
			null=True,
			blank=True,
			verbose_name=_('Participant'),
			help_text=_('Participant whose availability this is'),
			)
	start = models.DateTimeField()		start = models.DateTimeField()
	end = models.DateTimeField()		end = models.DateTimeField()

	def __str__(self) -> str:		def __str__(self) -> str:
	person = self.person.name if self.person else None		person = self.person.name if self.person else None
			participant = str(self.participant) if self.participant else None
	room = getattr(self.room, 'name', None)		room = getattr(self.room, 'name', None)
	event = getattr(getattr(self, 'event', None), 'name', None)		event = getattr(getattr(self, 'event', None), 'name', None)
	ak = getattr(self.ak, 'name', None)		ak = getattr(self.ak, 'name', None)
	ak_category = getattr(self.ak_category, 'name', None)		ak_category = getattr(self.ak_category, 'name', None)
	return f'Availability(event={event}, person={person}, room={room}, ak={ak}, ak category={ak_category})'		arg_list = [
			f"event={event}",
			f"person={person}",
			f"room={room}",
			f"ak={ak}",
			f"ak category={ak_category}",
			f"participant={participant}",
			]
			return f'Availability({", ".join(arg_list)})'

	def __hash__(self):		def __hash__(self):
	return hash(		return hash(
	(getattr(self, 'event', None), self.person, self.room, self.ak, self.ak_category, self.start, self.end))		(
			getattr(self, 'event', None),
			self.person,
			self.room,
			self.ak,
			self.ak_category,
			self.participant,
			self.start,
			self.end,
			)
			)

	def __eq__(self, other: 'Availability') -> bool:		def __eq__(self, other: 'Availability') -> bool:
	"""Comparisons like ``availability1 == availability2``.		"""Comparisons like ``availability1 == availability2``.
	@@ -96,10 +132,10 @@ class Availability(models.Model):
	are the same.		are the same.
	"""		"""
	return all(		return all(
	[		(
	getattr(self, attribute, None) == getattr(other, attribute, None)		getattr(self, attribute, None) == getattr(other, attribute, None)
	for attribute in ['event', 'person', 'room', 'ak', 'ak_category', 'start', 'end']		for attribute in ['event', 'person', 'room', 'ak', 'ak_category', 'participant', 'start', 'end']
	]		)
	)		)

	@cached_property		@cached_property
	@@ -146,9 +182,12 @@ class Availability(models.Model):
	if not other.overlaps(self, strict=False):		if not other.overlaps(self, strict=False):
	raise Exception('Only overlapping Availabilities can be merged.')		raise Exception('Only overlapping Availabilities can be merged.')

	return Availability(		avail = Availability(
	start=min(self.start, other.start), end=max(self.end, other.end)		start=min(self.start, other.start), end=max(self.end, other.end)
	)		)
			if self.event == other.event:
			avail.event = self.event
			return avail

	def __or__(self, other: 'Availability') -> 'Availability':		def __or__(self, other: 'Availability') -> 'Availability':
	"""Performs the merge operation: ``availability1 \| availability2``"""		"""Performs the merge operation: ``availability1 \| availability2``"""
	@@ -163,9 +202,12 @@ class Availability(models.Model):
	if not other.overlaps(self, False):		if not other.overlaps(self, False):
	raise Exception('Only overlapping Availabilities can be intersected.')		raise Exception('Only overlapping Availabilities can be intersected.')

	return Availability(		avail = Availability(
	start=max(self.start, other.start), end=min(self.end, other.end)		start=max(self.start, other.start), end=min(self.end, other.end)
	)		)
			if self.event == other.event:
			avail.event = self.event
			return avail

	def __and__(self, other: 'Availability') -> 'Availability':		def __and__(self, other: 'Availability') -> 'Availability':
	"""Performs the intersect operation: ``availability1 &		"""Performs the intersect operation: ``availability1 &
	@@ -231,6 +273,69 @@ class Availability(models.Model):
	result = cls._pair_intersection(result, availset)		result = cls._pair_intersection(result, availset)
	return result		return result

			@property
			def simplified(self):
			"""
			Get a simplified (only Weekday, hour and minute) string representation of an availability
			:return: simplified string version
			:rtype: str
			"""
			return (f'{self.start.astimezone(self.event.timezone).strftime("%a %H:%M")}-'
			f'{self.end.astimezone(self.event.timezone).strftime("%a %H:%M")}')

			@classmethod
			def with_event_length(
			cls,
			event: Event,
			person: AKOwner \| None = None,
			room: Room \| None = None,
			ak: AK \| None = None,
			ak_category: AKCategory \| None = None,
			participant: EventParticipant \| None = None,
			) -> "Availability":
			"""
			Create an availability covering exactly the time between event start and event end.
			Can e.g., be used to create default availabilities.

			:param event: relevant event
			:param person: person, if availability should be connected to a person
			:param room: room, if availability should be connected to a room
			:param ak: ak, if availability should be connected to a ak
			:param ak_category: ak_category, if availability should be connected to a ak_category
			:return: availability associated to the entity oder entities selected
			:rtype: Availability
			"""
			timeframe_start = event.start # adapt to our event model
			# add 1 day, not 24 hours, https://stackoverflow.com/a/25427822/2486196
			timeframe_end = event.end # adapt to our event model
			timeframe_end = timeframe_end + datetime.timedelta(days=1)
			return Availability(start=timeframe_start, end=timeframe_end, event=event, person=person,
			room=room, ak=ak, ak_category=ak_category, participant=participant)

			def is_covered(self, availabilities: List['Availability']):
			"""Check if list of availibilities cover this object.

			:param availabilities: availabilities to check.
			:return: whether the availabilities cover full event.
			:rtype: bool
			"""
			avail_union = Availability.union(availabilities)
			return any(avail.contains(self) for avail in avail_union)

			@classmethod
			def is_event_covered(cls, event: Event, availabilities: List['Availability']) -> bool:
			"""Check if list of availibilities cover whole event.

			:param event: event to check.
			:param availabilities: availabilities to check.
			:return: whether the availabilities cover full event.
			:rtype: bool
			"""
			# NOTE: Cannot use `Availability.with_event_length` as its end is the
			# event end + 1 day
			full_event = Availability(event=event, start=event.start, end=event.end)
			return full_event.is_covered(availabilities)

	class Meta:		class Meta:
	verbose_name = _('Availability')		verbose_name = _('Availability')
	verbose_name_plural = _('Availabilities')		verbose_name_plural = _('Availabilities')

AKModel/availability/serializers.py

0 → 100644

+72 −0

Original line number	Original line	Diff line number	Diff line
			# This part of the code was adapted from pretalx (https://github.com/pretalx/pretalx)
			# Copyright 2017-2019, Tobias Kunze
			# Original Copyrights licensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
			# Documentation was mainly added by us, other changes are marked in the code
			from django.utils import timezone
			from rest_framework.fields import SerializerMethodField
			from rest_framework.serializers import BaseSerializer, ModelSerializer

			from AKModel.availability.models import Availability
			from AKModel.models import Event


			class AvailabilitySerializer(ModelSerializer):
			"""
			REST Framework Serializer for Availability
			"""
			allDay = SerializerMethodField()
			start = SerializerMethodField()
			end = SerializerMethodField()

			def get_allDay(self, obj): # pylint: disable=invalid-name
			"""
			Bridge between naming conventions of python and fullcalendar by providing the all_day field as allDay, too
			"""
			return obj.all_day

			def get_start(self, obj):
			"""
			Get start timestamp

			Use already localized strings in serialized field
			(default would be UTC, but that would require heavy timezone calculation on client side)
			"""
			return timezone.localtime(obj.start, obj.event.timezone).strftime("%Y-%m-%dT%H:%M:%S")

			def get_end(self, obj):
			"""
			Get end timestamp

			Use already localized strings in serialized field
			(default would be UTC, but that would require heavy timezone calculation on client side)
			"""
			return timezone.localtime(obj.end, obj.event.timezone).strftime("%Y-%m-%dT%H:%M:%S")

			class Meta:
			model = Availability
			fields = ('id', 'start', 'end', 'allDay')


			class AvailabilityFormSerializer(BaseSerializer):
			"""Serializer to configure an availability form."""

			def create(self, validated_data):
			raise ValueError("`AvailabilityFormSerializer` is read-only.")

			def to_internal_value(self, data):
			raise ValueError("`AvailabilityFormSerializer` is read-only.")

			def update(self, instance, validated_data):
			raise ValueError("`AvailabilityFormSerializer` is read-only.")

			def to_representation(self, instance: tuple[Availability, Event], **kwargs):
			availabilities, event = instance

			return {
			'availabilities': AvailabilitySerializer(availabilities, many=True).data,
			'event': {
			# 'timezone': event.timezone,
			'date_from': str(event.start),
			'date_to': str(event.end),
			},
			}

AKModel/environment.py

0 → 100644

+35 −0

Original line number	Original line	Diff line number	Diff line
			"""
			Environment definitions
			Needed for tex compilation
			"""
			import re

			from django_tex.environment import environment

			# Used to filter all very special UTF-8 chars that are probably not contained in the LaTeX fonts
			# and would hence cause compilation errors
			utf8_replace_pattern = re.compile('[^\u0000-\u206F]', re.UNICODE)


			def latex_escape_utf8(value):
			"""
			Escape latex special chars and remove invalid utf-8 values

			:param value: string to escape
			:type value: str
			:return: escaped string
			:rtype: str
			"""
			return (utf8_replace_pattern.sub('', value).replace('&', r'\&').replace('_', r'\_').replace('#', r'\#').
			replace('$', r'\$').replace('%', r'\%').replace('{', r'\{').replace('}', r'\}'))


			def improved_tex_environment(**options):
			"""
			Encapsulate our improved latex environment for usage
			"""
			env = environment(**options)
			env.filters.update({
			'latex_escape_utf8': latex_escape_utf8,
			})
			return env

Compare revisions

Source

Target

Files

Some changes are not shown.

.docker/entrypoint.sh

.docker/extra_requirements.txt

.docker/uwsgi.ini

.dockerignore

.gitignore

.gitlab-ci.yml

AKDashboard/admin.py

AKDashboard/apps.py

AKDashboard/fixtures/dashboard.json

AKDashboard/locale/de_DE/LC_MESSAGES/django.po

AKDashboard/migrations/0001_initial.py

AKDashboard/migrations/0002_update_fa.py

AKDashboard/models.py

AKDashboard/static/AKDashboard/style.css

AKDashboard/templates/AKDashboard/dashboard.html

AKDashboard/templates/AKDashboard/dashboard_event.html

AKDashboard/templates/AKDashboard/dashboard_row.html

AKDashboard/templates/AKDashboard/dashboard_row_old_event.html

AKDashboard/tests.py

AKDashboard/urls.py

AKDashboard/views.py

AKModel/admin.py

AKModel/apps.py

AKModel/availability/init.py

AKModel/availability/forms.py

AKModel/availability.py→AKModel/availability/models.py

AKModel/availability/serializers.py

AKModel/environment.py