dak/examine_package.py

   1 #!/usr/bin/env python
   2
   3 # Script to automate some parts of checking NEW packages
   4 # Copyright (C) 2000, 2001, 2002, 2003, 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 # <Omnic> elmo wrote docs?!!?!?!?!?!?!
  23 # <aj> as if he wasn't scary enough before!!
  24 # * aj imagines a little red furry toy sitting hunched over a computer
  25 #   tapping furiously and giggling to himself
  26 # <aj> eventually he stops, and his heads slowly spins around and you
  27 #      see this really evil grin and then he sees you, and picks up a
  28 #      knife from beside the keyboard and throws it at you, and as you
  29 #      breathe your last breath, he starts giggling again
  30 # <aj> but i should be telling this to my psychiatrist, not you guys,
  31 #      right? :)
  32
  33 ################################################################################
  34
  35 import errno, os, pg, re, sys, md5
  36 import apt_pkg, apt_inst
  37 import daklib.database, daklib.utils, daklib.queue
  38
  39 ################################################################################
  40
  41 re_package = re.compile(r"^(.+?)_.*")
  42 re_doc_directory = re.compile(r".*/doc/([^/]*).*")
  43
  44 re_contrib = re.compile('^contrib/')
  45 re_nonfree = re.compile('^non\-free/')
  46
  47 re_arch = re.compile("Architecture: .*")
  48 re_builddep = re.compile("Build-Depends: .*")
  49 re_builddepind = re.compile("Build-Depends-Indep: .*")
  50
  51 re_localhost = re.compile("localhost\.localdomain")
  52 re_version = re.compile('^(.*)\((.*)\)')
  53
  54 re_newlinespace = re.compile('\n')
  55 re_spacestrip = re.compile('(\s)')
  56
  57 html_escaping = {'"':'&quot;', '&':'&amp;', '<':'&lt;', '>':'&gt;'}
  58 re_html_escaping = re.compile('|'.join(map(re.escape, html_escaping.keys())))
  59
  60 ################################################################################
  61
  62 Cnf = None
  63 projectB = None
  64
  65 Cnf = daklib.utils.get_conf()
  66 projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"]))
  67 daklib.database.init(Cnf, projectB)
  68
  69 printed_copyrights = {}
  70
  71 # default is to not output html.
  72 use_html = 0
  73
  74 ################################################################################
  75
  76 def usage (exit_code=0):
  77     print """Usage: dak examine-package [PACKAGE]...
  78 Check NEW package(s).
  79
  80   -h, --help                 show this help and exit
  81   -H, --html-output          output html page with inspection result
  82   -f, --file-name            filename for the html page
  83
  84 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
  85
  86     sys.exit(exit_code)
  87
  88 ################################################################################
  89 # probably xml.sax.saxutils would work as well
  90
  91 def html_escape(s):
  92   return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
  93
  94 def escape_if_needed(s):
  95   if use_html:
  96     return re_html_escaping.sub(html_escaping.get, s)
  97   else:
  98     return s
  99
 100 def headline(s, level=2, bodyelement=None):
 101   if use_html:
 102     if bodyelement:
 103       print """<thead>
 104           <tr><th colspan="2" class="title" onclick="toggle('%(bodyelement)s', 'table-row-group', 'table-row-group')">%(title)s</th></tr>
 105         </thead>"""%{"bodyelement":bodyelement,"title":html_escape(s)}
 106     else:
 107       print "<h%d>%s</h%d>" % (level, html_escape(s), level)
 108   else:
 109     print "---- %s ----" % (s)
 110
 111 # Colour definitions, 'end' isn't really for use
 112
 113 ansi_colours = {
 114   'main': "\033[36m",
 115   'contrib': "\033[33m",
 116   'nonfree': "\033[31m",
 117   'arch': "\033[32m",
 118   'end': "\033[0m",
 119   'bold': "\033[1m",
 120   'maintainer': "\033[32m"}
 121
 122 html_colours = {
 123   'main': ('<span style="color: aqua">',"</span>"),
 124   'contrib': ('<span style="color: yellow">',"</span>"),
 125   'nonfree': ('<span style="color: red">',"</span>"),
 126   'arch': ('<span style="color: green">',"</span>"),
 127   'bold': ('<span style="font-weight: bold">',"</span>"),
 128   'maintainer': ('<span style="color: green">',"</span>")}
 129
 130 def colour_output(s, colour):
 131   if use_html:
 132     return ("%s%s%s" % (html_colours[colour][0], html_escape(s), html_colours[colour][1]))
 133   else:
 134     return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
 135
 136 def escaped_text(s):
 137   if use_html:
 138     return "<pre>%s</pre>" % (s)
 139   else:
 140     return s
 141
 142 def formatted_text(s):
 143   if use_html:
 144     return "<pre>%s</pre>" % (html_escape(s))
 145   else:
 146     return s
 147
 148 def output_row(s):
 149     if use_html:
 150         return """<tr><td>"""+s+"""</td></tr>"""
 151     else:
 152         return s
 153
 154 def foldable_output(title, elementnameprefix, content):
 155     d = {'elementnameprefix':elementnameprefix}
 156     if use_html:
 157         print """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
 158                    <table class="infobox rfc822">"""%d
 159     headline(title, bodyelement="%(elementnameprefix)s-body"%d)
 160     if use_html:
 161         print """    <tbody id="%(elementnameprefix)s-body" class="infobody">"""%d
 162     print output_row(content)
 163     if use_html:
 164         print """</tbody></table></div>"""
 165
 166 ################################################################################
 167
 168 def get_depends_parts(depend) :
 169     v_match = re_version.match(depend)
 170     if v_match:
 171         d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
 172     else :
 173         d_parts = { 'name' : depend , 'version' : '' }
 174     return d_parts
 175
 176 def get_or_list(depend) :
 177     or_list = depend.split("|")
 178     return or_list
 179
 180 def get_comma_list(depend) :
 181     dep_list = depend.split(",")
 182     return dep_list
 183
 184 def split_depends (d_str) :
 185     # creates a list of lists of dictionaries of depends (package,version relation)
 186
 187     d_str = re_spacestrip.sub('',d_str)
 188     depends_tree = []
 189     # first split depends string up amongs comma delimiter
 190     dep_list = get_comma_list(d_str)
 191     d = 0
 192     while d < len(dep_list):
 193         # put depends into their own list
 194         depends_tree.append([dep_list[d]])
 195         d += 1
 196     d = 0
 197     while d < len(depends_tree):
 198         k = 0
 199         # split up Or'd depends into a multi-item list
 200         depends_tree[d] = get_or_list(depends_tree[d][0])
 201         while k < len(depends_tree[d]):
 202             # split depends into {package, version relation}
 203             depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
 204             k += 1
 205         d += 1
 206     return depends_tree
 207
 208 def read_control (filename):
 209     recommends = []
 210     depends = []
 211     section = ''
 212     maintainer = ''
 213     arch = ''
 214
 215     deb_file = daklib.utils.open_file(filename)
 216     try:
 217         extracts = apt_inst.debExtractControl(deb_file)
 218         control = apt_pkg.ParseSection(extracts)
 219     except:
 220         print formatted_text("can't parse control info")
 221         # TV-COMMENT: this will raise exceptions in two lines
 222         control = ''
 223
 224     deb_file.close()
 225
 226     control_keys = control.keys()
 227
 228     if control.has_key("Depends"):
 229         depends_str = control.Find("Depends")
 230         # create list of dependancy lists
 231         depends = split_depends(depends_str)
 232
 233     if control.has_key("Recommends"):
 234         recommends_str = control.Find("Recommends")
 235         recommends = split_depends(recommends_str)
 236
 237     if control.has_key("Section"):
 238         section_str = control.Find("Section")
 239
 240         c_match = re_contrib.search(section_str)
 241         nf_match = re_nonfree.search(section_str)
 242         if c_match :
 243             # contrib colour
 244             section = colour_output(section_str, 'contrib')
 245         elif nf_match :
 246             # non-free colour
 247             section = colour_output(section_str, 'nonfree')
 248         else :
 249             # main
 250             section = colour_output(section_str, 'main')
 251     if control.has_key("Architecture"):
 252         arch_str = control.Find("Architecture")
 253         arch = colour_output(arch_str, 'arch')
 254
 255     if control.has_key("Maintainer"):
 256         maintainer = control.Find("Maintainer")
 257         localhost = re_localhost.search(maintainer)
 258         if localhost:
 259             #highlight bad email
 260             maintainer = colour_output(maintainer, 'maintainer')
 261         else:
 262             maintainer = escape_if_needed(maintainer)
 263
 264     return (control, control_keys, section, depends, recommends, arch, maintainer)
 265
 266 def read_dsc (dsc_filename):
 267     dsc = {}
 268
 269     dsc_file = daklib.utils.open_file(dsc_filename)
 270     try:
 271         dsc = daklib.utils.parse_changes(dsc_filename)
 272     except:
 273         return formatted_text("can't parse control info")
 274     dsc_file.close()
 275
 276     filecontents = escape_if_needed(strip_pgp_signature(dsc_filename))
 277
 278     if dsc.has_key("build-depends"):
 279         builddep = split_depends(dsc["build-depends"])
 280         builddepstr = create_depends_string(builddep)
 281         filecontents = re_builddep.sub("Build-Depends: "+builddepstr, filecontents)
 282
 283     if dsc.has_key("build-depends-indep"):
 284         builddepindstr = create_depends_string(split_depends(dsc["build-depends-indep"]))
 285         filecontents = re_builddepind.sub("Build-Depends-Indep: "+builddepindstr, filecontents)
 286
 287     if dsc.has_key("architecture") :
 288         if (dsc["architecture"] != "any"):
 289             newarch = colour_output(dsc["architecture"], 'arch')
 290             filecontents = re_arch.sub("Architecture: " + newarch, filecontents)
 291
 292     return filecontents
 293
 294 def create_depends_string (depends_tree):
 295     # just look up unstable for now. possibly pull from .changes later
 296     suite = "unstable"
 297     result = ""
 298     comma_count = 1
 299     for l in depends_tree:
 300         if (comma_count >= 2):
 301             result += ", "
 302         or_count = 1
 303         for d in l:
 304             if (or_count >= 2 ):
 305                 result += " | "
 306             # doesn't do version lookup yet.
 307
 308             q = projectB.query("SELECT DISTINCT(b.package), b.version, c.name, su.suite_name FROM  binaries b, files fi, location l, component c, bin_associations ba, suite su WHERE b.package='%s' AND b.file = fi.id AND fi.location = l.id AND l.component = c.id AND ba.bin=b.id AND ba.suite = su.id AND su.suite_name='%s' ORDER BY b.version desc" % (d['name'], suite))
 309             ql = q.getresult()
 310             if ql:
 311                 i = ql[0]
 312
 313                 adepends = d['name']
 314                 if d['version'] != '' :
 315                     adepends += " (%s)" % (d['version'])
 316
 317                 if i[2] == "contrib":
 318                     result += colour_output(adepends, "contrib")
 319                 elif i[2] == "non-free":
 320                     result += colour_output(adepends, "nonfree")
 321                 else :
 322                     result += colour_output(adepends, "main")
 323             else:
 324                 adepends = d['name']
 325                 if d['version'] != '' :
 326                     adepends += " (%s)" % (d['version'])
 327                 result += colour_output(adepends, "bold")
 328             or_count += 1
 329         comma_count += 1
 330     return result
 331
 332 def output_deb_info(filename):
 333     (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
 334
 335     if control == '':
 336         return formatted_text("no control info")
 337     to_print = ""
 338     for key in control_keys :
 339         output = " " + key + ": "
 340         if key == 'Depends':
 341             output += create_depends_string(depends)
 342         elif key == 'Recommends':
 343             output += create_depends_string(recommends)
 344         elif key == 'Section':
 345             output += section
 346         elif key == 'Architecture':
 347             output += arch
 348         elif key == 'Maintainer':
 349             output += maintainer
 350         elif key == 'Description':
 351             desc = control.Find(key)
 352             desc = re_newlinespace.sub('\n ', desc)
 353             output += escape_if_needed(desc)
 354         else:
 355             output += escape_if_needed(control.Find(key))
 356         to_print += output + '\n'
 357     return escaped_text(to_print)
 358
 359 def do_command (command, filename, escaped=0):
 360     o = os.popen("%s %s" % (command, filename))
 361     if escaped:
 362         return escaped_text(o.read())
 363     else:
 364         return formatted_text(o.read())
 365
 366 def do_lintian (filename):
 367     if use_html:
 368         return do_command("lintian --show-overrides --color html", filename, 1)
 369     else:
 370         return do_command("lintian --show-overrides --color always", filename, 1)
 371
 372 def get_copyright (deb_filename):
 373     package = re_package.sub(r'\1', deb_filename)
 374     o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
 375     copyright = o.read()[:-1]
 376
 377     if copyright == "":
 378         return formatted_text("WARNING: No copyright found, please check package manually.")
 379
 380     doc_directory = re_doc_directory.sub(r'\1', copyright)
 381     if package != doc_directory:
 382         return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
 383
 384     o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, copyright))
 385     copyright = o.read()
 386     copyrightmd5 = md5.md5(copyright).hexdigest()
 387
 388     res = ""
 389     if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
 390         res += formatted_text( "NOTE: Copyright is the same as %s.\n" % \
 391                                (printed_copyrights[copyrightmd5]))
 392     else:
 393         printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
 394     return res+formatted_text(copyright)
 395
 396 def check_dsc (dsc_filename):
 397     (dsc) = read_dsc(dsc_filename)
 398     foldable_output(dsc_filename, "dsc", escaped_text(dsc))
 399     foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
 400
 401 def check_deb (deb_filename):
 402     filename = os.path.basename(deb_filename)
 403     packagename = filename.split('_')[0]
 404
 405     if filename.endswith(".udeb"):
 406         is_a_udeb = 1
 407     else:
 408         is_a_udeb = 0
 409
 410
 411     foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
 412                     output_deb_info(deb_filename))
 413
 414     if is_a_udeb:
 415         foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
 416                         "")
 417     else:
 418         foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
 419                         do_lintian(deb_filename))
 420
 421     foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
 422                     do_command("dpkg -c", deb_filename))
 423
 424     if is_a_udeb:
 425         foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
 426                         "")
 427     else:
 428         foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
 429                         get_copyright(deb_filename))
 430
 431     foldable_output("file listing of %s" % (filename),  "binary-%s-file-listing"%packagename,
 432                     do_command("ls -l", deb_filename))
 433
 434 # Read a file, strip the signature and return the modified contents as
 435 # a string.
 436 def strip_pgp_signature (filename):
 437     file = daklib.utils.open_file (filename)
 438     contents = ""
 439     inside_signature = 0
 440     skip_next = 0
 441     for line in file.readlines():
 442         if line[:-1] == "":
 443             continue
 444         if inside_signature:
 445             continue
 446         if skip_next:
 447             skip_next = 0
 448             continue
 449         if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
 450             skip_next = 1
 451             continue
 452         if line.startswith("-----BEGIN PGP SIGNATURE"):
 453             inside_signature = 1
 454             continue
 455         if line.startswith("-----END PGP SIGNATURE"):
 456             inside_signature = 0
 457             continue
 458         contents += line
 459     file.close()
 460     return contents
 461
 462 # Display the .changes [without the signature]
 463 # TV-COMMENT: M. Ferrari has more formatting ideas
 464 def display_changes(changes_filename):
 465     foldable_output(changes_filename, "changes", formatted_text(strip_pgp_signature(changes_filename)))
 466
 467 def check_changes (changes_filename):
 468     display_changes(changes_filename)
 469
 470     changes = daklib.utils.parse_changes (changes_filename)
 471     files = daklib.utils.build_file_list(changes)
 472     for file in files.keys():
 473         if file.endswith(".deb") or file.endswith(".udeb"):
 474             check_deb(file)
 475         if file.endswith(".dsc"):
 476             check_dsc(file)
 477         # else: => byhand
 478
 479 def main ():
 480     global Cnf, projectB, db_files, waste, excluded
 481
 482 #    Cnf = daklib.utils.get_conf()
 483
 484     Arguments = [('h',"help","Examine-Package::Options::Help"),
 485                  ('H',"html-output","Examine-Package::Options::Html-Output"),
 486                 ]
 487     for i in [ "Help", "Html-Output", "partial-html" ]:
 488         if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
 489             Cnf["Examine-Package::Options::%s" % (i)] = ""
 490
 491     args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
 492     Options = Cnf.SubTree("Examine-Package::Options")
 493
 494     if Options["Help"]:
 495         usage()
 496
 497     stdout_fd = sys.stdout
 498
 499     for file in args:
 500         try:
 501             if not Options["Html-Output"]:
 502                 # Pipe output for each argument through less
 503                 less_fd = os.popen("less -R -", 'w', 0)
 504                 # -R added to display raw control chars for colour
 505                 sys.stdout = less_fd
 506             try:
 507                 if file.endswith(".changes"):
 508                     check_changes(file)
 509                 elif file.endswith(".deb") or file.endswith(".udeb"):
 510                     check_deb(file)
 511                 elif file.endswith(".dsc"):
 512                     check_dsc(file)
 513                 else:
 514                     daklib.utils.fubar("Unrecognised file type: '%s'." % (file))
 515             finally:
 516                 if not Options["Html-Output"]:
 517                     # Reset stdout here so future less invocations aren't FUBAR
 518                     less_fd.close()
 519                     sys.stdout = stdout_fd
 520         except IOError, e:
 521             if errno.errorcode[e.errno] == 'EPIPE':
 522                 daklib.utils.warn("[examine-package] Caught EPIPE; skipping.")
 523                 pass
 524             else:
 525                 raise
 526         except KeyboardInterrupt:
 527             daklib.utils.warn("[examine-package] Caught C-c; skipping.")
 528             pass
 529
 530 #######################################################################################
 531
 532 if __name__ == '__main__':
 533     main()
 534