X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=dak%2Fexamine_package.py;h=626b9327c39fab2cfb9dd45eeed599bb8f4e5db9;hb=281403d6d387e3adad068ece921af17f507d0f0c;hp=9cf3d282e1bda3064d97b44347fad759cbe7b3d8;hpb=e4c57fa70ce986b1fce91a9c9aa5838abfebe72b;p=dak.git diff --git a/dak/examine_package.py b/dak/examine_package.py index 9cf3d282..626b9327 100755 --- a/dak/examine_package.py +++ b/dak/examine_package.py @@ -34,7 +34,7 @@ import errno, os, pg, re, sys, md5 import apt_pkg, apt_inst -import daklib.database, daklib.utils +import daklib.database, daklib.utils, daklib.queue ################################################################################ @@ -54,24 +54,8 @@ re_version = re.compile('^(.*)\((.*)\)') re_newlinespace = re.compile('\n') re_spacestrip = re.compile('(\s)') -################################################################################ - -# Colour definitions - -# Main -main_colour = "\033[36m" -# Contrib -contrib_colour = "\033[33m" -# Non-Free -nonfree_colour = "\033[31m" -# Arch -arch_colour = "\033[32m" -# End -end_colour = "\033[0m" -# Bold -bold_colour = "\033[1m" -# Bad maintainer -maintainer_colour = arch_colour +html_escaping = {'"':'"', '&':'&', '<':'<', '>':'>'} +re_html_escaping = re.compile('|'.join(map(re.escape, html_escaping.keys()))) ################################################################################ @@ -84,6 +68,9 @@ daklib.database.init(Cnf, projectB) printed_copyrights = {} +# default is to not output html. +use_html = 0 + ################################################################################ def usage (exit_code=0): @@ -91,11 +78,104 @@ def usage (exit_code=0): Check NEW package(s). -h, --help show this help and exit + -H, --html-output output html page with inspection result + -f, --file-name filename for the html page PACKAGE can be a .changes, .dsc, .deb or .udeb filename.""" sys.exit(exit_code) +################################################################################ +# probably xml.sax.saxutils would work as well + +def html_escape(s): + return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s) + +def escape_if_needed(s): + if use_html: + return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s) + else: + return s + +def headline(s, level=2, bodyelement=None): + if use_html: + if bodyelement: + print """ + %(title)s + """%{"bodyelement":bodyelement,"title":html_escape(s)} + else: + print "%s" % (level, html_escape(s), level) + else: + print "---- %s ----" % (s) + +# Colour definitions, 'end' isn't really for use + +ansi_colours = { + 'main': "\033[36m", + 'contrib': "\033[33m", + 'nonfree': "\033[31m", + 'arch': "\033[32m", + 'end': "\033[0m", + 'bold': "\033[1m", + 'maintainer': "\033[32m"} + +html_colours = { + 'main': ('',""), + 'contrib': ('',""), + 'nonfree': ('',""), + 'arch': ('',""), + 'bold': ('',""), + 'maintainer': ('',"")} + +def colour_output(s, colour): + if use_html: + return ("%s%s%s" % (html_colours[colour][0], html_escape(s), html_colours[colour][1])) + else: + return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end'])) + +def escaped_text(s, strip=False): + if use_html: + if strip: + s = s.strip() + return "
%s
" % (s) + else: + return s + +def formatted_text(s, strip=False): + if use_html: + if strip: + s = s.strip() + return "
%s
" % (html_escape(s)) + else: + return s + +def output_row(s): + if use_html: + return """"""+s+"""""" + else: + return s + +def format_field(k,v): + if use_html: + return """%s:%s"""%(k,v) + else: + return "%s: %s"%(k,v) + +def foldable_output(title, elementnameprefix, content, norow=False): + d = {'elementnameprefix':elementnameprefix} + if use_html: + print """
+ """%d + headline(title, bodyelement="%(elementnameprefix)s-body"%d) + if use_html: + print """ """%d + if norow: + print content + else: + print output_row(content) + if use_html: + print """
""" + ################################################################################ def get_depends_parts(depend) : @@ -150,8 +230,9 @@ def read_control (filename): extracts = apt_inst.debExtractControl(deb_file) control = apt_pkg.ParseSection(extracts) except: - print "can't parse control info" - control = '' + print formatted_text("can't parse control info") + deb_file.close() + raise deb_file.close() @@ -173,52 +254,62 @@ def read_control (filename): nf_match = re_nonfree.search(section_str) if c_match : # contrib colour - section = contrib_colour + section_str + end_colour + section = colour_output(section_str, 'contrib') elif nf_match : # non-free colour - section = nonfree_colour + section_str + end_colour + section = colour_output(section_str, 'nonfree') else : # main - section = main_colour + section_str + end_colour + section = colour_output(section_str, 'main') if control.has_key("Architecture"): arch_str = control.Find("Architecture") - arch = arch_colour + arch_str + end_colour + arch = colour_output(arch_str, 'arch') if control.has_key("Maintainer"): maintainer = control.Find("Maintainer") localhost = re_localhost.search(maintainer) if localhost: #highlight bad email - maintainer = maintainer_colour + maintainer + end_colour + maintainer = colour_output(maintainer, 'maintainer') + else: + maintainer = escape_if_needed(maintainer) return (control, control_keys, section, depends, recommends, arch, maintainer) -def read_dsc (dsc_filename): +def read_changes_or_dsc (filename): dsc = {} - dsc_file = daklib.utils.open_file(dsc_filename) + dsc_file = daklib.utils.open_file(filename) try: - dsc = daklib.utils.parse_changes(dsc_filename) + dsc = daklib.utils.parse_changes(filename) except: - print "can't parse control info" + return formatted_text("can't parse .dsc control info") dsc_file.close() - filecontents = strip_pgp_signature(dsc_filename) - - if dsc.has_key("build-depends"): - builddep = split_depends(dsc["build-depends"]) - builddepstr = create_depends_string(builddep) - filecontents = re_builddep.sub("Build-Depends: "+builddepstr, filecontents) - - if dsc.has_key("build-depends-indep"): - builddepindstr = create_depends_string(split_depends(dsc["build-depends-indep"])) - filecontents = re_builddepind.sub("Build-Depends-Indep: "+builddepindstr, filecontents) + filecontents = strip_pgp_signature(filename) + keysinorder = [] + for l in filecontents.split('\n'): + m = re.match(r'([-a-zA-Z0-9]*):', l) + if m: + keysinorder.append(m.group(1)) + + for k in dsc.keys(): + if k in ("build-depends","build-depends-indep"): + dsc[k] = create_depends_string(split_depends(dsc[k])) + elif k == "architecture": + if (dsc["architecture"] != "any"): + dsc['architecture'] = colour_output(dsc["architecture"], 'arch') + elif k in ("files","changes","description"): + if use_html: + dsc[k] = formatted_text(dsc[k], strip=True) + else: + dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip() + else: + dsc[k] = escape_if_needed(dsc[k]) - if dsc.has_key("architecture") : - if (dsc["architecture"] != "any"): - newarch = arch_colour + dsc["architecture"] + end_colour - filecontents = re_arch.sub("Architecture: " + newarch, filecontents) + keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder) + filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n' return filecontents def create_depends_string (depends_tree): @@ -240,21 +331,21 @@ def create_depends_string (depends_tree): if ql: i = ql[0] + adepends = d['name'] + if d['version'] != '' : + adepends += " (%s)" % (d['version']) + if i[2] == "contrib": - result += contrib_colour + d['name'] + result += colour_output(adepends, "contrib") elif i[2] == "non-free": - result += nonfree_colour + d['name'] + result += colour_output(adepends, "nonfree") else : - result += main_colour + d['name'] - - if d['version'] != '' : - result += " (%s)" % (d['version']) - result += end_colour + result += colour_output(adepends, "main") else: - result += bold_colour + d['name'] + adepends = d['name'] if d['version'] != '' : - result += " (%s)" % (d['version']) - result += end_colour + adepends += " (%s)" % (d['version']) + result += colour_output(adepends, "bold") or_count += 1 comma_count += 1 return result @@ -263,97 +354,102 @@ def output_deb_info(filename): (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename) if control == '': - print "no control info" + return formatted_text("no control info") + to_print = "" + for key in control_keys : + if key == 'Depends': + field_value = create_depends_string(depends) + elif key == 'Recommends': + field_value = create_depends_string(recommends) + elif key == 'Section': + field_value = section + elif key == 'Architecture': + field_value = arch + elif key == 'Maintainer': + field_value = maintainer + elif key == 'Description': + desc = control.Find(key) + desc = re_newlinespace.sub('\n ', desc) + field_value = escape_if_needed(desc) + else: + field_value = escape_if_needed(control.Find(key)) + to_print += " "+format_field(key,field_value)+'\n' + return to_print + +def do_command (command, filename, escaped=0): + o = os.popen("%s %s" % (command, filename)) + if escaped: + return escaped_text(o.read()) else: - for key in control_keys : - output = " " + key + ": " - if key == 'Depends': - output += create_depends_string(depends) - elif key == 'Recommends': - output += create_depends_string(recommends) - elif key == 'Section': - output += section - elif key == 'Architecture': - output += arch - elif key == 'Maintainer': - output += maintainer - elif key == 'Description': - desc = control.Find(key) - desc = re_newlinespace.sub('\n ', desc) - output += desc - else: - output += control.Find(key) - print output + return formatted_text(o.read()) -def do_command (command, filename): - o = os.popen("%s %s" % (command, filename)) - print o.read() +def do_lintian (filename): + if use_html: + return do_command("lintian --show-overrides --color html", filename, 1) + else: + return do_command("lintian --show-overrides --color always", filename, 1) -def print_copyright (deb_filename): +def get_copyright (deb_filename): package = re_package.sub(r'\1', deb_filename) o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename)) copyright = o.read()[:-1] if copyright == "": - print "WARNING: No copyright found, please check package manually." - return + return formatted_text("WARNING: No copyright found, please check package manually.") doc_directory = re_doc_directory.sub(r'\1', copyright) if package != doc_directory: - print "WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory) - return + return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory)) - o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s" % (deb_filename, copyright)) + o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, copyright)) copyright = o.read() copyrightmd5 = md5.md5(copyright).hexdigest() + res = "" if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename): - print "NOTE: Copyright is the same as %s.\n" % \ - (printed_copyrights[copyrightmd5]) + res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \ + (printed_copyrights[copyrightmd5])) else: printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename) - - print copyright + return res+formatted_text(copyright) def check_dsc (dsc_filename): - print "---- .dsc file for %s ----" % (dsc_filename) - (dsc) = read_dsc(dsc_filename) - print dsc - print "---- lintian check for %s ----" % (dsc_filename) - do_command("lintian --show-overrides --color always", dsc_filename) + (dsc) = read_changes_or_dsc(dsc_filename) + foldable_output(dsc_filename, "dsc", dsc, norow=True) + foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename)) def check_deb (deb_filename): filename = os.path.basename(deb_filename) + packagename = filename.split('_')[0] if filename.endswith(".udeb"): is_a_udeb = 1 else: is_a_udeb = 0 - print "---- control file for %s ----" % (filename) - #do_command ("dpkg -I", deb_filename) - output_deb_info(deb_filename) + + foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename, + output_deb_info(deb_filename), norow=True) if is_a_udeb: - print "---- skipping lintian check for udeb ----" - print + foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename, + "") else: - print "---- lintian check for %s ----" % (filename) - do_command ("lintian --show-overrides --color always", deb_filename) - print "---- linda check for %s ----" % (filename) - do_command ("linda", deb_filename) + foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename, + do_lintian(deb_filename)) - print "---- contents of %s ----" % (filename) - do_command ("dpkg -c", deb_filename) + foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename, + do_command("dpkg -c", deb_filename)) if is_a_udeb: - print "---- skipping copyright for udeb ----" + foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename, + "") else: - print "---- copyright of %s ----" % (filename) - print_copyright(deb_filename) + foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename, + get_copyright(deb_filename)) - print "---- file listing of %s ----" % (filename) - do_command ("ls -l", deb_filename) + foldable_output("file listing of %s" % (filename), "binary-%s-file-listing"%packagename, + do_command("ls -l", deb_filename)) # Read a file, strip the signature and return the modified contents as # a string. @@ -383,10 +479,9 @@ def strip_pgp_signature (filename): file.close() return contents -# Display the .changes [without the signature] -def display_changes (changes_filename): - print "---- .changes file for %s ----" % (changes_filename) - print strip_pgp_signature(changes_filename) +def display_changes(changes_filename): + changes = read_changes_or_dsc(changes_filename) + foldable_output(changes_filename, "changes", changes, norow=True) def check_changes (changes_filename): display_changes(changes_filename) @@ -405,9 +500,11 @@ def main (): # Cnf = daklib.utils.get_conf() - Arguments = [('h',"help","Examine-Package::Options::Help")] - for i in [ "help" ]: - if not Cnf.has_key("Frenanda::Options::%s" % (i)): + Arguments = [('h',"help","Examine-Package::Options::Help"), + ('H',"html-output","Examine-Package::Options::Html-Output"), + ] + for i in [ "Help", "Html-Output", "partial-html" ]: + if not Cnf.has_key("Examine-Package::Options::%s" % (i)): Cnf["Examine-Package::Options::%s" % (i)] = "" args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv) @@ -420,11 +517,11 @@ def main (): for file in args: try: - # Pipe output for each argument through less - less_fd = os.popen("less -R -", 'w', 0) - # -R added to display raw control chars for colour - sys.stdout = less_fd - + if not Options["Html-Output"]: + # Pipe output for each argument through less + less_fd = os.popen("less -R -", 'w', 0) + # -R added to display raw control chars for colour + sys.stdout = less_fd try: if file.endswith(".changes"): check_changes(file) @@ -435,9 +532,10 @@ def main (): else: daklib.utils.fubar("Unrecognised file type: '%s'." % (file)) finally: - # Reset stdout here so future less invocations aren't FUBAR - less_fd.close() - sys.stdout = stdout_fd + if not Options["Html-Output"]: + # Reset stdout here so future less invocations aren't FUBAR + less_fd.close() + sys.stdout = stdout_fd except IOError, e: if errno.errorcode[e.errno] == 'EPIPE': daklib.utils.warn("[examine-package] Caught EPIPE; skipping.")