wiki.techinc.nl/includes/Message.php

<?php
/**
 * OBS!!! *EXPERIMENTAL* This class is still under discussion.
 *
 * This class provides methods for fetching interface messages and
 * processing them into variety of formats that are needed in MediaWiki.
 *
 * It is intented to replace the old wfMsg* functions that over time grew
 * unusable.
 *
 * Examples:
 * Fetching a message text for interface message
 *    $button = Xml::button( Message::key( 'submit' )->text() );
 * Messages can have parameters:
 *    Message::key( 'welcome-to' )->params( $wgSitename )->text(); 
 *        {{GRAMMAR}} and friends work correctly
 *    Message::key( 'are-friends' )->params( $user, $friend );
 *    Message::key( 'bad-message' )->rawParams( '<script>...</script>' )->escaped()
 * Sometimes the message text ends up in the database, so content language is needed.
 *    Message::key( 'file-log' )->params( $user, $filename )->inContentLanguage()->text()
 * Checking if message exists:
 *    Message::key( 'mysterious-message' )->exists()
 * If you want to use a different language:
 *    Message::key( 'email-header' )->language( $user->getOption( 'language' ) )->plain()
 *        Note that you cannot parse the text except in the content or interface
 *        languages
 *
 *
 * Comparison with old wfMsg* functions:
 *
 * Use full parsing.
 *     wfMsgExt( 'key', array( 'parseinline' ), 'apple' );
 *     === Message::key( 'key' )->params( 'apple' )->parse();
 * Parseinline is used because it is more useful when pre-building html.
 * In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
 *
 * Places where html cannot be used. {{-transformation is done.
 *     wfMsgExt( 'key', array( 'parsemag' ), 'apple', 'pear' );
 *     === Message::key( 'key' )->params( 'apple', 'pear' )->text();
 *
 * Shortcut for escaping the message too, similar to wfMsgHTML, but
 * parameters are not replaced after escaping by default.
 * $escaped = Message::key( 'key' )->rawParams( 'apple' )->escaped();
 *
 * TODO:
 * * test, can we have tests?
 * * sort out the details marked with fixme
 * * should we have _m() or similar global wrapper?
 *
 * @since 1.17
 */
class Message {
	/**
	 * In which language to get this message. True, which is the default,
	 * means the current interface language, false content language.
	 */
	protected $interface = true;
	
	/**
	 * In which language to get this message. Overrides the $interface
	 * variable.
	 */
	protected $language = null;
	
	/**
	 * The message key.
	 */
	protected $key;

	/**
	 * List of parameters which will be substituted into the message.
	 */
	protected $parameters = array();
	
	/**
	 * Some situations need exotic combinations of options to the
	 * underlying Language modules; which can be specified here.
	 * Dependencies:
	 *     'parse' implies 'transform', 'escape'
	 */
	protected $options = array(
		# Don't wrap the output in a block-level element
		'inline' => true,
		# Expand {{ constructs
		'transform' => true,
		# Output will be safe HTML
		'escape' => true,
		# Parse the text with the full parser
		'parse' => true,
		# Access the database when getting the message text
		'usedb' => true,
	);

	/**
	 * Constructor.
	 * @param $key String: message key
	 * @return Message: $this
	 */
	public function __construct( $key, $params=array(), $options=array() ) {
		$this->key = $key;
		if( $params ){
			$this->params( $params );
		}
		if( $options ){
			$this->options( $options );
		}
	}

	/**
	 * Factory function that is just wrapper for the real constructor. It is
	 * intented to be used instead of the real constructor, because it allows
	 * chaining method calls, while new objects don't.
	 * //FIXME: key or get or something else?
	 * @param $key String: message key
	 * @return Message: $this
	 */
	public function key( $key ) {
		return new Message( $key );
	}

	/**
	 * Adds parameters to the parameter list of this message.
	 * @params Vargars: parameters as Strings
	 * @return Message: $this
	 */
	public function params( /*...*/ ) {
		$this->parameters += array_values( func_get_args() );
		return $this;
	}

	/**
	 * Add parameters that are substituted after parsing or escaping.
	 * In other words the parsing process cannot access the contents
	 * of this type of parameter, and you need to make sure it is
	 * sanitized beforehand.  The parser will see "$n", instead.
	 * @param $value Varargs: raw parameters as Strings
	 * @return Message: $this
	 */
	public function rawParams( /*...*/ ) {
		$params = func_get_args();
		foreach( $params as $param ){
			$this->parameters[] =  array( 'raw' => $param );
		}
		return $this;
	}
	
	/**
	 * Set some of the individual options, if you need to use some 
	 * funky combination of them.
	 * @param $options Array $option => $value
	 * @return Message $this
	 */
	public function options( array $options ){
		foreach( $options as $key => $value ){
			if( in_array( $key, $this->options ) ){
				$this->options[$key] = (bool)$value;
			}
		}
		return $this;
	}

	/**
	 * Request the message in any language that is supported.
	 * As a side effect interface message status is unconditionally
	 * turned off.
	 * @param $lang Mixed: langauge code or language object.
	 * @return Message: $this
	 */
	public function language( $lang ) {
		if( $lang instanceof Language ){
			$this->language = $lang;
		} elseif ( is_string( $lang ) ) {
			$this->language = Language::factory( $lang );
		} else {
			$type = gettype( $lang );
			throw new MWException( "Message::langauge() must be "
				. "passed a String or Language object; $type given" 
			);
		}
		$this->interface = false;
		return $this;
	}

