Localisation updates from https://translatewiki.net.
[mediawiki.git] / includes / page / WikiPage.php
blobfe61f6f3e28d4c899d6a040ec3af5e39cfb18fbd
1 <?php
2 /**
3 * Base representation for a MediaWiki page.
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.
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.
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
20 * @file
23 /**
24 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
26 interface Page {
29 /**
30 * Class representing a MediaWiki article and history.
32 * Some fields are public only for backwards-compatibility. Use accessors.
33 * In the past, this class was part of Article.php and everything was public.
35 * @internal documentation reviewed 15 Mar 2010
37 class WikiPage implements Page, IDBAccessObject {
38 // Constants for $mDataLoadedFrom and related
40 /**
41 * @var Title
43 public $mTitle = null;
45 /**@{{
46 * @protected
48 public $mDataLoaded = false; // !< Boolean
49 public $mIsRedirect = false; // !< Boolean
50 public $mLatest = false; // !< Integer (false means "not loaded")
51 /**@}}*/
53 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
54 public $mPreparedEdit = false;
56 /**
57 * @var int
59 protected $mId = null;
61 /**
62 * @var int One of the READ_* constants
64 protected $mDataLoadedFrom = self::READ_NONE;
66 /**
67 * @var Title
69 protected $mRedirectTarget = null;
71 /**
72 * @var Revision
74 protected $mLastRevision = null;
76 /**
77 * @var string Timestamp of the current revision or empty string if not loaded
79 protected $mTimestamp = '';
81 /**
82 * @var string
84 protected $mTouched = '19700101000000';
86 /**
87 * @var string
89 protected $mLinksUpdated = '19700101000000';
91 /**
92 * Constructor and clear the article
93 * @param Title $title Reference to a Title object.
95 public function __construct( Title $title ) {
96 $this->mTitle = $title;
99 /**
100 * Create a WikiPage object of the appropriate class for the given title.
102 * @param Title $title
104 * @throws MWException
105 * @return WikiPage Object of the appropriate type
107 public static function factory( Title $title ) {
108 $ns = $title->getNamespace();
110 if ( $ns == NS_MEDIA ) {
111 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
112 } elseif ( $ns < 0 ) {
113 throw new MWException( "Invalid or virtual namespace $ns given." );
116 switch ( $ns ) {
117 case NS_FILE:
118 $page = new WikiFilePage( $title );
119 break;
120 case NS_CATEGORY:
121 $page = new WikiCategoryPage( $title );
122 break;
123 default:
124 $page = new WikiPage( $title );
127 return $page;
131 * Constructor from a page id
133 * @param int $id Article ID to load
134 * @param string|int $from One of the following values:
135 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
136 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
138 * @return WikiPage|null
140 public static function newFromID( $id, $from = 'fromdb' ) {
141 // page id's are never 0 or negative, see bug 61166
142 if ( $id < 1 ) {
143 return null;
146 $from = self::convertSelectType( $from );
147 $db = wfGetDB( $from === self::READ_LATEST ? DB_MASTER : DB_SLAVE );
148 $row = $db->selectRow( 'page', self::selectFields(), array( 'page_id' => $id ), __METHOD__ );
149 if ( !$row ) {
150 return null;
152 return self::newFromRow( $row, $from );
156 * Constructor from a database row
158 * @since 1.20
159 * @param object $row Database row containing at least fields returned by selectFields().
160 * @param string|int $from Source of $data:
161 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
162 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
163 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
164 * @return WikiPage
166 public static function newFromRow( $row, $from = 'fromdb' ) {
167 $page = self::factory( Title::newFromRow( $row ) );
168 $page->loadFromRow( $row, $from );
169 return $page;
173 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
175 * @param object|string|int $type
176 * @return mixed
178 private static function convertSelectType( $type ) {
179 switch ( $type ) {
180 case 'fromdb':
181 return self::READ_NORMAL;
182 case 'fromdbmaster':
183 return self::READ_LATEST;
184 case 'forupdate':
185 return self::READ_LOCKING;
186 default:
187 // It may already be an integer or whatever else
188 return $type;
193 * Returns overrides for action handlers.
194 * Classes listed here will be used instead of the default one when
195 * (and only when) $wgActions[$action] === true. This allows subclasses
196 * to override the default behavior.
198 * @todo Move this UI stuff somewhere else
200 * @return array
202 public function getActionOverrides() {
203 $content_handler = $this->getContentHandler();
204 return $content_handler->getActionOverrides();
208 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
210 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
212 * @return ContentHandler
214 * @since 1.21
216 public function getContentHandler() {
217 return ContentHandler::getForModelID( $this->getContentModel() );
221 * Get the title object of the article
222 * @return Title Title object of this page
224 public function getTitle() {
225 return $this->mTitle;
229 * Clear the object
230 * @return void
232 public function clear() {
233 $this->mDataLoaded = false;
234 $this->mDataLoadedFrom = self::READ_NONE;
236 $this->clearCacheFields();
240 * Clear the object cache fields
241 * @return void
243 protected function clearCacheFields() {
244 $this->mId = null;
245 $this->mRedirectTarget = null; // Title object if set
246 $this->mLastRevision = null; // Latest revision
247 $this->mTouched = '19700101000000';
248 $this->mLinksUpdated = '19700101000000';
249 $this->mTimestamp = '';
250 $this->mIsRedirect = false;
251 $this->mLatest = false;
252 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
253 // the requested rev ID and content against the cached one for equality. For most
254 // content types, the output should not change during the lifetime of this cache.
255 // Clearing it can cause extra parses on edit for no reason.
259 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
260 * @return void
261 * @since 1.23
263 public function clearPreparedEdit() {
264 $this->mPreparedEdit = false;
268 * Return the list of revision fields that should be selected to create
269 * a new page.
271 * @return array
273 public static function selectFields() {
274 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
276 $fields = array(
277 'page_id',
278 'page_namespace',
279 'page_title',
280 'page_restrictions',
281 'page_is_redirect',
282 'page_is_new',
283 'page_random',
284 'page_touched',
285 'page_links_updated',
286 'page_latest',
287 'page_len',
290 if ( $wgContentHandlerUseDB ) {
291 $fields[] = 'page_content_model';
294 if ( $wgPageLanguageUseDB ) {
295 $fields[] = 'page_lang';
298 return $fields;
302 * Fetch a page record with the given conditions
303 * @param DatabaseBase $dbr
304 * @param array $conditions
305 * @param array $options
306 * @return object|bool Database result resource, or false on failure
308 protected function pageData( $dbr, $conditions, $options = array() ) {
309 $fields = self::selectFields();
311 Hooks::run( 'ArticlePageDataBefore', array( &$this, &$fields ) );
313 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__, $options );
315 Hooks::run( 'ArticlePageDataAfter', array( &$this, &$row ) );
317 return $row;
321 * Fetch a page record matching the Title object's namespace and title
322 * using a sanitized title string
324 * @param DatabaseBase $dbr
325 * @param Title $title
326 * @param array $options
327 * @return object|bool Database result resource, or false on failure
329 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
330 return $this->pageData( $dbr, array(
331 'page_namespace' => $title->getNamespace(),
332 'page_title' => $title->getDBkey() ), $options );
336 * Fetch a page record matching the requested ID
338 * @param DatabaseBase $dbr
339 * @param int $id
340 * @param array $options
341 * @return object|bool Database result resource, or false on failure
343 public function pageDataFromId( $dbr, $id, $options = array() ) {
344 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
348 * Load the object from a given source by title
350 * @param object|string|int $from One of the following:
351 * - A DB query result object.
352 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
353 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
354 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
355 * using SELECT FOR UPDATE.
357 * @return void
359 public function loadPageData( $from = 'fromdb' ) {
360 $from = self::convertSelectType( $from );
361 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
362 // We already have the data from the correct location, no need to load it twice.
363 return;
366 if ( $from === self::READ_LOCKING ) {
367 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle, array( 'FOR UPDATE' ) );
368 } elseif ( $from === self::READ_LATEST ) {
369 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
370 } elseif ( $from === self::READ_NORMAL ) {
371 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE ), $this->mTitle );
372 // Use a "last rev inserted" timestamp key to diminish the issue of slave lag.
373 // Note that DB also stores the master position in the session and checks it.
374 $touched = $this->getCachedLastEditTime();
375 if ( $touched ) { // key set
376 if ( !$data || $touched > wfTimestamp( TS_MW, $data->page_touched ) ) {
377 $from = self::READ_LATEST;
378 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
381 } else {
382 // No idea from where the caller got this data, assume slave database.
383 $data = $from;
384 $from = self::READ_NORMAL;
387 $this->loadFromRow( $data, $from );
391 * Load the object from a database row
393 * @since 1.20
394 * @param object $data Database row containing at least fields returned by selectFields()
395 * @param string|int $from One of the following:
396 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
397 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
398 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
399 * the master DB using SELECT FOR UPDATE
401 public function loadFromRow( $data, $from ) {
402 $lc = LinkCache::singleton();
403 $lc->clearLink( $this->mTitle );
405 if ( $data ) {
406 $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
408 $this->mTitle->loadFromRow( $data );
410 // Old-fashioned restrictions
411 $this->mTitle->loadRestrictions( $data->page_restrictions );
413 $this->mId = intval( $data->page_id );
414 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
415 $this->mLinksUpdated = wfTimestampOrNull( TS_MW, $data->page_links_updated );
416 $this->mIsRedirect = intval( $data->page_is_redirect );
417 $this->mLatest = intval( $data->page_latest );
418 // Bug 37225: $latest may no longer match the cached latest Revision object.
419 // Double-check the ID of any cached latest Revision object for consistency.
420 if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
421 $this->mLastRevision = null;
422 $this->mTimestamp = '';
424 } else {
425 $lc->addBadLinkObj( $this->mTitle );
427 $this->mTitle->loadFromRow( false );
429 $this->clearCacheFields();
431 $this->mId = 0;
434 $this->mDataLoaded = true;
435 $this->mDataLoadedFrom = self::convertSelectType( $from );
439 * @return int Page ID
441 public function getId() {
442 if ( !$this->mDataLoaded ) {
443 $this->loadPageData();
445 return $this->mId;
449 * @return bool Whether or not the page exists in the database
451 public function exists() {
452 if ( !$this->mDataLoaded ) {
453 $this->loadPageData();
455 return $this->mId > 0;
459 * Check if this page is something we're going to be showing
460 * some sort of sensible content for. If we return false, page
461 * views (plain action=view) will return an HTTP 404 response,
462 * so spiders and robots can know they're following a bad link.
464 * @return bool
466 public function hasViewableContent() {
467 return $this->exists() || $this->mTitle->isAlwaysKnown();
471 * Tests if the article content represents a redirect
473 * @return bool
475 public function isRedirect() {
476 $content = $this->getContent();
477 if ( !$content ) {
478 return false;
481 return $content->isRedirect();
485 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
487 * Will use the revisions actual content model if the page exists,
488 * and the page's default if the page doesn't exist yet.
490 * @return string
492 * @since 1.21
494 public function getContentModel() {
495 if ( $this->exists() ) {
496 // look at the revision's actual content model
497 $rev = $this->getRevision();
499 if ( $rev !== null ) {
500 return $rev->getContentModel();
501 } else {
502 $title = $this->mTitle->getPrefixedDBkey();
503 wfWarn( "Page $title exists but has no (visible) revisions!" );
507 // use the default model for this page
508 return $this->mTitle->getContentModel();
512 * Loads page_touched and returns a value indicating if it should be used
513 * @return bool True if not a redirect
515 public function checkTouched() {
516 if ( !$this->mDataLoaded ) {
517 $this->loadPageData();
519 return !$this->mIsRedirect;
523 * Get the page_touched field
524 * @return string Containing GMT timestamp
526 public function getTouched() {
527 if ( !$this->mDataLoaded ) {
528 $this->loadPageData();
530 return $this->mTouched;
534 * Get the page_links_updated field
535 * @return string|null Containing GMT timestamp
537 public function getLinksTimestamp() {
538 if ( !$this->mDataLoaded ) {
539 $this->loadPageData();
541 return $this->mLinksUpdated;
545 * Get the page_latest field
546 * @return int The rev_id of current revision
548 public function getLatest() {
549 if ( !$this->mDataLoaded ) {
550 $this->loadPageData();
552 return (int)$this->mLatest;
556 * Get the Revision object of the oldest revision
557 * @return Revision|null
559 public function getOldestRevision() {
561 // Try using the slave database first, then try the master
562 $continue = 2;
563 $db = wfGetDB( DB_SLAVE );
564 $revSelectFields = Revision::selectFields();
566 $row = null;
567 while ( $continue ) {
568 $row = $db->selectRow(
569 array( 'page', 'revision' ),
570 $revSelectFields,
571 array(
572 'page_namespace' => $this->mTitle->getNamespace(),
573 'page_title' => $this->mTitle->getDBkey(),
574 'rev_page = page_id'
576 __METHOD__,
577 array(
578 'ORDER BY' => 'rev_timestamp ASC'
582 if ( $row ) {
583 $continue = 0;
584 } else {
585 $db = wfGetDB( DB_MASTER );
586 $continue--;
590 return $row ? Revision::newFromRow( $row ) : null;
594 * Loads everything except the text
595 * This isn't necessary for all uses, so it's only done if needed.
597 protected function loadLastEdit() {
598 if ( $this->mLastRevision !== null ) {
599 return; // already loaded
602 $latest = $this->getLatest();
603 if ( !$latest ) {
604 return; // page doesn't exist or is missing page_latest info
607 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always includes the
608 // latest changes committed. This is true even within REPEATABLE-READ transactions, where
609 // S1 normally only sees changes committed before the first S1 SELECT. Thus we need S1 to
610 // also gets the revision row FOR UPDATE; otherwise, it may not find it since a page row
611 // UPDATE and revision row INSERT by S2 may have happened after the first S1 SELECT.
612 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
613 $flags = ( $this->mDataLoadedFrom == self::READ_LOCKING ) ? Revision::READ_LOCKING : 0;
614 $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
615 if ( $revision ) { // sanity
616 $this->setLastEdit( $revision );
621 * Set the latest revision
622 * @param Revision $revision
624 protected function setLastEdit( Revision $revision ) {
625 $this->mLastRevision = $revision;
626 $this->mTimestamp = $revision->getTimestamp();
630 * Get the latest revision
631 * @return Revision|null
633 public function getRevision() {
634 $this->loadLastEdit();
635 if ( $this->mLastRevision ) {
636 return $this->mLastRevision;
638 return null;
642 * Get the content of the current revision. No side-effects...
644 * @param int $audience One of:
645 * Revision::FOR_PUBLIC to be displayed to all users
646 * Revision::FOR_THIS_USER to be displayed to $wgUser
647 * Revision::RAW get the text regardless of permissions
648 * @param User $user User object to check for, only if FOR_THIS_USER is passed
649 * to the $audience parameter
650 * @return Content|null The content of the current revision
652 * @since 1.21
654 public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) {
655 $this->loadLastEdit();
656 if ( $this->mLastRevision ) {
657 return $this->mLastRevision->getContent( $audience, $user );
659 return null;
663 * Get the text of the current revision. No side-effects...
665 * @param int $audience One of:
666 * Revision::FOR_PUBLIC to be displayed to all users
667 * Revision::FOR_THIS_USER to be displayed to the given user
668 * Revision::RAW get the text regardless of permissions
669 * @param User $user User object to check for, only if FOR_THIS_USER is passed
670 * to the $audience parameter
671 * @return string|bool The text of the current revision
672 * @deprecated since 1.21, getContent() should be used instead.
674 public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
675 ContentHandler::deprecated( __METHOD__, '1.21' );
677 $this->loadLastEdit();
678 if ( $this->mLastRevision ) {
679 return $this->mLastRevision->getText( $audience, $user );
681 return false;
685 * Get the text of the current revision. No side-effects...
687 * @return string|bool The text of the current revision. False on failure
688 * @deprecated since 1.21, getContent() should be used instead.
690 public function getRawText() {
691 ContentHandler::deprecated( __METHOD__, '1.21' );
693 return $this->getText( Revision::RAW );
697 * @return string MW timestamp of last article revision
699 public function getTimestamp() {
700 // Check if the field has been filled by WikiPage::setTimestamp()
701 if ( !$this->mTimestamp ) {
702 $this->loadLastEdit();
705 return wfTimestamp( TS_MW, $this->mTimestamp );
709 * Set the page timestamp (use only to avoid DB queries)
710 * @param string $ts MW timestamp of last article revision
711 * @return void
713 public function setTimestamp( $ts ) {
714 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
718 * @param int $audience One of:
719 * Revision::FOR_PUBLIC to be displayed to all users
720 * Revision::FOR_THIS_USER to be displayed to the given user
721 * Revision::RAW get the text regardless of permissions
722 * @param User $user User object to check for, only if FOR_THIS_USER is passed
723 * to the $audience parameter
724 * @return int User ID for the user that made the last article revision
726 public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
727 $this->loadLastEdit();
728 if ( $this->mLastRevision ) {
729 return $this->mLastRevision->getUser( $audience, $user );
730 } else {
731 return -1;
736 * Get the User object of the user who created the page
737 * @param int $audience One of:
738 * Revision::FOR_PUBLIC to be displayed to all users
739 * Revision::FOR_THIS_USER to be displayed to the given user
740 * Revision::RAW get the text regardless of permissions
741 * @param User $user User object to check for, only if FOR_THIS_USER is passed
742 * to the $audience parameter
743 * @return User|null
745 public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) {
746 $revision = $this->getOldestRevision();
747 if ( $revision ) {
748 $userName = $revision->getUserText( $audience, $user );
749 return User::newFromName( $userName, false );
750 } else {
751 return null;
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 Username of the user that made the last article revision
764 public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
765 $this->loadLastEdit();
766 if ( $this->mLastRevision ) {
767 return $this->mLastRevision->getUserText( $audience, $user );
768 } else {
769 return '';
774 * @param int $audience One of:
775 * Revision::FOR_PUBLIC to be displayed to all users
776 * Revision::FOR_THIS_USER to be displayed to the given user
777 * Revision::RAW get the text regardless of permissions
778 * @param User $user User object to check for, only if FOR_THIS_USER is passed
779 * to the $audience parameter
780 * @return string Comment stored for the last article revision
782 public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) {
783 $this->loadLastEdit();
784 if ( $this->mLastRevision ) {
785 return $this->mLastRevision->getComment( $audience, $user );
786 } else {
787 return '';
792 * Returns true if last revision was marked as "minor edit"
794 * @return bool Minor edit indicator for the last article revision.
796 public function getMinorEdit() {
797 $this->loadLastEdit();
798 if ( $this->mLastRevision ) {
799 return $this->mLastRevision->isMinor();
800 } else {
801 return false;
806 * Get the cached timestamp for the last time the page changed.
807 * This is only used to help handle slave lag by comparing to page_touched.
808 * @return string MW timestamp
810 protected function getCachedLastEditTime() {
811 global $wgMemc;
812 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
813 return $wgMemc->get( $key );
817 * Set the cached timestamp for the last time the page changed.
818 * This is only used to help handle slave lag by comparing to page_touched.
819 * @param string $timestamp
820 * @return void
822 public function setCachedLastEditTime( $timestamp ) {
823 global $wgMemc;
824 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
825 $wgMemc->set( $key, wfTimestamp( TS_MW, $timestamp ), 60 * 15 );
829 * Determine whether a page would be suitable for being counted as an
830 * article in the site_stats table based on the title & its content
832 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
833 * if false, the current database state will be used
834 * @return bool
836 public function isCountable( $editInfo = false ) {
837 global $wgArticleCountMethod;
839 if ( !$this->mTitle->isContentPage() ) {
840 return false;
843 if ( $editInfo ) {
844 $content = $editInfo->pstContent;
845 } else {
846 $content = $this->getContent();
849 if ( !$content || $content->isRedirect() ) {
850 return false;
853 $hasLinks = null;
855 if ( $wgArticleCountMethod === 'link' ) {
856 // nasty special case to avoid re-parsing to detect links
858 if ( $editInfo ) {
859 // ParserOutput::getLinks() is a 2D array of page links, so
860 // to be really correct we would need to recurse in the array
861 // but the main array should only have items in it if there are
862 // links.
863 $hasLinks = (bool)count( $editInfo->output->getLinks() );
864 } else {
865 $hasLinks = (bool)wfGetDB( DB_SLAVE )->selectField( 'pagelinks', 1,
866 array( 'pl_from' => $this->getId() ), __METHOD__ );
870 return $content->isCountable( $hasLinks );
874 * If this page is a redirect, get its target
876 * The target will be fetched from the redirect table if possible.
877 * If this page doesn't have an entry there, call insertRedirect()
878 * @return Title|null Title object, or null if this page is not a redirect
880 public function getRedirectTarget() {
881 if ( !$this->mTitle->isRedirect() ) {
882 return null;
885 if ( $this->mRedirectTarget !== null ) {
886 return $this->mRedirectTarget;
889 // Query the redirect table
890 $dbr = wfGetDB( DB_SLAVE );
891 $row = $dbr->selectRow( 'redirect',
892 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
893 array( 'rd_from' => $this->getId() ),
894 __METHOD__
897 // rd_fragment and rd_interwiki were added later, populate them if empty
898 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
899 $this->mRedirectTarget = Title::makeTitle(
900 $row->rd_namespace, $row->rd_title,
901 $row->rd_fragment, $row->rd_interwiki );
902 return $this->mRedirectTarget;
905 // This page doesn't have an entry in the redirect table
906 $this->mRedirectTarget = $this->insertRedirect();
907 return $this->mRedirectTarget;
911 * Insert an entry for this page into the redirect table.
913 * Don't call this function directly unless you know what you're doing.
914 * @return Title|null Title object or null if not a redirect
916 public function insertRedirect() {
917 // recurse through to only get the final target
918 $content = $this->getContent();
919 $retval = $content ? $content->getUltimateRedirectTarget() : null;
920 if ( !$retval ) {
921 return null;
923 $this->insertRedirectEntry( $retval );
924 return $retval;
928 * Insert or update the redirect table entry for this page to indicate
929 * it redirects to $rt .
930 * @param Title $rt Redirect target
932 public function insertRedirectEntry( $rt ) {
933 $dbw = wfGetDB( DB_MASTER );
934 $dbw->replace( 'redirect', array( 'rd_from' ),
935 array(
936 'rd_from' => $this->getId(),
937 'rd_namespace' => $rt->getNamespace(),
938 'rd_title' => $rt->getDBkey(),
939 'rd_fragment' => $rt->getFragment(),
940 'rd_interwiki' => $rt->getInterwiki(),
942 __METHOD__
947 * Get the Title object or URL this page redirects to
949 * @return bool|Title|string False, Title of in-wiki target, or string with URL
951 public function followRedirect() {
952 return $this->getRedirectURL( $this->getRedirectTarget() );
956 * Get the Title object or URL to use for a redirect. We use Title
957 * objects for same-wiki, non-special redirects and URLs for everything
958 * else.
959 * @param Title $rt Redirect target
960 * @return bool|Title|string False, Title object of local target, or string with URL
962 public function getRedirectURL( $rt ) {
963 if ( !$rt ) {
964 return false;
967 if ( $rt->isExternal() ) {
968 if ( $rt->isLocal() ) {
969 // Offsite wikis need an HTTP redirect.
971 // This can be hard to reverse and may produce loops,
972 // so they may be disabled in the site configuration.
973 $source = $this->mTitle->getFullURL( 'redirect=no' );
974 return $rt->getFullURL( array( 'rdfrom' => $source ) );
975 } else {
976 // External pages without "local" bit set are not valid
977 // redirect targets
978 return false;
982 if ( $rt->isSpecialPage() ) {
983 // Gotta handle redirects to special pages differently:
984 // Fill the HTTP response "Location" header and ignore
985 // the rest of the page we're on.
987 // Some pages are not valid targets
988 if ( $rt->isValidRedirectTarget() ) {
989 return $rt->getFullURL();
990 } else {
991 return false;
995 return $rt;
999 * Get a list of users who have edited this article, not including the user who made
1000 * the most recent revision, which you can get from $article->getUser() if you want it
1001 * @return UserArrayFromResult
1003 public function getContributors() {
1004 // @todo FIXME: This is expensive; cache this info somewhere.
1006 $dbr = wfGetDB( DB_SLAVE );
1008 if ( $dbr->implicitGroupby() ) {
1009 $realNameField = 'user_real_name';
1010 } else {
1011 $realNameField = 'MIN(user_real_name) AS user_real_name';
1014 $tables = array( 'revision', 'user' );
1016 $fields = array(
1017 'user_id' => 'rev_user',
1018 'user_name' => 'rev_user_text',
1019 $realNameField,
1020 'timestamp' => 'MAX(rev_timestamp)',
1023 $conds = array( 'rev_page' => $this->getId() );
1025 // The user who made the top revision gets credited as "this page was last edited by
1026 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1027 $user = $this->getUser();
1028 if ( $user ) {
1029 $conds[] = "rev_user != $user";
1030 } else {
1031 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1034 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1036 $jconds = array(
1037 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1040 $options = array(
1041 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1042 'ORDER BY' => 'timestamp DESC',
1045 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1046 return new UserArrayFromResult( $res );
1050 * Get the last N authors
1051 * @param int $num Number of revisions to get
1052 * @param int|string $revLatest The latest rev_id, selected from the master (optional)
1053 * @return array Array of authors, duplicates not removed
1055 public function getLastNAuthors( $num, $revLatest = 0 ) {
1056 // First try the slave
1057 // If that doesn't have the latest revision, try the master
1058 $continue = 2;
1059 $db = wfGetDB( DB_SLAVE );
1061 do {
1062 $res = $db->select( array( 'page', 'revision' ),
1063 array( 'rev_id', 'rev_user_text' ),
1064 array(
1065 'page_namespace' => $this->mTitle->getNamespace(),
1066 'page_title' => $this->mTitle->getDBkey(),
1067 'rev_page = page_id'
1068 ), __METHOD__,
1069 array(
1070 'ORDER BY' => 'rev_timestamp DESC',
1071 'LIMIT' => $num
1075 if ( !$res ) {
1076 return array();
1079 $row = $db->fetchObject( $res );
1081 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
1082 $db = wfGetDB( DB_MASTER );
1083 $continue--;
1084 } else {
1085 $continue = 0;
1087 } while ( $continue );
1089 $authors = array( $row->rev_user_text );
1091 foreach ( $res as $row ) {
1092 $authors[] = $row->rev_user_text;
1095 return $authors;
1099 * Should the parser cache be used?
1101 * @param ParserOptions $parserOptions ParserOptions to check
1102 * @param int $oldid
1103 * @return bool
1105 public function isParserCacheUsed( ParserOptions $parserOptions, $oldid ) {
1106 global $wgEnableParserCache;
1108 return $wgEnableParserCache
1109 && $parserOptions->getStubThreshold() == 0
1110 && $this->exists()
1111 && ( $oldid === null || $oldid === 0 || $oldid === $this->getLatest() )
1112 && $this->getContentHandler()->isParserCacheSupported();
1116 * Get a ParserOutput for the given ParserOptions and revision ID.
1117 * The parser cache will be used if possible.
1119 * @since 1.19
1120 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1121 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1122 * get the current revision (default value)
1124 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1126 public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
1128 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1129 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1130 if ( $parserOptions->getStubThreshold() ) {
1131 wfIncrStats( 'pcache_miss_stub' );
1134 if ( $useParserCache ) {
1135 $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
1136 if ( $parserOutput !== false ) {
1137 return $parserOutput;
1141 if ( $oldid === null || $oldid === 0 ) {
1142 $oldid = $this->getLatest();
1145 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1146 $pool->execute();
1148 return $pool->getParserOutput();
1152 * Do standard deferred updates after page view (existing or missing page)
1153 * @param User $user The relevant user
1154 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
1156 public function doViewUpdates( User $user, $oldid = 0 ) {
1157 if ( wfReadOnly() ) {
1158 return;
1161 // Update newtalk / watchlist notification status
1162 $user->clearNotification( $this->mTitle, $oldid );
1166 * Perform the actions of a page purging
1167 * @return bool
1169 public function doPurge() {
1170 global $wgUseSquid;
1172 if ( !Hooks::run( 'ArticlePurge', array( &$this ) ) ) {
1173 return false;
1176 // Invalidate the cache
1177 $this->mTitle->invalidateCache();
1179 if ( $wgUseSquid ) {
1180 // Commit the transaction before the purge is sent
1181 $dbw = wfGetDB( DB_MASTER );
1182 $dbw->commit( __METHOD__ );
1184 // Send purge
1185 $update = SquidUpdate::newSimplePurge( $this->mTitle );
1186 $update->doUpdate();
1189 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1190 // @todo move this logic to MessageCache
1192 if ( $this->exists() ) {
1193 // NOTE: use transclusion text for messages.
1194 // This is consistent with MessageCache::getMsgFromNamespace()
1196 $content = $this->getContent();
1197 $text = $content === null ? null : $content->getWikitextForTransclusion();
1199 if ( $text === null ) {
1200 $text = false;
1202 } else {
1203 $text = false;
1206 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
1208 return true;
1212 * Insert a new empty page record for this article.
1213 * This *must* be followed up by creating a revision
1214 * and running $this->updateRevisionOn( ... );
1215 * or else the record will be left in a funky state.
1216 * Best if all done inside a transaction.
1218 * @param DatabaseBase $dbw
1219 * @return int The newly created page_id key, or false if the title already existed
1221 public function insertOn( $dbw ) {
1223 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1224 $dbw->insert( 'page', array(
1225 'page_id' => $page_id,
1226 'page_namespace' => $this->mTitle->getNamespace(),
1227 'page_title' => $this->mTitle->getDBkey(),
1228 'page_restrictions' => '',
1229 'page_is_redirect' => 0, // Will set this shortly...
1230 'page_is_new' => 1,
1231 'page_random' => wfRandom(),
1232 'page_touched' => $dbw->timestamp(),
1233 'page_latest' => 0, // Fill this in shortly...
1234 'page_len' => 0, // Fill this in shortly...
1235 ), __METHOD__, 'IGNORE' );
1237 $affected = $dbw->affectedRows();
1239 if ( $affected ) {
1240 $newid = $dbw->insertId();
1241 $this->mId = $newid;
1242 $this->mTitle->resetArticleID( $newid );
1245 return $affected ? $newid : false;
1249 * Update the page record to point to a newly saved revision.
1251 * @param DatabaseBase $dbw
1252 * @param Revision $revision For ID number, and text used to set
1253 * length and redirect status fields
1254 * @param int $lastRevision If given, will not overwrite the page field
1255 * when different from the currently set value.
1256 * Giving 0 indicates the new page flag should be set on.
1257 * @param bool $lastRevIsRedirect If given, will optimize adding and
1258 * removing rows in redirect table.
1259 * @return bool True on success, false on failure
1261 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1262 $lastRevIsRedirect = null
1264 global $wgContentHandlerUseDB;
1266 $content = $revision->getContent();
1267 $len = $content ? $content->getSize() : 0;
1268 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1270 $conditions = array( 'page_id' => $this->getId() );
1272 if ( !is_null( $lastRevision ) ) {
1273 // An extra check against threads stepping on each other
1274 $conditions['page_latest'] = $lastRevision;
1277 $now = wfTimestampNow();
1278 $row = array( /* SET */
1279 'page_latest' => $revision->getId(),
1280 'page_touched' => $dbw->timestamp( $now ),
1281 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
1282 'page_is_redirect' => $rt !== null ? 1 : 0,
1283 'page_len' => $len,
1286 if ( $wgContentHandlerUseDB ) {
1287 $row['page_content_model'] = $revision->getContentModel();
1290 $dbw->update( 'page',
1291 $row,
1292 $conditions,
1293 __METHOD__ );
1295 $result = $dbw->affectedRows() > 0;
1296 if ( $result ) {
1297 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1298 $this->setLastEdit( $revision );
1299 $this->setCachedLastEditTime( $now );
1300 $this->mLatest = $revision->getId();
1301 $this->mIsRedirect = (bool)$rt;
1302 // Update the LinkCache.
1303 LinkCache::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle, $len, $this->mIsRedirect,
1304 $this->mLatest, $revision->getContentModel() );
1307 return $result;
1311 * Add row to the redirect table if this is a redirect, remove otherwise.
1313 * @param DatabaseBase $dbw
1314 * @param Title $redirectTitle Title object pointing to the redirect target,
1315 * or NULL if this is not a redirect
1316 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1317 * removing rows in redirect table.
1318 * @return bool True on success, false on failure
1319 * @private
1321 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1322 // Always update redirects (target link might have changed)
1323 // Update/Insert if we don't know if the last revision was a redirect or not
1324 // Delete if changing from redirect to non-redirect
1325 $isRedirect = !is_null( $redirectTitle );
1327 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1328 return true;
1331 if ( $isRedirect ) {
1332 $this->insertRedirectEntry( $redirectTitle );
1333 } else {
1334 // This is not a redirect, remove row from redirect table
1335 $where = array( 'rd_from' => $this->getId() );
1336 $dbw->delete( 'redirect', $where, __METHOD__ );
1339 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1340 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1343 return ( $dbw->affectedRows() != 0 );
1347 * If the given revision is newer than the currently set page_latest,
1348 * update the page record. Otherwise, do nothing.
1350 * @deprecated since 1.24, use updateRevisionOn instead
1352 * @param DatabaseBase $dbw
1353 * @param Revision $revision
1354 * @return bool
1356 public function updateIfNewerOn( $dbw, $revision ) {
1358 $row = $dbw->selectRow(
1359 array( 'revision', 'page' ),
1360 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1361 array(
1362 'page_id' => $this->getId(),
1363 'page_latest=rev_id' ),
1364 __METHOD__ );
1366 if ( $row ) {
1367 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1368 return false;
1370 $prev = $row->rev_id;
1371 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1372 } else {
1373 // No or missing previous revision; mark the page as new
1374 $prev = 0;
1375 $lastRevIsRedirect = null;
1378 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1380 return $ret;
1384 * Get the content that needs to be saved in order to undo all revisions
1385 * between $undo and $undoafter. Revisions must belong to the same page,
1386 * must exist and must not be deleted
1387 * @param Revision $undo
1388 * @param Revision $undoafter Must be an earlier revision than $undo
1389 * @return mixed String on success, false on failure
1390 * @since 1.21
1391 * Before we had the Content object, this was done in getUndoText
1393 public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1394 $handler = $undo->getContentHandler();
1395 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1399 * Get the text that needs to be saved in order to undo all revisions
1400 * between $undo and $undoafter. Revisions must belong to the same page,
1401 * must exist and must not be deleted
1402 * @param Revision $undo
1403 * @param Revision $undoafter Must be an earlier revision than $undo
1404 * @return string|bool String on success, false on failure
1405 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1407 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
1408 ContentHandler::deprecated( __METHOD__, '1.21' );
1410 $this->loadLastEdit();
1412 if ( $this->mLastRevision ) {
1413 if ( is_null( $undoafter ) ) {
1414 $undoafter = $undo->getPrevious();
1417 $handler = $this->getContentHandler();
1418 $undone = $handler->getUndoContent( $this->mLastRevision, $undo, $undoafter );
1420 if ( !$undone ) {
1421 return false;
1422 } else {
1423 return ContentHandler::getContentText( $undone );
1427 return false;
1431 * @param string|number|null|bool $sectionId Section identifier as a number or string
1432 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1433 * or 'new' for a new section.
1434 * @param string $text New text of the section.
1435 * @param string $sectionTitle New section's subject, only if $section is "new".
1436 * @param string $edittime Revision timestamp or null to use the current revision.
1438 * @throws MWException
1439 * @return string New complete article text, or null if error.
1441 * @deprecated since 1.21, use replaceSectionAtRev() instead
1443 public function replaceSection( $sectionId, $text, $sectionTitle = '',
1444 $edittime = null
1446 ContentHandler::deprecated( __METHOD__, '1.21' );
1448 //NOTE: keep condition in sync with condition in replaceSectionContent!
1449 if ( strval( $sectionId ) === '' ) {
1450 // Whole-page edit; let the whole text through
1451 return $text;
1454 if ( !$this->supportsSections() ) {
1455 throw new MWException( "sections not supported for content model " .
1456 $this->getContentHandler()->getModelID() );
1459 // could even make section title, but that's not required.
1460 $sectionContent = ContentHandler::makeContent( $text, $this->getTitle() );
1462 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1463 $edittime );
1465 return ContentHandler::getContentText( $newContent );
1469 * Returns true if this page's content model supports sections.
1471 * @return bool
1473 * @todo The skin should check this and not offer section functionality if
1474 * sections are not supported.
1475 * @todo The EditPage should check this and not offer section functionality
1476 * if sections are not supported.
1478 public function supportsSections() {
1479 return $this->getContentHandler()->supportsSections();
1483 * @param string|number|null|bool $sectionId Section identifier as a number or string
1484 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1485 * or 'new' for a new section.
1486 * @param Content $sectionContent New content of the section.
1487 * @param string $sectionTitle New section's subject, only if $section is "new".
1488 * @param string $edittime Revision timestamp or null to use the current revision.
1490 * @throws MWException
1491 * @return Content New complete article content, or null if error.
1493 * @since 1.21
1494 * @deprecated since 1.24, use replaceSectionAtRev instead
1496 public function replaceSectionContent( $sectionId, Content $sectionContent, $sectionTitle = '',
1497 $edittime = null ) {
1499 $baseRevId = null;
1500 if ( $edittime && $sectionId !== 'new' ) {
1501 $dbw = wfGetDB( DB_MASTER );
1502 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1503 if ( $rev ) {
1504 $baseRevId = $rev->getId();
1508 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1512 * @param string|number|null|bool $sectionId Section identifier as a number or string
1513 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1514 * or 'new' for a new section.
1515 * @param Content $sectionContent New content of the section.
1516 * @param string $sectionTitle New section's subject, only if $section is "new".
1517 * @param int|null $baseRevId
1519 * @throws MWException
1520 * @return Content New complete article content, or null if error.
1522 * @since 1.24
1524 public function replaceSectionAtRev( $sectionId, Content $sectionContent,
1525 $sectionTitle = '', $baseRevId = null
1528 if ( strval( $sectionId ) === '' ) {
1529 // Whole-page edit; let the whole text through
1530 $newContent = $sectionContent;
1531 } else {
1532 if ( !$this->supportsSections() ) {
1533 throw new MWException( "sections not supported for content model " .
1534 $this->getContentHandler()->getModelID() );
1537 // Bug 30711: always use current version when adding a new section
1538 if ( is_null( $baseRevId ) || $sectionId === 'new' ) {
1539 $oldContent = $this->getContent();
1540 } else {
1541 // TODO: try DB_SLAVE first
1542 $dbw = wfGetDB( DB_MASTER );
1543 $rev = Revision::loadFromId( $dbw, $baseRevId );
1545 if ( !$rev ) {
1546 wfDebug( __METHOD__ . " asked for bogus section (page: " .
1547 $this->getId() . "; section: $sectionId)\n" );
1548 return null;
1551 $oldContent = $rev->getContent();
1554 if ( !$oldContent ) {
1555 wfDebug( __METHOD__ . ": no page text\n" );
1556 return null;
1559 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1562 return $newContent;
1566 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1567 * @param int $flags
1568 * @return int Updated $flags
1570 public function checkFlags( $flags ) {
1571 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1572 if ( $this->exists() ) {
1573 $flags |= EDIT_UPDATE;
1574 } else {
1575 $flags |= EDIT_NEW;
1579 return $flags;
1583 * Change an existing article or create a new article. Updates RC and all necessary caches,
1584 * optionally via the deferred update array.
1586 * @param string $text New text
1587 * @param string $summary Edit summary
1588 * @param int $flags Bitfield:
1589 * EDIT_NEW
1590 * Article is known or assumed to be non-existent, create a new one
1591 * EDIT_UPDATE
1592 * Article is known or assumed to be pre-existing, update it
1593 * EDIT_MINOR
1594 * Mark this edit minor, if the user is allowed to do so
1595 * EDIT_SUPPRESS_RC
1596 * Do not log the change in recentchanges
1597 * EDIT_FORCE_BOT
1598 * Mark the edit a "bot" edit regardless of user rights
1599 * EDIT_DEFER_UPDATES
1600 * Defer some of the updates until the end of index.php
1601 * EDIT_AUTOSUMMARY
1602 * Fill in blank summaries with generated text where possible
1604 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1605 * article will be detected. If EDIT_UPDATE is specified and the article
1606 * doesn't exist, the function will return an edit-gone-missing error. If
1607 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1608 * error will be returned. These two conditions are also possible with
1609 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1611 * @param bool|int $baseRevId The revision ID this edit was based off, if any
1612 * @param User $user The user doing the edit
1614 * @throws MWException
1615 * @return Status Possible errors:
1616 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1617 * set the fatal flag of $status
1618 * edit-gone-missing: In update mode, but the article didn't exist.
1619 * edit-conflict: In update mode, the article changed unexpectedly.
1620 * edit-no-change: Warning that the text was the same as before.
1621 * edit-already-exists: In creation mode, but the article already exists.
1623 * Extensions may define additional errors.
1625 * $return->value will contain an associative array with members as follows:
1626 * new: Boolean indicating if the function attempted to create a new article.
1627 * revision: The revision object for the inserted revision, or null.
1629 * Compatibility note: this function previously returned a boolean value
1630 * indicating success/failure
1632 * @deprecated since 1.21: use doEditContent() instead.
1634 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1635 ContentHandler::deprecated( __METHOD__, '1.21' );
1637 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1639 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1643 * Change an existing article or create a new article. Updates RC and all necessary caches,
1644 * optionally via the deferred update array.
1646 * @param Content $content New content
1647 * @param string $summary Edit summary
1648 * @param int $flags Bitfield:
1649 * EDIT_NEW
1650 * Article is known or assumed to be non-existent, create a new one
1651 * EDIT_UPDATE
1652 * Article is known or assumed to be pre-existing, update it
1653 * EDIT_MINOR
1654 * Mark this edit minor, if the user is allowed to do so
1655 * EDIT_SUPPRESS_RC
1656 * Do not log the change in recentchanges
1657 * EDIT_FORCE_BOT
1658 * Mark the edit a "bot" edit regardless of user rights
1659 * EDIT_DEFER_UPDATES
1660 * Defer some of the updates until the end of index.php
1661 * EDIT_AUTOSUMMARY
1662 * Fill in blank summaries with generated text where possible
1664 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1665 * article will be detected. If EDIT_UPDATE is specified and the article
1666 * doesn't exist, the function will return an edit-gone-missing error. If
1667 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1668 * error will be returned. These two conditions are also possible with
1669 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1671 * @param bool|int $baseRevId The revision ID this edit was based off, if any
1672 * @param User $user The user doing the edit
1673 * @param string $serialFormat Format for storing the content in the
1674 * database.
1676 * @throws MWException
1677 * @return Status Possible errors:
1678 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1679 * set the fatal flag of $status.
1680 * edit-gone-missing: In update mode, but the article didn't exist.
1681 * edit-conflict: In update mode, the article changed unexpectedly.
1682 * edit-no-change: Warning that the text was the same as before.
1683 * edit-already-exists: In creation mode, but the article already exists.
1685 * Extensions may define additional errors.
1687 * $return->value will contain an associative array with members as follows:
1688 * new: Boolean indicating if the function attempted to create a new article.
1689 * revision: The revision object for the inserted revision, or null.
1691 * @since 1.21
1693 public function doEditContent( Content $content, $summary, $flags = 0, $baseRevId = false,
1694 User $user = null, $serialFormat = null
1696 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1698 // Low-level sanity check
1699 if ( $this->mTitle->getText() === '' ) {
1700 throw new MWException( 'Something is trying to edit an article with an empty title' );
1703 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1704 return Status::newFatal( 'content-not-allowed-here',
1705 ContentHandler::getLocalizedName( $content->getModel() ),
1706 $this->getTitle()->getPrefixedText() );
1709 $user = is_null( $user ) ? $wgUser : $user;
1710 $status = Status::newGood( array() );
1712 // Load the data from the master database if needed.
1713 // The caller may already loaded it from the master or even loaded it using
1714 // SELECT FOR UPDATE, so do not override that using clear().
1715 $this->loadPageData( 'fromdbmaster' );
1717 $flags = $this->checkFlags( $flags );
1719 // handle hook
1720 $hook_args = array( &$this, &$user, &$content, &$summary,
1721 $flags & EDIT_MINOR, null, null, &$flags, &$status );
1723 if ( !Hooks::run( 'PageContentSave', $hook_args )
1724 || !ContentHandler::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1726 wfDebug( __METHOD__ . ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1728 if ( $status->isOK() ) {
1729 $status->fatal( 'edit-hook-aborted' );
1732 return $status;
1735 // Silently ignore EDIT_MINOR if not allowed
1736 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
1737 $bot = $flags & EDIT_FORCE_BOT;
1739 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1741 $oldsize = $old_content ? $old_content->getSize() : 0;
1742 $oldid = $this->getLatest();
1743 $oldIsRedirect = $this->isRedirect();
1744 $oldcountable = $this->isCountable();
1746 $handler = $content->getContentHandler();
1748 // Provide autosummaries if one is not provided and autosummaries are enabled.
1749 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
1750 if ( !$old_content ) {
1751 $old_content = null;
1753 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1756 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1757 $serialized = $editInfo->pst;
1760 * @var Content $content
1762 $content = $editInfo->pstContent;
1763 $newsize = $content->getSize();
1765 $dbw = wfGetDB( DB_MASTER );
1766 $now = wfTimestampNow();
1767 $this->mTimestamp = $now;
1769 if ( $flags & EDIT_UPDATE ) {
1770 // Update article, but only if changed.
1771 $status->value['new'] = false;
1773 if ( !$oldid ) {
1774 // Article gone missing
1775 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
1776 $status->fatal( 'edit-gone-missing' );
1778 return $status;
1779 } elseif ( !$old_content ) {
1780 // Sanity check for bug 37225
1781 throw new MWException( "Could not find text for current revision {$oldid}." );
1784 $revision = new Revision( array(
1785 'page' => $this->getId(),
1786 'title' => $this->getTitle(), // for determining the default content model
1787 'comment' => $summary,
1788 'minor_edit' => $isminor,
1789 'text' => $serialized,
1790 'len' => $newsize,
1791 'parent_id' => $oldid,
1792 'user' => $user->getId(),
1793 'user_text' => $user->getName(),
1794 'timestamp' => $now,
1795 'content_model' => $content->getModel(),
1796 'content_format' => $serialFormat,
1797 ) ); // XXX: pass content object?!
1799 $changed = !$content->equals( $old_content );
1801 if ( $changed ) {
1802 $dbw->begin( __METHOD__ );
1803 try {
1805 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1806 $status->merge( $prepStatus );
1808 if ( !$status->isOK() ) {
1809 $dbw->rollback( __METHOD__ );
1811 return $status;
1813 $revisionId = $revision->insertOn( $dbw );
1815 // Update page
1817 // We check for conflicts by comparing $oldid with the current latest revision ID.
1818 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1820 if ( !$ok ) {
1821 // Belated edit conflict! Run away!!
1822 $status->fatal( 'edit-conflict' );
1824 $dbw->rollback( __METHOD__ );
1826 return $status;
1829 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1830 // Update recentchanges
1831 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1832 // Mark as patrolled if the user can do so
1833 $patrolled = $wgUseRCPatrol && !count(
1834 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1835 // Add RC row to the DB
1836 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
1837 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1838 $revisionId, $patrolled
1841 // Log auto-patrolled edits
1842 if ( $patrolled ) {
1843 PatrolLog::record( $rc, true, $user );
1846 $user->incEditCount();
1847 } catch ( Exception $e ) {
1848 $dbw->rollback( __METHOD__ );
1849 // Question: Would it perhaps be better if this method turned all
1850 // exceptions into $status's?
1851 throw $e;
1853 $dbw->commit( __METHOD__ );
1854 } else {
1855 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1856 // related variables correctly
1857 $revision->setId( $this->getLatest() );
1860 // Update links tables, site stats, etc.
1861 $this->doEditUpdates(
1862 $revision,
1863 $user,
1864 array(
1865 'changed' => $changed,
1866 'oldcountable' => $oldcountable
1870 if ( !$changed ) {
1871 $status->warning( 'edit-no-change' );
1872 $revision = null;
1873 // Update page_touched, this is usually implicit in the page update
1874 // Other cache updates are done in onArticleEdit()
1875 $this->mTitle->invalidateCache();
1877 } else {
1878 // Create new article
1879 $status->value['new'] = true;
1881 $dbw->begin( __METHOD__ );
1882 try {
1884 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1885 $status->merge( $prepStatus );
1887 if ( !$status->isOK() ) {
1888 $dbw->rollback( __METHOD__ );
1890 return $status;
1893 $status->merge( $prepStatus );
1895 // Add the page record; stake our claim on this title!
1896 // This will return false if the article already exists
1897 $newid = $this->insertOn( $dbw );
1899 if ( $newid === false ) {
1900 $dbw->rollback( __METHOD__ );
1901 $status->fatal( 'edit-already-exists' );
1903 return $status;
1906 // Save the revision text...
1907 $revision = new Revision( array(
1908 'page' => $newid,
1909 'title' => $this->getTitle(), // for determining the default content model
1910 'comment' => $summary,
1911 'minor_edit' => $isminor,
1912 'text' => $serialized,
1913 'len' => $newsize,
1914 'user' => $user->getId(),
1915 'user_text' => $user->getName(),
1916 'timestamp' => $now,
1917 'content_model' => $content->getModel(),
1918 'content_format' => $serialFormat,
1919 ) );
1920 $revisionId = $revision->insertOn( $dbw );
1922 // Bug 37225: use accessor to get the text as Revision may trim it
1923 $content = $revision->getContent(); // sanity; get normalized version
1925 if ( $content ) {
1926 $newsize = $content->getSize();
1929 // Update the page record with revision data
1930 $this->updateRevisionOn( $dbw, $revision, 0 );
1932 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1934 // Update recentchanges
1935 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1936 // Mark as patrolled if the user can do so
1937 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
1938 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1939 // Add RC row to the DB
1940 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
1941 '', $newsize, $revisionId, $patrolled );
1943 // Log auto-patrolled edits
1944 if ( $patrolled ) {
1945 PatrolLog::record( $rc, true, $user );
1948 $user->incEditCount();
1950 } catch ( Exception $e ) {
1951 $dbw->rollback( __METHOD__ );
1952 throw $e;
1954 $dbw->commit( __METHOD__ );
1956 // Update links, etc.
1957 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1959 $hook_args = array( &$this, &$user, $content, $summary,
1960 $flags & EDIT_MINOR, null, null, &$flags, $revision );
1962 ContentHandler::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1963 Hooks::run( 'PageContentInsertComplete', $hook_args );
1966 // Do updates right now unless deferral was requested
1967 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
1968 DeferredUpdates::doUpdates();
1971 // Return the new revision (or null) to the caller
1972 $status->value['revision'] = $revision;
1974 $hook_args = array( &$this, &$user, $content, $summary,
1975 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId );
1977 ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1978 Hooks::run( 'PageContentSaveComplete', $hook_args );
1980 // Promote user to any groups they meet the criteria for
1981 $dbw->onTransactionIdle( function () use ( $user ) {
1982 $user->addAutopromoteOnceGroups( 'onEdit' );
1983 } );
1985 return $status;
1989 * Get parser options suitable for rendering the primary article wikitext
1991 * @see ContentHandler::makeParserOptions
1993 * @param IContextSource|User|string $context One of the following:
1994 * - IContextSource: Use the User and the Language of the provided
1995 * context
1996 * - User: Use the provided User object and $wgLang for the language,
1997 * so use an IContextSource object if possible.
1998 * - 'canonical': Canonical options (anonymous user with default
1999 * preferences and content language).
2000 * @return ParserOptions
2002 public function makeParserOptions( $context ) {
2003 $options = $this->getContentHandler()->makeParserOptions( $context );
2005 if ( $this->getTitle()->isConversionTable() ) {
2006 // @todo ConversionTable should become a separate content model, so
2007 // we don't need special cases like this one.
2008 $options->disableContentConversion();
2011 return $options;
2015 * Prepare text which is about to be saved.
2016 * Returns a stdClass with source, pst and output members
2018 * @deprecated since 1.21: use prepareContentForEdit instead.
2019 * @return object
2021 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
2022 ContentHandler::deprecated( __METHOD__, '1.21' );
2023 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2024 return $this->prepareContentForEdit( $content, $revid, $user );
2028 * Prepare content which is about to be saved.
2029 * Returns a stdClass with source, pst and output members
2031 * @param Content $content
2032 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2033 * revision ID is also accepted, but this is deprecated.
2034 * @param User|null $user
2035 * @param string|null $serialFormat
2036 * @param bool $useCache Check shared prepared edit cache
2038 * @return object
2040 * @since 1.21
2042 public function prepareContentForEdit(
2043 Content $content, $revision = null, User $user = null, $serialFormat = null, $useCache = true
2045 global $wgContLang, $wgUser, $wgAjaxEditStash;
2047 if ( is_object( $revision ) ) {
2048 $revid = $revision->getId();
2049 } else {
2050 $revid = $revision;
2051 // This code path is deprecated, and nothing is known to
2052 // use it, so performance here shouldn't be a worry.
2053 if ( $revid !== null ) {
2054 $revision = Revision::newFromId( $revid, Revision::READ_LATEST );
2055 } else {
2056 $revision = null;
2060 $user = is_null( $user ) ? $wgUser : $user;
2061 //XXX: check $user->getId() here???
2063 // Use a sane default for $serialFormat, see bug 57026
2064 if ( $serialFormat === null ) {
2065 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2068 if ( $this->mPreparedEdit
2069 && $this->mPreparedEdit->newContent
2070 && $this->mPreparedEdit->newContent->equals( $content )
2071 && $this->mPreparedEdit->revid == $revid
2072 && $this->mPreparedEdit->format == $serialFormat
2073 // XXX: also check $user here?
2075 // Already prepared
2076 return $this->mPreparedEdit;
2079 // The edit may have already been prepared via api.php?action=stashedit
2080 $cachedEdit = $useCache && $wgAjaxEditStash
2081 ? ApiStashEdit::checkCache( $this->getTitle(), $content, $user )
2082 : false;
2084 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2085 Hooks::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2087 $edit = (object)array();
2088 if ( $cachedEdit ) {
2089 $edit->timestamp = $cachedEdit->timestamp;
2090 } else {
2091 $edit->timestamp = wfTimestampNow();
2093 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2094 $edit->revid = $revid;
2096 if ( $cachedEdit ) {
2097 $edit->pstContent = $cachedEdit->pstContent;
2098 } else {
2099 $edit->pstContent = $content
2100 ? $content->preSaveTransform( $this->mTitle, $user, $popts )
2101 : null;
2104 $edit->format = $serialFormat;
2105 $edit->popts = $this->makeParserOptions( 'canonical' );
2106 if ( $cachedEdit ) {
2107 $edit->output = $cachedEdit->output;
2108 } else {
2109 if ( $revision ) {
2110 // We get here if vary-revision is set. This means that this page references
2111 // itself (such as via self-transclusion). In this case, we need to make sure
2112 // that any such self-references refer to the newly-saved revision, and not
2113 // to the previous one, which could otherwise happen due to slave lag.
2114 $oldCallback = $edit->popts->setCurrentRevisionCallback(
2115 function ( $title, $parser = false ) use ( $revision, &$oldCallback ) {
2116 if ( $title->equals( $revision->getTitle() ) ) {
2117 return $revision;
2118 } else {
2119 return call_user_func(
2120 $oldCallback,
2121 $title,
2122 $parser
2128 $edit->output = $edit->pstContent
2129 ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts )
2130 : null;
2133 $edit->newContent = $content;
2134 $edit->oldContent = $this->getContent( Revision::RAW );
2136 // NOTE: B/C for hooks! don't use these fields!
2137 $edit->newText = $edit->newContent ? ContentHandler::getContentText( $edit->newContent ) : '';
2138 $edit->oldText = $edit->oldContent ? ContentHandler::getContentText( $edit->oldContent ) : '';
2139 $edit->pst = $edit->pstContent ? $edit->pstContent->serialize( $serialFormat ) : '';
2141 $this->mPreparedEdit = $edit;
2142 return $edit;
2146 * Do standard deferred updates after page edit.
2147 * Update links tables, site stats, search index and message cache.
2148 * Purges pages that include this page if the text was changed here.
2149 * Every 100th edit, prune the recent changes table.
2151 * @param Revision $revision
2152 * @param User $user User object that did the revision
2153 * @param array $options Array of options, following indexes are used:
2154 * - changed: boolean, whether the revision changed the content (default true)
2155 * - created: boolean, whether the revision created the page (default false)
2156 * - moved: boolean, whether the page was moved (default false)
2157 * - oldcountable: boolean, null, or string 'no-change' (default null):
2158 * - boolean: whether the page was counted as an article before that
2159 * revision, only used in changed is true and created is false
2160 * - null: if created is false, don't update the article count; if created
2161 * is true, do update the article count
2162 * - 'no-change': don't update the article count, ever
2164 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2165 global $wgEnableParserCache;
2167 $options += array(
2168 'changed' => true,
2169 'created' => false,
2170 'moved' => false,
2171 'oldcountable' => null
2173 $content = $revision->getContent();
2175 // Parse the text
2176 // Be careful not to do pre-save transform twice: $text is usually
2177 // already pre-save transformed once.
2178 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2179 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2180 $editInfo = $this->prepareContentForEdit( $content, $revision, $user );
2181 } else {
2182 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2183 $editInfo = $this->mPreparedEdit;
2186 // Save it to the parser cache
2187 if ( $wgEnableParserCache ) {
2188 $parserCache = ParserCache::singleton();
2189 $parserCache->save(
2190 $editInfo->output, $this, $editInfo->popts, $editInfo->timestamp, $editInfo->revid
2194 // Update the links tables and other secondary data
2195 if ( $content ) {
2196 $recursive = $options['changed']; // bug 50785
2197 $updates = $content->getSecondaryDataUpdates(
2198 $this->getTitle(), null, $recursive, $editInfo->output );
2199 DataUpdate::runUpdates( $updates );
2202 Hooks::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2204 if ( Hooks::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2205 // Flush old entries from the `recentchanges` table
2206 JobQueueGroup::singleton()->push( RecentChangesUpdateJob::newPurgeJob() );
2209 if ( !$this->exists() ) {
2210 return;
2213 $id = $this->getId();
2214 $title = $this->mTitle->getPrefixedDBkey();
2215 $shortTitle = $this->mTitle->getDBkey();
2217 if ( $options['oldcountable'] === 'no-change' ||
2218 ( !$options['changed'] && !$options['moved'] )
2220 $good = 0;
2221 } elseif ( $options['created'] ) {
2222 $good = (int)$this->isCountable( $editInfo );
2223 } elseif ( $options['oldcountable'] !== null ) {
2224 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2225 } else {
2226 $good = 0;
2228 $edits = $options['changed'] ? 1 : 0;
2229 $total = $options['created'] ? 1 : 0;
2231 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2232 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2234 // If this is another user's talk page, update newtalk.
2235 // Don't do this if $options['changed'] = false (null-edits) nor if
2236 // it's a minor edit and the user doesn't want notifications for those.
2237 if ( $options['changed']
2238 && $this->mTitle->getNamespace() == NS_USER_TALK
2239 && $shortTitle != $user->getTitleKey()
2240 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2242 $recipient = User::newFromName( $shortTitle, false );
2243 if ( !$recipient ) {
2244 wfDebug( __METHOD__ . ": invalid username\n" );
2245 } else {
2246 // Allow extensions to prevent user notification when a new message is added to their talk page
2247 if ( Hooks::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2248 if ( User::isIP( $shortTitle ) ) {
2249 // An anonymous user
2250 $recipient->setNewtalk( true, $revision );
2251 } elseif ( $recipient->isLoggedIn() ) {
2252 $recipient->setNewtalk( true, $revision );
2253 } else {
2254 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2260 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2261 // XXX: could skip pseudo-messages like js/css here, based on content model.
2262 $msgtext = $content ? $content->getWikitextForTransclusion() : null;
2263 if ( $msgtext === false || $msgtext === null ) {
2264 $msgtext = '';
2267 MessageCache::singleton()->replace( $shortTitle, $msgtext );
2270 if ( $options['created'] ) {
2271 self::onArticleCreate( $this->mTitle );
2272 } elseif ( $options['changed'] ) { // bug 50785
2273 self::onArticleEdit( $this->mTitle );
2279 * Edit an article without doing all that other stuff
2280 * The article must already exist; link tables etc
2281 * are not updated, caches are not flushed.
2283 * @param string $text Text submitted
2284 * @param User $user The relevant user
2285 * @param string $comment Comment submitted
2286 * @param bool $minor Whereas it's a minor modification
2288 * @deprecated since 1.21, use doEditContent() instead.
2290 public function doQuickEdit( $text, User $user, $comment = '', $minor = 0 ) {
2291 ContentHandler::deprecated( __METHOD__, "1.21" );
2293 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2294 $this->doQuickEditContent( $content, $user, $comment, $minor );
2298 * Edit an article without doing all that other stuff
2299 * The article must already exist; link tables etc
2300 * are not updated, caches are not flushed.
2302 * @param Content $content Content submitted
2303 * @param User $user The relevant user
2304 * @param string $comment Comment submitted
2305 * @param bool $minor Whereas it's a minor modification
2306 * @param string $serialFormat Format for storing the content in the database
2308 public function doQuickEditContent( Content $content, User $user, $comment = '', $minor = false,
2309 $serialFormat = null
2312 $serialized = $content->serialize( $serialFormat );
2314 $dbw = wfGetDB( DB_MASTER );
2315 $revision = new Revision( array(
2316 'title' => $this->getTitle(), // for determining the default content model
2317 'page' => $this->getId(),
2318 'user_text' => $user->getName(),
2319 'user' => $user->getId(),
2320 'text' => $serialized,
2321 'length' => $content->getSize(),
2322 'comment' => $comment,
2323 'minor_edit' => $minor ? 1 : 0,
2324 ) ); // XXX: set the content object?
2325 $revision->insertOn( $dbw );
2326 $this->updateRevisionOn( $dbw, $revision );
2328 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2333 * Update the article's restriction field, and leave a log entry.
2334 * This works for protection both existing and non-existing pages.
2336 * @param array $limit Set of restriction keys
2337 * @param array $expiry Per restriction type expiration
2338 * @param int &$cascade Set to false if cascading protection isn't allowed.
2339 * @param string $reason
2340 * @param User $user The user updating the restrictions
2341 * @return Status
2343 public function doUpdateRestrictions( array $limit, array $expiry,
2344 &$cascade, $reason, User $user
2346 global $wgCascadingRestrictionLevels, $wgContLang;
2348 if ( wfReadOnly() ) {
2349 return Status::newFatal( 'readonlytext', wfReadOnlyReason() );
2352 $this->loadPageData( 'fromdbmaster' );
2353 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2354 $id = $this->getId();
2356 if ( !$cascade ) {
2357 $cascade = false;
2360 // Take this opportunity to purge out expired restrictions
2361 Title::purgeExpiredRestrictions();
2363 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2364 // we expect a single selection, but the schema allows otherwise.
2365 $isProtected = false;
2366 $protect = false;
2367 $changed = false;
2369 $dbw = wfGetDB( DB_MASTER );
2371 foreach ( $restrictionTypes as $action ) {
2372 if ( !isset( $expiry[$action] ) ) {
2373 $expiry[$action] = $dbw->getInfinity();
2375 if ( !isset( $limit[$action] ) ) {
2376 $limit[$action] = '';
2377 } elseif ( $limit[$action] != '' ) {
2378 $protect = true;
2381 // Get current restrictions on $action
2382 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2383 if ( $current != '' ) {
2384 $isProtected = true;
2387 if ( $limit[$action] != $current ) {
2388 $changed = true;
2389 } elseif ( $limit[$action] != '' ) {
2390 // Only check expiry change if the action is actually being
2391 // protected, since expiry does nothing on an not-protected
2392 // action.
2393 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2394 $changed = true;
2399 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2400 $changed = true;
2403 // If nothing has changed, do nothing
2404 if ( !$changed ) {
2405 return Status::newGood();
2408 if ( !$protect ) { // No protection at all means unprotection
2409 $revCommentMsg = 'unprotectedarticle';
2410 $logAction = 'unprotect';
2411 } elseif ( $isProtected ) {
2412 $revCommentMsg = 'modifiedarticleprotection';
2413 $logAction = 'modify';
2414 } else {
2415 $revCommentMsg = 'protectedarticle';
2416 $logAction = 'protect';
2419 // Truncate for whole multibyte characters
2420 $reason = $wgContLang->truncate( $reason, 255 );
2422 $logRelationsValues = array();
2423 $logRelationsField = null;
2425 if ( $id ) { // Protection of existing page
2426 if ( !Hooks::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2427 return Status::newGood();
2430 // Only certain restrictions can cascade...
2431 $editrestriction = isset( $limit['edit'] )
2432 ? array( $limit['edit'] )
2433 : $this->mTitle->getRestrictions( 'edit' );
2434 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2435 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2437 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2438 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2441 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2442 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2443 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2445 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2446 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2449 // The schema allows multiple restrictions
2450 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2451 $cascade = false;
2454 // insert null revision to identify the page protection change as edit summary
2455 $latest = $this->getLatest();
2456 $nullRevision = $this->insertProtectNullRevision(
2457 $revCommentMsg,
2458 $limit,
2459 $expiry,
2460 $cascade,
2461 $reason,
2462 $user
2465 if ( $nullRevision === null ) {
2466 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2469 $logRelationsField = 'pr_id';
2471 // Update restrictions table
2472 foreach ( $limit as $action => $restrictions ) {
2473 $dbw->delete(
2474 'page_restrictions',
2475 array(
2476 'pr_page' => $id,
2477 'pr_type' => $action
2479 __METHOD__
2481 if ( $restrictions != '' ) {
2482 $dbw->insert(
2483 'page_restrictions',
2484 array(
2485 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2486 'pr_page' => $id,
2487 'pr_type' => $action,
2488 'pr_level' => $restrictions,
2489 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
2490 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2492 __METHOD__
2494 $logRelationsValues[] = $dbw->insertId();
2498 // Clear out legacy restriction fields
2499 $dbw->update(
2500 'page',
2501 array( 'page_restrictions' => '' ),
2502 array( 'page_id' => $id ),
2503 __METHOD__
2506 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2507 Hooks::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2508 } else { // Protection of non-existing page (also known as "title protection")
2509 // Cascade protection is meaningless in this case
2510 $cascade = false;
2512 if ( $limit['create'] != '' ) {
2513 $dbw->replace( 'protected_titles',
2514 array( array( 'pt_namespace', 'pt_title' ) ),
2515 array(
2516 'pt_namespace' => $this->mTitle->getNamespace(),
2517 'pt_title' => $this->mTitle->getDBkey(),
2518 'pt_create_perm' => $limit['create'],
2519 'pt_timestamp' => $dbw->timestamp(),
2520 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2521 'pt_user' => $user->getId(),
2522 'pt_reason' => $reason,
2523 ), __METHOD__
2525 } else {
2526 $dbw->delete( 'protected_titles',
2527 array(
2528 'pt_namespace' => $this->mTitle->getNamespace(),
2529 'pt_title' => $this->mTitle->getDBkey()
2530 ), __METHOD__
2535 $this->mTitle->flushRestrictions();
2536 InfoAction::invalidateCache( $this->mTitle );
2538 if ( $logAction == 'unprotect' ) {
2539 $params = array();
2540 } else {
2541 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2542 $params = array( $protectDescriptionLog, $cascade ? 'cascade' : '' );
2545 // Update the protection log
2546 $log = new LogPage( 'protect' );
2547 $logId = $log->addEntry( $logAction, $this->mTitle, $reason, $params, $user );
2548 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2549 $log->addRelations( $logRelationsField, $logRelationsValues, $logId );
2552 return Status::newGood();
2556 * Insert a new null revision for this page.
2558 * @param string $revCommentMsg Comment message key for the revision
2559 * @param array $limit Set of restriction keys
2560 * @param array $expiry Per restriction type expiration
2561 * @param int $cascade Set to false if cascading protection isn't allowed.
2562 * @param string $reason
2563 * @param User|null $user
2564 * @return Revision|null Null on error
2566 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2567 array $expiry, $cascade, $reason, $user = null
2569 global $wgContLang;
2570 $dbw = wfGetDB( DB_MASTER );
2572 // Prepare a null revision to be added to the history
2573 $editComment = $wgContLang->ucfirst(
2574 wfMessage(
2575 $revCommentMsg,
2576 $this->mTitle->getPrefixedText()
2577 )->inContentLanguage()->text()
2579 if ( $reason ) {
2580 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2582 $protectDescription = $this->protectDescription( $limit, $expiry );
2583 if ( $protectDescription ) {
2584 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2585 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2586 ->inContentLanguage()->text();
2588 if ( $cascade ) {
2589 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2590 $editComment .= wfMessage( 'brackets' )->params(
2591 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2592 )->inContentLanguage()->text();
2595 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2596 if ( $nullRev ) {
2597 $nullRev->insertOn( $dbw );
2599 // Update page record and touch page
2600 $oldLatest = $nullRev->getParentId();
2601 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2604 return $nullRev;
2608 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2609 * @return string
2611 protected function formatExpiry( $expiry ) {
2612 global $wgContLang;
2613 $dbr = wfGetDB( DB_SLAVE );
2615 $encodedExpiry = $dbr->encodeExpiry( $expiry );
2616 if ( $encodedExpiry != 'infinity' ) {
2617 return wfMessage(
2618 'protect-expiring',
2619 $wgContLang->timeanddate( $expiry, false, false ),
2620 $wgContLang->date( $expiry, false, false ),
2621 $wgContLang->time( $expiry, false, false )
2622 )->inContentLanguage()->text();
2623 } else {
2624 return wfMessage( 'protect-expiry-indefinite' )
2625 ->inContentLanguage()->text();
2630 * Builds the description to serve as comment for the edit.
2632 * @param array $limit Set of restriction keys
2633 * @param array $expiry Per restriction type expiration
2634 * @return string
2636 public function protectDescription( array $limit, array $expiry ) {
2637 $protectDescription = '';
2639 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2640 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2641 # All possible message keys are listed here for easier grepping:
2642 # * restriction-create
2643 # * restriction-edit
2644 # * restriction-move
2645 # * restriction-upload
2646 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2647 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2648 # with '' filtered out. All possible message keys are listed below:
2649 # * protect-level-autoconfirmed
2650 # * protect-level-sysop
2651 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2653 $expiryText = $this->formatExpiry( $expiry[$action] );
2655 if ( $protectDescription !== '' ) {
2656 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2658 $protectDescription .= wfMessage( 'protect-summary-desc' )
2659 ->params( $actionText, $restrictionsText, $expiryText )
2660 ->inContentLanguage()->text();
2663 return $protectDescription;
2667 * Builds the description to serve as comment for the log entry.
2669 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2670 * protect description text. Keep them in old format to avoid breaking compatibility.
2671 * TODO: Fix protection log to store structured description and format it on-the-fly.
2673 * @param array $limit Set of restriction keys
2674 * @param array $expiry Per restriction type expiration
2675 * @return string
2677 public function protectDescriptionLog( array $limit, array $expiry ) {
2678 global $wgContLang;
2680 $protectDescriptionLog = '';
2682 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2683 $expiryText = $this->formatExpiry( $expiry[$action] );
2684 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] ($expiryText)";
2687 return trim( $protectDescriptionLog );
2691 * Take an array of page restrictions and flatten it to a string
2692 * suitable for insertion into the page_restrictions field.
2694 * @param string[] $limit
2696 * @throws MWException
2697 * @return string
2699 protected static function flattenRestrictions( $limit ) {
2700 if ( !is_array( $limit ) ) {
2701 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2704 $bits = array();
2705 ksort( $limit );
2707 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2708 $bits[] = "$action=$restrictions";
2711 return implode( ':', $bits );
2715 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2716 * backwards compatibility, if you care about error reporting you should use
2717 * doDeleteArticleReal() instead.
2719 * Deletes the article with database consistency, writes logs, purges caches
2721 * @param string $reason Delete reason for deletion log
2722 * @param bool $suppress Suppress all revisions and log the deletion in
2723 * the suppression log instead of the deletion log
2724 * @param int $id Article ID
2725 * @param bool $commit Defaults to true, triggers transaction end
2726 * @param array &$error Array of errors to append to
2727 * @param User $user The deleting user
2728 * @return bool True if successful
2730 public function doDeleteArticle(
2731 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2733 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2734 return $status->isGood();
2738 * Back-end article deletion
2739 * Deletes the article with database consistency, writes logs, purges caches
2741 * @since 1.19
2743 * @param string $reason Delete reason for deletion log
2744 * @param bool $suppress Suppress all revisions and log the deletion in
2745 * the suppression log instead of the deletion log
2746 * @param int $id Article ID
2747 * @param bool $commit Defaults to true, triggers transaction end
2748 * @param array &$error Array of errors to append to
2749 * @param User $user The deleting user
2750 * @return Status Status object; if successful, $status->value is the log_id of the
2751 * deletion log entry. If the page couldn't be deleted because it wasn't
2752 * found, $status is a non-fatal 'cannotdelete' error
2754 public function doDeleteArticleReal(
2755 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2757 global $wgUser, $wgContentHandlerUseDB;
2759 wfDebug( __METHOD__ . "\n" );
2761 $status = Status::newGood();
2763 if ( $this->mTitle->getDBkey() === '' ) {
2764 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2765 return $status;
2768 $user = is_null( $user ) ? $wgUser : $user;
2769 if ( !Hooks::run( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2770 if ( $status->isOK() ) {
2771 // Hook aborted but didn't set a fatal status
2772 $status->fatal( 'delete-hook-aborted' );
2774 return $status;
2777 $dbw = wfGetDB( DB_MASTER );
2778 $dbw->begin( __METHOD__ );
2780 if ( $id == 0 ) {
2781 $this->loadPageData( 'forupdate' );
2782 $id = $this->getID();
2783 if ( $id == 0 ) {
2784 $dbw->rollback( __METHOD__ );
2785 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2786 return $status;
2790 // we need to remember the old content so we can use it to generate all deletion updates.
2791 $content = $this->getContent( Revision::RAW );
2793 // Bitfields to further suppress the content
2794 if ( $suppress ) {
2795 $bitfield = 0;
2796 // This should be 15...
2797 $bitfield |= Revision::DELETED_TEXT;
2798 $bitfield |= Revision::DELETED_COMMENT;
2799 $bitfield |= Revision::DELETED_USER;
2800 $bitfield |= Revision::DELETED_RESTRICTED;
2801 } else {
2802 $bitfield = 'rev_deleted';
2805 // For now, shunt the revision data into the archive table.
2806 // Text is *not* removed from the text table; bulk storage
2807 // is left intact to avoid breaking block-compression or
2808 // immutable storage schemes.
2810 // For backwards compatibility, note that some older archive
2811 // table entries will have ar_text and ar_flags fields still.
2813 // In the future, we may keep revisions and mark them with
2814 // the rev_deleted field, which is reserved for this purpose.
2816 $row = array(
2817 'ar_namespace' => 'page_namespace',
2818 'ar_title' => 'page_title',
2819 'ar_comment' => 'rev_comment',
2820 'ar_user' => 'rev_user',
2821 'ar_user_text' => 'rev_user_text',
2822 'ar_timestamp' => 'rev_timestamp',
2823 'ar_minor_edit' => 'rev_minor_edit',
2824 'ar_rev_id' => 'rev_id',
2825 'ar_parent_id' => 'rev_parent_id',
2826 'ar_text_id' => 'rev_text_id',
2827 'ar_text' => '\'\'', // Be explicit to appease
2828 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2829 'ar_len' => 'rev_len',
2830 'ar_page_id' => 'page_id',
2831 'ar_deleted' => $bitfield,
2832 'ar_sha1' => 'rev_sha1',
2835 if ( $wgContentHandlerUseDB ) {
2836 $row['ar_content_model'] = 'rev_content_model';
2837 $row['ar_content_format'] = 'rev_content_format';
2840 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2841 $row,
2842 array(
2843 'page_id' => $id,
2844 'page_id = rev_page'
2845 ), __METHOD__
2848 // Now that it's safely backed up, delete it
2849 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
2850 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2852 if ( !$ok ) {
2853 $dbw->rollback( __METHOD__ );
2854 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2855 return $status;
2858 if ( !$dbw->cascadingDeletes() ) {
2859 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
2862 // Clone the title, so we have the information we need when we log
2863 $logTitle = clone $this->mTitle;
2865 // Log the deletion, if the page was suppressed, log it at Oversight instead
2866 $logtype = $suppress ? 'suppress' : 'delete';
2868 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2869 $logEntry->setPerformer( $user );
2870 $logEntry->setTarget( $logTitle );
2871 $logEntry->setComment( $reason );
2872 $logid = $logEntry->insert();
2874 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2875 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2876 $logEntry->publish( $logid );
2877 } );
2879 if ( $commit ) {
2880 $dbw->commit( __METHOD__ );
2883 $this->doDeleteUpdates( $id, $content );
2885 Hooks::run( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2886 $status->value = $logid;
2887 return $status;
2891 * Do some database updates after deletion
2893 * @param int $id The page_id value of the page being deleted
2894 * @param Content $content Optional page content to be used when determining
2895 * the required updates. This may be needed because $this->getContent()
2896 * may already return null when the page proper was deleted.
2898 public function doDeleteUpdates( $id, Content $content = null ) {
2899 // update site status
2900 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2902 // remove secondary indexes, etc
2903 $updates = $this->getDeletionUpdates( $content );
2904 DataUpdate::runUpdates( $updates );
2906 // Reparse any pages transcluding this page
2907 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
2909 // Reparse any pages including this image
2910 if ( $this->mTitle->getNamespace() == NS_FILE ) {
2911 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
2914 // Clear caches
2915 WikiPage::onArticleDelete( $this->mTitle );
2917 // Reset this object and the Title object
2918 $this->loadFromRow( false, self::READ_LATEST );
2920 // Search engine
2921 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
2925 * Roll back the most recent consecutive set of edits to a page
2926 * from the same user; fails if there are no eligible edits to
2927 * roll back to, e.g. user is the sole contributor. This function
2928 * performs permissions checks on $user, then calls commitRollback()
2929 * to do the dirty work
2931 * @todo Separate the business/permission stuff out from backend code
2933 * @param string $fromP Name of the user whose edits to rollback.
2934 * @param string $summary Custom summary. Set to default summary if empty.
2935 * @param string $token Rollback token.
2936 * @param bool $bot If true, mark all reverted edits as bot.
2938 * @param array $resultDetails Array contains result-specific array of additional values
2939 * 'alreadyrolled' : 'current' (rev)
2940 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2942 * @param User $user The user performing the rollback
2943 * @return array Array of errors, each error formatted as
2944 * array(messagekey, param1, param2, ...).
2945 * On success, the array is empty. This array can also be passed to
2946 * OutputPage::showPermissionsErrorPage().
2948 public function doRollback(
2949 $fromP, $summary, $token, $bot, &$resultDetails, User $user
2951 $resultDetails = null;
2953 // Check permissions
2954 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
2955 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
2956 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2958 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
2959 $errors[] = array( 'sessionfailure' );
2962 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
2963 $errors[] = array( 'actionthrottledtext' );
2966 // If there were errors, bail out now
2967 if ( !empty( $errors ) ) {
2968 return $errors;
2971 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2975 * Backend implementation of doRollback(), please refer there for parameter
2976 * and return value documentation
2978 * NOTE: This function does NOT check ANY permissions, it just commits the
2979 * rollback to the DB. Therefore, you should only call this function direct-
2980 * ly if you want to use custom permissions checks. If you don't, use
2981 * doRollback() instead.
2982 * @param string $fromP Name of the user whose edits to rollback.
2983 * @param string $summary Custom summary. Set to default summary if empty.
2984 * @param bool $bot If true, mark all reverted edits as bot.
2986 * @param array $resultDetails Contains result-specific array of additional values
2987 * @param User $guser The user performing the rollback
2988 * @return array
2990 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
2991 global $wgUseRCPatrol, $wgContLang;
2993 $dbw = wfGetDB( DB_MASTER );
2995 if ( wfReadOnly() ) {
2996 return array( array( 'readonlytext' ) );
2999 // Get the last editor
3000 $current = $this->getRevision();
3001 if ( is_null( $current ) ) {
3002 // Something wrong... no page?
3003 return array( array( 'notanarticle' ) );
3006 $from = str_replace( '_', ' ', $fromP );
3007 // User name given should match up with the top revision.
3008 // If the user was deleted then $from should be empty.
3009 if ( $from != $current->getUserText() ) {
3010 $resultDetails = array( 'current' => $current );
3011 return array( array( 'alreadyrolled',
3012 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3013 htmlspecialchars( $fromP ),
3014 htmlspecialchars( $current->getUserText() )
3015 ) );
3018 // Get the last edit not by this guy...
3019 // Note: these may not be public values
3020 $user = intval( $current->getUser( Revision::RAW ) );
3021 $user_text = $dbw->addQuotes( $current->getUserText( Revision::RAW ) );
3022 $s = $dbw->selectRow( 'revision',
3023 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3024 array( 'rev_page' => $current->getPage(),
3025 "rev_user != {$user} OR rev_user_text != {$user_text}"
3026 ), __METHOD__,
3027 array( 'USE INDEX' => 'page_timestamp',
3028 'ORDER BY' => 'rev_timestamp DESC' )
3030 if ( $s === false ) {
3031 // No one else ever edited this page
3032 return array( array( 'cantrollback' ) );
3033 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT
3034 || $s->rev_deleted & Revision::DELETED_USER
3036 // Only admins can see this text
3037 return array( array( 'notvisiblerev' ) );
3040 // Set patrolling and bot flag on the edits, which gets rollbacked.
3041 // This is done before the rollback edit to have patrolling also on failure (bug 62157).
3042 $set = array();
3043 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3044 // Mark all reverted edits as bot
3045 $set['rc_bot'] = 1;
3048 if ( $wgUseRCPatrol ) {
3049 // Mark all reverted edits as patrolled
3050 $set['rc_patrolled'] = 1;
3053 if ( count( $set ) ) {
3054 $dbw->update( 'recentchanges', $set,
3055 array( /* WHERE */
3056 'rc_cur_id' => $current->getPage(),
3057 'rc_user_text' => $current->getUserText(),
3058 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3059 ), __METHOD__
3063 // Generate the edit summary if necessary
3064 $target = Revision::newFromId( $s->rev_id );
3065 if ( empty( $summary ) ) {
3066 if ( $from == '' ) { // no public user name
3067 $summary = wfMessage( 'revertpage-nouser' );
3068 } else {
3069 $summary = wfMessage( 'revertpage' );
3073 // Allow the custom summary to use the same args as the default message
3074 $args = array(
3075 $target->getUserText(), $from, $s->rev_id,
3076 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3077 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3079 if ( $summary instanceof Message ) {
3080 $summary = $summary->params( $args )->inContentLanguage()->text();
3081 } else {
3082 $summary = wfMsgReplaceArgs( $summary, $args );
3085 // Trim spaces on user supplied text
3086 $summary = trim( $summary );
3088 // Truncate for whole multibyte characters.
3089 $summary = $wgContLang->truncate( $summary, 255 );
3091 // Save
3092 $flags = EDIT_UPDATE;
3094 if ( $guser->isAllowed( 'minoredit' ) ) {
3095 $flags |= EDIT_MINOR;
3098 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3099 $flags |= EDIT_FORCE_BOT;
3102 // Actually store the edit
3103 $status = $this->doEditContent(
3104 $target->getContent(),
3105 $summary,
3106 $flags,
3107 $target->getId(),
3108 $guser
3111 if ( !$status->isOK() ) {
3112 return $status->getErrorsArray();
3115 // raise error, when the edit is an edit without a new version
3116 if ( empty( $status->value['revision'] ) ) {
3117 $resultDetails = array( 'current' => $current );
3118 return array( array( 'alreadyrolled',
3119 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3120 htmlspecialchars( $fromP ),
3121 htmlspecialchars( $current->getUserText() )
3122 ) );
3125 $revId = $status->value['revision']->getId();
3127 Hooks::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3129 $resultDetails = array(
3130 'summary' => $summary,
3131 'current' => $current,
3132 'target' => $target,
3133 'newid' => $revId
3136 return array();
3140 * The onArticle*() functions are supposed to be a kind of hooks
3141 * which should be called whenever any of the specified actions
3142 * are done.
3144 * This is a good place to put code to clear caches, for instance.
3146 * This is called on page move and undelete, as well as edit
3148 * @param Title $title
3150 public static function onArticleCreate( Title $title ) {
3151 // Update existence markers on article/talk tabs...
3152 $other = $title->getOtherPage();
3154 $other->invalidateCache();
3155 $other->purgeSquid();
3157 $title->touchLinks();
3158 $title->purgeSquid();
3159 $title->deleteTitleProtection();
3163 * Clears caches when article is deleted
3165 * @param Title $title
3167 public static function onArticleDelete( Title $title ) {
3168 // Update existence markers on article/talk tabs...
3169 $other = $title->getOtherPage();
3171 $other->invalidateCache();
3172 $other->purgeSquid();
3174 $title->touchLinks();
3175 $title->purgeSquid();
3177 // File cache
3178 HTMLFileCache::clearFileCache( $title );
3179 InfoAction::invalidateCache( $title );
3181 // Messages
3182 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3183 MessageCache::singleton()->replace( $title->getDBkey(), false );
3186 // Images
3187 if ( $title->getNamespace() == NS_FILE ) {
3188 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3189 $update->doUpdate();
3192 // User talk pages
3193 if ( $title->getNamespace() == NS_USER_TALK ) {
3194 $user = User::newFromName( $title->getText(), false );
3195 if ( $user ) {
3196 $user->setNewtalk( false );
3200 // Image redirects
3201 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3205 * Purge caches on page update etc
3207 * @param Title $title
3209 public static function onArticleEdit( Title $title ) {
3210 // Invalidate caches of articles which include this page
3211 DeferredUpdates::addHTMLCacheUpdate( $title, 'templatelinks' );
3213 // Invalidate the caches of all pages which redirect here
3214 DeferredUpdates::addHTMLCacheUpdate( $title, 'redirect' );
3216 // Purge squid for this page only
3217 $title->purgeSquid();
3219 // Clear file cache for this page only
3220 HTMLFileCache::clearFileCache( $title );
3221 InfoAction::invalidateCache( $title );
3224 /**#@-*/
3227 * Returns a list of categories this page is a member of.
3228 * Results will include hidden categories
3230 * @return TitleArray
3232 public function getCategories() {
3233 $id = $this->getId();
3234 if ( $id == 0 ) {
3235 return TitleArray::newFromResult( new FakeResultWrapper( array() ) );
3238 $dbr = wfGetDB( DB_SLAVE );
3239 $res = $dbr->select( 'categorylinks',
3240 array( 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ),
3241 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3242 // as not being aliases, and NS_CATEGORY is numeric
3243 array( 'cl_from' => $id ),
3244 __METHOD__ );
3246 return TitleArray::newFromResult( $res );
3250 * Returns a list of hidden categories this page is a member of.
3251 * Uses the page_props and categorylinks tables.
3253 * @return array Array of Title objects
3255 public function getHiddenCategories() {
3256 $result = array();
3257 $id = $this->getId();
3259 if ( $id == 0 ) {
3260 return array();
3263 $dbr = wfGetDB( DB_SLAVE );
3264 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3265 array( 'cl_to' ),
3266 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3267 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
3268 __METHOD__ );
3270 if ( $res !== false ) {
3271 foreach ( $res as $row ) {
3272 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3276 return $result;
3280 * Return an applicable autosummary if one exists for the given edit.
3281 * @param string|null $oldtext The previous text of the page.
3282 * @param string|null $newtext The submitted text of the page.
3283 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3284 * @return string An appropriate autosummary, or an empty string.
3286 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3288 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3289 // NOTE: stub for backwards-compatibility. assumes the given text is
3290 // wikitext. will break horribly if it isn't.
3292 ContentHandler::deprecated( __METHOD__, '1.21' );
3294 $handler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT );
3295 $oldContent = is_null( $oldtext ) ? null : $handler->unserializeContent( $oldtext );
3296 $newContent = is_null( $newtext ) ? null : $handler->unserializeContent( $newtext );
3298 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3302 * Auto-generates a deletion reason
3304 * @param bool &$hasHistory Whether the page has a history
3305 * @return string|bool String containing deletion reason or empty string, or boolean false
3306 * if no revision occurred
3308 public function getAutoDeleteReason( &$hasHistory ) {
3309 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3313 * Update all the appropriate counts in the category table, given that
3314 * we've added the categories $added and deleted the categories $deleted.
3316 * @param array $added The names of categories that were added
3317 * @param array $deleted The names of categories that were deleted
3319 public function updateCategoryCounts( array $added, array $deleted ) {
3320 $that = $this;
3321 $method = __METHOD__;
3322 $dbw = wfGetDB( DB_MASTER );
3324 // Do this at the end of the commit to reduce lock wait timeouts
3325 $dbw->onTransactionPreCommitOrIdle(
3326 function () use ( $dbw, $that, $method, $added, $deleted ) {
3327 $ns = $that->getTitle()->getNamespace();
3329 $addFields = array( 'cat_pages = cat_pages + 1' );
3330 $removeFields = array( 'cat_pages = cat_pages - 1' );
3331 if ( $ns == NS_CATEGORY ) {
3332 $addFields[] = 'cat_subcats = cat_subcats + 1';
3333 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3334 } elseif ( $ns == NS_FILE ) {
3335 $addFields[] = 'cat_files = cat_files + 1';
3336 $removeFields[] = 'cat_files = cat_files - 1';
3339 if ( count( $added ) ) {
3340 $insertRows = array();
3341 foreach ( $added as $cat ) {
3342 $insertRows[] = array(
3343 'cat_title' => $cat,
3344 'cat_pages' => 1,
3345 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3346 'cat_files' => ( $ns == NS_FILE ) ? 1 : 0,
3349 $dbw->upsert(
3350 'category',
3351 $insertRows,
3352 array( 'cat_title' ),
3353 $addFields,
3354 $method
3358 if ( count( $deleted ) ) {
3359 $dbw->update(
3360 'category',
3361 $removeFields,
3362 array( 'cat_title' => $deleted ),
3363 $method
3367 foreach ( $added as $catName ) {
3368 $cat = Category::newFromName( $catName );
3369 Hooks::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3372 foreach ( $deleted as $catName ) {
3373 $cat = Category::newFromName( $catName );
3374 Hooks::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3381 * Opportunistically enqueue link update jobs given fresh parser output if useful
3383 * @param ParserOutput $parserOutput Current version page output
3384 * @return bool Whether a job was pushed
3385 * @since 1.25
3387 public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
3388 if ( wfReadOnly() ) {
3389 return false;
3392 if ( $this->mTitle->areRestrictionsCascading() ) {
3393 // If the page is cascade protecting, the links should really be up-to-date
3394 $params = array( 'prioritize' => true );
3395 } elseif ( $parserOutput->hasDynamicContent() ) {
3396 // Assume the output contains time/random based magic words
3397 $params = array();
3398 } else {
3399 // If the inclusions are deterministic, the edit-triggered link jobs are enough
3400 return false;
3403 // Check if the last link refresh was before page_touched
3404 if ( $this->getLinksTimestamp() < $this->getTouched() ) {
3405 JobQueueGroup::singleton()->push( new RefreshLinksJob( $this->mTitle, $params ) );
3406 return true;
3409 return false;
3413 * Return a list of templates used by this article.
3414 * Uses the templatelinks table
3416 * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3417 * @return array Array of Title objects
3419 public function getUsedTemplates() {
3420 return $this->mTitle->getTemplateLinksFrom();
3424 * This function is called right before saving the wikitext,
3425 * so we can do things like signatures and links-in-context.
3427 * @deprecated since 1.19; use Parser::preSaveTransform() instead
3428 * @param string $text Article contents
3429 * @param User $user User doing the edit
3430 * @param ParserOptions $popts Parser options, default options for
3431 * the user loaded if null given
3432 * @return string Article contents with altered wikitext markup (signatures
3433 * converted, {{subst:}}, templates, etc.)
3435 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
3436 global $wgParser, $wgUser;
3438 wfDeprecated( __METHOD__, '1.19' );
3440 $user = is_null( $user ) ? $wgUser : $user;
3442 if ( $popts === null ) {
3443 $popts = ParserOptions::newFromUser( $user );
3446 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
3450 * Update the article's restriction field, and leave a log entry.
3452 * @deprecated since 1.19
3453 * @param array $limit Set of restriction keys
3454 * @param string $reason
3455 * @param int &$cascade Set to false if cascading protection isn't allowed.
3456 * @param array $expiry Per restriction type expiration
3457 * @param User $user The user updating the restrictions
3458 * @return bool True on success
3460 public function updateRestrictions(
3461 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
3463 global $wgUser;
3465 $user = is_null( $user ) ? $wgUser : $user;
3467 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3471 * Returns a list of updates to be performed when this page is deleted. The
3472 * updates should remove any information about this page from secondary data
3473 * stores such as links tables.
3475 * @param Content|null $content Optional Content object for determining the
3476 * necessary updates.
3477 * @return array An array of DataUpdates objects
3479 public function getDeletionUpdates( Content $content = null ) {
3480 if ( !$content ) {
3481 // load content object, which may be used to determine the necessary updates
3482 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3483 $content = $this->getContent( Revision::RAW );
3486 if ( !$content ) {
3487 $updates = array();
3488 } else {
3489 $updates = $content->getDeletionUpdates( $this );
3492 Hooks::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );
3493 return $updates;