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

annotate Lib/mailbox.py @ 80661:94de77bd0b4b 2.7

Issue #16194: document imp.load_dynamic problems when read several extension modules from the same binary object file.

author	Andrew Svetlov <andrew.svetlov@gmail.com>
date	Thu, 29 Nov 2012 19:51:28 +0200
parents	d903d4981e33
children	041caa64486b

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 StringIO
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	22 try:
39151 b58f7952e38a Get mailbox module working on OS/2 EMX port. Andrew MacIntyre <andymac@bullseye.apana.org.au> parents: 38948 diff changeset	23 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	24 # 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	25 raise ImportError
38930 8168d05f9b49 [Bug #1512163] Fix typo. Andrew M. Kuchling <amk@amk.ca> parents: 38153 diff changeset	26 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	27 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	28 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	29
63528 751c6dd71b5e Merged revisions 77310-77311 via svnmerge from Ezio Melotti <ezio.melotti@gmail.com> parents: 52732 diff changeset	30 import warnings
751c6dd71b5e Merged revisions 77310-77311 via svnmerge from Ezio Melotti <ezio.melotti@gmail.com> parents: 52732 diff changeset	31 with warnings.catch_warnings():
751c6dd71b5e Merged revisions 77310-77311 via svnmerge from Ezio Melotti <ezio.melotti@gmail.com> parents: 52732 diff changeset	32 if sys.py3kwarning:
751c6dd71b5e Merged revisions 77310-77311 via svnmerge from Ezio Melotti <ezio.melotti@gmail.com> parents: 52732 diff changeset	33 warnings.filterwarnings("ignore", ".*rfc822 has been removed",
751c6dd71b5e Merged revisions 77310-77311 via svnmerge from Ezio Melotti <ezio.melotti@gmail.com> parents: 52732 diff changeset	34 DeprecationWarning)
751c6dd71b5e Merged revisions 77310-77311 via svnmerge from Ezio Melotti <ezio.melotti@gmail.com> parents: 52732 diff changeset	35 import rfc822
751c6dd71b5e Merged revisions 77310-77311 via svnmerge from Ezio Melotti <ezio.melotti@gmail.com> parents: 52732 diff changeset	36
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	37 __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	38 '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	39 '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	40 '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	41
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	42 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	43 """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	44
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	45 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	46 """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	47 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	48 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	49
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	50 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	51 """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	52 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	53
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	54 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	55 """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	56 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	57
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	58 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	59 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	60
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	61 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	62 """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	63 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	64 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	65 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	66 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	67
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	68 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	69 """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	70 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	71
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	72 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	73 """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	74 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	75 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	76 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	77 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	78
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	79 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	80 """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	81 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	82 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	83 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	84 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	85
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	86 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	87 """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	88 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	89
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	90 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	91 """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	92 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	93
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	94 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	95 """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	96 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	97
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	98 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	99 """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	100 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	101
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	102 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	103 """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	104 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	105
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	106 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	107 """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	108 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	109 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	110 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	111 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	112 continue
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	113 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	114
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	115 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	116 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	117
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	118 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	119 """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	120 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	121
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	122 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	123 """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	124 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	125 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	126 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	127 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	128 continue
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	129 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	130
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	131 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	132 """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	133 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	134
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	135 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	136 """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	137 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	138
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	139 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	140 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	141
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	142 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	143 """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	144 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	145
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	146 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	147 """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	148 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	149 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	150
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	151 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	152 """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	153 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	154 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	155 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	156 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	157 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	158 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	159
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	160 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	161 """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	162 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	163 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	164 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	165 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	166
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	167 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	168 """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	169 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	170 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	171 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	172 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	173 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	174 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	175 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	176 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	177 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	178 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	179 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	180 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	181 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	182 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	183
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	184 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	185 """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	186 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	187
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	188 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	189 """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	190 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	191
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	192 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	193 """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	194 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	195
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	196 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	197 """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	198 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	199
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	200 # Whether each message must end in a newline
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	201 _append_newline = False
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	202
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	203 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	204 # 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	205 # 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	206 # 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	207 """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	208 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	209 buffer = StringIO.StringIO()
40689 b23711be2b3e Use new email module names (#1637162, #1637159, #1637157). Georg Brandl <georg@python.org> parents: 40492 diff changeset	210 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	211 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	212 buffer.seek(0)
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	213 data = buffer.read().replace('\n', os.linesep)
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	214 target.write(data)
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	215 if self._append_newline and not data.endswith(os.linesep):
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	216 # Make sure the message ends with a newline
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	217 target.write(os.linesep)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	218 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	219 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	220 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	221 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	222 target.write(message)
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	223 if self._append_newline and not message.endswith(os.linesep):
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	224 # Make sure the message ends with a newline
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	225 target.write(os.linesep)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	226 elif hasattr(message, 'read'):
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	227 lastline = None
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	228 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	229 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	230 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	231 break
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 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	233 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	234 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	235 target.write(line)
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	236 lastline = line
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	237 if self._append_newline and lastline and not lastline.endswith(os.linesep):
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	238 # Make sure the message ends with a newline
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	239 target.write(os.linesep)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	240 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	241 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	242
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	243
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	244 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	245 """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	246
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	247 colon = ':'
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	248
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	249 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	250 """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	251 Mailbox.__init__(self, dirname, factory, create)
69881 a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	252 self._paths = {
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	253 'tmp': os.path.join(self._path, 'tmp'),
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	254 'new': os.path.join(self._path, 'new'),
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	255 'cur': os.path.join(self._path, 'cur'),
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	256 }
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	257 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	258 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	259 os.mkdir(self._path, 0700)
69881 a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	260 for path in self._paths.values():
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	261 os.mkdir(path, 0o700)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	262 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	263 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	264 self._toc = {}
73371 0b754ee12dbd Fix Maildir initialization so that maildir contents are read correctly. Petri Lehtinen <petri@digip.org> parents: 70856 diff changeset	265 self._toc_mtimes = {'cur': 0, 'new': 0}
0b754ee12dbd Fix Maildir initialization so that maildir contents are read correctly. Petri Lehtinen <petri@digip.org> parents: 70856 diff changeset	266 self._last_read = 0 # Records last time we read cur/new
0b754ee12dbd Fix Maildir initialization so that maildir contents are read correctly. Petri Lehtinen <petri@digip.org> parents: 70856 diff changeset	267 self._skewfactor = 0.1 # Adjust if os/fs clocks are skewing
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	268
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	269 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	270 """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	271 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	272 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	273 self._dump_message(message, tmp_file)
67930 bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	274 except BaseException:
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	275 tmp_file.close()
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	276 os.remove(tmp_file.name)
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	277 raise
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	278 _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	279 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	280 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	281 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	282 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	283 suffix = ''
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	284 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	285 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	286 suffix = ''
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	287 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	288 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	289 try:
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	290 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	291 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	292 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	293 else:
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	294 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	295 except OSError, e:
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	296 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	297 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	298 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	299 % dest)
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	300 else:
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	301 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	302 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	303 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	304 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	305
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	306 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	307 """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	308 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	309
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	310 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	311 """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	312 # 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	313 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	314 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	315 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	316 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	317 except OSError, e:
38114 79c8a2a988cb Update checks to consider Windows error numbers. Martin v. Löwis <martin@v.loewis.de> parents: 38087 diff changeset	318 if e.errno != errno.ENOENT:
37917 fb1837e88e72 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 37916 diff changeset	319 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	320
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	321 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	322 """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	323 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	324 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	325 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	326 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	327 # 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	328 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	329 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	330 # 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	331 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	332 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	333 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	334 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	335 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	336 suffix = ''
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	337 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	338 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	339 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	340 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	341 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	342 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	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 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	345 """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	346 subpath = self._lookup(key)
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	347 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	348 try:
44784 b3102006dd7e Bug 1277: make Maildir use the user-provided factory instead of hard-wiring MaildirMessage. Andrew M. Kuchling <amk@amk.ca> parents: 42281 diff changeset	349 if self._factory:
b3102006dd7e Bug 1277: make Maildir use the user-provided factory instead of hard-wiring MaildirMessage. Andrew M. Kuchling <amk@amk.ca> parents: 42281 diff changeset	350 msg = self._factory(f)
b3102006dd7e Bug 1277: make Maildir use the user-provided factory instead of hard-wiring MaildirMessage. Andrew M. Kuchling <amk@amk.ca> parents: 42281 diff changeset	351 else:
b3102006dd7e Bug 1277: make Maildir use the user-provided factory instead of hard-wiring MaildirMessage. Andrew M. Kuchling <amk@amk.ca> parents: 42281 diff changeset	352 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	353 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	354 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	355 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	356 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	357 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	358 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	359 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	360 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	361
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	362 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	363 """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	364 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	365 try:
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 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	367 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	368 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	369
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	370 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	371 """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	372 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	373 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	374
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	375 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	376 """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	377 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	378 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	379 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	380 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	381 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	382 continue
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	383 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	384
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	385 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	386 """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	387 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	388 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	389
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	390 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	391 """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	392 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	393 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	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 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	396 """Write any pending changes to disk."""
57049 51b9973f761e This should finally fix #6896. Let's watch the buildbots. Antoine Pitrou <solipsis@pitrou.net> parents: 57021 diff changeset	397 # Maildir changes are always written immediately, so there's nothing
69881 a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	398 # to do.
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	399 pass
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	400
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	401 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	402 """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	403 return
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 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	406 """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	407 return
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	408
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	409 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	410 """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	411 return
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	412
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	413 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	414 """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	415 result = []
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	416 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	417 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	418 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	419 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	420 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	421
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	422 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	423 """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	424 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	425 factory=self._factory,
6d99762cd818 [Bug #1569790] mailbox.Maildir.get_folder() loses factory information Andrew M. Kuchling <amk@amk.ca> parents: 40202 diff changeset	426 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	427
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	428 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	429 """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	430 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	431 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	432 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	433 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	434 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	435 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	436 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	437
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	438 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	439 """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	440 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	441 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	442 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	443 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	444 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	445 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	446 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	447 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	448 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	449 (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	450 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	451 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	452 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	453 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	454 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	455 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	456
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	457 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	458 """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	459 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	460 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	461 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	462 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	463 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	464
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	465 _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	466
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	467 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	468 """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	469 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	470 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	471 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	472 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	473 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	474 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	475 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	476 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	477 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	478 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	479 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	480 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	481 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	482 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	483 try:
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	484 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	485 except OSError, e:
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	486 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	487 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	488 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	489 raise
40321 561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	490
561ffa757dfb [Patch #1514543] mailbox (Maildir): avoid losing messages on name clash Andrew M. Kuchling <amk@amk.ca> parents: 40318 diff changeset	491 # 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	492 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	493 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	494
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	495 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	496 """Update table of contents mapping."""
69881 a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	497 # If it has been less than two seconds since the last _refresh() call,
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	498 # we have to unconditionally re-read the mailbox just in case it has
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	499 # been modified, because os.path.mtime() has a 2 sec resolution in the
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	500 # most common worst case (FAT) and a 1 sec resolution typically. This
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	501 # results in a few unnecessary re-reads when _refresh() is called
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	502 # multiple times in that interval, but once the clock ticks over, we
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	503 # will only re-read as needed. Because the filesystem might be being
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	504 # served by an independent system with its own clock, we record and
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	505 # compare with the mtimes from the filesystem. Because the other
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	506 # system's clock might be skewing relative to our clock, we add an
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	507 # extra delta to our wait. The default is one tenth second, but is an
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	508 # instance variable and so can be adjusted if dealing with a
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	509 # particularly skewed or irregular system.
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	510 if time.time() - self._last_read > 2 + self._skewfactor:
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	511 refresh = False
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	512 for subdir in self._toc_mtimes:
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	513 mtime = os.path.getmtime(self._paths[subdir])
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	514 if mtime > self._toc_mtimes[subdir]:
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	515 refresh = True
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	516 self._toc_mtimes[subdir] = mtime
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	517 if not refresh:
57021 f83b48962739 Hopefully fix the buildbot problems on test_mailbox, by computing Antoine Pitrou <solipsis@pitrou.net> parents: 53686 diff changeset	518 return
69881 a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	519 # Refresh toc
37916 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 = {}
69881 a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	521 for subdir in self._toc_mtimes:
a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	522 path = self._paths[subdir]
53686 e0cede7f521b #1607951: Make mailbox.Maildir re-read the directories less frequently. Andrew M. Kuchling <amk@amk.ca> parents: 52732 diff changeset	523 for entry in os.listdir(path):
e0cede7f521b #1607951: Make mailbox.Maildir re-read the directories less frequently. Andrew M. Kuchling <amk@amk.ca> parents: 52732 diff changeset	524 p = os.path.join(path, entry)
42281 daae27fbb816 [Backport of r56382] Andrew M. Kuchling <amk@amk.ca> parents: 40693 diff changeset	525 if os.path.isdir(p):
daae27fbb816 [Backport of r56382] Andrew M. Kuchling <amk@amk.ca> parents: 40693 diff changeset	526 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	527 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	528 self._toc[uniq] = os.path.join(subdir, entry)
69881 a0147a1f1776 #11999: sync based on comparing mtimes, not mtime to system clock R David Murray <rdmurray@bitdance.com> parents: 68256 diff changeset	529 self._last_read = time.time()
53686 e0cede7f521b #1607951: Make mailbox.Maildir re-read the directories less frequently. Andrew M. Kuchling <amk@amk.ca> parents: 52732 diff changeset	530
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	531 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	532 """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	533 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	534 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	535 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	536 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	537 pass
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._refresh()
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	539 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	540 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	541 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	542 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	543
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	544 # 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	545 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	546 """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	547 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	548 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	549 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	550 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	551 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	552 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	553 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	554 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	555 continue
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
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	558 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	559 """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	560
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	561 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	562 """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	563 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	564 try:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	565 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	566 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	567 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	568 if create:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	569 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	570 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	571 raise NoSuchMailboxError(self._path)
68066 a8389468e651 Merged revisions 88730 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67932 diff changeset	572 elif e.errno in (errno.EACCES, errno.EROFS):
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	573 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	574 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	575 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	576 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	577 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	578 self._next_key = 0
77832 c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	579 self._pending = False # No changes require rewriting the file.
c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	580 self._pending_sync = False # No need to sync the 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	581 self._locked = False
77832 c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	582 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	583
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	584 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	585 """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	586 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	587 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	588 self._next_key += 1
77832 c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	589 # _append_message appends the message to the mailbox file. We
c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	590 # don't need a full rewrite + rename, sync is enough.
c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	591 self._pending_sync = True
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	592 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	593
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	594 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	595 """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	596 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	597 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	598 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	599
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	600 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	601 """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	602 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	603 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	604 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	605
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	606 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	607 """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	608 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	609 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	610 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	611
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	612 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	613 """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	614 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	615 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	616
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	617 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	618 """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	619 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	620 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	621
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	622 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	623 """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	624 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	625 _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	626 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	627
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	628 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	629 """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	630 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	631 _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	632 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	633
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	634 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	635 """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	636 if not self._pending:
77832 c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	637 if self._pending_sync:
c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	638 # Messages have only been added, so syncing the file
c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	639 # is enough.
c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	640 _sync_flush(self._file)
c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	641 self._pending_sync = 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	642 return
40492 8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	643
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	644 # 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	645 # 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	646 # by adding or deleting an item).
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	647 assert self._toc is not None
40732 5dae0d7f683a Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 40691 diff changeset	648
40492 8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	649 # 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	650 # 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	651 self._file.seek(0, 2)
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	652 cur_len = self._file.tell()
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	653 if cur_len != self._file_length:
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	654 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	655 '(expected %i, found %i)' %
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	656 (self._file_length, cur_len))
40732 5dae0d7f683a Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 40691 diff changeset	657
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	658 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	659 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	660 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	661 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	662 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	663 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	664 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	665 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	666 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	667 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	668 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	669 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	670 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	671 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	672 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	673 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	674 self._post_message_hook(new_file)
77443 0add70dd3c43 #15036: Make a repeated changes and flushes work with single-file mailboxes Petri Lehtinen <petri@digip.org> parents: 73371 diff changeset	675 self._file_length = new_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	676 except:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	677 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	678 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	679 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	680 _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	681 # 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	682 self._file.close()
77850 69f654f718f4 #5346: Preserve permissions of mbox, MMDF and Babyl mailbox files on flush() Petri Lehtinen <petri@digip.org> parents: 77847 diff changeset	683 # Make sure the new file's mode is the same as the old file's
69f654f718f4 #5346: Preserve permissions of mbox, MMDF and Babyl mailbox files on flush() Petri Lehtinen <petri@digip.org> parents: 77847 diff changeset	684 mode = os.stat(self._path).st_mode
69f654f718f4 #5346: Preserve permissions of mbox, MMDF and Babyl mailbox files on flush() Petri Lehtinen <petri@digip.org> parents: 77847 diff changeset	685 os.chmod(new_file.name, mode)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	686 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	687 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	688 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	689 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	690 (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	691 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	692 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	693 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	694 raise
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	695 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	696 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	697 self._pending = False
77832 c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	698 self._pending_sync = 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	699 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	700 _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	701
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	702 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	703 """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	704 return
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	705
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	706 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	707 """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	708 return
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	709
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	710 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	711 """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	712 return
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	713
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	714 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	715 """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	716 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	717 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	718 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	719 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	720
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	721 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	722 """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	723 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	724 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	725 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	726 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	727 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	728 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	729 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	730
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	731 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	732 """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	733 self._file.seek(0, 2)
67930 bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	734 before = self._file.tell()
77847 3d7a75e945ee #9559: Don't call _pre_mailbox_hook more than once Petri Lehtinen <petri@digip.org> parents: 77832 diff changeset	735 if len(self._toc) == 0 and not self._pending:
3d7a75e945ee #9559: Don't call _pre_mailbox_hook more than once Petri Lehtinen <petri@digip.org> parents: 77832 diff changeset	736 # This is the first message, and the _pre_mailbox_hook
3d7a75e945ee #9559: Don't call _pre_mailbox_hook more than once Petri Lehtinen <petri@digip.org> parents: 77832 diff changeset	737 # hasn't yet been called. If self._pending is True,
3d7a75e945ee #9559: Don't call _pre_mailbox_hook more than once Petri Lehtinen <petri@digip.org> parents: 77832 diff changeset	738 # messages have been removed, so _pre_mailbox_hook must
3d7a75e945ee #9559: Don't call _pre_mailbox_hook more than once Petri Lehtinen <petri@digip.org> parents: 77832 diff changeset	739 # have been called already.
77832 c37cb11b546f #9559: Append data to single-file mailbox files if messages are only added Petri Lehtinen <petri@digip.org> parents: 77443 diff changeset	740 self._pre_mailbox_hook(self._file)
67930 bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	741 try:
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	742 self._pre_message_hook(self._file)
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	743 offsets = self._install_message(message)
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	744 self._post_message_hook(self._file)
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	745 except BaseException:
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	746 self._file.truncate(before)
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	747 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	748 self._file.flush()
40492 8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	749 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	750 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	751
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	752
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	753
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	754 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	755 """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	756
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	757 _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	758
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	759 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	760 """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	761 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	762 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	763 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	764 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	765 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	766 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	767 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	768
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	769 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	770 """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	771 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	772 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	773 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	774 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	775 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	776 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	777
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	778 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	779 """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	780 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	781 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	782 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	783 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	784 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	785
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	786 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	787 """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	788 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	789 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	790 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	791 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	792 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	793 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	794 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	795 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	796 message = ''
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 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	798 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	799 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	800 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	801 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	802 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	803 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	804 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	805 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	806 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	807 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	808
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	809
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	810 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	811 """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	812
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	813 _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	814
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	815 # All messages must end in a newline character, and
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	816 # _post_message_hooks outputs an empty line between messages.
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	817 _append_newline = True
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	818
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	819 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	820 """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	821 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	822 _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	823
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	824 def _post_message_hook(self, f):
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	825 """Called after writing each message to file f."""
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	826 f.write(os.linesep)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	827
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	828 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	829 """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	830 starts, stops = [], []
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	831 last_was_empty = 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	832 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	833 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	834 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	835 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	836 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	837 if len(stops) < len(starts):
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	838 if last_was_empty:
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	839 stops.append(line_pos - len(os.linesep))
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	840 else:
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	841 # The last line before the "From " line wasn't
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	842 # blank, but we consider it a start of a
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	843 # message anyway.
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	844 stops.append(line_pos)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	845 starts.append(line_pos)
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	846 last_was_empty = False
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	847 elif not line:
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	848 if last_was_empty:
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	849 stops.append(line_pos - len(os.linesep))
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	850 else:
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	851 stops.append(line_pos)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	852 break
79182 d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	853 elif line == os.linesep:
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	854 last_was_empty = True
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	855 else:
d903d4981e33 #15222: Insert blank line after each message in mbox mailboxes Petri Lehtinen <petri@digip.org> parents: 78584 diff changeset	856 last_was_empty = 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	857 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	858 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	859 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	860
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	861
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	862 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	863 """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	864
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	865 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	866 """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	867 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	868 _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	869
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	870 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	871 """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	872 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	873
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	874 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	875 """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	876 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	877
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	878 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	879 """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	880 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	881 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	882 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	883 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	884 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	885 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	886 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	887 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	888 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	889 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	890 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	891 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	892 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	893 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	894 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	895 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	896 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	897 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	898 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	899 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	900 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	901 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	902 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	903 self._file.seek(0, 2)
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	904 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	905
772828c1b1f6 Revamped test case and updated doc string. Guido van Rossum <guido@python.org> parents: 3360 diff changeset	906
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	907 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	908 """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	909
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	910 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	911 """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	912 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	913 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	914 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	915 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	916 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	917 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	918 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	919 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	920 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	921
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	922 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	923 """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	924 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	925 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	926 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	927 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	928 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	929 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	930 f = _create_carefully(new_path)
67932 883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	931 closed = 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	932 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	933 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	934 _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	935 try:
67930 bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	936 try:
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	937 self._dump_message(message, f)
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	938 except BaseException:
67932 883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	939 # Unlock and close so it can be deleted on Windows
883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	940 if self._locked:
883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	941 _unlock_file(f)
883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	942 _sync_close(f)
883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	943 closed = True
67930 bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	944 os.remove(new_path)
bbaf9304a0d0 Merged revisions 88403 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 59026 diff changeset	945 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	946 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	947 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	948 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	949 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	950 _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	951 finally:
67932 883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	952 if not closed:
883a023eb943 Merged revisions 88407 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67930 diff changeset	953 _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	954 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	955
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	956 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	957 """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	958 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	959 try:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	960 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	961 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	962 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	963 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	964 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	965 raise
59026 fd9488854088 #7627: MH.remove() would fail if the MH mailbox was locked; Andrew M. Kuchling <amk@amk.ca> parents: 58159 diff changeset	966 else:
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	967 f.close()
59026 fd9488854088 #7627: MH.remove() would fail if the MH mailbox was locked; Andrew M. Kuchling <amk@amk.ca> parents: 58159 diff changeset	968 os.remove(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	969
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	970 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	971 """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	972 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	973 try:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	974 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	975 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	976 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	977 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	978 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	979 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	980 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	981 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	982 _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	983 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	984 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	985 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	986 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	987 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	988 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	989 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	990 _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	991 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	992 _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	993
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	994 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	995 """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	996 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	997 if self._locked:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	998 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	999 else:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	1000 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	1001 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	1002 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	1003 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	1004 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1005 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1006 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1007 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	1008 _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	1009 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1010 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	1011 finally:
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 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	1013 _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	1014 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1015 f.close()
52732 a33bc8183e4c Merged revisions 71046 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 48162 diff changeset	1016 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	1017 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	1018 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	1019 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	1020
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1021 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	1022 """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	1023 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1024 if self._locked:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	1025 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	1026 else:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	1027 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	1028 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	1029 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	1030 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	1031 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1032 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1033 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1034 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	1035 _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	1036 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1037 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	1038 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1039 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	1040 _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	1041 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1042 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	1043
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1044 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	1045 """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	1046 try:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	1047 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	1048 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	1049 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	1050 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	1051 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1052 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1053 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	1054
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1055 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	1056 """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	1057 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	1058 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	1059
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1060 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	1061 """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	1062 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	1063
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1064 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	1065 """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	1066 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	1067
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1068 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	1069 """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	1070 if not self._locked:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	1071 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	1072 _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	1073 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	1074
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1075 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	1076 """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	1077 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	1078 _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	1079 _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	1080 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	1081 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	1082
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1083 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	1084 """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	1085 return
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1086
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1087 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	1088 """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	1089 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	1090 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	1091
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1092 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	1093 """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	1094 result = []
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 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	1096 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	1097 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	1098 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	1099
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1100 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	1101 """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	1102 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	1103 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	1104
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1105 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	1106 """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	1107 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	1108 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	1109
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1110 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	1111 """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	1112 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	1113 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	1114 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	1115 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	1116 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	1117 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1118 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1119 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	1120 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	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 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	1123 """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	1124 results = {}
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	1125 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	1126 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1127 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	1128 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	1129 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1130 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	1131 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	1132 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	1133 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	1134 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	1135 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1136 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	1137 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	1138 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	1139 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	1140 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	1141 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	1142 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	1143 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	1144 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	1145 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1146 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	1147 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	1148
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1149 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	1150 """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	1151 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	1152 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1153 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	1154 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	1155 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	1156 continue
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1157 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	1158 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	1159 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	1160 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	1161 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	1162 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	1163 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	1164 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	1165 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	1166 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	1167 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	1168 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1169 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	1170 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	1171 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	1172 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	1173 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1174 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	1175 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	1176 _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	1177
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1178 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	1179 """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	1180 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	1181 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	1182 changes = []
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1183 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	1184 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	1185 changes.append((key, prev + 1))
40348 7cee9434981a Remove file-locking in MH.pack() method. Andrew M. Kuchling <amk@amk.ca> parents: 40321 diff changeset	1186 if hasattr(os, 'link'):
7cee9434981a Remove file-locking in MH.pack() method. Andrew M. Kuchling <amk@amk.ca> parents: 40321 diff changeset	1187 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	1188 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	1189 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	1190 else:
7cee9434981a Remove file-locking in MH.pack() method. Andrew M. Kuchling <amk@amk.ca> parents: 40321 diff changeset	1191 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	1192 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	1193 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	1194 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	1195 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	1196 return
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1197 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	1198 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	1199 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	1200 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	1201 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	1202
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1203 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	1204 """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	1205 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	1206 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	1207 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	1208 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	1209 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	1210 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	1211 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	1212 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	1213 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	1214 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	1215 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	1216
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1217
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1218 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	1219 """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	1220
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1221 _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	1222 '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	1223
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1224 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	1225 """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	1226 _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	1227 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	1228
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1229 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	1230 """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	1231 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	1232 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	1233 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	1234 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	1235
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1236 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	1237 """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	1238 _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	1239 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	1240 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	1241
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1242 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	1243 """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	1244 _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	1245 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	1246 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	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 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	1249 """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	1250 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	1251 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	1252 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	1253 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	1254 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	1255 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	1256 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	1257 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1258 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	1259 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	1260 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	1261 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	1262 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	1263 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1264 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	1265 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	1266 '\n')
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1267 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	1268 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	1269 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	1270 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	1271 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	1272
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1273 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	1274 """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	1275 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	1276 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	1277 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	1278 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	1279 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	1280 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	1281 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	1282 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1283 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	1284 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	1285 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	1286 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	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 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	1289 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	1290 '\n')
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1291
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1292 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	1293 """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	1294 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	1295 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	1296
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1297 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	1298 """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	1299 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	1300 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	1301 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	1302 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	1303 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	1304 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	1305
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1306 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	1307 """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	1308 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	1309 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	1310 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	1311 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	1312 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	1313 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	1314 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	1315 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	1316 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	1317 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	1318 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	1319 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	1320 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	1321 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	1322 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	1323 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	1324 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	1325 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	1326 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	1327 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	1328 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	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._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	1331 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	1332 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	1333 self._file.seek(0, 2)
8fb33500e067 [Apply length-checking.diff from bug #1599254] Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	1334 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	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 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	1337 """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	1338 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	1339 (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	1340 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	1341
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1342 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	1343 """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	1344 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	1345
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1346 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	1347 """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	1348 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	1349
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1350 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	1351 """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	1352 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	1353 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	1354 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	1355 labels = []
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1356 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	1357 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	1358 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	1359 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1360 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	1361 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	1362 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	1363 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	1364 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	1365 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	1366 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	1367 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	1368 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1369 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	1370 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	1371 orig_buffer = StringIO.StringIO()
40689 b23711be2b3e Use new email module names (#1637162, #1637159, #1637157). Georg Brandl <georg@python.org> parents: 40492 diff changeset	1372 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	1373 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	1374 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	1375 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	1376 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	1377 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	1378 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	1379 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1380 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	1381 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	1382 vis_buffer = StringIO.StringIO()
40689 b23711be2b3e Use new email module names (#1637162, #1637159, #1637157). Georg Brandl <georg@python.org> parents: 40492 diff changeset	1383 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	1384 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	1385 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	1386 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	1387 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	1388 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	1389 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1390 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1391 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	1392 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	1393 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	1394 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	1395 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	1396 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1397 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	1398 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	1399 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	1400 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1401 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	1402 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	1403 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	1404 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	1405 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	1406 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	1407 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	1408 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	1409 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	1410 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	1411 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	1412 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1413 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	1414 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	1415 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	1416 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	1417 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	1418 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	1419 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	1420 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	1421 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	1422 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	1423 first_pass = False
78584 ad8c9725c041 #11062: Fix adding a message from file to Babyl mailbox Petri Lehtinen <petri@digip.org> parents: 77850 diff changeset	1424 self._file.write('* EOOH *' + os.linesep)
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1425 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	1426 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1427 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1428 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	1429 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	1430 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	1431 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1432 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	1433 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1434 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	1435 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	1436 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	1437
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1438
40689 b23711be2b3e Use new email module names (#1637162, #1637159, #1637157). Georg Brandl <georg@python.org> parents: 40492 diff changeset	1439 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	1440 """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	1441
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1442 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	1443 """Initialize a Message instance."""
40689 b23711be2b3e Use new email module names (#1637162, #1637159, #1637157). Georg Brandl <georg@python.org> parents: 40492 diff changeset	1444 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	1445 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	1446 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	1447 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	1448 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	1449 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	1450 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	1451 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	1452 elif message is None:
40689 b23711be2b3e Use new email module names (#1637162, #1637159, #1637157). Georg Brandl <georg@python.org> parents: 40492 diff changeset	1453 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	1454 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1455 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	1456
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1457 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	1458 """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	1459 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	1460 '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	1461 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	1462
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1463 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	1464 """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	1465 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	1466 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	1467 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1468 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	1469
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1470
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1471 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	1472 """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	1473
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1474 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	1475 """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	1476 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	1477 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	1478 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	1479 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	1480
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1481 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	1482 """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	1483 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	1484
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1485 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	1486 """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	1487 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	1488 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	1489 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1490 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	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 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	1493 """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	1494 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	1495 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	1496 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1497 return ''
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1498
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1499 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	1500 """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	1501 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	1502
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1503 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	1504 """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	1505 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	1506
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1507 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	1508 """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	1509 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	1510 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	1511
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1512 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	1513 """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	1514 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	1515
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1516 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	1517 """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	1518 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1519 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	1520 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	1521 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	1522
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1523 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	1524 """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	1525 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	1526
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1527 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	1528 """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	1529 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	1530 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	1531 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1532 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	1533
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1534 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	1535 """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	1536 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	1537 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	1538 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	1539 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	1540 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	1541 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	1542 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	1543 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	1544 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	1545 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	1546 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	1547 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	1548 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	1549 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	1550 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	1551 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	1552 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	1553 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	1554 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	1555 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	1556 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	1557 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	1558 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	1559 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	1560 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	1561 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	1562 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	1563 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	1564 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	1565 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	1566 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	1567 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	1568 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	1569 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	1570 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	1571 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	1572 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1573 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1574 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	1575 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	1576
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1577
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1578 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	1579 """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	1580
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1581 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	1582 """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	1583 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	1584 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	1585 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	1586 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	1587 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	1588 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	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 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	1591 """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	1592 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	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 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	1595 """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	1596 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	1597 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	1598 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	1599 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	1600 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	1601
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1602 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	1603 """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	1604 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	1605
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1606 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	1607 """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	1608 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	1609 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	1610 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	1611 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	1612 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	1613 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	1614 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	1615 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	1616 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	1617 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	1618 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	1619 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1620 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	1621 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	1622 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	1623 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1624 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	1625 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	1626 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	1627
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1628 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	1629 """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	1630 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	1631
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1632 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	1633 """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	1634 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	1635 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	1636
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1637 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	1638 """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	1639 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	1640 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	1641 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	1642 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	1643 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	1644 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	1645 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	1646 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	1647 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	1648 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	1649 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	1650 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	1651 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	1652 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	1653 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	1654 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1655 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	1656 '%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	1657 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	1658 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1659 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	1660 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	1661 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	1662 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	1663 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	1664 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	1665 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	1666 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	1667 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	1668 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	1669 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	1670 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	1671 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	1672 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	1673 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	1674 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	1675 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	1676 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	1677 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	1678 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	1679 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	1680 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	1681 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	1682 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	1683 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1684 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1685 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	1686 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	1687
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1688
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1689 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	1690 """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	1691
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1692
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1693 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	1694 """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	1695
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1696 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	1697 """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	1698 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	1699 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	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 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	1702 """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	1703 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	1704
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1705 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	1706 """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	1707 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	1708
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1709 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	1710 """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	1711 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	1712 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	1713 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	1714 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1715 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	1716
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1717 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	1718 """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	1719 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1720 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	1721 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	1722 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1723
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1724 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	1725 """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	1726 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	1727 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	1728 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	1729 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	1730 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1731 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	1732 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	1733 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	1734 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	1735 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	1736 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	1737 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	1738 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	1739 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	1740 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	1741 else:
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_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	1743 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	1744 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	1745 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	1746 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	1747 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	1748 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	1749 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	1750 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	1751 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	1752 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	1753 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	1754 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	1755 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	1756 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	1757 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1758 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1759 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	1760 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	1761
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1762
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1763 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	1764 """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	1765
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1766 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	1767 """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	1768 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	1769 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	1770 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	1771
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1772 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	1773 """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	1774 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	1775
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1776 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	1777 """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	1778 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	1779
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1780 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	1781 """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	1782 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	1783 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	1784 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	1785 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1786 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	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 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	1789 """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	1790 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1791 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	1792 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	1793 pass
37917 fb1837e88e72 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 37916 diff changeset	1794
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1795 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	1796 """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	1797 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	1798
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1799 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	1800 """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	1801 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	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 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	1804 """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	1805 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	1806 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	1807 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	1808 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1809 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	1810 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	1811 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	1812 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	1813
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1814 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	1815 """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	1816 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	1817 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	1818 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	1819 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	1820 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1821 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	1822 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	1823 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	1824 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	1825 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	1826 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	1827 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	1828 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	1829 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	1830 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	1831 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	1832 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	1833 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1834 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	1835 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	1836 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	1837 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	1838 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	1839 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	1840 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	1841 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	1842 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	1843 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	1844 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	1845 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	1846 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	1847 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	1848 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	1849 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	1850 pass
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1851 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1852 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	1853 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	1854
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1855
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1856 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	1857 """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	1858
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1859
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1860 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	1861 """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	1862
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1863 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	1864 """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	1865 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	1866 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	1867 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	1868 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1869 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	1870
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1871 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	1872 """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	1873 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	1874
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1875 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	1876 """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	1877 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	1878
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1879 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	1880 """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	1881 result = []
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1882 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	1883 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	1884 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	1885 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	1886 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	1887 break
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1888 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	1889
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1890 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	1891 """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	1892 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	1893
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1894 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	1895 """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	1896 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	1897
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1898 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	1899 """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	1900 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	1901 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	1902 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	1903 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	1904
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1905 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	1906 """Close the file."""
70856 b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1907 if hasattr(self, '_file'):
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1908 if hasattr(self._file, 'close'):
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1909 self._file.close()
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1910 del 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	1911
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1912 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	1913 """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	1914 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	1915 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	1916 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	1917 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	1918 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	1919 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	1920
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1921
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1922 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	1923 """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	1924
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1925 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	1926 """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	1927 _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	1928 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	1929 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	1930
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1931 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	1932 """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	1933 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	1934
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1935 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	1936 """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	1937 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	1938 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	1939 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	1940 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	1941 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	1942 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	1943 _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	1944
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1945 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	1946 """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	1947 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	1948 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	1949 return ''
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1950 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	1951 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	1952 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	1953
70856 b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1954 def close(self):
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1955 # do not close the underlying file object for partial files,
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1956 # since it's global to the mailbox object
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1957 if hasattr(self, '_file'):
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1958 del self._file
b89d193cbca5 #11700: proxy object close methods can now be called multiple times R David Murray <rdmurray@bitdance.com> parents: 69881 diff changeset	1959
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1960
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1961 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	1962 """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	1963 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	1964 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1965 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	1966 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1967 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	1968 except IOError, e:
68066 a8389468e651 Merged revisions 88730 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67932 diff changeset	1969 if e.errno in (errno.EAGAIN, errno.EACCES, errno.EROFS):
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1970 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	1971 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	1972 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1973 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1974 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	1975 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1976 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	1977 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	1978 except IOError, e:
68066 a8389468e651 Merged revisions 88730 via svnmerge from R. David Murray <rdmurray@bitdance.com> parents: 67932 diff changeset	1979 if e.errno in (errno.EACCES, errno.EROFS):
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1980 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	1981 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1982 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1983 try:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1984 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	1985 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	1986 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	1987 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	1988 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1989 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	1990 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	1991 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	1992 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	1993 (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	1994 os.remove(pre_lock.name)
37917 fb1837e88e72 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 37916 diff changeset	1995 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	1996 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	1997 else:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1998 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	1999 except:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2000 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	2001 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	2002 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	2003 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	2004 raise
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2005
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2006 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	2007 """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	2008 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	2009 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	2010 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	2011 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	2012
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2013 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	2014 """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	2015 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	2016 try:
38087 b706b100c8fc Use open() instead of file() Andrew M. Kuchling <amk@amk.ca> parents: 37917 diff changeset	2017 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	2018 finally:
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2019 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	2020
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2021 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	2022 """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	2023 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	2024 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	2025 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	2026
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	2027 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	2028 """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	2029 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	2030 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	2031 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	2032
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	2033 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	2034 """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	2035 _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	2036 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	2037
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2038 ## 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	2039
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2040 # 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	2041 # method for backward compatibility.
16198 32755b456369 a few more modules get __all__ Skip Montanaro <skip@pobox.com> parents: 15543 diff changeset	2042
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2043 class _Mailbox:
25227 809c14f1101a Undocumented feature: MHMailbox sets the msg object's _mh_msgno Guido van Rossum <guido@python.org> parents: 25039 diff changeset	2044
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2045 def __init__(self, fp, factory=rfc822.Message):
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2046 self.fp = fp
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2047 self.seekp = 0
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2048 self.factory = factory
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2049
17660 30d7518e17e5 Make the Mailbox objects support iteration -- they already had the Fred Drake <fdrake@acm.org> parents: 17530 diff changeset	2050 def __iter__(self):
19893 3af006503678 SF bug #461073: mailbox __iter__ bug, by Andrew Dalke. Guido van Rossum <guido@python.org> parents: 19228 diff changeset	2051 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	2052
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2053 def next(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2054 while 1:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2055 self.fp.seek(self.seekp)
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2056 try:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2057 self._search_start()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2058 except EOFError:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2059 self.seekp = self.fp.tell()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2060 return None
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2061 start = self.fp.tell()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2062 self._search_end()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2063 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	2064 if start != stop:
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2065 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	2066 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	2067
22136 7e188140b618 backport bwarsaw's checkin of Michael W. Hudson <mwh@python.net> parents: 19893 diff changeset	2068 # Recommended to use PortableUnixMailbox instead!
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2069 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	2070
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2071 def _search_start(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2072 while 1:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2073 pos = self.fp.tell()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2074 line = self.fp.readline()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2075 if not line:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2076 raise EOFError
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2077 if line[:5] == 'From ' and self._isrealfromline(line):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2078 self.fp.seek(pos)
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2079 return
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2080
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2081 def _search_end(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2082 self.fp.readline() # Throw away header line
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2083 while 1:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2084 pos = self.fp.tell()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2085 line = self.fp.readline()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2086 if not line:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2087 return
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2088 if line[:5] == 'From ' and self._isrealfromline(line):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2089 self.fp.seek(pos)
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2090 return
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2091
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2092 # An overridable mechanism to test for From-line-ness. You can either
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2093 # specify a different regular expression or define a whole new
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2094 # _isrealfromline() method. Note that this only gets called for lines
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2095 # starting with the 5 characters "From ".
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2096 #
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2097 # BAW: According to
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2098 #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	2099 # 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	2100 # 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	2101 # beginning of the file, "^From .*\n". While _fromlinepattern below seems
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2102 # 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	2103 # strict parsing of the line to be completely accurate.
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2104 #
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2105 # _strict_isrealfromline() is the old version which tries to do stricter
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2106 # parsing of the From_ line. _portable_isrealfromline() simply returns
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2107 # 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	2108 # "From ".
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2109 #
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2110 # This algorithm, and the way it interacts with _search_start() and
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2111 # _search_end() may not be completely correct, because it doesn't check
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2112 # 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	2113 # 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	2114 # necessary. For convenience, we've added a PortableUnixMailbox class
40692 ece2af764621 Make comment match the code Andrew M. Kuchling <amk@amk.ca> parents: 40459 diff changeset	2115 # 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	2116
40693 de2bbdece83e [Bug #1633678] Improve pattern used for mbox 'From' lines; add a simple test Andrew M. Kuchling <amk@amk.ca> parents: 40692 diff changeset	2117 _fromlinepattern = (r"From \s*[^\s]+\s+\w\w\w\s+\w\w\w\s+\d?\d\s+"
de2bbdece83e [Bug #1633678] Improve pattern used for mbox 'From' lines; add a simple test Andrew M. Kuchling <amk@amk.ca> parents: 40692 diff changeset	2118 r"\d?\d:\d\d(:\d\d)?(\s+[^\s]+)?\s+\d\d\d\d\s*"
de2bbdece83e [Bug #1633678] Improve pattern used for mbox 'From' lines; add a simple test Andrew M. Kuchling <amk@amk.ca> parents: 40692 diff changeset	2119 r"[^\s]\s"
de2bbdece83e [Bug #1633678] Improve pattern used for mbox 'From' lines; add a simple test Andrew M. Kuchling <amk@amk.ca> parents: 40692 diff changeset	2120 "$")
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2121 _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	2122
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2123 def _strict_isrealfromline(self, line):
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2124 if not self._regexp:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2125 import re
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2126 self._regexp = re.compile(self._fromlinepattern)
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2127 return self._regexp.match(line)
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2128
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2129 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	2130 return True
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2131
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2132 _isrealfromline = _strict_isrealfromline
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2133
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2134
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2135 class PortableUnixMailbox(UnixMailbox):
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2136 _isrealfromline = UnixMailbox._portable_isrealfromline
670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2137
7838 fc950433d158 UnixMailbox: don't be fooled by lines that begin with "From " but Guido van Rossum <guido@python.org> parents: 7752 diff changeset	2138
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2139 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	2140
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2141 def _search_start(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2142 while 1:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2143 line = self.fp.readline()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2144 if not line:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2145 raise EOFError
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2146 if line[:5] == '\001\001\001\001\n':
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2147 return
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2148
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2149 def _search_end(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2150 while 1:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2151 pos = self.fp.tell()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2152 line = self.fp.readline()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2153 if not line:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2154 return
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2155 if line == '\001\001\001\001\n':
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2156 self.fp.seek(pos)
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2157 return
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2158
1596 2197dd241d8d Jack's module for parsing UNIX mailbox files Guido van Rossum <guido@python.org> parents: diff changeset	2159
3230 118c063df453 Added class MHMailbox Jack Jansen <jack.jansen@cwi.nl> parents: 1618 diff changeset	2160 class MHMailbox:
25227 809c14f1101a Undocumented feature: MHMailbox sets the msg object's _mh_msgno Guido van Rossum <guido@python.org> parents: 25039 diff changeset	2161
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2162 def __init__(self, dirname, factory=rfc822.Message):
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2163 import re
13911 6bf1281ec763 Improve MHMailbox: messages are now sorted in numerical order. Guido van Rossum <guido@python.org> parents: 13475 diff changeset	2164 pat = re.compile('^[1-9][0-9]*$')
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2165 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	2166 # 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	2167 # 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	2168 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	2169 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	2170 list = map(long, list)
6bf1281ec763 Improve MHMailbox: messages are now sorted in numerical order. Guido van Rossum <guido@python.org> parents: 13475 diff changeset	2171 list.sort()
6bf1281ec763 Improve MHMailbox: messages are now sorted in numerical order. Guido van Rossum <guido@python.org> parents: 13475 diff changeset	2172 # 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	2173 # 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	2174 self.boxes = map(str, list)
31465 85f4932d8ffd Lists work better when popping from the right. Raymond Hettinger <python@rcn.com> parents: 25227 diff changeset	2175 self.boxes.reverse()
16372 670a0194a8da Two changes: Barry Warsaw <barry@python.org> parents: 16198 diff changeset	2176 self.factory = factory
3230 118c063df453 Added class MHMailbox Jack Jansen <jack.jansen@cwi.nl> parents: 1618 diff changeset	2177
17660 30d7518e17e5 Make the Mailbox objects support iteration -- they already had the Fred Drake <fdrake@acm.org> parents: 17530 diff changeset	2178 def __iter__(self):
19893 3af006503678 SF bug #461073: mailbox __iter__ bug, by Andrew Dalke. Guido van Rossum <guido@python.org> parents: 19228 diff changeset	2179 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	2180
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2181 def next(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2182 if not self.boxes:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2183 return None
31465 85f4932d8ffd Lists work better when popping from the right. Raymond Hettinger <python@rcn.com> parents: 25227 diff changeset	2184 fn = self.boxes.pop()
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2185 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	2186 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	2187 try:
809c14f1101a Undocumented feature: MHMailbox sets the msg object's _mh_msgno Guido van Rossum <guido@python.org> parents: 25039 diff changeset	2188 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	2189 except (AttributeError, TypeError):
809c14f1101a Undocumented feature: MHMailbox sets the msg object's _mh_msgno Guido van Rossum <guido@python.org> parents: 25039 diff changeset	2190 pass
809c14f1101a Undocumented feature: MHMailbox sets the msg object's _mh_msgno Guido van Rossum <guido@python.org> parents: 25039 diff changeset	2191 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	2192
9725 4b1b9432b26b Patch by Mike Meyer: Guido van Rossum <guido@python.org> parents: 8685 diff changeset	2193
5531 5454fe4925d3 Added BabylMailbox class by Fred Lundh (untested). Guido van Rossum <guido@python.org> parents: 5443 diff changeset	2194 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	2195
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2196 def _search_start(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2197 while 1:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2198 line = self.fp.readline()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2199 if not line:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2200 raise EOFError
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2201 if line == '* EOOH *\n':
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2202 return
5531 5454fe4925d3 Added BabylMailbox class by Fred Lundh (untested). Guido van Rossum <guido@python.org> parents: 5443 diff changeset	2203
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2204 def _search_end(self):
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2205 while 1:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2206 pos = self.fp.tell()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2207 line = self.fp.readline()
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2208 if not line:
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2209 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	2210 if line == '\037\014\n' or line == '\037':
13475 2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2211 self.fp.seek(pos)
2ff2785e5291 Make tabnanny happy. Fred Drake <fdrake@acm.org> parents: 12227 diff changeset	2212 return
5531 5454fe4925d3 Added BabylMailbox class by Fred Lundh (untested). Guido van Rossum <guido@python.org> parents: 5443 diff changeset	2213
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2214 ## 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	2215
772828c1b1f6 Revamped test case and updated doc string. Guido van Rossum <guido@python.org> parents: 3360 diff changeset	2216
37916 de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2217 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	2218 """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	2219
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2220 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	2221 """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	2222
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2223 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	2224 """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	2225
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2226 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	2227 """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	2228
de4a5f55e21d Add Gregory K. Johnson's revised version of mailbox.py (funded by Andrew M. Kuchling <amk@amk.ca> parents: 33215 diff changeset	2229 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	2230 """A file appears to have an invalid format."""

Mercurial > cpython-lru_cache-weakref

annotate Lib/mailbox.py @ 80661:94de77bd0b4b 2.7