3 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
8 * Class representing a MediaWiki article and history.
10 * Some fields are public only for backwards-compatibility. Use accessors.
11 * In the past, this class was part of Article.php and everything was public.
13 * @internal documentation reviewed 15 Mar 2010
15 class WikiPage
extends Page
{
19 public $mTitle = null;
24 public $mDataLoaded = false; // !< Boolean
25 public $mIsRedirect = false; // !< Boolean
26 public $mLatest = false; // !< Integer (false means "not loaded")
27 public $mPreparedEdit = false; // !< Array
32 protected $mRedirectTarget = null;
37 protected $mLastRevision = null;
39 protected $mTimestamp = ''; // !< String
40 protected $mTouched = '19700101000000'; // !< String
44 * Constructor and clear the article
45 * @param $title Title Reference to a Title object.
47 public function __construct( Title
$title ) {
48 $this->mTitle
= $title;
52 * Create a WikiPage object of the appropriate class for the given title.
55 * @return WikiPage object of the appropriate type
57 public static function factory( Title
$title ) {
58 $ns = $title->getNamespace();
60 if ( $ns == NS_MEDIA
) {
61 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
62 } elseif ( $ns < 0 ) {
63 throw new MWException( "Invalid or virtual namespace $ns given." );
68 $page = new WikiFilePage( $title );
71 $page = new WikiCategoryPage( $title );
74 $page = new WikiPage( $title );
81 * Constructor from a page id
83 * @param $id Int article ID to load
87 public static function newFromID( $id ) {
88 $t = Title
::newFromID( $id );
90 return self
::factory( $t );
96 * Returns overrides for action handlers.
97 * Classes listed here will be used instead of the default one when
98 * (and only when) $wgActions[$action] === true. This allows subclasses
99 * to override the default behavior.
101 * @todo: move this UI stuff somewhere else
105 public function getActionOverrides() {
110 * If this page is a redirect, get its target
112 * The target will be fetched from the redirect table if possible.
113 * If this page doesn't have an entry there, call insertRedirect()
114 * @return Title|mixed object, or null if this page is not a redirect
116 public function getRedirectTarget() {
117 if ( !$this->mTitle
->isRedirect() ) {
121 if ( $this->mRedirectTarget
!== null ) {
122 return $this->mRedirectTarget
;
125 # Query the redirect table
126 $dbr = wfGetDB( DB_SLAVE
);
127 $row = $dbr->selectRow( 'redirect',
128 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
129 array( 'rd_from' => $this->getId() ),
133 // rd_fragment and rd_interwiki were added later, populate them if empty
134 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
135 return $this->mRedirectTarget
= Title
::makeTitle(
136 $row->rd_namespace
, $row->rd_title
,
137 $row->rd_fragment
, $row->rd_interwiki
);
140 # This page doesn't have an entry in the redirect table
141 return $this->mRedirectTarget
= $this->insertRedirect();
145 * Insert an entry for this page into the redirect table.
147 * Don't call this function directly unless you know what you're doing.
148 * @return Title object or null if not a redirect
150 public function insertRedirect() {
151 // recurse through to only get the final target
152 $retval = Title
::newFromRedirectRecurse( $this->getRawText() );
156 $this->insertRedirectEntry( $retval );
161 * Insert or update the redirect table entry for this page to indicate
162 * it redirects to $rt .
163 * @param $rt Title redirect target
165 public function insertRedirectEntry( $rt ) {
166 $dbw = wfGetDB( DB_MASTER
);
167 $dbw->replace( 'redirect', array( 'rd_from' ),
169 'rd_from' => $this->getId(),
170 'rd_namespace' => $rt->getNamespace(),
171 'rd_title' => $rt->getDBkey(),
172 'rd_fragment' => $rt->getFragment(),
173 'rd_interwiki' => $rt->getInterwiki(),
180 * Get the Title object or URL this page redirects to
182 * @return mixed false, Title of in-wiki target, or string with URL
184 public function followRedirect() {
185 return $this->getRedirectURL( $this->getRedirectTarget() );
189 * Get the Title object or URL to use for a redirect. We use Title
190 * objects for same-wiki, non-special redirects and URLs for everything
192 * @param $rt Title Redirect target
193 * @return mixed false, Title object of local target, or string with URL
195 public function getRedirectURL( $rt ) {
197 if ( $rt->getInterwiki() != '' ) {
198 if ( $rt->isLocal() ) {
199 // Offsite wikis need an HTTP redirect.
201 // This can be hard to reverse and may produce loops,
202 // so they may be disabled in the site configuration.
203 $source = $this->mTitle
->getFullURL( 'redirect=no' );
204 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
207 if ( $rt->isSpecialPage() ) {
208 // Gotta handle redirects to special pages differently:
209 // Fill the HTTP response "Location" header and ignore
210 // the rest of the page we're on.
212 // This can be hard to reverse, so they may be disabled.
213 if ( $rt->isSpecial( 'Userlogout' ) ) {
216 return $rt->getFullURL();
224 // No or invalid redirect
229 * Get the title object of the article
230 * @return Title object of this page
232 public function getTitle() {
233 return $this->mTitle
;
239 public function clear() {
240 $this->mDataLoaded
= false;
242 $this->mRedirectTarget
= null; # Title object if set
243 $this->mLastRevision
= null; # Latest revision
244 $this->mTimestamp
= '';
245 $this->mTouched
= '19700101000000';
246 $this->mIsRedirect
= false;
247 $this->mLatest
= false;
248 $this->mPreparedEdit
= false;
252 * Get the text that needs to be saved in order to undo all revisions
253 * between $undo and $undoafter. Revisions must belong to the same page,
254 * must exist and must not be deleted
255 * @param $undo Revision
256 * @param $undoafter Revision Must be an earlier revision than $undo
257 * @return mixed string on success, false on failure
259 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
260 $cur_text = $this->getRawText();
261 if ( $cur_text === false ) {
262 return false; // no page
264 $undo_text = $undo->getText();
265 $undoafter_text = $undoafter->getText();
267 if ( $cur_text == $undo_text ) {
268 # No use doing a merge if it's just a straight revert.
269 return $undoafter_text;
274 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
282 * Return the list of revision fields that should be selected to create
287 public static function selectFields() {
304 * Fetch a page record with the given conditions
305 * @param $dbr DatabaseBase object
306 * @param $conditions Array
307 * @return mixed Database result resource, or false on failure
309 protected function pageData( $dbr, $conditions ) {
310 $fields = self
::selectFields();
312 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
314 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
316 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
322 * Fetch a page record matching the Title object's namespace and title
323 * using a sanitized title string
325 * @param $dbr DatabaseBase object
326 * @param $title Title object
327 * @return mixed Database result resource, or false on failure
329 public function pageDataFromTitle( $dbr, $title ) {
330 return $this->pageData( $dbr, array(
331 'page_namespace' => $title->getNamespace(),
332 'page_title' => $title->getDBkey() ) );
336 * Fetch a page record matching the requested ID
338 * @param $dbr DatabaseBase
340 * @return mixed Database result resource, or false on failure
342 public function pageDataFromId( $dbr, $id ) {
343 return $this->pageData( $dbr, array( 'page_id' => $id ) );
347 * Set the general counter, title etc data loaded from
350 * @param $data Object|String One of the following:
351 * A DB query result object or...
352 * "fromdb" to get from a slave DB or...
353 * "fromdbmaster" to get from the master DB
356 public function loadPageData( $data = 'fromdb' ) {
357 if ( $data === 'fromdbmaster' ) {
358 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
359 } elseif ( $data === 'fromdb' ) { // slave
360 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE
), $this->mTitle
);
361 # Use a "last rev inserted" timestamp key to dimish the issue of slave lag.
362 # Note that DB also stores the master position in the session and checks it.
363 $touched = $this->getCachedLastEditTime();
364 if ( $touched ) { // key set
365 if ( !$data ||
$touched > wfTimestamp( TS_MW
, $data->page_touched
) ) {
366 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
371 $lc = LinkCache
::singleton();
374 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
376 $this->mTitle
->loadFromRow( $data );
378 # Old-fashioned restrictions
379 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
381 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
382 $this->mIsRedirect
= intval( $data->page_is_redirect
);
383 $this->mLatest
= intval( $data->page_latest
);
385 $lc->addBadLinkObj( $this->mTitle
);
387 $this->mTitle
->loadFromRow( false );
390 $this->mDataLoaded
= true;
394 * @return int Page ID
396 public function getId() {
397 return $this->mTitle
->getArticleID();
401 * @return bool Whether or not the page exists in the database
403 public function exists() {
404 return $this->mTitle
->exists();
408 * Check if this page is something we're going to be showing
409 * some sort of sensible content for. If we return false, page
410 * views (plain action=view) will return an HTTP 404 response,
411 * so spiders and robots can know they're following a bad link.
415 public function hasViewableContent() {
416 return $this->mTitle
->exists() ||
$this->mTitle
->isAlwaysKnown();
420 * Get the number of views of this page
422 * @return int The view count for the page
424 public function getCount() {
425 return $this->mTitle
->getCount();
429 * Determine whether a page would be suitable for being counted as an
430 * article in the site_stats table based on the title & its content
432 * @param $editInfo Object or false: object returned by prepareTextForEdit(),
433 * if false, the current database state will be used
436 public function isCountable( $editInfo = false ) {
437 global $wgArticleCountMethod;
439 if ( !$this->mTitle
->isContentPage() ) {
443 $text = $editInfo ?
$editInfo->pst
: false;
445 if ( $this->isRedirect( $text ) ) {
449 switch ( $wgArticleCountMethod ) {
453 if ( $text === false ) {
454 $text = $this->getRawText();
456 return strpos( $text, ',' ) !== false;
459 // ParserOutput::getLinks() is a 2D array of page links, so
460 // to be really correct we would need to recurse in the array
461 // but the main array should only have items in it if there are
463 return (bool)count( $editInfo->output
->getLinks() );
465 return (bool)wfGetDB( DB_SLAVE
)->selectField( 'pagelinks', 1,
466 array( 'pl_from' => $this->getId() ), __METHOD__
);
472 * Tests if the article text represents a redirect
474 * @param $text mixed string containing article contents, or boolean
477 public function isRedirect( $text = false ) {
478 if ( $text === false ) {
479 if ( !$this->mDataLoaded
) {
480 $this->loadPageData();
483 return (bool)$this->mIsRedirect
;
485 return Title
::newFromRedirect( $text ) !== null;
490 * Loads everything except the text
491 * This isn't necessary for all uses, so it's only done if needed.
493 protected function loadLastEdit() {
494 if ( $this->mLastRevision
!== null ) {
495 return; // already loaded
498 $latest = $this->getLatest();
500 return; // page doesn't exist or is missing page_latest info
503 $revision = Revision
::newFromPageId( $this->getId(), $latest );
504 if ( $revision ) { // sanity
505 $this->setLastEdit( $revision );
510 * Set the latest revision
512 protected function setLastEdit( Revision
$revision ) {
513 $this->mLastRevision
= $revision;
514 $this->mTimestamp
= $revision->getTimestamp();
518 * Get the latest revision
519 * @return Revision|null
521 public function getRevision() {
522 $this->loadLastEdit();
523 if ( $this->mLastRevision
) {
524 return $this->mLastRevision
;
530 * Get the text of the current revision. No side-effects...
532 * @param $audience Integer: one of:
533 * Revision::FOR_PUBLIC to be displayed to all users
534 * Revision::FOR_THIS_USER to be displayed to $wgUser
535 * Revision::RAW get the text regardless of permissions
536 * @return String|false The text of the current revision
538 public function getText( $audience = Revision
::FOR_PUBLIC
) {
539 $this->loadLastEdit();
540 if ( $this->mLastRevision
) {
541 return $this->mLastRevision
->getText( $audience );
547 * Get the text of the current revision. No side-effects...
549 * @return String|false The text of the current revision
551 public function getRawText() {
552 $this->loadLastEdit();
553 if ( $this->mLastRevision
) {
554 return $this->mLastRevision
->getRawText();
560 * @return string MW timestamp of last article revision
562 public function getTimestamp() {
563 // Check if the field has been filled by WikiPage::setTimestamp()
564 if ( !$this->mTimestamp
) {
565 $this->loadLastEdit();
567 return wfTimestamp( TS_MW
, $this->mTimestamp
);
571 * Set the page timestamp (use only to avoid DB queries)
572 * @param $ts string MW timestamp of last article revision
575 public function setTimestamp( $ts ) {
576 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
580 * @param $audience Integer: one of:
581 * Revision::FOR_PUBLIC to be displayed to all users
582 * Revision::FOR_THIS_USER to be displayed to $wgUser
583 * Revision::RAW get the text regardless of permissions
584 * @return int user ID for the user that made the last article revision
586 public function getUser( $audience = Revision
::FOR_PUBLIC
) {
587 $this->loadLastEdit();
588 if ( $this->mLastRevision
) {
589 return $this->mLastRevision
->getUser( $audience );
596 * @param $audience Integer: one of:
597 * Revision::FOR_PUBLIC to be displayed to all users
598 * Revision::FOR_THIS_USER to be displayed to $wgUser
599 * Revision::RAW get the text regardless of permissions
600 * @return string username of the user that made the last article revision
602 public function getUserText( $audience = Revision
::FOR_PUBLIC
) {
603 $this->loadLastEdit();
604 if ( $this->mLastRevision
) {
605 return $this->mLastRevision
->getUserText( $audience );
612 * @param $audience Integer: one of:
613 * Revision::FOR_PUBLIC to be displayed to all users
614 * Revision::FOR_THIS_USER to be displayed to $wgUser
615 * Revision::RAW get the text regardless of permissions
616 * @return string Comment stored for the last article revision
618 public function getComment( $audience = Revision
::FOR_PUBLIC
) {
619 $this->loadLastEdit();
620 if ( $this->mLastRevision
) {
621 return $this->mLastRevision
->getComment( $audience );
628 * Returns true if last revision was marked as "minor edit"
630 * @return boolean Minor edit indicator for the last article revision.
632 public function getMinorEdit() {
633 $this->loadLastEdit();
634 if ( $this->mLastRevision
) {
635 return $this->mLastRevision
->isMinor();
642 * Get a list of users who have edited this article, not including the user who made
643 * the most recent revision, which you can get from $article->getUser() if you want it
644 * @return UserArrayFromResult
646 public function getContributors() {
647 # @todo FIXME: This is expensive; cache this info somewhere.
649 $dbr = wfGetDB( DB_SLAVE
);
651 if ( $dbr->implicitGroupby() ) {
652 $realNameField = 'user_real_name';
654 $realNameField = 'MIN(user_real_name) AS user_real_name';
657 $tables = array( 'revision', 'user' );
660 'rev_user as user_id',
661 'rev_user_text AS user_name',
663 'MAX(rev_timestamp) AS timestamp',
666 $conds = array( 'rev_page' => $this->getId() );
668 // The user who made the top revision gets credited as "this page was last edited by
669 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
670 $user = $this->getUser();
672 $conds[] = "rev_user != $user";
674 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
677 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
680 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
684 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
685 'ORDER BY' => 'timestamp DESC',
688 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
689 return new UserArrayFromResult( $res );
693 * Should the parser cache be used?
695 * @param $parserOptions ParserOptions to check
699 public function isParserCacheUsed( ParserOptions
$parserOptions, $oldid ) {
700 global $wgEnableParserCache;
702 return $wgEnableParserCache
703 && $parserOptions->getStubThreshold() == 0
704 && $this->mTitle
->exists()
705 && ( $oldid === null ||
$oldid === 0 ||
$oldid === $this->getLatest() )
706 && $this->mTitle
->isWikitextPage();
710 * Get a ParserOutput for the given ParserOptions and revision ID.
711 * The parser cache will be used if possible.
714 * @param $parserOptions ParserOptions to use for the parse operation
715 * @param $oldid Revision ID to get the text from, passing null or 0 will
716 * get the current revision (default value)
717 * @return ParserOutput or false if the revision was not found
719 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
720 wfProfileIn( __METHOD__
);
722 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
723 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
724 if ( $parserOptions->getStubThreshold() ) {
725 wfIncrStats( 'pcache_miss_stub' );
728 if ( $useParserCache ) {
729 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
730 if ( $parserOutput !== false ) {
731 wfProfileOut( __METHOD__
);
732 return $parserOutput;
736 if ( $oldid === null ||
$oldid === 0 ) {
737 $oldid = $this->getLatest();
740 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
743 wfProfileOut( __METHOD__
);
745 return $pool->getParserOutput();
749 * Perform the actions of a page purging
751 public function doPurge() {
754 if( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ){
758 // Invalidate the cache
759 $this->mTitle
->invalidateCache();
763 // Commit the transaction before the purge is sent
764 $dbw = wfGetDB( DB_MASTER
);
768 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
772 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
773 if ( $this->mTitle
->exists() ) {
774 $text = $this->getRawText();
779 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
785 * Insert a new empty page record for this article.
786 * This *must* be followed up by creating a revision
787 * and running $this->updateRevisionOn( ... );
788 * or else the record will be left in a funky state.
789 * Best if all done inside a transaction.
791 * @param $dbw DatabaseBase
792 * @return int The newly created page_id key, or false if the title already existed
794 public function insertOn( $dbw ) {
795 wfProfileIn( __METHOD__
);
797 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
798 $dbw->insert( 'page', array(
799 'page_id' => $page_id,
800 'page_namespace' => $this->mTitle
->getNamespace(),
801 'page_title' => $this->mTitle
->getDBkey(),
803 'page_restrictions' => '',
804 'page_is_redirect' => 0, # Will set this shortly...
806 'page_random' => wfRandom(),
807 'page_touched' => $dbw->timestamp(),
808 'page_latest' => 0, # Fill this in shortly...
809 'page_len' => 0, # Fill this in shortly...
810 ), __METHOD__
, 'IGNORE' );
812 $affected = $dbw->affectedRows();
815 $newid = $dbw->insertId();
816 $this->mTitle
->resetArticleID( $newid );
818 wfProfileOut( __METHOD__
);
820 return $affected ?
$newid : false;
824 * Update the page record to point to a newly saved revision.
826 * @param $dbw DatabaseBase: object
827 * @param $revision Revision: For ID number, and text used to set
828 * length and redirect status fields
829 * @param $lastRevision Integer: if given, will not overwrite the page field
830 * when different from the currently set value.
831 * Giving 0 indicates the new page flag should be set
833 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
834 * removing rows in redirect table.
835 * @return bool true on success, false on failure
838 public function updateRevisionOn( $dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
839 wfProfileIn( __METHOD__
);
841 $text = $revision->getText();
842 $len = strlen( $text );
843 $rt = Title
::newFromRedirectRecurse( $text );
845 $conditions = array( 'page_id' => $this->getId() );
847 if ( !is_null( $lastRevision ) ) {
848 # An extra check against threads stepping on each other
849 $conditions['page_latest'] = $lastRevision;
852 $now = wfTimestampNow();
853 $dbw->update( 'page',
855 'page_latest' => $revision->getId(),
856 'page_touched' => $dbw->timestamp( $now ),
857 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
858 'page_is_redirect' => $rt !== null ?
1 : 0,
864 $result = $dbw->affectedRows() != 0;
866 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
867 $this->setLastEdit( $revision );
868 $this->setCachedLastEditTime( $now );
869 $this->mLatest
= $revision->getId();
870 $this->mIsRedirect
= (bool)$rt;
871 # Update the LinkCache.
872 LinkCache
::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle
, $len, $this->mIsRedirect
, $this->mLatest
);
875 wfProfileOut( __METHOD__
);
880 * Get the cached timestamp for the last time the page changed.
881 * This is only used to help handle slave lag by comparing to page_touched.
882 * @return string MW timestamp
884 protected function getCachedLastEditTime() {
886 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
887 return $wgMemc->get( $key );
891 * Set the cached timestamp for the last time the page changed.
892 * This is only used to help handle slave lag by comparing to page_touched.
893 * @param $timestamp string
896 public function setCachedLastEditTime( $timestamp ) {
898 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
899 $wgMemc->set( $key, wfTimestamp( TS_MW
, $timestamp ), 60*15 );
903 * Add row to the redirect table if this is a redirect, remove otherwise.
905 * @param $dbw DatabaseBase
906 * @param $redirectTitle Title object pointing to the redirect target,
907 * or NULL if this is not a redirect
908 * @param $lastRevIsRedirect If given, will optimize adding and
909 * removing rows in redirect table.
910 * @return bool true on success, false on failure
913 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
914 // Always update redirects (target link might have changed)
915 // Update/Insert if we don't know if the last revision was a redirect or not
916 // Delete if changing from redirect to non-redirect
917 $isRedirect = !is_null( $redirectTitle );
919 if ( !$isRedirect && !is_null( $lastRevIsRedirect ) && $lastRevIsRedirect === $isRedirect ) {
923 wfProfileIn( __METHOD__
);
925 $this->insertRedirectEntry( $redirectTitle );
927 // This is not a redirect, remove row from redirect table
928 $where = array( 'rd_from' => $this->getId() );
929 $dbw->delete( 'redirect', $where, __METHOD__
);
932 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
933 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
935 wfProfileOut( __METHOD__
);
937 return ( $dbw->affectedRows() != 0 );
941 * If the given revision is newer than the currently set page_latest,
942 * update the page record. Otherwise, do nothing.
944 * @param $dbw Database object
945 * @param $revision Revision object
948 public function updateIfNewerOn( $dbw, $revision ) {
949 wfProfileIn( __METHOD__
);
951 $row = $dbw->selectRow(
952 array( 'revision', 'page' ),
953 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
955 'page_id' => $this->getId(),
956 'page_latest=rev_id' ),
960 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
961 wfProfileOut( __METHOD__
);
964 $prev = $row->rev_id
;
965 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
967 # No or missing previous revision; mark the page as new
969 $lastRevIsRedirect = null;
972 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
974 wfProfileOut( __METHOD__
);
979 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
980 * @param $text String: new text of the section
981 * @param $sectionTitle String: new section's subject, only if $section is 'new'
982 * @param $edittime String: revision timestamp or null to use the current revision
983 * @return string Complete article text, or null if error
985 public function replaceSection( $section, $text, $sectionTitle = '', $edittime = null ) {
986 wfProfileIn( __METHOD__
);
988 if ( strval( $section ) == '' ) {
989 // Whole-page edit; let the whole text through
991 // Bug 30711: always use current version when adding a new section
992 if ( is_null( $edittime ) ||
$section == 'new' ) {
993 $oldtext = $this->getRawText();
994 if ( $oldtext === false ) {
995 wfDebug( __METHOD__
. ": no page text\n" );
999 $dbw = wfGetDB( DB_MASTER
);
1000 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1003 wfDebug( "WikiPage::replaceSection asked for bogus section (page: " .
1004 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1005 wfProfileOut( __METHOD__
);
1009 $oldtext = $rev->getText();
1012 if ( $section == 'new' ) {
1013 # Inserting a new section
1014 $subject = $sectionTitle ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $sectionTitle ) . "\n\n" : '';
1015 if ( wfRunHooks( 'PlaceNewSection', array( $this, $oldtext, $subject, &$text ) ) ) {
1016 $text = strlen( trim( $oldtext ) ) > 0
1017 ?
"{$oldtext}\n\n{$subject}{$text}"
1018 : "{$subject}{$text}";
1021 # Replacing an existing section; roll out the big guns
1024 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1028 wfProfileOut( __METHOD__
);
1033 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1035 * @return Int updated $flags
1037 function checkFlags( $flags ) {
1038 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1039 if ( $this->mTitle
->getArticleID() ) {
1040 $flags |
= EDIT_UPDATE
;
1050 * Change an existing article or create a new article. Updates RC and all necessary caches,
1051 * optionally via the deferred update array.
1053 * @param $text String: new text
1054 * @param $summary String: edit summary
1055 * @param $flags Integer bitfield:
1057 * Article is known or assumed to be non-existent, create a new one
1059 * Article is known or assumed to be pre-existing, update it
1061 * Mark this edit minor, if the user is allowed to do so
1063 * Do not log the change in recentchanges
1065 * Mark the edit a "bot" edit regardless of user rights
1066 * EDIT_DEFER_UPDATES
1067 * Defer some of the updates until the end of index.php
1069 * Fill in blank summaries with generated text where possible
1071 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1072 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1073 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1074 * edit-already-exists error will be returned. These two conditions are also possible with
1075 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1077 * @param $baseRevId the revision ID this edit was based off, if any
1078 * @param $user User the user doing the edit
1080 * @return Status object. Possible errors:
1081 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1082 * edit-gone-missing: In update mode, but the article didn't exist
1083 * edit-conflict: In update mode, the article changed unexpectedly
1084 * edit-no-change: Warning that the text was the same as before
1085 * edit-already-exists: In creation mode, but the article already exists
1087 * Extensions may define additional errors.
1089 * $return->value will contain an associative array with members as follows:
1090 * new: Boolean indicating if the function attempted to create a new article
1091 * revision: The revision object for the inserted revision, or null
1093 * Compatibility note: this function previously returned a boolean value indicating success/failure
1095 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1096 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1098 # Low-level sanity check
1099 if ( $this->mTitle
->getText() === '' ) {
1100 throw new MWException( 'Something is trying to edit an article with an empty title' );
1103 wfProfileIn( __METHOD__
);
1105 $user = is_null( $user ) ?
$wgUser : $user;
1106 $status = Status
::newGood( array() );
1108 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
1109 $this->loadPageData( 'fromdbmaster' );
1111 $flags = $this->checkFlags( $flags );
1113 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
1114 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
1116 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
1118 if ( $status->isOK() ) {
1119 $status->fatal( 'edit-hook-aborted' );
1122 wfProfileOut( __METHOD__
);
1126 # Silently ignore EDIT_MINOR if not allowed
1127 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1128 $bot = $flags & EDIT_FORCE_BOT
;
1130 $oldtext = $this->getRawText(); // current revision
1131 $oldsize = strlen( $oldtext );
1132 $oldid = $this->getLatest();
1133 $oldIsRedirect = $this->isRedirect();
1134 $oldcountable = $this->isCountable();
1136 # Provide autosummaries if one is not provided and autosummaries are enabled.
1137 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1138 $summary = self
::getAutosummary( $oldtext, $text, $flags );
1141 $editInfo = $this->prepareTextForEdit( $text, null, $user );
1142 $text = $editInfo->pst
;
1143 $newsize = strlen( $text );
1145 $dbw = wfGetDB( DB_MASTER
);
1146 $now = wfTimestampNow();
1147 $this->mTimestamp
= $now;
1149 if ( $flags & EDIT_UPDATE
) {
1150 # Update article, but only if changed.
1151 $status->value
['new'] = false;
1153 # Make sure the revision is either completely inserted or not inserted at all
1154 if ( !$wgDBtransactions ) {
1155 $userAbort = ignore_user_abort( true );
1158 $revision = new Revision( array(
1159 'page' => $this->getId(),
1160 'comment' => $summary,
1161 'minor_edit' => $isminor,
1163 'parent_id' => $oldid,
1164 'user' => $user->getId(),
1165 'user_text' => $user->getName(),
1169 $changed = ( strcmp( $text, $oldtext ) != 0 );
1172 if ( !$this->mLatest
) {
1173 # Article gone missing
1174 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
1175 $status->fatal( 'edit-gone-missing' );
1177 wfProfileOut( __METHOD__
);
1182 $revisionId = $revision->insertOn( $dbw );
1186 # Note that we use $this->mLatest instead of fetching a value from the master DB
1187 # during the course of this function. This makes sure that EditPage can detect
1188 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1189 # before this function is called. A previous function used a separate query, this
1190 # creates a window where concurrent edits can cause an ignored edit conflict.
1191 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1194 /* Belated edit conflict! Run away!! */
1195 $status->fatal( 'edit-conflict' );
1197 # Delete the invalid revision if the DB is not transactional
1198 if ( !$wgDBtransactions ) {
1199 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
1205 global $wgUseRCPatrol;
1206 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1207 # Update recentchanges
1208 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1209 # Mark as patrolled if the user can do so
1210 $patrolled = $wgUseRCPatrol && !count(
1211 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1212 # Add RC row to the DB
1213 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
1214 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1215 $revisionId, $patrolled
1218 # Log auto-patrolled edits
1220 PatrolLog
::record( $rc, true );
1223 $user->incEditCount();
1228 if ( !$wgDBtransactions ) {
1229 ignore_user_abort( $userAbort );
1232 // Now that ignore_user_abort is restored, we can respond to fatal errors
1233 if ( !$status->isOK() ) {
1234 wfProfileOut( __METHOD__
);
1238 # Update links tables, site stats, etc.
1239 $this->doEditUpdates( $revision, $user, array( 'changed' => $changed,
1240 'oldcountable' => $oldcountable ) );
1243 $status->warning( 'edit-no-change' );
1245 // Keep the same revision ID, but do some updates on it
1246 $revisionId = $this->getLatest();
1247 // Update page_touched, this is usually implicit in the page update
1248 // Other cache updates are done in onArticleEdit()
1249 $this->mTitle
->invalidateCache();
1252 # Create new article
1253 $status->value
['new'] = true;
1257 # Add the page record; stake our claim on this title!
1258 # This will return false if the article already exists
1259 $newid = $this->insertOn( $dbw );
1261 if ( $newid === false ) {
1263 $status->fatal( 'edit-already-exists' );
1265 wfProfileOut( __METHOD__
);
1269 # Save the revision text...
1270 $revision = new Revision( array(
1272 'comment' => $summary,
1273 'minor_edit' => $isminor,
1275 'user' => $user->getId(),
1276 'user_text' => $user->getName(),
1279 $revisionId = $revision->insertOn( $dbw );
1281 # Update the page record with revision data
1282 $this->updateRevisionOn( $dbw, $revision, 0 );
1284 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1286 # Update recentchanges
1287 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1288 global $wgUseRCPatrol, $wgUseNPPatrol;
1290 # Mark as patrolled if the user can do so
1291 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
1292 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1293 # Add RC row to the DB
1294 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
1295 '', strlen( $text ), $revisionId, $patrolled );
1297 # Log auto-patrolled edits
1299 PatrolLog
::record( $rc, true );
1302 $user->incEditCount();
1305 # Update links, etc.
1306 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1308 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
1309 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
1312 # Do updates right now unless deferral was requested
1313 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
1314 DeferredUpdates
::doUpdates();
1317 // Return the new revision (or null) to the caller
1318 $status->value
['revision'] = $revision;
1320 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
1321 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
1323 # Promote user to any groups they meet the criteria for
1324 $user->addAutopromoteOnceGroups( 'onEdit' );
1326 wfProfileOut( __METHOD__
);
1331 * Update the article's restriction field, and leave a log entry.
1332 * This works for protection both existing and non-existing pages.
1334 * @param $limit Array: set of restriction keys
1335 * @param $reason String
1336 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
1337 * @param $expiry Array: per restriction type expiration
1338 * @param $user User The user updating the restrictions
1339 * @return bool true on success
1341 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade, $reason, User
$user ) {
1344 if ( wfReadOnly() ) {
1345 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
1348 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
1350 $id = $this->mTitle
->getArticleID();
1356 // Take this opportunity to purge out expired restrictions
1357 Title
::purgeExpiredRestrictions();
1359 # @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
1360 # we expect a single selection, but the schema allows otherwise.
1361 $isProtected = false;
1365 $dbw = wfGetDB( DB_MASTER
);
1367 foreach ( $restrictionTypes as $action ) {
1368 if ( !isset( $expiry[$action] ) ) {
1369 $expiry[$action] = $dbw->getInfinity();
1371 if ( !isset( $limit[$action] ) ) {
1372 $limit[$action] = '';
1373 } elseif ( $limit[$action] != '' ) {
1377 # Get current restrictions on $action
1378 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
1379 if ( $current != '' ) {
1380 $isProtected = true;
1383 if ( $limit[$action] != $current ) {
1385 } elseif ( $limit[$action] != '' ) {
1386 # Only check expiry change if the action is actually being
1387 # protected, since expiry does nothing on an not-protected
1389 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
1395 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
1399 # If nothing's changed, do nothing
1401 return Status
::newGood();
1404 if ( !$protect ) { # No protection at all means unprotection
1405 $revCommentMsg = 'unprotectedarticle';
1406 $logAction = 'unprotect';
1407 } elseif ( $isProtected ) {
1408 $revCommentMsg = 'modifiedarticleprotection';
1409 $logAction = 'modify';
1411 $revCommentMsg = 'protectedarticle';
1412 $logAction = 'protect';
1415 $encodedExpiry = array();
1416 $protectDescription = '';
1417 foreach ( $limit as $action => $restrictions ) {
1418 $encodedExpiry[$action] = $dbw->encodeExpiry( $expiry[$action] );
1419 if ( $restrictions != '' ) {
1420 $protectDescription .= $wgContLang->getDirMark() . "[$action=$restrictions] (";
1421 if ( $encodedExpiry[$action] != 'infinity' ) {
1422 $protectDescription .= wfMsgForContent( 'protect-expiring',
1423 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
1424 $wgContLang->date( $expiry[$action], false, false ) ,
1425 $wgContLang->time( $expiry[$action], false, false ) );
1427 $protectDescription .= wfMsgForContent( 'protect-expiry-indefinite' );
1430 $protectDescription .= ') ';
1433 $protectDescription = trim( $protectDescription );
1435 if ( $id ) { # Protection of existing page
1436 if ( !wfRunHooks( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
1437 return Status
::newGood();
1440 # Only restrictions with the 'protect' right can cascade...
1441 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
1442 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
1444 # The schema allows multiple restrictions
1445 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
1449 # Update restrictions table
1450 foreach ( $limit as $action => $restrictions ) {
1451 if ( $restrictions != '' ) {
1452 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
1453 array( 'pr_page' => $id,
1454 'pr_type' => $action,
1455 'pr_level' => $restrictions,
1456 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
1457 'pr_expiry' => $encodedExpiry[$action]
1462 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
1463 'pr_type' => $action ), __METHOD__
);
1467 # Prepare a null revision to be added to the history
1468 $editComment = $wgContLang->ucfirst( wfMsgForContent( $revCommentMsg, $this->mTitle
->getPrefixedText() ) );
1470 $editComment .= ": $reason";
1472 if ( $protectDescription ) {
1473 $editComment .= " ($protectDescription)";
1476 $editComment .= ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
1479 # Insert a null revision
1480 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
1481 $nullRevId = $nullRevision->insertOn( $dbw );
1483 $latest = $this->getLatest();
1484 # Update page record
1485 $dbw->update( 'page',
1487 'page_touched' => $dbw->timestamp(),
1488 'page_restrictions' => '',
1489 'page_latest' => $nullRevId
1490 ), array( /* WHERE */
1495 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
1496 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
1497 } else { # Protection of non-existing page (also known as "title protection")
1498 # Cascade protection is meaningless in this case
1501 if ( $limit['create'] != '' ) {
1502 $dbw->replace( 'protected_titles',
1503 array( array( 'pt_namespace', 'pt_title' ) ),
1505 'pt_namespace' => $this->mTitle
->getNamespace(),
1506 'pt_title' => $this->mTitle
->getDBkey(),
1507 'pt_create_perm' => $limit['create'],
1508 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ),
1509 'pt_expiry' => $encodedExpiry['create'],
1510 'pt_user' => $user->getId(),
1511 'pt_reason' => $reason,
1515 $dbw->delete( 'protected_titles',
1517 'pt_namespace' => $this->mTitle
->getNamespace(),
1518 'pt_title' => $this->mTitle
->getDBkey()
1524 $this->mTitle
->flushRestrictions();
1526 if ( $logAction == 'unprotect' ) {
1527 $logParams = array();
1529 $logParams = array( $protectDescription, $cascade ?
'cascade' : '' );
1532 # Update the protection log
1533 $log = new LogPage( 'protect' );
1534 $log->addEntry( $logAction, $this->mTitle
, trim( $reason ), $logParams, $user );
1536 return Status
::newGood();
1540 * Take an array of page restrictions and flatten it to a string
1541 * suitable for insertion into the page_restrictions field.
1542 * @param $limit Array
1545 protected static function flattenRestrictions( $limit ) {
1546 if ( !is_array( $limit ) ) {
1547 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
1553 foreach ( $limit as $action => $restrictions ) {
1554 if ( $restrictions != '' ) {
1555 $bits[] = "$action=$restrictions";
1559 return implode( ':', $bits );
1563 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
1565 * @deprecated in 1.19; use Title::isBigDeletion() instead.
1568 public function isBigDeletion() {
1569 wfDeprecated( __METHOD__
, '1.19' );
1570 return $this->mTitle
->isBigDeletion();
1574 * Get the approximate revision count of this page.
1576 * @deprecated in 1.19; use Title::estimateRevisionCount() instead.
1579 public function estimateRevisionCount() {
1580 wfDeprecated( __METHOD__
, '1.19' );
1581 return $this->mTitle
->estimateRevisionCount();
1585 * Get the last N authors
1586 * @param $num Integer: number of revisions to get
1587 * @param $revLatest String: the latest rev_id, selected from the master (optional)
1588 * @return array Array of authors, duplicates not removed
1590 public function getLastNAuthors( $num, $revLatest = 0 ) {
1591 wfProfileIn( __METHOD__
);
1592 // First try the slave
1593 // If that doesn't have the latest revision, try the master
1595 $db = wfGetDB( DB_SLAVE
);
1598 $res = $db->select( array( 'page', 'revision' ),
1599 array( 'rev_id', 'rev_user_text' ),
1601 'page_namespace' => $this->mTitle
->getNamespace(),
1602 'page_title' => $this->mTitle
->getDBkey(),
1603 'rev_page = page_id'
1606 'ORDER BY' => 'rev_timestamp DESC',
1612 wfProfileOut( __METHOD__
);
1616 $row = $db->fetchObject( $res );
1618 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
1619 $db = wfGetDB( DB_MASTER
);
1624 } while ( $continue );
1626 $authors = array( $row->rev_user_text
);
1628 foreach ( $res as $row ) {
1629 $authors[] = $row->rev_user_text
;
1632 wfProfileOut( __METHOD__
);
1637 * Back-end article deletion
1638 * Deletes the article with database consistency, writes logs, purges caches
1640 * @param $reason string delete reason for deletion log
1641 * @param $suppress bitfield
1642 * Revision::DELETED_TEXT
1643 * Revision::DELETED_COMMENT
1644 * Revision::DELETED_USER
1645 * Revision::DELETED_RESTRICTED
1646 * @param $id int article ID
1647 * @param $commit boolean defaults to true, triggers transaction end
1648 * @param &$errors Array of errors to append to
1649 * @param $user User The relevant user
1650 * @return boolean true if successful
1652 public function doDeleteArticle(
1653 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
1656 $user = is_null( $user ) ?
$wgUser : $user;
1658 wfDebug( __METHOD__
. "\n" );
1660 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error ) ) ) {
1663 $dbw = wfGetDB( DB_MASTER
);
1664 $t = $this->mTitle
->getDBkey();
1665 $id = $id ?
$id : $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
1667 if ( $t === '' ||
$id == 0 ) {
1671 DeferredUpdates
::addUpdate(
1672 new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 )
1675 // Bitfields to further suppress the content
1678 // This should be 15...
1679 $bitfield |
= Revision
::DELETED_TEXT
;
1680 $bitfield |
= Revision
::DELETED_COMMENT
;
1681 $bitfield |
= Revision
::DELETED_USER
;
1682 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1684 $bitfield = 'rev_deleted';
1688 // For now, shunt the revision data into the archive table.
1689 // Text is *not* removed from the text table; bulk storage
1690 // is left intact to avoid breaking block-compression or
1691 // immutable storage schemes.
1693 // For backwards compatibility, note that some older archive
1694 // table entries will have ar_text and ar_flags fields still.
1696 // In the future, we may keep revisions and mark them with
1697 // the rev_deleted field, which is reserved for this purpose.
1698 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
1700 'ar_namespace' => 'page_namespace',
1701 'ar_title' => 'page_title',
1702 'ar_comment' => 'rev_comment',
1703 'ar_user' => 'rev_user',
1704 'ar_user_text' => 'rev_user_text',
1705 'ar_timestamp' => 'rev_timestamp',
1706 'ar_minor_edit' => 'rev_minor_edit',
1707 'ar_rev_id' => 'rev_id',
1708 'ar_parent_id' => 'rev_parent_id',
1709 'ar_text_id' => 'rev_text_id',
1710 'ar_text' => '\'\'', // Be explicit to appease
1711 'ar_flags' => '\'\'', // MySQL's "strict mode"...
1712 'ar_len' => 'rev_len',
1713 'ar_page_id' => 'page_id',
1714 'ar_deleted' => $bitfield,
1715 'ar_sha1' => 'rev_sha1'
1718 'page_id = rev_page'
1722 # Delete restrictions for it
1723 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
1725 # Now that it's safely backed up, delete it
1726 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
1727 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
1734 # Fix category table counts
1736 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
1738 foreach ( $res as $row ) {
1739 $cats [] = $row->cl_to
;
1742 $this->updateCategoryCounts( array(), $cats );
1744 # If using cascading deletes, we can skip some explicit deletes
1745 if ( !$dbw->cascadingDeletes() ) {
1746 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
1748 # Delete outgoing links
1749 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ), __METHOD__
);
1750 $dbw->delete( 'imagelinks', array( 'il_from' => $id ), __METHOD__
);
1751 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ), __METHOD__
);
1752 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ), __METHOD__
);
1753 $dbw->delete( 'externallinks', array( 'el_from' => $id ), __METHOD__
);
1754 $dbw->delete( 'langlinks', array( 'll_from' => $id ), __METHOD__
);
1755 $dbw->delete( 'iwlinks', array( 'iwl_from' => $id ), __METHOD__
);
1756 $dbw->delete( 'redirect', array( 'rd_from' => $id ), __METHOD__
);
1757 $dbw->delete( 'page_props', array( 'pp_page' => $id ), __METHOD__
);
1760 # If using cleanup triggers, we can skip some manual deletes
1761 if ( !$dbw->cleanupTriggers() ) {
1762 # Clean up recentchanges entries...
1763 $dbw->delete( 'recentchanges',
1764 array( 'rc_type != ' . RC_LOG
,
1765 'rc_namespace' => $this->mTitle
->getNamespace(),
1766 'rc_title' => $this->mTitle
->getDBkey() ),
1768 $dbw->delete( 'recentchanges',
1769 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
1774 self
::onArticleDelete( $this->mTitle
);
1776 # Clear the cached article id so the interface doesn't act like we exist
1777 $this->mTitle
->resetArticleID( 0 );
1779 # Log the deletion, if the page was suppressed, log it at Oversight instead
1780 $logtype = $suppress ?
'suppress' : 'delete';
1782 $logEntry = new ManualLogEntry( $logtype, 'delete' );
1783 $logEntry->setPerformer( $user );
1784 $logEntry->setTarget( $this->mTitle
);
1785 $logEntry->setComment( $reason );
1786 $logid = $logEntry->insert();
1787 $logEntry->publish( $logid );
1793 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id ) );
1798 * Roll back the most recent consecutive set of edits to a page
1799 * from the same user; fails if there are no eligible edits to
1800 * roll back to, e.g. user is the sole contributor. This function
1801 * performs permissions checks on $user, then calls commitRollback()
1802 * to do the dirty work
1804 * @todo: seperate the business/permission stuff out from backend code
1806 * @param $fromP String: Name of the user whose edits to rollback.
1807 * @param $summary String: Custom summary. Set to default summary if empty.
1808 * @param $token String: Rollback token.
1809 * @param $bot Boolean: If true, mark all reverted edits as bot.
1811 * @param $resultDetails Array: contains result-specific array of additional values
1812 * 'alreadyrolled' : 'current' (rev)
1813 * success : 'summary' (str), 'current' (rev), 'target' (rev)
1815 * @param $user User The user performing the rollback
1816 * @return array of errors, each error formatted as
1817 * array(messagekey, param1, param2, ...).
1818 * On success, the array is empty. This array can also be passed to
1819 * OutputPage::showPermissionsErrorPage().
1821 public function doRollback(
1822 $fromP, $summary, $token, $bot, &$resultDetails, User
$user
1824 $resultDetails = null;
1827 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
1828 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
1829 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
1831 if ( !$user->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
1832 $errors[] = array( 'sessionfailure' );
1835 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
1836 $errors[] = array( 'actionthrottledtext' );
1839 # If there were errors, bail out now
1840 if ( !empty( $errors ) ) {
1844 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
1848 * Backend implementation of doRollback(), please refer there for parameter
1849 * and return value documentation
1851 * NOTE: This function does NOT check ANY permissions, it just commits the
1852 * rollback to the DB. Therefore, you should only call this function direct-
1853 * ly if you want to use custom permissions checks. If you don't, use
1854 * doRollback() instead.
1855 * @param $fromP String: Name of the user whose edits to rollback.
1856 * @param $summary String: Custom summary. Set to default summary if empty.
1857 * @param $bot Boolean: If true, mark all reverted edits as bot.
1859 * @param $resultDetails Array: contains result-specific array of additional values
1860 * @param $guser User The user performing the rollback
1862 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser ) {
1863 global $wgUseRCPatrol, $wgContLang;
1865 $dbw = wfGetDB( DB_MASTER
);
1867 if ( wfReadOnly() ) {
1868 return array( array( 'readonlytext' ) );
1871 # Get the last editor
1872 $current = Revision
::newFromTitle( $this->mTitle
);
1873 if ( is_null( $current ) ) {
1874 # Something wrong... no page?
1875 return array( array( 'notanarticle' ) );
1878 $from = str_replace( '_', ' ', $fromP );
1879 # User name given should match up with the top revision.
1880 # If the user was deleted then $from should be empty.
1881 if ( $from != $current->getUserText() ) {
1882 $resultDetails = array( 'current' => $current );
1883 return array( array( 'alreadyrolled',
1884 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
1885 htmlspecialchars( $fromP ),
1886 htmlspecialchars( $current->getUserText() )
1890 # Get the last edit not by this guy...
1891 # Note: these may not be public values
1892 $user = intval( $current->getRawUser() );
1893 $user_text = $dbw->addQuotes( $current->getRawUserText() );
1894 $s = $dbw->selectRow( 'revision',
1895 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
1896 array( 'rev_page' => $current->getPage(),
1897 "rev_user != {$user} OR rev_user_text != {$user_text}"
1899 array( 'USE INDEX' => 'page_timestamp',
1900 'ORDER BY' => 'rev_timestamp DESC' )
1902 if ( $s === false ) {
1903 # No one else ever edited this page
1904 return array( array( 'cantrollback' ) );
1905 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
1906 # Only admins can see this text
1907 return array( array( 'notvisiblerev' ) );
1911 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
1912 # Mark all reverted edits as bot
1916 if ( $wgUseRCPatrol ) {
1917 # Mark all reverted edits as patrolled
1918 $set['rc_patrolled'] = 1;
1921 if ( count( $set ) ) {
1922 $dbw->update( 'recentchanges', $set,
1924 'rc_cur_id' => $current->getPage(),
1925 'rc_user_text' => $current->getUserText(),
1926 "rc_timestamp > '{$s->rev_timestamp}'",
1931 # Generate the edit summary if necessary
1932 $target = Revision
::newFromId( $s->rev_id
);
1933 if ( empty( $summary ) ) {
1934 if ( $from == '' ) { // no public user name
1935 $summary = wfMsgForContent( 'revertpage-nouser' );
1937 $summary = wfMsgForContent( 'revertpage' );
1941 # Allow the custom summary to use the same args as the default message
1943 $target->getUserText(), $from, $s->rev_id
,
1944 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
1945 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
1947 $summary = wfMsgReplaceArgs( $summary, $args );
1950 $flags = EDIT_UPDATE
;
1952 if ( $guser->isAllowed( 'minoredit' ) ) {
1953 $flags |
= EDIT_MINOR
;
1956 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
1957 $flags |
= EDIT_FORCE_BOT
;
1960 # Actually store the edit
1961 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
1962 if ( !empty( $status->value
['revision'] ) ) {
1963 $revId = $status->value
['revision']->getId();
1968 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
1970 $resultDetails = array(
1971 'summary' => $summary,
1972 'current' => $current,
1973 'target' => $target,
1981 * Do standard deferred updates after page view
1982 * @param $user User The relevant user
1984 public function doViewUpdates( User
$user ) {
1985 global $wgDisableCounters;
1986 if ( wfReadOnly() ) {
1990 # Don't update page view counters on views from bot users (bug 14044)
1991 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->mTitle
->exists() ) {
1992 DeferredUpdates
::addUpdate( new ViewCountUpdate( $this->getId() ) );
1993 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1996 # Update newtalk / watchlist notification status
1997 $user->clearNotification( $this->mTitle
);
2001 * Prepare text which is about to be saved.
2002 * Returns a stdclass with source, pst and output members
2004 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
2005 global $wgParser, $wgContLang, $wgUser;
2006 $user = is_null( $user ) ?
$wgUser : $user;
2007 // @TODO fixme: check $user->getId() here???
2008 if ( $this->mPreparedEdit
2009 && $this->mPreparedEdit
->newText
== $text
2010 && $this->mPreparedEdit
->revid
== $revid
2013 return $this->mPreparedEdit
;
2016 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2017 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2019 $edit = (object)array();
2020 $edit->revid
= $revid;
2021 $edit->newText
= $text;
2022 $edit->pst
= $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
2023 $edit->popts
= $this->makeParserOptions( 'canonical' );
2024 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
2025 $edit->oldText
= $this->getRawText();
2027 $this->mPreparedEdit
= $edit;
2033 * Do standard deferred updates after page edit.
2034 * Update links tables, site stats, search index and message cache.
2035 * Purges pages that include this page if the text was changed here.
2036 * Every 100th edit, prune the recent changes table.
2039 * @param $revision Revision object
2040 * @param $user User object that did the revision
2041 * @param $options Array of options, following indexes are used:
2042 * - changed: boolean, whether the revision changed the content (default true)
2043 * - created: boolean, whether the revision created the page (default false)
2044 * - oldcountable: boolean or null (default null):
2045 * - boolean: whether the page was counted as an article before that
2046 * revision, only used in changed is true and created is false
2047 * - null: don't change the article count
2049 public function doEditUpdates( Revision
$revision, User
$user, array $options = array() ) {
2050 global $wgEnableParserCache;
2052 wfProfileIn( __METHOD__
);
2054 $options +
= array( 'changed' => true, 'created' => false, 'oldcountable' => null );
2055 $text = $revision->getText();
2058 # Be careful not to double-PST: $text is usually already PST-ed once
2059 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2060 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
2061 $editInfo = $this->prepareTextForEdit( $text, $revision->getId(), $user );
2063 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
2064 $editInfo = $this->mPreparedEdit
;
2067 # Save it to the parser cache
2068 if ( $wgEnableParserCache ) {
2069 $parserCache = ParserCache
::singleton();
2070 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
2073 # Update the links tables
2074 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
2077 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2079 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2080 if ( 0 == mt_rand( 0, 99 ) ) {
2081 // Flush old entries from the `recentchanges` table; we do this on
2082 // random requests so as to avoid an increase in writes for no good reason
2085 $dbw = wfGetDB( DB_MASTER
);
2086 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
2089 array( "rc_timestamp < '$cutoff'" ),
2095 if ( !$this->mTitle
->exists() ) {
2096 wfProfileOut( __METHOD__
);
2100 $id = $this->getId();
2101 $title = $this->mTitle
->getPrefixedDBkey();
2102 $shortTitle = $this->mTitle
->getDBkey();
2104 if ( !$options['changed'] ) {
2107 } elseif ( $options['created'] ) {
2108 $good = (int)$this->isCountable( $editInfo );
2110 } elseif ( $options['oldcountable'] !== null ) {
2111 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2118 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) );
2119 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $text ) );
2121 # If this is another user's talk page, update newtalk.
2122 # Don't do this if $options['changed'] = false (null-edits) nor if
2123 # it's a minor edit and the user doesn't want notifications for those.
2124 if ( $options['changed']
2125 && $this->mTitle
->getNamespace() == NS_USER_TALK
2126 && $shortTitle != $user->getTitleKey()
2127 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2129 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
2130 $other = User
::newFromName( $shortTitle, false );
2132 wfDebug( __METHOD__
. ": invalid username\n" );
2133 } elseif ( User
::isIP( $shortTitle ) ) {
2134 // An anonymous user
2135 $other->setNewtalk( true );
2136 } elseif ( $other->isLoggedIn() ) {
2137 $other->setNewtalk( true );
2139 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2144 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2145 MessageCache
::singleton()->replace( $shortTitle, $text );
2148 if( $options['created'] ) {
2149 self
::onArticleCreate( $this->mTitle
);
2151 self
::onArticleEdit( $this->mTitle
);
2154 wfProfileOut( __METHOD__
);
2158 * Perform article updates on a special page creation.
2160 * @param $rev Revision object
2162 * @todo This is a shitty interface function. Kill it and replace the
2163 * other shitty functions like doEditUpdates and such so it's not needed
2165 * @deprecated since 1.18, use doEditUpdates()
2167 public function createUpdates( $rev ) {
2168 wfDeprecated( __METHOD__
, '1.18' );
2170 $this->doEditUpdates( $rev, $wgUser, array( 'created' => true ) );
2174 * This function is called right before saving the wikitext,
2175 * so we can do things like signatures and links-in-context.
2177 * @deprecated in 1.19; use Parser::preSaveTransform() instead
2178 * @param $text String article contents
2179 * @param $user User object: user doing the edit
2180 * @param $popts ParserOptions object: parser options, default options for
2181 * the user loaded if null given
2182 * @return string article contents with altered wikitext markup (signatures
2183 * converted, {{subst:}}, templates, etc.)
2185 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
2186 global $wgParser, $wgUser;
2188 wfDeprecated( __METHOD__
, '1.19' );
2190 $user = is_null( $user ) ?
$wgUser : $user;
2192 if ( $popts === null ) {
2193 $popts = ParserOptions
::newFromUser( $user );
2196 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
2200 * Loads page_touched and returns a value indicating if it should be used
2201 * @return boolean true if not a redirect
2203 public function checkTouched() {
2204 if ( !$this->mDataLoaded
) {
2205 $this->loadPageData();
2207 return !$this->mIsRedirect
;
2211 * Get the page_touched field
2212 * @return string containing GMT timestamp
2214 public function getTouched() {
2215 if ( !$this->mDataLoaded
) {
2216 $this->loadPageData();
2218 return $this->mTouched
;
2222 * Get the page_latest field
2223 * @return integer rev_id of current revision
2225 public function getLatest() {
2226 if ( !$this->mDataLoaded
) {
2227 $this->loadPageData();
2229 return (int)$this->mLatest
;
2233 * Edit an article without doing all that other stuff
2234 * The article must already exist; link tables etc
2235 * are not updated, caches are not flushed.
2237 * @param $text String: text submitted
2238 * @param $user User The relevant user
2239 * @param $comment String: comment submitted
2240 * @param $minor Boolean: whereas it's a minor modification
2242 public function doQuickEdit( $text, User
$user, $comment = '', $minor = 0 ) {
2243 wfProfileIn( __METHOD__
);
2245 $dbw = wfGetDB( DB_MASTER
);
2246 $revision = new Revision( array(
2247 'page' => $this->getId(),
2249 'comment' => $comment,
2250 'minor_edit' => $minor ?
1 : 0,
2252 $revision->insertOn( $dbw );
2253 $this->updateRevisionOn( $dbw, $revision );
2255 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2257 wfProfileOut( __METHOD__
);
2261 * The onArticle*() functions are supposed to be a kind of hooks
2262 * which should be called whenever any of the specified actions
2265 * This is a good place to put code to clear caches, for instance.
2267 * This is called on page move and undelete, as well as edit
2269 * @param $title Title object
2271 public static function onArticleCreate( $title ) {
2272 # Update existence markers on article/talk tabs...
2273 if ( $title->isTalkPage() ) {
2274 $other = $title->getSubjectPage();
2276 $other = $title->getTalkPage();
2279 $other->invalidateCache();
2280 $other->purgeSquid();
2282 $title->touchLinks();
2283 $title->purgeSquid();
2284 $title->deleteTitleProtection();
2288 * Clears caches when article is deleted
2290 * @param $title Title
2292 public static function onArticleDelete( $title ) {
2293 # Update existence markers on article/talk tabs...
2294 if ( $title->isTalkPage() ) {
2295 $other = $title->getSubjectPage();
2297 $other = $title->getTalkPage();
2300 $other->invalidateCache();
2301 $other->purgeSquid();
2303 $title->touchLinks();
2304 $title->purgeSquid();
2307 HTMLFileCache
::clearFileCache( $title );
2310 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
2311 MessageCache
::singleton()->replace( $title->getDBkey(), false );
2315 if ( $title->getNamespace() == NS_FILE
) {
2316 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
2317 $update->doUpdate();
2321 if ( $title->getNamespace() == NS_USER_TALK
) {
2322 $user = User
::newFromName( $title->getText(), false );
2324 $user->setNewtalk( false );
2329 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
2333 * Purge caches on page update etc
2335 * @param $title Title object
2336 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
2338 public static function onArticleEdit( $title ) {
2339 // Invalidate caches of articles which include this page
2340 DeferredUpdates
::addHTMLCacheUpdate( $title, 'templatelinks' );
2343 // Invalidate the caches of all pages which redirect here
2344 DeferredUpdates
::addHTMLCacheUpdate( $title, 'redirect' );
2346 # Purge squid for this page only
2347 $title->purgeSquid();
2349 # Clear file cache for this page only
2350 HTMLFileCache
::clearFileCache( $title );
2356 * Return a list of templates used by this article.
2357 * Uses the templatelinks table
2359 * @return Array of Title objects
2361 public function getUsedTemplates() {
2363 $id = $this->mTitle
->getArticleID();
2369 $dbr = wfGetDB( DB_SLAVE
);
2370 $res = $dbr->select( array( 'templatelinks' ),
2371 array( 'tl_namespace', 'tl_title' ),
2372 array( 'tl_from' => $id ),
2375 if ( $res !== false ) {
2376 foreach ( $res as $row ) {
2377 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
2385 * Returns a list of hidden categories this page is a member of.
2386 * Uses the page_props and categorylinks tables.
2388 * @return Array of Title objects
2390 public function getHiddenCategories() {
2392 $id = $this->mTitle
->getArticleID();
2398 $dbr = wfGetDB( DB_SLAVE
);
2399 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
2401 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
2402 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
2405 if ( $res !== false ) {
2406 foreach ( $res as $row ) {
2407 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
2415 * Return an applicable autosummary if one exists for the given edit.
2416 * @param $oldtext String: the previous text of the page.
2417 * @param $newtext String: The submitted text of the page.
2418 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
2419 * @return string An appropriate autosummary, or an empty string.
2421 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2424 # Decide what kind of autosummary is needed.
2426 # Redirect autosummaries
2427 $ot = Title
::newFromRedirect( $oldtext );
2428 $rt = Title
::newFromRedirect( $newtext );
2430 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
2431 $truncatedtext = $wgContLang->truncate(
2432 str_replace( "\n", ' ', $newtext ),
2434 - strlen( wfMsgForContent( 'autoredircomment' ) )
2435 - strlen( $rt->getFullText() )
2437 return wfMsgForContent( 'autoredircomment', $rt->getFullText(), $truncatedtext );
2440 # New page autosummaries
2441 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
2442 # If they're making a new article, give its text, truncated, in the summary.
2444 $truncatedtext = $wgContLang->truncate(
2445 str_replace( "\n", ' ', $newtext ),
2446 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
2448 return wfMsgForContent( 'autosumm-new', $truncatedtext );
2451 # Blanking autosummaries
2452 if ( $oldtext != '' && $newtext == '' ) {
2453 return wfMsgForContent( 'autosumm-blank' );
2454 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
2455 # Removing more than 90% of the article
2457 $truncatedtext = $wgContLang->truncate(
2459 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
2461 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
2464 # If we reach this point, there's no applicable autosummary for our case, so our
2465 # autosummary is empty.
2470 * Auto-generates a deletion reason
2472 * @param &$hasHistory Boolean: whether the page has a history
2473 * @return mixed String containing deletion reason or empty string, or boolean false
2474 * if no revision occurred
2476 public function getAutoDeleteReason( &$hasHistory ) {
2479 $dbw = wfGetDB( DB_MASTER
);
2480 // Get the last revision
2481 $rev = Revision
::newFromTitle( $this->getTitle() );
2483 if ( is_null( $rev ) ) {
2487 // Get the article's contents
2488 $contents = $rev->getText();
2491 // If the page is blank, use the text from the previous revision,
2492 // which can only be blank if there's a move/import/protect dummy revision involved
2493 if ( $contents == '' ) {
2494 $prev = $rev->getPrevious();
2497 $contents = $prev->getText();
2502 // Find out if there was only one contributor
2503 // Only scan the last 20 revisions
2504 $res = $dbw->select( 'revision', 'rev_user_text',
2505 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2507 array( 'LIMIT' => 20 )
2510 if ( $res === false ) {
2511 // This page has no revisions, which is very weird
2515 $hasHistory = ( $res->numRows() > 1 );
2516 $row = $dbw->fetchObject( $res );
2518 if ( $row ) { // $row is false if the only contributor is hidden
2519 $onlyAuthor = $row->rev_user_text
;
2520 // Try to find a second contributor
2521 foreach ( $res as $row ) {
2522 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2523 $onlyAuthor = false;
2528 $onlyAuthor = false;
2531 // Generate the summary with a '$1' placeholder
2533 // The current revision is blank and the one before is also
2534 // blank. It's just not our lucky day
2535 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2537 if ( $onlyAuthor ) {
2538 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2540 $reason = wfMsgForContent( 'excontent', '$1' );
2544 if ( $reason == '-' ) {
2545 // Allow these UI messages to be blanked out cleanly
2549 // Replace newlines with spaces to prevent uglyness
2550 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2551 // Calculate the maximum amount of chars to get
2552 // Max content length = max comment length - length of the comment (excl. $1)
2553 $maxLength = 255 - ( strlen( $reason ) - 2 );
2554 $contents = $wgContLang->truncate( $contents, $maxLength );
2555 // Remove possible unfinished links
2556 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2557 // Now replace the '$1' placeholder
2558 $reason = str_replace( '$1', $contents, $reason );
2564 * Get parser options suitable for rendering the primary article wikitext
2565 * @param User|string $user User object or 'canonical'
2566 * @return ParserOptions
2568 public function makeParserOptions( $user ) {
2570 if ( $user instanceof User
) { // settings per user (even anons)
2571 $options = ParserOptions
::newFromUser( $user );
2572 } else { // canonical settings
2573 $options = ParserOptions
::newFromUserAndLang( new User
, $wgContLang );
2575 $options->enableLimitReport(); // show inclusion/loop reports
2576 $options->setTidy( true ); // fix bad HTML
2581 * Update all the appropriate counts in the category table, given that
2582 * we've added the categories $added and deleted the categories $deleted.
2584 * @param $added array The names of categories that were added
2585 * @param $deleted array The names of categories that were deleted
2587 public function updateCategoryCounts( $added, $deleted ) {
2588 $ns = $this->mTitle
->getNamespace();
2589 $dbw = wfGetDB( DB_MASTER
);
2591 # First make sure the rows exist. If one of the "deleted" ones didn't
2592 # exist, we might legitimately not create it, but it's simpler to just
2593 # create it and then give it a negative value, since the value is bogus
2596 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
2597 $insertCats = array_merge( $added, $deleted );
2598 if ( !$insertCats ) {
2599 # Okay, nothing to do
2603 $insertRows = array();
2605 foreach ( $insertCats as $cat ) {
2606 $insertRows[] = array(
2607 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
2611 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
2613 $addFields = array( 'cat_pages = cat_pages + 1' );
2614 $removeFields = array( 'cat_pages = cat_pages - 1' );
2616 if ( $ns == NS_CATEGORY
) {
2617 $addFields[] = 'cat_subcats = cat_subcats + 1';
2618 $removeFields[] = 'cat_subcats = cat_subcats - 1';
2619 } elseif ( $ns == NS_FILE
) {
2620 $addFields[] = 'cat_files = cat_files + 1';
2621 $removeFields[] = 'cat_files = cat_files - 1';
2628 array( 'cat_title' => $added ),
2637 array( 'cat_title' => $deleted ),
2644 * Updates cascading protections
2646 * @param $parserOutput ParserOutput object for the current version
2648 public function doCascadeProtectionUpdates( ParserOutput
$parserOutput ) {
2649 if ( wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
2653 // templatelinks table may have become out of sync,
2654 // especially if using variable-based transclusions.
2655 // For paranoia, check if things have changed and if
2656 // so apply updates to the database. This will ensure
2657 // that cascaded protections apply as soon as the changes
2660 # Get templates from templatelinks
2661 $id = $this->mTitle
->getArticleID();
2663 $tlTemplates = array();
2665 $dbr = wfGetDB( DB_SLAVE
);
2666 $res = $dbr->select( array( 'templatelinks' ),
2667 array( 'tl_namespace', 'tl_title' ),
2668 array( 'tl_from' => $id ),
2672 foreach ( $res as $row ) {
2673 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
2676 # Get templates from parser output.
2677 $poTemplates = array();
2678 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
2679 foreach ( $templates as $dbk => $id ) {
2680 $poTemplates["$ns:$dbk"] = true;
2685 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
2687 if ( count( $templates_diff ) > 0 ) {
2688 # Whee, link updates time.
2689 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
2695 * Update the article's restriction field, and leave a log entry.
2697 * @deprecated since 1.19
2698 * @param $limit Array: set of restriction keys
2699 * @param $reason String
2700 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2701 * @param $expiry Array: per restriction type expiration
2702 * @param $user User The user updating the restrictions
2703 * @return bool true on success
2705 public function updateRestrictions(
2706 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User
$user = null
2710 $user = is_null( $user ) ?
$wgUser : $user;
2712 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
2716 * @deprecated since 1.18
2718 public function quickEdit( $text, $comment = '', $minor = 0 ) {
2719 wfDeprecated( __METHOD__
, '1.18' );
2721 return $this->doQuickEdit( $text, $wgUser, $comment, $minor );
2725 * @deprecated since 1.18
2727 public function viewUpdates() {
2728 wfDeprecated( __METHOD__
, '1.18' );
2730 return $this->doViewUpdates( $wgUser );
2734 * @deprecated since 1.18
2736 public function useParserCache( $oldid ) {
2737 wfDeprecated( __METHOD__
, '1.18' );
2739 return $this->isParserCacheUsed( ParserOptions
::newFromUser( $wgUser ), $oldid );
2743 class PoolWorkArticleView
extends PoolCounterWork
{
2761 * @var ParserOptions
2763 private $parserOptions;
2771 * @var ParserOutput|false
2773 private $parserOutput = false;
2778 private $isDirty = false;
2783 private $error = false;
2789 * @param $revid Integer: ID of the revision being parsed
2790 * @param $useParserCache Boolean: whether to use the parser cache
2791 * @param $parserOptions parserOptions to use for the parse operation
2792 * @param $text String: text to parse or null to load it
2794 function __construct( Page
$page, ParserOptions
$parserOptions, $revid, $useParserCache, $text = null ) {
2795 $this->page
= $page;
2796 $this->revid
= $revid;
2797 $this->cacheable
= $useParserCache;
2798 $this->parserOptions
= $parserOptions;
2799 $this->text
= $text;
2800 $this->cacheKey
= ParserCache
::singleton()->getKey( $page, $parserOptions );
2801 parent
::__construct( 'ArticleView', $this->cacheKey
. ':revid:' . $revid );
2805 * Get the ParserOutput from this object, or false in case of failure
2807 * @return ParserOutput
2809 public function getParserOutput() {
2810 return $this->parserOutput
;
2814 * Get whether the ParserOutput is a dirty one (i.e. expired)
2818 public function getIsDirty() {
2819 return $this->isDirty
;
2823 * Get a Status object in case of error or false otherwise
2825 * @return Status|false
2827 public function getError() {
2828 return $this->error
;
2835 global $wgParser, $wgUseFileCache;
2837 $isCurrent = $this->revid
=== $this->page
->getLatest();
2839 if ( $this->text
!== null ) {
2840 $text = $this->text
;
2841 } elseif ( $isCurrent ) {
2842 $text = $this->page
->getRawText();
2844 $rev = Revision
::newFromTitle( $this->page
->getTitle(), $this->revid
);
2845 if ( $rev === null ) {
2848 $text = $rev->getText();
2852 $this->parserOutput
= $wgParser->parse( $text, $this->page
->getTitle(),
2853 $this->parserOptions
, true, true, $this->revid
);
2858 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
2859 $this->page
->getTitle()->getPrefixedDBkey() ) );
2862 if ( $this->cacheable
&& $this->parserOutput
->isCacheable() ) {
2863 ParserCache
::singleton()->save( $this->parserOutput
, $this->page
, $this->parserOptions
);
2866 // Make sure file cache is not used on uncacheable content.
2867 // Output that has magic words in it can still use the parser cache
2868 // (if enabled), though it will generally expire sooner.
2869 if ( !$this->parserOutput
->isCacheable() ||
$this->parserOutput
->containsOldMagic() ) {
2870 $wgUseFileCache = false;
2874 $this->page
->doCascadeProtectionUpdates( $this->parserOutput
);
2883 function getCachedWork() {
2884 $this->parserOutput
= ParserCache
::singleton()->get( $this->page
, $this->parserOptions
);
2886 if ( $this->parserOutput
=== false ) {
2887 wfDebug( __METHOD__
. ": parser cache miss\n" );
2890 wfDebug( __METHOD__
. ": parser cache hit\n" );
2898 function fallback() {
2899 $this->parserOutput
= ParserCache
::singleton()->getDirty( $this->page
, $this->parserOptions
);
2901 if ( $this->parserOutput
=== false ) {
2902 wfDebugLog( 'dirty', "dirty missing\n" );
2903 wfDebug( __METHOD__
. ": no dirty cache\n" );
2906 wfDebug( __METHOD__
. ": sending dirty output\n" );
2907 wfDebugLog( 'dirty', "dirty output {$this->cacheKey}\n" );
2908 $this->isDirty
= true;
2914 * @param $status Status
2916 function error( $status ) {
2917 $this->error
= $status;