3 # Script to automate some parts of checking NEW packages
4 # Copyright (C) 2000, 2001, 2002, 2003, 2006 James Troup <james@nocrew.org>
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 ################################################################################
22 # <Omnic> elmo wrote docs?!!?!?!?!?!?!
23 # <aj> as if he wasn't scary enough before!!
24 # * aj imagines a little red furry toy sitting hunched over a computer
25 # tapping furiously and giggling to himself
26 # <aj> eventually he stops, and his heads slowly spins around and you
27 # see this really evil grin and then he sees you, and picks up a
28 # knife from beside the keyboard and throws it at you, and as you
29 # breathe your last breath, he starts giggling again
30 # <aj> but i should be telling this to my psychiatrist, not you guys,
33 ################################################################################
35 import errno, os, pg, re, sys, md5
36 import apt_pkg, apt_inst
37 from daklib import database
38 from daklib import utils
40 ################################################################################
42 re_package = re.compile(r"^(.+?)_.*")
43 re_doc_directory = re.compile(r".*/doc/([^/]*).*")
45 re_contrib = re.compile('^contrib/')
46 re_nonfree = re.compile('^non\-free/')
48 re_arch = re.compile("Architecture: .*")
49 re_builddep = re.compile("Build-Depends: .*")
50 re_builddepind = re.compile("Build-Depends-Indep: .*")
52 re_localhost = re.compile("localhost\.localdomain")
53 re_version = re.compile('^(.*)\((.*)\)')
55 re_newlinespace = re.compile('\n')
56 re_spacestrip = re.compile('(\s)')
58 ################################################################################
63 Cnf = utils.get_conf()
64 projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"]))
65 database.init(Cnf, projectB)
67 printed_copyrights = {}
69 # default is to not output html.
72 ################################################################################
74 def usage (exit_code=0):
75 print """Usage: dak examine-package [PACKAGE]...
78 -h, --help show this help and exit
79 -H, --html-output output html page with inspection result
80 -f, --file-name filename for the html page
82 PACKAGE can be a .changes, .dsc, .deb or .udeb filename."""
86 ################################################################################
87 # probably xml.sax.saxutils would work as well
89 def escape_if_needed(s):
91 return utils.re_html_escaping.sub(lambda x: utils.html_escaping.get(x.group(0)), s)
95 def headline(s, level=2, bodyelement=None):
99 <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>
100 </thead>"""%{"bodyelement":bodyelement,"title":utils.html_escape(s)}
102 print "<h%d>%s</h%d>" % (level, utils.html_escape(s), level)
104 print "---- %s ----" % (s)
106 # Colour definitions, 'end' isn't really for use
110 'contrib': "\033[33m",
111 'nonfree': "\033[31m",
115 'maintainer': "\033[32m"}
118 'main': ('<span style="color: aqua">',"</span>"),
119 'contrib': ('<span style="color: yellow">',"</span>"),
120 'nonfree': ('<span style="color: red">',"</span>"),
121 'arch': ('<span style="color: green">',"</span>"),
122 'bold': ('<span style="font-weight: bold">',"</span>"),
123 'maintainer': ('<span style="color: green">',"</span>")}
125 def colour_output(s, colour):
127 return ("%s%s%s" % (html_colours[colour][0], utils.html_escape(s), html_colours[colour][1]))
129 return ("%s%s%s" % (ansi_colours[colour], s, ansi_colours['end']))
131 def escaped_text(s, strip=False):
135 return "<pre>%s</pre>" % (s)
139 def formatted_text(s, strip=False):
143 return "<pre>%s</pre>" % (utils.html_escape(s))
149 return """<tr><td>"""+s+"""</td></tr>"""
153 def format_field(k,v):
155 return """<tr><td class="key">%s:</td><td class="val">%s</td></tr>"""%(k,v)
157 return "%s: %s"%(k,v)
159 def foldable_output(title, elementnameprefix, content, norow=False):
160 d = {'elementnameprefix':elementnameprefix}
162 print """<div id="%(elementnameprefix)s-wrap"><a name="%(elementnameprefix)s" />
163 <table class="infobox rfc822">"""%d
164 headline(title, bodyelement="%(elementnameprefix)s-body"%d)
166 print """ <tbody id="%(elementnameprefix)s-body" class="infobody">"""%d
170 print output_row(content)
172 print """</tbody></table></div>"""
174 ################################################################################
176 def get_depends_parts(depend) :
177 v_match = re_version.match(depend)
179 d_parts = { 'name' : v_match.group(1), 'version' : v_match.group(2) }
181 d_parts = { 'name' : depend , 'version' : '' }
184 def get_or_list(depend) :
185 or_list = depend.split("|")
188 def get_comma_list(depend) :
189 dep_list = depend.split(",")
192 def split_depends (d_str) :
193 # creates a list of lists of dictionaries of depends (package,version relation)
195 d_str = re_spacestrip.sub('',d_str)
197 # first split depends string up amongs comma delimiter
198 dep_list = get_comma_list(d_str)
200 while d < len(dep_list):
201 # put depends into their own list
202 depends_tree.append([dep_list[d]])
205 while d < len(depends_tree):
207 # split up Or'd depends into a multi-item list
208 depends_tree[d] = get_or_list(depends_tree[d][0])
209 while k < len(depends_tree[d]):
210 # split depends into {package, version relation}
211 depends_tree[d][k] = get_depends_parts(depends_tree[d][k])
216 def read_control (filename):
223 deb_file = utils.open_file(filename)
225 extracts = apt_inst.debExtractControl(deb_file)
226 control = apt_pkg.ParseSection(extracts)
228 print formatted_text("can't parse control info")
234 control_keys = control.keys()
236 if control.has_key("Depends"):
237 depends_str = control.Find("Depends")
238 # create list of dependancy lists
239 depends = split_depends(depends_str)
241 if control.has_key("Recommends"):
242 recommends_str = control.Find("Recommends")
243 recommends = split_depends(recommends_str)
245 if control.has_key("Section"):
246 section_str = control.Find("Section")
248 c_match = re_contrib.search(section_str)
249 nf_match = re_nonfree.search(section_str)
252 section = colour_output(section_str, 'contrib')
255 section = colour_output(section_str, 'nonfree')
258 section = colour_output(section_str, 'main')
259 if control.has_key("Architecture"):
260 arch_str = control.Find("Architecture")
261 arch = colour_output(arch_str, 'arch')
263 if control.has_key("Maintainer"):
264 maintainer = control.Find("Maintainer")
265 localhost = re_localhost.search(maintainer)
268 maintainer = colour_output(maintainer, 'maintainer')
270 maintainer = escape_if_needed(maintainer)
272 return (control, control_keys, section, depends, recommends, arch, maintainer)
274 def read_changes_or_dsc (filename):
277 dsc_file = utils.open_file(filename)
279 dsc = utils.parse_changes(filename)
281 return formatted_text("can't parse .dsc control info")
284 filecontents = strip_pgp_signature(filename)
286 for l in filecontents.split('\n'):
287 m = re.match(r'([-a-zA-Z0-9]*):', l)
289 keysinorder.append(m.group(1))
292 if k in ("build-depends","build-depends-indep"):
293 dsc[k] = create_depends_string(split_depends(dsc[k]))
294 elif k == "architecture":
295 if (dsc["architecture"] != "any"):
296 dsc['architecture'] = colour_output(dsc["architecture"], 'arch')
297 elif k in ("files","changes","description"):
299 dsc[k] = formatted_text(dsc[k], strip=True)
301 dsc[k] = ('\n'+'\n'.join(map(lambda x: ' '+x, dsc[k].split('\n')))).rstrip()
303 dsc[k] = escape_if_needed(dsc[k])
305 keysinorder = filter(lambda x: not x.lower().startswith('checksums-'), keysinorder)
307 filecontents = '\n'.join(map(lambda x: format_field(x,dsc[x.lower()]), keysinorder))+'\n'
310 def create_depends_string (depends_tree):
311 # just look up unstable for now. possibly pull from .changes later
315 for l in depends_tree:
316 if (comma_count >= 2):
322 # doesn't do version lookup yet.
324 q = projectB.query("SELECT DISTINCT(b.package), b.version, c.name, su.suite_name FROM binaries b, files fi, location l, component c, bin_associations ba, suite su WHERE b.package='%s' AND b.file = fi.id AND fi.location = l.id AND l.component = c.id AND ba.bin=b.id AND ba.suite = su.id AND su.suite_name='%s' ORDER BY b.version desc" % (d['name'], suite))
330 if d['version'] != '' :
331 adepends += " (%s)" % (d['version'])
333 if i[2] == "contrib":
334 result += colour_output(adepends, "contrib")
335 elif i[2] == "non-free":
336 result += colour_output(adepends, "nonfree")
338 result += colour_output(adepends, "main")
341 if d['version'] != '' :
342 adepends += " (%s)" % (d['version'])
343 result += colour_output(adepends, "bold")
348 def output_deb_info(filename):
349 (control, control_keys, section, depends, recommends, arch, maintainer) = read_control(filename)
352 return formatted_text("no control info")
354 for key in control_keys :
356 field_value = create_depends_string(depends)
357 elif key == 'Recommends':
358 field_value = create_depends_string(recommends)
359 elif key == 'Section':
360 field_value = section
361 elif key == 'Architecture':
363 elif key == 'Maintainer':
364 field_value = maintainer
365 elif key == 'Description':
367 field_value = formatted_text(control.Find(key), strip=True)
369 desc = control.Find(key)
370 desc = re_newlinespace.sub('\n ', desc)
371 field_value = escape_if_needed(desc)
373 field_value = escape_if_needed(control.Find(key))
374 to_print += " "+format_field(key,field_value)+'\n'
377 def do_command (command, filename, escaped=0):
378 o = os.popen("%s %s" % (command, filename))
380 return escaped_text(o.read())
382 return formatted_text(o.read())
384 def do_lintian (filename):
386 return do_command("lintian --show-overrides --color html", filename, 1)
388 return do_command("lintian --show-overrides --color always", filename, 1)
390 def get_copyright (deb_filename):
391 package = re_package.sub(r'\1', deb_filename)
392 o = os.popen("dpkg-deb -c %s | egrep 'usr(/share)?/doc/[^/]*/copyright' | awk '{print $6}' | head -n 1" % (deb_filename))
393 cright = o.read()[:-1]
396 return formatted_text("WARNING: No copyright found, please check package manually.")
398 doc_directory = re_doc_directory.sub(r'\1', cright)
399 if package != doc_directory:
400 return formatted_text("WARNING: wrong doc directory (expected %s, got %s)." % (package, doc_directory))
402 o = os.popen("dpkg-deb --fsys-tarfile %s | tar xvOf - %s 2>/dev/null" % (deb_filename, cright))
404 copyrightmd5 = md5.md5(cright).hexdigest()
407 if printed_copyrights.has_key(copyrightmd5) and printed_copyrights[copyrightmd5] != "%s (%s)" % (package, deb_filename):
408 res += formatted_text( "NOTE: Copyright is the same as %s.\n\n" % \
409 (printed_copyrights[copyrightmd5]))
411 printed_copyrights[copyrightmd5] = "%s (%s)" % (package, deb_filename)
412 return res+formatted_text(cright)
414 def check_dsc (dsc_filename):
415 (dsc) = read_changes_or_dsc(dsc_filename)
416 foldable_output(dsc_filename, "dsc", dsc, norow=True)
417 foldable_output("lintian check for %s" % dsc_filename, "source-lintian", do_lintian(dsc_filename))
419 def check_deb (deb_filename):
420 filename = os.path.basename(deb_filename)
421 packagename = filename.split('_')[0]
423 if filename.endswith(".udeb"):
429 foldable_output("control file for %s" % (filename), "binary-%s-control"%packagename,
430 output_deb_info(deb_filename), norow=True)
433 foldable_output("skipping lintian check for udeb", "binary-%s-lintian"%packagename,
436 foldable_output("lintian check for %s" % (filename), "binary-%s-lintian"%packagename,
437 do_lintian(deb_filename))
439 foldable_output("contents of %s" % (filename), "binary-%s-contents"%packagename,
440 do_command("dpkg -c", deb_filename))
443 foldable_output("skipping copyright for udeb", "binary-%s-copyright"%packagename,
446 foldable_output("copyright of %s" % (filename), "binary-%s-copyright"%packagename,
447 get_copyright(deb_filename))
449 foldable_output("file listing of %s" % (filename), "binary-%s-file-listing"%packagename,
450 do_command("ls -l", deb_filename))
452 # Read a file, strip the signature and return the modified contents as
454 def strip_pgp_signature (filename):
455 file = utils.open_file (filename)
459 for line in file.readlines():
467 if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
470 if line.startswith("-----BEGIN PGP SIGNATURE"):
473 if line.startswith("-----END PGP SIGNATURE"):
480 def display_changes(changes_filename):
481 changes = read_changes_or_dsc(changes_filename)
482 foldable_output(changes_filename, "changes", changes, norow=True)
484 def check_changes (changes_filename):
485 display_changes(changes_filename)
487 changes = utils.parse_changes (changes_filename)
488 files = utils.build_file_list(changes)
489 for f in files.keys():
490 if f.endswith(".deb") or f.endswith(".udeb"):
492 if f.endswith(".dsc"):
497 global Cnf, projectB, db_files, waste, excluded
499 # Cnf = utils.get_conf()
501 Arguments = [('h',"help","Examine-Package::Options::Help"),
502 ('H',"html-output","Examine-Package::Options::Html-Output"),
504 for i in [ "Help", "Html-Output", "partial-html" ]:
505 if not Cnf.has_key("Examine-Package::Options::%s" % (i)):
506 Cnf["Examine-Package::Options::%s" % (i)] = ""
508 args = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv)
509 Options = Cnf.SubTree("Examine-Package::Options")
514 stdout_fd = sys.stdout
518 if not Options["Html-Output"]:
519 # Pipe output for each argument through less
520 less_fd = os.popen("less -R -", 'w', 0)
521 # -R added to display raw control chars for colour
524 if f.endswith(".changes"):
526 elif f.endswith(".deb") or f.endswith(".udeb"):
528 elif f.endswith(".dsc"):
531 utils.fubar("Unrecognised file type: '%s'." % (f))
533 if not Options["Html-Output"]:
534 # Reset stdout here so future less invocations aren't FUBAR
536 sys.stdout = stdout_fd
538 if errno.errorcode[e.errno] == 'EPIPE':
539 utils.warn("[examine-package] Caught EPIPE; skipping.")
543 except KeyboardInterrupt:
544 utils.warn("[examine-package] Caught C-c; skipping.")
547 #######################################################################################
549 if __name__ == '__main__':