5dbf5f9a2cf2781c273604a2799f446e5468de5e
4 * Created on Dec 1, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once ( 'ApiQueryBase.php' );
32 * A query action to return messages from site message cache
36 class ApiQueryAllmessages
extends ApiQueryBase
{
38 public function __construct( $query, $moduleName) {
39 parent
:: __construct( $query, $moduleName, 'am');
42 public function execute() {
43 $params = $this->extractRequestParams();
45 if ( !is_null( $params['lang'] ) )
48 $wgLang = Language
::factory( $params['lang'] );
51 $prop = array_flip( (array)$params['prop'] );
53 // Determine which messages should we print
54 $messages_target = array();
55 if ( in_array( '*', $params['messages'] ) ) {
56 $message_names = array_keys( Language
::getMessagesFor( 'en' ) );
57 sort( $message_names );
58 $messages_target = $message_names;
60 $messages_target = $params['messages'];
64 if ( isset( $params['filter'] ) ) {
65 $messages_filtered = array();
66 foreach ( $messages_target as $message ) {
67 if ( strpos( $message, $params['filter'] ) !== false ) { // !== is used because filter can be at the beginnig of the string
68 $messages_filtered[] = $message;
71 $messages_target = $messages_filtered;
74 // Get all requested messages and print the result
76 $skip = !is_null( $params['from'] );
77 $result = $this->getResult();
78 foreach ( $messages_target as $message ) {
79 // Skip all messages up to $params['from']
80 if ( $skip && $message === $params['from'] )
84 $a = array( 'name' => $message );
86 if ( isset( $params['args'] ) && count( $params['args'] ) != 0 ) {
87 $args = $params['args'];
89 // Check if the parser is enabled:
90 if ( $params[ 'enableparser' ] ){
91 $msg = wfMsgExt( $message, array( 'parsemag' ), $args );
93 $msgString = wfMsgGetKey( $message, true, false, false );
94 $msg = wfMsgReplaceArgs( $msgString, $args );
96 $msg = wfMsgGetKey( $message, true, false, false );
99 if ( wfEmptyMsg( $message, $msg ) )
102 ApiResult
::setContent( $a, $msg );
103 if ( isset( $prop['default'] ) ) {
104 $default = wfMsgGetKey( $message, false, false, false );
105 if ( $default !== $msg ) {
106 if ( wfEmptyMsg( $message, $default ) )
107 $a['defaultmissing'] = '';
109 $a['default'] = $default;
113 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $a );
115 $this->setContinueEnumParameter( 'from', $name );
120 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'message' );
123 public function getAllowedParams() {
125 'messages' => array (
126 ApiBase
:: PARAM_DFLT
=> '*',
127 ApiBase
:: PARAM_ISMULTI
=> true,
130 ApiBase
:: PARAM_ISMULTI
=> true,
131 ApiBase
:: PARAM_TYPE
=> array(
135 'enableparser' => false,
137 ApiBase
:: PARAM_ISMULTI
=> true
145 public function getParamDescription() {
147 'messages' => 'Which messages to output. "*" means all messages',
148 'prop' => 'Which properties to get',
149 'enableparser' => array('Set to enable parser, will parses the wikitext of message',
150 'Will substitute magic words, handle templates etc'),
151 'args' => 'Arguments to be substituted into message',
152 'filter' => 'Return only messages that contain this string',
153 'lang' => 'Return messages in this language',
154 'from' => 'Return messages starting at this message',
158 public function getDescription() {
159 return 'Return messages from this site.';
162 protected function getExamples() {
164 'api.php?action=query&meta=allmessages&amfilter=ipb-',
165 'api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de',
169 public function getVersion() {
170 return __CLASS__
. ': $Id$';