git.m6w6.name Git - m6w6/ext-http/blob - http_cache_api.c

   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 #ifdef HAVE_CONFIG_H
  19 #       include "config.h"
  20 #endif
  21
  22 #include "php.h"
  23 #include "php_streams.h"
  24 #include "php_output.h"
  25 #include "ext/standard/md5.h"
  26
  27 #include "SAPI.h"
  28
  29 #include "php_http.h"
  30 #include "php_http_std_defs.h"
  31 #include "php_http_api.h"
  32 #include "php_http_cache_api.h"
  33 #include "php_http_send_api.h"
  34 #include "php_http_date_api.h"
  35
  36 ZEND_EXTERN_MODULE_GLOBALS(http);
  37
  38 /* {{{ STATUS http_cache_exit(char *, zend_bool) */
  39 STATUS _http_cache_exit_ex(char *cache_token, zend_bool etag, zend_bool free_token TSRMLS_DC)
  40 {
  41         if (HTTP_G(log).cache && strlen(HTTP_G(log).cache)) {
  42                 php_stream *log = php_stream_open_wrapper(HTTP_G(log).cache, "ab", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL);
  43
  44                 if (log) {
  45                         time_t now;
  46                         struct tm nowtm;
  47                         char datetime[128];
  48
  49                         time(&now);
  50                         strftime(datetime, sizeof(datetime), "%Y-%m-%d %H:%M:%S", php_localtime_r(&now, &nowtm));
  51                         php_stream_printf(log TSRMLS_CC, "%s [%s] %32s %s\n", datetime, etag ? "ETAG":"LMOD", cache_token, SG(request_info).request_uri);
  52                         php_stream_close(log);
  53                 }
  54         }
  55         if (free_token && cache_token) {
  56                 efree(cache_token);
  57         }
  58         return http_exit_ex(304, NULL, 0);
  59 }
  60 /* }}} */
  61
  62 /* {{{ char *http_etag(void *, size_t, http_send_mode) */
  63 PHP_HTTP_API char *_http_etag(const void *data_ptr, size_t data_len, http_send_mode data_mode TSRMLS_DC)
  64 {
  65         char ssb_buf[128] = {0};
  66         unsigned char digest[16];
  67         PHP_MD5_CTX ctx;
  68         char *new_etag = ecalloc(1, 33);
  69
  70         PHP_MD5Init(&ctx);
  71
  72         switch (data_mode)
  73         {
  74                 case SEND_DATA:
  75                         PHP_MD5Update(&ctx, data_ptr, data_len);
  76                 break;
  77
  78                 case SEND_RSRC:
  79                 {
  80                         php_stream_statbuf ssb;
  81
  82             if (php_stream_stat((php_stream *) data_ptr, &ssb)) {
  83                 return NULL;
  84             }
  85                         snprintf(ssb_buf, 127, "%ld=%ld=%ld", ssb.sb.st_mtime, ssb.sb.st_ino, ssb.sb.st_size);
  86                         PHP_MD5Update(&ctx, ssb_buf, strlen(ssb_buf));
  87                 }
  88                 break;
  89
  90                 default:
  91                         efree(new_etag);
  92                         return NULL;
  93                 break;
  94         }
  95
  96         PHP_MD5Final(digest, &ctx);
  97         make_digest(new_etag, digest);
  98
  99         return new_etag;
 100 }
 101 /* }}} */
 102
 103 /* {{{ time_t http_last_modified(void *, http_send_mode) */
 104 PHP_HTTP_API time_t _http_last_modified(const void *data_ptr, http_send_mode data_mode TSRMLS_DC)
 105 {
 106         php_stream_statbuf ssb;
 107
 108         switch (data_mode)
 109         {
 110                 case SEND_DATA: return time(NULL);
 111                 case SEND_RSRC: return php_stream_stat((php_stream *) data_ptr, &ssb) ? 0 : ssb.sb.st_mtime;
 112                 default:                return php_stream_stat_path(Z_STRVAL_P((zval *) data_ptr), &ssb) ? 0 : ssb.sb.st_mtime;
 113         }
 114 }
 115 /* }}} */
 116
 117 /* {{{ zend_bool http_match_last_modified(char *, time_t) */
 118 PHP_HTTP_API zend_bool _http_match_last_modified_ex(const char *entry, time_t t, zend_bool enforce_presence TSRMLS_DC)
 119 {
 120         zend_bool retval;
 121         zval *zmodified;
 122         char *modified, *chr_ptr;
 123
 124         HTTP_GSC(zmodified, entry, !enforce_presence);
 125
 126         modified = estrndup(Z_STRVAL_P(zmodified), Z_STRLEN_P(zmodified));
 127         if (chr_ptr = strrchr(modified, ';')) {
 128                 chr_ptr = 0;
 129         }
 130         retval = (t <= http_parse_date(modified));
 131         efree(modified);
 132         return retval;
 133 }
 134 /* }}} */
 135
 136 /* {{{ zend_bool http_match_etag(char *, char *) */
 137 PHP_HTTP_API zend_bool _http_match_etag_ex(const char *entry, const char *etag, zend_bool enforce_presence TSRMLS_DC)
 138 {
 139         zval *zetag;
 140         char *quoted_etag;
 141         zend_bool result;
 142
 143         HTTP_GSC(zetag, entry, !enforce_presence);
 144
 145         if (NULL != strchr(Z_STRVAL_P(zetag), '*')) {
 146                 return 1;
 147         }
 148
 149         quoted_etag = (char *) emalloc(strlen(etag) + 3);
 150         sprintf(quoted_etag, "\"%s\"", etag);
 151
 152         if (!strchr(Z_STRVAL_P(zetag), ',')) {
 153                 result = !strcmp(Z_STRVAL_P(zetag), quoted_etag);
 154         } else {
 155                 result = (NULL != strstr(Z_STRVAL_P(zetag), quoted_etag));
 156         }
 157         efree(quoted_etag);
 158         return result;
 159 }
 160 /* }}} */
 161
 162 /* {{{ STATUS http_cache_last_modified(time_t, time_t, char *, size_t) */
 163 PHP_HTTP_API STATUS _http_cache_last_modified(time_t last_modified,
 164         time_t send_modified, const char *cache_control, size_t cc_len TSRMLS_DC)
 165 {
 166         if (cc_len && (SUCCESS != http_send_cache_control(cache_control, cc_len))) {
 167                 return FAILURE;
 168         }
 169
 170         if (SUCCESS != http_send_last_modified(send_modified)) {
 171                 return FAILURE;
 172         }
 173
 174         if (http_match_last_modified("HTTP_IF_MODIFIED_SINCE", last_modified)) {
 175                 return http_cache_exit(http_date(last_modified), 0);
 176         }
 177
 178         return SUCCESS;
 179 }
 180 /* }}} */
 181
 182 /* {{{ STATUS http_cache_etag(char *, size_t, char *, size_t) */
 183 PHP_HTTP_API STATUS _http_cache_etag(const char *etag, size_t etag_len,
 184         const char *cache_control, size_t cc_len TSRMLS_DC)
 185 {
 186         if (cc_len && (SUCCESS != http_send_cache_control(cache_control, cc_len))) {
 187                 return FAILURE;
 188         }
 189
 190         if (etag_len) {
 191                 if (SUCCESS != http_send_etag(etag, etag_len)) {
 192                         return FAILURE;
 193                 }
 194                 if (!http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
 195                         return SUCCESS;
 196                 }
 197                 return http_cache_exit_ex((char *)etag, 1, 0);
 198         }
 199
 200         /* if no etag is given and we didn't already start ob_etaghandler -- start it */
 201         if (HTTP_G(etag).started) {
 202                 return SUCCESS;
 203         }
 204
 205         if (HTTP_G(etag).started = (SUCCESS == php_start_ob_buffer_named("ob_etaghandler", HTTP_SENDBUF_SIZE, 1 TSRMLS_CC))) {
 206                 return SUCCESS;
 207         } else {
 208                 return FAILURE;
 209         }
 210 }
 211 /* }}} */
 212
 213 /* {{{ void http_ob_etaghandler(char *, uint, char **, uint *, int) */
 214 PHP_HTTP_API void _http_ob_etaghandler(char *output, uint output_len,
 215         char **handled_output, uint *handled_output_len, int mode TSRMLS_DC)
 216 {
 217         char etag[33] = { 0 };
 218         unsigned char digest[16];
 219
 220         if (mode & PHP_OUTPUT_HANDLER_START) {
 221                 HTTP_G(etag).started = 1;
 222                 PHP_MD5Init(&HTTP_G(etag).md5ctx);
 223         }
 224
 225         PHP_MD5Update(&HTTP_G(etag).md5ctx, output, output_len);
 226
 227         if (mode & PHP_OUTPUT_HANDLER_END) {
 228                 PHP_MD5Final(digest, &HTTP_G(etag).md5ctx);
 229
 230                 /* just do that if desired */
 231                 if (HTTP_G(etag).started) {
 232                         make_digest(etag, digest);
 233                         http_send_header("Cache-Control: " HTTP_DEFAULT_CACHECONTROL);
 234                         http_send_etag(etag, 32);
 235
 236                         if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
 237                                 http_cache_exit_ex(etag, 1, 0);
 238                         }
 239                 }
 240         }
 241
 242         *handled_output_len = output_len;
 243         *handled_output = estrndup(output, output_len);
 244 }
 245 /* }}} */
 246
 247 /*
 248  * Local variables:
 249  * tab-width: 4
 250  * c-basic-offset: 4
 251  * End:
 252  * vim600: sw=4 ts=4 fdm=marker
 253  * vim<600: sw=4 ts=4
 254  */
 255