3814112f6a9e1308b15b5a17c7b545e99032bc51
[lhc/web/wiklou.git] / includes / page / WikiPage.php
1 <?php
2 /**
3 * Base representation for a MediaWiki page.
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 use MediaWiki\Edit\PreparedEdit;
24 use MediaWiki\Logger\LoggerFactory;
25 use MediaWiki\MediaWikiServices;
26 use MediaWiki\Revision\RevisionRecord;
27 use MediaWiki\Revision\RevisionRenderer;
28 use MediaWiki\Revision\RevisionStore;
29 use MediaWiki\Revision\SlotRoleRegistry;
30 use MediaWiki\Revision\SlotRecord;
31 use MediaWiki\Storage\DerivedPageDataUpdater;
32 use MediaWiki\Storage\PageUpdater;
33 use MediaWiki\Storage\RevisionSlotsUpdate;
34 use Wikimedia\Assert\Assert;
35 use Wikimedia\Rdbms\FakeResultWrapper;
36 use Wikimedia\Rdbms\IDatabase;
37 use Wikimedia\Rdbms\LoadBalancer;
38
39 /**
40 * Class representing a MediaWiki article and history.
41 *
42 * Some fields are public only for backwards-compatibility. Use accessors.
43 * In the past, this class was part of Article.php and everything was public.
44 */
45 class WikiPage implements Page, IDBAccessObject {
46 // Constants for $mDataLoadedFrom and related
47
48 /**
49 * @var Title
50 */
51 public $mTitle = null;
52
53 /**
54 * @var bool
55 * @protected
56 */
57 public $mDataLoaded = false;
58
59 /**
60 * @var bool
61 * @protected
62 */
63 public $mIsRedirect = false;
64
65 /**
66 * @var int|false False means "not loaded"
67 * @protected
68 */
69 public $mLatest = false;
70
71 /** @var PreparedEdit Map of cache fields (text, parser output, ect) for a proposed/new edit */
72 public $mPreparedEdit = false;
73
74 /**
75 * @var int
76 */
77 protected $mId = null;
78
79 /**
80 * @var int One of the READ_* constants
81 */
82 protected $mDataLoadedFrom = self::READ_NONE;
83
84 /**
85 * @var Title
86 */
87 protected $mRedirectTarget = null;
88
89 /**
90 * @var Revision
91 */
92 protected $mLastRevision = null;
93
94 /**
95 * @var string Timestamp of the current revision or empty string if not loaded
96 */
97 protected $mTimestamp = '';
98
99 /**
100 * @var string
101 */
102 protected $mTouched = '19700101000000';
103
104 /**
105 * @var string
106 */
107 protected $mLinksUpdated = '19700101000000';
108
109 /**
110 * @var DerivedPageDataUpdater|null
111 */
112 private $derivedDataUpdater = null;
113
114 /**
115 * Constructor and clear the article
116 * @param Title $title Reference to a Title object.
117 */
118 public function __construct( Title $title ) {
119 $this->mTitle = $title;
120 }
121
122 /**
123 * Makes sure that the mTitle object is cloned
124 * to the newly cloned WikiPage.
125 */
126 public function __clone() {
127 $this->mTitle = clone $this->mTitle;
128 }
129
130 /**
131 * Create a WikiPage object of the appropriate class for the given title.
132 *
133 * @param Title $title
134 *
135 * @throws MWException
136 * @return WikiPage|WikiCategoryPage|WikiFilePage
137 */
138 public static function factory( Title $title ) {
139 $ns = $title->getNamespace();
140
141 if ( $ns == NS_MEDIA ) {
142 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
143 } elseif ( $ns < 0 ) {
144 throw new MWException( "Invalid or virtual namespace $ns given." );
145 }
146
147 $page = null;
148 if ( !Hooks::run( 'WikiPageFactory', [ $title, &$page ] ) ) {
149 return $page;
150 }
151
152 switch ( $ns ) {
153 case NS_FILE:
154 $page = new WikiFilePage( $title );
155 break;
156 case NS_CATEGORY:
157 $page = new WikiCategoryPage( $title );
158 break;
159 default:
160 $page = new WikiPage( $title );
161 }
162
163 return $page;
164 }
165
166 /**
167 * Constructor from a page id
168 *
169 * @param int $id Article ID to load
170 * @param string|int $from One of the following values:
171 * - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
172 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
173 *
174 * @return WikiPage|null
175 */
176 public static function newFromID( $id, $from = 'fromdb' ) {
177 // page ids are never 0 or negative, see T63166
178 if ( $id < 1 ) {
179 return null;
180 }
181
182 $from = self::convertSelectType( $from );
183 $db = wfGetDB( $from === self::READ_LATEST ? DB_MASTER : DB_REPLICA );
184 $pageQuery = self::getQueryInfo();
185 $row = $db->selectRow(
186 $pageQuery['tables'], $pageQuery['fields'], [ 'page_id' => $id ], __METHOD__,
187 [], $pageQuery['joins']
188 );
189 if ( !$row ) {
190 return null;
191 }
192 return self::newFromRow( $row, $from );
193 }
194
195 /**
196 * Constructor from a database row
197 *
198 * @since 1.20
199 * @param object $row Database row containing at least fields returned by selectFields().
200 * @param string|int $from Source of $data:
201 * - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
202 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
203 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
204 * @return WikiPage
205 */
206 public static function newFromRow( $row, $from = 'fromdb' ) {
207 $page = self::factory( Title::newFromRow( $row ) );
208 $page->loadFromRow( $row, $from );
209 return $page;
210 }
211
212 /**
213 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
214 *
215 * @param object|string|int $type
216 * @return mixed
217 */
218 protected static function convertSelectType( $type ) {
219 switch ( $type ) {
220 case 'fromdb':
221 return self::READ_NORMAL;
222 case 'fromdbmaster':
223 return self::READ_LATEST;
224 case 'forupdate':
225 return self::READ_LOCKING;
226 default:
227 // It may already be an integer or whatever else
228 return $type;
229 }
230 }
231
232 /**
233 * @return RevisionStore
234 */
235 private function getRevisionStore() {
236 return MediaWikiServices::getInstance()->getRevisionStore();
237 }
238
239 /**
240 * @return RevisionRenderer
241 */
242 private function getRevisionRenderer() {
243 return MediaWikiServices::getInstance()->getRevisionRenderer();
244 }
245
246 /**
247 * @return SlotRoleRegistry
248 */
249 private function getSlotRoleRegistry() {
250 return MediaWikiServices::getInstance()->getSlotRoleRegistry();
251 }
252
253 /**
254 * @return ParserCache
255 */
256 private function getParserCache() {
257 return MediaWikiServices::getInstance()->getParserCache();
258 }
259
260 /**
261 * @return LoadBalancer
262 */
263 private function getDBLoadBalancer() {
264 return MediaWikiServices::getInstance()->getDBLoadBalancer();
265 }
266
267 /**
268 * @todo Move this UI stuff somewhere else
269 *
270 * @see ContentHandler::getActionOverrides
271 * @return array
272 */
273 public function getActionOverrides() {
274 return $this->getContentHandler()->getActionOverrides();
275 }
276
277 /**
278 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
279 *
280 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
281 *
282 * @return ContentHandler
283 *
284 * @since 1.21
285 */
286 public function getContentHandler() {
287 return ContentHandler::getForModelID( $this->getContentModel() );
288 }
289
290 /**
291 * Get the title object of the article
292 * @return Title Title object of this page
293 */
294 public function getTitle() {
295 return $this->mTitle;
296 }
297
298 /**
299 * Clear the object
300 * @return void
301 */
302 public function clear() {
303 $this->mDataLoaded = false;
304 $this->mDataLoadedFrom = self::READ_NONE;
305
306 $this->clearCacheFields();
307 }
308
309 /**
310 * Clear the object cache fields
311 * @return void
312 */
313 protected function clearCacheFields() {
314 $this->mId = null;
315 $this->mRedirectTarget = null; // Title object if set
316 $this->mLastRevision = null; // Latest revision
317 $this->mTouched = '19700101000000';
318 $this->mLinksUpdated = '19700101000000';
319 $this->mTimestamp = '';
320 $this->mIsRedirect = false;
321 $this->mLatest = false;
322 // T59026: do not clear $this->derivedDataUpdater since getDerivedDataUpdater() already
323 // checks the requested rev ID and content against the cached one. For most
324 // content types, the output should not change during the lifetime of this cache.
325 // Clearing it can cause extra parses on edit for no reason.
326 }
327
328 /**
329 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
330 * @return void
331 * @since 1.23
332 */
333 public function clearPreparedEdit() {
334 $this->mPreparedEdit = false;
335 }
336
337 /**
338 * Return the list of revision fields that should be selected to create
339 * a new page.
340 *
341 * @deprecated since 1.31, use self::getQueryInfo() instead.
342 * @return array
343 */
344 public static function selectFields() {
345 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
346
347 wfDeprecated( __METHOD__, '1.31' );
348
349 $fields = [
350 'page_id',
351 'page_namespace',
352 'page_title',
353 'page_restrictions',
354 'page_is_redirect',
355 'page_is_new',
356 'page_random',
357 'page_touched',
358 'page_links_updated',
359 'page_latest',
360 'page_len',
361 ];
362
363 if ( $wgContentHandlerUseDB ) {
364 $fields[] = 'page_content_model';
365 }
366
367 if ( $wgPageLanguageUseDB ) {
368 $fields[] = 'page_lang';
369 }
370
371 return $fields;
372 }
373
374 /**
375 * Return the tables, fields, and join conditions to be selected to create
376 * a new page object.
377 * @since 1.31
378 * @return array With three keys:
379 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
380 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
381 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
382 */
383 public static function getQueryInfo() {
384 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
385
386 $ret = [
387 'tables' => [ 'page' ],
388 'fields' => [
389 'page_id',
390 'page_namespace',
391 'page_title',
392 'page_restrictions',
393 'page_is_redirect',
394 'page_is_new',
395 'page_random',
396 'page_touched',
397 'page_links_updated',
398 'page_latest',
399 'page_len',
400 ],
401 'joins' => [],
402 ];
403
404 if ( $wgContentHandlerUseDB ) {
405 $ret['fields'][] = 'page_content_model';
406 }
407
408 if ( $wgPageLanguageUseDB ) {
409 $ret['fields'][] = 'page_lang';
410 }
411
412 return $ret;
413 }
414
415 /**
416 * Fetch a page record with the given conditions
417 * @param IDatabase $dbr
418 * @param array $conditions
419 * @param array $options
420 * @return object|bool Database result resource, or false on failure
421 */
422 protected function pageData( $dbr, $conditions, $options = [] ) {
423 $pageQuery = self::getQueryInfo();
424
425 // Avoid PHP 7.1 warning of passing $this by reference
426 $wikiPage = $this;
427
428 Hooks::run( 'ArticlePageDataBefore', [
429 &$wikiPage, &$pageQuery['fields'], &$pageQuery['tables'], &$pageQuery['joins']
430 ] );
431
432 $row = $dbr->selectRow(
433 $pageQuery['tables'],
434 $pageQuery['fields'],
435 $conditions,
436 __METHOD__,
437 $options,
438 $pageQuery['joins']
439 );
440
441 Hooks::run( 'ArticlePageDataAfter', [ &$wikiPage, &$row ] );
442
443 return $row;
444 }
445
446 /**
447 * Fetch a page record matching the Title object's namespace and title
448 * using a sanitized title string
449 *
450 * @param IDatabase $dbr
451 * @param Title $title
452 * @param array $options
453 * @return object|bool Database result resource, or false on failure
454 */
455 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
456 return $this->pageData( $dbr, [
457 'page_namespace' => $title->getNamespace(),
458 'page_title' => $title->getDBkey() ], $options );
459 }
460
461 /**
462 * Fetch a page record matching the requested ID
463 *
464 * @param IDatabase $dbr
465 * @param int $id
466 * @param array $options
467 * @return object|bool Database result resource, or false on failure
468 */
469 public function pageDataFromId( $dbr, $id, $options = [] ) {
470 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
471 }
472
473 /**
474 * Load the object from a given source by title
475 *
476 * @param object|string|int $from One of the following:
477 * - A DB query result object.
478 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
479 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
480 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
481 * using SELECT FOR UPDATE.
482 *
483 * @return void
484 */
485 public function loadPageData( $from = 'fromdb' ) {
486 $from = self::convertSelectType( $from );
487 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
488 // We already have the data from the correct location, no need to load it twice.
489 return;
490 }
491
492 if ( is_int( $from ) ) {
493 list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
494 $loadBalancer = $this->getDBLoadBalancer();
495 $db = $loadBalancer->getConnection( $index );
496 $data = $this->pageDataFromTitle( $db, $this->mTitle, $opts );
497
498 if ( !$data
499 && $index == DB_REPLICA
500 && $loadBalancer->getServerCount() > 1
501 && $loadBalancer->hasOrMadeRecentMasterChanges()
502 ) {
503 $from = self::READ_LATEST;
504 list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
505 $db = $loadBalancer->getConnection( $index );
506 $data = $this->pageDataFromTitle( $db, $this->mTitle, $opts );
507 }
508 } else {
509 // No idea from where the caller got this data, assume replica DB.
510 $data = $from;
511 $from = self::READ_NORMAL;
512 }
513
514 $this->loadFromRow( $data, $from );
515 }
516
517 /**
518 * Checks whether the page data was loaded using the given database access mode (or better).
519 *
520 * @since 1.32
521 *
522 * @param string|int $from One of the following:
523 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
524 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
525 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
526 * using SELECT FOR UPDATE.
527 *
528 * @return bool
529 */
530 public function wasLoadedFrom( $from ) {
531 $from = self::convertSelectType( $from );
532
533 if ( !is_int( $from ) ) {
534 // No idea from where the caller got this data, assume replica DB.
535 $from = self::READ_NORMAL;
536 }
537
538 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
539 return true;
540 }
541
542 return false;
543 }
544
545 /**
546 * Load the object from a database row
547 *
548 * @since 1.20
549 * @param object|bool $data DB row containing fields returned by selectFields() or false
550 * @param string|int $from One of the following:
551 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
552 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
553 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
554 * the master DB using SELECT FOR UPDATE
555 */
556 public function loadFromRow( $data, $from ) {
557 $lc = MediaWikiServices::getInstance()->getLinkCache();
558 $lc->clearLink( $this->mTitle );
559
560 if ( $data ) {
561 $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
562
563 $this->mTitle->loadFromRow( $data );
564
565 // Old-fashioned restrictions
566 $this->mTitle->loadRestrictions( $data->page_restrictions );
567
568 $this->mId = intval( $data->page_id );
569 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
570 $this->mLinksUpdated = wfTimestampOrNull( TS_MW, $data->page_links_updated );
571 $this->mIsRedirect = intval( $data->page_is_redirect );
572 $this->mLatest = intval( $data->page_latest );
573 // T39225: $latest may no longer match the cached latest Revision object.
574 // Double-check the ID of any cached latest Revision object for consistency.
575 if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
576 $this->mLastRevision = null;
577 $this->mTimestamp = '';
578 }
579 } else {
580 $lc->addBadLinkObj( $this->mTitle );
581
582 $this->mTitle->loadFromRow( false );
583
584 $this->clearCacheFields();
585
586 $this->mId = 0;
587 }
588
589 $this->mDataLoaded = true;
590 $this->mDataLoadedFrom = self::convertSelectType( $from );
591 }
592
593 /**
594 * @return int Page ID
595 */
596 public function getId() {
597 if ( !$this->mDataLoaded ) {
598 $this->loadPageData();
599 }
600 return $this->mId;
601 }
602
603 /**
604 * @return bool Whether or not the page exists in the database
605 */
606 public function exists() {
607 if ( !$this->mDataLoaded ) {
608 $this->loadPageData();
609 }
610 return $this->mId > 0;
611 }
612
613 /**
614 * Check if this page is something we're going to be showing
615 * some sort of sensible content for. If we return false, page
616 * views (plain action=view) will return an HTTP 404 response,
617 * so spiders and robots can know they're following a bad link.
618 *
619 * @return bool
620 */
621 public function hasViewableContent() {
622 return $this->mTitle->isKnown();
623 }
624
625 /**
626 * Tests if the article content represents a redirect
627 *
628 * @return bool
629 */
630 public function isRedirect() {
631 if ( !$this->mDataLoaded ) {
632 $this->loadPageData();
633 }
634
635 return (bool)$this->mIsRedirect;
636 }
637
638 /**
639 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
640 *
641 * Will use the revisions actual content model if the page exists,
642 * and the page's default if the page doesn't exist yet.
643 *
644 * @return string
645 *
646 * @since 1.21
647 */
648 public function getContentModel() {
649 if ( $this->exists() ) {
650 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
651
652 return $cache->getWithSetCallback(
653 $cache->makeKey( 'page-content-model', $this->getLatest() ),
654 $cache::TTL_MONTH,
655 function () {
656 $rev = $this->getRevision();
657 if ( $rev ) {
658 // Look at the revision's actual content model
659 return $rev->getContentModel();
660 } else {
661 $title = $this->mTitle->getPrefixedDBkey();
662 wfWarn( "Page $title exists but has no (visible) revisions!" );
663 return $this->mTitle->getContentModel();
664 }
665 }
666 );
667 }
668
669 // use the default model for this page
670 return $this->mTitle->getContentModel();
671 }
672
673 /**
674 * Loads page_touched and returns a value indicating if it should be used
675 * @return bool True if this page exists and is not a redirect
676 */
677 public function checkTouched() {
678 if ( !$this->mDataLoaded ) {
679 $this->loadPageData();
680 }
681 return ( $this->mId && !$this->mIsRedirect );
682 }
683
684 /**
685 * Get the page_touched field
686 * @return string Containing GMT timestamp
687 */
688 public function getTouched() {
689 if ( !$this->mDataLoaded ) {
690 $this->loadPageData();
691 }
692 return $this->mTouched;
693 }
694
695 /**
696 * Get the page_links_updated field
697 * @return string|null Containing GMT timestamp
698 */
699 public function getLinksTimestamp() {
700 if ( !$this->mDataLoaded ) {
701 $this->loadPageData();
702 }
703 return $this->mLinksUpdated;
704 }
705
706 /**
707 * Get the page_latest field
708 * @return int The rev_id of current revision
709 */
710 public function getLatest() {
711 if ( !$this->mDataLoaded ) {
712 $this->loadPageData();
713 }
714 return (int)$this->mLatest;
715 }
716
717 /**
718 * Get the Revision object of the oldest revision
719 * @return Revision|null
720 */
721 public function getOldestRevision() {
722 // Try using the replica DB first, then try the master
723 $rev = $this->mTitle->getFirstRevision();
724 if ( !$rev ) {
725 $rev = $this->mTitle->getFirstRevision( Title::GAID_FOR_UPDATE );
726 }
727 return $rev;
728 }
729
730 /**
731 * Loads everything except the text
732 * This isn't necessary for all uses, so it's only done if needed.
733 */
734 protected function loadLastEdit() {
735 if ( $this->mLastRevision !== null ) {
736 return; // already loaded
737 }
738
739 $latest = $this->getLatest();
740 if ( !$latest ) {
741 return; // page doesn't exist or is missing page_latest info
742 }
743
744 if ( $this->mDataLoadedFrom == self::READ_LOCKING ) {
745 // T39225: if session S1 loads the page row FOR UPDATE, the result always
746 // includes the latest changes committed. This is true even within REPEATABLE-READ
747 // transactions, where S1 normally only sees changes committed before the first S1
748 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
749 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
750 // happened after the first S1 SELECT.
751 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
752 $flags = Revision::READ_LOCKING;
753 $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
754 } elseif ( $this->mDataLoadedFrom == self::READ_LATEST ) {
755 // Bug T93976: if page_latest was loaded from the master, fetch the
756 // revision from there as well, as it may not exist yet on a replica DB.
757 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
758 $flags = Revision::READ_LATEST;
759 $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
760 } else {
761 $dbr = wfGetDB( DB_REPLICA );
762 $revision = Revision::newKnownCurrent( $dbr, $this->getTitle(), $latest );
763 }
764
765 if ( $revision ) { // sanity
766 $this->setLastEdit( $revision );
767 }
768 }
769
770 /**
771 * Set the latest revision
772 * @param Revision $revision
773 */
774 protected function setLastEdit( Revision $revision ) {
775 $this->mLastRevision = $revision;
776 $this->mTimestamp = $revision->getTimestamp();
777 }
778
779 /**
780 * Get the latest revision
781 * @return Revision|null
782 */
783 public function getRevision() {
784 $this->loadLastEdit();
785 if ( $this->mLastRevision ) {
786 return $this->mLastRevision;
787 }
788 return null;
789 }
790
791 /**
792 * Get the latest revision
793 * @return RevisionRecord|null
794 */
795 public function getRevisionRecord() {
796 $this->loadLastEdit();
797 if ( $this->mLastRevision ) {
798 return $this->mLastRevision->getRevisionRecord();
799 }
800 return null;
801 }
802
803 /**
804 * Get the content of the current revision. No side-effects...
805 *
806 * @param int $audience One of:
807 * Revision::FOR_PUBLIC to be displayed to all users
808 * Revision::FOR_THIS_USER to be displayed to $wgUser
809 * Revision::RAW get the text regardless of permissions
810 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
811 * to the $audience parameter
812 * @return Content|null The content of the current revision
813 *
814 * @since 1.21
815 */
816 public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) {
817 $this->loadLastEdit();
818 if ( $this->mLastRevision ) {
819 return $this->mLastRevision->getContent( $audience, $user );
820 }
821 return null;
822 }
823
824 /**
825 * @return string MW timestamp of last article revision
826 */
827 public function getTimestamp() {
828 // Check if the field has been filled by WikiPage::setTimestamp()
829 if ( !$this->mTimestamp ) {
830 $this->loadLastEdit();
831 }
832
833 return wfTimestamp( TS_MW, $this->mTimestamp );
834 }
835
836 /**
837 * Set the page timestamp (use only to avoid DB queries)
838 * @param string $ts MW timestamp of last article revision
839 * @return void
840 */
841 public function setTimestamp( $ts ) {
842 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
843 }
844
845 /**
846 * @param int $audience One of:
847 * Revision::FOR_PUBLIC to be displayed to all users
848 * Revision::FOR_THIS_USER to be displayed to the given user
849 * Revision::RAW get the text regardless of permissions
850 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
851 * to the $audience parameter
852 * @return int User ID for the user that made the last article revision
853 */
854 public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
855 $this->loadLastEdit();
856 if ( $this->mLastRevision ) {
857 return $this->mLastRevision->getUser( $audience, $user );
858 } else {
859 return -1;
860 }
861 }
862
863 /**
864 * Get the User object of the user who created the page
865 * @param int $audience One of:
866 * Revision::FOR_PUBLIC to be displayed to all users
867 * Revision::FOR_THIS_USER to be displayed to the given user
868 * Revision::RAW get the text regardless of permissions
869 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
870 * to the $audience parameter
871 * @return User|null
872 */
873 public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) {
874 $revision = $this->getOldestRevision();
875 if ( $revision ) {
876 $userName = $revision->getUserText( $audience, $user );
877 return User::newFromName( $userName, false );
878 } else {
879 return null;
880 }
881 }
882
883 /**
884 * @param int $audience One of:
885 * Revision::FOR_PUBLIC to be displayed to all users
886 * Revision::FOR_THIS_USER to be displayed to the given user
887 * Revision::RAW get the text regardless of permissions
888 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
889 * to the $audience parameter
890 * @return string Username of the user that made the last article revision
891 */
892 public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
893 $this->loadLastEdit();
894 if ( $this->mLastRevision ) {
895 return $this->mLastRevision->getUserText( $audience, $user );
896 } else {
897 return '';
898 }
899 }
900
901 /**
902 * @param int $audience One of:
903 * Revision::FOR_PUBLIC to be displayed to all users
904 * Revision::FOR_THIS_USER to be displayed to the given user
905 * Revision::RAW get the text regardless of permissions
906 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
907 * to the $audience parameter
908 * @return string|null Comment stored for the last article revision, or null if the specified
909 * audience does not have access to the comment.
910 */
911 public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) {
912 $this->loadLastEdit();
913 if ( $this->mLastRevision ) {
914 return $this->mLastRevision->getComment( $audience, $user );
915 } else {
916 return '';
917 }
918 }
919
920 /**
921 * Returns true if last revision was marked as "minor edit"
922 *
923 * @return bool Minor edit indicator for the last article revision.
924 */
925 public function getMinorEdit() {
926 $this->loadLastEdit();
927 if ( $this->mLastRevision ) {
928 return $this->mLastRevision->isMinor();
929 } else {
930 return false;
931 }
932 }
933
934 /**
935 * Determine whether a page would be suitable for being counted as an
936 * article in the site_stats table based on the title & its content
937 *
938 * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
939 * if false, the current database state will be used
940 * @return bool
941 */
942 public function isCountable( $editInfo = false ) {
943 global $wgArticleCountMethod;
944
945 // NOTE: Keep in sync with DerivedPageDataUpdater::isCountable.
946
947 if ( !$this->mTitle->isContentPage() ) {
948 return false;
949 }
950
951 if ( $editInfo ) {
952 // NOTE: only the main slot can make a page a redirect
953 $content = $editInfo->pstContent;
954 } else {
955 $content = $this->getContent();
956 }
957
958 if ( !$content || $content->isRedirect() ) {
959 return false;
960 }
961
962 $hasLinks = null;
963
964 if ( $wgArticleCountMethod === 'link' ) {
965 // nasty special case to avoid re-parsing to detect links
966
967 if ( $editInfo ) {
968 // ParserOutput::getLinks() is a 2D array of page links, so
969 // to be really correct we would need to recurse in the array
970 // but the main array should only have items in it if there are
971 // links.
972 $hasLinks = (bool)count( $editInfo->output->getLinks() );
973 } else {
974 // NOTE: keep in sync with RevisionRenderer::getLinkCount
975 // NOTE: keep in sync with DerivedPageDataUpdater::isCountable
976 $hasLinks = (bool)wfGetDB( DB_REPLICA )->selectField( 'pagelinks', 1,
977 [ 'pl_from' => $this->getId() ], __METHOD__ );
978 }
979 }
980
981 // TODO: MCR: determine $hasLinks for each slot, and use that info
982 // with that slot's Content's isCountable method. That requires per-
983 // slot ParserOutput in the ParserCache, or per-slot info in the
984 // pagelinks table.
985 return $content->isCountable( $hasLinks );
986 }
987
988 /**
989 * If this page is a redirect, get its target
990 *
991 * The target will be fetched from the redirect table if possible.
992 * If this page doesn't have an entry there, call insertRedirect()
993 * @return Title|null Title object, or null if this page is not a redirect
994 */
995 public function getRedirectTarget() {
996 if ( !$this->mTitle->isRedirect() ) {
997 return null;
998 }
999
1000 if ( $this->mRedirectTarget !== null ) {
1001 return $this->mRedirectTarget;
1002 }
1003
1004 // Query the redirect table
1005 $dbr = wfGetDB( DB_REPLICA );
1006 $row = $dbr->selectRow( 'redirect',
1007 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
1008 [ 'rd_from' => $this->getId() ],
1009 __METHOD__
1010 );
1011
1012 // rd_fragment and rd_interwiki were added later, populate them if empty
1013 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
1014 // (T203942) We can't redirect to Media namespace because it's virtual.
1015 // We don't want to modify Title objects farther down the
1016 // line. So, let's fix this here by changing to File namespace.
1017 if ( $row->rd_namespace == NS_MEDIA ) {
1018 $namespace = NS_FILE;
1019 } else {
1020 $namespace = $row->rd_namespace;
1021 }
1022 $this->mRedirectTarget = Title::makeTitle(
1023 $namespace, $row->rd_title,
1024 $row->rd_fragment, $row->rd_interwiki
1025 );
1026 return $this->mRedirectTarget;
1027 }
1028
1029 // This page doesn't have an entry in the redirect table
1030 $this->mRedirectTarget = $this->insertRedirect();
1031 return $this->mRedirectTarget;
1032 }
1033
1034 /**
1035 * Insert an entry for this page into the redirect table if the content is a redirect
1036 *
1037 * The database update will be deferred via DeferredUpdates
1038 *
1039 * Don't call this function directly unless you know what you're doing.
1040 * @return Title|null Title object or null if not a redirect
1041 */
1042 public function insertRedirect() {
1043 $content = $this->getContent();
1044 $retval = $content ? $content->getUltimateRedirectTarget() : null;
1045 if ( !$retval ) {
1046 return null;
1047 }
1048
1049 // Update the DB post-send if the page has not cached since now
1050 $latest = $this->getLatest();
1051 DeferredUpdates::addCallableUpdate(
1052 function () use ( $retval, $latest ) {
1053 $this->insertRedirectEntry( $retval, $latest );
1054 },
1055 DeferredUpdates::POSTSEND,
1056 wfGetDB( DB_MASTER )
1057 );
1058
1059 return $retval;
1060 }
1061
1062 /**
1063 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
1064 * @param Title $rt Redirect target
1065 * @param int|null $oldLatest Prior page_latest for check and set
1066 */
1067 public function insertRedirectEntry( Title $rt, $oldLatest = null ) {
1068 $dbw = wfGetDB( DB_MASTER );
1069 $dbw->startAtomic( __METHOD__ );
1070
1071 if ( !$oldLatest || $oldLatest == $this->lockAndGetLatest() ) {
1072 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
1073 $truncatedFragment = $contLang->truncateForDatabase( $rt->getFragment(), 255 );
1074 $dbw->upsert(
1075 'redirect',
1076 [
1077 'rd_from' => $this->getId(),
1078 'rd_namespace' => $rt->getNamespace(),
1079 'rd_title' => $rt->getDBkey(),
1080 'rd_fragment' => $truncatedFragment,
1081 'rd_interwiki' => $rt->getInterwiki(),
1082 ],
1083 [ 'rd_from' ],
1084 [
1085 'rd_namespace' => $rt->getNamespace(),
1086 'rd_title' => $rt->getDBkey(),
1087 'rd_fragment' => $truncatedFragment,
1088 'rd_interwiki' => $rt->getInterwiki(),
1089 ],
1090 __METHOD__
1091 );
1092 }
1093
1094 $dbw->endAtomic( __METHOD__ );
1095 }
1096
1097 /**
1098 * Get the Title object or URL this page redirects to
1099 *
1100 * @return bool|Title|string False, Title of in-wiki target, or string with URL
1101 */
1102 public function followRedirect() {
1103 return $this->getRedirectURL( $this->getRedirectTarget() );
1104 }
1105
1106 /**
1107 * Get the Title object or URL to use for a redirect. We use Title
1108 * objects for same-wiki, non-special redirects and URLs for everything
1109 * else.
1110 * @param Title $rt Redirect target
1111 * @return bool|Title|string False, Title object of local target, or string with URL
1112 */
1113 public function getRedirectURL( $rt ) {
1114 if ( !$rt ) {
1115 return false;
1116 }
1117
1118 if ( $rt->isExternal() ) {
1119 if ( $rt->isLocal() ) {
1120 // Offsite wikis need an HTTP redirect.
1121 // This can be hard to reverse and may produce loops,
1122 // so they may be disabled in the site configuration.
1123 $source = $this->mTitle->getFullURL( 'redirect=no' );
1124 return $rt->getFullURL( [ 'rdfrom' => $source ] );
1125 } else {
1126 // External pages without "local" bit set are not valid
1127 // redirect targets
1128 return false;
1129 }
1130 }
1131
1132 if ( $rt->isSpecialPage() ) {
1133 // Gotta handle redirects to special pages differently:
1134 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
1135 // Some pages are not valid targets.
1136 if ( $rt->isValidRedirectTarget() ) {
1137 return $rt->getFullURL();
1138 } else {
1139 return false;
1140 }
1141 }
1142
1143 return $rt;
1144 }
1145
1146 /**
1147 * Get a list of users who have edited this article, not including the user who made
1148 * the most recent revision, which you can get from $article->getUser() if you want it
1149 * @return UserArrayFromResult
1150 */
1151 public function getContributors() {
1152 // @todo: This is expensive; cache this info somewhere.
1153
1154 $dbr = wfGetDB( DB_REPLICA );
1155
1156 $actorMigration = ActorMigration::newMigration();
1157 $actorQuery = $actorMigration->getJoin( 'rev_user' );
1158
1159 $tables = array_merge( [ 'revision' ], $actorQuery['tables'], [ 'user' ] );
1160
1161 $fields = [
1162 'user_id' => $actorQuery['fields']['rev_user'],
1163 'user_name' => $actorQuery['fields']['rev_user_text'],
1164 'actor_id' => $actorQuery['fields']['rev_actor'],
1165 'user_real_name' => 'MIN(user_real_name)',
1166 'timestamp' => 'MAX(rev_timestamp)',
1167 ];
1168
1169 $conds = [ 'rev_page' => $this->getId() ];
1170
1171 // The user who made the top revision gets credited as "this page was last edited by
1172 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1173 $user = $this->getUser()
1174 ? User::newFromId( $this->getUser() )
1175 : User::newFromName( $this->getUserText(), false );
1176 $conds[] = 'NOT(' . $actorMigration->getWhere( $dbr, 'rev_user', $user )['conds'] . ')';
1177
1178 // Username hidden?
1179 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1180
1181 $jconds = [
1182 'user' => [ 'LEFT JOIN', $actorQuery['fields']['rev_user'] . ' = user_id' ],
1183 ] + $actorQuery['joins'];
1184
1185 $options = [
1186 'GROUP BY' => [ $fields['user_id'], $fields['user_name'] ],
1187 'ORDER BY' => 'timestamp DESC',
1188 ];
1189
1190 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1191 return new UserArrayFromResult( $res );
1192 }
1193
1194 /**
1195 * Should the parser cache be used?
1196 *
1197 * @param ParserOptions $parserOptions ParserOptions to check
1198 * @param int $oldId
1199 * @return bool
1200 */
1201 public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) {
1202 return $parserOptions->getStubThreshold() == 0
1203 && $this->exists()
1204 && ( $oldId === null || $oldId === 0 || $oldId === $this->getLatest() )
1205 && $this->getContentHandler()->isParserCacheSupported();
1206 }
1207
1208 /**
1209 * Get a ParserOutput for the given ParserOptions and revision ID.
1210 *
1211 * The parser cache will be used if possible. Cache misses that result
1212 * in parser runs are debounced with PoolCounter.
1213 *
1214 * XXX merge this with updateParserCache()?
1215 *
1216 * @since 1.19
1217 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1218 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1219 * get the current revision (default value)
1220 * @param bool $forceParse Force reindexing, regardless of cache settings
1221 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1222 */
1223 public function getParserOutput(
1224 ParserOptions $parserOptions, $oldid = null, $forceParse = false
1225 ) {
1226 $useParserCache =
1227 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1228
1229 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1230 throw new InvalidArgumentException(
1231 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1232 );
1233 }
1234
1235 wfDebug( __METHOD__ .
1236 ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1237 if ( $parserOptions->getStubThreshold() ) {
1238 wfIncrStats( 'pcache.miss.stub' );
1239 }
1240
1241 if ( $useParserCache ) {
1242 $parserOutput = $this->getParserCache()
1243 ->get( $this, $parserOptions );
1244 if ( $parserOutput !== false ) {
1245 return $parserOutput;
1246 }
1247 }
1248
1249 if ( $oldid === null || $oldid === 0 ) {
1250 $oldid = $this->getLatest();
1251 }
1252
1253 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1254 $pool->execute();
1255
1256 return $pool->getParserOutput();
1257 }
1258
1259 /**
1260 * Do standard deferred updates after page view (existing or missing page)
1261 * @param User $user The relevant user
1262 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1263 */
1264 public function doViewUpdates( User $user, $oldid = 0 ) {
1265 if ( wfReadOnly() ) {
1266 return;
1267 }
1268
1269 // Update newtalk / watchlist notification status;
1270 // Avoid outage if the master is not reachable by using a deferred updated
1271 DeferredUpdates::addCallableUpdate(
1272 function () use ( $user, $oldid ) {
1273 Hooks::run( 'PageViewUpdates', [ $this, $user ] );
1274
1275 $user->clearNotification( $this->mTitle, $oldid );
1276 },
1277 DeferredUpdates::PRESEND
1278 );
1279 }
1280
1281 /**
1282 * Perform the actions of a page purging
1283 * @return bool
1284 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1285 * controlled how much purging was done.
1286 */
1287 public function doPurge() {
1288 // Avoid PHP 7.1 warning of passing $this by reference
1289 $wikiPage = $this;
1290
1291 if ( !Hooks::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1292 return false;
1293 }
1294
1295 $this->mTitle->invalidateCache();
1296
1297 // Clear file cache
1298 HTMLFileCache::clearFileCache( $this->getTitle() );
1299 // Send purge after above page_touched update was committed
1300 DeferredUpdates::addUpdate(
1301 new CdnCacheUpdate( $this->mTitle->getCdnUrls() ),
1302 DeferredUpdates::PRESEND
1303 );
1304
1305 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1306 $messageCache = MessageCache::singleton();
1307 $messageCache->updateMessageOverride( $this->mTitle, $this->getContent() );
1308 }
1309
1310 return true;
1311 }
1312
1313 /**
1314 * Insert a new empty page record for this article.
1315 * This *must* be followed up by creating a revision
1316 * and running $this->updateRevisionOn( ... );
1317 * or else the record will be left in a funky state.
1318 * Best if all done inside a transaction.
1319 *
1320 * @todo Factor out into a PageStore service, to be used by PageUpdater.
1321 *
1322 * @param IDatabase $dbw
1323 * @param int|null $pageId Custom page ID that will be used for the insert statement
1324 *
1325 * @return bool|int The newly created page_id key; false if the row was not
1326 * inserted, e.g. because the title already existed or because the specified
1327 * page ID is already in use.
1328 */
1329 public function insertOn( $dbw, $pageId = null ) {
1330 $pageIdForInsert = $pageId ? [ 'page_id' => $pageId ] : [];
1331 $dbw->insert(
1332 'page',
1333 [
1334 'page_namespace' => $this->mTitle->getNamespace(),
1335 'page_title' => $this->mTitle->getDBkey(),
1336 'page_restrictions' => '',
1337 'page_is_redirect' => 0, // Will set this shortly...
1338 'page_is_new' => 1,
1339 'page_random' => wfRandom(),
1340 'page_touched' => $dbw->timestamp(),
1341 'page_latest' => 0, // Fill this in shortly...
1342 'page_len' => 0, // Fill this in shortly...
1343 ] + $pageIdForInsert,
1344 __METHOD__,
1345 'IGNORE'
1346 );
1347
1348 if ( $dbw->affectedRows() > 0 ) {
1349 $newid = $pageId ? (int)$pageId : $dbw->insertId();
1350 $this->mId = $newid;
1351 $this->mTitle->resetArticleID( $newid );
1352
1353 return $newid;
1354 } else {
1355 return false; // nothing changed
1356 }
1357 }
1358
1359 /**
1360 * Update the page record to point to a newly saved revision.
1361 *
1362 * @todo Factor out into a PageStore service, or move into PageUpdater.
1363 *
1364 * @param IDatabase $dbw
1365 * @param Revision $revision For ID number, and text used to set
1366 * length and redirect status fields
1367 * @param int|null $lastRevision If given, will not overwrite the page field
1368 * when different from the currently set value.
1369 * Giving 0 indicates the new page flag should be set on.
1370 * @param bool|null $lastRevIsRedirect If given, will optimize adding and
1371 * removing rows in redirect table.
1372 * @return bool Success; false if the page row was missing or page_latest changed
1373 */
1374 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1375 $lastRevIsRedirect = null
1376 ) {
1377 global $wgContentHandlerUseDB;
1378
1379 // TODO: move into PageUpdater or PageStore
1380 // NOTE: when doing that, make sure cached fields get reset in doEditContent,
1381 // and in the compat stub!
1382
1383 // Assertion to try to catch T92046
1384 if ( (int)$revision->getId() === 0 ) {
1385 throw new InvalidArgumentException(
1386 __METHOD__ . ': Revision has ID ' . var_export( $revision->getId(), 1 )
1387 );
1388 }
1389
1390 $content = $revision->getContent();
1391 $len = $content ? $content->getSize() : 0;
1392 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1393
1394 $conditions = [ 'page_id' => $this->getId() ];
1395
1396 if ( !is_null( $lastRevision ) ) {
1397 // An extra check against threads stepping on each other
1398 $conditions['page_latest'] = $lastRevision;
1399 }
1400
1401 $revId = $revision->getId();
1402 Assert::parameter( $revId > 0, '$revision->getId()', 'must be > 0' );
1403
1404 $row = [ /* SET */
1405 'page_latest' => $revId,
1406 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1407 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
1408 'page_is_redirect' => $rt !== null ? 1 : 0,
1409 'page_len' => $len,
1410 ];
1411
1412 if ( $wgContentHandlerUseDB ) {
1413 $row['page_content_model'] = $revision->getContentModel();
1414 }
1415
1416 $dbw->update( 'page',
1417 $row,
1418 $conditions,
1419 __METHOD__ );
1420
1421 $result = $dbw->affectedRows() > 0;
1422 if ( $result ) {
1423 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1424 $this->setLastEdit( $revision );
1425 $this->mLatest = $revision->getId();
1426 $this->mIsRedirect = (bool)$rt;
1427 // Update the LinkCache.
1428 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
1429 $linkCache->addGoodLinkObj(
1430 $this->getId(),
1431 $this->mTitle,
1432 $len,
1433 $this->mIsRedirect,
1434 $this->mLatest,
1435 $revision->getContentModel()
1436 );
1437 }
1438
1439 return $result;
1440 }
1441
1442 /**
1443 * Add row to the redirect table if this is a redirect, remove otherwise.
1444 *
1445 * @param IDatabase $dbw
1446 * @param Title|null $redirectTitle Title object pointing to the redirect target,
1447 * or NULL if this is not a redirect
1448 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1449 * removing rows in redirect table.
1450 * @return bool True on success, false on failure
1451 * @private
1452 */
1453 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1454 // Always update redirects (target link might have changed)
1455 // Update/Insert if we don't know if the last revision was a redirect or not
1456 // Delete if changing from redirect to non-redirect
1457 $isRedirect = !is_null( $redirectTitle );
1458
1459 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1460 return true;
1461 }
1462
1463 if ( $isRedirect ) {
1464 $this->insertRedirectEntry( $redirectTitle );
1465 } else {
1466 // This is not a redirect, remove row from redirect table
1467 $where = [ 'rd_from' => $this->getId() ];
1468 $dbw->delete( 'redirect', $where, __METHOD__ );
1469 }
1470
1471 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1472 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1473 }
1474
1475 return ( $dbw->affectedRows() != 0 );
1476 }
1477
1478 /**
1479 * If the given revision is newer than the currently set page_latest,
1480 * update the page record. Otherwise, do nothing.
1481 *
1482 * @deprecated since 1.24, use updateRevisionOn instead
1483 *
1484 * @param IDatabase $dbw
1485 * @param Revision $revision
1486 * @return bool
1487 */
1488 public function updateIfNewerOn( $dbw, $revision ) {
1489 $row = $dbw->selectRow(
1490 [ 'revision', 'page' ],
1491 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1492 [
1493 'page_id' => $this->getId(),
1494 'page_latest=rev_id' ],
1495 __METHOD__ );
1496
1497 if ( $row ) {
1498 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1499 return false;
1500 }
1501 $prev = $row->rev_id;
1502 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1503 } else {
1504 // No or missing previous revision; mark the page as new
1505 $prev = 0;
1506 $lastRevIsRedirect = null;
1507 }
1508
1509 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1510
1511 return $ret;
1512 }
1513
1514 /**
1515 * Helper method for checking whether two revisions have differences that go
1516 * beyond the main slot.
1517 *
1518 * MCR migration note: this method should go away!
1519 *
1520 * @deprecated Use only as a stop-gap before refactoring to support MCR.
1521 *
1522 * @param Revision $a
1523 * @param Revision $b
1524 * @return bool
1525 */
1526 public static function hasDifferencesOutsideMainSlot( Revision $a, Revision $b ) {
1527 $aSlots = $a->getRevisionRecord()->getSlots();
1528 $bSlots = $b->getRevisionRecord()->getSlots();
1529 $changedRoles = $aSlots->getRolesWithDifferentContent( $bSlots );
1530
1531 return ( $changedRoles !== [ SlotRecord::MAIN ] && $changedRoles !== [] );
1532 }
1533
1534 /**
1535 * Get the content that needs to be saved in order to undo all revisions
1536 * between $undo and $undoafter. Revisions must belong to the same page,
1537 * must exist and must not be deleted
1538 *
1539 * @param Revision $undo
1540 * @param Revision $undoafter Must be an earlier revision than $undo
1541 * @return Content|bool Content on success, false on failure
1542 * @since 1.21
1543 * Before we had the Content object, this was done in getUndoText
1544 */
1545 public function getUndoContent( Revision $undo, Revision $undoafter ) {
1546 // TODO: MCR: replace this with a method that returns a RevisionSlotsUpdate
1547
1548 if ( self::hasDifferencesOutsideMainSlot( $undo, $undoafter ) ) {
1549 // Cannot yet undo edits that involve anything other the main slot.
1550 return false;
1551 }
1552
1553 $handler = $undo->getContentHandler();
1554 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1555 }
1556
1557 /**
1558 * Returns true if this page's content model supports sections.
1559 *
1560 * @return bool
1561 *
1562 * @todo The skin should check this and not offer section functionality if
1563 * sections are not supported.
1564 * @todo The EditPage should check this and not offer section functionality
1565 * if sections are not supported.
1566 */
1567 public function supportsSections() {
1568 return $this->getContentHandler()->supportsSections();
1569 }
1570
1571 /**
1572 * @param string|int|null|bool $sectionId Section identifier as a number or string
1573 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1574 * or 'new' for a new section.
1575 * @param Content $sectionContent New content of the section.
1576 * @param string $sectionTitle New section's subject, only if $section is "new".
1577 * @param string $edittime Revision timestamp or null to use the current revision.
1578 *
1579 * @throws MWException
1580 * @return Content|null New complete article content, or null if error.
1581 *
1582 * @since 1.21
1583 * @deprecated since 1.24, use replaceSectionAtRev instead
1584 */
1585 public function replaceSectionContent(
1586 $sectionId, Content $sectionContent, $sectionTitle = '', $edittime = null
1587 ) {
1588 $baseRevId = null;
1589 if ( $edittime && $sectionId !== 'new' ) {
1590 $lb = $this->getDBLoadBalancer();
1591 $dbr = $lb->getConnection( DB_REPLICA );
1592 $rev = Revision::loadFromTimestamp( $dbr, $this->mTitle, $edittime );
1593 // Try the master if this thread may have just added it.
1594 // This could be abstracted into a Revision method, but we don't want
1595 // to encourage loading of revisions by timestamp.
1596 if ( !$rev
1597 && $lb->getServerCount() > 1
1598 && $lb->hasOrMadeRecentMasterChanges()
1599 ) {
1600 $dbw = $lb->getConnection( DB_MASTER );
1601 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1602 }
1603 if ( $rev ) {
1604 $baseRevId = $rev->getId();
1605 }
1606 }
1607
1608 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1609 }
1610
1611 /**
1612 * @param string|int|null|bool $sectionId Section identifier as a number or string
1613 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1614 * or 'new' for a new section.
1615 * @param Content $sectionContent New content of the section.
1616 * @param string $sectionTitle New section's subject, only if $section is "new".
1617 * @param int|null $baseRevId
1618 *
1619 * @throws MWException
1620 * @return Content|null New complete article content, or null if error.
1621 *
1622 * @since 1.24
1623 */
1624 public function replaceSectionAtRev( $sectionId, Content $sectionContent,
1625 $sectionTitle = '', $baseRevId = null
1626 ) {
1627 if ( strval( $sectionId ) === '' ) {
1628 // Whole-page edit; let the whole text through
1629 $newContent = $sectionContent;
1630 } else {
1631 if ( !$this->supportsSections() ) {
1632 throw new MWException( "sections not supported for content model " .
1633 $this->getContentHandler()->getModelID() );
1634 }
1635
1636 // T32711: always use current version when adding a new section
1637 if ( is_null( $baseRevId ) || $sectionId === 'new' ) {
1638 $oldContent = $this->getContent();
1639 } else {
1640 $rev = Revision::newFromId( $baseRevId );
1641 if ( !$rev ) {
1642 wfDebug( __METHOD__ . " asked for bogus section (page: " .
1643 $this->getId() . "; section: $sectionId)\n" );
1644 return null;
1645 }
1646
1647 $oldContent = $rev->getContent();
1648 }
1649
1650 if ( !$oldContent ) {
1651 wfDebug( __METHOD__ . ": no page text\n" );
1652 return null;
1653 }
1654
1655 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1656 }
1657
1658 return $newContent;
1659 }
1660
1661 /**
1662 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1663 *
1664 * @deprecated since 1.32, use exists() instead, or simply omit the EDIT_UPDATE
1665 * and EDIT_NEW flags. To protect against race conditions, use PageUpdater::grabParentRevision.
1666 *
1667 * @param int $flags
1668 * @return int Updated $flags
1669 */
1670 public function checkFlags( $flags ) {
1671 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1672 if ( $this->exists() ) {
1673 $flags |= EDIT_UPDATE;
1674 } else {
1675 $flags |= EDIT_NEW;
1676 }
1677 }
1678
1679 return $flags;
1680 }
1681
1682 /**
1683 * @return DerivedPageDataUpdater
1684 */
1685 private function newDerivedDataUpdater() {
1686 global $wgRCWatchCategoryMembership, $wgArticleCountMethod;
1687
1688 $derivedDataUpdater = new DerivedPageDataUpdater(
1689 $this, // NOTE: eventually, PageUpdater should not know about WikiPage
1690 $this->getRevisionStore(),
1691 $this->getRevisionRenderer(),
1692 $this->getSlotRoleRegistry(),
1693 $this->getParserCache(),
1694 JobQueueGroup::singleton(),
1695 MessageCache::singleton(),
1696 MediaWikiServices::getInstance()->getContentLanguage(),
1697 MediaWikiServices::getInstance()->getDBLoadBalancerFactory()
1698 );
1699
1700 $derivedDataUpdater->setRcWatchCategoryMembership( $wgRCWatchCategoryMembership );
1701 $derivedDataUpdater->setArticleCountMethod( $wgArticleCountMethod );
1702
1703 return $derivedDataUpdater;
1704 }
1705
1706 /**
1707 * Returns a DerivedPageDataUpdater for use with the given target revision or new content.
1708 * This method attempts to re-use the same DerivedPageDataUpdater instance for subsequent calls.
1709 * The parameters passed to this method are used to ensure that the DerivedPageDataUpdater
1710 * returned matches that caller's expectations, allowing an existing instance to be re-used
1711 * if the given parameters match that instance's internal state according to
1712 * DerivedPageDataUpdater::isReusableFor(), and creating a new instance of the parameters do not
1713 * match the existign one.
1714 *
1715 * If neither $forRevision nor $forUpdate is given, a new DerivedPageDataUpdater is always
1716 * created, replacing any DerivedPageDataUpdater currently cached.
1717 *
1718 * MCR migration note: this replaces WikiPage::prepareContentForEdit.
1719 *
1720 * @since 1.32
1721 *
1722 * @param User|null $forUser The user that will be used for, or was used for, PST.
1723 * @param RevisionRecord|null $forRevision The revision created by the edit for which
1724 * to perform updates, if the edit was already saved.
1725 * @param RevisionSlotsUpdate|null $forUpdate The new content to be saved by the edit (pre PST),
1726 * if the edit was not yet saved.
1727 * @param bool $forEdit Only re-use if the cached DerivedPageDataUpdater has the current
1728 * revision as the edit's parent revision. This ensures that the same
1729 * DerivedPageDataUpdater cannot be re-used for two consecutive edits.
1730 *
1731 * @return DerivedPageDataUpdater
1732 */
1733 private function getDerivedDataUpdater(
1734 User $forUser = null,
1735 RevisionRecord $forRevision = null,
1736 RevisionSlotsUpdate $forUpdate = null,
1737 $forEdit = false
1738 ) {
1739 if ( !$forRevision && !$forUpdate ) {
1740 // NOTE: can't re-use an existing derivedDataUpdater if we don't know what the caller is
1741 // going to use it with.
1742 $this->derivedDataUpdater = null;
1743 }
1744
1745 if ( $this->derivedDataUpdater && !$this->derivedDataUpdater->isContentPrepared() ) {
1746 // NOTE: can't re-use an existing derivedDataUpdater if other code that has a reference
1747 // to it did not yet initialize it, because we don't know what data it will be
1748 // initialized with.
1749 $this->derivedDataUpdater = null;
1750 }
1751
1752 // XXX: It would be nice to have an LRU cache instead of trying to re-use a single instance.
1753 // However, there is no good way to construct a cache key. We'd need to check against all
1754 // cached instances.
1755
1756 if ( $this->derivedDataUpdater
1757 && !$this->derivedDataUpdater->isReusableFor(
1758 $forUser,
1759 $forRevision,
1760 $forUpdate,
1761 $forEdit ? $this->getLatest() : null
1762 )
1763 ) {
1764 $this->derivedDataUpdater = null;
1765 }
1766
1767 if ( !$this->derivedDataUpdater ) {
1768 $this->derivedDataUpdater = $this->newDerivedDataUpdater();
1769 }
1770
1771 return $this->derivedDataUpdater;
1772 }
1773
1774 /**
1775 * Returns a PageUpdater for creating new revisions on this page (or creating the page).
1776 *
1777 * The PageUpdater can also be used to detect the need for edit conflict resolution,
1778 * and to protected such conflict resolution from concurrent edits using a check-and-set
1779 * mechanism.
1780 *
1781 * @since 1.32
1782 *
1783 * @param User $user
1784 * @param RevisionSlotsUpdate|null $forUpdate If given, allows any cached ParserOutput
1785 * that may already have been returned via getDerivedDataUpdater to be re-used.
1786 *
1787 * @return PageUpdater
1788 */
1789 public function newPageUpdater( User $user, RevisionSlotsUpdate $forUpdate = null ) {
1790 global $wgAjaxEditStash, $wgUseAutomaticEditSummaries, $wgPageCreationLog;
1791
1792 $pageUpdater = new PageUpdater(
1793 $user,
1794 $this, // NOTE: eventually, PageUpdater should not know about WikiPage
1795 $this->getDerivedDataUpdater( $user, null, $forUpdate, true ),
1796 $this->getDBLoadBalancer(),
1797 $this->getRevisionStore(),
1798 $this->getSlotRoleRegistry()
1799 );
1800
1801 $pageUpdater->setUsePageCreationLog( $wgPageCreationLog );
1802 $pageUpdater->setAjaxEditStash( $wgAjaxEditStash );
1803 $pageUpdater->setUseAutomaticEditSummaries( $wgUseAutomaticEditSummaries );
1804
1805 return $pageUpdater;
1806 }
1807
1808 /**
1809 * Change an existing article or create a new article. Updates RC and all necessary caches,
1810 * optionally via the deferred update array.
1811 *
1812 * @deprecated since 1.32, use PageUpdater::saveRevision instead. Note that the new method
1813 * expects callers to take care of checking EDIT_MINOR against the minoredit right, and to
1814 * apply the autopatrol right as appropriate.
1815 *
1816 * @param Content $content New content
1817 * @param string|CommentStoreComment $summary Edit summary
1818 * @param int $flags Bitfield:
1819 * EDIT_NEW
1820 * Article is known or assumed to be non-existent, create a new one
1821 * EDIT_UPDATE
1822 * Article is known or assumed to be pre-existing, update it
1823 * EDIT_MINOR
1824 * Mark this edit minor, if the user is allowed to do so
1825 * EDIT_SUPPRESS_RC
1826 * Do not log the change in recentchanges
1827 * EDIT_FORCE_BOT
1828 * Mark the edit a "bot" edit regardless of user rights
1829 * EDIT_AUTOSUMMARY
1830 * Fill in blank summaries with generated text where possible
1831 * EDIT_INTERNAL
1832 * Signal that the page retrieve/save cycle happened entirely in this request.
1833 *
1834 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1835 * article will be detected. If EDIT_UPDATE is specified and the article
1836 * doesn't exist, the function will return an edit-gone-missing error. If
1837 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1838 * error will be returned. These two conditions are also possible with
1839 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1840 *
1841 * @param bool|int $originalRevId: The ID of an original revision that the edit
1842 * restores or repeats. The new revision is expected to have the exact same content as
1843 * the given original revision. This is used with rollbacks and with dummy "null" revisions
1844 * which are created to record things like page moves.
1845 * @param User|null $user The user doing the edit
1846 * @param string|null $serialFormat IGNORED.
1847 * @param array|null $tags Change tags to apply to this edit
1848 * Callers are responsible for permission checks
1849 * (with ChangeTags::canAddTagsAccompanyingChange)
1850 * @param Int $undidRevId Id of revision that was undone or 0
1851 *
1852 * @throws MWException
1853 * @return Status Possible errors:
1854 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1855 * set the fatal flag of $status.
1856 * edit-gone-missing: In update mode, but the article didn't exist.
1857 * edit-conflict: In update mode, the article changed unexpectedly.
1858 * edit-no-change: Warning that the text was the same as before.
1859 * edit-already-exists: In creation mode, but the article already exists.
1860 *
1861 * Extensions may define additional errors.
1862 *
1863 * $return->value will contain an associative array with members as follows:
1864 * new: Boolean indicating if the function attempted to create a new article.
1865 * revision: The revision object for the inserted revision, or null.
1866 *
1867 * @since 1.21
1868 * @throws MWException
1869 */
1870 public function doEditContent(
1871 Content $content, $summary, $flags = 0, $originalRevId = false,
1872 User $user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1873 ) {
1874 global $wgUser, $wgUseNPPatrol, $wgUseRCPatrol;
1875
1876 if ( !( $summary instanceof CommentStoreComment ) ) {
1877 $summary = CommentStoreComment::newUnsavedComment( trim( $summary ) );
1878 }
1879
1880 if ( !$user ) {
1881 $user = $wgUser;
1882 }
1883
1884 // TODO: this check is here for backwards-compatibility with 1.31 behavior.
1885 // Checking the minoredit right should be done in the same place the 'bot' right is
1886 // checked for the EDIT_FORCE_BOT flag, which is currently in EditPage::attemptSave.
1887 if ( ( $flags & EDIT_MINOR ) && !$user->isAllowed( 'minoredit' ) ) {
1888 $flags = ( $flags & ~EDIT_MINOR );
1889 }
1890
1891 $slotsUpdate = new RevisionSlotsUpdate();
1892 $slotsUpdate->modifyContent( SlotRecord::MAIN, $content );
1893
1894 // NOTE: while doEditContent() executes, callbacks to getDerivedDataUpdater and
1895 // prepareContentForEdit will generally use the DerivedPageDataUpdater that is also
1896 // used by this PageUpdater. However, there is no guarantee for this.
1897 $updater = $this->newPageUpdater( $user, $slotsUpdate );
1898 $updater->setContent( SlotRecord::MAIN, $content );
1899 $updater->setOriginalRevisionId( $originalRevId );
1900 $updater->setUndidRevisionId( $undidRevId );
1901
1902 $needsPatrol = $wgUseRCPatrol || ( $wgUseNPPatrol && !$this->exists() );
1903
1904 // TODO: this logic should not be in the storage layer, it's here for compatibility
1905 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
1906 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
1907 if ( $needsPatrol && $this->getTitle()->userCan( 'autopatrol', $user ) ) {
1908 $updater->setRcPatrolStatus( RecentChange::PRC_AUTOPATROLLED );
1909 }
1910
1911 $updater->addTags( $tags );
1912
1913 $revRec = $updater->saveRevision(
1914 $summary,
1915 $flags
1916 );
1917
1918 // $revRec will be null if the edit failed, or if no new revision was created because
1919 // the content did not change.
1920 if ( $revRec ) {
1921 // update cached fields
1922 // TODO: this is currently redundant to what is done in updateRevisionOn.
1923 // But updateRevisionOn() should move into PageStore, and then this will be needed.
1924 $this->setLastEdit( new Revision( $revRec ) ); // TODO: use RevisionRecord
1925 $this->mLatest = $revRec->getId();
1926 }
1927
1928 return $updater->getStatus();
1929 }
1930
1931 /**
1932 * Get parser options suitable for rendering the primary article wikitext
1933 *
1934 * @see ParserOptions::newCanonical
1935 *
1936 * @param IContextSource|User|string $context One of the following:
1937 * - IContextSource: Use the User and the Language of the provided
1938 * context
1939 * - User: Use the provided User object and $wgLang for the language,
1940 * so use an IContextSource object if possible.
1941 * - 'canonical': Canonical options (anonymous user with default
1942 * preferences and content language).
1943 * @return ParserOptions
1944 */
1945 public function makeParserOptions( $context ) {
1946 $options = ParserOptions::newCanonical( $context );
1947
1948 if ( $this->getTitle()->isConversionTable() ) {
1949 // @todo ConversionTable should become a separate content model, so
1950 // we don't need special cases like this one.
1951 $options->disableContentConversion();
1952 }
1953
1954 return $options;
1955 }
1956
1957 /**
1958 * Prepare content which is about to be saved.
1959 *
1960 * Prior to 1.30, this returned a stdClass.
1961 *
1962 * @deprecated since 1.32, use getDerivedDataUpdater instead.
1963 *
1964 * @param Content $content
1965 * @param Revision|RevisionRecord|null $revision Revision object.
1966 * Used with vary-revision or vary-revision-id.
1967 * @param User|null $user
1968 * @param string|null $serialFormat IGNORED
1969 * @param bool $useCache Check shared prepared edit cache
1970 *
1971 * @return PreparedEdit
1972 *
1973 * @since 1.21
1974 */
1975 public function prepareContentForEdit(
1976 Content $content,
1977 $revision = null,
1978 User $user = null,
1979 $serialFormat = null,
1980 $useCache = true
1981 ) {
1982 global $wgUser;
1983
1984 if ( !$user ) {
1985 $user = $wgUser;
1986 }
1987
1988 if ( $revision !== null ) {
1989 if ( $revision instanceof Revision ) {
1990 $revision = $revision->getRevisionRecord();
1991 } elseif ( !( $revision instanceof RevisionRecord ) ) {
1992 throw new InvalidArgumentException(
1993 __METHOD__ . ': invalid $revision argument type ' . gettype( $revision ) );
1994 }
1995 }
1996
1997 $slots = RevisionSlotsUpdate::newFromContent( [ SlotRecord::MAIN => $content ] );
1998 $updater = $this->getDerivedDataUpdater( $user, $revision, $slots );
1999
2000 if ( !$updater->isUpdatePrepared() ) {
2001 $updater->prepareContent( $user, $slots, $useCache );
2002
2003 if ( $revision ) {
2004 $updater->prepareUpdate(
2005 $revision,
2006 [
2007 'causeAction' => 'prepare-edit',
2008 'causeAgent' => $user->getName(),
2009 ]
2010 );
2011 }
2012 }
2013
2014 return $updater->getPreparedEdit();
2015 }
2016
2017 /**
2018 * Do standard deferred updates after page edit.
2019 * Update links tables, site stats, search index and message cache.
2020 * Purges pages that include this page if the text was changed here.
2021 * Every 100th edit, prune the recent changes table.
2022 *
2023 * @deprecated since 1.32, use PageUpdater::doUpdates instead.
2024 *
2025 * @param Revision $revision
2026 * @param User $user User object that did the revision
2027 * @param array $options Array of options, following indexes are used:
2028 * - changed: bool, whether the revision changed the content (default true)
2029 * - created: bool, whether the revision created the page (default false)
2030 * - moved: bool, whether the page was moved (default false)
2031 * - restored: bool, whether the page was undeleted (default false)
2032 * - oldrevision: Revision object for the pre-update revision (default null)
2033 * - oldcountable: bool, null, or string 'no-change' (default null):
2034 * - bool: whether the page was counted as an article before that
2035 * revision, only used in changed is true and created is false
2036 * - null: if created is false, don't update the article count; if created
2037 * is true, do update the article count
2038 * - 'no-change': don't update the article count, ever
2039 * - causeAction: an arbitrary string identifying the reason for the update.
2040 * See DataUpdate::getCauseAction(). (default 'edit-page')
2041 * - causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent().
2042 * (string, defaults to the passed user)
2043 */
2044 public function doEditUpdates( Revision $revision, User $user, array $options = [] ) {
2045 $options += [
2046 'causeAction' => 'edit-page',
2047 'causeAgent' => $user->getName(),
2048 ];
2049
2050 $revision = $revision->getRevisionRecord();
2051
2052 $updater = $this->getDerivedDataUpdater( $user, $revision );
2053
2054 $updater->prepareUpdate( $revision, $options );
2055
2056 $updater->doUpdates();
2057 }
2058
2059 /**
2060 * Update the parser cache.
2061 *
2062 * @note This is a temporary workaround until there is a proper data updater class.
2063 * It will become deprecated soon.
2064 *
2065 * @param array $options
2066 * - causeAction: an arbitrary string identifying the reason for the update.
2067 * See DataUpdate::getCauseAction(). (default 'edit-page')
2068 * - causeAgent: name of the user who caused the update (string, defaults to the
2069 * user who created the revision)
2070 * @since 1.32
2071 */
2072 public function updateParserCache( array $options = [] ) {
2073 $revision = $this->getRevisionRecord();
2074 if ( !$revision || !$revision->getId() ) {
2075 LoggerFactory::getInstance( 'wikipage' )->info(
2076 __METHOD__ . 'called with ' . ( $revision ? 'unsaved' : 'no' ) . ' revision'
2077 );
2078 return;
2079 }
2080 $user = User::newFromIdentity( $revision->getUser( RevisionRecord::RAW ) );
2081
2082 $updater = $this->getDerivedDataUpdater( $user, $revision );
2083 $updater->prepareUpdate( $revision, $options );
2084 $updater->doParserCacheUpdate();
2085 }
2086
2087 /**
2088 * Do secondary data updates (such as updating link tables).
2089 * Secondary data updates are only a small part of the updates needed after saving
2090 * a new revision; normally PageUpdater::doUpdates should be used instead (which includes
2091 * secondary data updates). This method is provided for partial purges.
2092 *
2093 * @note This is a temporary workaround until there is a proper data updater class.
2094 * It will become deprecated soon.
2095 *
2096 * @param array $options
2097 * - recursive (bool, default true): whether to do a recursive update (update pages that
2098 * depend on this page, e.g. transclude it). This will set the $recursive parameter of
2099 * Content::getSecondaryDataUpdates. Typically this should be true unless the update
2100 * was something that did not really change the page, such as a null edit.
2101 * - triggeringUser: The user triggering the update (UserIdentity, defaults to the
2102 * user who created the revision)
2103 * - causeAction: an arbitrary string identifying the reason for the update.
2104 * See DataUpdate::getCauseAction(). (default 'unknown')
2105 * - causeAgent: name of the user who caused the update (string, default 'unknown')
2106 * - defer: one of the DeferredUpdates constants, or false to run immediately (default: false).
2107 * Note that even when this is set to false, some updates might still get deferred (as
2108 * some update might directly add child updates to DeferredUpdates).
2109 * @since 1.32
2110 */
2111 public function doSecondaryDataUpdates( array $options = [] ) {
2112 $options['recursive'] = $options['recursive'] ?? true;
2113 $revision = $this->getRevisionRecord();
2114 if ( !$revision || !$revision->getId() ) {
2115 LoggerFactory::getInstance( 'wikipage' )->info(
2116 __METHOD__ . 'called with ' . ( $revision ? 'unsaved' : 'no' ) . ' revision'
2117 );
2118 return;
2119 }
2120 $user = User::newFromIdentity( $revision->getUser( RevisionRecord::RAW ) );
2121
2122 $updater = $this->getDerivedDataUpdater( $user, $revision );
2123 $updater->prepareUpdate( $revision, $options );
2124 $updater->doSecondaryDataUpdates( $options );
2125 }
2126
2127 /**
2128 * Update the article's restriction field, and leave a log entry.
2129 * This works for protection both existing and non-existing pages.
2130 *
2131 * @param array $limit Set of restriction keys
2132 * @param array $expiry Per restriction type expiration
2133 * @param int &$cascade Set to false if cascading protection isn't allowed.
2134 * @param string $reason
2135 * @param User $user The user updating the restrictions
2136 * @param string|string[]|null $tags Change tags to add to the pages and protection log entries
2137 * ($user should be able to add the specified tags before this is called)
2138 * @return Status Status object; if action is taken, $status->value is the log_id of the
2139 * protection log entry.
2140 */
2141 public function doUpdateRestrictions( array $limit, array $expiry,
2142 &$cascade, $reason, User $user, $tags = null
2143 ) {
2144 global $wgCascadingRestrictionLevels;
2145
2146 if ( wfReadOnly() ) {
2147 return Status::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2148 }
2149
2150 $this->loadPageData( 'fromdbmaster' );
2151 $this->mTitle->loadRestrictions( null, Title::READ_LATEST );
2152 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2153 $id = $this->getId();
2154
2155 if ( !$cascade ) {
2156 $cascade = false;
2157 }
2158
2159 // Take this opportunity to purge out expired restrictions
2160 Title::purgeExpiredRestrictions();
2161
2162 // @todo: Same limitations as described in ProtectionForm.php (line 37);
2163 // we expect a single selection, but the schema allows otherwise.
2164 $isProtected = false;
2165 $protect = false;
2166 $changed = false;
2167
2168 $dbw = wfGetDB( DB_MASTER );
2169
2170 foreach ( $restrictionTypes as $action ) {
2171 if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) {
2172 $expiry[$action] = 'infinity';
2173 }
2174 if ( !isset( $limit[$action] ) ) {
2175 $limit[$action] = '';
2176 } elseif ( $limit[$action] != '' ) {
2177 $protect = true;
2178 }
2179
2180 // Get current restrictions on $action
2181 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2182 if ( $current != '' ) {
2183 $isProtected = true;
2184 }
2185
2186 if ( $limit[$action] != $current ) {
2187 $changed = true;
2188 } elseif ( $limit[$action] != '' ) {
2189 // Only check expiry change if the action is actually being
2190 // protected, since expiry does nothing on an not-protected
2191 // action.
2192 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2193 $changed = true;
2194 }
2195 }
2196 }
2197
2198 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2199 $changed = true;
2200 }
2201
2202 // If nothing has changed, do nothing
2203 if ( !$changed ) {
2204 return Status::newGood();
2205 }
2206
2207 if ( !$protect ) { // No protection at all means unprotection
2208 $revCommentMsg = 'unprotectedarticle-comment';
2209 $logAction = 'unprotect';
2210 } elseif ( $isProtected ) {
2211 $revCommentMsg = 'modifiedarticleprotection-comment';
2212 $logAction = 'modify';
2213 } else {
2214 $revCommentMsg = 'protectedarticle-comment';
2215 $logAction = 'protect';
2216 }
2217
2218 $logRelationsValues = [];
2219 $logRelationsField = null;
2220 $logParamsDetails = [];
2221
2222 // Null revision (used for change tag insertion)
2223 $nullRevision = null;
2224
2225 if ( $id ) { // Protection of existing page
2226 // Avoid PHP 7.1 warning of passing $this by reference
2227 $wikiPage = $this;
2228
2229 if ( !Hooks::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2230 return Status::newGood();
2231 }
2232
2233 // Only certain restrictions can cascade...
2234 $editrestriction = isset( $limit['edit'] )
2235 ? [ $limit['edit'] ]
2236 : $this->mTitle->getRestrictions( 'edit' );
2237 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2238 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2239 }
2240 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2241 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2242 }
2243
2244 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2245 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2246 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2247 }
2248 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2249 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2250 }
2251
2252 // The schema allows multiple restrictions
2253 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2254 $cascade = false;
2255 }
2256
2257 // insert null revision to identify the page protection change as edit summary
2258 $latest = $this->getLatest();
2259 $nullRevision = $this->insertProtectNullRevision(
2260 $revCommentMsg,
2261 $limit,
2262 $expiry,
2263 $cascade,
2264 $reason,
2265 $user
2266 );
2267
2268 if ( $nullRevision === null ) {
2269 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2270 }
2271
2272 $logRelationsField = 'pr_id';
2273
2274 // Update restrictions table
2275 foreach ( $limit as $action => $restrictions ) {
2276 $dbw->delete(
2277 'page_restrictions',
2278 [
2279 'pr_page' => $id,
2280 'pr_type' => $action
2281 ],
2282 __METHOD__
2283 );
2284 if ( $restrictions != '' ) {
2285 $cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0;
2286 $dbw->insert(
2287 'page_restrictions',
2288 [
2289 'pr_page' => $id,
2290 'pr_type' => $action,
2291 'pr_level' => $restrictions,
2292 'pr_cascade' => $cascadeValue,
2293 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2294 ],
2295 __METHOD__
2296 );
2297 $logRelationsValues[] = $dbw->insertId();
2298 $logParamsDetails[] = [
2299 'type' => $action,
2300 'level' => $restrictions,
2301 'expiry' => $expiry[$action],
2302 'cascade' => (bool)$cascadeValue,
2303 ];
2304 }
2305 }
2306
2307 // Clear out legacy restriction fields
2308 $dbw->update(
2309 'page',
2310 [ 'page_restrictions' => '' ],
2311 [ 'page_id' => $id ],
2312 __METHOD__
2313 );
2314
2315 // Avoid PHP 7.1 warning of passing $this by reference
2316 $wikiPage = $this;
2317
2318 Hooks::run( 'NewRevisionFromEditComplete',
2319 [ $this, $nullRevision, $latest, $user ] );
2320 Hooks::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2321 } else { // Protection of non-existing page (also known as "title protection")
2322 // Cascade protection is meaningless in this case
2323 $cascade = false;
2324
2325 if ( $limit['create'] != '' ) {
2326 $commentFields = CommentStore::getStore()->insert( $dbw, 'pt_reason', $reason );
2327 $dbw->replace( 'protected_titles',
2328 [ [ 'pt_namespace', 'pt_title' ] ],
2329 [
2330 'pt_namespace' => $this->mTitle->getNamespace(),
2331 'pt_title' => $this->mTitle->getDBkey(),
2332 'pt_create_perm' => $limit['create'],
2333 'pt_timestamp' => $dbw->timestamp(),
2334 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2335 'pt_user' => $user->getId(),
2336 ] + $commentFields, __METHOD__
2337 );
2338 $logParamsDetails[] = [
2339 'type' => 'create',
2340 'level' => $limit['create'],
2341 'expiry' => $expiry['create'],
2342 ];
2343 } else {
2344 $dbw->delete( 'protected_titles',
2345 [
2346 'pt_namespace' => $this->mTitle->getNamespace(),
2347 'pt_title' => $this->mTitle->getDBkey()
2348 ], __METHOD__
2349 );
2350 }
2351 }
2352
2353 $this->mTitle->flushRestrictions();
2354 InfoAction::invalidateCache( $this->mTitle );
2355
2356 if ( $logAction == 'unprotect' ) {
2357 $params = [];
2358 } else {
2359 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2360 $params = [
2361 '4::description' => $protectDescriptionLog, // parameter for IRC
2362 '5:bool:cascade' => $cascade,
2363 'details' => $logParamsDetails, // parameter for localize and api
2364 ];
2365 }
2366
2367 // Update the protection log
2368 $logEntry = new ManualLogEntry( 'protect', $logAction );
2369 $logEntry->setTarget( $this->mTitle );
2370 $logEntry->setComment( $reason );
2371 $logEntry->setPerformer( $user );
2372 $logEntry->setParameters( $params );
2373 if ( !is_null( $nullRevision ) ) {
2374 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2375 }
2376 $logEntry->setTags( $tags );
2377 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2378 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2379 }
2380 $logId = $logEntry->insert();
2381 $logEntry->publish( $logId );
2382
2383 return Status::newGood( $logId );
2384 }
2385
2386 /**
2387 * Insert a new null revision for this page.
2388 *
2389 * @param string $revCommentMsg Comment message key for the revision
2390 * @param array $limit Set of restriction keys
2391 * @param array $expiry Per restriction type expiration
2392 * @param int $cascade Set to false if cascading protection isn't allowed.
2393 * @param string $reason
2394 * @param User|null $user
2395 * @return Revision|null Null on error
2396 */
2397 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2398 array $expiry, $cascade, $reason, $user = null
2399 ) {
2400 $dbw = wfGetDB( DB_MASTER );
2401
2402 // Prepare a null revision to be added to the history
2403 $editComment = wfMessage(
2404 $revCommentMsg,
2405 $this->mTitle->getPrefixedText(),
2406 $user ? $user->getName() : ''
2407 )->inContentLanguage()->text();
2408 if ( $reason ) {
2409 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2410 }
2411 $protectDescription = $this->protectDescription( $limit, $expiry );
2412 if ( $protectDescription ) {
2413 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2414 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2415 ->inContentLanguage()->text();
2416 }
2417 if ( $cascade ) {
2418 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2419 $editComment .= wfMessage( 'brackets' )->params(
2420 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2421 )->inContentLanguage()->text();
2422 }
2423
2424 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2425 if ( $nullRev ) {
2426 $nullRev->insertOn( $dbw );
2427
2428 // Update page record and touch page
2429 $oldLatest = $nullRev->getParentId();
2430 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2431 }
2432
2433 return $nullRev;
2434 }
2435
2436 /**
2437 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2438 * @return string
2439 */
2440 protected function formatExpiry( $expiry ) {
2441 if ( $expiry != 'infinity' ) {
2442 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
2443 return wfMessage(
2444 'protect-expiring',
2445 $contLang->timeanddate( $expiry, false, false ),
2446 $contLang->date( $expiry, false, false ),
2447 $contLang->time( $expiry, false, false )
2448 )->inContentLanguage()->text();
2449 } else {
2450 return wfMessage( 'protect-expiry-indefinite' )
2451 ->inContentLanguage()->text();
2452 }
2453 }
2454
2455 /**
2456 * Builds the description to serve as comment for the edit.
2457 *
2458 * @param array $limit Set of restriction keys
2459 * @param array $expiry Per restriction type expiration
2460 * @return string
2461 */
2462 public function protectDescription( array $limit, array $expiry ) {
2463 $protectDescription = '';
2464
2465 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2466 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2467 # All possible message keys are listed here for easier grepping:
2468 # * restriction-create
2469 # * restriction-edit
2470 # * restriction-move
2471 # * restriction-upload
2472 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2473 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2474 # with '' filtered out. All possible message keys are listed below:
2475 # * protect-level-autoconfirmed
2476 # * protect-level-sysop
2477 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2478 ->inContentLanguage()->text();
2479
2480 $expiryText = $this->formatExpiry( $expiry[$action] );
2481
2482 if ( $protectDescription !== '' ) {
2483 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2484 }
2485 $protectDescription .= wfMessage( 'protect-summary-desc' )
2486 ->params( $actionText, $restrictionsText, $expiryText )
2487 ->inContentLanguage()->text();
2488 }
2489
2490 return $protectDescription;
2491 }
2492
2493 /**
2494 * Builds the description to serve as comment for the log entry.
2495 *
2496 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2497 * protect description text. Keep them in old format to avoid breaking compatibility.
2498 * TODO: Fix protection log to store structured description and format it on-the-fly.
2499 *
2500 * @param array $limit Set of restriction keys
2501 * @param array $expiry Per restriction type expiration
2502 * @return string
2503 */
2504 public function protectDescriptionLog( array $limit, array $expiry ) {
2505 $protectDescriptionLog = '';
2506
2507 $dirMark = MediaWikiServices::getInstance()->getContentLanguage()->getDirMark();
2508 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2509 $expiryText = $this->formatExpiry( $expiry[$action] );
2510 $protectDescriptionLog .=
2511 $dirMark .
2512 "[$action=$restrictions] ($expiryText)";
2513 }
2514
2515 return trim( $protectDescriptionLog );
2516 }
2517
2518 /**
2519 * Take an array of page restrictions and flatten it to a string
2520 * suitable for insertion into the page_restrictions field.
2521 *
2522 * @param string[] $limit
2523 *
2524 * @throws MWException
2525 * @return string
2526 */
2527 protected static function flattenRestrictions( $limit ) {
2528 if ( !is_array( $limit ) ) {
2529 throw new MWException( __METHOD__ . ' given non-array restriction set' );
2530 }
2531
2532 $bits = [];
2533 ksort( $limit );
2534
2535 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2536 $bits[] = "$action=$restrictions";
2537 }
2538
2539 return implode( ':', $bits );
2540 }
2541
2542 /**
2543 * Determines if deletion of this page would be batched (executed over time by the job queue)
2544 * or not (completed in the same request as the delete call).
2545 *
2546 * It is unlikely but possible that an edit from another request could push the page over the
2547 * batching threshold after this function is called, but before the caller acts upon the
2548 * return value. Callers must decide for themselves how to deal with this. $safetyMargin
2549 * is provided as an unreliable but situationally useful help for some common cases.
2550 *
2551 * @param int $safetyMargin Added to the revision count when checking for batching
2552 * @return bool True if deletion would be batched, false otherwise
2553 */
2554 public function isBatchedDelete( $safetyMargin = 0 ) {
2555 global $wgDeleteRevisionsBatchSize;
2556
2557 $dbr = wfGetDB( DB_REPLICA );
2558 $revCount = $this->getRevisionStore()->countRevisionsByPageId( $dbr, $this->getId() );
2559 $revCount += $safetyMargin;
2560
2561 return $revCount >= $wgDeleteRevisionsBatchSize;
2562 }
2563
2564 /**
2565 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2566 * backwards compatibility, if you care about error reporting you should use
2567 * doDeleteArticleReal() instead.
2568 *
2569 * Deletes the article with database consistency, writes logs, purges caches
2570 *
2571 * @param string $reason Delete reason for deletion log
2572 * @param bool $suppress Suppress all revisions and log the deletion in
2573 * the suppression log instead of the deletion log
2574 * @param int|null $u1 Unused
2575 * @param bool|null $u2 Unused
2576 * @param array|string &$error Array of errors to append to
2577 * @param User|null $user The deleting user
2578 * @param bool $immediate false allows deleting over time via the job queue
2579 * @return bool True if successful
2580 * @throws FatalError
2581 * @throws MWException
2582 */
2583 public function doDeleteArticle(
2584 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null,
2585 $immediate = false
2586 ) {
2587 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user,
2588 [], 'delete', $immediate );
2589
2590 // Returns true if the page was actually deleted, or is scheduled for deletion
2591 return $status->isOK();
2592 }
2593
2594 /**
2595 * Back-end article deletion
2596 * Deletes the article with database consistency, writes logs, purges caches
2597 *
2598 * @since 1.19
2599 *
2600 * @param string $reason Delete reason for deletion log
2601 * @param bool $suppress Suppress all revisions and log the deletion in
2602 * the suppression log instead of the deletion log
2603 * @param int|null $u1 Unused
2604 * @param bool|null $u2 Unused
2605 * @param array|string &$error Array of errors to append to
2606 * @param User|null $deleter The deleting user
2607 * @param array $tags Tags to apply to the deletion action
2608 * @param string $logsubtype
2609 * @param bool $immediate false allows deleting over time via the job queue
2610 * @return Status Status object; if successful, $status->value is the log_id of the
2611 * deletion log entry. If the page couldn't be deleted because it wasn't
2612 * found, $status is a non-fatal 'cannotdelete' error
2613 * @throws FatalError
2614 * @throws MWException
2615 */
2616 public function doDeleteArticleReal(
2617 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $deleter = null,
2618 $tags = [], $logsubtype = 'delete', $immediate = false
2619 ) {
2620 global $wgUser;
2621
2622 wfDebug( __METHOD__ . "\n" );
2623
2624 $status = Status::newGood();
2625
2626 // Avoid PHP 7.1 warning of passing $this by reference
2627 $wikiPage = $this;
2628
2629 if ( !$deleter ) {
2630 $deleter = $wgUser;
2631 }
2632 if ( !Hooks::run( 'ArticleDelete',
2633 [ &$wikiPage, &$deleter, &$reason, &$error, &$status, $suppress ]
2634 ) ) {
2635 if ( $status->isOK() ) {
2636 // Hook aborted but didn't set a fatal status
2637 $status->fatal( 'delete-hook-aborted' );
2638 }
2639 return $status;
2640 }
2641
2642 return $this->doDeleteArticleBatched( $reason, $suppress, $deleter, $tags,
2643 $logsubtype, $immediate );
2644 }
2645
2646 /**
2647 * Back-end article deletion
2648 *
2649 * Only invokes batching via the job queue if necessary per $wgDeleteRevisionsBatchSize.
2650 * Deletions can often be completed inline without involving the job queue.
2651 *
2652 * Potentially called many times per deletion operation for pages with many revisions.
2653 */
2654 public function doDeleteArticleBatched(
2655 $reason, $suppress, User $deleter, $tags,
2656 $logsubtype, $immediate = false, $webRequestId = null
2657 ) {
2658 wfDebug( __METHOD__ . "\n" );
2659
2660 $status = Status::newGood();
2661
2662 $dbw = wfGetDB( DB_MASTER );
2663 $dbw->startAtomic( __METHOD__ );
2664
2665 $this->loadPageData( self::READ_LATEST );
2666 $id = $this->getId();
2667 // T98706: lock the page from various other updates but avoid using
2668 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2669 // the revisions queries (which also JOIN on user). Only lock the page
2670 // row and CAS check on page_latest to see if the trx snapshot matches.
2671 $lockedLatest = $this->lockAndGetLatest();
2672 if ( $id == 0 || $this->getLatest() != $lockedLatest ) {
2673 $dbw->endAtomic( __METHOD__ );
2674 // Page not there or trx snapshot is stale
2675 $status->error( 'cannotdelete',
2676 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2677 return $status;
2678 }
2679
2680 // At this point we are now committed to returning an OK
2681 // status unless some DB query error or other exception comes up.
2682 // This way callers don't have to call rollback() if $status is bad
2683 // unless they actually try to catch exceptions (which is rare).
2684
2685 // we need to remember the old content so we can use it to generate all deletion updates.
2686 $revision = $this->getRevision();
2687 try {
2688 $content = $this->getContent( Revision::RAW );
2689 } catch ( Exception $ex ) {
2690 wfLogWarning( __METHOD__ . ': failed to load content during deletion! '
2691 . $ex->getMessage() );
2692
2693 $content = null;
2694 }
2695
2696 // Archive revisions. In immediate mode, archive all revisions. Otherwise, archive
2697 // one batch of revisions and defer archival of any others to the job queue.
2698 $explictTrxLogged = false;
2699 while ( true ) {
2700 $done = $this->archiveRevisions( $dbw, $id, $suppress );
2701 if ( $done || !$immediate ) {
2702 break;
2703 }
2704 $dbw->endAtomic( __METHOD__ );
2705 if ( $dbw->explicitTrxActive() ) {
2706 // Explict transactions may never happen here in practice. Log to be sure.
2707 if ( !$explictTrxLogged ) {
2708 $explictTrxLogged = true;
2709 LoggerFactory::getInstance( 'wfDebug' )->debug(
2710 'explicit transaction active in ' . __METHOD__ . ' while deleting {title}', [
2711 'title' => $this->getTitle()->getText(),
2712 ] );
2713 }
2714 continue;
2715 }
2716 if ( $dbw->trxLevel() ) {
2717 $dbw->commit();
2718 }
2719 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2720 $lbFactory->waitForReplication();
2721 $dbw->startAtomic( __METHOD__ );
2722 }
2723
2724 // If done archiving, also delete the article.
2725 if ( !$done ) {
2726 $dbw->endAtomic( __METHOD__ );
2727
2728 $jobParams = [
2729 'namespace' => $this->getTitle()->getNamespace(),
2730 'title' => $this->getTitle()->getDBkey(),
2731 'wikiPageId' => $id,
2732 'requestId' => $webRequestId ?? WebRequest::getRequestId(),
2733 'reason' => $reason,
2734 'suppress' => $suppress,
2735 'userId' => $deleter->getId(),
2736 'tags' => json_encode( $tags ),
2737 'logsubtype' => $logsubtype,
2738 ];
2739
2740 $job = new DeletePageJob( $jobParams );
2741 JobQueueGroup::singleton()->push( $job );
2742
2743 $status->warning( 'delete-scheduled',
2744 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2745 } else {
2746 // Get archivedRevisionCount by db query, because there's no better alternative.
2747 // Jobs cannot pass a count of archived revisions to the next job, because additional
2748 // deletion operations can be started while the first is running. Jobs from each
2749 // gracefully interleave, but would not know about each other's count. Deduplication
2750 // in the job queue to avoid simultaneous deletion operations would add overhead.
2751 // Number of archived revisions cannot be known beforehand, because edits can be made
2752 // while deletion operations are being processed, changing the number of archivals.
2753 $archivedRevisionCount = (int)$dbw->selectField(
2754 'archive', 'COUNT(*)',
2755 [
2756 'ar_namespace' => $this->getTitle()->getNamespace(),
2757 'ar_title' => $this->getTitle()->getDBkey(),
2758 'ar_page_id' => $id
2759 ], __METHOD__
2760 );
2761
2762 // Clone the title and wikiPage, so we have the information we need when
2763 // we log and run the ArticleDeleteComplete hook.
2764 $logTitle = clone $this->mTitle;
2765 $wikiPageBeforeDelete = clone $this;
2766
2767 // Now that it's safely backed up, delete it
2768 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__ );
2769
2770 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2771 $logtype = $suppress ? 'suppress' : 'delete';
2772
2773 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2774 $logEntry->setPerformer( $deleter );
2775 $logEntry->setTarget( $logTitle );
2776 $logEntry->setComment( $reason );
2777 $logEntry->setTags( $tags );
2778 $logid = $logEntry->insert();
2779
2780 $dbw->onTransactionPreCommitOrIdle(
2781 function () use ( $logEntry, $logid ) {
2782 // T58776: avoid deadlocks (especially from FileDeleteForm)
2783 $logEntry->publish( $logid );
2784 },
2785 __METHOD__
2786 );
2787
2788 $dbw->endAtomic( __METHOD__ );
2789
2790 $this->doDeleteUpdates( $id, $content, $revision, $deleter );
2791
2792 Hooks::run( 'ArticleDeleteComplete', [
2793 &$wikiPageBeforeDelete,
2794 &$deleter,
2795 $reason,
2796 $id,
2797 $content,
2798 $logEntry,
2799 $archivedRevisionCount
2800 ] );
2801 $status->value = $logid;
2802
2803 // Show log excerpt on 404 pages rather than just a link
2804 $cache = MediaWikiServices::getInstance()->getMainObjectStash();
2805 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2806 $cache->set( $key, 1, $cache::TTL_DAY );
2807 }
2808
2809 return $status;
2810 }
2811
2812 /**
2813 * Archives revisions as part of page deletion.
2814 *
2815 * @param IDatabase $dbw
2816 * @param int $id
2817 * @param bool $suppress Suppress all revisions and log the deletion in
2818 * the suppression log instead of the deletion log
2819 * @return bool
2820 */
2821 protected function archiveRevisions( $dbw, $id, $suppress ) {
2822 global $wgContentHandlerUseDB, $wgMultiContentRevisionSchemaMigrationStage,
2823 $wgActorTableSchemaMigrationStage, $wgDeleteRevisionsBatchSize;
2824
2825 // Given the lock above, we can be confident in the title and page ID values
2826 $namespace = $this->getTitle()->getNamespace();
2827 $dbKey = $this->getTitle()->getDBkey();
2828
2829 $commentStore = CommentStore::getStore();
2830 $actorMigration = ActorMigration::newMigration();
2831
2832 $revQuery = Revision::getQueryInfo();
2833 $bitfield = false;
2834
2835 // Bitfields to further suppress the content
2836 if ( $suppress ) {
2837 $bitfield = Revision::SUPPRESSED_ALL;
2838 $revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
2839 }
2840
2841 // For now, shunt the revision data into the archive table.
2842 // Text is *not* removed from the text table; bulk storage
2843 // is left intact to avoid breaking block-compression or
2844 // immutable storage schemes.
2845 // In the future, we may keep revisions and mark them with
2846 // the rev_deleted field, which is reserved for this purpose.
2847
2848 // Lock rows in `revision` and its temp tables, but not any others.
2849 // Note array_intersect() preserves keys from the first arg, and we're
2850 // assuming $revQuery has `revision` primary and isn't using subtables
2851 // for anything we care about.
2852 $dbw->lockForUpdate(
2853 array_intersect(
2854 $revQuery['tables'],
2855 [ 'revision', 'revision_comment_temp', 'revision_actor_temp' ]
2856 ),
2857 [ 'rev_page' => $id ],
2858 __METHOD__,
2859 [],
2860 $revQuery['joins']
2861 );
2862
2863 // If SCHEMA_COMPAT_WRITE_OLD is set, also select all extra fields we still write,
2864 // so we can copy it to the archive table.
2865 // We know the fields exist, otherwise SCHEMA_COMPAT_WRITE_OLD could not function.
2866 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
2867 $revQuery['fields'][] = 'rev_text_id';
2868
2869 if ( $wgContentHandlerUseDB ) {
2870 $revQuery['fields'][] = 'rev_content_model';
2871 $revQuery['fields'][] = 'rev_content_format';
2872 }
2873 }
2874
2875 // Get as many of the page revisions as we are allowed to. The +1 lets us recognize the
2876 // unusual case where there were exactly $wgDeleteRevisionBatchSize revisions remaining.
2877 $res = $dbw->select(
2878 $revQuery['tables'],
2879 $revQuery['fields'],
2880 [ 'rev_page' => $id ],
2881 __METHOD__,
2882 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => $wgDeleteRevisionsBatchSize + 1 ],
2883 $revQuery['joins']
2884 );
2885
2886 // Build their equivalent archive rows
2887 $rowsInsert = [];
2888 $revids = [];
2889
2890 /** @var int[] Revision IDs of edits that were made by IPs */
2891 $ipRevIds = [];
2892
2893 $done = true;
2894 foreach ( $res as $row ) {
2895 if ( count( $revids ) >= $wgDeleteRevisionsBatchSize ) {
2896 $done = false;
2897 break;
2898 }
2899
2900 $comment = $commentStore->getComment( 'rev_comment', $row );
2901 $user = User::newFromAnyId( $row->rev_user, $row->rev_user_text, $row->rev_actor );
2902 $rowInsert = [
2903 'ar_namespace' => $namespace,
2904 'ar_title' => $dbKey,
2905 'ar_timestamp' => $row->rev_timestamp,
2906 'ar_minor_edit' => $row->rev_minor_edit,
2907 'ar_rev_id' => $row->rev_id,
2908 'ar_parent_id' => $row->rev_parent_id,
2909 /**
2910 * ar_text_id should probably not be written to when the multi content schema has
2911 * been migrated to (wgMultiContentRevisionSchemaMigrationStage) however there is no
2912 * default for the field in WMF production currently so we must keep writing
2913 * writing until a default of 0 is set.
2914 * Task: https://phabricator.wikimedia.org/T190148
2915 * Copying the value from the revision table should not lead to any issues for now.
2916 */
2917 'ar_len' => $row->rev_len,
2918 'ar_page_id' => $id,
2919 'ar_deleted' => $suppress ? $bitfield : $row->rev_deleted,
2920 'ar_sha1' => $row->rev_sha1,
2921 ] + $commentStore->insert( $dbw, 'ar_comment', $comment )
2922 + $actorMigration->getInsertValues( $dbw, 'ar_user', $user );
2923
2924 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
2925 $rowInsert['ar_text_id'] = $row->rev_text_id;
2926
2927 if ( $wgContentHandlerUseDB ) {
2928 $rowInsert['ar_content_model'] = $row->rev_content_model;
2929 $rowInsert['ar_content_format'] = $row->rev_content_format;
2930 }
2931 }
2932
2933 $rowsInsert[] = $rowInsert;
2934 $revids[] = $row->rev_id;
2935
2936 // Keep track of IP edits, so that the corresponding rows can
2937 // be deleted in the ip_changes table.
2938 if ( (int)$row->rev_user === 0 && IP::isValid( $row->rev_user_text ) ) {
2939 $ipRevIds[] = $row->rev_id;
2940 }
2941 }
2942
2943 // This conditional is just a sanity check
2944 if ( count( $revids ) > 0 ) {
2945 // Copy them into the archive table
2946 $dbw->insert( 'archive', $rowsInsert, __METHOD__ );
2947
2948 $dbw->delete( 'revision', [ 'rev_id' => $revids ], __METHOD__ );
2949 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__ );
2950 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
2951 $dbw->delete( 'revision_actor_temp', [ 'revactor_rev' => $revids ], __METHOD__ );
2952 }
2953
2954 // Also delete records from ip_changes as applicable.
2955 if ( count( $ipRevIds ) > 0 ) {
2956 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__ );
2957 }
2958 }
2959
2960 return $done;
2961 }
2962
2963 /**
2964 * Lock the page row for this title+id and return page_latest (or 0)
2965 *
2966 * @return int Returns 0 if no row was found with this title+id
2967 * @since 1.27
2968 */
2969 public function lockAndGetLatest() {
2970 return (int)wfGetDB( DB_MASTER )->selectField(
2971 'page',
2972 'page_latest',
2973 [
2974 'page_id' => $this->getId(),
2975 // Typically page_id is enough, but some code might try to do
2976 // updates assuming the title is the same, so verify that
2977 'page_namespace' => $this->getTitle()->getNamespace(),
2978 'page_title' => $this->getTitle()->getDBkey()
2979 ],
2980 __METHOD__,
2981 [ 'FOR UPDATE' ]
2982 );
2983 }
2984
2985 /**
2986 * Do some database updates after deletion
2987 *
2988 * @param int $id The page_id value of the page being deleted
2989 * @param Content|null $content Page content to be used when determining
2990 * the required updates. This may be needed because $this->getContent()
2991 * may already return null when the page proper was deleted.
2992 * @param Revision|null $revision The current page revision at the time of
2993 * deletion, used when determining the required updates. This may be needed because
2994 * $this->getRevision() may already return null when the page proper was deleted.
2995 * @param User|null $user The user that caused the deletion
2996 */
2997 public function doDeleteUpdates(
2998 $id, Content $content = null, Revision $revision = null, User $user = null
2999 ) {
3000 if ( $id !== $this->getId() ) {
3001 throw new InvalidArgumentException( 'Mismatching page ID' );
3002 }
3003
3004 try {
3005 $countable = $this->isCountable();
3006 } catch ( Exception $ex ) {
3007 // fallback for deleting broken pages for which we cannot load the content for
3008 // some reason. Note that doDeleteArticleReal() already logged this problem.
3009 $countable = false;
3010 }
3011
3012 // Update site status
3013 DeferredUpdates::addUpdate( SiteStatsUpdate::factory(
3014 [ 'edits' => 1, 'articles' => -$countable, 'pages' => -1 ]
3015 ) );
3016
3017 // Delete pagelinks, update secondary indexes, etc
3018 $updates = $this->getDeletionUpdates(
3019 $revision ? $revision->getRevisionRecord() : $content
3020 );
3021 foreach ( $updates as $update ) {
3022 DeferredUpdates::addUpdate( $update );
3023 }
3024
3025 $causeAgent = $user ? $user->getName() : 'unknown';
3026 // Reparse any pages transcluding this page
3027 LinksUpdate::queueRecursiveJobsForTable(
3028 $this->mTitle, 'templatelinks', 'delete-page', $causeAgent );
3029 // Reparse any pages including this image
3030 if ( $this->mTitle->getNamespace() == NS_FILE ) {
3031 LinksUpdate::queueRecursiveJobsForTable(
3032 $this->mTitle, 'imagelinks', 'delete-page', $causeAgent );
3033 }
3034
3035 // Clear caches
3036 self::onArticleDelete( $this->mTitle );
3037 ResourceLoaderWikiModule::invalidateModuleCache(
3038 $this->mTitle,
3039 $revision,
3040 null,
3041 WikiMap::getCurrentWikiDbDomain()->getId()
3042 );
3043
3044 // Reset this object and the Title object
3045 $this->loadFromRow( false, self::READ_LATEST );
3046
3047 // Search engine
3048 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
3049 }
3050
3051 /**
3052 * Roll back the most recent consecutive set of edits to a page
3053 * from the same user; fails if there are no eligible edits to
3054 * roll back to, e.g. user is the sole contributor. This function
3055 * performs permissions checks on $user, then calls commitRollback()
3056 * to do the dirty work
3057 *
3058 * @todo Separate the business/permission stuff out from backend code
3059 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3060 *
3061 * @param string $fromP Name of the user whose edits to rollback.
3062 * @param string $summary Custom summary. Set to default summary if empty.
3063 * @param string $token Rollback token.
3064 * @param bool $bot If true, mark all reverted edits as bot.
3065 *
3066 * @param array &$resultDetails Array contains result-specific array of additional values
3067 * 'alreadyrolled' : 'current' (rev)
3068 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3069 *
3070 * @param User $user The user performing the rollback
3071 * @param array|null $tags Change tags to apply to the rollback
3072 * Callers are responsible for permission checks
3073 * (with ChangeTags::canAddTagsAccompanyingChange)
3074 *
3075 * @return array Array of errors, each error formatted as
3076 * array(messagekey, param1, param2, ...).
3077 * On success, the array is empty. This array can also be passed to
3078 * OutputPage::showPermissionsErrorPage().
3079 */
3080 public function doRollback(
3081 $fromP, $summary, $token, $bot, &$resultDetails, User $user, $tags = null
3082 ) {
3083 $resultDetails = null;
3084
3085 // Check permissions
3086 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
3087 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
3088 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3089
3090 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3091 $errors[] = [ 'sessionfailure' ];
3092 }
3093
3094 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
3095 $errors[] = [ 'actionthrottledtext' ];
3096 }
3097
3098 // If there were errors, bail out now
3099 if ( !empty( $errors ) ) {
3100 return $errors;
3101 }
3102
3103 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3104 }
3105
3106 /**
3107 * Backend implementation of doRollback(), please refer there for parameter
3108 * and return value documentation
3109 *
3110 * NOTE: This function does NOT check ANY permissions, it just commits the
3111 * rollback to the DB. Therefore, you should only call this function direct-
3112 * ly if you want to use custom permissions checks. If you don't, use
3113 * doRollback() instead.
3114 * @param string $fromP Name of the user whose edits to rollback.
3115 * @param string $summary Custom summary. Set to default summary if empty.
3116 * @param bool $bot If true, mark all reverted edits as bot.
3117 *
3118 * @param array &$resultDetails Contains result-specific array of additional values
3119 * @param User $guser The user performing the rollback
3120 * @param array|null $tags Change tags to apply to the rollback
3121 * Callers are responsible for permission checks
3122 * (with ChangeTags::canAddTagsAccompanyingChange)
3123 *
3124 * @return array An array of error messages, as returned by Status::getErrorsArray()
3125 */
3126 public function commitRollback( $fromP, $summary, $bot,
3127 &$resultDetails, User $guser, $tags = null
3128 ) {
3129 global $wgUseRCPatrol;
3130
3131 $dbw = wfGetDB( DB_MASTER );
3132
3133 if ( wfReadOnly() ) {
3134 return [ [ 'readonlytext' ] ];
3135 }
3136
3137 // Begin revision creation cycle by creating a PageUpdater.
3138 // If the page is changed concurrently after grabParentRevision(), the rollback will fail.
3139 $updater = $this->newPageUpdater( $guser );
3140 $current = $updater->grabParentRevision();
3141
3142 if ( is_null( $current ) ) {
3143 // Something wrong... no page?
3144 return [ [ 'notanarticle' ] ];
3145 }
3146
3147 $currentEditorForPublic = $current->getUser( RevisionRecord::FOR_PUBLIC );
3148 $legacyCurrent = new Revision( $current );
3149 $from = str_replace( '_', ' ', $fromP );
3150
3151 // User name given should match up with the top revision.
3152 // If the revision's user is not visible, then $from should be empty.
3153 if ( $from !== ( $currentEditorForPublic ? $currentEditorForPublic->getName() : '' ) ) {
3154 $resultDetails = [ 'current' => $legacyCurrent ];
3155 return [ [ 'alreadyrolled',
3156 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3157 htmlspecialchars( $fromP ),
3158 htmlspecialchars( $currentEditorForPublic ? $currentEditorForPublic->getName() : '' )
3159 ] ];
3160 }
3161
3162 // Get the last edit not by this person...
3163 // Note: these may not be public values
3164 $actorWhere = ActorMigration::newMigration()->getWhere(
3165 $dbw,
3166 'rev_user',
3167 $current->getUser( RevisionRecord::RAW )
3168 );
3169
3170 $s = $dbw->selectRow(
3171 [ 'revision' ] + $actorWhere['tables'],
3172 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3173 [
3174 'rev_page' => $current->getPageId(),
3175 'NOT(' . $actorWhere['conds'] . ')',
3176 ],
3177 __METHOD__,
3178 [
3179 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
3180 'ORDER BY' => 'rev_timestamp DESC'
3181 ],
3182 $actorWhere['joins']
3183 );
3184 if ( $s === false ) {
3185 // No one else ever edited this page
3186 return [ [ 'cantrollback' ] ];
3187 } elseif ( $s->rev_deleted & RevisionRecord::DELETED_TEXT
3188 || $s->rev_deleted & RevisionRecord::DELETED_USER
3189 ) {
3190 // Only admins can see this text
3191 return [ [ 'notvisiblerev' ] ];
3192 }
3193
3194 // Generate the edit summary if necessary
3195 $target = $this->getRevisionStore()->getRevisionById(
3196 $s->rev_id,
3197 RevisionStore::READ_LATEST
3198 );
3199 if ( empty( $summary ) ) {
3200 if ( !$currentEditorForPublic ) { // no public user name
3201 $summary = wfMessage( 'revertpage-nouser' );
3202 } else {
3203 $summary = wfMessage( 'revertpage' );
3204 }
3205 }
3206 $legacyTarget = new Revision( $target );
3207 $targetEditorForPublic = $target->getUser( RevisionRecord::FOR_PUBLIC );
3208
3209 // Allow the custom summary to use the same args as the default message
3210 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
3211 $args = [
3212 $targetEditorForPublic ? $targetEditorForPublic->getName() : null,
3213 $currentEditorForPublic ? $currentEditorForPublic->getName() : null,
3214 $s->rev_id,
3215 $contLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3216 $current->getId(),
3217 $contLang->timeanddate( $current->getTimestamp() )
3218 ];
3219 if ( $summary instanceof Message ) {
3220 $summary = $summary->params( $args )->inContentLanguage()->text();
3221 } else {
3222 $summary = wfMsgReplaceArgs( $summary, $args );
3223 }
3224
3225 // Trim spaces on user supplied text
3226 $summary = trim( $summary );
3227
3228 // Save
3229 $flags = EDIT_UPDATE | EDIT_INTERNAL;
3230
3231 if ( $guser->isAllowed( 'minoredit' ) ) {
3232 $flags |= EDIT_MINOR;
3233 }
3234
3235 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3236 $flags |= EDIT_FORCE_BOT;
3237 }
3238
3239 // TODO: MCR: also log model changes in other slots, in case that becomes possible!
3240 $currentContent = $current->getContent( SlotRecord::MAIN );
3241 $targetContent = $target->getContent( SlotRecord::MAIN );
3242 $changingContentModel = $targetContent->getModel() !== $currentContent->getModel();
3243
3244 if ( in_array( 'mw-rollback', ChangeTags::getSoftwareTags() ) ) {
3245 $tags[] = 'mw-rollback';
3246 }
3247
3248 // Build rollback revision:
3249 // Restore old content
3250 // TODO: MCR: test this once we can store multiple slots
3251 foreach ( $target->getSlots()->getSlots() as $slot ) {
3252 $updater->inheritSlot( $slot );
3253 }
3254
3255 // Remove extra slots
3256 // TODO: MCR: test this once we can store multiple slots
3257 foreach ( $current->getSlotRoles() as $role ) {
3258 if ( !$target->hasSlot( $role ) ) {
3259 $updater->removeSlot( $role );
3260 }
3261 }
3262
3263 $updater->setOriginalRevisionId( $target->getId() );
3264 // Do not call setUndidRevisionId(), that causes an extra "mw-undo" tag to be added (T190374)
3265 $updater->addTags( $tags );
3266
3267 // TODO: this logic should not be in the storage layer, it's here for compatibility
3268 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
3269 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
3270 if ( $wgUseRCPatrol && $this->getTitle()->userCan( 'autopatrol', $guser ) ) {
3271 $updater->setRcPatrolStatus( RecentChange::PRC_AUTOPATROLLED );
3272 }
3273
3274 // Actually store the rollback
3275 $rev = $updater->saveRevision(
3276 CommentStoreComment::newUnsavedComment( $summary ),
3277 $flags
3278 );
3279
3280 // Set patrolling and bot flag on the edits, which gets rollbacked.
3281 // This is done even on edit failure to have patrolling in that case (T64157).
3282 $set = [];
3283 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3284 // Mark all reverted edits as bot
3285 $set['rc_bot'] = 1;
3286 }
3287
3288 if ( $wgUseRCPatrol ) {
3289 // Mark all reverted edits as patrolled
3290 $set['rc_patrolled'] = RecentChange::PRC_AUTOPATROLLED;
3291 }
3292
3293 if ( count( $set ) ) {
3294 $actorWhere = ActorMigration::newMigration()->getWhere(
3295 $dbw,
3296 'rc_user',
3297 $current->getUser( RevisionRecord::RAW ),
3298 false
3299 );
3300 $dbw->update( 'recentchanges', $set,
3301 [ /* WHERE */
3302 'rc_cur_id' => $current->getPageId(),
3303 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3304 $actorWhere['conds'], // No tables/joins are needed for rc_user
3305 ],
3306 __METHOD__
3307 );
3308 }
3309
3310 if ( !$updater->wasSuccessful() ) {
3311 return $updater->getStatus()->getErrorsArray();
3312 }
3313
3314 // Report if the edit was not created because it did not change the content.
3315 if ( $updater->isUnchanged() ) {
3316 $resultDetails = [ 'current' => $legacyCurrent ];
3317 return [ [ 'alreadyrolled',
3318 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3319 htmlspecialchars( $fromP ),
3320 htmlspecialchars( $currentEditorForPublic ? $currentEditorForPublic->getName() : '' )
3321 ] ];
3322 }
3323
3324 if ( $changingContentModel ) {
3325 // If the content model changed during the rollback,
3326 // make sure it gets logged to Special:Log/contentmodel
3327 $log = new ManualLogEntry( 'contentmodel', 'change' );
3328 $log->setPerformer( $guser );
3329 $log->setTarget( $this->mTitle );
3330 $log->setComment( $summary );
3331 $log->setParameters( [
3332 '4::oldmodel' => $currentContent->getModel(),
3333 '5::newmodel' => $targetContent->getModel(),
3334 ] );
3335
3336 $logId = $log->insert( $dbw );
3337 $log->publish( $logId );
3338 }
3339
3340 $revId = $rev->getId();
3341
3342 Hooks::run( 'ArticleRollbackComplete', [ $this, $guser, $legacyTarget, $legacyCurrent ] );
3343
3344 $resultDetails = [
3345 'summary' => $summary,
3346 'current' => $legacyCurrent,
3347 'target' => $legacyTarget,
3348 'newid' => $revId,
3349 'tags' => $tags
3350 ];
3351
3352 // TODO: make this return a Status object and wrap $resultDetails in that.
3353 return [];
3354 }
3355
3356 /**
3357 * The onArticle*() functions are supposed to be a kind of hooks
3358 * which should be called whenever any of the specified actions
3359 * are done.
3360 *
3361 * This is a good place to put code to clear caches, for instance.
3362 *
3363 * This is called on page move and undelete, as well as edit
3364 *
3365 * @param Title $title
3366 */
3367 public static function onArticleCreate( Title $title ) {
3368 // TODO: move this into a PageEventEmitter service
3369
3370 // Update existence markers on article/talk tabs...
3371 $other = $title->getOtherPage();
3372
3373 $other->purgeSquid();
3374
3375 $title->touchLinks();
3376 $title->purgeSquid();
3377 $title->deleteTitleProtection();
3378
3379 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3380
3381 // Invalidate caches of articles which include this page
3382 DeferredUpdates::addUpdate(
3383 new HTMLCacheUpdate( $title, 'templatelinks', 'page-create' )
3384 );
3385
3386 if ( $title->getNamespace() == NS_CATEGORY ) {
3387 // Load the Category object, which will schedule a job to create
3388 // the category table row if necessary. Checking a replica DB is ok
3389 // here, in the worst case it'll run an unnecessary recount job on
3390 // a category that probably doesn't have many members.
3391 Category::newFromTitle( $title )->getID();
3392 }
3393 }
3394
3395 /**
3396 * Clears caches when article is deleted
3397 *
3398 * @param Title $title
3399 */
3400 public static function onArticleDelete( Title $title ) {
3401 // TODO: move this into a PageEventEmitter service
3402
3403 // Update existence markers on article/talk tabs...
3404 // Clear Backlink cache first so that purge jobs use more up-to-date backlink information
3405 BacklinkCache::get( $title )->clear();
3406 $other = $title->getOtherPage();
3407
3408 $other->purgeSquid();
3409
3410 $title->touchLinks();
3411 $title->purgeSquid();
3412
3413 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3414
3415 // File cache
3416 HTMLFileCache::clearFileCache( $title );
3417 InfoAction::invalidateCache( $title );
3418
3419 // Messages
3420 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3421 MessageCache::singleton()->updateMessageOverride( $title, null );
3422 }
3423
3424 // Images
3425 if ( $title->getNamespace() == NS_FILE ) {
3426 DeferredUpdates::addUpdate(
3427 new HTMLCacheUpdate( $title, 'imagelinks', 'page-delete' )
3428 );
3429 }
3430
3431 // User talk pages
3432 if ( $title->getNamespace() == NS_USER_TALK ) {
3433 $user = User::newFromName( $title->getText(), false );
3434 if ( $user ) {
3435 $user->setNewtalk( false );
3436 }
3437 }
3438
3439 // Image redirects
3440 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3441
3442 // Purge cross-wiki cache entities referencing this page
3443 self::purgeInterwikiCheckKey( $title );
3444 }
3445
3446 /**
3447 * Purge caches on page update etc
3448 *
3449 * @param Title $title
3450 * @param Revision|null $revision Revision that was just saved, may be null
3451 * @param string[]|null $slotsChanged The role names of the slots that were changed.
3452 * If not given, all slots are assumed to have changed.
3453 */
3454 public static function onArticleEdit(
3455 Title $title,
3456 Revision $revision = null,
3457 $slotsChanged = null
3458 ) {
3459 // TODO: move this into a PageEventEmitter service
3460
3461 if ( $slotsChanged === null || in_array( SlotRecord::MAIN, $slotsChanged ) ) {
3462 // Invalidate caches of articles which include this page.
3463 // Only for the main slot, because only the main slot is transcluded.
3464 // TODO: MCR: not true for TemplateStyles! [SlotHandler]
3465 DeferredUpdates::addUpdate(
3466 new HTMLCacheUpdate( $title, 'templatelinks', 'page-edit' )
3467 );
3468 }
3469
3470 // Invalidate the caches of all pages which redirect here
3471 DeferredUpdates::addUpdate(
3472 new HTMLCacheUpdate( $title, 'redirect', 'page-edit' )
3473 );
3474
3475 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3476
3477 // Purge CDN for this page only
3478 $title->purgeSquid();