re r64403 - remove never-actually-used $flag parameter from verifyUpload()
[lhc/web/wiklou.git] / includes / api / ApiQueryAllmessages.php
index cb79f8f..6e5cbd2 100644 (file)
@@ -1,11 +1,11 @@
 <?php
 
-/*
+/**
  * Created on Dec 1, 2007
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * 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,77 +35,117 @@ 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() {
                $params = $this->extractRequestParams();
 
-               if(!is_null($params['lang']))
-               {
-                       global $wgLang;
-                       $wgLang = Language::factory($params['lang']);
+               global $wgLang;
+               
+               $oldLang = null;
+               if ( !is_null( $params['lang'] ) && $params['lang'] != $wgLang->getCode() ) {
+                       $oldLang = $wgLang; // Keep $wgLang for restore later
+                       $wgLang = Language::factory( $params['lang'] );
+               } else if ( is_null( $params['lang'] ) ) {
+                       // Language not determined by URL but by user preferences, so don't cache
+                       $this->getMain()->setVaryCookie();
                }
 
+               $prop = array_flip( (array)$params['prop'] );
 
-               //Determine which messages should we print
+               // Determine which messages should we print
                $messages_target = array();
-               if( $params['messages'] == '*' ) {
+               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 ) {
+                               // !== is used because filter can be at the beginning of the string
+                               if ( strpos( $message, $params['filter'] ) !== false ) {
                                        $messages_filtered[] = $message;
                                }
                        }
                        $messages_target = $messages_filtered;
                }
 
-               //Get all requested messages
-               $messages = array();
-               $skip = !is_null($params['from']);
-               foreach( $messages_target as $message ) {
+               // Get all requested messages and print the result
+               $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 );
+                               } elseif ( $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' );
+               
+               if ( !is_null( $oldLang ) ) {
+                       $wgLang = $oldLang; // Restore $oldLang
+               }
        }
 
        public function getAllowedParams() {
-               return array (
-                       'messages' => array (
-                               ApiBase :: PARAM_DFLT => '*',
+               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,
@@ -114,8 +154,12 @@ class ApiQueryAllmessages extends ApiQueryBase {
        }
 
        public function getParamDescription() {
-               return array (
+               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',
@@ -123,17 +167,17 @@ class ApiQueryAllmessages extends ApiQueryBase {
        }
 
        public function getDescription() {
-               return 'Return messages from this site.';
+               return 'Return messages from this site';
        }
 
        protected function getExamples() {
                return array(
                        'api.php?action=query&meta=allmessages&amfilter=ipb-',
                        'api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de',
-                       );
+               );
        }
 
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
\ No newline at end of file
+}