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.
5 # [Other people have contributed to this file; their copyrights should
7 # Copyright 2008 by Don Armstrong <don@donarmstrong.com>.
10 package Debbugs::CGI::Bugreport;
14 Debbugs::CGI::Bugreport -- specific routines for the bugreport cgi script
30 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT);
31 use base qw(Exporter);
34 use Params::Validate qw(validate_with :types);
35 use Digest::MD5 qw(md5_hex);
36 use Debbugs::Mail qw(get_addresses);
37 use Debbugs::MIME qw(decode_rfc1522 create_mime_message);
38 use Debbugs::CGI qw(:url :html :util);
39 use Debbugs::Common qw(globify_scalar english_join);
41 use Debbugs::Config qw(:config);
42 use POSIX qw(strftime);
43 use Encode qw(decode_utf8);
46 ($VERSION) = q$Revision: 494 $ =~ /^Revision:\s+([^\s+])/;
47 $DEBUG = 0 unless defined $DEBUG;
51 @EXPORT_OK = (qw(display_entity handle_record handle_email_message));
52 Exporter::export_ok_tags(keys %EXPORT_TAGS);
53 $EXPORT_TAGS{all} = [@EXPORT_OK];
60 display_entity(entity => $entity,
64 attachments => \@attachments,
70 =item entity -- MIME::Parser entity
72 =item bug_num -- Bug number
74 =item outer -- Whether this is the outer entity; defaults to 1
76 =item msg_num -- message number in the log
78 =item attachments -- arrayref of attachments
80 =item output -- scalar reference for output
87 my %param = validate_with(params => \@_,
88 spec => {entity => {type => OBJECT,
90 bug_num => {type => SCALAR,
93 outer => {type => BOOLEAN,
96 msg_num => {type => SCALAR,
98 attachments => {type => ARRAYREF,
101 output => {type => SCALARREF|HANDLE,
104 terse => {type => BOOLEAN,
107 msg => {type => SCALAR,
110 att => {type => SCALAR,
113 trim_headers => {type => BOOLEAN,
119 $param{output} = globify_scalar($param{output});
120 my $entity = $param{entity};
121 my $ref = $param{bug_num};
122 my $top = $param{outer};
123 my $xmessage = $param{msg_num};
124 my $attachments = $param{attachments};
126 my $head = $entity->head;
127 my $disposition = $head->mime_attr('content-disposition');
128 $disposition = 'inline' if not defined $disposition or $disposition eq '';
129 my $type = $entity->effective_type;
130 my $filename = $entity->head->recommended_filename;
131 $filename = '' unless defined $filename;
132 $filename = decode_rfc1522($filename);
134 if ($param{outer} and
135 not $param{terse} and
136 not exists $param{att}) {
137 my $header = $entity->head;
138 print {$param{output}} "<div class=\"headers\">\n";
139 if ($param{trim_headers}) {
141 foreach (qw(From To Cc Subject Date)) {
142 my $head_field = $head->get($_);
143 next unless defined $head_field and $head_field ne '';
145 my $libravatar_url = __libravatar_url(decode_rfc1522($head_field));
146 if (defined $libravatar_url and length $libravatar_url) {
147 push @headers,q(<img src=").$libravatar_url.q(">);
150 push @headers, qq(<p><span class="header">$_:</span> ) . html_escape(decode_rfc1522($head_field))."</p>";
152 print {$param{output}} join(qq(), @headers);
154 print {$param{output}} "<pre>".html_escape(decode_rfc1522($entity->head->stringify))."</pre>\n";
156 print {$param{output}} "</div>\n";
159 if (not (($param{outer} and $type =~ m{^text(?:/plain)?(?:;|$)})
160 or $type =~ m{^multipart/}
162 push @$attachments, $param{entity};
163 # output this attachment
164 if (exists $param{att} and
165 $param{att} == $#$attachments) {
166 my $head = $entity->head;
167 chomp(my $type = $entity->effective_type);
168 my $body = $entity->stringify_body;
169 # this attachment has its own content type, so we must not
170 # try to convert it to UTF-8 or do anything funky.
171 my @layers = PerlIO::get_layers($param{output});
172 binmode($param{output},':raw');
173 print {$param{output}} "Content-Type: $type";
174 my ($charset) = $head->get('Content-Type:') =~ m/charset\s*=\s*\"?([\w-]+)\"?/i;
175 print {$param{output}} qq(; charset="$charset") if defined $charset;
176 print {$param{output}} "\n";
177 if ($filename ne '') {
181 print {$param{output}} qq{Content-Disposition: inline; filename="$qf"\n};
183 print {$param{output}} "\n";
184 my $decoder = MIME::Decoder->new($head->mime_encoding);
185 $decoder->decode(IO::Scalar->new(\$body), $param{output});
186 if (grep {/utf8/} @layers) {
187 binmode($param{output},':utf8');
191 elsif (not exists $param{att}) {
192 my @dlargs = (msg=>$xmessage, att=>$#$attachments);
193 push @dlargs, (filename=>$filename) if $filename ne '';
194 my $printname = $filename;
195 $printname = 'Message part ' . ($#$attachments + 1) if $filename eq '';
196 print {$param{output}} '<pre class="mime">[<a href="' .
197 html_escape(bug_links(bug => $ref,
199 options => {@dlargs})
200 ) . qq{">$printname</a> } .
201 "($type, $disposition)]</pre>\n";
205 return if not $param{outer} and $disposition eq 'attachment' and not exists $param{att};
206 return unless ($type =~ m[^text/?] and
207 $type !~ m[^text/(?:html|enriched)(?:;|$)]) or
208 $type =~ m[^application/pgp(?:;|$)] or
211 if ($entity->is_multipart) {
212 my @parts = $entity->parts;
213 foreach my $part (@parts) {
214 display_entity(entity => $part,
217 msg_num => $xmessage,
218 output => $param{output},
219 attachments => $attachments,
220 terse => $param{terse},
221 exists $param{msg}?(msg=>$param{msg}):(),
222 exists $param{att}?(att=>$param{att}):(),
224 # print {$param{output}} "\n";
226 } elsif ($entity->parts) {
227 # We must be dealing with a nested message.
228 if (not exists $param{att}) {
229 print {$param{output}} "<blockquote>\n";
231 my @parts = $entity->parts;
232 foreach my $part (@parts) {
233 display_entity(entity => $part,
236 msg_num => $xmessage,
237 output => $param{output},
238 attachments => $attachments,
239 terse => $param{terse},
240 exists $param{msg}?(msg=>$param{msg}):(),
241 exists $param{att}?(att=>$param{att}):(),
243 # print {$param{output}} "\n";
245 if (not exists $param{att}) {
246 print {$param{output}} "</blockquote>\n";
248 } elsif (not $param{terse}) {
249 my $content_type = $entity->head->get('Content-Type:') || "text/html";
250 my ($charset) = $content_type =~ m/charset\s*=\s*\"?([\w-]+)\"?/i;
251 my $body = $entity->bodyhandle->as_string;
252 $body = convert_to_utf8($body,$charset//'utf8');
253 $body = html_escape($body);
254 # Attempt to deal with format=flowed
255 if ($content_type =~ m/format\s*=\s*\"?flowed\"?/i) {
256 $body =~ s{^\ }{}mgo;
257 # we ignore the other things that you can do with
258 # flowed e-mails cause they don't really matter.
261 # We don't html escape here because we escape above;
262 # wierd terminators are because of that
263 $body =~ s{((?:ftp|http|https|svn|ftps|rsync)://[\S~-]+?/?) # Url
264 ((?:\>\;)?[)]?(?:'|\&\#39\;)?[:.\,]?(?:\s|$)) # terminators
265 }{<a href=\"$1\">$1</a>$2}gox;
266 # Add links to bug closures
267 $body =~ s[(closes:\s*(?:bug)?\#?\s?\d+(?:,?\s*(?:bug)?\#?\s?\d+)*)]
270 {bug_links(bug=>$1)}ge;
272 if (defined $config{cve_tracker} and
273 length $config{cve_tracker}
275 # Add links to CVE vulnerabilities (closes #568464)
276 $body =~ s{(^|\s)(CVE-\d{4}-\d{4,})(\s|[,.-\[\]]|$)}
277 {$1<a href="http://$config{cve_tracker}$2">$2</a>$3}gxm;
279 if (not exists $param{att}) {
280 print {$param{output}} qq(<pre class="message">$body</pre>\n);
286 =head2 handle_email_message
288 handle_email_message($record->{text},
290 msg_num => $msg_number,
293 Returns a decoded e-mail message and displays entities/attachments as
299 sub handle_email_message{
300 my ($email,%param) = @_;
302 # output needs to have the is_utf8 flag on to avoid double
304 my $output = decode_utf8('');
305 my $parser = MIME::Parser->new();
306 # Because we are using memory, not tempfiles, there's no need to
307 # clean up here like in Debbugs::MIME
308 $parser->tmp_to_core(1);
309 $parser->output_to_core(1);
310 my $entity = $parser->parse_data( $email);
311 my @attachments = ();
312 display_entity(entity => $entity,
313 bug_num => $param{ref},
315 msg_num => $param{msg_num},
317 attachments => \@attachments,
318 terse => $param{terse},
319 exists $param{msg}?(msg=>$param{msg}):(),
320 exists $param{att}?(att=>$param{att}):(),
321 exists $param{trim_headers}?(trim_headers=>$param{trim_headers}):(),
329 push @log, handle_record($record,$ref,$msg_num);
331 Deals with a record in a bug log as returned by
332 L<Debbugs::Log::read_log_records>; returns the log information that
333 should be output to the browser.
338 my ($record,$bug_number,$msg_number,$seen_msg_ids) = @_;
340 # output needs to have the is_utf8 flag on to avoid double
342 my $output = decode_utf8('');
343 local $_ = $record->{type};
345 # $record->{text} is not in perl's internal encoding; convert it
346 my $text = decode_rfc1522(decode_utf8($record->{text}));
347 my ($time) = $text =~ /<!--\s+time:(\d+)\s+-->/;
348 my $class = $text =~ /^<strong>(?:Acknowledgement|Reply|Information|Report|Notification)/m ? 'infmessage':'msgreceived';
350 # Link to forwarded http:// urls in the midst of the report
351 # (even though these links already exist at the top)
352 $output =~ s,((?:ftp|http|https)://[\S~-]+?/?)((?:[\)\'\:\.\,]|\&\#39;)?(?:\s|\.<|$)),<a href=\"$1\">$1</a>$2,go;
353 # Add links to the cloned bugs
354 $output =~ s{(Bug )(\d+)( cloned as bugs? )(\d+)(?:\-(\d+)|)}{$1.bug_links(bug=>$2).$3.bug_links(bug=>(defined $5)?[$4..$5]:$4)}eo;
355 # Add links to merged bugs
356 $output =~ s{(?<=Merged )([\d\s]+)(?=\.)}{join(' ',map {bug_links(bug=>$_)} (split /\s+/, $1))}eo;
357 # Add links to blocked bugs
358 $output =~ s{(?<=Blocking bugs)(?:( of )(\d+))?( (?:added|set to|removed):\s+)([\d\s\,]+)}
359 {(defined $2?$1.bug_links(bug=>$2):'').$3.
360 english_join([map {bug_links(bug=>$_)} (split /\,?\s+/, $4)])}eo;
361 $output =~ s{((?:[Aa]dded|[Rr]emoved)\ blocking\ bug(?:\(s\))?)(?:(\ of\ )(\d+))?(:?\s+)
362 (\d+(?:,\s+\d+)*(?:\,?\s+and\s+\d+)?)}
363 {$1.(defined $3?$2.bug_links(bug=>$3):'').$4.
364 english_join([map {bug_links(bug=>$_)} (split /\,?\s+(?:and\s+)?/, $5)])}xeo;
365 $output =~ s{([Aa]dded|[Rr]emoved)( indication that bug )(\d+)( blocks )([\d\s\,]+)}
366 {$1.$2.(bug_links(bug=>$3)).$4.
367 english_join([map {bug_links(bug=>$_)} (split /\,?\s+(?:and\s+)?/, $5)])}eo;
368 # Add links to reassigned packages
369 $output =~ s{(Bug reassigned from package \`)([^']+?)((?:'|\&\#39;) to \`)([^']+?)((?:'|\&\#39;))}
370 {$1.q(<a href=").html_escape(package_links(package=>$2)).qq(">$2</a>).$3.q(<a href=").html_escape(package_links(package=>$4)).qq(">$4</a>).$5}eo;
372 $output .= ' ('.strftime('%a, %d %b %Y %T GMT',gmtime($time)).') ';
374 $output .= '<a href="' .
375 html_escape(bug_links(bug => $bug_number,
376 options => {msg => ($msg_number+1)},
379 ) . '">Full text</a> and <a href="' .
380 html_escape(bug_links(bug => $bug_number,
381 options => {msg => ($msg_number+1),
384 ) . '">rfc822 format</a> available.';
386 $output = qq(<div class="$class"><hr>\n<a name="$msg_number"></a>\n) . $output . "</div>\n";
389 my ($msg_id) = $record->{text} =~ /^Message-Id:\s+<(.+)>/im;
390 if (defined $msg_id and exists $$seen_msg_ids{$msg_id}) {
393 elsif (defined $msg_id) {
394 $$seen_msg_ids{$msg_id} = 1;
396 $output .= qq(<hr><p class="msgreceived"><a name="$msg_number"></a>\n);
397 $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>';
398 $output .= handle_email_message($record->{text},
400 msg_num => $msg_number,
403 elsif (/autocheck/) {
406 elsif (/incoming-recv/) {
407 my ($msg_id) = $record->{text} =~ /^Message-Id:\s+<(.+)>/im;
408 if (defined $msg_id and exists $$seen_msg_ids{$msg_id}) {
411 elsif (defined $msg_id) {
412 $$seen_msg_ids{$msg_id} = 1;
414 # Incomming Mail Message
415 my ($received,$hostname) = $record->{text} =~ m/Received: \(at (\S+)\) by (\S+)\;/;
416 $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 |.
417 html_escape("$received\@$hostname") .
418 q| (<a href="| . html_escape(bug_links(bug => $bug_number, links_only => 1, options => {msg=>$msg_number})) . '">full text</a>'.
419 q|, <a href="| . html_escape(bug_links(bug => $bug_number,
421 options => {msg=>$msg_number,
424 ) .'">mbox</a>)'.":</p>\n";
425 $output .= handle_email_message($record->{text},
427 msg_num => $msg_number,
431 die "Unknown record type $_";
437 sub __libravatar_url {
439 if (not defined $config{libravatar_uri} or not length $config{libravatar_uri}) {
442 ($email) = get_addresses($email);
443 return $config{libravatar_uri}.md5_hex(lc($email)).($config{libravatar_uri_options}//'');