Pass request to dispatcher extra context so we can retrieve the correct site based on request

src/oscar/apps/checkout/mixins.py

@@ -273,7 +273,8 @@ class OrderPlacementMixin(CheckoutSessionMixin):
         ctx = {
             'user': self.request.user,
             'order': order,
-            'lines': order.lines.all()
+            'lines': order.lines.all(),
+            'request': self.request,
         }
 
         # Attempt to add the order status URL to the email template ctx.

src/oscar/apps/communication/utils.py

@@ -156,18 +156,20 @@ class Dispatcher(object):
 
         return content_attachments, file_attachments
 
-    def get_base_context(self):
+    def get_base_context(self, **kwargs):
         """
         Return context that is common to all emails
         """
-        return {'site': Site.objects.get_current()}
+        request = kwargs.get("request")
+        return dict(kwargs, site=Site.objects.get_current(request))
 
     def get_messages(self, event_code, extra_context=None):
         """
         Return rendered messages
         """
-        context = self.get_base_context()
-        if extra_context is not None:
-            context.update(extra_context)
+        if extra_context is None:
+            extra_context = {}
+        context = self.get_base_context(**extra_context)
+
         msgs = CommunicationEventType.objects.get_and_render(event_code, context)
         return msgs

src/oscar/apps/customer/forms.py

@@ -49,13 +49,14 @@ class PasswordResetForm(auth_forms.PasswordResetForm):
         if domain_override is not None:
             site.domain = site.name = domain_override
         for user in self.get_users(self.cleaned_data['email']):
-            self.send_password_reset_email(site, user)
+            self.send_password_reset_email(site, user, request)
 
-    def send_password_reset_email(self, site, user):
+    def send_password_reset_email(self, site, user, request=None):
         extra_context = {
             'user': user,
             'site': site,
             'reset_url': get_password_reset_url(user),
+            'request': request,
         }
         CustomerDispatcher().send_password_reset_email_for_user(user, extra_context)
 

src/oscar/apps/customer/mixins.py

@@ -82,5 +82,5 @@ class RegisterUserMixin(object):
         return user
 
     def send_registration_email(self, user):
-        extra_context = {'user': user}
+        extra_context = {'user': user, 'request': self.request}
         CustomerDispatcher().send_registration_email_for_user(user, extra_context)

src/oscar/apps/customer/views.py

@@ -340,6 +340,7 @@ class ProfileUpdateView(PageTitleMixin, generic.FormView):
             'user': user,
             'reset_url': get_password_reset_url(old_user),
             'new_email': new_email,
+            'request': self.request,
         }
         CustomerDispatcher().send_email_changed_email_for_user(old_user, extra_context)
 
@@ -390,6 +391,7 @@ class ChangePasswordView(PageTitleMixin, generic.FormView):
         extra_context = {
             'user': user,
             'reset_url': get_password_reset_url(self.request.user),
+            'request': self.request,
         }
         CustomerDispatcher().send_password_changed_email_for_user(user, extra_context)
 

src/oscar/test/utils.py

@@ -99,10 +99,15 @@ class ThumbnailMixin:
 
 
 class EmailsMixin:
+    DJANGO_IMPROPERLY_CONFIGURED_MSG = 'You\'re using the Django "sites framework" '\
+        'without having set the SITE_ID setting. Create a site in your database and set '\
+        'the SITE_ID setting or pass a request to Site.objects.get_current() to fix this error.'
 
     def setUp(self):
         super().setUp()
         self.user = UserFactory()
+        factory = RequestFactory(SERVER_NAME="example.com")
+        self.request = factory.get("/")
 
     def _test_send_plain_text_and_html(self, outboxed_email):
         email = outboxed_email

tests/functional/customer/test_emails.py

@@ -1,6 +1,7 @@
 from django.contrib.sites.models import Site
 from django.core import mail
