Custom account email verification through adapter #1946

AUTHORS

@@ -128,6 +128,7 @@ Matt Nishi-Broach
 Mauro Stettler
 Mikhail Mitiaev
 Morgante Pell
+Muneeb Shahid
 Nariman Gharib
 Nathan Strobbe
 Nicolas Acosta

ChangeLog.rst

@@ -1,3 +1,8 @@
+Unreleased
+----------
+
+- Added support for custom account email verification based on the user's email.
+
 0.61.1 (2024-02-09)
 *******************
 

allauth/account/adapter.py

@@ -752,6 +752,9 @@ def get_reauthentication_methods(self, user):
                 )
         return ret
 
+    def get_email_verification_method(self, email=None):
+        return app_settings.EMAIL_VERIFICATION
+
     def send_notification_mail(self, template_prefix, user, context=None, email=None):
         from allauth.account.models import EmailAddress
 

allauth/account/forms.py

@@ -207,12 +207,14 @@ def login(self, request, redirect_url=None):
             if field in credentials
         }
         record_authentication(request, method="password", **extra_data)
+        adapter = get_adapter()
+        email = credentials.get("email")
         ret = perform_login(
             request,
             self.user,
-            email_verification=app_settings.EMAIL_VERIFICATION,
+            email_verification=adapter.get_email_verification_method(email),
             redirect_url=redirect_url,
-            email=credentials.get("email"),
+            email=email,
         )
         remember = app_settings.SESSION_REMEMBER
         if remember is None:

allauth/account/tests/test_adapter.py

@@ -2,6 +2,9 @@
 from django.urls import reverse
 
 from allauth.account.adapter import DefaultAccountAdapter
+from allauth.account.app_settings import (
+    EmailVerificationMethod,
+)
 from allauth.core.exceptions import ImmediateHttpResponse
 
 
@@ -10,6 +13,13 @@ def pre_login(self, *args, **kwargs):
         raise ImmediateHttpResponse(HttpResponseRedirect("/foo"))
 
 
+class CustomAccountEmailVerificationAdapter(DefaultAccountAdapter):
+    def get_email_verification_method(self, email):
+        if email == "mandatory@example.com":
+            return EmailVerificationMethod.MANDATORY
+        return EmailVerificationMethod.OPTIONAL
+
+
 def test_adapter_pre_login(settings, user, user_password, client):
     settings.ACCOUNT_ADAPTER = (
         "allauth.account.tests.test_adapter.PreLoginRedirectAccountAdapter"
@@ -20,3 +30,33 @@ def test_adapter_pre_login(settings, user, user_password, client):
     )
     assert resp.status_code == 302
     assert resp["location"] == "/foo"
+
+
+def test_custom_account_email_verification(settings, user_factory, client):
+    settings.ACCOUNT_ADAPTER = (
+        "allauth.account.tests.test_adapter.CustomAccountEmailVerificationAdapter"
+    )
+
+    resp = client.post(
+        reverse("account_signup"),
+        {
+            "username": "mandatory",
+            "email": "mandatory@example.com",
+            "password1": "mandatory123",
+            "password2": "mandatory123",
+        },
+    )
+    assert resp.status_code == 302
+    assert resp["location"] == reverse("account_email_verification_sent")
+
+    resp = client.post(
+        reverse("account_signup"),
+        {
+            "username": "optional",
+            "email": "optional@example.com",
+            "password1": "optional123",
+            "password2": "optional123",
+        },
+    )
+    assert resp.status_code == 302
+    assert resp["location"] == settings.LOGIN_REDIRECT_URL

allauth/account/utils.py

@@ -545,14 +545,15 @@ def assess_unique_email(email) -> Optional[bool]:
     False -- email is already in use
     None -- email is in use, but we should hide that using email verification.
     """
+    adapter = get_adapter()
     if not filter_users_by_email(email):
         # All good.
         return True
     elif not app_settings.PREVENT_ENUMERATION:
         # Fail right away.
         return False
     elif (
-        app_settings.EMAIL_VERIFICATION
+        adapter.get_email_verification_method(email)
         == app_settings.EmailVerificationMethod.MANDATORY
     ):
         # In case of mandatory verification and enumeration prevention,

allauth/account/views.py

@@ -266,14 +266,15 @@ def get_success_url(self):
         return ret
 
     def form_valid(self, form):
+        adapter = get_adapter()
         self.user, resp = form.try_save(self.request)
         if resp:
             return resp
         try:
             return complete_signup(
                 self.request,
                 self.user,
-                app_settings.EMAIL_VERIFICATION,
+                adapter.get_email_verification_method(self.user.email),
                 self.get_success_url(),
             )
         except ImmediateHttpResponse as e:
@@ -940,7 +941,7 @@ def form_valid(self, form):
             return perform_login(
                 self.request,
                 self.reset_user,
-                email_verification=app_settings.EMAIL_VERIFICATION,
+                email_verification=adapter.get_email_verification_method(self.reset_user.email),
             )
 
         return super(PasswordResetFromKeyView, self).form_valid(form)

allauth/socialaccount/adapter.py

@@ -147,7 +147,10 @@ def validate_disconnect(self, account, accounts):
             if not account.user.has_usable_password():
                 raise ValidationError(_("Your account has no password set up."))
             # No email address, no password reset
-            if app_settings.EMAIL_VERIFICATION == EmailVerificationMethod.MANDATORY:
+            if (
+                get_account_adapter().get_email_verification_method(account.user.email)
+                == EmailVerificationMethod.MANDATORY
+            ):
                 if not EmailAddress.objects.filter(
                     user=account.user, verified=True
                 ).exists():
@@ -315,6 +318,9 @@ def get_requests_session(self):
         )
         return session
 
+    def get_email_verification_method(self, email=None):
+        return app_settings.EMAIL_VERIFICATION
+
     def is_email_verified(self, provider, email):
         """
         Returns ``True`` iff the given email encountered during a social

allauth/socialaccount/helpers.py

@@ -108,7 +108,9 @@ def _login_social_account(request, sociallogin):
     return perform_login(
         request,
         sociallogin.user,
-        email_verification=app_settings.EMAIL_VERIFICATION,
+        email_verification=get_account_adapter().get_email_verification_method(
+            sociallogin.user.email
+        ),
         redirect_url=sociallogin.get_redirect_url(request),
         signal_kwargs={"sociallogin": sociallogin},
     )
@@ -244,7 +246,9 @@ def complete_social_signup(request, sociallogin):
     return complete_signup(
         request,
         sociallogin.user,
-        app_settings.EMAIL_VERIFICATION,
+        get_account_adapter(request).get_email_verification_method(
+            sociallogin.user.email
+        ),
         sociallogin.get_redirect_url(request),
         signal_kwargs={"sociallogin": sociallogin},
     )

allauth/socialaccount/providers/authentiq/provider.py

@@ -1,3 +1,4 @@
+from allauth.socialaccount.adapter import get_adapter
 from allauth.account.models import EmailAddress
 from allauth.socialaccount import app_settings
 from allauth.socialaccount.providers.base import AuthAction, ProviderAccount
@@ -58,14 +59,16 @@ class AuthentiqProvider(OAuth2Provider):
     account_class = AuthentiqAccount
 
     def get_scope(self, request):
+        adapter = get_adapter()
         scope = set(super(AuthentiqProvider, self).get_scope(request))
         scope.add("openid")
 
         if Scope.EMAIL in scope:
             modifiers = ""
             if app_settings.EMAIL_REQUIRED:
                 modifiers += "r"
-            if app_settings.EMAIL_VERIFICATION:
+            #TODO: How to get user email here for get_email_verification_method ?
+            if adapter.get_email_verification_method():
                 modifiers += "s"
             if modifiers:
                 scope.add(Scope.EMAIL + "~" + modifiers)