Merge "Simplified getMaxLag() to use getLagTimes()"
[mediawiki.git] / includes / page / Article.php
blobdaf331149e6234332028d6f3c772165fb5a00ea0
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 $this->getContext()->getOutput()->addWikiMsg( 'difference-missing-revision', $oldid, 1 );
794 return;
797 $contentHandler = $rev->getContentHandler();
798 $de = $contentHandler->createDifferenceEngine(
799 $this->getContext(),
800 $oldid,
801 $diff,
802 $rcid,
803 $purge,
804 $unhide
807 // DifferenceEngine directly fetched the revision:
808 $this->mRevIdFetched = $de->mNewid;
809 $de->showDiffPage( $diffOnly );
811 // Run view updates for the newer revision being diffed (and shown
812 // below the diff if not $diffOnly).
813 list( $old, $new ) = $de->mapDiffPrevNext( $oldid, $diff );
814 // New can be false, convert it to 0 - this conveniently means the latest revision
815 $this->mPage->doViewUpdates( $user, (int)$new );
819 * Show a page view for a page formatted as CSS or JavaScript. To be called by
820 * Article::view() only.
822 * This exists mostly to serve the deprecated ShowRawCssJs hook (used to customize these views).
823 * It has been replaced by the ContentGetParserOutput hook, which lets you do the same but with
824 * more flexibility.
826 * @param bool $showCacheHint Whether to show a message telling the user
827 * to clear the browser cache (default: true).
829 protected function showCssOrJsPage( $showCacheHint = true ) {
830 $outputPage = $this->getContext()->getOutput();
832 if ( $showCacheHint ) {
833 $dir = $this->getContext()->getLanguage()->getDir();
834 $lang = $this->getContext()->getLanguage()->getCode();
836 $outputPage->wrapWikiMsg(
837 "<div id='mw-clearyourcache' lang='$lang' dir='$dir' class='mw-content-$dir'>\n$1\n</div>",
838 'clearyourcache'
842 $this->fetchContentObject();
844 if ( $this->mContentObject ) {
845 // Give hooks a chance to customise the output
846 if ( ContentHandler::runLegacyHooks(
847 'ShowRawCssJs',
848 array( $this->mContentObject, $this->getTitle(), $outputPage ) )
850 // If no legacy hooks ran, display the content of the parser output, including RL modules,
851 // but excluding metadata like categories and language links
852 $po = $this->mContentObject->getParserOutput( $this->getTitle() );
853 $outputPage->addParserOutputContent( $po );
859 * Get the robot policy to be used for the current view
860 * @param string $action The action= GET parameter
861 * @param ParserOutput|null $pOutput
862 * @return array The policy that should be set
863 * @todo actions other than 'view'
865 public function getRobotPolicy( $action, $pOutput = null ) {
866 global $wgArticleRobotPolicies, $wgNamespaceRobotPolicies, $wgDefaultRobotPolicy;
868 $ns = $this->getTitle()->getNamespace();
870 # Don't index user and user talk pages for blocked users (bug 11443)
871 if ( ( $ns == NS_USER || $ns == NS_USER_TALK ) && !$this->getTitle()->isSubpage() ) {
872 $specificTarget = null;
873 $vagueTarget = null;
874 $titleText = $this->getTitle()->getText();
875 if ( IP::isValid( $titleText ) ) {
876 $vagueTarget = $titleText;
877 } else {
878 $specificTarget = $titleText;
880 if ( Block::newFromTarget( $specificTarget, $vagueTarget ) instanceof Block ) {
881 return array(
882 'index' => 'noindex',
883 'follow' => 'nofollow'
888 if ( $this->mPage->getID() === 0 || $this->getOldID() ) {
889 # Non-articles (special pages etc), and old revisions
890 return array(
891 'index' => 'noindex',
892 'follow' => 'nofollow'
894 } elseif ( $this->getContext()->getOutput()->isPrintable() ) {
895 # Discourage indexing of printable versions, but encourage following
896 return array(
897 'index' => 'noindex',
898 'follow' => 'follow'
900 } elseif ( $this->getContext()->getRequest()->getInt( 'curid' ) ) {
901 # For ?curid=x urls, disallow indexing
902 return array(
903 'index' => 'noindex',
904 'follow' => 'follow'
908 # Otherwise, construct the policy based on the various config variables.
909 $policy = self::formatRobotPolicy( $wgDefaultRobotPolicy );
911 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
912 # Honour customised robot policies for this namespace
913 $policy = array_merge(
914 $policy,
915 self::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
918 if ( $this->getTitle()->canUseNoindex() && is_object( $pOutput ) && $pOutput->getIndexPolicy() ) {
919 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
920 # a final sanity check that we have really got the parser output.
921 $policy = array_merge(
922 $policy,
923 array( 'index' => $pOutput->getIndexPolicy() )
927 if ( isset( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] ) ) {
928 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
929 $policy = array_merge(
930 $policy,
931 self::formatRobotPolicy( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] )
935 return $policy;
939 * Converts a String robot policy into an associative array, to allow
940 * merging of several policies using array_merge().
941 * @param array|string $policy Returns empty array on null/false/'', transparent
942 * to already-converted arrays, converts string.
943 * @return array 'index' => \<indexpolicy\>, 'follow' => \<followpolicy\>
945 public static function formatRobotPolicy( $policy ) {
946 if ( is_array( $policy ) ) {
947 return $policy;
948 } elseif ( !$policy ) {
949 return array();
952 $policy = explode( ',', $policy );
953 $policy = array_map( 'trim', $policy );
955 $arr = array();
956 foreach ( $policy as $var ) {
957 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
958 $arr['index'] = $var;
959 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
960 $arr['follow'] = $var;
964 return $arr;
968 * If this request is a redirect view, send "redirected from" subtitle to
969 * the output. Returns true if the header was needed, false if this is not
970 * a redirect view. Handles both local and remote redirects.
972 * @return bool
974 public function showRedirectedFromHeader() {
975 global $wgRedirectSources;
976 $outputPage = $this->getContext()->getOutput();
978 $request = $this->getContext()->getRequest();
979 $rdfrom = $request->getVal( 'rdfrom' );
981 // Construct a URL for the current page view, but with the target title
982 $query = $request->getValues();
983 unset( $query['rdfrom'] );
984 unset( $query['title'] );
985 $redirectTargetUrl = $this->getTitle()->getLinkURL( $query );
987 if ( isset( $this->mRedirectedFrom ) ) {
988 // This is an internally redirected page view.
989 // We'll need a backlink to the source page for navigation.
990 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
991 $redir = Linker::linkKnown(
992 $this->mRedirectedFrom,
993 null,
994 array(),
995 array( 'redirect' => 'no' )
998 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
1000 // Add the script to update the displayed URL and
1001 // set the fragment if one was specified in the redirect
1002 $outputPage->addJsConfigVars( array(
1003 'wgInternalRedirectTargetUrl' => $redirectTargetUrl,
1004 ) );
1005 $outputPage->addModules( 'mediawiki.action.view.redirect' );
1007 // Add a <link rel="canonical"> tag
1008 $outputPage->setCanonicalUrl( $this->getTitle()->getLocalURL() );
1010 // Tell the output object that the user arrived at this article through a redirect
1011 $outputPage->setRedirectedFrom( $this->mRedirectedFrom );
1013 return true;
1015 } elseif ( $rdfrom ) {
1016 // This is an externally redirected view, from some other wiki.
1017 // If it was reported from a trusted site, supply a backlink.
1018 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1019 $redir = Linker::makeExternalLink( $rdfrom, $rdfrom );
1020 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
1022 // Add the script to update the displayed URL
1023 $outputPage->addJsConfigVars( array(
1024 'wgInternalRedirectTargetUrl' => $redirectTargetUrl,
1025 ) );
1026 $outputPage->addModules( 'mediawiki.action.view.redirect' );
1028 return true;
1032 return false;
1036 * Show a header specific to the namespace currently being viewed, like
1037 * [[MediaWiki:Talkpagetext]]. For Article::view().
1039 public function showNamespaceHeader() {
1040 if ( $this->getTitle()->isTalkPage() ) {
1041 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1042 $this->getContext()->getOutput()->wrapWikiMsg(
1043 "<div class=\"mw-talkpageheader\">\n$1\n</div>",
1044 array( 'talkpageheader' )
1051 * Show the footer section of an ordinary page view
1053 public function showViewFooter() {
1054 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1055 if ( $this->getTitle()->getNamespace() == NS_USER_TALK
1056 && IP::isValid( $this->getTitle()->getText() )
1058 $this->getContext()->getOutput()->addWikiMsg( 'anontalkpagetext' );
1061 // Show a footer allowing the user to patrol the shown revision or page if possible
1062 $patrolFooterShown = $this->showPatrolFooter();
1064 wfRunHooks( 'ArticleViewFooter', array( $this, $patrolFooterShown ) );
1068 * If patrol is possible, output a patrol UI box. This is called from the
1069 * footer section of ordinary page views. If patrol is not possible or not
1070 * desired, does nothing.
1071 * Side effect: When the patrol link is build, this method will call
1072 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
1074 * @return bool
1076 public function showPatrolFooter() {
1077 global $wgUseNPPatrol, $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
1079 $outputPage = $this->getContext()->getOutput();
1080 $user = $this->getContext()->getUser();
1081 $cache = wfGetMainCache();
1082 $rc = false;
1084 if ( !$this->getTitle()->quickUserCan( 'patrol', $user )
1085 || !( $wgUseRCPatrol || $wgUseNPPatrol )
1087 // Patrolling is disabled or the user isn't allowed to
1088 return false;
1091 wfProfileIn( __METHOD__ );
1093 // New page patrol: Get the timestamp of the oldest revison which
1094 // the revision table holds for the given page. Then we look
1095 // whether it's within the RC lifespan and if it is, we try
1096 // to get the recentchanges row belonging to that entry
1097 // (with rc_new = 1).
1099 // Check for cached results
1100 if ( $cache->get( wfMemcKey( 'NotPatrollablePage', $this->getTitle()->getArticleID() ) ) ) {
1101 wfProfileOut( __METHOD__ );
1102 return false;
1105 if ( $this->mRevision
1106 && !RecentChange::isInRCLifespan( $this->mRevision->getTimestamp(), 21600 )
1108 // The current revision is already older than what could be in the RC table
1109 // 6h tolerance because the RC might not be cleaned out regularly
1110 wfProfileOut( __METHOD__ );
1111 return false;
1114 $dbr = wfGetDB( DB_SLAVE );
1115 $oldestRevisionTimestamp = $dbr->selectField(
1116 'revision',
1117 'MIN( rev_timestamp )',
1118 array( 'rev_page' => $this->getTitle()->getArticleID() ),
1119 __METHOD__
1122 if ( $oldestRevisionTimestamp
1123 && RecentChange::isInRCLifespan( $oldestRevisionTimestamp, 21600 )
1125 // 6h tolerance because the RC might not be cleaned out regularly
1126 $rc = RecentChange::newFromConds(
1127 array(
1128 'rc_new' => 1,
1129 'rc_timestamp' => $oldestRevisionTimestamp,
1130 'rc_namespace' => $this->getTitle()->getNamespace(),
1131 'rc_cur_id' => $this->getTitle()->getArticleID(),
1132 'rc_patrolled' => 0
1134 __METHOD__,
1135 array( 'USE INDEX' => 'new_name_timestamp' )
1139 if ( !$rc ) {
1140 // No RC entry around
1142 // Cache the information we gathered above in case we can't patrol
1143 // Don't cache in case we can patrol as this could change
1144 $cache->set( wfMemcKey( 'NotPatrollablePage', $this->getTitle()->getArticleID() ), '1' );
1146 wfProfileOut( __METHOD__ );
1147 return false;
1150 if ( $rc->getPerformer()->getName() == $user->getName() ) {
1151 // Don't show a patrol link for own creations. If the user could
1152 // patrol them, they already would be patrolled
1153 wfProfileOut( __METHOD__ );
1154 return false;
1157 $rcid = $rc->getAttribute( 'rc_id' );
1159 $token = $user->getEditToken( $rcid );
1161 $outputPage->preventClickjacking();
1162 if ( $wgEnableAPI && $wgEnableWriteAPI && $user->isAllowed( 'writeapi' ) ) {
1163 $outputPage->addModules( 'mediawiki.page.patrol.ajax' );
1166 $link = Linker::linkKnown(
1167 $this->getTitle(),
1168 wfMessage( 'markaspatrolledtext' )->escaped(),
1169 array(),
1170 array(
1171 'action' => 'markpatrolled',
1172 'rcid' => $rcid,
1173 'token' => $token,
1177 $outputPage->addHTML(
1178 "<div class='patrollink'>" .
1179 wfMessage( 'markaspatrolledlink' )->rawParams( $link )->escaped() .
1180 '</div>'
1183 wfProfileOut( __METHOD__ );
1184 return true;
1188 * Show the error text for a missing article. For articles in the MediaWiki
1189 * namespace, show the default message text. To be called from Article::view().
1191 public function showMissingArticle() {
1192 global $wgSend404Code;
1194 $outputPage = $this->getContext()->getOutput();
1195 // Whether the page is a root user page of an existing user (but not a subpage)
1196 $validUserPage = false;
1198 $title = $this->getTitle();
1200 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1201 if ( $title->getNamespace() == NS_USER
1202 || $title->getNamespace() == NS_USER_TALK
1204 $parts = explode( '/', $title->getText() );
1205 $rootPart = $parts[0];
1206 $user = User::newFromName( $rootPart, false /* allow IP users*/ );
1207 $ip = User::isIP( $rootPart );
1208 $block = Block::newFromTarget( $user, $user );
1210 if ( !( $user && $user->isLoggedIn() ) && !$ip ) { # User does not exist
1211 $outputPage->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1212 array( 'userpage-userdoesnotexist-view', wfEscapeWikiText( $rootPart ) ) );
1213 } elseif ( !is_null( $block ) && $block->getType() != Block::TYPE_AUTO ) { # Show log extract if the user is currently blocked
1214 LogEventsList::showLogExtract(
1215 $outputPage,
1216 'block',
1217 MWNamespace::getCanonicalName( NS_USER ) . ':' . $block->getTarget(),
1219 array(
1220 'lim' => 1,
1221 'showIfEmpty' => false,
1222 'msgKey' => array(
1223 'blocked-notice-logextract',
1224 $user->getName() # Support GENDER in notice
1228 $validUserPage = !$title->isSubpage();
1229 } else {
1230 $validUserPage = !$title->isSubpage();
1234 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1236 // Give extensions a chance to hide their (unrelated) log entries
1237 $logTypes = array( 'delete', 'move' );
1238 $conds = array( "log_action != 'revision'" );
1239 wfRunHooks( 'Article::MissingArticleConditions', array( &$conds, $logTypes ) );
1241 # Show delete and move logs
1242 $member = $title->getNamespace() . ':' . $title->getDBkey();
1243 // @todo: move optimization to showLogExtract()?
1244 if ( BloomCache::get( 'main' )->check( wfWikiId(), 'TitleHasLogs', $member ) ) {
1245 LogEventsList::showLogExtract( $outputPage, $logTypes, $title, '',
1246 array( 'lim' => 10,
1247 'conds' => $conds,
1248 'showIfEmpty' => false,
1249 'msgKey' => array( 'moveddeleted-notice' ) )
1253 if ( !$this->mPage->hasViewableContent() && $wgSend404Code && !$validUserPage ) {
1254 // If there's no backing content, send a 404 Not Found
1255 // for better machine handling of broken links.
1256 $this->getContext()->getRequest()->response()->header( "HTTP/1.1 404 Not Found" );
1259 // Also apply the robot policy for nonexisting pages (even if a 404 was used for sanity)
1260 $policy = $this->getRobotPolicy( 'view' );
1261 $outputPage->setIndexPolicy( $policy['index'] );
1262 $outputPage->setFollowPolicy( $policy['follow'] );
1264 $hookResult = wfRunHooks( 'BeforeDisplayNoArticleText', array( $this ) );
1266 if ( !$hookResult ) {
1267 return;
1270 # Show error message
1271 $oldid = $this->getOldID();
1272 if ( $oldid ) {
1273 $text = wfMessage( 'missing-revision', $oldid )->plain();
1274 } elseif ( $title->getNamespace() === NS_MEDIAWIKI ) {
1275 // Use the default message text
1276 $text = $title->getDefaultMessageText();
1277 } elseif ( $title->quickUserCan( 'create', $this->getContext()->getUser() )
1278 && $title->quickUserCan( 'edit', $this->getContext()->getUser() )
1280 $message = $this->getContext()->getUser()->isLoggedIn() ? 'noarticletext' : 'noarticletextanon';
1281 $text = wfMessage( $message )->plain();
1282 } else {
1283 $text = wfMessage( 'noarticletext-nopermission' )->plain();
1285 $text = "<div class='noarticletext'>\n$text\n</div>";
1287 $outputPage->addWikiText( $text );
1291 * If the revision requested for view is deleted, check permissions.
1292 * Send either an error message or a warning header to the output.
1294 * @return bool True if the view is allowed, false if not.
1296 public function showDeletedRevisionHeader() {
1297 if ( !$this->mRevision->isDeleted( Revision::DELETED_TEXT ) ) {
1298 // Not deleted
1299 return true;
1302 $outputPage = $this->getContext()->getOutput();
1303 $user = $this->getContext()->getUser();
1304 // If the user is not allowed to see it...
1305 if ( !$this->mRevision->userCan( Revision::DELETED_TEXT, $user ) ) {
1306 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1307 'rev-deleted-text-permission' );
1309 return false;
1310 // If the user needs to confirm that they want to see it...
1311 } elseif ( $this->getContext()->getRequest()->getInt( 'unhide' ) != 1 ) {
1312 # Give explanation and add a link to view the revision...
1313 $oldid = intval( $this->getOldID() );
1314 $link = $this->getTitle()->getFullURL( "oldid={$oldid}&unhide=1" );
1315 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1316 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1317 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1318 array( $msg, $link ) );
1320 return false;
1321 // We are allowed to see...
1322 } else {
1323 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1324 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1325 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1327 return true;
1332 * Generate the navigation links when browsing through an article revisions
1333 * It shows the information as:
1334 * Revision as of \<date\>; view current revision
1335 * \<- Previous version | Next Version -\>
1337 * @param int $oldid Revision ID of this article revision
1339 public function setOldSubtitle( $oldid = 0 ) {
1340 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
1341 return;
1344 $unhide = $this->getContext()->getRequest()->getInt( 'unhide' ) == 1;
1346 # Cascade unhide param in links for easy deletion browsing
1347 $extraParams = array();
1348 if ( $unhide ) {
1349 $extraParams['unhide'] = 1;
1352 if ( $this->mRevision && $this->mRevision->getId() === $oldid ) {
1353 $revision = $this->mRevision;
1354 } else {
1355 $revision = Revision::newFromId( $oldid );
1358 $timestamp = $revision->getTimestamp();
1360 $current = ( $oldid == $this->mPage->getLatest() );
1361 $language = $this->getContext()->getLanguage();
1362 $user = $this->getContext()->getUser();
1364 $td = $language->userTimeAndDate( $timestamp, $user );
1365 $tddate = $language->userDate( $timestamp, $user );
1366 $tdtime = $language->userTime( $timestamp, $user );
1368 # Show user links if allowed to see them. If hidden, then show them only if requested...
1369 $userlinks = Linker::revUserTools( $revision, !$unhide );
1371 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
1372 ? 'revision-info-current'
1373 : 'revision-info';
1375 $outputPage = $this->getContext()->getOutput();
1376 $outputPage->addSubtitle( "<div id=\"mw-{$infomsg}\">" . wfMessage( $infomsg,
1377 $td )->rawParams( $userlinks )->params( $revision->getID(), $tddate,
1378 $tdtime, $revision->getUserText() )->rawParams( Linker::revComment( $revision, true, true ) )->parse() . "</div>" );
1380 $lnk = $current
1381 ? wfMessage( 'currentrevisionlink' )->escaped()
1382 : Linker::linkKnown(
1383 $this->getTitle(),
1384 wfMessage( 'currentrevisionlink' )->escaped(),
1385 array(),
1386 $extraParams
1388 $curdiff = $current
1389 ? wfMessage( 'diff' )->escaped()
1390 : Linker::linkKnown(
1391 $this->getTitle(),
1392 wfMessage( 'diff' )->escaped(),
1393 array(),
1394 array(
1395 'diff' => 'cur',
1396 'oldid' => $oldid
1397 ) + $extraParams
1399 $prev = $this->getTitle()->getPreviousRevisionID( $oldid );
1400 $prevlink = $prev
1401 ? Linker::linkKnown(
1402 $this->getTitle(),
1403 wfMessage( 'previousrevision' )->escaped(),
1404 array(),
1405 array(
1406 'direction' => 'prev',
1407 'oldid' => $oldid
1408 ) + $extraParams
1410 : wfMessage( 'previousrevision' )->escaped();
1411 $prevdiff = $prev
1412 ? Linker::linkKnown(
1413 $this->getTitle(),
1414 wfMessage( 'diff' )->escaped(),
1415 array(),
1416 array(
1417 'diff' => 'prev',
1418 'oldid' => $oldid
1419 ) + $extraParams
1421 : wfMessage( 'diff' )->escaped();
1422 $nextlink = $current
1423 ? wfMessage( 'nextrevision' )->escaped()
1424 : Linker::linkKnown(
1425 $this->getTitle(),
1426 wfMessage( 'nextrevision' )->escaped(),
1427 array(),
1428 array(
1429 'direction' => 'next',
1430 'oldid' => $oldid
1431 ) + $extraParams
1433 $nextdiff = $current
1434 ? wfMessage( 'diff' )->escaped()
1435 : Linker::linkKnown(
1436 $this->getTitle(),
1437 wfMessage( 'diff' )->escaped(),
1438 array(),
1439 array(
1440 'diff' => 'next',
1441 'oldid' => $oldid
1442 ) + $extraParams
1445 $cdel = Linker::getRevDeleteLink( $user, $revision, $this->getTitle() );
1446 if ( $cdel !== '' ) {
1447 $cdel .= ' ';
1450 $outputPage->addSubtitle( "<div id=\"mw-revision-nav\">" . $cdel .
1451 wfMessage( 'revision-nav' )->rawParams(
1452 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff
1453 )->escaped() . "</div>" );
1457 * Return the HTML for the top of a redirect page
1459 * Chances are you should just be using the ParserOutput from
1460 * WikitextContent::getParserOutput instead of calling this for redirects.
1462 * @param Title|array $target Destination(s) to redirect
1463 * @param bool $appendSubtitle [optional]
1464 * @param bool $forceKnown Should the image be shown as a bluelink regardless of existence?
1465 * @return string Containing HTML with redirect link
1467 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1468 $lang = $this->getTitle()->getPageLanguage();
1469 $out = $this->getContext()->getOutput();
1470 if ( $appendSubtitle ) {
1471 $out->addSubtitle( wfMessage( 'redirectpagesub' )->parse() );
1473 $out->addModuleStyles( 'mediawiki.action.view.redirectPage' );
1474 return static::getRedirectHeaderHtml( $lang, $target, $forceKnown );
1478 * Return the HTML for the top of a redirect page
1480 * Chances are you should just be using the ParserOutput from
1481 * WikitextContent::getParserOutput instead of calling this for redirects.
1483 * @since 1.23
1484 * @param Language $lang
1485 * @param Title|array $target Destination(s) to redirect
1486 * @param bool $forceKnown Should the image be shown as a bluelink regardless of existence?
1487 * @return string Containing HTML with redirect link
1489 public static function getRedirectHeaderHtml( Language $lang, $target, $forceKnown = false ) {
1490 if ( !is_array( $target ) ) {
1491 $target = array( $target );
1494 $html = '<ul class="redirectText">';
1495 /** @var Title $title */
1496 foreach ( $target as $title ) {
1497 $html .= '<li>' . Linker::link(
1498 $title,
1499 htmlspecialchars( $title->getFullText() ),
1500 array(),
1501 // Automatically append redirect=no to each link, since most of them are
1502 // redirect pages themselves.
1503 array( 'redirect' => 'no' ),
1504 ( $forceKnown ? array( 'known', 'noclasses' ) : array() )
1505 ) . '</li>';
1508 $redirectToText = wfMessage( 'redirectto' )->inLanguage( $lang )->text();
1510 return '<div class="redirectMsg">' .
1511 '<p>' . $redirectToText . '</p>' .
1512 $html .
1513 '</div>';
1517 * Handle action=render
1519 public function render() {
1520 $this->getContext()->getRequest()->response()->header( 'X-Robots-Tag: noindex' );
1521 $this->getContext()->getOutput()->setArticleBodyOnly( true );
1522 $this->getContext()->getOutput()->enableSectionEditLinks( false );
1523 $this->view();
1527 * action=protect handler
1529 public function protect() {
1530 $form = new ProtectionForm( $this );
1531 $form->execute();
1535 * action=unprotect handler (alias)
1537 public function unprotect() {
1538 $this->protect();
1542 * UI entry point for page deletion
1544 public function delete() {
1545 # This code desperately needs to be totally rewritten
1547 $title = $this->getTitle();
1548 $user = $this->getContext()->getUser();
1550 # Check permissions
1551 $permissionErrors = $title->getUserPermissionsErrors( 'delete', $user );
1552 if ( count( $permissionErrors ) ) {
1553 throw new PermissionsError( 'delete', $permissionErrors );
1556 # Read-only check...
1557 if ( wfReadOnly() ) {
1558 throw new ReadOnlyError;
1561 # Better double-check that it hasn't been deleted yet!
1562 $this->mPage->loadPageData( 'fromdbmaster' );
1563 if ( !$this->mPage->exists() ) {
1564 $deleteLogPage = new LogPage( 'delete' );
1565 $outputPage = $this->getContext()->getOutput();
1566 $outputPage->setPageTitle( wfMessage( 'cannotdelete-title', $title->getPrefixedText() ) );
1567 $outputPage->wrapWikiMsg( "<div class=\"error mw-error-cannotdelete\">\n$1\n</div>",
1568 array( 'cannotdelete', wfEscapeWikiText( $title->getPrefixedText() ) )
1570 $outputPage->addHTML(
1571 Xml::element( 'h2', null, $deleteLogPage->getName()->text() )
1573 LogEventsList::showLogExtract(
1574 $outputPage,
1575 'delete',
1576 $title
1579 return;
1582 $request = $this->getContext()->getRequest();
1583 $deleteReasonList = $request->getText( 'wpDeleteReasonList', 'other' );
1584 $deleteReason = $request->getText( 'wpReason' );
1586 if ( $deleteReasonList == 'other' ) {
1587 $reason = $deleteReason;
1588 } elseif ( $deleteReason != '' ) {
1589 // Entry from drop down menu + additional comment
1590 $colonseparator = wfMessage( 'colon-separator' )->inContentLanguage()->text();
1591 $reason = $deleteReasonList . $colonseparator . $deleteReason;
1592 } else {
1593 $reason = $deleteReasonList;
1596 if ( $request->wasPosted() && $user->matchEditToken( $request->getVal( 'wpEditToken' ),
1597 array( 'delete', $this->getTitle()->getPrefixedText() ) )
1599 # Flag to hide all contents of the archived revisions
1600 $suppress = $request->getVal( 'wpSuppress' ) && $user->isAllowed( 'suppressrevision' );
1602 $this->doDelete( $reason, $suppress );
1604 WatchAction::doWatchOrUnwatch( $request->getCheck( 'wpWatch' ), $title, $user );
1606 return;
1609 // Generate deletion reason
1610 $hasHistory = false;
1611 if ( !$reason ) {
1612 try {
1613 $reason = $this->generateReason( $hasHistory );
1614 } catch ( MWException $e ) {
1615 # if a page is horribly broken, we still want to be able to
1616 # delete it. So be lenient about errors here.
1617 wfDebug( "Error while building auto delete summary: $e" );
1618 $reason = '';
1622 // If the page has a history, insert a warning
1623 if ( $hasHistory ) {
1624 $title = $this->getTitle();
1626 // The following can use the real revision count as this is only being shown for users that can delete
1627 // this page.
1628 // This, as a side-effect, also makes sure that the following query isn't being run for pages with a
1629 // larger history, unless the user has the 'bigdelete' right (and is about to delete this page).
1630 $dbr = wfGetDB( DB_SLAVE );
1631 $revisions = $edits = (int)$dbr->selectField(
1632 'revision',
1633 'COUNT(rev_page)',
1634 array( 'rev_page' => $title->getArticleID() ),
1635 __METHOD__
1638 // @todo FIXME: i18n issue/patchwork message
1639 $this->getContext()->getOutput()->addHTML( '<strong class="mw-delete-warning-revisions">' .
1640 wfMessage( 'historywarning' )->numParams( $revisions )->parse() .
1641 wfMessage( 'word-separator' )->plain() . Linker::linkKnown( $title,
1642 wfMessage( 'history' )->escaped(),
1643 array( 'rel' => 'archives' ),
1644 array( 'action' => 'history' ) ) .
1645 '</strong>'
1648 if ( $title->isBigDeletion() ) {
1649 global $wgDeleteRevisionsLimit;
1650 $this->getContext()->getOutput()->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1651 array(
1652 'delete-warning-toobig',
1653 $this->getContext()->getLanguage()->formatNum( $wgDeleteRevisionsLimit )
1659 $this->confirmDelete( $reason );
1663 * Output deletion confirmation dialog
1664 * @todo FIXME: Move to another file?
1665 * @param string $reason Prefilled reason
1667 public function confirmDelete( $reason ) {
1668 wfDebug( "Article::confirmDelete\n" );
1670 $title = $this->getTitle();
1671 $outputPage = $this->getContext()->getOutput();
1672 $outputPage->setPageTitle( wfMessage( 'delete-confirm', $title->getPrefixedText() ) );
1673 $outputPage->addBacklinkSubtitle( $title );
1674 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1675 $backlinkCache = $title->getBacklinkCache();
1676 if ( $backlinkCache->hasLinks( 'pagelinks' ) || $backlinkCache->hasLinks( 'templatelinks' ) ) {
1677 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1678 'deleting-backlinks-warning' );
1680 $outputPage->addWikiMsg( 'confirmdeletetext' );
1682 wfRunHooks( 'ArticleConfirmDelete', array( $this, $outputPage, &$reason ) );
1684 $user = $this->getContext()->getUser();
1686 if ( $user->isAllowed( 'suppressrevision' ) ) {
1687 $suppress = "<tr id=\"wpDeleteSuppressRow\">
1688 <td></td>
1689 <td class='mw-input'><strong>" .
1690 Xml::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
1691 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
1692 "</strong></td>
1693 </tr>";
1694 } else {
1695 $suppress = '';
1697 $checkWatch = $user->getBoolOption( 'watchdeletion' ) || $user->isWatched( $title );
1699 $form = Xml::openElement( 'form', array( 'method' => 'post',
1700 'action' => $title->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
1701 Xml::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
1702 Xml::tags( 'legend', null, wfMessage( 'delete-legend' )->escaped() ) .
1703 Xml::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
1704 "<tr id=\"wpDeleteReasonListRow\">
1705 <td class='mw-label'>" .
1706 Xml::label( wfMessage( 'deletecomment' )->text(), 'wpDeleteReasonList' ) .
1707 "</td>
1708 <td class='mw-input'>" .
1709 Xml::listDropDown(
1710 'wpDeleteReasonList',
1711 wfMessage( 'deletereason-dropdown' )->inContentLanguage()->text(),
1712 wfMessage( 'deletereasonotherlist' )->inContentLanguage()->text(),
1714 'wpReasonDropDown',
1717 "</td>
1718 </tr>
1719 <tr id=\"wpDeleteReasonRow\">
1720 <td class='mw-label'>" .
1721 Xml::label( wfMessage( 'deleteotherreason' )->text(), 'wpReason' ) .
1722 "</td>
1723 <td class='mw-input'>" .
1724 Html::input( 'wpReason', $reason, 'text', array(
1725 'size' => '60',
1726 'maxlength' => '255',
1727 'tabindex' => '2',
1728 'id' => 'wpReason',
1729 'autofocus'
1730 ) ) .
1731 "</td>
1732 </tr>";
1734 # Disallow watching if user is not logged in
1735 if ( $user->isLoggedIn() ) {
1736 $form .= "
1737 <tr>
1738 <td></td>
1739 <td class='mw-input'>" .
1740 Xml::checkLabel( wfMessage( 'watchthis' )->text(),
1741 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
1742 "</td>
1743 </tr>";
1746 $form .= "
1747 $suppress
1748 <tr>
1749 <td></td>
1750 <td class='mw-submit'>" .
1751 Xml::submitButton( wfMessage( 'deletepage' )->text(),
1752 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
1753 "</td>
1754 </tr>" .
1755 Xml::closeElement( 'table' ) .
1756 Xml::closeElement( 'fieldset' ) .
1757 Html::hidden(
1758 'wpEditToken',
1759 $user->getEditToken( array( 'delete', $title->getPrefixedText() ) )
1761 Xml::closeElement( 'form' );
1763 if ( $user->isAllowed( 'editinterface' ) ) {
1764 $dropdownTitle = Title::makeTitle( NS_MEDIAWIKI, 'Deletereason-dropdown' );
1765 $link = Linker::link(
1766 $dropdownTitle,
1767 wfMessage( 'delete-edit-reasonlist' )->escaped(),
1768 array(),
1769 array( 'action' => 'edit' )
1771 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
1774 $outputPage->addHTML( $form );
1776 $deleteLogPage = new LogPage( 'delete' );
1777 $outputPage->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) );
1778 LogEventsList::showLogExtract( $outputPage, 'delete', $title );
1782 * Perform a deletion and output success or failure messages
1783 * @param string $reason
1784 * @param bool $suppress
1786 public function doDelete( $reason, $suppress = false ) {
1787 $error = '';
1788 $outputPage = $this->getContext()->getOutput();
1789 $status = $this->mPage->doDeleteArticleReal( $reason, $suppress, 0, true, $error );
1791 if ( $status->isGood() ) {
1792 $deleted = $this->getTitle()->getPrefixedText();
1794 $outputPage->setPageTitle( wfMessage( 'actioncomplete' ) );
1795 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1797 $loglink = '[[Special:Log/delete|' . wfMessage( 'deletionlog' )->text() . ']]';
1799 $outputPage->addWikiMsg( 'deletedtext', wfEscapeWikiText( $deleted ), $loglink );
1800 $outputPage->returnToMain( false );
1801 } else {
1802 $outputPage->setPageTitle(
1803 wfMessage( 'cannotdelete-title',
1804 $this->getTitle()->getPrefixedText() )
1807 if ( $error == '' ) {
1808 $outputPage->addWikiText(
1809 "<div class=\"error mw-error-cannotdelete\">\n" . $status->getWikiText() . "\n</div>"
1811 $deleteLogPage = new LogPage( 'delete' );
1812 $outputPage->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) );
1814 LogEventsList::showLogExtract(
1815 $outputPage,
1816 'delete',
1817 $this->getTitle()
1819 } else {
1820 $outputPage->addHTML( $error );
1825 /* Caching functions */
1828 * checkLastModified returns true if it has taken care of all
1829 * output to the client that is necessary for this request.
1830 * (that is, it has sent a cached version of the page)
1832 * @return bool True if cached version send, false otherwise
1834 protected function tryFileCache() {
1835 static $called = false;
1837 if ( $called ) {
1838 wfDebug( "Article::tryFileCache(): called twice!?\n" );
1839 return false;
1842 $called = true;
1843 if ( $this->isFileCacheable() ) {
1844 $cache = new HTMLFileCache( $this->getTitle(), 'view' );
1845 if ( $cache->isCacheGood( $this->mPage->getTouched() ) ) {
1846 wfDebug( "Article::tryFileCache(): about to load file\n" );
1847 $cache->loadFromFileCache( $this->getContext() );
1848 return true;
1849 } else {
1850 wfDebug( "Article::tryFileCache(): starting buffer\n" );
1851 ob_start( array( &$cache, 'saveToFileCache' ) );
1853 } else {
1854 wfDebug( "Article::tryFileCache(): not cacheable\n" );
1857 return false;
1861 * Check if the page can be cached
1862 * @return bool
1864 public function isFileCacheable() {
1865 $cacheable = false;
1867 if ( HTMLFileCache::useFileCache( $this->getContext() ) ) {
1868 $cacheable = $this->mPage->getID()
1869 && !$this->mRedirectedFrom && !$this->getTitle()->isRedirect();
1870 // Extension may have reason to disable file caching on some pages.
1871 if ( $cacheable ) {
1872 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
1876 return $cacheable;
1879 /**#@-*/
1882 * Lightweight method to get the parser output for a page, checking the parser cache
1883 * and so on. Doesn't consider most of the stuff that WikiPage::view is forced to
1884 * consider, so it's not appropriate to use there.
1886 * @since 1.16 (r52326) for LiquidThreads
1888 * @param int|null $oldid Revision ID or null
1889 * @param User $user The relevant user
1890 * @return ParserOutput|bool ParserOutput or false if the given revision ID is not found
1892 public function getParserOutput( $oldid = null, User $user = null ) {
1893 //XXX: bypasses mParserOptions and thus setParserOptions()
1895 if ( $user === null ) {
1896 $parserOptions = $this->getParserOptions();
1897 } else {
1898 $parserOptions = $this->mPage->makeParserOptions( $user );
1901 return $this->mPage->getParserOutput( $parserOptions, $oldid );
1905 * Override the ParserOptions used to render the primary article wikitext.
1907 * @param ParserOptions $options
1908 * @throws MWException If the parser options where already initialized.
1910 public function setParserOptions( ParserOptions $options ) {
1911 if ( $this->mParserOptions ) {
1912 throw new MWException( "can't change parser options after they have already been set" );
1915 // clone, so if $options is modified later, it doesn't confuse the parser cache.
1916 $this->mParserOptions = clone $options;
1920 * Get parser options suitable for rendering the primary article wikitext
1921 * @return ParserOptions
1923 public function getParserOptions() {
1924 if ( !$this->mParserOptions ) {
1925 $this->mParserOptions = $this->mPage->makeParserOptions( $this->getContext() );
1927 // Clone to allow modifications of the return value without affecting cache
1928 return clone $this->mParserOptions;
1932 * Sets the context this Article is executed in
1934 * @param IContextSource $context
1935 * @since 1.18
1937 public function setContext( $context ) {
1938 $this->mContext = $context;
1942 * Gets the context this Article is executed in
1944 * @return IContextSource
1945 * @since 1.18
1947 public function getContext() {
1948 if ( $this->mContext instanceof IContextSource ) {
1949 return $this->mContext;
1950 } else {
1951 wfDebug( __METHOD__ . " called and \$mContext is null. " .
1952 "Return RequestContext::getMain(); for sanity\n" );
1953 return RequestContext::getMain();
1958 * Use PHP's magic __get handler to handle accessing of
1959 * raw WikiPage fields for backwards compatibility.
1961 * @param string $fname Field name
1962 * @return mixed
1964 public function __get( $fname ) {
1965 if ( property_exists( $this->mPage, $fname ) ) {
1966 #wfWarn( "Access to raw $fname field " . __CLASS__ );
1967 return $this->mPage->$fname;
1969 trigger_error( 'Inaccessible property via __get(): ' . $fname, E_USER_NOTICE );
1973 * Use PHP's magic __set handler to handle setting of
1974 * raw WikiPage fields for backwards compatibility.
1976 * @param string $fname Field name
1977 * @param mixed $fvalue New value
1979 public function __set( $fname, $fvalue ) {
1980 if ( property_exists( $this->mPage, $fname ) ) {
1981 #wfWarn( "Access to raw $fname field of " . __CLASS__ );
1982 $this->mPage->$fname = $fvalue;
1983 // Note: extensions may want to toss on new fields
1984 } elseif ( !in_array( $fname, array( 'mContext', 'mPage' ) ) ) {
1985 $this->mPage->$fname = $fvalue;
1986 } else {
1987 trigger_error( 'Inaccessible property via __set(): ' . $fname, E_USER_NOTICE );
1992 * Use PHP's magic __call handler to transform instance calls to
1993 * WikiPage functions for backwards compatibility.
1995 * @param string $fname Name of called method
1996 * @param array $args Arguments to the method
1997 * @return mixed
1999 public function __call( $fname, $args ) {
2000 if ( is_callable( array( $this->mPage, $fname ) ) ) {
2001 #wfWarn( "Call to " . __CLASS__ . "::$fname; please use WikiPage instead" );
2002 return call_user_func_array( array( $this->mPage, $fname ), $args );
2004 trigger_error( 'Inaccessible function via __call(): ' . $fname, E_USER_ERROR );
2007 // ****** B/C functions to work-around PHP silliness with __call and references ****** //
2010 * @param array $limit
2011 * @param array $expiry
2012 * @param bool $cascade
2013 * @param string $reason
2014 * @param User $user
2015 * @return Status
2017 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade,
2018 $reason, User $user
2020 return $this->mPage->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user );
2024 * @param array $limit
2025 * @param string $reason
2026 * @param int $cascade
2027 * @param array $expiry
2028 * @return bool
2030 public function updateRestrictions( $limit = array(), $reason = '',
2031 &$cascade = 0, $expiry = array()
2033 return $this->mPage->doUpdateRestrictions(
2034 $limit,
2035 $expiry,
2036 $cascade,
2037 $reason,
2038 $this->getContext()->getUser()
2043 * @param string $reason
2044 * @param bool $suppress
2045 * @param int $id
2046 * @param bool $commit
2047 * @param string $error
2048 * @return bool
2050 public function doDeleteArticle( $reason, $suppress = false, $id = 0,
2051 $commit = true, &$error = ''
2053 return $this->mPage->doDeleteArticle( $reason, $suppress, $id, $commit, $error );
2057 * @param string $fromP
2058 * @param string $summary
2059 * @param string $token
2060 * @param bool $bot
2061 * @param array $resultDetails
2062 * @param User|null $user
2063 * @return array
2065 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails, User $user = null ) {
2066 $user = is_null( $user ) ? $this->getContext()->getUser() : $user;
2067 return $this->mPage->doRollback( $fromP, $summary, $token, $bot, $resultDetails, $user );
2071 * @param string $fromP
2072 * @param string $summary
2073 * @param bool $bot
2074 * @param array $resultDetails
2075 * @param User|null $guser
2076 * @return array
2078 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser = null ) {
2079 $guser = is_null( $guser ) ? $this->getContext()->getUser() : $guser;
2080 return $this->mPage->commitRollback( $fromP, $summary, $bot, $resultDetails, $guser );
2084 * @param bool $hasHistory
2085 * @return mixed
2087 public function generateReason( &$hasHistory ) {
2088 $title = $this->mPage->getTitle();
2089 $handler = ContentHandler::getForTitle( $title );
2090 return $handler->getAutoDeleteReason( $title, $hasHistory );
2093 // ****** B/C functions for static methods ( __callStatic is PHP>=5.3 ) ****** //
2096 * @return array
2098 * @deprecated since 1.24, use WikiPage::selectFields() instead
2100 public static function selectFields() {
2101 wfDeprecated( __METHOD__, '1.24' );
2102 return WikiPage::selectFields();
2106 * @param Title $title
2108 * @deprecated since 1.24, use WikiPage::onArticleCreate() instead
2110 public static function onArticleCreate( $title ) {
2111 wfDeprecated( __METHOD__, '1.24' );
2112 WikiPage::onArticleCreate( $title );
2116 * @param Title $title
2118 * @deprecated since 1.24, use WikiPage::onArticleDelete() instead
2120 public static function onArticleDelete( $title ) {
2121 wfDeprecated( __METHOD__, '1.24' );
2122 WikiPage::onArticleDelete( $title );
2126 * @param Title $title
2128 * @deprecated since 1.24, use WikiPage::onArticleEdit() instead
2130 public static function onArticleEdit( $title ) {
2131 wfDeprecated( __METHOD__, '1.24' );
2132 WikiPage::onArticleEdit( $title );
2136 * @param string $oldtext
2137 * @param string $newtext
2138 * @param int $flags
2139 * @return string
2140 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
2142 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2143 return WikiPage::getAutosummary( $oldtext, $newtext, $flags );
2145 // ******