This commit was manufactured by cvs2svn to create tag 'RELEASE_1_3_1'.
[m6w6/ext-http] / 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 HTTP_GSC(zmodified, entry, !enforce_presence);
82
83 modified = estrndup(Z_STRVAL_P(zmodified), Z_STRLEN_P(zmodified));
84 if ((chr_ptr = strrchr(modified, ';'))) {
85 chr_ptr = 0;
86 }
87
88 retval = (t <= http_parse_date(modified));
89 efree(modified);
90 return retval;
91 }
92 /* }}} */
93
94 /* {{{ zend_bool http_match_etag(char *, char *) */
95 PHP_HTTP_API zend_bool _http_match_etag_ex(const char *entry, const char *etag, zend_bool enforce_presence TSRMLS_DC)
96 {
97 zval *zetag;
98 char *quoted_etag;
99 zend_bool result;
100
101 HTTP_GSC(zetag, entry, !enforce_presence);
102
103 if (NULL != strchr(Z_STRVAL_P(zetag), '*')) {
104 return 1;
105 }
106
107 spprintf(&quoted_etag, 0, "\"%s\"", etag);
108 if (!strchr(Z_STRVAL_P(zetag), ',')) {
109 result = !strcmp(Z_STRVAL_P(zetag), quoted_etag);
110 } else {
111 result = (NULL != strstr(Z_STRVAL_P(zetag), quoted_etag));
112 }
113 efree(quoted_etag);
114
115 return result;
116 }
117 /* }}} */
118
119 /* {{{ STATUS http_cache_last_modified(time_t, time_t, char *, size_t) */
120 PHP_HTTP_API STATUS _http_cache_last_modified(time_t last_modified,
121 time_t send_modified, const char *cache_control, size_t cc_len TSRMLS_DC)
122 {
123 char *sent_header = NULL;
124
125 if (SG(headers_sent)) {
126 return FAILURE;
127 }
128
129 if (cc_len && (SUCCESS != http_send_cache_control(cache_control, cc_len))) {
130 return FAILURE;
131 }
132
133 if (SUCCESS != http_send_last_modified_ex(send_modified, &sent_header)) {
134 return FAILURE;
135 }
136
137 if (http_match_last_modified("HTTP_IF_MODIFIED_SINCE", last_modified)) {
138 http_exit_ex(304, sent_header, NULL, 0);
139 } else {
140 STR_FREE(sent_header);
141 }
142
143 return SUCCESS;
144 }
145 /* }}} */
146
147 /* {{{ STATUS http_cache_etag(char *, size_t, char *, size_t) */
148 PHP_HTTP_API STATUS _http_cache_etag(const char *etag, size_t etag_len,
149 const char *cache_control, size_t cc_len TSRMLS_DC)
150 {
151 char *sent_header = NULL;
152
153 if (SG(headers_sent)) {
154 return FAILURE;
155 }
156
157 if (cc_len && (SUCCESS != http_send_cache_control(cache_control, cc_len))) {
158 return FAILURE;
159 }
160
161 if (etag_len) {
162 if (SUCCESS != http_send_etag_ex(etag, etag_len, &sent_header)) {
163 return FAILURE;
164 }
165 if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
166 http_exit_ex(304, sent_header, NULL, 0);
167 } else {
168 STR_FREE(sent_header);
169 }
170 return SUCCESS;
171 }
172
173 /* start ob_etaghandler */
174 return http_start_ob_etaghandler();
175 }
176 /* }}} */
177
178 PHP_HTTP_API STATUS _http_start_ob_etaghandler(TSRMLS_D)
179 {
180 /* already running? */
181 if (php_ob_handler_used("ob_etaghandler" TSRMLS_CC)) {
182 http_error(HE_WARNING, HTTP_E_RUNTIME, "ob_etaghandler can only be used once");
183 return FAILURE;
184 }
185
186 HTTP_G->etag.started = 1;
187 return php_start_ob_buffer_named("ob_etaghandler", HTTP_G->send.buffer_size, 0 TSRMLS_CC);
188 }
189
190 PHP_HTTP_API zend_bool _http_interrupt_ob_etaghandler(TSRMLS_D)
191 {
192 if (HTTP_G->etag.started) {
193 HTTP_G->etag.started = 0;
194 if (HTTP_G->etag.ctx) {
195 efree(HTTP_G->etag.ctx);
196 HTTP_G->etag.ctx = NULL;
197 }
198 return 1;
199 }
200 return 0;
201 }
202
203 /* {{{ void http_ob_etaghandler(char *, uint, char **, uint *, int) */
204 void _http_ob_etaghandler(char *output, uint output_len,
205 char **handled_output, uint *handled_output_len, int mode TSRMLS_DC)
206 {
207 /* passthru */
208 *handled_output_len = output_len;
209 *handled_output = estrndup(output, output_len);
210
211 /* are we supposed to run? */
212 if (HTTP_G->etag.started) {
213 /* initialize the etag context */
214 if (mode & PHP_OUTPUT_HANDLER_START) {
215 HTTP_G->etag.ctx = http_etag_init();
216 }
217
218 /* update */
219 http_etag_update(HTTP_G->etag.ctx, output, output_len);
220
221 /* finish */
222 if (mode & PHP_OUTPUT_HANDLER_END) {
223 char *sent_header = NULL;
224 char *etag = http_etag_finish(HTTP_G->etag.ctx);
225
226 HTTP_G->etag.ctx = NULL;
227
228 http_send_cache_control(HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL));
229 http_send_etag_ex(etag, strlen(etag), &sent_header);
230
231 if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
232 /* force exit; ob within ob does not work */
233 HTTP_G->force_exit = 1;
234 http_exit_ex(304, sent_header, etag, 0);
235 }
236
237 STR_FREE(sent_header);
238 STR_FREE(etag);
239 }
240 }
241 }
242 /* }}} */
243
244 /*
245 * Local variables:
246 * tab-width: 4
247 * c-basic-offset: 4
248 * End:
249 * vim600: sw=4 ts=4 fdm=marker
250 * vim<600: sw=4 ts=4
251 */
252