Babel.php
No OneTemporary
Actions

Size

13 KB

Referenced Files

None

Subscribers

None

Babel.php
View Options

	<?php
	/**
	* Contains main code.
	*
	* @file
	* @author Robert Leverington
	* @author Robin Pepermans
	* @author Niklas Laxström
	* @author Brian Wolff
	* @author Purodha Blissenbach
	* @author Sam Reed
	* @author Siebrand Mazeland
	* @license GPL-2.0-or-later
	*/

	declare( strict_types = 1 );

	namespace MediaWiki\Babel;

	use MediaWiki\Babel\BabelBox\LanguageBabelBox;
	use MediaWiki\Babel\BabelBox\NotBabelBox;
	use MediaWiki\Babel\BabelBox\NullBabelBox;
	use MediaWiki\Config\Config;
	use MediaWiki\MediaWikiServices;
	use MediaWiki\Page\PageReference;
	use MediaWiki\Page\PageReferenceValue;
	use MediaWiki\Parser\Parser;
	use MediaWiki\Parser\ParserOutput;
	use MediaWiki\Title\Title;
	use MediaWiki\User\UserIdentity;
	use MediaWiki\WikiMap\WikiMap;

	/**
	* Main class for the Babel extension.
	*/
	class Babel {
	private PageReference $page;
	private Parser $parser;

	/**
	* Get a Config instance to use
	*
	* @todo Use proper Dependency Injection.
	* @return Config
	*/
	private static function getConfig(): Config {
	return BabelServices::wrap( MediaWikiServices::getInstance() )->getConfig();
	}

	/**
	* Render the Babel tower.
	*
	* @param Parser $parser
	* @param string ...$parameters
	* @return string Babel tower.
	*/
	public static function render( Parser $parser, string ...$parameters ): string {
	return ( new Babel( $parser ) )->doRender( $parameters );
	}

	private function __construct( Parser $parser ) {
	$this->parser = $parser;
	$this->page = $parser->getPage() ?? PageReferenceValue::localReference( NS_SPECIAL, 'BadTitle/Missing' );
	}

	/** @param string[] $parameters */
	private function doRender( array $parameters ): string {
	self::mTemplateLinkBatch( $parameters );

	$this->parser->getOutput()->addModuleStyles( [ 'ext.babel' ] );

	$content = $this->mGenerateContentTower( $parameters );

	if ( preg_match( '/^plain\s=\s\S/', reset( $parameters ) ) ) {
	return $content;
	}

	if ( self::getConfig()->get( 'BabelUseUserLanguage' ) ) {
	$uiLang = $this->parser->getOptions()->getUserLangObj();
	} else {
	$uiLang = $this->parser->getTargetLanguage();
	}

	$top = wfMessage( 'babel', $this->page->getDBkey() )->inLanguage( $uiLang );

	if ( $top->isDisabled() ) {
	$top = '';
	} else {
	$top = $top->text();
	$url = wfMessage( 'babel-url' )->inContentLanguage();
	if ( !$url->isDisabled() ) {
	$top = '[[' . $url->text() . '\|' . $top . ']]';
	}
	$top = '! class="mw-babel-header" \| ' . $top;
	}
	$footer = wfMessage( 'babel-footer', $this->page->getDBkey() )->inLanguage( $uiLang );

	$url = wfMessage( 'babel-footer-url' )->inContentLanguage();
	$showFooter = '';
	if ( !$footer->isDisabled() && !$url->isDisabled() ) {
	$showFooter = '! class="mw-babel-footer" \| [[' .
	$url->text() . '\|' . $footer->text() . ']]';
	}

	$tower = <<<EOT
	{\|class="mw-babel-wrapper"
	$top
	\|-
	\| $content
	\|-
	$showFooter
	\|}
	EOT;
	if ( self::getConfig()->get( 'BabelAllowOverride' ) ) {
	// Make sure the page shows up as transcluding MediaWiki:babel-category-override
	$title = Title::makeTitle( NS_MEDIAWIKI, "Babel-category-override" );
	$revision = $this->parser->fetchCurrentRevisionRecordOfTitle( $title );
	if ( $revision === null ) {
	$revid = null;
	} else {
	$revid = $revision->getId();
	}
	// Passing null here when the page doesn't exist matches what the core parser does
	// even though the documentation of the method says otherwise.
	// @phan-suppress-next-line PhanTypeMismatchArgumentNullable
	$this->parser->getOutput()->addTemplate( $title, $title->getArticleID(), $revid );
	}
	return $tower;
	}

	/**
	* @param string[] $parameters
	*
	* @return string Wikitext
	*/
	private function mGenerateContentTower( array $parameters ): string {
	$content = '';
	// collects name=value parameters to be passed to wiki templates.
	$templateParameters = [];
	$first = true;

	$generateCategories = !preg_match( '/^nocat\s=\s\S/', reset( $parameters ) );

	foreach ( $parameters as $name ) {
	if ( strpos( $name, '=' ) !== false ) {
	$templateParameters[] = $name;
	if ( !$first \|\| !preg_match( '/^(plain\|nocat)\s=\s\S/', $name ) ) {
	$this->parser->addTrackingCategory( "babel-template-params-category" );
	}
	continue;
	}

	$content .= $this->mGenerateContent( $name, $templateParameters, $generateCategories );
	$first = false;
	}

	return $content;
	}

	private static function setExtensionData(
	ParserOutput $parserOutput,
	string $code,
	string $level
	): void {
	$data = $parserOutput->getExtensionData( 'babel' ) ?: [];
	$data[ BabelLanguageCodes::getCategoryCode( $code ) ] = $level;
	$parserOutput->setExtensionData( 'babel', $data );
	}

	/**
	* @param string $name
	* @param string[] $templateParameters
	* @param bool $generateCategories Whether to add categories
	* @return string Wikitext
	*/
	private function mGenerateContent(
	string $name,
	array $templateParameters,
	bool $generateCategories
	): string {
	$components = self::mParseParameter( $name );

	$template = wfMessage( 'babel-template', $name )->inContentLanguage()->text();
	$parserOutput = $this->parser->getOutput();

	if ( $name === '' ) {
	$box = new NullBabelBox();
	} elseif ( $components !== false ) {
	// Valid parameter syntax (with lowercase language code), babel box
	$box = new LanguageBabelBox(
	self::getConfig(),
	$this->page,
	$this->parser->getTargetLanguage(),
	$components['code'],
	$components['level'],
	);
	self::setExtensionData( $parserOutput, $components['code'], $components['level'] );
	} elseif ( self::mPageExists( $template ) ) {
	// Check for an existing template
	$templateParameters[0] = $template;
	$template = implode( '\|', $templateParameters );
	$box = new NotBabelBox(
	$this->parser->getTargetLanguage()->getDir(),
	$this->parser->replaceVariables( "{{{$template}}}" )
	);
	} elseif ( self::mValidTitle( $template ) ) {
	// Non-existing page, so try again as a babel box,
	// with converting the code to lowercase
	$components2 = self::mParseParameter( $name, true );
	if ( $components2 !== false ) {
	$box = new LanguageBabelBox(
	self::getConfig(),
	$this->page,
	$this->parser->getTargetLanguage(),
	$components2['code'],
	$components2['level'],
	);
	self::setExtensionData( $parserOutput,
	$components2['code'], $components2['level'] );
	} else {
	// Non-existent page and invalid parameter syntax, red link.
	$box = new NotBabelBox(
	$this->parser->getTargetLanguage()->getDir(),
	'[[' . $template . ']]'
	);
	}
	} else {
	// Invalid title, output raw.
	$box = new NotBabelBox(
	$this->parser->getTargetLanguage()->getDir(),
	$template
	);
	}
	if ( $generateCategories ) {
	$box->addCategories( $parserOutput );
	}

	return $box->render();
	}

	/**
	* Performs a link batch on a series of templates.
	*
	* @param string[] $parameters Templates to perform the link batch on.
	*/
	protected static function mTemplateLinkBatch( array $parameters ): void {
	$titles = [];
	foreach ( $parameters as $name ) {
	$title = Title::newFromText( wfMessage( 'babel-template', $name )->inContentLanguage()->text() );
	if ( is_object( $title ) ) {
	$titles[] = $title;
	}
	}

	$batch = MediaWikiServices::getInstance()->getLinkBatchFactory()->newLinkBatch( $titles );
	$batch->setCaller( __METHOD__ );
	$batch->execute();
	}

	/**
	* Identify whether a page exists.
	*
	* @param string $name Name of the page to check.
	* @return bool Indication of whether the page exists.
	*/
	protected static function mPageExists( string $name ): bool {
	$titleObj = Title::newFromText( $name );

	return ( is_object( $titleObj ) && $titleObj->exists() );
	}

	/**
	* Identify whether the passed string would make a valid page name.
	*
	* @param string $name Name of the page to check.
	* @return bool Indication of whether the title is valid.
	*/
	protected static function mValidTitle( string $name ): bool {
	$titleObj = Title::newFromText( $name );

	return is_object( $titleObj );
	}

	/**
	* Parse a parameter, getting a language code and level.
	*
	* @param string $parameter Parameter.
	* @param bool $strtolower Whether to convert the language code to lowercase
	* @return array\|bool [ 'code' => xx, 'level' => xx ] false on failure
	*/
	protected static function mParseParameter( string $parameter, bool $strtolower = false ) {
	$return = [];

	$babelCode = $strtolower ? strtolower( $parameter ) : $parameter;
	// Try treating the parameter as a language code (for default level).
	$code = BabelLanguageCodes::getCode( $babelCode );
	if ( $code !== null ) {
	$return['code'] = $code;
	$return['level'] = self::getConfig()->get( 'BabelDefaultLevel' );
	return $return;
	}
	// Try splitting the parameter in to language and level, split on last hyphen.
	$lastSplit = strrpos( $parameter, '-' );
	if ( $lastSplit === false ) {
	return false;
	}
	$code = substr( $parameter, 0, $lastSplit );
	$level = substr( $parameter, $lastSplit + 1 );

	$babelCode = $strtolower ? strtolower( $code ) : $code;
	// Validate code.
	$return['code'] = BabelLanguageCodes::getCode( $babelCode );
	if ( $return['code'] === null ) {
	return false;
	}
	// Validate level.
	$level = strtoupper( $level );
	$categoryNames = self::getConfig()->get( 'BabelCategoryNames' );
	if ( !isset( $categoryNames[$level] ) ) {
	return false;
	}
	$return['level'] = $level;

	return $return;
	}

	/**
	* Gets the language information a user has set up with Babel.
	* This function gets the actual info directly from the database.
	* For performance, it is recommended to use
	* getCachedUserLanguageInfo instead.
	*
	* @param UserIdentity $user
	* @return string[] [ language code => level ], sorted by language code
	*/
	public static function getUserLanguageInfo( UserIdentity $user ): array {
	$userLanguageInfo = self::getUserLanguagesDB( $user );

	ksort( $userLanguageInfo );

	return $userLanguageInfo;
	}

	/**
	* Gets the language information a user has set up with Babel,
	* from the cache. It's recommended to use this when this will
	* be called frequently.
	*
	* @param UserIdentity $user
	* @return string[] [ language code => level ], sorted by language code
	*
	* @since Version 1.10.0
	*/
	public static function getCachedUserLanguageInfo( UserIdentity $user ): array {
	$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
	$userId = $user->getId();
	$key = $cache->makeKey( 'babel-local-languages', $userId );
	$checkKeys = [ $key ];
	$centralId = MediaWikiServices::getInstance()->getCentralIdLookupFactory()
	->getLookup()->centralIdFromLocalUser( $user );

	if ( $centralId ) {
	$checkKeys[] = $cache->makeGlobalKey( 'babel-central-languages', $centralId );
	}

	return $cache->getWithSetCallback(
	$key,
	$cache::TTL_MINUTE * 30,
	function ( $oldValue, &$ttl, array &$setOpts ) use ( $userId, $user ) {
	wfDebug( "Babel: cache miss for user $userId\n" );

	return self::getUserLanguageInfo( $user );
	},
	[
	'checkKeys' => $checkKeys,
	]
	);
	}

	/**
	* Gets only the languages codes list out of the user language info.
	*
	* @param string[] $languageInfo [ language code => level ], the return value of
	* getUserLanguageInfo.
	* @param string\|null $level Minimal level as given in $wgBabelCategoryNames
	* @return string[] List of language codes. Sorted by level if $level is not null,
	* otherwise sorted by language code
	*
	* @since Version 1.10.0
	*/
	private static function getLanguages( array $languageInfo, ?string $level ): array {
	if ( !$languageInfo ) {
	return [];
	}

	if ( $level !== null ) {
	// filter down the set, note that this uses a text sort!
	$languageInfo = array_filter(
	$languageInfo,
	static function ( $value ) use ( $level ) {
	return ( strcmp( $value, $level ) >= 0 );
	}
	);
	// sort and retain keys
	uasort(
	$languageInfo,
	static function ( $a, $b ) {
	return -strcmp( $a, $b );
	}
	);
	}

	return array_keys( $languageInfo );
	}

	/**
	* Gets the cached list of languages a user has set up with Babel.
	*
	* @param UserIdentity $user
	* @param string\|null $level Minimal level as given in $wgBabelCategoryNames
	* @return string[] List of language codes. Sorted by level if $level is not null,
	* otherwise sorted by language code
	*
	* @since Version 1.10.0
	*/
	public static function getCachedUserLanguages(
	UserIdentity $user,
	?string $level = null
	): array {
	return self::getLanguages( self::getCachedUserLanguageInfo( $user ), $level );
	}

	/**
	* Gets the list of languages a user has set up with Babel.
	* For performance reasons, it is recommended to use getCachedUserLanguages.
	*
	* @param UserIdentity $user
	* @param string\|null $level Minimal level as given in $wgBabelCategoryNames
	* @return string[] List of language codes. Sorted by level if $level is not null,
	* otherwise sorted by language code
	*
	* @since Version 1.9.0
	*/
	public static function getUserLanguages( UserIdentity $user, ?string $level = null ): array {
	return self::getLanguages( self::getUserLanguageInfo( $user ), $level );
	}

	private static function getUserLanguagesDB( UserIdentity $user ): array {
	$centralDb = self::getConfig()->get( 'BabelCentralDb' );

	$babelDB = new Database();
	$result = $babelDB->getForUser( $user->getId() );
	/** If local data or no central source, return */
	if ( $result \|\| !$centralDb ) {
	return $result;
	}

	if ( $centralDb === WikiMap::getCurrentWikiId() ) {
	// We are the central wiki, so no fallback we can do
	return [];
	}

	$lookup = MediaWikiServices::getInstance()->getCentralIdLookupFactory()->getLookup();
	if ( !$lookup->isAttached( $user )
	\|\| !$lookup->isAttached( $user, $centralDb )
	) {
	return [];
	}

	return $babelDB->getForRemoteUser( $centralDb, $user->getName() );
	}
	}

	class_alias( Babel::class, 'Babel' );

File Metadata

Mime Type: text/x-php
Expires: Oct 4 2026, 14:53 (5 w, 3 d ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 03/85/6fe296e468c41889891390160f42
Default Alt Text: Babel.php (13 KB)

Babel.phpNo OneTemporaryActions

Babel.phpView Options

File Metadata

Event Timeline

Babel.php
No OneTemporary
Actions

Babel.php
View Options