Skip to content
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.

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

Implement stream_vt100_support user function #2103

Closed
wants to merge 41 commits into from
Closed
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
a0e0d8d
Add VT100 support for Windows
mlocati Aug 29, 2016
18c5c42
Fix function names prefix
mlocati Aug 30, 2016
be50062
Use Unicode version of GetFinalPathNameByHandle
mlocati Aug 30, 2016
e11f3d2
Use EG(windows_version_info) instead of RtlGetVersion
mlocati Aug 30, 2016
6953d2f
Use the specified handle_id instead of STD_OUTPUT_HANDLE
mlocati Aug 30, 2016
bd93781
Switch from stream name to stream resource
mlocati Aug 30, 2016
35bf19a
Allow running tests capturing only stdout and/or stderr
mlocati Aug 30, 2016
d9b1c99
Add tests for stream_vt100_support function
mlocati Aug 30, 2016
2f05643
Export Win32 console functions
mlocati Oct 4, 2016
694e207
Fix x64 build
mlocati Oct 4, 2016
4f4ffd0
Use zend_long instead of long long, use GetConsole instead of GetFina…
mlocati Oct 4, 2016
3fcdc64
Always use zend_long on any platform
mlocati Oct 4, 2016
99bd01e
Use _get_osfhandle to determine the standard handle
mlocati Oct 5, 2016
7b155f4
Accept stream names
mlocati Oct 5, 2016
08e75a2
Raise warnings in case of invalid stream parameter
mlocati Oct 5, 2016
c10467e
Return true if disabling VT100 support on a not-console/redirected st…
mlocati Oct 6, 2016
dd85825
Remove php_win32_console_os_supports_vt100
mlocati Oct 6, 2016
a6e88f6
Differentiate stdin vs stdout/stderr
mlocati Oct 6, 2016
1643715
Simplify setting flag
mlocati Oct 6, 2016
f86567e
Allow avoid piping STDIN
mlocati Oct 6, 2016
658ff84
Let stream_vt100_support accept only resources
mlocati Oct 6, 2016
d9e0531
Fix run-tests
mlocati Oct 6, 2016
157f8e8
Revert console flags in case of failure
mlocati Oct 6, 2016
76411a4
Simplify logic of stream_vt100_support when setting the flag
mlocati Oct 7, 2016
4d956f2
Drop support for STDIN
mlocati Oct 7, 2016
7d348a0
More comprehensive tests for stream_vt100_support
mlocati Oct 7, 2016
4588b50
Remove old tests
mlocati Oct 8, 2016
bf60a78
Fix name of included file and use absolute paths
mlocati Oct 8, 2016
5d2ecf9
Enable ENABLE_VIRTUAL_TERMINAL_PROCESSING on Windows by default
mlocati Oct 8, 2016
7581767
Remove tests for stream_vt100_support
mlocati Oct 9, 2016
d15063c
Split stream_vt100_support into stream_isatty+sapi_windows_vt100_support
mlocati Oct 9, 2016
65ad779
Add tests for stream_isatty
mlocati Oct 9, 2016
67e1eb7
Add tests for sapi_windows_vt100_support
mlocati Oct 9, 2016
f9ff470
Return null from stream_isatty is neither Windows nor Posix
mlocati Oct 14, 2016
6df8c3c
Fallback to S_ISCHR if neither Windows nor Posix
mlocati Oct 14, 2016
1081aa8
Avoid defining argc since it's only used once
mlocati Oct 17, 2016
e4aaa27
Better comment about php_win32_console_fileno_is_console
mlocati Oct 17, 2016
2d062f3
Use events instead of cNumberOfEvents
mlocati Oct 17, 2016
d70a7f2
Do not restore previous console mode
mlocati Oct 17, 2016
c2988ea
Merge master into vt100-windows
mlocati Oct 17, 2016
d1772e6
Don't configure STDOUT/STDERR on Windows with PHP_CLI_WIN32_NO_CONSOLE
mlocati Oct 17, 2016
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
6 changes: 6 additions & 0 deletions ext/standard/basic_functions.c
Original file line number Diff line number Diff line change
Expand Up @@ -2011,6 +2011,11 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_stream_supports_lock, 0, 0, 1)
ZEND_ARG_INFO(0, stream)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_stream_vt100_support, 0, 0, 1)
ZEND_ARG_INFO(0, stream)
ZEND_ARG_INFO(0, enable)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_stream_select, 0, 0, 4)
ZEND_ARG_INFO(1, read_streams) /* ARRAY_INFO(1, read_streams, 1) */
ZEND_ARG_INFO(1, write_streams) /* ARRAY_INFO(1, write_streams, 1) */
Expand Down Expand Up @@ -3134,6 +3139,7 @@ const zend_function_entry basic_functions[] = { /* {{{ */
PHP_FE(stream_copy_to_stream, arginfo_stream_copy_to_stream)
PHP_FE(stream_get_contents, arginfo_stream_get_contents)
PHP_FE(stream_supports_lock, arginfo_stream_supports_lock)
PHP_FE(stream_vt100_support, arginfo_stream_vt100_support)
PHP_FE(fgetcsv, arginfo_fgetcsv)
PHP_FE(fputcsv, arginfo_fputcsv)
PHP_FE(flock, arginfo_flock)
Expand Down
122 changes: 122 additions & 0 deletions ext/standard/streamsfuncs.c
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ typedef unsigned long long php_timeout_ull;
#else
#include "win32/select.h"
#include "win32/sockets.h"
#include "win32/console.h"
typedef unsigned __int64 php_timeout_ull;
#endif

Expand Down Expand Up @@ -1635,6 +1636,127 @@ PHP_FUNCTION(stream_supports_lock)
RETURN_TRUE;
}

