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)
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 class WikiPage
implements Page
, IDBAccessObject
{
36 // Constants for $mDataLoadedFrom and related
41 public $mTitle = null;
46 public $mDataLoaded = false; // !< Boolean
47 public $mIsRedirect = false; // !< Boolean
48 public $mLatest = false; // !< Integer (false means "not loaded")
51 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
52 public $mPreparedEdit = false;
57 protected $mId = null;
60 * @var int One of the READ_* constants
62 protected $mDataLoadedFrom = self
::READ_NONE
;
67 protected $mRedirectTarget = null;
72 protected $mLastRevision = null;
75 * @var string Timestamp of the current revision or empty string if not loaded
77 protected $mTimestamp = '';
82 protected $mTouched = '19700101000000';
87 protected $mLinksUpdated = '19700101000000';
90 * Constructor and clear the article
91 * @param Title $title Reference to a Title object.
93 public function __construct( Title
$title ) {
94 $this->mTitle
= $title;
98 * Create a WikiPage object of the appropriate class for the given title.
100 * @param Title $title
102 * @throws MWException
103 * @return WikiPage Object of the appropriate type
105 public static function factory( Title
$title ) {
106 $ns = $title->getNamespace();
108 if ( $ns == NS_MEDIA
) {
109 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
110 } elseif ( $ns < 0 ) {
111 throw new MWException( "Invalid or virtual namespace $ns given." );
116 $page = new WikiFilePage( $title );
119 $page = new WikiCategoryPage( $title );
122 $page = new WikiPage( $title );
129 * Constructor from a page id
131 * @param int $id Article ID to load
132 * @param string|int $from One of the following values:
133 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
134 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
136 * @return WikiPage|null
138 public static function newFromID( $id, $from = 'fromdb' ) {
139 // page id's are never 0 or negative, see bug 61166
144 $from = self
::convertSelectType( $from );
145 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_SLAVE
);
146 $row = $db->selectRow( 'page', self
::selectFields(), array( 'page_id' => $id ), __METHOD__
);
150 return self
::newFromRow( $row, $from );
154 * Constructor from a database row
157 * @param object $row Database row containing at least fields returned by selectFields().
158 * @param string|int $from Source of $data:
159 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
160 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
161 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
164 public static function newFromRow( $row, $from = 'fromdb' ) {
165 $page = self
::factory( Title
::newFromRow( $row ) );
166 $page->loadFromRow( $row, $from );
171 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
173 * @param object|string|int $type
176 private static function convertSelectType( $type ) {
179 return self
::READ_NORMAL
;
181 return self
::READ_LATEST
;
183 return self
::READ_LOCKING
;
185 // It may already be an integer or whatever else
191 * Returns overrides for action handlers.
192 * Classes listed here will be used instead of the default one when
193 * (and only when) $wgActions[$action] === true. This allows subclasses
194 * to override the default behavior.
196 * @todo Move this UI stuff somewhere else
200 public function getActionOverrides() {
201 $content_handler = $this->getContentHandler();
202 return $content_handler->getActionOverrides();
206 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
208 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
210 * @return ContentHandler
214 public function getContentHandler() {
215 return ContentHandler
::getForModelID( $this->getContentModel() );
219 * Get the title object of the article
220 * @return Title Title object of this page
222 public function getTitle() {
223 return $this->mTitle
;
230 public function clear() {
231 $this->mDataLoaded
= false;
232 $this->mDataLoadedFrom
= self
::READ_NONE
;
234 $this->clearCacheFields();
238 * Clear the object cache fields
241 protected function clearCacheFields() {
243 $this->mRedirectTarget
= null; // Title object if set
244 $this->mLastRevision
= null; // Latest revision
245 $this->mTouched
= '19700101000000';
246 $this->mLinksUpdated
= '19700101000000';
247 $this->mTimestamp
= '';
248 $this->mIsRedirect
= false;
249 $this->mLatest
= false;
250 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
251 // the requested rev ID and content against the cached one for equality. For most
252 // content types, the output should not change during the lifetime of this cache.
253 // Clearing it can cause extra parses on edit for no reason.
257 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
261 public function clearPreparedEdit() {
262 $this->mPreparedEdit
= false;
266 * Return the list of revision fields that should be selected to create
271 public static function selectFields() {
272 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
283 'page_links_updated',
288 if ( $wgContentHandlerUseDB ) {
289 $fields[] = 'page_content_model';
292 if ( $wgPageLanguageUseDB ) {
293 $fields[] = 'page_lang';
300 * Fetch a page record with the given conditions
301 * @param DatabaseBase $dbr
302 * @param array $conditions
303 * @param array $options
304 * @return object|bool Database result resource, or false on failure
306 protected function pageData( $dbr, $conditions, $options = array() ) {
307 $fields = self
::selectFields();
309 Hooks
::run( 'ArticlePageDataBefore', array( &$this, &$fields ) );
311 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
313 Hooks
::run( 'ArticlePageDataAfter', array( &$this, &$row ) );
319 * Fetch a page record matching the Title object's namespace and title
320 * using a sanitized title string
322 * @param DatabaseBase $dbr
323 * @param Title $title
324 * @param array $options
325 * @return object|bool Database result resource, or false on failure
327 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
328 return $this->pageData( $dbr, array(
329 'page_namespace' => $title->getNamespace(),
330 'page_title' => $title->getDBkey() ), $options );
334 * Fetch a page record matching the requested ID
336 * @param DatabaseBase $dbr
338 * @param array $options
339 * @return object|bool Database result resource, or false on failure
341 public function pageDataFromId( $dbr, $id, $options = array() ) {
342 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
346 * Load the object from a given source by title
348 * @param object|string|int $from One of the following:
349 * - A DB query result object.
350 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
351 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
352 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
353 * using SELECT FOR UPDATE.
357 public function loadPageData( $from = 'fromdb' ) {
358 $from = self
::convertSelectType( $from );
359 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
360 // We already have the data from the correct location, no need to load it twice.
364 if ( is_int( $from ) ) {
365 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
366 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
369 && $index == DB_SLAVE
370 && wfGetLB()->getServerCount() > 1
371 && wfGetLB()->hasOrMadeRecentMasterChanges()
373 $from = self
::READ_LATEST
;
374 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
375 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
378 // No idea from where the caller got this data, assume slave database.
380 $from = self
::READ_NORMAL
;
383 $this->loadFromRow( $data, $from );
387 * Load the object from a database row
390 * @param object $data Database row containing at least fields returned by selectFields()
391 * @param string|int $from One of the following:
392 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
393 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
394 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
395 * the master DB using SELECT FOR UPDATE
397 public function loadFromRow( $data, $from ) {
398 $lc = LinkCache
::singleton();
399 $lc->clearLink( $this->mTitle
);
402 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
404 $this->mTitle
->loadFromRow( $data );
406 // Old-fashioned restrictions
407 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
409 $this->mId
= intval( $data->page_id
);
410 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
411 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
412 $this->mIsRedirect
= intval( $data->page_is_redirect
);
413 $this->mLatest
= intval( $data->page_latest
);
414 // Bug 37225: $latest may no longer match the cached latest Revision object.
415 // Double-check the ID of any cached latest Revision object for consistency.
416 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
417 $this->mLastRevision
= null;
418 $this->mTimestamp
= '';
421 $lc->addBadLinkObj( $this->mTitle
);
423 $this->mTitle
->loadFromRow( false );
425 $this->clearCacheFields();
430 $this->mDataLoaded
= true;
431 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
435 * @return int Page ID
437 public function getId() {
438 if ( !$this->mDataLoaded
) {
439 $this->loadPageData();
445 * @return bool Whether or not the page exists in the database
447 public function exists() {
448 if ( !$this->mDataLoaded
) {
449 $this->loadPageData();
451 return $this->mId
> 0;
455 * Check if this page is something we're going to be showing
456 * some sort of sensible content for. If we return false, page
457 * views (plain action=view) will return an HTTP 404 response,
458 * so spiders and robots can know they're following a bad link.
462 public function hasViewableContent() {
463 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
467 * Tests if the article content represents a redirect
471 public function isRedirect() {
472 $content = $this->getContent();
477 return $content->isRedirect();
481 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
483 * Will use the revisions actual content model if the page exists,
484 * and the page's default if the page doesn't exist yet.
490 public function getContentModel() {
491 if ( $this->exists() ) {
492 // look at the revision's actual content model
493 $rev = $this->getRevision();
495 if ( $rev !== null ) {
496 return $rev->getContentModel();
498 $title = $this->mTitle
->getPrefixedDBkey();
499 wfWarn( "Page $title exists but has no (visible) revisions!" );
503 // use the default model for this page
504 return $this->mTitle
->getContentModel();
508 * Loads page_touched and returns a value indicating if it should be used
509 * @return bool True if not a redirect
511 public function checkTouched() {
512 if ( !$this->mDataLoaded
) {
513 $this->loadPageData();
515 return !$this->mIsRedirect
;
519 * Get the page_touched field
520 * @return string Containing GMT timestamp
522 public function getTouched() {
523 if ( !$this->mDataLoaded
) {
524 $this->loadPageData();
526 return $this->mTouched
;
530 * Get the page_links_updated field
531 * @return string|null Containing GMT timestamp
533 public function getLinksTimestamp() {
534 if ( !$this->mDataLoaded
) {
535 $this->loadPageData();
537 return $this->mLinksUpdated
;
541 * Get the page_latest field
542 * @return int The rev_id of current revision
544 public function getLatest() {
545 if ( !$this->mDataLoaded
) {
546 $this->loadPageData();
548 return (int)$this->mLatest
;
552 * Get the Revision object of the oldest revision
553 * @return Revision|null
555 public function getOldestRevision() {
557 // Try using the slave database first, then try the master
559 $db = wfGetDB( DB_SLAVE
);
560 $revSelectFields = Revision
::selectFields();
563 while ( $continue ) {
564 $row = $db->selectRow(
565 array( 'page', 'revision' ),
568 'page_namespace' => $this->mTitle
->getNamespace(),
569 'page_title' => $this->mTitle
->getDBkey(),
574 'ORDER BY' => 'rev_timestamp ASC'
581 $db = wfGetDB( DB_MASTER
);
586 return $row ? Revision
::newFromRow( $row ) : null;
590 * Loads everything except the text
591 * This isn't necessary for all uses, so it's only done if needed.
593 protected function loadLastEdit() {
594 if ( $this->mLastRevision
!== null ) {
595 return; // already loaded
598 $latest = $this->getLatest();
600 return; // page doesn't exist or is missing page_latest info
603 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
604 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always
605 // includes the latest changes committed. This is true even within REPEATABLE-READ
606 // transactions, where S1 normally only sees changes committed before the first S1
607 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
608 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
609 // happened after the first S1 SELECT.
610 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
611 $flags = Revision
::READ_LOCKING
;
612 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
613 // Bug T93976: if page_latest was loaded from the master, fetch the
614 // revision from there as well, as it may not exist yet on a slave DB.
615 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
616 $flags = Revision
::READ_LATEST
;
620 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
621 if ( $revision ) { // sanity
622 $this->setLastEdit( $revision );
627 * Set the latest revision
628 * @param Revision $revision
630 protected function setLastEdit( Revision
$revision ) {
631 $this->mLastRevision
= $revision;
632 $this->mTimestamp
= $revision->getTimestamp();
636 * Get the latest revision
637 * @return Revision|null
639 public function getRevision() {
640 $this->loadLastEdit();
641 if ( $this->mLastRevision
) {
642 return $this->mLastRevision
;
648 * Get the content of the current revision. No side-effects...
650 * @param int $audience One of:
651 * Revision::FOR_PUBLIC to be displayed to all users
652 * Revision::FOR_THIS_USER to be displayed to $wgUser
653 * Revision::RAW get the text regardless of permissions
654 * @param User $user User object to check for, only if FOR_THIS_USER is passed
655 * to the $audience parameter
656 * @return Content|null The content of the current revision
660 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
661 $this->loadLastEdit();
662 if ( $this->mLastRevision
) {
663 return $this->mLastRevision
->getContent( $audience, $user );
669 * Get the text of the current revision. No side-effects...
671 * @param int $audience One of:
672 * Revision::FOR_PUBLIC to be displayed to all users
673 * Revision::FOR_THIS_USER to be displayed to the given user
674 * Revision::RAW get the text regardless of permissions
675 * @param User $user User object to check for, only if FOR_THIS_USER is passed
676 * to the $audience parameter
677 * @return string|bool The text of the current revision
678 * @deprecated since 1.21, getContent() should be used instead.
680 public function getText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
681 ContentHandler
::deprecated( __METHOD__
, '1.21' );
683 $this->loadLastEdit();
684 if ( $this->mLastRevision
) {
685 return $this->mLastRevision
->getText( $audience, $user );
691 * Get the text of the current revision. No side-effects...
693 * @return string|bool The text of the current revision. False on failure
694 * @deprecated since 1.21, getContent() should be used instead.
696 public function getRawText() {
697 ContentHandler
::deprecated( __METHOD__
, '1.21' );
699 return $this->getText( Revision
::RAW
);
703 * @return string MW timestamp of last article revision
705 public function getTimestamp() {
706 // Check if the field has been filled by WikiPage::setTimestamp()
707 if ( !$this->mTimestamp
) {
708 $this->loadLastEdit();
711 return wfTimestamp( TS_MW
, $this->mTimestamp
);
715 * Set the page timestamp (use only to avoid DB queries)
716 * @param string $ts MW timestamp of last article revision
719 public function setTimestamp( $ts ) {
720 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
724 * @param int $audience One of:
725 * Revision::FOR_PUBLIC to be displayed to all users
726 * Revision::FOR_THIS_USER to be displayed to the given user
727 * Revision::RAW get the text regardless of permissions
728 * @param User $user User object to check for, only if FOR_THIS_USER is passed
729 * to the $audience parameter
730 * @return int User ID for the user that made the last article revision
732 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
733 $this->loadLastEdit();
734 if ( $this->mLastRevision
) {
735 return $this->mLastRevision
->getUser( $audience, $user );
742 * Get the User object of the user who created the page
743 * @param int $audience One of:
744 * Revision::FOR_PUBLIC to be displayed to all users
745 * Revision::FOR_THIS_USER to be displayed to the given user
746 * Revision::RAW get the text regardless of permissions
747 * @param User $user User object to check for, only if FOR_THIS_USER is passed
748 * to the $audience parameter
751 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
752 $revision = $this->getOldestRevision();
754 $userName = $revision->getUserText( $audience, $user );
755 return User
::newFromName( $userName, false );
762 * @param int $audience One of:
763 * Revision::FOR_PUBLIC to be displayed to all users
764 * Revision::FOR_THIS_USER to be displayed to the given user
765 * Revision::RAW get the text regardless of permissions
766 * @param User $user User object to check for, only if FOR_THIS_USER is passed
767 * to the $audience parameter
768 * @return string Username of the user that made the last article revision
770 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
771 $this->loadLastEdit();
772 if ( $this->mLastRevision
) {
773 return $this->mLastRevision
->getUserText( $audience, $user );
780 * @param int $audience One of:
781 * Revision::FOR_PUBLIC to be displayed to all users
782 * Revision::FOR_THIS_USER to be displayed to the given user
783 * Revision::RAW get the text regardless of permissions
784 * @param User $user User object to check for, only if FOR_THIS_USER is passed
785 * to the $audience parameter
786 * @return string Comment stored for the last article revision
788 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
789 $this->loadLastEdit();
790 if ( $this->mLastRevision
) {
791 return $this->mLastRevision
->getComment( $audience, $user );
798 * Returns true if last revision was marked as "minor edit"
800 * @return bool Minor edit indicator for the last article revision.
802 public function getMinorEdit() {
803 $this->loadLastEdit();
804 if ( $this->mLastRevision
) {
805 return $this->mLastRevision
->isMinor();
812 * Determine whether a page would be suitable for being counted as an
813 * article in the site_stats table based on the title & its content
815 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
816 * if false, the current database state will be used
819 public function isCountable( $editInfo = false ) {
820 global $wgArticleCountMethod;
822 if ( !$this->mTitle
->isContentPage() ) {
827 $content = $editInfo->pstContent
;
829 $content = $this->getContent();
832 if ( !$content ||
$content->isRedirect() ) {
838 if ( $wgArticleCountMethod === 'link' ) {
839 // nasty special case to avoid re-parsing to detect links
842 // ParserOutput::getLinks() is a 2D array of page links, so
843 // to be really correct we would need to recurse in the array
844 // but the main array should only have items in it if there are
846 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
848 $hasLinks = (bool)wfGetDB( DB_SLAVE
)->selectField( 'pagelinks', 1,
849 array( 'pl_from' => $this->getId() ), __METHOD__
);
853 return $content->isCountable( $hasLinks );
857 * If this page is a redirect, get its target
859 * The target will be fetched from the redirect table if possible.
860 * If this page doesn't have an entry there, call insertRedirect()
861 * @return Title|null Title object, or null if this page is not a redirect
863 public function getRedirectTarget() {
864 if ( !$this->mTitle
->isRedirect() ) {
868 if ( $this->mRedirectTarget
!== null ) {
869 return $this->mRedirectTarget
;
872 // Query the redirect table
873 $dbr = wfGetDB( DB_SLAVE
);
874 $row = $dbr->selectRow( 'redirect',
875 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
876 array( 'rd_from' => $this->getId() ),
880 // rd_fragment and rd_interwiki were added later, populate them if empty
881 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
882 $this->mRedirectTarget
= Title
::makeTitle(
883 $row->rd_namespace
, $row->rd_title
,
884 $row->rd_fragment
, $row->rd_interwiki
);
885 return $this->mRedirectTarget
;
888 // This page doesn't have an entry in the redirect table
889 $this->mRedirectTarget
= $this->insertRedirect();
890 return $this->mRedirectTarget
;
894 * Insert an entry for this page into the redirect table.
896 * Don't call this function directly unless you know what you're doing.
897 * @return Title|null Title object or null if not a redirect
899 public function insertRedirect() {
900 // recurse through to only get the final target
901 $content = $this->getContent();
902 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
906 $this->insertRedirectEntry( $retval );
911 * Insert or update the redirect table entry for this page to indicate
912 * it redirects to $rt .
913 * @param Title $rt Redirect target
915 public function insertRedirectEntry( $rt ) {
916 $dbw = wfGetDB( DB_MASTER
);
917 $dbw->replace( 'redirect', array( 'rd_from' ),
919 'rd_from' => $this->getId(),
920 'rd_namespace' => $rt->getNamespace(),
921 'rd_title' => $rt->getDBkey(),
922 'rd_fragment' => $rt->getFragment(),
923 'rd_interwiki' => $rt->getInterwiki(),
930 * Get the Title object or URL this page redirects to
932 * @return bool|Title|string False, Title of in-wiki target, or string with URL
934 public function followRedirect() {
935 return $this->getRedirectURL( $this->getRedirectTarget() );
939 * Get the Title object or URL to use for a redirect. We use Title
940 * objects for same-wiki, non-special redirects and URLs for everything
942 * @param Title $rt Redirect target
943 * @return bool|Title|string False, Title object of local target, or string with URL
945 public function getRedirectURL( $rt ) {
950 if ( $rt->isExternal() ) {
951 if ( $rt->isLocal() ) {
952 // Offsite wikis need an HTTP redirect.
953 // This can be hard to reverse and may produce loops,
954 // so they may be disabled in the site configuration.
955 $source = $this->mTitle
->getFullURL( 'redirect=no' );
956 return $rt->getFullURL( array( 'rdfrom' => $source ) );
958 // External pages without "local" bit set are not valid
964 if ( $rt->isSpecialPage() ) {
965 // Gotta handle redirects to special pages differently:
966 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
967 // Some pages are not valid targets.
968 if ( $rt->isValidRedirectTarget() ) {
969 return $rt->getFullURL();
979 * Get a list of users who have edited this article, not including the user who made
980 * the most recent revision, which you can get from $article->getUser() if you want it
981 * @return UserArrayFromResult
983 public function getContributors() {
984 // @todo FIXME: This is expensive; cache this info somewhere.
986 $dbr = wfGetDB( DB_SLAVE
);
988 if ( $dbr->implicitGroupby() ) {
989 $realNameField = 'user_real_name';
991 $realNameField = 'MIN(user_real_name) AS user_real_name';
994 $tables = array( 'revision', 'user' );
997 'user_id' => 'rev_user',
998 'user_name' => 'rev_user_text',
1000 'timestamp' => 'MAX(rev_timestamp)',
1003 $conds = array( 'rev_page' => $this->getId() );
1005 // The user who made the top revision gets credited as "this page was last edited by
1006 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1007 $user = $this->getUser();
1009 $conds[] = "rev_user != $user";
1011 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1014 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1017 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1021 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1022 'ORDER BY' => 'timestamp DESC',
1025 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1026 return new UserArrayFromResult( $res );
1030 * Get the last N authors
1031 * @param int $num Number of revisions to get
1032 * @param int|string $revLatest The latest rev_id, selected from the master (optional)
1033 * @return array Array of authors, duplicates not removed
1035 public function getLastNAuthors( $num, $revLatest = 0 ) {
1036 // First try the slave
1037 // If that doesn't have the latest revision, try the master
1039 $db = wfGetDB( DB_SLAVE
);
1042 $res = $db->select( array( 'page', 'revision' ),
1043 array( 'rev_id', 'rev_user_text' ),
1045 'page_namespace' => $this->mTitle
->getNamespace(),
1046 'page_title' => $this->mTitle
->getDBkey(),
1047 'rev_page = page_id'
1050 'ORDER BY' => 'rev_timestamp DESC',
1059 $row = $db->fetchObject( $res );
1061 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
1062 $db = wfGetDB( DB_MASTER
);
1067 } while ( $continue );
1069 $authors = array( $row->rev_user_text
);
1071 foreach ( $res as $row ) {
1072 $authors[] = $row->rev_user_text
;
1079 * Should the parser cache be used?
1081 * @param ParserOptions $parserOptions ParserOptions to check
1085 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1086 return $parserOptions->getStubThreshold() == 0
1088 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1089 && $this->getContentHandler()->isParserCacheSupported();
1093 * Get a ParserOutput for the given ParserOptions and revision ID.
1094 * The parser cache will be used if possible.
1097 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1098 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1099 * get the current revision (default value)
1101 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1103 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
1105 $useParserCache = $this->shouldCheckParserCache( $parserOptions, $oldid );
1106 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1107 if ( $parserOptions->getStubThreshold() ) {
1108 wfIncrStats( 'pcache.miss.stub' );
1111 if ( $useParserCache ) {
1112 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1113 if ( $parserOutput !== false ) {
1114 return $parserOutput;
1118 if ( $oldid === null ||
$oldid === 0 ) {
1119 $oldid = $this->getLatest();
1122 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1125 return $pool->getParserOutput();
1129 * Do standard deferred updates after page view (existing or missing page)
1130 * @param User $user The relevant user
1131 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
1133 public function doViewUpdates( User
$user, $oldid = 0 ) {
1134 if ( wfReadOnly() ) {
1138 Hooks
::run( 'PageViewUpdates', array( $this, $user ) );
1139 // Update newtalk / watchlist notification status
1141 $user->clearNotification( $this->mTitle
, $oldid );
1142 } catch ( DBError
$e ) {
1143 // Avoid outage if the master is not reachable
1144 MWExceptionHandler
::logException( $e );
1149 * Perform the actions of a page purging
1152 public function doPurge() {
1153 if ( !Hooks
::run( 'ArticlePurge', array( &$this ) ) ) {
1157 $title = $this->mTitle
;
1158 wfGetDB( DB_MASTER
)->onTransactionIdle( function() use ( $title ) {
1160 // Invalidate the cache in auto-commit mode
1161 $title->invalidateCache();
1162 if ( $wgUseSquid ) {
1163 // Send purge now that page_touched update was committed above
1164 $update = SquidUpdate
::newSimplePurge( $title );
1165 $update->doUpdate();
1169 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1170 // @todo move this logic to MessageCache
1171 if ( $this->exists() ) {
1172 // NOTE: use transclusion text for messages.
1173 // This is consistent with MessageCache::getMsgFromNamespace()
1175 $content = $this->getContent();
1176 $text = $content === null ?
null : $content->getWikitextForTransclusion();
1178 if ( $text === null ) {
1185 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1192 * Insert a new empty page record for this article.
1193 * This *must* be followed up by creating a revision
1194 * and running $this->updateRevisionOn( ... );
1195 * or else the record will be left in a funky state.
1196 * Best if all done inside a transaction.
1198 * @param DatabaseBase $dbw
1199 * @return int|bool The newly created page_id key; false if the title already existed
1201 public function insertOn( $dbw ) {
1202 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1203 $dbw->insert( 'page', array(
1204 'page_id' => $page_id,
1205 'page_namespace' => $this->mTitle
->getNamespace(),
1206 'page_title' => $this->mTitle
->getDBkey(),
1207 'page_restrictions' => '',
1208 'page_is_redirect' => 0, // Will set this shortly...
1210 'page_random' => wfRandom(),
1211 'page_touched' => $dbw->timestamp(),
1212 'page_latest' => 0, // Fill this in shortly...
1213 'page_len' => 0, // Fill this in shortly...
1214 ), __METHOD__
, 'IGNORE' );
1216 $affected = $dbw->affectedRows();
1219 $newid = $dbw->insertId();
1220 $this->mId
= $newid;
1221 $this->mTitle
->resetArticleID( $newid );
1230 * Update the page record to point to a newly saved revision.
1232 * @param DatabaseBase $dbw
1233 * @param Revision $revision For ID number, and text used to set
1234 * length and redirect status fields
1235 * @param int $lastRevision If given, will not overwrite the page field
1236 * when different from the currently set value.
1237 * Giving 0 indicates the new page flag should be set on.
1238 * @param bool $lastRevIsRedirect If given, will optimize adding and
1239 * removing rows in redirect table.
1240 * @return bool True on success, false on failure
1242 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1243 $lastRevIsRedirect = null
1245 global $wgContentHandlerUseDB;
1247 // Assertion to try to catch T92046
1248 if ( (int)$revision->getId() === 0 ) {
1249 throw new InvalidArgumentException(
1250 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1254 $content = $revision->getContent();
1255 $len = $content ?
$content->getSize() : 0;
1256 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1258 $conditions = array( 'page_id' => $this->getId() );
1260 if ( !is_null( $lastRevision ) ) {
1261 // An extra check against threads stepping on each other
1262 $conditions['page_latest'] = $lastRevision;
1265 $row = array( /* SET */
1266 'page_latest' => $revision->getId(),
1267 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1268 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1269 'page_is_redirect' => $rt !== null ?
1 : 0,
1273 if ( $wgContentHandlerUseDB ) {
1274 $row['page_content_model'] = $revision->getContentModel();
1277 $dbw->update( 'page',
1282 $result = $dbw->affectedRows() > 0;
1284 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1285 $this->setLastEdit( $revision );
1286 $this->mLatest
= $revision->getId();
1287 $this->mIsRedirect
= (bool)$rt;
1288 // Update the LinkCache.
1289 LinkCache
::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle
, $len, $this->mIsRedirect
,
1290 $this->mLatest
, $revision->getContentModel() );
1297 * Add row to the redirect table if this is a redirect, remove otherwise.
1299 * @param DatabaseBase $dbw
1300 * @param Title $redirectTitle Title object pointing to the redirect target,
1301 * or NULL if this is not a redirect
1302 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1303 * removing rows in redirect table.
1304 * @return bool True on success, false on failure
1307 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1308 // Always update redirects (target link might have changed)
1309 // Update/Insert if we don't know if the last revision was a redirect or not
1310 // Delete if changing from redirect to non-redirect
1311 $isRedirect = !is_null( $redirectTitle );
1313 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1317 if ( $isRedirect ) {
1318 $this->insertRedirectEntry( $redirectTitle );
1320 // This is not a redirect, remove row from redirect table
1321 $where = array( 'rd_from' => $this->getId() );
1322 $dbw->delete( 'redirect', $where, __METHOD__
);
1325 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1326 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1329 return ( $dbw->affectedRows() != 0 );
1333 * If the given revision is newer than the currently set page_latest,
1334 * update the page record. Otherwise, do nothing.
1336 * @deprecated since 1.24, use updateRevisionOn instead
1338 * @param DatabaseBase $dbw
1339 * @param Revision $revision
1342 public function updateIfNewerOn( $dbw, $revision ) {
1344 $row = $dbw->selectRow(
1345 array( 'revision', 'page' ),
1346 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1348 'page_id' => $this->getId(),
1349 'page_latest=rev_id' ),
1353 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1356 $prev = $row->rev_id
;
1357 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1359 // No or missing previous revision; mark the page as new
1361 $lastRevIsRedirect = null;
1364 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1370 * Get the content that needs to be saved in order to undo all revisions
1371 * between $undo and $undoafter. Revisions must belong to the same page,
1372 * must exist and must not be deleted
1373 * @param Revision $undo
1374 * @param Revision $undoafter Must be an earlier revision than $undo
1375 * @return mixed String on success, false on failure
1377 * Before we had the Content object, this was done in getUndoText
1379 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1380 $handler = $undo->getContentHandler();
1381 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1385 * Get the text that needs to be saved in order to undo all revisions
1386 * between $undo and $undoafter. Revisions must belong to the same page,
1387 * must exist and must not be deleted
1388 * @param Revision $undo
1389 * @param Revision $undoafter Must be an earlier revision than $undo
1390 * @return string|bool String on success, false on failure
1391 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1393 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
1394 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1396 $this->loadLastEdit();
1398 if ( $this->mLastRevision
) {
1399 if ( is_null( $undoafter ) ) {
1400 $undoafter = $undo->getPrevious();
1403 $handler = $this->getContentHandler();
1404 $undone = $handler->getUndoContent( $this->mLastRevision
, $undo, $undoafter );
1409 return ContentHandler
::getContentText( $undone );
1417 * @param string|number|null|bool $sectionId Section identifier as a number or string
1418 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1419 * or 'new' for a new section.
1420 * @param string $text New text of the section.
1421 * @param string $sectionTitle New section's subject, only if $section is "new".
1422 * @param string $edittime Revision timestamp or null to use the current revision.
1424 * @throws MWException
1425 * @return string New complete article text, or null if error.
1427 * @deprecated since 1.21, use replaceSectionAtRev() instead
1429 public function replaceSection( $sectionId, $text, $sectionTitle = '',
1432 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1434 // NOTE: keep condition in sync with condition in replaceSectionContent!
1435 if ( strval( $sectionId ) === '' ) {
1436 // Whole-page edit; let the whole text through
1440 if ( !$this->supportsSections() ) {
1441 throw new MWException( "sections not supported for content model " .
1442 $this->getContentHandler()->getModelID() );
1445 // could even make section title, but that's not required.
1446 $sectionContent = ContentHandler
::makeContent( $text, $this->getTitle() );
1448 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1451 return ContentHandler
::getContentText( $newContent );
1455 * Returns true if this page's content model supports sections.
1459 * @todo The skin should check this and not offer section functionality if
1460 * sections are not supported.
1461 * @todo The EditPage should check this and not offer section functionality
1462 * if sections are not supported.
1464 public function supportsSections() {
1465 return $this->getContentHandler()->supportsSections();
1469 * @param string|number|null|bool $sectionId Section identifier as a number or string
1470 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1471 * or 'new' for a new section.
1472 * @param Content $sectionContent New content of the section.
1473 * @param string $sectionTitle New section's subject, only if $section is "new".
1474 * @param string $edittime Revision timestamp or null to use the current revision.
1476 * @throws MWException
1477 * @return Content New complete article content, or null if error.
1480 * @deprecated since 1.24, use replaceSectionAtRev instead
1482 public function replaceSectionContent( $sectionId, Content
$sectionContent, $sectionTitle = '',
1483 $edittime = null ) {
1486 if ( $edittime && $sectionId !== 'new' ) {
1487 $dbr = wfGetDB( DB_SLAVE
);
1488 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1489 // Try the master if this thread may have just added it.
1490 // This could be abstracted into a Revision method, but we don't want
1491 // to encourage loading of revisions by timestamp.
1493 && wfGetLB()->getServerCount() > 1
1494 && wfGetLB()->hasOrMadeRecentMasterChanges()
1496 $dbw = wfGetDB( DB_MASTER
);
1497 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1500 $baseRevId = $rev->getId();
1504 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1508 * @param string|number|null|bool $sectionId Section identifier as a number or string
1509 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1510 * or 'new' for a new section.
1511 * @param Content $sectionContent New content of the section.
1512 * @param string $sectionTitle New section's subject, only if $section is "new".
1513 * @param int|null $baseRevId
1515 * @throws MWException
1516 * @return Content New complete article content, or null if error.
1520 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1521 $sectionTitle = '', $baseRevId = null
1524 if ( strval( $sectionId ) === '' ) {
1525 // Whole-page edit; let the whole text through
1526 $newContent = $sectionContent;
1528 if ( !$this->supportsSections() ) {
1529 throw new MWException( "sections not supported for content model " .
1530 $this->getContentHandler()->getModelID() );
1533 // Bug 30711: always use current version when adding a new section
1534 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1535 $oldContent = $this->getContent();
1537 $rev = Revision
::newFromId( $baseRevId );
1539 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1540 $this->getId() . "; section: $sectionId)\n" );
1544 $oldContent = $rev->getContent();
1547 if ( !$oldContent ) {
1548 wfDebug( __METHOD__
. ": no page text\n" );
1552 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1559 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1561 * @return int Updated $flags
1563 public function checkFlags( $flags ) {
1564 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1565 if ( $this->exists() ) {
1566 $flags |
= EDIT_UPDATE
;
1576 * Change an existing article or create a new article. Updates RC and all necessary caches,
1577 * optionally via the deferred update array.
1579 * @param string $text New text
1580 * @param string $summary Edit summary
1581 * @param int $flags Bitfield:
1583 * Article is known or assumed to be non-existent, create a new one
1585 * Article is known or assumed to be pre-existing, update it
1587 * Mark this edit minor, if the user is allowed to do so
1589 * Do not log the change in recentchanges
1591 * Mark the edit a "bot" edit regardless of user rights
1592 * EDIT_DEFER_UPDATES
1593 * Defer some of the updates until the end of index.php
1595 * Fill in blank summaries with generated text where possible
1597 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1598 * article will be detected. If EDIT_UPDATE is specified and the article
1599 * doesn't exist, the function will return an edit-gone-missing error. If
1600 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1601 * error will be returned. These two conditions are also possible with
1602 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1604 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1605 * This is not the parent revision ID, rather the revision ID for older
1606 * content used as the source for a rollback, for example.
1607 * @param User $user The user doing the edit
1609 * @throws MWException
1610 * @return Status Possible errors:
1611 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1612 * set the fatal flag of $status
1613 * edit-gone-missing: In update mode, but the article didn't exist.
1614 * edit-conflict: In update mode, the article changed unexpectedly.
1615 * edit-no-change: Warning that the text was the same as before.
1616 * edit-already-exists: In creation mode, but the article already exists.
1618 * Extensions may define additional errors.
1620 * $return->value will contain an associative array with members as follows:
1621 * new: Boolean indicating if the function attempted to create a new article.
1622 * revision: The revision object for the inserted revision, or null.
1624 * Compatibility note: this function previously returned a boolean value
1625 * indicating success/failure
1627 * @deprecated since 1.21: use doEditContent() instead.
1629 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1630 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1632 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1634 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1638 * Change an existing article or create a new article. Updates RC and all necessary caches,
1639 * optionally via the deferred update array.
1641 * @param Content $content New content
1642 * @param string $summary Edit summary
1643 * @param int $flags Bitfield:
1645 * Article is known or assumed to be non-existent, create a new one
1647 * Article is known or assumed to be pre-existing, update it
1649 * Mark this edit minor, if the user is allowed to do so
1651 * Do not log the change in recentchanges
1653 * Mark the edit a "bot" edit regardless of user rights
1654 * EDIT_DEFER_UPDATES
1655 * Defer some of the updates until the end of index.php
1657 * Fill in blank summaries with generated text where possible
1659 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1660 * article will be detected. If EDIT_UPDATE is specified and the article
1661 * doesn't exist, the function will return an edit-gone-missing error. If
1662 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1663 * error will be returned. These two conditions are also possible with
1664 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1666 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1667 * This is not the parent revision ID, rather the revision ID for older
1668 * content used as the source for a rollback, for example.
1669 * @param User $user The user doing the edit
1670 * @param string $serialFormat Format for storing the content in the
1673 * @throws MWException
1674 * @return Status Possible errors:
1675 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1676 * set the fatal flag of $status.
1677 * edit-gone-missing: In update mode, but the article didn't exist.
1678 * edit-conflict: In update mode, the article changed unexpectedly.
1679 * edit-no-change: Warning that the text was the same as before.
1680 * edit-already-exists: In creation mode, but the article already exists.
1682 * Extensions may define additional errors.
1684 * $return->value will contain an associative array with members as follows:
1685 * new: Boolean indicating if the function attempted to create a new article.
1686 * revision: The revision object for the inserted revision, or null.
1689 * @throws MWException
1691 public function doEditContent( Content
$content, $summary, $flags = 0, $baseRevId = false,
1692 User
$user = null, $serialFormat = null
1694 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1696 // Low-level sanity check
1697 if ( $this->mTitle
->getText() === '' ) {
1698 throw new MWException( 'Something is trying to edit an article with an empty title' );
1701 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1702 return Status
::newFatal( 'content-not-allowed-here',
1703 ContentHandler
::getLocalizedName( $content->getModel() ),
1704 $this->getTitle()->getPrefixedText() );
1707 $user = is_null( $user ) ?
$wgUser : $user;
1708 $status = Status
::newGood( array() );
1710 // Load the data from the master database if needed.
1711 // The caller may already loaded it from the master or even loaded it using
1712 // SELECT FOR UPDATE, so do not override that using clear().
1713 $this->loadPageData( 'fromdbmaster' );
1715 $flags = $this->checkFlags( $flags );
1718 $hook_args = array( &$this, &$user, &$content, &$summary,
1719 $flags & EDIT_MINOR
, null, null, &$flags, &$status );
1721 if ( !Hooks
::run( 'PageContentSave', $hook_args )
1722 ||
!ContentHandler
::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1724 wfDebug( __METHOD__
. ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1726 if ( $status->isOK() ) {
1727 $status->fatal( 'edit-hook-aborted' );
1733 // Silently ignore EDIT_MINOR if not allowed
1734 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1735 $bot = $flags & EDIT_FORCE_BOT
;
1737 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1739 $oldsize = $old_content ?
$old_content->getSize() : 0;
1740 $oldid = $this->getLatest();
1741 $oldIsRedirect = $this->isRedirect();
1742 $oldcountable = $this->isCountable();
1744 $handler = $content->getContentHandler();
1746 // Provide autosummaries if one is not provided and autosummaries are enabled.
1747 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1748 if ( !$old_content ) {
1749 $old_content = null;
1751 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1754 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1755 $serialized = $editInfo->pst
;
1758 * @var Content $content
1760 $content = $editInfo->pstContent
;
1761 $newsize = $content->getSize();
1763 $dbw = wfGetDB( DB_MASTER
);
1764 $now = wfTimestampNow();
1766 if ( $flags & EDIT_UPDATE
) {
1767 // Update article, but only if changed.
1768 $status->value
['new'] = false;
1771 // Article gone missing
1772 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
1773 $status->fatal( 'edit-gone-missing' );
1776 } elseif ( !$old_content ) {
1777 // Sanity check for bug 37225
1778 throw new MWException( "Could not find text for current revision {$oldid}." );
1781 $revision = new Revision( array(
1782 'page' => $this->getId(),
1783 'title' => $this->getTitle(), // for determining the default content model
1784 'comment' => $summary,
1785 'minor_edit' => $isminor,
1786 'text' => $serialized,
1788 'parent_id' => $oldid,
1789 'user' => $user->getId(),
1790 'user_text' => $user->getName(),
1791 'timestamp' => $now,
1792 'content_model' => $content->getModel(),
1793 'content_format' => $serialFormat,
1794 ) ); // XXX: pass content object?!
1796 $changed = !$content->equals( $old_content );
1799 $dbw->begin( __METHOD__
);
1801 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1802 $status->merge( $prepStatus );
1804 if ( !$status->isOK() ) {
1805 $dbw->rollback( __METHOD__
);
1809 $revisionId = $revision->insertOn( $dbw );
1812 // We check for conflicts by comparing $oldid with the current latest revision ID.
1813 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1816 // Belated edit conflict! Run away!!
1817 $status->fatal( 'edit-conflict' );
1819 $dbw->rollback( __METHOD__
);
1824 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1826 // Update recentchanges
1827 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1828 // Mark as patrolled if the user can do so
1829 $patrolled = $wgUseRCPatrol && !count(
1830 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1831 // Add RC row to the DB
1832 RecentChange
::notifyEdit(
1833 $now, $this->mTitle
, $isminor, $user, $summary,
1834 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1835 $revisionId, $patrolled
1839 $user->incEditCount();
1841 $dbw->commit( __METHOD__
);
1842 $this->mTimestamp
= $now;
1844 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1845 // related variables correctly
1846 $revision->setId( $this->getLatest() );
1849 // Update links tables, site stats, etc.
1850 $this->doEditUpdates(
1854 'changed' => $changed,
1855 'oldcountable' => $oldcountable
1860 $status->warning( 'edit-no-change' );
1862 // Update page_touched, this is usually implicit in the page update
1863 // Other cache updates are done in onArticleEdit()
1864 $this->mTitle
->invalidateCache( $now );
1867 // Create new article
1868 $status->value
['new'] = true;
1870 $dbw->begin( __METHOD__
);
1872 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1873 $status->merge( $prepStatus );
1875 if ( !$status->isOK() ) {
1876 $dbw->rollback( __METHOD__
);
1881 $status->merge( $prepStatus );
1883 // Add the page record; stake our claim on this title!
1884 // This will return false if the article already exists
1885 $newid = $this->insertOn( $dbw );
1887 if ( $newid === false ) {
1888 $dbw->rollback( __METHOD__
);
1889 $status->fatal( 'edit-already-exists' );
1894 // Save the revision text...
1895 $revision = new Revision( array(
1897 'title' => $this->getTitle(), // for determining the default content model
1898 'comment' => $summary,
1899 'minor_edit' => $isminor,
1900 'text' => $serialized,
1902 'user' => $user->getId(),
1903 'user_text' => $user->getName(),
1904 'timestamp' => $now,
1905 'content_model' => $content->getModel(),
1906 'content_format' => $serialFormat,
1908 $revisionId = $revision->insertOn( $dbw );
1910 // Bug 37225: use accessor to get the text as Revision may trim it
1911 $content = $revision->getContent(); // sanity; get normalized version
1914 $newsize = $content->getSize();
1917 // Update the page record with revision data
1918 $this->updateRevisionOn( $dbw, $revision, 0 );
1920 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1922 // Update recentchanges
1923 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1924 // Mark as patrolled if the user can do so
1925 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
1926 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1927 // Add RC row to the DB
1928 RecentChange
::notifyNew(
1929 $now, $this->mTitle
, $isminor, $user, $summary, $bot,
1930 '', $newsize, $revisionId, $patrolled
1934 $user->incEditCount();
1936 $dbw->commit( __METHOD__
);
1937 $this->mTimestamp
= $now;
1939 // Update links, etc.
1940 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1942 $hook_args = array( &$this, &$user, $content, $summary,
1943 $flags & EDIT_MINOR
, null, null, &$flags, $revision );
1945 ContentHandler
::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1946 Hooks
::run( 'PageContentInsertComplete', $hook_args );
1949 // Do updates right now unless deferral was requested
1950 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
1951 DeferredUpdates
::doUpdates();
1954 // Return the new revision (or null) to the caller
1955 $status->value
['revision'] = $revision;
1957 $hook_args = array( &$this, &$user, $content, $summary,
1958 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId );
1960 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1961 Hooks
::run( 'PageContentSaveComplete', $hook_args );
1963 // Promote user to any groups they meet the criteria for
1964 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1965 $user->addAutopromoteOnceGroups( 'onEdit' );
1966 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1973 * Get parser options suitable for rendering the primary article wikitext
1975 * @see ContentHandler::makeParserOptions
1977 * @param IContextSource|User|string $context One of the following:
1978 * - IContextSource: Use the User and the Language of the provided
1980 * - User: Use the provided User object and $wgLang for the language,
1981 * so use an IContextSource object if possible.
1982 * - 'canonical': Canonical options (anonymous user with default
1983 * preferences and content language).
1984 * @return ParserOptions
1986 public function makeParserOptions( $context ) {
1987 $options = $this->getContentHandler()->makeParserOptions( $context );
1989 if ( $this->getTitle()->isConversionTable() ) {
1990 // @todo ConversionTable should become a separate content model, so
1991 // we don't need special cases like this one.
1992 $options->disableContentConversion();
1999 * Prepare text which is about to be saved.
2000 * Returns a stdClass with source, pst and output members
2002 * @deprecated since 1.21: use prepareContentForEdit instead.
2005 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
2006 ContentHandler
::deprecated( __METHOD__
, '1.21' );
2007 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2008 return $this->prepareContentForEdit( $content, $revid, $user );
2012 * Prepare content which is about to be saved.
2013 * Returns a stdClass with source, pst and output members
2015 * @param Content $content
2016 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2017 * revision ID is also accepted, but this is deprecated.
2018 * @param User|null $user
2019 * @param string|null $serialFormat
2020 * @param bool $useCache Check shared prepared edit cache
2026 public function prepareContentForEdit(
2027 Content
$content, $revision = null, User
$user = null, $serialFormat = null, $useCache = true
2029 global $wgContLang, $wgUser, $wgAjaxEditStash;
2031 if ( is_object( $revision ) ) {
2032 $revid = $revision->getId();
2035 // This code path is deprecated, and nothing is known to
2036 // use it, so performance here shouldn't be a worry.
2037 if ( $revid !== null ) {
2038 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
2044 $user = is_null( $user ) ?
$wgUser : $user;
2045 // XXX: check $user->getId() here???
2047 // Use a sane default for $serialFormat, see bug 57026
2048 if ( $serialFormat === null ) {
2049 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2052 if ( $this->mPreparedEdit
2053 && $this->mPreparedEdit
->newContent
2054 && $this->mPreparedEdit
->newContent
->equals( $content )
2055 && $this->mPreparedEdit
->revid
== $revid
2056 && $this->mPreparedEdit
->format
== $serialFormat
2057 // XXX: also check $user here?
2060 return $this->mPreparedEdit
;
2063 // The edit may have already been prepared via api.php?action=stashedit
2064 $cachedEdit = $useCache && $wgAjaxEditStash && !$user->isAllowed( 'bot' )
2065 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2068 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2069 Hooks
::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2071 $edit = (object)array();
2072 if ( $cachedEdit ) {
2073 $edit->timestamp
= $cachedEdit->timestamp
;
2075 $edit->timestamp
= wfTimestampNow();
2077 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2078 $edit->revid
= $revid;
2080 if ( $cachedEdit ) {
2081 $edit->pstContent
= $cachedEdit->pstContent
;
2083 $edit->pstContent
= $content
2084 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2088 $edit->format
= $serialFormat;
2089 $edit->popts
= $this->makeParserOptions( 'canonical' );
2090 if ( $cachedEdit ) {
2091 $edit->output
= $cachedEdit->output
;
2094 // We get here if vary-revision is set. This means that this page references
2095 // itself (such as via self-transclusion). In this case, we need to make sure
2096 // that any such self-references refer to the newly-saved revision, and not
2097 // to the previous one, which could otherwise happen due to slave lag.
2098 $oldCallback = $edit->popts
->setCurrentRevisionCallback(
2099 function ( $title, $parser = false ) use ( $revision, &$oldCallback ) {
2100 if ( $title->equals( $revision->getTitle() ) ) {
2103 return call_user_func(
2112 $edit->output
= $edit->pstContent
2113 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2117 $edit->newContent
= $content;
2118 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2120 // NOTE: B/C for hooks! don't use these fields!
2121 $edit->newText
= $edit->newContent ? ContentHandler
::getContentText( $edit->newContent
) : '';
2122 $edit->oldText
= $edit->oldContent ? ContentHandler
::getContentText( $edit->oldContent
) : '';
2123 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2125 $this->mPreparedEdit
= $edit;
2130 * Do standard deferred updates after page edit.
2131 * Update links tables, site stats, search index and message cache.
2132 * Purges pages that include this page if the text was changed here.
2133 * Every 100th edit, prune the recent changes table.
2135 * @param Revision $revision
2136 * @param User $user User object that did the revision
2137 * @param array $options Array of options, following indexes are used:
2138 * - changed: boolean, whether the revision changed the content (default true)
2139 * - created: boolean, whether the revision created the page (default false)
2140 * - moved: boolean, whether the page was moved (default false)
2141 * - oldcountable: boolean, null, or string 'no-change' (default null):
2142 * - boolean: whether the page was counted as an article before that
2143 * revision, only used in changed is true and created is false
2144 * - null: if created is false, don't update the article count; if created
2145 * is true, do update the article count
2146 * - 'no-change': don't update the article count, ever
2148 public function doEditUpdates( Revision
$revision, User
$user, array $options = array() ) {
2153 'oldcountable' => null
2155 $content = $revision->getContent();
2158 // Be careful not to do pre-save transform twice: $text is usually
2159 // already pre-save transformed once.
2160 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2161 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
2162 $editInfo = $this->prepareContentForEdit( $content, $revision, $user );
2164 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
2165 $editInfo = $this->mPreparedEdit
;
2168 // Save it to the parser cache.
2169 // Make sure the cache time matches page_touched to avoid double parsing.
2170 ParserCache
::singleton()->save(
2171 $editInfo->output
, $this, $editInfo->popts
,
2172 $revision->getTimestamp(), $editInfo->revid
2175 // Update the links tables and other secondary data
2177 $recursive = $options['changed']; // bug 50785
2178 $updates = $content->getSecondaryDataUpdates(
2179 $this->getTitle(), null, $recursive, $editInfo->output
);
2180 foreach ( $updates as $update ) {
2181 DeferredUpdates
::addUpdate( $update );
2185 Hooks
::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2187 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2188 // Flush old entries from the `recentchanges` table
2189 if ( mt_rand( 0, 9 ) == 0 ) {
2190 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2194 if ( !$this->exists() ) {
2198 $id = $this->getId();
2199 $title = $this->mTitle
->getPrefixedDBkey();
2200 $shortTitle = $this->mTitle
->getDBkey();
2202 if ( $options['oldcountable'] === 'no-change' ||
2203 ( !$options['changed'] && !$options['moved'] )
2206 } elseif ( $options['created'] ) {
2207 $good = (int)$this->isCountable( $editInfo );
2208 } elseif ( $options['oldcountable'] !== null ) {
2209 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2213 $edits = $options['changed'] ?
1 : 0;
2214 $total = $options['created'] ?
1 : 0;
2216 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2217 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2219 // If this is another user's talk page, update newtalk.
2220 // Don't do this if $options['changed'] = false (null-edits) nor if
2221 // it's a minor edit and the user doesn't want notifications for those.
2222 if ( $options['changed']
2223 && $this->mTitle
->getNamespace() == NS_USER_TALK
2224 && $shortTitle != $user->getTitleKey()
2225 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2227 $recipient = User
::newFromName( $shortTitle, false );
2228 if ( !$recipient ) {
2229 wfDebug( __METHOD__
. ": invalid username\n" );
2231 // Allow extensions to prevent user notification when a new message is added to their talk page
2232 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2233 if ( User
::isIP( $shortTitle ) ) {
2234 // An anonymous user
2235 $recipient->setNewtalk( true, $revision );
2236 } elseif ( $recipient->isLoggedIn() ) {
2237 $recipient->setNewtalk( true, $revision );
2239 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2245 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2246 // XXX: could skip pseudo-messages like js/css here, based on content model.
2247 $msgtext = $content ?
$content->getWikitextForTransclusion() : null;
2248 if ( $msgtext === false ||
$msgtext === null ) {
2252 MessageCache
::singleton()->replace( $shortTitle, $msgtext );
2255 if ( $options['created'] ) {
2256 self
::onArticleCreate( $this->mTitle
);
2257 } elseif ( $options['changed'] ) { // bug 50785
2258 self
::onArticleEdit( $this->mTitle
, $revision );
2263 * Edit an article without doing all that other stuff
2264 * The article must already exist; link tables etc
2265 * are not updated, caches are not flushed.
2267 * @param string $text Text submitted
2268 * @param User $user The relevant user
2269 * @param string $comment Comment submitted
2270 * @param bool $minor Whereas it's a minor modification
2272 * @deprecated since 1.21, use doEditContent() instead.
2274 public function doQuickEdit( $text, User
$user, $comment = '', $minor = 0 ) {
2275 ContentHandler
::deprecated( __METHOD__
, "1.21" );
2277 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2278 $this->doQuickEditContent( $content, $user, $comment, $minor );
2282 * Edit an article without doing all that other stuff
2283 * The article must already exist; link tables etc
2284 * are not updated, caches are not flushed.
2286 * @param Content $content Content submitted
2287 * @param User $user The relevant user
2288 * @param string $comment Comment submitted
2289 * @param bool $minor Whereas it's a minor modification
2290 * @param string $serialFormat Format for storing the content in the database
2292 public function doQuickEditContent( Content
$content, User
$user, $comment = '', $minor = false,
2293 $serialFormat = null
2296 $serialized = $content->serialize( $serialFormat );
2298 $dbw = wfGetDB( DB_MASTER
);
2299 $revision = new Revision( array(
2300 'title' => $this->getTitle(), // for determining the default content model
2301 'page' => $this->getId(),
2302 'user_text' => $user->getName(),
2303 'user' => $user->getId(),
2304 'text' => $serialized,
2305 'length' => $content->getSize(),
2306 'comment' => $comment,
2307 'minor_edit' => $minor ?
1 : 0,
2308 ) ); // XXX: set the content object?
2309 $revision->insertOn( $dbw );
2310 $this->updateRevisionOn( $dbw, $revision );
2312 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2317 * Update the article's restriction field, and leave a log entry.
2318 * This works for protection both existing and non-existing pages.
2320 * @param array $limit Set of restriction keys
2321 * @param array $expiry Per restriction type expiration
2322 * @param int &$cascade Set to false if cascading protection isn't allowed.
2323 * @param string $reason
2324 * @param User $user The user updating the restrictions
2327 public function doUpdateRestrictions( array $limit, array $expiry,
2328 &$cascade, $reason, User
$user
2330 global $wgCascadingRestrictionLevels, $wgContLang;
2332 if ( wfReadOnly() ) {
2333 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
2336 $this->loadPageData( 'fromdbmaster' );
2337 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2338 $id = $this->getId();
2344 // Take this opportunity to purge out expired restrictions
2345 Title
::purgeExpiredRestrictions();
2347 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2348 // we expect a single selection, but the schema allows otherwise.
2349 $isProtected = false;
2353 $dbw = wfGetDB( DB_MASTER
);
2355 foreach ( $restrictionTypes as $action ) {
2356 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2357 $expiry[$action] = 'infinity';
2359 if ( !isset( $limit[$action] ) ) {
2360 $limit[$action] = '';
2361 } elseif ( $limit[$action] != '' ) {
2365 // Get current restrictions on $action
2366 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2367 if ( $current != '' ) {
2368 $isProtected = true;
2371 if ( $limit[$action] != $current ) {
2373 } elseif ( $limit[$action] != '' ) {
2374 // Only check expiry change if the action is actually being
2375 // protected, since expiry does nothing on an not-protected
2377 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2383 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2387 // If nothing has changed, do nothing
2389 return Status
::newGood();
2392 if ( !$protect ) { // No protection at all means unprotection
2393 $revCommentMsg = 'unprotectedarticle';
2394 $logAction = 'unprotect';
2395 } elseif ( $isProtected ) {
2396 $revCommentMsg = 'modifiedarticleprotection';
2397 $logAction = 'modify';
2399 $revCommentMsg = 'protectedarticle';
2400 $logAction = 'protect';
2403 // Truncate for whole multibyte characters
2404 $reason = $wgContLang->truncate( $reason, 255 );
2406 $logRelationsValues = array();
2407 $logRelationsField = null;
2408 $logParamsDetails = array();
2410 if ( $id ) { // Protection of existing page
2411 if ( !Hooks
::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2412 return Status
::newGood();
2415 // Only certain restrictions can cascade...
2416 $editrestriction = isset( $limit['edit'] )
2417 ?
array( $limit['edit'] )
2418 : $this->mTitle
->getRestrictions( 'edit' );
2419 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2420 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2422 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2423 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2426 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2427 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2428 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2430 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2431 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2434 // The schema allows multiple restrictions
2435 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2439 // insert null revision to identify the page protection change as edit summary
2440 $latest = $this->getLatest();
2441 $nullRevision = $this->insertProtectNullRevision(
2450 if ( $nullRevision === null ) {
2451 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2454 $logRelationsField = 'pr_id';
2456 // Update restrictions table
2457 foreach ( $limit as $action => $restrictions ) {
2459 'page_restrictions',
2462 'pr_type' => $action
2466 if ( $restrictions != '' ) {
2467 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2469 'page_restrictions',
2471 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2473 'pr_type' => $action,
2474 'pr_level' => $restrictions,
2475 'pr_cascade' => $cascadeValue,
2476 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2480 $logRelationsValues[] = $dbw->insertId();
2481 $logParamsDetails[] = array(
2483 'level' => $restrictions,
2484 'expiry' => $expiry[$action],
2485 'cascade' => (bool)$cascadeValue,
2490 // Clear out legacy restriction fields
2493 array( 'page_restrictions' => '' ),
2494 array( 'page_id' => $id ),
2498 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2499 Hooks
::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2500 } else { // Protection of non-existing page (also known as "title protection")
2501 // Cascade protection is meaningless in this case
2504 if ( $limit['create'] != '' ) {
2505 $dbw->replace( 'protected_titles',
2506 array( array( 'pt_namespace', 'pt_title' ) ),
2508 'pt_namespace' => $this->mTitle
->getNamespace(),
2509 'pt_title' => $this->mTitle
->getDBkey(),
2510 'pt_create_perm' => $limit['create'],
2511 'pt_timestamp' => $dbw->timestamp(),
2512 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2513 'pt_user' => $user->getId(),
2514 'pt_reason' => $reason,
2517 $logParamsDetails[] = array(
2519 'level' => $limit['create'],
2520 'expiry' => $expiry['create'],
2523 $dbw->delete( 'protected_titles',
2525 'pt_namespace' => $this->mTitle
->getNamespace(),
2526 'pt_title' => $this->mTitle
->getDBkey()
2532 $this->mTitle
->flushRestrictions();
2533 InfoAction
::invalidateCache( $this->mTitle
);
2535 if ( $logAction == 'unprotect' ) {
2538 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2540 '4::description' => $protectDescriptionLog, // parameter for IRC
2541 '5:bool:cascade' => $cascade,
2542 'details' => $logParamsDetails, // parameter for localize and api
2546 // Update the protection log
2547 $logEntry = new ManualLogEntry( 'protect', $logAction );
2548 $logEntry->setTarget( $this->mTitle
);
2549 $logEntry->setComment( $reason );
2550 $logEntry->setPerformer( $user );
2551 $logEntry->setParameters( $params );
2552 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2553 $logEntry->setRelations( array( $logRelationsField => $logRelationsValues ) );
2555 $logId = $logEntry->insert();
2556 $logEntry->publish( $logId );
2558 return Status
::newGood();
2562 * Insert a new null revision for this page.
2564 * @param string $revCommentMsg Comment message key for the revision
2565 * @param array $limit Set of restriction keys
2566 * @param array $expiry Per restriction type expiration
2567 * @param int $cascade Set to false if cascading protection isn't allowed.
2568 * @param string $reason
2569 * @param User|null $user
2570 * @return Revision|null Null on error
2572 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2573 array $expiry, $cascade, $reason, $user = null
2576 $dbw = wfGetDB( DB_MASTER
);
2578 // Prepare a null revision to be added to the history
2579 $editComment = $wgContLang->ucfirst(
2582 $this->mTitle
->getPrefixedText()
2583 )->inContentLanguage()->text()
2586 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2588 $protectDescription = $this->protectDescription( $limit, $expiry );
2589 if ( $protectDescription ) {
2590 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2591 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2592 ->inContentLanguage()->text();
2595 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2596 $editComment .= wfMessage( 'brackets' )->params(
2597 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2598 )->inContentLanguage()->text();
2601 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2603 $nullRev->insertOn( $dbw );
2605 // Update page record and touch page
2606 $oldLatest = $nullRev->getParentId();
2607 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2614 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2617 protected function formatExpiry( $expiry ) {
2620 if ( $expiry != 'infinity' ) {
2623 $wgContLang->timeanddate( $expiry, false, false ),
2624 $wgContLang->date( $expiry, false, false ),
2625 $wgContLang->time( $expiry, false, false )
2626 )->inContentLanguage()->text();
2628 return wfMessage( 'protect-expiry-indefinite' )
2629 ->inContentLanguage()->text();
2634 * Builds the description to serve as comment for the edit.
2636 * @param array $limit Set of restriction keys
2637 * @param array $expiry Per restriction type expiration
2640 public function protectDescription( array $limit, array $expiry ) {
2641 $protectDescription = '';
2643 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2644 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2645 # All possible message keys are listed here for easier grepping:
2646 # * restriction-create
2647 # * restriction-edit
2648 # * restriction-move
2649 # * restriction-upload
2650 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2651 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2652 # with '' filtered out. All possible message keys are listed below:
2653 # * protect-level-autoconfirmed
2654 # * protect-level-sysop
2655 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2657 $expiryText = $this->formatExpiry( $expiry[$action] );
2659 if ( $protectDescription !== '' ) {
2660 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2662 $protectDescription .= wfMessage( 'protect-summary-desc' )
2663 ->params( $actionText, $restrictionsText, $expiryText )
2664 ->inContentLanguage()->text();
2667 return $protectDescription;
2671 * Builds the description to serve as comment for the log entry.
2673 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2674 * protect description text. Keep them in old format to avoid breaking compatibility.
2675 * TODO: Fix protection log to store structured description and format it on-the-fly.
2677 * @param array $limit Set of restriction keys
2678 * @param array $expiry Per restriction type expiration
2681 public function protectDescriptionLog( array $limit, array $expiry ) {
2684 $protectDescriptionLog = '';
2686 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2687 $expiryText = $this->formatExpiry( $expiry[$action] );
2688 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] ($expiryText)";
2691 return trim( $protectDescriptionLog );
2695 * Take an array of page restrictions and flatten it to a string
2696 * suitable for insertion into the page_restrictions field.
2698 * @param string[] $limit
2700 * @throws MWException
2703 protected static function flattenRestrictions( $limit ) {
2704 if ( !is_array( $limit ) ) {
2705 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2711 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2712 $bits[] = "$action=$restrictions";
2715 return implode( ':', $bits );
2719 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2720 * backwards compatibility, if you care about error reporting you should use
2721 * doDeleteArticleReal() instead.
2723 * Deletes the article with database consistency, writes logs, purges caches
2725 * @param string $reason Delete reason for deletion log
2726 * @param bool $suppress Suppress all revisions and log the deletion in
2727 * the suppression log instead of the deletion log
2728 * @param int $id Article ID
2729 * @param bool $commit Defaults to true, triggers transaction end
2730 * @param array &$error Array of errors to append to
2731 * @param User $user The deleting user
2732 * @return bool True if successful
2734 public function doDeleteArticle(
2735 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2737 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2738 return $status->isGood();
2742 * Back-end article deletion
2743 * Deletes the article with database consistency, writes logs, purges caches
2747 * @param string $reason Delete reason for deletion log
2748 * @param bool $suppress Suppress all revisions and log the deletion in
2749 * the suppression log instead of the deletion log
2750 * @param int $id Article ID
2751 * @param bool $commit Defaults to true, triggers transaction end
2752 * @param array &$error Array of errors to append to
2753 * @param User $user The deleting user
2754 * @return Status Status object; if successful, $status->value is the log_id of the
2755 * deletion log entry. If the page couldn't be deleted because it wasn't
2756 * found, $status is a non-fatal 'cannotdelete' error
2758 public function doDeleteArticleReal(
2759 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2761 global $wgUser, $wgContentHandlerUseDB;
2763 wfDebug( __METHOD__
. "\n" );
2765 $status = Status
::newGood();
2767 if ( $this->mTitle
->getDBkey() === '' ) {
2768 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2772 $user = is_null( $user ) ?
$wgUser : $user;
2773 if ( !Hooks
::run( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2774 if ( $status->isOK() ) {
2775 // Hook aborted but didn't set a fatal status
2776 $status->fatal( 'delete-hook-aborted' );
2781 $dbw = wfGetDB( DB_MASTER
);
2782 $dbw->begin( __METHOD__
);
2785 // T98706: lock the page from various other updates but avoid using
2786 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2787 // the revisions queries (which also JOIN on user). Only lock the page
2788 // row and CAS check on page_latest to see if the trx snapshot matches.
2789 $latest = $this->lock();
2791 $this->loadPageData( WikiPage
::READ_LATEST
);
2792 $id = $this->getID();
2793 if ( $id == 0 ||
$this->getLatest() != $latest ) {
2794 // Page not there or trx snapshot is stale
2795 $dbw->rollback( __METHOD__
);
2796 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2801 // we need to remember the old content so we can use it to generate all deletion updates.
2802 $content = $this->getContent( Revision
::RAW
);
2804 // Bitfields to further suppress the content
2807 // This should be 15...
2808 $bitfield |
= Revision
::DELETED_TEXT
;
2809 $bitfield |
= Revision
::DELETED_COMMENT
;
2810 $bitfield |
= Revision
::DELETED_USER
;
2811 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2813 $bitfield = 'rev_deleted';
2817 * For now, shunt the revision data into the archive table.
2818 * Text is *not* removed from the text table; bulk storage
2819 * is left intact to avoid breaking block-compression or
2820 * immutable storage schemes.
2822 * For backwards compatibility, note that some older archive
2823 * table entries will have ar_text and ar_flags fields still.
2825 * In the future, we may keep revisions and mark them with
2826 * the rev_deleted field, which is reserved for this purpose.
2830 'ar_namespace' => 'page_namespace',
2831 'ar_title' => 'page_title',
2832 'ar_comment' => 'rev_comment',
2833 'ar_user' => 'rev_user',
2834 'ar_user_text' => 'rev_user_text',
2835 'ar_timestamp' => 'rev_timestamp',
2836 'ar_minor_edit' => 'rev_minor_edit',
2837 'ar_rev_id' => 'rev_id',
2838 'ar_parent_id' => 'rev_parent_id',
2839 'ar_text_id' => 'rev_text_id',
2840 'ar_text' => '\'\'', // Be explicit to appease
2841 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2842 'ar_len' => 'rev_len',
2843 'ar_page_id' => 'page_id',
2844 'ar_deleted' => $bitfield,
2845 'ar_sha1' => 'rev_sha1',
2848 if ( $wgContentHandlerUseDB ) {
2849 $row['ar_content_model'] = 'rev_content_model';
2850 $row['ar_content_format'] = 'rev_content_format';
2853 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2857 'page_id = rev_page'
2861 // Now that it's safely backed up, delete it
2862 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2863 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2866 $dbw->rollback( __METHOD__
);
2867 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2871 if ( !$dbw->cascadingDeletes() ) {
2872 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
2875 // Clone the title, so we have the information we need when we log
2876 $logTitle = clone $this->mTitle
;
2878 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2879 $logtype = $suppress ?
'suppress' : 'delete';
2881 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2882 $logEntry->setPerformer( $user );
2883 $logEntry->setTarget( $logTitle );
2884 $logEntry->setComment( $reason );
2885 $logid = $logEntry->insert();
2887 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2888 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2889 $logEntry->publish( $logid );
2893 $dbw->commit( __METHOD__
);
2896 // Show log excerpt on 404 pages rather than just a link
2897 $key = wfMemcKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2898 ObjectCache
::getMainStashInstance()->set( $key, 1, 86400 );
2900 $this->doDeleteUpdates( $id, $content );
2902 Hooks
::run( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2903 $status->value
= $logid;
2908 * Lock the page row for this title and return page_latest (or 0)
2912 protected function lock() {
2913 return (int)wfGetDB( DB_MASTER
)->selectField(
2917 'page_namespace' => $this->getTitle()->getNamespace(),
2918 'page_title' => $this->getTitle()->getDBkey()
2921 array( 'FOR UPDATE' )
2926 * Do some database updates after deletion
2928 * @param int $id The page_id value of the page being deleted
2929 * @param Content $content Optional page content to be used when determining
2930 * the required updates. This may be needed because $this->getContent()
2931 * may already return null when the page proper was deleted.
2933 public function doDeleteUpdates( $id, Content
$content = null ) {
2934 // update site status
2935 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2937 // remove secondary indexes, etc
2938 $updates = $this->getDeletionUpdates( $content );
2939 DataUpdate
::runUpdates( $updates, 'enqueue' );
2941 // Reparse any pages transcluding this page
2942 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
2944 // Reparse any pages including this image
2945 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
2946 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
2950 WikiPage
::onArticleDelete( $this->mTitle
);
2952 // Reset this object and the Title object
2953 $this->loadFromRow( false, self
::READ_LATEST
);
2956 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
2960 * Roll back the most recent consecutive set of edits to a page
2961 * from the same user; fails if there are no eligible edits to
2962 * roll back to, e.g. user is the sole contributor. This function
2963 * performs permissions checks on $user, then calls commitRollback()
2964 * to do the dirty work
2966 * @todo Separate the business/permission stuff out from backend code
2968 * @param string $fromP Name of the user whose edits to rollback.
2969 * @param string $summary Custom summary. Set to default summary if empty.
2970 * @param string $token Rollback token.
2971 * @param bool $bot If true, mark all reverted edits as bot.
2973 * @param array $resultDetails Array contains result-specific array of additional values
2974 * 'alreadyrolled' : 'current' (rev)
2975 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2977 * @param User $user The user performing the rollback
2978 * @return array Array of errors, each error formatted as
2979 * array(messagekey, param1, param2, ...).
2980 * On success, the array is empty. This array can also be passed to
2981 * OutputPage::showPermissionsErrorPage().
2983 public function doRollback(
2984 $fromP, $summary, $token, $bot, &$resultDetails, User
$user
2986 $resultDetails = null;
2988 // Check permissions
2989 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
2990 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
2991 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2993 if ( !$user->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
2994 $errors[] = array( 'sessionfailure' );
2997 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
2998 $errors[] = array( 'actionthrottledtext' );
3001 // If there were errors, bail out now
3002 if ( !empty( $errors ) ) {
3006 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
3010 * Backend implementation of doRollback(), please refer there for parameter
3011 * and return value documentation
3013 * NOTE: This function does NOT check ANY permissions, it just commits the
3014 * rollback to the DB. Therefore, you should only call this function direct-
3015 * ly if you want to use custom permissions checks. If you don't, use
3016 * doRollback() instead.
3017 * @param string $fromP Name of the user whose edits to rollback.
3018 * @param string $summary Custom summary. Set to default summary if empty.
3019 * @param bool $bot If true, mark all reverted edits as bot.
3021 * @param array $resultDetails Contains result-specific array of additional values
3022 * @param User $guser The user performing the rollback
3025 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser ) {
3026 global $wgUseRCPatrol, $wgContLang;
3028 $dbw = wfGetDB( DB_MASTER
);
3030 if ( wfReadOnly() ) {
3031 return array( array( 'readonlytext' ) );
3034 // Get the last editor
3035 $current = $this->getRevision();
3036 if ( is_null( $current ) ) {
3037 // Something wrong... no page?
3038 return array( array( 'notanarticle' ) );
3041 $from = str_replace( '_', ' ', $fromP );
3042 // User name given should match up with the top revision.
3043 // If the user was deleted then $from should be empty.
3044 if ( $from != $current->getUserText() ) {
3045 $resultDetails = array( 'current' => $current );
3046 return array( array( 'alreadyrolled',
3047 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3048 htmlspecialchars( $fromP ),
3049 htmlspecialchars( $current->getUserText() )
3053 // Get the last edit not by this person...
3054 // Note: these may not be public values
3055 $user = intval( $current->getUser( Revision
::RAW
) );
3056 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3057 $s = $dbw->selectRow( 'revision',
3058 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3059 array( 'rev_page' => $current->getPage(),
3060 "rev_user != {$user} OR rev_user_text != {$user_text}"
3062 array( 'USE INDEX' => 'page_timestamp',
3063 'ORDER BY' => 'rev_timestamp DESC' )
3065 if ( $s === false ) {
3066 // No one else ever edited this page
3067 return array( array( 'cantrollback' ) );
3068 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3069 ||
$s->rev_deleted
& Revision
::DELETED_USER
3071 // Only admins can see this text
3072 return array( array( 'notvisiblerev' ) );
3075 // Generate the edit summary if necessary
3076 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3077 if ( empty( $summary ) ) {
3078 if ( $from == '' ) { // no public user name
3079 $summary = wfMessage( 'revertpage-nouser' );
3081 $summary = wfMessage( 'revertpage' );
3085 // Allow the custom summary to use the same args as the default message
3087 $target->getUserText(), $from, $s->rev_id
,
3088 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3089 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3091 if ( $summary instanceof Message
) {
3092 $summary = $summary->params( $args )->inContentLanguage()->text();
3094 $summary = wfMsgReplaceArgs( $summary, $args );
3097 // Trim spaces on user supplied text
3098 $summary = trim( $summary );
3100 // Truncate for whole multibyte characters.
3101 $summary = $wgContLang->truncate( $summary, 255 );
3104 $flags = EDIT_UPDATE
;
3106 if ( $guser->isAllowed( 'minoredit' ) ) {
3107 $flags |
= EDIT_MINOR
;
3110 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3111 $flags |
= EDIT_FORCE_BOT
;
3114 // Actually store the edit
3115 $status = $this->doEditContent(
3116 $target->getContent(),
3123 // Set patrolling and bot flag on the edits, which gets rollbacked.
3124 // This is done even on edit failure to have patrolling in that case (bug 62157).
3126 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3127 // Mark all reverted edits as bot
3131 if ( $wgUseRCPatrol ) {
3132 // Mark all reverted edits as patrolled
3133 $set['rc_patrolled'] = 1;
3136 if ( count( $set ) ) {
3137 $dbw->update( 'recentchanges', $set,
3139 'rc_cur_id' => $current->getPage(),
3140 'rc_user_text' => $current->getUserText(),
3141 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3147 if ( !$status->isOK() ) {
3148 return $status->getErrorsArray();
3151 // raise error, when the edit is an edit without a new version
3152 if ( empty( $status->value
['revision'] ) ) {
3153 $resultDetails = array( 'current' => $current );
3154 return array( array( 'alreadyrolled',
3155 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3156 htmlspecialchars( $fromP ),
3157 htmlspecialchars( $current->getUserText() )
3161 $revId = $status->value
['revision']->getId();
3163 Hooks
::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3165 $resultDetails = array(
3166 'summary' => $summary,
3167 'current' => $current,
3168 'target' => $target,
3176 * The onArticle*() functions are supposed to be a kind of hooks
3177 * which should be called whenever any of the specified actions
3180 * This is a good place to put code to clear caches, for instance.
3182 * This is called on page move and undelete, as well as edit
3184 * @param Title $title
3186 public static function onArticleCreate( Title
$title ) {
3187 // Update existence markers on article/talk tabs...
3188 $other = $title->getOtherPage();
3190 $other->purgeSquid();
3192 $title->touchLinks();
3193 $title->purgeSquid();
3194 $title->deleteTitleProtection();
3198 * Clears caches when article is deleted
3200 * @param Title $title
3202 public static function onArticleDelete( Title
$title ) {
3203 // Update existence markers on article/talk tabs...
3204 $other = $title->getOtherPage();
3206 $other->purgeSquid();
3208 $title->touchLinks();
3209 $title->purgeSquid();
3212 HTMLFileCache
::clearFileCache( $title );
3213 InfoAction
::invalidateCache( $title );
3216 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3217 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3221 if ( $title->getNamespace() == NS_FILE
) {
3222 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3223 $update->doUpdate();
3227 if ( $title->getNamespace() == NS_USER_TALK
) {
3228 $user = User
::newFromName( $title->getText(), false );
3230 $user->setNewtalk( false );
3235 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3239 * Purge caches on page update etc
3241 * @param Title $title
3242 * @param Revision|null $revision Revision that was just saved, may be null
3244 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3245 // Invalidate caches of articles which include this page
3246 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3248 // Invalidate the caches of all pages which redirect here
3249 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3251 // Purge squid for this page only
3252 $title->purgeSquid();
3253 // Clear file cache for this page only
3254 HTMLFileCache
::clearFileCache( $title );
3256 $revid = $revision ?
$revision->getId() : null;
3257 DeferredUpdates
::addCallableUpdate( function() use ( $title, $revid ) {
3258 InfoAction
::invalidateCache( $title, $revid );
3265 * Returns a list of categories this page is a member of.
3266 * Results will include hidden categories
3268 * @return TitleArray
3270 public function getCategories() {
3271 $id = $this->getId();
3273 return TitleArray
::newFromResult( new FakeResultWrapper( array() ) );
3276 $dbr = wfGetDB( DB_SLAVE
);
3277 $res = $dbr->select( 'categorylinks',
3278 array( 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ),
3279 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3280 // as not being aliases, and NS_CATEGORY is numeric
3281 array( 'cl_from' => $id ),
3284 return TitleArray
::newFromResult( $res );
3288 * Returns a list of hidden categories this page is a member of.
3289 * Uses the page_props and categorylinks tables.
3291 * @return array Array of Title objects
3293 public function getHiddenCategories() {
3295 $id = $this->getId();
3301 $dbr = wfGetDB( DB_SLAVE
);
3302 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3304 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3305 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
3308 if ( $res !== false ) {
3309 foreach ( $res as $row ) {
3310 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3318 * Return an applicable autosummary if one exists for the given edit.
3319 * @param string|null $oldtext The previous text of the page.
3320 * @param string|null $newtext The submitted text of the page.
3321 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3322 * @return string An appropriate autosummary, or an empty string.
3324 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3326 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3327 // NOTE: stub for backwards-compatibility. assumes the given text is
3328 // wikitext. will break horribly if it isn't.
3330 ContentHandler
::deprecated( __METHOD__
, '1.21' );
3332 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
3333 $oldContent = is_null( $oldtext ) ?
null : $handler->unserializeContent( $oldtext );
3334 $newContent = is_null( $newtext ) ?
null : $handler->unserializeContent( $newtext );
3336 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3340 * Auto-generates a deletion reason
3342 * @param bool &$hasHistory Whether the page has a history
3343 * @return string|bool String containing deletion reason or empty string, or boolean false
3344 * if no revision occurred
3346 public function getAutoDeleteReason( &$hasHistory ) {
3347 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3351 * Update all the appropriate counts in the category table, given that
3352 * we've added the categories $added and deleted the categories $deleted.
3354 * @param array $added The names of categories that were added
3355 * @param array $deleted The names of categories that were deleted
3357 public function updateCategoryCounts( array $added, array $deleted ) {
3359 $method = __METHOD__
;
3360 $dbw = wfGetDB( DB_MASTER
);
3362 // Do this at the end of the commit to reduce lock wait timeouts
3363 $dbw->onTransactionPreCommitOrIdle(
3364 function () use ( $dbw, $that, $method, $added, $deleted ) {
3365 $ns = $that->getTitle()->getNamespace();
3367 $addFields = array( 'cat_pages = cat_pages + 1' );
3368 $removeFields = array( 'cat_pages = cat_pages - 1' );
3369 if ( $ns == NS_CATEGORY
) {
3370 $addFields[] = 'cat_subcats = cat_subcats + 1';
3371 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3372 } elseif ( $ns == NS_FILE
) {
3373 $addFields[] = 'cat_files = cat_files + 1';
3374 $removeFields[] = 'cat_files = cat_files - 1';
3377 if ( count( $added ) ) {
3378 $insertRows = array();
3379 foreach ( $added as $cat ) {
3380 $insertRows[] = array(
3381 'cat_title' => $cat,
3383 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3384 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3390 array( 'cat_title' ),
3396 if ( count( $deleted ) ) {
3400 array( 'cat_title' => $deleted ),
3405 foreach ( $added as $catName ) {
3406 $cat = Category
::newFromName( $catName );
3407 Hooks
::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3410 foreach ( $deleted as $catName ) {
3411 $cat = Category
::newFromName( $catName );
3412 Hooks
::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3419 * Opportunistically enqueue link update jobs given fresh parser output if useful
3421 * @param ParserOutput $parserOutput Current version page output
3424 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3425 if ( wfReadOnly() ) {
3429 if ( !Hooks
::run( 'OpportunisticLinksUpdate', array( $this, $this->mTitle
, $parserOutput ) ) ) {
3433 if ( $this->mTitle
->areRestrictionsCascading() ) {
3434 // If the page is cascade protecting, the links should really be up-to-date
3435 $params = array( 'prioritize' => true );
3436 } elseif ( $parserOutput->hasDynamicContent() ) {
3437 // Assume the output contains time/random based magic words
3440 // If the inclusions are deterministic, the edit-triggered link jobs are enough
3444 // Check if the last link refresh was before page_touched
3445 if ( $this->getLinksTimestamp() < $this->getTouched() ) {
3446 $params['isOpportunistic'] = true;
3447 $params['rootJobTimestamp'] = $parserOutput->getCacheTime();
3449 JobQueueGroup
::singleton()->lazyPush( EnqueueJob
::newFromLocalJobs(
3450 new JobSpecification( 'refreshLinks', $params,
3451 array( 'removeDuplicates' => true ), $this->mTitle
)
3457 * Return a list of templates used by this article.
3458 * Uses the templatelinks table
3460 * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3461 * @return array Array of Title objects
3463 public function getUsedTemplates() {
3464 return $this->mTitle
->getTemplateLinksFrom();
3468 * This function is called right before saving the wikitext,
3469 * so we can do things like signatures and links-in-context.
3471 * @deprecated since 1.19; use Parser::preSaveTransform() instead
3472 * @param string $text Article contents
3473 * @param User $user User doing the edit
3474 * @param ParserOptions $popts Parser options, default options for
3475 * the user loaded if null given
3476 * @return string Article contents with altered wikitext markup (signatures
3477 * converted, {{subst:}}, templates, etc.)
3479 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
3480 global $wgParser, $wgUser;
3482 wfDeprecated( __METHOD__
, '1.19' );
3484 $user = is_null( $user ) ?
$wgUser : $user;
3486 if ( $popts === null ) {
3487 $popts = ParserOptions
::newFromUser( $user );
3490 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
3494 * Update the article's restriction field, and leave a log entry.
3496 * @deprecated since 1.19
3497 * @param array $limit Set of restriction keys
3498 * @param string $reason
3499 * @param int &$cascade Set to false if cascading protection isn't allowed.
3500 * @param array $expiry Per restriction type expiration
3501 * @param User $user The user updating the restrictions
3502 * @return bool True on success
3504 public function updateRestrictions(
3505 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User
$user = null
3509 $user = is_null( $user ) ?
$wgUser : $user;
3511 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3515 * Returns a list of updates to be performed when this page is deleted. The
3516 * updates should remove any information about this page from secondary data
3517 * stores such as links tables.
3519 * @param Content|null $content Optional Content object for determining the
3520 * necessary updates.
3521 * @return array An array of DataUpdates objects
3523 public function getDeletionUpdates( Content
$content = null ) {
3525 // load content object, which may be used to determine the necessary updates
3526 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3527 $content = $this->getContent( Revision
::RAW
);
3533 $updates = $content->getDeletionUpdates( $this );
3536 Hooks
::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );