dak/examine_package.py

   1 #!/usr/bin/env python
   2
   3 """
   4 Script to automate some parts of checking NEW packages
   5
   6 @contact: Debian FTP Master <ftpmaster@debian.org>
   7 @copyright: 2000, 2001, 2002, 2003, 2006  James Troup <james@nocrew.org>
   8 @copyright: 2009  Joerg Jaspert <joerg@debian.org>
   9 @license: GNU General Public License version 2 or later
  10 """
  11
  12 # This program is free software; you can redistribute it and/or modify
  13 # it under the terms of the GNU General Public License as published by
  14 # the Free Software Foundation; either version 2 of the License, or
  15 # (at your option) any later version.
  16
  17 # This program is distributed in the hope that it will be useful,
  18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 # GNU General Public License for more details.
  21
  22 # You should have received a copy of the GNU General Public License
  23 # along with this program; if not, write to the Free Software
  24 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25
  26 ################################################################################
  27
  28 # <Omnic> elmo wrote docs?!!?!?!?!?!?!
  29 # <aj> as if he wasn't scary enough before!!
  30 # * aj imagines a little red furry toy sitting hunched over a computer
  31 #   tapping furiously and giggling to himself
  32 # <aj> eventually he stops, and his heads slowly spins around and you
  33 #      see this really evil grin and then he sees you, and picks up a
  34 #      knife from beside the keyboard and throws it at you, and as you
  35 #      breathe your last breath, he starts giggling again
  36 # <aj> but i should be telling this to my psychiatrist, not you guys,
  37 #      right? :)
  38
  39 ################################################################################
  40
  41 import errno
  42 import os
  43 import pg
  44 import re
  45 import sys
  46 import md5
  47 import apt_pkg
  48 import apt_inst
  49 import shutil
  50 import commands
  51 from daklib import database
  52 from daklib import utils
  53 from daklib.regexes import html_escaping, re_html_escaping, re_version, re_spacestrip, \
  54                            re_contrib, re_nonfree, re_localhost, re_newlinespace, \
  55                            re_package, re_doc_directory
  56
  57 ################################################################################
  58
  59 Cnf = None
  60 projectB = None
  61
  62 Cnf = utils.get_conf()
  63 projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"]))
  64 database.init(Cnf, projectB)
  65
  66 printed_copyrights = {}
  67 package_relations = {}           #: Store relations of packages for later output
  68
  69 # default is to not output html.
  70 use_html = 0
  71
  72 ################################################################################
  73
  74 def usage (exit_code=0):
  75     print """Usage: dak examine-package [PACKAGE]...
  76 Check NEW package(s).
  77
  78   -h, --help                 show this help and exit
  79   -H, --html-output          output html page with inspection result
  80   -f, --file-name            filename for the html page
  81
  82 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
  83
  84     sys.exit(exit_code)
  85
  86 ################################################################################
  87 # probably xml.sax.saxutils would work as well
  88
  89 def escape_if_needed(s):
  90     if use_html:
  91         return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
  92     else:
  93         return s
  94
  95 def headline(s, level=2, bodyelement=None):
  96     if use_html:
  97         if bodyelement:
  98             print """<thead>
  99                 <tr><th colspan="2" class="title" onclick="toggle('%(bodyelement)s', 'table-row-group', 'table-row-group')">%(title)s <span class="toggle-msg">(click to toggle)</span></th></tr>
 100               </thead>"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
 101         else:
 102             print "<h%d>%s</h%d>" % (level, utils.html_escape(s), level)
 103     else:
 104         print "---- %s ----" % (s)
 105
 106 # Colour definitions, 'end' isn't really for use
 107
 108 ansi_colours = {
 109   'main': "\033[36m",
 110   'contrib': "\033[33m",
 111   'nonfree': "\033[31m",
 112   'arch': "\033[32m",
 113   'end': "\033[0m",
 114   'bold': "\033[1m",
 115   'maintainer': "\033[32m"}
 116
 117 html_colours = {
 118   'main': ('<span style="color: aqua">',"</span>"),
 119   'contrib': ('<span style="color: yellow">',"</span>"),
 120   'nonfree': ('<span style="color: red">',"</span>"),
 121   'arch': ('<span style="color: green">',"</span>"),
 122   'bold': ('<span style="font-weight: bold">',"</span>"),
 123   'maintainer': ('<span style="color: green">',"</span>")}
 124
 125 def colour_output(s, colour):
 126     if use_html:
 127         return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
 128     else:
 129         return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
 130
 131 def escaped_text(s, strip=False):
 132     if use_html:
 133         if strip:
 134             s = s.strip()
 135         return "<pre>%s</pre>" % (s)
 136     else:
 137         return s
 138
 139 def formatted_text(s, strip=False):
 140     if use_html:
 141         if strip:
 142             s = s.strip()
 143         return "<pre>%s</pre>" % (utils.html_escape(s))
 144     else:
 145         return s
 146
 147 def output_row(s):
 148     if use_html:
 149         return """<tr><td>"""+s+"""</td></tr>"""
 150     else:
 151         return s
 152
 153 def format_field(k,v):
 154     if use_html:
 155         return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
 156     else:
 157         return "%s: %s"%(k,v)
 158
 159 def foldable_output(title, elementnameprefix, content, norow=False):
 160     d = {'elementnameprefix':elementnameprefix}
 161     if use_html:
 162         print """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
 163                    <table class="infobox rfc822">"""%d
 164     headline(title, bodyelement="%(elementnameprefix)s-body"%d)
 165     if use_html:
 166         print """    <tbody id="%(elementnameprefix)s-body" class="infobody">"""%d
 167     if norow:
 168         print content
 169     else:
 170         print output_row(content)
 171     if use_html:
 172         print """</tbody></table></div>"""
 173
 174 ################################################################################
 175
 176 def get_depends_parts(depend) :
 177     v_match = re_version.match(depend)
 178     if v_match:
 179         d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
 180     else :
 181         d_parts = { 'name' : depend , 'version' : '' }
 182     return d_parts
 183
 184 def get_or_list(depend) :
 185     or_list = depend.split("|")
 186     return or_list
 187
 188 def get_comma_list(depend) :
 189     dep_list = depend.split(",")
 190     return dep_list
 191
 192 def split_depends (d_str) :
 193     # creates a list of lists of dictionaries of depends (package,version relation)
 194
 195     d_str = re_spacestrip.sub('',d_str)
 196     depends_tree = []
 197     # first split depends string up amongs comma delimiter
 198     dep_list = get_comma_list(d_str)
 199     d = 0
 200     while d < len(dep_list):
 201         # put depends into their own list
 202         depends_tree.append([dep_list[d]])
 203         d += 1
 204     d = 0
 205     while d < len(depends_tree):
 206         k = 0
 207         # split up Or'd depends into a multi-item list
 208         depends_tree[d] = get_or_list(depends_tree[d][0])
 209         while k < len(depends_tree[d]):
 210             # split depends into {package, version relation}
 211             depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
 212             k += 1
 213         d += 1
 214     return depends_tree
 215
 216 def read_control (filename):
 217     recommends = []
 218     depends = []
 219     section = ''
 220     maintainer = ''
 221     arch = ''
 222
 223     deb_file = utils.open_file(filename)
 224     try:
 225         extracts = apt_inst.debExtractControl(deb_file)
 226         control = apt_pkg.ParseSection(extracts)
 227     except:
 228         print formatted_text("can't parse control info")
 229         deb_file.close()
 230         raise
 231
 232     deb_file.close()
 233
 234     control_keys = control.keys()
 235
 236     if control.has_key("Depends"):
 237         depends_str = control.Find("Depends")
 238         # create list of dependancy lists
 239         depends = split_depends(depends_str)
 240
 241     if control.has_key("Recommends"):
 242         recommends_str = control.Find("Recommends")
 243         recommends = split_depends(recommends_str)
 244
 245     if control.has_key("Section"):
 246         section_str = control.Find("Section")
 247
 248         c_match = re_contrib.search(section_str)
 249         nf_match = re_nonfree.search(section_str)
 250         if c_match :
 251             # contrib colour
 252             section = colour_output(section_str, 'contrib')
 253         elif nf_match :
 254             # non-free colour
 255             section = colour_output(section_str, 'nonfree')
 256         else :
 257             # main
 258             section = colour_output(section_str, 'main')
 259     if control.has_key("Architecture"):
 260         arch_str = control.Find("Architecture")
 261         arch = colour_output(arch_str, 'arch')
 262
 263     if control.has_key("Maintainer"):
 264         maintainer = control.Find("Maintainer")
 265         localhost = re_localhost.search(maintainer)
 266         if localhost:
 267             #highlight bad email
 268             maintainer = colour_output(maintainer, 'maintainer')
 269         else:
 270             maintainer = escape_if_needed(maintainer)
 271
 272     return (control, control_keys, section, depends, recommends, arch, maintainer)
 273
 274 def read_changes_or_dsc (suite, filename):
 275     dsc = {}
 276
 277     dsc_file = utils.open_file(filename)
 278     try:
 279         dsc = utils.parse_changes(filename)
 280     except:
 281         return formatted_text("can't parse .dsc control info")
 282     dsc_file.close()
 283
 284     filecontents = strip_pgp_signature(filename)
 285     keysinorder = []
 286     for l in filecontents.split('\n'):
 287         m = re.match(r'([-a-zA-Z0-9]*):', l)
 288         if m:
 289             keysinorder.append(m.group(1))
 290
 291     for k in dsc.keys():
 292         if k in ("build-depends","build-depends-indep"):
 293             dsc[k] = create_depends_string(suite, split_depends(dsc[k]))
 294         elif k == "architecture":
 295             if (dsc["architecture"] != "any"):
 296                 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
 297         elif k in ("files","changes","description"):
 298             if use_html:
 299                 dsc[k] = formatted_text(dsc[k], strip=True)
 300             else:
 301                 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
 302         else:
 303             dsc[k] = escape_if_needed(dsc[k])
 304
 305     keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
 306
 307     filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
 308     return filecontents
 309
 310 def create_depends_string (suite, depends_tree):
 311     result = ""
 312     if suite == 'experimental':
 313         suite_where = " in ('experimental','unstable')"
 314     else:
 315         suite_where = " ='%s'" % suite
 316
 317     comma_count = 1
 318     for l in depends_tree:
 319         if (comma_count >= 2):
 320             result += ", "
 321         or_count = 1
 322         for d in l:
 323             if (or_count >= 2 ):
 324                 result += " | "
 325             # doesn't do version lookup yet.
 326
 327             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_where))
 328             ql = q.getresult()
 329             if ql:
 330                 i = ql[0]
 331
 332                 adepends = d['name']
 333                 if d['version'] != '' :
 334                     adepends += " (%s)" % (d['version'])
 335
 336                 if i[2] == "contrib":
 337                     result += colour_output(adepends, "contrib")
 338                 elif i[2] == "non-free":
 339                     result += colour_output(adepends, "nonfree")
 340                 else :
 341                     result += colour_output(adepends, "main")
 342             else:
 343                 adepends = d['name']
 344                 if d['version'] != '' :
 345                     adepends += " (%s)" % (d['version'])
 346                 result += colour_output(adepends, "bold")
 347             or_count += 1
 348         comma_count += 1
 349     return result
 350
 351 def output_package_relations ():
 352     """
 353     Output the package relations, if there is more than one package checked in this run.
 354     """
 355
 356     if len(package_relations) < 2:
 357         # Only list something if we have more than one binary to compare
 358         return
 359
 360     to_print = ""
 361     for package in package_relations:
 362         for relation in package_relations[package]:
 363             to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
 364
 365     package_relations.clear()
 366     foldable_output("Package relations", "relations", to_print)
 367
 368 def output_deb_info(suite, filename, packagename):
 369     (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
 370
 371     if control == '':
 372         return formatted_text("no control info")
 373     to_print = ""
 374     if not package_relations.has_key(packagename):
 375         package_relations[packagename] = {}
 376     for key in control_keys :
 377         if key == 'Depends':
 378             field_value = create_depends_string(suite, depends)
 379             package_relations[packagename][key] = field_value
 380         elif key == 'Recommends':
 381             field_value = create_depends_string(suite, recommends)
 382             package_relations[packagename][key] = field_value
 383         elif key == 'Section':
 384             field_value = section
 385         elif key == 'Architecture':
 386             field_value = arch
 387         elif key == 'Maintainer':
 388             field_value = maintainer
 389         elif key == 'Description':
 390             if use_html:
 391                 field_value = formatted_text(control.Find(key), strip=True)
 392             else:
 393                 desc = control.Find(key)
 394                 desc = re_newlinespace.sub('\n ', desc)
 395                 field_value = escape_if_needed(desc)
 396         else:
 397             field_value = escape_if_needed(control.Find(key))
 398         to_print += " "+format_field(key,field_value)+'\n'
 399     return to_print
 400
 401 def do_command (command, filename, escaped=0):
 402     o = os.popen("%s %s" % (command, filename))
 403     if escaped:
 404         return escaped_text(o.read())
 405     else:
 406         return formatted_text(o.read())
 407
 408 def do_lintian (filename):
 409     if use_html:
 410         return do_command("lintian --show-overrides --color html", filename, 1)
 411     else:
 412         return do_command("lintian --show-overrides --color always", filename, 1)
 413
 414 def get_copyright (deb_filename):
 415     package = re_package.sub(r'\1', deb_filename)
 416     o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
 417     cright = o.read()[:-1]
 418
 419     if cright == "":
 420         return formatted_text("WARNING: No copyright found, please check package manually.")
 421
 422     doc_directory = re_doc_directory.sub(r'\1', cright)
 423     if package != doc_directory:
 424         return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
 425
 426     o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
 427     cright = o.read()
 428     copyrightmd5 = md5.md5(cright).hexdigest()
 429
 430     res = ""
 431     if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
 432         res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
 433                                (printed_copyrights[copyrightmd5]))
 434     else:
 435         printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
 436     return res+formatted_text(cright)
 437
 438 def get_readme_source (dsc_filename):
 439     tempdir = utils.temp_dirname()
 440     os.rmdir(tempdir)
 441
 442     cmd = "dpkg-source --no-check --no-copy -x %s %s" % (dsc_filename, tempdir)
 443     (result, output) = commands.getstatusoutput(cmd)
 444     if (result != 0):
 445         res = "How is education supposed to make me feel smarter? Besides, every time I learn something new, it pushes some\n old stuff out of my brain. Remember when I took that home winemaking course, and I forgot how to drive?\n"
 446         res += "Error, couldn't extract source, WTF?\n"
 447         res += "'dpkg-source -x' failed. return code: %s.\n\n" % (result)
 448         res += output
 449         return res
 450
 451     path = os.path.join(tempdir, 'debian/README.source')
 452     res = ""
 453     if os.path.exists(path):
 454         res += do_command("cat", path)
 455     else:
 456         res += "No README.source in this package\n\n"
 457
 458     try:
 459         shutil.rmtree(tempdir)
 460     except OSError, e:
 461         if errno.errorcode[e.errno] != 'EACCES':
 462             res += "%s: couldn't remove tmp dir %s for source tree." % (dsc_filename, tempdir)
 463
 464     return res
 465
 466 def check_dsc (suite, dsc_filename):
 467     (dsc) = read_changes_or_dsc(suite, dsc_filename)
 468     foldable_output(dsc_filename, "dsc", dsc, norow=True)
 469     foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
 470     foldable_output("README.source for %s" % dsc_filename, "source-readmesource", get_readme_source(dsc_filename))
 471
 472 def check_deb (suite, deb_filename):
 473     filename = os.path.basename(deb_filename)
 474     packagename = filename.split('_')[0]
 475
 476     if filename.endswith(".udeb"):
 477         is_a_udeb = 1
 478     else:
 479         is_a_udeb = 0
 480
 481
 482     foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
 483                     output_deb_info(suite, deb_filename, packagename), norow=True)
 484
 485     if is_a_udeb:
 486         foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
 487                         "")
 488     else:
 489         foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
 490                         do_lintian(deb_filename))
 491
 492     foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
 493                     do_command("dpkg -c", deb_filename))
 494
 495     if is_a_udeb:
 496         foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
 497                         "")
 498     else:
 499         foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
 500                         get_copyright(deb_filename))
 501
 502     foldable_output("file listing of %s" % (filename),  "binary-%s-file-listing"%packagename,
 503                     do_command("ls -l", deb_filename))
 504
 505 # Read a file, strip the signature and return the modified contents as
 506 # a string.
 507 def strip_pgp_signature (filename):
 508     inputfile = utils.open_file (filename)
 509     contents = ""
 510     inside_signature = 0
 511     skip_next = 0
 512     for line in inputfile.readlines():
 513         if line[:-1] == "":
 514             continue
 515         if inside_signature:
 516             continue
 517         if skip_next:
 518             skip_next = 0
 519             continue
 520         if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
 521             skip_next = 1
 522             continue
 523         if line.startswith("-----BEGIN PGP SIGNATURE"):
 524             inside_signature = 1
 525             continue
 526         if line.startswith("-----END PGP SIGNATURE"):
 527             inside_signature = 0
 528             continue
 529         contents += line
 530     inputfile.close()
 531     return contents
 532
 533 def display_changes(suite, changes_filename):
 534     changes = read_changes_or_dsc(suite, changes_filename)
 535     foldable_output(changes_filename, "changes", changes, norow=True)
 536
 537 def check_changes (changes_filename):
 538     try:
 539         changes = utils.parse_changes (changes_filename)
 540     except ChangesUnicodeError:
 541         utils.warn("Encoding problem with changes file %s" % (changes_filename))
 542     display_changes(changes['distribution'], changes_filename)
 543
 544     files = utils.build_file_list(changes)
 545     for f in files.keys():
 546         if f.endswith(".deb") or f.endswith(".udeb"):
 547             check_deb(changes['distribution'], f)
 548         if f.endswith(".dsc"):
 549             check_dsc(changes['distribution'], f)
 550         # else: => byhand
 551
 552 def main ():
 553     global Cnf, projectB, db_files, waste, excluded
 554
 555 #    Cnf = utils.get_conf()
 556
 557     Arguments = [('h',"help","Examine-Package::Options::Help"),
 558                  ('H',"html-output","Examine-Package::Options::Html-Output"),
 559                 ]
 560     for i in [ "Help", "Html-Output", "partial-html" ]:
 561         if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
 562             Cnf["Examine-Package::Options::%s" % (i)] = ""
 563
 564     args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
 565     Options = Cnf.SubTree("Examine-Package::Options")
 566
 567     if Options["Help"]:
 568         usage()
 569
 570     stdout_fd = sys.stdout
 571
 572     for f in args:
 573         try:
 574             if not Options["Html-Output"]:
 575                 # Pipe output for each argument through less
 576                 less_fd = os.popen("less -R -", 'w', 0)
 577                 # -R added to display raw control chars for colour
 578                 sys.stdout = less_fd
 579             try:
 580                 if f.endswith(".changes"):
 581                     check_changes(f)
 582                 elif f.endswith(".deb") or f.endswith(".udeb"):
 583                     # default to unstable when we don't have a .changes file
 584                     # perhaps this should be a command line option?
 585                     check_deb('unstable', file)
 586                 elif f.endswith(".dsc"):
 587                     check_dsc('unstable', f)
 588                 else:
 589                     utils.fubar("Unrecognised file type: '%s'." % (f))
 590             finally:
 591                 output_package_relations()
 592                 if not Options["Html-Output"]:
 593                     # Reset stdout here so future less invocations aren't FUBAR
 594                     less_fd.close()
 595                     sys.stdout = stdout_fd
 596         except IOError, e:
 597             if errno.errorcode[e.errno] == 'EPIPE':
 598                 utils.warn("[examine-package] Caught EPIPE; skipping.")
 599                 pass
 600             else:
 601                 raise
 602         except KeyboardInterrupt:
 603             utils.warn("[examine-package] Caught C-c; skipping.")
 604             pass
 605
 606 #######################################################################################
 607
 608 if __name__ == '__main__':
 609     main()