BootstrapComponents\Setup

Complexity

Total Complexity

34

Size/Duplication

Total Lines	413
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

93.75%

Importance

Changes	1
Bugs	1	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	onExtensionLoad()	0	6	1
A	__construct()	0	14	2
A	buildHookCallbackListFor()	0	12	3
A	clear()	0	5	2
B	createParserFirstCallInitCallback()	0	28	4
A	createParserHookCallbackFor()	0	17	1
A	prepareEnvironment()	0	3	1
B	compileRequestedHooksListFor()	0	15	5
B	getCompleteHookDefinitionList()	0	77	3
A	initializeApplications()	0	8	1
A	isRegistered()	0	3	1
A	register()	0	6	2
A	registerMyConfiguration()	0	3	1
A	run()	0	10	1
A	assertExtensionBootstrapPresent()	0	7	2
A	createImageBeforeProduceHTMLCallback()	0	16	3
A	createInternalParseBeforeLinksCallback()	0	12	1

<?php
/**
 * Contains the class doing preparing the environment and registering the needed/wanted hooks.
 *
 * @copyright (C) 2018, Tobias Oetterer, Paderborn University
 * @license       https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License, version 3 (or later)
 *
 * This file is part of the MediaWiki extension BootstrapComponents.
 * The BootstrapComponents extension 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.
 *
 * The BootstrapComponents extension 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 this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * @file
 * @ingroup       BootstrapComponents
 * @author        Tobias Oetterer
 */

namespace BootstrapComponents;

use \Bootstrap\BootstrapManager;
use \Hooks;
use \MagicWord;
use \MediaWiki\MediaWikiServices;
use \MWException;
use \Parser;
use \ReflectionClass;

/**
 * Class Setup
 *
 * Registers all hooks and components for Extension BootstrapComponents.
 *
 * Information on how to add an additional hook
 *  1. add it to {@see Setup::AVAILABLE_HOOKS}.
 *  2. add an appropriate entry in the array inside {@see Setup::getCompleteHookDefinitionList}
 *     with the hook as array key and the callback as value.
 *  3. have {@see Setup::compileRequestedHooksListFor} add the hook to its result array. Based on
 *     a certain condition, if necessary.
 *  4. add appropriate tests to {@see \BootstrapComponents\Tests\Unit\SetupTest}.
 *
 * @since 1.0
 */
class Setup {

	/**
	 * @var array
	 */
	const AVAILABLE_HOOKS = [
		'GalleryGetModes', 'ImageBeforeProduceHTML', 'InternalParseBeforeLinks',
		'ParserBeforeTidy', 'ParserFirstCallInit', 'ScribuntoExternalLibraries',
		'SetupAfterCache'
	];

	/**
	 * @var ComponentLibrary
	 */
	private $componentLibrary;

	/**
	 * @var \Config
	 */
	private $myConfig;

	/**
	 * @var NestingController
	 */
	private $nestingController;

	/**
	 * Callback function when extension is loaded via extension.json or composer.
	 *
	 * Note: With this we omit hook registration in extension.json and define our own here
	 * to better allow for unit testing.
	 *
	 * @param array $info
	 *
	 * @throws \ConfigException cascading {@see Setup::run}
	 * @throws \MWException cascading {@see Setup::__construct()} and {@see Setup::run}
	 *
	 * @return bool
	 */
	public static function onExtensionLoad( $info ) {
		$setup = new self( $info );

		$setup->run();
		return true;
	}

	/**
	 * Setup constructor.
	 *
	 * @param $info
	 *
	 * @throws \ConfigException cascading {@see \BootstrapComponents\Setup::getHooksToRegister}
	 * @throws \MWException cascading {@see \BootstrapComponents\Setup::getHooksToRegister}
	 *
	 */
	public function __construct( $info ) {

		$this->assertExtensionBootstrapPresent();

		if ( !empty( $info['version'] ) ) {
			$this->prepareEnvironment( $info['version'] );
		}

		$configFactory = MediaWikiServices::getInstance()->getConfigFactory();
		$this->registerMyConfiguration( $configFactory );
		$this->myConfig = $configFactory->makeConfig( 'BootstrapComponents' );

		list( $this->componentLibrary, $this->nestingController ) = $this->initializeApplications( $this->myConfig );
	}

