--- mailbox.py.orig 2007-10-15 19:49:29.267047481 +0200 +++ mailbox.py 2007-10-15 19:56:52.268292680 +0200 @@ -33,6 +33,776 @@ 'BabylMessage', 'MMDFMessage', 'UnixMailbox', 'PortableUnixMailbox', 'MmdfMailbox', 'MHMailbox', 'BabylMailbox' ] + + +class Message(email.Message.Message): + """Message with mailbox-format-specific properties.""" + + def __init__(self, message=None): + """Initialize a Message instance.""" + if isinstance(message, email.Message.Message): + self._become_message(copy.deepcopy(message)) + if isinstance(message, Message): + message._explain_to(self) + elif isinstance(message, str): + self._become_message(email.message_from_string(message)) + elif hasattr(message, "read"): + self._become_message(email.message_from_file(message)) + elif message is None: + email.Message.Message.__init__(self) + else: + raise TypeError('Invalid message type: %s' % type(message)) + + def _become_message(self, message): + """Assume the non-format-specific state of message.""" + for name in ('_headers', '_unixfrom', '_payload', '_charset', + 'preamble', 'epilogue', 'defects', '_default_type'): + self.__dict__[name] = message.__dict__[name] + + def _explain_to(self, message): + """Copy format-specific state to message insofar as possible.""" + if isinstance(message, Message): + return # There's nothing format-specific to explain. + else: + raise TypeError('Cannot convert to specified type') + + +class MaildirMessage(Message): + """Message with Maildir-specific properties.""" + + def __init__(self, message=None): + """Initialize a MaildirMessage instance.""" + self._subdir = 'new' + self._info = '' + self._date = time.time() + Message.__init__(self, message) + + def get_subdir(self): + """Return 'new' or 'cur'.""" + return self._subdir + + def set_subdir(self, subdir): + """Set subdir to 'new' or 'cur'.""" + if subdir == 'new' or subdir == 'cur': + self._subdir = subdir + else: + raise ValueError("subdir must be 'new' or 'cur': %s" % subdir) + + def get_flags(self): + """Return as a string the flags that are set.""" + if self._info.startswith('2,'): + return self._info[2:] + else: + return '' + + def set_flags(self, flags): + """Set the given flags and unset all others.""" + self._info = '2,' + ''.join(sorted(flags)) + + def add_flag(self, flag): + """Set the given flag(s) without changing others.""" + self.set_flags(''.join(set(self.get_flags()) | set(flag))) + + def remove_flag(self, flag): + """Unset the given string flag(s) without changing others.""" + if self.get_flags() != '': + self.set_flags(''.join(set(self.get_flags()) - set(flag))) + + def get_date(self): + """Return delivery date of message, in seconds since the epoch.""" + return self._date + + def set_date(self, date): + """Set delivery date of message, in seconds since the epoch.""" + try: + self._date = float(date) + except ValueError: + raise TypeError("can't convert to float: %s" % date) + + def get_info(self): + """Get the message's "info" as a string.""" + return self._info + + def set_info(self, info): + """Set the message's "info" string.""" + if isinstance(info, str): + self._info = info + else: + raise TypeError('info must be a string: %s' % type(info)) + + def _explain_to(self, message): + """Copy Maildir-specific state to message insofar as possible.""" + if isinstance(message, MaildirMessage): + message.set_flags(self.get_flags()) + message.set_subdir(self.get_subdir()) + message.set_date(self.get_date()) + elif isinstance(message, _mboxMMDFMessage): + flags = set(self.get_flags()) + if 'S' in flags: + message.add_flag('R') + if self.get_subdir() == 'cur': + message.add_flag('O') + if 'T' in flags: + message.add_flag('D') + if 'F' in flags: + message.add_flag('F') + if 'R' in flags: + message.add_flag('A') + message.set_from('MAILER-DAEMON', time.gmtime(self.get_date())) + elif isinstance(message, MHMessage): + flags = set(self.get_flags()) + if 'S' not in flags: + message.add_sequence('unseen') + if 'R' in flags: + message.add_sequence('replied') + if 'F' in flags: + message.add_sequence('flagged') + elif isinstance(message, BabylMessage): + flags = set(self.get_flags()) + if 'S' not in flags: + message.add_label('unseen') + if 'T' in flags: + message.add_label('deleted') + if 'R' in flags: + message.add_label('answered') + if 'P' in flags: + message.add_label('forwarded') + elif isinstance(message, Message): + pass + else: + raise TypeError('Cannot convert to specified type: %s' % + type(message)) + + +class _mboxMMDFMessage(Message): + """Message with mbox- or MMDF-specific properties.""" + + def __init__(self, message=None): + """Initialize an mboxMMDFMessage instance.""" + self.set_from('MAILER-DAEMON', True) + if isinstance(message, email.Message.Message): + unixfrom = message.get_unixfrom() + if unixfrom is not None and unixfrom.startswith('From '): + self.set_from(unixfrom[5:]) + Message.__init__(self, message) + + def get_from(self): + """Return contents of "From " line.""" + return self._from + + def set_from(self, from_, time_=None): + """Set "From " line, formatting and appending time_ if specified.""" + if time_ is not None: + if time_ is True: + time_ = time.gmtime() + from_ += ' ' + time.asctime(time_) + self._from = from_ + + def get_flags(self): + """Return as a string the flags that are set.""" + return self.get('Status', '') + self.get('X-Status', '') + + def set_flags(self, flags): + """Set the given flags and unset all others.""" + flags = set(flags) + status_flags, xstatus_flags = '', '' + for flag in ('R', 'O'): + if flag in flags: + status_flags += flag + flags.remove(flag) + for flag in ('D', 'F', 'A'): + if flag in flags: + xstatus_flags += flag + flags.remove(flag) + xstatus_flags += ''.join(sorted(flags)) + try: + self.replace_header('Status', status_flags) + except KeyError: + self.add_header('Status', status_flags) + try: + self.replace_header('X-Status', xstatus_flags) + except KeyError: + self.add_header('X-Status', xstatus_flags) + + def add_flag(self, flag): + """Set the given flag(s) without changing others.""" + self.set_flags(''.join(set(self.get_flags()) | set(flag))) + + def remove_flag(self, flag): + """Unset the given string flag(s) without changing others.""" + if 'Status' in self or 'X-Status' in self: + self.set_flags(''.join(set(self.get_flags()) - set(flag))) + + def _explain_to(self, message): + """Copy mbox- or MMDF-specific state to message insofar as possible.""" + if isinstance(message, MaildirMessage): + flags = set(self.get_flags()) + if 'O' in flags: + message.set_subdir('cur') + if 'F' in flags: + message.add_flag('F') + if 'A' in flags: + message.add_flag('R') + if 'R' in flags: + message.add_flag('S') + if 'D' in flags: + message.add_flag('T') + del message['status'] + del message['x-status'] + maybe_date = ' '.join(self.get_from().split()[-5:]) + try: + message.set_date(calendar.timegm(time.strptime(maybe_date, + '%a %b %d %H:%M:%S %Y'))) + except (ValueError, OverflowError): + pass + elif isinstance(message, _mboxMMDFMessage): + message.set_flags(self.get_flags()) + message.set_from(self.get_from()) + elif isinstance(message, MHMessage): + flags = set(self.get_flags()) + if 'R' not in flags: + message.add_sequence('unseen') + if 'A' in flags: + message.add_sequence('replied') + if 'F' in flags: + message.add_sequence('flagged') + del message['status'] + del message['x-status'] + elif isinstance(message, BabylMessage): + flags = set(self.get_flags()) + if 'R' not in flags: + message.add_label('unseen') + if 'D' in flags: + message.add_label('deleted') + if 'A' in flags: + message.add_label('answered') + del message['status'] + del message['x-status'] + elif isinstance(message, Message): + pass + else: + raise TypeError('Cannot convert to specified type: %s' % + type(message)) + + +class mboxMessage(_mboxMMDFMessage): + """Message with mbox-specific properties.""" + + +class MHMessage(Message): + """Message with MH-specific properties.""" + + def __init__(self, message=None): + """Initialize an MHMessage instance.""" + self._sequences = [] + Message.__init__(self, message) + + def get_sequences(self): + """Return a list of sequences that include the message.""" + return self._sequences[:] + + def set_sequences(self, sequences): + """Set the list of sequences that include the message.""" + self._sequences = list(sequences) + + def add_sequence(self, sequence): + """Add sequence to list of sequences including the message.""" + if isinstance(sequence, str): + if not sequence in self._sequences: + self._sequences.append(sequence) + else: + raise TypeError('sequence must be a string: %s' % type(sequence)) + + def remove_sequence(self, sequence): + """Remove sequence from the list of sequences including the message.""" + try: + self._sequences.remove(sequence) + except ValueError: + pass + + def _explain_to(self, message): + """Copy MH-specific state to message insofar as possible.""" + if isinstance(message, MaildirMessage): + sequences = set(self.get_sequences()) + if 'unseen' in sequences: + message.set_subdir('cur') + else: + message.set_subdir('cur') + message.add_flag('S') + if 'flagged' in sequences: + message.add_flag('F') + if 'replied' in sequences: + message.add_flag('R') + elif isinstance(message, _mboxMMDFMessage): + sequences = set(self.get_sequences()) + if 'unseen' not in sequences: + message.add_flag('RO') + else: + message.add_flag('O') + if 'flagged' in sequences: + message.add_flag('F') + if 'replied' in sequences: + message.add_flag('A') + elif isinstance(message, MHMessage): + for sequence in self.get_sequences(): + message.add_sequence(sequence) + elif isinstance(message, BabylMessage): + sequences = set(self.get_sequences()) + if 'unseen' in sequences: + message.add_label('unseen') + if 'replied' in sequences: + message.add_label('answered') + elif isinstance(message, Message): + pass + else: + raise TypeError('Cannot convert to specified type: %s' % + type(message)) + + +class BabylMessage(Message): + """Message with Babyl-specific properties.""" + + def __init__(self, message=None): + """Initialize an BabylMessage instance.""" + self._labels = [] + self._visible = Message() + Message.__init__(self, message) + + def get_labels(self): + """Return a list of labels on the message.""" + return self._labels[:] + + def set_labels(self, labels): + """Set the list of labels on the message.""" + self._labels = list(labels) + + def add_label(self, label): + """Add label to list of labels on the message.""" + if isinstance(label, str): + if label not in self._labels: + self._labels.append(label) + else: + raise TypeError('label must be a string: %s' % type(label)) + + def remove_label(self, label): + """Remove label from the list of labels on the message.""" + try: + self._labels.remove(label) + except ValueError: + pass + + def get_visible(self): + """Return a Message representation of visible headers.""" + return Message(self._visible) + + def set_visible(self, visible): + """Set the Message representation of visible headers.""" + self._visible = Message(visible) + + def update_visible(self): + """Update and/or sensibly generate a set of visible headers.""" + for header in self._visible.keys(): + if header in self: + self._visible.replace_header(header, self[header]) + else: + del self._visible[header] + for header in ('Date', 'From', 'Reply-To', 'To', 'CC', 'Subject'): + if header in self and header not in self._visible: + self._visible[header] = self[header] + + def _explain_to(self, message): + """Copy Babyl-specific state to message insofar as possible.""" + if isinstance(message, MaildirMessage): + labels = set(self.get_labels()) + if 'unseen' in labels: + message.set_subdir('cur') + else: + message.set_subdir('cur') + message.add_flag('S') + if 'forwarded' in labels or 'resent' in labels: + message.add_flag('P') + if 'answered' in labels: + message.add_flag('R') + if 'deleted' in labels: + message.add_flag('T') + elif isinstance(message, _mboxMMDFMessage): + labels = set(self.get_labels()) + if 'unseen' not in labels: + message.add_flag('RO') + else: + message.add_flag('O') + if 'deleted' in labels: + message.add_flag('D') + if 'answered' in labels: + message.add_flag('A') + elif isinstance(message, MHMessage): + labels = set(self.get_labels()) + if 'unseen' in labels: + message.add_sequence('unseen') + if 'answered' in labels: + message.add_sequence('replied') + elif isinstance(message, BabylMessage): + message.set_visible(self.get_visible()) + for label in self.get_labels(): + message.add_label(label) + elif isinstance(message, Message): + pass + else: + raise TypeError('Cannot convert to specified type: %s' % + type(message)) + + +class MMDFMessage(_mboxMMDFMessage): + """Message with MMDF-specific properties.""" + + +class _ProxyFile: + """A read-only wrapper of a file.""" + + def __init__(self, f, pos=None): + """Initialize a _ProxyFile.""" + self._file = f + if pos is None: + self._pos = f.tell() + else: + self._pos = pos + + def read(self, size=None): + """Read bytes.""" + return self._read(size, self._file.read) + + def readline(self, size=None): + """Read a line.""" + return self._read(size, self._file.readline) + + def readlines(self, sizehint=None): + """Read multiple lines.""" + result = [] + for line in self: + result.append(line) + if sizehint is not None: + sizehint -= len(line) + if sizehint <= 0: + break + return result + + def __iter__(self): + """Iterate over lines.""" + return iter(self.readline, "") + + def tell(self): + """Return the position.""" + return self._pos + + def seek(self, offset, whence=0): + """Change position.""" + if whence == 1: + self._file.seek(self._pos) + self._file.seek(offset, whence) + self._pos = self._file.tell() + + def close(self): + """Close the file.""" + del self._file + + def _read(self, size, read_method): + """Read size bytes using read_method.""" + if size is None: + size = -1 + self._file.seek(self._pos) + result = read_method(size) + self._pos = self._file.tell() + return result + + +class _PartialFile(_ProxyFile): + """A read-only wrapper of part of a file.""" + + def __init__(self, f, start=None, stop=None): + """Initialize a _PartialFile.""" + _ProxyFile.__init__(self, f, start) + self._start = start + self._stop = stop + + def tell(self): + """Return the position with respect to start.""" + return _ProxyFile.tell(self) - self._start + + def seek(self, offset, whence=0): + """Change position, possibly with respect to start or stop.""" + if whence == 0: + self._pos = self._start + whence = 1 + elif whence == 2: + self._pos = self._stop + whence = 1 + _ProxyFile.seek(self, offset, whence) + + def _read(self, size, read_method): + """Read size bytes using read_method, honoring start and stop.""" + remaining = self._stop - self._pos + if remaining <= 0: + return '' + if size is None or size < 0 or size > remaining: + size = remaining + return _ProxyFile._read(self, size, read_method) + + +def _lock_file(f, dotlock=True): + """Lock file f using lockf and dot locking.""" + dotlock_done = False + try: + if fcntl: + try: + fcntl.lockf(f, fcntl.LOCK_EX | fcntl.LOCK_NB) + except IOError, e: + if e.errno in (errno.EAGAIN, errno.EACCES): + raise ExternalClashError('lockf: lock unavailable: %s' % + f.name) + else: + raise + if dotlock: + try: + pre_lock = _create_temporary(f.name + '.lock') + pre_lock.close() + except IOError, e: + if e.errno == errno.EACCES: + return # Without write access, just skip dotlocking. + else: + raise + try: + if hasattr(os, 'link'): + os.link(pre_lock.name, f.name + '.lock') + dotlock_done = True + os.unlink(pre_lock.name) + else: + os.rename(pre_lock.name, f.name + '.lock') + dotlock_done = True + except OSError, e: + if e.errno == errno.EEXIST or \ + (os.name == 'os2' and e.errno == errno.EACCES): + os.remove(pre_lock.name) + raise ExternalClashError('dot lock unavailable: %s' % + f.name) + else: + raise + except: + if fcntl: + fcntl.lockf(f, fcntl.LOCK_UN) + if dotlock_done: + os.remove(f.name + '.lock') + raise + +def _unlock_file(f): + """Unlock file f using lockf and dot locking.""" + if fcntl: + fcntl.lockf(f, fcntl.LOCK_UN) + if os.path.exists(f.name + '.lock'): + os.remove(f.name + '.lock') + +def _create_carefully(path): + """Create a file if it doesn't exist and open for reading and writing.""" + fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDWR) + try: + return open(path, 'rb+') + finally: + os.close(fd) + +def _create_temporary(path): + """Create a temp file based on path and open for reading and writing.""" + return _create_carefully('%s.%s.%s.%s' % (path, int(time.time()), + socket.gethostname(), + os.getpid())) + +def _sync_flush(f): + """Ensure changes to file f are physically on disk.""" + f.flush() + if hasattr(os, 'fsync'): + os.fsync(f.fileno()) + +def _sync_close(f): + """Close file f, ensuring all changes are physically on disk.""" + _sync_flush(f) + f.close() + +## Start: classes from the original module (for backward compatibility). + +# Note that the Maildir class, whose name is unchanged, itself offers a next() +# method for backward compatibility. + +class _Mailbox: + + def __init__(self, fp, factory=rfc822.Message): + self.fp = fp + self.seekp = 0 + self.factory = factory + + def __iter__(self): + return iter(self.next, None) + + def next(self): + while 1: + self.fp.seek(self.seekp) + try: + self._search_start() + except EOFError: + self.seekp = self.fp.tell() + return None + start = self.fp.tell() + self._search_end() + self.seekp = stop = self.fp.tell() + if start != stop: + break + return self.factory(_PartialFile(self.fp, start, stop)) + +# Recommended to use PortableUnixMailbox instead! +class UnixMailbox(_Mailbox): + + def _search_start(self): + while 1: + pos = self.fp.tell() + line = self.fp.readline() + if not line: + raise EOFError + if line[:5] == 'From ' and self._isrealfromline(line): + self.fp.seek(pos) + return + + def _search_end(self): + self.fp.readline() # Throw away header line + while 1: + pos = self.fp.tell() + line = self.fp.readline() + if not line: + return + if line[:5] == 'From ' and self._isrealfromline(line): + self.fp.seek(pos) + return + + # An overridable mechanism to test for From-line-ness. You can either + # specify a different regular expression or define a whole new + # _isrealfromline() method. Note that this only gets called for lines + # starting with the 5 characters "From ". + # + # BAW: According to + #http://home.netscape.com/eng/mozilla/2.0/relnotes/demo/content-length.html + # the only portable, reliable way to find message delimiters in a BSD (i.e + # Unix mailbox) style folder is to search for "\n\nFrom .*\n", or at the + # beginning of the file, "^From .*\n". While _fromlinepattern below seems + # like a good idea, in practice, there are too many variations for more + # strict parsing of the line to be completely accurate. + # + # _strict_isrealfromline() is the old version which tries to do stricter + # parsing of the From_ line. _portable_isrealfromline() simply returns + # true, since it's never called if the line doesn't already start with + # "From ". + # + # This algorithm, and the way it interacts with _search_start() and + # _search_end() may not be completely correct, because it doesn't check + # that the two characters preceding "From " are \n\n or the beginning of + # the file. Fixing this would require a more extensive rewrite than is + # necessary. For convenience, we've added a PortableUnixMailbox class + # which does no checking of the format of the 'From' line. + + _fromlinepattern = (r"From \s*[^\s]+\s+\w\w\w\s+\w\w\w\s+\d?\d\s+" + r"\d?\d:\d\d(:\d\d)?(\s+[^\s]+)?\s+\d\d\d\d\s*" + r"[^\s]*\s*" + "$") + _regexp = None + + def _strict_isrealfromline(self, line): + if not self._regexp: + import re + self._regexp = re.compile(self._fromlinepattern) + return self._regexp.match(line) + + def _portable_isrealfromline(self, line): + return True + + _isrealfromline = _strict_isrealfromline + + +class PortableUnixMailbox(UnixMailbox): + _isrealfromline = UnixMailbox._portable_isrealfromline + + +class MmdfMailbox(_Mailbox): + + def _search_start(self): + while 1: + line = self.fp.readline() + if not line: + raise EOFError + if line[:5] == '\001\001\001\001\n': + return + + def _search_end(self): + while 1: + pos = self.fp.tell() + line = self.fp.readline() + if not line: + return + if line == '\001\001\001\001\n': + self.fp.seek(pos) + return + + +class MHMailbox: + + def __init__(self, dirname, factory=rfc822.Message): + import re + pat = re.compile('^[1-9][0-9]*$') + self.dirname = dirname + # the three following lines could be combined into: + # list = map(long, filter(pat.match, os.listdir(self.dirname))) + list = os.listdir(self.dirname) + list = filter(pat.match, list) + list = map(long, list) + list.sort() + # This only works in Python 1.6 or later; + # before that str() added 'L': + self.boxes = map(str, list) + self.boxes.reverse() + self.factory = factory + + def __iter__(self): + return iter(self.next, None) + + def next(self): + if not self.boxes: + return None + fn = self.boxes.pop() + fp = open(os.path.join(self.dirname, fn)) + msg = self.factory(fp) + try: + msg._mh_msgno = fn + except (AttributeError, TypeError): + pass + return msg + + +class BabylMailbox(_Mailbox): + + def _search_start(self): + while 1: + line = self.fp.readline() + if not line: + raise EOFError + if line == '*** EOOH ***\n': + return + + def _search_end(self): + while 1: + pos = self.fp.tell() + line = self.fp.readline() + if not line: + return + if line == '\037\014\n' or line == '\037': + self.fp.seek(pos) + return + + + class Mailbox: """A group of messages in a particular place.""" @@ -225,9 +995,11 @@ colon = ':' - def __init__(self, dirname, factory=rfc822.Message, create=True): + def __init__(self, dirname, factory=MaildirMessage, create=True): """Initialize a Maildir instance.""" Mailbox.__init__(self, dirname, factory, create) + if not isinstance(self._factory(), MaildirMessage): + raise DeprecationWarning("factory argument should be a MaildirMessage!") if not os.path.exists(self._path): if create: os.mkdir(self._path, 0700) @@ -245,7 +1017,7 @@ self._dump_message(message, tmp_file) finally: _sync_close(tmp_file) - if isinstance(message, MaildirMessage): + if isinstance(message, self._factory): subdir = message.get_subdir() suffix = self.colon + message.get_info() if suffix == self.colon: @@ -268,7 +1040,7 @@ % dest) else: raise - if isinstance(message, MaildirMessage): + if isinstance(message, self._factory): os.utime(dest, (os.path.getatime(dest), message.get_date())) return uniq @@ -292,7 +1064,7 @@ old_subpath = self._lookup(key) temp_key = self.add(message) temp_subpath = self._lookup(temp_key) - if isinstance(message, MaildirMessage): + if isinstance(message, self._factory): # temp's subdir and suffix were specified by message. dominant_subpath = temp_subpath else: @@ -306,7 +1078,7 @@ self.discard(key) new_path = os.path.join(self._path, subdir, key + suffix) os.rename(os.path.join(self._path, temp_subpath), new_path) - if isinstance(message, MaildirMessage): + if isinstance(message, self._factory): os.utime(new_path, (os.path.getatime(new_path), message.get_date())) @@ -315,7 +1087,7 @@ subpath = self._lookup(key) f = open(os.path.join(self._path, subpath), 'r') try: - msg = MaildirMessage(f) + msg = self._factory(f) finally: f.close() subdir, name = os.path.split(subpath) @@ -1305,772 +2077,6 @@ return (start, stop) -class Message(email.Message.Message): - """Message with mailbox-format-specific properties.""" - - def __init__(self, message=None): - """Initialize a Message instance.""" - if isinstance(message, email.Message.Message): - self._become_message(copy.deepcopy(message)) - if isinstance(message, Message): - message._explain_to(self) - elif isinstance(message, str): - self._become_message(email.message_from_string(message)) - elif hasattr(message, "read"): - self._become_message(email.message_from_file(message)) - elif message is None: - email.Message.Message.__init__(self) - else: - raise TypeError('Invalid message type: %s' % type(message)) - - def _become_message(self, message): - """Assume the non-format-specific state of message.""" - for name in ('_headers', '_unixfrom', '_payload', '_charset', - 'preamble', 'epilogue', 'defects', '_default_type'): - self.__dict__[name] = message.__dict__[name] - - def _explain_to(self, message): - """Copy format-specific state to message insofar as possible.""" - if isinstance(message, Message): - return # There's nothing format-specific to explain. - else: - raise TypeError('Cannot convert to specified type') - - -class MaildirMessage(Message): - """Message with Maildir-specific properties.""" - - def __init__(self, message=None): - """Initialize a MaildirMessage instance.""" - self._subdir = 'new' - self._info = '' - self._date = time.time() - Message.__init__(self, message) - - def get_subdir(self): - """Return 'new' or 'cur'.""" - return self._subdir - - def set_subdir(self, subdir): - """Set subdir to 'new' or 'cur'.""" - if subdir == 'new' or subdir == 'cur': - self._subdir = subdir - else: - raise ValueError("subdir must be 'new' or 'cur': %s" % subdir) - - def get_flags(self): - """Return as a string the flags that are set.""" - if self._info.startswith('2,'): - return self._info[2:] - else: - return '' - - def set_flags(self, flags): - """Set the given flags and unset all others.""" - self._info = '2,' + ''.join(sorted(flags)) - - def add_flag(self, flag): - """Set the given flag(s) without changing others.""" - self.set_flags(''.join(set(self.get_flags()) | set(flag))) - - def remove_flag(self, flag): - """Unset the given string flag(s) without changing others.""" - if self.get_flags() != '': - self.set_flags(''.join(set(self.get_flags()) - set(flag))) - - def get_date(self): - """Return delivery date of message, in seconds since the epoch.""" - return self._date - - def set_date(self, date): - """Set delivery date of message, in seconds since the epoch.""" - try: - self._date = float(date) - except ValueError: - raise TypeError("can't convert to float: %s" % date) - - def get_info(self): - """Get the message's "info" as a string.""" - return self._info - - def set_info(self, info): - """Set the message's "info" string.""" - if isinstance(info, str): - self._info = info - else: - raise TypeError('info must be a string: %s' % type(info)) - - def _explain_to(self, message): - """Copy Maildir-specific state to message insofar as possible.""" - if isinstance(message, MaildirMessage): - message.set_flags(self.get_flags()) - message.set_subdir(self.get_subdir()) - message.set_date(self.get_date()) - elif isinstance(message, _mboxMMDFMessage): - flags = set(self.get_flags()) - if 'S' in flags: - message.add_flag('R') - if self.get_subdir() == 'cur': - message.add_flag('O') - if 'T' in flags: - message.add_flag('D') - if 'F' in flags: - message.add_flag('F') - if 'R' in flags: - message.add_flag('A') - message.set_from('MAILER-DAEMON', time.gmtime(self.get_date())) - elif isinstance(message, MHMessage): - flags = set(self.get_flags()) - if 'S' not in flags: - message.add_sequence('unseen') - if 'R' in flags: - message.add_sequence('replied') - if 'F' in flags: - message.add_sequence('flagged') - elif isinstance(message, BabylMessage): - flags = set(self.get_flags()) - if 'S' not in flags: - message.add_label('unseen') - if 'T' in flags: - message.add_label('deleted') - if 'R' in flags: - message.add_label('answered') - if 'P' in flags: - message.add_label('forwarded') - elif isinstance(message, Message): - pass - else: - raise TypeError('Cannot convert to specified type: %s' % - type(message)) - - -class _mboxMMDFMessage(Message): - """Message with mbox- or MMDF-specific properties.""" - - def __init__(self, message=None): - """Initialize an mboxMMDFMessage instance.""" - self.set_from('MAILER-DAEMON', True) - if isinstance(message, email.Message.Message): - unixfrom = message.get_unixfrom() - if unixfrom is not None and unixfrom.startswith('From '): - self.set_from(unixfrom[5:]) - Message.__init__(self, message) - - def get_from(self): - """Return contents of "From " line.""" - return self._from - - def set_from(self, from_, time_=None): - """Set "From " line, formatting and appending time_ if specified.""" - if time_ is not None: - if time_ is True: - time_ = time.gmtime() - from_ += ' ' + time.asctime(time_) - self._from = from_ - - def get_flags(self): - """Return as a string the flags that are set.""" - return self.get('Status', '') + self.get('X-Status', '') - - def set_flags(self, flags): - """Set the given flags and unset all others.""" - flags = set(flags) - status_flags, xstatus_flags = '', '' - for flag in ('R', 'O'): - if flag in flags: - status_flags += flag - flags.remove(flag) - for flag in ('D', 'F', 'A'): - if flag in flags: - xstatus_flags += flag - flags.remove(flag) - xstatus_flags += ''.join(sorted(flags)) - try: - self.replace_header('Status', status_flags) - except KeyError: - self.add_header('Status', status_flags) - try: - self.replace_header('X-Status', xstatus_flags) - except KeyError: - self.add_header('X-Status', xstatus_flags) - - def add_flag(self, flag): - """Set the given flag(s) without changing others.""" - self.set_flags(''.join(set(self.get_flags()) | set(flag))) - - def remove_flag(self, flag): - """Unset the given string flag(s) without changing others.""" - if 'Status' in self or 'X-Status' in self: - self.set_flags(''.join(set(self.get_flags()) - set(flag))) - - def _explain_to(self, message): - """Copy mbox- or MMDF-specific state to message insofar as possible.""" - if isinstance(message, MaildirMessage): - flags = set(self.get_flags()) - if 'O' in flags: - message.set_subdir('cur') - if 'F' in flags: - message.add_flag('F') - if 'A' in flags: - message.add_flag('R') - if 'R' in flags: - message.add_flag('S') - if 'D' in flags: - message.add_flag('T') - del message['status'] - del message['x-status'] - maybe_date = ' '.join(self.get_from().split()[-5:]) - try: - message.set_date(calendar.timegm(time.strptime(maybe_date, - '%a %b %d %H:%M:%S %Y'))) - except (ValueError, OverflowError): - pass - elif isinstance(message, _mboxMMDFMessage): - message.set_flags(self.get_flags()) - message.set_from(self.get_from()) - elif isinstance(message, MHMessage): - flags = set(self.get_flags()) - if 'R' not in flags: - message.add_sequence('unseen') - if 'A' in flags: - message.add_sequence('replied') - if 'F' in flags: - message.add_sequence('flagged') - del message['status'] - del message['x-status'] - elif isinstance(message, BabylMessage): - flags = set(self.get_flags()) - if 'R' not in flags: - message.add_label('unseen') - if 'D' in flags: - message.add_label('deleted') - if 'A' in flags: - message.add_label('answered') - del message['status'] - del message['x-status'] - elif isinstance(message, Message): - pass - else: - raise TypeError('Cannot convert to specified type: %s' % - type(message)) - - -class mboxMessage(_mboxMMDFMessage): - """Message with mbox-specific properties.""" - - -class MHMessage(Message): - """Message with MH-specific properties.""" - - def __init__(self, message=None): - """Initialize an MHMessage instance.""" - self._sequences = [] - Message.__init__(self, message) - - def get_sequences(self): - """Return a list of sequences that include the message.""" - return self._sequences[:] - - def set_sequences(self, sequences): - """Set the list of sequences that include the message.""" - self._sequences = list(sequences) - - def add_sequence(self, sequence): - """Add sequence to list of sequences including the message.""" - if isinstance(sequence, str): - if not sequence in self._sequences: - self._sequences.append(sequence) - else: - raise TypeError('sequence must be a string: %s' % type(sequence)) - - def remove_sequence(self, sequence): - """Remove sequence from the list of sequences including the message.""" - try: - self._sequences.remove(sequence) - except ValueError: - pass - - def _explain_to(self, message): - """Copy MH-specific state to message insofar as possible.""" - if isinstance(message, MaildirMessage): - sequences = set(self.get_sequences()) - if 'unseen' in sequences: - message.set_subdir('cur') - else: - message.set_subdir('cur') - message.add_flag('S') - if 'flagged' in sequences: - message.add_flag('F') - if 'replied' in sequences: - message.add_flag('R') - elif isinstance(message, _mboxMMDFMessage): - sequences = set(self.get_sequences()) - if 'unseen' not in sequences: - message.add_flag('RO') - else: - message.add_flag('O') - if 'flagged' in sequences: - message.add_flag('F') - if 'replied' in sequences: - message.add_flag('A') - elif isinstance(message, MHMessage): - for sequence in self.get_sequences(): - message.add_sequence(sequence) - elif isinstance(message, BabylMessage): - sequences = set(self.get_sequences()) - if 'unseen' in sequences: - message.add_label('unseen') - if 'replied' in sequences: - message.add_label('answered') - elif isinstance(message, Message): - pass - else: - raise TypeError('Cannot convert to specified type: %s' % - type(message)) - - -class BabylMessage(Message): - """Message with Babyl-specific properties.""" - - def __init__(self, message=None): - """Initialize an BabylMessage instance.""" - self._labels = [] - self._visible = Message() - Message.__init__(self, message) - - def get_labels(self): - """Return a list of labels on the message.""" - return self._labels[:] - - def set_labels(self, labels): - """Set the list of labels on the message.""" - self._labels = list(labels) - - def add_label(self, label): - """Add label to list of labels on the message.""" - if isinstance(label, str): - if label not in self._labels: - self._labels.append(label) - else: - raise TypeError('label must be a string: %s' % type(label)) - - def remove_label(self, label): - """Remove label from the list of labels on the message.""" - try: - self._labels.remove(label) - except ValueError: - pass - - def get_visible(self): - """Return a Message representation of visible headers.""" - return Message(self._visible) - - def set_visible(self, visible): - """Set the Message representation of visible headers.""" - self._visible = Message(visible) - - def update_visible(self): - """Update and/or sensibly generate a set of visible headers.""" - for header in self._visible.keys(): - if header in self: - self._visible.replace_header(header, self[header]) - else: - del self._visible[header] - for header in ('Date', 'From', 'Reply-To', 'To', 'CC', 'Subject'): - if header in self and header not in self._visible: - self._visible[header] = self[header] - - def _explain_to(self, message): - """Copy Babyl-specific state to message insofar as possible.""" - if isinstance(message, MaildirMessage): - labels = set(self.get_labels()) - if 'unseen' in labels: - message.set_subdir('cur') - else: - message.set_subdir('cur') - message.add_flag('S') - if 'forwarded' in labels or 'resent' in labels: - message.add_flag('P') - if 'answered' in labels: - message.add_flag('R') - if 'deleted' in labels: - message.add_flag('T') - elif isinstance(message, _mboxMMDFMessage): - labels = set(self.get_labels()) - if 'unseen' not in labels: - message.add_flag('RO') - else: - message.add_flag('O') - if 'deleted' in labels: - message.add_flag('D') - if 'answered' in labels: - message.add_flag('A') - elif isinstance(message, MHMessage): - labels = set(self.get_labels()) - if 'unseen' in labels: - message.add_sequence('unseen') - if 'answered' in labels: - message.add_sequence('replied') - elif isinstance(message, BabylMessage): - message.set_visible(self.get_visible()) - for label in self.get_labels(): - message.add_label(label) - elif isinstance(message, Message): - pass - else: - raise TypeError('Cannot convert to specified type: %s' % - type(message)) - - -class MMDFMessage(_mboxMMDFMessage): - """Message with MMDF-specific properties.""" - - -class _ProxyFile: - """A read-only wrapper of a file.""" - - def __init__(self, f, pos=None): - """Initialize a _ProxyFile.""" - self._file = f - if pos is None: - self._pos = f.tell() - else: - self._pos = pos - - def read(self, size=None): - """Read bytes.""" - return self._read(size, self._file.read) - - def readline(self, size=None): - """Read a line.""" - return self._read(size, self._file.readline) - - def readlines(self, sizehint=None): - """Read multiple lines.""" - result = [] - for line in self: - result.append(line) - if sizehint is not None: - sizehint -= len(line) - if sizehint <= 0: - break - return result - - def __iter__(self): - """Iterate over lines.""" - return iter(self.readline, "") - - def tell(self): - """Return the position.""" - return self._pos - - def seek(self, offset, whence=0): - """Change position.""" - if whence == 1: - self._file.seek(self._pos) - self._file.seek(offset, whence) - self._pos = self._file.tell() - - def close(self): - """Close the file.""" - del self._file - - def _read(self, size, read_method): - """Read size bytes using read_method.""" - if size is None: - size = -1 - self._file.seek(self._pos) - result = read_method(size) - self._pos = self._file.tell() - return result - - -class _PartialFile(_ProxyFile): - """A read-only wrapper of part of a file.""" - - def __init__(self, f, start=None, stop=None): - """Initialize a _PartialFile.""" - _ProxyFile.__init__(self, f, start) - self._start = start - self._stop = stop - - def tell(self): - """Return the position with respect to start.""" - return _ProxyFile.tell(self) - self._start - - def seek(self, offset, whence=0): - """Change position, possibly with respect to start or stop.""" - if whence == 0: - self._pos = self._start - whence = 1 - elif whence == 2: - self._pos = self._stop - whence = 1 - _ProxyFile.seek(self, offset, whence) - - def _read(self, size, read_method): - """Read size bytes using read_method, honoring start and stop.""" - remaining = self._stop - self._pos - if remaining <= 0: - return '' - if size is None or size < 0 or size > remaining: - size = remaining - return _ProxyFile._read(self, size, read_method) - - -def _lock_file(f, dotlock=True): - """Lock file f using lockf and dot locking.""" - dotlock_done = False - try: - if fcntl: - try: - fcntl.lockf(f, fcntl.LOCK_EX | fcntl.LOCK_NB) - except IOError, e: - if e.errno in (errno.EAGAIN, errno.EACCES): - raise ExternalClashError('lockf: lock unavailable: %s' % - f.name) - else: - raise - if dotlock: - try: - pre_lock = _create_temporary(f.name + '.lock') - pre_lock.close() - except IOError, e: - if e.errno == errno.EACCES: - return # Without write access, just skip dotlocking. - else: - raise - try: - if hasattr(os, 'link'): - os.link(pre_lock.name, f.name + '.lock') - dotlock_done = True - os.unlink(pre_lock.name) - else: - os.rename(pre_lock.name, f.name + '.lock') - dotlock_done = True - except OSError, e: - if e.errno == errno.EEXIST or \ - (os.name == 'os2' and e.errno == errno.EACCES): - os.remove(pre_lock.name) - raise ExternalClashError('dot lock unavailable: %s' % - f.name) - else: - raise - except: - if fcntl: - fcntl.lockf(f, fcntl.LOCK_UN) - if dotlock_done: - os.remove(f.name + '.lock') - raise - -def _unlock_file(f): - """Unlock file f using lockf and dot locking.""" - if fcntl: - fcntl.lockf(f, fcntl.LOCK_UN) - if os.path.exists(f.name + '.lock'): - os.remove(f.name + '.lock') - -def _create_carefully(path): - """Create a file if it doesn't exist and open for reading and writing.""" - fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDWR) - try: - return open(path, 'rb+') - finally: - os.close(fd) - -def _create_temporary(path): - """Create a temp file based on path and open for reading and writing.""" - return _create_carefully('%s.%s.%s.%s' % (path, int(time.time()), - socket.gethostname(), - os.getpid())) - -def _sync_flush(f): - """Ensure changes to file f are physically on disk.""" - f.flush() - if hasattr(os, 'fsync'): - os.fsync(f.fileno()) - -def _sync_close(f): - """Close file f, ensuring all changes are physically on disk.""" - _sync_flush(f) - f.close() - -## Start: classes from the original module (for backward compatibility). - -# Note that the Maildir class, whose name is unchanged, itself offers a next() -# method for backward compatibility. - -class _Mailbox: - - def __init__(self, fp, factory=rfc822.Message): - self.fp = fp - self.seekp = 0 - self.factory = factory - - def __iter__(self): - return iter(self.next, None) - - def next(self): - while 1: - self.fp.seek(self.seekp) - try: - self._search_start() - except EOFError: - self.seekp = self.fp.tell() - return None - start = self.fp.tell() - self._search_end() - self.seekp = stop = self.fp.tell() - if start != stop: - break - return self.factory(_PartialFile(self.fp, start, stop)) - -# Recommended to use PortableUnixMailbox instead! -class UnixMailbox(_Mailbox): - - def _search_start(self): - while 1: - pos = self.fp.tell() - line = self.fp.readline() - if not line: - raise EOFError - if line[:5] == 'From ' and self._isrealfromline(line): - self.fp.seek(pos) - return - - def _search_end(self): - self.fp.readline() # Throw away header line - while 1: - pos = self.fp.tell() - line = self.fp.readline() - if not line: - return - if line[:5] == 'From ' and self._isrealfromline(line): - self.fp.seek(pos) - return - - # An overridable mechanism to test for From-line-ness. You can either - # specify a different regular expression or define a whole new - # _isrealfromline() method. Note that this only gets called for lines - # starting with the 5 characters "From ". - # - # BAW: According to - #http://home.netscape.com/eng/mozilla/2.0/relnotes/demo/content-length.html - # the only portable, reliable way to find message delimiters in a BSD (i.e - # Unix mailbox) style folder is to search for "\n\nFrom .*\n", or at the - # beginning of the file, "^From .*\n". While _fromlinepattern below seems - # like a good idea, in practice, there are too many variations for more - # strict parsing of the line to be completely accurate. - # - # _strict_isrealfromline() is the old version which tries to do stricter - # parsing of the From_ line. _portable_isrealfromline() simply returns - # true, since it's never called if the line doesn't already start with - # "From ". - # - # This algorithm, and the way it interacts with _search_start() and - # _search_end() may not be completely correct, because it doesn't check - # that the two characters preceding "From " are \n\n or the beginning of - # the file. Fixing this would require a more extensive rewrite than is - # necessary. For convenience, we've added a PortableUnixMailbox class - # which does no checking of the format of the 'From' line. - - _fromlinepattern = (r"From \s*[^\s]+\s+\w\w\w\s+\w\w\w\s+\d?\d\s+" - r"\d?\d:\d\d(:\d\d)?(\s+[^\s]+)?\s+\d\d\d\d\s*" - r"[^\s]*\s*" - "$") - _regexp = None - - def _strict_isrealfromline(self, line): - if not self._regexp: - import re - self._regexp = re.compile(self._fromlinepattern) - return self._regexp.match(line) - - def _portable_isrealfromline(self, line): - return True - - _isrealfromline = _strict_isrealfromline - - -class PortableUnixMailbox(UnixMailbox): - _isrealfromline = UnixMailbox._portable_isrealfromline - - -class MmdfMailbox(_Mailbox): - - def _search_start(self): - while 1: - line = self.fp.readline() - if not line: - raise EOFError - if line[:5] == '\001\001\001\001\n': - return - - def _search_end(self): - while 1: - pos = self.fp.tell() - line = self.fp.readline() - if not line: - return - if line == '\001\001\001\001\n': - self.fp.seek(pos) - return - - -class MHMailbox: - - def __init__(self, dirname, factory=rfc822.Message): - import re - pat = re.compile('^[1-9][0-9]*$') - self.dirname = dirname - # the three following lines could be combined into: - # list = map(long, filter(pat.match, os.listdir(self.dirname))) - list = os.listdir(self.dirname) - list = filter(pat.match, list) - list = map(long, list) - list.sort() - # This only works in Python 1.6 or later; - # before that str() added 'L': - self.boxes = map(str, list) - self.boxes.reverse() - self.factory = factory - - def __iter__(self): - return iter(self.next, None) - - def next(self): - if not self.boxes: - return None - fn = self.boxes.pop() - fp = open(os.path.join(self.dirname, fn)) - msg = self.factory(fp) - try: - msg._mh_msgno = fn - except (AttributeError, TypeError): - pass - return msg - - -class BabylMailbox(_Mailbox): - - def _search_start(self): - while 1: - line = self.fp.readline() - if not line: - raise EOFError - if line == '*** EOOH ***\n': - return - - def _search_end(self): - while 1: - pos = self.fp.tell() - line = self.fp.readline() - if not line: - return - if line == '\037\014\n' or line == '\037': - self.fp.seek(pos) - return - ## End: classes from the original module (for backward compatibility).