MediaWiki  master
ApiQueryContributors.php
Go to the documentation of this file.
1 <?php
28 
40  const MAX_PAGES = 100;
41 
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' );
46  }
47 
48  public function execute() {
49  $db = $this->getDB();
50  $params = $this->extractRequestParams();
51  $this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );
52 
53  // Only operate on existing pages
54  $pages = array_keys( $this->getPageSet()->getGoodTitles() );
55 
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;
63  } );
64  }
65  if ( $pages === [] ) {
66  // Nothing to do
67  return;
68  }
69 
70  // Apply MAX_PAGES, leaving any over the limit for a continue.
71  sort( $pages );
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 );
76  }
77 
78  $result = $this->getResult();
79  $revQuery = MediaWikiServices::getInstance()->getRevisionStore()->getQueryInfo();
80 
81  // Target indexes on the revision_actor_temp table.
82  $pageField = 'revactor_page';
83  $idField = 'revactor_actor';
84  $countField = 'revactor_actor';
85 
86  // First, count anons
87  $this->addTables( $revQuery['tables'] );
88  $this->addJoinConds( $revQuery['joins'] );
89  $this->addFields( [
90  'page' => $pageField,
91  'anons' => "COUNT(DISTINCT $countField)",
92  ] );
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
101  );
102  if ( !$fit ) {
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'
108  );
109 
110  return;
111  }
112  }
113 
114  // Next, add logged-in users
115  $this->resetQueryParams();
116  $this->addTables( $revQuery['tables'] );
117  $this->addJoinConds( $revQuery['joins'] );
118  $this->addFields( [
119  'page' => $pageField,
120  'id' => $idField,
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'] . ')',
124  ] );
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 );
130 
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' ] );
135  } else {
136  $this->addOption( 'ORDER BY', 'id' );
137  }
138 
139  $limitGroups = [];
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 ) );
151  }
152 
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 );
159  }
160 
161  return;
162  }
163  } elseif ( $params['excluderights'] ) {
164  $excludeGroups = true;
165  foreach ( $params['excluderights'] as $r ) {
166  $limitGroups = array_merge( $limitGroups, $this->getPermissionManager()
167  ->getGroupsWithPermission( $r ) );
168  }
169  }
170 
171  if ( $limitGroups ) {
172  $limitGroups = array_unique( $limitGroups );
173  $this->addTables( 'user_groups' );
174  $this->addJoinConds( [ 'user_groups' => [
175  $excludeGroups ? 'LEFT JOIN' : 'JOIN',
176  [
177  'ug_user=' . $revQuery['fields']['rev_user'],
178  'ug_group' => $limitGroups,
179  'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
180  ]
181  ] ] );
182  $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
183  }
184 
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];
190  $this->addWhere(
191  "$pageField > $cont_page OR " .
192  "($pageField = $cont_page AND " .
193  "$idField >= $cont_id)"
194  );
195  }
196 
197  $res = $this->select( __METHOD__ );
198  $count = 0;
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 );
204  return;
205  }
206 
207  $fit = $this->addPageSubItem( $row->page,
208  [ 'userid' => (int)$row->userid, 'name' => $row->username ],
209  'user'
210  );
211  if ( !$fit ) {
212  $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->id );
213  return;
214  }
215  }
216 
217  if ( $continuePages !== null ) {
218  $this->setContinueEnumParameter( 'continue', $continuePages );
219  }
220  }
221 
222  public function getCacheMode( $params ) {
223  return 'public';
224  }
225 
226  public function getAllowedParams() {
227  $userGroups = User::getAllGroups();
228  $userRights = $this->getPermissionManager()->getAllPermissions();
229 
230  return [
231  'group' => [
232  ApiBase::PARAM_TYPE => $userGroups,
233  ApiBase::PARAM_ISMULTI => true,
234  ],
235  'excludegroup' => [
236  ApiBase::PARAM_TYPE => $userGroups,
237  ApiBase::PARAM_ISMULTI => true,
238  ],
239  'rights' => [
240  ApiBase::PARAM_TYPE => $userRights,
241  ApiBase::PARAM_ISMULTI => true,
242  ],
243  'excluderights' => [
244  ApiBase::PARAM_TYPE => $userRights,
245  ApiBase::PARAM_ISMULTI => true,
246  ],
247  'limit' => [
248  ApiBase::PARAM_DFLT => 10,
249  ApiBase::PARAM_TYPE => 'limit',
250  ApiBase::PARAM_MIN => 1,
253  ],
254  'continue' => [
255  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
256  ],
257  ];
258  }
259 
260  protected function getExamplesMessages() {
261  return [
262  'action=query&prop=contributors&titles=Main_Page'
263  => 'apihelp-query+contributors-example-simple',
264  ];
265  }
266 
267  public function getHelpUrls() {
268  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Contributors';
269  }
270 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
getResult()
Get the result object.
Definition: ApiBase.php:640
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
This is a base class for all Query modules.
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
getPageSet()
Get the PageSet object to work on.
__construct(ApiQuery $query, $moduleName)
const MAX_PAGES
We don&#39;t want to process too many pages at once (it hits cold database pages too heavily), so only do the first MAX_PAGES input pages in each API call (leaving the rest for continuation).
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:4864
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
static newMigration()
Static constructor.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
A query module to show contributors to a page.
addFields( $value)
Add a set of fields to select to the internal array.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
This is the main query class.
Definition: ApiQuery.php:37
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
addWhere( $value)
Add a set of WHERE clauses to the internal array.
$revQuery
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
getPermissionManager()
Obtain a PermissionManager instance that subclasses may use in their authorization checks...
Definition: ApiBase.php:710
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
requireMaxOneParameter( $params,... $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:928
resetQueryParams()
Blank the internal arrays with query parameters.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.