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
186
187
188
189
190
191
192
|
<?php
/**
* Created on December 31, 2012
*
* Copyright © 2012 Brad Jorsch <bjorsch@wikimedia.org>
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @since 1.21
* @author Brad Jorsch
*/
/**
* A query module to enumerate pages that use a particular prop
*
* @ingroup API
* @since 1.21
*/
class ApiQueryPagesWithProp extends ApiQueryGeneratorBase {
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'pwp' );
}
public function execute() {
$this->run();
}
public function getCacheMode( $params ) {
return 'public';
}
public function executeGenerator( $resultPageSet ) {
$this->run( $resultPageSet );
}
/**
* @param ApiPageSet $resultPageSet
* @return void
*/
private function run( $resultPageSet = null ) {
$params = $this->extractRequestParams();
$prop = array_flip( $params['prop'] );
$fld_ids = isset( $prop['ids'] );
$fld_title = isset( $prop['title'] );
$fld_value = isset( $prop['value'] );
if ( $resultPageSet === null ) {
$this->addFields( array( 'page_id' ) );
$this->addFieldsIf( array( 'page_title', 'page_namespace' ), $fld_title );
$this->addFieldsIf( 'pp_value', $fld_value );
} else {
$this->addFields( $resultPageSet->getPageTableFields() );
}
$this->addTables( array( 'page_props', 'page' ) );
$this->addWhere( 'pp_page=page_id' );
$this->addWhereFld( 'pp_propname', $params['propname'] );
$dir = ( $params['dir'] == 'ascending' ) ? 'newer' : 'older';
if ( $params['continue'] ) {
$cont = explode( '|', $params['continue'] );
$this->dieContinueUsageIf( count( $cont ) != 1 );
// Add a WHERE clause
$from = (int)$cont[0];
$this->addWhereRange( 'pp_page', $dir, $from, null );
}
$sort = ( $params['dir'] === 'descending' ? ' DESC' : '' );
$this->addOption( 'ORDER BY', 'pp_page' . $sort );
$limit = $params['limit'];
$this->addOption( 'LIMIT', $limit + 1 );
$result = $this->getResult();
$count = 0;
foreach ( $this->select( __METHOD__ ) as $row ) {
if ( ++$count > $limit ) {
// We've reached the one extra which shows that there are
// additional pages to be had. Stop here...
$this->setContinueEnumParameter( 'continue', $row->page_id );
break;
}
if ( $resultPageSet === null ) {
$vals = array();
if ( $fld_ids ) {
$vals['pageid'] = (int)$row->page_id;
}
if ( $fld_title ) {
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
ApiQueryBase::addTitleInfo( $vals, $title );
}
if ( $fld_value ) {
$vals['value'] = $row->pp_value;
}
$fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
if ( !$fit ) {
$this->setContinueEnumParameter( 'continue', $row->page_id );
break;
}
} else {
$resultPageSet->processDbRow( $row );
}
}
if ( $resultPageSet === null ) {
$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
}
}
public function getAllowedParams() {
return array(
'propname' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
),
'prop' => array(
ApiBase::PARAM_DFLT => 'ids|title',
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => array(
'ids',
'title',
'value',
)
),
'continue' => null,
'limit' => array(
ApiBase::PARAM_TYPE => 'limit',
ApiBase::PARAM_DFLT => 10,
ApiBase::PARAM_MIN => 1,
ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
),
'dir' => array(
ApiBase::PARAM_DFLT => 'ascending',
ApiBase::PARAM_TYPE => array(
'ascending',
'descending',
)
),
);
}
public function getParamDescription() {
return array(
'propname' => 'Page prop for which to enumerate pages',
'prop' => array(
'What pieces of information to include',
' ids - Adds the page ID',
' title - Adds the title and namespace ID of the page',
' value - Adds the value of the page prop',
),
'dir' => 'In which direction to sort',
'continue' => 'When more results are available, use this to continue',
'limit' => 'The maximum number of pages to return',
);
}
public function getDescription() {
return 'List all pages using a given page prop.';
}
public function getExamples() {
return array(
'api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value'
=> 'Get first 10 pages using {{DISPLAYTITLE:}}',
'api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info'
=> 'Get page info about first 10 pages using __NOTOC__',
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Pageswithprop';
}
}
|