	/**
	 * @param array $hooksToRegister
	 *
	 * @return array
	 */
	public function buildHookCallbackListFor( $hooksToRegister ) {
		$hookCallbackList = [];
		$completeHookDefinitionList = $this->getCompleteHookDefinitionList(
			$this->myConfig, $this->componentLibrary, $this->nestingController
		);
		foreach ( $hooksToRegister as $requestedHook ) {
			if ( isset( $completeHookDefinitionList[$requestedHook] ) ) {
				$hookCallbackList[$requestedHook] = $completeHookDefinitionList[$requestedHook];
			}
		}
		return $hookCallbackList;
	}

	/**
	 * @throws \MWException cascading {@see \Hooks::clear}
	 */
	public function clear() {
		foreach ( self::AVAILABLE_HOOKS as $name ) {
			Hooks::clear( $name );
		}
	}

	/**
	 * @param \Config $myConfig
	 *
	 * @throws \ConfigException cascading {@see \Config::get}
	 *
	 * @return string[]
	 */
	public function compileRequestedHooksListFor( $myConfig ) {
		$requestedHookList = [ 'ParserBeforeTidy', 'ParserFirstCallInit', 'SetupAfterCache', 'ScribuntoExternalLibraries' ];
		if ( $myConfig->has( 'BootstrapComponentsEnableCarouselGalleryMode' )
			&& $myConfig->get( 'BootstrapComponentsEnableCarouselGalleryMode' )
		) {
			$requestedHookList[] = 'GalleryGetModes';
		}
		if ( $myConfig->has( 'BootstrapComponentsModalReplaceImageTag' )
			&& $myConfig->get( 'BootstrapComponentsModalReplaceImageTag' )
		) {
			$requestedHookList[] = 'ImageBeforeProduceHTML';
			$requestedHookList[] = 'InternalParseBeforeLinks';
		}
		return $requestedHookList;
	}

	/**
	 * @param \Config           $myConfig
	 * @param ComponentLibrary  $componentLibrary
	 * @param NestingController $nestingController
	 *
	 * @return \Closure[]
	 */
	public function getCompleteHookDefinitionList( $myConfig, $componentLibrary, $nestingController ) {
		return [
			/**
			 * Hook: GalleryGetModes
			 *
			 * Allows extensions to add classes that can render different modes of a gallery.
			 *
			 * @see https://www.mediawiki.org/wiki/Manual:Hooks/GalleryGetModes
			 */
			'GalleryGetModes'          => function( &$modeArray ) {
				$modeArray['carousel'] = 'BootstrapComponents\\CarouselGallery';
				return true;
			},

			/**
			 * Hook: ImageBeforeProduceHTML
			 *
			 * Called before producing the HTML created by a wiki image insertion
			 *
			 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ImageBeforeProduceHTML
			 */
			'ImageBeforeProduceHTML'   => $this->createImageBeforeProduceHTMLCallback( $nestingController, $myConfig ),

			/**
			 * Hook: InternalParseBeforeLinks
			 *
			 * Used to process the expanded wiki code after <nowiki>, HTML-comments, and templates have been treated.
			 *
			 * @see https://www.mediawiki.org/wiki/Manual:Hooks/InternalParseBeforeLinks
			 */
			'InternalParseBeforeLinks' => $this->createInternalParseBeforeLinksCallback(),

			/**
			 * Hook: ParserBeforeTidy
			 *
			 * Used to process the nearly-rendered html code for the page (but before any html tidying occurs).
			 *
			 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ParserBeforeTidy
			 */
			'ParserBeforeTidy'         => function( \Parser &$parser, &$text, $parserOutputHelper = null ) {
				// injects right before the tidy marker report (e.g. <!-- Tidy found no errors -->), at the very end of the wiki text content
				if ( is_null( $parserOutputHelper ) ) {
					$parserOutputHelper = ApplicationFactory::getInstance()->getParserOutputHelper( $parser );
				}
				$text .= $parserOutputHelper->getContentForLaterInjection();
				return true;
			},

			/**
			 * Hook: ParserFirstCallInit
			 *
			 * Called when the parser initializes for the first time.
			 *
			 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit
			 */
			'ParserFirstCallInit'      => $this->createParserFirstCallInitCallback( $componentLibrary, $nestingController ),

			'ScribuntoExternalLibraries' => function( $engine, &$extraLibraries ) {
				if ( $engine == 'lua' ) {
					$extraLibraries['mw.bootstrap'] = 'BootstrapComponents\\LuaLibrary';
				}
				return true;
			},

			/**
			 * Hook: SetupAfterCache
			 *
			 * Called in Setup.php, after cache objects are set
			 *
			 * @see https://www.mediawiki.org/wiki/Manual:Hooks/SetupAfterCache
			 */
			'SetupAfterCache'          => function() {
				BootstrapManager::getInstance()->addAllBootstrapModules();
				return true;
			},
		];
	}

	/**
	 * @param \Config $myConfig
	 *
	 * @throws \MWException cascading {@see \BootstrapComponents\ApplicationFactory} calls
	 * @throws \ConfigException cascading {@see \Config::get}
	 *
	 * @return array
	 */
	public function initializeApplications( $myConfig ) {
		$applicationFactory = ApplicationFactory::getInstance();
		$componentLibrary = $applicationFactory->getComponentLibrary(
			$myConfig->get( 'BootstrapComponentsWhitelist' )
		);
		$nestingController = $applicationFactory->getNestingController();
		return [ $componentLibrary, $nestingController ];
	}

	/**
	 * @param string $hook
	 *
	 * @return boolean
	 */
	public function isRegistered( $hook ) {
		return Hooks::isRegistered( $hook );
	}

	/**
	 * @param array $hookList
	 *
	 * @return int
	 */
	public function register( $hookList ) {
		foreach ( $hookList as $hook => $callback ) {
			Hooks::register( $hook, $callback );
		}
		return count( $hookList );
	}

	/**
	 * @param \ConfigFactory $configFactory
	 * Registers my own configuration, so that it is present during onLoad. See phabricator issue T184837
	 *
	 * @see https://phabricator.wikimedia.org/T184837
	 */
	public function registerMyConfiguration( $configFactory ) {
		$configFactory->register( 'BootstrapComponents', 'GlobalVarConfig::newInstance' );
	}

	/**
	 * Executes the setup process.
	 *
	 * @throws \ConfigException
	 *
	 * @return int
	 */
	public function run() {
		$requestedHooks = $this->compileRequestedHooksListFor(
			$this->myConfig
		);
		$hookCallbackList = $this->buildHookCallbackListFor(
			$requestedHooks
		);

		return $this->register( $hookCallbackList );
	}

	/**
	 * @throws \MWException
	 */
	private function assertExtensionBootstrapPresent() {
		if ( !defined( 'BS_VERSION' ) ) {
			echo 'The BootstrapComponents extension requires Extension Bootstrap to be installed. '
				. 'Please check <a href="https://github.com/oetterer/BootstrapComponents/">the online help</a>' . PHP_EOL;
			throw new MWException( 'BootstrapComponents needs extension Bootstrap present.' );
		}
	}

	/**
	 * Callback for Hook: ImageBeforeProduceHTML
	 *
	 * Called before producing the HTML created by a wiki image insertion
	 *
	 * @param NestingController $nestingController
	 * @param \Config           $myConfig
	 *
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ImageBeforeProduceHTML
	 *
	 * @return \Closure
	 */
	private function createImageBeforeProduceHTMLCallback( $nestingController, $myConfig ) {

		return function( &$dummy, &$title, &$file, &$frameParams, &$handlerParams, &$time, &$res
		) use ( $nestingController, $myConfig ) {

			$imageModal = new ImageModal( $dummy, $title, $file, $nestingController );

			if ( $myConfig->has( 'BootstrapComponentsDisableSourceLinkOnImageModal' )
				&& $myConfig->get( 'BootstrapComponentsDisableSourceLinkOnImageModal' )
			) {
				$imageModal->disableSourceLink();
			}

			return $imageModal->parse( $frameParams, $handlerParams, $time, $res );
		};
	}

