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