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 $mDataLoaded = false; // !<
25 var $mForUpdate = false; // !<
26 var $mGoodAdjustment = 0; // !<
27 var $mIsRedirect = false; // !<
28 var $mLatest = false; // !<
29 var $mMinorEdit; // !<
31 var $mPreparedEdit = false; // !< Title object if set
32 var $mRedirectedFrom = null; // !< Title object if set
33 var $mRedirectTarget = null; // !< Title object if set
34 var $mRedirectUrl = false; // !<
35 var $mRevIdFetched = 0; // !<
36 var $mRevision = null; // !< Revision object if set
37 var $mTimestamp = ''; // !<
38 var $mTitle; // !< Title object
39 var $mTotalAdjustment = 0; // !<
40 var $mTouched = '19700101000000'; // !<
41 var $mUser = -1; // !< Not loaded
42 var $mUserText = ''; // !< username from Revision if set
43 var $mParserOptions; // !< ParserOptions object for $wgUser articles
44 var $mParserOutput; // !< ParserCache object if set
48 * Constructor and clear the article
49 * @param $title Reference to a Title object.
50 * @param $oldId Integer revision ID, null to fetch from request, zero for current
52 public function __construct( Title
$title, $oldId = null ) {
53 // FIXME: does the reference play any role here?
54 $this->mTitle
=& $title;
55 $this->mOldId
= $oldId;
59 * Constructor from an page id
60 * @param $id Int article ID to load
62 public static function newFromID( $id ) {
63 $t = Title
::newFromID( $id );
64 # FIXME: doesn't inherit right
65 return $t == null ?
null : new self( $t );
66 # return $t == null ? null : new static( $t ); // PHP 5.3
70 * Tell the page view functions that this view was redirected
71 * from another page on the wiki.
72 * @param $from Title object.
74 public function setRedirectedFrom( Title
$from ) {
75 $this->mRedirectedFrom
= $from;
79 * If this page is a redirect, get its target
81 * The target will be fetched from the redirect table if possible.
82 * If this page doesn't have an entry there, call insertRedirect()
83 * @return mixed Title object, or null if this page is not a redirect
85 public function getRedirectTarget() {
86 if ( !$this->mTitle
->isRedirect() ) {
90 if ( $this->mRedirectTarget
!== null ) {
91 return $this->mRedirectTarget
;
94 # Query the redirect table
95 $dbr = wfGetDB( DB_SLAVE
);
96 $row = $dbr->selectRow( 'redirect',
97 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
98 array( 'rd_from' => $this->getID() ),
102 // rd_fragment and rd_interwiki were added later, populate them if empty
103 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
104 return $this->mRedirectTarget
= Title
::makeTitle(
105 $row->rd_namespace
, $row->rd_title
,
106 $row->rd_fragment
, $row->rd_interwiki
);
109 # This page doesn't have an entry in the redirect table
110 return $this->mRedirectTarget
= $this->insertRedirect();
114 * Insert an entry for this page into the redirect table.
116 * Don't call this function directly unless you know what you're doing.
117 * @return Title object or null if not a redirect
119 public function insertRedirect() {
120 // recurse through to only get the final target
121 $retval = Title
::newFromRedirectRecurse( $this->getRawText() );
125 $this->insertRedirectEntry( $retval );
130 * Insert or update the redirect table entry for this page to indicate
131 * it redirects to $rt .
132 * @param $rt Title redirect target
134 public function insertRedirectEntry( $rt ) {
135 $dbw = wfGetDB( DB_MASTER
);
136 $dbw->replace( 'redirect', array( 'rd_from' ),
138 'rd_from' => $this->getID(),
139 'rd_namespace' => $rt->getNamespace(),
140 'rd_title' => $rt->getDBkey(),
141 'rd_fragment' => $rt->getFragment(),
142 'rd_interwiki' => $rt->getInterwiki(),
149 * Get the Title object or URL this page redirects to
151 * @return mixed false, Title of in-wiki target, or string with URL
153 public function followRedirect() {
154 return $this->getRedirectURL( $this->getRedirectTarget() );
158 * Get the Title object this text redirects to
160 * @param $text string article content containing redirect info
161 * @return mixed false, Title of in-wiki target, or string with URL
162 * @deprecated @since 1.17
164 public function followRedirectText( $text ) {
165 // recurse through to only get the final target
166 return $this->getRedirectURL( Title
::newFromRedirectRecurse( $text ) );
170 * Get the Title object or URL to use for a redirect. We use Title
171 * objects for same-wiki, non-special redirects and URLs for everything
173 * @param $rt Title Redirect target
174 * @return mixed false, Title object of local target, or string with URL
176 public function getRedirectURL( $rt ) {
178 if ( $rt->getInterwiki() != '' ) {
179 if ( $rt->isLocal() ) {
180 // Offsite wikis need an HTTP redirect.
182 // This can be hard to reverse and may produce loops,
183 // so they may be disabled in the site configuration.
184 $source = $this->mTitle
->getFullURL( 'redirect=no' );
185 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
188 if ( $rt->getNamespace() == NS_SPECIAL
) {
189 // Gotta handle redirects to special pages differently:
190 // Fill the HTTP response "Location" header and ignore
191 // the rest of the page we're on.
193 // This can be hard to reverse, so they may be disabled.
194 if ( $rt->isSpecial( 'Userlogout' ) ) {
197 return $rt->getFullURL();
205 // No or invalid redirect
210 * Get the title object of the article
211 * @return Title object of this page
213 public function getTitle() {
214 return $this->mTitle
;
219 * FIXME: shouldn't this be public?
222 public function clear() {
223 $this->mDataLoaded
= false;
224 $this->mContentLoaded
= false;
226 $this->mUser
= $this->mCounter
= -1; # Not loaded
227 $this->mRedirectedFrom
= null; # Title object if set
228 $this->mRedirectTarget
= null; # Title object if set
230 $this->mTimestamp
= $this->mComment
= '';
231 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
232 $this->mTouched
= '19700101000000';
233 $this->mForUpdate
= false;
234 $this->mIsRedirect
= false;
235 $this->mRevIdFetched
= 0;
236 $this->mRedirectUrl
= false;
237 $this->mLatest
= false;
238 $this->mPreparedEdit
= false;
242 * Note that getContent/loadContent do not follow redirects anymore.
243 * If you need to fetch redirectable content easily, try
244 * the shortcut in Article::followRedirect()
246 * This function has side effects! Do not use this function if you
247 * only want the real revision text if any.
249 * @return Return the text of this revision
251 public function getContent() {
252 global $wgUser, $wgContLang, $wgMessageCache;
254 wfProfileIn( __METHOD__
);
256 if ( $this->getID() === 0 ) {
257 # If this is a MediaWiki:x message, then load the messages
258 # and return the message value for x.
259 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
260 # If this is a system message, get the default text.
261 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
262 $text = wfMsgGetKey( $message, false, $lang, false );
264 if ( wfEmptyMsg( $message, $text ) )
267 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
269 wfProfileOut( __METHOD__
);
273 $this->loadContent();
274 wfProfileOut( __METHOD__
);
276 return $this->mContent
;
281 * Get the text of the current revision. No side-effects...
283 * @return Return the text of the current revision
285 public function getRawText() {
286 // Check process cache for current revision
287 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
288 return $this->mContent
;
291 $rev = Revision
::newFromTitle( $this->mTitle
);
292 $text = $rev ?
$rev->getRawText() : false;
298 * This function returns the text of a section, specified by a number ($section).
299 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
300 * the first section before any such heading (section 0).
302 * If a section contains subsections, these are also returned.
304 * @param $text String: text to look in
305 * @param $section Integer: section number
306 * @return string text of the requested section
309 public function getSection( $text, $section ) {
311 return $wgParser->getSection( $text, $section );
315 * Get the text that needs to be saved in order to undo all revisions
316 * between $undo and $undoafter. Revisions must belong to the same page,
317 * must exist and must not be deleted
318 * @param $undo Revision
319 * @param $undoafter Revision Must be an earlier revision than $undo
320 * @return mixed string on success, false on failure
322 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
323 $currentRev = Revision
::newFromTitle( $this->mTitle
);
324 if ( !$currentRev ) {
325 return false; // no page
327 $undo_text = $undo->getText();
328 $undoafter_text = $undoafter->getText();
329 $cur_text = $currentRev->getText();
331 if ( $cur_text == $undo_text ) {
332 # No use doing a merge if it's just a straight revert.
333 return $undoafter_text;
338 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
346 * @return int The oldid of the article that is to be shown, 0 for the
349 public function getOldID() {
350 if ( is_null( $this->mOldId
) ) {
351 $this->mOldId
= $this->getOldIDFromRequest();
354 return $this->mOldId
;
358 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
360 * @return int The old id for the request
362 public function getOldIDFromRequest() {
365 $this->mRedirectUrl
= false;
367 $oldid = $wgRequest->getVal( 'oldid' );
369 if ( isset( $oldid ) ) {
370 $oldid = intval( $oldid );
371 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
372 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
376 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
378 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
379 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
394 * Load the revision (including text) into this object
396 function loadContent() {
397 if ( $this->mContentLoaded
) {
401 wfProfileIn( __METHOD__
);
403 $this->fetchContent( $this->getOldID() );
405 wfProfileOut( __METHOD__
);
409 * Fetch a page record with the given conditions
410 * @param $dbr Database object
411 * @param $conditions Array
412 * @return mixed Database result resource, or false on failure
414 protected function pageData( $dbr, $conditions ) {
429 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
431 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
433 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
439 * Fetch a page record matching the Title object's namespace and title
440 * using a sanitized title string
442 * @param $dbr Database object
443 * @param $title Title object
444 * @return mixed Database result resource, or false on failure
446 public function pageDataFromTitle( $dbr, $title ) {
447 return $this->pageData( $dbr, array(
448 'page_namespace' => $title->getNamespace(),
449 'page_title' => $title->getDBkey() ) );
453 * Fetch a page record matching the requested ID
455 * @param $dbr Database
458 protected function pageDataFromId( $dbr, $id ) {
459 return $this->pageData( $dbr, array( 'page_id' => $id ) );
463 * Set the general counter, title etc data loaded from
466 * @param $data Database row object or "fromdb"
468 public function loadPageData( $data = 'fromdb' ) {
469 if ( $data === 'fromdb' ) {
470 $dbr = wfGetDB( DB_SLAVE
);
471 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
474 $lc = LinkCache
::singleton();
477 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
, $data->page_latest
);
479 $this->mTitle
->mArticleID
= intval( $data->page_id
);
481 # Old-fashioned restrictions
482 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
484 $this->mCounter
= intval( $data->page_counter
);
485 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
486 $this->mIsRedirect
= intval( $data->page_is_redirect
);
487 $this->mLatest
= intval( $data->page_latest
);
489 $lc->addBadLinkObj( $this->mTitle
);
490 $this->mTitle
->mArticleID
= 0;
493 $this->mDataLoaded
= true;
497 * Get text of an article from database
498 * Does *NOT* follow redirects.
500 * @param $oldid Int: 0 for whatever the latest revision is
501 * @return mixed string containing article contents, or false if null
503 function fetchContent( $oldid = 0 ) {
504 if ( $this->mContentLoaded
) {
505 return $this->mContent
;
508 # Pre-fill content with error message so that if something
509 # fails we'll have something telling us what we intended.
510 $t = $this->mTitle
->getPrefixedText();
511 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
512 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
515 $revision = Revision
::newFromId( $oldid );
516 if ( $revision === null ) {
517 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
521 if ( !$this->mDataLoaded ||
$this->getID() != $revision->getPage() ) {
522 $data = $this->pageDataFromId( wfGetDB( DB_SLAVE
), $revision->getPage() );
525 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
529 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
530 $this->loadPageData( $data );
533 if ( !$this->mDataLoaded
) {
534 $this->loadPageData();
537 if ( $this->mLatest
=== false ) {
538 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
542 $revision = Revision
::newFromId( $this->mLatest
);
543 if ( $revision === null ) {
544 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
549 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
550 // We should instead work with the Revision object when we need it...
551 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
553 if ( $revision->getId() == $this->mLatest
) {
554 $this->setLastEdit( $revision );
557 $this->mRevIdFetched
= $revision->getId();
558 $this->mContentLoaded
= true;
559 $this->mRevision
=& $revision;
561 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
563 return $this->mContent
;
567 * Read/write accessor to select FOR UPDATE
569 * @param $x Mixed: FIXME
570 * @return mixed value of $x, or value stored in Article::mForUpdate
572 public function forUpdate( $x = null ) {
573 return wfSetVar( $this->mForUpdate
, $x );
577 * Get options for all SELECT statements
579 * @param $options Array: an optional options array which'll be appended to
581 * @return Array: options
583 protected function getSelectOptions( $options = '' ) {
584 if ( $this->mForUpdate
) {
585 if ( is_array( $options ) ) {
586 $options[] = 'FOR UPDATE';
588 $options = 'FOR UPDATE';
596 * @return int Page ID
598 public function getID() {
599 return $this->mTitle
->getArticleID();
603 * @return bool Whether or not the page exists in the database
605 public function exists() {
606 return $this->getId() > 0;
610 * Check if this page is something we're going to be showing
611 * some sort of sensible content for. If we return false, page
612 * views (plain action=view) will return an HTTP 404 response,
613 * so spiders and robots can know they're following a bad link.
617 public function hasViewableContent() {
618 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
622 * @return int The view count for the page
624 public function getCount() {
625 if ( -1 == $this->mCounter
) {
626 $id = $this->getID();
631 $dbr = wfGetDB( DB_SLAVE
);
632 $this->mCounter
= $dbr->selectField( 'page',
634 array( 'page_id' => $id ),
636 $this->getSelectOptions()
641 return $this->mCounter
;
645 * Determine whether a page would be suitable for being counted as an
646 * article in the site_stats table based on the title & its content
648 * @param $text String: text to analyze
651 public function isCountable( $text ) {
652 global $wgUseCommaCount;
654 $token = $wgUseCommaCount ?
',' : '[[';
656 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
660 * Tests if the article text represents a redirect
662 * @param $text mixed string containing article contents, or boolean
665 public function isRedirect( $text = false ) {
666 if ( $text === false ) {
667 if ( !$this->mDataLoaded
) {
668 $this->loadPageData();
671 return (bool)$this->mIsRedirect
;
673 return Title
::newFromRedirect( $text ) !== null;
678 * Returns true if the currently-referenced revision is the current edit
679 * to this page (and it exists).
682 public function isCurrent() {
683 # If no oldid, this is the current version.
684 if ( $this->getOldID() == 0 ) {
688 return $this->exists() && $this->mRevision
&& $this->mRevision
->isCurrent();
692 * Loads everything except the text
693 * This isn't necessary for all uses, so it's only done if needed.
695 protected function loadLastEdit() {
696 if ( -1 != $this->mUser
) {
700 # New or non-existent articles have no user information
701 $id = $this->getID();
706 $revision = Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
707 if ( !is_null( $revision ) ) {
708 $this->setLastEdit( $revision );
713 * Set the latest revision
715 protected function setLastEdit( Revision
$revision ) {
716 $this->mLastRevision
= $revision;
717 $this->mUser
= $revision->getUser();
718 $this->mUserText
= $revision->getUserText();
719 $this->mTimestamp
= $revision->getTimestamp();
720 $this->mComment
= $revision->getComment();
721 $this->mMinorEdit
= $revision->isMinor();
725 * @return string GMT timestamp of last article revision
727 public function getTimestamp() {
728 // Check if the field has been filled by ParserCache::get()
729 if ( !$this->mTimestamp
) {
730 $this->loadLastEdit();
733 return wfTimestamp( TS_MW
, $this->mTimestamp
);
737 * @return int user ID for the user that made the last article revision
739 public function getUser() {
740 $this->loadLastEdit();
745 * @return string username of the user that made the last article revision
747 public function getUserText() {
748 $this->loadLastEdit();
749 return $this->mUserText
;
753 * @return string Comment stored for the last article revision
755 public function getComment() {
756 $this->loadLastEdit();
757 return $this->mComment
;
761 * Returns true if last revision was marked as "minor edit"
763 * @return boolean Minor edit indicator for the last article revision.
765 public function getMinorEdit() {
766 $this->loadLastEdit();
767 return $this->mMinorEdit
;
771 * Use this to fetch the rev ID used on page views
773 * @return int revision ID of last article revision
775 public function getRevIdFetched() {
776 if ( $this->mRevIdFetched
) {
777 return $this->mRevIdFetched
;
779 return $this->getLatest();
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 # Allow frames by default
897 $wgOut->allowClickjacking();
899 if ( !$wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
900 $parserOptions->setEditSection( false );
903 # Should the parser cache be used?
904 $useParserCache = $this->useParserCache( $oldid );
905 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
906 if ( $wgUser->getStubThreshold() ) {
907 wfIncrStats( 'pcache_miss_stub' );
910 $wasRedirected = $this->showRedirectedFromHeader();
911 $this->showNamespaceHeader();
913 # Iterate through the possible ways of constructing the output text.
914 # Keep going until $outputDone is set, or we run out of things to do.
917 $this->mParserOutput
= false;
919 while ( !$outputDone && ++
$pass ) {
922 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
925 # Try the parser cache
926 if ( $useParserCache ) {
927 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
929 if ( $this->mParserOutput
!== false ) {
930 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
931 $wgOut->addParserOutput( $this->mParserOutput
);
932 # Ensure that UI elements requiring revision ID have
933 # the correct version information.
934 $wgOut->setRevisionId( $this->mLatest
);
940 $text = $this->getContent();
941 if ( $text === false ||
$this->getID() == 0 ) {
942 wfDebug( __METHOD__
. ": showing missing article\n" );
943 $this->showMissingArticle();
944 wfProfileOut( __METHOD__
);
948 # Another whitelist check in case oldid is altering the title
949 if ( !$this->mTitle
->userCanRead() ) {
950 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
951 $wgOut->loginToUse();
954 wfProfileOut( __METHOD__
);
958 # Are we looking at an old revision
959 if ( $oldid && !is_null( $this->mRevision
) ) {
960 $this->setOldSubtitle( $oldid );
962 if ( !$this->showDeletedRevisionHeader() ) {
963 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
964 wfProfileOut( __METHOD__
);
968 # If this "old" version is the current, then try the parser cache...
969 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
970 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
971 if ( $this->mParserOutput
) {
972 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
973 $wgOut->addParserOutput( $this->mParserOutput
);
974 $wgOut->setRevisionId( $this->mLatest
);
981 # Ensure that UI elements requiring revision ID have
982 # the correct version information.
983 $wgOut->setRevisionId( $this->getRevIdFetched() );
985 # Pages containing custom CSS or JavaScript get special treatment
986 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
987 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
988 $this->showCssOrJsPage();
991 $rt = Title
::newFromRedirectArray( $text );
993 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
994 # Viewing a redirect page (e.g. with parameter redirect=no)
995 # Don't append the subtitle if this was an old revision
996 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
997 # Parse just to get categories, displaytitle, etc.
998 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
999 $wgOut->addParserOutputNoText( $this->mParserOutput
);
1005 # Run the parse, protected by a pool counter
1006 wfDebug( __METHOD__
. ": doing uncached parse\n" );
1008 $key = $parserCache->getKey( $this, $parserOptions );
1009 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
1011 if ( !$poolArticleView->execute() ) {
1012 # Connection or timeout error
1013 wfProfileOut( __METHOD__
);
1019 # Should be unreachable, but just in case...
1025 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1026 if ( $this->mParserOutput
) {
1027 $titleText = $this->mParserOutput
->getTitleText();
1029 if ( strval( $titleText ) !== '' ) {
1030 $wgOut->setPageTitle( $titleText );
1034 # For the main page, overwrite the <title> element with the con-
1035 # tents of 'pagetitle-view-mainpage' instead of the default (if
1036 # that's not empty).
1037 # This message always exists because it is in the i18n files
1038 if ( $this->mTitle
->equals( Title
::newMainPage() )
1039 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1041 $wgOut->setHTMLTitle( $m );
1044 # Now that we've filled $this->mParserOutput, we know whether
1045 # there are any __NOINDEX__ tags on the page
1046 $policy = $this->getRobotPolicy( 'view' );
1047 $wgOut->setIndexPolicy( $policy['index'] );
1048 $wgOut->setFollowPolicy( $policy['follow'] );
1050 $this->showViewFooter();
1051 $this->viewUpdates();
1052 wfProfileOut( __METHOD__
);
1056 * Show a diff page according to current request variables. For use within
1057 * Article::view() only, other callers should use the DifferenceEngine class.
1059 public function showDiffPage() {
1060 global $wgRequest, $wgUser;
1062 $diff = $wgRequest->getVal( 'diff' );
1063 $rcid = $wgRequest->getVal( 'rcid' );
1064 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1065 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1066 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1067 $oldid = $this->getOldID();
1069 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1070 // DifferenceEngine directly fetched the revision:
1071 $this->mRevIdFetched
= $de->mNewid
;
1072 $de->showDiffPage( $diffOnly );
1074 // Needed to get the page's current revision
1075 $this->loadPageData();
1076 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1077 # Run view updates for current revision only
1078 $this->viewUpdates();
1083 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1084 * Article::view() only.
1086 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1089 protected function showCssOrJsPage() {
1092 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1094 // Give hooks a chance to customise the output
1095 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1096 // Wrap the whole lot in a <pre> and don't parse
1098 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1099 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1100 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1101 $wgOut->addHTML( "\n</pre>\n" );
1106 * Get the robot policy to be used for the current view
1107 * @param $action String the action= GET parameter
1108 * @return Array the policy that should be set
1109 * TODO: actions other than 'view'
1111 public function getRobotPolicy( $action ) {
1112 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1113 global $wgDefaultRobotPolicy, $wgRequest;
1115 $ns = $this->mTitle
->getNamespace();
1117 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1118 # Don't index user and user talk pages for blocked users (bug 11443)
1119 if ( !$this->mTitle
->isSubpage() ) {
1120 $block = new Block();
1121 if ( $block->load( $this->mTitle
->getText() ) ) {
1123 'index' => 'noindex',
1124 'follow' => 'nofollow'
1130 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1131 # Non-articles (special pages etc), and old revisions
1133 'index' => 'noindex',
1134 'follow' => 'nofollow'
1136 } elseif ( $wgOut->isPrintable() ) {
1137 # Discourage indexing of printable versions, but encourage following
1139 'index' => 'noindex',
1140 'follow' => 'follow'
1142 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1143 # For ?curid=x urls, disallow indexing
1145 'index' => 'noindex',
1146 'follow' => 'follow'
1150 # Otherwise, construct the policy based on the various config variables.
1151 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1153 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1154 # Honour customised robot policies for this namespace
1155 $policy = array_merge(
1157 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1160 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1161 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1162 # a final sanity check that we have really got the parser output.
1163 $policy = array_merge(
1165 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1169 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1170 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1171 $policy = array_merge(
1173 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1181 * Converts a String robot policy into an associative array, to allow
1182 * merging of several policies using array_merge().
1183 * @param $policy Mixed, returns empty array on null/false/'', transparent
1184 * to already-converted arrays, converts String.
1185 * @return Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1187 public static function formatRobotPolicy( $policy ) {
1188 if ( is_array( $policy ) ) {
1190 } elseif ( !$policy ) {
1194 $policy = explode( ',', $policy );
1195 $policy = array_map( 'trim', $policy );
1198 foreach ( $policy as $var ) {
1199 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1200 $arr['index'] = $var;
1201 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1202 $arr['follow'] = $var;
1210 * If this request is a redirect view, send "redirected from" subtitle to
1211 * $wgOut. Returns true if the header was needed, false if this is not a
1212 * redirect view. Handles both local and remote redirects.
1216 public function showRedirectedFromHeader() {
1217 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1219 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1220 $sk = $wgUser->getSkin();
1222 if ( isset( $this->mRedirectedFrom
) ) {
1223 // This is an internally redirected page view.
1224 // We'll need a backlink to the source page for navigation.
1225 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1227 $this->mRedirectedFrom
,
1230 array( 'redirect' => 'no' ),
1231 array( 'known', 'noclasses' )
1234 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1235 $wgOut->setSubtitle( $s );
1237 // Set the fragment if one was specified in the redirect
1238 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1239 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1240 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1243 // Add a <link rel="canonical"> tag
1244 $wgOut->addLink( array( 'rel' => 'canonical',
1245 'href' => $this->mTitle
->getLocalURL() )
1250 } elseif ( $rdfrom ) {
1251 // This is an externally redirected view, from some other wiki.
1252 // If it was reported from a trusted site, supply a backlink.
1253 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1254 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1255 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1256 $wgOut->setSubtitle( $s );
1266 * Show a header specific to the namespace currently being viewed, like
1267 * [[MediaWiki:Talkpagetext]]. For Article::view().
1269 public function showNamespaceHeader() {
1272 if ( $this->mTitle
->isTalkPage() ) {
1273 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1274 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1280 * Show the footer section of an ordinary page view
1282 public function showViewFooter() {
1283 global $wgOut, $wgUseTrackbacks;
1285 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1286 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1287 $wgOut->addWikiMsg( 'anontalkpagetext' );
1290 # If we have been passed an &rcid= parameter, we want to give the user a
1291 # chance to mark this new article as patrolled.
1292 $this->showPatrolFooter();
1295 if ( $wgUseTrackbacks ) {
1296 $this->addTrackbacks();
1299 wfRunHooks( 'ArticleViewFooter', array( $this ) );
1304 * If patrol is possible, output a patrol UI box. This is called from the
1305 * footer section of ordinary page views. If patrol is not possible or not
1306 * desired, does nothing.
1308 public function showPatrolFooter() {
1309 global $wgOut, $wgRequest, $wgUser;
1311 $rcid = $wgRequest->getVal( 'rcid' );
1313 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1317 $sk = $wgUser->getSkin();
1318 $token = $wgUser->editToken( $rcid );
1319 $wgOut->preventClickjacking();
1322 "<div class='patrollink'>" .
1324 'markaspatrolledlink',
1327 wfMsgHtml( 'markaspatrolledtext' ),
1330 'action' => 'markpatrolled',
1334 array( 'known', 'noclasses' )
1342 * Show the error text for a missing article. For articles in the MediaWiki
1343 * namespace, show the default message text. To be called from Article::view().
1345 public function showMissingArticle() {
1346 global $wgOut, $wgRequest, $wgUser;
1348 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1349 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1350 $parts = explode( '/', $this->mTitle
->getText() );
1351 $rootPart = $parts[0];
1352 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1353 $ip = User
::isIP( $rootPart );
1355 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1356 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1357 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1358 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1359 LogEventsList
::showLogExtract(
1362 $user->getUserPage()->getPrefixedText(),
1366 'showIfEmpty' => false,
1368 'blocked-notice-logextract',
1369 $user->getName() # Support GENDER in notice
1376 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1378 # Show delete and move logs
1379 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1381 'conds' => array( "log_action != 'revision'" ),
1382 'showIfEmpty' => false,
1383 'msgKey' => array( 'moveddeleted-notice' ) )
1386 # Show error message
1387 $oldid = $this->getOldID();
1389 $text = wfMsgNoTrans( 'missing-article',
1390 $this->mTitle
->getPrefixedText(),
1391 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1392 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1393 // Use the default message text
1394 $text = $this->getContent();
1396 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1397 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1398 $errors = array_merge( $createErrors, $editErrors );
1400 if ( !count( $errors ) ) {
1401 $text = wfMsgNoTrans( 'noarticletext' );
1403 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1406 $text = "<div class='noarticletext'>\n$text\n</div>";
1408 if ( !$this->hasViewableContent() ) {
1409 // If there's no backing content, send a 404 Not Found
1410 // for better machine handling of broken links.
1411 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1414 $wgOut->addWikiText( $text );
1418 * If the revision requested for view is deleted, check permissions.
1419 * Send either an error message or a warning header to $wgOut.
1421 * @return boolean true if the view is allowed, false if not.
1423 public function showDeletedRevisionHeader() {
1424 global $wgOut, $wgRequest;
1426 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1431 // If the user is not allowed to see it...
1432 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1433 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1434 'rev-deleted-text-permission' );
1437 // If the user needs to confirm that they want to see it...
1438 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1439 # Give explanation and add a link to view the revision...
1440 $oldid = intval( $this->getOldID() );
1441 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1442 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1443 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1444 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1445 array( $msg, $link ) );
1448 // We are allowed to see...
1450 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1451 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1452 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1459 * Should the parser cache be used?
1463 public function useParserCache( $oldid ) {
1464 global $wgUser, $wgEnableParserCache;
1466 return $wgEnableParserCache
1467 && $wgUser->getStubThreshold() == 0
1470 && !$this->mTitle
->isCssOrJsPage()
1471 && !$this->mTitle
->isCssJsSubpage();
1475 * Execute the uncached parse for action=view
1477 public function doViewParse() {
1480 $oldid = $this->getOldID();
1481 $parserOptions = $this->getParserOptions();
1483 # Render printable version, use printable version cache
1484 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1486 # Don't show section-edit links on old revisions... this way lies madness.
1487 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ||
!$this->mTitle
->quickUserCan( 'edit' ) ) {
1488 $parserOptions->setEditSection( false );
1491 $useParserCache = $this->useParserCache( $oldid );
1492 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1498 * Try to fetch an expired entry from the parser cache. If it is present,
1499 * output it and return true. If it is not present, output nothing and
1500 * return false. This is used as a callback function for
1501 * PoolCounter::executeProtected().
1505 public function tryDirtyCache() {
1507 $parserCache = ParserCache
::singleton();
1508 $options = $this->getParserOptions();
1510 if ( $wgOut->isPrintable() ) {
1511 $options->setIsPrintable( true );
1512 $options->setEditSection( false );
1515 $output = $parserCache->getDirty( $this, $options );
1518 wfDebug( __METHOD__
. ": sending dirty output\n" );
1519 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1520 $wgOut->setSquidMaxage( 0 );
1521 $this->mParserOutput
= $output;
1522 $wgOut->addParserOutput( $output );
1523 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1527 wfDebugLog( 'dirty', "dirty missing\n" );
1528 wfDebug( __METHOD__
. ": no dirty cache\n" );
1537 * @param $target Title|Array of destination(s) to redirect
1538 * @param $appendSubtitle Boolean [optional]
1539 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1540 * @return string containing HMTL with redirect link
1542 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1543 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1545 if ( !is_array( $target ) ) {
1546 $target = array( $target );
1549 $imageDir = $wgContLang->getDir();
1551 if ( $appendSubtitle ) {
1552 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1555 $sk = $wgUser->getSkin();
1556 // the loop prepends the arrow image before the link, so the first case needs to be outside
1557 $title = array_shift( $target );
1559 if ( $forceKnown ) {
1560 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1562 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1565 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1566 $alt = $wgContLang->isRTL() ?
'←' : '→';
1567 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1568 // FIXME: where this happens?
1569 foreach ( $target as $rt ) {
1570 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1571 if ( $forceKnown ) {
1572 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1574 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1578 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1579 return '<div class="redirectMsg">' .
1580 Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1581 '<span class="redirectText">' . $link . '</span></div>';
1585 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1587 public function addTrackbacks() {
1588 global $wgOut, $wgUser;
1590 $dbr = wfGetDB( DB_SLAVE
);
1591 $tbs = $dbr->select( 'trackbacks',
1592 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1593 array( 'tb_page' => $this->getID() )
1596 if ( !$dbr->numRows( $tbs ) ) {
1600 $wgOut->preventClickjacking();
1603 foreach ( $tbs as $o ) {
1606 if ( $wgUser->isAllowed( 'trackback' ) ) {
1607 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1608 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1609 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1613 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1621 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1625 * Removes trackback record for current article from trackbacks table
1627 public function deletetrackback() {
1628 global $wgUser, $wgRequest, $wgOut;
1630 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1631 $wgOut->addWikiMsg( 'sessionfailure' );
1636 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1638 if ( count( $permission_errors ) ) {
1639 $wgOut->showPermissionsErrorPage( $permission_errors );
1644 $db = wfGetDB( DB_MASTER
);
1645 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1647 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1648 $this->mTitle
->invalidateCache();
1652 * Handle action=render
1655 public function render() {
1658 $wgOut->setArticleBodyOnly( true );
1663 * Handle action=purge
1665 public function purge() {
1666 global $wgUser, $wgRequest, $wgOut;
1668 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1669 //FIXME: shouldn't this be in doPurge()?
1670 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1675 $formParams = array(
1677 'action' => $wgRequest->getRequestURL(),
1680 $wgOut->addWikiMsg( 'confirm-purge-top' );
1682 $form = Html
::openElement( 'form', $formParams );
1683 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1684 $form .= Html
::closeElement( 'form' );
1686 $wgOut->addHTML( $form );
1687 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1689 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1690 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1695 * Perform the actions of a page purging
1697 public function doPurge() {
1700 // Invalidate the cache
1701 $this->mTitle
->invalidateCache();
1704 if ( $wgUseSquid ) {
1705 // Commit the transaction before the purge is sent
1706 $dbw = wfGetDB( DB_MASTER
);
1710 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1711 $update->doUpdate();
1714 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1715 global $wgMessageCache;
1717 if ( $this->getID() == 0 ) {
1720 $text = $this->getRawText();
1723 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1728 * Insert a new empty page record for this article.
1729 * This *must* be followed up by creating a revision
1730 * and running $this->updateRevisionOn( ... );
1731 * or else the record will be left in a funky state.
1732 * Best if all done inside a transaction.
1734 * @param $dbw Database
1735 * @return int The newly created page_id key, or false if the title already existed
1738 public function insertOn( $dbw ) {
1739 wfProfileIn( __METHOD__
);
1741 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1742 $dbw->insert( 'page', array(
1743 'page_id' => $page_id,
1744 'page_namespace' => $this->mTitle
->getNamespace(),
1745 'page_title' => $this->mTitle
->getDBkey(),
1746 'page_counter' => 0,
1747 'page_restrictions' => '',
1748 'page_is_redirect' => 0, # Will set this shortly...
1750 'page_random' => wfRandom(),
1751 'page_touched' => $dbw->timestamp(),
1752 'page_latest' => 0, # Fill this in shortly...
1753 'page_len' => 0, # Fill this in shortly...
1754 ), __METHOD__
, 'IGNORE' );
1756 $affected = $dbw->affectedRows();
1759 $newid = $dbw->insertId();
1760 $this->mTitle
->resetArticleId( $newid );
1762 wfProfileOut( __METHOD__
);
1764 return $affected ?
$newid : false;
1768 * Update the page record to point to a newly saved revision.
1770 * @param $dbw DatabaseBase: object
1771 * @param $revision Revision: For ID number, and text used to set
1772 length and redirect status fields
1773 * @param $lastRevision Integer: if given, will not overwrite the page field
1774 * when different from the currently set value.
1775 * Giving 0 indicates the new page flag should be set
1777 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1778 * removing rows in redirect table.
1779 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1780 * Needed when $lastRevision has to be set to sth. !=0
1781 * @return bool true on success, false on failure
1784 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1785 wfProfileIn( __METHOD__
);
1787 $text = $revision->getText();
1788 $rt = Title
::newFromRedirectRecurse( $text );
1790 $conditions = array( 'page_id' => $this->getId() );
1792 if ( !is_null( $lastRevision ) ) {
1793 # An extra check against threads stepping on each other
1794 $conditions['page_latest'] = $lastRevision;
1797 if ( !$setNewFlag ) {
1798 $setNewFlag = ( $lastRevision === 0 );
1801 $dbw->update( 'page',
1803 'page_latest' => $revision->getId(),
1804 'page_touched' => $dbw->timestamp(),
1805 'page_is_new' => $setNewFlag,
1806 'page_is_redirect' => $rt !== null ?
1 : 0,
1807 'page_len' => strlen( $text ),
1812 $result = $dbw->affectedRows() != 0;
1814 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1817 wfProfileOut( __METHOD__
);
1822 * Add row to the redirect table if this is a redirect, remove otherwise.
1824 * @param $dbw Database
1825 * @param $redirectTitle Title object pointing to the redirect target,
1826 * or NULL if this is not a redirect
1827 * @param $lastRevIsRedirect If given, will optimize adding and
1828 * removing rows in redirect table.
1829 * @return bool true on success, false on failure
1832 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1833 // Always update redirects (target link might have changed)
1834 // Update/Insert if we don't know if the last revision was a redirect or not
1835 // Delete if changing from redirect to non-redirect
1836 $isRedirect = !is_null( $redirectTitle );
1838 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1839 wfProfileIn( __METHOD__
);
1840 if ( $isRedirect ) {
1841 $this->insertRedirectEntry( $redirectTitle );
1843 // This is not a redirect, remove row from redirect table
1844 $where = array( 'rd_from' => $this->getId() );
1845 $dbw->delete( 'redirect', $where, __METHOD__
);
1848 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1849 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1851 wfProfileOut( __METHOD__
);
1853 return ( $dbw->affectedRows() != 0 );
1860 * If the given revision is newer than the currently set page_latest,
1861 * update the page record. Otherwise, do nothing.
1863 * @param $dbw Database object
1864 * @param $revision Revision object
1867 public function updateIfNewerOn( &$dbw, $revision ) {
1868 wfProfileIn( __METHOD__
);
1870 $row = $dbw->selectRow(
1871 array( 'revision', 'page' ),
1872 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1874 'page_id' => $this->getId(),
1875 'page_latest=rev_id' ),
1879 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1880 wfProfileOut( __METHOD__
);
1883 $prev = $row->rev_id
;
1884 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1886 # No or missing previous revision; mark the page as new
1888 $lastRevIsRedirect = null;
1891 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1893 wfProfileOut( __METHOD__
);
1898 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1899 * @param $text String: new text of the section
1900 * @param $summary String: new section's subject, only if $section is 'new'
1901 * @param $edittime String: revision timestamp or null to use the current revision
1902 * @return string Complete article text, or null if error
1904 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1905 wfProfileIn( __METHOD__
);
1907 if ( strval( $section ) == '' ) {
1908 // Whole-page edit; let the whole text through
1910 if ( is_null( $edittime ) ) {
1911 $rev = Revision
::newFromTitle( $this->mTitle
);
1913 $dbw = wfGetDB( DB_MASTER
);
1914 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1918 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1919 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1923 $oldtext = $rev->getText();
1925 if ( $section == 'new' ) {
1926 # Inserting a new section
1927 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1928 $text = strlen( trim( $oldtext ) ) > 0
1929 ?
"{$oldtext}\n\n{$subject}{$text}"
1930 : "{$subject}{$text}";
1932 # Replacing an existing section; roll out the big guns
1935 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1939 wfProfileOut( __METHOD__
);
1944 * This function is not deprecated until somebody fixes the core not to use
1945 * it. Nevertheless, use Article::doEdit() instead.
1946 * @deprecated @since 1.7
1948 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1949 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1950 ( $isminor ? EDIT_MINOR
: 0 ) |
1951 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1952 ( $bot ? EDIT_FORCE_BOT
: 0 );
1954 # If this is a comment, add the summary as headline
1955 if ( $comment && $summary != "" ) {
1956 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1958 $this->doEdit( $text, $summary, $flags );
1960 $dbw = wfGetDB( DB_MASTER
);
1962 if ( !$this->mTitle
->userIsWatching() ) {
1968 if ( $this->mTitle
->userIsWatching() ) {
1974 $this->doRedirect( $this->isRedirect( $text ) );
1978 * @deprecated @since 1.7 use Article::doEdit()
1980 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1981 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1982 ( $minor ? EDIT_MINOR
: 0 ) |
1983 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1985 $status = $this->doEdit( $text, $summary, $flags );
1987 if ( !$status->isOK() ) {
1991 $dbw = wfGetDB( DB_MASTER
);
1993 if ( !$this->mTitle
->userIsWatching() ) {
1999 if ( $this->mTitle
->userIsWatching() ) {
2006 $extraQuery = ''; // Give extensions a chance to modify URL query on update
2007 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2009 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2014 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2016 * @return Int updated $flags
2018 function checkFlags( $flags ) {
2019 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
2020 if ( $this->mTitle
->getArticleID() ) {
2021 $flags |
= EDIT_UPDATE
;
2033 * Change an existing article or create a new article. Updates RC and all necessary caches,
2034 * optionally via the deferred update array.
2036 * $wgUser must be set before calling this function.
2038 * @param $text String: new text
2039 * @param $summary String: edit summary
2040 * @param $flags Integer bitfield:
2042 * Article is known or assumed to be non-existent, create a new one
2044 * Article is known or assumed to be pre-existing, update it
2046 * Mark this edit minor, if the user is allowed to do so
2048 * Do not log the change in recentchanges
2050 * Mark the edit a "bot" edit regardless of user rights
2051 * EDIT_DEFER_UPDATES
2052 * Defer some of the updates until the end of index.php
2054 * Fill in blank summaries with generated text where possible
2056 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2057 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2058 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2059 * edit-already-exists error will be returned. These two conditions are also possible with
2060 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2062 * @param $baseRevId the revision ID this edit was based off, if any
2063 * @param $user User (optional), $wgUser will be used if not passed
2065 * @return Status object. Possible errors:
2066 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2067 * edit-gone-missing: In update mode, but the article didn't exist
2068 * edit-conflict: In update mode, the article changed unexpectedly
2069 * edit-no-change: Warning that the text was the same as before
2070 * edit-already-exists: In creation mode, but the article already exists
2072 * Extensions may define additional errors.
2074 * $return->value will contain an associative array with members as follows:
2075 * new: Boolean indicating if the function attempted to create a new article
2076 * revision: The revision object for the inserted revision, or null
2078 * Compatibility note: this function previously returned a boolean value indicating success/failure
2080 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2081 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2083 # Low-level sanity check
2084 if ( $this->mTitle
->getText() === '' ) {
2085 throw new MWException( 'Something is trying to edit an article with an empty title' );
2088 wfProfileIn( __METHOD__
);
2090 $user = is_null( $user ) ?
$wgUser : $user;
2091 $status = Status
::newGood( array() );
2093 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2094 $this->loadPageData();
2096 $flags = $this->checkFlags( $flags );
2098 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2099 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
2101 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2102 wfProfileOut( __METHOD__
);
2104 if ( $status->isOK() ) {
2105 $status->fatal( 'edit-hook-aborted' );
2111 # Silently ignore EDIT_MINOR if not allowed
2112 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2113 $bot = $flags & EDIT_FORCE_BOT
;
2115 $oldtext = $this->getRawText(); // current revision
2116 $oldsize = strlen( $oldtext );
2118 # Provide autosummaries if one is not provided and autosummaries are enabled.
2119 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2120 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2123 $editInfo = $this->prepareTextForEdit( $text, null, $user );
2124 $text = $editInfo->pst
;
2125 $newsize = strlen( $text );
2127 $dbw = wfGetDB( DB_MASTER
);
2128 $now = wfTimestampNow();
2129 $this->mTimestamp
= $now;
2131 if ( $flags & EDIT_UPDATE
) {
2132 # Update article, but only if changed.
2133 $status->value
['new'] = false;
2135 # Make sure the revision is either completely inserted or not inserted at all
2136 if ( !$wgDBtransactions ) {
2137 $userAbort = ignore_user_abort( true );
2140 $changed = ( strcmp( $text, $oldtext ) != 0 );
2143 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2144 - (int)$this->isCountable( $oldtext );
2145 $this->mTotalAdjustment
= 0;
2147 if ( !$this->mLatest
) {
2148 # Article gone missing
2149 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2150 $status->fatal( 'edit-gone-missing' );
2152 wfProfileOut( __METHOD__
);
2156 $revision = new Revision( array(
2157 'page' => $this->getId(),
2158 'comment' => $summary,
2159 'minor_edit' => $isminor,
2161 'parent_id' => $this->mLatest
,
2162 'user' => $user->getId(),
2163 'user_text' => $user->getName(),
2168 $revisionId = $revision->insertOn( $dbw );
2172 # Note that we use $this->mLatest instead of fetching a value from the master DB
2173 # during the course of this function. This makes sure that EditPage can detect
2174 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2175 # before this function is called. A previous function used a separate query, this
2176 # creates a window where concurrent edits can cause an ignored edit conflict.
2177 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2180 /* Belated edit conflict! Run away!! */
2181 $status->fatal( 'edit-conflict' );
2183 # Delete the invalid revision if the DB is not transactional
2184 if ( !$wgDBtransactions ) {
2185 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2191 global $wgUseRCPatrol;
2192 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2193 # Update recentchanges
2194 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2195 # Mark as patrolled if the user can do so
2196 $patrolled = $wgUseRCPatrol && !count(
2197 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2198 # Add RC row to the DB
2199 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2200 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2201 $revisionId, $patrolled
2204 # Log auto-patrolled edits
2206 PatrolLog
::record( $rc, true );
2209 $user->incEditCount();
2213 $status->warning( 'edit-no-change' );
2215 // Keep the same revision ID, but do some updates on it
2216 $revisionId = $this->getLatest();
2217 // Update page_touched, this is usually implicit in the page update
2218 // Other cache updates are done in onArticleEdit()
2219 $this->mTitle
->invalidateCache();
2222 if ( !$wgDBtransactions ) {
2223 ignore_user_abort( $userAbort );
2226 // Now that ignore_user_abort is restored, we can respond to fatal errors
2227 if ( !$status->isOK() ) {
2228 wfProfileOut( __METHOD__
);
2232 # Invalidate cache of this article and all pages using this article
2233 # as a template. Partly deferred.
2234 Article
::onArticleEdit( $this->mTitle
);
2235 # Update links tables, site stats, etc.
2236 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed, $user );
2238 # Create new article
2239 $status->value
['new'] = true;
2241 # Set statistics members
2242 # We work out if it's countable after PST to avoid counter drift
2243 # when articles are created with {{subst:}}
2244 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2245 $this->mTotalAdjustment
= 1;
2249 # Add the page record; stake our claim on this title!
2250 # This will return false if the article already exists
2251 $newid = $this->insertOn( $dbw );
2253 if ( $newid === false ) {
2255 $status->fatal( 'edit-already-exists' );
2257 wfProfileOut( __METHOD__
);
2261 # Save the revision text...
2262 $revision = new Revision( array(
2264 'comment' => $summary,
2265 'minor_edit' => $isminor,
2267 'user' => $user->getId(),
2268 'user_text' => $user->getName(),
2271 $revisionId = $revision->insertOn( $dbw );
2273 $this->mTitle
->resetArticleID( $newid );
2275 # Update the page record with revision data
2276 $this->updateRevisionOn( $dbw, $revision, 0 );
2278 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2280 # Update recentchanges
2281 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2282 global $wgUseRCPatrol, $wgUseNPPatrol;
2284 # Mark as patrolled if the user can do so
2285 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
2286 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2287 # Add RC row to the DB
2288 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2289 '', strlen( $text ), $revisionId, $patrolled );
2291 # Log auto-patrolled edits
2293 PatrolLog
::record( $rc, true );
2296 $user->incEditCount();
2299 # Update links, etc.
2300 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true, $user );
2303 Article
::onArticleCreate( $this->mTitle
);
2305 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2306 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2309 # Do updates right now unless deferral was requested
2310 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2314 // Return the new revision (or null) to the caller
2315 $status->value
['revision'] = $revision;
2317 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2318 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2320 wfProfileOut( __METHOD__
);
2325 * Output a redirect back to the article.
2326 * This is typically used after an edit.
2328 * @param $noRedir Boolean: add redirect=no
2329 * @param $sectionAnchor String: section to redirect to, including "#"
2330 * @param $extraQuery String: extra query params
2332 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2336 $query = 'redirect=no';
2338 $query .= "&$extraQuery";
2340 $query = $extraQuery;
2343 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2347 * Mark this particular edit/page as patrolled
2349 public function markpatrolled() {
2350 global $wgOut, $wgUser, $wgRequest;
2352 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2354 # If we haven't been given an rc_id value, we can't do anything
2355 $rcid = (int) $wgRequest->getVal( 'rcid' );
2357 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2358 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2362 $rc = RecentChange
::newFromId( $rcid );
2364 if ( is_null( $rc ) ) {
2365 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2369 # It would be nice to see where the user had actually come from, but for now just guess
2370 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2371 $return = SpecialPage
::getTitleFor( $returnto );
2373 $errors = $rc->doMarkPatrolled();
2375 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2376 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2381 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2382 // The hook itself has handled any output
2386 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2387 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2388 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2389 $wgOut->returnToMain( false, $return );
2394 if ( !empty( $errors ) ) {
2395 $wgOut->showPermissionsErrorPage( $errors );
2401 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2402 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2403 $wgOut->returnToMain( false, $return );
2407 * User-interface handler for the "watch" action
2409 public function watch() {
2410 global $wgUser, $wgOut;
2412 if ( $wgUser->isAnon() ) {
2413 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2417 if ( wfReadOnly() ) {
2418 $wgOut->readOnlyPage();
2422 if ( $this->doWatch() ) {
2423 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2424 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2425 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2428 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2432 * Add this page to $wgUser's watchlist
2433 * @return bool true on successful watch operation
2435 public function doWatch() {
2438 if ( $wgUser->isAnon() ) {
2442 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2443 $wgUser->addWatch( $this->mTitle
);
2444 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2451 * User interface handler for the "unwatch" action.
2453 public function unwatch() {
2454 global $wgUser, $wgOut;
2456 if ( $wgUser->isAnon() ) {
2457 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2461 if ( wfReadOnly() ) {
2462 $wgOut->readOnlyPage();
2466 if ( $this->doUnwatch() ) {
2467 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2468 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2469 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2472 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2476 * Stop watching a page
2477 * @return bool true on successful unwatch
2479 public function doUnwatch() {
2482 if ( $wgUser->isAnon() ) {
2486 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2487 $wgUser->removeWatch( $this->mTitle
);
2488 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2495 * action=protect handler
2497 public function protect() {
2498 $form = new ProtectionForm( $this );
2503 * action=unprotect handler (alias)
2505 public function unprotect() {
2510 * Update the article's restriction field, and leave a log entry.
2512 * @param $limit Array: set of restriction keys
2513 * @param $reason String
2514 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2515 * @param $expiry Array: per restriction type expiration
2516 * @return bool true on success
2518 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2519 global $wgUser, $wgContLang;
2521 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2523 $id = $this->mTitle
->getArticleID();
2526 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
2530 if ( wfReadOnly() ) {
2531 wfDebug( "updateRestrictions failed: read-only\n" );
2535 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2536 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2544 // Take this opportunity to purge out expired restrictions
2545 Title
::purgeExpiredRestrictions();
2547 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2548 # we expect a single selection, but the schema allows otherwise.
2550 $updated = Article
::flattenRestrictions( $limit );
2553 foreach ( $restrictionTypes as $action ) {
2554 if ( isset( $expiry[$action] ) ) {
2555 # Get current restrictions on $action
2556 $aLimits = $this->mTitle
->getRestrictions( $action );
2557 $current[$action] = implode( '', $aLimits );
2558 # Are any actual restrictions being dealt with here?
2559 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2561 # If something changed, we need to log it. Checking $aRChanged
2562 # assures that "unprotecting" a page that is not protected does
2563 # not log just because the expiry was "changed".
2564 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2570 $current = Article
::flattenRestrictions( $current );
2572 $changed = ( $changed ||
$current != $updated );
2573 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2574 $protect = ( $updated != '' );
2576 # If nothing's changed, do nothing
2578 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2579 $dbw = wfGetDB( DB_MASTER
);
2581 # Prepare a null revision to be added to the history
2582 $modified = $current != '' && $protect;
2585 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2587 $comment_type = 'unprotectedarticle';
2590 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2592 # Only restrictions with the 'protect' right can cascade...
2593 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2594 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2596 # The schema allows multiple restrictions
2597 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2601 $cascade_description = '';
2604 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2608 $comment .= ": $reason";
2611 $editComment = $comment;
2612 $encodedExpiry = array();
2613 $protect_description = '';
2614 foreach ( $limit as $action => $restrictions ) {
2615 if ( !isset( $expiry[$action] ) )
2616 $expiry[$action] = Block
::infinity();
2618 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2619 if ( $restrictions != '' ) {
2620 $protect_description .= "[$action=$restrictions] (";
2621 if ( $encodedExpiry[$action] != 'infinity' ) {
2622 $protect_description .= wfMsgForContent( 'protect-expiring',
2623 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2624 $wgContLang->date( $expiry[$action], false, false ) ,
2625 $wgContLang->time( $expiry[$action], false, false ) );
2627 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2630 $protect_description .= ') ';
2633 $protect_description = trim( $protect_description );
2635 if ( $protect_description && $protect ) {
2636 $editComment .= " ($protect_description)";
2640 $editComment .= "$cascade_description";
2643 # Update restrictions table
2644 foreach ( $limit as $action => $restrictions ) {
2645 if ( $restrictions != '' ) {
2646 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2647 array( 'pr_page' => $id,
2648 'pr_type' => $action,
2649 'pr_level' => $restrictions,
2650 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2651 'pr_expiry' => $encodedExpiry[$action]
2656 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2657 'pr_type' => $action ), __METHOD__
);
2661 # Insert a null revision
2662 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2663 $nullRevId = $nullRevision->insertOn( $dbw );
2665 $latest = $this->getLatest();
2666 # Update page record
2667 $dbw->update( 'page',
2669 'page_touched' => $dbw->timestamp(),
2670 'page_restrictions' => '',
2671 'page_latest' => $nullRevId
2672 ), array( /* WHERE */
2674 ), 'Article::protect'
2677 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2678 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2680 # Update the protection log
2681 $log = new LogPage( 'protect' );
2683 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2684 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2686 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2689 } # End "changed" check
2695 * Take an array of page restrictions and flatten it to a string
2696 * suitable for insertion into the page_restrictions field.
2697 * @param $limit Array
2700 protected static function flattenRestrictions( $limit ) {
2701 if ( !is_array( $limit ) ) {
2702 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2708 foreach ( $limit as $action => $restrictions ) {
2709 if ( $restrictions != '' ) {
2710 $bits[] = "$action=$restrictions";
2714 return implode( ':', $bits );
2718 * Auto-generates a deletion reason
2720 * @param &$hasHistory Boolean: whether the page has a history
2721 * @return mixed String containing deletion reason or empty string, or boolean false
2722 * if no revision occurred
2724 public function generateReason( &$hasHistory ) {
2727 $dbw = wfGetDB( DB_MASTER
);
2728 // Get the last revision
2729 $rev = Revision
::newFromTitle( $this->mTitle
);
2731 if ( is_null( $rev ) ) {
2735 // Get the article's contents
2736 $contents = $rev->getText();
2739 // If the page is blank, use the text from the previous revision,
2740 // which can only be blank if there's a move/import/protect dummy revision involved
2741 if ( $contents == '' ) {
2742 $prev = $rev->getPrevious();
2745 $contents = $prev->getText();
2750 // Find out if there was only one contributor
2751 // Only scan the last 20 revisions
2752 $res = $dbw->select( 'revision', 'rev_user_text',
2753 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2755 array( 'LIMIT' => 20 )
2758 if ( $res === false ) {
2759 // This page has no revisions, which is very weird
2763 $hasHistory = ( $res->numRows() > 1 );
2764 $row = $dbw->fetchObject( $res );
2766 if ( $row ) { // $row is false if the only contributor is hidden
2767 $onlyAuthor = $row->rev_user_text
;
2768 // Try to find a second contributor
2769 foreach ( $res as $row ) {
2770 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2771 $onlyAuthor = false;
2776 $onlyAuthor = false;
2779 // Generate the summary with a '$1' placeholder
2781 // The current revision is blank and the one before is also
2782 // blank. It's just not our lucky day
2783 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2785 if ( $onlyAuthor ) {
2786 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2788 $reason = wfMsgForContent( 'excontent', '$1' );
2792 if ( $reason == '-' ) {
2793 // Allow these UI messages to be blanked out cleanly
2797 // Replace newlines with spaces to prevent uglyness
2798 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2799 // Calculate the maximum amount of chars to get
2800 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2801 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2802 $contents = $wgContLang->truncate( $contents, $maxLength );
2803 // Remove possible unfinished links
2804 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2805 // Now replace the '$1' placeholder
2806 $reason = str_replace( '$1', $contents, $reason );
2813 * UI entry point for page deletion
2815 public function delete() {
2816 global $wgUser, $wgOut, $wgRequest;
2818 $confirm = $wgRequest->wasPosted() &&
2819 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2821 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2822 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2824 $reason = $this->DeleteReasonList
;
2826 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2827 // Entry from drop down menu + additional comment
2828 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2829 } elseif ( $reason == 'other' ) {
2830 $reason = $this->DeleteReason
;
2833 # Flag to hide all contents of the archived revisions
2834 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2836 # This code desperately needs to be totally rewritten
2838 # Read-only check...
2839 if ( wfReadOnly() ) {
2840 $wgOut->readOnlyPage();
2846 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2848 if ( count( $permission_errors ) > 0 ) {
2849 $wgOut->showPermissionsErrorPage( $permission_errors );
2854 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2856 # Better double-check that it hasn't been deleted yet!
2857 $dbw = wfGetDB( DB_MASTER
);
2858 $conds = $this->mTitle
->pageCond();
2859 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2860 if ( $latest === false ) {
2861 $wgOut->showFatalError(
2864 array( 'class' => 'error mw-error-cannotdelete' ),
2865 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2868 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2869 LogEventsList
::showLogExtract(
2872 $this->mTitle
->getPrefixedText()
2878 # Hack for big sites
2879 $bigHistory = $this->isBigDeletion();
2880 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2881 global $wgLang, $wgDeleteRevisionsLimit;
2883 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2884 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2890 $this->doDelete( $reason, $suppress );
2892 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2894 } elseif ( $this->mTitle
->userIsWatching() ) {
2901 // Generate deletion reason
2902 $hasHistory = false;
2904 $reason = $this->generateReason( $hasHistory );
2907 // If the page has a history, insert a warning
2908 if ( $hasHistory && !$confirm ) {
2911 $skin = $wgUser->getSkin();
2912 $revisions = $this->estimateRevisionCount();
2914 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2915 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2916 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2920 if ( $bigHistory ) {
2921 global $wgDeleteRevisionsLimit;
2922 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2923 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2927 return $this->confirmDelete( $reason );
2931 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2933 public function isBigDeletion() {
2934 global $wgDeleteRevisionsLimit;
2936 if ( $wgDeleteRevisionsLimit ) {
2937 $revCount = $this->estimateRevisionCount();
2939 return $revCount > $wgDeleteRevisionsLimit;
2946 * @return int approximate revision count
2948 public function estimateRevisionCount() {
2949 $dbr = wfGetDB( DB_SLAVE
);
2951 // For an exact count...
2952 // return $dbr->selectField( 'revision', 'COUNT(*)',
2953 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2954 return $dbr->estimateRowCount( 'revision', '*',
2955 array( 'rev_page' => $this->getId() ), __METHOD__
);
2959 * Get the last N authors
2960 * @param $num Integer: number of revisions to get
2961 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2962 * @return array Array of authors, duplicates not removed
2964 public function getLastNAuthors( $num, $revLatest = 0 ) {
2965 wfProfileIn( __METHOD__
);
2966 // First try the slave
2967 // If that doesn't have the latest revision, try the master
2969 $db = wfGetDB( DB_SLAVE
);
2972 $res = $db->select( array( 'page', 'revision' ),
2973 array( 'rev_id', 'rev_user_text' ),
2975 'page_namespace' => $this->mTitle
->getNamespace(),
2976 'page_title' => $this->mTitle
->getDBkey(),
2977 'rev_page = page_id'
2978 ), __METHOD__
, $this->getSelectOptions( array(
2979 'ORDER BY' => 'rev_timestamp DESC',
2985 wfProfileOut( __METHOD__
);
2989 $row = $db->fetchObject( $res );
2991 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2992 $db = wfGetDB( DB_MASTER
);
2997 } while ( $continue );
2999 $authors = array( $row->rev_user_text
);
3001 foreach ( $res as $row ) {
3002 $authors[] = $row->rev_user_text
;
3005 wfProfileOut( __METHOD__
);
3010 * Output deletion confirmation dialog
3011 * FIXME: Move to another file?
3012 * @param $reason String: prefilled reason
3014 public function confirmDelete( $reason ) {
3015 global $wgOut, $wgUser;
3017 wfDebug( "Article::confirmDelete\n" );
3019 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3020 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3021 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3022 $wgOut->addWikiMsg( 'confirmdeletetext' );
3024 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3026 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3027 $suppress = "<tr id=\"wpDeleteSuppressRow\">
3029 <td class='mw-input'><strong>" .
3030 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3031 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3037 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3039 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3040 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3041 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3042 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3043 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3044 "<tr id=\"wpDeleteReasonListRow\">
3045 <td class='mw-label'>" .
3046 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3048 <td class='mw-input'>" .
3049 Xml
::listDropDown( 'wpDeleteReasonList',
3050 wfMsgForContent( 'deletereason-dropdown' ),
3051 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3054 <tr id=\"wpDeleteReasonRow\">
3055 <td class='mw-label'>" .
3056 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3058 <td class='mw-input'>" .
3059 Html
::input( 'wpReason', $reason, 'text', array(
3061 'maxlength' => '255',
3069 # Disallow watching if user is not logged in
3070 if ( $wgUser->isLoggedIn() ) {
3074 <td class='mw-input'>" .
3075 Xml
::checkLabel( wfMsg( 'watchthis' ),
3076 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3085 <td class='mw-submit'>" .
3086 Xml
::submitButton( wfMsg( 'deletepage' ),
3087 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3090 Xml
::closeElement( 'table' ) .
3091 Xml
::closeElement( 'fieldset' ) .
3092 Html
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3093 Xml
::closeElement( 'form' );
3095 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3096 $skin = $wgUser->getSkin();
3097 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3098 $link = $skin->link(
3100 wfMsgHtml( 'delete-edit-reasonlist' ),
3102 array( 'action' => 'edit' )
3104 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3107 $wgOut->addHTML( $form );
3108 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3109 LogEventsList
::showLogExtract( $wgOut, 'delete',
3110 $this->mTitle
->getPrefixedText()
3115 * Perform a deletion and output success or failure messages
3117 public function doDelete( $reason, $suppress = false ) {
3118 global $wgOut, $wgUser;
3120 $id = $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3123 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3124 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3125 $deleted = $this->mTitle
->getPrefixedText();
3127 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3128 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3130 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3132 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3133 $wgOut->returnToMain( false );
3134 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3137 if ( $error == '' ) {
3138 $wgOut->showFatalError(
3141 array( 'class' => 'error mw-error-cannotdelete' ),
3142 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3146 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3148 LogEventsList
::showLogExtract(
3151 $this->mTitle
->getPrefixedText()
3154 $wgOut->showFatalError( $error );
3160 * Back-end article deletion
3161 * Deletes the article with database consistency, writes logs, purges caches
3163 * @param $reason string delete reason for deletion log
3164 * @param suppress bitfield
3165 * Revision::DELETED_TEXT
3166 * Revision::DELETED_COMMENT
3167 * Revision::DELETED_USER
3168 * Revision::DELETED_RESTRICTED
3169 * @param $id int article ID
3170 * @param $commit boolean defaults to true, triggers transaction end
3171 * @return boolean true if successful
3173 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3174 global $wgDeferredUpdateList, $wgUseTrackbacks;
3176 wfDebug( __METHOD__
. "\n" );
3178 $dbw = wfGetDB( DB_MASTER
);
3179 $t = $this->mTitle
->getDBkey();
3180 $id = $id ?
$id : $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3182 if ( $t === '' ||
$id == 0 ) {
3186 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3187 array_push( $wgDeferredUpdateList, $u );
3189 // Bitfields to further suppress the content
3192 // This should be 15...
3193 $bitfield |
= Revision
::DELETED_TEXT
;
3194 $bitfield |
= Revision
::DELETED_COMMENT
;
3195 $bitfield |
= Revision
::DELETED_USER
;
3196 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3198 $bitfield = 'rev_deleted';
3202 // For now, shunt the revision data into the archive table.
3203 // Text is *not* removed from the text table; bulk storage
3204 // is left intact to avoid breaking block-compression or
3205 // immutable storage schemes.
3207 // For backwards compatibility, note that some older archive
3208 // table entries will have ar_text and ar_flags fields still.
3210 // In the future, we may keep revisions and mark them with
3211 // the rev_deleted field, which is reserved for this purpose.
3212 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3214 'ar_namespace' => 'page_namespace',
3215 'ar_title' => 'page_title',
3216 'ar_comment' => 'rev_comment',
3217 'ar_user' => 'rev_user',
3218 'ar_user_text' => 'rev_user_text',
3219 'ar_timestamp' => 'rev_timestamp',
3220 'ar_minor_edit' => 'rev_minor_edit',
3221 'ar_rev_id' => 'rev_id',
3222 'ar_text_id' => 'rev_text_id',
3223 'ar_text' => '\'\'', // Be explicit to appease
3224 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3225 'ar_len' => 'rev_len',
3226 'ar_page_id' => 'page_id',
3227 'ar_deleted' => $bitfield
3230 'page_id = rev_page'
3234 # Delete restrictions for it
3235 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3237 # Now that it's safely backed up, delete it
3238 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3239 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3246 # Fix category table counts
3248 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3250 foreach ( $res as $row ) {
3251 $cats [] = $row->cl_to
;
3254 $this->updateCategoryCounts( array(), $cats );
3256 # If using cascading deletes, we can skip some explicit deletes
3257 if ( !$dbw->cascadingDeletes() ) {
3258 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3260 if ( $wgUseTrackbacks )
3261 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3263 # Delete outgoing links
3264 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3265 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3266 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3267 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3268 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3269 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3270 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3273 # If using cleanup triggers, we can skip some manual deletes
3274 if ( !$dbw->cleanupTriggers() ) {
3275 # Clean up recentchanges entries...
3276 $dbw->delete( 'recentchanges',
3277 array( 'rc_type != ' . RC_LOG
,
3278 'rc_namespace' => $this->mTitle
->getNamespace(),
3279 'rc_title' => $this->mTitle
->getDBkey() ),
3281 $dbw->delete( 'recentchanges',
3282 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3287 Article
::onArticleDelete( $this->mTitle
);
3289 # Clear the cached article id so the interface doesn't act like we exist
3290 $this->mTitle
->resetArticleID( 0 );
3292 # Log the deletion, if the page was suppressed, log it at Oversight instead
3293 $logtype = $suppress ?
'suppress' : 'delete';
3294 $log = new LogPage( $logtype );
3296 # Make sure logging got through
3297 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3307 * Roll back the most recent consecutive set of edits to a page
3308 * from the same user; fails if there are no eligible edits to
3309 * roll back to, e.g. user is the sole contributor. This function
3310 * performs permissions checks on $wgUser, then calls commitRollback()
3311 * to do the dirty work
3313 * @param $fromP String: Name of the user whose edits to rollback.
3314 * @param $summary String: Custom summary. Set to default summary if empty.
3315 * @param $token String: Rollback token.
3316 * @param $bot Boolean: If true, mark all reverted edits as bot.
3318 * @param $resultDetails Array: contains result-specific array of additional values
3319 * 'alreadyrolled' : 'current' (rev)
3320 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3322 * @return array of errors, each error formatted as
3323 * array(messagekey, param1, param2, ...).
3324 * On success, the array is empty. This array can also be passed to
3325 * OutputPage::showPermissionsErrorPage().
3327 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3330 $resultDetails = null;
3333 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3334 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3335 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3337 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3338 $errors[] = array( 'sessionfailure' );
3341 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3342 $errors[] = array( 'actionthrottledtext' );
3345 # If there were errors, bail out now
3346 if ( !empty( $errors ) ) {
3350 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3354 * Backend implementation of doRollback(), please refer there for parameter
3355 * and return value documentation
3357 * NOTE: This function does NOT check ANY permissions, it just commits the
3358 * rollback to the DB Therefore, you should only call this function direct-
3359 * ly if you want to use custom permissions checks. If you don't, use
3360 * doRollback() instead.
3362 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3363 global $wgUseRCPatrol, $wgUser, $wgLang;
3365 $dbw = wfGetDB( DB_MASTER
);
3367 if ( wfReadOnly() ) {
3368 return array( array( 'readonlytext' ) );
3371 # Get the last editor
3372 $current = Revision
::newFromTitle( $this->mTitle
);
3373 if ( is_null( $current ) ) {
3374 # Something wrong... no page?
3375 return array( array( 'notanarticle' ) );
3378 $from = str_replace( '_', ' ', $fromP );
3379 # User name given should match up with the top revision.
3380 # If the user was deleted then $from should be empty.
3381 if ( $from != $current->getUserText() ) {
3382 $resultDetails = array( 'current' => $current );
3383 return array( array( 'alreadyrolled',
3384 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3385 htmlspecialchars( $fromP ),
3386 htmlspecialchars( $current->getUserText() )
3390 # Get the last edit not by this guy...
3391 # Note: these may not be public values
3392 $user = intval( $current->getRawUser() );
3393 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3394 $s = $dbw->selectRow( 'revision',
3395 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3396 array( 'rev_page' => $current->getPage(),
3397 "rev_user != {$user} OR rev_user_text != {$user_text}"
3399 array( 'USE INDEX' => 'page_timestamp',
3400 'ORDER BY' => 'rev_timestamp DESC' )
3402 if ( $s === false ) {
3403 # No one else ever edited this page
3404 return array( array( 'cantrollback' ) );
3405 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3406 # Only admins can see this text
3407 return array( array( 'notvisiblerev' ) );
3411 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3412 # Mark all reverted edits as bot
3416 if ( $wgUseRCPatrol ) {
3417 # Mark all reverted edits as patrolled
3418 $set['rc_patrolled'] = 1;
3421 if ( count( $set ) ) {
3422 $dbw->update( 'recentchanges', $set,
3424 'rc_cur_id' => $current->getPage(),
3425 'rc_user_text' => $current->getUserText(),
3426 "rc_timestamp > '{$s->rev_timestamp}'",
3431 # Generate the edit summary if necessary
3432 $target = Revision
::newFromId( $s->rev_id
);
3433 if ( empty( $summary ) ) {
3434 if ( $from == '' ) { // no public user name
3435 $summary = wfMsgForContent( 'revertpage-nouser' );
3437 $summary = wfMsgForContent( 'revertpage' );
3441 # Allow the custom summary to use the same args as the default message
3443 $target->getUserText(), $from, $s->rev_id
,
3444 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3445 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3447 $summary = wfMsgReplaceArgs( $summary, $args );
3450 $flags = EDIT_UPDATE
;
3452 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3453 $flags |
= EDIT_MINOR
;
3456 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3457 $flags |
= EDIT_FORCE_BOT
;
3460 # Actually store the edit
3461 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3462 if ( !empty( $status->value
['revision'] ) ) {
3463 $revId = $status->value
['revision']->getId();
3468 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3470 $resultDetails = array(
3471 'summary' => $summary,
3472 'current' => $current,
3473 'target' => $target,
3481 * User interface for rollback operations
3483 public function rollback() {
3484 global $wgUser, $wgOut, $wgRequest;
3488 $result = $this->doRollback(
3489 $wgRequest->getVal( 'from' ),
3490 $wgRequest->getText( 'summary' ),
3491 $wgRequest->getVal( 'token' ),
3492 $wgRequest->getBool( 'bot' ),
3496 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3497 $wgOut->rateLimited();
3501 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3502 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3503 $errArray = $result[0];
3504 $errMsg = array_shift( $errArray );
3505 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3507 if ( isset( $details['current'] ) ) {
3508 $current = $details['current'];
3510 if ( $current->getComment() != '' ) {
3511 $wgOut->addWikiMsgArray( 'editcomment', array(
3512 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3519 # Display permissions errors before read-only message -- there's no
3520 # point in misleading the user into thinking the inability to rollback
3521 # is only temporary.
3522 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3523 # array_diff is completely broken for arrays of arrays, sigh.
3524 # Remove any 'readonlytext' error manually.
3526 foreach ( $result as $error ) {
3527 if ( $error != array( 'readonlytext' ) ) {
3531 $wgOut->showPermissionsErrorPage( $out );
3536 if ( $result == array( array( 'readonlytext' ) ) ) {
3537 $wgOut->readOnlyPage();
3542 $current = $details['current'];
3543 $target = $details['target'];
3544 $newId = $details['newid'];
3545 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3546 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3548 if ( $current->getUserText() === '' ) {
3549 $old = wfMsg( 'rev-deleted-user' );
3551 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3552 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3555 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3556 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3557 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3558 $wgOut->returnToMain( false, $this->mTitle
);
3560 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3561 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3562 $de->showDiff( '', '' );
3567 * Do standard deferred updates after page view
3569 public function viewUpdates() {
3570 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3571 if ( wfReadOnly() ) {
3575 # Don't update page view counters on views from bot users (bug 14044)
3576 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3577 $wgDeferredUpdateList[] = new ViewCountUpdate( $this->getID() );
3578 $wgDeferredUpdateList[] = new SiteStatsUpdate( 1, 0, 0 );
3581 # Update newtalk / watchlist notification status
3582 $wgUser->clearNotification( $this->mTitle
);
3586 * Prepare text which is about to be saved.
3587 * Returns a stdclass with source, pst and output members
3589 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
3590 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3592 return $this->mPreparedEdit
;
3597 $edit = (object)array();
3598 $edit->revid
= $revid;
3599 $edit->newText
= $text;
3600 $edit->pst
= $this->preSaveTransform( $text, $user );
3601 $edit->popts
= $this->getParserOptions( true );
3602 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
3603 $edit->oldText
= $this->getRawText();
3605 $this->mPreparedEdit
= $edit;
3611 * Do standard deferred updates after page edit.
3612 * Update links tables, site stats, search index and message cache.
3613 * Purges pages that include this page if the text was changed here.
3614 * Every 100th edit, prune the recent changes table.
3617 * @param $text String: New text of the article
3618 * @param $summary String: Edit summary
3619 * @param $minoredit Boolean: Minor edit
3620 * @param $timestamp_of_pagechange String timestamp associated with the page change
3621 * @param $newid Integer: rev_id value of the new revision
3622 * @param $changed Boolean: Whether or not the content actually changed
3623 * @param $user User object: User doing the edit
3625 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true, User
$user = null ) {
3626 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3628 wfProfileIn( __METHOD__
);
3631 # Be careful not to double-PST: $text is usually already PST-ed once
3632 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3633 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3634 $editInfo = $this->prepareTextForEdit( $text, $newid, $user );
3636 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3637 $editInfo = $this->mPreparedEdit
;
3640 # Save it to the parser cache
3641 if ( $wgEnableParserCache ) {
3642 $parserCache = ParserCache
::singleton();
3643 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
3646 # Update the links tables
3647 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3650 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3652 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3653 if ( 0 == mt_rand( 0, 99 ) ) {
3654 // Flush old entries from the `recentchanges` table; we do this on
3655 // random requests so as to avoid an increase in writes for no good reason
3658 $dbw = wfGetDB( DB_MASTER
);
3659 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3660 $recentchanges = $dbw->tableName( 'recentchanges' );
3661 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3663 $dbw->query( $sql );
3667 $id = $this->getID();
3668 $title = $this->mTitle
->getPrefixedDBkey();
3669 $shortTitle = $this->mTitle
->getDBkey();
3672 wfProfileOut( __METHOD__
);
3676 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3677 array_push( $wgDeferredUpdateList, $u );
3678 $u = new SearchUpdate( $id, $title, $text );
3679 array_push( $wgDeferredUpdateList, $u );
3681 # If this is another user's talk page, update newtalk
3682 # Don't do this if $changed = false otherwise some idiot can null-edit a
3683 # load of user talk pages and piss people off, nor if it's a minor edit
3684 # by a properly-flagged bot.
3685 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3686 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3688 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3689 $other = User
::newFromName( $shortTitle, false );
3691 wfDebug( __METHOD__
. ": invalid username\n" );
3692 } elseif ( User
::isIP( $shortTitle ) ) {
3693 // An anonymous user
3694 $other->setNewtalk( true );
3695 } elseif ( $other->isLoggedIn() ) {
3696 $other->setNewtalk( true );
3698 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3703 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3704 $wgMessageCache->replace( $shortTitle, $text );
3707 wfProfileOut( __METHOD__
);
3711 * Perform article updates on a special page creation.
3713 * @param $rev Revision object
3715 * @todo This is a shitty interface function. Kill it and replace the
3716 * other shitty functions like editUpdates and such so it's not needed
3719 public function createUpdates( $rev ) {
3720 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3721 $this->mTotalAdjustment
= 1;
3722 $this->editUpdates( $rev->getText(), $rev->getComment(),
3723 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3727 * Generate the navigation links when browsing through an article revisions
3728 * It shows the information as:
3729 * Revision as of \<date\>; view current revision
3730 * \<- Previous version | Next Version -\>
3732 * @param $oldid String: revision ID of this article revision
3734 public function setOldSubtitle( $oldid = 0 ) {
3735 global $wgLang, $wgOut, $wgUser, $wgRequest;
3737 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3741 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3743 # Cascade unhide param in links for easy deletion browsing
3744 $extraParams = array();
3745 if ( $wgRequest->getVal( 'unhide' ) ) {
3746 $extraParams['unhide'] = 1;
3749 $revision = Revision
::newFromId( $oldid );
3751 $current = ( $oldid == $this->mLatest
);
3752 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3753 $tddate = $wgLang->date( $this->mTimestamp
, true );
3754 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3755 $sk = $wgUser->getSkin();
3757 ?
wfMsgHtml( 'currentrevisionlink' )
3760 wfMsgHtml( 'currentrevisionlink' ),
3763 array( 'known', 'noclasses' )
3766 ?
wfMsgHtml( 'diff' )
3769 wfMsgHtml( 'diff' ),
3775 array( 'known', 'noclasses' )
3777 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3781 wfMsgHtml( 'previousrevision' ),
3784 'direction' => 'prev',
3787 array( 'known', 'noclasses' )
3789 : wfMsgHtml( 'previousrevision' );
3793 wfMsgHtml( 'diff' ),
3799 array( 'known', 'noclasses' )
3801 : wfMsgHtml( 'diff' );
3802 $nextlink = $current
3803 ?
wfMsgHtml( 'nextrevision' )
3806 wfMsgHtml( 'nextrevision' ),
3809 'direction' => 'next',
3812 array( 'known', 'noclasses' )
3814 $nextdiff = $current
3815 ?
wfMsgHtml( 'diff' )
3818 wfMsgHtml( 'diff' ),
3824 array( 'known', 'noclasses' )
3829 // User can delete revisions or view deleted revisions...
3830 $canHide = $wgUser->isAllowed( 'deleterevision' );
3831 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3832 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3833 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3836 'type' => 'revision',
3837 'target' => $this->mTitle
->getPrefixedDbkey(),
3840 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3845 # Show user links if allowed to see them. If hidden, then show them only if requested...
3846 $userlinks = $sk->revUserTools( $revision, !$unhide );
3848 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
3849 ?
'revision-info-current'
3852 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3855 array( 'parseinline', 'replaceafter' ),
3861 $revision->getUser()
3864 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3865 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3867 $wgOut->setSubtitle( $r );
3871 * This function is called right before saving the wikitext,
3872 * so we can do things like signatures and links-in-context.
3874 * @param $text String article contents
3875 * @param $user User object: user doing the edit, $wgUser will be used if
3877 * @return string article contents with altered wikitext markup (signatures
3878 * converted, {{subst:}}, templates, etc.)
3880 public function preSaveTransform( $text, User
$user = null ) {
3883 if ( $user === null ) {
3888 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, ParserOptions
::newFromUser( $user ) );
3891 /* Caching functions */
3894 * checkLastModified returns true if it has taken care of all
3895 * output to the client that is necessary for this request.
3896 * (that is, it has sent a cached version of the page)
3898 * @return boolean true if cached version send, false otherwise
3900 protected function tryFileCache() {
3901 static $called = false;
3904 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3909 if ( $this->isFileCacheable() ) {
3910 $cache = new HTMLFileCache( $this->mTitle
);
3911 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3912 wfDebug( "Article::tryFileCache(): about to load file\n" );
3913 $cache->loadFromFileCache();
3916 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3917 ob_start( array( &$cache, 'saveToFileCache' ) );
3920 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3927 * Check if the page can be cached
3930 public function isFileCacheable() {
3933 if ( HTMLFileCache
::useFileCache() ) {
3934 $cacheable = $this->getID() && !$this->mRedirectedFrom
&& !$this->mTitle
->isRedirect();
3935 // Extension may have reason to disable file caching on some pages.
3937 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3945 * Loads page_touched and returns a value indicating if it should be used
3946 * @return boolean true if not a redirect
3948 public function checkTouched() {
3949 if ( !$this->mDataLoaded
) {
3950 $this->loadPageData();
3953 return !$this->mIsRedirect
;
3957 * Get the page_touched field
3958 * @return string containing GMT timestamp
3960 public function getTouched() {
3961 if ( !$this->mDataLoaded
) {
3962 $this->loadPageData();
3965 return $this->mTouched
;
3969 * Get the page_latest field
3970 * @return integer rev_id of current revision
3972 public function getLatest() {
3973 if ( !$this->mDataLoaded
) {
3974 $this->loadPageData();
3977 return (int)$this->mLatest
;
3981 * Edit an article without doing all that other stuff
3982 * The article must already exist; link tables etc
3983 * are not updated, caches are not flushed.
3985 * @param $text String: text submitted
3986 * @param $comment String: comment submitted
3987 * @param $minor Boolean: whereas it's a minor modification
3989 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3990 wfProfileIn( __METHOD__
);
3992 $dbw = wfGetDB( DB_MASTER
);
3993 $revision = new Revision( array(
3994 'page' => $this->getId(),
3996 'comment' => $comment,
3997 'minor_edit' => $minor ?
1 : 0,
3999 $revision->insertOn( $dbw );
4000 $this->updateRevisionOn( $dbw, $revision );
4003 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4005 wfProfileOut( __METHOD__
);
4009 * The onArticle*() functions are supposed to be a kind of hooks
4010 * which should be called whenever any of the specified actions
4013 * This is a good place to put code to clear caches, for instance.
4015 * This is called on page move and undelete, as well as edit
4017 * @param $title Title object
4019 public static function onArticleCreate( $title ) {
4020 # Update existence markers on article/talk tabs...
4021 if ( $title->isTalkPage() ) {
4022 $other = $title->getSubjectPage();
4024 $other = $title->getTalkPage();
4027 $other->invalidateCache();
4028 $other->purgeSquid();
4030 $title->touchLinks();
4031 $title->purgeSquid();
4032 $title->deleteTitleProtection();
4036 * Clears caches when article is deleted
4038 public static function onArticleDelete( $title ) {
4039 global $wgMessageCache;
4041 # Update existence markers on article/talk tabs...
4042 if ( $title->isTalkPage() ) {
4043 $other = $title->getSubjectPage();
4045 $other = $title->getTalkPage();
4048 $other->invalidateCache();
4049 $other->purgeSquid();
4051 $title->touchLinks();
4052 $title->purgeSquid();
4055 HTMLFileCache
::clearFileCache( $title );
4058 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4059 $wgMessageCache->replace( $title->getDBkey(), false );
4063 if ( $title->getNamespace() == NS_FILE
) {
4064 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4065 $update->doUpdate();
4069 if ( $title->getNamespace() == NS_USER_TALK
) {
4070 $user = User
::newFromName( $title->getText(), false );
4071 $user->setNewtalk( false );
4075 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4079 * Purge caches on page update etc
4081 * @param $title Title object
4082 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4084 public static function onArticleEdit( $title ) {
4085 global $wgDeferredUpdateList;
4087 // Invalidate caches of articles which include this page
4088 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4090 // Invalidate the caches of all pages which redirect here
4091 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4093 # Purge squid for this page only
4094 $title->purgeSquid();
4096 # Clear file cache for this page only
4097 HTMLFileCache
::clearFileCache( $title );
4103 * Overriden by ImagePage class, only present here to avoid a fatal error
4104 * Called for ?action=revert
4106 public function revert() {
4108 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4112 * Info about this page
4113 * Called for ?action=info when $wgAllowPageInfo is on.
4115 public function info() {
4116 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4118 if ( !$wgAllowPageInfo ) {
4119 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4123 $page = $this->mTitle
->getSubjectPage();
4125 $wgOut->setPagetitle( $page->getPrefixedText() );
4126 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4127 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4129 if ( !$this->mTitle
->exists() ) {
4130 $wgOut->addHTML( '<div class="noarticletext">' );
4131 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4132 // This doesn't quite make sense; the user is asking for
4133 // information about the _page_, not the message... -- RC
4134 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4136 $msg = $wgUser->isLoggedIn()
4138 : 'noarticletextanon';
4139 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4142 $wgOut->addHTML( '</div>' );
4144 $dbr = wfGetDB( DB_SLAVE
);
4146 'wl_title' => $page->getDBkey(),
4147 'wl_namespace' => $page->getNamespace() );
4148 $numwatchers = $dbr->selectField(
4153 $this->getSelectOptions() );
4155 $pageInfo = $this->pageCountInfo( $page );
4156 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4159 //FIXME: unescaped messages
4160 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4161 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4164 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4167 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4170 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4173 $wgOut->addHTML( '</ul>' );
4178 * Return the total number of edits and number of unique editors
4179 * on a given page. If page does not exist, returns false.
4181 * @param $title Title object
4182 * @return mixed array or boolean false
4184 public function pageCountInfo( $title ) {
4185 $id = $title->getArticleId();
4191 $dbr = wfGetDB( DB_SLAVE
);
4192 $rev_clause = array( 'rev_page' => $id );
4193 $edits = $dbr->selectField(
4198 $this->getSelectOptions()
4200 $authors = $dbr->selectField(
4202 'COUNT(DISTINCT rev_user_text)',
4205 $this->getSelectOptions()
4208 return array( 'edits' => $edits, 'authors' => $authors );
4212 * Return a list of templates used by this article.
4213 * Uses the templatelinks table
4215 * @return Array of Title objects
4217 public function getUsedTemplates() {
4219 $id = $this->mTitle
->getArticleID();
4225 $dbr = wfGetDB( DB_SLAVE
);
4226 $res = $dbr->select( array( 'templatelinks' ),
4227 array( 'tl_namespace', 'tl_title' ),
4228 array( 'tl_from' => $id ),
4231 if ( $res !== false ) {
4232 foreach ( $res as $row ) {
4233 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4241 * Returns a list of hidden categories this page is a member of.
4242 * Uses the page_props and categorylinks tables.
4244 * @return Array of Title objects
4246 public function getHiddenCategories() {
4248 $id = $this->mTitle
->getArticleID();
4254 $dbr = wfGetDB( DB_SLAVE
);
4255 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4257 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4258 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4261 if ( $res !== false ) {
4262 foreach ( $res as $row ) {
4263 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4271 * Return an applicable autosummary if one exists for the given edit.
4272 * @param $oldtext String: the previous text of the page.
4273 * @param $newtext String: The submitted text of the page.
4274 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
4275 * @return string An appropriate autosummary, or an empty string.
4277 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4280 # Decide what kind of autosummary is needed.
4282 # Redirect autosummaries
4283 $ot = Title
::newFromRedirect( $oldtext );
4284 $rt = Title
::newFromRedirect( $newtext );
4286 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4287 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4290 # New page autosummaries
4291 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4292 # If they're making a new article, give its text, truncated, in the summary.
4294 $truncatedtext = $wgContLang->truncate(
4295 str_replace( "\n", ' ', $newtext ),
4296 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4298 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4301 # Blanking autosummaries
4302 if ( $oldtext != '' && $newtext == '' ) {
4303 return wfMsgForContent( 'autosumm-blank' );
4304 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4305 # Removing more than 90% of the article
4307 $truncatedtext = $wgContLang->truncate(
4309 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4311 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4314 # If we reach this point, there's no applicable autosummary for our case, so our
4315 # autosummary is empty.
4320 * Add the primary page-view wikitext to the output buffer
4321 * Saves the text into the parser cache if possible.
4322 * Updates templatelinks if it is out of date.
4324 * @param $text String
4325 * @param $cache Boolean
4326 * @param $parserOptions mixed ParserOptions object, or boolean false
4328 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4331 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4332 $wgOut->addParserOutput( $this->mParserOutput
);
4336 * This does all the heavy lifting for outputWikitext, except it returns the parser
4337 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4338 * say, embedding thread pages within a discussion system (LiquidThreads)
4340 * @param $text string
4341 * @param $cache boolean
4342 * @param $parserOptions parsing options, defaults to false
4343 * @return string containing parsed output
4345 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4346 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4348 if ( !$parserOptions ) {
4349 $parserOptions = $this->getParserOptions();
4353 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4354 $parserOptions, true, true, $this->getRevIdFetched() );
4359 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4360 $this->mTitle
->getPrefixedDBkey() ) );
4363 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4364 $parserCache = ParserCache
::singleton();
4365 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4368 // Make sure file cache is not used on uncacheable content.
4369 // Output that has magic words in it can still use the parser cache
4370 // (if enabled), though it will generally expire sooner.
4371 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4372 $wgUseFileCache = false;
4375 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4377 return $this->mParserOutput
;
4381 * Get parser options suitable for rendering the primary article wikitext
4382 * @param $canonical boolean Determines that the generated must not depend on user preferences (see bug 14404)
4383 * @return mixed ParserOptions object or boolean false
4385 public function getParserOptions( $canonical = false ) {
4386 global $wgUser, $wgLanguageCode;
4388 if ( !$this->mParserOptions ||
$canonical ) {
4389 $user = !$canonical ?
$wgUser : new User
;
4390 $parserOptions = new ParserOptions( $user );
4391 $parserOptions->setTidy( true );
4392 $parserOptions->enableLimitReport();
4395 $parserOptions->setUserLang( $wgLanguageCode ); # Must be set explicitely
4396 return $parserOptions;
4398 $this->mParserOptions
= $parserOptions;
4401 // Clone to allow modifications of the return value without affecting
4403 return clone $this->mParserOptions
;
4407 * Updates cascading protections
4409 * @param $parserOutput mixed ParserOptions object, or boolean false
4411 protected function doCascadeProtectionUpdates( $parserOutput ) {
4412 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4416 // templatelinks table may have become out of sync,
4417 // especially if using variable-based transclusions.
4418 // For paranoia, check if things have changed and if
4419 // so apply updates to the database. This will ensure
4420 // that cascaded protections apply as soon as the changes
4423 # Get templates from templatelinks
4424 $id = $this->mTitle
->getArticleID();
4426 $tlTemplates = array();
4428 $dbr = wfGetDB( DB_SLAVE
);
4429 $res = $dbr->select( array( 'templatelinks' ),
4430 array( 'tl_namespace', 'tl_title' ),
4431 array( 'tl_from' => $id ),
4435 foreach ( $res as $row ) {
4436 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4439 # Get templates from parser output.
4440 $poTemplates = array();
4441 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4442 foreach ( $templates as $dbk => $id ) {
4443 $poTemplates["$ns:$dbk"] = true;
4448 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4450 if ( count( $templates_diff ) > 0 ) {
4451 # Whee, link updates time.
4452 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4458 * Update all the appropriate counts in the category table, given that
4459 * we've added the categories $added and deleted the categories $deleted.
4461 * @param $added array The names of categories that were added
4462 * @param $deleted array The names of categories that were deleted
4464 public function updateCategoryCounts( $added, $deleted ) {
4465 $ns = $this->mTitle
->getNamespace();
4466 $dbw = wfGetDB( DB_MASTER
);
4468 # First make sure the rows exist. If one of the "deleted" ones didn't
4469 # exist, we might legitimately not create it, but it's simpler to just
4470 # create it and then give it a negative value, since the value is bogus
4473 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4474 $insertCats = array_merge( $added, $deleted );
4475 if ( !$insertCats ) {
4476 # Okay, nothing to do
4480 $insertRows = array();
4482 foreach ( $insertCats as $cat ) {
4483 $insertRows[] = array(
4484 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4488 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4490 $addFields = array( 'cat_pages = cat_pages + 1' );
4491 $removeFields = array( 'cat_pages = cat_pages - 1' );
4493 if ( $ns == NS_CATEGORY
) {
4494 $addFields[] = 'cat_subcats = cat_subcats + 1';
4495 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4496 } elseif ( $ns == NS_FILE
) {
4497 $addFields[] = 'cat_files = cat_files + 1';
4498 $removeFields[] = 'cat_files = cat_files - 1';
4505 array( 'cat_title' => $added ),
4514 array( 'cat_title' => $deleted ),
4521 * Lightweight method to get the parser output for a page, checking the parser cache
4522 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4523 * consider, so it's not appropriate to use there.
4525 * @since 1.16 (r52326) for LiquidThreads
4527 * @param $oldid mixed integer Revision ID or null
4528 * @return ParserOutput
4530 public function getParserOutput( $oldid = null ) {
4531 global $wgEnableParserCache, $wgUser;
4533 // Should the parser cache be used?
4534 $useParserCache = $wgEnableParserCache &&
4535 $wgUser->getStubThreshold() == 0 &&
4539 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4541 if ( $wgUser->getStubThreshold() ) {
4542 wfIncrStats( 'pcache_miss_stub' );
4545 $parserOutput = false;
4546 if ( $useParserCache ) {
4547 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4550 if ( $parserOutput === false ) {
4551 // Cache miss; parse and output it.
4552 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4554 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4556 return $parserOutput;
4562 class PoolWorkArticleView
extends PoolCounterWork
{
4565 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4566 parent
::__construct( 'ArticleView', $key );
4567 $this->mArticle
= $article;
4568 $this->cacheable
= $useParserCache;
4569 $this->parserOptions
= $parserOptions;
4573 return $this->mArticle
->doViewParse();
4576 function getCachedWork() {
4579 $parserCache = ParserCache
::singleton();
4580 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
4582 if ( $this->mArticle
->mParserOutput
!== false ) {
4583 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
4584 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
4585 # Ensure that UI elements requiring revision ID have
4586 # the correct version information.
4587 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
4593 function fallback() {
4594 return $this->mArticle
->tryDirtyCache();
4597 function error( $status ) {
4600 $wgOut->clearHTML(); // for release() errors
4601 $wgOut->enableClientCache( false );
4602 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4604 $errortext = $status->getWikiText( false, 'view-pool-error' );
4605 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );