BotRiconferme\CLI

Complexity

Total Complexity

19

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getTaskOpt()	0	4	1
A	isCLI()	0	2	1
A	getURL()	0	2	1
A	getOpt()	0	2	1
B	checkRequired()	0	19	11
A	__construct()	0	5	1
A	canonicalize()	0	5	2
A	getMainOpts()	0	4	1

<?php declare( strict_types=1 );

namespace BotRiconferme;

/**
 * CLI helper
 *
 * Example options:
 *
 * 'username' => 'BotRiconferme'
 * 'list-title' => 'Utente:BotRiconferme/List.json',
 * 'config-title' => 'Utente:BotRiconferme/Config.json',
 * 'msg-title' => 'Utente:BotRiconferme/Messages.json"
 *
 * --password=(BotPassword)
 * OR
 * --use-password-file
 * which will look for a $PWFILE file in the current directory containing only the plain password
 *
 * --task=update-list
 * OR
 * --subtask=user-notice
 */
class CLI {
	public const SHORT_OPTS = '';

	public const LONG_OPTS = [
		'username:',
		'list-title:',
		'config-title:',
		'msg-title:',

		'force-url:',

		'password:',
		'use-password-file',

		'error-title:',

		'task:',
		'subtask:'
	];

	public const REQUIRED_OPTS = [
		'username',
		'list-title',
		'config-title',
		'msg-title',
	];

	/** @todo Make it customizable? */
	public const PASSWORD_FILE = __DIR__ . '/password.txt';

	/** @var array */
	private $opts;

	/**
	 * @return bool
	 */
	public static function isCLI() : bool {
		return PHP_SAPI === 'cli';
	}

	/**
	 * Populate options and check for required ones
	 */
	public function __construct() {
		$opts = getopt( self::SHORT_OPTS, self::LONG_OPTS );
		$this->checkRequired( $opts );
		$this->canonicalize( $opts );
		$this->opts = $opts;
	}

	/**
	 * @param array $opts
	 */
	private function checkRequired( array $opts ) {
		foreach ( self::REQUIRED_OPTS as $opt ) {
			if ( !array_key_exists( $opt, $opts ) ) {
				exit( "Required option $opt missing." );

Using exit here is not recommended.

			}
		}

		if ( !array_key_exists( 'password', $opts ) && !array_key_exists( 'use-password-file', $opts ) ) {
			exit( 'Please provide a password or use a password file' );

Using exit here is not recommended.

		} elseif ( array_key_exists( 'password', $opts ) && array_key_exists( 'use-password-file', $opts ) ) {
			exit( 'Can only use one of "password" and "use-password-file"' );

Using exit here is not recommended.

		}

		if ( array_key_exists( 'use-password-file', $opts ) && !file_exists( self::PASSWORD_FILE ) ) {
			exit( 'Please create the password file (' . self::PASSWORD_FILE . ')' );

Using exit here is not recommended.

		}

		if ( array_key_exists( 'task', $opts ) && array_key_exists( 'subtask', $opts ) ) {
			exit( 'Cannot specify both task and subtask.' );

Using exit here is not recommended.

		}
	}

	/**
	 * @param array &$opts
	 */
	private function canonicalize( array &$opts ) {
		if ( array_key_exists( 'use-password-file', $opts ) ) {
			$pw = file_get_contents( self::PASSWORD_FILE );
			$opts['password'] = $pw;
			unset( $opts['use-password-file'] );
		}
	}

	/**
	 * These are the options required by Config.
	 * @return array
	 */
	public function getMainOpts() : array {
		return array_intersect_key(
			$this->opts,
			array_fill_keys( Config::REQUIRED_OPTS, true )
		);
	}

	/**
	 * @param string $opt
	 * @param mixed $default
	 * @return mixed
	 */
	public function getOpt( string $opt, $default = null ) {
		return $this->opts[$opt] ?? $default;
	}

	/**
	 * @return array Either [ 'task' => taskname ] or [ 'subtask' => subtaskname ]
	 */
	public function getTaskOpt() : array {
		return array_intersect_key(
			$this->opts,
			[ 'task' => true, 'subtask' => true ]
		);
	}

	/**
	 * @return string|null
	 */
	public function getURL() : ?string {
		return $this->getOpt( 'force-url' );
	}
}