Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bug 714724: Correctly encode emails as quoted-printable
r=dkl a=sgreen
- Loading branch information
Showing
6 changed files
with
158 additions
and
142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| # This Source Code Form is subject to the terms of the Mozilla Public | ||
| # License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| # file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| # | ||
| # This Source Code Form is "Incompatible With Secondary Licenses", as | ||
| # defined by the Mozilla Public License, v. 2.0. | ||
|
|
||
| package Bugzilla::MIME; | ||
|
|
||
| use 5.10.1; | ||
| use strict; | ||
| use warnings; | ||
|
|
||
| use parent qw(Email::MIME); | ||
|
|
||
| use Encode qw(encode); | ||
| use Encode::MIME::Header; | ||
|
|
||
| sub new { | ||
| my ($class, $msg) = @_; | ||
| state $use_utf8 = Bugzilla->params->{'utf8'}; | ||
|
|
||
| # Template-Toolkit trims trailing newlines, which is problematic when | ||
| # parsing headers. | ||
| $msg =~ s/\n*$/\n/; | ||
|
|
||
| # Because the encoding headers are not present in our email templates, we | ||
| # need to treat them as binary UTF-8 when parsing. | ||
| my ($in_header, $has_type, $has_encoding, $has_body) = (1); | ||
| foreach my $line (split(/\n/, $msg)) { | ||
| if ($line eq '') { | ||
| $in_header = 0; | ||
| next; | ||
| } | ||
| if (!$in_header) { | ||
| $has_body = 1; | ||
| last; | ||
| } | ||
| $has_type = 1 if $line =~ /^Content-Type:/i; | ||
| $has_encoding = 1 if $line =~ /^Content-Transfer-Encoding:/i; | ||
| } | ||
| if ($has_body) { | ||
| if (!$has_type && $use_utf8) { | ||
| $msg = qq#Content-Type: text/plain; charset="UTF-8"\n# . $msg; | ||
| } | ||
| if (!$has_encoding) { | ||
| $msg = qq#Content-Transfer-Encoding: binary\n# . $msg; | ||
| } | ||
| } | ||
| if ($use_utf8 && utf8::is_utf8($msg)) { | ||
| utf8::encode($msg); | ||
| } | ||
|
|
||
| # RFC 2822 requires us to have CRLF for our line endings and | ||
| # Email::MIME doesn't do this for us. We use \015 (CR) and \012 (LF) | ||
| # directly because Perl translates "\n" depending on what platform | ||
| # you're running on. See http://perldoc.perl.org/perlport.html#Newlines | ||
| $msg =~ s/(?:\015+)?\012/\015\012/msg; | ||
|
|
||
| return $class->SUPER::new($msg); | ||
| } | ||
|
|
||
| sub as_string { | ||
| my $self = shift; | ||
| state $use_utf8 = Bugzilla->params->{'utf8'}; | ||
|
|
||
| # We add this header to uniquely identify all email that we | ||
| # send as coming from this Bugzilla installation. | ||
| # | ||
| # We don't use correct_urlbase, because we want this URL to | ||
| # *always* be the same for this Bugzilla, in every email, | ||
| # even if the admin changes the "ssl_redirect" parameter some day. | ||
| $self->header_set('X-Bugzilla-URL', Bugzilla->params->{'urlbase'}); | ||
|
|
||
| # We add this header to mark the mail as "auto-generated" and | ||
| # thus to hopefully avoid auto replies. | ||
| $self->header_set('Auto-Submitted', 'auto-generated'); | ||
|
|
||
| # MIME-Version must be set otherwise some mailsystems ignore the charset | ||
| $self->header_set('MIME-Version', '1.0') if !$self->header('MIME-Version'); | ||
|
|
||
| # Encode the headers correctly in quoted-printable | ||
| foreach my $header ($self->header_names) { | ||
| my @values = $self->header($header); | ||
| # We don't recode headers that happen multiple times. | ||
| next if scalar(@values) > 1; | ||
| if (my $value = $values[0]) { | ||
| utf8::decode($value) unless $use_utf8 && utf8::is_utf8($value); | ||
|
|
||
| # avoid excessive line wrapping done by Encode. | ||
| local $Encode::Encoding{'MIME-Q'}->{'bpl'} = 998; | ||
|
|
||
| my $encoded = encode('MIME-Q', $value); | ||
| $self->header_set($header, $encoded); | ||
| } | ||
| } | ||
|
|
||
| # Ensure the character-set and encoding is set correctly on single part | ||
| # emails. Multipart emails should have these already set when the parts | ||
| # are assembled. | ||
| if (scalar($self->parts) == 1) { | ||
| $self->charset_set('UTF-8') if $use_utf8; | ||
| $self->encoding_set('quoted-printable'); | ||
| } | ||
|
|
||
| # Ensure we always return the encoded string | ||
| my $value = $self->SUPER::as_string(); | ||
| if ($use_utf8 && utf8::is_utf8($value)) { | ||
| utf8::encode($value); | ||
| } | ||
|
|
||
| return $value; | ||
| } | ||
|
|
||
| 1; | ||
|
|
||
| __END__ | ||
| =head1 NAME | ||
| Bugzilla::MIME - Wrapper around Email::MIME for unifying MIME related | ||
| workarounds. | ||
| =head1 SYNOPSIS | ||
| use Bugzilla::MIME; | ||
| my $email = Bugzilla::MIME->new($message); | ||
| =head1 DESCRIPTION | ||
| Bugzilla::MIME subclasses Email::MIME and performs various fixes when parsing | ||
| and generating email. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.