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