/* {{{ proto proto stream_vt100_support(resource stream[, bool enable])
Get or set VT100 support for the specified stream.
*/
PHP_FUNCTION(stream_vt100_support)
{
zval *z_stream;
php_stream *stream;
int fileno;
zend_bool enable;
#ifdef PHP_WIN32
DWORD handle_id;
#endif
int argc = ZEND_NUM_ARGS();
Copy link
Contributor

Choose a reason for hiding this comment

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

You only use this in the call to zend_parse_parameters now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍 1081aa8


if (zend_parse_parameters(argc, "z|b", &z_stream, &enable) == FAILURE) {
return;
}
stream = NULL;
switch (Z_TYPE_P(z_stream)) {
case IS_RESOURCE:
php_stream_from_zval_no_verify(stream, z_stream);
break;
}
if (stream == NULL) {
RETURN_FALSE;
}
if (php_stream_can_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT) == SUCCESS) {
php_stream_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT, (void*)&fileno, 0);
Copy link
Contributor

Choose a reason for hiding this comment

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

The void* cast will cause the stack corruption on 64-bit.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The void* cast will cause the stack corruption on 64-bit.

Fixed in 694e207

} else if (php_stream_can_cast(stream, PHP_STREAM_AS_FD) == SUCCESS) {
php_stream_cast(stream, PHP_STREAM_AS_FD, (void*)&fileno, 0);
} else {
RETURN_FALSE;
}
switch (fileno) {
case STDOUT_FILENO:
#ifdef PHP_WIN32
handle_id = STD_OUTPUT_HANDLE;
#endif
break;
case STDERR_FILENO:
#ifdef PHP_WIN32
handle_id = STD_ERROR_HANDLE;
#endif
break;
default:
RETURN_FALSE;
}