-from django.test import TestCase
+from django.core.exceptions import ImproperlyConfigured
+from django.test import TestCase, override_settings
 
 from oscar.core.loading import get_class
 from oscar.test.factories import (
@@ -17,55 +18,109 @@ class TestCustomerConcreteEmailsSending(EmailsMixin, TestCase):
         super().setUp()
         self.dispatcher = CustomerDispatcher()
 
-    def test_send_registration_email_for_user(self):
+    def test_send_registration_email_for_user(self, additional_context=None):
         extra_context = {'user': self.user}
+
+        if additional_context:
+            extra_context.update(additional_context)
+
         self.dispatcher.send_registration_email_for_user(self.user, extra_context)
 
         self._test_common_part()
         self.assertEqual('Thank you for registering.', mail.outbox[0].subject)
         self.assertIn('Thank you for registering.', mail.outbox[0].body)
 
-    def test_send_password_reset_email_for_user(self):
+    @override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"])
+    def test_send_registration_email_for_user_multisite(self):
+        with self.assertRaises(ImproperlyConfigured, msg=self.DJANGO_IMPROPERLY_CONFIGURED_MSG):
+            self.test_send_registration_email_for_user()
+
+        additional_context = {"request": self.request}
+        self.test_send_registration_email_for_user(additional_context=additional_context)
+
+    def test_send_password_reset_email_for_user(self, additional_context=None):
         extra_context = {
             'user': self.user,
             'reset_url': '/django-oscar/django-oscar',
         }
+
+        request = None
+        if additional_context:
+            request = additional_context.get("request")
+            extra_context.update(additional_context)
+
         self.dispatcher.send_password_reset_email_for_user(self.user, extra_context)
 
         self._test_common_part()
-        expected_subject = 'Resetting your password at {}.'.format(Site.objects.get_current())
+        expected_subject = 'Resetting your password at {}.'.format(Site.objects.get_current(request))
         self.assertEqual(expected_subject, mail.outbox[0].subject)
         self.assertIn('Please go to the following page and choose a new password:', mail.outbox[0].body)
         self.assertIn('http://example.com/django-oscar/django-oscar', mail.outbox[0].body)
 
-    def test_send_password_changed_email_for_user(self):
+    @override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"])
+    def test_send_password_reset_email_for_user_multisite(self):
+        with self.assertRaises(ImproperlyConfigured, msg=self.DJANGO_IMPROPERLY_CONFIGURED_MSG):
+            self.test_send_password_reset_email_for_user()
+
+        additional_context = {"request": self.request}
+        self.test_send_password_reset_email_for_user(additional_context=additional_context)
+
+    def test_send_password_changed_email_for_user(self, additional_context=None):
         extra_context = {
             'user': self.user,
             'reset_url': '/django-oscar/django-oscar',
         }
+
+        request = None
+        if additional_context:
+            request = additional_context.get("request")
+            extra_context.update(additional_context)
+
         self.dispatcher.send_password_changed_email_for_user(self.user, extra_context)
 
         self._test_common_part()
-        expected_subject = 'Your password changed at {}.'.format(Site.objects.get_current())
+        expected_subject = 'Your password changed at {}.'.format(Site.objects.get_current(request))
         self.assertEqual(expected_subject, mail.outbox[0].subject)
         self.assertIn('your password has been changed', mail.outbox[0].body)
         self.assertIn('http://example.com/django-oscar/django-oscar', mail.outbox[0].body)
 
-    def test_send_email_changed_email_for_user(self):
+    @override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"])
+    def test_send_password_changed_email_for_user_multisite(self):
+        with self.assertRaises(ImproperlyConfigured, msg=self.DJANGO_IMPROPERLY_CONFIGURED_MSG):
+            self.test_send_password_changed_email_for_user()
+
+        additional_context = {"request": self.request}
+        self.test_send_password_changed_email_for_user(additional_context=additional_context)
+
+    def test_send_email_changed_email_for_user(self, additional_context=None):
         extra_context = {
             'user': self.user,
             'reset_url': '/django-oscar/django-oscar',
             'new_email': 'some_new@mail.com',
         }
+
+        request = None
+        if additional_context:
+            request = additional_context.get("request")
+            extra_context.update(additional_context)
+
         self.dispatcher.send_email_changed_email_for_user(self.user, extra_context)
 
         self._test_common_part()
-        expected_subject = 'Your email address has changed at {}.'.format(Site.objects.get_current())
+        expected_subject = 'Your email address has changed at {}.'.format(Site.objects.get_current(request))
         self.assertEqual(expected_subject, mail.outbox[0].subject)
         self.assertIn('your email address has been changed', mail.outbox[0].body)
         self.assertIn('http://example.com/django-oscar/django-oscar', mail.outbox[0].body)
         self.assertIn('some_new@mail.com', mail.outbox[0].body)
 
+    @override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"])
+    def test_send_email_changed_email_for_user_multisite(self):
+        with self.assertRaises(ImproperlyConfigured, msg=self.DJANGO_IMPROPERLY_CONFIGURED_MSG):
+            self.test_send_email_changed_email_for_user()
+
+        additional_context = {"request": self.request}
+        self.test_send_email_changed_email_for_user(additional_context=additional_context)
+
 
 class TestAlertsConcreteEmailsSending(EmailsMixin, TestCase):
 

tests/functional/order/test_emails.py

@@ -1,7 +1,8 @@
 import os
 
 from django.core import mail
-from django.test import TestCase
+from django.core.exceptions import ImproperlyConfigured
+from django.test import TestCase, override_settings
 
 from oscar.core.loading import get_class
 from oscar.test.factories import ProductImageFactory, create_order
@@ -16,14 +17,18 @@ class TestConcreteEmailsSending(EmailsMixin, TestCase):
         super().setUp()
         self.dispatcher = OrderDispatcher()
 
-    def test_send_order_placed_email_for_user(self):
-        order_number = 'SOME-NUM00042'
-        order = create_order(number=order_number, user=self.user)
+    def test_send_order_placed_email_for_user(self, order_number=None, additional_context=None):
+        order_number = order_number if order_number else 'SOME-NUM00042'
+        order = create_order(number=order_number, user=self.user, request=self.request)
 
         extra_context = {
             'order': order,
             'lines': order.lines.all()
         }
+
+        if additional_context:
+            extra_context.update(additional_context)
+
         self.dispatcher.send_order_placed_email_for_user(order, extra_context)
 
         self._test_common_part()
@@ -33,16 +38,30 @@ class TestConcreteEmailsSending(EmailsMixin, TestCase):
         product_title = order.lines.first().title
         assert product_title in mail.outbox[0].body
 
-    def test_send_order_placed_email_with_attachments_for_user(self):
+    @override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"])
+    def test_send_order_placed_email_for_user_multisite(self):
+        with self.assertRaises(ImproperlyConfigured, msg=self.DJANGO_IMPROPERLY_CONFIGURED_MSG):
+            self.test_send_order_placed_email_for_user()
+
+        additional_context = {"request": self.request}
+        self.test_send_order_placed_email_for_user(
+            order_number="SOME-NUM00043", additional_context=additional_context
+        )
+
+    def test_send_order_placed_email_with_attachments_for_user(self, order_number=None, additional_context=None):
         remove_image_folders()
 
-        order_number = 'SOME-NUM00042'
-        order = create_order(number=order_number, user=self.user)
+        order_number = order_number if order_number else 'SOME-NUM00042'
+        order = create_order(number=order_number, user=self.user, request=self.request)
 
         extra_context = {
             'order': order,
             'lines': order.lines.all()
         }
+
+        if additional_context:
+            extra_context.update(additional_context)
+
         line = order.lines.first()
         product_image = ProductImageFactory(product=line.product)
         attachments = [
@@ -59,3 +78,13 @@ class TestConcreteEmailsSending(EmailsMixin, TestCase):
 
         # Remove test file
         os.remove(product_image.original.path)
+
+    @override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"])
+    def test_send_order_placed_email_with_attachments_for_user_multisite(self):
+        with self.assertRaises(ImproperlyConfigured, msg=self.DJANGO_IMPROPERLY_CONFIGURED_MSG):
+            self.test_send_order_placed_email_with_attachments_for_user()
+
+        additional_context = {"request": self.request}
+        self.test_send_order_placed_email_with_attachments_for_user(
+            order_number="SOME-NUM00043", additional_context=additional_context
+        )