diff --git a/AUTHORS b/AUTHORS index 9ffd6cdd89..5fa21d3f8e 100644 --- a/AUTHORS +++ b/AUTHORS @@ -450,6 +450,7 @@ answer newbie questions, and generally made Django that much better: Manuel Saelices Ivan Sagalaev (Maniac) Vinay Sajip + Bartolome Sanchez Salado Kadesarin Sanjek Massimo Scamarcia Paulo Scardine @@ -548,6 +549,7 @@ answer newbie questions, and generally made Django that much better: Jakub Wiśniowski Maciej Wiśniowski wojtek + Marcin Wróbel Jason Yan Lars Yencken ye7cakf02@sneakemail.com diff --git a/django/utils/log.py b/django/utils/log.py index 8ce37f5309..16ad5f05de 100644 --- a/django/utils/log.py +++ b/django/utils/log.py @@ -47,18 +47,20 @@ class AdminEmailHandler(logging.Handler): request = record.request subject = '%s (%s IP): %s' % ( record.levelname, - (request.META.get('REMOTE_ADDR') in settings.INTERNAL_IPS and 'internal' or 'EXTERNAL'), + (request.META.get('REMOTE_ADDR') in settings.INTERNAL_IPS + and 'internal' or 'EXTERNAL'), record.msg ) filter = get_exception_reporter_filter(request) request_repr = filter.get_request_repr(request) - except: + except Exception: subject = '%s: %s' % ( record.levelname, record.getMessage() ) request = None request_repr = "Request repr() unavailable." + subject = self.format_subject(subject) if record.exc_info: exc_info = record.exc_info @@ -72,6 +74,15 @@ class AdminEmailHandler(logging.Handler): html_message = self.include_html and reporter.get_traceback_html() or None mail.mail_admins(subject, message, fail_silently=True, html_message=html_message) + def format_subject(self, subject): + """ + Escape CR and LF characters, and limit length. + RFC 2822's hard limit is 998 characters per line. So, minus "Subject: " + the actual subject must be no longer than 989 characters. + """ + formatted_subject = subject.replace('\n', '\\n').replace('\r', '\\r') + return formatted_subject[:989] + class CallbackFilter(logging.Filter): """ diff --git a/tests/regressiontests/logging_tests/tests.py b/tests/regressiontests/logging_tests/tests.py index a2c178c3b7..8eba44bf77 100644 --- a/tests/regressiontests/logging_tests/tests.py +++ b/tests/regressiontests/logging_tests/tests.py @@ -160,3 +160,50 @@ class AdminEmailHandlerTest(TestCase): # Restore original filters admin_email_handler.filters = orig_filters + + @override_settings( + ADMINS=(('admin', 'admin@example.com'),), + EMAIL_SUBJECT_PREFIX='', + DEBUG=False, + ) + def test_subject_accepts_newlines(self): + """ + Ensure that newlines in email reports' subjects are escaped to avoid + AdminErrorHandler to fail. + Refs #17281. + """ + message = u'Message \r\n with newlines' + expected_subject = u'ERROR: Message \\r\\n with newlines' + + self.assertEqual(len(mail.outbox), 0) + + logger = getLogger('django.request') + logger.error(message) + + self.assertEqual(len(mail.outbox), 1) + self.assertFalse('\n' in mail.outbox[0].subject) + self.assertFalse('\r' in mail.outbox[0].subject) + self.assertEqual(mail.outbox[0].subject, expected_subject) + + @override_settings( + ADMINS=(('admin', 'admin@example.com'),), + EMAIL_SUBJECT_PREFIX='', + DEBUG=False, + ) + def test_truncate_subject(self): + """ + RFC 2822's hard limit is 998 characters per line. + So, minus "Subject: ", the actual subject must be no longer than 989 + characters. + Refs #17281. + """ + message = 'a' * 1000 + expected_subject = 'ERROR: aa' + 'a' * 980 + + self.assertEqual(len(mail.outbox), 0) + + logger = getLogger('django.request') + logger.error(message) + + self.assertEqual(len(mail.outbox), 1) + self.assertEqual(mail.outbox[0].subject, expected_subject)