Show Wikimedia username in ticket checkout page (#1351)

* Show Wikimedia username in ticket checkout page

* Address Sourcery review

* Correct the label of `wikimedia_username` in User Settings form

Author: hongquan

app/eventyay/base/forms/user.py

@@ -54,16 +54,13 @@ class UserSettingsForm(forms.ModelForm):
     class Meta:
         model = User
         fields = ['fullname', 'wikimedia_username', 'locale', 'timezone', 'email']
-        labels = {
-            'wikimedia_username': 'Nick name',
-        }
         widgets = {'locale': SingleLanguageWidget}
 
     def __init__(self, *args, **kwargs):
         self.user = kwargs.pop('user')
         super().__init__(*args, **kwargs)
         self.fields['email'].required = True
-        self.fields['wikimedia_username'].widget.attrs['readonly'] = True
+        self.fields['wikimedia_username'].disabled = True
         if self.user.auth_backend != 'native':
             del self.fields['old_pw']
             del self.fields['new_pw']

app/eventyay/control/forms/orders.py

@@ -27,10 +27,10 @@
 )
 from eventyay.base.models import (
     InvoiceAddress,
-    ProductAddOn,
     Order,
     OrderFee,
     OrderPosition,
+    ProductAddOn,
     TaxRule,
 )
 from eventyay.base.models.event import SubEvent

app/eventyay/presale/forms/checkout.py

@@ -1,7 +1,9 @@
+import logging
 from itertools import chain
 
 from django import forms
 from django.core.exceptions import ValidationError
+from django.http import HttpRequest
 from django.utils.encoding import force_str
 from django.utils.translation import gettext_lazy as _
 from phonenumber_field.formfields import PhoneNumberField
@@ -16,9 +18,12 @@
     guess_country,
 )
 from eventyay.base.i18n import get_babel_locale, language
+from eventyay.base.models import Event
 from eventyay.base.validators import EmailBanlistValidator
 from eventyay.presale.signals import contact_form_fields
 
+logger = logging.getLogger(__name__)
+
 
 class ContactForm(forms.Form):
     required_css_class = 'required'
@@ -27,51 +32,78 @@ class ContactForm(forms.Form):
         validators=[EmailBanlistValidator()],
         widget=forms.EmailInput(attrs={'autocomplete': 'section-contact email'}),
     )
+    # This field will be dropped depending on `include_wikimedia_username` event setting.
+    wikimedia_username = forms.CharField(
+        label=_('Wikimedia Username'),
+        required=False,
+        disabled=True,
+        widget=forms.TextInput(attrs={'readonly': 'readonly'}),
+    )
+    phone = PhoneNumberField(
+        label=_('Phone number'),
+        required=False,
+        help_text='',
+        widget=WrappedPhoneNumberPrefixWidget(),
+    )
 
-    def __init__(self, *args, **kwargs):
-        self.event = kwargs.pop('event')
-        self.request = kwargs.pop('request')
-        self.all_optional = kwargs.pop('all_optional', False)
+    def __init__(self, *args, event: Event, request: HttpRequest, all_optional=False, **kwargs):
+        self.event = event
+        self.request = request
+        self.all_optional = all_optional
         super().__init__(*args, **kwargs)
 
-        if self.event.settings.order_email_asked_twice:
+        if event.settings.order_email_asked_twice:
             self.fields['email_repeat'] = forms.EmailField(
                 label=_('E-mail address (repeated)'),
                 help_text=_('Please enter the same email address again to make sure you typed it correctly.'),
             )
 
-        if self.event.settings.order_phone_asked:
+        if event.settings.order_phone_asked:
+            self.fields['phone'].required = True
+            self.fields['phone'].help_text = event.settings.checkout_phone_helptext
             with language(get_babel_locale()):
-                default_country = guess_country(self.event)
+                default_country = guess_country(event)
                 default_prefix = None
+                phone_initial = ''
                 for prefix, values in _COUNTRY_CODE_TO_REGION_CODE.items():
                     if str(default_country) in values:
                         default_prefix = prefix
