Back to index

php5  5.3.10
Classes | Typedefs | Functions | Variables
zlib_filter.c File Reference
#include "php.h"
#include "php_zlib.h"

Go to the source code of this file.

Classes

struct  _php_zlib_filter_data

Typedefs

typedef struct
_php_zlib_filter_data 
php_zlib_filter_data

Functions

static voidpf php_zlib_alloc (voidpf opaque, uInt items, uInt size)
static void php_zlib_free (voidpf opaque, voidpf address)
static php_stream_filter_status_t php_zlib_inflate_filter (php_stream *stream, php_stream_filter *thisfilter, php_stream_bucket_brigade *buckets_in, php_stream_bucket_brigade *buckets_out, size_t *bytes_consumed, int flags TSRMLS_DC)
static void php_zlib_inflate_dtor (php_stream_filter *thisfilter TSRMLS_DC)
static php_stream_filter_status_t php_zlib_deflate_filter (php_stream *stream, php_stream_filter *thisfilter, php_stream_bucket_brigade *buckets_in, php_stream_bucket_brigade *buckets_out, size_t *bytes_consumed, int flags TSRMLS_DC)
static void php_zlib_deflate_dtor (php_stream_filter *thisfilter TSRMLS_DC)
static php_stream_filter * php_zlib_filter_create (const char *filtername, zval *filterparams, int persistent TSRMLS_DC)

Variables

static php_stream_filter_ops php_zlib_inflate_ops
static php_stream_filter_ops php_zlib_deflate_ops
php_stream_filter_factory php_zlib_filter_factory

Class Documentation

struct _php_zlib_filter_data

Definition at line 27 of file zlib_filter.c.

Class Members
zend_bool finished
char * inbuf
size_t inbuf_len
char * outbuf
size_t outbuf_len
int persistent
z_stream strm

Typedef Documentation


Function Documentation

static voidpf php_zlib_alloc ( voidpf  opaque,
uInt  items,
uInt  size 
) [static]

Definition at line 41 of file zlib_filter.c.

{
       return (voidpf)safe_pemalloc(items, size, 0, ((php_zlib_filter_data*)opaque)->persistent);
}

Here is the caller graph for this function:

static void php_zlib_deflate_dtor ( php_stream_filter *thisfilter  TSRMLS_DC) [static]

Definition at line 267 of file zlib_filter.c.

{
       if (thisfilter && thisfilter->abstract) {
              php_zlib_filter_data *data = thisfilter->abstract;
              deflateEnd(&(data->strm));
              pefree(data->inbuf, data->persistent);
              pefree(data->outbuf, data->persistent);
              pefree(data, data->persistent);
       }
}
static php_stream_filter_status_t php_zlib_deflate_filter ( php_stream *  stream,
php_stream_filter *  thisfilter,
php_stream_bucket_brigade *  buckets_in,
php_stream_bucket_brigade *  buckets_out,
size_t bytes_consumed,
int flags  TSRMLS_DC 
) [static]

Definition at line 179 of file zlib_filter.c.

