Actually format search error Status objects nicely
[mediawiki.git] / includes / WikiPage.php
blobcedbcf94454e2e33f2b839af0c01c7318692ef5b
1 <?php
2 /**
3 * Base representation for a MediaWiki page.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
23 /**
24 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
26 interface Page {
29 /**
30 * Class representing a MediaWiki article and history.
32 * Some fields are public only for backwards-compatibility. Use accessors.
33 * In the past, this class was part of Article.php and everything was public.
35 * @internal documentation reviewed 15 Mar 2010
37 class WikiPage implements Page, IDBAccessObject {
38 // Constants for $mDataLoadedFrom and related
40 /**
41 * @var Title
43 public $mTitle = null;
45 /**@{{
46 * @protected
48 public $mDataLoaded = false; // !< Boolean
49 public $mIsRedirect = false; // !< Boolean
50 public $mLatest = false; // !< Integer (false means "not loaded")
51 /**@}}*/
53 /** @var stdclass Map of cache fields (text, parser output, ect) for a proposed/new edit */
54 public $mPreparedEdit = false;
56 /**
57 * @var int
59 protected $mId = null;
61 /**
62 * @var int One of the READ_* constants
64 protected $mDataLoadedFrom = self::READ_NONE;
66 /**
67 * @var Title
69 protected $mRedirectTarget = null;
71 /**
72 * @var Revision
74 protected $mLastRevision = null;
76 /**
77 * @var string Timestamp of the current revision or empty string if not loaded
79 protected $mTimestamp = '';
81 /**
82 * @var string
84 protected $mTouched = '19700101000000';
86 /**
87 * @var string
89 protected $mLinksUpdated = '19700101000000';
91 /**
92 * @var int|null
94 protected $mCounter = null;
96 /**
97 * Constructor and clear the article
98 * @param Title $title Reference to a Title object.
100 public function __construct( Title $title ) {
101 $this->mTitle = $title;
105 * Create a WikiPage object of the appropriate class for the given title.
107 * @param Title $title
109 * @throws MWException
110 * @return WikiPage Object of the appropriate type
112 public static function factory( Title $title ) {
113 $ns = $title->getNamespace();
115 if ( $ns == NS_MEDIA ) {
116 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
117 } elseif ( $ns < 0 ) {
118 throw new MWException( "Invalid or virtual namespace $ns given." );
121 switch ( $ns ) {
122 case NS_FILE:
123 $page = new WikiFilePage( $title );
124 break;
125 case NS_CATEGORY:
126 $page = new WikiCategoryPage( $title );
127 break;
128 default:
129 $page = new WikiPage( $title );
132 return $page;
136 * Constructor from a page id
138 * @param int $id Article ID to load
139 * @param string|int $from One of the following values:
140 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
141 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
143 * @return WikiPage|null
145 public static function newFromID( $id, $from = 'fromdb' ) {
146 // page id's are never 0 or negative, see bug 61166
147 if ( $id < 1 ) {
148 return null;
151 $from = self::convertSelectType( $from );
152 $db = wfGetDB( $from === self::READ_LATEST ? DB_MASTER : DB_SLAVE );
153 $row = $db->selectRow( 'page', self::selectFields(), array( 'page_id' => $id ), __METHOD__ );
154 if ( !$row ) {
155 return null;
157 return self::newFromRow( $row, $from );
161 * Constructor from a database row
163 * @since 1.20
164 * @param object $row Database row containing at least fields returned by selectFields().
165 * @param string|int $from Source of $data:
166 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
167 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
168 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
169 * @return WikiPage
171 public static function newFromRow( $row, $from = 'fromdb' ) {
172 $page = self::factory( Title::newFromRow( $row ) );
173 $page->loadFromRow( $row, $from );
174 return $page;
178 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
180 * @param object|string|int $type
181 * @return mixed
183 private static function convertSelectType( $type ) {
184 switch ( $type ) {
185 case 'fromdb':
186 return self::READ_NORMAL;
187 case 'fromdbmaster':
188 return self::READ_LATEST;
189 case 'forupdate':
190 return self::READ_LOCKING;
191 default:
192 // It may already be an integer or whatever else
193 return $type;
198 * Returns overrides for action handlers.
199 * Classes listed here will be used instead of the default one when
200 * (and only when) $wgActions[$action] === true. This allows subclasses
201 * to override the default behavior.
203 * @todo Move this UI stuff somewhere else
205 * @return array
207 public function getActionOverrides() {
208 $content_handler = $this->getContentHandler();
209 return $content_handler->getActionOverrides();
213 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
215 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
217 * @return ContentHandler
219 * @since 1.21
221 public function getContentHandler() {
222 return ContentHandler::getForModelID( $this->getContentModel() );
226 * Get the title object of the article
227 * @return Title Title object of this page
229 public function getTitle() {
230 return $this->mTitle;
234 * Clear the object
235 * @return void
237 public function clear() {
238 $this->mDataLoaded = false;
239 $this->mDataLoadedFrom = self::READ_NONE;
241 $this->clearCacheFields();
245 * Clear the object cache fields
246 * @return void
248 protected function clearCacheFields() {
249 $this->mId = null;
250 $this->mCounter = null;
251 $this->mRedirectTarget = null; // Title object if set
252 $this->mLastRevision = null; // Latest revision
253 $this->mTouched = '19700101000000';
254 $this->mLinksUpdated = '19700101000000';
255 $this->mTimestamp = '';
256 $this->mIsRedirect = false;
257 $this->mLatest = false;
258 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
259 // the requested rev ID and content against the cached one for equality. For most
260 // content types, the output should not change during the lifetime of this cache.
261 // Clearing it can cause extra parses on edit for no reason.
265 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
266 * @return void
267 * @since 1.23
269 public function clearPreparedEdit() {
270 $this->mPreparedEdit = false;
274 * Return the list of revision fields that should be selected to create
275 * a new page.
277 * @return array
279 public static function selectFields() {
280 global $wgContentHandlerUseDB;
282 $fields = array(
283 'page_id',
284 'page_namespace',
285 'page_title',
286 'page_restrictions',
287 'page_counter',
288 'page_is_redirect',
289 'page_is_new',
290 'page_random',
291 'page_touched',
292 'page_links_updated',
293 'page_latest',
294 'page_len',
297 if ( $wgContentHandlerUseDB ) {
298 $fields[] = 'page_content_model';
301 return $fields;
305 * Fetch a page record with the given conditions
306 * @param DatabaseBase $dbr
307 * @param array $conditions
308 * @param array $options
309 * @return object|bool Database result resource, or false on failure
311 protected function pageData( $dbr, $conditions, $options = array() ) {
312 $fields = self::selectFields();
314 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
316 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__, $options );
318 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
320 return $row;
324 * Fetch a page record matching the Title object's namespace and title
325 * using a sanitized title string
327 * @param DatabaseBase $dbr
328 * @param Title $title
329 * @param array $options
330 * @return object|bool Database result resource, or false on failure
332 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
333 return $this->pageData( $dbr, array(
334 'page_namespace' => $title->getNamespace(),
335 'page_title' => $title->getDBkey() ), $options );
339 * Fetch a page record matching the requested ID
341 * @param DatabaseBase $dbr
342 * @param int $id
343 * @param array $options
344 * @return object|bool Database result resource, or false on failure
346 public function pageDataFromId( $dbr, $id, $options = array() ) {
347 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
351 * Set the general counter, title etc data loaded from
352 * some source.
354 * @param object|string|int $from One of the following:
355 * - A DB query result object.
356 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
357 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
358 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
359 * using SELECT FOR UPDATE.
361 * @return void
363 public function loadPageData( $from = 'fromdb' ) {
364 $from = self::convertSelectType( $from );
365 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
366 // We already have the data from the correct location, no need to load it twice.
367 return;
370 if ( $from === self::READ_LOCKING ) {
371 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle, array( 'FOR UPDATE' ) );
372 } elseif ( $from === self::READ_LATEST ) {
373 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
374 } elseif ( $from === self::READ_NORMAL ) {
375 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE ), $this->mTitle );
376 // Use a "last rev inserted" timestamp key to diminish the issue of slave lag.
377 // Note that DB also stores the master position in the session and checks it.
378 $touched = $this->getCachedLastEditTime();
379 if ( $touched ) { // key set
380 if ( !$data || $touched > wfTimestamp( TS_MW, $data->page_touched ) ) {
381 $from = self::READ_LATEST;
382 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
385 } else {
386 // No idea from where the caller got this data, assume slave database.
387 $data = $from;
388 $from = self::READ_NORMAL;
391 $this->loadFromRow( $data, $from );
395 * Load the object from a database row
397 * @since 1.20
398 * @param object $data Database row containing at least fields returned by selectFields()
399 * @param string|int $from One of the following:
400 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
401 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
402 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from from
403 * the master DB using SELECT FOR UPDATE
405 public function loadFromRow( $data, $from ) {
406 $lc = LinkCache::singleton();
407 $lc->clearLink( $this->mTitle );
409 if ( $data ) {
410 $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
412 $this->mTitle->loadFromRow( $data );
414 // Old-fashioned restrictions
415 $this->mTitle->loadRestrictions( $data->page_restrictions );
417 $this->mId = intval( $data->page_id );
418 $this->mCounter = intval( $data->page_counter );
419 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
420 $this->mLinksUpdated = wfTimestampOrNull( TS_MW, $data->page_links_updated );
421 $this->mIsRedirect = intval( $data->page_is_redirect );
422 $this->mLatest = intval( $data->page_latest );
423 // Bug 37225: $latest may no longer match the cached latest Revision object.
424 // Double-check the ID of any cached latest Revision object for consistency.
425 if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
426 $this->mLastRevision = null;
427 $this->mTimestamp = '';
429 } else {
430 $lc->addBadLinkObj( $this->mTitle );
432 $this->mTitle->loadFromRow( false );
434 $this->clearCacheFields();
436 $this->mId = 0;
439 $this->mDataLoaded = true;
440 $this->mDataLoadedFrom = self::convertSelectType( $from );
444 * @return int Page ID
446 public function getId() {
447 if ( !$this->mDataLoaded ) {
448 $this->loadPageData();
450 return $this->mId;
454 * @return bool Whether or not the page exists in the database
456 public function exists() {
457 if ( !$this->mDataLoaded ) {
458 $this->loadPageData();
460 return $this->mId > 0;
464 * Check if this page is something we're going to be showing
465 * some sort of sensible content for. If we return false, page
466 * views (plain action=view) will return an HTTP 404 response,
467 * so spiders and robots can know they're following a bad link.
469 * @return bool
471 public function hasViewableContent() {
472 return $this->exists() || $this->mTitle->isAlwaysKnown();
476 * @return int The view count for the page
478 public function getCount() {
479 if ( !$this->mDataLoaded ) {
480 $this->loadPageData();
483 return $this->mCounter;
487 * Tests if the article content represents a redirect
489 * @return bool
491 public function isRedirect() {
492 $content = $this->getContent();
493 if ( !$content ) {
494 return false;
497 return $content->isRedirect();
501 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
503 * Will use the revisions actual content model if the page exists,
504 * and the page's default if the page doesn't exist yet.
506 * @return string
508 * @since 1.21
510 public function getContentModel() {
511 if ( $this->exists() ) {
512 // look at the revision's actual content model
513 $rev = $this->getRevision();
515 if ( $rev !== null ) {
516 return $rev->getContentModel();
517 } else {
518 $title = $this->mTitle->getPrefixedDBkey();
519 wfWarn( "Page $title exists but has no (visible) revisions!" );
523 // use the default model for this page
524 return $this->mTitle->getContentModel();
528 * Loads page_touched and returns a value indicating if it should be used
529 * @return bool true if not a redirect
531 public function checkTouched() {
532 if ( !$this->mDataLoaded ) {
533 $this->loadPageData();
535 return !$this->mIsRedirect;
539 * Get the page_touched field
540 * @return string Containing GMT timestamp
542 public function getTouched() {
543 if ( !$this->mDataLoaded ) {
544 $this->loadPageData();
546 return $this->mTouched;
550 * Get the page_links_updated field
551 * @return string|null Containing GMT timestamp
553 public function getLinksTimestamp() {
554 if ( !$this->mDataLoaded ) {
555 $this->loadPageData();
557 return $this->mLinksUpdated;
561 * Get the page_latest field
562 * @return int rev_id of current revision
564 public function getLatest() {
565 if ( !$this->mDataLoaded ) {
566 $this->loadPageData();
568 return (int)$this->mLatest;
572 * Get the Revision object of the oldest revision
573 * @return Revision|null
575 public function getOldestRevision() {
576 wfProfileIn( __METHOD__ );
578 // Try using the slave database first, then try the master
579 $continue = 2;
580 $db = wfGetDB( DB_SLAVE );
581 $revSelectFields = Revision::selectFields();
583 $row = null;
584 while ( $continue ) {
585 $row = $db->selectRow(
586 array( 'page', 'revision' ),
587 $revSelectFields,
588 array(
589 'page_namespace' => $this->mTitle->getNamespace(),
590 'page_title' => $this->mTitle->getDBkey(),
591 'rev_page = page_id'
593 __METHOD__,
594 array(
595 'ORDER BY' => 'rev_timestamp ASC'
599 if ( $row ) {
600 $continue = 0;
601 } else {
602 $db = wfGetDB( DB_MASTER );
603 $continue--;
607 wfProfileOut( __METHOD__ );
608 return $row ? Revision::newFromRow( $row ) : null;
612 * Loads everything except the text
613 * This isn't necessary for all uses, so it's only done if needed.
615 protected function loadLastEdit() {
616 if ( $this->mLastRevision !== null ) {
617 return; // already loaded
620 $latest = $this->getLatest();
621 if ( !$latest ) {
622 return; // page doesn't exist or is missing page_latest info
625 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always includes the
626 // latest changes committed. This is true even within REPEATABLE-READ transactions, where
627 // S1 normally only sees changes committed before the first S1 SELECT. Thus we need S1 to
628 // also gets the revision row FOR UPDATE; otherwise, it may not find it since a page row
629 // UPDATE and revision row INSERT by S2 may have happened after the first S1 SELECT.
630 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
631 $flags = ( $this->mDataLoadedFrom == self::READ_LOCKING ) ? Revision::READ_LOCKING : 0;
632 $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
633 if ( $revision ) { // sanity
634 $this->setLastEdit( $revision );
639 * Set the latest revision
640 * @param Revision $revision
642 protected function setLastEdit( Revision $revision ) {
643 $this->mLastRevision = $revision;
644 $this->mTimestamp = $revision->getTimestamp();
648 * Get the latest revision
649 * @return Revision|null
651 public function getRevision() {
652 $this->loadLastEdit();
653 if ( $this->mLastRevision ) {
654 return $this->mLastRevision;
656 return null;
660 * Get the content of the current revision. No side-effects...
662 * @param int $audience int One of:
663 * Revision::FOR_PUBLIC to be displayed to all users
664 * Revision::FOR_THIS_USER to be displayed to $wgUser
665 * Revision::RAW get the text regardless of permissions
666 * @param User $user User object to check for, only if FOR_THIS_USER is passed
667 * to the $audience parameter
668 * @return Content|null The content of the current revision
670 * @since 1.21
672 public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) {
673 $this->loadLastEdit();
674 if ( $this->mLastRevision ) {
675 return $this->mLastRevision->getContent( $audience, $user );
677 return null;
681 * Get the text of the current revision. No side-effects...
683 * @param int $audience One of:
684 * Revision::FOR_PUBLIC to be displayed to all users
685 * Revision::FOR_THIS_USER to be displayed to the given user
686 * Revision::RAW get the text regardless of permissions
687 * @param User $user User object to check for, only if FOR_THIS_USER is passed
688 * to the $audience parameter
689 * @return string|bool The text of the current revision
690 * @deprecated since 1.21, getContent() should be used instead.
692 public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
693 ContentHandler::deprecated( __METHOD__, '1.21' );
695 $this->loadLastEdit();
696 if ( $this->mLastRevision ) {
697 return $this->mLastRevision->getText( $audience, $user );
699 return false;
703 * Get the text of the current revision. No side-effects...
705 * @return string|bool The text of the current revision. False on failure
706 * @deprecated since 1.21, getContent() should be used instead.
708 public function getRawText() {
709 ContentHandler::deprecated( __METHOD__, '1.21' );
711 return $this->getText( Revision::RAW );
715 * @return string MW timestamp of last article revision
717 public function getTimestamp() {
718 // Check if the field has been filled by WikiPage::setTimestamp()
719 if ( !$this->mTimestamp ) {
720 $this->loadLastEdit();
723 return wfTimestamp( TS_MW, $this->mTimestamp );
727 * Set the page timestamp (use only to avoid DB queries)
728 * @param string $ts MW timestamp of last article revision
729 * @return void
731 public function setTimestamp( $ts ) {
732 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
736 * @param int $audience One of:
737 * Revision::FOR_PUBLIC to be displayed to all users
738 * Revision::FOR_THIS_USER to be displayed to the given user
739 * Revision::RAW get the text regardless of permissions
740 * @param User $user User object to check for, only if FOR_THIS_USER is passed
741 * to the $audience parameter
742 * @return int user ID for the user that made the last article revision
744 public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
745 $this->loadLastEdit();
746 if ( $this->mLastRevision ) {
747 return $this->mLastRevision->getUser( $audience, $user );
748 } else {
749 return -1;
754 * Get the User object of the user who created the page
755 * @param int $audience One of:
756 * Revision::FOR_PUBLIC to be displayed to all users
757 * Revision::FOR_THIS_USER to be displayed to the given user
758 * Revision::RAW get the text regardless of permissions
759 * @param User $user User object to check for, only if FOR_THIS_USER is passed
760 * to the $audience parameter
761 * @return User|null
763 public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) {
764 $revision = $this->getOldestRevision();
765 if ( $revision ) {
766 $userName = $revision->getUserText( $audience, $user );
767 return User::newFromName( $userName, false );
768 } else {
769 return null;
774 * @param int $audience One of:
775 * Revision::FOR_PUBLIC to be displayed to all users
776 * Revision::FOR_THIS_USER to be displayed to the given user
777 * Revision::RAW get the text regardless of permissions
778 * @param User $user User object to check for, only if FOR_THIS_USER is passed
779 * to the $audience parameter
780 * @return string username of the user that made the last article revision
782 public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
783 $this->loadLastEdit();
784 if ( $this->mLastRevision ) {
785 return $this->mLastRevision->getUserText( $audience, $user );
786 } else {
787 return '';
792 * @param int $audience One of:
793 * Revision::FOR_PUBLIC to be displayed to all users
794 * Revision::FOR_THIS_USER to be displayed to the given user
795 * Revision::RAW get the text regardless of permissions
796 * @param User $user User object to check for, only if FOR_THIS_USER is passed
797 * to the $audience parameter
798 * @return string Comment stored for the last article revision
800 public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) {
801 $this->loadLastEdit();
802 if ( $this->mLastRevision ) {
803 return $this->mLastRevision->getComment( $audience, $user );
804 } else {
805 return '';
810 * Returns true if last revision was marked as "minor edit"
812 * @return bool Minor edit indicator for the last article revision.
814 public function getMinorEdit() {
815 $this->loadLastEdit();
816 if ( $this->mLastRevision ) {
817 return $this->mLastRevision->isMinor();
818 } else {
819 return false;
824 * Get the cached timestamp for the last time the page changed.
825 * This is only used to help handle slave lag by comparing to page_touched.
826 * @return string MW timestamp
828 protected function getCachedLastEditTime() {
829 global $wgMemc;
830 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
831 return $wgMemc->get( $key );
835 * Set the cached timestamp for the last time the page changed.
836 * This is only used to help handle slave lag by comparing to page_touched.
837 * @param string $timestamp
838 * @return void
840 public function setCachedLastEditTime( $timestamp ) {
841 global $wgMemc;
842 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
843 $wgMemc->set( $key, wfTimestamp( TS_MW, $timestamp ), 60 * 15 );
847 * Determine whether a page would be suitable for being counted as an
848 * article in the site_stats table based on the title & its content
850 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
851 * if false, the current database state will be used
852 * @return bool
854 public function isCountable( $editInfo = false ) {
855 global $wgArticleCountMethod;
857 if ( !$this->mTitle->isContentPage() ) {
858 return false;
861 if ( $editInfo ) {
862 $content = $editInfo->pstContent;
863 } else {
864 $content = $this->getContent();
867 if ( !$content || $content->isRedirect() ) {
868 return false;
871 $hasLinks = null;
873 if ( $wgArticleCountMethod === 'link' ) {
874 // nasty special case to avoid re-parsing to detect links
876 if ( $editInfo ) {
877 // ParserOutput::getLinks() is a 2D array of page links, so
878 // to be really correct we would need to recurse in the array
879 // but the main array should only have items in it if there are
880 // links.
881 $hasLinks = (bool)count( $editInfo->output->getLinks() );
882 } else {
883 $hasLinks = (bool)wfGetDB( DB_SLAVE )->selectField( 'pagelinks', 1,
884 array( 'pl_from' => $this->getId() ), __METHOD__ );
888 return $content->isCountable( $hasLinks );
892 * If this page is a redirect, get its target
894 * The target will be fetched from the redirect table if possible.
895 * If this page doesn't have an entry there, call insertRedirect()
896 * @return Title|null Title object, or null if this page is not a redirect
898 public function getRedirectTarget() {
899 if ( !$this->mTitle->isRedirect() ) {
900 return null;
903 if ( $this->mRedirectTarget !== null ) {
904 return $this->mRedirectTarget;
907 // Query the redirect table
908 $dbr = wfGetDB( DB_SLAVE );
909 $row = $dbr->selectRow( 'redirect',
910 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
911 array( 'rd_from' => $this->getId() ),
912 __METHOD__
915 // rd_fragment and rd_interwiki were added later, populate them if empty
916 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
917 $this->mRedirectTarget = Title::makeTitle(
918 $row->rd_namespace, $row->rd_title,
919 $row->rd_fragment, $row->rd_interwiki );
920 return $this->mRedirectTarget;
923 // This page doesn't have an entry in the redirect table
924 $this->mRedirectTarget = $this->insertRedirect();
925 return $this->mRedirectTarget;
929 * Insert an entry for this page into the redirect table.
931 * Don't call this function directly unless you know what you're doing.
932 * @return Title|null Title object or null if not a redirect
934 public function insertRedirect() {
935 // recurse through to only get the final target
936 $content = $this->getContent();
937 $retval = $content ? $content->getUltimateRedirectTarget() : null;
938 if ( !$retval ) {
939 return null;
941 $this->insertRedirectEntry( $retval );
942 return $retval;
946 * Insert or update the redirect table entry for this page to indicate
947 * it redirects to $rt .
948 * @param Title $rt Redirect target
950 public function insertRedirectEntry( $rt ) {
951 $dbw = wfGetDB( DB_MASTER );
952 $dbw->replace( 'redirect', array( 'rd_from' ),
953 array(
954 'rd_from' => $this->getId(),
955 'rd_namespace' => $rt->getNamespace(),
956 'rd_title' => $rt->getDBkey(),
957 'rd_fragment' => $rt->getFragment(),
958 'rd_interwiki' => $rt->getInterwiki(),
960 __METHOD__
965 * Get the Title object or URL this page redirects to
967 * @return bool|Title|string false, Title of in-wiki target, or string with URL
969 public function followRedirect() {
970 return $this->getRedirectURL( $this->getRedirectTarget() );
974 * Get the Title object or URL to use for a redirect. We use Title
975 * objects for same-wiki, non-special redirects and URLs for everything
976 * else.
977 * @param Title $rt Redirect target
978 * @return bool|Title|string false, Title object of local target, or string with URL
980 public function getRedirectURL( $rt ) {
981 if ( !$rt ) {
982 return false;
985 if ( $rt->isExternal() ) {
986 if ( $rt->isLocal() ) {
987 // Offsite wikis need an HTTP redirect.
989 // This can be hard to reverse and may produce loops,
990 // so they may be disabled in the site configuration.
991 $source = $this->mTitle->getFullURL( 'redirect=no' );
992 return $rt->getFullURL( array( 'rdfrom' => $source ) );
993 } else {
994 // External pages pages without "local" bit set are not valid
995 // redirect targets
996 return false;
1000 if ( $rt->isSpecialPage() ) {
1001 // Gotta handle redirects to special pages differently:
1002 // Fill the HTTP response "Location" header and ignore
1003 // the rest of the page we're on.
1005 // Some pages are not valid targets
1006 if ( $rt->isValidRedirectTarget() ) {
1007 return $rt->getFullURL();
1008 } else {
1009 return false;
1013 return $rt;
1017 * Get a list of users who have edited this article, not including the user who made
1018 * the most recent revision, which you can get from $article->getUser() if you want it
1019 * @return UserArrayFromResult
1021 public function getContributors() {
1022 // @todo FIXME: This is expensive; cache this info somewhere.
1024 $dbr = wfGetDB( DB_SLAVE );
1026 if ( $dbr->implicitGroupby() ) {
1027 $realNameField = 'user_real_name';
1028 } else {
1029 $realNameField = 'MIN(user_real_name) AS user_real_name';
1032 $tables = array( 'revision', 'user' );
1034 $fields = array(
1035 'user_id' => 'rev_user',
1036 'user_name' => 'rev_user_text',
1037 $realNameField,
1038 'timestamp' => 'MAX(rev_timestamp)',
1041 $conds = array( 'rev_page' => $this->getId() );
1043 // The user who made the top revision gets credited as "this page was last edited by
1044 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1045 $user = $this->getUser();
1046 if ( $user ) {
1047 $conds[] = "rev_user != $user";
1048 } else {
1049 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1052 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1054 $jconds = array(
1055 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1058 $options = array(
1059 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1060 'ORDER BY' => 'timestamp DESC',
1063 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1064 return new UserArrayFromResult( $res );
1068 * Get the last N authors
1069 * @param int $num Number of revisions to get
1070 * @param int|string $revLatest The latest rev_id, selected from the master (optional)
1071 * @return array Array of authors, duplicates not removed
1073 public function getLastNAuthors( $num, $revLatest = 0 ) {
1074 wfProfileIn( __METHOD__ );
1075 // First try the slave
1076 // If that doesn't have the latest revision, try the master
1077 $continue = 2;
1078 $db = wfGetDB( DB_SLAVE );
1080 do {
1081 $res = $db->select( array( 'page', 'revision' ),
1082 array( 'rev_id', 'rev_user_text' ),
1083 array(
1084 'page_namespace' => $this->mTitle->getNamespace(),
1085 'page_title' => $this->mTitle->getDBkey(),
1086 'rev_page = page_id'
1087 ), __METHOD__,
1088 array(
1089 'ORDER BY' => 'rev_timestamp DESC',
1090 'LIMIT' => $num
1094 if ( !$res ) {
1095 wfProfileOut( __METHOD__ );
1096 return array();
1099 $row = $db->fetchObject( $res );
1101 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
1102 $db = wfGetDB( DB_MASTER );
1103 $continue--;
1104 } else {
1105 $continue = 0;
1107 } while ( $continue );
1109 $authors = array( $row->rev_user_text );
1111 foreach ( $res as $row ) {
1112 $authors[] = $row->rev_user_text;
1115 wfProfileOut( __METHOD__ );
1116 return $authors;
1120 * Should the parser cache be used?
1122 * @param ParserOptions $parserOptions ParserOptions to check
1123 * @param int $oldid
1124 * @return bool
1126 public function isParserCacheUsed( ParserOptions $parserOptions, $oldid ) {
1127 global $wgEnableParserCache;
1129 return $wgEnableParserCache
1130 && $parserOptions->getStubThreshold() == 0
1131 && $this->exists()
1132 && ( $oldid === null || $oldid === 0 || $oldid === $this->getLatest() )
1133 && $this->getContentHandler()->isParserCacheSupported();
1137 * Get a ParserOutput for the given ParserOptions and revision ID.
1138 * The parser cache will be used if possible.
1140 * @since 1.19
1141 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1142 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1143 * get the current revision (default value)
1145 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1147 public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
1148 wfProfileIn( __METHOD__ );
1150 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1151 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1152 if ( $parserOptions->getStubThreshold() ) {
1153 wfIncrStats( 'pcache_miss_stub' );
1156 if ( $useParserCache ) {
1157 $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
1158 if ( $parserOutput !== false ) {
1159 wfProfileOut( __METHOD__ );
1160 return $parserOutput;
1164 if ( $oldid === null || $oldid === 0 ) {
1165 $oldid = $this->getLatest();
1168 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1169 $pool->execute();
1171 wfProfileOut( __METHOD__ );
1173 return $pool->getParserOutput();
1177 * Do standard deferred updates after page view (existing or missing page)
1178 * @param User $user The relevant user
1179 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
1181 public function doViewUpdates( User $user, $oldid = 0 ) {
1182 global $wgDisableCounters;
1183 if ( wfReadOnly() ) {
1184 return;
1187 // Don't update page view counters on views from bot users (bug 14044)
1188 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->exists() ) {
1189 DeferredUpdates::addUpdate( new ViewCountUpdate( $this->getId() ) );
1190 DeferredUpdates::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1193 // Update newtalk / watchlist notification status
1194 $user->clearNotification( $this->mTitle, $oldid );
1198 * Perform the actions of a page purging
1199 * @return bool
1201 public function doPurge() {
1202 global $wgUseSquid;
1204 if ( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1205 return false;
1208 // Invalidate the cache
1209 $this->mTitle->invalidateCache();
1211 if ( $wgUseSquid ) {
1212 // Commit the transaction before the purge is sent
1213 $dbw = wfGetDB( DB_MASTER );
1214 $dbw->commit( __METHOD__ );
1216 // Send purge
1217 $update = SquidUpdate::newSimplePurge( $this->mTitle );
1218 $update->doUpdate();
1221 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1222 // @todo move this logic to MessageCache
1224 if ( $this->exists() ) {
1225 // NOTE: use transclusion text for messages.
1226 // This is consistent with MessageCache::getMsgFromNamespace()
1228 $content = $this->getContent();
1229 $text = $content === null ? null : $content->getWikitextForTransclusion();
1231 if ( $text === null ) {
1232 $text = false;
1234 } else {
1235 $text = false;
1238 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
1240 return true;
1244 * Insert a new empty page record for this article.
1245 * This *must* be followed up by creating a revision
1246 * and running $this->updateRevisionOn( ... );
1247 * or else the record will be left in a funky state.
1248 * Best if all done inside a transaction.
1250 * @param DatabaseBase $dbw
1251 * @return int The newly created page_id key, or false if the title already existed
1253 public function insertOn( $dbw ) {
1254 wfProfileIn( __METHOD__ );
1256 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1257 $dbw->insert( 'page', array(
1258 'page_id' => $page_id,
1259 'page_namespace' => $this->mTitle->getNamespace(),
1260 'page_title' => $this->mTitle->getDBkey(),
1261 'page_counter' => 0,
1262 'page_restrictions' => '',
1263 'page_is_redirect' => 0, // Will set this shortly...
1264 'page_is_new' => 1,
1265 'page_random' => wfRandom(),
1266 'page_touched' => $dbw->timestamp(),
1267 'page_latest' => 0, // Fill this in shortly...
1268 'page_len' => 0, // Fill this in shortly...
1269 ), __METHOD__, 'IGNORE' );
1271 $affected = $dbw->affectedRows();
1273 if ( $affected ) {
1274 $newid = $dbw->insertId();
1275 $this->mId = $newid;
1276 $this->mTitle->resetArticleID( $newid );
1278 wfProfileOut( __METHOD__ );
1280 return $affected ? $newid : false;
1284 * Update the page record to point to a newly saved revision.
1286 * @param DatabaseBase $dbw
1287 * @param Revision $revision For ID number, and text used to set
1288 * length and redirect status fields
1289 * @param int $lastRevision If given, will not overwrite the page field
1290 * when different from the currently set value.
1291 * Giving 0 indicates the new page flag should be set on.
1292 * @param bool $lastRevIsRedirect If given, will optimize adding and
1293 * removing rows in redirect table.
1294 * @return bool true on success, false on failure
1296 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1297 $lastRevIsRedirect = null
1299 global $wgContentHandlerUseDB;
1301 wfProfileIn( __METHOD__ );
1303 $content = $revision->getContent();
1304 $len = $content ? $content->getSize() : 0;
1305 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1307 $conditions = array( 'page_id' => $this->getId() );
1309 if ( !is_null( $lastRevision ) ) {
1310 // An extra check against threads stepping on each other
1311 $conditions['page_latest'] = $lastRevision;
1314 $now = wfTimestampNow();
1315 $row = array( /* SET */
1316 'page_latest' => $revision->getId(),
1317 'page_touched' => $dbw->timestamp( $now ),
1318 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
1319 'page_is_redirect' => $rt !== null ? 1 : 0,
1320 'page_len' => $len,
1323 if ( $wgContentHandlerUseDB ) {
1324 $row['page_content_model'] = $revision->getContentModel();
1327 $dbw->update( 'page',
1328 $row,
1329 $conditions,
1330 __METHOD__ );
1332 $result = $dbw->affectedRows() > 0;
1333 if ( $result ) {
1334 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1335 $this->setLastEdit( $revision );
1336 $this->setCachedLastEditTime( $now );
1337 $this->mLatest = $revision->getId();
1338 $this->mIsRedirect = (bool)$rt;
1339 // Update the LinkCache.
1340 LinkCache::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle, $len, $this->mIsRedirect,
1341 $this->mLatest, $revision->getContentModel() );
1344 wfProfileOut( __METHOD__ );
1345 return $result;
1349 * Add row to the redirect table if this is a redirect, remove otherwise.
1351 * @param DatabaseBase $dbw
1352 * @param Title $redirectTitle Title object pointing to the redirect target,
1353 * or NULL if this is not a redirect
1354 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1355 * removing rows in redirect table.
1356 * @return bool true on success, false on failure
1357 * @private
1359 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1360 // Always update redirects (target link might have changed)
1361 // Update/Insert if we don't know if the last revision was a redirect or not
1362 // Delete if changing from redirect to non-redirect
1363 $isRedirect = !is_null( $redirectTitle );
1365 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1366 return true;
1369 wfProfileIn( __METHOD__ );
1370 if ( $isRedirect ) {
1371 $this->insertRedirectEntry( $redirectTitle );
1372 } else {
1373 // This is not a redirect, remove row from redirect table
1374 $where = array( 'rd_from' => $this->getId() );
1375 $dbw->delete( 'redirect', $where, __METHOD__ );
1378 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1379 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1381 wfProfileOut( __METHOD__ );
1383 return ( $dbw->affectedRows() != 0 );
1387 * If the given revision is newer than the currently set page_latest,
1388 * update the page record. Otherwise, do nothing.
1390 * @deprecated since 1.24, use updateRevisionOn instead
1392 * @param DatabaseBase $dbw
1393 * @param Revision $revision
1394 * @return bool
1396 public function updateIfNewerOn( $dbw, $revision ) {
1397 wfProfileIn( __METHOD__ );
1399 $row = $dbw->selectRow(
1400 array( 'revision', 'page' ),
1401 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1402 array(
1403 'page_id' => $this->getId(),
1404 'page_latest=rev_id' ),
1405 __METHOD__ );
1407 if ( $row ) {
1408 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1409 wfProfileOut( __METHOD__ );
1410 return false;
1412 $prev = $row->rev_id;
1413 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1414 } else {
1415 // No or missing previous revision; mark the page as new
1416 $prev = 0;
1417 $lastRevIsRedirect = null;
1420 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1422 wfProfileOut( __METHOD__ );
1423 return $ret;
1427 * Get the content that needs to be saved in order to undo all revisions
1428 * between $undo and $undoafter. Revisions must belong to the same page,
1429 * must exist and must not be deleted
1430 * @param Revision $undo
1431 * @param Revision $undoafter Must be an earlier revision than $undo
1432 * @return mixed string on success, false on failure
1433 * @since 1.21
1434 * Before we had the Content object, this was done in getUndoText
1436 public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1437 $handler = $undo->getContentHandler();
1438 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1442 * Get the text that needs to be saved in order to undo all revisions
1443 * between $undo and $undoafter. Revisions must belong to the same page,
1444 * must exist and must not be deleted
1445 * @param Revision $undo
1446 * @param Revision $undoafter Must be an earlier revision than $undo
1447 * @return string|bool string on success, false on failure
1448 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1450 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
1451 ContentHandler::deprecated( __METHOD__, '1.21' );
1453 $this->loadLastEdit();
1455 if ( $this->mLastRevision ) {
1456 if ( is_null( $undoafter ) ) {
1457 $undoafter = $undo->getPrevious();
1460 $handler = $this->getContentHandler();
1461 $undone = $handler->getUndoContent( $this->mLastRevision, $undo, $undoafter );
1463 if ( !$undone ) {
1464 return false;
1465 } else {
1466 return ContentHandler::getContentText( $undone );
1470 return false;
1474 * @param string|null|bool $section Null/false, a section number (0, 1, 2, T1, T2, ...) or "new".
1475 * @param string $text New text of the section.
1476 * @param string $sectionTitle New section's subject, only if $section is "new".
1477 * @param string $edittime Revision timestamp or null to use the current revision.
1479 * @throws MWException
1480 * @return string New complete article text, or null if error.
1482 * @deprecated since 1.21, use replaceSectionAtRev() instead
1484 public function replaceSection( $section, $text, $sectionTitle = '',
1485 $edittime = null
1487 ContentHandler::deprecated( __METHOD__, '1.21' );
1489 //NOTE: keep condition in sync with condition in replaceSectionContent!
1490 if ( strval( $section ) == '' ) {
1491 // Whole-page edit; let the whole text through
1492 return $text;
1495 if ( !$this->supportsSections() ) {
1496 throw new MWException( "sections not supported for content model " .
1497 $this->getContentHandler()->getModelID() );
1500 // could even make section title, but that's not required.
1501 $sectionContent = ContentHandler::makeContent( $text, $this->getTitle() );
1503 $newContent = $this->replaceSectionContent( $section, $sectionContent, $sectionTitle,
1504 $edittime );
1506 return ContentHandler::getContentText( $newContent );
1510 * Returns true if this page's content model supports sections.
1512 * @return bool
1514 * @todo The skin should check this and not offer section functionality if
1515 * sections are not supported.
1516 * @todo The EditPage should check this and not offer section functionality
1517 * if sections are not supported.
1519 public function supportsSections() {
1520 return $this->getContentHandler()->supportsSections();
1524 * @param string|null|bool $section Null/false, a section number (0, 1, 2, T1, T2, ...) or "new".
1525 * @param Content $sectionContent New content of the section.
1526 * @param string $sectionTitle New section's subject, only if $section is "new".
1527 * @param string $edittime Revision timestamp or null to use the current revision.
1529 * @throws MWException
1530 * @return Content New complete article content, or null if error.
1532 * @since 1.21
1533 * @deprecated since 1.24, use replaceSectionAtRev instead
1535 public function replaceSectionContent( $section, Content $sectionContent, $sectionTitle = '',
1536 $edittime = null ) {
1537 wfProfileIn( __METHOD__ );
1539 $baseRevId = null;
1540 if ( $edittime && $section !== 'new' ) {
1541 $dbw = wfGetDB( DB_MASTER );
1542 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1543 if ( $rev ) {
1544 $baseRevId = $rev->getId();
1548 wfProfileOut( __METHOD__ );
1549 return $this->replaceSectionAtRev( $section, $sectionContent, $sectionTitle, $baseRevId );
1553 * @param string|null|bool $section Null/false, a section number (0, 1, 2, T1, T2, ...) or "new".
1554 * @param Content $sectionContent New content of the section.
1555 * @param string $sectionTitle New section's subject, only if $section is "new".
1556 * @param string $baseRevId integer|null
1558 * @throws MWException
1559 * @return Content New complete article content, or null if error.
1561 * @since 1.24
1563 public function replaceSectionAtRev( $section, Content $sectionContent,
1564 $sectionTitle = '', $baseRevId = null
1566 wfProfileIn( __METHOD__ );
1568 if ( strval( $section ) == '' ) {
1569 // Whole-page edit; let the whole text through
1570 $newContent = $sectionContent;
1571 } else {
1572 if ( !$this->supportsSections() ) {
1573 wfProfileOut( __METHOD__ );
1574 throw new MWException( "sections not supported for content model " .
1575 $this->getContentHandler()->getModelID() );
1578 // Bug 30711: always use current version when adding a new section
1579 if ( is_null( $baseRevId ) || $section == 'new' ) {
1580 $oldContent = $this->getContent();
1581 } else {
1582 // TODO: try DB_SLAVE first
1583 $dbw = wfGetDB( DB_MASTER );
1584 $rev = Revision::loadFromId( $dbw, $baseRevId );
1586 if ( !$rev ) {
1587 wfDebug( __METHOD__ . " asked for bogus section (page: " .
1588 $this->getId() . "; section: $section)\n" );
1589 wfProfileOut( __METHOD__ );
1590 return null;
1593 $oldContent = $rev->getContent();
1596 if ( ! $oldContent ) {
1597 wfDebug( __METHOD__ . ": no page text\n" );
1598 wfProfileOut( __METHOD__ );
1599 return null;
1602 $newContent = $oldContent->replaceSection( $section, $sectionContent, $sectionTitle );
1605 wfProfileOut( __METHOD__ );
1606 return $newContent;
1610 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1611 * @param int $flags
1612 * @return int Updated $flags
1614 public function checkFlags( $flags ) {
1615 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1616 if ( $this->exists() ) {
1617 $flags |= EDIT_UPDATE;
1618 } else {
1619 $flags |= EDIT_NEW;
1623 return $flags;
1627 * Change an existing article or create a new article. Updates RC and all necessary caches,
1628 * optionally via the deferred update array.
1630 * @param string $text New text
1631 * @param string $summary Edit summary
1632 * @param int $flags Bitfield:
1633 * EDIT_NEW
1634 * Article is known or assumed to be non-existent, create a new one
1635 * EDIT_UPDATE
1636 * Article is known or assumed to be pre-existing, update it
1637 * EDIT_MINOR
1638 * Mark this edit minor, if the user is allowed to do so
1639 * EDIT_SUPPRESS_RC
1640 * Do not log the change in recentchanges
1641 * EDIT_FORCE_BOT
1642 * Mark the edit a "bot" edit regardless of user rights
1643 * EDIT_DEFER_UPDATES
1644 * Defer some of the updates until the end of index.php
1645 * EDIT_AUTOSUMMARY
1646 * Fill in blank summaries with generated text where possible
1648 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1649 * article will be detected. If EDIT_UPDATE is specified and the article
1650 * doesn't exist, the function will return an edit-gone-missing error. If
1651 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1652 * error will be returned. These two conditions are also possible with
1653 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1655 * @param bool|int $baseRevId The revision ID this edit was based off, if any
1656 * @param User $user The user doing the edit
1658 * @throws MWException
1659 * @return Status object. Possible errors:
1660 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1661 * set the fatal flag of $status
1662 * edit-gone-missing: In update mode, but the article didn't exist.
1663 * edit-conflict: In update mode, the article changed unexpectedly.
1664 * edit-no-change: Warning that the text was the same as before.
1665 * edit-already-exists: In creation mode, but the article already exists.
1667 * Extensions may define additional errors.
1669 * $return->value will contain an associative array with members as follows:
1670 * new: Boolean indicating if the function attempted to create a new article.
1671 * revision: The revision object for the inserted revision, or null.
1673 * Compatibility note: this function previously returned a boolean value
1674 * indicating success/failure
1676 * @deprecated since 1.21: use doEditContent() instead.
1678 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1679 ContentHandler::deprecated( __METHOD__, '1.21' );
1681 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1683 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1687 * Change an existing article or create a new article. Updates RC and all necessary caches,
1688 * optionally via the deferred update array.
1690 * @param Content $content New content
1691 * @param string $summary Edit summary
1692 * @param int $flags Bitfield:
1693 * EDIT_NEW
1694 * Article is known or assumed to be non-existent, create a new one
1695 * EDIT_UPDATE
1696 * Article is known or assumed to be pre-existing, update it
1697 * EDIT_MINOR
1698 * Mark this edit minor, if the user is allowed to do so
1699 * EDIT_SUPPRESS_RC
1700 * Do not log the change in recentchanges
1701 * EDIT_FORCE_BOT
1702 * Mark the edit a "bot" edit regardless of user rights
1703 * EDIT_DEFER_UPDATES
1704 * Defer some of the updates until the end of index.php
1705 * EDIT_AUTOSUMMARY
1706 * Fill in blank summaries with generated text where possible
1708 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1709 * article will be detected. If EDIT_UPDATE is specified and the article
1710 * doesn't exist, the function will return an edit-gone-missing error. If
1711 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1712 * error will be returned. These two conditions are also possible with
1713 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1715 * @param bool|int $baseRevId The revision ID this edit was based off, if any
1716 * @param User $user The user doing the edit
1717 * @param string $serialisation_format Format for storing the content in the
1718 * database.
1720 * @throws MWException
1721 * @return Status object. Possible errors:
1722 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1723 * set the fatal flag of $status.
1724 * edit-gone-missing: In update mode, but the article didn't exist.
1725 * edit-conflict: In update mode, the article changed unexpectedly.
1726 * edit-no-change: Warning that the text was the same as before.
1727 * edit-already-exists: In creation mode, but the article already exists.
1729 * Extensions may define additional errors.
1731 * $return->value will contain an associative array with members as follows:
1732 * new: Boolean indicating if the function attempted to create a new article.
1733 * revision: The revision object for the inserted revision, or null.
1735 * @since 1.21
1737 public function doEditContent( Content $content, $summary, $flags = 0, $baseRevId = false,
1738 User $user = null, $serialisation_format = null
1740 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1742 // Low-level sanity check
1743 if ( $this->mTitle->getText() === '' ) {
1744 throw new MWException( 'Something is trying to edit an article with an empty title' );
1747 wfProfileIn( __METHOD__ );
1749 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1750 wfProfileOut( __METHOD__ );
1751 return Status::newFatal( 'content-not-allowed-here',
1752 ContentHandler::getLocalizedName( $content->getModel() ),
1753 $this->getTitle()->getPrefixedText() );
1756 $user = is_null( $user ) ? $wgUser : $user;
1757 $status = Status::newGood( array() );
1759 // Load the data from the master database if needed.
1760 // The caller may already loaded it from the master or even loaded it using
1761 // SELECT FOR UPDATE, so do not override that using clear().
1762 $this->loadPageData( 'fromdbmaster' );
1764 $flags = $this->checkFlags( $flags );
1766 // handle hook
1767 $hook_args = array( &$this, &$user, &$content, &$summary,
1768 $flags & EDIT_MINOR, null, null, &$flags, &$status );
1770 if ( !wfRunHooks( 'PageContentSave', $hook_args )
1771 || !ContentHandler::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1773 wfDebug( __METHOD__ . ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1775 if ( $status->isOK() ) {
1776 $status->fatal( 'edit-hook-aborted' );
1779 wfProfileOut( __METHOD__ );
1780 return $status;
1783 // Silently ignore EDIT_MINOR if not allowed
1784 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
1785 $bot = $flags & EDIT_FORCE_BOT;
1787 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1789 $oldsize = $old_content ? $old_content->getSize() : 0;
1790 $oldid = $this->getLatest();
1791 $oldIsRedirect = $this->isRedirect();
1792 $oldcountable = $this->isCountable();
1794 $handler = $content->getContentHandler();
1796 // Provide autosummaries if one is not provided and autosummaries are enabled.
1797 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
1798 if ( !$old_content ) {
1799 $old_content = null;
1801 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1804 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialisation_format );
1805 $serialized = $editInfo->pst;
1808 * @var Content $content
1810 $content = $editInfo->pstContent;
1811 $newsize = $content->getSize();
1813 $dbw = wfGetDB( DB_MASTER );
1814 $now = wfTimestampNow();
1815 $this->mTimestamp = $now;
1817 if ( $flags & EDIT_UPDATE ) {
1818 // Update article, but only if changed.
1819 $status->value['new'] = false;
1821 if ( !$oldid ) {
1822 // Article gone missing
1823 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
1824 $status->fatal( 'edit-gone-missing' );
1826 wfProfileOut( __METHOD__ );
1827 return $status;
1828 } elseif ( !$old_content ) {
1829 // Sanity check for bug 37225
1830 wfProfileOut( __METHOD__ );
1831 throw new MWException( "Could not find text for current revision {$oldid}." );
1834 $revision = new Revision( array(
1835 'page' => $this->getId(),
1836 'title' => $this->getTitle(), // for determining the default content model
1837 'comment' => $summary,
1838 'minor_edit' => $isminor,
1839 'text' => $serialized,
1840 'len' => $newsize,
1841 'parent_id' => $oldid,
1842 'user' => $user->getId(),
1843 'user_text' => $user->getName(),
1844 'timestamp' => $now,
1845 'content_model' => $content->getModel(),
1846 'content_format' => $serialisation_format,
1847 ) ); // XXX: pass content object?!
1849 $changed = !$content->equals( $old_content );
1851 if ( $changed ) {
1852 if ( !$content->isValid() ) {
1853 wfProfileOut( __METHOD__ );
1854 throw new MWException( "New content failed validity check!" );
1857 $dbw->begin( __METHOD__ );
1858 try {
1860 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1861 $status->merge( $prepStatus );
1863 if ( !$status->isOK() ) {
1864 $dbw->rollback( __METHOD__ );
1866 wfProfileOut( __METHOD__ );
1867 return $status;
1869 $revisionId = $revision->insertOn( $dbw );
1871 // Update page
1873 // We check for conflicts by comparing $oldid with the current latest revision ID.
1874 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1876 if ( !$ok ) {
1877 // Belated edit conflict! Run away!!
1878 $status->fatal( 'edit-conflict' );
1880 $dbw->rollback( __METHOD__ );
1882 wfProfileOut( __METHOD__ );
1883 return $status;
1886 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1887 // Update recentchanges
1888 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1889 // Mark as patrolled if the user can do so
1890 $patrolled = $wgUseRCPatrol && !count(
1891 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1892 // Add RC row to the DB
1893 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
1894 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1895 $revisionId, $patrolled
1898 // Log auto-patrolled edits
1899 if ( $patrolled ) {
1900 PatrolLog::record( $rc, true, $user );
1903 $user->incEditCount();
1904 } catch ( MWException $e ) {
1905 $dbw->rollback( __METHOD__ );
1906 // Question: Would it perhaps be better if this method turned all
1907 // exceptions into $status's?
1908 throw $e;
1910 $dbw->commit( __METHOD__ );
1911 } else {
1912 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1913 // related variables correctly
1914 $revision->setId( $this->getLatest() );
1917 // Update links tables, site stats, etc.
1918 $this->doEditUpdates(
1919 $revision,
1920 $user,
1921 array(
1922 'changed' => $changed,
1923 'oldcountable' => $oldcountable
1927 if ( !$changed ) {
1928 $status->warning( 'edit-no-change' );
1929 $revision = null;
1930 // Update page_touched, this is usually implicit in the page update
1931 // Other cache updates are done in onArticleEdit()
1932 $this->mTitle->invalidateCache();
1934 } else {
1935 // Create new article
1936 $status->value['new'] = true;
1938 $dbw->begin( __METHOD__ );
1939 try {
1941 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1942 $status->merge( $prepStatus );
1944 if ( !$status->isOK() ) {
1945 $dbw->rollback( __METHOD__ );
1947 wfProfileOut( __METHOD__ );
1948 return $status;
1951 $status->merge( $prepStatus );
1953 // Add the page record; stake our claim on this title!
1954 // This will return false if the article already exists
1955 $newid = $this->insertOn( $dbw );
1957 if ( $newid === false ) {
1958 $dbw->rollback( __METHOD__ );
1959 $status->fatal( 'edit-already-exists' );
1961 wfProfileOut( __METHOD__ );
1962 return $status;
1965 // Save the revision text...
1966 $revision = new Revision( array(
1967 'page' => $newid,
1968 'title' => $this->getTitle(), // for determining the default content model
1969 'comment' => $summary,
1970 'minor_edit' => $isminor,
1971 'text' => $serialized,
1972 'len' => $newsize,
1973 'user' => $user->getId(),
1974 'user_text' => $user->getName(),
1975 'timestamp' => $now,
1976 'content_model' => $content->getModel(),
1977 'content_format' => $serialisation_format,
1978 ) );
1979 $revisionId = $revision->insertOn( $dbw );
1981 // Bug 37225: use accessor to get the text as Revision may trim it
1982 $content = $revision->getContent(); // sanity; get normalized version
1984 if ( $content ) {
1985 $newsize = $content->getSize();
1988 // Update the page record with revision data
1989 $this->updateRevisionOn( $dbw, $revision, 0 );
1991 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1993 // Update recentchanges
1994 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1995 // Mark as patrolled if the user can do so
1996 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
1997 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1998 // Add RC row to the DB
1999 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
2000 '', $newsize, $revisionId, $patrolled );
2002 // Log auto-patrolled edits
2003 if ( $patrolled ) {
2004 PatrolLog::record( $rc, true, $user );
2007 $user->incEditCount();
2009 } catch ( MWException $e ) {
2010 $dbw->rollback( __METHOD__ );
2011 throw $e;
2013 $dbw->commit( __METHOD__ );
2015 // Update links, etc.
2016 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
2018 $hook_args = array( &$this, &$user, $content, $summary,
2019 $flags & EDIT_MINOR, null, null, &$flags, $revision );
2021 ContentHandler::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
2022 wfRunHooks( 'PageContentInsertComplete', $hook_args );
2025 // Do updates right now unless deferral was requested
2026 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
2027 DeferredUpdates::doUpdates();
2030 // Return the new revision (or null) to the caller
2031 $status->value['revision'] = $revision;
2033 $hook_args = array( &$this, &$user, $content, $summary,
2034 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId );
2036 ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
2037 wfRunHooks( 'PageContentSaveComplete', $hook_args );
2039 // Promote user to any groups they meet the criteria for
2040 $user->addAutopromoteOnceGroups( 'onEdit' );
2042 wfProfileOut( __METHOD__ );
2043 return $status;
2047 * Get parser options suitable for rendering the primary article wikitext
2049 * @see ContentHandler::makeParserOptions
2051 * @param IContextSource|User|string $context One of the following:
2052 * - IContextSource: Use the User and the Language of the provided
2053 * context
2054 * - User: Use the provided User object and $wgLang for the language,
2055 * so use an IContextSource object if possible.
2056 * - 'canonical': Canonical options (anonymous user with default
2057 * preferences and content language).
2058 * @return ParserOptions
2060 public function makeParserOptions( $context ) {
2061 $options = $this->getContentHandler()->makeParserOptions( $context );
2063 if ( $this->getTitle()->isConversionTable() ) {
2064 // @todo ConversionTable should become a separate content model, so
2065 // we don't need special cases like this one.
2066 $options->disableContentConversion();
2069 return $options;
2073 * Prepare text which is about to be saved.
2074 * Returns a stdclass with source, pst and output members
2076 * @deprecated since 1.21: use prepareContentForEdit instead.
2077 * @return object
2079 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
2080 ContentHandler::deprecated( __METHOD__, '1.21' );
2081 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2082 return $this->prepareContentForEdit( $content, $revid, $user );
2086 * Prepare content which is about to be saved.
2087 * Returns a stdclass with source, pst and output members
2089 * @param Content $content
2090 * @param int|null $revid
2091 * @param User|null $user
2092 * @param string|null $serialization_format
2094 * @return bool|object
2096 * @since 1.21
2098 public function prepareContentForEdit( Content $content, $revid = null, User $user = null,
2099 $serialization_format = null
2101 global $wgContLang, $wgUser;
2102 $user = is_null( $user ) ? $wgUser : $user;
2103 //XXX: check $user->getId() here???
2105 // Use a sane default for $serialization_format, see bug 57026
2106 if ( $serialization_format === null ) {
2107 $serialization_format = $content->getContentHandler()->getDefaultFormat();
2110 if ( $this->mPreparedEdit
2111 && $this->mPreparedEdit->newContent
2112 && $this->mPreparedEdit->newContent->equals( $content )
2113 && $this->mPreparedEdit->revid == $revid
2114 && $this->mPreparedEdit->format == $serialization_format
2115 // XXX: also check $user here?
2117 // Already prepared
2118 return $this->mPreparedEdit;
2121 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2122 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2124 $edit = (object)array();
2125 $edit->revid = $revid;
2126 $edit->timestamp = wfTimestampNow();
2128 $edit->pstContent = $content ? $content->preSaveTransform( $this->mTitle, $user, $popts ) : null;
2130 $edit->format = $serialization_format;
2131 $edit->popts = $this->makeParserOptions( 'canonical' );
2132 $edit->output = $edit->pstContent
2133 ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts )
2134 : null;
2136 $edit->newContent = $content;
2137 $edit->oldContent = $this->getContent( Revision::RAW );
2139 // NOTE: B/C for hooks! don't use these fields!
2140 $edit->newText = $edit->newContent ? ContentHandler::getContentText( $edit->newContent ) : '';
2141 $edit->oldText = $edit->oldContent ? ContentHandler::getContentText( $edit->oldContent ) : '';
2142 $edit->pst = $edit->pstContent ? $edit->pstContent->serialize( $serialization_format ) : '';
2144 $this->mPreparedEdit = $edit;
2145 return $edit;
2149 * Do standard deferred updates after page edit.
2150 * Update links tables, site stats, search index and message cache.
2151 * Purges pages that include this page if the text was changed here.
2152 * Every 100th edit, prune the recent changes table.
2154 * @param Revision $revision
2155 * @param User $user User object that did the revision
2156 * @param array $options Array of options, following indexes are used:
2157 * - changed: boolean, whether the revision changed the content (default true)
2158 * - created: boolean, whether the revision created the page (default false)
2159 * - oldcountable: boolean or null (default null):
2160 * - boolean: whether the page was counted as an article before that
2161 * revision, only used in changed is true and created is false
2162 * - null: don't change the article count
2164 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2165 global $wgEnableParserCache;
2167 wfProfileIn( __METHOD__ );
2169 $options += array( 'changed' => true, 'created' => false, 'oldcountable' => null );
2170 $content = $revision->getContent();
2172 // Parse the text
2173 // Be careful not to do pre-save transform twice: $text is usually
2174 // already pre-save transformed once.
2175 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2176 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2177 $editInfo = $this->prepareContentForEdit( $content, $revision->getId(), $user );
2178 } else {
2179 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2180 $editInfo = $this->mPreparedEdit;
2183 // Save it to the parser cache
2184 if ( $wgEnableParserCache ) {
2185 $parserCache = ParserCache::singleton();
2186 $parserCache->save(
2187 $editInfo->output, $this, $editInfo->popts, $editInfo->timestamp, $editInfo->revid
2191 // Update the links tables and other secondary data
2192 if ( $content ) {
2193 $recursive = $options['changed']; // bug 50785
2194 $updates = $content->getSecondaryDataUpdates(
2195 $this->getTitle(), null, $recursive, $editInfo->output );
2196 DataUpdate::runUpdates( $updates );
2199 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2201 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2202 if ( 0 == mt_rand( 0, 99 ) ) {
2203 // Flush old entries from the `recentchanges` table; we do this on
2204 // random requests so as to avoid an increase in writes for no good reason
2205 RecentChange::purgeExpiredChanges();
2209 if ( !$this->exists() ) {
2210 wfProfileOut( __METHOD__ );
2211 return;
2214 $id = $this->getId();
2215 $title = $this->mTitle->getPrefixedDBkey();
2216 $shortTitle = $this->mTitle->getDBkey();
2218 if ( !$options['changed'] ) {
2219 $good = 0;
2220 } elseif ( $options['created'] ) {
2221 $good = (int)$this->isCountable( $editInfo );
2222 } elseif ( $options['oldcountable'] !== null ) {
2223 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2224 } else {
2225 $good = 0;
2227 $edits = $options['changed'] ? 1 : 0;
2228 $total = $options['created'] ? 1 : 0;
2230 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2231 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2233 // If this is another user's talk page, update newtalk.
2234 // Don't do this if $options['changed'] = false (null-edits) nor if
2235 // it's a minor edit and the user doesn't want notifications for those.
2236 if ( $options['changed']
2237 && $this->mTitle->getNamespace() == NS_USER_TALK
2238 && $shortTitle != $user->getTitleKey()
2239 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2241 $recipient = User::newFromName( $shortTitle, false );
2242 if ( !$recipient ) {
2243 wfDebug( __METHOD__ . ": invalid username\n" );
2244 } else {
2245 // Allow extensions to prevent user notification when a new message is added to their talk page
2246 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2247 if ( User::isIP( $shortTitle ) ) {
2248 // An anonymous user
2249 $recipient->setNewtalk( true, $revision );
2250 } elseif ( $recipient->isLoggedIn() ) {
2251 $recipient->setNewtalk( true, $revision );
2252 } else {
2253 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2259 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2260 // XXX: could skip pseudo-messages like js/css here, based on content model.
2261 $msgtext = $content ? $content->getWikitextForTransclusion() : null;
2262 if ( $msgtext === false || $msgtext === null ) {
2263 $msgtext = '';
2266 MessageCache::singleton()->replace( $shortTitle, $msgtext );
2269 if ( $options['created'] ) {
2270 self::onArticleCreate( $this->mTitle );
2271 } elseif ( $options['changed'] ) { // bug 50785
2272 self::onArticleEdit( $this->mTitle );
2275 wfProfileOut( __METHOD__ );
2279 * Edit an article without doing all that other stuff
2280 * The article must already exist; link tables etc
2281 * are not updated, caches are not flushed.
2283 * @param string $text Text submitted
2284 * @param User $user The relevant user
2285 * @param string $comment Comment submitted
2286 * @param bool $minor Whereas it's a minor modification
2288 * @deprecated since 1.21, use doEditContent() instead.
2290 public function doQuickEdit( $text, User $user, $comment = '', $minor = 0 ) {
2291 ContentHandler::deprecated( __METHOD__, "1.21" );
2293 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2294 $this->doQuickEditContent( $content, $user, $comment, $minor );
2298 * Edit an article without doing all that other stuff
2299 * The article must already exist; link tables etc
2300 * are not updated, caches are not flushed.
2302 * @param Content $content Content submitted
2303 * @param User $user The relevant user
2304 * @param string $comment comment submitted
2305 * @param string $serialisation_format Format for storing the content in the database
2306 * @param bool $minor Whereas it's a minor modification
2308 public function doQuickEditContent( Content $content, User $user, $comment = '', $minor = false,
2309 $serialisation_format = null
2311 wfProfileIn( __METHOD__ );
2313 $serialized = $content->serialize( $serialisation_format );
2315 $dbw = wfGetDB( DB_MASTER );
2316 $revision = new Revision( array(
2317 'title' => $this->getTitle(), // for determining the default content model
2318 'page' => $this->getId(),
2319 'user_text' => $user->getName(),
2320 'user' => $user->getId(),
2321 'text' => $serialized,
2322 'length' => $content->getSize(),
2323 'comment' => $comment,
2324 'minor_edit' => $minor ? 1 : 0,
2325 ) ); // XXX: set the content object?
2326 $revision->insertOn( $dbw );
2327 $this->updateRevisionOn( $dbw, $revision );
2329 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2331 wfProfileOut( __METHOD__ );
2335 * Update the article's restriction field, and leave a log entry.
2336 * This works for protection both existing and non-existing pages.
2338 * @param array $limit Set of restriction keys
2339 * @param array $expiry Per restriction type expiration
2340 * @param int &$cascade Set to false if cascading protection isn't allowed.
2341 * @param string $reason
2342 * @param User $user The user updating the restrictions
2343 * @return Status
2345 public function doUpdateRestrictions( array $limit, array $expiry,
2346 &$cascade, $reason, User $user
2348 global $wgCascadingRestrictionLevels, $wgContLang;
2350 if ( wfReadOnly() ) {
2351 return Status::newFatal( 'readonlytext', wfReadOnlyReason() );
2354 $this->loadPageData( 'fromdbmaster' );
2355 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2356 $id = $this->getId();
2358 if ( !$cascade ) {
2359 $cascade = false;
2362 // Take this opportunity to purge out expired restrictions
2363 Title::purgeExpiredRestrictions();
2365 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2366 // we expect a single selection, but the schema allows otherwise.
2367 $isProtected = false;
2368 $protect = false;
2369 $changed = false;
2371 $dbw = wfGetDB( DB_MASTER );
2373 foreach ( $restrictionTypes as $action ) {
2374 if ( !isset( $expiry[$action] ) ) {
2375 $expiry[$action] = $dbw->getInfinity();
2377 if ( !isset( $limit[$action] ) ) {
2378 $limit[$action] = '';
2379 } elseif ( $limit[$action] != '' ) {
2380 $protect = true;
2383 // Get current restrictions on $action
2384 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2385 if ( $current != '' ) {
2386 $isProtected = true;
2389 if ( $limit[$action] != $current ) {
2390 $changed = true;
2391 } elseif ( $limit[$action] != '' ) {
2392 // Only check expiry change if the action is actually being
2393 // protected, since expiry does nothing on an not-protected
2394 // action.
2395 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2396 $changed = true;
2401 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2402 $changed = true;
2405 // If nothing has changed, do nothing
2406 if ( !$changed ) {
2407 return Status::newGood();
2410 if ( !$protect ) { // No protection at all means unprotection
2411 $revCommentMsg = 'unprotectedarticle';
2412 $logAction = 'unprotect';
2413 } elseif ( $isProtected ) {
2414 $revCommentMsg = 'modifiedarticleprotection';
2415 $logAction = 'modify';
2416 } else {
2417 $revCommentMsg = 'protectedarticle';
2418 $logAction = 'protect';
2421 // Truncate for whole multibyte characters
2422 $reason = $wgContLang->truncate( $reason, 255 );
2424 $logRelationsValues = array();
2425 $logRelationsField = null;
2427 if ( $id ) { // Protection of existing page
2428 if ( !wfRunHooks( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2429 return Status::newGood();
2432 // Only certain restrictions can cascade...
2433 $editrestriction = isset( $limit['edit'] )
2434 ? array( $limit['edit'] )
2435 : $this->mTitle->getRestrictions( 'edit' );
2436 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2437 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2439 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2440 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2443 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2444 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2445 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2447 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2448 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2451 // The schema allows multiple restrictions
2452 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2453 $cascade = false;
2456 // insert null revision to identify the page protection change as edit summary
2457 $latest = $this->getLatest();
2458 $nullRevision = $this->insertProtectNullRevision(
2459 $revCommentMsg,
2460 $limit,
2461 $expiry,
2462 $cascade,
2463 $reason,
2464 $user
2467 if ( $nullRevision === null ) {
2468 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2471 $logRelationsField = 'pr_id';
2473 // Update restrictions table
2474 foreach ( $limit as $action => $restrictions ) {
2475 $dbw->delete(
2476 'page_restrictions',
2477 array(
2478 'pr_page' => $id,
2479 'pr_type' => $action
2481 __METHOD__
2483 if ( $restrictions != '' ) {
2484 $dbw->insert(
2485 'page_restrictions',
2486 array(
2487 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2488 'pr_page' => $id,
2489 'pr_type' => $action,
2490 'pr_level' => $restrictions,
2491 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
2492 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2494 __METHOD__
2496 $logRelationsValues[] = $dbw->insertId();
2500 // Clear out legacy restriction fields
2501 $dbw->update(
2502 'page',
2503 array( 'page_restrictions' => '' ),
2504 array( 'page_id' => $id ),
2505 __METHOD__
2508 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2509 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2510 } else { // Protection of non-existing page (also known as "title protection")
2511 // Cascade protection is meaningless in this case
2512 $cascade = false;
2514 if ( $limit['create'] != '' ) {
2515 $dbw->replace( 'protected_titles',
2516 array( array( 'pt_namespace', 'pt_title' ) ),
2517 array(
2518 'pt_namespace' => $this->mTitle->getNamespace(),
2519 'pt_title' => $this->mTitle->getDBkey(),
2520 'pt_create_perm' => $limit['create'],
2521 'pt_timestamp' => $dbw->timestamp(),
2522 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2523 'pt_user' => $user->getId(),
2524 'pt_reason' => $reason,
2525 ), __METHOD__
2527 } else {
2528 $dbw->delete( 'protected_titles',
2529 array(
2530 'pt_namespace' => $this->mTitle->getNamespace(),
2531 'pt_title' => $this->mTitle->getDBkey()
2532 ), __METHOD__
2537 $this->mTitle->flushRestrictions();
2538 InfoAction::invalidateCache( $this->mTitle );
2540 if ( $logAction == 'unprotect' ) {
2541 $params = array();
2542 } else {
2543 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2544 $params = array( $protectDescriptionLog, $cascade ? 'cascade' : '' );
2547 // Update the protection log
2548 $log = new LogPage( 'protect' );
2549 $logId = $log->addEntry( $logAction, $this->mTitle, $reason, $params, $user );
2550 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2551 $log->addRelations( $logRelationsField, $logRelationsValues, $logId );
2554 return Status::newGood();
2558 * Insert a new null revision for this page.
2560 * @param string $revCommentMsg Comment message key for the revision
2561 * @param array $limit Set of restriction keys
2562 * @param array $expiry Per restriction type expiration
2563 * @param int $cascade Set to false if cascading protection isn't allowed.
2564 * @param string $reason
2565 * @param User|null $user
2566 * @return Revision|null Null on error
2568 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2569 array $expiry, $cascade, $reason, $user = null
2571 global $wgContLang;
2572 $dbw = wfGetDB( DB_MASTER );
2574 // Prepare a null revision to be added to the history
2575 $editComment = $wgContLang->ucfirst(
2576 wfMessage(
2577 $revCommentMsg,
2578 $this->mTitle->getPrefixedText()
2579 )->inContentLanguage()->text()
2581 if ( $reason ) {
2582 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2584 $protectDescription = $this->protectDescription( $limit, $expiry );
2585 if ( $protectDescription ) {
2586 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2587 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2588 ->inContentLanguage()->text();
2590 if ( $cascade ) {
2591 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2592 $editComment .= wfMessage( 'brackets' )->params(
2593 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2594 )->inContentLanguage()->text();
2597 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2598 if ( $nullRev ) {
2599 $nullRev->insertOn( $dbw );
2601 // Update page record and touch page
2602 $oldLatest = $nullRev->getParentId();
2603 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2606 return $nullRev;
2610 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2611 * @return string
2613 protected function formatExpiry( $expiry ) {
2614 global $wgContLang;
2615 $dbr = wfGetDB( DB_SLAVE );
2617 $encodedExpiry = $dbr->encodeExpiry( $expiry );
2618 if ( $encodedExpiry != 'infinity' ) {
2619 return wfMessage(
2620 'protect-expiring',
2621 $wgContLang->timeanddate( $expiry, false, false ),
2622 $wgContLang->date( $expiry, false, false ),
2623 $wgContLang->time( $expiry, false, false )
2624 )->inContentLanguage()->text();
2625 } else {
2626 return wfMessage( 'protect-expiry-indefinite' )
2627 ->inContentLanguage()->text();
2632 * Builds the description to serve as comment for the edit.
2634 * @param array $limit Set of restriction keys
2635 * @param array $expiry Per restriction type expiration
2636 * @return string
2638 public function protectDescription( array $limit, array $expiry ) {
2639 $protectDescription = '';
2641 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2642 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2643 # All possible message keys are listed here for easier grepping:
2644 # * restriction-create
2645 # * restriction-edit
2646 # * restriction-move
2647 # * restriction-upload
2648 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2649 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2650 # with '' filtered out. All possible message keys are listed below:
2651 # * protect-level-autoconfirmed
2652 # * protect-level-sysop
2653 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2655 $expiryText = $this->formatExpiry( $expiry[$action] );
2657 if ( $protectDescription !== '' ) {
2658 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2660 $protectDescription .= wfMessage( 'protect-summary-desc' )
2661 ->params( $actionText, $restrictionsText, $expiryText )
2662 ->inContentLanguage()->text();
2665 return $protectDescription;
2669 * Builds the description to serve as comment for the log entry.
2671 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2672 * protect description text. Keep them in old format to avoid breaking compatibility.
2673 * TODO: Fix protection log to store structured description and format it on-the-fly.
2675 * @param array $limit Set of restriction keys
2676 * @param array $expiry Per restriction type expiration
2677 * @return string
2679 public function protectDescriptionLog( array $limit, array $expiry ) {
2680 global $wgContLang;
2682 $protectDescriptionLog = '';
2684 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2685 $expiryText = $this->formatExpiry( $expiry[$action] );
2686 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] ($expiryText)";
2689 return trim( $protectDescriptionLog );
2693 * Take an array of page restrictions and flatten it to a string
2694 * suitable for insertion into the page_restrictions field.
2696 * @param string[] $limit
2698 * @throws MWException
2699 * @return string
2701 protected static function flattenRestrictions( $limit ) {
2702 if ( !is_array( $limit ) ) {
2703 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2706 $bits = array();
2707 ksort( $limit );
2709 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2710 $bits[] = "$action=$restrictions";
2713 return implode( ':', $bits );
2717 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2718 * backwards compatibility, if you care about error reporting you should use
2719 * doDeleteArticleReal() instead.
2721 * Deletes the article with database consistency, writes logs, purges caches
2723 * @param string $reason Delete reason for deletion log
2724 * @param bool $suppress Suppress all revisions and log the deletion in
2725 * the suppression log instead of the deletion log
2726 * @param int $id Article ID
2727 * @param bool $commit Defaults to true, triggers transaction end
2728 * @param array &$error Array of errors to append to
2729 * @param User $user The deleting user
2730 * @return bool true if successful
2732 public function doDeleteArticle(
2733 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2735 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2736 return $status->isGood();
2740 * Back-end article deletion
2741 * Deletes the article with database consistency, writes logs, purges caches
2743 * @since 1.19
2745 * @param string $reason Delete reason for deletion log
2746 * @param bool $suppress Suppress all revisions and log the deletion in
2747 * the suppression log instead of the deletion log
2748 * @param int $id Article ID
2749 * @param bool $commit Defaults to true, triggers transaction end
2750 * @param array &$error Array of errors to append to
2751 * @param User $user The deleting user
2752 * @return Status Status object; if successful, $status->value is the log_id of the
2753 * deletion log entry. If the page couldn't be deleted because it wasn't
2754 * found, $status is a non-fatal 'cannotdelete' error
2756 public function doDeleteArticleReal(
2757 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2759 global $wgUser, $wgContentHandlerUseDB;
2761 wfDebug( __METHOD__ . "\n" );
2763 $status = Status::newGood();
2765 if ( $this->mTitle->getDBkey() === '' ) {
2766 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2767 return $status;
2770 $user = is_null( $user ) ? $wgUser : $user;
2771 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2772 if ( $status->isOK() ) {
2773 // Hook aborted but didn't set a fatal status
2774 $status->fatal( 'delete-hook-aborted' );
2776 return $status;
2779 $dbw = wfGetDB( DB_MASTER );
2780 $dbw->begin( __METHOD__ );
2782 if ( $id == 0 ) {
2783 $this->loadPageData( 'forupdate' );
2784 $id = $this->getID();
2785 if ( $id == 0 ) {
2786 $dbw->rollback( __METHOD__ );
2787 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2788 return $status;
2792 // we need to remember the old content so we can use it to generate all deletion updates.
2793 $content = $this->getContent( Revision::RAW );
2795 // Bitfields to further suppress the content
2796 if ( $suppress ) {
2797 $bitfield = 0;
2798 // This should be 15...
2799 $bitfield |= Revision::DELETED_TEXT;
2800 $bitfield |= Revision::DELETED_COMMENT;
2801 $bitfield |= Revision::DELETED_USER;
2802 $bitfield |= Revision::DELETED_RESTRICTED;
2803 } else {
2804 $bitfield = 'rev_deleted';
2807 // For now, shunt the revision data into the archive table.
2808 // Text is *not* removed from the text table; bulk storage
2809 // is left intact to avoid breaking block-compression or
2810 // immutable storage schemes.
2812 // For backwards compatibility, note that some older archive
2813 // table entries will have ar_text and ar_flags fields still.
2815 // In the future, we may keep revisions and mark them with
2816 // the rev_deleted field, which is reserved for this purpose.
2818 $row = array(
2819 'ar_namespace' => 'page_namespace',
2820 'ar_title' => 'page_title',
2821 'ar_comment' => 'rev_comment',
2822 'ar_user' => 'rev_user',
2823 'ar_user_text' => 'rev_user_text',
2824 'ar_timestamp' => 'rev_timestamp',
2825 'ar_minor_edit' => 'rev_minor_edit',
2826 'ar_rev_id' => 'rev_id',
2827 'ar_parent_id' => 'rev_parent_id',
2828 'ar_text_id' => 'rev_text_id',
2829 'ar_text' => '\'\'', // Be explicit to appease
2830 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2831 'ar_len' => 'rev_len',
2832 'ar_page_id' => 'page_id',
2833 'ar_deleted' => $bitfield,
2834 'ar_sha1' => 'rev_sha1',
2837 if ( $wgContentHandlerUseDB ) {
2838 $row['ar_content_model'] = 'rev_content_model';
2839 $row['ar_content_format'] = 'rev_content_format';
2842 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2843 $row,
2844 array(
2845 'page_id' => $id,
2846 'page_id = rev_page'
2847 ), __METHOD__
2850 // Now that it's safely backed up, delete it
2851 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
2852 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2854 if ( !$ok ) {
2855 $dbw->rollback( __METHOD__ );
2856 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2857 return $status;
2860 if ( !$dbw->cascadingDeletes() ) {
2861 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
2864 // Clone the title, so we have the information we need when we log
2865 $logTitle = clone $this->mTitle;
2867 $this->doDeleteUpdates( $id, $content );
2869 // Log the deletion, if the page was suppressed, log it at Oversight instead
2870 $logtype = $suppress ? 'suppress' : 'delete';
2872 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2873 $logEntry->setPerformer( $user );
2874 $logEntry->setTarget( $logTitle );
2875 $logEntry->setComment( $reason );
2876 $logid = $logEntry->insert();
2878 $dbw->onTransactionPreCommitOrIdle( function() use ( $dbw, $logEntry, $logid ) {
2879 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2880 $logEntry->publish( $logid );
2881 } );
2883 if ( $commit ) {
2884 $dbw->commit( __METHOD__ );
2887 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2888 $status->value = $logid;
2889 return $status;
2893 * Do some database updates after deletion
2895 * @param int $id page_id value of the page being deleted
2896 * @param Content $content Optional page content to be used when determining
2897 * the required updates. This may be needed because $this->getContent()
2898 * may already return null when the page proper was deleted.
2900 public function doDeleteUpdates( $id, Content $content = null ) {
2901 // update site status
2902 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2904 // remove secondary indexes, etc
2905 $updates = $this->getDeletionUpdates( $content );
2906 DataUpdate::runUpdates( $updates );
2908 // Reparse any pages transcluding this page
2909 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
2911 // Reparse any pages including this image
2912 if ( $this->mTitle->getNamespace() == NS_FILE ) {
2913 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
2916 // Clear caches
2917 WikiPage::onArticleDelete( $this->mTitle );
2919 // Reset this object and the Title object
2920 $this->loadFromRow( false, self::READ_LATEST );
2922 // Search engine
2923 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
2927 * Roll back the most recent consecutive set of edits to a page
2928 * from the same user; fails if there are no eligible edits to
2929 * roll back to, e.g. user is the sole contributor. This function
2930 * performs permissions checks on $user, then calls commitRollback()
2931 * to do the dirty work
2933 * @todo Separate the business/permission stuff out from backend code
2935 * @param string $fromP Name of the user whose edits to rollback.
2936 * @param string $summary Custom summary. Set to default summary if empty.
2937 * @param string $token Rollback token.
2938 * @param bool $bot If true, mark all reverted edits as bot.
2940 * @param array $resultDetails contains result-specific array of additional values
2941 * 'alreadyrolled' : 'current' (rev)
2942 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2944 * @param User $user The user performing the rollback
2945 * @return array Array of errors, each error formatted as
2946 * array(messagekey, param1, param2, ...).
2947 * On success, the array is empty. This array can also be passed to
2948 * OutputPage::showPermissionsErrorPage().
2950 public function doRollback(
2951 $fromP, $summary, $token, $bot, &$resultDetails, User $user
2953 $resultDetails = null;
2955 // Check permissions
2956 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
2957 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
2958 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2960 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
2961 $errors[] = array( 'sessionfailure' );
2964 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
2965 $errors[] = array( 'actionthrottledtext' );
2968 // If there were errors, bail out now
2969 if ( !empty( $errors ) ) {
2970 return $errors;
2973 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2977 * Backend implementation of doRollback(), please refer there for parameter
2978 * and return value documentation
2980 * NOTE: This function does NOT check ANY permissions, it just commits the
2981 * rollback to the DB. Therefore, you should only call this function direct-
2982 * ly if you want to use custom permissions checks. If you don't, use
2983 * doRollback() instead.
2984 * @param string $fromP Name of the user whose edits to rollback.
2985 * @param string $summary Custom summary. Set to default summary if empty.
2986 * @param bool $bot If true, mark all reverted edits as bot.
2988 * @param array $resultDetails Contains result-specific array of additional values
2989 * @param User $guser The user performing the rollback
2990 * @return array
2992 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
2993 global $wgUseRCPatrol, $wgContLang;
2995 $dbw = wfGetDB( DB_MASTER );
2997 if ( wfReadOnly() ) {
2998 return array( array( 'readonlytext' ) );
3001 // Get the last editor
3002 $current = $this->getRevision();
3003 if ( is_null( $current ) ) {
3004 // Something wrong... no page?
3005 return array( array( 'notanarticle' ) );
3008 $from = str_replace( '_', ' ', $fromP );
3009 // User name given should match up with the top revision.
3010 // If the user was deleted then $from should be empty.
3011 if ( $from != $current->getUserText() ) {
3012 $resultDetails = array( 'current' => $current );
3013 return array( array( 'alreadyrolled',
3014 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3015 htmlspecialchars( $fromP ),
3016 htmlspecialchars( $current->getUserText() )
3017 ) );
3020 // Get the last edit not by this guy...
3021 // Note: these may not be public values
3022 $user = intval( $current->getRawUser() );
3023 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3024 $s = $dbw->selectRow( 'revision',
3025 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3026 array( 'rev_page' => $current->getPage(),
3027 "rev_user != {$user} OR rev_user_text != {$user_text}"
3028 ), __METHOD__,
3029 array( 'USE INDEX' => 'page_timestamp',
3030 'ORDER BY' => 'rev_timestamp DESC' )
3032 if ( $s === false ) {
3033 // No one else ever edited this page
3034 return array( array( 'cantrollback' ) );
3035 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT
3036 || $s->rev_deleted & Revision::DELETED_USER
3038 // Only admins can see this text
3039 return array( array( 'notvisiblerev' ) );
3042 // Set patrolling and bot flag on the edits, which gets rollbacked.
3043 // This is done before the rollback edit to have patrolling also on failure (bug 62157).
3044 $set = array();
3045 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3046 // Mark all reverted edits as bot
3047 $set['rc_bot'] = 1;
3050 if ( $wgUseRCPatrol ) {
3051 // Mark all reverted edits as patrolled
3052 $set['rc_patrolled'] = 1;
3055 if ( count( $set ) ) {
3056 $dbw->update( 'recentchanges', $set,
3057 array( /* WHERE */
3058 'rc_cur_id' => $current->getPage(),
3059 'rc_user_text' => $current->getUserText(),
3060 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3061 ), __METHOD__
3065 // Generate the edit summary if necessary
3066 $target = Revision::newFromId( $s->rev_id );
3067 if ( empty( $summary ) ) {
3068 if ( $from == '' ) { // no public user name
3069 $summary = wfMessage( 'revertpage-nouser' );
3070 } else {
3071 $summary = wfMessage( 'revertpage' );
3075 // Allow the custom summary to use the same args as the default message
3076 $args = array(
3077 $target->getUserText(), $from, $s->rev_id,
3078 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3079 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3081 if ( $summary instanceof Message ) {
3082 $summary = $summary->params( $args )->inContentLanguage()->text();
3083 } else {
3084 $summary = wfMsgReplaceArgs( $summary, $args );
3087 // Trim spaces on user supplied text
3088 $summary = trim( $summary );
3090 // Truncate for whole multibyte characters.
3091 $summary = $wgContLang->truncate( $summary, 255 );
3093 // Save
3094 $flags = EDIT_UPDATE;
3096 if ( $guser->isAllowed( 'minoredit' ) ) {
3097 $flags |= EDIT_MINOR;
3100 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3101 $flags |= EDIT_FORCE_BOT;
3104 // Actually store the edit
3105 $status = $this->doEditContent(
3106 $target->getContent(),
3107 $summary,
3108 $flags,
3109 $target->getId(),
3110 $guser
3113 if ( !$status->isOK() ) {
3114 return $status->getErrorsArray();
3117 // raise error, when the edit is an edit without a new version
3118 if ( empty( $status->value['revision'] ) ) {
3119 $resultDetails = array( 'current' => $current );
3120 return array( array( 'alreadyrolled',
3121 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3122 htmlspecialchars( $fromP ),
3123 htmlspecialchars( $current->getUserText() )
3124 ) );
3127 $revId = $status->value['revision']->getId();
3129 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3131 $resultDetails = array(
3132 'summary' => $summary,
3133 'current' => $current,
3134 'target' => $target,
3135 'newid' => $revId
3138 return array();
3142 * The onArticle*() functions are supposed to be a kind of hooks
3143 * which should be called whenever any of the specified actions
3144 * are done.
3146 * This is a good place to put code to clear caches, for instance.
3148 * This is called on page move and undelete, as well as edit
3150 * @param Title $title
3152 public static function onArticleCreate( $title ) {
3153 // Update existence markers on article/talk tabs...
3154 if ( $title->isTalkPage() ) {
3155 $other = $title->getSubjectPage();
3156 } else {
3157 $other = $title->getTalkPage();
3160 $other->invalidateCache();
3161 $other->purgeSquid();
3163 $title->touchLinks();
3164 $title->purgeSquid();
3165 $title->deleteTitleProtection();
3169 * Clears caches when article is deleted
3171 * @param Title $title
3173 public static function onArticleDelete( $title ) {
3174 // Update existence markers on article/talk tabs...
3175 if ( $title->isTalkPage() ) {
3176 $other = $title->getSubjectPage();
3177 } else {
3178 $other = $title->getTalkPage();
3181 $other->invalidateCache();
3182 $other->purgeSquid();
3184 $title->touchLinks();
3185 $title->purgeSquid();
3187 // File cache
3188 HTMLFileCache::clearFileCache( $title );
3189 InfoAction::invalidateCache( $title );
3191 // Messages
3192 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3193 MessageCache::singleton()->replace( $title->getDBkey(), false );
3196 // Images
3197 if ( $title->getNamespace() == NS_FILE ) {
3198 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3199 $update->doUpdate();
3202 // User talk pages
3203 if ( $title->getNamespace() == NS_USER_TALK ) {
3204 $user = User::newFromName( $title->getText(), false );
3205 if ( $user ) {
3206 $user->setNewtalk( false );
3210 // Image redirects
3211 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3215 * Purge caches on page update etc
3217 * @param Title $title
3218 * @todo Verify that $title is always a Title object (and never false or
3219 * null), add Title hint to parameter $title.
3221 public static function onArticleEdit( $title ) {
3222 // Invalidate caches of articles which include this page
3223 DeferredUpdates::addHTMLCacheUpdate( $title, 'templatelinks' );
3225 // Invalidate the caches of all pages which redirect here
3226 DeferredUpdates::addHTMLCacheUpdate( $title, 'redirect' );
3228 // Purge squid for this page only
3229 $title->purgeSquid();
3231 // Clear file cache for this page only
3232 HTMLFileCache::clearFileCache( $title );
3233 InfoAction::invalidateCache( $title );
3236 /**#@-*/
3239 * Returns a list of categories this page is a member of.
3240 * Results will include hidden categories
3242 * @return TitleArray
3244 public function getCategories() {
3245 $id = $this->getId();
3246 if ( $id == 0 ) {
3247 return TitleArray::newFromResult( new FakeResultWrapper( array() ) );
3250 $dbr = wfGetDB( DB_SLAVE );
3251 $res = $dbr->select( 'categorylinks',
3252 array( 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ),
3253 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3254 // as not being aliases, and NS_CATEGORY is numeric
3255 array( 'cl_from' => $id ),
3256 __METHOD__ );
3258 return TitleArray::newFromResult( $res );
3262 * Returns a list of hidden categories this page is a member of.
3263 * Uses the page_props and categorylinks tables.
3265 * @return array Array of Title objects
3267 public function getHiddenCategories() {
3268 $result = array();
3269 $id = $this->getId();
3271 if ( $id == 0 ) {
3272 return array();
3275 $dbr = wfGetDB( DB_SLAVE );
3276 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3277 array( 'cl_to' ),
3278 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3279 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
3280 __METHOD__ );
3282 if ( $res !== false ) {
3283 foreach ( $res as $row ) {
3284 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3288 return $result;
3292 * Return an applicable autosummary if one exists for the given edit.
3293 * @param string|null $oldtext The previous text of the page.
3294 * @param string|null $newtext The submitted text of the page.
3295 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3296 * @return string An appropriate autosummary, or an empty string.
3298 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3300 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3301 // NOTE: stub for backwards-compatibility. assumes the given text is
3302 // wikitext. will break horribly if it isn't.
3304 ContentHandler::deprecated( __METHOD__, '1.21' );
3306 $handler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT );
3307 $oldContent = is_null( $oldtext ) ? null : $handler->unserializeContent( $oldtext );
3308 $newContent = is_null( $newtext ) ? null : $handler->unserializeContent( $newtext );
3310 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3314 * Auto-generates a deletion reason
3316 * @param bool &$hasHistory Whether the page has a history
3317 * @return string|bool String containing deletion reason or empty string, or boolean false
3318 * if no revision occurred
3320 public function getAutoDeleteReason( &$hasHistory ) {
3321 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3325 * Update all the appropriate counts in the category table, given that
3326 * we've added the categories $added and deleted the categories $deleted.
3328 * @param array $added The names of categories that were added
3329 * @param array $deleted The names of categories that were deleted
3331 public function updateCategoryCounts( array $added, array $deleted ) {
3332 $that = $this;
3333 $method = __METHOD__;
3334 $dbw = wfGetDB( DB_MASTER );
3336 // Do this at the end of the commit to reduce lock wait timeouts
3337 $dbw->onTransactionPreCommitOrIdle(
3338 function() use ( $dbw, $that, $method, $added, $deleted ) {
3339 $ns = $that->getTitle()->getNamespace();
3341 $addFields = array( 'cat_pages = cat_pages + 1' );
3342 $removeFields = array( 'cat_pages = cat_pages - 1' );
3343 if ( $ns == NS_CATEGORY ) {
3344 $addFields[] = 'cat_subcats = cat_subcats + 1';
3345 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3346 } elseif ( $ns == NS_FILE ) {
3347 $addFields[] = 'cat_files = cat_files + 1';
3348 $removeFields[] = 'cat_files = cat_files - 1';
3351 if ( count( $added ) ) {
3352 $insertRows = array();
3353 foreach ( $added as $cat ) {
3354 $insertRows[] = array(
3355 'cat_title' => $cat,
3356 'cat_pages' => 1,
3357 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3358 'cat_files' => ( $ns == NS_FILE ) ? 1 : 0,
3361 $dbw->upsert(
3362 'category',
3363 $insertRows,
3364 array( 'cat_title' ),
3365 $addFields,
3366 $method
3370 if ( count( $deleted ) ) {
3371 $dbw->update(
3372 'category',
3373 $removeFields,
3374 array( 'cat_title' => $deleted ),
3375 $method
3379 foreach ( $added as $catName ) {
3380 $cat = Category::newFromName( $catName );
3381 wfRunHooks( 'CategoryAfterPageAdded', array( $cat, $that ) );
3384 foreach ( $deleted as $catName ) {
3385 $cat = Category::newFromName( $catName );
3386 wfRunHooks( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3393 * Updates cascading protections
3395 * @param ParserOutput $parserOutput ParserOutput object for the current version
3397 public function doCascadeProtectionUpdates( ParserOutput $parserOutput ) {
3398 if ( wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
3399 return;
3402 // templatelinks or imagelinks tables may have become out of sync,
3403 // especially if using variable-based transclusions.
3404 // For paranoia, check if things have changed and if
3405 // so apply updates to the database. This will ensure
3406 // that cascaded protections apply as soon as the changes
3407 // are visible.
3409 // Get templates from templatelinks and images from imagelinks
3410 $id = $this->getId();
3412 $dbLinks = array();
3414 $dbr = wfGetDB( DB_SLAVE );
3415 $res = $dbr->select( array( 'templatelinks' ),
3416 array( 'tl_namespace', 'tl_title' ),
3417 array( 'tl_from' => $id ),
3418 __METHOD__
3421 foreach ( $res as $row ) {
3422 $dbLinks["{$row->tl_namespace}:{$row->tl_title}"] = true;
3425 $dbr = wfGetDB( DB_SLAVE );
3426 $res = $dbr->select( array( 'imagelinks' ),
3427 array( 'il_to' ),
3428 array( 'il_from' => $id ),
3429 __METHOD__
3432 foreach ( $res as $row ) {
3433 $dbLinks[NS_FILE . ":{$row->il_to}"] = true;
3436 // Get templates and images from parser output.
3437 $poLinks = array();
3438 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
3439 foreach ( $templates as $dbk => $id ) {
3440 $poLinks["$ns:$dbk"] = true;
3443 foreach ( $parserOutput->getImages() as $dbk => $id ) {
3444 $poLinks[NS_FILE . ":$dbk"] = true;
3447 // Get the diff
3448 $links_diff = array_diff_key( $poLinks, $dbLinks );
3450 if ( count( $links_diff ) > 0 ) {
3451 // Whee, link updates time.
3452 // Note: we are only interested in links here. We don't need to get
3453 // other DataUpdate items from the parser output.
3454 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
3455 $u->doUpdate();
3460 * Return a list of templates used by this article.
3461 * Uses the templatelinks table
3463 * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3464 * @return array Array of Title objects
3466 public function getUsedTemplates() {
3467 return $this->mTitle->getTemplateLinksFrom();
3471 * This function is called right before saving the wikitext,
3472 * so we can do things like signatures and links-in-context.
3474 * @deprecated since 1.19; use Parser::preSaveTransform() instead
3475 * @param string $text Article contents
3476 * @param User $user User doing the edit
3477 * @param ParserOptions $popts Parser options, default options for
3478 * the user loaded if null given
3479 * @return string Article contents with altered wikitext markup (signatures
3480 * converted, {{subst:}}, templates, etc.)
3482 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
3483 global $wgParser, $wgUser;
3485 wfDeprecated( __METHOD__, '1.19' );
3487 $user = is_null( $user ) ? $wgUser : $user;
3489 if ( $popts === null ) {
3490 $popts = ParserOptions::newFromUser( $user );
3493 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
3497 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
3499 * @deprecated since 1.19; use Title::isBigDeletion() instead.
3500 * @return bool
3502 public function isBigDeletion() {
3503 wfDeprecated( __METHOD__, '1.19' );
3504 return $this->mTitle->isBigDeletion();
3508 * Get the approximate revision count of this page.
3510 * @deprecated since 1.19; use Title::estimateRevisionCount() instead.
3511 * @return int
3513 public function estimateRevisionCount() {
3514 wfDeprecated( __METHOD__, '1.19' );
3515 return $this->mTitle->estimateRevisionCount();
3519 * Update the article's restriction field, and leave a log entry.
3521 * @deprecated since 1.19
3522 * @param array $limit Set of restriction keys
3523 * @param string $reason
3524 * @param int &$cascade Set to false if cascading protection isn't allowed.
3525 * @param array $expiry Per restriction type expiration
3526 * @param User $user The user updating the restrictions
3527 * @return bool true on success
3529 public function updateRestrictions(
3530 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
3532 global $wgUser;
3534 $user = is_null( $user ) ? $wgUser : $user;
3536 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3540 * Returns a list of updates to be performed when this page is deleted. The
3541 * updates should remove any information about this page from secondary data
3542 * stores such as links tables.
3544 * @param Content|null $content Optional Content object for determining the
3545 * necessary updates.
3546 * @return array An array of DataUpdates objects
3548 public function getDeletionUpdates( Content $content = null ) {
3549 if ( !$content ) {
3550 // load content object, which may be used to determine the necessary updates
3551 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3552 $content = $this->getContent( Revision::RAW );
3555 if ( !$content ) {
3556 $updates = array();
3557 } else {
3558 $updates = $content->getDeletionUpdates( $this );
3561 wfRunHooks( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );
3562 return $updates;
3567 class PoolWorkArticleView extends PoolCounterWork {
3568 /** @var Page */
3569 private $page;
3571 /** @var string */
3572 private $cacheKey;
3574 /** @var int */
3575 private $revid;
3577 /** @var ParserOptions */
3578 private $parserOptions;
3580 /** @var Content|null */
3581 private $content = null;
3583 /** @var ParserOutput|bool */
3584 private $parserOutput = false;
3586 /** @var bool */
3587 private $isDirty = false;
3589 /** @var Status|bool */
3590 private $error = false;
3593 * @param Page $page
3594 * @param int $revid ID of the revision being parsed.
3595 * @param bool $useParserCache Whether to use the parser cache.
3596 * @param ParserOptions $parserOptions ParserOptions to use for the parse
3597 * operation.
3598 * @param Content|string $content Content to parse or null to load it; may
3599 * also be given as a wikitext string, for BC.
3601 public function __construct( Page $page, ParserOptions $parserOptions,
3602 $revid, $useParserCache, $content = null
3604 if ( is_string( $content ) ) { // BC: old style call
3605 $modelId = $page->getRevision()->getContentModel();
3606 $format = $page->getRevision()->getContentFormat();
3607 $content = ContentHandler::makeContent( $content, $page->getTitle(), $modelId, $format );
3610 $this->page = $page;
3611 $this->revid = $revid;
3612 $this->cacheable = $useParserCache;
3613 $this->parserOptions = $parserOptions;
3614 $this->content = $content;
3615 $this->cacheKey = ParserCache::singleton()->getKey( $page, $parserOptions );
3616 parent::__construct( 'ArticleView', $this->cacheKey . ':revid:' . $revid );
3620 * Get the ParserOutput from this object, or false in case of failure
3622 * @return ParserOutput
3624 public function getParserOutput() {
3625 return $this->parserOutput;
3629 * Get whether the ParserOutput is a dirty one (i.e. expired)
3631 * @return bool
3633 public function getIsDirty() {
3634 return $this->isDirty;
3638 * Get a Status object in case of error or false otherwise
3640 * @return Status|bool
3642 public function getError() {
3643 return $this->error;
3647 * @return bool
3649 public function doWork() {
3650 global $wgUseFileCache;
3652 // @todo several of the methods called on $this->page are not declared in Page, but present
3653 // in WikiPage and delegated by Article.
3655 $isCurrent = $this->revid === $this->page->getLatest();
3657 if ( $this->content !== null ) {
3658 $content = $this->content;
3659 } elseif ( $isCurrent ) {
3660 // XXX: why use RAW audience here, and PUBLIC (default) below?
3661 $content = $this->page->getContent( Revision::RAW );
3662 } else {
3663 $rev = Revision::newFromTitle( $this->page->getTitle(), $this->revid );
3665 if ( $rev === null ) {
3666 $content = null;
3667 } else {
3668 // XXX: why use PUBLIC audience here (default), and RAW above?
3669 $content = $rev->getContent();
3673 if ( $content === null ) {
3674 return false;
3677 // Reduce effects of race conditions for slow parses (bug 46014)
3678 $cacheTime = wfTimestampNow();
3680 $time = - microtime( true );
3681 $this->parserOutput = $content->getParserOutput(
3682 $this->page->getTitle(),
3683 $this->revid,
3684 $this->parserOptions
3686 $time += microtime( true );
3688 // Timing hack
3689 if ( $time > 3 ) {
3690 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
3691 $this->page->getTitle()->getPrefixedDBkey() ) );
3694 if ( $this->cacheable && $this->parserOutput->isCacheable() && $isCurrent ) {
3695 ParserCache::singleton()->save(
3696 $this->parserOutput, $this->page, $this->parserOptions, $cacheTime, $this->revid );
3699 // Make sure file cache is not used on uncacheable content.
3700 // Output that has magic words in it can still use the parser cache
3701 // (if enabled), though it will generally expire sooner.
3702 if ( !$this->parserOutput->isCacheable() || $this->parserOutput->containsOldMagic() ) {
3703 $wgUseFileCache = false;
3706 if ( $isCurrent ) {
3707 $this->page->doCascadeProtectionUpdates( $this->parserOutput );
3710 return true;
3714 * @return bool
3716 public function getCachedWork() {
3717 $this->parserOutput = ParserCache::singleton()->get( $this->page, $this->parserOptions );
3719 if ( $this->parserOutput === false ) {
3720 wfDebug( __METHOD__ . ": parser cache miss\n" );
3721 return false;
3722 } else {
3723 wfDebug( __METHOD__ . ": parser cache hit\n" );
3724 return true;
3729 * @return bool
3731 public function fallback() {
3732 $this->parserOutput = ParserCache::singleton()->getDirty( $this->page, $this->parserOptions );
3734 if ( $this->parserOutput === false ) {
3735 wfDebugLog( 'dirty', 'dirty missing' );
3736 wfDebug( __METHOD__ . ": no dirty cache\n" );
3737 return false;
3738 } else {
3739 wfDebug( __METHOD__ . ": sending dirty output\n" );
3740 wfDebugLog( 'dirty', "dirty output {$this->cacheKey}" );
3741 $this->isDirty = true;
3742 return true;
3747 * @param Status $status
3748 * @return bool
3750 public function error( $status ) {
3751 $this->error = $status;
3752 return false;