Skins\Chameleon\Hooks\SetupAfterCache

Complexity

Total Complexity

32

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

95.15%

Importance

Changes	8
Bugs	2	Features	2

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	process()	0	10	1
A	adjustConfiguration()	0	6	2
A	setInstallPaths()	0	5	1
A	addLateSettings()	0	6	1
A	registerCommonBootstrapModules()	0	23	3
A	registerExternalLessModules()	0	15	3
A	registerExternalLessVariables()	0	9	3
A	hasConfiguration()	0	3	1
A	hasConfigurationOfTypeArray()	0	3	2
A	matchAssociativeElement()	0	8	2
A	isReadableFile()	0	8	2
B	addChameleonToVisualEditorSupportedSkins()	0	22	5
A	addResourceModules()	0	8	1
A	setLayoutFile()	0	11	4

<?php
/**
 * File containing the BeforeInitialize class
 *
 * This file is part of the MediaWiki skin Chameleon.
 *
 * @copyright 2013 - 2016, Stephan Gambke, mwjames
 * @license   GNU General Public License, version 3 (or any later version)
 *
 * The Chameleon skin 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 Chameleon skin 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 <http://www.gnu.org/licenses/>.
 *
 * @file
 * @ingroup Skins
 */

namespace Skins\Chameleon\Hooks;

use Bootstrap\BootstrapManager;
use RuntimeException;

/**
 * @see https://www.mediawiki.org/wiki/Manual:Hooks/SetupAfterCache
 *
 * @since 1.0
 *
 * @author mwjames
 * @author Stephan Gambke
 * @since 1.0
 * @ingroup Skins
 */
class SetupAfterCache {

	protected $bootstrapManager = null;
	protected $configuration = array();
	protected $request;

	/**
	 * @since  1.0
	 *
	 * @param BootstrapManager $bootstrapManager
	 * @param array $configuration
	 * @param \WebRequest $request
	 */
	public function __construct( BootstrapManager $bootstrapManager, array &$configuration, \WebRequest $request ) {
		$this->bootstrapManager = $bootstrapManager;
		$this->configuration = &$configuration;
		$this->request = $request;
	}

	/**
	 * @since  1.0
	 *
	 * @return self
	 */
	public function process() {

		$this->setInstallPaths();
		$this->addLateSettings();
		$this->registerCommonBootstrapModules();
		$this->registerExternalLessModules();
		$this->registerExternalLessVariables();

		return $this;
	}

	/**
	 * @since 1.0
	 *
	 * @param array $configuration
	 */
	public function adjustConfiguration( array &$configuration ) {

		foreach ( $this->configuration as $key => $value ) {
			$configuration[ $key ] = $value;
		}
	}

	/**
	 * Set local and remote base path of the Chameleon skin
	 */
	protected function setInstallPaths() {

		$this->configuration[ 'chameleonLocalPath' ] = $this->configuration['wgStyleDirectory'] . DIRECTORY_SEPARATOR . 'chameleon';
		$this->configuration[ 'chameleonRemotePath' ] = $this->configuration['wgStylePath'] . '/chameleon';
	}

	protected function addLateSettings() {

		$this->addChameleonToVisualEditorSupportedSkins();
		$this->addResourceModules();
		$this->setLayoutFile();
	}

	protected function registerCommonBootstrapModules() {

		$this->bootstrapManager->addAllBootstrapModules();

		if ( file_exists( $this->configuration[ 'wgStyleDirectory' ] . '/common/shared.css' ) ) { // MW < 1.24
			$this->bootstrapManager->addExternalModule(
				$this->configuration[ 'wgStyleDirectory' ] . '/common/shared.css',
				$this->configuration[ 'wgStylePath' ] . '/common/'
			);
		} else {
			if ( file_exists( $this->configuration[ 'IP' ] . '/resources/src/mediawiki.legacy/shared.css' ) ) { // MW >= 1.24
				$this->bootstrapManager->addExternalModule(
					$this->configuration[ 'IP' ] . '/resources/src/mediawiki.legacy/shared.css',
					$this->configuration[ 'wgScriptPath' ] . '/resources/src/mediawiki.legacy/'
				);
			}
		}

		$this->bootstrapManager->addExternalModule(
			$this->configuration[ 'chameleonLocalPath' ] . '/resources/styles/core.less',
			$this->configuration[ 'chameleonRemotePath' ] . '/resources/styles/'
		);
	}

