1/*
2   +----------------------------------------------------------------------+
3   | PHP Version 7                                                        |
4   +----------------------------------------------------------------------+
5   | Copyright (c) 1997-2015 The PHP Group                                |
6   +----------------------------------------------------------------------+
7   | This source file is subject to version 3.01 of the PHP license,      |
8   | that is bundled with this package in the file LICENSE, and is        |
9   | available through the world-wide-web at the following url:           |
10   | http://www.php.net/license/3_01.txt                                  |
11   | If you did not receive a copy of the PHP license and are unable to   |
12   | obtain it through the world-wide-web, please send a note to          |
13   | license@php.net so we can mail you a copy immediately.               |
14   +----------------------------------------------------------------------+
15   | Authors: Sara Golemon (pollita@php.net)                              |
16   +----------------------------------------------------------------------+
17*/
18
19/* $Id$ */
20
21#include "php.h"
22#include "php_zlib.h"
23
24/* {{{ data structure */
25
26/* Passed as opaque in malloc callbacks */
27typedef struct _php_zlib_filter_data {
28    z_stream strm;
29    char *inbuf;
30    size_t inbuf_len;
31    char *outbuf;
32    size_t outbuf_len;
33    int persistent;
34    zend_bool finished;
35} php_zlib_filter_data;
36
37/* }}} */
38
39/* {{{ Memory management wrappers */
40
41static voidpf php_zlib_alloc(voidpf opaque, uInt items, uInt size)
42{
43    return (voidpf)safe_pemalloc(items, size, 0, ((php_zlib_filter_data*)opaque)->persistent);
44}
45
46static void php_zlib_free(voidpf opaque, voidpf address)
47{
48    pefree((void*)address, ((php_zlib_filter_data*)opaque)->persistent);
49}
50/* }}} */
51
52/* {{{ zlib.inflate filter implementation */
53
54static php_stream_filter_status_t php_zlib_inflate_filter(
55    php_stream *stream,
56    php_stream_filter *thisfilter,
57    php_stream_bucket_brigade *buckets_in,
58    php_stream_bucket_brigade *buckets_out,
59    size_t *bytes_consumed,
60    int flags
61    )
62{
63    php_zlib_filter_data *data;
64    php_stream_bucket *bucket;
65    size_t consumed = 0;
66    int status;
67    php_stream_filter_status_t exit_status = PSFS_FEED_ME;
68
69    if (!thisfilter || !Z_PTR(thisfilter->abstract)) {
70        /* Should never happen */
71        return PSFS_ERR_FATAL;
72    }
73
74    data = (php_zlib_filter_data *)(Z_PTR(thisfilter->abstract));
75
76    while (buckets_in->head) {
77        size_t bin = 0, desired;
78
79        bucket = php_stream_bucket_make_writeable(buckets_in->head);
80
81        while (bin < (unsigned int) bucket->buflen) {
82
83            if (data->finished) {
84                consumed += bucket->buflen;
85                break;
86            }
87
88            desired = bucket->buflen - bin;
89            if (desired > data->inbuf_len) {
90                desired = data->inbuf_len;
91            }
92            memcpy(data->strm.next_in, bucket->buf + bin, desired);
93            data->strm.avail_in = desired;
94
95            status = inflate(&(data->strm), flags & PSFS_FLAG_FLUSH_CLOSE ? Z_FINISH : Z_SYNC_FLUSH);
96            if (status == Z_STREAM_END) {
97                inflateEnd(&(data->strm));
98                data->finished = '\1';
99            } else if (status != Z_OK) {
100                /* Something bad happened */
101                php_stream_bucket_delref(bucket);
102                /* reset these because despite the error the filter may be used again */
103                data->strm.next_in = data->inbuf;
104                data->strm.avail_in = 0;
105                return PSFS_ERR_FATAL;
106            }
107            desired -= data->strm.avail_in; /* desired becomes what we consumed this round through */
108            data->strm.next_in = data->inbuf;
109            data->strm.avail_in = 0;
110            bin += desired;
111
112            if (data->strm.avail_out < data->outbuf_len) {
113                php_stream_bucket *out_bucket;
114                size_t bucketlen = data->outbuf_len - data->strm.avail_out;
115                out_bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0);
116                php_stream_bucket_append(buckets_out, out_bucket);
117                data->strm.avail_out = data->outbuf_len;
118                data->strm.next_out = data->outbuf;
119                exit_status = PSFS_PASS_ON;
120            } else if (status == Z_STREAM_END && data->strm.avail_out >= data->outbuf_len) {
121                /* no more data to decompress, and nothing was spat out */
122                php_stream_bucket_delref(bucket);
123                return PSFS_PASS_ON;
124            }
125
126        }
127        consumed += bucket->buflen;
128        php_stream_bucket_delref(bucket);
129    }
130
131    if (!data->finished && flags & PSFS_FLAG_FLUSH_CLOSE) {
132        /* Spit it out! */
133        status = Z_OK;
134        while (status == Z_OK) {
135            status = inflate(&(data->strm), Z_FINISH);
136            if (data->strm.avail_out < data->outbuf_len) {
137                size_t bucketlen = data->outbuf_len - data->strm.avail_out;
138
139                bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0);
140                php_stream_bucket_append(buckets_out, bucket);
141                data->strm.avail_out = data->outbuf_len;
142                data->strm.next_out = data->outbuf;
143                exit_status = PSFS_PASS_ON;
144            }
145        }
146    }
147
148    if (bytes_consumed) {
149        *bytes_consumed = consumed;
150    }
151
152    return exit_status;
153}
154
155static void php_zlib_inflate_dtor(php_stream_filter *thisfilter)
156{
157    if (thisfilter && Z_PTR(thisfilter->abstract)) {
158        php_zlib_filter_data *data = Z_PTR(thisfilter->abstract);
159        if (!data->finished) {
160            inflateEnd(&(data->strm));
161        }
162        pefree(data->inbuf, data->persistent);
163        pefree(data->outbuf, data->persistent);
164        pefree(data, data->persistent);
165    }
166}
167
168static php_stream_filter_ops php_zlib_inflate_ops = {
169    php_zlib_inflate_filter,
170    php_zlib_inflate_dtor,
171    "zlib.inflate"
172};
173/* }}} */
174
175/* {{{ zlib.inflate filter implementation */
176
177static php_stream_filter_status_t php_zlib_deflate_filter(
178    php_stream *stream,
179    php_stream_filter *thisfilter,
180    php_stream_bucket_brigade *buckets_in,
181    php_stream_bucket_brigade *buckets_out,
182    size_t *bytes_consumed,
183    int flags
184    )
185{
186    php_zlib_filter_data *data;
187    php_stream_bucket *bucket;
188    size_t consumed = 0;
189    int status;
190    php_stream_filter_status_t exit_status = PSFS_FEED_ME;
191
192    if (!thisfilter || !Z_PTR(thisfilter->abstract)) {
193        /* Should never happen */
194        return PSFS_ERR_FATAL;
195    }
196
197    data = (php_zlib_filter_data *)(Z_PTR(thisfilter->abstract));
198
199    while (buckets_in->head) {
200        size_t bin = 0, desired;
201
202        bucket = buckets_in->head;
203
204        bucket = php_stream_bucket_make_writeable(bucket);
205
206        while (bin < (unsigned int) bucket->buflen) {
207            desired = bucket->buflen - bin;
208            if (desired > data->inbuf_len) {
209                desired = data->inbuf_len;
210            }
211            memcpy(data->strm.next_in, bucket->buf + bin, desired);
212            data->strm.avail_in = desired;
213
214            status = deflate(&(data->strm), flags & PSFS_FLAG_FLUSH_CLOSE ? Z_FULL_FLUSH : (flags & PSFS_FLAG_FLUSH_INC ? Z_SYNC_FLUSH : Z_NO_FLUSH));
215            if (status != Z_OK) {
216                /* Something bad happened */
217                php_stream_bucket_delref(bucket);
218                return PSFS_ERR_FATAL;
219            }
220            desired -= data->strm.avail_in; /* desired becomes what we consumed this round through */
221            data->strm.next_in = data->inbuf;
222            data->strm.avail_in = 0;
223            bin += desired;
224
225            if (data->strm.avail_out < data->outbuf_len) {
226                php_stream_bucket *out_bucket;
227                size_t bucketlen = data->outbuf_len - data->strm.avail_out;
228
229                out_bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0);
230                php_stream_bucket_append(buckets_out, out_bucket);
231                data->strm.avail_out = data->outbuf_len;
232                data->strm.next_out = data->outbuf;
233                exit_status = PSFS_PASS_ON;
234            }
235        }
236        consumed += bucket->buflen;
237        php_stream_bucket_delref(bucket);
238    }
239
240    if (flags & PSFS_FLAG_FLUSH_CLOSE) {
241        /* Spit it out! */
242        status = Z_OK;
243        while (status == Z_OK) {
244            status = deflate(&(data->strm), Z_FINISH);
245            if (data->strm.avail_out < data->outbuf_len) {
246                size_t bucketlen = data->outbuf_len - data->strm.avail_out;
247
248                bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0);
249                php_stream_bucket_append(buckets_out, bucket);
250                data->strm.avail_out = data->outbuf_len;
251                data->strm.next_out = data->outbuf;
252                exit_status = PSFS_PASS_ON;
253            }
254        }
255    }
256
257    if (bytes_consumed) {
258        *bytes_consumed = consumed;
259    }
260
261    return exit_status;
262}
263
264static void php_zlib_deflate_dtor(php_stream_filter *thisfilter)
265{
266    if (thisfilter && Z_PTR(thisfilter->abstract)) {
267        php_zlib_filter_data *data = Z_PTR(thisfilter->abstract);
268        deflateEnd(&(data->strm));
269        pefree(data->inbuf, data->persistent);
270        pefree(data->outbuf, data->persistent);
271        pefree(data, data->persistent);
272    }
273}
274
275static php_stream_filter_ops php_zlib_deflate_ops = {
276    php_zlib_deflate_filter,
277    php_zlib_deflate_dtor,
278    "zlib.deflate"
279};
280
281/* }}} */
282
283/* {{{ zlib.* common factory */
284
285static php_stream_filter *php_zlib_filter_create(const char *filtername, zval *filterparams, int persistent)
286{
287    php_stream_filter_ops *fops = NULL;
288    php_zlib_filter_data *data;
289    int status;
290
291    /* Create this filter */
292    data = pecalloc(1, sizeof(php_zlib_filter_data), persistent);
293    if (!data) {
294        php_error_docref(NULL, E_WARNING, "Failed allocating %zd bytes", sizeof(php_zlib_filter_data));
295        return NULL;
296    }
297
298    /* Circular reference */
299    data->strm.opaque = (voidpf) data;
300
301    data->strm.zalloc = (alloc_func) php_zlib_alloc;
302    data->strm.zfree = (free_func) php_zlib_free;
303    data->strm.avail_out = data->outbuf_len = data->inbuf_len = 0x8000;
304    data->strm.next_in = data->inbuf = (Bytef *) pemalloc(data->inbuf_len, persistent);
305    if (!data->inbuf) {
306        php_error_docref(NULL, E_WARNING, "Failed allocating %zd bytes", data->inbuf_len);
307        pefree(data, persistent);
308        return NULL;
309    }
310    data->strm.avail_in = 0;
311    data->strm.next_out = data->outbuf = (Bytef *) pemalloc(data->outbuf_len, persistent);
312    if (!data->outbuf) {
313        php_error_docref(NULL, E_WARNING, "Failed allocating %zd bytes", data->outbuf_len);
314        pefree(data->inbuf, persistent);
315        pefree(data, persistent);
316        return NULL;
317    }
318
319    data->strm.data_type = Z_ASCII;
320
321    if (strcasecmp(filtername, "zlib.inflate") == 0) {
322        int windowBits = -MAX_WBITS;
323
324        if (filterparams) {
325            zval *tmpzval;
326
327            if ((Z_TYPE_P(filterparams) == IS_ARRAY || Z_TYPE_P(filterparams) == IS_OBJECT) &&
328                (tmpzval = zend_hash_str_find(HASH_OF(filterparams), "window", sizeof("window") - 1))) {
329                /* log-2 base of history window (9 - 15) */
330                zend_long tmp = zval_get_long(tmpzval);
331                if (tmp < -MAX_WBITS || tmp > MAX_WBITS + 32) {
332                    php_error_docref(NULL, E_WARNING, "Invalid parameter give for window size. (%pd)", tmp);
333                } else {
334                    windowBits = tmp;
335                }
336            }
337        }
338
339        /* RFC 1951 Inflate */
340        data->finished = '\0';
341        status = inflateInit2(&(data->strm), windowBits);
342        fops = &php_zlib_inflate_ops;
343    } else if (strcasecmp(filtername, "zlib.deflate") == 0) {
344        /* RFC 1951 Deflate */
345        int level = Z_DEFAULT_COMPRESSION;
346        int windowBits = -MAX_WBITS;
347        int memLevel = MAX_MEM_LEVEL;
348
349
350        if (filterparams) {
351            zval *tmpzval;
352            zend_long tmp;
353
354            /* filterparams can either be a scalar value to indicate compression level (shortcut method)
355               Or can be a hash containing one or more of 'window', 'memory', and/or 'level' members. */
356
357            switch (Z_TYPE_P(filterparams)) {
358                case IS_ARRAY:
359                case IS_OBJECT:
360                    if ((tmpzval = zend_hash_str_find(HASH_OF(filterparams), "memory", sizeof("memory") -1))) {
361                        /* Memory Level (1 - 9) */
362                        tmp = zval_get_long(tmpzval);
363                        if (tmp < 1 || tmp > MAX_MEM_LEVEL) {
364                            php_error_docref(NULL, E_WARNING, "Invalid parameter give for memory level. (%pd)", tmp);
365                        } else {
366                            memLevel = tmp;
367                        }
368                    }
369
370                    if ((tmpzval = zend_hash_str_find(HASH_OF(filterparams), "window", sizeof("window") - 1))) {
371                        /* log-2 base of history window (9 - 15) */
372                        tmp = zval_get_long(tmpzval);
373                        if (tmp < -MAX_WBITS || tmp > MAX_WBITS + 16) {
374                            php_error_docref(NULL, E_WARNING, "Invalid parameter give for window size. (%pd)", tmp);
375                        } else {
376                            windowBits = tmp;
377                        }
378                    }
379
380                    if ((tmpzval = zend_hash_str_find(HASH_OF(filterparams), "level", sizeof("level") - 1))) {
381                        tmp = zval_get_long(tmpzval);
382
383                        /* Pseudo pass through to catch level validating code */
384                        goto factory_setlevel;
385                    }
386                    break;
387                case IS_STRING:
388                case IS_DOUBLE:
389                case IS_LONG:
390                    tmp = zval_get_long(filterparams);
391factory_setlevel:
392                    /* Set compression level within reason (-1 == default, 0 == none, 1-9 == least to most compression */
393                    if (tmp < -1 || tmp > 9) {
394                        php_error_docref(NULL, E_WARNING, "Invalid compression level specified. (%pd)", tmp);
395                    } else {
396                        level = tmp;
397                    }
398                    break;
399                default:
400                    php_error_docref(NULL, E_WARNING, "Invalid filter parameter, ignored");
401            }
402        }
403        status = deflateInit2(&(data->strm), level, Z_DEFLATED, windowBits, memLevel, 0);
404        fops = &php_zlib_deflate_ops;
405    } else {
406        status = Z_DATA_ERROR;
407    }
408
409    if (status != Z_OK) {
410        /* Unspecified (probably strm) error, let stream-filter error do its own whining */
411        pefree(data->strm.next_in, persistent);
412        pefree(data->strm.next_out, persistent);
413        pefree(data, persistent);
414        return NULL;
415    }
416
417    return php_stream_filter_alloc(fops, data, persistent);
418}
419
420php_stream_filter_factory php_zlib_filter_factory = {
421    php_zlib_filter_create
422};
423/* }}} */
424
425/*
426 * Local variables:
427 * tab-width: 4
428 * c-basic-offset: 4
429 * End:
430 * vim600: sw=4 ts=4 fdm=marker
431 * vim<600: sw=4 ts=4
432 */
433