- set property default send buffer to 0 too
[m6w6/ext-http] / http_response_object.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 #define HTTP_WANT_MAGIC
17 #include "php_http.h"
18
19 /* broken static properties in PHP 5.0 */
20 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
21
22 #include "php_ini.h"
23
24 #include "php_http_api.h"
25 #include "php_http_cache_api.h"
26 #include "php_http_exception_object.h"
27 #include "php_http_headers_api.h"
28 #include "php_http_response_object.h"
29 #include "php_http_send_api.h"
30
31 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
32 #define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpResponse, method, 0)
33 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
34 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
35
36 HTTP_BEGIN_ARGS(setHeader, 2)
37 HTTP_ARG_VAL(name, 0)
38 HTTP_ARG_VAL(value, 0)
39 HTTP_ARG_VAL(replace, 0)
40 HTTP_END_ARGS;
41
42 HTTP_BEGIN_ARGS(getHeader, 0)
43 HTTP_ARG_VAL(name, 0)
44 HTTP_END_ARGS;
45
46 HTTP_EMPTY_ARGS(getETag);
47 HTTP_BEGIN_ARGS(setETag, 1)
48 HTTP_ARG_VAL(etag, 0)
49 HTTP_END_ARGS;
50
51 HTTP_EMPTY_ARGS(getLastModified);
52 HTTP_BEGIN_ARGS(setLastModified, 1)
53 HTTP_ARG_VAL(timestamp, 0)
54 HTTP_END_ARGS;
55
56 HTTP_EMPTY_ARGS(getCache);
57 HTTP_BEGIN_ARGS(setCache, 1)
58 HTTP_ARG_VAL(cache, 0)
59 HTTP_END_ARGS;
60
61 HTTP_EMPTY_ARGS(getGzip);
62 HTTP_BEGIN_ARGS(setGzip, 1)
63 HTTP_ARG_VAL(gzip, 0)
64 HTTP_END_ARGS;
65
66 HTTP_EMPTY_ARGS(getCacheControl);
67 HTTP_BEGIN_ARGS(setCacheControl, 1)
68 HTTP_ARG_VAL(cache_control, 0)
69 HTTP_ARG_VAL(max_age, 0)
70 HTTP_ARG_VAL(must_revalidate, 0)
71 HTTP_END_ARGS;
72
73 HTTP_EMPTY_ARGS(getContentType);
74 HTTP_BEGIN_ARGS(setContentType, 1)
75 HTTP_ARG_VAL(content_type, 0)
76 HTTP_END_ARGS;
77
78 HTTP_BEGIN_ARGS(guessContentType, 1)
79 HTTP_ARG_VAL(magic_file, 0)
80 HTTP_ARG_VAL(magic_mode, 0)
81 HTTP_END_ARGS;
82
83 HTTP_EMPTY_ARGS(getContentDisposition);
84 HTTP_BEGIN_ARGS(setContentDisposition, 1)
85 HTTP_ARG_VAL(filename, 0)
86 HTTP_ARG_VAL(send_inline, 0)
87 HTTP_END_ARGS;
88
89 HTTP_EMPTY_ARGS(getThrottleDelay);
90 HTTP_BEGIN_ARGS(setThrottleDelay, 1)
91 HTTP_ARG_VAL(seconds, 0)
92 HTTP_END_ARGS;
93
94 HTTP_EMPTY_ARGS(getBufferSize);
95 HTTP_BEGIN_ARGS(setBufferSize, 1)
96 HTTP_ARG_VAL(bytes, 0)
97 HTTP_END_ARGS;
98
99 HTTP_EMPTY_ARGS(getData);
100 HTTP_BEGIN_ARGS(setData, 1)
101 HTTP_ARG_VAL(data, 0)
102 HTTP_END_ARGS;
103
104 HTTP_EMPTY_ARGS(getStream);
105 HTTP_BEGIN_ARGS(setStream, 1)
106 HTTP_ARG_VAL(stream, 0)
107 HTTP_END_ARGS;
108
109 HTTP_EMPTY_ARGS(getFile);
110 HTTP_BEGIN_ARGS(setFile, 1)
111 HTTP_ARG_VAL(filepath, 0)
112 HTTP_END_ARGS;
113
114 HTTP_BEGIN_ARGS(send, 0)
115 HTTP_ARG_VAL(clean_ob, 0)
116 HTTP_END_ARGS;
117
118 HTTP_EMPTY_ARGS(capture);
119
120 HTTP_BEGIN_ARGS(redirect, 0)
121 HTTP_ARG_VAL(url, 0)
122 HTTP_ARG_VAL(params, 0)
123 HTTP_ARG_VAL(session, 0)
124 HTTP_ARG_VAL(permanent, 0)
125 HTTP_END_ARGS;
126
127 HTTP_BEGIN_ARGS(status, 1)
128 HTTP_ARG_VAL(code, 0)
129 HTTP_END_ARGS;
130
131 HTTP_EMPTY_ARGS(getRequestHeaders);
132 HTTP_EMPTY_ARGS(getRequestBody);
133 HTTP_EMPTY_ARGS(getRequestBodyStream);
134
135 #define http_grab_response_headers _http_grab_response_headers
136 static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC);
137
138 #define OBJ_PROP_CE http_response_object_ce
139 zend_class_entry *http_response_object_ce;
140 zend_function_entry http_response_object_fe[] = {
141
142 HTTP_RESPONSE_ME(setHeader, ZEND_ACC_PUBLIC)
143 HTTP_RESPONSE_ME(getHeader, ZEND_ACC_PUBLIC)
144
145 HTTP_RESPONSE_ME(setETag, ZEND_ACC_PUBLIC)
146 HTTP_RESPONSE_ME(getETag, ZEND_ACC_PUBLIC)
147
148 HTTP_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC)
149 HTTP_RESPONSE_ME(getLastModified, ZEND_ACC_PUBLIC)
150
151 HTTP_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC)
152 HTTP_RESPONSE_ME(getContentDisposition, ZEND_ACC_PUBLIC)
153
154 HTTP_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC)
155 HTTP_RESPONSE_ME(getContentType, ZEND_ACC_PUBLIC)
156
157 HTTP_RESPONSE_ME(guessContentType, ZEND_ACC_PUBLIC)
158
159 HTTP_RESPONSE_ME(setCache, ZEND_ACC_PUBLIC)
160 HTTP_RESPONSE_ME(getCache, ZEND_ACC_PUBLIC)
161
162 HTTP_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
163 HTTP_RESPONSE_ME(getCacheControl, ZEND_ACC_PUBLIC)
164
165 HTTP_RESPONSE_ME(setGzip, ZEND_ACC_PUBLIC)
166 HTTP_RESPONSE_ME(getGzip, ZEND_ACC_PUBLIC)
167
168 HTTP_RESPONSE_ME(setThrottleDelay, ZEND_ACC_PUBLIC)
169 HTTP_RESPONSE_ME(getThrottleDelay, ZEND_ACC_PUBLIC)
170
171 HTTP_RESPONSE_ME(setBufferSize, ZEND_ACC_PUBLIC)
172 HTTP_RESPONSE_ME(getBufferSize, ZEND_ACC_PUBLIC)
173
174 HTTP_RESPONSE_ME(setData, ZEND_ACC_PUBLIC)
175 HTTP_RESPONSE_ME(getData, ZEND_ACC_PUBLIC)
176
177 HTTP_RESPONSE_ME(setFile, ZEND_ACC_PUBLIC)
178 HTTP_RESPONSE_ME(getFile, ZEND_ACC_PUBLIC)
179
180 HTTP_RESPONSE_ME(setStream, ZEND_ACC_PUBLIC)
181 HTTP_RESPONSE_ME(getStream, ZEND_ACC_PUBLIC)
182
183 HTTP_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
184 HTTP_RESPONSE_ME(capture, ZEND_ACC_PUBLIC)
185
186 HTTP_RESPONSE_ALIAS(redirect, http_redirect)
187 HTTP_RESPONSE_ALIAS(status, http_send_status)
188 HTTP_RESPONSE_ALIAS(getRequestHeaders, http_get_request_headers)
189 HTTP_RESPONSE_ALIAS(getRequestBody, http_get_request_body)
190 HTTP_RESPONSE_ALIAS(getRequestBodyStream, http_get_request_body_stream)
191
192 EMPTY_FUNCTION_ENTRY
193 };
194
195 PHP_MINIT_FUNCTION(http_response_object)
196 {
197 HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0);
198
199 DCL_STATIC_PROP(PRIVATE, bool, sent, 0);
200 DCL_STATIC_PROP(PRIVATE, bool, catch, 0);
201 DCL_STATIC_PROP(PRIVATE, long, mode, -1);
202 DCL_STATIC_PROP(PRIVATE, long, stream, 0);
203 DCL_STATIC_PROP_N(PRIVATE, file);
204 DCL_STATIC_PROP_N(PRIVATE, data);
205 DCL_STATIC_PROP(PROTECTED, bool, cache, 0);
206 DCL_STATIC_PROP(PROTECTED, bool, gzip, 0);
207 DCL_STATIC_PROP_N(PROTECTED, eTag);
208 DCL_STATIC_PROP(PROTECTED, long, lastModified, 0);
209 DCL_STATIC_PROP_N(PROTECTED, cacheControl);
210 DCL_STATIC_PROP_N(PROTECTED, contentType);
211 DCL_STATIC_PROP_N(PROTECTED, contentDisposition);
212 DCL_STATIC_PROP(PROTECTED, long, bufferSize, 0);
213 DCL_STATIC_PROP(PROTECTED, double, throttleDelay, 0.0);
214
215 #ifndef WONKY
216 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT);
217 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM);
218 DCL_CONST(long, "REDIRECT_FOUND", HTTP_REDIRECT_FOUND);
219 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST);
220 DCL_CONST(long, "REDIRECT_PROXY", HTTP_REDIRECT_PROXY);
221 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP);
222 #endif /* WONKY */
223
224 return SUCCESS;
225 }
226
227 static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC)
228 {
229 phpstr_appendl(PHPSTR(arg), ((sapi_header_struct *)data)->header);
230 phpstr_appends(PHPSTR(arg), HTTP_CRLF);
231 }
232
233 /* ### USERLAND ### */
234
235 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
236 *
237 * Send an HTTP header.
238 *
239 * Expects a string parameter containing the name of the header and a mixed
240 * parameter containing the value of the header, which will be converted to
241 * a string. Additionally accepts an optional boolean parameter, which
242 * specifies whether an existing header should be replaced. If the second
243 * parameter is unset no header with this name will be sent.
244 *
245 * Returns TRUE on success, or FALSE on failure.
246 *
247 * Throws HttpHeaderException if http.only_exceptions is TRUE.
248 */
249 PHP_METHOD(HttpResponse, setHeader)
250 {
251 zend_bool replace = 1;
252 char *name;
253 int name_len = 0;
254 zval *value = NULL, *orig = NULL;
255
256 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz/!|b", &name, &name_len, &value, &replace)) {
257 RETURN_FALSE;
258 }
259 if (SG(headers_sent)) {
260 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot add another header when headers have already been sent");
261 RETURN_FALSE;
262 }
263 if (!name_len) {
264 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot send anonymous headers");
265 RETURN_FALSE;
266 }
267
268 /* delete header if value == null */
269 if (!value || Z_TYPE_P(value) == IS_NULL) {
270 RETURN_SUCCESS(http_send_header_ex(name, name_len, "", 0, replace, NULL));
271 }
272 /* send multiple header if replace is false and value is an array */
273 if (!replace && Z_TYPE_P(value) == IS_ARRAY) {
274 zval **data;
275 HashPosition pos;
276
277 FOREACH_VAL(pos, value, data) {
278 zval *orig = *data;
279
280 convert_to_string_ex(data);
281 if (SUCCESS != http_send_header_ex(name, name_len, Z_STRVAL_PP(data), Z_STRLEN_PP(data), 0, NULL)) {
282 if (orig != *data) {
283 zval_ptr_dtor(data);
284 }
285 RETURN_FALSE;
286 }
287 if (orig != *data) {
288 zval_ptr_dtor(data);
289 }
290 }
291 RETURN_TRUE;
292 }
293 /* send standard header */
294 orig = value;
295 convert_to_string_ex(&value);
296 RETVAL_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL));
297 if (orig != value) {
298 zval_ptr_dtor(&value);
299 }
300 }
301 /* }}} */
302
303 /* {{{ proto static mixed HttpResponse::getHeader([string name])
304 *
305 * Get header(s) about to be sent.
306 *
307 * Accepts a string as optional parameter which specifies the name of the
308 * header to read. If the parameter is empty or omitted, an associative array
309 * with all headers will be returned.
310 *
311 * NOTE: In Apache2 this only works for PHP-5.1.3 and greater.
312 *
313 * Returns either a string containing the value of the header matching name,
314 * FALSE on failure, or an associative array with all headers.
315 */
316 PHP_METHOD(HttpResponse, getHeader)
317 {
318 char *name = NULL;
319 int name_len = 0;
320 phpstr headers;
321
322 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &name, &name_len)) {
323 RETURN_FALSE;
324 }
325
326 phpstr_init(&headers);
327 zend_llist_apply_with_argument(&SG(sapi_headers).headers, http_grab_response_headers, &headers TSRMLS_CC);
328 phpstr_fix(&headers);
329
330 if (name && name_len) {
331 zval **header;
332 HashTable headers_ht;
333
334 zend_hash_init(&headers_ht, sizeof(zval *), NULL, ZVAL_PTR_DTOR, 0);
335 if ( (SUCCESS == http_parse_headers_ex(PHPSTR_VAL(&headers), &headers_ht, 1)) &&
336 (SUCCESS == zend_hash_find(&headers_ht, name, name_len + 1, (void *) &header))) {
337 RETVAL_ZVAL(*header, 1, 0);
338 } else {
339 RETVAL_NULL();
340 }
341 zend_hash_destroy(&headers_ht);
342 } else {
343 array_init(return_value);
344 http_parse_headers_ex(PHPSTR_VAL(&headers), Z_ARRVAL_P(return_value), 1);
345 }
346
347 phpstr_dtor(&headers);
348 }
349 /* }}} */
350
351 /* {{{ proto static bool HttpResponse::setCache(bool cache)
352 *
353 * Whether it should be attempted to cache the entity.
354 * This will result in necessary caching headers and checks of clients
355 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
356 * matches a "304 Not Modified" status code will be issued.
357 *
358 * NOTE: If you're using sessions, be sure that you set session.cache_limiter
359 * to something more appropriate than "no-cache"!
360 *
361 * Expects a boolean as parameter specifying whether caching should be attempted.
362 *
363 * Returns TRUE on success, or FALSE on failure.
364 */
365 PHP_METHOD(HttpResponse, setCache)
366 {
367 zend_bool do_cache = 0;
368
369 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_cache)) {
370 RETURN_FALSE;
371 }
372
373 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache, do_cache));
374 }
375 /* }}} */
376
377 /* {{{ proto static bool HttpResponse::getCache()
378 *
379 * Get current caching setting.
380 *
381 * Returns TRUE if caching should be attempted, else FALSE.
382 */
383 PHP_METHOD(HttpResponse, getCache)
384 {
385 NO_ARGS;
386
387 if (return_value_used) {
388 zval *cache_p, *cache = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache), &cache_p);
389
390 RETVAL_ZVAL(cache, 1, 0);
391
392 if (cache_p) {
393 zval_ptr_dtor(&cache_p);
394 }
395 }
396 }
397 /* }}}*/
398
399 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
400 *
401 * Enable on-thy-fly gzipping of the sent entity.
402 *
403 * Expects a boolean as parameter indicating if GZip compression should be enabled.
404 *
405 * Returns TRUE on success, or FALSE on failure.
406 */
407 PHP_METHOD(HttpResponse, setGzip)
408 {
409 zend_bool do_gzip = 0;
410
411 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_gzip)) {
412 RETURN_FALSE;
413 }
414
415 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip, do_gzip));
416 }
417 /* }}} */
418
419 /* {{{ proto static bool HttpResponse::getGzip()
420 *
421 * Get current gzipping setting.
422 *
423 * Returns TRUE if GZip compression is enabled, else FALSE.
424 */
425 PHP_METHOD(HttpResponse, getGzip)
426 {
427 NO_ARGS;
428
429 if (return_value_used) {
430 zval *gzip_p, *gzip = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(gzip), &gzip_p);
431
432 RETVAL_ZVAL(gzip, 1, 0);
433
434 if (gzip_p) {
435 zval_ptr_dtor(&gzip_p);
436 }
437 }
438 }
439 /* }}} */
440
441 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0[, bool must_revalidate = true]])
442 *
443 * Set a custom cache-control header, usually being "private" or "public";
444 * The max_age parameter controls how long the cache entry is valid on the client side.
445 *
446 * Expects a string parameter containing the primary cache control setting.
447 * Additionally accepts an int parameter specifying the max-age setting.
448 * Accepts an optional third bool parameter indicating whether the cache
449 * must be revalidated every request.
450 *
451 * Returns TRUE on success, or FALSE if control does not match one of
452 * "public" , "private" or "no-cache".
453 *
454 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
455 */
456 PHP_METHOD(HttpResponse, setCacheControl)
457 {
458 char *ccontrol, *cctl;
459 int cc_len;
460 long max_age = 0;
461 zend_bool must_revalidate = 1;
462
463 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|lb", &ccontrol, &cc_len, &max_age, &must_revalidate)) {
464 RETURN_FALSE;
465 }
466
467 if (strcmp(ccontrol, "public") && strcmp(ccontrol, "private") && strcmp(ccontrol, "no-cache")) {
468 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol);
469 RETURN_FALSE;
470 } else {
471 size_t cctl_len = spprintf(&cctl, 0, "%s,%s max-age=%ld", ccontrol, must_revalidate?" must-revalidate,":"", max_age);
472 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl, cctl, cctl_len));
473 efree(cctl);
474 }
475 }
476 /* }}} */
477
478 /* {{{ proto static string HttpResponse::getCacheControl()
479 *
480 * Get current Cache-Control header setting.
481 *
482 * Returns the current cache control setting as a string like sent in a header.
483 */
484 PHP_METHOD(HttpResponse, getCacheControl)
485 {
486 NO_ARGS;
487
488 if (return_value_used) {
489 zval *ccontrol_p, *ccontrol = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl), &ccontrol_p);
490
491 RETVAL_ZVAL(ccontrol, 1, 0);
492
493 if (ccontrol_p) {
494 zval_ptr_dtor(&ccontrol_p);
495 }
496 }
497 }
498 /* }}} */
499
500 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
501 *
502 * Set the content-type of the sent entity.
503 *
504 * Expects a string as parameter specifying the content type of the sent entity.
505 *
506 * Returns TRUE on success, or FALSE if the content type does not seem to
507 * contain a primary and secondary content type part.
508 *
509 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
510 */
511 PHP_METHOD(HttpResponse, setContentType)
512 {
513 char *ctype;
514 int ctype_len;
515
516 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ctype_len)) {
517 RETURN_FALSE;
518 }
519
520 HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE);
521 RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len));
522 }
523 /* }}} */
524
525 /* {{{ proto static string HttpResponse::getContentType()
526 *
527 * Get current Content-Type header setting.
528 *
529 * Returns the currently set content type as string.
530 */
531 PHP_METHOD(HttpResponse, getContentType)
532 {
533 NO_ARGS;
534
535 if (return_value_used) {
536 zval *ctype_p, *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType), &ctype_p);
537
538 RETVAL_ZVAL(ctype, 1, 0);
539
540 if (ctype_p) {
541 zval_ptr_dtor(&ctype_p);
542 }
543 }
544 }
545 /* }}} */
546
547 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
548 *
549 * Attempts to guess the content type of supplied payload through libmagic.
550 * If the attempt is successful, the guessed content type will automatically
551 * be set as response content type.
552 *
553 * Expects a string parameter specifying the magic.mime database to use.
554 * Additionally accepts an optional int parameter, being flags for libmagic.
555 *
556 * Returns the guessed content type on success, or FALSE on failure.
557 *
558 * Throws HttpRuntimeException, HttpInvalidParamException
559 * if http.only_exceptions is TRUE.
560 */
561 PHP_METHOD(HttpResponse, guessContentType)
562 {
563 #ifdef HTTP_HAVE_MAGIC
564 char *magic_file, *ct = NULL;
565 int magic_file_len;
566 long magic_mode = MAGIC_MIME;
567
568 RETVAL_FALSE;
569 SET_EH_THROW_HTTP();
570 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &magic_file, &magic_file_len, &magic_mode)) {
571 switch (Z_LVAL_P(GET_STATIC_PROP(mode))) {
572 case SEND_DATA:
573 {
574 zval *data = GET_STATIC_PROP(data);
575 ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(data), Z_STRLEN_P(data), SEND_DATA);
576 break;
577 }
578
579 case SEND_RSRC:
580 {
581 php_stream *s;
582 zval *z = GET_STATIC_PROP(stream);
583 z->type = IS_RESOURCE;
584 php_stream_from_zval(s, &z);
585 ct = http_guess_content_type(magic_file, magic_mode, s, 0, SEND_RSRC);
586 break;
587 }
588
589 default:
590 ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(GET_STATIC_PROP(file)), 0, -1);
591 break;
592 }
593 if (ct) {
594 UPD_STATIC_PROP(string, contentType, ct);
595 RETVAL_STRING(ct, 0);
596 }
597 }
598 SET_EH_NORMAL();
599 #else
600 http_error(HE_THROW, HTTP_E_RUNTIME, "Cannot guess Content-Type; libmagic not available");
601 RETURN_FALSE;
602 #endif
603 }
604 /* }}} */
605
606 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
607 *
608 * Set the Content-Disposition. The Content-Disposition header is very useful
609 * if the data actually sent came from a file or something similar, that should
610 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
611 *
612 * Expects a string parameter specifying the file name the "Save as..." dialog
613 * should display. Optionally accepts a bool parameter, which, if set to true
614 * and the user agent knows how to handle the content type, will probably not
615 * cause the popup window to be shown.
616 *
617 * Returns TRUE on success or FALSE on failure.
618 */
619 PHP_METHOD(HttpResponse, setContentDisposition)
620 {
621 char *file, *cd;
622 int file_len;
623 size_t cd_len;
624 zend_bool send_inline = 0;
625
626 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &send_inline)) {
627 RETURN_FALSE;
628 }
629
630 cd_len = spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file);
631 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition, cd, cd_len));
632 efree(cd);
633 }
634 /* }}} */
635
636 /* {{{ proto static string HttpResponse::getContentDisposition()
637 *
638 * Get current Content-Disposition setting.
639 *
640 * Returns the current content disposition as string like sent in a header.
641 */
642 PHP_METHOD(HttpResponse, getContentDisposition)
643 {
644 NO_ARGS;
645
646 if (return_value_used) {
647 zval *cd_p, *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition), &cd_p);
648
649 RETVAL_ZVAL(cd, 1, 0);
650
651 if (cd_p) {
652 zval_ptr_dtor(&cd_p);
653 }
654 }
655 }
656 /* }}} */
657
658 /* {{{ proto static bool HttpResponse::setETag(string etag)
659 *
660 * Set a custom ETag. Use this only if you know what you're doing.
661 *
662 * Expects an unquoted string as parameter containing the ETag.
663 *
664 * Returns TRUE on success, or FALSE on failure.
665 */
666 PHP_METHOD(HttpResponse, setETag)
667 {
668 char *etag;
669 int etag_len;
670
671 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len)) {
672 RETURN_FALSE;
673 }
674
675 RETURN_SUCCESS(UPD_STATIC_STRL(eTag, etag, etag_len));
676 }
677 /* }}} */
678
679 /* {{{ proto static string HttpResponse::getETag()
680 *
681 * Get calculated or previously set custom ETag.
682 *
683 * Returns the calculated or previously set ETag as unquoted string.
684 */
685 PHP_METHOD(HttpResponse, getETag)
686 {
687 NO_ARGS;
688
689 if (return_value_used) {
690 zval *etag_p, *etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p);
691
692 RETVAL_ZVAL(etag, 1, 0);
693
694 if (etag_p) {
695 zval_ptr_dtor(&etag_p);
696 }
697 }
698 }
699 /* }}} */
700
701 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
702 *
703 * Set a custom Last-Modified date.
704 *
705 * Expects an unix timestamp as parameter representing the last modification
706 * time of the sent entity.
707 *
708 * Returns TRUE on success, or FALSE on failure.
709 */
710 PHP_METHOD(HttpResponse, setLastModified)
711 {
712 long lm;
713
714 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &lm)) {
715 RETURN_FALSE;
716 }
717
718 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified, lm));
719 }
720 /* }}} */
721
722 /* {{{ proto static int HttpResponse::getLastModified()
723 *
724 * Get calculated or previously set custom Last-Modified date.
725 *
726 * Returns the calculated or previously set unix timestamp.
727 */
728 PHP_METHOD(HttpResponse, getLastModified)
729 {
730 NO_ARGS;
731
732 if (return_value_used) {
733 zval *lm_p, *lm = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified), &lm_p);
734
735 RETVAL_ZVAL(lm, 1, 0);
736
737 if (lm_p) {
738 zval_ptr_dtor(&lm_p);
739 }
740 }
741 }
742 /* }}} */
743
744 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
745 *
746 * Sets the throttle delay for use with HttpResponse::setBufferSize().
747 *
748 * Provides a basic throttling mechanism, which will yield the current process
749 * resp. thread until the entity has been completely sent, though.
750 *
751 * Note: This doesn't really work with the FastCGI SAPI.
752 *
753 * Expects a double parameter specifying the seconds too sleep() after
754 * each chunk sent.
755 *
756 * Returns TRUE on success, or FALSE on failure.
757 */
758 PHP_METHOD(HttpResponse, setThrottleDelay)
759 {
760 double seconds;
761
762 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d", &seconds)) {
763 RETURN_FALSE;
764 }
765 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay, seconds));
766 }
767 /* }}} */
768
769 /* {{{ proto static double HttpResponse::getThrottleDelay()
770 *
771 * Get the current throttle delay.
772 *
773 * Returns a double representing the throttle delay in seconds.
774 */
775 PHP_METHOD(HttpResponse, getThrottleDelay)
776 {
777 NO_ARGS;
778
779 if (return_value_used) {
780 zval *delay_p, *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay), &delay_p);
781
782 RETVAL_ZVAL(delay, 1, 0);
783
784 if (delay_p) {
785 zval_ptr_dtor(&delay_p);
786 }
787 }
788 }
789 /* }}} */
790
791 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
792 *
793 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
794 *
795 * Provides a basic throttling mechanism, which will yield the current process
796 * resp. thread until the entity has been completely sent, though.
797 *
798 * Note: This doesn't really work with the FastCGI SAPI.
799 *
800 * Expects an int parameter representing the chunk size in bytes.
801 *
802 * Returns TRUE on success, or FALSE on failure.
803 */
804 PHP_METHOD(HttpResponse, setBufferSize)
805 {
806 long bytes;
807
808 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &bytes)) {
809 RETURN_FALSE;
810 }
811 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize, bytes));
812 }
813 /* }}} */
814
815 /* {{{ proto static int HttpResponse::getBufferSize()
816 *
817 * Get current buffer size.
818 *
819 * Returns an int representing the current buffer size in bytes.
820 */
821 PHP_METHOD(HttpResponse, getBufferSize)
822 {
823 NO_ARGS;
824
825 if (return_value_used) {
826 zval *size_p, *size = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize), &size_p);
827
828 RETVAL_ZVAL(size, 1, 0);
829
830 if (size_p) {
831 zval_ptr_dtor(&size_p);
832 }
833 }
834 }
835 /* }}} */
836
837 /* {{{ proto static bool HttpResponse::setData(mixed data)
838 *
839 * Set the data to be sent.
840 *
841 * Expects one parameter, which will be converted to a string and contains
842 * the data to send.
843 *
844 * Returns TRUE on success, or FALSE on failure.
845 */
846 PHP_METHOD(HttpResponse, setData)
847 {
848 char *etag;
849 zval *the_data;
850
851 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_data)) {
852 RETURN_FALSE;
853 }
854 if (Z_TYPE_P(the_data) != IS_STRING) {
855 convert_to_string_ex(&the_data);
856 }
857
858 if ( (SUCCESS != SET_STATIC_PROP(data, the_data)) ||
859 (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_DATA))) {
860 RETURN_FALSE;
861 }
862
863 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA));
864 if ((etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA))) {
865 UPD_STATIC_PROP(string, eTag, etag);
866 efree(etag);
867 }
868
869 RETURN_TRUE;
870 }
871 /* }}} */
872
873 /* {{{ proto static string HttpResponse::getData()
874 *
875 * Get the previously set data to be sent.
876 *
877 * Returns a string containing the previously set data to send.
878 */
879 PHP_METHOD(HttpResponse, getData)
880 {
881 NO_ARGS;
882
883 if (return_value_used) {
884 zval *the_data = GET_STATIC_PROP(data);
885
886 RETURN_ZVAL(the_data, 1, 0);
887 }
888 }
889 /* }}} */
890
891 /* {{{ proto static bool HttpResponse::setStream(resource stream)
892 *
893 * Set the resource to be sent.
894 *
895 * Expects a resource parameter referencing an already opened stream from
896 * which the data to send will be read.
897 *
898 * Returns TRUE on success, or FALSE on failure.
899 */
900 PHP_METHOD(HttpResponse, setStream)
901 {
902 char *etag;
903 zval *the_stream;
904 php_stream *the_real_stream;
905 php_stream_statbuf ssb;
906
907 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &the_stream)) {
908 RETURN_FALSE;
909 }
910
911 php_stream_from_zval(the_real_stream, &the_stream);
912 if (php_stream_stat(the_real_stream, &ssb)) {
913 RETURN_FALSE;
914 }
915
916 if ( (SUCCESS != UPD_STATIC_PROP(long, stream, Z_LVAL_P(the_stream))) ||
917 (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_RSRC))) {
918 RETURN_FALSE;
919 }
920 zend_list_addref(Z_LVAL_P(the_stream));
921
922 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC));
923 if ((etag = http_etag(the_real_stream, 0, SEND_RSRC))) {
924 UPD_STATIC_PROP(string, eTag, etag);
925 efree(etag);
926 }
927
928 RETURN_TRUE;
929 }
930 /* }}} */
931
932 /* {{{ proto static resource HttpResponse::getStream()
933 *
934 * Get the previously set resource to be sent.
935 *
936 * Returns the previously set resource.
937 */
938 PHP_METHOD(HttpResponse, getStream)
939 {
940 NO_ARGS;
941
942 if (return_value_used) {
943 zval *stream_p;
944
945 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream), &stream_p)));
946
947 if (stream_p) {
948 zval_ptr_dtor(&stream_p);
949 }
950 }
951 }
952 /* }}} */
953
954 /* {{{ proto static bool HttpResponse::setFile(string file)
955 *
956 * Set the file to be sent.
957 *
958 * Expects a string as parameter, specifying the path to the file to send.
959 *
960 * Returns TRUE on success, or FALSE on failure.
961 */
962 PHP_METHOD(HttpResponse, setFile)
963 {
964 char *the_file, *etag;
965 int file_len;
966 php_stream_statbuf ssb;
967
968 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &the_file, &file_len)) {
969 RETURN_FALSE;
970 }
971
972 if (php_stream_stat_path(the_file, &ssb)) {
973 RETURN_FALSE;
974 }
975
976 if ( (SUCCESS != UPD_STATIC_STRL(file, the_file, file_len)) ||
977 (SUCCESS != UPD_STATIC_PROP(long, mode, -1))) {
978 RETURN_FALSE;
979 }
980
981 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
982 if ((etag = http_etag(the_file, 0, -1))) {
983 UPD_STATIC_PROP(string, eTag, etag);
984 efree(etag);
985 }
986
987 RETURN_TRUE;
988 }
989 /* }}} */
990
991 /* {{{ proto static string HttpResponse::getFile()
992 *
993 * Get the previously set file to be sent.
994 *
995 * Returns the previously set path to the file to send as string.
996 */
997 PHP_METHOD(HttpResponse, getFile)
998 {
999 NO_ARGS;
1000
1001 if (return_value_used) {
1002 zval *the_file_p, *the_file = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file), &the_file_p);
1003
1004 RETVAL_ZVAL(the_file, 1, 0);
1005
1006 if (the_file_p) {
1007 zval_ptr_dtor(&the_file_p);
1008 }
1009 }
1010 }
1011 /* }}} */
1012
1013 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1014 *
1015 * Finally send the entity.
1016 *
1017 * Accepts an optional boolean parameter, specifying whether the output
1018 * buffers should be discarded prior sending. A successful caching attempt
1019 * will cause a script termination, and write a log entry if the INI setting
1020 * http.cache_log is set.
1021 *
1022 * Returns TRUE on success, or FALSE on failure.
1023 *
1024 * Throws HttpHeaderException, HttpResponseException if http.only_exceptions is TRUE.
1025 *
1026 * Example:
1027 * <pre>
1028 * <?php
1029 * HttpResponse::setCache(true);
1030 * HttpResponse::setContentType('application/pdf');
1031 * HttpResponse::setContentDisposition("$user.pdf", false);
1032 * HttpResponse::setFile('sheet.pdf');
1033 * HttpResponse::send();
1034 * ?>
1035 * </pre>
1036 */
1037 PHP_METHOD(HttpResponse, send)
1038 {
1039 zval *sent;
1040 zend_bool clean_ob = 1;
1041
1042 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &clean_ob)) {
1043 RETURN_FALSE;
1044 }
1045
1046 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
1047
1048 sent = GET_STATIC_PROP(sent);
1049 if (Z_LVAL_P(sent)) {
1050 http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, response has already been sent");
1051 RETURN_FALSE;
1052 } else {
1053 Z_LVAL_P(sent) = 1;
1054 }
1055
1056 /* capture mode */
1057 if (zval_is_true(GET_STATIC_PROP(catch))) {
1058 zval *etag_p, *the_data;
1059
1060 MAKE_STD_ZVAL(the_data);
1061 php_ob_get_buffer(the_data TSRMLS_CC);
1062 SET_STATIC_PROP(data, the_data);
1063 ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
1064
1065 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p))) {
1066 char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA);
1067 if (etag) {
1068 UPD_STATIC_PROP(string, eTag, etag);
1069 efree(etag);
1070 }
1071 }
1072 zval_ptr_dtor(&the_data);
1073
1074 if (etag_p) {
1075 zval_ptr_dtor(&etag_p);
1076 }
1077
1078 clean_ob = 1;
1079 }
1080
1081 if (clean_ob) {
1082 /* interrupt on-the-fly etag generation */
1083 HTTP_G->etag.started = 0;
1084 /* discard previous output buffers */
1085 php_end_ob_buffers(0 TSRMLS_CC);
1086 }
1087
1088 /* caching */
1089 if (zval_is_true(GET_STATIC_PROP(cache))) {
1090 zval *cctl, *cctl_p, *etag, *etag_p, *lmod, *lmod_p;
1091
1092 etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p);
1093 lmod = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified), &lmod_p);
1094 cctl = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl), &cctl_p);
1095
1096 if (Z_LVAL_P(lmod) || Z_STRLEN_P(etag)) {
1097 if (Z_STRLEN_P(cctl)) {
1098 http_send_cache_control(Z_STRVAL_P(cctl), Z_STRLEN_P(cctl));
1099 } else {
1100 http_send_cache_control(HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL));
1101 }
1102 if (Z_STRLEN_P(etag)) {
1103 http_send_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag));
1104 }
1105 if (Z_LVAL_P(lmod)) {
1106 http_send_last_modified(Z_LVAL_P(lmod));
1107 }
1108 }
1109
1110 if (etag_p) zval_ptr_dtor(&etag_p);
1111 if (lmod_p) zval_ptr_dtor(&lmod_p);
1112 if (cctl_p) zval_ptr_dtor(&cctl_p);
1113 }
1114
1115 /* content type */
1116 {
1117 zval *ctype_p, *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType), &ctype_p);
1118 if (Z_STRLEN_P(ctype)) {
1119 http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype));
1120 } else {
1121 char *ctypes = INI_STR("default_mimetype");
1122 size_t ctlen = ctypes ? strlen(ctypes) : 0;
1123
1124 if (ctlen) {
1125 http_send_content_type(ctypes, ctlen);
1126 } else {
1127 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1128 }
1129 }
1130 if (ctype_p) {
1131 zval_ptr_dtor(&ctype_p);
1132 }
1133 }
1134
1135 /* content disposition */
1136 {
1137 zval *cd_p, *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition), &cd_p);
1138 if (Z_STRLEN_P(cd)) {
1139 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1, NULL);
1140 }
1141 if (cd_p) {
1142 zval_ptr_dtor(&cd_p);
1143 }
1144 }
1145
1146 /* throttling */
1147 {
1148 zval *bsize_p, *bsize = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize), &bsize_p);
1149 zval *delay_p, *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay), &delay_p);
1150 HTTP_G->send.buffer_size = Z_LVAL_P(bsize);
1151 HTTP_G->send.throttle_delay = Z_DVAL_P(delay);
1152 if (bsize_p) zval_ptr_dtor(&bsize_p);
1153 if (delay_p) zval_ptr_dtor(&delay_p);
1154 }
1155
1156 /* gzip */
1157 HTTP_G->send.deflate.encoding = zval_is_true(GET_STATIC_PROP(gzip));
1158
1159 /* send */
1160 switch (Z_LVAL_P(GET_STATIC_PROP(mode))) {
1161 case SEND_DATA:
1162 {
1163 zval *zdata_p, *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data), &zdata_p);
1164 RETVAL_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
1165 if (zdata_p) zval_ptr_dtor(&zdata_p);
1166 return;
1167 }
1168
1169 case SEND_RSRC:
1170 {
1171 php_stream *the_real_stream;
1172 zval *the_stream_p, *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream), &the_stream_p);
1173 the_stream->type = IS_RESOURCE;
1174 php_stream_from_zval(the_real_stream, &the_stream);
1175 RETVAL_SUCCESS(http_send_stream(the_real_stream));
1176 if (the_stream_p) zval_ptr_dtor(&the_stream_p);
1177 return;
1178 }
1179
1180 default:
1181 {
1182 zval *file_p;
1183 RETVAL_SUCCESS(http_send_file(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file), &file_p))));
1184 if (file_p) zval_ptr_dtor(&file_p);
1185 return;
1186 }
1187 }
1188 }
1189 /* }}} */
1190
1191 /* {{{ proto static void HttpResponse::capture()
1192 *
1193 * Capture script output.
1194 *
1195 * Example:
1196 * <pre>
1197 * <?php
1198 * HttpResponse::setCache(true);
1199 * HttpResponse::capture();
1200 * // script follows
1201 * ?>
1202 * </pre>
1203 */
1204 PHP_METHOD(HttpResponse, capture)
1205 {
1206 NO_ARGS;
1207
1208 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
1209
1210 UPD_STATIC_PROP(long, catch, 1);
1211
1212 php_end_ob_buffers(0 TSRMLS_CC);
1213 php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
1214
1215 /* register shutdown function */
1216 {
1217 zval func, retval, arg, *argp[1];
1218
1219 INIT_PZVAL(&arg);
1220 INIT_PZVAL(&func);
1221 INIT_PZVAL(&retval);
1222 ZVAL_STRINGL(&func, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1223
1224 array_init(&arg);
1225 add_next_index_stringl(&arg, "HttpResponse", lenof("HttpResponse"), 1);
1226 add_next_index_stringl(&arg, "send", lenof("send"), 1);
1227 argp[0] = &arg;
1228 call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC);
1229 zval_dtor(&arg);
1230 }
1231 }
1232 /* }}} */
1233
1234 #endif /* ZEND_ENGINE_2 && !WONKY */
1235
1236 /*
1237 * Local variables:
1238 * tab-width: 4
1239 * c-basic-offset: 4
1240 * End:
1241 * vim600: noet sw=4 ts=4 fdm=marker
1242 * vim<600: noet sw=4 ts=4
1243 */
1244