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(
147 'page', self
::selectFields(), array( 'page_id' => $id ), __METHOD__
);
151 return self
::newFromRow( $row, $from );
155 * Constructor from a database row
158 * @param object $row Database row containing at least fields returned by selectFields().
159 * @param string|int $from Source of $data:
160 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
161 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
162 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
165 public static function newFromRow( $row, $from = 'fromdb' ) {
166 $page = self
::factory( Title
::newFromRow( $row ) );
167 $page->loadFromRow( $row, $from );
172 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
174 * @param object|string|int $type
177 private static function convertSelectType( $type ) {
180 return self
::READ_NORMAL
;
182 return self
::READ_LATEST
;
184 return self
::READ_LOCKING
;
186 // It may already be an integer or whatever else
192 * Returns overrides for action handlers.
193 * Classes listed here will be used instead of the default one when
194 * (and only when) $wgActions[$action] === true. This allows subclasses
195 * to override the default behavior.
197 * @todo Move this UI stuff somewhere else
201 public function getActionOverrides() {
202 $content_handler = $this->getContentHandler();
203 return $content_handler->getActionOverrides();
207 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
209 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
211 * @return ContentHandler
215 public function getContentHandler() {
216 return ContentHandler
::getForModelID( $this->getContentModel() );
220 * Get the title object of the article
221 * @return Title Title object of this page
223 public function getTitle() {
224 return $this->mTitle
;
231 public function clear() {
232 $this->mDataLoaded
= false;
233 $this->mDataLoadedFrom
= self
::READ_NONE
;
235 $this->clearCacheFields();
239 * Clear the object cache fields
242 protected function clearCacheFields() {
244 $this->mRedirectTarget
= null; // Title object if set
245 $this->mLastRevision
= null; // Latest revision
246 $this->mTouched
= '19700101000000';
247 $this->mLinksUpdated
= '19700101000000';
248 $this->mTimestamp
= '';
249 $this->mIsRedirect
= false;
250 $this->mLatest
= false;
251 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
252 // the requested rev ID and content against the cached one for equality. For most
253 // content types, the output should not change during the lifetime of this cache.
254 // Clearing it can cause extra parses on edit for no reason.
258 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
262 public function clearPreparedEdit() {
263 $this->mPreparedEdit
= false;
267 * Return the list of revision fields that should be selected to create
272 public static function selectFields() {
273 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
284 'page_links_updated',
289 if ( $wgContentHandlerUseDB ) {
290 $fields[] = 'page_content_model';
293 if ( $wgPageLanguageUseDB ) {
294 $fields[] = 'page_lang';
301 * Fetch a page record with the given conditions
302 * @param IDatabase $dbr
303 * @param array $conditions
304 * @param array $options
305 * @return object|bool Database result resource, or false on failure
307 protected function pageData( $dbr, $conditions, $options = array() ) {
308 $fields = self
::selectFields();
310 Hooks
::run( 'ArticlePageDataBefore', array( &$this, &$fields ) );
312 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
314 Hooks
::run( 'ArticlePageDataAfter', array( &$this, &$row ) );
320 * Fetch a page record matching the Title object's namespace and title
321 * using a sanitized title string
323 * @param IDatabase $dbr
324 * @param Title $title
325 * @param array $options
326 * @return object|bool Database result resource, or false on failure
328 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
329 return $this->pageData( $dbr, array(
330 'page_namespace' => $title->getNamespace(),
331 'page_title' => $title->getDBkey() ), $options );
335 * Fetch a page record matching the requested ID
337 * @param IDatabase $dbr
339 * @param array $options
340 * @return object|bool Database result resource, or false on failure
342 public function pageDataFromId( $dbr, $id, $options = array() ) {
343 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
347 * Load the object from a given source by title
349 * @param object|string|int $from One of the following:
350 * - A DB query result object.
351 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
352 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
353 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
354 * using SELECT FOR UPDATE.
358 public function loadPageData( $from = 'fromdb' ) {
359 $from = self
::convertSelectType( $from );
360 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
361 // We already have the data from the correct location, no need to load it twice.
365 if ( is_int( $from ) ) {
366 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
367 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
370 && $index == DB_SLAVE
371 && wfGetLB()->getServerCount() > 1
372 && wfGetLB()->hasOrMadeRecentMasterChanges()
374 $from = self
::READ_LATEST
;
375 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
376 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
379 // No idea from where the caller got this data, assume slave database.
381 $from = self
::READ_NORMAL
;
384 $this->loadFromRow( $data, $from );
388 * Load the object from a database row
391 * @param object|bool $data DB row containing fields returned by selectFields() or false
392 * @param string|int $from One of the following:
393 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
394 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
395 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
396 * the master DB using SELECT FOR UPDATE
398 public function loadFromRow( $data, $from ) {
399 $lc = LinkCache
::singleton();
400 $lc->clearLink( $this->mTitle
);
403 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
405 $this->mTitle
->loadFromRow( $data );
407 // Old-fashioned restrictions
408 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
410 $this->mId
= intval( $data->page_id
);
411 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
412 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
413 $this->mIsRedirect
= intval( $data->page_is_redirect
);
414 $this->mLatest
= intval( $data->page_latest
);
415 // Bug 37225: $latest may no longer match the cached latest Revision object.
416 // Double-check the ID of any cached latest Revision object for consistency.
417 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
418 $this->mLastRevision
= null;
419 $this->mTimestamp
= '';
422 $lc->addBadLinkObj( $this->mTitle
);
424 $this->mTitle
->loadFromRow( false );
426 $this->clearCacheFields();
431 $this->mDataLoaded
= true;
432 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
436 * @return int Page ID
438 public function getId() {
439 if ( !$this->mDataLoaded
) {
440 $this->loadPageData();
446 * @return bool Whether or not the page exists in the database
448 public function exists() {
449 if ( !$this->mDataLoaded
) {
450 $this->loadPageData();
452 return $this->mId
> 0;
456 * Check if this page is something we're going to be showing
457 * some sort of sensible content for. If we return false, page
458 * views (plain action=view) will return an HTTP 404 response,
459 * so spiders and robots can know they're following a bad link.
463 public function hasViewableContent() {
464 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
468 * Tests if the article content represents a redirect
472 public function isRedirect() {
473 if ( !$this->mDataLoaded
) {
474 $this->loadPageData();
477 return (bool)$this->mIsRedirect
;
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() )}";
1015 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1018 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1022 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1023 'ORDER BY' => 'timestamp DESC',
1026 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1027 return new UserArrayFromResult( $res );
1031 * Get the last N authors
1032 * @param int $num Number of revisions to get
1033 * @param int|string $revLatest The latest rev_id, selected from the master (optional)
1034 * @return array Array of authors, duplicates not removed
1036 public function getLastNAuthors( $num, $revLatest = 0 ) {
1037 // First try the slave
1038 // If that doesn't have the latest revision, try the master
1040 $db = wfGetDB( DB_SLAVE
);
1043 $res = $db->select( array( 'page', 'revision' ),
1044 array( 'rev_id', 'rev_user_text' ),
1046 'page_namespace' => $this->mTitle
->getNamespace(),
1047 'page_title' => $this->mTitle
->getDBkey(),
1048 'rev_page = page_id'
1051 'ORDER BY' => 'rev_timestamp DESC',
1060 $row = $db->fetchObject( $res );
1062 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
1063 $db = wfGetDB( DB_MASTER
);
1068 } while ( $continue );
1070 $authors = array( $row->rev_user_text
);
1072 foreach ( $res as $row ) {
1073 $authors[] = $row->rev_user_text
;
1080 * Should the parser cache be used?
1082 * @param ParserOptions $parserOptions ParserOptions to check
1086 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1087 return $parserOptions->getStubThreshold() == 0
1089 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1090 && $this->getContentHandler()->isParserCacheSupported();
1094 * Get a ParserOutput for the given ParserOptions and revision ID.
1096 * The parser cache will be used if possible. Cache misses that result
1097 * in parser runs are debounced with PoolCounter.
1100 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1101 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1102 * get the current revision (default value)
1104 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1106 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
1108 $useParserCache = $this->shouldCheckParserCache( $parserOptions, $oldid );
1109 wfDebug( __METHOD__
.
1110 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1111 if ( $parserOptions->getStubThreshold() ) {
1112 wfIncrStats( 'pcache.miss.stub' );
1115 if ( $useParserCache ) {
1116 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1117 if ( $parserOutput !== false ) {
1118 return $parserOutput;
1122 if ( $oldid === null ||
$oldid === 0 ) {
1123 $oldid = $this->getLatest();
1126 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1129 return $pool->getParserOutput();
1133 * Do standard deferred updates after page view (existing or missing page)
1134 * @param User $user The relevant user
1135 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1137 public function doViewUpdates( User
$user, $oldid = 0 ) {
1138 if ( wfReadOnly() ) {
1142 Hooks
::run( 'PageViewUpdates', array( $this, $user ) );
1143 // Update newtalk / watchlist notification status
1145 $user->clearNotification( $this->mTitle
, $oldid );
1146 } catch ( DBError
$e ) {
1147 // Avoid outage if the master is not reachable
1148 MWExceptionHandler
::logException( $e );
1153 * Perform the actions of a page purging
1156 public function doPurge() {
1157 if ( !Hooks
::run( 'ArticlePurge', array( &$this ) ) ) {
1161 $title = $this->mTitle
;
1162 wfGetDB( DB_MASTER
)->onTransactionIdle( function() use ( $title ) {
1164 // Invalidate the cache in auto-commit mode
1165 $title->invalidateCache();
1166 if ( $wgUseSquid ) {
1167 // Send purge now that page_touched update was committed above
1168 $update = new SquidUpdate( $title->getSquidURLs() );
1169 $update->doUpdate();
1173 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1174 // @todo move this logic to MessageCache
1175 if ( $this->exists() ) {
1176 // NOTE: use transclusion text for messages.
1177 // This is consistent with MessageCache::getMsgFromNamespace()
1179 $content = $this->getContent();
1180 $text = $content === null ?
null : $content->getWikitextForTransclusion();
1182 if ( $text === null ) {
1189 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1195 * Insert a new empty page record for this article.
1196 * This *must* be followed up by creating a revision
1197 * and running $this->updateRevisionOn( ... );
1198 * or else the record will be left in a funky state.
1199 * Best if all done inside a transaction.
1201 * @param IDatabase $dbw
1202 * @return int|bool The newly created page_id key; false if the title already existed
1204 public function insertOn( $dbw ) {
1208 'page_id' => $dbw->nextSequenceValue( 'page_page_id_seq' ),
1209 'page_namespace' => $this->mTitle
->getNamespace(),
1210 'page_title' => $this->mTitle
->getDBkey(),
1211 'page_restrictions' => '',
1212 'page_is_redirect' => 0, // Will set this shortly...
1214 'page_random' => wfRandom(),
1215 'page_touched' => $dbw->timestamp(),
1216 'page_latest' => 0, // Fill this in shortly...
1217 'page_len' => 0, // Fill this in shortly...
1223 if ( $dbw->affectedRows() > 0 ) {
1224 $newid = $dbw->insertId();
1225 $this->mId
= $newid;
1226 $this->mTitle
->resetArticleID( $newid );
1230 return false; // nothing changed
1235 * Update the page record to point to a newly saved revision.
1237 * @param IDatabase $dbw
1238 * @param Revision $revision For ID number, and text used to set
1239 * length and redirect status fields
1240 * @param int $lastRevision If given, will not overwrite the page field
1241 * when different from the currently set value.
1242 * Giving 0 indicates the new page flag should be set on.
1243 * @param bool $lastRevIsRedirect If given, will optimize adding and
1244 * removing rows in redirect table.
1245 * @return bool Success; false if the page row was missing or page_latest changed
1247 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1248 $lastRevIsRedirect = null
1250 global $wgContentHandlerUseDB;
1252 // Assertion to try to catch T92046
1253 if ( (int)$revision->getId() === 0 ) {
1254 throw new InvalidArgumentException(
1255 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1259 $content = $revision->getContent();
1260 $len = $content ?
$content->getSize() : 0;
1261 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1263 $conditions = array( 'page_id' => $this->getId() );
1265 if ( !is_null( $lastRevision ) ) {
1266 // An extra check against threads stepping on each other
1267 $conditions['page_latest'] = $lastRevision;
1270 $row = array( /* SET */
1271 'page_latest' => $revision->getId(),
1272 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1273 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1274 'page_is_redirect' => $rt !== null ?
1 : 0,
1278 if ( $wgContentHandlerUseDB ) {
1279 $row['page_content_model'] = $revision->getContentModel();
1282 $dbw->update( 'page',
1287 $result = $dbw->affectedRows() > 0;
1289 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1290 $this->setLastEdit( $revision );
1291 $this->mLatest
= $revision->getId();
1292 $this->mIsRedirect
= (bool)$rt;
1293 // Update the LinkCache.
1294 LinkCache
::singleton()->addGoodLinkObj(
1300 $revision->getContentModel()
1308 * Add row to the redirect table if this is a redirect, remove otherwise.
1310 * @param IDatabase $dbw
1311 * @param Title $redirectTitle Title object pointing to the redirect target,
1312 * or NULL if this is not a redirect
1313 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1314 * removing rows in redirect table.
1315 * @return bool True on success, false on failure
1318 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1319 // Always update redirects (target link might have changed)
1320 // Update/Insert if we don't know if the last revision was a redirect or not
1321 // Delete if changing from redirect to non-redirect
1322 $isRedirect = !is_null( $redirectTitle );
1324 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1328 if ( $isRedirect ) {
1329 $this->insertRedirectEntry( $redirectTitle );
1331 // This is not a redirect, remove row from redirect table
1332 $where = array( 'rd_from' => $this->getId() );
1333 $dbw->delete( 'redirect', $where, __METHOD__
);
1336 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1337 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1340 return ( $dbw->affectedRows() != 0 );
1344 * If the given revision is newer than the currently set page_latest,
1345 * update the page record. Otherwise, do nothing.
1347 * @deprecated since 1.24, use updateRevisionOn instead
1349 * @param IDatabase $dbw
1350 * @param Revision $revision
1353 public function updateIfNewerOn( $dbw, $revision ) {
1355 $row = $dbw->selectRow(
1356 array( 'revision', 'page' ),
1357 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1359 'page_id' => $this->getId(),
1360 'page_latest=rev_id' ),
1364 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1367 $prev = $row->rev_id
;
1368 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1370 // No or missing previous revision; mark the page as new
1372 $lastRevIsRedirect = null;
1375 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1381 * Get the content that needs to be saved in order to undo all revisions
1382 * between $undo and $undoafter. Revisions must belong to the same page,
1383 * must exist and must not be deleted
1384 * @param Revision $undo
1385 * @param Revision $undoafter Must be an earlier revision than $undo
1386 * @return mixed String on success, false on failure
1388 * Before we had the Content object, this was done in getUndoText
1390 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1391 $handler = $undo->getContentHandler();
1392 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1396 * Get the text that needs to be saved in order to undo all revisions
1397 * between $undo and $undoafter. Revisions must belong to the same page,
1398 * must exist and must not be deleted
1399 * @param Revision $undo
1400 * @param Revision $undoafter Must be an earlier revision than $undo
1401 * @return string|bool String on success, false on failure
1402 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1404 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
1405 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1407 $this->loadLastEdit();
1409 if ( $this->mLastRevision
) {
1410 if ( is_null( $undoafter ) ) {
1411 $undoafter = $undo->getPrevious();
1414 $handler = $this->getContentHandler();
1415 $undone = $handler->getUndoContent( $this->mLastRevision
, $undo, $undoafter );
1420 return ContentHandler
::getContentText( $undone );
1428 * @param string|number|null|bool $sectionId Section identifier as a number or string
1429 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1430 * or 'new' for a new section.
1431 * @param string $text New text of the section.
1432 * @param string $sectionTitle New section's subject, only if $section is "new".
1433 * @param string $edittime Revision timestamp or null to use the current revision.
1435 * @throws MWException
1436 * @return string|null New complete article text, or null if error.
1438 * @deprecated since 1.21, use replaceSectionAtRev() instead
1440 public function replaceSection( $sectionId, $text, $sectionTitle = '',
1443 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1445 // NOTE: keep condition in sync with condition in replaceSectionContent!
1446 if ( strval( $sectionId ) === '' ) {
1447 // Whole-page edit; let the whole text through
1451 if ( !$this->supportsSections() ) {
1452 throw new MWException( "sections not supported for content model " .
1453 $this->getContentHandler()->getModelID() );
1456 // could even make section title, but that's not required.
1457 $sectionContent = ContentHandler
::makeContent( $text, $this->getTitle() );
1459 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1462 return ContentHandler
::getContentText( $newContent );
1466 * Returns true if this page's content model supports sections.
1470 * @todo The skin should check this and not offer section functionality if
1471 * sections are not supported.
1472 * @todo The EditPage should check this and not offer section functionality
1473 * if sections are not supported.
1475 public function supportsSections() {
1476 return $this->getContentHandler()->supportsSections();
1480 * @param string|number|null|bool $sectionId Section identifier as a number or string
1481 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1482 * or 'new' for a new section.
1483 * @param Content $sectionContent New content of the section.
1484 * @param string $sectionTitle New section's subject, only if $section is "new".
1485 * @param string $edittime Revision timestamp or null to use the current revision.
1487 * @throws MWException
1488 * @return Content|null New complete article content, or null if error.
1491 * @deprecated since 1.24, use replaceSectionAtRev instead
1493 public function replaceSectionContent(
1494 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1498 if ( $edittime && $sectionId !== 'new' ) {
1499 $dbr = wfGetDB( DB_SLAVE
);
1500 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1501 // Try the master if this thread may have just added it.
1502 // This could be abstracted into a Revision method, but we don't want
1503 // to encourage loading of revisions by timestamp.
1505 && wfGetLB()->getServerCount() > 1
1506 && wfGetLB()->hasOrMadeRecentMasterChanges()
1508 $dbw = wfGetDB( DB_MASTER
);
1509 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1512 $baseRevId = $rev->getId();
1516 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1520 * @param string|number|null|bool $sectionId Section identifier as a number or string
1521 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1522 * or 'new' for a new section.
1523 * @param Content $sectionContent New content of the section.
1524 * @param string $sectionTitle New section's subject, only if $section is "new".
1525 * @param int|null $baseRevId
1527 * @throws MWException
1528 * @return Content|null New complete article content, or null if error.
1532 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1533 $sectionTitle = '', $baseRevId = null
1536 if ( strval( $sectionId ) === '' ) {
1537 // Whole-page edit; let the whole text through
1538 $newContent = $sectionContent;
1540 if ( !$this->supportsSections() ) {
1541 throw new MWException( "sections not supported for content model " .
1542 $this->getContentHandler()->getModelID() );
1545 // Bug 30711: always use current version when adding a new section
1546 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1547 $oldContent = $this->getContent();
1549 $rev = Revision
::newFromId( $baseRevId );
1551 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1552 $this->getId() . "; section: $sectionId)\n" );
1556 $oldContent = $rev->getContent();
1559 if ( !$oldContent ) {
1560 wfDebug( __METHOD__
. ": no page text\n" );
1564 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1571 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1573 * @return int Updated $flags
1575 public function checkFlags( $flags ) {
1576 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1577 if ( $this->exists() ) {
1578 $flags |
= EDIT_UPDATE
;
1588 * Change an existing article or create a new article. Updates RC and all necessary caches,
1589 * optionally via the deferred update array.
1591 * @param string $text New text
1592 * @param string $summary Edit summary
1593 * @param int $flags Bitfield:
1595 * Article is known or assumed to be non-existent, create a new one
1597 * Article is known or assumed to be pre-existing, update it
1599 * Mark this edit minor, if the user is allowed to do so
1601 * Do not log the change in recentchanges
1603 * Mark the edit a "bot" edit regardless of user rights
1605 * Fill in blank summaries with generated text where possible
1607 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1608 * article will be detected. If EDIT_UPDATE is specified and the article
1609 * doesn't exist, the function will return an edit-gone-missing error. If
1610 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1611 * error will be returned. These two conditions are also possible with
1612 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1614 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1615 * This is not the parent revision ID, rather the revision ID for older
1616 * content used as the source for a rollback, for example.
1617 * @param User $user The user doing the edit
1619 * @throws MWException
1620 * @return Status Possible errors:
1621 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1622 * set the fatal flag of $status
1623 * edit-gone-missing: In update mode, but the article didn't exist.
1624 * edit-conflict: In update mode, the article changed unexpectedly.
1625 * edit-no-change: Warning that the text was the same as before.
1626 * edit-already-exists: In creation mode, but the article already exists.
1628 * Extensions may define additional errors.
1630 * $return->value will contain an associative array with members as follows:
1631 * new: Boolean indicating if the function attempted to create a new article.
1632 * revision: The revision object for the inserted revision, or null.
1634 * Compatibility note: this function previously returned a boolean value
1635 * indicating success/failure
1637 * @deprecated since 1.21: use doEditContent() instead.
1639 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1640 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1642 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1644 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1648 * Change an existing article or create a new article. Updates RC and all necessary caches,
1649 * optionally via the deferred update array.
1651 * @param Content $content New content
1652 * @param string $summary Edit summary
1653 * @param int $flags Bitfield:
1655 * Article is known or assumed to be non-existent, create a new one
1657 * Article is known or assumed to be pre-existing, update it
1659 * Mark this edit minor, if the user is allowed to do so
1661 * Do not log the change in recentchanges
1663 * Mark the edit a "bot" edit regardless of user rights
1665 * Fill in blank summaries with generated text where possible
1667 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1668 * article will be detected. If EDIT_UPDATE is specified and the article
1669 * doesn't exist, the function will return an edit-gone-missing error. If
1670 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1671 * error will be returned. These two conditions are also possible with
1672 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1674 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1675 * This is not the parent revision ID, rather the revision ID for older
1676 * content used as the source for a rollback, for example.
1677 * @param User $user The user doing the edit
1678 * @param string $serialFormat Format for storing the content in the
1681 * @throws MWException
1682 * @return Status Possible errors:
1683 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1684 * set the fatal flag of $status.
1685 * edit-gone-missing: In update mode, but the article didn't exist.
1686 * edit-conflict: In update mode, the article changed unexpectedly.
1687 * edit-no-change: Warning that the text was the same as before.
1688 * edit-already-exists: In creation mode, but the article already exists.
1690 * Extensions may define additional errors.
1692 * $return->value will contain an associative array with members as follows:
1693 * new: Boolean indicating if the function attempted to create a new article.
1694 * revision: The revision object for the inserted revision, or null.
1697 * @throws MWException
1699 public function doEditContent( Content
$content, $summary, $flags = 0, $baseRevId = false,
1700 User
$user = null, $serialFormat = null
1702 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1704 // Low-level sanity check
1705 if ( $this->mTitle
->getText() === '' ) {
1706 throw new MWException( 'Something is trying to edit an article with an empty title' );
1709 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1710 return Status
::newFatal( 'content-not-allowed-here',
1711 ContentHandler
::getLocalizedName( $content->getModel() ),
1712 $this->getTitle()->getPrefixedText() );
1715 $user = is_null( $user ) ?
$wgUser : $user;
1716 $status = Status
::newGood( array() );
1718 // Load the data from the master database if needed.
1719 // The caller may already loaded it from the master or even loaded it using
1720 // SELECT FOR UPDATE, so do not override that using clear().
1721 $this->loadPageData( 'fromdbmaster' );
1723 $flags = $this->checkFlags( $flags );
1726 $hook_args = array( &$this, &$user, &$content, &$summary,
1727 $flags & EDIT_MINOR
, null, null, &$flags, &$status );
1729 if ( !Hooks
::run( 'PageContentSave', $hook_args )
1730 ||
!ContentHandler
::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1732 wfDebug( __METHOD__
. ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1734 if ( $status->isOK() ) {
1735 $status->fatal( 'edit-hook-aborted' );
1741 // Silently ignore EDIT_MINOR if not allowed
1742 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1743 $bot = $flags & EDIT_FORCE_BOT
;
1745 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1747 $oldsize = $old_content ?
$old_content->getSize() : 0;
1748 $oldid = $this->getLatest();
1749 $oldIsRedirect = $this->isRedirect();
1750 $oldcountable = $this->isCountable();
1752 $handler = $content->getContentHandler();
1754 // Provide autosummaries if one is not provided and autosummaries are enabled.
1755 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1756 if ( !$old_content ) {
1757 $old_content = null;
1759 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1762 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1763 $serialized = $editInfo->pst
;
1766 * @var Content $content
1768 $content = $editInfo->pstContent
;
1769 $newsize = $content->getSize();
1771 $dbw = wfGetDB( DB_MASTER
);
1772 $now = wfTimestampNow();
1774 if ( $flags & EDIT_UPDATE
) {
1775 // Update article, but only if changed.
1776 $status->value
['new'] = false;
1779 // Article gone missing
1780 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
1781 $status->fatal( 'edit-gone-missing' );
1784 } elseif ( !$old_content ) {
1785 // Sanity check for bug 37225
1786 throw new MWException( "Could not find text for current revision {$oldid}." );
1789 $revision = new Revision( array(
1790 'page' => $this->getId(),
1791 'title' => $this->getTitle(), // for determining the default content model
1792 'comment' => $summary,
1793 'minor_edit' => $isminor,
1794 'text' => $serialized,
1796 'parent_id' => $oldid,
1797 'user' => $user->getId(),
1798 'user_text' => $user->getName(),
1799 'timestamp' => $now,
1800 'content_model' => $content->getModel(),
1801 'content_format' => $serialFormat,
1802 ) ); // XXX: pass content object?!
1804 $changed = !$content->equals( $old_content );
1807 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1808 $status->merge( $prepStatus );
1810 if ( !$status->isOK() ) {
1814 $dbw->begin( __METHOD__
);
1815 // Get the latest page_latest value while locking it.
1816 // Do a CAS style check to see if it's the same as when this method
1817 // started. If it changed then bail out before touching the DB.
1818 $latestNow = $this->lock();
1819 if ( $latestNow != $oldid ) {
1820 $dbw->commit( __METHOD__
);
1821 // Page updated or deleted in the mean time
1822 $status->fatal( 'edit-conflict' );
1827 // At this point we are now comitted to returning an OK
1828 // status unless some DB query error or other exception comes up.
1829 // This way callers don't have to call rollback() if $status is bad
1830 // unless they actually try to catch exceptions (which is rare).
1832 $revisionId = $revision->insertOn( $dbw );
1834 // Update page_latest and friends to reflect the new revision
1835 if ( !$this->updateRevisionOn( $dbw, $revision, null, $oldIsRedirect ) ) {
1836 $dbw->rollback( __METHOD__
);
1837 throw new MWException( "Failed to update page row to use new revision." );
1840 Hooks
::run( 'NewRevisionFromEditComplete',
1841 array( $this, $revision, $baseRevId, $user ) );
1843 // Update recentchanges
1844 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1845 // Mark as patrolled if the user can do so
1846 $patrolled = $wgUseRCPatrol && !count(
1847 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1848 // Add RC row to the DB
1849 RecentChange
::notifyEdit(
1850 $now, $this->mTitle
, $isminor, $user, $summary,
1851 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1852 $revisionId, $patrolled
1856 $user->incEditCount();
1858 $dbw->commit( __METHOD__
);
1859 $this->mTimestamp
= $now;
1861 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1862 // related variables correctly
1863 $revision->setId( $this->getLatest() );
1866 // Update links tables, site stats, etc.
1867 $this->doEditUpdates(
1871 'changed' => $changed,
1872 'oldcountable' => $oldcountable
1877 $status->warning( 'edit-no-change' );
1879 // Update page_touched, this is usually implicit in the page update
1880 // Other cache updates are done in onArticleEdit()
1881 $this->mTitle
->invalidateCache( $now );
1884 // Create new article
1885 $status->value
['new'] = true;
1887 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1888 $status->merge( $prepStatus );
1889 if ( !$status->isOK() ) {
1893 $dbw->begin( __METHOD__
);
1895 // Add the page record unless one already exists for the title
1896 $newid = $this->insertOn( $dbw );
1897 if ( $newid === false ) {
1898 $dbw->commit( __METHOD__
); // nothing inserted
1899 $status->fatal( 'edit-already-exists' );
1901 return $status; // nothing done
1904 // At this point we are now comitted to returning an OK
1905 // status unless some DB query error or other exception comes up.
1906 // This way callers don't have to call rollback() if $status is bad
1907 // unless they actually try to catch exceptions (which is rare).
1909 // Save the revision text...
1910 $revision = new Revision( array(
1912 'title' => $this->getTitle(), // for determining the default content model
1913 'comment' => $summary,
1914 'minor_edit' => $isminor,
1915 'text' => $serialized,
1917 'user' => $user->getId(),
1918 'user_text' => $user->getName(),
1919 'timestamp' => $now,
1920 'content_model' => $content->getModel(),
1921 'content_format' => $serialFormat,
1923 $revisionId = $revision->insertOn( $dbw );
1925 // Bug 37225: use accessor to get the text as Revision may trim it
1926 $content = $revision->getContent(); // sanity; get normalized version
1929 $newsize = $content->getSize();
1932 // Update the page record with revision data
1933 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1934 $dbw->rollback( __METHOD__
);
1935 throw new MWException( "Failed to update page row to use new revision." );
1938 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1940 // Update recentchanges
1941 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1942 // Mark as patrolled if the user can do so
1943 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
1944 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1945 // Add RC row to the DB
1946 RecentChange
::notifyNew(
1947 $now, $this->mTitle
, $isminor, $user, $summary, $bot,
1948 '', $newsize, $revisionId, $patrolled
1952 $user->incEditCount();
1954 $dbw->commit( __METHOD__
);
1955 $this->mTimestamp
= $now;
1957 // Update links, etc.
1958 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1960 $hook_args = array( &$this, &$user, $content, $summary,
1961 $flags & EDIT_MINOR
, null, null, &$flags, $revision );
1963 ContentHandler
::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1964 Hooks
::run( 'PageContentInsertComplete', $hook_args );
1967 // Return the new revision (or null) to the caller
1968 $status->value
['revision'] = $revision;
1970 $hook_args = array( &$this, &$user, $content, $summary,
1971 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId );
1973 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1974 Hooks
::run( 'PageContentSaveComplete', $hook_args );
1976 // Promote user to any groups they meet the criteria for
1977 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1978 $user->addAutopromoteOnceGroups( 'onEdit' );
1979 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1986 * Get parser options suitable for rendering the primary article wikitext
1988 * @see ContentHandler::makeParserOptions
1990 * @param IContextSource|User|string $context One of the following:
1991 * - IContextSource: Use the User and the Language of the provided
1993 * - User: Use the provided User object and $wgLang for the language,
1994 * so use an IContextSource object if possible.
1995 * - 'canonical': Canonical options (anonymous user with default
1996 * preferences and content language).
1997 * @return ParserOptions
1999 public function makeParserOptions( $context ) {
2000 $options = $this->getContentHandler()->makeParserOptions( $context );
2002 if ( $this->getTitle()->isConversionTable() ) {
2003 // @todo ConversionTable should become a separate content model, so
2004 // we don't need special cases like this one.
2005 $options->disableContentConversion();
2012 * Prepare text which is about to be saved.
2013 * Returns a stdClass with source, pst and output members
2015 * @deprecated since 1.21: use prepareContentForEdit instead.
2018 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
2019 ContentHandler
::deprecated( __METHOD__
, '1.21' );
2020 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2021 return $this->prepareContentForEdit( $content, $revid, $user );
2025 * Prepare content which is about to be saved.
2026 * Returns a stdClass with source, pst and output members
2028 * @param Content $content
2029 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2030 * revision ID is also accepted, but this is deprecated.
2031 * @param User|null $user
2032 * @param string|null $serialFormat
2033 * @param bool $useCache Check shared prepared edit cache
2039 public function prepareContentForEdit(
2040 Content
$content, $revision = null, User
$user = null,
2041 $serialFormat = null, $useCache = true
2043 global $wgContLang, $wgUser, $wgAjaxEditStash;
2045 if ( is_object( $revision ) ) {
2046 $revid = $revision->getId();
2049 // This code path is deprecated, and nothing is known to
2050 // use it, so performance here shouldn't be a worry.
2051 if ( $revid !== null ) {
2052 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
2058 $user = is_null( $user ) ?
$wgUser : $user;
2059 // XXX: check $user->getId() here???
2061 // Use a sane default for $serialFormat, see bug 57026
2062 if ( $serialFormat === null ) {
2063 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2066 if ( $this->mPreparedEdit
2067 && $this->mPreparedEdit
->newContent
2068 && $this->mPreparedEdit
->newContent
->equals( $content )
2069 && $this->mPreparedEdit
->revid
== $revid
2070 && $this->mPreparedEdit
->format
== $serialFormat
2071 // XXX: also check $user here?
2074 return $this->mPreparedEdit
;
2077 // The edit may have already been prepared via api.php?action=stashedit
2078 $cachedEdit = $useCache && $wgAjaxEditStash && !$user->isAllowed( 'bot' )
2079 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2082 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2083 Hooks
::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2085 $edit = (object)array();
2086 if ( $cachedEdit ) {
2087 $edit->timestamp
= $cachedEdit->timestamp
;
2089 $edit->timestamp
= wfTimestampNow();
2091 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2092 $edit->revid
= $revid;
2094 if ( $cachedEdit ) {
2095 $edit->pstContent
= $cachedEdit->pstContent
;
2097 $edit->pstContent
= $content
2098 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2102 $edit->format
= $serialFormat;
2103 $edit->popts
= $this->makeParserOptions( 'canonical' );
2104 if ( $cachedEdit ) {
2105 $edit->output
= $cachedEdit->output
;
2108 // We get here if vary-revision is set. This means that this page references
2109 // itself (such as via self-transclusion). In this case, we need to make sure
2110 // that any such self-references refer to the newly-saved revision, and not
2111 // to the previous one, which could otherwise happen due to slave lag.
2112 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2113 $edit->popts
->setCurrentRevisionCallback(
2114 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2115 if ( $title->equals( $revision->getTitle() ) ) {
2118 return call_user_func( $oldCallback, $title, $parser );
2123 $edit->output
= $edit->pstContent
2124 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2128 $edit->newContent
= $content;
2129 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2131 // NOTE: B/C for hooks! don't use these fields!
2132 $edit->newText
= $edit->newContent
2133 ? ContentHandler
::getContentText( $edit->newContent
)
2135 $edit->oldText
= $edit->oldContent
2136 ? ContentHandler
::getContentText( $edit->oldContent
)
2138 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2140 $this->mPreparedEdit
= $edit;
2145 * Do standard deferred updates after page edit.
2146 * Update links tables, site stats, search index and message cache.
2147 * Purges pages that include this page if the text was changed here.
2148 * Every 100th edit, prune the recent changes table.
2150 * @param Revision $revision
2151 * @param User $user User object that did the revision
2152 * @param array $options Array of options, following indexes are used:
2153 * - changed: boolean, whether the revision changed the content (default true)
2154 * - created: boolean, whether the revision created the page (default false)
2155 * - moved: boolean, whether the page was moved (default false)
2156 * - oldcountable: boolean, null, or string 'no-change' (default null):
2157 * - boolean: whether the page was counted as an article before that
2158 * revision, only used in changed is true and created is false
2159 * - null: if created is false, don't update the article count; if created
2160 * is true, do update the article count
2161 * - 'no-change': don't update the article count, ever
2163 public function doEditUpdates( Revision
$revision, User
$user, array $options = array() ) {
2168 'oldcountable' => null
2170 $content = $revision->getContent();
2173 // Be careful not to do pre-save transform twice: $text is usually
2174 // already pre-save transformed once.
2175 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2176 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
2177 $editInfo = $this->prepareContentForEdit( $content, $revision, $user );
2179 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
2180 $editInfo = $this->mPreparedEdit
;
2183 // Save it to the parser cache.
2184 // Make sure the cache time matches page_touched to avoid double parsing.
2185 ParserCache
::singleton()->save(
2186 $editInfo->output
, $this, $editInfo->popts
,
2187 $revision->getTimestamp(), $editInfo->revid
2190 // Update the links tables and other secondary data
2192 $recursive = $options['changed']; // bug 50785
2193 $updates = $content->getSecondaryDataUpdates(
2194 $this->getTitle(), null, $recursive, $editInfo->output
);
2195 foreach ( $updates as $update ) {
2196 if ( $update instanceof LinksUpdate
) {
2197 $update->setRevision( $revision );
2198 $update->setTriggeringUser( $user );
2200 DeferredUpdates
::addUpdate( $update );
2204 Hooks
::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2206 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2207 // Flush old entries from the `recentchanges` table
2208 if ( mt_rand( 0, 9 ) == 0 ) {
2209 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2213 if ( !$this->exists() ) {
2217 $id = $this->getId();
2218 $title = $this->mTitle
->getPrefixedDBkey();
2219 $shortTitle = $this->mTitle
->getDBkey();
2221 if ( $options['oldcountable'] === 'no-change' ||
2222 ( !$options['changed'] && !$options['moved'] )
2225 } elseif ( $options['created'] ) {
2226 $good = (int)$this->isCountable( $editInfo );
2227 } elseif ( $options['oldcountable'] !== null ) {
2228 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2232 $edits = $options['changed'] ?
1 : 0;
2233 $total = $options['created'] ?
1 : 0;
2235 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2236 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2238 // If this is another user's talk page, update newtalk.
2239 // Don't do this if $options['changed'] = false (null-edits) nor if
2240 // it's a minor edit and the user doesn't want notifications for those.
2241 if ( $options['changed']
2242 && $this->mTitle
->getNamespace() == NS_USER_TALK
2243 && $shortTitle != $user->getTitleKey()
2244 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2246 $recipient = User
::newFromName( $shortTitle, false );
2247 if ( !$recipient ) {
2248 wfDebug( __METHOD__
. ": invalid username\n" );
2250 // Allow extensions to prevent user notification
2251 // when a new message is added to their talk page
2252 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2253 if ( User
::isIP( $shortTitle ) ) {
2254 // An anonymous user
2255 $recipient->setNewtalk( true, $revision );
2256 } elseif ( $recipient->isLoggedIn() ) {
2257 $recipient->setNewtalk( true, $revision );
2259 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2265 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2266 // XXX: could skip pseudo-messages like js/css here, based on content model.
2267 $msgtext = $content ?
$content->getWikitextForTransclusion() : null;
2268 if ( $msgtext === false ||
$msgtext === null ) {
2272 MessageCache
::singleton()->replace( $shortTitle, $msgtext );
2275 if ( $options['created'] ) {
2276 self
::onArticleCreate( $this->mTitle
);
2277 } elseif ( $options['changed'] ) { // bug 50785
2278 self
::onArticleEdit( $this->mTitle
, $revision );
2283 * Edit an article without doing all that other stuff
2284 * The article must already exist; link tables etc
2285 * are not updated, caches are not flushed.
2287 * @param Content $content Content submitted
2288 * @param User $user The relevant user
2289 * @param string $comment Comment submitted
2290 * @param bool $minor Whereas it's a minor modification
2291 * @param string $serialFormat Format for storing the content in the database
2293 public function doQuickEditContent(
2294 Content
$content, User
$user, $comment = '', $minor = false, $serialFormat = null
2297 $serialized = $content->serialize( $serialFormat );
2299 $dbw = wfGetDB( DB_MASTER
);
2300 $revision = new Revision( array(
2301 'title' => $this->getTitle(), // for determining the default content model
2302 'page' => $this->getId(),
2303 'user_text' => $user->getName(),
2304 'user' => $user->getId(),
2305 'text' => $serialized,
2306 'length' => $content->getSize(),
2307 'comment' => $comment,
2308 'minor_edit' => $minor ?
1 : 0,
2309 ) ); // XXX: set the content object?
2310 $revision->insertOn( $dbw );
2311 $this->updateRevisionOn( $dbw, $revision );
2313 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2318 * Update the article's restriction field, and leave a log entry.
2319 * This works for protection both existing and non-existing pages.
2321 * @param array $limit Set of restriction keys
2322 * @param array $expiry Per restriction type expiration
2323 * @param int &$cascade Set to false if cascading protection isn't allowed.
2324 * @param string $reason
2325 * @param User $user The user updating the restrictions
2328 public function doUpdateRestrictions( array $limit, array $expiry,
2329 &$cascade, $reason, User
$user
2331 global $wgCascadingRestrictionLevels, $wgContLang;
2333 if ( wfReadOnly() ) {
2334 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
2337 $this->loadPageData( 'fromdbmaster' );
2338 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2339 $id = $this->getId();
2345 // Take this opportunity to purge out expired restrictions
2346 Title
::purgeExpiredRestrictions();
2348 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2349 // we expect a single selection, but the schema allows otherwise.
2350 $isProtected = false;
2354 $dbw = wfGetDB( DB_MASTER
);
2356 foreach ( $restrictionTypes as $action ) {
2357 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2358 $expiry[$action] = 'infinity';
2360 if ( !isset( $limit[$action] ) ) {
2361 $limit[$action] = '';
2362 } elseif ( $limit[$action] != '' ) {
2366 // Get current restrictions on $action
2367 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2368 if ( $current != '' ) {
2369 $isProtected = true;
2372 if ( $limit[$action] != $current ) {
2374 } elseif ( $limit[$action] != '' ) {
2375 // Only check expiry change if the action is actually being
2376 // protected, since expiry does nothing on an not-protected
2378 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2384 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2388 // If nothing has changed, do nothing
2390 return Status
::newGood();
2393 if ( !$protect ) { // No protection at all means unprotection
2394 $revCommentMsg = 'unprotectedarticle';
2395 $logAction = 'unprotect';
2396 } elseif ( $isProtected ) {
2397 $revCommentMsg = 'modifiedarticleprotection';
2398 $logAction = 'modify';
2400 $revCommentMsg = 'protectedarticle';
2401 $logAction = 'protect';
2404 // Truncate for whole multibyte characters
2405 $reason = $wgContLang->truncate( $reason, 255 );
2407 $logRelationsValues = array();
2408 $logRelationsField = null;
2409 $logParamsDetails = array();
2411 if ( $id ) { // Protection of existing page
2412 if ( !Hooks
::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2413 return Status
::newGood();
2416 // Only certain restrictions can cascade...
2417 $editrestriction = isset( $limit['edit'] )
2418 ?
array( $limit['edit'] )
2419 : $this->mTitle
->getRestrictions( 'edit' );
2420 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2421 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2423 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2424 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2427 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2428 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2429 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2431 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2432 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2435 // The schema allows multiple restrictions
2436 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2440 // insert null revision to identify the page protection change as edit summary
2441 $latest = $this->getLatest();
2442 $nullRevision = $this->insertProtectNullRevision(
2451 if ( $nullRevision === null ) {
2452 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2455 $logRelationsField = 'pr_id';
2457 // Update restrictions table
2458 foreach ( $limit as $action => $restrictions ) {
2460 'page_restrictions',
2463 'pr_type' => $action
2467 if ( $restrictions != '' ) {
2468 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2470 'page_restrictions',
2472 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2474 'pr_type' => $action,
2475 'pr_level' => $restrictions,
2476 'pr_cascade' => $cascadeValue,
2477 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2481 $logRelationsValues[] = $dbw->insertId();
2482 $logParamsDetails[] = array(
2484 'level' => $restrictions,
2485 'expiry' => $expiry[$action],
2486 'cascade' => (bool)$cascadeValue,
2491 // Clear out legacy restriction fields
2494 array( 'page_restrictions' => '' ),
2495 array( 'page_id' => $id ),
2499 Hooks
::run( 'NewRevisionFromEditComplete',
2500 array( $this, $nullRevision, $latest, $user ) );
2501 Hooks
::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2502 } else { // Protection of non-existing page (also known as "title protection")
2503 // Cascade protection is meaningless in this case
2506 if ( $limit['create'] != '' ) {
2507 $dbw->replace( 'protected_titles',
2508 array( array( 'pt_namespace', 'pt_title' ) ),
2510 'pt_namespace' => $this->mTitle
->getNamespace(),
2511 'pt_title' => $this->mTitle
->getDBkey(),
2512 'pt_create_perm' => $limit['create'],
2513 'pt_timestamp' => $dbw->timestamp(),
2514 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2515 'pt_user' => $user->getId(),
2516 'pt_reason' => $reason,
2519 $logParamsDetails[] = array(
2521 'level' => $limit['create'],
2522 'expiry' => $expiry['create'],
2525 $dbw->delete( 'protected_titles',
2527 'pt_namespace' => $this->mTitle
->getNamespace(),
2528 'pt_title' => $this->mTitle
->getDBkey()
2534 $this->mTitle
->flushRestrictions();
2535 InfoAction
::invalidateCache( $this->mTitle
);
2537 if ( $logAction == 'unprotect' ) {
2540 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2542 '4::description' => $protectDescriptionLog, // parameter for IRC
2543 '5:bool:cascade' => $cascade,
2544 'details' => $logParamsDetails, // parameter for localize and api
2548 // Update the protection log
2549 $logEntry = new ManualLogEntry( 'protect', $logAction );
2550 $logEntry->setTarget( $this->mTitle
);
2551 $logEntry->setComment( $reason );
2552 $logEntry->setPerformer( $user );
2553 $logEntry->setParameters( $params );
2554 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2555 $logEntry->setRelations( array( $logRelationsField => $logRelationsValues ) );
2557 $logId = $logEntry->insert();
2558 $logEntry->publish( $logId );
2560 return Status
::newGood();
2564 * Insert a new null revision for this page.
2566 * @param string $revCommentMsg Comment message key for the revision
2567 * @param array $limit Set of restriction keys
2568 * @param array $expiry Per restriction type expiration
2569 * @param int $cascade Set to false if cascading protection isn't allowed.
2570 * @param string $reason
2571 * @param User|null $user
2572 * @return Revision|null Null on error
2574 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2575 array $expiry, $cascade, $reason, $user = null
2578 $dbw = wfGetDB( DB_MASTER
);
2580 // Prepare a null revision to be added to the history
2581 $editComment = $wgContLang->ucfirst(
2584 $this->mTitle
->getPrefixedText()
2585 )->inContentLanguage()->text()
2588 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2590 $protectDescription = $this->protectDescription( $limit, $expiry );
2591 if ( $protectDescription ) {
2592 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2593 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2594 ->inContentLanguage()->text();
2597 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2598 $editComment .= wfMessage( 'brackets' )->params(
2599 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2600 )->inContentLanguage()->text();
2603 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2605 $nullRev->insertOn( $dbw );
2607 // Update page record and touch page
2608 $oldLatest = $nullRev->getParentId();
2609 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2616 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2619 protected function formatExpiry( $expiry ) {
2622 if ( $expiry != 'infinity' ) {
2625 $wgContLang->timeanddate( $expiry, false, false ),
2626 $wgContLang->date( $expiry, false, false ),
2627 $wgContLang->time( $expiry, false, false )
2628 )->inContentLanguage()->text();
2630 return wfMessage( 'protect-expiry-indefinite' )
2631 ->inContentLanguage()->text();
2636 * Builds the description to serve as comment for the edit.
2638 * @param array $limit Set of restriction keys
2639 * @param array $expiry Per restriction type expiration
2642 public function protectDescription( array $limit, array $expiry ) {
2643 $protectDescription = '';
2645 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2646 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2647 # All possible message keys are listed here for easier grepping:
2648 # * restriction-create
2649 # * restriction-edit
2650 # * restriction-move
2651 # * restriction-upload
2652 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2653 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2654 # with '' filtered out. All possible message keys are listed below:
2655 # * protect-level-autoconfirmed
2656 # * protect-level-sysop
2657 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2658 ->inContentLanguage()->text();
2660 $expiryText = $this->formatExpiry( $expiry[$action] );
2662 if ( $protectDescription !== '' ) {
2663 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2665 $protectDescription .= wfMessage( 'protect-summary-desc' )
2666 ->params( $actionText, $restrictionsText, $expiryText )
2667 ->inContentLanguage()->text();
2670 return $protectDescription;
2674 * Builds the description to serve as comment for the log entry.
2676 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2677 * protect description text. Keep them in old format to avoid breaking compatibility.
2678 * TODO: Fix protection log to store structured description and format it on-the-fly.
2680 * @param array $limit Set of restriction keys
2681 * @param array $expiry Per restriction type expiration
2684 public function protectDescriptionLog( array $limit, array $expiry ) {
2687 $protectDescriptionLog = '';
2689 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2690 $expiryText = $this->formatExpiry( $expiry[$action] );
2691 $protectDescriptionLog .= $wgContLang->getDirMark() .
2692 "[$action=$restrictions] ($expiryText)";
2695 return trim( $protectDescriptionLog );
2699 * Take an array of page restrictions and flatten it to a string
2700 * suitable for insertion into the page_restrictions field.
2702 * @param string[] $limit
2704 * @throws MWException
2707 protected static function flattenRestrictions( $limit ) {
2708 if ( !is_array( $limit ) ) {
2709 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2715 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2716 $bits[] = "$action=$restrictions";
2719 return implode( ':', $bits );
2723 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2724 * backwards compatibility, if you care about error reporting you should use
2725 * doDeleteArticleReal() instead.
2727 * Deletes the article with database consistency, writes logs, purges caches
2729 * @param string $reason Delete reason for deletion log
2730 * @param bool $suppress Suppress all revisions and log the deletion in
2731 * the suppression log instead of the deletion log
2732 * @param int $u1 Unused
2733 * @param bool $u2 Unused
2734 * @param array|string &$error Array of errors to append to
2735 * @param User $user The deleting user
2736 * @return bool True if successful
2738 public function doDeleteArticle(
2739 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2741 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2742 return $status->isGood();
2746 * Back-end article deletion
2747 * Deletes the article with database consistency, writes logs, purges caches
2751 * @param string $reason Delete reason for deletion log
2752 * @param bool $suppress Suppress all revisions and log the deletion in
2753 * the suppression log instead of the deletion log
2754 * @param int $u1 Unused
2755 * @param bool $u2 Unused
2756 * @param array|string &$error Array of errors to append to
2757 * @param User $user The deleting user
2758 * @return Status Status object; if successful, $status->value is the log_id of the
2759 * deletion log entry. If the page couldn't be deleted because it wasn't
2760 * found, $status is a non-fatal 'cannotdelete' error
2762 public function doDeleteArticleReal(
2763 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2765 global $wgUser, $wgContentHandlerUseDB;
2767 wfDebug( __METHOD__
. "\n" );
2769 $status = Status
::newGood();
2771 if ( $this->mTitle
->getDBkey() === '' ) {
2772 $status->error( 'cannotdelete',
2773 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2777 $user = is_null( $user ) ?
$wgUser : $user;
2778 if ( !Hooks
::run( 'ArticleDelete',
2779 array( &$this, &$user, &$reason, &$error, &$status, $suppress )
2781 if ( $status->isOK() ) {
2782 // Hook aborted but didn't set a fatal status
2783 $status->fatal( 'delete-hook-aborted' );
2788 $dbw = wfGetDB( DB_MASTER
);
2789 $dbw->startAtomic( __METHOD__
);
2791 $this->loadPageData( self
::READ_LATEST
);
2792 $id = $this->getID();
2793 // T98706: lock the page from various other updates but avoid using
2794 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2795 // the revisions queries (which also JOIN on user). Only lock the page
2796 // row and CAS check on page_latest to see if the trx snapshot matches.
2797 $lockedLatest = $this->lock();
2798 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2799 $dbw->endAtomic( __METHOD__
);
2800 // Page not there or trx snapshot is stale
2801 $status->error( 'cannotdelete',
2802 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2806 // At this point we are now comitted to returning an OK
2807 // status unless some DB query error or other exception comes up.
2808 // This way callers don't have to call rollback() if $status is bad
2809 // unless they actually try to catch exceptions (which is rare).
2811 // we need to remember the old content so we can use it to generate all deletion updates.
2812 $content = $this->getContent( Revision
::RAW
);
2814 // Bitfields to further suppress the content
2817 // This should be 15...
2818 $bitfield |
= Revision
::DELETED_TEXT
;
2819 $bitfield |
= Revision
::DELETED_COMMENT
;
2820 $bitfield |
= Revision
::DELETED_USER
;
2821 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2823 $bitfield = 'rev_deleted';
2827 * For now, shunt the revision data into the archive table.
2828 * Text is *not* removed from the text table; bulk storage
2829 * is left intact to avoid breaking block-compression or
2830 * immutable storage schemes.
2832 * For backwards compatibility, note that some older archive
2833 * table entries will have ar_text and ar_flags fields still.
2835 * In the future, we may keep revisions and mark them with
2836 * the rev_deleted field, which is reserved for this purpose.
2840 'ar_namespace' => 'page_namespace',
2841 'ar_title' => 'page_title',
2842 'ar_comment' => 'rev_comment',
2843 'ar_user' => 'rev_user',
2844 'ar_user_text' => 'rev_user_text',
2845 'ar_timestamp' => 'rev_timestamp',
2846 'ar_minor_edit' => 'rev_minor_edit',
2847 'ar_rev_id' => 'rev_id',
2848 'ar_parent_id' => 'rev_parent_id',
2849 'ar_text_id' => 'rev_text_id',
2850 'ar_text' => '\'\'', // Be explicit to appease
2851 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2852 'ar_len' => 'rev_len',
2853 'ar_page_id' => 'page_id',
2854 'ar_deleted' => $bitfield,
2855 'ar_sha1' => 'rev_sha1',
2858 if ( $wgContentHandlerUseDB ) {
2859 $row['ar_content_model'] = 'rev_content_model';
2860 $row['ar_content_format'] = 'rev_content_format';
2863 // Copy all the page revisions into the archive table
2866 array( 'page', 'revision' ),
2870 'page_id = rev_page'
2875 // Now that it's safely backed up, delete it
2876 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2878 if ( !$dbw->cascadingDeletes() ) {
2879 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
2882 // Clone the title, so we have the information we need when we log
2883 $logTitle = clone $this->mTitle
;
2885 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2886 $logtype = $suppress ?
'suppress' : 'delete';
2888 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2889 $logEntry->setPerformer( $user );
2890 $logEntry->setTarget( $logTitle );
2891 $logEntry->setComment( $reason );
2892 $logid = $logEntry->insert();
2894 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2895 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2896 $logEntry->publish( $logid );
2899 $dbw->endAtomic( __METHOD__
);
2901 $this->doDeleteUpdates( $id, $content );
2903 Hooks
::run( 'ArticleDeleteComplete',
2904 array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2905 $status->value
= $logid;
2907 // Show log excerpt on 404 pages rather than just a link
2908 $cache = ObjectCache
::getMainStashInstance();
2909 $key = wfMemcKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2910 $cache->set( $key, 1, $cache::TTL_DAY
);
2916 * Lock the page row for this title+id and return page_latest (or 0)
2918 * @return integer Returns 0 if no row was found with this title+id
2920 protected function lock() {
2921 return (int)wfGetDB( DB_MASTER
)->selectField(
2925 'page_id' => $this->getId(),
2926 // Typically page_id is enough, but some code might try to do
2927 // updates assuming the title is the same, so verify that
2928 'page_namespace' => $this->getTitle()->getNamespace(),
2929 'page_title' => $this->getTitle()->getDBkey()
2932 array( 'FOR UPDATE' )
2937 * Do some database updates after deletion
2939 * @param int $id The page_id value of the page being deleted
2940 * @param Content $content Optional page content to be used when determining
2941 * the required updates. This may be needed because $this->getContent()
2942 * may already return null when the page proper was deleted.
2944 public function doDeleteUpdates( $id, Content
$content = null ) {
2945 // Update site status
2946 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2948 // Delete pagelinks, update secondary indexes, etc
2949 $updates = $this->getDeletionUpdates( $content );
2950 foreach ( $updates as $update ) {
2951 DeferredUpdates
::addUpdate( $update );
2954 // Reparse any pages transcluding this page
2955 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
2957 // Reparse any pages including this image
2958 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
2959 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
2963 WikiPage
::onArticleDelete( $this->mTitle
);
2965 // Reset this object and the Title object
2966 $this->loadFromRow( false, self
::READ_LATEST
);
2969 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
2973 * Roll back the most recent consecutive set of edits to a page
2974 * from the same user; fails if there are no eligible edits to
2975 * roll back to, e.g. user is the sole contributor. This function
2976 * performs permissions checks on $user, then calls commitRollback()
2977 * to do the dirty work
2979 * @todo Separate the business/permission stuff out from backend code
2981 * @param string $fromP Name of the user whose edits to rollback.
2982 * @param string $summary Custom summary. Set to default summary if empty.
2983 * @param string $token Rollback token.
2984 * @param bool $bot If true, mark all reverted edits as bot.
2986 * @param array $resultDetails Array contains result-specific array of additional values
2987 * 'alreadyrolled' : 'current' (rev)
2988 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2990 * @param User $user The user performing the rollback
2991 * @return array Array of errors, each error formatted as
2992 * array(messagekey, param1, param2, ...).
2993 * On success, the array is empty. This array can also be passed to
2994 * OutputPage::showPermissionsErrorPage().
2996 public function doRollback(
2997 $fromP, $summary, $token, $bot, &$resultDetails, User
$user
2999 $resultDetails = null;
3001 // Check permissions
3002 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3003 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3004 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3006 if ( !$user->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3007 $errors[] = array( 'sessionfailure' );
3010 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3011 $errors[] = array( 'actionthrottledtext' );
3014 // If there were errors, bail out now
3015 if ( !empty( $errors ) ) {
3019 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
3023 * Backend implementation of doRollback(), please refer there for parameter
3024 * and return value documentation
3026 * NOTE: This function does NOT check ANY permissions, it just commits the
3027 * rollback to the DB. Therefore, you should only call this function direct-
3028 * ly if you want to use custom permissions checks. If you don't, use
3029 * doRollback() instead.
3030 * @param string $fromP Name of the user whose edits to rollback.
3031 * @param string $summary Custom summary. Set to default summary if empty.
3032 * @param bool $bot If true, mark all reverted edits as bot.
3034 * @param array $resultDetails Contains result-specific array of additional values
3035 * @param User $guser The user performing the rollback
3038 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser ) {
3039 global $wgUseRCPatrol, $wgContLang;
3041 $dbw = wfGetDB( DB_MASTER
);
3043 if ( wfReadOnly() ) {
3044 return array( array( 'readonlytext' ) );
3047 // Get the last editor
3048 $current = $this->getRevision();
3049 if ( is_null( $current ) ) {
3050 // Something wrong... no page?
3051 return array( array( 'notanarticle' ) );
3054 $from = str_replace( '_', ' ', $fromP );
3055 // User name given should match up with the top revision.
3056 // If the user was deleted then $from should be empty.
3057 if ( $from != $current->getUserText() ) {
3058 $resultDetails = array( 'current' => $current );
3059 return array( array( 'alreadyrolled',
3060 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3061 htmlspecialchars( $fromP ),
3062 htmlspecialchars( $current->getUserText() )
3066 // Get the last edit not by this person...
3067 // Note: these may not be public values
3068 $user = intval( $current->getUser( Revision
::RAW
) );
3069 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3070 $s = $dbw->selectRow( 'revision',
3071 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3072 array( 'rev_page' => $current->getPage(),
3073 "rev_user != {$user} OR rev_user_text != {$user_text}"
3075 array( 'USE INDEX' => 'page_timestamp',
3076 'ORDER BY' => 'rev_timestamp DESC' )
3078 if ( $s === false ) {
3079 // No one else ever edited this page
3080 return array( array( 'cantrollback' ) );
3081 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3082 ||
$s->rev_deleted
& Revision
::DELETED_USER
3084 // Only admins can see this text
3085 return array( array( 'notvisiblerev' ) );
3088 // Generate the edit summary if necessary
3089 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3090 if ( empty( $summary ) ) {
3091 if ( $from == '' ) { // no public user name
3092 $summary = wfMessage( 'revertpage-nouser' );
3094 $summary = wfMessage( 'revertpage' );
3098 // Allow the custom summary to use the same args as the default message
3100 $target->getUserText(), $from, $s->rev_id
,
3101 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3102 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3104 if ( $summary instanceof Message
) {
3105 $summary = $summary->params( $args )->inContentLanguage()->text();
3107 $summary = wfMsgReplaceArgs( $summary, $args );
3110 // Trim spaces on user supplied text
3111 $summary = trim( $summary );
3113 // Truncate for whole multibyte characters.
3114 $summary = $wgContLang->truncate( $summary, 255 );
3117 $flags = EDIT_UPDATE
;
3119 if ( $guser->isAllowed( 'minoredit' ) ) {
3120 $flags |
= EDIT_MINOR
;
3123 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3124 $flags |
= EDIT_FORCE_BOT
;
3127 // Actually store the edit
3128 $status = $this->doEditContent(
3129 $target->getContent(),
3136 // Set patrolling and bot flag on the edits, which gets rollbacked.
3137 // This is done even on edit failure to have patrolling in that case (bug 62157).
3139 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3140 // Mark all reverted edits as bot
3144 if ( $wgUseRCPatrol ) {
3145 // Mark all reverted edits as patrolled
3146 $set['rc_patrolled'] = 1;
3149 if ( count( $set ) ) {
3150 $dbw->update( 'recentchanges', $set,
3152 'rc_cur_id' => $current->getPage(),
3153 'rc_user_text' => $current->getUserText(),
3154 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3160 if ( !$status->isOK() ) {
3161 return $status->getErrorsArray();
3164 // raise error, when the edit is an edit without a new version
3165 $statusRev = isset( $status->value
['revision'] )
3166 ?
$status->value
['revision']
3168 if ( !( $statusRev instanceof Revision
) ) {
3169 $resultDetails = array( 'current' => $current );
3170 return array( array( 'alreadyrolled',
3171 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3172 htmlspecialchars( $fromP ),
3173 htmlspecialchars( $current->getUserText() )
3177 $revId = $statusRev->getId();
3179 Hooks
::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3181 $resultDetails = array(
3182 'summary' => $summary,
3183 'current' => $current,
3184 'target' => $target,
3192 * The onArticle*() functions are supposed to be a kind of hooks
3193 * which should be called whenever any of the specified actions
3196 * This is a good place to put code to clear caches, for instance.
3198 * This is called on page move and undelete, as well as edit
3200 * @param Title $title
3202 public static function onArticleCreate( Title
$title ) {
3203 // Update existence markers on article/talk tabs...
3204 $other = $title->getOtherPage();
3206 $other->purgeSquid();
3208 $title->touchLinks();
3209 $title->purgeSquid();
3210 $title->deleteTitleProtection();
3214 * Clears caches when article is deleted
3216 * @param Title $title
3218 public static function onArticleDelete( Title
$title ) {
3219 // Update existence markers on article/talk tabs...
3220 $other = $title->getOtherPage();
3222 $other->purgeSquid();
3224 $title->touchLinks();
3225 $title->purgeSquid();
3228 HTMLFileCache
::clearFileCache( $title );
3229 InfoAction
::invalidateCache( $title );
3232 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3233 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3237 if ( $title->getNamespace() == NS_FILE
) {
3238 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3242 if ( $title->getNamespace() == NS_USER_TALK
) {
3243 $user = User
::newFromName( $title->getText(), false );
3245 $user->setNewtalk( false );
3250 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3254 * Purge caches on page update etc
3256 * @param Title $title
3257 * @param Revision|null $revision Revision that was just saved, may be null
3259 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3260 // Invalidate caches of articles which include this page
3261 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3263 // Invalidate the caches of all pages which redirect here
3264 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3266 // Purge squid for this page only
3267 $title->purgeSquid();
3268 // Clear file cache for this page only
3269 HTMLFileCache
::clearFileCache( $title );
3271 $revid = $revision ?
$revision->getId() : null;
3272 DeferredUpdates
::addCallableUpdate( function() use ( $title, $revid ) {
3273 InfoAction
::invalidateCache( $title, $revid );
3280 * Returns a list of categories this page is a member of.
3281 * Results will include hidden categories
3283 * @return TitleArray
3285 public function getCategories() {
3286 $id = $this->getId();
3288 return TitleArray
::newFromResult( new FakeResultWrapper( array() ) );
3291 $dbr = wfGetDB( DB_SLAVE
);
3292 $res = $dbr->select( 'categorylinks',
3293 array( 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ),
3294 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3295 // as not being aliases, and NS_CATEGORY is numeric
3296 array( 'cl_from' => $id ),
3299 return TitleArray
::newFromResult( $res );
3303 * Returns a list of hidden categories this page is a member of.
3304 * Uses the page_props and categorylinks tables.
3306 * @return array Array of Title objects
3308 public function getHiddenCategories() {
3310 $id = $this->getId();
3316 $dbr = wfGetDB( DB_SLAVE
);
3317 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3319 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3320 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
3323 if ( $res !== false ) {
3324 foreach ( $res as $row ) {
3325 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3333 * Return an applicable autosummary if one exists for the given edit.
3334 * @param string|null $oldtext The previous text of the page.
3335 * @param string|null $newtext The submitted text of the page.
3336 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3337 * @return string An appropriate autosummary, or an empty string.
3339 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3341 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3342 // NOTE: stub for backwards-compatibility. assumes the given text is
3343 // wikitext. will break horribly if it isn't.
3345 ContentHandler
::deprecated( __METHOD__
, '1.21' );
3347 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
3348 $oldContent = is_null( $oldtext ) ?
null : $handler->unserializeContent( $oldtext );
3349 $newContent = is_null( $newtext ) ?
null : $handler->unserializeContent( $newtext );
3351 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3355 * Auto-generates a deletion reason
3357 * @param bool &$hasHistory Whether the page has a history
3358 * @return string|bool String containing deletion reason or empty string, or boolean false
3359 * if no revision occurred
3361 public function getAutoDeleteReason( &$hasHistory ) {
3362 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3366 * Update all the appropriate counts in the category table, given that
3367 * we've added the categories $added and deleted the categories $deleted.
3369 * @param array $added The names of categories that were added
3370 * @param array $deleted The names of categories that were deleted
3372 public function updateCategoryCounts( array $added, array $deleted ) {
3374 $method = __METHOD__
;
3375 $dbw = wfGetDB( DB_MASTER
);
3377 // Do this at the end of the commit to reduce lock wait timeouts
3378 $dbw->onTransactionPreCommitOrIdle(
3379 function () use ( $dbw, $that, $method, $added, $deleted ) {
3380 $ns = $that->getTitle()->getNamespace();
3382 $addFields = array( 'cat_pages = cat_pages + 1' );
3383 $removeFields = array( 'cat_pages = cat_pages - 1' );
3384 if ( $ns == NS_CATEGORY
) {
3385 $addFields[] = 'cat_subcats = cat_subcats + 1';
3386 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3387 } elseif ( $ns == NS_FILE
) {
3388 $addFields[] = 'cat_files = cat_files + 1';
3389 $removeFields[] = 'cat_files = cat_files - 1';
3392 if ( count( $added ) ) {
3393 $existingAdded = $dbw->selectFieldValues(
3396 array( 'cat_title' => $added ),
3400 // For category rows that already exist, do a plain
3401 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3402 // to avoid creating gaps in the cat_id sequence.
3403 if ( count( $existingAdded ) ) {
3407 array( 'cat_title' => $existingAdded ),
3412 $missingAdded = array_diff( $added, $existingAdded );
3413 if ( count( $missingAdded ) ) {
3414 $insertRows = array();
3415 foreach ( $missingAdded as $cat ) {
3416 $insertRows[] = array(
3417 'cat_title' => $cat,
3419 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3420 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3426 array( 'cat_title' ),
3433 if ( count( $deleted ) ) {
3437 array( 'cat_title' => $deleted ),
3442 foreach ( $added as $catName ) {
3443 $cat = Category
::newFromName( $catName );
3444 Hooks
::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3447 foreach ( $deleted as $catName ) {
3448 $cat = Category
::newFromName( $catName );
3449 Hooks
::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3456 * Opportunistically enqueue link update jobs given fresh parser output if useful
3458 * @param ParserOutput $parserOutput Current version page output
3461 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3462 if ( wfReadOnly() ) {
3466 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3467 array( $this, $this->mTitle
, $parserOutput )
3473 'isOpportunistic' => true,
3474 'rootJobTimestamp' => $parserOutput->getCacheTime()
3477 if ( $this->mTitle
->areRestrictionsCascading() ) {
3478 // If the page is cascade protecting, the links should really be up-to-date
3479 JobQueueGroup
::singleton()->lazyPush(
3480 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3482 } elseif ( $parserOutput->hasDynamicContent() ) {
3483 // Assume the output contains "dynamic" time/random based magic words.
3484 // Only update pages that expired due to dynamic content and NOT due to edits
3485 // to referenced templates/files. When the cache expires due to dynamic content,
3486 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3487 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3488 // template/file edit already triggered recursive RefreshLinksJob jobs.
3489 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3490 // If a page is uncacheable, do not keep spamming a job for it.
3491 // Although it would be de-duplicated, it would still waste I/O.
3492 $cache = ObjectCache
::getLocalClusterInstance();
3493 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3494 if ( $cache->add( $key, time(), 60 ) ) {
3495 JobQueueGroup
::singleton()->lazyPush(
3496 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3504 * Return a list of templates used by this article.
3505 * Uses the templatelinks table
3507 * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3508 * @return array Array of Title objects
3510 public function getUsedTemplates() {
3511 return $this->mTitle
->getTemplateLinksFrom();
3515 * This function is called right before saving the wikitext,
3516 * so we can do things like signatures and links-in-context.
3518 * @deprecated since 1.19; use Parser::preSaveTransform() instead
3519 * @param string $text Article contents
3520 * @param User $user User doing the edit
3521 * @param ParserOptions $popts Parser options, default options for
3522 * the user loaded if null given
3523 * @return string Article contents with altered wikitext markup (signatures
3524 * converted, {{subst:}}, templates, etc.)
3526 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
3527 global $wgParser, $wgUser;
3529 wfDeprecated( __METHOD__
, '1.19' );
3531 $user = is_null( $user ) ?
$wgUser : $user;
3533 if ( $popts === null ) {
3534 $popts = ParserOptions
::newFromUser( $user );
3537 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
3541 * Update the article's restriction field, and leave a log entry.
3543 * @deprecated since 1.19
3544 * @param array $limit Set of restriction keys
3545 * @param string $reason
3546 * @param int &$cascade Set to false if cascading protection isn't allowed.
3547 * @param array $expiry Per restriction type expiration
3548 * @param User $user The user updating the restrictions
3549 * @return bool True on success
3551 public function updateRestrictions(
3552 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User
$user = null
3556 $user = is_null( $user ) ?
$wgUser : $user;
3558 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3562 * Returns a list of updates to be performed when this page is deleted. The
3563 * updates should remove any information about this page from secondary data
3564 * stores such as links tables.
3566 * @param Content|null $content Optional Content object for determining the
3567 * necessary updates.
3568 * @return DataUpdate[]
3570 public function getDeletionUpdates( Content
$content = null ) {
3572 // load content object, which may be used to determine the necessary updates.
3573 // XXX: the content may not be needed to determine the updates.
3574 $content = $this->getContent( Revision
::RAW
);
3580 $updates = $content->getDeletionUpdates( $this );
3583 Hooks
::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );