includes/Message.php

   1 <?php
   2 /**
   3  * Fetching and processing of interface messages.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @author Niklas Laxström
  22  */
  23
  24 /**
  25  * The Message class provides methods which fulfil two basic services:
  26  *  - fetching interface messages
  27  *  - processing messages into a variety of formats
  28  *
  29  * First implemented with MediaWiki 1.17, the Message class is intended to
  30  * replace the old wfMsg* functions that over time grew unusable.
  31  * @see https://www.mediawiki.org/wiki/Manual:Messages_API for equivalences
  32  * between old and new functions.
  33  *
  34  * You should use the wfMessage() global function which acts as a wrapper for
  35  * the Message class. The wrapper let you pass parameters as arguments.
  36  *
  37  * The most basic usage cases would be:
  38  *
  39  * @code
  40  *     // Initialize a Message object using the 'some_key' message key
  41  *     $message = wfMessage( 'some_key' );
  42  *
  43  *     // Using two parameters those values are strings 'value1' and 'value2':
  44  *     $message = wfMessage( 'some_key',
  45  *          'value1', 'value2'
  46  *     );
  47  * @endcode
  48  *
  49  * @section message_global_fn Global function wrapper:
  50  *
  51  * Since wfMessage() returns a Message instance, you can chain its call with
  52  * a method. Some of them return a Message instance too so you can chain them.
  53  * You will find below several examples of wfMessage() usage.
  54  *
  55  * Fetching a message text for interface message:
  56  *
  57  * @code
  58  *    $button = Xml::button(
  59  *         wfMessage( 'submit' )->text()
  60  *    );
  61  * @endcode
  62  *
  63  * A Message instance can be passed parameters after it has been constructed,
  64  * use the params() method to do so:
  65  *
  66  * @code
  67  *     wfMessage( 'welcome-to' )
  68  *         ->params( $wgSitename )
  69  *         ->text();
  70  * @endcode
  71  *
  72  * {{GRAMMAR}} and friends work correctly:
  73  *
  74  * @code
  75  *    wfMessage( 'are-friends',
  76  *        $user, $friend
  77  *    );
  78  *    wfMessage( 'bad-message' )
  79  *         ->rawParams( '<script>...</script>' )
  80  *         ->escaped();
  81  * @endcode
  82  *
  83  * @section message_language Changing language:
  84  *
  85  * Messages can be requested in a different language or in whatever current
  86  * content language is being used. The methods are:
  87  *     - Message->inContentLanguage()
  88  *     - Message->inLanguage()
  89  *
  90  * Sometimes the message text ends up in the database, so content language is
  91  * needed:
  92  *
  93  * @code
  94  *    wfMessage( 'file-log',
  95  *        $user, $filename
  96  *    )->inContentLanguage()->text();
  97  * @endcode
  98  *
  99  * Checking whether a message exists:
 100  *
 101  * @code
 102  *    wfMessage( 'mysterious-message' )->exists()
 103  *    // returns a boolean whether the 'mysterious-message' key exist.
 104  * @endcode
 105  *
 106  * If you want to use a different language:
 107  *
 108  * @code
 109  *    $userLanguage = $user->getOption( 'language' );
 110  *    wfMessage( 'email-header' )
 111  *         ->inLanguage( $userLanguage )
 112  *         ->plain();
 113  * @endcode
 114  *
 115  * @note You can parse the text only in the content or interface languages
 116  *
 117  * @section message_compare_old Comparison with old wfMsg* functions:
 118  *
 119  * Use full parsing:
 120  *
 121  * @code
 122  *     // old style:
 123  *     wfMsgExt( 'key', [ 'parseinline' ], 'apple' );
 124  *     // new style:
 125  *     wfMessage( 'key', 'apple' )->parse();
 126  * @endcode
 127  *
 128  * Parseinline is used because it is more useful when pre-building HTML.
 129  * In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
 130  *
 131  * Places where HTML cannot be used. {{-transformation is done.
 132  * @code
 133  *     // old style:
 134  *     wfMsgExt( 'key', [ 'parsemag' ], 'apple', 'pear' );
 135  *     // new style:
 136  *     wfMessage( 'key', 'apple', 'pear' )->text();
 137  * @endcode
 138  *
 139  * Shortcut for escaping the message too, similar to wfMsgHTML(), but
 140  * parameters are not replaced after escaping by default.
 141  * @code
 142  *     $escaped = wfMessage( 'key' )
 143  *          ->rawParams( 'apple' )
 144  *          ->escaped();
 145  * @endcode
 146  *
 147  * @section message_appendix Appendix:
 148  *
 149  * @todo
 150  * - test, can we have tests?
 151  * - this documentation needs to be extended
 152  *
 153  * @see https://www.mediawiki.org/wiki/WfMessage()
 154  * @see https://www.mediawiki.org/wiki/New_messages_API
 155  * @see https://www.mediawiki.org/wiki/Localisation
 156  *
 157  * @since 1.17
 158  */
 159 class Message implements MessageSpecifier, Serializable {
 160         /** Use message text as-is */
 161         const FORMAT_PLAIN = 'plain';
 162         /** Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag) */
 163         const FORMAT_BLOCK_PARSE = 'block-parse';
 164         /** Use normal wikitext -> HTML parsing but strip the block-level wrapper */
 165         const FORMAT_PARSE = 'parse';
 166         /** Transform {{..}} constructs but don't transform to HTML */
 167         const FORMAT_TEXT = 'text';
 168         /** Transform {{..}} constructs, HTML-escape the result */
 169         const FORMAT_ESCAPED = 'escaped';
 170
 171         /**
 172          * Mapping from Message::listParam() types to Language methods.
 173          * @var array
 174          */
 175         protected static $listTypeMap = [
 176                 'comma' => 'commaList',
 177                 'semicolon' => 'semicolonList',
 178                 'pipe' => 'pipeList',
 179                 'text' => 'listToText',
 180         ];
 181
 182         /**
 183          * In which language to get this message. True, which is the default,
 184          * means the current user language, false content language.
 185          *
 186          * @var bool
 187          */
 188         protected $interface = true;
 189
 190         /**
 191          * In which language to get this message. Overrides the $interface setting.
 192          *
 193          * @var Language|bool Explicit language object, or false for user language
 194          */
 195         protected $language = false;
 196
 197         /**
 198          * @var string The message key. If $keysToTry has more than one element,
 199          * this may change to one of the keys to try when fetching the message text.
 200          */
 201         protected $key;
 202
 203         /**
 204          * @var string[] List of keys to try when fetching the message.
 205          */
 206         protected $keysToTry;
 207
 208         /**
 209          * @var array List of parameters which will be substituted into the message.
 210          */
 211         protected $parameters = [];
 212
 213         /**
 214          * @var string
 215          * @deprecated
 216          */
 217         protected $format = 'parse';
 218
 219         /**
 220          * @var bool Whether database can be used.
 221          */
 222         protected $useDatabase = true;
 223
 224         /**
 225          * @var Title Title object to use as context.
 226          */
 227         protected $title = null;
 228
 229         /**
 230          * @var Content Content object representing the message.
 231          */
 232         protected $content = null;
 233
 234         /**
 235          * @var string
 236          */
 237         protected $message;
 238
 239         /**
 240          * @since 1.17
 241          * @param string|string[]|MessageSpecifier $key Message key, or array of
 242          * message keys to try and use the first non-empty message for, or a
 243          * MessageSpecifier to copy from.
 244          * @param array $params Message parameters.
 245          * @param Language|null $language [optional] Language to use (defaults to current user language).
 246          * @throws InvalidArgumentException
 247          */
 248         public function __construct( $key, $params = [], Language $language = null ) {
 249                 if ( $key instanceof MessageSpecifier ) {
 250                         if ( $params ) {
 251                                 throw new InvalidArgumentException(
 252                                         '$params must be empty if $key is a MessageSpecifier'
 253                                 );
 254                         }
 255                         $params = $key->getParams();
 256                         $key = $key->getKey();
 257                 }
 258
 259                 if ( !is_string( $key ) && !is_array( $key ) ) {
 260                         throw new InvalidArgumentException( '$key must be a string or an array' );
 261                 }
 262
 263                 $this->keysToTry = (array)$key;
 264
 265                 if ( empty( $this->keysToTry ) ) {
 266                         throw new InvalidArgumentException( '$key must not be an empty list' );
 267                 }
 268
 269                 $this->key = reset( $this->keysToTry );
 270
 271                 $this->parameters = array_values( $params );
 272                 // User language is only resolved in getLanguage(). This helps preserve the
 273                 // semantic intent of "user language" across serialize() and unserialize().
 274                 $this->language = $language ?: false;
 275         }
 276
 277         /**
 278          * @see Serializable::serialize()
 279          * @since 1.26
 280          * @return string
 281          */
 282         public function serialize() {
 283                 return serialize( [
 284                         'interface' => $this->interface,
 285                         'language' => $this->language ? $this->language->getCode() : false,
 286                         'key' => $this->key,
 287                         'keysToTry' => $this->keysToTry,
 288                         'parameters' => $this->parameters,
 289                         'format' => $this->format,
 290                         'useDatabase' => $this->useDatabase,
 291                         'title' => $this->title,
 292                 ] );
 293         }
 294
 295         /**
 296          * @see Serializable::unserialize()
 297          * @since 1.26
 298          * @param string $serialized
 299          */
 300         public function unserialize( $serialized ) {
 301                 $data = unserialize( $serialized );
 302                 $this->interface = $data['interface'];
 303                 $this->key = $data['key'];
 304                 $this->keysToTry = $data['keysToTry'];
 305                 $this->parameters = $data['parameters'];
 306                 $this->format = $data['format'];
 307                 $this->useDatabase = $data['useDatabase'];
 308                 $this->language = $data['language'] ? Language::factory( $data['language'] ) : false;
 309                 $this->title = $data['title'];
 310         }
 311
 312         /**
 313          * @since 1.24
 314          *
 315          * @return bool True if this is a multi-key message, that is, if the key provided to the
 316          * constructor was a fallback list of keys to try.
 317          */
 318         public function isMultiKey() {
 319                 return count( $this->keysToTry ) > 1;
 320         }
 321
 322         /**
 323          * @since 1.24
 324          *
 325          * @return string[] The list of keys to try when fetching the message text,
 326          * in order of preference.
 327          */
 328         public function getKeysToTry() {
 329                 return $this->keysToTry;
 330         }
 331
 332         /**
 333          * Returns the message key.
 334          *
 335          * If a list of multiple possible keys was supplied to the constructor, this method may
 336          * return any of these keys. After the message has been fetched, this method will return
 337          * the key that was actually used to fetch the message.
 338          *
 339          * @since 1.21
 340          *
 341          * @return string
 342          */
 343         public function getKey() {
 344                 return $this->key;
 345         }
 346
 347         /**
 348          * Returns the message parameters.
 349          *
 350          * @since 1.21
 351          *
 352          * @return array
 353          */
 354         public function getParams() {
 355                 return $this->parameters;
 356         }
 357
 358         /**
 359          * Returns the message format.
 360          *
 361          * @since 1.21
 362          *
 363          * @return string
 364          * @deprecated since 1.29 formatting is not stateful
 365          */
 366         public function getFormat() {
 367                 wfDeprecated( __METHOD__, '1.29' );
 368                 return $this->format;
 369         }
 370
 371         /**
 372          * Returns the Language of the Message.
 373          *
 374          * @since 1.23
 375          *
 376          * @return Language
 377          */
 378         public function getLanguage() {
 379                 // Defaults to false which means current user language
 380                 return $this->language ?: RequestContext::getMain()->getLanguage();
 381         }
 382
 383         /**
 384          * Factory function that is just wrapper for the real constructor. It is
 385          * intended to be used instead of the real constructor, because it allows
 386          * chaining method calls, while new objects don't.
 387          *
 388          * @since 1.17
 389          *
 390          * @param string|string[]|MessageSpecifier $key
 391          * @param mixed $param,... Parameters as strings.
 392          *
 393          * @return Message
 394          */
 395         public static function newFromKey( $key /*...*/ ) {
 396                 $params = func_get_args();
 397                 array_shift( $params );
 398                 return new self( $key, $params );
 399         }
 400
 401         /**
 402          * Transform a MessageSpecifier or a primitive value used interchangeably with
 403          * specifiers (a message key string, or a key + params array) into a proper Message.
 404          *
 405          * Also accepts a MessageSpecifier inside an array: that's not considered a valid format
 406          * but is an easy error to make due to how StatusValue stores messages internally.
 407          * Further array elements are ignored in that case.
 408          *
 409          * @param string|array|MessageSpecifier $value
 410          * @return Message
 411          * @throws InvalidArgumentException
 412          * @since 1.27
 413          */
 414         public static function newFromSpecifier( $value ) {
 415                 $params = [];
 416                 if ( is_array( $value ) ) {
 417                         $params = $value;
 418                         $value = array_shift( $params );
 419                 }
 420
 421                 if ( $value instanceof Message ) { // Message, RawMessage, ApiMessage, etc
 422                         $message = clone $value;
 423                 } elseif ( $value instanceof MessageSpecifier ) {
 424                         $message = new Message( $value );
 425                 } elseif ( is_string( $value ) ) {
 426                         $message = new Message( $value, $params );
 427                 } else {
 428                         throw new InvalidArgumentException( __METHOD__ . ': invalid argument type '
 429                                 . gettype( $value ) );
 430                 }
 431
 432                 return $message;
 433         }
 434
 435         /**
 436          * Factory function accepting multiple message keys and returning a message instance
 437          * for the first message which is non-empty. If all messages are empty then an
 438          * instance of the first message key is returned.
 439          *
 440          * @since 1.18
 441          *
 442          * @param string|string[] $keys,... Message keys, or first argument as an array of all the
 443          * message keys.
 444          *
 445          * @return Message
 446          */
 447         public static function newFallbackSequence( /*...*/ ) {
 448                 $keys = func_get_args();
 449                 if ( func_num_args() == 1 ) {
 450                         if ( is_array( $keys[0] ) ) {
 451                                 // Allow an array to be passed as the first argument instead
 452                                 $keys = array_values( $keys[0] );
 453                         } else {
 454                                 // Optimize a single string to not need special fallback handling
 455                                 $keys = $keys[0];
 456                         }
 457                 }
 458                 return new self( $keys );
 459         }
 460
 461         /**
 462          * Get a title object for a mediawiki message, where it can be found in the mediawiki namespace.
 463          * The title will be for the current language, if the message key is in
 464          * $wgForceUIMsgAsContentMsg it will be append with the language code (except content
 465          * language), because Message::inContentLanguage will also return in user language.
 466          *
 467          * @see $wgForceUIMsgAsContentMsg
 468          * @return Title
 469          * @since 1.26
 470          */
 471         public function getTitle() {
 472                 global $wgContLang, $wgForceUIMsgAsContentMsg;
 473
 474                 $title = $this->key;
 475                 if (
 476                         !$this->language->equals( $wgContLang )
 477                         && in_array( $this->key, (array)$wgForceUIMsgAsContentMsg )
 478                 ) {
 479                         $code = $this->language->getCode();
 480                         $title .= '/' . $code;
 481                 }
 482
 483                 return Title::makeTitle( NS_MEDIAWIKI, $wgContLang->ucfirst( strtr( $title, ' ', '_' ) ) );
 484         }
 485
 486         /**
 487          * Adds parameters to the parameter list of this message.
 488          *
 489          * @since 1.17
 490          *
 491          * @param mixed $args,... Parameters as strings or arrays from
 492          *  Message::numParam() and the like, or a single array of parameters.
 493          *
 494          * @return Message $this
 495          */
 496         public function params( /*...*/ ) {
 497                 $args = func_get_args();
 498
 499                 // If $args has only one entry and it's an array, then it's either a
 500                 // non-varargs call or it happens to be a call with just a single
 501                 // "special" parameter. Since the "special" parameters don't have any
 502                 // numeric keys, we'll test that to differentiate the cases.
 503                 if ( count( $args ) === 1 && isset( $args[0] ) && is_array( $args[0] ) ) {
 504                         if ( $args[0] === [] ) {
 505                                 $args = [];
 506                         } else {
 507                                 foreach ( $args[0] as $key => $value ) {
 508                                         if ( is_int( $key ) ) {
 509                                                 $args = $args[0];
 510                                                 break;
 511                                         }
 512                                 }
 513                         }
 514                 }
 515
 516                 $this->parameters = array_merge( $this->parameters, array_values( $args ) );
 517                 return $this;
 518         }
 519
 520         /**
 521          * Add parameters that are substituted after parsing or escaping.
 522          * In other words the parsing process cannot access the contents
 523          * of this type of parameter, and you need to make sure it is
 524          * sanitized beforehand.  The parser will see "$n", instead.
 525          *
 526          * @since 1.17
 527          *
 528          * @param mixed $params,... Raw parameters as strings, or a single argument that is
 529          * an array of raw parameters.
 530          *
 531          * @return Message $this
 532          */
 533         public function rawParams( /*...*/ ) {
 534                 $params = func_get_args();
 535                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 536                         $params = $params[0];
 537                 }
 538                 foreach ( $params as $param ) {
 539                         $this->parameters[] = self::rawParam( $param );
 540                 }
 541                 return $this;
 542         }
 543
 544         /**
 545          * Add parameters that are numeric and will be passed through
 546          * Language::formatNum before substitution
 547          *
 548          * @since 1.18
 549          *
 550          * @param mixed $param,... Numeric parameters, or a single argument that is
 551          * an array of numeric parameters.
 552          *
 553          * @return Message $this
 554          */
 555         public function numParams( /*...*/ ) {
 556                 $params = func_get_args();
 557                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 558                         $params = $params[0];
 559                 }
 560                 foreach ( $params as $param ) {
 561                         $this->parameters[] = self::numParam( $param );
 562                 }
 563                 return $this;
 564         }
 565
 566         /**
 567          * Add parameters that are durations of time and will be passed through
 568          * Language::formatDuration before substitution
 569          *
 570          * @since 1.22
 571          *
 572          * @param int|int[] $param,... Duration parameters, or a single argument that is
 573          * an array of duration parameters.
 574          *
 575          * @return Message $this
 576          */
 577         public function durationParams( /*...*/ ) {
 578                 $params = func_get_args();
 579                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 580                         $params = $params[0];
 581                 }
 582                 foreach ( $params as $param ) {
 583                         $this->parameters[] = self::durationParam( $param );
 584                 }
 585                 return $this;
 586         }
 587
 588         /**
 589          * Add parameters that are expiration times and will be passed through
 590          * Language::formatExpiry before substitution
 591          *
 592          * @since 1.22
 593          *
 594          * @param string|string[] $param,... Expiry parameters, or a single argument that is
 595          * an array of expiry parameters.
 596          *
 597          * @return Message $this
 598          */
 599         public function expiryParams( /*...*/ ) {
 600                 $params = func_get_args();
 601                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 602                         $params = $params[0];
 603                 }
 604                 foreach ( $params as $param ) {
 605                         $this->parameters[] = self::expiryParam( $param );
 606                 }
 607                 return $this;
 608         }
 609
 610         /**
 611          * Add parameters that are time periods and will be passed through
 612          * Language::formatTimePeriod before substitution
 613          *
 614          * @since 1.22
 615          *
 616          * @param int|int[] $param,... Time period parameters, or a single argument that is
 617          * an array of time period parameters.
 618          *
 619          * @return Message $this
 620          */
 621         public function timeperiodParams( /*...*/ ) {
 622                 $params = func_get_args();
 623                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 624                         $params = $params[0];
 625                 }
 626                 foreach ( $params as $param ) {
 627                         $this->parameters[] = self::timeperiodParam( $param );
 628                 }
 629                 return $this;
 630         }
 631
 632         /**
 633          * Add parameters that are file sizes and will be passed through
 634          * Language::formatSize before substitution
 635          *
 636          * @since 1.22
 637          *
 638          * @param int|int[] $param,... Size parameters, or a single argument that is
 639          * an array of size parameters.
 640          *
 641          * @return Message $this
 642          */
 643         public function sizeParams( /*...*/ ) {
 644                 $params = func_get_args();
 645                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 646                         $params = $params[0];
 647                 }
 648                 foreach ( $params as $param ) {
 649                         $this->parameters[] = self::sizeParam( $param );
 650                 }
 651                 return $this;
 652         }
 653
 654         /**
 655          * Add parameters that are bitrates and will be passed through
 656          * Language::formatBitrate before substitution
 657          *
 658          * @since 1.22
 659          *
 660          * @param int|int[] $param,... Bit rate parameters, or a single argument that is
 661          * an array of bit rate parameters.
 662          *
 663          * @return Message $this
 664          */
 665         public function bitrateParams( /*...*/ ) {
 666                 $params = func_get_args();
 667                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 668                         $params = $params[0];
 669                 }
 670                 foreach ( $params as $param ) {
 671                         $this->parameters[] = self::bitrateParam( $param );
 672                 }
 673                 return $this;
 674         }
 675
 676         /**
 677          * Add parameters that are plaintext and will be passed through without
 678          * the content being evaluated.  Plaintext parameters are not valid as
 679          * arguments to parser functions. This differs from self::rawParams in
 680          * that the Message class handles escaping to match the output format.
 681          *
 682          * @since 1.25
 683          *
 684          * @param string|string[] $param,... plaintext parameters, or a single argument that is
 685          * an array of plaintext parameters.
 686          *
 687          * @return Message $this
 688          */
 689         public function plaintextParams( /*...*/ ) {
 690                 $params = func_get_args();
 691                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 692                         $params = $params[0];
 693                 }
 694                 foreach ( $params as $param ) {
 695                         $this->parameters[] = self::plaintextParam( $param );
 696                 }
 697                 return $this;
 698         }
 699
 700         /**
 701          * Set the language and the title from a context object
 702          *
 703          * @since 1.19
 704          *
 705          * @param IContextSource $context
 706          *
 707          * @return Message $this
 708          */
 709         public function setContext( IContextSource $context ) {
 710                 $this->inLanguage( $context->getLanguage() );
 711                 $this->title( $context->getTitle() );
 712                 $this->interface = true;
 713
 714                 return $this;
 715         }
 716
 717         /**
 718          * Request the message in any language that is supported.
 719          *
 720          * As a side effect interface message status is unconditionally
 721          * turned off.
 722          *
 723          * @since 1.17
 724          * @param Language|string $lang Language code or Language object.
 725          * @return Message $this
 726          * @throws MWException
 727          */
 728         public function inLanguage( $lang ) {
 729                 $previousLanguage = $this->language;
 730
 731                 if ( $lang instanceof Language ) {
 732                         $this->language = $lang;
 733                 } elseif ( is_string( $lang ) ) {
 734                         if ( !$this->language instanceof Language || $this->language->getCode() != $lang ) {
 735                                 $this->language = Language::factory( $lang );
 736                         }
 737                 } elseif ( $lang instanceof StubUserLang ) {
 738                         $this->language = false;
 739                 } else {
 740                         $type = gettype( $lang );
 741                         throw new MWException( __METHOD__ . " must be "
 742                                 . "passed a String or Language object; $type given"
 743                         );
 744                 }
 745
 746                 if ( $this->language !== $previousLanguage ) {
 747                         // The language has changed. Clear the message cache.
 748                         $this->message = null;
 749                 }
 750                 $this->interface = false;
 751                 return $this;
 752         }
 753
 754         /**
 755          * Request the message in the wiki's content language,
 756          * unless it is disabled for this message.
 757          *
 758          * @since 1.17
 759          * @see $wgForceUIMsgAsContentMsg
 760          *
 761          * @return Message $this
 762          */
 763         public function inContentLanguage() {
 764                 global $wgForceUIMsgAsContentMsg;
 765                 if ( in_array( $this->key, (array)$wgForceUIMsgAsContentMsg ) ) {
 766                         return $this;
 767                 }
 768
 769                 global $wgContLang;
 770                 $this->inLanguage( $wgContLang );
 771                 return $this;
 772         }
 773
 774         /**
 775          * Allows manipulating the interface message flag directly.
 776          * Can be used to restore the flag after setting a language.
 777          *
 778          * @since 1.20
 779          *
 780          * @param bool $interface
 781          *
 782          * @return Message $this
 783          */
 784         public function setInterfaceMessageFlag( $interface ) {
 785                 $this->interface = (bool)$interface;
 786                 return $this;
 787         }
 788
 789         /**
 790          * Enable or disable database use.
 791          *
 792          * @since 1.17
 793          *
 794          * @param bool $useDatabase
 795          *
 796          * @return Message $this
 797          */
 798         public function useDatabase( $useDatabase ) {
 799                 $this->useDatabase = (bool)$useDatabase;
 800                 $this->message = null;
 801                 return $this;
 802         }
 803
 804         /**
 805          * Set the Title object to use as context when transforming the message
 806          *
 807          * @since 1.18
 808          *
 809          * @param Title $title
 810          *
 811          * @return Message $this
 812          */
 813         public function title( $title ) {
 814                 $this->title = $title;
 815                 return $this;
 816         }
 817
 818         /**
 819          * Returns the message as a Content object.
 820          *
 821          * @return Content
 822          */
 823         public function content() {
 824                 if ( !$this->content ) {
 825                         $this->content = new MessageContent( $this );
 826                 }
 827
 828                 return $this->content;
 829         }
 830
 831         /**
 832          * Returns the message parsed from wikitext to HTML.
 833          *
 834          * @since 1.17
 835          *
 836          * @param string|null $format One of the FORMAT_* constants. Null means use whatever was used
 837          *   the last time (this is for B/C and should be avoided).
 838          *
 839          * @return string HTML
 840          * @suppress SecurityCheck-DoubleEscaped phan false positive
 841          */
 842         public function toString( $format = null ) {
 843                 if ( $format === null ) {
 844                         $ex = new LogicException( __METHOD__ . ' using implicit format: ' . $this->format );
 845                         \MediaWiki\Logger\LoggerFactory::getInstance( 'message-format' )->warning(
 846                                 $ex->getMessage(), [ 'exception' => $ex, 'format' => $this->format, 'key' => $this->key ] );
 847                         $format = $this->format;
 848                 }
 849                 $string = $this->fetchMessage();
 850
 851                 if ( $string === false ) {
 852                         // Err on the side of safety, ensure that the output
 853                         // is always html safe in the event the message key is
 854                         // missing, since in that case its highly likely the
 855                         // message key is user-controlled.
 856                         // '⧼' is used instead of '<' to side-step any
 857                         // double-escaping issues.
 858                         // (Keep synchronised with mw.Message#toString in JS.)
 859                         return '⧼' . htmlspecialchars( $this->key ) . '⧽';
 860                 }
 861
 862                 # Replace $* with a list of parameters for &uselang=qqx.
 863                 if ( strpos( $string, '$*' ) !== false ) {
 864                         $paramlist = '';
 865                         if ( $this->parameters !== [] ) {
 866                                 $paramlist = ': $' . implode( ', $', range( 1, count( $this->parameters ) ) );
 867                         }
 868                         $string = str_replace( '$*', $paramlist, $string );
 869                 }
 870
 871                 # Replace parameters before text parsing
 872                 $string = $this->replaceParameters( $string, 'before', $format );
 873
 874                 # Maybe transform using the full parser
 875                 if ( $format === self::FORMAT_PARSE ) {
 876                         $string = $this->parseText( $string );
 877                         $string = Parser::stripOuterParagraph( $string );
 878                 } elseif ( $format === self::FORMAT_BLOCK_PARSE ) {
 879                         $string = $this->parseText( $string );
 880                 } elseif ( $format === self::FORMAT_TEXT ) {
 881                         $string = $this->transformText( $string );
 882                 } elseif ( $format === self::FORMAT_ESCAPED ) {
 883                         $string = $this->transformText( $string );
 884                         $string = htmlspecialchars( $string, ENT_QUOTES, 'UTF-8', false );
 885                 }
 886
 887                 # Raw parameter replacement
 888                 $string = $this->replaceParameters( $string, 'after', $format );
 889
 890                 return $string;
 891         }
 892
 893         /**
 894          * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg:
 895          *     $foo = new Message( $key );
 896          *     $string = "<abbr>$foo</abbr>";
 897          *
 898          * @since 1.18
 899          *
 900          * @return string
 901          */
 902         public function __toString() {
 903                 // PHP doesn't allow __toString to throw exceptions and will
 904                 // trigger a fatal error if it does. So, catch any exceptions.
 905
 906                 try {
 907                         return $this->toString( self::FORMAT_PARSE );
 908                 } catch ( Exception $ex ) {
 909                         try {
 910                                 trigger_error( "Exception caught in " . __METHOD__ . " (message " . $this->key . "): "
 911                                         . $ex, E_USER_WARNING );
 912                         } catch ( Exception $ex ) {
 913                                 // Doh! Cause a fatal error after all?
 914                         }
 915
 916                         return '⧼' . htmlspecialchars( $this->key ) . '⧽';
 917                 }
 918         }
 919
 920         /**
 921          * Fully parse the text from wikitext to HTML.
 922          *
 923          * @since 1.17
 924          *
 925          * @return string Parsed HTML.
 926          */
 927         public function parse() {
 928                 $this->format = self::FORMAT_PARSE;
 929                 return $this->toString( self::FORMAT_PARSE );
 930         }
 931
 932         /**
 933          * Returns the message text. {{-transformation is done.
 934          *
 935          * @since 1.17
 936          *
 937          * @return string Unescaped message text.
 938          */
 939         public function text() {
 940                 $this->format = self::FORMAT_TEXT;
 941                 return $this->toString( self::FORMAT_TEXT );
 942         }
 943
 944         /**
 945          * Returns the message text as-is, only parameters are substituted.
 946          *
 947          * @since 1.17
 948          *
 949          * @return string Unescaped untransformed message text.
 950          */
 951         public function plain() {
 952                 $this->format = self::FORMAT_PLAIN;
 953                 return $this->toString( self::FORMAT_PLAIN );
 954         }
 955
 956         /**
 957          * Returns the parsed message text which is always surrounded by a block element.
 958          *
 959          * @since 1.17
 960          *
 961          * @return string HTML
 962          */
 963         public function parseAsBlock() {
 964                 $this->format = self::FORMAT_BLOCK_PARSE;
 965                 return $this->toString( self::FORMAT_BLOCK_PARSE );
 966         }
 967
 968         /**
 969          * Returns the message text. {{-transformation is done and the result
 970          * is escaped excluding any raw parameters.
 971          *
 972          * @since 1.17
 973          *
 974          * @return string Escaped message text.
 975          */
 976         public function escaped() {
 977                 $this->format = self::FORMAT_ESCAPED;
 978                 return $this->toString( self::FORMAT_ESCAPED );
 979         }
 980
 981         /**
 982          * Check whether a message key has been defined currently.
 983          *
 984          * @since 1.17
 985          *
 986          * @return bool
 987          */
 988         public function exists() {
 989                 return $this->fetchMessage() !== false;
 990         }
 991
 992         /**
 993          * Check whether a message does not exist, or is an empty string
 994          *
 995          * @since 1.18
 996          * @todo FIXME: Merge with isDisabled()?
 997          *
 998          * @return bool
 999          */
