dak/examine_package.py

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