utils.py

   1 # Utility functions
   2 # Copyright (C) 2000, 2001  James Troup <james@nocrew.org>
   3 # $Id: utils.py,v 1.36 2001-11-18 19:57:58 rmurray Exp $
   4
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18
  19 import commands, os, pwd, re, socket, shutil, stat, string, sys, tempfile
  20 import apt_pkg
  21
  22 re_comments = re.compile(r"\#.*")
  23 re_no_epoch = re.compile(r"^\d*\:")
  24 re_no_revision = re.compile(r"\-[^-]*$")
  25 re_arch_from_filename = re.compile(r"/binary-[^/]+/")
  26 re_extract_src_version = re.compile (r"(\S+)\s*\((.*)\)")
  27 re_isadeb = re.compile (r".*\.u?deb$");
  28 re_issource = re.compile (r"(.+)_(.+?)\.(orig\.tar\.gz|diff\.gz|tar\.gz|dsc)");
  29
  30 re_single_line_field = re.compile(r"^(\S*)\s*:\s*(.*)");
  31 re_multi_line_field = re.compile(r"^\s(.*)");
  32 re_taint_free = re.compile(r"^[-+\.\w]+$");
  33
  34 re_parse_maintainer = re.compile(r"^\s*(\S.*\S)\s*\<([^\> \t]+)\>");
  35
  36 changes_parse_error_exc = "Can't parse line in .changes file";
  37 invalid_dsc_format_exc = "Invalid .dsc file";
  38 nk_format_exc = "Unknown Format: in .changes file";
  39 no_files_exc = "No Files: field in .dsc file.";
  40 cant_open_exc = "Can't read file.";
  41 unknown_hostname_exc = "Unknown hostname";
  42 cant_overwrite_exc = "Permission denied; can't overwrite existent file."
  43 file_exists_exc = "Destination file exists";
  44 send_mail_invalid_args_exc = "Both arguments are non-null.";
  45 sendmail_failed_exc = "Sendmail invocation failed";
  46 tried_too_hard_exc = "Tried too hard to find a free filename.";
  47
  48 default_config = "/etc/katie/katie.conf";
  49 default_apt_config = "/etc/katie/apt.conf";
  50
  51 ######################################################################################
  52
  53 def open_file(filename, mode='r'):
  54     try:
  55         f = open(filename, mode);
  56     except IOError:
  57         raise cant_open_exc, filename
  58     return f
  59
  60 def touch_file(filename):
  61     fd = os.open(filename, os.O_RDONLY | os.O_CREAT);
  62     os.close(fd);
  63
  64 ######################################################################################
  65
  66 # From reportbug
  67 def our_raw_input():
  68     sys.stdout.flush()
  69     try:
  70         ret = raw_input()
  71         return ret
  72     except EOFError:
  73         sys.stderr.write('\nUser interrupt (^D).\n')
  74         raise SystemExit
  75
  76 ######################################################################################
  77
  78 def str_isnum (s):
  79     for c in s:
  80         if c not in string.digits:
  81             return 0;
  82     return 1;
  83
  84 ######################################################################################
  85
  86 def extract_component_from_section(section):
  87     component = "";
  88
  89     if string.find(section, '/') != -1:
  90         component = string.split(section, '/')[0];
  91     if string.lower(component) == "non-us" and string.count(section, '/') > 0:
  92         s = string.split(section, '/')[1];
  93         if Cnf.has_key("Component::%s" % s): # Avoid e.g. non-US/libs
  94             component = string.split(section, '/')[0]+ '/' + string.split(section, '/')[1];
  95
  96     if string.lower(section) == "non-us":
  97         component = "non-US/main";
  98
  99     # non-US prefix is case insensitive
 100     if string.lower(component)[:6] == "non-us":
 101         component = "non-US"+component[6:];
 102
 103     # Expand default component
 104     if component == "":
 105         if Cnf.has_key("Component::%s" % section):
 106             component = section;
 107         else:
 108             component = "main";
 109     elif component == "non-US":
 110         component = "non-US/main";
 111
 112     return (section, component);
 113
 114 ######################################################################################
 115
 116 # dsc_whitespace_rules turns on strict format checking to avoid
 117 # allowing in source packages which are unextracable by the
 118 # inappropriately fragile dpkg-source.
 119 #
 120 # The rules are:
 121 #
 122 #
 123 # o The PGP header consists of "-----BEGIN PGP SIGNED MESSAGE-----"
 124 #   followed by any PGP header data and must end with a blank line.
 125 #
 126 # o The data section must end with a blank line and must be followed by
 127 #   "-----BEGIN PGP SIGNATURE-----".
 128
 129 def parse_changes(filename, dsc_whitespace_rules):
 130     changes_in = open_file(filename);
 131     error = "";
 132     changes = {};
 133     lines = changes_in.readlines();
 134
 135     if not lines:
 136         raise changes_parse_error_exc, "[Empty changes file]";
 137
 138     # Reindex by line number so we can easily verify the format of
 139     # .dsc files...
 140     index = 0;
 141     indexed_lines = {};
 142     for line in lines:
 143         index = index + 1;
 144         indexed_lines[index] = line[:-1];
 145
 146     inside_signature = 0;
 147
 148     indices = indexed_lines.keys()
 149     index = 0;
 150     while index < max(indices):
 151         index = index + 1;
 152         line = indexed_lines[index];
 153         if line == "":
 154             if dsc_whitespace_rules:
 155                 index = index + 1;
 156                 if index > max(indices):
 157                     raise invalid_dsc_format_exc, index;
 158                 line = indexed_lines[index];
 159                 if string.find(line, "-----BEGIN PGP SIGNATURE") != 0:
 160                     raise invalid_dsc_format_exc, index;
 161                 inside_signature = 0;
 162                 break;
 163         if string.find(line, "-----BEGIN PGP SIGNATURE") == 0:
 164             break;
 165         if string.find(line, "-----BEGIN PGP SIGNED MESSAGE") == 0:
 166             if dsc_whitespace_rules:
 167                 inside_signature = 1;
 168                 while index < max(indices) and line != "":
 169                     index = index + 1;
 170                     line = indexed_lines[index];
 171             continue;
 172         slf = re_single_line_field.match(line);
 173         if slf:
 174             field = string.lower(slf.groups()[0]);
 175             changes[field] = slf.groups()[1];
 176             first = 1;
 177             continue;
 178         if line == " .":
 179             changes[field] = changes[field] + '\n';
 180             continue;
 181         mlf = re_multi_line_field.match(line);
 182         if mlf:
 183             if first == 1 and changes[field] != "":
 184                 changes[field] = changes[field] + '\n';
 185             first = 0;
 186             changes[field] = changes[field] + mlf.groups()[0] + '\n';
 187             continue;
 188         error = error + line;
 189
 190     if dsc_whitespace_rules and inside_signature:
 191         raise invalid_dsc_format_exc, index;
 192
 193     changes_in.close();
 194     changes["filecontents"] = string.join (lines, "");
 195
 196     if error != "":
 197         raise changes_parse_error_exc, error;
 198
 199     return changes;
 200
 201 ######################################################################################
 202
 203 # Dropped support for 1.4 and ``buggy dchanges 3.4'' (?!) compared to di.pl
 204
 205 def build_file_list(changes, dsc):
 206     files = {}
 207     format = changes.get("format", "")
 208     if format != "":
 209         format = float(format)
 210     if dsc == "" and (format < 1.5 or format > 2.0):
 211         raise nk_format_exc, format;
 212
 213     # No really, this has happened.  Think 0 length .dsc file.
 214     if not changes.has_key("files"):
 215         raise no_files_exc
 216
 217     for i in string.split(changes["files"], "\n"):
 218         if i == "":
 219             break
 220         s = string.split(i)
 221         section = priority = "";
 222         try:
 223             if dsc != "":
 224                 (md5, size, name) = s
 225             else:
 226                 (md5, size, section, priority, name) = s
 227         except ValueError:
 228             raise changes_parse_error_exc, i
 229
 230         if section == "": section = "-"
 231         if priority == "": priority = "-"
 232
 233         (section, component) = extract_component_from_section(section);
 234
 235         files[name] = { "md5sum" : md5,
 236                         "size" : size,
 237                         "section": section,
 238                         "priority": priority,
 239                         "component": component }
 240
 241     return files
 242
 243 ######################################################################################
 244
 245 # Fix the `Maintainer:' field to be an RFC822 compatible address.
 246 # cf. Packaging Manual (4.2.4)
 247 #
 248 # 06:28|<Culus> 'The standard sucks, but my tool is supposed to
 249 #                interoperate with it. I know - I'll fix the suckage
 250 #                and make things incompatible!'
 251
 252 def fix_maintainer (maintainer):
 253     m = re_parse_maintainer.match(maintainer);
 254     rfc822 = maintainer
 255     name = ""
 256     email = ""
 257     if m != None and len(m.groups()) == 2:
 258         name = m.group(1)
 259         email = m.group(2)
 260         if string.find(name, ',') != -1 or string.find(name, '.') != -1:
 261             rfc822 = re_parse_maintainer.sub(r"\2 (\1)", maintainer)
 262     return (rfc822, name, email)
 263
 264 ######################################################################################
 265
 266 # sendmail wrapper, takes _either_ a message string or a file as arguments
 267 def send_mail (message, filename):
 268         # Sanity check arguments
 269         if message != "" and filename != "":
 270             raise send_mail_invalid_args_exc;
 271
 272         # If we've been passed a string dump it into a temporary file
 273         if message != "":
 274             filename = tempfile.mktemp();
 275             fd = os.open(filename, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700);
 276             os.write (fd, message);
 277             os.close (fd);
 278
 279         # Invoke sendmail
 280         (result, output) = commands.getstatusoutput("%s < %s" % (Cnf["Dinstall::SendmailCommand"], filename));
 281         if (result != 0):
 282             raise sendmail_failed_exc, output;
 283
 284         # Clean up any temporary files
 285         if message !="":
 286             os.unlink (filename);
 287
 288 ######################################################################################
 289
 290 def poolify (source, component):
 291     if component != "":
 292         component = component + '/';
 293     # FIXME: this is nasty
 294     component = string.lower(component);
 295     component = string.replace(component, 'non-us/', 'non-US/');
 296     if source[:3] == "lib":
 297         return component + source[:4] + '/' + source + '/'
 298     else:
 299         return component + source[:1] + '/' + source + '/'
 300
 301 ######################################################################################
 302
 303 def move (src, dest, overwrite = 0):
 304     if os.path.exists(dest) and os.path.isdir(dest):
 305         dest_dir = dest;
 306     else:
 307         dest_dir = os.path.dirname(dest);
 308     if not os.path.exists(dest_dir):
 309         umask = os.umask(00000);
 310         os.makedirs(dest_dir, 02775);
 311         os.umask(umask);
 312     #print "Moving %s to %s..." % (src, dest);
 313     if os.path.exists(dest) and os.path.isdir(dest):
 314         dest = dest + '/' + os.path.basename(src);
 315     # Don't overwrite unless forced to
 316     if os.path.exists(dest):
 317         if not overwrite:
 318             raise file_exists_exc;
 319         else:
 320             if not os.access(dest, os.W_OK):
 321                 raise cant_overwrite_exc
 322     shutil.copy2(src, dest);
 323     os.chmod(dest, 0664);
 324     os.unlink(src);
 325
 326 def copy (src, dest, overwrite = 0):
 327     if os.path.exists(dest) and os.path.isdir(dest):
 328         dest_dir = dest;
 329     else:
 330         dest_dir = os.path.dirname(dest);
 331     if not os.path.exists(dest_dir):
 332         umask = os.umask(00000);
 333         os.makedirs(dest_dir, 02775);
 334         os.umask(umask);
 335     #print "Copying %s to %s..." % (src, dest);
 336     if os.path.exists(dest) and os.path.isdir(dest):
 337         dest = dest + '/' + os.path.basename(src);
 338     # Don't overwrite unless forced to
 339     if os.path.exists(dest):
 340         if not overwrite:
 341             raise file_exists_exc
 342         else:
 343             if not os.access(dest, os.W_OK):
 344                 raise cant_overwrite_exc
 345     shutil.copy2(src, dest);
 346     os.chmod(dest, 0664);
 347
 348 ######################################################################################
 349
 350 def where_am_i ():
 351     res = socket.gethostbyaddr(socket.gethostname());
 352     database_hostname = Cnf.get("Config::" + res[0] + "::DatabaseHostname");
 353     if database_hostname:
 354         return database_hostname;
 355     else:
 356         return res[0];
 357
 358 def which_conf_file ():
 359     res = socket.gethostbyaddr(socket.gethostname());
 360     if Cnf.get("Config::" + res[0] + "::KatieConfig"):
 361         return Cnf["Config::" + res[0] + "::KatieConfig"]
 362     else:
 363         return default_config;
 364
 365 def which_apt_conf_file ():
 366     res = socket.gethostbyaddr(socket.gethostname());
 367     if Cnf.get("Config::" + res[0] + "::AptConfig"):
 368         return Cnf["Config::" + res[0] + "::AptConfig"]
 369     else:
 370         return default_apt_config;
 371
 372 ######################################################################################
 373
 374 # Escape characters which have meaning to SQL's regex comparison operator ('~')
 375 # (woefully incomplete)
 376
 377 def regex_safe (s):
 378     s = string.replace(s, '+', '\\\\+');
 379     s = string.replace(s, '.', '\\\\.');
 380     return s
 381
 382 ######################################################################################
 383
 384 # Perform a substition of template
 385 def TemplateSubst(Map,Template):
 386     for x in Map.keys():
 387         Template = string.replace(Template,x,Map[x]);
 388     return Template;
 389
 390 ######################################################################################
 391
 392 def fubar(msg, exit_code=1):
 393     sys.stderr.write("E: %s\n" % (msg));
 394     sys.exit(exit_code);
 395
 396 def warn(msg):
 397     sys.stderr.write("W: %s\n" % (msg));
 398
 399 ######################################################################################
 400
 401 # Returns the user name with a laughable attempt at rfc822 conformancy
 402 # (read: removing stray periods).
 403 def whoami ():
 404     return string.replace(string.split(pwd.getpwuid(os.getuid())[4],',')[0], '.', '');
 405
 406 ######################################################################################
 407
 408 def size_type (c):
 409     t  = " b";
 410     if c > 10000:
 411         c = c / 1000;
 412         t = " Kb";
 413     if c > 10000:
 414         c = c / 1000;
 415         t = " Mb";
 416     return ("%d%s" % (c, t))
 417
 418 ################################################################################
 419
 420 def cc_fix_changes (changes):
 421     o = changes.get("architecture", "")
 422     if o != "":
 423         del changes["architecture"]
 424     changes["architecture"] = {}
 425     for j in string.split(o):
 426         changes["architecture"][j] = 1
 427
 428 # Sort by 'have source', by source name, by source version number, by filename
 429
 430 def changes_compare (a, b):
 431     try:
 432         a_changes = parse_changes(a, 0)
 433     except:
 434         return -1;
 435
 436     try:
 437         b_changes = parse_changes(b, 0)
 438     except:
 439         return 1;
 440
 441     cc_fix_changes (a_changes);
 442     cc_fix_changes (b_changes);
 443
 444     # Sort by 'have source'
 445
 446     a_has_source = a_changes["architecture"].get("source")
 447     b_has_source = b_changes["architecture"].get("source")
 448     if a_has_source and not b_has_source:
 449         return -1;
 450     elif b_has_source and not a_has_source:
 451         return 1;
 452
 453     # Sort by source name
 454
 455     a_source = a_changes.get("source");
 456     b_source = b_changes.get("source");
 457     q = cmp (a_source, b_source);
 458     if q:
 459         return q;
 460
 461     # Sort by source version
 462
 463     a_version = a_changes.get("version");
 464     b_version = b_changes.get("version");
 465     q = apt_pkg.VersionCompare(a_version, b_version);
 466     if q:
 467         return q
 468
 469     # Fall back to sort by filename
 470
 471     return cmp(a, b);
 472
 473 ################################################################################
 474
 475 def find_next_free (dest, too_many=100):
 476     extra = 0;
 477     orig_dest = dest;
 478     while os.path.exists(dest) and extra < too_many:
 479         dest = orig_dest + '.' + repr(extra);
 480         extra = extra + 1;
 481     if extra >= too_many:
 482         raise tried_too_hard_exc;
 483     return dest;
 484
 485 ################################################################################
 486
 487 def result_join (original, sep = '\t'):
 488     list = [];
 489     for i in xrange(len(original)):
 490         if original[i] == None:
 491             list.append("");
 492         else:
 493             list.append(original[i]);
 494     return string.join(list, sep);
 495
 496 ################################################################################
 497
 498 def get_conf():
 499         return Cnf;
 500
 501 ################################################################################
 502
 503 apt_pkg.init()
 504
 505 Cnf = apt_pkg.newConfiguration();
 506 apt_pkg.ReadConfigFileISC(Cnf,default_config);
 507
 508 if which_conf_file() != default_config:
 509         apt_pkg.ReadConfigFileISC(Cnf,which_conf_file())
 510
 511 ################################################################################