includes/api/ApiQueryContributors.php

   1 <?php
   2 /**
   3  * Query the list of contributors to a page
   4  *
   5  * Created on Nov 14, 2013
   6  *
   7  * Copyright © 2013 Brad Jorsch
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  * @since 1.23
  26  */
  27
  28 /**
  29  * A query module to show contributors to a page
  30  *
  31  * @ingroup API
  32  * @since 1.23
  33  */
  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).
  38          */
  39         const MAX_PAGES = 100;
  40
  41         public function __construct( $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' );
  45         }
  46
  47         public function execute() {
  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
  79                 // First, count anons
  80                 $this->addTables( 'revision' );
  81                 $this->addFields( array(
  82                         'page' => 'rev_page',
  83                         'anons' => 'COUNT(DISTINCT rev_user_text)',
  84                 ) );
  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( array( 'query', 'pages', $row->page ),
  92                                 'anoncontributors', $row->anons
  93                         );
  94                         if ( !$fit ) {
  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'
 100                                 );
 101                                 return;
 102                         }
 103                 }
 104
 105                 // Next, add logged-in users
 106                 $this->resetQueryParams();
 107                 $this->addTables( 'revision' );
 108                 $this->addFields( array(
 109                         'page' => 'rev_page',
 110                         'user' => 'rev_user',
 111                         'username' => 'MAX(rev_user_text)', // Non-MySQL databases don't like partial group-by
 112                 ) );
 113                 $this->addWhereFld( 'rev_page', $pages );
 114                 $this->addWhere( 'rev_user != 0' );
 115                 $this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
 116                 $this->addOption( 'GROUP BY', 'rev_page, rev_user' );
 117                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 118
 119                 // Force a sort order to ensure that properties are grouped by page
 120                 // But only if pp_page is not constant in the WHERE clause.
 121                 if ( count( $pages ) > 1 ) {
 122                         $this->addOption( 'ORDER BY', 'rev_page, rev_user' );
 123                 } else {
 124                         $this->addOption( 'ORDER BY', 'rev_user' );
 125                 }
 126
 127                 $limitGroups = array();
 128                 if ( $params['group'] ) {
 129                         $excludeGroups = false;
 130                         $limitGroups = $params['group'];
 131                 } elseif ( $params['excludegroup'] ) {
 132                         $excludeGroups = true;
 133                         $limitGroups = $params['excludegroup'];
 134                 } elseif ( $params['rights'] ) {
 135                         $excludeGroups = false;
 136                         foreach ( $params['rights'] as $r ) {
 137                                 $limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
 138                         }
 139
 140                         // If no group has the rights requested, no need to query
 141                         if ( !$limitGroups ) {
 142                                 if ( $continuePages !== null ) {
 143                                         // But we still need to continue for the next page's worth
 144                                         // of anoncontributors
 145                                         $this->setContinueEnumParameter( 'continue', $continuePages );
 146                                 }
 147                                 return;
 148                         }
 149                 } elseif ( $params['excluderights'] ) {
 150                         $excludeGroups = true;
 151                         foreach ( $params['excluderights'] as $r ) {
 152                                 $limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
 153                         }
 154                 }
 155
 156                 if ( $limitGroups ) {
 157                         $limitGroups = array_unique( $limitGroups );
 158                         $this->addTables( 'user_groups' );
 159                         $this->addJoinConds( array( 'user_groups' => array(
 160                                 $excludeGroups ? 'LEFT OUTER JOIN' : 'INNER JOIN',
 161                                 array( 'ug_user=rev_user', 'ug_group' => $limitGroups )
 162                         ) ) );
 163                         $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
 164                 }
 165
 166                 if ( $params['continue'] !== null ) {
 167                         $cont = explode( '|', $params['continue'] );
 168                         $this->dieContinueUsageIf( count( $cont ) != 2 );
 169                         $cont_page = (int)$cont[0];
 170                         $cont_user = (int)$cont[1];
 171                         $this->addWhere(
 172                                 "rev_page > $cont_page OR " .
 173                                 "(rev_page = $cont_page AND " .
 174                                 "rev_user >= $cont_user)"
 175                         );
 176                 }
 177
 178                 $res = $this->select( __METHOD__ );
 179                 $count = 0;
 180                 foreach ( $res as $row ) {
 181                         if ( ++$count > $params['limit'] ) {
 182                                 // We've reached the one extra which shows that
 183                                 // there are additional pages to be had. Stop here...
 184                                 $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );
 185                                 return;
 186                         }
 187
 188                         $fit = $this->addPageSubItem( $row->page,
 189                                 array( 'userid' => $row->user, 'name' => $row->username ),
 190                                 'user'
 191                         );
 192                         if ( !$fit ) {
 193                                 $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );
 194                                 return;
 195                         }
 196                 }
 197
 198                 if ( $continuePages !== null ) {
 199                         $this->setContinueEnumParameter( 'continue', $continuePages );
 200                 }
 201         }
 202
 203         public function getCacheMode( $params ) {
 204                 return 'public';
 205         }
 206
 207         public function getAllowedParams() {
 208                 $userGroups = User::getAllGroups();
 209                 $userRights = User::getAllRights();
 210
 211                 return array(
 212                         'group' => array(
 213                                 ApiBase::PARAM_TYPE => $userGroups,
 214                                 ApiBase::PARAM_ISMULTI => true,
 215                         ),
 216                         'excludegroup' => array(
 217                                 ApiBase::PARAM_TYPE => $userGroups,
 218                                 ApiBase::PARAM_ISMULTI => true,
 219                         ),
 220                         'rights' => array(
 221                                 ApiBase::PARAM_TYPE => $userRights,
 222                                 ApiBase::PARAM_ISMULTI => true,
 223                         ),
 224                         'excluderights' => array(
 225                                 ApiBase::PARAM_TYPE => $userRights,
 226                                 ApiBase::PARAM_ISMULTI => true,
 227                         ),
 228                         'limit' => array(
 229                                 ApiBase::PARAM_DFLT => 10,
 230                                 ApiBase::PARAM_TYPE => 'limit',
 231                                 ApiBase::PARAM_MIN => 1,
 232                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 233                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 234                         ),
 235                         'continue' => null,
 236                 );
 237         }
 238
 239         public function getParamDescription() {
 240                 return array(
 241                         'group' => array(
 242                                 'Limit users to given group name(s)',
 243                                 'Does not include implicit or auto-promoted groups like *, user, or autoconfirmed'
 244                         ),
 245                         'excludegroup' => array(
 246                                 'Exclude users in given group name(s)',
 247                                 'Does not include implicit or auto-promoted groups like *, user, or autoconfirmed'
 248                         ),
 249                         'rights' => array(
 250                                 'Limit users to those having given right(s)',
 251                                 'Does not include rights granted by implicit or auto-promoted groups ' .
 252                                         'like *, user, or autoconfirmed'
 253                         ),
 254                         'excluderights' => array(
 255                                 'Limit users to those not having given right(s)',
 256                                 'Does not include rights granted by implicit or auto-promoted groups ' .
 257                                         'like *, user, or autoconfirmed'
 258                         ),
 259                         'limit' => 'How many contributors to return',
 260                         'continue' => 'When more results are available, use this to continue',
 261                 );
 262         }
 263
 264         public function getPossibleErrors() {
 265                 return array_merge( parent::getPossibleErrors(),
 266                         $this->getRequireMaxOneParameterErrorMessages(
 267                                 array( 'group', 'excludegroup', 'rights', 'excluderights' )
 268                         )
 269                 );
 270         }
 271
 272
 273         public function getDescription() {
 274                 return 'Get the list of logged-in contributors and ' .
 275                         'the count of anonymous contributors to a page';
 276         }
 277
 278         public function getExamples() {
 279                 return array(
 280                         'api.php?action=query&prop=contributors&titles=Main_Page',
 281                 );
 282         }
 283
 284         public function getHelpUrls() {
 285                 return 'https://www.mediawiki.org/wiki/API:Properties#contributors_.2F_pc';
 286         }
 287 }