Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 1 | # A class that makes each part of a multipart message "feel" like an |
| 2 | # ordinary file, as long as you use fp.readline(). Allows recursive |
| 3 | # use, for nested multipart messages. Probably best used together |
| 4 | # with module mimetools. |
| 5 | # |
| 6 | # Suggested use: |
| 7 | # |
| 8 | # real_fp = open(...) |
Guido van Rossum | 7bc817d | 1993-12-17 15:25:27 +0000 | [diff] [blame] | 9 | # fp = MultiFile(real_fp) |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 10 | # |
| 11 | # "read some lines from fp" |
| 12 | # fp.push(separator) |
| 13 | # while 1: |
| 14 | # "read lines from fp until it returns an empty string" (A) |
| 15 | # if not fp.next(): break |
| 16 | # fp.pop() |
| 17 | # "read remaining lines from fp until it returns an empty string" |
| 18 | # |
| 19 | # The latter sequence may be used recursively at (A). |
| 20 | # It is also allowed to use multiple push()...pop() sequences. |
| 21 | # Note that if a nested multipart message is terminated by a separator |
| 22 | # for an outer message, this is not reported, even though it is really |
| 23 | # illegal input. |
Guido van Rossum | 4d40b0a | 1998-06-23 14:20:27 +0000 | [diff] [blame] | 24 | # |
| 25 | # If seekable is given as 0, the class code will not do the bookeeping |
| 26 | # it normally attempts in order to make seeks relative to the beginning of the |
| 27 | # current file part. This may be useful when using MultiFile with a non- |
| 28 | # seekable stream object. |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 29 | |
| 30 | import sys |
| 31 | import string |
| 32 | |
| 33 | err = sys.stderr.write |
| 34 | |
| 35 | Error = 'multifile.Error' |
| 36 | |
| 37 | class MultiFile: |
| 38 | # |
Guido van Rossum | 4d40b0a | 1998-06-23 14:20:27 +0000 | [diff] [blame] | 39 | seekable = 0 |
| 40 | def __init__(self, fp, seekable=1): |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 41 | self.fp = fp |
| 42 | self.stack = [] # Grows down |
| 43 | self.level = 0 |
| 44 | self.last = 0 |
Guido van Rossum | 4d40b0a | 1998-06-23 14:20:27 +0000 | [diff] [blame] | 45 | if seekable: |
| 46 | self.seekable = 1 |
| 47 | self.start = self.fp.tell() |
| 48 | self.posstack = [] # Grows down |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 49 | # |
| 50 | def tell(self): |
| 51 | if self.level > 0: |
| 52 | return self.lastpos |
| 53 | return self.fp.tell() - self.start |
| 54 | # |
Guido van Rossum | 69c70a2 | 1998-03-25 16:25:26 +0000 | [diff] [blame] | 55 | def seek(self, pos, whence=0): |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 56 | here = self.tell() |
| 57 | if whence: |
| 58 | if whence == 1: |
| 59 | pos = pos + here |
| 60 | elif whence == 2: |
| 61 | if self.level > 0: |
| 62 | pos = pos + self.lastpos |
| 63 | else: |
| 64 | raise Error, "can't use whence=2 yet" |
Guido van Rossum | 69c70a2 | 1998-03-25 16:25:26 +0000 | [diff] [blame] | 65 | if not 0 <= pos <= here or \ |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 66 | self.level > 0 and pos > self.lastpos: |
| 67 | raise Error, 'bad MultiFile.seek() call' |
| 68 | self.fp.seek(pos + self.start) |
| 69 | self.level = 0 |
| 70 | self.last = 0 |
| 71 | # |
| 72 | def readline(self): |
| 73 | if self.level > 0: return '' |
| 74 | line = self.fp.readline() |
| 75 | if not line: |
| 76 | self.level = len(self.stack) |
| 77 | self.last = (self.level > 0) |
| 78 | if self.last: |
| 79 | err('*** Sudden EOF in MultiFile.readline()\n') |
| 80 | return '' |
| 81 | if line[:2] <> '--': return line |
| 82 | n = len(line) |
| 83 | k = n |
| 84 | while k > 0 and line[k-1] in string.whitespace: k = k-1 |
| 85 | mark = line[2:k] |
| 86 | if mark[-2:] == '--': mark1 = mark[:-2] |
| 87 | else: mark1 = None |
| 88 | for i in range(len(self.stack)): |
| 89 | sep = self.stack[i] |
| 90 | if sep == mark: |
| 91 | self.last = 0 |
| 92 | break |
| 93 | elif mark1 <> None and sep == mark1: |
| 94 | self.last = 1 |
| 95 | break |
| 96 | else: |
| 97 | return line |
| 98 | # Get here after break out of loop |
Guido van Rossum | 4d40b0a | 1998-06-23 14:20:27 +0000 | [diff] [blame] | 99 | if self.seekable: |
| 100 | self.lastpos = self.tell() - len(line) |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 101 | self.level = i+1 |
| 102 | if self.level > 1: |
| 103 | err('*** Missing endmarker in MultiFile.readline()\n') |
| 104 | return '' |
| 105 | # |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 106 | def readlines(self): |
| 107 | list = [] |
| 108 | while 1: |
| 109 | line = self.readline() |
| 110 | if not line: break |
| 111 | list.append(line) |
| 112 | return list |
| 113 | # |
| 114 | def read(self): # Note: no size argument -- read until EOF only! |
| 115 | return string.joinfields(self.readlines(), '') |
| 116 | # |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 117 | def next(self): |
| 118 | while self.readline(): pass |
| 119 | if self.level > 1 or self.last: |
| 120 | return 0 |
| 121 | self.level = 0 |
| 122 | self.last = 0 |
Guido van Rossum | 4d40b0a | 1998-06-23 14:20:27 +0000 | [diff] [blame] | 123 | if self.seekable: |
| 124 | self.start = self.fp.tell() |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 125 | return 1 |
| 126 | # |
| 127 | def push(self, sep): |
| 128 | if self.level > 0: |
| 129 | raise Error, 'bad MultiFile.push() call' |
| 130 | self.stack.insert(0, sep) |
Guido van Rossum | 4d40b0a | 1998-06-23 14:20:27 +0000 | [diff] [blame] | 131 | if self.seekable: |
| 132 | self.posstack.insert(0, self.start) |
| 133 | self.start = self.fp.tell() |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 134 | # |
| 135 | def pop(self): |
| 136 | if self.stack == []: |
| 137 | raise Error, 'bad MultiFile.pop() call' |
| 138 | if self.level <= 1: |
| 139 | self.last = 0 |
| 140 | else: |
| 141 | abslastpos = self.lastpos + self.start |
| 142 | self.level = max(0, self.level - 1) |
| 143 | del self.stack[0] |
Guido van Rossum | 4d40b0a | 1998-06-23 14:20:27 +0000 | [diff] [blame] | 144 | if self.seekable: |
| 145 | self.start = self.posstack[0] |
| 146 | del self.posstack[0] |
| 147 | if self.level > 0: |
| 148 | self.lastpos = abslastpos - self.start |
Guido van Rossum | 741c81a | 1992-07-13 14:40:45 +0000 | [diff] [blame] | 149 | # |