3 * Query the list of contributors to a page
5 * Created on Nov 14, 2013
7 * Copyright © 2013 Brad Jorsch
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
29 * A query module to show contributors to a page
34 class ApiQueryContributors
extends ApiQueryBase
{
35 /** We don't want to process too many pages at once (it hits cold
36 * database pages too heavily), so only do the first MAX_PAGES input pages
37 * in each API call (leaving the rest for continuation).
39 const MAX_PAGES
= 100;
41 public function __construct( ApiQuery
$query, $moduleName ) {
42 // "pc" is short for "page contributors", "co" was already taken by the
43 // GeoData extension's prop=coordinates.
44 parent
::__construct( $query, $moduleName, 'pc' );
47 public function execute() {
49 $params = $this->extractRequestParams();
50 $this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );
52 // Only operate on existing pages
53 $pages = array_keys( $this->getPageSet()->getGoodTitles() );
55 // Filter out already-processed pages
56 if ( $params['continue'] !== null ) {
57 $cont = explode( '|', $params['continue'] );
58 $this->dieContinueUsageIf( count( $cont ) != 2 );
59 $cont_page = (int)$cont[0];
60 $pages = array_filter( $pages, function ( $v ) use ( $cont_page ) {
61 return $v >= $cont_page;
64 if ( !count( $pages ) ) {
69 // Apply MAX_PAGES, leaving any over the limit for a continue.
71 $continuePages = null;
72 if ( count( $pages ) > self
::MAX_PAGES
) {
73 $continuePages = $pages[self
::MAX_PAGES
] . '|0';
74 $pages = array_slice( $pages, 0, self
::MAX_PAGES
);
77 $result = $this->getResult();
80 $this->addTables( 'revision' );
83 'anons' => 'COUNT(DISTINCT rev_user_text)',
85 $this->addWhereFld( 'rev_page', $pages );
86 $this->addWhere( 'rev_user = 0' );
87 $this->addWhere( $db->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' );
88 $this->addOption( 'GROUP BY', 'rev_page' );
89 $res = $this->select( __METHOD__
);
90 foreach ( $res as $row ) {
91 $fit = $result->addValue( [ 'query', 'pages', $row->page
],
92 'anoncontributors', (int)$row->anons
95 // This not fitting isn't reasonable, so it probably means that
96 // some other module used up all the space. Just set a dummy
97 // continue and hope it works next time.
98 $this->setContinueEnumParameter( 'continue',
99 $params['continue'] !== null ?
$params['continue'] : '0|0'
106 // Next, add logged-in users
107 $this->resetQueryParams();
108 $this->addTables( 'revision' );
110 'page' => 'rev_page',
111 'user' => 'rev_user',
112 'username' => 'MAX(rev_user_text)', // Non-MySQL databases don't like partial group-by
114 $this->addWhereFld( 'rev_page', $pages );
115 $this->addWhere( 'rev_user != 0' );
116 $this->addWhere( $db->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' );
117 $this->addOption( 'GROUP BY', 'rev_page, rev_user' );
118 $this->addOption( 'LIMIT', $params['limit'] +
1 );
120 // Force a sort order to ensure that properties are grouped by page
121 // But only if pp_page is not constant in the WHERE clause.
122 if ( count( $pages ) > 1 ) {
123 $this->addOption( 'ORDER BY', 'rev_page, rev_user' );
125 $this->addOption( 'ORDER BY', 'rev_user' );
129 if ( $params['group'] ) {
130 $excludeGroups = false;
131 $limitGroups = $params['group'];
132 } elseif ( $params['excludegroup'] ) {
133 $excludeGroups = true;
134 $limitGroups = $params['excludegroup'];
135 } elseif ( $params['rights'] ) {
136 $excludeGroups = false;
137 foreach ( $params['rights'] as $r ) {
138 $limitGroups = array_merge( $limitGroups, User
::getGroupsWithPermission( $r ) );
141 // If no group has the rights requested, no need to query
142 if ( !$limitGroups ) {
143 if ( $continuePages !== null ) {
144 // But we still need to continue for the next page's worth
145 // of anoncontributors
146 $this->setContinueEnumParameter( 'continue', $continuePages );
151 } elseif ( $params['excluderights'] ) {
152 $excludeGroups = true;
153 foreach ( $params['excluderights'] as $r ) {
154 $limitGroups = array_merge( $limitGroups, User
::getGroupsWithPermission( $r ) );
158 if ( $limitGroups ) {
159 $limitGroups = array_unique( $limitGroups );
160 $this->addTables( 'user_groups' );
161 $this->addJoinConds( [ 'user_groups' => [
162 $excludeGroups ?
'LEFT OUTER JOIN' : 'INNER JOIN',
165 'ug_group' => $limitGroups,
166 $this->getConfig()->get( 'DisableUserGroupExpiry' ) ?
168 'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
171 $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
174 if ( $params['continue'] !== null ) {
175 $cont = explode( '|', $params['continue'] );
176 $this->dieContinueUsageIf( count( $cont ) != 2 );
177 $cont_page = (int)$cont[0];
178 $cont_user = (int)$cont[1];
180 "rev_page > $cont_page OR " .
181 "(rev_page = $cont_page AND " .
182 "rev_user >= $cont_user)"
186 $res = $this->select( __METHOD__
);
188 foreach ( $res as $row ) {
189 if ( ++
$count > $params['limit'] ) {
190 // We've reached the one extra which shows that
191 // there are additional pages to be had. Stop here...
192 $this->setContinueEnumParameter( 'continue', $row->page
. '|' . $row->user
);
197 $fit = $this->addPageSubItem( $row->page
,
198 [ 'userid' => (int)$row->user
, 'name' => $row->username
],
202 $this->setContinueEnumParameter( 'continue', $row->page
. '|' . $row->user
);
208 if ( $continuePages !== null ) {
209 $this->setContinueEnumParameter( 'continue', $continuePages );
213 public function getCacheMode( $params ) {
217 public function getAllowedParams() {
218 $userGroups = User
::getAllGroups();
219 $userRights = User
::getAllRights();
223 ApiBase
::PARAM_TYPE
=> $userGroups,
224 ApiBase
::PARAM_ISMULTI
=> true,
227 ApiBase
::PARAM_TYPE
=> $userGroups,
228 ApiBase
::PARAM_ISMULTI
=> true,
231 ApiBase
::PARAM_TYPE
=> $userRights,
232 ApiBase
::PARAM_ISMULTI
=> true,
235 ApiBase
::PARAM_TYPE
=> $userRights,
236 ApiBase
::PARAM_ISMULTI
=> true,
239 ApiBase
::PARAM_DFLT
=> 10,
240 ApiBase
::PARAM_TYPE
=> 'limit',
241 ApiBase
::PARAM_MIN
=> 1,
242 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
243 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
246 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
251 protected function getExamplesMessages() {
253 'action=query&prop=contributors&titles=Main_Page'
254 => 'apihelp-query+contributors-example-simple',
258 public function getHelpUrls() {
259 return 'https://www.mediawiki.org/wiki/API:Contributors';