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