mediawiki-extensions-RevisionSlider/RevisionSlider.hooks.php

<?php
use MediaWiki\MediaWikiServices;

/**
 * RevisionSlider extension hooks
 *
 * @file
 * @ingroup Extensions
 * @license GPL-2.0+
 */
class RevisionSliderHooks {

	public static function onDiffViewHeader(
		DifferenceEngine $diff,
		Revision $oldRev,
		Revision $newRev
	) {
		$config = MediaWikiServices::getInstance()->getMainConfig();

		/**
		 * If this extension is configured to be a beta feature, and the BetaFeatures extension
		 * is loaded then require the current user to have the feature enabled.
		 */
		if (
			$config->get( 'RevisionSliderBetaFeature' ) &&
			class_exists( BetaFeatures::class ) &&
			!BetaFeatures::isFeatureEnabled( $diff->getUser(), 'revisionslider' )
		) {
			return true;
		}

		/**
		 * If the user is logged in and has explictly requested to disable the extension don't load.
		 */
		$user = $diff->getUser();
		if ( !$user->isAnon() && $user->getBoolOption( 'revisionslider-disable' ) ) {
			return true;
		}

		/**
		 * Do not show the RevisionSlider when revisions from two different pages are being compared
		 */
		if ( !$oldRev->getTitle()->equals( $newRev->getTitle() ) ) {
			return true;
		}

		$stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
		$stats->increment( 'RevisionSlider.event.hookinit' );

		$timeOffset = $config->get( 'LocalTZoffset' );
		if ( is_null( $config->get( 'Localtimezone' ) ) ) {
			$timeOffset = 0;
		} elseif ( is_null( $timeOffset ) ) {
			$timeOffset = 0;
		}

		$autoExpand = $user->getBoolOption( 'userjs-revslider-autoexpand' );

		$out = RequestContext::getMain()->getOutput();
		$out->addModules( 'ext.RevisionSlider.init' );
		$out->addModuleStyles( 'ext.RevisionSlider.noscript' );
		$out->addJsConfigVars( 'extRevisionSliderOldRev', $oldRev->getId() );
		$out->addJsConfigVars( 'extRevisionSliderNewRev', $newRev->getId() );
		$out->addJsConfigVars( 'extRevisionSliderTimeOffset', intval( $timeOffset ) );
		$out->enableOOUI();

		// FIXME: this really not nice to inject those elements to ButtonWidget like that
		// but this is only done to have inline styles set for those elements, so they are
		// rendered as intended before RL loads all CSS styles (avoid jumping after CSS is loaded).
		// Some better and more future-proof solution (what if ButtonWidget switches to use other tags?)
		// should be used if possible.
		$button = ( new OOUI\Tag( 'a' ) )->setAttributes( [ 'style' => 'width: 100%;' ] );
		$label = ( new OOUI\Tag( 'span' ) )->setAttributes( [ 'style' => 'line-height: 1.875em;' ] );
		$icon = ( new OOUI\Tag( 'span' ) )->setAttributes( [ 'style' => 'float: right;' ] );

		$toggleButton = new OOUI\ButtonWidget( [
			'label' => ( new Message( 'revisionslider-toggle-label' ) )->text(),
			'icon' => $autoExpand ? 'collapse' : 'expand',
			'button' => $button,
			'labelElement' => $label,
			'iconElement' => $icon,
			'classes' => [ 'mw-revslider-toggle-button' ],
			'infusable' => true,
			'framed' => false,
			'title' => ( new Message( 'revisionslider-toggle-title-expand' ) )->text(),
		] );
		$toggleButton->setAttributes(
			[ 'style' => 'width: 100%; text-align: center; padding-bottom: 0.06em; padding-top: 0.06em' ]
		);

		$progressBar = new OOUI\ProgressBarWidget( [ 'progress' => false ] );
		$progressBar->setAttributes( [
			'style' => 'margin: 0 auto;',
		] );

		$out->addHTML(
			Html::rawElement(
				'div',
				[
					'class' => 'mw-revslider-container',
					'style' => 'border: 1px solid #cccccc;'
				],
				$toggleButton .
				Html::rawElement(
					'div',
					[
						'class' => 'mw-revslider-slider-wrapper',
						'style' => 'min-height: 142px; border-top: 1px solid #cccccc; padding: 20px 10px;' .
							( !$autoExpand ? ' display: none;' : '' ),
					],
					Html::rawElement(
						'div',
						[
							'style' => 'text-align: center; margin-top: 60px;',
							'class' => 'mw-revslider-placeholder'
						],
						$progressBar
					)
				)
			)
		);
		return true;
	}

	public static function getBetaFeaturePreferences( User $user, array &$prefs ) {
		$config = MediaWikiServices::getInstance()->getMainConfig();
		$extensionAssetsPath = $config->get( 'ExtensionAssetsPath' );

		if ( $config->get( 'RevisionSliderBetaFeature' ) ) {
			$prefs['revisionslider'] = [
				'label-message' => 'revisionslider-beta-feature-message',
				'desc-message' => 'revisionslider-beta-feature-description',
				'screenshot' => [
					'ltr' => "$extensionAssetsPath/RevisionSlider/resources/RevisionSlider-beta-features-ltr.svg",
					'rtl' => "$extensionAssetsPath/RevisionSlider/resources/RevisionSlider-beta-features-rtl.svg",
				],
				'info-link' => 'https://www.mediawiki.org/wiki/Extension:RevisionSlider',
				'discussion-link' => 'https://www.mediawiki.org/wiki/Extension_talk:RevisionSlider',
			];
		}
	}

	public static function onResourceLoaderTestModules( array &$testModules, ResourceLoader $rl ) {
		$testModules['qunit']['ext.RevisionSlider.tests'] = [
			'scripts' => [
				'tests/qunit/QUnit.revisionSlider.testOrSkip.js',
				'tests/qunit/RevisionSlider.Revision.test.js',
				'tests/qunit/RevisionSlider.Pointer.test.js',
				'tests/qunit/RevisionSlider.PointerView.test.js',
				'tests/qunit/RevisionSlider.Slider.test.js',
				'tests/qunit/RevisionSlider.SliderView.test.js',
				'tests/qunit/RevisionSlider.RevisionList.test.js',
				'tests/qunit/RevisionSlider.RevisionListView.test.js',
				'tests/qunit/RevisionSlider.DiffPage.test.js',
				'tests/qunit/RevisionSlider.HelpDialog.test.js',
			],
			'dependencies' => [
				'ext.RevisionSlider.Revision',
				'ext.RevisionSlider.Pointer',
				'ext.RevisionSlider.PointerView',
				'ext.RevisionSlider.Slider',
				'ext.RevisionSlider.SliderView',
				'ext.RevisionSlider.RevisionList',
				'ext.RevisionSlider.RevisionListView',
				'ext.RevisionSlider.DiffPage',
				'ext.RevisionSlider.HelpDialog',
				'jquery.ui.draggable',
				'jquery.ui.tooltip',
				'oojs-ui'
			],
			'localBasePath' => __DIR__,
			'remoteExtPath' => 'RevisionSlider',
		];

		return true;
	}

	public static function onGetPreferences( User $user, array &$preferences ) {
		$config = MediaWikiServices::getInstance()->getMainConfig();
		if ( $config->get( 'RevisionSliderBetaFeature' ) ) {
			return true;
		}

		$preferences['revisionslider-disable'] = [
			'type' => 'toggle',
			'label-message' => 'revisionslider-preference-disable',
			'section' => 'rendering/diffs',
			'default' => $user->getBoolOption( 'revisionslider-disable' ),
		];

		return true;
	}
}