8 * Class representing a MediaWiki article and history.
10 * See design.txt for an overview.
11 * Note: edit user interface and cache support functions have been
12 * moved to separate EditPage and HTMLFileCache classes.
14 * @internal documentation reviewed 15 Mar 2010
20 var $mComment = ''; // !<
22 var $mContentLoaded = false; // !<
23 var $mCounter = -1; // !< Not loaded
24 var $mCurID = -1; // !< Not loaded
25 var $mDataLoaded = false; // !<
26 var $mForUpdate = false; // !<
27 var $mGoodAdjustment = 0; // !<
28 var $mIsRedirect = false; // !<
29 var $mLatest = false; // !<
30 var $mMinorEdit; // !<
32 var $mPreparedEdit = false; // !< Title object if set
33 var $mRedirectedFrom = null; // !< Title object if set
34 var $mRedirectTarget = null; // !< Title object if set
35 var $mRedirectUrl = false; // !<
36 var $mRevIdFetched = 0; // !<
37 var $mRevision; // !< Revision object if set
38 var $mTimestamp = ''; // !<
39 var $mTitle; // !< Title object
40 var $mTotalAdjustment = 0; // !<
41 var $mTouched = '19700101000000'; // !<
42 var $mUser = -1; // !< Not loaded
43 var $mUserText = ''; // !< username from Revision if set
44 var $mParserOptions; // !< ParserOptions object
45 var $mParserOutput; // !< ParserCache object if set
49 * Constructor and clear the article
50 * @param $title Reference to a Title object.
51 * @param $oldId Integer revision ID, null to fetch from request, zero for current
53 public function __construct( Title
$title, $oldId = null ) {
54 // FIXME: does the reference play any role here?
55 $this->mTitle
=& $title;
56 $this->mOldId
= $oldId;
60 * Constructor from an page id
61 * @param $id The article ID to load
63 public static function newFromID( $id ) {
64 $t = Title
::newFromID( $id );
65 # FIXME: doesn't inherit right
66 return $t == null ?
null : new self( $t );
67 # return $t == null ? null : new static( $t ); // PHP 5.3
71 * Tell the page view functions that this view was redirected
72 * from another page on the wiki.
73 * @param $from Title object.
75 public function setRedirectedFrom( Title
$from ) {
76 $this->mRedirectedFrom
= $from;
80 * If this page is a redirect, get its target
82 * The target will be fetched from the redirect table if possible.
83 * If this page doesn't have an entry there, call insertRedirect()
84 * @return mixed Title object, or null if this page is not a redirect
86 public function getRedirectTarget() {
87 if ( !$this->mTitle
->isRedirect() ) {
91 if ( $this->mRedirectTarget
!== null ) {
92 return $this->mRedirectTarget
;
95 # Query the redirect table
96 $dbr = wfGetDB( DB_SLAVE
);
97 $row = $dbr->selectRow( 'redirect',
98 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
99 array( 'rd_from' => $this->getID() ),
103 // rd_fragment and rd_interwiki were added later, populate them if empty
104 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
105 return $this->mRedirectTarget
= Title
::makeTitle(
106 $row->rd_namespace
, $row->rd_title
,
107 $row->rd_fragment
, $row->rd_interwiki
);
110 # This page doesn't have an entry in the redirect table
111 return $this->mRedirectTarget
= $this->insertRedirect();
115 * Insert an entry for this page into the redirect table.
117 * Don't call this function directly unless you know what you're doing.
118 * @return Title object or null if not a redirect
120 public function insertRedirect() {
121 // recurse through to only get the final target
122 $retval = Title
::newFromRedirectRecurse( $this->getContent() );
126 $this->insertRedirectEntry( $retval );
131 * Insert or update the redirect table entry for this page to indicate
132 * it redirects to $rt .
133 * @param $rt Title redirect target
135 public function insertRedirectEntry( $rt ) {
136 $dbw = wfGetDB( DB_MASTER
);
137 $dbw->replace( 'redirect', array( 'rd_from' ),
139 'rd_from' => $this->getID(),
140 'rd_namespace' => $rt->getNamespace(),
141 'rd_title' => $rt->getDBkey(),
142 'rd_fragment' => $rt->getFragment(),
143 'rd_interwiki' => $rt->getInterwiki(),
150 * Get the Title object or URL this page redirects to
152 * @return mixed false, Title of in-wiki target, or string with URL
154 public function followRedirect() {
155 return $this->getRedirectURL( $this->getRedirectTarget() );
159 * Get the Title object this text redirects to
161 * @param $text string article content containing redirect info
162 * @return mixed false, Title of in-wiki target, or string with URL
165 public function followRedirectText( $text ) {
166 // recurse through to only get the final target
167 return $this->getRedirectURL( Title
::newFromRedirectRecurse( $text ) );
171 * Get the Title object or URL to use for a redirect. We use Title
172 * objects for same-wiki, non-special redirects and URLs for everything
174 * @param $rt Title Redirect target
175 * @return mixed false, Title object of local target, or string with URL
177 public function getRedirectURL( $rt ) {
179 if ( $rt->getInterwiki() != '' ) {
180 if ( $rt->isLocal() ) {
181 // Offsite wikis need an HTTP redirect.
183 // This can be hard to reverse and may produce loops,
184 // so they may be disabled in the site configuration.
185 $source = $this->mTitle
->getFullURL( 'redirect=no' );
186 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
189 if ( $rt->getNamespace() == NS_SPECIAL
) {
190 // Gotta handle redirects to special pages differently:
191 // Fill the HTTP response "Location" header and ignore
192 // the rest of the page we're on.
194 // This can be hard to reverse, so they may be disabled.
195 if ( $rt->isSpecial( 'Userlogout' ) ) {
198 return $rt->getFullURL();
206 // No or invalid redirect
211 * Get the title object of the article
212 * @return Title object of this page
214 public function getTitle() {
215 return $this->mTitle
;
220 * FIXME: shouldn't this be public?
223 public function clear() {
224 $this->mDataLoaded
= false;
225 $this->mContentLoaded
= false;
227 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
228 $this->mRedirectedFrom
= null; # Title object if set
229 $this->mRedirectTarget
= null; # Title object if set
231 $this->mTimestamp
= $this->mComment
= '';
232 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
233 $this->mTouched
= '19700101000000';
234 $this->mForUpdate
= false;
235 $this->mIsRedirect
= false;
236 $this->mRevIdFetched
= 0;
237 $this->mRedirectUrl
= false;
238 $this->mLatest
= false;
239 $this->mPreparedEdit
= false;
243 * Note that getContent/loadContent do not follow redirects anymore.
244 * If you need to fetch redirectable content easily, try
245 * the shortcut in Article::followRedirect()
247 * This function has side effects! Do not use this function if you
248 * only want the real revision text if any.
250 * @return Return the text of this revision
252 public function getContent() {
253 global $wgUser, $wgContLang, $wgMessageCache;
255 wfProfileIn( __METHOD__
);
257 if ( $this->getID() === 0 ) {
258 # If this is a MediaWiki:x message, then load the messages
259 # and return the message value for x.
260 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
261 # If this is a system message, get the default text.
262 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
263 $wgMessageCache->loadAllMessages( $lang );
264 $text = wfMsgGetKey( $message, false, $lang, false );
266 if ( wfEmptyMsg( $message, $text ) )
269 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
271 wfProfileOut( __METHOD__
);
275 $this->loadContent();
276 wfProfileOut( __METHOD__
);
278 return $this->mContent
;
283 * Get the text of the current revision. No side-effects...
285 * @return Return the text of the current revision
287 public function getRawText() {
288 // Check process cache for current revision
289 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
290 return $this->mContent
;
293 $rev = Revision
::newFromTitle( $this->mTitle
);
294 $text = $rev ?
$rev->getRawText() : false;
300 * This function returns the text of a section, specified by a number ($section).
301 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
302 * the first section before any such heading (section 0).
304 * If a section contains subsections, these are also returned.
306 * @param $text String: text to look in
307 * @param $section Integer: section number
308 * @return string text of the requested section
311 public function getSection( $text, $section ) {
313 return $wgParser->getSection( $text, $section );
317 * Get the text that needs to be saved in order to undo all revisions
318 * between $undo and $undoafter. Revisions must belong to the same page,
319 * must exist and must not be deleted
320 * @param $undo Revision
321 * @param $undoafter Revision Must be an earlier revision than $undo
322 * @return mixed string on success, false on failure
324 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
325 $undo_text = $undo->getText();
326 $undoafter_text = $undoafter->getText();
327 $cur_text = $this->getContent();
329 if ( $cur_text == $undo_text ) {
330 # No use doing a merge if it's just a straight revert.
331 return $undoafter_text;
336 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
344 * @return int The oldid of the article that is to be shown, 0 for the
347 public function getOldID() {
348 if ( is_null( $this->mOldId
) ) {
349 $this->mOldId
= $this->getOldIDFromRequest();
352 return $this->mOldId
;
356 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
358 * @return int The old id for the request
360 public function getOldIDFromRequest() {
363 $this->mRedirectUrl
= false;
365 $oldid = $wgRequest->getVal( 'oldid' );
367 if ( isset( $oldid ) ) {
368 $oldid = intval( $oldid );
369 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
370 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
374 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
376 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
377 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
392 * Load the revision (including text) into this object
394 function loadContent() {
395 if ( $this->mContentLoaded
) {
399 wfProfileIn( __METHOD__
);
401 $oldid = $this->getOldID();
402 $this->mOldId
= $oldid;
403 $this->fetchContent( $oldid );
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_MASTER
);
471 $data = $this->pageDataFromId( $dbr, $this->getId() );
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 $dbr = wfGetDB( DB_MASTER
);
510 # Pre-fill content with error message so that if something
511 # fails we'll have something telling us what we intended.
512 $t = $this->mTitle
->getPrefixedText();
513 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
514 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
517 $revision = Revision
::newFromId( $oldid );
518 if ( $revision === null ) {
519 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
523 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
526 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
530 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
531 $this->loadPageData( $data );
533 if ( !$this->mDataLoaded
) {
534 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
537 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
541 $this->loadPageData( $data );
543 $revision = Revision
::newFromId( $this->mLatest
);
544 if ( $revision === null ) {
545 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
550 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
551 // We should instead work with the Revision object when we need it...
552 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
554 $this->mUser
= $revision->getUser();
555 $this->mUserText
= $revision->getUserText();
556 $this->mComment
= $revision->getComment();
557 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
559 $this->mRevIdFetched
= $revision->getId();
560 $this->mContentLoaded
= true;
561 $this->mRevision
=& $revision;
563 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
565 return $this->mContent
;
569 * Read/write accessor to select FOR UPDATE
571 * @param $x Mixed: FIXME
572 * @return mixed value of $x, or value stored in Article::mForUpdate
574 public function forUpdate( $x = null ) {
575 return wfSetVar( $this->mForUpdate
, $x );
579 * Get options for all SELECT statements
581 * @param $options Array: an optional options array which'll be appended to
583 * @return Array: options
585 protected function getSelectOptions( $options = '' ) {
586 if ( $this->mForUpdate
) {
587 if ( is_array( $options ) ) {
588 $options[] = 'FOR UPDATE';
590 $options = 'FOR UPDATE';
598 * @return int Page ID
600 public function getID() {
601 return $this->mTitle
->getArticleID();
605 * @return bool Whether or not the page exists in the database
607 public function exists() {
608 return $this->getId() > 0;
612 * Check if this page is something we're going to be showing
613 * some sort of sensible content for. If we return false, page
614 * views (plain action=view) will return an HTTP 404 response,
615 * so spiders and robots can know they're following a bad link.
619 public function hasViewableContent() {
620 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
624 * @return int The view count for the page
626 public function getCount() {
627 if ( -1 == $this->mCounter
) {
628 $id = $this->getID();
633 $dbr = wfGetDB( DB_SLAVE
);
634 $this->mCounter
= $dbr->selectField( 'page',
636 array( 'page_id' => $id ),
638 $this->getSelectOptions()
643 return $this->mCounter
;
647 * Determine whether a page would be suitable for being counted as an
648 * article in the site_stats table based on the title & its content
650 * @param $text String: text to analyze
653 public function isCountable( $text ) {
654 global $wgUseCommaCount;
656 $token = $wgUseCommaCount ?
',' : '[[';
658 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
662 * Tests if the article text represents a redirect
664 * @param $text mixed string containing article contents, or boolean
667 public function isRedirect( $text = false ) {
668 if ( $text === false ) {
669 if ( $this->mDataLoaded
) {
670 return $this->mIsRedirect
;
673 // Apparently loadPageData was never called
674 $this->loadContent();
675 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
677 $titleObj = Title
::newFromRedirect( $text );
680 return $titleObj !== null;
684 * Returns true if the currently-referenced revision is the current edit
685 * to this page (and it exists).
688 public function isCurrent() {
689 # If no oldid, this is the current version.
690 if ( $this->getOldID() == 0 ) {
694 return $this->exists() && isset( $this->mRevision
) && $this->mRevision
->isCurrent();
698 * Loads everything except the text
699 * This isn't necessary for all uses, so it's only done if needed.
701 protected function loadLastEdit() {
702 if ( -1 != $this->mUser
) {
706 # New or non-existent articles have no user information
707 $id = $this->getID();
712 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
713 if ( !is_null( $this->mLastRevision
) ) {
714 $this->mUser
= $this->mLastRevision
->getUser();
715 $this->mUserText
= $this->mLastRevision
->getUserText();
716 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
717 $this->mComment
= $this->mLastRevision
->getComment();
718 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
719 $this->mRevIdFetched
= $this->mLastRevision
->getId();
724 * @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 $this->loadLastEdit();
777 return $this->mRevIdFetched
;
781 * FIXME: this does what?
782 * @param $limit Integer: default 0.
783 * @param $offset Integer: default 0.
784 * @return UserArrayFromResult object with User objects of article contributors for requested range
786 public function getContributors( $limit = 0, $offset = 0 ) {
787 # FIXME: this is expensive; cache this info somewhere.
789 $dbr = wfGetDB( DB_SLAVE
);
790 $revTable = $dbr->tableName( 'revision' );
791 $userTable = $dbr->tableName( 'user' );
793 $pageId = $this->getId();
795 $user = $this->getUser();
798 $excludeCond = "AND rev_user != $user";
800 $userText = $dbr->addQuotes( $this->getUserText() );
801 $excludeCond = "AND rev_user_text != $userText";
804 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
806 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
807 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
808 WHERE rev_page = $pageId
811 GROUP BY rev_user, rev_user_text
812 ORDER BY timestamp DESC";
815 $sql = $dbr->limitResult( $sql, $limit, $offset );
818 $sql .= ' ' . $this->getSelectOptions();
819 $res = $dbr->query( $sql, __METHOD__
);
821 return new UserArrayFromResult( $res );
825 * This is the default action of the index.php entry point: just view the
826 * page of the given title.
828 public function view() {
829 global $wgUser, $wgOut, $wgRequest, $wgParser;
830 global $wgUseFileCache;
832 wfProfileIn( __METHOD__
);
834 # Get variables from query string
835 $oldid = $this->getOldID();
836 $parserCache = ParserCache
::singleton();
838 $parserOptions = clone $this->getParserOptions();
839 # Render printable version, use printable version cache
840 if ( $wgOut->isPrintable() ) {
841 $parserOptions->setIsPrintable( true );
844 # Try client and file cache
845 if ( $oldid === 0 && $this->checkTouched() ) {
849 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
852 # Is is client cached?
853 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
854 wfDebug( __METHOD__
. ": done 304\n" );
855 wfProfileOut( __METHOD__
);
859 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
860 wfDebug( __METHOD__
. ": done file cache\n" );
861 # tell wgOut that output is taken care of
863 $this->viewUpdates();
864 wfProfileOut( __METHOD__
);
870 # getOldID may want us to redirect somewhere else
871 if ( $this->mRedirectUrl
) {
872 $wgOut->redirect( $this->mRedirectUrl
);
873 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
874 wfProfileOut( __METHOD__
);
879 $wgOut->setArticleFlag( true );
880 # Set page title (may be overridden by DISPLAYTITLE)
881 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
883 # If we got diff in the query, we want to see a diff page instead of the article.
884 if ( $wgRequest->getCheck( 'diff' ) ) {
885 wfDebug( __METHOD__
. ": showing diff page\n" );
886 $this->showDiffPage();
887 wfProfileOut( __METHOD__
);
892 # Should the parser cache be used?
893 $useParserCache = $this->useParserCache( $oldid );
894 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
895 if ( $wgUser->getOption( 'stubthreshold' ) ) {
896 wfIncrStats( 'pcache_miss_stub' );
899 $wasRedirected = $this->showRedirectedFromHeader();
900 $this->showNamespaceHeader();
902 # Iterate through the possible ways of constructing the output text.
903 # Keep going until $outputDone is set, or we run out of things to do.
906 $this->mParserOutput
= false;
908 while ( !$outputDone && ++
$pass ) {
911 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
914 # Try the parser cache
915 if ( $useParserCache ) {
916 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
918 if ( $this->mParserOutput
!== false ) {
919 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
920 $wgOut->addParserOutput( $this->mParserOutput
);
921 # Ensure that UI elements requiring revision ID have
922 # the correct version information.
923 $wgOut->setRevisionId( $this->mLatest
);
929 $text = $this->getContent();
930 if ( $text === false ||
$this->getID() == 0 ) {
931 wfDebug( __METHOD__
. ": showing missing article\n" );
932 $this->showMissingArticle();
933 wfProfileOut( __METHOD__
);
937 # Another whitelist check in case oldid is altering the title
938 if ( !$this->mTitle
->userCanRead() ) {
939 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
940 $wgOut->loginToUse();
943 wfProfileOut( __METHOD__
);
947 # Are we looking at an old revision
948 if ( $oldid && !is_null( $this->mRevision
) ) {
949 $this->setOldSubtitle( $oldid );
951 if ( !$this->showDeletedRevisionHeader() ) {
952 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
953 wfProfileOut( __METHOD__
);
957 # If this "old" version is the current, then try the parser cache...
958 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
959 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
960 if ( $this->mParserOutput
) {
961 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
962 $wgOut->addParserOutput( $this->mParserOutput
);
963 $wgOut->setRevisionId( $this->mLatest
);
964 $this->showViewFooter();
965 $this->viewUpdates();
966 wfProfileOut( __METHOD__
);
972 # Ensure that UI elements requiring revision ID have
973 # the correct version information.
974 $wgOut->setRevisionId( $this->getRevIdFetched() );
976 # Pages containing custom CSS or JavaScript get special treatment
977 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
978 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
979 $this->showCssOrJsPage();
981 } else if ( $rt = Title
::newFromRedirectArray( $text ) ) {
982 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
983 # Viewing a redirect page (e.g. with parameter redirect=no)
984 # Don't append the subtitle if this was an old revision
985 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
986 # Parse just to get categories, displaytitle, etc.
987 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
988 $wgOut->addParserOutputNoText( $this->mParserOutput
);
993 # Run the parse, protected by a pool counter
994 wfDebug( __METHOD__
. ": doing uncached parse\n" );
995 $key = $parserCache->getKey( $this, $parserOptions );
996 $poolCounter = PoolCounter
::factory( 'Article::view', $key );
997 $dirtyCallback = $useParserCache ?
array( $this, 'tryDirtyCache' ) : false;
998 $status = $poolCounter->executeProtected( array( $this, 'doViewParse' ), $dirtyCallback );
1000 if ( !$status->isOK() ) {
1001 # Connection or timeout error
1002 $this->showPoolError( $status );
1003 wfProfileOut( __METHOD__
);
1009 # Should be unreachable, but just in case...
1015 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1016 if ( $this->mParserOutput
) {
1017 $titleText = $this->mParserOutput
->getTitleText();
1019 if ( strval( $titleText ) !== '' ) {
1020 $wgOut->setPageTitle( $titleText );
1024 # For the main page, overwrite the <title> element with the con-
1025 # tents of 'pagetitle-view-mainpage' instead of the default (if
1026 # that's not empty).
1027 # This message always exists because it is in the i18n files
1028 if ( $this->mTitle
->equals( Title
::newMainPage() )
1029 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1031 $wgOut->setHTMLTitle( $m );
1034 # Now that we've filled $this->mParserOutput, we know whether
1035 # there are any __NOINDEX__ tags on the page
1036 $policy = $this->getRobotPolicy( 'view' );
1037 $wgOut->setIndexPolicy( $policy['index'] );
1038 $wgOut->setFollowPolicy( $policy['follow'] );
1040 $this->showViewFooter();
1041 $this->viewUpdates();
1042 wfProfileOut( __METHOD__
);
1046 * Show a diff page according to current request variables. For use within
1047 * Article::view() only, other callers should use the DifferenceEngine class.
1049 public function showDiffPage() {
1050 global $wgRequest, $wgUser;
1052 $diff = $wgRequest->getVal( 'diff' );
1053 $rcid = $wgRequest->getVal( 'rcid' );
1054 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1055 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1056 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1057 $oldid = $this->getOldID();
1059 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1060 // DifferenceEngine directly fetched the revision:
1061 $this->mRevIdFetched
= $de->mNewid
;
1062 $de->showDiffPage( $diffOnly );
1064 // Needed to get the page's current revision
1065 $this->loadPageData();
1066 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1067 # Run view updates for current revision only
1068 $this->viewUpdates();
1073 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1074 * Article::view() only.
1076 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1079 public function showCssOrJsPage() {
1082 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1084 // Give hooks a chance to customise the output
1085 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1086 // Wrap the whole lot in a <pre> and don't parse
1088 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1089 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1090 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1091 $wgOut->addHTML( "\n</pre>\n" );
1096 * Get the robot policy to be used for the current action=view request.
1097 * @return String the policy that should be set
1098 * @deprecated use getRobotPolicy() instead, which returns an associative
1101 public function getRobotPolicyForView() {
1102 wfDeprecated( __METHOD__
);
1103 $policy = $this->getRobotPolicy( 'view' );
1105 return $policy['index'] . ',' . $policy['follow'];
1109 * Get the robot policy to be used for the current view
1110 * @param $action String the action= GET parameter
1111 * @return Array the policy that should be set
1112 * TODO: actions other than 'view'
1114 public function getRobotPolicy( $action ) {
1115 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1116 global $wgDefaultRobotPolicy, $wgRequest;
1118 $ns = $this->mTitle
->getNamespace();
1120 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1121 # Don't index user and user talk pages for blocked users (bug 11443)
1122 if ( !$this->mTitle
->isSubpage() ) {
1123 $block = new Block();
1124 if ( $block->load( $this->mTitle
->getText() ) ) {
1126 'index' => 'noindex',
1127 'follow' => 'nofollow'
1133 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1134 # Non-articles (special pages etc), and old revisions
1136 'index' => 'noindex',
1137 'follow' => 'nofollow'
1139 } elseif ( $wgOut->isPrintable() ) {
1140 # Discourage indexing of printable versions, but encourage following
1142 'index' => 'noindex',
1143 'follow' => 'follow'
1145 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1146 # For ?curid=x urls, disallow indexing
1148 'index' => 'noindex',
1149 'follow' => 'follow'
1153 # Otherwise, construct the policy based on the various config variables.
1154 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1156 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1157 # Honour customised robot policies for this namespace
1158 $policy = array_merge(
1160 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1163 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1164 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1165 # a final sanity check that we have really got the parser output.
1166 $policy = array_merge(
1168 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1172 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1173 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1174 $policy = array_merge(
1176 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1184 * Converts a String robot policy into an associative array, to allow
1185 * merging of several policies using array_merge().
1186 * @param $policy Mixed, returns empty array on null/false/'', transparent
1187 * to already-converted arrays, converts String.
1188 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1190 public static function formatRobotPolicy( $policy ) {
1191 if ( is_array( $policy ) ) {
1193 } elseif ( !$policy ) {
1197 $policy = explode( ',', $policy );
1198 $policy = array_map( 'trim', $policy );
1201 foreach ( $policy as $var ) {
1202 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1203 $arr['index'] = $var;
1204 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1205 $arr['follow'] = $var;
1213 * If this request is a redirect view, send "redirected from" subtitle to
1214 * $wgOut. Returns true if the header was needed, false if this is not a
1215 * redirect view. Handles both local and remote redirects.
1219 public function showRedirectedFromHeader() {
1220 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1222 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1223 $sk = $wgUser->getSkin();
1225 if ( isset( $this->mRedirectedFrom
) ) {
1226 // This is an internally redirected page view.
1227 // We'll need a backlink to the source page for navigation.
1228 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1230 $this->mRedirectedFrom
,
1233 array( 'redirect' => 'no' ),
1234 array( 'known', 'noclasses' )
1237 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1238 $wgOut->setSubtitle( $s );
1240 // Set the fragment if one was specified in the redirect
1241 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1242 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1243 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1246 // Add a <link rel="canonical"> tag
1247 $wgOut->addLink( array( 'rel' => 'canonical',
1248 'href' => $this->mTitle
->getLocalURL() )
1253 } elseif ( $rdfrom ) {
1254 // This is an externally redirected view, from some other wiki.
1255 // If it was reported from a trusted site, supply a backlink.
1256 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1257 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1258 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1259 $wgOut->setSubtitle( $s );
1269 * Show a header specific to the namespace currently being viewed, like
1270 * [[MediaWiki:Talkpagetext]]. For Article::view().
1272 public function showNamespaceHeader() {
1275 if ( $this->mTitle
->isTalkPage() ) {
1276 $msg = wfMsgNoTrans( 'talkpageheader' );
1277 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1278 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1284 * Show the footer section of an ordinary page view
1286 public function showViewFooter() {
1287 global $wgOut, $wgUseTrackbacks;
1289 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1290 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1291 $wgOut->addWikiMsg( 'anontalkpagetext' );
1294 # If we have been passed an &rcid= parameter, we want to give the user a
1295 # chance to mark this new article as patrolled.
1296 $this->showPatrolFooter();
1299 if ( $wgUseTrackbacks ) {
1300 $this->addTrackbacks();
1305 * If patrol is possible, output a patrol UI box. This is called from the
1306 * footer section of ordinary page views. If patrol is not possible or not
1307 * desired, does nothing.
1309 public function showPatrolFooter() {
1310 global $wgOut, $wgRequest, $wgUser;
1312 $rcid = $wgRequest->getVal( 'rcid' );
1314 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1318 $sk = $wgUser->getSkin();
1321 "<div class='patrollink'>" .
1323 'markaspatrolledlink',
1326 wfMsgHtml( 'markaspatrolledtext' ),
1329 'action' => 'markpatrolled',
1332 array( 'known', 'noclasses' )
1340 * Show the error text for a missing article. For articles in the MediaWiki
1341 * namespace, show the default message text. To be called from Article::view().
1343 public function showMissingArticle() {
1344 global $wgOut, $wgRequest, $wgUser;
1346 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1347 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1348 $parts = explode( '/', $this->mTitle
->getText() );
1349 $rootPart = $parts[0];
1350 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1351 $ip = User
::isIP( $rootPart );
1353 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1354 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1355 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1356 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1357 LogEventsList
::showLogExtract(
1360 $user->getUserPage()->getPrefixedText(),
1364 'showIfEmpty' => false,
1366 'blocked-notice-logextract',
1367 $user->getName() # Support GENDER in notice
1374 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1376 # Show delete and move logs
1377 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1379 'conds' => array( "log_action != 'revision'" ),
1380 'showIfEmpty' => false,
1381 'msgKey' => array( 'moveddeleted-notice' ) )
1384 # Show error message
1385 $oldid = $this->getOldID();
1387 $text = wfMsgNoTrans( 'missing-article',
1388 $this->mTitle
->getPrefixedText(),
1389 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1390 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1391 // Use the default message text
1392 $text = $this->getContent();
1394 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1395 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1396 $errors = array_merge( $createErrors, $editErrors );
1398 if ( !count( $errors ) ) {
1399 $text = wfMsgNoTrans( 'noarticletext' );
1401 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1404 $text = "<div class='noarticletext'>\n$text\n</div>";
1406 if ( !$this->hasViewableContent() ) {
1407 // If there's no backing content, send a 404 Not Found
1408 // for better machine handling of broken links.
1409 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1412 $wgOut->addWikiText( $text );
1416 * If the revision requested for view is deleted, check permissions.
1417 * Send either an error message or a warning header to $wgOut.
1419 * @return boolean true if the view is allowed, false if not.
1421 public function showDeletedRevisionHeader() {
1422 global $wgOut, $wgRequest;
1424 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1429 // If the user is not allowed to see it...
1430 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1431 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1432 'rev-deleted-text-permission' );
1435 // If the user needs to confirm that they want to see it...
1436 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1437 # Give explanation and add a link to view the revision...
1438 $oldid = intval( $this->getOldID() );
1439 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1440 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1441 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1442 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1443 array( $msg, $link ) );
1446 // We are allowed to see...
1448 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1449 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1450 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1457 * Should the parser cache be used?
1461 public function useParserCache( $oldid ) {
1462 global $wgUser, $wgEnableParserCache;
1464 return $wgEnableParserCache
1465 && intval( $wgUser->getOption( 'stubthreshold' ) ) == 0
1468 && !$this->mTitle
->isCssOrJsPage()
1469 && !$this->mTitle
->isCssJsSubpage();
1473 * Execute the uncached parse for action=view
1475 public function doViewParse() {
1478 $oldid = $this->getOldID();
1479 $useParserCache = $this->useParserCache( $oldid );
1480 $parserOptions = clone $this->getParserOptions();
1482 # Render printable version, use printable version cache
1483 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1485 # Don't show section-edit links on old revisions... this way lies madness.
1486 $parserOptions->setEditSection( $this->isCurrent() );
1487 $useParserCache = $this->useParserCache( $oldid );
1488 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1492 * Try to fetch an expired entry from the parser cache. If it is present,
1493 * output it and return true. If it is not present, output nothing and
1494 * return false. This is used as a callback function for
1495 * PoolCounter::executeProtected().
1499 public function tryDirtyCache() {
1502 $parserCache = ParserCache
::singleton();
1503 $options = $this->getParserOptions();
1504 $options->setIsPrintable( $wgOut->isPrintable() );
1505 $output = $parserCache->getDirty( $this, $options );
1508 wfDebug( __METHOD__
. ": sending dirty output\n" );
1509 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1510 $wgOut->setSquidMaxage( 0 );
1511 $this->mParserOutput
= $output;
1512 $wgOut->addParserOutput( $output );
1513 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1517 wfDebugLog( 'dirty', "dirty missing\n" );
1518 wfDebug( __METHOD__
. ": no dirty cache\n" );
1525 * Show an error page for an error from the pool counter.
1526 * @param $status Status
1528 public function showPoolError( $status ) {
1531 $wgOut->clearHTML(); // for release() errors
1532 $wgOut->enableClientCache( false );
1533 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1534 $wgOut->addWikiText(
1535 '<div class="errorbox">' .
1536 $status->getWikiText( false, 'view-pool-error' ) .
1544 * @param $target Title object or Array of destination(s) to redirect
1545 * @param $appendSubtitle Boolean [optional]
1546 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1547 * @return string containing HMTL with redirect link
1549 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1550 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1552 if ( !is_array( $target ) ) {
1553 $target = array( $target );
1556 $imageDir = $wgContLang->getDir();
1558 if ( $appendSubtitle ) {
1559 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1562 $sk = $wgUser->getSkin();
1563 // the loop prepends the arrow image before the link, so the first case needs to be outside
1564 $title = array_shift( $target );
1566 if ( $forceKnown ) {
1567 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1569 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1572 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1573 $alt = $wgContLang->isRTL() ?
'←' : '→';
1574 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1575 // FIXME: where this happens?
1576 foreach ( $target as $rt ) {
1577 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1578 if ( $forceKnown ) {
1579 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1581 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1585 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1586 return Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1587 '<span class="redirectText">' . $link . '</span>';
1591 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1593 public function addTrackbacks() {
1594 global $wgOut, $wgUser;
1596 $dbr = wfGetDB( DB_SLAVE
);
1597 $tbs = $dbr->select( 'trackbacks',
1598 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1599 array( 'tb_page' => $this->getID() )
1602 if ( !$dbr->numRows( $tbs ) ) {
1607 while ( $o = $dbr->fetchObject( $tbs ) ) {
1610 if ( $wgUser->isAllowed( 'trackback' ) ) {
1611 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1612 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1613 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1617 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1625 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1629 * Removes trackback record for current article from trackbacks table
1631 public function deletetrackback() {
1632 global $wgUser, $wgRequest, $wgOut;
1634 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1635 $wgOut->addWikiMsg( 'sessionfailure' );
1640 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1642 if ( count( $permission_errors ) ) {
1643 $wgOut->showPermissionsErrorPage( $permission_errors );
1648 $db = wfGetDB( DB_MASTER
);
1649 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1651 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1652 $this->mTitle
->invalidateCache();
1656 * Handle action=render
1659 public function render() {
1662 $wgOut->setArticleBodyOnly( true );
1667 * Handle action=purge
1669 public function purge() {
1670 global $wgUser, $wgRequest, $wgOut;
1672 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1673 //FIXME: shouldn't this be in doPurge()?
1674 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1679 $formParams = array(
1681 'action' => $wgRequest->getRequestURL(),
1684 $wgOut->addWikiMsg( 'confirm-purge-top' );
1686 $form = Html
::openElement( 'form', $formParams );
1687 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1688 $form .= Html
::closeElement( 'form' );
1690 $wgOut->addHTML( $form );
1691 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1693 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1694 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1699 * Perform the actions of a page purging
1701 public function doPurge() {
1704 // Invalidate the cache
1705 $this->mTitle
->invalidateCache();
1707 if ( $wgUseSquid ) {
1708 // Commit the transaction before the purge is sent
1709 $dbw = wfGetDB( DB_MASTER
);
1713 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1714 $update->doUpdate();
1717 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1718 global $wgMessageCache;
1720 if ( $this->getID() == 0 ) {
1723 $text = $this->getRawText();
1726 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1731 * Insert a new empty page record for this article.
1732 * This *must* be followed up by creating a revision
1733 * and running $this->updateRevisionOn( ... );
1734 * or else the record will be left in a funky state.
1735 * Best if all done inside a transaction.
1737 * @param $dbw Database
1738 * @return int The newly created page_id key, or false if the title already existed
1741 public function insertOn( $dbw ) {
1742 wfProfileIn( __METHOD__
);
1744 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1745 $dbw->insert( 'page', array(
1746 'page_id' => $page_id,
1747 'page_namespace' => $this->mTitle
->getNamespace(),
1748 'page_title' => $this->mTitle
->getDBkey(),
1749 'page_counter' => 0,
1750 'page_restrictions' => '',
1751 'page_is_redirect' => 0, # Will set this shortly...
1753 'page_random' => wfRandom(),
1754 'page_touched' => $dbw->timestamp(),
1755 'page_latest' => 0, # Fill this in shortly...
1756 'page_len' => 0, # Fill this in shortly...
1757 ), __METHOD__
, 'IGNORE' );
1759 $affected = $dbw->affectedRows();
1762 $newid = $dbw->insertId();
1763 $this->mTitle
->resetArticleId( $newid );
1765 wfProfileOut( __METHOD__
);
1767 return $affected ?
$newid : false;
1771 * Update the page record to point to a newly saved revision.
1773 * @param $dbw Database object
1774 * @param $revision Revision: For ID number, and text used to set
1775 length and redirect status fields
1776 * @param $lastRevision Integer: if given, will not overwrite the page field
1777 * when different from the currently set value.
1778 * Giving 0 indicates the new page flag should be set
1780 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1781 * removing rows in redirect table.
1782 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1783 * Needed when $lastRevision has to be set to sth. !=0
1784 * @return bool true on success, false on failure
1787 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1788 wfProfileIn( __METHOD__
);
1790 $text = $revision->getText();
1791 $rt = Title
::newFromRedirectRecurse( $text );
1793 $conditions = array( 'page_id' => $this->getId() );
1795 if ( !is_null( $lastRevision ) ) {
1796 # An extra check against threads stepping on each other
1797 $conditions['page_latest'] = $lastRevision;
1800 if ( !$setNewFlag ) {
1801 $setNewFlag = ( $lastRevision === 0 );
1804 $dbw->update( 'page',
1806 'page_latest' => $revision->getId(),
1807 'page_touched' => $dbw->timestamp(),
1808 'page_is_new' => $setNewFlag,
1809 'page_is_redirect' => $rt !== null ?
1 : 0,
1810 'page_len' => strlen( $text ),
1815 $result = $dbw->affectedRows() != 0;
1817 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1820 wfProfileOut( __METHOD__
);
1825 * Add row to the redirect table if this is a redirect, remove otherwise.
1827 * @param $dbw Database
1828 * @param $redirectTitle a title object pointing to the redirect target,
1829 * or NULL if this is not a redirect
1830 * @param $lastRevIsRedirect If given, will optimize adding and
1831 * removing rows in redirect table.
1832 * @return bool true on success, false on failure
1835 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1836 // Always update redirects (target link might have changed)
1837 // Update/Insert if we don't know if the last revision was a redirect or not
1838 // Delete if changing from redirect to non-redirect
1839 $isRedirect = !is_null( $redirectTitle );
1841 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1842 wfProfileIn( __METHOD__
);
1843 if ( $isRedirect ) {
1844 $this->insertRedirectEntry( $redirectTitle );
1846 // This is not a redirect, remove row from redirect table
1847 $where = array( 'rd_from' => $this->getId() );
1848 $dbw->delete( 'redirect', $where, __METHOD__
);
1851 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1852 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1854 wfProfileOut( __METHOD__
);
1856 return ( $dbw->affectedRows() != 0 );
1863 * If the given revision is newer than the currently set page_latest,
1864 * update the page record. Otherwise, do nothing.
1866 * @param $dbw Database object
1867 * @param $revision Revision object
1870 public function updateIfNewerOn( &$dbw, $revision ) {
1871 wfProfileIn( __METHOD__
);
1873 $row = $dbw->selectRow(
1874 array( 'revision', 'page' ),
1875 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1877 'page_id' => $this->getId(),
1878 'page_latest=rev_id' ),
1882 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1883 wfProfileOut( __METHOD__
);
1886 $prev = $row->rev_id
;
1887 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1889 # No or missing previous revision; mark the page as new
1891 $lastRevIsRedirect = null;
1894 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1896 wfProfileOut( __METHOD__
);
1901 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1902 * @param $text String: new text of the section
1903 * @param $summary String: new section's subject, only if $section is 'new'
1904 * @param $edittime String: revision timestamp or null to use the current revision
1905 * @return string Complete article text, or null if error
1907 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1908 wfProfileIn( __METHOD__
);
1910 if ( strval( $section ) == '' ) {
1911 // Whole-page edit; let the whole text through
1913 if ( is_null( $edittime ) ) {
1914 $rev = Revision
::newFromTitle( $this->mTitle
);
1916 $dbw = wfGetDB( DB_MASTER
);
1917 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1921 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1922 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1926 $oldtext = $rev->getText();
1928 if ( $section == 'new' ) {
1929 # Inserting a new section
1930 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1931 $text = strlen( trim( $oldtext ) ) > 0
1932 ?
"{$oldtext}\n\n{$subject}{$text}"
1933 : "{$subject}{$text}";
1935 # Replacing an existing section; roll out the big guns
1938 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1942 wfProfileOut( __METHOD__
);
1947 * @deprecated use Article::doEdit()
1949 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1950 wfDeprecated( __METHOD__
);
1951 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1952 ( $isminor ? EDIT_MINOR
: 0 ) |
1953 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1954 ( $bot ? EDIT_FORCE_BOT
: 0 );
1956 $this->doEdit( $text, $summary, $flags, false, null, $watchthis, $comment, '', true );
1960 * @deprecated use Article::doEdit()
1962 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1963 wfDeprecated( __METHOD__
);
1964 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1965 ( $minor ? EDIT_MINOR
: 0 ) |
1966 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1968 $status = $this->doEdit( $text, $summary, $flags, false, null, $watchthis, false, $sectionanchor, true );
1970 if ( !$status->isOK() ) {
1978 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1980 * @return Int updated $flags
1982 function checkFlags( $flags ) {
1983 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1984 if ( $this->mTitle
->getArticleID() ) {
1985 $flags |
= EDIT_UPDATE
;
1997 * Change an existing article or create a new article. Updates RC and all necessary caches,
1998 * optionally via the deferred update array.
2000 * $wgUser must be set before calling this function.
2002 * @param $text String: new text
2003 * @param $summary String: edit summary
2004 * @param $flags Integer bitfield:
2006 * Article is known or assumed to be non-existent, create a new one
2008 * Article is known or assumed to be pre-existing, update it
2010 * Mark this edit minor, if the user is allowed to do so
2012 * Do not log the change in recentchanges
2014 * Mark the edit a "bot" edit regardless of user rights
2015 * EDIT_DEFER_UPDATES
2016 * Defer some of the updates until the end of index.php
2018 * Fill in blank summaries with generated text where possible
2020 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2021 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2022 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2023 * edit-already-exists error will be returned. These two conditions are also possible with
2024 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2026 * @param $baseRevId the revision ID this edit was based off, if any
2027 * @param $user Optional user object, $wgUser will be used if not passed
2028 * @param $watchthis Watch the page if true, unwatch the page if false, do nothing if null
2029 * @param $comment Boolean: whether the edit is a new section
2030 * @param $sectionanchor The section anchor for the page; used for redirecting the user back to the page
2031 * after the edit is successfully committed
2032 * @param $redirect If true, redirect the user back to the page after the edit is successfully committed
2034 * @return Status object. Possible errors:
2035 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2036 * edit-gone-missing: In update mode, but the article didn't exist
2037 * edit-conflict: In update mode, the article changed unexpectedly
2038 * edit-no-change: Warning that the text was the same as before
2039 * edit-already-exists: In creation mode, but the article already exists
2041 * Extensions may define additional errors.
2043 * $return->value will contain an associative array with members as follows:
2044 * new: Boolean indicating if the function attempted to create a new article
2045 * revision: The revision object for the inserted revision, or null
2047 * Compatibility note: this function previously returned a boolean value indicating success/failure
2049 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null , $watchthis = null,
2050 $comment = false, $sectionanchor = '', $redirect = false) {
2051 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2053 # Low-level sanity check
2054 if ( $this->mTitle
->getText() === '' ) {
2055 throw new MWException( 'Something is trying to edit an article with an empty title' );
2058 wfProfileIn( __METHOD__
);
2060 $user = is_null( $user ) ?
$wgUser : $user;
2061 $status = Status
::newGood( array() );
2063 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2064 $this->loadPageData();
2066 $flags = $this->checkFlags( $flags );
2068 # If this is a comment, add the summary as headline
2069 if ( $comment && $summary != "" ) {
2070 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
2073 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2074 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, &$status) ) )
2076 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2077 wfProfileOut( __METHOD__
);
2079 if ( $status->isOK() ) {
2080 $status->fatal( 'edit-hook-aborted' );
2086 # Silently ignore EDIT_MINOR if not allowed
2087 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2088 $bot = $flags & EDIT_FORCE_BOT
;
2090 $oldtext = $this->getRawText(); // current revision
2091 $oldsize = strlen( $oldtext );
2093 # Provide autosummaries if one is not provided and autosummaries are enabled.
2094 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2095 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2098 $editInfo = $this->prepareTextForEdit( $text );
2099 $text = $editInfo->pst
;
2100 $newsize = strlen( $text );
2102 $dbw = wfGetDB( DB_MASTER
);
2103 $now = wfTimestampNow();
2104 $this->mTimestamp
= $now;
2106 if ( $flags & EDIT_UPDATE
) {
2107 # Update article, but only if changed.
2108 $status->value
['new'] = false;
2110 # Make sure the revision is either completely inserted or not inserted at all
2111 if ( !$wgDBtransactions ) {
2112 $userAbort = ignore_user_abort( true );
2117 $changed = ( strcmp( $text, $oldtext ) != 0 );
2120 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2121 - (int)$this->isCountable( $oldtext );
2122 $this->mTotalAdjustment
= 0;
2124 if ( !$this->mLatest
) {
2125 # Article gone missing
2126 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2127 $status->fatal( 'edit-gone-missing' );
2129 wfProfileOut( __METHOD__
);
2133 $revision = new Revision( array(
2134 'page' => $this->getId(),
2135 'comment' => $summary,
2136 'minor_edit' => $isminor,
2138 'parent_id' => $this->mLatest
,
2139 'user' => $user->getId(),
2140 'user_text' => $user->getName(),
2144 $revisionId = $revision->insertOn( $dbw );
2148 # Note that we use $this->mLatest instead of fetching a value from the master DB
2149 # during the course of this function. This makes sure that EditPage can detect
2150 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2151 # before this function is called. A previous function used a separate query, this
2152 # creates a window where concurrent edits can cause an ignored edit conflict.
2153 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2156 /* Belated edit conflict! Run away!! */
2157 $status->fatal( 'edit-conflict' );
2159 # Delete the invalid revision if the DB is not transactional
2160 if ( !$wgDBtransactions ) {
2161 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2167 global $wgUseRCPatrol;
2168 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2169 # Update recentchanges
2170 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2171 # Mark as patrolled if the user can do so
2172 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan( 'autopatrol' );
2173 # Add RC row to the DB
2174 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2175 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2176 $revisionId, $patrolled
2179 # Log auto-patrolled edits
2181 PatrolLog
::record( $rc, true );
2184 $user->incEditCount();
2188 $status->warning( 'edit-no-change' );
2190 // Keep the same revision ID, but do some updates on it
2191 $revisionId = $this->getRevIdFetched();
2192 // Update page_touched, this is usually implicit in the page update
2193 // Other cache updates are done in onArticleEdit()
2194 $this->mTitle
->invalidateCache();
2197 if ( !$wgDBtransactions ) {
2198 ignore_user_abort( $userAbort );
2201 // Now that ignore_user_abort is restored, we can respond to fatal errors
2202 if ( !$status->isOK() ) {
2203 wfProfileOut( __METHOD__
);
2207 # Invalidate cache of this article and all pages using this article
2208 # as a template. Partly deferred.
2209 Article
::onArticleEdit( $this->mTitle
);
2210 # Update links tables, site stats, etc.
2211 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2213 # Create new article
2214 $status->value
['new'] = true;
2216 # Set statistics members
2217 # We work out if it's countable after PST to avoid counter drift
2218 # when articles are created with {{subst:}}
2219 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2220 $this->mTotalAdjustment
= 1;
2224 # Add the page record; stake our claim on this title!
2225 # This will return false if the article already exists
2226 $newid = $this->insertOn( $dbw );
2228 if ( $newid === false ) {
2230 $status->fatal( 'edit-already-exists' );
2232 wfProfileOut( __METHOD__
);
2236 # Save the revision text...
2237 $revision = new Revision( array(
2239 'comment' => $summary,
2240 'minor_edit' => $isminor,
2242 'user' => $user->getId(),
2243 'user_text' => $user->getName(),
2245 $revisionId = $revision->insertOn( $dbw );
2247 $this->mTitle
->resetArticleID( $newid );
2249 # Update the page record with revision data
2250 $this->updateRevisionOn( $dbw, $revision, 0 );
2252 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2254 # Update recentchanges
2255 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2256 global $wgUseRCPatrol, $wgUseNPPatrol;
2258 # Mark as patrolled if the user can do so
2259 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && $this->mTitle
->userCan( 'autopatrol' );
2260 # Add RC row to the DB
2261 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2262 '', strlen( $text ), $revisionId, $patrolled );
2264 # Log auto-patrolled edits
2266 PatrolLog
::record( $rc, true );
2269 $user->incEditCount();
2272 # Update links, etc.
2273 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2276 Article
::onArticleCreate( $this->mTitle
);
2278 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2279 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision ) );
2282 # Do updates right now unless deferral was requested
2283 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2287 // Return the new revision (or null) to the caller
2288 $status->value
['revision'] = $revision;
2290 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2291 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision, &$status, $baseRevId,
2294 # Watch or unwatch the page
2295 if ( $watchthis === true ) {
2296 if ( !$this->mTitle
->userIsWatching() ) {
2301 } elseif ( $watchthis === false ) {
2302 if ( $this->mTitle
->userIsWatching() ) {
2309 # Give extensions a chance to modify URL query on update
2312 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2315 if ( $sectionanchor ||
$extraQuery ) {
2316 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2318 $this->doRedirect( $this->isRedirect( $text ) );
2322 wfProfileOut( __METHOD__
);
2328 * @deprecated wrapper for doRedirect
2330 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2331 wfDeprecated( __METHOD__
);
2332 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2336 * Output a redirect back to the article.
2337 * This is typically used after an edit.
2339 * @param $noRedir Boolean: add redirect=no
2340 * @param $sectionAnchor String: section to redirect to, including "#"
2341 * @param $extraQuery String: extra query params
2343 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2347 $query = 'redirect=no';
2349 $query .= "&$extraQuery";
2351 $query = $extraQuery;
2354 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2358 * Mark this particular edit/page as patrolled
2360 public function markpatrolled() {
2361 global $wgOut, $wgRequest;
2363 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2365 # If we haven't been given an rc_id value, we can't do anything
2366 $rcid = (int) $wgRequest->getVal( 'rcid' );
2367 $rc = RecentChange
::newFromId( $rcid );
2369 if ( is_null( $rc ) ) {
2370 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2374 # It would be nice to see where the user had actually come from, but for now just guess
2375 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2376 $return = SpecialPage
::getTitleFor( $returnto );
2378 $errors = $rc->doMarkPatrolled();
2380 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2381 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2386 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2387 // The hook itself has handled any output
2391 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2392 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2393 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2394 $wgOut->returnToMain( false, $return );
2399 if ( !empty( $errors ) ) {
2400 $wgOut->showPermissionsErrorPage( $errors );
2406 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2407 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2408 $wgOut->returnToMain( false, $return );
2412 * User-interface handler for the "watch" action
2414 public function watch() {
2415 global $wgUser, $wgOut;
2417 if ( $wgUser->isAnon() ) {
2418 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2422 if ( wfReadOnly() ) {
2423 $wgOut->readOnlyPage();
2427 if ( $this->doWatch() ) {
2428 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2429 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2430 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2433 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2437 * Add this page to $wgUser's watchlist
2438 * @return bool true on successful watch operation
2440 public function doWatch() {
2443 if ( $wgUser->isAnon() ) {
2447 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2448 $wgUser->addWatch( $this->mTitle
);
2449 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2456 * User interface handler for the "unwatch" action.
2458 public function unwatch() {
2459 global $wgUser, $wgOut;
2461 if ( $wgUser->isAnon() ) {
2462 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2466 if ( wfReadOnly() ) {
2467 $wgOut->readOnlyPage();
2471 if ( $this->doUnwatch() ) {
2472 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2473 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2474 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2477 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2481 * Stop watching a page
2482 * @return bool true on successful unwatch
2484 public function doUnwatch() {
2487 if ( $wgUser->isAnon() ) {
2491 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2492 $wgUser->removeWatch( $this->mTitle
);
2493 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2500 * action=protect handler
2502 public function protect() {
2503 $form = new ProtectionForm( $this );
2508 * action=unprotect handler (alias)
2510 public function unprotect() {
2515 * Update the article's restriction field, and leave a log entry.
2517 * @param $limit Array: set of restriction keys
2518 * @param $reason String
2519 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2520 * @param $expiry Array: per restriction type expiration
2521 * @return bool true on success
2523 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2524 global $wgUser, $wgContLang;
2526 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2528 $id = $this->mTitle
->getArticleID();
2531 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2535 if ( wfReadOnly() ) {
2536 wfDebug( "updateRestrictions failed: read-only\n" );
2540 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2541 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2549 // Take this opportunity to purge out expired restrictions
2550 Title
::purgeExpiredRestrictions();
2552 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2553 # we expect a single selection, but the schema allows otherwise.
2555 $updated = Article
::flattenRestrictions( $limit );
2558 foreach ( $restrictionTypes as $action ) {
2559 if ( isset( $expiry[$action] ) ) {
2560 # Get current restrictions on $action
2561 $aLimits = $this->mTitle
->getRestrictions( $action );
2562 $current[$action] = implode( '', $aLimits );
2563 # Are any actual restrictions being dealt with here?
2564 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2566 # If something changed, we need to log it. Checking $aRChanged
2567 # assures that "unprotecting" a page that is not protected does
2568 # not log just because the expiry was "changed".
2569 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2575 $current = Article
::flattenRestrictions( $current );
2577 $changed = ( $changed ||
$current != $updated );
2578 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2579 $protect = ( $updated != '' );
2581 # If nothing's changed, do nothing
2583 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2584 $dbw = wfGetDB( DB_MASTER
);
2586 # Prepare a null revision to be added to the history
2587 $modified = $current != '' && $protect;
2590 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2592 $comment_type = 'unprotectedarticle';
2595 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2597 # Only restrictions with the 'protect' right can cascade...
2598 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2599 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2601 # The schema allows multiple restrictions
2602 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2606 $cascade_description = '';
2609 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2613 $comment .= ": $reason";
2616 $editComment = $comment;
2617 $encodedExpiry = array();
2618 $protect_description = '';
2619 foreach ( $limit as $action => $restrictions ) {
2620 if ( !isset( $expiry[$action] ) )
2621 $expiry[$action] = 'infinite';
2623 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2624 if ( $restrictions != '' ) {
2625 $protect_description .= "[$action=$restrictions] (";
2626 if ( $encodedExpiry[$action] != 'infinity' ) {
2627 $protect_description .= wfMsgForContent( 'protect-expiring',
2628 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2629 $wgContLang->date( $expiry[$action], false, false ) ,
2630 $wgContLang->time( $expiry[$action], false, false ) );
2632 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2635 $protect_description .= ') ';
2638 $protect_description = trim( $protect_description );
2640 if ( $protect_description && $protect ) {
2641 $editComment .= " ($protect_description)";
2645 $editComment .= "$cascade_description";
2648 # Update restrictions table
2649 foreach ( $limit as $action => $restrictions ) {
2650 if ( $restrictions != '' ) {
2651 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2652 array( 'pr_page' => $id,
2653 'pr_type' => $action,
2654 'pr_level' => $restrictions,
2655 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2656 'pr_expiry' => $encodedExpiry[$action]
2661 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2662 'pr_type' => $action ), __METHOD__
);
2666 # Insert a null revision
2667 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2668 $nullRevId = $nullRevision->insertOn( $dbw );
2670 $latest = $this->getLatest();
2671 # Update page record
2672 $dbw->update( 'page',
2674 'page_touched' => $dbw->timestamp(),
2675 'page_restrictions' => '',
2676 'page_latest' => $nullRevId
2677 ), array( /* WHERE */
2679 ), 'Article::protect'
2682 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2683 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2685 # Update the protection log
2686 $log = new LogPage( 'protect' );
2688 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2689 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2691 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2694 } # End "changed" check
2700 * Take an array of page restrictions and flatten it to a string
2701 * suitable for insertion into the page_restrictions field.
2702 * @param $limit Array
2705 protected static function flattenRestrictions( $limit ) {
2706 if ( !is_array( $limit ) ) {
2707 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2713 foreach ( $limit as $action => $restrictions ) {
2714 if ( $restrictions != '' ) {
2715 $bits[] = "$action=$restrictions";
2719 return implode( ':', $bits );
2723 * Auto-generates a deletion reason
2725 * @param &$hasHistory Boolean: whether the page has a history
2726 * @return mixed String containing deletion reason or empty string, or boolean false
2727 * if no revision occurred
2729 public function generateReason( &$hasHistory ) {
2732 $dbw = wfGetDB( DB_MASTER
);
2733 // Get the last revision
2734 $rev = Revision
::newFromTitle( $this->mTitle
);
2736 if ( is_null( $rev ) ) {
2740 // Get the article's contents
2741 $contents = $rev->getText();
2744 // If the page is blank, use the text from the previous revision,
2745 // which can only be blank if there's a move/import/protect dummy revision involved
2746 if ( $contents == '' ) {
2747 $prev = $rev->getPrevious();
2750 $contents = $prev->getText();
2755 // Find out if there was only one contributor
2756 // Only scan the last 20 revisions
2757 $res = $dbw->select( 'revision', 'rev_user_text',
2758 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2760 array( 'LIMIT' => 20 )
2763 if ( $res === false ) {
2764 // This page has no revisions, which is very weird
2768 $hasHistory = ( $res->numRows() > 1 );
2769 $row = $dbw->fetchObject( $res );
2771 if ( $row ) { // $row is false if the only contributor is hidden
2772 $onlyAuthor = $row->rev_user_text
;
2773 // Try to find a second contributor
2774 foreach ( $res as $row ) {
2775 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2776 $onlyAuthor = false;
2781 $onlyAuthor = false;
2784 $dbw->freeResult( $res );
2786 // Generate the summary with a '$1' placeholder
2788 // The current revision is blank and the one before is also
2789 // blank. It's just not our lucky day
2790 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2792 if ( $onlyAuthor ) {
2793 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2795 $reason = wfMsgForContent( 'excontent', '$1' );
2799 if ( $reason == '-' ) {
2800 // Allow these UI messages to be blanked out cleanly
2804 // Replace newlines with spaces to prevent uglyness
2805 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2806 // Calculate the maximum amount of chars to get
2807 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2808 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2809 $contents = $wgContLang->truncate( $contents, $maxLength );
2810 // Remove possible unfinished links
2811 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2812 // Now replace the '$1' placeholder
2813 $reason = str_replace( '$1', $contents, $reason );
2820 * UI entry point for page deletion
2822 public function delete() {
2823 global $wgUser, $wgOut, $wgRequest;
2825 $confirm = $wgRequest->wasPosted() &&
2826 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2828 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2829 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2831 $reason = $this->DeleteReasonList
;
2833 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2834 // Entry from drop down menu + additional comment
2835 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2836 } elseif ( $reason == 'other' ) {
2837 $reason = $this->DeleteReason
;
2840 # Flag to hide all contents of the archived revisions
2841 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2843 # This code desperately needs to be totally rewritten
2845 # Read-only check...
2846 if ( wfReadOnly() ) {
2847 $wgOut->readOnlyPage();
2853 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2855 if ( count( $permission_errors ) > 0 ) {
2856 $wgOut->showPermissionsErrorPage( $permission_errors );
2861 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2863 # Better double-check that it hasn't been deleted yet!
2864 $dbw = wfGetDB( DB_MASTER
);
2865 $conds = $this->mTitle
->pageCond();
2866 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2867 if ( $latest === false ) {
2868 $wgOut->showFatalError(
2871 array( 'class' => 'error mw-error-cannotdelete' ),
2872 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2875 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2876 LogEventsList
::showLogExtract(
2879 $this->mTitle
->getPrefixedText()
2885 # Hack for big sites
2886 $bigHistory = $this->isBigDeletion();
2887 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2888 global $wgLang, $wgDeleteRevisionsLimit;
2890 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2891 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2897 $this->doDelete( $reason, $suppress );
2899 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2901 } elseif ( $this->mTitle
->userIsWatching() ) {
2908 // Generate deletion reason
2909 $hasHistory = false;
2911 $reason = $this->generateReason( $hasHistory );
2914 // If the page has a history, insert a warning
2915 if ( $hasHistory && !$confirm ) {
2918 $skin = $wgUser->getSkin();
2919 $revisions = $this->estimateRevisionCount();
2921 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2922 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2923 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2927 if ( $bigHistory ) {
2928 global $wgDeleteRevisionsLimit;
2929 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2930 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2934 return $this->confirmDelete( $reason );
2938 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2940 public function isBigDeletion() {
2941 global $wgDeleteRevisionsLimit;
2943 if ( $wgDeleteRevisionsLimit ) {
2944 $revCount = $this->estimateRevisionCount();
2946 return $revCount > $wgDeleteRevisionsLimit;
2953 * @return int approximate revision count
2955 public function estimateRevisionCount() {
2956 $dbr = wfGetDB( DB_SLAVE
);
2958 // For an exact count...
2959 // return $dbr->selectField( 'revision', 'COUNT(*)',
2960 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2961 return $dbr->estimateRowCount( 'revision', '*',
2962 array( 'rev_page' => $this->getId() ), __METHOD__
);
2966 * Get the last N authors
2967 * @param $num Integer: number of revisions to get
2968 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2969 * @return array Array of authors, duplicates not removed
2971 public function getLastNAuthors( $num, $revLatest = 0 ) {
2972 wfProfileIn( __METHOD__
);
2973 // First try the slave
2974 // If that doesn't have the latest revision, try the master
2976 $db = wfGetDB( DB_SLAVE
);
2979 $res = $db->select( array( 'page', 'revision' ),
2980 array( 'rev_id', 'rev_user_text' ),
2982 'page_namespace' => $this->mTitle
->getNamespace(),
2983 'page_title' => $this->mTitle
->getDBkey(),
2984 'rev_page = page_id'
2985 ), __METHOD__
, $this->getSelectOptions( array(
2986 'ORDER BY' => 'rev_timestamp DESC',
2992 wfProfileOut( __METHOD__
);
2996 $row = $db->fetchObject( $res );
2998 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2999 $db = wfGetDB( DB_MASTER
);
3004 } while ( $continue );
3006 $authors = array( $row->rev_user_text
);
3008 while ( $row = $db->fetchObject( $res ) ) {
3009 $authors[] = $row->rev_user_text
;
3012 wfProfileOut( __METHOD__
);
3017 * Output deletion confirmation dialog
3018 * FIXME: Move to another file?
3019 * @param $reason String: prefilled reason
3021 public function confirmDelete( $reason ) {
3022 global $wgOut, $wgUser;
3024 wfDebug( "Article::confirmDelete\n" );
3026 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3027 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3028 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3029 $wgOut->addWikiMsg( 'confirmdeletetext' );
3031 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3033 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3034 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
3036 <td class='mw-input'><strong>" .
3037 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3038 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3044 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3046 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3047 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3048 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3049 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3050 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3051 "<tr id=\"wpDeleteReasonListRow\">
3052 <td class='mw-label'>" .
3053 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3055 <td class='mw-input'>" .
3056 Xml
::listDropDown( 'wpDeleteReasonList',
3057 wfMsgForContent( 'deletereason-dropdown' ),
3058 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3061 <tr id=\"wpDeleteReasonRow\">
3062 <td class='mw-label'>" .
3063 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3065 <td class='mw-input'>" .
3066 Html
::input( 'wpReason', $reason, 'text', array(
3068 'maxlength' => '255',
3076 # Disallow watching if user is not logged in
3077 if ( $wgUser->isLoggedIn() ) {
3081 <td class='mw-input'>" .
3082 Xml
::checkLabel( wfMsg( 'watchthis' ),
3083 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3092 <td class='mw-submit'>" .
3093 Xml
::submitButton( wfMsg( 'deletepage' ),
3094 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3097 Xml
::closeElement( 'table' ) .
3098 Xml
::closeElement( 'fieldset' ) .
3099 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3100 Xml
::closeElement( 'form' );
3102 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3103 $skin = $wgUser->getSkin();
3104 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3105 $link = $skin->link(
3107 wfMsgHtml( 'delete-edit-reasonlist' ),
3109 array( 'action' => 'edit' )
3111 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3114 $wgOut->addHTML( $form );
3115 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3116 LogEventsList
::showLogExtract( $wgOut, 'delete',
3117 $this->mTitle
->getPrefixedText()
3122 * Perform a deletion and output success or failure messages
3124 public function doDelete( $reason, $suppress = false ) {
3125 global $wgOut, $wgUser;
3127 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3130 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3131 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3132 $deleted = $this->mTitle
->getPrefixedText();
3134 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3135 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3137 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3139 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3140 $wgOut->returnToMain( false );
3141 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3144 if ( $error == '' ) {
3145 $wgOut->showFatalError(
3148 array( 'class' => 'error mw-error-cannotdelete' ),
3149 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3153 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3155 LogEventsList
::showLogExtract(
3158 $this->mTitle
->getPrefixedText()
3161 $wgOut->showFatalError( $error );
3167 * Back-end article deletion
3168 * Deletes the article with database consistency, writes logs, purges caches
3170 * @param $reason string delete reason for deletion log
3171 * @param suppress bitfield
3172 * Revision::DELETED_TEXT
3173 * Revision::DELETED_COMMENT
3174 * Revision::DELETED_USER
3175 * Revision::DELETED_RESTRICTED
3176 * @param $id int article ID
3177 * @param $commit boolean defaults to true, triggers transaction end
3178 * @return boolean true if successful
3180 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3181 global $wgDeferredUpdateList, $wgUseTrackbacks;
3183 wfDebug( __METHOD__
. "\n" );
3185 $dbw = wfGetDB( DB_MASTER
);
3186 $ns = $this->mTitle
->getNamespace();
3187 $t = $this->mTitle
->getDBkey();
3188 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3190 if ( $t === '' ||
$id == 0 ) {
3194 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3195 array_push( $wgDeferredUpdateList, $u );
3197 // Bitfields to further suppress the content
3200 // This should be 15...
3201 $bitfield |
= Revision
::DELETED_TEXT
;
3202 $bitfield |
= Revision
::DELETED_COMMENT
;
3203 $bitfield |
= Revision
::DELETED_USER
;
3204 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3206 $bitfield = 'rev_deleted';
3210 // For now, shunt the revision data into the archive table.
3211 // Text is *not* removed from the text table; bulk storage
3212 // is left intact to avoid breaking block-compression or
3213 // immutable storage schemes.
3215 // For backwards compatibility, note that some older archive
3216 // table entries will have ar_text and ar_flags fields still.
3218 // In the future, we may keep revisions and mark them with
3219 // the rev_deleted field, which is reserved for this purpose.
3220 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3222 'ar_namespace' => 'page_namespace',
3223 'ar_title' => 'page_title',
3224 'ar_comment' => 'rev_comment',
3225 'ar_user' => 'rev_user',
3226 'ar_user_text' => 'rev_user_text',
3227 'ar_timestamp' => 'rev_timestamp',
3228 'ar_minor_edit' => 'rev_minor_edit',
3229 'ar_rev_id' => 'rev_id',
3230 'ar_text_id' => 'rev_text_id',
3231 'ar_text' => '\'\'', // Be explicit to appease
3232 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3233 'ar_len' => 'rev_len',
3234 'ar_page_id' => 'page_id',
3235 'ar_deleted' => $bitfield
3238 'page_id = rev_page'
3242 # Delete restrictions for it
3243 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3245 # Now that it's safely backed up, delete it
3246 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3247 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3254 # Fix category table counts
3256 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3258 foreach ( $res as $row ) {
3259 $cats [] = $row->cl_to
;
3262 $this->updateCategoryCounts( array(), $cats );
3264 # If using cascading deletes, we can skip some explicit deletes
3265 if ( !$dbw->cascadingDeletes() ) {
3266 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3268 if ( $wgUseTrackbacks )
3269 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3271 # Delete outgoing links
3272 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3273 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3274 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3275 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3276 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3277 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3278 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3281 # If using cleanup triggers, we can skip some manual deletes
3282 if ( !$dbw->cleanupTriggers() ) {
3283 # Clean up recentchanges entries...
3284 $dbw->delete( 'recentchanges',
3285 array( 'rc_type != ' . RC_LOG
,
3286 'rc_namespace' => $this->mTitle
->getNamespace(),
3287 'rc_title' => $this->mTitle
->getDBkey() ),
3289 $dbw->delete( 'recentchanges',
3290 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3295 Article
::onArticleDelete( $this->mTitle
);
3297 # Clear the cached article id so the interface doesn't act like we exist
3298 $this->mTitle
->resetArticleID( 0 );
3300 # Log the deletion, if the page was suppressed, log it at Oversight instead
3301 $logtype = $suppress ?
'suppress' : 'delete';
3302 $log = new LogPage( $logtype );
3304 # Make sure logging got through
3305 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3315 * Roll back the most recent consecutive set of edits to a page
3316 * from the same user; fails if there are no eligible edits to
3317 * roll back to, e.g. user is the sole contributor. This function
3318 * performs permissions checks on $wgUser, then calls commitRollback()
3319 * to do the dirty work
3321 * @param $fromP String: Name of the user whose edits to rollback.
3322 * @param $summary String: Custom summary. Set to default summary if empty.
3323 * @param $token String: Rollback token.
3324 * @param $bot Boolean: If true, mark all reverted edits as bot.
3326 * @param $resultDetails Array: contains result-specific array of additional values
3327 * 'alreadyrolled' : 'current' (rev)
3328 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3330 * @return array of errors, each error formatted as
3331 * array(messagekey, param1, param2, ...).
3332 * On success, the array is empty. This array can also be passed to
3333 * OutputPage::showPermissionsErrorPage().
3335 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3338 $resultDetails = null;
3341 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3342 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3343 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3345 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3346 $errors[] = array( 'sessionfailure' );
3349 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3350 $errors[] = array( 'actionthrottledtext' );
3353 # If there were errors, bail out now
3354 if ( !empty( $errors ) ) {
3358 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3362 * Backend implementation of doRollback(), please refer there for parameter
3363 * and return value documentation
3365 * NOTE: This function does NOT check ANY permissions, it just commits the
3366 * rollback to the DB Therefore, you should only call this function direct-
3367 * ly if you want to use custom permissions checks. If you don't, use
3368 * doRollback() instead.
3370 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3371 global $wgUseRCPatrol, $wgUser, $wgLang;
3373 $dbw = wfGetDB( DB_MASTER
);
3375 if ( wfReadOnly() ) {
3376 return array( array( 'readonlytext' ) );
3379 # Get the last editor
3380 $current = Revision
::newFromTitle( $this->mTitle
);
3381 if ( is_null( $current ) ) {
3382 # Something wrong... no page?
3383 return array( array( 'notanarticle' ) );
3386 $from = str_replace( '_', ' ', $fromP );
3387 # User name given should match up with the top revision.
3388 # If the user was deleted then $from should be empty.
3389 if ( $from != $current->getUserText() ) {
3390 $resultDetails = array( 'current' => $current );
3391 return array( array( 'alreadyrolled',
3392 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3393 htmlspecialchars( $fromP ),
3394 htmlspecialchars( $current->getUserText() )
3398 # Get the last edit not by this guy...
3399 # Note: these may not be public values
3400 $user = intval( $current->getRawUser() );
3401 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3402 $s = $dbw->selectRow( 'revision',
3403 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3404 array( 'rev_page' => $current->getPage(),
3405 "rev_user != {$user} OR rev_user_text != {$user_text}"
3407 array( 'USE INDEX' => 'page_timestamp',
3408 'ORDER BY' => 'rev_timestamp DESC' )
3410 if ( $s === false ) {
3411 # No one else ever edited this page
3412 return array( array( 'cantrollback' ) );
3413 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3414 # Only admins can see this text
3415 return array( array( 'notvisiblerev' ) );
3419 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3420 # Mark all reverted edits as bot
3424 if ( $wgUseRCPatrol ) {
3425 # Mark all reverted edits as patrolled
3426 $set['rc_patrolled'] = 1;
3429 if ( count( $set ) ) {
3430 $dbw->update( 'recentchanges', $set,
3432 'rc_cur_id' => $current->getPage(),
3433 'rc_user_text' => $current->getUserText(),
3434 "rc_timestamp > '{$s->rev_timestamp}'",
3439 # Generate the edit summary if necessary
3440 $target = Revision
::newFromId( $s->rev_id
);
3441 if ( empty( $summary ) ) {
3442 if ( $from == '' ) { // no public user name
3443 $summary = wfMsgForContent( 'revertpage-nouser' );
3445 $summary = wfMsgForContent( 'revertpage' );
3449 # Allow the custom summary to use the same args as the default message
3451 $target->getUserText(), $from, $s->rev_id
,
3452 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3453 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3455 $summary = wfMsgReplaceArgs( $summary, $args );
3458 $flags = EDIT_UPDATE
;
3460 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3461 $flags |
= EDIT_MINOR
;
3464 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3465 $flags |
= EDIT_FORCE_BOT
;
3468 # Actually store the edit
3469 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3470 if ( !empty( $status->value
['revision'] ) ) {
3471 $revId = $status->value
['revision']->getId();
3476 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3478 $resultDetails = array(
3479 'summary' => $summary,
3480 'current' => $current,
3481 'target' => $target,
3489 * User interface for rollback operations
3491 public function rollback() {
3492 global $wgUser, $wgOut, $wgRequest;
3496 $result = $this->doRollback(
3497 $wgRequest->getVal( 'from' ),
3498 $wgRequest->getText( 'summary' ),
3499 $wgRequest->getVal( 'token' ),
3500 $wgRequest->getBool( 'bot' ),
3504 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3505 $wgOut->rateLimited();
3509 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3510 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3511 $errArray = $result[0];
3512 $errMsg = array_shift( $errArray );
3513 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3515 if ( isset( $details['current'] ) ) {
3516 $current = $details['current'];
3518 if ( $current->getComment() != '' ) {
3519 $wgOut->addWikiMsgArray( 'editcomment', array(
3520 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3527 # Display permissions errors before read-only message -- there's no
3528 # point in misleading the user into thinking the inability to rollback
3529 # is only temporary.
3530 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3531 # array_diff is completely broken for arrays of arrays, sigh.
3532 # Remove any 'readonlytext' error manually.
3534 foreach ( $result as $error ) {
3535 if ( $error != array( 'readonlytext' ) ) {
3539 $wgOut->showPermissionsErrorPage( $out );
3544 if ( $result == array( array( 'readonlytext' ) ) ) {
3545 $wgOut->readOnlyPage();
3550 $current = $details['current'];
3551 $target = $details['target'];
3552 $newId = $details['newid'];
3553 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3554 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3556 if ( $current->getUserText() === '' ) {
3557 $old = wfMsg( 'rev-deleted-user' );
3559 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3560 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3563 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3564 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3565 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3566 $wgOut->returnToMain( false, $this->mTitle
);
3568 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3569 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3570 $de->showDiff( '', '' );
3575 * Do standard deferred updates after page view
3577 public function viewUpdates() {
3578 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3579 if ( wfReadOnly() ) {
3583 # Don't update page view counters on views from bot users (bug 14044)
3584 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3585 Article
::incViewCount( $this->getID() );
3586 $u = new SiteStatsUpdate( 1, 0, 0 );
3587 array_push( $wgDeferredUpdateList, $u );
3590 # Update newtalk / watchlist notification status
3591 $wgUser->clearNotification( $this->mTitle
);
3595 * Prepare text which is about to be saved.
3596 * Returns a stdclass with source, pst and output members
3598 public function prepareTextForEdit( $text, $revid = null ) {
3599 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3601 return $this->mPreparedEdit
;
3606 $edit = (object)array();
3607 $edit->revid
= $revid;
3608 $edit->newText
= $text;
3609 $edit->pst
= $this->preSaveTransform( $text );
3610 $options = $this->getParserOptions();
3611 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $options, true, true, $revid );
3612 $edit->oldText
= $this->getContent();
3614 $this->mPreparedEdit
= $edit;
3620 * Do standard deferred updates after page edit.
3621 * Update links tables, site stats, search index and message cache.
3622 * Purges pages that include this page if the text was changed here.
3623 * Every 100th edit, prune the recent changes table.
3626 * @param $text New text of the article
3627 * @param $summary Edit summary
3628 * @param $minoredit Minor edit
3629 * @param $timestamp_of_pagechange Timestamp associated with the page change
3630 * @param $newid rev_id value of the new revision
3631 * @param $changed Whether or not the content actually changed
3633 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3634 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3636 wfProfileIn( __METHOD__
);
3639 # Be careful not to double-PST: $text is usually already PST-ed once
3640 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3641 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3642 $editInfo = $this->prepareTextForEdit( $text, $newid );
3644 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3645 $editInfo = $this->mPreparedEdit
;
3648 # Save it to the parser cache
3649 if ( $wgEnableParserCache ) {
3650 $popts = $this->getParserOptions();
3651 $parserCache = ParserCache
::singleton();
3652 $parserCache->save( $editInfo->output
, $this, $popts );
3655 # Update the links tables
3656 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3659 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3661 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3662 if ( 0 == mt_rand( 0, 99 ) ) {
3663 // Flush old entries from the `recentchanges` table; we do this on
3664 // random requests so as to avoid an increase in writes for no good reason
3667 $dbw = wfGetDB( DB_MASTER
);
3668 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3669 $recentchanges = $dbw->tableName( 'recentchanges' );
3670 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3672 $dbw->query( $sql );
3676 $id = $this->getID();
3677 $title = $this->mTitle
->getPrefixedDBkey();
3678 $shortTitle = $this->mTitle
->getDBkey();
3681 wfProfileOut( __METHOD__
);
3685 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3686 array_push( $wgDeferredUpdateList, $u );
3687 $u = new SearchUpdate( $id, $title, $text );
3688 array_push( $wgDeferredUpdateList, $u );
3690 # If this is another user's talk page, update newtalk
3691 # Don't do this if $changed = false otherwise some idiot can null-edit a
3692 # load of user talk pages and piss people off, nor if it's a minor edit
3693 # by a properly-flagged bot.
3694 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3695 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3697 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3698 $other = User
::newFromName( $shortTitle, false );
3700 wfDebug( __METHOD__
. ": invalid username\n" );
3701 } elseif ( User
::isIP( $shortTitle ) ) {
3702 // An anonymous user
3703 $other->setNewtalk( true );
3704 } elseif ( $other->isLoggedIn() ) {
3705 $other->setNewtalk( true );
3707 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3712 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3713 $wgMessageCache->replace( $shortTitle, $text );
3716 wfProfileOut( __METHOD__
);
3720 * Perform article updates on a special page creation.
3722 * @param $rev Revision object
3724 * @todo This is a shitty interface function. Kill it and replace the
3725 * other shitty functions like editUpdates and such so it's not needed
3728 public function createUpdates( $rev ) {
3729 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3730 $this->mTotalAdjustment
= 1;
3731 $this->editUpdates( $rev->getText(), $rev->getComment(),
3732 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3736 * Generate the navigation links when browsing through an article revisions
3737 * It shows the information as:
3738 * Revision as of \<date\>; view current revision
3739 * \<- Previous version | Next Version -\>
3741 * @param $oldid String: revision ID of this article revision
3743 public function setOldSubtitle( $oldid = 0 ) {
3744 global $wgLang, $wgOut, $wgUser, $wgRequest;
3746 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3750 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3752 # Cascade unhide param in links for easy deletion browsing
3753 $extraParams = array();
3754 if ( $wgRequest->getVal( 'unhide' ) ) {
3755 $extraParams['unhide'] = 1;
3758 $revision = Revision
::newFromId( $oldid );
3760 $current = ( $oldid == $this->mLatest
);
3761 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3762 $tddate = $wgLang->date( $this->mTimestamp
, true );
3763 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3764 $sk = $wgUser->getSkin();
3766 ?
wfMsgHtml( 'currentrevisionlink' )
3769 wfMsgHtml( 'currentrevisionlink' ),
3772 array( 'known', 'noclasses' )
3775 ?
wfMsgHtml( 'diff' )
3778 wfMsgHtml( 'diff' ),
3784 array( 'known', 'noclasses' )
3786 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3790 wfMsgHtml( 'previousrevision' ),
3793 'direction' => 'prev',
3796 array( 'known', 'noclasses' )
3798 : wfMsgHtml( 'previousrevision' );
3802 wfMsgHtml( 'diff' ),
3808 array( 'known', 'noclasses' )
3810 : wfMsgHtml( 'diff' );
3811 $nextlink = $current
3812 ?
wfMsgHtml( 'nextrevision' )
3815 wfMsgHtml( 'nextrevision' ),
3818 'direction' => 'next',
3821 array( 'known', 'noclasses' )
3823 $nextdiff = $current
3824 ?
wfMsgHtml( 'diff' )
3827 wfMsgHtml( 'diff' ),
3833 array( 'known', 'noclasses' )
3838 // User can delete revisions or view deleted revisions...
3839 $canHide = $wgUser->isAllowed( 'deleterevision' );
3840 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3841 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3842 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3845 'type' => 'revision',
3846 'target' => $this->mTitle
->getPrefixedDbkey(),
3849 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3854 # Show user links if allowed to see them. If hidden, then show them only if requested...
3855 $userlinks = $sk->revUserTools( $revision, !$unhide );
3857 $m = wfMsg( 'revision-info-current' );
3858 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3859 ?
'revision-info-current'
3862 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3865 array( 'parseinline', 'replaceafter' ),
3871 $revision->getUser()
3874 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3875 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3877 $wgOut->setSubtitle( $r );
3881 * This function is called right before saving the wikitext,
3882 * so we can do things like signatures and links-in-context.
3884 * @param $text String article contents
3885 * @return string article contents with altered wikitext markup (signatures
3886 * converted, {{subst:}}, templates, etc.)
3888 public function preSaveTransform( $text ) {
3889 global $wgParser, $wgUser;
3891 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3894 /* Caching functions */
3897 * checkLastModified returns true if it has taken care of all
3898 * output to the client that is necessary for this request.
3899 * (that is, it has sent a cached version of the page)
3901 * @return boolean true if cached version send, false otherwise
3903 protected function tryFileCache() {
3904 static $called = false;
3907 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3912 if ( $this->isFileCacheable() ) {
3913 $cache = new HTMLFileCache( $this->mTitle
);
3914 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3915 wfDebug( "Article::tryFileCache(): about to load file\n" );
3916 $cache->loadFromFileCache();
3919 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3920 ob_start( array( &$cache, 'saveToFileCache' ) );
3923 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3930 * Check if the page can be cached
3933 public function isFileCacheable() {
3936 if ( HTMLFileCache
::useFileCache() ) {
3937 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3938 // Extension may have reason to disable file caching on some pages.
3940 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3948 * Loads page_touched and returns a value indicating if it should be used
3949 * @return boolean true if not a redirect
3951 public function checkTouched() {
3952 if ( !$this->mDataLoaded
) {
3953 $this->loadPageData();
3956 return !$this->mIsRedirect
;
3960 * Get the page_touched field
3961 * @return string containing GMT timestamp
3963 public function getTouched() {
3964 if ( !$this->mDataLoaded
) {
3965 $this->loadPageData();
3968 return $this->mTouched
;
3972 * Get the page_latest field
3973 * @return integer rev_id of current revision
3975 public function getLatest() {
3976 if ( !$this->mDataLoaded
) {
3977 $this->loadPageData();
3980 return (int)$this->mLatest
;
3984 * Edit an article without doing all that other stuff
3985 * The article must already exist; link tables etc
3986 * are not updated, caches are not flushed.
3988 * @param $text String: text submitted
3989 * @param $comment String: comment submitted
3990 * @param $minor Boolean: whereas it's a minor modification
3992 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3993 wfProfileIn( __METHOD__
);
3995 $dbw = wfGetDB( DB_MASTER
);
3996 $revision = new Revision( array(
3997 'page' => $this->getId(),
3999 'comment' => $comment,
4000 'minor_edit' => $minor ?
1 : 0,
4002 $revision->insertOn( $dbw );
4003 $this->updateRevisionOn( $dbw, $revision );
4006 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4008 wfProfileOut( __METHOD__
);
4012 * Used to increment the view counter
4014 * @param $id Integer: article id
4016 public static function incViewCount( $id ) {
4017 $id = intval( $id );
4019 global $wgHitcounterUpdateFreq;
4021 $dbw = wfGetDB( DB_MASTER
);
4022 $pageTable = $dbw->tableName( 'page' );
4023 $hitcounterTable = $dbw->tableName( 'hitcounter' );
4024 $acchitsTable = $dbw->tableName( 'acchits' );
4025 $dbType = $dbw->getType();
4027 if ( $wgHitcounterUpdateFreq <= 1 ||
$dbType == 'sqlite' ) {
4028 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
4033 # Not important enough to warrant an error page in case of failure
4034 $oldignore = $dbw->ignoreErrors( true );
4036 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
4038 $checkfreq = intval( $wgHitcounterUpdateFreq / 25 +
1 );
4039 if ( ( rand() %
$checkfreq != 0 ) or ( $dbw->lastErrno() != 0 ) ) {
4040 # Most of the time (or on SQL errors), skip row count check
4041 $dbw->ignoreErrors( $oldignore );
4046 $res = $dbw->query( "SELECT COUNT(*) as n FROM $hitcounterTable" );
4047 $row = $dbw->fetchObject( $res );
4048 $rown = intval( $row->n
);
4050 if ( $rown >= $wgHitcounterUpdateFreq ) {
4051 wfProfileIn( 'Article::incViewCount-collect' );
4052 $old_user_abort = ignore_user_abort( true );
4054 $dbw->lockTables( array(), array( 'hitcounter' ), __METHOD__
, false );
4055 $tabletype = $dbType == 'mysql' ?
"ENGINE=HEAP " : '';
4056 $dbw->query( "CREATE TEMPORARY TABLE $acchitsTable $tabletype AS " .
4057 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable " .
4058 'GROUP BY hc_id', __METHOD__
);
4059 $dbw->delete( 'hitcounter', '*', __METHOD__
);
4060 $dbw->unlockTables( __METHOD__
);
4062 if ( $dbType == 'mysql' ) {
4063 $dbw->query( "UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n " .
4064 'WHERE page_id = hc_id', __METHOD__
);
4066 $dbw->query( "UPDATE $pageTable SET page_counter=page_counter + hc_n " .
4067 "FROM $acchitsTable WHERE page_id = hc_id", __METHOD__
);
4069 $dbw->query( "DROP TABLE $acchitsTable", __METHOD__
);
4071 ignore_user_abort( $old_user_abort );
4072 wfProfileOut( 'Article::incViewCount-collect' );
4075 $dbw->ignoreErrors( $oldignore );
4079 * The onArticle*() functions are supposed to be a kind of hooks
4080 * which should be called whenever any of the specified actions
4083 * This is a good place to put code to clear caches, for instance.
4085 * This is called on page move and undelete, as well as edit
4087 * @param $title a title object
4089 public static function onArticleCreate( $title ) {
4090 # Update existence markers on article/talk tabs...
4091 if ( $title->isTalkPage() ) {
4092 $other = $title->getSubjectPage();
4094 $other = $title->getTalkPage();
4097 $other->invalidateCache();
4098 $other->purgeSquid();
4100 $title->touchLinks();
4101 $title->purgeSquid();
4102 $title->deleteTitleProtection();
4106 * Clears caches when article is deleted
4108 public static function onArticleDelete( $title ) {
4109 global $wgMessageCache;
4111 # Update existence markers on article/talk tabs...
4112 if ( $title->isTalkPage() ) {
4113 $other = $title->getSubjectPage();
4115 $other = $title->getTalkPage();
4118 $other->invalidateCache();
4119 $other->purgeSquid();
4121 $title->touchLinks();
4122 $title->purgeSquid();
4125 HTMLFileCache
::clearFileCache( $title );
4128 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4129 $wgMessageCache->replace( $title->getDBkey(), false );
4133 if ( $title->getNamespace() == NS_FILE
) {
4134 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4135 $update->doUpdate();
4139 if ( $title->getNamespace() == NS_USER_TALK
) {
4140 $user = User
::newFromName( $title->getText(), false );
4141 $user->setNewtalk( false );
4145 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4149 * Purge caches on page update etc
4151 * @param $title Title object
4152 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4154 public static function onArticleEdit( $title ) {
4155 global $wgDeferredUpdateList;
4157 // Invalidate caches of articles which include this page
4158 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4160 // Invalidate the caches of all pages which redirect here
4161 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4163 # Purge squid for this page only
4164 $title->purgeSquid();
4166 # Clear file cache for this page only
4167 HTMLFileCache
::clearFileCache( $title );
4173 * Overriden by ImagePage class, only present here to avoid a fatal error
4174 * Called for ?action=revert
4176 public function revert() {
4178 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4182 * Info about this page
4183 * Called for ?action=info when $wgAllowPageInfo is on.
4185 public function info() {
4186 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4188 if ( !$wgAllowPageInfo ) {
4189 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4193 $page = $this->mTitle
->getSubjectPage();
4195 $wgOut->setPagetitle( $page->getPrefixedText() );
4196 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4197 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4199 if ( !$this->mTitle
->exists() ) {
4200 $wgOut->addHTML( '<div class="noarticletext">' );
4201 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4202 // This doesn't quite make sense; the user is asking for
4203 // information about the _page_, not the message... -- RC
4204 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4206 $msg = $wgUser->isLoggedIn()
4208 : 'noarticletextanon';
4209 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4212 $wgOut->addHTML( '</div>' );
4214 $dbr = wfGetDB( DB_SLAVE
);
4216 'wl_title' => $page->getDBkey(),
4217 'wl_namespace' => $page->getNamespace() );
4218 $numwatchers = $dbr->selectField(
4223 $this->getSelectOptions() );
4225 $pageInfo = $this->pageCountInfo( $page );
4226 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4229 //FIXME: unescaped messages
4230 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4231 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4234 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4237 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4240 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4243 $wgOut->addHTML( '</ul>' );
4248 * Return the total number of edits and number of unique editors
4249 * on a given page. If page does not exist, returns false.
4251 * @param $title Title object
4252 * @return mixed array or boolean false
4254 public function pageCountInfo( $title ) {
4255 $id = $title->getArticleId();
4261 $dbr = wfGetDB( DB_SLAVE
);
4262 $rev_clause = array( 'rev_page' => $id );
4263 $edits = $dbr->selectField(
4268 $this->getSelectOptions()
4270 $authors = $dbr->selectField(
4272 'COUNT(DISTINCT rev_user_text)',
4275 $this->getSelectOptions()
4278 return array( 'edits' => $edits, 'authors' => $authors );
4282 * Return a list of templates used by this article.
4283 * Uses the templatelinks table
4285 * @return Array of Title objects
4287 public function getUsedTemplates() {
4289 $id = $this->mTitle
->getArticleID();
4295 $dbr = wfGetDB( DB_SLAVE
);
4296 $res = $dbr->select( array( 'templatelinks' ),
4297 array( 'tl_namespace', 'tl_title' ),
4298 array( 'tl_from' => $id ),
4301 if ( $res !== false ) {
4302 foreach ( $res as $row ) {
4303 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4307 $dbr->freeResult( $res );
4313 * Returns a list of hidden categories this page is a member of.
4314 * Uses the page_props and categorylinks tables.
4316 * @return Array of Title objects
4318 public function getHiddenCategories() {
4320 $id = $this->mTitle
->getArticleID();
4326 $dbr = wfGetDB( DB_SLAVE
);
4327 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4329 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4330 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4333 if ( $res !== false ) {
4334 foreach ( $res as $row ) {
4335 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4339 $dbr->freeResult( $res );
4345 * Return an applicable autosummary if one exists for the given edit.
4346 * @param $oldtext String: the previous text of the page.
4347 * @param $newtext String: The submitted text of the page.
4348 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
4349 * @return string An appropriate autosummary, or an empty string.
4351 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4354 # Decide what kind of autosummary is needed.
4356 # Redirect autosummaries
4357 $ot = Title
::newFromRedirect( $oldtext );
4358 $rt = Title
::newFromRedirect( $newtext );
4360 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4361 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4364 # New page autosummaries
4365 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4366 # If they're making a new article, give its text, truncated, in the summary.
4368 $truncatedtext = $wgContLang->truncate(
4369 str_replace( "\n", ' ', $newtext ),
4370 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4372 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4375 # Blanking autosummaries
4376 if ( $oldtext != '' && $newtext == '' ) {
4377 return wfMsgForContent( 'autosumm-blank' );
4378 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4379 # Removing more than 90% of the article
4381 $truncatedtext = $wgContLang->truncate(
4383 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4385 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4388 # If we reach this point, there's no applicable autosummary for our case, so our
4389 # autosummary is empty.
4394 * Add the primary page-view wikitext to the output buffer
4395 * Saves the text into the parser cache if possible.
4396 * Updates templatelinks if it is out of date.
4398 * @param $text String
4399 * @param $cache Boolean
4400 * @param $parserOptions mixed ParserOptions object, or boolean false
4402 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4405 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4406 $wgOut->addParserOutput( $this->mParserOutput
);
4410 * This does all the heavy lifting for outputWikitext, except it returns the parser
4411 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4412 * say, embedding thread pages within a discussion system (LiquidThreads)
4414 * @param $text string
4415 * @param $cache boolean
4416 * @param $parserOptions parsing options, defaults to false
4417 * @return string containing parsed output
4419 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4420 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4422 if ( !$parserOptions ) {
4423 $parserOptions = $this->getParserOptions();
4427 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4428 $parserOptions, true, true, $this->getRevIdFetched() );
4433 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4434 $this->mTitle
->getPrefixedDBkey() ) );
4437 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4438 $parserCache = ParserCache
::singleton();
4439 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4442 // Make sure file cache is not used on uncacheable content.
4443 // Output that has magic words in it can still use the parser cache
4444 // (if enabled), though it will generally expire sooner.
4445 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4446 $wgUseFileCache = false;
4449 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4451 return $this->mParserOutput
;
4455 * Get parser options suitable for rendering the primary article wikitext
4456 * @return mixed ParserOptions object or boolean false
4458 public function getParserOptions() {
4461 if ( !$this->mParserOptions
) {
4462 $this->mParserOptions
= new ParserOptions( $wgUser );
4463 $this->mParserOptions
->setTidy( true );
4464 $this->mParserOptions
->enableLimitReport();
4467 return $this->mParserOptions
;
4471 * Updates cascading protections
4473 * @param $parserOutput mixed ParserOptions object, or boolean false
4476 protected function doCascadeProtectionUpdates( $parserOutput ) {
4477 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4481 // templatelinks table may have become out of sync,
4482 // especially if using variable-based transclusions.
4483 // For paranoia, check if things have changed and if
4484 // so apply updates to the database. This will ensure
4485 // that cascaded protections apply as soon as the changes
4488 # Get templates from templatelinks
4489 $id = $this->mTitle
->getArticleID();
4491 $tlTemplates = array();
4493 $dbr = wfGetDB( DB_SLAVE
);
4494 $res = $dbr->select( array( 'templatelinks' ),
4495 array( 'tl_namespace', 'tl_title' ),
4496 array( 'tl_from' => $id ),
4500 foreach ( $res as $row ) {
4501 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4504 # Get templates from parser output.
4505 $poTemplates = array();
4506 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4507 foreach ( $templates as $dbk => $id ) {
4508 $poTemplates["$ns:$dbk"] = true;
4513 # Note that we simulate array_diff_key in PHP <5.0.x
4514 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4516 if ( count( $templates_diff ) > 0 ) {
4517 # Whee, link updates time.
4518 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4524 * Update all the appropriate counts in the category table, given that
4525 * we've added the categories $added and deleted the categories $deleted.
4527 * @param $added array The names of categories that were added
4528 * @param $deleted array The names of categories that were deleted
4530 public function updateCategoryCounts( $added, $deleted ) {
4531 $ns = $this->mTitle
->getNamespace();
4532 $dbw = wfGetDB( DB_MASTER
);
4534 # First make sure the rows exist. If one of the "deleted" ones didn't
4535 # exist, we might legitimately not create it, but it's simpler to just
4536 # create it and then give it a negative value, since the value is bogus
4539 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4540 $insertCats = array_merge( $added, $deleted );
4541 if ( !$insertCats ) {
4542 # Okay, nothing to do
4546 $insertRows = array();
4548 foreach ( $insertCats as $cat ) {
4549 $insertRows[] = array(
4550 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4554 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4556 $addFields = array( 'cat_pages = cat_pages + 1' );
4557 $removeFields = array( 'cat_pages = cat_pages - 1' );
4559 if ( $ns == NS_CATEGORY
) {
4560 $addFields[] = 'cat_subcats = cat_subcats + 1';
4561 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4562 } elseif ( $ns == NS_FILE
) {
4563 $addFields[] = 'cat_files = cat_files + 1';
4564 $removeFields[] = 'cat_files = cat_files - 1';
4571 array( 'cat_title' => $added ),
4580 array( 'cat_title' => $deleted ),
4587 * Lightweight method to get the parser output for a page, checking the parser cache
4588 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4589 * consider, so it's not appropriate to use there.
4591 * @param $oldid mixed integer Revision ID or null
4593 public function getParserOutput( $oldid = null ) {
4594 global $wgEnableParserCache, $wgUser;
4596 // Should the parser cache be used?
4597 $useParserCache = $wgEnableParserCache &&
4598 intval( $wgUser->getOption( 'stubthreshold' ) ) == 0 &&
4602 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4604 if ( $wgUser->getOption( 'stubthreshold' ) ) {
4605 wfIncrStats( 'pcache_miss_stub' );
4608 $parserOutput = false;
4609 if ( $useParserCache ) {
4610 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4613 if ( $parserOutput === false ) {
4614 // Cache miss; parse and output it.
4615 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4617 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4619 return $parserOutput;
4623 // Deprecated methods
4625 * Get the database which should be used for reads
4628 * @deprecated - just call wfGetDB( DB_MASTER ) instead
4631 wfDeprecated( __METHOD__
);
4632 return wfGetDB( DB_MASTER
);