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

   1 /*
   2    +----------------------------------------------------------------------+
   3    | PECL :: http                                                         |
   4    +----------------------------------------------------------------------+
   5    | This source file is subject to version 3.0 of the PHP license, that  |
   6    | is bundled with this package in the file LICENSE, and is available   |
   7    | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
   8    | If you did not receive a copy of the PHP license and are unable to   |
   9    | obtain it through the world-wide-web, please send a note to          |
  10    | license@php.net so we can mail you a copy immediately.               |
  11    +----------------------------------------------------------------------+
  12    | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
  13    +----------------------------------------------------------------------+
  14 */
  15
  16 /* $Id$ */
  17
  18 #ifndef PHP_HTTP_CACHE_API_H
  19 #define PHP_HTTP_CACHE_API_H
  20
  21 #include "php_http_std_defs.h"
  22 #include "php_http.h"
  23 #include "php_http_api.h"
  24 #include "php_http_send_api.h"
  25
  26 #include "zend_ini.h"
  27
  28 #ifdef HAVE_LIBMHASH
  29 #       include <mhash.h>
  30 #endif
  31
  32 ZEND_EXTERN_MODULE_GLOBALS(http);
  33
  34 typedef enum {
  35         HTTP_ETAG_MD5 = -2,
  36         HTTP_ETAG_SHA1 = -1,
  37         HTTP_ETAG_MHASH = 0,
  38 } http_etag_mode;
  39
  40 #ifdef HAVE_LIBMHASH
  41 static void *http_etag_alloc_mhash_digest(size_t size)
  42 {
  43         return emalloc(size);
  44 }
  45 #endif
  46
  47 #define http_etag_digest(d, l) _http_etag_digest((d), (l) TSRMLS_CC)
  48 static inline char *_http_etag_digest(const unsigned char *digest, int len TSRMLS_DC)
  49 {
  50         int i;
  51         char *hex = emalloc(len * 2 + 1);
  52         char *ptr = hex;
  53
  54         /* optimize this --
  55                 look at apache's make_etag */
  56         for (i = 0; i < len; ++i) {
  57                 sprintf(ptr, "%02x", digest[i]);
  58                 ptr += 2;
  59         }
  60         *ptr = '\0';
  61
  62         return hex;
  63 }
  64
  65 #define http_etag_init() _http_etag_init(TSRMLS_C)
  66 static inline void *_http_etag_init(TSRMLS_D)
  67 {
  68         void *ctx;
  69         long mode = INI_INT("http.etag_mode");
  70
  71         switch (mode)
  72         {
  73                 case HTTP_ETAG_SHA1:
  74                         PHP_SHA1Init(ctx = emalloc(sizeof(PHP_SHA1_CTX)));
  75                 break;
  76
  77                 case HTTP_ETAG_MD5:
  78 invalid_flag:
  79                         PHP_MD5Init(ctx = emalloc(sizeof(PHP_MD5_CTX)));
  80                 break;
  81
  82                 default:
  83                 {
  84 #ifdef HAVE_LIBMHASH
  85                         if ((mode >= 0) && (mode <= mhash_count())) {
  86                                 ctx = mhash_init(mode);
  87                         }
  88                         if ((!ctx) || (ctx == MHASH_FAILED))
  89 #endif
  90                         {
  91                                 HTTP_G(etag).mode = HTTP_ETAG_MD5;
  92                                 goto invalid_flag;
  93                         }
  94                 }
  95                 break;
  96         }
  97
  98         return ctx;
  99 }
 100
 101 #define http_etag_finish(c) _http_etag_finish((c) TSRMLS_CC)
 102 static inline char *_http_etag_finish(void *ctx TSRMLS_DC)
 103 {
 104         char *etag = NULL;
 105         unsigned char digest[20];
 106         long mode = INI_INT("http.etag_mode");
 107
 108         switch (mode)
 109         {
 110                 case HTTP_ETAG_SHA1:
 111                         PHP_SHA1Final(digest, ctx);
 112                         etag = http_etag_digest(digest, 20);
 113                         efree(ctx);
 114                 break;
 115
 116                 case HTTP_ETAG_MD5:
 117                         PHP_MD5Final(digest, ctx);
 118                         etag = http_etag_digest(digest, 16);
 119                         efree(ctx);
 120                 break;
 121
 122                 default:
 123                 {
 124 #ifdef HAVE_LIBMHASH
 125                         unsigned char *mhash_digest = mhash_end_m(ctx, http_etag_alloc_mhash_digest);
 126                         etag = http_etag_digest(mhash_digest, mhash_get_block_size(mode));
 127                         efree(mhash_digest);
 128 #endif
 129                 }
 130                 break;
 131         }
 132
 133         return etag;
 134 }
 135
 136 #define http_etag_update(c, d, l) _http_etag_update((c), (d), (l) TSRMLS_CC)
 137 static inline void _http_etag_update(void *ctx, const char *data_ptr, size_t data_len TSRMLS_DC)
 138 {
 139         switch (INI_INT("http.etag_mode"))
 140         {
 141                 case HTTP_ETAG_SHA1:
 142                         PHP_SHA1Update(ctx, data_ptr, data_len);
 143                 break;
 144
 145                 case HTTP_ETAG_MD5:
 146                         PHP_MD5Update(ctx, data_ptr, data_len);
 147                 break;
 148
 149                 default:
 150 #ifdef HAVE_LIBMHASH
 151                         mhash(ctx, data_ptr, data_len);
 152 #endif
 153                 break;
 154         }
 155 }
 156
 157 #define http_etag(p, l, m) _http_etag((p), (l), (m) TSRMLS_CC)
 158 PHP_HTTP_API char *_http_etag(const void *data_ptr, size_t data_len, http_send_mode data_mode TSRMLS_DC);
 159
 160 #define http_last_modified(p, m) _http_last_modified((p), (m) TSRMLS_CC)
 161 PHP_HTTP_API time_t _http_last_modified(const void *data_ptr, http_send_mode data_mode TSRMLS_DC);
 162
 163 #define http_match_last_modified(entry, modified) _http_match_last_modified_ex((entry), (modified), 1 TSRMLS_CC)
 164 #define http_match_last_modified_ex(entry, modified, ep) _http_match_last_modified_ex((entry), (modified), (ep) TSRMLS_CC)
 165 PHP_HTTP_API zend_bool _http_match_last_modified_ex(const char *entry, time_t t, zend_bool enforce_presence TSRMLS_DC);
 166
 167 #define http_match_etag(entry, etag) _http_match_etag_ex((entry), (etag), 1 TSRMLS_CC)
 168 #define http_match_etag_ex(entry, etag, ep) _http_match_etag_ex((entry), (etag), (ep) TSRMLS_CC)
 169 PHP_HTTP_API zend_bool _http_match_etag_ex(const char *entry, const char *etag, zend_bool enforce_presence TSRMLS_DC);
 170
 171 #define http_cache_last_modified(l, s, cc, ccl) _http_cache_last_modified((l), (s), (cc), (ccl) TSRMLS_CC)
 172 PHP_HTTP_API STATUS _http_cache_last_modified(time_t last_modified, time_t send_modified, const char *cache_control, size_t cc_len TSRMLS_DC);
 173
 174 #define http_cache_etag(e, el, cc, ccl) _http_cache_etag((e), (el), (cc), (ccl) TSRMLS_CC)
 175 PHP_HTTP_API STATUS _http_cache_etag(const char *etag, size_t etag_len, const char *cache_control, size_t cc_len TSRMLS_DC);
 176
 177 #define http_ob_etaghandler(o, l, ho, hl, m) _http_ob_etaghandler((o), (l), (ho), (hl), (m) TSRMLS_CC)
 178 PHP_HTTP_API void _http_ob_etaghandler(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC);
 179
 180 #endif
 181
 182 /*
 183  * Local variables:
 184  * tab-width: 4
 185  * c-basic-offset: 4
 186  * End:
 187  * vim600: noet sw=4 ts=4 fdm=marker
 188  * vim<600: noet sw=4 ts=4
 189  */
 190