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

   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-2006, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #define HTTP_WANT_SAPI
  16 #include "php_http.h"
  17
  18 #include "php_output.h"
  19 #include "php_streams.h"
  20
  21 #include "php_http_api.h"
  22 #include "php_http_cache_api.h"
  23 #include "php_http_date_api.h"
  24 #include "php_http_send_api.h"
  25
  26 /* {{{ char *http_etag(void *, size_t, http_send_mode) */
  27 PHP_HTTP_API char *_http_etag(const void *data_ptr, size_t data_len, http_send_mode data_mode TSRMLS_DC)
  28 {
  29         void *ctx = http_etag_init();
  30
  31         if (data_mode == SEND_DATA) {
  32                 http_etag_update(ctx, data_ptr, data_len);
  33         } else {
  34                 STATUS ss = FAILURE;
  35                 php_stream_statbuf ssb;
  36
  37                 if (data_mode == SEND_RSRC) {
  38                         ss = php_stream_stat((php_stream *) data_ptr, &ssb);
  39                 } else {
  40                         ss = php_stream_stat_path((char *) data_ptr, &ssb);
  41                 }
  42
  43                 if (SUCCESS != ss) {
  44                         efree(ctx);
  45                         return NULL;
  46                 } else {
  47                         size_t ssb_len;
  48                         char ssb_buf[128] = {0};
  49
  50                         ssb_len = snprintf(ssb_buf, 127, "%ld=%ld=%ld", (long) ssb.sb.st_mtime,
  51                                                                                                                         (long) ssb.sb.st_ino,
  52                                                                                                                         (long) ssb.sb.st_size);
  53                         http_etag_update(ctx, ssb_buf, ssb_len);
  54                 }
  55         }
  56
  57         return http_etag_finish(ctx);
  58 }
  59 /* }}} */
  60
  61 /* {{{ time_t http_last_modified(void *, http_send_mode) */
  62 PHP_HTTP_API time_t _http_last_modified(const void *data_ptr, http_send_mode data_mode TSRMLS_DC)
  63 {
  64         php_stream_statbuf ssb;
  65
  66         switch (data_mode) {
  67                 case SEND_DATA: return HTTP_G->request.time;
  68                 case SEND_RSRC: return php_stream_stat((php_stream *) data_ptr, &ssb) ? 0 : ssb.sb.st_mtime;
  69                 default:                return php_stream_stat_path((char *) data_ptr, &ssb) ? 0 : ssb.sb.st_mtime;
  70         }
  71 }
  72 /* }}} */
  73
  74 /* {{{ zend_bool http_match_last_modified(char *, time_t) */
  75 PHP_HTTP_API zend_bool _http_match_last_modified_ex(const char *entry, time_t t, zend_bool enforce_presence TSRMLS_DC)
  76 {
  77         zend_bool retval;
  78         zval *zmodified;
  79         char *modified, *chr_ptr;
  80
  81         if (!(zmodified = http_get_server_var(entry, 1))) {
  82                 return !enforce_presence;
  83         }
  84
  85         modified = estrndup(Z_STRVAL_P(zmodified), Z_STRLEN_P(zmodified));
  86         if ((chr_ptr = strrchr(modified, ';'))) {
  87                 chr_ptr = 0;
  88         }
  89
  90         retval = (t <= http_parse_date_ex(modified, 1));
  91         efree(modified);
  92         return retval;
  93 }
  94 /* }}} */
  95
  96 /* {{{ zend_bool http_match_etag(char *, char *) */
  97 PHP_HTTP_API zend_bool _http_match_etag_ex(const char *entry, const char *etag, zend_bool enforce_presence TSRMLS_DC)
  98 {
  99         zval *zetag;
 100         char *quoted_etag;
 101         zend_bool result;
 102
 103         if (!(zetag = http_get_server_var_ex(entry, strlen(entry)+1, 1))) {
 104                 return !enforce_presence;
 105         }
 106
 107         if (NULL != strchr(Z_STRVAL_P(zetag), '*')) {
 108                 return 1;
 109         }
 110
 111         spprintf(&quoted_etag, 0, "\"%s\"", etag);
 112         if (!strchr(Z_STRVAL_P(zetag), ',')) {
 113                 result = !strcmp(Z_STRVAL_P(zetag), quoted_etag);
 114         } else {
 115                 result = (NULL != strstr(Z_STRVAL_P(zetag), quoted_etag));
 116         }
 117         efree(quoted_etag);
 118
 119         return result;
 120 }
 121 /* }}} */
 122
 123 /* {{{ STATUS http_cache_last_modified(time_t, time_t, char *, size_t) */
 124 PHP_HTTP_API STATUS _http_cache_last_modified(time_t last_modified,
 125         time_t send_modified, const char *cache_control, size_t cc_len TSRMLS_DC)
 126 {
 127         char *sent_header = NULL;
 128
 129         if (SG(headers_sent)) {
 130                 return FAILURE;
 131         }
 132
 133         if (cc_len && (SUCCESS != http_send_cache_control(cache_control, cc_len))) {
 134                 return FAILURE;
 135         }
 136
 137         if (SUCCESS != http_send_last_modified_ex(send_modified, &sent_header)) {
 138                 return FAILURE;
 139         }
 140
 141         if (http_match_last_modified("HTTP_IF_MODIFIED_SINCE", last_modified)) {
 142                 http_exit_ex(304, sent_header, NULL, 0);
 143         } else {
 144                 STR_FREE(sent_header);
 145         }
 146
 147         return SUCCESS;
 148 }
 149 /* }}} */
 150
 151 /* {{{ STATUS http_cache_etag(char *, size_t, char *, size_t) */
 152 PHP_HTTP_API STATUS _http_cache_etag(const char *etag, size_t etag_len,
 153         const char *cache_control, size_t cc_len TSRMLS_DC)
 154 {
 155         char *sent_header = NULL;
 156
 157         if (SG(headers_sent)) {
 158                 return FAILURE;
 159         }
 160
 161         if (cc_len && (SUCCESS != http_send_cache_control(cache_control, cc_len))) {
 162                 return FAILURE;
 163         }
 164
 165         if (etag_len) {
 166                 if (SUCCESS != http_send_etag_ex(etag, etag_len, &sent_header)) {
 167                         return FAILURE;
 168                 }
 169                 if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
 170                         http_exit_ex(304, sent_header, NULL, 0);
 171                 } else {
 172                         STR_FREE(sent_header);
 173                 }
 174                 return SUCCESS;
 175         }
 176
 177         /* start ob_etaghandler */
 178         return http_start_ob_etaghandler();
 179 }
 180 /* }}} */
 181
 182 PHP_HTTP_API STATUS _http_start_ob_etaghandler(TSRMLS_D)
 183 {
 184         /* already running? */
 185         if (php_ob_handler_used("ob_etaghandler" TSRMLS_CC)) {
 186                 http_error(HE_WARNING, HTTP_E_RUNTIME, "ob_etaghandler can only be used once");
 187                 return FAILURE;
 188         }
 189
 190         HTTP_G->etag.started = 1;
 191         return php_start_ob_buffer_named("ob_etaghandler", HTTP_G->send.buffer_size, 0 TSRMLS_CC);
 192 }
 193
 194 PHP_HTTP_API zend_bool _http_interrupt_ob_etaghandler(TSRMLS_D)
 195 {
 196         if (HTTP_G->etag.started) {
 197                 HTTP_G->etag.started = 0;
 198                 if (HTTP_G->etag.ctx) {
 199                         efree(HTTP_G->etag.ctx);
 200                         HTTP_G->etag.ctx = NULL;
 201                 }
 202                 return 1;
 203         }
 204         return 0;
 205 }
 206
 207 /* {{{ void http_ob_etaghandler(char *, uint, char **, uint *, int) */
 208 void _http_ob_etaghandler(char *output, uint output_len,
 209         char **handled_output, uint *handled_output_len, int mode TSRMLS_DC)
 210 {
 211         /* passthru */
 212         *handled_output_len = output_len;
 213         *handled_output = estrndup(output, output_len);
 214
 215         /* are we supposed to run? */
 216         if (HTTP_G->etag.started) {
 217                 /* initialize the etag context */
 218                 if (mode & PHP_OUTPUT_HANDLER_START) {
 219                         HTTP_G->etag.ctx = http_etag_init();
 220                 }
 221
 222                 /* update */
 223                 http_etag_update(HTTP_G->etag.ctx, output, output_len);
 224
 225                 /* finish */
 226                 if (mode & PHP_OUTPUT_HANDLER_END) {
 227                         char *sent_header = NULL;
 228                         char *etag = http_etag_finish(HTTP_G->etag.ctx);
 229
 230                         HTTP_G->etag.ctx = NULL;
 231
 232                         http_send_cache_control(HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL));
 233                         http_send_etag_ex(etag, strlen(etag), &sent_header);
 234
 235                         if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
 236                                 /* force exit; ob within ob does not work */
 237                                 HTTP_G->force_exit = 1;
 238                                 http_exit_ex(304, sent_header, etag, 0);
 239                         }
 240
 241                         STR_FREE(sent_header);
 242                         STR_FREE(etag);
 243                 }
 244         }
 245 }
 246 /* }}} */
 247
 248 /*
 249  * Local variables:
 250  * tab-width: 4
 251  * c-basic-offset: 4
 252  * End:
 253  * vim600: sw=4 ts=4 fdm=marker
 254  * vim<600: sw=4 ts=4
 255  */
 256