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