3 * Fetching and processing of interface messages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Niklas Laxström
23 use MediaWiki\MediaWikiServices
;
26 * The Message class provides methods which fulfil two basic services:
27 * - fetching interface messages
28 * - processing messages into a variety of formats
30 * First implemented with MediaWiki 1.17, the Message class is intended to
31 * replace the old wfMsg* functions that over time grew unusable.
32 * @see https://www.mediawiki.org/wiki/Manual:Messages_API for equivalences
33 * between old and new functions.
35 * You should use the wfMessage() global function which acts as a wrapper for
36 * the Message class. The wrapper let you pass parameters as arguments.
38 * The most basic usage cases would be:
41 * // Initialize a Message object using the 'some_key' message key
42 * $message = wfMessage( 'some_key' );
44 * // Using two parameters those values are strings 'value1' and 'value2':
45 * $message = wfMessage( 'some_key',
50 * @section message_global_fn Global function wrapper:
52 * Since wfMessage() returns a Message instance, you can chain its call with
53 * a method. Some of them return a Message instance too so you can chain them.
54 * You will find below several examples of wfMessage() usage.
56 * Fetching a message text for interface message:
59 * $button = Xml::button(
60 * wfMessage( 'submit' )->text()
64 * A Message instance can be passed parameters after it has been constructed,
65 * use the params() method to do so:
68 * wfMessage( 'welcome-to' )
69 * ->params( $wgSitename )
73 * {{GRAMMAR}} and friends work correctly:
76 * wfMessage( 'are-friends',
79 * wfMessage( 'bad-message' )
80 * ->rawParams( '<script>...</script>' )
84 * @section message_language Changing language:
86 * Messages can be requested in a different language or in whatever current
87 * content language is being used. The methods are:
88 * - Message->inContentLanguage()
89 * - Message->inLanguage()
91 * Sometimes the message text ends up in the database, so content language is
95 * wfMessage( 'file-log',
97 * )->inContentLanguage()->text();
100 * Checking whether a message exists:
103 * wfMessage( 'mysterious-message' )->exists()
104 * // returns a boolean whether the 'mysterious-message' key exist.
107 * If you want to use a different language:
110 * $userLanguage = $user->getOption( 'language' );
111 * wfMessage( 'email-header' )
112 * ->inLanguage( $userLanguage )
116 * @note You can parse the text only in the content or interface languages
118 * @section message_compare_old Comparison with old wfMsg* functions:
124 * wfMsgExt( 'key', [ 'parseinline' ], 'apple' );
126 * wfMessage( 'key', 'apple' )->parse();
129 * Parseinline is used because it is more useful when pre-building HTML.
130 * In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
132 * Places where HTML cannot be used. {{-transformation is done.
135 * wfMsgExt( 'key', [ 'parsemag' ], 'apple', 'pear' );
137 * wfMessage( 'key', 'apple', 'pear' )->text();
140 * Shortcut for escaping the message too, similar to wfMsgHTML(), but
141 * parameters are not replaced after escaping by default.
143 * $escaped = wfMessage( 'key' )
144 * ->rawParams( 'apple' )
148 * @section message_appendix Appendix:
151 * - test, can we have tests?
152 * - this documentation needs to be extended
154 * @see https://www.mediawiki.org/wiki/WfMessage()
155 * @see https://www.mediawiki.org/wiki/New_messages_API
156 * @see https://www.mediawiki.org/wiki/Localisation
160 class Message
implements MessageSpecifier
, Serializable
{
161 /** Use message text as-is */
162 const FORMAT_PLAIN
= 'plain';
163 /** Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag) */
164 const FORMAT_BLOCK_PARSE
= 'block-parse';
165 /** Use normal wikitext -> HTML parsing but strip the block-level wrapper */
166 const FORMAT_PARSE
= 'parse';
167 /** Transform {{..}} constructs but don't transform to HTML */
168 const FORMAT_TEXT
= 'text';
169 /** Transform {{..}} constructs, HTML-escape the result */
170 const FORMAT_ESCAPED
= 'escaped';
173 * Mapping from Message::listParam() types to Language methods.
176 protected static $listTypeMap = [
177 'comma' => 'commaList',
178 'semicolon' => 'semicolonList',
179 'pipe' => 'pipeList',
180 'text' => 'listToText',
184 * In which language to get this message. True, which is the default,
185 * means the current user language, false content language.
189 protected $interface = true;
192 * In which language to get this message. Overrides the $interface setting.
194 * @var Language|bool Explicit language object, or false for user language
196 protected $language = false;
199 * @var string The message key. If $keysToTry has more than one element,
200 * this may change to one of the keys to try when fetching the message text.
205 * @var string[] List of keys to try when fetching the message.
207 protected $keysToTry;
210 * @var array List of parameters which will be substituted into the message.
212 protected $parameters = [];
218 protected $format = 'parse';
221 * @var bool Whether database can be used.
223 protected $useDatabase = true;
226 * @var Title Title object to use as context.
228 protected $title = null;
231 * @var Content Content object representing the message.
233 protected $content = null;
242 * @param string|string[]|MessageSpecifier $key Message key, or array of
243 * message keys to try and use the first non-empty message for, or a
244 * MessageSpecifier to copy from.
245 * @param array $params Message parameters.
246 * @param Language|null $language [optional] Language to use (defaults to current user language).
247 * @throws InvalidArgumentException
249 public function __construct( $key, $params = [], Language
$language = null ) {
250 if ( $key instanceof MessageSpecifier
) {
252 throw new InvalidArgumentException(
253 '$params must be empty if $key is a MessageSpecifier'
256 $params = $key->getParams();
257 $key = $key->getKey();
260 if ( !is_string( $key ) && !is_array( $key ) ) {
261 throw new InvalidArgumentException( '$key must be a string or an array' );
264 $this->keysToTry
= (array)$key;
266 if ( empty( $this->keysToTry
) ) {
267 throw new InvalidArgumentException( '$key must not be an empty list' );
270 $this->key
= reset( $this->keysToTry
);
272 $this->parameters
= array_values( $params );
273 // User language is only resolved in getLanguage(). This helps preserve the
274 // semantic intent of "user language" across serialize() and unserialize().
275 $this->language
= $language ?
: false;
279 * @see Serializable::serialize()
283 public function serialize() {
285 'interface' => $this->interface,
286 'language' => $this->language ?
$this->language
->getCode() : false,
288 'keysToTry' => $this->keysToTry
,
289 'parameters' => $this->parameters
,
290 'format' => $this->format
,
291 'useDatabase' => $this->useDatabase
,
292 'title' => $this->title
,
297 * @see Serializable::unserialize()
299 * @param string $serialized
301 public function unserialize( $serialized ) {
302 $data = unserialize( $serialized );
303 if ( !is_array( $data ) ) {
304 throw new InvalidArgumentException( __METHOD__
. ': Invalid serialized data' );
307 $this->interface = $data['interface'];
308 $this->key
= $data['key'];
309 $this->keysToTry
= $data['keysToTry'];
310 $this->parameters
= $data['parameters'];
311 $this->format
= $data['format'];
312 $this->useDatabase
= $data['useDatabase'];
313 $this->language
= $data['language'] ? Language
::factory( $data['language'] ) : false;
314 $this->title
= $data['title'];
320 * @return bool True if this is a multi-key message, that is, if the key provided to the
321 * constructor was a fallback list of keys to try.
323 public function isMultiKey() {
324 return count( $this->keysToTry
) > 1;
330 * @return string[] The list of keys to try when fetching the message text,
331 * in order of preference.
333 public function getKeysToTry() {
334 return $this->keysToTry
;
338 * Returns the message key.
340 * If a list of multiple possible keys was supplied to the constructor, this method may
341 * return any of these keys. After the message has been fetched, this method will return
342 * the key that was actually used to fetch the message.
348 public function getKey() {
353 * Returns the message parameters.
359 public function getParams() {
360 return $this->parameters
;
364 * Returns the message format.
369 * @deprecated since 1.29 formatting is not stateful
371 public function getFormat() {
372 wfDeprecated( __METHOD__
, '1.29' );
373 return $this->format
;
377 * Returns the Language of the Message.
383 public function getLanguage() {
384 // Defaults to false which means current user language
385 return $this->language ?
: RequestContext
::getMain()->getLanguage();
389 * Factory function that is just wrapper for the real constructor. It is
390 * intended to be used instead of the real constructor, because it allows
391 * chaining method calls, while new objects don't.
395 * @param string|string[]|MessageSpecifier $key
396 * @param mixed $param,... Parameters as strings.
400 public static function newFromKey( $key /*...*/ ) {
401 $params = func_get_args();
402 array_shift( $params );
403 return new self( $key, $params );
407 * Transform a MessageSpecifier or a primitive value used interchangeably with
408 * specifiers (a message key string, or a key + params array) into a proper Message.
410 * Also accepts a MessageSpecifier inside an array: that's not considered a valid format
411 * but is an easy error to make due to how StatusValue stores messages internally.
412 * Further array elements are ignored in that case.
414 * @param string|array|MessageSpecifier $value
416 * @throws InvalidArgumentException
419 public static function newFromSpecifier( $value ) {
421 if ( is_array( $value ) ) {
423 $value = array_shift( $params );
426 if ( $value instanceof Message
) { // Message, RawMessage, ApiMessage, etc
427 $message = clone $value;
428 } elseif ( $value instanceof MessageSpecifier
) {
429 $message = new Message( $value );
430 } elseif ( is_string( $value ) ) {
431 $message = new Message( $value, $params );
433 throw new InvalidArgumentException( __METHOD__
. ': invalid argument type '
434 . gettype( $value ) );
441 * Factory function accepting multiple message keys and returning a message instance
442 * for the first message which is non-empty. If all messages are empty then an
443 * instance of the first message key is returned.
447 * @param string|string[] $keys,... Message keys, or first argument as an array of all the
452 public static function newFallbackSequence( /*...*/ ) {
453 $keys = func_get_args();
454 if ( func_num_args() == 1 ) {
455 if ( is_array( $keys[0] ) ) {
456 // Allow an array to be passed as the first argument instead
457 $keys = array_values( $keys[0] );
459 // Optimize a single string to not need special fallback handling
463 return new self( $keys );
467 * Get a title object for a mediawiki message, where it can be found in the mediawiki namespace.
468 * The title will be for the current language, if the message key is in
469 * $wgForceUIMsgAsContentMsg it will be append with the language code (except content
470 * language), because Message::inContentLanguage will also return in user language.
472 * @see $wgForceUIMsgAsContentMsg
476 public function getTitle() {
477 global $wgForceUIMsgAsContentMsg;
479 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
480 $lang = $this->getLanguage();
483 !$lang->equals( $contLang )
484 && in_array( $this->key
, (array)$wgForceUIMsgAsContentMsg )
486 $title .= '/' . $lang->getCode();
489 return Title
::makeTitle(
490 NS_MEDIAWIKI
, $contLang->ucfirst( strtr( $title, ' ', '_' ) ) );
494 * Adds parameters to the parameter list of this message.
498 * @param mixed $args,... Parameters as strings or arrays from
499 * Message::numParam() and the like, or a single array of parameters.
501 * @return Message $this
503 public function params( /*...*/ ) {
504 $args = func_get_args();
506 // If $args has only one entry and it's an array, then it's either a
507 // non-varargs call or it happens to be a call with just a single
508 // "special" parameter. Since the "special" parameters don't have any
509 // numeric keys, we'll test that to differentiate the cases.
510 if ( count( $args ) === 1 && isset( $args[0] ) && is_array( $args[0] ) ) {
511 if ( $args[0] === [] ) {
514 foreach ( $args[0] as $key => $value ) {
515 if ( is_int( $key ) ) {
523 $this->parameters
= array_merge( $this->parameters
, array_values( $args ) );
528 * Add parameters that are substituted after parsing or escaping.
529 * In other words the parsing process cannot access the contents
530 * of this type of parameter, and you need to make sure it is
531 * sanitized beforehand. The parser will see "$n", instead.
535 * @param mixed $params,... Raw parameters as strings, or a single argument that is
536 * an array of raw parameters.
538 * @return Message $this
540 public function rawParams( /*...*/ ) {
541 $params = func_get_args();
542 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
543 $params = $params[0];
545 foreach ( $params as $param ) {
546 $this->parameters
[] = self
::rawParam( $param );
552 * Add parameters that are numeric and will be passed through
553 * Language::formatNum before substitution
557 * @param mixed $param,... Numeric parameters, or a single argument that is
558 * an array of numeric parameters.
560 * @return Message $this
562 public function numParams( /*...*/ ) {
563 $params = func_get_args();
564 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
565 $params = $params[0];
567 foreach ( $params as $param ) {
568 $this->parameters
[] = self
::numParam( $param );
574 * Add parameters that are durations of time and will be passed through
575 * Language::formatDuration before substitution
579 * @param int|int[] $param,... Duration parameters, or a single argument that is
580 * an array of duration parameters.
582 * @return Message $this
584 public function durationParams( /*...*/ ) {
585 $params = func_get_args();
586 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
587 $params = $params[0];
589 foreach ( $params as $param ) {
590 $this->parameters
[] = self
::durationParam( $param );
596 * Add parameters that are expiration times and will be passed through
597 * Language::formatExpiry before substitution
601 * @param string|string[] $param,... Expiry parameters, or a single argument that is
602 * an array of expiry parameters.
604 * @return Message $this
606 public function expiryParams( /*...*/ ) {
607 $params = func_get_args();
608 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
609 $params = $params[0];
611 foreach ( $params as $param ) {
612 $this->parameters
[] = self
::expiryParam( $param );
618 * Add parameters that are time periods and will be passed through
619 * Language::formatTimePeriod before substitution
623 * @param int|int[] $param,... Time period parameters, or a single argument that is
624 * an array of time period parameters.
626 * @return Message $this
628 public function timeperiodParams( /*...*/ ) {
629 $params = func_get_args();
630 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
631 $params = $params[0];
633 foreach ( $params as $param ) {
634 $this->parameters
[] = self
::timeperiodParam( $param );
640 * Add parameters that are file sizes and will be passed through
641 * Language::formatSize before substitution
645 * @param int|int[] $param,... Size parameters, or a single argument that is
646 * an array of size parameters.
648 * @return Message $this
650 public function sizeParams( /*...*/ ) {
651 $params = func_get_args();
652 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
653 $params = $params[0];
655 foreach ( $params as $param ) {
656 $this->parameters
[] = self
::sizeParam( $param );
662 * Add parameters that are bitrates and will be passed through
663 * Language::formatBitrate before substitution
667 * @param int|int[] $param,... Bit rate parameters, or a single argument that is
668 * an array of bit rate parameters.
670 * @return Message $this
672 public function bitrateParams( /*...*/ ) {
673 $params = func_get_args();
674 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
675 $params = $params[0];
677 foreach ( $params as $param ) {
678 $this->parameters
[] = self
::bitrateParam( $param );
684 * Add parameters that are plaintext and will be passed through without
685 * the content being evaluated. Plaintext parameters are not valid as
686 * arguments to parser functions. This differs from self::rawParams in
687 * that the Message class handles escaping to match the output format.
691 * @param string|string[] $param,... plaintext parameters, or a single argument that is
692 * an array of plaintext parameters.
694 * @return Message $this
696 public function plaintextParams( /*...*/ ) {
697 $params = func_get_args();
698 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
699 $params = $params[0];
701 foreach ( $params as $param ) {
702 $this->parameters
[] = self
::plaintextParam( $param );
708 * Set the language and the title from a context object
712 * @param IContextSource $context
714 * @return Message $this
716 public function setContext( IContextSource
$context ) {
717 $this->inLanguage( $context->getLanguage() );
718 $this->title( $context->getTitle() );
719 $this->interface = true;
725 * Request the message in any language that is supported.
727 * As a side effect interface message status is unconditionally
731 * @param Language|string $lang Language code or Language object.
732 * @return Message $this
733 * @throws MWException
735 public function inLanguage( $lang ) {
736 $previousLanguage = $this->language
;
738 if ( $lang instanceof Language
) {
739 $this->language
= $lang;
740 } elseif ( is_string( $lang ) ) {
741 if ( !$this->language
instanceof Language ||
$this->language
->getCode() != $lang ) {
742 $this->language
= Language
::factory( $lang );
744 } elseif ( $lang instanceof StubUserLang
) {
745 $this->language
= false;
747 $type = gettype( $lang );
748 throw new MWException( __METHOD__
. " must be "
749 . "passed a String or Language object; $type given"
753 if ( $this->language
!== $previousLanguage ) {
754 // The language has changed. Clear the message cache.
755 $this->message
= null;
757 $this->interface = false;
762 * Request the message in the wiki's content language,
763 * unless it is disabled for this message.
766 * @see $wgForceUIMsgAsContentMsg
768 * @return Message $this
770 public function inContentLanguage() {
771 global $wgForceUIMsgAsContentMsg;
772 if ( in_array( $this->key
, (array)$wgForceUIMsgAsContentMsg ) ) {
776 $this->inLanguage( MediaWikiServices
::getInstance()->getContentLanguage() );
781 * Allows manipulating the interface message flag directly.
782 * Can be used to restore the flag after setting a language.
786 * @param bool $interface
788 * @return Message $this
790 public function setInterfaceMessageFlag( $interface ) {
791 $this->interface = (bool)$interface;
796 * Enable or disable database use.
800 * @param bool $useDatabase
802 * @return Message $this
804 public function useDatabase( $useDatabase ) {
805 $this->useDatabase
= (bool)$useDatabase;
806 $this->message
= null;
811 * Set the Title object to use as context when transforming the message
815 * @param Title $title
817 * @return Message $this
819 public function title( $title ) {
820 $this->title
= $title;
825 * Returns the message as a Content object.
829 public function content() {
830 if ( !$this->content
) {
831 $this->content
= new MessageContent( $this );
834 return $this->content
;
838 * Returns the message parsed from wikitext to HTML.
842 * @param string|null $format One of the FORMAT_* constants. Null means use whatever was used
843 * the last time (this is for B/C and should be avoided).
845 * @return string HTML
846 * @suppress SecurityCheck-DoubleEscaped phan false positive
848 public function toString( $format = null ) {
849 if ( $format === null ) {
850 $ex = new LogicException( __METHOD__
. ' using implicit format: ' . $this->format
);
851 \MediaWiki\Logger\LoggerFactory
::getInstance( 'message-format' )->warning(
852 $ex->getMessage(), [ 'exception' => $ex, 'format' => $this->format
, 'key' => $this->key
] );
853 $format = $this->format
;
855 $string = $this->fetchMessage();
857 if ( $string === false ) {
858 // Err on the side of safety, ensure that the output
859 // is always html safe in the event the message key is
860 // missing, since in that case its highly likely the
861 // message key is user-controlled.
862 // '⧼' is used instead of '<' to side-step any
863 // double-escaping issues.
864 // (Keep synchronised with mw.Message#toString in JS.)
865 return '⧼' . htmlspecialchars( $this->key
) . '⧽';
868 # Replace $* with a list of parameters for &uselang=qqx.
869 if ( strpos( $string, '$*' ) !== false ) {
871 if ( $this->parameters
!== [] ) {
872 $paramlist = ': $' . implode( ', $', range( 1, count( $this->parameters
) ) );
874 $string = str_replace( '$*', $paramlist, $string );
877 # Replace parameters before text parsing
878 $string = $this->replaceParameters( $string, 'before', $format );
880 # Maybe transform using the full parser
881 if ( $format === self
::FORMAT_PARSE
) {
882 $string = $this->parseText( $string );
883 $string = Parser
::stripOuterParagraph( $string );
884 } elseif ( $format === self
::FORMAT_BLOCK_PARSE
) {
885 $string = $this->parseText( $string );
886 } elseif ( $format === self
::FORMAT_TEXT
) {
887 $string = $this->transformText( $string );
888 } elseif ( $format === self
::FORMAT_ESCAPED
) {
889 $string = $this->transformText( $string );
890 $string = htmlspecialchars( $string, ENT_QUOTES
, 'UTF-8', false );
893 # Raw parameter replacement
894 $string = $this->replaceParameters( $string, 'after', $format );
900 * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg:
901 * $foo = new Message( $key );
902 * $string = "<abbr>$foo</abbr>";
908 public function __toString() {
909 // PHP doesn't allow __toString to throw exceptions and will
910 // trigger a fatal error if it does. So, catch any exceptions.
913 return $this->toString( self
::FORMAT_PARSE
);
914 } catch ( Exception
$ex ) {
916 trigger_error( "Exception caught in " . __METHOD__
. " (message " . $this->key
. "): "
917 . $ex, E_USER_WARNING
);
918 } catch ( Exception
$ex ) {
919 // Doh! Cause a fatal error after all?
922 return '⧼' . htmlspecialchars( $this->key
) . '⧽';
927 * Fully parse the text from wikitext to HTML.
931 * @return string Parsed HTML.
933 public function parse() {
934 $this->format
= self
::FORMAT_PARSE
;
935 return $this->toString( self
::FORMAT_PARSE
);
939 * Returns the message text. {{-transformation is done.
943 * @return string Unescaped message text.
945 public function text() {
946 $this->format
= self
::FORMAT_TEXT
;
947 return $this->toString( self
::FORMAT_TEXT
);
951 * Returns the message text as-is, only parameters are substituted.
955 * @return string Unescaped untransformed message text.
957 public function plain() {
958 $this->format
= self
::FORMAT_PLAIN
;
959 return $this->toString( self
::FORMAT_PLAIN
);
963 * Returns the parsed message text which is always surrounded by a block element.
967 * @return string HTML
969 public function parseAsBlock() {
970 $this->format
= self
::FORMAT_BLOCK_PARSE
;
971 return $this->toString( self
::FORMAT_BLOCK_PARSE
);
975 * Returns the message text. {{-transformation is done and the result
976 * is escaped excluding any raw parameters.
980 * @return string Escaped message text.
982 public function escaped() {
983 $this->format
= self
::FORMAT_ESCAPED
;
984 return $this->toString( self
::FORMAT_ESCAPED
);
988 * Check whether a message key has been defined currently.
994 public function exists() {
995 return $this->fetchMessage() !== false;
999 * Check whether a message does not exist, or is an empty string
1002 * @todo FIXME: Merge with isDisabled()?
1006 public function isBlank() {
1007 $message = $this->fetchMessage();
1008 return $message === false ||
$message === '';
1012 * Check whether a message does not exist, is an empty string, or is "-".
1018 public function isDisabled() {
1019 $message = $this->fetchMessage();
1020 return $message === false ||
$message === '' ||
$message === '-';
1028 * @return array Array with a single "raw" key.
1030 public static function rawParam( $raw ) {
1031 return [ 'raw' => $raw ];
1039 * @return array Array with a single "num" key.
1041 public static function numParam( $num ) {
1042 return [ 'num' => $num ];
1048 * @param int $duration
1050 * @return int[] Array with a single "duration" key.
1052 public static function durationParam( $duration ) {
1053 return [ 'duration' => $duration ];
1059 * @param string $expiry
1061 * @return string[] Array with a single "expiry" key.
1063 public static function expiryParam( $expiry ) {
1064 return [ 'expiry' => $expiry ];
1070 * @param int $period
1072 * @return int[] Array with a single "period" key.
1074 public static function timeperiodParam( $period ) {
1075 return [ 'period' => $period ];
1083 * @return int[] Array with a single "size" key.
1085 public static function sizeParam( $size ) {
1086 return [ 'size' => $size ];
1092 * @param int $bitrate
1094 * @return int[] Array with a single "bitrate" key.
1096 public static function bitrateParam( $bitrate ) {
1097 return [ 'bitrate' => $bitrate ];
1103 * @param string $plaintext
1105 * @return string[] Array with a single "plaintext" key.
1107 public static function plaintextParam( $plaintext ) {
1108 return [ 'plaintext' => $plaintext ];
1114 * @param array $list
1115 * @param string $type 'comma', 'semicolon', 'pipe', 'text'
1116 * @return array Array with "list" and "type" keys.
1118 public static function listParam( array $list, $type = 'text' ) {
1119 if ( !isset( self
::$listTypeMap[$type] ) ) {
1120 throw new InvalidArgumentException(
1121 "Invalid type '$type'. Known types are: " . implode( ', ', array_keys( self
::$listTypeMap ) )
1124 return [ 'list' => $list, 'type' => $type ];
1128 * Substitutes any parameters into the message text.
1132 * @param string $message The message text.
1133 * @param string $type Either "before" or "after".
1134 * @param string $format One of the FORMAT_* constants.
1138 protected function replaceParameters( $message, $type, $format ) {
1139 // A temporary marker for $1 parameters that is only valid
1140 // in non-attribute contexts. However if the entire message is escaped
1141 // then we don't want to use it because it will be mangled in all contexts
1142 // and its unnessary as ->escaped() messages aren't html.
1143 $marker = $format === self
::FORMAT_ESCAPED ?
'$' : '$\'"';
1144 $replacementKeys = [];
1145 foreach ( $this->parameters
as $n => $param ) {
1146 list( $paramType, $value ) = $this->extractParam( $param, $format );
1147 if ( $type === 'before' ) {
1148 if ( $paramType === 'before' ) {
1149 $replacementKeys['$' . ( $n +
1 )] = $value;
1150 } else /* $paramType === 'after' */ {
1151 // To protect against XSS from replacing parameters
1152 // inside html attributes, we convert $1 to $'"1.
1153 // In the event that one of the parameters ends up
1154 // in an attribute, either the ' or the " will be
1155 // escaped, breaking the replacement and avoiding XSS.
1156 $replacementKeys['$' . ( $n +
1 )] = $marker . ( $n +
1 );
1159 if ( $paramType === 'after' ) {
1160 $replacementKeys[$marker . ( $n +
1 )] = $value;
1164 $message = strtr( $message, $replacementKeys );
1169 * Extracts the parameter type and preprocessed the value if needed.
1173 * @param mixed $param Parameter as defined in this class.
1174 * @param string $format One of the FORMAT_* constants.
1176 * @return array Array with the parameter type (either "before" or "after") and the value.
1178 protected function extractParam( $param, $format ) {
1179 if ( is_array( $param ) ) {
1180 if ( isset( $param['raw'] ) ) {
1181 return [ 'after', $param['raw'] ];
1182 } elseif ( isset( $param['num'] ) ) {
1183 // Replace number params always in before step for now.
1184 // No support for combined raw and num params
1185 return [ 'before', $this->getLanguage()->formatNum( $param['num'] ) ];
1186 } elseif ( isset( $param['duration'] ) ) {
1187 return [ 'before', $this->getLanguage()->formatDuration( $param['duration'] ) ];
1188 } elseif ( isset( $param['expiry'] ) ) {
1189 return [ 'before', $this->getLanguage()->formatExpiry( $param['expiry'] ) ];
1190 } elseif ( isset( $param['period'] ) ) {
1191 return [ 'before', $this->getLanguage()->formatTimePeriod( $param['period'] ) ];
1192 } elseif ( isset( $param['size'] ) ) {
1193 return [ 'before', $this->getLanguage()->formatSize( $param['size'] ) ];
1194 } elseif ( isset( $param['bitrate'] ) ) {
1195 return [ 'before', $this->getLanguage()->formatBitrate( $param['bitrate'] ) ];
1196 } elseif ( isset( $param['plaintext'] ) ) {
1197 return [ 'after', $this->formatPlaintext( $param['plaintext'], $format ) ];
1198 } elseif ( isset( $param['list'] ) ) {
1199 return $this->formatListParam( $param['list'], $param['type'], $format );
1201 if ( !is_scalar( $param ) ) {
1202 $param = serialize( $param );
1204 \MediaWiki\Logger\LoggerFactory
::getInstance( 'Bug58676' )->warning(
1205 'Invalid parameter for message "{msgkey}": {param}',
1207 'exception' => new Exception
,
1208 'msgkey' => $this->getKey(),
1209 'param' => htmlspecialchars( $param ),
1213 return [ 'before', '[INVALID]' ];
1215 } elseif ( $param instanceof Message
) {
1216 // Match language, flags, etc. to the current message.
1217 $msg = clone $param;
1218 if ( $msg->language
!== $this->language ||
$msg->useDatabase
!== $this->useDatabase
) {
1219 // Cache depends on these parameters
1220 $msg->message
= null;
1222 $msg->interface = $this->interface;
1223 $msg->language
= $this->language
;
1224 $msg->useDatabase
= $this->useDatabase
;
1225 $msg->title
= $this->title
;
1228 if ( $format === 'block-parse' ) {
1231 $msg->format
= $format;
1233 // Message objects should not be before parameters because
1234 // then they'll get double escaped. If the message needs to be
1235 // escaped, it'll happen right here when we call toString().
1236 return [ 'after', $msg->toString( $format ) ];
1238 return [ 'before', $param ];
1243 * Wrapper for what ever method we use to parse wikitext.
1247 * @param string $string Wikitext message contents.
1249 * @return string Wikitext parsed into HTML.
1251 protected function parseText( $string ) {
1252 $out = MessageCache
::singleton()->parse(
1257 $this->getLanguage()
1260 return $out instanceof ParserOutput
1262 'enableSectionEditLinks' => false,
1263 // Wrapping messages in an extra <div> is probably not expected. If
1264 // they're outside the content area they probably shouldn't be
1265 // targeted by CSS that's targeting the parser output, and if
1266 // they're inside they already are from the outer div.
1273 * Wrapper for what ever method we use to {{-transform wikitext.
1277 * @param string $string Wikitext message contents.
1279 * @return string Wikitext with {{-constructs replaced with their values.
1281 protected function transformText( $string ) {
1282 return MessageCache
::singleton()->transform(
1285 $this->getLanguage(),
1291 * Wrapper for what ever method we use to get message contents.
1296 * @throws MWException If message key array is empty.
1298 protected function fetchMessage() {
1299 if ( $this->message
=== null ) {
1300 $cache = MessageCache
::singleton();
1302 foreach ( $this->keysToTry
as $key ) {
1303 $message = $cache->get( $key, $this->useDatabase
, $this->getLanguage() );
1304 if ( $message !== false && $message !== '' ) {
1309 // NOTE: The constructor makes sure keysToTry isn't empty,
1310 // so we know that $key and $message are initialized.
1312 $this->message
= $message;
1314 return $this->message
;
1318 * Formats a message parameter wrapped with 'plaintext'. Ensures that
1319 * the entire string is displayed unchanged when displayed in the output
1324 * @param string $plaintext String to ensure plaintext output of
1325 * @param string $format One of the FORMAT_* constants.
1327 * @return string Input plaintext encoded for output to $format
1329 protected function formatPlaintext( $plaintext, $format ) {
1330 switch ( $format ) {
1331 case self
::FORMAT_TEXT
:
1332 case self
::FORMAT_PLAIN
:
1335 case self
::FORMAT_PARSE
:
1336 case self
::FORMAT_BLOCK_PARSE
:
1337 case self
::FORMAT_ESCAPED
:
1339 return htmlspecialchars( $plaintext, ENT_QUOTES
);
1344 * Formats a list of parameters as a concatenated string.
1346 * @param array $params
1347 * @param string $listType
1348 * @param string $format One of the FORMAT_* constants.
1349 * @return array Array with the parameter type (either "before" or "after") and the value.
1351 protected function formatListParam( array $params, $listType, $format ) {
1352 if ( !isset( self
::$listTypeMap[$listType] ) ) {
1353 $warning = 'Invalid list type for message "' . $this->getKey() . '": '
1354 . htmlspecialchars( $listType )
1355 . ' (params are ' . htmlspecialchars( serialize( $params ) ) . ')';
1356 trigger_error( $warning, E_USER_WARNING
);
1358 wfDebugLog( 'Bug58676', $warning . "\n" . $e->getTraceAsString() );
1359 return [ 'before', '[INVALID]' ];
1361 $func = self
::$listTypeMap[$listType];
1363 // Handle an empty list sensibly
1365 return [ 'before', $this->getLanguage()->$func( [] ) ];
1368 // First, determine what kinds of list items we have
1372 foreach ( $params as $n => $p ) {
1373 list( $type, $value ) = $this->extractParam( $p, $format );
1374 $types[$type] = true;
1376 $vars[] = '$' . ( $n +
1 );
1379 // Easy case: all are 'before' or 'after', so just join the
1380 // values and use the same type.
1381 if ( count( $types ) === 1 ) {
1382 return [ key( $types ), $this->getLanguage()->$func( $list ) ];
1385 // Hard case: We need to process each value per its type, then
1386 // return the concatenated values as 'after'. We handle this by turning
1387 // the list into a RawMessage and processing that as a parameter.
1388 $vars = $this->getLanguage()->$func( $vars );
1389 return $this->extractParam( new RawMessage( $vars, $params ), $format );