mediawiki-extensions-SearchVue/src/Hooks.php

<?php

namespace SearchVue;

use MediaWiki\MediaWikiServices;
use MediaWiki\Search\SearchWidgets\FullSearchResultWidget;
use MediaWiki\SpecialPage\Hook\SpecialPageBeforeExecuteHook;
use OutputPage;
use SearchResultSet;
use SpecialPage;
use SpecialSearch;
use User;

/**
 * @license GPL-2.0-or-later
 */

class Hooks implements
	SpecialPageBeforeExecuteHook
{
	/**
	 * @var array holding the search result object.
	 */
	private $textMatches;

	/**
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/SpecialPageBeforeExecute
	 *
	 * @param SpecialPage $special
	 * @param string|null $subpage
	 * @return false|void false to abort the execution of the special page, "void" otherwise
	 */
	public function onSpecialPageBeforeExecute( $special, $subpage ) {
		if ( $special->getName() !== 'Search' ) {
			return;
		}

		$services = MediaWikiServices::getInstance();
		$userConfig = $services->getUserOptionsLookup();
		$searchPreviewEnabled = $userConfig->getBoolOption( $special->getUser(), 'searchpreview' );

		if ( $searchPreviewEnabled ) {
			$special->getOutput()->addModules( [
				'searchVue'
			] );

			$repositoryApiBaseUri = $services->getMainConfig()->get( 'QuickViewMediaRepositoryApiBaseUri' );
			$repositorySearchUri = $services->getMainConfig()->get( 'QuickViewMediaRepositorySearchUri' );
			$repositoryUri = $services->getMainConfig()->get( 'QuickViewMediaRepositoryUri' );
			$searchFilterForQID = $services->getMainConfig()->get( 'QuickViewSearchFilterForQID' );
			$enableMobile = $services->getMainConfig()->get( 'QuickViewEnableMobile' );
			$special->getOutput()->addJsConfigVars( [
				'wgQuickViewMediaRepositoryApiBaseUri' => $repositoryApiBaseUri,
				'wgQuickViewMediaRepositorySearchUri' => $repositorySearchUri,
				'wgQuickViewMediaRepositoryUri' => $repositoryUri,
				'wgQuickViewSearchFilterForQID' => $searchFilterForQID,
				'wgQuickViewEnableMobile' => $enableMobile
			] );
		}
	}

	/**
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/SpecialSearchResults
	 *
	 * @param string $term Search term
	 * @param SearchResultSet|null $titleMatches
	 * @param SearchResultSet|null $textMatches
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onSpecialSearchResults( $term, $titleMatches, $textMatches ) {
		$this->textMatches = $this->formatResult( $textMatches );
	}

	/**
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/SpecialSearchResultsAppend
	 *
	 * @param SpecialSearch $special SpecialSearch object ($this)
	 * @param OutputPage $out $wgOut
	 * @param string $term Search term specified by the user
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onSpecialSearchResultsAppend( $special, $out, $term ) {
		if ( $special->getName() !== 'Search' ) {
			return;
		}

		$out->addJsConfigVars(
			[
				'wgSpecialSearchTextMatches' => $this->textMatches,
			]
		);
	}

	/**
	 * Extract the searchResult information required by the extension UI
	 *
	 * @param SearchResultSet|null $resultSet
	 * @return array
	 */
	private function formatResult( $resultSet ) {
		if ( !$resultSet ) {
			return [];
		}

		$services = MediaWikiServices::getInstance();
		$thumbnailProvider = $services->getSearchResultThumbnailProvider();

		$formattedResultSet = [];

		foreach ( $resultSet as $result ) {
			if ( $result->getTitle() !== '' ) {
				$thumbnails = $thumbnailProvider->getThumbnails(
					[ $result->getTitle() ],
					FullSearchResultWidget::THUMBNAIL_SIZE
				);

				$formattedResult = $result->getTitle();
				$formattedResult->text = $result->getTextSnippet();
				if ( $thumbnails ) {
					$thumbnail = reset( $thumbnails );
					$formattedResult->thumbnail = [
						'width' => $thumbnail->getWidth(),
						'height' => $thumbnail->getHeight(),
					];
				}
				$formattedResultSet[] = $formattedResult;
			}
		}

		return $formattedResultSet;
	}

	/**
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences
	 * Adds a default-enabled preference to gate the feature
	 * @param User $user
	 * @param array &$prefs
	 */
	public static function onGetPreferences( $user, &$prefs ) {
		$prefs['searchpreview'] = [
			'type' => 'toggle',
			'section' => 'searchoptions/searchmisc',
			'label-message' => 'searchvue-label',
			'help-message' => 'searchvue-help',
		];

		$prefs['searchpreview-tutorial-enabled'] = [
			'type' => 'api'
		];
	}
}