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 from daklib import database
  38 from daklib import utils
  39
  40 ################################################################################
  41
  42 re_package = re.compile(r"^(.+?)_.*")
  43 re_doc_directory = re.compile(r".*/doc/([^/]*).*")
  44
  45 re_contrib = re.compile('^contrib/')
  46 re_nonfree = re.compile('^non\-free/')
  47
  48 re_arch = re.compile("Architecture: .*")
  49 re_builddep = re.compile("Build-Depends: .*")
  50 re_builddepind = re.compile("Build-Depends-Indep: .*")
  51
  52 re_localhost = re.compile("localhost\.localdomain")
  53 re_version = re.compile('^(.*)\((.*)\)')
  54
  55 re_newlinespace = re.compile('\n')
  56 re_spacestrip = re.compile('(\s)')
  57
  58 ################################################################################
  59
  60 Cnf = None
  61 projectB = None
  62
  63 Cnf = utils.get_conf()
  64 projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"]))
  65 database.init(Cnf, projectB)
  66
  67 printed_copyrights = {}
  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 utils.re_html_escaping.sub(lambda x: utils.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 (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(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 (depends_tree):
 311     # just look up unstable for now. possibly pull from .changes later
 312     suite = "unstable"
 313     result = ""
 314     comma_count = 1
 315     for l in depends_tree:
 316         if (comma_count >= 2):
 317             result += ", "
 318         or_count = 1
 319         for d in l:
 320             if (or_count >= 2 ):
 321                 result += " | "
 322             # doesn't do version lookup yet.
 323
 324             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))
 325             ql = q.getresult()
 326             if ql:
 327                 i = ql[0]
 328
 329                 adepends = d['name']
 330                 if d['version'] != '' :
 331                     adepends += " (%s)" % (d['version'])
 332
 333                 if i[2] == "contrib":
 334                     result += colour_output(adepends, "contrib")
 335                 elif i[2] == "non-free":
 336                     result += colour_output(adepends, "nonfree")
 337                 else :
 338                     result += colour_output(adepends, "main")
 339             else:
 340                 adepends = d['name']
 341                 if d['version'] != '' :
 342                     adepends += " (%s)" % (d['version'])
 343                 result += colour_output(adepends, "bold")
 344             or_count += 1
 345         comma_count += 1
 346     return result
 347
 348 def output_deb_info(filename):
 349     (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
 350
 351     if control == '':
 352         return formatted_text("no control info")
 353     to_print = ""
 354     for key in control_keys :
 355         if key == 'Depends':
 356             field_value = create_depends_string(depends)
 357         elif key == 'Recommends':
 358             field_value = create_depends_string(recommends)
 359         elif key == 'Section':
 360             field_value = section
 361         elif key == 'Architecture':
 362             field_value = arch
 363         elif key == 'Maintainer':
 364             field_value = maintainer
 365         elif key == 'Description':
 366             if use_html:
 367                 field_value = formatted_text(control.Find(key), strip=True)
 368             else:
 369                 desc = control.Find(key)
 370                 desc = re_newlinespace.sub('\n ', desc)
 371                 field_value = escape_if_needed(desc)
 372         else:
 373             field_value = escape_if_needed(control.Find(key))
 374         to_print += " "+format_field(key,field_value)+'\n'
 375     return to_print
 376
 377 def do_command (command, filename, escaped=0):
 378     o = os.popen("%s %s" % (command, filename))
 379     if escaped:
 380         return escaped_text(o.read())
 381     else:
 382         return formatted_text(o.read())
 383
 384 def do_lintian (filename):
 385     if use_html:
 386         return do_command("lintian --show-overrides --color html", filename, 1)
 387     else:
 388         return do_command("lintian --show-overrides --color always", filename, 1)
 389
 390 def get_copyright (deb_filename):
 391     package = re_package.sub(r'\1', deb_filename)
 392     o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
 393     cright = o.read()[:-1]
 394
 395     if cright == "":
 396         return formatted_text("WARNING: No copyright found, please check package manually.")
 397
 398     doc_directory = re_doc_directory.sub(r'\1', cright)
 399     if package != doc_directory:
 400         return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
 401
 402     o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
 403     cright = o.read()
 404     copyrightmd5 = md5.md5(cright).hexdigest()
 405
 406     res = ""
 407     if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
 408         res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
 409                                (printed_copyrights[copyrightmd5]))
 410     else:
 411         printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
 412     return res+formatted_text(cright)
 413
 414 def check_dsc (dsc_filename):
 415     (dsc) = read_changes_or_dsc(dsc_filename)
 416     foldable_output(dsc_filename, "dsc", dsc, norow=True)
 417     foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
 418
 419 def check_deb (deb_filename):
 420     filename = os.path.basename(deb_filename)
 421     packagename = filename.split('_')[0]
 422
 423     if filename.endswith(".udeb"):
 424         is_a_udeb = 1
 425     else:
 426         is_a_udeb = 0
 427
 428
 429     foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
 430                     output_deb_info(deb_filename), norow=True)
 431
 432     if is_a_udeb:
 433         foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
 434                         "")
 435     else:
 436         foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
 437                         do_lintian(deb_filename))
 438
 439     foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
 440                     do_command("dpkg -c", deb_filename))
 441
 442     if is_a_udeb:
 443         foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
 444                         "")
 445     else:
 446         foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
 447                         get_copyright(deb_filename))
 448
 449     foldable_output("file listing of %s" % (filename),  "binary-%s-file-listing"%packagename,
 450                     do_command("ls -l", deb_filename))
 451
 452 # Read a file, strip the signature and return the modified contents as
 453 # a string.
 454 def strip_pgp_signature (filename):
 455     file = utils.open_file (filename)
 456     contents = ""
 457     inside_signature = 0
 458     skip_next = 0
 459     for line in file.readlines():
 460         if line[:-1] == "":
 461             continue
 462         if inside_signature:
 463             continue
 464         if skip_next:
 465             skip_next = 0
 466             continue
 467         if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
 468             skip_next = 1
 469             continue
 470         if line.startswith("-----BEGIN PGP SIGNATURE"):
 471             inside_signature = 1
 472             continue
 473         if line.startswith("-----END PGP SIGNATURE"):
 474             inside_signature = 0
 475             continue
 476         contents += line
 477     file.close()
 478     return contents
 479
 480 def display_changes(changes_filename):
 481     changes = read_changes_or_dsc(changes_filename)
 482     foldable_output(changes_filename, "changes", changes, norow=True)
 483
 484 def check_changes (changes_filename):
 485     display_changes(changes_filename)
 486
 487     changes = utils.parse_changes (changes_filename)
 488     files = utils.build_file_list(changes)
 489     for f in files.keys():
 490         if f.endswith(".deb") or f.endswith(".udeb"):
 491             check_deb(f)
 492         if f.endswith(".dsc"):
 493             check_dsc(f)
 494         # else: => byhand
 495
 496 def main ():
 497     global Cnf, projectB, db_files, waste, excluded
 498
 499 #    Cnf = utils.get_conf()
 500
 501     Arguments = [('h',"help","Examine-Package::Options::Help"),
 502                  ('H',"html-output","Examine-Package::Options::Html-Output"),
 503                 ]
 504     for i in [ "Help", "Html-Output", "partial-html" ]:
 505         if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
 506             Cnf["Examine-Package::Options::%s" % (i)] = ""
 507
 508     args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
 509     Options = Cnf.SubTree("Examine-Package::Options")
 510
 511     if Options["Help"]:
 512         usage()
 513
 514     stdout_fd = sys.stdout
 515
 516     for f in args:
 517         try:
 518             if not Options["Html-Output"]:
 519                 # Pipe output for each argument through less
 520                 less_fd = os.popen("less -R -", 'w', 0)
 521                 # -R added to display raw control chars for colour
 522                 sys.stdout = less_fd
 523             try:
 524                 if f.endswith(".changes"):
 525                     check_changes(f)
 526                 elif f.endswith(".deb") or f.endswith(".udeb"):
 527                     check_deb(file)
 528                 elif f.endswith(".dsc"):
 529                     check_dsc(f)
 530                 else:
 531                     utils.fubar("Unrecognised file type: '%s'." % (f))
 532             finally:
 533                 if not Options["Html-Output"]:
 534                     # Reset stdout here so future less invocations aren't FUBAR
 535                     less_fd.close()
 536                     sys.stdout = stdout_fd
 537         except IOError, e:
 538             if errno.errorcode[e.errno] == 'EPIPE':
 539                 utils.warn("[examine-package] Caught EPIPE; skipping.")
 540                 pass
 541             else:
 542                 raise
 543         except KeyboardInterrupt:
 544             utils.warn("[examine-package] Caught C-c; skipping.")
 545             pass
 546
 547 #######################################################################################
 548
 549 if __name__ == '__main__':
 550     main()