3 * Query the list of contributors to a page
5 * Copyright © 2013 Wikimedia Foundation and contributors
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
26 use MediaWiki\MediaWikiServices
;
27 use MediaWiki\Revision\RevisionRecord
;
30 * A query module to show contributors to a page
35 class ApiQueryContributors
extends ApiQueryBase
{
36 /** We don't want to process too many pages at once (it hits cold
37 * database pages too heavily), so only do the first MAX_PAGES input pages
38 * in each API call (leaving the rest for continuation).
40 const MAX_PAGES
= 100;
42 public function __construct( ApiQuery
$query, $moduleName ) {
43 // "pc" is short for "page contributors", "co" was already taken by the
44 // GeoData extension's prop=coordinates.
45 parent
::__construct( $query, $moduleName, 'pc' );
48 public function execute() {
50 $params = $this->extractRequestParams();
51 $this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );
53 // Only operate on existing pages
54 $pages = array_keys( $this->getPageSet()->getGoodTitles() );
56 // Filter out already-processed pages
57 if ( $params['continue'] !== null ) {
58 $cont = explode( '|', $params['continue'] );
59 $this->dieContinueUsageIf( count( $cont ) != 2 );
60 $cont_page = (int)$cont[0];
61 $pages = array_filter( $pages, function ( $v ) use ( $cont_page ) {
62 return $v >= $cont_page;
65 if ( $pages === [] ) {
70 // Apply MAX_PAGES, leaving any over the limit for a continue.
72 $continuePages = null;
73 if ( count( $pages ) > self
::MAX_PAGES
) {
74 $continuePages = $pages[self
::MAX_PAGES
] . '|0';
75 $pages = array_slice( $pages, 0, self
::MAX_PAGES
);
78 $result = $this->getResult();
79 $revQuery = MediaWikiServices
::getInstance()->getRevisionStore()->getQueryInfo();
81 // Target indexes on the revision_actor_temp table.
82 $pageField = 'revactor_page';
83 $idField = 'revactor_actor';
84 $countField = 'revactor_actor';
87 $this->addTables( $revQuery['tables'] );
88 $this->addJoinConds( $revQuery['joins'] );
91 'anons' => "COUNT(DISTINCT $countField)",
93 $this->addWhereFld( $pageField, $pages );
94 $this->addWhere( ActorMigration
::newMigration()->isAnon( $revQuery['fields']['rev_user'] ) );
95 $this->addWhere( $db->bitAnd( 'rev_deleted', RevisionRecord
::DELETED_USER
) . ' = 0' );
96 $this->addOption( 'GROUP BY', $pageField );
97 $res = $this->select( __METHOD__
);
98 foreach ( $res as $row ) {
99 $fit = $result->addValue( [ 'query', 'pages', $row->page
],
100 'anoncontributors', (int)$row->anons
103 // This not fitting isn't reasonable, so it probably means that
104 // some other module used up all the space. Just set a dummy
105 // continue and hope it works next time.
106 $this->setContinueEnumParameter( 'continue',
107 $params['continue'] ??
'0|0'
114 // Next, add logged-in users
115 $this->resetQueryParams();
116 $this->addTables( $revQuery['tables'] );
117 $this->addJoinConds( $revQuery['joins'] );
119 'page' => $pageField,
121 // Non-MySQL databases don't like partial group-by
122 'userid' => 'MAX(' . $revQuery['fields']['rev_user'] . ')',
123 'username' => 'MAX(' . $revQuery['fields']['rev_user_text'] . ')',
125 $this->addWhereFld( $pageField, $pages );
126 $this->addWhere( ActorMigration
::newMigration()->isNotAnon( $revQuery['fields']['rev_user'] ) );
127 $this->addWhere( $db->bitAnd( 'rev_deleted', RevisionRecord
::DELETED_USER
) . ' = 0' );
128 $this->addOption( 'GROUP BY', [ $pageField, $idField ] );
129 $this->addOption( 'LIMIT', $params['limit'] +
1 );
131 // Force a sort order to ensure that properties are grouped by page
132 // But only if rev_page is not constant in the WHERE clause.
133 if ( count( $pages ) > 1 ) {
134 $this->addOption( 'ORDER BY', [ 'page', 'id' ] );
136 $this->addOption( 'ORDER BY', 'id' );
140 if ( $params['group'] ) {
141 $excludeGroups = false;
142 $limitGroups = $params['group'];
143 } elseif ( $params['excludegroup'] ) {
144 $excludeGroups = true;
145 $limitGroups = $params['excludegroup'];
146 } elseif ( $params['rights'] ) {
147 $excludeGroups = false;
148 foreach ( $params['rights'] as $r ) {
149 $limitGroups = array_merge( $limitGroups, $this->getPermissionManager()
150 ->getGroupsWithPermission( $r ) );
153 // If no group has the rights requested, no need to query
154 if ( !$limitGroups ) {
155 if ( $continuePages !== null ) {
156 // But we still need to continue for the next page's worth
157 // of anoncontributors
158 $this->setContinueEnumParameter( 'continue', $continuePages );
163 } elseif ( $params['excluderights'] ) {
164 $excludeGroups = true;
165 foreach ( $params['excluderights'] as $r ) {
166 $limitGroups = array_merge( $limitGroups, $this->getPermissionManager()
167 ->getGroupsWithPermission( $r ) );
171 if ( $limitGroups ) {
172 $limitGroups = array_unique( $limitGroups );
173 $this->addTables( 'user_groups' );
174 $this->addJoinConds( [ 'user_groups' => [
175 $excludeGroups ?
'LEFT JOIN' : 'JOIN',
177 'ug_user=' . $revQuery['fields']['rev_user'],
178 'ug_group' => $limitGroups,
179 'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
182 $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
185 if ( $params['continue'] !== null ) {
186 $cont = explode( '|', $params['continue'] );
187 $this->dieContinueUsageIf( count( $cont ) != 2 );
188 $cont_page = (int)$cont[0];
189 $cont_id = (int)$cont[1];
191 "$pageField > $cont_page OR " .
192 "($pageField = $cont_page AND " .
193 "$idField >= $cont_id)"
197 $res = $this->select( __METHOD__
);
199 foreach ( $res as $row ) {
200 if ( ++
$count > $params['limit'] ) {
201 // We've reached the one extra which shows that
202 // there are additional pages to be had. Stop here...
203 $this->setContinueEnumParameter( 'continue', $row->page
. '|' . $row->id
);
207 $fit = $this->addPageSubItem( $row->page
,
208 [ 'userid' => (int)$row->userid
, 'name' => $row->username
],
212 $this->setContinueEnumParameter( 'continue', $row->page
. '|' . $row->id
);
217 if ( $continuePages !== null ) {
218 $this->setContinueEnumParameter( 'continue', $continuePages );
222 public function getCacheMode( $params ) {
226 public function getAllowedParams() {
227 $userGroups = User
::getAllGroups();
228 $userRights = $this->getPermissionManager()->getAllPermissions();
232 ApiBase
::PARAM_TYPE
=> $userGroups,
233 ApiBase
::PARAM_ISMULTI
=> true,
236 ApiBase
::PARAM_TYPE
=> $userGroups,
237 ApiBase
::PARAM_ISMULTI
=> true,
240 ApiBase
::PARAM_TYPE
=> $userRights,
241 ApiBase
::PARAM_ISMULTI
=> true,
244 ApiBase
::PARAM_TYPE
=> $userRights,
245 ApiBase
::PARAM_ISMULTI
=> true,
248 ApiBase
::PARAM_DFLT
=> 10,
249 ApiBase
::PARAM_TYPE
=> 'limit',
250 ApiBase
::PARAM_MIN
=> 1,
251 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
252 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
255 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
260 protected function getExamplesMessages() {
262 'action=query&prop=contributors&titles=Main_Page'
263 => 'apihelp-query+contributors-example-simple',
267 public function getHelpUrls() {
268 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Contributors';