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 * @internal documentation reviewed 15 Mar 2010
37 class WikiPage
implements Page
, IDBAccessObject
{
38 // Constants for $mDataLoadedFrom and related
43 public $mTitle = null;
48 public $mDataLoaded = false; // !< Boolean
49 public $mIsRedirect = false; // !< Boolean
50 public $mLatest = false; // !< Integer (false means "not loaded")
53 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
54 public $mPreparedEdit = false;
59 protected $mId = null;
62 * @var int One of the READ_* constants
64 protected $mDataLoadedFrom = self
::READ_NONE
;
69 protected $mRedirectTarget = null;
74 protected $mLastRevision = null;
77 * @var string Timestamp of the current revision or empty string if not loaded
79 protected $mTimestamp = '';
84 protected $mTouched = '19700101000000';
89 protected $mLinksUpdated = '19700101000000';
92 * Constructor and clear the article
93 * @param Title $title Reference to a Title object.
95 public function __construct( Title
$title ) {
96 $this->mTitle
= $title;
100 * Create a WikiPage object of the appropriate class for the given title.
102 * @param Title $title
104 * @throws MWException
105 * @return WikiPage Object of the appropriate type
107 public static function factory( Title
$title ) {
108 $ns = $title->getNamespace();
110 if ( $ns == NS_MEDIA
) {
111 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
112 } elseif ( $ns < 0 ) {
113 throw new MWException( "Invalid or virtual namespace $ns given." );
118 $page = new WikiFilePage( $title );
121 $page = new WikiCategoryPage( $title );
124 $page = new WikiPage( $title );
131 * Constructor from a page id
133 * @param int $id Article ID to load
134 * @param string|int $from One of the following values:
135 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
136 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
138 * @return WikiPage|null
140 public static function newFromID( $id, $from = 'fromdb' ) {
141 // page id's are never 0 or negative, see bug 61166
146 $from = self
::convertSelectType( $from );
147 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_SLAVE
);
148 $row = $db->selectRow( 'page', self
::selectFields(), array( 'page_id' => $id ), __METHOD__
);
152 return self
::newFromRow( $row, $from );
156 * Constructor from a database row
159 * @param object $row Database row containing at least fields returned by selectFields().
160 * @param string|int $from Source of $data:
161 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
162 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
163 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
166 public static function newFromRow( $row, $from = 'fromdb' ) {
167 $page = self
::factory( Title
::newFromRow( $row ) );
168 $page->loadFromRow( $row, $from );
173 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
175 * @param object|string|int $type
178 private static function convertSelectType( $type ) {
181 return self
::READ_NORMAL
;
183 return self
::READ_LATEST
;
185 return self
::READ_LOCKING
;
187 // It may already be an integer or whatever else
193 * Returns overrides for action handlers.
194 * Classes listed here will be used instead of the default one when
195 * (and only when) $wgActions[$action] === true. This allows subclasses
196 * to override the default behavior.
198 * @todo Move this UI stuff somewhere else
202 public function getActionOverrides() {
203 $content_handler = $this->getContentHandler();
204 return $content_handler->getActionOverrides();
208 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
210 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
212 * @return ContentHandler
216 public function getContentHandler() {
217 return ContentHandler
::getForModelID( $this->getContentModel() );
221 * Get the title object of the article
222 * @return Title Title object of this page
224 public function getTitle() {
225 return $this->mTitle
;
232 public function clear() {
233 $this->mDataLoaded
= false;
234 $this->mDataLoadedFrom
= self
::READ_NONE
;
236 $this->clearCacheFields();
240 * Clear the object cache fields
243 protected function clearCacheFields() {
245 $this->mRedirectTarget
= null; // Title object if set
246 $this->mLastRevision
= null; // Latest revision
247 $this->mTouched
= '19700101000000';
248 $this->mLinksUpdated
= '19700101000000';
249 $this->mTimestamp
= '';
250 $this->mIsRedirect
= false;
251 $this->mLatest
= false;
252 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
253 // the requested rev ID and content against the cached one for equality. For most
254 // content types, the output should not change during the lifetime of this cache.
255 // Clearing it can cause extra parses on edit for no reason.
259 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
263 public function clearPreparedEdit() {
264 $this->mPreparedEdit
= false;
268 * Return the list of revision fields that should be selected to create
273 public static function selectFields() {
274 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
285 'page_links_updated',
290 if ( $wgContentHandlerUseDB ) {
291 $fields[] = 'page_content_model';
294 if ( $wgPageLanguageUseDB ) {
295 $fields[] = 'page_lang';
302 * Fetch a page record with the given conditions
303 * @param DatabaseBase $dbr
304 * @param array $conditions
305 * @param array $options
306 * @return object|bool Database result resource, or false on failure
308 protected function pageData( $dbr, $conditions, $options = array() ) {
309 $fields = self
::selectFields();
311 Hooks
::run( 'ArticlePageDataBefore', array( &$this, &$fields ) );
313 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
315 Hooks
::run( 'ArticlePageDataAfter', array( &$this, &$row ) );
321 * Fetch a page record matching the Title object's namespace and title
322 * using a sanitized title string
324 * @param DatabaseBase $dbr
325 * @param Title $title
326 * @param array $options
327 * @return object|bool Database result resource, or false on failure
329 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
330 return $this->pageData( $dbr, array(
331 'page_namespace' => $title->getNamespace(),
332 'page_title' => $title->getDBkey() ), $options );
336 * Fetch a page record matching the requested ID
338 * @param DatabaseBase $dbr
340 * @param array $options
341 * @return object|bool Database result resource, or false on failure
343 public function pageDataFromId( $dbr, $id, $options = array() ) {
344 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
348 * Load the object from a given source by title
350 * @param object|string|int $from One of the following:
351 * - A DB query result object.
352 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
353 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
354 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
355 * using SELECT FOR UPDATE.
359 public function loadPageData( $from = 'fromdb' ) {
360 $from = self
::convertSelectType( $from );
361 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
362 // We already have the data from the correct location, no need to load it twice.
366 if ( $from === self
::READ_LOCKING
) {
367 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
, array( 'FOR UPDATE' ) );
368 } elseif ( $from === self
::READ_LATEST
) {
369 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
370 } elseif ( $from === self
::READ_NORMAL
) {
371 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE
), $this->mTitle
);
372 // Use a "last rev inserted" timestamp key to diminish the issue of slave lag.
373 // Note that DB also stores the master position in the session and checks it.
374 $touched = $this->getCachedLastEditTime();
375 if ( $touched ) { // key set
376 if ( !$data ||
$touched > wfTimestamp( TS_MW
, $data->page_touched
) ) {
377 $from = self
::READ_LATEST
;
378 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
382 // No idea from where the caller got this data, assume slave database.
384 $from = self
::READ_NORMAL
;
387 $this->loadFromRow( $data, $from );
391 * Load the object from a database row
394 * @param object $data Database row containing at least fields returned by selectFields()
395 * @param string|int $from One of the following:
396 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
397 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
398 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
399 * the master DB using SELECT FOR UPDATE
401 public function loadFromRow( $data, $from ) {
402 $lc = LinkCache
::singleton();
403 $lc->clearLink( $this->mTitle
);
406 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
408 $this->mTitle
->loadFromRow( $data );
410 // Old-fashioned restrictions
411 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
413 $this->mId
= intval( $data->page_id
);
414 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
415 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
416 $this->mIsRedirect
= intval( $data->page_is_redirect
);
417 $this->mLatest
= intval( $data->page_latest
);
418 // Bug 37225: $latest may no longer match the cached latest Revision object.
419 // Double-check the ID of any cached latest Revision object for consistency.
420 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
421 $this->mLastRevision
= null;
422 $this->mTimestamp
= '';
425 $lc->addBadLinkObj( $this->mTitle
);
427 $this->mTitle
->loadFromRow( false );
429 $this->clearCacheFields();
434 $this->mDataLoaded
= true;
435 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
439 * @return int Page ID
441 public function getId() {
442 if ( !$this->mDataLoaded
) {
443 $this->loadPageData();
449 * @return bool Whether or not the page exists in the database
451 public function exists() {
452 if ( !$this->mDataLoaded
) {
453 $this->loadPageData();
455 return $this->mId
> 0;
459 * Check if this page is something we're going to be showing
460 * some sort of sensible content for. If we return false, page
461 * views (plain action=view) will return an HTTP 404 response,
462 * so spiders and robots can know they're following a bad link.
466 public function hasViewableContent() {
467 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
471 * Tests if the article content represents a redirect
475 public function isRedirect() {
476 $content = $this->getContent();
481 return $content->isRedirect();
485 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
487 * Will use the revisions actual content model if the page exists,
488 * and the page's default if the page doesn't exist yet.
494 public function getContentModel() {
495 if ( $this->exists() ) {
496 // look at the revision's actual content model
497 $rev = $this->getRevision();
499 if ( $rev !== null ) {
500 return $rev->getContentModel();
502 $title = $this->mTitle
->getPrefixedDBkey();
503 wfWarn( "Page $title exists but has no (visible) revisions!" );
507 // use the default model for this page
508 return $this->mTitle
->getContentModel();
512 * Loads page_touched and returns a value indicating if it should be used
513 * @return bool True if not a redirect
515 public function checkTouched() {
516 if ( !$this->mDataLoaded
) {
517 $this->loadPageData();
519 return !$this->mIsRedirect
;
523 * Get the page_touched field
524 * @return string Containing GMT timestamp
526 public function getTouched() {
527 if ( !$this->mDataLoaded
) {
528 $this->loadPageData();
530 return $this->mTouched
;
534 * Get the page_links_updated field
535 * @return string|null Containing GMT timestamp
537 public function getLinksTimestamp() {
538 if ( !$this->mDataLoaded
) {
539 $this->loadPageData();
541 return $this->mLinksUpdated
;
545 * Get the page_latest field
546 * @return int The rev_id of current revision
548 public function getLatest() {
549 if ( !$this->mDataLoaded
) {
550 $this->loadPageData();
552 return (int)$this->mLatest
;
556 * Get the Revision object of the oldest revision
557 * @return Revision|null
559 public function getOldestRevision() {
561 // Try using the slave database first, then try the master
563 $db = wfGetDB( DB_SLAVE
);
564 $revSelectFields = Revision
::selectFields();
567 while ( $continue ) {
568 $row = $db->selectRow(
569 array( 'page', 'revision' ),
572 'page_namespace' => $this->mTitle
->getNamespace(),
573 'page_title' => $this->mTitle
->getDBkey(),
578 'ORDER BY' => 'rev_timestamp ASC'
585 $db = wfGetDB( DB_MASTER
);
590 return $row ? Revision
::newFromRow( $row ) : null;
594 * Loads everything except the text
595 * This isn't necessary for all uses, so it's only done if needed.
597 protected function loadLastEdit() {
598 if ( $this->mLastRevision
!== null ) {
599 return; // already loaded
602 $latest = $this->getLatest();
604 return; // page doesn't exist or is missing page_latest info
607 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always includes the
608 // latest changes committed. This is true even within REPEATABLE-READ transactions, where
609 // S1 normally only sees changes committed before the first S1 SELECT. Thus we need S1 to
610 // also gets the revision row FOR UPDATE; otherwise, it may not find it since a page row
611 // UPDATE and revision row INSERT by S2 may have happened after the first S1 SELECT.
612 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
613 $flags = ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) ? Revision
::READ_LOCKING
: 0;
614 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
615 if ( $revision ) { // sanity
616 $this->setLastEdit( $revision );
621 * Set the latest revision
622 * @param Revision $revision
624 protected function setLastEdit( Revision
$revision ) {
625 $this->mLastRevision
= $revision;
626 $this->mTimestamp
= $revision->getTimestamp();
630 * Get the latest revision
631 * @return Revision|null
633 public function getRevision() {
634 $this->loadLastEdit();
635 if ( $this->mLastRevision
) {
636 return $this->mLastRevision
;
642 * Get the content of the current revision. No side-effects...
644 * @param int $audience One of:
645 * Revision::FOR_PUBLIC to be displayed to all users
646 * Revision::FOR_THIS_USER to be displayed to $wgUser
647 * Revision::RAW get the text regardless of permissions
648 * @param User $user User object to check for, only if FOR_THIS_USER is passed
649 * to the $audience parameter
650 * @return Content|null The content of the current revision
654 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
655 $this->loadLastEdit();
656 if ( $this->mLastRevision
) {
657 return $this->mLastRevision
->getContent( $audience, $user );
663 * Get the text of the current revision. No side-effects...
665 * @param int $audience One of:
666 * Revision::FOR_PUBLIC to be displayed to all users
667 * Revision::FOR_THIS_USER to be displayed to the given user
668 * Revision::RAW get the text regardless of permissions
669 * @param User $user User object to check for, only if FOR_THIS_USER is passed
670 * to the $audience parameter
671 * @return string|bool The text of the current revision
672 * @deprecated since 1.21, getContent() should be used instead.
674 public function getText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
675 ContentHandler
::deprecated( __METHOD__
, '1.21' );
677 $this->loadLastEdit();
678 if ( $this->mLastRevision
) {
679 return $this->mLastRevision
->getText( $audience, $user );
685 * Get the text of the current revision. No side-effects...
687 * @return string|bool The text of the current revision. False on failure
688 * @deprecated since 1.21, getContent() should be used instead.
690 public function getRawText() {
691 ContentHandler
::deprecated( __METHOD__
, '1.21' );
693 return $this->getText( Revision
::RAW
);
697 * @return string MW timestamp of last article revision
699 public function getTimestamp() {
700 // Check if the field has been filled by WikiPage::setTimestamp()
701 if ( !$this->mTimestamp
) {
702 $this->loadLastEdit();
705 return wfTimestamp( TS_MW
, $this->mTimestamp
);
709 * Set the page timestamp (use only to avoid DB queries)
710 * @param string $ts MW timestamp of last article revision
713 public function setTimestamp( $ts ) {
714 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
718 * @param int $audience One of:
719 * Revision::FOR_PUBLIC to be displayed to all users
720 * Revision::FOR_THIS_USER to be displayed to the given user
721 * Revision::RAW get the text regardless of permissions
722 * @param User $user User object to check for, only if FOR_THIS_USER is passed
723 * to the $audience parameter
724 * @return int User ID for the user that made the last article revision
726 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
727 $this->loadLastEdit();
728 if ( $this->mLastRevision
) {
729 return $this->mLastRevision
->getUser( $audience, $user );
736 * Get the User object of the user who created the page
737 * @param int $audience One of:
738 * Revision::FOR_PUBLIC to be displayed to all users
739 * Revision::FOR_THIS_USER to be displayed to the given user
740 * Revision::RAW get the text regardless of permissions
741 * @param User $user User object to check for, only if FOR_THIS_USER is passed
742 * to the $audience parameter
745 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
746 $revision = $this->getOldestRevision();
748 $userName = $revision->getUserText( $audience, $user );
749 return User
::newFromName( $userName, false );
756 * @param int $audience One of:
757 * Revision::FOR_PUBLIC to be displayed to all users
758 * Revision::FOR_THIS_USER to be displayed to the given user
759 * Revision::RAW get the text regardless of permissions
760 * @param User $user User object to check for, only if FOR_THIS_USER is passed
761 * to the $audience parameter
762 * @return string Username of the user that made the last article revision
764 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
765 $this->loadLastEdit();
766 if ( $this->mLastRevision
) {
767 return $this->mLastRevision
->getUserText( $audience, $user );
774 * @param int $audience One of:
775 * Revision::FOR_PUBLIC to be displayed to all users
776 * Revision::FOR_THIS_USER to be displayed to the given user
777 * Revision::RAW get the text regardless of permissions
778 * @param User $user User object to check for, only if FOR_THIS_USER is passed
779 * to the $audience parameter
780 * @return string Comment stored for the last article revision
782 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
783 $this->loadLastEdit();
784 if ( $this->mLastRevision
) {
785 return $this->mLastRevision
->getComment( $audience, $user );
792 * Returns true if last revision was marked as "minor edit"
794 * @return bool Minor edit indicator for the last article revision.
796 public function getMinorEdit() {
797 $this->loadLastEdit();
798 if ( $this->mLastRevision
) {
799 return $this->mLastRevision
->isMinor();
806 * Get the cached timestamp for the last time the page changed.
807 * This is only used to help handle slave lag by comparing to page_touched.
808 * @return string MW timestamp
810 protected function getCachedLastEditTime() {
812 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
813 return $wgMemc->get( $key );
817 * Set the cached timestamp for the last time the page changed.
818 * This is only used to help handle slave lag by comparing to page_touched.
819 * @param string $timestamp
822 public function setCachedLastEditTime( $timestamp ) {
824 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
825 $wgMemc->set( $key, wfTimestamp( TS_MW
, $timestamp ), 60 * 15 );
829 * Determine whether a page would be suitable for being counted as an
830 * article in the site_stats table based on the title & its content
832 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
833 * if false, the current database state will be used
836 public function isCountable( $editInfo = false ) {
837 global $wgArticleCountMethod;
839 if ( !$this->mTitle
->isContentPage() ) {
844 $content = $editInfo->pstContent
;
846 $content = $this->getContent();
849 if ( !$content ||
$content->isRedirect() ) {
855 if ( $wgArticleCountMethod === 'link' ) {
856 // nasty special case to avoid re-parsing to detect links
859 // ParserOutput::getLinks() is a 2D array of page links, so
860 // to be really correct we would need to recurse in the array
861 // but the main array should only have items in it if there are
863 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
865 $hasLinks = (bool)wfGetDB( DB_SLAVE
)->selectField( 'pagelinks', 1,
866 array( 'pl_from' => $this->getId() ), __METHOD__
);
870 return $content->isCountable( $hasLinks );
874 * If this page is a redirect, get its target
876 * The target will be fetched from the redirect table if possible.
877 * If this page doesn't have an entry there, call insertRedirect()
878 * @return Title|null Title object, or null if this page is not a redirect
880 public function getRedirectTarget() {
881 if ( !$this->mTitle
->isRedirect() ) {
885 if ( $this->mRedirectTarget
!== null ) {
886 return $this->mRedirectTarget
;
889 // Query the redirect table
890 $dbr = wfGetDB( DB_SLAVE
);
891 $row = $dbr->selectRow( 'redirect',
892 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
893 array( 'rd_from' => $this->getId() ),
897 // rd_fragment and rd_interwiki were added later, populate them if empty
898 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
899 $this->mRedirectTarget
= Title
::makeTitle(
900 $row->rd_namespace
, $row->rd_title
,
901 $row->rd_fragment
, $row->rd_interwiki
);
902 return $this->mRedirectTarget
;
905 // This page doesn't have an entry in the redirect table
906 $this->mRedirectTarget
= $this->insertRedirect();
907 return $this->mRedirectTarget
;
911 * Insert an entry for this page into the redirect table.
913 * Don't call this function directly unless you know what you're doing.
914 * @return Title|null Title object or null if not a redirect
916 public function insertRedirect() {
917 // recurse through to only get the final target
918 $content = $this->getContent();
919 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
923 $this->insertRedirectEntry( $retval );
928 * Insert or update the redirect table entry for this page to indicate
929 * it redirects to $rt .
930 * @param Title $rt Redirect target
932 public function insertRedirectEntry( $rt ) {
933 $dbw = wfGetDB( DB_MASTER
);
934 $dbw->replace( 'redirect', array( 'rd_from' ),
936 'rd_from' => $this->getId(),
937 'rd_namespace' => $rt->getNamespace(),
938 'rd_title' => $rt->getDBkey(),
939 'rd_fragment' => $rt->getFragment(),
940 'rd_interwiki' => $rt->getInterwiki(),
947 * Get the Title object or URL this page redirects to
949 * @return bool|Title|string False, Title of in-wiki target, or string with URL
951 public function followRedirect() {
952 return $this->getRedirectURL( $this->getRedirectTarget() );
956 * Get the Title object or URL to use for a redirect. We use Title
957 * objects for same-wiki, non-special redirects and URLs for everything
959 * @param Title $rt Redirect target
960 * @return bool|Title|string False, Title object of local target, or string with URL
962 public function getRedirectURL( $rt ) {
967 if ( $rt->isExternal() ) {
968 if ( $rt->isLocal() ) {
969 // Offsite wikis need an HTTP redirect.
971 // This can be hard to reverse and may produce loops,
972 // so they may be disabled in the site configuration.
973 $source = $this->mTitle
->getFullURL( 'redirect=no' );
974 return $rt->getFullURL( array( 'rdfrom' => $source ) );
976 // External pages without "local" bit set are not valid
982 if ( $rt->isSpecialPage() ) {
983 // Gotta handle redirects to special pages differently:
984 // Fill the HTTP response "Location" header and ignore
985 // the rest of the page we're on.
987 // Some pages are not valid targets
988 if ( $rt->isValidRedirectTarget() ) {
989 return $rt->getFullURL();
999 * Get a list of users who have edited this article, not including the user who made
1000 * the most recent revision, which you can get from $article->getUser() if you want it
1001 * @return UserArrayFromResult
1003 public function getContributors() {
1004 // @todo FIXME: This is expensive; cache this info somewhere.
1006 $dbr = wfGetDB( DB_SLAVE
);
1008 if ( $dbr->implicitGroupby() ) {
1009 $realNameField = 'user_real_name';
1011 $realNameField = 'MIN(user_real_name) AS user_real_name';
1014 $tables = array( 'revision', 'user' );
1017 'user_id' => 'rev_user',
1018 'user_name' => 'rev_user_text',
1020 'timestamp' => 'MAX(rev_timestamp)',
1023 $conds = array( 'rev_page' => $this->getId() );
1025 // The user who made the top revision gets credited as "this page was last edited by
1026 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1027 $user = $this->getUser();
1029 $conds[] = "rev_user != $user";
1031 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1034 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1037 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1041 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1042 'ORDER BY' => 'timestamp DESC',
1045 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1046 return new UserArrayFromResult( $res );
1050 * Get the last N authors
1051 * @param int $num Number of revisions to get
1052 * @param int|string $revLatest The latest rev_id, selected from the master (optional)
1053 * @return array Array of authors, duplicates not removed
1055 public function getLastNAuthors( $num, $revLatest = 0 ) {
1056 // First try the slave
1057 // If that doesn't have the latest revision, try the master
1059 $db = wfGetDB( DB_SLAVE
);
1062 $res = $db->select( array( 'page', 'revision' ),
1063 array( 'rev_id', 'rev_user_text' ),
1065 'page_namespace' => $this->mTitle
->getNamespace(),
1066 'page_title' => $this->mTitle
->getDBkey(),
1067 'rev_page = page_id'
1070 'ORDER BY' => 'rev_timestamp DESC',
1079 $row = $db->fetchObject( $res );
1081 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
1082 $db = wfGetDB( DB_MASTER
);
1087 } while ( $continue );
1089 $authors = array( $row->rev_user_text
);
1091 foreach ( $res as $row ) {
1092 $authors[] = $row->rev_user_text
;
1099 * Should the parser cache be used?
1101 * @param ParserOptions $parserOptions ParserOptions to check
1105 public function isParserCacheUsed( ParserOptions
$parserOptions, $oldid ) {
1106 global $wgEnableParserCache;
1108 return $wgEnableParserCache
1109 && $parserOptions->getStubThreshold() == 0
1111 && ( $oldid === null ||
$oldid === 0 ||
$oldid === $this->getLatest() )
1112 && $this->getContentHandler()->isParserCacheSupported();
1116 * Get a ParserOutput for the given ParserOptions and revision ID.
1117 * The parser cache will be used if possible.
1120 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1121 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1122 * get the current revision (default value)
1124 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1126 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
1128 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1129 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1130 if ( $parserOptions->getStubThreshold() ) {
1131 wfIncrStats( 'pcache_miss_stub' );
1134 if ( $useParserCache ) {
1135 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1136 if ( $parserOutput !== false ) {
1137 return $parserOutput;
1141 if ( $oldid === null ||
$oldid === 0 ) {
1142 $oldid = $this->getLatest();
1145 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1149 return $pool->getParserOutput();
1153 * Do standard deferred updates after page view (existing or missing page)
1154 * @param User $user The relevant user
1155 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
1157 public function doViewUpdates( User
$user, $oldid = 0 ) {
1158 if ( wfReadOnly() ) {
1162 // Update newtalk / watchlist notification status
1163 $user->clearNotification( $this->mTitle
, $oldid );
1167 * Perform the actions of a page purging
1170 public function doPurge() {
1173 if ( !Hooks
::run( 'ArticlePurge', array( &$this ) ) ) {
1177 // Invalidate the cache
1178 $this->mTitle
->invalidateCache();
1180 if ( $wgUseSquid ) {
1181 // Commit the transaction before the purge is sent
1182 $dbw = wfGetDB( DB_MASTER
);
1183 $dbw->commit( __METHOD__
);
1186 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1187 $update->doUpdate();
1190 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1191 // @todo move this logic to MessageCache
1193 if ( $this->exists() ) {
1194 // NOTE: use transclusion text for messages.
1195 // This is consistent with MessageCache::getMsgFromNamespace()
1197 $content = $this->getContent();
1198 $text = $content === null ?
null : $content->getWikitextForTransclusion();
1200 if ( $text === null ) {
1207 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1213 * Insert a new empty page record for this article.
1214 * This *must* be followed up by creating a revision
1215 * and running $this->updateRevisionOn( ... );
1216 * or else the record will be left in a funky state.
1217 * Best if all done inside a transaction.
1219 * @param DatabaseBase $dbw
1220 * @return int The newly created page_id key, or false if the title already existed
1222 public function insertOn( $dbw ) {
1224 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1225 $dbw->insert( 'page', array(
1226 'page_id' => $page_id,
1227 'page_namespace' => $this->mTitle
->getNamespace(),
1228 'page_title' => $this->mTitle
->getDBkey(),
1229 'page_restrictions' => '',
1230 'page_is_redirect' => 0, // Will set this shortly...
1232 'page_random' => wfRandom(),
1233 'page_touched' => $dbw->timestamp(),
1234 'page_latest' => 0, // Fill this in shortly...
1235 'page_len' => 0, // Fill this in shortly...
1236 ), __METHOD__
, 'IGNORE' );
1238 $affected = $dbw->affectedRows();
1241 $newid = $dbw->insertId();
1242 $this->mId
= $newid;
1243 $this->mTitle
->resetArticleID( $newid );
1246 return $affected ?
$newid : false;
1250 * Update the page record to point to a newly saved revision.
1252 * @param DatabaseBase $dbw
1253 * @param Revision $revision For ID number, and text used to set
1254 * length and redirect status fields
1255 * @param int $lastRevision If given, will not overwrite the page field
1256 * when different from the currently set value.
1257 * Giving 0 indicates the new page flag should be set on.
1258 * @param bool $lastRevIsRedirect If given, will optimize adding and
1259 * removing rows in redirect table.
1260 * @return bool True on success, false on failure
1262 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1263 $lastRevIsRedirect = null
1265 global $wgContentHandlerUseDB;
1268 $content = $revision->getContent();
1269 $len = $content ?
$content->getSize() : 0;
1270 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1272 $conditions = array( 'page_id' => $this->getId() );
1274 if ( !is_null( $lastRevision ) ) {
1275 // An extra check against threads stepping on each other
1276 $conditions['page_latest'] = $lastRevision;
1279 $now = wfTimestampNow();
1280 $row = array( /* SET */
1281 'page_latest' => $revision->getId(),
1282 'page_touched' => $dbw->timestamp( $now ),
1283 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1284 'page_is_redirect' => $rt !== null ?
1 : 0,
1288 if ( $wgContentHandlerUseDB ) {
1289 $row['page_content_model'] = $revision->getContentModel();
1292 $dbw->update( 'page',
1297 $result = $dbw->affectedRows() > 0;
1299 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1300 $this->setLastEdit( $revision );
1301 $this->setCachedLastEditTime( $now );
1302 $this->mLatest
= $revision->getId();
1303 $this->mIsRedirect
= (bool)$rt;
1304 // Update the LinkCache.
1305 LinkCache
::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle
, $len, $this->mIsRedirect
,
1306 $this->mLatest
, $revision->getContentModel() );
1313 * Add row to the redirect table if this is a redirect, remove otherwise.
1315 * @param DatabaseBase $dbw
1316 * @param Title $redirectTitle Title object pointing to the redirect target,
1317 * or NULL if this is not a redirect
1318 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1319 * removing rows in redirect table.
1320 * @return bool True on success, false on failure
1323 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1324 // Always update redirects (target link might have changed)
1325 // Update/Insert if we don't know if the last revision was a redirect or not
1326 // Delete if changing from redirect to non-redirect
1327 $isRedirect = !is_null( $redirectTitle );
1329 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1333 if ( $isRedirect ) {
1334 $this->insertRedirectEntry( $redirectTitle );
1336 // This is not a redirect, remove row from redirect table
1337 $where = array( 'rd_from' => $this->getId() );
1338 $dbw->delete( 'redirect', $where, __METHOD__
);
1341 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1342 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1345 return ( $dbw->affectedRows() != 0 );
1349 * If the given revision is newer than the currently set page_latest,
1350 * update the page record. Otherwise, do nothing.
1352 * @deprecated since 1.24, use updateRevisionOn instead
1354 * @param DatabaseBase $dbw
1355 * @param Revision $revision
1358 public function updateIfNewerOn( $dbw, $revision ) {
1360 $row = $dbw->selectRow(
1361 array( 'revision', 'page' ),
1362 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1364 'page_id' => $this->getId(),
1365 'page_latest=rev_id' ),
1369 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1372 $prev = $row->rev_id
;
1373 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1375 // No or missing previous revision; mark the page as new
1377 $lastRevIsRedirect = null;
1380 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1386 * Get the content that needs to be saved in order to undo all revisions
1387 * between $undo and $undoafter. Revisions must belong to the same page,
1388 * must exist and must not be deleted
1389 * @param Revision $undo
1390 * @param Revision $undoafter Must be an earlier revision than $undo
1391 * @return mixed String on success, false on failure
1393 * Before we had the Content object, this was done in getUndoText
1395 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1396 $handler = $undo->getContentHandler();
1397 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1401 * Get the text that needs to be saved in order to undo all revisions
1402 * between $undo and $undoafter. Revisions must belong to the same page,
1403 * must exist and must not be deleted
1404 * @param Revision $undo
1405 * @param Revision $undoafter Must be an earlier revision than $undo
1406 * @return string|bool String on success, false on failure
1407 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1409 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
1410 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1412 $this->loadLastEdit();
1414 if ( $this->mLastRevision
) {
1415 if ( is_null( $undoafter ) ) {
1416 $undoafter = $undo->getPrevious();
1419 $handler = $this->getContentHandler();
1420 $undone = $handler->getUndoContent( $this->mLastRevision
, $undo, $undoafter );
1425 return ContentHandler
::getContentText( $undone );
1433 * @param string|number|null|bool $sectionId Section identifier as a number or string
1434 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1435 * or 'new' for a new section.
1436 * @param string $text New text of the section.
1437 * @param string $sectionTitle New section's subject, only if $section is "new".
1438 * @param string $edittime Revision timestamp or null to use the current revision.
1440 * @throws MWException
1441 * @return string New complete article text, or null if error.
1443 * @deprecated since 1.21, use replaceSectionAtRev() instead
1445 public function replaceSection( $sectionId, $text, $sectionTitle = '',
1448 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1450 //NOTE: keep condition in sync with condition in replaceSectionContent!
1451 if ( strval( $sectionId ) === '' ) {
1452 // Whole-page edit; let the whole text through
1456 if ( !$this->supportsSections() ) {
1457 throw new MWException( "sections not supported for content model " .
1458 $this->getContentHandler()->getModelID() );
1461 // could even make section title, but that's not required.
1462 $sectionContent = ContentHandler
::makeContent( $text, $this->getTitle() );
1464 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1467 return ContentHandler
::getContentText( $newContent );
1471 * Returns true if this page's content model supports sections.
1475 * @todo The skin should check this and not offer section functionality if
1476 * sections are not supported.
1477 * @todo The EditPage should check this and not offer section functionality
1478 * if sections are not supported.
1480 public function supportsSections() {
1481 return $this->getContentHandler()->supportsSections();
1485 * @param string|number|null|bool $sectionId Section identifier as a number or string
1486 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1487 * or 'new' for a new section.
1488 * @param Content $sectionContent New content of the section.
1489 * @param string $sectionTitle New section's subject, only if $section is "new".
1490 * @param string $edittime Revision timestamp or null to use the current revision.
1492 * @throws MWException
1493 * @return Content New complete article content, or null if error.
1496 * @deprecated since 1.24, use replaceSectionAtRev instead
1498 public function replaceSectionContent( $sectionId, Content
$sectionContent, $sectionTitle = '',
1499 $edittime = null ) {
1502 if ( $edittime && $sectionId !== 'new' ) {
1503 $dbw = wfGetDB( DB_MASTER
);
1504 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1506 $baseRevId = $rev->getId();
1510 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1514 * @param string|number|null|bool $sectionId Section identifier as a number or string
1515 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1516 * or 'new' for a new section.
1517 * @param Content $sectionContent New content of the section.
1518 * @param string $sectionTitle New section's subject, only if $section is "new".
1519 * @param int|null $baseRevId
1521 * @throws MWException
1522 * @return Content New complete article content, or null if error.
1526 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1527 $sectionTitle = '', $baseRevId = null
1530 if ( strval( $sectionId ) === '' ) {
1531 // Whole-page edit; let the whole text through
1532 $newContent = $sectionContent;
1534 if ( !$this->supportsSections() ) {
1535 throw new MWException( "sections not supported for content model " .
1536 $this->getContentHandler()->getModelID() );
1539 // Bug 30711: always use current version when adding a new section
1540 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1541 $oldContent = $this->getContent();
1543 // TODO: try DB_SLAVE first
1544 $dbw = wfGetDB( DB_MASTER
);
1545 $rev = Revision
::loadFromId( $dbw, $baseRevId );
1548 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1549 $this->getId() . "; section: $sectionId)\n" );
1553 $oldContent = $rev->getContent();
1556 if ( !$oldContent ) {
1557 wfDebug( __METHOD__
. ": no page text\n" );
1561 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1568 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1570 * @return int Updated $flags
1572 public function checkFlags( $flags ) {
1573 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1574 if ( $this->exists() ) {
1575 $flags |
= EDIT_UPDATE
;
1585 * Change an existing article or create a new article. Updates RC and all necessary caches,
1586 * optionally via the deferred update array.
1588 * @param string $text New text
1589 * @param string $summary Edit summary
1590 * @param int $flags Bitfield:
1592 * Article is known or assumed to be non-existent, create a new one
1594 * Article is known or assumed to be pre-existing, update it
1596 * Mark this edit minor, if the user is allowed to do so
1598 * Do not log the change in recentchanges
1600 * Mark the edit a "bot" edit regardless of user rights
1601 * EDIT_DEFER_UPDATES
1602 * Defer some of the updates until the end of index.php
1604 * Fill in blank summaries with generated text where possible
1606 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1607 * article will be detected. If EDIT_UPDATE is specified and the article
1608 * doesn't exist, the function will return an edit-gone-missing error. If
1609 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1610 * error will be returned. These two conditions are also possible with
1611 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1613 * @param bool|int $baseRevId The revision ID this edit was based off, if any
1614 * @param User $user The user doing the edit
1616 * @throws MWException
1617 * @return Status Possible errors:
1618 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1619 * set the fatal flag of $status
1620 * edit-gone-missing: In update mode, but the article didn't exist.
1621 * edit-conflict: In update mode, the article changed unexpectedly.
1622 * edit-no-change: Warning that the text was the same as before.
1623 * edit-already-exists: In creation mode, but the article already exists.
1625 * Extensions may define additional errors.
1627 * $return->value will contain an associative array with members as follows:
1628 * new: Boolean indicating if the function attempted to create a new article.
1629 * revision: The revision object for the inserted revision, or null.
1631 * Compatibility note: this function previously returned a boolean value
1632 * indicating success/failure
1634 * @deprecated since 1.21: use doEditContent() instead.
1636 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1637 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1639 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1641 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1645 * Change an existing article or create a new article. Updates RC and all necessary caches,
1646 * optionally via the deferred update array.
1648 * @param Content $content New content
1649 * @param string $summary Edit summary
1650 * @param int $flags Bitfield:
1652 * Article is known or assumed to be non-existent, create a new one
1654 * Article is known or assumed to be pre-existing, update it
1656 * Mark this edit minor, if the user is allowed to do so
1658 * Do not log the change in recentchanges
1660 * Mark the edit a "bot" edit regardless of user rights
1661 * EDIT_DEFER_UPDATES
1662 * Defer some of the updates until the end of index.php
1664 * Fill in blank summaries with generated text where possible
1666 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1667 * article will be detected. If EDIT_UPDATE is specified and the article
1668 * doesn't exist, the function will return an edit-gone-missing error. If
1669 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1670 * error will be returned. These two conditions are also possible with
1671 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1673 * @param bool|int $baseRevId The revision ID this edit was based off, if any
1674 * @param User $user The user doing the edit
1675 * @param string $serialFormat Format for storing the content in the
1678 * @throws MWException
1679 * @return Status Possible errors:
1680 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1681 * set the fatal flag of $status.
1682 * edit-gone-missing: In update mode, but the article didn't exist.
1683 * edit-conflict: In update mode, the article changed unexpectedly.
1684 * edit-no-change: Warning that the text was the same as before.
1685 * edit-already-exists: In creation mode, but the article already exists.
1687 * Extensions may define additional errors.
1689 * $return->value will contain an associative array with members as follows:
1690 * new: Boolean indicating if the function attempted to create a new article.
1691 * revision: The revision object for the inserted revision, or null.
1695 public function doEditContent( Content
$content, $summary, $flags = 0, $baseRevId = false,
1696 User
$user = null, $serialFormat = null
1698 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1700 // Low-level sanity check
1701 if ( $this->mTitle
->getText() === '' ) {
1702 throw new MWException( 'Something is trying to edit an article with an empty title' );
1706 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1707 return Status
::newFatal( 'content-not-allowed-here',
1708 ContentHandler
::getLocalizedName( $content->getModel() ),
1709 $this->getTitle()->getPrefixedText() );
1712 $user = is_null( $user ) ?
$wgUser : $user;
1713 $status = Status
::newGood( array() );
1715 // Load the data from the master database if needed.
1716 // The caller may already loaded it from the master or even loaded it using
1717 // SELECT FOR UPDATE, so do not override that using clear().
1718 $this->loadPageData( 'fromdbmaster' );
1720 $flags = $this->checkFlags( $flags );
1723 $hook_args = array( &$this, &$user, &$content, &$summary,
1724 $flags & EDIT_MINOR
, null, null, &$flags, &$status );
1726 if ( !Hooks
::run( 'PageContentSave', $hook_args )
1727 ||
!ContentHandler
::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1729 wfDebug( __METHOD__
. ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1731 if ( $status->isOK() ) {
1732 $status->fatal( 'edit-hook-aborted' );
1738 // Silently ignore EDIT_MINOR if not allowed
1739 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1740 $bot = $flags & EDIT_FORCE_BOT
;
1742 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1744 $oldsize = $old_content ?
$old_content->getSize() : 0;
1745 $oldid = $this->getLatest();
1746 $oldIsRedirect = $this->isRedirect();
1747 $oldcountable = $this->isCountable();
1749 $handler = $content->getContentHandler();
1751 // Provide autosummaries if one is not provided and autosummaries are enabled.
1752 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1753 if ( !$old_content ) {
1754 $old_content = null;
1756 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1759 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1760 $serialized = $editInfo->pst
;
1763 * @var Content $content
1765 $content = $editInfo->pstContent
;
1766 $newsize = $content->getSize();
1768 $dbw = wfGetDB( DB_MASTER
);
1769 $now = wfTimestampNow();
1770 $this->mTimestamp
= $now;
1772 if ( $flags & EDIT_UPDATE
) {
1773 // Update article, but only if changed.
1774 $status->value
['new'] = false;
1777 // Article gone missing
1778 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
1779 $status->fatal( 'edit-gone-missing' );
1782 } elseif ( !$old_content ) {
1783 // Sanity check for bug 37225
1784 throw new MWException( "Could not find text for current revision {$oldid}." );
1787 $revision = new Revision( array(
1788 'page' => $this->getId(),
1789 'title' => $this->getTitle(), // for determining the default content model
1790 'comment' => $summary,
1791 'minor_edit' => $isminor,
1792 'text' => $serialized,
1794 'parent_id' => $oldid,
1795 'user' => $user->getId(),
1796 'user_text' => $user->getName(),
1797 'timestamp' => $now,
1798 'content_model' => $content->getModel(),
1799 'content_format' => $serialFormat,
1800 ) ); // XXX: pass content object?!
1802 $changed = !$content->equals( $old_content );
1805 $dbw->begin( __METHOD__
);
1808 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1809 $status->merge( $prepStatus );
1811 if ( !$status->isOK() ) {
1812 $dbw->rollback( __METHOD__
);
1816 $revisionId = $revision->insertOn( $dbw );
1820 // We check for conflicts by comparing $oldid with the current latest revision ID.
1821 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1824 // Belated edit conflict! Run away!!
1825 $status->fatal( 'edit-conflict' );
1827 $dbw->rollback( __METHOD__
);
1832 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1833 // Update recentchanges
1834 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1835 // Mark as patrolled if the user can do so
1836 $patrolled = $wgUseRCPatrol && !count(
1837 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1838 // Add RC row to the DB
1839 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
1840 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1841 $revisionId, $patrolled
1844 // Log auto-patrolled edits
1846 PatrolLog
::record( $rc, true, $user );
1849 $user->incEditCount();
1850 } catch ( MWException
$e ) {
1851 $dbw->rollback( __METHOD__
);
1852 // Question: Would it perhaps be better if this method turned all
1853 // exceptions into $status's?
1856 $dbw->commit( __METHOD__
);
1858 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1859 // related variables correctly
1860 $revision->setId( $this->getLatest() );
1863 // Update links tables, site stats, etc.
1864 $this->doEditUpdates(
1868 'changed' => $changed,
1869 'oldcountable' => $oldcountable
1874 $status->warning( 'edit-no-change' );
1876 // Update page_touched, this is usually implicit in the page update
1877 // Other cache updates are done in onArticleEdit()
1878 $this->mTitle
->invalidateCache();
1881 // Create new article
1882 $status->value
['new'] = true;
1884 $dbw->begin( __METHOD__
);
1887 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1888 $status->merge( $prepStatus );
1890 if ( !$status->isOK() ) {
1891 $dbw->rollback( __METHOD__
);
1896 $status->merge( $prepStatus );
1898 // Add the page record; stake our claim on this title!
1899 // This will return false if the article already exists
1900 $newid = $this->insertOn( $dbw );
1902 if ( $newid === false ) {
1903 $dbw->rollback( __METHOD__
);
1904 $status->fatal( 'edit-already-exists' );
1909 // Save the revision text...
1910 $revision = new Revision( array(
1912 'title' => $this->getTitle(), // for determining the default content model
1913 'comment' => $summary,
1914 'minor_edit' => $isminor,
1915 'text' => $serialized,
1917 'user' => $user->getId(),
1918 'user_text' => $user->getName(),
1919 'timestamp' => $now,
1920 'content_model' => $content->getModel(),
1921 'content_format' => $serialFormat,
1923 $revisionId = $revision->insertOn( $dbw );
1925 // Bug 37225: use accessor to get the text as Revision may trim it
1926 $content = $revision->getContent(); // sanity; get normalized version
1929 $newsize = $content->getSize();
1932 // Update the page record with revision data
1933 $this->updateRevisionOn( $dbw, $revision, 0 );
1935 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1937 // Update recentchanges
1938 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1939 // Mark as patrolled if the user can do so
1940 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
1941 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1942 // Add RC row to the DB
1943 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
1944 '', $newsize, $revisionId, $patrolled );
1946 // Log auto-patrolled edits
1948 PatrolLog
::record( $rc, true, $user );
1951 $user->incEditCount();
1953 } catch ( MWException
$e ) {
1954 $dbw->rollback( __METHOD__
);
1957 $dbw->commit( __METHOD__
);
1959 // Update links, etc.
1960 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1962 $hook_args = array( &$this, &$user, $content, $summary,
1963 $flags & EDIT_MINOR
, null, null, &$flags, $revision );
1965 ContentHandler
::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1966 Hooks
::run( 'PageContentInsertComplete', $hook_args );
1969 // Do updates right now unless deferral was requested
1970 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
1971 DeferredUpdates
::doUpdates();
1974 // Return the new revision (or null) to the caller
1975 $status->value
['revision'] = $revision;
1977 $hook_args = array( &$this, &$user, $content, $summary,
1978 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId );
1980 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1981 Hooks
::run( 'PageContentSaveComplete', $hook_args );
1983 // Promote user to any groups they meet the criteria for
1984 $dbw->onTransactionIdle( function () use ( $user ) {
1985 $user->addAutopromoteOnceGroups( 'onEdit' );
1992 * Get parser options suitable for rendering the primary article wikitext
1994 * @see ContentHandler::makeParserOptions
1996 * @param IContextSource|User|string $context One of the following:
1997 * - IContextSource: Use the User and the Language of the provided
1999 * - User: Use the provided User object and $wgLang for the language,
2000 * so use an IContextSource object if possible.
2001 * - 'canonical': Canonical options (anonymous user with default
2002 * preferences and content language).
2003 * @return ParserOptions
2005 public function makeParserOptions( $context ) {
2006 $options = $this->getContentHandler()->makeParserOptions( $context );
2008 if ( $this->getTitle()->isConversionTable() ) {
2009 // @todo ConversionTable should become a separate content model, so
2010 // we don't need special cases like this one.
2011 $options->disableContentConversion();
2018 * Prepare text which is about to be saved.
2019 * Returns a stdClass with source, pst and output members
2021 * @deprecated since 1.21: use prepareContentForEdit instead.
2024 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
2025 ContentHandler
::deprecated( __METHOD__
, '1.21' );
2026 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2027 return $this->prepareContentForEdit( $content, $revid, $user );
2031 * Prepare content which is about to be saved.
2032 * Returns a stdClass with source, pst and output members
2034 * @param Content $content
2035 * @param int|null $revid
2036 * @param User|null $user
2037 * @param string|null $serialFormat
2038 * @param bool $useCache Check shared prepared edit cache
2044 public function prepareContentForEdit(
2045 Content
$content, $revid = null, User
$user = null, $serialFormat = null, $useCache = true
2047 global $wgContLang, $wgUser;
2049 $user = is_null( $user ) ?
$wgUser : $user;
2050 //XXX: check $user->getId() here???
2052 // Use a sane default for $serialFormat, see bug 57026
2053 if ( $serialFormat === null ) {
2054 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2057 if ( $this->mPreparedEdit
2058 && $this->mPreparedEdit
->newContent
2059 && $this->mPreparedEdit
->newContent
->equals( $content )
2060 && $this->mPreparedEdit
->revid
== $revid
2061 && $this->mPreparedEdit
->format
== $serialFormat
2062 // XXX: also check $user here?
2065 return $this->mPreparedEdit
;
2068 // The edit may have already been prepared via api.php?action=stashedit
2069 $cachedEdit = $useCache
2070 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2073 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2074 Hooks
::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2076 $edit = (object)array();
2077 if ( $cachedEdit ) {
2078 $edit->timestamp
= $cachedEdit->timestamp
;
2080 $edit->timestamp
= wfTimestampNow();
2082 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2083 $edit->revid
= $revid;
2085 if ( $cachedEdit ) {
2086 $edit->pstContent
= $cachedEdit->pstContent
;
2088 $edit->pstContent
= $content
2089 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2093 $edit->format
= $serialFormat;
2094 $edit->popts
= $this->makeParserOptions( 'canonical' );
2095 if ( $cachedEdit ) {
2096 $edit->output
= $cachedEdit->output
;
2098 $edit->output
= $edit->pstContent
2099 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2103 $edit->newContent
= $content;
2104 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2106 // NOTE: B/C for hooks! don't use these fields!
2107 $edit->newText
= $edit->newContent ? ContentHandler
::getContentText( $edit->newContent
) : '';
2108 $edit->oldText
= $edit->oldContent ? ContentHandler
::getContentText( $edit->oldContent
) : '';
2109 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2111 $this->mPreparedEdit
= $edit;
2116 * Do standard deferred updates after page edit.
2117 * Update links tables, site stats, search index and message cache.
2118 * Purges pages that include this page if the text was changed here.
2119 * Every 100th edit, prune the recent changes table.
2121 * @param Revision $revision
2122 * @param User $user User object that did the revision
2123 * @param array $options Array of options, following indexes are used:
2124 * - changed: boolean, whether the revision changed the content (default true)
2125 * - created: boolean, whether the revision created the page (default false)
2126 * - moved: boolean, whether the page was moved (default false)
2127 * - oldcountable: boolean or null (default null):
2128 * - boolean: whether the page was counted as an article before that
2129 * revision, only used in changed is true and created is false
2130 * - null: don't change the article count
2132 public function doEditUpdates( Revision
$revision, User
$user, array $options = array() ) {
2133 global $wgEnableParserCache;
2140 'oldcountable' => null
2142 $content = $revision->getContent();
2145 // Be careful not to do pre-save transform twice: $text is usually
2146 // already pre-save transformed once.
2147 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2148 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
2149 $editInfo = $this->prepareContentForEdit( $content, $revision->getId(), $user );
2151 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
2152 $editInfo = $this->mPreparedEdit
;
2155 // Save it to the parser cache
2156 if ( $wgEnableParserCache ) {
2157 $parserCache = ParserCache
::singleton();
2159 $editInfo->output
, $this, $editInfo->popts
, $editInfo->timestamp
, $editInfo->revid
2163 // Update the links tables and other secondary data
2165 $recursive = $options['changed']; // bug 50785
2166 $updates = $content->getSecondaryDataUpdates(
2167 $this->getTitle(), null, $recursive, $editInfo->output
);
2168 DataUpdate
::runUpdates( $updates );
2171 Hooks
::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2173 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2174 if ( 0 == mt_rand( 0, 99 ) ) {
2175 // Flush old entries from the `recentchanges` table; we do this on
2176 // random requests so as to avoid an increase in writes for no good reason
2177 RecentChange
::purgeExpiredChanges();
2181 if ( !$this->exists() ) {
2185 $id = $this->getId();
2186 $title = $this->mTitle
->getPrefixedDBkey();
2187 $shortTitle = $this->mTitle
->getDBkey();
2189 if ( !$options['changed'] && !$options['moved'] ) {
2191 } elseif ( $options['created'] ) {
2192 $good = (int)$this->isCountable( $editInfo );
2193 } elseif ( $options['oldcountable'] !== null ) {
2194 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2198 $edits = $options['changed'] ?
1 : 0;
2199 $total = $options['created'] ?
1 : 0;
2201 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2202 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2204 // If this is another user's talk page, update newtalk.
2205 // Don't do this if $options['changed'] = false (null-edits) nor if
2206 // it's a minor edit and the user doesn't want notifications for those.
2207 if ( $options['changed']
2208 && $this->mTitle
->getNamespace() == NS_USER_TALK
2209 && $shortTitle != $user->getTitleKey()
2210 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2212 $recipient = User
::newFromName( $shortTitle, false );
2213 if ( !$recipient ) {
2214 wfDebug( __METHOD__
. ": invalid username\n" );
2216 // Allow extensions to prevent user notification when a new message is added to their talk page
2217 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2218 if ( User
::isIP( $shortTitle ) ) {
2219 // An anonymous user
2220 $recipient->setNewtalk( true, $revision );
2221 } elseif ( $recipient->isLoggedIn() ) {
2222 $recipient->setNewtalk( true, $revision );
2224 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2230 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2231 // XXX: could skip pseudo-messages like js/css here, based on content model.
2232 $msgtext = $content ?
$content->getWikitextForTransclusion() : null;
2233 if ( $msgtext === false ||
$msgtext === null ) {
2237 MessageCache
::singleton()->replace( $shortTitle, $msgtext );
2240 if ( $options['created'] ) {
2241 self
::onArticleCreate( $this->mTitle
);
2242 } elseif ( $options['changed'] ) { // bug 50785
2243 self
::onArticleEdit( $this->mTitle
);
2249 * Edit an article without doing all that other stuff
2250 * The article must already exist; link tables etc
2251 * are not updated, caches are not flushed.
2253 * @param string $text Text submitted
2254 * @param User $user The relevant user
2255 * @param string $comment Comment submitted
2256 * @param bool $minor Whereas it's a minor modification
2258 * @deprecated since 1.21, use doEditContent() instead.
2260 public function doQuickEdit( $text, User
$user, $comment = '', $minor = 0 ) {
2261 ContentHandler
::deprecated( __METHOD__
, "1.21" );
2263 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2264 $this->doQuickEditContent( $content, $user, $comment, $minor );
2268 * Edit an article without doing all that other stuff
2269 * The article must already exist; link tables etc
2270 * are not updated, caches are not flushed.
2272 * @param Content $content Content submitted
2273 * @param User $user The relevant user
2274 * @param string $comment Comment submitted
2275 * @param bool $minor Whereas it's a minor modification
2276 * @param string $serialFormat Format for storing the content in the database
2278 public function doQuickEditContent( Content
$content, User
$user, $comment = '', $minor = false,
2279 $serialFormat = null
2282 $serialized = $content->serialize( $serialFormat );
2284 $dbw = wfGetDB( DB_MASTER
);
2285 $revision = new Revision( array(
2286 'title' => $this->getTitle(), // for determining the default content model
2287 'page' => $this->getId(),
2288 'user_text' => $user->getName(),
2289 'user' => $user->getId(),
2290 'text' => $serialized,
2291 'length' => $content->getSize(),
2292 'comment' => $comment,
2293 'minor_edit' => $minor ?
1 : 0,
2294 ) ); // XXX: set the content object?
2295 $revision->insertOn( $dbw );
2296 $this->updateRevisionOn( $dbw, $revision );
2298 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2303 * Update the article's restriction field, and leave a log entry.
2304 * This works for protection both existing and non-existing pages.
2306 * @param array $limit Set of restriction keys
2307 * @param array $expiry Per restriction type expiration
2308 * @param int &$cascade Set to false if cascading protection isn't allowed.
2309 * @param string $reason
2310 * @param User $user The user updating the restrictions
2313 public function doUpdateRestrictions( array $limit, array $expiry,
2314 &$cascade, $reason, User
$user
2316 global $wgCascadingRestrictionLevels, $wgContLang;
2318 if ( wfReadOnly() ) {
2319 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
2322 $this->loadPageData( 'fromdbmaster' );
2323 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2324 $id = $this->getId();
2330 // Take this opportunity to purge out expired restrictions
2331 Title
::purgeExpiredRestrictions();
2333 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2334 // we expect a single selection, but the schema allows otherwise.
2335 $isProtected = false;
2339 $dbw = wfGetDB( DB_MASTER
);
2341 foreach ( $restrictionTypes as $action ) {
2342 if ( !isset( $expiry[$action] ) ) {
2343 $expiry[$action] = $dbw->getInfinity();
2345 if ( !isset( $limit[$action] ) ) {
2346 $limit[$action] = '';
2347 } elseif ( $limit[$action] != '' ) {
2351 // Get current restrictions on $action
2352 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2353 if ( $current != '' ) {
2354 $isProtected = true;
2357 if ( $limit[$action] != $current ) {
2359 } elseif ( $limit[$action] != '' ) {
2360 // Only check expiry change if the action is actually being
2361 // protected, since expiry does nothing on an not-protected
2363 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2369 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2373 // If nothing has changed, do nothing
2375 return Status
::newGood();
2378 if ( !$protect ) { // No protection at all means unprotection
2379 $revCommentMsg = 'unprotectedarticle';
2380 $logAction = 'unprotect';
2381 } elseif ( $isProtected ) {
2382 $revCommentMsg = 'modifiedarticleprotection';
2383 $logAction = 'modify';
2385 $revCommentMsg = 'protectedarticle';
2386 $logAction = 'protect';
2389 // Truncate for whole multibyte characters
2390 $reason = $wgContLang->truncate( $reason, 255 );
2392 $logRelationsValues = array();
2393 $logRelationsField = null;
2395 if ( $id ) { // Protection of existing page
2396 if ( !Hooks
::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2397 return Status
::newGood();
2400 // Only certain restrictions can cascade...
2401 $editrestriction = isset( $limit['edit'] )
2402 ?
array( $limit['edit'] )
2403 : $this->mTitle
->getRestrictions( 'edit' );
2404 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2405 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2407 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2408 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2411 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2412 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2413 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2415 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2416 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2419 // The schema allows multiple restrictions
2420 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2424 // insert null revision to identify the page protection change as edit summary
2425 $latest = $this->getLatest();
2426 $nullRevision = $this->insertProtectNullRevision(
2435 if ( $nullRevision === null ) {
2436 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2439 $logRelationsField = 'pr_id';
2441 // Update restrictions table
2442 foreach ( $limit as $action => $restrictions ) {
2444 'page_restrictions',
2447 'pr_type' => $action
2451 if ( $restrictions != '' ) {
2453 'page_restrictions',
2455 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2457 'pr_type' => $action,
2458 'pr_level' => $restrictions,
2459 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2460 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2464 $logRelationsValues[] = $dbw->insertId();
2468 // Clear out legacy restriction fields
2471 array( 'page_restrictions' => '' ),
2472 array( 'page_id' => $id ),
2476 Hooks
::run( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2477 Hooks
::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2478 } else { // Protection of non-existing page (also known as "title protection")
2479 // Cascade protection is meaningless in this case
2482 if ( $limit['create'] != '' ) {
2483 $dbw->replace( 'protected_titles',
2484 array( array( 'pt_namespace', 'pt_title' ) ),
2486 'pt_namespace' => $this->mTitle
->getNamespace(),
2487 'pt_title' => $this->mTitle
->getDBkey(),
2488 'pt_create_perm' => $limit['create'],
2489 'pt_timestamp' => $dbw->timestamp(),
2490 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2491 'pt_user' => $user->getId(),
2492 'pt_reason' => $reason,
2496 $dbw->delete( 'protected_titles',
2498 'pt_namespace' => $this->mTitle
->getNamespace(),
2499 'pt_title' => $this->mTitle
->getDBkey()
2505 $this->mTitle
->flushRestrictions();
2506 InfoAction
::invalidateCache( $this->mTitle
);
2508 if ( $logAction == 'unprotect' ) {
2511 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2512 $params = array( $protectDescriptionLog, $cascade ?
'cascade' : '' );
2515 // Update the protection log
2516 $log = new LogPage( 'protect' );
2517 $logId = $log->addEntry( $logAction, $this->mTitle
, $reason, $params, $user );
2518 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2519 $log->addRelations( $logRelationsField, $logRelationsValues, $logId );
2522 return Status
::newGood();
2526 * Insert a new null revision for this page.
2528 * @param string $revCommentMsg Comment message key for the revision
2529 * @param array $limit Set of restriction keys
2530 * @param array $expiry Per restriction type expiration
2531 * @param int $cascade Set to false if cascading protection isn't allowed.
2532 * @param string $reason
2533 * @param User|null $user
2534 * @return Revision|null Null on error
2536 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2537 array $expiry, $cascade, $reason, $user = null
2540 $dbw = wfGetDB( DB_MASTER
);
2542 // Prepare a null revision to be added to the history
2543 $editComment = $wgContLang->ucfirst(
2546 $this->mTitle
->getPrefixedText()
2547 )->inContentLanguage()->text()
2550 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2552 $protectDescription = $this->protectDescription( $limit, $expiry );
2553 if ( $protectDescription ) {
2554 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2555 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2556 ->inContentLanguage()->text();
2559 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2560 $editComment .= wfMessage( 'brackets' )->params(
2561 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2562 )->inContentLanguage()->text();
2565 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2567 $nullRev->insertOn( $dbw );
2569 // Update page record and touch page
2570 $oldLatest = $nullRev->getParentId();
2571 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2578 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2581 protected function formatExpiry( $expiry ) {
2583 $dbr = wfGetDB( DB_SLAVE
);
2585 $encodedExpiry = $dbr->encodeExpiry( $expiry );
2586 if ( $encodedExpiry != 'infinity' ) {
2589 $wgContLang->timeanddate( $expiry, false, false ),
2590 $wgContLang->date( $expiry, false, false ),
2591 $wgContLang->time( $expiry, false, false )
2592 )->inContentLanguage()->text();
2594 return wfMessage( 'protect-expiry-indefinite' )
2595 ->inContentLanguage()->text();
2600 * Builds the description to serve as comment for the edit.
2602 * @param array $limit Set of restriction keys
2603 * @param array $expiry Per restriction type expiration
2606 public function protectDescription( array $limit, array $expiry ) {
2607 $protectDescription = '';
2609 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2610 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2611 # All possible message keys are listed here for easier grepping:
2612 # * restriction-create
2613 # * restriction-edit
2614 # * restriction-move
2615 # * restriction-upload
2616 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2617 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2618 # with '' filtered out. All possible message keys are listed below:
2619 # * protect-level-autoconfirmed
2620 # * protect-level-sysop
2621 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2623 $expiryText = $this->formatExpiry( $expiry[$action] );
2625 if ( $protectDescription !== '' ) {
2626 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2628 $protectDescription .= wfMessage( 'protect-summary-desc' )
2629 ->params( $actionText, $restrictionsText, $expiryText )
2630 ->inContentLanguage()->text();
2633 return $protectDescription;
2637 * Builds the description to serve as comment for the log entry.
2639 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2640 * protect description text. Keep them in old format to avoid breaking compatibility.
2641 * TODO: Fix protection log to store structured description and format it on-the-fly.
2643 * @param array $limit Set of restriction keys
2644 * @param array $expiry Per restriction type expiration
2647 public function protectDescriptionLog( array $limit, array $expiry ) {
2650 $protectDescriptionLog = '';
2652 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2653 $expiryText = $this->formatExpiry( $expiry[$action] );
2654 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] ($expiryText)";
2657 return trim( $protectDescriptionLog );
2661 * Take an array of page restrictions and flatten it to a string
2662 * suitable for insertion into the page_restrictions field.
2664 * @param string[] $limit
2666 * @throws MWException
2669 protected static function flattenRestrictions( $limit ) {
2670 if ( !is_array( $limit ) ) {
2671 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2677 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2678 $bits[] = "$action=$restrictions";
2681 return implode( ':', $bits );
2685 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2686 * backwards compatibility, if you care about error reporting you should use
2687 * doDeleteArticleReal() instead.
2689 * Deletes the article with database consistency, writes logs, purges caches
2691 * @param string $reason Delete reason for deletion log
2692 * @param bool $suppress Suppress all revisions and log the deletion in
2693 * the suppression log instead of the deletion log
2694 * @param int $id Article ID
2695 * @param bool $commit Defaults to true, triggers transaction end
2696 * @param array &$error Array of errors to append to
2697 * @param User $user The deleting user
2698 * @return bool True if successful
2700 public function doDeleteArticle(
2701 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2703 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2704 return $status->isGood();
2708 * Back-end article deletion
2709 * Deletes the article with database consistency, writes logs, purges caches
2713 * @param string $reason Delete reason for deletion log
2714 * @param bool $suppress Suppress all revisions and log the deletion in
2715 * the suppression log instead of the deletion log
2716 * @param int $id Article ID
2717 * @param bool $commit Defaults to true, triggers transaction end
2718 * @param array &$error Array of errors to append to
2719 * @param User $user The deleting user
2720 * @return Status Status object; if successful, $status->value is the log_id of the
2721 * deletion log entry. If the page couldn't be deleted because it wasn't
2722 * found, $status is a non-fatal 'cannotdelete' error
2724 public function doDeleteArticleReal(
2725 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2727 global $wgUser, $wgContentHandlerUseDB;
2729 wfDebug( __METHOD__
. "\n" );
2731 $status = Status
::newGood();
2733 if ( $this->mTitle
->getDBkey() === '' ) {
2734 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2738 $user = is_null( $user ) ?
$wgUser : $user;
2739 if ( !Hooks
::run( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2740 if ( $status->isOK() ) {
2741 // Hook aborted but didn't set a fatal status
2742 $status->fatal( 'delete-hook-aborted' );
2747 $dbw = wfGetDB( DB_MASTER
);
2748 $dbw->begin( __METHOD__
);
2751 $this->loadPageData( 'forupdate' );
2752 $id = $this->getID();
2754 $dbw->rollback( __METHOD__
);
2755 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2760 // we need to remember the old content so we can use it to generate all deletion updates.
2761 $content = $this->getContent( Revision
::RAW
);
2763 // Bitfields to further suppress the content
2766 // This should be 15...
2767 $bitfield |
= Revision
::DELETED_TEXT
;
2768 $bitfield |
= Revision
::DELETED_COMMENT
;
2769 $bitfield |
= Revision
::DELETED_USER
;
2770 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2772 $bitfield = 'rev_deleted';
2775 // For now, shunt the revision data into the archive table.
2776 // Text is *not* removed from the text table; bulk storage
2777 // is left intact to avoid breaking block-compression or
2778 // immutable storage schemes.
2780 // For backwards compatibility, note that some older archive
2781 // table entries will have ar_text and ar_flags fields still.
2783 // In the future, we may keep revisions and mark them with
2784 // the rev_deleted field, which is reserved for this purpose.
2787 'ar_namespace' => 'page_namespace',
2788 'ar_title' => 'page_title',
2789 'ar_comment' => 'rev_comment',
2790 'ar_user' => 'rev_user',
2791 'ar_user_text' => 'rev_user_text',
2792 'ar_timestamp' => 'rev_timestamp',
2793 'ar_minor_edit' => 'rev_minor_edit',
2794 'ar_rev_id' => 'rev_id',
2795 'ar_parent_id' => 'rev_parent_id',
2796 'ar_text_id' => 'rev_text_id',
2797 'ar_text' => '\'\'', // Be explicit to appease
2798 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2799 'ar_len' => 'rev_len',
2800 'ar_page_id' => 'page_id',
2801 'ar_deleted' => $bitfield,
2802 'ar_sha1' => 'rev_sha1',
2805 if ( $wgContentHandlerUseDB ) {
2806 $row['ar_content_model'] = 'rev_content_model';
2807 $row['ar_content_format'] = 'rev_content_format';
2810 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2814 'page_id = rev_page'
2818 // Now that it's safely backed up, delete it
2819 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2820 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2823 $dbw->rollback( __METHOD__
);
2824 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2828 if ( !$dbw->cascadingDeletes() ) {
2829 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
2832 // Clone the title, so we have the information we need when we log
2833 $logTitle = clone $this->mTitle
;
2835 // Log the deletion, if the page was suppressed, log it at Oversight instead
2836 $logtype = $suppress ?
'suppress' : 'delete';
2838 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2839 $logEntry->setPerformer( $user );
2840 $logEntry->setTarget( $logTitle );
2841 $logEntry->setComment( $reason );
2842 $logid = $logEntry->insert();
2844 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2845 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2846 $logEntry->publish( $logid );
2850 $dbw->commit( __METHOD__
);
2853 $this->doDeleteUpdates( $id, $content );
2855 Hooks
::run( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2856 $status->value
= $logid;
2861 * Do some database updates after deletion
2863 * @param int $id The page_id value of the page being deleted
2864 * @param Content $content Optional page content to be used when determining
2865 * the required updates. This may be needed because $this->getContent()
2866 * may already return null when the page proper was deleted.
2868 public function doDeleteUpdates( $id, Content
$content = null ) {
2869 // update site status
2870 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2872 // remove secondary indexes, etc
2873 $updates = $this->getDeletionUpdates( $content );
2874 DataUpdate
::runUpdates( $updates );
2876 // Reparse any pages transcluding this page
2877 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
2879 // Reparse any pages including this image
2880 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
2881 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
2885 WikiPage
::onArticleDelete( $this->mTitle
);
2887 // Reset this object and the Title object
2888 $this->loadFromRow( false, self
::READ_LATEST
);
2891 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
2895 * Roll back the most recent consecutive set of edits to a page
2896 * from the same user; fails if there are no eligible edits to
2897 * roll back to, e.g. user is the sole contributor. This function
2898 * performs permissions checks on $user, then calls commitRollback()
2899 * to do the dirty work
2901 * @todo Separate the business/permission stuff out from backend code
2903 * @param string $fromP Name of the user whose edits to rollback.
2904 * @param string $summary Custom summary. Set to default summary if empty.
2905 * @param string $token Rollback token.
2906 * @param bool $bot If true, mark all reverted edits as bot.
2908 * @param array $resultDetails Array contains result-specific array of additional values
2909 * 'alreadyrolled' : 'current' (rev)
2910 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2912 * @param User $user The user performing the rollback
2913 * @return array Array of errors, each error formatted as
2914 * array(messagekey, param1, param2, ...).
2915 * On success, the array is empty. This array can also be passed to
2916 * OutputPage::showPermissionsErrorPage().
2918 public function doRollback(
2919 $fromP, $summary, $token, $bot, &$resultDetails, User
$user
2921 $resultDetails = null;
2923 // Check permissions
2924 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
2925 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
2926 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2928 if ( !$user->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
2929 $errors[] = array( 'sessionfailure' );
2932 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
2933 $errors[] = array( 'actionthrottledtext' );
2936 // If there were errors, bail out now
2937 if ( !empty( $errors ) ) {
2941 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2945 * Backend implementation of doRollback(), please refer there for parameter
2946 * and return value documentation
2948 * NOTE: This function does NOT check ANY permissions, it just commits the
2949 * rollback to the DB. Therefore, you should only call this function direct-
2950 * ly if you want to use custom permissions checks. If you don't, use
2951 * doRollback() instead.
2952 * @param string $fromP Name of the user whose edits to rollback.
2953 * @param string $summary Custom summary. Set to default summary if empty.
2954 * @param bool $bot If true, mark all reverted edits as bot.
2956 * @param array $resultDetails Contains result-specific array of additional values
2957 * @param User $guser The user performing the rollback
2960 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser ) {
2961 global $wgUseRCPatrol, $wgContLang;
2963 $dbw = wfGetDB( DB_MASTER
);
2965 if ( wfReadOnly() ) {
2966 return array( array( 'readonlytext' ) );
2969 // Get the last editor
2970 $current = $this->getRevision();
2971 if ( is_null( $current ) ) {
2972 // Something wrong... no page?
2973 return array( array( 'notanarticle' ) );
2976 $from = str_replace( '_', ' ', $fromP );
2977 // User name given should match up with the top revision.
2978 // If the user was deleted then $from should be empty.
2979 if ( $from != $current->getUserText() ) {
2980 $resultDetails = array( 'current' => $current );
2981 return array( array( 'alreadyrolled',
2982 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
2983 htmlspecialchars( $fromP ),
2984 htmlspecialchars( $current->getUserText() )
2988 // Get the last edit not by this guy...
2989 // Note: these may not be public values
2990 $user = intval( $current->getRawUser() );
2991 $user_text = $dbw->addQuotes( $current->getRawUserText() );
2992 $s = $dbw->selectRow( 'revision',
2993 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
2994 array( 'rev_page' => $current->getPage(),
2995 "rev_user != {$user} OR rev_user_text != {$user_text}"
2997 array( 'USE INDEX' => 'page_timestamp',
2998 'ORDER BY' => 'rev_timestamp DESC' )
3000 if ( $s === false ) {
3001 // No one else ever edited this page
3002 return array( array( 'cantrollback' ) );
3003 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3004 ||
$s->rev_deleted
& Revision
::DELETED_USER
3006 // Only admins can see this text
3007 return array( array( 'notvisiblerev' ) );
3010 // Set patrolling and bot flag on the edits, which gets rollbacked.
3011 // This is done before the rollback edit to have patrolling also on failure (bug 62157).
3013 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3014 // Mark all reverted edits as bot
3018 if ( $wgUseRCPatrol ) {
3019 // Mark all reverted edits as patrolled
3020 $set['rc_patrolled'] = 1;
3023 if ( count( $set ) ) {
3024 $dbw->update( 'recentchanges', $set,
3026 'rc_cur_id' => $current->getPage(),
3027 'rc_user_text' => $current->getUserText(),
3028 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3033 // Generate the edit summary if necessary
3034 $target = Revision
::newFromId( $s->rev_id
);
3035 if ( empty( $summary ) ) {
3036 if ( $from == '' ) { // no public user name
3037 $summary = wfMessage( 'revertpage-nouser' );
3039 $summary = wfMessage( 'revertpage' );
3043 // Allow the custom summary to use the same args as the default message
3045 $target->getUserText(), $from, $s->rev_id
,
3046 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3047 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3049 if ( $summary instanceof Message
) {
3050 $summary = $summary->params( $args )->inContentLanguage()->text();
3052 $summary = wfMsgReplaceArgs( $summary, $args );
3055 // Trim spaces on user supplied text
3056 $summary = trim( $summary );
3058 // Truncate for whole multibyte characters.
3059 $summary = $wgContLang->truncate( $summary, 255 );
3062 $flags = EDIT_UPDATE
;
3064 if ( $guser->isAllowed( 'minoredit' ) ) {
3065 $flags |
= EDIT_MINOR
;
3068 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3069 $flags |
= EDIT_FORCE_BOT
;
3072 // Actually store the edit
3073 $status = $this->doEditContent(
3074 $target->getContent(),
3081 if ( !$status->isOK() ) {
3082 return $status->getErrorsArray();
3085 // raise error, when the edit is an edit without a new version
3086 if ( empty( $status->value
['revision'] ) ) {
3087 $resultDetails = array( 'current' => $current );
3088 return array( array( 'alreadyrolled',
3089 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3090 htmlspecialchars( $fromP ),
3091 htmlspecialchars( $current->getUserText() )
3095 $revId = $status->value
['revision']->getId();
3097 Hooks
::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3099 $resultDetails = array(
3100 'summary' => $summary,
3101 'current' => $current,
3102 'target' => $target,
3110 * The onArticle*() functions are supposed to be a kind of hooks
3111 * which should be called whenever any of the specified actions
3114 * This is a good place to put code to clear caches, for instance.
3116 * This is called on page move and undelete, as well as edit
3118 * @param Title $title
3120 public static function onArticleCreate( Title
$title ) {
3121 // Update existence markers on article/talk tabs...
3122 $other = $title->getOtherPage();
3124 $other->invalidateCache();
3125 $other->purgeSquid();
3127 $title->touchLinks();
3128 $title->purgeSquid();
3129 $title->deleteTitleProtection();
3133 * Clears caches when article is deleted
3135 * @param Title $title
3137 public static function onArticleDelete( Title
$title ) {
3138 // Update existence markers on article/talk tabs...
3139 $other = $title->getOtherPage();
3141 $other->invalidateCache();
3142 $other->purgeSquid();
3144 $title->touchLinks();
3145 $title->purgeSquid();
3148 HTMLFileCache
::clearFileCache( $title );
3149 InfoAction
::invalidateCache( $title );
3152 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3153 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3157 if ( $title->getNamespace() == NS_FILE
) {
3158 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3159 $update->doUpdate();
3163 if ( $title->getNamespace() == NS_USER_TALK
) {
3164 $user = User
::newFromName( $title->getText(), false );
3166 $user->setNewtalk( false );
3171 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3175 * Purge caches on page update etc
3177 * @param Title $title
3179 public static function onArticleEdit( Title
$title ) {
3180 // Invalidate caches of articles which include this page
3181 DeferredUpdates
::addHTMLCacheUpdate( $title, 'templatelinks' );
3183 // Invalidate the caches of all pages which redirect here
3184 DeferredUpdates
::addHTMLCacheUpdate( $title, 'redirect' );
3186 // Purge squid for this page only
3187 $title->purgeSquid();
3189 // Clear file cache for this page only
3190 HTMLFileCache
::clearFileCache( $title );
3191 InfoAction
::invalidateCache( $title );
3197 * Returns a list of categories this page is a member of.
3198 * Results will include hidden categories
3200 * @return TitleArray
3202 public function getCategories() {
3203 $id = $this->getId();
3205 return TitleArray
::newFromResult( new FakeResultWrapper( array() ) );
3208 $dbr = wfGetDB( DB_SLAVE
);
3209 $res = $dbr->select( 'categorylinks',
3210 array( 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ),
3211 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3212 // as not being aliases, and NS_CATEGORY is numeric
3213 array( 'cl_from' => $id ),
3216 return TitleArray
::newFromResult( $res );
3220 * Returns a list of hidden categories this page is a member of.
3221 * Uses the page_props and categorylinks tables.
3223 * @return array Array of Title objects
3225 public function getHiddenCategories() {
3227 $id = $this->getId();
3233 $dbr = wfGetDB( DB_SLAVE
);
3234 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3236 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3237 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
3240 if ( $res !== false ) {
3241 foreach ( $res as $row ) {
3242 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3250 * Return an applicable autosummary if one exists for the given edit.
3251 * @param string|null $oldtext The previous text of the page.
3252 * @param string|null $newtext The submitted text of the page.
3253 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3254 * @return string An appropriate autosummary, or an empty string.
3256 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3258 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3259 // NOTE: stub for backwards-compatibility. assumes the given text is
3260 // wikitext. will break horribly if it isn't.
3262 ContentHandler
::deprecated( __METHOD__
, '1.21' );
3264 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
3265 $oldContent = is_null( $oldtext ) ?
null : $handler->unserializeContent( $oldtext );
3266 $newContent = is_null( $newtext ) ?
null : $handler->unserializeContent( $newtext );
3268 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3272 * Auto-generates a deletion reason
3274 * @param bool &$hasHistory Whether the page has a history
3275 * @return string|bool String containing deletion reason or empty string, or boolean false
3276 * if no revision occurred
3278 public function getAutoDeleteReason( &$hasHistory ) {
3279 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3283 * Update all the appropriate counts in the category table, given that
3284 * we've added the categories $added and deleted the categories $deleted.
3286 * @param array $added The names of categories that were added
3287 * @param array $deleted The names of categories that were deleted
3289 public function updateCategoryCounts( array $added, array $deleted ) {
3291 $method = __METHOD__
;
3292 $dbw = wfGetDB( DB_MASTER
);
3294 // Do this at the end of the commit to reduce lock wait timeouts
3295 $dbw->onTransactionPreCommitOrIdle(
3296 function () use ( $dbw, $that, $method, $added, $deleted ) {
3297 $ns = $that->getTitle()->getNamespace();
3299 $addFields = array( 'cat_pages = cat_pages + 1' );
3300 $removeFields = array( 'cat_pages = cat_pages - 1' );
3301 if ( $ns == NS_CATEGORY
) {
3302 $addFields[] = 'cat_subcats = cat_subcats + 1';
3303 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3304 } elseif ( $ns == NS_FILE
) {
3305 $addFields[] = 'cat_files = cat_files + 1';
3306 $removeFields[] = 'cat_files = cat_files - 1';
3309 if ( count( $added ) ) {
3310 $insertRows = array();
3311 foreach ( $added as $cat ) {
3312 $insertRows[] = array(
3313 'cat_title' => $cat,
3315 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3316 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3322 array( 'cat_title' ),
3328 if ( count( $deleted ) ) {
3332 array( 'cat_title' => $deleted ),
3337 foreach ( $added as $catName ) {
3338 $cat = Category
::newFromName( $catName );
3339 Hooks
::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3342 foreach ( $deleted as $catName ) {
3343 $cat = Category
::newFromName( $catName );
3344 Hooks
::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3351 * Updates cascading protections
3353 * @param ParserOutput $parserOutput ParserOutput object for the current version
3355 public function doCascadeProtectionUpdates( ParserOutput
$parserOutput ) {
3356 if ( wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
3360 // templatelinks or imagelinks tables may have become out of sync,
3361 // especially if using variable-based transclusions.
3362 // For paranoia, check if things have changed and if
3363 // so apply updates to the database. This will ensure
3364 // that cascaded protections apply as soon as the changes
3367 // Get templates from templatelinks and images from imagelinks
3368 $id = $this->getId();
3372 $dbr = wfGetDB( DB_SLAVE
);
3373 $res = $dbr->select( array( 'templatelinks' ),
3374 array( 'tl_namespace', 'tl_title' ),
3375 array( 'tl_from' => $id ),
3379 foreach ( $res as $row ) {
3380 $dbLinks["{$row->tl_namespace}:{$row->tl_title}"] = true;
3383 $dbr = wfGetDB( DB_SLAVE
);
3384 $res = $dbr->select( array( 'imagelinks' ),
3386 array( 'il_from' => $id ),
3390 foreach ( $res as $row ) {
3391 $dbLinks[NS_FILE
. ":{$row->il_to}"] = true;
3394 // Get templates and images from parser output.
3396 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
3397 foreach ( $templates as $dbk => $id ) {
3398 $poLinks["$ns:$dbk"] = true;
3401 foreach ( $parserOutput->getImages() as $dbk => $id ) {
3402 $poLinks[NS_FILE
. ":$dbk"] = true;
3406 $links_diff = array_diff_key( $poLinks, $dbLinks );
3408 if ( count( $links_diff ) > 0 ) {
3409 // Whee, link updates time.
3410 // Note: we are only interested in links here. We don't need to get
3411 // other DataUpdate items from the parser output.
3412 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
3418 * Return a list of templates used by this article.
3419 * Uses the templatelinks table
3421 * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3422 * @return array Array of Title objects
3424 public function getUsedTemplates() {
3425 return $this->mTitle
->getTemplateLinksFrom();
3429 * This function is called right before saving the wikitext,
3430 * so we can do things like signatures and links-in-context.
3432 * @deprecated since 1.19; use Parser::preSaveTransform() instead
3433 * @param string $text Article contents
3434 * @param User $user User doing the edit
3435 * @param ParserOptions $popts Parser options, default options for
3436 * the user loaded if null given
3437 * @return string Article contents with altered wikitext markup (signatures
3438 * converted, {{subst:}}, templates, etc.)
3440 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
3441 global $wgParser, $wgUser;
3443 wfDeprecated( __METHOD__
, '1.19' );
3445 $user = is_null( $user ) ?
$wgUser : $user;
3447 if ( $popts === null ) {
3448 $popts = ParserOptions
::newFromUser( $user );
3451 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
3455 * Update the article's restriction field, and leave a log entry.
3457 * @deprecated since 1.19
3458 * @param array $limit Set of restriction keys
3459 * @param string $reason
3460 * @param int &$cascade Set to false if cascading protection isn't allowed.
3461 * @param array $expiry Per restriction type expiration
3462 * @param User $user The user updating the restrictions
3463 * @return bool True on success
3465 public function updateRestrictions(
3466 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User
$user = null
3470 $user = is_null( $user ) ?
$wgUser : $user;
3472 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3476 * Returns a list of updates to be performed when this page is deleted. The
3477 * updates should remove any information about this page from secondary data
3478 * stores such as links tables.
3480 * @param Content|null $content Optional Content object for determining the
3481 * necessary updates.
3482 * @return array An array of DataUpdates objects
3484 public function getDeletionUpdates( Content
$content = null ) {
3486 // load content object, which may be used to determine the necessary updates
3487 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3488 $content = $this->getContent( Revision
::RAW
);
3494 $updates = $content->getDeletionUpdates( $this );
3497 Hooks
::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );