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