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