parser: inject the time for {{REVISIONTIMESTAMP}} on pre-save parse
[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->setLogger( LoggerFactory::getInstance( 'SaveParse' ) );
1701 $derivedDataUpdater->setRcWatchCategoryMembership( $wgRCWatchCategoryMembership );
1702 $derivedDataUpdater->setArticleCountMethod( $wgArticleCountMethod );
1703
1704 return $derivedDataUpdater;
1705 }
1706
1707 /**
1708 * Returns a DerivedPageDataUpdater for use with the given target revision or new content.
1709 * This method attempts to re-use the same DerivedPageDataUpdater instance for subsequent calls.
1710 * The parameters passed to this method are used to ensure that the DerivedPageDataUpdater
1711 * returned matches that caller's expectations, allowing an existing instance to be re-used
1712 * if the given parameters match that instance's internal state according to
1713 * DerivedPageDataUpdater::isReusableFor(), and creating a new instance of the parameters do not
1714 * match the existign one.
1715 *
1716 * If neither $forRevision nor $forUpdate is given, a new DerivedPageDataUpdater is always
1717 * created, replacing any DerivedPageDataUpdater currently cached.
1718 *
1719 * MCR migration note: this replaces WikiPage::prepareContentForEdit.
1720 *
1721 * @since 1.32
1722 *
1723 * @param User|null $forUser The user that will be used for, or was used for, PST.
1724 * @param RevisionRecord|null $forRevision The revision created by the edit for which
1725 * to perform updates, if the edit was already saved.
1726 * @param RevisionSlotsUpdate|null $forUpdate The new content to be saved by the edit (pre PST),
1727 * if the edit was not yet saved.
1728 * @param bool $forEdit Only re-use if the cached DerivedPageDataUpdater has the current
1729 * revision as the edit's parent revision. This ensures that the same
1730 * DerivedPageDataUpdater cannot be re-used for two consecutive edits.
1731 *
1732 * @return DerivedPageDataUpdater
1733 */
1734 private function getDerivedDataUpdater(
1735 User $forUser = null,
1736 RevisionRecord $forRevision = null,
1737 RevisionSlotsUpdate $forUpdate = null,
1738 $forEdit = false
1739 ) {
1740 if ( !$forRevision && !$forUpdate ) {
1741 // NOTE: can't re-use an existing derivedDataUpdater if we don't know what the caller is
1742 // going to use it with.
1743 $this->derivedDataUpdater = null;
1744 }
1745
1746 if ( $this->derivedDataUpdater && !$this->derivedDataUpdater->isContentPrepared() ) {
1747 // NOTE: can't re-use an existing derivedDataUpdater if other code that has a reference
1748 // to it did not yet initialize it, because we don't know what data it will be
1749 // initialized with.
1750 $this->derivedDataUpdater = null;
1751 }
1752
1753 // XXX: It would be nice to have an LRU cache instead of trying to re-use a single instance.
1754 // However, there is no good way to construct a cache key. We'd need to check against all
1755 // cached instances.
1756
1757 if ( $this->derivedDataUpdater
1758 && !$this->derivedDataUpdater->isReusableFor(
1759 $forUser,
1760 $forRevision,
1761 $forUpdate,
1762 $forEdit ? $this->getLatest() : null
1763 )
1764 ) {
1765 $this->derivedDataUpdater = null;
1766 }
1767
1768 if ( !$this->derivedDataUpdater ) {
1769 $this->derivedDataUpdater = $this->newDerivedDataUpdater();
1770 }
1771
1772 return $this->derivedDataUpdater;
1773 }
1774
1775 /**
1776 * Returns a PageUpdater for creating new revisions on this page (or creating the page).
1777 *
1778 * The PageUpdater can also be used to detect the need for edit conflict resolution,
1779 * and to protected such conflict resolution from concurrent edits using a check-and-set
1780 * mechanism.
1781 *
1782 * @since 1.32
1783 *
1784 * @param User $user
1785 * @param RevisionSlotsUpdate|null $forUpdate If given, allows any cached ParserOutput
1786 * that may already have been returned via getDerivedDataUpdater to be re-used.
1787 *
1788 * @return PageUpdater
1789 */
1790 public function newPageUpdater( User $user, RevisionSlotsUpdate $forUpdate = null ) {
1791 global $wgAjaxEditStash, $wgUseAutomaticEditSummaries, $wgPageCreationLog;
1792
1793 $pageUpdater = new PageUpdater(
1794 $user,
1795 $this, // NOTE: eventually, PageUpdater should not know about WikiPage
1796 $this->getDerivedDataUpdater( $user, null, $forUpdate, true ),
1797 $this->getDBLoadBalancer(),
1798 $this->getRevisionStore(),
1799 $this->getSlotRoleRegistry()
1800 );
1801
1802 $pageUpdater->setUsePageCreationLog( $wgPageCreationLog );
1803 $pageUpdater->setAjaxEditStash( $wgAjaxEditStash );
1804 $pageUpdater->setUseAutomaticEditSummaries( $wgUseAutomaticEditSummaries );
1805
1806 return $pageUpdater;
1807 }
1808
1809 /**
1810 * Change an existing article or create a new article. Updates RC and all necessary caches,
1811 * optionally via the deferred update array.
1812 *
1813 * @deprecated since 1.32, use PageUpdater::saveRevision instead. Note that the new method
1814 * expects callers to take care of checking EDIT_MINOR against the minoredit right, and to
1815 * apply the autopatrol right as appropriate.
1816 *
1817 * @param Content $content New content
1818 * @param string|CommentStoreComment $summary Edit summary
1819 * @param int $flags Bitfield:
1820 * EDIT_NEW
1821 * Article is known or assumed to be non-existent, create a new one
1822 * EDIT_UPDATE
1823 * Article is known or assumed to be pre-existing, update it
1824 * EDIT_MINOR
1825 * Mark this edit minor, if the user is allowed to do so
1826 * EDIT_SUPPRESS_RC
1827 * Do not log the change in recentchanges
1828 * EDIT_FORCE_BOT
1829 * Mark the edit a "bot" edit regardless of user rights
1830 * EDIT_AUTOSUMMARY
1831 * Fill in blank summaries with generated text where possible
1832 * EDIT_INTERNAL
1833 * Signal that the page retrieve/save cycle happened entirely in this request.
1834 *
1835 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1836 * article will be detected. If EDIT_UPDATE is specified and the article
1837 * doesn't exist, the function will return an edit-gone-missing error. If
1838 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1839 * error will be returned. These two conditions are also possible with
1840 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1841 *
1842 * @param bool|int $originalRevId: The ID of an original revision that the edit
1843 * restores or repeats. The new revision is expected to have the exact same content as
1844 * the given original revision. This is used with rollbacks and with dummy "null" revisions
1845 * which are created to record things like page moves.
1846 * @param User|null $user The user doing the edit
1847 * @param string|null $serialFormat IGNORED.
1848 * @param array|null $tags Change tags to apply to this edit
1849 * Callers are responsible for permission checks
1850 * (with ChangeTags::canAddTagsAccompanyingChange)
1851 * @param Int $undidRevId Id of revision that was undone or 0
1852 *
1853 * @throws MWException
1854 * @return Status Possible errors:
1855 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1856 * set the fatal flag of $status.
1857 * edit-gone-missing: In update mode, but the article didn't exist.
1858 * edit-conflict: In update mode, the article changed unexpectedly.
1859 * edit-no-change: Warning that the text was the same as before.
1860 * edit-already-exists: In creation mode, but the article already exists.
1861 *
1862 * Extensions may define additional errors.
1863 *
1864 * $return->value will contain an associative array with members as follows:
1865 * new: Boolean indicating if the function attempted to create a new article.
1866 * revision: The revision object for the inserted revision, or null.
1867 *
1868 * @since 1.21
1869 * @throws MWException
1870 */
1871 public function doEditContent(
1872 Content $content, $summary, $flags = 0, $originalRevId = false,
1873 User $user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1874 ) {
1875 global $wgUser, $wgUseNPPatrol, $wgUseRCPatrol;
1876
1877 if ( !( $summary instanceof CommentStoreComment ) ) {
1878 $summary = CommentStoreComment::newUnsavedComment( trim( $summary ) );
1879 }
1880
1881 if ( !$user ) {
1882 $user = $wgUser;
1883 }
1884
1885 // TODO: this check is here for backwards-compatibility with 1.31 behavior.
1886 // Checking the minoredit right should be done in the same place the 'bot' right is
1887 // checked for the EDIT_FORCE_BOT flag, which is currently in EditPage::attemptSave.
1888 if ( ( $flags & EDIT_MINOR ) && !$user->isAllowed( 'minoredit' ) ) {
1889 $flags = ( $flags & ~EDIT_MINOR );
1890 }
1891
1892 $slotsUpdate = new RevisionSlotsUpdate();
1893 $slotsUpdate->modifyContent( SlotRecord::MAIN, $content );
1894
1895 // NOTE: while doEditContent() executes, callbacks to getDerivedDataUpdater and
1896 // prepareContentForEdit will generally use the DerivedPageDataUpdater that is also
1897 // used by this PageUpdater. However, there is no guarantee for this.
1898 $updater = $this->newPageUpdater( $user, $slotsUpdate );
1899 $updater->setContent( SlotRecord::MAIN, $content );
1900 $updater->setOriginalRevisionId( $originalRevId );
1901 $updater->setUndidRevisionId( $undidRevId );
1902
1903 $needsPatrol = $wgUseRCPatrol || ( $wgUseNPPatrol && !$this->exists() );
1904
1905 // TODO: this logic should not be in the storage layer, it's here for compatibility
1906 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
1907 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
1908 if ( $needsPatrol && $this->getTitle()->userCan( 'autopatrol', $user ) ) {
1909 $updater->setRcPatrolStatus( RecentChange::PRC_AUTOPATROLLED );
1910 }
1911
1912 $updater->addTags( $tags );
1913
1914 $revRec = $updater->saveRevision(
1915 $summary,
1916 $flags
1917 );
1918
1919 // $revRec will be null if the edit failed, or if no new revision was created because
1920 // the content did not change.
1921 if ( $revRec ) {
1922 // update cached fields
1923 // TODO: this is currently redundant to what is done in updateRevisionOn.
1924 // But updateRevisionOn() should move into PageStore, and then this will be needed.
1925 $this->setLastEdit( new Revision( $revRec ) ); // TODO: use RevisionRecord
1926 $this->mLatest = $revRec->getId();
1927 }
1928
1929 return $updater->getStatus();
1930 }
1931
1932 /**
1933 * Get parser options suitable for rendering the primary article wikitext
1934 *
1935 * @see ParserOptions::newCanonical
1936 *
1937 * @param IContextSource|User|string $context One of the following:
1938 * - IContextSource: Use the User and the Language of the provided
1939 * context
1940 * - User: Use the provided User object and $wgLang for the language,
1941 * so use an IContextSource object if possible.
1942 * - 'canonical': Canonical options (anonymous user with default
1943 * preferences and content language).
1944 * @return ParserOptions
1945 */
1946 public function makeParserOptions( $context ) {
1947 $options = ParserOptions::newCanonical( $context );
1948
1949 if ( $this->getTitle()->isConversionTable() ) {
1950 // @todo ConversionTable should become a separate content model, so
1951 // we don't need special cases like this one.
1952 $options->disableContentConversion();
1953 }
1954
1955 return $options;
1956 }
1957
1958 /**
1959 * Prepare content which is about to be saved.
1960 *
1961 * Prior to 1.30, this returned a stdClass.
1962 *
1963 * @deprecated since 1.32, use getDerivedDataUpdater instead.
1964 *
1965 * @param Content $content
1966 * @param Revision|RevisionRecord|null $revision Revision object.
1967 * Used with vary-revision or vary-revision-id.
1968 * @param User|null $user
1969 * @param string|null $serialFormat IGNORED
1970 * @param bool $useCache Check shared prepared edit cache
1971 *
1972 * @return PreparedEdit
1973 *
1974 * @since 1.21
1975 */
1976 public function prepareContentForEdit(
1977 Content $content,
1978 $revision = null,
1979 User $user = null,
1980 $serialFormat = null,
1981 $useCache = true
1982 ) {
1983 global $wgUser;
1984
1985 if ( !$user ) {
1986 $user = $wgUser;
1987 }
1988
1989 if ( $revision !== null ) {
1990 if ( $revision instanceof Revision ) {
1991 $revision = $revision->getRevisionRecord();
1992 } elseif ( !( $revision instanceof RevisionRecord ) ) {
1993 throw new InvalidArgumentException(
1994 __METHOD__ . ': invalid $revision argument type ' . gettype( $revision ) );
1995 }
1996 }
1997
1998 $slots = RevisionSlotsUpdate::newFromContent( [ SlotRecord::MAIN => $content ] );
1999 $updater = $this->getDerivedDataUpdater( $user, $revision, $slots );
2000
2001 if ( !$updater->isUpdatePrepared() ) {
2002 $updater->prepareContent( $user, $slots, $useCache );
2003
2004 if ( $revision ) {
2005 $updater->prepareUpdate(
2006 $revision,
2007 [
2008 'causeAction' => 'prepare-edit',
2009 'causeAgent' => $user->getName(),
2010 ]
2011 );
2012 }
2013 }
2014
2015 return $updater->getPreparedEdit();
2016 }
2017
2018 /**
2019 * Do standard deferred updates after page edit.
2020 * Update links tables, site stats, search index and message cache.
2021 * Purges pages that include this page if the text was changed here.
2022 * Every 100th edit, prune the recent changes table.
2023 *
2024 * @deprecated since 1.32, use PageUpdater::doUpdates instead.
2025 *
2026 * @param Revision $revision
2027 * @param User $user User object that did the revision
2028 * @param array $options Array of options, following indexes are used:
2029 * - changed: bool, whether the revision changed the content (default true)
2030 * - created: bool, whether the revision created the page (default false)
2031 * - moved: bool, whether the page was moved (default false)
2032 * - restored: bool, whether the page was undeleted (default false)
2033 * - oldrevision: Revision object for the pre-update revision (default null)
2034 * - oldcountable: bool, null, or string 'no-change' (default null):
2035 * - bool: whether the page was counted as an article before that
2036 * revision, only used in changed is true and created is false
2037 * - null: if created is false, don't update the article count; if created
2038 * is true, do update the article count
2039 * - 'no-change': don't update the article count, ever
2040 * - causeAction: an arbitrary string identifying the reason for the update.
2041 * See DataUpdate::getCauseAction(). (default 'edit-page')
2042 * - causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent().
2043 * (string, defaults to the passed user)
2044 */
2045 public function doEditUpdates( Revision $revision, User $user, array $options = [] ) {
2046 $options += [
2047 'causeAction' => 'edit-page',
2048 'causeAgent' => $user->getName(),
2049 ];
2050
2051 $revision = $revision->getRevisionRecord();
2052
2053 $updater = $this->getDerivedDataUpdater( $user, $revision );
2054
2055 $updater->prepareUpdate( $revision, $options );
2056
2057 $updater->doUpdates();
2058 }
2059
2060 /**
2061 * Update the parser cache.
2062 *
2063 * @note This is a temporary workaround until there is a proper data updater class.
2064 * It will become deprecated soon.
2065 *
2066 * @param array $options
2067 * - causeAction: an arbitrary string identifying the reason for the update.
2068 * See DataUpdate::getCauseAction(). (default 'edit-page')
2069 * - causeAgent: name of the user who caused the update (string, defaults to the
2070 * user who created the revision)
2071 * @since 1.32
2072 */
2073 public function updateParserCache( array $options = [] ) {
2074 $revision = $this->getRevisionRecord();
2075 if ( !$revision || !$revision->getId() ) {
2076 LoggerFactory::getInstance( 'wikipage' )->info(
2077 __METHOD__ . 'called with ' . ( $revision ? 'unsaved' : 'no' ) . ' revision'
2078 );
2079 return;
2080 }
2081 $user = User::newFromIdentity( $revision->getUser( RevisionRecord::RAW ) );
2082
2083 $updater = $this->getDerivedDataUpdater( $user, $revision );
2084 $updater->prepareUpdate( $revision, $options );
2085 $updater->doParserCacheUpdate();
2086 }
2087
2088 /**
2089 * Do secondary data updates (such as updating link tables).
2090 * Secondary data updates are only a small part of the updates needed after saving
2091 * a new revision; normally PageUpdater::doUpdates should be used instead (which includes
2092 * secondary data updates). This method is provided for partial purges.
2093 *
2094 * @note This is a temporary workaround until there is a proper data updater class.
2095 * It will become deprecated soon.
2096 *
2097 * @param array $options
2098 * - recursive (bool, default true): whether to do a recursive update (update pages that
2099 * depend on this page, e.g. transclude it). This will set the $recursive parameter of
2100 * Content::getSecondaryDataUpdates. Typically this should be true unless the update
2101 * was something that did not really change the page, such as a null edit.
2102 * - triggeringUser: The user triggering the update (UserIdentity, defaults to the
2103 * user who created the revision)
2104 * - causeAction: an arbitrary string identifying the reason for the update.
2105 * See DataUpdate::getCauseAction(). (default 'unknown')
2106 * - causeAgent: name of the user who caused the update (string, default 'unknown')
2107 * - defer: one of the DeferredUpdates constants, or false to run immediately (default: false).
2108 * Note that even when this is set to false, some updates might still get deferred (as
2109 * some update might directly add child updates to DeferredUpdates).
2110 * - transactionTicket: a transaction ticket from LBFactory::getEmptyTransactionTicket(),
2111 * only when defer is false (default: null)
2112 * @since 1.32
2113 */
2114 public function doSecondaryDataUpdates( array $options = [] ) {
2115 $options['recursive'] = $options['recursive'] ?? true;
2116 $revision = $this->getRevisionRecord();
2117 if ( !$revision || !$revision->getId() ) {
2118 LoggerFactory::getInstance( 'wikipage' )->info(
2119 __METHOD__ . 'called with ' . ( $revision ? 'unsaved' : 'no' ) . ' revision'
2120 );
2121 return;
2122 }
2123 $user = User::newFromIdentity( $revision->getUser( RevisionRecord::RAW ) );
2124
2125 $updater = $this->getDerivedDataUpdater( $user, $revision );
2126 $updater->prepareUpdate( $revision, $options );
2127 $updater->doSecondaryDataUpdates( $options );
2128 }
2129
2130 /**
2131 * Update the article's restriction field, and leave a log entry.
2132 * This works for protection both existing and non-existing pages.
2133 *
2134 * @param array $limit Set of restriction keys
2135 * @param array $expiry Per restriction type expiration
2136 * @param int &$cascade Set to false if cascading protection isn't allowed.
2137 * @param string $reason
2138 * @param User $user The user updating the restrictions
2139 * @param string|string[]|null $tags Change tags to add to the pages and protection log entries
2140 * ($user should be able to add the specified tags before this is called)
2141 * @return Status Status object; if action is taken, $status->value is the log_id of the
2142 * protection log entry.
2143 */
2144 public function doUpdateRestrictions( array $limit, array $expiry,
2145 &$cascade, $reason, User $user, $tags = null
2146 ) {
2147 global $wgCascadingRestrictionLevels;
2148
2149 if ( wfReadOnly() ) {
2150 return Status::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2151 }
2152
2153 $this->loadPageData( 'fromdbmaster' );
2154 $this->mTitle->loadRestrictions( null, Title::READ_LATEST );
2155 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2156 $id = $this->getId();
2157
2158 if ( !$cascade ) {
2159 $cascade = false;
2160 }
2161
2162 // Take this opportunity to purge out expired restrictions
2163 Title::purgeExpiredRestrictions();
2164
2165 // @todo: Same limitations as described in ProtectionForm.php (line 37);
2166 // we expect a single selection, but the schema allows otherwise.
2167 $isProtected = false;
2168 $protect = false;
2169 $changed = false;
2170
2171 $dbw = wfGetDB( DB_MASTER );
2172
2173 foreach ( $restrictionTypes as $action ) {
2174 if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) {
2175 $expiry[$action] = 'infinity';
2176 }
2177 if ( !isset( $limit[$action] ) ) {
2178 $limit[$action] = '';
2179 } elseif ( $limit[$action] != '' ) {
2180 $protect = true;
2181 }
2182
2183 // Get current restrictions on $action
2184 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2185 if ( $current != '' ) {
2186 $isProtected = true;
2187 }
2188
2189 if ( $limit[$action] != $current ) {
2190 $changed = true;
2191 } elseif ( $limit[$action] != '' ) {
2192 // Only check expiry change if the action is actually being
2193 // protected, since expiry does nothing on an not-protected
2194 // action.
2195 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2196 $changed = true;
2197 }
2198 }
2199 }
2200
2201 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2202 $changed = true;
2203 }
2204
2205 // If nothing has changed, do nothing
2206 if ( !$changed ) {
2207 return Status::newGood();
2208 }
2209
2210 if ( !$protect ) { // No protection at all means unprotection
2211 $revCommentMsg = 'unprotectedarticle-comment';
2212 $logAction = 'unprotect';
2213 } elseif ( $isProtected ) {
2214 $revCommentMsg = 'modifiedarticleprotection-comment';
2215 $logAction = 'modify';
2216 } else {
2217 $revCommentMsg = 'protectedarticle-comment';
2218 $logAction = 'protect';
2219 }
2220
2221 $logRelationsValues = [];
2222 $logRelationsField = null;
2223 $logParamsDetails = [];
2224
2225 // Null revision (used for change tag insertion)
2226 $nullRevision = null;
2227
2228 if ( $id ) { // Protection of existing page
2229 // Avoid PHP 7.1 warning of passing $this by reference
2230 $wikiPage = $this;
2231
2232 if ( !Hooks::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2233 return Status::newGood();
2234 }
2235
2236 // Only certain restrictions can cascade...
2237 $editrestriction = isset( $limit['edit'] )
2238 ? [ $limit['edit'] ]
2239 : $this->mTitle->getRestrictions( 'edit' );
2240 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2241 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2242 }
2243 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2244 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2245 }
2246
2247 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2248 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2249 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2250 }
2251 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2252 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2253 }
2254
2255 // The schema allows multiple restrictions
2256 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2257 $cascade = false;
2258 }
2259
2260 // insert null revision to identify the page protection change as edit summary
2261 $latest = $this->getLatest();
2262 $nullRevision = $this->insertProtectNullRevision(
2263 $revCommentMsg,
2264 $limit,
2265 $expiry,
2266 $cascade,
2267 $reason,
2268 $user
2269 );
2270
2271 if ( $nullRevision === null ) {
2272 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2273 }
2274
2275 $logRelationsField = 'pr_id';
2276
2277 // Update restrictions table
2278 foreach ( $limit as $action => $restrictions ) {
2279 $dbw->delete(
2280 'page_restrictions',
2281 [
2282 'pr_page' => $id,
2283 'pr_type' => $action
2284 ],
2285 __METHOD__
2286 );
2287 if ( $restrictions != '' ) {
2288 $cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0;
2289 $dbw->insert(
2290 'page_restrictions',
2291 [
2292 'pr_page' => $id,
2293 'pr_type' => $action,
2294 'pr_level' => $restrictions,
2295 'pr_cascade' => $cascadeValue,
2296 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2297 ],
2298 __METHOD__
2299 );
2300 $logRelationsValues[] = $dbw->insertId();
2301 $logParamsDetails[] = [
2302 'type' => $action,
2303 'level' => $restrictions,
2304 'expiry' => $expiry[$action],
2305 'cascade' => (bool)$cascadeValue,
2306 ];
2307 }
2308 }
2309
2310 // Clear out legacy restriction fields
2311 $dbw->update(
2312 'page',
2313 [ 'page_restrictions' => '' ],
2314 [ 'page_id' => $id ],
2315 __METHOD__
2316 );
2317
2318 // Avoid PHP 7.1 warning of passing $this by reference
2319 $wikiPage = $this;
2320
2321 Hooks::run( 'NewRevisionFromEditComplete',
2322 [ $this, $nullRevision, $latest, $user ] );
2323 Hooks::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2324 } else { // Protection of non-existing page (also known as "title protection")
2325 // Cascade protection is meaningless in this case
2326 $cascade = false;
2327
2328 if ( $limit['create'] != '' ) {
2329 $commentFields = CommentStore::getStore()->insert( $dbw, 'pt_reason', $reason );
2330 $dbw->replace( 'protected_titles',
2331 [ [ 'pt_namespace', 'pt_title' ] ],
2332 [
2333 'pt_namespace' => $this->mTitle->getNamespace(),
2334 'pt_title' => $this->mTitle->getDBkey(),
2335 'pt_create_perm' => $limit['create'],
2336 'pt_timestamp' => $dbw->timestamp(),
2337 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2338 'pt_user' => $user->getId(),
2339 ] + $commentFields, __METHOD__
2340 );
2341 $logParamsDetails[] = [
2342 'type' => 'create',
2343 'level' => $limit['create'],
2344 'expiry' => $expiry['create'],
2345 ];
2346 } else {
2347 $dbw->delete( 'protected_titles',
2348 [
2349 'pt_namespace' => $this->mTitle->getNamespace(),
2350 'pt_title' => $this->mTitle->getDBkey()
2351 ], __METHOD__
2352 );
2353 }
2354 }
2355
2356 $this->mTitle->flushRestrictions();
2357 InfoAction::invalidateCache( $this->mTitle );
2358
2359 if ( $logAction == 'unprotect' ) {
2360 $params = [];
2361 } else {
2362 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2363 $params = [
2364 '4::description' => $protectDescriptionLog, // parameter for IRC
2365 '5:bool:cascade' => $cascade,
2366 'details' => $logParamsDetails, // parameter for localize and api
2367 ];
2368 }
2369
2370 // Update the protection log
2371 $logEntry = new ManualLogEntry( 'protect', $logAction );
2372 $logEntry->setTarget( $this->mTitle );
2373 $logEntry->setComment( $reason );
2374 $logEntry->setPerformer( $user );
2375 $logEntry->setParameters( $params );
2376 if ( !is_null( $nullRevision ) ) {
2377 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2378 }
2379 $logEntry->setTags( $tags );
2380 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2381 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2382 }
2383 $logId = $logEntry->insert();
2384 $logEntry->publish( $logId );
2385
2386 return Status::newGood( $logId );
2387 }
2388
2389 /**
2390 * Insert a new null revision for this page.
2391 *
2392 * @param string $revCommentMsg Comment message key for the revision
2393 * @param array $limit Set of restriction keys
2394 * @param array $expiry Per restriction type expiration
2395 * @param int $cascade Set to false if cascading protection isn't allowed.
2396 * @param string $reason
2397 * @param User|null $user
2398 * @return Revision|null Null on error
2399 */
2400 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2401 array $expiry, $cascade, $reason, $user = null
2402 ) {
2403 $dbw = wfGetDB( DB_MASTER );
2404
2405 // Prepare a null revision to be added to the history
2406 $editComment = wfMessage(
2407 $revCommentMsg,
2408 $this->mTitle->getPrefixedText(),
2409 $user ? $user->getName() : ''
2410 )->inContentLanguage()->text();
2411 if ( $reason ) {
2412 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2413 }
2414 $protectDescription = $this->protectDescription( $limit, $expiry );
2415 if ( $protectDescription ) {
2416 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2417 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2418 ->inContentLanguage()->text();
2419 }
2420 if ( $cascade ) {
2421 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2422 $editComment .= wfMessage( 'brackets' )->params(
2423 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2424 )->inContentLanguage()->text();
2425 }
2426
2427 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2428 if ( $nullRev ) {
2429 $nullRev->insertOn( $dbw );
2430
2431 // Update page record and touch page
2432 $oldLatest = $nullRev->getParentId();
2433 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2434 }
2435
2436 return $nullRev;
2437 }
2438
2439 /**
2440 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2441 * @return string
2442 */
2443 protected function formatExpiry( $expiry ) {
2444 if ( $expiry != 'infinity' ) {
2445 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
2446 return wfMessage(
2447 'protect-expiring',
2448 $contLang->timeanddate( $expiry, false, false ),
2449 $contLang->date( $expiry, false, false ),
2450 $contLang->time( $expiry, false, false )
2451 )->inContentLanguage()->text();
2452 } else {
2453 return wfMessage( 'protect-expiry-indefinite' )
2454 ->inContentLanguage()->text();
2455 }
2456 }
2457
2458 /**
2459 * Builds the description to serve as comment for the edit.
2460 *
2461 * @param array $limit Set of restriction keys
2462 * @param array $expiry Per restriction type expiration
2463 * @return string
2464 */
2465 public function protectDescription( array $limit, array $expiry ) {
2466 $protectDescription = '';
2467
2468 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2469 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2470 # All possible message keys are listed here for easier grepping:
2471 # * restriction-create
2472 # * restriction-edit
2473 # * restriction-move
2474 # * restriction-upload
2475 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2476 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2477 # with '' filtered out. All possible message keys are listed below:
2478 # * protect-level-autoconfirmed
2479 # * protect-level-sysop
2480 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2481 ->inContentLanguage()->text();
2482
2483 $expiryText = $this->formatExpiry( $expiry[$action] );
2484
2485 if ( $protectDescription !== '' ) {
2486 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2487 }
2488 $protectDescription .= wfMessage( 'protect-summary-desc' )
2489 ->params( $actionText, $restrictionsText, $expiryText )
2490 ->inContentLanguage()->text();
2491 }
2492
2493 return $protectDescription;
2494 }
2495
2496 /**
2497 * Builds the description to serve as comment for the log entry.
2498 *
2499 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2500 * protect description text. Keep them in old format to avoid breaking compatibility.
2501 * TODO: Fix protection log to store structured description and format it on-the-fly.
2502 *
2503 * @param array $limit Set of restriction keys
2504 * @param array $expiry Per restriction type expiration
2505 * @return string
2506 */
2507 public function protectDescriptionLog( array $limit, array $expiry ) {
2508 $protectDescriptionLog = '';
2509
2510 $dirMark = MediaWikiServices::getInstance()->getContentLanguage()->getDirMark();
2511 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2512 $expiryText = $this->formatExpiry( $expiry[$action] );
2513 $protectDescriptionLog .=
2514 $dirMark .
2515 "[$action=$restrictions] ($expiryText)";
2516 }
2517
2518 return trim( $protectDescriptionLog );
2519 }
2520
2521 /**
2522 * Take an array of page restrictions and flatten it to a string
2523 * suitable for insertion into the page_restrictions field.
2524 *
2525 * @param string[] $limit
2526 *
2527 * @throws MWException
2528 * @return string
2529 */
2530 protected static function flattenRestrictions( $limit ) {
2531 if ( !is_array( $limit ) ) {
2532 throw new MWException( __METHOD__ . ' given non-array restriction set' );
2533 }
2534
2535 $bits = [];
2536 ksort( $limit );
2537
2538 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2539 $bits[] = "$action=$restrictions";
2540 }
2541
2542 return implode( ':', $bits );
2543 }
2544
2545 /**
2546 * Determines if deletion of this page would be batched (executed over time by the job queue)
2547 * or not (completed in the same request as the delete call).
2548 *
2549 * It is unlikely but possible that an edit from another request could push the page over the
2550 * batching threshold after this function is called, but before the caller acts upon the
2551 * return value. Callers must decide for themselves how to deal with this. $safetyMargin
2552 * is provided as an unreliable but situationally useful help for some common cases.
2553 *
2554 * @param int $safetyMargin Added to the revision count when checking for batching
2555 * @return bool True if deletion would be batched, false otherwise
2556 */
2557 public function isBatchedDelete( $safetyMargin = 0 ) {
2558 global $wgDeleteRevisionsBatchSize;
2559
2560 $dbr = wfGetDB( DB_REPLICA );
2561 $revCount = $this->getRevisionStore()->countRevisionsByPageId( $dbr, $this->getId() );
2562 $revCount += $safetyMargin;
2563
2564 return $revCount >= $wgDeleteRevisionsBatchSize;
2565 }
2566
2567 /**
2568 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2569 * backwards compatibility, if you care about error reporting you should use
2570 * doDeleteArticleReal() instead.
2571 *
2572 * Deletes the article with database consistency, writes logs, purges caches
2573 *
2574 * @param string $reason Delete reason for deletion log
2575 * @param bool $suppress Suppress all revisions and log the deletion in
2576 * the suppression log instead of the deletion log
2577 * @param int|null $u1 Unused
2578 * @param bool|null $u2 Unused
2579 * @param array|string &$error Array of errors to append to
2580 * @param User|null $user The deleting user
2581 * @param bool $immediate false allows deleting over time via the job queue
2582 * @return bool True if successful
2583 * @throws FatalError
2584 * @throws MWException
2585 */
2586 public function doDeleteArticle(
2587 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null,
2588 $immediate = false
2589 ) {
2590 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user,
2591 [], 'delete', $immediate );
2592
2593 // Returns true if the page was actually deleted, or is scheduled for deletion
2594 return $status->isOK();
2595 }
2596
2597 /**
2598 * Back-end article deletion
2599 * Deletes the article with database consistency, writes logs, purges caches
2600 *
2601 * @since 1.19
2602 *
2603 * @param string $reason Delete reason for deletion log
2604 * @param bool $suppress Suppress all revisions and log the deletion in
2605 * the suppression log instead of the deletion log
2606 * @param int|null $u1 Unused
2607 * @param bool|null $u2 Unused
2608 * @param array|string &$error Array of errors to append to
2609 * @param User|null $deleter The deleting user
2610 * @param array $tags Tags to apply to the deletion action
2611 * @param string $logsubtype
2612 * @param bool $immediate false allows deleting over time via the job queue
2613 * @return Status Status object; if successful, $status->value is the log_id of the
2614 * deletion log entry. If the page couldn't be deleted because it wasn't
2615 * found, $status is a non-fatal 'cannotdelete' error
2616 * @throws FatalError
2617 * @throws MWException
2618 */
2619 public function doDeleteArticleReal(
2620 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $deleter = null,
2621 $tags = [], $logsubtype = 'delete', $immediate = false
2622 ) {
2623 global $wgUser;
2624
2625 wfDebug( __METHOD__ . "\n" );
2626
2627 $status = Status::newGood();
2628
2629 // Avoid PHP 7.1 warning of passing $this by reference
2630 $wikiPage = $this;
2631
2632 if ( !$deleter ) {
2633 $deleter = $wgUser;
2634 }
2635 if ( !Hooks::run( 'ArticleDelete',
2636 [ &$wikiPage, &$deleter, &$reason, &$error, &$status, $suppress ]
2637 ) ) {
2638 if ( $status->isOK() ) {
2639 // Hook aborted but didn't set a fatal status
2640 $status->fatal( 'delete-hook-aborted' );
2641 }
2642 return $status;
2643 }
2644
2645 return $this->doDeleteArticleBatched( $reason, $suppress, $deleter, $tags,
2646 $logsubtype, $immediate );
2647 }
2648
2649 /**
2650 * Back-end article deletion
2651 *
2652 * Only invokes batching via the job queue if necessary per $wgDeleteRevisionsBatchSize.
2653 * Deletions can often be completed inline without involving the job queue.
2654 *
2655 * Potentially called many times per deletion operation for pages with many revisions.
2656 */
2657 public function doDeleteArticleBatched(
2658 $reason, $suppress, User $deleter, $tags,
2659 $logsubtype, $immediate = false, $webRequestId = null
2660 ) {
2661 wfDebug( __METHOD__ . "\n" );
2662
2663 $status = Status::newGood();
2664
2665 $dbw = wfGetDB( DB_MASTER );
2666 $dbw->startAtomic( __METHOD__ );
2667
2668 $this->loadPageData( self::READ_LATEST );
2669 $id = $this->getId();
2670 // T98706: lock the page from various other updates but avoid using
2671 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2672 // the revisions queries (which also JOIN on user). Only lock the page
2673 // row and CAS check on page_latest to see if the trx snapshot matches.
2674 $lockedLatest = $this->lockAndGetLatest();
2675 if ( $id == 0 || $this->getLatest() != $lockedLatest ) {
2676 $dbw->endAtomic( __METHOD__ );
2677 // Page not there or trx snapshot is stale
2678 $status->error( 'cannotdelete',
2679 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2680 return $status;
2681 }
2682
2683 // At this point we are now committed to returning an OK
2684 // status unless some DB query error or other exception comes up.
2685 // This way callers don't have to call rollback() if $status is bad
2686 // unless they actually try to catch exceptions (which is rare).
2687
2688 // we need to remember the old content so we can use it to generate all deletion updates.
2689 $revision = $this->getRevision();
2690 try {
2691 $content = $this->getContent( Revision::RAW );
2692 } catch ( Exception $ex ) {
2693 wfLogWarning( __METHOD__ . ': failed to load content during deletion! '
2694 . $ex->getMessage() );
2695
2696 $content = null;
2697 }
2698
2699 // Archive revisions. In immediate mode, archive all revisions. Otherwise, archive
2700 // one batch of revisions and defer archival of any others to the job queue.
2701 $explictTrxLogged = false;
2702 while ( true ) {
2703 $done = $this->archiveRevisions( $dbw, $id, $suppress );
2704 if ( $done || !$immediate ) {
2705 break;
2706 }
2707 $dbw->endAtomic( __METHOD__ );
2708 if ( $dbw->explicitTrxActive() ) {
2709 // Explict transactions may never happen here in practice. Log to be sure.
2710 if ( !$explictTrxLogged ) {
2711 $explictTrxLogged = true;
2712 LoggerFactory::getInstance( 'wfDebug' )->debug(
2713 'explicit transaction active in ' . __METHOD__ . ' while deleting {title}', [
2714 'title' => $this->getTitle()->getText(),
2715 ] );
2716 }
2717 continue;
2718 }
2719 if ( $dbw->trxLevel() ) {
2720 $dbw->commit();
2721 }
2722 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2723 $lbFactory->waitForReplication();
2724 $dbw->startAtomic( __METHOD__ );
2725 }
2726
2727 // If done archiving, also delete the article.
2728 if ( !$done ) {
2729 $dbw->endAtomic( __METHOD__ );
2730
2731 $jobParams = [
2732 'namespace' => $this->getTitle()->getNamespace(),
2733 'title' => $this->getTitle()->getDBkey(),
2734 'wikiPageId' => $id,
2735 'requestId' => $webRequestId ?? WebRequest::getRequestId(),
2736 'reason' => $reason,
2737 'suppress' => $suppress,
2738 'userId' => $deleter->getId(),
2739 'tags' => json_encode( $tags ),
2740 'logsubtype' => $logsubtype,
2741 ];
2742
2743 $job = new DeletePageJob( $jobParams );
2744 JobQueueGroup::singleton()->push( $job );
2745
2746 $status->warning( 'delete-scheduled',
2747 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2748 } else {
2749 // Get archivedRevisionCount by db query, because there's no better alternative.
2750 // Jobs cannot pass a count of archived revisions to the next job, because additional
2751 // deletion operations can be started while the first is running. Jobs from each
2752 // gracefully interleave, but would not know about each other's count. Deduplication
2753 // in the job queue to avoid simultaneous deletion operations would add overhead.
2754 // Number of archived revisions cannot be known beforehand, because edits can be made
2755 // while deletion operations are being processed, changing the number of archivals.
2756 $archivedRevisionCount = (int)$dbw->selectField(
2757 'archive', 'COUNT(*)',
2758 [
2759 'ar_namespace' => $this->getTitle()->getNamespace(),
2760 'ar_title' => $this->getTitle()->getDBkey(),
2761 'ar_page_id' => $id
2762 ], __METHOD__
2763 );
2764
2765 // Clone the title and wikiPage, so we have the information we need when
2766 // we log and run the ArticleDeleteComplete hook.
2767 $logTitle = clone $this->mTitle;
2768 $wikiPageBeforeDelete = clone $this;
2769
2770 // Now that it's safely backed up, delete it
2771 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__ );
2772
2773 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2774 $logtype = $suppress ? 'suppress' : 'delete';
2775
2776 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2777 $logEntry->setPerformer( $deleter );
2778 $logEntry->setTarget( $logTitle );
2779 $logEntry->setComment( $reason );
2780 $logEntry->setTags( $tags );
2781 $logid = $logEntry->insert();
2782
2783 $dbw->onTransactionPreCommitOrIdle(
2784 function () use ( $logEntry, $logid ) {
2785 // T58776: avoid deadlocks (especially from FileDeleteForm)
2786 $logEntry->publish( $logid );
2787 },
2788 __METHOD__
2789 );
2790
2791 $dbw->endAtomic( __METHOD__ );
2792
2793 $this->doDeleteUpdates( $id, $content, $revision, $deleter );
2794
2795 Hooks::run( 'ArticleDeleteComplete', [
2796 &$wikiPageBeforeDelete,
2797 &$deleter,
2798 $reason,
2799 $id,
2800 $content,
2801 $logEntry,
2802 $archivedRevisionCount
2803 ] );
2804 $status->value = $logid;
2805
2806 // Show log excerpt on 404 pages rather than just a link
2807 $cache = MediaWikiServices::getInstance()->getMainObjectStash();
2808 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2809 $cache->set( $key, 1, $cache::TTL_DAY );
2810 }
2811
2812 return $status;
2813 }
2814
2815 /**
2816 * Archives revisions as part of page deletion.
2817 *
2818 * @param IDatabase $dbw
2819 * @param int $id
2820 * @param bool $suppress Suppress all revisions and log the deletion in
2821 * the suppression log instead of the deletion log
2822 * @return bool
2823 */
2824 protected function archiveRevisions( $dbw, $id, $suppress ) {
2825 global $wgContentHandlerUseDB, $wgMultiContentRevisionSchemaMigrationStage,
2826 $wgActorTableSchemaMigrationStage, $wgDeleteRevisionsBatchSize;
2827
2828 // Given the lock above, we can be confident in the title and page ID values
2829 $namespace = $this->getTitle()->getNamespace();
2830 $dbKey = $this->getTitle()->getDBkey();
2831
2832 $commentStore = CommentStore::getStore();
2833 $actorMigration = ActorMigration::newMigration();
2834
2835 $revQuery = Revision::getQueryInfo();
2836 $bitfield = false;
2837
2838 // Bitfields to further suppress the content
2839 if ( $suppress ) {
2840 $bitfield = Revision::SUPPRESSED_ALL;
2841 $revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
2842 }
2843
2844 // For now, shunt the revision data into the archive table.
2845 // Text is *not* removed from the text table; bulk storage
2846 // is left intact to avoid breaking block-compression or
2847 // immutable storage schemes.
2848 // In the future, we may keep revisions and mark them with
2849 // the rev_deleted field, which is reserved for this purpose.
2850
2851 // Lock rows in `revision` and its temp tables, but not any others.
2852 // Note array_intersect() preserves keys from the first arg, and we're
2853 // assuming $revQuery has `revision` primary and isn't using subtables
2854 // for anything we care about.
2855 $dbw->lockForUpdate(
2856 array_intersect(
2857 $revQuery['tables'],
2858 [ 'revision', 'revision_comment_temp', 'revision_actor_temp' ]
2859 ),
2860 [ 'rev_page' => $id ],
2861 __METHOD__,
2862 [],
2863 $revQuery['joins']
2864 );
2865
2866 // If SCHEMA_COMPAT_WRITE_OLD is set, also select all extra fields we still write,
2867 // so we can copy it to the archive table.
2868 // We know the fields exist, otherwise SCHEMA_COMPAT_WRITE_OLD could not function.
2869 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
2870 $revQuery['fields'][] = 'rev_text_id';
2871
2872 if ( $wgContentHandlerUseDB ) {
2873 $revQuery['fields'][] = 'rev_content_model';
2874 $revQuery['fields'][] = 'rev_content_format';
2875 }
2876 }
2877
2878 // Get as many of the page revisions as we are allowed to. The +1 lets us recognize the
2879 // unusual case where there were exactly $wgDeleteRevisionBatchSize revisions remaining.
2880 $res = $dbw->select(
2881 $revQuery['tables'],
2882 $revQuery['fields'],
2883 [ 'rev_page' => $id ],
2884 __METHOD__,
2885 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => $wgDeleteRevisionsBatchSize + 1 ],
2886 $revQuery['joins']
2887 );
2888
2889 // Build their equivalent archive rows
2890 $rowsInsert = [];
2891 $revids = [];
2892
2893 /** @var int[] Revision IDs of edits that were made by IPs */
2894 $ipRevIds = [];
2895
2896 $done = true;
2897 foreach ( $res as $row ) {
2898 if ( count( $revids ) >= $wgDeleteRevisionsBatchSize ) {
2899 $done = false;
2900 break;
2901 }
2902
2903 $comment = $commentStore->getComment( 'rev_comment', $row );
2904 $user = User::newFromAnyId( $row->rev_user, $row->rev_user_text, $row->rev_actor );
2905 $rowInsert = [
2906 'ar_namespace' => $namespace,
2907 'ar_title' => $dbKey,
2908 'ar_timestamp' => $row->rev_timestamp,
2909 'ar_minor_edit' => $row->rev_minor_edit,
2910 'ar_rev_id' => $row->rev_id,
2911 'ar_parent_id' => $row->rev_parent_id,
2912 /**
2913 * ar_text_id should probably not be written to when the multi content schema has
2914 * been migrated to (wgMultiContentRevisionSchemaMigrationStage) however there is no
2915 * default for the field in WMF production currently so we must keep writing
2916 * writing until a default of 0 is set.
2917 * Task: https://phabricator.wikimedia.org/T190148
2918 * Copying the value from the revision table should not lead to any issues for now.
2919 */
2920 'ar_len' => $row->rev_len,
2921 'ar_page_id' => $id,
2922 'ar_deleted' => $suppress ? $bitfield : $row->rev_deleted,
2923 'ar_sha1' => $row->rev_sha1,
2924 ] + $commentStore->insert( $dbw, 'ar_comment', $comment )
2925 + $actorMigration->getInsertValues( $dbw, 'ar_user', $user );
2926
2927 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
2928 $rowInsert['ar_text_id'] = $row->rev_text_id;
2929
2930 if ( $wgContentHandlerUseDB ) {
2931 $rowInsert['ar_content_model'] = $row->rev_content_model;
2932 $rowInsert['ar_content_format'] = $row->rev_content_format;
2933 }
2934 }
2935
2936 $rowsInsert[] = $rowInsert;
2937 $revids[] = $row->rev_id;
2938
2939 // Keep track of IP edits, so that the corresponding rows can
2940 // be deleted in the ip_changes table.
2941 if ( (int)$row->rev_user === 0 && IP::isValid( $row->rev_user_text ) ) {
2942 $ipRevIds[] = $row->rev_id;
2943 }
2944 }
2945
2946 // This conditional is just a sanity check
2947 if ( count( $revids ) > 0 ) {
2948 // Copy them into the archive table
2949 $dbw->insert( 'archive', $rowsInsert, __METHOD__ );
2950
2951 $dbw->delete( 'revision', [ 'rev_id' => $revids ], __METHOD__ );
2952 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__ );
2953 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
2954 $dbw->delete( 'revision_actor_temp', [ 'revactor_rev' => $revids ], __METHOD__ );
2955 }
2956
2957 // Also delete records from ip_changes as applicable.
2958 if ( count( $ipRevIds ) > 0 ) {
2959 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__ );
2960 }
2961 }
2962
2963 return $done;
2964 }
2965
2966 /**
2967 * Lock the page row for this title+id and return page_latest (or 0)
2968 *
2969 * @return int Returns 0 if no row was found with this title+id
2970 * @since 1.27
2971 */
2972 public function lockAndGetLatest() {
2973 return (int)wfGetDB( DB_MASTER )->selectField(
2974 'page',
2975 'page_latest',
2976 [
2977 'page_id' => $this->getId(),
2978 // Typically page_id is enough, but some code might try to do
2979 // updates assuming the title is the same, so verify that
2980 'page_namespace' => $this->getTitle()->getNamespace(),
2981 'page_title' => $this->getTitle()->getDBkey()
2982 ],
2983 __METHOD__,
2984 [ 'FOR UPDATE' ]
2985 );
2986 }
2987
2988 /**
2989 * Do some database updates after deletion
2990 *
2991 * @param int $id The page_id value of the page being deleted
2992 * @param Content|null $content Page content to be used when determining
2993 * the required updates. This may be needed because $this->getContent()
2994 * may already return null when the page proper was deleted.
2995 * @param Revision|null $revision The current page revision at the time of
2996 * deletion, used when determining the required updates. This may be needed because
2997 * $this->getRevision() may already return null when the page proper was deleted.
2998 * @param User|null $user The user that caused the deletion
2999 */
3000 public function doDeleteUpdates(
3001 $id, Content $content = null, Revision $revision = null, User $user = null
3002 ) {
3003 if ( $id !== $this->getId() ) {
3004 throw new InvalidArgumentException( 'Mismatching page ID' );
3005 }
3006
3007 try {
3008 $countable = $this->isCountable();
3009 } catch ( Exception $ex ) {
3010 // fallback for deleting broken pages for which we cannot load the content for
3011 // some reason. Note that doDeleteArticleReal() already logged this problem.
3012 $countable = false;
3013 }
3014
3015 // Update site status
3016 DeferredUpdates::addUpdate( SiteStatsUpdate::factory(
3017 [ 'edits' => 1, 'articles' => -$countable, 'pages' => -1 ]
3018 ) );
3019
3020 // Delete pagelinks, update secondary indexes, etc
3021 $updates = $this->getDeletionUpdates(
3022 $revision ? $revision->getRevisionRecord() : $content
3023 );
3024 foreach ( $updates as $update ) {
3025 DeferredUpdates::addUpdate( $update );
3026 }
3027
3028 $causeAgent = $user ? $user->getName() : 'unknown';
3029 // Reparse any pages transcluding this page
3030 LinksUpdate::queueRecursiveJobsForTable(
3031 $this->mTitle, 'templatelinks', 'delete-page', $causeAgent );
3032 // Reparse any pages including this image
3033 if ( $this->mTitle->getNamespace() == NS_FILE ) {
3034 LinksUpdate::queueRecursiveJobsForTable(
3035 $this->mTitle, 'imagelinks', 'delete-page', $causeAgent );
3036 }
3037
3038 // Clear caches
3039 self::onArticleDelete( $this->mTitle );
3040 ResourceLoaderWikiModule::invalidateModuleCache(
3041 $this->mTitle,
3042 $revision,
3043 null,
3044 WikiMap::getCurrentWikiDbDomain()->getId()
3045 );
3046
3047 // Reset this object and the Title object
3048 $this->loadFromRow( false, self::READ_LATEST );
3049
3050 // Search engine
3051 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
3052 }
3053
3054 /**
3055 * Roll back the most recent consecutive set of edits to a page
3056 * from the same user; fails if there are no eligible edits to
3057 * roll back to, e.g. user is the sole contributor. This function
3058 * performs permissions checks on $user, then calls commitRollback()
3059 * to do the dirty work
3060 *
3061 * @todo Separate the business/permission stuff out from backend code
3062 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3063 *
3064 * @param string $fromP Name of the user whose edits to rollback.
3065 * @param string $summary Custom summary. Set to default summary if empty.
3066 * @param string $token Rollback token.
3067 * @param bool $bot If true, mark all reverted edits as bot.
3068 *
3069 * @param array &$resultDetails Array contains result-specific array of additional values
3070 * 'alreadyrolled' : 'current' (rev)
3071 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3072 *
3073 * @param User $user The user performing the rollback
3074 * @param array|null $tags Change tags to apply to the rollback
3075 * Callers are responsible for permission checks
3076 * (with ChangeTags::canAddTagsAccompanyingChange)
3077 *
3078 * @return array Array of errors, each error formatted as
3079 * array(messagekey, param1, param2, ...).
3080 * On success, the array is empty. This array can also be passed to
3081 * OutputPage::showPermissionsErrorPage().
3082 */
3083 public function doRollback(
3084 $fromP, $summary, $token, $bot, &$resultDetails, User $user, $tags = null
3085 ) {
3086 $resultDetails = null;
3087
3088 // Check permissions
3089 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
3090 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
3091 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3092
3093 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3094 $errors[] = [ 'sessionfailure' ];
3095 }
3096
3097 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
3098 $errors[] = [ 'actionthrottledtext' ];
3099 }
3100
3101 // If there were errors, bail out now
3102 if ( !empty( $errors ) ) {
3103 return $errors;
3104 }
3105
3106 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3107 }
3108
3109 /**
3110 * Backend implementation of doRollback(), please refer there for parameter
3111 * and return value documentation
3112 *
3113 * NOTE: This function does NOT check ANY permissions, it just commits the
3114 * rollback to the DB. Therefore, you should only call this function direct-
3115 * ly if you want to use custom permissions checks. If you don't, use
3116 * doRollback() instead.
3117 * @param string $fromP Name of the user whose edits to rollback.
3118 * @param string $summary Custom summary. Set to default summary if empty.
3119 * @param bool $bot If true, mark all reverted edits as bot.
3120 *
3121 * @param array &$resultDetails Contains result-specific array of additional values
3122 * @param User $guser The user performing the rollback
3123 * @param array|null $tags Change tags to apply to the rollback
3124 * Callers are responsible for permission checks
3125 * (with ChangeTags::canAddTagsAccompanyingChange)
3126 *
3127 * @return array An array of error messages, as returned by Status::getErrorsArray()
3128 */
3129 public function commitRollback( $fromP, $summary, $bot,
3130 &$resultDetails, User $guser, $tags = null
3131 ) {
3132 global $wgUseRCPatrol;
3133
3134 $dbw = wfGetDB( DB_MASTER );
3135
3136 if ( wfReadOnly() ) {
3137 return [ [ 'readonlytext' ] ];
3138 }
3139
3140 // Begin revision creation cycle by creating a PageUpdater.
3141 // If the page is changed concurrently after grabParentRevision(), the rollback will fail.
3142 $updater = $this->newPageUpdater( $guser );
3143 $current = $updater->grabParentRevision();
3144
3145 if ( is_null( $current ) ) {
3146 // Something wrong... no page?
3147 return [ [ 'notanarticle' ] ];
3148 }
3149
3150 $currentEditorForPublic = $current->getUser( RevisionRecord::FOR_PUBLIC );
3151 $legacyCurrent = new Revision( $current );
3152 $from = str_replace( '_', ' ', $fromP );
3153
3154 // User name given should match up with the top revision.
3155 // If the revision's user is not visible, then $from should be empty.
3156 if ( $from !== ( $currentEditorForPublic ? $currentEditorForPublic->getName() : '' ) ) {
3157 $resultDetails = [ 'current' => $legacyCurrent ];
3158 return [ [ 'alreadyrolled',
3159 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3160 htmlspecialchars( $fromP ),
3161 htmlspecialchars( $currentEditorForPublic ? $currentEditorForPublic->getName() : '' )
3162 ] ];
3163 }
3164
3165 // Get the last edit not by this person...
3166 // Note: these may not be public values
3167 $actorWhere = ActorMigration::newMigration()->getWhere(
3168 $dbw,
3169 'rev_user',
3170 $current->getUser( RevisionRecord::RAW )
3171 );
3172
3173 $s = $dbw->selectRow(
3174 [ 'revision' ] + $actorWhere['tables'],
3175 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3176 [
3177 'rev_page' => $current->getPageId(),
3178 'NOT(' . $actorWhere['conds'] . ')',
3179 ],
3180 __METHOD__,
3181 [
3182 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
3183 'ORDER BY' => 'rev_timestamp DESC'
3184 ],
3185 $actorWhere['joins']
3186 );
3187 if ( $s === false ) {
3188 // No one else ever edited this page
3189 return [ [ 'cantrollback' ] ];
3190 } elseif ( $s->rev_deleted & RevisionRecord::DELETED_TEXT
3191 || $s->rev_deleted & RevisionRecord::DELETED_USER
3192 ) {
3193 // Only admins can see this text
3194 return [ [ 'notvisiblerev' ] ];
3195 }
3196
3197 // Generate the edit summary if necessary
3198 $target = $this->getRevisionStore()->getRevisionById(
3199 $s->rev_id,
3200 RevisionStore::READ_LATEST
3201 );
3202 if ( empty( $summary ) ) {
3203 if ( !$currentEditorForPublic ) { // no public user name
3204 $summary = wfMessage( 'revertpage-nouser' );
3205 } else {
3206 $summary = wfMessage( 'revertpage' );
3207 }
3208 }
3209 $legacyTarget = new Revision( $target );
3210 $targetEditorForPublic = $target->getUser( RevisionRecord::FOR_PUBLIC );
3211
3212 // Allow the custom summary to use the same args as the default message
3213 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
3214 $args = [
3215 $targetEditorForPublic ? $targetEditorForPublic->getName() : null,
3216 $currentEditorForPublic ? $currentEditorForPublic->getName() : null,
3217 $s->rev_id,
3218 $contLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3219 $current->getId(),
3220 $contLang->timeanddate( $current->getTimestamp() )
3221 ];
3222 if ( $summary instanceof Message ) {
3223 $summary = $summary->params( $args )->inContentLanguage()->text();
3224 } else {
3225 $summary = wfMsgReplaceArgs( $summary, $args );
3226 }
3227
3228 // Trim spaces on user supplied text
3229 $summary = trim( $summary );
3230
3231 // Save
3232 $flags = EDIT_UPDATE | EDIT_INTERNAL;
3233
3234 if ( $guser->isAllowed( 'minoredit' ) ) {
3235 $flags |= EDIT_MINOR;
3236 }
3237
3238 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3239 $flags |= EDIT_FORCE_BOT;
3240 }
3241
3242 // TODO: MCR: also log model changes in other slots, in case that becomes possible!
3243 $currentContent = $current->getContent( SlotRecord::MAIN );
3244 $targetContent = $target->getContent( SlotRecord::MAIN );
3245 $changingContentModel = $targetContent->getModel() !== $currentContent->getModel();
3246
3247 if ( in_array( 'mw-rollback', ChangeTags::getSoftwareTags() ) ) {
3248 $tags[] = 'mw-rollback';
3249 }
3250
3251 // Build rollback revision:
3252 // Restore old content
3253 // TODO: MCR: test this once we can store multiple slots
3254 foreach ( $target->getSlots()->getSlots() as $slot ) {
3255 $updater->inheritSlot( $slot );
3256 }
3257
3258 // Remove extra slots
3259 // TODO: MCR: test this once we can store multiple slots
3260 foreach ( $current->getSlotRoles() as $role ) {
3261 if ( !$target->hasSlot( $role ) ) {
3262 $updater->removeSlot( $role );
3263 }
3264 }
3265
3266 $updater->setOriginalRevisionId( $target->getId() );
3267 // Do not call setUndidRevisionId(), that causes an extra "mw-undo" tag to be added (T190374)
3268 $updater->addTags( $tags );
3269
3270 // TODO: this logic should not be in the storage layer, it's here for compatibility
3271 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
3272 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
3273 if ( $wgUseRCPatrol && $this->getTitle()->userCan( 'autopatrol', $guser ) ) {
3274 $updater->setRcPatrolStatus( RecentChange::PRC_AUTOPATROLLED );
3275 }
3276
3277 // Actually store the rollback
3278 $rev = $updater->saveRevision(
3279 CommentStoreComment::newUnsavedComment( $summary ),
3280 $flags
3281 );
3282
3283 // Set patrolling and bot flag on the edits, which gets rollbacked.
3284 // This is done even on edit failure to have patrolling in that case (T64157).
3285 $set = [];
3286 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3287 // Mark all reverted edits as bot
3288 $set['rc_bot'] = 1;
3289 }
3290
3291 if ( $wgUseRCPatrol ) {
3292 // Mark all reverted edits as patrolled
3293 $set['rc_patrolled'] = RecentChange::PRC_AUTOPATROLLED;
3294 }
3295
3296 if ( count( $set ) ) {
3297 $actorWhere = ActorMigration::newMigration()->getWhere(
3298 $dbw,
3299 'rc_user',
3300 $current->getUser( RevisionRecord::RAW ),
3301 false
3302 );
3303 $dbw->update( 'recentchanges', $set,
3304 [ /* WHERE */
3305 'rc_cur_id' => $current->getPageId(),
3306 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3307 $actorWhere['conds'], // No tables/joins are needed for rc_user
3308 ],
3309 __METHOD__
3310 );
3311 }
3312
3313 if ( !$updater->wasSuccessful() ) {
3314 return $updater->getStatus()->getErrorsArray();
3315 }
3316
3317 // Report if the edit was not created because it did not change the content.
3318 if ( $updater->isUnchanged() ) {
3319 $resultDetails = [ 'current' => $legacyCurrent ];
3320 return [ [ 'alreadyrolled',
3321 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3322 htmlspecialchars( $fromP ),
3323 htmlspecialchars( $currentEditorForPublic ? $currentEditorForPublic->getName() : '' )
3324 ] ];
3325 }
3326
3327 if ( $changingContentModel ) {
3328 // If the content model changed during the rollback,
3329 // make sure it gets logged to Special:Log/contentmodel
3330 $log = new ManualLogEntry( 'contentmodel', 'change' );
3331 $log->setPerformer( $guser );
3332 $log->setTarget( $this->mTitle );
3333 $log->setComment( $summary );
3334 $log->setParameters( [
3335 '4::oldmodel' => $currentContent->getModel(),
3336 '5::newmodel' => $targetContent->getModel(),
3337 ] );
3338
3339 $logId = $log->insert( $dbw );
3340 $log->publish( $logId );
3341 }
3342
3343 $revId = $rev->getId();
3344
3345 Hooks::run( 'ArticleRollbackComplete', [ $this, $guser, $legacyTarget, $legacyCurrent ] );
3346
3347 $resultDetails = [
3348 'summary' => $summary,
3349 'current' => $legacyCurrent,
3350 'target' => $legacyTarget,
3351 'newid' => $revId,
3352 'tags' => $tags
3353 ];
3354
3355 // TODO: make this return a Status object and wrap $resultDetails in that.
3356 return [];
3357 }
3358
3359 /**
3360 * The onArticle*() functions are supposed to be a kind of hooks
3361 * which should be called whenever any of the specified actions
3362 * are done.
3363 *
3364 * This is a good place to put code to clear caches, for instance.
3365 *
3366 * This is called on page move and undelete, as well as edit
3367 *
3368 * @param Title $title
3369 */
3370 public static function onArticleCreate( Title $title ) {
3371 // TODO: move this into a PageEventEmitter service
3372
3373 // Update existence markers on article/talk tabs...
3374 $other = $title->getOtherPage();
3375
3376 $other->purgeSquid();
3377
3378 $title->touchLinks();
3379 $title->purgeSquid();
3380 $title->deleteTitleProtection();
3381
3382 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3383
3384 // Invalidate caches of articles which include this page
3385 DeferredUpdates::addUpdate(
3386 new HTMLCacheUpdate( $title, 'templatelinks', 'page-create' )
3387 );
3388
3389 if ( $title->getNamespace() == NS_CATEGORY ) {
3390 // Load the Category object, which will schedule a job to create
3391 // the category table row if necessary. Checking a replica DB is ok
3392 // here, in the worst case it'll run an unnecessary recount job on
3393 // a category that probably doesn't have many members.
3394 Category::newFromTitle( $title )->getID();
3395 }
3396 }
3397
3398 /**
3399 * Clears caches when article is deleted
3400 *
3401 * @param Title $title
3402 */
3403 public static function onArticleDelete( Title $title ) {
3404 // TODO: move this into a PageEventEmitter service
3405
3406 // Update existence markers on article/talk tabs...
3407 // Clear Backlink cache first so that purge jobs use more up-to-date backlink information
3408 BacklinkCache::get( $title )->clear();
3409 $other = $title->getOtherPage();
3410
3411 $other->purgeSquid();
3412
3413 $title->touchLinks();
3414 $title->purgeSquid();
3415
3416 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3417
3418 // File cache
3419 HTMLFileCache::clearFileCache( $title );
3420 InfoAction::invalidateCache( $title );
3421
3422 // Messages
3423 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3424 MessageCache::singleton()->updateMessageOverride( $title, null );
3425 }
3426
3427 // Images
3428 if ( $title->getNamespace() == NS_FILE ) {
3429 DeferredUpdates::addUpdate(
3430 new HTMLCacheUpdate( $title, 'imagelinks', 'page-delete' )
3431 );
3432 }
3433
3434 // User talk pages
3435 if ( $title->getNamespace() == NS_USER_TALK ) {
3436 $user = User::newFromName( $title->getText(), false );
3437 if ( $user ) {
3438 $user->setNewtalk( false );
3439 }
3440 }
3441
3442 // Image redirects
3443 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3444
3445 // Purge cross-wiki cache entities referencing this page
3446 self::purgeInterwikiCheckKey( $title );
3447 }
3448
3449 /**
3450 * Purge caches on page update etc
3451 *
3452 * @param Title $title
3453 * @param Revision|null $revision Revision that was just saved, may be null
3454 * @param string[]|null $slotsChanged The role names of the slots that were changed.
3455 * If not given, all slots are assumed to have changed.
3456 */
3457 public static function onArticleEdit(
3458 Title $title,
3459 Revision $revision = null,
3460 $slotsChanged = null
3461 ) {
3462 // TODO: move this into a PageEventEmitter service
3463
3464 if ( $slotsChanged === null || in_array( SlotRecord::MAIN, $slotsChanged ) ) {
3465 // Invalidate caches of articles which include this page.
3466 // Only for the main slot, because only the main slot is transcluded.
3467 // TODO: MCR: not true for TemplateStyles! [SlotHandler]
3468 DeferredUpdates::addUpdate(
3469 new HTMLCacheUpdate( $title, 'templatelinks', 'page-edit' )
3470 );
3471 }
3472
3473 // Invalidate the caches of all pages which redirect here
3474 DeferredUpdates::addUpdate(
3475 new HTMLCacheUpdate( $title, 'redirect', 'page-edit' )
3476 );
3477
3478 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3479
3480 // Purge CDN for this page only
3481 $title->purgeSquid();
3482 // Clear file cache for this page only
3483 HTMLFileCache::clearFileCache( $title );
3484
3485 // Purge ?action=info cache
3486 $revid = $revision ? $revision->getId() : null;
3487 DeferredUpdates::addCallableUpdate( function () use ( $title, $revid ) {
3488 InfoAction::invalidateCache( $title, $revid );
3489 } );
3490
3491 // Purge cross-wiki cache entities referencing this page
3492 self::purgeInterwikiCheckKey( $title );
3493 }
3494
3495 /**#@-*/
3496
3497 /**
3498 * Purge the check key for cross-wiki cache entries referencing this page
3499 *
3500 * @param Title $title
3501 */
3502 private static function purgeInterwikiCheckKey( Title $title ) {
3503 global $wgEnableScaryTranscluding;
3504
3505 if ( !$wgEnableScaryTranscluding ) {
3506 return; // @todo: perhaps this wiki is only used as a *source* for content?
3507 }
3508
3509 DeferredUpdates::addCallableUpdate( function () use ( $title ) {
3510 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
3511 $cache->resetCheckKey(
3512 // Do not include the namespace since there can be multiple aliases to it
3513 // due to different namespace text definitions on different wikis. This only
3514 // means that some cache invalidations happen that are not strictly needed.
3515 $cache->makeGlobalKey(
3516 'interwiki-page',
3517 WikiMap::getCurrentWikiDbDomain()->getId(),
3518 $title->getDBkey()
3519 )
3520 );
3521 } );
3522 }
3523
3524 /**
3525 * Returns a list of categories this page is a member of.
3526 * Results will include hidden categories
3527 *
3528 * @return TitleArray
3529 */
3530 public function getCategories() {
3531 $id = $this->getId();
3532 if ( $id == 0 ) {
3533 return TitleArray::newFromResult( new FakeResultWrapper( [] ) );
3534 }
3535
3536 $dbr = wfGetDB( DB_REPLICA );
3537 $res = $dbr->select( 'categorylinks',
3538 [ 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ],
3539 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3540 // as not being aliases, and NS_CATEGORY is numeric
3541 [ 'cl_from' => $id ],
3542 __METHOD__ );
3543
3544 return TitleArray::newFromResult( $res );
3545 }
3546
3547 /**
3548 * Returns a list of hidden categories this page is a member of.
3549 * Uses the page_props and categorylinks tables.
3550 *
3551 * @return array Array of Title objects
3552 */
3553 public function getHiddenCategories() {
3554 $result = [];
3555 $id = $this->getId();
3556
3557 if ( $id == 0 ) {
3558 return [];
3559 }
3560
3561 $dbr = wfGetDB( DB_REPLICA );
3562 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3563 [ 'cl_to' ],
3564 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3565 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ],
3566 __METHOD__ );
3567
3568 if ( $res !== false ) {
3569 foreach ( $res as $row ) {
3570 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3571 }
3572 }
3573
3574 return $result;
3575 }
3576
3577 /**
3578 * Auto-generates a deletion reason
3579 *
3580 * @param bool &$hasHistory Whether the page has a history
3581 * @return string|bool String containing deletion reason or empty string, or boolean false
3582 * if no revision occurred
3583 */
3584 public function getAutoDeleteReason( &$hasHistory ) {
3585 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3586 }
3587
3588 /**
3589 * Update all the appropriate counts in the category table, given that
3590 * we've added the categories $added and deleted the categories $deleted.
3591 *
3592 * This should only be called from deferred updates or jobs to avoid contention.
3593 *
3594 * @param array $added The names of categories that were added
3595 * @param array $deleted The names of categories that were deleted
3596 * @param int $id Page ID (this should be the original deleted page ID)
3597 */
3598 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3599 $id = $id ?: $this->getId();
3600 $type = MediaWikiServices::getInstance()->getNamespaceInfo()->
3601 getCategoryLinkType( $this->getTitle()->getNamespace() );
3602
3603 $addFields = [ 'cat_pages = cat_pages + 1' ];
3604 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3605 if ( $type !== 'page' ) {
3606 $addFields[] = "cat_{$type}s = cat_{$type}s + 1";
3607 $removeFields[] = "cat_{$type}s = cat_{$type}s - 1";
3608 }
3609
3610 $dbw = wfGetDB( DB_MASTER );
3611
3612 if ( count( $added ) ) {
3613 $existingAdded = $dbw->selectFieldValues(
3614 'category',
3615 'cat_title',
3616 [ 'cat_title' => $added ],
3617 __METHOD__
3618 );
3619
3620 // For category rows that already exist, do a plain
3621 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3622 // to avoid creating gaps in the cat_id sequence.
3623 if ( count( $existingAdded ) ) {
3624 $dbw->update(
3625 'category',
3626 $addFields,
3627 [ 'cat_title' => $existingAdded ],
3628 __METHOD__
3629 );
3630 }
3631
3632 $missingAdded = array_diff( $added, $existingAdded );
3633 if ( count( $missingAdded ) ) {
3634 $insertRows = [];
3635 foreach ( $missingAdded as $cat ) {
3636 $insertRows[] = [
3637 'cat_title' => $cat,
3638 'cat_pages' => 1,
3639 'cat_subcats' => ( $type === 'subcat' ) ? 1 : 0,
3640 'cat_files' => ( $type === 'file' ) ? 1 : 0,
3641 ];
3642 }
3643 $dbw->upsert(
3644 'category',
3645 $insertRows,
3646 [ 'cat_title' ],
3647 $addFields,
3648 __METHOD__
3649 );
3650 }
3651 }
3652
3653 if ( count( $deleted ) ) {
3654 $dbw->update(
3655 'category',
3656 $removeFields,
3657 [ 'cat_title' => $deleted ],
3658 __METHOD__
3659 );
3660 }
3661
3662 foreach ( $added as $catName ) {
3663 $cat = Category::newFromName( $catName );
3664 Hooks::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3665 }
3666
3667 foreach ( $deleted as $catName ) {
3668 $cat = Category::newFromName( $catName );
3669 Hooks::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3670 // Refresh counts on categories that should be empty now (after commit, T166757)
3671 DeferredUpdates::addCallableUpdate( function () use ( $cat ) {
3672 $cat->refreshCountsIfEmpty();
3673 } );
3674 }
3675 }
3676
3677 /**
3678 * Opportunistically enqueue link update jobs given fresh parser output if useful
3679 *
3680 * @param ParserOutput $parserOutput Current version page output
3681 * @since 1.25
3682 */
3683 public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
3684 if ( wfReadOnly() ) {
3685 return;
3686 }
3687
3688 if ( !Hooks::run( 'OpportunisticLinksUpdate',
3689 [ $this, $this->mTitle, $parserOutput ]
3690 ) ) {
3691 return;
3692 }
3693
3694 $config = RequestContext::getMain()->getConfig();
3695
3696 $params = [
3697 'isOpportunistic' => true,
3698 'rootJobTimestamp' => $parserOutput->getCacheTime()
3699 ];
3700
3701 if ( $this->mTitle->areRestrictionsCascading() ) {
3702 // If the page is cascade protecting, the links should really be up-to-date
3703 JobQueueGroup::singleton()->lazyPush(
3704 RefreshLinksJob::newPrioritized( $this->mTitle, $params )
3705 );
3706 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3707 // Assume the output contains "dynamic" time/random based magic words.
3708 // Only update pages that expired due to dynamic content and NOT due to edits
3709 // to referenced templates/files. When the cache expires due to dynamic content,
3710 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3711 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3712 // template/file edit already triggered recursive RefreshLinksJob jobs.
3713 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3714 // If a page is uncacheable, do not keep spamming a job for it.
3715 // Although it would be de-duplicated, it would still waste I/O.
3716 $cache = ObjectCache::getLocalClusterInstance();
3717 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3718 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3719 if ( $cache->add( $key, time(), $ttl ) ) {
3720 JobQueueGroup::singleton()->lazyPush(
3721 RefreshLinksJob::newDynamic( $this->mTitle, $params )
3722 );
3723 }
3724 }
3725 }
3726 }
3727
3728 /**
3729 * Returns a list of updates to be performed when this page is deleted. The
3730 * updates should remove any information about this page from secondary data
3731 * stores such as links tables.
3732 *
3733 * @param RevisionRecord|Content|null $rev The revision being deleted. Also accepts a Content
3734 * object for backwards compatibility.
3735 * @return DeferrableUpdate[]
3736 */
3737 public function getDeletionUpdates( $rev = null ) {
3738 if ( !$rev ) {
3739 wfDeprecated( __METHOD__ . ' without a RevisionRecord', '1.32' );
3740
3741 try {
3742 $rev = $this->getRevisionRecord();
3743 } catch ( Exception $ex ) {
3744 // If we can't load the content, something is wrong. Perhaps that's why
3745 // the user is trying to delete the page, so let's not fail in that case.
3746 // Note that doDeleteArticleReal() will already have logged an issue with
3747 // loading the content.
3748 wfDebug( __METHOD__ . ' failed to load current revision of page ' . $this->getId() );
3749 }
3750 }
3751
3752 if ( !$rev ) {
3753 $slotContent = [];
3754 } elseif ( $rev instanceof Content ) {
3755 wfDeprecated( __METHOD__ . ' with a Content object instead of a RevisionRecord', '1.32' );
3756
3757 $slotContent = [ SlotRecord::MAIN => $rev ];
3758 } else {
3759 $slotContent = array_map( function ( SlotRecord $slot ) {
3760 return $slot->getContent( Revision::RAW );
3761 }, $rev->getSlots()->getSlots() );
3762 }
3763
3764 $allUpdates = [ new LinksDeletionUpdate( $this ) ];
3765
3766 // NOTE: once Content::getDeletionUpdates() is removed, we only need to content
3767 // model here, not the content object!
3768 // TODO: consolidate with similar logic in DerivedPageDataUpdater::getSecondaryDataUpdates()
3769 /** @var Content $content */
3770 foreach ( $slotContent as $role => $content ) {
3771 $handler = $content->getContentHandler();
3772
3773 $updates = $handler->getDeletionUpdates(
3774 $this->getTitle(),
3775 $role
3776 );
3777 $allUpdates = array_merge( $allUpdates, $updates );
3778
3779 // TODO: remove B/C hack in 1.32!
3780 $legacyUpdates = $content->getDeletionUpdates( $this );
3781
3782 // HACK: filter out redundant and incomplete LinksDeletionUpdate
3783 $legacyUpdates = array_filter( $legacyUpdates, function ( $update ) {
3784 return !( $update instanceof LinksDeletionUpdate );
3785 } );
3786
3787 $allUpdates = array_merge( $allUpdates, $legacyUpdates );
3788 }
3789
3790 Hooks::run( 'PageDeletionDataUpdates', [ $this->getTitle(), $rev, &$allUpdates ] );
3791
3792 // TODO: hard deprecate old hook in 1.33
3793 Hooks::run( 'WikiPageDeletionUpdates', [ $this, $content, &$allUpdates ] );
3794 return $allUpdates;
3795 }
3796
3797 /**
3798 * Whether this content displayed on this page
3799 * comes from the local database
3800 *
3801 * @since 1.28
3802 * @return bool
3803 */
3804 public function isLocal() {
3805 return true;
3806 }
3807
3808 /**
3809 * The display name for the site this content
3810 * come from. If a subclass overrides isLocal(),
3811 * this could return something other than the
3812 * current site name
3813 *
3814 * @since 1.28
3815 * @return string
3816 */
3817 public function getWikiDisplayName() {
3818 global $wgSitename;
3819 return $wgSitename;
3820 }
3821
3822 /**
3823 * Get the source URL for the content on this page,
3824 * typically the canonical URL, but may be a remote
3825 * link if the content comes from another site
3826 *
3827 * @since 1.28
3828 * @return string
3829 */
3830 public function getSourceURL() {
3831 return $this->getTitle()->getCanonicalURL();
3832 }
3833
3834 /**
3835 * @param WANObjectCache $cache
3836 * @return string[]
3837 * @since 1.28
3838 */
3839 public function getMutableCacheKeys( WANObjectCache $cache ) {
3840 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3841
3842 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle() );
3843 }
3844
3845 }