Debbugs/CGI/Bugreport.pm

   1 # This module is part of debbugs, and is released
   2 # under the terms of the GPL version 2, or any later version. See the
   3 # file README and COPYING for more information.
   4 #
   5 # [Other people have contributed to this file; their copyrights should
   6 # be listed here too.]
   7 # Copyright 2008 by Don Armstrong <don@donarmstrong.com>.
   8
   9
  10 package Debbugs::CGI::Bugreport;
  11
  12 =head1 NAME
  13
  14 Debbugs::CGI::Bugreport -- specific routines for the bugreport cgi script
  15
  16 =head1 SYNOPSIS
  17
  18
  19 =head1 DESCRIPTION
  20
  21
  22 =head1 BUGS
  23
  24 None known.
  25
  26 =cut
  27
  28 use warnings;
  29 use strict;
  30 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT);
  31 use base qw(Exporter);
  32
  33 use IO::Scalar;
  34 use Params::Validate qw(validate_with :types);
  35 use Debbugs::MIME qw(convert_to_utf8 decode_rfc1522 create_mime_message);
  36 use Debbugs::CGI qw(:url :html :util);
  37 use Debbugs::Common qw(globify_scalar);
  38 use POSIX qw(strftime);
  39
  40 BEGIN{
  41      ($VERSION) = q$Revision: 494 $ =~ /^Revision:\s+([^\s+])/;
  42      $DEBUG = 0 unless defined $DEBUG;
  43
  44      @EXPORT = ();
  45      %EXPORT_TAGS = ();
  46      @EXPORT_OK = (qw(display_entity handle_record handle_email_message));
  47      Exporter::export_ok_tags(keys %EXPORT_TAGS);
  48      $EXPORT_TAGS{all} = [@EXPORT_OK];
  49 }
  50
  51
  52
  53 =head2 display_entity
  54
  55      display_entity(entity      => $entity,
  56                     bug_num     => $ref,
  57                     outer       => 1,
  58                     msg_num     => $msg_num,
  59                     attachments => \@attachments,
  60                     output      => \$output);
  61
  62
  63 =over
  64
  65 =item entity -- MIME::Parser entity
  66
  67 =item bug_num -- Bug number
  68
  69 =item outer -- Whether this is the outer entity; defaults to 1
  70
  71 =item msg_num -- message number in the log
  72
  73 =item attachments -- arrayref of attachments
  74
  75 =item output -- scalar reference for output
  76
  77 =back
  78
  79 =cut
  80
  81 sub display_entity {
  82     my %param = validate_with(params => \@_,
  83                               spec   => {entity      => {type => OBJECT,
  84                                                         },
  85                                          bug_num     => {type => SCALAR,
  86                                                          regex => qr/^\d+$/,
  87                                                         },
  88                                          outer       => {type => BOOLEAN,
  89                                                          default => 1,
  90                                                         },
  91                                          msg_num     => {type => SCALAR,
  92                                                         },
  93                                          attachments => {type => ARRAYREF,
  94                                                          default => [],
  95                                                         },
  96                                          output      => {type => SCALARREF|HANDLE,
  97                                                          default => \*STDOUT,
  98                                                         },
  99                                          terse       => {type => BOOLEAN,
 100                                                          default => 0,
 101                                                         },
 102                                          msg         => {type => SCALAR,
 103                                                          optional => 1,
 104                                                         },
 105                                          att         => {type => SCALAR,
 106                                                          optional => 1,
 107                                                         },
 108                                          trim_headers => {type => BOOLEAN,
 109                                                           default => 1,
 110                                                          },
 111                                         }
 112                              );
 113
 114     $param{output} = globify_scalar($param{output});
 115     my $entity = $param{entity};
 116     my $ref = $param{bug_num};
 117     my $top = $param{outer};
 118     my $xmessage = $param{msg_num};
 119     my $attachments = $param{attachments};
 120
 121     my $head = $entity->head;
 122     my $disposition = $head->mime_attr('content-disposition');
 123     $disposition = 'inline' if not defined $disposition or $disposition eq '';
 124     my $type = $entity->effective_type;
 125     my $filename = $entity->head->recommended_filename;
 126     $filename = '' unless defined $filename;
 127     $filename = decode_rfc1522($filename);
 128
 129     if ($param{outer} and
 130         not $param{terse} and
 131         not exists $param{att}) {
 132          my $header = $entity->head;
 133          print {$param{output}} "<pre class=\"headers\">\n";
 134          if ($param{trim_headers}) {
 135               my @headers;
 136               foreach (qw(From To Cc Subject Date)) {
 137                    my $head_field = $head->get($_);
 138                    next unless defined $head_field and $head_field ne '';
 139                    push @headers, qq(<b>$_:</b> ) . html_escape(decode_rfc1522($head_field));
 140               }
 141               print {$param{output}} join(qq(), @headers);
 142          } else {
 143               print {$param{output}} html_escape(decode_rfc1522($entity->head->stringify));
 144          }
 145          print {$param{output}} "</pre>\n";
 146     }
 147
 148     if (not (($param{outer} and $type =~ m{^text(?:/plain)?(?:;|$)})
 149              or $type =~ m{^multipart/}
 150             )) {
 151         push @$attachments, $param{entity};
 152         # output this attachment
 153         if (exists $param{att} and
 154             $param{att} == $#$attachments) {
 155             my $head = $entity->head;
 156             chomp(my $type = $entity->effective_type);
 157             my $body = $entity->stringify_body;
 158             print {$param{output}} "Content-Type: $type";
 159             my ($charset) = $head->get('Content-Type:') =~ m/charset\s*=\s*\"?([\w-]+)\"?/i;
 160             print {$param{output}} qq(; charset="$charset") if defined $charset;
 161             print {$param{output}}"\n";
 162             if ($filename ne '') {
 163                 my $qf = $filename;
 164                 $qf =~ s/"/\\"/g;
 165                 $qf =~ s[.*/][];
 166                 print {$param{output}} qq{Content-Disposition: inline; filename="$qf"\n};
 167             }
 168             print {$param{output}} "\n";
 169             my $decoder = MIME::Decoder->new($head->mime_encoding);
 170             $decoder->decode(IO::Scalar->new(\$body), $param{output});
 171             return;
 172         }
 173         elsif (not exists $param{att}) {
 174              my @dlargs = (msg=>$xmessage, att=>$#$attachments);
 175              push @dlargs, (filename=>$filename) if $filename ne '';
 176              my $printname = $filename;
 177              $printname = 'Message part ' . ($#$attachments + 1) if $filename eq '';
 178              print {$param{output}} '<pre class="mime">[<a href="' .
 179                   html_escape(bug_links(bug => $ref,
 180                                         links_only => 1,
 181                                         options => {@dlargs})
 182                              ) . qq{">$printname</a> } .
 183                                   "($type, $disposition)]</pre>\n";
 184         }
 185     }
 186
 187     return if not $param{outer} and $disposition eq 'attachment' and not exists $param{att};
 188     return unless ($type =~ m[^text/?] and
 189                    $type !~ m[^text/(?:html|enriched)(?:;|$)]) or
 190                   $type =~ m[^application/pgp(?:;|$)] or
 191                   $entity->parts;
 192
 193     if ($entity->is_multipart) {
 194         my @parts = $entity->parts;
 195         foreach my $part (@parts) {
 196             display_entity(entity => $part,
 197                            bug_num => $ref,
 198                            outer => 0,
 199                            msg_num => $xmessage,
 200                            output => $param{output},
 201                            attachments => $attachments,
 202                            terse => $param{terse},
 203                            exists $param{msg}?(msg=>$param{msg}):(),
 204                            exists $param{att}?(att=>$param{att}):(),
 205                           );
 206             # print {$param{output}} "\n";
 207         }
 208     } elsif ($entity->parts) {
 209         # We must be dealing with a nested message.
 210          if (not exists $param{att}) {
 211               print {$param{output}} "<blockquote>\n";
 212          }
 213         my @parts = $entity->parts;
 214         foreach my $part (@parts) {
 215             display_entity(entity => $part,
 216                            bug_num => $ref,
 217                            outer => 1,
 218                            msg_num => $xmessage,
 219                            output => $param{output},
 220                            attachments => $attachments,
 221                            terse => $param{terse},
 222                            exists $param{msg}?(msg=>$param{msg}):(),
 223                            exists $param{att}?(att=>$param{att}):(),
 224                           );
 225             # print {$param{output}} "\n";
 226         }
 227          if (not exists $param{att}) {
 228               print {$param{output}} "</blockquote>\n";
 229          }
 230     } elsif (not $param{terse}) {
 231          my $content_type = $entity->head->get('Content-Type:') || "text/html";
 232          my ($charset) = $content_type =~ m/charset\s*=\s*\"?([\w-]+)\"?/i;
 233          my $body = $entity->bodyhandle->as_string;
 234          $body = convert_to_utf8($body,$charset) if defined $charset;
 235          $body = html_escape($body);
 236          # Attempt to deal with format=flowed
 237          if ($content_type =~ m/format\s*=\s*\"?flowed\"?/i) {
 238               $body =~ s{^\ }{}mgo;
 239               # we ignore the other things that you can do with
 240               # flowed e-mails cause they don't really matter.
 241          }
 242          # Add links to URLs
 243          # We don't html escape here because we escape above;
 244          # wierd terminators are because of that
 245          $body =~ s{((?:ftp|http|https|svn|ftps|rsync)://[\S~-]+?/?) # Url
 246                     ((?:\&gt\;)?[)]?(?:'|\&\#39\;)?[:.\,]?(?:\s|$)) # terminators
 247               }{<a href=\"$1\">$1</a>$2}gox;
 248          # Add links to bug closures
 249          $body =~ s[(closes:\s*(?:bug)?\#?\s?\d+(?:,?\s*(?:bug)?\#?\s?\d+)*)]
 250                    [my $temp = $1;
 251                     $temp =~ s{(\d+)}
 252                               {bug_links(bug=>$1)}ge;
 253                     $temp;]gxie;
 254
 255          if (not exists $param{att}) {
 256               print {$param{output}} qq(<pre class="message">$body</pre>\n);
 257          }
 258     }
 259 }
 260
 261
 262 =head2 handle_email_message
 263
 264      handle_email_message($record->{text},
 265                           ref        => $bug_number,
 266                           msg_num => $msg_number,
 267                          );
 268
 269 Returns a decoded e-mail message and displays entities/attachments as
 270 appropriate.
 271
 272
 273 =cut
 274
 275 sub handle_email_message{
 276      my ($email,%param) = @_;
 277
 278      my $output = '';
 279      my $parser = MIME::Parser->new();
 280      # Because we are using memory, not tempfiles, there's no need to
 281      # clean up here like in Debbugs::MIME
 282      $parser->tmp_to_core(1);
 283      $parser->output_to_core(1);
 284      my $entity = $parser->parse_data( $email);
 285      my @attachments = ();
 286      display_entity(entity  => $entity,
 287                     bug_num => $param{ref},
 288                     outer   => 1,
 289                     msg_num => $param{msg_num},
 290                     output => \$output,
 291                     attachments => \@attachments,
 292                     terse       => $param{terse},
 293                     exists $param{msg}?(msg=>$param{msg}):(),
 294                     exists $param{att}?(att=>$param{att}):(),
 295                     exists $param{trim_headers}?(trim_headers=>$param{trim_headers}):(),
 296                    );
 297      return $output;
 298
 299 }
 300
 301 =head2 handle_record
 302
 303      push @log, handle_record($record,$ref,$msg_num);
 304
 305 Deals with a record in a bug log as returned by
 306 L<Debbugs::Log::read_log_records>; returns the log information that
 307 should be output to the browser.
 308
 309 =cut
 310
 311 sub handle_record{
 312      my ($record,$bug_number,$msg_number,$seen_msg_ids) = @_;
 313
 314      my $output = '';
 315      local $_ = $record->{type};
 316      if (/html/) {
 317           my ($time) = $record->{text} =~ /<!--\s+time:(\d+)\s+-->/;
 318           my $class = $record->{text} =~ /^<strong>(?:Acknowledgement|Reply|Information|Report|Notification)/m ? 'infmessage':'msgreceived';
 319           $output .= decode_rfc1522($record->{text});
 320           # Link to forwarded http:// urls in the midst of the report
 321           # (even though these links already exist at the top)
 322           $output =~ s,((?:ftp|http|https)://[\S~-]+?/?)([\)\'\:\.\,]?(?:\s|\.<|$)),<a href=\"$1\">$1</a>$2,go;
 323           # Add links to the cloned bugs
 324           $output =~ s{(Bug )(\d+)( cloned as bugs? )(\d+)(?:\-(\d+)|)}{$1.bug_links(bug=>$2).$3.bug_links(bug=>(defined $5)?[$4..$5]:$4)}eo;
 325           # Add links to merged bugs
 326           $output =~ s{(?<=Merged )([\d\s]+)(?=\.)}{join(' ',map {bug_links(bug=>$_)} (split /\s+/, $1))}eo;
 327           # Add links to blocked bugs
 328           $output =~ s{(?<=Blocking bugs)(?:( of )(\d+))?( (?:added|set to|removed):\s+)([\d\s\,]+)}
 329                       {(defined $2?$1.bug_links(bug=>$2):'').$3.
 330                             join(' ',map {bug_links(bug=>$_)} (split /\,?\s+/, $4))}eo;
 331           # Add links to reassigned packages
 332           $output =~ s{(Bug reassigned from package \`)([^']+?)((?:'|\&\#39;) to \`)([^']+?)((?:'|\&\#39;))}
 333           {$1.q(<a href=").html_escape(pkg_url(pkg=>$2)).qq(">$2</a>).$3.q(<a href=").html_escape(pkg_url(pkg=>$4)).qq(">$4</a>).$5}eo;
 334           if (defined $time) {
 335                $output .= ' ('.strftime('%a, %d %b %Y %T GMT',gmtime($time)).') ';
 336           }
 337           $output .= '<a href="' .
 338                html_escape(bug_links(bug => $bug_number,
 339                                      options => {msg => ($msg_number+1)},
 340                                      links_only => 1,
 341                                     )
 342                           ) . '">Full text</a> and <a href="' .
 343                                html_escape(bug_links(bug => $bug_number,
 344                                                      options => {msg => ($msg_number+1),
 345                                                                  mbox => 'yes'},
 346                                                      links_only => 1)
 347                                           ) . '">rfc822 format</a> available.';
 348
 349           $output = qq(<div class="$class"><hr>\n<a name="$msg_number"></a>\n) . $output . "</div>\n";
 350      }
 351      elsif (/recips/) {
 352           my ($msg_id) = $record->{text} =~ /^Message-Id:\s+<(.+)>/im;
 353           if (defined $msg_id and exists $$seen_msg_ids{$msg_id}) {
 354                return ();
 355           }
 356           elsif (defined $msg_id) {
 357                $$seen_msg_ids{$msg_id} = 1;
 358           }
 359           $output .= qq(<hr><p class="msgreceived"><a name="$msg_number"></a>\n);
 360           $output .= 'View this message in <a href="' . html_escape(bug_links(bug=>$bug_number, links_only => 1, options=>{msg=>$msg_number, mbox=>'yes'})) . '">rfc822 format</a></p>';
 361           $output .= handle_email_message($record->{text},
 362                                           ref     => $bug_number,
 363                                           msg_num => $msg_number,
 364                                          );
 365      }
 366      elsif (/autocheck/) {
 367           # Do nothing
 368      }
 369      elsif (/incoming-recv/) {
 370           my ($msg_id) = $record->{text} =~ /^Message-Id:\s+<(.+)>/im;
 371           if (defined $msg_id and exists $$seen_msg_ids{$msg_id}) {
 372                return ();
 373           }
 374           elsif (defined $msg_id) {
 375                $$seen_msg_ids{$msg_id} = 1;
 376           }
 377           # Incomming Mail Message
 378           my ($received,$hostname) = $record->{text} =~ m/Received: \(at (\S+)\) by (\S+)\;/;
 379           $output .= qq|<hr><p class="msgreceived"><a name="$msg_number"></a><a name="msg$msg_number"></a><a href="#$msg_number">Message #$msg_number</a> received at |.
 380                html_escape("$received\@$hostname") .
 381                     q| (<a href="| . html_escape(bug_links(bug => $bug_number, links_only => 1, options => {msg=>$msg_number})) . '">full text</a>'.
 382                          q|, <a href="| . html_escape(bug_links(bug => $bug_number,
 383                                                                 links_only => 1,
 384                                                                 options => {msg=>$msg_number,
 385                                                                             mbox=>'yes'}
 386                                                                )
 387                                                      ) .'">mbox</a>)'.":</p>\n";
 388           $output .= handle_email_message($record->{text},
 389                                           ref     => $bug_number,
 390                                           msg_num => $msg_number,
 391                                          );
 392      }
 393      else {
 394           die "Unknown record type $_";
 395      }
 396      return $output;
 397 }
 398
 399
 400
 401 1;
 402
 403
 404 __END__
 405
 406
 407
 408
 409
 410