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