git.m6w6.name Git - m6w6/ext-http/blob - php_http_encoding.h

   1 /*
   2     +--------------------------------------------------------------------+
   3     | PECL :: http                                                       |
   4     +--------------------------------------------------------------------+
   5     | Redistribution and use in source and binary forms, with or without |
   6     | modification, are permitted provided that the conditions mentioned |
   7     | in the accompanying LICENSE file are met.                          |
   8     +--------------------------------------------------------------------+
   9     | Copyright (c) 2004-2011, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 #ifndef PHP_HTTP_ENCODING_H
  14 #define PHP_HTTP_ENCODING_H
  15
  16 extern PHP_MINIT_FUNCTION(http_encoding);
  17 extern PHP_RINIT_FUNCTION(http_encoding);
  18 extern PHP_RSHUTDOWN_FUNCTION(http_encoding);
  19
  20 #define PHP_HTTP_INFLATE_ROUNDS 100
  21
  22 #define PHP_HTTP_DEFLATE_BUFFER_SIZE_GUESS(S) \
  23         (((size_t) ((double) S * (double) 1.015)) + 10 + 8 + 4 + 1)
  24 #define PHP_HTTP_INFLATE_BUFFER_SIZE_GUESS(S) \
  25         (((S) + 1) << 3)
  26 #define PHP_HTTP_INFLATE_BUFFER_SIZE_ALIGN(S) \
  27         ((S) += (S) >> (3))
  28
  29 #define PHP_HTTP_DEFLATE_BUFFER_SIZE            0x8000
  30 #define PHP_HTTP_INFLATE_BUFFER_SIZE            0x1000
  31
  32 #define PHP_HTTP_DEFLATE_LEVEL_DEF                      0x00000000
  33 #define PHP_HTTP_DEFLATE_LEVEL_MIN                      0x00000001
  34 #define PHP_HTTP_DEFLATE_LEVEL_MAX                      0x00000009
  35 #define PHP_HTTP_DEFLATE_TYPE_ZLIB                      0x00000000
  36 #define PHP_HTTP_DEFLATE_TYPE_GZIP                      0x00000010
  37 #define PHP_HTTP_DEFLATE_TYPE_RAW                       0x00000020
  38 #define PHP_HTTP_DEFLATE_STRATEGY_DEF           0x00000000
  39 #define PHP_HTTP_DEFLATE_STRATEGY_FILT          0x00000100
  40 #define PHP_HTTP_DEFLATE_STRATEGY_HUFF          0x00000200
  41 #define PHP_HTTP_DEFLATE_STRATEGY_RLE           0x00000300
  42 #define PHP_HTTP_DEFLATE_STRATEGY_FIXED         0x00000400
  43
  44 #define PHP_HTTP_DEFLATE_LEVEL_SET(flags, level) \
  45         switch (flags & 0xf) \
  46         { \
  47                 default: \
  48                         if ((flags & 0xf) < 10) { \
  49                                 level = flags & 0xf; \
  50                                 break; \
  51                         } \
  52                 case PHP_HTTP_DEFLATE_LEVEL_DEF: \
  53                         level = Z_DEFAULT_COMPRESSION; \
  54                 break; \
  55         }
  56
  57 #define PHP_HTTP_DEFLATE_WBITS_SET(flags, wbits) \
  58         switch (flags & 0xf0) \
  59         { \
  60                 case PHP_HTTP_DEFLATE_TYPE_GZIP: \
  61                         wbits = PHP_HTTP_WINDOW_BITS_GZIP; \
  62                 break; \
  63                 case PHP_HTTP_DEFLATE_TYPE_RAW: \
  64                         wbits = PHP_HTTP_WINDOW_BITS_RAW; \
  65                 break; \
  66                 default: \
  67                         wbits = PHP_HTTP_WINDOW_BITS_ZLIB; \
  68                 break; \
  69         }
  70
  71 #define PHP_HTTP_INFLATE_WBITS_SET(flags, wbits) \
  72         if (flags & PHP_HTTP_INFLATE_TYPE_RAW) { \
  73                 wbits = PHP_HTTP_WINDOW_BITS_RAW; \
  74 } else { \
  75                 wbits = PHP_HTTP_WINDOW_BITS_ANY; \
  76 }
  77
  78 #define PHP_HTTP_DEFLATE_STRATEGY_SET(flags, strategy) \
  79         switch (flags & 0xf00) \
  80         { \
  81                 case PHP_HTTP_DEFLATE_STRATEGY_FILT: \
  82                         strategy = Z_FILTERED; \
  83                 break; \
  84                 case PHP_HTTP_DEFLATE_STRATEGY_HUFF: \
  85                         strategy = Z_HUFFMAN_ONLY; \
  86                 break; \
  87                 case PHP_HTTP_DEFLATE_STRATEGY_RLE: \
  88                         strategy = Z_RLE; \
  89                 break; \
  90                 case PHP_HTTP_DEFLATE_STRATEGY_FIXED: \
  91                         strategy = Z_FIXED; \
  92                 break; \
  93                 default: \
  94                         strategy = Z_DEFAULT_STRATEGY; \
  95                 break; \
  96         }
  97
  98 #define PHP_HTTP_WINDOW_BITS_ZLIB       0x0000000f
  99 #define PHP_HTTP_WINDOW_BITS_GZIP       0x0000001f
 100 #define PHP_HTTP_WINDOW_BITS_ANY        0x0000002f
 101 #define PHP_HTTP_WINDOW_BITS_RAW        -0x000000f
 102
 103 #ifndef Z_FIXED
 104 /* Z_FIXED does not exist prior 1.2.2.2 */
 105 #       define Z_FIXED 0
 106 #endif
 107
 108 #define PHP_HTTP_INFLATE_TYPE_ZLIB                      0x00000000
 109 #define PHP_HTTP_INFLATE_TYPE_GZIP                      0x00000000
 110 #define PHP_HTTP_INFLATE_TYPE_RAW                       0x00000001
 111
 112 #define PHP_HTTP_ENCODING_STREAM_FLUSH_NONE     0x00000000
 113 #define PHP_HTTP_ENCODING_STREAM_FLUSH_SYNC 0x00100000
 114 #define PHP_HTTP_ENCODING_STREAM_FLUSH_FULL 0x00200000
 115
 116 #define PHP_HTTP_ENCODING_STREAM_FLUSH_FLAG(f) \
 117         (((f) & PHP_HTTP_ENCODING_STREAM_FLUSH_FULL) ? Z_FULL_FLUSH : \
 118         (((f) & PHP_HTTP_ENCODING_STREAM_FLUSH_SYNC) ? Z_SYNC_FLUSH : Z_NO_FLUSH))
 119
 120 #define PHP_HTTP_ENCODING_STREAM_PERSISTENT     0x01000000
 121
 122 typedef struct php_http_encoding_stream php_http_encoding_stream_t;
 123
 124 typedef php_http_encoding_stream_t *(*php_http_encoding_stream_init_func_t)(php_http_encoding_stream_t *s);
 125 typedef php_http_encoding_stream_t *(*php_http_encoding_stream_copy_func_t)(php_http_encoding_stream_t *from, php_http_encoding_stream_t *to);
 126 typedef STATUS (*php_http_encoding_stream_update_func_t)(php_http_encoding_stream_t *s, const char *in_str, size_t in_len, char **out_str, size_t *out_len);
 127 typedef STATUS (*php_http_encoding_stream_flush_func_t)(php_http_encoding_stream_t *s, char **out_str, size_t *out_len);
 128 typedef zend_bool (*php_http_encoding_stream_done_func_t)(php_http_encoding_stream_t *s);
 129 typedef STATUS (*php_http_encoding_stream_finish_func_t)(php_http_encoding_stream_t *s, char **out_str, size_t *out_len);
 130 typedef void (*php_http_encoding_stream_dtor_func_t)(php_http_encoding_stream_t *s);
 131
 132 typedef struct php_http_encoding_stream_ops {
 133         php_http_encoding_stream_init_func_t init;
 134         php_http_encoding_stream_copy_func_t copy;
 135         php_http_encoding_stream_update_func_t update;
 136         php_http_encoding_stream_flush_func_t flush;
 137         php_http_encoding_stream_done_func_t done;
 138         php_http_encoding_stream_finish_func_t finish;
 139         php_http_encoding_stream_dtor_func_t dtor;
 140 } php_http_encoding_stream_ops_t;
 141
 142 struct php_http_encoding_stream {
 143         unsigned flags;
 144         void *ctx;
 145         php_http_encoding_stream_ops_t *ops;
 146 #ifdef ZTS
 147         void ***ts;
 148 #endif
 149 };
 150
 151 extern php_http_encoding_stream_ops_t *php_http_encoding_stream_get_deflate_ops(void);
 152 extern php_http_encoding_stream_ops_t *php_http_encoding_stream_get_inflate_ops(void);
 153 extern php_http_encoding_stream_ops_t *php_http_encoding_stream_get_dechunk_ops(void);
 154
 155 PHP_HTTP_API php_http_encoding_stream_t *php_http_encoding_stream_init(php_http_encoding_stream_t *s, php_http_encoding_stream_ops_t *ops, unsigned flags TSRMLS_DC);
 156 PHP_HTTP_API php_http_encoding_stream_t *php_http_encoding_stream_copy(php_http_encoding_stream_t *from, php_http_encoding_stream_t *to);
 157 PHP_HTTP_API STATUS php_http_encoding_stream_reset(php_http_encoding_stream_t **s);
 158 PHP_HTTP_API STATUS php_http_encoding_stream_update(php_http_encoding_stream_t *s, const char *in_str, size_t in_len, char **out_str, size_t *out_len);
 159 PHP_HTTP_API STATUS php_http_encoding_stream_flush(php_http_encoding_stream_t *s, char **out_str, size_t *len);
 160 PHP_HTTP_API zend_bool php_http_encoding_stream_done(php_http_encoding_stream_t *s);
 161 PHP_HTTP_API STATUS php_http_encoding_stream_finish(php_http_encoding_stream_t *s, char **out_str, size_t *len);
 162 PHP_HTTP_API void php_http_encoding_stream_dtor(php_http_encoding_stream_t *s);
 163 PHP_HTTP_API void php_http_encoding_stream_free(php_http_encoding_stream_t **s);
 164
 165 PHP_HTTP_API const char *php_http_encoding_dechunk(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
 166 PHP_HTTP_API STATUS php_http_encoding_deflate(int flags, const char *data, size_t data_len, char **encoded, size_t *encoded_len TSRMLS_DC);
 167 PHP_HTTP_API STATUS php_http_encoding_inflate(const char *data, size_t data_len, char **decoded, size_t *decoded_len TSRMLS_DC);
 168
 169 typedef struct php_http_encoding_stream_object {
 170         zend_object zo;
 171         php_http_encoding_stream_t *stream;
 172 } php_http_encoding_stream_object_t;
 173
 174 extern zend_class_entry *php_http_encoding_stream_class_entry;
 175 extern zend_function_entry php_http_encoding_stream_method_entry[];
 176
 177 extern zend_object_value php_http_encoding_stream_object_new(zend_class_entry *ce TSRMLS_DC);
 178 extern zend_object_value php_http_encoding_stream_object_new_ex(zend_class_entry *ce, php_http_encoding_stream_t *s, php_http_encoding_stream_object_t **ptr TSRMLS_DC);
 179 extern zend_object_value php_http_encoding_stream_object_clone(zval *object TSRMLS_DC);
 180 extern void php_http_encoding_stream_object_free(void *object TSRMLS_DC);
 181
 182 extern zend_class_entry *php_http_deflate_stream_class_entry;
 183 extern zend_function_entry php_http_deflate_stream_method_entry[];
 184 extern zend_class_entry *php_http_inflate_stream_class_entry;
 185 extern zend_function_entry php_http_inflate_stream_method_entry[];
 186 extern zend_class_entry *php_http_dechunk_stream_class_entry;
 187 extern zend_function_entry php_http_dechunk_stream_method_entry[];
 188
 189 PHP_METHOD(HttpEncodingStream, __construct);
 190 PHP_METHOD(HttpEncodingStream, update);
 191 PHP_METHOD(HttpEncodingStream, flush);
 192 PHP_METHOD(HttpEncodingStream, done);
 193 PHP_METHOD(HttpEncodingStream, finish);
 194
 195 PHP_METHOD(HttpDeflateStream, encode);
 196 PHP_METHOD(HttpInflateStream, decode);
 197 PHP_METHOD(HttpDechunkStream, decode);
 198
 199 /*
 200 typedef struct php_http_inflatestream_object {
 201         zend_object zo;
 202         php_http_encoding_stream_t *stream;
 203 } php_http_inflatestream_object_t;
 204
 205 extern zend_class_entry *php_http_inflatestream_class_entry;
 206 extern zend_function_entry php_http_inflatestream_method_entry[];
 207
 208 extern zend_object_value php_http_inflatestream_object_new(zend_class_entry *ce TSRMLS_DC);
 209 extern zend_object_value php_http_inflatestream_object_new_ex(zend_class_entry *ce, php_http_encoding_stream_t *s, php_http_inflatestream_object_t **ptr TSRMLS_DC);
 210 extern zend_object_value php_http_inflatestream_object_clone(zval *object TSRMLS_DC);
 211 extern void php_http_inflatestream_object_free(void *object TSRMLS_DC);
 212
 213 PHP_METHOD(HttpInflateStream, __construct);
 214 PHP_METHOD(HttpInflateStream, factory);
 215 PHP_METHOD(HttpInflateStream, update);
 216 PHP_METHOD(HttpInflateStream, flush);
 217 PHP_METHOD(HttpInflateStream, finish);
 218 */
 219 #endif
 220
 221 /*
 222  * Local variables:
 223  * tab-width: 4
 224  * c-basic-offset: 4
 225  * End:
 226  * vim600: noet sw=4 ts=4 fdm=marker
 227  * vim<600: noet sw=4 ts=4
 228  */