BotRiconferme\Bot

Complexity

Total Complexity

15

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	runInternal()	0	21	4
A	run()	0	15	4
A	initialize()	0	12	1
A	initConfig()	0	9	2
A	createMainLogger()	0	23	2
A	__construct()	0	3	1
A	createWikiGroup()	0	17	1

<?php declare( strict_types=1 );

namespace BotRiconferme;

use BotRiconferme\Exception\MissingPageException;
use BotRiconferme\Logger\IFlushingAwareLogger;
use BotRiconferme\Logger\MultiLogger;
use BotRiconferme\Logger\SimpleLogger;
use BotRiconferme\Logger\WikiLogger;
use BotRiconferme\Request\RequestFactory;
use BotRiconferme\TaskHelper\TaskResult;
use BotRiconferme\Wiki\LoginInfo;
use BotRiconferme\Wiki\Page\Page;
use BotRiconferme\Wiki\Page\PageBotList;
use BotRiconferme\Wiki\Wiki;
use BotRiconferme\Wiki\WikiGroup;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;

/**
 * Higher-level class. It only wraps tasks executions, and contains generic data
 */
class Bot {
	/** @var LoggerInterface */
	private $mainLogger;
	/** @var WikiGroup */
	private $wikiGroup;
	/** @var MessageProvider */
	private $messageProvider;
	/** @var PageBotList */
	private $pageBotList;
	/** @var CLI */
	private $cli;

	/**
	 * @param CLI $cli
	 */
	public function __construct( CLI $cli ) {
		$this->cli = $cli;
		$this->initialize();
	}

	/**
	 * Initialize all members.
	 */
	private function initialize() : void {
		$simpleLogger = new SimpleLogger();
		$this->wikiGroup = $this->createWikiGroup( $simpleLogger );
		$this->messageProvider = new MessageProvider(
			$this->wikiGroup->getMainWiki(),
			$this->cli->getOpt( 'msg-title' )

It seems like $this->cli->getOpt('msg-title') can also be of type null; however, parameter $msgTitle of BotRiconferme\MessageProvider::__construct() does only seem to accept string, maybe add an additional type check?

		);
		$this->initConfig();
		$this->mainLogger = $this->createMainLogger( $simpleLogger );
		$this->pageBotList = PageBotList::get(
			$this->wikiGroup->getMainWiki(),
			$this->cli->getOpt( 'list-title' )
		);
	}

	/**
	 * Main entry point
	 */
	public function run() : void {
		$taskOpt = $this->cli->getTaskOpt();
		$type = current( array_keys( $taskOpt ) );
		try {
			if ( $type === 'task' ) {
				$this->runInternal( TaskManager::MODE_TASK, $taskOpt['task'] );
			} elseif ( $type === 'subtask' ) {
				$this->runInternal( TaskManager::MODE_SUBTASK, $taskOpt['subtask'] );
			} else {
				$this->runInternal();
			}
		} catch ( \Throwable $e ) {
			$this->mainLogger->error( $e->__toString() );
		} finally {
			$this->mainLogger->flush();

The method flush() does not exist on Psr\Log\LoggerInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Phan\Library\StderrLogger or Psr\Log\AbstractLogger or Symfony\Component\Console\Logger\ConsoleLogger or Psr\Log\NullLogger. Are you sure you never get one of those?

		}
	}

	/**
	 * @param LoggerInterface $baseLogger
	 * @return WikiGroup
	 */
	private function createWikiGroup( LoggerInterface $baseLogger ) : WikiGroup {
		// FIXME Hardcoded
		$url = $this->cli->getURL() ?? 'https://it.wikipedia.org/w/api.php';
		$localUserIdentifier = '@itwiki';
		$centralURL = 'https://meta.wikimedia.org/w/api.php';

		$loginInfo = new LoginInfo(
			$this->cli->getOpt( 'username' ),

It seems like $this->cli->getOpt('username') can also be of type null; however, parameter $username of BotRiconferme\Wiki\LoginInfo::__construct() does only seem to accept string, maybe add an additional type check?

			$this->cli->getOpt( 'password' )

It seems like $this->cli->getOpt('password') can also be of type null; however, parameter $password of BotRiconferme\Wiki\LoginInfo::__construct() does only seem to accept string, maybe add an additional type check?

		);

		$rf = new RequestFactory( $url );
		$wiki = new Wiki( $loginInfo, $baseLogger, $rf );
		$centralRF = new RequestFactory( $centralURL );
		$centralWiki = new Wiki( $loginInfo, $baseLogger, $centralRF );
		$centralWiki->setLocalUserIdentifier( $localUserIdentifier );
		return new WikiGroup( $wiki, $centralWiki );
	}

	/**
	 * FIXME SO MUCH DEPENDENCY HELL
	 *
	 * @param IFlushingAwareLogger $baseLogger
	 * @return IFlushingAwareLogger
	 */
	private function createMainLogger( IFlushingAwareLogger $baseLogger ) : IFlushingAwareLogger {
		$mainWiki = $this->wikiGroup->getMainWiki();
		$mp = $this->messageProvider;
		$errTitle = $this->cli->getOpt( 'error-title' );
		if ( $errTitle !== null ) {
			// Use a different Wiki with higher min level.
			$wikiLoggerLogger = new SimpleLogger( LogLevel::ERROR );
			$wikiLoggerWiki = new Wiki(
				$mainWiki->getLoginInfo(),
				$wikiLoggerLogger,
				$mainWiki->getRequestFactory()
			);
			$errPage = new Page( $errTitle, $wikiLoggerWiki );
			$wikiLogger = new WikiLogger(
				$errPage,
				$mp->getMessage( 'error-page-summary' )->text(),
				LogLevel::ERROR
			);
			$mainLogger = new MultiLogger( $baseLogger, $wikiLogger );
		} else {
			$mainLogger = $baseLogger;
		}
		return $mainLogger;
	}

	/**
	 * Create the Config
	 */
	private function initConfig() : void {
		$wiki = $this->wikiGroup->getMainWiki();
		try {
			$confValues = json_decode( $wiki->getPageContent( $this->cli->getOpt( 'config-title' ) ), true );

It seems like $this->cli->getOpt('config-title') can also be of type null; however, parameter $title of BotRiconferme\Wiki\Wiki::getPageContent() does only seem to accept string, maybe add an additional type check?

		} catch ( MissingPageException $_ ) {
			exit( 'Please create a config page.' );
		}

		Config::init( $confValues );
	}

	/**
	 * Internal call to TaskManager
	 *
	 * @param string $mode
	 * @param string|null $name
	 */
	private function runInternal(
		string $mode = TaskManager::MODE_COMPLETE,
		string $name = null
	) : void {
		$activity = $mode === TaskManager::MODE_COMPLETE ? TaskManager::MODE_COMPLETE : "$mode $name";
		$this->mainLogger->info( "Running $activity" );
		$manager = new TaskManager(
			$this->mainLogger,
			$this->wikiGroup,
			$this->messageProvider,
			$this->pageBotList
		);
		$res = $manager->run( $mode, $name );
		$base = "Execution of $activity";
		if ( $res->isOK() ) {
			$msg = $res->getStatus() === TaskResult::STATUS_NOTHING ?
				': nothing to do' :
				' completed successfully';
			$this->mainLogger->info( $base . $msg );
		} else {
			$this->mainLogger->error( "$base failed.\n$res" );
		}
	}
}