includes/Message.php

   1 <?php
   2 /**
   3  * This class provides methods for fetching interface messages and
   4  * processing them into variety of formats that are needed in MediaWiki.
   5  *
   6  * It is intented to replace the old wfMsg* functions that over time grew
   7  * unusable.
   8  *
   9  * Examples:
  10  * Fetching a message text for interface message
  11  *    $button = Xml::button( wfMessage( 'submit' )->text() );
  12  * </pre>
  13  * Messages can have parameters:
  14  *    wfMessage( 'welcome-to' )->params( $wgSitename )->text();
  15  *        {{GRAMMAR}} and friends work correctly
  16  *    wfMessage( 'are-friends', $user, $friend );
  17  *    wfMessage( 'bad-message' )->rawParams( '<script>...</script>' )->escaped();
  18  * </pre>
  19  * Sometimes the message text ends up in the database, so content language is needed.
  20  *    wfMessage( 'file-log', $user, $filename )->inContentLanguage()->text()
  21  * </pre>
  22  * Checking if message exists:
  23  *    wfMessage( 'mysterious-message' )->exists()
  24  * </pre>
  25  * If you want to use a different language:
  26  *    wfMessage( 'email-header' )->inLanguage( $user->getOption( 'language' ) )->plain()
  27  *        Note that you cannot parse the text except in the content or interface
  28  *        languages
  29  * </pre>
  30  *
  31  *
  32  * Comparison with old wfMsg* functions:
  33  *
  34  * Use full parsing.
  35  *     wfMsgExt( 'key', array( 'parseinline' ), 'apple' );
  36  *     === wfMessage( 'key', 'apple' )->parse();
  37  * </pre>
  38  * Parseinline is used because it is more useful when pre-building html.
  39  * In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
  40  *
  41  * Places where html cannot be used. {{-transformation is done.
  42  *     wfMsgExt( 'key', array( 'parsemag' ), 'apple', 'pear' );
  43  *     === wfMessage( 'key', 'apple', 'pear' )->text();
  44  * </pre>
  45  *
  46  * Shortcut for escaping the message too, similar to wfMsgHTML, but
  47  * parameters are not replaced after escaping by default.
  48  * $escaped = wfMessage( 'key' )->rawParams( 'apple' )->escaped();
  49  * </pre>
  50  *
  51  * TODO:
  52  * - test, can we have tests?
  53  * - sort out the details marked with fixme
  54  *
  55  * @since 1.17
  56  * @author Niklas Laxström
  57  */
  58 class Message {
  59         /**
  60          * In which language to get this message. True, which is the default,
  61          * means the current interface language, false content language.
  62          */
  63         protected $interface = true;
  64
  65         /**
  66          * In which language to get this message. Overrides the $interface
  67          * variable.
  68          */
  69         protected $language = null;
  70
  71         /**
  72          * The message key.
  73          */
  74         protected $key;
  75
  76         /**
  77          * List of parameters which will be substituted into the message.
  78          */
  79         protected $parameters = array();
  80
  81         /**
  82          * Format for the message.
  83          * Supported formats are:
  84          * * text (transform)
  85          * * escaped (transform+htmlspecialchars)
  86          * * block-parse
  87          * * parse (default)
  88          * * plain
  89          */
  90         protected $format = 'parse';
  91
  92         /**
  93          * Whether database can be used.
  94          */
  95         protected $useDatabase = true;
  96
  97         /**
  98          * Constructor.
  99          * @param $key String: message key
 100          * @param $params Array message parameters
 101          * @return Message: $this
 102          */
 103         public function __construct( $key, $params = array() ) {
 104                 global $wgLang;
 105                 $this->key = $key;
 106                 $this->parameters = array_values( $params );
 107                 $this->language = $wgLang;
 108         }
 109
 110         /**
 111          * Factory function that is just wrapper for the real constructor. It is
 112          * intented to be used instead of the real constructor, because it allows
 113          * chaining method calls, while new objects don't.
 114          * @param $key String: message key
 115          * @param Varargs: parameters as Strings
 116          * @return Message: $this
 117          */
 118         public static function newFromKey( $key /*...*/ ) {
 119                 $params = func_get_args();
 120                 array_shift( $params );
 121                 return new self( $key, $params );
 122         }
 123
 124         /**
 125          * Adds parameters to the parameter list of this message.
 126          * @param Varargs: parameters as Strings
 127          * @return Message: $this
 128          */
 129         public function params( /*...*/ ) {
 130                 $this->parameters = array_merge( $this->parameters, array_values( func_get_args() ) );
 131                 return $this;
 132         }
 133
 134         /**
 135          * Add parameters that are substituted after parsing or escaping.
 136          * In other words the parsing process cannot access the contents
 137          * of this type of parameter, and you need to make sure it is
 138          * sanitized beforehand.  The parser will see "$n", instead.
 139          * @param Varargs: raw parameters as Strings
 140          * @return Message: $this
 141          */
 142         public function rawParams( /*...*/ ) {
 143                 $params = func_get_args();
 144                 foreach( $params as $param ) {
 145                         $this->parameters[] = self::rawParam( $param );
 146                 }
 147                 return $this;
 148         }
 149
 150         /**
 151          * Request the message in any language that is supported.
 152          * As a side effect interface message status is unconditionally
 153          * turned off.
 154          * @param $lang Mixed: language code or Language object.
 155          * @return Message: $this
 156          */
 157         public function inLanguage( $lang ) {
 158                 if( $lang instanceof Language ){
 159                         $this->language = $lang;
 160                 } elseif ( is_string( $lang ) ) {
 161                         $this->language = Language::factory( $lang );
 162                 } else {
 163                         $type = gettype( $lang );
 164                         throw new MWException( __METHOD__ . " must be "
 165                                 . "passed a String or Language object; $type given"
 166                         );
 167                 }
 168                 $this->interface = false;
 169                 return $this;
 170         }
 171
 172         /**
 173          * Request the message in the wiki's content language.
 174          * @return Message: $this
 175          */
 176         public function inContentLanguage() {
 177                 global $wgContLang;
 178                 $this->interface = false;
 179                 $this->language = $wgContLang;
 180                 return $this;
 181         }
 182
 183         /**
 184          * Enable or disable database use.
 185          * @param $value Boolean
 186          * @return Message: $this
 187          */
 188         public function useDatabase( $value ) {
 189                 $this->useDatabase = (bool) $value;
 190                 return $this;
 191         }
 192
 193         /**
 194          * Returns the message parsed from wikitext to HTML.
 195          * TODO: in PHP >= 5.2.0, we can make this a magic method,
 196          * and then we can do, eg:
 197          *     $foo = Message::get($key);
 198          *     $string = "<abbr>$foo</abbr>";
 199          * But we shouldn't implement that while MediaWiki still supports
 200          * PHP < 5.2; or people will start using it...
 201          * @return String: HTML
 202          */
 203         public function toString() {
 204                 $string = $this->getMessageText();
 205
 206                 # Replace parameters before text parsing
 207                 $string = $this->replaceParameters( $string, 'before' );
 208
 209                 # Maybe transform using the full parser
 210                 if( $this->format === 'parse' ) {
 211                         $string = $this->parseText( $string );
 212                         $m = array();
 213                         if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
 214                                 $string = $m[1];
 215                         }
 216                 } elseif( $this->format === 'block-parse' ){
 217                         $string = $this->parseText( $string );
 218                 } elseif( $this->format === 'text' ){
 219                         $string = $this->transformText( $string );
 220                 } elseif( $this->format === 'escaped' ){
 221                         # FIXME: Sanitizer method here?
 222                         $string = $this->transformText( $string );
 223                         $string = htmlspecialchars( $string );
 224                 }
 225
 226                 # Raw parameter replacement
 227                 $string = $this->replaceParameters( $string, 'after' );
 228
 229                 return $string;
 230         }
 231
 232         /**
 233          * Fully parse the text from wikitext to HTML
 234          * @return String parsed HTML
 235          */
 236         public function parse() {
 237                 $this->format = 'parse';
 238                 return $this->toString();
 239         }
 240
 241         /**
 242          * Returns the message text. {{-transformation is done.
 243          * @return String: Unescaped message text.
 244          */
 245         public function text() {
 246                 $this->format = 'text';
 247                 return $this->toString();
 248         }
 249
 250         /**
 251          * Returns the message text as-is, only parameters are subsituted.
 252          * @return String: Unescaped untransformed message text.
 253          */
 254         public function plain() {
 255                 $this->format = 'plain';
 256                 return $this->toString();
 257         }
 258
 259         /**
 260          * Returns the parsed message text which is always surrounded by a block element.
 261          * @return String: HTML
 262          */
 263         public function parseAsBlock() {
 264                 $this->format = 'block-parse';
 265                 return $this->toString();
 266         }
 267
 268         /**
 269          * Returns the message text. {{-transformation is done and the result
 270          * is escaped excluding any raw parameters.
 271          * @return String: Escaped message text.
 272          */
 273         public function escaped() {
 274                 $this->format = 'escaped';
 275                 return $this->toString();
 276         }
 277
 278         /**
 279          * Check whether a message key has been defined currently.
 280          * @return Bool: true if it is and false if not.
 281          */
 282         public function exists() {
 283                 return $this->fetchMessage() !== false;
 284         }
 285
 286         public static function rawParam( $value ) {
 287                 return array( 'raw' => $value );
 288         }
 289
 290         /**
 291          * Substitutes any paramaters into the message text.
 292          * @param $message String, the message text
 293          * @param $type String: either before or after
 294          * @return String
 295          */
 296         protected function replaceParameters( $message, $type = 'before' ) {
 297                 $replacementKeys = array();
 298                 foreach( $this->parameters as $n => $param ) {
 299                         if ( $type === 'before' && !is_array( $param ) ) {
 300                                 $replacementKeys['$' . ($n + 1)] = $param;
 301                         } elseif ( $type === 'after' && isset( $param['raw'] ) ) {
 302                                 $replacementKeys['$' . ($n + 1)] = $param['raw'];
 303                         }
 304                 }
 305                 $message = strtr( $message, $replacementKeys );
 306                 return $message;
 307         }
 308
 309         /**
 310          * Wrapper for what ever method we use to parse wikitext.
 311          * @param $string String: Wikitext message contents
 312          * @return Wikitext parsed into HTML
 313          */
 314         protected function parseText( $string ) {
 315                 global $wgOut, $wgLang, $wgContLang;
 316                 if ( $this->language !== $wgLang && $this->language !== $wgContLang ) {
 317                         # FIXME: remove this limitation
 318                         throw new MWException( 'Can only parse in interface or content language' );
 319                 }
 320                 return $wgOut->parse( $string, /*linestart*/true, $this->interface );
 321         }
 322
 323         /**
 324          * Wrapper for what ever method we use to {{-transform wikitext.
 325          * @param $string String: Wikitext message contents
 326          * @return Wikitext with {{-constructs replaced with their values.
 327          */
 328         protected function transformText( $string ) {
 329                 global $wgMessageCache;
 330                 return $wgMessageCache->transform( $string, $this->interface, $this->language );
 331         }
 332
 333         /**
 334          * Returns the textual value for the message.
 335          * @return Message contents or placeholder
 336          */
 337         protected function getMessageText() {
 338                 $message = $this->fetchMessage();
 339                 if ( $message === false ) {
 340                         return '&lt;' . htmlspecialchars( $this->key ) . '&gt;';
 341                 } else {
 342                         return $message;
 343                 }
 344         }
 345
 346         /**
 347          * Wrapper for what ever method we use to get message contents
 348          */
 349         protected function fetchMessage() {
 350                 if ( !isset( $this->message ) ) {
 351                         global $wgMessageCache;
 352                         $this->message = $wgMessageCache->get( $this->key, $this->useDatabase, $this->language );
 353                 }
 354                 return $this->message;
 355         }
 356
 357 }