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
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
extends Page
{
42 * The context this Article is executed in
43 * @var IContextSource $mContext
48 * The WikiPage object of this instance
49 * @var WikiPage $mPage
54 * ParserOptions object for $wgUser articles
55 * @var ParserOptions $mParserOptions
57 public $mParserOptions;
60 * Text of the revision we are working on
61 * @var string $mContent
63 var $mContent; // !< #BC cruft
66 * Content of the revision we are working on
70 var $mContentObject; // !<
73 * Is the content ($mContent) already loaded?
74 * @var bool $mContentLoaded
76 var $mContentLoaded = false; // !<
79 * The oldid of the article that is to be shown, 0 for the
81 * @var int|null $mOldId
86 * Title from which we were redirected here
87 * @var Title $mRedirectedFrom
89 var $mRedirectedFrom = null;
92 * URL to redirect to or false if none
93 * @var string|false $mRedirectUrl
95 var $mRedirectUrl = false; // !<
98 * Revision ID of revision we are working on
99 * @var int $mRevIdFetched
101 var $mRevIdFetched = 0; // !<
104 * Revision we are working on
105 * @var Revision $mRevision
107 var $mRevision = null;
110 * ParserOutput object
111 * @var ParserOutput $mParserOutput
118 * Constructor and clear the article
119 * @param $title Title Reference to a Title object.
120 * @param $oldId Integer revision ID, null to fetch from request, zero for current
122 public function __construct( Title
$title, $oldId = null ) {
123 $this->mOldId
= $oldId;
124 $this->mPage
= $this->newPage( $title );
128 * @param $title Title
131 protected function newPage( Title
$title ) {
132 return new WikiPage( $title );
136 * Constructor from a page id
137 * @param $id Int article ID to load
138 * @return Article|null
140 public static function newFromID( $id ) {
141 $t = Title
::newFromID( $id );
142 # @todo FIXME: Doesn't inherit right
143 return $t == null ?
null : new self( $t );
144 # return $t == null ? null : new static( $t ); // PHP 5.3
148 * Create an Article object of the appropriate class for the given page.
150 * @param $title Title
151 * @param $context IContextSource
152 * @return Article object
154 public static function newFromTitle( $title, IContextSource
$context ) {
155 if ( NS_MEDIA
== $title->getNamespace() ) {
156 // FIXME: where should this go?
157 $title = Title
::makeTitle( NS_FILE
, $title->getDBkey() );
161 wfRunHooks( 'ArticleFromTitle', array( &$title, &$page ) );
163 switch( $title->getNamespace() ) {
165 $page = new ImagePage( $title );
168 $page = new CategoryPage( $title );
171 $page = new Article( $title );
174 $page->setContext( $context );
180 * Create an Article object of the appropriate class for the given page.
182 * @param $page WikiPage
183 * @param $context IContextSource
184 * @return Article object
186 public static function newFromWikiPage( WikiPage
$page, IContextSource
$context ) {
187 $article = self
::newFromTitle( $page->getTitle(), $context );
188 $article->mPage
= $page; // override to keep process cached vars
193 * Tell the page view functions that this view was redirected
194 * from another page on the wiki.
195 * @param $from Title object.
197 public function setRedirectedFrom( Title
$from ) {
198 $this->mRedirectedFrom
= $from;
202 * Get the title object of the article
204 * @return Title object of this page
206 public function getTitle() {
207 return $this->mPage
->getTitle();
211 * Get the WikiPage object of this instance
216 public function getPage() {
223 public function clear() {
224 $this->mContentLoaded
= false;
226 $this->mRedirectedFrom
= null; # Title object if set
227 $this->mRevIdFetched
= 0;
228 $this->mRedirectUrl
= false;
230 $this->mPage
->clear();
234 * Note that getContent/loadContent do not follow redirects anymore.
235 * If you need to fetch redirectable content easily, try
236 * the shortcut in WikiPage::getRedirectTarget()
238 * This function has side effects! Do not use this function if you
239 * only want the real revision text if any.
241 * @deprecated in 1.21; use WikiPage::getContent() instead
243 * @return string Return the text of this revision
245 public function getContent() {
246 ContentHandler
::deprecated( __METHOD__
, '1.21' );
247 $content = $this->getContentObject();
248 return ContentHandler
::getContentText( $content );
252 * Returns a Content object representing the pages effective display content,
253 * not necessarily the revision's content!
255 * Note that getContent/loadContent do not follow redirects anymore.
256 * If you need to fetch redirectable content easily, try
257 * the shortcut in WikiPage::getRedirectTarget()
259 * This function has side effects! Do not use this function if you
260 * only want the real revision text if any.
262 * @return Content Return the content of this revision
266 protected function getContentObject() {
267 wfProfileIn( __METHOD__
);
269 if ( $this->mPage
->getID() === 0 ) {
270 # If this is a MediaWiki:x message, then load the messages
271 # and return the message value for x.
272 if ( $this->getTitle()->getNamespace() == NS_MEDIAWIKI
) {
273 $text = $this->getTitle()->getDefaultMessageText();
274 if ( $text === false ) {
278 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
280 $message = $this->getContext()->getUser()->isLoggedIn() ?
'noarticletext' : 'noarticletextanon';
281 $content = new MessageContent( $message, null, 'parsemag' );
283 wfProfileOut( __METHOD__
);
287 $this->fetchContentObject();
288 wfProfileOut( __METHOD__
);
290 return $this->mContentObject
;
295 * @return int The oldid of the article that is to be shown, 0 for the
298 public function getOldID() {
299 if ( is_null( $this->mOldId
) ) {
300 $this->mOldId
= $this->getOldIDFromRequest();
303 return $this->mOldId
;
307 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
309 * @return int The old id for the request
311 public function getOldIDFromRequest() {
312 $this->mRedirectUrl
= false;
314 $request = $this->getContext()->getRequest();
315 $oldid = $request->getIntOrNull( 'oldid' );
317 if ( $oldid === null ) {
321 if ( $oldid !== 0 ) {
322 # Load the given revision and check whether the page is another one.
323 # In that case, update this instance to reflect the change.
324 if ( $oldid === $this->mPage
->getLatest() ) {
325 $this->mRevision
= $this->mPage
->getRevision();
327 $this->mRevision
= Revision
::newFromId( $oldid );
328 if ( $this->mRevision
!== null ) {
329 // Revision title doesn't match the page title given?
330 if ( $this->mPage
->getID() != $this->mRevision
->getPage() ) {
331 $function = array( get_class( $this->mPage
), 'newFromID' );
332 $this->mPage
= call_user_func( $function, $this->mRevision
->getPage() );
338 if ( $request->getVal( 'direction' ) == 'next' ) {
339 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
342 $this->mRevision
= null;
344 $this->mRedirectUrl
= $this->getTitle()->getFullURL( 'redirect=no' );
346 } elseif ( $request->getVal( 'direction' ) == 'prev' ) {
347 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
350 $this->mRevision
= null;
358 * Load the revision (including text) into this object
360 * @deprecated in 1.19; use fetchContent()
362 function loadContent() {
363 wfDeprecated( __METHOD__
, '1.19' );
364 $this->fetchContent();
368 * Get text of an article from database
369 * Does *NOT* follow redirects.
372 * @note this is really internal functionality that should really NOT be used by other functions. For accessing
373 * article content, use the WikiPage class, especially WikiBase::getContent(). However, a lot of legacy code
374 * uses this method to retrieve page text from the database, so the function has to remain public for now.
376 * @return mixed string containing article contents, or false if null
377 * @deprecated in 1.21, use WikiPage::getContent() instead
379 function fetchContent() { #BC cruft!
380 ContentHandler
::deprecated( __METHOD__
, '1.21' );
382 if ( $this->mContentLoaded
&& $this->mContent
) {
383 return $this->mContent
;
386 wfProfileIn( __METHOD__
);
388 $content = $this->fetchContentObject();
390 $this->mContent
= ContentHandler
::getContentText( $content ); #@todo: get rid of mContent everywhere!
391 ContentHandler
::runLegacyHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
393 wfProfileOut( __METHOD__
);
395 return $this->mContent
;
400 * Get text content object
401 * Does *NOT* follow redirects.
402 * TODO: when is this null?
404 * @note code that wants to retrieve page content from the database should use WikiPage::getContent().
406 * @return Content|null
410 protected function fetchContentObject() {
411 if ( $this->mContentLoaded
) {
412 return $this->mContentObject
;
415 wfProfileIn( __METHOD__
);
417 $this->mContentLoaded
= true;
418 $this->mContent
= null;
420 $oldid = $this->getOldID();
422 # Pre-fill content with error message so that if something
423 # fails we'll have something telling us what we intended.
424 //XXX: this isn't page content but a UI message. horrible.
425 $this->mContentObject
= new MessageContent( 'missing-revision', array( $oldid ), array() ) ;
428 # $this->mRevision might already be fetched by getOldIDFromRequest()
429 if ( !$this->mRevision
) {
430 $this->mRevision
= Revision
::newFromId( $oldid );
431 if ( !$this->mRevision
) {
432 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
433 wfProfileOut( __METHOD__
);
438 if ( !$this->mPage
->getLatest() ) {
439 wfDebug( __METHOD__
. " failed to find page data for title " . $this->getTitle()->getPrefixedText() . "\n" );
440 wfProfileOut( __METHOD__
);
444 $this->mRevision
= $this->mPage
->getRevision();
446 if ( !$this->mRevision
) {
447 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id " . $this->mPage
->getLatest() . "\n" );
448 wfProfileOut( __METHOD__
);
453 // @todo FIXME: Horrible, horrible! This content-loading interface just plain sucks.
454 // We should instead work with the Revision object when we need it...
455 $this->mContentObject
= $this->mRevision
->getContent( Revision
::FOR_THIS_USER
, $this->getContext()->getUser() ); // Loads if user is allowed
456 $this->mRevIdFetched
= $this->mRevision
->getId();
458 wfRunHooks( 'ArticleAfterFetchContentObject', array( &$this, &$this->mContentObject
) );
460 wfProfileOut( __METHOD__
);
462 return $this->mContentObject
;
467 * @deprecated since 1.18
469 public function forUpdate() {
470 wfDeprecated( __METHOD__
, '1.18' );
474 * Returns true if the currently-referenced revision is the current edit
475 * to this page (and it exists).
478 public function isCurrent() {
479 # If no oldid, this is the current version.
480 if ( $this->getOldID() == 0 ) {
484 return $this->mPage
->exists() && $this->mRevision
&& $this->mRevision
->isCurrent();
488 * Get the fetched Revision object depending on request parameters or null
492 * @return Revision|null
494 public function getRevisionFetched() {
495 $this->fetchContentObject();
497 return $this->mRevision
;
501 * Use this to fetch the rev ID used on page views
503 * @return int revision ID of last article revision
505 public function getRevIdFetched() {
506 if ( $this->mRevIdFetched
) {
507 return $this->mRevIdFetched
;
509 return $this->mPage
->getLatest();
514 * This is the default action of the index.php entry point: just view the
515 * page of the given title.
517 public function view() {
518 global $wgParser, $wgUseFileCache, $wgUseETag, $wgDebugToolbar;
520 wfProfileIn( __METHOD__
);
522 # Get variables from query string
523 # As side effect this will load the revision and update the title
524 # in a revision ID is passed in the request, so this should remain
525 # the first call of this method even if $oldid is used way below.
526 $oldid = $this->getOldID();
528 $user = $this->getContext()->getUser();
529 # Another whitelist check in case getOldID() is altering the title
530 $permErrors = $this->getTitle()->getUserPermissionsErrors( 'read', $user );
531 if ( count( $permErrors ) ) {
532 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
533 wfProfileOut( __METHOD__
);
534 throw new PermissionsError( 'read', $permErrors );
537 $outputPage = $this->getContext()->getOutput();
538 # getOldID() may as well want us to redirect somewhere else
539 if ( $this->mRedirectUrl
) {
540 $outputPage->redirect( $this->mRedirectUrl
);
541 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
542 wfProfileOut( __METHOD__
);
547 # If we got diff in the query, we want to see a diff page instead of the article.
548 if ( $this->getContext()->getRequest()->getCheck( 'diff' ) ) {
549 wfDebug( __METHOD__
. ": showing diff page\n" );
550 $this->showDiffPage();
551 wfProfileOut( __METHOD__
);
556 # Set page title (may be overridden by DISPLAYTITLE)
557 $outputPage->setPageTitle( $this->getTitle()->getPrefixedText() );
559 $outputPage->setArticleFlag( true );
560 # Allow frames by default
561 $outputPage->allowClickjacking();
563 $parserCache = ParserCache
::singleton();
565 $parserOptions = $this->getParserOptions();
566 # Render printable version, use printable version cache
567 if ( $outputPage->isPrintable() ) {
568 $parserOptions->setIsPrintable( true );
569 $parserOptions->setEditSection( false );
570 } elseif ( !$this->isCurrent() ||
!$this->getTitle()->quickUserCan( 'edit', $user ) ) {
571 $parserOptions->setEditSection( false );
574 # Try client and file cache
575 if ( !$wgDebugToolbar && $oldid === 0 && $this->mPage
->checkTouched() ) {
577 $outputPage->setETag( $parserCache->getETag( $this, $parserOptions ) );
580 # Is it client cached?
581 if ( $outputPage->checkLastModified( $this->mPage
->getTouched() ) ) {
582 wfDebug( __METHOD__
. ": done 304\n" );
583 wfProfileOut( __METHOD__
);
587 } elseif ( $wgUseFileCache && $this->tryFileCache() ) {
588 wfDebug( __METHOD__
. ": done file cache\n" );
589 # tell wgOut that output is taken care of
590 $outputPage->disable();
591 $this->mPage
->doViewUpdates( $user );
592 wfProfileOut( __METHOD__
);
598 # Should the parser cache be used?
599 $useParserCache = $this->mPage
->isParserCacheUsed( $parserOptions, $oldid );
600 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
601 if ( $user->getStubThreshold() ) {
602 wfIncrStats( 'pcache_miss_stub' );
605 $this->showRedirectedFromHeader();
606 $this->showNamespaceHeader();
608 # Iterate through the possible ways of constructing the output text.
609 # Keep going until $outputDone is set, or we run out of things to do.
612 $this->mParserOutput
= false;
614 while ( !$outputDone && ++
$pass ) {
617 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
620 # Early abort if the page doesn't exist
621 if ( !$this->mPage
->exists() ) {
622 wfDebug( __METHOD__
. ": showing missing article\n" );
623 $this->showMissingArticle();
624 wfProfileOut( __METHOD__
);
628 # Try the parser cache
629 if ( $useParserCache ) {
630 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
632 if ( $this->mParserOutput
!== false ) {
634 wfDebug( __METHOD__
. ": showing parser cache contents for current rev permalink\n" );
635 $this->setOldSubtitle( $oldid );
637 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
639 $outputPage->addParserOutput( $this->mParserOutput
);
640 # Ensure that UI elements requiring revision ID have
641 # the correct version information.
642 $outputPage->setRevisionId( $this->mPage
->getLatest() );
643 # Preload timestamp to avoid a DB hit
644 $cachedTimestamp = $this->mParserOutput
->getTimestamp();
645 if ( $cachedTimestamp !== null ) {
646 $outputPage->setRevisionTimestamp( $cachedTimestamp );
647 $this->mPage
->setTimestamp( $cachedTimestamp );
654 # This will set $this->mRevision if needed
655 $this->fetchContentObject();
657 # Are we looking at an old revision
658 if ( $oldid && $this->mRevision
) {
659 $this->setOldSubtitle( $oldid );
661 if ( !$this->showDeletedRevisionHeader() ) {
662 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
663 wfProfileOut( __METHOD__
);
668 # Ensure that UI elements requiring revision ID have
669 # the correct version information.
670 $outputPage->setRevisionId( $this->getRevIdFetched() );
671 # Preload timestamp to avoid a DB hit
672 $outputPage->setRevisionTimestamp( $this->getTimestamp() );
674 # Pages containing custom CSS or JavaScript get special treatment
675 if ( $this->getTitle()->isCssOrJsPage() ||
$this->getTitle()->isCssJsSubpage() ) {
676 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
677 $this->showCssOrJsPage();
679 } elseif( !wfRunHooks( 'ArticleContentViewCustom',
680 array( $this->fetchContentObject(), $this->getTitle(), $outputPage ) ) ) {
682 # Allow extensions do their own custom view for certain pages
684 } elseif( !ContentHandler
::runLegacyHooks( 'ArticleViewCustom',
685 array( $this->fetchContentObject(), $this->getTitle(), $outputPage ) ) ) {
687 # Allow extensions do their own custom view for certain pages
690 $content = $this->getContentObject();
691 $rt = $content ?
$content->getRedirectChain() : null;
693 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
694 # Viewing a redirect page (e.g. with parameter redirect=no)
695 $outputPage->addHTML( $this->viewRedirect( $rt ) );
696 # Parse just to get categories, displaytitle, etc.
697 $this->mParserOutput
= $content->getParserOutput( $this->getTitle(), $oldid, $parserOptions, false );
698 $outputPage->addParserOutputNoText( $this->mParserOutput
);
704 # Run the parse, protected by a pool counter
705 wfDebug( __METHOD__
. ": doing uncached parse\n" );
707 // @todo: shouldn't we be passing $this->getPage() to PoolWorkArticleView instead of plain $this?
708 $poolArticleView = new PoolWorkArticleView( $this, $parserOptions,
709 $this->getRevIdFetched(), $useParserCache, $this->getContentObject(), $this->getContext() );
711 if ( !$poolArticleView->execute() ) {
712 $error = $poolArticleView->getError();
714 $outputPage->clearHTML(); // for release() errors
715 $outputPage->enableClientCache( false );
716 $outputPage->setRobotPolicy( 'noindex,nofollow' );
718 $errortext = $error->getWikiText( false, 'view-pool-error' );
719 $outputPage->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );
721 # Connection or timeout error
722 wfProfileOut( __METHOD__
);
726 $this->mParserOutput
= $poolArticleView->getParserOutput();
727 $outputPage->addParserOutput( $this->mParserOutput
);
729 # Don't cache a dirty ParserOutput object
730 if ( $poolArticleView->getIsDirty() ) {
731 $outputPage->setSquidMaxage( 0 );
732 $outputPage->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
737 # Should be unreachable, but just in case...
743 # Get the ParserOutput actually *displayed* here.
744 # Note that $this->mParserOutput is the *current* version output.
745 $pOutput = ( $outputDone instanceof ParserOutput
)
746 ?
$outputDone // object fetched by hook
747 : $this->mParserOutput
;
749 # Adjust title for main page & pages with displaytitle
751 $this->adjustDisplayTitle( $pOutput );
754 # For the main page, overwrite the <title> element with the con-
755 # tents of 'pagetitle-view-mainpage' instead of the default (if
757 # This message always exists because it is in the i18n files
758 if ( $this->getTitle()->isMainPage() ) {
759 $msg = wfMessage( 'pagetitle-view-mainpage' )->inContentLanguage();
760 if ( !$msg->isDisabled() ) {
761 $outputPage->setHTMLTitle( $msg->title( $this->getTitle() )->text() );
765 # Check for any __NOINDEX__ tags on the page using $pOutput
766 $policy = $this->getRobotPolicy( 'view', $pOutput );
767 $outputPage->setIndexPolicy( $policy['index'] );
768 $outputPage->setFollowPolicy( $policy['follow'] );
770 $this->showViewFooter();
771 $this->mPage
->doViewUpdates( $user );
773 wfProfileOut( __METHOD__
);
777 * Adjust title for pages with displaytitle, -{T|}- or language conversion
778 * @param $pOutput ParserOutput
780 public function adjustDisplayTitle( ParserOutput
$pOutput ) {
781 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
782 $titleText = $pOutput->getTitleText();
783 if ( strval( $titleText ) !== '' ) {
784 $this->getContext()->getOutput()->setPageTitle( $titleText );
789 * Show a diff page according to current request variables. For use within
790 * Article::view() only, other callers should use the DifferenceEngine class.
792 * @todo: make protected
794 public function showDiffPage() {
795 $request = $this->getContext()->getRequest();
796 $user = $this->getContext()->getUser();
797 $diff = $request->getVal( 'diff' );
798 $rcid = $request->getVal( 'rcid' );
799 $diffOnly = $request->getBool( 'diffonly', $user->getOption( 'diffonly' ) );
800 $purge = $request->getVal( 'action' ) == 'purge';
801 $unhide = $request->getInt( 'unhide' ) == 1;
802 $oldid = $this->getOldID();
804 $rev = $this->getRevisionFetched();
807 $this->getContext()->getOutput()->setPageTitle( wfMessage( 'errorpagetitle' ) );
808 $this->getContext()->getOutput()->addWikiMsg( 'difference-missing-revision', $oldid, 1 );
812 $contentHandler = $rev->getContentHandler();
813 $de = $contentHandler->createDifferenceEngine( $this->getContext(), $oldid, $diff, $rcid, $purge, $unhide );
815 // DifferenceEngine directly fetched the revision:
816 $this->mRevIdFetched
= $de->mNewid
;
817 $de->showDiffPage( $diffOnly );
819 if ( $diff == 0 ||
$diff == $this->mPage
->getLatest() ) {
820 # Run view updates for current revision only
821 $this->mPage
->doViewUpdates( $user );
826 * Show a page view for a page formatted as CSS or JavaScript. To be called by
827 * Article::view() only.
829 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
832 * @param bool $showCacheHint whether to show a message telling the user to clear the browser cache (default: true).
834 protected function showCssOrJsPage( $showCacheHint = true ) {
835 $outputPage = $this->getContext()->getOutput();
837 if ( $showCacheHint ) {
838 $dir = $this->getContext()->getLanguage()->getDir();
839 $lang = $this->getContext()->getLanguage()->getCode();
841 $outputPage->wrapWikiMsg( "<div id='mw-clearyourcache' lang='$lang' dir='$dir' class='mw-content-$dir'>\n$1\n</div>",
845 $this->fetchContentObject();
847 if ( $this->mContentObject
) {
848 // Give hooks a chance to customise the output
849 if ( ContentHandler
::runLegacyHooks( 'ShowRawCssJs', array( $this->mContentObject
, $this->getTitle(), $outputPage ) ) ) {
850 $po = $this->mContentObject
->getParserOutput( $this->getTitle() );
851 $outputPage->addHTML( $po->getText() );
857 * Get the robot policy to be used for the current view
858 * @param $action String the action= GET parameter
859 * @param $pOutput ParserOutput
860 * @return Array the policy that should be set
861 * TODO: actions other than 'view'
863 public function getRobotPolicy( $action, $pOutput ) {
864 global $wgArticleRobotPolicies, $wgNamespaceRobotPolicies, $wgDefaultRobotPolicy;
866 $ns = $this->getTitle()->getNamespace();
868 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
869 # Don't index user and user talk pages for blocked users (bug 11443)
870 if ( !$this->getTitle()->isSubpage() ) {
871 if ( Block
::newFromTarget( null, $this->getTitle()->getText() ) instanceof Block
) {
873 'index' => 'noindex',
874 'follow' => 'nofollow'
880 if ( $this->mPage
->getID() === 0 ||
$this->getOldID() ) {
881 # Non-articles (special pages etc), and old revisions
883 'index' => 'noindex',
884 'follow' => 'nofollow'
886 } elseif ( $this->getContext()->getOutput()->isPrintable() ) {
887 # Discourage indexing of printable versions, but encourage following
889 'index' => 'noindex',
892 } elseif ( $this->getContext()->getRequest()->getInt( 'curid' ) ) {
893 # For ?curid=x urls, disallow indexing
895 'index' => 'noindex',
900 # Otherwise, construct the policy based on the various config variables.
901 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
903 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
904 # Honour customised robot policies for this namespace
905 $policy = array_merge(
907 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
910 if ( $this->getTitle()->canUseNoindex() && is_object( $pOutput ) && $pOutput->getIndexPolicy() ) {
911 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
912 # a final sanity check that we have really got the parser output.
913 $policy = array_merge(
915 array( 'index' => $pOutput->getIndexPolicy() )
919 if ( isset( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] ) ) {
920 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
921 $policy = array_merge(
923 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] )
931 * Converts a String robot policy into an associative array, to allow
932 * merging of several policies using array_merge().
933 * @param $policy Mixed, returns empty array on null/false/'', transparent
934 * to already-converted arrays, converts String.
935 * @return Array: 'index' => \<indexpolicy\>, 'follow' => \<followpolicy\>
937 public static function formatRobotPolicy( $policy ) {
938 if ( is_array( $policy ) ) {
940 } elseif ( !$policy ) {
944 $policy = explode( ',', $policy );
945 $policy = array_map( 'trim', $policy );
948 foreach ( $policy as $var ) {
949 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
950 $arr['index'] = $var;
951 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
952 $arr['follow'] = $var;
960 * If this request is a redirect view, send "redirected from" subtitle to
961 * the output. Returns true if the header was needed, false if this is not
962 * a redirect view. Handles both local and remote redirects.
966 public function showRedirectedFromHeader() {
967 global $wgRedirectSources;
968 $outputPage = $this->getContext()->getOutput();
970 $rdfrom = $this->getContext()->getRequest()->getVal( 'rdfrom' );
972 if ( isset( $this->mRedirectedFrom
) ) {
973 // This is an internally redirected page view.
974 // We'll need a backlink to the source page for navigation.
975 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
976 $redir = Linker
::linkKnown(
977 $this->mRedirectedFrom
,
980 array( 'redirect' => 'no' )
983 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
985 // Set the fragment if one was specified in the redirect
986 if ( strval( $this->getTitle()->getFragment() ) != '' ) {
987 $fragment = Xml
::escapeJsString( $this->getTitle()->getFragmentForURL() );
988 $outputPage->addInlineScript( "redirectToFragment(\"$fragment\");" );
991 // Add a <link rel="canonical"> tag
992 $outputPage->addLink( array( 'rel' => 'canonical',
993 'href' => $this->getTitle()->getLocalURL() )
996 // Tell the output object that the user arrived at this article through a redirect
997 $outputPage->setRedirectedFrom( $this->mRedirectedFrom
);
1001 } elseif ( $rdfrom ) {
1002 // This is an externally redirected view, from some other wiki.
1003 // If it was reported from a trusted site, supply a backlink.
1004 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1005 $redir = Linker
::makeExternalLink( $rdfrom, $rdfrom );
1006 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
1016 * Show a header specific to the namespace currently being viewed, like
1017 * [[MediaWiki:Talkpagetext]]. For Article::view().
1019 public function showNamespaceHeader() {
1020 if ( $this->getTitle()->isTalkPage() ) {
1021 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1022 $this->getContext()->getOutput()->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1028 * Show the footer section of an ordinary page view
1030 public function showViewFooter() {
1031 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1032 if ( $this->getTitle()->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->getTitle()->getText() ) ) {
1033 $this->getContext()->getOutput()->addWikiMsg( 'anontalkpagetext' );
1036 # If we have been passed an &rcid= parameter, we want to give the user a
1037 # chance to mark this new article as patrolled.
1038 $this->showPatrolFooter();
1040 wfRunHooks( 'ArticleViewFooter', array( $this ) );
1045 * If patrol is possible, output a patrol UI box. This is called from the
1046 * footer section of ordinary page views. If patrol is not possible or not
1047 * desired, does nothing.
1049 public function showPatrolFooter() {
1050 $request = $this->getContext()->getRequest();
1051 $outputPage = $this->getContext()->getOutput();
1052 $user = $this->getContext()->getUser();
1053 $rcid = $request->getVal( 'rcid' );
1055 if ( !$rcid ||
!$this->getTitle()->quickUserCan( 'patrol', $user ) ) {
1059 $token = $user->getEditToken( $rcid );
1060 $outputPage->preventClickjacking();
1062 $link = Linker
::linkKnown(
1064 wfMessage( 'markaspatrolledtext' )->escaped(),
1067 'action' => 'markpatrolled',
1073 $outputPage->addHTML(
1074 "<div class='patrollink'>" .
1075 wfMessage( 'markaspatrolledlink' )->rawParams( $link )->escaped() .
1081 * Show the error text for a missing article. For articles in the MediaWiki
1082 * namespace, show the default message text. To be called from Article::view().
1084 public function showMissingArticle() {
1085 global $wgSend404Code;
1086 $outputPage = $this->getContext()->getOutput();
1088 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1089 if ( $this->getTitle()->getNamespace() == NS_USER ||
$this->getTitle()->getNamespace() == NS_USER_TALK
) {
1090 $parts = explode( '/', $this->getTitle()->getText() );
1091 $rootPart = $parts[0];
1092 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1093 $ip = User
::isIP( $rootPart );
1095 if ( !($user && $user->isLoggedIn()) && !$ip ) { # User does not exist
1096 $outputPage->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1097 array( 'userpage-userdoesnotexist-view', wfEscapeWikiText( $rootPart ) ) );
1098 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1099 LogEventsList
::showLogExtract(
1102 $user->getUserPage(),
1106 'showIfEmpty' => false,
1108 'blocked-notice-logextract',
1109 $user->getName() # Support GENDER in notice
1116 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1118 # Show delete and move logs
1119 LogEventsList
::showLogExtract( $outputPage, array( 'delete', 'move' ), $this->getTitle(), '',
1121 'conds' => array( "log_action != 'revision'" ),
1122 'showIfEmpty' => false,
1123 'msgKey' => array( 'moveddeleted-notice' ) )
1126 if ( !$this->mPage
->hasViewableContent() && $wgSend404Code ) {
1127 // If there's no backing content, send a 404 Not Found
1128 // for better machine handling of broken links.
1129 $this->getContext()->getRequest()->response()->header( "HTTP/1.1 404 Not Found" );
1132 $hookResult = wfRunHooks( 'BeforeDisplayNoArticleText', array( $this ) );
1134 if ( ! $hookResult ) {
1138 # Show error message
1139 $oldid = $this->getOldID();
1141 $text = wfMessage( 'missing-revision', $oldid )->plain();
1142 } elseif ( $this->getTitle()->getNamespace() === NS_MEDIAWIKI
) {
1143 // Use the default message text
1144 $text = $this->getTitle()->getDefaultMessageText();
1145 } elseif ( $this->getTitle()->quickUserCan( 'create', $this->getContext()->getUser() )
1146 && $this->getTitle()->quickUserCan( 'edit', $this->getContext()->getUser() )
1148 $text = wfMessage( 'noarticletext' )->plain();
1150 $text = wfMessage( 'noarticletext-nopermission' )->plain();
1152 $text = "<div class='noarticletext'>\n$text\n</div>";
1154 $outputPage->addWikiText( $text );
1158 * If the revision requested for view is deleted, check permissions.
1159 * Send either an error message or a warning header to the output.
1161 * @return boolean true if the view is allowed, false if not.
1163 public function showDeletedRevisionHeader() {
1164 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1169 $outputPage = $this->getContext()->getOutput();
1170 $user = $this->getContext()->getUser();
1171 // If the user is not allowed to see it...
1172 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1173 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1174 'rev-deleted-text-permission' );
1177 // If the user needs to confirm that they want to see it...
1178 } elseif ( $this->getContext()->getRequest()->getInt( 'unhide' ) != 1 ) {
1179 # Give explanation and add a link to view the revision...
1180 $oldid = intval( $this->getOldID() );
1181 $link = $this->getTitle()->getFullUrl( "oldid={$oldid}&unhide=1" );
1182 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1183 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1184 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1185 array( $msg, $link ) );
1188 // We are allowed to see...
1190 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1191 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1192 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1199 * Generate the navigation links when browsing through an article revisions
1200 * It shows the information as:
1201 * Revision as of \<date\>; view current revision
1202 * \<- Previous version | Next Version -\>
1204 * @param $oldid int: revision ID of this article revision
1206 public function setOldSubtitle( $oldid = 0 ) {
1207 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
1211 $unhide = $this->getContext()->getRequest()->getInt( 'unhide' ) == 1;
1213 # Cascade unhide param in links for easy deletion browsing
1214 $extraParams = array();
1216 $extraParams['unhide'] = 1;
1219 if ( $this->mRevision
&& $this->mRevision
->getId() === $oldid ) {
1220 $revision = $this->mRevision
;
1222 $revision = Revision
::newFromId( $oldid );
1225 $timestamp = $revision->getTimestamp();
1227 $current = ( $oldid == $this->mPage
->getLatest() );
1228 $language = $this->getContext()->getLanguage();
1229 $user = $this->getContext()->getUser();
1231 $td = $language->userTimeAndDate( $timestamp, $user );
1232 $tddate = $language->userDate( $timestamp, $user );
1233 $tdtime = $language->userTime( $timestamp, $user );
1235 # Show user links if allowed to see them. If hidden, then show them only if requested...
1236 $userlinks = Linker
::revUserTools( $revision, !$unhide );
1238 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
1239 ?
'revision-info-current'
1242 $outputPage = $this->getContext()->getOutput();
1243 $outputPage->addSubtitle( "<div id=\"mw-{$infomsg}\">" . wfMessage( $infomsg,
1244 $td )->rawParams( $userlinks )->params( $revision->getID(), $tddate,
1245 $tdtime, $revision->getUser() )->parse() . "</div>" );
1248 ?
wfMessage( 'currentrevisionlink' )->escaped()
1249 : Linker
::linkKnown(
1251 wfMessage( 'currentrevisionlink' )->escaped(),
1256 ?
wfMessage( 'diff' )->escaped()
1257 : Linker
::linkKnown(
1259 wfMessage( 'diff' )->escaped(),
1266 $prev = $this->getTitle()->getPreviousRevisionID( $oldid ) ;
1268 ? Linker
::linkKnown(
1270 wfMessage( 'previousrevision' )->escaped(),
1273 'direction' => 'prev',
1277 : wfMessage( 'previousrevision' )->escaped();
1279 ? Linker
::linkKnown(
1281 wfMessage( 'diff' )->escaped(),
1288 : wfMessage( 'diff' )->escaped();
1289 $nextlink = $current
1290 ?
wfMessage( 'nextrevision' )->escaped()
1291 : Linker
::linkKnown(
1293 wfMessage( 'nextrevision' )->escaped(),
1296 'direction' => 'next',
1300 $nextdiff = $current
1301 ?
wfMessage( 'diff' )->escaped()
1302 : Linker
::linkKnown(
1304 wfMessage( 'diff' )->escaped(),
1312 $cdel = Linker
::getRevDeleteLink( $user, $revision, $this->getTitle() );
1313 if ( $cdel !== '' ) {
1317 $outputPage->addSubtitle( "<div id=\"mw-revision-nav\">" . $cdel .
1318 wfMessage( 'revision-nav' )->rawParams(
1319 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff
1320 )->escaped() . "</div>" );
1326 * @param $target Title|Array of destination(s) to redirect
1327 * @param $appendSubtitle Boolean [optional]
1328 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1329 * @return string containing HMTL with redirect link
1331 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1332 global $wgStylePath;
1334 if ( !is_array( $target ) ) {
1335 $target = array( $target );
1338 $lang = $this->getTitle()->getPageLanguage();
1339 $imageDir = $lang->getDir();
1341 if ( $appendSubtitle ) {
1342 $out = $this->getContext()->getOutput();
1343 $out->addSubtitle( wfMessage( 'redirectpagesub' )->escaped() );
1346 // the loop prepends the arrow image before the link, so the first case needs to be outside
1351 $title = array_shift( $target );
1353 if ( $forceKnown ) {
1354 $link = Linker
::linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1356 $link = Linker
::link( $title, htmlspecialchars( $title->getFullText() ) );
1359 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1360 $alt = $lang->isRTL() ?
'←' : '→';
1361 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1362 foreach ( $target as $rt ) {
1363 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1364 if ( $forceKnown ) {
1365 $link .= Linker
::linkKnown( $rt, htmlspecialchars( $rt->getFullText(), array(), array( 'redirect' => 'no' ) ) );
1367 $link .= Linker
::link( $rt, htmlspecialchars( $rt->getFullText() ), array(), array( 'redirect' => 'no' ) );
1371 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1372 return '<div class="redirectMsg">' .
1373 Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1374 '<span class="redirectText">' . $link . '</span></div>';
1378 * Handle action=render
1380 public function render() {
1381 $this->getContext()->getOutput()->setArticleBodyOnly( true );
1386 * action=protect handler
1388 public function protect() {
1389 $form = new ProtectionForm( $this );
1394 * action=unprotect handler (alias)
1396 public function unprotect() {
1401 * UI entry point for page deletion
1403 public function delete() {
1404 # This code desperately needs to be totally rewritten
1406 $title = $this->getTitle();
1407 $user = $this->getContext()->getUser();
1410 $permission_errors = $title->getUserPermissionsErrors( 'delete', $user );
1411 if ( count( $permission_errors ) ) {
1412 throw new PermissionsError( 'delete', $permission_errors );
1415 # Read-only check...
1416 if ( wfReadOnly() ) {
1417 throw new ReadOnlyError
;
1420 # Better double-check that it hasn't been deleted yet!
1421 $this->mPage
->loadPageData( 'fromdbmaster' );
1422 if ( !$this->mPage
->exists() ) {
1423 $deleteLogPage = new LogPage( 'delete' );
1424 $outputPage = $this->getContext()->getOutput();
1425 $outputPage->setPageTitle( wfMessage( 'cannotdelete-title', $title->getPrefixedText() ) );
1426 $outputPage->wrapWikiMsg( "<div class=\"error mw-error-cannotdelete\">\n$1\n</div>",
1427 array( 'cannotdelete', wfEscapeWikiText( $title->getPrefixedText() ) )
1429 $outputPage->addHTML(
1430 Xml
::element( 'h2', null, $deleteLogPage->getName()->text() )
1432 LogEventsList
::showLogExtract(
1441 $request = $this->getContext()->getRequest();
1442 $deleteReasonList = $request->getText( 'wpDeleteReasonList', 'other' );
1443 $deleteReason = $request->getText( 'wpReason' );
1445 if ( $deleteReasonList == 'other' ) {
1446 $reason = $deleteReason;
1447 } elseif ( $deleteReason != '' ) {
1448 // Entry from drop down menu + additional comment
1449 $colonseparator = wfMessage( 'colon-separator' )->inContentLanguage()->text();
1450 $reason = $deleteReasonList . $colonseparator . $deleteReason;
1452 $reason = $deleteReasonList;
1455 if ( $request->wasPosted() && $user->matchEditToken( $request->getVal( 'wpEditToken' ),
1456 array( 'delete', $this->getTitle()->getPrefixedText() ) ) )
1458 # Flag to hide all contents of the archived revisions
1459 $suppress = $request->getVal( 'wpSuppress' ) && $user->isAllowed( 'suppressrevision' );
1461 $this->doDelete( $reason, $suppress );
1463 if ( $user->isLoggedIn() && $request->getCheck( 'wpWatch' ) != $user->isWatched( $title ) ) {
1464 if ( $request->getCheck( 'wpWatch' ) ) {
1465 WatchAction
::doWatch( $title, $user );
1467 WatchAction
::doUnwatch( $title, $user );
1474 // Generate deletion reason
1475 $hasHistory = false;
1478 $reason = $this->generateReason( $hasHistory );
1479 } catch ( MWException
$e ) {
1480 # if a page is horribly broken, we still want to be able to delete it. so be lenient about errors here.
1481 wfDebug("Error while building auto delete summary: $e");
1486 // If the page has a history, insert a warning
1487 if ( $hasHistory ) {
1488 $revisions = $this->mTitle
->estimateRevisionCount();
1489 // @todo FIXME: i18n issue/patchwork message
1490 $this->getContext()->getOutput()->addHTML( '<strong class="mw-delete-warning-revisions">' .
1491 wfMessage( 'historywarning' )->numParams( $revisions )->parse() .
1492 wfMessage( 'word-separator' )->plain() . Linker
::linkKnown( $title,
1493 wfMessage( 'history' )->escaped(),
1494 array( 'rel' => 'archives' ),
1495 array( 'action' => 'history' ) ) .
1499 if ( $this->mTitle
->isBigDeletion() ) {
1500 global $wgDeleteRevisionsLimit;
1501 $this->getContext()->getOutput()->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1502 array( 'delete-warning-toobig', $this->getContext()->getLanguage()->formatNum( $wgDeleteRevisionsLimit ) ) );
1506 $this->confirmDelete( $reason );
1510 * Output deletion confirmation dialog
1511 * @todo FIXME: Move to another file?
1512 * @param $reason String: prefilled reason
1514 public function confirmDelete( $reason ) {
1515 wfDebug( "Article::confirmDelete\n" );
1517 $outputPage = $this->getContext()->getOutput();
1518 $outputPage->setPageTitle( wfMessage( 'delete-confirm', $this->getTitle()->getPrefixedText() ) );
1519 $outputPage->addBacklinkSubtitle( $this->getTitle() );
1520 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1521 $outputPage->addWikiMsg( 'confirmdeletetext' );
1523 wfRunHooks( 'ArticleConfirmDelete', array( $this, $outputPage, &$reason ) );
1525 $user = $this->getContext()->getUser();
1527 if ( $user->isAllowed( 'suppressrevision' ) ) {
1528 $suppress = "<tr id=\"wpDeleteSuppressRow\">
1530 <td class='mw-input'><strong>" .
1531 Xml
::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
1532 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
1538 $checkWatch = $user->getBoolOption( 'watchdeletion' ) ||
$user->isWatched( $this->getTitle() );
1540 $form = Xml
::openElement( 'form', array( 'method' => 'post',
1541 'action' => $this->getTitle()->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
1542 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
1543 Xml
::tags( 'legend', null, wfMessage( 'delete-legend' )->escaped() ) .
1544 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
1545 "<tr id=\"wpDeleteReasonListRow\">
1546 <td class='mw-label'>" .
1547 Xml
::label( wfMessage( 'deletecomment' )->text(), 'wpDeleteReasonList' ) .
1549 <td class='mw-input'>" .
1550 Xml
::listDropDown( 'wpDeleteReasonList',
1551 wfMessage( 'deletereason-dropdown' )->inContentLanguage()->text(),
1552 wfMessage( 'deletereasonotherlist' )->inContentLanguage()->text(), '', 'wpReasonDropDown', 1 ) .
1555 <tr id=\"wpDeleteReasonRow\">
1556 <td class='mw-label'>" .
1557 Xml
::label( wfMessage( 'deleteotherreason' )->text(), 'wpReason' ) .
1559 <td class='mw-input'>" .
1560 Html
::input( 'wpReason', $reason, 'text', array(
1562 'maxlength' => '255',
1570 # Disallow watching if user is not logged in
1571 if ( $user->isLoggedIn() ) {
1575 <td class='mw-input'>" .
1576 Xml
::checkLabel( wfMessage( 'watchthis' )->text(),
1577 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
1586 <td class='mw-submit'>" .
1587 Xml
::submitButton( wfMessage( 'deletepage' )->text(),
1588 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
1591 Xml
::closeElement( 'table' ) .
1592 Xml
::closeElement( 'fieldset' ) .
1593 Html
::hidden( 'wpEditToken', $user->getEditToken( array( 'delete', $this->getTitle()->getPrefixedText() ) ) ) .
1594 Xml
::closeElement( 'form' );
1596 if ( $user->isAllowed( 'editinterface' ) ) {
1597 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
1598 $link = Linker
::link(
1600 wfMessage( 'delete-edit-reasonlist' )->escaped(),
1602 array( 'action' => 'edit' )
1604 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
1607 $outputPage->addHTML( $form );
1609 $deleteLogPage = new LogPage( 'delete' );
1610 $outputPage->addHTML( Xml
::element( 'h2', null, $deleteLogPage->getName()->text() ) );
1611 LogEventsList
::showLogExtract( $outputPage, 'delete',
1617 * Perform a deletion and output success or failure messages
1619 * @param $suppress bool
1621 public function doDelete( $reason, $suppress = false ) {
1623 $outputPage = $this->getContext()->getOutput();
1624 $status = $this->mPage
->doDeleteArticleReal( $reason, $suppress, 0, true, $error );
1625 if ( $status->isGood() ) {
1626 $deleted = $this->getTitle()->getPrefixedText();
1628 $outputPage->setPageTitle( wfMessage( 'actioncomplete' ) );
1629 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1631 $loglink = '[[Special:Log/delete|' . wfMessage( 'deletionlog' )->text() . ']]';
1633 $outputPage->addWikiMsg( 'deletedtext', wfEscapeWikiText( $deleted ), $loglink );
1634 $outputPage->returnToMain( false );
1636 $outputPage->setPageTitle( wfMessage( 'cannotdelete-title', $this->getTitle()->getPrefixedText() ) );
1637 if ( $error == '' ) {
1638 $outputPage->addWikiText(
1639 "<div class=\"error mw-error-cannotdelete\">\n" . $status->getWikiText() . "\n</div>"
1641 $deleteLogPage = new LogPage( 'delete' );
1642 $outputPage->addHTML( Xml
::element( 'h2', null, $deleteLogPage->getName()->text() ) );
1644 LogEventsList
::showLogExtract(
1650 $outputPage->addHTML( $error );
1655 /* Caching functions */
1658 * checkLastModified returns true if it has taken care of all
1659 * output to the client that is necessary for this request.
1660 * (that is, it has sent a cached version of the page)
1662 * @return boolean true if cached version send, false otherwise
1664 protected function tryFileCache() {
1665 static $called = false;
1668 wfDebug( "Article::tryFileCache(): called twice!?\n" );
1673 if ( $this->isFileCacheable() ) {
1674 $cache = HTMLFileCache
::newFromTitle( $this->getTitle(), 'view' );
1675 if ( $cache->isCacheGood( $this->mPage
->getTouched() ) ) {
1676 wfDebug( "Article::tryFileCache(): about to load file\n" );
1677 $cache->loadFromFileCache( $this->getContext() );
1680 wfDebug( "Article::tryFileCache(): starting buffer\n" );
1681 ob_start( array( &$cache, 'saveToFileCache' ) );
1684 wfDebug( "Article::tryFileCache(): not cacheable\n" );
1691 * Check if the page can be cached
1694 public function isFileCacheable() {
1697 if ( HTMLFileCache
::useFileCache( $this->getContext() ) ) {
1698 $cacheable = $this->mPage
->getID()
1699 && !$this->mRedirectedFrom
&& !$this->getTitle()->isRedirect();
1700 // Extension may have reason to disable file caching on some pages.
1702 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
1712 * Lightweight method to get the parser output for a page, checking the parser cache
1713 * and so on. Doesn't consider most of the stuff that WikiPage::view is forced to
1714 * consider, so it's not appropriate to use there.
1716 * @since 1.16 (r52326) for LiquidThreads
1718 * @param $oldid mixed integer Revision ID or null
1719 * @param $user User The relevant user
1720 * @return ParserOutput or false if the given revsion ID is not found
1722 public function getParserOutput( $oldid = null, User
$user = null ) {
1723 //XXX: bypasses mParserOptions and thus setParserOptions()
1725 if ( $user === null ) {
1726 $parserOptions = $this->getParserOptions();
1728 $parserOptions = $this->mPage
->makeParserOptions( $user );
1731 return $this->mPage
->getParserOutput( $parserOptions, $oldid );
1735 * Override the ParserOptions used to render the primary article wikitext.
1737 * @param ParserOptions $options
1738 * @throws MWException if the parser options where already initialized.
1740 public function setParserOptions( ParserOptions
$options ) {
1741 if ( $this->mParserOptions
) {
1742 throw new MWException( "can't change parser options after they have already been set" );
1745 // clone, so if $options is modified later, it doesn't confuse the parser cache.
1746 $this->mParserOptions
= clone $options;
1750 * Get parser options suitable for rendering the primary article wikitext
1751 * @return ParserOptions
1753 public function getParserOptions() {
1754 if ( !$this->mParserOptions
) {
1755 $this->mParserOptions
= $this->mPage
->makeParserOptions( $this->getContext() );
1757 // Clone to allow modifications of the return value without affecting cache
1758 return clone $this->mParserOptions
;
1762 * Sets the context this Article is executed in
1764 * @param $context IContextSource
1767 public function setContext( $context ) {
1768 $this->mContext
= $context;
1772 * Gets the context this Article is executed in
1774 * @return IContextSource
1777 public function getContext() {
1778 if ( $this->mContext
instanceof IContextSource
) {
1779 return $this->mContext
;
1781 wfDebug( __METHOD__
. " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
1782 return RequestContext
::getMain();
1787 * Info about this page
1788 * @deprecated since 1.19
1790 public function info() {
1791 wfDeprecated( __METHOD__
, '1.19' );
1792 Action
::factory( 'info', $this )->show();
1796 * Mark this particular edit/page as patrolled
1797 * @deprecated since 1.18
1799 public function markpatrolled() {
1800 wfDeprecated( __METHOD__
, '1.18' );
1801 Action
::factory( 'markpatrolled', $this )->show();
1805 * Handle action=purge
1806 * @deprecated since 1.19
1807 * @return Action|bool|null false if the action is disabled, null if it is not recognised
1809 public function purge() {
1810 return Action
::factory( 'purge', $this )->show();
1814 * Handle action=revert
1815 * @deprecated since 1.19
1817 public function revert() {
1818 wfDeprecated( __METHOD__
, '1.19' );
1819 Action
::factory( 'revert', $this )->show();
1823 * Handle action=rollback
1824 * @deprecated since 1.19
1826 public function rollback() {
1827 wfDeprecated( __METHOD__
, '1.19' );
1828 Action
::factory( 'rollback', $this )->show();
1832 * User-interface handler for the "watch" action.
1833 * Requires Request to pass a token as of 1.18.
1834 * @deprecated since 1.18
1836 public function watch() {
1837 wfDeprecated( __METHOD__
, '1.18' );
1838 Action
::factory( 'watch', $this )->show();
1842 * Add this page to the current user's watchlist
1844 * This is safe to be called multiple times
1846 * @return bool true on successful watch operation
1847 * @deprecated since 1.18
1849 public function doWatch() {
1850 wfDeprecated( __METHOD__
, '1.18' );
1851 return WatchAction
::doWatch( $this->getTitle(), $this->getContext()->getUser() );
1855 * User interface handler for the "unwatch" action.
1856 * Requires Request to pass a token as of 1.18.
1857 * @deprecated since 1.18
1859 public function unwatch() {
1860 wfDeprecated( __METHOD__
, '1.18' );
1861 Action
::factory( 'unwatch', $this )->show();
1865 * Stop watching a page
1866 * @return bool true on successful unwatch
1867 * @deprecated since 1.18
1869 public function doUnwatch() {
1870 wfDeprecated( __METHOD__
, '1.18' );
1871 return WatchAction
::doUnwatch( $this->getTitle(), $this->getContext()->getUser() );
1875 * Output a redirect back to the article.
1876 * This is typically used after an edit.
1878 * @deprecated in 1.18; call OutputPage::redirect() directly
1879 * @param $noRedir Boolean: add redirect=no
1880 * @param $sectionAnchor String: section to redirect to, including "#"
1881 * @param $extraQuery String: extra query params
1883 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
1884 wfDeprecated( __METHOD__
, '1.18' );
1886 $query = 'redirect=no';
1887 if ( $extraQuery ) {
1888 $query .= "&$extraQuery";
1891 $query = $extraQuery;
1894 $this->getContext()->getOutput()->redirect( $this->getTitle()->getFullURL( $query ) . $sectionAnchor );
1898 * Use PHP's magic __get handler to handle accessing of
1899 * raw WikiPage fields for backwards compatibility.
1901 * @param $fname String Field name
1903 public function __get( $fname ) {
1904 if ( property_exists( $this->mPage
, $fname ) ) {
1905 #wfWarn( "Access to raw $fname field " . __CLASS__ );
1906 return $this->mPage
->$fname;
1908 trigger_error( 'Inaccessible property via __get(): ' . $fname, E_USER_NOTICE
);
1912 * Use PHP's magic __set handler to handle setting of
1913 * raw WikiPage fields for backwards compatibility.
1915 * @param $fname String Field name
1916 * @param $fvalue mixed New value
1918 public function __set( $fname, $fvalue ) {
1919 if ( property_exists( $this->mPage
, $fname ) ) {
1920 #wfWarn( "Access to raw $fname field of " . __CLASS__ );
1921 $this->mPage
->$fname = $fvalue;
1922 // Note: extensions may want to toss on new fields
1923 } elseif ( !in_array( $fname, array( 'mContext', 'mPage' ) ) ) {
1924 $this->mPage
->$fname = $fvalue;
1926 trigger_error( 'Inaccessible property via __set(): ' . $fname, E_USER_NOTICE
);
1931 * Use PHP's magic __call handler to transform instance calls to
1932 * WikiPage functions for backwards compatibility.
1934 * @param $fname String Name of called method
1935 * @param $args Array Arguments to the method
1938 public function __call( $fname, $args ) {
1939 if ( is_callable( array( $this->mPage
, $fname ) ) ) {
1940 #wfWarn( "Call to " . __CLASS__ . "::$fname; please use WikiPage instead" );
1941 return call_user_func_array( array( $this->mPage
, $fname ), $args );
1943 trigger_error( 'Inaccessible function via __call(): ' . $fname, E_USER_ERROR
);
1946 // ****** B/C functions to work-around PHP silliness with __call and references ****** //
1949 * @param $limit array
1950 * @param $expiry array
1951 * @param $cascade bool
1952 * @param $reason string
1956 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade, $reason, User
$user ) {
1957 return $this->mPage
->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user );
1961 * @param $limit array
1962 * @param $reason string
1963 * @param $cascade int
1964 * @param $expiry array
1967 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
1968 return $this->mPage
->doUpdateRestrictions(
1973 $this->getContext()->getUser()
1978 * @param $reason string
1979 * @param $suppress bool
1981 * @param $commit bool
1982 * @param $error string
1985 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true, &$error = '' ) {
1986 return $this->mPage
->doDeleteArticle( $reason, $suppress, $id, $commit, $error );
1994 * @param $resultDetails
1998 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails, User
$user = null ) {
1999 $user = is_null( $user ) ?
$this->getContext()->getUser() : $user;
2000 return $this->mPage
->doRollback( $fromP, $summary, $token, $bot, $resultDetails, $user );
2007 * @param $resultDetails
2008 * @param $guser User
2011 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser = null ) {
2012 $guser = is_null( $guser ) ?
$this->getContext()->getUser() : $guser;
2013 return $this->mPage
->commitRollback( $fromP, $summary, $bot, $resultDetails, $guser );
2017 * @param $hasHistory bool
2020 public function generateReason( &$hasHistory ) {
2021 $title = $this->mPage
->getTitle();
2022 $handler = ContentHandler
::getForTitle( $title );
2023 return $handler->getAutoDeleteReason( $title, $hasHistory );
2026 // ****** B/C functions for static methods ( __callStatic is PHP>=5.3 ) ****** //
2031 public static function selectFields() {
2032 return WikiPage
::selectFields();
2036 * @param $title Title
2038 public static function onArticleCreate( $title ) {
2039 WikiPage
::onArticleCreate( $title );
2043 * @param $title Title
2045 public static function onArticleDelete( $title ) {
2046 WikiPage
::onArticleDelete( $title );
2050 * @param $title Title
2052 public static function onArticleEdit( $title ) {
2053 WikiPage
::onArticleEdit( $title );
2061 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
2063 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2064 return WikiPage
::getAutosummary( $oldtext, $newtext, $flags );