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