1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
<?php
/*
* Created on Dec 1, 2007
*
* API for MediaWiki 1.8+
*
* Copyright (C) 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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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.
* http://www.gnu.org/copyleft/gpl.html
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once ( 'ApiQueryBase.php' );
}
/**
* A query action to return messages from site message cache
*
* @ingroup API
*/
class ApiQueryAllmessages extends ApiQueryBase {
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'] );
}
$prop = array_flip( (array)$params['prop'] );
// Determine which messages should we print
$messages_target = array();
if ( in_array( '*', $params['messages'] ) ) {
$message_names = array_keys( Language::getMessagesFor( 'en' ) );
sort( $message_names );
$messages_target = $message_names;
} else {
$messages_target = $params['messages'];
}
// 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
$messages_filtered[] = $message;
}
}
$messages_target = $messages_filtered;
}
// Get all requested messages and print the result
$messages = array();
$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'] )
$skip = false;
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' );
}
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';
}
}
public function getAllowedParams() {
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,
'from' => null,
);
}
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',
);
}
public function getDescription() {
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: ApiQueryAllmessages.php 69932 2010-07-26 08:03:21Z tstarling $';
}
}
|
