php-src/main/output.c

774 lines
21 KiB
C
Raw Normal View History

/*
+----------------------------------------------------------------------+
2001-12-11 23:32:16 +08:00
| PHP Version 4 |
+----------------------------------------------------------------------+
2001-12-11 23:32:16 +08:00
| Copyright (c) 1997-2002 The PHP Group |
+----------------------------------------------------------------------+
| This source file is subject to version 2.02 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available at through the world-wide-web at |
| http://www.php.net/license/2_02.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@zend.com> |
2000-10-29 17:14:55 +08:00
| Thies C. Arntzen <thies@thieso.net> |
+----------------------------------------------------------------------+
*/
/* $Id$ */
#include "php.h"
#include "ext/standard/head.h"
2001-07-20 22:40:30 +08:00
#include "ext/standard/basic_functions.h"
#include "SAPI.h"
/* output functions */
2001-08-05 23:29:47 +08:00
static int php_ub_body_write(const char *str, uint str_length TSRMLS_DC);
static int php_ub_body_write_no_header(const char *str, uint str_length TSRMLS_DC);
static int php_b_body_write(const char *str, uint str_length TSRMLS_DC);
static void php_ob_init(uint initial_size, uint block_size, zval *output_handler, uint chunk_size, zend_bool erase TSRMLS_DC);
2001-08-05 23:29:47 +08:00
static void php_ob_append(const char *text, uint text_length TSRMLS_DC);
1999-12-05 22:16:37 +08:00
#if 0
static void php_ob_prepend(const char *text, uint text_length);
1999-12-05 22:16:37 +08:00
#endif
#ifdef ZTS
int output_globals_id;
#else
php_output_globals output_globals;
#endif
2001-08-05 23:29:47 +08:00
static int php_default_output_func(const char *str, uint str_len TSRMLS_DC)
{
fwrite(str, 1, str_len, stderr);
2001-05-30 04:32:57 +08:00
return str_len;
}
static void php_output_init_globals(php_output_globals *output_globals_p TSRMLS_DC)
{
OG(php_body_write) = php_default_output_func;
OG(php_header_write) = php_default_output_func;
OG(implicit_flush) = 0;
OG(output_start_filename) = NULL;
OG(output_start_lineno) = 0;
}
2001-05-24 00:52:45 +08:00
/* Start output layer */
PHPAPI void php_output_startup(void)
{
#ifdef ZTS
ts_allocate_id(&output_globals_id, sizeof(php_output_globals), (ts_allocate_ctor) php_output_init_globals, NULL);
#else
php_output_init_globals(&output_globals TSRMLS_CC);
#endif
}
2001-08-05 23:29:47 +08:00
PHPAPI void php_output_activate(TSRMLS_D)
{
OG(php_body_write) = php_ub_body_write;
OG(php_header_write) = sapi_module.ub_write;
OG(ob_nesting_level) = 0;
OG(ob_lock) = 0;
OG(disable_output) = 0;
}
2001-08-05 23:29:47 +08:00
PHPAPI void php_output_set_status(zend_bool status TSRMLS_DC)
{
OG(disable_output) = !status;
2001-03-04 09:45:19 +08:00
}
2001-08-05 23:29:47 +08:00
void php_output_register_constants(TSRMLS_D)
2001-03-04 09:45:19 +08:00
{
REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_START", PHP_OUTPUT_HANDLER_START, CONST_CS | CONST_PERSISTENT);
REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_CONT", PHP_OUTPUT_HANDLER_CONT, CONST_CS | CONST_PERSISTENT);
REGISTER_MAIN_LONG_CONSTANT("PHP_OUTPUT_HANDLER_END", PHP_OUTPUT_HANDLER_END, CONST_CS | CONST_PERSISTENT);
}
2001-03-04 09:45:19 +08:00
PHPAPI int php_body_write(const char *str, uint str_length TSRMLS_DC)
{
2001-08-05 23:29:47 +08:00
return OG(php_body_write)(str, str_length TSRMLS_CC);
}
PHPAPI int php_header_write(const char *str, uint str_length TSRMLS_DC)
{
if (OG(disable_output)) {
return 0;
} else {
2001-08-05 23:29:47 +08:00
return OG(php_header_write)(str, str_length TSRMLS_CC);
}
}
/* {{{ php_start_ob_buffer
* Start output buffering */
PHPAPI int php_start_ob_buffer(zval *output_handler, uint chunk_size, zend_bool erase TSRMLS_DC)
{
if (OG(ob_lock)) {
return FAILURE;
}
if (chunk_size) {
php_ob_init((chunk_size*3/2), chunk_size/2, output_handler, chunk_size, erase TSRMLS_CC);
} else {
php_ob_init(40*1024, 10*1024, output_handler, chunk_size, erase TSRMLS_CC);
}
1999-11-24 06:10:44 +08:00
OG(php_body_write) = php_b_body_write;
return SUCCESS;
}
/* }}} */
/* {{{ php_end_ob_buffer
* End output buffering (one level) */
2001-08-05 23:29:47 +08:00
PHPAPI void php_end_ob_buffer(zend_bool send_buffer, zend_bool just_flush TSRMLS_DC)
{
char *final_buffer=NULL;
2000-09-03 23:58:50 +08:00
int final_buffer_length=0;
zval *alternate_buffer=NULL;
2001-03-07 03:38:33 +08:00
char *to_be_destroyed_buffer;
char *to_be_destroyed_handled_output[2] = { 0, 0 };
int status;
php_ob_buffer *prev_ob_buffer_p=NULL;
php_ob_buffer orig_ob_buffer;
if (OG(ob_nesting_level)==0) {
return;
}
status = 0;
if (!OG(active_ob_buffer).status & PHP_OUTPUT_HANDLER_START) {
/* our first call */
status |= PHP_OUTPUT_HANDLER_START;
}
if (just_flush) {
status |= PHP_OUTPUT_HANDLER_CONT;
} else {
status |= PHP_OUTPUT_HANDLER_END;
}
if (OG(active_ob_buffer).internal_output_handler) {
2001-03-07 00:28:51 +08:00
final_buffer = OG(active_ob_buffer).internal_output_handler_buffer;
final_buffer_length = OG(active_ob_buffer).internal_output_handler_buffer_size;
2001-08-05 23:29:47 +08:00
OG(active_ob_buffer).internal_output_handler(OG(active_ob_buffer).buffer, OG(active_ob_buffer).text_length, &final_buffer, &final_buffer_length, status TSRMLS_CC);
} else if (OG(active_ob_buffer).output_handler) {
zval **params[2];
zval *orig_buffer;
zval *z_status;
ALLOC_INIT_ZVAL(orig_buffer);
2001-08-05 09:43:02 +08:00
ZVAL_STRINGL(orig_buffer, OG(active_ob_buffer).buffer, OG(active_ob_buffer).text_length, 0);
orig_buffer->refcount=2; /* don't let call_user_function() destroy our buffer */
orig_buffer->is_ref=1;
ALLOC_INIT_ZVAL(z_status);
2001-08-05 09:43:02 +08:00
ZVAL_LONG(z_status, status);
params[0] = &orig_buffer;
params[1] = &z_status;
OG(ob_lock) = 1;
2001-07-30 16:24:42 +08:00
if (call_user_function_ex(CG(function_table), NULL, OG(active_ob_buffer).output_handler, &alternate_buffer, 2, params, 1, NULL TSRMLS_CC)==SUCCESS) {
convert_to_string_ex(&alternate_buffer);
final_buffer = Z_STRVAL_P(alternate_buffer);
final_buffer_length = Z_STRLEN_P(alternate_buffer);
}
OG(ob_lock) = 0;
zval_ptr_dtor(&OG(active_ob_buffer).output_handler);
if (orig_buffer->refcount==2) { /* free the zval */
FREE_ZVAL(orig_buffer);
} else {
2001-02-27 08:09:14 +08:00
orig_buffer->refcount-=2;
}
zval_ptr_dtor(&z_status);
zval_ptr_dtor(&OG(active_ob_buffer).output_handler);
}
if (!final_buffer) {
final_buffer = OG(active_ob_buffer).buffer;
final_buffer_length = OG(active_ob_buffer).text_length;
}
if (OG(ob_nesting_level)==1) { /* end buffering */
if (SG(headers_sent) && !SG(request_info).headers_only) {
OG(php_body_write) = php_ub_body_write_no_header;
} else {
OG(php_body_write) = php_ub_body_write;
}
}
to_be_destroyed_buffer = OG(active_ob_buffer).buffer;
2001-03-07 03:38:33 +08:00
if (OG(active_ob_buffer).internal_output_handler
2001-08-31 23:16:15 +08:00
&& (final_buffer != OG(active_ob_buffer).internal_output_handler_buffer)
&& (final_buffer != OG(active_ob_buffer).buffer)) {
2001-03-07 03:38:33 +08:00
to_be_destroyed_handled_output[0] = final_buffer;
}
if (!just_flush) {
2001-03-07 03:38:33 +08:00
if (OG(active_ob_buffer).internal_output_handler) {
to_be_destroyed_handled_output[1] = OG(active_ob_buffer).internal_output_handler_buffer;
}
}
if (OG(ob_nesting_level)>1) { /* restore previous buffer */
zend_stack_top(&OG(ob_buffers), (void **) &prev_ob_buffer_p);
orig_ob_buffer = OG(active_ob_buffer);
OG(active_ob_buffer) = *prev_ob_buffer_p;
zend_stack_del_top(&OG(ob_buffers));
if (!just_flush && OG(ob_nesting_level)==2) { /* destroy the stack */
zend_stack_destroy(&OG(ob_buffers));
}
}
OG(ob_nesting_level)--;
if (send_buffer) {
2001-08-05 23:29:47 +08:00
OG(php_body_write)(final_buffer, final_buffer_length TSRMLS_CC);
}
if (just_flush) { /* we restored the previous ob, return to the current */
if (prev_ob_buffer_p) {
zend_stack_push(&OG(ob_buffers), &OG(active_ob_buffer), sizeof(php_ob_buffer));
OG(active_ob_buffer) = orig_ob_buffer;
}
OG(ob_nesting_level)++;
}
if (alternate_buffer) {
zval_ptr_dtor(&alternate_buffer);
}
if (!just_flush) {
efree(to_be_destroyed_buffer);
} else {
OG(active_ob_buffer).text_length = 0;
OG(active_ob_buffer).status |= PHP_OUTPUT_HANDLER_START;
OG(php_body_write) = php_b_body_write;
2001-03-07 03:38:33 +08:00
}
if (to_be_destroyed_handled_output[0]) {
efree(to_be_destroyed_handled_output[0]);
}
if (to_be_destroyed_handled_output[1]) {
efree(to_be_destroyed_handled_output[1]);
}
}
/* }}} */
/* {{{ php_end_ob_buffers
* End output buffering (all buffers) */
2001-08-05 23:29:47 +08:00
PHPAPI void php_end_ob_buffers(zend_bool send_buffer TSRMLS_DC)
{
while (OG(ob_nesting_level)!=0) {
2001-08-05 23:29:47 +08:00
php_end_ob_buffer(send_buffer, 0 TSRMLS_CC);
}
}
/* }}} */
/* {{{ php_start_implicit_flush
*/
2001-08-05 23:29:47 +08:00
PHPAPI void php_start_implicit_flush(TSRMLS_D)
{
OG(implicit_flush)=1;
}
/* }}} */
/* {{{ php_end_implicit_flush
*/
2001-08-05 23:29:47 +08:00
PHPAPI void php_end_implicit_flush(TSRMLS_D)
{
OG(implicit_flush)=0;
}
/* }}} */
/* {{{ php_ob_set_internal_handler
*/
PHPAPI void php_ob_set_internal_handler(php_output_handler_func_t internal_output_handler, uint buffer_size, char *handler_name, zend_bool erase TSRMLS_DC)
{
if (OG(ob_nesting_level)==0) {
return;
}
OG(active_ob_buffer).internal_output_handler = internal_output_handler;
OG(active_ob_buffer).internal_output_handler_buffer = (char *) emalloc(buffer_size);
OG(active_ob_buffer).internal_output_handler_buffer_size = buffer_size;
OG(active_ob_buffer).handler_name = handler_name;
OG(active_ob_buffer).erase = erase;
}
/* }}} */
/*
* Output buffering - implementation
*/
/* {{{ php_ob_allocate
*/
2001-08-05 23:29:47 +08:00
static inline void php_ob_allocate(TSRMLS_D)
{
if (OG(active_ob_buffer).size<OG(active_ob_buffer).text_length) {
while (OG(active_ob_buffer).size <= OG(active_ob_buffer).text_length) {
OG(active_ob_buffer).size+=OG(active_ob_buffer).block_size;
}
OG(active_ob_buffer).buffer = (char *) erealloc(OG(active_ob_buffer).buffer, OG(active_ob_buffer).size+1);
}
}
/* }}} */
/* {{{ php_ob_init
*/
static void php_ob_init(uint initial_size, uint block_size, zval *output_handler, uint chunk_size, zend_bool erase TSRMLS_DC)
{
if (OG(ob_nesting_level)>0) {
if (OG(ob_nesting_level)==1) { /* initialize stack */
zend_stack_init(&OG(ob_buffers));
}
zend_stack_push(&OG(ob_buffers), &OG(active_ob_buffer), sizeof(php_ob_buffer));
}
OG(ob_nesting_level)++;
OG(active_ob_buffer).block_size = block_size;
OG(active_ob_buffer).size = initial_size;
OG(active_ob_buffer).buffer = (char *) emalloc(initial_size+1);
OG(active_ob_buffer).text_length = 0;
OG(active_ob_buffer).output_handler = output_handler;
OG(active_ob_buffer).chunk_size = chunk_size;
OG(active_ob_buffer).status = 0;
OG(active_ob_buffer).internal_output_handler = NULL;
if (output_handler && output_handler->type == IS_STRING) {
OG(active_ob_buffer).handler_name = Z_STRVAL_P(output_handler);
}
else if (output_handler && output_handler->type == IS_ARRAY) {
/* FIXME: Array type is not supported yet.
See call_user_function_ex() for detials. */
OG(active_ob_buffer).handler_name = "array is not supported yet";
}
else {
OG(active_ob_buffer).handler_name = "default output handler";
}
OG(active_ob_buffer).erase = erase;
}
/* }}} */
/* {{{ php_ob_append
*/
2001-08-05 23:29:47 +08:00
static void php_ob_append(const char *text, uint text_length TSRMLS_DC)
{
char *target;
int original_ob_text_length;
original_ob_text_length=OG(active_ob_buffer).text_length;
2001-02-27 08:09:14 +08:00
OG(active_ob_buffer).text_length = OG(active_ob_buffer).text_length + text_length;
2001-08-05 23:29:47 +08:00
php_ob_allocate(TSRMLS_C);
2001-02-27 08:09:14 +08:00
target = OG(active_ob_buffer).buffer+original_ob_text_length;
memcpy(target, text, text_length);
target[text_length]=0;
if (OG(active_ob_buffer).chunk_size
2001-02-27 08:09:14 +08:00
&& OG(active_ob_buffer).text_length >= OG(active_ob_buffer).chunk_size) {
zval *output_handler = OG(active_ob_buffer).output_handler;
if (output_handler) {
output_handler->refcount++;
}
2001-08-05 23:29:47 +08:00
php_end_ob_buffer(1, 1 TSRMLS_CC);
return;
}
}
/* }}} */
1999-12-05 22:16:37 +08:00
#if 0
static void php_ob_prepend(const char *text, uint text_length)
{
char *p, *start;
TSRMLS_FETCH();
OG(active_ob_buffer).text_length += text_length;
2001-08-05 23:29:47 +08:00
php_ob_allocate(TSRMLS_C);
1999-11-24 06:10:44 +08:00
/* php_ob_allocate() may change OG(ob_buffer), so we can't initialize p&start earlier */
p = OG(ob_buffer)+OG(ob_text_length);
start = OG(ob_buffer);
while (--p>=start) {
p[text_length] = *p;
}
1999-11-24 06:10:44 +08:00
memcpy(OG(ob_buffer), text, text_length);
OG(ob_buffer)[OG(active_ob_buffer).text_length]=0;
}
1999-12-05 22:16:37 +08:00
#endif
/* {{{ php_ob_get_buffer
* Return the current output buffer */
int php_ob_get_buffer(zval *p TSRMLS_DC)
{
if (OG(ob_nesting_level)==0) {
return FAILURE;
}
2001-08-05 09:43:02 +08:00
ZVAL_STRINGL(p, OG(active_ob_buffer).buffer, OG(active_ob_buffer).text_length, 1);
return SUCCESS;
}
/* }}} */
/* {{{ php_ob_get_length
* Return the size of the current output buffer */
int php_ob_get_length(zval *p TSRMLS_DC)
{
if (OG(ob_nesting_level) == 0) {
return FAILURE;
}
2001-08-05 09:43:02 +08:00
ZVAL_LONG(p, OG(active_ob_buffer).text_length);
return SUCCESS;
}
/* }}} */
/*
* Wrapper functions - implementation
*/
/* buffered output function */
2001-08-05 23:29:47 +08:00
static int php_b_body_write(const char *str, uint str_length TSRMLS_DC)
{
2001-08-05 23:29:47 +08:00
php_ob_append(str, str_length TSRMLS_CC);
return str_length;
}
/* {{{ php_ub_body_write_no_header
*/
2001-08-05 23:29:47 +08:00
static int php_ub_body_write_no_header(const char *str, uint str_length TSRMLS_DC)
{
char *newstr = NULL;
2000-10-27 02:10:57 +08:00
size_t new_length=0;
int result;
if (OG(disable_output)) {
return 0;
}
if (newstr) {
str = newstr;
str_length = new_length;
}
2001-08-05 23:29:47 +08:00
result = OG(php_header_write)(str, str_length TSRMLS_CC);
if (OG(implicit_flush)) {
sapi_flush(TSRMLS_C);
}
return result;
}
/* }}} */
/* {{{ php_ub_body_write
*/
2001-08-05 23:29:47 +08:00
static int php_ub_body_write(const char *str, uint str_length TSRMLS_DC)
{
int result = 0;
if (SG(request_info).headers_only) {
php_header();
zend_bailout();
}
1999-12-18 03:51:39 +08:00
if (php_header()) {
2001-07-30 16:24:42 +08:00
if (zend_is_compiling(TSRMLS_C)) {
OG(output_start_filename) = zend_get_compiled_filename(TSRMLS_C);
OG(output_start_lineno) = zend_get_compiled_lineno(TSRMLS_C);
2001-07-30 16:24:42 +08:00
} else if (zend_is_executing(TSRMLS_C)) {
OG(output_start_filename) = zend_get_executed_filename(TSRMLS_C);
OG(output_start_lineno) = zend_get_executed_lineno(TSRMLS_C);
}
1999-11-24 06:10:44 +08:00
OG(php_body_write) = php_ub_body_write_no_header;
2001-08-05 23:29:47 +08:00
result = php_ub_body_write_no_header(str, str_length TSRMLS_CC);
}
return result;
}
/* }}} */
/*
* HEAD support
*/
/* {{{ proto void ob_start([ string user_function [, int chunk_size [, bool erase]]])
2000-11-13 06:13:35 +08:00
Turn on Output Buffering (specifying an optional output handler). */
PHP_FUNCTION(ob_start)
{
zval *output_handler=NULL;
2001-02-27 08:09:14 +08:00
uint chunk_size=0;
zend_bool erase=1;
int argc = ZEND_NUM_ARGS();
if (zend_parse_parameters(argc TSRMLS_CC, "|zlb", &output_handler,
&chunk_size, &erase) == FAILURE)
return;
if (output_handler) {
SEPARATE_ZVAL(&output_handler);
output_handler->refcount++;
}
if (php_start_ob_buffer(output_handler, chunk_size, erase TSRMLS_CC)==FAILURE) {
2001-06-27 02:30:31 +08:00
if (SG(headers_sent) && !SG(request_info).headers_only) {
OG(php_body_write) = php_ub_body_write_no_header;
} else {
OG(php_body_write) = php_ub_body_write;
}
OG(ob_nesting_level) = 0;
2001-06-27 02:30:31 +08:00
php_error(E_ERROR, "Cannot use output buffering in output buffering display handlers");
RETURN_FALSE;
}
RETURN_TRUE;
}
2000-04-19 03:18:47 +08:00
/* }}} */
/* {{{ proto bool ob_flush(void)
Flush (send) contents of the output buffers */
PHP_FUNCTION(ob_flush)
{
if (ZEND_NUM_ARGS() != 0)
WRONG_PARAM_COUNT;
if (!OG(ob_nesting_level)) {
php_error(E_NOTICE, "%s() failed to flush buffer. No buffer to flush.",
get_active_function_name(TSRMLS_C));
RETURN_FALSE;
}
php_end_ob_buffer(1, 1 TSRMLS_CC);
RETURN_TRUE;
}
/* }}} */
/* {{{ proto bool ob_clean(void)
Clean (delete) the current output buffer */
PHP_FUNCTION(ob_clean)
{
if (ZEND_NUM_ARGS() != 0)
WRONG_PARAM_COUNT;
if (!OG(ob_nesting_level)) {
php_error(E_NOTICE, "%s() failed to delete buffer. No buffer to delete.",
get_active_function_name(TSRMLS_C));
RETURN_FALSE;
}
if (OG(ob_nesting_level) && !OG(active_ob_buffer).status && !OG(active_ob_buffer).erase) {
php_error(E_NOTICE, "%s() failed to delete buffer %s.",
get_active_function_name(TSRMLS_C), OG(active_ob_buffer).handler_name);
RETURN_FALSE;
}
php_end_ob_buffer(0, 1 TSRMLS_CC);
RETURN_TRUE;
}
/* }}} */
/* {{{ proto bool ob_end_flush(void)
Flush (send) the output buffer, and delete current output buffer */
PHP_FUNCTION(ob_end_flush)
{
if (ZEND_NUM_ARGS() != 0)
WRONG_PARAM_COUNT;
if (!OG(ob_nesting_level)) {
php_error(E_NOTICE, "%s() failed to delete and flush buffer. No buffer to delete or flush.",
get_active_function_name(TSRMLS_C));
RETURN_FALSE;
}
if (OG(ob_nesting_level) && !OG(active_ob_buffer).status && !OG(active_ob_buffer).erase) {
php_error(E_NOTICE, "%s() failed to delete buffer %s.",
get_active_function_name(TSRMLS_C), OG(active_ob_buffer).handler_name);
RETURN_FALSE;
}
2001-08-05 23:29:47 +08:00
php_end_ob_buffer(1, 0 TSRMLS_CC);
RETURN_TRUE;
}
2000-04-19 03:18:47 +08:00
/* }}} */
/* {{{ proto bool ob_end_clean(void)
Clean the output buffer, and delete current output buffer */
PHP_FUNCTION(ob_end_clean)
{
if (ZEND_NUM_ARGS() != 0)
WRONG_PARAM_COUNT;
if (!OG(ob_nesting_level)) {
php_error(E_NOTICE, "%s() failed to delete buffer. No buffer to delete.",
get_active_function_name(TSRMLS_C));
RETURN_FALSE;
}
if (OG(ob_nesting_level) && !OG(active_ob_buffer).status && !OG(active_ob_buffer).erase) {
php_error(E_NOTICE, "%s() failed to delete buffer %s.",
get_active_function_name(TSRMLS_C), OG(active_ob_buffer).handler_name);
RETURN_FALSE;
}
2001-08-05 23:29:47 +08:00
php_end_ob_buffer(0, 0 TSRMLS_CC);
RETURN_TRUE;
}
2000-04-19 03:18:47 +08:00
/* }}} */
2000-05-24 07:13:02 +08:00
/* {{{ proto string ob_get_contents(void)
2000-04-19 03:18:47 +08:00
Return the contents of the output buffer */
PHP_FUNCTION(ob_get_contents)
{
if (ZEND_NUM_ARGS() != 0)
WRONG_PARAM_COUNT;
2001-08-05 23:29:47 +08:00
if (php_ob_get_buffer(return_value TSRMLS_CC)==FAILURE) {
RETURN_FALSE;
}
}
2000-04-19 03:18:47 +08:00
/* }}} */
/* {{{ proto integer ob_get_level(void)
Return the nesting level of the output buffer */
PHP_FUNCTION(ob_get_level)
{
if (ZEND_NUM_ARGS() != 0)
WRONG_PARAM_COUNT;
RETURN_LONG (OG(ob_nesting_level));
}
/* }}} */
/* {{{ proto string ob_get_length(void)
Return the length of the output buffer */
PHP_FUNCTION(ob_get_length)
{
if (ZEND_NUM_ARGS() != 0)
WRONG_PARAM_COUNT;
2001-08-05 23:29:47 +08:00
if (php_ob_get_length(return_value TSRMLS_CC)==FAILURE) {
RETURN_FALSE;
}
}
/* }}} */
static int php_ob_buffer_status(php_ob_buffer *ob_buffer, zval *result)
{
zval *elem;
MAKE_STD_ZVAL(elem);
if (array_init(elem))
return FAILURE;
if (ob_buffer->internal_output_handler) {
add_assoc_long(elem, "type", PHP_OUTPUT_HANDLER_INTERNAL);
}
else {
add_assoc_long(elem, "type", PHP_OUTPUT_HANDLER_USER);
}
add_assoc_long(elem, "status", ob_buffer->status);
add_assoc_string(elem, "name", ob_buffer->handler_name, 1);
add_assoc_bool(elem, "del", ob_buffer->erase);
add_next_index_zval(result, elem);
return SUCCESS;
}
/* {{{ poto array ob_get_status([bool full_status])
Return the nesting level of the output buffer */
PHP_FUNCTION(ob_get_status)
{
int argc = ZEND_NUM_ARGS();
zend_bool full_status = 0;
if (zend_parse_parameters(argc TSRMLS_CC, "|b", &full_status) == FAILURE )
return;
if (array_init(return_value) == FAILURE) {
RETURN_FALSE;
}
if (full_status) {
zval *elem;
zend_stack_apply_with_argument(&OG(ob_buffers), ZEND_STACK_APPLY_BOTTOMUP, (int (*)(void *elem, void *))php_ob_buffer_status, return_value);
MAKE_STD_ZVAL(elem);
if (array_init(elem))
RETURN_FALSE;
if (OG(active_ob_buffer).internal_output_handler) {
add_assoc_long(elem, "type", PHP_OUTPUT_HANDLER_INTERNAL);
}
else {
add_assoc_long(elem, "type", PHP_OUTPUT_HANDLER_USER);
}
add_assoc_long(elem, "status", OG(active_ob_buffer).status);
add_assoc_string(elem, "name", OG(active_ob_buffer).handler_name, 1);
add_assoc_bool(elem, "del", OG(active_ob_buffer).erase);
add_next_index_zval(return_value, elem);
}
else {
add_assoc_long(return_value, "level", OG(ob_nesting_level));
if (OG(active_ob_buffer).internal_output_handler) {
add_assoc_long(return_value, "type", PHP_OUTPUT_HANDLER_INTERNAL);
}
else {
add_assoc_long(return_value, "type", PHP_OUTPUT_HANDLER_USER);
}
add_assoc_long(return_value, "status", OG(active_ob_buffer).status);
add_assoc_string(return_value, "name", OG(active_ob_buffer).handler_name, 1);
add_assoc_bool(return_value, "del", OG(active_ob_buffer).erase);
}
}
/* }}} */
2000-04-19 04:00:21 +08:00
/* {{{ proto void ob_implicit_flush([int flag])
Turn implicit flush on/off and is equivalent to calling flush() after every output call */
PHP_FUNCTION(ob_implicit_flush)
{
zval **zv_flag;
2000-01-16 01:23:18 +08:00
int flag;
switch(ZEND_NUM_ARGS()) {
case 0:
flag = 1;
break;
case 1:
if (zend_get_parameters_ex(1, &zv_flag)==FAILURE) {
RETURN_FALSE;
}
convert_to_long_ex(zv_flag);
flag = Z_LVAL_PP(zv_flag);
break;
2000-01-16 01:23:18 +08:00
default:
WRONG_PARAM_COUNT;
break;
}
if (flag) {
2001-08-05 23:29:47 +08:00
php_start_implicit_flush(TSRMLS_C);
} else {
2001-08-05 23:29:47 +08:00
php_end_implicit_flush(TSRMLS_C);
}
}
2000-04-19 03:18:47 +08:00
/* }}} */
2001-08-05 23:29:47 +08:00
PHPAPI char *php_get_output_start_filename(TSRMLS_D)
{
return OG(output_start_filename);
}
2001-08-05 23:29:47 +08:00
PHPAPI int php_get_output_start_lineno(TSRMLS_D)
{
return OG(output_start_lineno);
}
/*
* Local variables:
* tab-width: 4
* c-basic-offset: 4
* End:
* vim600: sw=4 ts=4 fdm=marker
* vim<600: sw=4 ts=4
*/