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 "zend_ini.h"
  22
  23 #include "ext/standard/md5.h"
  24 #include "ext/standard/sha1.h"
  25
  26 #include "php_http_std_defs.h"
  27 #include "php_http.h"
  28 #include "php_http_api.h"
  29 #include "php_http_send_api.h"
  30
  31 #ifdef HTTP_HAVE_MHASH
  32 #       include <mhash.h>
  33 #endif
  34
  35 ZEND_EXTERN_MODULE_GLOBALS(http);
  36
  37 typedef enum {
  38         HTTP_ETAG_MD5 = -2,
  39         HTTP_ETAG_SHA1 = -1,
  40         HTTP_ETAG_MHASH = 0,
  41 } http_etag_mode;
  42
  43 #ifdef HTTP_HAVE_MHASH
  44 static void *http_etag_alloc_mhash_digest(size_t size)
  45 {
  46         return emalloc(size);
  47 }
  48 #endif
  49
  50 #define http_etag_digest(d, l) _http_etag_digest((d), (l) TSRMLS_CC)
  51 static inline char *_http_etag_digest(const unsigned char *digest, int len TSRMLS_DC)
  52 {
  53         int i;
  54         char *hex = emalloc(len * 2 + 1);
  55         char *ptr = hex;
  56
  57         /* optimize this --
  58                 look at apache's make_etag */
  59         for (i = 0; i < len; ++i) {
  60                 sprintf(ptr, "%02x", digest[i]);
  61                 ptr += 2;
  62         }
  63         *ptr = '\0';
  64
  65         return hex;
  66 }
  67
  68 #define http_etag_init() _http_etag_init(TSRMLS_C)
  69 static inline void *_http_etag_init(TSRMLS_D)
  70 {
  71         void *ctx = NULL;
  72         long mode = INI_INT("http.etag_mode");
  73
  74         switch (mode)
  75         {
  76                 case HTTP_ETAG_SHA1:
  77                         PHP_SHA1Init(ctx = emalloc(sizeof(PHP_SHA1_CTX)));
  78                 break;
  79
  80                 case HTTP_ETAG_MD5:
  81 #ifndef HTTP_HAVE_MHASH
  82                 default:
  83 #endif
  84                         PHP_MD5Init(ctx = emalloc(sizeof(PHP_MD5_CTX)));
  85                 break;
  86
  87 #ifdef HTTP_HAVE_MHASH
  88                 default:
  89                         if ((mode < 0) || ((ulong)mode > mhash_count()) || (!(ctx = mhash_init(mode)))) {
  90                                 http_error_ex(HE_ERROR, HTTP_E_RUNTIME, "Invalid ETag mode: %ld", mode);
  91                         }
  92                 break;
  93 #endif
  94         }
  95
  96         return ctx;
  97 }
  98
  99 #define http_etag_finish(c) _http_etag_finish((c) TSRMLS_CC)
 100 static inline char *_http_etag_finish(void *ctx TSRMLS_DC)
 101 {
 102         char *etag = NULL;
 103         unsigned char digest[20];
 104         long mode = INI_INT("http.etag_mode");
 105
 106         switch (mode)
 107         {
 108                 case HTTP_ETAG_SHA1:
 109                         PHP_SHA1Final(digest, ctx);
 110                         etag = http_etag_digest(digest, 20);
 111                         efree(ctx);
 112                 break;
 113
 114                 case HTTP_ETAG_MD5:
 115 #ifndef HTTP_HAVE_MHASH
 116                 default:
 117 #endif
 118                         PHP_MD5Final(digest, ctx);
 119                         etag = http_etag_digest(digest, 16);
 120                         efree(ctx);
 121                 break;
 122
 123 #ifdef HTTP_HAVE_MHASH
 124                 default:
 125                 {
 126                         unsigned char *mhash_digest = mhash_end_m(ctx, http_etag_alloc_mhash_digest);
 127                         etag = http_etag_digest(mhash_digest, mhash_get_block_size(mode));
 128                         efree(mhash_digest);
 129                 }
 130                 break;
 131 #endif
 132         }
 133
 134         return etag;
 135 }
 136
 137 #define http_etag_update(c, d, l) _http_etag_update((c), (d), (l) TSRMLS_CC)
 138 static inline void _http_etag_update(void *ctx, const char *data_ptr, size_t data_len TSRMLS_DC)
 139 {
 140         switch (INI_INT("http.etag_mode"))
 141         {
 142                 case HTTP_ETAG_SHA1:
 143                         PHP_SHA1Update(ctx, (const unsigned char *) data_ptr, data_len);
 144                 break;
 145
 146                 case HTTP_ETAG_MD5:
 147 #ifndef HTTP_HAVE_MHASH
 148                 default:
 149 #endif
 150                         PHP_MD5Update(ctx, (const unsigned char *) data_ptr, data_len);
 151                 break;
 152
 153 #ifdef HTTP_HAVE_MHASH
 154                 default:
 155                         mhash(ctx, data_ptr, data_len);
 156                 break;
 157 #endif
 158         }
 159 }
 160
 161 #define http_etag(p, l, m) _http_etag((p), (l), (m) TSRMLS_CC)
 162 PHP_HTTP_API char *_http_etag(const void *data_ptr, size_t data_len, http_send_mode data_mode TSRMLS_DC);
 163
 164 #define http_last_modified(p, m) _http_last_modified((p), (m) TSRMLS_CC)
 165 PHP_HTTP_API time_t _http_last_modified(const void *data_ptr, http_send_mode data_mode TSRMLS_DC);
 166
 167 #define http_match_last_modified(entry, modified) _http_match_last_modified_ex((entry), (modified), 1 TSRMLS_CC)
 168 #define http_match_last_modified_ex(entry, modified, ep) _http_match_last_modified_ex((entry), (modified), (ep) TSRMLS_CC)
 169 PHP_HTTP_API zend_bool _http_match_last_modified_ex(const char *entry, time_t t, zend_bool enforce_presence TSRMLS_DC);
 170
 171 #define http_match_etag(entry, etag) _http_match_etag_ex((entry), (etag), 1 TSRMLS_CC)
 172 #define http_match_etag_ex(entry, etag, ep) _http_match_etag_ex((entry), (etag), (ep) TSRMLS_CC)
 173 PHP_HTTP_API zend_bool _http_match_etag_ex(const char *entry, const char *etag, zend_bool enforce_presence TSRMLS_DC);
 174
 175 #define http_cache_last_modified(l, s, cc, ccl) _http_cache_last_modified((l), (s), (cc), (ccl) TSRMLS_CC)
 176 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);
 177
 178 #define http_cache_etag(e, el, cc, ccl) _http_cache_etag((e), (el), (cc), (ccl) TSRMLS_CC)
 179 PHP_HTTP_API STATUS _http_cache_etag(const char *etag, size_t etag_len, const char *cache_control, size_t cc_len TSRMLS_DC);
 180
 181 #define http_ob_etaghandler(o, l, ho, hl, m) _http_ob_etaghandler((o), (l), (ho), (hl), (m) TSRMLS_CC)
 182 PHP_HTTP_API void _http_ob_etaghandler(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC);
 183
 184 #endif
 185
 186 /*
 187  * Local variables:
 188  * tab-width: 4
 189  * c-basic-offset: 4
 190  * End:
 191  * vim600: noet sw=4 ts=4 fdm=marker
 192  * vim<600: noet sw=4 ts=4
 193  */
 194