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