- get rid of 1001 strict-aliasing warnings
[m6w6/ext-http] / http_filter_api.c
index 3315f75841f216b7085042402648a90ff82d58a0..02467decdb2844570151a79883d83d10ad9a89ca 100644 (file)
@@ -1,51 +1,58 @@
 /*
-   +----------------------------------------------------------------------+
-   | PECL :: http                                                         |
-   +----------------------------------------------------------------------+
-   | This source file is subject to version 3.0 of the PHP license, that  |
-   | is bundled with this package in the file LICENSE, and is available   |
-   | through the world-wide-web at http://www.php.net/license/3_0.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.               |
-   +----------------------------------------------------------------------+
-   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2006, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
 
-#ifdef HAVE_CONFIG_H
-#      include "config.h"
-#endif
-#include "php.h"
+#define HTTP_WANT_ZLIB
+#include "php_http.h"
 
-#include "php_http_std_defs.h"
+#ifdef ZEND_ENGINE_2
+
+#include "php_streams.h"
 #include "php_http_api.h"
+#include "php_http_encoding_api.h"
 #include "php_http_filter_api.h"
 
-#include "phpstr/phpstr.h"
-
-#include "php_streams.h"
+PHP_MINIT_FUNCTION(http_filter)
+{
+       php_stream_filter_register_factory("http.*", &http_filter_factory TSRMLS_CC);
+       return SUCCESS;
+}
 
 /*
- * TODO: allow use with persistent streams
- */
-
-typedef struct {
-       phpstr  buffer;
-       ulong   hexlen;
-} http_filter_buffer;
+       -
+*/
 
-#define PHP_STREAM_FILTER_OP_FILTER_PARAMS \
+#define HTTP_FILTER_PARAMS \
        php_stream *stream, \
        php_stream_filter *this, \
        php_stream_bucket_brigade *buckets_in, \
        php_stream_bucket_brigade *buckets_out, \
        size_t *bytes_consumed, int flags \
        TSRMLS_DC
-#define PHP_STREAM_FILTER_OP_FILTER(function) \
-       static php_stream_filter_status_t function(PHP_STREAM_FILTER_OP_FILTER_PARAMS)
+#define HTTP_FILTER_OP(filter) \
+       http_filter_op_ ##filter
+#define HTTP_FILTER_OPS(filter) \
+       php_stream_filter_ops HTTP_FILTER_OP(filter)
+#define HTTP_FILTER_DTOR(filter) \
+       http_filter_ ##filter## _dtor
+#define HTTP_FILTER_DESTRUCTOR(filter) \
+       void HTTP_FILTER_DTOR(filter)(php_stream_filter *this TSRMLS_DC)
+#define HTTP_FILTER_FUNC(filter) \
+       http_filter_ ##filter
+#define HTTP_FILTER_FUNCTION(filter) \
+       php_stream_filter_status_t HTTP_FILTER_FUNC(filter)(HTTP_FILTER_PARAMS)
+#define HTTP_FILTER_BUFFER(filter) \
+       http_filter_ ##filter## _buffer
 
 #define NEW_BUCKET(data, length) \
        { \
@@ -67,11 +74,22 @@ typedef struct {
                php_stream_bucket_append(buckets_out, __buck TSRMLS_CC); \
        }
 
-PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
+typedef struct _http_chunked_decode_filter_buffer_t {
+       phpstr  buffer;
+       ulong   hexlen;
+} HTTP_FILTER_BUFFER(chunked_decode);
+
+#ifdef HTTP_HAVE_ZLIB
+typedef http_encoding_stream HTTP_FILTER_BUFFER(deflate);
+typedef http_encoding_stream HTTP_FILTER_BUFFER(inflate);
+#endif /* HTTP_HAVE_ZLIB */
+
+
+static HTTP_FILTER_FUNCTION(chunked_decode)
 {
        int out_avail = 0;
        php_stream_bucket *ptr, *nxt;
-       http_filter_buffer *buffer = (http_filter_buffer *) (this->abstract);
+       HTTP_FILTER_BUFFER(chunked_decode) *buffer = (HTTP_FILTER_BUFFER(chunked_decode) *) (this->abstract);
        
        if (bytes_consumed) {
                *bytes_consumed = 0;
@@ -87,13 +105,17 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
                                *bytes_consumed += ptr->buflen;
                        }
                
-                       phpstr_append(PHPSTR(buffer), ptr->buf, ptr->buflen);
+                       if ((size_t) -1 == phpstr_append(PHPSTR(buffer), ptr->buf, ptr->buflen)) {
+                               return PSFS_ERR_FATAL;
+                       }
+                       
                        php_stream_bucket_unlink(ptr TSRMLS_CC);
                        php_stream_bucket_delref(ptr TSRMLS_CC);
-                       
                }
        }
