]> git.decadent.org.uk Git - dak.git/blob - dak/examine_package.py
p-n
[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 @contact: Debian FTP Master <ftpmaster@debian.org>
7 @copyright: 2000, 2001, 2002, 2003, 2006  James Troup <james@nocrew.org>
8 @copyright: 2009  Joerg Jaspert <joerg@debian.org>
9 @license: GNU General Public License version 2 or later
10 """
11
12 # This program is free software; you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License as published by
14 # the Free Software Foundation; either version 2 of the License, or
15 # (at your option) any later version.
16
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 # GNU General Public License for more details.
21
22 # You should have received a copy of the GNU General Public License
23 # along with this program; if not, write to the Free Software
24 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25
26 ################################################################################
27
28 # <Omnic> elmo wrote docs?!!?!?!?!?!?!
29 # <aj> as if he wasn't scary enough before!!
30 # * aj imagines a little red furry toy sitting hunched over a computer
31 #   tapping furiously and giggling to himself
32 # <aj> eventually he stops, and his heads slowly spins around and you
33 #      see this really evil grin and then he sees you, and picks up a
34 #      knife from beside the keyboard and throws it at you, and as you
35 #      breathe your last breath, he starts giggling again
36 # <aj> but i should be telling this to my psychiatrist, not you guys,
37 #      right? :)
38
39 ################################################################################
40
41 import errno
42 import os
43 import re
44 import sys
45 import md5
46 import apt_pkg
47 import apt_inst
48 import shutil
49 import commands
50
51 from daklib import utils
52 from daklib.dbconn import DBConn, get_binary_from_name_suite
53 from daklib.regexes import html_escaping, re_html_escaping, re_version, re_spacestrip, \
54                            re_contrib, re_nonfree, re_localhost, re_newlinespace, \
55                            re_package, re_doc_directory
56
57 ################################################################################
58
59 Cnf = None
60 Cnf = utils.get_conf()
61
62 printed_copyrights = {}
63 package_relations = {}           #: Store relations of packages for later output
64
65 # default is to not output html.
66 use_html = 0
67
68 ################################################################################
69
70 def usage (exit_code=0):
71     print """Usage: dak examine-package [PACKAGE]...
72 Check NEW package(s).
73
74   -h, --help                 show this help and exit
75   -H, --html-output          output html page with inspection result
76   -f, --file-name            filename for the html page
77
78 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
79
80     sys.exit(exit_code)
81
82 ################################################################################
83 # probably xml.sax.saxutils would work as well
84
85 def escape_if_needed(s):
86     if use_html:
87         return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
88     else:
89         return s
90
91 def headline(s, level=2, bodyelement=None):
92     if use_html:
93         if bodyelement:
94             print """<thead>
95                 <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>
96               </thead>"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
97         else:
98             print "<h%d>%s</h%d>" % (level, utils.html_escape(s), level)
99     else:
100         print "---- %s ----" % (s)
101
102 # Colour definitions, 'end' isn't really for use
103
104 ansi_colours = {
105   'main': "\033[36m",
106   'contrib': "\033[33m",
107   'nonfree': "\033[31m",
108   'arch': "\033[32m",
109   'end': "\033[0m",
110   'bold': "\033[1m",
111   'maintainer': "\033[32m"}
112
113 html_colours = {
114   'main': ('<span style="color: aqua">',"</span>"),
115   'contrib': ('<span style="color: yellow">',"</span>"),
116   'nonfree': ('<span style="color: red">',"</span>"),
117   'arch': ('<span style="color: green">',"</span>"),
118   'bold': ('<span style="font-weight: bold">',"</span>"),
119   'maintainer': ('<span style="color: green">',"</span>")}
120
121 def colour_output(s, colour):
122     if use_html:
123         return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
124     else:
125         return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
126
127 def escaped_text(s, strip=False):
128     if use_html:
129         if strip:
130             s = s.strip()
131         return "<pre>%s</pre>" % (s)
132     else:
133         return s
134
135 def formatted_text(s, strip=False):
136     if use_html:
137         if strip:
138             s = s.strip()
139         return "<pre>%s</pre>" % (utils.html_escape(s))
140     else:
141         return s
142
143 def output_row(s):
144     if use_html:
145         return """<tr><td>"""+s+"""</td></tr>"""
146     else:
147         return s
148
149 def format_field(k,v):
150     if use_html:
151         return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
152     else:
153         return "%s: %s"%(k,v)
154
155 def foldable_output(title, elementnameprefix, content, norow=False):
156     d = {'elementnameprefix':elementnameprefix}
157     if use_html:
158         print """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
159                    <table class="infobox rfc822">"""%d
160     headline(title, bodyelement="%(elementnameprefix)s-body"%d)
161     if use_html:
162         print """    <tbody id="%(elementnameprefix)s-body" class="infobody">"""%d
163     if norow:
164         print content
165     else:
166         print output_row(content)
167     if use_html:
168         print """</tbody></table></div>"""
169
170 ################################################################################
171
172 def get_depends_parts(depend) :
173     v_match = re_version.match(depend)
174     if v_match:
175         d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
176     else :
177         d_parts = { 'name' : depend , 'version' : '' }
178     return d_parts
179
180 def get_or_list(depend) :
181     or_list = depend.split("|")
182     return or_list
183
184 def get_comma_list(depend) :
185     dep_list = depend.split(",")
186     return dep_list
187
188 def split_depends (d_str) :
189     # creates a list of lists of dictionaries of depends (package,version relation)
190
191     d_str = re_spacestrip.sub('',d_str)
192     depends_tree = []
193     # first split depends string up amongs comma delimiter
194     dep_list = get_comma_list(d_str)
195     d = 0
196     while d < len(dep_list):
197         # put depends into their own list
198         depends_tree.append([dep_list[d]])
199         d += 1
200     d = 0
201     while d < len(depends_tree):
202         k = 0
203         # split up Or'd depends into a multi-item list
204         depends_tree[d] = get_or_list(depends_tree[d][0])
205         while k < len(depends_tree[d]):
206             # split depends into {package, version relation}
207             depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
208             k += 1
209         d += 1
210     return depends_tree
211
212 def read_control (filename):
213     recommends = []
214     depends = []
215     section = ''
216     maintainer = ''
217     arch = ''
218
219     deb_file = utils.open_file(filename)
220     try:
221         extracts = apt_inst.debExtractControl(deb_file)
222         control = apt_pkg.ParseSection(extracts)
223     except:
224         print formatted_text("can't parse control info")
225         deb_file.close()
226         raise
227
228     deb_file.close()
229
230     control_keys = control.keys()
231
232     if control.has_key("Depends"):
233         depends_str = control.Find("Depends")
234         # create list of dependancy lists
235         depends = split_depends(depends_str)
236
237     if control.has_key("Recommends"):
238         recommends_str = control.Find("Recommends")
239         recommends = split_depends(recommends_str)
240
241     if control.has_key("Section"):
242         section_str = control.Find("Section")
243
244         c_match = re_contrib.search(section_str)
245         nf_match = re_nonfree.search(section_str)
246         if c_match :
247             # contrib colour
248             section = colour_output(section_str, 'contrib')
249         elif nf_match :
250             # non-free colour
251             section = colour_output(section_str, 'nonfree')
252         else :
253             # main
254             section = colour_output(section_str, 'main')
255     if control.has_key("Architecture"):
256         arch_str = control.Find("Architecture")
257         arch = colour_output(arch_str, 'arch')
258
259     if control.has_key("Maintainer"):
260         maintainer = control.Find("Maintainer")
261         localhost = re_localhost.search(maintainer)
262         if localhost:
263             #highlight bad email
264             maintainer = colour_output(maintainer, 'maintainer')
265         else:
266             maintainer = escape_if_needed(maintainer)
267
268     return (control, control_keys, section, depends, recommends, arch, maintainer)
269
270 def read_changes_or_dsc (suite, filename):
271     dsc = {}
272
273     dsc_file = utils.open_file(filename)
274     try:
275         dsc = utils.parse_changes(filename)
276     except:
277         return formatted_text("can't parse .dsc control info")
278     dsc_file.close()
279
280     filecontents = strip_pgp_signature(filename)
281     keysinorder = []
282     for l in filecontents.split('\n'):
283         m = re.match(r'([-a-zA-Z0-9]*):', l)
284         if m:
285             keysinorder.append(m.group(1))
286
287     for k in dsc.keys():
288         if k in ("build-depends","build-depends-indep"):
289             dsc[k] = create_depends_string(suite, split_depends(dsc[k]))
290         elif k == "architecture":
291             if (dsc["architecture"] != "any"):
292                 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
293         elif k in ("files","changes","description"):
294             if use_html:
295                 dsc[k] = formatted_text(dsc[k], strip=True)
296             else:
297                 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
298         else:
299             dsc[k] = escape_if_needed(dsc[k])
300
301     keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
302
303     filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
304     return filecontents
305
306 def create_depends_string (suite, depends_tree):
307     result = ""
308     if suite == 'experimental':
309         suite_where = " in ('experimental','unstable')"
310     else:
311         suite_where = " ='%s'" % suite
312
313     comma_count = 1
314     session = DBConn().session()
315     for l in depends_tree:
316         if (comma_count >= 2):
317             result += ", "
318         or_count = 1
319         for d in l:
320             if (or_count >= 2 ):
321                 result += " | "
322             # doesn't do version lookup yet.
323
324             res = get_binary_from_name_suite(d['name'], suite_where)
325             if res.rowcount > 0:
326                 i = res.fetchone()
327
328                 adepends = d['name']
329                 if d['version'] != '' :
330                     adepends += " (%s)" % (d['version'])
331
332                 if i[2] == "contrib":
333                     result += colour_output(adepends, "contrib")
334                 elif i[2] == "non-free":
335                     result += colour_output(adepends, "nonfree")
336                 else :
337                     result += colour_output(adepends, "main")
338             else:
339                 adepends = d['name']
340                 if d['version'] != '' :
341                     adepends += " (%s)" % (d['version'])
342                 result += colour_output(adepends, "bold")
343             or_count += 1
344         comma_count += 1
345     return result
346
347 def output_package_relations ():
348     """
349     Output the package relations, if there is more than one package checked in this run.
350     """
351
352     if len(package_relations) < 2:
353         # Only list something if we have more than one binary to compare
354         package_relations.clear()
355         return
356
357     to_print = ""
358     for package in package_relations:
359         for relation in package_relations[package]:
360             to_print += "%-15s: (%s) %s\n" % (package, relation, package_relations[package][relation])
361
362     package_relations.clear()
363     foldable_output("Package relations", "relations", to_print)
364
365 def output_deb_info(suite, filename, packagename):
366     (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
367
368     if control == '':
369         return formatted_text("no control info")
370     to_print = ""
371     if not package_relations.has_key(packagename):
372         package_relations[packagename] = {}
373     for key in control_keys :
374         if key == 'Depends':
375             field_value = create_depends_string(suite, depends)
376             package_relations[packagename][key] = field_value
377         elif key == 'Recommends':
378             field_value = create_depends_string(suite, recommends)
379             package_relations[packagename][key] = field_value
380         elif key == 'Section':
381             field_value = section
382         elif key == 'Architecture':
383             field_value = arch
384         elif key == 'Maintainer':
385             field_value = maintainer
386         elif key == 'Description':
387             if use_html:
388                 field_value = formatted_text(control.Find(key), strip=True)
389             else:
390                 desc = control.Find(key)
391                 desc = re_newlinespace.sub('\n ', desc)
392                 field_value = escape_if_needed(desc)
393         else:
394             field_value = escape_if_needed(control.Find(key))
395         to_print += " "+format_field(key,field_value)+'\n'
396     return to_print
397
398 def do_command (command, filename, escaped=0):
399     o = os.popen("%s %s" % (command, filename))
400     if escaped:
401         return escaped_text(o.read())
402     else:
403         return formatted_text(o.read())
404
405 def do_lintian (filename):
406     if use_html:
407         return do_command("lintian --show-overrides --color html", filename, 1)
408     else:
409         return do_command("lintian --show-overrides --color always", filename, 1)
410
411 def get_copyright (deb_filename):
412     package = re_package.sub(r'\1', deb_filename)
413     o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
414     cright = o.read()[:-1]
415
416     if cright == "":
417         return formatted_text("WARNING: No copyright found, please check package manually.")
418
419     doc_directory = re_doc_directory.sub(r'\1', cright)
420     if package != doc_directory:
421         return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
422
423     o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
424     cright = o.read()
425     copyrightmd5 = md5.md5(cright).hexdigest()
426
427     res = ""
428     if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
429         res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
430                                (printed_copyrights[copyrightmd5]))
431     else:
432         printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
433     return res+formatted_text(cright)
434
435 def get_readme_source (dsc_filename):
436     tempdir = utils.temp_dirname()
437     os.rmdir(tempdir)
438
439     cmd = "dpkg-source --no-check --no-copy -x %s %s" % (dsc_filename, tempdir)
440     (result, output) = commands.getstatusoutput(cmd)
441     if (result != 0):
442         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"
443         res += "Error, couldn't extract source, WTF?\n"
444         res += "'dpkg-source -x' failed. return code: %s.\n\n" % (result)
445         res += output
446         return res
447
448     path = os.path.join(tempdir, 'debian/README.source')
449     res = ""
450     if os.path.exists(path):
451         res += do_command("cat", path)
452     else:
453         res += "No README.source in this package\n\n"
454
455     try:
456         shutil.rmtree(tempdir)
457     except OSError, e:
458         if errno.errorcode[e.errno] != 'EACCES':
459             res += "%s: couldn't remove tmp dir %s for source tree." % (dsc_filename, tempdir)
460
461     return res
462
463 def check_dsc (suite, dsc_filename):
464     (dsc) = read_changes_or_dsc(suite, dsc_filename)
465     foldable_output(dsc_filename, "dsc", dsc, norow=True)
466     foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
467     foldable_output("README.source for %s" % dsc_filename, "source-readmesource", get_readme_source(dsc_filename))
468
469 def check_deb (suite, deb_filename):
470     filename = os.path.basename(deb_filename)
471     packagename = filename.split('_')[0]
472
473     if filename.endswith(".udeb"):
474         is_a_udeb = 1
475     else:
476         is_a_udeb = 0
477
478
479     foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
480                     output_deb_info(suite, deb_filename, packagename), norow=True)
481
482     if is_a_udeb:
483         foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
484                         "")
485     else:
486         foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
487                         do_lintian(deb_filename))
488
489     foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
490                     do_command("dpkg -c", deb_filename))
491
492     if is_a_udeb:
493         foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
494                         "")
495     else:
496         foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
497                         get_copyright(deb_filename))
498
499     foldable_output("file listing of %s" % (filename),  "binary-%s-file-listing"%packagename,
500                     do_command("ls -l", deb_filename))
501
502 # Read a file, strip the signature and return the modified contents as
503 # a string.
504 def strip_pgp_signature (filename):
505     inputfile = utils.open_file (filename)
506     contents = ""
507     inside_signature = 0
508     skip_next = 0
509     for line in inputfile.readlines():
510         if line[:-1] == "":
511             continue
512         if inside_signature:
513             continue
514         if skip_next:
515             skip_next = 0
516             continue
517         if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
518             skip_next = 1
519             continue
520         if line.startswith("-----BEGIN PGP SIGNATURE"):
521             inside_signature = 1
522             continue
523         if line.startswith("-----END PGP SIGNATURE"):
524             inside_signature = 0
525             continue
526         contents += line
527     inputfile.close()
528     return contents
529
530 def display_changes(suite, changes_filename):
531     changes = read_changes_or_dsc(suite, changes_filename)
532     foldable_output(changes_filename, "changes", changes, norow=True)
533
534 def check_changes (changes_filename):
535     try:
536         changes = utils.parse_changes (changes_filename)
537     except ChangesUnicodeError:
538         utils.warn("Encoding problem with changes file %s" % (changes_filename))
539     display_changes(changes['distribution'], changes_filename)
540
541     files = utils.build_file_list(changes)
542     for f in files.keys():
543         if f.endswith(".deb") or f.endswith(".udeb"):
544             check_deb(changes['distribution'], f)
545         if f.endswith(".dsc"):
546             check_dsc(changes['distribution'], f)
547         # else: => byhand
548
549 def main ():
550     global Cnf, db_files, waste, excluded
551
552 #    Cnf = utils.get_conf()
553
554     Arguments = [('h',"help","Examine-Package::Options::Help"),
555                  ('H',"html-output","Examine-Package::Options::Html-Output"),
556                 ]
557     for i in [ "Help", "Html-Output", "partial-html" ]:
558         if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
559             Cnf["Examine-Package::Options::%s" % (i)] = ""
560
561     args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
562     Options = Cnf.SubTree("Examine-Package::Options")
563
564     if Options["Help"]:
565         usage()
566
567     stdout_fd = sys.stdout
568
569     for f in args:
570         try:
571             if not Options["Html-Output"]:
572                 # Pipe output for each argument through less
573                 less_fd = os.popen("less -R -", 'w', 0)
574                 # -R added to display raw control chars for colour
575                 sys.stdout = less_fd
576             try:
577                 if f.endswith(".changes"):
578                     check_changes(f)
579                 elif f.endswith(".deb") or f.endswith(".udeb"):
580                     # default to unstable when we don't have a .changes file
581                     # perhaps this should be a command line option?
582                     check_deb('unstable', file)
583                 elif f.endswith(".dsc"):
584                     check_dsc('unstable', f)
585                 else:
586                     utils.fubar("Unrecognised file type: '%s'." % (f))
587             finally:
588                 output_package_relations()
589                 if not Options["Html-Output"]:
590                     # Reset stdout here so future less invocations aren't FUBAR
591                     less_fd.close()
592                     sys.stdout = stdout_fd
593         except IOError, e:
594             if errno.errorcode[e.errno] == 'EPIPE':
595                 utils.warn("[examine-package] Caught EPIPE; skipping.")
596                 pass
597             else:
598                 raise
599         except KeyboardInterrupt:
600             utils.warn("[examine-package] Caught C-c; skipping.")
601             pass
602
603 #######################################################################################
604
605 if __name__ == '__main__':
606     main()