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