CiteHooks.php
No OneTemporary
Actions

Size

7 KB

Referenced Files

None

Subscribers

None

CiteHooks.php
View Options

	<?php
	/**
	* @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
	* @license MIT
	*/

	namespace Cite\Hooks;

	use Cite\ReferencePreviews\ReferencePreviewsContext;
	use Cite\ReferencePreviews\ReferencePreviewsGadgetsIntegration;
	use MediaWiki\Api\ApiQuerySiteinfo;
	use MediaWiki\Api\Hook\APIQuerySiteInfoGeneralInfoHook;
	use MediaWiki\Config\Config;
	use MediaWiki\EditPage\EditPage;
	use MediaWiki\Hook\EditPage__showEditForm_initialHook;
	use MediaWiki\Output\Hook\MakeGlobalVariablesScriptHook;
	use MediaWiki\Output\OutputPage;
	use MediaWiki\Registration\ExtensionRegistry;
	use MediaWiki\ResourceLoader\Hook\ResourceLoaderGetConfigVarsHook;
	use MediaWiki\ResourceLoader\Hook\ResourceLoaderRegisterModulesHook;
	use MediaWiki\ResourceLoader\ResourceLoader;
	use MediaWiki\Revision\Hook\ContentHandlerDefaultModelForHook;
	use MediaWiki\Title\Title;
	use MediaWiki\User\Options\UserOptionsLookup;
	use MediaWiki\User\User;

	/**
	* @license GPL-2.0-or-later
	* @phpcs:disable MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName
	*/
	class CiteHooks implements
	ContentHandlerDefaultModelForHook,
	MakeGlobalVariablesScriptHook,
	ResourceLoaderGetConfigVarsHook,
	ResourceLoaderRegisterModulesHook,
	APIQuerySiteInfoGeneralInfoHook,
	EditPage__showEditForm_initialHook
	{

	private ReferencePreviewsContext $referencePreviewsContext;
	private ReferencePreviewsGadgetsIntegration $gadgetsIntegration;
	private UserOptionsLookup $userOptionsLookup;

	public function __construct(
	ReferencePreviewsContext $referencePreviewsContext,
	ReferencePreviewsGadgetsIntegration $gadgetsIntegration,
	UserOptionsLookup $userOptionsLookup
	) {
	$this->referencePreviewsContext = $referencePreviewsContext;
	$this->gadgetsIntegration = $gadgetsIntegration;
	$this->userOptionsLookup = $userOptionsLookup;
	}

	/**
	* Convert the content model of a message that is actually JSON to JSON. This
	* only affects validation and UI when saving and editing, not loading the
	* content.
	*
	* @param Title $title
	* @param string &$model
	*/
	public function onContentHandlerDefaultModelFor( $title, &$model ) {
	if (
	$title->inNamespace( NS_MEDIAWIKI ) &&
	(
	$title->getText() == 'Visualeditor-cite-tool-definition.json' \|\|
	$title->getText() == 'Cite-tool-definition.json'
	)
	) {
	$model = CONTENT_MODEL_JSON;
	}
	}

	/**
	* @param array &$vars
	* @param OutputPage $out
	*/
	public function onMakeGlobalVariablesScript( &$vars, $out ): void {
	$vars['wgCiteReferencePreviewsActive'] = $this->referencePreviewsContext->isReferencePreviewsEnabled(
	$out->getUser(),
	$out->getSkin()
	);
	}

	/**
	* Adds extra variables to the global config
	* @param array &$vars `[ variable name => value ]`
	* @param string $skin
	* @param Config $config
	*/
	public function onResourceLoaderGetConfigVars( array &$vars, $skin, Config $config ): void {
	$vars['wgCiteVisualEditorOtherGroup'] = $config->get( 'CiteVisualEditorOtherGroup' );
	$vars['wgCiteResponsiveReferences'] = $config->get( 'CiteResponsiveReferences' );
	$vars['wgCiteBookReferencing'] = $config->get( 'CiteBookReferencing' );
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderRegisterModules
	*/
	public function onResourceLoaderRegisterModules( ResourceLoader $resourceLoader ): void {
	if ( !$resourceLoader->getConfig()->get( 'CiteReferencePreviews' ) \|\|
	!ExtensionRegistry::getInstance()->isLoaded( 'Popups' )
	) {
	return;
	}

	$resourceLoader->register( [
	'ext.cite.referencePreviews' => [
	'localBasePath' => dirname( __DIR__, 2 ) . '/modules/ext.cite.referencePreviews',
	'remoteExtPath' => 'Cite/modules/ext.cite.referencePreviews',
	'dependencies' => [
	'ext.popups.main',
	],
	'styles' => [
	'referencePreview.less',
	],
	'messages' => [
	'cite-reference-previews-reference',
	'cite-reference-previews-book',
	'cite-reference-previews-journal',
	'cite-reference-previews-news',
	'cite-reference-previews-note',
	'cite-reference-previews-web',
	'cite-reference-previews-collapsible-placeholder',
	],
	'packageFiles' => [
	'index.js',
	'constants.js',
	'createReferenceGateway.js',
	'createReferencePreview.js',
	'isReferencePreviewsEnabled.js',
	'referencePreviewsInstrumentation.js'
	]
	]
	] );
	}

	/**
	* Hook: APIQuerySiteInfoGeneralInfo
	*
	* Expose configs via action=query&meta=siteinfo
	*
	* @param ApiQuerySiteinfo $module
	* @param array &$results
	*/
	public function onAPIQuerySiteInfoGeneralInfo( $module, &$results ) {
	$results['citeresponsivereferences'] = $module->getConfig()->get( 'CiteResponsiveReferences' );
	}

	/**
	* Hook: EditPage::showEditForm:initial
	*
	* Add the module for WikiEditor
	*
	* @param EditPage $editPage the current EditPage object.
	* @param OutputPage $outputPage object.
	*/
	public function onEditPage__showEditForm_initial( $editPage, $outputPage ) {
	$extensionRegistry = ExtensionRegistry::getInstance();
	$allowedContentModels = array_merge(
	[ CONTENT_MODEL_WIKITEXT ],
	$extensionRegistry->getAttribute( 'CiteAllowedContentModels' )
	);
	if ( !in_array( $editPage->contentModel, $allowedContentModels ) ) {
	return;
	}

	$wikiEditorEnabled = $extensionRegistry->isLoaded( 'WikiEditor' );

	$user = $editPage->getContext()->getUser();

	if (
	$wikiEditorEnabled &&
	$this->userOptionsLookup->getBoolOption( $user, 'usebetatoolbar' )
	) {
	$outputPage->addModules( 'ext.cite.wikiEditor' );
	}
	}

	/**
	* Add options to user Preferences page
	*
	* @param User $user User whose preferences are being modified
	* @param array[] &$prefs Preferences description array, to be fed to a HTMLForm object
	*/
	public function onGetPreferences( $user, &$prefs ) {
	$option = [
	'type' => 'toggle',
	'label-message' => 'popups-refpreview-user-preference-label',
	// FIXME: This message is unnecessary and unactionable since we already
	// detect specific gadget conflicts.
	'help-message' => 'popups-prefs-conflicting-gadgets-info',
	// FIXME: copied from Popups
	'section' => 'rendering/reading',
	];
	$isNavPopupsGadgetEnabled = $this->gadgetsIntegration->isNavPopupsGadgetEnabled( $user );
	$isRefTooltipsGadgetEnabled = $this->gadgetsIntegration->isRefTooltipsGadgetEnabled( $user );
	if ( $isNavPopupsGadgetEnabled && $isRefTooltipsGadgetEnabled ) {
	$option[ 'disabled' ] = true;
	$option[ 'help-message' ] = [ 'popups-prefs-reftooltips-and-navpopups-gadget-conflict-info',
	'Special:Preferences#mw-prefsection-gadgets' ];
	} elseif ( $isNavPopupsGadgetEnabled ) {
	$option[ 'disabled' ] = true;
	$option[ 'help-message' ] = [ 'popups-prefs-navpopups-gadget-conflict-info',
	'Special:Preferences#mw-prefsection-gadgets' ];
	} elseif ( $isRefTooltipsGadgetEnabled ) {
	$option[ 'disabled' ] = true;
	$option[ 'help-message' ] = [ 'popups-prefs-reftooltips-gadget-conflict-info',
	'Special:Preferences#mw-prefsection-gadgets' ];
	}

	$prefs += [
	ReferencePreviewsContext::REFERENCE_PREVIEWS_PREFERENCE_NAME => $option
	];
	}

	/**
	* See https://www.mediawiki.org/wiki/Manual:Hooks/UserGetDefaultOptions
	* @param array &$defaultOptions Array of preference keys and their default values.
	*/
	public static function onUserGetDefaultOptions( &$defaultOptions ) {
	// FIXME: Move to extension.json once migration is complete. See T363162
	if ( !isset( $defaultOptions[ ReferencePreviewsContext::REFERENCE_PREVIEWS_PREFERENCE_NAME ] ) ) {
	$defaultOptions[ ReferencePreviewsContext::REFERENCE_PREVIEWS_PREFERENCE_NAME ] = '1';
	}
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Tue, Aug 18, 23:11 (1 d, 11 h)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: c1/80/545a259b604b40713a2b1130017d
Default Alt Text: CiteHooks.php (7 KB)

CiteHooks.phpNo OneTemporaryActions

CiteHooks.phpView Options

File Metadata

Event Timeline

CiteHooks.php
No OneTemporary
Actions

CiteHooks.php
View Options