-       phpstr_fix(PHPSTR(buffer));
+       if (!phpstr_fix(PHPSTR(buffer))) {
+               return PSFS_ERR_FATAL;
+       }
 
        /* we have data in our buffer */
        while (PHPSTR_LEN(buffer)) {
@@ -105,7 +127,7 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
                        if (PHPSTR_LEN(buffer) < buffer->hexlen) {
                        
                                /* flush anyway? */
-                               if (flags == PSFS_FLAG_FLUSH_INC) {
+                               if (flags & PSFS_FLAG_FLUSH_INC) {
                                
                                        /* flush all data (should only be chunk data) */
                                        out_avail = 1;
@@ -113,8 +135,9 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
                                        
                                        /* waiting for less data now */
                                        buffer->hexlen -= PHPSTR_LEN(buffer);
-                                       /* no more buffered data (breaks loop) */
+                                       /* no more buffered data */
                                        phpstr_reset(PHPSTR(buffer));
+                                       /* break */
                                } 
                                
                                /* we have too less data and don't need to flush */
@@ -132,6 +155,7 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
                                phpstr_cut(PHPSTR(buffer), 0, buffer->hexlen);
                                /* reset hexlen */
                                buffer->hexlen = 0;
+                               /* continue */
                        }
                } 
                
@@ -141,8 +165,8 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
                        
                        /* ignore preceeding CRLFs (too loose?) */
                        while (off < PHPSTR_LEN(buffer) && (
-                                       PHPSTR_VAL(buffer)[off] == 0xa || 
-                                       PHPSTR_VAL(buffer)[off] == 0xd)) {
+                                       PHPSTR_VAL(buffer)[off] == '\n' || 
+                                       PHPSTR_VAL(buffer)[off] == '\r')) {
                                ++off;
                        }
                        if (off) {
@@ -156,7 +180,7 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
                                
                                /* we need eol, so we can be sure we have all hex digits */
                                phpstr_fix(PHPSTR(buffer));
-                               if (eolstr = http_locate_eol(PHPSTR_VAL(buffer), &eollen)) {
+                               if ((eolstr = http_locate_eol(PHPSTR_VAL(buffer), &eollen))) {
                                        char *stop = NULL;
                                        
                                        /* read in chunk size */
@@ -172,6 +196,9 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
                                        phpstr_cut(PHPSTR(buffer), 0, eolstr + eollen - PHPSTR_VAL(buffer));
                                        /* buffer->hexlen is 0 now or contains the size of the next chunk */
                                        /* continue */
+                               } else {
+                                       /* we have not enough data buffered to read in chunk size */
+                                       break;
                                }
                        }
                        /* break */
@@ -179,7 +206,7 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
        }
        
        /* flush before close, but only if we are already waiting for more data */
-       if (flags == PSFS_FLAG_FLUSH_CLOSE && buffer->hexlen && PHPSTR_LEN(buffer)) {
+       if ((flags & PSFS_FLAG_FLUSH_CLOSE) && buffer->hexlen && PHPSTR_LEN(buffer)) {
                out_avail = 1;
                NEW_BUCKET(PHPSTR_VAL(buffer), PHPSTR_LEN(buffer));
                phpstr_reset(PHPSTR(buffer));
@@ -189,15 +216,15 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_decode)
        return out_avail ? PSFS_PASS_ON : PSFS_FEED_ME;
 }
 
