Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 1 | """Macintosh binhex compression/decompression. |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 2 | |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 3 | easy interface: |
| 4 | binhex(inputfilename, outputfilename) |
| 5 | hexbin(inputfilename, outputfilename) |
| 6 | """ |
| 7 | |
| 8 | # |
| 9 | # Jack Jansen, CWI, August 1995. |
| 10 | # |
| 11 | # The module is supposed to be as compatible as possible. Especially the |
| 12 | # easy interface should work "as expected" on any platform. |
| 13 | # XXXX Note: currently, textfiles appear in mac-form on all platforms. |
| 14 | # We seem to lack a simple character-translate in python. |
| 15 | # (we should probably use ISO-Latin-1 on all but the mac platform). |
Jeremy Hylton | a05e293 | 2000-06-28 14:48:01 +0000 | [diff] [blame] | 16 | # XXXX The simple routines are too simple: they expect to hold the complete |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 17 | # files in-core. Should be fixed. |
Roger E. Masse | 469848a | 1997-01-16 16:51:57 +0000 | [diff] [blame] | 18 | # XXXX It would be nice to handle AppleDouble format on unix |
| 19 | # (for servers serving macs). |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 20 | # XXXX I don't understand what happens when you get 0x90 times the same byte on |
| 21 | # input. The resulting code (xx 90 90) would appear to be interpreted as an |
| 22 | # escaped *value* of 0x90. All coders I've seen appear to ignore this nicety... |
| 23 | # |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 24 | import binascii |
| 25 | import contextlib |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 26 | import io |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 27 | import os |
| 28 | import struct |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 29 | import warnings |
| 30 | |
| 31 | warnings.warn('the binhex module is deprecated', DeprecationWarning, |
| 32 | stacklevel=2) |
| 33 | |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 34 | |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 35 | __all__ = ["binhex","hexbin","Error"] |
| 36 | |
Fred Drake | 227b120 | 2000-08-17 05:06:49 +0000 | [diff] [blame] | 37 | class Error(Exception): |
| 38 | pass |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 39 | |
| 40 | # States (what have we written) |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 41 | _DID_HEADER = 0 |
| 42 | _DID_DATA = 1 |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 43 | |
| 44 | # Various constants |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 45 | REASONABLY_LARGE = 32768 # Minimal amount we pass the rle-coder |
| 46 | LINELEN = 64 |
Jeremy Hylton | da3f228 | 2007-08-29 17:26:34 +0000 | [diff] [blame] | 47 | RUNCHAR = b"\x90" |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 48 | |
| 49 | # |
Roger E. Masse | 469848a | 1997-01-16 16:51:57 +0000 | [diff] [blame] | 50 | # This code is no longer byte-order dependent |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 51 | |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 52 | |
Benjamin Peterson | 69a07fb | 2008-05-12 22:25:16 +0000 | [diff] [blame] | 53 | class FInfo: |
| 54 | def __init__(self): |
| 55 | self.Type = '????' |
| 56 | self.Creator = '????' |
| 57 | self.Flags = 0 |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 58 | |
Benjamin Peterson | 69a07fb | 2008-05-12 22:25:16 +0000 | [diff] [blame] | 59 | def getfileinfo(name): |
| 60 | finfo = FInfo() |
Nick Coghlan | b3c728f | 2011-03-16 21:26:40 -0400 | [diff] [blame] | 61 | with io.open(name, 'rb') as fp: |
| 62 | # Quick check for textfile |
| 63 | data = fp.read(512) |
| 64 | if 0 not in data: |
| 65 | finfo.Type = 'TEXT' |
| 66 | fp.seek(0, 2) |
| 67 | dsize = fp.tell() |
Benjamin Peterson | 69a07fb | 2008-05-12 22:25:16 +0000 | [diff] [blame] | 68 | dir, file = os.path.split(name) |
| 69 | file = file.replace(':', '-', 1) |
| 70 | return file, finfo, dsize, 0 |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 71 | |
Benjamin Peterson | 69a07fb | 2008-05-12 22:25:16 +0000 | [diff] [blame] | 72 | class openrsrc: |
| 73 | def __init__(self, *args): |
| 74 | pass |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 75 | |
Benjamin Peterson | 69a07fb | 2008-05-12 22:25:16 +0000 | [diff] [blame] | 76 | def read(self, *args): |
| 77 | return b'' |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 78 | |
Benjamin Peterson | 69a07fb | 2008-05-12 22:25:16 +0000 | [diff] [blame] | 79 | def write(self, *args): |
| 80 | pass |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 81 | |
Benjamin Peterson | 69a07fb | 2008-05-12 22:25:16 +0000 | [diff] [blame] | 82 | def close(self): |
| 83 | pass |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 84 | |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 85 | |
| 86 | # DeprecationWarning is already emitted on "import binhex". There is no need |
| 87 | # to repeat the warning at each call to deprecated binascii functions. |
| 88 | @contextlib.contextmanager |
| 89 | def _ignore_deprecation_warning(): |
| 90 | with warnings.catch_warnings(): |
| 91 | warnings.filterwarnings('ignore', '', DeprecationWarning) |
| 92 | yield |
| 93 | |
| 94 | |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 95 | class _Hqxcoderengine: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 96 | """Write data to the coder in 3-byte chunks""" |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 97 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 98 | def __init__(self, ofp): |
| 99 | self.ofp = ofp |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 100 | self.data = b'' |
| 101 | self.hqxdata = b'' |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 102 | self.linelen = LINELEN - 1 |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 103 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 104 | def write(self, data): |
| 105 | self.data = self.data + data |
| 106 | datalen = len(self.data) |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 107 | todo = (datalen // 3) * 3 |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 108 | data = self.data[:todo] |
| 109 | self.data = self.data[todo:] |
| 110 | if not data: |
| 111 | return |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 112 | with _ignore_deprecation_warning(): |
| 113 | self.hqxdata = self.hqxdata + binascii.b2a_hqx(data) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 114 | self._flush(0) |
Guido van Rossum | cce074e | 1996-03-25 18:54:33 +0000 | [diff] [blame] | 115 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 116 | def _flush(self, force): |
| 117 | first = 0 |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 118 | while first <= len(self.hqxdata) - self.linelen: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 119 | last = first + self.linelen |
Ronald Oussoren | 2165cea | 2020-11-01 10:08:48 +0100 | [diff] [blame] | 120 | self.ofp.write(self.hqxdata[first:last] + b'\r') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 121 | self.linelen = LINELEN |
| 122 | first = last |
| 123 | self.hqxdata = self.hqxdata[first:] |
| 124 | if force: |
Ronald Oussoren | 2165cea | 2020-11-01 10:08:48 +0100 | [diff] [blame] | 125 | self.ofp.write(self.hqxdata + b':\r') |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 126 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 127 | def close(self): |
| 128 | if self.data: |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 129 | with _ignore_deprecation_warning(): |
| 130 | self.hqxdata = self.hqxdata + binascii.b2a_hqx(self.data) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 131 | self._flush(1) |
| 132 | self.ofp.close() |
| 133 | del self.ofp |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 134 | |
| 135 | class _Rlecoderengine: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 136 | """Write data to the RLE-coder in suitably large chunks""" |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 137 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 138 | def __init__(self, ofp): |
| 139 | self.ofp = ofp |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 140 | self.data = b'' |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 141 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 142 | def write(self, data): |
| 143 | self.data = self.data + data |
| 144 | if len(self.data) < REASONABLY_LARGE: |
| 145 | return |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 146 | with _ignore_deprecation_warning(): |
| 147 | rledata = binascii.rlecode_hqx(self.data) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 148 | self.ofp.write(rledata) |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 149 | self.data = b'' |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 150 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 151 | def close(self): |
| 152 | if self.data: |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 153 | with _ignore_deprecation_warning(): |
| 154 | rledata = binascii.rlecode_hqx(self.data) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 155 | self.ofp.write(rledata) |
| 156 | self.ofp.close() |
| 157 | del self.ofp |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 158 | |
| 159 | class BinHex: |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 160 | def __init__(self, name_finfo_dlen_rlen, ofp): |
| 161 | name, finfo, dlen, rlen = name_finfo_dlen_rlen |
Nick Coghlan | b3c728f | 2011-03-16 21:26:40 -0400 | [diff] [blame] | 162 | close_on_error = False |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 163 | if isinstance(ofp, str): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 164 | ofname = ofp |
Guido van Rossum | 34a042d | 2007-05-24 22:05:19 +0000 | [diff] [blame] | 165 | ofp = io.open(ofname, 'wb') |
Nick Coghlan | b3c728f | 2011-03-16 21:26:40 -0400 | [diff] [blame] | 166 | close_on_error = True |
| 167 | try: |
| 168 | ofp.write(b'(This file must be converted with BinHex 4.0)\r\r:') |
| 169 | hqxer = _Hqxcoderengine(ofp) |
| 170 | self.ofp = _Rlecoderengine(hqxer) |
| 171 | self.crc = 0 |
| 172 | if finfo is None: |
| 173 | finfo = FInfo() |
| 174 | self.dlen = dlen |
| 175 | self.rlen = rlen |
| 176 | self._writeinfo(name, finfo) |
| 177 | self.state = _DID_HEADER |
| 178 | except: |
| 179 | if close_on_error: |
| 180 | ofp.close() |
| 181 | raise |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 182 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 183 | def _writeinfo(self, name, finfo): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 184 | nl = len(name) |
| 185 | if nl > 63: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 186 | raise Error('Filename too long') |
Guido van Rossum | 09549f4 | 2007-08-27 20:40:10 +0000 | [diff] [blame] | 187 | d = bytes([nl]) + name.encode("latin-1") + b'\0' |
Guido van Rossum | 1b261df | 2007-08-28 03:35:35 +0000 | [diff] [blame] | 188 | tp, cr = finfo.Type, finfo.Creator |
| 189 | if isinstance(tp, str): |
| 190 | tp = tp.encode("latin-1") |
| 191 | if isinstance(cr, str): |
| 192 | cr = cr.encode("latin-1") |
| 193 | d2 = tp + cr |
Roger E. Masse | 469848a | 1997-01-16 16:51:57 +0000 | [diff] [blame] | 194 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 195 | # Force all structs to be packed with big-endian |
| 196 | d3 = struct.pack('>h', finfo.Flags) |
| 197 | d4 = struct.pack('>ii', self.dlen, self.rlen) |
| 198 | info = d + d2 + d3 + d4 |
| 199 | self._write(info) |
| 200 | self._writecrc() |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 201 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 202 | def _write(self, data): |
Victor Stinner | c38fd0d | 2020-01-30 09:56:40 +0100 | [diff] [blame] | 203 | self.crc = binascii.crc_hqx(data, self.crc) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 204 | self.ofp.write(data) |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 205 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 206 | def _writecrc(self): |
| 207 | # XXXX Should this be here?? |
| 208 | # self.crc = binascii.crc_hqx('\0\0', self.crc) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 209 | if self.crc < 0: |
| 210 | fmt = '>h' |
| 211 | else: |
| 212 | fmt = '>H' |
| 213 | self.ofp.write(struct.pack(fmt, self.crc)) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 214 | self.crc = 0 |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 215 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 216 | def write(self, data): |
| 217 | if self.state != _DID_HEADER: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 218 | raise Error('Writing data at the wrong time') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 219 | self.dlen = self.dlen - len(data) |
| 220 | self._write(data) |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 221 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 222 | def close_data(self): |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 223 | if self.dlen != 0: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 224 | raise Error('Incorrect data size, diff=%r' % (self.rlen,)) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 225 | self._writecrc() |
| 226 | self.state = _DID_DATA |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 227 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 228 | def write_rsrc(self, data): |
| 229 | if self.state < _DID_DATA: |
| 230 | self.close_data() |
| 231 | if self.state != _DID_DATA: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 232 | raise Error('Writing resource data at the wrong time') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 233 | self.rlen = self.rlen - len(data) |
| 234 | self._write(data) |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 235 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 236 | def close(self): |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 237 | if self.state is None: |
| 238 | return |
| 239 | try: |
| 240 | if self.state < _DID_DATA: |
| 241 | self.close_data() |
| 242 | if self.state != _DID_DATA: |
| 243 | raise Error('Close at the wrong time') |
| 244 | if self.rlen != 0: |
| 245 | raise Error("Incorrect resource-datasize, diff=%r" % (self.rlen,)) |
| 246 | self._writecrc() |
| 247 | finally: |
| 248 | self.state = None |
| 249 | ofp = self.ofp |
| 250 | del self.ofp |
| 251 | ofp.close() |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 252 | |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 253 | def binhex(inp, out): |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 254 | """binhex(infilename, outfilename): create binhex-encoded copy of a file""" |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 255 | finfo = getfileinfo(inp) |
| 256 | ofp = BinHex(finfo, out) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 257 | |
Serhiy Storchaka | 46ba6c8 | 2015-04-04 11:01:02 +0300 | [diff] [blame] | 258 | with io.open(inp, 'rb') as ifp: |
| 259 | # XXXX Do textfile translation on non-mac systems |
| 260 | while True: |
| 261 | d = ifp.read(128000) |
| 262 | if not d: break |
| 263 | ofp.write(d) |
| 264 | ofp.close_data() |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 265 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 266 | ifp = openrsrc(inp, 'rb') |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 267 | while True: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 268 | d = ifp.read(128000) |
| 269 | if not d: break |
| 270 | ofp.write_rsrc(d) |
| 271 | ofp.close() |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 272 | ifp.close() |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 273 | |
| 274 | class _Hqxdecoderengine: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 275 | """Read data via the decoder in 4-byte chunks""" |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 276 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 277 | def __init__(self, ifp): |
| 278 | self.ifp = ifp |
| 279 | self.eof = 0 |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 280 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 281 | def read(self, totalwtd): |
| 282 | """Read at least wtd bytes (or until EOF)""" |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 283 | decdata = b'' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 284 | wtd = totalwtd |
| 285 | # |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 286 | # The loop here is convoluted, since we don't really now how |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 287 | # much to decode: there may be newlines in the incoming data. |
| 288 | while wtd > 0: |
| 289 | if self.eof: return decdata |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 290 | wtd = ((wtd + 2) // 3) * 4 |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 291 | data = self.ifp.read(wtd) |
| 292 | # |
| 293 | # Next problem: there may not be a complete number of |
| 294 | # bytes in what we pass to a2b. Solve by yet another |
| 295 | # loop. |
| 296 | # |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 297 | while True: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 298 | try: |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 299 | with _ignore_deprecation_warning(): |
| 300 | decdatacur, self.eof = binascii.a2b_hqx(data) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 301 | break |
| 302 | except binascii.Incomplete: |
| 303 | pass |
| 304 | newdata = self.ifp.read(1) |
| 305 | if not newdata: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 306 | raise Error('Premature EOF on binhex file') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 307 | data = data + newdata |
| 308 | decdata = decdata + decdatacur |
| 309 | wtd = totalwtd - len(decdata) |
| 310 | if not decdata and not self.eof: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 311 | raise Error('Premature EOF on binhex file') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 312 | return decdata |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 313 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 314 | def close(self): |
| 315 | self.ifp.close() |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 316 | |
| 317 | class _Rledecoderengine: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 318 | """Read data via the RLE-coder""" |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 319 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 320 | def __init__(self, ifp): |
| 321 | self.ifp = ifp |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 322 | self.pre_buffer = b'' |
| 323 | self.post_buffer = b'' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 324 | self.eof = 0 |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 325 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 326 | def read(self, wtd): |
| 327 | if wtd > len(self.post_buffer): |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 328 | self._fill(wtd - len(self.post_buffer)) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 329 | rv = self.post_buffer[:wtd] |
| 330 | self.post_buffer = self.post_buffer[wtd:] |
| 331 | return rv |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 332 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 333 | def _fill(self, wtd): |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 334 | self.pre_buffer = self.pre_buffer + self.ifp.read(wtd + 4) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 335 | if self.ifp.eof: |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 336 | with _ignore_deprecation_warning(): |
| 337 | self.post_buffer = self.post_buffer + \ |
| 338 | binascii.rledecode_hqx(self.pre_buffer) |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 339 | self.pre_buffer = b'' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 340 | return |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 341 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 342 | # |
| 343 | # Obfuscated code ahead. We have to take care that we don't |
| 344 | # end up with an orphaned RUNCHAR later on. So, we keep a couple |
| 345 | # of bytes in the buffer, depending on what the end of |
| 346 | # the buffer looks like: |
| 347 | # '\220\0\220' - Keep 3 bytes: repeated \220 (escaped as \220\0) |
| 348 | # '?\220' - Keep 2 bytes: repeated something-else |
| 349 | # '\220\0' - Escaped \220: Keep 2 bytes. |
| 350 | # '?\220?' - Complete repeat sequence: decode all |
| 351 | # otherwise: keep 1 byte. |
| 352 | # |
| 353 | mark = len(self.pre_buffer) |
Jeremy Hylton | da3f228 | 2007-08-29 17:26:34 +0000 | [diff] [blame] | 354 | if self.pre_buffer[-3:] == RUNCHAR + b'\0' + RUNCHAR: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 355 | mark = mark - 3 |
Antoine Pitrou | 5492395 | 2009-07-01 14:53:06 +0000 | [diff] [blame] | 356 | elif self.pre_buffer[-1:] == RUNCHAR: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 357 | mark = mark - 2 |
Jeremy Hylton | da3f228 | 2007-08-29 17:26:34 +0000 | [diff] [blame] | 358 | elif self.pre_buffer[-2:] == RUNCHAR + b'\0': |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 359 | mark = mark - 2 |
Antoine Pitrou | 5492395 | 2009-07-01 14:53:06 +0000 | [diff] [blame] | 360 | elif self.pre_buffer[-2:-1] == RUNCHAR: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 361 | pass # Decode all |
| 362 | else: |
| 363 | mark = mark - 1 |
Guido van Rossum | 50b82e8 | 1997-02-11 16:39:31 +0000 | [diff] [blame] | 364 | |
Victor Stinner | beea26b | 2020-01-22 20:44:22 +0100 | [diff] [blame] | 365 | with _ignore_deprecation_warning(): |
| 366 | self.post_buffer = self.post_buffer + \ |
| 367 | binascii.rledecode_hqx(self.pre_buffer[:mark]) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 368 | self.pre_buffer = self.pre_buffer[mark:] |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 369 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 370 | def close(self): |
| 371 | self.ifp.close() |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 372 | |
| 373 | class HexBin: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 374 | def __init__(self, ifp): |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 375 | if isinstance(ifp, str): |
Guido van Rossum | 34a042d | 2007-05-24 22:05:19 +0000 | [diff] [blame] | 376 | ifp = io.open(ifp, 'rb') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 377 | # |
| 378 | # Find initial colon. |
| 379 | # |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 380 | while True: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 381 | ch = ifp.read(1) |
| 382 | if not ch: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 383 | raise Error("No binhex data found") |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 384 | # Cater for \r\n terminated lines (which show up as \n\r, hence |
| 385 | # all lines start with \r) |
Guido van Rossum | 34a042d | 2007-05-24 22:05:19 +0000 | [diff] [blame] | 386 | if ch == b'\r': |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 387 | continue |
Guido van Rossum | 34a042d | 2007-05-24 22:05:19 +0000 | [diff] [blame] | 388 | if ch == b':': |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 389 | break |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 390 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 391 | hqxifp = _Hqxdecoderengine(ifp) |
| 392 | self.ifp = _Rledecoderengine(hqxifp) |
| 393 | self.crc = 0 |
| 394 | self._readheader() |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 395 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 396 | def _read(self, len): |
| 397 | data = self.ifp.read(len) |
Victor Stinner | c38fd0d | 2020-01-30 09:56:40 +0100 | [diff] [blame] | 398 | self.crc = binascii.crc_hqx(data, self.crc) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 399 | return data |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 400 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 401 | def _checkcrc(self): |
| 402 | filecrc = struct.unpack('>h', self.ifp.read(2))[0] & 0xffff |
| 403 | #self.crc = binascii.crc_hqx('\0\0', self.crc) |
| 404 | # XXXX Is this needed?? |
| 405 | self.crc = self.crc & 0xffff |
| 406 | if filecrc != self.crc: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 407 | raise Error('CRC error, computed %x, read %x' |
| 408 | % (self.crc, filecrc)) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 409 | self.crc = 0 |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 410 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 411 | def _readheader(self): |
| 412 | len = self._read(1) |
| 413 | fname = self._read(ord(len)) |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 414 | rest = self._read(1 + 4 + 4 + 2 + 4 + 4) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 415 | self._checkcrc() |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 416 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 417 | type = rest[1:5] |
| 418 | creator = rest[5:9] |
| 419 | flags = struct.unpack('>h', rest[9:11])[0] |
| 420 | self.dlen = struct.unpack('>l', rest[11:15])[0] |
| 421 | self.rlen = struct.unpack('>l', rest[15:19])[0] |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 422 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 423 | self.FName = fname |
| 424 | self.FInfo = FInfo() |
Neal Norwitz | 6ea45d3 | 2007-08-26 04:19:43 +0000 | [diff] [blame] | 425 | self.FInfo.Creator = creator |
| 426 | self.FInfo.Type = type |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 427 | self.FInfo.Flags = flags |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 428 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 429 | self.state = _DID_HEADER |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 430 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 431 | def read(self, *n): |
| 432 | if self.state != _DID_HEADER: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 433 | raise Error('Read data at wrong time') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 434 | if n: |
| 435 | n = n[0] |
| 436 | n = min(n, self.dlen) |
| 437 | else: |
| 438 | n = self.dlen |
Guido van Rossum | dcee3c0 | 2007-05-22 22:25:42 +0000 | [diff] [blame] | 439 | rv = b'' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 440 | while len(rv) < n: |
| 441 | rv = rv + self._read(n-len(rv)) |
| 442 | self.dlen = self.dlen - n |
| 443 | return rv |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 444 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 445 | def close_data(self): |
| 446 | if self.state != _DID_HEADER: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 447 | raise Error('close_data at wrong time') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 448 | if self.dlen: |
| 449 | dummy = self._read(self.dlen) |
| 450 | self._checkcrc() |
| 451 | self.state = _DID_DATA |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 452 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 453 | def read_rsrc(self, *n): |
| 454 | if self.state == _DID_HEADER: |
| 455 | self.close_data() |
| 456 | if self.state != _DID_DATA: |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 457 | raise Error('Read resource data at wrong time') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 458 | if n: |
| 459 | n = n[0] |
| 460 | n = min(n, self.rlen) |
| 461 | else: |
| 462 | n = self.rlen |
| 463 | self.rlen = self.rlen - n |
| 464 | return self._read(n) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 465 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 466 | def close(self): |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 467 | if self.state is None: |
| 468 | return |
| 469 | try: |
| 470 | if self.rlen: |
| 471 | dummy = self.read_rsrc(self.rlen) |
| 472 | self._checkcrc() |
| 473 | finally: |
| 474 | self.state = None |
| 475 | self.ifp.close() |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 476 | |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 477 | def hexbin(inp, out): |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 478 | """hexbin(infilename, outfilename) - Decode binhexed file""" |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 479 | ifp = HexBin(inp) |
| 480 | finfo = ifp.FInfo |
| 481 | if not out: |
| 482 | out = ifp.FName |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 483 | |
Serhiy Storchaka | 46ba6c8 | 2015-04-04 11:01:02 +0300 | [diff] [blame] | 484 | with io.open(out, 'wb') as ofp: |
| 485 | # XXXX Do translation on non-mac systems |
| 486 | while True: |
| 487 | d = ifp.read(128000) |
| 488 | if not d: break |
| 489 | ofp.write(d) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 490 | ifp.close_data() |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 491 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 492 | d = ifp.read_rsrc(128000) |
| 493 | if d: |
| 494 | ofp = openrsrc(out, 'wb') |
| 495 | ofp.write(d) |
Collin Winter | 115cde3 | 2007-08-28 06:06:33 +0000 | [diff] [blame] | 496 | while True: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 497 | d = ifp.read_rsrc(128000) |
| 498 | if not d: break |
| 499 | ofp.write(d) |
| 500 | ofp.close() |
Jack Jansen | fcdffea | 1995-08-07 14:36:51 +0000 | [diff] [blame] | 501 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 502 | ifp.close() |