wikimedia/mediawiki-extensions-CirrusSearch

<?php

namespace CirrusSearch\Search;

use CirrusSearch\InterwikiResolver;
use CirrusSearch\Util;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Title\Title;
use MediaWiki\WikiMap\WikiMap;

/**
 * Utility class build MW Title from elastica Result/ResultSet classes
 * This class can be used in all classes that need to build a Title
 * by reading the elasticsearch output.
 */
class TitleHelper {
    /**
     * @var string
     */
    private $hostWikiID;

    /**
     * @var InterwikiResolver
     */
    private $interwikiResolver;

    /**
     * @var callable accepts a string and returns a string
     */
    private $linkSanitizer;

    /**
     * @param string|null $hostWikiID
     * @param InterwikiResolver|null $interwikiResolver
     * @param callable|null $linkSanitizer
     */
    public function __construct( $hostWikiID = null, InterwikiResolver $interwikiResolver = null, callable $linkSanitizer = null ) {
        $this->hostWikiID = $hostWikiID ?: WikiMap::getCurrentWikiId();
        $this->interwikiResolver = $interwikiResolver ?: MediaWikiServices::getInstance()->getService( InterwikiResolver::SERVICE );
        $this->linkSanitizer = $linkSanitizer ?: [ Sanitizer::class, 'escapeIdForLink' ];
    }

    /**
     * Create a title. When making interwiki titles we should be providing the
     * namespace text as a portion of the text, rather than a namespace id,
     * because namespace id's are not consistent across wiki's. This
     * additionally prevents the local wiki from localizing the namespace text
     * when it should be using the localized name of the remote wiki.
     *
     * @param \Elastica\Result $r int $namespace
     * @return Title
     */
    public function makeTitle( \Elastica\Result $r ): Title {
        $iwPrefix = $this->identifyInterwikiPrefix( $r );
        $titleFactory = MediaWikiServices::getInstance()->getTitleFactory();
        if ( $iwPrefix === null && $r->namespace !== null && $r->title !== null ) {
            return $titleFactory->makeTitle( $r->namespace, $r->title );
        }

        $nsPrefix = $r->namespace_text ? $r->namespace_text . ':' : '';
        return $titleFactory->makeTitle( 0, $nsPrefix . $r->title, '', $iwPrefix ?? '' );
    }

    /**
     * Build a Title to a redirect, this always works for internal titles.
     * For external titles we need to use the namespace_text which is only
     * valid if the redirect namespace is equals to the target title namespace.
     * If the namespaces do not match we return null.
     *
     * @param \Elastica\Result $r
     * @param string $redirectText
     * @param int $redirNamespace
     * @return Title|null the Title to the Redirect or null if we can't build it
     */
    public function makeRedirectTitle( \Elastica\Result $r, $redirectText, $redirNamespace ) {
        $iwPrefix = self::identifyInterwikiPrefix( $r );
        if ( $iwPrefix === null ) {
            return Title::makeTitle( $redirNamespace, $redirectText );
        }
        if ( $redirNamespace === $r->namespace ) {
            $nsPrefix = $r->namespace_text ? $r->namespace_text . ':' : '';
            return Title::makeTitle(
                0,
                $nsPrefix . $redirectText,
                '',
                $iwPrefix
            );
        } else {
            // redir namespace does not match, we can't
            // build this title.
            // The caller should fallback to the target title.
            return null;
        }
    }

    /**
     * @param \Elastica\Result $r
     * @return bool true if this result refers to an external Title
     */
    public function isExternal( \Elastica\Result $r ) {
        if ( isset( $r->wiki ) && $r->wiki !== $this->hostWikiID ) {
            return true;
        }
        // no wiki is suspicious, should we log a warning?
        return false;
    }

    /**
     * @param \Elastica\Result $r
     * @return string|null the interwiki prefix for this result or null or
     * empty if local.
     */
    private function identifyInterwikiPrefix( $r ) {
        if ( isset( $r->wiki ) && $r->wiki !== $this->hostWikiID ) {
            return $this->interwikiResolver->getInterwikiPrefix( $r->wiki );
        }
        // no wiki is suspicious, should we log something?
        return null;
    }

    /**
     * @param string $id
     * @return string
     */
    public function sanitizeSectionFragment( $id ) {
        return ( $this->linkSanitizer )( $id );
    }

    /**
     * @param Title $title
     * @return string
     */
    public function getNamespaceText( Title $title ) {
        return Util::getNamespaceText( $title );
    }
}