mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-17 21:49:15 +01:00
Code Issues Projects Releases Wiki Activity

MDL-66675 CLI: Add ANSI formatting options

Browse Source
This commit is contained in:
Andrew Nicols 2019-09-17 10:11:09 +08:00
parent 1c3efe48f8
commit 3b4717ea4b
1 changed files with 56 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
lib/clilib.php
View File

@ -227,3 +227,59 @@ function cli_logo($padding=2, $return=false) {
cli_write($logo);
}
}
/**
* Substitute cursor, colour, and bell placeholders in a CLI output to ANSI escape characters when ANSI is available.
*
* @param string $message
* @return string
*/
function cli_ansi_format(string $message): string {
global $CFG;
$replacements = [
"<newline>" => "\n",
"<bell>" => "\007",
// Cursor movement: https://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/x361.html.
"<cursor:save>" => "\033[s",
"<cursor:restore>" => "\033[u",
"<cursor:up>" => "\033[1A",
"<cursor:down>" => "\033[1B",
"<cursor:forward>" => "\033[1C",
"<cursor:back>" => "\033[1D",
];
$colours = [
'normal' => '0;0',
'black' => '0;30',
'darkGray' => '1;30',
'blue' => '0;34',
'lightBlue' => '1;34',
'green' => '0;32',
'lightGreen' => '1;32',
'cyan' => '0;36',
'lightCyan' => '1;36',
'red' => '0;31',
'lightRed' => '1;31',
'purple' => '0;35',
'lightPurple' => '1;35',
'brown' => '0;33',
'yellow' => '1;33',
'lightYellow' => '0;93',
'lightGray' => '0;37',
'white' => '1;37',
];
foreach ($colours as $colour => $code) {
$replacements["<colour:{$colour}>"] = "\033[{$code}m";
}
// Windows don't support ANSI code by default, but does if ANSICON is available.
$isansicon = getenv('ANSICON');
if (($CFG->ostype === 'WINDOWS') && empty($isansicon)) {
return str_replace(array_keys($replacements), '', $message);
}
return str_replace(array_keys($replacements), array_values($replacements), $message);
}