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