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