	/**
	 * Callback for Hook: InternalParseBeforeLinks
	 *
	 * Used to process the expanded wiki code after <nowiki>, HTML-comments, and templates have been treated.
	 *
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/InternalParseBeforeLinks
	 *
	 * @return \Closure
	 */
	private function createInternalParseBeforeLinksCallback() {
		return function( Parser &$parser, &$text ) {
			$mw = MagicWord::get( 'BSC_NO_IMAGE_MODAL' );
			// we do not use our ParserOutputHelper class here, for we would need to reset it in integration tests.
			// resetting our factory build classes is unfortunately a little skittish
			$parser->getOutput()->setExtensionData(
				'bsc_no_image_modal',
				$mw->matchAndRemove( $text )
			);
			return true;
		};
	}

	/**
	 * Callback for Hook: ParserFirstCallInit
	 *
	 * Called when the parser initializes for the first time.
	 *
	 * @param ComponentLibrary  $componentLibrary
	 * @param NestingController $nestingController
	 *
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit
	 *
	 * @return \Closure
	 */
	private function createParserFirstCallInitCallback( $componentLibrary, $nestingController ) {

		return function( Parser $parser ) use ( $componentLibrary, $nestingController ) {

			$parserOutputHelper = ApplicationFactory::getInstance()->getParserOutputHelper( $parser );

			foreach ( $componentLibrary->getRegisteredComponents() as $componentName ) {

				$parserHookString = $componentLibrary::compileParserHookStringFor( $componentName );
				$callback = $this->createParserHookCallbackFor(
					$componentName, $componentLibrary, $nestingController, $parserOutputHelper
				);

				if ( $componentLibrary->isParserFunction( $componentName ) ) {
					$parser->setFunctionHook( $parserHookString, $callback );
				} elseif ( $componentLibrary->isTagExtension( $componentName ) ) {
					$parser->setHook( $parserHookString, $callback );
				} else {
					wfDebugLog(
						'BootstrapComponents',
						'Unknown handler type (' . $componentLibrary->getHandlerTypeFor( $componentName )
						. ') detected for component ' . $parserHookString
					);
				}
			}
			return true;
		};
	}

	/**
	 * Creates the callback to be registered with {@see \Parser::setFunctionHook} or {@see \Parser::setHook}.
	 *
	 * @param string             $componentName
	 * @param ComponentLibrary   $componentLibrary
	 * @param NestingController  $nestingController
	 * @param ParserOutputHelper $parserOutputHelper
	 *
	 * @return \Closure
	 */
	private function createParserHookCallbackFor( $componentName, $componentLibrary, $nestingController, $parserOutputHelper ) {

		return function() use ( $componentName, $componentLibrary, $nestingController, $parserOutputHelper ) {

			$componentClass = $componentLibrary->getClassFor( $componentName );
			$objectReflection = new ReflectionClass( $componentClass );
			$object = $objectReflection->newInstanceArgs( [ $componentLibrary, $parserOutputHelper, $nestingController ] );

			$parserRequest = ApplicationFactory::getInstance()->getNewParserRequest(
				func_get_args(),
				$componentLibrary->isParserFunction( $componentName ),
				$componentName
			);
			/** @var AbstractComponent $object */
			return $object->parseComponent( $parserRequest );
		};
	}

	/**
	 * Version number retrieved from extension info array.
	 *
	 * @param string $version
	 *
	 * @return bool
	 */
	private function prepareEnvironment( $version ) {
		return @define( 'BOOTSTRAP_COMPONENTS_VERSION', (string) $version );
	}
}