From 5962536a11b6215b40fdc1a03e3d4e5a3835549f Mon Sep 17 00:00:00 2001 From: luelista Date: Tue, 27 May 2025 07:17:50 +0200 Subject: [PATCH] Dialog for cart renewal, async task without page refresh (#5148) * async_task: deduplicate response handling code * extend cart without full page reload * update dialog markup * fix error response from CartExtend * refactor asynctask, make sure waitingDialog.show() re-initializes dialog contents * add cart expiry notification * add aria references to other dialogs * improve error handling * fix error if max_extend=None * different message for expiring soon and expired carts * refactor dialog css * add classes to further dialog elements * switch extend-cart-dialog and loadingmodal to * Backport simple_block_tag from Django 5.2 * Use simple_block_tag for {% dialog %} tag * add alertdialog role * Update src/pretix/static/pretixbase/scss/_dialogs.scss Co-authored-by: Richard Schreiber * fix mobile dialog styles not being overwritten * asynctask dialog: prevent close by escape on chrome * remove dynamic aria-live from #cart-deadline dynamic aria-live is generally not well supported and as we have the dialog now anyways, we can remove it * move continue-button to right * Update src/pretix/static/pretixpresale/js/ui/cart.js Co-authored-by: Richard Schreiber * Fix CSS for old-style dialog * fix heading display/level * align dialogs at the top as they originally were * fix from merge-conflict * fix missing grow for dialog-content * improve cart-extend-button ui * do not show cart-extend-dialog onload * improve message if 0 minutes * do not save messae in session if ajax_dont_redirect * add ajax_dont_redirect to async_task_check_url * improve draw_deadline to only update #cart-deadline if necessary * add renew-confirmation-message --------- Co-authored-by: Richard Schreiber Co-authored-by: Raphael Michel --- src/pretix/base/services/cart.py | 4 +- src/pretix/base/templatetags/dialog.py | 33 +- src/pretix/base/views/tasks.py | 20 +- .../control/templates/pretixcontrol/base.html | 27 +- .../helpers/templatetags/simple_block_tag.py | 133 ++++++++ .../pretixpresale/event/fragment_cart.html | 11 +- .../event/fragment_cart_box.html | 2 +- .../pretixpresale/fragment_modals.html | 34 ++- src/pretix/presale/views/__init__.py | 3 + src/pretix/presale/views/cart.py | 10 +- src/pretix/static/pretixbase/js/asynctask.js | 288 ++++++++++-------- .../static/pretixbase/scss/_dialogs.scss | 174 +++++++++++ src/pretix/static/pretixbase/scss/_theme.scss | 114 ------- src/pretix/static/pretixcontrol/js/ui/main.js | 26 -- .../static/pretixcontrol/scss/main.scss | 86 +----- src/pretix/static/pretixpresale/js/ui/cart.js | 92 +++++- src/pretix/static/pretixpresale/js/ui/main.js | 2 - src/pretix/static/pretixpresale/js/ui/sso.js | 8 +- .../static/pretixpresale/scss/main.scss | 110 +------ 19 files changed, 621 insertions(+), 556 deletions(-) create mode 100644 src/pretix/helpers/templatetags/simple_block_tag.py create mode 100644 src/pretix/static/pretixbase/scss/_dialogs.scss diff --git a/src/pretix/base/services/cart.py b/src/pretix/base/services/cart.py index 14099b8c1..5212b1307 100644 --- a/src/pretix/base/services/cart.py +++ b/src/pretix/base/services/cart.py @@ -1655,7 +1655,7 @@ def clear_cart(self, event: Event, cart_id: str=None, locale='en', sales_channel @app.task(base=ProfiledEventTask, bind=True, max_retries=5, default_retry_delay=1, throws=(CartError,)) -def extend_cart_reservation(self, event: Event, cart_id: str=None, locale='en', sales_channel='web', override_now_dt: datetime=None) -> None: +def extend_cart_reservation(self, event: Event, cart_id: str=None, locale='en', sales_channel='web', override_now_dt: datetime=None) -> dict: """ Resets the expiry time of a cart to the configured reservation time of this event. Limited to 11x the reservation time. @@ -1672,7 +1672,7 @@ def extend_cart_reservation(self, event: Event, cart_id: str=None, locale='en', try: cm = CartManager(event=event, cart_id=cart_id, sales_channel=sales_channel) cm.commit() - return cm.num_extended_positions + return {"success": cm.num_extended_positions, "expiry": cm._expiry, "max_expiry_extend": cm._max_expiry_extend} except LockTimeoutException: self.retry() except (MaxRetriesExceededError, LockTimeoutException): diff --git a/src/pretix/base/templatetags/dialog.py b/src/pretix/base/templatetags/dialog.py index 16805cecc..0cc422455 100644 --- a/src/pretix/base/templatetags/dialog.py +++ b/src/pretix/base/templatetags/dialog.py @@ -23,38 +23,39 @@ from django import template from django.utils.html import format_html from django.utils.safestring import mark_safe +from pretix.helpers.templatetags.simple_block_tag import ( + register_simple_block_tag, +) + from django.utils.translation import gettext_lazy as _ # NOQA + register = template.Library() -@register.simple_tag -def dialog(html_id, label, description, *args, **kwargs): +@register_simple_block_tag(register) +def dialog(content, html_id, title, description, *args, **kwargs): format_kwargs = { "id": html_id, - "label": label, + "title": title, "description": description, "icon": format_html('
', kwargs["icon"]) if "icon" in kwargs else "", "alert": mark_safe('role="alertdialog"') if kwargs.get("alert", "False") != "False" else "", + "content": content, } result = """ -
+ {icon}
-

{label}

-

{description}

- """ - return format_html(result, **format_kwargs) - - -@register.simple_tag -def enddialog(*args, **kwargs): - return mark_safe(""" + + + {content}
- """) + """ + return format_html(result, **format_kwargs) diff --git a/src/pretix/base/views/tasks.py b/src/pretix/base/views/tasks.py index 8a9e6e909..949cef639 100644 --- a/src/pretix/base/views/tasks.py +++ b/src/pretix/base/views/tasks.py @@ -68,7 +68,7 @@ class AsyncMixin: def get_check_url(self, task_id, ajax): return self.request.path + '?async_id=%s' % task_id + ('&ajax=1' if ajax else '') - def _ajax_response_data(self): + def _ajax_response_data(self, value): return {} def _return_ajax_result(self, res, timeout=.5): @@ -85,7 +85,7 @@ class AsyncMixin: logger.warning('Ignored ResponseError in AsyncResult.get()') except ConnectionError: # Redis probably just restarted, let's just report not ready and retry next time - data = self._ajax_response_data() + data = self._ajax_response_data(None) data.update({ 'async_id': res.id, 'ready': False @@ -93,7 +93,7 @@ class AsyncMixin: return data state, info = res.state, res.info - data = self._ajax_response_data() + data = self._ajax_response_data(info) data.update({ 'async_id': res.id, 'ready': ready, @@ -102,23 +102,21 @@ class AsyncMixin: if ready: if state == states.SUCCESS and not isinstance(info, Exception): smes = self.get_success_message(info) - if smes: + if smes and 'ajax_dont_redirect' not in self.request.GET and 'ajax_dont_redirect' not in self.request.POST: messages.success(self.request, smes) - # TODO: Do not store message if the ajax client states that it will not redirect - # but handle the message itself data.update({ 'redirect': self.get_success_url(info), 'success': True, - 'message': str(self.get_success_message(info)) + 'message': str(smes) }) else: - messages.error(self.request, self.get_error_message(info)) - # TODO: Do not store message if the ajax client states that it will not redirect - # but handle the message itself + smes = self.get_error_message(info) + if smes and 'ajax_dont_redirect' not in self.request.GET and 'ajax_dont_redirect' not in self.request.POST: + messages.error(self.request, smes) data.update({ 'redirect': self.get_error_url(), 'success': False, - 'message': str(self.get_error_message(info)) + 'message': str(smes) }) elif state == 'PROGRESS': data.update({ diff --git a/src/pretix/control/templates/pretixcontrol/base.html b/src/pretix/control/templates/pretixcontrol/base.html index 79d9c5f52..edd858c33 100644 --- a/src/pretix/control/templates/pretixcontrol/base.html +++ b/src/pretix/control/templates/pretixcontrol/base.html @@ -4,6 +4,8 @@ {% load statici18n %} {% load eventsignal %} {% load eventurl %} +{% load dialog %} +{% load icon %} @@ -463,25 +465,16 @@ -
+ -
-
-
- -
-
-

-

-

{% trans "If this takes longer than a few minutes, please contact us." %}

-
-
-
-
-
-
+ {% dialog "loadingmodal" "" "" icon="cog rotating" %} +

{% trans "If this takes longer than a few minutes, please contact us." %}

+
+
-
+
+
+ {% enddialog %} diff --git a/src/pretix/helpers/templatetags/simple_block_tag.py b/src/pretix/helpers/templatetags/simple_block_tag.py new file mode 100644 index 000000000..a71bab7b0 --- /dev/null +++ b/src/pretix/helpers/templatetags/simple_block_tag.py @@ -0,0 +1,133 @@ +# +# This file is part of pretix (Community Edition). +# +# Copyright (C) 2014-2020 Raphael Michel and contributors +# Copyright (C) 2020-2021 rami.io GmbH and contributors +# +# This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General +# Public License as published by the Free Software Foundation in version 3 of the License. +# +# ADDITIONAL TERMS APPLY: Pursuant to Section 7 of the GNU Affero General Public License, additional terms are +# applicable granting you additional permissions and placing additional restrictions on your usage of this software. +# Please refer to the pretix LICENSE file to obtain the full terms applicable to this work. If you did not receive +# this file, see . +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied +# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more +# details. +# +# You should have received a copy of the GNU Affero General Public License along with this program. If not, see +# . +# + +# +# backport from Django 5.2 (django/django/template/library.py) +# +# TODO: remove once we upgrade to Django 5.2 + +from functools import wraps +from inspect import getfullargspec, unwrap + +from django.template.exceptions import TemplateSyntaxError +from django.template.library import SimpleNode, parse_bits + + +class SimpleBlockNode(SimpleNode): + def __init__(self, nodelist, *args, **kwargs): + super().__init__(*args, **kwargs) + self.nodelist = nodelist + + def get_resolved_arguments(self, context): + resolved_args, resolved_kwargs = super().get_resolved_arguments(context) + + # Restore the "content" argument. + # It will move depending on whether takes_context was passed. + resolved_args.insert( + 1 if self.takes_context else 0, self.nodelist.render(context) + ) + + return resolved_args, resolved_kwargs + + +def register_simple_block_tag(library, func=None, takes_context=None, name=None, end_name=None): + """ + Register a callable as a compiled block template tag. Example: + + @register_simple_block_tag(register) + def hello(content): + return 'world' + """ + def dec(func): + nonlocal end_name + + ( + params, + varargs, + varkw, + defaults, + kwonly, + kwonly_defaults, + _, + ) = getfullargspec(unwrap(func)) + function_name = name or func.__name__ + + if end_name is None: + end_name = f"end{function_name}" + + @wraps(func) + def compile_func(parser, token): + tag_params = params.copy() + + if takes_context: + if len(tag_params) >= 2 and tag_params[1] == "content": + del tag_params[1] + else: + raise TemplateSyntaxError( + f"{function_name!r} is decorated with takes_context=True so" + " it must have a first argument of 'context' and a second " + "argument of 'content'" + ) + elif tag_params and tag_params[0] == "content": + del tag_params[0] + else: + raise TemplateSyntaxError( + f"'{function_name}' must have a first argument of 'content'" + ) + + bits = token.split_contents()[1:] + target_var = None + if len(bits) >= 2 and bits[-2] == "as": + target_var = bits[-1] + bits = bits[:-2] + + nodelist = parser.parse((end_name,)) + parser.delete_first_token() + + args, kwargs = parse_bits( + parser, + bits, + tag_params, + varargs, + varkw, + defaults, + kwonly, + kwonly_defaults, + takes_context, + function_name, + ) + + return SimpleBlockNode( + nodelist, func, takes_context, args, kwargs, target_var + ) + + library.tag(function_name, compile_func) + return func + + if func is None: + # @register.simple_block_tag(...) + return dec + elif callable(func): + # @register.simple_block_tag + return dec(func) + else: + raise ValueError("Invalid arguments provided to simple_block_tag") diff --git a/src/pretix/presale/templates/pretixpresale/event/fragment_cart.html b/src/pretix/presale/templates/pretixpresale/event/fragment_cart.html index bcfb67e9b..259b80f4b 100644 --- a/src/pretix/presale/templates/pretixpresale/event/fragment_cart.html +++ b/src/pretix/presale/templates/pretixpresale/event/fragment_cart.html @@ -495,7 +495,7 @@
{% csrf_token %} - +

{% if cart.minutes_left > 0 or cart.seconds_left > 0 %} {% blocktrans trimmed with minutes=cart.minutes_left %} The items in your cart are reserved for you for {{ minutes }} minutes. @@ -503,9 +503,12 @@ {% else %} {% trans "The items in your cart are no longer reserved for you. You can still complete your order as long as they’re available." %} {% endif %} - - +

+

+ +

{% else %}

{% trans "Overview of your ordered products." %}

diff --git a/src/pretix/presale/templates/pretixpresale/event/fragment_cart_box.html b/src/pretix/presale/templates/pretixpresale/event/fragment_cart_box.html index d1d94cdc1..934e98c92 100644 --- a/src/pretix/presale/templates/pretixpresale/event/fragment_cart_box.html +++ b/src/pretix/presale/templates/pretixpresale/event/fragment_cart_box.html @@ -4,7 +4,7 @@ {% load rich_text %} {% load money %}
- +

diff --git a/src/pretix/presale/templates/pretixpresale/fragment_modals.html b/src/pretix/presale/templates/pretixpresale/fragment_modals.html index de6590c5c..fce9d0a05 100644 --- a/src/pretix/presale/templates/pretixpresale/fragment_modals.html +++ b/src/pretix/presale/templates/pretixpresale/fragment_modals.html @@ -4,18 +4,19 @@ {% load escapejson %} {% load icon %} {% load dialog %} -
+ -

{% trans "If you do not see the new window, we can help you launch it again." %}

@@ -32,20 +33,21 @@
-