cpython-lru_cache-weakref: Lib/mailbox.py annotate

annotate Lib/mailbox.py @ 58925:eecf1bef052d 2.6

Merged revisions 78207 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r78207 | ezio.melotti | 2010-02-17 01:26:09 +0200 (Wed, 17 Feb 2010) | 1 line #7930: fix stripid ........

author	Ezio Melotti <ezio.melotti@gmail.com>
date	Tue, 16 Feb 2010 23:29:44 +0000
parents	a33bc8183e4c
children	751c6dd71b5e e0cede7f521b

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

Mercurial > cpython-lru_cache-weakref

annotate Lib/mailbox.py @ 58925:eecf1bef052d 2.6