diff options
Diffstat (limited to 'includes/api/ApiQueryAllmessages.php')
| -rw-r--r-- | includes/api/ApiQueryAllmessages.php | 118 |
1 files changed, 76 insertions, 42 deletions
diff --git a/includes/api/ApiQueryAllmessages.php b/includes/api/ApiQueryAllmessages.php index c615daf4..7dd9d874 100644 --- a/includes/api/ApiQueryAllmessages.php +++ b/includes/api/ApiQueryAllmessages.php @@ -23,9 +23,9 @@ * http://www.gnu.org/copyleft/gpl.html */ -if (!defined('MEDIAWIKI')) { +if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ('ApiQueryBase.php'); + require_once ( 'ApiQueryBase.php' ); } /** @@ -35,79 +35,98 @@ if (!defined('MEDIAWIKI')) { */ class ApiQueryAllmessages extends ApiQueryBase { - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'am'); + public function __construct( $query, $moduleName ) { + parent :: __construct( $query, $moduleName, 'am' ); } public function execute() { - global $wgMessageCache; $params = $this->extractRequestParams(); - if(!is_null($params['lang'])) + if ( !is_null( $params['lang'] ) ) { global $wgLang; - $wgLang = Language::factory($params['lang']); + $wgLang = Language::factory( $params['lang'] ); } + + $prop = array_flip( (array)$params['prop'] ); - - //Determine which messages should we print + // Determine which messages should we print $messages_target = array(); - if( $params['messages'] == '*' ) { - $wgMessageCache->loadAllMessages(); - $message_names = array_keys( array_merge( Language::getMessagesFor( 'en' ), $wgMessageCache->getExtensionMessagesFor( 'en' ) ) ); + if ( in_array( '*', $params['messages'] ) ) { + $message_names = array_keys( Language::getMessagesFor( 'en' ) ); sort( $message_names ); $messages_target = $message_names; } else { - $messages_target = explode( '|', $params['messages'] ); + $messages_target = $params['messages']; } - //Filter messages - if( isset( $params['filter'] ) ) { + // Filter messages + if ( isset( $params['filter'] ) ) { $messages_filtered = array(); - foreach( $messages_target as $message ) { - if( strpos( $message, $params['filter'] ) !== false ) { //!== is used because filter can be at the beginnig of the string + foreach ( $messages_target as $message ) { + if ( strpos( $message, $params['filter'] ) !== false ) { // !== is used because filter can be at the beginnig of the string $messages_filtered[] = $message; } } $messages_target = $messages_filtered; } - //Get all requested messages + // Get all requested messages and print the result $messages = array(); - $skip = !is_null($params['from']); - foreach( $messages_target as $message ) { + $skip = !is_null( $params['from'] ); + $result = $this->getResult(); + foreach ( $messages_target as $message ) { // Skip all messages up to $params['from'] - if($skip && $message === $params['from']) + if ( $skip && $message === $params['from'] ) $skip = false; - if(!$skip) - $messages[$message] = wfMsg( $message ); - } - //Print the result - $result = $this->getResult(); - $messages_out = array(); - foreach( $messages as $name => $value ) { - $message = array(); - $message['name'] = $name; - if( wfEmptyMsg( $name, $value ) ) { - $message['missing'] = ''; - } else { - $result->setContent( $message, $value ); - } - $fit = $result->addValue(array('query', $this->getModuleName()), null, $message); - if(!$fit) - { - $this->setContinueEnumParameter('from', $name); - break; + if ( !$skip ) { + $a = array( 'name' => $message ); + $args = null; + if ( isset( $params['args'] ) && count( $params['args'] ) != 0 ) { + $args = $params['args']; + } + // Check if the parser is enabled: + if ( $params['enableparser'] ) { + $msg = wfMsgExt( $message, array( 'parsemag' ), $args ); + } else if ( $args ) { + $msgString = wfMsgGetKey( $message, true, false, false ); + $msg = wfMsgReplaceArgs( $msgString, $args ); + } else { + $msg = wfMsgGetKey( $message, true, false, false ); + } + + if ( wfEmptyMsg( $message, $msg ) ) + $a['missing'] = ''; + else { + ApiResult::setContent( $a, $msg ); + if ( isset( $prop['default'] ) ) { + $default = wfMsgGetKey( $message, false, false, false ); + if ( $default !== $msg ) { + if ( wfEmptyMsg( $message, $default ) ) + $a['defaultmissing'] = ''; + else + $a['default'] = $default; + } + } + } + $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $a ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'from', $name ); + break; + } } } - $result->setIndexedTagName_internal(array('query', $this->getModuleName()), 'message'); + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'message' ); } public function getCacheMode( $params ) { if ( is_null( $params['lang'] ) ) { // Language not specified, will be fetched from preferences return 'anon-public-user-private'; + } elseif ( $params['enableparser'] ) { + // User-specific parser options will be used + return 'anon-public-user-private'; } else { // OK to cache return 'public'; @@ -118,6 +137,17 @@ class ApiQueryAllmessages extends ApiQueryBase { return array ( 'messages' => array ( ApiBase :: PARAM_DFLT => '*', + ApiBase :: PARAM_ISMULTI => true, + ), + 'prop' => array( + ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_TYPE => array( + 'default' + ) + ), + 'enableparser' => false, + 'args' => array( + ApiBase :: PARAM_ISMULTI => true ), 'filter' => array(), 'lang' => null, @@ -128,6 +158,10 @@ class ApiQueryAllmessages extends ApiQueryBase { public function getParamDescription() { return array ( 'messages' => 'Which messages to output. "*" means all messages', + 'prop' => 'Which properties to get', + 'enableparser' => array( 'Set to enable parser, will preprocess the wikitext of message', + 'Will substitute magic words, handle templates etc.' ), + 'args' => 'Arguments to be substituted into message', 'filter' => 'Return only messages that contain this string', 'lang' => 'Return messages in this language', 'from' => 'Return messages starting at this message', @@ -146,6 +180,6 @@ class ApiQueryAllmessages extends ApiQueryBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryAllmessages.php 69986 2010-07-27 03:57:39Z tstarling $'; + return __CLASS__ . ': $Id: ApiQueryAllmessages.php 69932 2010-07-26 08:03:21Z tstarling $'; } } |