]> git.donarmstrong.com Git - debbugs.git/blobdiff - Debbugs/MIME.pm
switch to compatibility level 12
[debbugs.git] / Debbugs / MIME.pm
index 482a30b4d182e530bbcd3b780a5479dc53f4cae4..fec3b6e2dc4e1dd43d8d31c020c27343407d0e30 100644 (file)
@@ -10,6 +10,8 @@
 
 package Debbugs::MIME;
 
+=encoding utf8
+
 =head1 NAME
 
 Debbugs::MIME -- Mime handling routines for debbugs
@@ -30,7 +32,7 @@ None known.
 use warnings;
 use strict;
 
-use base qw(Exporter);
+use Exporter qw(import);
 use vars qw($DEBUG $VERSION @EXPORT_OK %EXPORT_TAGS @EXPORT);
 
 BEGIN {
@@ -39,7 +41,9 @@ BEGIN {
 
     @EXPORT = ();
 
-    %EXPORT_TAGS = (mime => [qw(parse create_mime_message getmailbody)],
+    %EXPORT_TAGS = (mime => [qw(parse create_mime_message getmailbody),
+                            qw(parse_to_mime_entity),
+                           ],
                    rfc1522 => [qw(decode_rfc1522 encode_rfc1522)],
                   );
     @EXPORT_OK=();
@@ -47,21 +51,18 @@ BEGIN {
     $EXPORT_TAGS{all} = [@EXPORT_OK];
 }
 
-use File::Path;
-use File::Temp qw();
+use File::Path qw(remove_tree);
+use File::Temp qw(tempdir);
 use MIME::Parser;
 
 use POSIX qw(strftime);
-use List::MoreUtils qw(apply);
+use List::AllUtils qw(apply);
 
 # for convert_to_utf8
 use Debbugs::UTF8 qw(convert_to_utf8);
 
-# for decode_rfc1522
-use MIME::WordDecoder qw();
+# for decode_rfc1522 and encode_rfc1522
 use Encode qw(decode encode encode_utf8 decode_utf8 is_utf8);
-
-# for encode_rfc1522
 use MIME::Words qw();
 
 sub getmailbody
@@ -89,13 +90,50 @@ sub getmailbody
     return undef;
 }
 
+=head2 parse_to_mime_entity
+
+     $entity = parse_to_mime_entity($record);
+
+Returns a MIME::Entity from a record (from Debbugs::Log), a filehandle, or a
+scalar mail message. Will die upon failure.
+
+Intermediate parsing results will be output under a temporary directory which
+should be cleaned up upon process exit.
+
+=cut
+
+sub parse_to_mime_entity {
+    my ($record) = @_;
+    my $parser = MIME::Parser->new();
+    my $entity;
+    # this will be cleaned up once we exit
+    my $tempdir = File::Temp->newdir();
+    $parser->output_dir($tempdir->dirname());
+    if (ref($record) eq 'HASH') {
+       if ($record->{inner_file}) {
+           $entity = $parser->parse($record->{fh}) or
+               die "Unable to parse entity";
+       } else {
+           $entity = $parser->parse_data($record->{text}) or
+               die "Unable to parse entity";
+       }
+    } elsif (ref($record)) {
+       $entity = $parser->parse($record) or
+           die "Unable to parse entity";
+    } else {
+       $entity = $parser->parse_data($record) or
+           die "Unable to parse entity";
+    }
+    return $entity;
+}
+
 sub parse
 {
     # header and decoded body respectively
     my (@headerlines, @bodylines);
 
     my $parser = MIME::Parser->new();
-    my $tempdir = File::Temp::tempdir();
+    my $tempdir = tempdir(CLEANUP => 1);
     $parser->output_under($tempdir);
     my $entity = eval { $parser->parse_data($_[0]) };
 
@@ -118,6 +156,9 @@ sub parse
        my @msg = split /\n/, $_[0];
        my $i;
 
+        # assume us-ascii unless charset is set; probably bad, but we
+        # really shouldn't get to this point anyway
+        my $charset = 'us-ascii';
        for ($i = 0; $i <= $#msg; ++$i) {
            $_ = $msg[$i];
            last unless length;
@@ -125,13 +166,15 @@ sub parse
                ++$i;
                $_ .= "\n" . $msg[$i];
            }
+            if (/charset=\"([^\"]+)\"/) {
+                $charset = $1;
+            }
            push @headerlines, $_;
        }
-
-       @bodylines = @msg[$i .. $#msg];
+       @bodylines = map {convert_to_utf8($_,$charset)} @msg[$i .. $#msg];
     }
 
-    rmtree $tempdir, 0, 1;
+    remove_tree($tempdir,{verbose => 0, safe => 1});
 
     # Remove blank lines.
     shift @bodylines while @bodylines and $bodylines[0] !~ /\S/;
@@ -189,7 +232,7 @@ sub create_mime_message{
      die "The third argument to create_mime_message must be an arrayref" unless ref($attachments) eq 'ARRAY';
 
      if ($include_date) {
-        my %headers = apply {lc($_)} @{$headers};
+        my %headers = apply {defined $_ ? lc($_) : ''} @{$headers};
         if (not exists $headers{date}) {
             push @{$headers},
                 ('Date',
@@ -202,8 +245,8 @@ sub create_mime_message{
      # MIME::Entity is stupid, and doesn't rfc1522 encode its headers, so we do it for it.
      my $msg = MIME::Entity->build('Content-Type' => 'text/plain; charset=utf-8',
                                   'Encoding'     => 'quoted-printable',
-                                  (map{encode_rfc1522($_)} @{$headers}),
-                                  Data    => is_utf8($body)?encode_utf8($body):$body,
+                                  (map{encode_rfc1522(encode_utf8(defined $_ ? $_:''))} @{$headers}),
+                                  Data    => encode_utf8($body),
                                  );
 
      # Attach the attachments
@@ -248,24 +291,27 @@ Turn RFC-1522 names into the UTF-8 equivalent.
 
 =cut
 
-BEGIN {
-    # Set up the default RFC1522 decoder, which turns all charsets that
-    # are supported into the appropriate UTF-8 charset.
-    MIME::WordDecoder->default(new MIME::WordDecoder(
-       ['*' => \&convert_to_utf8,
-       ]));
-}
-
 sub decode_rfc1522 {
     my ($string) = @_;
 
     # this is craptacular, but leading space is hacked off by unmime.
     # Save it.
     my $leading_space = '';
-    $leading_space = $1 if $string =~ s/^(\s+)//;
-    # unmime calls the default MIME::WordDecoder handler set up at
-    # initialization time.
-    return $leading_space . MIME::WordDecoder::unmime($string);
+    $leading_space = $1 if $string =~ s/^(\ +)//;
+    # we must do this to switch off the utf8 flag before calling decode_mimewords
+    $string = encode_utf8($string);
+    my @mime_words = MIME::Words::decode_mimewords($string);
+    my $tmp = $leading_space .
+        join('',
+             (map {
+                 if (@{$_} > 1) {
+                     convert_to_utf8(${$_}[0],${$_}[1]);
+                 } else {
+                     decode_utf8(${$_}[0]);
+                 }
+             } @mime_words)
+            );
+    return $tmp;
 }
 
 =head2 encode_rfc1522
@@ -285,9 +331,10 @@ sub encode_rfc1522 {
 
      # handle being passed undef properly
      return undef if not defined $rawstr;
-     if (is_utf8($rawstr)) {
-        $rawstr= encode_utf8($rawstr);
-     }
+
+     # convert to octets if we are given a string in perl's internal
+     # encoding
+     $rawstr= encode_utf8($rawstr) if is_utf8($rawstr);
      # We process words in reverse so we can preserve spacing between
      # encoded words. This regex splits on word|nonword boundaries and
      # nonword|nonword boundaries. We also consider parenthesis and "