-                try:
-                    initial = self.initial.pop('phone', None)
-                    initial = PhoneNumber().from_string(initial) if initial else '+{}.'.format(default_prefix)
-                except NumberParseException:
-                    initial = None
-                self.fields['phone'] = PhoneNumberField(
-                    label=_('Phone number'),
-                    required=self.event.settings.order_phone_required,
-                    help_text=self.event.settings.checkout_phone_helptext,
-                    # We now exploit an implementation detail in PhoneNumberPrefixWidget to allow us to pass just
-                    # a country code but no number as an initial value. It's a bit hacky, but should be stable for
-                    # the future.
-                    initial=initial,
-                    widget=WrappedPhoneNumberPrefixWidget(),
-                )
+                        break
+                if passed_initial := self.initial.get('phone'):
+                    try:
+                        phone_number = PhoneNumber().from_string(passed_initial)
+                        phone_initial = str(phone_number)
+                    except NumberParseException:
+                        pass
+                elif default_prefix:
+                    phone_initial = f'+{default_prefix}.'
+            self.fields['phone'].initial = phone_initial
+        else:
+            del self.fields['phone']
+
+        # Wikimedia username field visibility based on event setting
+        if not event.settings.include_wikimedia_username:
+            logger.debug('Dropping wikimedia_username field because `include_wikimedia_username` setting is False.')
+            self.fields.pop('wikimedia_username', None)
+        else:
+            # Configure read-only Wikimedia username initial without redefining the field
+            wm_initial = (
+                self.initial.get('wikimedia_username')
+                or getattr(getattr(request, 'user', None), 'wikimedia_username', None)
+                or request.session.get('wikimedia_username')
+            )
+            if wm_initial:
+                self.fields['wikimedia_username'].initial = wm_initial
 
-        if not self.request.session.get('iframe_session', False):
+        if not request.session.get('iframe_session', False):
             # There is a browser quirk in Chrome that leads to incorrect initial scrolling in iframes if there
             # is an autofocus field. Who would have thought… See e.g. here:
             # https://floatboxjs.com/forum/topic.php?post=8440&usebb_sid=2e116486a9ec6b7070e045aea8cded5b#post8440
             self.fields['email'].widget.attrs['autofocus'] = 'autofocus'
-        self.fields['email'].help_text = self.event.settings.checkout_email_helptext
+        self.fields['email'].help_text = event.settings.checkout_email_helptext
         self.fields['email'].widget.attrs['placeholder'] = 'Valid Email address'
 
-        responses = contact_form_fields.send(self.event, request=self.request)
+        responses = contact_form_fields.send(event, request=request)
         for r, response in responses:
             for key, value in response.items():
                 # We need to be this explicit, since OrderedDict.update does not retain ordering

app/eventyay/presale/views/checkout.py

@@ -1,3 +1,4 @@
+import logging
 from urllib.parse import quote
 
 from django.contrib import messages
@@ -18,9 +19,10 @@
     iframe_entry_view_wrapper,
 )
 
+logger = logging.getLogger(__name__)
 
-@method_decorator(allow_frame_if_namespaced, 'dispatch')
-@method_decorator(iframe_entry_view_wrapper, 'dispatch')
+
+@method_decorator((allow_frame_if_namespaced, iframe_entry_view_wrapper), 'dispatch')
 class CheckoutView(View):
     def get_index_url(self, request):
         kwargs = {}
@@ -37,7 +39,9 @@ def dispatch(self, request, *args, **kwargs):
 
         if not request.event.presale_is_running:
             messages.error(request, _('The presale for this event is over or has not yet started.'))
-            return self.redirect(self.get_index_url(self.request))
+            new_url = self.get_index_url(self.request)
+            logger.info('Redirecting to %s as presale is not running.', new_url)
+            return self.redirect(new_url)
 
         cart_error = None
         try:
@@ -52,29 +56,35 @@ def dispatch(self, request, *args, **kwargs):
                 continue
             if step.requires_valid_cart and cart_error:
                 messages.error(request, str(cart_error))
-                return self.redirect(
-                    previous_step.get_step_url(request) if previous_step else self.get_index_url(request)
-                )
+                new_url = previous_step.get_step_url(request) if previous_step else self.get_index_url(request)
+                logger.info('Redirecting to %s as cart is invalid.', new_url)
+                return self.redirect(new_url)
 
             if 'step' not in kwargs:
-                return self.redirect(step.get_step_url(request))
+                new_url = step.get_step_url(request)
+                logger.info('Redirecting to %s as no step is specified.', new_url)
+                return self.redirect(new_url)
             is_selected = step.identifier == kwargs.get('step', '')
             if (
                 'async_id' not in request.GET
                 and not is_selected
                 and not step.is_completed(request, warn=not is_selected)
             ):
-                return self.redirect(step.get_step_url(request))
+                new_url = step.get_step_url(request)
+                logger.info('Redirecting to %s as previous steps are not completed.', new_url)
+                return self.redirect(new_url)
             if is_selected:
                 if request.method.lower() in self.http_method_names:
                     handler = getattr(step, request.method.lower(), self.http_method_not_allowed)
                 else:
                     handler = self.http_method_not_allowed
+                logger.debug('Dispatching to step handler %s.', handler)
                 return handler(request)
             else:
                 previous_step = step
                 step.c_is_before = True
                 step.c_resolved_url = step.get_step_url(request)
+        logger.warning('No matching step found in checkout flow.')
         raise Http404()
 
     def redirect(self, url):