Add phone number to customer profile (Z#178346) (#2414)

src/pretix/base/forms/questions.py

@@ -333,23 +333,41 @@ class WrappedPhoneNumberPrefixWidget(PhoneNumberPrefixWidget):
 def guess_country(event):
     # Try to guess the initial country from either the country of the merchant
     # or the locale. This will hopefully save at least some users some scrolling :)
-    locale = get_language_without_region()
     country = event.settings.region or event.settings.invoice_address_from_country
     if not country:
-        valid_countries = countries.countries
-        if '-' in locale:
-            parts = locale.split('-')
-            # TODO: does this actually work?
-            if parts[1].upper() in valid_countries:
-                country = Country(parts[1].upper())
-            elif parts[0].upper() in valid_countries:
-                country = Country(parts[0].upper())
-        else:
-            if locale.upper() in valid_countries:
-                country = Country(locale.upper())
+        country = get_country_by_locale(get_language_without_region())
     return country
 
 
+def get_country_by_locale(locale):
+    country = None
+    valid_countries = countries.countries
+    if '-' in locale:
+        parts = locale.split('-')
+        # TODO: does this actually work?
+        if parts[1].upper() in valid_countries:
+            country = Country(parts[1].upper())
+        elif parts[0].upper() in valid_countries:
+            country = Country(parts[0].upper())
+    else:
+        if locale.upper() in valid_countries:
+            country = Country(locale.upper())
+    return country
+
+
+def guess_phone_prefix(event):
+    with language(get_babel_locale()):
+        country = str(guess_country(event))
+        return get_phone_prefix(country)
+
+
+def get_phone_prefix(country):
+    for prefix, values in _COUNTRY_CODE_TO_REGION_CODE.items():
+        if country in values:
+            return prefix
+    return None
+
+
 class QuestionCheckboxSelectMultiple(forms.CheckboxSelectMultiple):
     option_template_name = 'pretixbase/forms/widgets/checkbox_option_with_links.html'
 
@@ -780,25 +798,26 @@ class BaseQuestionsForm(forms.Form):
                 if q.valid_datetime_max:
                     field.validators.append(MaxDateTimeValidator(q.valid_datetime_max))
             elif q.type == Question.TYPE_PHONENUMBER:
-                with language(get_babel_locale()):
-                    default_country = guess_country(event)
-                    default_prefix = None
-                    for prefix, values in _COUNTRY_CODE_TO_REGION_CODE.items():
-                        if str(default_country) in values:
-                            default_prefix = prefix
+                if initial:
                     try:
-                        initial = PhoneNumber().from_string(initial.answer) if initial else "+{}.".format(default_prefix)
+                        initial = PhoneNumber().from_string(initial.answer)
                     except NumberParseException:
                         initial = None
-                    field = PhoneNumberField(
-                        label=label, required=required,
-                        help_text=help_text,
-                        # 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()
-                    )
+
+                if not initial:
+                    phone_prefix = guess_phone_prefix(event)
+                    if phone_prefix:
+                        initial = "+{}.".format(phone_prefix)
+
+                field = PhoneNumberField(
+                    label=label, required=required,
+                    help_text=help_text,
+                    # 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()
+                )
             field.question = q
             if answers:
                 # Cache the answer object for later use

src/pretix/base/migrations/0206_customer_phone.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.2.9 on 2022-01-12 10:59
+
+import phonenumber_field.modelfields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pretixbase', '0205_itemvariation_require_approval'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='customer',
+            name='phone',
+            field=phonenumber_field.modelfields.PhoneNumberField(max_length=128, null=True, region=None),
+        ),
+    ]

src/pretix/base/models/customers.py

@@ -29,6 +29,7 @@ from django.db.models import F, Q
 from django.utils.crypto import get_random_string, salted_hmac
 from django.utils.translation import gettext_lazy as _, pgettext_lazy
 from django_scopes import ScopedManager, scopes_disabled
+from phonenumber_field.modelfields import PhoneNumberField
 
 from pretix.base.banlist import banned
 from pretix.base.models.base import LoggedModel
@@ -45,6 +46,7 @@ class Customer(LoggedModel):
     organizer = models.ForeignKey(Organizer, related_name='customers', on_delete=models.CASCADE)
     identifier = models.CharField(max_length=190, db_index=True, unique=True)
     email = models.EmailField(db_index=True, null=True, blank=False, verbose_name=_('E-mail'), max_length=190)
+    phone = PhoneNumberField(null=True, blank=True, verbose_name=_('Phone number'))
     password = models.CharField(verbose_name=_('Password'), max_length=128)
     name_cached = models.CharField(max_length=255, verbose_name=_('Full name'), blank=True)
     name_parts = models.JSONField(default=dict)
@@ -87,6 +89,7 @@ class Customer(LoggedModel):
         self.name_parts = {}
         self.name_cached = ''
         self.email = None
+        self.phone = None
         self.save()
         self.all_logentries().update(data={}, shredded=True)
         self.orders.all().update(customer=None)