Remove collateOnly() from ProfilerStandard and subclasses
[mediawiki.git] / includes / page / Article.php
blob54fab29a55d757c541c58d42751779b98a498655
1 <?php
2 /**
3 * User interface for page actions.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
23 /**
24 * Class for viewing MediaWiki article and history.
26 * This maintains WikiPage functions for backwards compatibility.
28 * @todo Move and rewrite code to an Action class
30 * See design.txt for an overview.
31 * Note: edit user interface and cache support functions have been
32 * moved to separate EditPage and HTMLFileCache classes.
34 * @internal documentation reviewed 15 Mar 2010
36 class Article implements Page {
37 /** @var IContextSource The context this Article is executed in */
38 protected $mContext;
40 /** @var WikiPage The WikiPage object of this instance */
41 protected $mPage;
43 /** @var ParserOptions ParserOptions object for $wgUser articles */
44 public $mParserOptions;
46 /**
47 * @var string Text of the revision we are working on
48 * @todo BC cruft
50 public $mContent;
52 /**
53 * @var Content Content of the revision we are working on
54 * @since 1.21
56 public $mContentObject;
58 /** @var bool Is the content ($mContent) already loaded? */
59 public $mContentLoaded = false;
61 /** @var int|null The oldid of the article that is to be shown, 0 for the current revision */
62 public $mOldId;
64 /** @var Title Title from which we were redirected here */
65 public $mRedirectedFrom = null;
67 /** @var string|bool URL to redirect to or false if none */
68 public $mRedirectUrl = false;
70 /** @var int Revision ID of revision we are working on */
71 public $mRevIdFetched = 0;
73 /** @var Revision Revision we are working on */
74 public $mRevision = null;
76 /** @var ParserOutput */
77 public $mParserOutput;
79 /**
80 * Constructor and clear the article
81 * @param Title $title Reference to a Title object.
82 * @param int $oldId Revision ID, null to fetch from request, zero for current
84 public function __construct( Title $title, $oldId = null ) {
85 $this->mOldId = $oldId;
86 $this->mPage = $this->newPage( $title );
89 /**
90 * @param Title $title
91 * @return WikiPage
93 protected function newPage( Title $title ) {
94 return new WikiPage( $title );
97 /**
98 * Constructor from a page id
99 * @param int $id Article ID to load
100 * @return Article|null
102 public static function newFromID( $id ) {
103 $t = Title::newFromID( $id );
104 # @todo FIXME: Doesn't inherit right
105 return $t == null ? null : new self( $t );
106 # return $t == null ? null : new static( $t ); // PHP 5.3
110 * Create an Article object of the appropriate class for the given page.
112 * @param Title $title
113 * @param IContextSource $context
114 * @return Article
116 public static function newFromTitle( $title, IContextSource $context ) {
117 if ( NS_MEDIA == $title->getNamespace() ) {
118 // FIXME: where should this go?
119 $title = Title::makeTitle( NS_FILE, $title->getDBkey() );
122 $page = null;
123 wfRunHooks( 'ArticleFromTitle', array( &$title, &$page, $context ) );
124 if ( !$page ) {
125 switch ( $title->getNamespace() ) {
126 case NS_FILE:
127 $page = new ImagePage( $title );
128 break;
129 case NS_CATEGORY:
130 $page = new CategoryPage( $title );
131 break;
132 default:
133 $page = new Article( $title );
136 $page->setContext( $context );
138 return $page;
142 * Create an Article object of the appropriate class for the given page.
144 * @param WikiPage $page
145 * @param IContextSource $context
146 * @return Article
148 public static function newFromWikiPage( WikiPage $page, IContextSource $context ) {
149 $article = self::newFromTitle( $page->getTitle(), $context );
150 $article->mPage = $page; // override to keep process cached vars
151 return $article;
155 * Tell the page view functions that this view was redirected
156 * from another page on the wiki.
157 * @param Title $from
159 public function setRedirectedFrom( Title $from ) {
160 $this->mRedirectedFrom = $from;
164 * Get the title object of the article
166 * @return Title Title object of this page
168 public function getTitle() {
169 return $this->mPage->getTitle();
173 * Get the WikiPage object of this instance
175 * @since 1.19
176 * @return WikiPage
178 public function getPage() {
179 return $this->mPage;
183 * Clear the object
185 public function clear() {
186 $this->mContentLoaded = false;
188 $this->mRedirectedFrom = null; # Title object if set
189 $this->mRevIdFetched = 0;
190 $this->mRedirectUrl = false;
192 $this->mPage->clear();
196 * Note that getContent/loadContent do not follow redirects anymore.
197 * If you need to fetch redirectable content easily, try
198 * the shortcut in WikiPage::getRedirectTarget()
200 * This function has side effects! Do not use this function if you
201 * only want the real revision text if any.
203 * @deprecated since 1.21; use WikiPage::getContent() instead
205 * @return string Return the text of this revision
207 public function getContent() {
208 ContentHandler::deprecated( __METHOD__, '1.21' );
209 $content = $this->getContentObject();
210 return ContentHandler::getContentText( $content );
214 * Returns a Content object representing the pages effective display content,
215 * not necessarily the revision's content!
217 * Note that getContent/loadContent do not follow redirects anymore.
218 * If you need to fetch redirectable content easily, try
219 * the shortcut in WikiPage::getRedirectTarget()
221 * This function has side effects! Do not use this function if you
222 * only want the real revision text if any.
224 * @return Content Return the content of this revision
226 * @since 1.21
228 protected function getContentObject() {
229 wfProfileIn( __METHOD__ );
231 if ( $this->mPage->getID() === 0 ) {
232 # If this is a MediaWiki:x message, then load the messages
233 # and return the message value for x.
234 if ( $this->getTitle()->getNamespace() == NS_MEDIAWIKI ) {
235 $text = $this->getTitle()->getDefaultMessageText();
236 if ( $text === false ) {
237 $text = '';
240 $content = ContentHandler::makeContent( $text, $this->getTitle() );
241 } else {
242 $message = $this->getContext()->getUser()->isLoggedIn() ? 'noarticletext' : 'noarticletextanon';
243 $content = new MessageContent( $message, null, 'parsemag' );
245 } else {
246 $this->fetchContentObject();
247 $content = $this->mContentObject;
250 wfProfileOut( __METHOD__ );
251 return $content;
255 * @return int The oldid of the article that is to be shown, 0 for the current revision
257 public function getOldID() {
258 if ( is_null( $this->mOldId ) ) {
259 $this->mOldId = $this->getOldIDFromRequest();
262 return $this->mOldId;
266 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
268 * @return int The old id for the request
270 public function getOldIDFromRequest() {
271 $this->mRedirectUrl = false;
273 $request = $this->getContext()->getRequest();
274 $oldid = $request->getIntOrNull( 'oldid' );
276 if ( $oldid === null ) {
277 return 0;
280 if ( $oldid !== 0 ) {
281 # Load the given revision and check whether the page is another one.
282 # In that case, update this instance to reflect the change.
283 if ( $oldid === $this->mPage->getLatest() ) {
284 $this->mRevision = $this->mPage->getRevision();
285 } else {
286 $this->mRevision = Revision::newFromId( $oldid );
287 if ( $this->mRevision !== null ) {
288 // Revision title doesn't match the page title given?
289 if ( $this->mPage->getID() != $this->mRevision->getPage() ) {
290 $function = array( get_class( $this->mPage ), 'newFromID' );
291 $this->mPage = call_user_func( $function, $this->mRevision->getPage() );
297 if ( $request->getVal( 'direction' ) == 'next' ) {
298 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
299 if ( $nextid ) {
300 $oldid = $nextid;
301 $this->mRevision = null;
302 } else {
303 $this->mRedirectUrl = $this->getTitle()->getFullURL( 'redirect=no' );
305 } elseif ( $request->getVal( 'direction' ) == 'prev' ) {
306 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
307 if ( $previd ) {
308 $oldid = $previd;
309 $this->mRevision = null;
313 return $oldid;
317 * Load the revision (including text) into this object
319 * @deprecated since 1.19; use fetchContent()
321 function loadContent() {
322 wfDeprecated( __METHOD__, '1.19' );
323 $this->fetchContent();
327 * Get text of an article from database
328 * Does *NOT* follow redirects.
330 * @protected
331 * @note This is really internal functionality that should really NOT be
332 * used by other functions. For accessing article content, use the WikiPage
333 * class, especially WikiBase::getContent(). However, a lot of legacy code
334 * uses this method to retrieve page text from the database, so the function
335 * has to remain public for now.
337 * @return string|bool String containing article contents, or false if null
338 * @deprecated since 1.21, use WikiPage::getContent() instead
340 function fetchContent() { #BC cruft!
341 ContentHandler::deprecated( __METHOD__, '1.21' );
343 if ( $this->mContentLoaded && $this->mContent ) {
344 return $this->mContent;
347 wfProfileIn( __METHOD__ );
349 $content = $this->fetchContentObject();
351 if ( !$content ) {
352 wfProfileOut( __METHOD__ );
353 return false;
356 // @todo Get rid of mContent everywhere!
357 $this->mContent = ContentHandler::getContentText( $content );
358 ContentHandler::runLegacyHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent ) );
360 wfProfileOut( __METHOD__ );
362 return $this->mContent;
366 * Get text content object
367 * Does *NOT* follow redirects.
368 * @todo When is this null?
370 * @note Code that wants to retrieve page content from the database should
371 * use WikiPage::getContent().
373 * @return Content|null|bool
375 * @since 1.21
377 protected function fetchContentObject() {
378 if ( $this->mContentLoaded ) {
379 return $this->mContentObject;
382 wfProfileIn( __METHOD__ );
384 $this->mContentLoaded = true;
385 $this->mContent = null;
387 $oldid = $this->getOldID();
389 # Pre-fill content with error message so that if something
390 # fails we'll have something telling us what we intended.
391 //XXX: this isn't page content but a UI message. horrible.
392 $this->mContentObject = new MessageContent( 'missing-revision', array( $oldid ), array() );
394 if ( $oldid ) {
395 # $this->mRevision might already be fetched by getOldIDFromRequest()
396 if ( !$this->mRevision ) {
397 $this->mRevision = Revision::newFromId( $oldid );
398 if ( !$this->mRevision ) {
399 wfDebug( __METHOD__ . " failed to retrieve specified revision, id $oldid\n" );
400 wfProfileOut( __METHOD__ );
401 return false;
404 } else {
405 if ( !$this->mPage->getLatest() ) {
406 wfDebug( __METHOD__ . " failed to find page data for title " .
407 $this->getTitle()->getPrefixedText() . "\n" );
408 wfProfileOut( __METHOD__ );
409 return false;
412 $this->mRevision = $this->mPage->getRevision();
414 if ( !$this->mRevision ) {
415 wfDebug( __METHOD__ . " failed to retrieve current page, rev_id " .
416 $this->mPage->getLatest() . "\n" );
417 wfProfileOut( __METHOD__ );
418 return false;
422 // @todo FIXME: Horrible, horrible! This content-loading interface just plain sucks.
423 // We should instead work with the Revision object when we need it...
424 // Loads if user is allowed
425 $this->mContentObject = $this->mRevision->getContent(
426 Revision::FOR_THIS_USER,
427 $this->getContext()->getUser()
429 $this->mRevIdFetched = $this->mRevision->getId();
431 wfRunHooks( 'ArticleAfterFetchContentObject', array( &$this, &$this->mContentObject ) );
433 wfProfileOut( __METHOD__ );
435 return $this->mContentObject;
439 * Returns true if the currently-referenced revision is the current edit
440 * to this page (and it exists).
441 * @return bool
443 public function isCurrent() {
444 # If no oldid, this is the current version.
445 if ( $this->getOldID() == 0 ) {
446 return true;
449 return $this->mPage->exists() && $this->mRevision && $this->mRevision->isCurrent();
453 * Get the fetched Revision object depending on request parameters or null
454 * on failure.
456 * @since 1.19
457 * @return Revision|null
459 public function getRevisionFetched() {
460 $this->fetchContentObject();
462 return $this->mRevision;
466 * Use this to fetch the rev ID used on page views
468 * @return int Revision ID of last article revision
470 public function getRevIdFetched() {
471 if ( $this->mRevIdFetched ) {
472 return $this->mRevIdFetched;
473 } else {
474 return $this->mPage->getLatest();
479 * This is the default action of the index.php entry point: just view the
480 * page of the given title.
482 public function view() {
483 global $wgUseFileCache, $wgUseETag, $wgDebugToolbar, $wgMaxRedirects;
485 wfProfileIn( __METHOD__ );
487 # Get variables from query string
488 # As side effect this will load the revision and update the title
489 # in a revision ID is passed in the request, so this should remain
490 # the first call of this method even if $oldid is used way below.
491 $oldid = $this->getOldID();
493 $user = $this->getContext()->getUser();
494 # Another whitelist check in case getOldID() is altering the title
495 $permErrors = $this->getTitle()->getUserPermissionsErrors( 'read', $user );
496 if ( count( $permErrors ) ) {
497 wfDebug( __METHOD__ . ": denied on secondary read check\n" );
498 wfProfileOut( __METHOD__ );
499 throw new PermissionsError( 'read', $permErrors );
502 $outputPage = $this->getContext()->getOutput();
503 # getOldID() may as well want us to redirect somewhere else
504 if ( $this->mRedirectUrl ) {
505 $outputPage->redirect( $this->mRedirectUrl );
506 wfDebug( __METHOD__ . ": redirecting due to oldid\n" );
507 wfProfileOut( __METHOD__ );
509 return;
512 # If we got diff in the query, we want to see a diff page instead of the article.
513 if ( $this->getContext()->getRequest()->getCheck( 'diff' ) ) {
514 wfDebug( __METHOD__ . ": showing diff page\n" );
515 $this->showDiffPage();
516 wfProfileOut( __METHOD__ );
518 return;
521 # Set page title (may be overridden by DISPLAYTITLE)
522 $outputPage->setPageTitle( $this->getTitle()->getPrefixedText() );
524 $outputPage->setArticleFlag( true );
525 # Allow frames by default
526 $outputPage->allowClickjacking();
528 $parserCache = ParserCache::singleton();
530 $parserOptions = $this->getParserOptions();
531 # Render printable version, use printable version cache
532 if ( $outputPage->isPrintable() ) {
533 $parserOptions->setIsPrintable( true );
534 $parserOptions->setEditSection( false );
535 } elseif ( !$this->isCurrent() || !$this->getTitle()->quickUserCan( 'edit', $user ) ) {
536 $parserOptions->setEditSection( false );
539 # Try client and file cache
540 if ( !$wgDebugToolbar && $oldid === 0 && $this->mPage->checkTouched() ) {
541 if ( $wgUseETag ) {
542 $outputPage->setETag( $parserCache->getETag( $this, $parserOptions ) );
545 # Use the greatest of the page's timestamp or the timestamp of any
546 # redirect in the chain (bug 67849)
547 $timestamp = $this->mPage->getTouched();
548 if ( isset( $this->mRedirectedFrom ) ) {
549 $timestamp = max( $timestamp, $this->mRedirectedFrom->getTouched() );
551 # If there can be more than one redirect in the chain, we have
552 # to go through the whole chain too in case an intermediate
553 # redirect was changed.
554 if ( $wgMaxRedirects > 1 ) {
555 $titles = Revision::newFromTitle( $this->mRedirectedFrom )
556 ->getContent( Revision::FOR_THIS_USER, $user )
557 ->getRedirectChain();
558 $thisTitle = $this->getTitle();
559 foreach ( $titles as $title ) {
560 if ( Title::compare( $title, $thisTitle ) === 0 ) {
561 break;
563 $timestamp = max( $timestamp, $title->getTouched() );
568 # Is it client cached?
569 if ( $outputPage->checkLastModified( $timestamp ) ) {
570 wfDebug( __METHOD__ . ": done 304\n" );
571 wfProfileOut( __METHOD__ );
573 return;
574 # Try file cache
575 } elseif ( $wgUseFileCache && $this->tryFileCache() ) {
576 wfDebug( __METHOD__ . ": done file cache\n" );
577 # tell wgOut that output is taken care of
578 $outputPage->disable();
579 $this->mPage->doViewUpdates( $user, $oldid );
580 wfProfileOut( __METHOD__ );
582 return;
586 # Should the parser cache be used?
587 $useParserCache = $this->mPage->isParserCacheUsed( $parserOptions, $oldid );
588 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
589 if ( $user->getStubThreshold() ) {
590 wfIncrStats( 'pcache_miss_stub' );
593 $this->showRedirectedFromHeader();
594 $this->showNamespaceHeader();
596 # Iterate through the possible ways of constructing the output text.
597 # Keep going until $outputDone is set, or we run out of things to do.
598 $pass = 0;
599 $outputDone = false;
600 $this->mParserOutput = false;
602 while ( !$outputDone && ++$pass ) {
603 switch ( $pass ) {
604 case 1:
605 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
606 break;
607 case 2:
608 # Early abort if the page doesn't exist
609 if ( !$this->mPage->exists() ) {
610 wfDebug( __METHOD__ . ": showing missing article\n" );
611 $this->showMissingArticle();
612 $this->mPage->doViewUpdates( $user );
613 wfProfileOut( __METHOD__ );
614 return;
617 # Try the parser cache
618 if ( $useParserCache ) {
619 $this->mParserOutput = $parserCache->get( $this, $parserOptions );
621 if ( $this->mParserOutput !== false ) {
622 if ( $oldid ) {
623 wfDebug( __METHOD__ . ": showing parser cache contents for current rev permalink\n" );
624 $this->setOldSubtitle( $oldid );
625 } else {
626 wfDebug( __METHOD__ . ": showing parser cache contents\n" );
628 $outputPage->addParserOutput( $this->mParserOutput );
629 # Ensure that UI elements requiring revision ID have
630 # the correct version information.
631 $outputPage->setRevisionId( $this->mPage->getLatest() );
632 # Preload timestamp to avoid a DB hit
633 $cachedTimestamp = $this->mParserOutput->getTimestamp();
634 if ( $cachedTimestamp !== null ) {
635 $outputPage->setRevisionTimestamp( $cachedTimestamp );
636 $this->mPage->setTimestamp( $cachedTimestamp );
638 $outputDone = true;
641 break;
642 case 3:
643 # This will set $this->mRevision if needed
644 $this->fetchContentObject();
646 # Are we looking at an old revision
647 if ( $oldid && $this->mRevision ) {
648 $this->setOldSubtitle( $oldid );
650 if ( !$this->showDeletedRevisionHeader() ) {
651 wfDebug( __METHOD__ . ": cannot view deleted revision\n" );
652 wfProfileOut( __METHOD__ );
653 return;
657 # Ensure that UI elements requiring revision ID have
658 # the correct version information.
659 $outputPage->setRevisionId( $this->getRevIdFetched() );
660 # Preload timestamp to avoid a DB hit
661 $outputPage->setRevisionTimestamp( $this->getTimestamp() );
663 # Pages containing custom CSS or JavaScript get special treatment
664 if ( $this->getTitle()->isCssOrJsPage() || $this->getTitle()->isCssJsSubpage() ) {
665 wfDebug( __METHOD__ . ": showing CSS/JS source\n" );
666 $this->showCssOrJsPage();
667 $outputDone = true;
668 } elseif ( !wfRunHooks( 'ArticleContentViewCustom',
669 array( $this->fetchContentObject(), $this->getTitle(), $outputPage ) ) ) {
671 # Allow extensions do their own custom view for certain pages
672 $outputDone = true;
673 } elseif ( !ContentHandler::runLegacyHooks( 'ArticleViewCustom',
674 array( $this->fetchContentObject(), $this->getTitle(), $outputPage ) ) ) {
676 # Allow extensions do their own custom view for certain pages
677 $outputDone = true;
679 break;
680 case 4:
681 # Run the parse, protected by a pool counter
682 wfDebug( __METHOD__ . ": doing uncached parse\n" );
684 $content = $this->getContentObject();
685 $poolArticleView = new PoolWorkArticleView( $this->getPage(), $parserOptions,
686 $this->getRevIdFetched(), $useParserCache, $content );
688 if ( !$poolArticleView->execute() ) {
689 $error = $poolArticleView->getError();
690 if ( $error ) {
691 $outputPage->clearHTML(); // for release() errors
692 $outputPage->enableClientCache( false );
693 $outputPage->setRobotPolicy( 'noindex,nofollow' );
695 $errortext = $error->getWikiText( false, 'view-pool-error' );
696 $outputPage->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );
698 # Connection or timeout error
699 wfProfileOut( __METHOD__ );
700 return;
703 $this->mParserOutput = $poolArticleView->getParserOutput();
704 $outputPage->addParserOutput( $this->mParserOutput );
705 if ( $content->getRedirectTarget() ) {
706 $outputPage->addSubtitle(
707 "<span id=\"redirectsub\">" . wfMessage( 'redirectpagesub' )->parse() . "</span>"
711 # Don't cache a dirty ParserOutput object
712 if ( $poolArticleView->getIsDirty() ) {
713 $outputPage->setSquidMaxage( 0 );
714 $outputPage->addHTML( "<!-- parser cache is expired, " .
715 "sending anyway due to pool overload-->\n" );
718 $outputDone = true;
719 break;
720 # Should be unreachable, but just in case...
721 default:
722 break 2;
726 # Get the ParserOutput actually *displayed* here.
727 # Note that $this->mParserOutput is the *current* version output.
728 $pOutput = ( $outputDone instanceof ParserOutput )
729 ? $outputDone // object fetched by hook
730 : $this->mParserOutput;
732 # Adjust title for main page & pages with displaytitle
733 if ( $pOutput ) {
734 $this->adjustDisplayTitle( $pOutput );
737 # For the main page, overwrite the <title> element with the con-
738 # tents of 'pagetitle-view-mainpage' instead of the default (if
739 # that's not empty).
740 # This message always exists because it is in the i18n files
741 if ( $this->getTitle()->isMainPage() ) {
742 $msg = wfMessage( 'pagetitle-view-mainpage' )->inContentLanguage();
743 if ( !$msg->isDisabled() ) {
744 $outputPage->setHTMLTitle( $msg->title( $this->getTitle() )->text() );
748 # Check for any __NOINDEX__ tags on the page using $pOutput
749 $policy = $this->getRobotPolicy( 'view', $pOutput );
750 $outputPage->setIndexPolicy( $policy['index'] );
751 $outputPage->setFollowPolicy( $policy['follow'] );
753 $this->showViewFooter();
754 $this->mPage->doViewUpdates( $user, $oldid );
756 $outputPage->addModules( 'mediawiki.action.view.postEdit' );
758 wfProfileOut( __METHOD__ );
762 * Adjust title for pages with displaytitle, -{T|}- or language conversion
763 * @param ParserOutput $pOutput
765 public function adjustDisplayTitle( ParserOutput $pOutput ) {
766 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
767 $titleText = $pOutput->getTitleText();
768 if ( strval( $titleText ) !== '' ) {
769 $this->getContext()->getOutput()->setPageTitle( $titleText );
774 * Show a diff page according to current request variables. For use within
775 * Article::view() only, other callers should use the DifferenceEngine class.
777 * @todo Make protected
779 public function showDiffPage() {
780 $request = $this->getContext()->getRequest();
781 $user = $this->getContext()->getUser();
782 $diff = $request->getVal( 'diff' );
783 $rcid = $request->getVal( 'rcid' );
784 $diffOnly = $request->getBool( 'diffonly', $user->getOption( 'diffonly' ) );
785 $purge = $request->getVal( 'action' ) == 'purge';
786 $unhide = $request->getInt( 'unhide' ) == 1;
787 $oldid = $this->getOldID();
789 $rev = $this->getRevisionFetched();
791 if ( !$rev ) {
792 $this->getContext()->getOutput()->setPageTitle( wfMessage( 'errorpagetitle' ) );
793 $msg = $this->getContext()->msg( 'difference-missing-revision' )
794 ->params( $oldid )
795 ->numParams( 1 )
796 ->parseAsBlock();
797 $this->getContext()->getOutput()->addHtml( $msg );
798 return;
801 $contentHandler = $rev->getContentHandler();
802 $de = $contentHandler->createDifferenceEngine(
803 $this->getContext(),
804 $oldid,
805 $diff,
806 $rcid,
807 $purge,
808 $unhide
811 // DifferenceEngine directly fetched the revision:
812 $this->mRevIdFetched = $de->mNewid;
813 $de->showDiffPage( $diffOnly );
815 // Run view updates for the newer revision being diffed (and shown
816 // below the diff if not $diffOnly).
817 list( $old, $new ) = $de->mapDiffPrevNext( $oldid, $diff );
818 // New can be false, convert it to 0 - this conveniently means the latest revision
819 $this->mPage->doViewUpdates( $user, (int)$new );
823 * Show a page view for a page formatted as CSS or JavaScript. To be called by
824 * Article::view() only.
826 * This exists mostly to serve the deprecated ShowRawCssJs hook (used to customize these views).
827 * It has been replaced by the ContentGetParserOutput hook, which lets you do the same but with
828 * more flexibility.
830 * @param bool $showCacheHint Whether to show a message telling the user
831 * to clear the browser cache (default: true).
833 protected function showCssOrJsPage( $showCacheHint = true ) {
834 $outputPage = $this->getContext()->getOutput();
836 if ( $showCacheHint ) {
837 $dir = $this->getContext()->getLanguage()->getDir();
838 $lang = $this->getContext()->getLanguage()->getCode();
840 $outputPage->wrapWikiMsg(
841 "<div id='mw-clearyourcache' lang='$lang' dir='$dir' class='mw-content-$dir'>\n$1\n</div>",
842 'clearyourcache'
846 $this->fetchContentObject();
848 if ( $this->mContentObject ) {
849 // Give hooks a chance to customise the output
850 if ( ContentHandler::runLegacyHooks(
851 'ShowRawCssJs',
852 array( $this->mContentObject, $this->getTitle(), $outputPage ) )
854 // If no legacy hooks ran, display the content of the parser output, including RL modules,
855 // but excluding metadata like categories and language links
856 $po = $this->mContentObject->getParserOutput( $this->getTitle() );
857 $outputPage->addParserOutputContent( $po );
863 * Get the robot policy to be used for the current view
864 * @param string $action The action= GET parameter
865 * @param ParserOutput|null $pOutput
866 * @return array The policy that should be set
867 * @todo actions other than 'view'
869 public function getRobotPolicy( $action, $pOutput = null ) {
870 global $wgArticleRobotPolicies, $wgNamespaceRobotPolicies, $wgDefaultRobotPolicy;
872 $ns = $this->getTitle()->getNamespace();
874 # Don't index user and user talk pages for blocked users (bug 11443)
875 if ( ( $ns == NS_USER || $ns == NS_USER_TALK ) && !$this->getTitle()->isSubpage() ) {
876 $specificTarget = null;
877 $vagueTarget = null;
878 $titleText = $this->getTitle()->getText();
879 if ( IP::isValid( $titleText ) ) {
880 $vagueTarget = $titleText;
881 } else {
882 $specificTarget = $titleText;
884 if ( Block::newFromTarget( $specificTarget, $vagueTarget ) instanceof Block ) {
885 return array(
886 'index' => 'noindex',
887 'follow' => 'nofollow'
892 if ( $this->mPage->getID() === 0 || $this->getOldID() ) {
893 # Non-articles (special pages etc), and old revisions
894 return array(
895 'index' => 'noindex',
896 'follow' => 'nofollow'
898 } elseif ( $this->getContext()->getOutput()->isPrintable() ) {
899 # Discourage indexing of printable versions, but encourage following
900 return array(
901 'index' => 'noindex',
902 'follow' => 'follow'
904 } elseif ( $this->getContext()->getRequest()->getInt( 'curid' ) ) {
905 # For ?curid=x urls, disallow indexing
906 return array(
907 'index' => 'noindex',
908 'follow' => 'follow'
912 # Otherwise, construct the policy based on the various config variables.
913 $policy = self::formatRobotPolicy( $wgDefaultRobotPolicy );
915 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
916 # Honour customised robot policies for this namespace
917 $policy = array_merge(
918 $policy,
919 self::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
922 if ( $this->getTitle()->canUseNoindex() && is_object( $pOutput ) && $pOutput->getIndexPolicy() ) {
923 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
924 # a final sanity check that we have really got the parser output.
925 $policy = array_merge(
926 $policy,
927 array( 'index' => $pOutput->getIndexPolicy() )
931 if ( isset( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] ) ) {
932 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
933 $policy = array_merge(
934 $policy,
935 self::formatRobotPolicy( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] )
939 return $policy;
943 * Converts a String robot policy into an associative array, to allow
944 * merging of several policies using array_merge().
945 * @param array|string $policy Returns empty array on null/false/'', transparent
946 * to already-converted arrays, converts string.
947 * @return array 'index' => \<indexpolicy\>, 'follow' => \<followpolicy\>
949 public static function formatRobotPolicy( $policy ) {
950 if ( is_array( $policy ) ) {
951 return $policy;
952 } elseif ( !$policy ) {
953 return array();
956 $policy = explode( ',', $policy );
957 $policy = array_map( 'trim', $policy );
959 $arr = array();
960 foreach ( $policy as $var ) {
961 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
962 $arr['index'] = $var;
963 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
964 $arr['follow'] = $var;
968 return $arr;
972 * If this request is a redirect view, send "redirected from" subtitle to
973 * the output. Returns true if the header was needed, false if this is not
974 * a redirect view. Handles both local and remote redirects.
976 * @return bool
978 public function showRedirectedFromHeader() {
979 global $wgRedirectSources;
980 $outputPage = $this->getContext()->getOutput();
982 $request = $this->getContext()->getRequest();
983 $rdfrom = $request->getVal( 'rdfrom' );
985 // Construct a URL for the current page view, but with the target title
986 $query = $request->getValues();
987 unset( $query['rdfrom'] );
988 unset( $query['title'] );
989 if ( $this->getTitle()->isRedirect() ) {
990 // Prevent double redirects
991 $query['redirect'] = 'no';
993 $redirectTargetUrl = $this->getTitle()->getLinkURL( $query );
995 if ( isset( $this->mRedirectedFrom ) ) {
996 // This is an internally redirected page view.
997 // We'll need a backlink to the source page for navigation.
998 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
999 $redir = Linker::linkKnown(
1000 $this->mRedirectedFrom,
1001 null,
1002 array(),
1003 array( 'redirect' => 'no' )
1006 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
1008 // Add the script to update the displayed URL and
1009 // set the fragment if one was specified in the redirect
1010 $outputPage->addJsConfigVars( array(
1011 'wgInternalRedirectTargetUrl' => $redirectTargetUrl,
1012 ) );
1013 $outputPage->addModules( 'mediawiki.action.view.redirect' );
1015 // Add a <link rel="canonical"> tag
1016 $outputPage->setCanonicalUrl( $this->getTitle()->getLocalURL() );
1018 // Tell the output object that the user arrived at this article through a redirect
1019 $outputPage->setRedirectedFrom( $this->mRedirectedFrom );
1021 return true;
1023 } elseif ( $rdfrom ) {
1024 // This is an externally redirected view, from some other wiki.
1025 // If it was reported from a trusted site, supply a backlink.
1026 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1027 $redir = Linker::makeExternalLink( $rdfrom, $rdfrom );
1028 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
1030 // Add the script to update the displayed URL
1031 $outputPage->addJsConfigVars( array(
1032 'wgInternalRedirectTargetUrl' => $redirectTargetUrl,
1033 ) );
1034 $outputPage->addModules( 'mediawiki.action.view.redirect' );
1036 return true;
1040 return false;
1044 * Show a header specific to the namespace currently being viewed, like
1045 * [[MediaWiki:Talkpagetext]]. For Article::view().
1047 public function showNamespaceHeader() {
1048 if ( $this->getTitle()->isTalkPage() ) {
1049 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1050 $this->getContext()->getOutput()->wrapWikiMsg(
1051 "<div class=\"mw-talkpageheader\">\n$1\n</div>",
1052 array( 'talkpageheader' )
1059 * Show the footer section of an ordinary page view
1061 public function showViewFooter() {
1062 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1063 if ( $this->getTitle()->getNamespace() == NS_USER_TALK
1064 && IP::isValid( $this->getTitle()->getText() )
1066 $this->getContext()->getOutput()->addWikiMsg( 'anontalkpagetext' );
1069 // Show a footer allowing the user to patrol the shown revision or page if possible
1070 $patrolFooterShown = $this->showPatrolFooter();
1072 wfRunHooks( 'ArticleViewFooter', array( $this, $patrolFooterShown ) );
1076 * If patrol is possible, output a patrol UI box. This is called from the
1077 * footer section of ordinary page views. If patrol is not possible or not
1078 * desired, does nothing.
1079 * Side effect: When the patrol link is build, this method will call
1080 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
1082 * @return bool
1084 public function showPatrolFooter() {
1085 global $wgUseNPPatrol, $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
1087 $outputPage = $this->getContext()->getOutput();
1088 $user = $this->getContext()->getUser();
1089 $cache = wfGetMainCache();
1090 $rc = false;
1092 if ( !$this->getTitle()->quickUserCan( 'patrol', $user )
1093 || !( $wgUseRCPatrol || $wgUseNPPatrol )
1095 // Patrolling is disabled or the user isn't allowed to
1096 return false;
1099 wfProfileIn( __METHOD__ );
1101 // New page patrol: Get the timestamp of the oldest revison which
1102 // the revision table holds for the given page. Then we look
1103 // whether it's within the RC lifespan and if it is, we try
1104 // to get the recentchanges row belonging to that entry
1105 // (with rc_new = 1).
1107 // Check for cached results
1108 if ( $cache->get( wfMemcKey( 'NotPatrollablePage', $this->getTitle()->getArticleID() ) ) ) {
1109 wfProfileOut( __METHOD__ );
1110 return false;
1113 if ( $this->mRevision
1114 && !RecentChange::isInRCLifespan( $this->mRevision->getTimestamp(), 21600 )
1116 // The current revision is already older than what could be in the RC table
1117 // 6h tolerance because the RC might not be cleaned out regularly
1118 wfProfileOut( __METHOD__ );
1119 return false;
1122 $dbr = wfGetDB( DB_SLAVE );
1123 $oldestRevisionTimestamp = $dbr->selectField(
1124 'revision',
1125 'MIN( rev_timestamp )',
1126 array( 'rev_page' => $this->getTitle()->getArticleID() ),
1127 __METHOD__
1130 if ( $oldestRevisionTimestamp
1131 && RecentChange::isInRCLifespan( $oldestRevisionTimestamp, 21600 )
1133 // 6h tolerance because the RC might not be cleaned out regularly
1134 $rc = RecentChange::newFromConds(
1135 array(
1136 'rc_new' => 1,
1137 'rc_timestamp' => $oldestRevisionTimestamp,
1138 'rc_namespace' => $this->getTitle()->getNamespace(),
1139 'rc_cur_id' => $this->getTitle()->getArticleID(),
1140 'rc_patrolled' => 0
1142 __METHOD__,
1143 array( 'USE INDEX' => 'new_name_timestamp' )
1147 if ( !$rc ) {
1148 // No RC entry around
1150 // Cache the information we gathered above in case we can't patrol
1151 // Don't cache in case we can patrol as this could change
1152 $cache->set( wfMemcKey( 'NotPatrollablePage', $this->getTitle()->getArticleID() ), '1' );
1154 wfProfileOut( __METHOD__ );
1155 return false;
1158 if ( $rc->getPerformer()->getName() == $user->getName() ) {
1159 // Don't show a patrol link for own creations. If the user could
1160 // patrol them, they already would be patrolled
1161 wfProfileOut( __METHOD__ );
1162 return false;
1165 $rcid = $rc->getAttribute( 'rc_id' );
1167 $token = $user->getEditToken( $rcid );
1169 $outputPage->preventClickjacking();
1170 if ( $wgEnableAPI && $wgEnableWriteAPI && $user->isAllowed( 'writeapi' ) ) {
1171 $outputPage->addModules( 'mediawiki.page.patrol.ajax' );
1174 $link = Linker::linkKnown(
1175 $this->getTitle(),
1176 wfMessage( 'markaspatrolledtext' )->escaped(),
1177 array(),
1178 array(
1179 'action' => 'markpatrolled',
1180 'rcid' => $rcid,
1181 'token' => $token,
1185 $outputPage->addHTML(
1186 "<div class='patrollink'>" .
1187 wfMessage( 'markaspatrolledlink' )->rawParams( $link )->escaped() .
1188 '</div>'
1191 wfProfileOut( __METHOD__ );
1192 return true;
1196 * Show the error text for a missing article. For articles in the MediaWiki
1197 * namespace, show the default message text. To be called from Article::view().
1199 public function showMissingArticle() {
1200 global $wgSend404Code;
1202 $outputPage = $this->getContext()->getOutput();
1203 // Whether the page is a root user page of an existing user (but not a subpage)
1204 $validUserPage = false;
1206 $title = $this->getTitle();
1208 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1209 if ( $title->getNamespace() == NS_USER
1210 || $title->getNamespace() == NS_USER_TALK
1212 $parts = explode( '/', $title->getText() );
1213 $rootPart = $parts[0];
1214 $user = User::newFromName( $rootPart, false /* allow IP users*/ );
1215 $ip = User::isIP( $rootPart );
1216 $block = Block::newFromTarget( $user, $user );
1218 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
1219 $outputPage->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1220 array( 'userpage-userdoesnotexist-view', wfEscapeWikiText( $rootPart ) ) );
1221 } elseif ( !is_null( $block ) && $block->getType() != Block::TYPE_AUTO ) {
1222 # Show log extract if the user is currently blocked
1223 LogEventsList::showLogExtract(
1224 $outputPage,
1225 'block',
1226 MWNamespace::getCanonicalName( NS_USER ) . ':' . $block->getTarget(),
1228 array(
1229 'lim' => 1,
1230 'showIfEmpty' => false,
1231 'msgKey' => array(
1232 'blocked-notice-logextract',
1233 $user->getName() # Support GENDER in notice
1237 $validUserPage = !$title->isSubpage();
1238 } else {
1239 $validUserPage = !$title->isSubpage();
1243 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1245 // Give extensions a chance to hide their (unrelated) log entries
1246 $logTypes = array( 'delete', 'move' );
1247 $conds = array( "log_action != 'revision'" );
1248 wfRunHooks( 'Article::MissingArticleConditions', array( &$conds, $logTypes ) );
1250 # Show delete and move logs
1251 $member = $title->getNamespace() . ':' . $title->getDBkey();
1252 // @todo: move optimization to showLogExtract()?
1253 if ( BloomCache::get( 'main' )->check( wfWikiId(), 'TitleHasLogs', $member ) ) {
1254 LogEventsList::showLogExtract( $outputPage, $logTypes, $title, '',
1255 array( 'lim' => 10,
1256 'conds' => $conds,
1257 'showIfEmpty' => false,
1258 'msgKey' => array( 'moveddeleted-notice' ) )
1262 if ( !$this->mPage->hasViewableContent() && $wgSend404Code && !$validUserPage ) {
1263 // If there's no backing content, send a 404 Not Found
1264 // for better machine handling of broken links.
1265 $this->getContext()->getRequest()->response()->header( "HTTP/1.1 404 Not Found" );
1268 // Also apply the robot policy for nonexisting pages (even if a 404 was used for sanity)
1269 $policy = $this->getRobotPolicy( 'view' );
1270 $outputPage->setIndexPolicy( $policy['index'] );
1271 $outputPage->setFollowPolicy( $policy['follow'] );
1273 $hookResult = wfRunHooks( 'BeforeDisplayNoArticleText', array( $this ) );
1275 if ( !$hookResult ) {
1276 return;
1279 # Show error message
1280 $oldid = $this->getOldID();
1281 if ( $oldid ) {
1282 $text = wfMessage( 'missing-revision', $oldid )->plain();
1283 } elseif ( $title->getNamespace() === NS_MEDIAWIKI ) {
1284 // Use the default message text
1285 $text = $title->getDefaultMessageText();
1286 } elseif ( $title->quickUserCan( 'create', $this->getContext()->getUser() )
1287 && $title->quickUserCan( 'edit', $this->getContext()->getUser() )
1289 $message = $this->getContext()->getUser()->isLoggedIn() ? 'noarticletext' : 'noarticletextanon';
1290 $text = wfMessage( $message )->plain();
1291 } else {
1292 $text = wfMessage( 'noarticletext-nopermission' )->plain();
1294 $text = "<div class='noarticletext'>\n$text\n</div>";
1296 $outputPage->addWikiText( $text );
1300 * If the revision requested for view is deleted, check permissions.
1301 * Send either an error message or a warning header to the output.
1303 * @return bool True if the view is allowed, false if not.
1305 public function showDeletedRevisionHeader() {
1306 if ( !$this->mRevision->isDeleted( Revision::DELETED_TEXT ) ) {
1307 // Not deleted
1308 return true;
1311 $outputPage = $this->getContext()->getOutput();
1312 $user = $this->getContext()->getUser();
1313 // If the user is not allowed to see it...
1314 if ( !$this->mRevision->userCan( Revision::DELETED_TEXT, $user ) ) {
1315 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1316 'rev-deleted-text-permission' );
1318 return false;
1319 // If the user needs to confirm that they want to see it...
1320 } elseif ( $this->getContext()->getRequest()->getInt( 'unhide' ) != 1 ) {
1321 # Give explanation and add a link to view the revision...
1322 $oldid = intval( $this->getOldID() );
1323 $link = $this->getTitle()->getFullURL( "oldid={$oldid}&unhide=1" );
1324 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1325 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1326 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1327 array( $msg, $link ) );
1329 return false;
1330 // We are allowed to see...
1331 } else {
1332 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1333 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1334 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1336 return true;
1341 * Generate the navigation links when browsing through an article revisions
1342 * It shows the information as:
1343 * Revision as of \<date\>; view current revision
1344 * \<- Previous version | Next Version -\>
1346 * @param int $oldid Revision ID of this article revision
1348 public function setOldSubtitle( $oldid = 0 ) {
1349 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
1350 return;
1353 $unhide = $this->getContext()->getRequest()->getInt( 'unhide' ) == 1;
1355 # Cascade unhide param in links for easy deletion browsing
1356 $extraParams = array();
1357 if ( $unhide ) {
1358 $extraParams['unhide'] = 1;
1361 if ( $this->mRevision && $this->mRevision->getId() === $oldid ) {
1362 $revision = $this->mRevision;
1363 } else {
1364 $revision = Revision::newFromId( $oldid );
1367 $timestamp = $revision->getTimestamp();
1369 $current = ( $oldid == $this->mPage->getLatest() );
1370 $language = $this->getContext()->getLanguage();
1371 $user = $this->getContext()->getUser();
1373 $td = $language->userTimeAndDate( $timestamp, $user );
1374 $tddate = $language->userDate( $timestamp, $user );
1375 $tdtime = $language->userTime( $timestamp, $user );
1377 # Show user links if allowed to see them. If hidden, then show them only if requested...
1378 $userlinks = Linker::revUserTools( $revision, !$unhide );
1380 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
1381 ? 'revision-info-current'
1382 : 'revision-info';
1384 $outputPage = $this->getContext()->getOutput();
1385 $outputPage->addSubtitle( "<div id=\"mw-{$infomsg}\">" .
1386 wfMessage( $infomsg, $td )
1387 ->rawParams( $userlinks )
1388 ->params( $revision->getID(), $tddate, $tdtime, $revision->getUserText() )
1389 ->rawParams( Linker::revComment( $revision, true, true ) )
1390 ->parse() .
1391 "</div>"
1394 $lnk = $current
1395 ? wfMessage( 'currentrevisionlink' )->escaped()
1396 : Linker::linkKnown(
1397 $this->getTitle(),
1398 wfMessage( 'currentrevisionlink' )->escaped(),
1399 array(),
1400 $extraParams
1402 $curdiff = $current
1403 ? wfMessage( 'diff' )->escaped()
1404 : Linker::linkKnown(
1405 $this->getTitle(),
1406 wfMessage( 'diff' )->escaped(),
1407 array(),
1408 array(
1409 'diff' => 'cur',
1410 'oldid' => $oldid
1411 ) + $extraParams
1413 $prev = $this->getTitle()->getPreviousRevisionID( $oldid );
1414 $prevlink = $prev
1415 ? Linker::linkKnown(
1416 $this->getTitle(),
1417 wfMessage( 'previousrevision' )->escaped(),
1418 array(),
1419 array(
1420 'direction' => 'prev',
1421 'oldid' => $oldid
1422 ) + $extraParams
1424 : wfMessage( 'previousrevision' )->escaped();
1425 $prevdiff = $prev
1426 ? Linker::linkKnown(
1427 $this->getTitle(),
1428 wfMessage( 'diff' )->escaped(),
1429 array(),
1430 array(
1431 'diff' => 'prev',
1432 'oldid' => $oldid
1433 ) + $extraParams
1435 : wfMessage( 'diff' )->escaped();
1436 $nextlink = $current
1437 ? wfMessage( 'nextrevision' )->escaped()
1438 : Linker::linkKnown(
1439 $this->getTitle(),
1440 wfMessage( 'nextrevision' )->escaped(),
1441 array(),
1442 array(
1443 'direction' => 'next',
1444 'oldid' => $oldid
1445 ) + $extraParams
1447 $nextdiff = $current
1448 ? wfMessage( 'diff' )->escaped()
1449 : Linker::linkKnown(
1450 $this->getTitle(),
1451 wfMessage( 'diff' )->escaped(),
1452 array(),
1453 array(
1454 'diff' => 'next',
1455 'oldid' => $oldid
1456 ) + $extraParams
1459 $cdel = Linker::getRevDeleteLink( $user, $revision, $this->getTitle() );
1460 if ( $cdel !== '' ) {
1461 $cdel .= ' ';
1464 $outputPage->addSubtitle( "<div id=\"mw-revision-nav\">" . $cdel .
1465 wfMessage( 'revision-nav' )->rawParams(
1466 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff
1467 )->escaped() . "</div>" );
1471 * Return the HTML for the top of a redirect page
1473 * Chances are you should just be using the ParserOutput from
1474 * WikitextContent::getParserOutput instead of calling this for redirects.
1476 * @param Title|array $target Destination(s) to redirect
1477 * @param bool $appendSubtitle [optional]
1478 * @param bool $forceKnown Should the image be shown as a bluelink regardless of existence?
1479 * @return string Containing HTML with redirect link
1481 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1482 $lang = $this->getTitle()->getPageLanguage();
1483 $out = $this->getContext()->getOutput();
1484 if ( $appendSubtitle ) {
1485 $out->addSubtitle( wfMessage( 'redirectpagesub' )->parse() );
1487 $out->addModuleStyles( 'mediawiki.action.view.redirectPage' );
1488 return static::getRedirectHeaderHtml( $lang, $target, $forceKnown );
1492 * Return the HTML for the top of a redirect page
1494 * Chances are you should just be using the ParserOutput from
1495 * WikitextContent::getParserOutput instead of calling this for redirects.
1497 * @since 1.23
1498 * @param Language $lang
1499 * @param Title|array $target Destination(s) to redirect
1500 * @param bool $forceKnown Should the image be shown as a bluelink regardless of existence?
1501 * @return string Containing HTML with redirect link
1503 public static function getRedirectHeaderHtml( Language $lang, $target, $forceKnown = false ) {
1504 if ( !is_array( $target ) ) {
1505 $target = array( $target );
1508 $html = '<ul class="redirectText">';
1509 /** @var Title $title */
1510 foreach ( $target as $title ) {
1511 $html .= '<li>' . Linker::link(
1512 $title,
1513 htmlspecialchars( $title->getFullText() ),
1514 array(),
1515 // Automatically append redirect=no to each link, since most of them are
1516 // redirect pages themselves.
1517 array( 'redirect' => 'no' ),
1518 ( $forceKnown ? array( 'known', 'noclasses' ) : array() )
1519 ) . '</li>';
1522 $redirectToText = wfMessage( 'redirectto' )->inLanguage( $lang )->text();
1524 return '<div class="redirectMsg">' .
1525 '<p>' . $redirectToText . '</p>' .
1526 $html .
1527 '</div>';
1531 * Handle action=render
1533 public function render() {
1534 $this->getContext()->getRequest()->response()->header( 'X-Robots-Tag: noindex' );
1535 $this->getContext()->getOutput()->setArticleBodyOnly( true );
1536 $this->getContext()->getOutput()->enableSectionEditLinks( false );
1537 $this->view();
1541 * action=protect handler
1543 public function protect() {
1544 $form = new ProtectionForm( $this );
1545 $form->execute();
1549 * action=unprotect handler (alias)
1551 public function unprotect() {
1552 $this->protect();
1556 * UI entry point for page deletion
1558 public function delete() {
1559 # This code desperately needs to be totally rewritten
1561 $title = $this->getTitle();
1562 $user = $this->getContext()->getUser();
1564 # Check permissions
1565 $permissionErrors = $title->getUserPermissionsErrors( 'delete', $user );
1566 if ( count( $permissionErrors ) ) {
1567 throw new PermissionsError( 'delete', $permissionErrors );
1570 # Read-only check...
1571 if ( wfReadOnly() ) {
1572 throw new ReadOnlyError;
1575 # Better double-check that it hasn't been deleted yet!
1576 $this->mPage->loadPageData( 'fromdbmaster' );
1577 if ( !$this->mPage->exists() ) {
1578 $deleteLogPage = new LogPage( 'delete' );
1579 $outputPage = $this->getContext()->getOutput();
1580 $outputPage->setPageTitle( wfMessage( 'cannotdelete-title', $title->getPrefixedText() ) );
1581 $outputPage->wrapWikiMsg( "<div class=\"error mw-error-cannotdelete\">\n$1\n</div>",
1582 array( 'cannotdelete', wfEscapeWikiText( $title->getPrefixedText() ) )
1584 $outputPage->addHTML(
1585 Xml::element( 'h2', null, $deleteLogPage->getName()->text() )
1587 LogEventsList::showLogExtract(
1588 $outputPage,
1589 'delete',
1590 $title
1593 return;
1596 $request = $this->getContext()->getRequest();
1597 $deleteReasonList = $request->getText( 'wpDeleteReasonList', 'other' );
1598 $deleteReason = $request->getText( 'wpReason' );
1600 if ( $deleteReasonList == 'other' ) {
1601 $reason = $deleteReason;
1602 } elseif ( $deleteReason != '' ) {
1603 // Entry from drop down menu + additional comment
1604 $colonseparator = wfMessage( 'colon-separator' )->inContentLanguage()->text();
1605 $reason = $deleteReasonList . $colonseparator . $deleteReason;
1606 } else {
1607 $reason = $deleteReasonList;
1610 if ( $request->wasPosted() && $user->matchEditToken( $request->getVal( 'wpEditToken' ),
1611 array( 'delete', $this->getTitle()->getPrefixedText() ) )
1613 # Flag to hide all contents of the archived revisions
1614 $suppress = $request->getVal( 'wpSuppress' ) && $user->isAllowed( 'suppressrevision' );
1616 $this->doDelete( $reason, $suppress );
1618 WatchAction::doWatchOrUnwatch( $request->getCheck( 'wpWatch' ), $title, $user );
1620 return;
1623 // Generate deletion reason
1624 $hasHistory = false;
1625 if ( !$reason ) {
1626 try {
1627 $reason = $this->generateReason( $hasHistory );
1628 } catch ( MWException $e ) {
1629 # if a page is horribly broken, we still want to be able to
1630 # delete it. So be lenient about errors here.
1631 wfDebug( "Error while building auto delete summary: $e" );
1632 $reason = '';
1636 // If the page has a history, insert a warning
1637 if ( $hasHistory ) {
1638 $title = $this->getTitle();
1640 // The following can use the real revision count as this is only being shown for users
1641 // that can delete this page.
1642 // This, as a side-effect, also makes sure that the following query isn't being run for
1643 // pages with a larger history, unless the user has the 'bigdelete' right
1644 // (and is about to delete this page).
1645 $dbr = wfGetDB( DB_SLAVE );
1646 $revisions = $edits = (int)$dbr->selectField(
1647 'revision',
1648 'COUNT(rev_page)',
1649 array( 'rev_page' => $title->getArticleID() ),
1650 __METHOD__
1653 // @todo FIXME: i18n issue/patchwork message
1654 $this->getContext()->getOutput()->addHTML(
1655 '<strong class="mw-delete-warning-revisions">' .
1656 wfMessage( 'historywarning' )->numParams( $revisions )->parse() .
1657 wfMessage( 'word-separator' )->plain() . Linker::linkKnown( $title,
1658 wfMessage( 'history' )->escaped(),
1659 array( 'rel' => 'archives' ),
1660 array( 'action' => 'history' ) ) .
1661 '</strong>'
1664 if ( $title->isBigDeletion() ) {
1665 global $wgDeleteRevisionsLimit;
1666 $this->getContext()->getOutput()->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1667 array(
1668 'delete-warning-toobig',
1669 $this->getContext()->getLanguage()->formatNum( $wgDeleteRevisionsLimit )
1675 $this->confirmDelete( $reason );
1679 * Output deletion confirmation dialog
1680 * @todo FIXME: Move to another file?
1681 * @param string $reason Prefilled reason
1683 public function confirmDelete( $reason ) {
1684 wfDebug( "Article::confirmDelete\n" );
1686 $title = $this->getTitle();
1687 $ctx = $this->getContext();
1688 $outputPage = $ctx->getOutput();
1689 $useMediaWikiUIEverywhere = $ctx->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1690 $outputPage->setPageTitle( wfMessage( 'delete-confirm', $title->getPrefixedText() ) );
1691 $outputPage->addBacklinkSubtitle( $title );
1692 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1693 $backlinkCache = $title->getBacklinkCache();
1694 if ( $backlinkCache->hasLinks( 'pagelinks' ) || $backlinkCache->hasLinks( 'templatelinks' ) ) {
1695 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1696 'deleting-backlinks-warning' );
1698 $outputPage->addWikiMsg( 'confirmdeletetext' );
1700 wfRunHooks( 'ArticleConfirmDelete', array( $this, $outputPage, &$reason ) );
1702 $user = $this->getContext()->getUser();
1704 if ( $user->isAllowed( 'suppressrevision' ) ) {
1705 $suppress = Html::openElement( 'div', array( 'id' => 'wpDeleteSuppressRow' ) ) .
1706 "<strong>" .
1707 Xml::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
1708 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
1709 "</strong>" .
1710 Html::closeElement( 'div' );
1711 } else {
1712 $suppress = '';
1714 $checkWatch = $user->getBoolOption( 'watchdeletion' ) || $user->isWatched( $title );
1716 $form = Html::openElement( 'form', array( 'method' => 'post',
1717 'action' => $title->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
1718 Html::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
1719 Html::element( 'legend', null, wfMessage( 'delete-legend' )->text() ) .
1720 Html::openElement( 'div', array( 'id' => 'mw-deleteconfirm-table' ) ) .
1721 Html::openElement( 'div', array( 'id' => 'wpDeleteReasonListRow' ) ) .
1722 Html::label( wfMessage( 'deletecomment' )->text(), 'wpDeleteReasonList' ) .
1723 '&nbsp;' .
1724 Xml::listDropDown(
1725 'wpDeleteReasonList',
1726 wfMessage( 'deletereason-dropdown' )->inContentLanguage()->text(),
1727 wfMessage( 'deletereasonotherlist' )->inContentLanguage()->text(),
1729 'wpReasonDropDown',
1732 Html::closeElement( 'div' ) .
1733 Html::openElement( 'div', array( 'id' => 'wpDeleteReasonRow' ) ) .
1734 Html::label( wfMessage( 'deleteotherreason' )->text(), 'wpReason' ) .
1735 '&nbsp;' .
1736 Html::input( 'wpReason', $reason, 'text', array(
1737 'size' => '60',
1738 'maxlength' => '255',
1739 'tabindex' => '2',
1740 'id' => 'wpReason',
1741 'class' => 'mw-ui-input-inline',
1742 'autofocus'
1743 ) ) .
1744 Html::closeElement( 'div' );
1746 # Disallow watching if user is not logged in
1747 if ( $user->isLoggedIn() ) {
1748 $form .=
1749 Xml::checkLabel( wfMessage( 'watchthis' )->text(),
1750 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) );
1753 $form .=
1754 Html::openElement( 'div' ) .
1755 $suppress .
1756 Xml::submitButton( wfMessage( 'deletepage' )->text(),
1757 array(
1758 'name' => 'wpConfirmB',
1759 'id' => 'wpConfirmB',
1760 'tabindex' => '5',
1761 'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button mw-ui-destructive' : '',
1764 Html::closeElement( 'div' ) .
1765 Html::closeElement( 'div' ) .
1766 Xml::closeElement( 'fieldset' ) .
1767 Html::hidden(
1768 'wpEditToken',
1769 $user->getEditToken( array( 'delete', $title->getPrefixedText() ) )
1771 Xml::closeElement( 'form' );
1773 if ( $user->isAllowed( 'editinterface' ) ) {
1774 $dropdownTitle = Title::makeTitle( NS_MEDIAWIKI, 'Deletereason-dropdown' );
1775 $link = Linker::link(
1776 $dropdownTitle,
1777 wfMessage( 'delete-edit-reasonlist' )->escaped(),
1778 array(),
1779 array( 'action' => 'edit' )
1781 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
1784 $outputPage->addHTML( $form );
1786 $deleteLogPage = new LogPage( 'delete' );
1787 $outputPage->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) );
1788 LogEventsList::showLogExtract( $outputPage, 'delete', $title );
1792 * Perform a deletion and output success or failure messages
1793 * @param string $reason
1794 * @param bool $suppress
1796 public function doDelete( $reason, $suppress = false ) {
1797 $error = '';
1798 $outputPage = $this->getContext()->getOutput();
1799 $status = $this->mPage->doDeleteArticleReal( $reason, $suppress, 0, true, $error );
1801 if ( $status->isGood() ) {
1802 $deleted = $this->getTitle()->getPrefixedText();
1804 $outputPage->setPageTitle( wfMessage( 'actioncomplete' ) );
1805 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1807 $loglink = '[[Special:Log/delete|' . wfMessage( 'deletionlog' )->text() . ']]';
1809 $outputPage->addWikiMsg( 'deletedtext', wfEscapeWikiText( $deleted ), $loglink );
1810 $outputPage->returnToMain( false );
1811 } else {
1812 $outputPage->setPageTitle(
1813 wfMessage( 'cannotdelete-title',
1814 $this->getTitle()->getPrefixedText() )
1817 if ( $error == '' ) {
1818 $outputPage->addWikiText(
1819 "<div class=\"error mw-error-cannotdelete\">\n" . $status->getWikiText() . "\n</div>"
1821 $deleteLogPage = new LogPage( 'delete' );
1822 $outputPage->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) );
1824 LogEventsList::showLogExtract(
1825 $outputPage,
1826 'delete',
1827 $this->getTitle()
1829 } else {
1830 $outputPage->addHTML( $error );
1835 /* Caching functions */
1838 * checkLastModified returns true if it has taken care of all
1839 * output to the client that is necessary for this request.
1840 * (that is, it has sent a cached version of the page)
1842 * @return bool True if cached version send, false otherwise
1844 protected function tryFileCache() {
1845 static $called = false;
1847 if ( $called ) {
1848 wfDebug( "Article::tryFileCache(): called twice!?\n" );
1849 return false;
1852 $called = true;
1853 if ( $this->isFileCacheable() ) {
1854 $cache = new HTMLFileCache( $this->getTitle(), 'view' );
1855 if ( $cache->isCacheGood( $this->mPage->getTouched() ) ) {
1856 wfDebug( "Article::tryFileCache(): about to load file\n" );
1857 $cache->loadFromFileCache( $this->getContext() );
1858 return true;
1859 } else {
1860 wfDebug( "Article::tryFileCache(): starting buffer\n" );
1861 ob_start( array( &$cache, 'saveToFileCache' ) );
1863 } else {
1864 wfDebug( "Article::tryFileCache(): not cacheable\n" );
1867 return false;
1871 * Check if the page can be cached
1872 * @return bool
1874 public function isFileCacheable() {
1875 $cacheable = false;
1877 if ( HTMLFileCache::useFileCache( $this->getContext() ) ) {
1878 $cacheable = $this->mPage->getID()
1879 && !$this->mRedirectedFrom && !$this->getTitle()->isRedirect();
1880 // Extension may have reason to disable file caching on some pages.
1881 if ( $cacheable ) {
1882 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
1886 return $cacheable;
1889 /**#@-*/
1892 * Lightweight method to get the parser output for a page, checking the parser cache
1893 * and so on. Doesn't consider most of the stuff that WikiPage::view is forced to
1894 * consider, so it's not appropriate to use there.
1896 * @since 1.16 (r52326) for LiquidThreads
1898 * @param int|null $oldid Revision ID or null
1899 * @param User $user The relevant user
1900 * @return ParserOutput|bool ParserOutput or false if the given revision ID is not found
1902 public function getParserOutput( $oldid = null, User $user = null ) {
1903 //XXX: bypasses mParserOptions and thus setParserOptions()
1905 if ( $user === null ) {
1906 $parserOptions = $this->getParserOptions();
1907 } else {
1908 $parserOptions = $this->mPage->makeParserOptions( $user );
1911 return $this->mPage->getParserOutput( $parserOptions, $oldid );
1915 * Override the ParserOptions used to render the primary article wikitext.
1917 * @param ParserOptions $options
1918 * @throws MWException If the parser options where already initialized.
1920 public function setParserOptions( ParserOptions $options ) {
1921 if ( $this->mParserOptions ) {
1922 throw new MWException( "can't change parser options after they have already been set" );
1925 // clone, so if $options is modified later, it doesn't confuse the parser cache.
1926 $this->mParserOptions = clone $options;
1930 * Get parser options suitable for rendering the primary article wikitext
1931 * @return ParserOptions
1933 public function getParserOptions() {
1934 if ( !$this->mParserOptions ) {
1935 $this->mParserOptions = $this->mPage->makeParserOptions( $this->getContext() );
1937 // Clone to allow modifications of the return value without affecting cache
1938 return clone $this->mParserOptions;
1942 * Sets the context this Article is executed in
1944 * @param IContextSource $context
1945 * @since 1.18
1947 public function setContext( $context ) {
1948 $this->mContext = $context;
1952 * Gets the context this Article is executed in
1954 * @return IContextSource
1955 * @since 1.18
1957 public function getContext() {
1958 if ( $this->mContext instanceof IContextSource ) {
1959 return $this->mContext;
1960 } else {
1961 wfDebug( __METHOD__ . " called and \$mContext is null. " .
1962 "Return RequestContext::getMain(); for sanity\n" );
1963 return RequestContext::getMain();
1968 * Use PHP's magic __get handler to handle accessing of
1969 * raw WikiPage fields for backwards compatibility.
1971 * @param string $fname Field name
1972 * @return mixed
1974 public function __get( $fname ) {
1975 if ( property_exists( $this->mPage, $fname ) ) {
1976 #wfWarn( "Access to raw $fname field " . __CLASS__ );
1977 return $this->mPage->$fname;
1979 trigger_error( 'Inaccessible property via __get(): ' . $fname, E_USER_NOTICE );
1983 * Use PHP's magic __set handler to handle setting of
1984 * raw WikiPage fields for backwards compatibility.
1986 * @param string $fname Field name
1987 * @param mixed $fvalue New value
1989 public function __set( $fname, $fvalue ) {
1990 if ( property_exists( $this->mPage, $fname ) ) {
1991 #wfWarn( "Access to raw $fname field of " . __CLASS__ );
1992 $this->mPage->$fname = $fvalue;
1993 // Note: extensions may want to toss on new fields
1994 } elseif ( !in_array( $fname, array( 'mContext', 'mPage' ) ) ) {
1995 $this->mPage->$fname = $fvalue;
1996 } else {
1997 trigger_error( 'Inaccessible property via __set(): ' . $fname, E_USER_NOTICE );
2002 * Use PHP's magic __call handler to transform instance calls to
2003 * WikiPage functions for backwards compatibility.
2005 * @param string $fname Name of called method
2006 * @param array $args Arguments to the method
2007 * @return mixed
2009 public function __call( $fname, $args ) {
2010 if ( is_callable( array( $this->mPage, $fname ) ) ) {
2011 #wfWarn( "Call to " . __CLASS__ . "::$fname; please use WikiPage instead" );
2012 return call_user_func_array( array( $this->mPage, $fname ), $args );
2014 trigger_error( 'Inaccessible function via __call(): ' . $fname, E_USER_ERROR );
2017 // ****** B/C functions to work-around PHP silliness with __call and references ****** //
2020 * @param array $limit
2021 * @param array $expiry
2022 * @param bool $cascade
2023 * @param string $reason
2024 * @param User $user
2025 * @return Status
2027 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade,
2028 $reason, User $user
2030 return $this->mPage->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user );
2034 * @param array $limit
2035 * @param string $reason
2036 * @param int $cascade
2037 * @param array $expiry
2038 * @return bool
2040 public function updateRestrictions( $limit = array(), $reason = '',
2041 &$cascade = 0, $expiry = array()
2043 return $this->mPage->doUpdateRestrictions(
2044 $limit,
2045 $expiry,
2046 $cascade,
2047 $reason,
2048 $this->getContext()->getUser()
2053 * @param string $reason
2054 * @param bool $suppress
2055 * @param int $id
2056 * @param bool $commit
2057 * @param string $error
2058 * @return bool
2060 public function doDeleteArticle( $reason, $suppress = false, $id = 0,
2061 $commit = true, &$error = ''
2063 return $this->mPage->doDeleteArticle( $reason, $suppress, $id, $commit, $error );
2067 * @param string $fromP
2068 * @param string $summary
2069 * @param string $token
2070 * @param bool $bot
2071 * @param array $resultDetails
2072 * @param User|null $user
2073 * @return array
2075 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails, User $user = null ) {
2076 $user = is_null( $user ) ? $this->getContext()->getUser() : $user;
2077 return $this->mPage->doRollback( $fromP, $summary, $token, $bot, $resultDetails, $user );
2081 * @param string $fromP
2082 * @param string $summary
2083 * @param bool $bot
2084 * @param array $resultDetails
2085 * @param User|null $guser
2086 * @return array
2088 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser = null ) {
2089 $guser = is_null( $guser ) ? $this->getContext()->getUser() : $guser;
2090 return $this->mPage->commitRollback( $fromP, $summary, $bot, $resultDetails, $guser );
2094 * @param bool $hasHistory
2095 * @return mixed
2097 public function generateReason( &$hasHistory ) {
2098 $title = $this->mPage->getTitle();
2099 $handler = ContentHandler::getForTitle( $title );
2100 return $handler->getAutoDeleteReason( $title, $hasHistory );
2103 // ****** B/C functions for static methods ( __callStatic is PHP>=5.3 ) ****** //
2106 * @return array
2108 * @deprecated since 1.24, use WikiPage::selectFields() instead
2110 public static function selectFields() {
2111 wfDeprecated( __METHOD__, '1.24' );
2112 return WikiPage::selectFields();
2116 * @param Title $title
2118 * @deprecated since 1.24, use WikiPage::onArticleCreate() instead
2120 public static function onArticleCreate( $title ) {
2121 wfDeprecated( __METHOD__, '1.24' );
2122 WikiPage::onArticleCreate( $title );
2126 * @param Title $title
2128 * @deprecated since 1.24, use WikiPage::onArticleDelete() instead
2130 public static function onArticleDelete( $title ) {
2131 wfDeprecated( __METHOD__, '1.24' );
2132 WikiPage::onArticleDelete( $title );
2136 * @param Title $title
2138 * @deprecated since 1.24, use WikiPage::onArticleEdit() instead
2140 public static function onArticleEdit( $title ) {
2141 wfDeprecated( __METHOD__, '1.24' );
2142 WikiPage::onArticleEdit( $title );
2146 * @param string $oldtext
2147 * @param string $newtext
2148 * @param int $flags
2149 * @return string
2150 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
2152 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2153 return WikiPage::getAutosummary( $oldtext, $newtext, $flags );
2155 // ******