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 ################################################################################
45 # suppress some deprecation warnings in squeeze related to md5 module
47 warnings.filterwarnings('ignore', \
48 "the md5 module is deprecated; use hashlib instead", \
62 from daklib import utils
63 from daklib.config import Config
64 from daklib.dbconn import DBConn, get_component_by_package_suite
65 from daklib.gpg import SignedFile
66 from daklib.regexes import html_escaping, re_html_escaping, re_version, re_spacestrip, \
67 re_contrib, re_nonfree, re_localhost, re_newlinespace, \
68 re_package, re_doc_directory
69 from daklib.dak_exceptions import ChangesUnicodeError
71 ################################################################################
74 Cnf = utils.get_conf()
76 printed = threading.local()
77 printed.copyrights = {}
78 package_relations = {} #: Store relations of packages for later output
80 # default is to not output html.
83 ################################################################################
85 def usage (exit_code=0):
86 print """Usage: dak examine-package [PACKAGE]...
89 -h, --help show this help and exit
90 -H, --html-output output html page with inspection result
91 -f, --file-name filename for the html page
93 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
97 ################################################################################
98 # probably xml.sax.saxutils would work as well
100 def escape_if_needed(s):
102 return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
106 def headline(s, level=2, bodyelement=None):
110 <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>
111 </thead>\n"""%{"bodyelement":bodyelement,"title":utils.html_escape(os.path.basename(s))}
113 return "<h%d>%s</h%d>\n" % (level, utils.html_escape(s), level)
115 return "---- %s ----\n" % (s)
117 # Colour definitions, 'end' isn't really for use
121 'contrib': "\033[33m",
122 'nonfree': "\033[31m",
123 'provides': "\033[35m",
127 'maintainer': "\033[32m",
128 'distro': "\033[1m\033[41m"}
131 'main': ('<span style="color: aqua">',"</span>"),
132 'contrib': ('<span style="color: yellow">',"</span>"),
133 'nonfree': ('<span style="color: red">',"</span>"),
134 'provides': ('<span style="color: magenta">',"</span>"),
135 'arch': ('<span style="color: green">',"</span>"),
136 'bold': ('<span style="font-weight: bold">',"</span>"),
137 'maintainer': ('<span style="color: green">',"</span>"),
138 'distro': ('<span style="font-weight: bold; background-color: red">',"</span>")}
140 def colour_output(s, colour):
142 return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
144 return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
146 def escaped_text(s, strip=False):
150 return "<pre>%s</pre>" % (s)
154 def formatted_text(s, strip=False):
158 return "<pre>%s</pre>" % (utils.html_escape(s))
164 return """<tr><td>"""+s+"""</td></tr>"""
168 def format_field(k,v):
170 return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
172 return "%s: %s"%(k,v)
174 def foldable_output(title, elementnameprefix, content, norow=False):
175 d = {'elementnameprefix':elementnameprefix}
178 result += """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
179 <table class="infobox rfc822">\n"""%d
180 result += headline(title, bodyelement="%(elementnameprefix)s-body"%d)
182 result += """ <tbody id="%(elementnameprefix)s-body" class="infobody">\n"""%d
184 result += content + "\n"
186 result += output_row(content) + "\n"
188 result += """</tbody></table></div>"""
191 ################################################################################
193 def get_depends_parts(depend) :
194 v_match = re_version.match(depend)
196 d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
198 d_parts = { 'name' : depend , 'version' : '' }
201 def get_or_list(depend) :
202 or_list = depend.split("|")
205 def get_comma_list(depend) :
206 dep_list = depend.split(",")
209 def split_depends (d_str) :
210 # creates a list of lists of dictionaries of depends (package,version relation)
212 d_str = re_spacestrip.sub('',d_str)
214 # first split depends string up amongs comma delimiter
215 dep_list = get_comma_list(d_str)
217 while d < len(dep_list):
218 # put depends into their own list
219 depends_tree.append([dep_list[d]])
222 while d < len(depends_tree):
224 # split up Or'd depends into a multi-item list
225 depends_tree[d] = get_or_list(depends_tree[d][0])
226 while k < len(depends_tree[d]):
227 # split depends into {package, version relation}
228 depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
233 def read_control (filename):
240 deb_file = utils.open_file(filename)
242 extracts = utils.deb_extract_control(deb_file)
243 control = apt_pkg.TagSection(extracts)
245 print formatted_text("can't parse control info")
251 control_keys = control.keys()
253 if "Depends" in control:
254 depends_str = control["Depends"]
255 # create list of dependancy lists
256 depends = split_depends(depends_str)
258 if "Recommends" in control:
259 recommends_str = control["Recommends"]
260 recommends = split_depends(recommends_str)
262 if "Section" in control:
263 section_str = control["Section"]
265 c_match = re_contrib.search(section_str)
266 nf_match = re_nonfree.search(section_str)
269 section = colour_output(section_str, 'contrib')
272 section = colour_output(section_str, 'nonfree')
275 section = colour_output(section_str, 'main')
276 if "Architecture" in control:
277 arch_str = control["Architecture"]
278 arch = colour_output(arch_str, 'arch')
280 if "Maintainer" in control:
281 maintainer = control["Maintainer"]
282 localhost = re_localhost.search(maintainer)
285 maintainer = colour_output(maintainer, 'maintainer')
287 maintainer = escape_if_needed(maintainer)
289 return (control, control_keys, section, depends, recommends, arch, maintainer)
291 def read_changes_or_dsc (suite, filename, session = None):
294 dsc_file = utils.open_file(filename)
296 dsc = utils.parse_changes(filename, dsc_file=1)
298 return formatted_text("can't parse .dsc control info")
301 filecontents = strip_pgp_signature(filename)
303 for l in filecontents.split('\n'):
304 m = re.match(r'([-a-zA-Z0-9]*):', l)
306 keysinorder.append(m.group(1))
309 if k in ("build-depends","build-depends-indep"):
310 dsc[k] = create_depends_string(suite, split_depends(dsc[k]), session)
311 elif k == "architecture":
312 if (dsc["architecture"] != "any"):
313 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
314 elif k == "distribution":
315 if dsc["distribution"] not in ('unstable', 'experimental'):
316 dsc['distribution'] = colour_output(dsc["distribution"], 'distro')
317 elif k in ("files","changes","description"):
319 dsc[k] = formatted_text(dsc[k], strip=True)
321 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
323 dsc[k] = escape_if_needed(dsc[k])
325 keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
327 filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
330 def get_provides(suite):
332 session = DBConn().session()
333 query = '''SELECT DISTINCT value
334 FROM binaries_metadata m
335 JOIN bin_associations b
340 WHERE key = 'Provides' )
344 WHERE suite_name = '%(suite)s'
345 OR codename = '%(suite)s')''' % \
347 for p in session.execute(query):
349 for i in e.split(','):
350 provides.add(i.strip())
354 def create_depends_string (suite, depends_tree, session = None):
356 if suite == 'experimental':
357 suite_list = ['experimental','unstable']
363 for l in depends_tree:
364 if (comma_count >= 2):
370 # doesn't do version lookup yet.
372 component = get_component_by_package_suite(d['name'], suite_list, \
374 if component is not None:
376 if d['version'] != '' :
377 adepends += " (%s)" % (d['version'])
379 if component == "contrib":
380 result += colour_output(adepends, "contrib")
381 elif component == "non-free":
382 result += colour_output(adepends, "nonfree")
384 result += colour_output(adepends, "main")
387 if d['version'] != '' :
388 adepends += " (%s)" % (d['version'])
390 provides = get_provides(suite)
391 if d['name'] in provides:
392 result += colour_output(adepends, "provides")
394 result += colour_output(adepends, "bold")
399 def output_package_relations ():
401 Output the package relations, if there is more than one package checked in this run.
404 if len(package_relations) < 2:
405 # Only list something if we have more than one binary to compare
406 package_relations.clear()
410 for package in package_relations:
411 for relation in package_relations[package]:
412 to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
414 package_relations.clear()
415 return foldable_output("Package relations", "relations", to_print)
417 def output_deb_info(suite, filename, packagename, session = None):
418 (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
421 return formatted_text("no control info")
423 if not package_relations.has_key(packagename):
424 package_relations[packagename] = {}
425 for key in control_keys :
427 field_value = create_depends_string(suite, depends, session)
428 package_relations[packagename][key] = field_value
429 elif key == 'Recommends':
430 field_value = create_depends_string(suite, recommends, session)
431 package_relations[packagename][key] = field_value
432 elif key == 'Section':
433 field_value = section
434 elif key == 'Architecture':
436 elif key == 'Maintainer':
437 field_value = maintainer
438 elif key == 'Description':
440 field_value = formatted_text(control.find(key), strip=True)
442 desc = control.find(key)
443 desc = re_newlinespace.sub('\n ', desc)
444 field_value = escape_if_needed(desc)
446 field_value = escape_if_needed(control.find(key))
447 to_print += " "+format_field(key,field_value)+'\n'
450 def do_command (command, filename, escaped=False):
451 o = os.popen("%s %s" % (command, filename))
453 return escaped_text(o.read())
455 return formatted_text(o.read())
457 def do_lintian (filename):
461 user = cnf.get('Dinstall::UnprivUser') or None
463 cmd.extend(['sudo', '-H', '-u', user])
469 cmd.extend(['lintian', '--show-overrides', '--color', color])
471 return do_command(' '.join(cmd), filename, escaped=True)
473 def get_copyright (deb_filename):
476 package = re_package.sub(r'\1', os.path.basename(deb_filename))
477 o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
478 cright = o.read()[:-1]
481 return formatted_text("WARNING: No copyright found, please check package manually.")
483 doc_directory = re_doc_directory.sub(r'\1', cright)
484 if package != doc_directory:
485 return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
487 o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
489 copyrightmd5 = md5.md5(cright).hexdigest()
492 if printed.copyrights.has_key(copyrightmd5) and printed.copyrights[copyrightmd5] != "%s (%s)" % (package, os.path.basename(deb_filename)):
493 res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
494 (printed.copyrights[copyrightmd5]))
496 printed.copyrights[copyrightmd5] = "%s (%s)" % (package, os.path.basename(deb_filename))
497 return res+formatted_text(cright)
499 def get_readme_source (dsc_filename):
500 tempdir = utils.temp_dirname()
503 cmd = "dpkg-source --no-check --no-copy -x %s %s" % (dsc_filename, tempdir)
504 (result, output) = commands.getstatusoutput(cmd)
506 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"
507 res += "Error, couldn't extract source, WTF?\n"
508 res += "'dpkg-source -x' failed. return code: %s.\n\n" % (result)
512 path = os.path.join(tempdir, 'debian/README.source')
514 if os.path.exists(path):
515 res += do_command("cat", path)
517 res += "No README.source in this package\n\n"
520 shutil.rmtree(tempdir)
522 if errno.errorcode[e.errno] != 'EACCES':
523 res += "%s: couldn't remove tmp dir %s for source tree." % (dsc_filename, tempdir)
527 def check_dsc (suite, dsc_filename, session = None):
528 dsc = read_changes_or_dsc(suite, dsc_filename, session)
529 dsc_basename = os.path.basename(dsc_filename)
530 return foldable_output(dsc_filename, "dsc", dsc, norow=True) + \
532 foldable_output("lintian check for %s" % dsc_basename,
533 "source-lintian", do_lintian(dsc_filename)) + \
535 foldable_output("README.source for %s" % dsc_basename,
536 "source-readmesource", get_readme_source(dsc_filename))
538 def check_deb (suite, deb_filename, session = None):
539 filename = os.path.basename(deb_filename)
540 packagename = filename.split('_')[0]
542 if filename.endswith(".udeb"):
547 result = foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
548 output_deb_info(suite, deb_filename, packagename, session), norow=True) + "\n"
551 result += foldable_output("skipping lintian check for udeb",
552 "binary-%s-lintian"%packagename, "") + "\n"
554 result += foldable_output("lintian check for %s" % (filename),
555 "binary-%s-lintian"%packagename, do_lintian(deb_filename)) + "\n"
557 result += foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
558 do_command("dpkg -c", deb_filename)) + "\n"
561 result += foldable_output("skipping copyright for udeb",
562 "binary-%s-copyright"%packagename, "") + "\n"
564 result += foldable_output("copyright of %s" % (filename),
565 "binary-%s-copyright"%packagename, get_copyright(deb_filename)) + "\n"
569 # Read a file, strip the signature and return the modified contents as
571 def strip_pgp_signature (filename):
572 with utils.open_file(filename) as f:
574 signedfile = SignedFile(data, keyrings=(), require_signature=False)
575 return signedfile.contents
577 def display_changes(suite, changes_filename):
579 changes = read_changes_or_dsc(suite, changes_filename)
580 printed.copyrights = {}
581 return foldable_output(changes_filename, "changes", changes, norow=True)
583 def check_changes (changes_filename):
585 changes = utils.parse_changes (changes_filename)
586 except ChangesUnicodeError:
587 utils.warn("Encoding problem with changes file %s" % (changes_filename))
588 print display_changes(changes['distribution'], changes_filename)
590 files = utils.build_file_list(changes)
591 for f in files.keys():
592 if f.endswith(".deb") or f.endswith(".udeb"):
593 print check_deb(changes['distribution'], f)
594 if f.endswith(".dsc"):
595 print check_dsc(changes['distribution'], f)
599 global Cnf, db_files, waste, excluded
601 # Cnf = utils.get_conf()
603 Arguments = [('h',"help","Examine-Package::Options::Help"),
604 ('H',"html-output","Examine-Package::Options::Html-Output"),
606 for i in [ "Help", "Html-Output", "partial-html" ]:
607 if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
608 Cnf["Examine-Package::Options::%s" % (i)] = ""
610 args = apt_pkg.parse_commandline(Cnf,Arguments,sys.argv)
611 Options = Cnf.subtree("Examine-Package::Options")
616 if Options["Html-Output"]:
620 stdout_fd = sys.stdout
624 if not Options["Html-Output"]:
625 # Pipe output for each argument through less
626 less_fd = os.popen("less -R -", 'w', 0)
627 # -R added to display raw control chars for colour
630 if f.endswith(".changes"):
632 elif f.endswith(".deb") or f.endswith(".udeb"):
633 # default to unstable when we don't have a .changes file
634 # perhaps this should be a command line option?
635 print check_deb('unstable', f)
636 elif f.endswith(".dsc"):
637 print check_dsc('unstable', f)
639 utils.fubar("Unrecognised file type: '%s'." % (f))
641 print output_package_relations()
642 if not Options["Html-Output"]:
643 # Reset stdout here so future less invocations aren't FUBAR
645 sys.stdout = stdout_fd
647 if errno.errorcode[e.errno] == 'EPIPE':
648 utils.warn("[examine-package] Caught EPIPE; skipping.")
652 except KeyboardInterrupt:
653 utils.warn("[examine-package] Caught C-c; skipping.")
656 #######################################################################################
658 if __name__ == '__main__':