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 ################################################################################
52 from daklib import utils
53 from daklib.dbconn import DBConn, get_binary_from_name_suite
54 from daklib.regexes import html_escaping, re_html_escaping, re_version, re_spacestrip, \
55 re_contrib, re_nonfree, re_localhost, re_newlinespace, \
56 re_package, re_doc_directory
58 ################################################################################
61 Cnf = utils.get_conf()
63 printed_copyrights = {}
64 package_relations = {} #: Store relations of packages for later output
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 session = DBConn().session()
316 for l in depends_tree:
317 if (comma_count >= 2):
323 # doesn't do version lookup yet.
325 res = get_binary_from_name_suite(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
355 package_relations.clear()
359 for package in package_relations:
360 for relation in package_relations[package]:
361 to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
363 package_relations.clear()
364 foldable_output("Package relations", "relations", to_print)
366 def output_deb_info(suite, filename, packagename):
367 (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
370 return formatted_text("no control info")
372 if not package_relations.has_key(packagename):
373 package_relations[packagename] = {}
374 for key in control_keys :
376 field_value = create_depends_string(suite, depends)
377 package_relations[packagename][key] = field_value
378 elif key == 'Recommends':
379 field_value = create_depends_string(suite, recommends)
380 package_relations[packagename][key] = field_value
381 elif key == 'Section':
382 field_value = section
383 elif key == 'Architecture':
385 elif key == 'Maintainer':
386 field_value = maintainer
387 elif key == 'Description':
389 field_value = formatted_text(control.Find(key), strip=True)
391 desc = control.Find(key)
392 desc = re_newlinespace.sub('\n ', desc)
393 field_value = escape_if_needed(desc)
395 field_value = escape_if_needed(control.Find(key))
396 to_print += " "+format_field(key,field_value)+'\n'
399 def do_command (command, filename, escaped=0):
400 o = os.popen("%s %s" % (command, filename))
402 return escaped_text(o.read())
404 return formatted_text(o.read())
406 def do_lintian (filename):
408 return do_command("lintian --show-overrides --color html", filename, 1)
410 return do_command("lintian --show-overrides --color always", filename, 1)
412 def get_copyright (deb_filename):
413 package = re_package.sub(r'\1', deb_filename)
414 o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
415 cright = o.read()[:-1]
418 return formatted_text("WARNING: No copyright found, please check package manually.")
420 doc_directory = re_doc_directory.sub(r'\1', cright)
421 if package != doc_directory:
422 return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
424 o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
426 copyrightmd5 = md5.md5(cright).hexdigest()
429 if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
430 res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
431 (printed_copyrights[copyrightmd5]))
433 printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
434 return res+formatted_text(cright)
436 def get_readme_source (dsc_filename):
437 tempdir = utils.temp_dirname()
440 cmd = "dpkg-source --no-check --no-copy -x %s %s" % (dsc_filename, tempdir)
441 (result, output) = commands.getstatusoutput(cmd)
443 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"
444 res += "Error, couldn't extract source, WTF?\n"
445 res += "'dpkg-source -x' failed. return code: %s.\n\n" % (result)
449 path = os.path.join(tempdir, 'debian/README.source')
451 if os.path.exists(path):
452 res += do_command("cat", path)
454 res += "No README.source in this package\n\n"
457 shutil.rmtree(tempdir)
459 if errno.errorcode[e.errno] != 'EACCES':
460 res += "%s: couldn't remove tmp dir %s for source tree." % (dsc_filename, tempdir)
464 def check_dsc (suite, dsc_filename):
465 (dsc) = read_changes_or_dsc(suite, dsc_filename)
466 foldable_output(dsc_filename, "dsc", dsc, norow=True)
467 foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
468 foldable_output("README.source for %s" % dsc_filename, "source-readmesource", get_readme_source(dsc_filename))
470 def check_deb (suite, deb_filename):
471 filename = os.path.basename(deb_filename)
472 packagename = filename.split('_')[0]
474 if filename.endswith(".udeb"):
480 foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
481 output_deb_info(suite, deb_filename, packagename), norow=True)
484 foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
487 foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
488 do_lintian(deb_filename))
490 foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
491 do_command("dpkg -c", deb_filename))
494 foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
497 foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
498 get_copyright(deb_filename))
500 foldable_output("file listing of %s" % (filename), "binary-%s-file-listing"%packagename,
501 do_command("ls -l", deb_filename))
503 # Read a file, strip the signature and return the modified contents as
505 def strip_pgp_signature (filename):
506 inputfile = utils.open_file (filename)
510 for line in inputfile.readlines():
518 if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
521 if line.startswith("-----BEGIN PGP SIGNATURE"):
524 if line.startswith("-----END PGP SIGNATURE"):
531 def display_changes(suite, changes_filename):
532 changes = read_changes_or_dsc(suite, changes_filename)
533 foldable_output(changes_filename, "changes", changes, norow=True)
535 def check_changes (changes_filename):
537 changes = utils.parse_changes (changes_filename)
538 except ChangesUnicodeError:
539 utils.warn("Encoding problem with changes file %s" % (changes_filename))
540 display_changes(changes['distribution'], changes_filename)
542 files = utils.build_file_list(changes)
543 for f in files.keys():
544 if f.endswith(".deb") or f.endswith(".udeb"):
545 check_deb(changes['distribution'], f)
546 if f.endswith(".dsc"):
547 check_dsc(changes['distribution'], f)
551 global Cnf, db_files, waste, excluded
553 # Cnf = utils.get_conf()
555 Arguments = [('h',"help","Examine-Package::Options::Help"),
556 ('H',"html-output","Examine-Package::Options::Html-Output"),
558 for i in [ "Help", "Html-Output", "partial-html" ]:
559 if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
560 Cnf["Examine-Package::Options::%s" % (i)] = ""
562 args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
563 Options = Cnf.SubTree("Examine-Package::Options")
568 stdout_fd = sys.stdout
572 if not Options["Html-Output"]:
573 # Pipe output for each argument through less
574 less_fd = os.popen("less -R -", 'w', 0)
575 # -R added to display raw control chars for colour
578 if f.endswith(".changes"):
580 elif f.endswith(".deb") or f.endswith(".udeb"):
581 # default to unstable when we don't have a .changes file
582 # perhaps this should be a command line option?
583 check_deb('unstable', file)
584 elif f.endswith(".dsc"):
585 check_dsc('unstable', f)
587 utils.fubar("Unrecognised file type: '%s'." % (f))
589 output_package_relations()
590 if not Options["Html-Output"]:
591 # Reset stdout here so future less invocations aren't FUBAR
593 sys.stdout = stdout_fd
595 if errno.errorcode[e.errno] == 'EPIPE':
596 utils.warn("[examine-package] Caught EPIPE; skipping.")
600 except KeyboardInterrupt:
601 utils.warn("[examine-package] Caught C-c; skipping.")
604 #######################################################################################
606 if __name__ == '__main__':