Edit File: output.c
/* +----------------------------------------------------------------------+ | Copyright (c) The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 3.01 of the PHP license, | | that is bundled with this package in the file LICENSE, and is | | available through the world-wide-web at the following url: | | https://www.php.net/license/3_01.txt | | If you did not receive a copy of the PHP license and are unable to | | obtain it through the world-wide-web, please send a note to | | license@php.net so we can mail you a copy immediately. | +----------------------------------------------------------------------+ | Authors: Zeev Suraski <zeev@php.net> | | Thies C. Arntzen <thies@thieso.net> | | Marcus Boerger <helly@php.net> | | New API: Michael Wallner <mike@php.net> | +----------------------------------------------------------------------+ */ #ifndef PHP_OUTPUT_DEBUG # define PHP_OUTPUT_DEBUG 0 #endif #ifndef PHP_OUTPUT_NOINLINE # define PHP_OUTPUT_NOINLINE 0 #endif #include "php.h" #include "ext/standard/head.h" #include "ext/standard/url_scanner_ex.h" #include "SAPI.h" #include "zend_stack.h" #include "php_output.h" PHPAPI ZEND_DECLARE_MODULE_GLOBALS(output) const char php_output_default_handler_name[sizeof("default output handler")] = "default output handler"; const char php_output_devnull_handler_name[sizeof("null output handler")] = "null output handler"; #if PHP_OUTPUT_NOINLINE || PHP_OUTPUT_DEBUG # undef inline # define inline #endif /* {{{ aliases, conflict and reverse conflict hash tables */ static HashTable php_output_handler_aliases; static HashTable php_output_handler_conflicts; static HashTable php_output_handler_reverse_conflicts; /* }}} */ /* {{{ forward declarations */ static inline int php_output_lock_error(int op); static inline void php_output_op(int op, const char *str, size_t len); static inline php_output_handler *php_output_handler_init(zend_string *name, size_t chunk_size, int flags); static inline php_output_handler_status_t php_output_handler_op(php_output_handler *handler, php_output_context *context); static inline int php_output_handler_append(php_output_handler *handler, const php_output_buffer *buf); static inline zval *php_output_handler_status(php_output_handler *handler, zval *entry); static inline void php_output_context_init(php_output_context *context, int op); static inline void php_output_context_reset(php_output_context *context); static inline void php_output_context_swap(php_output_context *context); static inline void php_output_context_dtor(php_output_context *context); static int php_output_stack_pop(int flags); static int php_output_stack_apply_op(void *h, void *c); static int php_output_stack_apply_clean(void *h, void *c); static int php_output_stack_apply_list(void *h, void *z); static int php_output_stack_apply_status(void *h, void *z); static int php_output_handler_compat_func(void **handler_context, php_output_context *output_context); static int php_output_handler_default_func(void **handler_context, php_output_context *output_context); static int php_output_handler_devnull_func(void **handler_context, php_output_context *output_context); /* }}} */ /* {{{ static void php_output_init_globals(zend_output_globals *G) * Initialize the module globals on MINIT */ static inline void php_output_init_globals(zend_output_globals *G) { memset(G, 0, sizeof(*G)); } /* }}} */ /* {{{ stderr/stdout writer if not PHP_OUTPUT_ACTIVATED */ static size_t php_output_stdout(const char *str, size_t str_len) { fwrite(str, 1, str_len, stdout); return str_len; } static size_t php_output_stderr(const char *str, size_t str_len) { fwrite(str, 1, str_len, stderr); /* See http://support.microsoft.com/kb/190351 */ #ifdef PHP_WIN32 fflush(stderr); #endif return str_len; } static size_t (*php_output_direct)(const char *str, size_t str_len) = php_output_stderr; /* }}} */ /* {{{ void php_output_header(void) */ static void php_output_header(void) { if (!SG(headers_sent)) { if (!OG(output_start_filename)) { if (zend_is_compiling()) { OG(output_start_filename) = zend_get_compiled_filename(); OG(output_start_lineno) = zend_get_compiled_lineno(); } else if (zend_is_executing()) { OG(output_start_filename) = zend_get_executed_filename_ex(); OG(output_start_lineno) = zend_get_executed_lineno(); } if (OG(output_start_filename)) { zend_string_addref(OG(output_start_filename)); } #if PHP_OUTPUT_DEBUG fprintf(stderr, "!!! output started at: %s (%d)\n", ZSTR_VAL(OG(output_start_filename)), OG(output_start_lineno)); #endif } if (!php_header()) { OG(flags) |= PHP_OUTPUT_DISABLED; } } } /* }}} */ static void reverse_conflict_dtor(zval *zv) { HashTable *ht = Z_PTR_P(zv); zend_hash_destroy(ht); } /* {{{ void php_output_startup(void) * Set up module globals and initialize the conflict and reverse conflict hash tables */ PHPAPI void php_output_startup(void) { ZEND_INIT_MODULE_GLOBALS(output, php_output_init_globals, NULL); zend_hash_init(&php_output_handler_aliases, 8, NULL, NULL, 1); zend_hash_init(&php_output_handler_conflicts, 8, NULL, NULL, 1); zend_hash_init(&php_output_handler_reverse_conflicts, 8, NULL, reverse_conflict_dtor, 1); php_output_direct = php_output_stdout; } /* }}} */ /* {{{ void php_output_shutdown(void) * Destroy module globals and the conflict and reverse conflict hash tables */ PHPAPI void php_output_shutdown(void) { php_output_direct = php_output_stderr; zend_hash_destroy(&php_output_handler_aliases); zend_hash_destroy(&php_output_handler_conflicts); zend_hash_destroy(&php_output_handler_reverse_conflicts); } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_activate(void) * Reset output globals and setup the output handler stack */ PHPAPI int php_output_activate(void) { #ifdef ZTS memset(TSRMG_BULK_STATIC(output_globals_id, zend_output_globals*), 0, sizeof(zend_output_globals)); #else memset(&output_globals, 0, sizeof(zend_output_globals)); #endif zend_stack_init(&OG(handlers), sizeof(php_output_handler *)); OG(flags) |= PHP_OUTPUT_ACTIVATED; return SUCCESS; } /* }}} */ /* {{{ void php_output_deactivate(void) * Destroy the output handler stack */ PHPAPI void php_output_deactivate(void) { php_output_handler **handler = NULL; if ((OG(flags) & PHP_OUTPUT_ACTIVATED)) { php_output_header(); OG(flags) ^= PHP_OUTPUT_ACTIVATED; OG(active) = NULL; OG(running) = NULL; /* release all output handlers */ if (OG(handlers).elements) { while ((handler = zend_stack_top(&OG(handlers)))) { php_output_handler_free(handler); zend_stack_del_top(&OG(handlers)); } } zend_stack_destroy(&OG(handlers)); } if (OG(output_start_filename)) { zend_string_release(OG(output_start_filename)); OG(output_start_filename) = NULL; } } /* }}} */ /* {{{ void php_output_register_constants() */ PHPAPI void php_output_register_constants(void) { REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_START", PHP_OUTPUT_HANDLER_START, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_WRITE", PHP_OUTPUT_HANDLER_WRITE, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_FLUSH", PHP_OUTPUT_HANDLER_FLUSH, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_CLEAN", PHP_OUTPUT_HANDLER_CLEAN, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_FINAL", PHP_OUTPUT_HANDLER_FINAL, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_CONT", PHP_OUTPUT_HANDLER_WRITE, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_END", PHP_OUTPUT_HANDLER_FINAL, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_CLEANABLE", PHP_OUTPUT_HANDLER_CLEANABLE, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_FLUSHABLE", PHP_OUTPUT_HANDLER_FLUSHABLE, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_REMOVABLE", PHP_OUTPUT_HANDLER_REMOVABLE, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_STDFLAGS", PHP_OUTPUT_HANDLER_STDFLAGS, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_STARTED", PHP_OUTPUT_HANDLER_STARTED, CONST_CS | CONST_PERSISTENT); REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_DISABLED", PHP_OUTPUT_HANDLER_DISABLED, CONST_CS | CONST_PERSISTENT); } /* }}} */ /* {{{ void php_output_set_status(int status) * Used by SAPIs to disable output */ PHPAPI void php_output_set_status(int status) { OG(flags) = (OG(flags) & ~0xf) | (status & 0xf); } /* }}} */ /* {{{ int php_output_get_status() * Get output control status */ PHPAPI int php_output_get_status(void) { return ( OG(flags) | (OG(active) ? PHP_OUTPUT_ACTIVE : 0) | (OG(running)? PHP_OUTPUT_LOCKED : 0) ) & 0xff; } /* }}} */ /* {{{ int php_output_write_unbuffered(const char *str, size_t len) * Unbuffered write */ PHPAPI size_t php_output_write_unbuffered(const char *str, size_t len) { if (OG(flags) & PHP_OUTPUT_ACTIVATED) { return sapi_module.ub_write(str, len); } return php_output_direct(str, len); } /* }}} */ /* {{{ int php_output_write(const char *str, size_t len) * Buffered write */ PHPAPI size_t php_output_write(const char *str, size_t len) { if (OG(flags) & PHP_OUTPUT_ACTIVATED) { php_output_op(PHP_OUTPUT_HANDLER_WRITE, str, len); return len; } if (OG(flags) & PHP_OUTPUT_DISABLED) { return 0; } return php_output_direct(str, len); } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_flush(void) * Flush the most recent output handlers buffer */ PHPAPI int php_output_flush(void) { php_output_context context; if (OG(active) && (OG(active)->flags & PHP_OUTPUT_HANDLER_FLUSHABLE)) { php_output_context_init(&context, PHP_OUTPUT_HANDLER_FLUSH); php_output_handler_op(OG(active), &context); if (context.out.data && context.out.used) { zend_stack_del_top(&OG(handlers)); php_output_write(context.out.data, context.out.used); zend_stack_push(&OG(handlers), &OG(active)); } php_output_context_dtor(&context); return SUCCESS; } return FAILURE; } /* }}} */ /* {{{ void php_output_flush_all() * Flush all output buffers subsequently */ PHPAPI void php_output_flush_all(void) { if (OG(active)) { php_output_op(PHP_OUTPUT_HANDLER_FLUSH, NULL, 0); } } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_clean(void) * Cleans the most recent output handlers buffer if the handler is cleanable */ PHPAPI int php_output_clean(void) { php_output_context context; if (OG(active) && (OG(active)->flags & PHP_OUTPUT_HANDLER_CLEANABLE)) { php_output_context_init(&context, PHP_OUTPUT_HANDLER_CLEAN); php_output_handler_op(OG(active), &context); php_output_context_dtor(&context); return SUCCESS; } return FAILURE; } /* }}} */ /* {{{ void php_output_clean_all(void) * Cleans all output handler buffers, without regard whether the handler is cleanable */ PHPAPI void php_output_clean_all(void) { php_output_context context; if (OG(active)) { php_output_context_init(&context, PHP_OUTPUT_HANDLER_CLEAN); zend_stack_apply_with_argument(&OG(handlers), ZEND_STACK_APPLY_TOPDOWN, php_output_stack_apply_clean, &context); } } /* {{{ SUCCESS|FAILURE php_output_end(void) * Finalizes the most recent output handler at pops it off the stack if the handler is removable */ PHPAPI int php_output_end(void) { if (php_output_stack_pop(PHP_OUTPUT_POP_TRY)) { return SUCCESS; } return FAILURE; } /* }}} */ /* {{{ void php_output_end_all(void) * Finalizes all output handlers and ends output buffering without regard whether a handler is removable */ PHPAPI void php_output_end_all(void) { while (OG(active) && php_output_stack_pop(PHP_OUTPUT_POP_FORCE)); } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_discard(void) * Discards the most recent output handlers buffer and pops it off the stack if the handler is removable */ PHPAPI int php_output_discard(void) { if (php_output_stack_pop(PHP_OUTPUT_POP_DISCARD|PHP_OUTPUT_POP_TRY)) { return SUCCESS; } return FAILURE; } /* }}} */ /* {{{ void php_output_discard_all(void) * Discard all output handlers and buffers without regard whether a handler is removable */ PHPAPI void php_output_discard_all(void) { while (OG(active)) { php_output_stack_pop(PHP_OUTPUT_POP_DISCARD|PHP_OUTPUT_POP_FORCE); } } /* }}} */ /* {{{ int php_output_get_level(void) * Get output buffering level, ie. how many output handlers the stack contains */ PHPAPI int php_output_get_level(void) { return OG(active) ? zend_stack_count(&OG(handlers)) : 0; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_get_contents(zval *z) * Get the contents of the active output handlers buffer */ PHPAPI int php_output_get_contents(zval *p) { if (OG(active)) { ZVAL_STRINGL(p, OG(active)->buffer.data, OG(active)->buffer.used); return SUCCESS; } else { ZVAL_NULL(p); return FAILURE; } } /* {{{ SUCCESS|FAILURE php_output_get_length(zval *z) * Get the length of the active output handlers buffer */ PHPAPI int php_output_get_length(zval *p) { if (OG(active)) { ZVAL_LONG(p, OG(active)->buffer.used); return SUCCESS; } else { ZVAL_NULL(p); return FAILURE; } } /* }}} */ /* {{{ php_output_handler* php_output_get_active_handler(void) * Get active output handler */ PHPAPI php_output_handler* php_output_get_active_handler(void) { return OG(active); } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_handler_start_default(void) * Start a "default output handler" */ PHPAPI int php_output_start_default(void) { php_output_handler *handler; handler = php_output_handler_create_internal(ZEND_STRL(php_output_default_handler_name), php_output_handler_default_func, 0, PHP_OUTPUT_HANDLER_STDFLAGS); if (SUCCESS == php_output_handler_start(handler)) { return SUCCESS; } php_output_handler_free(&handler); return FAILURE; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_handler_start_devnull(void) * Start a "null output handler" */ PHPAPI int php_output_start_devnull(void) { php_output_handler *handler; handler = php_output_handler_create_internal(ZEND_STRL(php_output_devnull_handler_name), php_output_handler_devnull_func, PHP_OUTPUT_HANDLER_DEFAULT_SIZE, 0); if (SUCCESS == php_output_handler_start(handler)) { return SUCCESS; } php_output_handler_free(&handler); return FAILURE; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_start_user(zval *handler, size_t chunk_size, int flags) * Start a user level output handler */ PHPAPI int php_output_start_user(zval *output_handler, size_t chunk_size, int flags) { php_output_handler *handler; if (output_handler) { handler = php_output_handler_create_user(output_handler, chunk_size, flags); } else { handler = php_output_handler_create_internal(ZEND_STRL(php_output_default_handler_name), php_output_handler_default_func, chunk_size, flags); } if (SUCCESS == php_output_handler_start(handler)) { return SUCCESS; } php_output_handler_free(&handler); return FAILURE; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_start_internal(zval *name, php_output_handler_func_t handler, size_t chunk_size, int flags) * Start an internal output handler that does not have to maintain a non-global state */ PHPAPI int php_output_start_internal(const char *name, size_t name_len, php_output_handler_func_t output_handler, size_t chunk_size, int flags) { php_output_handler *handler; handler = php_output_handler_create_internal(name, name_len, php_output_handler_compat_func, chunk_size, flags); php_output_handler_set_context(handler, output_handler, NULL); if (SUCCESS == php_output_handler_start(handler)) { return SUCCESS; } php_output_handler_free(&handler); return FAILURE; } /* }}} */ /* {{{ php_output_handler *php_output_handler_create_user(zval *handler, size_t chunk_size, int flags) * Create a user level output handler */ PHPAPI php_output_handler *php_output_handler_create_user(zval *output_handler, size_t chunk_size, int flags) { zend_string *handler_name = NULL; char *error = NULL; php_output_handler *handler = NULL; php_output_handler_alias_ctor_t alias = NULL; php_output_handler_user_func_t *user = NULL; switch (Z_TYPE_P(output_handler)) { case IS_NULL: handler = php_output_handler_create_internal(ZEND_STRL(php_output_default_handler_name), php_output_handler_default_func, chunk_size, flags); break; case IS_STRING: if (Z_STRLEN_P(output_handler) && (alias = php_output_handler_alias(Z_STRVAL_P(output_handler), Z_STRLEN_P(output_handler)))) { handler = alias(Z_STRVAL_P(output_handler), Z_STRLEN_P(output_handler), chunk_size, flags); break; } ZEND_FALLTHROUGH; default: user = ecalloc(1, sizeof(php_output_handler_user_func_t)); if (SUCCESS == zend_fcall_info_init(output_handler, 0, &user->fci, &user->fcc, &handler_name, &error)) { handler = php_output_handler_init(handler_name, chunk_size, (flags & ~0xf) | PHP_OUTPUT_HANDLER_USER); ZVAL_COPY(&user->zoh, output_handler); handler->func.user = user; } else { efree(user); } if (error) { php_error_docref("ref.outcontrol", E_WARNING, "%s", error); efree(error); } if (handler_name) { zend_string_release_ex(handler_name, 0); } } return handler; } /* }}} */ /* {{{ php_output_handler *php_output_handler_create_internal(zval *name, php_output_handler_context_func_t handler, size_t chunk_size, int flags) * Create an internal output handler that can maintain a non-global state */ PHPAPI php_output_handler *php_output_handler_create_internal(const char *name, size_t name_len, php_output_handler_context_func_t output_handler, size_t chunk_size, int flags) { php_output_handler *handler; zend_string *str = zend_string_init(name, name_len, 0); handler = php_output_handler_init(str, chunk_size, (flags & ~0xf) | PHP_OUTPUT_HANDLER_INTERNAL); handler->func.internal = output_handler; zend_string_release_ex(str, 0); return handler; } /* }}} */ /* {{{ void php_output_handler_set_context(php_output_handler *handler, void *opaq, void (*dtor)(void*)) * Set the context/state of an output handler. Calls the dtor of the previous context if there is one */ PHPAPI void php_output_handler_set_context(php_output_handler *handler, void *opaq, void (*dtor)(void*)) { if (handler->dtor && handler->opaq) { handler->dtor(handler->opaq); } handler->dtor = dtor; handler->opaq = opaq; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_handler_start(php_output_handler *handler) * Starts the set up output handler and pushes it on top of the stack. Checks for any conflicts regarding the output handler to start */ PHPAPI int php_output_handler_start(php_output_handler *handler) { HashTable *rconflicts; php_output_handler_conflict_check_t conflict; if (php_output_lock_error(PHP_OUTPUT_HANDLER_START) || !handler) { return FAILURE; } if (NULL != (conflict = zend_hash_find_ptr(&php_output_handler_conflicts, handler->name))) { if (SUCCESS != conflict(ZSTR_VAL(handler->name), ZSTR_LEN(handler->name))) { return FAILURE; } } if (NULL != (rconflicts = zend_hash_find_ptr(&php_output_handler_reverse_conflicts, handler->name))) { ZEND_HASH_PACKED_FOREACH_PTR(rconflicts, conflict) { if (SUCCESS != conflict(ZSTR_VAL(handler->name), ZSTR_LEN(handler->name))) { return FAILURE; } } ZEND_HASH_FOREACH_END(); } /* zend_stack_push returns stack level */ handler->level = zend_stack_push(&OG(handlers), &handler); OG(active) = handler; return SUCCESS; } /* }}} */ /* {{{ int php_output_handler_started(zval *name) * Check whether a certain output handler is in use */ PHPAPI int php_output_handler_started(const char *name, size_t name_len) { php_output_handler **handlers; int i, count = php_output_get_level(); if (count) { handlers = (php_output_handler **) zend_stack_base(&OG(handlers)); for (i = 0; i < count; ++i) { if (zend_string_equals_cstr(handlers[i]->name, name, name_len)) { return 1; } } } return 0; } /* }}} */ /* {{{ int php_output_handler_conflict(zval *handler_new, zval *handler_old) * Check whether a certain handler is in use and issue a warning that the new handler would conflict with the already used one */ PHPAPI int php_output_handler_conflict(const char *handler_new, size_t handler_new_len, const char *handler_set, size_t handler_set_len) { if (php_output_handler_started(handler_set, handler_set_len)) { if (handler_new_len != handler_set_len || memcmp(handler_new, handler_set, handler_set_len)) { php_error_docref("ref.outcontrol", E_WARNING, "Output handler '%s' conflicts with '%s'", handler_new, handler_set); } else { php_error_docref("ref.outcontrol", E_WARNING, "Output handler '%s' cannot be used twice", handler_new); } return 1; } return 0; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_handler_conflict_register(zval *name, php_output_handler_conflict_check_t check_func) * Register a conflict checking function on MINIT */ PHPAPI int php_output_handler_conflict_register(const char *name, size_t name_len, php_output_handler_conflict_check_t check_func) { zend_string *str; if (!EG(current_module)) { zend_error(E_ERROR, "Cannot register an output handler conflict outside of MINIT"); return FAILURE; } str = zend_string_init_interned(name, name_len, 1); zend_hash_update_ptr(&php_output_handler_conflicts, str, check_func); zend_string_release_ex(str, 1); return SUCCESS; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_handler_reverse_conflict_register(zval *name, php_output_handler_conflict_check_t check_func) * Register a reverse conflict checking function on MINIT */ PHPAPI int php_output_handler_reverse_conflict_register(const char *name, size_t name_len, php_output_handler_conflict_check_t check_func) { HashTable rev, *rev_ptr = NULL; if (!EG(current_module)) { zend_error(E_ERROR, "Cannot register a reverse output handler conflict outside of MINIT"); return FAILURE; } if (NULL != (rev_ptr = zend_hash_str_find_ptr(&php_output_handler_reverse_conflicts, name, name_len))) { return zend_hash_next_index_insert_ptr(rev_ptr, check_func) ? SUCCESS : FAILURE; } else { zend_string *str; zend_hash_init(&rev, 8, NULL, NULL, 1); if (NULL == zend_hash_next_index_insert_ptr(&rev, check_func)) { zend_hash_destroy(&rev); return FAILURE; } str = zend_string_init_interned(name, name_len, 1); zend_hash_update_mem(&php_output_handler_reverse_conflicts, str, &rev, sizeof(HashTable)); zend_string_release_ex(str, 1); return SUCCESS; } } /* }}} */ /* {{{ php_output_handler_alias_ctor_t php_output_handler_alias(zval *name) * Get an internal output handler for a user handler if it exists */ PHPAPI php_output_handler_alias_ctor_t php_output_handler_alias(const char *name, size_t name_len) { return zend_hash_str_find_ptr(&php_output_handler_aliases, name, name_len); } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_handler_alias_register(zval *name, php_output_handler_alias_ctor_t func) * Registers an internal output handler as alias for a user handler */ PHPAPI int php_output_handler_alias_register(const char *name, size_t name_len, php_output_handler_alias_ctor_t func) { zend_string *str; if (!EG(current_module)) { zend_error(E_ERROR, "Cannot register an output handler alias outside of MINIT"); return FAILURE; } str = zend_string_init_interned(name, name_len, 1); zend_hash_update_ptr(&php_output_handler_aliases, str, func); zend_string_release_ex(str, 1); return SUCCESS; } /* }}} */ /* {{{ SUCCESS|FAILURE php_output_handler_hook(php_output_handler_hook_t type, void *arg) * Output handler hook for output handler functions to check/modify the current handlers abilities */ PHPAPI int php_output_handler_hook(php_output_handler_hook_t type, void *arg) { if (OG(running)) { switch (type) { case PHP_OUTPUT_HANDLER_HOOK_GET_OPAQ: *(void ***) arg = &OG(running)->opaq; return SUCCESS; case PHP_OUTPUT_HANDLER_HOOK_GET_FLAGS: *(int *) arg = OG(running)->flags; return SUCCESS; case PHP_OUTPUT_HANDLER_HOOK_GET_LEVEL: *(int *) arg = OG(running)->level; return SUCCESS; case PHP_OUTPUT_HANDLER_HOOK_IMMUTABLE: OG(running)->flags &= ~(PHP_OUTPUT_HANDLER_REMOVABLE|PHP_OUTPUT_HANDLER_CLEANABLE); return SUCCESS; case PHP_OUTPUT_HANDLER_HOOK_DISABLE: OG(running)->flags |= PHP_OUTPUT_HANDLER_DISABLED; return SUCCESS; default: break; } } return FAILURE; } /* }}} */ /* {{{ void php_output_handler_dtor(php_output_handler *handler) * Destroy an output handler */ PHPAPI void php_output_handler_dtor(php_output_handler *handler) { if (handler->name) { zend_string_release_ex(handler->name, 0); } if (handler->buffer.data) { efree(handler->buffer.data); } if (handler->flags & PHP_OUTPUT_HANDLER_USER) { zval_ptr_dtor(&handler->func.user->zoh); efree(handler->func.user); } if (handler->dtor && handler->opaq) { handler->dtor(handler->opaq); } memset(handler, 0, sizeof(*handler)); } /* }}} */ /* {{{ void php_output_handler_free(php_output_handler **handler) * Destroy and free an output handler */ PHPAPI void php_output_handler_free(php_output_handler **h) { if (*h) { php_output_handler_dtor(*h); efree(*h); *h = NULL; } } /* }}} */ /* void php_output_set_implicit_flush(int enabled) * Enable or disable implicit flush */ PHPAPI void php_output_set_implicit_flush(int flush) { if (flush) { OG(flags) |= PHP_OUTPUT_IMPLICITFLUSH; } else { OG(flags) &= ~PHP_OUTPUT_IMPLICITFLUSH; } } /* }}} */ /* {{{ char *php_output_get_start_filename(void) * Get the file name where output has started */ PHPAPI const char *php_output_get_start_filename(void) { return OG(output_start_filename) ? ZSTR_VAL(OG(output_start_filename)) : NULL; } /* }}} */ /* {{{ int php_output_get_start_lineno(void) * Get the line number where output has started */ PHPAPI int php_output_get_start_lineno(void) { return OG(output_start_lineno); } /* }}} */ /* {{{ static int php_output_lock_error(int op) * Checks whether an unallowed operation is attempted from within the output handler and issues a fatal error */ static inline int php_output_lock_error(int op) { /* if there's no ob active, ob has been stopped */ if (op && OG(active) && OG(running)) { /* fatal error */ php_output_deactivate(); php_error_docref("ref.outcontrol", E_ERROR, "Cannot use output buffering in output buffering display handlers"); return 1; } return 0; } /* }}} */ /* {{{ static php_output_context *php_output_context_init(php_output_context *context, int op) * Initialize a new output context */ static inline void php_output_context_init(php_output_context *context, int op) { memset(context, 0, sizeof(php_output_context)); context->op = op; } /* }}} */ /* {{{ static void php_output_context_reset(php_output_context *context) * Reset an output context */ static inline void php_output_context_reset(php_output_context *context) { int op = context->op; php_output_context_dtor(context); memset(context, 0, sizeof(php_output_context)); context->op = op; } /* }}} */ /* {{{ static void php_output_context_feed(php_output_context *context, char *, size_t, size_t) * Feed output contexts input buffer */ static inline void php_output_context_feed(php_output_context *context, char *data, size_t size, size_t used, bool free) { if (context->in.free && context->in.data) { efree(context->in.data); } context->in.data = data; context->in.used = used; context->in.free = free; context->in.size = size; } /* }}} */ /* {{{ static void php_output_context_swap(php_output_context *context) * Swap output contexts buffers */ static inline void php_output_context_swap(php_output_context *context) { if (context->in.free && context->in.data) { efree(context->in.data); } context->in.data = context->out.data; context->in.used = context->out.used; context->in.free = context->out.free; context->in.size = context->out.size; context->out.data = NULL; context->out.used = 0; context->out.free = 0; context->out.size = 0; } /* }}} */ /* {{{ static void php_output_context_pass(php_output_context *context) * Pass input to output buffer */ static inline void php_output_context_pass(php_output_context *context) { context->out.data = context->in.data; context->out.used = context->in.used; context->out.size = context->in.size; context->out.free = context->in.free; context->in.data = NULL; context->in.used = 0; context->in.free = 0; context->in.size = 0; } /* }}} */ /* {{{ static void php_output_context_dtor(php_output_context *context) * Destroy the contents of an output context */ static inline void php_output_context_dtor(php_output_context *context) { if (context->in.free && context->in.data) { efree(context->in.data); context->in.data = NULL; } if (context->out.free && context->out.data) { efree(context->out.data); context->out.data = NULL; } } /* }}} */ /* {{{ static php_output_handler *php_output_handler_init(zval *name, size_t chunk_size, int flags) * Allocates and initializes a php_output_handler structure */ static inline php_output_handler *php_output_handler_init(zend_string *name, size_t chunk_size, int flags) { php_output_handler *handler; handler = ecalloc(1, sizeof(php_output_handler)); handler->name = zend_string_copy(name); handler->size = chunk_size; handler->flags = flags; handler->buffer.size = PHP_OUTPUT_HANDLER_INITBUF_SIZE(chunk_size); handler->buffer.data = emalloc(handler->buffer.size); return handler; } /* }}} */ /* {{{ static int php_output_handler_append(php_output_handler *handler, const php_output_buffer *buf) * Appends input to the output handlers buffer and indicates whether the buffer does not have to be processed by the output handler */ static inline int php_output_handler_append(php_output_handler *handler, const php_output_buffer *buf) { if (buf->used) { OG(flags) |= PHP_OUTPUT_WRITTEN; /* store it away */ if ((handler->buffer.size - handler->buffer.used) <= buf->used) { size_t grow_int = PHP_OUTPUT_HANDLER_INITBUF_SIZE(handler->size); size_t grow_buf = PHP_OUTPUT_HANDLER_INITBUF_SIZE(buf->used - (handler->buffer.size - handler->buffer.used)); size_t grow_max = MAX(grow_int, grow_buf); handler->buffer.data = safe_erealloc(handler->buffer.data, 1, handler->buffer.size, grow_max); handler->buffer.size += grow_max; } memcpy(handler->buffer.data + handler->buffer.used, buf->data, buf->used); handler->buffer.used += buf->used; /* chunked buffering */ if (handler->size && (handler->buffer.used >= handler->size)) { /* store away errors and/or any intermediate output */ return OG(running) ? 1 : 0; } } return 1; } /* }}} */ /* {{{ static php_output_handler_status_t php_output_handler_op(php_output_handler *handler, php_output_context *context) * Output handler operation dispatcher, applying context op to the php_output_handler handler */ static inline php_output_handler_status_t php_output_handler_op(php_output_handler *handler, php_output_context *context) { php_output_handler_status_t status; int original_op = context->op; #if PHP_OUTPUT_DEBUG fprintf(stderr, ">>> op(%d, " "handler=%p, " "name=%s, " "flags=%d, " "buffer.data=%s, " "buffer.used=%zu, " "buffer.size=%zu, " "in.data=%s, " "in.used=%zu)\n", context->op, handler, handler->name, handler->flags, handler->buffer.used?handler->buffer.data:"", handler->buffer.used, handler->buffer.size, context->in.used?context->in.data:"", context->in.used ); #endif if (php_output_lock_error(context->op)) { /* fatal error */ return PHP_OUTPUT_HANDLER_FAILURE; } /* storable? */ if (php_output_handler_append(handler, &context->in) && !context->op) { context->op = original_op; return PHP_OUTPUT_HANDLER_NO_DATA; } else { /* need to start? */ if (!(handler->flags & PHP_OUTPUT_HANDLER_STARTED)) { context->op |= PHP_OUTPUT_HANDLER_START; } OG(running) = handler; if (handler->flags & PHP_OUTPUT_HANDLER_USER) { zval retval, ob_data, ob_mode; ZVAL_STRINGL(&ob_data, handler->buffer.data, handler->buffer.used); ZVAL_LONG(&ob_mode, (zend_long) context->op); zend_fcall_info_argn(&handler->func.user->fci, 2, &ob_data, &ob_mode); zval_ptr_dtor(&ob_data); #define PHP_OUTPUT_USER_SUCCESS(retval) ((Z_TYPE(retval) != IS_UNDEF) && !(Z_TYPE(retval) == IS_FALSE)) if (SUCCESS == zend_fcall_info_call(&handler->func.user->fci, &handler->func.user->fcc, &retval, NULL) && PHP_OUTPUT_USER_SUCCESS(retval)) { /* user handler may have returned TRUE */ status = PHP_OUTPUT_HANDLER_NO_DATA; if (Z_TYPE(retval) != IS_FALSE && Z_TYPE(retval) != IS_TRUE) { convert_to_string(&retval); if (Z_STRLEN(retval)) { context->out.data = estrndup(Z_STRVAL(retval), Z_STRLEN(retval)); context->out.used = Z_STRLEN(retval); context->out.free = 1; status = PHP_OUTPUT_HANDLER_SUCCESS; } } } else { /* call failed, pass internal buffer along */ status = PHP_OUTPUT_HANDLER_FAILURE; } zend_fcall_info_argn(&handler->func.user->fci, 0); zval_ptr_dtor(&retval); } else { php_output_context_feed(context, handler->buffer.data, handler->buffer.size, handler->buffer.used, 0); if (SUCCESS == handler->func.internal(&handler->opaq, context)) { if (context->out.used) { status = PHP_OUTPUT_HANDLER_SUCCESS; } else { status = PHP_OUTPUT_HANDLER_NO_DATA; } } else { status = PHP_OUTPUT_HANDLER_FAILURE; } } handler->flags |= PHP_OUTPUT_HANDLER_STARTED; OG(running) = NULL; } switch (status) { case PHP_OUTPUT_HANDLER_FAILURE: /* disable this handler */ handler->flags |= PHP_OUTPUT_HANDLER_DISABLED; /* discard any output */ if (context->out.data && context->out.free) { efree(context->out.data); } /* returns handlers buffer */ context->out.data = handler->buffer.data; context->out.used = handler->buffer.used; context->out.free = 1; handler->buffer.data = NULL; handler->buffer.used = 0; handler->buffer.size = 0; break; case PHP_OUTPUT_HANDLER_NO_DATA: /* handler ate all */ php_output_context_reset(context); ZEND_FALLTHROUGH; case PHP_OUTPUT_HANDLER_SUCCESS: /* no more buffered data */ handler->buffer.used = 0; handler->flags |= PHP_OUTPUT_HANDLER_PROCESSED; break; } context->op = original_op; return status; } /* }}} */ /* {{{ static void php_output_op(int op, const char *str, size_t len) * Output op dispatcher, passes input and output handlers output through the output handler stack until it gets written to the SAPI */ static inline void php_output_op(int op, const char *str, size_t len) { php_output_context context; php_output_handler **active; int obh_cnt; if (php_output_lock_error(op)) { return; } php_output_context_init(&context, op); /* * broken up for better performance: * - apply op to the one active handler; note that OG(active) might be popped off the stack on a flush * - or apply op to the handler stack */ if (OG(active) && (obh_cnt = zend_stack_count(&OG(handlers)))) { context.in.data = (char *) str; context.in.used = len; if (obh_cnt > 1) { zend_stack_apply_with_argument(&OG(handlers), ZEND_STACK_APPLY_TOPDOWN, php_output_stack_apply_op, &context); } else if ((active = zend_stack_top(&OG(handlers))) && (!((*active)->flags & PHP_OUTPUT_HANDLER_DISABLED))) { php_output_handler_op(*active, &context); } else { php_output_context_pass(&context); } } else { context.out.data = (char *) str; context.out.used = len; } if (context.out.data && context.out.used) { php_output_header(); if (!(OG(flags) & PHP_OUTPUT_DISABLED)) { #if PHP_OUTPUT_DEBUG fprintf(stderr, "::: sapi_write('%s', %zu)\n", context.out.data, context.out.used); #endif sapi_module.ub_write(context.out.data, context.out.used); if (OG(flags) & PHP_OUTPUT_IMPLICITFLUSH) { sapi_flush(); } OG(flags) |= PHP_OUTPUT_SENT; } } php_output_context_dtor(&context); } /* }}} */ /* {{{ static int php_output_stack_apply_op(void *h, void *c) * Operation callback for the stack apply function */ static int php_output_stack_apply_op(void *h, void *c) { int was_disabled; php_output_handler_status_t status; php_output_handler *handler = *(php_output_handler **) h; php_output_context *context = (php_output_context *) c; if ((was_disabled = (handler->flags & PHP_OUTPUT_HANDLER_DISABLED))) { status = PHP_OUTPUT_HANDLER_FAILURE; } else { status = php_output_handler_op(handler, context); } /* * handler ate all => break * handler returned data or failed resp. is disabled => continue */ switch (status) { case PHP_OUTPUT_HANDLER_NO_DATA: return 1; case PHP_OUTPUT_HANDLER_SUCCESS: /* swap contexts buffers, unless this is the last handler in the stack */ if (handler->level) { php_output_context_swap(context); } return 0; case PHP_OUTPUT_HANDLER_FAILURE: default: if (was_disabled) { /* pass input along, if it's the last handler in the stack */ if (!handler->level) { php_output_context_pass(context); } } else { /* swap buffers, unless this is the last handler */ if (handler->level) { php_output_context_swap(context); } } return 0; } } /* }}} */ /* {{{ static int php_output_stack_apply_clean(void *h, void *c) * Clean callback for the stack apply function */ static int php_output_stack_apply_clean(void *h, void *c) { php_output_handler *handler = *(php_output_handler **) h; php_output_context *context = (php_output_context *) c; handler->buffer.used = 0; php_output_handler_op(handler, context); php_output_context_reset(context); return 0; } /* }}} */ /* {{{ static int php_output_stack_apply_list(void *h, void *z) * List callback for the stack apply function */ static int php_output_stack_apply_list(void *h, void *z) { php_output_handler *handler = *(php_output_handler **) h; zval *array = (zval *) z; add_next_index_str(array, zend_string_copy(handler->name)); return 0; } /* }}} */ /* {{{ static int php_output_stack_apply_status(void *h, void *z) * Status callback for the stack apply function */ static int php_output_stack_apply_status(void *h, void *z) { php_output_handler *handler = *(php_output_handler **) h; zval arr, *array = (zval *) z; add_next_index_zval(array, php_output_handler_status(handler, &arr)); return 0; } /* {{{ static zval *php_output_handler_status(php_output_handler *handler, zval *entry) * Returns an array with the status of the output handler */ static inline zval *php_output_handler_status(php_output_handler *handler, zval *entry) { ZEND_ASSERT(entry != NULL); array_init(entry); add_assoc_str(entry, "name", zend_string_copy(handler->name)); add_assoc_long(entry, "type", (zend_long) (handler->flags & 0xf)); add_assoc_long(entry, "flags", (zend_long) handler->flags); add_assoc_long(entry, "level", (zend_long) handler->level); add_assoc_long(entry, "chunk_size", (zend_long) handler->size); add_assoc_long(entry, "buffer_size", (zend_long) handler->buffer.size); add_assoc_long(entry, "buffer_used", (zend_long) handler->buffer.used); return entry; } /* }}} */ /* {{{ static int php_output_stack_pop(int flags) * Pops an output handler off the stack */ static int php_output_stack_pop(int flags) { php_output_context context; php_output_handler **current, *orphan = OG(active); if (!orphan) { if (!(flags & PHP_OUTPUT_POP_SILENT)) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to %s buffer. No buffer to %s", (flags&PHP_OUTPUT_POP_DISCARD)?"discard":"send", (flags&PHP_OUTPUT_POP_DISCARD)?"discard":"send"); } return 0; } else if (!(flags & PHP_OUTPUT_POP_FORCE) && !(orphan->flags & PHP_OUTPUT_HANDLER_REMOVABLE)) { if (!(flags & PHP_OUTPUT_POP_SILENT)) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to %s buffer of %s (%d)", (flags&PHP_OUTPUT_POP_DISCARD)?"discard":"send", ZSTR_VAL(orphan->name), orphan->level); } return 0; } else { php_output_context_init(&context, PHP_OUTPUT_HANDLER_FINAL); /* don't run the output handler if it's disabled */ if (!(orphan->flags & PHP_OUTPUT_HANDLER_DISABLED)) { /* didn't it start yet? */ if (!(orphan->flags & PHP_OUTPUT_HANDLER_STARTED)) { context.op |= PHP_OUTPUT_HANDLER_START; } /* signal that we're cleaning up */ if (flags & PHP_OUTPUT_POP_DISCARD) { context.op |= PHP_OUTPUT_HANDLER_CLEAN; } php_output_handler_op(orphan, &context); } /* pop it off the stack */ zend_stack_del_top(&OG(handlers)); if ((current = zend_stack_top(&OG(handlers)))) { OG(active) = *current; } else { OG(active) = NULL; } /* pass output along */ if (context.out.data && context.out.used && !(flags & PHP_OUTPUT_POP_DISCARD)) { php_output_write(context.out.data, context.out.used); } /* destroy the handler (after write!) */ php_output_handler_free(&orphan); php_output_context_dtor(&context); return 1; } } /* }}} */ /* {{{ static SUCCESS|FAILURE php_output_handler_compat_func(void *ctx, php_output_context *) * php_output_handler_context_func_t for php_output_handler_func_t output handlers */ static int php_output_handler_compat_func(void **handler_context, php_output_context *output_context) { php_output_handler_func_t func = *(php_output_handler_func_t *) handler_context; if (func) { char *out_str = NULL; size_t out_len = 0; func(output_context->in.data, output_context->in.used, &out_str, &out_len, output_context->op); if (out_str) { output_context->out.data = out_str; output_context->out.used = out_len; output_context->out.free = 1; } else { php_output_context_pass(output_context); } return SUCCESS; } return FAILURE; } /* }}} */ /* {{{ static SUCCESS|FAILURE php_output_handler_default_func(void *ctx, php_output_context *) * Default output handler */ static int php_output_handler_default_func(void **handler_context, php_output_context *output_context) { php_output_context_pass(output_context); return SUCCESS; } /* }}} */ /* {{{ static SUCCESS|FAILURE php_output_handler_devnull_func(void *ctx, php_output_context *) * Null output handler */ static int php_output_handler_devnull_func(void **handler_context, php_output_context *output_context) { return SUCCESS; } /* }}} */ /* * USERLAND (nearly 1:1 of old output.c) */ /* {{{ Turn on Output Buffering (specifying an optional output handler). */ PHP_FUNCTION(ob_start) { zval *output_handler = NULL; zend_long chunk_size = 0; zend_long flags = PHP_OUTPUT_HANDLER_STDFLAGS; if (zend_parse_parameters(ZEND_NUM_ARGS(), "|zll", &output_handler, &chunk_size, &flags) == FAILURE) { RETURN_THROWS(); } if (chunk_size < 0) { chunk_size = 0; } if (php_output_start_user(output_handler, chunk_size, flags) == FAILURE) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to create buffer"); RETURN_FALSE; } RETURN_TRUE; } /* }}} */ /* {{{ Flush (send) contents of the output buffer. The last buffer content is sent to next buffer */ PHP_FUNCTION(ob_flush) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (!OG(active)) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to flush buffer. No buffer to flush"); RETURN_FALSE; } if (SUCCESS != php_output_flush()) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to flush buffer of %s (%d)", ZSTR_VAL(OG(active)->name), OG(active)->level); RETURN_FALSE; } RETURN_TRUE; } /* }}} */ /* {{{ Clean (delete) the current output buffer */ PHP_FUNCTION(ob_clean) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (!OG(active)) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete buffer. No buffer to delete"); RETURN_FALSE; } if (SUCCESS != php_output_clean()) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete buffer of %s (%d)", ZSTR_VAL(OG(active)->name), OG(active)->level); RETURN_FALSE; } RETURN_TRUE; } /* }}} */ /* {{{ Flush (send) the output buffer, and delete current output buffer */ PHP_FUNCTION(ob_end_flush) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (!OG(active)) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete and flush buffer. No buffer to delete or flush"); RETURN_FALSE; } RETURN_BOOL(SUCCESS == php_output_end()); } /* }}} */ /* {{{ Clean the output buffer, and delete current output buffer */ PHP_FUNCTION(ob_end_clean) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (!OG(active)) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete buffer. No buffer to delete"); RETURN_FALSE; } RETURN_BOOL(SUCCESS == php_output_discard()); } /* }}} */ /* {{{ Get current buffer contents, flush (send) the output buffer, and delete current output buffer */ PHP_FUNCTION(ob_get_flush) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (php_output_get_contents(return_value) == FAILURE) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete and flush buffer. No buffer to delete or flush"); RETURN_FALSE; } if (SUCCESS != php_output_end()) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete buffer of %s (%d)", ZSTR_VAL(OG(active)->name), OG(active)->level); } } /* }}} */ /* {{{ Get current buffer contents and delete current output buffer */ PHP_FUNCTION(ob_get_clean) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if(!OG(active)) { RETURN_FALSE; } if (php_output_get_contents(return_value) == FAILURE) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete buffer. No buffer to delete"); RETURN_FALSE; } if (SUCCESS != php_output_discard()) { php_error_docref("ref.outcontrol", E_NOTICE, "Failed to delete buffer of %s (%d)", ZSTR_VAL(OG(active)->name), OG(active)->level); } } /* }}} */ /* {{{ Return the contents of the output buffer */ PHP_FUNCTION(ob_get_contents) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (php_output_get_contents(return_value) == FAILURE) { RETURN_FALSE; } } /* }}} */ /* {{{ Return the nesting level of the output buffer */ PHP_FUNCTION(ob_get_level) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } RETURN_LONG(php_output_get_level()); } /* }}} */ /* {{{ Return the length of the output buffer */ PHP_FUNCTION(ob_get_length) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (php_output_get_length(return_value) == FAILURE) { RETURN_FALSE; } } /* }}} */ /* {{{ List all output_buffers in an array */ PHP_FUNCTION(ob_list_handlers) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } array_init(return_value); if (!OG(active)) { return; } zend_stack_apply_with_argument(&OG(handlers), ZEND_STACK_APPLY_BOTTOMUP, php_output_stack_apply_list, return_value); } /* }}} */ /* {{{ Return the status of the active or all output buffers */ PHP_FUNCTION(ob_get_status) { bool full_status = 0; if (zend_parse_parameters(ZEND_NUM_ARGS(), "|b", &full_status) == FAILURE) { RETURN_THROWS(); } if (!OG(active)) { array_init(return_value); return; } if (full_status) { array_init(return_value); zend_stack_apply_with_argument(&OG(handlers), ZEND_STACK_APPLY_BOTTOMUP, php_output_stack_apply_status, return_value); } else { php_output_handler_status(OG(active), return_value); } } /* }}} */ /* {{{ Turn implicit flush on/off and is equivalent to calling flush() after every output call */ PHP_FUNCTION(ob_implicit_flush) { zend_long flag = 1; if (zend_parse_parameters(ZEND_NUM_ARGS(), "|b", &flag) == FAILURE) { RETURN_THROWS(); } php_output_set_implicit_flush((int) flag); } /* }}} */ /* {{{ Reset(clear) URL rewriter values */ PHP_FUNCTION(output_reset_rewrite_vars) { if (zend_parse_parameters_none() == FAILURE) { RETURN_THROWS(); } if (php_url_scanner_reset_vars() == SUCCESS) { RETURN_TRUE; } else { RETURN_FALSE; } } /* }}} */ /* {{{ Add URL rewriter values */ PHP_FUNCTION(output_add_rewrite_var) { char *name, *value; size_t name_len, value_len; if (zend_parse_parameters(ZEND_NUM_ARGS(), "ss", &name, &name_len, &value, &value_len) == FAILURE) { RETURN_THROWS(); } if (php_url_scanner_add_var(name, name_len, value, value_len, 1) == SUCCESS) { RETURN_TRUE; } else { RETURN_FALSE; } } /* }}} */