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();
1301 * If patrol is possible, output a patrol UI box. This is called from the
1302 * footer section of ordinary page views. If patrol is not possible or not
1303 * desired, does nothing.
1305 public function showPatrolFooter() {
1306 global $wgOut, $wgRequest, $wgUser;
1308 $rcid = $wgRequest->getVal( 'rcid' );
1310 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1314 $sk = $wgUser->getSkin();
1315 $token = $wgUser->editToken( $rcid );
1316 $wgOut->preventClickjacking();
1319 "<div class='patrollink'>" .
1321 'markaspatrolledlink',
1324 wfMsgHtml( 'markaspatrolledtext' ),
1327 'action' => 'markpatrolled',
1331 array( 'known', 'noclasses' )
1339 * Show the error text for a missing article. For articles in the MediaWiki
1340 * namespace, show the default message text. To be called from Article::view().
1342 public function showMissingArticle() {
1343 global $wgOut, $wgRequest, $wgUser;
1345 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1346 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1347 $parts = explode( '/', $this->mTitle
->getText() );
1348 $rootPart = $parts[0];
1349 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1350 $ip = User
::isIP( $rootPart );
1352 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1353 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1354 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1355 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1356 LogEventsList
::showLogExtract(
1359 $user->getUserPage()->getPrefixedText(),
1363 'showIfEmpty' => false,
1365 'blocked-notice-logextract',
1366 $user->getName() # Support GENDER in notice
1373 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1375 # Show delete and move logs
1376 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1378 'conds' => array( "log_action != 'revision'" ),
1379 'showIfEmpty' => false,
1380 'msgKey' => array( 'moveddeleted-notice' ) )
1383 # Show error message
1384 $oldid = $this->getOldID();
1386 $text = wfMsgNoTrans( 'missing-article',
1387 $this->mTitle
->getPrefixedText(),
1388 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1389 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1390 // Use the default message text
1391 $text = $this->getContent();
1393 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1394 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1395 $errors = array_merge( $createErrors, $editErrors );
1397 if ( !count( $errors ) ) {
1398 $text = wfMsgNoTrans( 'noarticletext' );
1400 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1403 $text = "<div class='noarticletext'>\n$text\n</div>";
1405 if ( !$this->hasViewableContent() ) {
1406 // If there's no backing content, send a 404 Not Found
1407 // for better machine handling of broken links.
1408 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1411 $wgOut->addWikiText( $text );
1415 * If the revision requested for view is deleted, check permissions.
1416 * Send either an error message or a warning header to $wgOut.
1418 * @return boolean true if the view is allowed, false if not.
1420 public function showDeletedRevisionHeader() {
1421 global $wgOut, $wgRequest;
1423 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1428 // If the user is not allowed to see it...
1429 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1430 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1431 'rev-deleted-text-permission' );
1434 // If the user needs to confirm that they want to see it...
1435 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1436 # Give explanation and add a link to view the revision...
1437 $oldid = intval( $this->getOldID() );
1438 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1439 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1440 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1441 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1442 array( $msg, $link ) );
1445 // We are allowed to see...
1447 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1448 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1449 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1456 * Should the parser cache be used?
1460 public function useParserCache( $oldid ) {
1461 global $wgUser, $wgEnableParserCache;
1463 return $wgEnableParserCache
1464 && $wgUser->getStubThreshold() == 0
1467 && !$this->mTitle
->isCssOrJsPage()
1468 && !$this->mTitle
->isCssJsSubpage();
1472 * Execute the uncached parse for action=view
1474 public function doViewParse() {
1477 $oldid = $this->getOldID();
1478 $parserOptions = $this->getParserOptions();
1480 # Render printable version, use printable version cache
1481 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1483 # Don't show section-edit links on old revisions... this way lies madness.
1484 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ||
!$this->mTitle
->quickUserCan( 'edit' ) ) {
1485 $parserOptions->setEditSection( false );
1488 $useParserCache = $this->useParserCache( $oldid );
1489 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1495 * Try to fetch an expired entry from the parser cache. If it is present,
1496 * output it and return true. If it is not present, output nothing and
1497 * return false. This is used as a callback function for
1498 * PoolCounter::executeProtected().
1502 public function tryDirtyCache() {
1504 $parserCache = ParserCache
::singleton();
1505 $options = $this->getParserOptions();
1507 if ( $wgOut->isPrintable() ) {
1508 $options->setIsPrintable( true );
1509 $options->setEditSection( false );
1512 $output = $parserCache->getDirty( $this, $options );
1515 wfDebug( __METHOD__
. ": sending dirty output\n" );
1516 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1517 $wgOut->setSquidMaxage( 0 );
1518 $this->mParserOutput
= $output;
1519 $wgOut->addParserOutput( $output );
1520 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1524 wfDebugLog( 'dirty', "dirty missing\n" );
1525 wfDebug( __METHOD__
. ": no dirty cache\n" );
1534 * @param $target Title|Array of destination(s) to redirect
1535 * @param $appendSubtitle Boolean [optional]
1536 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1537 * @return string containing HMTL with redirect link
1539 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1540 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1542 if ( !is_array( $target ) ) {
1543 $target = array( $target );
1546 $imageDir = $wgContLang->getDir();
1548 if ( $appendSubtitle ) {
1549 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1552 $sk = $wgUser->getSkin();
1553 // the loop prepends the arrow image before the link, so the first case needs to be outside
1554 $title = array_shift( $target );
1556 if ( $forceKnown ) {
1557 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1559 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1562 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1563 $alt = $wgContLang->isRTL() ?
'←' : '→';
1564 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1565 // FIXME: where this happens?
1566 foreach ( $target as $rt ) {
1567 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1568 if ( $forceKnown ) {
1569 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1571 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1575 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1576 return '<div class="redirectMsg">' .
1577 Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1578 '<span class="redirectText">' . $link . '</span></div>';
1582 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1584 public function addTrackbacks() {
1585 global $wgOut, $wgUser;
1587 $dbr = wfGetDB( DB_SLAVE
);
1588 $tbs = $dbr->select( 'trackbacks',
1589 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1590 array( 'tb_page' => $this->getID() )
1593 if ( !$dbr->numRows( $tbs ) ) {
1597 $wgOut->preventClickjacking();
1600 foreach ( $tbs as $o ) {
1603 if ( $wgUser->isAllowed( 'trackback' ) ) {
1604 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1605 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1606 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1610 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1618 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1622 * Removes trackback record for current article from trackbacks table
1624 public function deletetrackback() {
1625 global $wgUser, $wgRequest, $wgOut;
1627 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1628 $wgOut->addWikiMsg( 'sessionfailure' );
1633 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1635 if ( count( $permission_errors ) ) {
1636 $wgOut->showPermissionsErrorPage( $permission_errors );
1641 $db = wfGetDB( DB_MASTER
);
1642 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1644 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1645 $this->mTitle
->invalidateCache();
1649 * Handle action=render
1652 public function render() {
1655 $wgOut->setArticleBodyOnly( true );
1660 * Handle action=purge
1662 public function purge() {
1663 global $wgUser, $wgRequest, $wgOut;
1665 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1666 //FIXME: shouldn't this be in doPurge()?
1667 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1672 $formParams = array(
1674 'action' => $wgRequest->getRequestURL(),
1677 $wgOut->addWikiMsg( 'confirm-purge-top' );
1679 $form = Html
::openElement( 'form', $formParams );
1680 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1681 $form .= Html
::closeElement( 'form' );
1683 $wgOut->addHTML( $form );
1684 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1686 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1687 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1692 * Perform the actions of a page purging
1694 public function doPurge() {
1697 // Invalidate the cache
1698 $this->mTitle
->invalidateCache();
1701 if ( $wgUseSquid ) {
1702 // Commit the transaction before the purge is sent
1703 $dbw = wfGetDB( DB_MASTER
);
1707 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1708 $update->doUpdate();
1711 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1712 global $wgMessageCache;
1714 if ( $this->getID() == 0 ) {
1717 $text = $this->getRawText();
1720 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1725 * Insert a new empty page record for this article.
1726 * This *must* be followed up by creating a revision
1727 * and running $this->updateRevisionOn( ... );
1728 * or else the record will be left in a funky state.
1729 * Best if all done inside a transaction.
1731 * @param $dbw Database
1732 * @return int The newly created page_id key, or false if the title already existed
1735 public function insertOn( $dbw ) {
1736 wfProfileIn( __METHOD__
);
1738 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1739 $dbw->insert( 'page', array(
1740 'page_id' => $page_id,
1741 'page_namespace' => $this->mTitle
->getNamespace(),
1742 'page_title' => $this->mTitle
->getDBkey(),
1743 'page_counter' => 0,
1744 'page_restrictions' => '',
1745 'page_is_redirect' => 0, # Will set this shortly...
1747 'page_random' => wfRandom(),
1748 'page_touched' => $dbw->timestamp(),
1749 'page_latest' => 0, # Fill this in shortly...
1750 'page_len' => 0, # Fill this in shortly...
1751 ), __METHOD__
, 'IGNORE' );
1753 $affected = $dbw->affectedRows();
1756 $newid = $dbw->insertId();
1757 $this->mTitle
->resetArticleId( $newid );
1759 wfProfileOut( __METHOD__
);
1761 return $affected ?
$newid : false;
1765 * Update the page record to point to a newly saved revision.
1767 * @param $dbw DatabaseBase: object
1768 * @param $revision Revision: For ID number, and text used to set
1769 length and redirect status fields
1770 * @param $lastRevision Integer: if given, will not overwrite the page field
1771 * when different from the currently set value.
1772 * Giving 0 indicates the new page flag should be set
1774 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1775 * removing rows in redirect table.
1776 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1777 * Needed when $lastRevision has to be set to sth. !=0
1778 * @return bool true on success, false on failure
1781 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1782 wfProfileIn( __METHOD__
);
1784 $text = $revision->getText();
1785 $rt = Title
::newFromRedirectRecurse( $text );
1787 $conditions = array( 'page_id' => $this->getId() );
1789 if ( !is_null( $lastRevision ) ) {
1790 # An extra check against threads stepping on each other
1791 $conditions['page_latest'] = $lastRevision;
1794 if ( !$setNewFlag ) {
1795 $setNewFlag = ( $lastRevision === 0 );
1798 $dbw->update( 'page',
1800 'page_latest' => $revision->getId(),
1801 'page_touched' => $dbw->timestamp(),
1802 'page_is_new' => $setNewFlag,
1803 'page_is_redirect' => $rt !== null ?
1 : 0,
1804 'page_len' => strlen( $text ),
1809 $result = $dbw->affectedRows() != 0;
1811 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1814 wfProfileOut( __METHOD__
);
1819 * Add row to the redirect table if this is a redirect, remove otherwise.
1821 * @param $dbw Database
1822 * @param $redirectTitle Title object pointing to the redirect target,
1823 * or NULL if this is not a redirect
1824 * @param $lastRevIsRedirect If given, will optimize adding and
1825 * removing rows in redirect table.
1826 * @return bool true on success, false on failure
1829 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1830 // Always update redirects (target link might have changed)
1831 // Update/Insert if we don't know if the last revision was a redirect or not
1832 // Delete if changing from redirect to non-redirect
1833 $isRedirect = !is_null( $redirectTitle );
1835 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1836 wfProfileIn( __METHOD__
);
1837 if ( $isRedirect ) {
1838 $this->insertRedirectEntry( $redirectTitle );
1840 // This is not a redirect, remove row from redirect table
1841 $where = array( 'rd_from' => $this->getId() );
1842 $dbw->delete( 'redirect', $where, __METHOD__
);
1845 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1846 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1848 wfProfileOut( __METHOD__
);
1850 return ( $dbw->affectedRows() != 0 );
1857 * If the given revision is newer than the currently set page_latest,
1858 * update the page record. Otherwise, do nothing.
1860 * @param $dbw Database object
1861 * @param $revision Revision object
1864 public function updateIfNewerOn( &$dbw, $revision ) {
1865 wfProfileIn( __METHOD__
);
1867 $row = $dbw->selectRow(
1868 array( 'revision', 'page' ),
1869 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1871 'page_id' => $this->getId(),
1872 'page_latest=rev_id' ),
1876 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1877 wfProfileOut( __METHOD__
);
1880 $prev = $row->rev_id
;
1881 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1883 # No or missing previous revision; mark the page as new
1885 $lastRevIsRedirect = null;
1888 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1890 wfProfileOut( __METHOD__
);
1895 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1896 * @param $text String: new text of the section
1897 * @param $summary String: new section's subject, only if $section is 'new'
1898 * @param $edittime String: revision timestamp or null to use the current revision
1899 * @return string Complete article text, or null if error
1901 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1902 wfProfileIn( __METHOD__
);
1904 if ( strval( $section ) == '' ) {
1905 // Whole-page edit; let the whole text through
1907 if ( is_null( $edittime ) ) {
1908 $rev = Revision
::newFromTitle( $this->mTitle
);
1910 $dbw = wfGetDB( DB_MASTER
);
1911 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1915 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1916 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1920 $oldtext = $rev->getText();
1922 if ( $section == 'new' ) {
1923 # Inserting a new section
1924 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1925 $text = strlen( trim( $oldtext ) ) > 0
1926 ?
"{$oldtext}\n\n{$subject}{$text}"
1927 : "{$subject}{$text}";
1929 # Replacing an existing section; roll out the big guns
1932 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1936 wfProfileOut( __METHOD__
);
1941 * This function is not deprecated until somebody fixes the core not to use
1942 * it. Nevertheless, use Article::doEdit() instead.
1943 * @deprecated @since 1.7
1945 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1946 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1947 ( $isminor ? EDIT_MINOR
: 0 ) |
1948 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1949 ( $bot ? EDIT_FORCE_BOT
: 0 );
1951 # If this is a comment, add the summary as headline
1952 if ( $comment && $summary != "" ) {
1953 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1955 $this->doEdit( $text, $summary, $flags );
1957 $dbw = wfGetDB( DB_MASTER
);
1959 if ( !$this->mTitle
->userIsWatching() ) {
1965 if ( $this->mTitle
->userIsWatching() ) {
1971 $this->doRedirect( $this->isRedirect( $text ) );
1975 * @deprecated @since 1.7 use Article::doEdit()
1977 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1978 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1979 ( $minor ? EDIT_MINOR
: 0 ) |
1980 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1982 $status = $this->doEdit( $text, $summary, $flags );
1984 if ( !$status->isOK() ) {
1988 $dbw = wfGetDB( DB_MASTER
);
1990 if ( !$this->mTitle
->userIsWatching() ) {
1996 if ( $this->mTitle
->userIsWatching() ) {
2003 $extraQuery = ''; // Give extensions a chance to modify URL query on update
2004 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2006 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2011 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2013 * @return Int updated $flags
2015 function checkFlags( $flags ) {
2016 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
2017 if ( $this->mTitle
->getArticleID() ) {
2018 $flags |
= EDIT_UPDATE
;
2030 * Change an existing article or create a new article. Updates RC and all necessary caches,
2031 * optionally via the deferred update array.
2033 * $wgUser must be set before calling this function.
2035 * @param $text String: new text
2036 * @param $summary String: edit summary
2037 * @param $flags Integer bitfield:
2039 * Article is known or assumed to be non-existent, create a new one
2041 * Article is known or assumed to be pre-existing, update it
2043 * Mark this edit minor, if the user is allowed to do so
2045 * Do not log the change in recentchanges
2047 * Mark the edit a "bot" edit regardless of user rights
2048 * EDIT_DEFER_UPDATES
2049 * Defer some of the updates until the end of index.php
2051 * Fill in blank summaries with generated text where possible
2053 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2054 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2055 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2056 * edit-already-exists error will be returned. These two conditions are also possible with
2057 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2059 * @param $baseRevId the revision ID this edit was based off, if any
2060 * @param $user User (optional), $wgUser will be used if not passed
2062 * @return Status object. Possible errors:
2063 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2064 * edit-gone-missing: In update mode, but the article didn't exist
2065 * edit-conflict: In update mode, the article changed unexpectedly
2066 * edit-no-change: Warning that the text was the same as before
2067 * edit-already-exists: In creation mode, but the article already exists
2069 * Extensions may define additional errors.
2071 * $return->value will contain an associative array with members as follows:
2072 * new: Boolean indicating if the function attempted to create a new article
2073 * revision: The revision object for the inserted revision, or null
2075 * Compatibility note: this function previously returned a boolean value indicating success/failure
2077 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2078 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2080 # Low-level sanity check
2081 if ( $this->mTitle
->getText() === '' ) {
2082 throw new MWException( 'Something is trying to edit an article with an empty title' );
2085 wfProfileIn( __METHOD__
);
2087 $user = is_null( $user ) ?
$wgUser : $user;
2088 $status = Status
::newGood( array() );
2090 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2091 $this->loadPageData();
2093 $flags = $this->checkFlags( $flags );
2095 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2096 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
2098 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2099 wfProfileOut( __METHOD__
);
2101 if ( $status->isOK() ) {
2102 $status->fatal( 'edit-hook-aborted' );
2108 # Silently ignore EDIT_MINOR if not allowed
2109 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2110 $bot = $flags & EDIT_FORCE_BOT
;
2112 $oldtext = $this->getRawText(); // current revision
2113 $oldsize = strlen( $oldtext );
2115 # Provide autosummaries if one is not provided and autosummaries are enabled.
2116 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2117 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2120 $editInfo = $this->prepareTextForEdit( $text, null, $user );
2121 $text = $editInfo->pst
;
2122 $newsize = strlen( $text );
2124 $dbw = wfGetDB( DB_MASTER
);
2125 $now = wfTimestampNow();
2126 $this->mTimestamp
= $now;
2128 if ( $flags & EDIT_UPDATE
) {
2129 # Update article, but only if changed.
2130 $status->value
['new'] = false;
2132 # Make sure the revision is either completely inserted or not inserted at all
2133 if ( !$wgDBtransactions ) {
2134 $userAbort = ignore_user_abort( true );
2137 $changed = ( strcmp( $text, $oldtext ) != 0 );
2140 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2141 - (int)$this->isCountable( $oldtext );
2142 $this->mTotalAdjustment
= 0;
2144 if ( !$this->mLatest
) {
2145 # Article gone missing
2146 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2147 $status->fatal( 'edit-gone-missing' );
2149 wfProfileOut( __METHOD__
);
2153 $revision = new Revision( array(
2154 'page' => $this->getId(),
2155 'comment' => $summary,
2156 'minor_edit' => $isminor,
2158 'parent_id' => $this->mLatest
,
2159 'user' => $user->getId(),
2160 'user_text' => $user->getName(),
2165 $revisionId = $revision->insertOn( $dbw );
2169 # Note that we use $this->mLatest instead of fetching a value from the master DB
2170 # during the course of this function. This makes sure that EditPage can detect
2171 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2172 # before this function is called. A previous function used a separate query, this
2173 # creates a window where concurrent edits can cause an ignored edit conflict.
2174 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2177 /* Belated edit conflict! Run away!! */
2178 $status->fatal( 'edit-conflict' );
2180 # Delete the invalid revision if the DB is not transactional
2181 if ( !$wgDBtransactions ) {
2182 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2188 global $wgUseRCPatrol;
2189 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2190 # Update recentchanges
2191 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2192 # Mark as patrolled if the user can do so
2193 $patrolled = $wgUseRCPatrol && !count(
2194 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2195 # Add RC row to the DB
2196 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2197 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2198 $revisionId, $patrolled
2201 # Log auto-patrolled edits
2203 PatrolLog
::record( $rc, true );
2206 $user->incEditCount();
2210 $status->warning( 'edit-no-change' );
2212 // Keep the same revision ID, but do some updates on it
2213 $revisionId = $this->getLatest();
2214 // Update page_touched, this is usually implicit in the page update
2215 // Other cache updates are done in onArticleEdit()
2216 $this->mTitle
->invalidateCache();
2219 if ( !$wgDBtransactions ) {
2220 ignore_user_abort( $userAbort );
2223 // Now that ignore_user_abort is restored, we can respond to fatal errors
2224 if ( !$status->isOK() ) {
2225 wfProfileOut( __METHOD__
);
2229 # Invalidate cache of this article and all pages using this article
2230 # as a template. Partly deferred.
2231 Article
::onArticleEdit( $this->mTitle
);
2232 # Update links tables, site stats, etc.
2233 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed, $user );
2235 # Create new article
2236 $status->value
['new'] = true;
2238 # Set statistics members
2239 # We work out if it's countable after PST to avoid counter drift
2240 # when articles are created with {{subst:}}
2241 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2242 $this->mTotalAdjustment
= 1;
2246 # Add the page record; stake our claim on this title!
2247 # This will return false if the article already exists
2248 $newid = $this->insertOn( $dbw );
2250 if ( $newid === false ) {
2252 $status->fatal( 'edit-already-exists' );
2254 wfProfileOut( __METHOD__
);
2258 # Save the revision text...
2259 $revision = new Revision( array(
2261 'comment' => $summary,
2262 'minor_edit' => $isminor,
2264 'user' => $user->getId(),
2265 'user_text' => $user->getName(),
2268 $revisionId = $revision->insertOn( $dbw );
2270 $this->mTitle
->resetArticleID( $newid );
2272 # Update the page record with revision data
2273 $this->updateRevisionOn( $dbw, $revision, 0 );
2275 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2277 # Update recentchanges
2278 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2279 global $wgUseRCPatrol, $wgUseNPPatrol;
2281 # Mark as patrolled if the user can do so
2282 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
2283 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2284 # Add RC row to the DB
2285 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2286 '', strlen( $text ), $revisionId, $patrolled );
2288 # Log auto-patrolled edits
2290 PatrolLog
::record( $rc, true );
2293 $user->incEditCount();
2296 # Update links, etc.
2297 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true, $user );
2300 Article
::onArticleCreate( $this->mTitle
);
2302 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2303 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2306 # Do updates right now unless deferral was requested
2307 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2311 // Return the new revision (or null) to the caller
2312 $status->value
['revision'] = $revision;
2314 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2315 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2317 wfProfileOut( __METHOD__
);
2322 * Output a redirect back to the article.
2323 * This is typically used after an edit.
2325 * @param $noRedir Boolean: add redirect=no
2326 * @param $sectionAnchor String: section to redirect to, including "#"
2327 * @param $extraQuery String: extra query params
2329 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2333 $query = 'redirect=no';
2335 $query .= "&$extraQuery";
2337 $query = $extraQuery;
2340 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2344 * Mark this particular edit/page as patrolled
2346 public function markpatrolled() {
2347 global $wgOut, $wgUser, $wgRequest;
2349 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2351 # If we haven't been given an rc_id value, we can't do anything
2352 $rcid = (int) $wgRequest->getVal( 'rcid' );
2354 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2355 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2359 $rc = RecentChange
::newFromId( $rcid );
2361 if ( is_null( $rc ) ) {
2362 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2366 # It would be nice to see where the user had actually come from, but for now just guess
2367 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2368 $return = SpecialPage
::getTitleFor( $returnto );
2370 $errors = $rc->doMarkPatrolled();
2372 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2373 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2378 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2379 // The hook itself has handled any output
2383 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2384 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2385 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2386 $wgOut->returnToMain( false, $return );
2391 if ( !empty( $errors ) ) {
2392 $wgOut->showPermissionsErrorPage( $errors );
2398 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2399 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2400 $wgOut->returnToMain( false, $return );
2404 * User-interface handler for the "watch" action
2406 public function watch() {
2407 global $wgUser, $wgOut;
2409 if ( $wgUser->isAnon() ) {
2410 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2414 if ( wfReadOnly() ) {
2415 $wgOut->readOnlyPage();
2419 if ( $this->doWatch() ) {
2420 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2421 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2422 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2425 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2429 * Add this page to $wgUser's watchlist
2430 * @return bool true on successful watch operation
2432 public function doWatch() {
2435 if ( $wgUser->isAnon() ) {
2439 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2440 $wgUser->addWatch( $this->mTitle
);
2441 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2448 * User interface handler for the "unwatch" action.
2450 public function unwatch() {
2451 global $wgUser, $wgOut;
2453 if ( $wgUser->isAnon() ) {
2454 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2458 if ( wfReadOnly() ) {
2459 $wgOut->readOnlyPage();
2463 if ( $this->doUnwatch() ) {
2464 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2465 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2466 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2469 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2473 * Stop watching a page
2474 * @return bool true on successful unwatch
2476 public function doUnwatch() {
2479 if ( $wgUser->isAnon() ) {
2483 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2484 $wgUser->removeWatch( $this->mTitle
);
2485 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2492 * action=protect handler
2494 public function protect() {
2495 $form = new ProtectionForm( $this );
2500 * action=unprotect handler (alias)
2502 public function unprotect() {
2507 * Update the article's restriction field, and leave a log entry.
2509 * @param $limit Array: set of restriction keys
2510 * @param $reason String
2511 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2512 * @param $expiry Array: per restriction type expiration
2513 * @return bool true on success
2515 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2516 global $wgUser, $wgContLang;
2518 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2520 $id = $this->mTitle
->getArticleID();
2523 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
2527 if ( wfReadOnly() ) {
2528 wfDebug( "updateRestrictions failed: read-only\n" );
2532 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2533 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2541 // Take this opportunity to purge out expired restrictions
2542 Title
::purgeExpiredRestrictions();
2544 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2545 # we expect a single selection, but the schema allows otherwise.
2547 $updated = Article
::flattenRestrictions( $limit );
2550 foreach ( $restrictionTypes as $action ) {
2551 if ( isset( $expiry[$action] ) ) {
2552 # Get current restrictions on $action
2553 $aLimits = $this->mTitle
->getRestrictions( $action );
2554 $current[$action] = implode( '', $aLimits );
2555 # Are any actual restrictions being dealt with here?
2556 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2558 # If something changed, we need to log it. Checking $aRChanged
2559 # assures that "unprotecting" a page that is not protected does
2560 # not log just because the expiry was "changed".
2561 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2567 $current = Article
::flattenRestrictions( $current );
2569 $changed = ( $changed ||
$current != $updated );
2570 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2571 $protect = ( $updated != '' );
2573 # If nothing's changed, do nothing
2575 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2576 $dbw = wfGetDB( DB_MASTER
);
2578 # Prepare a null revision to be added to the history
2579 $modified = $current != '' && $protect;
2582 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2584 $comment_type = 'unprotectedarticle';
2587 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2589 # Only restrictions with the 'protect' right can cascade...
2590 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2591 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2593 # The schema allows multiple restrictions
2594 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2598 $cascade_description = '';
2601 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2605 $comment .= ": $reason";
2608 $editComment = $comment;
2609 $encodedExpiry = array();
2610 $protect_description = '';
2611 foreach ( $limit as $action => $restrictions ) {
2612 if ( !isset( $expiry[$action] ) )
2613 $expiry[$action] = Block
::infinity();
2615 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2616 if ( $restrictions != '' ) {
2617 $protect_description .= "[$action=$restrictions] (";
2618 if ( $encodedExpiry[$action] != 'infinity' ) {
2619 $protect_description .= wfMsgForContent( 'protect-expiring',
2620 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2621 $wgContLang->date( $expiry[$action], false, false ) ,
2622 $wgContLang->time( $expiry[$action], false, false ) );
2624 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2627 $protect_description .= ') ';
2630 $protect_description = trim( $protect_description );
2632 if ( $protect_description && $protect ) {
2633 $editComment .= " ($protect_description)";
2637 $editComment .= "$cascade_description";
2640 # Update restrictions table
2641 foreach ( $limit as $action => $restrictions ) {
2642 if ( $restrictions != '' ) {
2643 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2644 array( 'pr_page' => $id,
2645 'pr_type' => $action,
2646 'pr_level' => $restrictions,
2647 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2648 'pr_expiry' => $encodedExpiry[$action]
2653 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2654 'pr_type' => $action ), __METHOD__
);
2658 # Insert a null revision
2659 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2660 $nullRevId = $nullRevision->insertOn( $dbw );
2662 $latest = $this->getLatest();
2663 # Update page record
2664 $dbw->update( 'page',
2666 'page_touched' => $dbw->timestamp(),
2667 'page_restrictions' => '',
2668 'page_latest' => $nullRevId
2669 ), array( /* WHERE */
2671 ), 'Article::protect'
2674 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2675 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2677 # Update the protection log
2678 $log = new LogPage( 'protect' );
2680 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2681 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2683 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2686 } # End "changed" check
2692 * Take an array of page restrictions and flatten it to a string
2693 * suitable for insertion into the page_restrictions field.
2694 * @param $limit Array
2697 protected static function flattenRestrictions( $limit ) {
2698 if ( !is_array( $limit ) ) {
2699 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2705 foreach ( $limit as $action => $restrictions ) {
2706 if ( $restrictions != '' ) {
2707 $bits[] = "$action=$restrictions";
2711 return implode( ':', $bits );
2715 * Auto-generates a deletion reason
2717 * @param &$hasHistory Boolean: whether the page has a history
2718 * @return mixed String containing deletion reason or empty string, or boolean false
2719 * if no revision occurred
2721 public function generateReason( &$hasHistory ) {
2724 $dbw = wfGetDB( DB_MASTER
);
2725 // Get the last revision
2726 $rev = Revision
::newFromTitle( $this->mTitle
);
2728 if ( is_null( $rev ) ) {
2732 // Get the article's contents
2733 $contents = $rev->getText();
2736 // If the page is blank, use the text from the previous revision,
2737 // which can only be blank if there's a move/import/protect dummy revision involved
2738 if ( $contents == '' ) {
2739 $prev = $rev->getPrevious();
2742 $contents = $prev->getText();
2747 // Find out if there was only one contributor
2748 // Only scan the last 20 revisions
2749 $res = $dbw->select( 'revision', 'rev_user_text',
2750 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2752 array( 'LIMIT' => 20 )
2755 if ( $res === false ) {
2756 // This page has no revisions, which is very weird
2760 $hasHistory = ( $res->numRows() > 1 );
2761 $row = $dbw->fetchObject( $res );
2763 if ( $row ) { // $row is false if the only contributor is hidden
2764 $onlyAuthor = $row->rev_user_text
;
2765 // Try to find a second contributor
2766 foreach ( $res as $row ) {
2767 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2768 $onlyAuthor = false;
2773 $onlyAuthor = false;
2776 // Generate the summary with a '$1' placeholder
2778 // The current revision is blank and the one before is also
2779 // blank. It's just not our lucky day
2780 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2782 if ( $onlyAuthor ) {
2783 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2785 $reason = wfMsgForContent( 'excontent', '$1' );
2789 if ( $reason == '-' ) {
2790 // Allow these UI messages to be blanked out cleanly
2794 // Replace newlines with spaces to prevent uglyness
2795 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2796 // Calculate the maximum amount of chars to get
2797 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2798 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2799 $contents = $wgContLang->truncate( $contents, $maxLength );
2800 // Remove possible unfinished links
2801 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2802 // Now replace the '$1' placeholder
2803 $reason = str_replace( '$1', $contents, $reason );
2810 * UI entry point for page deletion
2812 public function delete() {
2813 global $wgUser, $wgOut, $wgRequest;
2815 $confirm = $wgRequest->wasPosted() &&
2816 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2818 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2819 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2821 $reason = $this->DeleteReasonList
;
2823 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2824 // Entry from drop down menu + additional comment
2825 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2826 } elseif ( $reason == 'other' ) {
2827 $reason = $this->DeleteReason
;
2830 # Flag to hide all contents of the archived revisions
2831 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2833 # This code desperately needs to be totally rewritten
2835 # Read-only check...
2836 if ( wfReadOnly() ) {
2837 $wgOut->readOnlyPage();
2843 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2845 if ( count( $permission_errors ) > 0 ) {
2846 $wgOut->showPermissionsErrorPage( $permission_errors );
2851 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2853 # Better double-check that it hasn't been deleted yet!
2854 $dbw = wfGetDB( DB_MASTER
);
2855 $conds = $this->mTitle
->pageCond();
2856 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2857 if ( $latest === false ) {
2858 $wgOut->showFatalError(
2861 array( 'class' => 'error mw-error-cannotdelete' ),
2862 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2865 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2866 LogEventsList
::showLogExtract(
2869 $this->mTitle
->getPrefixedText()
2875 # Hack for big sites
2876 $bigHistory = $this->isBigDeletion();
2877 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2878 global $wgLang, $wgDeleteRevisionsLimit;
2880 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2881 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2887 $this->doDelete( $reason, $suppress );
2889 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2891 } elseif ( $this->mTitle
->userIsWatching() ) {
2898 // Generate deletion reason
2899 $hasHistory = false;
2901 $reason = $this->generateReason( $hasHistory );
2904 // If the page has a history, insert a warning
2905 if ( $hasHistory && !$confirm ) {
2908 $skin = $wgUser->getSkin();
2909 $revisions = $this->estimateRevisionCount();
2911 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2912 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2913 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2917 if ( $bigHistory ) {
2918 global $wgDeleteRevisionsLimit;
2919 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2920 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2924 return $this->confirmDelete( $reason );
2928 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2930 public function isBigDeletion() {
2931 global $wgDeleteRevisionsLimit;
2933 if ( $wgDeleteRevisionsLimit ) {
2934 $revCount = $this->estimateRevisionCount();
2936 return $revCount > $wgDeleteRevisionsLimit;
2943 * @return int approximate revision count
2945 public function estimateRevisionCount() {
2946 $dbr = wfGetDB( DB_SLAVE
);
2948 // For an exact count...
2949 // return $dbr->selectField( 'revision', 'COUNT(*)',
2950 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2951 return $dbr->estimateRowCount( 'revision', '*',
2952 array( 'rev_page' => $this->getId() ), __METHOD__
);
2956 * Get the last N authors
2957 * @param $num Integer: number of revisions to get
2958 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2959 * @return array Array of authors, duplicates not removed
2961 public function getLastNAuthors( $num, $revLatest = 0 ) {
2962 wfProfileIn( __METHOD__
);
2963 // First try the slave
2964 // If that doesn't have the latest revision, try the master
2966 $db = wfGetDB( DB_SLAVE
);
2969 $res = $db->select( array( 'page', 'revision' ),
2970 array( 'rev_id', 'rev_user_text' ),
2972 'page_namespace' => $this->mTitle
->getNamespace(),
2973 'page_title' => $this->mTitle
->getDBkey(),
2974 'rev_page = page_id'
2975 ), __METHOD__
, $this->getSelectOptions( array(
2976 'ORDER BY' => 'rev_timestamp DESC',
2982 wfProfileOut( __METHOD__
);
2986 $row = $db->fetchObject( $res );
2988 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2989 $db = wfGetDB( DB_MASTER
);
2994 } while ( $continue );
2996 $authors = array( $row->rev_user_text
);
2998 foreach ( $res as $row ) {
2999 $authors[] = $row->rev_user_text
;
3002 wfProfileOut( __METHOD__
);
3007 * Output deletion confirmation dialog
3008 * FIXME: Move to another file?
3009 * @param $reason String: prefilled reason
3011 public function confirmDelete( $reason ) {
3012 global $wgOut, $wgUser;
3014 wfDebug( "Article::confirmDelete\n" );
3016 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3017 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3018 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3019 $wgOut->addWikiMsg( 'confirmdeletetext' );
3021 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3023 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3024 $suppress = "<tr id=\"wpDeleteSuppressRow\">
3026 <td class='mw-input'><strong>" .
3027 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3028 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3034 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3036 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3037 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3038 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3039 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3040 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3041 "<tr id=\"wpDeleteReasonListRow\">
3042 <td class='mw-label'>" .
3043 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3045 <td class='mw-input'>" .
3046 Xml
::listDropDown( 'wpDeleteReasonList',
3047 wfMsgForContent( 'deletereason-dropdown' ),
3048 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3051 <tr id=\"wpDeleteReasonRow\">
3052 <td class='mw-label'>" .
3053 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3055 <td class='mw-input'>" .
3056 Html
::input( 'wpReason', $reason, 'text', array(
3058 'maxlength' => '255',
3066 # Disallow watching if user is not logged in
3067 if ( $wgUser->isLoggedIn() ) {
3071 <td class='mw-input'>" .
3072 Xml
::checkLabel( wfMsg( 'watchthis' ),
3073 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3082 <td class='mw-submit'>" .
3083 Xml
::submitButton( wfMsg( 'deletepage' ),
3084 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3087 Xml
::closeElement( 'table' ) .
3088 Xml
::closeElement( 'fieldset' ) .
3089 Html
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3090 Xml
::closeElement( 'form' );
3092 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3093 $skin = $wgUser->getSkin();
3094 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3095 $link = $skin->link(
3097 wfMsgHtml( 'delete-edit-reasonlist' ),
3099 array( 'action' => 'edit' )
3101 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3104 $wgOut->addHTML( $form );
3105 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3106 LogEventsList
::showLogExtract( $wgOut, 'delete',
3107 $this->mTitle
->getPrefixedText()
3112 * Perform a deletion and output success or failure messages
3114 public function doDelete( $reason, $suppress = false ) {
3115 global $wgOut, $wgUser;
3117 $id = $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3120 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3121 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3122 $deleted = $this->mTitle
->getPrefixedText();
3124 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3125 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3127 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3129 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3130 $wgOut->returnToMain( false );
3131 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3134 if ( $error == '' ) {
3135 $wgOut->showFatalError(
3138 array( 'class' => 'error mw-error-cannotdelete' ),
3139 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3143 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3145 LogEventsList
::showLogExtract(
3148 $this->mTitle
->getPrefixedText()
3151 $wgOut->showFatalError( $error );
3157 * Back-end article deletion
3158 * Deletes the article with database consistency, writes logs, purges caches
3160 * @param $reason string delete reason for deletion log
3161 * @param suppress bitfield
3162 * Revision::DELETED_TEXT
3163 * Revision::DELETED_COMMENT
3164 * Revision::DELETED_USER
3165 * Revision::DELETED_RESTRICTED
3166 * @param $id int article ID
3167 * @param $commit boolean defaults to true, triggers transaction end
3168 * @return boolean true if successful
3170 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3171 global $wgDeferredUpdateList, $wgUseTrackbacks;
3173 wfDebug( __METHOD__
. "\n" );
3175 $dbw = wfGetDB( DB_MASTER
);
3176 $t = $this->mTitle
->getDBkey();
3177 $id = $id ?
$id : $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3179 if ( $t === '' ||
$id == 0 ) {
3183 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3184 array_push( $wgDeferredUpdateList, $u );
3186 // Bitfields to further suppress the content
3189 // This should be 15...
3190 $bitfield |
= Revision
::DELETED_TEXT
;
3191 $bitfield |
= Revision
::DELETED_COMMENT
;
3192 $bitfield |
= Revision
::DELETED_USER
;
3193 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3195 $bitfield = 'rev_deleted';
3199 // For now, shunt the revision data into the archive table.
3200 // Text is *not* removed from the text table; bulk storage
3201 // is left intact to avoid breaking block-compression or
3202 // immutable storage schemes.
3204 // For backwards compatibility, note that some older archive
3205 // table entries will have ar_text and ar_flags fields still.
3207 // In the future, we may keep revisions and mark them with
3208 // the rev_deleted field, which is reserved for this purpose.
3209 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3211 'ar_namespace' => 'page_namespace',
3212 'ar_title' => 'page_title',
3213 'ar_comment' => 'rev_comment',
3214 'ar_user' => 'rev_user',
3215 'ar_user_text' => 'rev_user_text',
3216 'ar_timestamp' => 'rev_timestamp',
3217 'ar_minor_edit' => 'rev_minor_edit',
3218 'ar_rev_id' => 'rev_id',
3219 'ar_text_id' => 'rev_text_id',
3220 'ar_text' => '\'\'', // Be explicit to appease
3221 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3222 'ar_len' => 'rev_len',
3223 'ar_page_id' => 'page_id',
3224 'ar_deleted' => $bitfield
3227 'page_id = rev_page'
3231 # Delete restrictions for it
3232 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3234 # Now that it's safely backed up, delete it
3235 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3236 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3243 # Fix category table counts
3245 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3247 foreach ( $res as $row ) {
3248 $cats [] = $row->cl_to
;
3251 $this->updateCategoryCounts( array(), $cats );
3253 # If using cascading deletes, we can skip some explicit deletes
3254 if ( !$dbw->cascadingDeletes() ) {
3255 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3257 if ( $wgUseTrackbacks )
3258 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3260 # Delete outgoing links
3261 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3262 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3263 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3264 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3265 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3266 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3267 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3270 # If using cleanup triggers, we can skip some manual deletes
3271 if ( !$dbw->cleanupTriggers() ) {
3272 # Clean up recentchanges entries...
3273 $dbw->delete( 'recentchanges',
3274 array( 'rc_type != ' . RC_LOG
,
3275 'rc_namespace' => $this->mTitle
->getNamespace(),
3276 'rc_title' => $this->mTitle
->getDBkey() ),
3278 $dbw->delete( 'recentchanges',
3279 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3284 Article
::onArticleDelete( $this->mTitle
);
3286 # Clear the cached article id so the interface doesn't act like we exist
3287 $this->mTitle
->resetArticleID( 0 );
3289 # Log the deletion, if the page was suppressed, log it at Oversight instead
3290 $logtype = $suppress ?
'suppress' : 'delete';
3291 $log = new LogPage( $logtype );
3293 # Make sure logging got through
3294 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3304 * Roll back the most recent consecutive set of edits to a page
3305 * from the same user; fails if there are no eligible edits to
3306 * roll back to, e.g. user is the sole contributor. This function
3307 * performs permissions checks on $wgUser, then calls commitRollback()
3308 * to do the dirty work
3310 * @param $fromP String: Name of the user whose edits to rollback.
3311 * @param $summary String: Custom summary. Set to default summary if empty.
3312 * @param $token String: Rollback token.
3313 * @param $bot Boolean: If true, mark all reverted edits as bot.
3315 * @param $resultDetails Array: contains result-specific array of additional values
3316 * 'alreadyrolled' : 'current' (rev)
3317 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3319 * @return array of errors, each error formatted as
3320 * array(messagekey, param1, param2, ...).
3321 * On success, the array is empty. This array can also be passed to
3322 * OutputPage::showPermissionsErrorPage().
3324 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3327 $resultDetails = null;
3330 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3331 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3332 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3334 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3335 $errors[] = array( 'sessionfailure' );
3338 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3339 $errors[] = array( 'actionthrottledtext' );
3342 # If there were errors, bail out now
3343 if ( !empty( $errors ) ) {
3347 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3351 * Backend implementation of doRollback(), please refer there for parameter
3352 * and return value documentation
3354 * NOTE: This function does NOT check ANY permissions, it just commits the
3355 * rollback to the DB Therefore, you should only call this function direct-
3356 * ly if you want to use custom permissions checks. If you don't, use
3357 * doRollback() instead.
3359 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3360 global $wgUseRCPatrol, $wgUser, $wgLang;
3362 $dbw = wfGetDB( DB_MASTER
);
3364 if ( wfReadOnly() ) {
3365 return array( array( 'readonlytext' ) );
3368 # Get the last editor
3369 $current = Revision
::newFromTitle( $this->mTitle
);
3370 if ( is_null( $current ) ) {
3371 # Something wrong... no page?
3372 return array( array( 'notanarticle' ) );
3375 $from = str_replace( '_', ' ', $fromP );
3376 # User name given should match up with the top revision.
3377 # If the user was deleted then $from should be empty.
3378 if ( $from != $current->getUserText() ) {
3379 $resultDetails = array( 'current' => $current );
3380 return array( array( 'alreadyrolled',
3381 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3382 htmlspecialchars( $fromP ),
3383 htmlspecialchars( $current->getUserText() )
3387 # Get the last edit not by this guy...
3388 # Note: these may not be public values
3389 $user = intval( $current->getRawUser() );
3390 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3391 $s = $dbw->selectRow( 'revision',
3392 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3393 array( 'rev_page' => $current->getPage(),
3394 "rev_user != {$user} OR rev_user_text != {$user_text}"
3396 array( 'USE INDEX' => 'page_timestamp',
3397 'ORDER BY' => 'rev_timestamp DESC' )
3399 if ( $s === false ) {
3400 # No one else ever edited this page
3401 return array( array( 'cantrollback' ) );
3402 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3403 # Only admins can see this text
3404 return array( array( 'notvisiblerev' ) );
3408 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3409 # Mark all reverted edits as bot
3413 if ( $wgUseRCPatrol ) {
3414 # Mark all reverted edits as patrolled
3415 $set['rc_patrolled'] = 1;
3418 if ( count( $set ) ) {
3419 $dbw->update( 'recentchanges', $set,
3421 'rc_cur_id' => $current->getPage(),
3422 'rc_user_text' => $current->getUserText(),
3423 "rc_timestamp > '{$s->rev_timestamp}'",
3428 # Generate the edit summary if necessary
3429 $target = Revision
::newFromId( $s->rev_id
);
3430 if ( empty( $summary ) ) {
3431 if ( $from == '' ) { // no public user name
3432 $summary = wfMsgForContent( 'revertpage-nouser' );
3434 $summary = wfMsgForContent( 'revertpage' );
3438 # Allow the custom summary to use the same args as the default message
3440 $target->getUserText(), $from, $s->rev_id
,
3441 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3442 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3444 $summary = wfMsgReplaceArgs( $summary, $args );
3447 $flags = EDIT_UPDATE
;
3449 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3450 $flags |
= EDIT_MINOR
;
3453 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3454 $flags |
= EDIT_FORCE_BOT
;
3457 # Actually store the edit
3458 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3459 if ( !empty( $status->value
['revision'] ) ) {
3460 $revId = $status->value
['revision']->getId();
3465 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3467 $resultDetails = array(
3468 'summary' => $summary,
3469 'current' => $current,
3470 'target' => $target,
3478 * User interface for rollback operations
3480 public function rollback() {
3481 global $wgUser, $wgOut, $wgRequest;
3485 $result = $this->doRollback(
3486 $wgRequest->getVal( 'from' ),
3487 $wgRequest->getText( 'summary' ),
3488 $wgRequest->getVal( 'token' ),
3489 $wgRequest->getBool( 'bot' ),
3493 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3494 $wgOut->rateLimited();
3498 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3499 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3500 $errArray = $result[0];
3501 $errMsg = array_shift( $errArray );
3502 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3504 if ( isset( $details['current'] ) ) {
3505 $current = $details['current'];
3507 if ( $current->getComment() != '' ) {
3508 $wgOut->addWikiMsgArray( 'editcomment', array(
3509 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3516 # Display permissions errors before read-only message -- there's no
3517 # point in misleading the user into thinking the inability to rollback
3518 # is only temporary.
3519 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3520 # array_diff is completely broken for arrays of arrays, sigh.
3521 # Remove any 'readonlytext' error manually.
3523 foreach ( $result as $error ) {
3524 if ( $error != array( 'readonlytext' ) ) {
3528 $wgOut->showPermissionsErrorPage( $out );
3533 if ( $result == array( array( 'readonlytext' ) ) ) {
3534 $wgOut->readOnlyPage();
3539 $current = $details['current'];
3540 $target = $details['target'];
3541 $newId = $details['newid'];
3542 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3543 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3545 if ( $current->getUserText() === '' ) {
3546 $old = wfMsg( 'rev-deleted-user' );
3548 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3549 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3552 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3553 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3554 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3555 $wgOut->returnToMain( false, $this->mTitle
);
3557 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3558 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3559 $de->showDiff( '', '' );
3564 * Do standard deferred updates after page view
3566 public function viewUpdates() {
3567 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3568 if ( wfReadOnly() ) {
3572 # Don't update page view counters on views from bot users (bug 14044)
3573 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3574 $wgDeferredUpdateList[] = new ViewCountUpdate( $this->getID() );
3575 $wgDeferredUpdateList[] = new SiteStatsUpdate( 1, 0, 0 );
3578 # Update newtalk / watchlist notification status
3579 $wgUser->clearNotification( $this->mTitle
);
3583 * Prepare text which is about to be saved.
3584 * Returns a stdclass with source, pst and output members
3586 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
3587 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3589 return $this->mPreparedEdit
;
3594 $edit = (object)array();
3595 $edit->revid
= $revid;
3596 $edit->newText
= $text;
3597 $edit->pst
= $this->preSaveTransform( $text, $user );
3598 $edit->popts
= $this->getParserOptions( true );
3599 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
3600 $edit->oldText
= $this->getRawText();
3602 $this->mPreparedEdit
= $edit;
3608 * Do standard deferred updates after page edit.
3609 * Update links tables, site stats, search index and message cache.
3610 * Purges pages that include this page if the text was changed here.
3611 * Every 100th edit, prune the recent changes table.
3614 * @param $text String: New text of the article
3615 * @param $summary String: Edit summary
3616 * @param $minoredit Boolean: Minor edit
3617 * @param $timestamp_of_pagechange String timestamp associated with the page change
3618 * @param $newid Integer: rev_id value of the new revision
3619 * @param $changed Boolean: Whether or not the content actually changed
3620 * @param $user User object: User doing the edit
3622 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true, User
$user = null ) {
3623 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3625 wfProfileIn( __METHOD__
);
3628 # Be careful not to double-PST: $text is usually already PST-ed once
3629 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3630 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3631 $editInfo = $this->prepareTextForEdit( $text, $newid, $user );
3633 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3634 $editInfo = $this->mPreparedEdit
;
3637 # Save it to the parser cache
3638 if ( $wgEnableParserCache ) {
3639 $parserCache = ParserCache
::singleton();
3640 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
3643 # Update the links tables
3644 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3647 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3649 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3650 if ( 0 == mt_rand( 0, 99 ) ) {
3651 // Flush old entries from the `recentchanges` table; we do this on
3652 // random requests so as to avoid an increase in writes for no good reason
3655 $dbw = wfGetDB( DB_MASTER
);
3656 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3657 $recentchanges = $dbw->tableName( 'recentchanges' );
3658 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3660 $dbw->query( $sql );
3664 $id = $this->getID();
3665 $title = $this->mTitle
->getPrefixedDBkey();
3666 $shortTitle = $this->mTitle
->getDBkey();
3669 wfProfileOut( __METHOD__
);
3673 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3674 array_push( $wgDeferredUpdateList, $u );
3675 $u = new SearchUpdate( $id, $title, $text );
3676 array_push( $wgDeferredUpdateList, $u );
3678 # If this is another user's talk page, update newtalk
3679 # Don't do this if $changed = false otherwise some idiot can null-edit a
3680 # load of user talk pages and piss people off, nor if it's a minor edit
3681 # by a properly-flagged bot.
3682 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3683 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3685 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3686 $other = User
::newFromName( $shortTitle, false );
3688 wfDebug( __METHOD__
. ": invalid username\n" );
3689 } elseif ( User
::isIP( $shortTitle ) ) {
3690 // An anonymous user
3691 $other->setNewtalk( true );
3692 } elseif ( $other->isLoggedIn() ) {
3693 $other->setNewtalk( true );
3695 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3700 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3701 $wgMessageCache->replace( $shortTitle, $text );
3704 wfProfileOut( __METHOD__
);
3708 * Perform article updates on a special page creation.
3710 * @param $rev Revision object
3712 * @todo This is a shitty interface function. Kill it and replace the
3713 * other shitty functions like editUpdates and such so it's not needed
3716 public function createUpdates( $rev ) {
3717 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3718 $this->mTotalAdjustment
= 1;
3719 $this->editUpdates( $rev->getText(), $rev->getComment(),
3720 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3724 * Generate the navigation links when browsing through an article revisions
3725 * It shows the information as:
3726 * Revision as of \<date\>; view current revision
3727 * \<- Previous version | Next Version -\>
3729 * @param $oldid String: revision ID of this article revision
3731 public function setOldSubtitle( $oldid = 0 ) {
3732 global $wgLang, $wgOut, $wgUser, $wgRequest;
3734 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3738 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3740 # Cascade unhide param in links for easy deletion browsing
3741 $extraParams = array();
3742 if ( $wgRequest->getVal( 'unhide' ) ) {
3743 $extraParams['unhide'] = 1;
3746 $revision = Revision
::newFromId( $oldid );
3748 $current = ( $oldid == $this->mLatest
);
3749 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3750 $tddate = $wgLang->date( $this->mTimestamp
, true );
3751 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3752 $sk = $wgUser->getSkin();
3754 ?
wfMsgHtml( 'currentrevisionlink' )
3757 wfMsgHtml( 'currentrevisionlink' ),
3760 array( 'known', 'noclasses' )
3763 ?
wfMsgHtml( 'diff' )
3766 wfMsgHtml( 'diff' ),
3772 array( 'known', 'noclasses' )
3774 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3778 wfMsgHtml( 'previousrevision' ),
3781 'direction' => 'prev',
3784 array( 'known', 'noclasses' )
3786 : wfMsgHtml( 'previousrevision' );
3790 wfMsgHtml( 'diff' ),
3796 array( 'known', 'noclasses' )
3798 : wfMsgHtml( 'diff' );
3799 $nextlink = $current
3800 ?
wfMsgHtml( 'nextrevision' )
3803 wfMsgHtml( 'nextrevision' ),
3806 'direction' => 'next',
3809 array( 'known', 'noclasses' )
3811 $nextdiff = $current
3812 ?
wfMsgHtml( 'diff' )
3815 wfMsgHtml( 'diff' ),
3821 array( 'known', 'noclasses' )
3826 // User can delete revisions or view deleted revisions...
3827 $canHide = $wgUser->isAllowed( 'deleterevision' );
3828 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3829 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3830 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3833 'type' => 'revision',
3834 'target' => $this->mTitle
->getPrefixedDbkey(),
3837 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3842 # Show user links if allowed to see them. If hidden, then show them only if requested...
3843 $userlinks = $sk->revUserTools( $revision, !$unhide );
3845 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
3846 ?
'revision-info-current'
3849 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3852 array( 'parseinline', 'replaceafter' ),
3858 $revision->getUser()
3861 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3862 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3864 $wgOut->setSubtitle( $r );
3868 * This function is called right before saving the wikitext,
3869 * so we can do things like signatures and links-in-context.
3871 * @param $text String article contents
3872 * @param $user User object: user doing the edit, $wgUser will be used if
3874 * @return string article contents with altered wikitext markup (signatures
3875 * converted, {{subst:}}, templates, etc.)
3877 public function preSaveTransform( $text, User
$user = null ) {
3880 if ( $user === null ) {
3885 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, ParserOptions
::newFromUser( $user ) );
3888 /* Caching functions */
3891 * checkLastModified returns true if it has taken care of all
3892 * output to the client that is necessary for this request.
3893 * (that is, it has sent a cached version of the page)
3895 * @return boolean true if cached version send, false otherwise
3897 protected function tryFileCache() {
3898 static $called = false;
3901 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3906 if ( $this->isFileCacheable() ) {
3907 $cache = new HTMLFileCache( $this->mTitle
);
3908 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3909 wfDebug( "Article::tryFileCache(): about to load file\n" );
3910 $cache->loadFromFileCache();
3913 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3914 ob_start( array( &$cache, 'saveToFileCache' ) );
3917 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3924 * Check if the page can be cached
3927 public function isFileCacheable() {
3930 if ( HTMLFileCache
::useFileCache() ) {
3931 $cacheable = $this->getID() && !$this->mRedirectedFrom
&& !$this->mTitle
->isRedirect();
3932 // Extension may have reason to disable file caching on some pages.
3934 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3942 * Loads page_touched and returns a value indicating if it should be used
3943 * @return boolean true if not a redirect
3945 public function checkTouched() {
3946 if ( !$this->mDataLoaded
) {
3947 $this->loadPageData();
3950 return !$this->mIsRedirect
;
3954 * Get the page_touched field
3955 * @return string containing GMT timestamp
3957 public function getTouched() {
3958 if ( !$this->mDataLoaded
) {
3959 $this->loadPageData();
3962 return $this->mTouched
;
3966 * Get the page_latest field
3967 * @return integer rev_id of current revision
3969 public function getLatest() {
3970 if ( !$this->mDataLoaded
) {
3971 $this->loadPageData();
3974 return (int)$this->mLatest
;
3978 * Edit an article without doing all that other stuff
3979 * The article must already exist; link tables etc
3980 * are not updated, caches are not flushed.
3982 * @param $text String: text submitted
3983 * @param $comment String: comment submitted
3984 * @param $minor Boolean: whereas it's a minor modification
3986 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3987 wfProfileIn( __METHOD__
);
3989 $dbw = wfGetDB( DB_MASTER
);
3990 $revision = new Revision( array(
3991 'page' => $this->getId(),
3993 'comment' => $comment,
3994 'minor_edit' => $minor ?
1 : 0,
3996 $revision->insertOn( $dbw );
3997 $this->updateRevisionOn( $dbw, $revision );
4000 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4002 wfProfileOut( __METHOD__
);
4006 * The onArticle*() functions are supposed to be a kind of hooks
4007 * which should be called whenever any of the specified actions
4010 * This is a good place to put code to clear caches, for instance.
4012 * This is called on page move and undelete, as well as edit
4014 * @param $title Title object
4016 public static function onArticleCreate( $title ) {
4017 # Update existence markers on article/talk tabs...
4018 if ( $title->isTalkPage() ) {
4019 $other = $title->getSubjectPage();
4021 $other = $title->getTalkPage();
4024 $other->invalidateCache();
4025 $other->purgeSquid();
4027 $title->touchLinks();
4028 $title->purgeSquid();
4029 $title->deleteTitleProtection();
4033 * Clears caches when article is deleted
4035 public static function onArticleDelete( $title ) {
4036 global $wgMessageCache;
4038 # Update existence markers on article/talk tabs...
4039 if ( $title->isTalkPage() ) {
4040 $other = $title->getSubjectPage();
4042 $other = $title->getTalkPage();
4045 $other->invalidateCache();
4046 $other->purgeSquid();
4048 $title->touchLinks();
4049 $title->purgeSquid();
4052 HTMLFileCache
::clearFileCache( $title );
4055 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4056 $wgMessageCache->replace( $title->getDBkey(), false );
4060 if ( $title->getNamespace() == NS_FILE
) {
4061 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4062 $update->doUpdate();
4066 if ( $title->getNamespace() == NS_USER_TALK
) {
4067 $user = User
::newFromName( $title->getText(), false );
4068 $user->setNewtalk( false );
4072 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4076 * Purge caches on page update etc
4078 * @param $title Title object
4079 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4081 public static function onArticleEdit( $title ) {
4082 global $wgDeferredUpdateList;
4084 // Invalidate caches of articles which include this page
4085 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4087 // Invalidate the caches of all pages which redirect here
4088 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4090 # Purge squid for this page only
4091 $title->purgeSquid();
4093 # Clear file cache for this page only
4094 HTMLFileCache
::clearFileCache( $title );
4100 * Overriden by ImagePage class, only present here to avoid a fatal error
4101 * Called for ?action=revert
4103 public function revert() {
4105 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4109 * Info about this page
4110 * Called for ?action=info when $wgAllowPageInfo is on.
4112 public function info() {
4113 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4115 if ( !$wgAllowPageInfo ) {
4116 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4120 $page = $this->mTitle
->getSubjectPage();
4122 $wgOut->setPagetitle( $page->getPrefixedText() );
4123 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4124 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4126 if ( !$this->mTitle
->exists() ) {
4127 $wgOut->addHTML( '<div class="noarticletext">' );
4128 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4129 // This doesn't quite make sense; the user is asking for
4130 // information about the _page_, not the message... -- RC
4131 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4133 $msg = $wgUser->isLoggedIn()
4135 : 'noarticletextanon';
4136 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4139 $wgOut->addHTML( '</div>' );
4141 $dbr = wfGetDB( DB_SLAVE
);
4143 'wl_title' => $page->getDBkey(),
4144 'wl_namespace' => $page->getNamespace() );
4145 $numwatchers = $dbr->selectField(
4150 $this->getSelectOptions() );
4152 $pageInfo = $this->pageCountInfo( $page );
4153 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4156 //FIXME: unescaped messages
4157 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4158 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4161 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4164 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4167 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4170 $wgOut->addHTML( '</ul>' );
4175 * Return the total number of edits and number of unique editors
4176 * on a given page. If page does not exist, returns false.
4178 * @param $title Title object
4179 * @return mixed array or boolean false
4181 public function pageCountInfo( $title ) {
4182 $id = $title->getArticleId();
4188 $dbr = wfGetDB( DB_SLAVE
);
4189 $rev_clause = array( 'rev_page' => $id );
4190 $edits = $dbr->selectField(
4195 $this->getSelectOptions()
4197 $authors = $dbr->selectField(
4199 'COUNT(DISTINCT rev_user_text)',
4202 $this->getSelectOptions()
4205 return array( 'edits' => $edits, 'authors' => $authors );
4209 * Return a list of templates used by this article.
4210 * Uses the templatelinks table
4212 * @return Array of Title objects
4214 public function getUsedTemplates() {
4216 $id = $this->mTitle
->getArticleID();
4222 $dbr = wfGetDB( DB_SLAVE
);
4223 $res = $dbr->select( array( 'templatelinks' ),
4224 array( 'tl_namespace', 'tl_title' ),
4225 array( 'tl_from' => $id ),
4228 if ( $res !== false ) {
4229 foreach ( $res as $row ) {
4230 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4238 * Returns a list of hidden categories this page is a member of.
4239 * Uses the page_props and categorylinks tables.
4241 * @return Array of Title objects
4243 public function getHiddenCategories() {
4245 $id = $this->mTitle
->getArticleID();
4251 $dbr = wfGetDB( DB_SLAVE
);
4252 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4254 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4255 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4258 if ( $res !== false ) {
4259 foreach ( $res as $row ) {
4260 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4268 * Return an applicable autosummary if one exists for the given edit.
4269 * @param $oldtext String: the previous text of the page.
4270 * @param $newtext String: The submitted text of the page.
4271 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
4272 * @return string An appropriate autosummary, or an empty string.
4274 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4277 # Decide what kind of autosummary is needed.
4279 # Redirect autosummaries
4280 $ot = Title
::newFromRedirect( $oldtext );
4281 $rt = Title
::newFromRedirect( $newtext );
4283 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4284 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4287 # New page autosummaries
4288 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4289 # If they're making a new article, give its text, truncated, in the summary.
4291 $truncatedtext = $wgContLang->truncate(
4292 str_replace( "\n", ' ', $newtext ),
4293 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4295 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4298 # Blanking autosummaries
4299 if ( $oldtext != '' && $newtext == '' ) {
4300 return wfMsgForContent( 'autosumm-blank' );
4301 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4302 # Removing more than 90% of the article
4304 $truncatedtext = $wgContLang->truncate(
4306 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4308 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4311 # If we reach this point, there's no applicable autosummary for our case, so our
4312 # autosummary is empty.
4317 * Add the primary page-view wikitext to the output buffer
4318 * Saves the text into the parser cache if possible.
4319 * Updates templatelinks if it is out of date.
4321 * @param $text String
4322 * @param $cache Boolean
4323 * @param $parserOptions mixed ParserOptions object, or boolean false
4325 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4328 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4329 $wgOut->addParserOutput( $this->mParserOutput
);
4333 * This does all the heavy lifting for outputWikitext, except it returns the parser
4334 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4335 * say, embedding thread pages within a discussion system (LiquidThreads)
4337 * @param $text string
4338 * @param $cache boolean
4339 * @param $parserOptions parsing options, defaults to false
4340 * @return string containing parsed output
4342 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4343 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4345 if ( !$parserOptions ) {
4346 $parserOptions = $this->getParserOptions();
4350 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4351 $parserOptions, true, true, $this->getRevIdFetched() );
4356 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4357 $this->mTitle
->getPrefixedDBkey() ) );
4360 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4361 $parserCache = ParserCache
::singleton();
4362 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4365 // Make sure file cache is not used on uncacheable content.
4366 // Output that has magic words in it can still use the parser cache
4367 // (if enabled), though it will generally expire sooner.
4368 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4369 $wgUseFileCache = false;
4372 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4374 return $this->mParserOutput
;
4378 * Get parser options suitable for rendering the primary article wikitext
4379 * @param $canonical boolean Determines that the generated must not depend on user preferences (see bug 14404)
4380 * @return mixed ParserOptions object or boolean false
4382 public function getParserOptions( $canonical = false ) {
4383 global $wgUser, $wgLanguageCode;
4385 if ( !$this->mParserOptions ||
$canonical ) {
4386 $user = !$canonical ?
$wgUser : new User
;
4387 $parserOptions = new ParserOptions( $user );
4388 $parserOptions->setTidy( true );
4389 $parserOptions->enableLimitReport();
4392 $parserOptions->setUserLang( $wgLanguageCode ); # Must be set explicitely
4393 return $parserOptions;
4395 $this->mParserOptions
= $parserOptions;
4398 // Clone to allow modifications of the return value without affecting
4400 return clone $this->mParserOptions
;
4404 * Updates cascading protections
4406 * @param $parserOutput mixed ParserOptions object, or boolean false
4408 protected function doCascadeProtectionUpdates( $parserOutput ) {
4409 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4413 // templatelinks table may have become out of sync,
4414 // especially if using variable-based transclusions.
4415 // For paranoia, check if things have changed and if
4416 // so apply updates to the database. This will ensure
4417 // that cascaded protections apply as soon as the changes
4420 # Get templates from templatelinks
4421 $id = $this->mTitle
->getArticleID();
4423 $tlTemplates = array();
4425 $dbr = wfGetDB( DB_SLAVE
);
4426 $res = $dbr->select( array( 'templatelinks' ),
4427 array( 'tl_namespace', 'tl_title' ),
4428 array( 'tl_from' => $id ),
4432 foreach ( $res as $row ) {
4433 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4436 # Get templates from parser output.
4437 $poTemplates = array();
4438 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4439 foreach ( $templates as $dbk => $id ) {
4440 $poTemplates["$ns:$dbk"] = true;
4445 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4447 if ( count( $templates_diff ) > 0 ) {
4448 # Whee, link updates time.
4449 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4455 * Update all the appropriate counts in the category table, given that
4456 * we've added the categories $added and deleted the categories $deleted.
4458 * @param $added array The names of categories that were added
4459 * @param $deleted array The names of categories that were deleted
4461 public function updateCategoryCounts( $added, $deleted ) {
4462 $ns = $this->mTitle
->getNamespace();
4463 $dbw = wfGetDB( DB_MASTER
);
4465 # First make sure the rows exist. If one of the "deleted" ones didn't
4466 # exist, we might legitimately not create it, but it's simpler to just
4467 # create it and then give it a negative value, since the value is bogus
4470 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4471 $insertCats = array_merge( $added, $deleted );
4472 if ( !$insertCats ) {
4473 # Okay, nothing to do
4477 $insertRows = array();
4479 foreach ( $insertCats as $cat ) {
4480 $insertRows[] = array(
4481 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4485 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4487 $addFields = array( 'cat_pages = cat_pages + 1' );
4488 $removeFields = array( 'cat_pages = cat_pages - 1' );
4490 if ( $ns == NS_CATEGORY
) {
4491 $addFields[] = 'cat_subcats = cat_subcats + 1';
4492 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4493 } elseif ( $ns == NS_FILE
) {
4494 $addFields[] = 'cat_files = cat_files + 1';
4495 $removeFields[] = 'cat_files = cat_files - 1';
4502 array( 'cat_title' => $added ),
4511 array( 'cat_title' => $deleted ),
4518 * Lightweight method to get the parser output for a page, checking the parser cache
4519 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4520 * consider, so it's not appropriate to use there.
4522 * @since 1.16 (r52326) for LiquidThreads
4524 * @param $oldid mixed integer Revision ID or null
4525 * @return ParserOutput
4527 public function getParserOutput( $oldid = null ) {
4528 global $wgEnableParserCache, $wgUser;
4530 // Should the parser cache be used?
4531 $useParserCache = $wgEnableParserCache &&
4532 $wgUser->getStubThreshold() == 0 &&
4536 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4538 if ( $wgUser->getStubThreshold() ) {
4539 wfIncrStats( 'pcache_miss_stub' );
4542 $parserOutput = false;
4543 if ( $useParserCache ) {
4544 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4547 if ( $parserOutput === false ) {
4548 // Cache miss; parse and output it.
4549 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4551 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4553 return $parserOutput;
4559 class PoolWorkArticleView
extends PoolCounterWork
{
4562 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4563 parent
::__construct( 'ArticleView', $key );
4564 $this->mArticle
= $article;
4565 $this->cacheable
= $useParserCache;
4566 $this->parserOptions
= $parserOptions;
4570 return $this->mArticle
->doViewParse();
4573 function getCachedWork() {
4576 $parserCache = ParserCache
::singleton();
4577 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
4579 if ( $this->mArticle
->mParserOutput
!== false ) {
4580 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
4581 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
4582 # Ensure that UI elements requiring revision ID have
4583 # the correct version information.
4584 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
4590 function fallback() {
4591 return $this->mArticle
->tryDirtyCache();
4594 function error( $status ) {
4597 $wgOut->clearHTML(); // for release() errors
4598 $wgOut->enableClientCache( false );
4599 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4601 $errortext = $status->getWikiText( false, 'view-pool-error' );
4602 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );