blob: c3238a0685017d2e04326c9f3d8ae4f79f071d80 [file] [log] [blame]
Guido van Rossumfb221561997-04-29 15:38:09 +00001/* zlibmodule.c -- gzip-compatible data compression */
Martin v. Löwis1dbce442001-10-09 10:54:31 +00002/* See http://www.gzip.org/zlib/ */
Mark Hammondae8c2682001-01-31 10:28:03 +00003
Tim Petersee826f82001-01-31 19:39:44 +00004/* Windows users: read Python's PCbuild\readme.txt */
Mark Hammondae8c2682001-01-31 10:28:03 +00005
Guido van Rossumfb221561997-04-29 15:38:09 +00006
Guido van Rossum97b54571997-06-03 22:21:47 +00007#include "Python.h"
8#include "zlib.h"
Guido van Rossumfb221561997-04-29 15:38:09 +00009
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +000010#ifdef WITH_THREAD
11#include "pythread.h"
12
13/* #defs ripped off from _tkinter.c, even though the situation here is much
14 simpler, because we don't have to worry about waiting for Tcl
15 events! And, since zlib itself is threadsafe, we don't need to worry
16 about re-entering zlib functions.
17
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +000018 N.B.
19
20 Since ENTER_ZLIB and LEAVE_ZLIB only need to be called on functions
21 that modify the components of preexisting de/compress objects, it
22 could prove to be a performance gain on multiprocessor machines if
23 there was an de/compress object-specific lock. However, for the
24 moment the ENTER_ZLIB and LEAVE_ZLIB calls are global for ALL
25 de/compress objects.
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +000026 */
27
28static PyThread_type_lock zlib_lock = NULL; /* initialized on module load */
29
30#define ENTER_ZLIB \
Tim Peters6605c642001-10-17 03:43:54 +000031 Py_BEGIN_ALLOW_THREADS \
32 PyThread_acquire_lock(zlib_lock, 1); \
33 Py_END_ALLOW_THREADS
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +000034
35#define LEAVE_ZLIB \
Tim Peters6605c642001-10-17 03:43:54 +000036 PyThread_release_lock(zlib_lock);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +000037
38#else
39
40#define ENTER_ZLIB
41#define LEAVE_ZLIB
42
43#endif
44
Guido van Rossumfb221561997-04-29 15:38:09 +000045/* The following parameters are copied from zutil.h, version 0.95 */
46#define DEFLATED 8
47#if MAX_MEM_LEVEL >= 8
48# define DEF_MEM_LEVEL 8
49#else
50# define DEF_MEM_LEVEL MAX_MEM_LEVEL
51#endif
52#define DEF_WBITS MAX_WBITS
53
Guido van Rossumb729a1d1999-04-07 20:23:17 +000054/* The output buffer will be increased in chunks of DEFAULTALLOC bytes. */
55#define DEFAULTALLOC (16*1024)
Guido van Rossumfb221561997-04-29 15:38:09 +000056#define PyInit_zlib initzlib
57
Jeremy Hylton938ace62002-07-17 16:30:39 +000058static PyTypeObject Comptype;
59static PyTypeObject Decomptype;
Guido van Rossumfb221561997-04-29 15:38:09 +000060
61static PyObject *ZlibError;
62
Tim Peters977e5402001-10-17 03:57:20 +000063typedef struct
Guido van Rossumfb221561997-04-29 15:38:09 +000064{
Jeremy Hylton9714f992001-10-16 21:19:45 +000065 PyObject_HEAD
66 z_stream zst;
67 PyObject *unused_data;
68 PyObject *unconsumed_tail;
69 int is_initialised;
Guido van Rossumfb221561997-04-29 15:38:09 +000070} compobject;
71
Jeremy Hylton0965e082001-10-16 21:56:09 +000072static void
73zlib_error(z_stream zst, int err, char *msg)
74{
75 if (zst.msg == Z_NULL)
76 PyErr_Format(ZlibError, "Error %d %s", err, msg);
77 else
78 PyErr_Format(ZlibError, "Error %d %s: %.200s", err, msg, zst.msg);
79}
80
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000081PyDoc_STRVAR(compressobj__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +000082"compressobj([level]) -- Return a compressor object.\n"
83"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000084"Optional arg level is the compression level, in 1-9.");
Guido van Rossum3c540301997-06-03 22:21:03 +000085
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000086PyDoc_STRVAR(decompressobj__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +000087"decompressobj([wbits]) -- Return a decompressor object.\n"
88"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000089"Optional arg wbits is the window buffer size.");
Guido van Rossum3c540301997-06-03 22:21:03 +000090
Guido van Rossumfb221561997-04-29 15:38:09 +000091static compobject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +000092newcompobject(PyTypeObject *type)
Guido van Rossumfb221561997-04-29 15:38:09 +000093{
Tim Peters977e5402001-10-17 03:57:20 +000094 compobject *self;
Jeremy Hylton9714f992001-10-16 21:19:45 +000095 self = PyObject_New(compobject, type);
96 if (self == NULL)
97 return NULL;
98 self->is_initialised = 0;
99 self->unused_data = PyString_FromString("");
100 if (self->unused_data == NULL) {
101 Py_DECREF(self);
102 return NULL;
103 }
104 self->unconsumed_tail = PyString_FromString("");
105 if (self->unconsumed_tail == NULL) {
106 Py_DECREF(self);
107 return NULL;
108 }
109 return self;
Guido van Rossumfb221561997-04-29 15:38:09 +0000110}
111
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000112PyDoc_STRVAR(compress__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +0000113"compress(string[, level]) -- Returned compressed string.\n"
114"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000115"Optional arg level is the compression level, in 1-9.");
Guido van Rossum3c540301997-06-03 22:21:03 +0000116
Guido van Rossumfb221561997-04-29 15:38:09 +0000117static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000118PyZlib_compress(PyObject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000119{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000120 PyObject *ReturnVal = NULL;
121 Byte *input, *output;
122 int length, level=Z_DEFAULT_COMPRESSION, err;
123 z_stream zst;
Tim Peters977e5402001-10-17 03:57:20 +0000124
Jeremy Hylton9714f992001-10-16 21:19:45 +0000125 /* require Python string object, optional 'level' arg */
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000126 if (!PyArg_ParseTuple(args, "s#|i:compress", &input, &length, &level))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000127 return NULL;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000128
Jeremy Hylton9714f992001-10-16 21:19:45 +0000129 zst.avail_out = length + length/1000 + 12 + 1;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000130
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000131 output = (Byte*)malloc(zst.avail_out);
132 if (output == NULL) {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000133 PyErr_SetString(PyExc_MemoryError,
134 "Can't allocate memory to compress data");
Jeremy Hylton9714f992001-10-16 21:19:45 +0000135 return NULL;
Guido van Rossumfb221561997-04-29 15:38:09 +0000136 }
Jeremy Hyltona37e2441998-12-18 22:13:11 +0000137
Jeremy Hylton9714f992001-10-16 21:19:45 +0000138 /* Past the point of no return. From here on out, we need to make sure
139 we clean up mallocs & INCREFs. */
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000140
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000141 zst.zalloc = (alloc_func)NULL;
142 zst.zfree = (free_func)Z_NULL;
143 zst.next_out = (Byte *)output;
144 zst.next_in = (Byte *)input;
145 zst.avail_in = length;
146 err = deflateInit(&zst, level);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000147
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000148 switch(err) {
Guido van Rossumfb221561997-04-29 15:38:09 +0000149 case(Z_OK):
Jeremy Hylton9714f992001-10-16 21:19:45 +0000150 break;
Guido van Rossumfb221561997-04-29 15:38:09 +0000151 case(Z_MEM_ERROR):
Jeremy Hylton9714f992001-10-16 21:19:45 +0000152 PyErr_SetString(PyExc_MemoryError,
153 "Out of memory while compressing data");
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000154 goto error;
Guido van Rossumfb221561997-04-29 15:38:09 +0000155 case(Z_STREAM_ERROR):
Jeremy Hylton9714f992001-10-16 21:19:45 +0000156 PyErr_SetString(ZlibError,
157 "Bad compression level");
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000158 goto error;
Jeremy Hylton0965e082001-10-16 21:56:09 +0000159 default:
Guido van Rossumfb221561997-04-29 15:38:09 +0000160 deflateEnd(&zst);
Jeremy Hylton0965e082001-10-16 21:56:09 +0000161 zlib_error(zst, err, "while compressing data");
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000162 goto error;
Guido van Rossumfb221561997-04-29 15:38:09 +0000163 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000164
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000165 Py_BEGIN_ALLOW_THREADS;
166 err = deflate(&zst, Z_FINISH);
167 Py_END_ALLOW_THREADS;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000168
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000169 if (err != Z_STREAM_END) {
170 zlib_error(zst, err, "while compressing data");
171 deflateEnd(&zst);
172 goto error;
173 }
Tim Peters977e5402001-10-17 03:57:20 +0000174
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000175 err=deflateEnd(&zst);
176 if (err == Z_OK)
Tim Peters977e5402001-10-17 03:57:20 +0000177 ReturnVal = PyString_FromStringAndSize((char *)output,
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000178 zst.total_out);
Tim Peters977e5402001-10-17 03:57:20 +0000179 else
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000180 zlib_error(zst, err, "while finishing compression");
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000181
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000182 error:
Jeremy Hylton9714f992001-10-16 21:19:45 +0000183 free(output);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000184
Jeremy Hylton9714f992001-10-16 21:19:45 +0000185 return ReturnVal;
Guido van Rossumfb221561997-04-29 15:38:09 +0000186}
187
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000188PyDoc_STRVAR(decompress__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +0000189"decompress(string[, wbits[, bufsize]]) -- Return decompressed string.\n"
190"\n"
191"Optional arg wbits is the window buffer size. Optional arg bufsize is\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000192"the initial output buffer size.");
Guido van Rossum3c540301997-06-03 22:21:03 +0000193
Guido van Rossumfb221561997-04-29 15:38:09 +0000194static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000195PyZlib_decompress(PyObject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000196{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000197 PyObject *result_str;
198 Byte *input;
199 int length, err;
200 int wsize=DEF_WBITS, r_strlen=DEFAULTALLOC;
201 z_stream zst;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000202
Tim Peters977e5402001-10-17 03:57:20 +0000203 if (!PyArg_ParseTuple(args, "s#|ii:decompress",
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000204 &input, &length, &wsize, &r_strlen))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000205 return NULL;
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000206
Jeremy Hylton9714f992001-10-16 21:19:45 +0000207 if (r_strlen <= 0)
208 r_strlen = 1;
Jeremy Hyltona37e2441998-12-18 22:13:11 +0000209
Jeremy Hylton9714f992001-10-16 21:19:45 +0000210 zst.avail_in = length;
211 zst.avail_out = r_strlen;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000212
Jeremy Hylton9bc9d662001-10-16 21:23:58 +0000213 if (!(result_str = PyString_FromStringAndSize(NULL, r_strlen)))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000214 return NULL;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000215
Jeremy Hylton9714f992001-10-16 21:19:45 +0000216 zst.zalloc = (alloc_func)NULL;
217 zst.zfree = (free_func)Z_NULL;
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000218 zst.next_out = (Byte *)PyString_AS_STRING(result_str);
Jeremy Hylton9714f992001-10-16 21:19:45 +0000219 zst.next_in = (Byte *)input;
220 err = inflateInit2(&zst, wsize);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000221
Jeremy Hylton9714f992001-10-16 21:19:45 +0000222 switch(err) {
Guido van Rossumfb221561997-04-29 15:38:09 +0000223 case(Z_OK):
Jeremy Hylton9714f992001-10-16 21:19:45 +0000224 break;
Tim Peters977e5402001-10-17 03:57:20 +0000225 case(Z_MEM_ERROR):
Jeremy Hylton9714f992001-10-16 21:19:45 +0000226 PyErr_SetString(PyExc_MemoryError,
227 "Out of memory while decompressing data");
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000228 goto error;
Jeremy Hylton0965e082001-10-16 21:56:09 +0000229 default:
Guido van Rossumfb221561997-04-29 15:38:09 +0000230 inflateEnd(&zst);
Jeremy Hylton0965e082001-10-16 21:56:09 +0000231 zlib_error(zst, err, "while preparing to decompress data");
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000232 goto error;
Guido van Rossumfb221561997-04-29 15:38:09 +0000233 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000234
Jeremy Hylton9714f992001-10-16 21:19:45 +0000235 do {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000236 Py_BEGIN_ALLOW_THREADS
237 err=inflate(&zst, Z_FINISH);
238 Py_END_ALLOW_THREADS
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000239
Jeremy Hylton9714f992001-10-16 21:19:45 +0000240 switch(err) {
241 case(Z_STREAM_END):
Jeremy Hylton41b9f001997-08-13 23:19:55 +0000242 break;
Guido van Rossum115f5171998-04-23 20:22:11 +0000243 case(Z_BUF_ERROR):
Andrew M. Kuchlingd9238312000-10-09 14:18:10 +0000244 /*
245 * If there is at least 1 byte of room according to zst.avail_out
246 * and we get this error, assume that it means zlib cannot
247 * process the inflate call() due to an error in the data.
248 */
Jeremy Hylton0965e082001-10-16 21:56:09 +0000249 if (zst.avail_out > 0) {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000250 PyErr_Format(ZlibError, "Error %i while decompressing data",
251 err);
252 inflateEnd(&zst);
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000253 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000254 }
Andrew M. Kuchlingd9238312000-10-09 14:18:10 +0000255 /* fall through */
256 case(Z_OK):
Jeremy Hylton41b9f001997-08-13 23:19:55 +0000257 /* need more memory */
Tim Peters5de98422002-04-27 18:44:32 +0000258 if (_PyString_Resize(&result_str, r_strlen << 1) < 0) {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000259 inflateEnd(&zst);
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000260 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000261 }
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000262 zst.next_out = (unsigned char *)PyString_AS_STRING(result_str) \
Jeremy Hylton9714f992001-10-16 21:19:45 +0000263 + r_strlen;
264 zst.avail_out = r_strlen;
Jeremy Hylton41b9f001997-08-13 23:19:55 +0000265 r_strlen = r_strlen << 1;
266 break;
Jeremy Hylton0965e082001-10-16 21:56:09 +0000267 default:
Jeremy Hylton9714f992001-10-16 21:19:45 +0000268 inflateEnd(&zst);
Jeremy Hylton0965e082001-10-16 21:56:09 +0000269 zlib_error(zst, err, "while decompressing data");
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000270 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000271 }
272 } while (err != Z_STREAM_END);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000273
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000274 err = inflateEnd(&zst);
275 if (err != Z_OK) {
276 zlib_error(zst, err, "while finishing data decompression");
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000277 goto error;
Guido van Rossumfb221561997-04-29 15:38:09 +0000278 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000279
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000280 _PyString_Resize(&result_str, zst.total_out);
Jeremy Hylton9714f992001-10-16 21:19:45 +0000281 return result_str;
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000282
283 error:
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000284 Py_XDECREF(result_str);
285 return NULL;
Guido van Rossumfb221561997-04-29 15:38:09 +0000286}
287
288static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000289PyZlib_compressobj(PyObject *selfptr, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000290{
Jeremy Hylton499000002001-10-16 21:59:35 +0000291 compobject *self;
292 int level=Z_DEFAULT_COMPRESSION, method=DEFLATED;
293 int wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=0, err;
Jeremy Hylton41b9f001997-08-13 23:19:55 +0000294
Jeremy Hylton499000002001-10-16 21:59:35 +0000295 if (!PyArg_ParseTuple(args, "|iiiii:compressobj", &level, &method, &wbits,
296 &memLevel, &strategy))
297 return NULL;
Jeremy Hylton41b9f001997-08-13 23:19:55 +0000298
Jeremy Hylton499000002001-10-16 21:59:35 +0000299 self = newcompobject(&Comptype);
Tim Peters977e5402001-10-17 03:57:20 +0000300 if (self==NULL)
Jeremy Hylton499000002001-10-16 21:59:35 +0000301 return(NULL);
302 self->zst.zalloc = (alloc_func)NULL;
303 self->zst.zfree = (free_func)Z_NULL;
Andrew M. Kuchling3b585b32004-12-28 20:10:48 +0000304 self->zst.next_in = NULL;
305 self->zst.avail_in = 0;
Jeremy Hylton499000002001-10-16 21:59:35 +0000306 err = deflateInit2(&self->zst, level, method, wbits, memLevel, strategy);
307 switch(err) {
Guido van Rossumfb221561997-04-29 15:38:09 +0000308 case (Z_OK):
Jeremy Hylton499000002001-10-16 21:59:35 +0000309 self->is_initialised = 1;
310 return (PyObject*)self;
Guido van Rossumfb221561997-04-29 15:38:09 +0000311 case (Z_MEM_ERROR):
Jeremy Hylton499000002001-10-16 21:59:35 +0000312 Py_DECREF(self);
313 PyErr_SetString(PyExc_MemoryError,
314 "Can't allocate memory for compression object");
315 return NULL;
Guido van Rossumfb221561997-04-29 15:38:09 +0000316 case(Z_STREAM_ERROR):
Jeremy Hylton499000002001-10-16 21:59:35 +0000317 Py_DECREF(self);
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000318 PyErr_SetString(PyExc_ValueError, "Invalid initialization option");
Jeremy Hylton499000002001-10-16 21:59:35 +0000319 return NULL;
Guido van Rossumfb221561997-04-29 15:38:09 +0000320 default:
Jeremy Hylton0965e082001-10-16 21:56:09 +0000321 zlib_error(self->zst, err, "while creating compression object");
Andrew M. Kuchling1c7aaa21999-01-29 21:49:34 +0000322 Py_DECREF(self);
Guido van Rossumfb221561997-04-29 15:38:09 +0000323 return NULL;
Guido van Rossumfb221561997-04-29 15:38:09 +0000324 }
325}
326
327static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000328PyZlib_decompressobj(PyObject *selfptr, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000329{
Jeremy Hylton499000002001-10-16 21:59:35 +0000330 int wbits=DEF_WBITS, err;
331 compobject *self;
332 if (!PyArg_ParseTuple(args, "|i:decompressobj", &wbits))
333 return NULL;
334
335 self = newcompobject(&Decomptype);
Tim Peters977e5402001-10-17 03:57:20 +0000336 if (self == NULL)
Jeremy Hylton499000002001-10-16 21:59:35 +0000337 return(NULL);
338 self->zst.zalloc = (alloc_func)NULL;
339 self->zst.zfree = (free_func)Z_NULL;
Andrew M. Kuchling3b585b32004-12-28 20:10:48 +0000340 self->zst.next_in = NULL;
341 self->zst.avail_in = 0;
Jeremy Hylton499000002001-10-16 21:59:35 +0000342 err = inflateInit2(&self->zst, wbits);
343 switch(err) {
Guido van Rossumfb221561997-04-29 15:38:09 +0000344 case (Z_OK):
Jeremy Hylton499000002001-10-16 21:59:35 +0000345 self->is_initialised = 1;
346 return (PyObject*)self;
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000347 case(Z_STREAM_ERROR):
Jeremy Hylton499000002001-10-16 21:59:35 +0000348 Py_DECREF(self);
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000349 PyErr_SetString(PyExc_ValueError, "Invalid initialization option");
Jeremy Hylton499000002001-10-16 21:59:35 +0000350 return NULL;
Guido van Rossumfb221561997-04-29 15:38:09 +0000351 case (Z_MEM_ERROR):
Jeremy Hylton499000002001-10-16 21:59:35 +0000352 Py_DECREF(self);
353 PyErr_SetString(PyExc_MemoryError,
354 "Can't allocate memory for decompression object");
355 return NULL;
Guido van Rossumfb221561997-04-29 15:38:09 +0000356 default:
Jeremy Hylton0965e082001-10-16 21:56:09 +0000357 zlib_error(self->zst, err, "while creating decompression object");
Andrew M. Kuchling1c7aaa21999-01-29 21:49:34 +0000358 Py_DECREF(self);
Guido van Rossumfb221561997-04-29 15:38:09 +0000359 return NULL;
Jeremy Hylton499000002001-10-16 21:59:35 +0000360 }
Guido van Rossumfb221561997-04-29 15:38:09 +0000361}
362
363static void
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000364Comp_dealloc(compobject *self)
Guido van Rossumfb221561997-04-29 15:38:09 +0000365{
Andrew M. Kuchling1c7aaa21999-01-29 21:49:34 +0000366 if (self->is_initialised)
Jeremy Hylton499000002001-10-16 21:59:35 +0000367 deflateEnd(&self->zst);
Andrew M. Kuchlingb95227d1999-03-25 21:21:08 +0000368 Py_XDECREF(self->unused_data);
Jeremy Hylton511e2ca2001-10-16 20:39:49 +0000369 Py_XDECREF(self->unconsumed_tail);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000370 PyObject_Del(self);
Guido van Rossumfb221561997-04-29 15:38:09 +0000371}
372
373static void
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000374Decomp_dealloc(compobject *self)
Guido van Rossumfb221561997-04-29 15:38:09 +0000375{
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000376 if (self->is_initialised)
Jeremy Hylton499000002001-10-16 21:59:35 +0000377 inflateEnd(&self->zst);
Andrew M. Kuchlingb95227d1999-03-25 21:21:08 +0000378 Py_XDECREF(self->unused_data);
Jeremy Hylton511e2ca2001-10-16 20:39:49 +0000379 Py_XDECREF(self->unconsumed_tail);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000380 PyObject_Del(self);
Guido van Rossumfb221561997-04-29 15:38:09 +0000381}
382
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000383PyDoc_STRVAR(comp_compress__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +0000384"compress(data) -- Return a string containing data compressed.\n"
385"\n"
Guido van Rossum3c540301997-06-03 22:21:03 +0000386"After calling this function, some of the input data may still\n"
387"be stored in internal buffers for later processing.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000388"Call the flush() method to clear these buffers.");
Guido van Rossum3c540301997-06-03 22:21:03 +0000389
390
Guido van Rossumfb221561997-04-29 15:38:09 +0000391static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000392PyZlib_objcompress(compobject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000393{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000394 int err, inplen, length = DEFAULTALLOC;
395 PyObject *RetVal;
396 Byte *input;
397 unsigned long start_total_out;
Tim Peters977e5402001-10-17 03:57:20 +0000398
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000399 if (!PyArg_ParseTuple(args, "s#:compress", &input, &inplen))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000400 return NULL;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000401
Jeremy Hylton9bc9d662001-10-16 21:23:58 +0000402 if (!(RetVal = PyString_FromStringAndSize(NULL, length)))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000403 return NULL;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000404
405 ENTER_ZLIB
406
Jeremy Hylton9714f992001-10-16 21:19:45 +0000407 start_total_out = self->zst.total_out;
408 self->zst.avail_in = inplen;
409 self->zst.next_in = input;
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000410 self->zst.avail_out = length;
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000411 self->zst.next_out = (unsigned char *)PyString_AS_STRING(RetVal);
Jeremy Hylton9714f992001-10-16 21:19:45 +0000412
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000413 Py_BEGIN_ALLOW_THREADS
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000414 err = deflate(&(self->zst), Z_NO_FLUSH);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000415 Py_END_ALLOW_THREADS
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000416
Jeremy Hylton9714f992001-10-16 21:19:45 +0000417 /* while Z_OK and the output buffer is full, there might be more output,
418 so extend the output buffer and try again */
419 while (err == Z_OK && self->zst.avail_out == 0) {
Tim Peters5de98422002-04-27 18:44:32 +0000420 if (_PyString_Resize(&RetVal, length << 1) < 0)
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000421 goto error;
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000422 self->zst.next_out = (unsigned char *)PyString_AS_STRING(RetVal) \
Jeremy Hylton9714f992001-10-16 21:19:45 +0000423 + length;
424 self->zst.avail_out = length;
425 length = length << 1;
Tim Peters977e5402001-10-17 03:57:20 +0000426
Jeremy Hylton9714f992001-10-16 21:19:45 +0000427 Py_BEGIN_ALLOW_THREADS
428 err = deflate(&(self->zst), Z_NO_FLUSH);
429 Py_END_ALLOW_THREADS
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000430 }
Tim Peters977e5402001-10-17 03:57:20 +0000431 /* We will only get Z_BUF_ERROR if the output buffer was full but
Jeremy Hylton9714f992001-10-16 21:19:45 +0000432 there wasn't more output when we tried again, so it is not an error
Tim Peters977e5402001-10-17 03:57:20 +0000433 condition.
434 */
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000435
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000436 if (err != Z_OK && err != Z_BUF_ERROR) {
437 zlib_error(self->zst, err, "while compressing");
438 Py_DECREF(RetVal);
439 RetVal = NULL;
440 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000441 }
Tim Peters5de98422002-04-27 18:44:32 +0000442 _PyString_Resize(&RetVal, self->zst.total_out - start_total_out);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000443
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000444 error:
Jeremy Hylton9714f992001-10-16 21:19:45 +0000445 LEAVE_ZLIB
Jeremy Hylton9714f992001-10-16 21:19:45 +0000446 return RetVal;
Guido van Rossumfb221561997-04-29 15:38:09 +0000447}
448
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000449PyDoc_STRVAR(decomp_decompress__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +0000450"decompress(data, max_length) -- Return a string containing the decompressed\n"
451"version of the data.\n"
452"\n"
453"After calling this function, some of the input data may still be stored in\n"
454"internal buffers for later processing.\n"
Jeremy Hylton511e2ca2001-10-16 20:39:49 +0000455"Call the flush() method to clear these buffers.\n"
456"If the max_length parameter is specified then the return value will be\n"
457"no longer than max_length. Unconsumed input data will be stored in\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000458"the unconsumed_tail attribute.");
Guido van Rossum3c540301997-06-03 22:21:03 +0000459
Guido van Rossumfb221561997-04-29 15:38:09 +0000460static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000461PyZlib_objdecompress(compobject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000462{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000463 int err, inplen, old_length, length = DEFAULTALLOC;
464 int max_length = 0;
465 PyObject *RetVal;
466 Byte *input;
467 unsigned long start_total_out;
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000468
Tim Peters977e5402001-10-17 03:57:20 +0000469 if (!PyArg_ParseTuple(args, "s#|i:decompress", &input,
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000470 &inplen, &max_length))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000471 return NULL;
472 if (max_length < 0) {
473 PyErr_SetString(PyExc_ValueError,
474 "max_length must be greater than zero");
475 return NULL;
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000476 }
Jeremy Hylton9714f992001-10-16 21:19:45 +0000477
Jeremy Hylton9714f992001-10-16 21:19:45 +0000478 /* limit amount of data allocated to max_length */
Tim Peters977e5402001-10-17 03:57:20 +0000479 if (max_length && length > max_length)
Jeremy Hylton9714f992001-10-16 21:19:45 +0000480 length = max_length;
Jeremy Hylton9bc9d662001-10-16 21:23:58 +0000481 if (!(RetVal = PyString_FromStringAndSize(NULL, length)))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000482 return NULL;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000483
484 ENTER_ZLIB
Jeremy Hylton9714f992001-10-16 21:19:45 +0000485
Jeremy Hylton9714f992001-10-16 21:19:45 +0000486 start_total_out = self->zst.total_out;
487 self->zst.avail_in = inplen;
488 self->zst.next_in = input;
489 self->zst.avail_out = length;
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000490 self->zst.next_out = (unsigned char *)PyString_AS_STRING(RetVal);
Jeremy Hylton511e2ca2001-10-16 20:39:49 +0000491
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000492 Py_BEGIN_ALLOW_THREADS
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000493 err = inflate(&(self->zst), Z_SYNC_FLUSH);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000494 Py_END_ALLOW_THREADS
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000495
Jeremy Hylton9714f992001-10-16 21:19:45 +0000496 /* While Z_OK and the output buffer is full, there might be more output.
497 So extend the output buffer and try again.
498 */
Tim Peters977e5402001-10-17 03:57:20 +0000499 while (err == Z_OK && self->zst.avail_out == 0) {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000500 /* If max_length set, don't continue decompressing if we've already
501 reached the limit.
502 */
503 if (max_length && length >= max_length)
504 break;
Jeremy Hylton511e2ca2001-10-16 20:39:49 +0000505
Jeremy Hylton9714f992001-10-16 21:19:45 +0000506 /* otherwise, ... */
507 old_length = length;
508 length = length << 1;
Tim Peters977e5402001-10-17 03:57:20 +0000509 if (max_length && length > max_length)
Jeremy Hylton9714f992001-10-16 21:19:45 +0000510 length = max_length;
511
Tim Peters5de98422002-04-27 18:44:32 +0000512 if (_PyString_Resize(&RetVal, length) < 0)
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000513 goto error;
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000514 self->zst.next_out = (unsigned char *)PyString_AS_STRING(RetVal) \
Jeremy Hylton9714f992001-10-16 21:19:45 +0000515 + old_length;
516 self->zst.avail_out = length - old_length;
517
518 Py_BEGIN_ALLOW_THREADS
519 err = inflate(&(self->zst), Z_SYNC_FLUSH);
520 Py_END_ALLOW_THREADS
Guido van Rossumfb221561997-04-29 15:38:09 +0000521 }
Jeremy Hylton9714f992001-10-16 21:19:45 +0000522
Andrew M. Kuchling3b585b32004-12-28 20:10:48 +0000523 /* Not all of the compressed data could be accommodated in the output buffer
Jeremy Hylton9714f992001-10-16 21:19:45 +0000524 of specified size. Return the unconsumed tail in an attribute.*/
525 if(max_length) {
526 Py_DECREF(self->unconsumed_tail);
Jack Jansen72af01a2001-10-23 22:29:06 +0000527 self->unconsumed_tail = PyString_FromStringAndSize((char *)self->zst.next_in,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000528 self->zst.avail_in);
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000529 if(!self->unconsumed_tail) {
530 Py_DECREF(RetVal);
531 RetVal = NULL;
532 goto error;
533 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000534 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000535
Tim Peters977e5402001-10-17 03:57:20 +0000536 /* The end of the compressed data has been reached, so set the
537 unused_data attribute to a string containing the remainder of the
538 data in the string. Note that this is also a logical place to call
Jeremy Hylton9714f992001-10-16 21:19:45 +0000539 inflateEnd, but the old behaviour of only calling it on flush() is
540 preserved.
541 */
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000542 if (err == Z_STREAM_END) {
543 Py_XDECREF(self->unused_data); /* Free original empty string */
544 self->unused_data = PyString_FromStringAndSize(
545 (char *)self->zst.next_in, self->zst.avail_in);
546 if (self->unused_data == NULL) {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000547 Py_DECREF(RetVal);
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000548 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000549 }
Tim Peters977e5402001-10-17 03:57:20 +0000550 /* We will only get Z_BUF_ERROR if the output buffer was full
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000551 but there wasn't more output when we tried again, so it is
552 not an error condition.
553 */
554 } else if (err != Z_OK && err != Z_BUF_ERROR) {
555 zlib_error(self->zst, err, "while decompressing");
556 Py_DECREF(RetVal);
557 RetVal = NULL;
558 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000559 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000560
Tim Peters5de98422002-04-27 18:44:32 +0000561 _PyString_Resize(&RetVal, self->zst.total_out - start_total_out);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000562
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000563 error:
Jeremy Hylton9714f992001-10-16 21:19:45 +0000564 LEAVE_ZLIB
565
566 return RetVal;
Guido van Rossumfb221561997-04-29 15:38:09 +0000567}
568
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000569PyDoc_STRVAR(comp_flush__doc__,
Jeremy Hyltona37e2441998-12-18 22:13:11 +0000570"flush( [mode] ) -- Return a string containing any remaining compressed data.\n"
Tim Petersadbd35b2001-10-17 04:16:15 +0000571"\n"
572"mode can be one of the constants Z_SYNC_FLUSH, Z_FULL_FLUSH, Z_FINISH; the\n"
Jeremy Hyltona37e2441998-12-18 22:13:11 +0000573"default value used when mode is not specified is Z_FINISH.\n"
574"If mode == Z_FINISH, the compressor object can no longer be used after\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000575"calling the flush() method. Otherwise, more data can still be compressed.");
Guido van Rossum3c540301997-06-03 22:21:03 +0000576
Guido van Rossumfb221561997-04-29 15:38:09 +0000577static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000578PyZlib_flush(compobject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000579{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000580 int err, length = DEFAULTALLOC;
581 PyObject *RetVal;
582 int flushmode = Z_FINISH;
583 unsigned long start_total_out;
Jeremy Hyltona37e2441998-12-18 22:13:11 +0000584
Jeremy Hylton9714f992001-10-16 21:19:45 +0000585 if (!PyArg_ParseTuple(args, "|i:flush", &flushmode))
586 return NULL;
Jeremy Hyltona37e2441998-12-18 22:13:11 +0000587
Jeremy Hylton9714f992001-10-16 21:19:45 +0000588 /* Flushing with Z_NO_FLUSH is a no-op, so there's no point in
589 doing any work at all; just return an empty string. */
590 if (flushmode == Z_NO_FLUSH) {
591 return PyString_FromStringAndSize(NULL, 0);
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000592 }
Jeremy Hylton9714f992001-10-16 21:19:45 +0000593
Jeremy Hylton9bc9d662001-10-16 21:23:58 +0000594 if (!(RetVal = PyString_FromStringAndSize(NULL, length)))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000595 return NULL;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000596
597 ENTER_ZLIB
Tim Peters977e5402001-10-17 03:57:20 +0000598
Jeremy Hylton9714f992001-10-16 21:19:45 +0000599 start_total_out = self->zst.total_out;
600 self->zst.avail_in = 0;
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000601 self->zst.avail_out = length;
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000602 self->zst.next_out = (unsigned char *)PyString_AS_STRING(RetVal);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000603
604 Py_BEGIN_ALLOW_THREADS
Andrew M. Kuchling9aff4a22001-02-21 02:15:56 +0000605 err = deflate(&(self->zst), flushmode);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000606 Py_END_ALLOW_THREADS
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000607
Jeremy Hylton9714f992001-10-16 21:19:45 +0000608 /* while Z_OK and the output buffer is full, there might be more output,
609 so extend the output buffer and try again */
610 while (err == Z_OK && self->zst.avail_out == 0) {
Tim Peters5de98422002-04-27 18:44:32 +0000611 if (_PyString_Resize(&RetVal, length << 1) < 0)
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000612 goto error;
Jeremy Hyltonba3dd992001-10-16 23:26:08 +0000613 self->zst.next_out = (unsigned char *)PyString_AS_STRING(RetVal) \
Jeremy Hylton9714f992001-10-16 21:19:45 +0000614 + length;
615 self->zst.avail_out = length;
616 length = length << 1;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000617
Jeremy Hylton9714f992001-10-16 21:19:45 +0000618 Py_BEGIN_ALLOW_THREADS
619 err = deflate(&(self->zst), flushmode);
620 Py_END_ALLOW_THREADS
Jeremy Hyltona37e2441998-12-18 22:13:11 +0000621 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000622
Jeremy Hylton9714f992001-10-16 21:19:45 +0000623 /* If flushmode is Z_FINISH, we also have to call deflateEnd() to free
Tim Peters977e5402001-10-17 03:57:20 +0000624 various data structures. Note we should only get Z_STREAM_END when
Jeremy Hylton9714f992001-10-16 21:19:45 +0000625 flushmode is Z_FINISH, but checking both for safety*/
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000626 if (err == Z_STREAM_END && flushmode == Z_FINISH) {
627 err = deflateEnd(&(self->zst));
628 if (err != Z_OK) {
629 zlib_error(self->zst, err, "from deflateEnd()");
Jeremy Hylton9714f992001-10-16 21:19:45 +0000630 Py_DECREF(RetVal);
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000631 RetVal = NULL;
632 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000633 }
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000634 else
635 self->is_initialised = 0;
Tim Peters977e5402001-10-17 03:57:20 +0000636
637 /* We will only get Z_BUF_ERROR if the output buffer was full
638 but there wasn't more output when we tried again, so it is
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000639 not an error condition.
640 */
641 } else if (err!=Z_OK && err!=Z_BUF_ERROR) {
642 zlib_error(self->zst, err, "while flushing");
643 Py_DECREF(RetVal);
644 RetVal = NULL;
Jeremy Hyltonc72737e2002-04-19 14:37:07 +0000645 goto error;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000646 }
Tim Peters977e5402001-10-17 03:57:20 +0000647
Tim Peters5de98422002-04-27 18:44:32 +0000648 _PyString_Resize(&RetVal, self->zst.total_out - start_total_out);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000649
Tim Peters977e5402001-10-17 03:57:20 +0000650 error:
Tim Petersb1a37c02001-10-17 03:56:45 +0000651 LEAVE_ZLIB
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000652
653 return RetVal;
Guido van Rossumfb221561997-04-29 15:38:09 +0000654}
655
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000656PyDoc_STRVAR(decomp_flush__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +0000657"flush() -- Return a string containing any remaining decompressed data.\n"
658"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000659"The decompressor object can no longer be used after this call.");
Guido van Rossum3c540301997-06-03 22:21:03 +0000660
Guido van Rossumfb221561997-04-29 15:38:09 +0000661static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000662PyZlib_unflush(compobject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000663{
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000664 int err, length = DEFAULTALLOC;
Jeremy Hylton9d620d02001-10-16 23:02:32 +0000665 PyObject * retval = NULL;
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000666 unsigned long start_total_out;
Tim Peters977e5402001-10-17 03:57:20 +0000667
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000668 if (!PyArg_ParseTuple(args, "|i:flush", &length))
Jeremy Hylton9714f992001-10-16 21:19:45 +0000669 return NULL;
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000670 if (!(retval = PyString_FromStringAndSize(NULL, length)))
671 return NULL;
672
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000673
Jeremy Hylton9714f992001-10-16 21:19:45 +0000674 ENTER_ZLIB
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000675
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000676 start_total_out = self->zst.total_out;
677 self->zst.avail_out = length;
678 self->zst.next_out = (Byte *)PyString_AS_STRING(retval);
679
680 Py_BEGIN_ALLOW_THREADS
681 err = inflate(&(self->zst), Z_FINISH);
682 Py_END_ALLOW_THREADS
683
684 /* while Z_OK and the output buffer is full, there might be more output,
685 so extend the output buffer and try again */
686 while ((err == Z_OK || err == Z_BUF_ERROR) && self->zst.avail_out == 0) {
687 if (_PyString_Resize(&retval, length << 1) < 0)
688 goto error;
689 self->zst.next_out = (Byte *)PyString_AS_STRING(retval) + length;
690 self->zst.avail_out = length;
691 length = length << 1;
692
693 Py_BEGIN_ALLOW_THREADS
694 err = inflate(&(self->zst), Z_FINISH);
695 Py_END_ALLOW_THREADS
Jeremy Hylton9714f992001-10-16 21:19:45 +0000696 }
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000697
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000698 /* If flushmode is Z_FINISH, we also have to call deflateEnd() to free
699 various data structures. Note we should only get Z_STREAM_END when
700 flushmode is Z_FINISH */
701 if (err == Z_STREAM_END) {
702 err = inflateEnd(&(self->zst));
703 self->is_initialised = 0;
704 if (err != Z_OK) {
705 zlib_error(self->zst, err, "from inflateEnd()");
706 Py_DECREF(retval);
707 retval = NULL;
708 goto error;
709 }
710 }
711 _PyString_Resize(&retval, self->zst.total_out - start_total_out);
712
713error:
714
Jeremy Hylton9714f992001-10-16 21:19:45 +0000715 LEAVE_ZLIB
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000716
Jeremy Hylton9714f992001-10-16 21:19:45 +0000717 return retval;
Guido van Rossumfb221561997-04-29 15:38:09 +0000718}
719
720static PyMethodDef comp_methods[] =
721{
Tim Peters977e5402001-10-17 03:57:20 +0000722 {"compress", (binaryfunc)PyZlib_objcompress, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000723 comp_compress__doc__},
Tim Peters977e5402001-10-17 03:57:20 +0000724 {"flush", (binaryfunc)PyZlib_flush, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000725 comp_flush__doc__},
726 {NULL, NULL}
Guido van Rossumfb221561997-04-29 15:38:09 +0000727};
728
729static PyMethodDef Decomp_methods[] =
730{
Tim Peters977e5402001-10-17 03:57:20 +0000731 {"decompress", (binaryfunc)PyZlib_objdecompress, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000732 decomp_decompress__doc__},
Tim Peters977e5402001-10-17 03:57:20 +0000733 {"flush", (binaryfunc)PyZlib_unflush, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000734 decomp_flush__doc__},
735 {NULL, NULL}
Guido van Rossumfb221561997-04-29 15:38:09 +0000736};
737
738static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000739Comp_getattr(compobject *self, char *name)
Guido van Rossumfb221561997-04-29 15:38:09 +0000740{
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000741 /* No ENTER/LEAVE_ZLIB is necessary because this fn doesn't touch
742 internal data. */
743
744 return Py_FindMethod(comp_methods, (PyObject *)self, name);
Guido van Rossumfb221561997-04-29 15:38:09 +0000745}
746
747static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000748Decomp_getattr(compobject *self, char *name)
Guido van Rossumfb221561997-04-29 15:38:09 +0000749{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000750 PyObject * retval;
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000751
Jeremy Hylton9714f992001-10-16 21:19:45 +0000752 ENTER_ZLIB
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000753
Tim Peters977e5402001-10-17 03:57:20 +0000754 if (strcmp(name, "unused_data") == 0) {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000755 Py_INCREF(self->unused_data);
756 retval = self->unused_data;
Tim Peters977e5402001-10-17 03:57:20 +0000757 } else if (strcmp(name, "unconsumed_tail") == 0) {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000758 Py_INCREF(self->unconsumed_tail);
759 retval = self->unconsumed_tail;
Tim Peters977e5402001-10-17 03:57:20 +0000760 } else
Jeremy Hylton9714f992001-10-16 21:19:45 +0000761 retval = Py_FindMethod(Decomp_methods, (PyObject *)self, name);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000762
Jeremy Hylton9714f992001-10-16 21:19:45 +0000763 LEAVE_ZLIB
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000764
Jeremy Hylton9714f992001-10-16 21:19:45 +0000765 return retval;
Guido van Rossumfb221561997-04-29 15:38:09 +0000766}
767
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000768PyDoc_STRVAR(adler32__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +0000769"adler32(string[, start]) -- Compute an Adler-32 checksum of string.\n"
770"\n"
771"An optional starting value can be specified. The returned checksum is\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000772"an integer.");
Guido van Rossum3c540301997-06-03 22:21:03 +0000773
Guido van Rossumfb221561997-04-29 15:38:09 +0000774static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000775PyZlib_adler32(PyObject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000776{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000777 uLong adler32val = adler32(0L, Z_NULL, 0);
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000778 Byte *buf;
779 int len;
Tim Peters977e5402001-10-17 03:57:20 +0000780
Guido van Rossum43713e52000-02-29 13:59:29 +0000781 if (!PyArg_ParseTuple(args, "s#|l:adler32", &buf, &len, &adler32val))
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000782 return NULL;
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000783 adler32val = adler32(adler32val, buf, len);
784 return PyInt_FromLong(adler32val);
Guido van Rossumfb221561997-04-29 15:38:09 +0000785}
Tim Peters977e5402001-10-17 03:57:20 +0000786
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000787PyDoc_STRVAR(crc32__doc__,
Tim Petersadbd35b2001-10-17 04:16:15 +0000788"crc32(string[, start]) -- Compute a CRC-32 checksum of string.\n"
789"\n"
790"An optional starting value can be specified. The returned checksum is\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000791"an integer.");
Guido van Rossumfb221561997-04-29 15:38:09 +0000792
793static PyObject *
Peter Schneider-Kampa788a7f2000-07-10 09:57:19 +0000794PyZlib_crc32(PyObject *self, PyObject *args)
Guido van Rossumfb221561997-04-29 15:38:09 +0000795{
Jeremy Hylton9714f992001-10-16 21:19:45 +0000796 uLong crc32val = crc32(0L, Z_NULL, 0);
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000797 Byte *buf;
798 int len;
Guido van Rossum43713e52000-02-29 13:59:29 +0000799 if (!PyArg_ParseTuple(args, "s#|l:crc32", &buf, &len, &crc32val))
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000800 return NULL;
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000801 crc32val = crc32(crc32val, buf, len);
802 return PyInt_FromLong(crc32val);
Guido van Rossumfb221561997-04-29 15:38:09 +0000803}
Tim Peters977e5402001-10-17 03:57:20 +0000804
Guido van Rossumfb221561997-04-29 15:38:09 +0000805
806static PyMethodDef zlib_methods[] =
807{
Tim Peters977e5402001-10-17 03:57:20 +0000808 {"adler32", (PyCFunction)PyZlib_adler32, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000809 adler32__doc__},
Tim Peters977e5402001-10-17 03:57:20 +0000810 {"compress", (PyCFunction)PyZlib_compress, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000811 compress__doc__},
Tim Peters977e5402001-10-17 03:57:20 +0000812 {"compressobj", (PyCFunction)PyZlib_compressobj, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000813 compressobj__doc__},
Tim Peters977e5402001-10-17 03:57:20 +0000814 {"crc32", (PyCFunction)PyZlib_crc32, METH_VARARGS,
815 crc32__doc__},
816 {"decompress", (PyCFunction)PyZlib_decompress, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000817 decompress__doc__},
Tim Peters977e5402001-10-17 03:57:20 +0000818 {"decompressobj", (PyCFunction)PyZlib_decompressobj, METH_VARARGS,
Jeremy Hylton9714f992001-10-16 21:19:45 +0000819 decompressobj__doc__},
820 {NULL, NULL}
Guido van Rossumfb221561997-04-29 15:38:09 +0000821};
822
Tim Peters0c322792002-07-17 16:49:03 +0000823static PyTypeObject Comptype = {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000824 PyObject_HEAD_INIT(0)
825 0,
Guido van Rossum14648392001-12-08 18:02:58 +0000826 "zlib.Compress",
Jeremy Hylton9714f992001-10-16 21:19:45 +0000827 sizeof(compobject),
828 0,
829 (destructor)Comp_dealloc, /*tp_dealloc*/
830 0, /*tp_print*/
831 (getattrfunc)Comp_getattr, /*tp_getattr*/
832 0, /*tp_setattr*/
833 0, /*tp_compare*/
834 0, /*tp_repr*/
835 0, /*tp_as_number*/
836 0, /*tp_as_sequence*/
837 0, /*tp_as_mapping*/
Guido van Rossumfb221561997-04-29 15:38:09 +0000838};
839
Tim Peters0c322792002-07-17 16:49:03 +0000840static PyTypeObject Decomptype = {
Jeremy Hylton9714f992001-10-16 21:19:45 +0000841 PyObject_HEAD_INIT(0)
842 0,
Guido van Rossum14648392001-12-08 18:02:58 +0000843 "zlib.Decompress",
Jeremy Hylton9714f992001-10-16 21:19:45 +0000844 sizeof(compobject),
845 0,
846 (destructor)Decomp_dealloc, /*tp_dealloc*/
847 0, /*tp_print*/
848 (getattrfunc)Decomp_getattr, /*tp_getattr*/
849 0, /*tp_setattr*/
850 0, /*tp_compare*/
851 0, /*tp_repr*/
852 0, /*tp_as_number*/
853 0, /*tp_as_sequence*/
854 0, /*tp_as_mapping*/
Guido van Rossumfb221561997-04-29 15:38:09 +0000855};
856
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000857PyDoc_STRVAR(zlib_module_documentation,
Tim Petersadbd35b2001-10-17 04:16:15 +0000858"The functions in this module allow compression and decompression using the\n"
859"zlib library, which is based on GNU zip.\n"
860"\n"
861"adler32(string[, start]) -- Compute an Adler-32 checksum.\n"
862"compress(string[, level]) -- Compress string, with compression level in 1-9.\n"
Guido van Rossum3c540301997-06-03 22:21:03 +0000863"compressobj([level]) -- Return a compressor object.\n"
Tim Petersadbd35b2001-10-17 04:16:15 +0000864"crc32(string[, start]) -- Compute a CRC-32 checksum.\n"
Andrew M. Kuchling313a3e31999-12-20 22:13:38 +0000865"decompress(string,[wbits],[bufsize]) -- Decompresses a compressed string.\n"
Tim Petersadbd35b2001-10-17 04:16:15 +0000866"decompressobj([wbits]) -- Return a decompressor object.\n"
867"\n"
868"'wbits' is window buffer size.\n"
869"Compressor objects support compress() and flush() methods; decompressor\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000870"objects support decompress() and flush().");
Guido van Rossum3c540301997-06-03 22:21:03 +0000871
Mark Hammond62b1ab12002-07-23 06:31:15 +0000872PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000873PyInit_zlib(void)
Guido van Rossumfb221561997-04-29 15:38:09 +0000874{
Fred Drake4baedc12002-04-01 14:53:37 +0000875 PyObject *m, *ver;
Jeremy Hylton9714f992001-10-16 21:19:45 +0000876 Comptype.ob_type = &PyType_Type;
877 Decomptype.ob_type = &PyType_Type;
878 m = Py_InitModule4("zlib", zlib_methods,
879 zlib_module_documentation,
880 (PyObject*)NULL,PYTHON_API_VERSION);
Jeremy Hyltoncb914041997-09-04 23:39:23 +0000881
Fred Drake4baedc12002-04-01 14:53:37 +0000882 ZlibError = PyErr_NewException("zlib.error", NULL, NULL);
883 if (ZlibError != NULL) {
884 Py_INCREF(ZlibError);
885 PyModule_AddObject(m, "error", ZlibError);
886 }
Jeremy Hylton9714f992001-10-16 21:19:45 +0000887 PyModule_AddIntConstant(m, "MAX_WBITS", MAX_WBITS);
888 PyModule_AddIntConstant(m, "DEFLATED", DEFLATED);
889 PyModule_AddIntConstant(m, "DEF_MEM_LEVEL", DEF_MEM_LEVEL);
890 PyModule_AddIntConstant(m, "Z_BEST_SPEED", Z_BEST_SPEED);
891 PyModule_AddIntConstant(m, "Z_BEST_COMPRESSION", Z_BEST_COMPRESSION);
892 PyModule_AddIntConstant(m, "Z_DEFAULT_COMPRESSION", Z_DEFAULT_COMPRESSION);
893 PyModule_AddIntConstant(m, "Z_FILTERED", Z_FILTERED);
894 PyModule_AddIntConstant(m, "Z_HUFFMAN_ONLY", Z_HUFFMAN_ONLY);
895 PyModule_AddIntConstant(m, "Z_DEFAULT_STRATEGY", Z_DEFAULT_STRATEGY);
Tim Peters977e5402001-10-17 03:57:20 +0000896
Jeremy Hylton9714f992001-10-16 21:19:45 +0000897 PyModule_AddIntConstant(m, "Z_FINISH", Z_FINISH);
898 PyModule_AddIntConstant(m, "Z_NO_FLUSH", Z_NO_FLUSH);
899 PyModule_AddIntConstant(m, "Z_SYNC_FLUSH", Z_SYNC_FLUSH);
900 PyModule_AddIntConstant(m, "Z_FULL_FLUSH", Z_FULL_FLUSH);
Tim Peters977e5402001-10-17 03:57:20 +0000901
Jeremy Hylton9714f992001-10-16 21:19:45 +0000902 ver = PyString_FromString(ZLIB_VERSION);
Fred Drake4baedc12002-04-01 14:53:37 +0000903 if (ver != NULL)
904 PyModule_AddObject(m, "ZLIB_VERSION", ver);
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000905
Guido van Rossum7d9ea502003-02-03 20:45:52 +0000906 PyModule_AddStringConstant(m, "__version__", "1.0");
907
Martin v. Löwis3bd8c1e2001-09-07 16:27:31 +0000908#ifdef WITH_THREAD
Jeremy Hylton9714f992001-10-16 21:19:45 +0000909 zlib_lock = PyThread_allocate_lock();
Sjoerd Mullender556a9382002-03-11 09:20:47 +0000910#endif /* WITH_THREAD */
Guido van Rossumfb221561997-04-29 15:38:09 +0000911}