Detect CLI color support for Windows 10 build 10586 #18385

mlocati · 2016-03-31T15:37:58Z

Newer Windows 10 versions (builds starting from 10586) offer VT100 color support.
See http://www.nivot.org/blog/post/2016/02/04/Windows-10-TH2-(v1511)-Console-Host-Enhancements

Q	A
Branch?	master - Maybe it could be backported to other branches too
Bug fix?	maybe 😉 - Do you you consider a bug not having colors on Windows?
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR

Newer Windows 10 versions (builds older than 10586) offer VT100 color support. See http://www.nivot.org/blog/post/2016/02/04/Windows-10-TH2-(v1511)-Console-Host-Enhancements

nicolas-grekas · 2016-03-31T16:44:43Z

note that the VarDumper component has similar logic that should be patched also

stof · 2016-03-31T17:16:15Z

src/Symfony/Component/Console/Output/StreamOutput.php

@@ -93,7 +93,16 @@ protected function doWrite($message, $newline)
    protected function hasColorSupport()
    {
        if (DIRECTORY_SEPARATOR === '\\') {
-            return false !== getenv('ANSICON') || 'ON' === getenv('ConEmuANSI') || 'xterm' === getenv('TERM');
+            return
+                defined('PHP_WINDOWS_VERSION_MAJOR')


AFAIK, PHP_WINDOWS_VERSION_MAJOR goves the version of Windows where PHP was compiled, not the version where it runs

AFAIK, PHP_WINDOWS_VERSION_MAJOR goves the version of Windows where PHP was compiled, not the version where it runs

@stof Whoops, you're right!

stof · 2016-03-31T17:17:06Z

Do you you consider a bug not having colors on Windows?

not a bugfix IMO (especially given that we can already force it with a CLI flag)

mlocati · 2016-04-01T14:00:38Z

AFAIK, PHP_WINDOWS_VERSION_MAJOR goves the version of Windows where PHP was compiled, not the version where it runs

No, it's not true. They are determined at runtime.

I diggered a bit into these PHP_WINDOWS_VERSION_... constants, and the results are quite interesting.

I tested exactly the same PHP executables under these different PCs:

Windows 7
version 6.1 32 bit (build 7601 SP 1)
output of standard ver command in Windows Command Prompt: 6.1.7601
Windows 8
version 6.2 32 bit (build 9200)
output of standard ver command in Windows Command Prompt: 6.2.9200
Windows 8.1
version 6.3 32 bit (build 9600)
output of standard ver command in Windows Command Prompt: 6.3.9600
Windows 10
version 1511 64 bit (build 10586.164)
output of standard ver command in Windows Command Prompt: 10.0.10586

And here's the values of the three constants (concatenated with dots for simplicity) for every PHP version and every PC:

PHP Version	Windows 7	Windows 8	Windows 8.1	Windows 10
5.3.0	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.1	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.2	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.3	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.4	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.5	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.6	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.7	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.8	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.9	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.10	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.11	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.12	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.13	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.14	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.15	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.16	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.17	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.18	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.19	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.20	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.21	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.22	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.23	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.24	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.25	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.26	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.27	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.28	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.3.29	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.0	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.1	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.2	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.3	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.4	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.5	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.6	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.7	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.8	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.9	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.10	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.11	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.12	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.13	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.14	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.15	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.16	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.17	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.18	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.19	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.20	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.21	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.22	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.23	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.24	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.25	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.26	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.27	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.28	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.29	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.30	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.31	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.32	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.33	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.34	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.35	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.36	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.37	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.38	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.39	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.40	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.41	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.42	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.43	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.44	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.4.45	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.0	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.1	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.2	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.3	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.4	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.5	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.6	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.7	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.8	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.9	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.10	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.11	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.12	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.13	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.14	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.15	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.16	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.17	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.18	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.19	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.20	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.21	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.22	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.23	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.24	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.25	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.26	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.5.27	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.5.28	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.5.29	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.5.30	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.5.31	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.5.32	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.5.33	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.5.34	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.0	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.1	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.2	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.3	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.4	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.5	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.6	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.7	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.8	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.9	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.10	6.1.7601	6.2.9200	6.2.9200	6.2.9200
5.6.11	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.12	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.13	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.14	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.15	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.16	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.17	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.18	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.19	6.1.7601	6.2.9200	6.3.9600	10.0.10586
5.6.20	6.1.7601	6.2.9200	6.3.9600	10.0.10586
7.0.0	6.1.7601	6.2.9200	6.3.9600	10.0.10586
7.0.1	6.1.7601	6.2.9200	6.3.9600	10.0.10586
7.0.2	6.1.7601	6.2.9200	6.3.9600	10.0.10586
7.0.3	6.1.7601	6.2.9200	6.3.9600	10.0.10586
7.0.4	6.1.7601	6.2.9200	6.3.9600	10.0.10586
7.0.5	6.1.7601	6.2.9200	6.3.9600	10.0.10586

For these versions:

PHP 5.4
PHP 5.5 up to 5.5.26
PHP 5.6 up to 5.6.10

the detected Windows version is wrong because of this Windows change.

These versions:

PHP 5.5 from 5.5.27
PHP 5.6 from 5.6.11
PHP 7.0

have this patch, so those versions have a reliable value for the constants.

Given all that, I think that this pull request is still valid, but it will work only for PHP 5.5 >= 5.5.27, PHP 5.6 >= 5.6.11 and PHP 7+ (older versions will continue to work as before).

So, @stof, shall I reopen this PR?

mlocati · 2016-04-01T14:12:55Z

PS: a more reliable way to determine the exact Windows version would be to use exec('ver'), but:

we should check if exec can be used (like here)
the output of ver is localized, so we'd need to use a regex to catch its result

stof · 2016-04-01T14:37:12Z

it is fine if the autodetection works fine only in uptodate PHP versions. Not detecting color support won't break the console (it will just fallback to non colored output by default)

Newer Windows 10 versions (builds older than 10586) offer VT100 color support. See http://www.nivot.org/blog/post/2016/02/04/Windows-10-TH2-(v1511)-Console-Host-Enhancements

mlocati · 2016-04-01T15:30:53Z

I updated this PR, adding the Windows 10 detection code to DeprecationErrorHandler and CliDumper too

stof · 2016-04-01T16:17:40Z

src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler.php

@@ -194,7 +194,16 @@ public static function register($mode = 0)
    private static function hasColorSupport()
    {
        if ('\\' === DIRECTORY_SEPARATOR) {
-            return false !== getenv('ANSICON') || 'ON' === getenv('ConEmuANSI') || 'xterm' === getenv('TERM');
+            return
+                defined('PHP_WINDOWS_VERSION_MAJOR')


is this part actually needed ? We already detect windows just before

We just detected that the directory separator in \... I'm not 100% sure it's only used in Windows (there are more OSs out there than just *nix, Windows and Mac... What about OS2? Others?....)

I think we can safely state that only Windows does '\\' === DIRECTORY_SEPARATOR

…rator is \

nicolas-grekas · 2016-04-03T17:27:04Z

👍, as a bug fix on 2.3 to me...

fabpot · 2016-04-03T17:41:47Z

I don't think it qualifies as a bug fix (and this PR does not apply cleanly on 2.3 as two files did not exist back then). For such a PR, I propose to merge it on master and be done with it.

nicolas-grekas · 2016-04-04T17:01:32Z

Thank you @mlocati.

This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #18385). Discussion ---------- Detect CLI color support for Windows 10 build 10586 Newer Windows 10 versions (builds starting from 10586) offer VT100 color support. See http://www.nivot.org/blog/post/2016/02/04/Windows-10-TH2-(v1511)-Console-Host-Enhancements | Q | A | ------------- | --- | Branch? | master - Maybe it could be backported to other branches too | Bug fix? | maybe 😉 - Do you you consider a bug not having colors on Windows? | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Commits ------- 472a7bf Detect CLI color support for Windows 10 build 10586

Detect CLI color support for Windows 10 build 10586

70db2c0

Newer Windows 10 versions (builds older than 10586) offer VT100 color support. See http://www.nivot.org/blog/post/2016/02/04/Windows-10-TH2-(v1511)-Console-Host-Enhancements

carsonbot added the Status: Needs Review label Mar 31, 2016

nicolas-grekas mentioned this pull request Mar 31, 2016

added a maintenance document symfony/symfony-docs#6412

Merged

stof reviewed Mar 31, 2016
View reviewed changes

mlocati closed this Apr 1, 2016

mlocati deleted the use-cli-colors-on-win10 branch April 1, 2016 06:17

mlocati restored the use-cli-colors-on-win10 branch April 1, 2016 14:50

mlocati reopened this Apr 1, 2016

mlocati added 2 commits April 1, 2016 16:59

Detect CLI color support for Windows 10 build 10586

1ab5544

Newer Windows 10 versions (builds older than 10586) offer VT100 color support. See http://www.nivot.org/blog/post/2016/02/04/Windows-10-TH2-(v1511)-Console-Host-Enhancements

Use only 16 colors when using standard Windows 10 VT100 commands

5530fac

stof reviewed Apr 1, 2016
View reviewed changes

mlocati added 2 commits April 1, 2016 19:36

Don't check if PHP_WINDOWS_VERSION_MAJOR is defined if directory sepa…

6e676c4

…rator is \

Windows 10 version check in just one line

a226d77

javiereguiluz added Feature Console PhpUnitBridge labels Apr 3, 2016

nicolas-grekas closed this Apr 4, 2016

fabpot mentioned this pull request Apr 29, 2016

Release v2.3.40 #18669

Merged

This was referenced Apr 29, 2016

Release v2.7.12 #18670

Merged

Release v2.8.5 #18674

Merged

Release v3.0.5 #18697

Merged

Seldaek mentioned this pull request May 16, 2016

Windows 10 console seems to now provide ANSI support without ANSICON. #17499

Closed

jhdxr mentioned this pull request Aug 3, 2016

Windows 10 does not support console colors any more #19520

Closed

dantleech mentioned this pull request Oct 14, 2024

Windows Support php-tui/term#14

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Detect CLI color support for Windows 10 build 10586 #18385

Detect CLI color support for Windows 10 build 10586 #18385

mlocati commented Mar 31, 2016

nicolas-grekas commented Mar 31, 2016

stof Mar 31, 2016

mlocati Apr 1, 2016

stof commented Mar 31, 2016

mlocati commented Apr 1, 2016

mlocati commented Apr 1, 2016

stof commented Apr 1, 2016

mlocati commented Apr 1, 2016

stof Apr 1, 2016

mlocati Apr 1, 2016

nicolas-grekas Apr 1, 2016

nicolas-grekas commented Apr 3, 2016

fabpot commented Apr 3, 2016

nicolas-grekas commented Apr 4, 2016

Detect CLI color support for Windows 10 build 10586 #18385

Detect CLI color support for Windows 10 build 10586 #18385

Conversation

mlocati commented Mar 31, 2016

nicolas-grekas commented Mar 31, 2016

stof Mar 31, 2016

Choose a reason for hiding this comment

mlocati Apr 1, 2016

Choose a reason for hiding this comment

stof commented Mar 31, 2016

mlocati commented Apr 1, 2016

mlocati commented Apr 1, 2016

stof commented Apr 1, 2016

mlocati commented Apr 1, 2016

stof Apr 1, 2016

Choose a reason for hiding this comment

mlocati Apr 1, 2016

Choose a reason for hiding this comment

nicolas-grekas Apr 1, 2016

Choose a reason for hiding this comment

nicolas-grekas commented Apr 3, 2016

fabpot commented Apr 3, 2016

nicolas-grekas commented Apr 4, 2016