3 * Base representation for a MediaWiki page.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
30 * Class representing a MediaWiki article and history.
32 * Some fields are public only for backwards-compatibility. Use accessors.
33 * In the past, this class was part of Article.php and everything was public.
35 class WikiPage
implements Page
, IDBAccessObject
{
36 // Constants for $mDataLoadedFrom and related
41 public $mTitle = null;
46 public $mDataLoaded = false; // !< Boolean
47 public $mIsRedirect = false; // !< Boolean
48 public $mLatest = false; // !< Integer (false means "not loaded")
51 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
52 public $mPreparedEdit = false;
57 protected $mId = null;
60 * @var int One of the READ_* constants
62 protected $mDataLoadedFrom = self
::READ_NONE
;
67 protected $mRedirectTarget = null;
72 protected $mLastRevision = null;
75 * @var string Timestamp of the current revision or empty string if not loaded
77 protected $mTimestamp = '';
82 protected $mTouched = '19700101000000';
87 protected $mLinksUpdated = '19700101000000';
90 * Constructor and clear the article
91 * @param Title $title Reference to a Title object.
93 public function __construct( Title
$title ) {
94 $this->mTitle
= $title;
98 * Create a WikiPage object of the appropriate class for the given title.
100 * @param Title $title
102 * @throws MWException
103 * @return WikiPage Object of the appropriate type
105 public static function factory( Title
$title ) {
106 $ns = $title->getNamespace();
108 if ( $ns == NS_MEDIA
) {
109 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
110 } elseif ( $ns < 0 ) {
111 throw new MWException( "Invalid or virtual namespace $ns given." );
116 $page = new WikiFilePage( $title );
119 $page = new WikiCategoryPage( $title );
122 $page = new WikiPage( $title );
129 * Constructor from a page id
131 * @param int $id Article ID to load
132 * @param string|int $from One of the following values:
133 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
134 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
136 * @return WikiPage|null
138 public static function newFromID( $id, $from = 'fromdb' ) {
139 // page id's are never 0 or negative, see bug 61166
144 $from = self
::convertSelectType( $from );
145 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_SLAVE
);
146 $row = $db->selectRow( 'page', self
::selectFields(), array( 'page_id' => $id ), __METHOD__
);
150 return self
::newFromRow( $row, $from );
154 * Constructor from a database row
157 * @param object $row Database row containing at least fields returned by selectFields().
158 * @param string|int $from Source of $data:
159 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
160 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
161 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
164 public static function newFromRow( $row, $from = 'fromdb' ) {
165 $page = self
::factory( Title
::newFromRow( $row ) );
166 $page->loadFromRow( $row, $from );
171 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
173 * @param object|string|int $type
176 private static function convertSelectType( $type ) {
179 return self
::READ_NORMAL
;
181 return self
::READ_LATEST
;
183 return self
::READ_LOCKING
;
185 // It may already be an integer or whatever else
191 * Returns overrides for action handlers.
192 * Classes listed here will be used instead of the default one when
193 * (and only when) $wgActions[$action] === true. This allows subclasses
194 * to override the default behavior.
196 * @todo Move this UI stuff somewhere else
200 public function getActionOverrides() {
201 $content_handler = $this->getContentHandler();
202 return $content_handler->getActionOverrides();
206 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
208 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
210 * @return ContentHandler
214 public function getContentHandler() {
215 return ContentHandler
::getForModelID( $this->getContentModel() );
219 * Get the title object of the article
220 * @return Title Title object of this page
222 public function getTitle() {
223 return $this->mTitle
;
230 public function clear() {
231 $this->mDataLoaded
= false;
232 $this->mDataLoadedFrom
= self
::READ_NONE
;
234 $this->clearCacheFields();
238 * Clear the object cache fields
241 protected function clearCacheFields() {
243 $this->mRedirectTarget
= null; // Title object if set
244 $this->mLastRevision
= null; // Latest revision
245 $this->mTouched
= '19700101000000';
246 $this->mLinksUpdated
= '19700101000000';
247 $this->mTimestamp
= '';
248 $this->mIsRedirect
= false;
249 $this->mLatest
= false;
250 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
251 // the requested rev ID and content against the cached one for equality. For most
252 // content types, the output should not change during the lifetime of this cache.
253 // Clearing it can cause extra parses on edit for no reason.
257 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
261 public function clearPreparedEdit() {
262 $this->mPreparedEdit
= false;
266 * Return the list of revision fields that should be selected to create
271 public static function selectFields() {
272 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
283 'page_links_updated',
288 if ( $wgContentHandlerUseDB ) {
289 $fields[] = 'page_content_model';
292 if ( $wgPageLanguageUseDB ) {
293 $fields[] = 'page_lang';
300 * Fetch a page record with the given conditions
301 * @param DatabaseBase $dbr
302 * @param array $conditions
303 * @param array $options
304 * @return object|bool Database result resource, or false on failure
306 protected function pageData( $dbr, $conditions, $options = array() ) {
307 $fields = self
::selectFields();
309 Hooks
::run( 'ArticlePageDataBefore', array( &$this, &$fields ) );
311 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
313 Hooks
::run( 'ArticlePageDataAfter', array( &$this, &$row ) );
319 * Fetch a page record matching the Title object's namespace and title
320 * using a sanitized title string
322 * @param DatabaseBase $dbr
323 * @param Title $title
324 * @param array $options
325 * @return object|bool Database result resource, or false on failure
327 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
328 return $this->pageData( $dbr, array(
329 'page_namespace' => $title->getNamespace(),
330 'page_title' => $title->getDBkey() ), $options );
334 * Fetch a page record matching the requested ID
336 * @param DatabaseBase $dbr
338 * @param array $options
339 * @return object|bool Database result resource, or false on failure
341 public function pageDataFromId( $dbr, $id, $options = array() ) {
342 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
346 * Load the object from a given source by title
348 * @param object|string|int $from One of the following:
349 * - A DB query result object.
350 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
351 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
352 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
353 * using SELECT FOR UPDATE.
357 public function loadPageData( $from = 'fromdb' ) {
358 $from = self
::convertSelectType( $from );
359 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
360 // We already have the data from the correct location, no need to load it twice.
364 if ( $from === self
::READ_LOCKING
) {
365 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
, array( 'FOR UPDATE' ) );
366 } elseif ( $from === self
::READ_LATEST
) {
367 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
368 } elseif ( $from === self
::READ_NORMAL
) {
369 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE
), $this->mTitle
);
371 && wfGetLB()->getServerCount() > 1
372 && wfGetLB()->hasOrMadeRecentMasterChanges()
374 $from = self
::READ_LATEST
;
375 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
378 // No idea from where the caller got this data, assume slave database.
380 $from = self
::READ_NORMAL
;
383 $this->loadFromRow( $data, $from );
387 * Load the object from a database row
390 * @param object $data Database row containing at least fields returned by selectFields()
391 * @param string|int $from One of the following:
392 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
393 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
394 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
395 * the master DB using SELECT FOR UPDATE
397 public function loadFromRow( $data, $from ) {
398 $lc = LinkCache
::singleton();
399 $lc->clearLink( $this->mTitle
);
402 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
404 $this->mTitle
->loadFromRow( $data );
406 // Old-fashioned restrictions
407 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
409 $this->mId
= intval( $data->page_id
);
410 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
411 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
412 $this->mIsRedirect
= intval( $data->page_is_redirect
);
413 $this->mLatest
= intval( $data->page_latest
);
414 // Bug 37225: $latest may no longer match the cached latest Revision object.
415 // Double-check the ID of any cached latest Revision object for consistency.
416 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
417 $this->mLastRevision
= null;
418 $this->mTimestamp
= '';
421 $lc->addBadLinkObj( $this->mTitle
);
423 $this->mTitle
->loadFromRow( false );
425 $this->clearCacheFields();
430 $this->mDataLoaded
= true;
431 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
435 * @return int Page ID
437 public function getId() {
438 if ( !$this->mDataLoaded
) {
439 $this->loadPageData();
445 * @return bool Whether or not the page exists in the database
447 public function exists() {
448 if ( !$this->mDataLoaded
) {
449 $this->loadPageData();
451 return $this->mId
> 0;
455 * Check if this page is something we're going to be showing
456 * some sort of sensible content for. If we return false, page
457 * views (plain action=view) will return an HTTP 404 response,
458 * so spiders and robots can know they're following a bad link.
462 public function hasViewableContent() {
463 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
467 * Tests if the article content represents a redirect
471 public function isRedirect() {
472 $content = $this->getContent();
477 return $content->isRedirect();
481 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
483 * Will use the revisions actual content model if the page exists,
484 * and the page's default if the page doesn't exist yet.
490 public function getContentModel() {
491 if ( $this->exists() ) {
492 // look at the revision's actual content model
493 $rev = $this->getRevision();
495 if ( $rev !== null ) {
496 return $rev->getContentModel();
498 $title = $this->mTitle
->getPrefixedDBkey();
499 wfWarn( "Page $title exists but has no (visible) revisions!" );
503 // use the default model for this page
504 return $this->mTitle
->getContentModel();
508 * Loads page_touched and returns a value indicating if it should be used
509 * @return bool True if not a redirect
511 public function checkTouched() {
512 if ( !$this->mDataLoaded
) {
513 $this->loadPageData();
515 return !$this->mIsRedirect
;
519 * Get the page_touched field
520 * @return string Containing GMT timestamp
522 public function getTouched() {
523 if ( !$this->mDataLoaded
) {
524 $this->loadPageData();
526 return $this->mTouched
;
530 * Get the page_links_updated field
531 * @return string|null Containing GMT timestamp
533 public function getLinksTimestamp() {
534 if ( !$this->mDataLoaded
) {
535 $this->loadPageData();
537 return $this->mLinksUpdated
;
541 * Get the page_latest field
542 * @return int The rev_id of current revision
544 public function getLatest() {
545 if ( !$this->mDataLoaded
) {
546 $this->loadPageData();
548 return (int)$this->mLatest
;
552 * Get the Revision object of the oldest revision
553 * @return Revision|null
555 public function getOldestRevision() {
557 // Try using the slave database first, then try the master
559 $db = wfGetDB( DB_SLAVE
);
560 $revSelectFields = Revision
::selectFields();
563 while ( $continue ) {
564 $row = $db->selectRow(
565 array( 'page', 'revision' ),
568 'page_namespace' => $this->mTitle
->getNamespace(),
569 'page_title' => $this->mTitle
->getDBkey(),
574 'ORDER BY' => 'rev_timestamp ASC'
581 $db = wfGetDB( DB_MASTER
);
586 return $row ? Revision
::newFromRow( $row ) : null;
590 * Loads everything except the text
591 * This isn't necessary for all uses, so it's only done if needed.
593 protected function loadLastEdit() {
594 if ( $this->mLastRevision
!== null ) {
595 return; // already loaded
598 $latest = $this->getLatest();
600 return; // page doesn't exist or is missing page_latest info
603 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
604 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always
605 // includes the latest changes committed. This is true even within REPEATABLE-READ
606 // transactions, where S1 normally only sees changes committed before the first S1
607 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
608 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
609 // happened after the first S1 SELECT.
610 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
611 $flags = Revision
::READ_LOCKING
;
612 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
613 // Bug T93976: if page_latest was loaded from the master, fetch the
614 // revision from there as well, as it may not exist yet on a slave DB.
615 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
616 $flags = Revision
::READ_LATEST
;
620 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
621 if ( $revision ) { // sanity
622 $this->setLastEdit( $revision );
627 * Set the latest revision
628 * @param Revision $revision
630 protected function setLastEdit( Revision
$revision ) {
631 $this->mLastRevision
= $revision;
632 $this->mTimestamp
= $revision->getTimestamp();
636 * Get the latest revision
637 * @return Revision|null
639 public function getRevision() {
640 $this->loadLastEdit();
641 if ( $this->mLastRevision
) {
642 return $this->mLastRevision
;
648 * Get the content of the current revision. No side-effects...
650 * @param int $audience One of:
651 * Revision::FOR_PUBLIC to be displayed to all users
652 * Revision::FOR_THIS_USER to be displayed to $wgUser
653 * Revision::RAW get the text regardless of permissions
654 * @param User $user User object to check for, only if FOR_THIS_USER is passed
655 * to the $audience parameter
656 * @return Content|null The content of the current revision
660 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
661 $this->loadLastEdit();
662 if ( $this->mLastRevision
) {
663 return $this->mLastRevision
->getContent( $audience, $user );
669 * Get the text of the current revision. No side-effects...
671 * @param int $audience One of:
672 * Revision::FOR_PUBLIC to be displayed to all users
673 * Revision::FOR_THIS_USER to be displayed to the given user
674 * Revision::RAW get the text regardless of permissions
675 * @param User $user User object to check for, only if FOR_THIS_USER is passed
676 * to the $audience parameter
677 * @return string|bool The text of the current revision
678 * @deprecated since 1.21, getContent() should be used instead.
680 public function getText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
681 ContentHandler
::deprecated( __METHOD__
, '1.21' );
683 $this->loadLastEdit();
684 if ( $this->mLastRevision
) {
685 return $this->mLastRevision
->getText( $audience, $user );
691 * Get the text of the current revision. No side-effects...
693 * @return string|bool The text of the current revision. False on failure
694 * @deprecated since 1.21, getContent() should be used instead.
696 public function getRawText() {
697 ContentHandler
::deprecated( __METHOD__
, '1.21' );
699 return $this->getText( Revision
::RAW
);
703 * @return string MW timestamp of last article revision
705 public function getTimestamp() {
706 // Check if the field has been filled by WikiPage::setTimestamp()
707 if ( !$this->mTimestamp
) {
708 $this->loadLastEdit();
711 return wfTimestamp( TS_MW
, $this->mTimestamp
);
715 * Set the page timestamp (use only to avoid DB queries)
716 * @param string $ts MW timestamp of last article revision
719 public function setTimestamp( $ts ) {
720 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
724 * @param int $audience One of:
725 * Revision::FOR_PUBLIC to be displayed to all users
726 * Revision::FOR_THIS_USER to be displayed to the given user
727 * Revision::RAW get the text regardless of permissions
728 * @param User $user User object to check for, only if FOR_THIS_USER is passed
729 * to the $audience parameter
730 * @return int User ID for the user that made the last article revision
732 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
733 $this->loadLastEdit();
734 if ( $this->mLastRevision
) {
735 return $this->mLastRevision
->getUser( $audience, $user );
742 * Get the User object of the user who created the page
743 * @param int $audience One of:
744 * Revision::FOR_PUBLIC to be displayed to all users
745 * Revision::FOR_THIS_USER to be displayed to the given user
746 * Revision::RAW get the text regardless of permissions
747 * @param User $user User object to check for, only if FOR_THIS_USER is passed
748 * to the $audience parameter
751 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
752 $revision = $this->getOldestRevision();
754 $userName = $revision->getUserText( $audience, $user );
755 return User
::newFromName( $userName, false );
762 * @param int $audience One of:
763 * Revision::FOR_PUBLIC to be displayed to all users
764 * Revision::FOR_THIS_USER to be displayed to the given user
765 * Revision::RAW get the text regardless of permissions
766 * @param User $user User object to check for, only if FOR_THIS_USER is passed
767 * to the $audience parameter
768 * @return string Username of the user that made the last article revision
770 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
771 $this->loadLastEdit();
772 if ( $this->mLastRevision
) {
773 return $this->mLastRevision
->getUserText( $audience, $user );
780 * @param int $audience One of:
781 * Revision::FOR_PUBLIC to be displayed to all users
782 * Revision::FOR_THIS_USER to be displayed to the given user
783 * Revision::RAW get the text regardless of permissions
784 * @param User $user User object to check for, only if FOR_THIS_USER is passed
785 * to the $audience parameter
786 * @return string Comment stored for the last article revision
788 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
789 $this->loadLastEdit();
790 if ( $this->mLastRevision
) {
791 return $this->mLastRevision
->getComment( $audience, $user );
798 * Returns true if last revision was marked as "minor edit"
800 * @return bool Minor edit indicator for the last article revision.
802 public function getMinorEdit() {
803 $this->loadLastEdit();
804 if ( $this->mLastRevision
) {
805 return $this->mLastRevision
->isMinor();
812 * Determine whether a page would be suitable for being counted as an
813 * article in the site_stats table based on the title & its content
815 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
816 * if false, the current database state will be used
819 public function isCountable( $editInfo = false ) {
820 global $wgArticleCountMethod;
822 if ( !$this->mTitle
->isContentPage() ) {
827 $content = $editInfo->pstContent
;
829 $content = $this->getContent();
832 if ( !$content ||
$content->isRedirect() ) {
838 if ( $wgArticleCountMethod === 'link' ) {
839 // nasty special case to avoid re-parsing to detect links
842 // ParserOutput::getLinks() is a 2D array of page links, so
843 // to be really correct we would need to recurse in the array
844 // but the main array should only have items in it if there are
846 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
848 $hasLinks = (bool)wfGetDB( DB_SLAVE
)->selectField( 'pagelinks', 1,
849 array( 'pl_from' => $this->getId() ), __METHOD__
);
853 return $content->isCountable( $hasLinks );
857 * If this page is a redirect, get its target
859 * The target will be fetched from the redirect table if possible.
860 * If this page doesn't have an entry there, call insertRedirect()
861 * @return Title|null Title object, or null if this page is not a redirect
863 public function getRedirectTarget() {
864 if ( !$this->mTitle
->isRedirect() ) {
868 if ( $this->mRedirectTarget
!== null ) {
869 return $this->mRedirectTarget
;
872 // Query the redirect table
873 $dbr = wfGetDB( DB_SLAVE
);
874 $row = $dbr->selectRow( 'redirect',
875 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
876 array( 'rd_from' => $this->getId() ),
880 // rd_fragment and rd_interwiki were added later, populate them if empty
881 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
882 $this->mRedirectTarget
= Title
::makeTitle(
883 $row->rd_namespace
, $row->rd_title
,
884 $row->rd_fragment
, $row->rd_interwiki
);
885 return $this->mRedirectTarget
;
888 // This page doesn't have an entry in the redirect table
889 $this->mRedirectTarget
= $this->insertRedirect();
890 return $this->mRedirectTarget
;
894 * Insert an entry for this page into the redirect table.
896 * Don't call this function directly unless you know what you're doing.
897 * @return Title|null Title object or null if not a redirect
899 public function insertRedirect() {
900 // recurse through to only get the final target
901 $content = $this->getContent();
902 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
906 $this->insertRedirectEntry( $retval );
911 * Insert or update the redirect table entry for this page to indicate
912 * it redirects to $rt .
913 * @param Title $rt Redirect target
915 public function insertRedirectEntry( $rt ) {
916 $dbw = wfGetDB( DB_MASTER
);
917 $dbw->replace( 'redirect', array( 'rd_from' ),
919 'rd_from' => $this->getId(),
920 'rd_namespace' => $rt->getNamespace(),
921 'rd_title' => $rt->getDBkey(),
922 'rd_fragment' => $rt->getFragment(),
923 'rd_interwiki' => $rt->getInterwiki(),
930 * Get the Title object or URL this page redirects to
932 * @return bool|Title|string False, Title of in-wiki target, or string with URL
934 public function followRedirect() {
935 return $this->getRedirectURL( $this->getRedirectTarget() );
939 * Get the Title object or URL to use for a redirect. We use Title
940 * objects for same-wiki, non-special redirects and URLs for everything
942 * @param Title $rt Redirect target
943 * @return bool|Title|string False, Title object of local target, or string with URL
945 public function getRedirectURL( $rt ) {
950 if ( $rt->isExternal() ) {
951 if ( $rt->isLocal() ) {
952 // Offsite wikis need an HTTP redirect.
954 // This can be hard to reverse and may produce loops,
955 // so they may be disabled in the site configuration.
956 $source = $this->mTitle
->getFullURL( 'redirect=no' );
957 return $rt->getFullURL( array( 'rdfrom' => $source ) );
959 // External pages without "local" bit set are not valid
965 if ( $rt->isSpecialPage() ) {
966 // Gotta handle redirects to special pages differently:
967 // Fill the HTTP response "Location" header and ignore
968 // the rest of the page we're on.
970 // Some pages are not valid targets
971 if ( $rt->isValidRedirectTarget() ) {
972 return $rt->getFullURL();
982 * Get a list of users who have edited this article, not including the user who made
983 * the most recent revision, which you can get from $article->getUser() if you want it
984 * @return UserArrayFromResult
986 public function getContributors() {
987 // @todo FIXME: This is expensive; cache this info somewhere.
989 $dbr = wfGetDB( DB_SLAVE
);
991 if ( $dbr->implicitGroupby() ) {
992 $realNameField = 'user_real_name';
994 $realNameField = 'MIN(user_real_name) AS user_real_name';
997 $tables = array( 'revision', 'user' );
1000 'user_id' => 'rev_user',
1001 'user_name' => 'rev_user_text',
1003 'timestamp' => 'MAX(rev_timestamp)',
1006 $conds = array( 'rev_page' => $this->getId() );
1008 // The user who made the top revision gets credited as "this page was last edited by
1009 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1010 $user = $this->getUser();
1012 $conds[] = "rev_user != $user";
1014 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1017 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1020 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1024 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1025 'ORDER BY' => 'timestamp DESC',
1028 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1029 return new UserArrayFromResult( $res );
1033 * Get the last N authors
1034 * @param int $num Number of revisions to get
1035 * @param int|string $revLatest The latest rev_id, selected from the master (optional)
1036 * @return array Array of authors, duplicates not removed
1038 public function getLastNAuthors( $num, $revLatest = 0 ) {
1039 // First try the slave
1040 // If that doesn't have the latest revision, try the master
1042 $db = wfGetDB( DB_SLAVE
);
1045 $res = $db->select( array( 'page', 'revision' ),
1046 array( 'rev_id', 'rev_user_text' ),
1048 'page_namespace' => $this->mTitle
->getNamespace(),
1049 'page_title' => $this->mTitle
->getDBkey(),
1050 'rev_page = page_id'
1053 'ORDER BY' => 'rev_timestamp DESC',
1062 $row = $db->fetchObject( $res );
1064 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
1065 $db = wfGetDB( DB_MASTER
);
1070 } while ( $continue );
1072 $authors = array( $row->rev_user_text
);
1074 foreach ( $res as $row ) {
1075 $authors[] = $row->rev_user_text
;
1082 * Should the parser cache be used?
1084 * @param ParserOptions $parserOptions ParserOptions to check
1088 public function isParserCacheUsed( ParserOptions
$parserOptions, $oldid ) {
1089 global $wgEnableParserCache;
1091 return $wgEnableParserCache
1092 && $parserOptions->getStubThreshold() == 0
1094 && ( $oldid === null ||
$oldid === 0 ||
$oldid === $this->getLatest() )
1095 && $this->getContentHandler()->isParserCacheSupported();
1099 * Get a ParserOutput for the given ParserOptions and revision ID.
1100 * The parser cache will be used if possible.
1103 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1104 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1105 * get the current revision (default value)
1107 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1109 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
1111 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1112 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1113 if ( $parserOptions->getStubThreshold() ) {
1114 wfIncrStats( 'pcache_miss_stub' );
1117 if ( $useParserCache ) {
1118 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1119 if ( $parserOutput !== false ) {
1120 return $parserOutput;
1124 if ( $oldid === null ||
$oldid === 0 ) {
1125 $oldid = $this->getLatest();
1128 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1131 return $pool->getParserOutput();
1135 * Do standard deferred updates after page view (existing or missing page)
1136 * @param User $user The relevant user
1137 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
1139 public function doViewUpdates( User
$user, $oldid = 0 ) {
1140 if ( wfReadOnly() ) {
1144 // Update newtalk / watchlist notification status
1145 $user->clearNotification( $this->mTitle
, $oldid );
1149 * Perform the actions of a page purging
1152 public function doPurge() {
1155 if ( !Hooks
::run( 'ArticlePurge', array( &$this ) ) ) {
1159 // Invalidate the cache
1160 $this->mTitle
->invalidateCache();
1162 if ( $wgUseSquid ) {
1163 // Commit the transaction before the purge is sent
1164 $dbw = wfGetDB( DB_MASTER
);
1165 $dbw->commit( __METHOD__
);
1168 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1169 $update->doUpdate();
1172 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1173 // @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 DatabaseBase $dbw
1202 * @return int The newly created page_id key, or false if the title already existed
1204 public function insertOn( $dbw ) {
1206 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1207 $dbw->insert( 'page', array(
1208 'page_id' => $page_id,
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...
1218 ), __METHOD__
, 'IGNORE' );
1220 $affected = $dbw->affectedRows();
1223 $newid = $dbw->insertId();
1224 $this->mId
= $newid;
1225 $this->mTitle
->resetArticleID( $newid );
1228 return $affected ?
$newid : false;
1232 * Update the page record to point to a newly saved revision.
1234 * @param DatabaseBase $dbw
1235 * @param Revision $revision For ID number, and text used to set
1236 * length and redirect status fields
1237 * @param int $lastRevision If given, will not overwrite the page field
1238 * when different from the currently set value.
1239 * Giving 0 indicates the new page flag should be set on.
1240 * @param bool $lastRevIsRedirect If given, will optimize adding and
1241 * removing rows in redirect table.
1242 * @return bool True on success, false on failure
1244 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1245 $lastRevIsRedirect = null
1247 global $wgContentHandlerUseDB;
1249 // Assertion to try to catch T92046
1250 if ( (int)$revision->getId() === 0 ) {
1251 throw new InvalidArgumentException(
1252 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1256 $content = $revision->getContent();
1257 $len = $content ?
$content->getSize() : 0;
1258 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1260 $conditions = array( 'page_id' => $this->getId() );
1262 if ( !is_null( $lastRevision ) ) {
1263 // An extra check against threads stepping on each other
1264 $conditions['page_latest'] = $lastRevision;
1267 $now = wfTimestampNow();
1268 $row = array( /* SET */
1269 'page_latest' => $revision->getId(),
1270 'page_touched' => $dbw->timestamp( $now ),
1271 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1272 'page_is_redirect' => $rt !== null ?
1 : 0,
1276 if ( $wgContentHandlerUseDB ) {
1277 $row['page_content_model'] = $revision->getContentModel();
1280 $dbw->update( 'page',
1285 $result = $dbw->affectedRows() > 0;
1287 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1288 $this->setLastEdit( $revision );
1289 $this->mLatest
= $revision->getId();
1290 $this->mIsRedirect
= (bool)$rt;
1291 // Update the LinkCache.
1292 LinkCache
::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle
, $len, $this->mIsRedirect
,
1293 $this->mLatest
, $revision->getContentModel() );
1300 * Add row to the redirect table if this is a redirect, remove otherwise.
1302 * @param DatabaseBase $dbw
1303 * @param Title $redirectTitle Title object pointing to the redirect target,
1304 * or NULL if this is not a redirect
1305 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1306 * removing rows in redirect table.
1307 * @return bool True on success, false on failure
1310 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1311 // Always update redirects (target link might have changed)
1312 // Update/Insert if we don't know if the last revision was a redirect or not
1313 // Delete if changing from redirect to non-redirect
1314 $isRedirect = !is_null( $redirectTitle );
1316 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1320 if ( $isRedirect ) {
1321 $this->insertRedirectEntry( $redirectTitle );
1323 // This is not a redirect, remove row from redirect table
1324 $where = array( 'rd_from' => $this->getId() );
1325 $dbw->delete( 'redirect', $where, __METHOD__
);
1328 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1329 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1332 return ( $dbw->affectedRows() != 0 );
1336 * If the given revision is newer than the currently set page_latest,
1337 * update the page record. Otherwise, do nothing.
1339 * @deprecated since 1.24, use updateRevisionOn instead
1341 * @param DatabaseBase $dbw
1342 * @param Revision $revision
1345 public function updateIfNewerOn( $dbw, $revision ) {
1347 $row = $dbw->selectRow(
1348 array( 'revision', 'page' ),
1349 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1351 'page_id' => $this->getId(),
1352 'page_latest=rev_id' ),
1356 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1359 $prev = $row->rev_id
;
1360 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1362 // No or missing previous revision; mark the page as new
1364 $lastRevIsRedirect = null;
1367 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1373 * Get the content that needs to be saved in order to undo all revisions
1374 * between $undo and $undoafter. Revisions must belong to the same page,
1375 * must exist and must not be deleted
1376 * @param Revision $undo
1377 * @param Revision $undoafter Must be an earlier revision than $undo
1378 * @return mixed String on success, false on failure
1380 * Before we had the Content object, this was done in getUndoText
1382 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1383 $handler = $undo->getContentHandler();
1384 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1388 * Get the text that needs to be saved in order to undo all revisions
1389 * between $undo and $undoafter. Revisions must belong to the same page,
1390 * must exist and must not be deleted
1391 * @param Revision $undo
1392 * @param Revision $undoafter Must be an earlier revision than $undo
1393 * @return string|bool String on success, false on failure
1394 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1396 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
1397 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1399 $this->loadLastEdit();
1401 if ( $this->mLastRevision
) {
1402 if ( is_null( $undoafter ) ) {
1403 $undoafter = $undo->getPrevious();
1406 $handler = $this->getContentHandler();
1407 $undone = $handler->getUndoContent( $this->mLastRevision
, $undo, $undoafter );
1412 return ContentHandler
::getContentText( $undone );
1420 * @param string|number|null|bool $sectionId Section identifier as a number or string
1421 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1422 * or 'new' for a new section.
1423 * @param string $text New text of the section.
1424 * @param string $sectionTitle New section's subject, only if $section is "new".
1425 * @param string $edittime Revision timestamp or null to use the current revision.
1427 * @throws MWException
1428 * @return string New complete article text, or null if error.
1430 * @deprecated since 1.21, use replaceSectionAtRev() instead
1432 public function replaceSection( $sectionId, $text, $sectionTitle = '',
1435 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1437 //NOTE: keep condition in sync with condition in replaceSectionContent!
1438 if ( strval( $sectionId ) === '' ) {
1439 // Whole-page edit; let the whole text through
1443 if ( !$this->supportsSections() ) {
1444 throw new MWException( "sections not supported for content model " .
1445 $this->getContentHandler()->getModelID() );
1448 // could even make section title, but that's not required.
1449 $sectionContent = ContentHandler
::makeContent( $text, $this->getTitle() );
1451 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1454 return ContentHandler
::getContentText( $newContent );
1458 * Returns true if this page's content model supports sections.
1462 * @todo The skin should check this and not offer section functionality if
1463 * sections are not supported.
1464 * @todo The EditPage should check this and not offer section functionality
1465 * if sections are not supported.
1467 public function supportsSections() {
1468 return $this->getContentHandler()->supportsSections();
1472 * @param string|number|null|bool $sectionId Section identifier as a number or string
1473 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1474 * or 'new' for a new section.
1475 * @param Content $sectionContent New content of the section.
1476 * @param string $sectionTitle New section's subject, only if $section is "new".
1477 * @param string $edittime Revision timestamp or null to use the current revision.
1479 * @throws MWException
1480 * @return Content New complete article content, or null if error.
1483 * @deprecated since 1.24, use replaceSectionAtRev instead
1485 public function replaceSectionContent( $sectionId, Content
$sectionContent, $sectionTitle = '',
1486 $edittime = null ) {
1489 if ( $edittime && $sectionId !== 'new' ) {
1490 $dbr = wfGetDB( DB_SLAVE
);
1491 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1492 // Try the master if this thread may have just added it.
1493 // This could be abstracted into a Revision method, but we don't want
1494 // to encourage loading of revisions by timestamp.
1496 && wfGetLB()->getServerCount() > 1
1497 && wfGetLB()->hasOrMadeRecentMasterChanges()
1499 $dbw = wfGetDB( DB_MASTER
);
1500 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1503 $baseRevId = $rev->getId();
1507 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1511 * @param string|number|null|bool $sectionId Section identifier as a number or string
1512 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1513 * or 'new' for a new section.
1514 * @param Content $sectionContent New content of the section.
1515 * @param string $sectionTitle New section's subject, only if $section is "new".
1516 * @param int|null $baseRevId
1518 * @throws MWException
1519 * @return Content New complete article content, or null if error.
1523 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1524 $sectionTitle = '', $baseRevId = null
1527 if ( strval( $sectionId ) === '' ) {
1528 // Whole-page edit; let the whole text through
1529 $newContent = $sectionContent;
1531 if ( !$this->supportsSections() ) {
1532 throw new MWException( "sections not supported for content model " .
1533 $this->getContentHandler()->getModelID() );
1536 // Bug 30711: always use current version when adding a new section
1537 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1538 $oldContent = $this->getContent();
1540 $rev = Revision
::newFromId( $baseRevId );
1542 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1543 $this->getId() . "; section: $sectionId)\n" );
1547 $oldContent = $rev->getContent();
1550 if ( !$oldContent ) {
1551 wfDebug( __METHOD__
. ": no page text\n" );
1555 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1562 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1564 * @return int Updated $flags
1566 public function checkFlags( $flags ) {
1567 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1568 if ( $this->exists() ) {
1569 $flags |
= EDIT_UPDATE
;
1579 * Change an existing article or create a new article. Updates RC and all necessary caches,
1580 * optionally via the deferred update array.
1582 * @param string $text New text
1583 * @param string $summary Edit summary
1584 * @param int $flags Bitfield:
1586 * Article is known or assumed to be non-existent, create a new one
1588 * Article is known or assumed to be pre-existing, update it
1590 * Mark this edit minor, if the user is allowed to do so
1592 * Do not log the change in recentchanges
1594 * Mark the edit a "bot" edit regardless of user rights
1595 * EDIT_DEFER_UPDATES
1596 * Defer some of the updates until the end of index.php
1598 * Fill in blank summaries with generated text where possible
1600 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1601 * article will be detected. If EDIT_UPDATE is specified and the article
1602 * doesn't exist, the function will return an edit-gone-missing error. If
1603 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1604 * error will be returned. These two conditions are also possible with
1605 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1607 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1608 * This is not the parent revision ID, rather the revision ID for older
1609 * content used as the source for a rollback, for example.
1610 * @param User $user The user doing the edit
1612 * @throws MWException
1613 * @return Status Possible errors:
1614 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1615 * set the fatal flag of $status
1616 * edit-gone-missing: In update mode, but the article didn't exist.
1617 * edit-conflict: In update mode, the article changed unexpectedly.
1618 * edit-no-change: Warning that the text was the same as before.
1619 * edit-already-exists: In creation mode, but the article already exists.
1621 * Extensions may define additional errors.
1623 * $return->value will contain an associative array with members as follows:
1624 * new: Boolean indicating if the function attempted to create a new article.
1625 * revision: The revision object for the inserted revision, or null.
1627 * Compatibility note: this function previously returned a boolean value
1628 * indicating success/failure
1630 * @deprecated since 1.21: use doEditContent() instead.
1632 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1633 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1635 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1637 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1641 * Change an existing article or create a new article. Updates RC and all necessary caches,
1642 * optionally via the deferred update array.
1644 * @param Content $content New content
1645 * @param string $summary Edit summary
1646 * @param int $flags Bitfield:
1648 * Article is known or assumed to be non-existent, create a new one
1650 * Article is known or assumed to be pre-existing, update it
1652 * Mark this edit minor, if the user is allowed to do so
1654 * Do not log the change in recentchanges
1656 * Mark the edit a "bot" edit regardless of user rights
1657 * EDIT_DEFER_UPDATES
1658 * Defer some of the updates until the end of index.php
1660 * Fill in blank summaries with generated text where possible
1662 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1663 * article will be detected. If EDIT_UPDATE is specified and the article
1664 * doesn't exist, the function will return an edit-gone-missing error. If
1665 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1666 * error will be returned. These two conditions are also possible with
1667 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1669 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1670 * This is not the parent revision ID, rather the revision ID for older
1671 * content used as the source for a rollback, for example.
1672 * @param User $user The user doing the edit
1673 * @param string $serialFormat Format for storing the content in the
1676 * @throws MWException
1677 * @return Status Possible errors:
1678 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1679 * set the fatal flag of $status.
1680 * edit-gone-missing: In update mode, but the article didn't exist.
1681 * edit-conflict: In update mode, the article changed unexpectedly.
1682 * edit-no-change: Warning that the text was the same as before.
1683 * edit-already-exists: In creation mode, but the article already exists.
1685 * Extensions may define additional errors.
1687 * $return->value will contain an associative array with members as follows:
1688 * new: Boolean indicating if the function attempted to create a new article.
1689 * revision: The revision object for the inserted revision, or null.
1693 public function doEditContent( Content
$content, $summary, $flags = 0, $baseRevId = false,
1694 User
$user = null, $serialFormat = null
1696 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1698 // Low-level sanity check
1699 if ( $this->mTitle
->getText() === '' ) {
1700 throw new MWException( 'Something is trying to edit an article with an empty title' );
1703 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1704 return Status
::newFatal( 'content-not-allowed-here',
1705 ContentHandler
::getLocalizedName( $content->getModel() ),
1706 $this->getTitle()->getPrefixedText() );
1709 $user = is_null( $user ) ?
$wgUser : $user;
1710 $status = Status
::newGood( array() );
1712 // Load the data from the master database if needed.
1713 // The caller may already loaded it from the master or even loaded it using
1714 // SELECT FOR UPDATE, so do not override that using clear().
1715 $this->loadPageData( 'fromdbmaster' );
1717 $flags = $this->checkFlags( $flags );
1720 $hook_args = array( &$this, &$user, &$content, &$summary,
1721 $flags & EDIT_MINOR
, null, null, &$flags, &$status );
1723 if ( !Hooks
::run( 'PageContentSave', $hook_args )
1724 ||
!ContentHandler
::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1726 wfDebug( __METHOD__
. ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1728 if ( $status->isOK() ) {
1729 $status->fatal( 'edit-hook-aborted' );
1735 // Silently ignore EDIT_MINOR if not allowed
1736 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1737 $bot = $flags & EDIT_FORCE_BOT
;
1739 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1741 $oldsize = $old_content ?
$old_content->getSize() : 0;
1742 $oldid = $this->getLatest();
1743 $oldIsRedirect = $this->isRedirect();
1744 $oldcountable = $this->isCountable();
1746 $handler = $content->getContentHandler();
1748 // Provide autosummaries if one is not provided and autosummaries are enabled.
1749 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1750 if ( !$old_content ) {
1751 $old_content = null;
1753 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1756 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1757 $serialized = $editInfo->pst
;
1760 * @var Content $content
1762 $content = $editInfo->pstContent
;
1763 $newsize = $content->getSize();
1765 $dbw = wfGetDB( DB_MASTER
);
1766 $now = wfTimestampNow();
1767 $this->mTimestamp
= $now;
1769 if ( $flags & EDIT_UPDATE
) {
1770 // Update article, but only if changed.
1771 $status->value
['new'] = false;
1774 // Article gone missing
1775 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
1776 $status->fatal( 'edit-gone-missing' );
1779 } elseif ( !$old_content ) {
1780 // Sanity check for bug 37225
1781 throw new MWException( "Could not find text for current revision {$oldid}." );
1784 $revision = new Revision( array(
1785 'page' => $this->getId(),
1786 'title' => $this->getTitle(), // for determining the default content model
1787 'comment' => $summary,
1788 'minor_edit' => $isminor,
1789 'text' => $serialized,
1791 'parent_id' => $oldid,
1792 'user' => $user->getId(),
1793 'user_text' => $user->getName(),
1794 'timestamp' => $now,
1795 'content_model' => $content->getModel(),
1796 'content_format' => $serialFormat,
1797 ) ); // XXX: pass content object?!
1799 $changed = !$content->equals( $old_content );
1802 $dbw->begin( __METHOD__
);
1805 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1806 $status->merge( $prepStatus );
1808 if ( !$status->isOK() ) {
1809 $dbw->rollback( __METHOD__
);
1813 $revisionId = $revision->insertOn( $dbw );
1817 // We check for conflicts by comparing $oldid with the current latest revision ID.
1818 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1821 // Belated edit conflict! Run away!!
1822 $status->fatal( 'edit-conflict' );
1824 $dbw->rollback( __METHOD__
);
1829 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1830 // Update recentchanges
1831 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1832 // Mark as patrolled if the user can do so
1833 $patrolled = $wgUseRCPatrol && !count(
1834 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1835 // Add RC row to the DB
1836 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
1837 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1838 $revisionId, $patrolled
1841 // Log auto-patrolled edits
1843 PatrolLog
::record( $rc, true, $user );
1846 $user->incEditCount();
1847 } catch ( Exception
$e ) {
1848 $dbw->rollback( __METHOD__
);
1849 // Question: Would it perhaps be better if this method turned all
1850 // exceptions into $status's?
1853 $dbw->commit( __METHOD__
);
1855 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1856 // related variables correctly
1857 $revision->setId( $this->getLatest() );
1860 // Update links tables, site stats, etc.
1861 $this->doEditUpdates(
1865 'changed' => $changed,
1866 'oldcountable' => $oldcountable
1871 $status->warning( 'edit-no-change' );
1873 // Update page_touched, this is usually implicit in the page update
1874 // Other cache updates are done in onArticleEdit()
1875 $this->mTitle
->invalidateCache();
1878 // Create new article
1879 $status->value
['new'] = true;
1881 $dbw->begin( __METHOD__
);
1884 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1885 $status->merge( $prepStatus );
1887 if ( !$status->isOK() ) {
1888 $dbw->rollback( __METHOD__
);
1893 $status->merge( $prepStatus );
1895 // Add the page record; stake our claim on this title!
1896 // This will return false if the article already exists
1897 $newid = $this->insertOn( $dbw );
1899 if ( $newid === false ) {
1900 $dbw->rollback( __METHOD__
);
1901 $status->fatal( 'edit-already-exists' );
1906 // Save the revision text...
1907 $revision = new Revision( array(
1909 'title' => $this->getTitle(), // for determining the default content model
1910 'comment' => $summary,
1911 'minor_edit' => $isminor,
1912 'text' => $serialized,
1914 'user' => $user->getId(),
1915 'user_text' => $user->getName(),
1916 'timestamp' => $now,
1917 'content_model' => $content->getModel(),
1918 'content_format' => $serialFormat,
1920 $revisionId = $revision->insertOn( $dbw );
1922 // Bug 37225: use accessor to get the text as Revision may trim it
1923 $content = $revision->getContent(); // sanity; get normalized version
1926 $newsize = $content->getSize();
1929 // Update the page record with revision data
1930 $this->updateRevisionOn( $dbw, $revision, 0 );
1932 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1934 // Update recentchanges
1935 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1936 // Mark as patrolled if the user can do so
1937 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
1938 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1939 // Add RC row to the DB
1940 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
1941 '', $newsize, $revisionId, $patrolled );
1943 // Log auto-patrolled edits
1945 PatrolLog
::record( $rc, true, $user );
1948 $user->incEditCount();
1950 } catch ( Exception
$e ) {
1951 $dbw->rollback( __METHOD__
);
1954 $dbw->commit( __METHOD__
);
1956 // Update links, etc.
1957 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1959 $hook_args = array( &$this, &$user, $content, $summary,
1960 $flags & EDIT_MINOR
, null, null, &$flags, $revision );
1962 ContentHandler
::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1963 Hooks
::run( 'PageContentInsertComplete', $hook_args );
1966 // Do updates right now unless deferral was requested
1967 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
1968 DeferredUpdates
::doUpdates();
1971 // Return the new revision (or null) to the caller
1972 $status->value
['revision'] = $revision;
1974 $hook_args = array( &$this, &$user, $content, $summary,
1975 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId );
1977 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1978 Hooks
::run( 'PageContentSaveComplete', $hook_args );
1980 // Promote user to any groups they meet the criteria for
1981 $dbw->onTransactionIdle( function () use ( $user ) {
1982 $user->addAutopromoteOnceGroups( 'onEdit' );
1983 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1990 * Get parser options suitable for rendering the primary article wikitext
1992 * @see ContentHandler::makeParserOptions
1994 * @param IContextSource|User|string $context One of the following:
1995 * - IContextSource: Use the User and the Language of the provided
1997 * - User: Use the provided User object and $wgLang for the language,
1998 * so use an IContextSource object if possible.
1999 * - 'canonical': Canonical options (anonymous user with default
2000 * preferences and content language).
2001 * @return ParserOptions
2003 public function makeParserOptions( $context ) {
2004 $options = $this->getContentHandler()->makeParserOptions( $context );
2006 if ( $this->getTitle()->isConversionTable() ) {
2007 // @todo ConversionTable should become a separate content model, so
2008 // we don't need special cases like this one.
2009 $options->disableContentConversion();
2016 * Prepare text which is about to be saved.
2017 * Returns a stdClass with source, pst and output members
2019 * @deprecated since 1.21: use prepareContentForEdit instead.
2022 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
2023 ContentHandler
::deprecated( __METHOD__
, '1.21' );
2024 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2025 return $this->prepareContentForEdit( $content, $revid, $user );
2029 * Prepare content which is about to be saved.
2030 * Returns a stdClass with source, pst and output members
2032 * @param Content $content
2033 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2034 * revision ID is also accepted, but this is deprecated.
2035 * @param User|null $user
2036 * @param string|null $serialFormat
2037 * @param bool $useCache Check shared prepared edit cache
2043 public function prepareContentForEdit(
2044 Content
$content, $revision = null, User
$user = null, $serialFormat = null, $useCache = true
2046 global $wgContLang, $wgUser, $wgAjaxEditStash;
2048 if ( is_object( $revision ) ) {
2049 $revid = $revision->getId();
2052 // This code path is deprecated, and nothing is known to
2053 // use it, so performance here shouldn't be a worry.
2054 if ( $revid !== null ) {
2055 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
2061 $user = is_null( $user ) ?
$wgUser : $user;
2062 //XXX: check $user->getId() here???
2064 // Use a sane default for $serialFormat, see bug 57026
2065 if ( $serialFormat === null ) {
2066 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2069 if ( $this->mPreparedEdit
2070 && $this->mPreparedEdit
->newContent
2071 && $this->mPreparedEdit
->newContent
->equals( $content )
2072 && $this->mPreparedEdit
->revid
== $revid
2073 && $this->mPreparedEdit
->format
== $serialFormat
2074 // XXX: also check $user here?
2077 return $this->mPreparedEdit
;
2080 // The edit may have already been prepared via api.php?action=stashedit
2081 $cachedEdit = $useCache && $wgAjaxEditStash
2082 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2085 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2086 Hooks
::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2088 $edit = (object)array();
2089 if ( $cachedEdit ) {
2090 $edit->timestamp
= $cachedEdit->timestamp
;
2092 $edit->timestamp
= wfTimestampNow();
2094 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2095 $edit->revid
= $revid;
2097 if ( $cachedEdit ) {
2098 $edit->pstContent
= $cachedEdit->pstContent
;
2100 $edit->pstContent
= $content
2101 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2105 $edit->format
= $serialFormat;
2106 $edit->popts
= $this->makeParserOptions( 'canonical' );
2107 if ( $cachedEdit ) {
2108 $edit->output
= $cachedEdit->output
;
2111 // We get here if vary-revision is set. This means that this page references
2112 // itself (such as via self-transclusion). In this case, we need to make sure
2113 // that any such self-references refer to the newly-saved revision, and not
2114 // to the previous one, which could otherwise happen due to slave lag.
2115 $oldCallback = $edit->popts
->setCurrentRevisionCallback(
2116 function ( $title, $parser = false ) use ( $revision, &$oldCallback ) {
2117 if ( $title->equals( $revision->getTitle() ) ) {
2120 return call_user_func(
2129 $edit->output
= $edit->pstContent
2130 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2134 $edit->newContent
= $content;
2135 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2137 // NOTE: B/C for hooks! don't use these fields!
2138 $edit->newText
= $edit->newContent ? ContentHandler
::getContentText( $edit->newContent
) : '';
2139 $edit->oldText
= $edit->oldContent ? ContentHandler
::getContentText( $edit->oldContent
) : '';
2140 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2142 $this->mPreparedEdit
= $edit;
2147 * Do standard deferred updates after page edit.
2148 * Update links tables, site stats, search index and message cache.
2149 * Purges pages that include this page if the text was changed here.
2150 * Every 100th edit, prune the recent changes table.
2152 * @param Revision $revision
2153 * @param User $user User object that did the revision
2154 * @param array $options Array of options, following indexes are used:
2155 * - changed: boolean, whether the revision changed the content (default true)
2156 * - created: boolean, whether the revision created the page (default false)
2157 * - moved: boolean, whether the page was moved (default false)
2158 * - oldcountable: boolean, null, or string 'no-change' (default null):
2159 * - boolean: whether the page was counted as an article before that
2160 * revision, only used in changed is true and created is false
2161 * - null: if created is false, don't update the article count; if created
2162 * is true, do update the article count
2163 * - 'no-change': don't update the article count, ever
2165 public function doEditUpdates( Revision
$revision, User
$user, array $options = array() ) {
2166 global $wgEnableParserCache;
2172 'oldcountable' => null
2174 $content = $revision->getContent();
2177 // Be careful not to do pre-save transform twice: $text is usually
2178 // already pre-save transformed once.
2179 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2180 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
2181 $editInfo = $this->prepareContentForEdit( $content, $revision, $user );
2183 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
2184 $editInfo = $this->mPreparedEdit
;
2187 // Save it to the parser cache
2188 if ( $wgEnableParserCache ) {
2189 $parserCache = ParserCache
::singleton();
2191 $editInfo->output
, $this, $editInfo->popts
, $editInfo->timestamp
, $editInfo->revid
2195 // Update the links tables and other secondary data
2197 $recursive = $options['changed']; // bug 50785
2198 $updates = $content->getSecondaryDataUpdates(
2199 $this->getTitle(), null, $recursive, $editInfo->output
);
2200 DataUpdate
::runUpdates( $updates );
2203 Hooks
::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2205 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2206 // Flush old entries from the `recentchanges` table
2207 JobQueueGroup
::singleton()->push( RecentChangesUpdateJob
::newPurgeJob() );
2210 if ( !$this->exists() ) {
2214 $id = $this->getId();
2215 $title = $this->mTitle
->getPrefixedDBkey();
2216 $shortTitle = $this->mTitle
->getDBkey();
2218 if ( $options['oldcountable'] === 'no-change' ||
2219 ( !$options['changed'] && !$options['moved'] )
2222 } elseif ( $options['created'] ) {
2223 $good = (int)$this->isCountable( $editInfo );
2224 } elseif ( $options['oldcountable'] !== null ) {
2225 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2229 $edits = $options['changed'] ?
1 : 0;
2230 $total = $options['created'] ?
1 : 0;
2232 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2233 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2235 // If this is another user's talk page, update newtalk.
2236 // Don't do this if $options['changed'] = false (null-edits) nor if
2237 // it's a minor edit and the user doesn't want notifications for those.
2238 if ( $options['changed']
2239 && $this->mTitle
->getNamespace() == NS_USER_TALK
2240 && $shortTitle != $user->getTitleKey()
2241 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2243 $recipient = User
::newFromName( $shortTitle, false );
2244 if ( !$recipient ) {
2245 wfDebug( __METHOD__
. ": invalid username\n" );
2247 // Allow extensions to prevent user notification when a new message is added to their talk page
2248 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2249 if ( User
::isIP( $shortTitle ) ) {
2250 // An anonymous user
2251 $recipient->setNewtalk( true, $revision );
2252 } elseif ( $recipient->isLoggedIn() ) {
2253 $recipient->setNewtalk( true, $revision );
2255 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2261 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2262 // XXX: could skip pseudo-messages like js/css here, based on content model.
2263 $msgtext = $content ?
$content->getWikitextForTransclusion() : null;
2264 if ( $msgtext === false ||
$msgtext === null ) {
2268 MessageCache
::singleton()->replace( $shortTitle, $msgtext );
2271 if ( $options['created'] ) {
2272 self
::onArticleCreate( $this->mTitle
);
2273 } elseif ( $options['changed'] ) { // bug 50785
2274 self
::onArticleEdit( $this->mTitle
);
2280 * Edit an article without doing all that other stuff
2281 * The article must already exist; link tables etc
2282 * are not updated, caches are not flushed.
2284 * @param string $text Text submitted
2285 * @param User $user The relevant user
2286 * @param string $comment Comment submitted
2287 * @param bool $minor Whereas it's a minor modification
2289 * @deprecated since 1.21, use doEditContent() instead.
2291 public function doQuickEdit( $text, User
$user, $comment = '', $minor = 0 ) {
2292 ContentHandler
::deprecated( __METHOD__
, "1.21" );
2294 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2295 $this->doQuickEditContent( $content, $user, $comment, $minor );
2299 * Edit an article without doing all that other stuff
2300 * The article must already exist; link tables etc
2301 * are not updated, caches are not flushed.
2303 * @param Content $content Content submitted
2304 * @param User $user The relevant user
2305 * @param string $comment Comment submitted
2306 * @param bool $minor Whereas it's a minor modification
2307 * @param string $serialFormat Format for storing the content in the database
2309 public function doQuickEditContent( Content
$content, User
$user, $comment = '', $minor = false,
2310 $serialFormat = null
2313 $serialized = $content->serialize( $serialFormat );
2315 $dbw = wfGetDB( DB_MASTER
);
2316 $revision = new Revision( array(
2317 'title' => $this->getTitle(), // for determining the default content model
2318 'page' => $this->getId(),
2319 'user_text' => $user->getName(),
2320 'user' => $user->getId(),
2321 'text' => $serialized,
2322 'length' => $content->getSize(),
2323 'comment' => $comment,
2324 'minor_edit' => $minor ?
1 : 0,
2325 ) ); // XXX: set the content object?
2326 $revision->insertOn( $dbw );
2327 $this->updateRevisionOn( $dbw, $revision );
2329 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2334 * Update the article's restriction field, and leave a log entry.
2335 * This works for protection both existing and non-existing pages.
2337 * @param array $limit Set of restriction keys
2338 * @param array $expiry Per restriction type expiration
2339 * @param int &$cascade Set to false if cascading protection isn't allowed.
2340 * @param string $reason
2341 * @param User $user The user updating the restrictions
2344 public function doUpdateRestrictions( array $limit, array $expiry,
2345 &$cascade, $reason, User
$user
2347 global $wgCascadingRestrictionLevels, $wgContLang;
2349 if ( wfReadOnly() ) {
2350 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
2353 $this->loadPageData( 'fromdbmaster' );
2354 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2355 $id = $this->getId();
2361 // Take this opportunity to purge out expired restrictions
2362 Title
::purgeExpiredRestrictions();
2364 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2365 // we expect a single selection, but the schema allows otherwise.
2366 $isProtected = false;
2370 $dbw = wfGetDB( DB_MASTER
);
2372 foreach ( $restrictionTypes as $action ) {
2373 if ( !isset( $expiry[$action] ) ) {
2374 $expiry[$action] = $dbw->getInfinity();
2376 if ( !isset( $limit[$action] ) ) {
2377 $limit[$action] = '';
2378 } elseif ( $limit[$action] != '' ) {
2382 // Get current restrictions on $action
2383 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2384 if ( $current != '' ) {
2385 $isProtected = true;
2388 if ( $limit[$action] != $current ) {
2390 } elseif ( $limit[$action] != '' ) {
2391 // Only check expiry change if the action is actually being
2392 // protected, since expiry does nothing on an not-protected
2394 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2400 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2404 // If nothing has changed, do nothing
2406 return Status
::newGood();
2409 if ( !$protect ) { // No protection at all means unprotection
2410 $revCommentMsg = 'unprotectedarticle';
2411 $logAction = 'unprotect';
2412 } elseif ( $isProtected ) {
2413 $revCommentMsg = 'modifiedarticleprotection';
2414 $logAction = 'modify';
2416 $revCommentMsg = 'protectedarticle';
2417 $logAction = 'protect';
2420 // Truncate for whole multibyte characters
2421 $reason = $wgContLang->truncate( $reason, 255 );
2423 $logRelationsValues = array();
2424 $logRelationsField = null;
2426 if ( $id ) { // Protection of existing page
2427 if ( !Hooks
::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2428 return Status
::newGood();
2431 // Only certain restrictions can cascade...
2432 $editrestriction = isset( $limit['edit'] )
2433 ?
array( $limit['edit'] )
2434 : $this->mTitle
->getRestrictions( 'edit' );
2435 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2436 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2438 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2439 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2442 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2443 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2444 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2446 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2447 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2450 // The schema allows multiple restrictions
2451 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2455 // insert null revision to identify the page protection change as edit summary
2456 $latest = $this->getLatest();
2457 $nullRevision = $this->insertProtectNullRevision(
2466 if ( $nullRevision === null ) {
2467 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2470 $logRelationsField = 'pr_id';
2472 // Update restrictions table
2473 foreach ( $limit as $action => $restrictions ) {
2475 'page_restrictions',
2478 'pr_type' => $action
2482 if ( $restrictions != '' ) {
2484 'page_restrictions',
2486 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2488 'pr_type' => $action,
2489 'pr_level' => $restrictions,
2490 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2491 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2495 $logRelationsValues[] = $dbw->insertId();
2499 // Clear out legacy restriction fields
2502 array( 'page_restrictions' => '' ),
2503 array( 'page_id' => $id ),
2507 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2508 Hooks
::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2509 } else { // Protection of non-existing page (also known as "title protection")
2510 // Cascade protection is meaningless in this case
2513 if ( $limit['create'] != '' ) {
2514 $dbw->replace( 'protected_titles',
2515 array( array( 'pt_namespace', 'pt_title' ) ),
2517 'pt_namespace' => $this->mTitle
->getNamespace(),
2518 'pt_title' => $this->mTitle
->getDBkey(),
2519 'pt_create_perm' => $limit['create'],
2520 'pt_timestamp' => $dbw->timestamp(),
2521 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2522 'pt_user' => $user->getId(),
2523 'pt_reason' => $reason,
2527 $dbw->delete( 'protected_titles',
2529 'pt_namespace' => $this->mTitle
->getNamespace(),
2530 'pt_title' => $this->mTitle
->getDBkey()
2536 $this->mTitle
->flushRestrictions();
2537 InfoAction
::invalidateCache( $this->mTitle
);
2539 if ( $logAction == 'unprotect' ) {
2542 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2543 $params = array( $protectDescriptionLog, $cascade ?
'cascade' : '' );
2546 // Update the protection log
2547 $log = new LogPage( 'protect' );
2548 $logId = $log->addEntry( $logAction, $this->mTitle
, $reason, $params, $user );
2549 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2550 $log->addRelations( $logRelationsField, $logRelationsValues, $logId );
2553 return Status
::newGood();
2557 * Insert a new null revision for this page.
2559 * @param string $revCommentMsg Comment message key for the revision
2560 * @param array $limit Set of restriction keys
2561 * @param array $expiry Per restriction type expiration
2562 * @param int $cascade Set to false if cascading protection isn't allowed.
2563 * @param string $reason
2564 * @param User|null $user
2565 * @return Revision|null Null on error
2567 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2568 array $expiry, $cascade, $reason, $user = null
2571 $dbw = wfGetDB( DB_MASTER
);
2573 // Prepare a null revision to be added to the history
2574 $editComment = $wgContLang->ucfirst(
2577 $this->mTitle
->getPrefixedText()
2578 )->inContentLanguage()->text()
2581 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2583 $protectDescription = $this->protectDescription( $limit, $expiry );
2584 if ( $protectDescription ) {
2585 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2586 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2587 ->inContentLanguage()->text();
2590 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2591 $editComment .= wfMessage( 'brackets' )->params(
2592 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2593 )->inContentLanguage()->text();
2596 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2598 $nullRev->insertOn( $dbw );
2600 // Update page record and touch page
2601 $oldLatest = $nullRev->getParentId();
2602 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2609 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2612 protected function formatExpiry( $expiry ) {
2614 $dbr = wfGetDB( DB_SLAVE
);
2616 $encodedExpiry = $dbr->encodeExpiry( $expiry );
2617 if ( $encodedExpiry != 'infinity' ) {
2620 $wgContLang->timeanddate( $expiry, false, false ),
2621 $wgContLang->date( $expiry, false, false ),
2622 $wgContLang->time( $expiry, false, false )
2623 )->inContentLanguage()->text();
2625 return wfMessage( 'protect-expiry-indefinite' )
2626 ->inContentLanguage()->text();
2631 * Builds the description to serve as comment for the edit.
2633 * @param array $limit Set of restriction keys
2634 * @param array $expiry Per restriction type expiration
2637 public function protectDescription( array $limit, array $expiry ) {
2638 $protectDescription = '';
2640 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2641 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2642 # All possible message keys are listed here for easier grepping:
2643 # * restriction-create
2644 # * restriction-edit
2645 # * restriction-move
2646 # * restriction-upload
2647 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2648 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2649 # with '' filtered out. All possible message keys are listed below:
2650 # * protect-level-autoconfirmed
2651 # * protect-level-sysop
2652 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2654 $expiryText = $this->formatExpiry( $expiry[$action] );
2656 if ( $protectDescription !== '' ) {
2657 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2659 $protectDescription .= wfMessage( 'protect-summary-desc' )
2660 ->params( $actionText, $restrictionsText, $expiryText )
2661 ->inContentLanguage()->text();
2664 return $protectDescription;
2668 * Builds the description to serve as comment for the log entry.
2670 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2671 * protect description text. Keep them in old format to avoid breaking compatibility.
2672 * TODO: Fix protection log to store structured description and format it on-the-fly.
2674 * @param array $limit Set of restriction keys
2675 * @param array $expiry Per restriction type expiration
2678 public function protectDescriptionLog( array $limit, array $expiry ) {
2681 $protectDescriptionLog = '';
2683 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2684 $expiryText = $this->formatExpiry( $expiry[$action] );
2685 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] ($expiryText)";
2688 return trim( $protectDescriptionLog );
2692 * Take an array of page restrictions and flatten it to a string
2693 * suitable for insertion into the page_restrictions field.
2695 * @param string[] $limit
2697 * @throws MWException
2700 protected static function flattenRestrictions( $limit ) {
2701 if ( !is_array( $limit ) ) {
2702 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2708 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2709 $bits[] = "$action=$restrictions";
2712 return implode( ':', $bits );
2716 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2717 * backwards compatibility, if you care about error reporting you should use
2718 * doDeleteArticleReal() instead.
2720 * Deletes the article with database consistency, writes logs, purges caches
2722 * @param string $reason Delete reason for deletion log
2723 * @param bool $suppress Suppress all revisions and log the deletion in
2724 * the suppression log instead of the deletion log
2725 * @param int $id Article ID
2726 * @param bool $commit Defaults to true, triggers transaction end
2727 * @param array &$error Array of errors to append to
2728 * @param User $user The deleting user
2729 * @return bool True if successful
2731 public function doDeleteArticle(
2732 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2734 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2735 return $status->isGood();
2739 * Back-end article deletion
2740 * Deletes the article with database consistency, writes logs, purges caches
2744 * @param string $reason Delete reason for deletion log
2745 * @param bool $suppress Suppress all revisions and log the deletion in
2746 * the suppression log instead of the deletion log
2747 * @param int $id Article ID
2748 * @param bool $commit Defaults to true, triggers transaction end
2749 * @param array &$error Array of errors to append to
2750 * @param User $user The deleting user
2751 * @return Status Status object; if successful, $status->value is the log_id of the
2752 * deletion log entry. If the page couldn't be deleted because it wasn't
2753 * found, $status is a non-fatal 'cannotdelete' error
2755 public function doDeleteArticleReal(
2756 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2758 global $wgUser, $wgContentHandlerUseDB;
2760 wfDebug( __METHOD__
. "\n" );
2762 $status = Status
::newGood();
2764 if ( $this->mTitle
->getDBkey() === '' ) {
2765 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2769 $user = is_null( $user ) ?
$wgUser : $user;
2770 if ( !Hooks
::run( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2771 if ( $status->isOK() ) {
2772 // Hook aborted but didn't set a fatal status
2773 $status->fatal( 'delete-hook-aborted' );
2778 $dbw = wfGetDB( DB_MASTER
);
2779 $dbw->begin( __METHOD__
);
2782 $this->loadPageData( 'forupdate' );
2783 $id = $this->getID();
2785 $dbw->rollback( __METHOD__
);
2786 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2791 // we need to remember the old content so we can use it to generate all deletion updates.
2792 $content = $this->getContent( Revision
::RAW
);
2794 // Bitfields to further suppress the content
2797 // This should be 15...
2798 $bitfield |
= Revision
::DELETED_TEXT
;
2799 $bitfield |
= Revision
::DELETED_COMMENT
;
2800 $bitfield |
= Revision
::DELETED_USER
;
2801 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2803 $bitfield = 'rev_deleted';
2806 // For now, shunt the revision data into the archive table.
2807 // Text is *not* removed from the text table; bulk storage
2808 // is left intact to avoid breaking block-compression or
2809 // immutable storage schemes.
2811 // For backwards compatibility, note that some older archive
2812 // table entries will have ar_text and ar_flags fields still.
2814 // In the future, we may keep revisions and mark them with
2815 // the rev_deleted field, which is reserved for this purpose.
2818 'ar_namespace' => 'page_namespace',
2819 'ar_title' => 'page_title',
2820 'ar_comment' => 'rev_comment',
2821 'ar_user' => 'rev_user',
2822 'ar_user_text' => 'rev_user_text',
2823 'ar_timestamp' => 'rev_timestamp',
2824 'ar_minor_edit' => 'rev_minor_edit',
2825 'ar_rev_id' => 'rev_id',
2826 'ar_parent_id' => 'rev_parent_id',
2827 'ar_text_id' => 'rev_text_id',
2828 'ar_text' => '\'\'', // Be explicit to appease
2829 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2830 'ar_len' => 'rev_len',
2831 'ar_page_id' => 'page_id',
2832 'ar_deleted' => $bitfield,
2833 'ar_sha1' => 'rev_sha1',
2836 if ( $wgContentHandlerUseDB ) {
2837 $row['ar_content_model'] = 'rev_content_model';
2838 $row['ar_content_format'] = 'rev_content_format';
2841 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2845 'page_id = rev_page'
2849 // Now that it's safely backed up, delete it
2850 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2851 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2854 $dbw->rollback( __METHOD__
);
2855 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2859 if ( !$dbw->cascadingDeletes() ) {
2860 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
2863 // Clone the title, so we have the information we need when we log
2864 $logTitle = clone $this->mTitle
;
2866 // Log the deletion, if the page was suppressed, log it at Oversight instead
2867 $logtype = $suppress ?
'suppress' : 'delete';
2869 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2870 $logEntry->setPerformer( $user );
2871 $logEntry->setTarget( $logTitle );
2872 $logEntry->setComment( $reason );
2873 $logid = $logEntry->insert();
2875 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2876 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2877 $logEntry->publish( $logid );
2881 $dbw->commit( __METHOD__
);
2884 $this->doDeleteUpdates( $id, $content );
2886 Hooks
::run( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2887 $status->value
= $logid;
2892 * Do some database updates after deletion
2894 * @param int $id The page_id value of the page being deleted
2895 * @param Content $content Optional page content to be used when determining
2896 * the required updates. This may be needed because $this->getContent()
2897 * may already return null when the page proper was deleted.
2899 public function doDeleteUpdates( $id, Content
$content = null ) {
2900 // update site status
2901 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2903 // remove secondary indexes, etc
2904 $updates = $this->getDeletionUpdates( $content );
2905 DataUpdate
::runUpdates( $updates );
2907 // Reparse any pages transcluding this page
2908 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
2910 // Reparse any pages including this image
2911 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
2912 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
2916 WikiPage
::onArticleDelete( $this->mTitle
);
2918 // Reset this object and the Title object
2919 $this->loadFromRow( false, self
::READ_LATEST
);
2922 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
2926 * Roll back the most recent consecutive set of edits to a page
2927 * from the same user; fails if there are no eligible edits to
2928 * roll back to, e.g. user is the sole contributor. This function
2929 * performs permissions checks on $user, then calls commitRollback()
2930 * to do the dirty work
2932 * @todo Separate the business/permission stuff out from backend code
2934 * @param string $fromP Name of the user whose edits to rollback.
2935 * @param string $summary Custom summary. Set to default summary if empty.
2936 * @param string $token Rollback token.
2937 * @param bool $bot If true, mark all reverted edits as bot.
2939 * @param array $resultDetails Array contains result-specific array of additional values
2940 * 'alreadyrolled' : 'current' (rev)
2941 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2943 * @param User $user The user performing the rollback
2944 * @return array Array of errors, each error formatted as
2945 * array(messagekey, param1, param2, ...).
2946 * On success, the array is empty. This array can also be passed to
2947 * OutputPage::showPermissionsErrorPage().
2949 public function doRollback(
2950 $fromP, $summary, $token, $bot, &$resultDetails, User
$user
2952 $resultDetails = null;
2954 // Check permissions
2955 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
2956 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
2957 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2959 if ( !$user->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
2960 $errors[] = array( 'sessionfailure' );
2963 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
2964 $errors[] = array( 'actionthrottledtext' );
2967 // If there were errors, bail out now
2968 if ( !empty( $errors ) ) {
2972 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2976 * Backend implementation of doRollback(), please refer there for parameter
2977 * and return value documentation
2979 * NOTE: This function does NOT check ANY permissions, it just commits the
2980 * rollback to the DB. Therefore, you should only call this function direct-
2981 * ly if you want to use custom permissions checks. If you don't, use
2982 * doRollback() instead.
2983 * @param string $fromP Name of the user whose edits to rollback.
2984 * @param string $summary Custom summary. Set to default summary if empty.
2985 * @param bool $bot If true, mark all reverted edits as bot.
2987 * @param array $resultDetails Contains result-specific array of additional values
2988 * @param User $guser The user performing the rollback
2991 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser ) {
2992 global $wgUseRCPatrol, $wgContLang;
2994 $dbw = wfGetDB( DB_MASTER
);
2996 if ( wfReadOnly() ) {
2997 return array( array( 'readonlytext' ) );
3000 // Get the last editor
3001 $current = $this->getRevision();
3002 if ( is_null( $current ) ) {
3003 // Something wrong... no page?
3004 return array( array( 'notanarticle' ) );
3007 $from = str_replace( '_', ' ', $fromP );
3008 // User name given should match up with the top revision.
3009 // If the user was deleted then $from should be empty.
3010 if ( $from != $current->getUserText() ) {
3011 $resultDetails = array( 'current' => $current );
3012 return array( array( 'alreadyrolled',
3013 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3014 htmlspecialchars( $fromP ),
3015 htmlspecialchars( $current->getUserText() )
3019 // Get the last edit not by this guy...
3020 // Note: these may not be public values
3021 $user = intval( $current->getUser( Revision
::RAW
) );
3022 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3023 $s = $dbw->selectRow( 'revision',
3024 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3025 array( 'rev_page' => $current->getPage(),
3026 "rev_user != {$user} OR rev_user_text != {$user_text}"
3028 array( 'USE INDEX' => 'page_timestamp',
3029 'ORDER BY' => 'rev_timestamp DESC' )
3031 if ( $s === false ) {
3032 // No one else ever edited this page
3033 return array( array( 'cantrollback' ) );
3034 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3035 ||
$s->rev_deleted
& Revision
::DELETED_USER
3037 // Only admins can see this text
3038 return array( array( 'notvisiblerev' ) );
3041 // Set patrolling and bot flag on the edits, which gets rollbacked.
3042 // This is done before the rollback edit to have patrolling also on failure (bug 62157).
3044 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3045 // Mark all reverted edits as bot
3049 if ( $wgUseRCPatrol ) {
3050 // Mark all reverted edits as patrolled
3051 $set['rc_patrolled'] = 1;
3054 if ( count( $set ) ) {
3055 $dbw->update( 'recentchanges', $set,
3057 'rc_cur_id' => $current->getPage(),
3058 'rc_user_text' => $current->getUserText(),
3059 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3064 // Generate the edit summary if necessary
3065 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3066 if ( empty( $summary ) ) {
3067 if ( $from == '' ) { // no public user name
3068 $summary = wfMessage( 'revertpage-nouser' );
3070 $summary = wfMessage( 'revertpage' );
3074 // Allow the custom summary to use the same args as the default message
3076 $target->getUserText(), $from, $s->rev_id
,
3077 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3078 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3080 if ( $summary instanceof Message
) {
3081 $summary = $summary->params( $args )->inContentLanguage()->text();
3083 $summary = wfMsgReplaceArgs( $summary, $args );
3086 // Trim spaces on user supplied text
3087 $summary = trim( $summary );
3089 // Truncate for whole multibyte characters.
3090 $summary = $wgContLang->truncate( $summary, 255 );
3093 $flags = EDIT_UPDATE
;
3095 if ( $guser->isAllowed( 'minoredit' ) ) {
3096 $flags |
= EDIT_MINOR
;
3099 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3100 $flags |
= EDIT_FORCE_BOT
;
3103 // Actually store the edit
3104 $status = $this->doEditContent(
3105 $target->getContent(),
3112 if ( !$status->isOK() ) {
3113 return $status->getErrorsArray();
3116 // raise error, when the edit is an edit without a new version
3117 if ( empty( $status->value
['revision'] ) ) {
3118 $resultDetails = array( 'current' => $current );
3119 return array( array( 'alreadyrolled',
3120 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3121 htmlspecialchars( $fromP ),
3122 htmlspecialchars( $current->getUserText() )
3126 $revId = $status->value
['revision']->getId();
3128 Hooks
::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3130 $resultDetails = array(
3131 'summary' => $summary,
3132 'current' => $current,
3133 'target' => $target,
3141 * The onArticle*() functions are supposed to be a kind of hooks
3142 * which should be called whenever any of the specified actions
3145 * This is a good place to put code to clear caches, for instance.
3147 * This is called on page move and undelete, as well as edit
3149 * @param Title $title
3151 public static function onArticleCreate( Title
$title ) {
3152 // Update existence markers on article/talk tabs...
3153 $other = $title->getOtherPage();
3155 $other->invalidateCache();
3156 $other->purgeSquid();
3158 $title->touchLinks();
3159 $title->purgeSquid();
3160 $title->deleteTitleProtection();
3164 * Clears caches when article is deleted
3166 * @param Title $title
3168 public static function onArticleDelete( Title
$title ) {
3169 // Update existence markers on article/talk tabs...
3170 $other = $title->getOtherPage();
3172 $other->invalidateCache();
3173 $other->purgeSquid();
3175 $title->touchLinks();
3176 $title->purgeSquid();
3179 HTMLFileCache
::clearFileCache( $title );
3180 InfoAction
::invalidateCache( $title );
3183 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3184 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3188 if ( $title->getNamespace() == NS_FILE
) {
3189 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3190 $update->doUpdate();
3194 if ( $title->getNamespace() == NS_USER_TALK
) {
3195 $user = User
::newFromName( $title->getText(), false );
3197 $user->setNewtalk( false );
3202 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3206 * Purge caches on page update etc
3208 * @param Title $title
3210 public static function onArticleEdit( Title
$title ) {
3211 // Invalidate caches of articles which include this page
3212 DeferredUpdates
::addHTMLCacheUpdate( $title, 'templatelinks' );
3214 // Invalidate the caches of all pages which redirect here
3215 DeferredUpdates
::addHTMLCacheUpdate( $title, 'redirect' );
3217 // Purge squid for this page only
3218 $title->purgeSquid();
3220 // Clear file cache for this page only
3221 HTMLFileCache
::clearFileCache( $title );
3222 InfoAction
::invalidateCache( $title );
3228 * Returns a list of categories this page is a member of.
3229 * Results will include hidden categories
3231 * @return TitleArray
3233 public function getCategories() {
3234 $id = $this->getId();
3236 return TitleArray
::newFromResult( new FakeResultWrapper( array() ) );
3239 $dbr = wfGetDB( DB_SLAVE
);
3240 $res = $dbr->select( 'categorylinks',
3241 array( 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ),
3242 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3243 // as not being aliases, and NS_CATEGORY is numeric
3244 array( 'cl_from' => $id ),
3247 return TitleArray
::newFromResult( $res );
3251 * Returns a list of hidden categories this page is a member of.
3252 * Uses the page_props and categorylinks tables.
3254 * @return array Array of Title objects
3256 public function getHiddenCategories() {
3258 $id = $this->getId();
3264 $dbr = wfGetDB( DB_SLAVE
);
3265 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3267 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3268 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
3271 if ( $res !== false ) {
3272 foreach ( $res as $row ) {
3273 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3281 * Return an applicable autosummary if one exists for the given edit.
3282 * @param string|null $oldtext The previous text of the page.
3283 * @param string|null $newtext The submitted text of the page.
3284 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3285 * @return string An appropriate autosummary, or an empty string.
3287 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3289 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3290 // NOTE: stub for backwards-compatibility. assumes the given text is
3291 // wikitext. will break horribly if it isn't.
3293 ContentHandler
::deprecated( __METHOD__
, '1.21' );
3295 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
3296 $oldContent = is_null( $oldtext ) ?
null : $handler->unserializeContent( $oldtext );
3297 $newContent = is_null( $newtext ) ?
null : $handler->unserializeContent( $newtext );
3299 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3303 * Auto-generates a deletion reason
3305 * @param bool &$hasHistory Whether the page has a history
3306 * @return string|bool String containing deletion reason or empty string, or boolean false
3307 * if no revision occurred
3309 public function getAutoDeleteReason( &$hasHistory ) {
3310 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3314 * Update all the appropriate counts in the category table, given that
3315 * we've added the categories $added and deleted the categories $deleted.
3317 * @param array $added The names of categories that were added
3318 * @param array $deleted The names of categories that were deleted
3320 public function updateCategoryCounts( array $added, array $deleted ) {
3322 $method = __METHOD__
;
3323 $dbw = wfGetDB( DB_MASTER
);
3325 // Do this at the end of the commit to reduce lock wait timeouts
3326 $dbw->onTransactionPreCommitOrIdle(
3327 function () use ( $dbw, $that, $method, $added, $deleted ) {
3328 $ns = $that->getTitle()->getNamespace();
3330 $addFields = array( 'cat_pages = cat_pages + 1' );
3331 $removeFields = array( 'cat_pages = cat_pages - 1' );
3332 if ( $ns == NS_CATEGORY
) {
3333 $addFields[] = 'cat_subcats = cat_subcats + 1';
3334 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3335 } elseif ( $ns == NS_FILE
) {
3336 $addFields[] = 'cat_files = cat_files + 1';
3337 $removeFields[] = 'cat_files = cat_files - 1';
3340 if ( count( $added ) ) {
3341 $insertRows = array();
3342 foreach ( $added as $cat ) {
3343 $insertRows[] = array(
3344 'cat_title' => $cat,
3346 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3347 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3353 array( 'cat_title' ),
3359 if ( count( $deleted ) ) {
3363 array( 'cat_title' => $deleted ),
3368 foreach ( $added as $catName ) {
3369 $cat = Category
::newFromName( $catName );
3370 Hooks
::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3373 foreach ( $deleted as $catName ) {
3374 $cat = Category
::newFromName( $catName );
3375 Hooks
::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3382 * Opportunistically enqueue link update jobs given fresh parser output if useful
3384 * @param ParserOutput $parserOutput Current version page output
3387 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3388 if ( wfReadOnly() ) {
3392 if ( !Hooks
::run( 'OpportunisticLinksUpdate', array( $this, $this->mTitle
, $parserOutput ) ) ) {
3396 if ( $this->mTitle
->areRestrictionsCascading() ) {
3397 // If the page is cascade protecting, the links should really be up-to-date
3398 $params = array( 'prioritize' => true );
3399 } elseif ( $parserOutput->hasDynamicContent() ) {
3400 // Assume the output contains time/random based magic words
3403 // If the inclusions are deterministic, the edit-triggered link jobs are enough
3407 // Check if the last link refresh was before page_touched
3408 if ( $this->getLinksTimestamp() < $this->getTouched() ) {
3409 JobQueueGroup
::singleton()->push( EnqueueJob
::newFromLocalJobs(
3410 new JobSpecification( 'refreshLinks', $params, array(), $this->mTitle
)
3419 * Return a list of templates used by this article.
3420 * Uses the templatelinks table
3422 * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3423 * @return array Array of Title objects
3425 public function getUsedTemplates() {
3426 return $this->mTitle
->getTemplateLinksFrom();
3430 * This function is called right before saving the wikitext,
3431 * so we can do things like signatures and links-in-context.
3433 * @deprecated since 1.19; use Parser::preSaveTransform() instead
3434 * @param string $text Article contents
3435 * @param User $user User doing the edit
3436 * @param ParserOptions $popts Parser options, default options for
3437 * the user loaded if null given
3438 * @return string Article contents with altered wikitext markup (signatures
3439 * converted, {{subst:}}, templates, etc.)
3441 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
3442 global $wgParser, $wgUser;
3444 wfDeprecated( __METHOD__
, '1.19' );
3446 $user = is_null( $user ) ?
$wgUser : $user;
3448 if ( $popts === null ) {
3449 $popts = ParserOptions
::newFromUser( $user );
3452 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
3456 * Update the article's restriction field, and leave a log entry.
3458 * @deprecated since 1.19
3459 * @param array $limit Set of restriction keys
3460 * @param string $reason
3461 * @param int &$cascade Set to false if cascading protection isn't allowed.
3462 * @param array $expiry Per restriction type expiration
3463 * @param User $user The user updating the restrictions
3464 * @return bool True on success
3466 public function updateRestrictions(
3467 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User
$user = null
3471 $user = is_null( $user ) ?
$wgUser : $user;
3473 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3477 * Returns a list of updates to be performed when this page is deleted. The
3478 * updates should remove any information about this page from secondary data
3479 * stores such as links tables.
3481 * @param Content|null $content Optional Content object for determining the
3482 * necessary updates.
3483 * @return array An array of DataUpdates objects
3485 public function getDeletionUpdates( Content
$content = null ) {
3487 // load content object, which may be used to determine the necessary updates
3488 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3489 $content = $this->getContent( Revision
::RAW
);
3495 $updates = $content->getDeletionUpdates( $this );
3498 Hooks
::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );