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.dbconn import DBConn, get_component_by_package_suite
64 from daklib.regexes import html_escaping, re_html_escaping, re_version, re_spacestrip, \
65 re_contrib, re_nonfree, re_localhost, re_newlinespace, \
66 re_package, re_doc_directory
68 ################################################################################
71 Cnf = utils.get_conf()
73 printed = threading.local()
74 printed.copyrights = {}
75 package_relations = {} #: Store relations of packages for later output
77 # default is to not output html.
80 ################################################################################
82 def usage (exit_code=0):
83 print """Usage: dak examine-package [PACKAGE]...
86 -h, --help show this help and exit
87 -H, --html-output output html page with inspection result
88 -f, --file-name filename for the html page
90 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
94 ################################################################################
95 # probably xml.sax.saxutils would work as well
97 def escape_if_needed(s):
99 return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
103 def headline(s, level=2, bodyelement=None):
107 <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>
108 </thead>\n"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
110 return "<h%d>%s</h%d>\n" % (level, utils.html_escape(s), level)
112 return "---- %s ----\n" % (s)
114 # Colour definitions, 'end' isn't really for use
118 'contrib': "\033[33m",
119 'nonfree': "\033[31m",
123 'maintainer': "\033[32m",
124 'distro': "\033[1m\033[41m"}
127 'main': ('<span style="color: aqua">',"</span>"),
128 'contrib': ('<span style="color: yellow">',"</span>"),
129 'nonfree': ('<span style="color: red">',"</span>"),
130 'arch': ('<span style="color: green">',"</span>"),
131 'bold': ('<span style="font-weight: bold">',"</span>"),
132 'maintainer': ('<span style="color: green">',"</span>"),
133 'distro': ('<span style="font-weight: bold; background-color: red">',"</span>")}
135 def colour_output(s, colour):
137 return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
139 return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
141 def escaped_text(s, strip=False):
145 return "<pre>%s</pre>" % (s)
149 def formatted_text(s, strip=False):
153 return "<pre>%s</pre>" % (utils.html_escape(s))
159 return """<tr><td>"""+s+"""</td></tr>"""
163 def format_field(k,v):
165 return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
167 return "%s: %s"%(k,v)
169 def foldable_output(title, elementnameprefix, content, norow=False):
170 d = {'elementnameprefix':elementnameprefix}
173 result += """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
174 <table class="infobox rfc822">\n"""%d
175 result += headline(title, bodyelement="%(elementnameprefix)s-body"%d)
177 result += """ <tbody id="%(elementnameprefix)s-body" class="infobody">\n"""%d
179 result += content + "\n"
181 result += output_row(content) + "\n"
183 result += """</tbody></table></div>"""
186 ################################################################################
188 def get_depends_parts(depend) :
189 v_match = re_version.match(depend)
191 d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
193 d_parts = { 'name' : depend , 'version' : '' }
196 def get_or_list(depend) :
197 or_list = depend.split("|")
200 def get_comma_list(depend) :
201 dep_list = depend.split(",")
204 def split_depends (d_str) :
205 # creates a list of lists of dictionaries of depends (package,version relation)
207 d_str = re_spacestrip.sub('',d_str)
209 # first split depends string up amongs comma delimiter
210 dep_list = get_comma_list(d_str)
212 while d < len(dep_list):
213 # put depends into their own list
214 depends_tree.append([dep_list[d]])
217 while d < len(depends_tree):
219 # split up Or'd depends into a multi-item list
220 depends_tree[d] = get_or_list(depends_tree[d][0])
221 while k < len(depends_tree[d]):
222 # split depends into {package, version relation}
223 depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
228 def read_control (filename):
235 deb_file = utils.open_file(filename)
237 extracts = apt_inst.debExtractControl(deb_file)
238 control = apt_pkg.ParseSection(extracts)
240 print formatted_text("can't parse control info")
246 control_keys = control.keys()
248 if control.has_key("Depends"):
249 depends_str = control.Find("Depends")
250 # create list of dependancy lists
251 depends = split_depends(depends_str)
253 if control.has_key("Recommends"):
254 recommends_str = control.Find("Recommends")
255 recommends = split_depends(recommends_str)
257 if control.has_key("Section"):
258 section_str = control.Find("Section")
260 c_match = re_contrib.search(section_str)
261 nf_match = re_nonfree.search(section_str)
264 section = colour_output(section_str, 'contrib')
267 section = colour_output(section_str, 'nonfree')
270 section = colour_output(section_str, 'main')
271 if control.has_key("Architecture"):
272 arch_str = control.Find("Architecture")
273 arch = colour_output(arch_str, 'arch')
275 if control.has_key("Maintainer"):
276 maintainer = control.Find("Maintainer")
277 localhost = re_localhost.search(maintainer)
280 maintainer = colour_output(maintainer, 'maintainer')
282 maintainer = escape_if_needed(maintainer)
284 return (control, control_keys, section, depends, recommends, arch, maintainer)
286 def read_changes_or_dsc (suite, filename, session = None):
289 dsc_file = utils.open_file(filename)
291 dsc = utils.parse_changes(filename, dsc_file=1)
293 return formatted_text("can't parse .dsc control info")
296 filecontents = strip_pgp_signature(filename)
298 for l in filecontents.split('\n'):
299 m = re.match(r'([-a-zA-Z0-9]*):', l)
301 keysinorder.append(m.group(1))
304 if k in ("build-depends","build-depends-indep"):
305 dsc[k] = create_depends_string(suite, split_depends(dsc[k]), session)
306 elif k == "architecture":
307 if (dsc["architecture"] != "any"):
308 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
309 elif k == "distribution":
310 if dsc["distribution"] not in ('unstable', 'experimental'):
311 dsc['distribution'] = colour_output(dsc["distribution"], 'distro')
312 elif k in ("files","changes","description"):
314 dsc[k] = formatted_text(dsc[k], strip=True)
316 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
318 dsc[k] = escape_if_needed(dsc[k])
320 keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
322 filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
325 def create_depends_string (suite, depends_tree, session = None):
327 if suite == 'experimental':
328 suite_list = ['experimental','unstable']
333 for l in depends_tree:
334 if (comma_count >= 2):
340 # doesn't do version lookup yet.
342 component = get_component_by_package_suite(d['name'], suite_list, session)
343 if component is not None:
345 if d['version'] != '' :
346 adepends += " (%s)" % (d['version'])
348 if component == "contrib":
349 result += colour_output(adepends, "contrib")
350 elif component == "non-free":
351 result += colour_output(adepends, "nonfree")
353 result += colour_output(adepends, "main")
356 if d['version'] != '' :
357 adepends += " (%s)" % (d['version'])
358 result += colour_output(adepends, "bold")
363 def output_package_relations ():
365 Output the package relations, if there is more than one package checked in this run.
368 if len(package_relations) < 2:
369 # Only list something if we have more than one binary to compare
370 package_relations.clear()
374 for package in package_relations:
375 for relation in package_relations[package]:
376 to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
378 package_relations.clear()
379 return foldable_output("Package relations", "relations", to_print)
381 def output_deb_info(suite, filename, packagename, session = None):
382 (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
385 return formatted_text("no control info")
387 if not package_relations.has_key(packagename):
388 package_relations[packagename] = {}
389 for key in control_keys :
391 field_value = create_depends_string(suite, depends, session)
392 package_relations[packagename][key] = field_value
393 elif key == 'Recommends':
394 field_value = create_depends_string(suite, recommends, session)
395 package_relations[packagename][key] = field_value
396 elif key == 'Section':
397 field_value = section
398 elif key == 'Architecture':
400 elif key == 'Maintainer':
401 field_value = maintainer
402 elif key == 'Description':
404 field_value = formatted_text(control.Find(key), strip=True)
406 desc = control.Find(key)
407 desc = re_newlinespace.sub('\n ', desc)
408 field_value = escape_if_needed(desc)
410 field_value = escape_if_needed(control.Find(key))
411 to_print += " "+format_field(key,field_value)+'\n'
414 def do_command (command, filename, escaped=0):
415 o = os.popen("%s %s" % (command, filename))
417 return escaped_text(o.read())
419 return formatted_text(o.read())
421 def do_lintian (filename):
423 return do_command("lintian --show-overrides --color html", filename, 1)
425 return do_command("lintian --show-overrides --color always", filename, 1)
427 def get_copyright (deb_filename):
430 package = re_package.sub(r'\1', deb_filename)
431 o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
432 cright = o.read()[:-1]
435 return formatted_text("WARNING: No copyright found, please check package manually.")
437 doc_directory = re_doc_directory.sub(r'\1', cright)
438 if package != doc_directory:
439 return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
441 o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
443 copyrightmd5 = md5.md5(cright).hexdigest()
446 if printed.copyrights.has_key(copyrightmd5) and printed.copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
447 res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
448 (printed.copyrights[copyrightmd5]))
450 printed.copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
451 return res+formatted_text(cright)
453 def get_readme_source (dsc_filename):
454 tempdir = utils.temp_dirname()
457 cmd = "dpkg-source --no-check --no-copy -x %s %s" % (dsc_filename, tempdir)
458 (result, output) = commands.getstatusoutput(cmd)
460 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"
461 res += "Error, couldn't extract source, WTF?\n"
462 res += "'dpkg-source -x' failed. return code: %s.\n\n" % (result)
466 path = os.path.join(tempdir, 'debian/README.source')
468 if os.path.exists(path):
469 res += do_command("cat", path)
471 res += "No README.source in this package\n\n"
474 shutil.rmtree(tempdir)
476 if errno.errorcode[e.errno] != 'EACCES':
477 res += "%s: couldn't remove tmp dir %s for source tree." % (dsc_filename, tempdir)
481 def check_dsc (suite, dsc_filename, session = None):
482 (dsc) = read_changes_or_dsc(suite, dsc_filename, session)
483 return foldable_output(dsc_filename, "dsc", dsc, norow=True) + \
485 foldable_output("lintian check for %s" % dsc_filename,
486 "source-lintian", do_lintian(dsc_filename)) + \
488 foldable_output("README.source for %s" % dsc_filename,
489 "source-readmesource", get_readme_source(dsc_filename))
491 def check_deb (suite, deb_filename, session = None):
492 filename = os.path.basename(deb_filename)
493 packagename = filename.split('_')[0]
495 if filename.endswith(".udeb"):
500 result = foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
501 output_deb_info(suite, deb_filename, packagename, session), norow=True) + "\n"
504 result += foldable_output("skipping lintian check for udeb",
505 "binary-%s-lintian"%packagename, "") + "\n"
507 result += foldable_output("lintian check for %s" % (filename),
508 "binary-%s-lintian"%packagename, do_lintian(deb_filename)) + "\n"
510 result += foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
511 do_command("dpkg -c", deb_filename)) + "\n"
514 result += foldable_output("skipping copyright for udeb",
515 "binary-%s-copyright"%packagename, "") + "\n"
517 result += foldable_output("copyright of %s" % (filename),
518 "binary-%s-copyright"%packagename, get_copyright(deb_filename)) + "\n"
520 result += foldable_output("file listing of %s" % (filename),
521 "binary-%s-file-listing"%packagename, do_command("ls -l", deb_filename))
525 # Read a file, strip the signature and return the modified contents as
527 def strip_pgp_signature (filename):
528 inputfile = utils.open_file (filename)
532 for line in inputfile.readlines():
540 if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
543 if line.startswith("-----BEGIN PGP SIGNATURE"):
546 if line.startswith("-----END PGP SIGNATURE"):
553 def display_changes(suite, changes_filename):
555 changes = read_changes_or_dsc(suite, changes_filename)
556 printed.copyrights = {}
557 return foldable_output(changes_filename, "changes", changes, norow=True)
559 def check_changes (changes_filename):
561 changes = utils.parse_changes (changes_filename)
562 except ChangesUnicodeError:
563 utils.warn("Encoding problem with changes file %s" % (changes_filename))
564 print display_changes(changes['distribution'], changes_filename)
566 files = utils.build_file_list(changes)
567 for f in files.keys():
568 if f.endswith(".deb") or f.endswith(".udeb"):
569 print check_deb(changes['distribution'], f)
570 if f.endswith(".dsc"):
571 print check_dsc(changes['distribution'], f)
575 global Cnf, db_files, waste, excluded
577 # Cnf = utils.get_conf()
579 Arguments = [('h',"help","Examine-Package::Options::Help"),
580 ('H',"html-output","Examine-Package::Options::Html-Output"),
582 for i in [ "Help", "Html-Output", "partial-html" ]:
583 if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
584 Cnf["Examine-Package::Options::%s" % (i)] = ""
586 args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
587 Options = Cnf.SubTree("Examine-Package::Options")
592 if Options["Html-Output"]:
596 stdout_fd = sys.stdout
600 if not Options["Html-Output"]:
601 # Pipe output for each argument through less
602 less_fd = os.popen("less -R -", 'w', 0)
603 # -R added to display raw control chars for colour
606 if f.endswith(".changes"):
608 elif f.endswith(".deb") or f.endswith(".udeb"):
609 # default to unstable when we don't have a .changes file
610 # perhaps this should be a command line option?
611 print check_deb('unstable', f)
612 elif f.endswith(".dsc"):
613 print check_dsc('unstable', f)
615 utils.fubar("Unrecognised file type: '%s'." % (f))
617 print output_package_relations()
618 if not Options["Html-Output"]:
619 # Reset stdout here so future less invocations aren't FUBAR
621 sys.stdout = stdout_fd
623 if errno.errorcode[e.errno] == 'EPIPE':
624 utils.warn("[examine-package] Caught EPIPE; skipping.")
628 except KeyboardInterrupt:
629 utils.warn("[examine-package] Caught C-c; skipping.")
632 #######################################################################################
634 if __name__ == '__main__':