8 * Class for viewing MediaWiki article and history.
10 * This maintains WikiPage functions for backwards compatibility.
12 * @TODO: move and rewrite code to an Action class
14 * See design.txt for an overview.
15 * Note: edit user interface and cache support functions have been
16 * moved to separate EditPage and HTMLFileCache classes.
18 * @internal documentation reviewed 15 Mar 2010
20 class Article
extends Page
{
36 * @var ParserOptions: ParserOptions object for $wgUser articles
38 public $mParserOptions;
41 var $mContentLoaded = false; // !<
47 var $mRedirectedFrom = null;
50 * @var mixed: boolean false or URL string
52 var $mRedirectUrl = false; // !<
53 var $mRevIdFetched = 0; // !<
58 var $mRevision = null;
68 * Constructor and clear the article
69 * @param $title Title Reference to a Title object.
70 * @param $oldId Integer revision ID, null to fetch from request, zero for current
72 public function __construct( Title
$title, $oldId = null ) {
73 $this->mOldId
= $oldId;
74 $this->mPage
= $this->newPage( $title );
81 protected function newPage( Title
$title ) {
82 return new WikiPage( $title );
86 * Constructor from a page id
87 * @param $id Int article ID to load
88 * @return Article|null
90 public static function newFromID( $id ) {
91 $t = Title
::newFromID( $id );
92 # @todo FIXME: Doesn't inherit right
93 return $t == null ?
null : new self( $t );
94 # return $t == null ? null : new static( $t ); // PHP 5.3
98 * Create an Article object of the appropriate class for the given page.
100 * @param $title Title
101 * @param $context IContextSource
102 * @return Article object
104 public static function newFromTitle( $title, IContextSource
$context ) {
105 if ( NS_MEDIA
== $title->getNamespace() ) {
106 // FIXME: where should this go?
107 $title = Title
::makeTitle( NS_FILE
, $title->getDBkey() );
111 wfRunHooks( 'ArticleFromTitle', array( &$title, &$page ) );
113 switch( $title->getNamespace() ) {
115 $page = new ImagePage( $title );
118 $page = new CategoryPage( $title );
121 $page = new Article( $title );
124 $page->setContext( $context );
130 * Tell the page view functions that this view was redirected
131 * from another page on the wiki.
132 * @param $from Title object.
134 public function setRedirectedFrom( Title
$from ) {
135 $this->mRedirectedFrom
= $from;
139 * Get the title object of the article
140 * @return Title object of this page
142 public function getTitle() {
143 return $this->mPage
->getTitle();
149 public function clear() {
150 $this->mContentLoaded
= false;
152 $this->mRedirectedFrom
= null; # Title object if set
153 $this->mRevIdFetched
= 0;
154 $this->mRedirectUrl
= false;
156 $this->mPage
->clear();
160 * Note that getContent/loadContent do not follow redirects anymore.
161 * If you need to fetch redirectable content easily, try
162 * the shortcut in Article::followRedirect()
164 * This function has side effects! Do not use this function if you
165 * only want the real revision text if any.
167 * @return Return the text of this revision
169 public function getContent() {
172 wfProfileIn( __METHOD__
);
174 if ( $this->mPage
->getID() === 0 ) {
175 # If this is a MediaWiki:x message, then load the messages
176 # and return the message value for x.
177 if ( $this->getTitle()->getNamespace() == NS_MEDIAWIKI
) {
178 $text = $this->getTitle()->getDefaultMessageText();
179 if ( $text === false ) {
183 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
185 wfProfileOut( __METHOD__
);
189 $this->fetchContent();
190 wfProfileOut( __METHOD__
);
192 return $this->mContent
;
197 * @return int The oldid of the article that is to be shown, 0 for the
200 public function getOldID() {
201 if ( is_null( $this->mOldId
) ) {
202 $this->mOldId
= $this->getOldIDFromRequest();
205 return $this->mOldId
;
209 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
211 * @return int The old id for the request
213 public function getOldIDFromRequest() {
216 $this->mRedirectUrl
= false;
218 $oldid = $wgRequest->getIntOrNull( 'oldid' );
220 if ( $oldid === null ) {
224 if ( $oldid !== 0 ) {
225 # Load the given revision and check whether the page is another one.
226 # In that case, update this instance to reflect the change.
227 $this->mRevision
= Revision
::newFromId( $oldid );
228 if ( $this->mRevision
!== null ) {
229 // Revision title doesn't match the page title given?
230 if ( $this->mPage
->getID() != $this->mRevision
->getPage() ) {
231 $function = array( get_class( $this->mPage
), 'newFromID' );
232 $this->mPage
= call_user_func( $function, $this->mRevision
->getPage() );
237 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
238 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
242 $this->mRedirectUrl
= $this->getTitle()->getFullURL( 'redirect=no' );
244 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
245 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
255 * Load the revision (including text) into this object
257 * @deprecated in 1.19; use fetchContent()
259 function loadContent() {
260 $this->fetchContent();
264 * Get text of an article from database
265 * Does *NOT* follow redirects.
267 * @return mixed string containing article contents, or false if null
269 function fetchContent() {
270 if ( $this->mContentLoaded
) {
271 return $this->mContent
;
274 wfProfileIn( __METHOD__
);
276 $this->mContentLoaded
= true;
278 $oldid = $this->getOldID();
280 # Pre-fill content with error message so that if something
281 # fails we'll have something telling us what we intended.
282 $t = $this->getTitle()->getPrefixedText();
283 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
284 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
287 # $this->mRevision might already be fetched by getOldIDFromRequest()
288 if ( !$this->mRevision
) {
289 $this->mRevision
= Revision
::newFromId( $oldid );
290 if ( !$this->mRevision
) {
291 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
292 wfProfileOut( __METHOD__
);
297 if ( !$this->mPage
->getLatest() ) {
298 wfDebug( __METHOD__
. " failed to find page data for title " . $this->getTitle()->getPrefixedText() . "\n" );
299 wfProfileOut( __METHOD__
);
303 $this->mRevision
= $this->mPage
->getRevision();
304 if ( !$this->mRevision
) {
305 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id " . $this->mPage
->getLatest() . "\n" );
306 wfProfileOut( __METHOD__
);
311 // @todo FIXME: Horrible, horrible! This content-loading interface just plain sucks.
312 // We should instead work with the Revision object when we need it...
313 $this->mContent
= $this->mRevision
->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
314 $this->mRevIdFetched
= $this->mRevision
->getId();
316 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
318 wfProfileOut( __METHOD__
);
320 return $this->mContent
;
325 * @deprecated since 1.18
327 public function forUpdate() {
328 wfDeprecated( __METHOD__
);
332 * Returns true if the currently-referenced revision is the current edit
333 * to this page (and it exists).
336 public function isCurrent() {
337 # If no oldid, this is the current version.
338 if ( $this->getOldID() == 0 ) {
342 return $this->mPage
->exists() && $this->mRevision
&& $this->mRevision
->isCurrent();
346 * Use this to fetch the rev ID used on page views
348 * @return int revision ID of last article revision
350 public function getRevIdFetched() {
351 if ( $this->mRevIdFetched
) {
352 return $this->mRevIdFetched
;
354 return $this->mPage
->getLatest();
359 * This is the default action of the index.php entry point: just view the
360 * page of the given title.
362 public function view() {
363 global $wgUser, $wgOut, $wgRequest, $wgParser;
364 global $wgUseFileCache, $wgUseETag;
366 wfProfileIn( __METHOD__
);
368 # Get variables from query string
369 # As side effect this will load the revision and update the title
370 # in a revision ID is passed in the request, so this should remain
371 # the first call of this method even if $oldid is used way below.
372 $oldid = $this->getOldID();
374 # Another whitelist check in case getOldID() is altering the title
375 $permErrors = $this->getTitle()->getUserPermissionsErrors( 'read', $wgUser );
376 if ( count( $permErrors ) ) {
377 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
378 wfProfileOut( __METHOD__
);
379 throw new PermissionsError( 'read', $permErrors );
382 # getOldID() may as well want us to redirect somewhere else
383 if ( $this->mRedirectUrl
) {
384 $wgOut->redirect( $this->mRedirectUrl
);
385 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
386 wfProfileOut( __METHOD__
);
391 # If we got diff in the query, we want to see a diff page instead of the article.
392 if ( $wgRequest->getCheck( 'diff' ) ) {
393 wfDebug( __METHOD__
. ": showing diff page\n" );
394 $this->showDiffPage();
395 wfProfileOut( __METHOD__
);
400 # Set page title (may be overridden by DISPLAYTITLE)
401 $wgOut->setPageTitle( $this->getTitle()->getPrefixedText() );
403 $wgOut->setArticleFlag( true );
404 # Allow frames by default
405 $wgOut->allowClickjacking();
407 $parserCache = ParserCache
::singleton();
409 $parserOptions = $this->getParserOptions();
410 # Render printable version, use printable version cache
411 if ( $wgOut->isPrintable() ) {
412 $parserOptions->setIsPrintable( true );
413 $parserOptions->setEditSection( false );
414 } elseif ( !$this->getTitle()->quickUserCan( 'edit' ) ) {
415 $parserOptions->setEditSection( false );
418 # Try client and file cache
419 if ( $oldid === 0 && $this->mPage
->checkTouched() ) {
421 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
424 # Is it client cached?
425 if ( $wgOut->checkLastModified( $this->mPage
->getTouched() ) ) {
426 wfDebug( __METHOD__
. ": done 304\n" );
427 wfProfileOut( __METHOD__
);
431 } elseif ( $wgUseFileCache && $this->tryFileCache() ) {
432 wfDebug( __METHOD__
. ": done file cache\n" );
433 # tell wgOut that output is taken care of
435 $this->mPage
->viewUpdates();
436 wfProfileOut( __METHOD__
);
442 # Should the parser cache be used?
443 $useParserCache = $this->mPage
->isParserCacheUsed( $wgUser, $oldid );
444 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
445 if ( $wgUser->getStubThreshold() ) {
446 wfIncrStats( 'pcache_miss_stub' );
449 $this->showRedirectedFromHeader();
450 $this->showNamespaceHeader();
452 # Iterate through the possible ways of constructing the output text.
453 # Keep going until $outputDone is set, or we run out of things to do.
456 $this->mParserOutput
= false;
458 while ( !$outputDone && ++
$pass ) {
461 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
464 # Early abort if the page doesn't exist
465 if ( !$this->mPage
->exists() ) {
466 wfDebug( __METHOD__
. ": showing missing article\n" );
467 $this->showMissingArticle();
468 wfProfileOut( __METHOD__
);
472 # Try the parser cache
473 if ( $useParserCache ) {
474 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
476 if ( $this->mParserOutput
!== false ) {
478 wfDebug( __METHOD__
. ": showing parser cache contents for current rev permalink\n" );
479 $this->setOldSubtitle( $oldid );
481 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
483 $wgOut->addParserOutput( $this->mParserOutput
);
484 # Ensure that UI elements requiring revision ID have
485 # the correct version information.
486 $wgOut->setRevisionId( $this->mPage
->getLatest() );
488 # Preload timestamp to avoid a DB hit
489 if ( isset( $this->mParserOutput
->mTimestamp
) ) {
490 $this->mPage
->setTimestamp( $this->mParserOutput
->mTimestamp
);
496 # This will set $this->mRevision if needed
497 $this->fetchContent();
499 # Are we looking at an old revision
500 if ( $oldid && $this->mRevision
) {
501 $this->setOldSubtitle( $oldid );
503 if ( !$this->showDeletedRevisionHeader() ) {
504 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
505 wfProfileOut( __METHOD__
);
510 # Ensure that UI elements requiring revision ID have
511 # the correct version information.
512 $wgOut->setRevisionId( $this->getRevIdFetched() );
514 # Pages containing custom CSS or JavaScript get special treatment
515 if ( $this->getTitle()->isCssOrJsPage() ||
$this->getTitle()->isCssJsSubpage() ) {
516 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
517 $this->showCssOrJsPage();
519 } elseif( !wfRunHooks( 'ArticleViewCustom', array( $this->mContent
, $this->getTitle(), $wgOut ) ) ) {
520 # Allow extensions do their own custom view for certain pages
523 $text = $this->getContent();
524 $rt = Title
::newFromRedirectArray( $text );
526 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
527 # Viewing a redirect page (e.g. with parameter redirect=no)
528 $wgOut->addHTML( $this->viewRedirect( $rt ) );
529 # Parse just to get categories, displaytitle, etc.
530 $this->mParserOutput
= $wgParser->parse( $text, $this->getTitle(), $parserOptions );
531 $wgOut->addParserOutputNoText( $this->mParserOutput
);
537 # Run the parse, protected by a pool counter
538 wfDebug( __METHOD__
. ": doing uncached parse\n" );
540 $key = $parserCache->getKey( $this, $parserOptions );
541 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
543 if ( !$poolArticleView->execute() ) {
544 # Connection or timeout error
545 wfProfileOut( __METHOD__
);
551 # Should be unreachable, but just in case...
557 # Get the ParserOutput actually *displayed* here.
558 # Note that $this->mParserOutput is the *current* version output.
559 $pOutput = ( $outputDone instanceof ParserOutput
)
560 ?
$outputDone // object fetched by hook
561 : $this->mParserOutput
;
563 # Adjust title for main page & pages with displaytitle
565 $this->adjustDisplayTitle( $pOutput );
568 # For the main page, overwrite the <title> element with the con-
569 # tents of 'pagetitle-view-mainpage' instead of the default (if
571 # This message always exists because it is in the i18n files
572 if ( $this->getTitle()->isMainPage() ) {
573 $msg = wfMessage( 'pagetitle-view-mainpage' )->inContentLanguage();
574 if ( !$msg->isDisabled() ) {
575 $wgOut->setHTMLTitle( $msg->title( $this->getTitle() )->text() );
579 # Check for any __NOINDEX__ tags on the page using $pOutput
580 $policy = $this->getRobotPolicy( 'view', $pOutput );
581 $wgOut->setIndexPolicy( $policy['index'] );
582 $wgOut->setFollowPolicy( $policy['follow'] );
584 $this->showViewFooter();
585 $this->mPage
->viewUpdates();
587 wfProfileOut( __METHOD__
);
591 * Adjust title for pages with displaytitle, -{T|}- or language conversion
592 * @param $pOutput ParserOutput
594 public function adjustDisplayTitle( ParserOutput
$pOutput ) {
596 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
597 $titleText = $pOutput->getTitleText();
598 if ( strval( $titleText ) !== '' ) {
599 $wgOut->setPageTitle( $titleText );
604 * Show a diff page according to current request variables. For use within
605 * Article::view() only, other callers should use the DifferenceEngine class.
607 public function showDiffPage() {
608 global $wgRequest, $wgUser;
610 $diff = $wgRequest->getVal( 'diff' );
611 $rcid = $wgRequest->getVal( 'rcid' );
612 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
613 $purge = $wgRequest->getVal( 'action' ) == 'purge';
614 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
615 $oldid = $this->getOldID();
617 $de = new DifferenceEngine( $this->getContext(), $oldid, $diff, $rcid, $purge, $unhide );
618 // DifferenceEngine directly fetched the revision:
619 $this->mRevIdFetched
= $de->mNewid
;
620 $de->showDiffPage( $diffOnly );
622 if ( $diff == 0 ||
$diff == $this->mPage
->getLatest() ) {
623 # Run view updates for current revision only
624 $this->mPage
->viewUpdates();
629 * Show a page view for a page formatted as CSS or JavaScript. To be called by
630 * Article::view() only.
632 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
635 protected function showCssOrJsPage() {
638 $dir = $this->getContext()->getLang()->getDir();
639 $lang = $this->getContext()->getLang()->getCode();
641 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache' lang='$lang' dir='$dir' class='mw-content-$dir'>\n$1\n</div>",
644 // Give hooks a chance to customise the output
645 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->getTitle(), $wgOut ) ) ) {
646 // Wrap the whole lot in a <pre> and don't parse
648 preg_match( '!\.(css|js)$!u', $this->getTitle()->getText(), $m );
649 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
650 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
651 $wgOut->addHTML( "\n</pre>\n" );
656 * Get the robot policy to be used for the current view
657 * @param $action String the action= GET parameter
658 * @param $pOutput ParserOutput
659 * @return Array the policy that should be set
660 * TODO: actions other than 'view'
662 public function getRobotPolicy( $action, $pOutput ) {
663 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
664 global $wgDefaultRobotPolicy, $wgRequest;
666 $ns = $this->getTitle()->getNamespace();
668 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
669 # Don't index user and user talk pages for blocked users (bug 11443)
670 if ( !$this->getTitle()->isSubpage() ) {
671 if ( Block
::newFromTarget( null, $this->getTitle()->getText() ) instanceof Block
) {
673 'index' => 'noindex',
674 'follow' => 'nofollow'
680 if ( $this->mPage
->getID() === 0 ||
$this->getOldID() ) {
681 # Non-articles (special pages etc), and old revisions
683 'index' => 'noindex',
684 'follow' => 'nofollow'
686 } elseif ( $wgOut->isPrintable() ) {
687 # Discourage indexing of printable versions, but encourage following
689 'index' => 'noindex',
692 } elseif ( $wgRequest->getInt( 'curid' ) ) {
693 # For ?curid=x urls, disallow indexing
695 'index' => 'noindex',
700 # Otherwise, construct the policy based on the various config variables.
701 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
703 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
704 # Honour customised robot policies for this namespace
705 $policy = array_merge(
707 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
710 if ( $this->getTitle()->canUseNoindex() && is_object( $pOutput ) && $pOutput->getIndexPolicy() ) {
711 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
712 # a final sanity check that we have really got the parser output.
713 $policy = array_merge(
715 array( 'index' => $pOutput->getIndexPolicy() )
719 if ( isset( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] ) ) {
720 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
721 $policy = array_merge(
723 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] )
731 * Converts a String robot policy into an associative array, to allow
732 * merging of several policies using array_merge().
733 * @param $policy Mixed, returns empty array on null/false/'', transparent
734 * to already-converted arrays, converts String.
735 * @return Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
737 public static function formatRobotPolicy( $policy ) {
738 if ( is_array( $policy ) ) {
740 } elseif ( !$policy ) {
744 $policy = explode( ',', $policy );
745 $policy = array_map( 'trim', $policy );
748 foreach ( $policy as $var ) {
749 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
750 $arr['index'] = $var;
751 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
752 $arr['follow'] = $var;
760 * If this request is a redirect view, send "redirected from" subtitle to
761 * $wgOut. Returns true if the header was needed, false if this is not a
762 * redirect view. Handles both local and remote redirects.
766 public function showRedirectedFromHeader() {
767 global $wgOut, $wgRequest, $wgRedirectSources;
769 $rdfrom = $wgRequest->getVal( 'rdfrom' );
771 if ( isset( $this->mRedirectedFrom
) ) {
772 // This is an internally redirected page view.
773 // We'll need a backlink to the source page for navigation.
774 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
775 $redir = Linker
::linkKnown(
776 $this->mRedirectedFrom
,
779 array( 'redirect' => 'no' )
782 $wgOut->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
784 // Set the fragment if one was specified in the redirect
785 if ( strval( $this->getTitle()->getFragment() ) != '' ) {
786 $fragment = Xml
::escapeJsString( $this->getTitle()->getFragmentForURL() );
787 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
790 // Add a <link rel="canonical"> tag
791 $wgOut->addLink( array( 'rel' => 'canonical',
792 'href' => $this->getTitle()->getLocalURL() )
797 } elseif ( $rdfrom ) {
798 // This is an externally redirected view, from some other wiki.
799 // If it was reported from a trusted site, supply a backlink.
800 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
801 $redir = Linker
::makeExternalLink( $rdfrom, $rdfrom );
802 $wgOut->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
812 * Show a header specific to the namespace currently being viewed, like
813 * [[MediaWiki:Talkpagetext]]. For Article::view().
815 public function showNamespaceHeader() {
818 if ( $this->getTitle()->isTalkPage() ) {
819 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
820 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
826 * Show the footer section of an ordinary page view
828 public function showViewFooter() {
829 global $wgOut, $wgUseTrackbacks;
831 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
832 if ( $this->getTitle()->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->getTitle()->getText() ) ) {
833 $wgOut->addWikiMsg( 'anontalkpagetext' );
836 # If we have been passed an &rcid= parameter, we want to give the user a
837 # chance to mark this new article as patrolled.
838 $this->showPatrolFooter();
841 if ( $wgUseTrackbacks ) {
842 $this->addTrackbacks();
845 wfRunHooks( 'ArticleViewFooter', array( $this ) );
850 * If patrol is possible, output a patrol UI box. This is called from the
851 * footer section of ordinary page views. If patrol is not possible or not
852 * desired, does nothing.
854 public function showPatrolFooter() {
855 global $wgOut, $wgRequest, $wgUser;
857 $rcid = $wgRequest->getVal( 'rcid' );
859 if ( !$rcid ||
!$this->getTitle()->quickUserCan( 'patrol' ) ) {
863 $token = $wgUser->editToken( $rcid );
864 $wgOut->preventClickjacking();
867 "<div class='patrollink'>" .
869 'markaspatrolledlink',
872 wfMsgHtml( 'markaspatrolledtext' ),
875 'action' => 'markpatrolled',
879 array( 'known', 'noclasses' )
887 * Show the error text for a missing article. For articles in the MediaWiki
888 * namespace, show the default message text. To be called from Article::view().
890 public function showMissingArticle() {
891 global $wgOut, $wgRequest, $wgUser;
893 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
894 if ( $this->getTitle()->getNamespace() == NS_USER ||
$this->getTitle()->getNamespace() == NS_USER_TALK
) {
895 $parts = explode( '/', $this->getTitle()->getText() );
896 $rootPart = $parts[0];
897 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
898 $ip = User
::isIP( $rootPart );
900 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
901 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
902 array( 'userpage-userdoesnotexist-view', wfEscapeWikiText( $rootPart ) ) );
903 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
904 LogEventsList
::showLogExtract(
907 $user->getUserPage()->getPrefixedText(),
911 'showIfEmpty' => false,
913 'blocked-notice-logextract',
914 $user->getName() # Support GENDER in notice
921 wfRunHooks( 'ShowMissingArticle', array( $this ) );
923 # Show delete and move logs
924 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->getTitle()->getPrefixedText(), '',
926 'conds' => array( "log_action != 'revision'" ),
927 'showIfEmpty' => false,
928 'msgKey' => array( 'moveddeleted-notice' ) )
932 $oldid = $this->getOldID();
934 $text = wfMsgNoTrans( 'missing-article',
935 $this->getTitle()->getPrefixedText(),
936 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
937 } elseif ( $this->getTitle()->getNamespace() === NS_MEDIAWIKI
) {
938 // Use the default message text
939 $text = $this->getTitle()->getDefaultMessageText();
941 $createErrors = $this->getTitle()->getUserPermissionsErrors( 'create', $wgUser );
942 $editErrors = $this->getTitle()->getUserPermissionsErrors( 'edit', $wgUser );
943 $errors = array_merge( $createErrors, $editErrors );
945 if ( !count( $errors ) ) {
946 $text = wfMsgNoTrans( 'noarticletext' );
948 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
951 $text = "<div class='noarticletext'>\n$text\n</div>";
953 if ( !$this->mPage
->hasViewableContent() ) {
954 // If there's no backing content, send a 404 Not Found
955 // for better machine handling of broken links.
956 $wgRequest->response()->header( "HTTP/1.1 404 Not Found" );
959 $wgOut->addWikiText( $text );
963 * If the revision requested for view is deleted, check permissions.
964 * Send either an error message or a warning header to $wgOut.
966 * @return boolean true if the view is allowed, false if not.
968 public function showDeletedRevisionHeader() {
969 global $wgOut, $wgRequest;
971 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
976 // If the user is not allowed to see it...
977 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
978 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
979 'rev-deleted-text-permission' );
982 // If the user needs to confirm that they want to see it...
983 } elseif ( $wgRequest->getInt( 'unhide' ) != 1 ) {
984 # Give explanation and add a link to view the revision...
985 $oldid = intval( $this->getOldID() );
986 $link = $this->getTitle()->getFullUrl( "oldid={$oldid}&unhide=1" );
987 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
988 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
989 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
990 array( $msg, $link ) );
993 // We are allowed to see...
995 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
996 'rev-suppressed-text-view' : 'rev-deleted-text-view';
997 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1004 * Generate the navigation links when browsing through an article revisions
1005 * It shows the information as:
1006 * Revision as of \<date\>; view current revision
1007 * \<- Previous version | Next Version -\>
1009 * @param $oldid String: revision ID of this article revision
1011 public function setOldSubtitle( $oldid = 0 ) {
1012 global $wgLang, $wgOut, $wgUser, $wgRequest;
1014 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
1018 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1020 # Cascade unhide param in links for easy deletion browsing
1021 $extraParams = array();
1022 if ( $wgRequest->getVal( 'unhide' ) ) {
1023 $extraParams['unhide'] = 1;
1026 $revision = Revision
::newFromId( $oldid );
1027 $timestamp = $revision->getTimestamp();
1029 $current = ( $oldid == $this->mPage
->getLatest() );
1030 $td = $wgLang->timeanddate( $timestamp, true );
1031 $tddate = $wgLang->date( $timestamp, true );
1032 $tdtime = $wgLang->time( $timestamp, true );
1034 # Show user links if allowed to see them. If hidden, then show them only if requested...
1035 $userlinks = Linker
::revUserTools( $revision, !$unhide );
1037 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
1038 ?
'revision-info-current'
1041 $wgOut->addSubtitle( "<div id=\"mw-{$infomsg}\">" . wfMessage( $infomsg,
1042 $td )->rawParams( $userlinks )->params( $revision->getID(), $tddate,
1043 $tdtime, $revision->getUser() )->parse() . "</div>" );
1046 ?
wfMsgHtml( 'currentrevisionlink' )
1049 wfMsgHtml( 'currentrevisionlink' ),
1052 array( 'known', 'noclasses' )
1055 ?
wfMsgHtml( 'diff' )
1058 wfMsgHtml( 'diff' ),
1064 array( 'known', 'noclasses' )
1066 $prev = $this->getTitle()->getPreviousRevisionID( $oldid ) ;
1070 wfMsgHtml( 'previousrevision' ),
1073 'direction' => 'prev',
1076 array( 'known', 'noclasses' )
1078 : wfMsgHtml( 'previousrevision' );
1082 wfMsgHtml( 'diff' ),
1088 array( 'known', 'noclasses' )
1090 : wfMsgHtml( 'diff' );
1091 $nextlink = $current
1092 ?
wfMsgHtml( 'nextrevision' )
1095 wfMsgHtml( 'nextrevision' ),
1098 'direction' => 'next',
1101 array( 'known', 'noclasses' )
1103 $nextdiff = $current
1104 ?
wfMsgHtml( 'diff' )
1107 wfMsgHtml( 'diff' ),
1113 array( 'known', 'noclasses' )
1118 // User can delete revisions or view deleted revisions...
1119 $canHide = $wgUser->isAllowed( 'deleterevision' );
1120 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
1121 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
1122 $cdel = Linker
::revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
1125 'type' => 'revision',
1126 'target' => $this->getTitle()->getPrefixedDbkey(),
1129 $cdel = Linker
::revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1134 $wgOut->addSubtitle( "<div id=\"mw-revision-nav\">" . $cdel .
1135 wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
1136 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>" );
1140 * Execute the uncached parse for action=view
1143 public function doViewParse() {
1146 $oldid = $this->getOldID();
1147 $parserOptions = $this->getParserOptions();
1149 # Render printable version, use printable version cache
1150 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1152 # Don't show section-edit links on old revisions... this way lies madness.
1153 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ||
!$this->getTitle()->quickUserCan( 'edit' ) ) {
1154 $parserOptions->setEditSection( false );
1157 $useParserCache = $this->useParserCache( $oldid );
1158 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1164 * Try to fetch an expired entry from the parser cache. If it is present,
1165 * output it and return true. If it is not present, output nothing and
1166 * return false. This is used as a callback function for
1167 * PoolCounter::executeProtected().
1171 public function tryDirtyCache() {
1173 $parserCache = ParserCache
::singleton();
1174 $options = $this->getParserOptions();
1176 if ( $wgOut->isPrintable() ) {
1177 $options->setIsPrintable( true );
1178 $options->setEditSection( false );
1181 $output = $parserCache->getDirty( $this, $options );
1184 wfDebug( __METHOD__
. ": sending dirty output\n" );
1185 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1186 $wgOut->setSquidMaxage( 0 );
1187 $this->mParserOutput
= $output;
1188 $wgOut->addParserOutput( $output );
1189 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1193 wfDebugLog( 'dirty', "dirty missing\n" );
1194 wfDebug( __METHOD__
. ": no dirty cache\n" );
1203 * @param $target Title|Array of destination(s) to redirect
1204 * @param $appendSubtitle Boolean [optional]
1205 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1206 * @return string containing HMTL with redirect link
1208 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1209 global $wgOut, $wgStylePath;
1211 if ( !is_array( $target ) ) {
1212 $target = array( $target );
1215 $lang = $this->getTitle()->getPageLanguage();
1216 $imageDir = $lang->getDir();
1218 if ( $appendSubtitle ) {
1219 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1222 // the loop prepends the arrow image before the link, so the first case needs to be outside
1227 $title = array_shift( $target );
1229 if ( $forceKnown ) {
1230 $link = Linker
::linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1232 $link = Linker
::link( $title, htmlspecialchars( $title->getFullText() ) );
1235 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1236 $alt = $lang->isRTL() ?
'←' : '→';
1237 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1238 foreach ( $target as $rt ) {
1239 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1240 if ( $forceKnown ) {
1241 $link .= Linker
::linkKnown( $rt, htmlspecialchars( $rt->getFullText(), array(), array( 'redirect' => 'no' ) ) );
1243 $link .= Linker
::link( $rt, htmlspecialchars( $rt->getFullText() ), array(), array( 'redirect' => 'no' ) );
1247 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1248 return '<div class="redirectMsg">' .
1249 Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1250 '<span class="redirectText">' . $link . '</span></div>';
1254 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1256 public function addTrackbacks() {
1259 $dbr = wfGetDB( DB_SLAVE
);
1260 $tbs = $dbr->select( 'trackbacks',
1261 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1262 array( 'tb_page' => $this->mPage
->getID() )
1265 if ( !$dbr->numRows( $tbs ) ) {
1269 $wgOut->preventClickjacking();
1272 foreach ( $tbs as $o ) {
1275 if ( $this->getContext()->getUser()->isAllowed( 'trackback' ) ) {
1276 $delurl = $this->getTitle()->getFullURL( "action=deletetrackback&tbid=" .
1277 $o->tb_id
. "&token=" . urlencode( $this->getContext()->getUser()->editToken() ) );
1278 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1282 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1290 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1294 * Handle action=render
1296 public function render() {
1299 $wgOut->setArticleBodyOnly( true );
1304 * action=protect handler
1306 public function protect() {
1307 $form = new ProtectionForm( $this );
1312 * action=unprotect handler (alias)
1314 public function unprotect() {
1319 * UI entry point for page deletion
1321 public function delete() {
1322 global $wgOut, $wgRequest, $wgLang;
1324 # This code desperately needs to be totally rewritten
1326 $title = $this->getTitle();
1327 $user = $this->getContext()->getUser();
1330 $permission_errors = $title->getUserPermissionsErrors( 'delete', $user );
1331 if ( count( $permission_errors ) ) {
1332 throw new PermissionsError( 'delete', $permission_errors );
1335 # Read-only check...
1336 if ( wfReadOnly() ) {
1337 throw new ReadOnlyError
;
1340 # Better double-check that it hasn't been deleted yet!
1341 $dbw = wfGetDB( DB_MASTER
);
1342 $conds = $title->pageCond();
1343 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
1344 if ( $latest === false ) {
1345 $wgOut->setPageTitle( wfMessage( 'cannotdelete-title', $title->getPrefixedText() ) );
1346 $wgOut->wrapWikiMsg( "<div class=\"error mw-error-cannotdelete\">\n$1\n</div>",
1347 array( 'cannotdelete', wfEscapeWikiText( $title->getPrefixedText() ) )
1349 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
1350 LogEventsList
::showLogExtract(
1353 $title->getPrefixedText()
1359 # Hack for big sites
1360 $bigHistory = $this->mPage
->isBigDeletion();
1361 if ( $bigHistory && !$title->userCan( 'bigdelete' ) ) {
1362 global $wgDeleteRevisionsLimit;
1364 $wgOut->setPageTitle( wfMessage( 'cannotdelete-title', $title->getPrefixedText() ) );
1365 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1366 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
1371 $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList', 'other' );
1372 $deleteReason = $wgRequest->getText( 'wpReason' );
1374 if ( $deleteReasonList == 'other' ) {
1375 $reason = $deleteReason;
1376 } elseif ( $deleteReason != '' ) {
1377 // Entry from drop down menu + additional comment
1378 $reason = $deleteReasonList . wfMsgForContent( 'colon-separator' ) . $deleteReason;
1380 $reason = $deleteReasonList;
1383 if ( $wgRequest->wasPosted() && $user->matchEditToken( $wgRequest->getVal( 'wpEditToken' ),
1384 array( 'delete', $this->getTitle()->getPrefixedText() ) ) )
1386 # Flag to hide all contents of the archived revisions
1387 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $user->isAllowed( 'suppressrevision' );
1389 $this->doDelete( $reason, $suppress );
1391 if ( $wgRequest->getCheck( 'wpWatch' ) && $user->isLoggedIn() ) {
1393 } elseif ( $title->userIsWatching() ) {
1400 // Generate deletion reason
1401 $hasHistory = false;
1403 $reason = $this->generateReason( $hasHistory );
1406 // If the page has a history, insert a warning
1407 if ( $hasHistory ) {
1408 $revisions = $this->mPage
->estimateRevisionCount();
1409 // @todo FIXME: i18n issue/patchwork message
1410 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
1411 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
1412 wfMsgHtml( 'word-separator' ) . Linker
::link( $title,
1413 wfMsgHtml( 'history' ),
1414 array( 'rel' => 'archives' ),
1415 array( 'action' => 'history' ) ) .
1419 if ( $bigHistory ) {
1420 global $wgDeleteRevisionsLimit;
1421 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1422 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
1426 return $this->confirmDelete( $reason );
1430 * Output deletion confirmation dialog
1431 * @todo FIXME: Move to another file?
1432 * @param $reason String: prefilled reason
1434 public function confirmDelete( $reason ) {
1437 wfDebug( "Article::confirmDelete\n" );
1439 $wgOut->setPageTitle( wfMessage( 'delete-confirm', $this->getTitle()->getPrefixedText() ) );
1440 $wgOut->addBacklinkSubtitle( $this->getTitle() );
1441 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1442 $wgOut->addWikiMsg( 'confirmdeletetext' );
1444 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
1446 $user = $this->getContext()->getUser();
1448 if ( $user->isAllowed( 'suppressrevision' ) ) {
1449 $suppress = "<tr id=\"wpDeleteSuppressRow\">
1451 <td class='mw-input'><strong>" .
1452 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
1453 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
1459 $checkWatch = $user->getBoolOption( 'watchdeletion' ) ||
$this->getTitle()->userIsWatching();
1461 $form = Xml
::openElement( 'form', array( 'method' => 'post',
1462 'action' => $this->getTitle()->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
1463 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
1464 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
1465 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
1466 "<tr id=\"wpDeleteReasonListRow\">
1467 <td class='mw-label'>" .
1468 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
1470 <td class='mw-input'>" .
1471 Xml
::listDropDown( 'wpDeleteReasonList',
1472 wfMsgForContent( 'deletereason-dropdown' ),
1473 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
1476 <tr id=\"wpDeleteReasonRow\">
1477 <td class='mw-label'>" .
1478 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
1480 <td class='mw-input'>" .
1481 Html
::input( 'wpReason', $reason, 'text', array(
1483 'maxlength' => '255',
1491 # Disallow watching if user is not logged in
1492 if ( $user->isLoggedIn() ) {
1496 <td class='mw-input'>" .
1497 Xml
::checkLabel( wfMsg( 'watchthis' ),
1498 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
1507 <td class='mw-submit'>" .
1508 Xml
::submitButton( wfMsg( 'deletepage' ),
1509 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
1512 Xml
::closeElement( 'table' ) .
1513 Xml
::closeElement( 'fieldset' ) .
1514 Html
::hidden( 'wpEditToken', $user->editToken( array( 'delete', $this->getTitle()->getPrefixedText() ) ) ) .
1515 Xml
::closeElement( 'form' );
1517 if ( $user->isAllowed( 'editinterface' ) ) {
1518 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
1519 $link = Linker
::link(
1521 wfMsgHtml( 'delete-edit-reasonlist' ),
1523 array( 'action' => 'edit' )
1525 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
1528 $wgOut->addHTML( $form );
1529 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
1530 LogEventsList
::showLogExtract( $wgOut, 'delete',
1531 $this->getTitle()->getPrefixedText()
1536 * Perform a deletion and output success or failure messages
1538 * @param $suppress bool
1540 public function doDelete( $reason, $suppress = false ) {
1543 $id = $this->getTitle()->getArticleID( Title
::GAID_FOR_UPDATE
);
1546 if ( $this->mPage
->doDeleteArticle( $reason, $suppress, $id, true, $error ) ) {
1547 $deleted = $this->getTitle()->getPrefixedText();
1549 $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
1550 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1552 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
1554 $wgOut->addWikiMsg( 'deletedtext', wfEscapeWikiText( $deleted ), $loglink );
1555 $wgOut->returnToMain( false );
1557 $wgOut->setPageTitle( wfMessage( 'cannotdelete-title', $this->getTitle()->getPrefixedText() ) );
1558 if ( $error == '' ) {
1559 $wgOut->wrapWikiMsg( "<div class=\"error mw-error-cannotdelete\">\n$1\n</div>",
1560 array( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) )
1562 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
1564 LogEventsList
::showLogExtract(
1567 $this->getTitle()->getPrefixedText()
1570 $wgOut->addHTML( $error );
1575 /* Caching functions */
1578 * checkLastModified returns true if it has taken care of all
1579 * output to the client that is necessary for this request.
1580 * (that is, it has sent a cached version of the page)
1582 * @return boolean true if cached version send, false otherwise
1584 protected function tryFileCache() {
1585 static $called = false;
1588 wfDebug( "Article::tryFileCache(): called twice!?\n" );
1593 if ( $this->isFileCacheable() ) {
1594 $cache = HTMLFileCache
::newFromTitle( $this->getTitle(), 'view' );
1595 if ( $cache->isCacheGood( $this->mPage
->getTouched() ) ) {
1596 wfDebug( "Article::tryFileCache(): about to load file\n" );
1597 $cache->loadFromFileCache( $this->getContext() );
1600 wfDebug( "Article::tryFileCache(): starting buffer\n" );
1601 ob_start( array( &$cache, 'saveToFileCache' ) );
1604 wfDebug( "Article::tryFileCache(): not cacheable\n" );
1611 * Check if the page can be cached
1614 public function isFileCacheable() {
1617 if ( HTMLFileCache
::useFileCache( $this->getContext() ) ) {
1618 $cacheable = $this->mPage
->getID()
1619 && !$this->mRedirectedFrom
&& !$this->getTitle()->isRedirect();
1620 // Extension may have reason to disable file caching on some pages.
1622 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
1632 * Add the primary page-view wikitext to the output buffer
1633 * Saves the text into the parser cache if possible.
1634 * Updates templatelinks if it is out of date.
1636 * @param $text String
1637 * @param $cache Boolean
1638 * @param $parserOptions mixed ParserOptions object, or boolean false
1640 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
1643 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
1645 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
1647 $wgOut->addParserOutput( $this->mParserOutput
);
1651 * Lightweight method to get the parser output for a page, checking the parser cache
1652 * and so on. Doesn't consider most of the stuff that WikiPage::view is forced to
1653 * consider, so it's not appropriate to use there.
1655 * @since 1.16 (r52326) for LiquidThreads
1657 * @param $oldid mixed integer Revision ID or null
1658 * @param $user User The relevant user
1659 * @return ParserOutput or false if the given revsion ID is not found
1661 public function getParserOutput( $oldid = null, User
$user = null ) {
1662 global $wgEnableParserCache, $wgUser;
1663 $user = is_null( $user ) ?
$wgUser : $user;
1665 wfProfileIn( __METHOD__
);
1666 // Should the parser cache be used?
1667 $useParserCache = $wgEnableParserCache &&
1668 $user->getStubThreshold() == 0 &&
1669 $this->mPage
->exists() &&
1672 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1674 if ( $user->getStubThreshold() ) {
1675 wfIncrStats( 'pcache_miss_stub' );
1678 if ( $useParserCache ) {
1679 $options = $this->mPage
->makeParserOptions( $user );
1680 $parserOutput = ParserCache
::singleton()->get( $this, $options );
1681 if ( $parserOutput !== false ) {
1682 wfProfileOut( __METHOD__
);
1683 return $parserOutput;
1687 // Cache miss; parse and output it.
1688 if ( $oldid === null ) {
1689 $text = $this->mPage
->getRawText();
1691 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
1692 if ( $rev === null ) {
1693 wfProfileOut( __METHOD__
);
1696 $text = $rev->getText();
1699 $output = $this->getOutputFromWikitext( $text, $useParserCache );
1700 wfProfileOut( __METHOD__
);
1705 * This does all the heavy lifting for outputWikitext, except it returns the parser
1706 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
1707 * say, embedding thread pages within a discussion system (LiquidThreads)
1709 * @param $text string
1710 * @param $cache boolean
1711 * @param $parserOptions parsing options, defaults to false
1712 * @return ParserOutput
1714 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
1715 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
1717 if ( !$parserOptions ) {
1718 $parserOptions = $this->getParserOptions();
1722 $this->mParserOutput
= $wgParser->parse( $text, $this->getTitle(),
1723 $parserOptions, true, true, $this->getRevIdFetched() );
1728 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
1729 $this->getTitle()->getPrefixedDBkey() ) );
1732 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
1733 $parserCache = ParserCache
::singleton();
1734 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
1737 // Make sure file cache is not used on uncacheable content.
1738 // Output that has magic words in it can still use the parser cache
1739 // (if enabled), though it will generally expire sooner.
1740 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
1741 $wgUseFileCache = false;
1744 if ( $this->isCurrent() ) {
1745 $this->mPage
->doCascadeProtectionUpdates( $this->mParserOutput
);
1748 return $this->mParserOutput
;
1752 * Get parser options suitable for rendering the primary article wikitext
1753 * @return ParserOptions|false
1755 public function getParserOptions() {
1757 if ( !$this->mParserOptions
) {
1758 $this->mParserOptions
= $this->mPage
->makeParserOptions( $wgUser );
1760 // Clone to allow modifications of the return value without affecting cache
1761 return clone $this->mParserOptions
;
1765 * Sets the context this Article is executed in
1767 * @param $context IContextSource
1770 public function setContext( $context ) {
1771 $this->mContext
= $context;
1775 * Gets the context this Article is executed in
1777 * @return IContextSource
1780 public function getContext() {
1781 if ( $this->mContext
instanceof IContextSource
) {
1782 return $this->mContext
;
1784 wfDebug( __METHOD__
. " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
1785 return RequestContext
::getMain();
1790 * Removes trackback record for current article from trackbacks table
1791 * @deprecated since 1.18
1793 public function deletetrackback() {
1794 return Action
::factory( 'deletetrackback', $this )->show();
1798 * Info about this page
1799 * @deprecated since 1.19
1801 public function info() {
1802 Action
::factory( 'info', $this )->show();
1806 * Mark this particular edit/page as patrolled
1807 * @deprecated since 1.18
1809 public function markpatrolled() {
1810 Action
::factory( 'markpatrolled', $this )->show();
1814 * Handle action=purge
1815 * @deprecated since 1.19
1817 public function purge() {
1818 return Action
::factory( 'purge', $this )->show();
1822 * Handle action=revert
1823 * @deprecated since 1.19
1825 public function revert() {
1826 Action
::factory( 'revert', $this )->show();
1830 * Handle action=rollback
1831 * @deprecated since 1.19
1833 public function rollback() {
1834 Action
::factory( 'rollback', $this )->show();
1838 * User-interface handler for the "watch" action.
1839 * Requires Request to pass a token as of 1.18.
1840 * @deprecated since 1.18
1842 public function watch() {
1843 Action
::factory( 'watch', $this )->show();
1847 * Add this page to $wgUser's watchlist
1849 * This is safe to be called multiple times
1851 * @return bool true on successful watch operation
1852 * @deprecated since 1.18
1854 public function doWatch() {
1856 return WatchAction
::doWatch( $this->getTitle(), $wgUser );
1860 * User interface handler for the "unwatch" action.
1861 * Requires Request to pass a token as of 1.18.
1862 * @deprecated since 1.18
1864 public function unwatch() {
1865 Action
::factory( 'unwatch', $this )->show();
1869 * Stop watching a page
1870 * @return bool true on successful unwatch
1871 * @deprecated since 1.18
1873 public function doUnwatch() {
1875 return WatchAction
::doUnwatch( $this->getTitle(), $wgUser );
1879 * Output a redirect back to the article.
1880 * This is typically used after an edit.
1882 * @deprecated in 1.18; call $wgOut->redirect() directly
1883 * @param $noRedir Boolean: add redirect=no
1884 * @param $sectionAnchor String: section to redirect to, including "#"
1885 * @param $extraQuery String: extra query params
1887 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
1888 wfDeprecated( __METHOD__
);
1892 $query = 'redirect=no';
1894 $query .= "&$extraQuery";
1896 $query = $extraQuery;
1899 $wgOut->redirect( $this->getTitle()->getFullURL( $query ) . $sectionAnchor );
1903 * Use PHP's magic __get handler to handle accessing of
1904 * raw WikiPage fields for backwards compatibility.
1906 * @param $fname String Field name
1908 public function __get( $fname ) {
1909 if ( property_exists( $this->mPage
, $fname ) ) {
1910 #wfWarn( "Access to raw $fname field " . __CLASS__ );
1911 return $this->mPage
->$fname;
1913 trigger_error( 'Inaccessible property via __get(): ' . $fname, E_USER_NOTICE
);
1917 * Use PHP's magic __set handler to handle setting of
1918 * raw WikiPage fields for backwards compatibility.
1920 * @param $fname String Field name
1921 * @param $fvalue mixed New value
1923 public function __set( $fname, $fvalue ) {
1924 if ( property_exists( $this->mPage
, $fname ) ) {
1925 #wfWarn( "Access to raw $fname field of " . __CLASS__ );
1926 $this->mPage
->$fname = $fvalue;
1927 // Note: extensions may want to toss on new fields
1928 } elseif ( !in_array( $fname, array( 'mContext', 'mPage' ) ) ) {
1929 $this->mPage
->$fname = $fvalue;
1931 trigger_error( 'Inaccessible property via __set(): ' . $fname, E_USER_NOTICE
);
1936 * Use PHP's magic __call handler to transform instance calls to
1937 * WikiPage functions for backwards compatibility.
1939 * @param $fname String Name of called method
1940 * @param $args Array Arguments to the method
1942 public function __call( $fname, $args ) {
1943 if ( is_callable( array( $this->mPage
, $fname ) ) ) {
1944 #wfWarn( "Call to " . __CLASS__ . "::$fname; please use WikiPage instead" );
1945 return call_user_func_array( array( $this->mPage
, $fname ), $args );
1947 trigger_error( 'Inaccessible function via __call(): ' . $fname, E_USER_ERROR
);
1950 // ****** B/C functions to work-around PHP silliness with __call and references ****** //
1953 * @param $limit array
1954 * @param $reason string
1955 * @param $cascade int
1956 * @param $expiry array
1959 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
1960 return $this->mPage
->updateRestrictions( $limit, $reason, $cascade, $expiry );
1964 * @param $reason string
1965 * @param $suppress bool
1967 * @param $commit bool
1968 * @param $error string
1971 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true, &$error = '' ) {
1972 return $this->mPage
->doDeleteArticle( $reason, $suppress, $id, $commit, $error );
1980 * @param $resultDetails
1984 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails, User
$user = null ) {
1986 $user = is_null( $user ) ?
$wgUser : $user;
1987 return $this->mPage
->doRollback( $fromP, $summary, $token, $bot, $resultDetails, $user );
1994 * @param $resultDetails
1995 * @param $guser User
1998 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser = null ) {
2000 $guser = is_null( $guser ) ?
$wgUser : $guser;
2001 return $this->mPage
->commitRollback( $fromP, $summary, $bot, $resultDetails, $guser );
2005 * @param $hasHistory bool
2008 public function generateReason( &$hasHistory ) {
2009 return $this->mPage
->getAutoDeleteReason( $hasHistory );
2012 // ****** B/C functions for static methods ( __callStatic is PHP>=5.3 ) ****** //
2017 public static function selectFields() {
2018 return WikiPage
::selectFields();
2022 * @param $title Title
2024 public static function onArticleCreate( $title ) {
2025 WikiPage
::onArticleCreate( $title );
2029 * @param $title Title
2031 public static function onArticleDelete( $title ) {
2032 WikiPage
::onArticleDelete( $title );
2036 * @param $title Title
2038 public static function onArticleEdit( $title ) {
2039 WikiPage
::onArticleEdit( $title );
2048 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2049 return WikiPage
::getAutosummary( $oldtext, $newtext, $flags );
2054 class PoolWorkArticleView
extends PoolCounterWork
{
2061 function __construct( $article, $key, $useParserCache, $parserOptions ) {
2062 parent
::__construct( 'ArticleView', $key );
2063 $this->mArticle
= $article;
2064 $this->cacheable
= $useParserCache;
2065 $this->parserOptions
= $parserOptions;
2072 return $this->mArticle
->doViewParse();
2078 function getCachedWork() {
2081 $parserCache = ParserCache
::singleton();
2082 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
2084 if ( $this->mArticle
->mParserOutput
!== false ) {
2085 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
2086 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
2087 # Ensure that UI elements requiring revision ID have
2088 # the correct version information.
2089 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
2098 function fallback() {
2099 return $this->mArticle
->tryDirtyCache();
2103 * @param $status Status
2105 function error( $status ) {
2108 $wgOut->clearHTML(); // for release() errors
2109 $wgOut->enableClientCache( false );
2110 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2112 $errortext = $status->getWikiText( false, 'view-pool-error' );
2113 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );