includes/api/ApiQueryDeletedrevs.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Jul 2, 2007
   6  *
   7  * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   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  */
  26
  27 /**
  28  * Query module to enumerate all deleted revisions.
  29  *
  30  * @ingroup API
  31  */
  32 class ApiQueryDeletedrevs extends ApiQueryBase {
  33
  34         public function __construct( $query, $moduleName ) {
  35                 parent::__construct( $query, $moduleName, 'dr' );
  36         }
  37
  38         public function execute() {
  39                 $user = $this->getUser();
  40                 // Before doing anything at all, let's check permissions
  41                 if ( !$user->isAllowed( 'deletedhistory' ) ) {
  42                         $this->dieUsage( 'You don\'t have permission to view deleted revision information', 'permissiondenied' );
  43                 }
  44
  45                 $db = $this->getDB();
  46                 $params = $this->extractRequestParams( false );
  47                 $prop = array_flip( $params['prop'] );
  48                 $fld_parentid = isset( $prop['parentid'] );
  49                 $fld_revid = isset( $prop['revid'] );
  50                 $fld_user = isset( $prop['user'] );
  51                 $fld_userid = isset( $prop['userid'] );
  52                 $fld_comment = isset( $prop['comment'] );
  53                 $fld_parsedcomment = isset ( $prop['parsedcomment'] );
  54                 $fld_minor = isset( $prop['minor'] );
  55                 $fld_len = isset( $prop['len'] );
  56                 $fld_sha1 = isset( $prop['sha1'] );
  57                 $fld_content = isset( $prop['content'] );
  58                 $fld_token = isset( $prop['token'] );
  59
  60                 $result = $this->getResult();
  61                 $pageSet = $this->getPageSet();
  62                 $titles = $pageSet->getTitles();
  63
  64                 // This module operates in three modes:
  65                 // 'revs': List deleted revs for certain titles (1)
  66                 // 'user': List deleted revs by a certain user (2)
  67                 // 'all': List all deleted revs in NS (3)
  68                 $mode = 'all';
  69                 if ( count( $titles ) > 0 ) {
  70                         $mode = 'revs';
  71                 } elseif ( !is_null( $params['user'] ) ) {
  72                         $mode = 'user';
  73                 }
  74
  75                 if ( $mode == 'revs' || $mode == 'user' ) {
  76                         // Ignore namespace and unique due to inability to know whether they were purposely set
  77                         foreach ( array( 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ) as $p ) {
  78                                 if ( !is_null( $params[$p] ) ) {
  79                                         $this->dieUsage( "The '{$p}' parameter cannot be used in modes 1 or 2", 'badparams' );
  80                                 }
  81                         }
  82                 } else {
  83                         foreach ( array( 'start', 'end' ) as $p ) {
  84                                 if ( !is_null( $params[$p] ) ) {
  85                                         $this->dieUsage( "The {$p} parameter cannot be used in mode 3", 'badparams' );
  86                                 }
  87                         }
  88                 }
  89
  90                 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
  91                         $this->dieUsage( 'user and excludeuser cannot be used together', 'badparams' );
  92                 }
  93
  94                 $this->addTables( 'archive' );
  95                 $this->addWhere( 'ar_deleted = 0' );
  96                 $this->addFields( array( 'ar_title', 'ar_namespace', 'ar_timestamp' ) );
  97
  98                 $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
  99                 $this->addFieldsIf( 'ar_rev_id', $fld_revid );
 100                 $this->addFieldsIf( 'ar_user_text', $fld_user );
 101                 $this->addFieldsIf( 'ar_user', $fld_userid );
 102                 $this->addFieldsIf( 'ar_comment', $fld_comment || $fld_parsedcomment );
 103                 $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
 104                 $this->addFieldsIf( 'ar_len', $fld_len );
 105                 $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
 106
 107                 if ( $fld_content ) {
 108                         $this->addTables( 'text' );
 109                         $this->addFields( array( 'ar_text', 'ar_text_id', 'old_text', 'old_flags' ) );
 110                         $this->addWhere( 'ar_text_id = old_id' );
 111
 112                         // This also means stricter restrictions
 113                         if ( !$user->isAllowed( 'undelete' ) ) {
 114                                 $this->dieUsage( 'You don\'t have permission to view deleted revision content', 'permissiondenied' );
 115                         }
 116                 }
 117                 // Check limits
 118                 $userMax = $fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1;
 119                 $botMax = $fld_content ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2;
 120
 121                 $limit = $params['limit'];
 122
 123                 if ( $limit == 'max' ) {
 124                         $limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
 125                         $this->getResult()->setParsedLimit( $this->getModuleName(), $limit );
 126                 }
 127
 128                 $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
 129
 130                 if ( $fld_token ) {
 131                         // Undelete tokens are identical for all pages, so we cache one here
 132                         $token = $user->getEditToken( '', $this->getMain()->getRequest() );
 133                 }
 134
 135                 $dir = $params['dir'];
 136
 137                 // We need a custom WHERE clause that matches all titles.
 138                 if ( $mode == 'revs' ) {
 139                         $lb = new LinkBatch( $titles );
 140                         $where = $lb->constructSet( 'ar', $db );
 141                         $this->addWhere( $where );
 142                 } elseif ( $mode == 'all' ) {
 143                         $this->addWhereFld( 'ar_namespace', $params['namespace'] );
 144
 145                         $from = is_null( $params['from'] ) ? null : $this->titleToKey( $params['from'] );
 146                         $to = is_null( $params['to'] ) ? null : $this->titleToKey( $params['to'] );
 147                         $this->addWhereRange( 'ar_title', $dir, $from, $to );
 148
 149                         if ( isset( $params['prefix'] ) ) {
 150                                 $this->addWhere( 'ar_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
 151                         }
 152                 }
 153
 154                 if ( !is_null( $params['user'] ) ) {
 155                         $this->addWhereFld( 'ar_user_text', $params['user'] );
 156                 } elseif ( !is_null( $params['excludeuser'] ) ) {
 157                         $this->addWhere( 'ar_user_text != ' .
 158                                 $db->addQuotes( $params['excludeuser'] ) );
 159                 }
 160
 161                 if ( !is_null( $params['continue'] ) && ( $mode == 'all' || $mode == 'revs' ) ) {
 162                         $cont = explode( '|', $params['continue'] );
 163                         $this->dieContinueUsageIf( count( $cont ) != 3 );
 164                         $ns = intval( $cont[0] );
 165                         $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
 166                         $title = $db->addQuotes( $cont[1] );
 167                         $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
 168                         $op = ( $dir == 'newer' ? '>' : '<' );
 169                         $this->addWhere( "ar_namespace $op $ns OR " .
 170                                         "(ar_namespace = $ns AND " .
 171                                         "(ar_title $op $title OR " .
 172                                         "(ar_title = $title AND " .
 173                                         "ar_timestamp $op= $ts)))" );
 174                 }
 175
 176                 $this->addOption( 'LIMIT', $limit + 1 );
 177                 $this->addOption( 'USE INDEX', array( 'archive' => ( $mode == 'user' ? 'usertext_timestamp' : 'name_title_timestamp' ) ) );
 178                 if ( $mode == 'all' ) {
 179                         if ( $params['unique'] ) {
 180                                 $this->addOption( 'GROUP BY', 'ar_title' );
 181                         } else {
 182                                 $sort = ( $dir == 'newer' ? '' : ' DESC' );
 183                                 $this->addOption( 'ORDER BY', array(
 184                                         'ar_title' . $sort,
 185                                         'ar_timestamp' . $sort
 186                                 ));
 187                         }
 188                 } else {
 189                         if ( $mode == 'revs' ) {
 190                                 // Sort by ns and title in the same order as timestamp for efficiency
 191                                 $this->addWhereRange( 'ar_namespace', $dir, null, null );
 192                                 $this->addWhereRange( 'ar_title', $dir, null, null );
 193                         }
 194                         $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
 195                 }
 196                 $res = $this->select( __METHOD__ );
 197                 $pageMap = array(); // Maps ns&title to (fake) pageid
 198                 $count = 0;
 199                 $newPageID = 0;
 200                 foreach ( $res as $row ) {
 201                         if ( ++$count > $limit ) {
 202                                 // We've had enough
 203                                 if ( $mode == 'all' || $mode == 'revs' ) {
 204                                         $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace ) . '|' .
 205                                                 $row->ar_title . '|' . $row->ar_timestamp );
 206                                 } else {
 207                                         $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->ar_timestamp ) );
 208                                 }
 209                                 break;
 210                         }
 211
 212                         $rev = array();
 213                         $rev['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ar_timestamp );
 214                         if ( $fld_revid ) {
 215                                 $rev['revid'] = intval( $row->ar_rev_id );
 216                         }
 217                         if ( $fld_parentid && !is_null( $row->ar_parent_id ) ) {
 218                                 $rev['parentid'] = intval( $row->ar_parent_id );
 219                         }
 220                         if ( $fld_user ) {
 221                                 $rev['user'] = $row->ar_user_text;
 222                         }
 223                         if ( $fld_userid ) {
 224                                 $rev['userid'] = $row->ar_user;
 225                         }
 226                         if ( $fld_comment ) {
 227                                 $rev['comment'] = $row->ar_comment;
 228                         }
 229
 230                         $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 231
 232                         if ( $fld_parsedcomment ) {
 233                                 $rev['parsedcomment'] = Linker::formatComment( $row->ar_comment, $title );
 234                         }
 235                         if ( $fld_minor && $row->ar_minor_edit == 1 ) {
 236                                 $rev['minor'] = '';
 237                         }
 238                         if ( $fld_len ) {
 239                                 $rev['len'] = $row->ar_len;
 240                         }
 241                         if ( $fld_sha1 ) {
 242                                 if ( $row->ar_sha1 != '' ) {
 243                                         $rev['sha1'] = wfBaseConvert( $row->ar_sha1, 36, 16, 40 );
 244                                 } else {
 245                                         $rev['sha1'] = '';
 246                                 }
 247                         }
 248                         if ( $fld_content ) {
 249                                 ApiResult::setContent( $rev, Revision::getRevisionText( $row ) );
 250                         }
 251
 252                         if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
 253                                 $pageID = $newPageID++;
 254                                 $pageMap[$row->ar_namespace][$row->ar_title] = $pageID;
 255                                 $a['revisions'] = array( $rev );
 256                                 $result->setIndexedTagName( $a['revisions'], 'rev' );
 257                                 ApiQueryBase::addTitleInfo( $a, $title );
 258                                 if ( $fld_token ) {
 259                                         $a['token'] = $token;
 260                                 }
 261                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), $pageID, $a );
 262                         } else {
 263                                 $pageID = $pageMap[$row->ar_namespace][$row->ar_title];
 264                                 $fit = $result->addValue(
 265                                         array( 'query', $this->getModuleName(), $pageID, 'revisions' ),
 266                                         null, $rev );
 267                         }
 268                         if ( !$fit ) {
 269                                 if ( $mode == 'all' || $mode == 'revs' ) {
 270                                         $this->setContinueEnumParameter( 'continue', intval( $row->ar_namespace ) . '|' .
 271                                                 $row->ar_title . '|' . $row->ar_timestamp );
 272                                 } else {
 273                                         $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->ar_timestamp ) );
 274                                 }
 275                                 break;
 276                         }
 277                 }
 278                 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
 279         }
 280
 281         public function getAllowedParams() {
 282                 return array(
 283                         'start' => array(
 284                                 ApiBase::PARAM_TYPE => 'timestamp'
 285                         ),
 286                         'end' => array(
 287                                 ApiBase::PARAM_TYPE => 'timestamp',
 288                         ),
 289                         'dir' => array(
 290                                 ApiBase::PARAM_TYPE => array(
 291                                         'newer',
 292                                         'older'
 293                                 ),
 294                                 ApiBase::PARAM_DFLT => 'older'
 295                         ),
 296                         'from' => null,
 297                         'to' => null,
 298                         'prefix' => null,
 299                         'continue' => null,
 300                         'unique' => false,
 301                         'user' => array(
 302                                 ApiBase::PARAM_TYPE => 'user'
 303                         ),
 304                         'excludeuser' => array(
 305                                 ApiBase::PARAM_TYPE => 'user'
 306                         ),
 307                         'namespace' => array(
 308                                 ApiBase::PARAM_TYPE => 'namespace',
 309                                 ApiBase::PARAM_DFLT => NS_MAIN,
 310                         ),
 311                         'limit' => array(
 312                                 ApiBase::PARAM_DFLT => 10,
 313                                 ApiBase::PARAM_TYPE => 'limit',
 314                                 ApiBase::PARAM_MIN => 1,
 315                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 316                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 317                         ),
 318                         'prop' => array(
 319                                 ApiBase::PARAM_DFLT => 'user|comment',
 320                                 ApiBase::PARAM_TYPE => array(
 321                                         'revid',
 322                                         'parentid',
 323                                         'user',
 324                                         'userid',
 325                                         'comment',
 326                                         'parsedcomment',
 327                                         'minor',
 328                                         'len',
 329                                         'sha1',
 330                                         'content',
 331                                         'token'
 332                                 ),
 333                                 ApiBase::PARAM_ISMULTI => true
 334                         ),
 335                 );
 336         }
 337
 338         public function getParamDescription() {
 339                 return array(
 340                         'start' => 'The timestamp to start enumerating from (1, 2)',
 341                         'end' => 'The timestamp to stop enumerating at (1, 2)',
 342                         'dir' => $this->getDirectionDescription( $this->getModulePrefix(), ' (1, 3)' ),
 343                         'from' => 'Start listing at this title (3)',
 344                         'to' => 'Stop listing at this title (3)',
 345                         'prefix' => 'Search for all page titles that begin with this value (3)',
 346                         'limit' => 'The maximum amount of revisions to list',
 347                         'prop' => array(
 348                                 'Which properties to get',
 349                                 ' revid          - Adds the revision ID of the deleted revision',
 350                                 ' parentid       - Adds the revision ID of the previous revision to the page',
 351                                 ' user           - Adds the user who made the revision',
 352                                 ' userid         - Adds the user ID whom made the revision',
 353                                 ' comment        - Adds the comment of the revision',
 354                                 ' parsedcomment  - Adds the parsed comment of the revision',
 355                                 ' minor          - Tags if the revision is minor',
 356                                 ' len            - Adds the length (bytes) of the revision',
 357                                 ' sha1           - Adds the SHA-1 (base 16) of the revision',
 358                                 ' content        - Adds the content of the revision',
 359                                 ' token          - Gives the edit token',
 360                         ),
 361                         'namespace' => 'Only list pages in this namespace (3)',
 362                         'user' => 'Only list revisions by this user',
 363                         'excludeuser' => 'Don\'t list revisions by this user',
 364                         'continue' => 'When more results are available, use this to continue (1, 3)',
 365                         'unique' => 'List only one revision for each page (3)',
 366                 );
 367         }
 368
 369         public function getResultProperties() {
 370                 return array(
 371                         '' => array(
 372                                 'ns' => 'namespace',
 373                                 'title' => 'string'
 374                         ),
 375                         'token' => array(
 376                                 'token' => 'string'
 377                         )
 378                 );
 379         }
 380
 381         public function getDescription() {
 382                 $p = $this->getModulePrefix();
 383                 return array(
 384                         'List deleted revisions.',
 385                         'Operates in three modes:',
 386                         ' 1) List deleted revisions for the given title(s), sorted by timestamp',
 387                         ' 2) List deleted contributions for the given user, sorted by timestamp (no titles specified)',
 388                         " 3) List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, {$p}user not set)",
 389                         'Certain parameters only apply to some modes and are ignored in others.',
 390                         'For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3',
 391                 );
 392         }
 393
 394         public function getPossibleErrors() {
 395                 return array_merge( parent::getPossibleErrors(), array(
 396                         array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revision information' ),
 397                         array( 'code' => 'badparams', 'info' => 'user and excludeuser cannot be used together' ),
 398                         array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revision content' ),
 399                         array( 'code' => 'badparams', 'info' => "The 'from' parameter cannot be used in modes 1 or 2" ),
 400                         array( 'code' => 'badparams', 'info' => "The 'to' parameter cannot be used in modes 1 or 2" ),
 401                         array( 'code' => 'badparams', 'info' => "The 'prefix' parameter cannot be used in modes 1 or 2" ),
 402                         array( 'code' => 'badparams', 'info' => "The 'start' parameter cannot be used in mode 3" ),
 403                         array( 'code' => 'badparams', 'info' => "The 'end' parameter cannot be used in mode 3" ),
 404                 ) );
 405         }
 406
 407         public function getExamples() {
 408                 return array(
 409                         'api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content'
 410                                 => 'List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1)',
 411                         'api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50'
 412                                 => 'List the last 50 deleted contributions by Bob (mode 2)',
 413                         'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50'
 414                                 => 'List the first 50 deleted revisions in the main namespace (mode 3)',
 415                         'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
 416                                 => 'List the first 50 deleted pages in the Talk namespace (mode 3):',
 417                 );
 418         }
 419
 420         public function getHelpUrls() {
 421                 return 'https://www.mediawiki.org/wiki/API:Deletedrevs';
 422         }
 423 }