wikimedia/mediawiki-extensions-Wikibase

<?php

declare( strict_types = 1 );

namespace Wikibase\Repo\Hooks;

use MediaWiki\Language\Language;
use MediaWiki\Output\Hook\MakeGlobalVariablesScriptHook;
use MediaWiki\Output\OutputPage;
use Wikibase\Lib\ContentLanguages;
use Wikibase\Lib\SettingsArray;
use Wikibase\Lib\UserLanguageLookup;
use Wikibase\Repo\BabelUserLanguageLookup;
use Wikibase\Repo\Content\EntityContentFactory;
use Wikibase\Repo\Hooks\Helpers\OutputPageEntityViewChecker;
use Wikibase\Repo\Hooks\Helpers\UserPreferredContentLanguagesLookup;
use Wikibase\Repo\OutputPageJsConfigBuilder;

/**
 * @license GPL-2.0-or-later
 */
class MakeGlobalVariablesScriptHookHandler implements MakeGlobalVariablesScriptHook {

    /** @var OutputPageEntityViewChecker */
    private $entityViewChecker;

    /** @var OutputPageJsConfigBuilder */
    private $outputPageJsConfigBuilder;

    /** @var ContentLanguages */
    private $termsLanguages;

    /** @var UserLanguageLookup */
    private $userLanguageLookup;

    /** @var UserPreferredContentLanguagesLookup */
    private $userPreferredContentLanguagesLookup;

    /** @var string */
    private $dataRightsUrl;

    /** @var string */
    private $dataRightsText;

    /** @var string[] */
    private $badgeItems;

    /** @var int */
    private $stringLimit;

    /** @var bool */
    private $taintedReferencesEnabled;

    public function __construct(
        OutputPageEntityViewChecker $entityViewChecker,
        OutputPageJsConfigBuilder $outputPageJsConfigBuilder,
        ContentLanguages $termsLanguages,
        UserLanguageLookup $userLanguageLookup,
        UserPreferredContentLanguagesLookup $userPreferredContentLanguagesLookup,
        string $dataRightsUrl,
        string $dataRightsText,
        array $badgeItems,
        int $stringLimit,
        bool $taintedReferencesEnabled
    ) {
        $this->entityViewChecker = $entityViewChecker;
        $this->outputPageJsConfigBuilder = $outputPageJsConfigBuilder;
        $this->termsLanguages = $termsLanguages;
        $this->userLanguageLookup = $userLanguageLookup;
        $this->userPreferredContentLanguagesLookup = $userPreferredContentLanguagesLookup;
        $this->dataRightsUrl = $dataRightsUrl;
        $this->dataRightsText = $dataRightsText;
        $this->badgeItems = $badgeItems;
        $this->stringLimit = $stringLimit;
        $this->taintedReferencesEnabled = $taintedReferencesEnabled;
    }

    public static function factory(
        Language $contentLanguage,
        EntityContentFactory $entityContentFactory,
        SettingsArray $repoSettings,
        ContentLanguages $termsLanguages
    ): self {
        $userLanguageLookup = new BabelUserLanguageLookup();

        return new self(
            new OutputPageEntityViewChecker( $entityContentFactory ),
            new OutputPageJsConfigBuilder(),
            $termsLanguages,
            $userLanguageLookup,
            new UserPreferredContentLanguagesLookup(
                $termsLanguages,
                $userLanguageLookup,
                $contentLanguage->getCode()
            ),
            $repoSettings->getSetting( 'dataRightsUrl' ),
            $repoSettings->getSetting( 'dataRightsText' ),
            $repoSettings->getSetting( 'badgeItems' ),
            $repoSettings->getSetting( 'string-limits' )['multilang']['length'],
            $repoSettings->getSetting( 'taintedReferencesEnabled' )
        );
    }

    /**
     * @param array &$vars
     * @param OutputPage $out
     */
    public function onMakeGlobalVariablesScript( &$vars, $out ): void {
        if ( !$this->entityViewChecker->hasEntityView( $out ) ) {
            return;
        }

        $language = $out->getLanguage();
        $user = $out->getUser();
        // the languages that the server-side termbox was rendered with, in the same order
        $vars['wbUserPreferredContentLanguages'] = $this->userPreferredContentLanguagesLookup->getLanguages(
            $language->getCode(),
            $user
        );
        // the languages that the user explicitly specified,
        // used to determine whether client-side should show extra languages based on ULS data
        $vars['wbUserSpecifiedLanguages'] = array_values( array_intersect(
            $this->userLanguageLookup->getUserSpecifiedLanguages( $user ),
            $this->termsLanguages->getLanguages()
        ) );

        $vars += $this->outputPageJsConfigBuilder->build(
            $out,
            $this->dataRightsUrl,
            $this->dataRightsText,
            $this->badgeItems,
            $this->stringLimit,
            $this->taintedReferencesEnabled
        );
    }

}