Python code coverage for Lib/mhlib.py

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