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 $mContentLoaded = false; // !<
42 var $mRedirectedFrom = null;
45 * @var mixed: boolean false or URL string
47 var $mRedirectUrl = false; // !<
48 var $mRevIdFetched = 0; // !<
53 var $mRevision = null;
63 * Constructor and clear the article
64 * @param $title Title Reference to a Title object.
65 * @param $oldId Integer revision ID, null to fetch from request, zero for current
67 public function __construct( Title
$title, $oldId = null ) {
68 $this->mOldId
= $oldId;
69 $this->mPage
= $this->newPage( $title );
72 protected function newPage( Title
$title ) {
73 return new WikiPage( $title );
77 * Constructor from a page id
78 * @param $id Int article ID to load
80 public static function newFromID( $id ) {
81 $t = Title
::newFromID( $id );
82 # @todo FIXME: Doesn't inherit right
83 return $t == null ?
null : new self( $t );
84 # return $t == null ? null : new static( $t ); // PHP 5.3
88 * Create an Article object of the appropriate class for the given page.
91 * @param $context RequestContext
92 * @return Article object
94 public static function newFromTitle( $title, RequestContext
$context ) {
95 if ( NS_MEDIA
== $title->getNamespace() ) {
96 // FIXME: where should this go?
97 $title = Title
::makeTitle( NS_FILE
, $title->getDBkey() );
101 wfRunHooks( 'ArticleFromTitle', array( &$title, &$page ) );
103 switch( $title->getNamespace() ) {
105 $page = new ImagePage( $title );
108 $page = new CategoryPage( $title );
111 $page = new Article( $title );
114 $page->setContext( $context );
120 * Tell the page view functions that this view was redirected
121 * from another page on the wiki.
122 * @param $from Title object.
124 public function setRedirectedFrom( Title
$from ) {
125 $this->mRedirectedFrom
= $from;
129 * Get the title object of the article
130 * @return Title object of this page
132 public function getTitle() {
133 return $this->mPage
->getTitle();
138 * @todo FIXME: Shouldn't this be public?
141 public function clear() {
142 $this->mContentLoaded
= false;
144 $this->mRedirectedFrom
= null; # Title object if set
145 $this->mRevIdFetched
= 0;
146 $this->mRedirectUrl
= false;
148 $this->mPage
->clear();
152 * Note that getContent/loadContent do not follow redirects anymore.
153 * If you need to fetch redirectable content easily, try
154 * the shortcut in Article::followRedirect()
156 * This function has side effects! Do not use this function if you
157 * only want the real revision text if any.
159 * @return Return the text of this revision
161 public function getContent() {
164 wfProfileIn( __METHOD__
);
166 if ( $this->mPage
->getID() === 0 ) {
167 # If this is a MediaWiki:x message, then load the messages
168 # and return the message value for x.
169 if ( $this->getTitle()->getNamespace() == NS_MEDIAWIKI
) {
170 $text = $this->getTitle()->getDefaultMessageText();
171 if ( $text === false ) {
175 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
177 wfProfileOut( __METHOD__
);
181 $this->loadContent();
182 wfProfileOut( __METHOD__
);
184 return $this->mContent
;
189 * @return int The oldid of the article that is to be shown, 0 for the
192 public function getOldID() {
193 if ( is_null( $this->mOldId
) ) {
194 $this->mOldId
= $this->getOldIDFromRequest();
197 return $this->mOldId
;
201 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
203 * @return int The old id for the request
205 public function getOldIDFromRequest() {
208 $this->mRedirectUrl
= false;
210 $oldid = $wgRequest->getVal( 'oldid' );
212 if ( isset( $oldid ) ) {
213 $oldid = intval( $oldid );
214 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
215 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
219 $this->mRedirectUrl
= $this->getTitle()->getFullURL( 'redirect=no' );
221 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
222 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
237 * Load the revision (including text) into this object
239 function loadContent() {
240 if ( $this->mContentLoaded
) {
244 wfProfileIn( __METHOD__
);
246 $this->fetchContent( $this->getOldID() );
248 wfProfileOut( __METHOD__
);
252 * Get text of an article from database
253 * Does *NOT* follow redirects.
255 * @param $oldid Int: 0 for whatever the latest revision is
256 * @return mixed string containing article contents, or false if null
258 function fetchContent( $oldid = 0 ) {
259 if ( $this->mContentLoaded
) {
260 return $this->mContent
;
263 # Pre-fill content with error message so that if something
264 # fails we'll have something telling us what we intended.
265 $t = $this->getTitle()->getPrefixedText();
266 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
267 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
270 $revision = Revision
::newFromId( $oldid );
272 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
275 // Revision title doesn't match the page title given?
276 if ( $this->mPage
->getID() != $revision->getPage() ) {
277 $function = array( get_class( $this->mPage
), 'newFromID' );
278 $this->mPage
= call_user_func( $function, $revision->getPage() );
279 if ( !$this->mPage
->getId() ) {
280 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
285 if ( !$this->mPage
->getLatest() ) {
286 wfDebug( __METHOD__
. " failed to find page data for title " . $this->getTitle()->getPrefixedText() . "\n" );
290 $revision = $this->mPage
->getRevision();
292 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id " . $this->mPage
->getLatest() . "\n" );
297 // @todo FIXME: Horrible, horrible! This content-loading interface just plain sucks.
298 // We should instead work with the Revision object when we need it...
299 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
301 $this->mRevIdFetched
= $revision->getId();
302 $this->mContentLoaded
= true;
303 $this->mRevision
=& $revision;
305 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
307 return $this->mContent
;
312 * @deprecated since 1.18
314 public function forUpdate() {
315 wfDeprecated( __METHOD__
);
319 * Returns true if the currently-referenced revision is the current edit
320 * to this page (and it exists).
323 public function isCurrent() {
324 # If no oldid, this is the current version.
325 if ( $this->getOldID() == 0 ) {
329 return $this->mPage
->exists() && $this->mRevision
&& $this->mRevision
->isCurrent();
333 * Use this to fetch the rev ID used on page views
335 * @return int revision ID of last article revision
337 public function getRevIdFetched() {
338 if ( $this->mRevIdFetched
) {
339 return $this->mRevIdFetched
;
341 return $this->mPage
->getLatest();
346 * This is the default action of the index.php entry point: just view the
347 * page of the given title.
349 public function view() {
350 global $wgUser, $wgOut, $wgRequest, $wgParser;
351 global $wgUseFileCache, $wgUseETag;
353 wfProfileIn( __METHOD__
);
355 # Get variables from query string
356 $oldid = $this->getOldID();
358 # getOldID may want us to redirect somewhere else
359 if ( $this->mRedirectUrl
) {
360 $wgOut->redirect( $this->mRedirectUrl
);
361 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
362 wfProfileOut( __METHOD__
);
367 # Set page title (may be overridden by DISPLAYTITLE)
368 $wgOut->setPageTitle( $this->getTitle()->getPrefixedText() );
370 # If we got diff in the query, we want to see a diff page instead of the article.
371 if ( $wgRequest->getCheck( 'diff' ) ) {
372 wfDebug( __METHOD__
. ": showing diff page\n" );
373 $this->showDiffPage();
374 wfProfileOut( __METHOD__
);
379 $wgOut->setArticleFlag( true );
380 # Allow frames by default
381 $wgOut->allowClickjacking();
383 $parserCache = ParserCache
::singleton();
385 $parserOptions = $this->mPage
->getParserOptions();
386 # Render printable version, use printable version cache
387 if ( $wgOut->isPrintable() ) {
388 $parserOptions->setIsPrintable( true );
389 $parserOptions->setEditSection( false );
390 } elseif ( $wgUseETag && !$this->getTitle()->quickUserCan( 'edit' ) ) {
391 $parserOptions->setEditSection( false );
394 # Try client and file cache
395 if ( $oldid === 0 && $this->mPage
->checkTouched() ) {
397 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
400 # Is it client cached?
401 if ( $wgOut->checkLastModified( $this->mPage
->getTouched() ) ) {
402 wfDebug( __METHOD__
. ": done 304\n" );
403 wfProfileOut( __METHOD__
);
407 } elseif ( $wgUseFileCache && $this->tryFileCache() ) {
408 wfDebug( __METHOD__
. ": done file cache\n" );
409 # tell wgOut that output is taken care of
411 $this->mPage
->viewUpdates();
412 wfProfileOut( __METHOD__
);
418 if ( !$wgUseETag && !$this->getTitle()->quickUserCan( 'edit' ) ) {
419 $parserOptions->setEditSection( false );
422 # Should the parser cache be used?
423 $useParserCache = $this->useParserCache( $oldid );
424 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
425 if ( $wgUser->getStubThreshold() ) {
426 wfIncrStats( 'pcache_miss_stub' );
429 $wasRedirected = $this->showRedirectedFromHeader();
430 $this->showNamespaceHeader();
432 # Iterate through the possible ways of constructing the output text.
433 # Keep going until $outputDone is set, or we run out of things to do.
436 $this->mParserOutput
= false;
438 while ( !$outputDone && ++
$pass ) {
441 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
444 # Try the parser cache
445 if ( $useParserCache ) {
446 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
448 if ( $this->mParserOutput
!== false ) {
449 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
450 $wgOut->addParserOutput( $this->mParserOutput
);
451 # Ensure that UI elements requiring revision ID have
452 # the correct version information.
453 $wgOut->setRevisionId( $this->mPage
->getLatest() );
455 # Preload timestamp to avoid a DB hit
456 if ( isset( $this->mParserOutput
->mTimestamp
) ) {
457 $this->mPage
->setTimestamp( $this->mParserOutput
->mTimestamp
);
463 $text = $this->getContent();
464 if ( $text === false ||
$this->mPage
->getID() == 0 ) {
465 wfDebug( __METHOD__
. ": showing missing article\n" );
466 $this->showMissingArticle();
467 wfProfileOut( __METHOD__
);
471 # Another whitelist check in case oldid is altering the title
472 if ( !$this->getTitle()->userCanRead() ) {
473 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
474 $wgOut->loginToUse();
477 wfProfileOut( __METHOD__
);
481 # Are we looking at an old revision
482 if ( $oldid && !is_null( $this->mRevision
) ) {
483 $this->setOldSubtitle( $oldid );
485 if ( !$this->showDeletedRevisionHeader() ) {
486 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
487 wfProfileOut( __METHOD__
);
491 # If this "old" version is the current, then try the parser cache...
492 if ( $oldid === $this->mPage
->getLatest() && $this->useParserCache( false ) ) {
493 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
494 if ( $this->mParserOutput
) {
495 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
496 $wgOut->addParserOutput( $this->mParserOutput
);
497 $wgOut->setRevisionId( $this->mPage
->getLatest() );
504 # Ensure that UI elements requiring revision ID have
505 # the correct version information.
506 $wgOut->setRevisionId( $this->getRevIdFetched() );
508 # Pages containing custom CSS or JavaScript get special treatment
509 if ( $this->getTitle()->isCssOrJsPage() ||
$this->getTitle()->isCssJsSubpage() ) {
510 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
511 $this->showCssOrJsPage();
513 } elseif( !wfRunHooks( 'ArticleViewCustom', array( $this->mContent
, $this->getTitle(), $wgOut ) ) ) {
514 # Allow extensions do their own custom view for certain pages
517 $rt = Title
::newFromRedirectArray( $text );
519 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
520 # Viewing a redirect page (e.g. with parameter redirect=no)
521 # Don't append the subtitle if this was an old revision
522 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
523 # Parse just to get categories, displaytitle, etc.
524 $this->mParserOutput
= $wgParser->parse( $text, $this->getTitle(), $parserOptions );
525 $wgOut->addParserOutputNoText( $this->mParserOutput
);
531 # Run the parse, protected by a pool counter
532 wfDebug( __METHOD__
. ": doing uncached parse\n" );
534 $key = $parserCache->getKey( $this, $parserOptions );
535 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
537 if ( !$poolArticleView->execute() ) {
538 # Connection or timeout error
539 wfProfileOut( __METHOD__
);
545 # Should be unreachable, but just in case...
551 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
552 if ( $this->mParserOutput
) {
553 $titleText = $this->mParserOutput
->getTitleText();
555 if ( strval( $titleText ) !== '' ) {
556 $wgOut->setPageTitle( $titleText );
560 # For the main page, overwrite the <title> element with the con-
561 # tents of 'pagetitle-view-mainpage' instead of the default (if
563 # This message always exists because it is in the i18n files
564 if ( $this->getTitle()->equals( Title
::newMainPage() ) ) {
565 $msg = wfMessage( 'pagetitle-view-mainpage' )->inContentLanguage();
566 if ( !$msg->isDisabled() ) {
567 $wgOut->setHTMLTitle( $msg->title( $this->getTitle() )->text() );
571 # Now that we've filled $this->mParserOutput, we know whether
572 # there are any __NOINDEX__ tags on the page
573 $policy = $this->getRobotPolicy( 'view' );
574 $wgOut->setIndexPolicy( $policy['index'] );
575 $wgOut->setFollowPolicy( $policy['follow'] );
577 $this->showViewFooter();
578 $this->mPage
->viewUpdates();
579 wfProfileOut( __METHOD__
);
583 * Show a diff page according to current request variables. For use within
584 * Article::view() only, other callers should use the DifferenceEngine class.
586 public function showDiffPage() {
587 global $wgRequest, $wgUser;
589 $diff = $wgRequest->getVal( 'diff' );
590 $rcid = $wgRequest->getVal( 'rcid' );
591 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
592 $purge = $wgRequest->getVal( 'action' ) == 'purge';
593 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
594 $oldid = $this->getOldID();
596 $de = new DifferenceEngine( $this->getTitle(), $oldid, $diff, $rcid, $purge, $unhide );
597 // DifferenceEngine directly fetched the revision:
598 $this->mRevIdFetched
= $de->mNewid
;
599 $de->showDiffPage( $diffOnly );
601 if ( $diff == 0 ||
$diff == $this->mPage
->getLatest() ) {
602 # Run view updates for current revision only
603 $this->mPage
->viewUpdates();
608 * Show a page view for a page formatted as CSS or JavaScript. To be called by
609 * Article::view() only.
611 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
614 protected function showCssOrJsPage() {
617 $dir = $this->getContext()->getLang()->getDir();
618 $lang = $this->getContext()->getLang()->getCode();
620 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache' lang='$lang' dir='$dir' class='mw-content-$dir'>\n$1\n</div>",
623 // Give hooks a chance to customise the output
624 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->getTitle(), $wgOut ) ) ) {
625 // Wrap the whole lot in a <pre> and don't parse
627 preg_match( '!\.(css|js)$!u', $this->getTitle()->getText(), $m );
628 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
629 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
630 $wgOut->addHTML( "\n</pre>\n" );
635 * Get the robot policy to be used for the current view
636 * @param $action String the action= GET parameter
637 * @return Array the policy that should be set
638 * TODO: actions other than 'view'
640 public function getRobotPolicy( $action ) {
641 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
642 global $wgDefaultRobotPolicy, $wgRequest;
644 $ns = $this->getTitle()->getNamespace();
646 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
647 # Don't index user and user talk pages for blocked users (bug 11443)
648 if ( !$this->getTitle()->isSubpage() ) {
649 if ( Block
::newFromTarget( null, $this->getTitle()->getText() ) instanceof Block
) {
651 'index' => 'noindex',
652 'follow' => 'nofollow'
658 if ( $this->mPage
->getID() === 0 ||
$this->getOldID() ) {
659 # Non-articles (special pages etc), and old revisions
661 'index' => 'noindex',
662 'follow' => 'nofollow'
664 } elseif ( $wgOut->isPrintable() ) {
665 # Discourage indexing of printable versions, but encourage following
667 'index' => 'noindex',
670 } elseif ( $wgRequest->getInt( 'curid' ) ) {
671 # For ?curid=x urls, disallow indexing
673 'index' => 'noindex',
678 # Otherwise, construct the policy based on the various config variables.
679 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
681 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
682 # Honour customised robot policies for this namespace
683 $policy = array_merge(
685 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
688 if ( $this->getTitle()->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
689 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
690 # a final sanity check that we have really got the parser output.
691 $policy = array_merge(
693 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
697 if ( isset( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] ) ) {
698 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
699 $policy = array_merge(
701 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] )
709 * Converts a String robot policy into an associative array, to allow
710 * merging of several policies using array_merge().
711 * @param $policy Mixed, returns empty array on null/false/'', transparent
712 * to already-converted arrays, converts String.
713 * @return Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
715 public static function formatRobotPolicy( $policy ) {
716 if ( is_array( $policy ) ) {
718 } elseif ( !$policy ) {
722 $policy = explode( ',', $policy );
723 $policy = array_map( 'trim', $policy );
726 foreach ( $policy as $var ) {
727 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
728 $arr['index'] = $var;
729 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
730 $arr['follow'] = $var;
738 * If this request is a redirect view, send "redirected from" subtitle to
739 * $wgOut. Returns true if the header was needed, false if this is not a
740 * redirect view. Handles both local and remote redirects.
744 public function showRedirectedFromHeader() {
745 global $wgOut, $wgRequest, $wgRedirectSources;
747 $rdfrom = $wgRequest->getVal( 'rdfrom' );
749 if ( isset( $this->mRedirectedFrom
) ) {
750 // This is an internally redirected page view.
751 // We'll need a backlink to the source page for navigation.
752 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
753 $redir = Linker
::link(
754 $this->mRedirectedFrom
,
757 array( 'redirect' => 'no' ),
758 array( 'known', 'noclasses' )
761 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
762 $wgOut->setSubtitle( $s );
764 // Set the fragment if one was specified in the redirect
765 if ( strval( $this->getTitle()->getFragment() ) != '' ) {
766 $fragment = Xml
::escapeJsString( $this->getTitle()->getFragmentForURL() );
767 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
770 // Add a <link rel="canonical"> tag
771 $wgOut->addLink( array( 'rel' => 'canonical',
772 'href' => $this->getTitle()->getLocalURL() )
777 } elseif ( $rdfrom ) {
778 // This is an externally redirected view, from some other wiki.
779 // If it was reported from a trusted site, supply a backlink.
780 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
781 $redir = Linker
::makeExternalLink( $rdfrom, $rdfrom );
782 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
783 $wgOut->setSubtitle( $s );
793 * Show a header specific to the namespace currently being viewed, like
794 * [[MediaWiki:Talkpagetext]]. For Article::view().
796 public function showNamespaceHeader() {
799 if ( $this->getTitle()->isTalkPage() ) {
800 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
801 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
807 * Show the footer section of an ordinary page view
809 public function showViewFooter() {
810 global $wgOut, $wgUseTrackbacks;
812 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
813 if ( $this->getTitle()->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->getTitle()->getText() ) ) {
814 $wgOut->addWikiMsg( 'anontalkpagetext' );
817 # If we have been passed an &rcid= parameter, we want to give the user a
818 # chance to mark this new article as patrolled.
819 $this->showPatrolFooter();
822 if ( $wgUseTrackbacks ) {
823 $this->addTrackbacks();
826 wfRunHooks( 'ArticleViewFooter', array( $this ) );
831 * If patrol is possible, output a patrol UI box. This is called from the
832 * footer section of ordinary page views. If patrol is not possible or not
833 * desired, does nothing.
835 public function showPatrolFooter() {
836 global $wgOut, $wgRequest, $wgUser;
838 $rcid = $wgRequest->getVal( 'rcid' );
840 if ( !$rcid ||
!$this->getTitle()->quickUserCan( 'patrol' ) ) {
844 $token = $wgUser->editToken( $rcid );
845 $wgOut->preventClickjacking();
848 "<div class='patrollink'>" .
850 'markaspatrolledlink',
853 wfMsgHtml( 'markaspatrolledtext' ),
856 'action' => 'markpatrolled',
860 array( 'known', 'noclasses' )
868 * Show the error text for a missing article. For articles in the MediaWiki
869 * namespace, show the default message text. To be called from Article::view().
871 public function showMissingArticle() {
872 global $wgOut, $wgRequest, $wgUser;
874 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
875 if ( $this->getTitle()->getNamespace() == NS_USER ||
$this->getTitle()->getNamespace() == NS_USER_TALK
) {
876 $parts = explode( '/', $this->getTitle()->getText() );
877 $rootPart = $parts[0];
878 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
879 $ip = User
::isIP( $rootPart );
881 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
882 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
883 array( 'userpage-userdoesnotexist-view', wfEscapeWikiText( $rootPart ) ) );
884 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
885 LogEventsList
::showLogExtract(
888 $user->getUserPage()->getPrefixedText(),
892 'showIfEmpty' => false,
894 'blocked-notice-logextract',
895 $user->getName() # Support GENDER in notice
902 wfRunHooks( 'ShowMissingArticle', array( $this ) );
904 # Show delete and move logs
905 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->getTitle()->getPrefixedText(), '',
907 'conds' => array( "log_action != 'revision'" ),
908 'showIfEmpty' => false,
909 'msgKey' => array( 'moveddeleted-notice' ) )
913 $oldid = $this->getOldID();
915 $text = wfMsgNoTrans( 'missing-article',
916 $this->getTitle()->getPrefixedText(),
917 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
918 } elseif ( $this->getTitle()->getNamespace() === NS_MEDIAWIKI
) {
919 // Use the default message text
920 $text = $this->getTitle()->getDefaultMessageText();
922 $createErrors = $this->getTitle()->getUserPermissionsErrors( 'create', $wgUser );
923 $editErrors = $this->getTitle()->getUserPermissionsErrors( 'edit', $wgUser );
924 $errors = array_merge( $createErrors, $editErrors );
926 if ( !count( $errors ) ) {
927 $text = wfMsgNoTrans( 'noarticletext' );
929 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
932 $text = "<div class='noarticletext'>\n$text\n</div>";
934 if ( !$this->mPage
->hasViewableContent() ) {
935 // If there's no backing content, send a 404 Not Found
936 // for better machine handling of broken links.
937 $wgRequest->response()->header( "HTTP/1.1 404 Not Found" );
940 $wgOut->addWikiText( $text );
944 * If the revision requested for view is deleted, check permissions.
945 * Send either an error message or a warning header to $wgOut.
947 * @return boolean true if the view is allowed, false if not.
949 public function showDeletedRevisionHeader() {
950 global $wgOut, $wgRequest;
952 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
957 // If the user is not allowed to see it...
958 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
959 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
960 'rev-deleted-text-permission' );
963 // If the user needs to confirm that they want to see it...
964 } elseif ( $wgRequest->getInt( 'unhide' ) != 1 ) {
965 # Give explanation and add a link to view the revision...
966 $oldid = intval( $this->getOldID() );
967 $link = $this->getTitle()->getFullUrl( "oldid={$oldid}&unhide=1" );
968 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
969 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
970 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
971 array( $msg, $link ) );
974 // We are allowed to see...
976 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
977 'rev-suppressed-text-view' : 'rev-deleted-text-view';
978 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
985 * Execute the uncached parse for action=view
987 public function doViewParse() {
990 $oldid = $this->getOldID();
991 $parserOptions = $this->mPage
->getParserOptions();
993 # Render printable version, use printable version cache
994 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
996 # Don't show section-edit links on old revisions... this way lies madness.
997 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ||
!$this->getTitle()->quickUserCan( 'edit' ) ) {
998 $parserOptions->setEditSection( false );
1001 $useParserCache = $this->useParserCache( $oldid );
1002 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1008 * Try to fetch an expired entry from the parser cache. If it is present,
1009 * output it and return true. If it is not present, output nothing and
1010 * return false. This is used as a callback function for
1011 * PoolCounter::executeProtected().
1015 public function tryDirtyCache() {
1017 $parserCache = ParserCache
::singleton();
1018 $options = $this->mPage
->getParserOptions();
1020 if ( $wgOut->isPrintable() ) {
1021 $options->setIsPrintable( true );
1022 $options->setEditSection( false );
1025 $output = $parserCache->getDirty( $this, $options );
1028 wfDebug( __METHOD__
. ": sending dirty output\n" );
1029 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1030 $wgOut->setSquidMaxage( 0 );
1031 $this->mParserOutput
= $output;
1032 $wgOut->addParserOutput( $output );
1033 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1037 wfDebugLog( 'dirty', "dirty missing\n" );
1038 wfDebug( __METHOD__
. ": no dirty cache\n" );
1047 * @param $target Title|Array of destination(s) to redirect
1048 * @param $appendSubtitle Boolean [optional]
1049 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1050 * @return string containing HMTL with redirect link
1052 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1053 global $wgOut, $wgLang, $wgStylePath;
1055 if ( !is_array( $target ) ) {
1056 $target = array( $target );
1059 $imageDir = $wgLang->getDir();
1061 if ( $appendSubtitle ) {
1062 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1065 // the loop prepends the arrow image before the link, so the first case needs to be outside
1066 $title = array_shift( $target );
1068 if ( $forceKnown ) {
1069 $link = Linker
::linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1071 $link = Linker
::link( $title, htmlspecialchars( $title->getFullText() ) );
1074 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1075 $alt = $wgLang->isRTL() ?
'←' : '→';
1076 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1077 foreach ( $target as $rt ) {
1078 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1079 if ( $forceKnown ) {
1080 $link .= Linker
::linkKnown( $rt, htmlspecialchars( $rt->getFullText(), array(), array( 'redirect' => 'no' ) ) );
1082 $link .= Linker
::link( $rt, htmlspecialchars( $rt->getFullText() ), array(), array( 'redirect' => 'no' ) );
1086 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1087 return '<div class="redirectMsg">' .
1088 Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1089 '<span class="redirectText">' . $link . '</span></div>';
1093 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1095 public function addTrackbacks() {
1098 $dbr = wfGetDB( DB_SLAVE
);
1099 $tbs = $dbr->select( 'trackbacks',
1100 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1101 array( 'tb_page' => $this->mPage
->getID() )
1104 if ( !$dbr->numRows( $tbs ) ) {
1108 $wgOut->preventClickjacking();
1111 foreach ( $tbs as $o ) {
1114 if ( $this->getContext()->getUser()->isAllowed( 'trackback' ) ) {
1115 $delurl = $this->getTitle()->getFullURL( "action=deletetrackback&tbid=" .
1116 $o->tb_id
. "&token=" . urlencode( $this->getContext()->getUser()->editToken() ) );
1117 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1121 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1129 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1133 * Removes trackback record for current article from trackbacks table
1134 * @deprecated since 1.18
1136 public function deletetrackback() {
1137 return Action
::factory( 'deletetrackback', $this )->show();
1141 * Handle action=render
1144 public function render() {
1147 $wgOut->setArticleBodyOnly( true );
1152 * Handle action=purge
1154 public function purge() {
1155 return Action
::factory( 'purge', $this )->show();
1159 * Mark this particular edit/page as patrolled
1160 * @deprecated since 1.18
1162 public function markpatrolled() {
1163 Action
::factory( 'markpatrolled', $this )->show();
1167 * User-interface handler for the "watch" action.
1168 * Requires Request to pass a token as of 1.18.
1169 * @deprecated since 1.18
1171 public function watch() {
1172 Action
::factory( 'watch', $this )->show();
1176 * Add this page to $wgUser's watchlist
1178 * This is safe to be called multiple times
1180 * @return bool true on successful watch operation
1181 * @deprecated since 1.18
1183 public function doWatch() {
1185 return WatchAction
::doWatch( $this->getTitle(), $wgUser );
1189 * User interface handler for the "unwatch" action.
1190 * Requires Request to pass a token as of 1.18.
1191 * @deprecated since 1.18
1193 public function unwatch() {
1194 Action
::factory( 'unwatch', $this )->show();
1198 * Stop watching a page
1199 * @return bool true on successful unwatch
1200 * @deprecated since 1.18
1202 public function doUnwatch() {
1204 return WatchAction
::doUnwatch( $this->getTitle(), $wgUser );
1208 * action=protect handler
1210 public function protect() {
1211 $form = new ProtectionForm( $this );
1216 * action=unprotect handler (alias)
1218 public function unprotect() {
1223 * Info about this page
1224 * Called for ?action=info when $wgAllowPageInfo is on.
1226 public function info() {
1227 Action
::factory( 'info', $this )->show();
1231 * Overriden by ImagePage class, only present here to avoid a fatal error
1232 * Called for ?action=revert
1234 public function revert() {
1235 Action
::factory( 'revert', $this )->show();
1239 * User interface for rollback operations
1241 public function rollback() {
1242 Action
::factory( 'rollback', $this )->show();
1246 * Output a redirect back to the article.
1247 * This is typically used after an edit.
1249 * @deprecated in 1.18; call $wgOut->redirect() directly
1250 * @param $noRedir Boolean: add redirect=no
1251 * @param $sectionAnchor String: section to redirect to, including "#"
1252 * @param $extraQuery String: extra query params
1254 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
1255 wfDeprecated( __METHOD__
);
1259 $query = 'redirect=no';
1261 $query .= "&$extraQuery";
1263 $query = $extraQuery;
1266 $wgOut->redirect( $this->getTitle()->getFullURL( $query ) . $sectionAnchor );
1270 * UI entry point for page deletion
1272 public function delete() {
1273 global $wgOut, $wgRequest;
1275 $confirm = $wgRequest->wasPosted() &&
1276 $this->getContext()->getUser()->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
1278 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
1279 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
1281 $reason = $this->DeleteReasonList
;
1283 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
1284 // Entry from drop down menu + additional comment
1285 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
1286 } elseif ( $reason == 'other' ) {
1287 $reason = $this->DeleteReason
;
1290 # Flag to hide all contents of the archived revisions
1291 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $this->getContext()->getUser()->isAllowed( 'suppressrevision' );
1293 # This code desperately needs to be totally rewritten
1295 # Read-only check...
1296 if ( wfReadOnly() ) {
1297 $wgOut->readOnlyPage();
1303 $permission_errors = $this->getTitle()->getUserPermissionsErrors( 'delete', $this->getContext()->getUser() );
1305 if ( count( $permission_errors ) > 0 ) {
1306 $wgOut->showPermissionsErrorPage( $permission_errors );
1311 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->getTitle()->getPrefixedText() ) );
1313 # Better double-check that it hasn't been deleted yet!
1314 $dbw = wfGetDB( DB_MASTER
);
1315 $conds = $this->getTitle()->pageCond();
1316 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
1317 if ( $latest === false ) {
1318 $wgOut->showFatalError(
1321 array( 'class' => 'error mw-error-cannotdelete' ),
1322 wfMsgExt( 'cannotdelete', array( 'parse' ),
1323 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) )
1326 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
1327 LogEventsList
::showLogExtract(
1330 $this->getTitle()->getPrefixedText()
1336 # Hack for big sites
1337 $bigHistory = $this->mPage
->isBigDeletion();
1338 if ( $bigHistory && !$this->getTitle()->userCan( 'bigdelete' ) ) {
1339 global $wgLang, $wgDeleteRevisionsLimit;
1341 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1342 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
1348 $this->doDelete( $reason, $suppress );
1350 if ( $wgRequest->getCheck( 'wpWatch' ) && $this->getContext()->getUser()->isLoggedIn() ) {
1352 } elseif ( $this->getTitle()->userIsWatching() ) {
1359 // Generate deletion reason
1360 $hasHistory = false;
1362 $reason = $this->generateReason( $hasHistory );
1365 // If the page has a history, insert a warning
1366 if ( $hasHistory && !$confirm ) {
1369 $revisions = $this->mPage
->estimateRevisionCount();
1370 // @todo FIXME: i18n issue/patchwork message
1371 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
1372 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
1373 wfMsgHtml( 'word-separator' ) . Linker
::link( $this->getTitle(),
1374 wfMsgHtml( 'history' ),
1375 array( 'rel' => 'archives' ),
1376 array( 'action' => 'history' ) ) .
1380 if ( $bigHistory ) {
1381 global $wgDeleteRevisionsLimit;
1382 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1383 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
1387 return $this->confirmDelete( $reason );
1391 * Output deletion confirmation dialog
1392 * @todo FIXME: Move to another file?
1393 * @param $reason String: prefilled reason
1395 public function confirmDelete( $reason ) {
1398 wfDebug( "Article::confirmDelete\n" );
1400 $deleteBackLink = Linker
::linkKnown( $this->getTitle() );
1401 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
1402 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1403 $wgOut->addWikiMsg( 'confirmdeletetext' );
1405 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
1407 if ( $this->getContext()->getUser()->isAllowed( 'suppressrevision' ) ) {
1408 $suppress = "<tr id=\"wpDeleteSuppressRow\">
1410 <td class='mw-input'><strong>" .
1411 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
1412 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
1418 $checkWatch = $this->getContext()->getUser()->getBoolOption( 'watchdeletion' ) ||
$this->getTitle()->userIsWatching();
1420 $form = Xml
::openElement( 'form', array( 'method' => 'post',
1421 'action' => $this->getTitle()->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
1422 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
1423 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
1424 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
1425 "<tr id=\"wpDeleteReasonListRow\">
1426 <td class='mw-label'>" .
1427 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
1429 <td class='mw-input'>" .
1430 Xml
::listDropDown( 'wpDeleteReasonList',
1431 wfMsgForContent( 'deletereason-dropdown' ),
1432 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
1435 <tr id=\"wpDeleteReasonRow\">
1436 <td class='mw-label'>" .
1437 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
1439 <td class='mw-input'>" .
1440 Html
::input( 'wpReason', $reason, 'text', array(
1442 'maxlength' => '255',
1450 # Disallow watching if user is not logged in
1451 if ( $this->getContext()->getUser()->isLoggedIn() ) {
1455 <td class='mw-input'>" .
1456 Xml
::checkLabel( wfMsg( 'watchthis' ),
1457 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
1466 <td class='mw-submit'>" .
1467 Xml
::submitButton( wfMsg( 'deletepage' ),
1468 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
1471 Xml
::closeElement( 'table' ) .
1472 Xml
::closeElement( 'fieldset' ) .
1473 Html
::hidden( 'wpEditToken', $this->getContext()->getUser()->editToken() ) .
1474 Xml
::closeElement( 'form' );
1476 if ( $this->getContext()->getUser()->isAllowed( 'editinterface' ) ) {
1477 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
1478 $link = Linker
::link(
1480 wfMsgHtml( 'delete-edit-reasonlist' ),
1482 array( 'action' => 'edit' )
1484 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
1487 $wgOut->addHTML( $form );
1488 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
1489 LogEventsList
::showLogExtract( $wgOut, 'delete',
1490 $this->getTitle()->getPrefixedText()
1495 * Perform a deletion and output success or failure messages
1497 public function doDelete( $reason, $suppress = false ) {
1500 $id = $this->getTitle()->getArticleID( Title
::GAID_FOR_UPDATE
);
1503 if ( $this->mPage
->doDeleteArticle( $reason, $suppress, $id, $error ) ) {
1504 $deleted = $this->getTitle()->getPrefixedText();
1506 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
1507 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1509 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
1511 $wgOut->addWikiMsg( 'deletedtext', wfEscapeWikiText( $deleted ), $loglink );
1512 $wgOut->returnToMain( false );
1514 if ( $error == '' ) {
1515 $wgOut->showFatalError(
1518 array( 'class' => 'error mw-error-cannotdelete' ),
1519 wfMsgExt( 'cannotdelete', array( 'parse' ),
1520 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) )
1524 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
1526 LogEventsList
::showLogExtract(
1529 $this->getTitle()->getPrefixedText()
1532 $wgOut->showFatalError( $error );
1538 * Generate the navigation links when browsing through an article revisions
1539 * It shows the information as:
1540 * Revision as of \<date\>; view current revision
1541 * \<- Previous version | Next Version -\>
1543 * @param $oldid String: revision ID of this article revision
1545 public function setOldSubtitle( $oldid = 0 ) {
1546 global $wgLang, $wgOut, $wgUser, $wgRequest;
1548 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
1552 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1554 # Cascade unhide param in links for easy deletion browsing
1555 $extraParams = array();
1556 if ( $wgRequest->getVal( 'unhide' ) ) {
1557 $extraParams['unhide'] = 1;
1560 $revision = Revision
::newFromId( $oldid );
1561 $timestamp = $revision->getTimestamp();
1563 $current = ( $oldid == $this->mPage
->getLatest() );
1564 $td = $wgLang->timeanddate( $timestamp, true );
1565 $tddate = $wgLang->date( $timestamp, true );
1566 $tdtime = $wgLang->time( $timestamp, true );
1569 ?
wfMsgHtml( 'currentrevisionlink' )
1572 wfMsgHtml( 'currentrevisionlink' ),
1575 array( 'known', 'noclasses' )
1578 ?
wfMsgHtml( 'diff' )
1581 wfMsgHtml( 'diff' ),
1587 array( 'known', 'noclasses' )
1589 $prev = $this->getTitle()->getPreviousRevisionID( $oldid ) ;
1593 wfMsgHtml( 'previousrevision' ),
1596 'direction' => 'prev',
1599 array( 'known', 'noclasses' )
1601 : wfMsgHtml( 'previousrevision' );
1605 wfMsgHtml( 'diff' ),
1611 array( 'known', 'noclasses' )
1613 : wfMsgHtml( 'diff' );
1614 $nextlink = $current
1615 ?
wfMsgHtml( 'nextrevision' )
1618 wfMsgHtml( 'nextrevision' ),
1621 'direction' => 'next',
1624 array( 'known', 'noclasses' )
1626 $nextdiff = $current
1627 ?
wfMsgHtml( 'diff' )
1630 wfMsgHtml( 'diff' ),
1636 array( 'known', 'noclasses' )
1641 // User can delete revisions or view deleted revisions...
1642 $canHide = $wgUser->isAllowed( 'deleterevision' );
1643 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
1644 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
1645 $cdel = Linker
::revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
1648 'type' => 'revision',
1649 'target' => $this->getTitle()->getPrefixedDbkey(),
1652 $cdel = Linker
::revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1657 # Show user links if allowed to see them. If hidden, then show them only if requested...
1658 $userlinks = Linker
::revUserTools( $revision, !$unhide );
1660 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
1661 ?
'revision-info-current'
1664 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
1667 array( 'parseinline', 'replaceafter' ),
1673 $revision->getUser()
1676 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
1677 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
1679 $wgOut->setSubtitle( $r );
1682 /* Caching functions */
1685 * checkLastModified returns true if it has taken care of all
1686 * output to the client that is necessary for this request.
1687 * (that is, it has sent a cached version of the page)
1689 * @return boolean true if cached version send, false otherwise
1691 protected function tryFileCache() {
1692 static $called = false;
1695 wfDebug( "Article::tryFileCache(): called twice!?\n" );
1700 if ( $this->isFileCacheable() ) {
1701 $cache = new HTMLFileCache( $this->getTitle() );
1702 if ( $cache->isFileCacheGood( $this->mPage
->getTouched() ) ) {
1703 wfDebug( "Article::tryFileCache(): about to load file\n" );
1704 $cache->loadFromFileCache();
1707 wfDebug( "Article::tryFileCache(): starting buffer\n" );
1708 ob_start( array( &$cache, 'saveToFileCache' ) );
1711 wfDebug( "Article::tryFileCache(): not cacheable\n" );
1718 * Check if the page can be cached
1721 public function isFileCacheable() {
1724 if ( HTMLFileCache
::useFileCache() ) {
1725 $cacheable = $this->mPage
->getID() && !$this->mRedirectedFrom
&& !$this->getTitle()->isRedirect();
1726 // Extension may have reason to disable file caching on some pages.
1728 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
1738 * Add the primary page-view wikitext to the output buffer
1739 * Saves the text into the parser cache if possible.
1740 * Updates templatelinks if it is out of date.
1742 * @param $text String
1743 * @param $cache Boolean
1744 * @param $parserOptions mixed ParserOptions object, or boolean false
1746 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
1749 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
1751 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
1753 $wgOut->addParserOutput( $this->mParserOutput
);
1757 * Lightweight method to get the parser output for a page, checking the parser cache
1758 * and so on. Doesn't consider most of the stuff that WikiPage::view is forced to
1759 * consider, so it's not appropriate to use there.
1761 * @since 1.16 (r52326) for LiquidThreads
1763 * @param $oldid mixed integer Revision ID or null
1764 * @param $user User The relevant user
1765 * @return ParserOutput or false if the given revsion ID is not found
1767 public function getParserOutput( $oldid = null, User
$user = null ) {
1768 global $wgEnableParserCache, $wgUser;
1769 $user = is_null( $user ) ?
$wgUser : $user;
1771 wfProfileIn( __METHOD__
);
1772 // Should the parser cache be used?
1773 $useParserCache = $wgEnableParserCache &&
1774 $user->getStubThreshold() == 0 &&
1775 $this->mPage
->exists() &&
1778 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1780 if ( $user->getStubThreshold() ) {
1781 wfIncrStats( 'pcache_miss_stub' );
1784 if ( $useParserCache ) {
1785 $parserOutput = ParserCache
::singleton()->get( $this, $this->mPage
->getParserOptions() );
1786 if ( $parserOutput !== false ) {
1787 wfProfileOut( __METHOD__
);
1788 return $parserOutput;
1792 // Cache miss; parse and output it.
1793 if ( $oldid === null ) {
1794 $text = $this->mPage
->getRawText();
1796 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
1797 if ( $rev === null ) {
1798 wfProfileOut( __METHOD__
);
1801 $text = $rev->getText();
1804 $output = $this->getOutputFromWikitext( $text, $useParserCache );
1805 wfProfileOut( __METHOD__
);
1810 * This does all the heavy lifting for outputWikitext, except it returns the parser
1811 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
1812 * say, embedding thread pages within a discussion system (LiquidThreads)
1814 * @param $text string
1815 * @param $cache boolean
1816 * @param $parserOptions parsing options, defaults to false
1817 * @return ParserOutput
1819 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
1820 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
1822 if ( !$parserOptions ) {
1823 $parserOptions = $this->mPage
->getParserOptions();
1827 $this->mParserOutput
= $wgParser->parse( $text, $this->getTitle(),
1828 $parserOptions, true, true, $this->getRevIdFetched() );
1833 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
1834 $this->getTitle()->getPrefixedDBkey() ) );
1837 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
1838 $parserCache = ParserCache
::singleton();
1839 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
1842 // Make sure file cache is not used on uncacheable content.
1843 // Output that has magic words in it can still use the parser cache
1844 // (if enabled), though it will generally expire sooner.
1845 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
1846 $wgUseFileCache = false;
1849 if ( $this->isCurrent() ) {
1850 $this->mPage
->doCascadeProtectionUpdates( $this->mParserOutput
);
1853 return $this->mParserOutput
;
1857 * Sets the context this Article is executed in
1859 * @param $context RequestContext
1862 public function setContext( $context ) {
1863 $this->mContext
= $context;
1867 * Gets the context this Article is executed in
1869 * @return RequestContext
1872 public function getContext() {
1873 if ( $this->mContext
instanceof RequestContext
) {
1874 return $this->mContext
;
1876 wfDebug( __METHOD__
. " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
1877 return RequestContext
::getMain();
1882 * Use PHP's magic __get handler to handle accessing of
1883 * raw WikiPage fields for backwards compatibility.
1885 * @param $fname String Field name
1887 public function __get( $fname ) {
1888 if ( property_exists( $this->mPage
, $fname ) ) {
1889 #wfWarn( "Access to raw $fname field " . __CLASS__ );
1890 return $this->mPage
->$fname;
1892 trigger_error( 'Inaccessible property via __get(): ' . $fname, E_USER_NOTICE
);
1896 * Use PHP's magic __set handler to handle setting of
1897 * raw WikiPage fields for backwards compatibility.
1899 * @param $fname String Field name
1900 * @param $fvalue mixed New value
1902 public function __set( $fname, $fvalue ) {
1903 if ( property_exists( $this->mPage
, $fname ) ) {
1904 #wfWarn( "Access to raw $fname field of " . __CLASS__ );
1905 $this->mPage
->$fname = $fvalue;
1906 // Note: extensions may want to toss on new fields
1907 } elseif ( !in_array( $fname, array( 'mContext', 'mPage' ) ) ) {
1908 $this->mPage
->$fname = $fvalue;
1910 trigger_error( 'Inaccessible property via __set(): ' . $fname, E_USER_NOTICE
);
1915 * Use PHP's magic __call handler to transform instance calls to
1916 * WikiPage functions for backwards compatibility.
1918 * @param $fname String Name of called method
1919 * @param $args Array Arguments to the method
1921 public function __call( $fname, $args ) {
1922 if ( is_callable( array( $this->mPage
, $fname ) ) ) {
1923 #wfWarn( "Call to " . __CLASS__ . "::$fname; please use WikiPage instead" );
1924 return call_user_func_array( array( $this->mPage
, $fname ), $args );
1926 trigger_error( 'Inaccessible function via __call(): ' . $fname, E_USER_ERROR
);
1929 // ****** B/C functions to work-around PHP silliness with __call and references ****** //
1930 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
1931 return $this->mPage
->updateRestrictions( $limit, $reason, $cascade, $expiry );
1934 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true, &$error = '' ) {
1935 return $this->mPage
->doDeleteArticle( $reason, $suppress, $id, $commit, $error );
1938 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails, User
$user = null ) {
1940 $user = is_null( $user ) ?
$wgUser : $user;
1941 return $this->mPage
->doRollback( $fromP, $summary, $token, $bot, $resultDetails, $user );
1944 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser = null ) {
1946 $guser = is_null( $guser ) ?
$wgUser : $guser;
1947 return $this->mPage
->commitRollback( $fromP, $summary, $bot, $resultDetails, $guser );
1950 public function generateReason( &$hasHistory ) {
1951 return $this->mPage
->getAutoDeleteReason( $hasHistory );
1954 // ****** B/C functions for static methods ( __callStatic is PHP>=5.3 ) ****** //
1955 public static function selectFields() {
1956 return WikiPage
::selectFields();
1959 public static function onArticleCreate( $title ) {
1960 return WikiPage
::onArticleCreate( $title );
1963 public static function onArticleDelete( $title ) {
1964 return WikiPage
::onArticleDelete( $title );
1967 public static function onArticleEdit( $title ) {
1968 return WikiPage
::onArticleEdit( $title );
1971 public static function getAutosummary( $oldtext, $newtext, $flags ) {
1972 return WikiPage
::getAutosummary( $oldtext, $newtext, $flags );
1977 class PoolWorkArticleView
extends PoolCounterWork
{
1984 function __construct( $article, $key, $useParserCache, $parserOptions ) {
1985 parent
::__construct( 'ArticleView', $key );
1986 $this->mArticle
= $article;
1987 $this->cacheable
= $useParserCache;
1988 $this->parserOptions
= $parserOptions;
1992 return $this->mArticle
->doViewParse();
1995 function getCachedWork() {
1998 $parserCache = ParserCache
::singleton();
1999 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
2001 if ( $this->mArticle
->mParserOutput
!== false ) {
2002 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
2003 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
2004 # Ensure that UI elements requiring revision ID have
2005 # the correct version information.
2006 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
2012 function fallback() {
2013 return $this->mArticle
->tryDirtyCache();
2017 * @param $status Status
2019 function error( $status ) {
2022 $wgOut->clearHTML(); // for release() errors
2023 $wgOut->enableClientCache( false );
2024 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2026 $errortext = $status->getWikiText( false, 'view-pool-error' );
2027 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );