Guido van Rossum | f06ee5f | 1996-11-27 19:52:01 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python |
Guido van Rossum | 6244867 | 1996-09-17 21:33:15 +0000 | [diff] [blame] | 2 | |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 3 | """Read/write support for Maildir, mbox, MH, Babyl, and MMDF mailboxes.""" |
Guido van Rossum | 6244867 | 1996-09-17 21:33:15 +0000 | [diff] [blame] | 4 | |
Martin v. Löwis | 08041d5 | 2006-05-04 14:27:52 +0000 | [diff] [blame^] | 5 | import sys |
Jack Jansen | 9715779 | 1995-10-23 13:59:53 +0000 | [diff] [blame] | 6 | import os |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 7 | import time |
| 8 | import calendar |
| 9 | import socket |
| 10 | import errno |
| 11 | import copy |
| 12 | import email |
| 13 | import email.Message |
| 14 | import email.Generator |
| 15 | import rfc822 |
| 16 | import StringIO |
| 17 | try: |
| 18 | import fnctl |
| 19 | except ImportError: |
| 20 | fcntl = None |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 21 | |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 22 | __all__ = [ 'Mailbox', 'Maildir', 'mbox', 'MH', 'Babyl', 'MMDF', |
| 23 | 'Message', 'MaildirMessage', 'mboxMessage', 'MHMessage', |
| 24 | 'BabylMessage', 'MMDFMessage', 'UnixMailbox', |
| 25 | 'PortableUnixMailbox', 'MmdfMailbox', 'MHMailbox', 'BabylMailbox' ] |
| 26 | |
Martin v. Löwis | 08041d5 | 2006-05-04 14:27:52 +0000 | [diff] [blame^] | 27 | if sys.platform != 'win32': |
| 28 | # Define WindowsError so that we can use it in an except statement |
| 29 | # even on non-Windows systems |
| 30 | class WindowsError: |
| 31 | pass |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 32 | |
| 33 | class Mailbox: |
| 34 | """A group of messages in a particular place.""" |
| 35 | |
| 36 | def __init__(self, path, factory=None, create=True): |
| 37 | """Initialize a Mailbox instance.""" |
| 38 | self._path = os.path.abspath(os.path.expanduser(path)) |
| 39 | self._factory = factory |
| 40 | |
| 41 | def add(self, message): |
| 42 | """Add message and return assigned key.""" |
| 43 | raise NotImplementedError('Method must be implemented by subclass') |
| 44 | |
| 45 | def remove(self, key): |
| 46 | """Remove the keyed message; raise KeyError if it doesn't exist.""" |
| 47 | raise NotImplementedError('Method must be implemented by subclass') |
| 48 | |
| 49 | def __delitem__(self, key): |
| 50 | self.remove(key) |
| 51 | |
| 52 | def discard(self, key): |
| 53 | """If the keyed message exists, remove it.""" |
| 54 | try: |
| 55 | self.remove(key) |
| 56 | except KeyError: |
| 57 | pass |
| 58 | |
| 59 | def __setitem__(self, key, message): |
| 60 | """Replace the keyed message; raise KeyError if it doesn't exist.""" |
| 61 | raise NotImplementedError('Method must be implemented by subclass') |
| 62 | |
| 63 | def get(self, key, default=None): |
| 64 | """Return the keyed message, or default if it doesn't exist.""" |
| 65 | try: |
| 66 | return self.__getitem__(key) |
| 67 | except KeyError: |
| 68 | return default |
| 69 | |
| 70 | def __getitem__(self, key): |
| 71 | """Return the keyed message; raise KeyError if it doesn't exist.""" |
| 72 | if not self._factory: |
| 73 | return self.get_message(key) |
| 74 | else: |
| 75 | return self._factory(self.get_file(key)) |
| 76 | |
| 77 | def get_message(self, key): |
| 78 | """Return a Message representation or raise a KeyError.""" |
| 79 | raise NotImplementedError('Method must be implemented by subclass') |
| 80 | |
| 81 | def get_string(self, key): |
| 82 | """Return a string representation or raise a KeyError.""" |
| 83 | raise NotImplementedError('Method must be implemented by subclass') |
| 84 | |
| 85 | def get_file(self, key): |
| 86 | """Return a file-like representation or raise a KeyError.""" |
| 87 | raise NotImplementedError('Method must be implemented by subclass') |
| 88 | |
| 89 | def iterkeys(self): |
| 90 | """Return an iterator over keys.""" |
| 91 | raise NotImplementedError('Method must be implemented by subclass') |
| 92 | |
| 93 | def keys(self): |
| 94 | """Return a list of keys.""" |
| 95 | return list(self.iterkeys()) |
| 96 | |
| 97 | def itervalues(self): |
| 98 | """Return an iterator over all messages.""" |
| 99 | for key in self.iterkeys(): |
| 100 | try: |
| 101 | value = self[key] |
| 102 | except KeyError: |
| 103 | continue |
| 104 | yield value |
| 105 | |
| 106 | def __iter__(self): |
| 107 | return self.itervalues() |
| 108 | |
| 109 | def values(self): |
| 110 | """Return a list of messages. Memory intensive.""" |
| 111 | return list(self.itervalues()) |
| 112 | |
| 113 | def iteritems(self): |
| 114 | """Return an iterator over (key, message) tuples.""" |
| 115 | for key in self.iterkeys(): |
| 116 | try: |
| 117 | value = self[key] |
| 118 | except KeyError: |
| 119 | continue |
| 120 | yield (key, value) |
| 121 | |
| 122 | def items(self): |
| 123 | """Return a list of (key, message) tuples. Memory intensive.""" |
| 124 | return list(self.iteritems()) |
| 125 | |
| 126 | def has_key(self, key): |
| 127 | """Return True if the keyed message exists, False otherwise.""" |
| 128 | raise NotImplementedError('Method must be implemented by subclass') |
| 129 | |
| 130 | def __contains__(self, key): |
| 131 | return self.has_key(key) |
| 132 | |
| 133 | def __len__(self): |
| 134 | """Return a count of messages in the mailbox.""" |
| 135 | raise NotImplementedError('Method must be implemented by subclass') |
| 136 | |
| 137 | def clear(self): |
| 138 | """Delete all messages.""" |
| 139 | for key in self.iterkeys(): |
| 140 | self.discard(key) |
| 141 | |
| 142 | def pop(self, key, default=None): |
| 143 | """Delete the keyed message and return it, or default.""" |
| 144 | try: |
| 145 | result = self[key] |
| 146 | except KeyError: |
| 147 | return default |
| 148 | self.discard(key) |
| 149 | return result |
| 150 | |
| 151 | def popitem(self): |
| 152 | """Delete an arbitrary (key, message) pair and return it.""" |
| 153 | for key in self.iterkeys(): |
| 154 | return (key, self.pop(key)) # This is only run once. |
| 155 | else: |
| 156 | raise KeyError('No messages in mailbox') |
| 157 | |
| 158 | def update(self, arg=None): |
| 159 | """Change the messages that correspond to certain keys.""" |
| 160 | if hasattr(arg, 'iteritems'): |
| 161 | source = arg.iteritems() |
| 162 | elif hasattr(arg, 'items'): |
| 163 | source = arg.items() |
| 164 | else: |
| 165 | source = arg |
| 166 | bad_key = False |
| 167 | for key, message in source: |
| 168 | try: |
| 169 | self[key] = message |
| 170 | except KeyError: |
| 171 | bad_key = True |
| 172 | if bad_key: |
| 173 | raise KeyError('No message with key(s)') |
| 174 | |
| 175 | def flush(self): |
| 176 | """Write any pending changes to the disk.""" |
| 177 | raise NotImplementedError('Method must be implemented by subclass') |
| 178 | |
| 179 | def lock(self): |
| 180 | """Lock the mailbox.""" |
| 181 | raise NotImplementedError('Method must be implemented by subclass') |
| 182 | |
| 183 | def unlock(self): |
| 184 | """Unlock the mailbox if it is locked.""" |
| 185 | raise NotImplementedError('Method must be implemented by subclass') |
| 186 | |
| 187 | def close(self): |
| 188 | """Flush and close the mailbox.""" |
| 189 | raise NotImplementedError('Method must be implemented by subclass') |
| 190 | |
| 191 | def _dump_message(self, message, target, mangle_from_=False): |
| 192 | # Most files are opened in binary mode to allow predictable seeking. |
| 193 | # To get native line endings on disk, the user-friendly \n line endings |
| 194 | # used in strings and by email.Message are translated here. |
| 195 | """Dump message contents to target file.""" |
| 196 | if isinstance(message, email.Message.Message): |
| 197 | buffer = StringIO.StringIO() |
| 198 | gen = email.Generator.Generator(buffer, mangle_from_, 0) |
| 199 | gen.flatten(message) |
| 200 | buffer.seek(0) |
| 201 | target.write(buffer.read().replace('\n', os.linesep)) |
| 202 | elif isinstance(message, str): |
| 203 | if mangle_from_: |
| 204 | message = message.replace('\nFrom ', '\n>From ') |
| 205 | message = message.replace('\n', os.linesep) |
| 206 | target.write(message) |
| 207 | elif hasattr(message, 'read'): |
| 208 | while True: |
| 209 | line = message.readline() |
| 210 | if line == '': |
| 211 | break |
| 212 | if mangle_from_ and line.startswith('From '): |
| 213 | line = '>From ' + line[5:] |
| 214 | line = line.replace('\n', os.linesep) |
| 215 | target.write(line) |
| 216 | else: |
| 217 | raise TypeError('Invalid message type: %s' % type(message)) |
| 218 | |
| 219 | |
| 220 | class Maildir(Mailbox): |
| 221 | """A qmail-style Maildir mailbox.""" |
| 222 | |
| 223 | colon = ':' |
| 224 | |
| 225 | def __init__(self, dirname, factory=rfc822.Message, create=True): |
| 226 | """Initialize a Maildir instance.""" |
| 227 | Mailbox.__init__(self, dirname, factory, create) |
| 228 | if not os.path.exists(self._path): |
| 229 | if create: |
| 230 | os.mkdir(self._path, 0700) |
| 231 | os.mkdir(os.path.join(self._path, 'tmp'), 0700) |
| 232 | os.mkdir(os.path.join(self._path, 'new'), 0700) |
| 233 | os.mkdir(os.path.join(self._path, 'cur'), 0700) |
| 234 | else: |
| 235 | raise NoSuchMailboxError(self._path) |
| 236 | self._toc = {} |
| 237 | |
| 238 | def add(self, message): |
| 239 | """Add message and return assigned key.""" |
| 240 | tmp_file = self._create_tmp() |
| 241 | try: |
| 242 | self._dump_message(message, tmp_file) |
| 243 | finally: |
| 244 | tmp_file.close() |
| 245 | if isinstance(message, MaildirMessage): |
| 246 | subdir = message.get_subdir() |
| 247 | suffix = self.colon + message.get_info() |
| 248 | if suffix == self.colon: |
| 249 | suffix = '' |
| 250 | else: |
| 251 | subdir = 'new' |
| 252 | suffix = '' |
| 253 | uniq = os.path.basename(tmp_file.name).split(self.colon)[0] |
| 254 | dest = os.path.join(self._path, subdir, uniq + suffix) |
| 255 | os.rename(tmp_file.name, dest) |
| 256 | if isinstance(message, MaildirMessage): |
| 257 | os.utime(dest, (os.path.getatime(dest), message.get_date())) |
| 258 | return uniq |
| 259 | |
| 260 | def remove(self, key): |
| 261 | """Remove the keyed message; raise KeyError if it doesn't exist.""" |
| 262 | os.remove(os.path.join(self._path, self._lookup(key))) |
| 263 | |
| 264 | def discard(self, key): |
| 265 | """If the keyed message exists, remove it.""" |
| 266 | # This overrides an inapplicable implementation in the superclass. |
| 267 | try: |
| 268 | self.remove(key) |
| 269 | except KeyError: |
| 270 | pass |
Martin v. Löwis | 08041d5 | 2006-05-04 14:27:52 +0000 | [diff] [blame^] | 271 | except WindowsError, e: |
| 272 | if e.errno != 2: # ERROR_FILE_NOT_FOUND |
| 273 | raise |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 274 | except OSError, e: |
Martin v. Löwis | 08041d5 | 2006-05-04 14:27:52 +0000 | [diff] [blame^] | 275 | if e.errno != errno.ENOENT: |
Tim Peters | 6d7cd7d | 2006-04-22 05:52:59 +0000 | [diff] [blame] | 276 | raise |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 277 | |
| 278 | def __setitem__(self, key, message): |
| 279 | """Replace the keyed message; raise KeyError if it doesn't exist.""" |
| 280 | old_subpath = self._lookup(key) |
| 281 | temp_key = self.add(message) |
| 282 | temp_subpath = self._lookup(temp_key) |
| 283 | if isinstance(message, MaildirMessage): |
| 284 | # temp's subdir and suffix were specified by message. |
| 285 | dominant_subpath = temp_subpath |
| 286 | else: |
| 287 | # temp's subdir and suffix were defaults from add(). |
| 288 | dominant_subpath = old_subpath |
| 289 | subdir = os.path.dirname(dominant_subpath) |
| 290 | if self.colon in dominant_subpath: |
| 291 | suffix = self.colon + dominant_subpath.split(self.colon)[-1] |
| 292 | else: |
| 293 | suffix = '' |
| 294 | self.discard(key) |
| 295 | new_path = os.path.join(self._path, subdir, key + suffix) |
| 296 | os.rename(os.path.join(self._path, temp_subpath), new_path) |
| 297 | if isinstance(message, MaildirMessage): |
| 298 | os.utime(new_path, (os.path.getatime(new_path), |
| 299 | message.get_date())) |
| 300 | |
| 301 | def get_message(self, key): |
| 302 | """Return a Message representation or raise a KeyError.""" |
| 303 | subpath = self._lookup(key) |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 304 | f = open(os.path.join(self._path, subpath), 'r') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 305 | try: |
| 306 | msg = MaildirMessage(f) |
| 307 | finally: |
| 308 | f.close() |
| 309 | subdir, name = os.path.split(subpath) |
| 310 | msg.set_subdir(subdir) |
| 311 | if self.colon in name: |
| 312 | msg.set_info(name.split(self.colon)[-1]) |
| 313 | msg.set_date(os.path.getmtime(os.path.join(self._path, subpath))) |
| 314 | return msg |
| 315 | |
| 316 | def get_string(self, key): |
| 317 | """Return a string representation or raise a KeyError.""" |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 318 | f = open(os.path.join(self._path, self._lookup(key)), 'r') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 319 | try: |
| 320 | return f.read() |
| 321 | finally: |
| 322 | f.close() |
| 323 | |
| 324 | def get_file(self, key): |
| 325 | """Return a file-like representation or raise a KeyError.""" |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 326 | f = open(os.path.join(self._path, self._lookup(key)), 'rb') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 327 | return _ProxyFile(f) |
| 328 | |
| 329 | def iterkeys(self): |
| 330 | """Return an iterator over keys.""" |
| 331 | self._refresh() |
| 332 | for key in self._toc: |
| 333 | try: |
| 334 | self._lookup(key) |
| 335 | except KeyError: |
| 336 | continue |
| 337 | yield key |
| 338 | |
| 339 | def has_key(self, key): |
| 340 | """Return True if the keyed message exists, False otherwise.""" |
| 341 | self._refresh() |
| 342 | return key in self._toc |
| 343 | |
| 344 | def __len__(self): |
| 345 | """Return a count of messages in the mailbox.""" |
| 346 | self._refresh() |
| 347 | return len(self._toc) |
| 348 | |
| 349 | def flush(self): |
| 350 | """Write any pending changes to disk.""" |
| 351 | return # Maildir changes are always written immediately. |
| 352 | |
| 353 | def lock(self): |
| 354 | """Lock the mailbox.""" |
| 355 | return |
| 356 | |
| 357 | def unlock(self): |
| 358 | """Unlock the mailbox if it is locked.""" |
| 359 | return |
| 360 | |
| 361 | def close(self): |
| 362 | """Flush and close the mailbox.""" |
| 363 | return |
| 364 | |
| 365 | def list_folders(self): |
| 366 | """Return a list of folder names.""" |
| 367 | result = [] |
| 368 | for entry in os.listdir(self._path): |
| 369 | if len(entry) > 1 and entry[0] == '.' and \ |
| 370 | os.path.isdir(os.path.join(self._path, entry)): |
| 371 | result.append(entry[1:]) |
| 372 | return result |
| 373 | |
| 374 | def get_folder(self, folder): |
| 375 | """Return a Maildir instance for the named folder.""" |
| 376 | return Maildir(os.path.join(self._path, '.' + folder), create=False) |
| 377 | |
| 378 | def add_folder(self, folder): |
| 379 | """Create a folder and return a Maildir instance representing it.""" |
| 380 | path = os.path.join(self._path, '.' + folder) |
| 381 | result = Maildir(path) |
| 382 | maildirfolder_path = os.path.join(path, 'maildirfolder') |
| 383 | if not os.path.exists(maildirfolder_path): |
| 384 | os.close(os.open(maildirfolder_path, os.O_CREAT | os.O_WRONLY)) |
| 385 | return result |
| 386 | |
| 387 | def remove_folder(self, folder): |
| 388 | """Delete the named folder, which must be empty.""" |
| 389 | path = os.path.join(self._path, '.' + folder) |
| 390 | for entry in os.listdir(os.path.join(path, 'new')) + \ |
| 391 | os.listdir(os.path.join(path, 'cur')): |
| 392 | if len(entry) < 1 or entry[0] != '.': |
| 393 | raise NotEmptyError('Folder contains message(s): %s' % folder) |
| 394 | for entry in os.listdir(path): |
| 395 | if entry != 'new' and entry != 'cur' and entry != 'tmp' and \ |
| 396 | os.path.isdir(os.path.join(path, entry)): |
| 397 | raise NotEmptyError("Folder contains subdirectory '%s': %s" % |
| 398 | (folder, entry)) |
| 399 | for root, dirs, files in os.walk(path, topdown=False): |
| 400 | for entry in files: |
| 401 | os.remove(os.path.join(root, entry)) |
| 402 | for entry in dirs: |
| 403 | os.rmdir(os.path.join(root, entry)) |
| 404 | os.rmdir(path) |
| 405 | |
| 406 | def clean(self): |
| 407 | """Delete old files in "tmp".""" |
| 408 | now = time.time() |
| 409 | for entry in os.listdir(os.path.join(self._path, 'tmp')): |
| 410 | path = os.path.join(self._path, 'tmp', entry) |
| 411 | if now - os.path.getatime(path) > 129600: # 60 * 60 * 36 |
| 412 | os.remove(path) |
| 413 | |
| 414 | _count = 1 # This is used to generate unique file names. |
| 415 | |
| 416 | def _create_tmp(self): |
| 417 | """Create a file in the tmp subdirectory and open and return it.""" |
| 418 | now = time.time() |
| 419 | hostname = socket.gethostname() |
| 420 | if '/' in hostname: |
| 421 | hostname = hostname.replace('/', r'\057') |
| 422 | if ':' in hostname: |
| 423 | hostname = hostname.replace(':', r'\072') |
| 424 | uniq = "%s.M%sP%sQ%s.%s" % (int(now), int(now % 1 * 1e6), os.getpid(), |
| 425 | Maildir._count, hostname) |
| 426 | path = os.path.join(self._path, 'tmp', uniq) |
| 427 | try: |
| 428 | os.stat(path) |
Martin v. Löwis | 08041d5 | 2006-05-04 14:27:52 +0000 | [diff] [blame^] | 429 | except WindowsError, e: |
| 430 | if e.errno == 2: # ERROR_FILE_NOT_FOUND |
| 431 | Maildir._count += 1 |
| 432 | return open(path, 'wb+') |
| 433 | else: |
| 434 | raise |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 435 | except OSError, e: |
| 436 | if e.errno == errno.ENOENT: |
| 437 | Maildir._count += 1 |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 438 | return open(path, 'wb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 439 | else: |
| 440 | raise |
| 441 | else: |
| 442 | raise ExternalClashError('Name clash prevented file creation: %s' % |
| 443 | path) |
| 444 | |
| 445 | def _refresh(self): |
| 446 | """Update table of contents mapping.""" |
| 447 | self._toc = {} |
| 448 | for subdir in ('new', 'cur'): |
| 449 | for entry in os.listdir(os.path.join(self._path, subdir)): |
| 450 | uniq = entry.split(self.colon)[0] |
| 451 | self._toc[uniq] = os.path.join(subdir, entry) |
| 452 | |
| 453 | def _lookup(self, key): |
| 454 | """Use TOC to return subpath for given key, or raise a KeyError.""" |
| 455 | try: |
| 456 | if os.path.exists(os.path.join(self._path, self._toc[key])): |
| 457 | return self._toc[key] |
| 458 | except KeyError: |
| 459 | pass |
| 460 | self._refresh() |
| 461 | try: |
| 462 | return self._toc[key] |
| 463 | except KeyError: |
| 464 | raise KeyError('No message with key: %s' % key) |
| 465 | |
| 466 | # This method is for backward compatibility only. |
| 467 | def next(self): |
| 468 | """Return the next message in a one-time iteration.""" |
| 469 | if not hasattr(self, '_onetime_keys'): |
| 470 | self._onetime_keys = self.iterkeys() |
| 471 | while True: |
| 472 | try: |
| 473 | return self[self._onetime_keys.next()] |
| 474 | except StopIteration: |
| 475 | return None |
| 476 | except KeyError: |
| 477 | continue |
| 478 | |
| 479 | |
| 480 | class _singlefileMailbox(Mailbox): |
| 481 | """A single-file mailbox.""" |
| 482 | |
| 483 | def __init__(self, path, factory=None, create=True): |
| 484 | """Initialize a single-file mailbox.""" |
| 485 | Mailbox.__init__(self, path, factory, create) |
| 486 | try: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 487 | f = open(self._path, 'rb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 488 | except IOError, e: |
| 489 | if e.errno == errno.ENOENT: |
| 490 | if create: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 491 | f = open(self._path, 'wb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 492 | else: |
| 493 | raise NoSuchMailboxError(self._path) |
| 494 | elif e.errno == errno.EACCES: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 495 | f = open(self._path, 'rb') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 496 | else: |
| 497 | raise |
| 498 | self._file = f |
| 499 | self._toc = None |
| 500 | self._next_key = 0 |
| 501 | self._pending = False # No changes require rewriting the file. |
| 502 | self._locked = False |
| 503 | |
| 504 | def add(self, message): |
| 505 | """Add message and return assigned key.""" |
| 506 | self._lookup() |
| 507 | self._toc[self._next_key] = self._append_message(message) |
| 508 | self._next_key += 1 |
| 509 | self._pending = True |
| 510 | return self._next_key - 1 |
| 511 | |
| 512 | def remove(self, key): |
| 513 | """Remove the keyed message; raise KeyError if it doesn't exist.""" |
| 514 | self._lookup(key) |
| 515 | del self._toc[key] |
| 516 | self._pending = True |
| 517 | |
| 518 | def __setitem__(self, key, message): |
| 519 | """Replace the keyed message; raise KeyError if it doesn't exist.""" |
| 520 | self._lookup(key) |
| 521 | self._toc[key] = self._append_message(message) |
| 522 | self._pending = True |
| 523 | |
| 524 | def iterkeys(self): |
| 525 | """Return an iterator over keys.""" |
| 526 | self._lookup() |
| 527 | for key in self._toc.keys(): |
| 528 | yield key |
| 529 | |
| 530 | def has_key(self, key): |
| 531 | """Return True if the keyed message exists, False otherwise.""" |
| 532 | self._lookup() |
| 533 | return key in self._toc |
| 534 | |
| 535 | def __len__(self): |
| 536 | """Return a count of messages in the mailbox.""" |
| 537 | self._lookup() |
| 538 | return len(self._toc) |
| 539 | |
| 540 | def lock(self): |
| 541 | """Lock the mailbox.""" |
| 542 | if not self._locked: |
| 543 | _lock_file(self._file) |
| 544 | self._locked = True |
| 545 | |
| 546 | def unlock(self): |
| 547 | """Unlock the mailbox if it is locked.""" |
| 548 | if self._locked: |
| 549 | _unlock_file(self._file) |
| 550 | self._locked = False |
| 551 | |
| 552 | def flush(self): |
| 553 | """Write any pending changes to disk.""" |
| 554 | if not self._pending: |
| 555 | return |
| 556 | self._lookup() |
| 557 | new_file = _create_temporary(self._path) |
| 558 | try: |
| 559 | new_toc = {} |
| 560 | self._pre_mailbox_hook(new_file) |
| 561 | for key in sorted(self._toc.keys()): |
| 562 | start, stop = self._toc[key] |
| 563 | self._file.seek(start) |
| 564 | self._pre_message_hook(new_file) |
| 565 | new_start = new_file.tell() |
| 566 | while True: |
| 567 | buffer = self._file.read(min(4096, |
| 568 | stop - self._file.tell())) |
| 569 | if buffer == '': |
| 570 | break |
| 571 | new_file.write(buffer) |
| 572 | new_toc[key] = (new_start, new_file.tell()) |
| 573 | self._post_message_hook(new_file) |
| 574 | except: |
| 575 | new_file.close() |
| 576 | os.remove(new_file.name) |
| 577 | raise |
| 578 | new_file.close() |
| 579 | self._file.close() |
| 580 | try: |
| 581 | os.rename(new_file.name, self._path) |
Martin v. Löwis | 08041d5 | 2006-05-04 14:27:52 +0000 | [diff] [blame^] | 582 | except WindowsError, e: |
| 583 | if e.errno == 183: # ERROR_ALREADY_EXISTS |
| 584 | os.remove(self._path) |
| 585 | os.rename(new_file.name, self._path) |
| 586 | else: |
| 587 | raise |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 588 | except OSError, e: |
| 589 | if e.errno == errno.EEXIST: |
| 590 | os.remove(self._path) |
| 591 | os.rename(new_file.name, self._path) |
| 592 | else: |
| 593 | raise |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 594 | self._file = open(self._path, 'rb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 595 | self._toc = new_toc |
| 596 | self._pending = False |
| 597 | if self._locked: |
| 598 | _lock_file(new_file, dotlock=False) |
| 599 | |
| 600 | def _pre_mailbox_hook(self, f): |
| 601 | """Called before writing the mailbox to file f.""" |
| 602 | return |
| 603 | |
| 604 | def _pre_message_hook(self, f): |
| 605 | """Called before writing each message to file f.""" |
| 606 | return |
| 607 | |
| 608 | def _post_message_hook(self, f): |
| 609 | """Called after writing each message to file f.""" |
| 610 | return |
| 611 | |
| 612 | def close(self): |
| 613 | """Flush and close the mailbox.""" |
| 614 | self.flush() |
| 615 | if self._locked: |
| 616 | self.unlock() |
| 617 | self._file.close() |
| 618 | |
| 619 | def _lookup(self, key=None): |
| 620 | """Return (start, stop) or raise KeyError.""" |
| 621 | if self._toc is None: |
| 622 | self._generate_toc() |
| 623 | if key is not None: |
| 624 | try: |
| 625 | return self._toc[key] |
| 626 | except KeyError: |
| 627 | raise KeyError('No message with key: %s' % key) |
| 628 | |
| 629 | def _append_message(self, message): |
| 630 | """Append message to mailbox and return (start, stop) offsets.""" |
| 631 | self._file.seek(0, 2) |
| 632 | self._pre_message_hook(self._file) |
| 633 | offsets = self._install_message(message) |
| 634 | self._post_message_hook(self._file) |
| 635 | self._file.flush() |
| 636 | return offsets |
| 637 | |
| 638 | |
| 639 | |
| 640 | class _mboxMMDF(_singlefileMailbox): |
| 641 | """An mbox or MMDF mailbox.""" |
| 642 | |
| 643 | _mangle_from_ = True |
| 644 | |
| 645 | def get_message(self, key): |
| 646 | """Return a Message representation or raise a KeyError.""" |
| 647 | start, stop = self._lookup(key) |
| 648 | self._file.seek(start) |
| 649 | from_line = self._file.readline().replace(os.linesep, '') |
| 650 | string = self._file.read(stop - self._file.tell()) |
| 651 | msg = self._message_factory(string.replace(os.linesep, '\n')) |
| 652 | msg.set_from(from_line[5:]) |
| 653 | return msg |
| 654 | |
| 655 | def get_string(self, key, from_=False): |
| 656 | """Return a string representation or raise a KeyError.""" |
| 657 | start, stop = self._lookup(key) |
| 658 | self._file.seek(start) |
| 659 | if not from_: |
| 660 | self._file.readline() |
| 661 | string = self._file.read(stop - self._file.tell()) |
| 662 | return string.replace(os.linesep, '\n') |
| 663 | |
| 664 | def get_file(self, key, from_=False): |
| 665 | """Return a file-like representation or raise a KeyError.""" |
| 666 | start, stop = self._lookup(key) |
| 667 | self._file.seek(start) |
| 668 | if not from_: |
| 669 | self._file.readline() |
| 670 | return _PartialFile(self._file, self._file.tell(), stop) |
| 671 | |
| 672 | def _install_message(self, message): |
| 673 | """Format a message and blindly write to self._file.""" |
| 674 | from_line = None |
| 675 | if isinstance(message, str) and message.startswith('From '): |
| 676 | newline = message.find('\n') |
| 677 | if newline != -1: |
| 678 | from_line = message[:newline] |
| 679 | message = message[newline + 1:] |
| 680 | else: |
| 681 | from_line = message |
| 682 | message = '' |
| 683 | elif isinstance(message, _mboxMMDFMessage): |
| 684 | from_line = 'From ' + message.get_from() |
| 685 | elif isinstance(message, email.Message.Message): |
| 686 | from_line = message.get_unixfrom() # May be None. |
| 687 | if from_line is None: |
| 688 | from_line = 'From MAILER-DAEMON %s' % time.asctime(time.gmtime()) |
| 689 | start = self._file.tell() |
| 690 | self._file.write(from_line + os.linesep) |
| 691 | self._dump_message(message, self._file, self._mangle_from_) |
| 692 | stop = self._file.tell() |
| 693 | return (start, stop) |
| 694 | |
| 695 | |
| 696 | class mbox(_mboxMMDF): |
| 697 | """A classic mbox mailbox.""" |
| 698 | |
| 699 | _mangle_from_ = True |
| 700 | |
| 701 | def __init__(self, path, factory=None, create=True): |
| 702 | """Initialize an mbox mailbox.""" |
| 703 | self._message_factory = mboxMessage |
| 704 | _mboxMMDF.__init__(self, path, factory, create) |
| 705 | |
| 706 | def _pre_message_hook(self, f): |
| 707 | """Called before writing each message to file f.""" |
| 708 | if f.tell() != 0: |
| 709 | f.write(os.linesep) |
| 710 | |
| 711 | def _generate_toc(self): |
| 712 | """Generate key-to-(start, stop) table of contents.""" |
| 713 | starts, stops = [], [] |
| 714 | self._file.seek(0) |
| 715 | while True: |
| 716 | line_pos = self._file.tell() |
| 717 | line = self._file.readline() |
| 718 | if line.startswith('From '): |
| 719 | if len(stops) < len(starts): |
| 720 | stops.append(line_pos - len(os.linesep)) |
| 721 | starts.append(line_pos) |
| 722 | elif line == '': |
| 723 | stops.append(line_pos) |
| 724 | break |
| 725 | self._toc = dict(enumerate(zip(starts, stops))) |
| 726 | self._next_key = len(self._toc) |
| 727 | |
| 728 | |
| 729 | class MMDF(_mboxMMDF): |
| 730 | """An MMDF mailbox.""" |
| 731 | |
| 732 | def __init__(self, path, factory=None, create=True): |
| 733 | """Initialize an MMDF mailbox.""" |
| 734 | self._message_factory = MMDFMessage |
| 735 | _mboxMMDF.__init__(self, path, factory, create) |
| 736 | |
| 737 | def _pre_message_hook(self, f): |
| 738 | """Called before writing each message to file f.""" |
| 739 | f.write('\001\001\001\001' + os.linesep) |
| 740 | |
| 741 | def _post_message_hook(self, f): |
| 742 | """Called after writing each message to file f.""" |
| 743 | f.write(os.linesep + '\001\001\001\001' + os.linesep) |
| 744 | |
| 745 | def _generate_toc(self): |
| 746 | """Generate key-to-(start, stop) table of contents.""" |
| 747 | starts, stops = [], [] |
| 748 | self._file.seek(0) |
| 749 | next_pos = 0 |
| 750 | while True: |
| 751 | line_pos = next_pos |
| 752 | line = self._file.readline() |
| 753 | next_pos = self._file.tell() |
| 754 | if line.startswith('\001\001\001\001' + os.linesep): |
| 755 | starts.append(next_pos) |
| 756 | while True: |
| 757 | line_pos = next_pos |
| 758 | line = self._file.readline() |
| 759 | next_pos = self._file.tell() |
| 760 | if line == '\001\001\001\001' + os.linesep: |
| 761 | stops.append(line_pos - len(os.linesep)) |
| 762 | break |
| 763 | elif line == '': |
| 764 | stops.append(line_pos) |
| 765 | break |
| 766 | elif line == '': |
| 767 | break |
| 768 | self._toc = dict(enumerate(zip(starts, stops))) |
| 769 | self._next_key = len(self._toc) |
| 770 | |
| 771 | |
| 772 | class MH(Mailbox): |
| 773 | """An MH mailbox.""" |
| 774 | |
| 775 | def __init__(self, path, factory=None, create=True): |
| 776 | """Initialize an MH instance.""" |
| 777 | Mailbox.__init__(self, path, factory, create) |
| 778 | if not os.path.exists(self._path): |
| 779 | if create: |
| 780 | os.mkdir(self._path, 0700) |
| 781 | os.close(os.open(os.path.join(self._path, '.mh_sequences'), |
| 782 | os.O_CREAT | os.O_EXCL | os.O_WRONLY, 0600)) |
| 783 | else: |
| 784 | raise NoSuchMailboxError(self._path) |
| 785 | self._locked = False |
| 786 | |
| 787 | def add(self, message): |
| 788 | """Add message and return assigned key.""" |
| 789 | keys = self.keys() |
| 790 | if len(keys) == 0: |
| 791 | new_key = 1 |
| 792 | else: |
| 793 | new_key = max(keys) + 1 |
| 794 | new_path = os.path.join(self._path, str(new_key)) |
| 795 | f = _create_carefully(new_path) |
| 796 | try: |
| 797 | if self._locked: |
| 798 | _lock_file(f) |
| 799 | try: |
| 800 | self._dump_message(message, f) |
| 801 | if isinstance(message, MHMessage): |
| 802 | self._dump_sequences(message, new_key) |
| 803 | finally: |
| 804 | if self._locked: |
| 805 | _unlock_file(f) |
| 806 | finally: |
| 807 | f.close() |
| 808 | return new_key |
| 809 | |
| 810 | def remove(self, key): |
| 811 | """Remove the keyed message; raise KeyError if it doesn't exist.""" |
| 812 | path = os.path.join(self._path, str(key)) |
| 813 | try: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 814 | f = open(path, 'rb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 815 | except IOError, e: |
| 816 | if e.errno == errno.ENOENT: |
| 817 | raise KeyError('No message with key: %s' % key) |
| 818 | else: |
| 819 | raise |
| 820 | try: |
| 821 | if self._locked: |
| 822 | _lock_file(f) |
| 823 | try: |
| 824 | f.close() |
| 825 | os.remove(os.path.join(self._path, str(key))) |
| 826 | finally: |
| 827 | if self._locked: |
| 828 | _unlock_file(f) |
| 829 | finally: |
| 830 | f.close() |
| 831 | |
| 832 | def __setitem__(self, key, message): |
| 833 | """Replace the keyed message; raise KeyError if it doesn't exist.""" |
| 834 | path = os.path.join(self._path, str(key)) |
| 835 | try: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 836 | f = open(path, 'rb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 837 | except IOError, e: |
| 838 | if e.errno == errno.ENOENT: |
| 839 | raise KeyError('No message with key: %s' % key) |
| 840 | else: |
| 841 | raise |
| 842 | try: |
| 843 | if self._locked: |
| 844 | _lock_file(f) |
| 845 | try: |
| 846 | os.close(os.open(path, os.O_WRONLY | os.O_TRUNC)) |
| 847 | self._dump_message(message, f) |
| 848 | if isinstance(message, MHMessage): |
| 849 | self._dump_sequences(message, key) |
| 850 | finally: |
| 851 | if self._locked: |
| 852 | _unlock_file(f) |
| 853 | finally: |
| 854 | f.close() |
| 855 | |
| 856 | def get_message(self, key): |
| 857 | """Return a Message representation or raise a KeyError.""" |
| 858 | try: |
| 859 | if self._locked: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 860 | f = open(os.path.join(self._path, str(key)), 'r+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 861 | else: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 862 | f = open(os.path.join(self._path, str(key)), 'r') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 863 | except IOError, e: |
| 864 | if e.errno == errno.ENOENT: |
| 865 | raise KeyError('No message with key: %s' % key) |
| 866 | else: |
| 867 | raise |
| 868 | try: |
| 869 | if self._locked: |
| 870 | _lock_file(f) |
| 871 | try: |
| 872 | msg = MHMessage(f) |
| 873 | finally: |
| 874 | if self._locked: |
| 875 | _unlock_file(f) |
| 876 | finally: |
| 877 | f.close() |
| 878 | for name, key_list in self.get_sequences(): |
| 879 | if key in key_list: |
| 880 | msg.add_sequence(name) |
| 881 | return msg |
| 882 | |
| 883 | def get_string(self, key): |
| 884 | """Return a string representation or raise a KeyError.""" |
| 885 | try: |
| 886 | if self._locked: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 887 | f = open(os.path.join(self._path, str(key)), 'r+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 888 | else: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 889 | f = open(os.path.join(self._path, str(key)), 'r') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 890 | except IOError, e: |
| 891 | if e.errno == errno.ENOENT: |
| 892 | raise KeyError('No message with key: %s' % key) |
| 893 | else: |
| 894 | raise |
| 895 | try: |
| 896 | if self._locked: |
| 897 | _lock_file(f) |
| 898 | try: |
| 899 | return f.read() |
| 900 | finally: |
| 901 | if self._locked: |
| 902 | _unlock_file(f) |
| 903 | finally: |
| 904 | f.close() |
| 905 | |
| 906 | def get_file(self, key): |
| 907 | """Return a file-like representation or raise a KeyError.""" |
| 908 | try: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 909 | f = open(os.path.join(self._path, str(key)), 'rb') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 910 | except IOError, e: |
| 911 | if e.errno == errno.ENOENT: |
| 912 | raise KeyError('No message with key: %s' % key) |
| 913 | else: |
| 914 | raise |
| 915 | return _ProxyFile(f) |
| 916 | |
| 917 | def iterkeys(self): |
| 918 | """Return an iterator over keys.""" |
| 919 | return iter(sorted(int(entry) for entry in os.listdir(self._path) |
| 920 | if entry.isdigit())) |
| 921 | |
| 922 | def has_key(self, key): |
| 923 | """Return True if the keyed message exists, False otherwise.""" |
| 924 | return os.path.exists(os.path.join(self._path, str(key))) |
| 925 | |
| 926 | def __len__(self): |
| 927 | """Return a count of messages in the mailbox.""" |
| 928 | return len(list(self.iterkeys())) |
| 929 | |
| 930 | def lock(self): |
| 931 | """Lock the mailbox.""" |
| 932 | if not self._locked: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 933 | self._file = open(os.path.join(self._path, '.mh_sequences'), 'rb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 934 | _lock_file(self._file) |
| 935 | self._locked = True |
| 936 | |
| 937 | def unlock(self): |
| 938 | """Unlock the mailbox if it is locked.""" |
| 939 | if self._locked: |
| 940 | _unlock_file(self._file) |
| 941 | self._file.close() |
| 942 | del self._file |
| 943 | self._locked = False |
| 944 | |
| 945 | def flush(self): |
| 946 | """Write any pending changes to the disk.""" |
| 947 | return |
| 948 | |
| 949 | def close(self): |
| 950 | """Flush and close the mailbox.""" |
| 951 | if self._locked: |
| 952 | self.unlock() |
| 953 | |
| 954 | def list_folders(self): |
| 955 | """Return a list of folder names.""" |
| 956 | result = [] |
| 957 | for entry in os.listdir(self._path): |
| 958 | if os.path.isdir(os.path.join(self._path, entry)): |
| 959 | result.append(entry) |
| 960 | return result |
| 961 | |
| 962 | def get_folder(self, folder): |
| 963 | """Return an MH instance for the named folder.""" |
| 964 | return MH(os.path.join(self._path, folder), create=False) |
| 965 | |
| 966 | def add_folder(self, folder): |
| 967 | """Create a folder and return an MH instance representing it.""" |
| 968 | return MH(os.path.join(self._path, folder)) |
| 969 | |
| 970 | def remove_folder(self, folder): |
| 971 | """Delete the named folder, which must be empty.""" |
| 972 | path = os.path.join(self._path, folder) |
| 973 | entries = os.listdir(path) |
| 974 | if entries == ['.mh_sequences']: |
| 975 | os.remove(os.path.join(path, '.mh_sequences')) |
| 976 | elif entries == []: |
| 977 | pass |
| 978 | else: |
| 979 | raise NotEmptyError('Folder not empty: %s' % self._path) |
| 980 | os.rmdir(path) |
| 981 | |
| 982 | def get_sequences(self): |
| 983 | """Return a name-to-key-list dictionary to define each sequence.""" |
| 984 | results = {} |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 985 | f = open(os.path.join(self._path, '.mh_sequences'), 'r') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 986 | try: |
| 987 | all_keys = set(self.keys()) |
| 988 | for line in f: |
| 989 | try: |
| 990 | name, contents = line.split(':') |
| 991 | keys = set() |
| 992 | for spec in contents.split(): |
| 993 | if spec.isdigit(): |
| 994 | keys.add(int(spec)) |
| 995 | else: |
| 996 | start, stop = (int(x) for x in spec.split('-')) |
| 997 | keys.update(range(start, stop + 1)) |
| 998 | results[name] = [key for key in sorted(keys) \ |
| 999 | if key in all_keys] |
| 1000 | if len(results[name]) == 0: |
| 1001 | del results[name] |
| 1002 | except ValueError: |
| 1003 | raise FormatError('Invalid sequence specification: %s' % |
| 1004 | line.rstrip()) |
| 1005 | finally: |
| 1006 | f.close() |
| 1007 | return results |
| 1008 | |
| 1009 | def set_sequences(self, sequences): |
| 1010 | """Set sequences using the given name-to-key-list dictionary.""" |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 1011 | f = open(os.path.join(self._path, '.mh_sequences'), 'r+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 1012 | try: |
| 1013 | os.close(os.open(f.name, os.O_WRONLY | os.O_TRUNC)) |
| 1014 | for name, keys in sequences.iteritems(): |
| 1015 | if len(keys) == 0: |
| 1016 | continue |
| 1017 | f.write('%s:' % name) |
| 1018 | prev = None |
| 1019 | completing = False |
| 1020 | for key in sorted(set(keys)): |
| 1021 | if key - 1 == prev: |
| 1022 | if not completing: |
| 1023 | completing = True |
| 1024 | f.write('-') |
| 1025 | elif completing: |
| 1026 | completing = False |
| 1027 | f.write('%s %s' % (prev, key)) |
| 1028 | else: |
| 1029 | f.write(' %s' % key) |
| 1030 | prev = key |
| 1031 | if completing: |
| 1032 | f.write(str(prev) + '\n') |
| 1033 | else: |
| 1034 | f.write('\n') |
| 1035 | finally: |
| 1036 | f.close() |
| 1037 | |
| 1038 | def pack(self): |
| 1039 | """Re-name messages to eliminate numbering gaps. Invalidates keys.""" |
| 1040 | sequences = self.get_sequences() |
| 1041 | prev = 0 |
| 1042 | changes = [] |
| 1043 | for key in self.iterkeys(): |
| 1044 | if key - 1 != prev: |
| 1045 | changes.append((key, prev + 1)) |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 1046 | f = open(os.path.join(self._path, str(key)), 'r+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 1047 | try: |
| 1048 | if self._locked: |
| 1049 | _lock_file(f) |
| 1050 | try: |
| 1051 | if hasattr(os, 'link'): |
| 1052 | os.link(os.path.join(self._path, str(key)), |
| 1053 | os.path.join(self._path, str(prev + 1))) |
| 1054 | os.unlink(os.path.join(self._path, str(key))) |
| 1055 | else: |
| 1056 | f.close() |
| 1057 | os.rename(os.path.join(self._path, str(key)), |
| 1058 | os.path.join(self._path, str(prev + 1))) |
| 1059 | finally: |
| 1060 | if self._locked: |
| 1061 | _unlock_file(f) |
| 1062 | finally: |
| 1063 | f.close() |
| 1064 | prev += 1 |
| 1065 | self._next_key = prev + 1 |
| 1066 | if len(changes) == 0: |
| 1067 | return |
| 1068 | for name, key_list in sequences.items(): |
| 1069 | for old, new in changes: |
| 1070 | if old in key_list: |
| 1071 | key_list[key_list.index(old)] = new |
| 1072 | self.set_sequences(sequences) |
| 1073 | |
| 1074 | def _dump_sequences(self, message, key): |
| 1075 | """Inspect a new MHMessage and update sequences appropriately.""" |
| 1076 | pending_sequences = message.get_sequences() |
| 1077 | all_sequences = self.get_sequences() |
| 1078 | for name, key_list in all_sequences.iteritems(): |
| 1079 | if name in pending_sequences: |
| 1080 | key_list.append(key) |
| 1081 | elif key in key_list: |
| 1082 | del key_list[key_list.index(key)] |
| 1083 | for sequence in pending_sequences: |
| 1084 | if sequence not in all_sequences: |
| 1085 | all_sequences[sequence] = [key] |
| 1086 | self.set_sequences(all_sequences) |
| 1087 | |
| 1088 | |
| 1089 | class Babyl(_singlefileMailbox): |
| 1090 | """An Rmail-style Babyl mailbox.""" |
| 1091 | |
| 1092 | _special_labels = frozenset(('unseen', 'deleted', 'filed', 'answered', |
| 1093 | 'forwarded', 'edited', 'resent')) |
| 1094 | |
| 1095 | def __init__(self, path, factory=None, create=True): |
| 1096 | """Initialize a Babyl mailbox.""" |
| 1097 | _singlefileMailbox.__init__(self, path, factory, create) |
| 1098 | self._labels = {} |
| 1099 | |
| 1100 | def add(self, message): |
| 1101 | """Add message and return assigned key.""" |
| 1102 | key = _singlefileMailbox.add(self, message) |
| 1103 | if isinstance(message, BabylMessage): |
| 1104 | self._labels[key] = message.get_labels() |
| 1105 | return key |
| 1106 | |
| 1107 | def remove(self, key): |
| 1108 | """Remove the keyed message; raise KeyError if it doesn't exist.""" |
| 1109 | _singlefileMailbox.remove(self, key) |
| 1110 | if key in self._labels: |
| 1111 | del self._labels[key] |
| 1112 | |
| 1113 | def __setitem__(self, key, message): |
| 1114 | """Replace the keyed message; raise KeyError if it doesn't exist.""" |
| 1115 | _singlefileMailbox.__setitem__(self, key, message) |
| 1116 | if isinstance(message, BabylMessage): |
| 1117 | self._labels[key] = message.get_labels() |
| 1118 | |
| 1119 | def get_message(self, key): |
| 1120 | """Return a Message representation or raise a KeyError.""" |
| 1121 | start, stop = self._lookup(key) |
| 1122 | self._file.seek(start) |
| 1123 | self._file.readline() # Skip '1,' line specifying labels. |
| 1124 | original_headers = StringIO.StringIO() |
| 1125 | while True: |
| 1126 | line = self._file.readline() |
| 1127 | if line == '*** EOOH ***' + os.linesep or line == '': |
| 1128 | break |
| 1129 | original_headers.write(line.replace(os.linesep, '\n')) |
| 1130 | visible_headers = StringIO.StringIO() |
| 1131 | while True: |
| 1132 | line = self._file.readline() |
| 1133 | if line == os.linesep or line == '': |
| 1134 | break |
| 1135 | visible_headers.write(line.replace(os.linesep, '\n')) |
| 1136 | body = self._file.read(stop - self._file.tell()).replace(os.linesep, |
| 1137 | '\n') |
| 1138 | msg = BabylMessage(original_headers.getvalue() + body) |
| 1139 | msg.set_visible(visible_headers.getvalue()) |
| 1140 | if key in self._labels: |
| 1141 | msg.set_labels(self._labels[key]) |
| 1142 | return msg |
| 1143 | |
| 1144 | def get_string(self, key): |
| 1145 | """Return a string representation or raise a KeyError.""" |
| 1146 | start, stop = self._lookup(key) |
| 1147 | self._file.seek(start) |
| 1148 | self._file.readline() # Skip '1,' line specifying labels. |
| 1149 | original_headers = StringIO.StringIO() |
| 1150 | while True: |
| 1151 | line = self._file.readline() |
| 1152 | if line == '*** EOOH ***' + os.linesep or line == '': |
| 1153 | break |
| 1154 | original_headers.write(line.replace(os.linesep, '\n')) |
| 1155 | while True: |
| 1156 | line = self._file.readline() |
| 1157 | if line == os.linesep or line == '': |
| 1158 | break |
| 1159 | return original_headers.getvalue() + \ |
| 1160 | self._file.read(stop - self._file.tell()).replace(os.linesep, |
| 1161 | '\n') |
| 1162 | |
| 1163 | def get_file(self, key): |
| 1164 | """Return a file-like representation or raise a KeyError.""" |
| 1165 | return StringIO.StringIO(self.get_string(key).replace('\n', |
| 1166 | os.linesep)) |
| 1167 | |
| 1168 | def get_labels(self): |
| 1169 | """Return a list of user-defined labels in the mailbox.""" |
| 1170 | self._lookup() |
| 1171 | labels = set() |
| 1172 | for label_list in self._labels.values(): |
| 1173 | labels.update(label_list) |
| 1174 | labels.difference_update(self._special_labels) |
| 1175 | return list(labels) |
| 1176 | |
| 1177 | def _generate_toc(self): |
| 1178 | """Generate key-to-(start, stop) table of contents.""" |
| 1179 | starts, stops = [], [] |
| 1180 | self._file.seek(0) |
| 1181 | next_pos = 0 |
| 1182 | label_lists = [] |
| 1183 | while True: |
| 1184 | line_pos = next_pos |
| 1185 | line = self._file.readline() |
| 1186 | next_pos = self._file.tell() |
| 1187 | if line == '\037\014' + os.linesep: |
| 1188 | if len(stops) < len(starts): |
| 1189 | stops.append(line_pos - len(os.linesep)) |
| 1190 | starts.append(next_pos) |
| 1191 | labels = [label.strip() for label |
| 1192 | in self._file.readline()[1:].split(',') |
| 1193 | if label.strip() != ''] |
| 1194 | label_lists.append(labels) |
| 1195 | elif line == '\037' or line == '\037' + os.linesep: |
| 1196 | if len(stops) < len(starts): |
| 1197 | stops.append(line_pos - len(os.linesep)) |
| 1198 | elif line == '': |
| 1199 | stops.append(line_pos - len(os.linesep)) |
| 1200 | break |
| 1201 | self._toc = dict(enumerate(zip(starts, stops))) |
| 1202 | self._labels = dict(enumerate(label_lists)) |
| 1203 | self._next_key = len(self._toc) |
| 1204 | |
| 1205 | def _pre_mailbox_hook(self, f): |
| 1206 | """Called before writing the mailbox to file f.""" |
| 1207 | f.write('BABYL OPTIONS:%sVersion: 5%sLabels:%s%s\037' % |
| 1208 | (os.linesep, os.linesep, ','.join(self.get_labels()), |
| 1209 | os.linesep)) |
| 1210 | |
| 1211 | def _pre_message_hook(self, f): |
| 1212 | """Called before writing each message to file f.""" |
| 1213 | f.write('\014' + os.linesep) |
| 1214 | |
| 1215 | def _post_message_hook(self, f): |
| 1216 | """Called after writing each message to file f.""" |
| 1217 | f.write(os.linesep + '\037') |
| 1218 | |
| 1219 | def _install_message(self, message): |
| 1220 | """Write message contents and return (start, stop).""" |
| 1221 | start = self._file.tell() |
| 1222 | if isinstance(message, BabylMessage): |
| 1223 | special_labels = [] |
| 1224 | labels = [] |
| 1225 | for label in message.get_labels(): |
| 1226 | if label in self._special_labels: |
| 1227 | special_labels.append(label) |
| 1228 | else: |
| 1229 | labels.append(label) |
| 1230 | self._file.write('1') |
| 1231 | for label in special_labels: |
| 1232 | self._file.write(', ' + label) |
| 1233 | self._file.write(',,') |
| 1234 | for label in labels: |
| 1235 | self._file.write(' ' + label + ',') |
| 1236 | self._file.write(os.linesep) |
| 1237 | else: |
| 1238 | self._file.write('1,,' + os.linesep) |
| 1239 | if isinstance(message, email.Message.Message): |
| 1240 | orig_buffer = StringIO.StringIO() |
| 1241 | orig_generator = email.Generator.Generator(orig_buffer, False, 0) |
| 1242 | orig_generator.flatten(message) |
| 1243 | orig_buffer.seek(0) |
| 1244 | while True: |
| 1245 | line = orig_buffer.readline() |
| 1246 | self._file.write(line.replace('\n', os.linesep)) |
| 1247 | if line == '\n' or line == '': |
| 1248 | break |
| 1249 | self._file.write('*** EOOH ***' + os.linesep) |
| 1250 | if isinstance(message, BabylMessage): |
| 1251 | vis_buffer = StringIO.StringIO() |
| 1252 | vis_generator = email.Generator.Generator(vis_buffer, False, 0) |
| 1253 | vis_generator.flatten(message.get_visible()) |
| 1254 | while True: |
| 1255 | line = vis_buffer.readline() |
| 1256 | self._file.write(line.replace('\n', os.linesep)) |
| 1257 | if line == '\n' or line == '': |
| 1258 | break |
| 1259 | else: |
| 1260 | orig_buffer.seek(0) |
| 1261 | while True: |
| 1262 | line = orig_buffer.readline() |
| 1263 | self._file.write(line.replace('\n', os.linesep)) |
| 1264 | if line == '\n' or line == '': |
| 1265 | break |
| 1266 | while True: |
| 1267 | buffer = orig_buffer.read(4096) # Buffer size is arbitrary. |
| 1268 | if buffer == '': |
| 1269 | break |
| 1270 | self._file.write(buffer.replace('\n', os.linesep)) |
| 1271 | elif isinstance(message, str): |
| 1272 | body_start = message.find('\n\n') + 2 |
| 1273 | if body_start - 2 != -1: |
| 1274 | self._file.write(message[:body_start].replace('\n', |
| 1275 | os.linesep)) |
| 1276 | self._file.write('*** EOOH ***' + os.linesep) |
| 1277 | self._file.write(message[:body_start].replace('\n', |
| 1278 | os.linesep)) |
| 1279 | self._file.write(message[body_start:].replace('\n', |
| 1280 | os.linesep)) |
| 1281 | else: |
| 1282 | self._file.write('*** EOOH ***' + os.linesep + os.linesep) |
| 1283 | self._file.write(message.replace('\n', os.linesep)) |
| 1284 | elif hasattr(message, 'readline'): |
| 1285 | original_pos = message.tell() |
| 1286 | first_pass = True |
| 1287 | while True: |
| 1288 | line = message.readline() |
| 1289 | self._file.write(line.replace('\n', os.linesep)) |
| 1290 | if line == '\n' or line == '': |
| 1291 | self._file.write('*** EOOH ***' + os.linesep) |
| 1292 | if first_pass: |
| 1293 | first_pass = False |
| 1294 | message.seek(original_pos) |
| 1295 | else: |
| 1296 | break |
| 1297 | while True: |
| 1298 | buffer = message.read(4096) # Buffer size is arbitrary. |
| 1299 | if buffer == '': |
| 1300 | break |
| 1301 | self._file.write(buffer.replace('\n', os.linesep)) |
| 1302 | else: |
| 1303 | raise TypeError('Invalid message type: %s' % type(message)) |
| 1304 | stop = self._file.tell() |
| 1305 | return (start, stop) |
| 1306 | |
| 1307 | |
| 1308 | class Message(email.Message.Message): |
| 1309 | """Message with mailbox-format-specific properties.""" |
| 1310 | |
| 1311 | def __init__(self, message=None): |
| 1312 | """Initialize a Message instance.""" |
| 1313 | if isinstance(message, email.Message.Message): |
| 1314 | self._become_message(copy.deepcopy(message)) |
| 1315 | if isinstance(message, Message): |
| 1316 | message._explain_to(self) |
| 1317 | elif isinstance(message, str): |
| 1318 | self._become_message(email.message_from_string(message)) |
| 1319 | elif hasattr(message, "read"): |
| 1320 | self._become_message(email.message_from_file(message)) |
| 1321 | elif message is None: |
| 1322 | email.Message.Message.__init__(self) |
| 1323 | else: |
| 1324 | raise TypeError('Invalid message type: %s' % type(message)) |
| 1325 | |
| 1326 | def _become_message(self, message): |
| 1327 | """Assume the non-format-specific state of message.""" |
| 1328 | for name in ('_headers', '_unixfrom', '_payload', '_charset', |
| 1329 | 'preamble', 'epilogue', 'defects', '_default_type'): |
| 1330 | self.__dict__[name] = message.__dict__[name] |
| 1331 | |
| 1332 | def _explain_to(self, message): |
| 1333 | """Copy format-specific state to message insofar as possible.""" |
| 1334 | if isinstance(message, Message): |
| 1335 | return # There's nothing format-specific to explain. |
| 1336 | else: |
| 1337 | raise TypeError('Cannot convert to specified type') |
| 1338 | |
| 1339 | |
| 1340 | class MaildirMessage(Message): |
| 1341 | """Message with Maildir-specific properties.""" |
| 1342 | |
| 1343 | def __init__(self, message=None): |
| 1344 | """Initialize a MaildirMessage instance.""" |
| 1345 | self._subdir = 'new' |
| 1346 | self._info = '' |
| 1347 | self._date = time.time() |
| 1348 | Message.__init__(self, message) |
| 1349 | |
| 1350 | def get_subdir(self): |
| 1351 | """Return 'new' or 'cur'.""" |
| 1352 | return self._subdir |
| 1353 | |
| 1354 | def set_subdir(self, subdir): |
| 1355 | """Set subdir to 'new' or 'cur'.""" |
| 1356 | if subdir == 'new' or subdir == 'cur': |
| 1357 | self._subdir = subdir |
| 1358 | else: |
| 1359 | raise ValueError("subdir must be 'new' or 'cur': %s" % subdir) |
| 1360 | |
| 1361 | def get_flags(self): |
| 1362 | """Return as a string the flags that are set.""" |
| 1363 | if self._info.startswith('2,'): |
| 1364 | return self._info[2:] |
| 1365 | else: |
| 1366 | return '' |
| 1367 | |
| 1368 | def set_flags(self, flags): |
| 1369 | """Set the given flags and unset all others.""" |
| 1370 | self._info = '2,' + ''.join(sorted(flags)) |
| 1371 | |
| 1372 | def add_flag(self, flag): |
| 1373 | """Set the given flag(s) without changing others.""" |
| 1374 | self.set_flags(''.join(set(self.get_flags()) | set(flag))) |
| 1375 | |
| 1376 | def remove_flag(self, flag): |
| 1377 | """Unset the given string flag(s) without changing others.""" |
| 1378 | if self.get_flags() != '': |
| 1379 | self.set_flags(''.join(set(self.get_flags()) - set(flag))) |
| 1380 | |
| 1381 | def get_date(self): |
| 1382 | """Return delivery date of message, in seconds since the epoch.""" |
| 1383 | return self._date |
| 1384 | |
| 1385 | def set_date(self, date): |
| 1386 | """Set delivery date of message, in seconds since the epoch.""" |
| 1387 | try: |
| 1388 | self._date = float(date) |
| 1389 | except ValueError: |
| 1390 | raise TypeError("can't convert to float: %s" % date) |
| 1391 | |
| 1392 | def get_info(self): |
| 1393 | """Get the message's "info" as a string.""" |
| 1394 | return self._info |
| 1395 | |
| 1396 | def set_info(self, info): |
| 1397 | """Set the message's "info" string.""" |
| 1398 | if isinstance(info, str): |
| 1399 | self._info = info |
| 1400 | else: |
| 1401 | raise TypeError('info must be a string: %s' % type(info)) |
| 1402 | |
| 1403 | def _explain_to(self, message): |
| 1404 | """Copy Maildir-specific state to message insofar as possible.""" |
| 1405 | if isinstance(message, MaildirMessage): |
| 1406 | message.set_flags(self.get_flags()) |
| 1407 | message.set_subdir(self.get_subdir()) |
| 1408 | message.set_date(self.get_date()) |
| 1409 | elif isinstance(message, _mboxMMDFMessage): |
| 1410 | flags = set(self.get_flags()) |
| 1411 | if 'S' in flags: |
| 1412 | message.add_flag('R') |
| 1413 | if self.get_subdir() == 'cur': |
| 1414 | message.add_flag('O') |
| 1415 | if 'T' in flags: |
| 1416 | message.add_flag('D') |
| 1417 | if 'F' in flags: |
| 1418 | message.add_flag('F') |
| 1419 | if 'R' in flags: |
| 1420 | message.add_flag('A') |
| 1421 | message.set_from('MAILER-DAEMON', time.gmtime(self.get_date())) |
| 1422 | elif isinstance(message, MHMessage): |
| 1423 | flags = set(self.get_flags()) |
| 1424 | if 'S' not in flags: |
| 1425 | message.add_sequence('unseen') |
| 1426 | if 'R' in flags: |
| 1427 | message.add_sequence('replied') |
| 1428 | if 'F' in flags: |
| 1429 | message.add_sequence('flagged') |
| 1430 | elif isinstance(message, BabylMessage): |
| 1431 | flags = set(self.get_flags()) |
| 1432 | if 'S' not in flags: |
| 1433 | message.add_label('unseen') |
| 1434 | if 'T' in flags: |
| 1435 | message.add_label('deleted') |
| 1436 | if 'R' in flags: |
| 1437 | message.add_label('answered') |
| 1438 | if 'P' in flags: |
| 1439 | message.add_label('forwarded') |
| 1440 | elif isinstance(message, Message): |
| 1441 | pass |
| 1442 | else: |
| 1443 | raise TypeError('Cannot convert to specified type: %s' % |
| 1444 | type(message)) |
| 1445 | |
| 1446 | |
| 1447 | class _mboxMMDFMessage(Message): |
| 1448 | """Message with mbox- or MMDF-specific properties.""" |
| 1449 | |
| 1450 | def __init__(self, message=None): |
| 1451 | """Initialize an mboxMMDFMessage instance.""" |
| 1452 | self.set_from('MAILER-DAEMON', True) |
| 1453 | if isinstance(message, email.Message.Message): |
| 1454 | unixfrom = message.get_unixfrom() |
| 1455 | if unixfrom is not None and unixfrom.startswith('From '): |
| 1456 | self.set_from(unixfrom[5:]) |
| 1457 | Message.__init__(self, message) |
| 1458 | |
| 1459 | def get_from(self): |
| 1460 | """Return contents of "From " line.""" |
| 1461 | return self._from |
| 1462 | |
| 1463 | def set_from(self, from_, time_=None): |
| 1464 | """Set "From " line, formatting and appending time_ if specified.""" |
| 1465 | if time_ is not None: |
| 1466 | if time_ is True: |
| 1467 | time_ = time.gmtime() |
| 1468 | from_ += ' ' + time.asctime(time_) |
| 1469 | self._from = from_ |
| 1470 | |
| 1471 | def get_flags(self): |
| 1472 | """Return as a string the flags that are set.""" |
| 1473 | return self.get('Status', '') + self.get('X-Status', '') |
| 1474 | |
| 1475 | def set_flags(self, flags): |
| 1476 | """Set the given flags and unset all others.""" |
| 1477 | flags = set(flags) |
| 1478 | status_flags, xstatus_flags = '', '' |
| 1479 | for flag in ('R', 'O'): |
| 1480 | if flag in flags: |
| 1481 | status_flags += flag |
| 1482 | flags.remove(flag) |
| 1483 | for flag in ('D', 'F', 'A'): |
| 1484 | if flag in flags: |
| 1485 | xstatus_flags += flag |
| 1486 | flags.remove(flag) |
| 1487 | xstatus_flags += ''.join(sorted(flags)) |
| 1488 | try: |
| 1489 | self.replace_header('Status', status_flags) |
| 1490 | except KeyError: |
| 1491 | self.add_header('Status', status_flags) |
| 1492 | try: |
| 1493 | self.replace_header('X-Status', xstatus_flags) |
| 1494 | except KeyError: |
| 1495 | self.add_header('X-Status', xstatus_flags) |
| 1496 | |
| 1497 | def add_flag(self, flag): |
| 1498 | """Set the given flag(s) without changing others.""" |
| 1499 | self.set_flags(''.join(set(self.get_flags()) | set(flag))) |
| 1500 | |
| 1501 | def remove_flag(self, flag): |
| 1502 | """Unset the given string flag(s) without changing others.""" |
| 1503 | if 'Status' in self or 'X-Status' in self: |
| 1504 | self.set_flags(''.join(set(self.get_flags()) - set(flag))) |
| 1505 | |
| 1506 | def _explain_to(self, message): |
| 1507 | """Copy mbox- or MMDF-specific state to message insofar as possible.""" |
| 1508 | if isinstance(message, MaildirMessage): |
| 1509 | flags = set(self.get_flags()) |
| 1510 | if 'O' in flags: |
| 1511 | message.set_subdir('cur') |
| 1512 | if 'F' in flags: |
| 1513 | message.add_flag('F') |
| 1514 | if 'A' in flags: |
| 1515 | message.add_flag('R') |
| 1516 | if 'R' in flags: |
| 1517 | message.add_flag('S') |
| 1518 | if 'D' in flags: |
| 1519 | message.add_flag('T') |
| 1520 | del message['status'] |
| 1521 | del message['x-status'] |
| 1522 | maybe_date = ' '.join(self.get_from().split()[-5:]) |
| 1523 | try: |
| 1524 | message.set_date(calendar.timegm(time.strptime(maybe_date, |
| 1525 | '%a %b %d %H:%M:%S %Y'))) |
| 1526 | except (ValueError, OverflowError): |
| 1527 | pass |
| 1528 | elif isinstance(message, _mboxMMDFMessage): |
| 1529 | message.set_flags(self.get_flags()) |
| 1530 | message.set_from(self.get_from()) |
| 1531 | elif isinstance(message, MHMessage): |
| 1532 | flags = set(self.get_flags()) |
| 1533 | if 'R' not in flags: |
| 1534 | message.add_sequence('unseen') |
| 1535 | if 'A' in flags: |
| 1536 | message.add_sequence('replied') |
| 1537 | if 'F' in flags: |
| 1538 | message.add_sequence('flagged') |
| 1539 | del message['status'] |
| 1540 | del message['x-status'] |
| 1541 | elif isinstance(message, BabylMessage): |
| 1542 | flags = set(self.get_flags()) |
| 1543 | if 'R' not in flags: |
| 1544 | message.add_label('unseen') |
| 1545 | if 'D' in flags: |
| 1546 | message.add_label('deleted') |
| 1547 | if 'A' in flags: |
| 1548 | message.add_label('answered') |
| 1549 | del message['status'] |
| 1550 | del message['x-status'] |
| 1551 | elif isinstance(message, Message): |
| 1552 | pass |
| 1553 | else: |
| 1554 | raise TypeError('Cannot convert to specified type: %s' % |
| 1555 | type(message)) |
| 1556 | |
| 1557 | |
| 1558 | class mboxMessage(_mboxMMDFMessage): |
| 1559 | """Message with mbox-specific properties.""" |
| 1560 | |
| 1561 | |
| 1562 | class MHMessage(Message): |
| 1563 | """Message with MH-specific properties.""" |
| 1564 | |
| 1565 | def __init__(self, message=None): |
| 1566 | """Initialize an MHMessage instance.""" |
| 1567 | self._sequences = [] |
| 1568 | Message.__init__(self, message) |
| 1569 | |
| 1570 | def get_sequences(self): |
| 1571 | """Return a list of sequences that include the message.""" |
| 1572 | return self._sequences[:] |
| 1573 | |
| 1574 | def set_sequences(self, sequences): |
| 1575 | """Set the list of sequences that include the message.""" |
| 1576 | self._sequences = list(sequences) |
| 1577 | |
| 1578 | def add_sequence(self, sequence): |
| 1579 | """Add sequence to list of sequences including the message.""" |
| 1580 | if isinstance(sequence, str): |
| 1581 | if not sequence in self._sequences: |
| 1582 | self._sequences.append(sequence) |
| 1583 | else: |
| 1584 | raise TypeError('sequence must be a string: %s' % type(sequence)) |
| 1585 | |
| 1586 | def remove_sequence(self, sequence): |
| 1587 | """Remove sequence from the list of sequences including the message.""" |
| 1588 | try: |
| 1589 | self._sequences.remove(sequence) |
| 1590 | except ValueError: |
| 1591 | pass |
| 1592 | |
| 1593 | def _explain_to(self, message): |
| 1594 | """Copy MH-specific state to message insofar as possible.""" |
| 1595 | if isinstance(message, MaildirMessage): |
| 1596 | sequences = set(self.get_sequences()) |
| 1597 | if 'unseen' in sequences: |
| 1598 | message.set_subdir('cur') |
| 1599 | else: |
| 1600 | message.set_subdir('cur') |
| 1601 | message.add_flag('S') |
| 1602 | if 'flagged' in sequences: |
| 1603 | message.add_flag('F') |
| 1604 | if 'replied' in sequences: |
| 1605 | message.add_flag('R') |
| 1606 | elif isinstance(message, _mboxMMDFMessage): |
| 1607 | sequences = set(self.get_sequences()) |
| 1608 | if 'unseen' not in sequences: |
| 1609 | message.add_flag('RO') |
| 1610 | else: |
| 1611 | message.add_flag('O') |
| 1612 | if 'flagged' in sequences: |
| 1613 | message.add_flag('F') |
| 1614 | if 'replied' in sequences: |
| 1615 | message.add_flag('A') |
| 1616 | elif isinstance(message, MHMessage): |
| 1617 | for sequence in self.get_sequences(): |
| 1618 | message.add_sequence(sequence) |
| 1619 | elif isinstance(message, BabylMessage): |
| 1620 | sequences = set(self.get_sequences()) |
| 1621 | if 'unseen' in sequences: |
| 1622 | message.add_label('unseen') |
| 1623 | if 'replied' in sequences: |
| 1624 | message.add_label('answered') |
| 1625 | elif isinstance(message, Message): |
| 1626 | pass |
| 1627 | else: |
| 1628 | raise TypeError('Cannot convert to specified type: %s' % |
| 1629 | type(message)) |
| 1630 | |
| 1631 | |
| 1632 | class BabylMessage(Message): |
| 1633 | """Message with Babyl-specific properties.""" |
| 1634 | |
| 1635 | def __init__(self, message=None): |
| 1636 | """Initialize an BabylMessage instance.""" |
| 1637 | self._labels = [] |
| 1638 | self._visible = Message() |
| 1639 | Message.__init__(self, message) |
| 1640 | |
| 1641 | def get_labels(self): |
| 1642 | """Return a list of labels on the message.""" |
| 1643 | return self._labels[:] |
| 1644 | |
| 1645 | def set_labels(self, labels): |
| 1646 | """Set the list of labels on the message.""" |
| 1647 | self._labels = list(labels) |
| 1648 | |
| 1649 | def add_label(self, label): |
| 1650 | """Add label to list of labels on the message.""" |
| 1651 | if isinstance(label, str): |
| 1652 | if label not in self._labels: |
| 1653 | self._labels.append(label) |
| 1654 | else: |
| 1655 | raise TypeError('label must be a string: %s' % type(label)) |
| 1656 | |
| 1657 | def remove_label(self, label): |
| 1658 | """Remove label from the list of labels on the message.""" |
| 1659 | try: |
| 1660 | self._labels.remove(label) |
| 1661 | except ValueError: |
| 1662 | pass |
Tim Peters | 6d7cd7d | 2006-04-22 05:52:59 +0000 | [diff] [blame] | 1663 | |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 1664 | def get_visible(self): |
| 1665 | """Return a Message representation of visible headers.""" |
| 1666 | return Message(self._visible) |
| 1667 | |
| 1668 | def set_visible(self, visible): |
| 1669 | """Set the Message representation of visible headers.""" |
| 1670 | self._visible = Message(visible) |
| 1671 | |
| 1672 | def update_visible(self): |
| 1673 | """Update and/or sensibly generate a set of visible headers.""" |
| 1674 | for header in self._visible.keys(): |
| 1675 | if header in self: |
| 1676 | self._visible.replace_header(header, self[header]) |
| 1677 | else: |
| 1678 | del self._visible[header] |
| 1679 | for header in ('Date', 'From', 'Reply-To', 'To', 'CC', 'Subject'): |
| 1680 | if header in self and header not in self._visible: |
| 1681 | self._visible[header] = self[header] |
| 1682 | |
| 1683 | def _explain_to(self, message): |
| 1684 | """Copy Babyl-specific state to message insofar as possible.""" |
| 1685 | if isinstance(message, MaildirMessage): |
| 1686 | labels = set(self.get_labels()) |
| 1687 | if 'unseen' in labels: |
| 1688 | message.set_subdir('cur') |
| 1689 | else: |
| 1690 | message.set_subdir('cur') |
| 1691 | message.add_flag('S') |
| 1692 | if 'forwarded' in labels or 'resent' in labels: |
| 1693 | message.add_flag('P') |
| 1694 | if 'answered' in labels: |
| 1695 | message.add_flag('R') |
| 1696 | if 'deleted' in labels: |
| 1697 | message.add_flag('T') |
| 1698 | elif isinstance(message, _mboxMMDFMessage): |
| 1699 | labels = set(self.get_labels()) |
| 1700 | if 'unseen' not in labels: |
| 1701 | message.add_flag('RO') |
| 1702 | else: |
| 1703 | message.add_flag('O') |
| 1704 | if 'deleted' in labels: |
| 1705 | message.add_flag('D') |
| 1706 | if 'answered' in labels: |
| 1707 | message.add_flag('A') |
| 1708 | elif isinstance(message, MHMessage): |
| 1709 | labels = set(self.get_labels()) |
| 1710 | if 'unseen' in labels: |
| 1711 | message.add_sequence('unseen') |
| 1712 | if 'answered' in labels: |
| 1713 | message.add_sequence('replied') |
| 1714 | elif isinstance(message, BabylMessage): |
| 1715 | message.set_visible(self.get_visible()) |
| 1716 | for label in self.get_labels(): |
| 1717 | message.add_label(label) |
| 1718 | elif isinstance(message, Message): |
| 1719 | pass |
| 1720 | else: |
| 1721 | raise TypeError('Cannot convert to specified type: %s' % |
| 1722 | type(message)) |
| 1723 | |
| 1724 | |
| 1725 | class MMDFMessage(_mboxMMDFMessage): |
| 1726 | """Message with MMDF-specific properties.""" |
| 1727 | |
| 1728 | |
| 1729 | class _ProxyFile: |
| 1730 | """A read-only wrapper of a file.""" |
| 1731 | |
| 1732 | def __init__(self, f, pos=None): |
| 1733 | """Initialize a _ProxyFile.""" |
| 1734 | self._file = f |
| 1735 | if pos is None: |
| 1736 | self._pos = f.tell() |
| 1737 | else: |
| 1738 | self._pos = pos |
| 1739 | |
| 1740 | def read(self, size=None): |
| 1741 | """Read bytes.""" |
| 1742 | return self._read(size, self._file.read) |
| 1743 | |
| 1744 | def readline(self, size=None): |
| 1745 | """Read a line.""" |
| 1746 | return self._read(size, self._file.readline) |
| 1747 | |
| 1748 | def readlines(self, sizehint=None): |
| 1749 | """Read multiple lines.""" |
| 1750 | result = [] |
| 1751 | for line in self: |
| 1752 | result.append(line) |
| 1753 | if sizehint is not None: |
| 1754 | sizehint -= len(line) |
| 1755 | if sizehint <= 0: |
| 1756 | break |
| 1757 | return result |
| 1758 | |
| 1759 | def __iter__(self): |
| 1760 | """Iterate over lines.""" |
| 1761 | return iter(self.readline, "") |
| 1762 | |
| 1763 | def tell(self): |
| 1764 | """Return the position.""" |
| 1765 | return self._pos |
| 1766 | |
| 1767 | def seek(self, offset, whence=0): |
| 1768 | """Change position.""" |
| 1769 | if whence == 1: |
| 1770 | self._file.seek(self._pos) |
| 1771 | self._file.seek(offset, whence) |
| 1772 | self._pos = self._file.tell() |
| 1773 | |
| 1774 | def close(self): |
| 1775 | """Close the file.""" |
| 1776 | del self._file |
| 1777 | |
| 1778 | def _read(self, size, read_method): |
| 1779 | """Read size bytes using read_method.""" |
| 1780 | if size is None: |
| 1781 | size = -1 |
| 1782 | self._file.seek(self._pos) |
| 1783 | result = read_method(size) |
| 1784 | self._pos = self._file.tell() |
| 1785 | return result |
| 1786 | |
| 1787 | |
| 1788 | class _PartialFile(_ProxyFile): |
| 1789 | """A read-only wrapper of part of a file.""" |
| 1790 | |
| 1791 | def __init__(self, f, start=None, stop=None): |
| 1792 | """Initialize a _PartialFile.""" |
| 1793 | _ProxyFile.__init__(self, f, start) |
| 1794 | self._start = start |
| 1795 | self._stop = stop |
| 1796 | |
| 1797 | def tell(self): |
| 1798 | """Return the position with respect to start.""" |
| 1799 | return _ProxyFile.tell(self) - self._start |
| 1800 | |
| 1801 | def seek(self, offset, whence=0): |
| 1802 | """Change position, possibly with respect to start or stop.""" |
| 1803 | if whence == 0: |
| 1804 | self._pos = self._start |
| 1805 | whence = 1 |
| 1806 | elif whence == 2: |
| 1807 | self._pos = self._stop |
| 1808 | whence = 1 |
| 1809 | _ProxyFile.seek(self, offset, whence) |
| 1810 | |
| 1811 | def _read(self, size, read_method): |
| 1812 | """Read size bytes using read_method, honoring start and stop.""" |
| 1813 | remaining = self._stop - self._pos |
| 1814 | if remaining <= 0: |
| 1815 | return '' |
| 1816 | if size is None or size < 0 or size > remaining: |
| 1817 | size = remaining |
| 1818 | return _ProxyFile._read(self, size, read_method) |
| 1819 | |
| 1820 | |
| 1821 | def _lock_file(f, dotlock=True): |
| 1822 | """Lock file f using lockf, flock, and dot locking.""" |
| 1823 | dotlock_done = False |
| 1824 | try: |
| 1825 | if fcntl: |
| 1826 | try: |
| 1827 | fcntl.lockf(f, fcntl.LOCK_EX | fcntl.LOCK_NB) |
| 1828 | except IOError, e: |
| 1829 | if e.errno == errno.EAGAIN: |
| 1830 | raise ExternalClashError('lockf: lock unavailable: %s' % |
| 1831 | f.name) |
| 1832 | else: |
| 1833 | raise |
| 1834 | try: |
| 1835 | fcntl.flock(f, fcntl.LOCK_EX | fcntl.LOCK_NB) |
| 1836 | except IOError, e: |
| 1837 | if e.errno == errno.EWOULDBLOCK: |
| 1838 | raise ExternalClashError('flock: lock unavailable: %s' % |
| 1839 | f.name) |
| 1840 | else: |
| 1841 | raise |
| 1842 | if dotlock: |
| 1843 | try: |
| 1844 | pre_lock = _create_temporary(f.name + '.lock') |
| 1845 | pre_lock.close() |
| 1846 | except IOError, e: |
| 1847 | if e.errno == errno.EACCES: |
| 1848 | return # Without write access, just skip dotlocking. |
| 1849 | else: |
| 1850 | raise |
| 1851 | try: |
| 1852 | if hasattr(os, 'link'): |
| 1853 | os.link(pre_lock.name, f.name + '.lock') |
| 1854 | dotlock_done = True |
| 1855 | os.unlink(pre_lock.name) |
| 1856 | else: |
| 1857 | os.rename(pre_lock.name, f.name + '.lock') |
| 1858 | dotlock_done = True |
Martin v. Löwis | 08041d5 | 2006-05-04 14:27:52 +0000 | [diff] [blame^] | 1859 | except WindowsError, e: |
| 1860 | if e.errno == 183: # ERROR_ALREADY_EXISTS |
| 1861 | os.remove(pre_lock.name) |
| 1862 | raise ExternalClashError('dot lock unavailable: %s' % |
| 1863 | f.name) |
| 1864 | else: |
| 1865 | raise |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 1866 | except OSError, e: |
| 1867 | if e.errno == errno.EEXIST: |
| 1868 | os.remove(pre_lock.name) |
Tim Peters | 6d7cd7d | 2006-04-22 05:52:59 +0000 | [diff] [blame] | 1869 | raise ExternalClashError('dot lock unavailable: %s' % |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 1870 | f.name) |
| 1871 | else: |
| 1872 | raise |
| 1873 | except: |
| 1874 | if fcntl: |
| 1875 | fcntl.lockf(f, fcntl.LOCK_UN) |
| 1876 | fcntl.flock(f, fcntl.LOCK_UN) |
| 1877 | if dotlock_done: |
| 1878 | os.remove(f.name + '.lock') |
| 1879 | raise |
| 1880 | |
| 1881 | def _unlock_file(f): |
| 1882 | """Unlock file f using lockf, flock, and dot locking.""" |
| 1883 | if fcntl: |
| 1884 | fcntl.lockf(f, fcntl.LOCK_UN) |
| 1885 | fcntl.flock(f, fcntl.LOCK_UN) |
| 1886 | if os.path.exists(f.name + '.lock'): |
| 1887 | os.remove(f.name + '.lock') |
| 1888 | |
| 1889 | def _create_carefully(path): |
| 1890 | """Create a file if it doesn't exist and open for reading and writing.""" |
| 1891 | fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDWR) |
| 1892 | try: |
Andrew M. Kuchling | 214db63 | 2006-05-02 21:44:33 +0000 | [diff] [blame] | 1893 | return open(path, 'rb+') |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 1894 | finally: |
| 1895 | os.close(fd) |
| 1896 | |
| 1897 | def _create_temporary(path): |
| 1898 | """Create a temp file based on path and open for reading and writing.""" |
| 1899 | return _create_carefully('%s.%s.%s.%s' % (path, int(time.time()), |
| 1900 | socket.gethostname(), |
| 1901 | os.getpid())) |
| 1902 | |
| 1903 | |
| 1904 | ## Start: classes from the original module (for backward compatibility). |
| 1905 | |
| 1906 | # Note that the Maildir class, whose name is unchanged, itself offers a next() |
| 1907 | # method for backward compatibility. |
Skip Montanaro | 17ab123 | 2001-01-24 06:27:27 +0000 | [diff] [blame] | 1908 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 1909 | class _Mailbox: |
Guido van Rossum | 4bf1254 | 2002-09-12 05:08:00 +0000 | [diff] [blame] | 1910 | |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 1911 | def __init__(self, fp, factory=rfc822.Message): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 1912 | self.fp = fp |
| 1913 | self.seekp = 0 |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 1914 | self.factory = factory |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 1915 | |
Fred Drake | 72987a4 | 2001-05-02 20:20:53 +0000 | [diff] [blame] | 1916 | def __iter__(self): |
Guido van Rossum | 93a696f | 2001-09-13 01:29:13 +0000 | [diff] [blame] | 1917 | return iter(self.next, None) |
Fred Drake | 72987a4 | 2001-05-02 20:20:53 +0000 | [diff] [blame] | 1918 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 1919 | def next(self): |
| 1920 | while 1: |
| 1921 | self.fp.seek(self.seekp) |
| 1922 | try: |
| 1923 | self._search_start() |
| 1924 | except EOFError: |
| 1925 | self.seekp = self.fp.tell() |
| 1926 | return None |
| 1927 | start = self.fp.tell() |
| 1928 | self._search_end() |
| 1929 | self.seekp = stop = self.fp.tell() |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 1930 | if start != stop: |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 1931 | break |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 1932 | return self.factory(_PartialFile(self.fp, start, stop)) |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 1933 | |
Barry Warsaw | ffd05ee | 2002-03-01 22:39:14 +0000 | [diff] [blame] | 1934 | # Recommended to use PortableUnixMailbox instead! |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 1935 | class UnixMailbox(_Mailbox): |
Guido van Rossum | 4bf1254 | 2002-09-12 05:08:00 +0000 | [diff] [blame] | 1936 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 1937 | def _search_start(self): |
| 1938 | while 1: |
| 1939 | pos = self.fp.tell() |
| 1940 | line = self.fp.readline() |
| 1941 | if not line: |
| 1942 | raise EOFError |
| 1943 | if line[:5] == 'From ' and self._isrealfromline(line): |
| 1944 | self.fp.seek(pos) |
| 1945 | return |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 1946 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 1947 | def _search_end(self): |
| 1948 | self.fp.readline() # Throw away header line |
| 1949 | while 1: |
| 1950 | pos = self.fp.tell() |
| 1951 | line = self.fp.readline() |
| 1952 | if not line: |
| 1953 | return |
| 1954 | if line[:5] == 'From ' and self._isrealfromline(line): |
| 1955 | self.fp.seek(pos) |
| 1956 | return |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 1957 | |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 1958 | # An overridable mechanism to test for From-line-ness. You can either |
| 1959 | # specify a different regular expression or define a whole new |
| 1960 | # _isrealfromline() method. Note that this only gets called for lines |
| 1961 | # starting with the 5 characters "From ". |
| 1962 | # |
| 1963 | # BAW: According to |
| 1964 | #http://home.netscape.com/eng/mozilla/2.0/relnotes/demo/content-length.html |
| 1965 | # the only portable, reliable way to find message delimiters in a BSD (i.e |
| 1966 | # Unix mailbox) style folder is to search for "\n\nFrom .*\n", or at the |
| 1967 | # beginning of the file, "^From .*\n". While _fromlinepattern below seems |
| 1968 | # like a good idea, in practice, there are too many variations for more |
| 1969 | # strict parsing of the line to be completely accurate. |
| 1970 | # |
| 1971 | # _strict_isrealfromline() is the old version which tries to do stricter |
| 1972 | # parsing of the From_ line. _portable_isrealfromline() simply returns |
| 1973 | # true, since it's never called if the line doesn't already start with |
| 1974 | # "From ". |
| 1975 | # |
| 1976 | # This algorithm, and the way it interacts with _search_start() and |
| 1977 | # _search_end() may not be completely correct, because it doesn't check |
| 1978 | # that the two characters preceding "From " are \n\n or the beginning of |
| 1979 | # the file. Fixing this would require a more extensive rewrite than is |
Barry Warsaw | da5628f | 2002-08-26 16:44:56 +0000 | [diff] [blame] | 1980 | # necessary. For convenience, we've added a PortableUnixMailbox class |
| 1981 | # which uses the more lenient _fromlinepattern regular expression. |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 1982 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 1983 | _fromlinepattern = r"From \s*[^\s]+\s+\w\w\w\s+\w\w\w\s+\d?\d\s+" \ |
| 1984 | r"\d?\d:\d\d(:\d\d)?(\s+[^\s]+)?\s+\d\d\d\d\s*$" |
| 1985 | _regexp = None |
Guido van Rossum | fbe63de | 1998-04-03 16:04:05 +0000 | [diff] [blame] | 1986 | |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 1987 | def _strict_isrealfromline(self, line): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 1988 | if not self._regexp: |
| 1989 | import re |
| 1990 | self._regexp = re.compile(self._fromlinepattern) |
| 1991 | return self._regexp.match(line) |
Guido van Rossum | fbe63de | 1998-04-03 16:04:05 +0000 | [diff] [blame] | 1992 | |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 1993 | def _portable_isrealfromline(self, line): |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 1994 | return True |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 1995 | |
| 1996 | _isrealfromline = _strict_isrealfromline |
| 1997 | |
| 1998 | |
| 1999 | class PortableUnixMailbox(UnixMailbox): |
| 2000 | _isrealfromline = UnixMailbox._portable_isrealfromline |
| 2001 | |
Guido van Rossum | fbe63de | 1998-04-03 16:04:05 +0000 | [diff] [blame] | 2002 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 2003 | class MmdfMailbox(_Mailbox): |
Guido van Rossum | 4bf1254 | 2002-09-12 05:08:00 +0000 | [diff] [blame] | 2004 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2005 | def _search_start(self): |
| 2006 | while 1: |
| 2007 | line = self.fp.readline() |
| 2008 | if not line: |
| 2009 | raise EOFError |
| 2010 | if line[:5] == '\001\001\001\001\n': |
| 2011 | return |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 2012 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2013 | def _search_end(self): |
| 2014 | while 1: |
| 2015 | pos = self.fp.tell() |
| 2016 | line = self.fp.readline() |
| 2017 | if not line: |
| 2018 | return |
| 2019 | if line == '\001\001\001\001\n': |
| 2020 | self.fp.seek(pos) |
| 2021 | return |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 2022 | |
Guido van Rossum | c7b6882 | 1994-04-28 09:53:33 +0000 | [diff] [blame] | 2023 | |
Jack Jansen | 9715779 | 1995-10-23 13:59:53 +0000 | [diff] [blame] | 2024 | class MHMailbox: |
Guido van Rossum | 4bf1254 | 2002-09-12 05:08:00 +0000 | [diff] [blame] | 2025 | |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 2026 | def __init__(self, dirname, factory=rfc822.Message): |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2027 | import re |
Guido van Rossum | 0707fea | 2000-08-10 03:05:26 +0000 | [diff] [blame] | 2028 | pat = re.compile('^[1-9][0-9]*$') |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2029 | self.dirname = dirname |
Sjoerd Mullender | d2653a9 | 2000-08-11 07:48:36 +0000 | [diff] [blame] | 2030 | # the three following lines could be combined into: |
| 2031 | # list = map(long, filter(pat.match, os.listdir(self.dirname))) |
| 2032 | list = os.listdir(self.dirname) |
| 2033 | list = filter(pat.match, list) |
Guido van Rossum | 0707fea | 2000-08-10 03:05:26 +0000 | [diff] [blame] | 2034 | list = map(long, list) |
| 2035 | list.sort() |
| 2036 | # This only works in Python 1.6 or later; |
| 2037 | # before that str() added 'L': |
| 2038 | self.boxes = map(str, list) |
Raymond Hettinger | b5ba8d7 | 2004-02-07 02:16:24 +0000 | [diff] [blame] | 2039 | self.boxes.reverse() |
Barry Warsaw | 81ad67c | 2001-01-31 22:13:15 +0000 | [diff] [blame] | 2040 | self.factory = factory |
Jack Jansen | 9715779 | 1995-10-23 13:59:53 +0000 | [diff] [blame] | 2041 | |
Fred Drake | 72987a4 | 2001-05-02 20:20:53 +0000 | [diff] [blame] | 2042 | def __iter__(self): |
Guido van Rossum | 93a696f | 2001-09-13 01:29:13 +0000 | [diff] [blame] | 2043 | return iter(self.next, None) |
Fred Drake | 72987a4 | 2001-05-02 20:20:53 +0000 | [diff] [blame] | 2044 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2045 | def next(self): |
| 2046 | if not self.boxes: |
| 2047 | return None |
Raymond Hettinger | b5ba8d7 | 2004-02-07 02:16:24 +0000 | [diff] [blame] | 2048 | fn = self.boxes.pop() |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2049 | fp = open(os.path.join(self.dirname, fn)) |
Guido van Rossum | 4bf1254 | 2002-09-12 05:08:00 +0000 | [diff] [blame] | 2050 | msg = self.factory(fp) |
| 2051 | try: |
| 2052 | msg._mh_msgno = fn |
| 2053 | except (AttributeError, TypeError): |
| 2054 | pass |
| 2055 | return msg |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 2056 | |
Guido van Rossum | 9a4d637 | 1998-12-23 22:05:42 +0000 | [diff] [blame] | 2057 | |
Guido van Rossum | fdf58fe | 1997-05-15 14:33:09 +0000 | [diff] [blame] | 2058 | class BabylMailbox(_Mailbox): |
Guido van Rossum | 4bf1254 | 2002-09-12 05:08:00 +0000 | [diff] [blame] | 2059 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2060 | def _search_start(self): |
| 2061 | while 1: |
| 2062 | line = self.fp.readline() |
| 2063 | if not line: |
| 2064 | raise EOFError |
| 2065 | if line == '*** EOOH ***\n': |
| 2066 | return |
Guido van Rossum | fdf58fe | 1997-05-15 14:33:09 +0000 | [diff] [blame] | 2067 | |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2068 | def _search_end(self): |
| 2069 | while 1: |
| 2070 | pos = self.fp.tell() |
| 2071 | line = self.fp.readline() |
| 2072 | if not line: |
| 2073 | return |
Johannes Gijsbers | 6abc685 | 2004-08-21 12:30:26 +0000 | [diff] [blame] | 2074 | if line == '\037\014\n' or line == '\037': |
Fred Drake | dbbf76b | 2000-07-09 16:44:26 +0000 | [diff] [blame] | 2075 | self.fp.seek(pos) |
| 2076 | return |
Guido van Rossum | fdf58fe | 1997-05-15 14:33:09 +0000 | [diff] [blame] | 2077 | |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 2078 | ## End: classes from the original module (for backward compatibility). |
Guido van Rossum | 6244867 | 1996-09-17 21:33:15 +0000 | [diff] [blame] | 2079 | |
| 2080 | |
Andrew M. Kuchling | 1da4a94 | 2006-04-22 02:32:43 +0000 | [diff] [blame] | 2081 | class Error(Exception): |
| 2082 | """Raised for module-specific errors.""" |
| 2083 | |
| 2084 | class NoSuchMailboxError(Error): |
| 2085 | """The specified mailbox does not exist and won't be created.""" |
| 2086 | |
| 2087 | class NotEmptyError(Error): |
| 2088 | """The specified mailbox is not empty and deletion was requested.""" |
| 2089 | |
| 2090 | class ExternalClashError(Error): |
| 2091 | """Another process caused an action to fail.""" |
| 2092 | |
| 2093 | class FormatError(Error): |
| 2094 | """A file appears to have an invalid format.""" |