blob: dd8e5e1dbaba9f4e7acd937729a4e7d82f8dcabf [file] [log] [blame]
Guido van Rossumf06ee5f1996-11-27 19:52:01 +00001#! /usr/bin/env python
Guido van Rossum62448671996-09-17 21:33:15 +00002
3"""Classes to handle Unix style, MMDF style, and MH style mailboxes."""
4
5
Guido van Rossumc7b68821994-04-28 09:53:33 +00006import rfc822
Jack Jansen97157791995-10-23 13:59:53 +00007import os
Guido van Rossumc7b68821994-04-28 09:53:33 +00008
9class _Mailbox:
Guido van Rossum8ca84201998-03-26 20:56:10 +000010
Guido van Rossumc7b68821994-04-28 09:53:33 +000011 def __init__(self, fp):
12 self.fp = fp
13 self.seekp = 0
14
Guido van Rossum44a4d591996-01-25 18:40:41 +000015 def seek(self, pos, whence=0):
16 if whence==1: # Relative to current position
17 self.pos = self.pos + pos
18 if whence==2: # Relative to file's end
19 self.pos = self.stop + pos
20 else: # Default - absolute position
21 self.pos = self.start + pos
Guido van Rossumc7b68821994-04-28 09:53:33 +000022
23 def next(self):
24 while 1:
25 self.fp.seek(self.seekp)
26 try:
27 self._search_start()
28 except EOFError:
29 self.seekp = self.fp.tell()
30 return None
31 start = self.fp.tell()
32 self._search_end()
33 self.seekp = stop = self.fp.tell()
34 if start <> stop:
35 break
36 return rfc822.Message(_Subfile(self.fp, start, stop))
37
38class _Subfile:
Guido van Rossum8ca84201998-03-26 20:56:10 +000039
Guido van Rossumc7b68821994-04-28 09:53:33 +000040 def __init__(self, fp, start, stop):
41 self.fp = fp
42 self.start = start
43 self.stop = stop
44 self.pos = self.start
45
Guido van Rossum2922c6d1994-05-06 14:28:19 +000046 def read(self, length = None):
Guido van Rossumc7b68821994-04-28 09:53:33 +000047 if self.pos >= self.stop:
48 return ''
Guido van Rossum2922c6d1994-05-06 14:28:19 +000049 if length is None:
Guido van Rossumc7b68821994-04-28 09:53:33 +000050 length = self.stop - self.pos
Guido van Rossumc7b68821994-04-28 09:53:33 +000051 self.fp.seek(self.pos)
52 self.pos = self.pos + length
53 return self.fp.read(length)
54
Guido van Rossum2922c6d1994-05-06 14:28:19 +000055 def readline(self, length = None):
Guido van Rossumc7b68821994-04-28 09:53:33 +000056 if self.pos >= self.stop:
57 return ''
Guido van Rossum2922c6d1994-05-06 14:28:19 +000058 if length is None:
Guido van Rossumc7b68821994-04-28 09:53:33 +000059 length = self.stop - self.pos
Guido van Rossumc7b68821994-04-28 09:53:33 +000060 self.fp.seek(self.pos)
61 data = self.fp.readline(length)
62 if len(data) < length:
63 length = len(data)
64 self.pos = self.pos + length
65 return data
66
67 def tell(self):
68 return self.pos - self.start
69
Jack Jansen97157791995-10-23 13:59:53 +000070 def seek(self, pos, whence=0):
Guido van Rossum8ca84201998-03-26 20:56:10 +000071 if whence == 0:
72 self.pos = self.start + pos
Jack Jansen97157791995-10-23 13:59:53 +000073 elif whence == 1:
Guido van Rossum8ca84201998-03-26 20:56:10 +000074 self.pos = self.pos + pos
Jack Jansen97157791995-10-23 13:59:53 +000075 elif whence == 2:
Guido van Rossum8ca84201998-03-26 20:56:10 +000076 self.pos = self.stop + pos
Guido van Rossumc7b68821994-04-28 09:53:33 +000077
78 def close(self):
79 pass
80
81class UnixMailbox(_Mailbox):
Guido van Rossum8ca84201998-03-26 20:56:10 +000082
Guido van Rossumc7b68821994-04-28 09:53:33 +000083 def _search_start(self):
84 while 1:
85 line = self.fp.readline()
86 if not line:
87 raise EOFError
Guido van Rossumfbe63de1998-04-03 16:04:05 +000088 if line[:5] == 'From ' and self._isrealfromline(line):
Guido van Rossumc7b68821994-04-28 09:53:33 +000089 return
90
91 def _search_end(self):
92 while 1:
93 pos = self.fp.tell()
94 line = self.fp.readline()
95 if not line:
96 return
Guido van Rossumfbe63de1998-04-03 16:04:05 +000097 if line[:5] == 'From ' and self._isrealfromline(line):
Guido van Rossumc7b68821994-04-28 09:53:33 +000098 self.fp.seek(pos)
99 return
100
Guido van Rossumfbe63de1998-04-03 16:04:05 +0000101 # An overridable mechanism to test for From-line-ness.
102 # You can either specify a different regular expression
103 # or define a whole new _isrealfromline() method.
104 # Note that this only gets called for lines starting with
105 # the 5 characters "From ".
106
107 _fromlinepattern = r"From \s*[^\s]+\s+\w\w\w\s+\w\w\w\s+\d?\d\s+" \
108 r"\d?\d:\d\d:\d\d(\s+[^\s]+)?\s+\d\d\d\d\s*$"
109 _regexp = None
110
111 def _isrealfromline(self, line):
112 if not self._regexp:
113 import re
114 self._regexp = re.compile(self._fromlinepattern)
115 return self._regexp.match(line)
116
Guido van Rossumc7b68821994-04-28 09:53:33 +0000117class MmdfMailbox(_Mailbox):
Guido van Rossum8ca84201998-03-26 20:56:10 +0000118
Guido van Rossumc7b68821994-04-28 09:53:33 +0000119 def _search_start(self):
120 while 1:
121 line = self.fp.readline()
122 if not line:
123 raise EOFError
124 if line[:5] == '\001\001\001\001\n':
125 return
126
127 def _search_end(self):
128 while 1:
129 pos = self.fp.tell()
130 line = self.fp.readline()
131 if not line:
132 return
133 if line == '\001\001\001\001\n':
134 self.fp.seek(pos)
135 return
136
Jack Jansen97157791995-10-23 13:59:53 +0000137class MHMailbox:
Jack Jansen97157791995-10-23 13:59:53 +0000138
Guido van Rossum8ca84201998-03-26 20:56:10 +0000139 def __init__(self, dirname):
140 import re
141 pat = re.compile('^[0-9][0-9]*$')
142 self.dirname = dirname
143 files = os.listdir(self.dirname)
144 self.boxes = []
145 for f in files:
146 if pat.match(f):
147 self.boxes.append(f)
148
149 def next(self):
150 if not self.boxes:
151 return None
152 fn = self.boxes[0]
153 del self.boxes[0]
154 fp = open(os.path.join(self.dirname, fn))
155 return rfc822.Message(fp)
Jack Jansen97157791995-10-23 13:59:53 +0000156
157
Guido van Rossumfdf58fe1997-05-15 14:33:09 +0000158class BabylMailbox(_Mailbox):
Guido van Rossumfdf58fe1997-05-15 14:33:09 +0000159
Guido van Rossum8ca84201998-03-26 20:56:10 +0000160 def _search_start(self):
161 while 1:
162 line = self.fp.readline()
163 if not line:
164 raise EOFError
165 if line == '*** EOOH ***\n':
166 return
167
168 def _search_end(self):
169 while 1:
170 pos = self.fp.tell()
171 line = self.fp.readline()
172 if not line:
173 return
174 if line == '\037\014\n':
175 self.fp.seek(pos)
176 return
Guido van Rossumfdf58fe1997-05-15 14:33:09 +0000177
178
Guido van Rossum62448671996-09-17 21:33:15 +0000179def _test():
Guido van Rossumc7b68821994-04-28 09:53:33 +0000180 import time
181 import sys
182 import string
Guido van Rossum62448671996-09-17 21:33:15 +0000183 import os
Jack Jansen97157791995-10-23 13:59:53 +0000184
Guido van Rossum62448671996-09-17 21:33:15 +0000185 args = sys.argv[1:]
186 if not args:
Guido van Rossum6dd87831997-05-08 23:11:52 +0000187 for key in 'MAIL', 'LOGNAME', 'USER':
188 if os.environ.has_key(key):
189 mbox = os.environ[key]
190 break
Guido van Rossum62448671996-09-17 21:33:15 +0000191 else:
Guido van Rossum6dd87831997-05-08 23:11:52 +0000192 print "$MAIL, $LOGNAME nor $USER set -- who are you?"
Guido van Rossum62448671996-09-17 21:33:15 +0000193 return
194 else:
195 mbox = args[0]
196 if mbox[:1] == '+':
197 mbox = os.environ['HOME'] + '/Mail/' + mbox[1:]
198 elif not '/' in mbox:
199 mbox = '/usr/mail/' + mbox
200 if os.path.isdir(mbox):
201 mb = MHMailbox(mbox)
202 else:
203 fp = open(mbox, 'r')
204 mb = UnixMailbox(fp)
Jack Jansen97157791995-10-23 13:59:53 +0000205
Guido van Rossumc7b68821994-04-28 09:53:33 +0000206 msgs = []
207 while 1:
208 msg = mb.next()
Guido van Rossumfbe63de1998-04-03 16:04:05 +0000209 if msg is None:
Guido van Rossumc7b68821994-04-28 09:53:33 +0000210 break
211 msgs.append(msg)
Guido van Rossum9694fca1997-10-22 21:00:49 +0000212 msg.fp = None
Guido van Rossum62448671996-09-17 21:33:15 +0000213 if len(args) > 1:
214 num = string.atoi(args[1])
Guido van Rossumc7b68821994-04-28 09:53:33 +0000215 print 'Message %d body:'%num
216 msg = msgs[num-1]
217 msg.rewindbody()
218 sys.stdout.write(msg.fp.read())
Guido van Rossum62448671996-09-17 21:33:15 +0000219 else:
220 print 'Mailbox',mbox,'has',len(msgs),'messages:'
221 for msg in msgs:
Guido van Rossumfbe63de1998-04-03 16:04:05 +0000222 f = msg.getheader('from') or ""
223 s = msg.getheader('subject') or ""
224 d = msg.getheader('date') or ""
Guido van Rossum62448671996-09-17 21:33:15 +0000225 print '%20.20s %18.18s %-30.30s'%(f, d[5:], s)
226
227
228if __name__ == '__main__':
229 _test()