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