dff469a408
During development a lot of classes were placed in MediaWiki\Storage\. The precedent set would mean that every class relating to something stored in a database table, plus all related value classes and such, would go into that namespace. Let's put them into MediaWiki\Revision\ instead. Then future classes related to the 'page' table can go into MediaWiki\Page\, future classes related to the 'user' table can go into MediaWiki\User\, and so on. Note I didn't move DerivedPageDataUpdater, PageUpdateException, PageUpdater, or RevisionSlotsUpdate in this patch. If these are kept long-term, they probably belong in MediaWiki\Page\ or MediaWiki\Edit\ instead. Bug: T204158 Change-Id: I16bea8927566a3c73c07e4f4afb3537e05aa04a5
727 lines
23 KiB
PHP
727 lines
23 KiB
PHP
<?php
|
|
/**
|
|
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Revision\RevisionAccessException;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
use MediaWiki\Revision\SlotRecord;
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* A base class for functions common to producing a list of revisions.
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
abstract class ApiQueryRevisionsBase extends ApiQueryGeneratorBase {
|
|
|
|
/**
|
|
* @name Constants for internal use. Don't use externally.
|
|
* @{
|
|
*/
|
|
|
|
// Bits to indicate the results of the revdel permission check on a revision,
|
|
// see self::checkRevDel()
|
|
const IS_DELETED = 1; // Whether the field is revision-deleted
|
|
const CANNOT_VIEW = 2; // Whether the user cannot view the field due to revdel
|
|
|
|
/**@}*/
|
|
|
|
protected $limit, $diffto, $difftotext, $difftotextpst, $expandTemplates, $generateXML,
|
|
$section, $parseContent, $fetchContent, $contentFormat, $setParsedLimit = true,
|
|
$slotRoles = null, $needSlots;
|
|
|
|
protected $fld_ids = false, $fld_flags = false, $fld_timestamp = false,
|
|
$fld_size = false, $fld_slotsize = false, $fld_sha1 = false, $fld_slotsha1 = false,
|
|
$fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
|
|
$fld_content = false, $fld_tags = false, $fld_contentmodel = false, $fld_roles = false,
|
|
$fld_parsetree = false;
|
|
|
|
public function execute() {
|
|
$this->run();
|
|
}
|
|
|
|
public function executeGenerator( $resultPageSet ) {
|
|
$this->run( $resultPageSet );
|
|
}
|
|
|
|
/**
|
|
* @param ApiPageSet|null $resultPageSet
|
|
* @return void
|
|
*/
|
|
abstract protected function run( ApiPageSet $resultPageSet = null );
|
|
|
|
/**
|
|
* Parse the parameters into the various instance fields.
|
|
*
|
|
* @param array $params
|
|
*/
|
|
protected function parseParameters( $params ) {
|
|
$prop = array_flip( $params['prop'] );
|
|
|
|
$this->fld_ids = isset( $prop['ids'] );
|
|
$this->fld_flags = isset( $prop['flags'] );
|
|
$this->fld_timestamp = isset( $prop['timestamp'] );
|
|
$this->fld_comment = isset( $prop['comment'] );
|
|
$this->fld_parsedcomment = isset( $prop['parsedcomment'] );
|
|
$this->fld_size = isset( $prop['size'] );
|
|
$this->fld_slotsize = isset( $prop['slotsize'] );
|
|
$this->fld_sha1 = isset( $prop['sha1'] );
|
|
$this->fld_slotsha1 = isset( $prop['slotsha1'] );
|
|
$this->fld_content = isset( $prop['content'] );
|
|
$this->fld_contentmodel = isset( $prop['contentmodel'] );
|
|
$this->fld_userid = isset( $prop['userid'] );
|
|
$this->fld_user = isset( $prop['user'] );
|
|
$this->fld_tags = isset( $prop['tags'] );
|
|
$this->fld_roles = isset( $prop['roles'] );
|
|
$this->fld_parsetree = isset( $prop['parsetree'] );
|
|
|
|
$this->slotRoles = $params['slots'];
|
|
|
|
if ( $this->slotRoles !== null ) {
|
|
if ( $this->fld_parsetree ) {
|
|
$this->dieWithError( [
|
|
'apierror-invalidparammix-cannotusewith',
|
|
$this->encodeParamName( 'prop=parsetree' ),
|
|
$this->encodeParamName( 'slots' ),
|
|
], 'invalidparammix' );
|
|
}
|
|
foreach ( [
|
|
'expandtemplates', 'generatexml', 'parse', 'diffto', 'difftotext', 'difftotextpst',
|
|
'contentformat'
|
|
] as $p ) {
|
|
if ( $params[$p] !== null && $params[$p] !== false ) {
|
|
$this->dieWithError( [
|
|
'apierror-invalidparammix-cannotusewith',
|
|
$this->encodeParamName( $p ),
|
|
$this->encodeParamName( 'slots' ),
|
|
], 'invalidparammix' );
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( !empty( $params['contentformat'] ) ) {
|
|
$this->contentFormat = $params['contentformat'];
|
|
}
|
|
|
|
$this->limit = $params['limit'];
|
|
|
|
if ( !is_null( $params['difftotext'] ) ) {
|
|
$this->difftotext = $params['difftotext'];
|
|
$this->difftotextpst = $params['difftotextpst'];
|
|
} elseif ( !is_null( $params['diffto'] ) ) {
|
|
if ( $params['diffto'] == 'cur' ) {
|
|
$params['diffto'] = 0;
|
|
}
|
|
if ( ( !ctype_digit( $params['diffto'] ) || $params['diffto'] < 0 )
|
|
&& $params['diffto'] != 'prev' && $params['diffto'] != 'next'
|
|
) {
|
|
$p = $this->getModulePrefix();
|
|
$this->dieWithError( [ 'apierror-baddiffto', $p ], 'diffto' );
|
|
}
|
|
// Check whether the revision exists and is readable,
|
|
// DifferenceEngine returns a rather ambiguous empty
|
|
// string if that's not the case
|
|
if ( $params['diffto'] != 0 ) {
|
|
$difftoRev = MediaWikiServices::getInstance()->getRevisionStore()
|
|
->getRevisionById( $params['diffto'] );
|
|
if ( !$difftoRev ) {
|
|
$this->dieWithError( [ 'apierror-nosuchrevid', $params['diffto'] ] );
|
|
}
|
|
$revDel = $this->checkRevDel( $difftoRev, RevisionRecord::DELETED_TEXT );
|
|
if ( $revDel & self::CANNOT_VIEW ) {
|
|
$this->addWarning( [ 'apiwarn-difftohidden', $difftoRev->getId() ] );
|
|
$params['diffto'] = null;
|
|
}
|
|
}
|
|
$this->diffto = $params['diffto'];
|
|
}
|
|
|
|
$this->fetchContent = $this->fld_content || !is_null( $this->diffto )
|
|
|| !is_null( $this->difftotext ) || $this->fld_parsetree;
|
|
|
|
$smallLimit = false;
|
|
if ( $this->fetchContent ) {
|
|
$smallLimit = true;
|
|
$this->expandTemplates = $params['expandtemplates'];
|
|
$this->generateXML = $params['generatexml'];
|
|
$this->parseContent = $params['parse'];
|
|
if ( $this->parseContent ) {
|
|
// Must manually initialize unset limit
|
|
if ( is_null( $this->limit ) ) {
|
|
$this->limit = 1;
|
|
}
|
|
}
|
|
if ( isset( $params['section'] ) ) {
|
|
$this->section = $params['section'];
|
|
} else {
|
|
$this->section = false;
|
|
}
|
|
}
|
|
|
|
$userMax = $this->parseContent ? 1 : ( $smallLimit ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1 );
|
|
$botMax = $this->parseContent ? 1 : ( $smallLimit ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2 );
|
|
if ( $this->limit == 'max' ) {
|
|
$this->limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
|
|
if ( $this->setParsedLimit ) {
|
|
$this->getResult()->addParsedLimit( $this->getModuleName(), $this->limit );
|
|
}
|
|
}
|
|
|
|
if ( is_null( $this->limit ) ) {
|
|
$this->limit = 10;
|
|
}
|
|
$this->validateLimit( 'limit', $this->limit, 1, $userMax, $botMax );
|
|
|
|
$this->needSlots = $this->fetchContent || $this->fld_contentmodel ||
|
|
$this->fld_slotsize || $this->fld_slotsha1;
|
|
if ( $this->needSlots && $this->slotRoles === null ) {
|
|
$encParam = $this->encodeParamName( 'slots' );
|
|
$name = $this->getModuleName();
|
|
$parent = $this->getParent();
|
|
$parentParam = $parent->encodeParamName( $parent->getModuleManager()->getModuleGroup( $name ) );
|
|
$this->addDeprecation(
|
|
[ 'apiwarn-deprecation-missingparam', $encParam ],
|
|
"action=query&{$parentParam}={$name}&!{$encParam}"
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Test revision deletion status
|
|
* @param RevisionRecord $revision Revision to check
|
|
* @param int $field One of the RevisionRecord::DELETED_* constants
|
|
* @return int Revision deletion status flags. Bitwise OR of
|
|
* self::IS_DELETED and self::CANNOT_VIEW, as appropriate.
|
|
*/
|
|
private function checkRevDel( RevisionRecord $revision, $field ) {
|
|
$ret = $revision->isDeleted( $field ) ? self::IS_DELETED : 0;
|
|
if ( $ret ) {
|
|
$canSee = $revision->audienceCan( $field, RevisionRecord::FOR_THIS_USER, $this->getUser() );
|
|
$ret = $ret | ( $canSee ? 0 : self::CANNOT_VIEW );
|
|
}
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Extract information from the RevisionRecord
|
|
*
|
|
* @since 1.32, takes a RevisionRecord instead of a Revision
|
|
* @param RevisionRecord $revision Revision
|
|
* @param object $row Should have a field 'ts_tags' if $this->fld_tags is set
|
|
* @return array
|
|
*/
|
|
protected function extractRevisionInfo( RevisionRecord $revision, $row ) {
|
|
$vals = [];
|
|
$anyHidden = false;
|
|
|
|
if ( $this->fld_ids ) {
|
|
$vals['revid'] = intval( $revision->getId() );
|
|
if ( !is_null( $revision->getParentId() ) ) {
|
|
$vals['parentid'] = intval( $revision->getParentId() );
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_flags ) {
|
|
$vals['minor'] = $revision->isMinor();
|
|
}
|
|
|
|
if ( $this->fld_user || $this->fld_userid ) {
|
|
$revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_USER );
|
|
if ( ( $revDel & self::IS_DELETED ) ) {
|
|
$vals['userhidden'] = true;
|
|
$anyHidden = true;
|
|
}
|
|
if ( !( $revDel & self::CANNOT_VIEW ) ) {
|
|
$u = $revision->getUser( RevisionRecord::RAW );
|
|
if ( $this->fld_user ) {
|
|
$vals['user'] = $u->getName();
|
|
}
|
|
$userid = $u->getId();
|
|
if ( !$userid ) {
|
|
$vals['anon'] = true;
|
|
}
|
|
|
|
if ( $this->fld_userid ) {
|
|
$vals['userid'] = $userid;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_timestamp ) {
|
|
$vals['timestamp'] = wfTimestamp( TS_ISO_8601, $revision->getTimestamp() );
|
|
}
|
|
|
|
if ( $this->fld_size ) {
|
|
try {
|
|
$vals['size'] = intval( $revision->getSize() );
|
|
} catch ( RevisionAccessException $e ) {
|
|
// Back compat: If there's no size, return 0.
|
|
// @todo: Gergő says to mention T198099 as a "todo" here.
|
|
$vals['size'] = 0;
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_sha1 ) {
|
|
$revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_TEXT );
|
|
if ( ( $revDel & self::IS_DELETED ) ) {
|
|
$vals['sha1hidden'] = true;
|
|
$anyHidden = true;
|
|
}
|
|
if ( !( $revDel & self::CANNOT_VIEW ) ) {
|
|
try {
|
|
$vals['sha1'] = Wikimedia\base_convert( $revision->getSha1(), 36, 16, 40 );
|
|
} catch ( RevisionAccessException $e ) {
|
|
// Back compat: If there's no sha1, return emtpy string.
|
|
// @todo: Gergő says to mention T198099 as a "todo" here.
|
|
$vals['sha1'] = '';
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_roles ) {
|
|
$vals['roles'] = $revision->getSlotRoles();
|
|
}
|
|
|
|
if ( $this->needSlots ) {
|
|
$revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_TEXT );
|
|
if ( ( $this->fld_slotsha1 || $this->fetchContent ) && ( $revDel & self::IS_DELETED ) ) {
|
|
$anyHidden = true;
|
|
}
|
|
if ( $this->slotRoles === null ) {
|
|
try {
|
|
$slot = $revision->getSlot( SlotRecord::MAIN, RevisionRecord::RAW );
|
|
} catch ( RevisionAccessException $e ) {
|
|
// Back compat: If there's no slot, there's no content, so set 'textmissing'
|
|
// @todo: Gergő says to mention T198099 as a "todo" here.
|
|
$vals['textmissing'] = true;
|
|
$slot = null;
|
|
}
|
|
|
|
if ( $slot ) {
|
|
$content = null;
|
|
$vals += $this->extractSlotInfo( $slot, $revDel, $content );
|
|
if ( !empty( $vals['nosuchsection'] ) ) {
|
|
$this->dieWithError(
|
|
[
|
|
'apierror-nosuchsection-what',
|
|
wfEscapeWikiText( $this->section ),
|
|
$this->msg( 'revid', $revision->getId() )
|
|
],
|
|
'nosuchsection'
|
|
);
|
|
}
|
|
if ( $content ) {
|
|
$vals += $this->extractDeprecatedContent( $content, $revision );
|
|
}
|
|
}
|
|
} else {
|
|
$roles = array_intersect( $this->slotRoles, $revision->getSlotRoles() );
|
|
$vals['slots'] = [
|
|
ApiResult::META_KVP_MERGE => true,
|
|
];
|
|
foreach ( $roles as $role ) {
|
|
try {
|
|
$slot = $revision->getSlot( $role, RevisionRecord::RAW );
|
|
} catch ( RevisionAccessException $e ) {
|
|
// Don't error out here so the client can still process other slots/revisions.
|
|
// @todo: Gergő says to mention T198099 as a "todo" here.
|
|
$vals['slots'][$role]['missing'] = true;
|
|
continue;
|
|
}
|
|
$content = null;
|
|
$vals['slots'][$role] = $this->extractSlotInfo( $slot, $revDel, $content );
|
|
// @todo Move this into extractSlotInfo() (and remove its $content parameter)
|
|
// when extractDeprecatedContent() is no more.
|
|
if ( $content ) {
|
|
$vals['slots'][$role]['contentmodel'] = $content->getModel();
|
|
$vals['slots'][$role]['contentformat'] = $content->getDefaultFormat();
|
|
ApiResult::setContentValue( $vals['slots'][$role], 'content', $content->serialize() );
|
|
}
|
|
}
|
|
ApiResult::setArrayType( $vals['slots'], 'kvp', 'role' );
|
|
ApiResult::setIndexedTagName( $vals['slots'], 'slot' );
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_comment || $this->fld_parsedcomment ) {
|
|
$revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_COMMENT );
|
|
if ( ( $revDel & self::IS_DELETED ) ) {
|
|
$vals['commenthidden'] = true;
|
|
$anyHidden = true;
|
|
}
|
|
if ( !( $revDel & self::CANNOT_VIEW ) ) {
|
|
$comment = $revision->getComment( RevisionRecord::RAW );
|
|
$comment = $comment ? $comment->text : '';
|
|
|
|
if ( $this->fld_comment ) {
|
|
$vals['comment'] = $comment;
|
|
}
|
|
|
|
if ( $this->fld_parsedcomment ) {
|
|
$vals['parsedcomment'] = Linker::formatComment(
|
|
$comment, Title::newFromLinkTarget( $revision->getPageAsLinkTarget() )
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_tags ) {
|
|
if ( $row->ts_tags ) {
|
|
$tags = explode( ',', $row->ts_tags );
|
|
ApiResult::setIndexedTagName( $tags, 'tag' );
|
|
$vals['tags'] = $tags;
|
|
} else {
|
|
$vals['tags'] = [];
|
|
}
|
|
}
|
|
|
|
if ( $anyHidden && $revision->isDeleted( RevisionRecord::DELETED_RESTRICTED ) ) {
|
|
$vals['suppressed'] = true;
|
|
}
|
|
|
|
return $vals;
|
|
}
|
|
|
|
/**
|
|
* Extract information from the SlotRecord
|
|
*
|
|
* @param SlotRecord $slot
|
|
* @param int $revDel Revdel status flags, from self::checkRevDel()
|
|
* @param Content|null &$content Set to the slot's content, if available
|
|
* and $this->fetchContent is true
|
|
* @return array
|
|
*/
|
|
private function extractSlotInfo( SlotRecord $slot, $revDel, &$content = null ) {
|
|
$vals = [];
|
|
ApiResult::setArrayType( $vals, 'assoc' );
|
|
|
|
if ( $this->fld_slotsize ) {
|
|
$vals['size'] = intval( $slot->getSize() );
|
|
}
|
|
|
|
if ( $this->fld_slotsha1 ) {
|
|
if ( ( $revDel & self::IS_DELETED ) ) {
|
|
$vals['sha1hidden'] = true;
|
|
}
|
|
if ( !( $revDel & self::CANNOT_VIEW ) ) {
|
|
if ( $slot->getSha1() != '' ) {
|
|
$vals['sha1'] = Wikimedia\base_convert( $slot->getSha1(), 36, 16, 40 );
|
|
} else {
|
|
$vals['sha1'] = '';
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_contentmodel ) {
|
|
$vals['contentmodel'] = $slot->getModel();
|
|
}
|
|
|
|
$content = null;
|
|
if ( $this->fetchContent ) {
|
|
if ( ( $revDel & self::IS_DELETED ) ) {
|
|
$vals['texthidden'] = true;
|
|
}
|
|
if ( !( $revDel & self::CANNOT_VIEW ) ) {
|
|
try {
|
|
$content = $slot->getContent();
|
|
} catch ( RevisionAccessException $e ) {
|
|
// @todo: Gergő says to mention T198099 as a "todo" here.
|
|
$vals['textmissing'] = true;
|
|
}
|
|
// Expand templates after getting section content because
|
|
// template-added sections don't count and Parser::preprocess()
|
|
// will have less input
|
|
if ( $content && $this->section !== false ) {
|
|
$content = $content->getSection( $this->section, false );
|
|
if ( !$content ) {
|
|
$vals['nosuchsection'] = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $vals;
|
|
}
|
|
|
|
/**
|
|
* Format a Content using deprecated options
|
|
* @param Content $content Content to format
|
|
* @param RevisionRecord $revision Revision being processed
|
|
* @return array
|
|
*/
|
|
private function extractDeprecatedContent( Content $content, RevisionRecord $revision ) {
|
|
global $wgParser;
|
|
|
|
$vals = [];
|
|
$title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
|
|
|
|
if ( $this->fld_parsetree || ( $this->fld_content && $this->generateXML ) ) {
|
|
if ( $content->getModel() === CONTENT_MODEL_WIKITEXT ) {
|
|
$t = $content->getNativeData(); # note: don't set $text
|
|
|
|
$wgParser->startExternalParse(
|
|
$title,
|
|
ParserOptions::newFromContext( $this->getContext() ),
|
|
Parser::OT_PREPROCESS
|
|
);
|
|
$dom = $wgParser->preprocessToDom( $t );
|
|
if ( is_callable( [ $dom, 'saveXML' ] ) ) {
|
|
$xml = $dom->saveXML();
|
|
} else {
|
|
$xml = $dom->__toString();
|
|
}
|
|
$vals['parsetree'] = $xml;
|
|
} else {
|
|
$vals['badcontentformatforparsetree'] = true;
|
|
$this->addWarning(
|
|
[
|
|
'apierror-parsetree-notwikitext-title',
|
|
wfEscapeWikiText( $title->getPrefixedText() ),
|
|
$content->getModel()
|
|
],
|
|
'parsetree-notwikitext'
|
|
);
|
|
}
|
|
}
|
|
|
|
if ( $this->fld_content ) {
|
|
$text = null;
|
|
|
|
if ( $this->expandTemplates && !$this->parseContent ) {
|
|
if ( $content->getModel() === CONTENT_MODEL_WIKITEXT ) {
|
|
$text = $content->getNativeData();
|
|
|
|
$text = $wgParser->preprocess(
|
|
$text,
|
|
$title,
|
|
ParserOptions::newFromContext( $this->getContext() )
|
|
);
|
|
} else {
|
|
$this->addWarning( [
|
|
'apierror-templateexpansion-notwikitext',
|
|
wfEscapeWikiText( $title->getPrefixedText() ),
|
|
$content->getModel()
|
|
] );
|
|
$vals['badcontentformat'] = true;
|
|
$text = false;
|
|
}
|
|
}
|
|
if ( $this->parseContent ) {
|
|
$po = $content->getParserOutput(
|
|
$title,
|
|
$revision->getId(),
|
|
ParserOptions::newFromContext( $this->getContext() )
|
|
);
|
|
$text = $po->getText();
|
|
}
|
|
|
|
if ( $text === null ) {
|
|
$format = $this->contentFormat ?: $content->getDefaultFormat();
|
|
$model = $content->getModel();
|
|
|
|
if ( !$content->isSupportedFormat( $format ) ) {
|
|
$name = wfEscapeWikiText( $title->getPrefixedText() );
|
|
$this->addWarning( [ 'apierror-badformat', $this->contentFormat, $model, $name ] );
|
|
$vals['badcontentformat'] = true;
|
|
$text = false;
|
|
} else {
|
|
$text = $content->serialize( $format );
|
|
// always include format and model.
|
|
// Format is needed to deserialize, model is needed to interpret.
|
|
$vals['contentformat'] = $format;
|
|
$vals['contentmodel'] = $model;
|
|
}
|
|
}
|
|
|
|
if ( $text !== false ) {
|
|
ApiResult::setContentValue( $vals, 'content', $text );
|
|
}
|
|
}
|
|
|
|
if ( $content && ( !is_null( $this->diffto ) || !is_null( $this->difftotext ) ) ) {
|
|
static $n = 0; // Number of uncached diffs we've had
|
|
|
|
if ( $n < $this->getConfig()->get( 'APIMaxUncachedDiffs' ) ) {
|
|
$vals['diff'] = [];
|
|
$context = new DerivativeContext( $this->getContext() );
|
|
$context->setTitle( $title );
|
|
$handler = $content->getContentHandler();
|
|
|
|
if ( !is_null( $this->difftotext ) ) {
|
|
$model = $title->getContentModel();
|
|
|
|
if ( $this->contentFormat
|
|
&& !ContentHandler::getForModelID( $model )->isSupportedFormat( $this->contentFormat )
|
|
) {
|
|
$name = wfEscapeWikiText( $title->getPrefixedText() );
|
|
$this->addWarning( [ 'apierror-badformat', $this->contentFormat, $model, $name ] );
|
|
$vals['diff']['badcontentformat'] = true;
|
|
$engine = null;
|
|
} else {
|
|
$difftocontent = ContentHandler::makeContent(
|
|
$this->difftotext,
|
|
$title,
|
|
$model,
|
|
$this->contentFormat
|
|
);
|
|
|
|
if ( $this->difftotextpst ) {
|
|
$popts = ParserOptions::newFromContext( $this->getContext() );
|
|
$difftocontent = $difftocontent->preSaveTransform( $title, $this->getUser(), $popts );
|
|
}
|
|
|
|
$engine = $handler->createDifferenceEngine( $context );
|
|
$engine->setContent( $content, $difftocontent );
|
|
}
|
|
} else {
|
|
$engine = $handler->createDifferenceEngine( $context, $revision->getId(), $this->diffto );
|
|
$vals['diff']['from'] = $engine->getOldid();
|
|
$vals['diff']['to'] = $engine->getNewid();
|
|
}
|
|
if ( $engine ) {
|
|
$difftext = $engine->getDiffBody();
|
|
ApiResult::setContentValue( $vals['diff'], 'body', $difftext );
|
|
if ( !$engine->wasCacheHit() ) {
|
|
$n++;
|
|
}
|
|
}
|
|
} else {
|
|
$vals['diff']['notcached'] = true;
|
|
}
|
|
}
|
|
|
|
return $vals;
|
|
}
|
|
|
|
public function getCacheMode( $params ) {
|
|
if ( $this->userCanSeeRevDel() ) {
|
|
return 'private';
|
|
}
|
|
|
|
return 'public';
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
$slotRoles = MediaWikiServices::getInstance()->getSlotRoleStore()->getMap();
|
|
if ( !in_array( SlotRecord::MAIN, $slotRoles, true ) ) {
|
|
$slotRoles[] = SlotRecord::MAIN;
|
|
}
|
|
sort( $slotRoles, SORT_STRING );
|
|
|
|
return [
|
|
'prop' => [
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
ApiBase::PARAM_DFLT => 'ids|timestamp|flags|comment|user',
|
|
ApiBase::PARAM_TYPE => [
|
|
'ids',
|
|
'flags',
|
|
'timestamp',
|
|
'user',
|
|
'userid',
|
|
'size',
|
|
'slotsize',
|
|
'sha1',
|
|
'slotsha1',
|
|
'contentmodel',
|
|
'comment',
|
|
'parsedcomment',
|
|
'content',
|
|
'tags',
|
|
'roles',
|
|
'parsetree',
|
|
],
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-prop',
|
|
ApiBase::PARAM_HELP_MSG_PER_VALUE => [
|
|
'ids' => 'apihelp-query+revisions+base-paramvalue-prop-ids',
|
|
'flags' => 'apihelp-query+revisions+base-paramvalue-prop-flags',
|
|
'timestamp' => 'apihelp-query+revisions+base-paramvalue-prop-timestamp',
|
|
'user' => 'apihelp-query+revisions+base-paramvalue-prop-user',
|
|
'userid' => 'apihelp-query+revisions+base-paramvalue-prop-userid',
|
|
'size' => 'apihelp-query+revisions+base-paramvalue-prop-size',
|
|
'slotsize' => 'apihelp-query+revisions+base-paramvalue-prop-slotsize',
|
|
'sha1' => 'apihelp-query+revisions+base-paramvalue-prop-sha1',
|
|
'slotsha1' => 'apihelp-query+revisions+base-paramvalue-prop-slotsha1',
|
|
'contentmodel' => 'apihelp-query+revisions+base-paramvalue-prop-contentmodel',
|
|
'comment' => 'apihelp-query+revisions+base-paramvalue-prop-comment',
|
|
'parsedcomment' => 'apihelp-query+revisions+base-paramvalue-prop-parsedcomment',
|
|
'content' => 'apihelp-query+revisions+base-paramvalue-prop-content',
|
|
'tags' => 'apihelp-query+revisions+base-paramvalue-prop-tags',
|
|
'roles' => 'apihelp-query+revisions+base-paramvalue-prop-roles',
|
|
'parsetree' => [ 'apihelp-query+revisions+base-paramvalue-prop-parsetree',
|
|
CONTENT_MODEL_WIKITEXT ],
|
|
],
|
|
ApiBase::PARAM_DEPRECATED_VALUES => [
|
|
'parsetree' => true,
|
|
],
|
|
],
|
|
'slots' => [
|
|
ApiBase::PARAM_TYPE => $slotRoles,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-slots',
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
ApiBase::PARAM_ALL => true,
|
|
],
|
|
'limit' => [
|
|
ApiBase::PARAM_TYPE => 'limit',
|
|
ApiBase::PARAM_MIN => 1,
|
|
ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
|
|
ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-limit',
|
|
],
|
|
'expandtemplates' => [
|
|
ApiBase::PARAM_DFLT => false,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-expandtemplates',
|
|
ApiBase::PARAM_DEPRECATED => true,
|
|
],
|
|
'generatexml' => [
|
|
ApiBase::PARAM_DFLT => false,
|
|
ApiBase::PARAM_DEPRECATED => true,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-generatexml',
|
|
],
|
|
'parse' => [
|
|
ApiBase::PARAM_DFLT => false,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-parse',
|
|
ApiBase::PARAM_DEPRECATED => true,
|
|
],
|
|
'section' => [
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-section',
|
|
],
|
|
'diffto' => [
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-diffto',
|
|
ApiBase::PARAM_DEPRECATED => true,
|
|
],
|
|
'difftotext' => [
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-difftotext',
|
|
ApiBase::PARAM_DEPRECATED => true,
|
|
],
|
|
'difftotextpst' => [
|
|
ApiBase::PARAM_DFLT => false,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-difftotextpst',
|
|
ApiBase::PARAM_DEPRECATED => true,
|
|
],
|
|
'contentformat' => [
|
|
ApiBase::PARAM_TYPE => ContentHandler::getAllContentFormats(),
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-contentformat',
|
|
ApiBase::PARAM_DEPRECATED => true,
|
|
],
|
|
];
|
|
}
|
|
|
|
}
|