{
       php_zlib_filter_data *data;
       php_stream_bucket *bucket;
       size_t consumed = 0, original_out, original_in;
       int status;
       php_stream_filter_status_t exit_status = PSFS_FEED_ME;
       z_stream *streamp;

       if (!thisfilter || !thisfilter->abstract) {
              /* Should never happen */
              return PSFS_ERR_FATAL;
       }

       data = (php_zlib_filter_data *)(thisfilter->abstract);
       streamp = &(data->strm);
       original_in = data->strm.total_in;
       original_out = data->strm.total_out;

       while (buckets_in->head) {
              size_t bin = 0, desired;

              bucket = php_stream_bucket_make_writeable(buckets_in->head TSRMLS_CC);

              while (bin < bucket->buflen) {
                     desired = bucket->buflen - bin;
                     if (desired > data->inbuf_len) {
                            desired = data->inbuf_len;
                     }
                     memcpy(data->strm.next_in, bucket->buf + bin, desired);
                     data->strm.avail_in = desired;

                     status = deflate(&(data->strm), flags & PSFS_FLAG_FLUSH_CLOSE ? Z_FULL_FLUSH : (flags & PSFS_FLAG_FLUSH_INC ? Z_SYNC_FLUSH : Z_NO_FLUSH));
                     if (status != Z_OK) {
                            /* Something bad happened */
                            php_stream_bucket_delref(bucket TSRMLS_CC);
                            return PSFS_ERR_FATAL;
                     }
                     desired -= data->strm.avail_in; /* desired becomes what we consumed this round through */
                     data->strm.next_in = data->inbuf;
                     data->strm.avail_in = 0;
                     consumed += desired;
                     bin += desired;

                     if (data->strm.avail_out < data->outbuf_len) {
                            php_stream_bucket *out_bucket;
                            size_t bucketlen = data->outbuf_len - data->strm.avail_out;

                            out_bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0 TSRMLS_CC);
                            php_stream_bucket_append(buckets_out, out_bucket TSRMLS_CC);
                            data->strm.avail_out = data->outbuf_len;
                            data->strm.next_out = data->outbuf;
                            exit_status = PSFS_PASS_ON;
                     }
              }
              php_stream_bucket_delref(bucket TSRMLS_CC);
       }

       if (flags & PSFS_FLAG_FLUSH_CLOSE) {
              /* Spit it out! */
              status = Z_OK;
              while (status == Z_OK) {
                     status = deflate(&(data->strm), Z_FINISH);
                     if (data->strm.avail_out < data->outbuf_len) {
                            size_t bucketlen = data->outbuf_len - data->strm.avail_out;

                            bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0 TSRMLS_CC);
                            php_stream_bucket_append(buckets_out, bucket TSRMLS_CC);
                            data->strm.avail_out = data->outbuf_len;
                            data->strm.next_out = data->outbuf;
                            exit_status = PSFS_PASS_ON;
                     }
              }
       }

       if (bytes_consumed) {
              *bytes_consumed = consumed;
       }
       return exit_status;
}

Here is the call graph for this function:

static php_stream_filter* php_zlib_filter_create ( const char *  filtername,
zval *  filterparams,
int persistent  TSRMLS_DC 
) [static]

Definition at line 288 of file zlib_filter.c.

