]> git.decadent.org.uk Git - dak.git/blob - dak/cruft_report.py
dinstall
[dak.git] / dak / cruft_report.py
1 #!/usr/bin/env python
2
3 """ Check for obsolete binary packages """
4 # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006  James Troup <james@nocrew.org>
5
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20 ################################################################################
21
22 # ``If you're claiming that's a "problem" that needs to be "fixed",
23 #   you might as well write some letters to God about how unfair entropy
24 #   is while you're at it.'' -- 20020802143104.GA5628@azure.humbug.org.au
25
26 ## TODO:  fix NBS looping for version, implement Dubious NBS, fix up output of
27 ##        duplicate source package stuff, improve experimental ?, add overrides,
28 ##        avoid ANAIS for duplicated packages
29
30 ################################################################################
31
32 import commands, os, sys, re
33 import apt_pkg
34
35 from daklib.config import Config
36 from daklib.dbconn import *
37 from daklib import utils
38 from daklib.regexes import re_extract_src_version
39
40 ################################################################################
41
42 no_longer_in_suite = {}; # Really should be static to add_nbs, but I'm lazy
43
44 source_binaries = {}
45 source_versions = {}
46
47 ################################################################################
48
49 def usage(exit_code=0):
50     print """Usage: dak cruft-report
51 Check for obsolete or duplicated packages.
52
53   -h, --help                show this help and exit.
54   -m, --mode=MODE           chose the MODE to run in (full or daily).
55   -s, --suite=SUITE         check suite SUITE.
56   -w, --wanna-build-dump    where to find the copies of http://buildd.debian.org/stats/*.txt"""
57     sys.exit(exit_code)
58
59 ################################################################################
60
61 def add_nbs(nbs_d, source, version, package, suite_id, session):
62     # Ensure the package is still in the suite (someone may have already removed it)
63     if no_longer_in_suite.has_key(package):
64         return
65     else:
66         q = session.execute("""SELECT b.id FROM binaries b, bin_associations ba
67                                 WHERE ba.bin = b.id AND ba.suite = :suite_id
68                                   AND b.package = :package LIMIT 1""", {'suite_id': suite_id,
69                                                                          'package': package})
70         if not q.fetchall():
71             no_longer_in_suite[package] = ""
72             return
73
74     nbs_d.setdefault(source, {})
75     nbs_d[source].setdefault(version, {})
76     nbs_d[source][version][package] = ""
77
78 ################################################################################
79
80 # Check for packages built on architectures they shouldn't be.
81 def do_anais(architecture, binaries_list, source, session):
82     if architecture == "any" or architecture == "all":
83         return ""
84
85     anais_output = ""
86     architectures = {}
87     for arch in architecture.split():
88         architectures[arch.strip()] = ""
89     for binary in binaries_list:
90         q = session.execute("""SELECT a.arch_string, b.version
91                                 FROM binaries b, bin_associations ba, architecture a
92                                WHERE ba.suite = :suiteid AND ba.bin = b.id
93                                  AND b.architecture = a.id AND b.package = :package""",
94                              {'suiteid': suite_id, 'package': binary})
95         ql = q.fetchall()
96         versions = []
97         for i in ql:
98             arch = i[0]
99             version = i[1]
100             if architectures.has_key(arch):
101                 versions.append(version)
102         versions.sort(apt_pkg.VersionCompare)
103         if versions:
104             latest_version = versions.pop()
105         else:
106             latest_version = None
107         # Check for 'invalid' architectures
108         versions_d = {}
109         for i in ql:
110             arch = i[0]
111             version = i[1]
112             if not architectures.has_key(arch):
113                 versions_d.setdefault(version, [])
114                 versions_d[version].append(arch)
115
116         if versions_d != {}:
117             anais_output += "\n (*) %s_%s [%s]: %s\n" % (binary, latest_version, source, architecture)
118             versions = versions_d.keys()
119             versions.sort(apt_pkg.VersionCompare)
120             for version in versions:
121                 arches = versions_d[version]
122                 arches.sort()
123                 anais_output += "    o %s: %s\n" % (version, ", ".join(arches))
124     return anais_output
125
126
127 ################################################################################
128
129 # Check for out-of-date binaries on architectures that do not want to build that
130 # package any more, and have them listed as Not-For-Us
131 def do_nfu(nfu_packages):
132     output = ""
133     
134     a2p = {}
135
136     for architecture in nfu_packages:
137         a2p[architecture] = []
138         for (package,bver,sver) in nfu_packages[architecture]:
139             output += "  * [%s] does not want %s (binary %s, source %s)\n" % (architecture, package, bver, sver)
140             a2p[architecture].append(package)
141
142
143     if output:
144         print "Obsolete by Not-For-Us"
145         print "----------------------"
146         print
147         print output
148
149         print "Suggested commands:"
150         for architecture in a2p:
151             if a2p[architecture]:
152                 print (" dak rm -m \"[auto-cruft] NFU\" -s %s -a %s -b %s" % 
153                     (suite, architecture, " ".join(a2p[architecture])))
154         print
155
156 def parse_nfu(architecture):
157     cnf = Config()
158     # utils/hpodder_1.1.5.0: Not-For-Us [optional:out-of-date]
159     r = re.compile("^\w+/([^_]+)_.*: Not-For-Us")
160
161     ret = set()
162     
163     filename = "%s/%s-all.txt" % (cnf["Cruft-Report::Options::Wanna-Build-Dump"], architecture)
164
165     # Not all architectures may have a wanna-build dump, so we want to ignore missin
166     # files
167     if os.path.exists(filename):
168         f = utils.open_file(filename)
169         for line in f:
170             if line[0] == ' ':
171                 continue
172
173             m = r.match(line)
174             if m:
175                 ret.add(m.group(1))
176
177         f.close()
178     else:
179         utils.warn("No wanna-build dump file for architecture %s" % architecture)
180     return ret
181
182 ################################################################################
183
184 def do_newer_version(lowersuite_name, highersuite_name, code, session):
185     lowersuite = get_suite(lowersuite_name, session)
186     if not lowersuite:
187         return
188
189     highersuite = get_suite(highersuite_name, session)
190     if not highersuite:
191         return
192
193     # Check for packages in $highersuite obsoleted by versions in $lowersuite
194     q = session.execute("""
195 SELECT s.source, s.version AS lower, s2.version AS higher
196   FROM src_associations sa, source s, source s2, src_associations sa2
197   WHERE sa.suite = :highersuite_id AND sa2.suite = :lowersuite_id AND sa.source = s.id
198    AND sa2.source = s2.id AND s.source = s2.source
199    AND s.version < s2.version""", {'lowersuite_id': lowersuite.suite_id,
200                                     'highersuite_id': highersuite.suite_id})
201     ql = q.fetchall()
202     if ql:
203         nv_to_remove = []
204         print "Newer version in %s" % lowersuite.suite_name
205         print "-----------------" + "-" * len(lowersuite.suite_name)
206         print
207         for i in ql:
208             (source, higher_version, lower_version) = i
209             print " o %s (%s, %s)" % (source, higher_version, lower_version)
210             nv_to_remove.append(source)
211         print
212         print "Suggested command:"
213         print " dak rm -m \"[auto-cruft] %s\" -s %s %s" % (code, highersuite.suite_name,
214                                                            " ".join(nv_to_remove))
215         print
216
217 ################################################################################
218
219 def do_nbs(real_nbs):
220     output = "Not Built from Source\n"
221     output += "---------------------\n\n"
222
223     cmd_output = ""
224     nbs_keys = real_nbs.keys()
225     nbs_keys.sort()
226     for source in nbs_keys:
227         output += " * %s_%s builds: %s\n" % (source,
228                                        source_versions.get(source, "??"),
229                                        source_binaries.get(source, "(source does not exist)"))
230         output += "      but no longer builds:\n"
231         versions = real_nbs[source].keys()
232         versions.sort(apt_pkg.VersionCompare)
233         all_packages = []
234         for version in versions:
235             packages = real_nbs[source][version].keys()
236             packages.sort()
237             all_packages.extend(packages)
238             output += "        o %s: %s\n" % (version, ", ".join(packages))
239         if all_packages:
240             all_packages.sort()
241             cmd_output += " dak rm -m \"[auto-cruft] NBS (was built by %s)\" -s %s -b %s\n\n" % (source, suite.suite_name, " ".join(all_packages))
242
243         output += "\n"
244
245     if len(cmd_output):
246         print output
247         print "Suggested commands:\n"
248         print cmd_output
249
250 ################################################################################
251
252 def do_dubious_nbs(dubious_nbs):
253     print "Dubious NBS"
254     print "-----------"
255     print
256
257     dubious_nbs_keys = dubious_nbs.keys()
258     dubious_nbs_keys.sort()
259     for source in dubious_nbs_keys:
260         print " * %s_%s builds: %s" % (source,
261                                        source_versions.get(source, "??"),
262                                        source_binaries.get(source, "(source does not exist)"))
263         print "      won't admit to building:"
264         versions = dubious_nbs[source].keys()
265         versions.sort(apt_pkg.VersionCompare)
266         for version in versions:
267             packages = dubious_nbs[source][version].keys()
268             packages.sort()
269             print "        o %s: %s" % (version, ", ".join(packages))
270
271         print
272
273 ################################################################################
274
275 def do_obsolete_source(duplicate_bins, bin2source):
276     obsolete = {}
277     for key in duplicate_bins.keys():
278         (source_a, source_b) = key.split('_')
279         for source in [ source_a, source_b ]:
280             if not obsolete.has_key(source):
281                 if not source_binaries.has_key(source):
282                     # Source has already been removed
283                     continue
284                 else:
285                     obsolete[source] = [ i.strip() for i in source_binaries[source].split(',') ]
286             for binary in duplicate_bins[key]:
287                 if bin2source.has_key(binary) and bin2source[binary]["source"] == source:
288                     continue
289                 if binary in obsolete[source]:
290                     obsolete[source].remove(binary)
291
292     to_remove = []
293     output = "Obsolete source package\n"
294     output += "-----------------------\n\n"
295     obsolete_keys = obsolete.keys()
296     obsolete_keys.sort()
297     for source in obsolete_keys:
298         if not obsolete[source]:
299             to_remove.append(source)
300             output += " * %s (%s)\n" % (source, source_versions[source])
301             for binary in [ i.strip() for i in source_binaries[source].split(',') ]:
302                 if bin2source.has_key(binary):
303                     output += "    o %s (%s) is built by %s.\n" \
304                           % (binary, bin2source[binary]["version"],
305                              bin2source[binary]["source"])
306                 else:
307                     output += "    o %s is not built.\n" % binary
308             output += "\n"
309
310     if to_remove:
311         print output
312
313         print "Suggested command:"
314         print " dak rm -S -p -m \"[auto-cruft] obsolete source package\" %s" % (" ".join(to_remove))
315         print
316
317 def get_suite_binaries(suite, session):
318     # Initalize a large hash table of all binary packages
319     binaries = {}
320
321     print "Getting a list of binary packages in %s..." % suite.suite_name
322     q = session.execute("""SELECT distinct b.package
323                              FROM binaries b, bin_associations ba
324                             WHERE ba.suite = :suiteid AND ba.bin = b.id""",
325                            {'suiteid': suite.suite_id})
326     for i in q.fetchall():
327         binaries[i[0]] = ""
328
329     return binaries
330
331 ################################################################################
332
333 def main ():
334     global suite, suite_id, source_binaries, source_versions
335
336     cnf = Config()
337
338     Arguments = [('h',"help","Cruft-Report::Options::Help"),
339                  ('m',"mode","Cruft-Report::Options::Mode", "HasArg"),
340                  ('s',"suite","Cruft-Report::Options::Suite","HasArg"),
341                  ('w',"wanna-build-dump","Cruft-Report::Options::Wanna-Build-Dump","HasArg")]
342     for i in [ "help" ]:
343         if not cnf.has_key("Cruft-Report::Options::%s" % (i)):
344             cnf["Cruft-Report::Options::%s" % (i)] = ""
345     cnf["Cruft-Report::Options::Suite"] = cnf["Dinstall::DefaultSuite"]
346
347     if not cnf.has_key("Cruft-Report::Options::Mode"):
348         cnf["Cruft-Report::Options::Mode"] = "daily"
349
350     if not cnf.has_key("Cruft-Report::Options::Wanna-Build-Dump"):
351         cnf["Cruft-Report::Options::Wanna-Build-Dump"] = "/srv/ftp.debian.org/scripts/nfu"
352
353     apt_pkg.ParseCommandLine(cnf.Cnf, Arguments, sys.argv)
354
355     Options = cnf.SubTree("Cruft-Report::Options")
356     if Options["Help"]:
357         usage()
358
359     # Set up checks based on mode
360     if Options["Mode"] == "daily":
361         checks = [ "nbs", "nviu", "nvit", "obsolete source" ]
362     elif Options["Mode"] == "full":
363         checks = [ "nbs", "nviu", "nvit", "obsolete source", "nfu", "dubious nbs", "bnb", "bms", "anais" ]
364     else:
365         utils.warn("%s is not a recognised mode - only 'full' or 'daily' are understood." % (Options["Mode"]))
366         usage(1)
367
368     session = DBConn().session()
369
370     bin_pkgs = {}
371     src_pkgs = {}
372     bin2source = {}
373     bins_in_suite = {}
374     nbs = {}
375     source_versions = {}
376
377     anais_output = ""
378     duplicate_bins = {}
379
380     nfu_packages = {}
381
382     suite = get_suite(Options["Suite"].lower(), session)
383     suite_id = suite.suite_id
384     suite_name = suite.suite_name.lower()
385
386     bin_not_built = {}
387
388     if "bnb" in checks:
389         bins_in_suite = get_suite_binaries(suite_name, session)
390
391     # Checks based on the Sources files
392     components = cnf.ValueList("Suite::%s::Components" % (suite_name))
393     for component in components:
394         filename = "%s/dists/%s/%s/source/Sources.gz" % (cnf["Dir::Root"], suite_name, component)
395         # apt_pkg.ParseTagFile needs a real file handle and can't handle a GzipFile instance...
396         (fd, temp_filename) = utils.temp_filename()
397         (result, output) = commands.getstatusoutput("gunzip -c %s > %s" % (filename, temp_filename))
398         if (result != 0):
399             sys.stderr.write("Gunzip invocation failed!\n%s\n" % (output))
400             sys.exit(result)
401         sources = utils.open_file(temp_filename)
402         Sources = apt_pkg.ParseTagFile(sources)
403         while Sources.Step():
404             source = Sources.Section.Find('Package')
405             source_version = Sources.Section.Find('Version')
406             architecture = Sources.Section.Find('Architecture')
407             binaries = Sources.Section.Find('Binary')
408             binaries_list = [ i.strip() for i in  binaries.split(',') ]
409
410             if "bnb" in checks:
411                 # Check for binaries not built on any architecture.
412                 for binary in binaries_list:
413                     if not bins_in_suite.has_key(binary):
414                         bin_not_built.setdefault(source, {})
415                         bin_not_built[source][binary] = ""
416
417             if "anais" in checks:
418                 anais_output += do_anais(architecture, binaries_list, source, session)
419
420             # Check for duplicated packages and build indices for checking "no source" later
421             source_index = component + '/' + source
422             if src_pkgs.has_key(source):
423                 print " %s is a duplicated source package (%s and %s)" % (source, source_index, src_pkgs[source])
424             src_pkgs[source] = source_index
425             for binary in binaries_list:
426                 if bin_pkgs.has_key(binary):
427                     key_list = [ source, bin_pkgs[binary] ]
428                     key_list.sort()
429                     key = '_'.join(key_list)
430                     duplicate_bins.setdefault(key, [])
431                     duplicate_bins[key].append(binary)
432                 bin_pkgs[binary] = source
433             source_binaries[source] = binaries
434             source_versions[source] = source_version
435
436         sources.close()
437         os.unlink(temp_filename)
438
439     # Checks based on the Packages files
440     check_components = components[:]
441     if suite_name != "experimental":
442         check_components.append('main/debian-installer');
443
444     for component in check_components:
445         architectures = [ a.arch_string for a in get_suite_architectures(suite_name,
446                                                                          skipsrc=True, skipall=True,
447                                                                          session=session) ]
448         for architecture in architectures:
449             if component == 'main/debian-installer' and re.match("kfreebsd", architecture):
450                 continue
451             filename = "%s/dists/%s/%s/binary-%s/Packages.gz" % (cnf["Dir::Root"], suite_name, component, architecture)
452             # apt_pkg.ParseTagFile needs a real file handle
453             (fd, temp_filename) = utils.temp_filename()
454             (result, output) = commands.getstatusoutput("gunzip -c %s > %s" % (filename, temp_filename))
455             if (result != 0):
456                 sys.stderr.write("Gunzip invocation failed!\n%s\n" % (output))
457                 sys.exit(result)
458
459             if "nfu" in checks:
460                 nfu_packages.setdefault(architecture,[])
461                 nfu_entries = parse_nfu(architecture)
462
463             packages = utils.open_file(temp_filename)
464             Packages = apt_pkg.ParseTagFile(packages)
465             while Packages.Step():
466                 package = Packages.Section.Find('Package')
467                 source = Packages.Section.Find('Source', "")
468                 version = Packages.Section.Find('Version')
469                 if source == "":
470                     source = package
471                 if bin2source.has_key(package) and \
472                        apt_pkg.VersionCompare(version, bin2source[package]["version"]) > 0:
473                     bin2source[package]["version"] = version
474                     bin2source[package]["source"] = source
475                 else:
476                     bin2source[package] = {}
477                     bin2source[package]["version"] = version
478                     bin2source[package]["source"] = source
479                 if source.find("(") != -1:
480                     m = re_extract_src_version.match(source)
481                     source = m.group(1)
482                     version = m.group(2)
483                 if not bin_pkgs.has_key(package):
484                     nbs.setdefault(source,{})
485                     nbs[source].setdefault(package, {})
486                     nbs[source][package][version] = ""
487                 else:
488                     previous_source = bin_pkgs[package]
489                     if previous_source != source:
490                         key_list = [ source, previous_source ]
491                         key_list.sort()
492                         key = '_'.join(key_list)
493                         duplicate_bins.setdefault(key, [])
494                         if package not in duplicate_bins[key]:
495                             duplicate_bins[key].append(package)
496                     if "nfu" in checks:
497                         if package in nfu_entries and \
498                                version != source_versions[source]: # only suggest to remove out-of-date packages
499                             nfu_packages[architecture].append((package,version,source_versions[source]))
500                     
501             packages.close()
502             os.unlink(temp_filename)
503
504     if "obsolete source" in checks:
505         do_obsolete_source(duplicate_bins, bin2source)
506
507     # Distinguish dubious (version numbers match) and 'real' NBS (they don't)
508     dubious_nbs = {}
509     real_nbs = {}
510     for source in nbs.keys():
511         for package in nbs[source].keys():
512             versions = nbs[source][package].keys()
513             versions.sort(apt_pkg.VersionCompare)
514             latest_version = versions.pop()
515             source_version = source_versions.get(source,"0")
516             if apt_pkg.VersionCompare(latest_version, source_version) == 0:
517                 add_nbs(dubious_nbs, source, latest_version, package, suite_id, session)
518             else:
519                 add_nbs(real_nbs, source, latest_version, package, suite_id, session)
520
521     if "nviu" in checks:
522         do_newer_version('unstable', 'experimental', 'NVIU', session)
523
524     if "nvit" in checks:
525         do_newer_version('testing', 'testing-proposed-updates', 'NVIT', session)
526
527     if "nbs" in checks:
528         do_nbs(real_nbs)
529
530     ###
531
532     if Options["Mode"] == "full":
533         print "="*75
534         print
535
536     if "nfu" in checks:
537         do_nfu(nfu_packages)
538
539     if "bnb" in checks:
540         print "Unbuilt binary packages"
541         print "-----------------------"
542         print
543         keys = bin_not_built.keys()
544         keys.sort()
545         for source in keys:
546             binaries = bin_not_built[source].keys()
547             binaries.sort()
548             print " o %s: %s" % (source, ", ".join(binaries))
549         print
550
551     if "bms" in checks:
552         print "Built from multiple source packages"
553         print "-----------------------------------"
554         print
555         keys = duplicate_bins.keys()
556         keys.sort()
557         for key in keys:
558             (source_a, source_b) = key.split("_")
559             print " o %s & %s => %s" % (source_a, source_b, ", ".join(duplicate_bins[key]))
560         print
561
562     if "anais" in checks:
563         print "Architecture Not Allowed In Source"
564         print "----------------------------------"
565         print anais_output
566         print
567
568     if "dubious nbs" in checks:
569         do_dubious_nbs(dubious_nbs)
570
571
572 ################################################################################
573
574 if __name__ == '__main__':
575     main()