Repository navigation
Expand file tree
/
Copy pathclilib.php
More file actions
229 lines (209 loc) · 6.62 KB
/
Copy pathclilib.php
File metadata and controls
229 lines (209 loc) · 6.62 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<?php
// This file is part of Moodle - http://moodle.org/
//
// 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.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Command line utility functions and classes
*
* @package core
* @subpackage cli
* @copyright 2009 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
// NOTE: no MOODLE_INTERNAL test here, sometimes we use this before requiring Moodle libs!
/**
* 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);
}
/**
* Get input from user
* @param string $prompt text prompt, should include possible options
* @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
*/
function cli_input($prompt, $default='', array $options=null, $casesensitiveoptions=false) {
cli_writeln($prompt);
cli_write(': ');
$input = fread(STDIN, 2048);
$input = trim($input);
if ($input === '') {
$input = $default;
}
if ($options) {
if (!$casesensitiveoptions) {
$input = strtolower($input);
}
if (!in_array($input, $options)) {
cli_writeln(get_string('cliincorrectvalueretry', 'admin'));
return cli_input($prompt, $default, $options, $casesensitiveoptions);
}
}
return $input;
}
/**
* 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
*/
function cli_get_params(array $longoptions, array $shortmapping=null) {
$shortmapping = (array)$shortmapping;
$options = array();
$unrecognized = array();
if (empty($_SERVER['argv'])) {
// bad luck, we can continue in interactive mode ;-)
return array($options, $unrecognized);
}
$rawoptions = $_SERVER['argv'];
//remove anything after '--', options can not be there
if (($key = array_search('--', $rawoptions)) !== false) {
$rawoptions = array_slice($rawoptions, 0, $key);
}
//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;
} else {
$key = array_shift($parts);
$value = implode('=', $parts);
}
if (array_key_exists($key, $longoptions)) {
$options[$key] = $value;
} else {
$unrecognized[] = $raw;
}
} 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;
}
} else {
$unrecognized[] = $raw;
continue;
}
}
//apply defaults
foreach ($longoptions as $key=>$default) {
if (!array_key_exists($key, $options)) {
$options[$key] = $default;
}
}
// finished
return array($options, $unrecognized);
}
/**
* 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) {
$separator = str_repeat('-', 79).PHP_EOL;
if ($return) {
return $separator;
} else {
cli_write($separator);
}
}
/**
* 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) {
$string = "== $string ==".PHP_EOL;
if ($return) {
return $string;
} else {
cli_write($string);
}
}
/**
* Write error notification
* @param $text
* @return void
*/
function cli_problem($text) {
cli_writeln($text, STDERR);
}
/**
* Write to standard error output and exit with the given code
*
* @param string $text
* @param int $errorcode
* @return void (does not return)
*/
function cli_error($text, $errorcode=1) {
cli_writeln($text.PHP_EOL, STDERR);
die($errorcode);
}
/**
* 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 {
cli_write($logo);
}
}