{
       php_stream_filter_ops *fops = NULL;
       php_zlib_filter_data *data;
       int status;

       /* Create this filter */
       data = pecalloc(1, sizeof(php_zlib_filter_data), persistent);
       if (!data) {
              php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed allocating %zd bytes.", sizeof(php_zlib_filter_data));
              return NULL;
       }

       /* Circular reference */
       data->strm.opaque = (voidpf) data;

       data->strm.zalloc = (alloc_func) php_zlib_alloc;
       data->strm.zfree = (free_func) php_zlib_free;
       data->strm.avail_out = data->outbuf_len = data->inbuf_len = 2048;
       data->strm.next_in = data->inbuf = (Bytef *) pemalloc(data->inbuf_len, persistent);
       if (!data->inbuf) {
              php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed allocating %zd bytes.", data->inbuf_len);
              pefree(data, persistent);
              return NULL;
       }
       data->strm.avail_in = 0;
       data->strm.next_out = data->outbuf = (Bytef *) pemalloc(data->outbuf_len, persistent);
       if (!data->outbuf) {
              php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed allocating %zd bytes.", data->outbuf_len);
              pefree(data->inbuf, persistent);
              pefree(data, persistent);
              return NULL;
       }
              
       data->strm.data_type = Z_ASCII;

       if (strcasecmp(filtername, "zlib.inflate") == 0) {
              int windowBits = -MAX_WBITS;

              if (filterparams) {
                     zval **tmpzval;

                     if ((Z_TYPE_P(filterparams) == IS_ARRAY || Z_TYPE_P(filterparams) == IS_OBJECT) &&
                            zend_hash_find(HASH_OF(filterparams), "window", sizeof("window"), (void **) &tmpzval) == SUCCESS) {
                            zval tmp;

                            /* log-2 base of history window (9 - 15) */
                            tmp = **tmpzval;
                            zval_copy_ctor(&tmp);
                            convert_to_long(&tmp);
                            if (Z_LVAL(tmp) < -MAX_WBITS || Z_LVAL(tmp) > MAX_WBITS + 32) {
                                   php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid parameter give for window size. (%ld)", Z_LVAL(tmp));
                            } else {
                                   windowBits = Z_LVAL(tmp);
                            }
                     }
              }

              /* RFC 1951 Inflate */
              data->finished = '\0';
              status = inflateInit2(&(data->strm), windowBits);
              fops = &php_zlib_inflate_ops;
       } else if (strcasecmp(filtername, "zlib.deflate") == 0) {
              /* RFC 1951 Deflate */
              int level = Z_DEFAULT_COMPRESSION;
              int windowBits = -MAX_WBITS;
              int memLevel = MAX_MEM_LEVEL;


              if (filterparams) {
                     zval **tmpzval, tmp;

                     /* filterparams can either be a scalar value to indicate compression level (shortcut method)
               Or can be a hash containing one or more of 'window', 'memory', and/or 'level' members. */

                     switch (Z_TYPE_P(filterparams)) {
                            case IS_ARRAY:
                            case IS_OBJECT:
                                   if (zend_hash_find(HASH_OF(filterparams), "memory", sizeof("memory"), (void**) &tmpzval) == SUCCESS) {
                                          tmp = **tmpzval;
                                          zval_copy_ctor(&tmp);
                                          convert_to_long(&tmp);

                                          /* Memory Level (1 - 9) */
                                          if (Z_LVAL(tmp) < 1 || Z_LVAL(tmp) > MAX_MEM_LEVEL) {
                                                 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid parameter give for memory level. (%ld)", Z_LVAL(tmp));
                                          } else {
                                                 memLevel = Z_LVAL(tmp);
                                          }
                                   }

                                   if (zend_hash_find(HASH_OF(filterparams), "window", sizeof("window"), (void**) &tmpzval) == SUCCESS) {
                                          tmp = **tmpzval;
                                          zval_copy_ctor(&tmp);
                                          convert_to_long(&tmp);

                                          /* log-2 base of history window (9 - 15) */
                                          if (Z_LVAL(tmp) < -MAX_WBITS || Z_LVAL(tmp) > MAX_WBITS + 16) {
                                                 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid parameter give for window size. (%ld)", Z_LVAL(tmp));
                                          } else {
                                                 windowBits = Z_LVAL(tmp);
                                          }
                                   }

                                   if (zend_hash_find(HASH_OF(filterparams), "level", sizeof("level"), (void**) &tmpzval) == SUCCESS) {
                                          tmp = **tmpzval;

                                          /* Psuedo pass through to catch level validating code */
                                          goto factory_setlevel;
                                   }
                                   break;
                            case IS_STRING:
                            case IS_DOUBLE:
                            case IS_LONG:
                                   tmp = *filterparams;
factory_setlevel:
                                   zval_copy_ctor(&tmp);
                                   convert_to_long(&tmp);

                                   /* Set compression level within reason (-1 == default, 0 == none, 1-9 == least to most compression */
                                   if (Z_LVAL(tmp) < -1 || Z_LVAL(tmp) > 9) {
                                          php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid compression level specified. (%ld)", Z_LVAL(tmp));
                                   } else {
                                          level = Z_LVAL(tmp);
                                   }
                                   break;
                            default:
                                   php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid filter parameter, ignored.");
                     }
              }
              status = deflateInit2(&(data->strm), level, Z_DEFLATED, windowBits, memLevel, 0);
              fops = &php_zlib_deflate_ops;
       } else {
              status = Z_DATA_ERROR;
       }

       if (status != Z_OK) {
              /* Unspecified (probably strm) error, let stream-filter error do its own whining */
              pefree(data->strm.next_in, persistent);
              pefree(data->strm.next_out, persistent);
              pefree(data, persistent);
              return NULL;
       }

       return php_stream_filter_alloc(fops, data, persistent);
}

Here is the call graph for this function:

static void php_zlib_free ( voidpf  opaque,
voidpf  address 
) [static]

Definition at line 46 of file zlib_filter.c.

{
       pefree((void*)address, ((php_zlib_filter_data*)opaque)->persistent);
}

Here is the caller graph for this function:

static void php_zlib_inflate_dtor ( php_stream_filter *thisfilter  TSRMLS_DC) [static]

Definition at line 157 of file zlib_filter.c.