-static void http_filter_chunked_decode_dtor(php_stream_filter *this TSRMLS_DC)
+static HTTP_FILTER_DESTRUCTOR(chunked_decode)
 {
-       http_filter_buffer *b = (http_filter_buffer *) (this->abstract);
+       HTTP_FILTER_BUFFER(chunked_decode) *b = (HTTP_FILTER_BUFFER(chunked_decode) *) (this->abstract);
        
        phpstr_dtor(PHPSTR(b));
        pefree(b, this->is_persistent);
 }
 
-PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_encode)
+static HTTP_FILTER_FUNCTION(chunked_encode)
 {
        int out_avail = 0;
        php_stream_bucket *ptr, *nxt;
@@ -227,7 +254,7 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_encode)
                        /* pass through */
                        NEW_BUCKET(PHPSTR_VAL(&buf), PHPSTR_LEN(&buf));
                        /* reset */
-                       PHPSTR_LEN(&buf) = 0;
+                       phpstr_reset(&buf);
                        
                        php_stream_bucket_unlink(ptr TSRMLS_CC);
                        php_stream_bucket_delref(ptr TSRMLS_CC);
@@ -238,7 +265,7 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_encode)
        }
        
        /* terminate with "0" */
-       if (flags == PSFS_FLAG_FLUSH_CLOSE) {
+       if (flags & PSFS_FLAG_FLUSH_CLOSE) {
                out_avail = 1;
                NEW_BUCKET("0" HTTP_CRLF, lenof("0" HTTP_CRLF));
        }
@@ -246,40 +273,236 @@ PHP_STREAM_FILTER_OP_FILTER(http_filter_chunked_encode)
        return out_avail ? PSFS_PASS_ON : PSFS_FEED_ME;
 }
 
