]> git.decadent.org.uk Git - dak.git/blob - daklib/utils.py
remove (mercifully) unused routine
[dak.git] / daklib / utils.py
1 #!/usr/bin/env python
2 # vim:set et ts=4 sw=4:
3
4 """Utility functions
5
6 @contact: Debian FTP Master <ftpmaster@debian.org>
7 @copyright: 2000, 2001, 2002, 2003, 2004, 2005, 2006  James Troup <james@nocrew.org>
8 @license: GNU General Public License version 2 or later
9 """
10
11 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 2 of the License, or
14 # (at your option) any later version.
15
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 # GNU General Public License for more details.
20
21 # You should have received a copy of the GNU General Public License
22 # along with this program; if not, write to the Free Software
23 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24
25 import codecs
26 import commands
27 import email.Header
28 import os
29 import pwd
30 import select
31 import socket
32 import shutil
33 import sys
34 import tempfile
35 import traceback
36 import stat
37 import apt_pkg
38 import time
39 import re
40 import string
41 import email as modemail
42
43 from dbconn import DBConn, get_architecture, get_component, get_suite
44 from dak_exceptions import *
45 from textutils import fix_maintainer
46 from regexes import re_html_escaping, html_escaping, re_single_line_field, \
47                     re_multi_line_field, re_srchasver, re_verwithext, \
48                     re_parse_maintainer, re_taint_free, re_gpg_uid, re_re_mark, \
49                     re_whitespace_comment
50
51 ################################################################################
52
53 default_config = "/etc/dak/dak.conf"     #: default dak config, defines host properties
54 default_apt_config = "/etc/dak/apt.conf" #: default apt config, not normally used
55
56 alias_cache = None        #: Cache for email alias checks
57 key_uid_email_cache = {}  #: Cache for email addresses from gpg key uids
58
59 # (hashname, function, earliest_changes_version)
60 known_hashes = [("sha1", apt_pkg.sha1sum, (1, 8)),
61                 ("sha256", apt_pkg.sha256sum, (1, 8))] #: hashes we accept for entries in .changes/.dsc
62
63 ################################################################################
64
65 def html_escape(s):
66     """ Escape html chars """
67     return re_html_escaping.sub(lambda x: html_escaping.get(x.group(0)), s)
68
69 ################################################################################
70
71 def open_file(filename, mode='r'):
72     """
73     Open C{file}, return fileobject.
74
75     @type filename: string
76     @param filename: path/filename to open
77
78     @type mode: string
79     @param mode: open mode
80
81     @rtype: fileobject
82     @return: open fileobject
83
84     @raise CantOpenError: If IOError is raised by open, reraise it as CantOpenError.
85
86     """
87     try:
88         f = open(filename, mode)
89     except IOError:
90         raise CantOpenError, filename
91     return f
92
93 ################################################################################
94
95 def our_raw_input(prompt=""):
96     if prompt:
97         sys.stdout.write(prompt)
98     sys.stdout.flush()
99     try:
100         ret = raw_input()
101         return ret
102     except EOFError:
103         sys.stderr.write("\nUser interrupt (^D).\n")
104         raise SystemExit
105
106 ################################################################################
107
108 def extract_component_from_section(section):
109     component = ""
110
111     if section.find('/') != -1:
112         component = section.split('/')[0]
113
114     # Expand default component
115     if component == "":
116         if Cnf.has_key("Component::%s" % section):
117             component = section
118         else:
119             component = "main"
120
121     return (section, component)
122
123 ################################################################################
124
125 def parse_deb822(contents, signing_rules=0):
126     error = ""
127     changes = {}
128
129     # Split the lines in the input, keeping the linebreaks.
130     lines = contents.splitlines(True)
131
132     if len(lines) == 0:
133         raise ParseChangesError, "[Empty changes file]"
134
135     # Reindex by line number so we can easily verify the format of
136     # .dsc files...
137     index = 0
138     indexed_lines = {}
139     for line in lines:
140         index += 1
141         indexed_lines[index] = line[:-1]
142
143     inside_signature = 0
144
145     num_of_lines = len(indexed_lines.keys())
146     index = 0
147     first = -1
148     while index < num_of_lines:
149         index += 1
150         line = indexed_lines[index]
151         if line == "":
152             if signing_rules == 1:
153                 index += 1
154                 if index > num_of_lines:
155                     raise InvalidDscError, index
156                 line = indexed_lines[index]
157                 if not line.startswith("-----BEGIN PGP SIGNATURE"):
158                     raise InvalidDscError, index
159                 inside_signature = 0
160                 break
161             else:
162                 continue
163         if line.startswith("-----BEGIN PGP SIGNATURE"):
164             break
165         if line.startswith("-----BEGIN PGP SIGNED MESSAGE"):
166             inside_signature = 1
167             if signing_rules == 1:
168                 while index < num_of_lines and line != "":
169                     index += 1
170                     line = indexed_lines[index]
171             continue
172         # If we're not inside the signed data, don't process anything
173         if signing_rules >= 0 and not inside_signature:
174             continue
175         slf = re_single_line_field.match(line)
176         if slf:
177             field = slf.groups()[0].lower()
178             changes[field] = slf.groups()[1]
179             first = 1
180             continue
181         if line == " .":
182             changes[field] += '\n'
183             continue
184         mlf = re_multi_line_field.match(line)
185         if mlf:
186             if first == -1:
187                 raise ParseChangesError, "'%s'\n [Multi-line field continuing on from nothing?]" % (line)
188             if first == 1 and changes[field] != "":
189                 changes[field] += '\n'
190             first = 0
191             changes[field] += mlf.groups()[0] + '\n'
192             continue
193         error += line
194
195     if signing_rules == 1 and inside_signature:
196         raise InvalidDscError, index
197
198     changes["filecontents"] = "".join(lines)
199
200     if changes.has_key("source"):
201         # Strip the source version in brackets from the source field,
202         # put it in the "source-version" field instead.
203         srcver = re_srchasver.search(changes["source"])
204         if srcver:
205             changes["source"] = srcver.group(1)
206             changes["source-version"] = srcver.group(2)
207
208     if error:
209         raise ParseChangesError, error
210
211     return changes
212
213 ################################################################################
214
215 def parse_changes(filename, signing_rules=0):
216     """
217     Parses a changes file and returns a dictionary where each field is a
218     key.  The mandatory first argument is the filename of the .changes
219     file.
220
221     signing_rules is an optional argument:
222
223       - If signing_rules == -1, no signature is required.
224       - If signing_rules == 0 (the default), a signature is required.
225       - If signing_rules == 1, it turns on the same strict format checking
226         as dpkg-source.
227
228     The rules for (signing_rules == 1)-mode are:
229
230       - The PGP header consists of "-----BEGIN PGP SIGNED MESSAGE-----"
231         followed by any PGP header data and must end with a blank line.
232
233       - The data section must end with a blank line and must be followed by
234         "-----BEGIN PGP SIGNATURE-----".
235     """
236
237     changes_in = open_file(filename)
238     content = changes_in.read()
239     changes_in.close()
240     try:
241         unicode(content, 'utf-8')
242     except UnicodeError:
243         raise ChangesUnicodeError, "Changes file not proper utf-8"
244     return parse_deb822(content, signing_rules)
245
246 ################################################################################
247
248 def hash_key(hashname):
249     return '%ssum' % hashname
250
251 ################################################################################
252
253 def create_hash(where, files, hashname, hashfunc):
254     """
255     create_hash extends the passed files dict with the given hash by
256     iterating over all files on disk and passing them to the hashing
257     function given.
258     """
259
260     rejmsg = []
261     for f in files.keys():
262         try:
263             file_handle = open_file(f)
264         except CantOpenError:
265             rejmsg.append("Could not open file %s for checksumming" % (f))
266             continue
267
268         files[f][hash_key(hashname)] = hashfunc(file_handle)
269
270         file_handle.close()
271     return rejmsg
272
273 ################################################################################
274
275 def check_hash(where, files, hashname, hashfunc):
276     """
277     check_hash checks the given hash in the files dict against the actual
278     files on disk.  The hash values need to be present consistently in
279     all file entries.  It does not modify its input in any way.
280     """
281
282     rejmsg = []
283     for f in files.keys():
284         file_handle = None
285         try:
286             try:
287                 file_handle = open_file(f)
288     
289                 # Check for the hash entry, to not trigger a KeyError.
290                 if not files[f].has_key(hash_key(hashname)):
291                     rejmsg.append("%s: misses %s checksum in %s" % (f, hashname,
292                         where))
293                     continue
294     
295                 # Actually check the hash for correctness.
296                 if hashfunc(file_handle) != files[f][hash_key(hashname)]:
297                     rejmsg.append("%s: %s check failed in %s" % (f, hashname,
298                         where))
299             except CantOpenError:
300                 # TODO: This happens when the file is in the pool.
301                 # warn("Cannot open file %s" % f)
302                 continue
303         finally:
304             if file_handle:
305                 file_handle.close()
306     return rejmsg
307
308 ################################################################################
309
310 def check_size(where, files):
311     """
312     check_size checks the file sizes in the passed files dict against the
313     files on disk.
314     """
315
316     rejmsg = []
317     for f in files.keys():
318         try:
319             entry = os.stat(f)
320         except OSError, exc:
321             if exc.errno == 2:
322                 # TODO: This happens when the file is in the pool.
323                 continue
324             raise
325
326         actual_size = entry[stat.ST_SIZE]
327         size = int(files[f]["size"])
328         if size != actual_size:
329             rejmsg.append("%s: actual file size (%s) does not match size (%s) in %s"
330                    % (f, actual_size, size, where))
331     return rejmsg
332
333 ################################################################################
334
335 def check_hash_fields(what, manifest):
336     """
337     check_hash_fields ensures that there are no checksum fields in the
338     given dict that we do not know about.
339     """
340
341     rejmsg = []
342     hashes = map(lambda x: x[0], known_hashes)
343     for field in manifest:
344         if field.startswith("checksums-"):
345             hashname = field.split("-",1)[1]
346             if hashname not in hashes:
347                 rejmsg.append("Unsupported checksum field for %s "\
348                     "in %s" % (hashname, what))
349     return rejmsg
350
351 ################################################################################
352
353 def _ensure_changes_hash(changes, format, version, files, hashname, hashfunc):
354     if format >= version:
355         # The version should contain the specified hash.
356         func = check_hash
357
358         # Import hashes from the changes
359         rejmsg = parse_checksums(".changes", files, changes, hashname)
360         if len(rejmsg) > 0:
361             return rejmsg
362     else:
363         # We need to calculate the hash because it can't possibly
364         # be in the file.
365         func = create_hash
366     return func(".changes", files, hashname, hashfunc)
367
368 # We could add the orig which might be in the pool to the files dict to
369 # access the checksums easily.
370
371 def _ensure_dsc_hash(dsc, dsc_files, hashname, hashfunc):
372     """
373     ensure_dsc_hashes' task is to ensure that each and every *present* hash
374     in the dsc is correct, i.e. identical to the changes file and if necessary
375     the pool.  The latter task is delegated to check_hash.
376     """
377
378     rejmsg = []
379     if not dsc.has_key('Checksums-%s' % (hashname,)):
380         return rejmsg
381     # Import hashes from the dsc
382     parse_checksums(".dsc", dsc_files, dsc, hashname)
383     # And check it...
384     rejmsg.extend(check_hash(".dsc", dsc_files, hashname, hashfunc))
385     return rejmsg
386
387 ################################################################################
388
389 def ensure_hashes(changes, dsc, files, dsc_files):
390     rejmsg = []
391
392     # Make sure we recognise the format of the Files: field in the .changes
393     format = changes.get("format", "0.0").split(".", 1)
394     if len(format) == 2:
395         format = int(format[0]), int(format[1])
396     else:
397         format = int(float(format[0])), 0
398
399     # We need to deal with the original changes blob, as the fields we need
400     # might not be in the changes dict serialised into the .dak anymore.
401     orig_changes = parse_deb822(changes['filecontents'])
402
403     # Copy the checksums over to the current changes dict.  This will keep
404     # the existing modifications to it intact.
405     for field in orig_changes:
406         if field.startswith('checksums-'):
407             changes[field] = orig_changes[field]
408
409     # Check for unsupported hashes
410     rejmsg.extend(check_hash_fields(".changes", changes))
411     rejmsg.extend(check_hash_fields(".dsc", dsc))
412
413     # We have to calculate the hash if we have an earlier changes version than
414     # the hash appears in rather than require it exist in the changes file
415     for hashname, hashfunc, version in known_hashes:
416         rejmsg.extend(_ensure_changes_hash(changes, format, version, files,
417             hashname, hashfunc))
418         if "source" in changes["architecture"]:
419             rejmsg.extend(_ensure_dsc_hash(dsc, dsc_files, hashname,
420                 hashfunc))
421
422     return rejmsg
423
424 def parse_checksums(where, files, manifest, hashname):
425     rejmsg = []
426     field = 'checksums-%s' % hashname
427     if not field in manifest:
428         return rejmsg
429     for line in manifest[field].split('\n'):
430         if not line:
431             break
432         checksum, size, checkfile = line.strip().split(' ')
433         if not files.has_key(checkfile):
434         # TODO: check for the file's entry in the original files dict, not
435         # the one modified by (auto)byhand and other weird stuff
436         #    rejmsg.append("%s: not present in files but in checksums-%s in %s" %
437         #        (file, hashname, where))
438             continue
439         if not files[checkfile]["size"] == size:
440             rejmsg.append("%s: size differs for files and checksums-%s entry "\
441                 "in %s" % (checkfile, hashname, where))
442             continue
443         files[checkfile][hash_key(hashname)] = checksum
444     for f in files.keys():
445         if not files[f].has_key(hash_key(hashname)):
446             rejmsg.append("%s: no entry in checksums-%s in %s" % (checkfile,
447                 hashname, where))
448     return rejmsg
449
450 ################################################################################
451
452 # Dropped support for 1.4 and ``buggy dchanges 3.4'' (?!) compared to di.pl
453
454 def build_file_list(changes, is_a_dsc=0, field="files", hashname="md5sum"):
455     files = {}
456
457     # Make sure we have a Files: field to parse...
458     if not changes.has_key(field):
459         raise NoFilesFieldError
460
461     # Make sure we recognise the format of the Files: field
462     format = re_verwithext.search(changes.get("format", "0.0"))
463     if not format:
464         raise UnknownFormatError, "%s" % (changes.get("format","0.0"))
465
466     format = format.groups()
467     if format[1] == None:
468         format = int(float(format[0])), 0, format[2]
469     else:
470         format = int(format[0]), int(format[1]), format[2]
471     if format[2] == None:
472         format = format[:2]
473
474     if is_a_dsc:
475         # format = (1,0) are the only formats we currently accept,
476         # format = (0,0) are missing format headers of which we still
477         # have some in the archive.
478         if format != (1,0) and format != (0,0):
479             raise UnknownFormatError, "%s" % (changes.get("format","0.0"))
480     else:
481         if (format < (1,5) or format > (1,8)):
482             raise UnknownFormatError, "%s" % (changes.get("format","0.0"))
483         if field != "files" and format < (1,8):
484             raise UnknownFormatError, "%s" % (changes.get("format","0.0"))
485
486     includes_section = (not is_a_dsc) and field == "files"
487
488     # Parse each entry/line:
489     for i in changes[field].split('\n'):
490         if not i:
491             break
492         s = i.split()
493         section = priority = ""
494         try:
495             if includes_section:
496                 (md5, size, section, priority, name) = s
497             else:
498                 (md5, size, name) = s
499         except ValueError:
500             raise ParseChangesError, i
501
502         if section == "":
503             section = "-"
504         if priority == "":
505             priority = "-"
506
507         (section, component) = extract_component_from_section(section)
508
509         files[name] = Dict(size=size, section=section,
510                            priority=priority, component=component)
511         files[name][hashname] = md5
512
513     return files
514
515 ################################################################################
516
517 def send_mail (message, filename=""):
518     """sendmail wrapper, takes _either_ a message string or a file as arguments"""
519
520     # If we've been passed a string dump it into a temporary file
521     if message:
522         (fd, filename) = tempfile.mkstemp()
523         os.write (fd, message)
524         os.close (fd)
525
526     if Cnf.has_key("Dinstall::MailWhiteList") and \
527            Cnf["Dinstall::MailWhiteList"] != "":
528         message_in = open_file(filename)
529         message_raw = modemail.message_from_file(message_in)
530         message_in.close();
531
532         whitelist = [];
533         whitelist_in = open_file(Cnf["Dinstall::MailWhiteList"])
534         try:
535             for line in whitelist_in:
536                 if not re_whitespace_comment.match(line):
537                     if re_re_mark.match(line):
538                         whitelist.append(re.compile(re_re_mark.sub("", line.strip(), 1)))
539                     else:
540                         whitelist.append(re.compile(re.escape(line.strip())))
541         finally:
542             whitelist_in.close()
543
544         # Fields to check.
545         fields = ["To", "Bcc", "Cc"]
546         for field in fields:
547             # Check each field
548             value = message_raw.get(field, None)
549             if value != None:
550                 match = [];
551                 for item in value.split(","):
552                     (rfc822_maint, rfc2047_maint, name, email) = fix_maintainer(item.strip())
553                     mail_whitelisted = 0
554                     for wr in whitelist:
555                         if wr.match(email):
556                             mail_whitelisted = 1
557                             break
558                     if not mail_whitelisted:
559                         print "Skipping %s since it's not in %s" % (item, Cnf["Dinstall::MailWhiteList"])
560                         continue
561                     match.append(item)
562
563                 # Doesn't have any mail in whitelist so remove the header
564                 if len(match) == 0:
565                     del message_raw[field]
566                 else:
567                     message_raw.replace_header(field, string.join(match, ", "))
568
569         # Change message fields in order if we don't have a To header
570         if not message_raw.has_key("To"):
571             fields.reverse()
572             for field in fields:
573                 if message_raw.has_key(field):
574                     message_raw[fields[-1]] = message_raw[field]
575                     del message_raw[field]
576                     break
577             else:
578                 # Clean up any temporary files
579                 # and return, as we removed all recipients.
580                 if message:
581                     os.unlink (filename);
582                 return;
583
584         fd = os.open(filename, os.O_RDWR|os.O_EXCL, 0700);
585         os.write (fd, message_raw.as_string(True));
586         os.close (fd);
587
588     # Invoke sendmail
589     (result, output) = commands.getstatusoutput("%s < %s" % (Cnf["Dinstall::SendmailCommand"], filename))
590     if (result != 0):
591         raise SendmailFailedError, output
592
593     # Clean up any temporary files
594     if message:
595         os.unlink (filename)
596
597 ################################################################################
598
599 def poolify (source, component):
600     if component:
601         component += '/'
602     if source[:3] == "lib":
603         return component + source[:4] + '/' + source + '/'
604     else:
605         return component + source[:1] + '/' + source + '/'
606
607 ################################################################################
608
609 def move (src, dest, overwrite = 0, perms = 0664):
610     if os.path.exists(dest) and os.path.isdir(dest):
611         dest_dir = dest
612     else:
613         dest_dir = os.path.dirname(dest)
614     if not os.path.exists(dest_dir):
615         umask = os.umask(00000)
616         os.makedirs(dest_dir, 02775)
617         os.umask(umask)
618     #print "Moving %s to %s..." % (src, dest)
619     if os.path.exists(dest) and os.path.isdir(dest):
620         dest += '/' + os.path.basename(src)
621     # Don't overwrite unless forced to
622     if os.path.exists(dest):
623         if not overwrite:
624             fubar("Can't move %s to %s - file already exists." % (src, dest))
625         else:
626             if not os.access(dest, os.W_OK):
627                 fubar("Can't move %s to %s - can't write to existing file." % (src, dest))
628     shutil.copy2(src, dest)
629     os.chmod(dest, perms)
630     os.unlink(src)
631
632 def copy (src, dest, overwrite = 0, perms = 0664):
633     if os.path.exists(dest) and os.path.isdir(dest):
634         dest_dir = dest
635     else:
636         dest_dir = os.path.dirname(dest)
637     if not os.path.exists(dest_dir):
638         umask = os.umask(00000)
639         os.makedirs(dest_dir, 02775)
640         os.umask(umask)
641     #print "Copying %s to %s..." % (src, dest)
642     if os.path.exists(dest) and os.path.isdir(dest):
643         dest += '/' + os.path.basename(src)
644     # Don't overwrite unless forced to
645     if os.path.exists(dest):
646         if not overwrite:
647             raise FileExistsError
648         else:
649             if not os.access(dest, os.W_OK):
650                 raise CantOverwriteError
651     shutil.copy2(src, dest)
652     os.chmod(dest, perms)
653
654 ################################################################################
655
656 def where_am_i ():
657     res = socket.gethostbyaddr(socket.gethostname())
658     database_hostname = Cnf.get("Config::" + res[0] + "::DatabaseHostname")
659     if database_hostname:
660         return database_hostname
661     else:
662         return res[0]
663
664 def which_conf_file ():
665     res = socket.gethostbyaddr(socket.gethostname())
666     # In case we allow local config files per user, try if one exists
667     if Cnf.FindB("Config::" + res[0] + "::AllowLocalConfig"):
668         homedir = os.getenv("HOME")
669         confpath = os.path.join(homedir, "/etc/dak.conf")
670         if os.path.exists(confpath):
671             apt_pkg.ReadConfigFileISC(Cnf,default_config)
672
673     # We are still in here, so there is no local config file or we do
674     # not allow local files. Do the normal stuff.
675     if Cnf.get("Config::" + res[0] + "::DakConfig"):
676         return Cnf["Config::" + res[0] + "::DakConfig"]
677     else:
678         return default_config
679
680 def which_apt_conf_file ():
681     res = socket.gethostbyaddr(socket.gethostname())
682     # In case we allow local config files per user, try if one exists
683     if Cnf.FindB("Config::" + res[0] + "::AllowLocalConfig"):
684         homedir = os.getenv("HOME")
685         confpath = os.path.join(homedir, "/etc/dak.conf")
686         if os.path.exists(confpath):
687             apt_pkg.ReadConfigFileISC(Cnf,default_config)
688
689     if Cnf.get("Config::" + res[0] + "::AptConfig"):
690         return Cnf["Config::" + res[0] + "::AptConfig"]
691     else:
692         return default_apt_config
693
694 def which_alias_file():
695     hostname = socket.gethostbyaddr(socket.gethostname())[0]
696     aliasfn = '/var/lib/misc/'+hostname+'/forward-alias'
697     if os.path.exists(aliasfn):
698         return aliasfn
699     else:
700         return None
701
702 ################################################################################
703
704 def TemplateSubst(map, filename):
705     """ Perform a substition of template """
706     templatefile = open_file(filename)
707     template = templatefile.read()
708     for x in map.keys():
709         template = template.replace(x,map[x])
710     templatefile.close()
711     return template
712
713 ################################################################################
714
715 def fubar(msg, exit_code=1):
716     sys.stderr.write("E: %s\n" % (msg))
717     sys.exit(exit_code)
718
719 def warn(msg):
720     sys.stderr.write("W: %s\n" % (msg))
721
722 ################################################################################
723
724 # Returns the user name with a laughable attempt at rfc822 conformancy
725 # (read: removing stray periods).
726 def whoami ():
727     return pwd.getpwuid(os.getuid())[4].split(',')[0].replace('.', '')
728
729 ################################################################################
730
731 def size_type (c):
732     t  = " B"
733     if c > 10240:
734         c = c / 1024
735         t = " KB"
736     if c > 10240:
737         c = c / 1024
738         t = " MB"
739     return ("%d%s" % (c, t))
740
741 ################################################################################
742
743 def cc_fix_changes (changes):
744     o = changes.get("architecture", "")
745     if o:
746         del changes["architecture"]
747     changes["architecture"] = {}
748     for j in o.split():
749         changes["architecture"][j] = 1
750
751 def changes_compare (a, b):
752     """ Sort by source name, source version, 'have source', and then by filename """
753     try:
754         a_changes = parse_changes(a)
755     except:
756         return -1
757
758     try:
759         b_changes = parse_changes(b)
760     except:
761         return 1
762
763     cc_fix_changes (a_changes)
764     cc_fix_changes (b_changes)
765
766     # Sort by source name
767     a_source = a_changes.get("source")
768     b_source = b_changes.get("source")
769     q = cmp (a_source, b_source)
770     if q:
771         return q
772
773     # Sort by source version
774     a_version = a_changes.get("version", "0")
775     b_version = b_changes.get("version", "0")
776     q = apt_pkg.VersionCompare(a_version, b_version)
777     if q:
778         return q
779
780     # Sort by 'have source'
781     a_has_source = a_changes["architecture"].get("source")
782     b_has_source = b_changes["architecture"].get("source")
783     if a_has_source and not b_has_source:
784         return -1
785     elif b_has_source and not a_has_source:
786         return 1
787
788     # Fall back to sort by filename
789     return cmp(a, b)
790
791 ################################################################################
792
793 def find_next_free (dest, too_many=100):
794     extra = 0
795     orig_dest = dest
796     while os.path.exists(dest) and extra < too_many:
797         dest = orig_dest + '.' + repr(extra)
798         extra += 1
799     if extra >= too_many:
800         raise NoFreeFilenameError
801     return dest
802
803 ################################################################################
804
805 def result_join (original, sep = '\t'):
806     resultlist = []
807     for i in xrange(len(original)):
808         if original[i] == None:
809             resultlist.append("")
810         else:
811             resultlist.append(original[i])
812     return sep.join(resultlist)
813
814 ################################################################################
815
816 def prefix_multi_line_string(str, prefix, include_blank_lines=0):
817     out = ""
818     for line in str.split('\n'):
819         line = line.strip()
820         if line or include_blank_lines:
821             out += "%s%s\n" % (prefix, line)
822     # Strip trailing new line
823     if out:
824         out = out[:-1]
825     return out
826
827 ################################################################################
828
829 def validate_changes_file_arg(filename, require_changes=1):
830     """
831     'filename' is either a .changes or .dak file.  If 'filename' is a
832     .dak file, it's changed to be the corresponding .changes file.  The
833     function then checks if the .changes file a) exists and b) is
834     readable and returns the .changes filename if so.  If there's a
835     problem, the next action depends on the option 'require_changes'
836     argument:
837
838       - If 'require_changes' == -1, errors are ignored and the .changes
839         filename is returned.
840       - If 'require_changes' == 0, a warning is given and 'None' is returned.
841       - If 'require_changes' == 1, a fatal error is raised.
842
843     """
844     error = None
845
846     orig_filename = filename
847     if filename.endswith(".dak"):
848         filename = filename[:-4]+".changes"
849
850     if not filename.endswith(".changes"):
851         error = "invalid file type; not a changes file"
852     else:
853         if not os.access(filename,os.R_OK):
854             if os.path.exists(filename):
855                 error = "permission denied"
856             else:
857                 error = "file not found"
858
859     if error:
860         if require_changes == 1:
861             fubar("%s: %s." % (orig_filename, error))
862         elif require_changes == 0:
863             warn("Skipping %s - %s" % (orig_filename, error))
864             return None
865         else: # We only care about the .dak file
866             return filename
867     else:
868         return filename
869
870 ################################################################################
871
872 def real_arch(arch):
873     return (arch != "source" and arch != "all")
874
875 ################################################################################
876
877 def join_with_commas_and(list):
878     if len(list) == 0: return "nothing"
879     if len(list) == 1: return list[0]
880     return ", ".join(list[:-1]) + " and " + list[-1]
881
882 ################################################################################
883
884 def pp_deps (deps):
885     pp_deps = []
886     for atom in deps:
887         (pkg, version, constraint) = atom
888         if constraint:
889             pp_dep = "%s (%s %s)" % (pkg, constraint, version)
890         else:
891             pp_dep = pkg
892         pp_deps.append(pp_dep)
893     return " |".join(pp_deps)
894
895 ################################################################################
896
897 def get_conf():
898     return Cnf
899
900 ################################################################################
901
902 def parse_args(Options):
903     """ Handle -a, -c and -s arguments; returns them as SQL constraints """
904     # XXX: This should go away and everything which calls it be converted
905     #      to use SQLA properly.  For now, we'll just fix it not to use
906     #      the old Pg interface though
907     session = DBConn().session()
908     # Process suite
909     if Options["Suite"]:
910         suite_ids_list = []
911         for suitename in split_args(Options["Suite"]):
912             suite = get_suite(suitename, session=session)
913             if suite_id is None:
914                 warn("suite '%s' not recognised." % (suitename))
915             else:
916                 suite_ids_list.append(suite.suite_id)
917         if suite_ids_list:
918             con_suites = "AND su.id IN (%s)" % ", ".join([ str(i) for i in suite_ids_list ])
919         else:
920             fubar("No valid suite given.")
921     else:
922         con_suites = ""
923
924     # Process component
925     if Options["Component"]:
926         component_ids_list = []
927         for componentname in split_args(Options["Component"]):
928             component = get_component(componentname, session=session)
929             if component is None:
930                 warn("component '%s' not recognised." % (componentname))
931             else:
932                 component_ids_list.append(component.component_id)
933         if component_ids_list:
934             con_components = "AND c.id IN (%s)" % ", ".join([ str(i) for i in component_ids_list ])
935         else:
936             fubar("No valid component given.")
937     else:
938         con_components = ""
939
940     # Process architecture
941     con_architectures = ""
942     check_source = 0
943     if Options["Architecture"]:
944         arch_ids_list = []
945         for archname in split_args(Options["Architecture"]):
946             if archname == "source":
947                 check_source = 1
948             else:
949                 arch = get_architecture(archname, session=session)
950                 if arch is None:
951                     warn("architecture '%s' not recognised." % (archname))
952                 else:
953                     arch_ids_list.append(arch.arch_id)
954         if arch_ids_list:
955             con_architectures = "AND a.id IN (%s)" % ", ".join([ str(i) for i in arch_ids_list ])
956         else:
957             if not check_source:
958                 fubar("No valid architecture given.")
959     else:
960         check_source = 1
961
962     return (con_suites, con_architectures, con_components, check_source)
963
964 ################################################################################
965
966 # Inspired(tm) by Bryn Keller's print_exc_plus (See
967 # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52215)
968
969 def print_exc():
970     tb = sys.exc_info()[2]
971     while tb.tb_next:
972         tb = tb.tb_next
973     stack = []
974     frame = tb.tb_frame
975     while frame:
976         stack.append(frame)
977         frame = frame.f_back
978     stack.reverse()
979     traceback.print_exc()
980     for frame in stack:
981         print "\nFrame %s in %s at line %s" % (frame.f_code.co_name,
982                                              frame.f_code.co_filename,
983                                              frame.f_lineno)
984         for key, value in frame.f_locals.items():
985             print "\t%20s = " % key,
986             try:
987                 print value
988             except:
989                 print "<unable to print>"
990
991 ################################################################################
992
993 def try_with_debug(function):
994     try:
995         function()
996     except SystemExit:
997         raise
998     except:
999         print_exc()
1000
1001 ################################################################################
1002
1003 def arch_compare_sw (a, b):
1004     """
1005     Function for use in sorting lists of architectures.
1006
1007     Sorts normally except that 'source' dominates all others.
1008     """
1009
1010     if a == "source" and b == "source":
1011         return 0
1012     elif a == "source":
1013         return -1
1014     elif b == "source":
1015         return 1
1016
1017     return cmp (a, b)
1018
1019 ################################################################################
1020
1021 def split_args (s, dwim=1):
1022     """
1023     Split command line arguments which can be separated by either commas
1024     or whitespace.  If dwim is set, it will complain about string ending
1025     in comma since this usually means someone did 'dak ls -a i386, m68k
1026     foo' or something and the inevitable confusion resulting from 'm68k'
1027     being treated as an argument is undesirable.
1028     """
1029
1030     if s.find(",") == -1:
1031         return s.split()
1032     else:
1033         if s[-1:] == "," and dwim:
1034             fubar("split_args: found trailing comma, spurious space maybe?")
1035         return s.split(",")
1036
1037 ################################################################################
1038
1039 def Dict(**dict): return dict
1040
1041 ########################################
1042
1043 def gpgv_get_status_output(cmd, status_read, status_write):
1044     """
1045     Our very own version of commands.getouputstatus(), hacked to support
1046     gpgv's status fd.
1047     """
1048
1049     cmd = ['/bin/sh', '-c', cmd]
1050     p2cread, p2cwrite = os.pipe()
1051     c2pread, c2pwrite = os.pipe()
1052     errout, errin = os.pipe()
1053     pid = os.fork()
1054     if pid == 0:
1055         # Child
1056         os.close(0)
1057         os.close(1)
1058         os.dup(p2cread)
1059         os.dup(c2pwrite)
1060         os.close(2)
1061         os.dup(errin)
1062         for i in range(3, 256):
1063             if i != status_write:
1064                 try:
1065                     os.close(i)
1066                 except:
1067                     pass
1068         try:
1069             os.execvp(cmd[0], cmd)
1070         finally:
1071             os._exit(1)
1072
1073     # Parent
1074     os.close(p2cread)
1075     os.dup2(c2pread, c2pwrite)
1076     os.dup2(errout, errin)
1077
1078     output = status = ""
1079     while 1:
1080         i, o, e = select.select([c2pwrite, errin, status_read], [], [])
1081         more_data = []
1082         for fd in i:
1083             r = os.read(fd, 8196)
1084             if len(r) > 0:
1085                 more_data.append(fd)
1086                 if fd == c2pwrite or fd == errin:
1087                     output += r
1088                 elif fd == status_read:
1089                     status += r
1090                 else:
1091                     fubar("Unexpected file descriptor [%s] returned from select\n" % (fd))
1092         if not more_data:
1093             pid, exit_status = os.waitpid(pid, 0)
1094             try:
1095                 os.close(status_write)
1096                 os.close(status_read)
1097                 os.close(c2pread)
1098                 os.close(c2pwrite)
1099                 os.close(p2cwrite)
1100                 os.close(errin)
1101                 os.close(errout)
1102             except:
1103                 pass
1104             break
1105
1106     return output, status, exit_status
1107
1108 ################################################################################
1109
1110 def process_gpgv_output(status):
1111     # Process the status-fd output
1112     keywords = {}
1113     internal_error = ""
1114     for line in status.split('\n'):
1115         line = line.strip()
1116         if line == "":
1117             continue
1118         split = line.split()
1119         if len(split) < 2:
1120             internal_error += "gpgv status line is malformed (< 2 atoms) ['%s'].\n" % (line)
1121             continue
1122         (gnupg, keyword) = split[:2]
1123         if gnupg != "[GNUPG:]":
1124             internal_error += "gpgv status line is malformed (incorrect prefix '%s').\n" % (gnupg)
1125             continue
1126         args = split[2:]
1127         if keywords.has_key(keyword) and keyword not in [ "NODATA", "SIGEXPIRED", "KEYEXPIRED" ]:
1128             internal_error += "found duplicate status token ('%s').\n" % (keyword)
1129             continue
1130         else:
1131             keywords[keyword] = args
1132
1133     return (keywords, internal_error)
1134
1135 ################################################################################
1136
1137 def retrieve_key (filename, keyserver=None, keyring=None):
1138     """
1139     Retrieve the key that signed 'filename' from 'keyserver' and
1140     add it to 'keyring'.  Returns nothing on success, or an error message
1141     on error.
1142     """
1143
1144     # Defaults for keyserver and keyring
1145     if not keyserver:
1146         keyserver = Cnf["Dinstall::KeyServer"]
1147     if not keyring:
1148         keyring = Cnf.ValueList("Dinstall::GPGKeyring")[0]
1149
1150     # Ensure the filename contains no shell meta-characters or other badness
1151     if not re_taint_free.match(filename):
1152         return "%s: tainted filename" % (filename)
1153
1154     # Invoke gpgv on the file
1155     status_read, status_write = os.pipe()
1156     cmd = "gpgv --status-fd %s --keyring /dev/null %s" % (status_write, filename)
1157     (_, status, _) = gpgv_get_status_output(cmd, status_read, status_write)
1158
1159     # Process the status-fd output
1160     (keywords, internal_error) = process_gpgv_output(status)
1161     if internal_error:
1162         return internal_error
1163
1164     if not keywords.has_key("NO_PUBKEY"):
1165         return "didn't find expected NO_PUBKEY in gpgv status-fd output"
1166
1167     fingerprint = keywords["NO_PUBKEY"][0]
1168     # XXX - gpg sucks.  You can't use --secret-keyring=/dev/null as
1169     # it'll try to create a lockfile in /dev.  A better solution might
1170     # be a tempfile or something.
1171     cmd = "gpg --no-default-keyring --secret-keyring=%s --no-options" \
1172           % (Cnf["Dinstall::SigningKeyring"])
1173     cmd += " --keyring %s --keyserver %s --recv-key %s" \
1174            % (keyring, keyserver, fingerprint)
1175     (result, output) = commands.getstatusoutput(cmd)
1176     if (result != 0):
1177         return "'%s' failed with exit code %s" % (cmd, result)
1178
1179     return ""
1180
1181 ################################################################################
1182
1183 def gpg_keyring_args(keyrings=None):
1184     if not keyrings:
1185         keyrings = Cnf.ValueList("Dinstall::GPGKeyring")
1186
1187     return " ".join(["--keyring %s" % x for x in keyrings])
1188
1189 ################################################################################
1190
1191 def check_signature (sig_filename, reject, data_filename="", keyrings=None, autofetch=None):
1192     """
1193     Check the signature of a file and return the fingerprint if the
1194     signature is valid or 'None' if it's not.  The first argument is the
1195     filename whose signature should be checked.  The second argument is a
1196     reject function and is called when an error is found.  The reject()
1197     function must allow for two arguments: the first is the error message,
1198     the second is an optional prefix string.  It's possible for reject()
1199     to be called more than once during an invocation of check_signature().
1200     The third argument is optional and is the name of the files the
1201     detached signature applies to.  The fourth argument is optional and is
1202     a *list* of keyrings to use.  'autofetch' can either be None, True or
1203     False.  If None, the default behaviour specified in the config will be
1204     used.
1205     """
1206
1207     # Ensure the filename contains no shell meta-characters or other badness
1208     if not re_taint_free.match(sig_filename):
1209         reject("!!WARNING!! tainted signature filename: '%s'." % (sig_filename))
1210         return None
1211
1212     if data_filename and not re_taint_free.match(data_filename):
1213         reject("!!WARNING!! tainted data filename: '%s'." % (data_filename))
1214         return None
1215
1216     if not keyrings:
1217         keyrings = Cnf.ValueList("Dinstall::GPGKeyring")
1218
1219     # Autofetch the signing key if that's enabled
1220     if autofetch == None:
1221         autofetch = Cnf.get("Dinstall::KeyAutoFetch")
1222     if autofetch:
1223         error_msg = retrieve_key(sig_filename)
1224         if error_msg:
1225             reject(error_msg)
1226             return None
1227
1228     # Build the command line
1229     status_read, status_write = os.pipe()
1230     cmd = "gpgv --status-fd %s %s %s %s" % (
1231         status_write, gpg_keyring_args(keyrings), sig_filename, data_filename)
1232
1233     # Invoke gpgv on the file
1234     (output, status, exit_status) = gpgv_get_status_output(cmd, status_read, status_write)
1235
1236     # Process the status-fd output
1237     (keywords, internal_error) = process_gpgv_output(status)
1238
1239     # If we failed to parse the status-fd output, let's just whine and bail now
1240     if internal_error:
1241         reject("internal error while performing signature check on %s." % (sig_filename))
1242         reject(internal_error, "")
1243         reject("Please report the above errors to the Archive maintainers by replying to this mail.", "")
1244         return None
1245
1246     bad = ""
1247     # Now check for obviously bad things in the processed output
1248     if keywords.has_key("KEYREVOKED"):
1249         reject("The key used to sign %s has been revoked." % (sig_filename))
1250         bad = 1
1251     if keywords.has_key("BADSIG"):
1252         reject("bad signature on %s." % (sig_filename))
1253         bad = 1
1254     if keywords.has_key("ERRSIG") and not keywords.has_key("NO_PUBKEY"):
1255         reject("failed to check signature on %s." % (sig_filename))
1256         bad = 1
1257     if keywords.has_key("NO_PUBKEY"):
1258         args = keywords["NO_PUBKEY"]
1259         if len(args) >= 1:
1260             key = args[0]
1261         reject("The key (0x%s) used to sign %s wasn't found in the keyring(s)." % (key, sig_filename))
1262         bad = 1
1263     if keywords.has_key("BADARMOR"):
1264         reject("ASCII armour of signature was corrupt in %s." % (sig_filename))
1265         bad = 1
1266     if keywords.has_key("NODATA"):
1267         reject("no signature found in %s." % (sig_filename))
1268         bad = 1
1269     if keywords.has_key("EXPKEYSIG"):
1270         args = keywords["EXPKEYSIG"]
1271         if len(args) >= 1:
1272             key = args[0]
1273         reject("Signature made by expired key 0x%s" % (key))
1274         bad = 1
1275     if keywords.has_key("KEYEXPIRED") and not keywords.has_key("GOODSIG"):
1276         args = keywords["KEYEXPIRED"]
1277         expiredate=""
1278         if len(args) >= 1:
1279             timestamp = args[0]
1280             if timestamp.count("T") == 0:
1281                 try:
1282                     expiredate = time.strftime("%Y-%m-%d", time.gmtime(float(timestamp)))
1283                 except ValueError:
1284                     expiredate = "unknown (%s)" % (timestamp)
1285             else:
1286                 expiredate = timestamp
1287         reject("The key used to sign %s has expired on %s" % (sig_filename, expiredate))
1288         bad = 1
1289
1290     if bad:
1291         return None
1292
1293     # Next check gpgv exited with a zero return code
1294     if exit_status:
1295         reject("gpgv failed while checking %s." % (sig_filename))
1296         if status.strip():
1297             reject(prefix_multi_line_string(status, " [GPG status-fd output:] "), "")
1298         else:
1299             reject(prefix_multi_line_string(output, " [GPG output:] "), "")
1300         return None
1301
1302     # Sanity check the good stuff we expect
1303     if not keywords.has_key("VALIDSIG"):
1304         reject("signature on %s does not appear to be valid [No VALIDSIG]." % (sig_filename))
1305         bad = 1
1306     else:
1307         args = keywords["VALIDSIG"]
1308         if len(args) < 1:
1309             reject("internal error while checking signature on %s." % (sig_filename))
1310             bad = 1
1311         else:
1312             fingerprint = args[0]
1313     if not keywords.has_key("GOODSIG"):
1314         reject("signature on %s does not appear to be valid [No GOODSIG]." % (sig_filename))
1315         bad = 1
1316     if not keywords.has_key("SIG_ID"):
1317         reject("signature on %s does not appear to be valid [No SIG_ID]." % (sig_filename))
1318         bad = 1
1319
1320     # Finally ensure there's not something we don't recognise
1321     known_keywords = Dict(VALIDSIG="",SIG_ID="",GOODSIG="",BADSIG="",ERRSIG="",
1322                           SIGEXPIRED="",KEYREVOKED="",NO_PUBKEY="",BADARMOR="",
1323                           NODATA="",NOTATION_DATA="",NOTATION_NAME="",KEYEXPIRED="")
1324
1325     for keyword in keywords.keys():
1326         if not known_keywords.has_key(keyword):
1327             reject("found unknown status token '%s' from gpgv with args '%r' in %s." % (keyword, keywords[keyword], sig_filename))
1328             bad = 1
1329
1330     if bad:
1331         return None
1332     else:
1333         return fingerprint
1334
1335 ################################################################################
1336
1337 def gpg_get_key_addresses(fingerprint):
1338     """retreive email addresses from gpg key uids for a given fingerprint"""
1339     addresses = key_uid_email_cache.get(fingerprint)
1340     if addresses != None:
1341         return addresses
1342     addresses = set()
1343     cmd = "gpg --no-default-keyring %s --fingerprint %s" \
1344                 % (gpg_keyring_args(), fingerprint)
1345     (result, output) = commands.getstatusoutput(cmd)
1346     if result == 0:
1347         for l in output.split('\n'):
1348             m = re_gpg_uid.match(l)
1349             if m:
1350                 addresses.add(m.group(1))
1351     key_uid_email_cache[fingerprint] = addresses
1352     return addresses
1353
1354 ################################################################################
1355
1356 # Inspired(tm) by http://www.zopelabs.com/cookbook/1022242603
1357
1358 def wrap(paragraph, max_length, prefix=""):
1359     line = ""
1360     s = ""
1361     have_started = 0
1362     words = paragraph.split()
1363
1364     for word in words:
1365         word_size = len(word)
1366         if word_size > max_length:
1367             if have_started:
1368                 s += line + '\n' + prefix
1369             s += word + '\n' + prefix
1370         else:
1371             if have_started:
1372                 new_length = len(line) + word_size + 1
1373                 if new_length > max_length:
1374                     s += line + '\n' + prefix
1375                     line = word
1376                 else:
1377                     line += ' ' + word
1378             else:
1379                 line = word
1380         have_started = 1
1381
1382     if have_started:
1383         s += line
1384
1385     return s
1386
1387 ################################################################################
1388
1389 def clean_symlink (src, dest, root):
1390     """
1391     Relativize an absolute symlink from 'src' -> 'dest' relative to 'root'.
1392     Returns fixed 'src'
1393     """
1394     src = src.replace(root, '', 1)
1395     dest = dest.replace(root, '', 1)
1396     dest = os.path.dirname(dest)
1397     new_src = '../' * len(dest.split('/'))
1398     return new_src + src
1399
1400 ################################################################################
1401
1402 def temp_filename(directory=None, prefix="dak", suffix=""):
1403     """
1404     Return a secure and unique filename by pre-creating it.
1405     If 'directory' is non-null, it will be the directory the file is pre-created in.
1406     If 'prefix' is non-null, the filename will be prefixed with it, default is dak.
1407     If 'suffix' is non-null, the filename will end with it.
1408
1409     Returns a pair (fd, name).
1410     """
1411
1412     return tempfile.mkstemp(suffix, prefix, directory)
1413
1414 ################################################################################
1415
1416 def temp_dirname(parent=None, prefix="dak", suffix=""):
1417     """
1418     Return a secure and unique directory by pre-creating it.
1419     If 'parent' is non-null, it will be the directory the directory is pre-created in.
1420     If 'prefix' is non-null, the filename will be prefixed with it, default is dak.
1421     If 'suffix' is non-null, the filename will end with it.
1422
1423     Returns a pathname to the new directory
1424     """
1425
1426     return tempfile.mkdtemp(suffix, prefix, parent)
1427
1428 ################################################################################
1429
1430 def is_email_alias(email):
1431     """ checks if the user part of the email is listed in the alias file """
1432     global alias_cache
1433     if alias_cache == None:
1434         aliasfn = which_alias_file()
1435         alias_cache = set()
1436         if aliasfn:
1437             for l in open(aliasfn):
1438                 alias_cache.add(l.split(':')[0])
1439     uid = email.split('@')[0]
1440     return uid in alias_cache
1441
1442 ################################################################################
1443
1444 def get_changes_files(dir):
1445     """
1446     Takes a directory and lists all .changes files in it (as well as chdir'ing
1447     to the directory; this is due to broken behaviour on the part of p-u/p-a
1448     when you're not in the right place)
1449
1450     Returns a list of filenames
1451     """
1452     try:
1453         # Much of the rest of p-u/p-a depends on being in the right place
1454         os.chdir(dir)
1455         changes_files = [x for x in os.listdir(dir) if x.endswith('.changes')]
1456     except OSError, e:
1457         fubar("Failed to read list from directory %s (%s)" % (dir, e))
1458
1459     return changes_files
1460
1461 ################################################################################
1462
1463 apt_pkg.init()
1464
1465 Cnf = apt_pkg.newConfiguration()
1466 apt_pkg.ReadConfigFileISC(Cnf,default_config)
1467
1468 if which_conf_file() != default_config:
1469     apt_pkg.ReadConfigFileISC(Cnf,which_conf_file())
1470
1471 ###############################################################################