'LanguageAz' => __DIR__ . '/languages/classes/LanguageAz.php',
'LanguageBe_tarask' => __DIR__ . '/languages/classes/LanguageBe_tarask.php',
'LanguageBs' => __DIR__ . '/languages/classes/LanguageBs.php',
- 'LanguageCode' => __DIR__ . '/languages/LanguageCode.php',
+ 'LanguageCode' => __DIR__ . '/includes/language/LanguageCode.php',
'LanguageConverter' => __DIR__ . '/languages/LanguageConverter.php',
'LanguageCrh' => __DIR__ . '/languages/classes/LanguageCrh.php',
'LanguageCu' => __DIR__ . '/languages/classes/LanguageCu.php',
'MergeLogFormatter' => __DIR__ . '/includes/logging/MergeLogFormatter.php',
'MergeMessageFileList' => __DIR__ . '/maintenance/mergeMessageFileList.php',
'MergeableUpdate' => __DIR__ . '/includes/deferred/MergeableUpdate.php',
- 'Message' => __DIR__ . '/includes/Message.php',
+ 'Message' => __DIR__ . '/includes/language/Message.php',
'MessageBlobStore' => __DIR__ . '/includes/resourceloader/MessageBlobStore.php',
'MessageCache' => __DIR__ . '/includes/cache/MessageCache.php',
'MessageCacheUpdate' => __DIR__ . '/includes/deferred/MessageCacheUpdate.php',
'MessageContent' => __DIR__ . '/includes/content/MessageContent.php',
- 'MessageLocalizer' => __DIR__ . '/languages/MessageLocalizer.php',
+ 'MessageLocalizer' => __DIR__ . '/includes/language/MessageLocalizer.php',
'MessageSpecifier' => __DIR__ . '/includes/libs/MessageSpecifier.php',
'MigrateActors' => __DIR__ . '/maintenance/includes/MigrateActors.php',
'MigrateArchiveText' => __DIR__ . '/maintenance/migrateArchiveText.php',
'ResetUserTokens' => __DIR__ . '/maintenance/resetUserTokens.php',
'ResourceFileCache' => __DIR__ . '/includes/cache/ResourceFileCache.php',
'ResourceLoader' => __DIR__ . '/includes/resourceloader/ResourceLoader.php',
+ 'ResourceLoaderCircularDependencyError' => __DIR__ . '/includes/resourceloader/ResourceLoaderCircularDependencyError.php',
'ResourceLoaderClientHtml' => __DIR__ . '/includes/resourceloader/ResourceLoaderClientHtml.php',
'ResourceLoaderContext' => __DIR__ . '/includes/resourceloader/ResourceLoaderContext.php',
'ResourceLoaderFileModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderFileModule.php',
use MediaWiki\Logger\LoggerFactory;
use Psr\Log\LoggerInterface;
use MediaWiki\MediaWikiServices;
+use Wikimedia\Rdbms\ILBFactory;
use Wikimedia\Rdbms\ChronologyProtector;
-use Wikimedia\Rdbms\LBFactory;
use Wikimedia\Rdbms\DBConnectionError;
use Liuggio\StatsdClient\Sender\SocketSender;
public static function preOutputCommit(
IContextSource $context, callable $postCommitWork = null
) {
- // Either all DBs should commit or none
- ignore_user_abort( true );
-
$config = $context->getConfig();
$request = $context->getRequest();
$output = $context->getOutput();
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
- // Commit all changes
+ // Try to make sure that all RDBMs, session, and other storage updates complete
+ ignore_user_abort( true );
+
+ // Commit all RDBMs changes from the main transaction round
$lbFactory->commitMasterChanges(
__METHOD__,
// Abort if any transaction was too big
);
wfDebug( __METHOD__ . ': primary transaction round committed' );
- // Run updates that need to block the user or affect output (this is the last chance)
+ // Run updates that need to block the client or affect output (this is the last chance)
DeferredUpdates::doUpdates( 'run', DeferredUpdates::PRESEND );
wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
- // T214471: persist the session to avoid race conditions on subsequent requests
- $request->getSession()->save();
-
- // Should the client return, their request should observe the new ChronologyProtector
- // DB positions. This request might be on a foreign wiki domain, so synchronously update
- // the DB positions in all datacenters to be safe. If this output is not a redirect,
- // then OutputPage::output() will be relatively slow, meaning that running it in
- // $postCommitWork should help mask the latency of those updates.
- $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
- $strategy = 'cookie+sync';
-
- $allowHeaders = !( $output->isDisabled() || headers_sent() );
- if ( $output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
- // OutputPage::output() will be fast, so $postCommitWork is useless for masking
- // the latency of synchronously updating the DB positions in all datacenters.
- // Try to make use of the time the client spends following redirects instead.
- $domainDistance = self::getUrlDomainDistance( $output->getRedirect() );
- if ( $domainDistance === 'local' && $allowHeaders ) {
- $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
- $strategy = 'cookie'; // use same-domain cookie and keep the URL uncluttered
- } elseif ( $domainDistance === 'remote' ) {
- $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
- $strategy = 'cookie+url'; // cross-domain cookie might not work
- }
- }
-
+ // Persist the session to avoid race conditions on subsequent requests by the client
+ $request->getSession()->save(); // T214471
+ wfDebug( __METHOD__ . ': session changes committed' );
+
+ // Figure out whether to wait for DB replication now or to use some method that assures
+ // that subsequent requests by the client will use the DB replication positions written
+ // during the shutdown() call below; the later requires working around replication lag
+ // of the store containing DB replication positions (e.g. dynomite, mcrouter).
+ list( $flags, $strategy ) = self::getChronProtStrategy( $lbFactory, $output );
// Record ChronologyProtector positions for DBs affected in this request at this point
$cpIndex = null;
$cpClientId = null;
$lbFactory->shutdown( $flags, $postCommitWork, $cpIndex, $cpClientId );
wfDebug( __METHOD__ . ': LBFactory shutdown completed' );
+ $allowHeaders = !( $output->isDisabled() || headers_sent() );
if ( $cpIndex > 0 ) {
if ( $allowHeaders ) {
$now = time();
$expires = $now + ChronologyProtector::POSITION_COOKIE_TTL;
$options = [ 'prefix' => '' ];
- $value = LBFactory::makeCookieValueFromCPIndex( $cpIndex, $now, $cpClientId );
+ $value = $lbFactory::makeCookieValueFromCPIndex( $cpIndex, $now, $cpClientId );
$request->response()->setCookie( 'cpPosIndex', $value, $expires, $options );
}
}
}
- // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
- // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
- // ChronologyProtector works for cacheable URLs.
- if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
- $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
- $options = [ 'prefix' => '' ];
- $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
- $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
- }
+ if ( $allowHeaders ) {
+ // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that
+ // handles this POST request (e.g. the "master" data center). Also have the user
+ // briefly bypass CDN so ChronologyProtector works for cacheable URLs.
+ if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
+ $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
+ $options = [ 'prefix' => '' ];
+ $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
+ $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
+ }
+
+ // Avoid letting a few seconds of replica DB lag cause a month of stale data.
+ // This logic is also intimately related to the value of $wgCdnReboundPurgeDelay.
+ if ( $lbFactory->laggedReplicaUsed() ) {
+ $maxAge = $config->get( 'CdnMaxageLagged' );
+ $output->lowerCdnMaxage( $maxAge );
+ $request->response()->header( "X-Database-Lagged: true" );
+ wfDebugLog( 'replication',
+ "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
+ }
- // Avoid letting a few seconds of replica DB lag cause a month of stale data. This logic is
- // also intimately related to the value of $wgCdnReboundPurgeDelay.
- if ( $lbFactory->laggedReplicaUsed() ) {
- $maxAge = $config->get( 'CdnMaxageLagged' );
- $output->lowerCdnMaxage( $maxAge );
- $request->response()->header( "X-Database-Lagged: true" );
- wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
+ // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
+ if ( MessageCache::singleton()->isDisabled() ) {
+ $maxAge = $config->get( 'CdnMaxageSubstitute' );
+ $output->lowerCdnMaxage( $maxAge );
+ $request->response()->header( "X-Response-Substitute: true" );
+ }
}
+ }
+
+ /**
+ * @param ILBFactory $lbFactory
+ * @param OutputPage $output
+ * @return array
+ */
+ private static function getChronProtStrategy( ILBFactory $lbFactory, OutputPage $output ) {
+ // Should the client return, their request should observe the new ChronologyProtector
+ // DB positions. This request might be on a foreign wiki domain, so synchronously update
+ // the DB positions in all datacenters to be safe. If this output is not a redirect,
+ // then OutputPage::output() will be relatively slow, meaning that running it in
+ // $postCommitWork should help mask the latency of those updates.
+ $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
+ $strategy = 'cookie+sync';
- // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
- if ( MessageCache::singleton()->isDisabled() ) {
- $maxAge = $config->get( 'CdnMaxageSubstitute' );
- $output->lowerCdnMaxage( $maxAge );
- $request->response()->header( "X-Response-Substitute: true" );
+ $allowHeaders = !( $output->isDisabled() || headers_sent() );
+ if ( $output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
+ // OutputPage::output() will be fast, so $postCommitWork is useless for masking
+ // the latency of synchronously updating the DB positions in all datacenters.
+ // Try to make use of the time the client spends following redirects instead.
+ $domainDistance = self::getUrlDomainDistance( $output->getRedirect() );
+ if ( $domainDistance === 'local' && $allowHeaders ) {
+ $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
+ $strategy = 'cookie'; // use same-domain cookie and keep the URL uncluttered
+ } elseif ( $domainDistance === 'remote' ) {
+ $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
+ $strategy = 'cookie+url'; // cross-domain cookie might not work
+ }
}
+
+ return [ $flags, $strategy ];
}
/**
// Commit and close up!
$lbFactory->commitMasterChanges( __METHOD__ );
- $lbFactory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
+ $lbFactory->shutdown( $lbFactory::SHUTDOWN_NO_CHRONPROT );
wfDebug( "Request ended normally\n" );
}
+++ /dev/null
-<?php
-/**
- * Fetching and processing of interface messages.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @author Niklas Laxström
- */
-use MediaWiki\MediaWikiServices;
-
-/**
- * The Message class provides methods which fulfil two basic services:
- * - fetching interface messages
- * - processing messages into a variety of formats
- *
- * First implemented with MediaWiki 1.17, the Message class is intended to
- * replace the old wfMsg* functions that over time grew unusable.
- * @see https://www.mediawiki.org/wiki/Manual:Messages_API for equivalences
- * between old and new functions.
- *
- * You should use the wfMessage() global function which acts as a wrapper for
- * the Message class. The wrapper let you pass parameters as arguments.
- *
- * The most basic usage cases would be:
- *
- * @code
- * // Initialize a Message object using the 'some_key' message key
- * $message = wfMessage( 'some_key' );
- *
- * // Using two parameters those values are strings 'value1' and 'value2':
- * $message = wfMessage( 'some_key',
- * 'value1', 'value2'
- * );
- * @endcode
- *
- * @section message_global_fn Global function wrapper:
- *
- * Since wfMessage() returns a Message instance, you can chain its call with
- * a method. Some of them return a Message instance too so you can chain them.
- * You will find below several examples of wfMessage() usage.
- *
- * Fetching a message text for interface message:
- *
- * @code
- * $button = Xml::button(
- * wfMessage( 'submit' )->text()
- * );
- * @endcode
- *
- * A Message instance can be passed parameters after it has been constructed,
- * use the params() method to do so:
- *
- * @code
- * wfMessage( 'welcome-to' )
- * ->params( $wgSitename )
- * ->text();
- * @endcode
- *
- * {{GRAMMAR}} and friends work correctly:
- *
- * @code
- * wfMessage( 'are-friends',
- * $user, $friend
- * );
- * wfMessage( 'bad-message' )
- * ->rawParams( '<script>...</script>' )
- * ->escaped();
- * @endcode
- *
- * @section message_language Changing language:
- *
- * Messages can be requested in a different language or in whatever current
- * content language is being used. The methods are:
- * - Message->inContentLanguage()
- * - Message->inLanguage()
- *
- * Sometimes the message text ends up in the database, so content language is
- * needed:
- *
- * @code
- * wfMessage( 'file-log',
- * $user, $filename
- * )->inContentLanguage()->text();
- * @endcode
- *
- * Checking whether a message exists:
- *
- * @code
- * wfMessage( 'mysterious-message' )->exists()
- * // returns a boolean whether the 'mysterious-message' key exist.
- * @endcode
- *
- * If you want to use a different language:
- *
- * @code
- * $userLanguage = $user->getOption( 'language' );
- * wfMessage( 'email-header' )
- * ->inLanguage( $userLanguage )
- * ->plain();
- * @endcode
- *
- * @note You can parse the text only in the content or interface languages
- *
- * @section message_compare_old Comparison with old wfMsg* functions:
- *
- * Use full parsing:
- *
- * @code
- * // old style:
- * wfMsgExt( 'key', [ 'parseinline' ], 'apple' );
- * // new style:
- * wfMessage( 'key', 'apple' )->parse();
- * @endcode
- *
- * Parseinline is used because it is more useful when pre-building HTML.
- * In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
- *
- * Places where HTML cannot be used. {{-transformation is done.
- * @code
- * // old style:
- * wfMsgExt( 'key', [ 'parsemag' ], 'apple', 'pear' );
- * // new style:
- * wfMessage( 'key', 'apple', 'pear' )->text();
- * @endcode
- *
- * Shortcut for escaping the message too, similar to wfMsgHTML(), but
- * parameters are not replaced after escaping by default.
- * @code
- * $escaped = wfMessage( 'key' )
- * ->rawParams( 'apple' )
- * ->escaped();
- * @endcode
- *
- * @section message_appendix Appendix:
- *
- * @todo
- * - test, can we have tests?
- * - this documentation needs to be extended
- *
- * @see https://www.mediawiki.org/wiki/WfMessage()
- * @see https://www.mediawiki.org/wiki/New_messages_API
- * @see https://www.mediawiki.org/wiki/Localisation
- *
- * @since 1.17
- */
-class Message implements MessageSpecifier, Serializable {
- /** Use message text as-is */
- const FORMAT_PLAIN = 'plain';
- /** Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag) */
- const FORMAT_BLOCK_PARSE = 'block-parse';
- /** Use normal wikitext -> HTML parsing but strip the block-level wrapper */
- const FORMAT_PARSE = 'parse';
- /** Transform {{..}} constructs but don't transform to HTML */
- const FORMAT_TEXT = 'text';
- /** Transform {{..}} constructs, HTML-escape the result */
- const FORMAT_ESCAPED = 'escaped';
-
- /**
- * Mapping from Message::listParam() types to Language methods.
- * @var array
- */
- protected static $listTypeMap = [
- 'comma' => 'commaList',
- 'semicolon' => 'semicolonList',
- 'pipe' => 'pipeList',
- 'text' => 'listToText',
- ];
-
- /**
- * In which language to get this message. True, which is the default,
- * means the current user language, false content language.
- *
- * @var bool
- */
- protected $interface = true;
-
- /**
- * In which language to get this message. Overrides the $interface setting.
- *
- * @var Language|bool Explicit language object, or false for user language
- */
- protected $language = false;
-
- /**
- * @var string The message key. If $keysToTry has more than one element,
- * this may change to one of the keys to try when fetching the message text.
- */
- protected $key;
-
- /**
- * @var string[] List of keys to try when fetching the message.
- */
- protected $keysToTry;
-
- /**
- * @var array List of parameters which will be substituted into the message.
- */
- protected $parameters = [];
-
- /**
- * @var string
- * @deprecated
- */
- protected $format = 'parse';
-
- /**
- * @var bool Whether database can be used.
- */
- protected $useDatabase = true;
-
- /**
- * @var Title Title object to use as context.
- */
- protected $title = null;
-
- /**
- * @var Content Content object representing the message.
- */
- protected $content = null;
-
- /**
- * @var string
- */
- protected $message;
-
- /**
- * @since 1.17
- * @param string|string[]|MessageSpecifier $key Message key, or array of
- * message keys to try and use the first non-empty message for, or a
- * MessageSpecifier to copy from.
- * @param array $params Message parameters.
- * @param Language|null $language [optional] Language to use (defaults to current user language).
- * @throws InvalidArgumentException
- */
- public function __construct( $key, $params = [], Language $language = null ) {
- if ( $key instanceof MessageSpecifier ) {
- if ( $params ) {
- throw new InvalidArgumentException(
- '$params must be empty if $key is a MessageSpecifier'
- );
- }
- $params = $key->getParams();
- $key = $key->getKey();
- }
-
- if ( !is_string( $key ) && !is_array( $key ) ) {
- throw new InvalidArgumentException( '$key must be a string or an array' );
- }
-
- $this->keysToTry = (array)$key;
-
- if ( empty( $this->keysToTry ) ) {
- throw new InvalidArgumentException( '$key must not be an empty list' );
- }
-
- $this->key = reset( $this->keysToTry );
-
- $this->parameters = array_values( $params );
- // User language is only resolved in getLanguage(). This helps preserve the
- // semantic intent of "user language" across serialize() and unserialize().
- $this->language = $language ?: false;
- }
-
- /**
- * @see Serializable::serialize()
- * @since 1.26
- * @return string
- */
- public function serialize() {
- return serialize( [
- 'interface' => $this->interface,
- 'language' => $this->language ? $this->language->getCode() : false,
- 'key' => $this->key,
- 'keysToTry' => $this->keysToTry,
- 'parameters' => $this->parameters,
- 'format' => $this->format,
- 'useDatabase' => $this->useDatabase,
- 'titlestr' => $this->title ? $this->title->getFullText() : null,
- ] );
- }
-
- /**
- * @see Serializable::unserialize()
- * @since 1.26
- * @param string $serialized
- */
- public function unserialize( $serialized ) {
- $data = unserialize( $serialized );
- if ( !is_array( $data ) ) {
- throw new InvalidArgumentException( __METHOD__ . ': Invalid serialized data' );
- }
-
- $this->interface = $data['interface'];
- $this->key = $data['key'];
- $this->keysToTry = $data['keysToTry'];
- $this->parameters = $data['parameters'];
- $this->format = $data['format'];
- $this->useDatabase = $data['useDatabase'];
- $this->language = $data['language'] ? Language::factory( $data['language'] ) : false;
-
- if ( isset( $data['titlestr'] ) ) {
- $this->title = Title::newFromText( $data['titlestr'] );
- } elseif ( isset( $data['title'] ) && $data['title'] instanceof Title ) {
- // Old serializations from before December 2018
- $this->title = $data['title'];
- } else {
- $this->title = null; // Explicit for sanity
- }
- }
-
- /**
- * @since 1.24
- *
- * @return bool True if this is a multi-key message, that is, if the key provided to the
- * constructor was a fallback list of keys to try.
- */
- public function isMultiKey() {
- return count( $this->keysToTry ) > 1;
- }
-
- /**
- * @since 1.24
- *
- * @return string[] The list of keys to try when fetching the message text,
- * in order of preference.
- */
- public function getKeysToTry() {
- return $this->keysToTry;
- }
-
- /**
- * Returns the message key.
- *
- * If a list of multiple possible keys was supplied to the constructor, this method may
- * return any of these keys. After the message has been fetched, this method will return
- * the key that was actually used to fetch the message.
- *
- * @since 1.21
- *
- * @return string
- */
- public function getKey() {
- return $this->key;
- }
-
- /**
- * Returns the message parameters.
- *
- * @since 1.21
- *
- * @return array
- */
- public function getParams() {
- return $this->parameters;
- }
-
- /**
- * Returns the message format.
- *
- * @since 1.21
- *
- * @return string
- * @deprecated since 1.29 formatting is not stateful
- */
- public function getFormat() {
- wfDeprecated( __METHOD__, '1.29' );
- return $this->format;
- }
-
- /**
- * Returns the Language of the Message.
- *
- * @since 1.23
- *
- * @return Language
- */
- public function getLanguage() {
- // Defaults to false which means current user language
- return $this->language ?: RequestContext::getMain()->getLanguage();
- }
-
- /**
- * Factory function that is just wrapper for the real constructor. It is
- * intended to be used instead of the real constructor, because it allows
- * chaining method calls, while new objects don't.
- *
- * @since 1.17
- *
- * @param string|string[]|MessageSpecifier $key
- * @param mixed $param,... Parameters as strings.
- *
- * @return Message
- */
- public static function newFromKey( $key /*...*/ ) {
- $params = func_get_args();
- array_shift( $params );
- return new self( $key, $params );
- }
-
- /**
- * Transform a MessageSpecifier or a primitive value used interchangeably with
- * specifiers (a message key string, or a key + params array) into a proper Message.
- *
- * Also accepts a MessageSpecifier inside an array: that's not considered a valid format
- * but is an easy error to make due to how StatusValue stores messages internally.
- * Further array elements are ignored in that case.
- *
- * @param string|array|MessageSpecifier $value
- * @return Message
- * @throws InvalidArgumentException
- * @since 1.27
- */
- public static function newFromSpecifier( $value ) {
- $params = [];
- if ( is_array( $value ) ) {
- $params = $value;
- $value = array_shift( $params );
- }
-
- if ( $value instanceof Message ) { // Message, RawMessage, ApiMessage, etc
- $message = clone $value;
- } elseif ( $value instanceof MessageSpecifier ) {
- $message = new Message( $value );
- } elseif ( is_string( $value ) ) {
- $message = new Message( $value, $params );
- } else {
- throw new InvalidArgumentException( __METHOD__ . ': invalid argument type '
- . gettype( $value ) );
- }
-
- return $message;
- }
-
- /**
- * Factory function accepting multiple message keys and returning a message instance
- * for the first message which is non-empty. If all messages are empty then an
- * instance of the first message key is returned.
- *
- * @since 1.18
- *
- * @param string|string[] $keys,... Message keys, or first argument as an array of all the
- * message keys.
- *
- * @return Message
- */
- public static function newFallbackSequence( /*...*/ ) {
- $keys = func_get_args();
- if ( func_num_args() == 1 ) {
- if ( is_array( $keys[0] ) ) {
- // Allow an array to be passed as the first argument instead
- $keys = array_values( $keys[0] );
- } else {
- // Optimize a single string to not need special fallback handling
- $keys = $keys[0];
- }
- }
- return new self( $keys );
- }
-
- /**
- * Get a title object for a mediawiki message, where it can be found in the mediawiki namespace.
- * The title will be for the current language, if the message key is in
- * $wgForceUIMsgAsContentMsg it will be append with the language code (except content
- * language), because Message::inContentLanguage will also return in user language.
- *
- * @see $wgForceUIMsgAsContentMsg
- * @return Title
- * @since 1.26
- */
- public function getTitle() {
- global $wgForceUIMsgAsContentMsg;
-
- $contLang = MediaWikiServices::getInstance()->getContentLanguage();
- $lang = $this->getLanguage();
- $title = $this->key;
- if (
- !$lang->equals( $contLang )
- && in_array( $this->key, (array)$wgForceUIMsgAsContentMsg )
- ) {
- $title .= '/' . $lang->getCode();
- }
-
- return Title::makeTitle(
- NS_MEDIAWIKI, $contLang->ucfirst( strtr( $title, ' ', '_' ) ) );
- }
-
- /**
- * Adds parameters to the parameter list of this message.
- *
- * @since 1.17
- *
- * @param mixed $args,... Parameters as strings or arrays from
- * Message::numParam() and the like, or a single array of parameters.
- *
- * @return Message $this
- */
- public function params( /*...*/ ) {
- $args = func_get_args();
-
- // If $args has only one entry and it's an array, then it's either a
- // non-varargs call or it happens to be a call with just a single
- // "special" parameter. Since the "special" parameters don't have any
- // numeric keys, we'll test that to differentiate the cases.
- if ( count( $args ) === 1 && isset( $args[0] ) && is_array( $args[0] ) ) {
- if ( $args[0] === [] ) {
- $args = [];
- } else {
- foreach ( $args[0] as $key => $value ) {
- if ( is_int( $key ) ) {
- $args = $args[0];
- break;
- }
- }
- }
- }
-
- $this->parameters = array_merge( $this->parameters, array_values( $args ) );
- return $this;
- }
-
- /**
- * Add parameters that are substituted after parsing or escaping.
- * In other words the parsing process cannot access the contents
- * of this type of parameter, and you need to make sure it is
- * sanitized beforehand. The parser will see "$n", instead.
- *
- * @since 1.17
- *
- * @param mixed $params,... Raw parameters as strings, or a single argument that is
- * an array of raw parameters.
- *
- * @return Message $this
- */
- public function rawParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::rawParam( $param );
- }
- return $this;
- }
-
- /**
- * Add parameters that are numeric and will be passed through
- * Language::formatNum before substitution
- *
- * @since 1.18
- *
- * @param mixed $param,... Numeric parameters, or a single argument that is
- * an array of numeric parameters.
- *
- * @return Message $this
- */
- public function numParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::numParam( $param );
- }
- return $this;
- }
-
- /**
- * Add parameters that are durations of time and will be passed through
- * Language::formatDuration before substitution
- *
- * @since 1.22
- *
- * @param int|int[] $param,... Duration parameters, or a single argument that is
- * an array of duration parameters.
- *
- * @return Message $this
- */
- public function durationParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::durationParam( $param );
- }
- return $this;
- }
-
- /**
- * Add parameters that are expiration times and will be passed through
- * Language::formatExpiry before substitution
- *
- * @since 1.22
- *
- * @param string|string[] $param,... Expiry parameters, or a single argument that is
- * an array of expiry parameters.
- *
- * @return Message $this
- */
- public function expiryParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::expiryParam( $param );
- }
- return $this;
- }
-
- /**
- * Add parameters that are time periods and will be passed through
- * Language::formatTimePeriod before substitution
- *
- * @since 1.22
- *
- * @param int|int[] $param,... Time period parameters, or a single argument that is
- * an array of time period parameters.
- *
- * @return Message $this
- */
- public function timeperiodParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::timeperiodParam( $param );
- }
- return $this;
- }
-
- /**
- * Add parameters that are file sizes and will be passed through
- * Language::formatSize before substitution
- *
- * @since 1.22
- *
- * @param int|int[] $param,... Size parameters, or a single argument that is
- * an array of size parameters.
- *
- * @return Message $this
- */
- public function sizeParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::sizeParam( $param );
- }
- return $this;
- }
-
- /**
- * Add parameters that are bitrates and will be passed through
- * Language::formatBitrate before substitution
- *
- * @since 1.22
- *
- * @param int|int[] $param,... Bit rate parameters, or a single argument that is
- * an array of bit rate parameters.
- *
- * @return Message $this
- */
- public function bitrateParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::bitrateParam( $param );
- }
- return $this;
- }
-
- /**
- * Add parameters that are plaintext and will be passed through without
- * the content being evaluated. Plaintext parameters are not valid as
- * arguments to parser functions. This differs from self::rawParams in
- * that the Message class handles escaping to match the output format.
- *
- * @since 1.25
- *
- * @param string|string[] $param,... plaintext parameters, or a single argument that is
- * an array of plaintext parameters.
- *
- * @return Message $this
- */
- public function plaintextParams( /*...*/ ) {
- $params = func_get_args();
- if ( isset( $params[0] ) && is_array( $params[0] ) ) {
- $params = $params[0];
- }
- foreach ( $params as $param ) {
- $this->parameters[] = self::plaintextParam( $param );
- }
- return $this;
- }
-
- /**
- * Set the language and the title from a context object
- *
- * @since 1.19
- *
- * @param IContextSource $context
- *
- * @return Message $this
- */
- public function setContext( IContextSource $context ) {
- $this->inLanguage( $context->getLanguage() );
- $this->title( $context->getTitle() );
- $this->interface = true;
-
- return $this;
- }
-
- /**
- * Request the message in any language that is supported.
- *
- * As a side effect interface message status is unconditionally
- * turned off.
- *
- * @since 1.17
- * @param Language|string $lang Language code or Language object.
- * @return Message $this
- * @throws MWException
- */
- public function inLanguage( $lang ) {
- $previousLanguage = $this->language;
-
- if ( $lang instanceof Language ) {
- $this->language = $lang;
- } elseif ( is_string( $lang ) ) {
- if ( !$this->language instanceof Language || $this->language->getCode() != $lang ) {
- $this->language = Language::factory( $lang );
- }
- } elseif ( $lang instanceof StubUserLang ) {
- $this->language = false;
- } else {
- $type = gettype( $lang );
- throw new MWException( __METHOD__ . " must be "
- . "passed a String or Language object; $type given"
- );
- }
-
- if ( $this->language !== $previousLanguage ) {
- // The language has changed. Clear the message cache.
- $this->message = null;
- }
- $this->interface = false;
- return $this;
- }
-
- /**
- * Request the message in the wiki's content language,
- * unless it is disabled for this message.
- *
- * @since 1.17
- * @see $wgForceUIMsgAsContentMsg
- *
- * @return Message $this
- */
- public function inContentLanguage() {
- global $wgForceUIMsgAsContentMsg;
- if ( in_array( $this->key, (array)$wgForceUIMsgAsContentMsg ) ) {
- return $this;
- }
-
- $this->inLanguage( MediaWikiServices::getInstance()->getContentLanguage() );
- return $this;
- }
-
- /**
- * Allows manipulating the interface message flag directly.
- * Can be used to restore the flag after setting a language.
- *
- * @since 1.20
- *
- * @param bool $interface
- *
- * @return Message $this
- */
- public function setInterfaceMessageFlag( $interface ) {
- $this->interface = (bool)$interface;
- return $this;
- }
-
- /**
- * Enable or disable database use.
- *
- * @since 1.17
- *
- * @param bool $useDatabase
- *
- * @return Message $this
- */
- public function useDatabase( $useDatabase ) {
- $this->useDatabase = (bool)$useDatabase;
- $this->message = null;
- return $this;
- }
-
- /**
- * Set the Title object to use as context when transforming the message
- *
- * @since 1.18
- *
- * @param Title $title
- *
- * @return Message $this
- */
- public function title( $title ) {
- $this->title = $title;
- return $this;
- }
-
- /**
- * Returns the message as a Content object.
- *
- * @return Content
- */
- public function content() {
- if ( !$this->content ) {
- $this->content = new MessageContent( $this );
- }
-
- return $this->content;
- }
-
- /**
- * Returns the message parsed from wikitext to HTML.
- *
- * @since 1.17
- *
- * @param string|null $format One of the FORMAT_* constants. Null means use whatever was used
- * the last time (this is for B/C and should be avoided).
- *
- * @return string HTML
- * @suppress SecurityCheck-DoubleEscaped phan false positive
- */
- public function toString( $format = null ) {
- if ( $format === null ) {
- $ex = new LogicException( __METHOD__ . ' using implicit format: ' . $this->format );
- \MediaWiki\Logger\LoggerFactory::getInstance( 'message-format' )->warning(
- $ex->getMessage(), [ 'exception' => $ex, 'format' => $this->format, 'key' => $this->key ] );
- $format = $this->format;
- }
- $string = $this->fetchMessage();
-
- if ( $string === false ) {
- // Err on the side of safety, ensure that the output
- // is always html safe in the event the message key is
- // missing, since in that case its highly likely the
- // message key is user-controlled.
- // '⧼' is used instead of '<' to side-step any
- // double-escaping issues.
- // (Keep synchronised with mw.Message#toString in JS.)
- return '⧼' . htmlspecialchars( $this->key ) . '⧽';
- }
-
- # Replace $* with a list of parameters for &uselang=qqx.
- if ( strpos( $string, '$*' ) !== false ) {
- $paramlist = '';
- if ( $this->parameters !== [] ) {
- $paramlist = ': $' . implode( ', $', range( 1, count( $this->parameters ) ) );
- }
- $string = str_replace( '$*', $paramlist, $string );
- }
-
- # Replace parameters before text parsing
- $string = $this->replaceParameters( $string, 'before', $format );
-
- # Maybe transform using the full parser
- if ( $format === self::FORMAT_PARSE ) {
- $string = $this->parseText( $string );
- $string = Parser::stripOuterParagraph( $string );
- } elseif ( $format === self::FORMAT_BLOCK_PARSE ) {
- $string = $this->parseText( $string );
- } elseif ( $format === self::FORMAT_TEXT ) {
- $string = $this->transformText( $string );
- } elseif ( $format === self::FORMAT_ESCAPED ) {
- $string = $this->transformText( $string );
- $string = htmlspecialchars( $string, ENT_QUOTES, 'UTF-8', false );
- }
-
- # Raw parameter replacement
- $string = $this->replaceParameters( $string, 'after', $format );
-
- return $string;
- }
-
- /**
- * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg:
- * $foo = new Message( $key );
- * $string = "<abbr>$foo</abbr>";
- *
- * @since 1.18
- *
- * @return string
- */
- public function __toString() {
- // PHP doesn't allow __toString to throw exceptions and will
- // trigger a fatal error if it does. So, catch any exceptions.
-
- try {
- return $this->toString( self::FORMAT_PARSE );
- } catch ( Exception $ex ) {
- try {
- trigger_error( "Exception caught in " . __METHOD__ . " (message " . $this->key . "): "
- . $ex, E_USER_WARNING );
- } catch ( Exception $ex ) {
- // Doh! Cause a fatal error after all?
- }
-
- return '⧼' . htmlspecialchars( $this->key ) . '⧽';
- }
- }
-
- /**
- * Fully parse the text from wikitext to HTML.
- *
- * @since 1.17
- *
- * @return string Parsed HTML.
- */
- public function parse() {
- $this->format = self::FORMAT_PARSE;
- return $this->toString( self::FORMAT_PARSE );
- }
-
- /**
- * Returns the message text. {{-transformation is done.
- *
- * @since 1.17
- *
- * @return string Unescaped message text.
- */
- public function text() {
- $this->format = self::FORMAT_TEXT;
- return $this->toString( self::FORMAT_TEXT );
- }
-
- /**
- * Returns the message text as-is, only parameters are substituted.
- *
- * @since 1.17
- *
- * @return string Unescaped untransformed message text.
- */
- public function plain() {
- $this->format = self::FORMAT_PLAIN;
- return $this->toString( self::FORMAT_PLAIN );
- }
-
- /**
- * Returns the parsed message text which is always surrounded by a block element.
- *
- * @since 1.17
- *
- * @return string HTML
- */
- public function parseAsBlock() {
- $this->format = self::FORMAT_BLOCK_PARSE;
- return $this->toString( self::FORMAT_BLOCK_PARSE );
- }
-
- /**
- * Returns the message text. {{-transformation is done and the result
- * is escaped excluding any raw parameters.
- *
- * @since 1.17
- *
- * @return string Escaped message text.
- */
- public function escaped() {
- $this->format = self::FORMAT_ESCAPED;
- return $this->toString( self::FORMAT_ESCAPED );
- }
-
- /**
- * Check whether a message key has been defined currently.
- *
- * @since 1.17
- *
- * @return bool
- */
- public function exists() {
- return $this->fetchMessage() !== false;
- }
-
- /**
- * Check whether a message does not exist, or is an empty string
- *
- * @since 1.18
- * @todo FIXME: Merge with isDisabled()?
- *
- * @return bool
- */
- public function isBlank() {
- $message = $this->fetchMessage();
- return $message === false || $message === '';
- }
-
- /**
- * Check whether a message does not exist, is an empty string, or is "-".
- *
- * @since 1.18
- *
- * @return bool
- */
- public function isDisabled() {
- $message = $this->fetchMessage();
- return $message === false || $message === '' || $message === '-';
- }
-
- /**
- * @since 1.17
- *
- * @param mixed $raw
- *
- * @return array Array with a single "raw" key.
- */
- public static function rawParam( $raw ) {
- return [ 'raw' => $raw ];
- }
-
- /**
- * @since 1.18
- *
- * @param mixed $num
- *
- * @return array Array with a single "num" key.
- */
- public static function numParam( $num ) {
- return [ 'num' => $num ];
- }
-
- /**
- * @since 1.22
- *
- * @param int $duration
- *
- * @return int[] Array with a single "duration" key.
- */
- public static function durationParam( $duration ) {
- return [ 'duration' => $duration ];
- }
-
- /**
- * @since 1.22
- *
- * @param string $expiry
- *
- * @return string[] Array with a single "expiry" key.
- */
- public static function expiryParam( $expiry ) {
- return [ 'expiry' => $expiry ];
- }
-
- /**
- * @since 1.22
- *
- * @param int $period
- *
- * @return int[] Array with a single "period" key.
- */
- public static function timeperiodParam( $period ) {
- return [ 'period' => $period ];
- }
-
- /**
- * @since 1.22
- *
- * @param int $size
- *
- * @return int[] Array with a single "size" key.
- */
- public static function sizeParam( $size ) {
- return [ 'size' => $size ];
- }
-
- /**
- * @since 1.22
- *
- * @param int $bitrate
- *
- * @return int[] Array with a single "bitrate" key.
- */
- public static function bitrateParam( $bitrate ) {
- return [ 'bitrate' => $bitrate ];
- }
-
- /**
- * @since 1.25
- *
- * @param string $plaintext
- *
- * @return string[] Array with a single "plaintext" key.
- */
- public static function plaintextParam( $plaintext ) {
- return [ 'plaintext' => $plaintext ];
- }
-
- /**
- * @since 1.29
- *
- * @param array $list
- * @param string $type 'comma', 'semicolon', 'pipe', 'text'
- * @return array Array with "list" and "type" keys.
- */
- public static function listParam( array $list, $type = 'text' ) {
- if ( !isset( self::$listTypeMap[$type] ) ) {
- throw new InvalidArgumentException(
- "Invalid type '$type'. Known types are: " . implode( ', ', array_keys( self::$listTypeMap ) )
- );
- }
- return [ 'list' => $list, 'type' => $type ];
- }
-
- /**
- * Substitutes any parameters into the message text.
- *
- * @since 1.17
- *
- * @param string $message The message text.
- * @param string $type Either "before" or "after".
- * @param string $format One of the FORMAT_* constants.
- *
- * @return string
- */
- protected function replaceParameters( $message, $type, $format ) {
- // A temporary marker for $1 parameters that is only valid
- // in non-attribute contexts. However if the entire message is escaped
- // then we don't want to use it because it will be mangled in all contexts
- // and its unnessary as ->escaped() messages aren't html.
- $marker = $format === self::FORMAT_ESCAPED ? '$' : '$\'"';
- $replacementKeys = [];
- foreach ( $this->parameters as $n => $param ) {
- list( $paramType, $value ) = $this->extractParam( $param, $format );
- if ( $type === 'before' ) {
- if ( $paramType === 'before' ) {
- $replacementKeys['$' . ( $n + 1 )] = $value;
- } else /* $paramType === 'after' */ {
- // To protect against XSS from replacing parameters
- // inside html attributes, we convert $1 to $'"1.
- // In the event that one of the parameters ends up
- // in an attribute, either the ' or the " will be
- // escaped, breaking the replacement and avoiding XSS.
- $replacementKeys['$' . ( $n + 1 )] = $marker . ( $n + 1 );
- }
- } elseif ( $paramType === 'after' ) {
- $replacementKeys[$marker . ( $n + 1 )] = $value;
- }
- }
- return strtr( $message, $replacementKeys );
- }
-
- /**
- * Extracts the parameter type and preprocessed the value if needed.
- *
- * @since 1.18
- *
- * @param mixed $param Parameter as defined in this class.
- * @param string $format One of the FORMAT_* constants.
- *
- * @return array Array with the parameter type (either "before" or "after") and the value.
- */
- protected function extractParam( $param, $format ) {
- if ( is_array( $param ) ) {
- if ( isset( $param['raw'] ) ) {
- return [ 'after', $param['raw'] ];
- } elseif ( isset( $param['num'] ) ) {
- // Replace number params always in before step for now.
- // No support for combined raw and num params
- return [ 'before', $this->getLanguage()->formatNum( $param['num'] ) ];
- } elseif ( isset( $param['duration'] ) ) {
- return [ 'before', $this->getLanguage()->formatDuration( $param['duration'] ) ];
- } elseif ( isset( $param['expiry'] ) ) {
- return [ 'before', $this->getLanguage()->formatExpiry( $param['expiry'] ) ];
- } elseif ( isset( $param['period'] ) ) {
- return [ 'before', $this->getLanguage()->formatTimePeriod( $param['period'] ) ];
- } elseif ( isset( $param['size'] ) ) {
- return [ 'before', $this->getLanguage()->formatSize( $param['size'] ) ];
- } elseif ( isset( $param['bitrate'] ) ) {
- return [ 'before', $this->getLanguage()->formatBitrate( $param['bitrate'] ) ];
- } elseif ( isset( $param['plaintext'] ) ) {
- return [ 'after', $this->formatPlaintext( $param['plaintext'], $format ) ];
- } elseif ( isset( $param['list'] ) ) {
- return $this->formatListParam( $param['list'], $param['type'], $format );
- } else {
- if ( !is_scalar( $param ) ) {
- $param = serialize( $param );
- }
- \MediaWiki\Logger\LoggerFactory::getInstance( 'Bug58676' )->warning(
- 'Invalid parameter for message "{msgkey}": {param}',
- [
- 'exception' => new Exception,
- 'msgkey' => $this->getKey(),
- 'param' => htmlspecialchars( $param ),
- ]
- );
-
- return [ 'before', '[INVALID]' ];
- }
- } elseif ( $param instanceof Message ) {
- // Match language, flags, etc. to the current message.
- $msg = clone $param;
- if ( $msg->language !== $this->language || $msg->useDatabase !== $this->useDatabase ) {
- // Cache depends on these parameters
- $msg->message = null;
- }
- $msg->interface = $this->interface;
- $msg->language = $this->language;
- $msg->useDatabase = $this->useDatabase;
- $msg->title = $this->title;
-
- // DWIM
- if ( $format === 'block-parse' ) {
- $format = 'parse';
- }
- $msg->format = $format;
-
- // Message objects should not be before parameters because
- // then they'll get double escaped. If the message needs to be
- // escaped, it'll happen right here when we call toString().
- return [ 'after', $msg->toString( $format ) ];
- } else {
- return [ 'before', $param ];
- }
- }
-
- /**
- * Wrapper for what ever method we use to parse wikitext.
- *
- * @since 1.17
- *
- * @param string $string Wikitext message contents.
- *
- * @return string Wikitext parsed into HTML.
- */
- protected function parseText( $string ) {
- $out = MessageCache::singleton()->parse(
- $string,
- $this->title,
- /*linestart*/true,
- $this->interface,
- $this->getLanguage()
- );
-
- return $out instanceof ParserOutput
- ? $out->getText( [
- 'enableSectionEditLinks' => false,
- // Wrapping messages in an extra <div> is probably not expected. If
- // they're outside the content area they probably shouldn't be
- // targeted by CSS that's targeting the parser output, and if
- // they're inside they already are from the outer div.
- 'unwrap' => true,
- ] )
- : $out;
- }
-
- /**
- * Wrapper for what ever method we use to {{-transform wikitext.
- *
- * @since 1.17
- *
- * @param string $string Wikitext message contents.
- *
- * @return string Wikitext with {{-constructs replaced with their values.
- */
- protected function transformText( $string ) {
- return MessageCache::singleton()->transform(
- $string,
- $this->interface,
- $this->getLanguage(),
- $this->title
- );
- }
-
- /**
- * Wrapper for what ever method we use to get message contents.
- *
- * @since 1.17
- *
- * @return string
- * @throws MWException If message key array is empty.
- */
- protected function fetchMessage() {
- if ( $this->message === null ) {
- $cache = MessageCache::singleton();
-
- foreach ( $this->keysToTry as $key ) {
- $message = $cache->get( $key, $this->useDatabase, $this->getLanguage() );
- if ( $message !== false && $message !== '' ) {
- break;
- }
- }
-
- // NOTE: The constructor makes sure keysToTry isn't empty,
- // so we know that $key and $message are initialized.
- $this->key = $key;
- $this->message = $message;
- }
- return $this->message;
- }
-
- /**
- * Formats a message parameter wrapped with 'plaintext'. Ensures that
- * the entire string is displayed unchanged when displayed in the output
- * format.
- *
- * @since 1.25
- *
- * @param string $plaintext String to ensure plaintext output of
- * @param string $format One of the FORMAT_* constants.
- *
- * @return string Input plaintext encoded for output to $format
- */
- protected function formatPlaintext( $plaintext, $format ) {
- switch ( $format ) {
- case self::FORMAT_TEXT:
- case self::FORMAT_PLAIN:
- return $plaintext;
-
- case self::FORMAT_PARSE:
- case self::FORMAT_BLOCK_PARSE:
- case self::FORMAT_ESCAPED:
- default:
- return htmlspecialchars( $plaintext, ENT_QUOTES );
- }
- }
-
- /**
- * Formats a list of parameters as a concatenated string.
- * @since 1.29
- * @param array $params
- * @param string $listType
- * @param string $format One of the FORMAT_* constants.
- * @return array Array with the parameter type (either "before" or "after") and the value.
- */
- protected function formatListParam( array $params, $listType, $format ) {
- if ( !isset( self::$listTypeMap[$listType] ) ) {
- $warning = 'Invalid list type for message "' . $this->getKey() . '": '
- . htmlspecialchars( $listType )
- . ' (params are ' . htmlspecialchars( serialize( $params ) ) . ')';
- trigger_error( $warning, E_USER_WARNING );
- $e = new Exception;
- wfDebugLog( 'Bug58676', $warning . "\n" . $e->getTraceAsString() );
- return [ 'before', '[INVALID]' ];
- }
- $func = self::$listTypeMap[$listType];
-
- // Handle an empty list sensibly
- if ( !$params ) {
- return [ 'before', $this->getLanguage()->$func( [] ) ];
- }
-
- // First, determine what kinds of list items we have
- $types = [];
- $vars = [];
- $list = [];
- foreach ( $params as $n => $p ) {
- list( $type, $value ) = $this->extractParam( $p, $format );
- $types[$type] = true;
- $list[] = $value;
- $vars[] = '$' . ( $n + 1 );
- }
-
- // Easy case: all are 'before' or 'after', so just join the
- // values and use the same type.
- if ( count( $types ) === 1 ) {
- return [ key( $types ), $this->getLanguage()->$func( $list ) ];
- }
-
- // Hard case: We need to process each value per its type, then
- // return the concatenated values as 'after'. We handle this by turning
- // the list into a RawMessage and processing that as a parameter.
- $vars = $this->getLanguage()->$func( $vars );
- return $this->extractParam( new RawMessage( $vars, $params ), $format );
- }
-}
* Add the resulting error code to the errors array
*
* @param array $errors List of current errors
- * @param array $result Result of errors
+ * @param array|string|MessageSpecifier|false $result Result of errors
*
* @return array List of errors
*/
* Add the resulting error code to the errors array
*
* @param array $errors List of current errors
- * @param array $result Result of errors
+ * @param array|string|MessageSpecifier|false $result Result of errors
*
* @return array List of errors
*/
/**
* Print the history page for an article.
+ * @return string|null
*/
function onView() {
$out = $this->getOutput();
* Allow client caching.
*/
if ( $out->checkLastModified( $this->page->getTouched() ) ) {
- return; // Client cache fresh and headers sent, nothing more to do.
+ return null; // Client cache fresh and headers sent, nothing more to do.
}
$this->preCacheMessages();
$feedType = $request->getRawVal( 'feed' );
if ( $feedType !== null ) {
$this->feed( $feedType );
- return;
+ return null;
}
$this->addHelpLink(
]
);
- return;
+ return null;
}
$ts = $this->getTimestampFromRequest( $request );
$pager->getNavigationBar()
);
$out->preventClickjacking( $pager->getPreventClickjacking() );
+
+ return null;
}
/**
/**
* @suppress SecurityCheck-XSS Non html mime type
+ * @return string|null
*/
function onView() {
$this->getOutput()->disable();
$config = $this->context->getConfig();
if ( !$request->checkUrlExtension() ) {
- return;
+ return null;
}
if ( $this->getOutput()->checkLastModified( $this->page->getTouched() ) ) {
- return; // Client cache fresh and headers sent, nothing more to do.
+ return null; // Client cache fresh and headers sent, nothing more to do.
}
$contentType = $this->getContentType();
}
echo $text;
+
+ return null;
}
/**
'$schema' => '/mediawiki/api/request/0.0.1',
'meta' => [
'request_id' => WebRequest::getRequestId(),
- 'id' => UIDGenerator::newUUIDv1(),
+ 'id' => UIDGenerator::newUUIDv4(),
'dt' => wfTimestamp( TS_ISO_8601 ),
'domain' => $this->getConfig()->get( 'ServerName' ),
'stream' => 'mediawiki.api-request'
/**
* Format records with a cee cookie
* @param array $record
- * @return array
+ * @return mixed
*/
public function format( array $record ) {
return "@cee: " . parent::format( $record );
--- /dev/null
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Language
+ */
+
+/**
+ * Methods for dealing with language codes.
+ * @todo Move some of the code-related static methods out of Language into this class
+ *
+ * @since 1.29
+ * @ingroup Language
+ */
+class LanguageCode {
+ /**
+ * Mapping of deprecated language codes that were used in previous
+ * versions of MediaWiki to up-to-date, current language codes.
+ * These may or may not be valid BCP 47 codes; they are included here
+ * because MediaWiki renamed these particular codes at some point.
+ *
+ * @var array Mapping from deprecated MediaWiki-internal language code
+ * to replacement MediaWiki-internal language code.
+ *
+ * @since 1.30
+ * @see https://meta.wikimedia.org/wiki/Special_language_codes
+ */
+ private static $deprecatedLanguageCodeMapping = [
+ // Note that als is actually a valid ISO 639 code (Tosk Albanian), but it
+ // was previously used in MediaWiki for Alsatian, which comes under gsw
+ 'als' => 'gsw', // T25215
+ 'bat-smg' => 'sgs', // T27522
+ 'be-x-old' => 'be-tarask', // T11823
+ 'fiu-vro' => 'vro', // T31186
+ 'roa-rup' => 'rup', // T17988
+ 'zh-classical' => 'lzh', // T30443
+ 'zh-min-nan' => 'nan', // T30442
+ 'zh-yue' => 'yue', // T30441
+ ];
+
+ /**
+ * Mapping of non-standard language codes used in MediaWiki to
+ * standardized BCP 47 codes. These are not deprecated (yet?):
+ * IANA may eventually recognize the subtag, in which case the `-x-`
+ * infix could be removed, or else we could rename the code in
+ * MediaWiki, in which case they'd move up to the above mapping
+ * of deprecated codes.
+ *
+ * As a rule, we preserve all distinctions made by MediaWiki
+ * internally. For example, `de-formal` becomes `de-x-formal`
+ * instead of just `de` because MediaWiki distinguishes `de-formal`
+ * from `de` (for example, for interface translations). Similarly,
+ * BCP 47 indicates that `kk-Cyrl` SHOULD not be used because it
+ * "typically does not add information", but in our case MediaWiki
+ * LanguageConverter distinguishes `kk` (render content in a mix of
+ * Kurdish variants) from `kk-Cyrl` (convert content to be uniformly
+ * Cyrillic). As the BCP 47 requirement is a SHOULD not a MUST,
+ * `kk-Cyrl` is a valid code, although some validators may emit
+ * a warning note.
+ *
+ * @var array Mapping from nonstandard MediaWiki-internal codes to
+ * BCP 47 codes
+ *
+ * @since 1.32
+ * @see https://meta.wikimedia.org/wiki/Special_language_codes
+ * @see https://phabricator.wikimedia.org/T125073
+ */
+ private static $nonstandardLanguageCodeMapping = [
+ // All codes returned by Language::fetchLanguageNames() validated
+ // against IANA registry at
+ // https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
+ // with help of validator at
+ // http://schneegans.de/lv/
+ 'cbk-zam' => 'cbk', // T124657
+ 'de-formal' => 'de-x-formal',
+ 'eml' => 'egl', // T36217
+ 'en-rtl' => 'en-x-rtl',
+ 'es-formal' => 'es-x-formal',
+ 'hu-formal' => 'hu-x-formal',
+ 'map-bms' => 'jv-x-bms', // [[en:Banyumasan_dialect]] T125073
+ 'mo' => 'ro-Cyrl-MD', // T125073
+ 'nrm' => 'nrf', // [[en:Norman_language]] T25216
+ 'nl-informal' => 'nl-x-informal',
+ 'roa-tara' => 'nap-x-tara', // [[en:Tarantino_dialect]]
+ 'simple' => 'en-simple',
+ 'sr-ec' => 'sr-Cyrl', // T117845
+ 'sr-el' => 'sr-Latn', // T117845
+
+ // Although these next codes aren't *wrong* per se, including
+ // both the script and the country code helps compatibility with
+ // other BCP 47 users. Note that MW also uses `zh-Hans`/`zh-Hant`,
+ // without a country code, and those should be left alone.
+ // (See $variantfallbacks in LanguageZh.php for Hans/Hant id.)
+ 'zh-cn' => 'zh-Hans-CN',
+ 'zh-sg' => 'zh-Hans-SG',
+ 'zh-my' => 'zh-Hans-MY',
+ 'zh-tw' => 'zh-Hant-TW',
+ 'zh-hk' => 'zh-Hant-HK',
+ 'zh-mo' => 'zh-Hant-MO',
+ ];
+
+ /**
+ * Returns a mapping of deprecated language codes that were used in previous
+ * versions of MediaWiki to up-to-date, current language codes.
+ *
+ * This array is merged into $wgDummyLanguageCodes in Setup.php, along with
+ * the fake language codes 'qqq' and 'qqx', which are used internally by
+ * MediaWiki's localisation system.
+ *
+ * @return string[]
+ *
+ * @since 1.29
+ */
+ public static function getDeprecatedCodeMapping() {
+ return self::$deprecatedLanguageCodeMapping;
+ }
+
+ /**
+ * Returns a mapping of non-standard language codes used by
+ * (current and previous version of) MediaWiki, mapped to standard
+ * BCP 47 names.
+ *
+ * This array is exported to JavaScript to ensure
+ * mediawiki.language.bcp47 stays in sync with LanguageCode::bcp47().
+ *
+ * @return string[]
+ *
+ * @since 1.32
+ */
+ public static function getNonstandardLanguageCodeMapping() {
+ $result = [];
+ foreach ( self::$deprecatedLanguageCodeMapping as $code => $ignore ) {
+ $result[$code] = self::bcp47( $code );
+ }
+ foreach ( self::$nonstandardLanguageCodeMapping as $code => $ignore ) {
+ $result[$code] = self::bcp47( $code );
+ }
+ return $result;
+ }
+
+ /**
+ * Replace deprecated language codes that were used in previous
+ * versions of MediaWiki to up-to-date, current language codes.
+ * Other values will returned unchanged.
+ *
+ * @param string $code Old language code
+ * @return string New language code
+ *
+ * @since 1.30
+ */
+ public static function replaceDeprecatedCodes( $code ) {
+ return self::$deprecatedLanguageCodeMapping[$code] ?? $code;
+ }
+
+ /**
+ * Get the normalised IETF language tag
+ * See unit test for examples.
+ * See mediawiki.language.bcp47 for the JavaScript implementation.
+ *
+ * @param string $code The language code.
+ * @return string A language code complying with BCP 47 standards.
+ *
+ * @since 1.31
+ */
+ public static function bcp47( $code ) {
+ $code = self::replaceDeprecatedCodes( strtolower( $code ) );
+ if ( isset( self::$nonstandardLanguageCodeMapping[$code] ) ) {
+ $code = self::$nonstandardLanguageCodeMapping[$code];
+ }
+ $codeSegment = explode( '-', $code );
+ $codeBCP = [];
+ foreach ( $codeSegment as $segNo => $seg ) {
+ // when previous segment is x, it is a private segment and should be lc
+ if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
+ $codeBCP[$segNo] = strtolower( $seg );
+ // ISO 3166 country code
+ } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
+ $codeBCP[$segNo] = strtoupper( $seg );
+ // ISO 15924 script code
+ } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
+ $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
+ // Use lowercase for other cases
+ } else {
+ $codeBCP[$segNo] = strtolower( $seg );
+ }
+ }
+ $langCode = implode( '-', $codeBCP );
+ return $langCode;
+ }
+}
--- /dev/null
+<?php
+/**
+ * Fetching and processing of interface messages.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @author Niklas Laxström
+ */
+use MediaWiki\MediaWikiServices;
+
+/**
+ * The Message class provides methods which fulfil two basic services:
+ * - fetching interface messages
+ * - processing messages into a variety of formats
+ *
+ * First implemented with MediaWiki 1.17, the Message class is intended to
+ * replace the old wfMsg* functions that over time grew unusable.
+ * @see https://www.mediawiki.org/wiki/Manual:Messages_API for equivalences
+ * between old and new functions.
+ *
+ * You should use the wfMessage() global function which acts as a wrapper for
+ * the Message class. The wrapper let you pass parameters as arguments.
+ *
+ * The most basic usage cases would be:
+ *
+ * @code
+ * // Initialize a Message object using the 'some_key' message key
+ * $message = wfMessage( 'some_key' );
+ *
+ * // Using two parameters those values are strings 'value1' and 'value2':
+ * $message = wfMessage( 'some_key',
+ * 'value1', 'value2'
+ * );
+ * @endcode
+ *
+ * @section message_global_fn Global function wrapper:
+ *
+ * Since wfMessage() returns a Message instance, you can chain its call with
+ * a method. Some of them return a Message instance too so you can chain them.
+ * You will find below several examples of wfMessage() usage.
+ *
+ * Fetching a message text for interface message:
+ *
+ * @code
+ * $button = Xml::button(
+ * wfMessage( 'submit' )->text()
+ * );
+ * @endcode
+ *
+ * A Message instance can be passed parameters after it has been constructed,
+ * use the params() method to do so:
+ *
+ * @code
+ * wfMessage( 'welcome-to' )
+ * ->params( $wgSitename )
+ * ->text();
+ * @endcode
+ *
+ * {{GRAMMAR}} and friends work correctly:
+ *
+ * @code
+ * wfMessage( 'are-friends',
+ * $user, $friend
+ * );
+ * wfMessage( 'bad-message' )
+ * ->rawParams( '<script>...</script>' )
+ * ->escaped();
+ * @endcode
+ *
+ * @section message_language Changing language:
+ *
+ * Messages can be requested in a different language or in whatever current
+ * content language is being used. The methods are:
+ * - Message->inContentLanguage()
+ * - Message->inLanguage()
+ *
+ * Sometimes the message text ends up in the database, so content language is
+ * needed:
+ *
+ * @code
+ * wfMessage( 'file-log',
+ * $user, $filename
+ * )->inContentLanguage()->text();
+ * @endcode
+ *
+ * Checking whether a message exists:
+ *
+ * @code
+ * wfMessage( 'mysterious-message' )->exists()
+ * // returns a boolean whether the 'mysterious-message' key exist.
+ * @endcode
+ *
+ * If you want to use a different language:
+ *
+ * @code
+ * $userLanguage = $user->getOption( 'language' );
+ * wfMessage( 'email-header' )
+ * ->inLanguage( $userLanguage )
+ * ->plain();
+ * @endcode
+ *
+ * @note You can parse the text only in the content or interface languages
+ *
+ * @section message_compare_old Comparison with old wfMsg* functions:
+ *
+ * Use full parsing:
+ *
+ * @code
+ * // old style:
+ * wfMsgExt( 'key', [ 'parseinline' ], 'apple' );
+ * // new style:
+ * wfMessage( 'key', 'apple' )->parse();
+ * @endcode
+ *
+ * Parseinline is used because it is more useful when pre-building HTML.
+ * In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
+ *
+ * Places where HTML cannot be used. {{-transformation is done.
+ * @code
+ * // old style:
+ * wfMsgExt( 'key', [ 'parsemag' ], 'apple', 'pear' );
+ * // new style:
+ * wfMessage( 'key', 'apple', 'pear' )->text();
+ * @endcode
+ *
+ * Shortcut for escaping the message too, similar to wfMsgHTML(), but
+ * parameters are not replaced after escaping by default.
+ * @code
+ * $escaped = wfMessage( 'key' )
+ * ->rawParams( 'apple' )
+ * ->escaped();
+ * @endcode
+ *
+ * @section message_appendix Appendix:
+ *
+ * @todo
+ * - test, can we have tests?
+ * - this documentation needs to be extended
+ *
+ * @see https://www.mediawiki.org/wiki/WfMessage()
+ * @see https://www.mediawiki.org/wiki/New_messages_API
+ * @see https://www.mediawiki.org/wiki/Localisation
+ *
+ * @since 1.17
+ */
+class Message implements MessageSpecifier, Serializable {
+ /** Use message text as-is */
+ const FORMAT_PLAIN = 'plain';
+ /** Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag) */
+ const FORMAT_BLOCK_PARSE = 'block-parse';
+ /** Use normal wikitext -> HTML parsing but strip the block-level wrapper */
+ const FORMAT_PARSE = 'parse';
+ /** Transform {{..}} constructs but don't transform to HTML */
+ const FORMAT_TEXT = 'text';
+ /** Transform {{..}} constructs, HTML-escape the result */
+ const FORMAT_ESCAPED = 'escaped';
+
+ /**
+ * Mapping from Message::listParam() types to Language methods.
+ * @var array
+ */
+ protected static $listTypeMap = [
+ 'comma' => 'commaList',
+ 'semicolon' => 'semicolonList',
+ 'pipe' => 'pipeList',
+ 'text' => 'listToText',
+ ];
+
+ /**
+ * In which language to get this message. True, which is the default,
+ * means the current user language, false content language.
+ *
+ * @var bool
+ */
+ protected $interface = true;
+
+ /**
+ * In which language to get this message. Overrides the $interface setting.
+ *
+ * @var Language|bool Explicit language object, or false for user language
+ */
+ protected $language = false;
+
+ /**
+ * @var string The message key. If $keysToTry has more than one element,
+ * this may change to one of the keys to try when fetching the message text.
+ */
+ protected $key;
+
+ /**
+ * @var string[] List of keys to try when fetching the message.
+ */
+ protected $keysToTry;
+
+ /**
+ * @var array List of parameters which will be substituted into the message.
+ */
+ protected $parameters = [];
+
+ /**
+ * @var string
+ * @deprecated
+ */
+ protected $format = 'parse';
+
+ /**
+ * @var bool Whether database can be used.
+ */
+ protected $useDatabase = true;
+
+ /**
+ * @var Title Title object to use as context.
+ */
+ protected $title = null;
+
+ /**
+ * @var Content Content object representing the message.
+ */
+ protected $content = null;
+
+ /**
+ * @var string
+ */
+ protected $message;
+
+ /**
+ * @since 1.17
+ * @param string|string[]|MessageSpecifier $key Message key, or array of
+ * message keys to try and use the first non-empty message for, or a
+ * MessageSpecifier to copy from.
+ * @param array $params Message parameters.
+ * @param Language|null $language [optional] Language to use (defaults to current user language).
+ * @throws InvalidArgumentException
+ */
+ public function __construct( $key, $params = [], Language $language = null ) {
+ if ( $key instanceof MessageSpecifier ) {
+ if ( $params ) {
+ throw new InvalidArgumentException(
+ '$params must be empty if $key is a MessageSpecifier'
+ );
+ }
+ $params = $key->getParams();
+ $key = $key->getKey();
+ }
+
+ if ( !is_string( $key ) && !is_array( $key ) ) {
+ throw new InvalidArgumentException( '$key must be a string or an array' );
+ }
+
+ $this->keysToTry = (array)$key;
+
+ if ( empty( $this->keysToTry ) ) {
+ throw new InvalidArgumentException( '$key must not be an empty list' );
+ }
+
+ $this->key = reset( $this->keysToTry );
+
+ $this->parameters = array_values( $params );
+ // User language is only resolved in getLanguage(). This helps preserve the
+ // semantic intent of "user language" across serialize() and unserialize().
+ $this->language = $language ?: false;
+ }
+
+ /**
+ * @see Serializable::serialize()
+ * @since 1.26
+ * @return string
+ */
+ public function serialize() {
+ return serialize( [
+ 'interface' => $this->interface,
+ 'language' => $this->language ? $this->language->getCode() : false,
+ 'key' => $this->key,
+ 'keysToTry' => $this->keysToTry,
+ 'parameters' => $this->parameters,
+ 'format' => $this->format,
+ 'useDatabase' => $this->useDatabase,
+ 'titlestr' => $this->title ? $this->title->getFullText() : null,
+ ] );
+ }
+
+ /**
+ * @see Serializable::unserialize()
+ * @since 1.26
+ * @param string $serialized
+ */
+ public function unserialize( $serialized ) {
+ $data = unserialize( $serialized );
+ if ( !is_array( $data ) ) {
+ throw new InvalidArgumentException( __METHOD__ . ': Invalid serialized data' );
+ }
+
+ $this->interface = $data['interface'];
+ $this->key = $data['key'];
+ $this->keysToTry = $data['keysToTry'];
+ $this->parameters = $data['parameters'];
+ $this->format = $data['format'];
+ $this->useDatabase = $data['useDatabase'];
+ $this->language = $data['language'] ? Language::factory( $data['language'] ) : false;
+
+ if ( isset( $data['titlestr'] ) ) {
+ $this->title = Title::newFromText( $data['titlestr'] );
+ } elseif ( isset( $data['title'] ) && $data['title'] instanceof Title ) {
+ // Old serializations from before December 2018
+ $this->title = $data['title'];
+ } else {
+ $this->title = null; // Explicit for sanity
+ }
+ }
+
+ /**
+ * @since 1.24
+ *
+ * @return bool True if this is a multi-key message, that is, if the key provided to the
+ * constructor was a fallback list of keys to try.
+ */
+ public function isMultiKey() {
+ return count( $this->keysToTry ) > 1;
+ }
+
+ /**
+ * @since 1.24
+ *
+ * @return string[] The list of keys to try when fetching the message text,
+ * in order of preference.
+ */
+ public function getKeysToTry() {
+ return $this->keysToTry;
+ }
+
+ /**
+ * Returns the message key.
+ *
+ * If a list of multiple possible keys was supplied to the constructor, this method may
+ * return any of these keys. After the message has been fetched, this method will return
+ * the key that was actually used to fetch the message.
+ *
+ * @since 1.21
+ *
+ * @return string
+ */
+ public function getKey() {
+ return $this->key;
+ }
+
+ /**
+ * Returns the message parameters.
+ *
+ * @since 1.21
+ *
+ * @return array
+ */
+ public function getParams() {
+ return $this->parameters;
+ }
+
+ /**
+ * Returns the message format.
+ *
+ * @since 1.21
+ *
+ * @return string
+ * @deprecated since 1.29 formatting is not stateful
+ */
+ public function getFormat() {
+ wfDeprecated( __METHOD__, '1.29' );
+ return $this->format;
+ }
+
+ /**
+ * Returns the Language of the Message.
+ *
+ * @since 1.23
+ *
+ * @return Language
+ */
+ public function getLanguage() {
+ // Defaults to false which means current user language
+ return $this->language ?: RequestContext::getMain()->getLanguage();
+ }
+
+ /**
+ * Factory function that is just wrapper for the real constructor. It is
+ * intended to be used instead of the real constructor, because it allows
+ * chaining method calls, while new objects don't.
+ *
+ * @since 1.17
+ *
+ * @param string|string[]|MessageSpecifier $key
+ * @param mixed $param,... Parameters as strings.
+ *
+ * @return Message
+ */
+ public static function newFromKey( $key /*...*/ ) {
+ $params = func_get_args();
+ array_shift( $params );
+ return new self( $key, $params );
+ }
+
+ /**
+ * Transform a MessageSpecifier or a primitive value used interchangeably with
+ * specifiers (a message key string, or a key + params array) into a proper Message.
+ *
+ * Also accepts a MessageSpecifier inside an array: that's not considered a valid format
+ * but is an easy error to make due to how StatusValue stores messages internally.
+ * Further array elements are ignored in that case.
+ *
+ * @param string|array|MessageSpecifier $value
+ * @return Message
+ * @throws InvalidArgumentException
+ * @since 1.27
+ */
+ public static function newFromSpecifier( $value ) {
+ $params = [];
+ if ( is_array( $value ) ) {
+ $params = $value;
+ $value = array_shift( $params );
+ }
+
+ if ( $value instanceof Message ) { // Message, RawMessage, ApiMessage, etc
+ $message = clone $value;
+ } elseif ( $value instanceof MessageSpecifier ) {
+ $message = new Message( $value );
+ } elseif ( is_string( $value ) ) {
+ $message = new Message( $value, $params );
+ } else {
+ throw new InvalidArgumentException( __METHOD__ . ': invalid argument type '
+ . gettype( $value ) );
+ }
+
+ return $message;
+ }
+
+ /**
+ * Factory function accepting multiple message keys and returning a message instance
+ * for the first message which is non-empty. If all messages are empty then an
+ * instance of the first message key is returned.
+ *
+ * @since 1.18
+ *
+ * @param string|string[] $keys,... Message keys, or first argument as an array of all the
+ * message keys.
+ *
+ * @return Message
+ */
+ public static function newFallbackSequence( /*...*/ ) {
+ $keys = func_get_args();
+ if ( func_num_args() == 1 ) {
+ if ( is_array( $keys[0] ) ) {
+ // Allow an array to be passed as the first argument instead
+ $keys = array_values( $keys[0] );
+ } else {
+ // Optimize a single string to not need special fallback handling
+ $keys = $keys[0];
+ }
+ }
+ return new self( $keys );
+ }
+
+ /**
+ * Get a title object for a mediawiki message, where it can be found in the mediawiki namespace.
+ * The title will be for the current language, if the message key is in
+ * $wgForceUIMsgAsContentMsg it will be append with the language code (except content
+ * language), because Message::inContentLanguage will also return in user language.
+ *
+ * @see $wgForceUIMsgAsContentMsg
+ * @return Title
+ * @since 1.26
+ */
+ public function getTitle() {
+ global $wgForceUIMsgAsContentMsg;
+
+ $contLang = MediaWikiServices::getInstance()->getContentLanguage();
+ $lang = $this->getLanguage();
+ $title = $this->key;
+ if (
+ !$lang->equals( $contLang )
+ && in_array( $this->key, (array)$wgForceUIMsgAsContentMsg )
+ ) {
+ $title .= '/' . $lang->getCode();
+ }
+
+ return Title::makeTitle(
+ NS_MEDIAWIKI, $contLang->ucfirst( strtr( $title, ' ', '_' ) ) );
+ }
+
+ /**
+ * Adds parameters to the parameter list of this message.
+ *
+ * @since 1.17
+ *
+ * @param mixed $args,... Parameters as strings or arrays from
+ * Message::numParam() and the like, or a single array of parameters.
+ *
+ * @return Message $this
+ */
+ public function params( /*...*/ ) {
+ $args = func_get_args();
+
+ // If $args has only one entry and it's an array, then it's either a
+ // non-varargs call or it happens to be a call with just a single
+ // "special" parameter. Since the "special" parameters don't have any
+ // numeric keys, we'll test that to differentiate the cases.
+ if ( count( $args ) === 1 && isset( $args[0] ) && is_array( $args[0] ) ) {
+ if ( $args[0] === [] ) {
+ $args = [];
+ } else {
+ foreach ( $args[0] as $key => $value ) {
+ if ( is_int( $key ) ) {
+ $args = $args[0];
+ break;
+ }
+ }
+ }
+ }
+
+ $this->parameters = array_merge( $this->parameters, array_values( $args ) );
+ return $this;
+ }
+
+ /**
+ * Add parameters that are substituted after parsing or escaping.
+ * In other words the parsing process cannot access the contents
+ * of this type of parameter, and you need to make sure it is
+ * sanitized beforehand. The parser will see "$n", instead.
+ *
+ * @since 1.17
+ *
+ * @param mixed $params,... Raw parameters as strings, or a single argument that is
+ * an array of raw parameters.
+ *
+ * @return Message $this
+ */
+ public function rawParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::rawParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Add parameters that are numeric and will be passed through
+ * Language::formatNum before substitution
+ *
+ * @since 1.18
+ *
+ * @param mixed $param,... Numeric parameters, or a single argument that is
+ * an array of numeric parameters.
+ *
+ * @return Message $this
+ */
+ public function numParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::numParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Add parameters that are durations of time and will be passed through
+ * Language::formatDuration before substitution
+ *
+ * @since 1.22
+ *
+ * @param int|int[] $param,... Duration parameters, or a single argument that is
+ * an array of duration parameters.
+ *
+ * @return Message $this
+ */
+ public function durationParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::durationParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Add parameters that are expiration times and will be passed through
+ * Language::formatExpiry before substitution
+ *
+ * @since 1.22
+ *
+ * @param string|string[] $param,... Expiry parameters, or a single argument that is
+ * an array of expiry parameters.
+ *
+ * @return Message $this
+ */
+ public function expiryParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::expiryParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Add parameters that are time periods and will be passed through
+ * Language::formatTimePeriod before substitution
+ *
+ * @since 1.22
+ *
+ * @param int|int[] $param,... Time period parameters, or a single argument that is
+ * an array of time period parameters.
+ *
+ * @return Message $this
+ */
+ public function timeperiodParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::timeperiodParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Add parameters that are file sizes and will be passed through
+ * Language::formatSize before substitution
+ *
+ * @since 1.22
+ *
+ * @param int|int[] $param,... Size parameters, or a single argument that is
+ * an array of size parameters.
+ *
+ * @return Message $this
+ */
+ public function sizeParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::sizeParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Add parameters that are bitrates and will be passed through
+ * Language::formatBitrate before substitution
+ *
+ * @since 1.22
+ *
+ * @param int|int[] $param,... Bit rate parameters, or a single argument that is
+ * an array of bit rate parameters.
+ *
+ * @return Message $this
+ */
+ public function bitrateParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::bitrateParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Add parameters that are plaintext and will be passed through without
+ * the content being evaluated. Plaintext parameters are not valid as
+ * arguments to parser functions. This differs from self::rawParams in
+ * that the Message class handles escaping to match the output format.
+ *
+ * @since 1.25
+ *
+ * @param string|string[] $param,... plaintext parameters, or a single argument that is
+ * an array of plaintext parameters.
+ *
+ * @return Message $this
+ */
+ public function plaintextParams( /*...*/ ) {
+ $params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+ foreach ( $params as $param ) {
+ $this->parameters[] = self::plaintextParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Set the language and the title from a context object
+ *
+ * @since 1.19
+ *
+ * @param IContextSource $context
+ *
+ * @return Message $this
+ */
+ public function setContext( IContextSource $context ) {
+ $this->inLanguage( $context->getLanguage() );
+ $this->title( $context->getTitle() );
+ $this->interface = true;
+
+ return $this;
+ }
+
+ /**
+ * Request the message in any language that is supported.
+ *
+ * As a side effect interface message status is unconditionally
+ * turned off.
+ *
+ * @since 1.17
+ * @param Language|string $lang Language code or Language object.
+ * @return Message $this
+ * @throws MWException
+ */
+ public function inLanguage( $lang ) {
+ $previousLanguage = $this->language;
+
+ if ( $lang instanceof Language ) {
+ $this->language = $lang;
+ } elseif ( is_string( $lang ) ) {
+ if ( !$this->language instanceof Language || $this->language->getCode() != $lang ) {
+ $this->language = Language::factory( $lang );
+ }
+ } elseif ( $lang instanceof StubUserLang ) {
+ $this->language = false;
+ } else {
+ $type = gettype( $lang );
+ throw new MWException( __METHOD__ . " must be "
+ . "passed a String or Language object; $type given"
+ );
+ }
+
+ if ( $this->language !== $previousLanguage ) {
+ // The language has changed. Clear the message cache.
+ $this->message = null;
+ }
+ $this->interface = false;
+ return $this;
+ }
+
+ /**
+ * Request the message in the wiki's content language,
+ * unless it is disabled for this message.
+ *
+ * @since 1.17
+ * @see $wgForceUIMsgAsContentMsg
+ *
+ * @return Message $this
+ */
+ public function inContentLanguage() {
+ global $wgForceUIMsgAsContentMsg;
+ if ( in_array( $this->key, (array)$wgForceUIMsgAsContentMsg ) ) {
+ return $this;
+ }
+
+ $this->inLanguage( MediaWikiServices::getInstance()->getContentLanguage() );
+ return $this;
+ }
+
+ /**
+ * Allows manipulating the interface message flag directly.
+ * Can be used to restore the flag after setting a language.
+ *
+ * @since 1.20
+ *
+ * @param bool $interface
+ *
+ * @return Message $this
+ */
+ public function setInterfaceMessageFlag( $interface ) {
+ $this->interface = (bool)$interface;
+ return $this;
+ }
+
+ /**
+ * Enable or disable database use.
+ *
+ * @since 1.17
+ *
+ * @param bool $useDatabase
+ *
+ * @return Message $this
+ */
+ public function useDatabase( $useDatabase ) {
+ $this->useDatabase = (bool)$useDatabase;
+ $this->message = null;
+ return $this;
+ }
+
+ /**
+ * Set the Title object to use as context when transforming the message
+ *
+ * @since 1.18
+ *
+ * @param Title $title
+ *
+ * @return Message $this
+ */
+ public function title( $title ) {
+ $this->title = $title;
+ return $this;
+ }
+
+ /**
+ * Returns the message as a Content object.
+ *
+ * @return Content
+ */
+ public function content() {
+ if ( !$this->content ) {
+ $this->content = new MessageContent( $this );
+ }
+
+ return $this->content;
+ }
+
+ /**
+ * Returns the message parsed from wikitext to HTML.
+ *
+ * @since 1.17
+ *
+ * @param string|null $format One of the FORMAT_* constants. Null means use whatever was used
+ * the last time (this is for B/C and should be avoided).
+ *
+ * @return string HTML
+ * @suppress SecurityCheck-DoubleEscaped phan false positive
+ */
+ public function toString( $format = null ) {
+ if ( $format === null ) {
+ $ex = new LogicException( __METHOD__ . ' using implicit format: ' . $this->format );
+ \MediaWiki\Logger\LoggerFactory::getInstance( 'message-format' )->warning(
+ $ex->getMessage(), [ 'exception' => $ex, 'format' => $this->format, 'key' => $this->key ] );
+ $format = $this->format;
+ }
+ $string = $this->fetchMessage();
+
+ if ( $string === false ) {
+ // Err on the side of safety, ensure that the output
+ // is always html safe in the event the message key is
+ // missing, since in that case its highly likely the
+ // message key is user-controlled.
+ // '⧼' is used instead of '<' to side-step any
+ // double-escaping issues.
+ // (Keep synchronised with mw.Message#toString in JS.)
+ return '⧼' . htmlspecialchars( $this->key ) . '⧽';
+ }
+
+ # Replace $* with a list of parameters for &uselang=qqx.
+ if ( strpos( $string, '$*' ) !== false ) {
+ $paramlist = '';
+ if ( $this->parameters !== [] ) {
+ $paramlist = ': $' . implode( ', $', range( 1, count( $this->parameters ) ) );
+ }
+ $string = str_replace( '$*', $paramlist, $string );
+ }
+
+ # Replace parameters before text parsing
+ $string = $this->replaceParameters( $string, 'before', $format );
+
+ # Maybe transform using the full parser
+ if ( $format === self::FORMAT_PARSE ) {
+ $string = $this->parseText( $string );
+ $string = Parser::stripOuterParagraph( $string );
+ } elseif ( $format === self::FORMAT_BLOCK_PARSE ) {
+ $string = $this->parseText( $string );
+ } elseif ( $format === self::FORMAT_TEXT ) {
+ $string = $this->transformText( $string );
+ } elseif ( $format === self::FORMAT_ESCAPED ) {
+ $string = $this->transformText( $string );
+ $string = htmlspecialchars( $string, ENT_QUOTES, 'UTF-8', false );
+ }
+
+ # Raw parameter replacement
+ $string = $this->replaceParameters( $string, 'after', $format );
+
+ return $string;
+ }
+
+ /**
+ * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg:
+ * $foo = new Message( $key );
+ * $string = "<abbr>$foo</abbr>";
+ *
+ * @since 1.18
+ *
+ * @return string
+ */
+ public function __toString() {
+ // PHP doesn't allow __toString to throw exceptions and will
+ // trigger a fatal error if it does. So, catch any exceptions.
+
+ try {
+ return $this->toString( self::FORMAT_PARSE );
+ } catch ( Exception $ex ) {
+ try {
+ trigger_error( "Exception caught in " . __METHOD__ . " (message " . $this->key . "): "
+ . $ex, E_USER_WARNING );
+ } catch ( Exception $ex ) {
+ // Doh! Cause a fatal error after all?
+ }
+
+ return '⧼' . htmlspecialchars( $this->key ) . '⧽';
+ }
+ }
+
+ /**
+ * Fully parse the text from wikitext to HTML.
+ *
+ * @since 1.17
+ *
+ * @return string Parsed HTML.
+ */
+ public function parse() {
+ $this->format = self::FORMAT_PARSE;
+ return $this->toString( self::FORMAT_PARSE );
+ }
+
+ /**
+ * Returns the message text. {{-transformation is done.
+ *
+ * @since 1.17
+ *
+ * @return string Unescaped message text.
+ */
+ public function text() {
+ $this->format = self::FORMAT_TEXT;
+ return $this->toString( self::FORMAT_TEXT );
+ }
+
+ /**
+ * Returns the message text as-is, only parameters are substituted.
+ *
+ * @since 1.17
+ *
+ * @return string Unescaped untransformed message text.
+ */
+ public function plain() {
+ $this->format = self::FORMAT_PLAIN;
+ return $this->toString( self::FORMAT_PLAIN );
+ }
+
+ /**
+ * Returns the parsed message text which is always surrounded by a block element.
+ *
+ * @since 1.17
+ *
+ * @return string HTML
+ */
+ public function parseAsBlock() {
+ $this->format = self::FORMAT_BLOCK_PARSE;
+ return $this->toString( self::FORMAT_BLOCK_PARSE );
+ }
+
+ /**
+ * Returns the message text. {{-transformation is done and the result
+ * is escaped excluding any raw parameters.
+ *
+ * @since 1.17
+ *
+ * @return string Escaped message text.
+ */
+ public function escaped() {
+ $this->format = self::FORMAT_ESCAPED;
+ return $this->toString( self::FORMAT_ESCAPED );
+ }
+
+ /**
+ * Check whether a message key has been defined currently.
+ *
+ * @since 1.17
+ *
+ * @return bool
+ */
+ public function exists() {
+ return $this->fetchMessage() !== false;
+ }
+
+ /**
+ * Check whether a message does not exist, or is an empty string
+ *
+ * @since 1.18
+ * @todo FIXME: Merge with isDisabled()?
+ *
+ * @return bool
+ */
+ public function isBlank() {
+ $message = $this->fetchMessage();
+ return $message === false || $message === '';
+ }
+
+ /**
+ * Check whether a message does not exist, is an empty string, or is "-".
+ *
+ * @since 1.18
+ *
+ * @return bool
+ */
+ public function isDisabled() {
+ $message = $this->fetchMessage();
+ return $message === false || $message === '' || $message === '-';
+ }
+
+ /**
+ * @since 1.17
+ *
+ * @param mixed $raw
+ *
+ * @return array Array with a single "raw" key.
+ */
+ public static function rawParam( $raw ) {
+ return [ 'raw' => $raw ];
+ }
+
+ /**
+ * @since 1.18
+ *
+ * @param mixed $num
+ *
+ * @return array Array with a single "num" key.
+ */
+ public static function numParam( $num ) {
+ return [ 'num' => $num ];
+ }
+
+ /**
+ * @since 1.22
+ *
+ * @param int $duration
+ *
+ * @return int[] Array with a single "duration" key.
+ */
+ public static function durationParam( $duration ) {
+ return [ 'duration' => $duration ];
+ }
+
+ /**
+ * @since 1.22
+ *
+ * @param string $expiry
+ *
+ * @return string[] Array with a single "expiry" key.
+ */
+ public static function expiryParam( $expiry ) {
+ return [ 'expiry' => $expiry ];
+ }
+
+ /**
+ * @since 1.22
+ *
+ * @param int $period
+ *
+ * @return int[] Array with a single "period" key.
+ */
+ public static function timeperiodParam( $period ) {
+ return [ 'period' => $period ];
+ }
+
+ /**
+ * @since 1.22
+ *
+ * @param int $size
+ *
+ * @return int[] Array with a single "size" key.
+ */
+ public static function sizeParam( $size ) {
+ return [ 'size' => $size ];
+ }
+
+ /**
+ * @since 1.22
+ *
+ * @param int $bitrate
+ *
+ * @return int[] Array with a single "bitrate" key.
+ */
+ public static function bitrateParam( $bitrate ) {
+ return [ 'bitrate' => $bitrate ];
+ }
+
+ /**
+ * @since 1.25
+ *
+ * @param string $plaintext
+ *
+ * @return string[] Array with a single "plaintext" key.
+ */
+ public static function plaintextParam( $plaintext ) {
+ return [ 'plaintext' => $plaintext ];
+ }
+
+ /**
+ * @since 1.29
+ *
+ * @param array $list
+ * @param string $type 'comma', 'semicolon', 'pipe', 'text'
+ * @return array Array with "list" and "type" keys.
+ */
+ public static function listParam( array $list, $type = 'text' ) {
+ if ( !isset( self::$listTypeMap[$type] ) ) {
+ throw new InvalidArgumentException(
+ "Invalid type '$type'. Known types are: " . implode( ', ', array_keys( self::$listTypeMap ) )
+ );
+ }
+ return [ 'list' => $list, 'type' => $type ];
+ }
+
+ /**
+ * Substitutes any parameters into the message text.
+ *
+ * @since 1.17
+ *
+ * @param string $message The message text.
+ * @param string $type Either "before" or "after".
+ * @param string $format One of the FORMAT_* constants.
+ *
+ * @return string
+ */
+ protected function replaceParameters( $message, $type, $format ) {
+ // A temporary marker for $1 parameters that is only valid
+ // in non-attribute contexts. However if the entire message is escaped
+ // then we don't want to use it because it will be mangled in all contexts
+ // and its unnessary as ->escaped() messages aren't html.
+ $marker = $format === self::FORMAT_ESCAPED ? '$' : '$\'"';
+ $replacementKeys = [];
+ foreach ( $this->parameters as $n => $param ) {
+ list( $paramType, $value ) = $this->extractParam( $param, $format );
+ if ( $type === 'before' ) {
+ if ( $paramType === 'before' ) {
+ $replacementKeys['$' . ( $n + 1 )] = $value;
+ } else /* $paramType === 'after' */ {
+ // To protect against XSS from replacing parameters
+ // inside html attributes, we convert $1 to $'"1.
+ // In the event that one of the parameters ends up
+ // in an attribute, either the ' or the " will be
+ // escaped, breaking the replacement and avoiding XSS.
+ $replacementKeys['$' . ( $n + 1 )] = $marker . ( $n + 1 );
+ }
+ } elseif ( $paramType === 'after' ) {
+ $replacementKeys[$marker . ( $n + 1 )] = $value;
+ }
+ }
+ return strtr( $message, $replacementKeys );
+ }
+
+ /**
+ * Extracts the parameter type and preprocessed the value if needed.
+ *
+ * @since 1.18
+ *
+ * @param mixed $param Parameter as defined in this class.
+ * @param string $format One of the FORMAT_* constants.
+ *
+ * @return array Array with the parameter type (either "before" or "after") and the value.
+ */
+ protected function extractParam( $param, $format ) {
+ if ( is_array( $param ) ) {
+ if ( isset( $param['raw'] ) ) {
+ return [ 'after', $param['raw'] ];
+ } elseif ( isset( $param['num'] ) ) {
+ // Replace number params always in before step for now.
+ // No support for combined raw and num params
+ return [ 'before', $this->getLanguage()->formatNum( $param['num'] ) ];
+ } elseif ( isset( $param['duration'] ) ) {
+ return [ 'before', $this->getLanguage()->formatDuration( $param['duration'] ) ];
+ } elseif ( isset( $param['expiry'] ) ) {
+ return [ 'before', $this->getLanguage()->formatExpiry( $param['expiry'] ) ];
+ } elseif ( isset( $param['period'] ) ) {
+ return [ 'before', $this->getLanguage()->formatTimePeriod( $param['period'] ) ];
+ } elseif ( isset( $param['size'] ) ) {
+ return [ 'before', $this->getLanguage()->formatSize( $param['size'] ) ];
+ } elseif ( isset( $param['bitrate'] ) ) {
+ return [ 'before', $this->getLanguage()->formatBitrate( $param['bitrate'] ) ];
+ } elseif ( isset( $param['plaintext'] ) ) {
+ return [ 'after', $this->formatPlaintext( $param['plaintext'], $format ) ];
+ } elseif ( isset( $param['list'] ) ) {
+ return $this->formatListParam( $param['list'], $param['type'], $format );
+ } else {
+ if ( !is_scalar( $param ) ) {
+ $param = serialize( $param );
+ }
+ \MediaWiki\Logger\LoggerFactory::getInstance( 'Bug58676' )->warning(
+ 'Invalid parameter for message "{msgkey}": {param}',
+ [
+ 'exception' => new Exception,
+ 'msgkey' => $this->getKey(),
+ 'param' => htmlspecialchars( $param ),
+ ]
+ );
+
+ return [ 'before', '[INVALID]' ];
+ }
+ } elseif ( $param instanceof Message ) {
+ // Match language, flags, etc. to the current message.
+ $msg = clone $param;
+ if ( $msg->language !== $this->language || $msg->useDatabase !== $this->useDatabase ) {
+ // Cache depends on these parameters
+ $msg->message = null;
+ }
+ $msg->interface = $this->interface;
+ $msg->language = $this->language;
+ $msg->useDatabase = $this->useDatabase;
+ $msg->title = $this->title;
+
+ // DWIM
+ if ( $format === 'block-parse' ) {
+ $format = 'parse';
+ }
+ $msg->format = $format;
+
+ // Message objects should not be before parameters because
+ // then they'll get double escaped. If the message needs to be
+ // escaped, it'll happen right here when we call toString().
+ return [ 'after', $msg->toString( $format ) ];
+ } else {
+ return [ 'before', $param ];
+ }
+ }
+
+ /**
+ * Wrapper for what ever method we use to parse wikitext.
+ *
+ * @since 1.17
+ *
+ * @param string $string Wikitext message contents.
+ *
+ * @return string Wikitext parsed into HTML.
+ */
+ protected function parseText( $string ) {
+ $out = MessageCache::singleton()->parse(
+ $string,
+ $this->title,
+ /*linestart*/true,
+ $this->interface,
+ $this->getLanguage()
+ );
+
+ return $out instanceof ParserOutput
+ ? $out->getText( [
+ 'enableSectionEditLinks' => false,
+ // Wrapping messages in an extra <div> is probably not expected. If
+ // they're outside the content area they probably shouldn't be
+ // targeted by CSS that's targeting the parser output, and if
+ // they're inside they already are from the outer div.
+ 'unwrap' => true,
+ ] )
+ : $out;
+ }
+
+ /**
+ * Wrapper for what ever method we use to {{-transform wikitext.
+ *
+ * @since 1.17
+ *
+ * @param string $string Wikitext message contents.
+ *
+ * @return string Wikitext with {{-constructs replaced with their values.
+ */
+ protected function transformText( $string ) {
+ return MessageCache::singleton()->transform(
+ $string,
+ $this->interface,
+ $this->getLanguage(),
+ $this->title
+ );
+ }
+
+ /**
+ * Wrapper for what ever method we use to get message contents.
+ *
+ * @since 1.17
+ *
+ * @return string
+ * @throws MWException If message key array is empty.
+ */
+ protected function fetchMessage() {
+ if ( $this->message === null ) {
+ $cache = MessageCache::singleton();
+
+ foreach ( $this->keysToTry as $key ) {
+ $message = $cache->get( $key, $this->useDatabase, $this->getLanguage() );
+ if ( $message !== false && $message !== '' ) {
+ break;
+ }
+ }
+
+ // NOTE: The constructor makes sure keysToTry isn't empty,
+ // so we know that $key and $message are initialized.
+ $this->key = $key;
+ $this->message = $message;
+ }
+ return $this->message;
+ }
+
+ /**
+ * Formats a message parameter wrapped with 'plaintext'. Ensures that
+ * the entire string is displayed unchanged when displayed in the output
+ * format.
+ *
+ * @since 1.25
+ *
+ * @param string $plaintext String to ensure plaintext output of
+ * @param string $format One of the FORMAT_* constants.
+ *
+ * @return string Input plaintext encoded for output to $format
+ */
+ protected function formatPlaintext( $plaintext, $format ) {
+ switch ( $format ) {
+ case self::FORMAT_TEXT:
+ case self::FORMAT_PLAIN:
+ return $plaintext;
+
+ case self::FORMAT_PARSE:
+ case self::FORMAT_BLOCK_PARSE:
+ case self::FORMAT_ESCAPED:
+ default:
+ return htmlspecialchars( $plaintext, ENT_QUOTES );
+ }
+ }
+
+ /**
+ * Formats a list of parameters as a concatenated string.
+ * @since 1.29
+ * @param array $params
+ * @param string $listType
+ * @param string $format One of the FORMAT_* constants.
+ * @return array Array with the parameter type (either "before" or "after") and the value.
+ */
+ protected function formatListParam( array $params, $listType, $format ) {
+ if ( !isset( self::$listTypeMap[$listType] ) ) {
+ $warning = 'Invalid list type for message "' . $this->getKey() . '": '
+ . htmlspecialchars( $listType )
+ . ' (params are ' . htmlspecialchars( serialize( $params ) ) . ')';
+ trigger_error( $warning, E_USER_WARNING );
+ $e = new Exception;
+ wfDebugLog( 'Bug58676', $warning . "\n" . $e->getTraceAsString() );
+ return [ 'before', '[INVALID]' ];
+ }
+ $func = self::$listTypeMap[$listType];
+
+ // Handle an empty list sensibly
+ if ( !$params ) {
+ return [ 'before', $this->getLanguage()->$func( [] ) ];
+ }
+
+ // First, determine what kinds of list items we have
+ $types = [];
+ $vars = [];
+ $list = [];
+ foreach ( $params as $n => $p ) {
+ list( $type, $value ) = $this->extractParam( $p, $format );
+ $types[$type] = true;
+ $list[] = $value;
+ $vars[] = '$' . ( $n + 1 );
+ }
+
+ // Easy case: all are 'before' or 'after', so just join the
+ // values and use the same type.
+ if ( count( $types ) === 1 ) {
+ return [ key( $types ), $this->getLanguage()->$func( $list ) ];
+ }
+
+ // Hard case: We need to process each value per its type, then
+ // return the concatenated values as 'after'. We handle this by turning
+ // the list into a RawMessage and processing that as a parameter.
+ $vars = $this->getLanguage()->$func( $vars );
+ return $this->extractParam( new RawMessage( $vars, $params ), $format );
+ }
+}
--- /dev/null
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Language
+ */
+
+/**
+ * Interface for localizing messages in MediaWiki
+ *
+ * @since 1.30
+ * @ingroup Language
+ */
+interface MessageLocalizer {
+
+ /**
+ * This is the method for getting translated interface messages.
+ *
+ * @see https://www.mediawiki.org/wiki/Manual:Messages_API
+ * @see Message::__construct
+ *
+ * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
+ * or a MessageSpecifier.
+ * @param mixed $params,... Normal message parameters
+ * @return Message
+ */
+ public function msg( $key /*...*/ );
+
+}
* Fetch a result row as an associative and numeric array
*
* @param resource $res Raw result
- * @return array
+ * @return array|false
*/
abstract protected function mysqlFetchArray( $res );
/**
* @param mysqli_result $res
- * @return bool
+ * @return array|false
*/
protected function mysqlFetchArray( $res ) {
$array = $res->fetch_array();
--- /dev/null
+<?php
+/**
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * @internal For use by ResourceLoaderStartUpModule only
+ */
+class ResourceLoaderCircularDependencyError extends Exception {
+}
protected $origin = self::ORIGIN_CORE_SITEWIDE;
- /** @var ResourceLoaderImage[]|null */
+ /** @var ResourceLoaderImage[][]|null */
protected $imageObjects = null;
/** @var array */
protected $images = [];
*
* @param string $blob
* @param array $exclusions
- * @return array $blob
+ * @return object $blob
*/
protected function excludeMessagesFromBlob( $blob, $exclusions ) {
$data = json_decode( $blob, true );
*
* @param array $registryData
* @param string $moduleName
+ * @param string[] $handled Internal parameter for recursion. (Optional)
* @return array
+ * @throws ResourceLoaderCircularDependencyError
*/
- protected static function getImplicitDependencies( array $registryData, $moduleName ) {
+ protected static function getImplicitDependencies(
+ array $registryData,
+ $moduleName,
+ array $handled = []
+ ) {
static $dependencyCache = [];
- // The list of implicit dependencies won't be altered, so we can
- // cache them without having to worry.
+ // No modules will be added or changed server-side after this point,
+ // so we can safely cache parts of the tree for re-use.
if ( !isset( $dependencyCache[$moduleName] ) ) {
if ( !isset( $registryData[$moduleName] ) ) {
- // Dependencies may not exist
- $dependencyCache[$moduleName] = [];
+ // Unknown module names are allowed here, this is only an optimisation.
+ // Checks for illegal and unknown dependencies happen as PHPUnit structure tests,
+ // and also client-side at run-time.
+ $flat = [];
} else {
$data = $registryData[$moduleName];
- $dependencyCache[$moduleName] = $data['dependencies'];
+ $flat = $data['dependencies'];
+ // Prevent recursion
+ $handled[] = $moduleName;
foreach ( $data['dependencies'] as $dependency ) {
- // Recursively get the dependencies of the dependencies
- $dependencyCache[$moduleName] = array_merge(
- $dependencyCache[$moduleName],
- self::getImplicitDependencies( $registryData, $dependency )
- );
+ if ( in_array( $dependency, $handled, true ) ) {
+ // If we encounter a circular dependency, then stop the optimiser and leave the
+ // original dependencies array unmodified. Circular dependencies are not
+ // supported in ResourceLoader. Awareness of them exists here so that we can
+ // optimise the registry when it isn't broken, and otherwise transport the
+ // registry unchanged. The client will handle this further.
+ throw new ResourceLoaderCircularDependencyError();
+ } else {
+ // Recursively add the dependencies of the dependencies
+ $flat = array_merge(
+ $flat,
+ self::getImplicitDependencies( $registryData, $dependency, $handled )
+ );
+ }
}
}
+
+ $dependencyCache[$moduleName] = $flat;
}
return $dependencyCache[$moduleName];
public static function compileUnresolvedDependencies( array &$registryData ) {
foreach ( $registryData as $name => &$data ) {
$dependencies = $data['dependencies'];
- foreach ( $data['dependencies'] as $dependency ) {
- $implicitDependencies = self::getImplicitDependencies( $registryData, $dependency );
- $dependencies = array_diff( $dependencies, $implicitDependencies );
+ try {
+ foreach ( $data['dependencies'] as $dependency ) {
+ $implicitDependencies = self::getImplicitDependencies( $registryData, $dependency );
+ $dependencies = array_diff( $dependencies, $implicitDependencies );
+ }
+ } catch ( ResourceLoaderCircularDependencyError $err ) {
+ // Leave unchanged
+ $dependencies = $data['dependencies'];
}
+
// Rebuild keys
$data['dependencies'] = array_values( $dependencies );
}
* List all files in the stash.
*
* @throws UploadStashNotLoggedInException
- * @return array
+ * @return array|false
*/
public function listFiles() {
if ( !$this->isLoggedIn ) {
use MediaWiki\Auth\AuthenticationResponse;
use MediaWiki\MediaWikiServices;
use MediaWiki\Session\BotPasswordSessionProvider;
-use Wikimedia\Rdbms\IMaintainableDatabase;
+use Wikimedia\Rdbms\IDatabase;
/**
* Utility class for bot passwords
/**
* Get a database connection for the bot passwords database
* @param int $db Index of the connection to get, e.g. DB_MASTER or DB_REPLICA.
- * @return IMaintainableDatabase
+ * @return IDatabase
*/
public static function getDB( $db ) {
global $wgBotPasswordsCluster, $wgBotPasswordsDatabase;
+++ /dev/null
-<?php
-/**
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup Language
- */
-
-/**
- * Methods for dealing with language codes.
- * @todo Move some of the code-related static methods out of Language into this class
- *
- * @since 1.29
- * @ingroup Language
- */
-class LanguageCode {
- /**
- * Mapping of deprecated language codes that were used in previous
- * versions of MediaWiki to up-to-date, current language codes.
- * These may or may not be valid BCP 47 codes; they are included here
- * because MediaWiki renamed these particular codes at some point.
- *
- * @var array Mapping from deprecated MediaWiki-internal language code
- * to replacement MediaWiki-internal language code.
- *
- * @since 1.30
- * @see https://meta.wikimedia.org/wiki/Special_language_codes
- */
- private static $deprecatedLanguageCodeMapping = [
- // Note that als is actually a valid ISO 639 code (Tosk Albanian), but it
- // was previously used in MediaWiki for Alsatian, which comes under gsw
- 'als' => 'gsw', // T25215
- 'bat-smg' => 'sgs', // T27522
- 'be-x-old' => 'be-tarask', // T11823
- 'fiu-vro' => 'vro', // T31186
- 'roa-rup' => 'rup', // T17988
- 'zh-classical' => 'lzh', // T30443
- 'zh-min-nan' => 'nan', // T30442
- 'zh-yue' => 'yue', // T30441
- ];
-
- /**
- * Mapping of non-standard language codes used in MediaWiki to
- * standardized BCP 47 codes. These are not deprecated (yet?):
- * IANA may eventually recognize the subtag, in which case the `-x-`
- * infix could be removed, or else we could rename the code in
- * MediaWiki, in which case they'd move up to the above mapping
- * of deprecated codes.
- *
- * As a rule, we preserve all distinctions made by MediaWiki
- * internally. For example, `de-formal` becomes `de-x-formal`
- * instead of just `de` because MediaWiki distinguishes `de-formal`
- * from `de` (for example, for interface translations). Similarly,
- * BCP 47 indicates that `kk-Cyrl` SHOULD not be used because it
- * "typically does not add information", but in our case MediaWiki
- * LanguageConverter distinguishes `kk` (render content in a mix of
- * Kurdish variants) from `kk-Cyrl` (convert content to be uniformly
- * Cyrillic). As the BCP 47 requirement is a SHOULD not a MUST,
- * `kk-Cyrl` is a valid code, although some validators may emit
- * a warning note.
- *
- * @var array Mapping from nonstandard MediaWiki-internal codes to
- * BCP 47 codes
- *
- * @since 1.32
- * @see https://meta.wikimedia.org/wiki/Special_language_codes
- * @see https://phabricator.wikimedia.org/T125073
- */
- private static $nonstandardLanguageCodeMapping = [
- // All codes returned by Language::fetchLanguageNames() validated
- // against IANA registry at
- // https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
- // with help of validator at
- // http://schneegans.de/lv/
- 'cbk-zam' => 'cbk', // T124657
- 'de-formal' => 'de-x-formal',
- 'eml' => 'egl', // T36217
- 'en-rtl' => 'en-x-rtl',
- 'es-formal' => 'es-x-formal',
- 'hu-formal' => 'hu-x-formal',
- 'map-bms' => 'jv-x-bms', // [[en:Banyumasan_dialect]] T125073
- 'mo' => 'ro-Cyrl-MD', // T125073
- 'nrm' => 'nrf', // [[en:Norman_language]] T25216
- 'nl-informal' => 'nl-x-informal',
- 'roa-tara' => 'nap-x-tara', // [[en:Tarantino_dialect]]
- 'simple' => 'en-simple',
- 'sr-ec' => 'sr-Cyrl', // T117845
- 'sr-el' => 'sr-Latn', // T117845
-
- // Although these next codes aren't *wrong* per se, including
- // both the script and the country code helps compatibility with
- // other BCP 47 users. Note that MW also uses `zh-Hans`/`zh-Hant`,
- // without a country code, and those should be left alone.
- // (See $variantfallbacks in LanguageZh.php for Hans/Hant id.)
- 'zh-cn' => 'zh-Hans-CN',
- 'zh-sg' => 'zh-Hans-SG',
- 'zh-my' => 'zh-Hans-MY',
- 'zh-tw' => 'zh-Hant-TW',
- 'zh-hk' => 'zh-Hant-HK',
- 'zh-mo' => 'zh-Hant-MO',
- ];
-
- /**
- * Returns a mapping of deprecated language codes that were used in previous
- * versions of MediaWiki to up-to-date, current language codes.
- *
- * This array is merged into $wgDummyLanguageCodes in Setup.php, along with
- * the fake language codes 'qqq' and 'qqx', which are used internally by
- * MediaWiki's localisation system.
- *
- * @return string[]
- *
- * @since 1.29
- */
- public static function getDeprecatedCodeMapping() {
- return self::$deprecatedLanguageCodeMapping;
- }
-
- /**
- * Returns a mapping of non-standard language codes used by
- * (current and previous version of) MediaWiki, mapped to standard
- * BCP 47 names.
- *
- * This array is exported to JavaScript to ensure
- * mediawiki.language.bcp47 stays in sync with LanguageCode::bcp47().
- *
- * @return string[]
- *
- * @since 1.32
- */
- public static function getNonstandardLanguageCodeMapping() {
- $result = [];
- foreach ( self::$deprecatedLanguageCodeMapping as $code => $ignore ) {
- $result[$code] = self::bcp47( $code );
- }
- foreach ( self::$nonstandardLanguageCodeMapping as $code => $ignore ) {
- $result[$code] = self::bcp47( $code );
- }
- return $result;
- }
-
- /**
- * Replace deprecated language codes that were used in previous
- * versions of MediaWiki to up-to-date, current language codes.
- * Other values will returned unchanged.
- *
- * @param string $code Old language code
- * @return string New language code
- *
- * @since 1.30
- */
- public static function replaceDeprecatedCodes( $code ) {
- return self::$deprecatedLanguageCodeMapping[$code] ?? $code;
- }
-
- /**
- * Get the normalised IETF language tag
- * See unit test for examples.
- * See mediawiki.language.bcp47 for the JavaScript implementation.
- *
- * @param string $code The language code.
- * @return string A language code complying with BCP 47 standards.
- *
- * @since 1.31
- */
- public static function bcp47( $code ) {
- $code = self::replaceDeprecatedCodes( strtolower( $code ) );
- if ( isset( self::$nonstandardLanguageCodeMapping[$code] ) ) {
- $code = self::$nonstandardLanguageCodeMapping[$code];
- }
- $codeSegment = explode( '-', $code );
- $codeBCP = [];
- foreach ( $codeSegment as $segNo => $seg ) {
- // when previous segment is x, it is a private segment and should be lc
- if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
- $codeBCP[$segNo] = strtolower( $seg );
- // ISO 3166 country code
- } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
- $codeBCP[$segNo] = strtoupper( $seg );
- // ISO 15924 script code
- } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
- $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
- // Use lowercase for other cases
- } else {
- $codeBCP[$segNo] = strtolower( $seg );
- }
- }
- $langCode = implode( '-', $codeBCP );
- return $langCode;
- }
-}
+++ /dev/null
-<?php
-/**
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup Language
- */
-
-/**
- * Interface for localizing messages in MediaWiki
- *
- * @since 1.30
- * @ingroup Language
- */
-interface MessageLocalizer {
-
- /**
- * This is the method for getting translated interface messages.
- *
- * @see https://www.mediawiki.org/wiki/Manual:Messages_API
- * @see Message::__construct
- *
- * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
- * or a MessageSpecifier.
- * @param mixed $params,... Normal message parameters
- * @return Message
- */
- public function msg( $key /*...*/ );
-
-}
*/
use MediaWiki\MediaWikiServices;
+use Wikimedia\Rdbms\IResultWrapper;
require_once __DIR__ . '/Maintenance.php';
* Return a database resolution of all the pages in a given namespace
*
* @param int $namespace Limit the query to this namespace
- * @return Resource
+ * @return IResultWrapper
*/
function getPageRes( $namespace ) {
return $this->dbr->select( 'page',
"c",
"{blankVer}"
]
+] );',
+ ] ],
+ [ [
+ // Regression test for T223402.
+ 'msg' => 'Optimise the dependency tree (indirect circular dependency)',
+ 'modules' => [
+ 'top' => new ResourceLoaderTestModule( [ 'dependencies' => [ 'middle1', 'util' ] ] ),
+ 'middle1' => new ResourceLoaderTestModule( [ 'dependencies' => [ 'middle2', 'util' ] ] ),
+ 'middle2' => new ResourceLoaderTestModule( [ 'dependencies' => [ 'bottom' ] ] ),
+ 'bottom' => new ResourceLoaderTestModule( [ 'dependencies' => [ 'top' ] ] ),
+ 'util' => new ResourceLoaderTestModule( [ 'dependencies' => [] ] ),
+ ],
+ 'out' => '
+mw.loader.addSource( {
+ "local": "/w/load.php"
+} );
+mw.loader.register( [
+ [
+ "top",
+ "{blankVer}",
+ [
+ 1,
+ 4
+ ]
+ ],
+ [
+ "middle1",
+ "{blankVer}",
+ [
+ 2,
+ 4
+ ]
+ ],
+ [
+ "middle2",
+ "{blankVer}",
+ [
+ 3
+ ]
+ ],
+ [
+ "bottom",
+ "{blankVer}",
+ [
+ 0
+ ]
+ ],
+ [
+ "util",
+ "{blankVer}"
+ ]
+] );',
+ ] ],
+ [ [
+ // Regression test for T223402.
+ 'msg' => 'Optimise the dependency tree (direct circular dependency)',
+ 'modules' => [
+ 'top' => new ResourceLoaderTestModule( [ 'dependencies' => [ 'util', 'top' ] ] ),
+ 'util' => new ResourceLoaderTestModule( [ 'dependencies' => [] ] ),
+ ],
+ 'out' => '
+mw.loader.addSource( {
+ "local": "/w/load.php"
+} );
+mw.loader.register( [
+ [
+ "top",
+ "{blankVer}",
+ [
+ 1,
+ 0
+ ]
+ ],
+ [
+ "util",
+ "{blankVer}"
+ ]
] );',
] ],
[ [
dépôts / lhc / web / wiklou.git / commitdiff