-static php_stream_filter_ops http_filter_ops_chunked_decode = {
-       http_filter_chunked_decode,
-       http_filter_chunked_decode_dtor,
+static HTTP_FILTER_OPS(chunked_decode) = {
+       HTTP_FILTER_FUNC(chunked_decode),
+       HTTP_FILTER_DTOR(chunked_decode),
        "http.chunked_decode"
 };
 
-static php_stream_filter_ops http_filter_ops_chunked_encode = {
-       http_filter_chunked_encode,
+static HTTP_FILTER_OPS(chunked_encode) = {
+       HTTP_FILTER_FUNC(chunked_encode),
        NULL,
        "http.chunked_encode"
 };
 
+#ifdef HTTP_HAVE_ZLIB
+
+static HTTP_FILTER_FUNCTION(deflate)
+{
+       int out_avail = 0;
+       php_stream_bucket *ptr, *nxt;
+       HTTP_FILTER_BUFFER(inflate) *buffer = (HTTP_FILTER_BUFFER(deflate) *) this->abstract;
+       
+       if (bytes_consumed) {
+               *bytes_consumed = 0;
+       }
+       
+       /* new data available? */
+       if (buckets_in->head) {
+               
+               /* fetch available bucket data */
+               for (ptr = buckets_in->head; ptr; ptr = nxt) {
+                       char *encoded = NULL;
+                       size_t encoded_len = 0;
+                       
+                       nxt = ptr->next;
+                       if (bytes_consumed) {
+                               *bytes_consumed += ptr->buflen;
+                       }
+                       
+                       if (ptr->buflen) {
+                               http_encoding_deflate_stream_update(buffer, ptr->buf, ptr->buflen, &encoded, &encoded_len);
+                               if (encoded) {
+                                       out_avail = 1;
+                                       NEW_BUCKET(encoded, encoded_len);
+                                       efree(encoded);
+                               }
+                       }
+                       
+                       php_stream_bucket_unlink(ptr TSRMLS_CC);
+                       php_stream_bucket_delref(ptr TSRMLS_CC);
+               }
+       }
+       
+       /* flush & close */
+       if (flags & PSFS_FLAG_FLUSH_INC) {
+               char *encoded = NULL;
+               size_t encoded_len = 0;
+               
+               http_encoding_deflate_stream_flush(buffer, &encoded, &encoded_len);
+               if (encoded) {
+                       out_avail = 1;
+                       NEW_BUCKET(encoded, encoded_len);
+                       efree(encoded);
+               }
+       }
+       
+       if (flags & PSFS_FLAG_FLUSH_CLOSE) {
+               char *encoded = NULL;
+               size_t encoded_len = 0;
+               
+               http_encoding_deflate_stream_finish(buffer, &encoded, &encoded_len);
+               if (encoded) {
+                       out_avail = 1;
+                       NEW_BUCKET(encoded, encoded_len);
+                       efree(encoded);
+               }
+       }
+       
+       return out_avail ? PSFS_PASS_ON : PSFS_FEED_ME;
+}
+
+static HTTP_FILTER_FUNCTION(inflate)
+{
+       int out_avail = 0;
+       php_stream_bucket *ptr, *nxt;
+       HTTP_FILTER_BUFFER(inflate) *buffer = (HTTP_FILTER_BUFFER(inflate) *) this->abstract;
+       
+       if (bytes_consumed) {
+               *bytes_consumed = 0;
+       }
+       
+       /* new data available? */
+       if (buckets_in->head) {
+               
+               /* fetch available bucket data */
+               for (ptr = buckets_in->head; ptr; ptr = nxt) {
+                       char *decoded = NULL;
+                       size_t decoded_len = 0;
+                       
+                       nxt = ptr->next;
+                       if (bytes_consumed) {
+                               *bytes_consumed += ptr->buflen;
+                       }
+                       
+                       if (ptr->buflen) {
+                               http_encoding_inflate_stream_update(buffer, ptr->buf, ptr->buflen, &decoded, &decoded_len);
+                               if (decoded) {
+                                       out_avail = 1;
+                                       NEW_BUCKET(decoded, decoded_len);
+                                       efree(decoded);
+                               }
+                       }
+                       
+                       php_stream_bucket_unlink(ptr TSRMLS_CC);
+                       php_stream_bucket_delref(ptr TSRMLS_CC);
+               }
+       }
+       
+       /* flush & close */
+       if (flags & PSFS_FLAG_FLUSH_INC) {
+               char *decoded = NULL;
+               size_t decoded_len = 0;
+               
+               http_encoding_inflate_stream_flush(buffer, &decoded, &decoded_len);
+               if (decoded) {
+                       out_avail = 1;
+                       NEW_BUCKET(decoded, decoded_len);
+                       efree(decoded);
+               }
+       }
+       
+       if (flags & PSFS_FLAG_FLUSH_CLOSE) {
+               char *decoded = NULL;
+               size_t decoded_len = 0;
+               
+               http_encoding_inflate_stream_finish(buffer, &decoded, &decoded_len);
+               if (decoded) {
+                       out_avail = 1;
+                       NEW_BUCKET(decoded, decoded_len);
+                       efree(decoded);
+               }
+       }
+       
+       return out_avail ? PSFS_PASS_ON : PSFS_FEED_ME;
+}
+
+static HTTP_FILTER_DESTRUCTOR(deflate)
+{
+       HTTP_FILTER_BUFFER(deflate) *buffer = (HTTP_FILTER_BUFFER(deflate) *) this->abstract;
+       http_encoding_deflate_stream_free(&buffer);
+}
+
+static HTTP_FILTER_DESTRUCTOR(inflate)
+{
+       HTTP_FILTER_BUFFER(inflate) *buffer = (HTTP_FILTER_BUFFER(inflate) *) this->abstract;
+       http_encoding_inflate_stream_free(&buffer);
+}
+
+static HTTP_FILTER_OPS(deflate) = {
+       HTTP_FILTER_FUNC(deflate),
+       HTTP_FILTER_DTOR(deflate),
+       "http.deflate"
+};
+
+static HTTP_FILTER_OPS(inflate) = {
+       HTTP_FILTER_FUNC(inflate),
+       HTTP_FILTER_DTOR(inflate),
+       "http.inflate"
+};
+
+#endif /* HTTP_HAVE_ZLIB */
+
 static php_stream_filter *http_filter_create(const char *name, zval *params, int p TSRMLS_DC)
 {
+       zval **tmp = &params;
        php_stream_filter *f = NULL;
        
        if (!strcasecmp(name, "http.chunked_decode")) {
-               http_filter_buffer *b = NULL;
-               
-               /* FIXXME: allow usage with persistent streams */
-               if (p) {
-                       return NULL;
-               }
+               HTTP_FILTER_BUFFER(chunked_decode) *b = NULL;
                
-               if (b = pecalloc(1, sizeof(http_filter_buffer), p)) {
-                       phpstr_init(PHPSTR(b));
-                       if (!(f = php_stream_filter_alloc(&http_filter_ops_chunked_decode, b, p))) {
+               if ((b = pecalloc(1, sizeof(HTTP_FILTER_BUFFER(chunked_decode)), p))) {
+                       phpstr_init_ex(PHPSTR(b), 4096, p ? PHPSTR_INIT_PERSISTENT : 0);
+                       if (!(f = php_stream_filter_alloc(&HTTP_FILTER_OP(chunked_decode), b, p))) {
                                pefree(b, p);
                        }
                }
        } else
        
        if (!strcasecmp(name, "http.chunked_encode")) {
-               f = php_stream_filter_alloc(&http_filter_ops_chunked_encode, NULL, p);
+               f = php_stream_filter_alloc(&HTTP_FILTER_OP(chunked_encode), NULL, p);
+#ifdef HTTP_HAVE_ZLIB
+       } else
+       
+       if (!strcasecmp(name, "http.inflate")) {
+               int flags = p ? HTTP_ENCODING_STREAM_PERSISTENT : 0;
+               HTTP_FILTER_BUFFER(inflate) *b = NULL;
+               
+               if ((b = http_encoding_inflate_stream_init(NULL, flags))) {
+                       if (!(f = php_stream_filter_alloc(&HTTP_FILTER_OP(inflate), b, p))) {
+                               http_encoding_inflate_stream_free(&b);
+                       }
+               }
+       } else
+       
+       if (!strcasecmp(name, "http.deflate")) {
+               int flags = p ? HTTP_ENCODING_STREAM_PERSISTENT : 0;
+               HTTP_FILTER_BUFFER(deflate) *b = NULL;
+               
+               if (params) {
+                       switch (Z_TYPE_P(params))
+                       {
+                               case IS_ARRAY:
+                               case IS_OBJECT:
+                                       if (SUCCESS != zend_hash_find(HASH_OF(params), "flags", sizeof("flags"), (void *) &tmp)) {
+                                               break;
+                                       }
+                               default:
+                               {
+                                       zval *orig = *tmp;
+                                       
+                                       convert_to_long_ex(tmp);
+                                       flags |= (Z_LVAL_PP(tmp) & 0x0fffffff);
+                                       if (orig != *tmp) zval_ptr_dtor(tmp);
+                               }
+                       }
+               }
+               if ((b = http_encoding_deflate_stream_init(NULL, flags))) {
+                       if (!(f = php_stream_filter_alloc(&HTTP_FILTER_OP(deflate), b, p))) {
+                               http_encoding_deflate_stream_free(&b);
+                       }
+               }
+#endif /* HTTP_HAVE_ZLIB */
        }
        
        return f;
@@ -289,11 +512,7 @@ php_stream_filter_factory http_filter_factory = {
        http_filter_create
 };
 
-PHP_MINIT_FUNCTION(http_filter)
-{
-       php_stream_filter_register_factory("http.*", &http_filter_factory TSRMLS_CC);
-       return SUCCESS;
-}
+#endif /* ZEND_ENGINE_2 */
 
 /*
  * Local variables:
@@ -303,4 +522,3 @@ PHP_MINIT_FUNCTION(http_filter)
  * vim600: noet sw=4 ts=4 fdm=marker
  * vim<600: noet sw=4 ts=4
  */
-