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
24 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
26 abstract class Page
{}
29 * Class representing a MediaWiki article and history.
31 * Some fields are public only for backwards-compatibility. Use accessors.
32 * In the past, this class was part of Article.php and everything was public.
34 * @internal documentation reviewed 15 Mar 2010
36 class WikiPage
extends Page
{
37 // doDeleteArticleReal() return values. Values less than zero indicate fatal errors,
38 // values greater than zero indicate that there were problems not resulting in page
42 * Delete operation aborted by hook
44 const DELETE_HOOK_ABORTED
= -1;
49 const DELETE_SUCCESS
= 0;
54 const DELETE_NO_PAGE
= 1;
57 * No revisions found to delete
59 const DELETE_NO_REVISIONS
= 2;
61 // Constants for $mDataLoadedFrom and related
64 * Data has not been loaded yet (or the object was cleared)
66 const DATA_NOT_LOADED
= 0;
69 * Data has been loaded from a slave database
71 const DATA_FROM_SLAVE
= 1;
74 * Data has been loaded from the master database
76 const DATA_FROM_MASTER
= 2;
79 * Data has been loaded from the master database using FOR UPDATE
81 const DATA_FOR_UPDATE
= 3;
86 public $mTitle = null;
91 public $mDataLoaded = false; // !< Boolean
92 public $mIsRedirect = false; // !< Boolean
93 public $mLatest = false; // !< Integer (false means "not loaded")
94 public $mPreparedEdit = false; // !< Array
98 * @var int; one of the DATA_* constants
100 protected $mDataLoadedFrom = self
::DATA_NOT_LOADED
;
105 protected $mRedirectTarget = null;
110 protected $mLastRevision = null;
113 * @var string; timestamp of the current revision or empty string if not loaded
115 protected $mTimestamp = '';
120 protected $mTouched = '19700101000000';
125 protected $mCounter = null;
128 * Constructor and clear the article
129 * @param $title Title Reference to a Title object.
131 public function __construct( Title
$title ) {
132 $this->mTitle
= $title;
136 * Create a WikiPage object of the appropriate class for the given title.
138 * @param $title Title
139 * @return WikiPage object of the appropriate type
141 public static function factory( Title
$title ) {
142 $ns = $title->getNamespace();
144 if ( $ns == NS_MEDIA
) {
145 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
146 } elseif ( $ns < 0 ) {
147 throw new MWException( "Invalid or virtual namespace $ns given." );
152 $page = new WikiFilePage( $title );
155 $page = new WikiCategoryPage( $title );
158 $page = new WikiPage( $title );
165 * Constructor from a page id
167 * @param $id Int article ID to load
168 * @param $from string|int one of the following values:
169 * - "fromdb" or self::DATA_FROM_SLAVE to select from a slave database
170 * - "fromdbmaster" or self::DATA_FROM_MASTER to select from the master database
172 * @return WikiPage|null
174 public static function newFromID( $id, $from = 'fromdb' ) {
175 $from = self
::convertSelectType( $from );
176 $db = wfGetDB( $from === self
::DATA_FROM_MASTER ? DB_MASTER
: DB_SLAVE
);
177 $row = $db->selectRow( 'page', self
::selectFields(), array( 'page_id' => $id ), __METHOD__
);
181 return self
::newFromRow( $row, $from );
185 * Constructor from a database row
188 * @param $row object: database row containing at least fields returned
190 * @param $from string|int: source of $data:
191 * - "fromdb" or self::DATA_FROM_SLAVE: from a slave DB
192 * - "fromdbmaster" or self::DATA_FROM_MASTER: from the master DB
193 * - "forupdate" or self::DATA_FOR_UPDATE: from the master DB using SELECT FOR UPDATE
196 public static function newFromRow( $row, $from = 'fromdb' ) {
197 $page = self
::factory( Title
::newFromRow( $row ) );
198 $page->loadFromRow( $row, $from );
203 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to DATA_* constants.
205 * @param $type object|string|int
208 private static function convertSelectType( $type ) {
211 return self
::DATA_FROM_SLAVE
;
213 return self
::DATA_FROM_MASTER
;
215 return self
::DATA_FOR_UPDATE
;
217 // It may already be an integer or whatever else
223 * Returns overrides for action handlers.
224 * Classes listed here will be used instead of the default one when
225 * (and only when) $wgActions[$action] === true. This allows subclasses
226 * to override the default behavior.
228 * @todo: move this UI stuff somewhere else
232 public function getActionOverrides() {
237 * Get the title object of the article
238 * @return Title object of this page
240 public function getTitle() {
241 return $this->mTitle
;
247 public function clear() {
248 $this->mDataLoaded
= false;
249 $this->mDataLoadedFrom
= self
::DATA_NOT_LOADED
;
251 $this->mCounter
= null;
252 $this->mRedirectTarget
= null; # Title object if set
253 $this->mLastRevision
= null; # Latest revision
254 $this->mTouched
= '19700101000000';
255 $this->mTimestamp
= '';
256 $this->mIsRedirect
= false;
257 $this->mLatest
= false;
258 $this->mPreparedEdit
= false;
262 * Return the list of revision fields that should be selected to create
267 public static function selectFields() {
284 * Fetch a page record with the given conditions
285 * @param $dbr DatabaseBase object
286 * @param $conditions Array
287 * @param $options Array
288 * @return mixed Database result resource, or false on failure
290 protected function pageData( $dbr, $conditions, $options = array() ) {
291 $fields = self
::selectFields();
293 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
295 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
297 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
303 * Fetch a page record matching the Title object's namespace and title
304 * using a sanitized title string
306 * @param $dbr DatabaseBase object
307 * @param $title Title object
308 * @param $options Array
309 * @return mixed Database result resource, or false on failure
311 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
312 return $this->pageData( $dbr, array(
313 'page_namespace' => $title->getNamespace(),
314 'page_title' => $title->getDBkey() ), $options );
318 * Fetch a page record matching the requested ID
320 * @param $dbr DatabaseBase
322 * @param $options Array
323 * @return mixed Database result resource, or false on failure
325 public function pageDataFromId( $dbr, $id, $options = array() ) {
326 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
330 * Set the general counter, title etc data loaded from
333 * @param $from object|string|int One of the following:
334 * - A DB query result object
335 * - "fromdb" or self::DATA_FROM_SLAVE to get from a slave DB
336 * - "fromdbmaster" or self::DATA_FROM_MASTER to get from the master DB
337 * - "forupdate" or self::DATA_FOR_UPDATE to get from the master DB using SELECT FOR UPDATE
341 public function loadPageData( $from = 'fromdb' ) {
342 $from = self
::convertSelectType( $from );
343 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
344 // We already have the data from the correct location, no need to load it twice.
348 if ( $from === self
::DATA_FOR_UPDATE
) {
349 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
, array( 'FOR UPDATE' ) );
350 } elseif ( $from === self
::DATA_FROM_MASTER
) {
351 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
352 } elseif ( $from === self
::DATA_FROM_SLAVE
) {
353 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE
), $this->mTitle
);
354 # Use a "last rev inserted" timestamp key to dimish the issue of slave lag.
355 # Note that DB also stores the master position in the session and checks it.
356 $touched = $this->getCachedLastEditTime();
357 if ( $touched ) { // key set
358 if ( !$data ||
$touched > wfTimestamp( TS_MW
, $data->page_touched
) ) {
359 $from = self
::DATA_FROM_MASTER
;
360 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
364 // No idea from where the caller got this data, assume slave database.
366 $from = self
::DATA_FROM_SLAVE
;
369 $this->loadFromRow( $data, $from );
373 * Load the object from a database row
376 * @param $data object: database row containing at least fields returned
378 * @param $from string|int One of the following:
379 * - "fromdb" or self::DATA_FROM_SLAVE if the data comes from a slave DB
380 * - "fromdbmaster" or self::DATA_FROM_MASTER if the data comes from the master DB
381 * - "forupdate" or self::DATA_FOR_UPDATE if the data comes from from
382 * the master DB using SELECT FOR UPDATE
384 public function loadFromRow( $data, $from ) {
385 $lc = LinkCache
::singleton();
388 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
390 $this->mTitle
->loadFromRow( $data );
392 # Old-fashioned restrictions
393 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
395 $this->mCounter
= intval( $data->page_counter
);
396 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
397 $this->mIsRedirect
= intval( $data->page_is_redirect
);
398 $this->mLatest
= intval( $data->page_latest
);
400 $lc->addBadLinkObj( $this->mTitle
);
402 $this->mTitle
->loadFromRow( false );
405 $this->mDataLoaded
= true;
406 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
410 * @return int Page ID
412 public function getId() {
413 return $this->mTitle
->getArticleID();
417 * @return bool Whether or not the page exists in the database
419 public function exists() {
420 return $this->mTitle
->exists();
424 * Check if this page is something we're going to be showing
425 * some sort of sensible content for. If we return false, page
426 * views (plain action=view) will return an HTTP 404 response,
427 * so spiders and robots can know they're following a bad link.
431 public function hasViewableContent() {
432 return $this->mTitle
->exists() ||
$this->mTitle
->isAlwaysKnown();
436 * @return int The view count for the page
438 public function getCount() {
439 if ( !$this->mDataLoaded
) {
440 $this->loadPageData();
443 return $this->mCounter
;
447 * Tests if the article text represents a redirect
449 * @param $text mixed string containing article contents, or boolean
452 public function isRedirect( $text = false ) {
453 if ( $text === false ) {
454 if ( !$this->mDataLoaded
) {
455 $this->loadPageData();
458 return (bool)$this->mIsRedirect
;
460 return Title
::newFromRedirect( $text ) !== null;
465 * Loads page_touched and returns a value indicating if it should be used
466 * @return boolean true if not a redirect
468 public function checkTouched() {
469 if ( !$this->mDataLoaded
) {
470 $this->loadPageData();
472 return !$this->mIsRedirect
;
476 * Get the page_touched field
477 * @return string containing GMT timestamp
479 public function getTouched() {
480 if ( !$this->mDataLoaded
) {
481 $this->loadPageData();
483 return $this->mTouched
;
487 * Get the page_latest field
488 * @return integer rev_id of current revision
490 public function getLatest() {
491 if ( !$this->mDataLoaded
) {
492 $this->loadPageData();
494 return (int)$this->mLatest
;
498 * Get the Revision object of the oldest revision
499 * @return Revision|null
501 public function getOldestRevision() {
502 wfProfileIn( __METHOD__
);
504 // Try using the slave database first, then try the master
506 $db = wfGetDB( DB_SLAVE
);
507 $revSelectFields = Revision
::selectFields();
509 while ( $continue ) {
510 $row = $db->selectRow(
511 array( 'page', 'revision' ),
514 'page_namespace' => $this->mTitle
->getNamespace(),
515 'page_title' => $this->mTitle
->getDBkey(),
520 'ORDER BY' => 'rev_timestamp ASC'
527 $db = wfGetDB( DB_MASTER
);
532 wfProfileOut( __METHOD__
);
533 return $row ? Revision
::newFromRow( $row ) : null;
537 * Loads everything except the text
538 * This isn't necessary for all uses, so it's only done if needed.
540 protected function loadLastEdit() {
541 if ( $this->mLastRevision
!== null ) {
542 return; // already loaded
545 $latest = $this->getLatest();
547 return; // page doesn't exist or is missing page_latest info
550 $revision = Revision
::newFromPageId( $this->getId(), $latest );
551 if ( $revision ) { // sanity
552 $this->setLastEdit( $revision );
557 * Set the latest revision
559 protected function setLastEdit( Revision
$revision ) {
560 $this->mLastRevision
= $revision;
561 $this->mTimestamp
= $revision->getTimestamp();
565 * Get the latest revision
566 * @return Revision|null
568 public function getRevision() {
569 $this->loadLastEdit();
570 if ( $this->mLastRevision
) {
571 return $this->mLastRevision
;
577 * Get the text of the current revision. No side-effects...
579 * @param $audience Integer: one of:
580 * Revision::FOR_PUBLIC to be displayed to all users
581 * Revision::FOR_THIS_USER to be displayed to $wgUser
582 * Revision::RAW get the text regardless of permissions
583 * @return String|bool The text of the current revision. False on failure
585 public function getText( $audience = Revision
::FOR_PUBLIC
) {
586 $this->loadLastEdit();
587 if ( $this->mLastRevision
) {
588 return $this->mLastRevision
->getText( $audience );
594 * Get the text of the current revision. No side-effects...
596 * @return String|bool The text of the current revision. False on failure
598 public function getRawText() {
599 $this->loadLastEdit();
600 if ( $this->mLastRevision
) {
601 return $this->mLastRevision
->getRawText();
607 * @return string MW timestamp of last article revision
609 public function getTimestamp() {
610 // Check if the field has been filled by WikiPage::setTimestamp()
611 if ( !$this->mTimestamp
) {
612 $this->loadLastEdit();
615 return wfTimestamp( TS_MW
, $this->mTimestamp
);
619 * Set the page timestamp (use only to avoid DB queries)
620 * @param $ts string MW timestamp of last article revision
623 public function setTimestamp( $ts ) {
624 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
628 * @param $audience Integer: one of:
629 * Revision::FOR_PUBLIC to be displayed to all users
630 * Revision::FOR_THIS_USER to be displayed to $wgUser
631 * Revision::RAW get the text regardless of permissions
632 * @return int user ID for the user that made the last article revision
634 public function getUser( $audience = Revision
::FOR_PUBLIC
) {
635 $this->loadLastEdit();
636 if ( $this->mLastRevision
) {
637 return $this->mLastRevision
->getUser( $audience );
644 * Get the User object of the user who created the page
645 * @param $audience Integer: one of:
646 * Revision::FOR_PUBLIC to be displayed to all users
647 * Revision::FOR_THIS_USER to be displayed to $wgUser
648 * Revision::RAW get the text regardless of permissions
651 public function getCreator( $audience = Revision
::FOR_PUBLIC
) {
652 $revision = $this->getOldestRevision();
654 $userName = $revision->getUserText( $audience );
655 return User
::newFromName( $userName, false );
662 * @param $audience Integer: 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 * @return string username of the user that made the last article revision
668 public function getUserText( $audience = Revision
::FOR_PUBLIC
) {
669 $this->loadLastEdit();
670 if ( $this->mLastRevision
) {
671 return $this->mLastRevision
->getUserText( $audience );
678 * @param $audience Integer: one of:
679 * Revision::FOR_PUBLIC to be displayed to all users
680 * Revision::FOR_THIS_USER to be displayed to $wgUser
681 * Revision::RAW get the text regardless of permissions
682 * @return string Comment stored for the last article revision
684 public function getComment( $audience = Revision
::FOR_PUBLIC
) {
685 $this->loadLastEdit();
686 if ( $this->mLastRevision
) {
687 return $this->mLastRevision
->getComment( $audience );
694 * Returns true if last revision was marked as "minor edit"
696 * @return boolean Minor edit indicator for the last article revision.
698 public function getMinorEdit() {
699 $this->loadLastEdit();
700 if ( $this->mLastRevision
) {
701 return $this->mLastRevision
->isMinor();
708 * Get the cached timestamp for the last time the page changed.
709 * This is only used to help handle slave lag by comparing to page_touched.
710 * @return string MW timestamp
712 protected function getCachedLastEditTime() {
714 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
715 return $wgMemc->get( $key );
719 * Set the cached timestamp for the last time the page changed.
720 * This is only used to help handle slave lag by comparing to page_touched.
721 * @param $timestamp string
724 public function setCachedLastEditTime( $timestamp ) {
726 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
727 $wgMemc->set( $key, wfTimestamp( TS_MW
, $timestamp ), 60*15 );
731 * Determine whether a page would be suitable for being counted as an
732 * article in the site_stats table based on the title & its content
734 * @param $editInfo Object or false: object returned by prepareTextForEdit(),
735 * if false, the current database state will be used
738 public function isCountable( $editInfo = false ) {
739 global $wgArticleCountMethod;
741 if ( !$this->mTitle
->isContentPage() ) {
745 $text = $editInfo ?
$editInfo->pst
: false;
747 if ( $this->isRedirect( $text ) ) {
751 switch ( $wgArticleCountMethod ) {
755 if ( $text === false ) {
756 $text = $this->getRawText();
758 return strpos( $text, ',' ) !== false;
761 // ParserOutput::getLinks() is a 2D array of page links, so
762 // to be really correct we would need to recurse in the array
763 // but the main array should only have items in it if there are
765 return (bool)count( $editInfo->output
->getLinks() );
767 return (bool)wfGetDB( DB_SLAVE
)->selectField( 'pagelinks', 1,
768 array( 'pl_from' => $this->getId() ), __METHOD__
);
774 * If this page is a redirect, get its target
776 * The target will be fetched from the redirect table if possible.
777 * If this page doesn't have an entry there, call insertRedirect()
778 * @return Title|mixed object, or null if this page is not a redirect
780 public function getRedirectTarget() {
781 if ( !$this->mTitle
->isRedirect() ) {
785 if ( $this->mRedirectTarget
!== null ) {
786 return $this->mRedirectTarget
;
789 # Query the redirect table
790 $dbr = wfGetDB( DB_SLAVE
);
791 $row = $dbr->selectRow( 'redirect',
792 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
793 array( 'rd_from' => $this->getId() ),
797 // rd_fragment and rd_interwiki were added later, populate them if empty
798 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
799 return $this->mRedirectTarget
= Title
::makeTitle(
800 $row->rd_namespace
, $row->rd_title
,
801 $row->rd_fragment
, $row->rd_interwiki
);
804 # This page doesn't have an entry in the redirect table
805 return $this->mRedirectTarget
= $this->insertRedirect();
809 * Insert an entry for this page into the redirect table.
811 * Don't call this function directly unless you know what you're doing.
812 * @return Title object or null if not a redirect
814 public function insertRedirect() {
815 // recurse through to only get the final target
816 $retval = Title
::newFromRedirectRecurse( $this->getRawText() );
820 $this->insertRedirectEntry( $retval );
825 * Insert or update the redirect table entry for this page to indicate
826 * it redirects to $rt .
827 * @param $rt Title redirect target
829 public function insertRedirectEntry( $rt ) {
830 $dbw = wfGetDB( DB_MASTER
);
831 $dbw->replace( 'redirect', array( 'rd_from' ),
833 'rd_from' => $this->getId(),
834 'rd_namespace' => $rt->getNamespace(),
835 'rd_title' => $rt->getDBkey(),
836 'rd_fragment' => $rt->getFragment(),
837 'rd_interwiki' => $rt->getInterwiki(),
844 * Get the Title object or URL this page redirects to
846 * @return mixed false, Title of in-wiki target, or string with URL
848 public function followRedirect() {
849 return $this->getRedirectURL( $this->getRedirectTarget() );
853 * Get the Title object or URL to use for a redirect. We use Title
854 * objects for same-wiki, non-special redirects and URLs for everything
856 * @param $rt Title Redirect target
857 * @return mixed false, Title object of local target, or string with URL
859 public function getRedirectURL( $rt ) {
864 if ( $rt->isExternal() ) {
865 if ( $rt->isLocal() ) {
866 // Offsite wikis need an HTTP redirect.
868 // This can be hard to reverse and may produce loops,
869 // so they may be disabled in the site configuration.
870 $source = $this->mTitle
->getFullURL( 'redirect=no' );
871 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
873 // External pages pages without "local" bit set are not valid
879 if ( $rt->isSpecialPage() ) {
880 // Gotta handle redirects to special pages differently:
881 // Fill the HTTP response "Location" header and ignore
882 // the rest of the page we're on.
884 // Some pages are not valid targets
885 if ( $rt->isValidRedirectTarget() ) {
886 return $rt->getFullURL();
896 * Get a list of users who have edited this article, not including the user who made
897 * the most recent revision, which you can get from $article->getUser() if you want it
898 * @return UserArrayFromResult
900 public function getContributors() {
901 # @todo FIXME: This is expensive; cache this info somewhere.
903 $dbr = wfGetDB( DB_SLAVE
);
905 if ( $dbr->implicitGroupby() ) {
906 $realNameField = 'user_real_name';
908 $realNameField = 'MIN(user_real_name) AS user_real_name';
911 $tables = array( 'revision', 'user' );
914 'rev_user as user_id',
915 'rev_user_text AS user_name',
917 'MAX(rev_timestamp) AS timestamp',
920 $conds = array( 'rev_page' => $this->getId() );
922 // The user who made the top revision gets credited as "this page was last edited by
923 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
924 $user = $this->getUser();
926 $conds[] = "rev_user != $user";
928 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
931 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
934 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
938 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
939 'ORDER BY' => 'timestamp DESC',
942 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
943 return new UserArrayFromResult( $res );
947 * Get the last N authors
948 * @param $num Integer: number of revisions to get
949 * @param $revLatest String: the latest rev_id, selected from the master (optional)
950 * @return array Array of authors, duplicates not removed
952 public function getLastNAuthors( $num, $revLatest = 0 ) {
953 wfProfileIn( __METHOD__
);
954 // First try the slave
955 // If that doesn't have the latest revision, try the master
957 $db = wfGetDB( DB_SLAVE
);
960 $res = $db->select( array( 'page', 'revision' ),
961 array( 'rev_id', 'rev_user_text' ),
963 'page_namespace' => $this->mTitle
->getNamespace(),
964 'page_title' => $this->mTitle
->getDBkey(),
968 'ORDER BY' => 'rev_timestamp DESC',
974 wfProfileOut( __METHOD__
);
978 $row = $db->fetchObject( $res );
980 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
981 $db = wfGetDB( DB_MASTER
);
986 } while ( $continue );
988 $authors = array( $row->rev_user_text
);
990 foreach ( $res as $row ) {
991 $authors[] = $row->rev_user_text
;
994 wfProfileOut( __METHOD__
);
999 * Should the parser cache be used?
1001 * @param $parserOptions ParserOptions to check
1005 public function isParserCacheUsed( ParserOptions
$parserOptions, $oldid ) {
1006 global $wgEnableParserCache;
1008 return $wgEnableParserCache
1009 && $parserOptions->getStubThreshold() == 0
1010 && $this->mTitle
->exists()
1011 && ( $oldid === null ||
$oldid === 0 ||
$oldid === $this->getLatest() )
1012 && $this->mTitle
->isWikitextPage();
1016 * Get a ParserOutput for the given ParserOptions and revision ID.
1017 * The parser cache will be used if possible.
1020 * @param $parserOptions ParserOptions to use for the parse operation
1021 * @param $oldid Revision ID to get the text from, passing null or 0 will
1022 * get the current revision (default value)
1023 * @return ParserOutput or false if the revision was not found
1025 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
1026 wfProfileIn( __METHOD__
);
1028 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1029 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1030 if ( $parserOptions->getStubThreshold() ) {
1031 wfIncrStats( 'pcache_miss_stub' );
1034 if ( $useParserCache ) {
1035 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1036 if ( $parserOutput !== false ) {
1037 wfProfileOut( __METHOD__
);
1038 return $parserOutput;
1042 if ( $oldid === null ||
$oldid === 0 ) {
1043 $oldid = $this->getLatest();
1046 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1049 wfProfileOut( __METHOD__
);
1051 return $pool->getParserOutput();
1055 * Do standard deferred updates after page view
1056 * @param $user User The relevant user
1058 public function doViewUpdates( User
$user ) {
1059 global $wgDisableCounters;
1060 if ( wfReadOnly() ) {
1064 # Don't update page view counters on views from bot users (bug 14044)
1065 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->mTitle
->exists() ) {
1066 DeferredUpdates
::addUpdate( new ViewCountUpdate( $this->getId() ) );
1067 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1070 # Update newtalk / watchlist notification status
1071 $user->clearNotification( $this->mTitle
);
1075 * Perform the actions of a page purging
1078 public function doPurge() {
1081 if( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ){
1085 // Invalidate the cache
1086 $this->mTitle
->invalidateCache();
1089 if ( $wgUseSquid ) {
1090 // Commit the transaction before the purge is sent
1091 $dbw = wfGetDB( DB_MASTER
);
1092 $dbw->commit( __METHOD__
);
1095 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1096 $update->doUpdate();
1099 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1100 if ( $this->mTitle
->exists() ) {
1101 $text = $this->getRawText();
1106 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1112 * Insert a new empty page record for this article.
1113 * This *must* be followed up by creating a revision
1114 * and running $this->updateRevisionOn( ... );
1115 * or else the record will be left in a funky state.
1116 * Best if all done inside a transaction.
1118 * @param $dbw DatabaseBase
1119 * @return int The newly created page_id key, or false if the title already existed
1121 public function insertOn( $dbw ) {
1122 wfProfileIn( __METHOD__
);
1124 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1125 $dbw->insert( 'page', array(
1126 'page_id' => $page_id,
1127 'page_namespace' => $this->mTitle
->getNamespace(),
1128 'page_title' => $this->mTitle
->getDBkey(),
1129 'page_counter' => 0,
1130 'page_restrictions' => '',
1131 'page_is_redirect' => 0, # Will set this shortly...
1133 'page_random' => wfRandom(),
1134 'page_touched' => $dbw->timestamp(),
1135 'page_latest' => 0, # Fill this in shortly...
1136 'page_len' => 0, # Fill this in shortly...
1137 ), __METHOD__
, 'IGNORE' );
1139 $affected = $dbw->affectedRows();
1142 $newid = $dbw->insertId();
1143 $this->mTitle
->resetArticleID( $newid );
1145 wfProfileOut( __METHOD__
);
1147 return $affected ?
$newid : false;
1151 * Update the page record to point to a newly saved revision.
1153 * @param $dbw DatabaseBase: object
1154 * @param $revision Revision: For ID number, and text used to set
1155 * length and redirect status fields
1156 * @param $lastRevision Integer: if given, will not overwrite the page field
1157 * when different from the currently set value.
1158 * Giving 0 indicates the new page flag should be set
1160 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1161 * removing rows in redirect table.
1162 * @return bool true on success, false on failure
1165 public function updateRevisionOn( $dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
1166 wfProfileIn( __METHOD__
);
1168 $text = $revision->getText();
1169 $len = strlen( $text );
1170 $rt = Title
::newFromRedirectRecurse( $text );
1172 $conditions = array( 'page_id' => $this->getId() );
1174 if ( !is_null( $lastRevision ) ) {
1175 # An extra check against threads stepping on each other
1176 $conditions['page_latest'] = $lastRevision;
1179 $now = wfTimestampNow();
1180 $dbw->update( 'page',
1182 'page_latest' => $revision->getId(),
1183 'page_touched' => $dbw->timestamp( $now ),
1184 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1185 'page_is_redirect' => $rt !== null ?
1 : 0,
1191 $result = $dbw->affectedRows() != 0;
1193 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1194 $this->setLastEdit( $revision );
1195 $this->setCachedLastEditTime( $now );
1196 $this->mLatest
= $revision->getId();
1197 $this->mIsRedirect
= (bool)$rt;
1198 # Update the LinkCache.
1199 LinkCache
::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle
, $len, $this->mIsRedirect
, $this->mLatest
);
1202 wfProfileOut( __METHOD__
);
1207 * Add row to the redirect table if this is a redirect, remove otherwise.
1209 * @param $dbw DatabaseBase
1210 * @param $redirectTitle Title object pointing to the redirect target,
1211 * or NULL if this is not a redirect
1212 * @param $lastRevIsRedirect null|bool If given, will optimize adding and
1213 * removing rows in redirect table.
1214 * @return bool true on success, false on failure
1217 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1218 // Always update redirects (target link might have changed)
1219 // Update/Insert if we don't know if the last revision was a redirect or not
1220 // Delete if changing from redirect to non-redirect
1221 $isRedirect = !is_null( $redirectTitle );
1223 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1227 wfProfileIn( __METHOD__
);
1228 if ( $isRedirect ) {
1229 $this->insertRedirectEntry( $redirectTitle );
1231 // This is not a redirect, remove row from redirect table
1232 $where = array( 'rd_from' => $this->getId() );
1233 $dbw->delete( 'redirect', $where, __METHOD__
);
1236 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1237 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1239 wfProfileOut( __METHOD__
);
1241 return ( $dbw->affectedRows() != 0 );
1245 * If the given revision is newer than the currently set page_latest,
1246 * update the page record. Otherwise, do nothing.
1248 * @param $dbw DatabaseBase object
1249 * @param $revision Revision object
1252 public function updateIfNewerOn( $dbw, $revision ) {
1253 wfProfileIn( __METHOD__
);
1255 $row = $dbw->selectRow(
1256 array( 'revision', 'page' ),
1257 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1259 'page_id' => $this->getId(),
1260 'page_latest=rev_id' ),
1264 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1265 wfProfileOut( __METHOD__
);
1268 $prev = $row->rev_id
;
1269 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1271 # No or missing previous revision; mark the page as new
1273 $lastRevIsRedirect = null;
1276 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1278 wfProfileOut( __METHOD__
);
1283 * Get the text that needs to be saved in order to undo all revisions
1284 * between $undo and $undoafter. Revisions must belong to the same page,
1285 * must exist and must not be deleted
1286 * @param $undo Revision
1287 * @param $undoafter Revision Must be an earlier revision than $undo
1288 * @return mixed string on success, false on failure
1290 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
1291 $cur_text = $this->getRawText();
1292 if ( $cur_text === false ) {
1293 return false; // no page
1295 $undo_text = $undo->getText();
1296 $undoafter_text = $undoafter->getText();
1298 if ( $cur_text == $undo_text ) {
1299 # No use doing a merge if it's just a straight revert.
1300 return $undoafter_text;
1305 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
1309 return $undone_text;
1313 * @param $section null|bool|int or a section number (0, 1, 2, T1, T2...)
1314 * @param $text String: new text of the section
1315 * @param $sectionTitle String: new section's subject, only if $section is 'new'
1316 * @param $edittime String: revision timestamp or null to use the current revision
1317 * @return string Complete article text, or null if error
1319 public function replaceSection( $section, $text, $sectionTitle = '', $edittime = null ) {
1320 wfProfileIn( __METHOD__
);
1322 if ( strval( $section ) == '' ) {
1323 // Whole-page edit; let the whole text through
1325 // Bug 30711: always use current version when adding a new section
1326 if ( is_null( $edittime ) ||
$section == 'new' ) {
1327 $oldtext = $this->getRawText();
1328 if ( $oldtext === false ) {
1329 wfDebug( __METHOD__
. ": no page text\n" );
1330 wfProfileOut( __METHOD__
);
1334 $dbw = wfGetDB( DB_MASTER
);
1335 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1338 wfDebug( "WikiPage::replaceSection asked for bogus section (page: " .
1339 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1340 wfProfileOut( __METHOD__
);
1344 $oldtext = $rev->getText();
1347 if ( $section == 'new' ) {
1348 # Inserting a new section
1349 $subject = $sectionTitle ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $sectionTitle ) . "\n\n" : '';
1350 if ( wfRunHooks( 'PlaceNewSection', array( $this, $oldtext, $subject, &$text ) ) ) {
1351 $text = strlen( trim( $oldtext ) ) > 0
1352 ?
"{$oldtext}\n\n{$subject}{$text}"
1353 : "{$subject}{$text}";
1356 # Replacing an existing section; roll out the big guns
1359 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1363 wfProfileOut( __METHOD__
);
1368 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1370 * @return Int updated $flags
1372 function checkFlags( $flags ) {
1373 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1374 if ( $this->mTitle
->getArticleID() ) {
1375 $flags |
= EDIT_UPDATE
;
1385 * Change an existing article or create a new article. Updates RC and all necessary caches,
1386 * optionally via the deferred update array.
1388 * @param $text String: new text
1389 * @param $summary String: edit summary
1390 * @param $flags Integer bitfield:
1392 * Article is known or assumed to be non-existent, create a new one
1394 * Article is known or assumed to be pre-existing, update it
1396 * Mark this edit minor, if the user is allowed to do so
1398 * Do not log the change in recentchanges
1400 * Mark the edit a "bot" edit regardless of user rights
1401 * EDIT_DEFER_UPDATES
1402 * Defer some of the updates until the end of index.php
1404 * Fill in blank summaries with generated text where possible
1406 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1407 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1408 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1409 * edit-already-exists error will be returned. These two conditions are also possible with
1410 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1412 * @param $baseRevId int the revision ID this edit was based off, if any
1413 * @param $user User the user doing the edit
1415 * @return Status object. Possible errors:
1416 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1417 * edit-gone-missing: In update mode, but the article didn't exist
1418 * edit-conflict: In update mode, the article changed unexpectedly
1419 * edit-no-change: Warning that the text was the same as before
1420 * edit-already-exists: In creation mode, but the article already exists
1422 * Extensions may define additional errors.
1424 * $return->value will contain an associative array with members as follows:
1425 * new: Boolean indicating if the function attempted to create a new article
1426 * revision: The revision object for the inserted revision, or null
1428 * Compatibility note: this function previously returned a boolean value indicating success/failure
1430 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1431 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1433 # Low-level sanity check
1434 if ( $this->mTitle
->getText() === '' ) {
1435 throw new MWException( 'Something is trying to edit an article with an empty title' );
1438 wfProfileIn( __METHOD__
);
1440 $user = is_null( $user ) ?
$wgUser : $user;
1441 $status = Status
::newGood( array() );
1443 // Load the data from the master database if needed.
1444 // The caller may already loaded it from the master or even loaded it using
1445 // SELECT FOR UPDATE, so do not override that using clear().
1446 $this->loadPageData( 'fromdbmaster' );
1448 $flags = $this->checkFlags( $flags );
1450 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
1451 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
1453 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
1455 if ( $status->isOK() ) {
1456 $status->fatal( 'edit-hook-aborted' );
1459 wfProfileOut( __METHOD__
);
1463 # Silently ignore EDIT_MINOR if not allowed
1464 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1465 $bot = $flags & EDIT_FORCE_BOT
;
1467 $oldtext = $this->getRawText(); // current revision
1468 $oldsize = strlen( $oldtext );
1469 $oldid = $this->getLatest();
1470 $oldIsRedirect = $this->isRedirect();
1471 $oldcountable = $this->isCountable();
1473 # Provide autosummaries if one is not provided and autosummaries are enabled.
1474 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1475 $summary = self
::getAutosummary( $oldtext, $text, $flags );
1478 $editInfo = $this->prepareTextForEdit( $text, null, $user );
1479 $text = $editInfo->pst
;
1480 $newsize = strlen( $text );
1482 $dbw = wfGetDB( DB_MASTER
);
1483 $now = wfTimestampNow();
1484 $this->mTimestamp
= $now;
1486 if ( $flags & EDIT_UPDATE
) {
1487 # Update article, but only if changed.
1488 $status->value
['new'] = false;
1491 # Article gone missing
1492 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
1493 $status->fatal( 'edit-gone-missing' );
1495 wfProfileOut( __METHOD__
);
1499 # Make sure the revision is either completely inserted or not inserted at all
1500 if ( !$wgDBtransactions ) {
1501 $userAbort = ignore_user_abort( true );
1504 $revision = new Revision( array(
1505 'page' => $this->getId(),
1506 'comment' => $summary,
1507 'minor_edit' => $isminor,
1509 'parent_id' => $oldid,
1510 'user' => $user->getId(),
1511 'user_text' => $user->getName(),
1515 $changed = ( strcmp( $text, $oldtext ) != 0 );
1518 $dbw->begin( __METHOD__
);
1519 $revisionId = $revision->insertOn( $dbw );
1523 # Note that we use $this->mLatest instead of fetching a value from the master DB
1524 # during the course of this function. This makes sure that EditPage can detect
1525 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1526 # before this function is called. A previous function used a separate query, this
1527 # creates a window where concurrent edits can cause an ignored edit conflict.
1528 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1531 /* Belated edit conflict! Run away!! */
1532 $status->fatal( 'edit-conflict' );
1534 # Delete the invalid revision if the DB is not transactional
1535 if ( !$wgDBtransactions ) {
1536 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
1540 $dbw->rollback( __METHOD__
);
1542 global $wgUseRCPatrol;
1543 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1544 # Update recentchanges
1545 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1546 # Mark as patrolled if the user can do so
1547 $patrolled = $wgUseRCPatrol && !count(
1548 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1549 # Add RC row to the DB
1550 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
1551 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1552 $revisionId, $patrolled
1555 # Log auto-patrolled edits
1557 PatrolLog
::record( $rc, true, $user );
1560 $user->incEditCount();
1561 $dbw->commit( __METHOD__
);
1564 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1565 // related variables correctly
1566 $revision->setId( $this->getLatest() );
1569 if ( !$wgDBtransactions ) {
1570 ignore_user_abort( $userAbort );
1573 // Now that ignore_user_abort is restored, we can respond to fatal errors
1574 if ( !$status->isOK() ) {
1575 wfProfileOut( __METHOD__
);
1579 # Update links tables, site stats, etc.
1580 $this->doEditUpdates( $revision, $user, array( 'changed' => $changed,
1581 'oldcountable' => $oldcountable ) );
1584 $status->warning( 'edit-no-change' );
1586 // Update page_touched, this is usually implicit in the page update
1587 // Other cache updates are done in onArticleEdit()
1588 $this->mTitle
->invalidateCache();
1591 # Create new article
1592 $status->value
['new'] = true;
1594 $dbw->begin( __METHOD__
);
1596 # Add the page record; stake our claim on this title!
1597 # This will return false if the article already exists
1598 $newid = $this->insertOn( $dbw );
1600 if ( $newid === false ) {
1601 $dbw->rollback( __METHOD__
);
1602 $status->fatal( 'edit-already-exists' );
1604 wfProfileOut( __METHOD__
);
1608 # Save the revision text...
1609 $revision = new Revision( array(
1611 'comment' => $summary,
1612 'minor_edit' => $isminor,
1614 'user' => $user->getId(),
1615 'user_text' => $user->getName(),
1618 $revisionId = $revision->insertOn( $dbw );
1620 # Update the page record with revision data
1621 $this->updateRevisionOn( $dbw, $revision, 0 );
1623 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1625 # Update recentchanges
1626 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1627 global $wgUseRCPatrol, $wgUseNPPatrol;
1629 # Mark as patrolled if the user can do so
1630 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
1631 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1632 # Add RC row to the DB
1633 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
1634 '', strlen( $text ), $revisionId, $patrolled );
1636 # Log auto-patrolled edits
1638 PatrolLog
::record( $rc, true, $user );
1641 $user->incEditCount();
1642 $dbw->commit( __METHOD__
);
1644 # Update links, etc.
1645 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1647 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
1648 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
1651 # Do updates right now unless deferral was requested
1652 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
1653 DeferredUpdates
::doUpdates();
1656 // Return the new revision (or null) to the caller
1657 $status->value
['revision'] = $revision;
1659 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
1660 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
1662 # Promote user to any groups they meet the criteria for
1663 $user->addAutopromoteOnceGroups( 'onEdit' );
1665 wfProfileOut( __METHOD__
);
1670 * Get parser options suitable for rendering the primary article wikitext
1671 * @param User|string $user User object or 'canonical'
1672 * @return ParserOptions
1674 public function makeParserOptions( $user ) {
1676 if ( $user instanceof User
) { // settings per user (even anons)
1677 $options = ParserOptions
::newFromUser( $user );
1678 } else { // canonical settings
1679 $options = ParserOptions
::newFromUserAndLang( new User
, $wgContLang );
1681 $options->enableLimitReport(); // show inclusion/loop reports
1682 $options->setTidy( true ); // fix bad HTML
1687 * Prepare text which is about to be saved.
1688 * Returns a stdclass with source, pst and output members
1689 * @return bool|object
1691 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
1692 global $wgParser, $wgContLang, $wgUser;
1693 $user = is_null( $user ) ?
$wgUser : $user;
1694 // @TODO fixme: check $user->getId() here???
1695 if ( $this->mPreparedEdit
1696 && $this->mPreparedEdit
->newText
== $text
1697 && $this->mPreparedEdit
->revid
== $revid
1700 return $this->mPreparedEdit
;
1703 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
1704 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
1706 $edit = (object)array();
1707 $edit->revid
= $revid;
1708 $edit->newText
= $text;
1709 $edit->pst
= $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
1710 $edit->popts
= $this->makeParserOptions( 'canonical' );
1711 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
1712 $edit->oldText
= $this->getRawText();
1714 $this->mPreparedEdit
= $edit;
1720 * Do standard deferred updates after page edit.
1721 * Update links tables, site stats, search index and message cache.
1722 * Purges pages that include this page if the text was changed here.
1723 * Every 100th edit, prune the recent changes table.
1726 * @param $revision Revision object
1727 * @param $user User object that did the revision
1728 * @param $options Array of options, following indexes are used:
1729 * - changed: boolean, whether the revision changed the content (default true)
1730 * - created: boolean, whether the revision created the page (default false)
1731 * - oldcountable: boolean or null (default null):
1732 * - boolean: whether the page was counted as an article before that
1733 * revision, only used in changed is true and created is false
1734 * - null: don't change the article count
1736 public function doEditUpdates( Revision
$revision, User
$user, array $options = array() ) {
1737 global $wgEnableParserCache;
1739 wfProfileIn( __METHOD__
);
1741 $options +
= array( 'changed' => true, 'created' => false, 'oldcountable' => null );
1742 $text = $revision->getText();
1745 # Be careful not to double-PST: $text is usually already PST-ed once
1746 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
1747 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
1748 $editInfo = $this->prepareTextForEdit( $text, $revision->getId(), $user );
1750 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
1751 $editInfo = $this->mPreparedEdit
;
1754 # Save it to the parser cache
1755 if ( $wgEnableParserCache ) {
1756 $parserCache = ParserCache
::singleton();
1757 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
1760 # Update the links tables and other secondary data
1761 $updates = $editInfo->output
->getSecondaryDataUpdates( $this->mTitle
);
1762 DataUpdate
::runUpdates( $updates );
1764 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
1766 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
1767 if ( 0 == mt_rand( 0, 99 ) ) {
1768 // Flush old entries from the `recentchanges` table; we do this on
1769 // random requests so as to avoid an increase in writes for no good reason
1772 $dbw = wfGetDB( DB_MASTER
);
1773 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
1776 array( "rc_timestamp < '$cutoff'" ),
1782 if ( !$this->mTitle
->exists() ) {
1783 wfProfileOut( __METHOD__
);
1787 $id = $this->getId();
1788 $title = $this->mTitle
->getPrefixedDBkey();
1789 $shortTitle = $this->mTitle
->getDBkey();
1791 if ( !$options['changed'] ) {
1794 } elseif ( $options['created'] ) {
1795 $good = (int)$this->isCountable( $editInfo );
1797 } elseif ( $options['oldcountable'] !== null ) {
1798 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
1805 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) );
1806 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $text ) );
1808 # If this is another user's talk page, update newtalk.
1809 # Don't do this if $options['changed'] = false (null-edits) nor if
1810 # it's a minor edit and the user doesn't want notifications for those.
1811 if ( $options['changed']
1812 && $this->mTitle
->getNamespace() == NS_USER_TALK
1813 && $shortTitle != $user->getTitleKey()
1814 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
1816 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
1817 $other = User
::newFromName( $shortTitle, false );
1819 wfDebug( __METHOD__
. ": invalid username\n" );
1820 } elseif ( User
::isIP( $shortTitle ) ) {
1821 // An anonymous user
1822 $other->setNewtalk( true );
1823 } elseif ( $other->isLoggedIn() ) {
1824 $other->setNewtalk( true );
1826 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
1831 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1832 MessageCache
::singleton()->replace( $shortTitle, $text );
1835 if( $options['created'] ) {
1836 self
::onArticleCreate( $this->mTitle
);
1838 self
::onArticleEdit( $this->mTitle
);
1841 wfProfileOut( __METHOD__
);
1845 * Edit an article without doing all that other stuff
1846 * The article must already exist; link tables etc
1847 * are not updated, caches are not flushed.
1849 * @param $text String: text submitted
1850 * @param $user User The relevant user
1851 * @param $comment String: comment submitted
1852 * @param $minor Boolean: whereas it's a minor modification
1854 public function doQuickEdit( $text, User
$user, $comment = '', $minor = 0 ) {
1855 wfProfileIn( __METHOD__
);
1857 $dbw = wfGetDB( DB_MASTER
);
1858 $revision = new Revision( array(
1859 'page' => $this->getId(),
1861 'comment' => $comment,
1862 'minor_edit' => $minor ?
1 : 0,
1864 $revision->insertOn( $dbw );
1865 $this->updateRevisionOn( $dbw, $revision );
1867 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1869 wfProfileOut( __METHOD__
);
1873 * Update the article's restriction field, and leave a log entry.
1874 * This works for protection both existing and non-existing pages.
1876 * @param $limit Array: set of restriction keys
1877 * @param $reason String
1878 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
1879 * @param $expiry Array: per restriction type expiration
1880 * @param $user User The user updating the restrictions
1883 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade, $reason, User
$user ) {
1886 if ( wfReadOnly() ) {
1887 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
1890 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
1892 $id = $this->mTitle
->getArticleID();
1898 // Take this opportunity to purge out expired restrictions
1899 Title
::purgeExpiredRestrictions();
1901 # @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
1902 # we expect a single selection, but the schema allows otherwise.
1903 $isProtected = false;
1907 $dbw = wfGetDB( DB_MASTER
);
1909 foreach ( $restrictionTypes as $action ) {
1910 if ( !isset( $expiry[$action] ) ) {
1911 $expiry[$action] = $dbw->getInfinity();
1913 if ( !isset( $limit[$action] ) ) {
1914 $limit[$action] = '';
1915 } elseif ( $limit[$action] != '' ) {
1919 # Get current restrictions on $action
1920 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
1921 if ( $current != '' ) {
1922 $isProtected = true;
1925 if ( $limit[$action] != $current ) {
1927 } elseif ( $limit[$action] != '' ) {
1928 # Only check expiry change if the action is actually being
1929 # protected, since expiry does nothing on an not-protected
1931 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
1937 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
1941 # If nothing's changed, do nothing
1943 return Status
::newGood();
1946 if ( !$protect ) { # No protection at all means unprotection
1947 $revCommentMsg = 'unprotectedarticle';
1948 $logAction = 'unprotect';
1949 } elseif ( $isProtected ) {
1950 $revCommentMsg = 'modifiedarticleprotection';
1951 $logAction = 'modify';
1953 $revCommentMsg = 'protectedarticle';
1954 $logAction = 'protect';
1957 $encodedExpiry = array();
1958 $protectDescription = '';
1959 foreach ( $limit as $action => $restrictions ) {
1960 $encodedExpiry[$action] = $dbw->encodeExpiry( $expiry[$action] );
1961 if ( $restrictions != '' ) {
1962 $protectDescription .= $wgContLang->getDirMark() . "[$action=$restrictions] (";
1963 if ( $encodedExpiry[$action] != 'infinity' ) {
1964 $protectDescription .= wfMsgForContent( 'protect-expiring',
1965 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
1966 $wgContLang->date( $expiry[$action], false, false ) ,
1967 $wgContLang->time( $expiry[$action], false, false ) );
1969 $protectDescription .= wfMsgForContent( 'protect-expiry-indefinite' );
1972 $protectDescription .= ') ';
1975 $protectDescription = trim( $protectDescription );
1977 if ( $id ) { # Protection of existing page
1978 if ( !wfRunHooks( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
1979 return Status
::newGood();
1982 # Only restrictions with the 'protect' right can cascade...
1983 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
1984 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
1986 # The schema allows multiple restrictions
1987 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
1991 # Update restrictions table
1992 foreach ( $limit as $action => $restrictions ) {
1993 if ( $restrictions != '' ) {
1994 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
1995 array( 'pr_page' => $id,
1996 'pr_type' => $action,
1997 'pr_level' => $restrictions,
1998 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
1999 'pr_expiry' => $encodedExpiry[$action]
2004 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2005 'pr_type' => $action ), __METHOD__
);
2009 # Prepare a null revision to be added to the history
2010 $editComment = $wgContLang->ucfirst( wfMsgForContent( $revCommentMsg, $this->mTitle
->getPrefixedText() ) );
2012 $editComment .= ": $reason";
2014 if ( $protectDescription ) {
2015 $editComment .= " ($protectDescription)";
2018 $editComment .= ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2021 # Insert a null revision
2022 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2023 $nullRevId = $nullRevision->insertOn( $dbw );
2025 $latest = $this->getLatest();
2026 # Update page record
2027 $dbw->update( 'page',
2029 'page_touched' => $dbw->timestamp(),
2030 'page_restrictions' => '',
2031 'page_latest' => $nullRevId
2032 ), array( /* WHERE */
2037 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2038 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2039 } else { # Protection of non-existing page (also known as "title protection")
2040 # Cascade protection is meaningless in this case
2043 if ( $limit['create'] != '' ) {
2044 $dbw->replace( 'protected_titles',
2045 array( array( 'pt_namespace', 'pt_title' ) ),
2047 'pt_namespace' => $this->mTitle
->getNamespace(),
2048 'pt_title' => $this->mTitle
->getDBkey(),
2049 'pt_create_perm' => $limit['create'],
2050 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ),
2051 'pt_expiry' => $encodedExpiry['create'],
2052 'pt_user' => $user->getId(),
2053 'pt_reason' => $reason,
2057 $dbw->delete( 'protected_titles',
2059 'pt_namespace' => $this->mTitle
->getNamespace(),
2060 'pt_title' => $this->mTitle
->getDBkey()
2066 $this->mTitle
->flushRestrictions();
2068 if ( $logAction == 'unprotect' ) {
2069 $logParams = array();
2071 $logParams = array( $protectDescription, $cascade ?
'cascade' : '' );
2074 # Update the protection log
2075 $log = new LogPage( 'protect' );
2076 $log->addEntry( $logAction, $this->mTitle
, trim( $reason ), $logParams, $user );
2078 return Status
::newGood();
2082 * Take an array of page restrictions and flatten it to a string
2083 * suitable for insertion into the page_restrictions field.
2084 * @param $limit Array
2087 protected static function flattenRestrictions( $limit ) {
2088 if ( !is_array( $limit ) ) {
2089 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2095 foreach ( $limit as $action => $restrictions ) {
2096 if ( $restrictions != '' ) {
2097 $bits[] = "$action=$restrictions";
2101 return implode( ':', $bits );
2105 * Same as doDeleteArticleReal(), but returns more detailed success/failure status
2106 * Deletes the article with database consistency, writes logs, purges caches
2108 * @param $reason string delete reason for deletion log
2109 * @param $suppress int bitfield
2110 * Revision::DELETED_TEXT
2111 * Revision::DELETED_COMMENT
2112 * Revision::DELETED_USER
2113 * Revision::DELETED_RESTRICTED
2114 * @param $id int article ID
2115 * @param $commit boolean defaults to true, triggers transaction end
2116 * @param &$error Array of errors to append to
2117 * @param $user User The deleting user
2118 * @return boolean true if successful
2120 public function doDeleteArticle(
2121 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2123 return $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user )
2124 == WikiPage
::DELETE_SUCCESS
;
2128 * Back-end article deletion
2129 * Deletes the article with database consistency, writes logs, purges caches
2131 * @param $reason string delete reason for deletion log
2132 * @param $suppress int bitfield
2133 * Revision::DELETED_TEXT
2134 * Revision::DELETED_COMMENT
2135 * Revision::DELETED_USER
2136 * Revision::DELETED_RESTRICTED
2137 * @param $id int article ID
2138 * @param $commit boolean defaults to true, triggers transaction end
2139 * @param &$error Array of errors to append to
2140 * @param $user User The deleting user
2141 * @return int: One of WikiPage::DELETE_* constants
2143 public function doDeleteArticleReal(
2144 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2148 wfDebug( __METHOD__
. "\n" );
2150 if ( $this->mTitle
->getDBkey() === '' ) {
2151 return WikiPage
::DELETE_NO_PAGE
;
2154 $user = is_null( $user ) ?
$wgUser : $user;
2155 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error ) ) ) {
2156 return WikiPage
::DELETE_HOOK_ABORTED
;
2160 $this->loadPageData( 'forupdate' );
2161 $id = $this->getID();
2163 return WikiPage
::DELETE_NO_PAGE
;
2167 // Bitfields to further suppress the content
2170 // This should be 15...
2171 $bitfield |
= Revision
::DELETED_TEXT
;
2172 $bitfield |
= Revision
::DELETED_COMMENT
;
2173 $bitfield |
= Revision
::DELETED_USER
;
2174 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2176 $bitfield = 'rev_deleted';
2179 $dbw = wfGetDB( DB_MASTER
);
2180 $dbw->begin( __METHOD__
);
2181 // For now, shunt the revision data into the archive table.
2182 // Text is *not* removed from the text table; bulk storage
2183 // is left intact to avoid breaking block-compression or
2184 // immutable storage schemes.
2186 // For backwards compatibility, note that some older archive
2187 // table entries will have ar_text and ar_flags fields still.
2189 // In the future, we may keep revisions and mark them with
2190 // the rev_deleted field, which is reserved for this purpose.
2191 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2193 'ar_namespace' => 'page_namespace',
2194 'ar_title' => 'page_title',
2195 'ar_comment' => 'rev_comment',
2196 'ar_user' => 'rev_user',
2197 'ar_user_text' => 'rev_user_text',
2198 'ar_timestamp' => 'rev_timestamp',
2199 'ar_minor_edit' => 'rev_minor_edit',
2200 'ar_rev_id' => 'rev_id',
2201 'ar_parent_id' => 'rev_parent_id',
2202 'ar_text_id' => 'rev_text_id',
2203 'ar_text' => '\'\'', // Be explicit to appease
2204 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2205 'ar_len' => 'rev_len',
2206 'ar_page_id' => 'page_id',
2207 'ar_deleted' => $bitfield,
2208 'ar_sha1' => 'rev_sha1'
2211 'page_id = rev_page'
2215 # Now that it's safely backed up, delete it
2216 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2217 $ok = ( $dbw->affectedRows() > 0 ); // getArticleID() uses slave, could be laggy
2220 $dbw->rollback( __METHOD__
);
2221 return WikiPage
::DELETE_NO_REVISIONS
;
2224 $this->doDeleteUpdates( $id );
2226 # Log the deletion, if the page was suppressed, log it at Oversight instead
2227 $logtype = $suppress ?
'suppress' : 'delete';
2229 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2230 $logEntry->setPerformer( $user );
2231 $logEntry->setTarget( $this->mTitle
);
2232 $logEntry->setComment( $reason );
2233 $logid = $logEntry->insert();
2234 $logEntry->publish( $logid );
2237 $dbw->commit( __METHOD__
);
2240 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id ) );
2241 return WikiPage
::DELETE_SUCCESS
;
2245 * Do some database updates after deletion
2247 * @param $id Int: page_id value of the page being deleted (B/C, currently unused)
2249 public function doDeleteUpdates( $id ) {
2250 # update site status
2251 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2253 # remove secondary indexes, etc
2254 $updates = $this->getDeletionUpdates( );
2255 DataUpdate
::runUpdates( $updates );
2258 WikiPage
::onArticleDelete( $this->mTitle
);
2263 # Clear the cached article id so the interface doesn't act like we exist
2264 $this->mTitle
->resetArticleID( 0 );
2267 public function getDeletionUpdates() {
2269 new LinksDeletionUpdate( $this ),
2272 //@todo: make a hook to add update objects
2273 //NOTE: deletion updates will be determined by the ContentHandler in the future
2278 * Roll back the most recent consecutive set of edits to a page
2279 * from the same user; fails if there are no eligible edits to
2280 * roll back to, e.g. user is the sole contributor. This function
2281 * performs permissions checks on $user, then calls commitRollback()
2282 * to do the dirty work
2284 * @todo: seperate the business/permission stuff out from backend code
2286 * @param $fromP String: Name of the user whose edits to rollback.
2287 * @param $summary String: Custom summary. Set to default summary if empty.
2288 * @param $token String: Rollback token.
2289 * @param $bot Boolean: If true, mark all reverted edits as bot.
2291 * @param $resultDetails Array: contains result-specific array of additional values
2292 * 'alreadyrolled' : 'current' (rev)
2293 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2295 * @param $user User The user performing the rollback
2296 * @return array of errors, each error formatted as
2297 * array(messagekey, param1, param2, ...).
2298 * On success, the array is empty. This array can also be passed to
2299 * OutputPage::showPermissionsErrorPage().
2301 public function doRollback(
2302 $fromP, $summary, $token, $bot, &$resultDetails, User
$user
2304 $resultDetails = null;
2307 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
2308 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
2309 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2311 if ( !$user->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
2312 $errors[] = array( 'sessionfailure' );
2315 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
2316 $errors[] = array( 'actionthrottledtext' );
2319 # If there were errors, bail out now
2320 if ( !empty( $errors ) ) {
2324 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2328 * Backend implementation of doRollback(), please refer there for parameter
2329 * and return value documentation
2331 * NOTE: This function does NOT check ANY permissions, it just commits the
2332 * rollback to the DB. Therefore, you should only call this function direct-
2333 * ly if you want to use custom permissions checks. If you don't, use
2334 * doRollback() instead.
2335 * @param $fromP String: Name of the user whose edits to rollback.
2336 * @param $summary String: Custom summary. Set to default summary if empty.
2337 * @param $bot Boolean: If true, mark all reverted edits as bot.
2339 * @param $resultDetails Array: contains result-specific array of additional values
2340 * @param $guser User The user performing the rollback
2343 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser ) {
2344 global $wgUseRCPatrol, $wgContLang;
2346 $dbw = wfGetDB( DB_MASTER
);
2348 if ( wfReadOnly() ) {
2349 return array( array( 'readonlytext' ) );
2352 # Get the last editor
2353 $current = $this->getRevision();
2354 if ( is_null( $current ) ) {
2355 # Something wrong... no page?
2356 return array( array( 'notanarticle' ) );
2359 $from = str_replace( '_', ' ', $fromP );
2360 # User name given should match up with the top revision.
2361 # If the user was deleted then $from should be empty.
2362 if ( $from != $current->getUserText() ) {
2363 $resultDetails = array( 'current' => $current );
2364 return array( array( 'alreadyrolled',
2365 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
2366 htmlspecialchars( $fromP ),
2367 htmlspecialchars( $current->getUserText() )
2371 # Get the last edit not by this guy...
2372 # Note: these may not be public values
2373 $user = intval( $current->getRawUser() );
2374 $user_text = $dbw->addQuotes( $current->getRawUserText() );
2375 $s = $dbw->selectRow( 'revision',
2376 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
2377 array( 'rev_page' => $current->getPage(),
2378 "rev_user != {$user} OR rev_user_text != {$user_text}"
2380 array( 'USE INDEX' => 'page_timestamp',
2381 'ORDER BY' => 'rev_timestamp DESC' )
2383 if ( $s === false ) {
2384 # No one else ever edited this page
2385 return array( array( 'cantrollback' ) );
2386 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
2387 # Only admins can see this text
2388 return array( array( 'notvisiblerev' ) );
2392 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
2393 # Mark all reverted edits as bot
2397 if ( $wgUseRCPatrol ) {
2398 # Mark all reverted edits as patrolled
2399 $set['rc_patrolled'] = 1;
2402 if ( count( $set ) ) {
2403 $dbw->update( 'recentchanges', $set,
2405 'rc_cur_id' => $current->getPage(),
2406 'rc_user_text' => $current->getUserText(),
2407 "rc_timestamp > '{$s->rev_timestamp}'",
2412 # Generate the edit summary if necessary
2413 $target = Revision
::newFromId( $s->rev_id
);
2414 if ( empty( $summary ) ) {
2415 if ( $from == '' ) { // no public user name
2416 $summary = wfMsgForContent( 'revertpage-nouser' );
2418 $summary = wfMsgForContent( 'revertpage' );
2422 # Allow the custom summary to use the same args as the default message
2424 $target->getUserText(), $from, $s->rev_id
,
2425 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
2426 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
2428 $summary = wfMsgReplaceArgs( $summary, $args );
2431 $flags = EDIT_UPDATE
;
2433 if ( $guser->isAllowed( 'minoredit' ) ) {
2434 $flags |
= EDIT_MINOR
;
2437 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
2438 $flags |
= EDIT_FORCE_BOT
;
2441 # Actually store the edit
2442 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId(), $guser );
2443 if ( !empty( $status->value
['revision'] ) ) {
2444 $revId = $status->value
['revision']->getId();
2449 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
2451 $resultDetails = array(
2452 'summary' => $summary,
2453 'current' => $current,
2454 'target' => $target,
2462 * The onArticle*() functions are supposed to be a kind of hooks
2463 * which should be called whenever any of the specified actions
2466 * This is a good place to put code to clear caches, for instance.
2468 * This is called on page move and undelete, as well as edit
2470 * @param $title Title object
2472 public static function onArticleCreate( $title ) {
2473 # Update existence markers on article/talk tabs...
2474 if ( $title->isTalkPage() ) {
2475 $other = $title->getSubjectPage();
2477 $other = $title->getTalkPage();
2480 $other->invalidateCache();
2481 $other->purgeSquid();
2483 $title->touchLinks();
2484 $title->purgeSquid();
2485 $title->deleteTitleProtection();
2489 * Clears caches when article is deleted
2491 * @param $title Title
2493 public static function onArticleDelete( $title ) {
2494 # Update existence markers on article/talk tabs...
2495 if ( $title->isTalkPage() ) {
2496 $other = $title->getSubjectPage();
2498 $other = $title->getTalkPage();
2501 $other->invalidateCache();
2502 $other->purgeSquid();
2504 $title->touchLinks();
2505 $title->purgeSquid();
2508 HTMLFileCache
::clearFileCache( $title );
2511 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
2512 MessageCache
::singleton()->replace( $title->getDBkey(), false );
2516 if ( $title->getNamespace() == NS_FILE
) {
2517 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
2518 $update->doUpdate();
2522 if ( $title->getNamespace() == NS_USER_TALK
) {
2523 $user = User
::newFromName( $title->getText(), false );
2525 $user->setNewtalk( false );
2530 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
2534 * Purge caches on page update etc
2536 * @param $title Title object
2537 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
2539 public static function onArticleEdit( $title ) {
2540 // Invalidate caches of articles which include this page
2541 DeferredUpdates
::addHTMLCacheUpdate( $title, 'templatelinks' );
2544 // Invalidate the caches of all pages which redirect here
2545 DeferredUpdates
::addHTMLCacheUpdate( $title, 'redirect' );
2547 # Purge squid for this page only
2548 $title->purgeSquid();
2550 # Clear file cache for this page only
2551 HTMLFileCache
::clearFileCache( $title );
2557 * Returns a list of hidden categories this page is a member of.
2558 * Uses the page_props and categorylinks tables.
2560 * @return Array of Title objects
2562 public function getHiddenCategories() {
2564 $id = $this->mTitle
->getArticleID();
2570 $dbr = wfGetDB( DB_SLAVE
);
2571 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
2573 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
2574 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
2577 if ( $res !== false ) {
2578 foreach ( $res as $row ) {
2579 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
2587 * Return an applicable autosummary if one exists for the given edit.
2588 * @param $oldtext String: the previous text of the page.
2589 * @param $newtext String: The submitted text of the page.
2590 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
2591 * @return string An appropriate autosummary, or an empty string.
2593 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2596 # Decide what kind of autosummary is needed.
2598 # Redirect autosummaries
2599 $ot = Title
::newFromRedirect( $oldtext );
2600 $rt = Title
::newFromRedirect( $newtext );
2602 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
2603 $truncatedtext = $wgContLang->truncate(
2604 str_replace( "\n", ' ', $newtext ),
2606 - strlen( wfMsgForContent( 'autoredircomment' ) )
2607 - strlen( $rt->getFullText() )
2609 return wfMsgForContent( 'autoredircomment', $rt->getFullText(), $truncatedtext );
2612 # New page autosummaries
2613 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
2614 # If they're making a new article, give its text, truncated, in the summary.
2616 $truncatedtext = $wgContLang->truncate(
2617 str_replace( "\n", ' ', $newtext ),
2618 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
2620 return wfMsgForContent( 'autosumm-new', $truncatedtext );
2623 # Blanking autosummaries
2624 if ( $oldtext != '' && $newtext == '' ) {
2625 return wfMsgForContent( 'autosumm-blank' );
2626 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
2627 # Removing more than 90% of the article
2629 $truncatedtext = $wgContLang->truncate(
2631 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
2633 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
2636 # If we reach this point, there's no applicable autosummary for our case, so our
2637 # autosummary is empty.
2642 * Auto-generates a deletion reason
2644 * @param &$hasHistory Boolean: whether the page has a history
2645 * @return mixed String containing deletion reason or empty string, or boolean false
2646 * if no revision occurred
2648 public function getAutoDeleteReason( &$hasHistory ) {
2651 // Get the last revision
2652 $rev = $this->getRevision();
2654 if ( is_null( $rev ) ) {
2658 // Get the article's contents
2659 $contents = $rev->getText();
2662 // If the page is blank, use the text from the previous revision,
2663 // which can only be blank if there's a move/import/protect dummy revision involved
2664 if ( $contents == '' ) {
2665 $prev = $rev->getPrevious();
2668 $contents = $prev->getText();
2673 $dbw = wfGetDB( DB_MASTER
);
2675 // Find out if there was only one contributor
2676 // Only scan the last 20 revisions
2677 $res = $dbw->select( 'revision', 'rev_user_text',
2678 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2680 array( 'LIMIT' => 20 )
2683 if ( $res === false ) {
2684 // This page has no revisions, which is very weird
2688 $hasHistory = ( $res->numRows() > 1 );
2689 $row = $dbw->fetchObject( $res );
2691 if ( $row ) { // $row is false if the only contributor is hidden
2692 $onlyAuthor = $row->rev_user_text
;
2693 // Try to find a second contributor
2694 foreach ( $res as $row ) {
2695 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2696 $onlyAuthor = false;
2701 $onlyAuthor = false;
2704 // Generate the summary with a '$1' placeholder
2706 // The current revision is blank and the one before is also
2707 // blank. It's just not our lucky day
2708 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2710 if ( $onlyAuthor ) {
2711 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2713 $reason = wfMsgForContent( 'excontent', '$1' );
2717 if ( $reason == '-' ) {
2718 // Allow these UI messages to be blanked out cleanly
2722 // Replace newlines with spaces to prevent uglyness
2723 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2724 // Calculate the maximum amount of chars to get
2725 // Max content length = max comment length - length of the comment (excl. $1)
2726 $maxLength = 255 - ( strlen( $reason ) - 2 );
2727 $contents = $wgContLang->truncate( $contents, $maxLength );
2728 // Remove possible unfinished links
2729 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2730 // Now replace the '$1' placeholder
2731 $reason = str_replace( '$1', $contents, $reason );
2737 * Update all the appropriate counts in the category table, given that
2738 * we've added the categories $added and deleted the categories $deleted.
2740 * @param $added array The names of categories that were added
2741 * @param $deleted array The names of categories that were deleted
2743 public function updateCategoryCounts( $added, $deleted ) {
2744 $ns = $this->mTitle
->getNamespace();
2745 $dbw = wfGetDB( DB_MASTER
);
2747 # First make sure the rows exist. If one of the "deleted" ones didn't
2748 # exist, we might legitimately not create it, but it's simpler to just
2749 # create it and then give it a negative value, since the value is bogus
2752 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
2753 $insertCats = array_merge( $added, $deleted );
2754 if ( !$insertCats ) {
2755 # Okay, nothing to do
2759 $insertRows = array();
2761 foreach ( $insertCats as $cat ) {
2762 $insertRows[] = array(
2763 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
2767 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
2769 $addFields = array( 'cat_pages = cat_pages + 1' );
2770 $removeFields = array( 'cat_pages = cat_pages - 1' );
2772 if ( $ns == NS_CATEGORY
) {
2773 $addFields[] = 'cat_subcats = cat_subcats + 1';
2774 $removeFields[] = 'cat_subcats = cat_subcats - 1';
2775 } elseif ( $ns == NS_FILE
) {
2776 $addFields[] = 'cat_files = cat_files + 1';
2777 $removeFields[] = 'cat_files = cat_files - 1';
2784 array( 'cat_title' => $added ),
2793 array( 'cat_title' => $deleted ),
2800 * Updates cascading protections
2802 * @param $parserOutput ParserOutput object for the current version
2804 public function doCascadeProtectionUpdates( ParserOutput
$parserOutput ) {
2805 if ( wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
2809 // templatelinks table may have become out of sync,
2810 // especially if using variable-based transclusions.
2811 // For paranoia, check if things have changed and if
2812 // so apply updates to the database. This will ensure
2813 // that cascaded protections apply as soon as the changes
2816 # Get templates from templatelinks
2817 $id = $this->mTitle
->getArticleID();
2819 $tlTemplates = array();
2821 $dbr = wfGetDB( DB_SLAVE
);
2822 $res = $dbr->select( array( 'templatelinks' ),
2823 array( 'tl_namespace', 'tl_title' ),
2824 array( 'tl_from' => $id ),
2828 foreach ( $res as $row ) {
2829 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
2832 # Get templates from parser output.
2833 $poTemplates = array();
2834 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
2835 foreach ( $templates as $dbk => $id ) {
2836 $poTemplates["$ns:$dbk"] = true;
2841 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
2843 if ( count( $templates_diff ) > 0 ) {
2844 # Whee, link updates time.
2845 # Note: we are only interested in links here. We don't need to get other DataUpdate items from the parser output.
2846 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
2852 * Return a list of templates used by this article.
2853 * Uses the templatelinks table
2855 * @deprecated in 1.19; use Title::getTemplateLinksFrom()
2856 * @return Array of Title objects
2858 public function getUsedTemplates() {
2859 return $this->mTitle
->getTemplateLinksFrom();
2863 * Perform article updates on a special page creation.
2865 * @param $rev Revision object
2867 * @todo This is a shitty interface function. Kill it and replace the
2868 * other shitty functions like doEditUpdates and such so it's not needed
2870 * @deprecated since 1.18, use doEditUpdates()
2872 public function createUpdates( $rev ) {
2873 wfDeprecated( __METHOD__
, '1.18' );
2875 $this->doEditUpdates( $rev, $wgUser, array( 'created' => true ) );
2879 * This function is called right before saving the wikitext,
2880 * so we can do things like signatures and links-in-context.
2882 * @deprecated in 1.19; use Parser::preSaveTransform() instead
2883 * @param $text String article contents
2884 * @param $user User object: user doing the edit
2885 * @param $popts ParserOptions object: parser options, default options for
2886 * the user loaded if null given
2887 * @return string article contents with altered wikitext markup (signatures
2888 * converted, {{subst:}}, templates, etc.)
2890 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
2891 global $wgParser, $wgUser;
2893 wfDeprecated( __METHOD__
, '1.19' );
2895 $user = is_null( $user ) ?
$wgUser : $user;
2897 if ( $popts === null ) {
2898 $popts = ParserOptions
::newFromUser( $user );
2901 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
2905 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
2907 * @deprecated in 1.19; use Title::isBigDeletion() instead.
2910 public function isBigDeletion() {
2911 wfDeprecated( __METHOD__
, '1.19' );
2912 return $this->mTitle
->isBigDeletion();
2916 * Get the approximate revision count of this page.
2918 * @deprecated in 1.19; use Title::estimateRevisionCount() instead.
2921 public function estimateRevisionCount() {
2922 wfDeprecated( __METHOD__
, '1.19' );
2923 return $this->mTitle
->estimateRevisionCount();
2927 * Update the article's restriction field, and leave a log entry.
2929 * @deprecated since 1.19
2930 * @param $limit Array: set of restriction keys
2931 * @param $reason String
2932 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2933 * @param $expiry Array: per restriction type expiration
2934 * @param $user User The user updating the restrictions
2935 * @return bool true on success
2937 public function updateRestrictions(
2938 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User
$user = null
2942 $user = is_null( $user ) ?
$wgUser : $user;
2944 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
2948 * @deprecated since 1.18
2950 public function quickEdit( $text, $comment = '', $minor = 0 ) {
2951 wfDeprecated( __METHOD__
, '1.18' );
2953 return $this->doQuickEdit( $text, $wgUser, $comment, $minor );
2957 * @deprecated since 1.18
2959 public function viewUpdates() {
2960 wfDeprecated( __METHOD__
, '1.18' );
2962 return $this->doViewUpdates( $wgUser );
2966 * @deprecated since 1.18
2969 public function useParserCache( $oldid ) {
2970 wfDeprecated( __METHOD__
, '1.18' );
2972 return $this->isParserCacheUsed( ParserOptions
::newFromUser( $wgUser ), $oldid );
2976 class PoolWorkArticleView
extends PoolCounterWork
{
2994 * @var ParserOptions
2996 private $parserOptions;
3004 * @var ParserOutput|bool
3006 private $parserOutput = false;
3011 private $isDirty = false;
3016 private $error = false;
3022 * @param $revid Integer: ID of the revision being parsed
3023 * @param $useParserCache Boolean: whether to use the parser cache
3024 * @param $parserOptions parserOptions to use for the parse operation
3025 * @param $text String: text to parse or null to load it
3027 function __construct( Page
$page, ParserOptions
$parserOptions, $revid, $useParserCache, $text = null ) {
3028 $this->page
= $page;
3029 $this->revid
= $revid;
3030 $this->cacheable
= $useParserCache;
3031 $this->parserOptions
= $parserOptions;
3032 $this->text
= $text;
3033 $this->cacheKey
= ParserCache
::singleton()->getKey( $page, $parserOptions );
3034 parent
::__construct( 'ArticleView', $this->cacheKey
. ':revid:' . $revid );
3038 * Get the ParserOutput from this object, or false in case of failure
3040 * @return ParserOutput
3042 public function getParserOutput() {
3043 return $this->parserOutput
;
3047 * Get whether the ParserOutput is a dirty one (i.e. expired)
3051 public function getIsDirty() {
3052 return $this->isDirty
;
3056 * Get a Status object in case of error or false otherwise
3058 * @return Status|bool
3060 public function getError() {
3061 return $this->error
;
3068 global $wgParser, $wgUseFileCache;
3070 $isCurrent = $this->revid
=== $this->page
->getLatest();
3072 if ( $this->text
!== null ) {
3073 $text = $this->text
;
3074 } elseif ( $isCurrent ) {
3075 $text = $this->page
->getRawText();
3077 $rev = Revision
::newFromTitle( $this->page
->getTitle(), $this->revid
);
3078 if ( $rev === null ) {
3081 $text = $rev->getText();
3084 $time = - microtime( true );
3085 $this->parserOutput
= $wgParser->parse( $text, $this->page
->getTitle(),
3086 $this->parserOptions
, true, true, $this->revid
);
3087 $time +
= microtime( true );
3091 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
3092 $this->page
->getTitle()->getPrefixedDBkey() ) );
3095 if ( $this->cacheable
&& $this->parserOutput
->isCacheable() ) {
3096 ParserCache
::singleton()->save( $this->parserOutput
, $this->page
, $this->parserOptions
);
3099 // Make sure file cache is not used on uncacheable content.
3100 // Output that has magic words in it can still use the parser cache
3101 // (if enabled), though it will generally expire sooner.
3102 if ( !$this->parserOutput
->isCacheable() ||
$this->parserOutput
->containsOldMagic() ) {
3103 $wgUseFileCache = false;
3107 $this->page
->doCascadeProtectionUpdates( $this->parserOutput
);
3116 function getCachedWork() {
3117 $this->parserOutput
= ParserCache
::singleton()->get( $this->page
, $this->parserOptions
);
3119 if ( $this->parserOutput
=== false ) {
3120 wfDebug( __METHOD__
. ": parser cache miss\n" );
3123 wfDebug( __METHOD__
. ": parser cache hit\n" );
3131 function fallback() {
3132 $this->parserOutput
= ParserCache
::singleton()->getDirty( $this->page
, $this->parserOptions
);
3134 if ( $this->parserOutput
=== false ) {
3135 wfDebugLog( 'dirty', "dirty missing\n" );
3136 wfDebug( __METHOD__
. ": no dirty cache\n" );
3139 wfDebug( __METHOD__
. ": sending dirty output\n" );
3140 wfDebugLog( 'dirty', "dirty output {$this->cacheKey}\n" );
3141 $this->isDirty
= true;
3147 * @param $status Status
3150 function error( $status ) {
3151 $this->error
= $status;