{
       if (thisfilter && thisfilter->abstract) {
              php_zlib_filter_data *data = thisfilter->abstract;
              if (!data->finished) {
                     inflateEnd(&(data->strm));
              }
              pefree(data->inbuf, data->persistent);
              pefree(data->outbuf, data->persistent);
              pefree(data, data->persistent);
       }
}
static php_stream_filter_status_t php_zlib_inflate_filter ( php_stream *  stream,
php_stream_filter *  thisfilter,
php_stream_bucket_brigade *  buckets_in,
php_stream_bucket_brigade *  buckets_out,
size_t bytes_consumed,
int flags  TSRMLS_DC 
) [static]

Definition at line 54 of file zlib_filter.c.

{
       php_zlib_filter_data *data;
       php_stream_bucket *bucket;
       size_t consumed = 0, original_out, original_in;
       int status;
       php_stream_filter_status_t exit_status = PSFS_FEED_ME;
       z_stream *streamp;

       if (!thisfilter || !thisfilter->abstract) {
              /* Should never happen */
              return PSFS_ERR_FATAL;
       }

       data = (php_zlib_filter_data *)(thisfilter->abstract);
       streamp = &(data->strm);
       original_in = data->strm.total_in;
       original_out = data->strm.total_out;

       while (buckets_in->head) {
              size_t bin = 0, desired;

              bucket = php_stream_bucket_make_writeable(buckets_in->head TSRMLS_CC);
              while (bin < bucket->buflen) {

                     if (data->finished) {
                            consumed += bucket->buflen;
                            break;
                     }

                     desired = bucket->buflen - bin;
                     if (desired > data->inbuf_len) {
                            desired = data->inbuf_len;
                     }
                     memcpy(data->strm.next_in, bucket->buf + bin, desired);
                     data->strm.avail_in = desired;

                     status = inflate(&(data->strm), flags & PSFS_FLAG_FLUSH_CLOSE ? Z_FINISH : Z_SYNC_FLUSH);
                     if (status == Z_STREAM_END) {
                            inflateEnd(&(data->strm));
                            data->finished = '\1';
                     } else if (status != Z_OK) {
                            /* Something bad happened */
                            php_stream_bucket_delref(bucket TSRMLS_CC);
                            /* reset these because despite the error the filter may be used again */
                            data->strm.next_in = data->inbuf;
                            data->strm.avail_in = 0;
                            return PSFS_ERR_FATAL;
                     }
                     desired -= data->strm.avail_in; /* desired becomes what we consumed this round through */
                     data->strm.next_in = data->inbuf;
                     data->strm.avail_in = 0;
                     consumed += desired;
                     bin += desired;

                     if (data->strm.avail_out < data->outbuf_len) {
                            php_stream_bucket *out_bucket;
                            size_t bucketlen = data->outbuf_len - data->strm.avail_out;
                            out_bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0 TSRMLS_CC);
                            php_stream_bucket_append(buckets_out, out_bucket TSRMLS_CC);
                            data->strm.avail_out = data->outbuf_len;
                            data->strm.next_out = data->outbuf;
                            exit_status = PSFS_PASS_ON;
                     } else if (status == Z_STREAM_END && data->strm.avail_out >= data->outbuf_len) {
                            /* no more data to decompress, and nothing was spat out */
                            php_stream_bucket_delref(bucket TSRMLS_CC);
                            return PSFS_PASS_ON;
                     }
              }
              php_stream_bucket_delref(bucket TSRMLS_CC);
       }

       if (!data->finished && flags & PSFS_FLAG_FLUSH_CLOSE) {
              /* Spit it out! */
              status = Z_OK;
              while (status == Z_OK) {
                     status = inflate(&(data->strm), Z_FINISH);
                     if (data->strm.avail_out < data->outbuf_len) {
                            size_t bucketlen = data->outbuf_len - data->strm.avail_out;

                            bucket = php_stream_bucket_new(stream, estrndup(data->outbuf, bucketlen), bucketlen, 1, 0 TSRMLS_CC);
                            php_stream_bucket_append(buckets_out, bucket TSRMLS_CC);
                            data->strm.avail_out = data->outbuf_len;
                            data->strm.next_out = data->outbuf;
                            exit_status = PSFS_PASS_ON;
                     }
              }
       }

       if (bytes_consumed) {
              *bytes_consumed = consumed;
       }

       return exit_status;
}

Here is the call graph for this function:


Variable Documentation

Initial value:

Definition at line 278 of file zlib_filter.c.

Initial value:

Definition at line 435 of file zlib_filter.c.

Initial value:

Definition at line 170 of file zlib_filter.c.