fix: deprecate SEND_BROKEN_LINK_EMAILS setting

django-cms · vinitkumar · Nov 3, 2022 · Feb 9, 2022 · Feb 11, 2022 · Feb 18, 2022
commit 771f71ba1f4f4c740de4aab9620211f74f0c1ef0
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -7,6 +7,8 @@ unreleased
 
 * Make javascript dark mode functions available to popups as CMS.API.getColorScheme
   and CMS.API.setColorScheme
+* Deprecate usage of legacy SEND_BROKEN_LINK_EMAILS setting (removed since Django 1.8)
+
 
 3.11.0 (2022-08-02)
 ===================

diff --git a/cms/templatetags/cms_tags.py b/cms/templatetags/cms_tags.py
@@ -13,10 +13,9 @@
 from django.contrib.sites.models import Site
 from django.core.mail import mail_managers
 from django.db.models import Model
-from django.middleware.common import BrokenLinkEmailsMiddleware
 from django.template.loader import render_to_string
 from django.urls import reverse
-from django.utils.encoding import force_str, smart_str
+from django.utils.encoding import smart_str
 from django.utils.html import escape
 from django.utils.http import urlencode
 from django.utils.translation import get_language, gettext_lazy as _, override as force_language
@@ -92,12 +91,7 @@ def _get_page_by_untyped_arg(page_lookup, request, site_id):
             if getattr(settings, 'SEND_BROKEN_LINK_EMAILS', False):
                 mail_managers(subject, body, fail_silently=True)
             elif 'django.middleware.common.BrokenLinkEmailsMiddleware' in mw:
-                middle = BrokenLinkEmailsMiddleware()
-                domain = request.get_host()
-                path = request.get_full_path()
-                referer = force_str(request.headers.get('Referer', ''), errors='replace')
-                if not middle.is_ignorable_request(request, path, domain, referer):
-                    mail_managers(subject, body, fail_silently=True)
+                mail_managers(subject, body, fail_silently=True)
             return None
 
 

diff --git a/cms/utils/setup.py b/cms/utils/setup.py
@@ -1,3 +1,5 @@
+import warnings
+
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 
@@ -33,6 +35,14 @@ def validate_settings():
         raise ImproperlyConfigured("django CMS requires django.template.context_processors.request in "
                                    "'django.template.backends.django.DjangoTemplates' context processors.")
 
+    if (
+        hasattr(settings, "SEND_BROKEN_LINK_EMAILS") and
+        "django.middleware.common.BrokenLinkEmailsMiddleware" not in getattr(settings, "MIDDLEWARE", [])
+    ):
+        warnings.warn('The setting "SEND_BROKEN_LINK_EMAILS" will not be honored by django CMS as of version 4.1. '
+                      'Add "django.middleware.common.BrokenLinkEmailsMiddleware" to your MIDDLEWARE settings '
+                      'instead.', DeprecationWarning)
+
 
 def setup():
     """