	/**
	 * Request the message in the wiki's content language.
	 * @return Message: $this
	 */
	public function inContentLanguage() {
		$this->interface = false;
		$this->language = null;
		return $this;
	}

	/**
	 * Returns the message parsed from wikitext to HTML.
	 * TODO: in PHP >= 5.2.0, we can make this a magic method,
	 * and then we can do, eg:
	 *     $foo = Message::get($key);
	 *     $string = "<abbr>$foo</abbr>";
	 * But we shouldn't implement that while MediaWiki still supports
	 * PHP < 5.2; or people will start using it...
	 * @return String: HTML
	 */
	public function toString() {
		$string = $this->getMessageText();
		
		# Replace parameters before text parsing
		$string = $this->replaceParameters( $string, 'before' );
		
		# Maybe transform using the full parser
		if( $this->options['parse'] ){
			$string = $this->parseText( $string );
		} else {
			
			# Transform {{ constructs
			if( $this->options['transform'] ){
				$string = $this->transformText( $string );
			}
			
			# Sanitise
			if( $this->options['escape'] ){
				# FIXME: Sanitizer method here?
				$string = htmlspecialchars( $string );
			}
		}
		
		# Strip the block element
		if( !$this->options['inline'] ){
			$m = array();
			if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
				$string = $m[1];
			}
		}
		
		# Raw parameter replacement
		$string = $this->replaceParameters( $string, 'after' );
		
		return $string;
	}
	
	public function __tostring(){ return $this->toString(); }
	
	/**
	 * Fully parse the text from wikitext to HTML
	 * @return String parsed HTML
	 */
	public function parse(){
		$this->options( array(
			'parse' => true,
		));		
		return $this->tostring();
	}

	/**
	 * Returns the message text. {{-transformation is done.
	 * @return String: Unescaped message text.
	 */
	public function text() {
		$this->options( array(
			'parse' => false,
			'transform' => true,
			'escape' => false,
		));		
		return $this->tostring();
	}

	/**
	 * Returns the message text as-is, only parameters are subsituted.
	 * @return String: Unescaped untransformed message text.
	 */
	public function plain() {
		$this->options( array(
			'parse' => false,
			'transform' => false,
			'escape' => false,
			'inline' => false,
		));		
		return $this->tostring();
	}

	/**
	 * Returns the parsed message text which is always surrounded by a block element.
	 * @return String: HTML
	 */
	public function parseAsBlock() {
		$this->options( array(
			'parse' => true,
			'inline' => true,
		));		
		return $this->tostring();
	}

	/**
	 * Returns the message text. {{-transformation is done and the result
	 * is excaped excluding any raw parameters.
	 * @return String: Escaped message text.
	 */
	public function escaped() {
		$this->options( array(
			'parse' => false,
			'transform' => true,
			'escape' => true,
			'inline' => false,
		));		
		return $this->tostring();
	}

	/**
	 * Check whether a message key has been defined currently.
	 * @return Bool: true if it is and false if not.
	 */
	public function exists() {
		global $wgMessageCache;
		return $wgMessageCache->get( 
			$this->key, 
			$this->options['usedb'], 
			$this->language 
		) !== false;
	}

	/**
	 * Substitutes any paramaters into the message text.
	 * @param $message String, the message text
	 * @param $type String: either before or after
	 * @return String
	 */
	protected function replaceParameters( $message, $type = 'before' ) {
		$replacementKeys = array();
		foreach( $this->parameters as $n => $param ) {
			if ( $type === 'before' && !is_array( $param ) ) {
				$replacementKeys['$' . ($n + 1)] = $param;
			} elseif ( $type === 'after' && isset( $param['raw'] ) ) {
				$replacementKeys['$' . ($n + 1)] = $param['raw'];
			}
		}
		$message = strtr( $message, $replacementKeys );
		return $message;
	}

	/**
	 * Wrapper for what ever method we use to parse wikitext.
	 * @param $string String: Wikitext message contents
	 * @return Wikitext parsed into HTML
	 */
	protected function parseText( $string ) {
		global $wgOut;
		if ( $this->language !== null ) {
			# FIXME: remove this limitation
			throw new MWException( 'Can only parse in interface or content language' );
		}
		return $wgOut->parse( $string, /*linestart*/true, $this->interface );
	}

	/**
	 * Wrapper for what ever method we use to {{-transform wikitext.
	 * @param $string String: Wikitext message contents
	 * @return Wikitext with {{-constructs replaced with their values.
	 */
	protected function transformText( $string ) {
		global $wgMessageCache;
		return $wgMessageCache->transform( $string, $this->interface, $this->language );
	}

	/**
	 * Wrapper for what ever method we use to get message contents
	 * @return Unmodified message contents
	 */
	protected function getMessageText() {
		global $wgMessageCache;
		$message = $wgMessageCache->get( $this->key, $this->options['usedb'], $this->language );
		return $message === false
			? '&lt;' . htmlspecialchars( $this->key ) . '&gt;'
			: $message;
	}

}