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::Pkgreport;
14 Debbugs::CGI::Pkgreport -- specific routines for the pkgreport 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);
36 use Debbugs::Config qw(:config :globals);
37 use Debbugs::CGI qw(:url :html :util);
38 use Debbugs::Common qw(:misc :util :date);
39 use Debbugs::Status qw(:status);
40 use Debbugs::Bugs qw(bug_filter);
41 use Debbugs::Packages qw(:mapping);
43 use Debbugs::Text qw(:templates);
45 use POSIX qw(strftime);
49 ($VERSION) = q$Revision: 494 $ =~ /^Revision:\s+([^\s+])/;
50 $DEBUG = 0 unless defined $DEBUG;
53 %EXPORT_TAGS = (html => [qw(short_bug_status_html pkg_htmlizebugs),
55 qw(pkg_htmlselectyesno pkg_htmlselectsuite),
56 qw(buglinklist pkg_htmlselectarch)
58 misc => [qw(generate_package_info make_order_list),
60 qw(get_bug_order_index determine_ordering),
64 Exporter::export_ok_tags(keys %EXPORT_TAGS);
65 $EXPORT_TAGS{all} = [@EXPORT_OK];
68 =head2 generate_package_info
70 generate_package_info($srcorbin,$package)
72 Generates the informational bits for a package and returns it
76 sub generate_package_info{
77 my %param = validate_with(params => \@_,
78 spec => {binary => {type => BOOLEAN,
81 package => {type => SCALAR|ARRAYREF,
83 options => {type => HASHREF,
85 bugs => {type => ARRAYREF,
90 my $output_scalar = '';
91 my $output = globify_scalar(\$output_scalar);
93 my $package = $param{package};
95 my %pkgsrc = %{getpkgsrc()};
96 my $srcforpkg = $package;
97 if ($param{binary} and exists $pkgsrc{$package}
98 and defined $pkgsrc{$package}) {
99 $srcforpkg = $pkgsrc{$package};
102 my $showpkg = html_escape($package);
103 my $maintainers = getmaintainers();
104 my $maint = $maintainers->{$srcforpkg};
105 if (defined $maint) {
106 print {$output} '<p>';
107 print {$output} (($maint =~ /,/)? "Maintainer for $showpkg is "
108 : "Maintainers for $showpkg are ") .
109 package_links(maint => $maint);
110 print {$output} ".</p>\n";
113 print {$output} "<p>No maintainer for $showpkg. Please do not report new bugs against this package.</p>\n";
115 my @pkgs = getsrcpkgs($srcforpkg);
116 @pkgs = grep( !/^\Q$package\E$/, @pkgs );
119 if ($param{binary}) {
120 print {$output} "<p>You may want to refer to the following packages that are part of the same source:\n";
123 print {$output} "<p>You may want to refer to the following individual bug pages:\n";
125 #push @pkgs, $src if ( $src && !grep(/^\Q$src\E$/, @pkgs) );
126 print {$output} scalar package_links(package=>[@pkgs]);
127 print {$output} ".\n";
130 my $pseudodesc = getpseudodesc();
131 if ($package and defined($pseudodesc) and exists($pseudodesc->{$package})) {
132 push @references, "to the <a href=\"http://${debbugs::gWebDomain}/pseudo-packages${debbugs::gHTMLSuffix}\">".
133 "list of other pseudo-packages</a>";
136 if ($package and defined $gPackagePages) {
137 push @references, sprintf "to the <a href=\"%s\">%s package page</a>",
138 html_escape("http://${gPackagePages}/$package"), html_escape("$package");
140 if (defined $gSubscriptionDomain) {
141 my $ptslink = $param{binary} ? $srcforpkg : $package;
142 push @references, q(to the <a href="http://).html_escape("$gSubscriptionDomain/$ptslink").q(">Package Tracking System</a>);
144 # Only output this if the source listing is non-trivial.
145 if ($param{binary} and $srcforpkg) {
147 "to the source package ".
148 package_links(src=>$srcforpkg,
149 options => $param{options}) .
154 $references[$#references] = "or $references[$#references]" if @references > 1;
155 print {$output} "<p>You might like to refer ", join(", ", @references), ".</p>\n";
157 if (defined $param{maint} || defined $param{maintenc}) {
158 print {$output} "<p>If you find a bug not listed here, please\n";
159 printf {$output} "<a href=\"%s\">report it</a>.</p>\n",
160 html_escape("http://${debbugs::gWebDomain}/Reporting${debbugs::gHTMLSuffix}");
162 if (not $maint and not @{$param{bugs}}) {
163 print {$output} "<p>There is no record of the " . html_escape($package) .
164 ($param{binary} ? " package" : " source package") .
165 ", and no bugs have been filed against it.</p>";
167 return $output_scalar;
171 =head2 short_bug_status_html
173 print short_bug_status_html(status => read_bug(bug => 5),
179 =item status -- status hashref as returned by read_bug
181 =item options -- hashref of options to pass to package_links (defaults
184 =item bug_options -- hashref of options to pass to bug_links (default
187 =item snippet -- optional snippet of information about the bug to
197 sub short_bug_status_html {
198 my %param = validate_with(params => \@_,
199 spec => {status => {type => HASHREF,
201 options => {type => HASHREF,
204 bug_options => {type => HASHREF,
207 snippet => {type => SCALAR,
213 my %status = %{$param{status}};
215 $status{tags_array} = [sort(split(/\s+/, $status{tags}))];
216 $status{date_text} = strftime('%a, %e %b %Y %T UTC', gmtime($status{date}));
217 $status{mergedwith_array} = [split(/ /,$status{mergedwith})];
219 my @blockedby= split(/ /, $status{blockedby});
220 $status{blockedby_array} = [];
221 if (@blockedby && $status{"pending"} ne 'fixed' && ! length($status{done})) {
222 for my $b (@blockedby) {
223 my %s = %{get_bug_status($b)};
224 next if $s{"pending"} eq 'fixed' || length $s{done};
225 push @{$status{blockedby_array}},{bug_num => $b, subject => $s{subject}, status => \%s};
229 my @blocks= split(/ /, $status{blocks});
230 $status{blocks_array} = [];
231 if (@blocks && $status{"pending"} ne 'fixed' && ! length($status{done})) {
232 for my $b (@blocks) {
233 my %s = %{get_bug_status($b)};
234 next if $s{"pending"} eq 'fixed' || length $s{done};
235 push @{$status{blocks_array}}, {bug_num => $b, subject => $s{subject}, status => \%s};
240 return fill_in_template(template => 'cgi/short_bug_status',
241 variables => {status => \%status,
242 isstrongseverity => \&Debbugs::Status::isstrongseverity,
243 html_escape => \&Debbugs::CGI::html_escape,
244 looks_like_number => \&Scalar::Util::looks_like_number,
246 hole_var => {'&package_links' => \&Debbugs::CGI::package_links,
247 '&bug_links' => \&Debbugs::CGI::bug_links,
248 '&version_url' => \&Debbugs::CGI::version_url,
249 '&secs_to_english' => \&Debbugs::Common::secs_to_english,
250 '&strftime' => \&POSIX::strftime,
257 if ($status{severity} eq 'normal') {
260 elsif (isstrongseverity($status{severity})) {
261 $showseverity = "Severity: <em class=\"severity\">$status{severity}</em>;\n";
264 $showseverity = "Severity: <em>$status{severity}</em>;\n";
267 $result .= package_links(package => $status{package},
268 options => $param{options},
271 my $showversions = '';
272 if (@{$status{found_versions}}) {
273 my @found = @{$status{found_versions}};
274 $showversions .= join ', ', map {s{/}{ }; html_escape($_)} @found;
276 if (@{$status{fixed_versions}}) {
277 $showversions .= '; ' if length $showversions;
278 $showversions .= '<strong>fixed</strong>: ';
279 my @fixed = @{$status{fixed_versions}};
280 $showversions .= join ', ', map {s{/}{ }; html_escape($_)} @fixed;
282 $result .= ' (<a href="'.
283 version_url(package => $status{package},
284 found => $status{found_versions},
285 fixed => $status{fixed_versions},
286 ).qq{">$showversions</a>)} if length $showversions;
289 $result .= $showseverity;
290 $result .= "Reported by: ".package_links(submitter=>$status{originator},
291 class => "submitter",
293 $result .= ";\nOwned by: " . package_links(owner => $status{owner},
294 class => "submitter",
296 if length $status{owner};
297 $result .= ";\nTags: <strong>"
298 . html_escape(join(", ", sort(split(/\s+/, $status{tags}))))
300 if (length($status{tags}));
302 $result .= (length($status{mergedwith})?";\nMerged with ":"") .
303 bug_links(bug => [split(/ /,$status{mergedwith})],
304 class => "submitter",
306 $result .= (length($status{blockedby})?";\nBlocked by ":"") .
307 bug_links(bug => [split(/ /,$status{blockedby})],
308 class => "submitter",
310 $result .= (length($status{blocks})?";\nBlocks ":"") .
311 bug_links(bug => [split(/ /,$status{blocks})],
312 class => "submitter",
315 if (length($status{done})) {
316 $result .= "<br><strong>Done:</strong> " . html_escape($status{done});
317 my $days = bug_archiveable(bug => $status{id},
321 if ($days >= 0 and defined $status{location} and $status{location} ne 'archive') {
322 $result .= ";\n<strong>Can be archived" . ( $days == 0 ? " today" : $days == 1 ? " in $days day" : " in $days days" ) . "</strong>";
324 elsif (defined $status{location} and $status{location} eq 'archived') {
325 $result .= ";\n<strong>Archived.</strong>";
329 unless (length($status{done})) {
330 if (length($status{forwarded})) {
331 $result .= ";\n<strong>Forwarded</strong> to "
334 split /\,\s+/,$status{forwarded}
337 # Check the age of the logfile
338 my ($days_last,$eng_last) = secs_to_english(time - $status{log_modified});
339 my ($days,$eng) = secs_to_english(time - $status{date});
344 $font = "em" if ($days > 30);
345 $font = "strong" if ($days > 60);
346 $efont = "</$font>" if ($font);
347 $font = "<$font>" if ($font);
349 $result .= ";\n ${font}$eng old$efont";
351 if ($days_last > 7) {
354 $font = "em" if ($days_last > 30);
355 $font = "strong" if ($days_last > 60);
356 $efont = "</$font>" if ($font);
357 $font = "<$font>" if ($font);
359 $result .= ";\n ${font}Modified $eng_last ago$efont";
369 sub pkg_htmlizebugs {
370 my %param = validate_with(params => \@_,
371 spec => {bugs => {type => ARRAYREF,
373 names => {type => ARRAYREF,
375 title => {type => ARRAYREF,
377 prior => {type => ARRAYREF,
379 order => {type => ARRAYREF,
381 ordering => {type => SCALAR,
383 bugusertags => {type => HASHREF,
386 bug_rev => {type => BOOLEAN,
389 bug_order => {type => SCALAR,
391 repeatmerged => {type => BOOLEAN,
394 include => {type => ARRAYREF,
397 exclude => {type => ARRAYREF,
400 this => {type => SCALAR,
403 options => {type => HASHREF,
408 my @bugs = @{$param{bugs}};
413 my $footer = "<h2 class=\"outstanding\">Summary</h2>\n";
415 my @dummy = ($gRemoveAge); #, @gSeverityList, @gSeverityDisplay); #, $gHTMLExpireNote);
418 return "<HR><H2>No reports found!</H2></HR>\n";
421 if ( $param{bug_rev} ) {
422 @bugs = sort {$b<=>$a} @bugs;
425 @bugs = sort {$a<=>$b} @bugs;
430 'show_list_header' => 1,
431 'show_list_footer' => 1,
435 # Make the include/exclude map
438 for my $include (make_list($param{include})) {
439 next unless defined $include;
440 my ($key,$value) = split /\s*:\s*/,$include,2;
441 unless (defined $value) {
445 push @{$include{$key}}, split /\s*,\s*/, $value;
447 for my $exclude (make_list($param{exclude})) {
448 next unless defined $exclude;
449 my ($key,$value) = split /\s*:\s*/,$exclude,2;
450 unless (defined $value) {
454 push @{$exclude{$key}}, split /\s*,\s*/, $value;
457 foreach my $bug (@bugs) {
458 my %status = %{get_bug_status(bug=>$bug,
459 (exists $param{dist}?(dist => $param{dist}):()),
460 bugusertags => $param{bugusertags},
461 (exists $param{version}?(version => $param{version}):()),
462 (exists $param{arch}?(arch => $param{arch}):(arch => $config{default_architectures})),
465 next if bug_filter(bug => $bug,
467 repeat_merged => $param{repeatmerged},
468 seen_merged => \%seenmerged,
469 (keys %include ? (include => \%include):()),
470 (keys %exclude ? (exclude => \%exclude):()),
473 my $html = "<li>"; #<a href=\"%s\">#%d: %s</a>\n<br>",
474 #bug_url($bug), $bug, html_escape($status{subject});
475 $html .= short_bug_status_html(status => \%status,
476 options => $param{options},
478 push @status, [ $bug, \%status, $html ];
480 if ($param{bug_order} eq 'age') {
482 @status = sort {$a->[1]{log_modified} <=> $b->[1]{log_modified}} @status;
484 elsif ($param{bug_order} eq 'agerev') {
485 @status = sort {$b->[1]{log_modified} <=> $a->[1]{log_modified}} @status;
487 for my $entry (@status) {
489 for my $i (0..$#{$param{prior}}) {
490 my $v = get_bug_order_index($param{prior}[$i], $entry->[1]);
491 $count{"g_${i}_${v}"}++;
494 $section{$key} .= $entry->[2];
499 if ($param{ordering} eq "raw") {
500 $result .= "<UL class=\"bugs\">\n" . join("", map( { $_->[ 2 ] } @status ) ) . "</UL>\n";
503 $header .= "<div class=\"msgreceived\">\n<ul>\n";
504 my @keys_in_order = ("");
505 for my $o (@{$param{order}}) {
506 push @keys_in_order, "X";
507 while ((my $k = shift @keys_in_order) ne "X") {
510 push @keys_in_order, "${k}_${k2}";
514 for my $order (@keys_in_order) {
515 next unless defined $section{$order};
516 my @ttl = split /_/, $order;
518 my $title = $param{title}[0]->[$ttl[0]] . " bugs";
521 $title .= join("; ", grep {($_ || "") ne ""}
522 map { $param{title}[$_]->[$ttl[$_]] } 1..$#ttl);
524 $title = html_escape($title);
526 my $count = $count{"_$order"};
527 my $bugs = $count == 1 ? "bug" : "bugs";
529 $header .= "<li><a href=\"#$order\">$title</a> ($count $bugs)</li>\n";
530 if ($common{show_list_header}) {
531 my $count = $count{"_$order"};
532 my $bugs = $count == 1 ? "bug" : "bugs";
533 $result .= "<H2 CLASS=\"outstanding\"><a name=\"$order\"></a>$title ($count $bugs)</H2>\n";
536 $result .= "<H2 CLASS=\"outstanding\">$title</H2>\n";
538 $result .= "<div class=\"msgreceived\">\n<UL class=\"bugs\">\n";
539 $result .= "\n\n\n\n";
540 $result .= $section{$order};
541 $result .= "\n\n\n\n";
542 $result .= "</UL>\n</div>\n";
544 $header .= "</ul></div>\n";
546 $footer .= "<div class=\"msgreceived\">\n<ul>\n";
547 for my $i (0..$#{$param{prior}}) {
548 my $local_result = '';
549 foreach my $key ( @{$param{order}[$i]} ) {
550 my $count = $count{"g_${i}_$key"};
551 next if !$count or !$param{title}[$i]->[$key];
552 $local_result .= "<li>$count $param{title}[$i]->[$key]</li>\n";
554 if ( $local_result ) {
555 $footer .= "<li>$param{names}[$i]<ul>\n$local_result</ul></li>\n";
558 $footer .= "</ul>\n</div>\n";
561 $result = $header . $result if ( $common{show_list_header} );
562 $result .= $footer if ( $common{show_list_footer} );
567 return fill_in_template(template=>'cgi/pkgreport_javascript',
571 sub pkg_htmlselectyesno {
572 my ($name, $n, $y, $default) = @_;
573 return sprintf('<select name="%s"><option value=no%s>%s</option><option value=yes%s>%s</option></select>', $name, ($default ? "" : " selected"), $n, ($default ? " selected" : ""), $y);
576 sub pkg_htmlselectsuite {
577 my $id = sprintf "b_%d_%d_%d", $_[0], $_[1], $_[2];
578 my @suites = ("stable", "testing", "unstable", "experimental");
579 my %suiteaka = ("stable", "etch", "testing", "lenny", "unstable", "sid");
580 my $defaultsuite = "unstable";
582 my $result = sprintf '<select name=dist id="%s">', $id;
583 for my $s (@suites) {
584 $result .= sprintf '<option value="%s"%s>%s%s</option>',
585 $s, ($defaultsuite eq $s ? " selected" : ""),
586 $s, (defined $suiteaka{$s} ? " (" . $suiteaka{$s} . ")" : "");
588 $result .= '</select>';
592 sub pkg_htmlselectarch {
593 my $id = sprintf "b_%d_%d_%d", $_[0], $_[1], $_[2];
594 my @arches = qw(alpha amd64 arm hppa i386 ia64 m68k mips mipsel powerpc s390 sparc);
596 my $result = sprintf '<select name=arch id="%s">', $id;
597 $result .= '<option value="any">any architecture</option>';
598 for my $a (@arches) {
599 $result .= sprintf '<option value="%s">%s</option>', $a, $a;
601 $result .= '</select>';
607 return html_escape(pkg_url(map {exists $param{$_}?($_,$param{$_}):()}
608 qw(archive repeatmerged mindays maxdays),
609 qw(version dist arch package src tag maint submitter)
614 sub make_order_list {
618 if ($vfull =~ m/^([^:]+):(.*)$/) {
620 for my $vv (split /,/, $2) {
625 for my $v (split /,/, $vfull) {
626 next unless $v =~ m/.=./;
630 push @x, ""; # catch all
634 sub get_bug_order_index {
640 %tags = map { $_, 1 } split / /, $status->{"tags"}
641 if defined $status->{"tags"};
643 for my $el (@${order}) {
646 for my $item (split /[+]/, $el) {
647 my ($f, $v) = split /=/, $item, 2;
648 next unless (defined $f and defined $v);
650 $isokay = 1 if (defined $status->{$f} and $v eq $status->{$f});
651 $isokay = 1 if ($f eq "tag" && defined $tags{$v});
666 my ($prefix, $infix, @els) = @_;
667 return '' if not @els;
668 return $prefix . bug_linklist($infix,'submitter',@els);
672 # sets: my @names; my @prior; my @title; my @order;
674 sub determine_ordering {
675 my %param = validate_with(params => \@_,
676 spec => {cats => {type => HASHREF,
678 param => {type => HASHREF,
680 ordering => {type => SCALARREF,
682 names => {type => ARRAYREF,
684 pend_rev => {type => BOOLEAN,
687 sev_rev => {type => BOOLEAN,
690 prior => {type => ARRAYREF,
692 title => {type => ARRAYREF,
694 order => {type => ARRAYREF,
698 $param{cats}{status}[0]{ord} = [ reverse @{$param{cats}{status}[0]{ord}} ]
699 if ($param{pend_rev});
700 $param{cats}{severity}[0]{ord} = [ reverse @{$param{cats}{severity}[0]{ord}} ]
701 if ($param{sev_rev});
704 if (defined $param{param}{"pri0"}) {
707 while (defined $param{param}{"pri$i"}) {
710 my ($pri) = make_list($param{param}{"pri$i"});
711 if ($pri =~ m/^([^:]*):(.*)$/) {
712 $h->{"nam"} = $1; # overridden later if necesary
713 $h->{"pri"} = [ map { "$1=$_" } (split /,/, $2) ];
716 $h->{"pri"} = [ split /,/, $pri ];
719 ($h->{"nam"}) = make_list($param{param}{"nam$i"})
720 if (defined $param{param}{"nam$i"});
721 $h->{"ord"} = [ map {split /\s*,\s*/} make_list($param{param}{"ord$i"}) ]
722 if (defined $param{param}{"ord$i"});
723 $h->{"ttl"} = [ map {split /\s*,\s*/} make_list($param{param}{"ttl$i"}) ]
724 if (defined $param{param}{"ttl$i"});
729 $param{cats}{"_"} = [@c];
730 ${$param{ordering}} = "_";
733 ${$param{ordering}} = "normal" unless defined $param{cats}{${$param{ordering}}};
739 for my $c (@{$cats->{$o}}) {
740 if (ref($c) eq "HASH") {
744 push @res, get_ordering($cats, $c);
749 my @cats = get_ordering($param{cats}, ${$param{ordering}});
753 $expr =~ s/[+]/ and /g;
754 $expr =~ s/[a-z]+=//g;
761 push @{$param{prior}}, $c->{"pri"};
762 push @{$param{names}}, ($c->{"nam"} || "Bug attribute #" . $i);
763 if (defined $c->{"ord"}) {
764 push @{$param{order}}, $c->{"ord"};
767 push @{$param{order}}, [ 0..$#{$param{prior}[-1]} ];
769 my @t = @{ $c->{"ttl"} } if defined $c->{ttl};
770 if (@t < $#{$param{prior}[-1]}) {
771 push @t, map { toenglish($param{prior}[-1][$_]) } @t..($#{$param{prior}[-1]});
773 push @t, $c->{"def"} || "";
774 push @{$param{title}}, [@t];