8 * Class representing a MediaWiki article and history.
10 * See design.txt for an overview.
11 * Note: edit user interface and cache support functions have been
12 * moved to separate EditPage and HTMLFileCache classes.
14 * @internal documentation reviewed 15 Mar 2010
20 var $mComment = ''; // !<
22 var $mContentLoaded = false; // !<
23 var $mCounter = -1; // !< Not loaded
24 var $mCurID = -1; // !< Not loaded
25 var $mDataLoaded = false; // !<
26 var $mForUpdate = false; // !<
27 var $mGoodAdjustment = 0; // !<
28 var $mIsRedirect = false; // !<
29 var $mLatest = false; // !<
30 var $mMinorEdit; // !<
32 var $mPreparedEdit = false; // !< Title object if set
33 var $mRedirectedFrom = null; // !< Title object if set
34 var $mRedirectTarget = null; // !< Title object if set
35 var $mRedirectUrl = false; // !<
36 var $mRevIdFetched = 0; // !<
37 var $mRevision; // !< Revision object if set
38 var $mTimestamp = ''; // !<
39 var $mTitle; // !< Title object
40 var $mTotalAdjustment = 0; // !<
41 var $mTouched = '19700101000000'; // !<
42 var $mUser = -1; // !< Not loaded
43 var $mUserText = ''; // !< username from Revision if set
44 var $mParserOptions; // !< ParserOptions object
45 var $mParserOutput; // !< ParserCache object if set
49 * Constructor and clear the article
50 * @param $title Reference to a Title object.
51 * @param $oldId Integer revision ID, null to fetch from request, zero for current
53 public function __construct( Title
$title, $oldId = null ) {
54 // FIXME: does the reference play any role here?
55 $this->mTitle
=& $title;
56 $this->mOldId
= $oldId;
60 * Constructor from an page id
61 * @param $id The article ID to load
63 public static function newFromID( $id ) {
64 $t = Title
::newFromID( $id );
65 # FIXME: doesn't inherit right
66 return $t == null ?
null : new self( $t );
67 # return $t == null ? null : new static( $t ); // PHP 5.3
71 * Tell the page view functions that this view was redirected
72 * from another page on the wiki.
73 * @param $from Title object.
75 public function setRedirectedFrom( Title
$from ) {
76 $this->mRedirectedFrom
= $from;
80 * If this page is a redirect, get its target
82 * The target will be fetched from the redirect table if possible.
83 * If this page doesn't have an entry there, call insertRedirect()
84 * @return mixed Title object, or null if this page is not a redirect
86 public function getRedirectTarget() {
87 if ( !$this->mTitle
->isRedirect() ) {
91 if ( $this->mRedirectTarget
!== null ) {
92 return $this->mRedirectTarget
;
95 # Query the redirect table
96 $dbr = wfGetDB( DB_SLAVE
);
97 $row = $dbr->selectRow( 'redirect',
98 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
99 array( 'rd_from' => $this->getID() ),
103 // rd_fragment and rd_interwiki were added later, populate them if empty
104 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
105 return $this->mRedirectTarget
= Title
::makeTitle(
106 $row->rd_namespace
, $row->rd_title
,
107 $row->rd_fragment
, $row->rd_interwiki
);
110 # This page doesn't have an entry in the redirect table
111 return $this->mRedirectTarget
= $this->insertRedirect();
115 * Insert an entry for this page into the redirect table.
117 * Don't call this function directly unless you know what you're doing.
118 * @return Title object or null if not a redirect
120 public function insertRedirect() {
121 // recurse through to only get the final target
122 $retval = Title
::newFromRedirectRecurse( $this->getContent() );
126 $this->insertRedirectEntry( $retval );
131 * Insert or update the redirect table entry for this page to indicate
132 * it redirects to $rt .
133 * @param $rt Title redirect target
135 public function insertRedirectEntry( $rt ) {
136 $dbw = wfGetDB( DB_MASTER
);
137 $dbw->replace( 'redirect', array( 'rd_from' ),
139 'rd_from' => $this->getID(),
140 'rd_namespace' => $rt->getNamespace(),
141 'rd_title' => $rt->getDBkey(),
142 'rd_fragment' => $rt->getFragment(),
143 'rd_interwiki' => $rt->getInterwiki(),
150 * Get the Title object or URL this page redirects to
152 * @return mixed false, Title of in-wiki target, or string with URL
154 public function followRedirect() {
155 return $this->getRedirectURL( $this->getRedirectTarget() );
159 * Get the Title object this text redirects to
161 * @param $text string article content containing redirect info
162 * @return mixed false, Title of in-wiki target, or string with URL
165 public function followRedirectText( $text ) {
166 // recurse through to only get the final target
167 return $this->getRedirectURL( Title
::newFromRedirectRecurse( $text ) );
171 * Get the Title object or URL to use for a redirect. We use Title
172 * objects for same-wiki, non-special redirects and URLs for everything
174 * @param $rt Title Redirect target
175 * @return mixed false, Title object of local target, or string with URL
177 public function getRedirectURL( $rt ) {
179 if ( $rt->getInterwiki() != '' ) {
180 if ( $rt->isLocal() ) {
181 // Offsite wikis need an HTTP redirect.
183 // This can be hard to reverse and may produce loops,
184 // so they may be disabled in the site configuration.
185 $source = $this->mTitle
->getFullURL( 'redirect=no' );
186 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
189 if ( $rt->getNamespace() == NS_SPECIAL
) {
190 // Gotta handle redirects to special pages differently:
191 // Fill the HTTP response "Location" header and ignore
192 // the rest of the page we're on.
194 // This can be hard to reverse, so they may be disabled.
195 if ( $rt->isSpecial( 'Userlogout' ) ) {
198 return $rt->getFullURL();
206 // No or invalid redirect
211 * Get the title object of the article
212 * @return Title object of this page
214 public function getTitle() {
215 return $this->mTitle
;
220 * FIXME: shouldn't this be public?
223 public function clear() {
224 $this->mDataLoaded
= false;
225 $this->mContentLoaded
= false;
227 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
228 $this->mRedirectedFrom
= null; # Title object if set
229 $this->mRedirectTarget
= null; # Title object if set
231 $this->mTimestamp
= $this->mComment
= '';
232 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
233 $this->mTouched
= '19700101000000';
234 $this->mForUpdate
= false;
235 $this->mIsRedirect
= false;
236 $this->mRevIdFetched
= 0;
237 $this->mRedirectUrl
= false;
238 $this->mLatest
= false;
239 $this->mPreparedEdit
= false;
243 * Note that getContent/loadContent do not follow redirects anymore.
244 * If you need to fetch redirectable content easily, try
245 * the shortcut in Article::followRedirect()
247 * This function has side effects! Do not use this function if you
248 * only want the real revision text if any.
250 * @return Return the text of this revision
252 public function getContent() {
253 global $wgUser, $wgContLang, $wgMessageCache;
255 wfProfileIn( __METHOD__
);
257 if ( $this->getID() === 0 ) {
258 # If this is a MediaWiki:x message, then load the messages
259 # and return the message value for x.
260 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
261 # If this is a system message, get the default text.
262 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
263 $text = wfMsgGetKey( $message, false, $lang, false );
265 if ( wfEmptyMsg( $message, $text ) )
268 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
270 wfProfileOut( __METHOD__
);
274 $this->loadContent();
275 wfProfileOut( __METHOD__
);
277 return $this->mContent
;
282 * Get the text of the current revision. No side-effects...
284 * @return Return the text of the current revision
286 public function getRawText() {
287 // Check process cache for current revision
288 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
289 return $this->mContent
;
292 $rev = Revision
::newFromTitle( $this->mTitle
);
293 $text = $rev ?
$rev->getRawText() : false;
299 * This function returns the text of a section, specified by a number ($section).
300 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
301 * the first section before any such heading (section 0).
303 * If a section contains subsections, these are also returned.
305 * @param $text String: text to look in
306 * @param $section Integer: section number
307 * @return string text of the requested section
310 public function getSection( $text, $section ) {
312 return $wgParser->getSection( $text, $section );
316 * Get the text that needs to be saved in order to undo all revisions
317 * between $undo and $undoafter. Revisions must belong to the same page,
318 * must exist and must not be deleted
319 * @param $undo Revision
320 * @param $undoafter Revision Must be an earlier revision than $undo
321 * @return mixed string on success, false on failure
323 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
324 $currentRev = Revision
::newFromTitle( $this->mTitle
);
325 if ( !$currentRev ) {
326 return false; // no page
328 $undo_text = $undo->getText();
329 $undoafter_text = $undoafter->getText();
330 $cur_text = $currentRev->getText();
332 if ( $cur_text == $undo_text ) {
333 # No use doing a merge if it's just a straight revert.
334 return $undoafter_text;
339 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
347 * @return int The oldid of the article that is to be shown, 0 for the
350 public function getOldID() {
351 if ( is_null( $this->mOldId
) ) {
352 $this->mOldId
= $this->getOldIDFromRequest();
355 return $this->mOldId
;
359 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
361 * @return int The old id for the request
363 public function getOldIDFromRequest() {
366 $this->mRedirectUrl
= false;
368 $oldid = $wgRequest->getVal( 'oldid' );
370 if ( isset( $oldid ) ) {
371 $oldid = intval( $oldid );
372 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
373 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
377 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
379 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
380 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
395 * Load the revision (including text) into this object
397 function loadContent() {
398 if ( $this->mContentLoaded
) {
402 wfProfileIn( __METHOD__
);
404 $oldid = $this->getOldID();
405 $this->mOldId
= $oldid;
406 $this->fetchContent( $oldid );
408 wfProfileOut( __METHOD__
);
412 * Fetch a page record with the given conditions
413 * @param $dbr Database object
414 * @param $conditions Array
415 * @return mixed Database result resource, or false on failure
417 protected function pageData( $dbr, $conditions ) {
432 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
434 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
436 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
442 * Fetch a page record matching the Title object's namespace and title
443 * using a sanitized title string
445 * @param $dbr Database object
446 * @param $title Title object
447 * @return mixed Database result resource, or false on failure
449 public function pageDataFromTitle( $dbr, $title ) {
450 return $this->pageData( $dbr, array(
451 'page_namespace' => $title->getNamespace(),
452 'page_title' => $title->getDBkey() ) );
456 * Fetch a page record matching the requested ID
458 * @param $dbr Database
461 protected function pageDataFromId( $dbr, $id ) {
462 return $this->pageData( $dbr, array( 'page_id' => $id ) );
466 * Set the general counter, title etc data loaded from
469 * @param $data Database row object or "fromdb"
471 public function loadPageData( $data = 'fromdb' ) {
472 if ( $data === 'fromdb' ) {
473 $dbr = wfGetDB( DB_MASTER
);
474 $data = $this->pageDataFromId( $dbr, $this->getId() );
477 $lc = LinkCache
::singleton();
480 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
, $data->page_latest
);
482 $this->mTitle
->mArticleID
= intval( $data->page_id
);
484 # Old-fashioned restrictions
485 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
487 $this->mCounter
= intval( $data->page_counter
);
488 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
489 $this->mIsRedirect
= intval( $data->page_is_redirect
);
490 $this->mLatest
= intval( $data->page_latest
);
492 $lc->addBadLinkObj( $this->mTitle
);
493 $this->mTitle
->mArticleID
= 0;
496 $this->mDataLoaded
= true;
500 * Get text of an article from database
501 * Does *NOT* follow redirects.
503 * @param $oldid Int: 0 for whatever the latest revision is
504 * @return mixed string containing article contents, or false if null
506 function fetchContent( $oldid = 0 ) {
507 if ( $this->mContentLoaded
) {
508 return $this->mContent
;
511 $dbr = wfGetDB( DB_MASTER
);
513 # Pre-fill content with error message so that if something
514 # fails we'll have something telling us what we intended.
515 $t = $this->mTitle
->getPrefixedText();
516 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
517 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
520 $revision = Revision
::newFromId( $oldid );
521 if ( $revision === null ) {
522 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
526 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
529 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
533 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
534 $this->loadPageData( $data );
536 if ( !$this->mDataLoaded
) {
537 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
540 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
544 $this->loadPageData( $data );
546 $revision = Revision
::newFromId( $this->mLatest
);
547 if ( $revision === null ) {
548 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
553 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
554 // We should instead work with the Revision object when we need it...
555 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
557 $this->mUser
= $revision->getUser();
558 $this->mUserText
= $revision->getUserText();
559 $this->mComment
= $revision->getComment();
560 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
562 $this->mRevIdFetched
= $revision->getId();
563 $this->mContentLoaded
= true;
564 $this->mRevision
=& $revision;
566 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
568 return $this->mContent
;
572 * Read/write accessor to select FOR UPDATE
574 * @param $x Mixed: FIXME
575 * @return mixed value of $x, or value stored in Article::mForUpdate
577 public function forUpdate( $x = null ) {
578 return wfSetVar( $this->mForUpdate
, $x );
582 * Get options for all SELECT statements
584 * @param $options Array: an optional options array which'll be appended to
586 * @return Array: options
588 protected function getSelectOptions( $options = '' ) {
589 if ( $this->mForUpdate
) {
590 if ( is_array( $options ) ) {
591 $options[] = 'FOR UPDATE';
593 $options = 'FOR UPDATE';
601 * @return int Page ID
603 public function getID() {
604 return $this->mTitle
->getArticleID();
608 * @return bool Whether or not the page exists in the database
610 public function exists() {
611 return $this->getId() > 0;
615 * Check if this page is something we're going to be showing
616 * some sort of sensible content for. If we return false, page
617 * views (plain action=view) will return an HTTP 404 response,
618 * so spiders and robots can know they're following a bad link.
622 public function hasViewableContent() {
623 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
627 * @return int The view count for the page
629 public function getCount() {
630 if ( -1 == $this->mCounter
) {
631 $id = $this->getID();
636 $dbr = wfGetDB( DB_SLAVE
);
637 $this->mCounter
= $dbr->selectField( 'page',
639 array( 'page_id' => $id ),
641 $this->getSelectOptions()
646 return $this->mCounter
;
650 * Determine whether a page would be suitable for being counted as an
651 * article in the site_stats table based on the title & its content
653 * @param $text String: text to analyze
656 public function isCountable( $text ) {
657 global $wgUseCommaCount;
659 $token = $wgUseCommaCount ?
',' : '[[';
661 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
665 * Tests if the article text represents a redirect
667 * @param $text mixed string containing article contents, or boolean
670 public function isRedirect( $text = false ) {
671 if ( $text === false ) {
672 if ( $this->mDataLoaded
) {
673 return $this->mIsRedirect
;
676 // Apparently loadPageData was never called
677 $this->loadContent();
678 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
680 $titleObj = Title
::newFromRedirect( $text );
683 return $titleObj !== null;
687 * Returns true if the currently-referenced revision is the current edit
688 * to this page (and it exists).
691 public function isCurrent() {
692 # If no oldid, this is the current version.
693 if ( $this->getOldID() == 0 ) {
697 return $this->exists() && isset( $this->mRevision
) && $this->mRevision
->isCurrent();
701 * Loads everything except the text
702 * This isn't necessary for all uses, so it's only done if needed.
704 protected function loadLastEdit() {
705 if ( -1 != $this->mUser
) {
709 # New or non-existent articles have no user information
710 $id = $this->getID();
715 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
716 if ( !is_null( $this->mLastRevision
) ) {
717 $this->mUser
= $this->mLastRevision
->getUser();
718 $this->mUserText
= $this->mLastRevision
->getUserText();
719 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
720 $this->mComment
= $this->mLastRevision
->getComment();
721 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
722 $this->mRevIdFetched
= $this->mLastRevision
->getId();
727 * @return string GMT timestamp of last article revision
730 public function getTimestamp() {
731 // Check if the field has been filled by ParserCache::get()
732 if ( !$this->mTimestamp
) {
733 $this->loadLastEdit();
736 return wfTimestamp( TS_MW
, $this->mTimestamp
);
740 * @return int user ID for the user that made the last article revision
742 public function getUser() {
743 $this->loadLastEdit();
748 * @return string username of the user that made the last article revision
750 public function getUserText() {
751 $this->loadLastEdit();
752 return $this->mUserText
;
756 * @return string Comment stored for the last article revision
758 public function getComment() {
759 $this->loadLastEdit();
760 return $this->mComment
;
764 * Returns true if last revision was marked as "minor edit"
766 * @return boolean Minor edit indicator for the last article revision.
768 public function getMinorEdit() {
769 $this->loadLastEdit();
770 return $this->mMinorEdit
;
774 * Use this to fetch the rev ID used on page views
776 * @return int revision ID of last article revision
778 public function getRevIdFetched() {
779 $this->loadLastEdit();
780 return $this->mRevIdFetched
;
784 * FIXME: this does what?
785 * @param $limit Integer: default 0.
786 * @param $offset Integer: default 0.
787 * @return UserArrayFromResult object with User objects of article contributors for requested range
789 public function getContributors( $limit = 0, $offset = 0 ) {
790 # FIXME: this is expensive; cache this info somewhere.
792 $dbr = wfGetDB( DB_SLAVE
);
793 $revTable = $dbr->tableName( 'revision' );
794 $userTable = $dbr->tableName( 'user' );
796 $pageId = $this->getId();
798 $user = $this->getUser();
801 $excludeCond = "AND rev_user != $user";
803 $userText = $dbr->addQuotes( $this->getUserText() );
804 $excludeCond = "AND rev_user_text != $userText";
807 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
809 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
810 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
811 WHERE rev_page = $pageId
814 GROUP BY rev_user, rev_user_text
815 ORDER BY timestamp DESC";
818 $sql = $dbr->limitResult( $sql, $limit, $offset );
821 $sql .= ' ' . $this->getSelectOptions();
822 $res = $dbr->query( $sql, __METHOD__
);
824 return new UserArrayFromResult( $res );
828 * This is the default action of the index.php entry point: just view the
829 * page of the given title.
831 public function view() {
832 global $wgUser, $wgOut, $wgRequest, $wgParser;
833 global $wgUseFileCache, $wgUseETag;
835 wfProfileIn( __METHOD__
);
837 # Get variables from query string
838 $oldid = $this->getOldID();
839 $parserCache = ParserCache
::singleton();
841 $parserOptions = $this->getParserOptions();
842 # Render printable version, use printable version cache
843 if ( $wgOut->isPrintable() ) {
844 $parserOptions->setIsPrintable( true );
845 $parserOptions->setEditSection( false );
846 } else if ( $wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
847 $parserOptions->setEditSection( false );
850 # Try client and file cache
851 if ( $oldid === 0 && $this->checkTouched() ) {
853 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
856 # Is it client cached?
857 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
858 wfDebug( __METHOD__
. ": done 304\n" );
859 wfProfileOut( __METHOD__
);
863 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
864 wfDebug( __METHOD__
. ": done file cache\n" );
865 # tell wgOut that output is taken care of
867 $this->viewUpdates();
868 wfProfileOut( __METHOD__
);
874 # getOldID may want us to redirect somewhere else
875 if ( $this->mRedirectUrl
) {
876 $wgOut->redirect( $this->mRedirectUrl
);
877 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
878 wfProfileOut( __METHOD__
);
883 $wgOut->setArticleFlag( true );
884 # Set page title (may be overridden by DISPLAYTITLE)
885 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
887 # If we got diff in the query, we want to see a diff page instead of the article.
888 if ( $wgRequest->getCheck( 'diff' ) ) {
889 wfDebug( __METHOD__
. ": showing diff page\n" );
890 $this->showDiffPage();
891 wfProfileOut( __METHOD__
);
896 if ( !$wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
897 $parserOptions->setEditSection( false );
900 # Should the parser cache be used?
901 $useParserCache = $this->useParserCache( $oldid );
902 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
903 if ( $wgUser->getStubThreshold() ) {
904 wfIncrStats( 'pcache_miss_stub' );
907 $wasRedirected = $this->showRedirectedFromHeader();
908 $this->showNamespaceHeader();
910 # Iterate through the possible ways of constructing the output text.
911 # Keep going until $outputDone is set, or we run out of things to do.
914 $this->mParserOutput
= false;
916 while ( !$outputDone && ++
$pass ) {
919 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
922 # Try the parser cache
923 if ( $useParserCache ) {
924 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
926 if ( $this->mParserOutput
!== false ) {
927 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
928 $wgOut->addParserOutput( $this->mParserOutput
);
929 # Ensure that UI elements requiring revision ID have
930 # the correct version information.
931 $wgOut->setRevisionId( $this->mLatest
);
937 $text = $this->getContent();
938 if ( $text === false ||
$this->getID() == 0 ) {
939 wfDebug( __METHOD__
. ": showing missing article\n" );
940 $this->showMissingArticle();
941 wfProfileOut( __METHOD__
);
945 # Another whitelist check in case oldid is altering the title
946 if ( !$this->mTitle
->userCanRead() ) {
947 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
948 $wgOut->loginToUse();
951 wfProfileOut( __METHOD__
);
955 # Are we looking at an old revision
956 if ( $oldid && !is_null( $this->mRevision
) ) {
957 $this->setOldSubtitle( $oldid );
959 if ( !$this->showDeletedRevisionHeader() ) {
960 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
961 wfProfileOut( __METHOD__
);
965 # If this "old" version is the current, then try the parser cache...
966 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
967 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
968 if ( $this->mParserOutput
) {
969 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
970 $wgOut->addParserOutput( $this->mParserOutput
);
971 $wgOut->setRevisionId( $this->mLatest
);
978 # Ensure that UI elements requiring revision ID have
979 # the correct version information.
980 $wgOut->setRevisionId( $this->getRevIdFetched() );
982 # Pages containing custom CSS or JavaScript get special treatment
983 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
984 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
985 $this->showCssOrJsPage();
987 } else if ( $rt = Title
::newFromRedirectArray( $text ) ) {
988 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
989 # Viewing a redirect page (e.g. with parameter redirect=no)
990 # Don't append the subtitle if this was an old revision
991 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
992 # Parse just to get categories, displaytitle, etc.
993 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
994 $wgOut->addParserOutputNoText( $this->mParserOutput
);
999 # Run the parse, protected by a pool counter
1000 wfDebug( __METHOD__
. ": doing uncached parse\n" );
1002 $this->checkTouched();
1003 $key = $parserCache->getKey( $this, $parserOptions );
1004 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
1006 if ( !$poolArticleView->execute() ) {
1007 # Connection or timeout error
1008 wfProfileOut( __METHOD__
);
1014 # Should be unreachable, but just in case...
1020 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1021 if ( $this->mParserOutput
) {
1022 $titleText = $this->mParserOutput
->getTitleText();
1024 if ( strval( $titleText ) !== '' ) {
1025 $wgOut->setPageTitle( $titleText );
1029 # For the main page, overwrite the <title> element with the con-
1030 # tents of 'pagetitle-view-mainpage' instead of the default (if
1031 # that's not empty).
1032 # This message always exists because it is in the i18n files
1033 if ( $this->mTitle
->equals( Title
::newMainPage() )
1034 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1036 $wgOut->setHTMLTitle( $m );
1039 # Now that we've filled $this->mParserOutput, we know whether
1040 # there are any __NOINDEX__ tags on the page
1041 $policy = $this->getRobotPolicy( 'view' );
1042 $wgOut->setIndexPolicy( $policy['index'] );
1043 $wgOut->setFollowPolicy( $policy['follow'] );
1045 $this->showViewFooter();
1046 $this->viewUpdates();
1047 wfProfileOut( __METHOD__
);
1051 * Show a diff page according to current request variables. For use within
1052 * Article::view() only, other callers should use the DifferenceEngine class.
1054 public function showDiffPage() {
1055 global $wgRequest, $wgUser;
1057 $diff = $wgRequest->getVal( 'diff' );
1058 $rcid = $wgRequest->getVal( 'rcid' );
1059 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1060 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1061 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1062 $oldid = $this->getOldID();
1064 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1065 // DifferenceEngine directly fetched the revision:
1066 $this->mRevIdFetched
= $de->mNewid
;
1067 $de->showDiffPage( $diffOnly );
1069 // Needed to get the page's current revision
1070 $this->loadPageData();
1071 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1072 # Run view updates for current revision only
1073 $this->viewUpdates();
1078 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1079 * Article::view() only.
1081 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1084 protected function showCssOrJsPage() {
1087 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1089 // Give hooks a chance to customise the output
1090 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1091 // Wrap the whole lot in a <pre> and don't parse
1093 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1094 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1095 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1096 $wgOut->addHTML( "\n</pre>\n" );
1101 * Get the robot policy to be used for the current view
1102 * @param $action String the action= GET parameter
1103 * @return Array the policy that should be set
1104 * TODO: actions other than 'view'
1106 public function getRobotPolicy( $action ) {
1107 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1108 global $wgDefaultRobotPolicy, $wgRequest;
1110 $ns = $this->mTitle
->getNamespace();
1112 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1113 # Don't index user and user talk pages for blocked users (bug 11443)
1114 if ( !$this->mTitle
->isSubpage() ) {
1115 $block = new Block();
1116 if ( $block->load( $this->mTitle
->getText() ) ) {
1118 'index' => 'noindex',
1119 'follow' => 'nofollow'
1125 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1126 # Non-articles (special pages etc), and old revisions
1128 'index' => 'noindex',
1129 'follow' => 'nofollow'
1131 } elseif ( $wgOut->isPrintable() ) {
1132 # Discourage indexing of printable versions, but encourage following
1134 'index' => 'noindex',
1135 'follow' => 'follow'
1137 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1138 # For ?curid=x urls, disallow indexing
1140 'index' => 'noindex',
1141 'follow' => 'follow'
1145 # Otherwise, construct the policy based on the various config variables.
1146 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1148 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1149 # Honour customised robot policies for this namespace
1150 $policy = array_merge(
1152 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1155 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1156 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1157 # a final sanity check that we have really got the parser output.
1158 $policy = array_merge(
1160 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1164 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1165 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1166 $policy = array_merge(
1168 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1176 * Converts a String robot policy into an associative array, to allow
1177 * merging of several policies using array_merge().
1178 * @param $policy Mixed, returns empty array on null/false/'', transparent
1179 * to already-converted arrays, converts String.
1180 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1182 public static function formatRobotPolicy( $policy ) {
1183 if ( is_array( $policy ) ) {
1185 } elseif ( !$policy ) {
1189 $policy = explode( ',', $policy );
1190 $policy = array_map( 'trim', $policy );
1193 foreach ( $policy as $var ) {
1194 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1195 $arr['index'] = $var;
1196 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1197 $arr['follow'] = $var;
1205 * If this request is a redirect view, send "redirected from" subtitle to
1206 * $wgOut. Returns true if the header was needed, false if this is not a
1207 * redirect view. Handles both local and remote redirects.
1211 public function showRedirectedFromHeader() {
1212 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1214 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1215 $sk = $wgUser->getSkin();
1217 if ( isset( $this->mRedirectedFrom
) ) {
1218 // This is an internally redirected page view.
1219 // We'll need a backlink to the source page for navigation.
1220 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1222 $this->mRedirectedFrom
,
1225 array( 'redirect' => 'no' ),
1226 array( 'known', 'noclasses' )
1229 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1230 $wgOut->setSubtitle( $s );
1232 // Set the fragment if one was specified in the redirect
1233 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1234 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1235 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1238 // Add a <link rel="canonical"> tag
1239 $wgOut->addLink( array( 'rel' => 'canonical',
1240 'href' => $this->mTitle
->getLocalURL() )
1245 } elseif ( $rdfrom ) {
1246 // This is an externally redirected view, from some other wiki.
1247 // If it was reported from a trusted site, supply a backlink.
1248 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1249 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1250 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1251 $wgOut->setSubtitle( $s );
1261 * Show a header specific to the namespace currently being viewed, like
1262 * [[MediaWiki:Talkpagetext]]. For Article::view().
1264 public function showNamespaceHeader() {
1267 if ( $this->mTitle
->isTalkPage() ) {
1268 $msg = wfMsgNoTrans( 'talkpageheader' );
1269 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1270 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1276 * Show the footer section of an ordinary page view
1278 public function showViewFooter() {
1279 global $wgOut, $wgUseTrackbacks;
1281 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1282 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1283 $wgOut->addWikiMsg( 'anontalkpagetext' );
1286 # If we have been passed an &rcid= parameter, we want to give the user a
1287 # chance to mark this new article as patrolled.
1288 $this->showPatrolFooter();
1291 if ( $wgUseTrackbacks ) {
1292 $this->addTrackbacks();
1297 * If patrol is possible, output a patrol UI box. This is called from the
1298 * footer section of ordinary page views. If patrol is not possible or not
1299 * desired, does nothing.
1301 public function showPatrolFooter() {
1302 global $wgOut, $wgRequest, $wgUser;
1304 $rcid = $wgRequest->getVal( 'rcid' );
1306 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1310 $sk = $wgUser->getSkin();
1311 $token = $wgUser->editToken( $rcid );
1314 "<div class='patrollink'>" .
1316 'markaspatrolledlink',
1319 wfMsgHtml( 'markaspatrolledtext' ),
1322 'action' => 'markpatrolled',
1326 array( 'known', 'noclasses' )
1334 * Show the error text for a missing article. For articles in the MediaWiki
1335 * namespace, show the default message text. To be called from Article::view().
1337 public function showMissingArticle() {
1338 global $wgOut, $wgRequest, $wgUser;
1340 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1341 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1342 $parts = explode( '/', $this->mTitle
->getText() );
1343 $rootPart = $parts[0];
1344 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1345 $ip = User
::isIP( $rootPart );
1347 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1348 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1349 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1350 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1351 LogEventsList
::showLogExtract(
1354 $user->getUserPage()->getPrefixedText(),
1358 'showIfEmpty' => false,
1360 'blocked-notice-logextract',
1361 $user->getName() # Support GENDER in notice
1368 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1370 # Show delete and move logs
1371 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1373 'conds' => array( "log_action != 'revision'" ),
1374 'showIfEmpty' => false,
1375 'msgKey' => array( 'moveddeleted-notice' ) )
1378 # Show error message
1379 $oldid = $this->getOldID();
1381 $text = wfMsgNoTrans( 'missing-article',
1382 $this->mTitle
->getPrefixedText(),
1383 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1384 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1385 // Use the default message text
1386 $text = $this->getContent();
1388 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1389 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1390 $errors = array_merge( $createErrors, $editErrors );
1392 if ( !count( $errors ) ) {
1393 $text = wfMsgNoTrans( 'noarticletext' );
1395 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1398 $text = "<div class='noarticletext'>\n$text\n</div>";
1400 if ( !$this->hasViewableContent() ) {
1401 // If there's no backing content, send a 404 Not Found
1402 // for better machine handling of broken links.
1403 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1406 $wgOut->addWikiText( $text );
1410 * If the revision requested for view is deleted, check permissions.
1411 * Send either an error message or a warning header to $wgOut.
1413 * @return boolean true if the view is allowed, false if not.
1415 public function showDeletedRevisionHeader() {
1416 global $wgOut, $wgRequest;
1418 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1423 // If the user is not allowed to see it...
1424 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1425 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1426 'rev-deleted-text-permission' );
1429 // If the user needs to confirm that they want to see it...
1430 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1431 # Give explanation and add a link to view the revision...
1432 $oldid = intval( $this->getOldID() );
1433 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1434 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1435 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1436 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1437 array( $msg, $link ) );
1440 // We are allowed to see...
1442 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1443 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1444 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1451 * Should the parser cache be used?
1455 public function useParserCache( $oldid ) {
1456 global $wgUser, $wgEnableParserCache;
1458 return $wgEnableParserCache
1459 && $wgUser->getStubThreshold() == 0
1462 && !$this->mTitle
->isCssOrJsPage()
1463 && !$this->mTitle
->isCssJsSubpage();
1467 * Execute the uncached parse for action=view
1469 public function doViewParse() {
1472 $oldid = $this->getOldID();
1473 $useParserCache = $this->useParserCache( $oldid );
1474 $parserOptions = $this->getParserOptions();
1476 # Render printable version, use printable version cache
1477 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1479 # Don't show section-edit links on old revisions... this way lies madness.
1480 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ) {
1481 $parserOptions->setEditSection( false );
1484 $useParserCache = $this->useParserCache( $oldid );
1485 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1491 * Try to fetch an expired entry from the parser cache. If it is present,
1492 * output it and return true. If it is not present, output nothing and
1493 * return false. This is used as a callback function for
1494 * PoolCounter::executeProtected().
1498 public function tryDirtyCache() {
1500 $parserCache = ParserCache
::singleton();
1501 $options = clone $this->getParserOptions();
1503 if ( $wgOut->isPrintable() ) {
1504 $options->setIsPrintable( true );
1505 $options->setEditSection( false );
1508 $output = $parserCache->getDirty( $this, $options );
1511 wfDebug( __METHOD__
. ": sending dirty output\n" );
1512 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1513 $wgOut->setSquidMaxage( 0 );
1514 $this->mParserOutput
= $output;
1515 $wgOut->addParserOutput( $output );
1516 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1520 wfDebugLog( 'dirty', "dirty missing\n" );
1521 wfDebug( __METHOD__
. ": no dirty cache\n" );
1530 * @param $target Title object or Array of destination(s) to redirect
1531 * @param $appendSubtitle Boolean [optional]
1532 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1533 * @return string containing HMTL with redirect link
1535 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1536 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1538 if ( !is_array( $target ) ) {
1539 $target = array( $target );
1542 $imageDir = $wgContLang->getDir();
1544 if ( $appendSubtitle ) {
1545 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1548 $sk = $wgUser->getSkin();
1549 // the loop prepends the arrow image before the link, so the first case needs to be outside
1550 $title = array_shift( $target );
1552 if ( $forceKnown ) {
1553 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1555 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1558 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1559 $alt = $wgContLang->isRTL() ?
'←' : '→';
1560 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1561 // FIXME: where this happens?
1562 foreach ( $target as $rt ) {
1563 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1564 if ( $forceKnown ) {
1565 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1567 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1571 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1572 return Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1573 '<span class="redirectText">' . $link . '</span>';
1577 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1579 public function addTrackbacks() {
1580 global $wgOut, $wgUser;
1582 $dbr = wfGetDB( DB_SLAVE
);
1583 $tbs = $dbr->select( 'trackbacks',
1584 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1585 array( 'tb_page' => $this->getID() )
1588 if ( !$dbr->numRows( $tbs ) ) {
1593 foreach ( $tbs as $o ) {
1596 if ( $wgUser->isAllowed( 'trackback' ) ) {
1597 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1598 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1599 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1603 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1611 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1615 * Removes trackback record for current article from trackbacks table
1617 public function deletetrackback() {
1618 global $wgUser, $wgRequest, $wgOut;
1620 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1621 $wgOut->addWikiMsg( 'sessionfailure' );
1626 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1628 if ( count( $permission_errors ) ) {
1629 $wgOut->showPermissionsErrorPage( $permission_errors );
1634 $db = wfGetDB( DB_MASTER
);
1635 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1637 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1638 $this->mTitle
->invalidateCache();
1642 * Handle action=render
1645 public function render() {
1648 $wgOut->setArticleBodyOnly( true );
1653 * Handle action=purge
1655 public function purge() {
1656 global $wgUser, $wgRequest, $wgOut;
1658 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1659 //FIXME: shouldn't this be in doPurge()?
1660 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1665 $formParams = array(
1667 'action' => $wgRequest->getRequestURL(),
1670 $wgOut->addWikiMsg( 'confirm-purge-top' );
1672 $form = Html
::openElement( 'form', $formParams );
1673 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1674 $form .= Html
::closeElement( 'form' );
1676 $wgOut->addHTML( $form );
1677 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1679 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1680 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1685 * Perform the actions of a page purging
1687 public function doPurge() {
1690 // Invalidate the cache
1691 $this->mTitle
->invalidateCache();
1693 if ( $wgUseSquid ) {
1694 // Commit the transaction before the purge is sent
1695 $dbw = wfGetDB( DB_MASTER
);
1699 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1700 $update->doUpdate();
1703 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1704 global $wgMessageCache;
1706 if ( $this->getID() == 0 ) {
1709 $text = $this->getRawText();
1712 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1717 * Insert a new empty page record for this article.
1718 * This *must* be followed up by creating a revision
1719 * and running $this->updateRevisionOn( ... );
1720 * or else the record will be left in a funky state.
1721 * Best if all done inside a transaction.
1723 * @param $dbw Database
1724 * @return int The newly created page_id key, or false if the title already existed
1727 public function insertOn( $dbw ) {
1728 wfProfileIn( __METHOD__
);
1730 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1731 $dbw->insert( 'page', array(
1732 'page_id' => $page_id,
1733 'page_namespace' => $this->mTitle
->getNamespace(),
1734 'page_title' => $this->mTitle
->getDBkey(),
1735 'page_counter' => 0,
1736 'page_restrictions' => '',
1737 'page_is_redirect' => 0, # Will set this shortly...
1739 'page_random' => wfRandom(),
1740 'page_touched' => $dbw->timestamp(),
1741 'page_latest' => 0, # Fill this in shortly...
1742 'page_len' => 0, # Fill this in shortly...
1743 ), __METHOD__
, 'IGNORE' );
1745 $affected = $dbw->affectedRows();
1748 $newid = $dbw->insertId();
1749 $this->mTitle
->resetArticleId( $newid );
1751 wfProfileOut( __METHOD__
);
1753 return $affected ?
$newid : false;
1757 * Update the page record to point to a newly saved revision.
1759 * @param $dbw Database object
1760 * @param $revision Revision: For ID number, and text used to set
1761 length and redirect status fields
1762 * @param $lastRevision Integer: if given, will not overwrite the page field
1763 * when different from the currently set value.
1764 * Giving 0 indicates the new page flag should be set
1766 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1767 * removing rows in redirect table.
1768 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1769 * Needed when $lastRevision has to be set to sth. !=0
1770 * @return bool true on success, false on failure
1773 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1774 wfProfileIn( __METHOD__
);
1776 $text = $revision->getText();
1777 $rt = Title
::newFromRedirectRecurse( $text );
1779 $conditions = array( 'page_id' => $this->getId() );
1781 if ( !is_null( $lastRevision ) ) {
1782 # An extra check against threads stepping on each other
1783 $conditions['page_latest'] = $lastRevision;
1786 if ( !$setNewFlag ) {
1787 $setNewFlag = ( $lastRevision === 0 );
1790 $dbw->update( 'page',
1792 'page_latest' => $revision->getId(),
1793 'page_touched' => $dbw->timestamp(),
1794 'page_is_new' => $setNewFlag,
1795 'page_is_redirect' => $rt !== null ?
1 : 0,
1796 'page_len' => strlen( $text ),
1801 $result = $dbw->affectedRows() != 0;
1803 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1806 wfProfileOut( __METHOD__
);
1811 * Add row to the redirect table if this is a redirect, remove otherwise.
1813 * @param $dbw Database
1814 * @param $redirectTitle a title object pointing to the redirect target,
1815 * or NULL if this is not a redirect
1816 * @param $lastRevIsRedirect If given, will optimize adding and
1817 * removing rows in redirect table.
1818 * @return bool true on success, false on failure
1821 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1822 // Always update redirects (target link might have changed)
1823 // Update/Insert if we don't know if the last revision was a redirect or not
1824 // Delete if changing from redirect to non-redirect
1825 $isRedirect = !is_null( $redirectTitle );
1827 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1828 wfProfileIn( __METHOD__
);
1829 if ( $isRedirect ) {
1830 $this->insertRedirectEntry( $redirectTitle );
1832 // This is not a redirect, remove row from redirect table
1833 $where = array( 'rd_from' => $this->getId() );
1834 $dbw->delete( 'redirect', $where, __METHOD__
);
1837 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1838 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1840 wfProfileOut( __METHOD__
);
1842 return ( $dbw->affectedRows() != 0 );
1849 * If the given revision is newer than the currently set page_latest,
1850 * update the page record. Otherwise, do nothing.
1852 * @param $dbw Database object
1853 * @param $revision Revision object
1856 public function updateIfNewerOn( &$dbw, $revision ) {
1857 wfProfileIn( __METHOD__
);
1859 $row = $dbw->selectRow(
1860 array( 'revision', 'page' ),
1861 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1863 'page_id' => $this->getId(),
1864 'page_latest=rev_id' ),
1868 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1869 wfProfileOut( __METHOD__
);
1872 $prev = $row->rev_id
;
1873 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1875 # No or missing previous revision; mark the page as new
1877 $lastRevIsRedirect = null;
1880 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1882 wfProfileOut( __METHOD__
);
1887 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1888 * @param $text String: new text of the section
1889 * @param $summary String: new section's subject, only if $section is 'new'
1890 * @param $edittime String: revision timestamp or null to use the current revision
1891 * @return string Complete article text, or null if error
1893 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1894 wfProfileIn( __METHOD__
);
1896 if ( strval( $section ) == '' ) {
1897 // Whole-page edit; let the whole text through
1899 if ( is_null( $edittime ) ) {
1900 $rev = Revision
::newFromTitle( $this->mTitle
);
1902 $dbw = wfGetDB( DB_MASTER
);
1903 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1907 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1908 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1912 $oldtext = $rev->getText();
1914 if ( $section == 'new' ) {
1915 # Inserting a new section
1916 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1917 $text = strlen( trim( $oldtext ) ) > 0
1918 ?
"{$oldtext}\n\n{$subject}{$text}"
1919 : "{$subject}{$text}";
1921 # Replacing an existing section; roll out the big guns
1924 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1928 wfProfileOut( __METHOD__
);
1933 * This function is not deprecated until somebody fixes the core not to use
1934 * it. Nevertheless, use Article::doEdit() instead.
1936 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1937 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1938 ( $isminor ? EDIT_MINOR
: 0 ) |
1939 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1940 ( $bot ? EDIT_FORCE_BOT
: 0 );
1942 # If this is a comment, add the summary as headline
1943 if ( $comment && $summary != "" ) {
1944 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1946 $this->doEdit( $text, $summary, $flags );
1948 $dbw = wfGetDB( DB_MASTER
);
1950 if ( !$this->mTitle
->userIsWatching() ) {
1956 if ( $this->mTitle
->userIsWatching() ) {
1962 $this->doRedirect( $this->isRedirect( $text ) );
1966 * @deprecated use Article::doEdit()
1968 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1969 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1970 ( $minor ? EDIT_MINOR
: 0 ) |
1971 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1973 $status = $this->doEdit( $text, $summary, $flags );
1975 if ( !$status->isOK() ) {
1979 $dbw = wfGetDB( DB_MASTER
);
1981 if ( !$this->mTitle
->userIsWatching() ) {
1987 if ( $this->mTitle
->userIsWatching() ) {
1994 $extraQuery = ''; // Give extensions a chance to modify URL query on update
1995 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
1997 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2002 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2004 * @return Int updated $flags
2006 function checkFlags( $flags ) {
2007 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
2008 if ( $this->mTitle
->getArticleID() ) {
2009 $flags |
= EDIT_UPDATE
;
2021 * Change an existing article or create a new article. Updates RC and all necessary caches,
2022 * optionally via the deferred update array.
2024 * $wgUser must be set before calling this function.
2026 * @param $text String: new text
2027 * @param $summary String: edit summary
2028 * @param $flags Integer bitfield:
2030 * Article is known or assumed to be non-existent, create a new one
2032 * Article is known or assumed to be pre-existing, update it
2034 * Mark this edit minor, if the user is allowed to do so
2036 * Do not log the change in recentchanges
2038 * Mark the edit a "bot" edit regardless of user rights
2039 * EDIT_DEFER_UPDATES
2040 * Defer some of the updates until the end of index.php
2042 * Fill in blank summaries with generated text where possible
2044 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2045 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2046 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2047 * edit-already-exists error will be returned. These two conditions are also possible with
2048 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2050 * @param $baseRevId the revision ID this edit was based off, if any
2051 * @param $user Optional user object, $wgUser will be used if not passed
2053 * @return Status object. Possible errors:
2054 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2055 * edit-gone-missing: In update mode, but the article didn't exist
2056 * edit-conflict: In update mode, the article changed unexpectedly
2057 * edit-no-change: Warning that the text was the same as before
2058 * edit-already-exists: In creation mode, but the article already exists
2060 * Extensions may define additional errors.
2062 * $return->value will contain an associative array with members as follows:
2063 * new: Boolean indicating if the function attempted to create a new article
2064 * revision: The revision object for the inserted revision, or null
2066 * Compatibility note: this function previously returned a boolean value indicating success/failure
2068 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2069 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2071 # Low-level sanity check
2072 if ( $this->mTitle
->getText() === '' ) {
2073 throw new MWException( 'Something is trying to edit an article with an empty title' );
2076 wfProfileIn( __METHOD__
);
2078 $user = is_null( $user ) ?
$wgUser : $user;
2079 $status = Status
::newGood( array() );
2081 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2082 $this->loadPageData();
2084 $flags = $this->checkFlags( $flags );
2086 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2087 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
2089 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2090 wfProfileOut( __METHOD__
);
2092 if ( $status->isOK() ) {
2093 $status->fatal( 'edit-hook-aborted' );
2099 # Silently ignore EDIT_MINOR if not allowed
2100 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2101 $bot = $flags & EDIT_FORCE_BOT
;
2103 $oldtext = $this->getRawText(); // current revision
2104 $oldsize = strlen( $oldtext );
2106 # Provide autosummaries if one is not provided and autosummaries are enabled.
2107 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2108 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2111 $editInfo = $this->prepareTextForEdit( $text );
2112 $text = $editInfo->pst
;
2113 $newsize = strlen( $text );
2115 $dbw = wfGetDB( DB_MASTER
);
2116 $now = wfTimestampNow();
2117 $this->mTimestamp
= $now;
2119 if ( $flags & EDIT_UPDATE
) {
2120 # Update article, but only if changed.
2121 $status->value
['new'] = false;
2123 # Make sure the revision is either completely inserted or not inserted at all
2124 if ( !$wgDBtransactions ) {
2125 $userAbort = ignore_user_abort( true );
2128 $changed = ( strcmp( $text, $oldtext ) != 0 );
2131 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2132 - (int)$this->isCountable( $oldtext );
2133 $this->mTotalAdjustment
= 0;
2135 if ( !$this->mLatest
) {
2136 # Article gone missing
2137 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2138 $status->fatal( 'edit-gone-missing' );
2140 wfProfileOut( __METHOD__
);
2144 $revision = new Revision( array(
2145 'page' => $this->getId(),
2146 'comment' => $summary,
2147 'minor_edit' => $isminor,
2149 'parent_id' => $this->mLatest
,
2150 'user' => $user->getId(),
2151 'user_text' => $user->getName(),
2155 $revisionId = $revision->insertOn( $dbw );
2159 # Note that we use $this->mLatest instead of fetching a value from the master DB
2160 # during the course of this function. This makes sure that EditPage can detect
2161 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2162 # before this function is called. A previous function used a separate query, this
2163 # creates a window where concurrent edits can cause an ignored edit conflict.
2164 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2167 /* Belated edit conflict! Run away!! */
2168 $status->fatal( 'edit-conflict' );
2170 # Delete the invalid revision if the DB is not transactional
2171 if ( !$wgDBtransactions ) {
2172 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2178 global $wgUseRCPatrol;
2179 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2180 # Update recentchanges
2181 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2182 # Mark as patrolled if the user can do so
2183 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan( 'autopatrol' );
2184 # Add RC row to the DB
2185 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2186 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2187 $revisionId, $patrolled
2190 # Log auto-patrolled edits
2192 PatrolLog
::record( $rc, true );
2195 $user->incEditCount();
2199 $status->warning( 'edit-no-change' );
2201 // Keep the same revision ID, but do some updates on it
2202 $revisionId = $this->getRevIdFetched();
2203 // Update page_touched, this is usually implicit in the page update
2204 // Other cache updates are done in onArticleEdit()
2205 $this->mTitle
->invalidateCache();
2208 if ( !$wgDBtransactions ) {
2209 ignore_user_abort( $userAbort );
2212 // Now that ignore_user_abort is restored, we can respond to fatal errors
2213 if ( !$status->isOK() ) {
2214 wfProfileOut( __METHOD__
);
2218 # Invalidate cache of this article and all pages using this article
2219 # as a template. Partly deferred.
2220 Article
::onArticleEdit( $this->mTitle
);
2221 # Update links tables, site stats, etc.
2222 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2224 # Create new article
2225 $status->value
['new'] = true;
2227 # Set statistics members
2228 # We work out if it's countable after PST to avoid counter drift
2229 # when articles are created with {{subst:}}
2230 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2231 $this->mTotalAdjustment
= 1;
2235 # Add the page record; stake our claim on this title!
2236 # This will return false if the article already exists
2237 $newid = $this->insertOn( $dbw );
2239 if ( $newid === false ) {
2241 $status->fatal( 'edit-already-exists' );
2243 wfProfileOut( __METHOD__
);
2247 # Save the revision text...
2248 $revision = new Revision( array(
2250 'comment' => $summary,
2251 'minor_edit' => $isminor,
2253 'user' => $user->getId(),
2254 'user_text' => $user->getName(),
2256 $revisionId = $revision->insertOn( $dbw );
2258 $this->mTitle
->resetArticleID( $newid );
2260 # Update the page record with revision data
2261 $this->updateRevisionOn( $dbw, $revision, 0 );
2263 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2265 # Update recentchanges
2266 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2267 global $wgUseRCPatrol, $wgUseNPPatrol;
2269 # Mark as patrolled if the user can do so
2270 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && $this->mTitle
->userCan( 'autopatrol' );
2271 # Add RC row to the DB
2272 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2273 '', strlen( $text ), $revisionId, $patrolled );
2275 # Log auto-patrolled edits
2277 PatrolLog
::record( $rc, true );
2280 $user->incEditCount();
2283 # Update links, etc.
2284 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2287 Article
::onArticleCreate( $this->mTitle
);
2289 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2290 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2293 # Do updates right now unless deferral was requested
2294 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2298 // Return the new revision (or null) to the caller
2299 $status->value
['revision'] = $revision;
2301 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2302 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2304 wfProfileOut( __METHOD__
);
2309 * @deprecated wrapper for doRedirect
2311 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2312 wfDeprecated( __METHOD__
);
2313 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2317 * Output a redirect back to the article.
2318 * This is typically used after an edit.
2320 * @param $noRedir Boolean: add redirect=no
2321 * @param $sectionAnchor String: section to redirect to, including "#"
2322 * @param $extraQuery String: extra query params
2324 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2328 $query = 'redirect=no';
2330 $query .= "&$extraQuery";
2332 $query = $extraQuery;
2335 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2339 * Mark this particular edit/page as patrolled
2341 public function markpatrolled() {
2342 global $wgOut, $wgUser, $wgRequest;
2344 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2346 # If we haven't been given an rc_id value, we can't do anything
2347 $rcid = (int) $wgRequest->getVal( 'rcid' );
2349 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2350 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2354 $rc = RecentChange
::newFromId( $rcid );
2356 if ( is_null( $rc ) ) {
2357 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2361 # It would be nice to see where the user had actually come from, but for now just guess
2362 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2363 $return = SpecialPage
::getTitleFor( $returnto );
2365 $errors = $rc->doMarkPatrolled();
2367 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2368 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2373 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2374 // The hook itself has handled any output
2378 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2379 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2380 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2381 $wgOut->returnToMain( false, $return );
2386 if ( !empty( $errors ) ) {
2387 $wgOut->showPermissionsErrorPage( $errors );
2393 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2394 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2395 $wgOut->returnToMain( false, $return );
2399 * User-interface handler for the "watch" action
2401 public function watch() {
2402 global $wgUser, $wgOut;
2404 if ( $wgUser->isAnon() ) {
2405 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2409 if ( wfReadOnly() ) {
2410 $wgOut->readOnlyPage();
2414 if ( $this->doWatch() ) {
2415 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2416 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2417 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2420 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2424 * Add this page to $wgUser's watchlist
2425 * @return bool true on successful watch operation
2427 public function doWatch() {
2430 if ( $wgUser->isAnon() ) {
2434 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2435 $wgUser->addWatch( $this->mTitle
);
2436 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2443 * User interface handler for the "unwatch" action.
2445 public function unwatch() {
2446 global $wgUser, $wgOut;
2448 if ( $wgUser->isAnon() ) {
2449 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2453 if ( wfReadOnly() ) {
2454 $wgOut->readOnlyPage();
2458 if ( $this->doUnwatch() ) {
2459 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2460 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2461 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2464 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2468 * Stop watching a page
2469 * @return bool true on successful unwatch
2471 public function doUnwatch() {
2474 if ( $wgUser->isAnon() ) {
2478 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2479 $wgUser->removeWatch( $this->mTitle
);
2480 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2487 * action=protect handler
2489 public function protect() {
2490 $form = new ProtectionForm( $this );
2495 * action=unprotect handler (alias)
2497 public function unprotect() {
2502 * Update the article's restriction field, and leave a log entry.
2504 * @param $limit Array: set of restriction keys
2505 * @param $reason String
2506 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2507 * @param $expiry Array: per restriction type expiration
2508 * @return bool true on success
2510 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2511 global $wgUser, $wgContLang;
2513 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2515 $id = $this->mTitle
->getArticleID();
2518 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2522 if ( wfReadOnly() ) {
2523 wfDebug( "updateRestrictions failed: read-only\n" );
2527 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2528 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2536 // Take this opportunity to purge out expired restrictions
2537 Title
::purgeExpiredRestrictions();
2539 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2540 # we expect a single selection, but the schema allows otherwise.
2542 $updated = Article
::flattenRestrictions( $limit );
2545 foreach ( $restrictionTypes as $action ) {
2546 if ( isset( $expiry[$action] ) ) {
2547 # Get current restrictions on $action
2548 $aLimits = $this->mTitle
->getRestrictions( $action );
2549 $current[$action] = implode( '', $aLimits );
2550 # Are any actual restrictions being dealt with here?
2551 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2553 # If something changed, we need to log it. Checking $aRChanged
2554 # assures that "unprotecting" a page that is not protected does
2555 # not log just because the expiry was "changed".
2556 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2562 $current = Article
::flattenRestrictions( $current );
2564 $changed = ( $changed ||
$current != $updated );
2565 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2566 $protect = ( $updated != '' );
2568 # If nothing's changed, do nothing
2570 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2571 $dbw = wfGetDB( DB_MASTER
);
2573 # Prepare a null revision to be added to the history
2574 $modified = $current != '' && $protect;
2577 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2579 $comment_type = 'unprotectedarticle';
2582 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2584 # Only restrictions with the 'protect' right can cascade...
2585 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2586 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2588 # The schema allows multiple restrictions
2589 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2593 $cascade_description = '';
2596 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2600 $comment .= ": $reason";
2603 $editComment = $comment;
2604 $encodedExpiry = array();
2605 $protect_description = '';
2606 foreach ( $limit as $action => $restrictions ) {
2607 if ( !isset( $expiry[$action] ) )
2608 $expiry[$action] = Block
::infinity();
2610 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2611 if ( $restrictions != '' ) {
2612 $protect_description .= "[$action=$restrictions] (";
2613 if ( $encodedExpiry[$action] != 'infinity' ) {
2614 $protect_description .= wfMsgForContent( 'protect-expiring',
2615 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2616 $wgContLang->date( $expiry[$action], false, false ) ,
2617 $wgContLang->time( $expiry[$action], false, false ) );
2619 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2622 $protect_description .= ') ';
2625 $protect_description = trim( $protect_description );
2627 if ( $protect_description && $protect ) {
2628 $editComment .= " ($protect_description)";
2632 $editComment .= "$cascade_description";
2635 # Update restrictions table
2636 foreach ( $limit as $action => $restrictions ) {
2637 if ( $restrictions != '' ) {
2638 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2639 array( 'pr_page' => $id,
2640 'pr_type' => $action,
2641 'pr_level' => $restrictions,
2642 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2643 'pr_expiry' => $encodedExpiry[$action]
2648 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2649 'pr_type' => $action ), __METHOD__
);
2653 # Insert a null revision
2654 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2655 $nullRevId = $nullRevision->insertOn( $dbw );
2657 $latest = $this->getLatest();
2658 # Update page record
2659 $dbw->update( 'page',
2661 'page_touched' => $dbw->timestamp(),
2662 'page_restrictions' => '',
2663 'page_latest' => $nullRevId
2664 ), array( /* WHERE */
2666 ), 'Article::protect'
2669 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2670 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2672 # Update the protection log
2673 $log = new LogPage( 'protect' );
2675 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2676 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2678 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2681 } # End "changed" check
2687 * Take an array of page restrictions and flatten it to a string
2688 * suitable for insertion into the page_restrictions field.
2689 * @param $limit Array
2692 protected static function flattenRestrictions( $limit ) {
2693 if ( !is_array( $limit ) ) {
2694 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2700 foreach ( $limit as $action => $restrictions ) {
2701 if ( $restrictions != '' ) {
2702 $bits[] = "$action=$restrictions";
2706 return implode( ':', $bits );
2710 * Auto-generates a deletion reason
2712 * @param &$hasHistory Boolean: whether the page has a history
2713 * @return mixed String containing deletion reason or empty string, or boolean false
2714 * if no revision occurred
2716 public function generateReason( &$hasHistory ) {
2719 $dbw = wfGetDB( DB_MASTER
);
2720 // Get the last revision
2721 $rev = Revision
::newFromTitle( $this->mTitle
);
2723 if ( is_null( $rev ) ) {
2727 // Get the article's contents
2728 $contents = $rev->getText();
2731 // If the page is blank, use the text from the previous revision,
2732 // which can only be blank if there's a move/import/protect dummy revision involved
2733 if ( $contents == '' ) {
2734 $prev = $rev->getPrevious();
2737 $contents = $prev->getText();
2742 // Find out if there was only one contributor
2743 // Only scan the last 20 revisions
2744 $res = $dbw->select( 'revision', 'rev_user_text',
2745 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2747 array( 'LIMIT' => 20 )
2750 if ( $res === false ) {
2751 // This page has no revisions, which is very weird
2755 $hasHistory = ( $res->numRows() > 1 );
2756 $row = $dbw->fetchObject( $res );
2758 if ( $row ) { // $row is false if the only contributor is hidden
2759 $onlyAuthor = $row->rev_user_text
;
2760 // Try to find a second contributor
2761 foreach ( $res as $row ) {
2762 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2763 $onlyAuthor = false;
2768 $onlyAuthor = false;
2771 // Generate the summary with a '$1' placeholder
2773 // The current revision is blank and the one before is also
2774 // blank. It's just not our lucky day
2775 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2777 if ( $onlyAuthor ) {
2778 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2780 $reason = wfMsgForContent( 'excontent', '$1' );
2784 if ( $reason == '-' ) {
2785 // Allow these UI messages to be blanked out cleanly
2789 // Replace newlines with spaces to prevent uglyness
2790 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2791 // Calculate the maximum amount of chars to get
2792 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2793 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2794 $contents = $wgContLang->truncate( $contents, $maxLength );
2795 // Remove possible unfinished links
2796 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2797 // Now replace the '$1' placeholder
2798 $reason = str_replace( '$1', $contents, $reason );
2805 * UI entry point for page deletion
2807 public function delete() {
2808 global $wgUser, $wgOut, $wgRequest;
2810 $confirm = $wgRequest->wasPosted() &&
2811 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2813 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2814 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2816 $reason = $this->DeleteReasonList
;
2818 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2819 // Entry from drop down menu + additional comment
2820 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2821 } elseif ( $reason == 'other' ) {
2822 $reason = $this->DeleteReason
;
2825 # Flag to hide all contents of the archived revisions
2826 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2828 # This code desperately needs to be totally rewritten
2830 # Read-only check...
2831 if ( wfReadOnly() ) {
2832 $wgOut->readOnlyPage();
2838 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2840 if ( count( $permission_errors ) > 0 ) {
2841 $wgOut->showPermissionsErrorPage( $permission_errors );
2846 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2848 # Better double-check that it hasn't been deleted yet!
2849 $dbw = wfGetDB( DB_MASTER
);
2850 $conds = $this->mTitle
->pageCond();
2851 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2852 if ( $latest === false ) {
2853 $wgOut->showFatalError(
2856 array( 'class' => 'error mw-error-cannotdelete' ),
2857 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2860 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2861 LogEventsList
::showLogExtract(
2864 $this->mTitle
->getPrefixedText()
2870 # Hack for big sites
2871 $bigHistory = $this->isBigDeletion();
2872 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2873 global $wgLang, $wgDeleteRevisionsLimit;
2875 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2876 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2882 $this->doDelete( $reason, $suppress );
2884 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2886 } elseif ( $this->mTitle
->userIsWatching() ) {
2893 // Generate deletion reason
2894 $hasHistory = false;
2896 $reason = $this->generateReason( $hasHistory );
2899 // If the page has a history, insert a warning
2900 if ( $hasHistory && !$confirm ) {
2903 $skin = $wgUser->getSkin();
2904 $revisions = $this->estimateRevisionCount();
2906 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2907 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2908 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2912 if ( $bigHistory ) {
2913 global $wgDeleteRevisionsLimit;
2914 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2915 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2919 return $this->confirmDelete( $reason );
2923 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2925 public function isBigDeletion() {
2926 global $wgDeleteRevisionsLimit;
2928 if ( $wgDeleteRevisionsLimit ) {
2929 $revCount = $this->estimateRevisionCount();
2931 return $revCount > $wgDeleteRevisionsLimit;
2938 * @return int approximate revision count
2940 public function estimateRevisionCount() {
2941 $dbr = wfGetDB( DB_SLAVE
);
2943 // For an exact count...
2944 // return $dbr->selectField( 'revision', 'COUNT(*)',
2945 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2946 return $dbr->estimateRowCount( 'revision', '*',
2947 array( 'rev_page' => $this->getId() ), __METHOD__
);
2951 * Get the last N authors
2952 * @param $num Integer: number of revisions to get
2953 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2954 * @return array Array of authors, duplicates not removed
2956 public function getLastNAuthors( $num, $revLatest = 0 ) {
2957 wfProfileIn( __METHOD__
);
2958 // First try the slave
2959 // If that doesn't have the latest revision, try the master
2961 $db = wfGetDB( DB_SLAVE
);
2964 $res = $db->select( array( 'page', 'revision' ),
2965 array( 'rev_id', 'rev_user_text' ),
2967 'page_namespace' => $this->mTitle
->getNamespace(),
2968 'page_title' => $this->mTitle
->getDBkey(),
2969 'rev_page = page_id'
2970 ), __METHOD__
, $this->getSelectOptions( array(
2971 'ORDER BY' => 'rev_timestamp DESC',
2977 wfProfileOut( __METHOD__
);
2981 $row = $db->fetchObject( $res );
2983 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2984 $db = wfGetDB( DB_MASTER
);
2989 } while ( $continue );
2991 $authors = array( $row->rev_user_text
);
2993 foreach ( $res as $row ) {
2994 $authors[] = $row->rev_user_text
;
2997 wfProfileOut( __METHOD__
);
3002 * Output deletion confirmation dialog
3003 * FIXME: Move to another file?
3004 * @param $reason String: prefilled reason
3006 public function confirmDelete( $reason ) {
3007 global $wgOut, $wgUser;
3009 wfDebug( "Article::confirmDelete\n" );
3011 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3012 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3013 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3014 $wgOut->addWikiMsg( 'confirmdeletetext' );
3016 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3018 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3019 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
3021 <td class='mw-input'><strong>" .
3022 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3023 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3029 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3031 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3032 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3033 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3034 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3035 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3036 "<tr id=\"wpDeleteReasonListRow\">
3037 <td class='mw-label'>" .
3038 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3040 <td class='mw-input'>" .
3041 Xml
::listDropDown( 'wpDeleteReasonList',
3042 wfMsgForContent( 'deletereason-dropdown' ),
3043 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3046 <tr id=\"wpDeleteReasonRow\">
3047 <td class='mw-label'>" .
3048 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3050 <td class='mw-input'>" .
3051 Html
::input( 'wpReason', $reason, 'text', array(
3053 'maxlength' => '255',
3061 # Disallow watching if user is not logged in
3062 if ( $wgUser->isLoggedIn() ) {
3066 <td class='mw-input'>" .
3067 Xml
::checkLabel( wfMsg( 'watchthis' ),
3068 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3077 <td class='mw-submit'>" .
3078 Xml
::submitButton( wfMsg( 'deletepage' ),
3079 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3082 Xml
::closeElement( 'table' ) .
3083 Xml
::closeElement( 'fieldset' ) .
3084 Html
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3085 Xml
::closeElement( 'form' );
3087 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3088 $skin = $wgUser->getSkin();
3089 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3090 $link = $skin->link(
3092 wfMsgHtml( 'delete-edit-reasonlist' ),
3094 array( 'action' => 'edit' )
3096 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3099 $wgOut->addHTML( $form );
3100 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3101 LogEventsList
::showLogExtract( $wgOut, 'delete',
3102 $this->mTitle
->getPrefixedText()
3107 * Perform a deletion and output success or failure messages
3109 public function doDelete( $reason, $suppress = false ) {
3110 global $wgOut, $wgUser;
3112 $id = $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3115 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3116 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3117 $deleted = $this->mTitle
->getPrefixedText();
3119 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3120 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3122 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3124 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3125 $wgOut->returnToMain( false );
3126 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3129 if ( $error == '' ) {
3130 $wgOut->showFatalError(
3133 array( 'class' => 'error mw-error-cannotdelete' ),
3134 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3138 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3140 LogEventsList
::showLogExtract(
3143 $this->mTitle
->getPrefixedText()
3146 $wgOut->showFatalError( $error );
3152 * Back-end article deletion
3153 * Deletes the article with database consistency, writes logs, purges caches
3155 * @param $reason string delete reason for deletion log
3156 * @param suppress bitfield
3157 * Revision::DELETED_TEXT
3158 * Revision::DELETED_COMMENT
3159 * Revision::DELETED_USER
3160 * Revision::DELETED_RESTRICTED
3161 * @param $id int article ID
3162 * @param $commit boolean defaults to true, triggers transaction end
3163 * @return boolean true if successful
3165 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3166 global $wgDeferredUpdateList, $wgUseTrackbacks;
3168 wfDebug( __METHOD__
. "\n" );
3170 $dbw = wfGetDB( DB_MASTER
);
3171 $t = $this->mTitle
->getDBkey();
3172 $id = $id ?
$id : $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3174 if ( $t === '' ||
$id == 0 ) {
3178 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3179 array_push( $wgDeferredUpdateList, $u );
3181 // Bitfields to further suppress the content
3184 // This should be 15...
3185 $bitfield |
= Revision
::DELETED_TEXT
;
3186 $bitfield |
= Revision
::DELETED_COMMENT
;
3187 $bitfield |
= Revision
::DELETED_USER
;
3188 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3190 $bitfield = 'rev_deleted';
3194 // For now, shunt the revision data into the archive table.
3195 // Text is *not* removed from the text table; bulk storage
3196 // is left intact to avoid breaking block-compression or
3197 // immutable storage schemes.
3199 // For backwards compatibility, note that some older archive
3200 // table entries will have ar_text and ar_flags fields still.
3202 // In the future, we may keep revisions and mark them with
3203 // the rev_deleted field, which is reserved for this purpose.
3204 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3206 'ar_namespace' => 'page_namespace',
3207 'ar_title' => 'page_title',
3208 'ar_comment' => 'rev_comment',
3209 'ar_user' => 'rev_user',
3210 'ar_user_text' => 'rev_user_text',
3211 'ar_timestamp' => 'rev_timestamp',
3212 'ar_minor_edit' => 'rev_minor_edit',
3213 'ar_rev_id' => 'rev_id',
3214 'ar_text_id' => 'rev_text_id',
3215 'ar_text' => '\'\'', // Be explicit to appease
3216 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3217 'ar_len' => 'rev_len',
3218 'ar_page_id' => 'page_id',
3219 'ar_deleted' => $bitfield
3222 'page_id = rev_page'
3226 # Delete restrictions for it
3227 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3229 # Now that it's safely backed up, delete it
3230 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3231 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3238 # Fix category table counts
3240 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3242 foreach ( $res as $row ) {
3243 $cats [] = $row->cl_to
;
3246 $this->updateCategoryCounts( array(), $cats );
3248 # If using cascading deletes, we can skip some explicit deletes
3249 if ( !$dbw->cascadingDeletes() ) {
3250 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3252 if ( $wgUseTrackbacks )
3253 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3255 # Delete outgoing links
3256 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3257 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3258 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3259 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3260 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3261 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3262 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3265 # If using cleanup triggers, we can skip some manual deletes
3266 if ( !$dbw->cleanupTriggers() ) {
3267 # Clean up recentchanges entries...
3268 $dbw->delete( 'recentchanges',
3269 array( 'rc_type != ' . RC_LOG
,
3270 'rc_namespace' => $this->mTitle
->getNamespace(),
3271 'rc_title' => $this->mTitle
->getDBkey() ),
3273 $dbw->delete( 'recentchanges',
3274 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3279 Article
::onArticleDelete( $this->mTitle
);
3281 # Clear the cached article id so the interface doesn't act like we exist
3282 $this->mTitle
->resetArticleID( 0 );
3284 # Log the deletion, if the page was suppressed, log it at Oversight instead
3285 $logtype = $suppress ?
'suppress' : 'delete';
3286 $log = new LogPage( $logtype );
3288 # Make sure logging got through
3289 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3299 * Roll back the most recent consecutive set of edits to a page
3300 * from the same user; fails if there are no eligible edits to
3301 * roll back to, e.g. user is the sole contributor. This function
3302 * performs permissions checks on $wgUser, then calls commitRollback()
3303 * to do the dirty work
3305 * @param $fromP String: Name of the user whose edits to rollback.
3306 * @param $summary String: Custom summary. Set to default summary if empty.
3307 * @param $token String: Rollback token.
3308 * @param $bot Boolean: If true, mark all reverted edits as bot.
3310 * @param $resultDetails Array: contains result-specific array of additional values
3311 * 'alreadyrolled' : 'current' (rev)
3312 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3314 * @return array of errors, each error formatted as
3315 * array(messagekey, param1, param2, ...).
3316 * On success, the array is empty. This array can also be passed to
3317 * OutputPage::showPermissionsErrorPage().
3319 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3322 $resultDetails = null;
3325 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3326 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3327 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3329 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3330 $errors[] = array( 'sessionfailure' );
3333 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3334 $errors[] = array( 'actionthrottledtext' );
3337 # If there were errors, bail out now
3338 if ( !empty( $errors ) ) {
3342 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3346 * Backend implementation of doRollback(), please refer there for parameter
3347 * and return value documentation
3349 * NOTE: This function does NOT check ANY permissions, it just commits the
3350 * rollback to the DB Therefore, you should only call this function direct-
3351 * ly if you want to use custom permissions checks. If you don't, use
3352 * doRollback() instead.
3354 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3355 global $wgUseRCPatrol, $wgUser, $wgLang;
3357 $dbw = wfGetDB( DB_MASTER
);
3359 if ( wfReadOnly() ) {
3360 return array( array( 'readonlytext' ) );
3363 # Get the last editor
3364 $current = Revision
::newFromTitle( $this->mTitle
);
3365 if ( is_null( $current ) ) {
3366 # Something wrong... no page?
3367 return array( array( 'notanarticle' ) );
3370 $from = str_replace( '_', ' ', $fromP );
3371 # User name given should match up with the top revision.
3372 # If the user was deleted then $from should be empty.
3373 if ( $from != $current->getUserText() ) {
3374 $resultDetails = array( 'current' => $current );
3375 return array( array( 'alreadyrolled',
3376 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3377 htmlspecialchars( $fromP ),
3378 htmlspecialchars( $current->getUserText() )
3382 # Get the last edit not by this guy...
3383 # Note: these may not be public values
3384 $user = intval( $current->getRawUser() );
3385 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3386 $s = $dbw->selectRow( 'revision',
3387 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3388 array( 'rev_page' => $current->getPage(),
3389 "rev_user != {$user} OR rev_user_text != {$user_text}"
3391 array( 'USE INDEX' => 'page_timestamp',
3392 'ORDER BY' => 'rev_timestamp DESC' )
3394 if ( $s === false ) {
3395 # No one else ever edited this page
3396 return array( array( 'cantrollback' ) );
3397 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3398 # Only admins can see this text
3399 return array( array( 'notvisiblerev' ) );
3403 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3404 # Mark all reverted edits as bot
3408 if ( $wgUseRCPatrol ) {
3409 # Mark all reverted edits as patrolled
3410 $set['rc_patrolled'] = 1;
3413 if ( count( $set ) ) {
3414 $dbw->update( 'recentchanges', $set,
3416 'rc_cur_id' => $current->getPage(),
3417 'rc_user_text' => $current->getUserText(),
3418 "rc_timestamp > '{$s->rev_timestamp}'",
3423 # Generate the edit summary if necessary
3424 $target = Revision
::newFromId( $s->rev_id
);
3425 if ( empty( $summary ) ) {
3426 if ( $from == '' ) { // no public user name
3427 $summary = wfMsgForContent( 'revertpage-nouser' );
3429 $summary = wfMsgForContent( 'revertpage' );
3433 # Allow the custom summary to use the same args as the default message
3435 $target->getUserText(), $from, $s->rev_id
,
3436 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3437 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3439 $summary = wfMsgReplaceArgs( $summary, $args );
3442 $flags = EDIT_UPDATE
;
3444 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3445 $flags |
= EDIT_MINOR
;
3448 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3449 $flags |
= EDIT_FORCE_BOT
;
3452 # Actually store the edit
3453 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3454 if ( !empty( $status->value
['revision'] ) ) {
3455 $revId = $status->value
['revision']->getId();
3460 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3462 $resultDetails = array(
3463 'summary' => $summary,
3464 'current' => $current,
3465 'target' => $target,
3473 * User interface for rollback operations
3475 public function rollback() {
3476 global $wgUser, $wgOut, $wgRequest;
3480 $result = $this->doRollback(
3481 $wgRequest->getVal( 'from' ),
3482 $wgRequest->getText( 'summary' ),
3483 $wgRequest->getVal( 'token' ),
3484 $wgRequest->getBool( 'bot' ),
3488 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3489 $wgOut->rateLimited();
3493 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3494 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3495 $errArray = $result[0];
3496 $errMsg = array_shift( $errArray );
3497 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3499 if ( isset( $details['current'] ) ) {
3500 $current = $details['current'];
3502 if ( $current->getComment() != '' ) {
3503 $wgOut->addWikiMsgArray( 'editcomment', array(
3504 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3511 # Display permissions errors before read-only message -- there's no
3512 # point in misleading the user into thinking the inability to rollback
3513 # is only temporary.
3514 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3515 # array_diff is completely broken for arrays of arrays, sigh.
3516 # Remove any 'readonlytext' error manually.
3518 foreach ( $result as $error ) {
3519 if ( $error != array( 'readonlytext' ) ) {
3523 $wgOut->showPermissionsErrorPage( $out );
3528 if ( $result == array( array( 'readonlytext' ) ) ) {
3529 $wgOut->readOnlyPage();
3534 $current = $details['current'];
3535 $target = $details['target'];
3536 $newId = $details['newid'];
3537 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3538 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3540 if ( $current->getUserText() === '' ) {
3541 $old = wfMsg( 'rev-deleted-user' );
3543 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3544 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3547 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3548 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3549 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3550 $wgOut->returnToMain( false, $this->mTitle
);
3552 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3553 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3554 $de->showDiff( '', '' );
3559 * Do standard deferred updates after page view
3561 public function viewUpdates() {
3562 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3563 if ( wfReadOnly() ) {
3567 # Don't update page view counters on views from bot users (bug 14044)
3568 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3569 Article
::incViewCount( $this->getID() );
3570 $u = new SiteStatsUpdate( 1, 0, 0 );
3571 array_push( $wgDeferredUpdateList, $u );
3574 # Update newtalk / watchlist notification status
3575 $wgUser->clearNotification( $this->mTitle
);
3579 * Prepare text which is about to be saved.
3580 * Returns a stdclass with source, pst and output members
3582 public function prepareTextForEdit( $text, $revid = null ) {
3583 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3585 return $this->mPreparedEdit
;
3590 $edit = (object)array();
3591 $edit->revid
= $revid;
3592 $edit->newText
= $text;
3593 $edit->pst
= $this->preSaveTransform( $text );
3594 $edit->popts
= clone $this->getParserOptions();
3595 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
3596 $edit->oldText
= $this->getContent();
3598 $this->mPreparedEdit
= $edit;
3604 * Do standard deferred updates after page edit.
3605 * Update links tables, site stats, search index and message cache.
3606 * Purges pages that include this page if the text was changed here.
3607 * Every 100th edit, prune the recent changes table.
3610 * @param $text New text of the article
3611 * @param $summary Edit summary
3612 * @param $minoredit Minor edit
3613 * @param $timestamp_of_pagechange Timestamp associated with the page change
3614 * @param $newid rev_id value of the new revision
3615 * @param $changed Whether or not the content actually changed
3617 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3618 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3620 wfProfileIn( __METHOD__
);
3623 # Be careful not to double-PST: $text is usually already PST-ed once
3624 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3625 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3626 $editInfo = $this->prepareTextForEdit( $text, $newid );
3628 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3629 $editInfo = $this->mPreparedEdit
;
3632 # Save it to the parser cache
3633 if ( $wgEnableParserCache ) {
3634 $parserCache = ParserCache
::singleton();
3635 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
3638 # Update the links tables
3639 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3642 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3644 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3645 if ( 0 == mt_rand( 0, 99 ) ) {
3646 // Flush old entries from the `recentchanges` table; we do this on
3647 // random requests so as to avoid an increase in writes for no good reason
3650 $dbw = wfGetDB( DB_MASTER
);
3651 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3652 $recentchanges = $dbw->tableName( 'recentchanges' );
3653 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3655 $dbw->query( $sql );
3659 $id = $this->getID();
3660 $title = $this->mTitle
->getPrefixedDBkey();
3661 $shortTitle = $this->mTitle
->getDBkey();
3664 wfProfileOut( __METHOD__
);
3668 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3669 array_push( $wgDeferredUpdateList, $u );
3670 $u = new SearchUpdate( $id, $title, $text );
3671 array_push( $wgDeferredUpdateList, $u );
3673 # If this is another user's talk page, update newtalk
3674 # Don't do this if $changed = false otherwise some idiot can null-edit a
3675 # load of user talk pages and piss people off, nor if it's a minor edit
3676 # by a properly-flagged bot.
3677 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3678 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3680 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3681 $other = User
::newFromName( $shortTitle, false );
3683 wfDebug( __METHOD__
. ": invalid username\n" );
3684 } elseif ( User
::isIP( $shortTitle ) ) {
3685 // An anonymous user
3686 $other->setNewtalk( true );
3687 } elseif ( $other->isLoggedIn() ) {
3688 $other->setNewtalk( true );
3690 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3695 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3696 $wgMessageCache->replace( $shortTitle, $text );
3699 wfProfileOut( __METHOD__
);
3703 * Perform article updates on a special page creation.
3705 * @param $rev Revision object
3707 * @todo This is a shitty interface function. Kill it and replace the
3708 * other shitty functions like editUpdates and such so it's not needed
3711 public function createUpdates( $rev ) {
3712 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3713 $this->mTotalAdjustment
= 1;
3714 $this->editUpdates( $rev->getText(), $rev->getComment(),
3715 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3719 * Generate the navigation links when browsing through an article revisions
3720 * It shows the information as:
3721 * Revision as of \<date\>; view current revision
3722 * \<- Previous version | Next Version -\>
3724 * @param $oldid String: revision ID of this article revision
3726 public function setOldSubtitle( $oldid = 0 ) {
3727 global $wgLang, $wgOut, $wgUser, $wgRequest;
3729 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3733 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3735 # Cascade unhide param in links for easy deletion browsing
3736 $extraParams = array();
3737 if ( $wgRequest->getVal( 'unhide' ) ) {
3738 $extraParams['unhide'] = 1;
3741 $revision = Revision
::newFromId( $oldid );
3743 $current = ( $oldid == $this->mLatest
);
3744 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3745 $tddate = $wgLang->date( $this->mTimestamp
, true );
3746 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3747 $sk = $wgUser->getSkin();
3749 ?
wfMsgHtml( 'currentrevisionlink' )
3752 wfMsgHtml( 'currentrevisionlink' ),
3755 array( 'known', 'noclasses' )
3758 ?
wfMsgHtml( 'diff' )
3761 wfMsgHtml( 'diff' ),
3767 array( 'known', 'noclasses' )
3769 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3773 wfMsgHtml( 'previousrevision' ),
3776 'direction' => 'prev',
3779 array( 'known', 'noclasses' )
3781 : wfMsgHtml( 'previousrevision' );
3785 wfMsgHtml( 'diff' ),
3791 array( 'known', 'noclasses' )
3793 : wfMsgHtml( 'diff' );
3794 $nextlink = $current
3795 ?
wfMsgHtml( 'nextrevision' )
3798 wfMsgHtml( 'nextrevision' ),
3801 'direction' => 'next',
3804 array( 'known', 'noclasses' )
3806 $nextdiff = $current
3807 ?
wfMsgHtml( 'diff' )
3810 wfMsgHtml( 'diff' ),
3816 array( 'known', 'noclasses' )
3821 // User can delete revisions or view deleted revisions...
3822 $canHide = $wgUser->isAllowed( 'deleterevision' );
3823 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3824 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3825 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3828 'type' => 'revision',
3829 'target' => $this->mTitle
->getPrefixedDbkey(),
3832 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3837 # Show user links if allowed to see them. If hidden, then show them only if requested...
3838 $userlinks = $sk->revUserTools( $revision, !$unhide );
3840 $m = wfMsg( 'revision-info-current' );
3841 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3842 ?
'revision-info-current'
3845 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3848 array( 'parseinline', 'replaceafter' ),
3854 $revision->getUser()
3857 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3858 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3860 $wgOut->setSubtitle( $r );
3864 * This function is called right before saving the wikitext,
3865 * so we can do things like signatures and links-in-context.
3867 * @param $text String article contents
3868 * @return string article contents with altered wikitext markup (signatures
3869 * converted, {{subst:}}, templates, etc.)
3871 public function preSaveTransform( $text ) {
3872 global $wgParser, $wgUser;
3874 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3877 /* Caching functions */
3880 * checkLastModified returns true if it has taken care of all
3881 * output to the client that is necessary for this request.
3882 * (that is, it has sent a cached version of the page)
3884 * @return boolean true if cached version send, false otherwise
3886 protected function tryFileCache() {
3887 static $called = false;
3890 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3895 if ( $this->isFileCacheable() ) {
3896 $cache = new HTMLFileCache( $this->mTitle
);
3897 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3898 wfDebug( "Article::tryFileCache(): about to load file\n" );
3899 $cache->loadFromFileCache();
3902 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3903 ob_start( array( &$cache, 'saveToFileCache' ) );
3906 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3913 * Check if the page can be cached
3916 public function isFileCacheable() {
3919 if ( HTMLFileCache
::useFileCache() ) {
3920 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3921 // Extension may have reason to disable file caching on some pages.
3923 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3931 * Loads page_touched and returns a value indicating if it should be used
3932 * @return boolean true if not a redirect
3934 public function checkTouched() {
3935 if ( !$this->mDataLoaded
) {
3936 $this->loadPageData();
3939 return !$this->mIsRedirect
;
3943 * Get the page_touched field
3944 * @return string containing GMT timestamp
3946 public function getTouched() {
3947 if ( !$this->mDataLoaded
) {
3948 $this->loadPageData();
3951 return $this->mTouched
;
3955 * Get the page_latest field
3956 * @return integer rev_id of current revision
3958 public function getLatest() {
3959 if ( !$this->mDataLoaded
) {
3960 $this->loadPageData();
3963 return (int)$this->mLatest
;
3967 * Edit an article without doing all that other stuff
3968 * The article must already exist; link tables etc
3969 * are not updated, caches are not flushed.
3971 * @param $text String: text submitted
3972 * @param $comment String: comment submitted
3973 * @param $minor Boolean: whereas it's a minor modification
3975 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3976 wfProfileIn( __METHOD__
);
3978 $dbw = wfGetDB( DB_MASTER
);
3979 $revision = new Revision( array(
3980 'page' => $this->getId(),
3982 'comment' => $comment,
3983 'minor_edit' => $minor ?
1 : 0,
3985 $revision->insertOn( $dbw );
3986 $this->updateRevisionOn( $dbw, $revision );
3989 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
3991 wfProfileOut( __METHOD__
);
3995 * Used to increment the view counter
3997 * @param $id Integer: article id
3999 public static function incViewCount( $id ) {
4000 $id = intval( $id );
4002 global $wgHitcounterUpdateFreq;
4004 $dbw = wfGetDB( DB_MASTER
);
4005 $pageTable = $dbw->tableName( 'page' );
4006 $hitcounterTable = $dbw->tableName( 'hitcounter' );
4007 $acchitsTable = $dbw->tableName( 'acchits' );
4008 $dbType = $dbw->getType();
4010 if ( $wgHitcounterUpdateFreq <= 1 ||
$dbType == 'sqlite' ) {
4011 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
4016 # Not important enough to warrant an error page in case of failure
4017 $oldignore = $dbw->ignoreErrors( true );
4019 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
4021 $checkfreq = intval( $wgHitcounterUpdateFreq / 25 +
1 );
4022 if ( ( rand() %
$checkfreq != 0 ) or ( $dbw->lastErrno() != 0 ) ) {
4023 # Most of the time (or on SQL errors), skip row count check
4024 $dbw->ignoreErrors( $oldignore );
4029 $res = $dbw->query( "SELECT COUNT(*) as n FROM $hitcounterTable" );
4030 $row = $dbw->fetchObject( $res );
4031 $rown = intval( $row->n
);
4033 if ( $rown >= $wgHitcounterUpdateFreq ) {
4034 wfProfileIn( 'Article::incViewCount-collect' );
4035 $old_user_abort = ignore_user_abort( true );
4037 $dbw->lockTables( array(), array( 'hitcounter' ), __METHOD__
, false );
4038 $tabletype = $dbType == 'mysql' ?
"ENGINE=HEAP " : '';
4039 $dbw->query( "CREATE TEMPORARY TABLE $acchitsTable $tabletype AS " .
4040 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable " .
4041 'GROUP BY hc_id', __METHOD__
);
4042 $dbw->delete( 'hitcounter', '*', __METHOD__
);
4043 $dbw->unlockTables( __METHOD__
);
4045 if ( $dbType == 'mysql' ) {
4046 $dbw->query( "UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n " .
4047 'WHERE page_id = hc_id', __METHOD__
);
4049 $dbw->query( "UPDATE $pageTable SET page_counter=page_counter + hc_n " .
4050 "FROM $acchitsTable WHERE page_id = hc_id", __METHOD__
);
4052 $dbw->query( "DROP TABLE $acchitsTable", __METHOD__
);
4054 ignore_user_abort( $old_user_abort );
4055 wfProfileOut( 'Article::incViewCount-collect' );
4058 $dbw->ignoreErrors( $oldignore );
4062 * The onArticle*() functions are supposed to be a kind of hooks
4063 * which should be called whenever any of the specified actions
4066 * This is a good place to put code to clear caches, for instance.
4068 * This is called on page move and undelete, as well as edit
4070 * @param $title a title object
4072 public static function onArticleCreate( $title ) {
4073 # Update existence markers on article/talk tabs...
4074 if ( $title->isTalkPage() ) {
4075 $other = $title->getSubjectPage();
4077 $other = $title->getTalkPage();
4080 $other->invalidateCache();
4081 $other->purgeSquid();
4083 $title->touchLinks();
4084 $title->purgeSquid();
4085 $title->deleteTitleProtection();
4089 * Clears caches when article is deleted
4091 public static function onArticleDelete( $title ) {
4092 global $wgMessageCache;
4094 # Update existence markers on article/talk tabs...
4095 if ( $title->isTalkPage() ) {
4096 $other = $title->getSubjectPage();
4098 $other = $title->getTalkPage();
4101 $other->invalidateCache();
4102 $other->purgeSquid();
4104 $title->touchLinks();
4105 $title->purgeSquid();
4108 HTMLFileCache
::clearFileCache( $title );
4111 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4112 $wgMessageCache->replace( $title->getDBkey(), false );
4116 if ( $title->getNamespace() == NS_FILE
) {
4117 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4118 $update->doUpdate();
4122 if ( $title->getNamespace() == NS_USER_TALK
) {
4123 $user = User
::newFromName( $title->getText(), false );
4124 $user->setNewtalk( false );
4128 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4132 * Purge caches on page update etc
4134 * @param $title Title object
4135 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4137 public static function onArticleEdit( $title ) {
4138 global $wgDeferredUpdateList;
4140 // Invalidate caches of articles which include this page
4141 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4143 // Invalidate the caches of all pages which redirect here
4144 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4146 # Purge squid for this page only
4147 $title->purgeSquid();
4149 # Clear file cache for this page only
4150 HTMLFileCache
::clearFileCache( $title );
4156 * Overriden by ImagePage class, only present here to avoid a fatal error
4157 * Called for ?action=revert
4159 public function revert() {
4161 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4165 * Info about this page
4166 * Called for ?action=info when $wgAllowPageInfo is on.
4168 public function info() {
4169 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4171 if ( !$wgAllowPageInfo ) {
4172 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4176 $page = $this->mTitle
->getSubjectPage();
4178 $wgOut->setPagetitle( $page->getPrefixedText() );
4179 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4180 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4182 if ( !$this->mTitle
->exists() ) {
4183 $wgOut->addHTML( '<div class="noarticletext">' );
4184 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4185 // This doesn't quite make sense; the user is asking for
4186 // information about the _page_, not the message... -- RC
4187 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4189 $msg = $wgUser->isLoggedIn()
4191 : 'noarticletextanon';
4192 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4195 $wgOut->addHTML( '</div>' );
4197 $dbr = wfGetDB( DB_SLAVE
);
4199 'wl_title' => $page->getDBkey(),
4200 'wl_namespace' => $page->getNamespace() );
4201 $numwatchers = $dbr->selectField(
4206 $this->getSelectOptions() );
4208 $pageInfo = $this->pageCountInfo( $page );
4209 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4212 //FIXME: unescaped messages
4213 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4214 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4217 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4220 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4223 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4226 $wgOut->addHTML( '</ul>' );
4231 * Return the total number of edits and number of unique editors
4232 * on a given page. If page does not exist, returns false.
4234 * @param $title Title object
4235 * @return mixed array or boolean false
4237 public function pageCountInfo( $title ) {
4238 $id = $title->getArticleId();
4244 $dbr = wfGetDB( DB_SLAVE
);
4245 $rev_clause = array( 'rev_page' => $id );
4246 $edits = $dbr->selectField(
4251 $this->getSelectOptions()
4253 $authors = $dbr->selectField(
4255 'COUNT(DISTINCT rev_user_text)',
4258 $this->getSelectOptions()
4261 return array( 'edits' => $edits, 'authors' => $authors );
4265 * Return a list of templates used by this article.
4266 * Uses the templatelinks table
4268 * @return Array of Title objects
4270 public function getUsedTemplates() {
4272 $id = $this->mTitle
->getArticleID();
4278 $dbr = wfGetDB( DB_SLAVE
);
4279 $res = $dbr->select( array( 'templatelinks' ),
4280 array( 'tl_namespace', 'tl_title' ),
4281 array( 'tl_from' => $id ),
4284 if ( $res !== false ) {
4285 foreach ( $res as $row ) {
4286 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4294 * Returns a list of hidden categories this page is a member of.
4295 * Uses the page_props and categorylinks tables.
4297 * @return Array of Title objects
4299 public function getHiddenCategories() {
4301 $id = $this->mTitle
->getArticleID();
4307 $dbr = wfGetDB( DB_SLAVE
);
4308 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4310 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4311 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4314 if ( $res !== false ) {
4315 foreach ( $res as $row ) {
4316 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4324 * Return an applicable autosummary if one exists for the given edit.
4325 * @param $oldtext String: the previous text of the page.
4326 * @param $newtext String: The submitted text of the page.
4327 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
4328 * @return string An appropriate autosummary, or an empty string.
4330 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4333 # Decide what kind of autosummary is needed.
4335 # Redirect autosummaries
4336 $ot = Title
::newFromRedirect( $oldtext );
4337 $rt = Title
::newFromRedirect( $newtext );
4339 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4340 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4343 # New page autosummaries
4344 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4345 # If they're making a new article, give its text, truncated, in the summary.
4347 $truncatedtext = $wgContLang->truncate(
4348 str_replace( "\n", ' ', $newtext ),
4349 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4351 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4354 # Blanking autosummaries
4355 if ( $oldtext != '' && $newtext == '' ) {
4356 return wfMsgForContent( 'autosumm-blank' );
4357 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4358 # Removing more than 90% of the article
4360 $truncatedtext = $wgContLang->truncate(
4362 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4364 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4367 # If we reach this point, there's no applicable autosummary for our case, so our
4368 # autosummary is empty.
4373 * Add the primary page-view wikitext to the output buffer
4374 * Saves the text into the parser cache if possible.
4375 * Updates templatelinks if it is out of date.
4377 * @param $text String
4378 * @param $cache Boolean
4379 * @param $parserOptions mixed ParserOptions object, or boolean false
4381 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4384 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4385 $wgOut->addParserOutput( $this->mParserOutput
);
4389 * This does all the heavy lifting for outputWikitext, except it returns the parser
4390 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4391 * say, embedding thread pages within a discussion system (LiquidThreads)
4393 * @param $text string
4394 * @param $cache boolean
4395 * @param $parserOptions parsing options, defaults to false
4396 * @return string containing parsed output
4398 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4399 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4401 if ( !$parserOptions ) {
4402 $parserOptions = clone $this->getParserOptions();
4406 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4407 $parserOptions, true, true, $this->getRevIdFetched() );
4412 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4413 $this->mTitle
->getPrefixedDBkey() ) );
4416 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4417 $parserCache = ParserCache
::singleton();
4418 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4421 // Make sure file cache is not used on uncacheable content.
4422 // Output that has magic words in it can still use the parser cache
4423 // (if enabled), though it will generally expire sooner.
4424 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4425 $wgUseFileCache = false;
4428 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4430 return $this->mParserOutput
;
4434 * Get parser options suitable for rendering the primary article wikitext
4435 * @return mixed ParserOptions object or boolean false
4437 public function getParserOptions() {
4440 if ( !$this->mParserOptions
) {
4441 $this->mParserOptions
= new ParserOptions( $wgUser );
4442 $this->mParserOptions
->setTidy( true );
4443 $this->mParserOptions
->enableLimitReport();
4446 // Clone to allow modifications of the return value without affecting
4448 return clone $this->mParserOptions
;
4452 * Updates cascading protections
4454 * @param $parserOutput mixed ParserOptions object, or boolean false
4456 protected function doCascadeProtectionUpdates( $parserOutput ) {
4457 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4461 // templatelinks table may have become out of sync,
4462 // especially if using variable-based transclusions.
4463 // For paranoia, check if things have changed and if
4464 // so apply updates to the database. This will ensure
4465 // that cascaded protections apply as soon as the changes
4468 # Get templates from templatelinks
4469 $id = $this->mTitle
->getArticleID();
4471 $tlTemplates = array();
4473 $dbr = wfGetDB( DB_SLAVE
);
4474 $res = $dbr->select( array( 'templatelinks' ),
4475 array( 'tl_namespace', 'tl_title' ),
4476 array( 'tl_from' => $id ),
4480 foreach ( $res as $row ) {
4481 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4484 # Get templates from parser output.
4485 $poTemplates = array();
4486 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4487 foreach ( $templates as $dbk => $id ) {
4488 $poTemplates["$ns:$dbk"] = true;
4493 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4495 if ( count( $templates_diff ) > 0 ) {
4496 # Whee, link updates time.
4497 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4503 * Update all the appropriate counts in the category table, given that
4504 * we've added the categories $added and deleted the categories $deleted.
4506 * @param $added array The names of categories that were added
4507 * @param $deleted array The names of categories that were deleted
4509 public function updateCategoryCounts( $added, $deleted ) {
4510 $ns = $this->mTitle
->getNamespace();
4511 $dbw = wfGetDB( DB_MASTER
);
4513 # First make sure the rows exist. If one of the "deleted" ones didn't
4514 # exist, we might legitimately not create it, but it's simpler to just
4515 # create it and then give it a negative value, since the value is bogus
4518 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4519 $insertCats = array_merge( $added, $deleted );
4520 if ( !$insertCats ) {
4521 # Okay, nothing to do
4525 $insertRows = array();
4527 foreach ( $insertCats as $cat ) {
4528 $insertRows[] = array(
4529 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4533 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4535 $addFields = array( 'cat_pages = cat_pages + 1' );
4536 $removeFields = array( 'cat_pages = cat_pages - 1' );
4538 if ( $ns == NS_CATEGORY
) {
4539 $addFields[] = 'cat_subcats = cat_subcats + 1';
4540 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4541 } elseif ( $ns == NS_FILE
) {
4542 $addFields[] = 'cat_files = cat_files + 1';
4543 $removeFields[] = 'cat_files = cat_files - 1';
4550 array( 'cat_title' => $added ),
4559 array( 'cat_title' => $deleted ),
4566 * Lightweight method to get the parser output for a page, checking the parser cache
4567 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4568 * consider, so it's not appropriate to use there.
4570 * @since 1.16 (r52326) for LiquidThreads
4572 * @param $oldid mixed integer Revision ID or null
4574 public function getParserOutput( $oldid = null ) {
4575 global $wgEnableParserCache, $wgUser;
4577 // Should the parser cache be used?
4578 $useParserCache = $wgEnableParserCache &&
4579 $wgUser->getStubThreshold() == 0 &&
4583 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4585 if ( $wgUser->getStubThreshold() ) {
4586 wfIncrStats( 'pcache_miss_stub' );
4589 $parserOutput = false;
4590 if ( $useParserCache ) {
4591 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4594 if ( $parserOutput === false ) {
4595 // Cache miss; parse and output it.
4596 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4598 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4600 return $parserOutput;
4604 // Deprecated methods
4606 * Get the database which should be used for reads
4609 * @deprecated - just call wfGetDB( DB_MASTER ) instead
4612 wfDeprecated( __METHOD__
);
4613 return wfGetDB( DB_MASTER
);
4618 class PoolWorkArticleView
extends PoolCounterWork
{
4621 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4622 parent
::__construct( 'ArticleView', $key );
4623 $this->mArticle
= $article;
4624 $this->cacheable
= $useParserCache;
4625 $this->parserOptions
= $parserOptions;
4629 return $this->mArticle
->doViewParse();
4632 function getCachedWork() {
4635 $parserCache = ParserCache
::singleton();
4636 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
4638 if ( $this->mArticle
->mParserOutput
!== false ) {
4639 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
4640 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
4641 # Ensure that UI elements requiring revision ID have
4642 # the correct version information.
4643 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
4649 function fallback() {
4650 return $this->mArticle
->tryDirtyCache();
4653 function error( $status ) {
4656 $wgOut->clearHTML(); // for release() errors
4657 $wgOut->enableClientCache( false );
4658 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4660 $errortext = $status->getWikiText( false, 'view-pool-error' );
4661 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );