2 # Copyright (C) 2000, 2001 James Troup <james@nocrew.org>
3 # $Id: utils.py,v 1.33 2001-09-26 03:49:16 troup Exp $
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.
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.
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
19 import commands, os, pwd, re, socket, shutil, stat, string, sys, tempfile
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)");
30 re_single_line_field = re.compile(r"^(\S*)\s*:\s*(.*)");
31 re_multi_line_field = re.compile(r"^\s(.*)");
33 re_parse_maintainer = re.compile(r"^\s*(\S.*\S)\s*\<([^\> \t]+)\>");
35 changes_parse_error_exc = "Can't parse line in .changes file";
36 invalid_dsc_format_exc = "Invalid .dsc file";
37 nk_format_exc = "Unknown Format: in .changes file";
38 no_files_exc = "No Files: field in .dsc file.";
39 cant_open_exc = "Can't read file.";
40 unknown_hostname_exc = "Unknown hostname";
41 cant_overwrite_exc = "Permission denied; can't overwrite existent file."
42 file_exists_exc = "Destination file exists";
43 send_mail_invalid_args_exc = "Both arguments are non-null.";
44 sendmail_failed_exc = "Sendmail invocation failed";
45 tried_too_hard_exc = "Tried too hard to find a free filename.";
47 # Valid components; used by extract_component_from_section() because
48 # it doesn't know about Conf from it's caller. FIXME
56 default_config = "/etc/katie/katie.conf";
57 default_apt_config = "/etc/katie/apt.conf";
58 DefaultCnf = apt_pkg.newConfiguration();
59 apt_pkg.ReadConfigFileISC(DefaultCnf,default_config);
61 ######################################################################################
63 def open_file(filename, mode='r'):
65 f = open(filename, mode);
67 raise cant_open_exc, filename
70 ######################################################################################
79 sys.stderr.write('\nUser interrupt (^D).\n')
82 ######################################################################################
86 if c not in string.digits:
90 ######################################################################################
92 # Prefix and components hardcoded into this like a good'un; need to unhardcod at some
95 def extract_component_from_section(section):
98 if string.find(section, '/') != -1:
99 component = string.split(section, '/')[0];
100 if string.lower(component) == "non-us" and string.count(section, '/') > 0:
101 s = string.split(section, '/')[1];
102 if valid_components.has_key(s): # Avoid e.g. non-US/libs
103 component = string.split(section, '/')[0]+ '/' + string.split(section, '/')[1];
105 if string.lower(section) == "non-us":
106 component = "non-US/main";
108 # non-US prefix is case insensitive
109 if string.lower(component)[:6] == "non-us":
110 component = "non-US"+component[6:];
112 # Expand default component
114 if valid_components.has_key(section):
118 elif component == "non-US":
119 component = "non-US/main";
121 return (section, component);
123 ######################################################################################
125 # dsc_whitespace_rules turns on strict format checking to avoid
126 # allowing in source packages which are unextracable by the
127 # inappropriately fragile dpkg-source.
132 # o The PGP header consists of "-----BEGIN PGP SIGNED MESSAGE-----"
133 # followed by any PGP header data and must end with a blank line.
135 # o The data section must end with a blank line and must be followed by
136 # "-----BEGIN PGP SIGNATURE-----".
138 def parse_changes(filename, dsc_whitespace_rules):
139 changes_in = open_file(filename,'r');
142 lines = changes_in.readlines();
145 raise changes_parse_error_exc, "[Empty changes file]";
147 # Reindex by line number so we can easily verify the format of
153 indexed_lines[index] = line[:-1];
155 inside_signature = 0;
157 indices = indexed_lines.keys()
159 while index < max(indices):
161 line = indexed_lines[index];
163 if dsc_whitespace_rules:
165 if index > max(indices):
166 raise invalid_dsc_format_exc, index;
167 line = indexed_lines[index];
168 if line[:24] != "-----BEGIN PGP SIGNATURE":
169 raise invalid_dsc_format_exc, index;
170 inside_signature = 0;
172 if line[:24] == "-----BEGIN PGP SIGNATURE":
174 if line[:29] == "-----BEGIN PGP SIGNED MESSAGE":
175 if dsc_whitespace_rules:
176 inside_signature = 1;
177 while index < max(indices) and line != "":
179 line = indexed_lines[index];
181 slf = re_single_line_field.match(line);
183 field = string.lower(slf.groups()[0]);
184 changes[field] = slf.groups()[1];
188 changes[field] = changes[field] + '\n';
190 mlf = re_multi_line_field.match(line);
192 if first == 1 and changes[field] != "":
193 changes[field] = changes[field] + '\n';
195 changes[field] = changes[field] + mlf.groups()[0] + '\n';
197 error = error + line;
199 if dsc_whitespace_rules and inside_signature:
200 raise invalid_dsc_format_exc, index;
203 changes["filecontents"] = string.join (lines, "");
206 raise changes_parse_error_exc, error;
210 ######################################################################################
212 # Dropped support for 1.4 and ``buggy dchanges 3.4'' (?!) compared to di.pl
214 def build_file_list(changes, dsc):
216 format = changes.get("format", "")
218 format = float(format)
219 if dsc == "" and (format < 1.5 or format > 2.0):
220 raise nk_format_exc, format;
222 # No really, this has happened. Think 0 length .dsc file.
223 if not changes.has_key("files"):
226 for i in string.split(changes["files"], "\n"):
230 section = priority = "";
233 (md5, size, name) = s
235 (md5, size, section, priority, name) = s
237 raise changes_parse_error_exc, i
239 if section == "": section = "-"
240 if priority == "": priority = "-"
242 (section, component) = extract_component_from_section(section);
244 files[name] = { "md5sum" : md5,
247 "priority": priority,
248 "component": component }
252 ######################################################################################
254 # Fix the `Maintainer:' field to be an RFC822 compatible address.
255 # cf. Packaging Manual (4.2.4)
257 # 06:28|<Culus> 'The standard sucks, but my tool is supposed to
258 # interoperate with it. I know - I'll fix the suckage
259 # and make things incompatible!'
261 def fix_maintainer (maintainer):
262 m = re_parse_maintainer.match(maintainer);
266 if m != None and len(m.groups()) == 2:
269 if string.find(name, ',') != -1 or string.find(name, '.') != -1:
270 rfc822 = re_parse_maintainer.sub(r"\2 (\1)", maintainer)
271 return (rfc822, name, email)
273 ######################################################################################
275 # sendmail wrapper, takes _either_ a message string or a file as arguments
276 def send_mail (message, filename):
277 #### FIXME, how do I get this out of Cnf in katie?
278 sendmail_command = "/usr/sbin/sendmail -odq -oi -t";
280 # Sanity check arguments
281 if message != "" and filename != "":
282 raise send_mail_invalid_args_exc;
284 # If we've been passed a string dump it into a temporary file
286 filename = tempfile.mktemp();
287 fd = os.open(filename, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700);
288 os.write (fd, message);
292 (result, output) = commands.getstatusoutput("%s < %s" % (sendmail_command, filename));
294 raise sendmail_failed_exc, output;
296 # Clean up any temporary files
298 os.unlink (filename);
300 ######################################################################################
302 def poolify (source, component):
304 component = component + '/';
305 # FIXME: this is nasty
306 component = string.lower(component);
307 component = string.replace(component, 'non-us/', 'non-US/');
308 if source[:3] == "lib":
309 return component + source[:4] + '/' + source + '/'
311 return component + source[:1] + '/' + source + '/'
313 ######################################################################################
315 def move (src, dest, overwrite = 0):
316 if os.path.exists(dest) and os.path.isdir(dest):
319 dest_dir = os.path.dirname(dest);
320 if not os.path.exists(dest_dir):
321 umask = os.umask(00000);
322 os.makedirs(dest_dir, 02775);
324 #print "Moving %s to %s..." % (src, dest);
325 if os.path.exists(dest) and os.path.isdir(dest):
326 dest = dest + '/' + os.path.basename(src);
327 # Don't overwrite unless forced to
328 if os.path.exists(dest):
330 raise file_exists_exc;
332 if not os.access(dest, os.W_OK):
333 raise cant_overwrite_exc
334 shutil.copy2(src, dest);
335 os.chmod(dest, 0664);
338 def copy (src, dest, overwrite = 0):
339 if os.path.exists(dest) and os.path.isdir(dest):
342 dest_dir = os.path.dirname(dest);
343 if not os.path.exists(dest_dir):
344 umask = os.umask(00000);
345 os.makedirs(dest_dir, 02775);
347 #print "Copying %s to %s..." % (src, dest);
348 if os.path.exists(dest) and os.path.isdir(dest):
349 dest = dest + '/' + os.path.basename(src);
350 # Don't overwrite unless forced to
351 if os.path.exists(dest):
353 raise file_exists_exc
355 if not os.access(dest, os.W_OK):
356 raise cant_overwrite_exc
357 shutil.copy2(src, dest);
358 os.chmod(dest, 0664);
360 ######################################################################################
363 res = socket.gethostbyaddr(socket.gethostname());
364 if DefaultCnf.get("Config::" + res[0] + "::DatbaseHostname"):
365 return DefaultCnf["Config::" + res[0] + "::DatabaseHostname"]
369 def which_conf_file ():
370 res = socket.gethostbyaddr(socket.gethostname());
371 if DefaultCnf.get("Config::" + res[0] + "::KatieConfig"):
372 return DefaultCnf["Config::" + res[0] + "::KatieConfig"]
374 return default_config;
376 def which_apt_conf_file ():
377 res = socket.gethostbyaddr(socket.gethostname());
378 if DefaultCnf.get("Config::" + res[0] + "::AptConfig"):
379 return DefaultCnf["Config::" + res[0] + "::AptConfig"]
381 return default_apt_config;
383 ######################################################################################
385 # Escape characters which have meaning to SQL's regex comparison operator ('~')
386 # (woefully incomplete)
389 s = string.replace(s, '+', '\\\\+');
390 s = string.replace(s, '.', '\\\\.');
393 ######################################################################################
395 # Perform a substition of template
396 def TemplateSubst(Map,Template):
398 Template = string.replace(Template,x,Map[x]);
401 ######################################################################################
403 def fubar(msg, exit_code=1):
404 sys.stderr.write("E: %s\n" % (msg));
408 sys.stderr.write("W: %s\n" % (msg));
410 ######################################################################################
412 # Returns the user name with a laughable attempt at rfc822 conformancy
413 # (read: removing stray periods).
415 return string.replace(string.split(pwd.getpwuid(os.getuid())[4],',')[0], '.', '');
417 ######################################################################################
427 return ("%d%s" % (c, t))
429 ################################################################################
431 def cc_fix_changes (changes):
432 o = changes.get("architecture", "")
434 del changes["architecture"]
435 changes["architecture"] = {}
436 for j in string.split(o):
437 changes["architecture"][j] = 1
439 # Sort by 'have source', by source name, by source version number, by filename
441 def changes_compare (a, b):
443 a_changes = parse_changes(a, 0)
448 b_changes = parse_changes(b, 0)
452 cc_fix_changes (a_changes);
453 cc_fix_changes (b_changes);
455 # Sort by 'have source'
457 a_has_source = a_changes["architecture"].get("source")
458 b_has_source = b_changes["architecture"].get("source")
459 if a_has_source and not b_has_source:
461 elif b_has_source and not a_has_source:
464 # Sort by source name
466 a_source = a_changes.get("source");
467 b_source = b_changes.get("source");
468 q = cmp (a_source, b_source);
472 # Sort by source version
474 a_version = a_changes.get("version");
475 b_version = b_changes.get("version");
476 q = apt_pkg.VersionCompare(a_version, b_version);
480 # Fall back to sort by filename
484 ################################################################################
486 def find_next_free (dest, too_many=100):
489 while os.path.exists(dest) and extra < too_many:
490 dest = orig_dest + '.' + repr(extra);
492 if extra >= too_many:
493 raise tried_too_hard_exc;
496 ################################################################################
498 def result_join (original, sep = '\t'):
500 for i in xrange(len(original)):
501 if original[i] == None:
504 list.append(original[i]);
505 return string.join(list, sep);
507 ################################################################################