Merge "Typo fix"
[mediawiki.git] / includes / WikiPage.php
blob9d61abc75429e74cd4792e15c7b5472a7c6b1ae4
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 {}
28 /**
29 * Class representing a MediaWiki article and history.
31 * Some fields are public only for backwards-compatibility. Use accessors.
32 * In the past, this class was part of Article.php and everything was public.
34 * @internal documentation reviewed 15 Mar 2010
36 class WikiPage implements Page, IDBAccessObject {
37 // Constants for $mDataLoadedFrom and related
39 /**
40 * @var Title
42 public $mTitle = null;
44 /**@{{
45 * @protected
47 public $mDataLoaded = false; // !< Boolean
48 public $mIsRedirect = false; // !< Boolean
49 public $mLatest = false; // !< Integer (false means "not loaded")
50 public $mPreparedEdit = false; // !< Array
51 /**@}}*/
53 /**
54 * @var int
56 protected $mId = null;
58 /**
59 * @var int; one of the READ_* constants
61 protected $mDataLoadedFrom = self::READ_NONE;
63 /**
64 * @var Title
66 protected $mRedirectTarget = null;
68 /**
69 * @var Revision
71 protected $mLastRevision = null;
73 /**
74 * @var string; timestamp of the current revision or empty string if not loaded
76 protected $mTimestamp = '';
78 /**
79 * @var string
81 protected $mTouched = '19700101000000';
83 /**
84 * @var int|null
86 protected $mCounter = null;
88 /**
89 * Constructor and clear the article
90 * @param $title Title Reference to a Title object.
92 public function __construct( Title $title ) {
93 $this->mTitle = $title;
96 /**
97 * Create a WikiPage object of the appropriate class for the given title.
99 * @param $title Title
100 * @throws MWException
101 * @return WikiPage object of the appropriate type
103 public static function factory( Title $title ) {
104 $ns = $title->getNamespace();
106 if ( $ns == NS_MEDIA ) {
107 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
108 } elseif ( $ns < 0 ) {
109 throw new MWException( "Invalid or virtual namespace $ns given." );
112 switch ( $ns ) {
113 case NS_FILE:
114 $page = new WikiFilePage( $title );
115 break;
116 case NS_CATEGORY:
117 $page = new WikiCategoryPage( $title );
118 break;
119 default:
120 $page = new WikiPage( $title );
123 return $page;
127 * Constructor from a page id
129 * @param int $id article ID to load
130 * @param string|int $from one of the following values:
131 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
132 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
134 * @return WikiPage|null
136 public static function newFromID( $id, $from = 'fromdb' ) {
137 $from = self::convertSelectType( $from );
138 $db = wfGetDB( $from === self::READ_LATEST ? DB_MASTER : DB_SLAVE );
139 $row = $db->selectRow( 'page', self::selectFields(), array( 'page_id' => $id ), __METHOD__ );
140 if ( !$row ) {
141 return null;
143 return self::newFromRow( $row, $from );
147 * Constructor from a database row
149 * @since 1.20
150 * @param $row object: database row containing at least fields returned
151 * by selectFields().
152 * @param string|int $from source of $data:
153 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
154 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
155 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
156 * @return WikiPage
158 public static function newFromRow( $row, $from = 'fromdb' ) {
159 $page = self::factory( Title::newFromRow( $row ) );
160 $page->loadFromRow( $row, $from );
161 return $page;
165 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
167 * @param $type object|string|int
168 * @return mixed
170 private static function convertSelectType( $type ) {
171 switch ( $type ) {
172 case 'fromdb':
173 return self::READ_NORMAL;
174 case 'fromdbmaster':
175 return self::READ_LATEST;
176 case 'forupdate':
177 return self::READ_LOCKING;
178 default:
179 // It may already be an integer or whatever else
180 return $type;
185 * Returns overrides for action handlers.
186 * Classes listed here will be used instead of the default one when
187 * (and only when) $wgActions[$action] === true. This allows subclasses
188 * to override the default behavior.
190 * @todo Move this UI stuff somewhere else
192 * @return Array
194 public function getActionOverrides() {
195 $content_handler = $this->getContentHandler();
196 return $content_handler->getActionOverrides();
200 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
202 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
204 * @return ContentHandler
206 * @since 1.21
208 public function getContentHandler() {
209 return ContentHandler::getForModelID( $this->getContentModel() );
213 * Get the title object of the article
214 * @return Title object of this page
216 public function getTitle() {
217 return $this->mTitle;
221 * Clear the object
222 * @return void
224 public function clear() {
225 $this->mDataLoaded = false;
226 $this->mDataLoadedFrom = self::READ_NONE;
228 $this->clearCacheFields();
232 * Clear the object cache fields
233 * @return void
235 protected function clearCacheFields() {
236 $this->mId = null;
237 $this->mCounter = null;
238 $this->mRedirectTarget = null; // Title object if set
239 $this->mLastRevision = null; // Latest revision
240 $this->mTouched = '19700101000000';
241 $this->mTimestamp = '';
242 $this->mIsRedirect = false;
243 $this->mLatest = false;
244 $this->mPreparedEdit = false;
248 * Return the list of revision fields that should be selected to create
249 * a new page.
251 * @return array
253 public static function selectFields() {
254 global $wgContentHandlerUseDB;
256 $fields = array(
257 'page_id',
258 'page_namespace',
259 'page_title',
260 'page_restrictions',
261 'page_counter',
262 'page_is_redirect',
263 'page_is_new',
264 'page_random',
265 'page_touched',
266 'page_latest',
267 'page_len',
270 if ( $wgContentHandlerUseDB ) {
271 $fields[] = 'page_content_model';
274 return $fields;
278 * Fetch a page record with the given conditions
279 * @param $dbr DatabaseBase object
280 * @param $conditions Array
281 * @param $options Array
282 * @return mixed Database result resource, or false on failure
284 protected function pageData( $dbr, $conditions, $options = array() ) {
285 $fields = self::selectFields();
287 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
289 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__, $options );
291 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
293 return $row;
297 * Fetch a page record matching the Title object's namespace and title
298 * using a sanitized title string
300 * @param $dbr DatabaseBase object
301 * @param $title Title object
302 * @param $options Array
303 * @return mixed Database result resource, or false on failure
305 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
306 return $this->pageData( $dbr, array(
307 'page_namespace' => $title->getNamespace(),
308 'page_title' => $title->getDBkey() ), $options );
312 * Fetch a page record matching the requested ID
314 * @param $dbr DatabaseBase
315 * @param $id Integer
316 * @param $options Array
317 * @return mixed Database result resource, or false on failure
319 public function pageDataFromId( $dbr, $id, $options = array() ) {
320 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
324 * Set the general counter, title etc data loaded from
325 * some source.
327 * @param $from object|string|int One of the following:
328 * - A DB query result object
329 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB
330 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB
331 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB using SELECT FOR UPDATE
333 * @return void
335 public function loadPageData( $from = 'fromdb' ) {
336 $from = self::convertSelectType( $from );
337 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
338 // We already have the data from the correct location, no need to load it twice.
339 return;
342 if ( $from === self::READ_LOCKING ) {
343 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle, array( 'FOR UPDATE' ) );
344 } elseif ( $from === self::READ_LATEST ) {
345 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
346 } elseif ( $from === self::READ_NORMAL ) {
347 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE ), $this->mTitle );
348 // Use a "last rev inserted" timestamp key to diminish the issue of slave lag.
349 // Note that DB also stores the master position in the session and checks it.
350 $touched = $this->getCachedLastEditTime();
351 if ( $touched ) { // key set
352 if ( !$data || $touched > wfTimestamp( TS_MW, $data->page_touched ) ) {
353 $from = self::READ_LATEST;
354 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
357 } else {
358 // No idea from where the caller got this data, assume slave database.
359 $data = $from;
360 $from = self::READ_NORMAL;
363 $this->loadFromRow( $data, $from );
367 * Load the object from a database row
369 * @since 1.20
370 * @param $data object: database row containing at least fields returned
371 * by selectFields()
372 * @param string|int $from One of the following:
373 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
374 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
375 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from from
376 * the master DB using SELECT FOR UPDATE
378 public function loadFromRow( $data, $from ) {
379 $lc = LinkCache::singleton();
380 $lc->clearLink( $this->mTitle );
382 if ( $data ) {
383 $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
385 $this->mTitle->loadFromRow( $data );
387 // Old-fashioned restrictions
388 $this->mTitle->loadRestrictions( $data->page_restrictions );
390 $this->mId = intval( $data->page_id );
391 $this->mCounter = intval( $data->page_counter );
392 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
393 $this->mIsRedirect = intval( $data->page_is_redirect );
394 $this->mLatest = intval( $data->page_latest );
395 // Bug 37225: $latest may no longer match the cached latest Revision object.
396 // Double-check the ID of any cached latest Revision object for consistency.
397 if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
398 $this->mLastRevision = null;
399 $this->mTimestamp = '';
401 } else {
402 $lc->addBadLinkObj( $this->mTitle );
404 $this->mTitle->loadFromRow( false );
406 $this->clearCacheFields();
408 $this->mId = 0;
411 $this->mDataLoaded = true;
412 $this->mDataLoadedFrom = self::convertSelectType( $from );
416 * @return int Page ID
418 public function getId() {
419 if ( !$this->mDataLoaded ) {
420 $this->loadPageData();
422 return $this->mId;
426 * @return bool Whether or not the page exists in the database
428 public function exists() {
429 if ( !$this->mDataLoaded ) {
430 $this->loadPageData();
432 return $this->mId > 0;
436 * Check if this page is something we're going to be showing
437 * some sort of sensible content for. If we return false, page
438 * views (plain action=view) will return an HTTP 404 response,
439 * so spiders and robots can know they're following a bad link.
441 * @return bool
443 public function hasViewableContent() {
444 return $this->exists() || $this->mTitle->isAlwaysKnown();
448 * @return int The view count for the page
450 public function getCount() {
451 if ( !$this->mDataLoaded ) {
452 $this->loadPageData();
455 return $this->mCounter;
459 * Tests if the article content represents a redirect
461 * @return bool
463 public function isRedirect() {
464 $content = $this->getContent();
465 if ( !$content ) {
466 return false;
469 return $content->isRedirect();
473 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
475 * Will use the revisions actual content model if the page exists,
476 * and the page's default if the page doesn't exist yet.
478 * @return String
480 * @since 1.21
482 public function getContentModel() {
483 if ( $this->exists() ) {
484 // look at the revision's actual content model
485 $rev = $this->getRevision();
487 if ( $rev !== null ) {
488 return $rev->getContentModel();
489 } else {
490 $title = $this->mTitle->getPrefixedDBkey();
491 wfWarn( "Page $title exists but has no (visible) revisions!" );
495 // use the default model for this page
496 return $this->mTitle->getContentModel();
500 * Loads page_touched and returns a value indicating if it should be used
501 * @return boolean true if not a redirect
503 public function checkTouched() {
504 if ( !$this->mDataLoaded ) {
505 $this->loadPageData();
507 return !$this->mIsRedirect;
511 * Get the page_touched field
512 * @return string containing GMT timestamp
514 public function getTouched() {
515 if ( !$this->mDataLoaded ) {
516 $this->loadPageData();
518 return $this->mTouched;
522 * Get the page_latest field
523 * @return integer rev_id of current revision
525 public function getLatest() {
526 if ( !$this->mDataLoaded ) {
527 $this->loadPageData();
529 return (int)$this->mLatest;
533 * Get the Revision object of the oldest revision
534 * @return Revision|null
536 public function getOldestRevision() {
537 wfProfileIn( __METHOD__ );
539 // Try using the slave database first, then try the master
540 $continue = 2;
541 $db = wfGetDB( DB_SLAVE );
542 $revSelectFields = Revision::selectFields();
544 while ( $continue ) {
545 $row = $db->selectRow(
546 array( 'page', 'revision' ),
547 $revSelectFields,
548 array(
549 'page_namespace' => $this->mTitle->getNamespace(),
550 'page_title' => $this->mTitle->getDBkey(),
551 'rev_page = page_id'
553 __METHOD__,
554 array(
555 'ORDER BY' => 'rev_timestamp ASC'
559 if ( $row ) {
560 $continue = 0;
561 } else {
562 $db = wfGetDB( DB_MASTER );
563 $continue--;
567 wfProfileOut( __METHOD__ );
568 return $row ? Revision::newFromRow( $row ) : null;
572 * Loads everything except the text
573 * This isn't necessary for all uses, so it's only done if needed.
575 protected function loadLastEdit() {
576 if ( $this->mLastRevision !== null ) {
577 return; // already loaded
580 $latest = $this->getLatest();
581 if ( !$latest ) {
582 return; // page doesn't exist or is missing page_latest info
585 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always includes the
586 // latest changes committed. This is true even within REPEATABLE-READ transactions, where
587 // S1 normally only sees changes committed before the first S1 SELECT. Thus we need S1 to
588 // also gets the revision row FOR UPDATE; otherwise, it may not find it since a page row
589 // UPDATE and revision row INSERT by S2 may have happened after the first S1 SELECT.
590 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
591 $flags = ( $this->mDataLoadedFrom == self::READ_LOCKING ) ? Revision::READ_LOCKING : 0;
592 $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
593 if ( $revision ) { // sanity
594 $this->setLastEdit( $revision );
599 * Set the latest revision
601 protected function setLastEdit( Revision $revision ) {
602 $this->mLastRevision = $revision;
603 $this->mTimestamp = $revision->getTimestamp();
607 * Get the latest revision
608 * @return Revision|null
610 public function getRevision() {
611 $this->loadLastEdit();
612 if ( $this->mLastRevision ) {
613 return $this->mLastRevision;
615 return null;
619 * Get the content of the current revision. No side-effects...
621 * @param $audience Integer: one of:
622 * Revision::FOR_PUBLIC to be displayed to all users
623 * Revision::FOR_THIS_USER to be displayed to $wgUser
624 * Revision::RAW get the text regardless of permissions
625 * @param $user User object to check for, only if FOR_THIS_USER is passed
626 * to the $audience parameter
627 * @return Content|null The content of the current revision
629 * @since 1.21
631 public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) {
632 $this->loadLastEdit();
633 if ( $this->mLastRevision ) {
634 return $this->mLastRevision->getContent( $audience, $user );
636 return null;
640 * Get the text of the current revision. No side-effects...
642 * @param $audience Integer: one of:
643 * Revision::FOR_PUBLIC to be displayed to all users
644 * Revision::FOR_THIS_USER to be displayed to the given user
645 * Revision::RAW get the text regardless of permissions
646 * @param $user User object to check for, only if FOR_THIS_USER is passed
647 * to the $audience parameter
648 * @return String|false The text of the current revision
649 * @deprecated as of 1.21, getContent() should be used instead.
651 public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) { // @todo deprecated, replace usage!
652 ContentHandler::deprecated( __METHOD__, '1.21' );
654 $this->loadLastEdit();
655 if ( $this->mLastRevision ) {
656 return $this->mLastRevision->getText( $audience, $user );
658 return false;
662 * Get the text of the current revision. No side-effects...
664 * @return String|bool The text of the current revision. False on failure
665 * @deprecated as of 1.21, getContent() should be used instead.
667 public function getRawText() {
668 ContentHandler::deprecated( __METHOD__, '1.21' );
670 return $this->getText( Revision::RAW );
674 * @return string MW timestamp of last article revision
676 public function getTimestamp() {
677 // Check if the field has been filled by WikiPage::setTimestamp()
678 if ( !$this->mTimestamp ) {
679 $this->loadLastEdit();
682 return wfTimestamp( TS_MW, $this->mTimestamp );
686 * Set the page timestamp (use only to avoid DB queries)
687 * @param string $ts MW timestamp of last article revision
688 * @return void
690 public function setTimestamp( $ts ) {
691 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
695 * @param $audience Integer: one of:
696 * Revision::FOR_PUBLIC to be displayed to all users
697 * Revision::FOR_THIS_USER to be displayed to the given user
698 * Revision::RAW get the text regardless of permissions
699 * @param $user User object to check for, only if FOR_THIS_USER is passed
700 * to the $audience parameter
701 * @return int user ID for the user that made the last article revision
703 public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
704 $this->loadLastEdit();
705 if ( $this->mLastRevision ) {
706 return $this->mLastRevision->getUser( $audience, $user );
707 } else {
708 return -1;
713 * Get the User object of the user who created the page
714 * @param $audience Integer: one of:
715 * Revision::FOR_PUBLIC to be displayed to all users
716 * Revision::FOR_THIS_USER to be displayed to the given user
717 * Revision::RAW get the text regardless of permissions
718 * @param $user User object to check for, only if FOR_THIS_USER is passed
719 * to the $audience parameter
720 * @return User|null
722 public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) {
723 $revision = $this->getOldestRevision();
724 if ( $revision ) {
725 $userName = $revision->getUserText( $audience, $user );
726 return User::newFromName( $userName, false );
727 } else {
728 return null;
733 * @param $audience Integer: one of:
734 * Revision::FOR_PUBLIC to be displayed to all users
735 * Revision::FOR_THIS_USER to be displayed to the given user
736 * Revision::RAW get the text regardless of permissions
737 * @param $user User object to check for, only if FOR_THIS_USER is passed
738 * to the $audience parameter
739 * @return string username of the user that made the last article revision
741 public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
742 $this->loadLastEdit();
743 if ( $this->mLastRevision ) {
744 return $this->mLastRevision->getUserText( $audience, $user );
745 } else {
746 return '';
751 * @param $audience Integer: one of:
752 * Revision::FOR_PUBLIC to be displayed to all users
753 * Revision::FOR_THIS_USER to be displayed to the given user
754 * Revision::RAW get the text regardless of permissions
755 * @param $user User object to check for, only if FOR_THIS_USER is passed
756 * to the $audience parameter
757 * @return string Comment stored for the last article revision
759 public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) {
760 $this->loadLastEdit();
761 if ( $this->mLastRevision ) {
762 return $this->mLastRevision->getComment( $audience, $user );
763 } else {
764 return '';
769 * Returns true if last revision was marked as "minor edit"
771 * @return boolean Minor edit indicator for the last article revision.
773 public function getMinorEdit() {
774 $this->loadLastEdit();
775 if ( $this->mLastRevision ) {
776 return $this->mLastRevision->isMinor();
777 } else {
778 return false;
783 * Get the cached timestamp for the last time the page changed.
784 * This is only used to help handle slave lag by comparing to page_touched.
785 * @return string MW timestamp
787 protected function getCachedLastEditTime() {
788 global $wgMemc;
789 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
790 return $wgMemc->get( $key );
794 * Set the cached timestamp for the last time the page changed.
795 * This is only used to help handle slave lag by comparing to page_touched.
796 * @param $timestamp string
797 * @return void
799 public function setCachedLastEditTime( $timestamp ) {
800 global $wgMemc;
801 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
802 $wgMemc->set( $key, wfTimestamp( TS_MW, $timestamp ), 60 * 15 );
806 * Determine whether a page would be suitable for being counted as an
807 * article in the site_stats table based on the title & its content
809 * @param $editInfo Object|bool (false): object returned by prepareTextForEdit(),
810 * if false, the current database state will be used
811 * @return Boolean
813 public function isCountable( $editInfo = false ) {
814 global $wgArticleCountMethod;
816 if ( !$this->mTitle->isContentPage() ) {
817 return false;
820 if ( $editInfo ) {
821 $content = $editInfo->pstContent;
822 } else {
823 $content = $this->getContent();
826 if ( !$content || $content->isRedirect() ) {
827 return false;
830 $hasLinks = null;
832 if ( $wgArticleCountMethod === 'link' ) {
833 // nasty special case to avoid re-parsing to detect links
835 if ( $editInfo ) {
836 // ParserOutput::getLinks() is a 2D array of page links, so
837 // to be really correct we would need to recurse in the array
838 // but the main array should only have items in it if there are
839 // links.
840 $hasLinks = (bool)count( $editInfo->output->getLinks() );
841 } else {
842 $hasLinks = (bool)wfGetDB( DB_SLAVE )->selectField( 'pagelinks', 1,
843 array( 'pl_from' => $this->getId() ), __METHOD__ );
847 return $content->isCountable( $hasLinks );
851 * If this page is a redirect, get its target
853 * The target will be fetched from the redirect table if possible.
854 * If this page doesn't have an entry there, call insertRedirect()
855 * @return Title|mixed object, or null if this page is not a redirect
857 public function getRedirectTarget() {
858 if ( !$this->mTitle->isRedirect() ) {
859 return null;
862 if ( $this->mRedirectTarget !== null ) {
863 return $this->mRedirectTarget;
866 // Query the redirect table
867 $dbr = wfGetDB( DB_SLAVE );
868 $row = $dbr->selectRow( 'redirect',
869 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
870 array( 'rd_from' => $this->getId() ),
871 __METHOD__
874 // rd_fragment and rd_interwiki were added later, populate them if empty
875 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
876 return $this->mRedirectTarget = Title::makeTitle(
877 $row->rd_namespace, $row->rd_title,
878 $row->rd_fragment, $row->rd_interwiki );
881 // This page doesn't have an entry in the redirect table
882 return $this->mRedirectTarget = $this->insertRedirect();
886 * Insert an entry for this page into the redirect table.
888 * Don't call this function directly unless you know what you're doing.
889 * @return Title object or null if not a redirect
891 public function insertRedirect() {
892 // recurse through to only get the final target
893 $content = $this->getContent();
894 $retval = $content ? $content->getUltimateRedirectTarget() : null;
895 if ( !$retval ) {
896 return null;
898 $this->insertRedirectEntry( $retval );
899 return $retval;
903 * Insert or update the redirect table entry for this page to indicate
904 * it redirects to $rt .
905 * @param $rt Title redirect target
907 public function insertRedirectEntry( $rt ) {
908 $dbw = wfGetDB( DB_MASTER );
909 $dbw->replace( 'redirect', array( 'rd_from' ),
910 array(
911 'rd_from' => $this->getId(),
912 'rd_namespace' => $rt->getNamespace(),
913 'rd_title' => $rt->getDBkey(),
914 'rd_fragment' => $rt->getFragment(),
915 'rd_interwiki' => $rt->getInterwiki(),
917 __METHOD__
922 * Get the Title object or URL this page redirects to
924 * @return mixed false, Title of in-wiki target, or string with URL
926 public function followRedirect() {
927 return $this->getRedirectURL( $this->getRedirectTarget() );
931 * Get the Title object or URL to use for a redirect. We use Title
932 * objects for same-wiki, non-special redirects and URLs for everything
933 * else.
934 * @param $rt Title Redirect target
935 * @return mixed false, Title object of local target, or string with URL
937 public function getRedirectURL( $rt ) {
938 if ( !$rt ) {
939 return false;
942 if ( $rt->isExternal() ) {
943 if ( $rt->isLocal() ) {
944 // Offsite wikis need an HTTP redirect.
946 // This can be hard to reverse and may produce loops,
947 // so they may be disabled in the site configuration.
948 $source = $this->mTitle->getFullURL( 'redirect=no' );
949 return $rt->getFullURL( array( 'rdfrom' => $source ) );
950 } else {
951 // External pages pages without "local" bit set are not valid
952 // redirect targets
953 return false;
957 if ( $rt->isSpecialPage() ) {
958 // Gotta handle redirects to special pages differently:
959 // Fill the HTTP response "Location" header and ignore
960 // the rest of the page we're on.
962 // Some pages are not valid targets
963 if ( $rt->isValidRedirectTarget() ) {
964 return $rt->getFullURL();
965 } else {
966 return false;
970 return $rt;
974 * Get a list of users who have edited this article, not including the user who made
975 * the most recent revision, which you can get from $article->getUser() if you want it
976 * @return UserArrayFromResult
978 public function getContributors() {
979 // @todo FIXME: This is expensive; cache this info somewhere.
981 $dbr = wfGetDB( DB_SLAVE );
983 if ( $dbr->implicitGroupby() ) {
984 $realNameField = 'user_real_name';
985 } else {
986 $realNameField = 'MIN(user_real_name) AS user_real_name';
989 $tables = array( 'revision', 'user' );
991 $fields = array(
992 'user_id' => 'rev_user',
993 'user_name' => 'rev_user_text',
994 $realNameField,
995 'timestamp' => 'MAX(rev_timestamp)',
998 $conds = array( 'rev_page' => $this->getId() );
1000 // The user who made the top revision gets credited as "this page was last edited by
1001 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1002 $user = $this->getUser();
1003 if ( $user ) {
1004 $conds[] = "rev_user != $user";
1005 } else {
1006 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1009 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1011 $jconds = array(
1012 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1015 $options = array(
1016 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1017 'ORDER BY' => 'timestamp DESC',
1020 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1021 return new UserArrayFromResult( $res );
1025 * Get the last N authors
1026 * @param $num Integer: number of revisions to get
1027 * @param string $revLatest the latest rev_id, selected from the master (optional)
1028 * @return array Array of authors, duplicates not removed
1030 public function getLastNAuthors( $num, $revLatest = 0 ) {
1031 wfProfileIn( __METHOD__ );
1032 // First try the slave
1033 // If that doesn't have the latest revision, try the master
1034 $continue = 2;
1035 $db = wfGetDB( DB_SLAVE );
1037 do {
1038 $res = $db->select( array( 'page', 'revision' ),
1039 array( 'rev_id', 'rev_user_text' ),
1040 array(
1041 'page_namespace' => $this->mTitle->getNamespace(),
1042 'page_title' => $this->mTitle->getDBkey(),
1043 'rev_page = page_id'
1044 ), __METHOD__,
1045 array(
1046 'ORDER BY' => 'rev_timestamp DESC',
1047 'LIMIT' => $num
1051 if ( !$res ) {
1052 wfProfileOut( __METHOD__ );
1053 return array();
1056 $row = $db->fetchObject( $res );
1058 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
1059 $db = wfGetDB( DB_MASTER );
1060 $continue--;
1061 } else {
1062 $continue = 0;
1064 } while ( $continue );
1066 $authors = array( $row->rev_user_text );
1068 foreach ( $res as $row ) {
1069 $authors[] = $row->rev_user_text;
1072 wfProfileOut( __METHOD__ );
1073 return $authors;
1077 * Should the parser cache be used?
1079 * @param $parserOptions ParserOptions to check
1080 * @param $oldid int
1081 * @return boolean
1083 public function isParserCacheUsed( ParserOptions $parserOptions, $oldid ) {
1084 global $wgEnableParserCache;
1086 return $wgEnableParserCache
1087 && $parserOptions->getStubThreshold() == 0
1088 && $this->exists()
1089 && ( $oldid === null || $oldid === 0 || $oldid === $this->getLatest() )
1090 && $this->getContentHandler()->isParserCacheSupported();
1094 * Get a ParserOutput for the given ParserOptions and revision ID.
1095 * The parser cache will be used if possible.
1097 * @since 1.19
1098 * @param $parserOptions ParserOptions to use for the parse operation
1099 * @param $oldid Revision ID to get the text from, passing null or 0 will
1100 * get the current revision (default value)
1102 * @return ParserOutput or false if the revision was not found
1104 public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
1105 wfProfileIn( __METHOD__ );
1107 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1108 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1109 if ( $parserOptions->getStubThreshold() ) {
1110 wfIncrStats( 'pcache_miss_stub' );
1113 if ( $useParserCache ) {
1114 $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
1115 if ( $parserOutput !== false ) {
1116 wfProfileOut( __METHOD__ );
1117 return $parserOutput;
1121 if ( $oldid === null || $oldid === 0 ) {
1122 $oldid = $this->getLatest();
1125 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1126 $pool->execute();
1128 wfProfileOut( __METHOD__ );
1130 return $pool->getParserOutput();
1134 * Do standard deferred updates after page view
1135 * @param $user User The relevant user
1137 public function doViewUpdates( User $user ) {
1138 global $wgDisableCounters;
1139 if ( wfReadOnly() ) {
1140 return;
1143 // Don't update page view counters on views from bot users (bug 14044)
1144 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->exists() ) {
1145 DeferredUpdates::addUpdate( new ViewCountUpdate( $this->getId() ) );
1146 DeferredUpdates::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1149 // Update newtalk / watchlist notification status
1150 $user->clearNotification( $this->mTitle );
1154 * Perform the actions of a page purging
1155 * @return bool
1157 public function doPurge() {
1158 global $wgUseSquid;
1160 if ( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1161 return false;
1164 // Invalidate the cache
1165 $this->mTitle->invalidateCache();
1167 if ( $wgUseSquid ) {
1168 // Commit the transaction before the purge is sent
1169 $dbw = wfGetDB( DB_MASTER );
1170 $dbw->commit( __METHOD__ );
1172 // Send purge
1173 $update = SquidUpdate::newSimplePurge( $this->mTitle );
1174 $update->doUpdate();
1177 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1178 // @todo move this logic to MessageCache
1180 if ( $this->exists() ) {
1181 // NOTE: use transclusion text for messages.
1182 // This is consistent with MessageCache::getMsgFromNamespace()
1184 $content = $this->getContent();
1185 $text = $content === null ? null : $content->getWikitextForTransclusion();
1187 if ( $text === null ) {
1188 $text = false;
1190 } else {
1191 $text = false;
1194 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
1196 return true;
1200 * Insert a new empty page record for this article.
1201 * This *must* be followed up by creating a revision
1202 * and running $this->updateRevisionOn( ... );
1203 * or else the record will be left in a funky state.
1204 * Best if all done inside a transaction.
1206 * @param $dbw DatabaseBase
1207 * @return int The newly created page_id key, or false if the title already existed
1209 public function insertOn( $dbw ) {
1210 wfProfileIn( __METHOD__ );
1212 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1213 $dbw->insert( 'page', array(
1214 'page_id' => $page_id,
1215 'page_namespace' => $this->mTitle->getNamespace(),
1216 'page_title' => $this->mTitle->getDBkey(),
1217 'page_counter' => 0,
1218 'page_restrictions' => '',
1219 'page_is_redirect' => 0, // Will set this shortly...
1220 'page_is_new' => 1,
1221 'page_random' => wfRandom(),
1222 'page_touched' => $dbw->timestamp(),
1223 'page_latest' => 0, // Fill this in shortly...
1224 'page_len' => 0, // Fill this in shortly...
1225 ), __METHOD__, 'IGNORE' );
1227 $affected = $dbw->affectedRows();
1229 if ( $affected ) {
1230 $newid = $dbw->insertId();
1231 $this->mId = $newid;
1232 $this->mTitle->resetArticleID( $newid );
1234 wfProfileOut( __METHOD__ );
1236 return $affected ? $newid : false;
1240 * Update the page record to point to a newly saved revision.
1242 * @param $dbw DatabaseBase: object
1243 * @param $revision Revision: For ID number, and text used to set
1244 * length and redirect status fields
1245 * @param $lastRevision Integer: if given, will not overwrite the page field
1246 * when different from the currently set value.
1247 * Giving 0 indicates the new page flag should be set
1248 * on.
1249 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1250 * removing rows in redirect table.
1251 * @return bool true on success, false on failure
1252 * @private
1254 public function updateRevisionOn( $dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
1255 global $wgContentHandlerUseDB;
1257 wfProfileIn( __METHOD__ );
1259 $content = $revision->getContent();
1260 $len = $content ? $content->getSize() : 0;
1261 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1263 $conditions = array( 'page_id' => $this->getId() );
1265 if ( !is_null( $lastRevision ) ) {
1266 // An extra check against threads stepping on each other
1267 $conditions['page_latest'] = $lastRevision;
1270 $now = wfTimestampNow();
1271 $row = array( /* SET */
1272 'page_latest' => $revision->getId(),
1273 'page_touched' => $dbw->timestamp( $now ),
1274 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
1275 'page_is_redirect' => $rt !== null ? 1 : 0,
1276 'page_len' => $len,
1279 if ( $wgContentHandlerUseDB ) {
1280 $row['page_content_model'] = $revision->getContentModel();
1283 $dbw->update( 'page',
1284 $row,
1285 $conditions,
1286 __METHOD__ );
1288 $result = $dbw->affectedRows() > 0;
1289 if ( $result ) {
1290 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1291 $this->setLastEdit( $revision );
1292 $this->setCachedLastEditTime( $now );
1293 $this->mLatest = $revision->getId();
1294 $this->mIsRedirect = (bool)$rt;
1295 // Update the LinkCache.
1296 LinkCache::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle, $len, $this->mIsRedirect,
1297 $this->mLatest, $revision->getContentModel() );
1300 wfProfileOut( __METHOD__ );
1301 return $result;
1305 * Add row to the redirect table if this is a redirect, remove otherwise.
1307 * @param $dbw DatabaseBase
1308 * @param $redirectTitle Title object pointing to the redirect target,
1309 * or NULL if this is not a redirect
1310 * @param $lastRevIsRedirect null|bool If given, will optimize adding and
1311 * removing rows in redirect table.
1312 * @return bool true on success, false on failure
1313 * @private
1315 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1316 // Always update redirects (target link might have changed)
1317 // Update/Insert if we don't know if the last revision was a redirect or not
1318 // Delete if changing from redirect to non-redirect
1319 $isRedirect = !is_null( $redirectTitle );
1321 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1322 return true;
1325 wfProfileIn( __METHOD__ );
1326 if ( $isRedirect ) {
1327 $this->insertRedirectEntry( $redirectTitle );
1328 } else {
1329 // This is not a redirect, remove row from redirect table
1330 $where = array( 'rd_from' => $this->getId() );
1331 $dbw->delete( 'redirect', $where, __METHOD__ );
1334 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1335 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1337 wfProfileOut( __METHOD__ );
1339 return ( $dbw->affectedRows() != 0 );
1343 * If the given revision is newer than the currently set page_latest,
1344 * update the page record. Otherwise, do nothing.
1346 * @param $dbw DatabaseBase object
1347 * @param $revision Revision object
1348 * @return mixed
1350 public function updateIfNewerOn( $dbw, $revision ) {
1351 wfProfileIn( __METHOD__ );
1353 $row = $dbw->selectRow(
1354 array( 'revision', 'page' ),
1355 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1356 array(
1357 'page_id' => $this->getId(),
1358 'page_latest=rev_id' ),
1359 __METHOD__ );
1361 if ( $row ) {
1362 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1363 wfProfileOut( __METHOD__ );
1364 return false;
1366 $prev = $row->rev_id;
1367 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1368 } else {
1369 // No or missing previous revision; mark the page as new
1370 $prev = 0;
1371 $lastRevIsRedirect = null;
1374 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1376 wfProfileOut( __METHOD__ );
1377 return $ret;
1381 * Get the content that needs to be saved in order to undo all revisions
1382 * between $undo and $undoafter. Revisions must belong to the same page,
1383 * must exist and must not be deleted
1384 * @param $undo Revision
1385 * @param $undoafter Revision Must be an earlier revision than $undo
1386 * @return mixed string on success, false on failure
1387 * @since 1.21
1388 * Before we had the Content object, this was done in getUndoText
1390 public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1391 $handler = $undo->getContentHandler();
1392 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1396 * Get the text that needs to be saved in order to undo all revisions
1397 * between $undo and $undoafter. Revisions must belong to the same page,
1398 * must exist and must not be deleted
1399 * @param $undo Revision
1400 * @param $undoafter Revision Must be an earlier revision than $undo
1401 * @return mixed string on success, false on failure
1402 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1404 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
1405 ContentHandler::deprecated( __METHOD__, '1.21' );
1407 $this->loadLastEdit();
1409 if ( $this->mLastRevision ) {
1410 if ( is_null( $undoafter ) ) {
1411 $undoafter = $undo->getPrevious();
1414 $handler = $this->getContentHandler();
1415 $undone = $handler->getUndoContent( $this->mLastRevision, $undo, $undoafter );
1417 if ( !$undone ) {
1418 return false;
1419 } else {
1420 return ContentHandler::getContentText( $undone );
1424 return false;
1428 * @param $section null|bool|int or a section number (0, 1, 2, T1, T2...)
1429 * @param string $text new text of the section
1430 * @param string $sectionTitle new section's subject, only if $section is 'new'
1431 * @param string $edittime revision timestamp or null to use the current revision
1432 * @throws MWException
1433 * @return String new complete article text, or null if error
1435 * @deprecated since 1.21, use replaceSectionContent() instead
1437 public function replaceSection( $section, $text, $sectionTitle = '', $edittime = null ) {
1438 ContentHandler::deprecated( __METHOD__, '1.21' );
1440 if ( strval( $section ) == '' ) { //NOTE: keep condition in sync with condition in replaceSectionContent!
1441 // Whole-page edit; let the whole text through
1442 return $text;
1445 if ( !$this->supportsSections() ) {
1446 throw new MWException( "sections not supported for content model " . $this->getContentHandler()->getModelID() );
1449 // could even make section title, but that's not required.
1450 $sectionContent = ContentHandler::makeContent( $text, $this->getTitle() );
1452 $newContent = $this->replaceSectionContent( $section, $sectionContent, $sectionTitle, $edittime );
1454 return ContentHandler::getContentText( $newContent );
1458 * Returns true iff this page's content model supports sections.
1460 * @return boolean whether sections are supported.
1462 * @todo The skin should check this and not offer section functionality if sections are not supported.
1463 * @todo The EditPage should check this and not offer section functionality if sections are not supported.
1465 public function supportsSections() {
1466 return $this->getContentHandler()->supportsSections();
1470 * @param $section null|bool|int or a section number (0, 1, 2, T1, T2...)
1471 * @param $sectionContent Content: new content of the section
1472 * @param string $sectionTitle new section's subject, only if $section is 'new'
1473 * @param string $edittime revision timestamp or null to use the current revision
1475 * @throws MWException
1476 * @return Content new complete article content, or null if error
1478 * @since 1.21
1480 public function replaceSectionContent( $section, Content $sectionContent, $sectionTitle = '', $edittime = null ) {
1481 wfProfileIn( __METHOD__ );
1483 if ( strval( $section ) == '' ) {
1484 // Whole-page edit; let the whole text through
1485 $newContent = $sectionContent;
1486 } else {
1487 if ( !$this->supportsSections() ) {
1488 wfProfileOut( __METHOD__ );
1489 throw new MWException( "sections not supported for content model " . $this->getContentHandler()->getModelID() );
1492 // Bug 30711: always use current version when adding a new section
1493 if ( is_null( $edittime ) || $section == 'new' ) {
1494 $oldContent = $this->getContent();
1495 } else {
1496 $dbw = wfGetDB( DB_MASTER );
1497 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1499 if ( !$rev ) {
1500 wfDebug( "WikiPage::replaceSection asked for bogus section (page: " .
1501 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1502 wfProfileOut( __METHOD__ );
1503 return null;
1506 $oldContent = $rev->getContent();
1509 if ( ! $oldContent ) {
1510 wfDebug( __METHOD__ . ": no page text\n" );
1511 wfProfileOut( __METHOD__ );
1512 return null;
1515 // FIXME: $oldContent might be null?
1516 $newContent = $oldContent->replaceSection( $section, $sectionContent, $sectionTitle );
1519 wfProfileOut( __METHOD__ );
1520 return $newContent;
1524 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1525 * @param $flags Int
1526 * @return Int updated $flags
1528 function checkFlags( $flags ) {
1529 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1530 if ( $this->exists() ) {
1531 $flags |= EDIT_UPDATE;
1532 } else {
1533 $flags |= EDIT_NEW;
1537 return $flags;
1541 * Change an existing article or create a new article. Updates RC and all necessary caches,
1542 * optionally via the deferred update array.
1544 * @param string $text new text
1545 * @param string $summary edit summary
1546 * @param $flags Integer bitfield:
1547 * EDIT_NEW
1548 * Article is known or assumed to be non-existent, create a new one
1549 * EDIT_UPDATE
1550 * Article is known or assumed to be pre-existing, update it
1551 * EDIT_MINOR
1552 * Mark this edit minor, if the user is allowed to do so
1553 * EDIT_SUPPRESS_RC
1554 * Do not log the change in recentchanges
1555 * EDIT_FORCE_BOT
1556 * Mark the edit a "bot" edit regardless of user rights
1557 * EDIT_DEFER_UPDATES
1558 * Defer some of the updates until the end of index.php
1559 * EDIT_AUTOSUMMARY
1560 * Fill in blank summaries with generated text where possible
1562 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1563 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1564 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1565 * edit-already-exists error will be returned. These two conditions are also possible with
1566 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1568 * @param bool|int $baseRevId int the revision ID this edit was based off, if any
1569 * @param $user User the user doing the edit
1571 * @throws MWException
1572 * @return Status object. Possible errors:
1573 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1574 * edit-gone-missing: In update mode, but the article didn't exist
1575 * edit-conflict: In update mode, the article changed unexpectedly
1576 * edit-no-change: Warning that the text was the same as before
1577 * edit-already-exists: In creation mode, but the article already exists
1579 * Extensions may define additional errors.
1581 * $return->value will contain an associative array with members as follows:
1582 * new: Boolean indicating if the function attempted to create a new article
1583 * revision: The revision object for the inserted revision, or null
1585 * Compatibility note: this function previously returned a boolean value indicating success/failure
1587 * @deprecated since 1.21: use doEditContent() instead.
1589 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1590 ContentHandler::deprecated( __METHOD__, '1.21' );
1592 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1594 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1598 * Change an existing article or create a new article. Updates RC and all necessary caches,
1599 * optionally via the deferred update array.
1601 * @param $content Content: new content
1602 * @param string $summary edit summary
1603 * @param $flags Integer bitfield:
1604 * EDIT_NEW
1605 * Article is known or assumed to be non-existent, create a new one
1606 * EDIT_UPDATE
1607 * Article is known or assumed to be pre-existing, update it
1608 * EDIT_MINOR
1609 * Mark this edit minor, if the user is allowed to do so
1610 * EDIT_SUPPRESS_RC
1611 * Do not log the change in recentchanges
1612 * EDIT_FORCE_BOT
1613 * Mark the edit a "bot" edit regardless of user rights
1614 * EDIT_DEFER_UPDATES
1615 * Defer some of the updates until the end of index.php
1616 * EDIT_AUTOSUMMARY
1617 * Fill in blank summaries with generated text where possible
1619 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1620 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1621 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1622 * edit-already-exists error will be returned. These two conditions are also possible with
1623 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1625 * @param bool|\the $baseRevId the revision ID this edit was based off, if any
1626 * @param $user User the user doing the edit
1627 * @param $serialisation_format String: format for storing the content in the database
1629 * @throws MWException
1630 * @return Status object. Possible errors:
1631 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1632 * edit-gone-missing: In update mode, but the article didn't exist
1633 * edit-conflict: In update mode, the article changed unexpectedly
1634 * edit-no-change: Warning that the text was the same as before
1635 * edit-already-exists: In creation mode, but the article already exists
1637 * Extensions may define additional errors.
1639 * $return->value will contain an associative array with members as follows:
1640 * new: Boolean indicating if the function attempted to create a new article
1641 * revision: The revision object for the inserted revision, or null
1643 * @since 1.21
1645 public function doEditContent( Content $content, $summary, $flags = 0, $baseRevId = false,
1646 User $user = null, $serialisation_format = null ) {
1647 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1649 // Low-level sanity check
1650 if ( $this->mTitle->getText() === '' ) {
1651 throw new MWException( 'Something is trying to edit an article with an empty title' );
1654 wfProfileIn( __METHOD__ );
1656 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1657 wfProfileOut( __METHOD__ );
1658 return Status::newFatal( 'content-not-allowed-here',
1659 ContentHandler::getLocalizedName( $content->getModel() ),
1660 $this->getTitle()->getPrefixedText() );
1663 $user = is_null( $user ) ? $wgUser : $user;
1664 $status = Status::newGood( array() );
1666 // Load the data from the master database if needed.
1667 // The caller may already loaded it from the master or even loaded it using
1668 // SELECT FOR UPDATE, so do not override that using clear().
1669 $this->loadPageData( 'fromdbmaster' );
1671 $flags = $this->checkFlags( $flags );
1673 // handle hook
1674 $hook_args = array( &$this, &$user, &$content, &$summary,
1675 $flags & EDIT_MINOR, null, null, &$flags, &$status );
1677 if ( !wfRunHooks( 'PageContentSave', $hook_args )
1678 || !ContentHandler::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1680 wfDebug( __METHOD__ . ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1682 if ( $status->isOK() ) {
1683 $status->fatal( 'edit-hook-aborted' );
1686 wfProfileOut( __METHOD__ );
1687 return $status;
1690 // Silently ignore EDIT_MINOR if not allowed
1691 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
1692 $bot = $flags & EDIT_FORCE_BOT;
1694 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1696 $oldsize = $old_content ? $old_content->getSize() : 0;
1697 $oldid = $this->getLatest();
1698 $oldIsRedirect = $this->isRedirect();
1699 $oldcountable = $this->isCountable();
1701 $handler = $content->getContentHandler();
1703 // Provide autosummaries if one is not provided and autosummaries are enabled.
1704 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
1705 if ( !$old_content ) {
1706 $old_content = null;
1708 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1711 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialisation_format );
1712 $serialized = $editInfo->pst;
1713 $content = $editInfo->pstContent;
1714 $newsize = $content->getSize();
1716 $dbw = wfGetDB( DB_MASTER );
1717 $now = wfTimestampNow();
1718 $this->mTimestamp = $now;
1720 if ( $flags & EDIT_UPDATE ) {
1721 // Update article, but only if changed.
1722 $status->value['new'] = false;
1724 if ( !$oldid ) {
1725 // Article gone missing
1726 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
1727 $status->fatal( 'edit-gone-missing' );
1729 wfProfileOut( __METHOD__ );
1730 return $status;
1731 } elseif ( !$old_content ) {
1732 // Sanity check for bug 37225
1733 wfProfileOut( __METHOD__ );
1734 throw new MWException( "Could not find text for current revision {$oldid}." );
1737 $revision = new Revision( array(
1738 'page' => $this->getId(),
1739 'title' => $this->getTitle(), // for determining the default content model
1740 'comment' => $summary,
1741 'minor_edit' => $isminor,
1742 'text' => $serialized,
1743 'len' => $newsize,
1744 'parent_id' => $oldid,
1745 'user' => $user->getId(),
1746 'user_text' => $user->getName(),
1747 'timestamp' => $now,
1748 'content_model' => $content->getModel(),
1749 'content_format' => $serialisation_format,
1750 ) ); // XXX: pass content object?!
1752 $changed = !$content->equals( $old_content );
1754 if ( $changed ) {
1755 if ( !$content->isValid() ) {
1756 wfProfileOut( __METHOD__ );
1757 throw new MWException( "New content failed validity check!" );
1760 $dbw->begin( __METHOD__ );
1762 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1763 $status->merge( $prepStatus );
1765 if ( !$status->isOK() ) {
1766 $dbw->rollback( __METHOD__ );
1768 wfProfileOut( __METHOD__ );
1769 return $status;
1772 $revisionId = $revision->insertOn( $dbw );
1774 // Update page
1776 // Note that we use $this->mLatest instead of fetching a value from the master DB
1777 // during the course of this function. This makes sure that EditPage can detect
1778 // edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1779 // before this function is called. A previous function used a separate query, this
1780 // creates a window where concurrent edits can cause an ignored edit conflict.
1781 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1783 if ( !$ok ) {
1784 // Belated edit conflict! Run away!!
1785 $status->fatal( 'edit-conflict' );
1787 $dbw->rollback( __METHOD__ );
1789 wfProfileOut( __METHOD__ );
1790 return $status;
1793 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1794 // Update recentchanges
1795 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1796 // Mark as patrolled if the user can do so
1797 $patrolled = $wgUseRCPatrol && !count(
1798 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1799 // Add RC row to the DB
1800 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
1801 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1802 $revisionId, $patrolled
1805 // Log auto-patrolled edits
1806 if ( $patrolled ) {
1807 PatrolLog::record( $rc, true, $user );
1810 $user->incEditCount();
1811 $dbw->commit( __METHOD__ );
1812 } else {
1813 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1814 // related variables correctly
1815 $revision->setId( $this->getLatest() );
1818 // Update links tables, site stats, etc.
1819 $this->doEditUpdates(
1820 $revision,
1821 $user,
1822 array(
1823 'changed' => $changed,
1824 'oldcountable' => $oldcountable
1828 if ( !$changed ) {
1829 $status->warning( 'edit-no-change' );
1830 $revision = null;
1831 // Update page_touched, this is usually implicit in the page update
1832 // Other cache updates are done in onArticleEdit()
1833 $this->mTitle->invalidateCache();
1835 } else {
1836 // Create new article
1837 $status->value['new'] = true;
1839 $dbw->begin( __METHOD__ );
1841 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1842 $status->merge( $prepStatus );
1844 if ( !$status->isOK() ) {
1845 $dbw->rollback( __METHOD__ );
1847 wfProfileOut( __METHOD__ );
1848 return $status;
1851 $status->merge( $prepStatus );
1853 // Add the page record; stake our claim on this title!
1854 // This will return false if the article already exists
1855 $newid = $this->insertOn( $dbw );
1857 if ( $newid === false ) {
1858 $dbw->rollback( __METHOD__ );
1859 $status->fatal( 'edit-already-exists' );
1861 wfProfileOut( __METHOD__ );
1862 return $status;
1865 // Save the revision text...
1866 $revision = new Revision( array(
1867 'page' => $newid,
1868 'title' => $this->getTitle(), // for determining the default content model
1869 'comment' => $summary,
1870 'minor_edit' => $isminor,
1871 'text' => $serialized,
1872 'len' => $newsize,
1873 'user' => $user->getId(),
1874 'user_text' => $user->getName(),
1875 'timestamp' => $now,
1876 'content_model' => $content->getModel(),
1877 'content_format' => $serialisation_format,
1878 ) );
1879 $revisionId = $revision->insertOn( $dbw );
1881 // Bug 37225: use accessor to get the text as Revision may trim it
1882 $content = $revision->getContent(); // sanity; get normalized version
1884 if ( $content ) {
1885 $newsize = $content->getSize();
1888 // Update the page record with revision data
1889 $this->updateRevisionOn( $dbw, $revision, 0 );
1891 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1893 // Update recentchanges
1894 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1895 // Mark as patrolled if the user can do so
1896 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
1897 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1898 // Add RC row to the DB
1899 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
1900 '', $newsize, $revisionId, $patrolled );
1902 // Log auto-patrolled edits
1903 if ( $patrolled ) {
1904 PatrolLog::record( $rc, true, $user );
1907 $user->incEditCount();
1908 $dbw->commit( __METHOD__ );
1910 // Update links, etc.
1911 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1913 $hook_args = array( &$this, &$user, $content, $summary,
1914 $flags & EDIT_MINOR, null, null, &$flags, $revision );
1916 ContentHandler::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1917 wfRunHooks( 'PageContentInsertComplete', $hook_args );
1920 // Do updates right now unless deferral was requested
1921 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
1922 DeferredUpdates::doUpdates();
1925 // Return the new revision (or null) to the caller
1926 $status->value['revision'] = $revision;
1928 $hook_args = array( &$this, &$user, $content, $summary,
1929 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId );
1931 ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1932 wfRunHooks( 'PageContentSaveComplete', $hook_args );
1934 // Promote user to any groups they meet the criteria for
1935 $user->addAutopromoteOnceGroups( 'onEdit' );
1937 wfProfileOut( __METHOD__ );
1938 return $status;
1942 * Get parser options suitable for rendering the primary article wikitext
1944 * @see ContentHandler::makeParserOptions
1946 * @param IContextSource|User|string $context One of the following:
1947 * - IContextSource: Use the User and the Language of the provided
1948 * context
1949 * - User: Use the provided User object and $wgLang for the language,
1950 * so use an IContextSource object if possible.
1951 * - 'canonical': Canonical options (anonymous user with default
1952 * preferences and content language).
1953 * @return ParserOptions
1955 public function makeParserOptions( $context ) {
1956 $options = $this->getContentHandler()->makeParserOptions( $context );
1958 if ( $this->getTitle()->isConversionTable() ) {
1959 // @todo ConversionTable should become a separate content model, so we don't need special cases like this one.
1960 $options->disableContentConversion();
1963 return $options;
1967 * Prepare text which is about to be saved.
1968 * Returns a stdclass with source, pst and output members
1970 * @deprecated in 1.21: use prepareContentForEdit instead.
1972 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
1973 ContentHandler::deprecated( __METHOD__, '1.21' );
1974 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1975 return $this->prepareContentForEdit( $content, $revid, $user );
1979 * Prepare content which is about to be saved.
1980 * Returns a stdclass with source, pst and output members
1982 * @param \Content $content
1983 * @param null $revid
1984 * @param null|\User $user
1985 * @param null $serialization_format
1987 * @return bool|object
1989 * @since 1.21
1991 public function prepareContentForEdit( Content $content, $revid = null, User $user = null, $serialization_format = null ) {
1992 global $wgContLang, $wgUser;
1993 $user = is_null( $user ) ? $wgUser : $user;
1994 //XXX: check $user->getId() here???
1996 if ( $this->mPreparedEdit
1997 && $this->mPreparedEdit->newContent
1998 && $this->mPreparedEdit->newContent->equals( $content )
1999 && $this->mPreparedEdit->revid == $revid
2000 && $this->mPreparedEdit->format == $serialization_format
2001 // XXX: also check $user here?
2003 // Already prepared
2004 return $this->mPreparedEdit;
2007 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2008 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2010 $edit = (object)array();
2011 $edit->revid = $revid;
2013 $edit->pstContent = $content ? $content->preSaveTransform( $this->mTitle, $user, $popts ) : null;
2015 $edit->format = $serialization_format;
2016 $edit->popts = $this->makeParserOptions( 'canonical' );
2017 $edit->output = $edit->pstContent ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts ) : null;
2019 $edit->newContent = $content;
2020 $edit->oldContent = $this->getContent( Revision::RAW );
2022 // NOTE: B/C for hooks! don't use these fields!
2023 $edit->newText = $edit->newContent ? ContentHandler::getContentText( $edit->newContent ) : '';
2024 $edit->oldText = $edit->oldContent ? ContentHandler::getContentText( $edit->oldContent ) : '';
2025 $edit->pst = $edit->pstContent ? $edit->pstContent->serialize( $serialization_format ) : '';
2027 $this->mPreparedEdit = $edit;
2028 return $edit;
2032 * Do standard deferred updates after page edit.
2033 * Update links tables, site stats, search index and message cache.
2034 * Purges pages that include this page if the text was changed here.
2035 * Every 100th edit, prune the recent changes table.
2037 * @param $revision Revision object
2038 * @param $user User object that did the revision
2039 * @param array $options of options, following indexes are used:
2040 * - changed: boolean, whether the revision changed the content (default true)
2041 * - created: boolean, whether the revision created the page (default false)
2042 * - oldcountable: boolean or null (default null):
2043 * - boolean: whether the page was counted as an article before that
2044 * revision, only used in changed is true and created is false
2045 * - null: don't change the article count
2047 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2048 global $wgEnableParserCache;
2050 wfProfileIn( __METHOD__ );
2052 $options += array( 'changed' => true, 'created' => false, 'oldcountable' => null );
2053 $content = $revision->getContent();
2055 // Parse the text
2056 // Be careful not to do pre-save transform twice: $text is usually
2057 // already pre-save transformed once.
2058 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2059 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2060 $editInfo = $this->prepareContentForEdit( $content, $revision->getId(), $user );
2061 } else {
2062 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2063 $editInfo = $this->mPreparedEdit;
2066 // Save it to the parser cache
2067 if ( $wgEnableParserCache ) {
2068 $parserCache = ParserCache::singleton();
2069 $parserCache->save( $editInfo->output, $this, $editInfo->popts );
2072 // Update the links tables and other secondary data
2073 if ( $content ) {
2074 $recursive = $options['changed']; // bug 50785
2075 $updates = $content->getSecondaryDataUpdates(
2076 $this->getTitle(), null, $recursive, $editInfo->output );
2077 DataUpdate::runUpdates( $updates );
2080 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2082 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2083 if ( 0 == mt_rand( 0, 99 ) ) {
2084 // Flush old entries from the `recentchanges` table; we do this on
2085 // random requests so as to avoid an increase in writes for no good reason
2086 RecentChange::purgeExpiredChanges();
2090 if ( !$this->exists() ) {
2091 wfProfileOut( __METHOD__ );
2092 return;
2095 $id = $this->getId();
2096 $title = $this->mTitle->getPrefixedDBkey();
2097 $shortTitle = $this->mTitle->getDBkey();
2099 if ( !$options['changed'] ) {
2100 $good = 0;
2101 $total = 0;
2102 } elseif ( $options['created'] ) {
2103 $good = (int)$this->isCountable( $editInfo );
2104 $total = 1;
2105 } elseif ( $options['oldcountable'] !== null ) {
2106 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2107 $total = 0;
2108 } else {
2109 $good = 0;
2110 $total = 0;
2113 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) );
2114 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2116 // If this is another user's talk page, update newtalk.
2117 // Don't do this if $options['changed'] = false (null-edits) nor if
2118 // it's a minor edit and the user doesn't want notifications for those.
2119 if ( $options['changed']
2120 && $this->mTitle->getNamespace() == NS_USER_TALK
2121 && $shortTitle != $user->getTitleKey()
2122 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2124 $recipient = User::newFromName( $shortTitle, false );
2125 if ( !$recipient ) {
2126 wfDebug( __METHOD__ . ": invalid username\n" );
2127 } else {
2128 // Allow extensions to prevent user notification when a new message is added to their talk page
2129 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2130 if ( User::isIP( $shortTitle ) ) {
2131 // An anonymous user
2132 $recipient->setNewtalk( true, $revision );
2133 } elseif ( $recipient->isLoggedIn() ) {
2134 $recipient->setNewtalk( true, $revision );
2135 } else {
2136 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2142 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2143 // XXX: could skip pseudo-messages like js/css here, based on content model.
2144 $msgtext = $content ? $content->getWikitextForTransclusion() : null;
2145 if ( $msgtext === false || $msgtext === null ) {
2146 $msgtext = '';
2149 MessageCache::singleton()->replace( $shortTitle, $msgtext );
2152 if ( $options['created'] ) {
2153 self::onArticleCreate( $this->mTitle );
2154 } else {
2155 self::onArticleEdit( $this->mTitle );
2158 wfProfileOut( __METHOD__ );
2162 * Edit an article without doing all that other stuff
2163 * The article must already exist; link tables etc
2164 * are not updated, caches are not flushed.
2166 * @param string $text text submitted
2167 * @param $user User The relevant user
2168 * @param string $comment comment submitted
2169 * @param $minor Boolean: whereas it's a minor modification
2171 * @deprecated since 1.21, use doEditContent() instead.
2173 public function doQuickEdit( $text, User $user, $comment = '', $minor = 0 ) {
2174 ContentHandler::deprecated( __METHOD__, "1.21" );
2176 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2177 return $this->doQuickEditContent( $content, $user, $comment, $minor );
2181 * Edit an article without doing all that other stuff
2182 * The article must already exist; link tables etc
2183 * are not updated, caches are not flushed.
2185 * @param $content Content: content submitted
2186 * @param $user User The relevant user
2187 * @param string $comment comment submitted
2188 * @param $serialisation_format String: format for storing the content in the database
2189 * @param $minor Boolean: whereas it's a minor modification
2191 public function doQuickEditContent( Content $content, User $user, $comment = '', $minor = 0, $serialisation_format = null ) {
2192 wfProfileIn( __METHOD__ );
2194 $serialized = $content->serialize( $serialisation_format );
2196 $dbw = wfGetDB( DB_MASTER );
2197 $revision = new Revision( array(
2198 'title' => $this->getTitle(), // for determining the default content model
2199 'page' => $this->getId(),
2200 'text' => $serialized,
2201 'length' => $content->getSize(),
2202 'comment' => $comment,
2203 'minor_edit' => $minor ? 1 : 0,
2204 ) ); // XXX: set the content object?
2205 $revision->insertOn( $dbw );
2206 $this->updateRevisionOn( $dbw, $revision );
2208 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2210 wfProfileOut( __METHOD__ );
2214 * Update the article's restriction field, and leave a log entry.
2215 * This works for protection both existing and non-existing pages.
2217 * @param array $limit set of restriction keys
2218 * @param $reason String
2219 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2220 * @param array $expiry per restriction type expiration
2221 * @param $user User The user updating the restrictions
2222 * @return Status
2224 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade, $reason, User $user ) {
2225 global $wgContLang, $wgCascadingRestrictionLevels;
2227 if ( wfReadOnly() ) {
2228 return Status::newFatal( 'readonlytext', wfReadOnlyReason() );
2231 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2233 $id = $this->getId();
2235 if ( !$cascade ) {
2236 $cascade = false;
2239 // Take this opportunity to purge out expired restrictions
2240 Title::purgeExpiredRestrictions();
2242 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2243 // we expect a single selection, but the schema allows otherwise.
2244 $isProtected = false;
2245 $protect = false;
2246 $changed = false;
2248 $dbw = wfGetDB( DB_MASTER );
2250 foreach ( $restrictionTypes as $action ) {
2251 if ( !isset( $expiry[$action] ) ) {
2252 $expiry[$action] = $dbw->getInfinity();
2254 if ( !isset( $limit[$action] ) ) {
2255 $limit[$action] = '';
2256 } elseif ( $limit[$action] != '' ) {
2257 $protect = true;
2260 // Get current restrictions on $action
2261 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2262 if ( $current != '' ) {
2263 $isProtected = true;
2266 if ( $limit[$action] != $current ) {
2267 $changed = true;
2268 } elseif ( $limit[$action] != '' ) {
2269 // Only check expiry change if the action is actually being
2270 // protected, since expiry does nothing on an not-protected
2271 // action.
2272 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2273 $changed = true;
2278 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2279 $changed = true;
2282 // If nothing has changed, do nothing
2283 if ( !$changed ) {
2284 return Status::newGood();
2287 if ( !$protect ) { // No protection at all means unprotection
2288 $revCommentMsg = 'unprotectedarticle';
2289 $logAction = 'unprotect';
2290 } elseif ( $isProtected ) {
2291 $revCommentMsg = 'modifiedarticleprotection';
2292 $logAction = 'modify';
2293 } else {
2294 $revCommentMsg = 'protectedarticle';
2295 $logAction = 'protect';
2298 $encodedExpiry = array();
2299 $protectDescription = '';
2300 # Some bots may parse IRC lines, which are generated from log entries which contain plain
2301 # protect description text. Keep them in old format to avoid breaking compatibility.
2302 # TODO: Fix protection log to store structured description and format it on-the-fly.
2303 $protectDescriptionLog = '';
2304 foreach ( $limit as $action => $restrictions ) {
2305 $encodedExpiry[$action] = $dbw->encodeExpiry( $expiry[$action] );
2306 if ( $restrictions != '' ) {
2307 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] (";
2308 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2309 # All possible message keys are listed here for easier grepping:
2310 # * restriction-create
2311 # * restriction-edit
2312 # * restriction-move
2313 # * restriction-upload
2314 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2315 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2316 # with '' filtered out. All possible message keys are listed below:
2317 # * protect-level-autoconfirmed
2318 # * protect-level-sysop
2319 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2320 if ( $encodedExpiry[$action] != 'infinity' ) {
2321 $expiryText = wfMessage(
2322 'protect-expiring',
2323 $wgContLang->timeanddate( $expiry[$action], false, false ),
2324 $wgContLang->date( $expiry[$action], false, false ),
2325 $wgContLang->time( $expiry[$action], false, false )
2326 )->inContentLanguage()->text();
2327 } else {
2328 $expiryText = wfMessage( 'protect-expiry-indefinite' )
2329 ->inContentLanguage()->text();
2332 if ( $protectDescription !== '' ) {
2333 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2335 $protectDescription .= wfMessage( 'protect-summary-desc' )
2336 ->params( $actionText, $restrictionsText, $expiryText )
2337 ->inContentLanguage()->text();
2338 $protectDescriptionLog .= $expiryText . ') ';
2341 $protectDescriptionLog = trim( $protectDescriptionLog );
2343 if ( $id ) { // Protection of existing page
2344 if ( !wfRunHooks( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2345 return Status::newGood();
2348 // Only certain restrictions can cascade...
2349 $editrestriction = isset( $limit['edit'] ) ? array( $limit['edit'] ) : $this->mTitle->getRestrictions( 'edit' );
2350 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2351 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2353 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2354 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2357 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2358 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2359 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2361 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2362 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2365 // The schema allows multiple restrictions
2366 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2367 $cascade = false;
2370 // Prepare a null revision to be added to the history
2371 $editComment = $wgContLang->ucfirst(
2372 wfMessage(
2373 $revCommentMsg,
2374 $this->mTitle->getPrefixedText()
2375 )->inContentLanguage()->text()
2377 if ( $reason ) {
2378 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2380 if ( $protectDescription ) {
2381 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2382 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )->inContentLanguage()->text();
2384 if ( $cascade ) {
2385 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2386 $editComment .= wfMessage( 'brackets' )->params(
2387 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2388 )->inContentLanguage()->text();
2391 $nullRevision = Revision::newNullRevision( $dbw, $id, $editComment, true );
2392 if ( $nullRevision === null ) {
2393 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2396 // Update restrictions table
2397 foreach ( $limit as $action => $restrictions ) {
2398 if ( $restrictions != '' ) {
2399 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2400 array( 'pr_page' => $id,
2401 'pr_type' => $action,
2402 'pr_level' => $restrictions,
2403 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
2404 'pr_expiry' => $encodedExpiry[$action]
2406 __METHOD__
2408 } else {
2409 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2410 'pr_type' => $action ), __METHOD__ );
2414 // Insert a null revision
2415 $nullRevId = $nullRevision->insertOn( $dbw );
2417 $latest = $this->getLatest();
2418 // Update page record
2419 $dbw->update( 'page',
2420 array( /* SET */
2421 'page_touched' => $dbw->timestamp(),
2422 'page_restrictions' => '',
2423 'page_latest' => $nullRevId
2424 ), array( /* WHERE */
2425 'page_id' => $id
2426 ), __METHOD__
2429 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2430 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2431 } else { // Protection of non-existing page (also known as "title protection")
2432 // Cascade protection is meaningless in this case
2433 $cascade = false;
2435 if ( $limit['create'] != '' ) {
2436 $dbw->replace( 'protected_titles',
2437 array( array( 'pt_namespace', 'pt_title' ) ),
2438 array(
2439 'pt_namespace' => $this->mTitle->getNamespace(),
2440 'pt_title' => $this->mTitle->getDBkey(),
2441 'pt_create_perm' => $limit['create'],
2442 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ),
2443 'pt_expiry' => $encodedExpiry['create'],
2444 'pt_user' => $user->getId(),
2445 'pt_reason' => $reason,
2446 ), __METHOD__
2448 } else {
2449 $dbw->delete( 'protected_titles',
2450 array(
2451 'pt_namespace' => $this->mTitle->getNamespace(),
2452 'pt_title' => $this->mTitle->getDBkey()
2453 ), __METHOD__
2458 $this->mTitle->flushRestrictions();
2459 InfoAction::invalidateCache( $this->mTitle );
2461 if ( $logAction == 'unprotect' ) {
2462 $logParams = array();
2463 } else {
2464 $logParams = array( $protectDescriptionLog, $cascade ? 'cascade' : '' );
2467 // Update the protection log
2468 $log = new LogPage( 'protect' );
2469 $log->addEntry( $logAction, $this->mTitle, trim( $reason ), $logParams, $user );
2471 return Status::newGood();
2475 * Take an array of page restrictions and flatten it to a string
2476 * suitable for insertion into the page_restrictions field.
2477 * @param $limit Array
2478 * @throws MWException
2479 * @return String
2481 protected static function flattenRestrictions( $limit ) {
2482 if ( !is_array( $limit ) ) {
2483 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2486 $bits = array();
2487 ksort( $limit );
2489 foreach ( $limit as $action => $restrictions ) {
2490 if ( $restrictions != '' ) {
2491 $bits[] = "$action=$restrictions";
2495 return implode( ':', $bits );
2499 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2500 * backwards compatibility, if you care about error reporting you should use
2501 * doDeleteArticleReal() instead.
2503 * Deletes the article with database consistency, writes logs, purges caches
2505 * @param string $reason delete reason for deletion log
2506 * @param $suppress boolean suppress all revisions and log the deletion in
2507 * the suppression log instead of the deletion log
2508 * @param int $id article ID
2509 * @param $commit boolean defaults to true, triggers transaction end
2510 * @param &$error Array of errors to append to
2511 * @param $user User The deleting user
2512 * @return boolean true if successful
2514 public function doDeleteArticle(
2515 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2517 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2518 return $status->isGood();
2522 * Back-end article deletion
2523 * Deletes the article with database consistency, writes logs, purges caches
2525 * @since 1.19
2527 * @param string $reason delete reason for deletion log
2528 * @param $suppress boolean suppress all revisions and log the deletion in
2529 * the suppression log instead of the deletion log
2530 * @param int $id article ID
2531 * @param $commit boolean defaults to true, triggers transaction end
2532 * @param &$error Array of errors to append to
2533 * @param $user User The deleting user
2534 * @return Status: Status object; if successful, $status->value is the log_id of the
2535 * deletion log entry. If the page couldn't be deleted because it wasn't
2536 * found, $status is a non-fatal 'cannotdelete' error
2538 public function doDeleteArticleReal(
2539 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2541 global $wgUser, $wgContentHandlerUseDB;
2543 wfDebug( __METHOD__ . "\n" );
2545 $status = Status::newGood();
2547 if ( $this->mTitle->getDBkey() === '' ) {
2548 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2549 return $status;
2552 $user = is_null( $user ) ? $wgUser : $user;
2553 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2554 if ( $status->isOK() ) {
2555 // Hook aborted but didn't set a fatal status
2556 $status->fatal( 'delete-hook-aborted' );
2558 return $status;
2561 if ( $id == 0 ) {
2562 $this->loadPageData( 'forupdate' );
2563 $id = $this->getID();
2564 if ( $id == 0 ) {
2565 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2566 return $status;
2570 // Bitfields to further suppress the content
2571 if ( $suppress ) {
2572 $bitfield = 0;
2573 // This should be 15...
2574 $bitfield |= Revision::DELETED_TEXT;
2575 $bitfield |= Revision::DELETED_COMMENT;
2576 $bitfield |= Revision::DELETED_USER;
2577 $bitfield |= Revision::DELETED_RESTRICTED;
2578 } else {
2579 $bitfield = 'rev_deleted';
2582 // we need to remember the old content so we can use it to generate all deletion updates.
2583 $content = $this->getContent( Revision::RAW );
2585 $dbw = wfGetDB( DB_MASTER );
2586 $dbw->begin( __METHOD__ );
2587 // For now, shunt the revision data into the archive table.
2588 // Text is *not* removed from the text table; bulk storage
2589 // is left intact to avoid breaking block-compression or
2590 // immutable storage schemes.
2592 // For backwards compatibility, note that some older archive
2593 // table entries will have ar_text and ar_flags fields still.
2595 // In the future, we may keep revisions and mark them with
2596 // the rev_deleted field, which is reserved for this purpose.
2598 $row = array(
2599 'ar_namespace' => 'page_namespace',
2600 'ar_title' => 'page_title',
2601 'ar_comment' => 'rev_comment',
2602 'ar_user' => 'rev_user',
2603 'ar_user_text' => 'rev_user_text',
2604 'ar_timestamp' => 'rev_timestamp',
2605 'ar_minor_edit' => 'rev_minor_edit',
2606 'ar_rev_id' => 'rev_id',
2607 'ar_parent_id' => 'rev_parent_id',
2608 'ar_text_id' => 'rev_text_id',
2609 'ar_text' => '\'\'', // Be explicit to appease
2610 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2611 'ar_len' => 'rev_len',
2612 'ar_page_id' => 'page_id',
2613 'ar_deleted' => $bitfield,
2614 'ar_sha1' => 'rev_sha1',
2617 if ( $wgContentHandlerUseDB ) {
2618 $row['ar_content_model'] = 'rev_content_model';
2619 $row['ar_content_format'] = 'rev_content_format';
2622 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2623 $row,
2624 array(
2625 'page_id' => $id,
2626 'page_id = rev_page'
2627 ), __METHOD__
2630 // Now that it's safely backed up, delete it
2631 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
2632 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2634 if ( !$ok ) {
2635 $dbw->rollback( __METHOD__ );
2636 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2637 return $status;
2640 $this->doDeleteUpdates( $id, $content );
2642 // Log the deletion, if the page was suppressed, log it at Oversight instead
2643 $logtype = $suppress ? 'suppress' : 'delete';
2645 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2646 $logEntry->setPerformer( $user );
2647 $logEntry->setTarget( $this->mTitle );
2648 $logEntry->setComment( $reason );
2649 $logid = $logEntry->insert();
2650 $logEntry->publish( $logid );
2652 if ( $commit ) {
2653 $dbw->commit( __METHOD__ );
2656 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2657 $status->value = $logid;
2658 return $status;
2662 * Do some database updates after deletion
2664 * @param int $id page_id value of the page being deleted
2665 * @param $content Content: optional page content to be used when determining the required updates.
2666 * This may be needed because $this->getContent() may already return null when the page proper was deleted.
2668 public function doDeleteUpdates( $id, Content $content = null ) {
2669 // update site status
2670 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2672 // remove secondary indexes, etc
2673 $updates = $this->getDeletionUpdates( $content );
2674 DataUpdate::runUpdates( $updates );
2676 // Clear caches
2677 WikiPage::onArticleDelete( $this->mTitle );
2679 // Reset this object and the Title object
2680 $this->loadFromRow( false, self::READ_LATEST );
2682 // Search engine
2683 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
2687 * Roll back the most recent consecutive set of edits to a page
2688 * from the same user; fails if there are no eligible edits to
2689 * roll back to, e.g. user is the sole contributor. This function
2690 * performs permissions checks on $user, then calls commitRollback()
2691 * to do the dirty work
2693 * @todo Separate the business/permission stuff out from backend code
2695 * @param string $fromP Name of the user whose edits to rollback.
2696 * @param string $summary Custom summary. Set to default summary if empty.
2697 * @param string $token Rollback token.
2698 * @param $bot Boolean: If true, mark all reverted edits as bot.
2700 * @param array $resultDetails contains result-specific array of additional values
2701 * 'alreadyrolled' : 'current' (rev)
2702 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2704 * @param $user User The user performing the rollback
2705 * @return array of errors, each error formatted as
2706 * array(messagekey, param1, param2, ...).
2707 * On success, the array is empty. This array can also be passed to
2708 * OutputPage::showPermissionsErrorPage().
2710 public function doRollback(
2711 $fromP, $summary, $token, $bot, &$resultDetails, User $user
2713 $resultDetails = null;
2715 // Check permissions
2716 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
2717 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
2718 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2720 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
2721 $errors[] = array( 'sessionfailure' );
2724 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
2725 $errors[] = array( 'actionthrottledtext' );
2728 // If there were errors, bail out now
2729 if ( !empty( $errors ) ) {
2730 return $errors;
2733 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2737 * Backend implementation of doRollback(), please refer there for parameter
2738 * and return value documentation
2740 * NOTE: This function does NOT check ANY permissions, it just commits the
2741 * rollback to the DB. Therefore, you should only call this function direct-
2742 * ly if you want to use custom permissions checks. If you don't, use
2743 * doRollback() instead.
2744 * @param string $fromP Name of the user whose edits to rollback.
2745 * @param string $summary Custom summary. Set to default summary if empty.
2746 * @param $bot Boolean: If true, mark all reverted edits as bot.
2748 * @param array $resultDetails contains result-specific array of additional values
2749 * @param $guser User The user performing the rollback
2750 * @return array
2752 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
2753 global $wgUseRCPatrol, $wgContLang;
2755 $dbw = wfGetDB( DB_MASTER );
2757 if ( wfReadOnly() ) {
2758 return array( array( 'readonlytext' ) );
2761 // Get the last editor
2762 $current = $this->getRevision();
2763 if ( is_null( $current ) ) {
2764 // Something wrong... no page?
2765 return array( array( 'notanarticle' ) );
2768 $from = str_replace( '_', ' ', $fromP );
2769 // User name given should match up with the top revision.
2770 // If the user was deleted then $from should be empty.
2771 if ( $from != $current->getUserText() ) {
2772 $resultDetails = array( 'current' => $current );
2773 return array( array( 'alreadyrolled',
2774 htmlspecialchars( $this->mTitle->getPrefixedText() ),
2775 htmlspecialchars( $fromP ),
2776 htmlspecialchars( $current->getUserText() )
2777 ) );
2780 // Get the last edit not by this guy...
2781 // Note: these may not be public values
2782 $user = intval( $current->getRawUser() );
2783 $user_text = $dbw->addQuotes( $current->getRawUserText() );
2784 $s = $dbw->selectRow( 'revision',
2785 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
2786 array( 'rev_page' => $current->getPage(),
2787 "rev_user != {$user} OR rev_user_text != {$user_text}"
2788 ), __METHOD__,
2789 array( 'USE INDEX' => 'page_timestamp',
2790 'ORDER BY' => 'rev_timestamp DESC' )
2792 if ( $s === false ) {
2793 // No one else ever edited this page
2794 return array( array( 'cantrollback' ) );
2795 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT || $s->rev_deleted & Revision::DELETED_USER ) {
2796 // Only admins can see this text
2797 return array( array( 'notvisiblerev' ) );
2800 $set = array();
2801 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
2802 // Mark all reverted edits as bot
2803 $set['rc_bot'] = 1;
2806 if ( $wgUseRCPatrol ) {
2807 // Mark all reverted edits as patrolled
2808 $set['rc_patrolled'] = 1;
2811 if ( count( $set ) ) {
2812 $dbw->update( 'recentchanges', $set,
2813 array( /* WHERE */
2814 'rc_cur_id' => $current->getPage(),
2815 'rc_user_text' => $current->getUserText(),
2816 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
2817 ), __METHOD__
2821 // Generate the edit summary if necessary
2822 $target = Revision::newFromId( $s->rev_id );
2823 if ( empty( $summary ) ) {
2824 if ( $from == '' ) { // no public user name
2825 $summary = wfMessage( 'revertpage-nouser' );
2826 } else {
2827 $summary = wfMessage( 'revertpage' );
2831 // Allow the custom summary to use the same args as the default message
2832 $args = array(
2833 $target->getUserText(), $from, $s->rev_id,
2834 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
2835 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
2837 if ( $summary instanceof Message ) {
2838 $summary = $summary->params( $args )->inContentLanguage()->text();
2839 } else {
2840 $summary = wfMsgReplaceArgs( $summary, $args );
2843 // Trim spaces on user supplied text
2844 $summary = trim( $summary );
2846 // Truncate for whole multibyte characters.
2847 $summary = $wgContLang->truncate( $summary, 255 );
2849 // Save
2850 $flags = EDIT_UPDATE;
2852 if ( $guser->isAllowed( 'minoredit' ) ) {
2853 $flags |= EDIT_MINOR;
2856 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
2857 $flags |= EDIT_FORCE_BOT;
2860 // Actually store the edit
2861 $status = $this->doEditContent( $target->getContent(), $summary, $flags, $target->getId(), $guser );
2863 if ( !$status->isOK() ) {
2864 return $status->getErrorsArray();
2867 if ( !empty( $status->value['revision'] ) ) {
2868 $revId = $status->value['revision']->getId();
2869 } else {
2870 $revId = false;
2873 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
2875 $resultDetails = array(
2876 'summary' => $summary,
2877 'current' => $current,
2878 'target' => $target,
2879 'newid' => $revId
2882 return array();
2886 * The onArticle*() functions are supposed to be a kind of hooks
2887 * which should be called whenever any of the specified actions
2888 * are done.
2890 * This is a good place to put code to clear caches, for instance.
2892 * This is called on page move and undelete, as well as edit
2894 * @param $title Title object
2896 public static function onArticleCreate( $title ) {
2897 // Update existence markers on article/talk tabs...
2898 if ( $title->isTalkPage() ) {
2899 $other = $title->getSubjectPage();
2900 } else {
2901 $other = $title->getTalkPage();
2904 $other->invalidateCache();
2905 $other->purgeSquid();
2907 $title->touchLinks();
2908 $title->purgeSquid();
2909 $title->deleteTitleProtection();
2913 * Clears caches when article is deleted
2915 * @param $title Title
2917 public static function onArticleDelete( $title ) {
2918 // Update existence markers on article/talk tabs...
2919 if ( $title->isTalkPage() ) {
2920 $other = $title->getSubjectPage();
2921 } else {
2922 $other = $title->getTalkPage();
2925 $other->invalidateCache();
2926 $other->purgeSquid();
2928 $title->touchLinks();
2929 $title->purgeSquid();
2931 // File cache
2932 HTMLFileCache::clearFileCache( $title );
2933 InfoAction::invalidateCache( $title );
2935 // Messages
2936 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
2937 MessageCache::singleton()->replace( $title->getDBkey(), false );
2940 // Images
2941 if ( $title->getNamespace() == NS_FILE ) {
2942 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
2943 $update->doUpdate();
2946 // User talk pages
2947 if ( $title->getNamespace() == NS_USER_TALK ) {
2948 $user = User::newFromName( $title->getText(), false );
2949 if ( $user ) {
2950 $user->setNewtalk( false );
2954 // Image redirects
2955 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
2959 * Purge caches on page update etc
2961 * @param $title Title object
2962 * @todo Verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
2964 public static function onArticleEdit( $title ) {
2965 // Invalidate caches of articles which include this page
2966 DeferredUpdates::addHTMLCacheUpdate( $title, 'templatelinks' );
2968 // Invalidate the caches of all pages which redirect here
2969 DeferredUpdates::addHTMLCacheUpdate( $title, 'redirect' );
2971 // Purge squid for this page only
2972 $title->purgeSquid();
2974 // Clear file cache for this page only
2975 HTMLFileCache::clearFileCache( $title );
2976 InfoAction::invalidateCache( $title );
2979 /**#@-*/
2982 * Returns a list of hidden categories this page is a member of.
2983 * Uses the page_props and categorylinks tables.
2985 * @return Array of Title objects
2987 public function getHiddenCategories() {
2988 $result = array();
2989 $id = $this->getId();
2991 if ( $id == 0 ) {
2992 return array();
2995 $dbr = wfGetDB( DB_SLAVE );
2996 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
2997 array( 'cl_to' ),
2998 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
2999 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
3000 __METHOD__ );
3002 if ( $res !== false ) {
3003 foreach ( $res as $row ) {
3004 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3008 return $result;
3012 * Return an applicable autosummary if one exists for the given edit.
3013 * @param string|null $oldtext the previous text of the page.
3014 * @param string|null $newtext The submitted text of the page.
3015 * @param int $flags bitmask: a bitmask of flags submitted for the edit.
3016 * @return string An appropriate autosummary, or an empty string.
3018 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3020 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3021 // NOTE: stub for backwards-compatibility. assumes the given text is wikitext. will break horribly if it isn't.
3023 ContentHandler::deprecated( __METHOD__, '1.21' );
3025 $handler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT );
3026 $oldContent = is_null( $oldtext ) ? null : $handler->unserializeContent( $oldtext );
3027 $newContent = is_null( $newtext ) ? null : $handler->unserializeContent( $newtext );
3029 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3033 * Auto-generates a deletion reason
3035 * @param &$hasHistory Boolean: whether the page has a history
3036 * @return mixed String containing deletion reason or empty string, or boolean false
3037 * if no revision occurred
3039 public function getAutoDeleteReason( &$hasHistory ) {
3040 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3044 * Update all the appropriate counts in the category table, given that
3045 * we've added the categories $added and deleted the categories $deleted.
3047 * @param array $added The names of categories that were added
3048 * @param array $deleted The names of categories that were deleted
3050 public function updateCategoryCounts( array $added, array $deleted ) {
3051 $that = $this;
3052 $method = __METHOD__;
3053 $dbw = wfGetDB( DB_MASTER );
3055 // Do this at the end of the commit to reduce lock wait timeouts
3056 $dbw->onTransactionPreCommitOrIdle(
3057 function() use ( $dbw, $that, $method, $added, $deleted ) {
3058 $ns = $that->getTitle()->getNamespace();
3060 $addFields = array( 'cat_pages = cat_pages + 1' );
3061 $removeFields = array( 'cat_pages = cat_pages - 1' );
3062 if ( $ns == NS_CATEGORY ) {
3063 $addFields[] = 'cat_subcats = cat_subcats + 1';
3064 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3065 } elseif ( $ns == NS_FILE ) {
3066 $addFields[] = 'cat_files = cat_files + 1';
3067 $removeFields[] = 'cat_files = cat_files - 1';
3070 if ( count( $added ) ) {
3071 $insertRows = array();
3072 foreach ( $added as $cat ) {
3073 $insertRows[] = array(
3074 'cat_title' => $cat,
3075 'cat_pages' => 1,
3076 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3077 'cat_files' => ( $ns == NS_FILE ) ? 1 : 0,
3080 $dbw->upsert(
3081 'category',
3082 $insertRows,
3083 array( 'cat_title' ),
3084 $addFields,
3085 $method
3089 if ( count( $deleted ) ) {
3090 $dbw->update(
3091 'category',
3092 $removeFields,
3093 array( 'cat_title' => $deleted ),
3094 $method
3098 foreach ( $added as $catName ) {
3099 $cat = Category::newFromName( $catName );
3100 wfRunHooks( 'CategoryAfterPageAdded', array( $cat, $that ) );
3103 foreach ( $deleted as $catName ) {
3104 $cat = Category::newFromName( $catName );
3105 wfRunHooks( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3112 * Updates cascading protections
3114 * @param $parserOutput ParserOutput object for the current version
3116 public function doCascadeProtectionUpdates( ParserOutput $parserOutput ) {
3117 if ( wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
3118 return;
3121 // templatelinks table may have become out of sync,
3122 // especially if using variable-based transclusions.
3123 // For paranoia, check if things have changed and if
3124 // so apply updates to the database. This will ensure
3125 // that cascaded protections apply as soon as the changes
3126 // are visible.
3128 // Get templates from templatelinks
3129 $id = $this->getId();
3131 $tlTemplates = array();
3133 $dbr = wfGetDB( DB_SLAVE );
3134 $res = $dbr->select( array( 'templatelinks' ),
3135 array( 'tl_namespace', 'tl_title' ),
3136 array( 'tl_from' => $id ),
3137 __METHOD__
3140 foreach ( $res as $row ) {
3141 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
3144 // Get templates from parser output.
3145 $poTemplates = array();
3146 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
3147 foreach ( $templates as $dbk => $id ) {
3148 $poTemplates["$ns:$dbk"] = true;
3152 // Get the diff
3153 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
3155 if ( count( $templates_diff ) > 0 ) {
3156 // Whee, link updates time.
3157 // Note: we are only interested in links here. We don't need to get other DataUpdate items from the parser output.
3158 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
3159 $u->doUpdate();
3164 * Return a list of templates used by this article.
3165 * Uses the templatelinks table
3167 * @deprecated in 1.19; use Title::getTemplateLinksFrom()
3168 * @return Array of Title objects
3170 public function getUsedTemplates() {
3171 return $this->mTitle->getTemplateLinksFrom();
3175 * Perform article updates on a special page creation.
3177 * @param $rev Revision object
3179 * @todo This is a shitty interface function. Kill it and replace the
3180 * other shitty functions like doEditUpdates and such so it's not needed
3181 * anymore.
3182 * @deprecated since 1.18, use doEditUpdates()
3184 public function createUpdates( $rev ) {
3185 wfDeprecated( __METHOD__, '1.18' );
3186 global $wgUser;
3187 $this->doEditUpdates( $rev, $wgUser, array( 'created' => true ) );
3191 * This function is called right before saving the wikitext,
3192 * so we can do things like signatures and links-in-context.
3194 * @deprecated in 1.19; use Parser::preSaveTransform() instead
3195 * @param string $text article contents
3196 * @param $user User object: user doing the edit
3197 * @param $popts ParserOptions object: parser options, default options for
3198 * the user loaded if null given
3199 * @return string article contents with altered wikitext markup (signatures
3200 * converted, {{subst:}}, templates, etc.)
3202 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
3203 global $wgParser, $wgUser;
3205 wfDeprecated( __METHOD__, '1.19' );
3207 $user = is_null( $user ) ? $wgUser : $user;
3209 if ( $popts === null ) {
3210 $popts = ParserOptions::newFromUser( $user );
3213 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
3217 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
3219 * @deprecated in 1.19; use Title::isBigDeletion() instead.
3220 * @return bool
3222 public function isBigDeletion() {
3223 wfDeprecated( __METHOD__, '1.19' );
3224 return $this->mTitle->isBigDeletion();
3228 * Get the approximate revision count of this page.
3230 * @deprecated in 1.19; use Title::estimateRevisionCount() instead.
3231 * @return int
3233 public function estimateRevisionCount() {
3234 wfDeprecated( __METHOD__, '1.19' );
3235 return $this->mTitle->estimateRevisionCount();
3239 * Update the article's restriction field, and leave a log entry.
3241 * @deprecated since 1.19
3242 * @param array $limit set of restriction keys
3243 * @param $reason String
3244 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
3245 * @param array $expiry per restriction type expiration
3246 * @param $user User The user updating the restrictions
3247 * @return bool true on success
3249 public function updateRestrictions(
3250 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
3252 global $wgUser;
3254 $user = is_null( $user ) ? $wgUser : $user;
3256 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3260 * @deprecated since 1.18
3262 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3263 wfDeprecated( __METHOD__, '1.18' );
3264 global $wgUser;
3265 $this->doQuickEdit( $text, $wgUser, $comment, $minor );
3269 * @deprecated since 1.18
3271 public function viewUpdates() {
3272 wfDeprecated( __METHOD__, '1.18' );
3273 global $wgUser;
3274 return $this->doViewUpdates( $wgUser );
3278 * @deprecated since 1.18
3279 * @param $oldid int
3280 * @return bool
3282 public function useParserCache( $oldid ) {
3283 wfDeprecated( __METHOD__, '1.18' );
3284 global $wgUser;
3285 return $this->isParserCacheUsed( ParserOptions::newFromUser( $wgUser ), $oldid );
3289 * Returns a list of updates to be performed when this page is deleted. The updates should remove any information
3290 * about this page from secondary data stores such as links tables.
3292 * @param Content|null $content optional Content object for determining the necessary updates
3293 * @return Array an array of DataUpdates objects
3295 public function getDeletionUpdates( Content $content = null ) {
3296 if ( !$content ) {
3297 // load content object, which may be used to determine the necessary updates
3298 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3299 $content = $this->getContent( Revision::RAW );
3302 if ( !$content ) {
3303 $updates = array();
3304 } else {
3305 $updates = $content->getDeletionUpdates( $this );
3308 wfRunHooks( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );
3309 return $updates;
3314 class PoolWorkArticleView extends PoolCounterWork {
3317 * @var Page
3319 private $page;
3322 * @var string
3324 private $cacheKey;
3327 * @var integer
3329 private $revid;
3332 * @var ParserOptions
3334 private $parserOptions;
3337 * @var Content|null
3339 private $content = null;
3342 * @var ParserOutput|bool
3344 private $parserOutput = false;
3347 * @var bool
3349 private $isDirty = false;
3352 * @var Status|bool
3354 private $error = false;
3357 * Constructor
3359 * @param $page Page
3360 * @param $revid Integer: ID of the revision being parsed
3361 * @param $useParserCache Boolean: whether to use the parser cache
3362 * @param $parserOptions parserOptions to use for the parse operation
3363 * @param $content Content|String: content to parse or null to load it; may also be given as a wikitext string, for BC
3365 function __construct( Page $page, ParserOptions $parserOptions, $revid, $useParserCache, $content = null ) {
3366 if ( is_string( $content ) ) { // BC: old style call
3367 $modelId = $page->getRevision()->getContentModel();
3368 $format = $page->getRevision()->getContentFormat();
3369 $content = ContentHandler::makeContent( $content, $page->getTitle(), $modelId, $format );
3372 $this->page = $page;
3373 $this->revid = $revid;
3374 $this->cacheable = $useParserCache;
3375 $this->parserOptions = $parserOptions;
3376 $this->content = $content;
3377 $this->cacheKey = ParserCache::singleton()->getKey( $page, $parserOptions );
3378 parent::__construct( 'ArticleView', $this->cacheKey . ':revid:' . $revid );
3382 * Get the ParserOutput from this object, or false in case of failure
3384 * @return ParserOutput
3386 public function getParserOutput() {
3387 return $this->parserOutput;
3391 * Get whether the ParserOutput is a dirty one (i.e. expired)
3393 * @return bool
3395 public function getIsDirty() {
3396 return $this->isDirty;
3400 * Get a Status object in case of error or false otherwise
3402 * @return Status|bool
3404 public function getError() {
3405 return $this->error;
3409 * @return bool
3411 function doWork() {
3412 global $wgUseFileCache;
3414 // @todo several of the methods called on $this->page are not declared in Page, but present
3415 // in WikiPage and delegated by Article.
3417 $isCurrent = $this->revid === $this->page->getLatest();
3419 if ( $this->content !== null ) {
3420 $content = $this->content;
3421 } elseif ( $isCurrent ) {
3422 // XXX: why use RAW audience here, and PUBLIC (default) below?
3423 $content = $this->page->getContent( Revision::RAW );
3424 } else {
3425 $rev = Revision::newFromTitle( $this->page->getTitle(), $this->revid );
3427 if ( $rev === null ) {
3428 $content = null;
3429 } else {
3430 // XXX: why use PUBLIC audience here (default), and RAW above?
3431 $content = $rev->getContent();
3435 if ( $content === null ) {
3436 return false;
3439 $time = - microtime( true );
3440 $this->parserOutput = $content->getParserOutput( $this->page->getTitle(), $this->revid, $this->parserOptions );
3441 $time += microtime( true );
3443 // Timing hack
3444 if ( $time > 3 ) {
3445 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
3446 $this->page->getTitle()->getPrefixedDBkey() ) );
3449 if ( $this->cacheable && $this->parserOutput->isCacheable() ) {
3450 ParserCache::singleton()->save( $this->parserOutput, $this->page, $this->parserOptions );
3453 // Make sure file cache is not used on uncacheable content.
3454 // Output that has magic words in it can still use the parser cache
3455 // (if enabled), though it will generally expire sooner.
3456 if ( !$this->parserOutput->isCacheable() || $this->parserOutput->containsOldMagic() ) {
3457 $wgUseFileCache = false;
3460 if ( $isCurrent ) {
3461 $this->page->doCascadeProtectionUpdates( $this->parserOutput );
3464 return true;
3468 * @return bool
3470 function getCachedWork() {
3471 $this->parserOutput = ParserCache::singleton()->get( $this->page, $this->parserOptions );
3473 if ( $this->parserOutput === false ) {
3474 wfDebug( __METHOD__ . ": parser cache miss\n" );
3475 return false;
3476 } else {
3477 wfDebug( __METHOD__ . ": parser cache hit\n" );
3478 return true;
3483 * @return bool
3485 function fallback() {
3486 $this->parserOutput = ParserCache::singleton()->getDirty( $this->page, $this->parserOptions );
3488 if ( $this->parserOutput === false ) {
3489 wfDebugLog( 'dirty', "dirty missing\n" );
3490 wfDebug( __METHOD__ . ": no dirty cache\n" );
3491 return false;
3492 } else {
3493 wfDebug( __METHOD__ . ": sending dirty output\n" );
3494 wfDebugLog( 'dirty', "dirty output {$this->cacheKey}\n" );
3495 $this->isDirty = true;
3496 return true;
3501 * @param $status Status
3502 * @return bool
3504 function error( $status ) {
3505 $this->error = $status;
3506 return false;