includes/api/ApiQueryContributors.php

   1 <?php
   2 /**
   3  * Query the list of contributors to a page
   4  *
   5  * Copyright © 2013 Wikimedia Foundation and contributors
   6  *
   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.
  11  *
  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.
  16  *
  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
  21  *
  22  * @file
  23  * @since 1.23
  24  */
  25
  26 /**
  27  * A query module to show contributors to a page
  28  *
  29  * @ingroup API
  30  * @since 1.23
  31  */
  32 class ApiQueryContributors extends ApiQueryBase {
  33         /** We don't want to process too many pages at once (it hits cold
  34          * database pages too heavily), so only do the first MAX_PAGES input pages
  35          * in each API call (leaving the rest for continuation).
  36          */
  37         const MAX_PAGES = 100;
  38
  39         public function __construct( ApiQuery $query, $moduleName ) {
  40                 // "pc" is short for "page contributors", "co" was already taken by the
  41                 // GeoData extension's prop=coordinates.
  42                 parent::__construct( $query, $moduleName, 'pc' );
  43         }
  44
  45         public function execute() {
  46                 global $wgActorTableSchemaMigrationStage;
  47
  48                 $db = $this->getDB();
  49                 $params = $this->extractRequestParams();
  50                 $this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );
  51
  52                 // Only operate on existing pages
  53                 $pages = array_keys( $this->getPageSet()->getGoodTitles() );
  54
  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;
  62                         } );
  63                 }
  64                 if ( !count( $pages ) ) {
  65                         // Nothing to do
  66                         return;
  67                 }
  68
  69                 // Apply MAX_PAGES, leaving any over the limit for a continue.
  70                 sort( $pages );
  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 );
  75                 }
  76
  77                 $result = $this->getResult();
  78                 $revQuery = Revision::getQueryInfo();
  79
  80                 // For MIGRATION_NEW, target indexes on the revision_actor_temp table.
  81                 // Otherwise, revision is fine because it'll have to check all revision rows anyway.
  82                 $pageField = $wgActorTableSchemaMigrationStage === MIGRATION_NEW ? 'revactor_page' : 'rev_page';
  83                 $idField = $wgActorTableSchemaMigrationStage === MIGRATION_NEW
  84                         ? 'revactor_actor' : $revQuery['fields']['rev_user'];
  85                 $countField = $wgActorTableSchemaMigrationStage === MIGRATION_NEW
  86                         ? 'revactor_actor' : $revQuery['fields']['rev_user_text'];
  87
  88                 // First, count anons
  89                 $this->addTables( $revQuery['tables'] );
  90                 $this->addJoinConds( $revQuery['joins'] );
  91                 $this->addFields( [
  92                         'page' => $pageField,
  93                         'anons' => "COUNT(DISTINCT $countField)",
  94                 ] );
  95                 $this->addWhereFld( $pageField, $pages );
  96                 $this->addWhere( ActorMigration::newMigration()->isAnon( $revQuery['fields']['rev_user'] ) );
  97                 $this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
  98                 $this->addOption( 'GROUP BY', $pageField );
  99                 $res = $this->select( __METHOD__ );
 100                 foreach ( $res as $row ) {
 101                         $fit = $result->addValue( [ 'query', 'pages', $row->page ],
 102                                 'anoncontributors', (int)$row->anons
 103                         );
 104                         if ( !$fit ) {
 105                                 // This not fitting isn't reasonable, so it probably means that
 106                                 // some other module used up all the space. Just set a dummy
 107                                 // continue and hope it works next time.
 108                                 $this->setContinueEnumParameter( 'continue',
 109                                         $params['continue'] !== null ? $params['continue'] : '0|0'
 110                                 );
 111
 112                                 return;
 113                         }
 114                 }
 115
 116                 // Next, add logged-in users
 117                 $this->resetQueryParams();
 118                 $this->addTables( $revQuery['tables'] );
 119                 $this->addJoinConds( $revQuery['joins'] );
 120                 $this->addFields( [
 121                         'page' => $pageField,
 122                         'id' => $idField,
 123                         // Non-MySQL databases don't like partial group-by
 124                         'userid' => 'MAX(' . $revQuery['fields']['rev_user'] . ')',
 125                         'username' => 'MAX(' . $revQuery['fields']['rev_user_text'] . ')',
 126                 ] );
 127                 $this->addWhereFld( $pageField, $pages );
 128                 $this->addWhere( ActorMigration::newMigration()->isNotAnon( $revQuery['fields']['rev_user'] ) );
 129                 $this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
 130                 $this->addOption( 'GROUP BY', [ $pageField, $idField ] );
 131                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 132
 133                 // Force a sort order to ensure that properties are grouped by page
 134                 // But only if rev_page is not constant in the WHERE clause.
 135                 if ( count( $pages ) > 1 ) {
 136                         $this->addOption( 'ORDER BY', [ 'page', 'id' ] );
 137                 } else {
 138                         $this->addOption( 'ORDER BY', 'id' );
 139                 }
 140
 141                 $limitGroups = [];
 142                 if ( $params['group'] ) {
 143                         $excludeGroups = false;
 144                         $limitGroups = $params['group'];
 145                 } elseif ( $params['excludegroup'] ) {
 146                         $excludeGroups = true;
 147                         $limitGroups = $params['excludegroup'];
 148                 } elseif ( $params['rights'] ) {
 149                         $excludeGroups = false;
 150                         foreach ( $params['rights'] as $r ) {
 151                                 $limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
 152                         }
 153
 154                         // If no group has the rights requested, no need to query
 155                         if ( !$limitGroups ) {
 156                                 if ( $continuePages !== null ) {
 157                                         // But we still need to continue for the next page's worth
 158                                         // of anoncontributors
 159                                         $this->setContinueEnumParameter( 'continue', $continuePages );
 160                                 }
 161
 162                                 return;
 163                         }
 164                 } elseif ( $params['excluderights'] ) {
 165                         $excludeGroups = true;
 166                         foreach ( $params['excluderights'] as $r ) {
 167                                 $limitGroups = array_merge( $limitGroups, User::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 OUTER JOIN' : 'INNER 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 = User::getAllRights();
 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,
 251                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 252                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 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 }