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