2009-05-22 02:20:10 +00:00
|
|
|
<?php
|
2009-05-27 09:52:25 +00:00
|
|
|
|
|
|
|
// This file is part of Moodle - http://moodle.org/
|
|
|
|
//
|
2009-05-22 02:20:10 +00:00
|
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU General Public License for more details.
|
2009-05-27 09:52:25 +00:00
|
|
|
//
|
2009-05-22 02:20:10 +00:00
|
|
|
// You should have received a copy of the GNU General Public License
|
|
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2008-06-15 12:23:53 +00:00
|
|
|
/**
|
2009-05-27 09:52:25 +00:00
|
|
|
* Command line utility functions and classes
|
2008-06-15 12:23:53 +00:00
|
|
|
*
|
2010-07-25 13:35:05 +00:00
|
|
|
* @package core
|
2009-05-27 09:52:25 +00:00
|
|
|
* @subpackage cli
|
|
|
|
* @copyright 2009 Petr Skoda (http://skodak.org)
|
|
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
2008-06-15 12:23:53 +00:00
|
|
|
*/
|
|
|
|
|
2012-04-06 13:39:31 +02:00
|
|
|
// NOTE: no MOODLE_INTERNAL test here, sometimes we use this before requiring Moodle libs!
|
2010-07-25 13:35:05 +00:00
|
|
|
|
2015-09-15 23:01:09 +02:00
|
|
|
/**
|
|
|
|
* Write a text to the given stream
|
|
|
|
*
|
|
|
|
* @param string $text text to be written
|
|
|
|
* @param resource $stream output stream to be written to, defaults to STDOUT
|
|
|
|
*/
|
|
|
|
function cli_write($text, $stream=STDOUT) {
|
|
|
|
fwrite($stream, $text);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Write a text followed by an end of line symbol to the given stream
|
|
|
|
*
|
|
|
|
* @param string $text text to be written
|
|
|
|
* @param resource $stream output stream to be written to, defaults to STDOUT
|
|
|
|
*/
|
|
|
|
function cli_writeln($text, $stream=STDOUT) {
|
|
|
|
cli_write($text.PHP_EOL, $stream);
|
|
|
|
}
|
|
|
|
|
2008-06-15 12:23:53 +00:00
|
|
|
/**
|
2009-05-27 09:52:25 +00:00
|
|
|
* Get input from user
|
2010-05-21 19:08:35 +00:00
|
|
|
* @param string $prompt text prompt, should include possible options
|
2009-05-27 09:52:25 +00:00
|
|
|
* @param string $default default value when enter pressed
|
|
|
|
* @param array $options list of allowed options, empty means any text
|
|
|
|
* @param bool $casesensitive true if options are case sensitive
|
|
|
|
* @return string entered text
|
2008-06-15 12:23:53 +00:00
|
|
|
*/
|
2009-05-27 09:52:25 +00:00
|
|
|
function cli_input($prompt, $default='', array $options=null, $casesensitiveoptions=false) {
|
2015-09-15 23:01:09 +02:00
|
|
|
cli_writeln($prompt);
|
|
|
|
cli_write(': ');
|
2009-05-27 09:52:25 +00:00
|
|
|
$input = fread(STDIN, 2048);
|
|
|
|
$input = trim($input);
|
|
|
|
if ($input === '') {
|
|
|
|
$input = $default;
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
if ($options) {
|
|
|
|
if (!$casesensitiveoptions) {
|
|
|
|
$input = strtolower($input);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
if (!in_array($input, $options)) {
|
2015-09-15 23:11:01 +02:00
|
|
|
cli_writeln(get_string('cliincorrectvalueretry', 'admin'));
|
2009-05-27 09:52:25 +00:00
|
|
|
return cli_input($prompt, $default, $options, $casesensitiveoptions);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
return $input;
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2009-05-27 09:52:25 +00:00
|
|
|
* Returns cli script parameters.
|
|
|
|
* @param array $longoptions array of --style options ex:('verbose'=>false)
|
|
|
|
* @param array $shortmapping array describing mapping of short to long style options ex:('h'=>'help', 'v'=>'verbose')
|
|
|
|
* @return array array of arrays, options, unrecognised as optionlongname=>value
|
2008-06-15 12:23:53 +00:00
|
|
|
*/
|
2009-05-27 09:52:25 +00:00
|
|
|
function cli_get_params(array $longoptions, array $shortmapping=null) {
|
|
|
|
$shortmapping = (array)$shortmapping;
|
|
|
|
$options = array();
|
|
|
|
$unrecognized = array();
|
2008-06-15 12:23:53 +00:00
|
|
|
|
2009-05-27 09:52:25 +00:00
|
|
|
if (empty($_SERVER['argv'])) {
|
|
|
|
// bad luck, we can continue in interactive mode ;-)
|
|
|
|
return array($options, $unrecognized);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
$rawoptions = $_SERVER['argv'];
|
2008-06-15 12:23:53 +00:00
|
|
|
|
2009-05-27 09:52:25 +00:00
|
|
|
//remove anything after '--', options can not be there
|
|
|
|
if (($key = array_search('--', $rawoptions)) !== false) {
|
|
|
|
$rawoptions = array_slice($rawoptions, 0, $key);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
|
2009-05-27 09:52:25 +00:00
|
|
|
//remove script
|
|
|
|
unset($rawoptions[0]);
|
|
|
|
foreach ($rawoptions as $raw) {
|
|
|
|
if (substr($raw, 0, 2) === '--') {
|
|
|
|
$value = substr($raw, 2);
|
|
|
|
$parts = explode('=', $value);
|
|
|
|
if (count($parts) == 1) {
|
|
|
|
$key = reset($parts);
|
|
|
|
$value = true;
|
2020-06-15 12:38:56 +08:00
|
|
|
|
2020-11-05 18:10:13 +01:00
|
|
|
if (substr($key, 0, 3) === 'no-' && !array_key_exists($key, $longoptions)
|
|
|
|
&& array_key_exists(substr($key, 3), $longoptions)) {
|
2020-06-15 12:38:56 +08:00
|
|
|
// Support flipping the boolean value.
|
|
|
|
$value = !$value;
|
|
|
|
$key = substr($key, 3);
|
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
} else {
|
|
|
|
$key = array_shift($parts);
|
|
|
|
$value = implode('=', $parts);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
if (array_key_exists($key, $longoptions)) {
|
|
|
|
$options[$key] = $value;
|
|
|
|
} else {
|
|
|
|
$unrecognized[] = $raw;
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
|
2009-05-27 09:52:25 +00:00
|
|
|
} else if (substr($raw, 0, 1) === '-') {
|
|
|
|
$value = substr($raw, 1);
|
|
|
|
$parts = explode('=', $value);
|
|
|
|
if (count($parts) == 1) {
|
|
|
|
$key = reset($parts);
|
|
|
|
$value = true;
|
|
|
|
} else {
|
|
|
|
$key = array_shift($parts);
|
|
|
|
$value = implode('=', $parts);
|
|
|
|
}
|
|
|
|
if (array_key_exists($key, $shortmapping)) {
|
|
|
|
$options[$shortmapping[$key]] = $value;
|
|
|
|
} else {
|
|
|
|
$unrecognized[] = $raw;
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
} else {
|
2009-05-27 09:52:25 +00:00
|
|
|
$unrecognized[] = $raw;
|
|
|
|
continue;
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
//apply defaults
|
|
|
|
foreach ($longoptions as $key=>$default) {
|
|
|
|
if (!array_key_exists($key, $options)) {
|
|
|
|
$options[$key] = $default;
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
// finished
|
|
|
|
return array($options, $unrecognized);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
|
|
|
|
2020-05-16 20:06:40 +10:00
|
|
|
/**
|
|
|
|
* This sets the cli process title suffix
|
|
|
|
*
|
|
|
|
* An example is appending current Task API info so a sysadmin can immediately
|
|
|
|
* see what task a cron process is running at any given moment.
|
|
|
|
*
|
|
|
|
* @param string $suffix process suffix
|
|
|
|
*/
|
|
|
|
function cli_set_process_title_suffix(string $suffix) {
|
2020-07-03 09:49:08 +08:00
|
|
|
if (CLI_SCRIPT && function_exists('cli_set_process_title') && isset($_SERVER['argv'])) {
|
2020-05-16 20:06:40 +10:00
|
|
|
$command = join(' ', $_SERVER['argv']);
|
|
|
|
@cli_set_process_title("php $command ($suffix)");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-05-30 17:14:24 +00:00
|
|
|
/**
|
|
|
|
* Print or return section separator string
|
|
|
|
* @param bool $return false means print, true return as string
|
|
|
|
* @return mixed void or string
|
|
|
|
*/
|
|
|
|
function cli_separator($return=false) {
|
2015-09-15 23:01:09 +02:00
|
|
|
$separator = str_repeat('-', 79).PHP_EOL;
|
2009-05-30 17:14:24 +00:00
|
|
|
if ($return) {
|
|
|
|
return $separator;
|
|
|
|
} else {
|
2015-09-15 23:01:09 +02:00
|
|
|
cli_write($separator);
|
2009-05-30 17:14:24 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Print or return section heading string
|
|
|
|
* @param string $string text
|
|
|
|
* @param bool $return false means print, true return as string
|
|
|
|
* @return mixed void or string
|
|
|
|
*/
|
|
|
|
function cli_heading($string, $return=false) {
|
2015-09-15 23:01:09 +02:00
|
|
|
$string = "== $string ==".PHP_EOL;
|
2009-05-30 17:14:24 +00:00
|
|
|
if ($return) {
|
|
|
|
return $string;
|
|
|
|
} else {
|
2015-09-15 23:01:09 +02:00
|
|
|
cli_write($string);
|
2009-05-30 17:14:24 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2008-06-15 12:23:53 +00:00
|
|
|
/**
|
2009-05-27 09:52:25 +00:00
|
|
|
* Write error notification
|
|
|
|
* @param $text
|
|
|
|
* @return void
|
2008-06-15 12:23:53 +00:00
|
|
|
*/
|
2009-05-27 09:52:25 +00:00
|
|
|
function cli_problem($text) {
|
2015-09-15 23:01:09 +02:00
|
|
|
cli_writeln($text, STDERR);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
2009-05-27 09:52:25 +00:00
|
|
|
|
2008-06-15 12:23:53 +00:00
|
|
|
/**
|
2015-09-15 23:01:09 +02:00
|
|
|
* Write to standard error output and exit with the given code
|
2008-06-15 12:23:53 +00:00
|
|
|
*
|
2009-05-27 09:52:25 +00:00
|
|
|
* @param string $text
|
|
|
|
* @param int $errorcode
|
|
|
|
* @return void (does not return)
|
2008-06-15 12:23:53 +00:00
|
|
|
*/
|
2009-05-27 09:52:25 +00:00
|
|
|
function cli_error($text, $errorcode=1) {
|
2015-09-15 23:01:09 +02:00
|
|
|
cli_writeln($text.PHP_EOL, STDERR);
|
2009-05-27 09:52:25 +00:00
|
|
|
die($errorcode);
|
2008-06-15 12:23:53 +00:00
|
|
|
}
|
2014-05-31 17:40:26 +09:30
|
|
|
|
2015-06-17 22:32:14 +02:00
|
|
|
/**
|
|
|
|
* Print an ASCII version of the Moodle logo.
|
|
|
|
*
|
|
|
|
* @param int $padding left padding of the logo
|
|
|
|
* @param bool $return should we print directly (false) or return the string (true)
|
|
|
|
* @return mixed void or string
|
|
|
|
*/
|
|
|
|
function cli_logo($padding=2, $return=false) {
|
|
|
|
|
|
|
|
$lines = array(
|
|
|
|
' .-..-. ',
|
|
|
|
' _____ | || | ',
|
|
|
|
'/____/-.---_ .---. .---. .-.| || | .---. ',
|
|
|
|
'| | _ _ |/ _ \\/ _ \\/ _ || |/ __ \\',
|
|
|
|
'* | | | | | || |_| || |_| || |_| || || |___/',
|
|
|
|
' |_| |_| |_|\\_____/\\_____/\\_____||_|\\_____)',
|
|
|
|
);
|
|
|
|
|
|
|
|
$logo = '';
|
|
|
|
|
|
|
|
foreach ($lines as $line) {
|
|
|
|
$logo .= str_repeat(' ', $padding);
|
|
|
|
$logo .= $line;
|
|
|
|
$logo .= PHP_EOL;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($return) {
|
|
|
|
return $logo;
|
|
|
|
} else {
|
2015-09-15 23:01:09 +02:00
|
|
|
cli_write($logo);
|
2015-06-17 22:32:14 +02:00
|
|
|
}
|
|
|
|
}
|
2019-09-17 10:11:09 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
2020-03-15 16:54:47 +11:00
|
|
|
"<cursor:save>" => "\033[s",
|
|
|
|
"<cursor:restore>" => "\033[u",
|
|
|
|
"<cursor:up>" => "\033[1A",
|
|
|
|
"<cursor:down>" => "\033[1B",
|
|
|
|
"<cursor:forward>" => "\033[1C",
|
|
|
|
"<cursor:back>" => "\033[1D",
|
2019-09-17 10:11:09 +08:00
|
|
|
];
|
|
|
|
|
|
|
|
$colours = [
|
2020-03-15 16:54:47 +11:00
|
|
|
'normal' => '0;0',
|
|
|
|
'black' => '0;30',
|
|
|
|
'darkGray' => '1;30',
|
|
|
|
'red' => '0;31',
|
|
|
|
'lightRed' => '1;31',
|
|
|
|
'green' => '0;32',
|
|
|
|
'lightGreen' => '1;32',
|
|
|
|
'brown' => '0;33',
|
|
|
|
'yellow' => '1;33',
|
|
|
|
'lightYellow' => '0;93',
|
|
|
|
'blue' => '0;34',
|
|
|
|
'lightBlue' => '1;34',
|
|
|
|
'purple' => '0;35',
|
|
|
|
'lightPurple' => '1;35',
|
|
|
|
'cyan' => '0;36',
|
|
|
|
'lightCyan' => '1;36',
|
|
|
|
'lightGray' => '0;37',
|
|
|
|
'white' => '1;37',
|
|
|
|
];
|
|
|
|
$bgcolours = [
|
|
|
|
'black' => '40',
|
|
|
|
'red' => '41',
|
|
|
|
'green' => '42',
|
|
|
|
'yellow' => '43',
|
|
|
|
'blue' => '44',
|
|
|
|
'magenta' => '45',
|
|
|
|
'cyan' => '46',
|
|
|
|
'white' => '47',
|
2019-09-17 10:11:09 +08:00
|
|
|
];
|
|
|
|
|
|
|
|
foreach ($colours as $colour => $code) {
|
|
|
|
$replacements["<colour:{$colour}>"] = "\033[{$code}m";
|
|
|
|
}
|
2020-03-15 16:54:47 +11:00
|
|
|
foreach ($bgcolours as $colour => $code) {
|
|
|
|
$replacements["<bgcolour:{$colour}>"] = "\033[{$code}m";
|
|
|
|
}
|
2019-09-17 10:11:09 +08:00
|
|
|
|
|
|
|
// 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);
|
|
|
|
}
|