includes/api/ApiQueryRevisionsBase.php

   1 <?php
   2 /**
   3  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * A base class for functions common to producing a list of revisions.
  25  *
  26  * @ingroup API
  27  */
  28 abstract class ApiQueryRevisionsBase extends ApiQueryGeneratorBase {
  29
  30         protected $limit, $diffto, $difftotext, $difftotextpst, $expandTemplates, $generateXML,
  31                 $section, $parseContent, $fetchContent, $contentFormat, $setParsedLimit = true;
  32
  33         protected $fld_ids = false, $fld_flags = false, $fld_timestamp = false,
  34                 $fld_size = false, $fld_sha1 = false, $fld_comment = false,
  35                 $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
  36                 $fld_content = false, $fld_tags = false, $fld_contentmodel = false, $fld_parsetree = false;
  37
  38         public function execute() {
  39                 $this->run();
  40         }
  41
  42         public function executeGenerator( $resultPageSet ) {
  43                 $this->run( $resultPageSet );
  44         }
  45
  46         /**
  47          * @param ApiPageSet $resultPageSet
  48          * @return void
  49          */
  50         abstract protected function run( ApiPageSet $resultPageSet = null );
  51
  52         /**
  53          * Parse the parameters into the various instance fields.
  54          *
  55          * @param array $params
  56          */
  57         protected function parseParameters( $params ) {
  58                 if ( !is_null( $params['difftotext'] ) ) {
  59                         $this->difftotext = $params['difftotext'];
  60                         $this->difftotextpst = $params['difftotextpst'];
  61                 } elseif ( !is_null( $params['diffto'] ) ) {
  62                         if ( $params['diffto'] == 'cur' ) {
  63                                 $params['diffto'] = 0;
  64                         }
  65                         if ( ( !ctype_digit( $params['diffto'] ) || $params['diffto'] < 0 )
  66                                 && $params['diffto'] != 'prev' && $params['diffto'] != 'next'
  67                         ) {
  68                                 $p = $this->getModulePrefix();
  69                                 $this->dieWithError( [ 'apierror-baddiffto', $p ], 'diffto' );
  70                         }
  71                         // Check whether the revision exists and is readable,
  72                         // DifferenceEngine returns a rather ambiguous empty
  73                         // string if that's not the case
  74                         if ( $params['diffto'] != 0 ) {
  75                                 $difftoRev = Revision::newFromId( $params['diffto'] );
  76                                 if ( !$difftoRev ) {
  77                                         $this->dieWithError( [ 'apierror-nosuchrevid', $params['diffto'] ] );
  78                                 }
  79                                 if ( !$difftoRev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
  80                                         $this->addWarning( [ 'apiwarn-difftohidden', $difftoRev->getId() ] );
  81                                         $params['diffto'] = null;
  82                                 }
  83                         }
  84                         $this->diffto = $params['diffto'];
  85                 }
  86
  87                 $prop = array_flip( $params['prop'] );
  88
  89                 $this->fld_ids = isset( $prop['ids'] );
  90                 $this->fld_flags = isset( $prop['flags'] );
  91                 $this->fld_timestamp = isset( $prop['timestamp'] );
  92                 $this->fld_comment = isset( $prop['comment'] );
  93                 $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
  94                 $this->fld_size = isset( $prop['size'] );
  95                 $this->fld_sha1 = isset( $prop['sha1'] );
  96                 $this->fld_content = isset( $prop['content'] );
  97                 $this->fld_contentmodel = isset( $prop['contentmodel'] );
  98                 $this->fld_userid = isset( $prop['userid'] );
  99                 $this->fld_user = isset( $prop['user'] );
 100                 $this->fld_tags = isset( $prop['tags'] );
 101                 $this->fld_parsetree = isset( $prop['parsetree'] );
 102
 103                 if ( $this->fld_parsetree ) {
 104                         $encParam = $this->encodeParamName( 'prop' );
 105                         $name = $this->getModuleName();
 106                         $parent = $this->getParent();
 107                         $parentParam = $parent->encodeParamName( $parent->getModuleManager()->getModuleGroup( $name ) );
 108                         $this->addDeprecation(
 109                                 [ 'apiwarn-deprecation-parameter', "{$encParam}=parsetree" ],
 110                                 "action=query&{$parentParam}={$name}&{$encParam}=parsetree"
 111                         );
 112                 }
 113
 114                 if ( !empty( $params['contentformat'] ) ) {
 115                         $this->contentFormat = $params['contentformat'];
 116                 }
 117
 118                 $this->limit = $params['limit'];
 119
 120                 $this->fetchContent = $this->fld_content || !is_null( $this->diffto )
 121                         || !is_null( $this->difftotext ) || $this->fld_parsetree;
 122
 123                 $smallLimit = false;
 124                 if ( $this->fetchContent ) {
 125                         $smallLimit = true;
 126                         $this->expandTemplates = $params['expandtemplates'];
 127                         $this->generateXML = $params['generatexml'];
 128                         $this->parseContent = $params['parse'];
 129                         if ( $this->parseContent ) {
 130                                 // Must manually initialize unset limit
 131                                 if ( is_null( $this->limit ) ) {
 132                                         $this->limit = 1;
 133                                 }
 134                         }
 135                         if ( isset( $params['section'] ) ) {
 136                                 $this->section = $params['section'];
 137                         } else {
 138                                 $this->section = false;
 139                         }
 140                 }
 141
 142                 $userMax = $this->parseContent ? 1 : ( $smallLimit ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1 );
 143                 $botMax = $this->parseContent ? 1 : ( $smallLimit ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2 );
 144                 if ( $this->limit == 'max' ) {
 145                         $this->limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
 146                         if ( $this->setParsedLimit ) {
 147                                 $this->getResult()->addParsedLimit( $this->getModuleName(), $this->limit );
 148                         }
 149                 }
 150
 151                 if ( is_null( $this->limit ) ) {
 152                         $this->limit = 10;
 153                 }
 154                 $this->validateLimit( 'limit', $this->limit, 1, $userMax, $botMax );
 155         }
 156
 157         /**
 158          * Extract information from the Revision
 159          *
 160          * @param Revision $revision
 161          * @param object $row Should have a field 'ts_tags' if $this->fld_tags is set
 162          * @return array
 163          */
 164         protected function extractRevisionInfo( Revision $revision, $row ) {
 165                 $title = $revision->getTitle();
 166                 $user = $this->getUser();
 167                 $vals = [];
 168                 $anyHidden = false;
 169
 170                 if ( $this->fld_ids ) {
 171                         $vals['revid'] = intval( $revision->getId() );
 172                         if ( !is_null( $revision->getParentId() ) ) {
 173                                 $vals['parentid'] = intval( $revision->getParentId() );
 174                         }
 175                 }
 176
 177                 if ( $this->fld_flags ) {
 178                         $vals['minor'] = $revision->isMinor();
 179                 }
 180
 181                 if ( $this->fld_user || $this->fld_userid ) {
 182                         if ( $revision->isDeleted( Revision::DELETED_USER ) ) {
 183                                 $vals['userhidden'] = true;
 184                                 $anyHidden = true;
 185                         }
 186                         if ( $revision->userCan( Revision::DELETED_USER, $user ) ) {
 187                                 if ( $this->fld_user ) {
 188                                         $vals['user'] = $revision->getUserText( Revision::RAW );
 189                                 }
 190                                 $userid = $revision->getUser( Revision::RAW );
 191                                 if ( !$userid ) {
 192                                         $vals['anon'] = true;
 193                                 }
 194
 195                                 if ( $this->fld_userid ) {
 196                                         $vals['userid'] = $userid;
 197                                 }
 198                         }
 199                 }
 200
 201                 if ( $this->fld_timestamp ) {
 202                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $revision->getTimestamp() );
 203                 }
 204
 205                 if ( $this->fld_size ) {
 206                         if ( !is_null( $revision->getSize() ) ) {
 207                                 $vals['size'] = intval( $revision->getSize() );
 208                         } else {
 209                                 $vals['size'] = 0;
 210                         }
 211                 }
 212
 213                 if ( $this->fld_sha1 ) {
 214                         if ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
 215                                 $vals['sha1hidden'] = true;
 216                                 $anyHidden = true;
 217                         }
 218                         if ( $revision->userCan( Revision::DELETED_TEXT, $user ) ) {
 219                                 if ( $revision->getSha1() != '' ) {
 220                                         $vals['sha1'] = Wikimedia\base_convert( $revision->getSha1(), 36, 16, 40 );
 221                                 } else {
 222                                         $vals['sha1'] = '';
 223                                 }
 224                         }
 225                 }
 226
 227                 if ( $this->fld_contentmodel ) {
 228                         $vals['contentmodel'] = $revision->getContentModel();
 229                 }
 230
 231                 if ( $this->fld_comment || $this->fld_parsedcomment ) {
 232                         if ( $revision->isDeleted( Revision::DELETED_COMMENT ) ) {
 233                                 $vals['commenthidden'] = true;
 234                                 $anyHidden = true;
 235                         }
 236                         if ( $revision->userCan( Revision::DELETED_COMMENT, $user ) ) {
 237                                 $comment = $revision->getComment( Revision::RAW );
 238
 239                                 if ( $this->fld_comment ) {
 240                                         $vals['comment'] = $comment;
 241                                 }
 242
 243                                 if ( $this->fld_parsedcomment ) {
 244                                         $vals['parsedcomment'] = Linker::formatComment( $comment, $title );
 245                                 }
 246                         }
 247                 }
 248
 249                 if ( $this->fld_tags ) {
 250                         if ( $row->ts_tags ) {
 251                                 $tags = explode( ',', $row->ts_tags );
 252                                 ApiResult::setIndexedTagName( $tags, 'tag' );
 253                                 $vals['tags'] = $tags;
 254                         } else {
 255                                 $vals['tags'] = [];
 256                         }
 257                 }
 258
 259                 $content = null;
 260                 global $wgParser;
 261                 if ( $this->fetchContent ) {
 262                         $content = $revision->getContent( Revision::FOR_THIS_USER, $this->getUser() );
 263                         // Expand templates after getting section content because
 264                         // template-added sections don't count and Parser::preprocess()
 265                         // will have less input
 266                         if ( $content && $this->section !== false ) {
 267                                 $content = $content->getSection( $this->section, false );
 268                                 if ( !$content ) {
 269                                         $this->dieWithError(
 270                                                 [
 271                                                         'apierror-nosuchsection-what',
 272                                                         wfEscapeWikiText( $this->section ),
 273                                                         $this->msg( 'revid', $revision->getId() )
 274                                                 ],
 275                                                 'nosuchsection'
 276                                         );
 277                                 }
 278                         }
 279                         if ( $revision->isDeleted( Revision::DELETED_TEXT ) ) {
 280                                 $vals['texthidden'] = true;
 281                                 $anyHidden = true;
 282                         } elseif ( !$content ) {
 283                                 $vals['textmissing'] = true;
 284                         }
 285                 }
 286                 if ( $this->fld_parsetree || ( $this->fld_content && $this->generateXML ) ) {
 287                         if ( $content ) {
 288                                 if ( $content->getModel() === CONTENT_MODEL_WIKITEXT ) {
 289                                         $t = $content->getNativeData(); # note: don't set $text
 290
 291                                         $wgParser->startExternalParse(
 292                                                 $title,
 293                                                 ParserOptions::newFromContext( $this->getContext() ),
 294                                                 Parser::OT_PREPROCESS
 295                                         );
 296                                         $dom = $wgParser->preprocessToDom( $t );
 297                                         if ( is_callable( [ $dom, 'saveXML' ] ) ) {
 298                                                 $xml = $dom->saveXML();
 299                                         } else {
 300                                                 $xml = $dom->__toString();
 301                                         }
 302                                         $vals['parsetree'] = $xml;
 303                                 } else {
 304                                         $vals['badcontentformatforparsetree'] = true;
 305                                         $this->addWarning(
 306                                                 [
 307                                                         'apierror-parsetree-notwikitext-title',
 308                                                         wfEscapeWikiText( $title->getPrefixedText() ),
 309                                                         $content->getModel()
 310                                                 ],
 311                                                 'parsetree-notwikitext'
 312                                         );
 313                                 }
 314                         }
 315                 }
 316
 317                 if ( $this->fld_content && $content ) {
 318                         $text = null;
 319
 320                         if ( $this->expandTemplates && !$this->parseContent ) {
 321                                 # XXX: implement template expansion for all content types in ContentHandler?
 322                                 if ( $content->getModel() === CONTENT_MODEL_WIKITEXT ) {
 323                                         $text = $content->getNativeData();
 324
 325                                         $text = $wgParser->preprocess(
 326                                                 $text,
 327                                                 $title,
 328                                                 ParserOptions::newFromContext( $this->getContext() )
 329                                         );
 330                                 } else {
 331                                         $this->addWarning( [
 332                                                 'apierror-templateexpansion-notwikitext',
 333                                                 wfEscapeWikiText( $title->getPrefixedText() ),
 334                                                 $content->getModel()
 335                                         ] );
 336                                         $vals['badcontentformat'] = true;
 337                                         $text = false;
 338                                 }
 339                         }
 340                         if ( $this->parseContent ) {
 341                                 $po = $content->getParserOutput(
 342                                         $title,
 343                                         $revision->getId(),
 344                                         ParserOptions::newFromContext( $this->getContext() )
 345                                 );
 346                                 $text = $po->getText();
 347                         }
 348
 349                         if ( $text === null ) {
 350                                 $format = $this->contentFormat ?: $content->getDefaultFormat();
 351                                 $model = $content->getModel();
 352
 353                                 if ( !$content->isSupportedFormat( $format ) ) {
 354                                         $name = wfEscapeWikiText( $title->getPrefixedText() );
 355                                         $this->addWarning( [ 'apierror-badformat', $this->contentFormat, $model, $name ] );
 356                                         $vals['badcontentformat'] = true;
 357                                         $text = false;
 358                                 } else {
 359                                         $text = $content->serialize( $format );
 360                                         // always include format and model.
 361                                         // Format is needed to deserialize, model is needed to interpret.
 362                                         $vals['contentformat'] = $format;
 363                                         $vals['contentmodel'] = $model;
 364                                 }
 365                         }
 366
 367                         if ( $text !== false ) {
 368                                 ApiResult::setContentValue( $vals, 'content', $text );
 369                         }
 370                 }
 371
 372                 if ( $content && ( !is_null( $this->diffto ) || !is_null( $this->difftotext ) ) ) {
 373                         static $n = 0; // Number of uncached diffs we've had
 374
 375                         if ( $n < $this->getConfig()->get( 'APIMaxUncachedDiffs' ) ) {
 376                                 $vals['diff'] = [];
 377                                 $context = new DerivativeContext( $this->getContext() );
 378                                 $context->setTitle( $title );
 379                                 $handler = $revision->getContentHandler();
 380
 381                                 if ( !is_null( $this->difftotext ) ) {
 382                                         $model = $title->getContentModel();
 383
 384                                         if ( $this->contentFormat
 385                                                 && !ContentHandler::getForModelID( $model )->isSupportedFormat( $this->contentFormat )
 386                                         ) {
 387                                                 $name = wfEscapeWikiText( $title->getPrefixedText() );
 388                                                 $this->addWarning( [ 'apierror-badformat', $this->contentFormat, $model, $name ] );
 389                                                 $vals['diff']['badcontentformat'] = true;
 390                                                 $engine = null;
 391                                         } else {
 392                                                 $difftocontent = ContentHandler::makeContent(
 393                                                         $this->difftotext,
 394                                                         $title,
 395                                                         $model,
 396                                                         $this->contentFormat
 397                                                 );
 398
 399                                                 if ( $this->difftotextpst ) {
 400                                                         $popts = ParserOptions::newFromContext( $this->getContext() );
 401                                                         $difftocontent = $difftocontent->preSaveTransform( $title, $user, $popts );
 402                                                 }
 403
 404                                                 $engine = $handler->createDifferenceEngine( $context );
 405                                                 $engine->setContent( $content, $difftocontent );
 406                                         }
 407                                 } else {
 408                                         $engine = $handler->createDifferenceEngine( $context, $revision->getId(), $this->diffto );
 409                                         $vals['diff']['from'] = $engine->getOldid();
 410                                         $vals['diff']['to'] = $engine->getNewid();
 411                                 }
 412                                 if ( $engine ) {
 413                                         $difftext = $engine->getDiffBody();
 414                                         ApiResult::setContentValue( $vals['diff'], 'body', $difftext );
 415                                         if ( !$engine->wasCacheHit() ) {
 416                                                 $n++;
 417                                         }
 418                                 }
 419                         } else {
 420                                 $vals['diff']['notcached'] = true;
 421                         }
 422                 }
 423
 424                 if ( $anyHidden && $revision->isDeleted( Revision::DELETED_RESTRICTED ) ) {
 425                         $vals['suppressed'] = true;
 426                 }
 427
 428                 return $vals;
 429         }
 430
 431         public function getCacheMode( $params ) {
 432                 if ( $this->userCanSeeRevDel() ) {
 433                         return 'private';
 434                 }
 435
 436                 return 'public';
 437         }
 438
 439         public function getAllowedParams() {
 440                 return [
 441                         'prop' => [
 442                                 ApiBase::PARAM_ISMULTI => true,
 443                                 ApiBase::PARAM_DFLT => 'ids|timestamp|flags|comment|user',
 444                                 ApiBase::PARAM_TYPE => [
 445                                         'ids',
 446                                         'flags',
 447                                         'timestamp',
 448                                         'user',
 449                                         'userid',
 450                                         'size',
 451                                         'sha1',
 452                                         'contentmodel',
 453                                         'comment',
 454                                         'parsedcomment',
 455                                         'content',
 456                                         'tags',
 457                                         'parsetree',
 458                                 ],
 459                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-prop',
 460                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [
 461                                         'ids' => 'apihelp-query+revisions+base-paramvalue-prop-ids',
 462                                         'flags' => 'apihelp-query+revisions+base-paramvalue-prop-flags',
 463                                         'timestamp' => 'apihelp-query+revisions+base-paramvalue-prop-timestamp',
 464                                         'user' => 'apihelp-query+revisions+base-paramvalue-prop-user',
 465                                         'userid' => 'apihelp-query+revisions+base-paramvalue-prop-userid',
 466                                         'size' => 'apihelp-query+revisions+base-paramvalue-prop-size',
 467                                         'sha1' => 'apihelp-query+revisions+base-paramvalue-prop-sha1',
 468                                         'contentmodel' => 'apihelp-query+revisions+base-paramvalue-prop-contentmodel',
 469                                         'comment' => 'apihelp-query+revisions+base-paramvalue-prop-comment',
 470                                         'parsedcomment' => 'apihelp-query+revisions+base-paramvalue-prop-parsedcomment',
 471                                         'content' => 'apihelp-query+revisions+base-paramvalue-prop-content',
 472                                         'tags' => 'apihelp-query+revisions+base-paramvalue-prop-tags',
 473                                         'parsetree' => [ 'apihelp-query+revisions+base-paramvalue-prop-parsetree',
 474                                                 CONTENT_MODEL_WIKITEXT ],
 475                                 ],
 476                         ],
 477                         'limit' => [
 478                                 ApiBase::PARAM_TYPE => 'limit',
 479                                 ApiBase::PARAM_MIN => 1,
 480                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 481                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
 482                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-limit',
 483                         ],
 484                         'expandtemplates' => [
 485                                 ApiBase::PARAM_DFLT => false,
 486                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-expandtemplates',
 487                                 ApiBase::PARAM_DEPRECATED => true,
 488                         ],
 489                         'generatexml' => [
 490                                 ApiBase::PARAM_DFLT => false,
 491                                 ApiBase::PARAM_DEPRECATED => true,
 492                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-generatexml',
 493                         ],
 494                         'parse' => [
 495                                 ApiBase::PARAM_DFLT => false,
 496                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-parse',
 497                                 ApiBase::PARAM_DEPRECATED => true,
 498                         ],
 499                         'section' => [
 500                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-section',
 501                         ],
 502                         'diffto' => [
 503                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-diffto',
 504                                 ApiBase::PARAM_DEPRECATED => true,
 505                         ],
 506                         'difftotext' => [
 507                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-difftotext',
 508                                 ApiBase::PARAM_DEPRECATED => true,
 509                         ],
 510                         'difftotextpst' => [
 511                                 ApiBase::PARAM_DFLT => false,
 512                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-difftotextpst',
 513                                 ApiBase::PARAM_DEPRECATED => true,
 514                         ],
 515                         'contentformat' => [
 516                                 ApiBase::PARAM_TYPE => ContentHandler::getAllContentFormats(),
 517                                 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-contentformat',
 518                         ],
 519                 ];
 520         }
 521
 522 }