CommandLineController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Controller;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Utility\GeneralUtility;

class CommandLineController
{
    public $cli_args = [];

    public $cli_options = [
        ['-s', 'Silent operation, will only output errors and important messages.'],
        ['--silent', 'Same as -s'],
        ['-ss', 'Super silent, will not even output errors or important messages.']
    ];

    public $cli_help = [
        'name' => 'CLI base class (overwrite this...)',
        'synopsis' => '###OPTIONS###',
        'description' => 'Class with basic functionality for CLI scripts (overwrite this...)',
        'examples' => 'Give examples...',
        'options' => '',
        'license' => 'GNU GPL - free software!',
        'author' => '[Author name]'
    ];

    public $stdin = null;

    public function __construct()
    {
        GeneralUtility::logDeprecatedFunction();
        // Loads the cli_args array with command line arguments
        $this->cli_setArguments($_SERVER['argv']);
    }

    public function cli_getArgArray($option, $argv)
    {
        while (count($argv) && (string)$argv[0] !== (string)$option) {
            array_shift($argv);
        }
        if ((string)$argv[0] === (string)$option) {
            array_shift($argv);
            return !empty($argv) ? $argv : [''];
        }
    }

    public function cli_isArg($option)
    {
        return isset($this->cli_args[$option]);
    }

    public function cli_argValue($option, $idx = 0)
    {
        return is_array($this->cli_args[$option]) ? $this->cli_args[$option][$idx] : '';
    }

    public function cli_getArgIndex(array $argv = [])
    {
        $cli_options = [];
        $index = '_DEFAULT';
        foreach ($argv as $token) {
            // Options starting with a number is invalid - they could be negative values!
            if ($token[0] === '-' && !\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($token[1])) {
                list($index, $opt) = explode('=', $token, 2);
                if (isset($cli_options[$index])) {
                    echo 'ERROR: Option ' . $index . ' was used twice!' . LF;
                    die;
                }
                $cli_options[$index] = [];
                if (isset($opt)) {
                    $cli_options[$index][] = $opt;
                }
            } else {
                $cli_options[$index][] = $token;
            }
        }
        return $cli_options;
    }

    public function cli_validateArgs()
    {
        $cli_args_copy = $this->cli_args;
        unset($cli_args_copy['_DEFAULT']);
        $allOptions = [];
        foreach ($this->cli_options as $cfg) {
            $allOptions[] = $cfg[0];
            $argSplit = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(' ', $cfg[0], true);
            if (isset($cli_args_copy[$argSplit[0]])) {
                $ii = 0;
                foreach ($argSplit as $i => $v) {
                    $ii = $i;
                    if ($i > 0) {
                        if (!isset($cli_args_copy[$argSplit[0]][$i - 1]) && $v[0] !== '[') {
                            // Using "[]" around a parameter makes it optional
                            echo 'ERROR: Option "' . $argSplit[0] . '" requires a value ("' . $v . '") on position ' . $i . LF;
                            die;
                        }
                    }
                }
                $ii++;
                if (isset($cli_args_copy[$argSplit[0]][$ii - 1])) {
                    echo 'ERROR: Option "' . $argSplit[0] . '" does not support a value on position ' . $ii . LF;
                    die;
                }
                unset($cli_args_copy[$argSplit[0]]);
            }
        }
        if (!empty($cli_args_copy)) {
            echo wordwrap('ERROR: Option ' . implode(',', array_keys($cli_args_copy)) . ' was unknown to this script!' . LF . '(Options are: ' . implode(', ', $allOptions) . ')' . LF);
            die;
        }
    }

    public function cli_setArguments(array $argv = [])
    {
        $this->cli_args = $this->cli_getArgIndex($argv);
    }

    public function cli_keyboardInput()
    {
        // Have to open the stdin stream only ONCE! otherwise I cannot read multiple lines from it... :
        if (!$this->stdin) {
            $this->stdin = fopen('php://stdin', 'r');
        }
        while (false == ($line = fgets($this->stdin, 1000))) {
        }
        return trim($line);
    }

    public function cli_keyboardInput_yes($msg = '')
    {
        // ONLY makes sense to echo it out since we are awaiting keyboard input - that cannot be silenced
        echo $msg . ' (Yes/No + return): ';
        $input = strtolower($this->cli_keyboardInput());
        return $input === 'y' || $input === 'yes';
    }

    public function cli_echo($string = '', $force = false)
    {
        if (isset($this->cli_args['-ss'])) {
        } elseif (isset($this->cli_args['-s']) || isset($this->cli_args['--silent'])) {
            if ($force) {
                echo $string;
                return true;
            }
        } else {
            echo $string;
            return true;
        }
        return false;
    }

    public function cli_help()
    {
        foreach ($this->cli_help as $key => $value) {
            $this->cli_echo(strtoupper($key) . ':
');
            switch ($key) {
                case 'synopsis':
                    $optStr = '';
                    foreach ($this->cli_options as $v) {
                        $optStr .= ' [' . $v[0] . ']';
                    }
                    $this->cli_echo($this->cli_indent(str_replace('###OPTIONS###', trim($optStr), $value), 4) . '

');
                    break;
                case 'options':
                    $this->cli_echo($this->cli_indent($value, 4) . LF);
                    $maxLen = 0;
                    foreach ($this->cli_options as $v) {
                        if (strlen($v[0]) > $maxLen) {
                            $maxLen = strlen($v[0]);
                        }
                    }
                    foreach ($this->cli_options as $v) {
                        $this->cli_echo($v[0] . substr($this->cli_indent(rtrim($v[1] . LF . $v[2]), $maxLen + 4), strlen($v[0])) . LF);
                    }
                    $this->cli_echo(LF);
                    break;
                default:
                    $this->cli_echo($this->cli_indent($value, 4) . '

');
            }
        }
    }

    public function cli_indent($str, $indent)
    {
        $lines = explode(LF, wordwrap($str, 75 - $indent));
        $indentStr = str_pad('', $indent, ' ');
        foreach ($lines as $k => $v) {
            $lines[$k] = $indentStr . $lines[$k];
        }
        return implode(LF, $lines);
    }
}