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