/* +----------------------------------------------------------------------+ | Copyright (c) The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 3.01 of the PHP license, | | that is bundled with this package in the file LICENSE, and is | | available through the world-wide-web at the following url: | | https://www.php.net/license/3_01.txt | | If you did not receive a copy of the PHP license and are unable to | | obtain it through the world-wide-web, please send a note to | | license@php.net so we can mail you a copy immediately. | +----------------------------------------------------------------------+ | Authors: Rasmus Lerdorf | | Stefan Röhrich | | Zeev Suraski | | Jade Nicoletti | | Michael Wallner | +----------------------------------------------------------------------+ */ #ifdef HAVE_CONFIG_H #include #endif #include "php.h" #include "SAPI.h" #include "php_ini.h" #include "ext/standard/info.h" #include "php_zlib.h" #include "zlib_arginfo.h" /* * zlib include files can define the following preprocessor defines which rename * the corresponding PHP functions to gzopen64, gzseek64 and gztell64 and thereby * breaking some software, most notably PEAR's Archive_Tar, which halts execution * without error message on gzip compressed archives. * * This only seems to happen on 32bit systems with large file support. */ #undef gzopen #undef gzseek #undef gztell ZEND_DECLARE_MODULE_GLOBALS(zlib) /* InflateContext class */ zend_class_entry *inflate_context_ce; static zend_object_handlers inflate_context_object_handlers; static inline php_zlib_context *inflate_context_from_obj(zend_object *obj) { return (php_zlib_context *)((char *)(obj) - XtOffsetOf(php_zlib_context, std)); } #define Z_INFLATE_CONTEXT_P(zv) inflate_context_from_obj(Z_OBJ_P(zv)) static zend_object *inflate_context_create_object(zend_class_entry *class_type) { php_zlib_context *intern = zend_object_alloc(sizeof(php_zlib_context), class_type); zend_object_std_init(&intern->std, class_type); object_properties_init(&intern->std, class_type); return &intern->std; } static zend_function *inflate_context_get_constructor(zend_object *object) { zend_throw_error(NULL, "Cannot directly construct InflateContext, use inflate_init() instead"); return NULL; } static void inflate_context_free_obj(zend_object *object) { php_zlib_context *intern = inflate_context_from_obj(object); if (intern->inflateDict) { efree(intern->inflateDict); } inflateEnd(&intern->Z); zend_object_std_dtor(&intern->std); } /* }}} */ /* DeflateContext class */ zend_class_entry *deflate_context_ce; static zend_object_handlers deflate_context_object_handlers; static inline php_zlib_context *deflate_context_from_obj(zend_object *obj) { return (php_zlib_context *)((char *)(obj) - XtOffsetOf(php_zlib_context, std)); } #define Z_DEFLATE_CONTEXT_P(zv) deflate_context_from_obj(Z_OBJ_P(zv)) static zend_object *deflate_context_create_object(zend_class_entry *class_type) { php_zlib_context *intern = zend_object_alloc(sizeof(php_zlib_context), class_type); zend_object_std_init(&intern->std, class_type); object_properties_init(&intern->std, class_type); return &intern->std; } static zend_function *deflate_context_get_constructor(zend_object *object) { zend_throw_error(NULL, "Cannot directly construct DeflateContext, use deflate_init() instead"); return NULL; } static void deflate_context_free_obj(zend_object *object) { php_zlib_context *intern = deflate_context_from_obj(object); deflateEnd(&intern->Z); zend_object_std_dtor(&intern->std); } /* }}} */ /* {{{ Memory management wrappers */ static voidpf php_zlib_alloc(voidpf opaque, uInt items, uInt size) { return (voidpf)safe_emalloc(items, size, 0); } static void php_zlib_free(voidpf opaque, voidpf address) { efree((void*)address); } /* }}} */ /* {{{ php_zlib_output_conflict_check() */ static zend_result php_zlib_output_conflict_check(const char *handler_name, size_t handler_name_len) { if (php_output_get_level() > 0) { if (php_output_handler_conflict(handler_name, handler_name_len, ZEND_STRL(PHP_ZLIB_OUTPUT_HANDLER_NAME)) || php_output_handler_conflict(handler_name, handler_name_len, ZEND_STRL("ob_gzhandler")) || php_output_handler_conflict(handler_name, handler_name_len, ZEND_STRL("mb_output_handler")) || php_output_handler_conflict(handler_name, handler_name_len, ZEND_STRL("URL-Rewriter"))) { return FAILURE; } } return SUCCESS; } /* }}} */ /* {{{ php_zlib_output_encoding() */ static int php_zlib_output_encoding(void) { zval *enc; if (!ZLIBG(compression_coding)) { if ((Z_TYPE(PG(http_globals)[TRACK_VARS_SERVER]) == IS_ARRAY || zend_is_auto_global(ZSTR_KNOWN(ZEND_STR_AUTOGLOBAL_SERVER))) && (enc = zend_hash_str_find(Z_ARRVAL(PG(http_globals)[TRACK_VARS_SERVER]), "HTTP_ACCEPT_ENCODING", sizeof("HTTP_ACCEPT_ENCODING") - 1))) { convert_to_string(enc); if (strstr(Z_STRVAL_P(enc), "gzip")) { ZLIBG(compression_coding) = PHP_ZLIB_ENCODING_GZIP; } else if (strstr(Z_STRVAL_P(enc), "deflate")) { ZLIBG(compression_coding) = PHP_ZLIB_ENCODING_DEFLATE; } } } return ZLIBG(compression_coding); } /* }}} */ /* {{{ php_zlib_output_handler_ex() */ static zend_result php_zlib_output_handler_ex(php_zlib_context *ctx, php_output_context *output_context) { int flags = Z_SYNC_FLUSH; if (output_context->op & PHP_OUTPUT_HANDLER_START) { /* start up */ if (Z_OK != deflateInit2(&ctx->Z, ZLIBG(output_compression_level), Z_DEFLATED, ZLIBG(compression_coding), MAX_MEM_LEVEL, Z_DEFAULT_STRATEGY)) { return FAILURE; } } if (output_context->op & PHP_OUTPUT_HANDLER_CLEAN) { /* free buffers */ deflateEnd(&ctx->Z); if (output_context->op & PHP_OUTPUT_HANDLER_FINAL) { /* discard */ return SUCCESS; } else { /* restart */ if (Z_OK != deflateInit2(&ctx->Z, ZLIBG(output_compression_level), Z_DEFLATED, ZLIBG(compression_coding), MAX_MEM_LEVEL, Z_DEFAULT_STRATEGY)) { return FAILURE; } ctx->buffer.used = 0; } } else { if (output_context->in.used) { /* append input */ if (ctx->buffer.free < output_context->in.used) { if (!(ctx->buffer.aptr = erealloc_recoverable(ctx->buffer.data, ctx->buffer.used + ctx->buffer.free + output_context->in.used))) { deflateEnd(&ctx->Z); return FAILURE; } ctx->buffer.data = ctx->buffer.aptr; ctx->buffer.free += output_context->in.used; } memcpy(ctx->buffer.data + ctx->buffer.used, output_context->in.data, output_context->in.used); ctx->buffer.free -= output_context->in.used; ctx->buffer.used += output_context->in.used; } output_context->out.size = PHP_ZLIB_BUFFER_SIZE_GUESS(output_context->in.used); output_context->out.data = emalloc(output_context->out.size); output_context->out.free = 1; output_context->out.used = 0; ctx->Z.avail_in = ctx->buffer.used; ctx->Z.next_in = (Bytef *) ctx->buffer.data; ctx->Z.avail_out = output_context->out.size; ctx->Z.next_out = (Bytef *) output_context->out.data; if (output_context->op & PHP_OUTPUT_HANDLER_FINAL) { flags = Z_FINISH; } else if (output_context->op & PHP_OUTPUT_HANDLER_FLUSH) { flags = Z_FULL_FLUSH; } switch (deflate(&ctx->Z, flags)) { case Z_OK: if (flags == Z_FINISH) { deflateEnd(&ctx->Z); return FAILURE; } ZEND_FALLTHROUGH; case Z_STREAM_END: if (ctx->Z.avail_in) { memmove(ctx->buffer.data, ctx->buffer.data + ctx->buffer.used - ctx->Z.avail_in, ctx->Z.avail_in); } ctx->buffer.free += ctx->buffer.used - ctx->Z.avail_in; ctx->buffer.used = ctx->Z.avail_in; output_context->out.used = output_context->out.size - ctx->Z.avail_out; break; default: deflateEnd(&ctx->Z); return FAILURE; } if (output_context->op & PHP_OUTPUT_HANDLER_FINAL) { deflateEnd(&ctx->Z); } } return SUCCESS; } /* }}} */ /* {{{ php_zlib_output_handler() */ static zend_result php_zlib_output_handler(void **handler_context, php_output_context *output_context) { php_zlib_context *ctx = *(php_zlib_context **) handler_context; if (!php_zlib_output_encoding()) { /* "Vary: Accept-Encoding" header sent along uncompressed content breaks caching in MSIE, so let's just send it with successfully compressed content or unless the complete buffer gets discarded, see http://bugs.php.net/40325; Test as follows: +Vary: $ HTTP_ACCEPT_ENCODING=gzip ./sapi/cgi/php <<<'op & PHP_OUTPUT_HANDLER_START) && (output_context->op != (PHP_OUTPUT_HANDLER_START|PHP_OUTPUT_HANDLER_CLEAN|PHP_OUTPUT_HANDLER_FINAL)) ) { sapi_add_header_ex(ZEND_STRL("Vary: Accept-Encoding"), 1, 0); } return FAILURE; } if (SUCCESS != php_zlib_output_handler_ex(ctx, output_context)) { return FAILURE; } if (!(output_context->op & PHP_OUTPUT_HANDLER_CLEAN) || ((output_context->op & PHP_OUTPUT_HANDLER_START) && !(output_context->op & PHP_OUTPUT_HANDLER_FINAL))) { int flags; if (SUCCESS == php_output_handler_hook(PHP_OUTPUT_HANDLER_HOOK_GET_FLAGS, &flags)) { /* only run this once */ if (!(flags & PHP_OUTPUT_HANDLER_STARTED)) { if (SG(headers_sent) || !ZLIBG(output_compression)) { deflateEnd(&ctx->Z); return FAILURE; } switch (ZLIBG(compression_coding)) { case PHP_ZLIB_ENCODING_GZIP: sapi_add_header_ex(ZEND_STRL("Content-Encoding: gzip"), 1, 1); break; case PHP_ZLIB_ENCODING_DEFLATE: sapi_add_header_ex(ZEND_STRL("Content-Encoding: deflate"), 1, 1); break; default: deflateEnd(&ctx->Z); return FAILURE; } sapi_add_header_ex(ZEND_STRL("Vary: Accept-Encoding"), 1, 0); php_output_handler_hook(PHP_OUTPUT_HANDLER_HOOK_IMMUTABLE, NULL); } } } return SUCCESS; } /* }}} */ /* {{{ php_zlib_output_handler_context_init() */ static php_zlib_context *php_zlib_output_handler_context_init(void) { php_zlib_context *ctx = (php_zlib_context *) ecalloc(1, sizeof(php_zlib_context)); ctx->Z.zalloc = php_zlib_alloc; ctx->Z.zfree = php_zlib_free; return ctx; } /* }}} */ /* {{{ php_zlib_output_handler_context_dtor() */ static void php_zlib_output_handler_context_dtor(void *opaq) { php_zlib_context *ctx = (php_zlib_context *) opaq; if (ctx) { if (ctx->buffer.data) { efree(ctx->buffer.data); } efree(ctx); } } /* }}} */ /* {{{ php_zlib_output_handler_init() */ static php_output_handler *php_zlib_output_handler_init(const char *handler_name, size_t handler_name_len, size_t chunk_size, int flags) { php_output_handler *h = NULL; if (!ZLIBG(output_compression)) { ZLIBG(output_compression) = chunk_size ? chunk_size : PHP_OUTPUT_HANDLER_DEFAULT_SIZE; } ZLIBG(handler_registered) = 1; if ((h = php_output_handler_create_internal(handler_name, handler_name_len, php_zlib_output_handler, chunk_size, flags))) { php_output_handler_set_context(h, php_zlib_output_handler_context_init(), php_zlib_output_handler_context_dtor); } return h; } /* }}} */ /* {{{ php_zlib_output_compression_start() */ static void php_zlib_output_compression_start(void) { zval zoh; php_output_handler *h; switch (ZLIBG(output_compression)) { case 0: break; case 1: ZLIBG(output_compression) = PHP_OUTPUT_HANDLER_DEFAULT_SIZE; ZEND_FALLTHROUGH; default: if ( php_zlib_output_encoding() && (h = php_zlib_output_handler_init(ZEND_STRL(PHP_ZLIB_OUTPUT_HANDLER_NAME), ZLIBG(output_compression), PHP_OUTPUT_HANDLER_STDFLAGS)) && (SUCCESS == php_output_handler_start(h))) { if (ZLIBG(output_handler) && *ZLIBG(output_handler)) { ZVAL_STRING(&zoh, ZLIBG(output_handler)); php_output_start_user(&zoh, ZLIBG(output_compression), PHP_OUTPUT_HANDLER_STDFLAGS); zval_ptr_dtor(&zoh); } } break; } } /* }}} */ /* {{{ php_zlib_encode() */ static zend_string *php_zlib_encode(const char *in_buf, size_t in_len, int encoding, int level) { int status; z_stream Z; zend_string *out; memset(&Z, 0, sizeof(z_stream)); Z.zalloc = php_zlib_alloc; Z.zfree = php_zlib_free; if (Z_OK == (status = deflateInit2(&Z, level, Z_DEFLATED, encoding, MAX_MEM_LEVEL, Z_DEFAULT_STRATEGY))) { out = zend_string_alloc(PHP_ZLIB_BUFFER_SIZE_GUESS(in_len), 0); Z.next_in = (Bytef *) in_buf; Z.next_out = (Bytef *) ZSTR_VAL(out); Z.avail_in = in_len; Z.avail_out = ZSTR_LEN(out); status = deflate(&Z, Z_FINISH); deflateEnd(&Z); if (Z_STREAM_END == status) { /* size buffer down to actual length */ out = zend_string_truncate(out, Z.total_out, 0); ZSTR_VAL(out)[ZSTR_LEN(out)] = '\0'; return out; } else { zend_string_efree(out); } } php_error_docref(NULL, E_WARNING, "%s", zError(status)); return NULL; } /* }}} */ /* {{{ php_zlib_inflate_rounds() */ static inline int php_zlib_inflate_rounds(z_stream *Z, size_t max, char **buf, size_t *len) { int status, round = 0; php_zlib_buffer buffer = {NULL, NULL, 0, 0, 0}; *buf = NULL; *len = 0; buffer.size = (max && (max < Z->avail_in)) ? max : Z->avail_in; do { if ((max && (max <= buffer.used)) || !(buffer.aptr = erealloc_recoverable(buffer.data, buffer.size))) { status = Z_MEM_ERROR; } else { buffer.data = buffer.aptr; Z->avail_out = buffer.free = buffer.size - buffer.used; Z->next_out = (Bytef *) buffer.data + buffer.used; #if 0 fprintf(stderr, "\n%3d: %3d PRIOR: size=%7lu,\tfree=%7lu,\tused=%7lu,\tavail_in=%7lu,\tavail_out=%7lu\n", round, status, buffer.size, buffer.free, buffer.used, Z->avail_in, Z->avail_out); #endif status = inflate(Z, Z_NO_FLUSH); buffer.used += buffer.free - Z->avail_out; buffer.free = Z->avail_out; #if 0 fprintf(stderr, "%3d: %3d AFTER: size=%7lu,\tfree=%7lu,\tused=%7lu,\tavail_in=%7lu,\tavail_out=%7lu\n", round, status, buffer.size, buffer.free, buffer.used, Z->avail_in, Z->avail_out); #endif buffer.size += (buffer.size >> 3) + 1; } } while ((Z_BUF_ERROR == status || (Z_OK == status && Z->avail_in)) && ++round < 100); if (status == Z_STREAM_END) { buffer.data = erealloc(buffer.data, buffer.used + 1); buffer.data[buffer.used] = '\0'; *buf = buffer.data; *len = buffer.used; } else { if (buffer.data) { efree(buffer.data); } /* HACK: See zlib/examples/zpipe.c inf() function for explanation. */ /* This works as long as this function is not used for streaming. Required to catch very short invalid data. */ status = (status == Z_OK) ? Z_DATA_ERROR : status; } return status; } /* }}} */ /* {{{ php_zlib_decode() */ static int php_zlib_decode(const char *in_buf, size_t in_len, char **out_buf, size_t *out_len, int encoding, size_t max_len) { int status = Z_DATA_ERROR; z_stream Z; memset(&Z, 0, sizeof(z_stream)); Z.zalloc = php_zlib_alloc; Z.zfree = php_zlib_free; if (in_len) { retry_raw_inflate: status = inflateInit2(&Z, encoding); if (Z_OK == status) { Z.next_in = (Bytef *) in_buf; Z.avail_in = in_len + 1; /* NOTE: data must be zero terminated */ switch (status = php_zlib_inflate_rounds(&Z, max_len, out_buf, out_len)) { case Z_STREAM_END: inflateEnd(&Z); return SUCCESS; case Z_DATA_ERROR: /* raw deflated data? */ if (PHP_ZLIB_ENCODING_ANY == encoding) { inflateEnd(&Z); encoding = PHP_ZLIB_ENCODING_RAW; goto retry_raw_inflate; } } inflateEnd(&Z); } } *out_buf = NULL; *out_len = 0; php_error_docref(NULL, E_WARNING, "%s", zError(status)); return FAILURE; } /* }}} */ /* {{{ php_zlib_cleanup_ob_gzhandler_mess() */ static void php_zlib_cleanup_ob_gzhandler_mess(void) { if (ZLIBG(ob_gzhandler)) { deflateEnd(&(ZLIBG(ob_gzhandler)->Z)); php_zlib_output_handler_context_dtor(ZLIBG(ob_gzhandler)); ZLIBG(ob_gzhandler) = NULL; } } /* }}} */ /* {{{ Legacy hack */ PHP_FUNCTION(ob_gzhandler) { char *in_str; size_t in_len; zend_long flags = 0; php_output_context ctx = {0}; int encoding; /* * NOTE that the real ob_gzhandler is an alias to "zlib output compression". * This is a really bad hack, because * - we have to initialize a php_zlib_context on demand * - we have to clean it up in RSHUTDOWN * - OG(running) is not set or set to any other output handler * - we have to mess around with php_output_context */ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "sl", &in_str, &in_len, &flags)) { RETURN_THROWS(); } if (!(encoding = php_zlib_output_encoding())) { RETURN_FALSE; } if (flags & PHP_OUTPUT_HANDLER_START) { switch (encoding) { case PHP_ZLIB_ENCODING_GZIP: sapi_add_header_ex(ZEND_STRL("Content-Encoding: gzip"), 1, 1); break; case PHP_ZLIB_ENCODING_DEFLATE: sapi_add_header_ex(ZEND_STRL("Content-Encoding: deflate"), 1, 1); break; } sapi_add_header_ex(ZEND_STRL("Vary: Accept-Encoding"), 1, 0); } if (!ZLIBG(ob_gzhandler)) { ZLIBG(ob_gzhandler) = php_zlib_output_handler_context_init(); } ctx.op = flags; ctx.in.data = in_str; ctx.in.used = in_len; zend_result rv = php_zlib_output_handler_ex(ZLIBG(ob_gzhandler), &ctx); if (SUCCESS != rv) { if (ctx.out.data && ctx.out.free) { efree(ctx.out.data); } php_zlib_cleanup_ob_gzhandler_mess(); RETURN_FALSE; } if (ctx.out.data) { RETVAL_STRINGL(ctx.out.data, ctx.out.used); if (ctx.out.free) { efree(ctx.out.data); } } else { RETVAL_EMPTY_STRING(); } } /* }}} */ /* {{{ Returns the coding type used for output compression */ PHP_FUNCTION(zlib_get_coding_type) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } switch (ZLIBG(compression_coding)) { case PHP_ZLIB_ENCODING_GZIP: RETURN_STRINGL("gzip", sizeof("gzip") - 1); case PHP_ZLIB_ENCODING_DEFLATE: RETURN_STRINGL("deflate", sizeof("deflate") - 1); default: RETURN_FALSE; } } /* }}} */ /* {{{ Read and uncompress entire .gz-file into an array */ PHP_FUNCTION(gzfile) { char *filename; size_t filename_len; int flags = REPORT_ERRORS; char buf[8192] = {0}; int i = 0; bool use_include_path = false; php_stream *stream; if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "p|b", &filename, &filename_len, &use_include_path)) { RETURN_THROWS(); } if (use_include_path) { flags |= USE_PATH; } /* using a stream here is a bit more efficient (resource wise) than php_gzopen_wrapper */ stream = php_stream_gzopen(NULL, filename, "rb", flags, NULL, NULL STREAMS_CC); if (!stream) { /* Error reporting is already done by stream code */ RETURN_FALSE; } /* Initialize return array */ array_init(return_value); /* Now loop through the file and do the magic quotes thing if needed */ memset(buf, 0, sizeof(buf)); while (php_stream_gets(stream, buf, sizeof(buf) - 1) != NULL) { add_index_string(return_value, i++, buf); } php_stream_close(stream); } /* }}} */ /* {{{ Open a .gz-file and return a .gz-file pointer */ PHP_FUNCTION(gzopen) { char *filename; char *mode; size_t filename_len, mode_len; int flags = REPORT_ERRORS; php_stream *stream; bool use_include_path = false; if (zend_parse_parameters(ZEND_NUM_ARGS(), "ps|b", &filename, &filename_len, &mode, &mode_len, &use_include_path) == FAILURE) { RETURN_THROWS(); } if (use_include_path) { flags |= USE_PATH; } stream = php_stream_gzopen(NULL, filename, mode, flags, NULL, NULL STREAMS_CC); if (!stream) { RETURN_FALSE; } php_stream_to_zval(stream, return_value); } /* }}} */ /* {{{ Output a .gz-file */ PHP_FUNCTION(readgzfile) { char *filename; size_t filename_len; int flags = REPORT_ERRORS; php_stream *stream; size_t size; bool use_include_path = false; if (zend_parse_parameters(ZEND_NUM_ARGS(), "p|b", &filename, &filename_len, &use_include_path) == FAILURE) { RETURN_THROWS(); } if (use_include_path) { flags |= USE_PATH; } stream = php_stream_gzopen(NULL, filename, "rb", flags, NULL, NULL STREAMS_CC); if (!stream) { RETURN_FALSE; } size = php_stream_passthru(stream); php_stream_close(stream); RETURN_LONG(size); } /* }}} */ #define PHP_ZLIB_ENCODE_FUNC(name, default_encoding) \ PHP_FUNCTION(name) \ { \ zend_string *in, *out; \ zend_long level = -1; \ zend_long encoding = default_encoding; \ if (default_encoding) { \ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "S|ll", &in, &level, &encoding)) { \ RETURN_THROWS(); \ } \ } else { \ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "Sl|l", &in, &encoding, &level)) { \ RETURN_THROWS(); \ } \ } \ if (level < -1 || level > 9) { \ zend_argument_value_error(default_encoding ? 2 : 3, "must be between -1 and 9"); \ RETURN_THROWS(); \ } \ switch (encoding) { \ case PHP_ZLIB_ENCODING_RAW: \ case PHP_ZLIB_ENCODING_GZIP: \ case PHP_ZLIB_ENCODING_DEFLATE: \ break; \ default: \ zend_argument_value_error(default_encoding ? 3 : 2, "must be one of ZLIB_ENCODING_RAW, ZLIB_ENCODING_GZIP, or ZLIB_ENCODING_DEFLATE"); \ RETURN_THROWS(); \ } \ if ((out = php_zlib_encode(ZSTR_VAL(in), ZSTR_LEN(in), encoding, level)) == NULL) { \ RETURN_FALSE; \ } \ RETURN_STR(out); \ } #define PHP_ZLIB_DECODE_FUNC(name, encoding) \ PHP_FUNCTION(name) \ { \ char *in_buf, *out_buf; \ size_t in_len; \ size_t out_len; \ zend_long max_len = 0; \ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "s|l", &in_buf, &in_len, &max_len)) { \ RETURN_THROWS(); \ } \ if (max_len < 0) { \ zend_argument_value_error(2, "must be greater than or equal to 0"); \ RETURN_THROWS(); \ } \ if (SUCCESS != php_zlib_decode(in_buf, in_len, &out_buf, &out_len, encoding, max_len)) { \ RETURN_FALSE; \ } \ RETVAL_STRINGL(out_buf, out_len); \ efree(out_buf); \ } /* {{{ Compress data with the specified encoding */ PHP_ZLIB_ENCODE_FUNC(zlib_encode, 0); /* }}} */ /* {{{ Uncompress any raw/gzip/zlib encoded data */ PHP_ZLIB_DECODE_FUNC(zlib_decode, PHP_ZLIB_ENCODING_ANY); /* }}} */ /* NOTE: The naming of these userland functions was quite unlucky */ /* {{{ Encode data with the raw deflate encoding */ PHP_ZLIB_ENCODE_FUNC(gzdeflate, PHP_ZLIB_ENCODING_RAW); /* }}} */ /* {{{ Encode data with the gzip encoding */ PHP_ZLIB_ENCODE_FUNC(gzencode, PHP_ZLIB_ENCODING_GZIP); /* }}} */ /* {{{ Encode data with the zlib encoding */ PHP_ZLIB_ENCODE_FUNC(gzcompress, PHP_ZLIB_ENCODING_DEFLATE); /* }}} */ /* {{{ Decode raw deflate encoded data */ PHP_ZLIB_DECODE_FUNC(gzinflate, PHP_ZLIB_ENCODING_RAW); /* }}} */ /* {{{ Decode gzip encoded data */ PHP_ZLIB_DECODE_FUNC(gzdecode, PHP_ZLIB_ENCODING_GZIP); /* }}} */ /* {{{ Decode zlib encoded data */ PHP_ZLIB_DECODE_FUNC(gzuncompress, PHP_ZLIB_ENCODING_DEFLATE); /* }}} */ static bool zlib_create_dictionary_string(HashTable *options, char **dict, size_t *dictlen) { zval *option_buffer; if (options && (option_buffer = zend_hash_str_find(options, ZEND_STRL("dictionary"))) != NULL) { ZVAL_DEREF(option_buffer); switch (Z_TYPE_P(option_buffer)) { case IS_STRING: { zend_string *str = Z_STR_P(option_buffer); *dict = emalloc(ZSTR_LEN(str)); memcpy(*dict, ZSTR_VAL(str), ZSTR_LEN(str)); *dictlen = ZSTR_LEN(str); return 1; } case IS_ARRAY: { HashTable *dictionary = Z_ARR_P(option_buffer); bool result = 1; if (zend_hash_num_elements(dictionary) > 0) { zend_string **strings = safe_emalloc(zend_hash_num_elements(dictionary), sizeof(zend_string *), 0); size_t total = 0; zval *cur; ZEND_HASH_FOREACH_VAL(dictionary, cur) { zend_string *string = zval_try_get_string(cur); if (string == NULL) { result = 0; break; } *dictlen += ZSTR_LEN(string) + 1; strings[total++] = string; if (ZSTR_LEN(string) == 0) { result = 0; zend_argument_value_error(2, "must not contain empty strings"); break; } if (zend_str_has_nul_byte(string)) { result = 0; zend_argument_value_error(2, "must not contain strings with null bytes"); break; } } ZEND_HASH_FOREACH_END(); char *dictptr = emalloc(*dictlen); *dict = dictptr; for (size_t i = 0; i < total; i++) { zend_string *string = strings[i]; dictptr = zend_mempcpy(dictptr, ZSTR_VAL(string), ZSTR_LEN(string)); *dictptr++ = 0; zend_string_release(string); } efree(strings); if (!result) { efree(*dict); *dict = NULL; } } return result; } default: zend_argument_type_error(2, "must be of type zero-terminated string or array, %s given", zend_zval_value_name(option_buffer)); return 0; } } return 1; } /* {{{ Initialize an incremental inflate context with the specified encoding */ PHP_FUNCTION(inflate_init) { php_zlib_context *ctx; zend_long encoding, window = 15; char *dict = NULL; size_t dictlen = 0; HashTable *options = NULL; zval *option_buffer; if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "l|H", &encoding, &options)) { RETURN_THROWS(); } if (options && (option_buffer = zend_hash_str_find(options, ZEND_STRL("window"))) != NULL) { window = zval_get_long(option_buffer); } if (window < 8 || window > 15) { zend_value_error("zlib window size (logarithm) (" ZEND_LONG_FMT ") must be within 8..15", window); RETURN_THROWS(); } if (!zlib_create_dictionary_string(options, &dict, &dictlen)) { RETURN_THROWS(); } switch (encoding) { case PHP_ZLIB_ENCODING_RAW: case PHP_ZLIB_ENCODING_GZIP: case PHP_ZLIB_ENCODING_DEFLATE: break; default: zend_value_error("Encoding mode must be ZLIB_ENCODING_RAW, ZLIB_ENCODING_GZIP or ZLIB_ENCODING_DEFLATE"); RETURN_THROWS(); } object_init_ex(return_value, inflate_context_ce); ctx = Z_INFLATE_CONTEXT_P(return_value); ctx->Z.zalloc = php_zlib_alloc; ctx->Z.zfree = php_zlib_free; ctx->inflateDict = dict; ctx->inflateDictlen = dictlen; ctx->status = Z_OK; if (encoding < 0) { encoding += 15 - window; } else { encoding -= 15 - window; } if (inflateInit2(&ctx->Z, encoding) != Z_OK) { zval_ptr_dtor(return_value); php_error_docref(NULL, E_WARNING, "Failed allocating zlib.inflate context"); RETURN_FALSE; } if (encoding == PHP_ZLIB_ENCODING_RAW && dictlen > 0) { switch (inflateSetDictionary(&ctx->Z, (Bytef *) ctx->inflateDict, ctx->inflateDictlen)) { case Z_OK: efree(ctx->inflateDict); ctx->inflateDict = NULL; break; case Z_DATA_ERROR: php_error_docref(NULL, E_WARNING, "Dictionary does not match expected dictionary (incorrect adler32 hash)"); efree(ctx->inflateDict); ctx->inflateDict = NULL; break; EMPTY_SWITCH_DEFAULT_CASE() } } } /* }}} */ /* {{{ Incrementally inflate encoded data in the specified context */ PHP_FUNCTION(inflate_add) { zend_string *out; char *in_buf; size_t in_len, buffer_used = 0, CHUNK_SIZE = 8192; zval *res; php_zlib_context *ctx; zend_long flush_type = Z_SYNC_FLUSH; int status; if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "Os|l", &res, inflate_context_ce, &in_buf, &in_len, &flush_type)) { RETURN_THROWS(); } ctx = Z_INFLATE_CONTEXT_P(res); switch (flush_type) { case Z_NO_FLUSH: case Z_PARTIAL_FLUSH: case Z_SYNC_FLUSH: case Z_FULL_FLUSH: case Z_BLOCK: case Z_FINISH: break; default: zend_argument_value_error(3, "must be one of ZLIB_NO_FLUSH, ZLIB_PARTIAL_FLUSH, ZLIB_SYNC_FLUSH, ZLIB_FULL_FLUSH, ZLIB_BLOCK, or ZLIB_FINISH"); RETURN_THROWS(); } /* Lazy-resetting the zlib stream so ctx->total_in remains available until the next inflate_add() call. */ if (ctx->status == Z_STREAM_END) { ctx->status = Z_OK; inflateReset(&ctx->Z); } if (in_len <= 0 && flush_type != Z_FINISH) { RETURN_EMPTY_STRING(); } out = zend_string_alloc((in_len > CHUNK_SIZE) ? in_len : CHUNK_SIZE, 0); ctx->Z.next_in = (Bytef *) in_buf; ctx->Z.next_out = (Bytef *) ZSTR_VAL(out); ctx->Z.avail_in = in_len; ctx->Z.avail_out = ZSTR_LEN(out); do { status = inflate(&ctx->Z, flush_type); buffer_used = ZSTR_LEN(out) - ctx->Z.avail_out; ctx->status = status; /* Save status for exposing to userspace */ switch (status) { case Z_OK: if (ctx->Z.avail_out == 0) { /* more output buffer space needed; realloc and try again */ out = zend_string_realloc(out, ZSTR_LEN(out) + CHUNK_SIZE, 0); ctx->Z.avail_out = CHUNK_SIZE; ctx->Z.next_out = (Bytef *) ZSTR_VAL(out) + buffer_used; break; } else { goto complete; } case Z_STREAM_END: goto complete; case Z_BUF_ERROR: if (flush_type == Z_FINISH && ctx->Z.avail_out == 0) { /* more output buffer space needed; realloc and try again */ out = zend_string_realloc(out, ZSTR_LEN(out) + CHUNK_SIZE, 0); ctx->Z.avail_out = CHUNK_SIZE; ctx->Z.next_out = (Bytef *) ZSTR_VAL(out) + buffer_used; break; } else { /* No more input data; we're finished */ goto complete; } case Z_NEED_DICT: if (ctx->inflateDict) { switch (inflateSetDictionary(&ctx->Z, (Bytef *) ctx->inflateDict, ctx->inflateDictlen)) { case Z_OK: efree(ctx->inflateDict); ctx->inflateDict = NULL; break; case Z_DATA_ERROR: efree(ctx->inflateDict); ctx->inflateDict = NULL; zend_string_release_ex(out, 0); php_error_docref(NULL, E_WARNING, "Dictionary does not match expected dictionary (incorrect adler32 hash)"); RETURN_FALSE; EMPTY_SWITCH_DEFAULT_CASE() } break; } else { php_error_docref(NULL, E_WARNING, "Inflating this data requires a preset dictionary, please specify it in the options array of inflate_init()"); RETURN_FALSE; } default: zend_string_release_ex(out, 0); php_error_docref(NULL, E_WARNING, "%s", zError(status)); RETURN_FALSE; } } while (1); complete: out = zend_string_realloc(out, buffer_used, 0); ZSTR_VAL(out)[buffer_used] = 0; RETURN_STR(out); } /* }}} */ /* {{{ Get decompression status, usually returns either ZLIB_OK or ZLIB_STREAM_END. */ PHP_FUNCTION(inflate_get_status) { zval *res; php_zlib_context *ctx; if (zend_parse_parameters(ZEND_NUM_ARGS(), "O", &res, inflate_context_ce) != SUCCESS) { RETURN_THROWS(); } ctx = Z_INFLATE_CONTEXT_P(res); RETURN_LONG(ctx->status); } /* }}} */ /* {{{ Get number of bytes read so far. */ PHP_FUNCTION(inflate_get_read_len) { zval *res; php_zlib_context *ctx; if (zend_parse_parameters(ZEND_NUM_ARGS(), "O", &res, inflate_context_ce) != SUCCESS) { RETURN_THROWS(); } ctx = Z_INFLATE_CONTEXT_P(res); RETURN_LONG(ctx->Z.total_in); } /* }}} */ /* {{{ Initialize an incremental deflate context using the specified encoding */ PHP_FUNCTION(deflate_init) { php_zlib_context *ctx; zend_long encoding, level = -1, memory = 8, window = 15, strategy = Z_DEFAULT_STRATEGY; char *dict = NULL; size_t dictlen = 0; HashTable *options = NULL; zval *option_buffer; if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "l|H", &encoding, &options)) { RETURN_THROWS(); } if (options && (option_buffer = zend_hash_str_find(options, ZEND_STRL("level"))) != NULL) { level = zval_get_long(option_buffer); } if (level < -1 || level > 9) { zend_value_error("deflate_init(): \"level\" option must be between -1 and 9"); RETURN_THROWS(); } if (options && (option_buffer = zend_hash_str_find(options, ZEND_STRL("memory"))) != NULL) { memory = zval_get_long(option_buffer); } if (memory < 1 || memory > 9) { zend_value_error("deflate_init(): \"memory\" option must be between 1 and 9"); RETURN_THROWS(); } if (options && (option_buffer = zend_hash_str_find(options, ZEND_STRL("window"))) != NULL) { window = zval_get_long(option_buffer); } if (window < 8 || window > 15) { zend_value_error("deflate_init(): \"window\" option must be between 8 and 15"); RETURN_THROWS(); } if (options && (option_buffer = zend_hash_str_find(options, ZEND_STRL("strategy"))) != NULL) { strategy = zval_get_long(option_buffer); } switch (strategy) { case Z_FILTERED: case Z_HUFFMAN_ONLY: case Z_RLE: case Z_FIXED: case Z_DEFAULT_STRATEGY: break; default: zend_value_error("deflate_init(): \"strategy\" option must be one of ZLIB_FILTERED, ZLIB_HUFFMAN_ONLY, ZLIB_RLE, ZLIB_FIXED, or ZLIB_DEFAULT_STRATEGY"); RETURN_THROWS(); } if (!zlib_create_dictionary_string(options, &dict, &dictlen)) { RETURN_THROWS(); } switch (encoding) { case PHP_ZLIB_ENCODING_RAW: case PHP_ZLIB_ENCODING_GZIP: case PHP_ZLIB_ENCODING_DEFLATE: break; default: zend_argument_value_error(1, "must be one of ZLIB_ENCODING_RAW, ZLIB_ENCODING_GZIP, or ZLIB_ENCODING_DEFLATE"); RETURN_THROWS(); } object_init_ex(return_value, deflate_context_ce); ctx = Z_DEFLATE_CONTEXT_P(return_value); ctx->Z.zalloc = php_zlib_alloc; ctx->Z.zfree = php_zlib_free; if (encoding < 0) { encoding += 15 - window; } else { encoding -= 15 - window; } if (deflateInit2(&ctx->Z, level, Z_DEFLATED, encoding, memory, strategy) != Z_OK) { zval_ptr_dtor(return_value); php_error_docref(NULL, E_WARNING, "Failed allocating zlib.deflate context"); RETURN_FALSE; } if (dict) { int success = deflateSetDictionary(&ctx->Z, (Bytef *) dict, dictlen); ZEND_ASSERT(success == Z_OK); efree(dict); } } /* }}} */ /* {{{ Incrementally deflate data in the specified context */ PHP_FUNCTION(deflate_add) { zend_string *out; char *in_buf; size_t in_len, out_size, buffer_used; zval *res; php_zlib_context *ctx; zend_long flush_type = Z_SYNC_FLUSH; int status; if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "Os|l", &res, deflate_context_ce, &in_buf, &in_len, &flush_type)) { RETURN_THROWS(); } ctx = Z_DEFLATE_CONTEXT_P(res); switch (flush_type) { case Z_BLOCK: #if ZLIB_VERNUM < 0x1240L zend_throw_error(NULL, "zlib >= 1.2.4 required for BLOCK deflate; current version: %s", ZLIB_VERSION); RETURN_THROWS(); #endif case Z_NO_FLUSH: case Z_PARTIAL_FLUSH: case Z_SYNC_FLUSH: case Z_FULL_FLUSH: case Z_FINISH: break; default: zend_argument_value_error(3, "must be one of ZLIB_NO_FLUSH, ZLIB_PARTIAL_FLUSH, ZLIB_SYNC_FLUSH, ZLIB_FULL_FLUSH, ZLIB_BLOCK, or ZLIB_FINISH"); RETURN_THROWS(); } if (in_len <= 0 && flush_type != Z_FINISH) { RETURN_EMPTY_STRING(); } out_size = PHP_ZLIB_BUFFER_SIZE_GUESS(in_len); out_size = (out_size < 64) ? 64 : out_size; out = zend_string_alloc(out_size, 0); ctx->Z.next_in = (Bytef *) in_buf; ctx->Z.next_out = (Bytef *) ZSTR_VAL(out); ctx->Z.avail_in = in_len; ctx->Z.avail_out = ZSTR_LEN(out); buffer_used = 0; do { if (ctx->Z.avail_out == 0) { /* more output buffer space needed; realloc and try again */ /* adding 64 more bytes solved every issue I have seen */ out = zend_string_realloc(out, ZSTR_LEN(out) + 64, 0); ctx->Z.avail_out = 64; ctx->Z.next_out = (Bytef *) ZSTR_VAL(out) + buffer_used; } status = deflate(&ctx->Z, flush_type); buffer_used = ZSTR_LEN(out) - ctx->Z.avail_out; } while (status == Z_OK && ctx->Z.avail_out == 0); switch (status) { case Z_OK: ZSTR_LEN(out) = (char *) ctx->Z.next_out - ZSTR_VAL(out); ZSTR_VAL(out)[ZSTR_LEN(out)] = 0; RETURN_STR(out); break; case Z_STREAM_END: ZSTR_LEN(out) = (char *) ctx->Z.next_out - ZSTR_VAL(out); ZSTR_VAL(out)[ZSTR_LEN(out)] = 0; deflateReset(&ctx->Z); RETURN_STR(out); break; default: zend_string_release_ex(out, 0); php_error_docref(NULL, E_WARNING, "zlib error (%s)", zError(status)); RETURN_FALSE; } } /* }}} */ #ifdef COMPILE_DL_ZLIB #ifdef ZTS ZEND_TSRMLS_CACHE_DEFINE() #endif ZEND_GET_MODULE(php_zlib) #endif /* {{{ OnUpdate_zlib_output_compression */ static PHP_INI_MH(OnUpdate_zlib_output_compression) { int int_value; char *ini_value; if (new_value == NULL) { return FAILURE; } if (zend_string_equals_literal_ci(new_value, "off")) { int_value = 0; } else if (zend_string_equals_literal_ci(new_value, "on")) { int_value = 1; } else { int_value = (int) zend_ini_parse_quantity_warn(new_value, entry->name); } ini_value = zend_ini_string("output_handler", sizeof("output_handler") - 1, 0); if (ini_value && *ini_value && int_value) { php_error_docref("ref.outcontrol", E_CORE_ERROR, "Cannot use both zlib.output_compression and output_handler together!!"); return FAILURE; } if (stage == PHP_INI_STAGE_RUNTIME) { int status = php_output_get_status(); if (status & PHP_OUTPUT_SENT) { php_error_docref("ref.outcontrol", E_WARNING, "Cannot change zlib.output_compression - headers already sent"); return FAILURE; } } zend_long *p = (zend_long *) ZEND_INI_GET_ADDR(); *p = int_value; ZLIBG(output_compression) = ZLIBG(output_compression_default); if (stage == PHP_INI_STAGE_RUNTIME && int_value) { if (!php_output_handler_started(ZEND_STRL(PHP_ZLIB_OUTPUT_HANDLER_NAME))) { php_zlib_output_compression_start(); } } return SUCCESS; } /* }}} */ /* {{{ OnUpdate_zlib_output_handler */ static PHP_INI_MH(OnUpdate_zlib_output_handler) { if (stage == PHP_INI_STAGE_RUNTIME && (php_output_get_status() & PHP_OUTPUT_SENT)) { php_error_docref("ref.outcontrol", E_WARNING, "Cannot change zlib.output_handler - headers already sent"); return FAILURE; } return OnUpdateString(entry, new_value, mh_arg1, mh_arg2, mh_arg3, stage); } /* }}} */ /* {{{ INI */ PHP_INI_BEGIN() STD_PHP_INI_BOOLEAN("zlib.output_compression", "0", PHP_INI_ALL, OnUpdate_zlib_output_compression, output_compression_default, zend_zlib_globals, zlib_globals) STD_PHP_INI_ENTRY("zlib.output_compression_level", "-1", PHP_INI_ALL, OnUpdateLong, output_compression_level, zend_zlib_globals, zlib_globals) STD_PHP_INI_ENTRY("zlib.output_handler", "", PHP_INI_ALL, OnUpdate_zlib_output_handler, output_handler, zend_zlib_globals, zlib_globals) PHP_INI_END() /* }}} */ /* {{{ PHP_MINIT_FUNCTION */ static PHP_MINIT_FUNCTION(zlib) { php_register_url_stream_wrapper("compress.zlib", &php_stream_gzip_wrapper); php_stream_filter_register_factory("zlib.*", &php_zlib_filter_factory); php_output_handler_alias_register(ZEND_STRL("ob_gzhandler"), php_zlib_output_handler_init); php_output_handler_conflict_register(ZEND_STRL("ob_gzhandler"), php_zlib_output_conflict_check); php_output_handler_conflict_register(ZEND_STRL(PHP_ZLIB_OUTPUT_HANDLER_NAME), php_zlib_output_conflict_check); inflate_context_ce = register_class_InflateContext(); inflate_context_ce->create_object = inflate_context_create_object; inflate_context_ce->default_object_handlers = &inflate_context_object_handlers; memcpy(&inflate_context_object_handlers, &std_object_handlers, sizeof(zend_object_handlers)); inflate_context_object_handlers.offset = XtOffsetOf(php_zlib_context, std); inflate_context_object_handlers.free_obj = inflate_context_free_obj; inflate_context_object_handlers.get_constructor = inflate_context_get_constructor; inflate_context_object_handlers.clone_obj = NULL; inflate_context_object_handlers.compare = zend_objects_not_comparable; deflate_context_ce = register_class_DeflateContext(); deflate_context_ce->create_object = deflate_context_create_object; deflate_context_ce->default_object_handlers = &deflate_context_object_handlers; memcpy(&deflate_context_object_handlers, &std_object_handlers, sizeof(zend_object_handlers)); deflate_context_object_handlers.offset = XtOffsetOf(php_zlib_context, std); deflate_context_object_handlers.free_obj = deflate_context_free_obj; deflate_context_object_handlers.get_constructor = deflate_context_get_constructor; deflate_context_object_handlers.clone_obj = NULL; deflate_context_object_handlers.compare = zend_objects_not_comparable; register_zlib_symbols(module_number); REGISTER_INI_ENTRIES(); return SUCCESS; } /* }}} */ /* {{{ PHP_MSHUTDOWN_FUNCTION */ static PHP_MSHUTDOWN_FUNCTION(zlib) { php_unregister_url_stream_wrapper("zlib"); php_stream_filter_unregister_factory("zlib.*"); UNREGISTER_INI_ENTRIES(); return SUCCESS; } /* }}} */ /* {{{ PHP_RINIT_FUNCTION */ static PHP_RINIT_FUNCTION(zlib) { ZLIBG(compression_coding) = 0; if (!ZLIBG(handler_registered)) { ZLIBG(output_compression) = ZLIBG(output_compression_default); php_zlib_output_compression_start(); } return SUCCESS; } /* }}} */ /* {{{ PHP_RSHUTDOWN_FUNCTION */ static PHP_RSHUTDOWN_FUNCTION(zlib) { php_zlib_cleanup_ob_gzhandler_mess(); ZLIBG(handler_registered) = 0; return SUCCESS; } /* }}} */ /* {{{ PHP_MINFO_FUNCTION */ static PHP_MINFO_FUNCTION(zlib) { php_info_print_table_start(); php_info_print_table_row(2, "ZLib Support", "enabled"); php_info_print_table_row(2, "Stream Wrapper", "compress.zlib://"); php_info_print_table_row(2, "Stream Filter", "zlib.inflate, zlib.deflate"); php_info_print_table_row(2, "Compiled Version", ZLIB_VERSION); php_info_print_table_row(2, "Linked Version", (char *) zlibVersion()); php_info_print_table_end(); DISPLAY_INI_ENTRIES(); } /* }}} */ /* {{{ ZEND_MODULE_GLOBALS_CTOR */ static PHP_GINIT_FUNCTION(zlib) { #if defined(COMPILE_DL_ZLIB) && defined(ZTS) ZEND_TSRMLS_CACHE_UPDATE(); #endif zlib_globals->ob_gzhandler = NULL; zlib_globals->handler_registered = 0; } /* }}} */ /* {{{ php_zlib_module_entry */ zend_module_entry php_zlib_module_entry = { STANDARD_MODULE_HEADER, "zlib", ext_functions, PHP_MINIT(zlib), PHP_MSHUTDOWN(zlib), PHP_RINIT(zlib), PHP_RSHUTDOWN(zlib), PHP_MINFO(zlib), PHP_ZLIB_VERSION, PHP_MODULE_GLOBALS(zlib), PHP_GINIT(zlib), NULL, NULL, STANDARD_MODULE_PROPERTIES_EX }; /* }}} */