PageRenderTime 48ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/python/lib/Lib/mhlib.py

http://github.com/JetBrains/intellij-community
Python | 1001 lines | 957 code | 4 blank | 40 comment | 0 complexity | e24ac85bdc29cd42f600dee25be0d58f MD5 | raw file
Possible License(s): BSD-3-Clause, Apache-2.0, MPL-2.0-no-copyleft-exception, MIT, EPL-1.0, AGPL-1.0
  1. """MH interface -- purely object-oriented (well, almost)
  2. Executive summary:
  3. import mhlib
  4. mh = mhlib.MH() # use default mailbox directory and profile
  5. mh = mhlib.MH(mailbox) # override mailbox location (default from profile)
  6. mh = mhlib.MH(mailbox, profile) # override mailbox and profile
  7. mh.error(format, ...) # print error message -- can be overridden
  8. s = mh.getprofile(key) # profile entry (None if not set)
  9. path = mh.getpath() # mailbox pathname
  10. name = mh.getcontext() # name of current folder
  11. mh.setcontext(name) # set name of current folder
  12. list = mh.listfolders() # names of top-level folders
  13. list = mh.listallfolders() # names of all folders, including subfolders
  14. list = mh.listsubfolders(name) # direct subfolders of given folder
  15. list = mh.listallsubfolders(name) # all subfolders of given folder
  16. mh.makefolder(name) # create new folder
  17. mh.deletefolder(name) # delete folder -- must have no subfolders
  18. f = mh.openfolder(name) # new open folder object
  19. f.error(format, ...) # same as mh.error(format, ...)
  20. path = f.getfullname() # folder's full pathname
  21. path = f.getsequencesfilename() # full pathname of folder's sequences file
  22. path = f.getmessagefilename(n) # full pathname of message n in folder
  23. list = f.listmessages() # list of messages in folder (as numbers)
  24. n = f.getcurrent() # get current message
  25. f.setcurrent(n) # set current message
  26. list = f.parsesequence(seq) # parse msgs syntax into list of messages
  27. n = f.getlast() # get last message (0 if no messagse)
  28. f.setlast(n) # set last message (internal use only)
  29. dict = f.getsequences() # dictionary of sequences in folder {name: list}
  30. f.putsequences(dict) # write sequences back to folder
  31. f.createmessage(n, fp) # add message from file f as number n
  32. f.removemessages(list) # remove messages in list from folder
  33. f.refilemessages(list, tofolder) # move messages in list to other folder
  34. f.movemessage(n, tofolder, ton) # move one message to a given destination
  35. f.copymessage(n, tofolder, ton) # copy one message to a given destination
  36. m = f.openmessage(n) # new open message object (costs a file descriptor)
  37. m is a derived class of mimetools.Message(rfc822.Message), with:
  38. s = m.getheadertext() # text of message's headers
  39. s = m.getheadertext(pred) # text of message's headers, filtered by pred
  40. s = m.getbodytext() # text of message's body, decoded
  41. s = m.getbodytext(0) # text of message's body, not decoded
  42. """
  43. # XXX To do, functionality:
  44. # - annotate messages
  45. # - send messages
  46. #
  47. # XXX To do, organization:
  48. # - move IntSet to separate file
  49. # - move most Message functionality to module mimetools
  50. # Customizable defaults
  51. MH_PROFILE = '~/.mh_profile'
  52. PATH = '~/Mail'
  53. MH_SEQUENCES = '.mh_sequences'
  54. FOLDER_PROTECT = 0700
  55. # Imported modules
  56. import os
  57. import sys
  58. import re
  59. import mimetools
  60. import multifile
  61. import shutil
  62. from bisect import bisect
  63. __all__ = ["MH","Error","Folder","Message"]
  64. # Exported constants
  65. class Error(Exception):
  66. pass
  67. class MH:
  68. """Class representing a particular collection of folders.
  69. Optional constructor arguments are the pathname for the directory
  70. containing the collection, and the MH profile to use.
  71. If either is omitted or empty a default is used; the default
  72. directory is taken from the MH profile if it is specified there."""
  73. def __init__(self, path = None, profile = None):
  74. """Constructor."""
  75. if profile is None: profile = MH_PROFILE
  76. self.profile = os.path.expanduser(profile)
  77. if path is None: path = self.getprofile('Path')
  78. if not path: path = PATH
  79. if not os.path.isabs(path) and path[0] != '~':
  80. path = os.path.join('~', path)
  81. path = os.path.expanduser(path)
  82. if not os.path.isdir(path): raise Error, 'MH() path not found'
  83. self.path = path
  84. def __repr__(self):
  85. """String representation."""
  86. return 'MH(%r, %r)' % (self.path, self.profile)
  87. def error(self, msg, *args):
  88. """Routine to print an error. May be overridden by a derived class."""
  89. sys.stderr.write('MH error: %s\n' % (msg % args))
  90. def getprofile(self, key):
  91. """Return a profile entry, None if not found."""
  92. return pickline(self.profile, key)
  93. def getpath(self):
  94. """Return the path (the name of the collection's directory)."""
  95. return self.path
  96. def getcontext(self):
  97. """Return the name of the current folder."""
  98. context = pickline(os.path.join(self.getpath(), 'context'),
  99. 'Current-Folder')
  100. if not context: context = 'inbox'
  101. return context
  102. def setcontext(self, context):
  103. """Set the name of the current folder."""
  104. fn = os.path.join(self.getpath(), 'context')
  105. f = open(fn, "w")
  106. f.write("Current-Folder: %s\n" % context)
  107. f.close()
  108. def listfolders(self):
  109. """Return the names of the top-level folders."""
  110. folders = []
  111. path = self.getpath()
  112. for name in os.listdir(path):
  113. fullname = os.path.join(path, name)
  114. if os.path.isdir(fullname):
  115. folders.append(name)
  116. folders.sort()
  117. return folders
  118. def listsubfolders(self, name):
  119. """Return the names of the subfolders in a given folder
  120. (prefixed with the given folder name)."""
  121. fullname = os.path.join(self.path, name)
  122. # Get the link count so we can avoid listing folders
  123. # that have no subfolders.
  124. nlinks = os.stat(fullname).st_nlink
  125. if nlinks <= 2:
  126. return []
  127. subfolders = []
  128. subnames = os.listdir(fullname)
  129. for subname in subnames:
  130. fullsubname = os.path.join(fullname, subname)
  131. if os.path.isdir(fullsubname):
  132. name_subname = os.path.join(name, subname)
  133. subfolders.append(name_subname)
  134. # Stop looking for subfolders when
  135. # we've seen them all
  136. nlinks = nlinks - 1
  137. if nlinks <= 2:
  138. break
  139. subfolders.sort()
  140. return subfolders
  141. def listallfolders(self):
  142. """Return the names of all folders and subfolders, recursively."""
  143. return self.listallsubfolders('')
  144. def listallsubfolders(self, name):
  145. """Return the names of subfolders in a given folder, recursively."""
  146. fullname = os.path.join(self.path, name)
  147. # Get the link count so we can avoid listing folders
  148. # that have no subfolders.
  149. nlinks = os.stat(fullname).st_nlink
  150. if nlinks <= 2:
  151. return []
  152. subfolders = []
  153. subnames = os.listdir(fullname)
  154. for subname in subnames:
  155. if subname[0] == ',' or isnumeric(subname): continue
  156. fullsubname = os.path.join(fullname, subname)
  157. if os.path.isdir(fullsubname):
  158. name_subname = os.path.join(name, subname)
  159. subfolders.append(name_subname)
  160. if not os.path.islink(fullsubname):
  161. subsubfolders = self.listallsubfolders(
  162. name_subname)
  163. subfolders = subfolders + subsubfolders
  164. # Stop looking for subfolders when
  165. # we've seen them all
  166. nlinks = nlinks - 1
  167. if nlinks <= 2:
  168. break
  169. subfolders.sort()
  170. return subfolders
  171. def openfolder(self, name):
  172. """Return a new Folder object for the named folder."""
  173. return Folder(self, name)
  174. def makefolder(self, name):
  175. """Create a new folder (or raise os.error if it cannot be created)."""
  176. protect = pickline(self.profile, 'Folder-Protect')
  177. if protect and isnumeric(protect):
  178. mode = int(protect, 8)
  179. else:
  180. mode = FOLDER_PROTECT
  181. os.mkdir(os.path.join(self.getpath(), name), mode)
  182. def deletefolder(self, name):
  183. """Delete a folder. This removes files in the folder but not
  184. subdirectories. Raise os.error if deleting the folder itself fails."""
  185. fullname = os.path.join(self.getpath(), name)
  186. for subname in os.listdir(fullname):
  187. fullsubname = os.path.join(fullname, subname)
  188. try:
  189. os.unlink(fullsubname)
  190. except os.error:
  191. self.error('%s not deleted, continuing...' %
  192. fullsubname)
  193. os.rmdir(fullname)
  194. numericprog = re.compile('^[1-9][0-9]*$')
  195. def isnumeric(str):
  196. return numericprog.match(str) is not None
  197. class Folder:
  198. """Class representing a particular folder."""
  199. def __init__(self, mh, name):
  200. """Constructor."""
  201. self.mh = mh
  202. self.name = name
  203. if not os.path.isdir(self.getfullname()):
  204. raise Error, 'no folder %s' % name
  205. def __repr__(self):
  206. """String representation."""
  207. return 'Folder(%r, %r)' % (self.mh, self.name)
  208. def error(self, *args):
  209. """Error message handler."""
  210. self.mh.error(*args)
  211. def getfullname(self):
  212. """Return the full pathname of the folder."""
  213. return os.path.join(self.mh.path, self.name)
  214. def getsequencesfilename(self):
  215. """Return the full pathname of the folder's sequences file."""
  216. return os.path.join(self.getfullname(), MH_SEQUENCES)
  217. def getmessagefilename(self, n):
  218. """Return the full pathname of a message in the folder."""
  219. return os.path.join(self.getfullname(), str(n))
  220. def listsubfolders(self):
  221. """Return list of direct subfolders."""
  222. return self.mh.listsubfolders(self.name)
  223. def listallsubfolders(self):
  224. """Return list of all subfolders."""
  225. return self.mh.listallsubfolders(self.name)
  226. def listmessages(self):
  227. """Return the list of messages currently present in the folder.
  228. As a side effect, set self.last to the last message (or 0)."""
  229. messages = []
  230. match = numericprog.match
  231. append = messages.append
  232. for name in os.listdir(self.getfullname()):
  233. if match(name):
  234. append(name)
  235. messages = map(int, messages)
  236. messages.sort()
  237. if messages:
  238. self.last = messages[-1]
  239. else:
  240. self.last = 0
  241. return messages
  242. def getsequences(self):
  243. """Return the set of sequences for the folder."""
  244. sequences = {}
  245. fullname = self.getsequencesfilename()
  246. try:
  247. f = open(fullname, 'r')
  248. except IOError:
  249. return sequences
  250. while 1:
  251. line = f.readline()
  252. if not line: break
  253. fields = line.split(':')
  254. if len(fields) != 2:
  255. self.error('bad sequence in %s: %s' %
  256. (fullname, line.strip()))
  257. key = fields[0].strip()
  258. value = IntSet(fields[1].strip(), ' ').tolist()
  259. sequences[key] = value
  260. return sequences
  261. def putsequences(self, sequences):
  262. """Write the set of sequences back to the folder."""
  263. fullname = self.getsequencesfilename()
  264. f = None
  265. for key, seq in sequences.iteritems():
  266. s = IntSet('', ' ')
  267. s.fromlist(seq)
  268. if not f: f = open(fullname, 'w')
  269. f.write('%s: %s\n' % (key, s.tostring()))
  270. if not f:
  271. try:
  272. os.unlink(fullname)
  273. except os.error:
  274. pass
  275. else:
  276. f.close()
  277. def getcurrent(self):
  278. """Return the current message. Raise Error when there is none."""
  279. seqs = self.getsequences()
  280. try:
  281. return max(seqs['cur'])
  282. except (ValueError, KeyError):
  283. raise Error, "no cur message"
  284. def setcurrent(self, n):
  285. """Set the current message."""
  286. updateline(self.getsequencesfilename(), 'cur', str(n), 0)
  287. def parsesequence(self, seq):
  288. """Parse an MH sequence specification into a message list.
  289. Attempt to mimic mh-sequence(5) as close as possible.
  290. Also attempt to mimic observed behavior regarding which
  291. conditions cause which error messages."""
  292. # XXX Still not complete (see mh-format(5)).
  293. # Missing are:
  294. # - 'prev', 'next' as count
  295. # - Sequence-Negation option
  296. all = self.listmessages()
  297. # Observed behavior: test for empty folder is done first
  298. if not all:
  299. raise Error, "no messages in %s" % self.name
  300. # Common case first: all is frequently the default
  301. if seq == 'all':
  302. return all
  303. # Test for X:Y before X-Y because 'seq:-n' matches both
  304. i = seq.find(':')
  305. if i >= 0:
  306. head, dir, tail = seq[:i], '', seq[i+1:]
  307. if tail[:1] in '-+':
  308. dir, tail = tail[:1], tail[1:]
  309. if not isnumeric(tail):
  310. raise Error, "bad message list %s" % seq
  311. try:
  312. count = int(tail)
  313. except (ValueError, OverflowError):
  314. # Can't use sys.maxint because of i+count below
  315. count = len(all)
  316. try:
  317. anchor = self._parseindex(head, all)
  318. except Error, msg:
  319. seqs = self.getsequences()
  320. if not head in seqs:
  321. if not msg:
  322. msg = "bad message list %s" % seq
  323. raise Error, msg, sys.exc_info()[2]
  324. msgs = seqs[head]
  325. if not msgs:
  326. raise Error, "sequence %s empty" % head
  327. if dir == '-':
  328. return msgs[-count:]
  329. else:
  330. return msgs[:count]
  331. else:
  332. if not dir:
  333. if head in ('prev', 'last'):
  334. dir = '-'
  335. if dir == '-':
  336. i = bisect(all, anchor)
  337. return all[max(0, i-count):i]
  338. else:
  339. i = bisect(all, anchor-1)
  340. return all[i:i+count]
  341. # Test for X-Y next
  342. i = seq.find('-')
  343. if i >= 0:
  344. begin = self._parseindex(seq[:i], all)
  345. end = self._parseindex(seq[i+1:], all)
  346. i = bisect(all, begin-1)
  347. j = bisect(all, end)
  348. r = all[i:j]
  349. if not r:
  350. raise Error, "bad message list %s" % seq
  351. return r
  352. # Neither X:Y nor X-Y; must be a number or a (pseudo-)sequence
  353. try:
  354. n = self._parseindex(seq, all)
  355. except Error, msg:
  356. seqs = self.getsequences()
  357. if not seq in seqs:
  358. if not msg:
  359. msg = "bad message list %s" % seq
  360. raise Error, msg
  361. return seqs[seq]
  362. else:
  363. if n not in all:
  364. if isnumeric(seq):
  365. raise Error, "message %d doesn't exist" % n
  366. else:
  367. raise Error, "no %s message" % seq
  368. else:
  369. return [n]
  370. def _parseindex(self, seq, all):
  371. """Internal: parse a message number (or cur, first, etc.)."""
  372. if isnumeric(seq):
  373. try:
  374. return int(seq)
  375. except (OverflowError, ValueError):
  376. return sys.maxint
  377. if seq in ('cur', '.'):
  378. return self.getcurrent()
  379. if seq == 'first':
  380. return all[0]
  381. if seq == 'last':
  382. return all[-1]
  383. if seq == 'next':
  384. n = self.getcurrent()
  385. i = bisect(all, n)
  386. try:
  387. return all[i]
  388. except IndexError:
  389. raise Error, "no next message"
  390. if seq == 'prev':
  391. n = self.getcurrent()
  392. i = bisect(all, n-1)
  393. if i == 0:
  394. raise Error, "no prev message"
  395. try:
  396. return all[i-1]
  397. except IndexError:
  398. raise Error, "no prev message"
  399. raise Error, None
  400. def openmessage(self, n):
  401. """Open a message -- returns a Message object."""
  402. return Message(self, n)
  403. def removemessages(self, list):
  404. """Remove one or more messages -- may raise os.error."""
  405. errors = []
  406. deleted = []
  407. for n in list:
  408. path = self.getmessagefilename(n)
  409. commapath = self.getmessagefilename(',' + str(n))
  410. try:
  411. os.unlink(commapath)
  412. except os.error:
  413. pass
  414. try:
  415. os.rename(path, commapath)
  416. except os.error, msg:
  417. errors.append(msg)
  418. else:
  419. deleted.append(n)
  420. if deleted:
  421. self.removefromallsequences(deleted)
  422. if errors:
  423. if len(errors) == 1:
  424. raise os.error, errors[0]
  425. else:
  426. raise os.error, ('multiple errors:', errors)
  427. def refilemessages(self, list, tofolder, keepsequences=0):
  428. """Refile one or more messages -- may raise os.error.
  429. 'tofolder' is an open folder object."""
  430. errors = []
  431. refiled = {}
  432. for n in list:
  433. ton = tofolder.getlast() + 1
  434. path = self.getmessagefilename(n)
  435. topath = tofolder.getmessagefilename(ton)
  436. try:
  437. os.rename(path, topath)
  438. except os.error:
  439. # Try copying
  440. try:
  441. shutil.copy2(path, topath)
  442. os.unlink(path)
  443. except (IOError, os.error), msg:
  444. errors.append(msg)
  445. try:
  446. os.unlink(topath)
  447. except os.error:
  448. pass
  449. continue
  450. tofolder.setlast(ton)
  451. refiled[n] = ton
  452. if refiled:
  453. if keepsequences:
  454. tofolder._copysequences(self, refiled.items())
  455. self.removefromallsequences(refiled.keys())
  456. if errors:
  457. if len(errors) == 1:
  458. raise os.error, errors[0]
  459. else:
  460. raise os.error, ('multiple errors:', errors)
  461. def _copysequences(self, fromfolder, refileditems):
  462. """Helper for refilemessages() to copy sequences."""
  463. fromsequences = fromfolder.getsequences()
  464. tosequences = self.getsequences()
  465. changed = 0
  466. for name, seq in fromsequences.items():
  467. try:
  468. toseq = tosequences[name]
  469. new = 0
  470. except KeyError:
  471. toseq = []
  472. new = 1
  473. for fromn, ton in refileditems:
  474. if fromn in seq:
  475. toseq.append(ton)
  476. changed = 1
  477. if new and toseq:
  478. tosequences[name] = toseq
  479. if changed:
  480. self.putsequences(tosequences)
  481. def movemessage(self, n, tofolder, ton):
  482. """Move one message over a specific destination message,
  483. which may or may not already exist."""
  484. path = self.getmessagefilename(n)
  485. # Open it to check that it exists
  486. f = open(path)
  487. f.close()
  488. del f
  489. topath = tofolder.getmessagefilename(ton)
  490. backuptopath = tofolder.getmessagefilename(',%d' % ton)
  491. try:
  492. os.rename(topath, backuptopath)
  493. except os.error:
  494. pass
  495. try:
  496. os.rename(path, topath)
  497. except os.error:
  498. # Try copying
  499. ok = 0
  500. try:
  501. tofolder.setlast(None)
  502. shutil.copy2(path, topath)
  503. ok = 1
  504. finally:
  505. if not ok:
  506. try:
  507. os.unlink(topath)
  508. except os.error:
  509. pass
  510. os.unlink(path)
  511. self.removefromallsequences([n])
  512. def copymessage(self, n, tofolder, ton):
  513. """Copy one message over a specific destination message,
  514. which may or may not already exist."""
  515. path = self.getmessagefilename(n)
  516. # Open it to check that it exists
  517. f = open(path)
  518. f.close()
  519. del f
  520. topath = tofolder.getmessagefilename(ton)
  521. backuptopath = tofolder.getmessagefilename(',%d' % ton)
  522. try:
  523. os.rename(topath, backuptopath)
  524. except os.error:
  525. pass
  526. ok = 0
  527. try:
  528. tofolder.setlast(None)
  529. shutil.copy2(path, topath)
  530. ok = 1
  531. finally:
  532. if not ok:
  533. try:
  534. os.unlink(topath)
  535. except os.error:
  536. pass
  537. def createmessage(self, n, txt):
  538. """Create a message, with text from the open file txt."""
  539. path = self.getmessagefilename(n)
  540. backuppath = self.getmessagefilename(',%d' % n)
  541. try:
  542. os.rename(path, backuppath)
  543. except os.error:
  544. pass
  545. ok = 0
  546. BUFSIZE = 16*1024
  547. try:
  548. f = open(path, "w")
  549. while 1:
  550. buf = txt.read(BUFSIZE)
  551. if not buf:
  552. break
  553. f.write(buf)
  554. f.close()
  555. ok = 1
  556. finally:
  557. if not ok:
  558. try:
  559. os.unlink(path)
  560. except os.error:
  561. pass
  562. def removefromallsequences(self, list):
  563. """Remove one or more messages from all sequences (including last)
  564. -- but not from 'cur'!!!"""
  565. if hasattr(self, 'last') and self.last in list:
  566. del self.last
  567. sequences = self.getsequences()
  568. changed = 0
  569. for name, seq in sequences.items():
  570. if name == 'cur':
  571. continue
  572. for n in list:
  573. if n in seq:
  574. seq.remove(n)
  575. changed = 1
  576. if not seq:
  577. del sequences[name]
  578. if changed:
  579. self.putsequences(sequences)
  580. def getlast(self):
  581. """Return the last message number."""
  582. if not hasattr(self, 'last'):
  583. self.listmessages() # Set self.last
  584. return self.last
  585. def setlast(self, last):
  586. """Set the last message number."""
  587. if last is None:
  588. if hasattr(self, 'last'):
  589. del self.last
  590. else:
  591. self.last = last
  592. class Message(mimetools.Message):
  593. def __init__(self, f, n, fp = None):
  594. """Constructor."""
  595. self.folder = f
  596. self.number = n
  597. if fp is None:
  598. path = f.getmessagefilename(n)
  599. fp = open(path, 'r')
  600. mimetools.Message.__init__(self, fp)
  601. def __repr__(self):
  602. """String representation."""
  603. return 'Message(%s, %s)' % (repr(self.folder), self.number)
  604. def getheadertext(self, pred = None):
  605. """Return the message's header text as a string. If an
  606. argument is specified, it is used as a filter predicate to
  607. decide which headers to return (its argument is the header
  608. name converted to lower case)."""
  609. if pred is None:
  610. return ''.join(self.headers)
  611. headers = []
  612. hit = 0
  613. for line in self.headers:
  614. if not line[0].isspace():
  615. i = line.find(':')
  616. if i > 0:
  617. hit = pred(line[:i].lower())
  618. if hit: headers.append(line)
  619. return ''.join(headers)
  620. def getbodytext(self, decode = 1):
  621. """Return the message's body text as string. This undoes a
  622. Content-Transfer-Encoding, but does not interpret other MIME
  623. features (e.g. multipart messages). To suppress decoding,
  624. pass 0 as an argument."""
  625. self.fp.seek(self.startofbody)
  626. encoding = self.getencoding()
  627. if not decode or encoding in ('', '7bit', '8bit', 'binary'):
  628. return self.fp.read()
  629. try:
  630. from cStringIO import StringIO
  631. except ImportError:
  632. from StringIO import StringIO
  633. output = StringIO()
  634. mimetools.decode(self.fp, output, encoding)
  635. return output.getvalue()
  636. def getbodyparts(self):
  637. """Only for multipart messages: return the message's body as a
  638. list of SubMessage objects. Each submessage object behaves
  639. (almost) as a Message object."""
  640. if self.getmaintype() != 'multipart':
  641. raise Error, 'Content-Type is not multipart/*'
  642. bdry = self.getparam('boundary')
  643. if not bdry:
  644. raise Error, 'multipart/* without boundary param'
  645. self.fp.seek(self.startofbody)
  646. mf = multifile.MultiFile(self.fp)
  647. mf.push(bdry)
  648. parts = []
  649. while mf.next():
  650. n = "%s.%r" % (self.number, 1 + len(parts))
  651. part = SubMessage(self.folder, n, mf)
  652. parts.append(part)
  653. mf.pop()
  654. return parts
  655. def getbody(self):
  656. """Return body, either a string or a list of messages."""
  657. if self.getmaintype() == 'multipart':
  658. return self.getbodyparts()
  659. else:
  660. return self.getbodytext()
  661. class SubMessage(Message):
  662. def __init__(self, f, n, fp):
  663. """Constructor."""
  664. Message.__init__(self, f, n, fp)
  665. if self.getmaintype() == 'multipart':
  666. self.body = Message.getbodyparts(self)
  667. else:
  668. self.body = Message.getbodytext(self)
  669. self.bodyencoded = Message.getbodytext(self, decode=0)
  670. # XXX If this is big, should remember file pointers
  671. def __repr__(self):
  672. """String representation."""
  673. f, n, fp = self.folder, self.number, self.fp
  674. return 'SubMessage(%s, %s, %s)' % (f, n, fp)
  675. def getbodytext(self, decode = 1):
  676. if not decode:
  677. return self.bodyencoded
  678. if type(self.body) == type(''):
  679. return self.body
  680. def getbodyparts(self):
  681. if type(self.body) == type([]):
  682. return self.body
  683. def getbody(self):
  684. return self.body
  685. class IntSet:
  686. """Class implementing sets of integers.
  687. This is an efficient representation for sets consisting of several
  688. continuous ranges, e.g. 1-100,200-400,402-1000 is represented
  689. internally as a list of three pairs: [(1,100), (200,400),
  690. (402,1000)]. The internal representation is always kept normalized.
  691. The constructor has up to three arguments:
  692. - the string used to initialize the set (default ''),
  693. - the separator between ranges (default ',')
  694. - the separator between begin and end of a range (default '-')
  695. The separators must be strings (not regexprs) and should be different.
  696. The tostring() function yields a string that can be passed to another
  697. IntSet constructor; __repr__() is a valid IntSet constructor itself.
  698. """
  699. # XXX The default begin/end separator means that negative numbers are
  700. # not supported very well.
  701. #
  702. # XXX There are currently no operations to remove set elements.
  703. def __init__(self, data = None, sep = ',', rng = '-'):
  704. self.pairs = []
  705. self.sep = sep
  706. self.rng = rng
  707. if data: self.fromstring(data)
  708. def reset(self):
  709. self.pairs = []
  710. def __cmp__(self, other):
  711. return cmp(self.pairs, other.pairs)
  712. def __hash__(self):
  713. return hash(self.pairs)
  714. def __repr__(self):
  715. return 'IntSet(%r, %r, %r)' % (self.tostring(), self.sep, self.rng)
  716. def normalize(self):
  717. self.pairs.sort()
  718. i = 1
  719. while i < len(self.pairs):
  720. alo, ahi = self.pairs[i-1]
  721. blo, bhi = self.pairs[i]
  722. if ahi >= blo-1:
  723. self.pairs[i-1:i+1] = [(alo, max(ahi, bhi))]
  724. else:
  725. i = i+1
  726. def tostring(self):
  727. s = ''
  728. for lo, hi in self.pairs:
  729. if lo == hi: t = repr(lo)
  730. else: t = repr(lo) + self.rng + repr(hi)
  731. if s: s = s + (self.sep + t)
  732. else: s = t
  733. return s
  734. def tolist(self):
  735. l = []
  736. for lo, hi in self.pairs:
  737. m = range(lo, hi+1)
  738. l = l + m
  739. return l
  740. def fromlist(self, list):
  741. for i in list:
  742. self.append(i)
  743. def clone(self):
  744. new = IntSet()
  745. new.pairs = self.pairs[:]
  746. return new
  747. def min(self):
  748. return self.pairs[0][0]
  749. def max(self):
  750. return self.pairs[-1][-1]
  751. def contains(self, x):
  752. for lo, hi in self.pairs:
  753. if lo <= x <= hi: return True
  754. return False
  755. def append(self, x):
  756. for i in range(len(self.pairs)):
  757. lo, hi = self.pairs[i]
  758. if x < lo: # Need to insert before
  759. if x+1 == lo:
  760. self.pairs[i] = (x, hi)
  761. else:
  762. self.pairs.insert(i, (x, x))
  763. if i > 0 and x-1 == self.pairs[i-1][1]:
  764. # Merge with previous
  765. self.pairs[i-1:i+1] = [
  766. (self.pairs[i-1][0],
  767. self.pairs[i][1])
  768. ]
  769. return
  770. if x <= hi: # Already in set
  771. return
  772. i = len(self.pairs) - 1
  773. if i >= 0:
  774. lo, hi = self.pairs[i]
  775. if x-1 == hi:
  776. self.pairs[i] = lo, x
  777. return
  778. self.pairs.append((x, x))
  779. def addpair(self, xlo, xhi):
  780. if xlo > xhi: return
  781. self.pairs.append((xlo, xhi))
  782. self.normalize()
  783. def fromstring(self, data):
  784. new = []
  785. for part in data.split(self.sep):
  786. list = []
  787. for subp in part.split(self.rng):
  788. s = subp.strip()
  789. list.append(int(s))
  790. if len(list) == 1:
  791. new.append((list[0], list[0]))
  792. elif len(list) == 2 and list[0] <= list[1]:
  793. new.append((list[0], list[1]))
  794. else:
  795. raise ValueError, 'bad data passed to IntSet'
  796. self.pairs = self.pairs + new
  797. self.normalize()
  798. # Subroutines to read/write entries in .mh_profile and .mh_sequences
  799. def pickline(file, key, casefold = 1):
  800. try:
  801. f = open(file, 'r')
  802. except IOError:
  803. return None
  804. pat = re.escape(key) + ':'
  805. prog = re.compile(pat, casefold and re.IGNORECASE)
  806. while 1:
  807. line = f.readline()
  808. if not line: break
  809. if prog.match(line):
  810. text = line[len(key)+1:]
  811. while 1:
  812. line = f.readline()
  813. if not line or not line[0].isspace():
  814. break
  815. text = text + line
  816. return text.strip()
  817. return None
  818. def updateline(file, key, value, casefold = 1):
  819. try:
  820. f = open(file, 'r')
  821. lines = f.readlines()
  822. f.close()
  823. except IOError:
  824. lines = []
  825. pat = re.escape(key) + ':(.*)\n'
  826. prog = re.compile(pat, casefold and re.IGNORECASE)
  827. if value is None:
  828. newline = None
  829. else:
  830. newline = '%s: %s\n' % (key, value)
  831. for i in range(len(lines)):
  832. line = lines[i]
  833. if prog.match(line):
  834. if newline is None:
  835. del lines[i]
  836. else:
  837. lines[i] = newline
  838. break
  839. else:
  840. if newline is not None:
  841. lines.append(newline)
  842. tempfile = file + "~"
  843. f = open(tempfile, 'w')
  844. for line in lines:
  845. f.write(line)
  846. f.close()
  847. os.rename(tempfile, file)
  848. # Test program
  849. def test():
  850. global mh, f
  851. os.system('rm -rf $HOME/Mail/@test')
  852. mh = MH()
  853. def do(s): print s; print eval(s)
  854. do('mh.listfolders()')
  855. do('mh.listallfolders()')
  856. testfolders = ['@test', '@test/test1', '@test/test2',
  857. '@test/test1/test11', '@test/test1/test12',
  858. '@test/test1/test11/test111']
  859. for t in testfolders: do('mh.makefolder(%r)' % (t,))
  860. do('mh.listsubfolders(\'@test\')')
  861. do('mh.listallsubfolders(\'@test\')')
  862. f = mh.openfolder('@test')
  863. do('f.listsubfolders()')
  864. do('f.listallsubfolders()')
  865. do('f.getsequences()')
  866. seqs = f.getsequences()
  867. seqs['foo'] = IntSet('1-10 12-20', ' ').tolist()
  868. print seqs
  869. f.putsequences(seqs)
  870. do('f.getsequences()')
  871. for t in reversed(testfolders): do('mh.deletefolder(%r)' % (t,))
  872. do('mh.getcontext()')
  873. context = mh.getcontext()
  874. f = mh.openfolder(context)
  875. do('f.getcurrent()')
  876. for seq in ('first', 'last', 'cur', '.', 'prev', 'next',
  877. 'first:3', 'last:3', 'cur:3', 'cur:-3',
  878. 'prev:3', 'next:3',
  879. '1:3', '1:-3', '100:3', '100:-3', '10000:3', '10000:-3',
  880. 'all'):
  881. try:
  882. do('f.parsesequence(%r)' % (seq,))
  883. except Error, msg:
  884. print "Error:", msg
  885. stuff = os.popen("pick %r 2>/dev/null" % (seq,)).read()
  886. list = map(int, stuff.split())
  887. print list, "<-- pick"
  888. do('f.listmessages()')
  889. if __name__ == '__main__':
  890. test()