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