if (argc == 1) {
/* Check if the specified stream supports VT100 control codes */
#ifdef PHP_WIN32
/* Check if the current Windows version supports VT100 control codes */
if (!php_win32_console_os_supports_vt100()) {
RETURN_FALSE;
}
/* Check if the Windows standard handle is redirected to file */
if (php_win32_console_handle_is_redirected(handle_id)) {
RETURN_FALSE;
}
/* Check if the Windows standard handle has VT100 control codes enabled */
if (php_win32_console_handle_has_vt100(handle_id)) {
RETURN_TRUE;
}
else {
RETURN_FALSE;
}
#elif HAVE_POSIX
/* Check if the file descriptor identifier is a terminal */
if (isatty(fileno)) {
RETURN_TRUE;
}
else {
RETURN_FALSE;
}
#else
RETURN_FALSE;
#endif
}
else {
/* Enable/disable VT100 control codes support for the specified stream */
#ifdef PHP_WIN32
/* Check if the current Windows version supports VT100 control codes */
if (!php_win32_console_os_supports_vt100()) {
RETURN_FALSE;
}
/* Check if the Windows standard handle is redirected to file */
if (php_win32_console_handle_is_redirected(handle_id)) {
RETURN_FALSE;
}
/* Enable/disable VT100 control codes support for the specified Windows standard handle */
if (php_win32_console_handle_set_vt100(handle_id, enable ? TRUE : FALSE)) {
RETURN_TRUE;
}
else {
RETURN_FALSE;
}
#elif HAVE_POSIX
/* Check if the file descriptor identifier is a terminal */
if (isatty(fileno)) {
if (enable) {
RETURN_TRUE;
}
else {
RETURN_FALSE;
}
}
else {
if (enable) {
RETURN_FALSE;
}
else {
RETURN_TRUE;
}
}
#else
RETURN_FALSE;
#endif
}
}

#ifdef HAVE_SHUTDOWN
/* {{{ proto int stream_socket_shutdown(resource stream, int how)
causes all or part of a full-duplex connection on the socket associated
Expand Down
1 change: 1 addition & 0 deletions ext/standard/streamsfuncs.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ PHP_FUNCTION(stream_socket_shutdown);
PHP_FUNCTION(stream_resolve_include_path);
PHP_FUNCTION(stream_is_local);
PHP_FUNCTION(stream_supports_lock);
PHP_FUNCTION(stream_vt100_support);

#if HAVE_SOCKETPAIR
PHP_FUNCTION(stream_socket_pair);
Expand Down
50 changes: 37 additions & 13 deletions run-tests.php
Original file line number Diff line number Diff line change
Expand Up @@ -1062,7 +1062,7 @@ function error_report($testname, $logname, $tested)
}
}

function system_with_timeout($commandline, $env = null, $stdin = null)
function system_with_timeout($commandline, $env = null, $stdin = null, $captureStdOut = true, $captureStdErr = true)
Copy link
Contributor

@weltling weltling Sep 19, 2016

Choose a reason for hiding this comment

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

It's a nice approach, but i'd rather avoid adding the new section to run-tests.php. It is not a general case and probably only useful for this concrete case, so IMO a new section is not justified.

What could be done instead, were doing an extra PHP run inside the test. Fe we do this for the CLI server, you can cehck sapi/cli/tests/php_cli_server.inc for a simple example framework. It is also better to be close to the real word, when testing redirection. Like

php.exe -r "if (stream_vt100_support(STDOUT, true)) echo \"\033[101;93msupported\033[0m\n\"; else echo 'not supported'; " > tmp

should should out "not supported" into a file on both linux and windows. Or i don't get this part right?

Thanks.

{
global $leak_check, $cwd;

Expand All @@ -1073,11 +1073,16 @@ function system_with_timeout($commandline, $env = null, $stdin = null)
$bin_env[$key] = $value;
}

$proc = proc_open($commandline, array(
$descriptorspec = array(
0 => array('pipe', 'r'),
1 => array('pipe', 'w'),
2 => array('pipe', 'w')
), $pipes, $cwd, $bin_env, array('suppress_errors' => true, 'binary_pipes' => true));
);
if ($captureStdOut) {
$descriptorspec[1] = array('pipe', 'w');
}
if ($captureStdErr) {
$descriptorspec[2] = array('pipe', 'w');
}
$proc = proc_open($commandline, $descriptorspec, $pipes, $cwd, $bin_env, array('suppress_errors' => true, 'binary_pipes' => true));

if (!$proc) {
return false;
Expand Down Expand Up @@ -1107,7 +1112,13 @@ function system_with_timeout($commandline, $env = null, $stdin = null)
proc_terminate($proc, 9);
return $data;
} else if ($n > 0) {
$line = fread($pipes[1], 8192);
if ($captureStdOut) {
$line = fread($pipes[1], 8192);
} elseif ($captureStdErr) {
$line = fread($pipes[2], 8192);
} else {
$line = '';
}
if (strlen($line) == 0) {
/* EOF */
break;
Expand Down Expand Up @@ -1338,6 +1349,19 @@ function run_test($php, $file, $env)
return 'BORKED';
}