1000         public function isBlank() {
1001                 $message = $this->fetchMessage();
1002                 return $message === false || $message === '';
1003         }
1004
1005         /**
1006          * Check whether a message does not exist, is an empty string, or is "-".
1007          *
1008          * @since 1.18
1009          *
1010          * @return bool
1011          */
1012         public function isDisabled() {
1013                 $message = $this->fetchMessage();
1014                 return $message === false || $message === '' || $message === '-';
1015         }
1016
1017         /**
1018          * @since 1.17
1019          *
1020          * @param mixed $raw
1021          *
1022          * @return array Array with a single "raw" key.
1023          */
1024         public static function rawParam( $raw ) {
1025                 return [ 'raw' => $raw ];
1026         }
1027
1028         /**
1029          * @since 1.18
1030          *
1031          * @param mixed $num
1032          *
1033          * @return array Array with a single "num" key.
1034          */
1035         public static function numParam( $num ) {
1036                 return [ 'num' => $num ];
1037         }
1038
1039         /**
1040          * @since 1.22
1041          *
1042          * @param int $duration
1043          *
1044          * @return int[] Array with a single "duration" key.
1045          */
1046         public static function durationParam( $duration ) {
1047                 return [ 'duration' => $duration ];
1048         }
1049
1050         /**
1051          * @since 1.22
1052          *
1053          * @param string $expiry
1054          *
1055          * @return string[] Array with a single "expiry" key.
1056          */
1057         public static function expiryParam( $expiry ) {
1058                 return [ 'expiry' => $expiry ];
1059         }
1060
1061         /**
1062          * @since 1.22
1063          *
1064          * @param int $period
1065          *
1066          * @return int[] Array with a single "period" key.
1067          */
1068         public static function timeperiodParam( $period ) {
1069                 return [ 'period' => $period ];
1070         }
1071
1072         /**
1073          * @since 1.22
1074          *
1075          * @param int $size
1076          *
1077          * @return int[] Array with a single "size" key.
1078          */
1079         public static function sizeParam( $size ) {
1080                 return [ 'size' => $size ];
1081         }
1082
1083         /**
1084          * @since 1.22
1085          *
1086          * @param int $bitrate
1087          *
1088          * @return int[] Array with a single "bitrate" key.
1089          */
1090         public static function bitrateParam( $bitrate ) {
1091                 return [ 'bitrate' => $bitrate ];
1092         }
1093
1094         /**
1095          * @since 1.25
1096          *
1097          * @param string $plaintext
1098          *
1099          * @return string[] Array with a single "plaintext" key.
1100          */
1101         public static function plaintextParam( $plaintext ) {
1102                 return [ 'plaintext' => $plaintext ];
1103         }
1104
1105         /**
1106          * @since 1.29
1107          *
1108          * @param array $list
1109          * @param string $type 'comma', 'semicolon', 'pipe', 'text'
1110          * @return array Array with "list" and "type" keys.
1111          */
1112         public static function listParam( array $list, $type = 'text' ) {
1113                 if ( !isset( self::$listTypeMap[$type] ) ) {
1114                         throw new InvalidArgumentException(
1115                                 "Invalid type '$type'. Known types are: " . implode( ', ', array_keys( self::$listTypeMap ) )
1116                         );
1117                 }
1118                 return [ 'list' => $list, 'type' => $type ];
1119         }
1120
1121         /**
1122          * Substitutes any parameters into the message text.
1123          *
1124          * @since 1.17
1125          *
1126          * @param string $message The message text.
1127          * @param string $type Either "before" or "after".
1128          * @param string $format One of the FORMAT_* constants.
1129          *
1130          * @return string
1131          */
1132         protected function replaceParameters( $message, $type, $format ) {
1133                 // A temporary marker for $1 parameters that is only valid
1134                 // in non-attribute contexts. However if the entire message is escaped
1135                 // then we don't want to use it because it will be mangled in all contexts
1136                 // and its unnessary as ->escaped() messages aren't html.
1137                 $marker = $format === self::FORMAT_ESCAPED ? '$' : '$\'"';
1138                 $replacementKeys = [];
1139                 foreach ( $this->parameters as $n => $param ) {
1140                         list( $paramType, $value ) = $this->extractParam( $param, $format );
1141                         if ( $type === 'before' ) {
1142                                 if ( $paramType === 'before' ) {
1143                                         $replacementKeys['$' . ( $n + 1 )] = $value;
1144                                 } else /* $paramType === 'after' */ {
1145                                         // To protect against XSS from replacing parameters
1146                                         // inside html attributes, we convert $1 to $'"1.
1147                                         // In the event that one of the parameters ends up
1148                                         // in an attribute, either the ' or the " will be
1149                                         // escaped, breaking the replacement and avoiding XSS.
1150                                         $replacementKeys['$' . ( $n + 1 )] = $marker . ( $n + 1 );
1151                                 }
1152                         } else {
1153                                 if ( $paramType === 'after' ) {
1154                                         $replacementKeys[$marker . ( $n + 1 )] = $value;
1155                                 }
1156                         }
1157                 }
1158                 $message = strtr( $message, $replacementKeys );
1159                 return $message;
1160         }
1161
1162         /**
1163          * Extracts the parameter type and preprocessed the value if needed.
1164          *
1165          * @since 1.18
1166          *
1167          * @param mixed $param Parameter as defined in this class.
1168          * @param string $format One of the FORMAT_* constants.
1169          *
1170          * @return array Array with the parameter type (either "before" or "after") and the value.
1171          */
1172         protected function extractParam( $param, $format ) {
1173                 if ( is_array( $param ) ) {
1174                         if ( isset( $param['raw'] ) ) {
1175                                 return [ 'after', $param['raw'] ];
1176                         } elseif ( isset( $param['num'] ) ) {
1177                                 // Replace number params always in before step for now.
1178                                 // No support for combined raw and num params
1179                                 return [ 'before', $this->getLanguage()->formatNum( $param['num'] ) ];
1180                         } elseif ( isset( $param['duration'] ) ) {
1181                                 return [ 'before', $this->getLanguage()->formatDuration( $param['duration'] ) ];
1182                         } elseif ( isset( $param['expiry'] ) ) {
1183                                 return [ 'before', $this->getLanguage()->formatExpiry( $param['expiry'] ) ];
1184                         } elseif ( isset( $param['period'] ) ) {
1185                                 return [ 'before', $this->getLanguage()->formatTimePeriod( $param['period'] ) ];
1186                         } elseif ( isset( $param['size'] ) ) {
1187                                 return [ 'before', $this->getLanguage()->formatSize( $param['size'] ) ];
1188                         } elseif ( isset( $param['bitrate'] ) ) {
1189                                 return [ 'before', $this->getLanguage()->formatBitrate( $param['bitrate'] ) ];
1190                         } elseif ( isset( $param['plaintext'] ) ) {
1191                                 return [ 'after', $this->formatPlaintext( $param['plaintext'], $format ) ];
1192                         } elseif ( isset( $param['list'] ) ) {
1193                                 return $this->formatListParam( $param['list'], $param['type'], $format );
1194                         } else {
1195                                 if ( !is_scalar( $param ) ) {
1196                                         $param = serialize( $param );
1197                                 }
1198                                 \MediaWiki\Logger\LoggerFactory::getInstance( 'Bug58676' )->warning(
1199                                         'Invalid parameter for message "{msgkey}": {param}',
1200                                         [
1201                                                 'exception' => new Exception,
1202                                                 'msgkey' => $this->getKey(),
1203                                                 'param' => htmlspecialchars( $param ),
1204                                         ]
1205                                 );
1206
1207                                 return [ 'before', '[INVALID]' ];
1208                         }
1209                 } elseif ( $param instanceof Message ) {
1210                         // Match language, flags, etc. to the current message.
1211                         $msg = clone $param;
1212                         if ( $msg->language !== $this->language || $msg->useDatabase !== $this->useDatabase ) {
1213                                 // Cache depends on these parameters
1214                                 $msg->message = null;
1215                         }
1216                         $msg->interface = $this->interface;
1217                         $msg->language = $this->language;
1218                         $msg->useDatabase = $this->useDatabase;
1219                         $msg->title = $this->title;
1220
1221                         // DWIM
1222                         if ( $format === 'block-parse' ) {
1223                                 $format = 'parse';
1224                         }
1225                         $msg->format = $format;
1226
1227                         // Message objects should not be before parameters because
1228                         // then they'll get double escaped. If the message needs to be
1229                         // escaped, it'll happen right here when we call toString().
1230                         return [ 'after', $msg->toString( $format ) ];
1231                 } else {
1232                         return [ 'before', $param ];
1233                 }
1234         }
1235
1236         /**
1237          * Wrapper for what ever method we use to parse wikitext.
1238          *
1239          * @since 1.17
1240          *
1241          * @param string $string Wikitext message contents.
1242          *
1243          * @return string Wikitext parsed into HTML.
1244          */
1245         protected function parseText( $string ) {
1246                 $out = MessageCache::singleton()->parse(
1247                         $string,
1248                         $this->title,
1249                         /*linestart*/true,
1250                         $this->interface,
1251                         $this->getLanguage()
1252                 );
1253
1254                 return $out instanceof ParserOutput
1255                         ? $out->getText( [
1256                                 'enableSectionEditLinks' => false,
1257                                 // Wrapping messages in an extra <div> is probably not expected. If
1258                                 // they're outside the content area they probably shouldn't be
1259                                 // targeted by CSS that's targeting the parser output, and if
1260                                 // they're inside they already are from the outer div.
1261                                 'unwrap' => true,
1262                         ] )
1263                         : $out;
1264         }
1265
1266         /**
1267          * Wrapper for what ever method we use to {{-transform wikitext.
1268          *
1269          * @since 1.17
1270          *
1271          * @param string $string Wikitext message contents.
1272          *
1273          * @return string Wikitext with {{-constructs replaced with their values.
1274          */
1275         protected function transformText( $string ) {
1276                 return MessageCache::singleton()->transform(
1277                         $string,
1278                         $this->interface,
1279                         $this->getLanguage(),
1280                         $this->title
1281                 );
1282         }
1283
1284         /**
1285          * Wrapper for what ever method we use to get message contents.
1286          *
1287          * @since 1.17
1288          *
1289          * @return string
1290          * @throws MWException If message key array is empty.
1291          */
1292         protected function fetchMessage() {
1293                 if ( $this->message === null ) {
1294                         $cache = MessageCache::singleton();
1295
1296                         foreach ( $this->keysToTry as $key ) {
1297                                 $message = $cache->get( $key, $this->useDatabase, $this->getLanguage() );
1298                                 if ( $message !== false && $message !== '' ) {
1299                                         break;
1300                                 }
1301                         }
1302
1303                         // NOTE: The constructor makes sure keysToTry isn't empty,
1304                         //       so we know that $key and $message are initialized.
1305                         $this->key = $key;
1306                         $this->message = $message;
1307                 }
1308                 return $this->message;
1309         }
1310
1311         /**
1312          * Formats a message parameter wrapped with 'plaintext'. Ensures that
1313          * the entire string is displayed unchanged when displayed in the output
1314          * format.
1315          *
1316          * @since 1.25
1317          *
1318          * @param string $plaintext String to ensure plaintext output of
1319          * @param string $format One of the FORMAT_* constants.
1320          *
1321          * @return string Input plaintext encoded for output to $format
1322          */
1323         protected function formatPlaintext( $plaintext, $format ) {
1324                 switch ( $format ) {
1325                         case self::FORMAT_TEXT:
1326                         case self::FORMAT_PLAIN:
1327                                 return $plaintext;
1328
1329                         case self::FORMAT_PARSE:
1330                         case self::FORMAT_BLOCK_PARSE:
1331                         case self::FORMAT_ESCAPED:
1332                         default:
1333                                 return htmlspecialchars( $plaintext, ENT_QUOTES );
1334                 }
1335         }
1336
1337         /**
1338          * Formats a list of parameters as a concatenated string.
1339          * @since 1.29
1340          * @param array $params
1341          * @param string $listType
1342          * @param string $format One of the FORMAT_* constants.
1343          * @return array Array with the parameter type (either "before" or "after") and the value.
1344          */
1345         protected function formatListParam( array $params, $listType, $format ) {
1346                 if ( !isset( self::$listTypeMap[$listType] ) ) {
1347                         $warning = 'Invalid list type for message "' . $this->getKey() . '": '
1348                                 . htmlspecialchars( $listType )
1349                                 . ' (params are ' . htmlspecialchars( serialize( $params ) ) . ')';
1350                         trigger_error( $warning, E_USER_WARNING );
1351                         $e = new Exception;
1352                         wfDebugLog( 'Bug58676', $warning . "\n" . $e->getTraceAsString() );
1353                         return [ 'before', '[INVALID]' ];
1354                 }
1355                 $func = self::$listTypeMap[$listType];
1356
1357                 // Handle an empty list sensibly
1358                 if ( !$params ) {
1359                         return [ 'before', $this->getLanguage()->$func( [] ) ];
1360                 }
1361
1362                 // First, determine what kinds of list items we have
1363                 $types = [];
1364                 $vars = [];
1365                 $list = [];
1366                 foreach ( $params as $n => $p ) {
1367                         list( $type, $value ) = $this->extractParam( $p, $format );
1368                         $types[$type] = true;
1369                         $list[] = $value;
1370                         $vars[] = '$' . ( $n + 1 );
1371                 }
1372
1373                 // Easy case: all are 'before' or 'after', so just join the
1374                 // values and use the same type.
1375                 if ( count( $types ) === 1 ) {
1376                         return [ key( $types ), $this->getLanguage()->$func( $list ) ];
1377                 }
1378
1379                 // Hard case: We need to process each value per its type, then
1380                 // return the concatenated values as 'after'. We handle this by turning
1381                 // the list into a RawMessage and processing that as a parameter.
1382                 $vars = $this->getLanguage()->$func( $vars );
1383                 return $this->extractParam( new RawMessage( $vars, $params ), $format );
1384         }
1385 }