	protected function registerExternalLessModules() {

		if ( $this->hasConfigurationOfTypeArray( 'egChameleonExternalStyleModules' ) ) {

			foreach ( $this->configuration[ 'egChameleonExternalStyleModules' ] as $localFile => $remotePath ) {

				list( $localFile, $remotePath ) = $this->matchAssociativeElement( $localFile, $remotePath );

				$this->bootstrapManager->addExternalModule(
					$this->isReadableFile( $localFile ),
					$remotePath
				);
			}
		}
	}

	protected function registerExternalLessVariables() {

		if ( $this->hasConfigurationOfTypeArray( 'egChameleonExternalLessVariables' ) ) {

			foreach ( $this->configuration[ 'egChameleonExternalLessVariables' ] as $key => $value ) {
				$this->bootstrapManager->setLessVariable( $key, $value );
			}
		}
	}

	/**
	 * @param $id
	 * @return bool
	 */
	private function hasConfiguration( $id ) {
		return isset( $this->configuration[ $id ] );
	}

	/**
	 * @param string $id
	 * @return bool
	 */
	private function hasConfigurationOfTypeArray( $id ) {
		return $this->hasConfiguration( $id ) && is_array( $this->configuration[ $id ] );
	}

	/**
	 * @param $localFile
	 * @param $remotePath
	 * @return array
	 */
	private function matchAssociativeElement( $localFile, $remotePath ) {

		if ( is_integer( $localFile ) ) {
			return array( $remotePath, '' );
		}

		return array( $localFile, $remotePath );
	}

	/**
	 * @param string $file
	 * @return string
	 */
	private function isReadableFile( $file ) {

		if ( is_readable( $file ) ) {
			return $file;
		}

		throw new RuntimeException( "Expected an accessible {$file} file" );
	}

	protected function addChameleonToVisualEditorSupportedSkins() {

		// if Visual Editor is installed and there is a setting to enable or disable it
		if ( $this->hasConfiguration( 'wgVisualEditorSupportedSkins' ) && $this->hasConfiguration( 'egChameleonEnableVisualEditor' ) ) {

			// if VE should be enabled
			if ( $this->configuration[ 'egChameleonEnableVisualEditor' ] === true ) {

				// if Chameleon is not yet in the list of VE-enabled skins
				if ( !in_array( 'chameleon', $this->configuration[ 'wgVisualEditorSupportedSkins' ] ) ) {
					$this->configuration[ 'wgVisualEditorSupportedSkins' ][] = 'chameleon';
				}

			} else {
				// remove all entries of Chameleon from the list of VE-enabled skins
				$this->configuration[ 'wgVisualEditorSupportedSkins' ] = array_diff(
					$this->configuration[ 'wgVisualEditorSupportedSkins' ],
					array( 'chameleon' )
				);
			}
		}
	}

	protected function addResourceModules() {
		$this->configuration[ 'wgResourceModules' ][ 'skin.chameleon.jquery-sticky' ] = array(
			'localBasePath'  => $this->configuration[ 'chameleonLocalPath' ] . '/resources/js',
			'remoteBasePath' => $this->configuration[ 'chameleonRemotePath' ] . '/resources/js',
			'group'          => 'skin.chameleon',
			'skinScripts'    => array( 'chameleon' => array( 'jquery-sticky/jquery.sticky.js', 'Components/Modifications/sticky.js' ) )
		);
	}

	protected function setLayoutFile() {

		$layout = $this->request->getVal( 'uselayout' );

		if ( $layout !== null &&
			$this->hasConfigurationOfTypeArray( 'egChameleonAvailableLayoutFiles' ) &&
			array_key_exists( $layout, $this->configuration[ 'egChameleonAvailableLayoutFiles' ] ) ) {

			$this->configuration[ 'egChameleonLayoutFile' ] = $this->configuration[ 'egChameleonAvailableLayoutFiles' ][ $layout ];
		}
	}

}