dak/check_archive.py

   1 #!/usr/bin/env python
   2
   3 # Various different sanity checks
   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 #   And, lo, a great and menacing voice rose from the depths, and with
  23 #   great wrath and vehemence it's voice boomed across the
  24 #   land... ``hehehehehehe... that *tickles*''
  25 #                                                       -- aj on IRC
  26
  27 ################################################################################
  28
  29 import commands, os, pg, stat, sys, time
  30 import apt_pkg, apt_inst
  31 from daklib import database
  32 from daklib import utils
  33
  34 ################################################################################
  35
  36 Cnf = None
  37 projectB = None
  38 db_files = {}
  39 waste = 0.0
  40 excluded = {}
  41 current_file = None
  42 future_files = {}
  43 current_time = time.time()
  44
  45 ################################################################################
  46
  47 def usage(exit_code=0):
  48     print """Usage: dak check-archive MODE
  49 Run various sanity checks of the archive and/or database.
  50
  51   -h, --help                show this help and exit.
  52
  53 The following MODEs are available:
  54
  55   checksums          - validate the checksums stored in the database
  56   files              - check files in the database against what's in the archive
  57   dsc-syntax         - validate the syntax of .dsc files in the archive
  58   missing-overrides  - check for missing overrides
  59   source-in-one-dir  - ensure the source for each package is in one directory
  60   timestamps         - check for future timestamps in .deb's
  61   tar-gz-in-dsc      - ensure each .dsc lists a .tar.gz file
  62   validate-indices   - ensure files mentioned in Packages & Sources exist
  63   files-not-symlinks - check files in the database aren't symlinks
  64   validate-builddeps - validate build-dependencies of .dsc files in the archive
  65 """
  66     sys.exit(exit_code)
  67
  68 ################################################################################
  69
  70 def process_dir (unused, dirname, filenames):
  71     global waste, db_files, excluded
  72
  73     if dirname.find('/disks-') != -1 or dirname.find('upgrade-') != -1:
  74         return
  75     # hack; can't handle .changes files
  76     if dirname.find('proposed-updates') != -1:
  77         return
  78     for name in filenames:
  79         filename = os.path.abspath(dirname+'/'+name)
  80         filename = filename.replace('potato-proposed-updates', 'proposed-updates')
  81         if os.path.isfile(filename) and not os.path.islink(filename) and not db_files.has_key(filename) and not excluded.has_key(filename):
  82             waste += os.stat(filename)[stat.ST_SIZE]
  83             print "%s" % (filename)
  84
  85 ################################################################################
  86
  87 def check_files():
  88     global db_files
  89
  90     print "Building list of database files..."
  91     q = projectB.query("SELECT l.path, f.filename, f.last_used FROM files f, location l WHERE f.location = l.id ORDER BY l.path, f.filename")
  92     ql = q.getresult()
  93
  94     print "Missing files:"
  95     db_files.clear()
  96     for i in ql:
  97         filename = os.path.abspath(i[0] + i[1])
  98         db_files[filename] = ""
  99         if os.access(filename, os.R_OK) == 0:
 100             if i[2]:
 101                 print "(last used: %s) %s" % (i[2], filename)
 102             else:
 103                 print "%s" % (filename)
 104
 105
 106     filename = Cnf["Dir::Override"]+'override.unreferenced'
 107     if os.path.exists(filename):
 108         f = utils.open_file(filename)
 109         for filename in f.readlines():
 110             filename = filename[:-1]
 111             excluded[filename] = ""
 112
 113     print "Existent files not in db:"
 114
 115     os.path.walk(Cnf["Dir::Root"]+'pool/', process_dir, None)
 116
 117     print
 118     print "%s wasted..." % (utils.size_type(waste))
 119
 120 ################################################################################
 121
 122 def check_dscs():
 123     count = 0
 124     suite = 'unstable'
 125     for component in Cnf.SubTree("Component").List():
 126         if component == "mixed":
 127             continue
 128         component = component.lower()
 129         list_filename = '%s%s_%s_source.list' % (Cnf["Dir::Lists"], suite, component)
 130         list_file = utils.open_file(list_filename)
 131         for line in list_file.readlines():
 132             f = line[:-1]
 133             try:
 134                 utils.parse_changes(f, signing_rules=1)
 135             except InvalidDscError, line:
 136                 utils.warn("syntax error in .dsc file '%s', line %s." % (f, line))
 137                 count += 1
 138
 139     if count:
 140         utils.warn("Found %s invalid .dsc files." % (count))
 141
 142 ################################################################################
 143
 144 def check_override():
 145     for suite in [ "stable", "unstable" ]:
 146         print suite
 147         print "-"*len(suite)
 148         print
 149         suite_id = database.get_suite_id(suite)
 150         q = projectB.query("""
 151 SELECT DISTINCT b.package FROM binaries b, bin_associations ba
 152  WHERE b.id = ba.bin AND ba.suite = %s AND NOT EXISTS
 153        (SELECT 1 FROM override o WHERE o.suite = %s AND o.package = b.package)"""
 154                            % (suite_id, suite_id))
 155         print q
 156         q = projectB.query("""
 157 SELECT DISTINCT s.source FROM source s, src_associations sa
 158   WHERE s.id = sa.source AND sa.suite = %s AND NOT EXISTS
 159        (SELECT 1 FROM override o WHERE o.suite = %s and o.package = s.source)"""
 160                            % (suite_id, suite_id))
 161         print q
 162
 163 ################################################################################
 164
 165 # Ensure that the source files for any given package is all in one
 166 # directory so that 'apt-get source' works...
 167
 168 def check_source_in_one_dir():
 169     # Not the most enterprising method, but hey...
 170     broken_count = 0
 171     q = projectB.query("SELECT id FROM source;")
 172     for i in q.getresult():
 173         source_id = i[0]
 174         q2 = projectB.query("""
 175 SELECT l.path, f.filename FROM files f, dsc_files df, location l WHERE df.source = %s AND f.id = df.file AND l.id = f.location"""
 176                             % (source_id))
 177         first_path = ""
 178         first_filename = ""
 179         broken = 0
 180         for j in q2.getresult():
 181             filename = j[0] + j[1]
 182             path = os.path.dirname(filename)
 183             if first_path == "":
 184                 first_path = path
 185                 first_filename = filename
 186             elif first_path != path:
 187                 symlink = path + '/' + os.path.basename(first_filename)
 188                 if not os.path.exists(symlink):
 189                     broken = 1
 190                     print "WOAH, we got a live one here... %s [%s] {%s}" % (filename, source_id, symlink)
 191         if broken:
 192             broken_count += 1
 193     print "Found %d source packages where the source is not all in one directory." % (broken_count)
 194
 195 ################################################################################
 196
 197 def check_checksums():
 198     print "Getting file information from database..."
 199     q = projectB.query("SELECT l.path, f.filename, f.md5sum, f.sha1sum, f.sha256sum, f.size FROM files f, location l WHERE f.location = l.id")
 200     ql = q.getresult()
 201
 202     print "Checking file checksums & sizes..."
 203     for i in ql:
 204         filename = os.path.abspath(i[0] + i[1])
 205         db_md5sum = i[2]
 206         db_sha1sum = i[3]
 207         db_sha256sum = i[4]
 208         db_size = int(i[5])
 209         try:
 210             f = utils.open_file(filename)
 211         except:
 212             utils.warn("can't open '%s'." % (filename))
 213             continue
 214         md5sum = apt_pkg.md5sum(f)
 215         size = os.stat(filename)[stat.ST_SIZE]
 216         if md5sum != db_md5sum:
 217             utils.warn("**WARNING** md5sum mismatch for '%s' ('%s' [current] vs. '%s' [db])." % (filename, md5sum, db_md5sum))
 218         if size != db_size:
 219             utils.warn("**WARNING** size mismatch for '%s' ('%s' [current] vs. '%s' [db])." % (filename, size, db_size))
 220         # Until the main database is filled, we need to not spit 500,000 warnings
 221         # every time we scan the archive.  Yet another hack (TM) which can go away
 222         # once this is all working
 223         if db_sha1sum is not None and db_sha1sum != '':
 224             sha1sum = apt_pkg.sha1sum(f)
 225             if sha1sum != db_sha1sum:
 226                 utils.warn("**WARNING** sha1sum mismatch for '%s' ('%s' [current] vs. '%s' [db])." % (filename, sha1sum, db_sha1sum))
 227
 228         if db_sha256sum is not None and db_sha256sum != '':
 229             sha256sum = apt_pkg.sha256sum(f)
 230             if sha256sum != db_sha256sum:
 231                 utils.warn("**WARNING** sha256sum mismatch for '%s' ('%s' [current] vs. '%s' [db])." % (filename, sha256sum, db_sha256sum))
 232
 233     print "Done."
 234
 235 ################################################################################
 236 #
 237 # Check all files for timestamps in the future; common from hardware
 238 # (e.g. alpha) which have far-future dates as their default dates.
 239
 240 def Ent(Kind,Name,Link,Mode,UID,GID,Size,MTime,Major,Minor):
 241     global future_files
 242
 243     if MTime > current_time:
 244         future_files[current_file] = MTime
 245         print "%s: %s '%s','%s',%u,%u,%u,%u,%u,%u,%u" % (current_file, Kind,Name,Link,Mode,UID,GID,Size, MTime, Major, Minor)
 246
 247 def check_timestamps():
 248     global current_file
 249
 250     q = projectB.query("SELECT l.path, f.filename FROM files f, location l WHERE f.location = l.id AND f.filename ~ '.deb$'")
 251     ql = q.getresult()
 252     db_files.clear()
 253     count = 0
 254     for i in ql:
 255         filename = os.path.abspath(i[0] + i[1])
 256         if os.access(filename, os.R_OK):
 257             f = utils.open_file(filename)
 258             current_file = filename
 259             sys.stderr.write("Processing %s.\n" % (filename))
 260             apt_inst.debExtract(f, Ent, "control.tar.gz")
 261             f.seek(0)
 262             apt_inst.debExtract(f, Ent, "data.tar.gz")
 263             count += 1
 264     print "Checked %d files (out of %d)." % (count, len(db_files.keys()))
 265
 266 ################################################################################
 267
 268 def check_missing_tar_gz_in_dsc():
 269     count = 0
 270
 271     print "Building list of database files..."
 272     q = projectB.query("SELECT l.path, f.filename FROM files f, location l WHERE f.location = l.id AND f.filename ~ '.dsc$'")
 273     ql = q.getresult()
 274     if ql:
 275         print "Checking %d files..." % len(ql)
 276     else:
 277         print "No files to check."
 278     for i in ql:
 279         filename = os.path.abspath(i[0] + i[1])
 280         try:
 281             # NB: don't enforce .dsc syntax
 282             dsc = utils.parse_changes(filename)
 283         except:
 284             utils.fubar("error parsing .dsc file '%s'." % (filename))
 285         dsc_files = utils.build_file_list(dsc, is_a_dsc=1)
 286         has_tar = 0
 287         for f in dsc_files.keys():
 288             m = utils.re_issource.match(f)
 289             if not m:
 290                 utils.fubar("%s not recognised as source." % (f))
 291             ftype = m.group(3)
 292             if ftype == "orig.tar.gz" or ftype == "tar.gz":
 293                 has_tar = 1
 294         if not has_tar:
 295             utils.warn("%s has no .tar.gz in the .dsc file." % (f))
 296             count += 1
 297
 298     if count:
 299         utils.warn("Found %s invalid .dsc files." % (count))
 300
 301
 302 ################################################################################
 303
 304 def validate_sources(suite, component):
 305     filename = "%s/dists/%s/%s/source/Sources.gz" % (Cnf["Dir::Root"], suite, component)
 306     print "Processing %s..." % (filename)
 307     # apt_pkg.ParseTagFile needs a real file handle and can't handle a GzipFile instance...
 308     temp_filename = utils.temp_filename()
 309     (result, output) = commands.getstatusoutput("gunzip -c %s > %s" % (filename, temp_filename))
 310     if (result != 0):
 311         sys.stderr.write("Gunzip invocation failed!\n%s\n" % (output))
 312         sys.exit(result)
 313     sources = utils.open_file(temp_filename)
 314     Sources = apt_pkg.ParseTagFile(sources)
 315     while Sources.Step():
 316         source = Sources.Section.Find('Package')
 317         directory = Sources.Section.Find('Directory')
 318         files = Sources.Section.Find('Files')
 319         for i in files.split('\n'):
 320             (md5, size, name) = i.split()
 321             filename = "%s/%s/%s" % (Cnf["Dir::Root"], directory, name)
 322             if not os.path.exists(filename):
 323                 if directory.find("potato") == -1:
 324                     print "W: %s missing." % (filename)
 325                 else:
 326                     pool_location = utils.poolify (source, component)
 327                     pool_filename = "%s/%s/%s" % (Cnf["Dir::Pool"], pool_location, name)
 328                     if not os.path.exists(pool_filename):
 329                         print "E: %s missing (%s)." % (filename, pool_filename)
 330                     else:
 331                         # Create symlink
 332                         pool_filename = os.path.normpath(pool_filename)
 333                         filename = os.path.normpath(filename)
 334                         src = utils.clean_symlink(pool_filename, filename, Cnf["Dir::Root"])
 335                         print "Symlinking: %s -> %s" % (filename, src)
 336                         #os.symlink(src, filename)
 337     sources.close()
 338     os.unlink(temp_filename)
 339
 340 ########################################
 341
 342 def validate_packages(suite, component, architecture):
 343     filename = "%s/dists/%s/%s/binary-%s/Packages.gz" \
 344                % (Cnf["Dir::Root"], suite, component, architecture)
 345     print "Processing %s..." % (filename)
 346     # apt_pkg.ParseTagFile needs a real file handle and can't handle a GzipFile instance...
 347     temp_filename = utils.temp_filename()
 348     (result, output) = commands.getstatusoutput("gunzip -c %s > %s" % (filename, temp_filename))
 349     if (result != 0):
 350         sys.stderr.write("Gunzip invocation failed!\n%s\n" % (output))
 351         sys.exit(result)
 352     packages = utils.open_file(temp_filename)
 353     Packages = apt_pkg.ParseTagFile(packages)
 354     while Packages.Step():
 355         filename = "%s/%s" % (Cnf["Dir::Root"], Packages.Section.Find('Filename'))
 356         if not os.path.exists(filename):
 357             print "W: %s missing." % (filename)
 358     packages.close()
 359     os.unlink(temp_filename)
 360
 361 ########################################
 362
 363 def check_indices_files_exist():
 364     for suite in [ "stable", "testing", "unstable" ]:
 365         for component in Cnf.ValueList("Suite::%s::Components" % (suite)):
 366             architectures = Cnf.ValueList("Suite::%s::Architectures" % (suite))
 367             for arch in [ i.lower() for i in architectures ]:
 368                 if arch == "source":
 369                     validate_sources(suite, component)
 370                 elif arch == "all":
 371                     continue
 372                 else:
 373                     validate_packages(suite, component, arch)
 374
 375 ################################################################################
 376
 377 def check_files_not_symlinks():
 378     print "Building list of database files... ",
 379     before = time.time()
 380     q = projectB.query("SELECT l.path, f.filename, f.id FROM files f, location l WHERE f.location = l.id")
 381     print "done. (%d seconds)" % (int(time.time()-before))
 382     q_files = q.getresult()
 383
 384     for i in q_files:
 385         filename = os.path.normpath(i[0] + i[1])
 386         if os.access(filename, os.R_OK) == 0:
 387             utils.warn("%s: doesn't exist." % (filename))
 388         else:
 389             if os.path.islink(filename):
 390                 utils.warn("%s: is a symlink." % (filename))
 391
 392 ################################################################################
 393
 394 def chk_bd_process_dir (unused, dirname, filenames):
 395     for name in filenames:
 396         if not name.endswith(".dsc"):
 397             continue
 398         filename = os.path.abspath(dirname+'/'+name)
 399         dsc = utils.parse_changes(filename)
 400         for field_name in [ "build-depends", "build-depends-indep" ]:
 401             field = dsc.get(field_name)
 402             if field:
 403                 try:
 404                     apt_pkg.ParseSrcDepends(field)
 405                 except:
 406                     print "E: [%s] %s: %s" % (filename, field_name, field)
 407                     pass
 408
 409 ################################################################################
 410
 411 def check_build_depends():
 412     os.path.walk(Cnf["Dir::Root"], chk_bd_process_dir, None)
 413
 414 ################################################################################
 415
 416 def main ():
 417     global Cnf, projectB, db_files, waste, excluded
 418
 419     Cnf = utils.get_conf()
 420     Arguments = [('h',"help","Check-Archive::Options::Help")]
 421     for i in [ "help" ]:
 422         if not Cnf.has_key("Check-Archive::Options::%s" % (i)):
 423             Cnf["Check-Archive::Options::%s" % (i)] = ""
 424
 425     args = apt_pkg.ParseCommandLine(Cnf, Arguments, sys.argv)
 426
 427     Options = Cnf.SubTree("Check-Archive::Options")
 428     if Options["Help"]:
 429         usage()
 430
 431     if len(args) < 1:
 432         utils.warn("dak check-archive requires at least one argument")
 433         usage(1)
 434     elif len(args) > 1:
 435         utils.warn("dak check-archive accepts only one argument")
 436         usage(1)
 437     mode = args[0].lower()
 438
 439     projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"]))
 440     database.init(Cnf, projectB)
 441
 442     if mode == "checksums":
 443         check_checksums()
 444     elif mode == "files":
 445         check_files()
 446     elif mode == "dsc-syntax":
 447         check_dscs()
 448     elif mode == "missing-overrides":
 449         check_override()
 450     elif mode == "source-in-one-dir":
 451         check_source_in_one_dir()
 452     elif mode == "timestamps":
 453         check_timestamps()
 454     elif mode == "tar-gz-in-dsc":
 455         check_missing_tar_gz_in_dsc()
 456     elif mode == "validate-indices":
 457         check_indices_files_exist()
 458     elif mode == "files-not-symlinks":
 459         check_files_not_symlinks()
 460     elif mode == "validate-builddeps":
 461         check_build_depends()
 462     else:
 463         utils.warn("unknown mode '%s'" % (mode))
 464         usage(1)
 465
 466 ################################################################################
 467
 468 if __name__ == '__main__':
 469     main()