paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
paulgoughbooks_old / trunk / system / CLI / CLI.php
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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\CLI; use CodeIgniter\CLI\Exceptions\CLIException; /** * Set of static methods useful for CLI request handling. * * Portions of this code were initially from the FuelPHP Framework, * version 1.7.x, and used here under the MIT license they were * originally made available under. Reference: http://fuelphp.com * * Some of the code in this class is Windows-specific, and not * possible to test using travis-ci. It has been phpunit-annotated * to prevent messing up code coverage. * * Some of the methods require keyboard input, and are not unit-testable * as a result: input() and prompt(). * validate() is internal, and not testable if prompt() isn't. * The wait() method is mostly testable, as long as you don't give it * an argument of "0". * These have been flagged to ignore for code coverage purposes. * * @package CodeIgniter\CLI */ class CLI { /** * Is the readline library on the system? * * @var boolean */ public static $readline_support = false; /** * The message displayed at prompts. * * @var string */ public static $wait_msg = 'Press any key to continue...'; /** * Has the class already been initialized? * * @var boolean */ protected static $initialized = false; /** * Foreground color list * * @var array */ protected static $foreground_colors = [ 'black' => '0;30', 'dark_gray' => '1;30', 'blue' => '0;34', 'dark_blue' => '0;34', 'light_blue' => '1;34', 'green' => '0;32', 'light_green' => '1;32', 'cyan' => '0;36', 'light_cyan' => '1;36', 'red' => '0;31', 'light_red' => '1;31', 'purple' => '0;35', 'light_purple' => '1;35', 'yellow' => '0;33', 'light_yellow' => '1;33', 'light_gray' => '0;37', 'white' => '1;37', ]; /** * Background color list * * @var array */ protected static $background_colors = [ 'black' => '40', 'red' => '41', 'green' => '42', 'yellow' => '43', 'blue' => '44', 'magenta' => '45', 'cyan' => '46', 'light_gray' => '47', ]; /** * List of array segments. * * @var array */ protected static $segments = []; /** * @var array */ protected static $options = []; /** * Helps track internally whether the last * output was a "write" or a "print" to * keep the output clean and as expected. * * @var string */ protected static $lastWrite; /** * Height of the CLI window * * @var integer */ protected static $height; /** * Width of the CLI window * * @var integer */ protected static $width; /** * Whether the current stream supports colored output. * * @var boolean */ protected static $isColored = false; //-------------------------------------------------------------------- /** * Static "constructor". */ public static function init() { if (is_cli()) { // Readline is an extension for PHP that makes interactivity with PHP // much more bash-like. // http://www.php.net/manual/en/readline.installation.php static::$readline_support = extension_loaded('readline'); // clear segments & options to keep testing clean static::$segments = []; static::$options = []; // Check our stream resource for color support static::$isColored = static::hasColorSupport(STDOUT); static::parseCommandLine(); static::$initialized = true; } else { // If the command is being called from a controller // we need to define STDOUT ourselves // @codeCoverageIgnoreStart define('STDOUT', 'php://output'); // @codeCoverageIgnoreEnd } } //-------------------------------------------------------------------- /** * Get input from the shell, using readline or the standard STDIN * * Named options must be in the following formats: * php index.php user -v --v -name=John --name=John * * @param string $prefix * @return string * * @codeCoverageIgnore */ public static function input(string $prefix = null): string { if (static::$readline_support) { return readline($prefix); } echo $prefix; return fgets(STDIN); } //-------------------------------------------------------------------- /** * Asks the user for input. * * Usage: * * // Takes any input * $color = CLI::prompt('What is your favorite color?'); * * // Takes any input, but offers default * $color = CLI::prompt('What is your favourite color?', 'white'); * * // Will validate options with the in_list rule and accept only if one of the list * $color = CLI::prompt('What is your favourite color?', array('red','blue')); * * // Do not provide options but requires a valid email * $email = CLI::prompt('What is your email?', null, 'required|valid_email'); * * @param string $field Output "field" question * @param string|array $options String to a default value, array to a list of options (the first option will be the default value) * @param string $validation Validation rules * * @return string The user input * * @codeCoverageIgnore */ public static function prompt(string $field, $options = null, string $validation = null): string { $extra_output = ''; $default = ''; if (is_string($options)) { $extra_output = ' [' . static::color($options, 'white') . ']'; $default = $options; } if (is_array($options) && $options) { $opts = $options; $extra_output_default = static::color($opts[0], 'white'); unset($opts[0]); if (empty($opts)) { $extra_output = $extra_output_default; } else { $extra_output = ' [' . $extra_output_default . ', ' . implode(', ', $opts) . ']'; $validation .= '|in_list[' . implode(',', $options) . ']'; $validation = trim($validation, '|'); } $default = $options[0]; } static::fwrite(STDOUT, $field . $extra_output . ': '); // Read the input from keyboard. $input = trim(static::input()) ?: $default; if (isset($validation)) { while (! static::validate($field, $input, $validation)) { $input = static::prompt($field, $options, $validation); } } return empty($input) ? '' : $input; } //-------------------------------------------------------------------- /** * Validate one prompt "field" at a time * * @param string $field Prompt "field" output * @param string $value Input value * @param string $rules Validation rules * * @return boolean * * @codeCoverageIgnore */ protected static function validate(string $field, string $value, string $rules): bool { $label = $field; $field = 'temp'; $validation = \Config\Services::validation(null, false); $validation->setRule($field, $label, $rules); $validation->run([$field => $value]); if ($validation->hasError($field)) { static::error($validation->getError($field)); return false; } return true; } //-------------------------------------------------------------------- /** * Outputs a string to the CLI without any surrounding newlines. * Useful for showing repeating elements on a single line. * * @param string $text * @param string|null $foreground * @param string|null $background */ public static function print(string $text = '', string $foreground = null, string $background = null) { if ($foreground || $background) { $text = static::color($text, $foreground, $background); } static::$lastWrite = null; static::fwrite(STDOUT, $text); } /** * Outputs a string to the cli on it's own line. * * @param string $text The text to output * @param string $foreground * @param string $background */ public static function write(string $text = '', string $foreground = null, string $background = null) { if ($foreground || $background) { $text = static::color($text, $foreground, $background); } if (static::$lastWrite !== 'write') { $text = PHP_EOL . $text; static::$lastWrite = 'write'; } static::fwrite(STDOUT, $text . PHP_EOL); } //-------------------------------------------------------------------- /** * Outputs an error to the CLI using STDERR instead of STDOUT * * @param string|array $text The text to output, or array of errors * @param string $foreground * @param string $background */ public static function error(string $text, string $foreground = 'light_red', string $background = null) { // Check color support for STDERR $stdout = static::$isColored; static::$isColored = static::hasColorSupport(STDERR); if ($foreground || $background) { $text = static::color($text, $foreground, $background); } static::fwrite(STDERR, $text . PHP_EOL); // return STDOUT color support static::$isColored = $stdout; } //-------------------------------------------------------------------- /** * Beeps a certain number of times. * * @param integer $num The number of times to beep */ public static function beep(int $num = 1) { echo str_repeat("\x07", $num); } //-------------------------------------------------------------------- /** * Waits a certain number of seconds, optionally showing a wait message and * waiting for a key press. * * @param integer $seconds Number of seconds * @param boolean $countdown Show a countdown or not */ public static function wait(int $seconds, bool $countdown = false) { if ($countdown === true) { $time = $seconds; while ($time > 0) { static::fwrite(STDOUT, $time . '... '); sleep(1); $time --; } static::write(); } else { if ($seconds > 0) { sleep($seconds); } else { // this chunk cannot be tested because of keyboard input // @codeCoverageIgnoreStart static::write(static::$wait_msg); static::input(); // @codeCoverageIgnoreEnd } } } //-------------------------------------------------------------------- /** * if operating system === windows * * @return boolean */ public static function isWindows(): bool { return stripos(PHP_OS, 'WIN') === 0; } //-------------------------------------------------------------------- /** * Enter a number of empty lines * * @param integer $num Number of lines to output * * @return void */ public static function newLine(int $num = 1) { // Do it once or more, write with empty string gives us a new line for ($i = 0; $i < $num; $i ++) { static::write(); } } //-------------------------------------------------------------------- /** * Clears the screen of output * * @return void * * @codeCoverageIgnore */ public static function clearScreen() { // Unix systems, and Windows with VT100 Terminal support (i.e. Win10) // can handle CSI sequences. For lower than Win10 we just shove in 40 new lines. static::isWindows() && ! static::streamSupports('sapi_windows_vt100_support', STDOUT) ? static::newLine(40) : static::fwrite(STDOUT, "\033[H\033[2J"); } //-------------------------------------------------------------------- /** * Returns the given text with the correct color codes for a foreground and * optionally a background color. * * @param string $text The text to color * @param string $foreground The foreground color * @param string $background The background color * @param string $format Other formatting to apply. Currently only 'underline' is understood * * @return string The color coded string */ public static function color(string $text, string $foreground, string $background = null, string $format = null): string { if (! static::$isColored) { return $text; } if (! array_key_exists($foreground, static::$foreground_colors)) { throw CLIException::forInvalidColor('foreground', $foreground); } if ($background !== null && ! array_key_exists($background, static::$background_colors)) { throw CLIException::forInvalidColor('background', $background); } $string = "\033[" . static::$foreground_colors[$foreground] . 'm'; if ($background !== null) { $string .= "\033[" . static::$background_colors[$background] . 'm'; } if ($format === 'underline') { $string .= "\033[4m"; } // Detect if color method was already in use with this text if (strpos($text, "\033[0m") !== false) { // Split the text into parts so that we can see // if any part missing the color definition $chunks = mb_split("\\033\[0m", $text); // Reset text $text = ''; foreach ($chunks as $chunk) { if ($chunk === '') { continue; } // If chunk doesn't have colors defined we need to add them if (strpos($chunk, "\033[") === false) { $chunk = static::color($chunk, $foreground, $background, $format); // Add color reset before chunk and clear end of the string $text .= rtrim("\033[0m" . $chunk, "\033[0m"); } else { $text .= $chunk; } } } return $string . $text . "\033[0m"; } //-------------------------------------------------------------------- /** * Get the number of characters in string having encoded characters * and ignores styles set by the color() function * * @param string $string * * @return integer */ public static function strlen(?string $string): int { if (is_null($string)) { return 0; } foreach (static::$foreground_colors as $color) { $string = strtr($string, ["\033[" . $color . 'm' => '']); } foreach (static::$background_colors as $color) { $string = strtr($string, ["\033[" . $color . 'm' => '']); } $string = strtr($string, ["\033[4m" => '', "\033[0m" => '']); return mb_strlen($string); } //-------------------------------------------------------------------- /** * Checks whether the current stream resource supports or * refers to a valid terminal type device. * * @param string $function * @param resource $resource * * @return boolean */ public static function streamSupports(string $function, $resource): bool { if (ENVIRONMENT === 'testing') { // In the current setup of the tests we cannot fully check // if the stream supports the function since we are using // filtered streams. return function_exists($function); } // @codeCoverageIgnoreStart return function_exists($function) && @$function($resource); // @codeCoverageIgnoreEnd } //-------------------------------------------------------------------- /** * Returns true if the stream resource supports colors. * * This is tricky on Windows, because Cygwin, Msys2 etc. emulate pseudo * terminals via named pipes, so we can only check the environment. * * Reference: https://github.com/composer/xdebug-handler/blob/master/src/Process.php * * @param resource $resource * * @return boolean */ public static function hasColorSupport($resource): bool { // Follow https://no-color.org/ if (isset($_SERVER['NO_COLOR']) || getenv('NO_COLOR') !== false) { return false; } if (getenv('TERM_PROGRAM') === 'Hyper') { return true; } if (static::isWindows()) { // @codeCoverageIgnoreStart return static::streamSupports('sapi_windows_vt100_support', $resource) || isset($_SERVER['ANSICON']) || getenv('ANSICON') !== false || getenv('ConEmuANSI') === 'ON' || getenv('TERM') === 'xterm'; // @codeCoverageIgnoreEnd } return static::streamSupports('stream_isatty', $resource); } //-------------------------------------------------------------------- /** * Attempts to determine the width of the viewable CLI window. * * @param integer $default * * @return integer */ public static function getWidth(int $default = 80): int { if (\is_null(static::$width)) { static::generateDimensions(); } return static::$width ?: $default; } //-------------------------------------------------------------------- /** * Attempts to determine the height of the viewable CLI window. * * @param integer $default * * @return integer */ public static function getHeight(int $default = 32): int { if (\is_null(static::$height)) { static::generateDimensions(); } return static::$height ?: $default; } //-------------------------------------------------------------------- /** * Populates the CLI's dimensions. * * @return void */ public static function generateDimensions() { if (static::isWindows()) { // Shells such as `Cygwin` and `Git bash` returns incorrect values // when executing `mode CON`, so we use `tput` instead // @codeCoverageIgnoreStart if (($shell = getenv('SHELL')) && preg_match('/(?:bash|zsh)(?:\.exe)?$/', $shell) || getenv('TERM')) { static::$height = (int) exec('tput lines'); static::$width = (int) exec('tput cols'); } else { $return = -1; $output = []; exec('mode CON', $output, $return); if ($return === 0 && $output) { // Look for the next lines ending in ": <number>" // Searching for "Columns:" or "Lines:" will fail on non-English locales if (preg_match('/:\s*(\d+)\n[^:]+:\s*(\d+)\n/', implode("\n", $output), $matches)) { static::$height = (int) $matches[1]; static::$width = (int) $matches[2]; } } } // @codeCoverageIgnoreEnd } else { if (($size = exec('stty size')) && preg_match('/(\d+)\s+(\d+)/', $size, $matches)) { static::$height = (int) $matches[1]; static::$width = (int) $matches[2]; } else { // @codeCoverageIgnoreStart static::$height = (int) exec('tput lines'); static::$width = (int) exec('tput cols'); // @codeCoverageIgnoreEnd } } } //-------------------------------------------------------------------- /** * Displays a progress bar on the CLI. You must call it repeatedly * to update it. Set $thisStep = false to erase the progress bar. * * @param integer|boolean $thisStep * @param integer $totalSteps */ public static function showProgress($thisStep = 1, int $totalSteps = 10) { static $inProgress = false; // restore cursor position when progress is continuing. if ($inProgress !== false && $inProgress <= $thisStep) { static::fwrite(STDOUT, "\033[1A"); } $inProgress = $thisStep; if ($thisStep !== false) { // Don't allow div by zero or negative numbers.... $thisStep = abs($thisStep); $totalSteps = $totalSteps < 1 ? 1 : $totalSteps; $percent = intval(($thisStep / $totalSteps) * 100); $step = (int) round($percent / 10); // Write the progress bar static::fwrite(STDOUT, "[\033[32m" . str_repeat('#', $step) . str_repeat('.', 10 - $step) . "\033[0m]"); // Textual representation... static::fwrite(STDOUT, sprintf(' %3d%% Complete', $percent) . PHP_EOL); } else { static::fwrite(STDOUT, "\007"); } } //-------------------------------------------------------------------- /** * Takes a string and writes it to the command line, wrapping to a maximum * width. If no maximum width is specified, will wrap to the window's max * width. * * If an int is passed into $pad_left, then all strings after the first * will padded with that many spaces to the left. Useful when printing * short descriptions that need to start on an existing line. * * @param string $string * @param integer $max * @param integer $pad_left * * @return string */ public static function wrap(string $string = null, int $max = 0, int $pad_left = 0): string { if (empty($string)) { return ''; } if ($max === 0) { $max = CLI::getWidth(); } if (CLI::getWidth() < $max) { $max = CLI::getWidth(); } $max = $max - $pad_left; $lines = wordwrap($string, $max, PHP_EOL); if ($pad_left > 0) { $lines = explode(PHP_EOL, $lines); $first = true; array_walk($lines, function (&$line, $index) use ($pad_left, &$first) { if (! $first) { $line = str_repeat(' ', $pad_left) . $line; } else { $first = false; } }); $lines = implode(PHP_EOL, $lines); } return $lines; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // Command-Line 'URI' support //-------------------------------------------------------------------- /** * Parses the command line it was called from and collects all * options and valid segments. * * I tried to use getopt but had it fail occasionally to find any * options but argc has always had our back. We don't have all of the power * of getopt but this does us just fine. */ protected static function parseCommandLine() { // start picking segments off from #1, ignoring the invoking program for ($i = 1; $i < $_SERVER['argc']; $i ++) { // If there's no '-' at the beginning of the argument // then add it to our segments. if (mb_strpos($_SERVER['argv'][$i], '-') !== 0) { static::$segments[] = $_SERVER['argv'][$i]; continue; } $arg = str_replace('-', '', $_SERVER['argv'][$i]); $value = null; // if there is a following segment, and it doesn't start with a dash, it's a value. if (isset($_SERVER['argv'][$i + 1]) && mb_strpos($_SERVER['argv'][$i + 1], '-') !== 0) { $value = $_SERVER['argv'][$i + 1]; $i ++; } static::$options[$arg] = $value; } } //-------------------------------------------------------------------- /** * Returns the command line string portions of the arguments, minus * any options, as a string. This is used to pass along to the main * CodeIgniter application. * * @return string */ public static function getURI(): string { return implode('/', static::$segments); } //-------------------------------------------------------------------- /** * Returns an individual segment. * * This ignores any options that might have been dispersed between * valid segments in the command: * * // segment(3) is 'three', not '-f' or 'anOption' * > php spark one two -f anOption three * * @param integer $index * * @return mixed|null */ public static function getSegment(int $index) { if (! isset(static::$segments[$index - 1])) { return null; } return static::$segments[$index - 1]; } //-------------------------------------------------------------------- /** * Returns the raw array of segments found. * * @return array */ public static function getSegments(): array { return static::$segments; } //-------------------------------------------------------------------- /** * Gets a single command-line option. Returns TRUE if the option * exists, but doesn't have a value, and is simply acting as a flag. * * @param string $name * * @return boolean|mixed|null */ public static function getOption(string $name) { if (! array_key_exists($name, static::$options)) { return null; } // If the option didn't have a value, simply return TRUE // so they know it was set, otherwise return the actual value. $val = static::$options[$name] === null ? true : static::$options[$name]; return $val; } //-------------------------------------------------------------------- /** * Returns the raw array of options found. * * @return array */ public static function getOptions(): array { return static::$options; } //-------------------------------------------------------------------- /** * Returns the options as a string, suitable for passing along on * the CLI to other commands. * * @return string */ public static function getOptionString(): string { if (empty(static::$options)) { return ''; } $out = ''; foreach (static::$options as $name => $value) { // If there's a space, we need to group // so it will pass correctly. if (mb_strpos($value, ' ') !== false) { $value = '"' . $value . '"'; } $out .= "-{$name} $value "; } return $out; } //-------------------------------------------------------------------- /** * Returns a well formatted table * * @param array $tbody List of rows * @param array $thead List of columns * * @return void */ public static function table(array $tbody, array $thead = []) { // All the rows in the table will be here until the end $table_rows = []; // We need only indexes and not keys if (! empty($thead)) { $table_rows[] = array_values($thead); } foreach ($tbody as $tr) { $table_rows[] = array_values($tr); } // Yes, it really is necessary to know this count $total_rows = count($table_rows); // Store all columns lengths // $all_cols_lengths[row][column] = length $all_cols_lengths = []; // Store maximum lengths by column // $max_cols_lengths[column] = length $max_cols_lengths = []; // Read row by row and define the longest columns for ($row = 0; $row < $total_rows; $row ++) { $column = 0; // Current column index foreach ($table_rows[$row] as $col) { // Sets the size of this column in the current row $all_cols_lengths[$row][$column] = static::strlen($col); // If the current column does not have a value among the larger ones // or the value of this is greater than the existing one // then, now, this assumes the maximum length if (! isset($max_cols_lengths[$column]) || $all_cols_lengths[$row][$column] > $max_cols_lengths[$column]) { $max_cols_lengths[$column] = $all_cols_lengths[$row][$column]; } // We can go check the size of the next column... $column ++; } } // Read row by row and add spaces at the end of the columns // to match the exact column length for ($row = 0; $row < $total_rows; $row ++) { $column = 0; foreach ($table_rows[$row] as $col) { $diff = $max_cols_lengths[$column] - static::strlen($col); if ($diff) { $table_rows[$row][$column] = $table_rows[$row][$column] . str_repeat(' ', $diff); } $column ++; } } $table = ''; // Joins columns and append the well formatted rows to the table for ($row = 0; $row < $total_rows; $row ++) { // Set the table border-top if ($row === 0) { $cols = '+'; foreach ($table_rows[$row] as $col) { $cols .= str_repeat('-', static::strlen($col) + 2) . '+'; } $table .= $cols . PHP_EOL; } // Set the columns borders $table .= '| ' . implode(' | ', $table_rows[$row]) . ' |' . PHP_EOL; // Set the thead and table borders-bottom if ($row === 0 && ! empty($thead) || $row + 1 === $total_rows) { $table .= $cols . PHP_EOL; } } static::write($table); } //-------------------------------------------------------------------- /** * While the library is intended for use on CLI commands, * commands can be called from controllers and elsewhere * so we need a way to allow them to still work. * * For now, just echo the content, but look into a better * solution down the road. * * @param resource $handle * @param string $string */ protected static function fwrite($handle, string $string) { if (is_cli()) { fwrite($handle, $string); return; } // @codeCoverageIgnoreStart echo $string; // @codeCoverageIgnoreEnd } } // Ensure the class is initialized. Done outside of code coverage // @codeCoverageIgnoreStart CLI::init(); // @codeCoverageIgnoreEnd |
Commits for paulgoughbooks_old/trunk/system/CLI/CLI.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |