]> git.decadent.org.uk Git - dak.git/blob - dak/examine_package.py
Merge remote branch 'drkranz/examine-package' into merge
[dak.git] / dak / examine_package.py
1 #!/usr/bin/env python
2
3 """
4 Script to automate some parts of checking NEW packages
5
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.
9
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
14 """
15
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.
20
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.
25
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
29
30 ################################################################################
31
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,
41 #      right? :)
42
43 ################################################################################
44
45 # suppress some deprecation warnings in squeeze related to md5 module
46 import warnings
47 warnings.filterwarnings('ignore', \
48     "the md5 module is deprecated; use hashlib instead", \
49     DeprecationWarning)
50
51 import errno
52 import os
53 import re
54 import sys
55 import md5
56 import apt_pkg
57 import apt_inst
58 import shutil
59 import commands
60 import threading
61
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
67
68 ################################################################################
69
70 Cnf = None
71 Cnf = utils.get_conf()
72
73 printed = threading.local()
74 printed.copyrights = {}
75 package_relations = {}           #: Store relations of packages for later output
76
77 # default is to not output html.
78 use_html = 0
79
80 ################################################################################
81
82 def usage (exit_code=0):
83     print """Usage: dak examine-package [PACKAGE]...
84 Check NEW package(s).
85
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
89
90 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
91
92     sys.exit(exit_code)
93
94 ################################################################################
95 # probably xml.sax.saxutils would work as well
96
97 def escape_if_needed(s):
98     if use_html:
99         return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
100     else:
101         return s
102
103 def headline(s, level=2, bodyelement=None):
104     if use_html:
105         if bodyelement:
106             return """<thead>
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)}
109         else:
110             return "<h%d>%s</h%d>\n" % (level, utils.html_escape(s), level)
111     else:
112         return "---- %s ----\n" % (s)
113
114 # Colour definitions, 'end' isn't really for use
115
116 ansi_colours = {
117   'main': "\033[36m",
118   'contrib': "\033[33m",
119   'nonfree': "\033[31m",
120   'provides': "\033[35m",
121   'arch': "\033[32m",
122   'end': "\033[0m",
123   'bold': "\033[1m",
124   'maintainer': "\033[32m",
125   'distro': "\033[1m\033[41m"}
126
127 html_colours = {
128   'main': ('<span style="color: aqua">',"</span>"),
129   'contrib': ('<span style="color: yellow">',"</span>"),
130   'nonfree': ('<span style="color: red">',"</span>"),
131   'provides': ('<span style="color: magenta">',"</span>"),
132   'arch': ('<span style="color: green">',"</span>"),
133   'bold': ('<span style="font-weight: bold">',"</span>"),
134   'maintainer': ('<span style="color: green">',"</span>"),
135   'distro': ('<span style="font-weight: bold; background-color: red">',"</span>")}
136
137 def colour_output(s, colour):
138     if use_html:
139         return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
140     else:
141         return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
142
143 def escaped_text(s, strip=False):
144     if use_html:
145         if strip:
146             s = s.strip()
147         return "<pre>%s</pre>" % (s)
148     else:
149         return s
150
151 def formatted_text(s, strip=False):
152     if use_html:
153         if strip:
154             s = s.strip()
155         return "<pre>%s</pre>" % (utils.html_escape(s))
156     else:
157         return s
158
159 def output_row(s):
160     if use_html:
161         return """<tr><td>"""+s+"""</td></tr>"""
162     else:
163         return s
164
165 def format_field(k,v):
166     if use_html:
167         return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
168     else:
169         return "%s: %s"%(k,v)
170
171 def foldable_output(title, elementnameprefix, content, norow=False):
172     d = {'elementnameprefix':elementnameprefix}
173     result = ''
174     if use_html:
175         result += """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
176                    <table class="infobox rfc822">\n"""%d
177     result += headline(title, bodyelement="%(elementnameprefix)s-body"%d)
178     if use_html:
179         result += """    <tbody id="%(elementnameprefix)s-body" class="infobody">\n"""%d
180     if norow:
181         result += content + "\n"
182     else:
183         result += output_row(content) + "\n"
184     if use_html:
185         result += """</tbody></table></div>"""
186     return result
187
188 ################################################################################
189
190 def get_depends_parts(depend) :
191     v_match = re_version.match(depend)
192     if v_match:
193         d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
194     else :
195         d_parts = { 'name' : depend , 'version' : '' }
196     return d_parts
197
198 def get_or_list(depend) :
199     or_list = depend.split("|")
200     return or_list
201
202 def get_comma_list(depend) :
203     dep_list = depend.split(",")
204     return dep_list
205
206 def split_depends (d_str) :
207     # creates a list of lists of dictionaries of depends (package,version relation)
208
209     d_str = re_spacestrip.sub('',d_str)
210     depends_tree = []
211     # first split depends string up amongs comma delimiter
212     dep_list = get_comma_list(d_str)
213     d = 0
214     while d < len(dep_list):
215         # put depends into their own list
216         depends_tree.append([dep_list[d]])
217         d += 1
218     d = 0
219     while d < len(depends_tree):
220         k = 0
221         # split up Or'd depends into a multi-item list
222         depends_tree[d] = get_or_list(depends_tree[d][0])
223         while k < len(depends_tree[d]):
224             # split depends into {package, version relation}
225             depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
226             k += 1
227         d += 1
228     return depends_tree
229
230 def read_control (filename):
231     recommends = []
232     depends = []
233     section = ''
234     maintainer = ''
235     arch = ''
236
237     deb_file = utils.open_file(filename)
238     try:
239         extracts = apt_inst.debExtractControl(deb_file)
240         control = apt_pkg.ParseSection(extracts)
241     except:
242         print formatted_text("can't parse control info")
243         deb_file.close()
244         raise
245
246     deb_file.close()
247
248     control_keys = control.keys()
249
250     if control.has_key("Depends"):
251         depends_str = control.Find("Depends")
252         # create list of dependancy lists
253         depends = split_depends(depends_str)
254
255     if control.has_key("Recommends"):
256         recommends_str = control.Find("Recommends")
257         recommends = split_depends(recommends_str)
258
259     if control.has_key("Section"):
260         section_str = control.Find("Section")
261
262         c_match = re_contrib.search(section_str)
263         nf_match = re_nonfree.search(section_str)
264         if c_match :
265             # contrib colour
266             section = colour_output(section_str, 'contrib')
267         elif nf_match :
268             # non-free colour
269             section = colour_output(section_str, 'nonfree')
270         else :
271             # main
272             section = colour_output(section_str, 'main')
273     if control.has_key("Architecture"):
274         arch_str = control.Find("Architecture")
275         arch = colour_output(arch_str, 'arch')
276
277     if control.has_key("Maintainer"):
278         maintainer = control.Find("Maintainer")
279         localhost = re_localhost.search(maintainer)
280         if localhost:
281             #highlight bad email
282             maintainer = colour_output(maintainer, 'maintainer')
283         else:
284             maintainer = escape_if_needed(maintainer)
285
286     return (control, control_keys, section, depends, recommends, arch, maintainer)
287
288 def read_changes_or_dsc (suite, filename, session = None):
289     dsc = {}
290
291     dsc_file = utils.open_file(filename)
292     try:
293         dsc = utils.parse_changes(filename, dsc_file=1)
294     except:
295         return formatted_text("can't parse .dsc control info")
296     dsc_file.close()
297
298     filecontents = strip_pgp_signature(filename)
299     keysinorder = []
300     for l in filecontents.split('\n'):
301         m = re.match(r'([-a-zA-Z0-9]*):', l)
302         if m:
303             keysinorder.append(m.group(1))
304
305     for k in dsc.keys():
306         if k in ("build-depends","build-depends-indep"):
307             dsc[k] = create_depends_string(suite, split_depends(dsc[k]), session)
308         elif k == "architecture":
309             if (dsc["architecture"] != "any"):
310                 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
311         elif k == "distribution":
312             if dsc["distribution"] not in ('unstable', 'experimental'):
313                 dsc['distribution'] = colour_output(dsc["distribution"], 'distro')
314         elif k in ("files","changes","description"):
315             if use_html:
316                 dsc[k] = formatted_text(dsc[k], strip=True)
317             else:
318                 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
319         else:
320             dsc[k] = escape_if_needed(dsc[k])
321
322     keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
323
324     filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
325     return filecontents
326
327 def get_provides(suite):
328     provides = set()
329     session = DBConn().session()
330     query = '''SELECT DISTINCT value
331                FROM binaries_metadata m
332                JOIN bin_associations b
333                ON b.bin = m.bin_id
334                WHERE key_id = (
335                  SELECT key_id
336                  FROM metadata_keys
337                  WHERE key = 'Provides' )
338                AND b.suite = (
339                  SELECT id
340                  FROM suite
341                  WHERE suite_name = '%(suite)s'
342                  OR codename = '%(suite)s')''' % \
343             {'suite': suite}
344     for p in session.execute(query):
345         for e in p:
346             for i in e.split(','):
347                 provides.add(i.strip())
348     session.close()
349     return provides
350
351 def create_depends_string (suite, depends_tree, session = None):
352     result = ""
353     if suite == 'experimental':
354         suite_list = ['experimental','unstable']
355     else:
356         suite_list = [suite]
357
358     provides = set()
359     comma_count = 1
360     for l in depends_tree:
361         if (comma_count >= 2):
362             result += ", "
363         or_count = 1
364         for d in l:
365             if (or_count >= 2 ):
366                 result += " | "
367             # doesn't do version lookup yet.
368
369             component = get_component_by_package_suite(d['name'], suite_list, \
370                 session = session)
371             if component is not None:
372                 adepends = d['name']
373                 if d['version'] != '' :
374                     adepends += " (%s)" % (d['version'])
375
376                 if component == "contrib":
377                     result += colour_output(adepends, "contrib")
378                 elif component == "non-free":
379                     result += colour_output(adepends, "nonfree")
380                 else :
381                     result += colour_output(adepends, "main")
382             else:
383                 adepends = d['name']
384                 if d['version'] != '' :
385                     adepends += " (%s)" % (d['version'])
386                 if not provides:
387                     provides = get_provides(suite)
388                 if d['name'] in provides:
389                     result += colour_output(adepends, "provides")
390                 else:
391                     result += colour_output(adepends, "bold")
392             or_count += 1
393         comma_count += 1
394     return result
395
396 def output_package_relations ():
397     """
398     Output the package relations, if there is more than one package checked in this run.
399     """
400
401     if len(package_relations) < 2:
402         # Only list something if we have more than one binary to compare
403         package_relations.clear()
404         return
405
406     to_print = ""
407     for package in package_relations:
408         for relation in package_relations[package]:
409             to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
410
411     package_relations.clear()
412     return foldable_output("Package relations", "relations", to_print)
413
414 def output_deb_info(suite, filename, packagename, session = None):
415     (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
416
417     if control == '':
418         return formatted_text("no control info")
419     to_print = ""
420     if not package_relations.has_key(packagename):
421         package_relations[packagename] = {}
422     for key in control_keys :
423         if key == 'Depends':
424             field_value = create_depends_string(suite, depends, session)
425             package_relations[packagename][key] = field_value
426         elif key == 'Recommends':
427             field_value = create_depends_string(suite, recommends, session)
428             package_relations[packagename][key] = field_value
429         elif key == 'Section':
430             field_value = section
431         elif key == 'Architecture':
432             field_value = arch
433         elif key == 'Maintainer':
434             field_value = maintainer
435         elif key == 'Description':
436             if use_html:
437                 field_value = formatted_text(control.Find(key), strip=True)
438             else:
439                 desc = control.Find(key)
440                 desc = re_newlinespace.sub('\n ', desc)
441                 field_value = escape_if_needed(desc)
442         else:
443             field_value = escape_if_needed(control.Find(key))
444         to_print += " "+format_field(key,field_value)+'\n'
445     return to_print
446
447 def do_command (command, filename, escaped=0):
448     o = os.popen("%s %s" % (command, filename))
449     if escaped:
450         return escaped_text(o.read())
451     else:
452         return formatted_text(o.read())
453
454 def do_lintian (filename):
455     if use_html:
456         return do_command("lintian --show-overrides --color html", filename, 1)
457     else:
458         return do_command("lintian --show-overrides --color always", filename, 1)
459
460 def get_copyright (deb_filename):
461     global printed
462
463     package = re_package.sub(r'\1', deb_filename)
464     o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
465     cright = o.read()[:-1]
466
467     if cright == "":
468         return formatted_text("WARNING: No copyright found, please check package manually.")
469
470     doc_directory = re_doc_directory.sub(r'\1', cright)
471     if package != doc_directory:
472         return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
473
474     o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
475     cright = o.read()
476     copyrightmd5 = md5.md5(cright).hexdigest()
477
478     res = ""
479     if printed.copyrights.has_key(copyrightmd5) and printed.copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
480         res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
481                                (printed.copyrights[copyrightmd5]))
482     else:
483         printed.copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
484     return res+formatted_text(cright)
485
486 def get_readme_source (dsc_filename):
487     tempdir = utils.temp_dirname()
488     os.rmdir(tempdir)
489
490     cmd = "dpkg-source --no-check --no-copy -x %s %s" % (dsc_filename, tempdir)
491     (result, output) = commands.getstatusoutput(cmd)
492     if (result != 0):
493         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"
494         res += "Error, couldn't extract source, WTF?\n"
495         res += "'dpkg-source -x' failed. return code: %s.\n\n" % (result)
496         res += output
497         return res
498
499     path = os.path.join(tempdir, 'debian/README.source')
500     res = ""
501     if os.path.exists(path):
502         res += do_command("cat", path)
503     else:
504         res += "No README.source in this package\n\n"
505
506     try:
507         shutil.rmtree(tempdir)
508     except OSError, e:
509         if errno.errorcode[e.errno] != 'EACCES':
510             res += "%s: couldn't remove tmp dir %s for source tree." % (dsc_filename, tempdir)
511
512     return res
513
514 def check_dsc (suite, dsc_filename, session = None):
515     (dsc) = read_changes_or_dsc(suite, dsc_filename, session)
516     return foldable_output(dsc_filename, "dsc", dsc, norow=True) + \
517            "\n" + \
518            foldable_output("lintian check for %s" % dsc_filename,
519                "source-lintian", do_lintian(dsc_filename)) + \
520            "\n" + \
521            foldable_output("README.source for %s" % dsc_filename,
522                "source-readmesource", get_readme_source(dsc_filename))
523
524 def check_deb (suite, deb_filename, session = None):
525     filename = os.path.basename(deb_filename)
526     packagename = filename.split('_')[0]
527
528     if filename.endswith(".udeb"):
529         is_a_udeb = 1
530     else:
531         is_a_udeb = 0
532
533     result = foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
534         output_deb_info(suite, deb_filename, packagename, session), norow=True) + "\n"
535
536     if is_a_udeb:
537         result += foldable_output("skipping lintian check for udeb",
538             "binary-%s-lintian"%packagename, "") + "\n"
539     else:
540         result += foldable_output("lintian check for %s" % (filename),
541             "binary-%s-lintian"%packagename, do_lintian(deb_filename)) + "\n"
542
543     result += foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
544         do_command("dpkg -c", deb_filename)) + "\n"
545
546     if is_a_udeb:
547         result += foldable_output("skipping copyright for udeb",
548             "binary-%s-copyright"%packagename, "") + "\n"
549     else:
550         result += foldable_output("copyright of %s" % (filename),
551             "binary-%s-copyright"%packagename, get_copyright(deb_filename)) + "\n"
552
553     result += foldable_output("file listing of %s" % (filename),
554         "binary-%s-file-listing"%packagename, do_command("ls -l", deb_filename))
555
556     return result
557
558 # Read a file, strip the signature and return the modified contents as
559 # a string.
560 def strip_pgp_signature (filename):
561     inputfile = utils.open_file (filename)
562     contents = ""
563     inside_signature = 0
564     skip_next = 0
565     for line in inputfile.readlines():
566         if line[:-1] == "":
567             continue
568         if inside_signature:
569             continue
570         if skip_next:
571             skip_next = 0
572             continue
573         if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
574             skip_next = 1
575             continue
576         if line.startswith("-----BEGIN PGP SIGNATURE"):
577             inside_signature = 1
578             continue
579         if line.startswith("-----END PGP SIGNATURE"):
580             inside_signature = 0
581             continue
582         contents += line
583     inputfile.close()
584     return contents
585
586 def display_changes(suite, changes_filename):
587     global printed
588     changes = read_changes_or_dsc(suite, changes_filename)
589     printed.copyrights = {}
590     return foldable_output(changes_filename, "changes", changes, norow=True)
591
592 def check_changes (changes_filename):
593     try:
594         changes = utils.parse_changes (changes_filename)
595     except ChangesUnicodeError:
596         utils.warn("Encoding problem with changes file %s" % (changes_filename))
597     print display_changes(changes['distribution'], changes_filename)
598
599     files = utils.build_file_list(changes)
600     for f in files.keys():
601         if f.endswith(".deb") or f.endswith(".udeb"):
602             print check_deb(changes['distribution'], f)
603         if f.endswith(".dsc"):
604             print check_dsc(changes['distribution'], f)
605         # else: => byhand
606
607 def main ():
608     global Cnf, db_files, waste, excluded
609
610 #    Cnf = utils.get_conf()
611
612     Arguments = [('h',"help","Examine-Package::Options::Help"),
613                  ('H',"html-output","Examine-Package::Options::Html-Output"),
614                 ]
615     for i in [ "Help", "Html-Output", "partial-html" ]:
616         if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
617             Cnf["Examine-Package::Options::%s" % (i)] = ""
618
619     args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
620     Options = Cnf.SubTree("Examine-Package::Options")
621
622     if Options["Help"]:
623         usage()
624
625     if Options["Html-Output"]:
626         global use_html
627         use_html = 1
628
629     stdout_fd = sys.stdout
630
631     for f in args:
632         try:
633             if not Options["Html-Output"]:
634                 # Pipe output for each argument through less
635                 less_fd = os.popen("less -R -", 'w', 0)
636                 # -R added to display raw control chars for colour
637                 sys.stdout = less_fd
638             try:
639                 if f.endswith(".changes"):
640                     check_changes(f)
641                 elif f.endswith(".deb") or f.endswith(".udeb"):
642                     # default to unstable when we don't have a .changes file
643                     # perhaps this should be a command line option?
644                     print check_deb('unstable', f)
645                 elif f.endswith(".dsc"):
646                     print check_dsc('unstable', f)
647                 else:
648                     utils.fubar("Unrecognised file type: '%s'." % (f))
649             finally:
650                 print output_package_relations()
651                 if not Options["Html-Output"]:
652                     # Reset stdout here so future less invocations aren't FUBAR
653                     less_fd.close()
654                     sys.stdout = stdout_fd
655         except IOError, e:
656             if errno.errorcode[e.errno] == 'EPIPE':
657                 utils.warn("[examine-package] Caught EPIPE; skipping.")
658                 pass
659             else:
660                 raise
661         except KeyboardInterrupt:
662             utils.warn("[examine-package] Caught C-c; skipping.")
663             pass
664
665 #######################################################################################
666
667 if __name__ == '__main__':
668     main()