MediaWiki REL1_34
ApiQueryRevisionsBase.php
Go to the documentation of this file.
1<?php
28
35
41 // Bits to indicate the results of the revdel permission check on a revision,
42 // see self::checkRevDel()
43 const IS_DELETED = 1; // Whether the field is revision-deleted
44 const CANNOT_VIEW = 2; // Whether the user cannot view the field due to revdel
45
51
52 protected $fld_ids = false, $fld_flags = false, $fld_timestamp = false,
53 $fld_size = false, $fld_slotsize = false, $fld_sha1 = false, $fld_slotsha1 = false,
54 $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
55 $fld_content = false, $fld_tags = false, $fld_contentmodel = false, $fld_roles = false,
57
58 public function execute() {
59 $this->run();
60 }
61
62 public function executeGenerator( $resultPageSet ) {
63 $this->run( $resultPageSet );
64 }
65
70 abstract protected function run( ApiPageSet $resultPageSet = null );
71
77 protected function parseParameters( $params ) {
78 $prop = array_flip( $params['prop'] );
79
80 $this->fld_ids = isset( $prop['ids'] );
81 $this->fld_flags = isset( $prop['flags'] );
82 $this->fld_timestamp = isset( $prop['timestamp'] );
83 $this->fld_comment = isset( $prop['comment'] );
84 $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
85 $this->fld_size = isset( $prop['size'] );
86 $this->fld_slotsize = isset( $prop['slotsize'] );
87 $this->fld_sha1 = isset( $prop['sha1'] );
88 $this->fld_slotsha1 = isset( $prop['slotsha1'] );
89 $this->fld_content = isset( $prop['content'] );
90 $this->fld_contentmodel = isset( $prop['contentmodel'] );
91 $this->fld_userid = isset( $prop['userid'] );
92 $this->fld_user = isset( $prop['user'] );
93 $this->fld_tags = isset( $prop['tags'] );
94 $this->fld_roles = isset( $prop['roles'] );
95 $this->fld_parsetree = isset( $prop['parsetree'] );
96
97 $this->slotRoles = $params['slots'];
98
99 if ( $this->slotRoles !== null ) {
100 if ( $this->fld_parsetree ) {
101 $this->dieWithError( [
102 'apierror-invalidparammix-cannotusewith',
103 $this->encodeParamName( 'prop=parsetree' ),
104 $this->encodeParamName( 'slots' ),
105 ], 'invalidparammix' );
106 }
107 foreach ( [
108 'expandtemplates', 'generatexml', 'parse', 'diffto', 'difftotext', 'difftotextpst',
109 'contentformat'
110 ] as $p ) {
111 if ( $params[$p] !== null && $params[$p] !== false ) {
112 $this->dieWithError( [
113 'apierror-invalidparammix-cannotusewith',
114 $this->encodeParamName( $p ),
115 $this->encodeParamName( 'slots' ),
116 ], 'invalidparammix' );
117 }
118 }
119 }
120
121 if ( !empty( $params['contentformat'] ) ) {
122 $this->contentFormat = $params['contentformat'];
123 }
124
125 $this->limit = $params['limit'];
126
127 if ( !is_null( $params['difftotext'] ) ) {
128 $this->difftotext = $params['difftotext'];
129 $this->difftotextpst = $params['difftotextpst'];
130 } elseif ( !is_null( $params['diffto'] ) ) {
131 if ( $params['diffto'] == 'cur' ) {
132 $params['diffto'] = 0;
133 }
134 if ( ( !ctype_digit( $params['diffto'] ) || $params['diffto'] < 0 )
135 && $params['diffto'] != 'prev' && $params['diffto'] != 'next'
136 ) {
137 $p = $this->getModulePrefix();
138 $this->dieWithError( [ 'apierror-baddiffto', $p ], 'diffto' );
139 }
140 // Check whether the revision exists and is readable,
141 // DifferenceEngine returns a rather ambiguous empty
142 // string if that's not the case
143 if ( $params['diffto'] != 0 ) {
144 $difftoRev = MediaWikiServices::getInstance()->getRevisionStore()
145 ->getRevisionById( $params['diffto'] );
146 if ( !$difftoRev ) {
147 $this->dieWithError( [ 'apierror-nosuchrevid', $params['diffto'] ] );
148 }
149 $revDel = $this->checkRevDel( $difftoRev, RevisionRecord::DELETED_TEXT );
150 if ( $revDel & self::CANNOT_VIEW ) {
151 $this->addWarning( [ 'apiwarn-difftohidden', $difftoRev->getId() ] );
152 $params['diffto'] = null;
153 }
154 }
155 $this->diffto = $params['diffto'];
156 }
157
158 $this->fetchContent = $this->fld_content || !is_null( $this->diffto )
159 || !is_null( $this->difftotext ) || $this->fld_parsetree;
160
161 $smallLimit = false;
162 if ( $this->fetchContent ) {
163 $smallLimit = true;
164 $this->expandTemplates = $params['expandtemplates'];
165 $this->generateXML = $params['generatexml'];
166 $this->parseContent = $params['parse'];
167 if ( $this->parseContent ) {
168 // Must manually initialize unset limit
169 if ( is_null( $this->limit ) ) {
170 $this->limit = 1;
171 }
172 }
173 $this->section = $params['section'] ?? false;
174 }
175
176 $userMax = $this->parseContent ? 1 : ( $smallLimit ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1 );
177 $botMax = $this->parseContent ? 1 : ( $smallLimit ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2 );
178 if ( $this->limit == 'max' ) {
179 $this->limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
180 if ( $this->setParsedLimit ) {
181 $this->getResult()->addParsedLimit( $this->getModuleName(), $this->limit );
182 }
183 }
184
185 if ( is_null( $this->limit ) ) {
186 $this->limit = 10;
187 }
188 $this->validateLimit( 'limit', $this->limit, 1, $userMax, $botMax );
189
190 $this->needSlots = $this->fetchContent || $this->fld_contentmodel ||
191 $this->fld_slotsize || $this->fld_slotsha1;
192 if ( $this->needSlots && $this->slotRoles === null ) {
193 $encParam = $this->encodeParamName( 'slots' );
194 $name = $this->getModuleName();
195 $parent = $this->getParent();
196 $parentParam = $parent->encodeParamName( $parent->getModuleManager()->getModuleGroup( $name ) );
197 $this->addDeprecation(
198 [ 'apiwarn-deprecation-missingparam', $encParam ],
199 "action=query&{$parentParam}={$name}&!{$encParam}"
200 );
201 }
202 }
203
211 private function checkRevDel( RevisionRecord $revision, $field ) {
212 $ret = $revision->isDeleted( $field ) ? self::IS_DELETED : 0;
213 if ( $ret ) {
214 $canSee = $revision->audienceCan( $field, RevisionRecord::FOR_THIS_USER, $this->getUser() );
215 $ret = $ret | ( $canSee ? 0 : self::CANNOT_VIEW );
216 }
217 return $ret;
218 }
219
228 protected function extractRevisionInfo( RevisionRecord $revision, $row ) {
229 $vals = [];
230 $anyHidden = false;
231
232 if ( $this->fld_ids ) {
233 $vals['revid'] = (int)$revision->getId();
234 if ( !is_null( $revision->getParentId() ) ) {
235 $vals['parentid'] = (int)$revision->getParentId();
236 }
237 }
238
239 if ( $this->fld_flags ) {
240 $vals['minor'] = $revision->isMinor();
241 }
242
243 if ( $this->fld_user || $this->fld_userid ) {
244 $revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_USER );
245 if ( ( $revDel & self::IS_DELETED ) ) {
246 $vals['userhidden'] = true;
247 $anyHidden = true;
248 }
249 if ( !( $revDel & self::CANNOT_VIEW ) ) {
250 $u = $revision->getUser( RevisionRecord::RAW );
251 if ( $this->fld_user ) {
252 $vals['user'] = $u->getName();
253 }
254 $userid = $u->getId();
255 if ( !$userid ) {
256 $vals['anon'] = true;
257 }
258
259 if ( $this->fld_userid ) {
260 $vals['userid'] = $userid;
261 }
262 }
263 }
264
265 if ( $this->fld_timestamp ) {
266 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $revision->getTimestamp() );
267 }
268
269 if ( $this->fld_size ) {
270 try {
271 $vals['size'] = (int)$revision->getSize();
272 } catch ( RevisionAccessException $e ) {
273 // Back compat: If there's no size, return 0.
274 // @todo: Gergő says to mention T198099 as a "todo" here.
275 $vals['size'] = 0;
276 }
277 }
278
279 if ( $this->fld_sha1 ) {
280 $revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_TEXT );
281 if ( ( $revDel & self::IS_DELETED ) ) {
282 $vals['sha1hidden'] = true;
283 $anyHidden = true;
284 }
285 if ( !( $revDel & self::CANNOT_VIEW ) ) {
286 try {
287 $vals['sha1'] = Wikimedia\base_convert( $revision->getSha1(), 36, 16, 40 );
288 } catch ( RevisionAccessException $e ) {
289 // Back compat: If there's no sha1, return emtpy string.
290 // @todo: Gergő says to mention T198099 as a "todo" here.
291 $vals['sha1'] = '';
292 }
293 }
294 }
295
296 try {
297 if ( $this->fld_roles ) {
298 $vals['roles'] = $revision->getSlotRoles();
299 }
300
301 if ( $this->needSlots ) {
302 $revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_TEXT );
303 if ( ( $this->fld_slotsha1 || $this->fetchContent ) && ( $revDel & self::IS_DELETED ) ) {
304 $anyHidden = true;
305 }
306 $vals = array_merge( $vals, $this->extractAllSlotInfo( $revision, $revDel ) );
307 }
308 } catch ( RevisionAccessException $ex ) {
309 // This is here so T212428 doesn't spam the log.
310 // TODO: find out why T212428 happens in the first place!
311 $vals['slotsmissing'] = true;
312
313 LoggerFactory::getInstance( 'api-warning' )->error(
314 'Failed to access revision slots',
315 [ 'revision' => $revision->getId(), 'exception' => $ex, ]
316 );
317 }
318
319 if ( $this->fld_comment || $this->fld_parsedcomment ) {
320 $revDel = $this->checkRevDel( $revision, RevisionRecord::DELETED_COMMENT );
321 if ( ( $revDel & self::IS_DELETED ) ) {
322 $vals['commenthidden'] = true;
323 $anyHidden = true;
324 }
325 if ( !( $revDel & self::CANNOT_VIEW ) ) {
326 $comment = $revision->getComment( RevisionRecord::RAW );
327 $comment = $comment ? $comment->text : '';
328
329 if ( $this->fld_comment ) {
330 $vals['comment'] = $comment;
331 }
332
333 if ( $this->fld_parsedcomment ) {
334 $vals['parsedcomment'] = Linker::formatComment(
335 $comment, Title::newFromLinkTarget( $revision->getPageAsLinkTarget() )
336 );
337 }
338 }
339 }
340
341 if ( $this->fld_tags ) {
342 if ( $row->ts_tags ) {
343 $tags = explode( ',', $row->ts_tags );
344 ApiResult::setIndexedTagName( $tags, 'tag' );
345 $vals['tags'] = $tags;
346 } else {
347 $vals['tags'] = [];
348 }
349 }
350
351 if ( $anyHidden && $revision->isDeleted( RevisionRecord::DELETED_RESTRICTED ) ) {
352 $vals['suppressed'] = true;
353 }
354
355 return $vals;
356 }
357
367 private function extractAllSlotInfo( RevisionRecord $revision, $revDel ): array {
368 $vals = [];
369
370 if ( $this->slotRoles === null ) {
371 try {
372 $slot = $revision->getSlot( SlotRecord::MAIN, RevisionRecord::RAW );
373 } catch ( RevisionAccessException $e ) {
374 // Back compat: If there's no slot, there's no content, so set 'textmissing'
375 // @todo: Gergő says to mention T198099 as a "todo" here.
376 $vals['textmissing'] = true;
377 $slot = null;
378 }
379
380 if ( $slot ) {
381 $content = null;
382 $vals += $this->extractSlotInfo( $slot, $revDel, $content );
383 if ( !empty( $vals['nosuchsection'] ) ) {
384 $this->dieWithError(
385 [
386 'apierror-nosuchsection-what',
387 wfEscapeWikiText( $this->section ),
388 $this->msg( 'revid', $revision->getId() )
389 ],
390 'nosuchsection'
391 );
392 }
393 if ( $content ) {
394 $vals += $this->extractDeprecatedContent( $content, $revision );
395 }
396 }
397 } else {
398 $roles = array_intersect( $this->slotRoles, $revision->getSlotRoles() );
399 $vals['slots'] = [
400 ApiResult::META_KVP_MERGE => true,
401 ];
402 foreach ( $roles as $role ) {
403 try {
404 $slot = $revision->getSlot( $role, RevisionRecord::RAW );
405 } catch ( RevisionAccessException $e ) {
406 // Don't error out here so the client can still process other slots/revisions.
407 // @todo: Gergő says to mention T198099 as a "todo" here.
408 $vals['slots'][$role]['missing'] = true;
409 continue;
410 }
411 $content = null;
412 $vals['slots'][$role] = $this->extractSlotInfo( $slot, $revDel, $content );
413 // @todo Move this into extractSlotInfo() (and remove its $content parameter)
414 // when extractDeprecatedContent() is no more.
415 if ( $content ) {
416 $vals['slots'][$role]['contentmodel'] = $content->getModel();
417 $vals['slots'][$role]['contentformat'] = $content->getDefaultFormat();
419 $vals['slots'][$role],
420 'content',
421 $content->serialize()
422 );
423 }
424 }
425 ApiResult::setArrayType( $vals['slots'], 'kvp', 'role' );
426 ApiResult::setIndexedTagName( $vals['slots'], 'slot' );
427 }
428 return $vals;
429 }
430
440 private function extractSlotInfo( SlotRecord $slot, $revDel, &$content = null ) {
441 $vals = [];
442 ApiResult::setArrayType( $vals, 'assoc' );
443
444 if ( $this->fld_slotsize ) {
445 $vals['size'] = (int)$slot->getSize();
446 }
447
448 if ( $this->fld_slotsha1 ) {
449 if ( ( $revDel & self::IS_DELETED ) ) {
450 $vals['sha1hidden'] = true;
451 }
452 if ( !( $revDel & self::CANNOT_VIEW ) ) {
453 if ( $slot->getSha1() != '' ) {
454 $vals['sha1'] = Wikimedia\base_convert( $slot->getSha1(), 36, 16, 40 );
455 } else {
456 $vals['sha1'] = '';
457 }
458 }
459 }
460
461 if ( $this->fld_contentmodel ) {
462 $vals['contentmodel'] = $slot->getModel();
463 }
464
465 $content = null;
466 if ( $this->fetchContent ) {
467 if ( ( $revDel & self::IS_DELETED ) ) {
468 $vals['texthidden'] = true;
469 }
470 if ( !( $revDel & self::CANNOT_VIEW ) ) {
471 try {
472 $content = $slot->getContent();
473 } catch ( RevisionAccessException $e ) {
474 // @todo: Gergő says to mention T198099 as a "todo" here.
475 $vals['textmissing'] = true;
476 }
477 // Expand templates after getting section content because
478 // template-added sections don't count and Parser::preprocess()
479 // will have less input
480 if ( $content && $this->section !== false ) {
481 $content = $content->getSection( $this->section, false );
482 if ( !$content ) {
483 $vals['nosuchsection'] = true;
484 }
485 }
486 }
487 }
488
489 return $vals;
490 }
491
499 $vals = [];
500 $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
501
502 if ( $this->fld_parsetree || ( $this->fld_content && $this->generateXML ) ) {
503 if ( $content->getModel() === CONTENT_MODEL_WIKITEXT ) {
505 '@phan-var WikitextContent $content';
506 $t = $content->getText(); # note: don't set $text
507
508 $parser = MediaWikiServices::getInstance()->getParser();
509 $parser->startExternalParse(
510 $title,
511 ParserOptions::newFromContext( $this->getContext() ),
512 Parser::OT_PREPROCESS
513 );
514 $dom = $parser->preprocessToDom( $t );
515 // @phan-suppress-next-line PhanUndeclaredMethodInCallable
516 if ( is_callable( [ $dom, 'saveXML' ] ) ) {
517 // @phan-suppress-next-line PhanUndeclaredMethod
518 $xml = $dom->saveXML();
519 } else {
520 // @phan-suppress-next-line PhanUndeclaredMethod
521 $xml = $dom->__toString();
522 }
523 $vals['parsetree'] = $xml;
524 } else {
525 $vals['badcontentformatforparsetree'] = true;
526 $this->addWarning(
527 [
528 'apierror-parsetree-notwikitext-title',
529 wfEscapeWikiText( $title->getPrefixedText() ),
530 $content->getModel()
531 ],
532 'parsetree-notwikitext'
533 );
534 }
535 }
536
537 if ( $this->fld_content ) {
538 $text = null;
539
540 if ( $this->expandTemplates && !$this->parseContent ) {
541 if ( $content->getModel() === CONTENT_MODEL_WIKITEXT ) {
543 '@phan-var WikitextContent $content';
544 $text = $content->getText();
545
546 $text = MediaWikiServices::getInstance()->getParser()->preprocess(
547 $text,
548 $title,
549 ParserOptions::newFromContext( $this->getContext() )
550 );
551 } else {
552 $this->addWarning( [
553 'apierror-templateexpansion-notwikitext',
554 wfEscapeWikiText( $title->getPrefixedText() ),
555 $content->getModel()
556 ] );
557 $vals['badcontentformat'] = true;
558 $text = false;
559 }
560 }
561 if ( $this->parseContent ) {
562 $po = $content->getParserOutput(
563 $title,
564 $revision->getId(),
565 ParserOptions::newFromContext( $this->getContext() )
566 );
567 $text = $po->getText();
568 }
569
570 if ( $text === null ) {
571 $format = $this->contentFormat ?: $content->getDefaultFormat();
572 $model = $content->getModel();
573
574 if ( !$content->isSupportedFormat( $format ) ) {
575 $name = wfEscapeWikiText( $title->getPrefixedText() );
576 $this->addWarning( [ 'apierror-badformat', $this->contentFormat, $model, $name ] );
577 $vals['badcontentformat'] = true;
578 $text = false;
579 } else {
580 $text = $content->serialize( $format );
581 // always include format and model.
582 // Format is needed to deserialize, model is needed to interpret.
583 $vals['contentformat'] = $format;
584 $vals['contentmodel'] = $model;
585 }
586 }
587
588 if ( $text !== false ) {
589 ApiResult::setContentValue( $vals, 'content', $text );
590 }
591 }
592
593 if ( $content && ( !is_null( $this->diffto ) || !is_null( $this->difftotext ) ) ) {
594 static $n = 0; // Number of uncached diffs we've had
595
596 if ( $n < $this->getConfig()->get( 'APIMaxUncachedDiffs' ) ) {
597 $vals['diff'] = [];
598 $context = new DerivativeContext( $this->getContext() );
599 $context->setTitle( $title );
600 $handler = $content->getContentHandler();
601
602 if ( !is_null( $this->difftotext ) ) {
603 $model = $title->getContentModel();
604
605 if ( $this->contentFormat
606 && !ContentHandler::getForModelID( $model )->isSupportedFormat( $this->contentFormat )
607 ) {
608 $name = wfEscapeWikiText( $title->getPrefixedText() );
609 $this->addWarning( [ 'apierror-badformat', $this->contentFormat, $model, $name ] );
610 $vals['diff']['badcontentformat'] = true;
611 $engine = null;
612 } else {
613 $difftocontent = ContentHandler::makeContent(
614 $this->difftotext,
615 $title,
616 $model,
617 $this->contentFormat
618 );
619
620 if ( $this->difftotextpst ) {
621 $popts = ParserOptions::newFromContext( $this->getContext() );
622 $difftocontent = $difftocontent->preSaveTransform( $title, $this->getUser(), $popts );
623 }
624
625 $engine = $handler->createDifferenceEngine( $context );
626 $engine->setContent( $content, $difftocontent );
627 }
628 } else {
629 $engine = $handler->createDifferenceEngine( $context, $revision->getId(), $this->diffto );
630 $vals['diff']['from'] = $engine->getOldid();
631 $vals['diff']['to'] = $engine->getNewid();
632 }
633 if ( $engine ) {
634 $difftext = $engine->getDiffBody();
635 ApiResult::setContentValue( $vals['diff'], 'body', $difftext );
636 if ( !$engine->wasCacheHit() ) {
637 $n++;
638 }
639 }
640 } else {
641 $vals['diff']['notcached'] = true;
642 }
643 }
644
645 return $vals;
646 }
647
648 public function getCacheMode( $params ) {
649 if ( $this->userCanSeeRevDel() ) {
650 return 'private';
651 }
652
653 return 'public';
654 }
655
656 public function getAllowedParams() {
657 $slotRoles = MediaWikiServices::getInstance()->getSlotRoleRegistry()->getKnownRoles();
658 sort( $slotRoles, SORT_STRING );
659
660 return [
661 'prop' => [
663 ApiBase::PARAM_DFLT => 'ids|timestamp|flags|comment|user',
665 'ids',
666 'flags',
667 'timestamp',
668 'user',
669 'userid',
670 'size',
671 'slotsize',
672 'sha1',
673 'slotsha1',
674 'contentmodel',
675 'comment',
676 'parsedcomment',
677 'content',
678 'tags',
679 'roles',
680 'parsetree',
681 ],
682 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-prop',
684 'ids' => 'apihelp-query+revisions+base-paramvalue-prop-ids',
685 'flags' => 'apihelp-query+revisions+base-paramvalue-prop-flags',
686 'timestamp' => 'apihelp-query+revisions+base-paramvalue-prop-timestamp',
687 'user' => 'apihelp-query+revisions+base-paramvalue-prop-user',
688 'userid' => 'apihelp-query+revisions+base-paramvalue-prop-userid',
689 'size' => 'apihelp-query+revisions+base-paramvalue-prop-size',
690 'slotsize' => 'apihelp-query+revisions+base-paramvalue-prop-slotsize',
691 'sha1' => 'apihelp-query+revisions+base-paramvalue-prop-sha1',
692 'slotsha1' => 'apihelp-query+revisions+base-paramvalue-prop-slotsha1',
693 'contentmodel' => 'apihelp-query+revisions+base-paramvalue-prop-contentmodel',
694 'comment' => 'apihelp-query+revisions+base-paramvalue-prop-comment',
695 'parsedcomment' => 'apihelp-query+revisions+base-paramvalue-prop-parsedcomment',
696 'content' => 'apihelp-query+revisions+base-paramvalue-prop-content',
697 'tags' => 'apihelp-query+revisions+base-paramvalue-prop-tags',
698 'roles' => 'apihelp-query+revisions+base-paramvalue-prop-roles',
699 'parsetree' => [ 'apihelp-query+revisions+base-paramvalue-prop-parsetree',
701 ],
703 'parsetree' => true,
704 ],
705 ],
706 'slots' => [
707 ApiBase::PARAM_TYPE => $slotRoles,
708 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-slots',
710 ApiBase::PARAM_ALL => true,
711 ],
712 'limit' => [
713 ApiBase::PARAM_TYPE => 'limit',
717 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-limit',
718 ],
719 'expandtemplates' => [
720 ApiBase::PARAM_DFLT => false,
721 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-expandtemplates',
723 ],
724 'generatexml' => [
725 ApiBase::PARAM_DFLT => false,
727 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-generatexml',
728 ],
729 'parse' => [
730 ApiBase::PARAM_DFLT => false,
731 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-parse',
733 ],
734 'section' => [
735 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-section',
736 ],
737 'diffto' => [
738 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-diffto',
740 ],
741 'difftotext' => [
742 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-difftotext',
744 ],
745 'difftotextpst' => [
746 ApiBase::PARAM_DFLT => false,
747 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-difftotextpst',
749 ],
750 'contentformat' => [
751 ApiBase::PARAM_TYPE => ContentHandler::getAllContentFormats(),
752 ApiBase::PARAM_HELP_MSG => 'apihelp-query+revisions+base-param-contentformat',
754 ],
755 ];
756 }
757
758}
getUser()
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
getContext()
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition ApiBase.php:528
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:103
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:112
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:97
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:2014
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
Definition ApiBase.php:209
getMain()
Get the main module.
Definition ApiBase.php:536
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:94
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:55
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:164
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
Definition ApiBase.php:1947
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:106
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:259
const LIMIT_SML2
Slow query, apihighlimits limit.
Definition ApiBase.php:265
validateLimit( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
Validate the value against the minimum and user/bot maximum limits.
Definition ApiBase.php:1578
getResult()
Get the result object.
Definition ApiBase.php:640
const LIMIT_SML1
Slow query, standard limit.
Definition ApiBase.php:263
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:131
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1933
const PARAM_ALL
(boolean|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true,...
Definition ApiBase.php:187
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:261
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:520
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:58
This class contains a list of pages that the client has requested.
getParent()
Get the parent of this module.1.25 ApiBase|null
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
A base class for functions common to producing a list of revisions.
executeGenerator( $resultPageSet)
Execute this module as a generator.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
extractAllSlotInfo(RevisionRecord $revision, $revDel)
Extracts information about all relevant slots.
parseParameters( $params)
Parse the parameters into the various instance fields.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
extractDeprecatedContent(Content $content, RevisionRecord $revision)
Format a Content using deprecated options.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
extractSlotInfo(SlotRecord $slot, $revDel, &$content=null)
Extract information from the SlotRecord.
run(ApiPageSet $resultPageSet=null)
checkRevDel(RevisionRecord $revision, $field)
Test revision deletion status.
extractRevisionInfo(RevisionRecord $revision, $row)
Extract information from the RevisionRecord.
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
msg( $key,... $params)
Get a Message object with context set Parameters are the same as wfMessage()
An IContextSource implementation which will inherit context from another source but allow individual ...
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition Linker.php:1165
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Exception representing a failure to look up a revision.
Page revision base class.
getParentId()
Get parent revision ID (the original previous page revision).
getSize()
Returns the nominal size of this revision, in bogo-bytes.
getComment( $audience=self::FOR_PUBLIC, User $user=null)
Fetch revision comment, if it's available to the specified audience.
getSlotRoles()
Returns the slot names (roles) of all slots present in this revision.
getTimestamp()
MCR migration note: this replaces Revision::getTimestamp.
audienceCan( $field, $audience, User $user=null)
Check that the given audience has access to the given field.
getSlot( $role, $audience=self::FOR_PUBLIC, User $user=null)
Returns meta-data for the given slot.
getSha1()
Returns the base36 sha1 of this revision.
isMinor()
MCR migration note: this replaces Revision::isMinor.
getPageAsLinkTarget()
Returns the title of the page this revision is associated with as a LinkTarget object.
getUser( $audience=self::FOR_PUBLIC, User $user=null)
Fetch revision's author's user identity, if it's available to the specified audience.
isDeleted( $field)
MCR migration note: this replaces Revision::isDeleted.
Value object representing a content slot associated with a page revision.
getContent()
Returns the Content of the given slot.
getSha1()
Returns the content size.
getSize()
Returns the content size.
getModel()
Returns the content model.
Content object for wiki text pages.
const CONTENT_MODEL_WIKITEXT
Definition Defines.php:224
Base interface for content objects.
Definition Content.php:34
$context
Definition load.php:45
$content
Definition router.php:78