4 Script to automate some parts of checking NEW packages
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
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.
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.
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
26 ################################################################################
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,
39 ################################################################################
47 import apt_pkg, apt_inst
48 from daklib import database
49 from daklib import utils
50 from daklib.regexes import html_escaping, re_html_escaping, re_version, re_spacestrip, \
51 re_contrib, re_nonfree, re_localhost, re_newlinespace, \
52 re_package, re_doc_directory
54 ################################################################################
59 Cnf = utils.get_conf()
60 projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"]))
61 database.init(Cnf, projectB)
63 printed_copyrights = {}
64 package_relations = {}
66 # default is to not output html.
69 ################################################################################
71 def usage (exit_code=0):
72 print """Usage: dak examine-package [PACKAGE]...
75 -h, --help show this help and exit
76 -H, --html-output output html page with inspection result
77 -f, --file-name filename for the html page
79 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
83 ################################################################################
84 # probably xml.sax.saxutils would work as well
86 def escape_if_needed(s):
88 return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
92 def headline(s, level=2, bodyelement=None):
96 <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>
97 </thead>"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
99 print "<h%d>%s</h%d>" % (level, utils.html_escape(s), level)
101 print "---- %s ----" % (s)
103 # Colour definitions, 'end' isn't really for use
107 'contrib': "\033[33m",
108 'nonfree': "\033[31m",
112 'maintainer': "\033[32m"}
115 'main': ('<span style="color: aqua">',"</span>"),
116 'contrib': ('<span style="color: yellow">',"</span>"),
117 'nonfree': ('<span style="color: red">',"</span>"),
118 'arch': ('<span style="color: green">',"</span>"),
119 'bold': ('<span style="font-weight: bold">',"</span>"),
120 'maintainer': ('<span style="color: green">',"</span>")}
122 def colour_output(s, colour):
124 return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
126 return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
128 def escaped_text(s, strip=False):
132 return "<pre>%s</pre>" % (s)
136 def formatted_text(s, strip=False):
140 return "<pre>%s</pre>" % (utils.html_escape(s))
146 return """<tr><td>"""+s+"""</td></tr>"""
150 def format_field(k,v):
152 return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
154 return "%s: %s"%(k,v)
156 def foldable_output(title, elementnameprefix, content, norow=False):
157 d = {'elementnameprefix':elementnameprefix}
159 print """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
160 <table class="infobox rfc822">"""%d
161 headline(title, bodyelement="%(elementnameprefix)s-body"%d)
163 print """ <tbody id="%(elementnameprefix)s-body" class="infobody">"""%d
167 print output_row(content)
169 print """</tbody></table></div>"""
171 ################################################################################
173 def get_depends_parts(depend) :
174 v_match = re_version.match(depend)
176 d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
178 d_parts = { 'name' : depend , 'version' : '' }
181 def get_or_list(depend) :
182 or_list = depend.split("|")
185 def get_comma_list(depend) :
186 dep_list = depend.split(",")
189 def split_depends (d_str) :
190 # creates a list of lists of dictionaries of depends (package,version relation)
192 d_str = re_spacestrip.sub('',d_str)
194 # first split depends string up amongs comma delimiter
195 dep_list = get_comma_list(d_str)
197 while d < len(dep_list):
198 # put depends into their own list
199 depends_tree.append([dep_list[d]])
202 while d < len(depends_tree):
204 # split up Or'd depends into a multi-item list
205 depends_tree[d] = get_or_list(depends_tree[d][0])
206 while k < len(depends_tree[d]):
207 # split depends into {package, version relation}
208 depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
213 def read_control (filename):
220 deb_file = utils.open_file(filename)
222 extracts = apt_inst.debExtractControl(deb_file)
223 control = apt_pkg.ParseSection(extracts)
225 print formatted_text("can't parse control info")
231 control_keys = control.keys()
233 if control.has_key("Depends"):
234 depends_str = control.Find("Depends")
235 # create list of dependancy lists
236 depends = split_depends(depends_str)
238 if control.has_key("Recommends"):
239 recommends_str = control.Find("Recommends")
240 recommends = split_depends(recommends_str)
242 if control.has_key("Section"):
243 section_str = control.Find("Section")
245 c_match = re_contrib.search(section_str)
246 nf_match = re_nonfree.search(section_str)
249 section = colour_output(section_str, 'contrib')
252 section = colour_output(section_str, 'nonfree')
255 section = colour_output(section_str, 'main')
256 if control.has_key("Architecture"):
257 arch_str = control.Find("Architecture")
258 arch = colour_output(arch_str, 'arch')
260 if control.has_key("Maintainer"):
261 maintainer = control.Find("Maintainer")
262 localhost = re_localhost.search(maintainer)
265 maintainer = colour_output(maintainer, 'maintainer')
267 maintainer = escape_if_needed(maintainer)
269 return (control, control_keys, section, depends, recommends, arch, maintainer)
271 def read_changes_or_dsc (suite, filename):
274 dsc_file = utils.open_file(filename)
276 dsc = utils.parse_changes(filename)
278 return formatted_text("can't parse .dsc control info")
281 filecontents = strip_pgp_signature(filename)
283 for l in filecontents.split('\n'):
284 m = re.match(r'([-a-zA-Z0-9]*):', l)
286 keysinorder.append(m.group(1))
289 if k in ("build-depends","build-depends-indep"):
290 dsc[k] = create_depends_string(suite, split_depends(dsc[k]))
291 elif k == "architecture":
292 if (dsc["architecture"] != "any"):
293 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
294 elif k in ("files","changes","description"):
296 dsc[k] = formatted_text(dsc[k], strip=True)
298 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
300 dsc[k] = escape_if_needed(dsc[k])
302 keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
304 filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
307 def create_depends_string (suite, depends_tree):
309 if suite == 'experimental':
310 suite_where = " in ('experimental','unstable')"
312 suite_where = " ='%s'" % suite
315 for l in depends_tree:
316 if (comma_count >= 2):
322 # doesn't do version lookup yet.
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_where))
330 if d['version'] != '' :
331 adepends += " (%s)" % (d['version'])
333 if i[2] == "contrib":
334 result += colour_output(adepends, "contrib")
335 elif i[2] == "non-free":
336 result += colour_output(adepends, "nonfree")
338 result += colour_output(adepends, "main")
341 if d['version'] != '' :
342 adepends += " (%s)" % (d['version'])
343 result += colour_output(adepends, "bold")
348 def output_package_relations ():
350 Output the package relations, if there is more than one package checked in this run.
353 if len(package_relations) < 2:
354 # Only list something if we have more than one binary to compare
358 for package in package_relations:
359 for relation in package_relations[package]:
360 to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
362 foldable_output("Package relations", "relations", to_print)
364 def output_deb_info(suite, filename, packagename):
365 (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
368 return formatted_text("no control info")
370 if not package_relations.has_key(packagename):
371 package_relations[packagename] = {}
372 for key in control_keys :
374 field_value = create_depends_string(suite, depends)
375 package_relations[packagename][key] = field_value
376 elif key == 'Recommends':
377 field_value = create_depends_string(suite, recommends)
378 package_relations[packagename][key] = field_value
379 elif key == 'Section':
380 field_value = section
381 elif key == 'Architecture':
383 elif key == 'Maintainer':
384 field_value = maintainer
385 elif key == 'Description':
387 field_value = formatted_text(control.Find(key), strip=True)
389 desc = control.Find(key)
390 desc = re_newlinespace.sub('\n ', desc)
391 field_value = escape_if_needed(desc)
393 field_value = escape_if_needed(control.Find(key))
394 to_print += " "+format_field(key,field_value)+'\n'
397 def do_command (command, filename, escaped=0):
398 o = os.popen("%s %s" % (command, filename))
400 return escaped_text(o.read())
402 return formatted_text(o.read())
404 def do_lintian (filename):
406 return do_command("lintian --show-overrides --color html", filename, 1)
408 return do_command("lintian --show-overrides --color always", filename, 1)
410 def get_copyright (deb_filename):
411 package = re_package.sub(r'\1', deb_filename)
412 o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
413 cright = o.read()[:-1]
416 return formatted_text("WARNING: No copyright found, please check package manually.")
418 doc_directory = re_doc_directory.sub(r'\1', cright)
419 if package != doc_directory:
420 return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
422 o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
424 copyrightmd5 = md5.md5(cright).hexdigest()
427 if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
428 res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
429 (printed_copyrights[copyrightmd5]))
431 printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
432 return res+formatted_text(cright)
434 def check_dsc (suite, dsc_filename):
435 (dsc) = read_changes_or_dsc(suite, dsc_filename)
436 foldable_output(dsc_filename, "dsc", dsc, norow=True)
437 foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
439 def check_deb (suite, deb_filename):
440 filename = os.path.basename(deb_filename)
441 packagename = filename.split('_')[0]
443 if filename.endswith(".udeb"):
449 foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
450 output_deb_info(suite, deb_filename, packagename), norow=True)
453 foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
456 foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
457 do_lintian(deb_filename))
459 foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
460 do_command("dpkg -c", deb_filename))
463 foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
466 foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
467 get_copyright(deb_filename))
469 foldable_output("file listing of %s" % (filename), "binary-%s-file-listing"%packagename,
470 do_command("ls -l", deb_filename))
472 # Read a file, strip the signature and return the modified contents as
474 def strip_pgp_signature (filename):
475 inputfile = utils.open_file (filename)
479 for line in inputfile.readlines():
487 if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
490 if line.startswith("-----BEGIN PGP SIGNATURE"):
493 if line.startswith("-----END PGP SIGNATURE"):
500 def display_changes(suite, changes_filename):
501 changes = read_changes_or_dsc(suite, changes_filename)
502 foldable_output(changes_filename, "changes", changes, norow=True)
504 def check_changes (changes_filename):
506 changes = utils.parse_changes (changes_filename)
507 except ChangesUnicodeError:
508 utils.warn("Encoding problem with changes file %s" % (changes_filename))
509 display_changes(changes['distribution'], changes_filename)
511 files = utils.build_file_list(changes)
512 for f in files.keys():
513 if f.endswith(".deb") or f.endswith(".udeb"):
514 check_deb(changes['distribution'], f)
515 if f.endswith(".dsc"):
516 check_dsc(changes['distribution'], f)
520 global Cnf, projectB, db_files, waste, excluded
522 # Cnf = utils.get_conf()
524 Arguments = [('h',"help","Examine-Package::Options::Help"),
525 ('H',"html-output","Examine-Package::Options::Html-Output"),
527 for i in [ "Help", "Html-Output", "partial-html" ]:
528 if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
529 Cnf["Examine-Package::Options::%s" % (i)] = ""
531 args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
532 Options = Cnf.SubTree("Examine-Package::Options")
537 stdout_fd = sys.stdout
541 if not Options["Html-Output"]:
542 # Pipe output for each argument through less
543 less_fd = os.popen("less -R -", 'w', 0)
544 # -R added to display raw control chars for colour
547 if f.endswith(".changes"):
549 elif f.endswith(".deb") or f.endswith(".udeb"):
550 # default to unstable when we don't have a .changes file
551 # perhaps this should be a command line option?
552 check_deb('unstable', file)
553 elif f.endswith(".dsc"):
554 check_dsc('unstable', f)
556 utils.fubar("Unrecognised file type: '%s'." % (f))
558 output_package_relations()
559 if not Options["Html-Output"]:
560 # Reset stdout here so future less invocations aren't FUBAR
562 sys.stdout = stdout_fd
564 if errno.errorcode[e.errno] == 'EPIPE':
565 utils.warn("[examine-package] Caught EPIPE; skipping.")
569 except KeyboardInterrupt:
570 utils.warn("[examine-package] Caught C-c; skipping.")
573 #######################################################################################
575 if __name__ == '__main__':