Improve some parameter docs
[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 if ( $dbr->implicitGroupby() ) {
987 $realNameField = 'user_real_name';
988 } else {
989 $realNameField = 'MIN(user_real_name) AS user_real_name';
990 }
991
992 $tables = [ 'revision', 'user' ];
993
994 $fields = [
995 'user_id' => 'rev_user',
996 'user_name' => 'rev_user_text',
997 $realNameField,
998 'timestamp' => 'MAX(rev_timestamp)',
999 ];
1000
1001 $conds = [ 'rev_page' => $this->getId() ];
1002
1003 // The user who made the top revision gets credited as "this page was last edited by
1004 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1005 $user = $this->getUser();
1006 if ( $user ) {
1007 $conds[] = "rev_user != $user";
1008 } else {
1009 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1010 }
1011
1012 // Username hidden?
1013 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1014
1015 $jconds = [
1016 'user' => [ 'LEFT JOIN', 'rev_user = user_id' ],
1017 ];
1018
1019 $options = [
1020 'GROUP BY' => [ 'rev_user', 'rev_user_text' ],
1021 'ORDER BY' => 'timestamp DESC',
1022 ];
1023
1024 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1025 return new UserArrayFromResult( $res );
1026 }
1027
1028 /**
1029 * Should the parser cache be used?
1030 *
1031 * @param ParserOptions $parserOptions ParserOptions to check
1032 * @param int $oldId
1033 * @return bool
1034 */
1035 public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) {
1036 return $parserOptions->getStubThreshold() == 0
1037 && $this->exists()
1038 && ( $oldId === null || $oldId === 0 || $oldId === $this->getLatest() )
1039 && $this->getContentHandler()->isParserCacheSupported();
1040 }
1041
1042 /**
1043 * Get a ParserOutput for the given ParserOptions and revision ID.
1044 *
1045 * The parser cache will be used if possible. Cache misses that result
1046 * in parser runs are debounced with PoolCounter.
1047 *
1048 * @since 1.19
1049 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1050 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1051 * get the current revision (default value)
1052 * @param bool $forceParse Force reindexing, regardless of cache settings
1053 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1054 */
1055 public function getParserOutput(
1056 ParserOptions $parserOptions, $oldid = null, $forceParse = false
1057 ) {
1058 $useParserCache =
1059 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1060
1061 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1062 throw new InvalidArgumentException(
1063 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1064 );
1065 }
1066
1067 wfDebug( __METHOD__ .
1068 ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1069 if ( $parserOptions->getStubThreshold() ) {
1070 wfIncrStats( 'pcache.miss.stub' );
1071 }
1072
1073 if ( $useParserCache ) {
1074 $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
1075 if ( $parserOutput !== false ) {
1076 return $parserOutput;
1077 }
1078 }
1079
1080 if ( $oldid === null || $oldid === 0 ) {
1081 $oldid = $this->getLatest();
1082 }
1083
1084 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1085 $pool->execute();
1086
1087 return $pool->getParserOutput();
1088 }
1089
1090 /**
1091 * Do standard deferred updates after page view (existing or missing page)
1092 * @param User $user The relevant user
1093 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1094 */
1095 public function doViewUpdates( User $user, $oldid = 0 ) {
1096 if ( wfReadOnly() ) {
1097 return;
1098 }
1099
1100 Hooks::run( 'PageViewUpdates', [ $this, $user ] );
1101 // Update newtalk / watchlist notification status
1102 try {
1103 $user->clearNotification( $this->mTitle, $oldid );
1104 } catch ( DBError $e ) {
1105 // Avoid outage if the master is not reachable
1106 MWExceptionHandler::logException( $e );
1107 }
1108 }
1109
1110 /**
1111 * Perform the actions of a page purging
1112 * @return bool
1113 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1114 * controlled how much purging was done.
1115 */
1116 public function doPurge() {
1117 // Avoid PHP 7.1 warning of passing $this by reference
1118 $wikiPage = $this;
1119
1120 if ( !Hooks::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1121 return false;
1122 }
1123
1124 $this->mTitle->invalidateCache();
1125
1126 // Clear file cache
1127 HTMLFileCache::clearFileCache( $this->getTitle() );
1128 // Send purge after above page_touched update was committed
1129 DeferredUpdates::addUpdate(
1130 new CdnCacheUpdate( $this->mTitle->getCdnUrls() ),
1131 DeferredUpdates::PRESEND
1132 );
1133
1134 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1135 $messageCache = MessageCache::singleton();
1136 $messageCache->updateMessageOverride( $this->mTitle, $this->getContent() );
1137 }
1138
1139 return true;
1140 }
1141
1142 /**
1143 * Get the last time a user explicitly purged the page via action=purge
1144 *
1145 * @return string|bool TS_MW timestamp or false
1146 * @since 1.28
1147 * @deprecated since 1.29. It will always return false.
1148 */
1149 public function getLastPurgeTimestamp() {
1150 wfDeprecated( __METHOD__, '1.29' );
1151 return false;
1152 }
1153
1154 /**
1155 * Insert a new empty page record for this article.
1156 * This *must* be followed up by creating a revision
1157 * and running $this->updateRevisionOn( ... );
1158 * or else the record will be left in a funky state.
1159 * Best if all done inside a transaction.
1160 *
1161 * @param IDatabase $dbw
1162 * @param int|null $pageId Custom page ID that will be used for the insert statement
1163 *
1164 * @return bool|int The newly created page_id key; false if the row was not
1165 * inserted, e.g. because the title already existed or because the specified
1166 * page ID is already in use.
1167 */
1168 public function insertOn( $dbw, $pageId = null ) {
1169 $pageIdForInsert = $pageId ? [ 'page_id' => $pageId ] : [];
1170 $dbw->insert(
1171 'page',
1172 [
1173 'page_namespace' => $this->mTitle->getNamespace(),
1174 'page_title' => $this->mTitle->getDBkey(),
1175 'page_restrictions' => '',
1176 'page_is_redirect' => 0, // Will set this shortly...
1177 'page_is_new' => 1,
1178 'page_random' => wfRandom(),
1179 'page_touched' => $dbw->timestamp(),
1180 'page_latest' => 0, // Fill this in shortly...
1181 'page_len' => 0, // Fill this in shortly...
1182 ] + $pageIdForInsert,
1183 __METHOD__,
1184 'IGNORE'
1185 );
1186
1187 if ( $dbw->affectedRows() > 0 ) {
1188 $newid = $pageId ? (int)$pageId : $dbw->insertId();
1189 $this->mId = $newid;
1190 $this->mTitle->resetArticleID( $newid );
1191
1192 return $newid;
1193 } else {
1194 return false; // nothing changed
1195 }
1196 }
1197
1198 /**
1199 * Update the page record to point to a newly saved revision.
1200 *
1201 * @param IDatabase $dbw
1202 * @param Revision $revision For ID number, and text used to set
1203 * length and redirect status fields
1204 * @param int $lastRevision If given, will not overwrite the page field
1205 * when different from the currently set value.
1206 * Giving 0 indicates the new page flag should be set on.
1207 * @param bool $lastRevIsRedirect If given, will optimize adding and
1208 * removing rows in redirect table.
1209 * @return bool Success; false if the page row was missing or page_latest changed
1210 */
1211 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1212 $lastRevIsRedirect = null
1213 ) {
1214 global $wgContentHandlerUseDB;
1215
1216 // Assertion to try to catch T92046
1217 if ( (int)$revision->getId() === 0 ) {
1218 throw new InvalidArgumentException(
1219 __METHOD__ . ': Revision has ID ' . var_export( $revision->getId(), 1 )
1220 );
1221 }
1222
1223 $content = $revision->getContent();
1224 $len = $content ? $content->getSize() : 0;
1225 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1226
1227 $conditions = [ 'page_id' => $this->getId() ];
1228
1229 if ( !is_null( $lastRevision ) ) {
1230 // An extra check against threads stepping on each other
1231 $conditions['page_latest'] = $lastRevision;
1232 }
1233
1234 $row = [ /* SET */
1235 'page_latest' => $revision->getId(),
1236 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1237 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
1238 'page_is_redirect' => $rt !== null ? 1 : 0,
1239 'page_len' => $len,
1240 ];
1241
1242 if ( $wgContentHandlerUseDB ) {
1243 $row['page_content_model'] = $revision->getContentModel();
1244 }
1245
1246 $dbw->update( 'page',
1247 $row,
1248 $conditions,
1249 __METHOD__ );
1250
1251 $result = $dbw->affectedRows() > 0;
1252 if ( $result ) {
1253 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1254 $this->setLastEdit( $revision );
1255 $this->mLatest = $revision->getId();
1256 $this->mIsRedirect = (bool)$rt;
1257 // Update the LinkCache.
1258 LinkCache::singleton()->addGoodLinkObj(
1259 $this->getId(),
1260 $this->mTitle,
1261 $len,
1262 $this->mIsRedirect,
1263 $this->mLatest,
1264 $revision->getContentModel()
1265 );
1266 }
1267
1268 return $result;
1269 }
1270
1271 /**
1272 * Add row to the redirect table if this is a redirect, remove otherwise.
1273 *
1274 * @param IDatabase $dbw
1275 * @param Title $redirectTitle Title object pointing to the redirect target,
1276 * or NULL if this is not a redirect
1277 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1278 * removing rows in redirect table.
1279 * @return bool True on success, false on failure
1280 * @private
1281 */
1282 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1283 // Always update redirects (target link might have changed)
1284 // Update/Insert if we don't know if the last revision was a redirect or not
1285 // Delete if changing from redirect to non-redirect
1286 $isRedirect = !is_null( $redirectTitle );
1287
1288 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1289 return true;
1290 }
1291
1292 if ( $isRedirect ) {
1293 $this->insertRedirectEntry( $redirectTitle );
1294 } else {
1295 // This is not a redirect, remove row from redirect table
1296 $where = [ 'rd_from' => $this->getId() ];
1297 $dbw->delete( 'redirect', $where, __METHOD__ );
1298 }
1299
1300 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1301 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1302 }
1303
1304 return ( $dbw->affectedRows() != 0 );
1305 }
1306
1307 /**
1308 * If the given revision is newer than the currently set page_latest,
1309 * update the page record. Otherwise, do nothing.
1310 *
1311 * @deprecated since 1.24, use updateRevisionOn instead
1312 *
1313 * @param IDatabase $dbw
1314 * @param Revision $revision
1315 * @return bool
1316 */
1317 public function updateIfNewerOn( $dbw, $revision ) {
1318 $row = $dbw->selectRow(
1319 [ 'revision', 'page' ],
1320 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1321 [
1322 'page_id' => $this->getId(),
1323 'page_latest=rev_id' ],
1324 __METHOD__ );
1325
1326 if ( $row ) {
1327 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1328 return false;
1329 }
1330 $prev = $row->rev_id;
1331 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1332 } else {
1333 // No or missing previous revision; mark the page as new
1334 $prev = 0;
1335 $lastRevIsRedirect = null;
1336 }
1337
1338 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1339
1340 return $ret;
1341 }
1342
1343 /**
1344 * Get the content that needs to be saved in order to undo all revisions
1345 * between $undo and $undoafter. Revisions must belong to the same page,
1346 * must exist and must not be deleted
1347 * @param Revision $undo
1348 * @param Revision $undoafter Must be an earlier revision than $undo
1349 * @return Content|bool Content on success, false on failure
1350 * @since 1.21
1351 * Before we had the Content object, this was done in getUndoText
1352 */
1353 public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1354 $handler = $undo->getContentHandler();
1355 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1356 }
1357
1358 /**
1359 * Returns true if this page's content model supports sections.
1360 *
1361 * @return bool
1362 *
1363 * @todo The skin should check this and not offer section functionality if
1364 * sections are not supported.
1365 * @todo The EditPage should check this and not offer section functionality
1366 * if sections are not supported.
1367 */
1368 public function supportsSections() {
1369 return $this->getContentHandler()->supportsSections();
1370 }
1371
1372 /**
1373 * @param string|int|null|bool $sectionId Section identifier as a number or string
1374 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1375 * or 'new' for a new section.
1376 * @param Content $sectionContent New content of the section.
1377 * @param string $sectionTitle New section's subject, only if $section is "new".
1378 * @param string $edittime Revision timestamp or null to use the current revision.
1379 *
1380 * @throws MWException
1381 * @return Content|null New complete article content, or null if error.
1382 *
1383 * @since 1.21
1384 * @deprecated since 1.24, use replaceSectionAtRev instead
1385 */
1386 public function replaceSectionContent(
1387 $sectionId, Content $sectionContent, $sectionTitle = '', $edittime = null
1388 ) {
1389 $baseRevId = null;
1390 if ( $edittime && $sectionId !== 'new' ) {
1391 $dbr = wfGetDB( DB_REPLICA );
1392 $rev = Revision::loadFromTimestamp( $dbr, $this->mTitle, $edittime );
1393 // Try the master if this thread may have just added it.
1394 // This could be abstracted into a Revision method, but we don't want
1395 // to encourage loading of revisions by timestamp.
1396 if ( !$rev
1397 && wfGetLB()->getServerCount() > 1
1398 && wfGetLB()->hasOrMadeRecentMasterChanges()
1399 ) {
1400 $dbw = wfGetDB( DB_MASTER );
1401 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1402 }
1403 if ( $rev ) {
1404 $baseRevId = $rev->getId();
1405 }
1406 }
1407
1408 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1409 }
1410
1411 /**
1412 * @param string|int|null|bool $sectionId Section identifier as a number or string
1413 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1414 * or 'new' for a new section.
1415 * @param Content $sectionContent New content of the section.
1416 * @param string $sectionTitle New section's subject, only if $section is "new".
1417 * @param int|null $baseRevId
1418 *
1419 * @throws MWException
1420 * @return Content|null New complete article content, or null if error.
1421 *
1422 * @since 1.24
1423 */
1424 public function replaceSectionAtRev( $sectionId, Content $sectionContent,
1425 $sectionTitle = '', $baseRevId = null
1426 ) {
1427 if ( strval( $sectionId ) === '' ) {
1428 // Whole-page edit; let the whole text through
1429 $newContent = $sectionContent;
1430 } else {
1431 if ( !$this->supportsSections() ) {
1432 throw new MWException( "sections not supported for content model " .
1433 $this->getContentHandler()->getModelID() );
1434 }
1435
1436 // T32711: always use current version when adding a new section
1437 if ( is_null( $baseRevId ) || $sectionId === 'new' ) {
1438 $oldContent = $this->getContent();
1439 } else {
1440 $rev = Revision::newFromId( $baseRevId );
1441 if ( !$rev ) {
1442 wfDebug( __METHOD__ . " asked for bogus section (page: " .
1443 $this->getId() . "; section: $sectionId)\n" );
1444 return null;
1445 }
1446
1447 $oldContent = $rev->getContent();
1448 }
1449
1450 if ( !$oldContent ) {
1451 wfDebug( __METHOD__ . ": no page text\n" );
1452 return null;
1453 }
1454
1455 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1456 }
1457
1458 return $newContent;
1459 }
1460
1461 /**
1462 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1463 * @param int $flags
1464 * @return int Updated $flags
1465 */
1466 public function checkFlags( $flags ) {
1467 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1468 if ( $this->exists() ) {
1469 $flags |= EDIT_UPDATE;
1470 } else {
1471 $flags |= EDIT_NEW;
1472 }
1473 }
1474
1475 return $flags;
1476 }
1477
1478 /**
1479 * Change an existing article or create a new article. Updates RC and all necessary caches,
1480 * optionally via the deferred update array.
1481 *
1482 * @param Content $content New content
1483 * @param string $summary Edit summary
1484 * @param int $flags Bitfield:
1485 * EDIT_NEW
1486 * Article is known or assumed to be non-existent, create a new one
1487 * EDIT_UPDATE
1488 * Article is known or assumed to be pre-existing, update it
1489 * EDIT_MINOR
1490 * Mark this edit minor, if the user is allowed to do so
1491 * EDIT_SUPPRESS_RC
1492 * Do not log the change in recentchanges
1493 * EDIT_FORCE_BOT
1494 * Mark the edit a "bot" edit regardless of user rights
1495 * EDIT_AUTOSUMMARY
1496 * Fill in blank summaries with generated text where possible
1497 * EDIT_INTERNAL
1498 * Signal that the page retrieve/save cycle happened entirely in this request.
1499 *
1500 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1501 * article will be detected. If EDIT_UPDATE is specified and the article
1502 * doesn't exist, the function will return an edit-gone-missing error. If
1503 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1504 * error will be returned. These two conditions are also possible with
1505 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1506 *
1507 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1508 * This is not the parent revision ID, rather the revision ID for older
1509 * content used as the source for a rollback, for example.
1510 * @param User $user The user doing the edit
1511 * @param string $serialFormat Format for storing the content in the
1512 * database.
1513 * @param array|null $tags Change tags to apply to this edit
1514 * Callers are responsible for permission checks
1515 * (with ChangeTags::canAddTagsAccompanyingChange)
1516 * @param Int $undidRevId Id of revision that was undone or 0
1517 *
1518 * @throws MWException
1519 * @return Status Possible errors:
1520 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1521 * set the fatal flag of $status.
1522 * edit-gone-missing: In update mode, but the article didn't exist.
1523 * edit-conflict: In update mode, the article changed unexpectedly.
1524 * edit-no-change: Warning that the text was the same as before.
1525 * edit-already-exists: In creation mode, but the article already exists.
1526 *
1527 * Extensions may define additional errors.
1528 *
1529 * $return->value will contain an associative array with members as follows:
1530 * new: Boolean indicating if the function attempted to create a new article.
1531 * revision: The revision object for the inserted revision, or null.
1532 *
1533 * @since 1.21
1534 * @throws MWException
1535 */
1536 public function doEditContent(
1537 Content $content, $summary, $flags = 0, $baseRevId = false,
1538 User $user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1539 ) {
1540 global $wgUser, $wgUseAutomaticEditSummaries;
1541
1542 // Old default parameter for $tags was null
1543 if ( $tags === null ) {
1544 $tags = [];
1545 }
1546
1547 // Low-level sanity check
1548 if ( $this->mTitle->getText() === '' ) {
1549 throw new MWException( 'Something is trying to edit an article with an empty title' );
1550 }
1551 // Make sure the given content type is allowed for this page
1552 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle ) ) {
1553 return Status::newFatal( 'content-not-allowed-here',
1554 ContentHandler::getLocalizedName( $content->getModel() ),
1555 $this->mTitle->getPrefixedText()
1556 );
1557 }
1558
1559 // Load the data from the master database if needed.
1560 // The caller may already loaded it from the master or even loaded it using
1561 // SELECT FOR UPDATE, so do not override that using clear().
1562 $this->loadPageData( 'fromdbmaster' );
1563
1564 $user = $user ?: $wgUser;
1565 $flags = $this->checkFlags( $flags );
1566
1567 // Avoid PHP 7.1 warning of passing $this by reference
1568 $wikiPage = $this;
1569
1570 // Trigger pre-save hook (using provided edit summary)
1571 $hookStatus = Status::newGood( [] );
1572 $hook_args = [ &$wikiPage, &$user, &$content, &$summary,
1573 $flags & EDIT_MINOR, null, null, &$flags, &$hookStatus ];
1574 // Check if the hook rejected the attempted save
1575 if ( !Hooks::run( 'PageContentSave', $hook_args ) ) {
1576 if ( $hookStatus->isOK() ) {
1577 // Hook returned false but didn't call fatal(); use generic message
1578 $hookStatus->fatal( 'edit-hook-aborted' );
1579 }
1580
1581 return $hookStatus;
1582 }
1583
1584 $old_revision = $this->getRevision(); // current revision
1585 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1586
1587 if ( $old_content && $old_content->getModel() !== $content->getModel() ) {
1588 $tags[] = 'mw-contentmodelchange';
1589 }
1590
1591 // Provide autosummaries if one is not provided and autosummaries are enabled
1592 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY ) && $summary == '' ) {
1593 $handler = $content->getContentHandler();
1594 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1595 }
1596
1597 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1598 if ( ( $flags & EDIT_INTERNAL ) || ( $flags & EDIT_FORCE_BOT ) ) {
1599 $useCache = false;
1600 } else {
1601 $useCache = true;
1602 }
1603
1604 // Get the pre-save transform content and final parser output
1605 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1606 $pstContent = $editInfo->pstContent; // Content object
1607 $meta = [
1608 'bot' => ( $flags & EDIT_FORCE_BOT ),
1609 'minor' => ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' ),
1610 'serialized' => $pstContent->serialize( $serialFormat ),
1611 'serialFormat' => $serialFormat,
1612 'baseRevId' => $baseRevId,
1613 'oldRevision' => $old_revision,
1614 'oldContent' => $old_content,
1615 'oldId' => $this->getLatest(),
1616 'oldIsRedirect' => $this->isRedirect(),
1617 'oldCountable' => $this->isCountable(),
1618 'tags' => ( $tags !== null ) ? (array)$tags : [],
1619 'undidRevId' => $undidRevId
1620 ];
1621
1622 // Actually create the revision and create/update the page
1623 if ( $flags & EDIT_UPDATE ) {
1624 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1625 } else {
1626 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1627 }
1628
1629 // Promote user to any groups they meet the criteria for
1630 DeferredUpdates::addCallableUpdate( function () use ( $user ) {
1631 $user->addAutopromoteOnceGroups( 'onEdit' );
1632 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1633 } );
1634
1635 return $status;
1636 }
1637
1638 /**
1639 * @param Content $content Pre-save transform content
1640 * @param int $flags
1641 * @param User $user
1642 * @param string $summary
1643 * @param array $meta
1644 * @return Status
1645 * @throws DBUnexpectedError
1646 * @throws Exception
1647 * @throws FatalError
1648 * @throws MWException
1649 */
1650 private function doModify(
1651 Content $content, $flags, User $user, $summary, array $meta
1652 ) {
1653 global $wgUseRCPatrol;
1654
1655 // Update article, but only if changed.
1656 $status = Status::newGood( [ 'new' => false, 'revision' => null ] );
1657
1658 // Convenience variables
1659 $now = wfTimestampNow();
1660 $oldid = $meta['oldId'];
1661 /** @var Content|null $oldContent */
1662 $oldContent = $meta['oldContent'];
1663 $newsize = $content->getSize();
1664
1665 if ( !$oldid ) {
1666 // Article gone missing
1667 $status->fatal( 'edit-gone-missing' );
1668
1669 return $status;
1670 } elseif ( !$oldContent ) {
1671 // Sanity check for T39225
1672 throw new MWException( "Could not find text for current revision {$oldid}." );
1673 }
1674
1675 // @TODO: pass content object?!
1676 $revision = new Revision( [
1677 'page' => $this->getId(),
1678 'title' => $this->mTitle, // for determining the default content model
1679 'comment' => $summary,
1680 'minor_edit' => $meta['minor'],
1681 'text' => $meta['serialized'],
1682 'len' => $newsize,
1683 'parent_id' => $oldid,
1684 'user' => $user->getId(),
1685 'user_text' => $user->getName(),
1686 'timestamp' => $now,
1687 'content_model' => $content->getModel(),
1688 'content_format' => $meta['serialFormat'],
1689 ] );
1690
1691 $changed = !$content->equals( $oldContent );
1692
1693 $dbw = wfGetDB( DB_MASTER );
1694
1695 if ( $changed ) {
1696 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1697 $status->merge( $prepStatus );
1698 if ( !$status->isOK() ) {
1699 return $status;
1700 }
1701
1702 $dbw->startAtomic( __METHOD__ );
1703 // Get the latest page_latest value while locking it.
1704 // Do a CAS style check to see if it's the same as when this method
1705 // started. If it changed then bail out before touching the DB.
1706 $latestNow = $this->lockAndGetLatest();
1707 if ( $latestNow != $oldid ) {
1708 $dbw->endAtomic( __METHOD__ );
1709 // Page updated or deleted in the mean time
1710 $status->fatal( 'edit-conflict' );
1711
1712 return $status;
1713 }
1714
1715 // At this point we are now comitted to returning an OK
1716 // status unless some DB query error or other exception comes up.
1717 // This way callers don't have to call rollback() if $status is bad
1718 // unless they actually try to catch exceptions (which is rare).
1719
1720 // Save the revision text
1721 $revisionId = $revision->insertOn( $dbw );
1722 // Update page_latest and friends to reflect the new revision
1723 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1724 throw new MWException( "Failed to update page row to use new revision." );
1725 }
1726
1727 Hooks::run( 'NewRevisionFromEditComplete',
1728 [ $this, $revision, $meta['baseRevId'], $user ] );
1729
1730 // Update recentchanges
1731 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1732 // Mark as patrolled if the user can do so
1733 $patrolled = $wgUseRCPatrol && !count(
1734 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1735 // Add RC row to the DB
1736 RecentChange::notifyEdit(
1737 $now,
1738 $this->mTitle,
1739 $revision->isMinor(),
1740 $user,
1741 $summary,
1742 $oldid,
1743 $this->getTimestamp(),
1744 $meta['bot'],
1745 '',
1746 $oldContent ? $oldContent->getSize() : 0,
1747 $newsize,
1748 $revisionId,
1749 $patrolled,
1750 $meta['tags']
1751 );
1752 }
1753
1754 $user->incEditCount();
1755
1756 $dbw->endAtomic( __METHOD__ );
1757 $this->mTimestamp = $now;
1758 } else {
1759 // T34948: revision ID must be set to page {{REVISIONID}} and
1760 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1761 $revision->setId( $this->getLatest() );
1762 $revision->setUserIdAndName(
1763 $this->getUser( Revision::RAW ),
1764 $this->getUserText( Revision::RAW )
1765 );
1766 }
1767
1768 if ( $changed ) {
1769 // Return the new revision to the caller
1770 $status->value['revision'] = $revision;
1771 } else {
1772 $status->warning( 'edit-no-change' );
1773 // Update page_touched as updateRevisionOn() was not called.
1774 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1775 $this->mTitle->invalidateCache( $now );
1776 }
1777
1778 // Do secondary updates once the main changes have been committed...
1779 DeferredUpdates::addUpdate(
1780 new AtomicSectionUpdate(
1781 $dbw,
1782 __METHOD__,
1783 function () use (
1784 $revision, &$user, $content, $summary, &$flags,
1785 $changed, $meta, &$status
1786 ) {
1787 // Update links tables, site stats, etc.
1788 $this->doEditUpdates(
1789 $revision,
1790 $user,
1791 [
1792 'changed' => $changed,
1793 'oldcountable' => $meta['oldCountable'],
1794 'oldrevision' => $meta['oldRevision']
1795 ]
1796 );
1797 // Avoid PHP 7.1 warning of passing $this by reference
1798 $wikiPage = $this;
1799 // Trigger post-save hook
1800 $params = [ &$wikiPage, &$user, $content, $summary, $flags & EDIT_MINOR,
1801 null, null, &$flags, $revision, &$status, $meta['baseRevId'],
1802 $meta['undidRevId'] ];
1803 Hooks::run( 'PageContentSaveComplete', $params );
1804 }
1805 ),
1806 DeferredUpdates::PRESEND
1807 );
1808
1809 return $status;
1810 }
1811
1812 /**
1813 * @param Content $content Pre-save transform content
1814 * @param int $flags
1815 * @param User $user
1816 * @param string $summary
1817 * @param array $meta
1818 * @return Status
1819 * @throws DBUnexpectedError
1820 * @throws Exception
1821 * @throws FatalError
1822 * @throws MWException
1823 */
1824 private function doCreate(
1825 Content $content, $flags, User $user, $summary, array $meta
1826 ) {
1827 global $wgUseRCPatrol, $wgUseNPPatrol;
1828
1829 $status = Status::newGood( [ 'new' => true, 'revision' => null ] );
1830
1831 $now = wfTimestampNow();
1832 $newsize = $content->getSize();
1833 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1834 $status->merge( $prepStatus );
1835 if ( !$status->isOK() ) {
1836 return $status;
1837 }
1838
1839 $dbw = wfGetDB( DB_MASTER );
1840 $dbw->startAtomic( __METHOD__ );
1841
1842 // Add the page record unless one already exists for the title
1843 $newid = $this->insertOn( $dbw );
1844 if ( $newid === false ) {
1845 $dbw->endAtomic( __METHOD__ ); // nothing inserted
1846 $status->fatal( 'edit-already-exists' );
1847
1848 return $status; // nothing done
1849 }
1850
1851 // At this point we are now comitted to returning an OK
1852 // status unless some DB query error or other exception comes up.
1853 // This way callers don't have to call rollback() if $status is bad
1854 // unless they actually try to catch exceptions (which is rare).
1855
1856 // @TODO: pass content object?!
1857 $revision = new Revision( [
1858 'page' => $newid,
1859 'title' => $this->mTitle, // for determining the default content model
1860 'comment' => $summary,
1861 'minor_edit' => $meta['minor'],
1862 'text' => $meta['serialized'],
1863 'len' => $newsize,
1864 'user' => $user->getId(),
1865 'user_text' => $user->getName(),
1866 'timestamp' => $now,
1867 'content_model' => $content->getModel(),
1868 'content_format' => $meta['serialFormat'],
1869 ] );
1870
1871 // Save the revision text...
1872 $revisionId = $revision->insertOn( $dbw );
1873 // Update the page record with revision data
1874 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1875 throw new MWException( "Failed to update page row to use new revision." );
1876 }
1877
1878 Hooks::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1879
1880 // Update recentchanges
1881 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1882 // Mark as patrolled if the user can do so
1883 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) &&
1884 !count( $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1885 // Add RC row to the DB
1886 RecentChange::notifyNew(
1887 $now,
1888 $this->mTitle,
1889 $revision->isMinor(),
1890 $user,
1891 $summary,
1892 $meta['bot'],
1893 '',
1894 $newsize,
1895 $revisionId,
1896 $patrolled,
1897 $meta['tags']
1898 );
1899 }
1900
1901 $user->incEditCount();
1902
1903 $dbw->endAtomic( __METHOD__ );
1904 $this->mTimestamp = $now;
1905
1906 // Return the new revision to the caller
1907 $status->value['revision'] = $revision;
1908
1909 // Do secondary updates once the main changes have been committed...
1910 DeferredUpdates::addUpdate(
1911 new AtomicSectionUpdate(
1912 $dbw,
1913 __METHOD__,
1914 function () use (
1915 $revision, &$user, $content, $summary, &$flags, $meta, &$status
1916 ) {
1917 // Update links, etc.
1918 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1919 // Avoid PHP 7.1 warning of passing $this by reference
1920 $wikiPage = $this;
1921 // Trigger post-create hook
1922 $params = [ &$wikiPage, &$user, $content, $summary,
1923 $flags & EDIT_MINOR, null, null, &$flags, $revision ];
1924 Hooks::run( 'PageContentInsertComplete', $params );
1925 // Trigger post-save hook
1926 $params = array_merge( $params, [ &$status, $meta['baseRevId'] ] );
1927 Hooks::run( 'PageContentSaveComplete', $params );
1928 }
1929 ),
1930 DeferredUpdates::PRESEND
1931 );
1932
1933 return $status;
1934 }
1935
1936 /**
1937 * Get parser options suitable for rendering the primary article wikitext
1938 *
1939 * @see ContentHandler::makeParserOptions
1940 *
1941 * @param IContextSource|User|string $context One of the following:
1942 * - IContextSource: Use the User and the Language of the provided
1943 * context
1944 * - User: Use the provided User object and $wgLang for the language,
1945 * so use an IContextSource object if possible.
1946 * - 'canonical': Canonical options (anonymous user with default
1947 * preferences and content language).
1948 * @return ParserOptions
1949 */
1950 public function makeParserOptions( $context ) {
1951 $options = $this->getContentHandler()->makeParserOptions( $context );
1952
1953 if ( $this->getTitle()->isConversionTable() ) {
1954 // @todo ConversionTable should become a separate content model, so
1955 // we don't need special cases like this one.
1956 $options->disableContentConversion();
1957 }
1958
1959 return $options;
1960 }
1961
1962 /**
1963 * Prepare content which is about to be saved.
1964 *
1965 * Prior to 1.30, this returned a stdClass object with the same class
1966 * members.
1967 *
1968 * @param Content $content
1969 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
1970 * revision ID is also accepted, but this is deprecated.
1971 * @param User|null $user
1972 * @param string|null $serialFormat
1973 * @param bool $useCache Check shared prepared edit cache
1974 *
1975 * @return PreparedEdit
1976 *
1977 * @since 1.21
1978 */
1979 public function prepareContentForEdit(
1980 Content $content, $revision = null, User $user = null,
1981 $serialFormat = null, $useCache = true
1982 ) {
1983 global $wgContLang, $wgUser, $wgAjaxEditStash;
1984
1985 if ( is_object( $revision ) ) {
1986 $revid = $revision->getId();
1987 } else {
1988 $revid = $revision;
1989 // This code path is deprecated, and nothing is known to
1990 // use it, so performance here shouldn't be a worry.
1991 if ( $revid !== null ) {
1992 $revision = Revision::newFromId( $revid, Revision::READ_LATEST );
1993 } else {
1994 $revision = null;
1995 }
1996 }
1997
1998 $user = is_null( $user ) ? $wgUser : $user;
1999 // XXX: check $user->getId() here???
2000
2001 // Use a sane default for $serialFormat, see T59026
2002 if ( $serialFormat === null ) {
2003 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2004 }
2005
2006 if ( $this->mPreparedEdit
2007 && isset( $this->mPreparedEdit->newContent )
2008 && $this->mPreparedEdit->newContent->equals( $content )
2009 && $this->mPreparedEdit->revid == $revid
2010 && $this->mPreparedEdit->format == $serialFormat
2011 // XXX: also check $user here?
2012 ) {
2013 // Already prepared
2014 return $this->mPreparedEdit;
2015 }
2016
2017 // The edit may have already been prepared via api.php?action=stashedit
2018 $cachedEdit = $useCache && $wgAjaxEditStash
2019 ? ApiStashEdit::checkCache( $this->getTitle(), $content, $user )
2020 : false;
2021
2022 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2023 Hooks::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2024
2025 $edit = new PreparedEdit();
2026 if ( $cachedEdit ) {
2027 $edit->timestamp = $cachedEdit->timestamp;
2028 } else {
2029 $edit->timestamp = wfTimestampNow();
2030 }
2031 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2032 $edit->revid = $revid;
2033
2034 if ( $cachedEdit ) {
2035 $edit->pstContent = $cachedEdit->pstContent;
2036 } else {
2037 $edit->pstContent = $content
2038 ? $content->preSaveTransform( $this->mTitle, $user, $popts )
2039 : null;
2040 }
2041
2042 $edit->format = $serialFormat;
2043 $edit->popts = $this->makeParserOptions( 'canonical' );
2044 if ( $cachedEdit ) {
2045 $edit->output = $cachedEdit->output;
2046 } else {
2047 if ( $revision ) {
2048 // We get here if vary-revision is set. This means that this page references
2049 // itself (such as via self-transclusion). In this case, we need to make sure
2050 // that any such self-references refer to the newly-saved revision, and not
2051 // to the previous one, which could otherwise happen due to replica DB lag.
2052 $oldCallback = $edit->popts->getCurrentRevisionCallback();
2053 $edit->popts->setCurrentRevisionCallback(
2054 function ( Title $title, $parser = false ) use ( $revision, &$oldCallback ) {
2055 if ( $title->equals( $revision->getTitle() ) ) {
2056 return $revision;
2057 } else {
2058 return call_user_func( $oldCallback, $title, $parser );
2059 }
2060 }
2061 );
2062 } else {
2063 // Try to avoid a second parse if {{REVISIONID}} is used
2064 $dbIndex = ( $this->mDataLoadedFrom & self::READ_LATEST ) === self::READ_LATEST
2065 ? DB_MASTER // use the best possible guess
2066 : DB_REPLICA; // T154554
2067
2068 $edit->popts->setSpeculativeRevIdCallback( function () use ( $dbIndex ) {
2069 return 1 + (int)wfGetDB( $dbIndex )->selectField(
2070 'revision',
2071 'MAX(rev_id)',
2072 [],
2073 __METHOD__
2074 );
2075 } );
2076 }
2077 $edit->output = $edit->pstContent
2078 ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts )
2079 : null;
2080 }
2081
2082 $edit->newContent = $content;
2083 $edit->oldContent = $this->getContent( Revision::RAW );
2084
2085 // NOTE: B/C for hooks! don't use these fields!
2086 $edit->newText = $edit->newContent
2087 ? ContentHandler::getContentText( $edit->newContent )
2088 : '';
2089 $edit->oldText = $edit->oldContent
2090 ? ContentHandler::getContentText( $edit->oldContent )
2091 : '';
2092 $edit->pst = $edit->pstContent ? $edit->pstContent->serialize( $serialFormat ) : '';
2093
2094 if ( $edit->output ) {
2095 $edit->output->setCacheTime( wfTimestampNow() );
2096 }
2097
2098 // Process cache the result
2099 $this->mPreparedEdit = $edit;
2100
2101 return $edit;
2102 }
2103
2104 /**
2105 * Do standard deferred updates after page edit.
2106 * Update links tables, site stats, search index and message cache.
2107 * Purges pages that include this page if the text was changed here.
2108 * Every 100th edit, prune the recent changes table.
2109 *
2110 * @param Revision $revision
2111 * @param User $user User object that did the revision
2112 * @param array $options Array of options, following indexes are used:
2113 * - changed: bool, whether the revision changed the content (default true)
2114 * - created: bool, whether the revision created the page (default false)
2115 * - moved: bool, whether the page was moved (default false)
2116 * - restored: bool, whether the page was undeleted (default false)
2117 * - oldrevision: Revision object for the pre-update revision (default null)
2118 * - oldcountable: bool, null, or string 'no-change' (default null):
2119 * - bool: whether the page was counted as an article before that
2120 * revision, only used in changed is true and created is false
2121 * - null: if created is false, don't update the article count; if created
2122 * is true, do update the article count
2123 * - 'no-change': don't update the article count, ever
2124 */
2125 public function doEditUpdates( Revision $revision, User $user, array $options = [] ) {
2126 global $wgRCWatchCategoryMembership;
2127
2128 $options += [
2129 'changed' => true,
2130 'created' => false,
2131 'moved' => false,
2132 'restored' => false,
2133 'oldrevision' => null,
2134 'oldcountable' => null
2135 ];
2136 $content = $revision->getContent();
2137
2138 $logger = LoggerFactory::getInstance( 'SaveParse' );
2139
2140 // See if the parser output before $revision was inserted is still valid
2141 $editInfo = false;
2142 if ( !$this->mPreparedEdit ) {
2143 $logger->debug( __METHOD__ . ": No prepared edit...\n" );
2144 } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2145 $logger->info( __METHOD__ . ": Prepared edit has vary-revision...\n" );
2146 } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-revision-id' )
2147 && $this->mPreparedEdit->output->getSpeculativeRevIdUsed() !== $revision->getId()
2148 ) {
2149 $logger->info( __METHOD__ . ": Prepared edit has vary-revision-id with wrong ID...\n" );
2150 } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-user' ) && !$options['changed'] ) {
2151 $logger->info( __METHOD__ . ": Prepared edit has vary-user and is null...\n" );
2152 } else {
2153 wfDebug( __METHOD__ . ": Using prepared edit...\n" );
2154 $editInfo = $this->mPreparedEdit;
2155 }
2156
2157 if ( !$editInfo ) {
2158 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2159 // $text is usually already pre-save transformed once. Avoid using the edit stash
2160 // as any prepared content from there or in doEditContent() was already rejected.
2161 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2162 }
2163
2164 // Save it to the parser cache.
2165 // Make sure the cache time matches page_touched to avoid double parsing.
2166 ParserCache::singleton()->save(
2167 $editInfo->output, $this, $editInfo->popts,
2168 $revision->getTimestamp(), $editInfo->revid
2169 );
2170
2171 // Update the links tables and other secondary data
2172 if ( $content ) {
2173 $recursive = $options['changed']; // T52785
2174 $updates = $content->getSecondaryDataUpdates(
2175 $this->getTitle(), null, $recursive, $editInfo->output
2176 );
2177 foreach ( $updates as $update ) {
2178 if ( $update instanceof LinksUpdate ) {
2179 $update->setRevision( $revision );
2180 $update->setTriggeringUser( $user );
2181 }
2182 DeferredUpdates::addUpdate( $update );
2183 }
2184 if ( $wgRCWatchCategoryMembership
2185 && $this->getContentHandler()->supportsCategories() === true
2186 && ( $options['changed'] || $options['created'] )
2187 && !$options['restored']
2188 ) {
2189 // Note: jobs are pushed after deferred updates, so the job should be able to see
2190 // the recent change entry (also done via deferred updates) and carry over any
2191 // bot/deletion/IP flags, ect.
2192 JobQueueGroup::singleton()->lazyPush( new CategoryMembershipChangeJob(
2193 $this->getTitle(),
2194 [
2195 'pageId' => $this->getId(),
2196 'revTimestamp' => $revision->getTimestamp()
2197 ]
2198 ) );
2199 }
2200 }
2201
2202 // Avoid PHP 7.1 warning of passing $this by reference
2203 $wikiPage = $this;
2204
2205 Hooks::run( 'ArticleEditUpdates', [ &$wikiPage, &$editInfo, $options['changed'] ] );
2206
2207 if ( Hooks::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
2208 // Flush old entries from the `recentchanges` table
2209 if ( mt_rand( 0, 9 ) == 0 ) {
2210 JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newPurgeJob() );
2211 }
2212 }
2213
2214 if ( !$this->exists() ) {
2215 return;
2216 }
2217
2218 $id = $this->getId();
2219 $title = $this->mTitle->getPrefixedDBkey();
2220 $shortTitle = $this->mTitle->getDBkey();
2221
2222 if ( $options['oldcountable'] === 'no-change' ||
2223 ( !$options['changed'] && !$options['moved'] )
2224 ) {
2225 $good = 0;
2226 } elseif ( $options['created'] ) {
2227 $good = (int)$this->isCountable( $editInfo );
2228 } elseif ( $options['oldcountable'] !== null ) {
2229 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2230 } else {
2231 $good = 0;
2232 }
2233 $edits = $options['changed'] ? 1 : 0;
2234 $total = $options['created'] ? 1 : 0;
2235
2236 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2237 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2238
2239 // If this is another user's talk page, update newtalk.
2240 // Don't do this if $options['changed'] = false (null-edits) nor if
2241 // it's a minor edit and the user doesn't want notifications for those.
2242 if ( $options['changed']
2243 && $this->mTitle->getNamespace() == NS_USER_TALK
2244 && $shortTitle != $user->getTitleKey()
2245 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2246 ) {
2247 $recipient = User::newFromName( $shortTitle, false );
2248 if ( !$recipient ) {
2249 wfDebug( __METHOD__ . ": invalid username\n" );
2250 } else {
2251 // Avoid PHP 7.1 warning of passing $this by reference
2252 $wikiPage = $this;
2253
2254 // Allow extensions to prevent user notification
2255 // when a new message is added to their talk page
2256 if ( Hooks::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
2257 if ( User::isIP( $shortTitle ) ) {
2258 // An anonymous user
2259 $recipient->setNewtalk( true, $revision );
2260 } elseif ( $recipient->isLoggedIn() ) {
2261 $recipient->setNewtalk( true, $revision );
2262 } else {
2263 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2264 }
2265 }
2266 }
2267 }
2268
2269 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2270 MessageCache::singleton()->updateMessageOverride( $this->mTitle, $content );
2271 }
2272
2273 if ( $options['created'] ) {
2274 self::onArticleCreate( $this->mTitle );
2275 } elseif ( $options['changed'] ) { // T52785
2276 self::onArticleEdit( $this->mTitle, $revision );
2277 }
2278
2279 ResourceLoaderWikiModule::invalidateModuleCache(
2280 $this->mTitle, $options['oldrevision'], $revision, wfWikiID()
2281 );
2282 }
2283
2284 /**
2285 * Update the article's restriction field, and leave a log entry.
2286 * This works for protection both existing and non-existing pages.
2287 *
2288 * @param array $limit Set of restriction keys
2289 * @param array $expiry Per restriction type expiration
2290 * @param int &$cascade Set to false if cascading protection isn't allowed.
2291 * @param string $reason
2292 * @param User $user The user updating the restrictions
2293 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2294 * ($user should be able to add the specified tags before this is called)
2295 * @return Status Status object; if action is taken, $status->value is the log_id of the
2296 * protection log entry.
2297 */
2298 public function doUpdateRestrictions( array $limit, array $expiry,
2299 &$cascade, $reason, User $user, $tags = null
2300 ) {
2301 global $wgCascadingRestrictionLevels;
2302
2303 if ( wfReadOnly() ) {
2304 return Status::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2305 }
2306
2307 $this->loadPageData( 'fromdbmaster' );
2308 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2309 $id = $this->getId();
2310
2311 if ( !$cascade ) {
2312 $cascade = false;
2313 }
2314
2315 // Take this opportunity to purge out expired restrictions
2316 Title::purgeExpiredRestrictions();
2317
2318 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2319 // we expect a single selection, but the schema allows otherwise.
2320 $isProtected = false;
2321 $protect = false;
2322 $changed = false;
2323
2324 $dbw = wfGetDB( DB_MASTER );
2325
2326 foreach ( $restrictionTypes as $action ) {
2327 if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) {
2328 $expiry[$action] = 'infinity';
2329 }
2330 if ( !isset( $limit[$action] ) ) {
2331 $limit[$action] = '';
2332 } elseif ( $limit[$action] != '' ) {
2333 $protect = true;
2334 }
2335
2336 // Get current restrictions on $action
2337 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2338 if ( $current != '' ) {
2339 $isProtected = true;
2340 }
2341
2342 if ( $limit[$action] != $current ) {
2343 $changed = true;
2344 } elseif ( $limit[$action] != '' ) {
2345 // Only check expiry change if the action is actually being
2346 // protected, since expiry does nothing on an not-protected
2347 // action.
2348 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2349 $changed = true;
2350 }
2351 }
2352 }
2353
2354 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2355 $changed = true;
2356 }
2357
2358 // If nothing has changed, do nothing
2359 if ( !$changed ) {
2360 return Status::newGood();
2361 }
2362
2363 if ( !$protect ) { // No protection at all means unprotection
2364 $revCommentMsg = 'unprotectedarticle-comment';
2365 $logAction = 'unprotect';
2366 } elseif ( $isProtected ) {
2367 $revCommentMsg = 'modifiedarticleprotection-comment';
2368 $logAction = 'modify';
2369 } else {
2370 $revCommentMsg = 'protectedarticle-comment';
2371 $logAction = 'protect';
2372 }
2373
2374 $logRelationsValues = [];
2375 $logRelationsField = null;
2376 $logParamsDetails = [];
2377
2378 // Null revision (used for change tag insertion)
2379 $nullRevision = null;
2380
2381 if ( $id ) { // Protection of existing page
2382 // Avoid PHP 7.1 warning of passing $this by reference
2383 $wikiPage = $this;
2384
2385 if ( !Hooks::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2386 return Status::newGood();
2387 }
2388
2389 // Only certain restrictions can cascade...
2390 $editrestriction = isset( $limit['edit'] )
2391 ? [ $limit['edit'] ]
2392 : $this->mTitle->getRestrictions( 'edit' );
2393 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2394 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2395 }
2396 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2397 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2398 }
2399
2400 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2401 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2402 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2403 }
2404 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2405 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2406 }
2407
2408 // The schema allows multiple restrictions
2409 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2410 $cascade = false;
2411 }
2412
2413 // insert null revision to identify the page protection change as edit summary
2414 $latest = $this->getLatest();
2415 $nullRevision = $this->insertProtectNullRevision(
2416 $revCommentMsg,
2417 $limit,
2418 $expiry,
2419 $cascade,
2420 $reason,
2421 $user
2422 );
2423
2424 if ( $nullRevision === null ) {
2425 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2426 }
2427
2428 $logRelationsField = 'pr_id';
2429
2430 // Update restrictions table
2431 foreach ( $limit as $action => $restrictions ) {
2432 $dbw->delete(
2433 'page_restrictions',
2434 [
2435 'pr_page' => $id,
2436 'pr_type' => $action
2437 ],
2438 __METHOD__
2439 );
2440 if ( $restrictions != '' ) {
2441 $cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0;
2442 $dbw->insert(
2443 'page_restrictions',
2444 [
2445 'pr_page' => $id,
2446 'pr_type' => $action,
2447 'pr_level' => $restrictions,
2448 'pr_cascade' => $cascadeValue,
2449 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2450 ],
2451 __METHOD__
2452 );
2453 $logRelationsValues[] = $dbw->insertId();
2454 $logParamsDetails[] = [
2455 'type' => $action,
2456 'level' => $restrictions,
2457 'expiry' => $expiry[$action],
2458 'cascade' => (bool)$cascadeValue,
2459 ];
2460 }
2461 }
2462
2463 // Clear out legacy restriction fields
2464 $dbw->update(
2465 'page',
2466 [ 'page_restrictions' => '' ],
2467 [ 'page_id' => $id ],
2468 __METHOD__
2469 );
2470
2471 // Avoid PHP 7.1 warning of passing $this by reference
2472 $wikiPage = $this;
2473
2474 Hooks::run( 'NewRevisionFromEditComplete',
2475 [ $this, $nullRevision, $latest, $user ] );
2476 Hooks::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2477 } else { // Protection of non-existing page (also known as "title protection")
2478 // Cascade protection is meaningless in this case
2479 $cascade = false;
2480
2481 if ( $limit['create'] != '' ) {
2482 $commentFields = CommentStore::newKey( 'pt_reason' )->insert( $dbw, $reason );
2483 $dbw->replace( 'protected_titles',
2484 [ [ 'pt_namespace', 'pt_title' ] ],
2485 [
2486 'pt_namespace' => $this->mTitle->getNamespace(),
2487 'pt_title' => $this->mTitle->getDBkey(),
2488 'pt_create_perm' => $limit['create'],
2489 'pt_timestamp' => $dbw->timestamp(),
2490 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2491 'pt_user' => $user->getId(),
2492 ] + $commentFields, __METHOD__
2493 );
2494 $logParamsDetails[] = [
2495 'type' => 'create',
2496 'level' => $limit['create'],
2497 'expiry' => $expiry['create'],
2498 ];
2499 } else {
2500 $dbw->delete( 'protected_titles',
2501 [
2502 'pt_namespace' => $this->mTitle->getNamespace(),
2503 'pt_title' => $this->mTitle->getDBkey()
2504 ], __METHOD__
2505 );
2506 }
2507 }
2508
2509 $this->mTitle->flushRestrictions();
2510 InfoAction::invalidateCache( $this->mTitle );
2511
2512 if ( $logAction == 'unprotect' ) {
2513 $params = [];
2514 } else {
2515 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2516 $params = [
2517 '4::description' => $protectDescriptionLog, // parameter for IRC
2518 '5:bool:cascade' => $cascade,
2519 'details' => $logParamsDetails, // parameter for localize and api
2520 ];
2521 }
2522
2523 // Update the protection log
2524 $logEntry = new ManualLogEntry( 'protect', $logAction );
2525 $logEntry->setTarget( $this->mTitle );
2526 $logEntry->setComment( $reason );
2527 $logEntry->setPerformer( $user );
2528 $logEntry->setParameters( $params );
2529 if ( !is_null( $nullRevision ) ) {
2530 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2531 }
2532 $logEntry->setTags( $tags );
2533 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2534 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2535 }
2536 $logId = $logEntry->insert();
2537 $logEntry->publish( $logId );
2538
2539 return Status::newGood( $logId );
2540 }
2541
2542 /**
2543 * Insert a new null revision for this page.
2544 *
2545 * @param string $revCommentMsg Comment message key for the revision
2546 * @param array $limit Set of restriction keys
2547 * @param array $expiry Per restriction type expiration
2548 * @param int $cascade Set to false if cascading protection isn't allowed.
2549 * @param string $reason
2550 * @param User|null $user
2551 * @return Revision|null Null on error
2552 */
2553 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2554 array $expiry, $cascade, $reason, $user = null
2555 ) {
2556 $dbw = wfGetDB( DB_MASTER );
2557
2558 // Prepare a null revision to be added to the history
2559 $editComment = wfMessage(
2560 $revCommentMsg,
2561 $this->mTitle->getPrefixedText(),
2562 $user ? $user->getName() : ''
2563 )->inContentLanguage()->text();
2564 if ( $reason ) {
2565 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2566 }
2567 $protectDescription = $this->protectDescription( $limit, $expiry );
2568 if ( $protectDescription ) {
2569 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2570 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2571 ->inContentLanguage()->text();
2572 }
2573 if ( $cascade ) {
2574 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2575 $editComment .= wfMessage( 'brackets' )->params(
2576 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2577 )->inContentLanguage()->text();
2578 }
2579
2580 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2581 if ( $nullRev ) {
2582 $nullRev->insertOn( $dbw );
2583
2584 // Update page record and touch page
2585 $oldLatest = $nullRev->getParentId();
2586 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2587 }
2588
2589 return $nullRev;
2590 }
2591
2592 /**
2593 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2594 * @return string
2595 */
2596 protected function formatExpiry( $expiry ) {
2597 global $wgContLang;
2598
2599 if ( $expiry != 'infinity' ) {
2600 return wfMessage(
2601 'protect-expiring',
2602 $wgContLang->timeanddate( $expiry, false, false ),
2603 $wgContLang->date( $expiry, false, false ),
2604 $wgContLang->time( $expiry, false, false )
2605 )->inContentLanguage()->text();
2606 } else {
2607 return wfMessage( 'protect-expiry-indefinite' )
2608 ->inContentLanguage()->text();
2609 }
2610 }
2611
2612 /**
2613 * Builds the description to serve as comment for the edit.
2614 *
2615 * @param array $limit Set of restriction keys
2616 * @param array $expiry Per restriction type expiration
2617 * @return string
2618 */
2619 public function protectDescription( array $limit, array $expiry ) {
2620 $protectDescription = '';
2621
2622 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2623 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2624 # All possible message keys are listed here for easier grepping:
2625 # * restriction-create
2626 # * restriction-edit
2627 # * restriction-move
2628 # * restriction-upload
2629 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2630 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2631 # with '' filtered out. All possible message keys are listed below:
2632 # * protect-level-autoconfirmed
2633 # * protect-level-sysop
2634 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2635 ->inContentLanguage()->text();
2636
2637 $expiryText = $this->formatExpiry( $expiry[$action] );
2638
2639 if ( $protectDescription !== '' ) {
2640 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2641 }
2642 $protectDescription .= wfMessage( 'protect-summary-desc' )
2643 ->params( $actionText, $restrictionsText, $expiryText )
2644 ->inContentLanguage()->text();
2645 }
2646
2647 return $protectDescription;
2648 }
2649
2650 /**
2651 * Builds the description to serve as comment for the log entry.
2652 *
2653 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2654 * protect description text. Keep them in old format to avoid breaking compatibility.
2655 * TODO: Fix protection log to store structured description and format it on-the-fly.
2656 *
2657 * @param array $limit Set of restriction keys
2658 * @param array $expiry Per restriction type expiration
2659 * @return string
2660 */
2661 public function protectDescriptionLog( array $limit, array $expiry ) {
2662 global $wgContLang;
2663
2664 $protectDescriptionLog = '';
2665
2666 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2667 $expiryText = $this->formatExpiry( $expiry[$action] );
2668 $protectDescriptionLog .= $wgContLang->getDirMark() .
2669 "[$action=$restrictions] ($expiryText)";
2670 }
2671
2672 return trim( $protectDescriptionLog );
2673 }
2674
2675 /**
2676 * Take an array of page restrictions and flatten it to a string
2677 * suitable for insertion into the page_restrictions field.
2678 *
2679 * @param string[] $limit
2680 *
2681 * @throws MWException
2682 * @return string
2683 */
2684 protected static function flattenRestrictions( $limit ) {
2685 if ( !is_array( $limit ) ) {
2686 throw new MWException( __METHOD__ . ' given non-array restriction set' );
2687 }
2688
2689 $bits = [];
2690 ksort( $limit );
2691
2692 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2693 $bits[] = "$action=$restrictions";
2694 }
2695
2696 return implode( ':', $bits );
2697 }
2698
2699 /**
2700 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2701 * backwards compatibility, if you care about error reporting you should use
2702 * doDeleteArticleReal() instead.
2703 *
2704 * Deletes the article with database consistency, writes logs, purges caches
2705 *
2706 * @param string $reason Delete reason for deletion log
2707 * @param bool $suppress Suppress all revisions and log the deletion in
2708 * the suppression log instead of the deletion log
2709 * @param int $u1 Unused
2710 * @param bool $u2 Unused
2711 * @param array|string &$error Array of errors to append to
2712 * @param User $user The deleting user
2713 * @return bool True if successful
2714 */
2715 public function doDeleteArticle(
2716 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null
2717 ) {
2718 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2719 return $status->isGood();
2720 }
2721
2722 /**
2723 * Back-end article deletion
2724 * Deletes the article with database consistency, writes logs, purges caches
2725 *
2726 * @since 1.19
2727 *
2728 * @param string $reason Delete reason for deletion log
2729 * @param bool $suppress Suppress all revisions and log the deletion in
2730 * the suppression log instead of the deletion log
2731 * @param int $u1 Unused
2732 * @param bool $u2 Unused
2733 * @param array|string &$error Array of errors to append to
2734 * @param User $user The deleting user
2735 * @param array $tags Tags to apply to the deletion action
2736 * @param string $logsubtype
2737 * @return Status Status object; if successful, $status->value is the log_id of the
2738 * deletion log entry. If the page couldn't be deleted because it wasn't
2739 * found, $status is a non-fatal 'cannotdelete' error
2740 */
2741 public function doDeleteArticleReal(
2742 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null,
2743 $tags = [], $logsubtype = 'delete'
2744 ) {
2745 global $wgUser, $wgContentHandlerUseDB, $wgCommentTableSchemaMigrationStage;
2746
2747 wfDebug( __METHOD__ . "\n" );
2748
2749 $status = Status::newGood();
2750
2751 if ( $this->mTitle->getDBkey() === '' ) {
2752 $status->error( 'cannotdelete',
2753 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2754 return $status;
2755 }
2756
2757 // Avoid PHP 7.1 warning of passing $this by reference
2758 $wikiPage = $this;
2759
2760 $user = is_null( $user ) ? $wgUser : $user;
2761 if ( !Hooks::run( 'ArticleDelete',
2762 [ &$wikiPage, &$user, &$reason, &$error, &$status, $suppress ]
2763 ) ) {
2764 if ( $status->isOK() ) {
2765 // Hook aborted but didn't set a fatal status
2766 $status->fatal( 'delete-hook-aborted' );
2767 }
2768 return $status;
2769 }
2770
2771 $dbw = wfGetDB( DB_MASTER );
2772 $dbw->startAtomic( __METHOD__ );
2773
2774 $this->loadPageData( self::READ_LATEST );
2775 $id = $this->getId();
2776 // T98706: lock the page from various other updates but avoid using
2777 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2778 // the revisions queries (which also JOIN on user). Only lock the page
2779 // row and CAS check on page_latest to see if the trx snapshot matches.
2780 $lockedLatest = $this->lockAndGetLatest();
2781 if ( $id == 0 || $this->getLatest() != $lockedLatest ) {
2782 $dbw->endAtomic( __METHOD__ );
2783 // Page not there or trx snapshot is stale
2784 $status->error( 'cannotdelete',
2785 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2786 return $status;
2787 }
2788
2789 // Given the lock above, we can be confident in the title and page ID values
2790 $namespace = $this->getTitle()->getNamespace();
2791 $dbKey = $this->getTitle()->getDBkey();
2792
2793 // At this point we are now comitted to returning an OK
2794 // status unless some DB query error or other exception comes up.
2795 // This way callers don't have to call rollback() if $status is bad
2796 // unless they actually try to catch exceptions (which is rare).
2797
2798 // we need to remember the old content so we can use it to generate all deletion updates.
2799 $revision = $this->getRevision();
2800 try {
2801 $content = $this->getContent( Revision::RAW );
2802 } catch ( Exception $ex ) {
2803 wfLogWarning( __METHOD__ . ': failed to load content during deletion! '
2804 . $ex->getMessage() );
2805
2806 $content = null;
2807 }
2808
2809 $revCommentStore = new CommentStore( 'rev_comment' );
2810 $arCommentStore = new CommentStore( 'ar_comment' );
2811
2812 $fields = Revision::selectFields();
2813 $bitfield = false;
2814
2815 // Bitfields to further suppress the content
2816 if ( $suppress ) {
2817 $bitfield = Revision::SUPPRESSED_ALL;
2818 $fields = array_diff( $fields, [ 'rev_deleted' ] );
2819 }
2820
2821 // For now, shunt the revision data into the archive table.
2822 // Text is *not* removed from the text table; bulk storage
2823 // is left intact to avoid breaking block-compression or
2824 // immutable storage schemes.
2825 // In the future, we may keep revisions and mark them with
2826 // the rev_deleted field, which is reserved for this purpose.
2827
2828 // Get all of the page revisions
2829 $commentQuery = $revCommentStore->getJoin();
2830 $res = $dbw->select(
2831 [ 'revision' ] + $commentQuery['tables'],
2832 $fields + $commentQuery['fields'],
2833 [ 'rev_page' => $id ],
2834 __METHOD__,
2835 'FOR UPDATE',
2836 $commentQuery['joins']
2837 );
2838
2839 // Build their equivalent archive rows
2840 $rowsInsert = [];
2841 $revids = [];
2842
2843 /** @var int[] Revision IDs of edits that were made by IPs */
2844 $ipRevIds = [];
2845
2846 foreach ( $res as $row ) {
2847 $comment = $revCommentStore->getComment( $row );
2848 $rowInsert = [
2849 'ar_namespace' => $namespace,
2850 'ar_title' => $dbKey,
2851 'ar_user' => $row->rev_user,
2852 'ar_user_text' => $row->rev_user_text,
2853 'ar_timestamp' => $row->rev_timestamp,
2854 'ar_minor_edit' => $row->rev_minor_edit,
2855 'ar_rev_id' => $row->rev_id,
2856 'ar_parent_id' => $row->rev_parent_id,
2857 'ar_text_id' => $row->rev_text_id,
2858 'ar_text' => '',
2859 'ar_flags' => '',
2860 'ar_len' => $row->rev_len,
2861 'ar_page_id' => $id,
2862 'ar_deleted' => $suppress ? $bitfield : $row->rev_deleted,
2863 'ar_sha1' => $row->rev_sha1,
2864 ] + $arCommentStore->insert( $dbw, $comment );
2865 if ( $wgContentHandlerUseDB ) {
2866 $rowInsert['ar_content_model'] = $row->rev_content_model;
2867 $rowInsert['ar_content_format'] = $row->rev_content_format;
2868 }
2869 $rowsInsert[] = $rowInsert;
2870 $revids[] = $row->rev_id;
2871
2872 // Keep track of IP edits, so that the corresponding rows can
2873 // be deleted in the ip_changes table.
2874 if ( (int)$row->rev_user === 0 && IP::isValid( $row->rev_user_text ) ) {
2875 $ipRevIds[] = $row->rev_id;
2876 }
2877 }
2878 // Copy them into the archive table
2879 $dbw->insert( 'archive', $rowsInsert, __METHOD__ );
2880 // Save this so we can pass it to the ArticleDeleteComplete hook.
2881 $archivedRevisionCount = $dbw->affectedRows();
2882
2883 // Clone the title and wikiPage, so we have the information we need when
2884 // we log and run the ArticleDeleteComplete hook.
2885 $logTitle = clone $this->mTitle;
2886 $wikiPageBeforeDelete = clone $this;
2887
2888 // Now that it's safely backed up, delete it
2889 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__ );
2890 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__ );
2891 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD ) {
2892 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__ );
2893 }
2894
2895 // Also delete records from ip_changes as applicable.
2896 if ( count( $ipRevIds ) > 0 ) {
2897 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__ );
2898 }
2899
2900 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2901 $logtype = $suppress ? 'suppress' : 'delete';
2902
2903 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2904 $logEntry->setPerformer( $user );
2905 $logEntry->setTarget( $logTitle );
2906 $logEntry->setComment( $reason );
2907 $logEntry->setTags( $tags );
2908 $logid = $logEntry->insert();
2909
2910 $dbw->onTransactionPreCommitOrIdle(
2911 function () use ( $dbw, $logEntry, $logid ) {
2912 // T58776: avoid deadlocks (especially from FileDeleteForm)
2913 $logEntry->publish( $logid );
2914 },
2915 __METHOD__
2916 );
2917
2918 $dbw->endAtomic( __METHOD__ );
2919
2920 $this->doDeleteUpdates( $id, $content, $revision );
2921
2922 Hooks::run( 'ArticleDeleteComplete', [
2923 &$wikiPageBeforeDelete,
2924 &$user,
2925 $reason,
2926 $id,
2927 $content,
2928 $logEntry,
2929 $archivedRevisionCount
2930 ] );
2931 $status->value = $logid;
2932
2933 // Show log excerpt on 404 pages rather than just a link
2934 $cache = MediaWikiServices::getInstance()->getMainObjectStash();
2935 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2936 $cache->set( $key, 1, $cache::TTL_DAY );
2937
2938 return $status;
2939 }
2940
2941 /**
2942 * Lock the page row for this title+id and return page_latest (or 0)
2943 *
2944 * @return int Returns 0 if no row was found with this title+id
2945 * @since 1.27
2946 */
2947 public function lockAndGetLatest() {
2948 return (int)wfGetDB( DB_MASTER )->selectField(
2949 'page',
2950 'page_latest',
2951 [
2952 'page_id' => $this->getId(),
2953 // Typically page_id is enough, but some code might try to do
2954 // updates assuming the title is the same, so verify that
2955 'page_namespace' => $this->getTitle()->getNamespace(),
2956 'page_title' => $this->getTitle()->getDBkey()
2957 ],
2958 __METHOD__,
2959 [ 'FOR UPDATE' ]
2960 );
2961 }
2962
2963 /**
2964 * Do some database updates after deletion
2965 *
2966 * @param int $id The page_id value of the page being deleted
2967 * @param Content|null $content Optional page content to be used when determining
2968 * the required updates. This may be needed because $this->getContent()
2969 * may already return null when the page proper was deleted.
2970 * @param Revision|null $revision The latest page revision
2971 */
2972 public function doDeleteUpdates( $id, Content $content = null, Revision $revision = null ) {
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 // Reparse any pages transcluding this page
2991 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
2992
2993 // Reparse any pages including this image
2994 if ( $this->mTitle->getNamespace() == NS_FILE ) {
2995 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
2996 }
2997
2998 // Clear caches
2999 self::onArticleDelete( $this->mTitle );
3000 ResourceLoaderWikiModule::invalidateModuleCache(
3001 $this->mTitle, $revision, null, wfWikiID()
3002 );
3003
3004 // Reset this object and the Title object
3005 $this->loadFromRow( false, self::READ_LATEST );
3006
3007 // Search engine
3008 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
3009 }
3010
3011 /**
3012 * Roll back the most recent consecutive set of edits to a page
3013 * from the same user; fails if there are no eligible edits to
3014 * roll back to, e.g. user is the sole contributor. This function
3015 * performs permissions checks on $user, then calls commitRollback()
3016 * to do the dirty work
3017 *
3018 * @todo Separate the business/permission stuff out from backend code
3019 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3020 *
3021 * @param string $fromP Name of the user whose edits to rollback.
3022 * @param string $summary Custom summary. Set to default summary if empty.
3023 * @param string $token Rollback token.
3024 * @param bool $bot If true, mark all reverted edits as bot.
3025 *
3026 * @param array &$resultDetails Array contains result-specific array of additional values
3027 * 'alreadyrolled' : 'current' (rev)
3028 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3029 *
3030 * @param User $user The user performing the rollback
3031 * @param array|null $tags Change tags to apply to the rollback
3032 * Callers are responsible for permission checks
3033 * (with ChangeTags::canAddTagsAccompanyingChange)
3034 *
3035 * @return array Array of errors, each error formatted as
3036 * array(messagekey, param1, param2, ...).
3037 * On success, the array is empty. This array can also be passed to
3038 * OutputPage::showPermissionsErrorPage().
3039 */
3040 public function doRollback(
3041 $fromP, $summary, $token, $bot, &$resultDetails, User $user, $tags = null
3042 ) {
3043 $resultDetails = null;
3044
3045 // Check permissions
3046 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
3047 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
3048 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3049
3050 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3051 $errors[] = [ 'sessionfailure' ];
3052 }
3053
3054 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
3055 $errors[] = [ 'actionthrottledtext' ];
3056 }
3057
3058 // If there were errors, bail out now
3059 if ( !empty( $errors ) ) {
3060 return $errors;
3061 }
3062
3063 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3064 }
3065
3066 /**
3067 * Backend implementation of doRollback(), please refer there for parameter
3068 * and return value documentation
3069 *
3070 * NOTE: This function does NOT check ANY permissions, it just commits the
3071 * rollback to the DB. Therefore, you should only call this function direct-
3072 * ly if you want to use custom permissions checks. If you don't, use
3073 * doRollback() instead.
3074 * @param string $fromP Name of the user whose edits to rollback.
3075 * @param string $summary Custom summary. Set to default summary if empty.
3076 * @param bool $bot If true, mark all reverted edits as bot.
3077 *
3078 * @param array &$resultDetails Contains result-specific array of additional values
3079 * @param User $guser The user performing the rollback
3080 * @param array|null $tags Change tags to apply to the rollback
3081 * Callers are responsible for permission checks
3082 * (with ChangeTags::canAddTagsAccompanyingChange)
3083 *
3084 * @return array
3085 */
3086 public function commitRollback( $fromP, $summary, $bot,
3087 &$resultDetails, User $guser, $tags = null
3088 ) {
3089 global $wgUseRCPatrol, $wgContLang;
3090
3091 $dbw = wfGetDB( DB_MASTER );
3092
3093 if ( wfReadOnly() ) {
3094 return [ [ 'readonlytext' ] ];
3095 }
3096
3097 // Get the last editor
3098 $current = $this->getRevision();
3099 if ( is_null( $current ) ) {
3100 // Something wrong... no page?
3101 return [ [ 'notanarticle' ] ];
3102 }
3103
3104 $from = str_replace( '_', ' ', $fromP );
3105 // User name given should match up with the top revision.
3106 // If the user was deleted then $from should be empty.
3107 if ( $from != $current->getUserText() ) {
3108 $resultDetails = [ 'current' => $current ];
3109 return [ [ 'alreadyrolled',
3110 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3111 htmlspecialchars( $fromP ),
3112 htmlspecialchars( $current->getUserText() )
3113 ] ];
3114 }
3115
3116 // Get the last edit not by this person...
3117 // Note: these may not be public values
3118 $user = intval( $current->getUser( Revision::RAW ) );
3119 $user_text = $dbw->addQuotes( $current->getUserText( Revision::RAW ) );
3120 $s = $dbw->selectRow( 'revision',
3121 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3122 [ 'rev_page' => $current->getPage(),
3123 "rev_user != {$user} OR rev_user_text != {$user_text}"
3124 ], __METHOD__,
3125 [ 'USE INDEX' => 'page_timestamp',
3126 'ORDER BY' => 'rev_timestamp DESC' ]
3127 );
3128 if ( $s === false ) {
3129 // No one else ever edited this page
3130 return [ [ 'cantrollback' ] ];
3131 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT
3132 || $s->rev_deleted & Revision::DELETED_USER
3133 ) {
3134 // Only admins can see this text
3135 return [ [ 'notvisiblerev' ] ];
3136 }
3137
3138 // Generate the edit summary if necessary
3139 $target = Revision::newFromId( $s->rev_id, Revision::READ_LATEST );
3140 if ( empty( $summary ) ) {
3141 if ( $from == '' ) { // no public user name
3142 $summary = wfMessage( 'revertpage-nouser' );
3143 } else {
3144 $summary = wfMessage( 'revertpage' );
3145 }
3146 }
3147
3148 // Allow the custom summary to use the same args as the default message
3149 $args = [
3150 $target->getUserText(), $from, $s->rev_id,
3151 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3152 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3153 ];
3154 if ( $summary instanceof Message ) {
3155 $summary = $summary->params( $args )->inContentLanguage()->text();
3156 } else {
3157 $summary = wfMsgReplaceArgs( $summary, $args );
3158 }
3159
3160 // Trim spaces on user supplied text
3161 $summary = trim( $summary );
3162
3163 // Save
3164 $flags = EDIT_UPDATE | EDIT_INTERNAL;
3165
3166 if ( $guser->isAllowed( 'minoredit' ) ) {
3167 $flags |= EDIT_MINOR;
3168 }
3169
3170 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3171 $flags |= EDIT_FORCE_BOT;
3172 }
3173
3174 $targetContent = $target->getContent();
3175 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3176
3177 // Actually store the edit
3178 $status = $this->doEditContent(
3179 $targetContent,
3180 $summary,
3181 $flags,
3182 $target->getId(),
3183 $guser,
3184 null,
3185 $tags
3186 );
3187
3188 // Set patrolling and bot flag on the edits, which gets rollbacked.
3189 // This is done even on edit failure to have patrolling in that case (T64157).
3190 $set = [];
3191 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3192 // Mark all reverted edits as bot
3193 $set['rc_bot'] = 1;
3194 }
3195
3196 if ( $wgUseRCPatrol ) {
3197 // Mark all reverted edits as patrolled
3198 $set['rc_patrolled'] = 1;
3199 }
3200
3201 if ( count( $set ) ) {
3202 $dbw->update( 'recentchanges', $set,
3203 [ /* WHERE */
3204 'rc_cur_id' => $current->getPage(),
3205 'rc_user_text' => $current->getUserText(),
3206 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3207 ],
3208 __METHOD__
3209 );
3210 }
3211
3212 if ( !$status->isOK() ) {
3213 return $status->getErrorsArray();
3214 }
3215
3216 // raise error, when the edit is an edit without a new version
3217 $statusRev = isset( $status->value['revision'] )
3218 ? $status->value['revision']
3219 : null;
3220 if ( !( $statusRev instanceof Revision ) ) {
3221 $resultDetails = [ 'current' => $current ];
3222 return [ [ 'alreadyrolled',
3223 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3224 htmlspecialchars( $fromP ),
3225 htmlspecialchars( $current->getUserText() )
3226 ] ];
3227 }
3228
3229 if ( $changingContentModel ) {
3230 // If the content model changed during the rollback,
3231 // make sure it gets logged to Special:Log/contentmodel
3232 $log = new ManualLogEntry( 'contentmodel', 'change' );
3233 $log->setPerformer( $guser );
3234 $log->setTarget( $this->mTitle );
3235 $log->setComment( $summary );
3236 $log->setParameters( [
3237 '4::oldmodel' => $current->getContentModel(),
3238 '5::newmodel' => $targetContent->getModel(),
3239 ] );
3240
3241 $logId = $log->insert( $dbw );
3242 $log->publish( $logId );
3243 }
3244
3245 $revId = $statusRev->getId();
3246
3247 Hooks::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3248
3249 $resultDetails = [
3250 'summary' => $summary,
3251 'current' => $current,
3252 'target' => $target,
3253 'newid' => $revId
3254 ];
3255
3256 return [];
3257 }
3258
3259 /**
3260 * The onArticle*() functions are supposed to be a kind of hooks
3261 * which should be called whenever any of the specified actions
3262 * are done.
3263 *
3264 * This is a good place to put code to clear caches, for instance.
3265 *
3266 * This is called on page move and undelete, as well as edit
3267 *
3268 * @param Title $title
3269 */
3270 public static function onArticleCreate( Title $title ) {
3271 // Update existence markers on article/talk tabs...
3272 $other = $title->getOtherPage();
3273
3274 $other->purgeSquid();
3275
3276 $title->touchLinks();
3277 $title->purgeSquid();
3278 $title->deleteTitleProtection();
3279
3280 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3281
3282 // Invalidate caches of articles which include this page
3283 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3284
3285 if ( $title->getNamespace() == NS_CATEGORY ) {
3286 // Load the Category object, which will schedule a job to create
3287 // the category table row if necessary. Checking a replica DB is ok
3288 // here, in the worst case it'll run an unnecessary recount job on
3289 // a category that probably doesn't have many members.
3290 Category::newFromTitle( $title )->getID();
3291 }
3292 }
3293
3294 /**
3295 * Clears caches when article is deleted
3296 *
3297 * @param Title $title
3298 */
3299 public static function onArticleDelete( Title $title ) {
3300 // Update existence markers on article/talk tabs...
3301 $other = $title->getOtherPage();
3302
3303 $other->purgeSquid();
3304
3305 $title->touchLinks();
3306 $title->purgeSquid();
3307
3308 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3309
3310 // File cache
3311 HTMLFileCache::clearFileCache( $title );
3312 InfoAction::invalidateCache( $title );
3313
3314 // Messages
3315 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3316 MessageCache::singleton()->updateMessageOverride( $title, null );
3317 }
3318
3319 // Images
3320 if ( $title->getNamespace() == NS_FILE ) {
3321 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3322 }
3323
3324 // User talk pages
3325 if ( $title->getNamespace() == NS_USER_TALK ) {
3326 $user = User::newFromName( $title->getText(), false );
3327 if ( $user ) {
3328 $user->setNewtalk( false );
3329 }
3330 }
3331
3332 // Image redirects
3333 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3334 }
3335
3336 /**
3337 * Purge caches on page update etc
3338 *
3339 * @param Title $title
3340 * @param Revision|null $revision Revision that was just saved, may be null
3341 */
3342 public static function onArticleEdit( Title $title, Revision $revision = null ) {
3343 // Invalidate caches of articles which include this page
3344 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3345
3346 // Invalidate the caches of all pages which redirect here
3347 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3348
3349 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3350
3351 // Purge CDN for this page only
3352 $title->purgeSquid();
3353 // Clear file cache for this page only
3354 HTMLFileCache::clearFileCache( $title );
3355
3356 $revid = $revision ? $revision->getId() : null;
3357 DeferredUpdates::addCallableUpdate( function () use ( $title, $revid ) {
3358 InfoAction::invalidateCache( $title, $revid );
3359 } );
3360 }
3361
3362 /**#@-*/
3363
3364 /**
3365 * Returns a list of categories this page is a member of.
3366 * Results will include hidden categories
3367 *
3368 * @return TitleArray
3369 */
3370 public function getCategories() {
3371 $id = $this->getId();
3372 if ( $id == 0 ) {
3373 return TitleArray::newFromResult( new FakeResultWrapper( [] ) );
3374 }
3375
3376 $dbr = wfGetDB( DB_REPLICA );
3377 $res = $dbr->select( 'categorylinks',
3378 [ 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ],
3379 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3380 // as not being aliases, and NS_CATEGORY is numeric
3381 [ 'cl_from' => $id ],
3382 __METHOD__ );
3383
3384 return TitleArray::newFromResult( $res );
3385 }
3386
3387 /**
3388 * Returns a list of hidden categories this page is a member of.
3389 * Uses the page_props and categorylinks tables.
3390 *
3391 * @return array Array of Title objects
3392 */
3393 public function getHiddenCategories() {
3394 $result = [];
3395 $id = $this->getId();
3396
3397 if ( $id == 0 ) {
3398 return [];
3399 }
3400
3401 $dbr = wfGetDB( DB_REPLICA );
3402 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3403 [ 'cl_to' ],
3404 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3405 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ],
3406 __METHOD__ );
3407
3408 if ( $res !== false ) {
3409 foreach ( $res as $row ) {
3410 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3411 }
3412 }
3413
3414 return $result;
3415 }
3416
3417 /**
3418 * Auto-generates a deletion reason
3419 *
3420 * @param bool &$hasHistory Whether the page has a history
3421 * @return string|bool String containing deletion reason or empty string, or boolean false
3422 * if no revision occurred
3423 */
3424 public function getAutoDeleteReason( &$hasHistory ) {
3425 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3426 }
3427
3428 /**
3429 * Update all the appropriate counts in the category table, given that
3430 * we've added the categories $added and deleted the categories $deleted.
3431 *
3432 * This should only be called from deferred updates or jobs to avoid contention.
3433 *
3434 * @param array $added The names of categories that were added
3435 * @param array $deleted The names of categories that were deleted
3436 * @param int $id Page ID (this should be the original deleted page ID)
3437 */
3438 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3439 $id = $id ?: $this->getId();
3440 $ns = $this->getTitle()->getNamespace();
3441
3442 $addFields = [ 'cat_pages = cat_pages + 1' ];
3443 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3444 if ( $ns == NS_CATEGORY ) {
3445 $addFields[] = 'cat_subcats = cat_subcats + 1';
3446 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3447 } elseif ( $ns == NS_FILE ) {
3448 $addFields[] = 'cat_files = cat_files + 1';
3449 $removeFields[] = 'cat_files = cat_files - 1';
3450 }
3451
3452 $dbw = wfGetDB( DB_MASTER );
3453
3454 if ( count( $added ) ) {
3455 $existingAdded = $dbw->selectFieldValues(
3456 'category',
3457 'cat_title',
3458 [ 'cat_title' => $added ],
3459 __METHOD__
3460 );
3461
3462 // For category rows that already exist, do a plain
3463 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3464 // to avoid creating gaps in the cat_id sequence.
3465 if ( count( $existingAdded ) ) {
3466 $dbw->update(
3467 'category',
3468 $addFields,
3469 [ 'cat_title' => $existingAdded ],
3470 __METHOD__
3471 );
3472 }
3473
3474 $missingAdded = array_diff( $added, $existingAdded );
3475 if ( count( $missingAdded ) ) {
3476 $insertRows = [];
3477 foreach ( $missingAdded as $cat ) {
3478 $insertRows[] = [
3479 'cat_title' => $cat,
3480 'cat_pages' => 1,
3481 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3482 'cat_files' => ( $ns == NS_FILE ) ? 1 : 0,
3483 ];
3484 }
3485 $dbw->upsert(
3486 'category',
3487 $insertRows,
3488 [ 'cat_title' ],
3489 $addFields,
3490 __METHOD__
3491 );
3492 }
3493 }
3494
3495 if ( count( $deleted ) ) {
3496 $dbw->update(
3497 'category',
3498 $removeFields,
3499 [ 'cat_title' => $deleted ],
3500 __METHOD__
3501 );
3502 }
3503
3504 foreach ( $added as $catName ) {
3505 $cat = Category::newFromName( $catName );
3506 Hooks::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3507 }
3508
3509 foreach ( $deleted as $catName ) {
3510 $cat = Category::newFromName( $catName );
3511 Hooks::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3512 }
3513
3514 // Refresh counts on categories that should be empty now, to
3515 // trigger possible deletion. Check master for the most
3516 // up-to-date cat_pages.
3517 if ( count( $deleted ) ) {
3518 $rows = $dbw->select(
3519 'category',
3520 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3521 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3522 __METHOD__
3523 );
3524 foreach ( $rows as $row ) {
3525 $cat = Category::newFromRow( $row );
3526 // T166757: do the update after this DB commit
3527 DeferredUpdates::addCallableUpdate( function () use ( $cat ) {
3528 $cat->refreshCounts();
3529 } );
3530 }
3531 }
3532 }
3533
3534 /**
3535 * Opportunistically enqueue link update jobs given fresh parser output if useful
3536 *
3537 * @param ParserOutput $parserOutput Current version page output
3538 * @since 1.25
3539 */
3540 public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
3541 if ( wfReadOnly() ) {
3542 return;
3543 }
3544
3545 if ( !Hooks::run( 'OpportunisticLinksUpdate',
3546 [ $this, $this->mTitle, $parserOutput ]
3547 ) ) {
3548 return;
3549 }
3550
3551 $config = RequestContext::getMain()->getConfig();
3552
3553 $params = [
3554 'isOpportunistic' => true,
3555 'rootJobTimestamp' => $parserOutput->getCacheTime()
3556 ];
3557
3558 if ( $this->mTitle->areRestrictionsCascading() ) {
3559 // If the page is cascade protecting, the links should really be up-to-date
3560 JobQueueGroup::singleton()->lazyPush(
3561 RefreshLinksJob::newPrioritized( $this->mTitle, $params )
3562 );
3563 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3564 // Assume the output contains "dynamic" time/random based magic words.
3565 // Only update pages that expired due to dynamic content and NOT due to edits
3566 // to referenced templates/files. When the cache expires due to dynamic content,
3567 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3568 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3569 // template/file edit already triggered recursive RefreshLinksJob jobs.
3570 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3571 // If a page is uncacheable, do not keep spamming a job for it.
3572 // Although it would be de-duplicated, it would still waste I/O.
3573 $cache = ObjectCache::getLocalClusterInstance();
3574 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3575 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3576 if ( $cache->add( $key, time(), $ttl ) ) {
3577 JobQueueGroup::singleton()->lazyPush(
3578 RefreshLinksJob::newDynamic( $this->mTitle, $params )
3579 );
3580 }
3581 }
3582 }
3583 }
3584
3585 /**
3586 * Returns a list of updates to be performed when this page is deleted. The
3587 * updates should remove any information about this page from secondary data
3588 * stores such as links tables.
3589 *
3590 * @param Content|null $content Optional Content object for determining the
3591 * necessary updates.
3592 * @return DeferrableUpdate[]
3593 */
3594 public function getDeletionUpdates( Content $content = null ) {
3595 if ( !$content ) {
3596 // load content object, which may be used to determine the necessary updates.
3597 // XXX: the content may not be needed to determine the updates.
3598 try {
3599 $content = $this->getContent( Revision::RAW );
3600 } catch ( Exception $ex ) {
3601 // If we can't load the content, something is wrong. Perhaps that's why
3602 // the user is trying to delete the page, so let's not fail in that case.
3603 // Note that doDeleteArticleReal() will already have logged an issue with
3604 // loading the content.
3605 }
3606 }
3607
3608 if ( !$content ) {
3609 $updates = [];
3610 } else {
3611 $updates = $content->getDeletionUpdates( $this );
3612 }
3613
3614 Hooks::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3615 return $updates;
3616 }
3617
3618 /**
3619 * Whether this content displayed on this page
3620 * comes from the local database
3621 *
3622 * @since 1.28
3623 * @return bool
3624 */
3625 public function isLocal() {
3626 return true;
3627 }
3628
3629 /**
3630 * The display name for the site this content
3631 * come from. If a subclass overrides isLocal(),
3632 * this could return something other than the
3633 * current site name
3634 *
3635 * @since 1.28
3636 * @return string
3637 */
3638 public function getWikiDisplayName() {
3639 global $wgSitename;
3640 return $wgSitename;
3641 }
3642
3643 /**
3644 * Get the source URL for the content on this page,
3645 * typically the canonical URL, but may be a remote
3646 * link if the content comes from another site
3647 *
3648 * @since 1.28
3649 * @return string
3650 */
3651 public function getSourceURL() {
3652 return $this->getTitle()->getCanonicalURL();
3653 }
3654
3655 /**
3656 * @param WANObjectCache $cache
3657 * @return string[]
3658 * @since 1.28
3659 */
3660 public function getMutableCacheKeys( WANObjectCache $cache ) {
3661 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3662
3663 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle()->getTitleValue() );
3664 }
3665 }