4 Script to automate some parts of checking NEW packages
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.
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
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.
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.
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
30 ################################################################################
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,
43 ################################################################################
55 from daklib import utils
56 from daklib.dbconn import DBConn, get_binary_from_name_suite
57 from daklib.regexes import html_escaping, re_html_escaping, re_version, re_spacestrip, \
58 re_contrib, re_nonfree, re_localhost, re_newlinespace, \
59 re_package, re_doc_directory
61 ################################################################################
64 Cnf = utils.get_conf()
66 printed_copyrights = {}
67 package_relations = {} #: Store relations of packages for later output
69 # default is to not output html.
72 ################################################################################
74 def usage (exit_code=0):
75 print """Usage: dak examine-package [PACKAGE]...
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
82 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
86 ################################################################################
87 # probably xml.sax.saxutils would work as well
89 def escape_if_needed(s):
91 return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
95 def headline(s, level=2, bodyelement=None):
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>\n"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
102 return "<h%d>%s</h%d>\n" % (level, utils.html_escape(s), level)
104 return "---- %s ----\n" % (s)
106 # Colour definitions, 'end' isn't really for use
110 'contrib': "\033[33m",
111 'nonfree': "\033[31m",
115 'maintainer': "\033[32m"}
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>")}
125 def colour_output(s, colour):
127 return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
129 return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
131 def escaped_text(s, strip=False):
135 return "<pre>%s</pre>" % (s)
139 def formatted_text(s, strip=False):
143 return "<pre>%s</pre>" % (utils.html_escape(s))
149 return """<tr><td>"""+s+"""</td></tr>"""
153 def format_field(k,v):
155 return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
157 return "%s: %s"%(k,v)
159 def foldable_output(title, elementnameprefix, content, norow=False):
160 d = {'elementnameprefix':elementnameprefix}
163 result += """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
164 <table class="infobox rfc822">\n"""%d
165 result += headline(title, bodyelement="%(elementnameprefix)s-body"%d)
167 result += """ <tbody id="%(elementnameprefix)s-body" class="infobody">\n"""%d
169 result += content + "\n"
171 result += output_row(content) + "\n"
173 result += """</tbody></table></div>"""
176 ################################################################################
178 def get_depends_parts(depend) :
179 v_match = re_version.match(depend)
181 d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
183 d_parts = { 'name' : depend , 'version' : '' }
186 def get_or_list(depend) :
187 or_list = depend.split("|")
190 def get_comma_list(depend) :
191 dep_list = depend.split(",")
194 def split_depends (d_str) :
195 # creates a list of lists of dictionaries of depends (package,version relation)
197 d_str = re_spacestrip.sub('',d_str)
199 # first split depends string up amongs comma delimiter
200 dep_list = get_comma_list(d_str)
202 while d < len(dep_list):
203 # put depends into their own list
204 depends_tree.append([dep_list[d]])
207 while d < len(depends_tree):
209 # split up Or'd depends into a multi-item list
210 depends_tree[d] = get_or_list(depends_tree[d][0])
211 while k < len(depends_tree[d]):
212 # split depends into {package, version relation}
213 depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
218 def read_control (filename):
225 deb_file = utils.open_file(filename)
227 extracts = apt_inst.debExtractControl(deb_file)
228 control = apt_pkg.ParseSection(extracts)
230 print formatted_text("can't parse control info")
236 control_keys = control.keys()
238 if control.has_key("Depends"):
239 depends_str = control.Find("Depends")
240 # create list of dependancy lists
241 depends = split_depends(depends_str)
243 if control.has_key("Recommends"):
244 recommends_str = control.Find("Recommends")
245 recommends = split_depends(recommends_str)
247 if control.has_key("Section"):
248 section_str = control.Find("Section")
250 c_match = re_contrib.search(section_str)
251 nf_match = re_nonfree.search(section_str)
254 section = colour_output(section_str, 'contrib')
257 section = colour_output(section_str, 'nonfree')
260 section = colour_output(section_str, 'main')
261 if control.has_key("Architecture"):
262 arch_str = control.Find("Architecture")
263 arch = colour_output(arch_str, 'arch')
265 if control.has_key("Maintainer"):
266 maintainer = control.Find("Maintainer")
267 localhost = re_localhost.search(maintainer)
270 maintainer = colour_output(maintainer, 'maintainer')
272 maintainer = escape_if_needed(maintainer)
274 return (control, control_keys, section, depends, recommends, arch, maintainer)
276 def read_changes_or_dsc (suite, filename):
279 dsc_file = utils.open_file(filename)
281 dsc = utils.parse_changes(filename, dsc_file=1)
283 return formatted_text("can't parse .dsc control info")
286 filecontents = strip_pgp_signature(filename)
288 for l in filecontents.split('\n'):
289 m = re.match(r'([-a-zA-Z0-9]*):', l)
291 keysinorder.append(m.group(1))
294 if k in ("build-depends","build-depends-indep"):
295 dsc[k] = create_depends_string(suite, split_depends(dsc[k]))
296 elif k == "architecture":
297 if (dsc["architecture"] != "any"):
298 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
299 elif k in ("files","changes","description"):
301 dsc[k] = formatted_text(dsc[k], strip=True)
303 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
305 dsc[k] = escape_if_needed(dsc[k])
307 keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
309 filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
312 def create_depends_string (suite, depends_tree):
314 if suite == 'experimental':
315 suite_where = "in ('experimental','unstable')"
317 suite_where = "= '%s'" % suite
320 session = DBConn().session()
321 for l in depends_tree:
322 if (comma_count >= 2):
328 # doesn't do version lookup yet.
330 res = get_binary_from_name_suite(d['name'], suite_where)
335 if d['version'] != '' :
336 adepends += " (%s)" % (d['version'])
338 if i[2] == "contrib":
339 result += colour_output(adepends, "contrib")
340 elif i[2] == "non-free":
341 result += colour_output(adepends, "nonfree")
343 result += colour_output(adepends, "main")
346 if d['version'] != '' :
347 adepends += " (%s)" % (d['version'])
348 result += colour_output(adepends, "bold")
353 def output_package_relations ():
355 Output the package relations, if there is more than one package checked in this run.
358 if len(package_relations) < 2:
359 # Only list something if we have more than one binary to compare
360 package_relations.clear()
364 for package in package_relations:
365 for relation in package_relations[package]:
366 to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
368 package_relations.clear()
369 return foldable_output("Package relations", "relations", to_print)
371 def output_deb_info(suite, filename, packagename):
372 (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
375 return formatted_text("no control info")
377 if not package_relations.has_key(packagename):
378 package_relations[packagename] = {}
379 for key in control_keys :
381 field_value = create_depends_string(suite, depends)
382 package_relations[packagename][key] = field_value
383 elif key == 'Recommends':
384 field_value = create_depends_string(suite, recommends)
385 package_relations[packagename][key] = field_value
386 elif key == 'Section':
387 field_value = section
388 elif key == 'Architecture':
390 elif key == 'Maintainer':
391 field_value = maintainer
392 elif key == 'Description':
394 field_value = formatted_text(control.Find(key), strip=True)
396 desc = control.Find(key)
397 desc = re_newlinespace.sub('\n ', desc)
398 field_value = escape_if_needed(desc)
400 field_value = escape_if_needed(control.Find(key))
401 to_print += " "+format_field(key,field_value)+'\n'
404 def do_command (command, filename, escaped=0):
405 o = os.popen("%s %s" % (command, filename))
407 return escaped_text(o.read())
409 return formatted_text(o.read())
411 def do_lintian (filename):
413 return do_command("lintian --show-overrides --color html", filename, 1)
415 return do_command("lintian --show-overrides --color always", filename, 1)
417 def get_copyright (deb_filename):
418 package = re_package.sub(r'\1', deb_filename)
419 o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
420 cright = o.read()[:-1]
423 return formatted_text("WARNING: No copyright found, please check package manually.")
425 doc_directory = re_doc_directory.sub(r'\1', cright)
426 if package != doc_directory:
427 return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
429 o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
431 copyrightmd5 = md5.md5(cright).hexdigest()
434 if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
435 res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
436 (printed_copyrights[copyrightmd5]))
438 printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
439 return res+formatted_text(cright)
441 def get_readme_source (dsc_filename):
442 tempdir = utils.temp_dirname()
445 cmd = "dpkg-source --no-check --no-copy -x %s %s" % (dsc_filename, tempdir)
446 (result, output) = commands.getstatusoutput(cmd)
448 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"
449 res += "Error, couldn't extract source, WTF?\n"
450 res += "'dpkg-source -x' failed. return code: %s.\n\n" % (result)
454 path = os.path.join(tempdir, 'debian/README.source')
456 if os.path.exists(path):
457 res += do_command("cat", path)
459 res += "No README.source in this package\n\n"
462 shutil.rmtree(tempdir)
464 if errno.errorcode[e.errno] != 'EACCES':
465 res += "%s: couldn't remove tmp dir %s for source tree." % (dsc_filename, tempdir)
469 def check_dsc (suite, dsc_filename):
470 (dsc) = read_changes_or_dsc(suite, dsc_filename)
471 return foldable_output(dsc_filename, "dsc", dsc, norow=True) + \
473 foldable_output("lintian check for %s" % dsc_filename,
474 "source-lintian", do_lintian(dsc_filename)) + \
476 foldable_output("README.source for %s" % dsc_filename,
477 "source-readmesource", get_readme_source(dsc_filename))
479 def check_deb (suite, deb_filename):
480 filename = os.path.basename(deb_filename)
481 packagename = filename.split('_')[0]
483 if filename.endswith(".udeb"):
488 result = foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
489 output_deb_info(suite, deb_filename, packagename), norow=True) + "\n"
492 result += foldable_output("skipping lintian check for udeb",
493 "binary-%s-lintian"%packagename, "") + "\n"
495 result += foldable_output("lintian check for %s" % (filename),
496 "binary-%s-lintian"%packagename, do_lintian(deb_filename)) + "\n"
498 result += foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
499 do_command("dpkg -c", deb_filename)) + "\n"
502 result += foldable_output("skipping copyright for udeb",
503 "binary-%s-copyright"%packagename, "") + "\n"
505 result += foldable_output("copyright of %s" % (filename),
506 "binary-%s-copyright"%packagename, get_copyright(deb_filename)) + "\n"
508 result += foldable_output("file listing of %s" % (filename),
509 "binary-%s-file-listing"%packagename, do_command("ls -l", deb_filename))
513 # Read a file, strip the signature and return the modified contents as
515 def strip_pgp_signature (filename):
516 inputfile = utils.open_file (filename)
520 for line in inputfile.readlines():
528 if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
531 if line.startswith("-----BEGIN PGP SIGNATURE"):
534 if line.startswith("-----END PGP SIGNATURE"):
541 def display_changes(suite, changes_filename):
542 changes = read_changes_or_dsc(suite, changes_filename)
543 return foldable_output(changes_filename, "changes", changes, norow=True)
545 def check_changes (changes_filename):
547 changes = utils.parse_changes (changes_filename)
548 except ChangesUnicodeError:
549 utils.warn("Encoding problem with changes file %s" % (changes_filename))
550 print display_changes(changes['distribution'], changes_filename)
552 files = utils.build_file_list(changes)
553 for f in files.keys():
554 if f.endswith(".deb") or f.endswith(".udeb"):
555 print check_deb(changes['distribution'], f)
556 if f.endswith(".dsc"):
557 print check_dsc(changes['distribution'], f)
561 global Cnf, db_files, waste, excluded
563 # Cnf = utils.get_conf()
565 Arguments = [('h',"help","Examine-Package::Options::Help"),
566 ('H',"html-output","Examine-Package::Options::Html-Output"),
568 for i in [ "Help", "Html-Output", "partial-html" ]:
569 if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
570 Cnf["Examine-Package::Options::%s" % (i)] = ""
572 args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
573 Options = Cnf.SubTree("Examine-Package::Options")
578 if Options["Html-Output"]:
582 stdout_fd = sys.stdout
586 if not Options["Html-Output"]:
587 # Pipe output for each argument through less
588 less_fd = os.popen("less -R -", 'w', 0)
589 # -R added to display raw control chars for colour
592 if f.endswith(".changes"):
594 elif f.endswith(".deb") or f.endswith(".udeb"):
595 # default to unstable when we don't have a .changes file
596 # perhaps this should be a command line option?
597 print check_deb('unstable', f)
598 elif f.endswith(".dsc"):
599 print check_dsc('unstable', f)
601 utils.fubar("Unrecognised file type: '%s'." % (f))
603 print output_package_relations()
604 if not Options["Html-Output"]:
605 # Reset stdout here so future less invocations aren't FUBAR
607 sys.stdout = stdout_fd
609 if errno.errorcode[e.errno] == 'EPIPE':
610 utils.warn("[examine-package] Caught EPIPE; skipping.")
614 except KeyboardInterrupt:
615 utils.warn("[examine-package] Caught C-c; skipping.")
618 #######################################################################################
620 if __name__ == '__main__':