if (isset($section_text['CAPTURE_STDIO'])) {
$captureStdOut = stripos($section_text['CAPTURE_STDIO'], 'STDOUT') !== false;
$captureStdErr = stripos($section_text['CAPTURE_STDIO'], 'STDERR') !== false;
} else {
$captureStdOut = true;
$captureStdErr = true;
}
if ($captureStdOut && $captureStdErr) {
$cmdRedirect = ' 2>&1';
} else {
$cmdRedirect = '';
}

$tested = trim($section_text['TEST']);

/* For GET/POST/PUT tests, check if cgi sapi is available and if it is, use it. */
Expand Down Expand Up @@ -1750,7 +1774,7 @@ function run_test($php, $file, $env)
}

save_text($tmp_post, $request);
$cmd = "$php $pass_options $ini_settings -f \"$test_file\" 2>&1 < \"$tmp_post\"";
$cmd = "$php $pass_options $ini_settings -f \"$test_file\"$cmdRedirect < \"$tmp_post\"";

} elseif (array_key_exists('PUT', $section_text) && !empty($section_text['PUT'])) {

Expand Down Expand Up @@ -1784,7 +1808,7 @@ function run_test($php, $file, $env)
}

save_text($tmp_post, $request);
$cmd = "$php $pass_options $ini_settings -f \"$test_file\" 2>&1 < \"$tmp_post\"";
$cmd = "$php $pass_options $ini_settings -f \"$test_file\"$cmdRedirect < \"$tmp_post\"";

} else if (array_key_exists('POST', $section_text) && !empty($section_text['POST'])) {

Expand All @@ -1801,7 +1825,7 @@ function run_test($php, $file, $env)
$env['CONTENT_LENGTH'] = $content_length;
}

$cmd = "$php $pass_options $ini_settings -f \"$test_file\" 2>&1 < \"$tmp_post\"";
$cmd = "$php $pass_options $ini_settings -f \"$test_file\"$cmdRedirect < \"$tmp_post\"";

} else if (array_key_exists('GZIP_POST', $section_text) && !empty($section_text['GZIP_POST'])) {

Expand All @@ -1816,7 +1840,7 @@ function run_test($php, $file, $env)
$env['CONTENT_TYPE'] = 'application/x-www-form-urlencoded';
$env['CONTENT_LENGTH'] = $content_length;

$cmd = "$php $pass_options $ini_settings -f \"$test_file\" 2>&1 < \"$tmp_post\"";
$cmd = "$php $pass_options $ini_settings -f \"$test_file\"$cmdRedirect < \"$tmp_post\"";

} else if (array_key_exists('DEFLATE_POST', $section_text) && !empty($section_text['DEFLATE_POST'])) {
$post = trim($section_text['DEFLATE_POST']);
Expand All @@ -1829,15 +1853,15 @@ function run_test($php, $file, $env)
$env['CONTENT_TYPE'] = 'application/x-www-form-urlencoded';
$env['CONTENT_LENGTH'] = $content_length;

$cmd = "$php $pass_options $ini_settings -f \"$test_file\" 2>&1 < \"$tmp_post\"";
$cmd = "$php $pass_options $ini_settings -f \"$test_file\"$cmdRedirect < \"$tmp_post\"";

} else {

$env['REQUEST_METHOD'] = 'GET';
$env['CONTENT_TYPE'] = '';
$env['CONTENT_LENGTH'] = '';

$cmd = "$php $pass_options $ini_settings -f \"$test_file\" $args 2>&1";
$cmd = "$php $pass_options $ini_settings -f \"$test_file\" $args$cmdRedirect";
}

