dc4aac662351f0b5826a4ed2075d24c45906e418
[bugscan.git] / scanlib.pm
1 #! /usr/bin/perl
2 # vim: ts=4 sw=4 nowrap
3 #
4 # General functions for scanning the BTS-database.
5 # Based on bugscan, written by Richard Braakman <dark@debian.org>,
6 # which was based on an unknown other script.
7 #
8 # Global variables:
9 #   %comments       - map from bugnumber to bug description
10 #   %premature      - list of prematurely closed bugreports
11 #   %exclude        - list of bugreports to exclude from the report
12 #   %maintainer     - map from packagename to maintainer
13 #   %section        - map from packagename to section in the FTP-site
14 #   %packagelist    - map from packagename to bugreports
15 #   %NMU            - map with NMU information
16
17 use lib qw(/org/bugs.debian.org/perl);
18 use LWP::UserAgent;
19 use Debbugs::MIME qw(decode_rfc1522 encode_rfc1522);
20 use Debbugs::Packages;
21 use Debbugs::Versions;
22 use Debbugs::Status;
23 use Fcntl qw(O_RDONLY);
24 use strict;
25 use warnings;
26 require bugcfg;
27 package scanlib;
28
29 our (%comments,%premature,%exclude,%maintainer,%section,%packagelist,%NMU,%debbugssection,%bugs);
30
31 sub readcomments() {
32 # Read bug commentary 
33 # It is in paragraph format, with the first line of each paragraph being
34 # the bug number or package name to which the comment applies.
35 # Prefix a bug number with a * to force it to be listed even if it's closed.
36 # (This deals with prematurely closed bugs)
37
38         my $index;                                      # Bug-number for current comment
39         my $file;                                       # Name of comments-file
40
41         %comments = ();                                 # Initialize our data
42         %premature = ();
43         %exclude = ();
44         $file=shift;
45         open(C, $file) or die "open $file: $!\n";
46         while (<C>) {
47                 chomp;
48                 if (m/^\s*$/) {                         # Check for paragraph-breaks
49                         undef $index;
50                 } elsif (defined $index) {
51                         $comments{$index} .= $_ . "\n";
52                 } else {
53                         if (s/^\*//) {                  # Test & remove initial *
54                                 $premature{$_} = 1;
55                         }
56                         if (s/\s+EXCLUDE\s*//) {        # Test & remove EXCLUDE
57                                 $exclude{$_} = 1;
58                                 next;
59                         }
60                         $index = $_;
61                         $comments{$index} = ''; # New comment, initialize data
62                 }
63         }
64         close(C);
65 }
66
67
68 # Read the list of maintainer 
69 sub readmaintainers() {
70         my $pkg;                                        # Name of package
71         my $mnt;                                        # Maintainer name & email
72
73         open(M, $bugcfg::maintainerlist) or die "open $bugcfg::maintainerlist: $!\n";
74         while (<M>) {
75                 chomp;
76                 m/^(\S+)\s+(\S.*\S)\s*$/ or die "Maintainers: $_ ?";
77                 ($pkg, $mnt) = ($1, $2);
78                 $pkg =~ y/A-Z/a-z/;                     # Normalize package-name. why???
79                 $_=$mnt;
80                 if (not m/</) {
81                         $mnt="$2 <$1>" if ( m/(\S+)\s+\(([^)]+)\)/ );
82                 }
83                 $maintainer{$pkg}= $mnt;
84         }
85         close(M);
86 }
87
88
89 sub readsources() {
90         my $root;                                       # Root of archive we are scanning
91         my $archive;                            # Name of archive we are scanning
92         my $sect;                                       # Name of current section
93
94         $root=shift;
95         $archive=shift;
96         for $sect (@bugcfg::sections) {
97                 open(P, "zcat $root/$sect/source/Sources.gz|")
98                         or die open "open: $sect sourcelist: $!\n";
99                 while (<P>) {
100                         chomp;
101                         next unless m/^Package:\s/;
102                         s/^Package:\s*//;                       # Strip the fieldname
103                         $section{$_} = "$archive/$sect";
104                 }
105                 close (P);
106         }
107 }
108
109 sub readpackages() {
110         my $root;                                       # Root of archive we are scanning
111         my $archive;                            # Name of archive we are scanning
112         my $sect;                                       # Name of current section
113         my $arch;                                       # Name of current architecture
114
115         $root=shift;
116         $archive=shift;
117         for $arch ( @bugcfg::architectures ) {
118                 for $sect ( @bugcfg::sections) {
119                         open(P, "zcat $root/$sect/binary-$arch/Packages.gz|")
120                                 or die "open: $root/$sect/binary-$arch/Packages.gz: $!\n";
121                         while (<P>) {
122                                 chomp;
123                                 next unless m/^Package:\s/;     # We're only interested in the packagenames
124                                 s/^Package:\s*//;                       # Strip the fieldname
125                                 $section{$_} = "$archive/$sect";
126                         }
127                         close(P);
128                 }
129         }
130 }
131
132 sub readdebbugssources() {
133         my $file;
134         my $archive;
135
136         $file=shift;
137         $archive=shift;
138         open(P, $file)
139                 or die "open: $file: $!\n";
140         while (<P>) {
141                 chomp;
142                 my ($host, $bin, $sect, $ver, $src) = split /\s+/;
143                 my $sectname = ($sect =~ /^\Q$archive/) ? $sect : "$archive/$sect";
144                 $debbugssection{$bin} = $sectname;
145                 $debbugssection{$src} = $sectname;
146         }
147         close(P);
148 }
149
150 sub readpseudopackages() {
151         open(P, $bugcfg::pseudolist) or die("open $bugcfg::pseudolist: $!\n");
152         while (<P>) {
153                 chomp;
154                 s/\s.*//;
155                 $section{$_} = "pseudo";
156         }
157         close(P);
158 }
159
160
161 sub scanspool() {
162         my @dirs;
163         my $dir;
164
165         chdir($bugcfg::spooldir) or die "chdir $bugcfg::spooldir: $!\n";
166
167         opendir(DIR, $bugcfg::spooldir) or die "opendir $bugcfg::spooldir: $!\n";
168         @dirs=grep(m/^\d+$/,readdir(DIR));
169         closedir(DIR);
170
171         for $dir (@dirs) {
172                 scanspooldir("$bugcfg::spooldir/$dir");
173         }
174
175 }
176
177 sub scanspooldir() {
178         my ($dir)               = @_;
179         my $f;                  # While we're currently processing
180         my @list;               # List of files to process
181         my $skip;               # Flow control
182         my $walk;               # index variable
183         my $taginfo;    # Tag info
184
185         chdir($dir) or die "chdir $dir: $!\n";
186
187         opendir(DIR, $dir) or die "opendir $dir: $!\n";
188         @list = grep { s/\.summary$// }
189                         grep { m/^\d+\.summary$/ } 
190                         readdir(DIR);
191         closedir(DIR);
192
193         for $f (@list) {
194                 next if $exclude{$f};                   # Check the list of bugs to skip
195         
196                 my $bug = Debbugs::Status::read_bug(summary => "$f.summary");
197                 next if (!defined($bug));
198                 
199                 $skip=1;
200                 for $walk (@bugcfg::priorities) {
201                         $skip=0 if $walk eq $bug->{'severity'};
202                 }
203
204                 my @tags = split(' ', $bug->{'keywords'});
205                 for my $tag (@tags) {
206                         for my $s (@bugcfg::skiptags) {
207                                 $skip=1 if $tag eq $s;
208                         }
209                 }
210                 next if $skip==1;
211         
212                 my %disttags = ();      
213                 $disttags{'oldstable'}    = grep(/^woody$/, @tags);
214                 $disttags{'stable'}       = grep(/^sarge$/, @tags);
215                 $disttags{'testing'}      = grep(/^etch$/, @tags);
216                 $disttags{'unstable'}     = grep(/^sid$/, @tags);
217                 $disttags{'experimental'} = grep(/^experimental$/, @tags);
218                 
219                 my $relinfo = "";
220                 if (defined($section{$bug->{'package'}}) && $section{$bug->{'package'}} eq 'pseudo') {
221                         # versioning information makes no sense for pseudo packages,
222                         # just use the tags
223                         for my $dist qw(oldstable stable testing unstable experimental) {
224                                 $relinfo .= uc(substr($dist, 0, 1)) if $disttags{$dist};
225                         }
226                 } else {
227                         # default according to dondelelcaro 2006-11-11
228                         if (!$disttags{'oldstable'} && !$disttags{'stable'} && !$disttags{'testing'} && !$disttags{'unstable'} && !$disttags{'experimental'}) {
229                                 $disttags{'testing'} = 1;
230                                 $disttags{'unstable'} = 1;
231                                 $disttags{'experimental'} = 1;
232                         }
233
234                         # only bother to check the versioning status for the distributions indicated by the tags 
235                         for my $dist qw(oldstable stable testing unstable experimental) {
236                                 local $SIG{__WARN__} = sub {};
237
238                                 next if (!$disttags{$dist});
239
240                                 my $presence = Debbugs::Status::bug_presence(
241                                         bug => $f, 
242                                         status => $bug, 
243                                         dist => $dist, 
244                                         arch => [ qw(alpha amd64 arm hppa i386 ia64 mips mipsel powerpc s390 sparc) ]
245                                 );
246
247                                 # ignore bugs that are absent/fixed in this distribution, include everything
248                                 # else (that is, "found" which says that the bug is present, and undef, which
249                                 # indicates that no versioning information is present and it's not closed
250                                 # unversioned)
251                                 if (!defined($presence) || ($presence ne 'absent' && $presence ne 'fixed')) {
252                                         $relinfo .= uc(substr($dist, 0, 1));
253                                 }
254                         }
255                         
256                         next if $relinfo eq '' and not $premature{$f};
257                         $premature{$f}++ if $relinfo eq '';
258                 }
259
260                 $taginfo = "[";
261                 $taginfo .= ($bug->{'keywords'} =~ /\bpending\b/        ? "P" : " ");
262                 $taginfo .= ($bug->{'keywords'} =~ /\bpatch\b/          ? "+" : " ");
263                 $taginfo .= ($bug->{'keywords'} =~ /\bhelp\b/           ? "H" : " ");
264                 $taginfo .= ($bug->{'keywords'} =~ /\bmoreinfo\b/       ? "M" : " ");
265                 $taginfo .= ($bug->{'keywords'} =~ /\bunreproducible\b/ ? "R" : " ");
266                 $taginfo .= ($bug->{'keywords'} =~ /\bsecurity\b/       ? "S" : " ");
267                 $taginfo .= ($bug->{'keywords'} =~ /\bupstream\b/       ? "U" : " ");
268                 $taginfo .= ($bug->{'keywords'} =~ /\betch-ignore\b/    ? "I" : " ");
269                 $taginfo .= "]";
270
271                 if (length($bug->{'mergedwith'})) {
272                         my @merged = split(' ', $bug->{'mergedwith'});
273                         next if ($merged[0] < $f);
274                 }
275
276                 for my $package (split /[,\s]+/, $bug->{'package'}) {
277                         $_= $package; y/A-Z/a-z/; $_= $` if m/[^-+._a-z0-9]/;
278                         if (not defined $section{$_}) {
279                                 if (defined $debbugssection{$_}) {
280                                         $relinfo .= "X";
281                                 } else {
282                                         next;   # Skip unavailable packages
283                                 }
284                         }
285
286                         push @{$packagelist{$_}}, $f;
287                 }
288
289                 if ($relinfo eq "") { # or $relinfo eq "U" # confuses e.g. #210306
290                         $relinfo = "";
291                 } else {
292                         $relinfo = " [$relinfo]";
293                 }
294
295                 $bugs{$f} = "$f $taginfo$relinfo " . $bug->{'subject'};
296         }
297 }
298
299
300 sub readstatus() {
301         my $bug;                # Number of current bug
302         my $subject;    # Subject for current bug
303         my $pkg;                # Name of current package
304         my $file;               # Name of statusfile
305         my $sect;               # Section of current package
306         my $mnt;                # Maintainer of current package
307
308         $file=shift;
309         open(P, $file) or die "open $file: $!";
310         while (<P>) {
311                 chomp;
312                 if (m/^[0-9]+ \[/) {
313                         ($bug,$subject)=split(/ /, $_, 2);
314                         $bugs{$bug}=$subject;
315                         push @{$packagelist{$pkg}}, $bug;
316                 } else {
317                         ($pkg,$sect, $mnt)=split(/ /, $_, 3);
318                         next if (!defined($pkg));
319                         $section{$pkg}=$sect;
320                         $maintainer{$pkg}=$mnt;
321                 }
322         }
323         close P;
324 }
325
326
327 sub readNMUstatus() {
328         my $bug;       # Number of current bug
329         my $source;    # Source upload which closes this bug.
330         my $version;   # Version where this bug was closed.
331         my $flag;      # Whether this paragraph has been processed.
332         my ($field, $value);
333
334         for (split /\n/, LWP::UserAgent->new->request(HTTP::Request->new(GET => shift))->content) {
335                 chomp;
336                 if (m/^$/) {
337                         $NMU{$bug} = 1;
338                         $NMU{$bug, "source"} = $source;
339                         $NMU{$bug, "version"} = $version;
340 #                       $comments{$bug} .= "[FIXED] Fixed package $source is in Incoming\n";
341                         $flag = 0;
342                 } else {
343                         ($field, $value) = split(/: /, $_, 2);
344                         $bug = $value if($field =~ /bug/i);
345                         $source = $value if($field =~ /source/i);
346                         $version = $value if($field =~ /version/i);
347                         $flag = 1;
348                 }
349         }
350         if ($flag) {
351                 $NMU{$bug} = 1;
352                 $NMU{$bug, "source"} = $source;
353                 $NMU{$bug, "version"} = $version;
354 #               $comments{$bug} .= "[FIXED] Fixed package $source in in Incoming\n";
355         }
356         close P;
357 }
358
359
360 sub urlsanit {
361         my $url = shift;
362         $url =~ s/%/%25/g;
363         $url =~ s/\+/%2b/g;
364         my %saniarray = ('<','lt', '>','gt', '&','amp', '"','quot');
365         $url =~ s/([<>&"])/\&$saniarray{$1};/g;
366         return $url;
367 }
368
369 sub htmlsanit {
370     my %saniarray = ('<','lt', '>','gt', '&','amp', '"','quot');
371     my $in = shift || "";
372     $in =~ s/([<>&"])/\&$saniarray{$1};/g;
373     return $in;
374 }
375
376 sub wwwnumber() {
377         my $number = shift;             # Number of bug to html-ize
378 #       my $section);                           # Section for the bug
379
380         "<A HREF=\"http://bugs.debian.org/cgi-bin/bugreport.cgi?archive=no&amp;bug=" .
381                 urlsanit($number) . '">' . htmlsanit($number) . '</A>';
382 #       ($section=$number) =~ s/([0-9]{2}).*/$1/;
383 #       "<A HREF=\"${btsURL}/db/$section/$number.html\">$number</A>";
384 }
385
386 sub wwwname() {
387         my $name = shift;                       # Name of package
388
389         "<A HREF=\"http://bugs.debian.org/cgi-bin/pkgreport.cgi?archive=no&amp;pkg=" .
390                 urlsanit($name) . '">' . htmlsanit($name) . '</A>';
391 #       "<A HREF=\"${btsURL}/db/pa/l$name.html\">$name</A>";
392 }
393
394 sub check_worry {
395         my ($status) = @_;
396
397         if ($status =~ m/^\[[^]]*I/ or
398             $status =~ m/ \[[^]]*X/ or
399             $status !~ m/ \[[^]]*T/) {
400                 return 0;
401         }
402         return 1;
403 }
404
405 1;