Skip to content

Implement GH-19249: http context - allow content to be a stream/resource #19267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Implement GH-19249: http context - allow content to be a stream/resource #19267

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
88cf76e
Implement GH-19249: http context - allow content to be a stream/resource
nielsdos Jul 27, 2025
ddacfb2
Make error less confusing
nielsdos Jul 27, 2025
f3d56e7
Handle non-seekable streams
nielsdos Jul 27, 2025
55ca377
Windows
nielsdos Jul 27, 2025
4300417
fix
nielsdos Jul 27, 2025
45582d7
attempt 2 to make both Linux and Windows happy
nielsdos Jul 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions UPGRADING
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ PHP 8.5 UPGRADE NOTES
and the function returns false. Previously, these errors were silently
ignored. This change affects only the sendmail transport.
. getimagesize() now supports HEIF/HEIC images.
. The "http" stream context's "content" field now supports streams.

- Standard:
. getimagesize() now supports SVG images when ext-libxml is also loaded.
Expand Down
97 changes: 83 additions & 14 deletions ext/standard/http_fopen_wrapper.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,43 @@ static zend_string *php_stream_http_response_headers_parse(php_stream_wrapper *w
return NULL;
}

static bool php_stream_unwrap_content(php_stream_context *context, zend_string **str_out, php_stream **stream_out)
{
zval *content = php_stream_context_get_option(context, "http", "content");
if (content) {
if (Z_TYPE_P(content) == IS_STRING && Z_STRLEN_P(content) > 0) {
*str_out = Z_STR_P(content);
return true;
} else if (Z_TYPE_P(content) == IS_RESOURCE) {
if ((php_stream_from_zval_no_verify(*stream_out, content))) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if ((php_stream_from_zval_no_verify(*stream_out, content))) {
if (php_stream_from_zval_no_verify(*stream_out, content)) {

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this is used to silence a compiler warning because php_stream_from_zval_no_verify expands to an assignment

return true;
}
}
}

return false;
}

static bool php_stream_append_content_length(smart_str *req_buf, zend_string *content_str, php_stream *content_stream)
{
smart_str_appends(req_buf, "Content-Length: ");
if (content_str) {
smart_str_append_unsigned(req_buf, ZSTR_LEN(content_str));
} else {
zend_off_t current_position = php_stream_tell(content_stream);
if (php_stream_seek(content_stream, 0, SEEK_END) < 0) {
return false;
}
zend_off_t end_position = php_stream_tell(content_stream);
if (php_stream_seek(content_stream, current_position, SEEK_SET) < 0) {
return false;
}
smart_str_append_unsigned(req_buf, end_position - current_position);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about the non seekable streams?

I'm thinking that it might be better to use chunked encoding for such cases

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively you will need to fetch them to memory so it won't give much memory saving in this case but I guess files are bigger use case for this so it's probably better than nothing (considering that addition of chunked encoding support might be quite involved).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll go with the "read to memory" solution as I believe that non-seekable streams are pretty rare in this context.

}
smart_str_appends(req_buf, "\r\n");
return true;
}

static php_stream *php_stream_url_wrap_http_ex(php_stream_wrapper *wrapper,
const char *path, const char *mode, int options, zend_string **opened_path,
php_stream_context *context, int redirect_max, int flags,
Expand Down Expand Up @@ -832,6 +869,9 @@ static php_stream *php_stream_url_wrap_http_ex(php_stream_wrapper *wrapper,
}
}

zend_string *content_str = NULL;
php_stream *content_stream = NULL;

if (user_headers) {
/* A bit weird, but some servers require that Content-Length be sent prior to Content-Type for POST
* see bug #44603 for details. Since Content-Type maybe part of user's headers we need to do this check first.
Expand All @@ -840,42 +880,71 @@ static php_stream *php_stream_url_wrap_http_ex(php_stream_wrapper *wrapper,
(header_init || redirect_keep_method) &&
context &&
!(have_header & HTTP_HEADER_CONTENT_LENGTH) &&
(tmpzval = php_stream_context_get_option(context, "http", "content")) != NULL &&
Z_TYPE_P(tmpzval) == IS_STRING && Z_STRLEN_P(tmpzval) > 0
php_stream_unwrap_content(context, &content_str, &content_stream)
) {
smart_str_appends(&req_buf, "Content-Length: ");
smart_str_append_unsigned(&req_buf, Z_STRLEN_P(tmpzval));
smart_str_appends(&req_buf, "\r\n");
if (!php_stream_append_content_length(&req_buf, content_str, content_stream)) {
php_stream_close(stream);
stream = NULL;
efree(user_headers);
php_stream_wrapper_log_error(wrapper, options, "Unable to determine length of \"content\" stream!");
goto out;
}
have_header |= HTTP_HEADER_CONTENT_LENGTH;
}

smart_str_appends(&req_buf, user_headers);
smart_str_appends(&req_buf, "\r\n");
efree(user_headers);

/* php_stream_unwrap_content() may throw a TypeError for non-stream resources */
if (UNEXPECTED(EG(exception))) {
php_stream_close(stream);
stream = NULL;
goto out;
}
}

/* Request content, such as for POST requests */
if ((header_init || redirect_keep_method) && context &&
(tmpzval = php_stream_context_get_option(context, "http", "content")) != NULL &&
Z_TYPE_P(tmpzval) == IS_STRING && Z_STRLEN_P(tmpzval) > 0) {
(content_str || content_stream || php_stream_unwrap_content(context, &content_str, &content_stream))) {
if (!(have_header & HTTP_HEADER_CONTENT_LENGTH)) {
smart_str_appends(&req_buf, "Content-Length: ");
smart_str_append_unsigned(&req_buf, Z_STRLEN_P(tmpzval));
smart_str_appends(&req_buf, "\r\n");
if (!php_stream_append_content_length(&req_buf, content_str, content_stream)) {
php_stream_close(stream);
stream = NULL;
php_stream_wrapper_log_error(wrapper, options, "Unable to determine length of \"content\" stream!");
goto out;
}
}
if (!(have_header & HTTP_HEADER_TYPE)) {
smart_str_appends(&req_buf, "Content-Type: application/x-www-form-urlencoded\r\n");
php_error_docref(NULL, E_NOTICE, "Content-type not specified assuming application/x-www-form-urlencoded");
}
smart_str_appends(&req_buf, "\r\n");
smart_str_appendl(&req_buf, Z_STRVAL_P(tmpzval), Z_STRLEN_P(tmpzval));
if (content_str) {
smart_str_append(&req_buf, content_str);
php_stream_write(stream, ZSTR_VAL(req_buf.s), ZSTR_LEN(req_buf.s));
} else {
php_stream_write(stream, ZSTR_VAL(req_buf.s), ZSTR_LEN(req_buf.s));

if (SUCCESS != php_stream_copy_to_stream_ex(content_stream, stream, PHP_STREAM_COPY_ALL, NULL)) {
php_stream_close(stream);
stream = NULL;
php_stream_wrapper_log_error(wrapper, options, "Unable to copy \"content\" stream!");
goto out;
}
}
} else {
/* php_stream_unwrap_content() may throw a TypeError for non-stream resources */
if (UNEXPECTED(EG(exception))) {
php_stream_close(stream);
stream = NULL;
goto out;
}

smart_str_appends(&req_buf, "\r\n");
php_stream_write(stream, ZSTR_VAL(req_buf.s), ZSTR_LEN(req_buf.s));
}

/* send it */
php_stream_write(stream, ZSTR_VAL(req_buf.s), ZSTR_LEN(req_buf.s));

if (Z_ISUNDEF_P(response_header)) {
array_init(response_header);
}
Expand Down
46 changes: 46 additions & 0 deletions ext/standard/tests/http/gh19249_custom_stream.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
--TEST--
GH-19249 (http context - allow content to be a stream/resource) - custom stream
--INI--
allow_url_fopen=1
--CONFLICTS--
server
--FILE--
<?php
class MyStream {
public $context;

public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool {
return true;
}

public function stream_read(int $count): string|false {
return false;
}
}

stream_wrapper_register("custom", MyStream::class);

$serverCode = <<<'CODE'
var_dump(getallheaders()['Content-Length']);
echo file_get_contents('php://input');
CODE;

include __DIR__."/../../../../sapi/cli/tests/php_cli_server.inc";
php_cli_server_start($serverCode, null, []);

$postData = fopen("custom://", "r");

echo file_get_contents("http://" . PHP_CLI_SERVER_ADDRESS . "/", false, stream_context_create([
'http' => [
'method' => 'POST',
'header' => [
'Content-type: application/x-www-form-urlencoded',
],
'content' => $postData,
]
]));
?>
--EXPECTF--
Warning: file_get_contents(): Stream does not support seeking in %s on line %d

Warning: file_get_contents(%s): Failed to open stream: Unable to determine length of "content" stream! in %s on line %d
34 changes: 34 additions & 0 deletions ext/standard/tests/http/gh19249_memory_stream.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
--TEST--
GH-19249 (http context - allow content to be a stream/resource) - memory stream
--INI--
allow_url_fopen=1
--CONFLICTS--
server
--FILE--
<?php
$serverCode = <<<'CODE'
var_dump(getallheaders()['Content-Length']);
echo file_get_contents('php://input');
CODE;

include __DIR__."/../../../../sapi/cli/tests/php_cli_server.inc";
php_cli_server_start($serverCode, null, []);

$postData = fopen("php://memory", "w+");
fwrite($postData, "a=b&c=d");
// Test skip
fseek($postData, 4);

echo file_get_contents("http://" . PHP_CLI_SERVER_ADDRESS . "/", false, stream_context_create([
'http' => [
'method' => 'POST',
'header' => [
'Content-type: application/x-www-form-urlencoded',
],
'content' => $postData,
]
]));
?>
--EXPECT--
string(1) "3"
c=d
41 changes: 41 additions & 0 deletions ext/standard/tests/http/gh19249_no_stream.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
--TEST--
GH-19249 (http context - allow content to be a stream/resource) - no stream
--INI--
allow_url_fopen=1
--CONFLICTS--
server
--FILE--
<?php
$serverCode = '';

include __DIR__."/../../../../sapi/cli/tests/php_cli_server.inc";
php_cli_server_start($serverCode, null, []);

$postData = proc_open("echo", [], $pipes);

$headers = [
[],
'header' => [
'Content-type: application/x-www-form-urlencoded',
],
];

foreach ($headers as $header) {
try {
file_get_contents("http://" . PHP_CLI_SERVER_ADDRESS . "/", false, stream_context_create([
'http' => [
'method' => 'POST',
...$header,
'content' => $postData,
]
]));
} catch (TypeError $e) {
echo $e->getMessage(), "\n";
}
}

proc_close($postData);
?>
--EXPECT--
file_get_contents(): supplied resource is not a valid stream resource
file_get_contents(): supplied resource is not a valid stream resource
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a confusing error message, as it is in the stream context the problem occurs really, not in the file_get_contents

Loading