if ($leak_check) {
Expand Down Expand Up @@ -1873,7 +1897,7 @@ function run_test($php, $file, $env)

junit_start_timer($shortname);

$out = system_with_timeout($cmd, $env, isset($section_text['STDIN']) ? $section_text['STDIN'] : null);
$out = system_with_timeout($cmd, $env, isset($section_text['STDIN']) ? $section_text['STDIN'] : null, $captureStdOut, $captureStdErr);

junit_finish_timer($shortname);

Expand Down
21 changes: 21 additions & 0 deletions tests/output/vt100_support_posix_redirected_stderr.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
--TEST--
Test stream_vt100_support on POSIX with redirected STDERR
--SKIPIF--
<?php
if (!function_exists('posix_isatty')) {
echo "skip Only for POSIX systems";
}
?>
--CAPTURE_STDIO--
STDERR
--FILE--
<?php
ob_start();
var_dump(stream_vt100_support(STDOUT));
var_dump(stream_vt100_support(STDERR));
$content = ob_get_clean();
fwrite(STDERR, $content);
?>
--EXPECT--
bool(true)
bool(false)
18 changes: 18 additions & 0 deletions tests/output/vt100_support_posix_redirected_stdout.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
--TEST--
Test stream_vt100_support on POSIX with redirected STDOUT
--SKIPIF--
<?php
if (!function_exists('posix_isatty')) {
echo "skip Only for POSIX systems";
}
?>
--CAPTURE_STDIO--
STDOUT
--FILE--
<?php
var_dump(stream_vt100_support(STDOUT));
var_dump(stream_vt100_support(STDERR));
?>
--EXPECT--
bool(false)
bool(true)
25 changes: 25 additions & 0 deletions tests/output/vt100_support_win_supported_redirected.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
--TEST--
Test stream_vt100_support on newer Windows versions with redirected STDIO/STDERR
--SKIPIF--
<?php
if (stripos(PHP_OS, 'WIN') !== 0) {
echo "skip Only for Windows systems";
} elseif (version_compare(
PHP_WINDOWS_VERSION_MAJOR.'.'.PHP_WINDOWS_VERSION_MINOR.'.'.PHP_WINDOWS_VERSION_BUILD,
'10.0.10586'
) < 0) {
echo "skip Only for Windows systems >= 10.0.10586";
}
?>
--CAPTURE_STDIO--
STDOUT, STDERR
--FILE--
<?php
var_dump(stream_vt100_support(STDOUT, true));
var_dump(stream_vt100_support(STDERR, true));
stream_vt100_support(STDOUT, false);
stream_vt100_support(STDERR, false);
?>
--EXPECT--
bool(false)
bool(false)
27 changes: 27 additions & 0 deletions tests/output/vt100_support_win_supported_stderr.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
--TEST--
Test stream_vt100_support for STDERR on newer Windows versions
--SKIPIF--
<?php
if (stripos(PHP_OS, 'WIN') !== 0) {
echo "skip Only for Windows systems";
} elseif (version_compare(
PHP_WINDOWS_VERSION_MAJOR.'.'.PHP_WINDOWS_VERSION_MINOR.'.'.PHP_WINDOWS_VERSION_BUILD,
'10.0.10586'
) < 0) {
echo "skip Only for Windows systems >= 10.0.10586";
}
?>
--CAPTURE_STDIO--
STDOUT
--FILE--
<?php
var_dump(stream_vt100_support(STDERR, true));
var_dump(stream_vt100_support(STDERR));
var_dump(stream_vt100_support(STDERR, false));
var_dump(stream_vt100_support(STDERR));
?>
--EXPECT--
bool(true)
bool(true)
bool(true)
bool(false)
Loading