From: Arnaud Le Blanc Date: Thu, 13 Nov 2008 10:14:04 +0000 (+0000) Subject: Added header_remove() (chsc at peytz dotdk, Arnaud) X-Git-Tag: php-5.3.0alpha2~169 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8c4151ad72b6c5a82b341aaf59d2c31521ca4341;p=php Added header_remove() (chsc at peytz dotdk, Arnaud) [DOC] proto void header_remove([string header_name]) Removes an HTTP header previously set using header() The header_name parameter is optionnal, all headers are removed if it is not set [SAPIs] The header_handler callback in sapi_module_struct has been changed, it now take a new argument. When it is set to SAPI_HEADER_DELETE, sapi_header->header is the name of an header, header_handler has to delete it. When it is set to SAPI_HEADER_DELETE_ALL, header_handler has to delete all headers. When sapi_header_op_enum is SAPI_HEADER_ADD or _REPLACE, sapi_header->header is in the form "Name: value", header_handler has to add or replace the given header. In all cases, header_handler must not free sapi_header or sapi_header->header. SAPI_HEADER_ADD must be returned if the header has been added or replaced, or 0 in other cases. --- diff --git a/NEWS b/NEWS index 67ba1db56d..01b9728527 100644 --- a/NEWS +++ b/NEWS @@ -10,6 +10,7 @@ PHP NEWS parameter validation. (Felipe) - Changed openssl info to show the shared library version number. (Scott) +- Added header_remove() function. (chsc at peytz dot dk, Arnaud) - Added stream_context_get_params() function. (Arnaud) - Added optional parameter "new" to sybase_connect() (Timm) - Added parse_ini_string() function. (grange at lemonde dot fr, Arnaud) diff --git a/ext/standard/basic_functions.c b/ext/standard/basic_functions.c index d8c8d66115..e1f314b9c4 100644 --- a/ext/standard/basic_functions.c +++ b/ext/standard/basic_functions.c @@ -1691,6 +1691,11 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_header, 0, 0, 1) ZEND_ARG_INFO(0, http_response_code) ZEND_END_ARG_INFO() +static +ZEND_BEGIN_ARG_INFO_EX(arginfo_header_remove, 0, 0, 0) + ZEND_ARG_INFO(0, name) +ZEND_END_ARG_INFO() + static ZEND_BEGIN_ARG_INFO_EX(arginfo_setcookie, 0, 0, 1) ZEND_ARG_INFO(0, name) @@ -3455,6 +3460,7 @@ const zend_function_entry basic_functions[] = { /* {{{ */ PHP_FE(setcookie, arginfo_setcookie) PHP_FE(setrawcookie, arginfo_setrawcookie) PHP_FE(header, arginfo_header) + PHP_FE(header_remove, arginfo_header_remove) PHP_FE(headers_sent, arginfo_headers_sent) PHP_FE(headers_list, arginfo_headers_list) diff --git a/ext/standard/head.c b/ext/standard/head.c index 3e6c59f133..bcb7f37963 100644 --- a/ext/standard/head.c +++ b/ext/standard/head.c @@ -50,6 +50,20 @@ PHP_FUNCTION(header) } /* }}} */ +/* {{{ proto void header_remove([string name]) + Removes an HTTP header previously set using header() */ +PHP_FUNCTION(header_remove) +{ + sapi_header_line ctr = {0}; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &ctr.line, + &ctr.line_len) == FAILURE) + return; + + sapi_header_op(ZEND_NUM_ARGS() == 0 ? SAPI_HEADER_DELETE_ALL : SAPI_HEADER_DELETE, &ctr TSRMLS_CC); +} +/* }}} */ + PHPAPI int php_header(TSRMLS_D) { if (sapi_send_headers(TSRMLS_C)==FAILURE || SG(request_info).headers_only) { diff --git a/ext/standard/head.h b/ext/standard/head.h index 81abf7094f..54dce2685b 100644 --- a/ext/standard/head.h +++ b/ext/standard/head.h @@ -23,6 +23,7 @@ extern PHP_RINIT_FUNCTION(head); PHP_FUNCTION(header); +PHP_FUNCTION(header_remove); PHP_FUNCTION(setcookie); PHP_FUNCTION(setrawcookie); PHP_FUNCTION(headers_sent); diff --git a/main/SAPI.c b/main/SAPI.c index feabcef549..3adb76541e 100644 --- a/main/SAPI.c +++ b/main/SAPI.c @@ -497,7 +497,8 @@ static void sapi_update_response_code(int ncode TSRMLS_DC) static int sapi_find_matching_header(void *element1, void *element2) { - return strncasecmp(((sapi_header_struct*)element1)->header, (char*)element2, strlen((char*)element2)) == 0; + int len = strlen((char*)element2); + return strncasecmp(((sapi_header_struct*)element1)->header, (char*)element2, len) == 0 && ((sapi_header_struct*)element1)->header[len] == ':'; } SAPI_API int sapi_add_header_ex(char *header_line, uint header_line_len, zend_bool duplicate, zend_bool replace TSRMLS_DC) @@ -525,7 +526,6 @@ SAPI_API int sapi_header_op(sapi_header_op_enum op, void *arg TSRMLS_DC) long myuid = 0L; char *header_line; uint header_line_len; - zend_bool replace; int http_response_code; if (SG(headers_sent) && !SG(request_info).no_headers) { @@ -546,8 +546,9 @@ SAPI_API int sapi_header_op(sapi_header_op_enum op, void *arg TSRMLS_DC) sapi_update_response_code((int)(zend_intptr_t) arg TSRMLS_CC); return SUCCESS; + case SAPI_HEADER_ADD: case SAPI_HEADER_REPLACE: - case SAPI_HEADER_ADD: { + case SAPI_HEADER_DELETE: { sapi_header_line *p = arg; if (!p->line || !p->line_len) { @@ -556,10 +557,16 @@ SAPI_API int sapi_header_op(sapi_header_op_enum op, void *arg TSRMLS_DC) header_line = p->line; header_line_len = p->line_len; http_response_code = p->response_code; - replace = (op == SAPI_HEADER_REPLACE); break; } + case SAPI_HEADER_DELETE_ALL: + if (sapi_module.header_handler) { + sapi_module.header_handler(&sapi_header, op, &SG(sapi_headers) TSRMLS_CC); + } + zend_llist_clean(&SG(sapi_headers).headers); + return SUCCESS; + default: return FAILURE; } @@ -570,8 +577,14 @@ SAPI_API int sapi_header_op(sapi_header_op_enum op, void *arg TSRMLS_DC) while(header_line_len && isspace(header_line[header_line_len-1])) header_line[--header_line_len]='\0'; - /* new line safety check */ - { + if (op == SAPI_HEADER_DELETE) { + if (strchr(header_line, ':')) { + efree(header_line); + sapi_module.sapi_error(E_WARNING, "Header to delete may not contain colon."); + return FAILURE; + } + } else { + /* new line safety check */ char *s = header_line, *e = header_line + header_line_len, *p; while (s < e && (p = memchr(s, '\n', (e - s)))) { if (*(p + 1) == ' ' || *(p + 1) == '\t') { @@ -586,7 +599,15 @@ SAPI_API int sapi_header_op(sapi_header_op_enum op, void *arg TSRMLS_DC) sapi_header.header = header_line; sapi_header.header_len = header_line_len; - sapi_header.replace = replace; + + if (op == SAPI_HEADER_DELETE) { + if (sapi_module.header_handler) { + sapi_module.header_handler(&sapi_header, op, &SG(sapi_headers) TSRMLS_CC); + } + zend_llist_del_element(&SG(sapi_headers).headers, sapi_header.header, (int(*)(void*, void*))sapi_find_matching_header); + sapi_free_header(&sapi_header); + return SUCCESS; + } /* Check the header for a few cases that we have special support for in SAPI */ if (header_line_len>=5 @@ -728,20 +749,16 @@ SAPI_API int sapi_header_op(sapi_header_op_enum op, void *arg TSRMLS_DC) sapi_update_response_code(http_response_code TSRMLS_CC); } if (sapi_module.header_handler) { - retval = sapi_module.header_handler(&sapi_header, &SG(sapi_headers) TSRMLS_CC); + retval = sapi_module.header_handler(&sapi_header, op, &SG(sapi_headers) TSRMLS_CC); } else { retval = SAPI_HEADER_ADD; } - if (retval & SAPI_HEADER_DELETE_ALL) { - zend_llist_clean(&SG(sapi_headers).headers); - } if (retval & SAPI_HEADER_ADD) { /* in replace mode first remove the header if it already exists in the headers llist */ - if (replace) { + if (op == SAPI_HEADER_REPLACE) { colon_offset = strchr(sapi_header.header, ':'); if (colon_offset) { char sav; - colon_offset++; sav = *colon_offset; *colon_offset = 0; zend_llist_del_element(&SG(sapi_headers).headers, sapi_header.header, (int(*)(void*, void*))sapi_find_matching_header); @@ -750,6 +767,8 @@ SAPI_API int sapi_header_op(sapi_header_op_enum op, void *arg TSRMLS_DC) } zend_llist_add_element(&SG(sapi_headers).headers, (void *) &sapi_header); + } else { + sapi_free_header(&sapi_header); } return SUCCESS; } diff --git a/main/SAPI.h b/main/SAPI.h index d4a558e3e7..1a2adbf10c 100644 --- a/main/SAPI.h +++ b/main/SAPI.h @@ -50,7 +50,6 @@ typedef struct { char *header; uint header_len; - zend_bool replace; } sapi_header_struct; @@ -170,6 +169,8 @@ typedef struct { typedef enum { /* Parameter: */ SAPI_HEADER_REPLACE, /* sapi_header_line* */ SAPI_HEADER_ADD, /* sapi_header_line* */ + SAPI_HEADER_DELETE, /* sapi_header_line* */ + SAPI_HEADER_DELETE_ALL, /* void */ SAPI_HEADER_SET_STATUS /* int */ } sapi_header_op_enum; @@ -227,7 +228,7 @@ struct _sapi_module_struct { void (*sapi_error)(int type, const char *error_msg, ...); - int (*header_handler)(sapi_header_struct *sapi_header, sapi_headers_struct *sapi_headers TSRMLS_DC); + int (*header_handler)(sapi_header_struct *sapi_header, sapi_header_op_enum op, sapi_headers_struct *sapi_headers TSRMLS_DC); int (*send_headers)(sapi_headers_struct *sapi_headers TSRMLS_DC); void (*send_header)(sapi_header_struct *sapi_header, void *server_context TSRMLS_DC); @@ -275,8 +276,6 @@ struct _sapi_post_entry { /* header_handler() constants */ #define SAPI_HEADER_ADD (1<<0) -#define SAPI_HEADER_DELETE_ALL (1<<1) -#define SAPI_HEADER_SEND_NOW (1<<2) #define SAPI_HEADER_SENT_SUCCESSFULLY 1 diff --git a/sapi/apache/mod_php5.c b/sapi/apache/mod_php5.c index a5afb77be4..3acf8a58f5 100644 --- a/sapi/apache/mod_php5.c +++ b/sapi/apache/mod_php5.c @@ -35,7 +35,7 @@ static void php_save_umask(void); static void php_restore_umask(void); static int sapi_apache_read_post(char *buffer, uint count_bytes TSRMLS_DC); static char *sapi_apache_read_cookies(TSRMLS_D); -static int sapi_apache_header_handler(sapi_header_struct *sapi_header, sapi_headers_struct *sapi_headers TSRMLS_DC); +static int sapi_apache_header_handler(sapi_header_struct *sapi_header, sapi_header_op_enum op, sapi_headers_struct *sapi_headers TSRMLS_DC); static int sapi_apache_send_headers(sapi_headers_struct *sapi_headers TSRMLS_DC); static int send_php(request_rec *r, int display_source_mode, char *filename); static int send_parsed_php(request_rec * r); @@ -163,41 +163,54 @@ static char *sapi_apache_read_cookies(TSRMLS_D) /* {{{ sapi_apache_header_handler */ -static int sapi_apache_header_handler(sapi_header_struct *sapi_header, sapi_headers_struct *sapi_headers TSRMLS_DC) +static int sapi_apache_header_handler(sapi_header_struct *sapi_header, sapi_header_op_enum op, sapi_headers_struct *sapi_headers TSRMLS_DC) { char *header_name, *header_content, *p; request_rec *r = (request_rec *) SG(server_context); if(!r) { - efree(sapi_header->header); return 0; } - header_name = sapi_header->header; + switch(op) { + case SAPI_HEADER_DELETE_ALL: + clear_table(r->headers_out); + return 0; - header_content = p = strchr(header_name, ':'); - if (!p) { - efree(sapi_header->header); - return 0; - } + case SAPI_HEADER_DELETE: + table_unset(r->headers_out, sapi_header->header); + return 0; - *p = 0; - do { - header_content++; - } while (*header_content==' '); - - if (!strcasecmp(header_name, "Content-Type")) { - r->content_type = pstrdup(r->pool, header_content); - } else if (!strcasecmp(header_name, "Set-Cookie")) { - table_add(r->headers_out, header_name, header_content); - } else if (sapi_header->replace) { - table_set(r->headers_out, header_name, header_content); - } else { - table_add(r->headers_out, header_name, header_content); - } + case SAPI_HEADER_ADD: + case SAPI_HEADER_REPLACE: + header_name = sapi_header->header; + + header_content = p = strchr(header_name, ':'); + if (!p) { + return 0; + } + + *p = 0; + do { + header_content++; + } while (*header_content==' '); + + if (!strcasecmp(header_name, "Content-Type")) { + r->content_type = pstrdup(r->pool, header_content); + } else if (!strcasecmp(header_name, "Set-Cookie")) { + table_add(r->headers_out, header_name, header_content); + } else if (op == SAPI_HEADER_REPLACE) { + table_set(r->headers_out, header_name, header_content); + } else { + table_add(r->headers_out, header_name, header_content); + } - *p = ':'; /* a well behaved header handler shouldn't change its original arguments */ + *p = ':'; /* a well behaved header handler shouldn't change its original arguments */ - return SAPI_HEADER_ADD; + return SAPI_HEADER_ADD; + + default: + return 0; + } } /* }}} */ diff --git a/sapi/apache2handler/sapi_apache2.c b/sapi/apache2handler/sapi_apache2.c index b8671c59d4..cf2e1427be 100644 --- a/sapi/apache2handler/sapi_apache2.c +++ b/sapi/apache2handler/sapi_apache2.c @@ -83,40 +83,55 @@ php_apache_sapi_ub_write(const char *str, uint str_length TSRMLS_DC) } static int -php_apache_sapi_header_handler(sapi_header_struct *sapi_header,sapi_headers_struct *sapi_headers TSRMLS_DC) +php_apache_sapi_header_handler(sapi_header_struct *sapi_header, sapi_header_op_enum op, sapi_headers_struct *sapi_headers TSRMLS_DC) { php_struct *ctx; char *val, *ptr; ctx = SG(server_context); - val = strchr(sapi_header->header, ':'); + switch (op) { + case SAPI_HEADER_DELETE: + apr_table_unset(ctx->r->headers_out, sapi_header->header); + return 0; - if (!val) { - sapi_free_header(sapi_header); - return 0; - } - ptr = val; + case SAPI_HEADER_DELETE_ALL: + apr_table_clear(ctx->r->headers_out); + return 0; + + case SAPI_HEADER_ADD: + case SAPI_HEADER_REPLACE: + val = strchr(sapi_header->header, ':'); - *val = '\0'; + if (!val) { + return 0; + } + ptr = val; + + *val = '\0'; - do { - val++; - } while (*val == ' '); + do { + val++; + } while (*val == ' '); + + if (!strcasecmp(sapi_header->header, "content-type")) { + if (ctx->content_type) { + efree(ctx->content_type); + } + ctx->content_type = estrdup(val); + } else if (op == SAPI_HEADER_REPLACE) { + apr_table_set(ctx->r->headers_out, sapi_header->header, val); + } else { + apr_table_add(ctx->r->headers_out, sapi_header->header, val); + } - if (!strcasecmp(sapi_header->header, "content-type")) { - if (ctx->content_type) { - efree(ctx->content_type); - } - ctx->content_type = estrdup(val); - } else if (sapi_header->replace) { - apr_table_set(ctx->r->headers_out, sapi_header->header, val); - } else { - apr_table_add(ctx->r->headers_out, sapi_header->header, val); + *ptr = ':'; + + return SAPI_HEADER_ADD; + + default: + return 0; } - *ptr = ':'; - - return SAPI_HEADER_ADD; } static int diff --git a/sapi/cgi/tests/011.phpt b/sapi/cgi/tests/011.phpt new file mode 100644 index 0000000000..177df021a6 --- /dev/null +++ b/sapi/cgi/tests/011.phpt @@ -0,0 +1,165 @@ +--TEST-- +header_remove() +--SKIPIF-- + +--FILE-- +'); +test(''); +test(''); +test(''); +test(''); +test(''); +test(''); +test(''); +test(''); +test(''); +test(''); + +@unlink($f); +?> +--EXPECTF-- +---------- + +---------- +X-Powered-By: PHP/%s +Content-type: text/html + +---------- + +---------- +Content-type: text/html + +---------- + +---------- +X-Powered-By: PHP/%s +Content-type: text/html + +---------- + +---------- +X-Powered-By: PHP/%s +X-Foo: Bar +Content-type: text/html + +---------- + +---------- +X-Powered-By: PHP/%s +X-Bar: Baz +Content-type: text/html + +---------- + +---------- +X-Powered-By: PHP/%s +X-Foo: Bar +Content-type: text/html + + +Warning: Header to delete may not contain colon. in %s on line 3 +---------- + +---------- +X-Powered-By: PHP/%s +X-Foo: Bar +Content-type: text/html + + +Warning: Header to delete may not contain colon. in %s on line 3 +---------- + +---------- +Content-type: text/html + +---------- + +---------- +X-Powered-By: PHP/%s +Content-type: text/html + +---------- + +---------- +X-Powered-By: PHP/%s +Content-type: text/html + + +Warning: Header to delete may not contain colon. in %s on line 2 +---------- + +---------- +X-Powered-By: PHP/%s +X-Foo: Bar +Content-type: text/html + +flush + +Warning: Cannot modify header information - headers already sent by (output started at %s:3) in %s on line 5 diff --git a/sapi/cli/php_cli.c b/sapi/cli/php_cli.c index 66e206df62..4b9d112ed7 100644 --- a/sapi/cli/php_cli.c +++ b/sapi/cli/php_cli.c @@ -347,11 +347,8 @@ static char* sapi_cli_read_cookies(TSRMLS_D) /* {{{ */ } /* }}} */ -static int sapi_cli_header_handler(sapi_header_struct *h, sapi_headers_struct *s TSRMLS_DC) /* {{{ */ +static int sapi_cli_header_handler(sapi_header_struct *h, sapi_header_op_enum op, sapi_headers_struct *s TSRMLS_DC) /* {{{ */ { - /* free allocated header line */ - efree(h->header); - /* avoid pushing headers into SAPI headers list */ return 0; } /* }}} */