2 # Copyright (C) 2000, 2001 James Troup <james@nocrew.org>
3 # $Id: utils.py,v 1.41 2002-04-21 15:39:06 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, 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(.*)");
32 re_taint_free = re.compile(r"^[-+\.\w]+$");
34 re_parse_maintainer = re.compile(r"^\s*(\S.*\S)\s*\<([^\> \t]+)\>");
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.";
48 default_config = "/etc/katie/katie.conf";
49 default_apt_config = "/etc/katie/apt.conf";
51 ######################################################################################
53 def open_file(filename, mode='r'):
55 f = open(filename, mode);
57 raise cant_open_exc, filename
60 ######################################################################################
62 def our_raw_input(prompt=""):
64 sys.stdout.write(prompt);
70 sys.stderr.write('\nUser interrupt (^D).\n');
73 ######################################################################################
77 if c not in string.digits:
81 ######################################################################################
83 def extract_component_from_section(section):
86 if string.find(section, '/') != -1:
87 component = string.split(section, '/')[0];
88 if string.lower(component) == "non-us" and string.count(section, '/') > 0:
89 s = component + '/' + string.split(section, '/')[1];
90 if Cnf.has_key("Component::%s" % s): # Avoid e.g. non-US/libs
93 if string.lower(section) == "non-us":
94 component = "non-US/main";
96 # non-US prefix is case insensitive
97 if string.lower(component)[:6] == "non-us":
98 component = "non-US"+component[6:];
100 # Expand default component
102 if Cnf.has_key("Component::%s" % section):
106 elif component == "non-US":
107 component = "non-US/main";
109 return (section, component);
111 ######################################################################################
113 # dsc_whitespace_rules turns on strict format checking to avoid
114 # allowing in source packages which are unextracable by the
115 # inappropriately fragile dpkg-source.
120 # o The PGP header consists of "-----BEGIN PGP SIGNED MESSAGE-----"
121 # followed by any PGP header data and must end with a blank line.
123 # o The data section must end with a blank line and must be followed by
124 # "-----BEGIN PGP SIGNATURE-----".
126 def parse_changes(filename, dsc_whitespace_rules):
127 changes_in = open_file(filename);
130 lines = changes_in.readlines();
133 raise changes_parse_error_exc, "[Empty changes file]";
135 # Reindex by line number so we can easily verify the format of
141 indexed_lines[index] = line[:-1];
143 inside_signature = 0;
145 indices = indexed_lines.keys()
147 while index < max(indices):
149 line = indexed_lines[index];
151 if dsc_whitespace_rules:
153 if index > max(indices):
154 raise invalid_dsc_format_exc, index;
155 line = indexed_lines[index];
156 if string.find(line, "-----BEGIN PGP SIGNATURE") != 0:
157 raise invalid_dsc_format_exc, index;
158 inside_signature = 0;
160 if string.find(line, "-----BEGIN PGP SIGNATURE") == 0:
162 if string.find(line, "-----BEGIN PGP SIGNED MESSAGE") == 0:
163 if dsc_whitespace_rules:
164 inside_signature = 1;
165 while index < max(indices) and line != "":
167 line = indexed_lines[index];
169 slf = re_single_line_field.match(line);
171 field = string.lower(slf.groups()[0]);
172 changes[field] = slf.groups()[1];
176 changes[field] = changes[field] + '\n';
178 mlf = re_multi_line_field.match(line);
180 if first == 1 and changes[field] != "":
181 changes[field] = changes[field] + '\n';
183 changes[field] = changes[field] + mlf.groups()[0] + '\n';
185 error = error + line;
187 if dsc_whitespace_rules and inside_signature:
188 raise invalid_dsc_format_exc, index;
191 changes["filecontents"] = string.join (lines, "");
194 raise changes_parse_error_exc, error;
198 ######################################################################################
200 # Dropped support for 1.4 and ``buggy dchanges 3.4'' (?!) compared to di.pl
202 def build_file_list(changes, dsc):
204 format = changes.get("format", "")
206 format = float(format)
207 if dsc == "" and (format < 1.5 or format > 2.0):
208 raise nk_format_exc, format;
210 # No really, this has happened. Think 0 length .dsc file.
211 if not changes.has_key("files"):
214 for i in string.split(changes["files"], "\n"):
218 section = priority = "";
221 (md5, size, name) = s
223 (md5, size, section, priority, name) = s
225 raise changes_parse_error_exc, i
227 if section == "": section = "-"
228 if priority == "": priority = "-"
230 (section, component) = extract_component_from_section(section);
232 files[name] = { "md5sum" : md5,
235 "priority": priority,
236 "component": component }
240 ######################################################################################
242 # Fix the `Maintainer:' field to be an RFC822 compatible address.
243 # cf. Packaging Manual (4.2.4)
245 # 06:28|<Culus> 'The standard sucks, but my tool is supposed to
246 # interoperate with it. I know - I'll fix the suckage
247 # and make things incompatible!'
249 def fix_maintainer (maintainer):
250 m = re_parse_maintainer.match(maintainer);
254 if m != None and len(m.groups()) == 2:
257 if string.find(name, ',') != -1 or string.find(name, '.') != -1:
258 rfc822 = re_parse_maintainer.sub(r"\2 (\1)", maintainer)
259 return (rfc822, name, email)
261 ######################################################################################
263 # sendmail wrapper, takes _either_ a message string or a file as arguments
264 def send_mail (message, filename):
265 # Sanity check arguments
266 if message != "" and filename != "":
267 raise send_mail_invalid_args_exc;
269 # If we've been passed a string dump it into a temporary file
271 filename = tempfile.mktemp();
272 fd = os.open(filename, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700);
273 os.write (fd, message);
277 (result, output) = commands.getstatusoutput("%s < %s" % (Cnf["Dinstall::SendmailCommand"], filename));
279 raise sendmail_failed_exc, output;
281 # Clean up any temporary files
283 os.unlink (filename);
285 ######################################################################################
287 def poolify (source, component):
289 component = component + '/';
290 # FIXME: this is nasty
291 component = string.lower(component);
292 component = string.replace(component, 'non-us/', 'non-US/');
293 if source[:3] == "lib":
294 return component + source[:4] + '/' + source + '/'
296 return component + source[:1] + '/' + source + '/'
298 ######################################################################################
300 def move (src, dest, overwrite = 0, perms = 0664):
301 if os.path.exists(dest) and os.path.isdir(dest):
304 dest_dir = os.path.dirname(dest);
305 if not os.path.exists(dest_dir):
306 umask = os.umask(00000);
307 os.makedirs(dest_dir, 02775);
309 #print "Moving %s to %s..." % (src, dest);
310 if os.path.exists(dest) and os.path.isdir(dest):
311 dest = dest + '/' + os.path.basename(src);
312 # Don't overwrite unless forced to
313 if os.path.exists(dest):
315 raise file_exists_exc;
317 if not os.access(dest, os.W_OK):
318 raise cant_overwrite_exc
319 shutil.copy2(src, dest);
320 os.chmod(dest, perms);
323 def copy (src, dest, overwrite = 0, perms = 0664):
324 if os.path.exists(dest) and os.path.isdir(dest):
327 dest_dir = os.path.dirname(dest);
328 if not os.path.exists(dest_dir):
329 umask = os.umask(00000);
330 os.makedirs(dest_dir, 02775);
332 #print "Copying %s to %s..." % (src, dest);
333 if os.path.exists(dest) and os.path.isdir(dest):
334 dest = dest + '/' + os.path.basename(src);
335 # Don't overwrite unless forced to
336 if os.path.exists(dest):
338 raise file_exists_exc
340 if not os.access(dest, os.W_OK):
341 raise cant_overwrite_exc
342 shutil.copy2(src, dest);
343 os.chmod(dest, perms);
345 ######################################################################################
348 res = socket.gethostbyaddr(socket.gethostname());
349 database_hostname = Cnf.get("Config::" + res[0] + "::DatabaseHostname");
350 if database_hostname:
351 return database_hostname;
355 def which_conf_file ():
356 res = socket.gethostbyaddr(socket.gethostname());
357 if Cnf.get("Config::" + res[0] + "::KatieConfig"):
358 return Cnf["Config::" + res[0] + "::KatieConfig"]
360 return default_config;
362 def which_apt_conf_file ():
363 res = socket.gethostbyaddr(socket.gethostname());
364 if Cnf.get("Config::" + res[0] + "::AptConfig"):
365 return Cnf["Config::" + res[0] + "::AptConfig"]
367 return default_apt_config;
369 ######################################################################################
371 # Escape characters which have meaning to SQL's regex comparison operator ('~')
372 # (woefully incomplete)
375 s = string.replace(s, '+', '\\\\+');
376 s = string.replace(s, '.', '\\\\.');
379 ######################################################################################
381 # Perform a substition of template
382 def TemplateSubst(Map,Template):
384 Template = string.replace(Template,x,Map[x]);
387 ######################################################################################
389 def fubar(msg, exit_code=1):
390 sys.stderr.write("E: %s\n" % (msg));
394 sys.stderr.write("W: %s\n" % (msg));
396 ######################################################################################
398 # Returns the user name with a laughable attempt at rfc822 conformancy
399 # (read: removing stray periods).
401 return string.replace(string.split(pwd.getpwuid(os.getuid())[4],',')[0], '.', '');
403 ######################################################################################
413 return ("%d%s" % (c, t))
415 ################################################################################
417 def cc_fix_changes (changes):
418 o = changes.get("architecture", "")
420 del changes["architecture"]
421 changes["architecture"] = {}
422 for j in string.split(o):
423 changes["architecture"][j] = 1
425 # Sort by 'have source', by source name, by source version number, by filename
427 def changes_compare (a, b):
429 a_changes = parse_changes(a, 0)
434 b_changes = parse_changes(b, 0)
438 cc_fix_changes (a_changes);
439 cc_fix_changes (b_changes);
441 # Sort by 'have source'
443 a_has_source = a_changes["architecture"].get("source")
444 b_has_source = b_changes["architecture"].get("source")
445 if a_has_source and not b_has_source:
447 elif b_has_source and not a_has_source:
450 # Sort by source name
452 a_source = a_changes.get("source");
453 b_source = b_changes.get("source");
454 q = cmp (a_source, b_source);
458 # Sort by source version
460 a_version = a_changes.get("version");
461 b_version = b_changes.get("version");
462 q = apt_pkg.VersionCompare(a_version, b_version);
466 # Fall back to sort by filename
470 ################################################################################
472 def find_next_free (dest, too_many=100):
475 while os.path.exists(dest) and extra < too_many:
476 dest = orig_dest + '.' + repr(extra);
478 if extra >= too_many:
479 raise tried_too_hard_exc;
482 ################################################################################
484 def result_join (original, sep = '\t'):
486 for i in xrange(len(original)):
487 if original[i] == None:
490 list.append(original[i]);
491 return string.join(list, sep);
493 ################################################################################
495 def prefix_multi_line_string(str, prefix):
497 for line in string.split(str, '\n'):
498 line = string.strip(line);
500 out = out + "%s%s\n" % (prefix, line);
501 # Strip trailing new line
506 ################################################################################
511 ################################################################################
515 Cnf = apt_pkg.newConfiguration();
516 apt_pkg.ReadConfigFileISC(Cnf,default_config);
518 if which_conf_file() != default_config:
519 apt_pkg.ReadConfigFileISC(Cnf,which_conf_file())
521 ################################################################################