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() {
49 global $wgActorTableSchemaMigrationStage;
52 $params = $this->extractRequestParams();
53 $this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );
55 // Only operate on existing pages
56 $pages = array_keys( $this->getPageSet()->getGoodTitles() );
58 // Filter out already-processed pages
59 if ( $params['continue'] !== null ) {
60 $cont = explode( '|', $params['continue'] );
61 $this->dieContinueUsageIf( count( $cont ) != 2 );
62 $cont_page = (int)$cont[0];
63 $pages = array_filter( $pages, function ( $v ) use ( $cont_page ) {
64 return $v >= $cont_page;
67 if ( $pages === [] ) {
72 // Apply MAX_PAGES, leaving any over the limit for a continue.
74 $continuePages = null;
75 if ( count( $pages ) > self
::MAX_PAGES
) {
76 $continuePages = $pages[self
::MAX_PAGES
] . '|0';
77 $pages = array_slice( $pages, 0, self
::MAX_PAGES
);
80 $result = $this->getResult();
81 $revQuery = MediaWikiServices
::getInstance()->getRevisionStore()->getQueryInfo();
83 // For SCHEMA_COMPAT_READ_NEW, target indexes on the
84 // revision_actor_temp table, otherwise on the revision table.
85 $pageField = ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
)
86 ?
'revactor_page' : 'rev_page';
87 $idField = ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
)
88 ?
'revactor_actor' : $revQuery['fields']['rev_user'];
89 $countField = ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
)
90 ?
'revactor_actor' : $revQuery['fields']['rev_user_text'];
93 $this->addTables( $revQuery['tables'] );
94 $this->addJoinConds( $revQuery['joins'] );
97 'anons' => "COUNT(DISTINCT $countField)",
99 $this->addWhereFld( $pageField, $pages );
100 $this->addWhere( ActorMigration
::newMigration()->isAnon( $revQuery['fields']['rev_user'] ) );
101 $this->addWhere( $db->bitAnd( 'rev_deleted', RevisionRecord
::DELETED_USER
) . ' = 0' );
102 $this->addOption( 'GROUP BY', $pageField );
103 $res = $this->select( __METHOD__
);
104 foreach ( $res as $row ) {
105 $fit = $result->addValue( [ 'query', 'pages', $row->page
],
106 'anoncontributors', (int)$row->anons
109 // This not fitting isn't reasonable, so it probably means that
110 // some other module used up all the space. Just set a dummy
111 // continue and hope it works next time.
112 $this->setContinueEnumParameter( 'continue',
113 $params['continue'] ??
'0|0'
120 // Next, add logged-in users
121 $this->resetQueryParams();
122 $this->addTables( $revQuery['tables'] );
123 $this->addJoinConds( $revQuery['joins'] );
125 'page' => $pageField,
127 // Non-MySQL databases don't like partial group-by
128 'userid' => 'MAX(' . $revQuery['fields']['rev_user'] . ')',
129 'username' => 'MAX(' . $revQuery['fields']['rev_user_text'] . ')',
131 $this->addWhereFld( $pageField, $pages );
132 $this->addWhere( ActorMigration
::newMigration()->isNotAnon( $revQuery['fields']['rev_user'] ) );
133 $this->addWhere( $db->bitAnd( 'rev_deleted', RevisionRecord
::DELETED_USER
) . ' = 0' );
134 $this->addOption( 'GROUP BY', [ $pageField, $idField ] );
135 $this->addOption( 'LIMIT', $params['limit'] +
1 );
137 // Force a sort order to ensure that properties are grouped by page
138 // But only if rev_page is not constant in the WHERE clause.
139 if ( count( $pages ) > 1 ) {
140 $this->addOption( 'ORDER BY', [ 'page', 'id' ] );
142 $this->addOption( 'ORDER BY', 'id' );
146 if ( $params['group'] ) {
147 $excludeGroups = false;
148 $limitGroups = $params['group'];
149 } elseif ( $params['excludegroup'] ) {
150 $excludeGroups = true;
151 $limitGroups = $params['excludegroup'];
152 } elseif ( $params['rights'] ) {
153 $excludeGroups = false;
154 foreach ( $params['rights'] as $r ) {
155 $limitGroups = array_merge( $limitGroups, User
::getGroupsWithPermission( $r ) );
158 // If no group has the rights requested, no need to query
159 if ( !$limitGroups ) {
160 if ( $continuePages !== null ) {
161 // But we still need to continue for the next page's worth
162 // of anoncontributors
163 $this->setContinueEnumParameter( 'continue', $continuePages );
168 } elseif ( $params['excluderights'] ) {
169 $excludeGroups = true;
170 foreach ( $params['excluderights'] as $r ) {
171 $limitGroups = array_merge( $limitGroups, User
::getGroupsWithPermission( $r ) );
175 if ( $limitGroups ) {
176 $limitGroups = array_unique( $limitGroups );
177 $this->addTables( 'user_groups' );
178 $this->addJoinConds( [ 'user_groups' => [
179 $excludeGroups ?
'LEFT OUTER JOIN' : 'JOIN',
181 'ug_user=' . $revQuery['fields']['rev_user'],
182 'ug_group' => $limitGroups,
183 'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
186 $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
189 if ( $params['continue'] !== null ) {
190 $cont = explode( '|', $params['continue'] );
191 $this->dieContinueUsageIf( count( $cont ) != 2 );
192 $cont_page = (int)$cont[0];
193 $cont_id = (int)$cont[1];
195 "$pageField > $cont_page OR " .
196 "($pageField = $cont_page AND " .
197 "$idField >= $cont_id)"
201 $res = $this->select( __METHOD__
);
203 foreach ( $res as $row ) {
204 if ( ++
$count > $params['limit'] ) {
205 // We've reached the one extra which shows that
206 // there are additional pages to be had. Stop here...
207 $this->setContinueEnumParameter( 'continue', $row->page
. '|' . $row->id
);
211 $fit = $this->addPageSubItem( $row->page
,
212 [ 'userid' => (int)$row->userid
, 'name' => $row->username
],
216 $this->setContinueEnumParameter( 'continue', $row->page
. '|' . $row->id
);
221 if ( $continuePages !== null ) {
222 $this->setContinueEnumParameter( 'continue', $continuePages );
226 public function getCacheMode( $params ) {
230 public function getAllowedParams() {
231 $userGroups = User
::getAllGroups();
232 $userRights = User
::getAllRights();
236 ApiBase
::PARAM_TYPE
=> $userGroups,
237 ApiBase
::PARAM_ISMULTI
=> true,
240 ApiBase
::PARAM_TYPE
=> $userGroups,
241 ApiBase
::PARAM_ISMULTI
=> true,
244 ApiBase
::PARAM_TYPE
=> $userRights,
245 ApiBase
::PARAM_ISMULTI
=> true,
248 ApiBase
::PARAM_TYPE
=> $userRights,
249 ApiBase
::PARAM_ISMULTI
=> true,
252 ApiBase
::PARAM_DFLT
=> 10,
253 ApiBase
::PARAM_TYPE
=> 'limit',
254 ApiBase
::PARAM_MIN
=> 1,
255 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
256 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
259 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
264 protected function getExamplesMessages() {
266 'action=query&prop=contributors&titles=Main_Page'
267 => 'apihelp-query+contributors-example-simple',
271 public function getHelpUrls() {
272 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Contributors';