git.m6w6.name Git - m6w6/ext-http/blob - php_http_encoding_api.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-2007, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #ifndef PHP_HTTP_ENCODING_API_H
  16 #define PHP_HTTP_ENCODING_API_H
  17
  18 #define http_encoding_dechunk(e, el, d, dl) _http_encoding_dechunk((e), (el), (d), (dl) TSRMLS_CC)
  19 PHP_HTTP_API const char *_http_encoding_dechunk(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
  20
  21 #define http_encoding_response_start(cl, i) _http_encoding_response_start((cl), (i) TSRMLS_CC)
  22 PHP_HTTP_API int _http_encoding_response_start(size_t content_length, zend_bool ignore_http_ohandler TSRMLS_DC);
  23
  24 #ifdef HTTP_HAVE_ZLIB
  25
  26 extern PHP_MINIT_FUNCTION(http_encoding);
  27 extern PHP_RINIT_FUNCTION(http_encoding);
  28 extern PHP_RSHUTDOWN_FUNCTION(http_encoding);
  29
  30 typedef enum _http_encoding_type_t {
  31         HTTP_ENCODING_NONE,
  32         HTTP_ENCODING_GZIP,
  33         HTTP_ENCODING_DEFLATE,
  34 } http_encoding_type;
  35
  36 #define HTTP_INFLATE_ROUNDS 100
  37
  38 #define HTTP_DEFLATE_BUFFER_SIZE_GUESS(S) \
  39         (((size_t) ((double) S * (double) 1.015)) + 10 + 8 + 4 + 1)
  40 #define HTTP_INFLATE_BUFFER_SIZE_GUESS(S) \
  41         (((S) + 1) << 3)
  42 #define HTTP_INFLATE_BUFFER_SIZE_ALIGN(S) \
  43         ((S) += (S) >> (3))
  44
  45 #define HTTP_DEFLATE_BUFFER_SIZE                0x8000
  46 #define HTTP_INFLATE_BUFFER_SIZE                0x1000
  47
  48 #define HTTP_DEFLATE_LEVEL_DEF                  0x00000000
  49 #define HTTP_DEFLATE_LEVEL_MIN                  0x00000001
  50 #define HTTP_DEFLATE_LEVEL_MAX                  0x00000009
  51 #define HTTP_DEFLATE_TYPE_ZLIB                  0x00000000
  52 #define HTTP_DEFLATE_TYPE_GZIP                  0x00000010
  53 #define HTTP_DEFLATE_TYPE_RAW                   0x00000020
  54 #define HTTP_DEFLATE_STRATEGY_DEF               0x00000000
  55 #define HTTP_DEFLATE_STRATEGY_FILT              0x00000100
  56 #define HTTP_DEFLATE_STRATEGY_HUFF              0x00000200
  57 #define HTTP_DEFLATE_STRATEGY_RLE               0x00000300
  58 #define HTTP_DEFLATE_STRATEGY_FIXED             0x00000400
  59
  60 #define HTTP_DEFLATE_LEVEL_SET(flags, level) \
  61         switch (flags & 0xf) \
  62         { \
  63                 default: \
  64                         if ((flags & 0xf) < 10) { \
  65                                 level = flags & 0xf; \
  66                                 break; \
  67                         } \
  68                 case HTTP_DEFLATE_LEVEL_DEF: \
  69                         level = Z_DEFAULT_COMPRESSION; \
  70                 break; \
  71         }
  72
  73 #define HTTP_DEFLATE_WBITS_SET(flags, wbits) \
  74         switch (flags & 0xf0) \
  75         { \
  76                 case HTTP_DEFLATE_TYPE_GZIP: \
  77                         wbits = HTTP_WINDOW_BITS_GZIP; \
  78                 break; \
  79                 case HTTP_DEFLATE_TYPE_RAW: \
  80                         wbits = HTTP_WINDOW_BITS_RAW; \
  81                 break; \
  82                 default: \
  83                         wbits = HTTP_WINDOW_BITS_ZLIB; \
  84                 break; \
  85         }
  86
  87 #define HTTP_INFLATE_WBITS_SET(flags, wbits) \
  88         if (flags & HTTP_INFLATE_TYPE_RAW) { \
  89                 wbits = HTTP_WINDOW_BITS_RAW; \
  90 } else { \
  91                 wbits = HTTP_WINDOW_BITS_ANY; \
  92 }
  93
  94 #define HTTP_DEFLATE_STRATEGY_SET(flags, strategy) \
  95         switch (flags & 0xf00) \
  96         { \
  97                 case HTTP_DEFLATE_STRATEGY_FILT: \
  98                         strategy = Z_FILTERED; \
  99                 break; \
 100                 case HTTP_DEFLATE_STRATEGY_HUFF: \
 101                         strategy = Z_HUFFMAN_ONLY; \
 102                 break; \
 103                 case HTTP_DEFLATE_STRATEGY_RLE: \
 104                         strategy = Z_RLE; \
 105                 break; \
 106                 case HTTP_DEFLATE_STRATEGY_FIXED: \
 107                         strategy = Z_FIXED; \
 108                 break; \
 109                 default: \
 110                         strategy = Z_DEFAULT_STRATEGY; \
 111                 break; \
 112         }
 113
 114 #define HTTP_WINDOW_BITS_ZLIB   0x0000000f
 115 #define HTTP_WINDOW_BITS_GZIP   0x0000001f
 116 #define HTTP_WINDOW_BITS_ANY    0x0000002f
 117 #define HTTP_WINDOW_BITS_RAW    -0x000000f
 118
 119 #ifndef Z_FIXED
 120 /* Z_FIXED does not exist prior 1.2.2.2 */
 121 #       define Z_FIXED 0
 122 #endif
 123
 124 #define HTTP_INFLATE_TYPE_ZLIB                  0x00000000
 125 #define HTTP_INFLATE_TYPE_GZIP                  0x00000000
 126 #define HTTP_INFLATE_TYPE_RAW                   0x00000001
 127
 128 #define HTTP_ENCODING_STREAM_FLUSH_NONE 0x00000000
 129 #define HTTP_ENCODING_STREAM_FLUSH_SYNC 0x00100000
 130 #define HTTP_ENCODING_STREAM_FLUSH_FULL 0x00200000
 131
 132 #define HTTP_ENCODING_STREAM_FLUSH_FLAG(f) \
 133         (((f) & HTTP_ENCODING_STREAM_FLUSH_FULL) ? Z_FULL_FLUSH : \
 134         (((f) & HTTP_ENCODING_STREAM_FLUSH_SYNC) ? Z_SYNC_FLUSH : Z_NO_FLUSH))
 135
 136 #define HTTP_ENCODING_STREAM_PERSISTENT 0x01000000
 137
 138 typedef struct _http_encoding_stream_t {
 139         z_stream stream;
 140         int flags;
 141         void *storage;
 142 } http_encoding_stream;
 143
 144 #define http_encoding_deflate(f, d, dl, r, rl) _http_encoding_deflate((f), (d), (dl), (r), (rl) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 145 PHP_HTTP_API STATUS _http_encoding_deflate(int flags, const char *data, size_t data_len, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 146 #define http_encoding_inflate(d, dl, r, rl) _http_encoding_inflate((d), (dl), (r), (rl) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 147 PHP_HTTP_API STATUS _http_encoding_inflate(const char *data, size_t data_len, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 148
 149 #define http_encoding_deflate_stream_init(s, f) _http_encoding_deflate_stream_init((s), (f) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 150 PHP_HTTP_API http_encoding_stream *_http_encoding_deflate_stream_init(http_encoding_stream *s, int flags ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 151 #define http_encoding_deflate_stream_update(s, d, dl, e, el) _http_encoding_deflate_stream_update((s), (d), (dl), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 152 PHP_HTTP_API STATUS _http_encoding_deflate_stream_update(http_encoding_stream *s, const char *data, size_t data_len, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 153 #define http_encoding_deflate_stream_flush(s, e, el) _http_encoding_deflate_stream_flush((s), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 154 PHP_HTTP_API STATUS _http_encoding_deflate_stream_flush(http_encoding_stream *s, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 155 #define http_encoding_deflate_stream_finish(s, e, el) _http_encoding_deflate_stream_finish((s), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 156 PHP_HTTP_API STATUS _http_encoding_deflate_stream_finish(http_encoding_stream *s, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 157 #define http_encoding_deflate_stream_dtor(s) _http_encoding_deflate_stream_dtor((s) TSRMLS_CC)
 158 PHP_HTTP_API void _http_encoding_deflate_stream_dtor(http_encoding_stream *s TSRMLS_DC);
 159 #define http_encoding_deflate_stream_free(s) _http_encoding_deflate_stream_free((s) TSRMLS_CC)
 160 PHP_HTTP_API void _http_encoding_deflate_stream_free(http_encoding_stream **s TSRMLS_DC);
 161
 162 #define http_encoding_inflate_stream_init(s, f) _http_encoding_inflate_stream_init((s), (f) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 163 PHP_HTTP_API http_encoding_stream *_http_encoding_inflate_stream_init(http_encoding_stream *s, int flags ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 164 #define http_encoding_inflate_stream_update(s, d, dl, e, el) _http_encoding_inflate_stream_update((s), (d), (dl), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 165 PHP_HTTP_API STATUS _http_encoding_inflate_stream_update(http_encoding_stream *s, const char *data, size_t data_len, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 166 #define http_encoding_inflate_stream_flush(s, d, dl) _http_encoding_inflate_stream_flush((s), (d), (dl) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 167 PHP_HTTP_API STATUS _http_encoding_inflate_stream_flush(http_encoding_stream *s, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 168 #define http_encoding_inflate_stream_finish(s, e, el) _http_encoding_inflate_stream_finish((s), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
 169 PHP_HTTP_API STATUS _http_encoding_inflate_stream_finish(http_encoding_stream *s, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 170 #define http_encoding_inflate_stream_dtor(s) _http_encoding_inflate_stream_dtor((s) TSRMLS_CC)
 171 PHP_HTTP_API void _http_encoding_inflate_stream_dtor(http_encoding_stream *s TSRMLS_DC);
 172 #define http_encoding_inflate_stream_free(s) _http_encoding_inflate_stream_free((s) TSRMLS_CC)
 173 PHP_HTTP_API void _http_encoding_inflate_stream_free(http_encoding_stream **s TSRMLS_DC);
 174
 175 #define http_ob_deflatehandler(o, ol, h, hl, m) _http_ob_deflatehandler((o), (ol), (h), (hl), (m) TSRMLS_CC)
 176 extern void _http_ob_deflatehandler(char *, uint, char **, uint *, int TSRMLS_DC);
 177
 178 #define http_ob_inflatehandler(o, ol, h, hl, m) _http_ob_inflatehandler((o), (ol), (h), (hl), (m) TSRMLS_CC)
 179 extern void _http_ob_inflatehandler(char *, uint, char **, uint *, int TSRMLS_DC);
 180
 181 #endif /* HTTP_HAVE_ZLIB */
 182
 183 #endif
 184
 185 /*
 186  * Local variables:
 187  * tab-width: 4
 188  * c-basic-offset: 4
 189  * End:
 190  * vim600: noet sw=4 ts=4 fdm=marker
 191  * vim<600: noet sw=4 ts=4
 192  */