]> git.decadent.org.uk Git - dak.git/blobdiff - dak/examine_package.py
finish exterior css'ing
[dak.git] / dak / examine_package.py
index c1de75763af6e4d9147d384cc68ed2817205eb7d..31549e11099c4a98aaa1cf6d81f3f940e25fcbdf 100755 (executable)
@@ -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 = {'"':'&quot;', '&':'&amp;', '<':'&lt;', '>':'&gt;'}
+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,91 @@ 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(html_escaping.get, s)
+  else:
+    return s
+  
+def headline(s, level=2, bodyelement=None):
+  if use_html:
+    if bodyelement:
+      print """<thead>
+          <tr><th colspan="2" class="title" onclick="toggle('%(bodyelement)s', 'table-row-group', 'table-row-group')">%(title)s</th></tr>
+        </thead>"""%{"bodyelement":bodyelement,"title":html_escape(s)}
+    else:
+      print "<h%d>%s</h%d>" % (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': ('<span style="color: aqua">',"</span>"),
+  'contrib': ('<span style="color: yellow">',"</span>"),
+  'nonfree': ('<span style="color: red">',"</span>"),
+  'arch': ('<span style="color: green">',"</span>"),
+  'bold': ('<span style="font-weight: bold">',"</span>"),
+  'maintainer': ('<span style="color: green">',"</span>")}
+
+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):
+  if use_html:
+    return "<pre>%s</pre>" % (s)
+  else:
+    return s  
+
+def formatted_text(s):
+  if use_html:
+    return "<pre>%s</pre>" % (html_escape(s))
+  else:
+    return s
+
+def output_row(s):
+    if use_html:
+        return """<tr><td>"""+s+"""</td></tr>"""
+    else:
+        return s
+
+def foldable_output(title, elementnameprefix, content):
+    d = {'elementnameprefix':elementnameprefix}
+    if use_html:
+        print """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
+                   <table class="infobox rfc822">"""%d
+    headline(title, bodyelement="%(elementnameprefix)s-body"%d)
+    if use_html:
+        print """    <tbody id="%(elementnameprefix)s-body" class="infobody">"""%d
+    print output_row(content)
+    if use_html:
+        print """</tbody></table></div>"""
+
 ################################################################################
 
 def get_depends_parts(depend) :
@@ -150,7 +217,8 @@ def read_control (filename):
        extracts = apt_inst.debExtractControl(deb_file)
        control = apt_pkg.ParseSection(extracts)
     except:
-       print "can't parse control info"
+       print formatted_text("can't parse control info")
+       # TV-COMMENT: this will raise exceptions in two lines
        control = ''
 
     deb_file.close()
@@ -173,23 +241,25 @@ 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)
 
@@ -200,10 +270,10 @@ def read_dsc (dsc_filename):
     try:
        dsc = daklib.utils.parse_changes(dsc_filename)
     except:
-       print "can't parse control info"
+       return formatted_text("can't parse control info")
     dsc_file.close()
 
-    filecontents = strip_pgp_signature(dsc_filename)
+    filecontents = escape_if_needed(strip_pgp_signature(dsc_filename))
 
     if dsc.has_key("build-depends"):
        builddep = split_depends(dsc["build-depends"])
@@ -216,7 +286,7 @@ def read_dsc (dsc_filename):
 
     if dsc.has_key("architecture") :
        if (dsc["architecture"] != "any"):
-           newarch = arch_colour + dsc["architecture"] + end_colour
+           newarch = colour_output(dsc["architecture"], 'arch')
            filecontents = re_arch.sub("Architecture: " + newarch, filecontents)
 
     return filecontents
@@ -240,21 +310,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,95 +333,103 @@ 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 :
+        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 += escape_if_needed(desc)
+        else:
+            output += escape_if_needed(control.Find(key))
+        to_print += output + '\n'
+    return escaped_text(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("ar p %s data.tar.gz | tar tzvf - | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{ print $6 }' | head -n 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("ar p %s data.tar.gz | tar xzOf - %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" % \
+                               (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
+    foldable_output(dsc_filename, "dsc", escaped_text(dsc))
+    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))
 
     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.
@@ -382,9 +460,9 @@ def strip_pgp_signature (filename):
     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)
+# TV-COMMENT: M. Ferrari has more formatting ideas
+def display_changes(changes_filename):
+    foldable_output(changes_filename, "changes", formatted_text(strip_pgp_signature(changes_filename)))
 
 def check_changes (changes_filename):
     display_changes(changes_filename)
@@ -403,9 +481,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)
@@ -418,11 +498,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)
@@ -433,9 +513,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.")