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();
1319 $token = $wgUser->editToken( $rcid );
1322 "<div class='patrollink'>" .
1324 'markaspatrolledlink',
1327 wfMsgHtml( 'markaspatrolledtext' ),
1330 'action' => 'markpatrolled',
1334 array( 'known', 'noclasses' )
1342 * Show the error text for a missing article. For articles in the MediaWiki
1343 * namespace, show the default message text. To be called from Article::view().
1345 public function showMissingArticle() {
1346 global $wgOut, $wgRequest, $wgUser;
1348 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1349 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1350 $parts = explode( '/', $this->mTitle
->getText() );
1351 $rootPart = $parts[0];
1352 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1353 $ip = User
::isIP( $rootPart );
1355 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1356 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1357 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1358 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1359 LogEventsList
::showLogExtract(
1362 $user->getUserPage()->getPrefixedText(),
1366 'showIfEmpty' => false,
1368 'blocked-notice-logextract',
1369 $user->getName() # Support GENDER in notice
1376 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1378 # Show delete and move logs
1379 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1381 'conds' => array( "log_action != 'revision'" ),
1382 'showIfEmpty' => false,
1383 'msgKey' => array( 'moveddeleted-notice' ) )
1386 # Show error message
1387 $oldid = $this->getOldID();
1389 $text = wfMsgNoTrans( 'missing-article',
1390 $this->mTitle
->getPrefixedText(),
1391 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1392 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1393 // Use the default message text
1394 $text = $this->getContent();
1396 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1397 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1398 $errors = array_merge( $createErrors, $editErrors );
1400 if ( !count( $errors ) ) {
1401 $text = wfMsgNoTrans( 'noarticletext' );
1403 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1406 $text = "<div class='noarticletext'>\n$text\n</div>";
1408 if ( !$this->hasViewableContent() ) {
1409 // If there's no backing content, send a 404 Not Found
1410 // for better machine handling of broken links.
1411 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1414 $wgOut->addWikiText( $text );
1418 * If the revision requested for view is deleted, check permissions.
1419 * Send either an error message or a warning header to $wgOut.
1421 * @return boolean true if the view is allowed, false if not.
1423 public function showDeletedRevisionHeader() {
1424 global $wgOut, $wgRequest;
1426 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1431 // If the user is not allowed to see it...
1432 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1433 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1434 'rev-deleted-text-permission' );
1437 // If the user needs to confirm that they want to see it...
1438 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1439 # Give explanation and add a link to view the revision...
1440 $oldid = intval( $this->getOldID() );
1441 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1442 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1443 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1444 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1445 array( $msg, $link ) );
1448 // We are allowed to see...
1450 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1451 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1452 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1459 * Should the parser cache be used?
1463 public function useParserCache( $oldid ) {
1464 global $wgUser, $wgEnableParserCache;
1466 return $wgEnableParserCache
1467 && intval( $wgUser->getOption( 'stubthreshold' ) ) == 0
1470 && !$this->mTitle
->isCssOrJsPage()
1471 && !$this->mTitle
->isCssJsSubpage();
1475 * Execute the uncached parse for action=view
1477 public function doViewParse() {
1480 $oldid = $this->getOldID();
1481 $useParserCache = $this->useParserCache( $oldid );
1482 $parserOptions = clone $this->getParserOptions();
1484 # Render printable version, use printable version cache
1485 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1487 # Don't show section-edit links on old revisions... this way lies madness.
1488 $parserOptions->setEditSection( $this->isCurrent() );
1489 $useParserCache = $this->useParserCache( $oldid );
1490 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1494 * Try to fetch an expired entry from the parser cache. If it is present,
1495 * output it and return true. If it is not present, output nothing and
1496 * return false. This is used as a callback function for
1497 * PoolCounter::executeProtected().
1501 public function tryDirtyCache() {
1504 $parserCache = ParserCache
::singleton();
1505 $options = $this->getParserOptions();
1506 $options->setIsPrintable( $wgOut->isPrintable() );
1507 $output = $parserCache->getDirty( $this, $options );
1510 wfDebug( __METHOD__
. ": sending dirty output\n" );
1511 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1512 $wgOut->setSquidMaxage( 0 );
1513 $this->mParserOutput
= $output;
1514 $wgOut->addParserOutput( $output );
1515 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1519 wfDebugLog( 'dirty', "dirty missing\n" );
1520 wfDebug( __METHOD__
. ": no dirty cache\n" );
1527 * Show an error page for an error from the pool counter.
1528 * @param $status Status
1530 public function showPoolError( $status ) {
1533 $wgOut->clearHTML(); // for release() errors
1534 $wgOut->enableClientCache( false );
1535 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1536 $wgOut->addWikiText(
1537 '<div class="errorbox">' .
1538 $status->getWikiText( false, 'view-pool-error' ) .
1546 * @param $target Title object or Array of destination(s) to redirect
1547 * @param $appendSubtitle Boolean [optional]
1548 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1549 * @return string containing HMTL with redirect link
1551 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1552 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1554 if ( !is_array( $target ) ) {
1555 $target = array( $target );
1558 $imageDir = $wgContLang->getDir();
1560 if ( $appendSubtitle ) {
1561 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1564 $sk = $wgUser->getSkin();
1565 // the loop prepends the arrow image before the link, so the first case needs to be outside
1566 $title = array_shift( $target );
1568 if ( $forceKnown ) {
1569 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1571 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1574 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1575 $alt = $wgContLang->isRTL() ?
'←' : '→';
1576 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1577 // FIXME: where this happens?
1578 foreach ( $target as $rt ) {
1579 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1580 if ( $forceKnown ) {
1581 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1583 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1587 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1588 return Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1589 '<span class="redirectText">' . $link . '</span>';
1593 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1595 public function addTrackbacks() {
1596 global $wgOut, $wgUser;
1598 $dbr = wfGetDB( DB_SLAVE
);
1599 $tbs = $dbr->select( 'trackbacks',
1600 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1601 array( 'tb_page' => $this->getID() )
1604 if ( !$dbr->numRows( $tbs ) ) {
1609 while ( $o = $dbr->fetchObject( $tbs ) ) {
1612 if ( $wgUser->isAllowed( 'trackback' ) ) {
1613 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1614 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1615 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1619 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1627 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1631 * Removes trackback record for current article from trackbacks table
1633 public function deletetrackback() {
1634 global $wgUser, $wgRequest, $wgOut;
1636 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1637 $wgOut->addWikiMsg( 'sessionfailure' );
1642 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1644 if ( count( $permission_errors ) ) {
1645 $wgOut->showPermissionsErrorPage( $permission_errors );
1650 $db = wfGetDB( DB_MASTER
);
1651 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1653 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1654 $this->mTitle
->invalidateCache();
1658 * Handle action=render
1661 public function render() {
1664 $wgOut->setArticleBodyOnly( true );
1669 * Handle action=purge
1671 public function purge() {
1672 global $wgUser, $wgRequest, $wgOut;
1674 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1675 //FIXME: shouldn't this be in doPurge()?
1676 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1681 $formParams = array(
1683 'action' => $wgRequest->getRequestURL(),
1686 $wgOut->addWikiMsg( 'confirm-purge-top' );
1688 $form = Html
::openElement( 'form', $formParams );
1689 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1690 $form .= Html
::closeElement( 'form' );
1692 $wgOut->addHTML( $form );
1693 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1695 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1696 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1701 * Perform the actions of a page purging
1703 public function doPurge() {
1706 // Invalidate the cache
1707 $this->mTitle
->invalidateCache();
1709 if ( $wgUseSquid ) {
1710 // Commit the transaction before the purge is sent
1711 $dbw = wfGetDB( DB_MASTER
);
1715 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1716 $update->doUpdate();
1719 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1720 global $wgMessageCache;
1722 if ( $this->getID() == 0 ) {
1725 $text = $this->getRawText();
1728 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1733 * Insert a new empty page record for this article.
1734 * This *must* be followed up by creating a revision
1735 * and running $this->updateRevisionOn( ... );
1736 * or else the record will be left in a funky state.
1737 * Best if all done inside a transaction.
1739 * @param $dbw Database
1740 * @return int The newly created page_id key, or false if the title already existed
1743 public function insertOn( $dbw ) {
1744 wfProfileIn( __METHOD__
);
1746 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1747 $dbw->insert( 'page', array(
1748 'page_id' => $page_id,
1749 'page_namespace' => $this->mTitle
->getNamespace(),
1750 'page_title' => $this->mTitle
->getDBkey(),
1751 'page_counter' => 0,
1752 'page_restrictions' => '',
1753 'page_is_redirect' => 0, # Will set this shortly...
1755 'page_random' => wfRandom(),
1756 'page_touched' => $dbw->timestamp(),
1757 'page_latest' => 0, # Fill this in shortly...
1758 'page_len' => 0, # Fill this in shortly...
1759 ), __METHOD__
, 'IGNORE' );
1761 $affected = $dbw->affectedRows();
1764 $newid = $dbw->insertId();
1765 $this->mTitle
->resetArticleId( $newid );
1767 wfProfileOut( __METHOD__
);
1769 return $affected ?
$newid : false;
1773 * Update the page record to point to a newly saved revision.
1775 * @param $dbw Database object
1776 * @param $revision Revision: For ID number, and text used to set
1777 length and redirect status fields
1778 * @param $lastRevision Integer: if given, will not overwrite the page field
1779 * when different from the currently set value.
1780 * Giving 0 indicates the new page flag should be set
1782 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1783 * removing rows in redirect table.
1784 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1785 * Needed when $lastRevision has to be set to sth. !=0
1786 * @return bool true on success, false on failure
1789 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1790 wfProfileIn( __METHOD__
);
1792 $text = $revision->getText();
1793 $rt = Title
::newFromRedirectRecurse( $text );
1795 $conditions = array( 'page_id' => $this->getId() );
1797 if ( !is_null( $lastRevision ) ) {
1798 # An extra check against threads stepping on each other
1799 $conditions['page_latest'] = $lastRevision;
1802 if ( !$setNewFlag ) {
1803 $setNewFlag = ( $lastRevision === 0 );
1806 $dbw->update( 'page',
1808 'page_latest' => $revision->getId(),
1809 'page_touched' => $dbw->timestamp(),
1810 'page_is_new' => $setNewFlag,
1811 'page_is_redirect' => $rt !== null ?
1 : 0,
1812 'page_len' => strlen( $text ),
1817 $result = $dbw->affectedRows() != 0;
1819 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1822 wfProfileOut( __METHOD__
);
1827 * Add row to the redirect table if this is a redirect, remove otherwise.
1829 * @param $dbw Database
1830 * @param $redirectTitle a title object pointing to the redirect target,
1831 * or NULL if this is not a redirect
1832 * @param $lastRevIsRedirect If given, will optimize adding and
1833 * removing rows in redirect table.
1834 * @return bool true on success, false on failure
1837 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1838 // Always update redirects (target link might have changed)
1839 // Update/Insert if we don't know if the last revision was a redirect or not
1840 // Delete if changing from redirect to non-redirect
1841 $isRedirect = !is_null( $redirectTitle );
1843 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1844 wfProfileIn( __METHOD__
);
1845 if ( $isRedirect ) {
1846 $this->insertRedirectEntry( $redirectTitle );
1848 // This is not a redirect, remove row from redirect table
1849 $where = array( 'rd_from' => $this->getId() );
1850 $dbw->delete( 'redirect', $where, __METHOD__
);
1853 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1854 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1856 wfProfileOut( __METHOD__
);
1858 return ( $dbw->affectedRows() != 0 );
1865 * If the given revision is newer than the currently set page_latest,
1866 * update the page record. Otherwise, do nothing.
1868 * @param $dbw Database object
1869 * @param $revision Revision object
1872 public function updateIfNewerOn( &$dbw, $revision ) {
1873 wfProfileIn( __METHOD__
);
1875 $row = $dbw->selectRow(
1876 array( 'revision', 'page' ),
1877 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1879 'page_id' => $this->getId(),
1880 'page_latest=rev_id' ),
1884 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1885 wfProfileOut( __METHOD__
);
1888 $prev = $row->rev_id
;
1889 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1891 # No or missing previous revision; mark the page as new
1893 $lastRevIsRedirect = null;
1896 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1898 wfProfileOut( __METHOD__
);
1903 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1904 * @param $text String: new text of the section
1905 * @param $summary String: new section's subject, only if $section is 'new'
1906 * @param $edittime String: revision timestamp or null to use the current revision
1907 * @return string Complete article text, or null if error
1909 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1910 wfProfileIn( __METHOD__
);
1912 if ( strval( $section ) == '' ) {
1913 // Whole-page edit; let the whole text through
1915 if ( is_null( $edittime ) ) {
1916 $rev = Revision
::newFromTitle( $this->mTitle
);
1918 $dbw = wfGetDB( DB_MASTER
);
1919 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1923 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1924 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1928 $oldtext = $rev->getText();
1930 if ( $section == 'new' ) {
1931 # Inserting a new section
1932 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1933 $text = strlen( trim( $oldtext ) ) > 0
1934 ?
"{$oldtext}\n\n{$subject}{$text}"
1935 : "{$subject}{$text}";
1937 # Replacing an existing section; roll out the big guns
1940 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1944 wfProfileOut( __METHOD__
);
1949 * @deprecated use Article::doEdit()
1951 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1952 wfDeprecated( __METHOD__
);
1953 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1954 ( $isminor ? EDIT_MINOR
: 0 ) |
1955 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1956 ( $bot ? EDIT_FORCE_BOT
: 0 );
1958 $this->doEdit( $text, $summary, $flags, false, null, $watchthis, $comment, '', true );
1962 * @deprecated use Article::doEdit()
1964 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1965 wfDeprecated( __METHOD__
);
1966 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1967 ( $minor ? EDIT_MINOR
: 0 ) |
1968 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1970 $status = $this->doEdit( $text, $summary, $flags, false, null, $watchthis, false, $sectionanchor, true );
1972 if ( !$status->isOK() ) {
1980 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1982 * @return Int updated $flags
1984 function checkFlags( $flags ) {
1985 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1986 if ( $this->mTitle
->getArticleID() ) {
1987 $flags |
= EDIT_UPDATE
;
1999 * Change an existing article or create a new article. Updates RC and all necessary caches,
2000 * optionally via the deferred update array.
2002 * $wgUser must be set before calling this function.
2004 * @param $text String: new text
2005 * @param $summary String: edit summary
2006 * @param $flags Integer bitfield:
2008 * Article is known or assumed to be non-existent, create a new one
2010 * Article is known or assumed to be pre-existing, update it
2012 * Mark this edit minor, if the user is allowed to do so
2014 * Do not log the change in recentchanges
2016 * Mark the edit a "bot" edit regardless of user rights
2017 * EDIT_DEFER_UPDATES
2018 * Defer some of the updates until the end of index.php
2020 * Fill in blank summaries with generated text where possible
2022 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2023 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2024 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2025 * edit-already-exists error will be returned. These two conditions are also possible with
2026 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2028 * @param $baseRevId the revision ID this edit was based off, if any
2029 * @param $user Optional user object, $wgUser will be used if not passed
2030 * @param $watchthis Watch the page if true, unwatch the page if false, do nothing if null
2031 * @param $comment Boolean: whether the edit is a new section
2032 * @param $sectionanchor The section anchor for the page; used for redirecting the user back to the page
2033 * after the edit is successfully committed
2034 * @param $redirect If true, redirect the user back to the page after the edit is successfully committed
2036 * @return Status object. Possible errors:
2037 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2038 * edit-gone-missing: In update mode, but the article didn't exist
2039 * edit-conflict: In update mode, the article changed unexpectedly
2040 * edit-no-change: Warning that the text was the same as before
2041 * edit-already-exists: In creation mode, but the article already exists
2043 * Extensions may define additional errors.
2045 * $return->value will contain an associative array with members as follows:
2046 * new: Boolean indicating if the function attempted to create a new article
2047 * revision: The revision object for the inserted revision, or null
2049 * Compatibility note: this function previously returned a boolean value indicating success/failure
2051 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null , $watchthis = null,
2052 $comment = false, $sectionanchor = '', $redirect = false) {
2053 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2055 # Low-level sanity check
2056 if ( $this->mTitle
->getText() === '' ) {
2057 throw new MWException( 'Something is trying to edit an article with an empty title' );
2060 wfProfileIn( __METHOD__
);
2062 $user = is_null( $user ) ?
$wgUser : $user;
2063 $status = Status
::newGood( array() );
2065 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2066 $this->loadPageData();
2068 $flags = $this->checkFlags( $flags );
2070 # If this is a comment, add the summary as headline
2071 if ( $comment && $summary != "" ) {
2072 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
2075 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2076 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, &$status) ) )
2078 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2079 wfProfileOut( __METHOD__
);
2081 if ( $status->isOK() ) {
2082 $status->fatal( 'edit-hook-aborted' );
2088 # Silently ignore EDIT_MINOR if not allowed
2089 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2090 $bot = $flags & EDIT_FORCE_BOT
;
2092 $oldtext = $this->getRawText(); // current revision
2093 $oldsize = strlen( $oldtext );
2095 # Provide autosummaries if one is not provided and autosummaries are enabled.
2096 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2097 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2100 $editInfo = $this->prepareTextForEdit( $text );
2101 $text = $editInfo->pst
;
2102 $newsize = strlen( $text );
2104 $dbw = wfGetDB( DB_MASTER
);
2105 $now = wfTimestampNow();
2106 $this->mTimestamp
= $now;
2108 if ( $flags & EDIT_UPDATE
) {
2109 # Update article, but only if changed.
2110 $status->value
['new'] = false;
2112 # Make sure the revision is either completely inserted or not inserted at all
2113 if ( !$wgDBtransactions ) {
2114 $userAbort = ignore_user_abort( true );
2119 $changed = ( strcmp( $text, $oldtext ) != 0 );
2122 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2123 - (int)$this->isCountable( $oldtext );
2124 $this->mTotalAdjustment
= 0;
2126 if ( !$this->mLatest
) {
2127 # Article gone missing
2128 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2129 $status->fatal( 'edit-gone-missing' );
2131 wfProfileOut( __METHOD__
);
2135 $revision = new Revision( array(
2136 'page' => $this->getId(),
2137 'comment' => $summary,
2138 'minor_edit' => $isminor,
2140 'parent_id' => $this->mLatest
,
2141 'user' => $user->getId(),
2142 'user_text' => $user->getName(),
2146 $revisionId = $revision->insertOn( $dbw );
2150 # Note that we use $this->mLatest instead of fetching a value from the master DB
2151 # during the course of this function. This makes sure that EditPage can detect
2152 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2153 # before this function is called. A previous function used a separate query, this
2154 # creates a window where concurrent edits can cause an ignored edit conflict.
2155 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2158 /* Belated edit conflict! Run away!! */
2159 $status->fatal( 'edit-conflict' );
2161 # Delete the invalid revision if the DB is not transactional
2162 if ( !$wgDBtransactions ) {
2163 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2169 global $wgUseRCPatrol;
2170 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2171 # Update recentchanges
2172 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2173 # Mark as patrolled if the user can do so
2174 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan( 'autopatrol' );
2175 # Add RC row to the DB
2176 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2177 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2178 $revisionId, $patrolled
2181 # Log auto-patrolled edits
2183 PatrolLog
::record( $rc, true );
2186 $user->incEditCount();
2190 $status->warning( 'edit-no-change' );
2192 // Keep the same revision ID, but do some updates on it
2193 $revisionId = $this->getRevIdFetched();
2194 // Update page_touched, this is usually implicit in the page update
2195 // Other cache updates are done in onArticleEdit()
2196 $this->mTitle
->invalidateCache();
2199 if ( !$wgDBtransactions ) {
2200 ignore_user_abort( $userAbort );
2203 // Now that ignore_user_abort is restored, we can respond to fatal errors
2204 if ( !$status->isOK() ) {
2205 wfProfileOut( __METHOD__
);
2209 # Invalidate cache of this article and all pages using this article
2210 # as a template. Partly deferred.
2211 Article
::onArticleEdit( $this->mTitle
);
2212 # Update links tables, site stats, etc.
2213 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2215 # Create new article
2216 $status->value
['new'] = true;
2218 # Set statistics members
2219 # We work out if it's countable after PST to avoid counter drift
2220 # when articles are created with {{subst:}}
2221 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2222 $this->mTotalAdjustment
= 1;
2226 # Add the page record; stake our claim on this title!
2227 # This will return false if the article already exists
2228 $newid = $this->insertOn( $dbw );
2230 if ( $newid === false ) {
2232 $status->fatal( 'edit-already-exists' );
2234 wfProfileOut( __METHOD__
);
2238 # Save the revision text...
2239 $revision = new Revision( array(
2241 'comment' => $summary,
2242 'minor_edit' => $isminor,
2244 'user' => $user->getId(),
2245 'user_text' => $user->getName(),
2247 $revisionId = $revision->insertOn( $dbw );
2249 $this->mTitle
->resetArticleID( $newid );
2251 # Update the page record with revision data
2252 $this->updateRevisionOn( $dbw, $revision, 0 );
2254 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2256 # Update recentchanges
2257 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2258 global $wgUseRCPatrol, $wgUseNPPatrol;
2260 # Mark as patrolled if the user can do so
2261 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && $this->mTitle
->userCan( 'autopatrol' );
2262 # Add RC row to the DB
2263 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2264 '', strlen( $text ), $revisionId, $patrolled );
2266 # Log auto-patrolled edits
2268 PatrolLog
::record( $rc, true );
2271 $user->incEditCount();
2274 # Update links, etc.
2275 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2278 Article
::onArticleCreate( $this->mTitle
);
2280 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2281 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision ) );
2284 # Do updates right now unless deferral was requested
2285 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2289 // Return the new revision (or null) to the caller
2290 $status->value
['revision'] = $revision;
2292 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2293 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision, &$status, $baseRevId,
2296 # Watch or unwatch the page
2297 if ( $watchthis === true ) {
2298 if ( !$this->mTitle
->userIsWatching() ) {
2303 } elseif ( $watchthis === false ) {
2304 if ( $this->mTitle
->userIsWatching() ) {
2311 # Give extensions a chance to modify URL query on update
2314 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2317 if ( $sectionanchor ||
$extraQuery ) {
2318 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2320 $this->doRedirect( $this->isRedirect( $text ) );
2324 wfProfileOut( __METHOD__
);
2330 * @deprecated wrapper for doRedirect
2332 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2333 wfDeprecated( __METHOD__
);
2334 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2338 * Output a redirect back to the article.
2339 * This is typically used after an edit.
2341 * @param $noRedir Boolean: add redirect=no
2342 * @param $sectionAnchor String: section to redirect to, including "#"
2343 * @param $extraQuery String: extra query params
2345 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2349 $query = 'redirect=no';
2351 $query .= "&$extraQuery";
2353 $query = $extraQuery;
2356 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2360 * Mark this particular edit/page as patrolled
2362 public function markpatrolled() {
2363 global $wgOut, $wgUser, $wgRequest;
2365 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2367 # If we haven't been given an rc_id value, we can't do anything
2368 $rcid = (int) $wgRequest->getVal( 'rcid' );
2370 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2371 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2375 $rc = RecentChange
::newFromId( $rcid );
2377 if ( is_null( $rc ) ) {
2378 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2382 # It would be nice to see where the user had actually come from, but for now just guess
2383 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2384 $return = SpecialPage
::getTitleFor( $returnto );
2386 $errors = $rc->doMarkPatrolled();
2388 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2389 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2394 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2395 // The hook itself has handled any output
2399 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2400 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2401 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2402 $wgOut->returnToMain( false, $return );
2407 if ( !empty( $errors ) ) {
2408 $wgOut->showPermissionsErrorPage( $errors );
2414 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2415 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2416 $wgOut->returnToMain( false, $return );
2420 * User-interface handler for the "watch" action
2422 public function watch() {
2423 global $wgUser, $wgOut;
2425 if ( $wgUser->isAnon() ) {
2426 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2430 if ( wfReadOnly() ) {
2431 $wgOut->readOnlyPage();
2435 if ( $this->doWatch() ) {
2436 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2437 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2438 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2441 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2445 * Add this page to $wgUser's watchlist
2446 * @return bool true on successful watch operation
2448 public function doWatch() {
2451 if ( $wgUser->isAnon() ) {
2455 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2456 $wgUser->addWatch( $this->mTitle
);
2457 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2464 * User interface handler for the "unwatch" action.
2466 public function unwatch() {
2467 global $wgUser, $wgOut;
2469 if ( $wgUser->isAnon() ) {
2470 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2474 if ( wfReadOnly() ) {
2475 $wgOut->readOnlyPage();
2479 if ( $this->doUnwatch() ) {
2480 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2481 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2482 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2485 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2489 * Stop watching a page
2490 * @return bool true on successful unwatch
2492 public function doUnwatch() {
2495 if ( $wgUser->isAnon() ) {
2499 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2500 $wgUser->removeWatch( $this->mTitle
);
2501 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2508 * action=protect handler
2510 public function protect() {
2511 $form = new ProtectionForm( $this );
2516 * action=unprotect handler (alias)
2518 public function unprotect() {
2523 * Update the article's restriction field, and leave a log entry.
2525 * @param $limit Array: set of restriction keys
2526 * @param $reason String
2527 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2528 * @param $expiry Array: per restriction type expiration
2529 * @return bool true on success
2531 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2532 global $wgUser, $wgContLang;
2534 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2536 $id = $this->mTitle
->getArticleID();
2539 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2543 if ( wfReadOnly() ) {
2544 wfDebug( "updateRestrictions failed: read-only\n" );
2548 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2549 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2557 // Take this opportunity to purge out expired restrictions
2558 Title
::purgeExpiredRestrictions();
2560 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2561 # we expect a single selection, but the schema allows otherwise.
2563 $updated = Article
::flattenRestrictions( $limit );
2566 foreach ( $restrictionTypes as $action ) {
2567 if ( isset( $expiry[$action] ) ) {
2568 # Get current restrictions on $action
2569 $aLimits = $this->mTitle
->getRestrictions( $action );
2570 $current[$action] = implode( '', $aLimits );
2571 # Are any actual restrictions being dealt with here?
2572 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2574 # If something changed, we need to log it. Checking $aRChanged
2575 # assures that "unprotecting" a page that is not protected does
2576 # not log just because the expiry was "changed".
2577 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2583 $current = Article
::flattenRestrictions( $current );
2585 $changed = ( $changed ||
$current != $updated );
2586 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2587 $protect = ( $updated != '' );
2589 # If nothing's changed, do nothing
2591 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2592 $dbw = wfGetDB( DB_MASTER
);
2594 # Prepare a null revision to be added to the history
2595 $modified = $current != '' && $protect;
2598 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2600 $comment_type = 'unprotectedarticle';
2603 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2605 # Only restrictions with the 'protect' right can cascade...
2606 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2607 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2609 # The schema allows multiple restrictions
2610 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2614 $cascade_description = '';
2617 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2621 $comment .= ": $reason";
2624 $editComment = $comment;
2625 $encodedExpiry = array();
2626 $protect_description = '';
2627 foreach ( $limit as $action => $restrictions ) {
2628 if ( !isset( $expiry[$action] ) )
2629 $expiry[$action] = 'infinite';
2631 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2632 if ( $restrictions != '' ) {
2633 $protect_description .= "[$action=$restrictions] (";
2634 if ( $encodedExpiry[$action] != 'infinity' ) {
2635 $protect_description .= wfMsgForContent( 'protect-expiring',
2636 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2637 $wgContLang->date( $expiry[$action], false, false ) ,
2638 $wgContLang->time( $expiry[$action], false, false ) );
2640 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2643 $protect_description .= ') ';
2646 $protect_description = trim( $protect_description );
2648 if ( $protect_description && $protect ) {
2649 $editComment .= " ($protect_description)";
2653 $editComment .= "$cascade_description";
2656 # Update restrictions table
2657 foreach ( $limit as $action => $restrictions ) {
2658 if ( $restrictions != '' ) {
2659 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2660 array( 'pr_page' => $id,
2661 'pr_type' => $action,
2662 'pr_level' => $restrictions,
2663 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2664 'pr_expiry' => $encodedExpiry[$action]
2669 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2670 'pr_type' => $action ), __METHOD__
);
2674 # Insert a null revision
2675 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2676 $nullRevId = $nullRevision->insertOn( $dbw );
2678 $latest = $this->getLatest();
2679 # Update page record
2680 $dbw->update( 'page',
2682 'page_touched' => $dbw->timestamp(),
2683 'page_restrictions' => '',
2684 'page_latest' => $nullRevId
2685 ), array( /* WHERE */
2687 ), 'Article::protect'
2690 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2691 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2693 # Update the protection log
2694 $log = new LogPage( 'protect' );
2696 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2697 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2699 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2702 } # End "changed" check
2708 * Take an array of page restrictions and flatten it to a string
2709 * suitable for insertion into the page_restrictions field.
2710 * @param $limit Array
2713 protected static function flattenRestrictions( $limit ) {
2714 if ( !is_array( $limit ) ) {
2715 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2721 foreach ( $limit as $action => $restrictions ) {
2722 if ( $restrictions != '' ) {
2723 $bits[] = "$action=$restrictions";
2727 return implode( ':', $bits );
2731 * Auto-generates a deletion reason
2733 * @param &$hasHistory Boolean: whether the page has a history
2734 * @return mixed String containing deletion reason or empty string, or boolean false
2735 * if no revision occurred
2737 public function generateReason( &$hasHistory ) {
2740 $dbw = wfGetDB( DB_MASTER
);
2741 // Get the last revision
2742 $rev = Revision
::newFromTitle( $this->mTitle
);
2744 if ( is_null( $rev ) ) {
2748 // Get the article's contents
2749 $contents = $rev->getText();
2752 // If the page is blank, use the text from the previous revision,
2753 // which can only be blank if there's a move/import/protect dummy revision involved
2754 if ( $contents == '' ) {
2755 $prev = $rev->getPrevious();
2758 $contents = $prev->getText();
2763 // Find out if there was only one contributor
2764 // Only scan the last 20 revisions
2765 $res = $dbw->select( 'revision', 'rev_user_text',
2766 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2768 array( 'LIMIT' => 20 )
2771 if ( $res === false ) {
2772 // This page has no revisions, which is very weird
2776 $hasHistory = ( $res->numRows() > 1 );
2777 $row = $dbw->fetchObject( $res );
2779 if ( $row ) { // $row is false if the only contributor is hidden
2780 $onlyAuthor = $row->rev_user_text
;
2781 // Try to find a second contributor
2782 foreach ( $res as $row ) {
2783 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2784 $onlyAuthor = false;
2789 $onlyAuthor = false;
2792 $dbw->freeResult( $res );
2794 // Generate the summary with a '$1' placeholder
2796 // The current revision is blank and the one before is also
2797 // blank. It's just not our lucky day
2798 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2800 if ( $onlyAuthor ) {
2801 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2803 $reason = wfMsgForContent( 'excontent', '$1' );
2807 if ( $reason == '-' ) {
2808 // Allow these UI messages to be blanked out cleanly
2812 // Replace newlines with spaces to prevent uglyness
2813 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2814 // Calculate the maximum amount of chars to get
2815 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2816 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2817 $contents = $wgContLang->truncate( $contents, $maxLength );
2818 // Remove possible unfinished links
2819 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2820 // Now replace the '$1' placeholder
2821 $reason = str_replace( '$1', $contents, $reason );
2828 * UI entry point for page deletion
2830 public function delete() {
2831 global $wgUser, $wgOut, $wgRequest;
2833 $confirm = $wgRequest->wasPosted() &&
2834 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2836 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2837 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2839 $reason = $this->DeleteReasonList
;
2841 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2842 // Entry from drop down menu + additional comment
2843 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2844 } elseif ( $reason == 'other' ) {
2845 $reason = $this->DeleteReason
;
2848 # Flag to hide all contents of the archived revisions
2849 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2851 # This code desperately needs to be totally rewritten
2853 # Read-only check...
2854 if ( wfReadOnly() ) {
2855 $wgOut->readOnlyPage();
2861 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2863 if ( count( $permission_errors ) > 0 ) {
2864 $wgOut->showPermissionsErrorPage( $permission_errors );
2869 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2871 # Better double-check that it hasn't been deleted yet!
2872 $dbw = wfGetDB( DB_MASTER
);
2873 $conds = $this->mTitle
->pageCond();
2874 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2875 if ( $latest === false ) {
2876 $wgOut->showFatalError(
2879 array( 'class' => 'error mw-error-cannotdelete' ),
2880 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2883 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2884 LogEventsList
::showLogExtract(
2887 $this->mTitle
->getPrefixedText()
2893 # Hack for big sites
2894 $bigHistory = $this->isBigDeletion();
2895 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2896 global $wgLang, $wgDeleteRevisionsLimit;
2898 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2899 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2905 $this->doDelete( $reason, $suppress );
2907 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2909 } elseif ( $this->mTitle
->userIsWatching() ) {
2916 // Generate deletion reason
2917 $hasHistory = false;
2919 $reason = $this->generateReason( $hasHistory );
2922 // If the page has a history, insert a warning
2923 if ( $hasHistory && !$confirm ) {
2926 $skin = $wgUser->getSkin();
2927 $revisions = $this->estimateRevisionCount();
2929 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2930 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2931 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2935 if ( $bigHistory ) {
2936 global $wgDeleteRevisionsLimit;
2937 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2938 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2942 return $this->confirmDelete( $reason );
2946 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2948 public function isBigDeletion() {
2949 global $wgDeleteRevisionsLimit;
2951 if ( $wgDeleteRevisionsLimit ) {
2952 $revCount = $this->estimateRevisionCount();
2954 return $revCount > $wgDeleteRevisionsLimit;
2961 * @return int approximate revision count
2963 public function estimateRevisionCount() {
2964 $dbr = wfGetDB( DB_SLAVE
);
2966 // For an exact count...
2967 // return $dbr->selectField( 'revision', 'COUNT(*)',
2968 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2969 return $dbr->estimateRowCount( 'revision', '*',
2970 array( 'rev_page' => $this->getId() ), __METHOD__
);
2974 * Get the last N authors
2975 * @param $num Integer: number of revisions to get
2976 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2977 * @return array Array of authors, duplicates not removed
2979 public function getLastNAuthors( $num, $revLatest = 0 ) {
2980 wfProfileIn( __METHOD__
);
2981 // First try the slave
2982 // If that doesn't have the latest revision, try the master
2984 $db = wfGetDB( DB_SLAVE
);
2987 $res = $db->select( array( 'page', 'revision' ),
2988 array( 'rev_id', 'rev_user_text' ),
2990 'page_namespace' => $this->mTitle
->getNamespace(),
2991 'page_title' => $this->mTitle
->getDBkey(),
2992 'rev_page = page_id'
2993 ), __METHOD__
, $this->getSelectOptions( array(
2994 'ORDER BY' => 'rev_timestamp DESC',
3000 wfProfileOut( __METHOD__
);
3004 $row = $db->fetchObject( $res );
3006 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
3007 $db = wfGetDB( DB_MASTER
);
3012 } while ( $continue );
3014 $authors = array( $row->rev_user_text
);
3016 while ( $row = $db->fetchObject( $res ) ) {
3017 $authors[] = $row->rev_user_text
;
3020 wfProfileOut( __METHOD__
);
3025 * Output deletion confirmation dialog
3026 * FIXME: Move to another file?
3027 * @param $reason String: prefilled reason
3029 public function confirmDelete( $reason ) {
3030 global $wgOut, $wgUser;
3032 wfDebug( "Article::confirmDelete\n" );
3034 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3035 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3036 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3037 $wgOut->addWikiMsg( 'confirmdeletetext' );
3039 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3041 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3042 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
3044 <td class='mw-input'><strong>" .
3045 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3046 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3052 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3054 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3055 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3056 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3057 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3058 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3059 "<tr id=\"wpDeleteReasonListRow\">
3060 <td class='mw-label'>" .
3061 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3063 <td class='mw-input'>" .
3064 Xml
::listDropDown( 'wpDeleteReasonList',
3065 wfMsgForContent( 'deletereason-dropdown' ),
3066 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3069 <tr id=\"wpDeleteReasonRow\">
3070 <td class='mw-label'>" .
3071 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3073 <td class='mw-input'>" .
3074 Html
::input( 'wpReason', $reason, 'text', array(
3076 'maxlength' => '255',
3084 # Disallow watching if user is not logged in
3085 if ( $wgUser->isLoggedIn() ) {
3089 <td class='mw-input'>" .
3090 Xml
::checkLabel( wfMsg( 'watchthis' ),
3091 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3100 <td class='mw-submit'>" .
3101 Xml
::submitButton( wfMsg( 'deletepage' ),
3102 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3105 Xml
::closeElement( 'table' ) .
3106 Xml
::closeElement( 'fieldset' ) .
3107 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3108 Xml
::closeElement( 'form' );
3110 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3111 $skin = $wgUser->getSkin();
3112 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3113 $link = $skin->link(
3115 wfMsgHtml( 'delete-edit-reasonlist' ),
3117 array( 'action' => 'edit' )
3119 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3122 $wgOut->addHTML( $form );
3123 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3124 LogEventsList
::showLogExtract( $wgOut, 'delete',
3125 $this->mTitle
->getPrefixedText()
3130 * Perform a deletion and output success or failure messages
3132 public function doDelete( $reason, $suppress = false ) {
3133 global $wgOut, $wgUser;
3135 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3138 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3139 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3140 $deleted = $this->mTitle
->getPrefixedText();
3142 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3143 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3145 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3147 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3148 $wgOut->returnToMain( false );
3149 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3152 if ( $error == '' ) {
3153 $wgOut->showFatalError(
3156 array( 'class' => 'error mw-error-cannotdelete' ),
3157 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3161 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3163 LogEventsList
::showLogExtract(
3166 $this->mTitle
->getPrefixedText()
3169 $wgOut->showFatalError( $error );
3175 * Back-end article deletion
3176 * Deletes the article with database consistency, writes logs, purges caches
3178 * @param $reason string delete reason for deletion log
3179 * @param suppress bitfield
3180 * Revision::DELETED_TEXT
3181 * Revision::DELETED_COMMENT
3182 * Revision::DELETED_USER
3183 * Revision::DELETED_RESTRICTED
3184 * @param $id int article ID
3185 * @param $commit boolean defaults to true, triggers transaction end
3186 * @return boolean true if successful
3188 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3189 global $wgDeferredUpdateList, $wgUseTrackbacks;
3191 wfDebug( __METHOD__
. "\n" );
3193 $dbw = wfGetDB( DB_MASTER
);
3194 $ns = $this->mTitle
->getNamespace();
3195 $t = $this->mTitle
->getDBkey();
3196 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3198 if ( $t === '' ||
$id == 0 ) {
3202 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3203 array_push( $wgDeferredUpdateList, $u );
3205 // Bitfields to further suppress the content
3208 // This should be 15...
3209 $bitfield |
= Revision
::DELETED_TEXT
;
3210 $bitfield |
= Revision
::DELETED_COMMENT
;
3211 $bitfield |
= Revision
::DELETED_USER
;
3212 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3214 $bitfield = 'rev_deleted';
3218 // For now, shunt the revision data into the archive table.
3219 // Text is *not* removed from the text table; bulk storage
3220 // is left intact to avoid breaking block-compression or
3221 // immutable storage schemes.
3223 // For backwards compatibility, note that some older archive
3224 // table entries will have ar_text and ar_flags fields still.
3226 // In the future, we may keep revisions and mark them with
3227 // the rev_deleted field, which is reserved for this purpose.
3228 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3230 'ar_namespace' => 'page_namespace',
3231 'ar_title' => 'page_title',
3232 'ar_comment' => 'rev_comment',
3233 'ar_user' => 'rev_user',
3234 'ar_user_text' => 'rev_user_text',
3235 'ar_timestamp' => 'rev_timestamp',
3236 'ar_minor_edit' => 'rev_minor_edit',
3237 'ar_rev_id' => 'rev_id',
3238 'ar_text_id' => 'rev_text_id',
3239 'ar_text' => '\'\'', // Be explicit to appease
3240 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3241 'ar_len' => 'rev_len',
3242 'ar_page_id' => 'page_id',
3243 'ar_deleted' => $bitfield
3246 'page_id = rev_page'
3250 # Delete restrictions for it
3251 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3253 # Now that it's safely backed up, delete it
3254 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3255 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3262 # Fix category table counts
3264 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3266 foreach ( $res as $row ) {
3267 $cats [] = $row->cl_to
;
3270 $this->updateCategoryCounts( array(), $cats );
3272 # If using cascading deletes, we can skip some explicit deletes
3273 if ( !$dbw->cascadingDeletes() ) {
3274 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3276 if ( $wgUseTrackbacks )
3277 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3279 # Delete outgoing links
3280 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3281 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3282 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3283 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3284 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3285 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3286 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3289 # If using cleanup triggers, we can skip some manual deletes
3290 if ( !$dbw->cleanupTriggers() ) {
3291 # Clean up recentchanges entries...
3292 $dbw->delete( 'recentchanges',
3293 array( 'rc_type != ' . RC_LOG
,
3294 'rc_namespace' => $this->mTitle
->getNamespace(),
3295 'rc_title' => $this->mTitle
->getDBkey() ),
3297 $dbw->delete( 'recentchanges',
3298 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3303 Article
::onArticleDelete( $this->mTitle
);
3305 # Clear the cached article id so the interface doesn't act like we exist
3306 $this->mTitle
->resetArticleID( 0 );
3308 # Log the deletion, if the page was suppressed, log it at Oversight instead
3309 $logtype = $suppress ?
'suppress' : 'delete';
3310 $log = new LogPage( $logtype );
3312 # Make sure logging got through
3313 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3323 * Roll back the most recent consecutive set of edits to a page
3324 * from the same user; fails if there are no eligible edits to
3325 * roll back to, e.g. user is the sole contributor. This function
3326 * performs permissions checks on $wgUser, then calls commitRollback()
3327 * to do the dirty work
3329 * @param $fromP String: Name of the user whose edits to rollback.
3330 * @param $summary String: Custom summary. Set to default summary if empty.
3331 * @param $token String: Rollback token.
3332 * @param $bot Boolean: If true, mark all reverted edits as bot.
3334 * @param $resultDetails Array: contains result-specific array of additional values
3335 * 'alreadyrolled' : 'current' (rev)
3336 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3338 * @return array of errors, each error formatted as
3339 * array(messagekey, param1, param2, ...).
3340 * On success, the array is empty. This array can also be passed to
3341 * OutputPage::showPermissionsErrorPage().
3343 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3346 $resultDetails = null;
3349 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3350 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3351 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3353 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3354 $errors[] = array( 'sessionfailure' );
3357 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3358 $errors[] = array( 'actionthrottledtext' );
3361 # If there were errors, bail out now
3362 if ( !empty( $errors ) ) {
3366 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3370 * Backend implementation of doRollback(), please refer there for parameter
3371 * and return value documentation
3373 * NOTE: This function does NOT check ANY permissions, it just commits the
3374 * rollback to the DB Therefore, you should only call this function direct-
3375 * ly if you want to use custom permissions checks. If you don't, use
3376 * doRollback() instead.
3378 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3379 global $wgUseRCPatrol, $wgUser, $wgLang;
3381 $dbw = wfGetDB( DB_MASTER
);
3383 if ( wfReadOnly() ) {
3384 return array( array( 'readonlytext' ) );
3387 # Get the last editor
3388 $current = Revision
::newFromTitle( $this->mTitle
);
3389 if ( is_null( $current ) ) {
3390 # Something wrong... no page?
3391 return array( array( 'notanarticle' ) );
3394 $from = str_replace( '_', ' ', $fromP );
3395 # User name given should match up with the top revision.
3396 # If the user was deleted then $from should be empty.
3397 if ( $from != $current->getUserText() ) {
3398 $resultDetails = array( 'current' => $current );
3399 return array( array( 'alreadyrolled',
3400 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3401 htmlspecialchars( $fromP ),
3402 htmlspecialchars( $current->getUserText() )
3406 # Get the last edit not by this guy...
3407 # Note: these may not be public values
3408 $user = intval( $current->getRawUser() );
3409 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3410 $s = $dbw->selectRow( 'revision',
3411 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3412 array( 'rev_page' => $current->getPage(),
3413 "rev_user != {$user} OR rev_user_text != {$user_text}"
3415 array( 'USE INDEX' => 'page_timestamp',
3416 'ORDER BY' => 'rev_timestamp DESC' )
3418 if ( $s === false ) {
3419 # No one else ever edited this page
3420 return array( array( 'cantrollback' ) );
3421 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3422 # Only admins can see this text
3423 return array( array( 'notvisiblerev' ) );
3427 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3428 # Mark all reverted edits as bot
3432 if ( $wgUseRCPatrol ) {
3433 # Mark all reverted edits as patrolled
3434 $set['rc_patrolled'] = 1;
3437 if ( count( $set ) ) {
3438 $dbw->update( 'recentchanges', $set,
3440 'rc_cur_id' => $current->getPage(),
3441 'rc_user_text' => $current->getUserText(),
3442 "rc_timestamp > '{$s->rev_timestamp}'",
3447 # Generate the edit summary if necessary
3448 $target = Revision
::newFromId( $s->rev_id
);
3449 if ( empty( $summary ) ) {
3450 if ( $from == '' ) { // no public user name
3451 $summary = wfMsgForContent( 'revertpage-nouser' );
3453 $summary = wfMsgForContent( 'revertpage' );
3457 # Allow the custom summary to use the same args as the default message
3459 $target->getUserText(), $from, $s->rev_id
,
3460 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3461 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3463 $summary = wfMsgReplaceArgs( $summary, $args );
3466 $flags = EDIT_UPDATE
;
3468 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3469 $flags |
= EDIT_MINOR
;
3472 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3473 $flags |
= EDIT_FORCE_BOT
;
3476 # Actually store the edit
3477 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3478 if ( !empty( $status->value
['revision'] ) ) {
3479 $revId = $status->value
['revision']->getId();
3484 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3486 $resultDetails = array(
3487 'summary' => $summary,
3488 'current' => $current,
3489 'target' => $target,
3497 * User interface for rollback operations
3499 public function rollback() {
3500 global $wgUser, $wgOut, $wgRequest;
3504 $result = $this->doRollback(
3505 $wgRequest->getVal( 'from' ),
3506 $wgRequest->getText( 'summary' ),
3507 $wgRequest->getVal( 'token' ),
3508 $wgRequest->getBool( 'bot' ),
3512 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3513 $wgOut->rateLimited();
3517 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3518 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3519 $errArray = $result[0];
3520 $errMsg = array_shift( $errArray );
3521 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3523 if ( isset( $details['current'] ) ) {
3524 $current = $details['current'];
3526 if ( $current->getComment() != '' ) {
3527 $wgOut->addWikiMsgArray( 'editcomment', array(
3528 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3535 # Display permissions errors before read-only message -- there's no
3536 # point in misleading the user into thinking the inability to rollback
3537 # is only temporary.
3538 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3539 # array_diff is completely broken for arrays of arrays, sigh.
3540 # Remove any 'readonlytext' error manually.
3542 foreach ( $result as $error ) {
3543 if ( $error != array( 'readonlytext' ) ) {
3547 $wgOut->showPermissionsErrorPage( $out );
3552 if ( $result == array( array( 'readonlytext' ) ) ) {
3553 $wgOut->readOnlyPage();
3558 $current = $details['current'];
3559 $target = $details['target'];
3560 $newId = $details['newid'];
3561 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3562 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3564 if ( $current->getUserText() === '' ) {
3565 $old = wfMsg( 'rev-deleted-user' );
3567 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3568 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3571 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3572 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3573 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3574 $wgOut->returnToMain( false, $this->mTitle
);
3576 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3577 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3578 $de->showDiff( '', '' );
3583 * Do standard deferred updates after page view
3585 public function viewUpdates() {
3586 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3587 if ( wfReadOnly() ) {
3591 # Don't update page view counters on views from bot users (bug 14044)
3592 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3593 Article
::incViewCount( $this->getID() );
3594 $u = new SiteStatsUpdate( 1, 0, 0 );
3595 array_push( $wgDeferredUpdateList, $u );
3598 # Update newtalk / watchlist notification status
3599 $wgUser->clearNotification( $this->mTitle
);
3603 * Prepare text which is about to be saved.
3604 * Returns a stdclass with source, pst and output members
3606 public function prepareTextForEdit( $text, $revid = null ) {
3607 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3609 return $this->mPreparedEdit
;
3614 $edit = (object)array();
3615 $edit->revid
= $revid;
3616 $edit->newText
= $text;
3617 $edit->pst
= $this->preSaveTransform( $text );
3618 $options = $this->getParserOptions();
3619 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $options, true, true, $revid );
3620 $edit->oldText
= $this->getContent();
3622 $this->mPreparedEdit
= $edit;
3628 * Do standard deferred updates after page edit.
3629 * Update links tables, site stats, search index and message cache.
3630 * Purges pages that include this page if the text was changed here.
3631 * Every 100th edit, prune the recent changes table.
3634 * @param $text New text of the article
3635 * @param $summary Edit summary
3636 * @param $minoredit Minor edit
3637 * @param $timestamp_of_pagechange Timestamp associated with the page change
3638 * @param $newid rev_id value of the new revision
3639 * @param $changed Whether or not the content actually changed
3641 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3642 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3644 wfProfileIn( __METHOD__
);
3647 # Be careful not to double-PST: $text is usually already PST-ed once
3648 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3649 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3650 $editInfo = $this->prepareTextForEdit( $text, $newid );
3652 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3653 $editInfo = $this->mPreparedEdit
;
3656 # Save it to the parser cache
3657 if ( $wgEnableParserCache ) {
3658 $popts = $this->getParserOptions();
3659 $parserCache = ParserCache
::singleton();
3660 $parserCache->save( $editInfo->output
, $this, $popts );
3663 # Update the links tables
3664 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3667 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3669 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3670 if ( 0 == mt_rand( 0, 99 ) ) {
3671 // Flush old entries from the `recentchanges` table; we do this on
3672 // random requests so as to avoid an increase in writes for no good reason
3675 $dbw = wfGetDB( DB_MASTER
);
3676 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3677 $recentchanges = $dbw->tableName( 'recentchanges' );
3678 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3680 $dbw->query( $sql );
3684 $id = $this->getID();
3685 $title = $this->mTitle
->getPrefixedDBkey();
3686 $shortTitle = $this->mTitle
->getDBkey();
3689 wfProfileOut( __METHOD__
);
3693 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3694 array_push( $wgDeferredUpdateList, $u );
3695 $u = new SearchUpdate( $id, $title, $text );
3696 array_push( $wgDeferredUpdateList, $u );
3698 # If this is another user's talk page, update newtalk
3699 # Don't do this if $changed = false otherwise some idiot can null-edit a
3700 # load of user talk pages and piss people off, nor if it's a minor edit
3701 # by a properly-flagged bot.
3702 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3703 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3705 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3706 $other = User
::newFromName( $shortTitle, false );
3708 wfDebug( __METHOD__
. ": invalid username\n" );
3709 } elseif ( User
::isIP( $shortTitle ) ) {
3710 // An anonymous user
3711 $other->setNewtalk( true );
3712 } elseif ( $other->isLoggedIn() ) {
3713 $other->setNewtalk( true );
3715 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3720 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3721 $wgMessageCache->replace( $shortTitle, $text );
3724 wfProfileOut( __METHOD__
);
3728 * Perform article updates on a special page creation.
3730 * @param $rev Revision object
3732 * @todo This is a shitty interface function. Kill it and replace the
3733 * other shitty functions like editUpdates and such so it's not needed
3736 public function createUpdates( $rev ) {
3737 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3738 $this->mTotalAdjustment
= 1;
3739 $this->editUpdates( $rev->getText(), $rev->getComment(),
3740 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3744 * Generate the navigation links when browsing through an article revisions
3745 * It shows the information as:
3746 * Revision as of \<date\>; view current revision
3747 * \<- Previous version | Next Version -\>
3749 * @param $oldid String: revision ID of this article revision
3751 public function setOldSubtitle( $oldid = 0 ) {
3752 global $wgLang, $wgOut, $wgUser, $wgRequest;
3754 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3758 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3760 # Cascade unhide param in links for easy deletion browsing
3761 $extraParams = array();
3762 if ( $wgRequest->getVal( 'unhide' ) ) {
3763 $extraParams['unhide'] = 1;
3766 $revision = Revision
::newFromId( $oldid );
3768 $current = ( $oldid == $this->mLatest
);
3769 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3770 $tddate = $wgLang->date( $this->mTimestamp
, true );
3771 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3772 $sk = $wgUser->getSkin();
3774 ?
wfMsgHtml( 'currentrevisionlink' )
3777 wfMsgHtml( 'currentrevisionlink' ),
3780 array( 'known', 'noclasses' )
3783 ?
wfMsgHtml( 'diff' )
3786 wfMsgHtml( 'diff' ),
3792 array( 'known', 'noclasses' )
3794 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3798 wfMsgHtml( 'previousrevision' ),
3801 'direction' => 'prev',
3804 array( 'known', 'noclasses' )
3806 : wfMsgHtml( 'previousrevision' );
3810 wfMsgHtml( 'diff' ),
3816 array( 'known', 'noclasses' )
3818 : wfMsgHtml( 'diff' );
3819 $nextlink = $current
3820 ?
wfMsgHtml( 'nextrevision' )
3823 wfMsgHtml( 'nextrevision' ),
3826 'direction' => 'next',
3829 array( 'known', 'noclasses' )
3831 $nextdiff = $current
3832 ?
wfMsgHtml( 'diff' )
3835 wfMsgHtml( 'diff' ),
3841 array( 'known', 'noclasses' )
3846 // User can delete revisions or view deleted revisions...
3847 $canHide = $wgUser->isAllowed( 'deleterevision' );
3848 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3849 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3850 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3853 'type' => 'revision',
3854 'target' => $this->mTitle
->getPrefixedDbkey(),
3857 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3862 # Show user links if allowed to see them. If hidden, then show them only if requested...
3863 $userlinks = $sk->revUserTools( $revision, !$unhide );
3865 $m = wfMsg( 'revision-info-current' );
3866 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3867 ?
'revision-info-current'
3870 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3873 array( 'parseinline', 'replaceafter' ),
3879 $revision->getUser()
3882 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3883 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3885 $wgOut->setSubtitle( $r );
3889 * This function is called right before saving the wikitext,
3890 * so we can do things like signatures and links-in-context.
3892 * @param $text String article contents
3893 * @return string article contents with altered wikitext markup (signatures
3894 * converted, {{subst:}}, templates, etc.)
3896 public function preSaveTransform( $text ) {
3897 global $wgParser, $wgUser;
3899 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3902 /* Caching functions */
3905 * checkLastModified returns true if it has taken care of all
3906 * output to the client that is necessary for this request.
3907 * (that is, it has sent a cached version of the page)
3909 * @return boolean true if cached version send, false otherwise
3911 protected function tryFileCache() {
3912 static $called = false;
3915 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3920 if ( $this->isFileCacheable() ) {
3921 $cache = new HTMLFileCache( $this->mTitle
);
3922 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3923 wfDebug( "Article::tryFileCache(): about to load file\n" );
3924 $cache->loadFromFileCache();
3927 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3928 ob_start( array( &$cache, 'saveToFileCache' ) );
3931 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3938 * Check if the page can be cached
3941 public function isFileCacheable() {
3944 if ( HTMLFileCache
::useFileCache() ) {
3945 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3946 // Extension may have reason to disable file caching on some pages.
3948 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3956 * Loads page_touched and returns a value indicating if it should be used
3957 * @return boolean true if not a redirect
3959 public function checkTouched() {
3960 if ( !$this->mDataLoaded
) {
3961 $this->loadPageData();
3964 return !$this->mIsRedirect
;
3968 * Get the page_touched field
3969 * @return string containing GMT timestamp
3971 public function getTouched() {
3972 if ( !$this->mDataLoaded
) {
3973 $this->loadPageData();
3976 return $this->mTouched
;
3980 * Get the page_latest field
3981 * @return integer rev_id of current revision
3983 public function getLatest() {
3984 if ( !$this->mDataLoaded
) {
3985 $this->loadPageData();
3988 return (int)$this->mLatest
;
3992 * Edit an article without doing all that other stuff
3993 * The article must already exist; link tables etc
3994 * are not updated, caches are not flushed.
3996 * @param $text String: text submitted
3997 * @param $comment String: comment submitted
3998 * @param $minor Boolean: whereas it's a minor modification
4000 public function quickEdit( $text, $comment = '', $minor = 0 ) {
4001 wfProfileIn( __METHOD__
);
4003 $dbw = wfGetDB( DB_MASTER
);
4004 $revision = new Revision( array(
4005 'page' => $this->getId(),
4007 'comment' => $comment,
4008 'minor_edit' => $minor ?
1 : 0,
4010 $revision->insertOn( $dbw );
4011 $this->updateRevisionOn( $dbw, $revision );
4014 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4016 wfProfileOut( __METHOD__
);
4020 * Used to increment the view counter
4022 * @param $id Integer: article id
4024 public static function incViewCount( $id ) {
4025 $id = intval( $id );
4027 global $wgHitcounterUpdateFreq;
4029 $dbw = wfGetDB( DB_MASTER
);
4030 $pageTable = $dbw->tableName( 'page' );
4031 $hitcounterTable = $dbw->tableName( 'hitcounter' );
4032 $acchitsTable = $dbw->tableName( 'acchits' );
4033 $dbType = $dbw->getType();
4035 if ( $wgHitcounterUpdateFreq <= 1 ||
$dbType == 'sqlite' ) {
4036 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
4041 # Not important enough to warrant an error page in case of failure
4042 $oldignore = $dbw->ignoreErrors( true );
4044 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
4046 $checkfreq = intval( $wgHitcounterUpdateFreq / 25 +
1 );
4047 if ( ( rand() %
$checkfreq != 0 ) or ( $dbw->lastErrno() != 0 ) ) {
4048 # Most of the time (or on SQL errors), skip row count check
4049 $dbw->ignoreErrors( $oldignore );
4054 $res = $dbw->query( "SELECT COUNT(*) as n FROM $hitcounterTable" );
4055 $row = $dbw->fetchObject( $res );
4056 $rown = intval( $row->n
);
4058 if ( $rown >= $wgHitcounterUpdateFreq ) {
4059 wfProfileIn( 'Article::incViewCount-collect' );
4060 $old_user_abort = ignore_user_abort( true );
4062 $dbw->lockTables( array(), array( 'hitcounter' ), __METHOD__
, false );
4063 $tabletype = $dbType == 'mysql' ?
"ENGINE=HEAP " : '';
4064 $dbw->query( "CREATE TEMPORARY TABLE $acchitsTable $tabletype AS " .
4065 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable " .
4066 'GROUP BY hc_id', __METHOD__
);
4067 $dbw->delete( 'hitcounter', '*', __METHOD__
);
4068 $dbw->unlockTables( __METHOD__
);
4070 if ( $dbType == 'mysql' ) {
4071 $dbw->query( "UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n " .
4072 'WHERE page_id = hc_id', __METHOD__
);
4074 $dbw->query( "UPDATE $pageTable SET page_counter=page_counter + hc_n " .
4075 "FROM $acchitsTable WHERE page_id = hc_id", __METHOD__
);
4077 $dbw->query( "DROP TABLE $acchitsTable", __METHOD__
);
4079 ignore_user_abort( $old_user_abort );
4080 wfProfileOut( 'Article::incViewCount-collect' );
4083 $dbw->ignoreErrors( $oldignore );
4087 * The onArticle*() functions are supposed to be a kind of hooks
4088 * which should be called whenever any of the specified actions
4091 * This is a good place to put code to clear caches, for instance.
4093 * This is called on page move and undelete, as well as edit
4095 * @param $title a title object
4097 public static function onArticleCreate( $title ) {
4098 # Update existence markers on article/talk tabs...
4099 if ( $title->isTalkPage() ) {
4100 $other = $title->getSubjectPage();
4102 $other = $title->getTalkPage();
4105 $other->invalidateCache();
4106 $other->purgeSquid();
4108 $title->touchLinks();
4109 $title->purgeSquid();
4110 $title->deleteTitleProtection();
4114 * Clears caches when article is deleted
4116 public static function onArticleDelete( $title ) {
4117 global $wgMessageCache;
4119 # Update existence markers on article/talk tabs...
4120 if ( $title->isTalkPage() ) {
4121 $other = $title->getSubjectPage();
4123 $other = $title->getTalkPage();
4126 $other->invalidateCache();
4127 $other->purgeSquid();
4129 $title->touchLinks();
4130 $title->purgeSquid();
4133 HTMLFileCache
::clearFileCache( $title );
4136 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4137 $wgMessageCache->replace( $title->getDBkey(), false );
4141 if ( $title->getNamespace() == NS_FILE
) {
4142 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4143 $update->doUpdate();
4147 if ( $title->getNamespace() == NS_USER_TALK
) {
4148 $user = User
::newFromName( $title->getText(), false );
4149 $user->setNewtalk( false );
4153 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4157 * Purge caches on page update etc
4159 * @param $title Title object
4160 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4162 public static function onArticleEdit( $title ) {
4163 global $wgDeferredUpdateList;
4165 // Invalidate caches of articles which include this page
4166 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4168 // Invalidate the caches of all pages which redirect here
4169 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4171 # Purge squid for this page only
4172 $title->purgeSquid();
4174 # Clear file cache for this page only
4175 HTMLFileCache
::clearFileCache( $title );
4181 * Overriden by ImagePage class, only present here to avoid a fatal error
4182 * Called for ?action=revert
4184 public function revert() {
4186 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4190 * Info about this page
4191 * Called for ?action=info when $wgAllowPageInfo is on.
4193 public function info() {
4194 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4196 if ( !$wgAllowPageInfo ) {
4197 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4201 $page = $this->mTitle
->getSubjectPage();
4203 $wgOut->setPagetitle( $page->getPrefixedText() );
4204 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4205 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4207 if ( !$this->mTitle
->exists() ) {
4208 $wgOut->addHTML( '<div class="noarticletext">' );
4209 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4210 // This doesn't quite make sense; the user is asking for
4211 // information about the _page_, not the message... -- RC
4212 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4214 $msg = $wgUser->isLoggedIn()
4216 : 'noarticletextanon';
4217 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4220 $wgOut->addHTML( '</div>' );
4222 $dbr = wfGetDB( DB_SLAVE
);
4224 'wl_title' => $page->getDBkey(),
4225 'wl_namespace' => $page->getNamespace() );
4226 $numwatchers = $dbr->selectField(
4231 $this->getSelectOptions() );
4233 $pageInfo = $this->pageCountInfo( $page );
4234 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4237 //FIXME: unescaped messages
4238 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4239 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4242 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4245 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4248 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4251 $wgOut->addHTML( '</ul>' );
4256 * Return the total number of edits and number of unique editors
4257 * on a given page. If page does not exist, returns false.
4259 * @param $title Title object
4260 * @return mixed array or boolean false
4262 public function pageCountInfo( $title ) {
4263 $id = $title->getArticleId();
4269 $dbr = wfGetDB( DB_SLAVE
);
4270 $rev_clause = array( 'rev_page' => $id );
4271 $edits = $dbr->selectField(
4276 $this->getSelectOptions()
4278 $authors = $dbr->selectField(
4280 'COUNT(DISTINCT rev_user_text)',
4283 $this->getSelectOptions()
4286 return array( 'edits' => $edits, 'authors' => $authors );
4290 * Return a list of templates used by this article.
4291 * Uses the templatelinks table
4293 * @return Array of Title objects
4295 public function getUsedTemplates() {
4297 $id = $this->mTitle
->getArticleID();
4303 $dbr = wfGetDB( DB_SLAVE
);
4304 $res = $dbr->select( array( 'templatelinks' ),
4305 array( 'tl_namespace', 'tl_title' ),
4306 array( 'tl_from' => $id ),
4309 if ( $res !== false ) {
4310 foreach ( $res as $row ) {
4311 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4315 $dbr->freeResult( $res );
4321 * Returns a list of hidden categories this page is a member of.
4322 * Uses the page_props and categorylinks tables.
4324 * @return Array of Title objects
4326 public function getHiddenCategories() {
4328 $id = $this->mTitle
->getArticleID();
4334 $dbr = wfGetDB( DB_SLAVE
);
4335 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4337 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4338 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4341 if ( $res !== false ) {
4342 foreach ( $res as $row ) {
4343 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4347 $dbr->freeResult( $res );
4353 * Return an applicable autosummary if one exists for the given edit.
4354 * @param $oldtext String: the previous text of the page.
4355 * @param $newtext String: The submitted text of the page.
4356 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
4357 * @return string An appropriate autosummary, or an empty string.
4359 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4362 # Decide what kind of autosummary is needed.
4364 # Redirect autosummaries
4365 $ot = Title
::newFromRedirect( $oldtext );
4366 $rt = Title
::newFromRedirect( $newtext );
4368 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4369 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4372 # New page autosummaries
4373 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4374 # If they're making a new article, give its text, truncated, in the summary.
4376 $truncatedtext = $wgContLang->truncate(
4377 str_replace( "\n", ' ', $newtext ),
4378 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4380 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4383 # Blanking autosummaries
4384 if ( $oldtext != '' && $newtext == '' ) {
4385 return wfMsgForContent( 'autosumm-blank' );
4386 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4387 # Removing more than 90% of the article
4389 $truncatedtext = $wgContLang->truncate(
4391 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4393 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4396 # If we reach this point, there's no applicable autosummary for our case, so our
4397 # autosummary is empty.
4402 * Add the primary page-view wikitext to the output buffer
4403 * Saves the text into the parser cache if possible.
4404 * Updates templatelinks if it is out of date.
4406 * @param $text String
4407 * @param $cache Boolean
4408 * @param $parserOptions mixed ParserOptions object, or boolean false
4410 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4413 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4414 $wgOut->addParserOutput( $this->mParserOutput
);
4418 * This does all the heavy lifting for outputWikitext, except it returns the parser
4419 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4420 * say, embedding thread pages within a discussion system (LiquidThreads)
4422 * @param $text string
4423 * @param $cache boolean
4424 * @param $parserOptions parsing options, defaults to false
4425 * @return string containing parsed output
4427 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4428 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4430 if ( !$parserOptions ) {
4431 $parserOptions = $this->getParserOptions();
4435 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4436 $parserOptions, true, true, $this->getRevIdFetched() );
4441 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4442 $this->mTitle
->getPrefixedDBkey() ) );
4445 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4446 $parserCache = ParserCache
::singleton();
4447 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4450 // Make sure file cache is not used on uncacheable content.
4451 // Output that has magic words in it can still use the parser cache
4452 // (if enabled), though it will generally expire sooner.
4453 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4454 $wgUseFileCache = false;
4457 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4459 return $this->mParserOutput
;
4463 * Get parser options suitable for rendering the primary article wikitext
4464 * @return mixed ParserOptions object or boolean false
4466 public function getParserOptions() {
4469 if ( !$this->mParserOptions
) {
4470 $this->mParserOptions
= new ParserOptions( $wgUser );
4471 $this->mParserOptions
->setTidy( true );
4472 $this->mParserOptions
->enableLimitReport();
4475 return $this->mParserOptions
;
4479 * Updates cascading protections
4481 * @param $parserOutput mixed ParserOptions object, or boolean false
4484 protected function doCascadeProtectionUpdates( $parserOutput ) {
4485 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4489 // templatelinks table may have become out of sync,
4490 // especially if using variable-based transclusions.
4491 // For paranoia, check if things have changed and if
4492 // so apply updates to the database. This will ensure
4493 // that cascaded protections apply as soon as the changes
4496 # Get templates from templatelinks
4497 $id = $this->mTitle
->getArticleID();
4499 $tlTemplates = array();
4501 $dbr = wfGetDB( DB_SLAVE
);
4502 $res = $dbr->select( array( 'templatelinks' ),
4503 array( 'tl_namespace', 'tl_title' ),
4504 array( 'tl_from' => $id ),
4508 foreach ( $res as $row ) {
4509 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4512 # Get templates from parser output.
4513 $poTemplates = array();
4514 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4515 foreach ( $templates as $dbk => $id ) {
4516 $poTemplates["$ns:$dbk"] = true;
4521 # Note that we simulate array_diff_key in PHP <5.0.x
4522 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4524 if ( count( $templates_diff ) > 0 ) {
4525 # Whee, link updates time.
4526 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4532 * Update all the appropriate counts in the category table, given that
4533 * we've added the categories $added and deleted the categories $deleted.
4535 * @param $added array The names of categories that were added
4536 * @param $deleted array The names of categories that were deleted
4538 public function updateCategoryCounts( $added, $deleted ) {
4539 $ns = $this->mTitle
->getNamespace();
4540 $dbw = wfGetDB( DB_MASTER
);
4542 # First make sure the rows exist. If one of the "deleted" ones didn't
4543 # exist, we might legitimately not create it, but it's simpler to just
4544 # create it and then give it a negative value, since the value is bogus
4547 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4548 $insertCats = array_merge( $added, $deleted );
4549 if ( !$insertCats ) {
4550 # Okay, nothing to do
4554 $insertRows = array();
4556 foreach ( $insertCats as $cat ) {
4557 $insertRows[] = array(
4558 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4562 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4564 $addFields = array( 'cat_pages = cat_pages + 1' );
4565 $removeFields = array( 'cat_pages = cat_pages - 1' );
4567 if ( $ns == NS_CATEGORY
) {
4568 $addFields[] = 'cat_subcats = cat_subcats + 1';
4569 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4570 } elseif ( $ns == NS_FILE
) {
4571 $addFields[] = 'cat_files = cat_files + 1';
4572 $removeFields[] = 'cat_files = cat_files - 1';
4579 array( 'cat_title' => $added ),
4588 array( 'cat_title' => $deleted ),
4595 * Lightweight method to get the parser output for a page, checking the parser cache
4596 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4597 * consider, so it's not appropriate to use there.
4599 * @param $oldid mixed integer Revision ID or null
4601 public function getParserOutput( $oldid = null ) {
4602 global $wgEnableParserCache, $wgUser;
4604 // Should the parser cache be used?
4605 $useParserCache = $wgEnableParserCache &&
4606 intval( $wgUser->getOption( 'stubthreshold' ) ) == 0 &&
4610 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4612 if ( $wgUser->getOption( 'stubthreshold' ) ) {
4613 wfIncrStats( 'pcache_miss_stub' );
4616 $parserOutput = false;
4617 if ( $useParserCache ) {
4618 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4621 if ( $parserOutput === false ) {
4622 // Cache miss; parse and output it.
4623 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4625 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4627 return $parserOutput;
4631 // Deprecated methods
4633 * Get the database which should be used for reads
4636 * @deprecated - just call wfGetDB( DB_MASTER ) instead
4639 wfDeprecated( __METHOD__
);
4640 return wfGetDB( DB_MASTER
);