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