1/*
2  +----------------------------------------------------------------------+
3  | PHP Version 5                                                        |
4  +----------------------------------------------------------------------+
5  | Copyright (c) 1997-2014 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  | Author: Sterling Hughes <sterling@php.net>                           |
16  +----------------------------------------------------------------------+
17*/
18
19/* $Id$ */
20
21#ifdef HAVE_CONFIG_H
22#include "config.h"
23#endif
24
25#include "php.h"
26#include "php_bz2.h"
27
28#if HAVE_BZ2
29
30/* PHP Includes */
31#include "ext/standard/file.h"
32#include "ext/standard/info.h"
33#include "ext/standard/php_string.h"
34#include "main/php_network.h"
35
36/* for fileno() */
37#include <stdio.h>
38
39/* Internal error constants */
40#define PHP_BZ_ERRNO   0
41#define PHP_BZ_ERRSTR  1
42#define PHP_BZ_ERRBOTH 2
43
44static PHP_MINIT_FUNCTION(bz2);
45static PHP_MSHUTDOWN_FUNCTION(bz2);
46static PHP_MINFO_FUNCTION(bz2);
47static PHP_FUNCTION(bzopen);
48static PHP_FUNCTION(bzread);
49static PHP_FUNCTION(bzerrno);
50static PHP_FUNCTION(bzerrstr);
51static PHP_FUNCTION(bzerror);
52static PHP_FUNCTION(bzcompress);
53static PHP_FUNCTION(bzdecompress);
54
55/* {{{ arginfo */
56ZEND_BEGIN_ARG_INFO_EX(arginfo_bzread, 0, 0, 1)
57    ZEND_ARG_INFO(0, bz)
58    ZEND_ARG_INFO(0, length)
59ZEND_END_ARG_INFO()
60
61ZEND_BEGIN_ARG_INFO(arginfo_bzopen, 0)
62    ZEND_ARG_INFO(0, file)
63    ZEND_ARG_INFO(0, mode)
64ZEND_END_ARG_INFO()
65
66ZEND_BEGIN_ARG_INFO(arginfo_bzerrno, 0)
67    ZEND_ARG_INFO(0, bz)
68ZEND_END_ARG_INFO()
69
70ZEND_BEGIN_ARG_INFO(arginfo_bzerrstr, 0)
71    ZEND_ARG_INFO(0, bz)
72ZEND_END_ARG_INFO()
73
74ZEND_BEGIN_ARG_INFO(arginfo_bzerror, 0)
75    ZEND_ARG_INFO(0, bz)
76ZEND_END_ARG_INFO()
77
78ZEND_BEGIN_ARG_INFO_EX(arginfo_bzcompress, 0, 0, 2)
79    ZEND_ARG_INFO(0, source)
80    ZEND_ARG_INFO(0, blocksize)
81    ZEND_ARG_INFO(0, workfactor)
82ZEND_END_ARG_INFO()
83
84ZEND_BEGIN_ARG_INFO_EX(arginfo_bzdecompress, 0, 0, 1)
85    ZEND_ARG_INFO(0, source)
86    ZEND_ARG_INFO(0, small)
87ZEND_END_ARG_INFO()
88
89ZEND_BEGIN_ARG_INFO_EX(arginfo_bzwrite, 0, 0, 2)
90    ZEND_ARG_INFO(0, fp)
91    ZEND_ARG_INFO(0, str)
92    ZEND_ARG_INFO(0, length)
93ZEND_END_ARG_INFO()
94
95ZEND_BEGIN_ARG_INFO(arginfo_bzflush, 0)
96    ZEND_ARG_INFO(0, fp)
97ZEND_END_ARG_INFO()
98/* }}} */
99
100static const zend_function_entry bz2_functions[] = {
101    PHP_FE(bzopen,       arginfo_bzopen)
102    PHP_FE(bzread,       arginfo_bzread)
103    PHP_FALIAS(bzwrite,   fwrite,       arginfo_bzwrite)
104    PHP_FALIAS(bzflush,   fflush,       arginfo_bzflush)
105    PHP_FALIAS(bzclose,   fclose,       arginfo_bzflush)
106    PHP_FE(bzerrno,      arginfo_bzerrno)
107    PHP_FE(bzerrstr,     arginfo_bzerrstr)
108    PHP_FE(bzerror,      arginfo_bzerror)
109    PHP_FE(bzcompress,   arginfo_bzcompress)
110    PHP_FE(bzdecompress, arginfo_bzdecompress)
111    PHP_FE_END
112};
113
114zend_module_entry bz2_module_entry = {
115    STANDARD_MODULE_HEADER,
116    "bz2",
117    bz2_functions,
118    PHP_MINIT(bz2),
119    PHP_MSHUTDOWN(bz2),
120    NULL,
121    NULL,
122    PHP_MINFO(bz2),
123    NO_VERSION_YET,
124    STANDARD_MODULE_PROPERTIES
125};
126
127#ifdef COMPILE_DL_BZ2
128ZEND_GET_MODULE(bz2)
129#endif
130
131struct php_bz2_stream_data_t {
132    BZFILE *bz_file;
133    php_stream *stream;
134};
135
136/* {{{ BZip2 stream implementation */
137
138static size_t php_bz2iop_read(php_stream *stream, char *buf, size_t count TSRMLS_DC)
139{
140    struct php_bz2_stream_data_t *self = (struct php_bz2_stream_data_t *)stream->abstract;
141    size_t ret;
142
143    ret = BZ2_bzread(self->bz_file, buf, count);
144
145    if (ret == 0) {
146        stream->eof = 1;
147    }
148
149    return ret;
150}
151
152static size_t php_bz2iop_write(php_stream *stream, const char *buf, size_t count TSRMLS_DC)
153{
154    struct php_bz2_stream_data_t *self = (struct php_bz2_stream_data_t *)stream->abstract;
155
156    return BZ2_bzwrite(self->bz_file, (char*)buf, count);
157}
158
159static int php_bz2iop_close(php_stream *stream, int close_handle TSRMLS_DC)
160{
161    struct php_bz2_stream_data_t *self = (struct php_bz2_stream_data_t *)stream->abstract;
162    int ret = EOF;
163
164    if (close_handle) {
165        BZ2_bzclose(self->bz_file);
166    }
167
168    if (self->stream) {
169        php_stream_free(self->stream, PHP_STREAM_FREE_CLOSE | (close_handle == 0 ? PHP_STREAM_FREE_PRESERVE_HANDLE : 0));
170    }
171
172    efree(self);
173
174    return ret;
175}
176
177static int php_bz2iop_flush(php_stream *stream TSRMLS_DC)
178{
179    struct php_bz2_stream_data_t *self = (struct php_bz2_stream_data_t *)stream->abstract;
180    return BZ2_bzflush(self->bz_file);
181}
182/* }}} */
183
184php_stream_ops php_stream_bz2io_ops = {
185    php_bz2iop_write, php_bz2iop_read,
186    php_bz2iop_close, php_bz2iop_flush,
187    "BZip2",
188    NULL, /* seek */
189    NULL, /* cast */
190    NULL, /* stat */
191    NULL  /* set_option */
192};
193
194/* {{{ Bzip2 stream openers */
195PHP_BZ2_API php_stream *_php_stream_bz2open_from_BZFILE(BZFILE *bz,
196                                                        const char *mode, php_stream *innerstream STREAMS_DC TSRMLS_DC)
197{
198    struct php_bz2_stream_data_t *self;
199
200    self = emalloc(sizeof(*self));
201
202    self->stream = innerstream;
203    self->bz_file = bz;
204
205    return php_stream_alloc_rel(&php_stream_bz2io_ops, self, 0, mode);
206}
207
208PHP_BZ2_API php_stream *_php_stream_bz2open(php_stream_wrapper *wrapper,
209                                            const char *path,
210                                            const char *mode,
211                                            int options,
212                                            char **opened_path,
213                                            php_stream_context *context STREAMS_DC TSRMLS_DC)
214{
215    php_stream *retstream = NULL, *stream = NULL;
216    char *path_copy = NULL;
217    BZFILE *bz_file = NULL;
218
219    if (strncasecmp("compress.bzip2://", path, 17) == 0) {
220        path += 17;
221    }
222    if (mode[0] == '\0' || (mode[0] != 'w' && mode[0] != 'r' && mode[1] != '\0')) {
223        return NULL;
224    }
225
226#ifdef VIRTUAL_DIR
227    virtual_filepath_ex(path, &path_copy, NULL TSRMLS_CC);
228#else
229    path_copy = path;
230#endif
231
232    if (php_check_open_basedir(path_copy TSRMLS_CC)) {
233#ifdef VIRTUAL_DIR
234        efree(path_copy);
235#endif
236        return NULL;
237    }
238
239    /* try and open it directly first */
240    bz_file = BZ2_bzopen(path_copy, mode);
241
242    if (opened_path && bz_file) {
243#ifdef VIRTUAL_DIR
244        *opened_path = path_copy;
245        path_copy = NULL;
246#else
247        *opened_path = estrdup(path_copy);
248#endif
249    }
250
251#ifdef VIRTUAL_DIR
252    if (path_copy) {
253        efree(path_copy);
254    }
255#endif
256    path_copy = NULL;
257
258    if (bz_file == NULL) {
259        /* that didn't work, so try and get something from the network/wrapper */
260        stream = php_stream_open_wrapper(path, mode, options | STREAM_WILL_CAST, opened_path);
261
262        if (stream) {
263            php_socket_t fd;
264            if (SUCCESS == php_stream_cast(stream, PHP_STREAM_AS_FD, (void **) &fd, REPORT_ERRORS)) {
265                bz_file = BZ2_bzdopen(fd, mode);
266            }
267        }
268
269        /* remove the file created by php_stream_open_wrapper(), it is not needed since BZ2 functions
270         * failed.
271         */
272        if (opened_path && !bz_file && mode[0] == 'w') {
273            VCWD_UNLINK(*opened_path);
274        }
275    }
276
277    if (bz_file) {
278        retstream = _php_stream_bz2open_from_BZFILE(bz_file, mode, stream STREAMS_REL_CC TSRMLS_CC);
279        if (retstream) {
280            return retstream;
281        }
282
283        BZ2_bzclose(bz_file);
284    }
285
286    if (stream) {
287        php_stream_close(stream);
288    }
289
290    return NULL;
291}
292
293/* }}} */
294
295static php_stream_wrapper_ops bzip2_stream_wops = {
296    _php_stream_bz2open,
297    NULL, /* close */
298    NULL, /* fstat */
299    NULL, /* stat */
300    NULL, /* opendir */
301    "BZip2",
302    NULL, /* unlink */
303    NULL, /* rename */
304    NULL, /* mkdir */
305    NULL  /* rmdir */
306};
307
308static php_stream_wrapper php_stream_bzip2_wrapper = {
309    &bzip2_stream_wops,
310    NULL,
311    0 /* is_url */
312};
313
314static void php_bz2_error(INTERNAL_FUNCTION_PARAMETERS, int);
315
316static PHP_MINIT_FUNCTION(bz2)
317{
318    php_register_url_stream_wrapper("compress.bzip2", &php_stream_bzip2_wrapper TSRMLS_CC);
319    php_stream_filter_register_factory("bzip2.*", &php_bz2_filter_factory TSRMLS_CC);
320    return SUCCESS;
321}
322
323static PHP_MSHUTDOWN_FUNCTION(bz2)
324{
325    php_unregister_url_stream_wrapper("compress.bzip2" TSRMLS_CC);
326    php_stream_filter_unregister_factory("bzip2.*" TSRMLS_CC);
327
328    return SUCCESS;
329}
330
331static PHP_MINFO_FUNCTION(bz2)
332{
333    php_info_print_table_start();
334    php_info_print_table_row(2, "BZip2 Support", "Enabled");
335    php_info_print_table_row(2, "Stream Wrapper support", "compress.bzip2://");
336    php_info_print_table_row(2, "Stream Filter support", "bzip2.decompress, bzip2.compress");
337    php_info_print_table_row(2, "BZip2 Version", (char *) BZ2_bzlibVersion());
338    php_info_print_table_end();
339}
340
341/* {{{ proto string bzread(resource bz[, int length])
342   Reads up to length bytes from a BZip2 stream, or 1024 bytes if length is not specified */
343static PHP_FUNCTION(bzread)
344{
345    zval *bz;
346    zend_long len = 1024;
347    php_stream *stream;
348    zend_string *data;
349
350    if (FAILURE == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r|l", &bz, &len)) {
351        RETURN_FALSE;
352    }
353
354    php_stream_from_zval(stream, bz);
355
356    if ((len + 1) < 1) {
357        php_error_docref(NULL TSRMLS_CC, E_WARNING, "length may not be negative");
358        RETURN_FALSE;
359    }
360    data = zend_string_alloc(len, 0);
361    data->len = php_stream_read(stream, data->val, data->len);
362
363    if (data->len < 0) {
364        zend_string_free(data);
365        php_error_docref(NULL TSRMLS_CC, E_WARNING, "could not read valid bz2 data from stream");
366        RETURN_FALSE;
367    }
368    data->val[data->len] = '\0';
369
370    RETURN_STR(data);
371}
372/* }}} */
373
374/* {{{ proto resource bzopen(string|int file|fp, string mode)
375   Opens a new BZip2 stream */
376static PHP_FUNCTION(bzopen)
377{
378    zval     *file;   /* The file to open */
379    char     *mode;   /* The mode to open the stream with */
380    size_t      mode_len;
381
382    BZFILE   *bz;     /* The compressed file stream */
383    php_stream *stream = NULL;
384
385    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zs", &file, &mode, &mode_len) == FAILURE) {
386        return;
387    }
388
389    if (mode_len != 1 || (mode[0] != 'r' && mode[0] != 'w')) {
390        php_error_docref(NULL TSRMLS_CC, E_WARNING, "'%s' is not a valid mode for bzopen(). Only 'w' and 'r' are supported.", mode);
391        RETURN_FALSE;
392    }
393
394    /* If it's not a resource its a string containing the filename to open */
395    if (Z_TYPE_P(file) == IS_STRING) {
396        if (Z_STRLEN_P(file) == 0) {
397            php_error_docref(NULL TSRMLS_CC, E_WARNING, "filename cannot be empty");
398            RETURN_FALSE;
399        }
400
401        if (CHECK_ZVAL_NULL_PATH(file)) {
402            RETURN_FALSE;
403        }
404
405        stream = php_stream_bz2open(NULL, Z_STRVAL_P(file), mode, REPORT_ERRORS, NULL);
406    } else if (Z_TYPE_P(file) == IS_RESOURCE) {
407        /* If it is a resource, than its a stream resource */
408        php_socket_t fd;
409        size_t stream_mode_len;
410
411        php_stream_from_zval(stream, file);
412        stream_mode_len = strlen(stream->mode);
413
414        if (stream_mode_len != 1 && !(stream_mode_len == 2 && memchr(stream->mode, 'b', 2))) {
415            php_error_docref(NULL TSRMLS_CC, E_WARNING, "cannot use stream opened in mode '%s'", stream->mode);
416            RETURN_FALSE;
417        } else if (stream_mode_len == 1 && stream->mode[0] != 'r' && stream->mode[0] != 'w' && stream->mode[0] != 'a' && stream->mode[0] != 'x') {
418            php_error_docref(NULL TSRMLS_CC, E_WARNING, "cannot use stream opened in mode '%s'", stream->mode);
419            RETURN_FALSE;
420        }
421
422        switch(mode[0]) {
423            case 'r':
424                /* only "r" and "rb" are supported */
425                if (stream->mode[0] != mode[0] && !(stream_mode_len == 2 && stream->mode[1] != mode[0])) {
426                    php_error_docref(NULL TSRMLS_CC, E_WARNING, "cannot read from a stream opened in write only mode");
427                    RETURN_FALSE;
428                }
429                break;
430            case 'w':
431                /* support only "w"(b), "a"(b), "x"(b) */
432                if (stream->mode[0] != mode[0] && !(stream_mode_len == 2 && stream->mode[1] != mode[0])
433                    && stream->mode[0] != 'a' && !(stream_mode_len == 2 && stream->mode[1] != 'a')
434                    && stream->mode[0] != 'x' && !(stream_mode_len == 2 && stream->mode[1] != 'x')) {
435                    php_error_docref(NULL TSRMLS_CC, E_WARNING, "cannot write to a stream opened in read only mode");
436                    RETURN_FALSE;
437                }
438                break;
439            default:
440                /* not reachable */
441                break;
442        }
443
444        if (FAILURE == php_stream_cast(stream, PHP_STREAM_AS_FD, (void *) &fd, REPORT_ERRORS)) {
445            RETURN_FALSE;
446        }
447
448        bz = BZ2_bzdopen(fd, mode);
449
450        stream = php_stream_bz2open_from_BZFILE(bz, mode, stream);
451    } else {
452        php_error_docref(NULL TSRMLS_CC, E_WARNING, "first parameter has to be string or file-resource");
453        RETURN_FALSE;
454    }
455
456    if (stream) {
457        php_stream_to_zval(stream, return_value);
458    } else {
459        RETURN_FALSE;
460    }
461}
462/* }}} */
463
464/* {{{ proto int bzerrno(resource bz)
465   Returns the error number */
466static PHP_FUNCTION(bzerrno)
467{
468    php_bz2_error(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHP_BZ_ERRNO);
469}
470/* }}} */
471
472/* {{{ proto string bzerrstr(resource bz)
473   Returns the error string */
474static PHP_FUNCTION(bzerrstr)
475{
476    php_bz2_error(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHP_BZ_ERRSTR);
477}
478/* }}} */
479
480/* {{{ proto array bzerror(resource bz)
481   Returns the error number and error string in an associative array */
482static PHP_FUNCTION(bzerror)
483{
484    php_bz2_error(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHP_BZ_ERRBOTH);
485}
486/* }}} */
487
488/* {{{ proto string bzcompress(string source [, int blocksize100k [, int workfactor]])
489   Compresses a string into BZip2 encoded data */
490static PHP_FUNCTION(bzcompress)
491{
492    char             *source;          /* Source data to compress */
493    zend_long              zblock_size = 0; /* Optional block size to use */
494    zend_long              zwork_factor = 0;/* Optional work factor to use */
495    zend_string      *dest = NULL;     /* Destination to place the compressed data into */
496    int               error,           /* Error Container */
497                      block_size  = 4, /* Block size for compression algorithm */
498                      work_factor = 0, /* Work factor for compression algorithm */
499                      argc;            /* Argument count */
500    size_t               source_len;      /* Length of the source data */
501    unsigned int      dest_len;        /* Length of the destination buffer */
502
503    argc = ZEND_NUM_ARGS();
504
505    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ll", &source, &source_len, &zblock_size, &zwork_factor) == FAILURE) {
506        return;
507    }
508
509    /* Assign them to easy to use variables, dest_len is initially the length of the data
510       + .01 x length of data + 600 which is the largest size the results of the compression
511       could possibly be, at least that's what the libbz2 docs say (thanks to jeremy@nirvani.net
512       for pointing this out).  */
513    dest_len = (unsigned int) (source_len + (0.01 * source_len) + 600);
514
515    /* Allocate the destination buffer */
516    dest = zend_string_alloc(dest_len, 0);
517
518    /* Handle the optional arguments */
519    if (argc > 1) {
520        block_size = zblock_size;
521    }
522
523    if (argc > 2) {
524        work_factor = zwork_factor;
525    }
526
527    error = BZ2_bzBuffToBuffCompress(dest->val, &dest_len, source, source_len, block_size, 0, work_factor);
528    if (error != BZ_OK) {
529        zend_string_free(dest);
530        RETURN_LONG(error);
531    } else {
532        /* Copy the buffer, we have perhaps allocate a lot more than we need,
533           so we erealloc() the buffer to the proper size */
534        dest->len = dest_len;
535        dest->val[dest->len] = '\0';
536        RETURN_STR(dest);
537    }
538}
539/* }}} */
540
541/* {{{ proto string bzdecompress(string source [, int small])
542   Decompresses BZip2 compressed data */
543static PHP_FUNCTION(bzdecompress)
544{
545    char *source, *dest;
546    size_t source_len;
547    int error;
548    zend_long small = 0;
549#if defined(PHP_WIN32)
550    unsigned __int64 size = 0;
551#else
552    unsigned long long size = 0;
553#endif
554    bz_stream bzs;
555
556    if (FAILURE == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &source, &source_len, &small)) {
557        RETURN_FALSE;
558    }
559
560    bzs.bzalloc = NULL;
561    bzs.bzfree = NULL;
562
563    if (BZ2_bzDecompressInit(&bzs, 0, small) != BZ_OK) {
564        RETURN_FALSE;
565    }
566
567    bzs.next_in = source;
568    bzs.avail_in = source_len;
569
570    /* in most cases bz2 offers at least 2:1 compression, so we use that as our base */
571    bzs.avail_out = source_len * 2;
572    bzs.next_out = dest = emalloc(bzs.avail_out + 1);
573
574    while ((error = BZ2_bzDecompress(&bzs)) == BZ_OK && bzs.avail_in > 0) {
575        /* compression is better then 2:1, need to allocate more memory */
576        bzs.avail_out = source_len;
577        size = (bzs.total_out_hi32 * (unsigned int) -1) + bzs.total_out_lo32;
578        dest = safe_erealloc(dest, 1, bzs.avail_out+1, (size_t) size );
579        bzs.next_out = dest + size;
580    }
581
582    if (error == BZ_STREAM_END || error == BZ_OK) {
583        size = (bzs.total_out_hi32 * (unsigned int) -1) + bzs.total_out_lo32;
584        dest = safe_erealloc(dest, 1, (size_t) size, 1);
585        dest[size] = '\0';
586        RETVAL_STRINGL(dest, (int) size);
587        efree(dest);
588    } else { /* real error */
589        efree(dest);
590        RETVAL_LONG(error);
591    }
592
593    BZ2_bzDecompressEnd(&bzs);
594}
595/* }}} */
596
597/* {{{ php_bz2_error()
598   The central error handling interface, does the work for bzerrno, bzerrstr and bzerror */
599static void php_bz2_error(INTERNAL_FUNCTION_PARAMETERS, int opt)
600{
601    zval         *bzp;     /* BZip2 Resource Pointer */
602    php_stream   *stream;
603    const char   *errstr;  /* Error string */
604    int           errnum;  /* Error number */
605    struct php_bz2_stream_data_t *self;
606
607    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &bzp) == FAILURE) {
608        return;
609    }
610
611    php_stream_from_zval(stream, bzp);
612
613    if (!php_stream_is(stream, PHP_STREAM_IS_BZIP2)) {
614        RETURN_FALSE;
615    }
616
617    self = (struct php_bz2_stream_data_t *) stream->abstract;
618
619    /* Fetch the error information */
620    errstr = BZ2_bzerror(self->bz_file, &errnum);
621
622    /* Determine what to return */
623    switch (opt) {
624        case PHP_BZ_ERRNO:
625            RETURN_LONG(errnum);
626            break;
627        case PHP_BZ_ERRSTR:
628            RETURN_STRING((char*)errstr);
629            break;
630        case PHP_BZ_ERRBOTH:
631            array_init(return_value);
632
633            add_assoc_long  (return_value, "errno",  errnum);
634            add_assoc_string(return_value, "errstr", (char*)errstr);
635            break;
636    }
637}
638/* }}} */
639
640#endif
641
642/*
643 * Local variables:
644 * tab-width: 4
645 * c-basic-offset: 4
646 * End:
647 * vim600: fdm=marker
648 * vim: noet sw=4 ts=4
649 */
650