2 if ( ! defined( 'MEDIAWIKI' ) )
13 var $mMetatags, $mKeywords;
14 var $mLinktags, $mPagetitle, $mBodytext, $mDebugtext;
15 var $mHTMLtitle, $mRobotpolicy, $mIsarticle, $mPrintable;
16 var $mSubtitle, $mRedirect, $mStatusCode;
17 var $mLastModified, $mETag, $mCategoryLinks;
18 var $mScripts, $mLinkColours, $mPageLinkTitle;
20 var $mSuppressQuickbar;
23 var $mContainsOldMagic, $mContainsNewMagic;
24 var $mIsArticleRelated;
25 protected $mParserOptions; // lazy initialised, use parserOptions()
26 var $mShowFeedLinks = false;
27 var $mEnableClientCache = true;
28 var $mArticleBodyOnly = false;
30 var $mNewSectionLink = false;
31 var $mNoGallery = false;
35 * Initialise private variables
37 function OutputPage() {
38 $this->mMetatags
= $this->mKeywords
= $this->mLinktags
= array();
39 $this->mHTMLtitle
= $this->mPagetitle
= $this->mBodytext
=
40 $this->mRedirect
= $this->mLastModified
=
41 $this->mSubtitle
= $this->mDebugtext
= $this->mRobotpolicy
=
42 $this->mOnloadHandler
= $this->mPageLinkTitle
= '';
43 $this->mIsArticleRelated
= $this->mIsarticle
= $this->mPrintable
= true;
44 $this->mSuppressQuickbar
= $this->mPrintable
= false;
45 $this->mLanguageLinks
= array();
46 $this->mCategoryLinks
= array();
47 $this->mDoNothing
= false;
48 $this->mContainsOldMagic
= $this->mContainsNewMagic
= 0;
49 $this->mParserOptions
= null;
50 $this->mSquidMaxage
= 0;
53 $this->mRevisionId
= null;
54 $this->mNewSectionLink
= false;
57 public function redirect( $url, $responsecode = '302' ) {
58 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
59 $this->mRedirect
= str_replace( "\n", '', $url );
60 $this->mRedirectCode
= $responsecode;
64 * Set the HTTP status code to send with the output.
66 * @param int $statusCode
69 function setStatusCode( $statusCode ) { $this->mStatusCode
= $statusCode; }
71 # To add an http-equiv meta tag, precede the name with "http:"
72 function addMeta( $name, $val ) { array_push( $this->mMetatags
, array( $name, $val ) ); }
73 function addKeyword( $text ) { array_push( $this->mKeywords
, $text ); }
74 function addScript( $script ) { $this->mScripts
.= $script; }
77 * Add a self-contained script tag with the given contents
78 * @param string $script JavaScript text, no <script> tags
80 function addInlineScript( $script ) {
82 $this->mScripts
.= "<script type=\"$wgJsMimeType\"><!--\n$script\n--></script>";
85 function getScript() { return $this->mScripts
; }
87 function setETag($tag) { $this->mETag
= $tag; }
88 function setArticleBodyOnly($only) { $this->mArticleBodyOnly
= $only; }
89 function getArticleBodyOnly($only) { return $this->mArticleBodyOnly
; }
91 function addLink( $linkarr ) {
92 # $linkarr should be an associative array of attributes. We'll escape on output.
93 array_push( $this->mLinktags
, $linkarr );
96 function addMetadataLink( $linkarr ) {
97 # note: buggy CC software only reads first "meta" link
98 static $haveMeta = false;
99 $linkarr['rel'] = ($haveMeta) ?
'alternate meta' : 'meta';
100 $this->addLink( $linkarr );
105 * checkLastModified tells the client to use the client-cached page if
106 * possible. If sucessful, the OutputPage is disabled so that
107 * any future call to OutputPage->output() have no effect.
109 * @return bool True iff cache-ok headers was sent.
111 function checkLastModified ( $timestamp ) {
112 global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
113 $fname = 'OutputPage::checkLastModified';
115 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
116 wfDebug( "$fname: CACHE DISABLED, NO TIMESTAMP\n" );
119 if( !$wgCachePages ) {
120 wfDebug( "$fname: CACHE DISABLED\n", false );
123 if( $wgUser->getOption( 'nocache' ) ) {
124 wfDebug( "$fname: USER DISABLED CACHE\n", false );
128 $timestamp=wfTimestamp(TS_MW
,$timestamp);
129 $lastmod = wfTimestamp( TS_RFC2822
, max( $timestamp, $wgUser->mTouched
, $wgCacheEpoch ) );
131 if( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
132 # IE sends sizes after the date like this:
133 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
134 # this breaks strtotime().
135 $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
136 $modsinceTime = strtotime( $modsince );
137 $ismodsince = wfTimestamp( TS_MW
, $modsinceTime ?
$modsinceTime : 1 );
138 wfDebug( "$fname: -- client send If-Modified-Since: " . $modsince . "\n", false );
139 wfDebug( "$fname: -- we might send Last-Modified : $lastmod\n", false );
140 if( ($ismodsince >= $timestamp ) && $wgUser->validateCache( $ismodsince ) && $ismodsince >= $wgCacheEpoch ) {
141 # Make sure you're in a place you can leave when you call us!
142 $wgRequest->response()->header( "HTTP/1.0 304 Not Modified" );
143 $this->mLastModified
= $lastmod;
144 $this->sendCacheControl();
145 wfDebug( "$fname: CACHED client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
148 // Don't output a compressed blob when using ob_gzhandler;
149 // it's technically against HTTP spec and seems to confuse
150 // Firefox when the response gets split over two packets.
151 wfClearOutputBuffers();
155 wfDebug( "$fname: READY client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
156 $this->mLastModified
= $lastmod;
159 wfDebug( "$fname: client did not send If-Modified-Since header\n", false );
160 $this->mLastModified
= $lastmod;
164 function getPageTitleActionText () {
173 // Display title is already customized
176 return wfMsg('history_short');
178 // FIXME: bug 2735; not correct for special pages etc
179 return wfMsg('preview');
181 return wfMsg('info_short');
187 public function setRobotpolicy( $str ) { $this->mRobotpolicy
= $str; }
188 public function setHTMLTitle( $name ) {$this->mHTMLtitle
= $name; }
189 public function setPageTitle( $name ) {
190 global $action, $wgContLang;
191 $name = $wgContLang->convert($name, true);
192 $this->mPagetitle
= $name;
193 if(!empty($action)) {
194 $taction = $this->getPageTitleActionText();
195 if( !empty( $taction ) ) {
196 $name .= ' - '.$taction;
200 $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
202 public function getHTMLTitle() { return $this->mHTMLtitle
; }
203 public function getPageTitle() { return $this->mPagetitle
; }
204 public function setSubtitle( $str ) { $this->mSubtitle
= /*$this->parse(*/$str/*)*/; } // @bug 2514
205 public function getSubtitle() { return $this->mSubtitle
; }
206 public function isArticle() { return $this->mIsarticle
; }
207 public function setPrintable() { $this->mPrintable
= true; }
208 public function isPrintable() { return $this->mPrintable
; }
209 public function setSyndicated( $show = true ) { $this->mShowFeedLinks
= $show; }
210 public function isSyndicated() { return $this->mShowFeedLinks
; }
211 public function setOnloadHandler( $js ) { $this->mOnloadHandler
= $js; }
212 public function getOnloadHandler() { return $this->mOnloadHandler
; }
213 public function disable() { $this->mDoNothing
= true; }
215 public function setArticleRelated( $v ) {
216 $this->mIsArticleRelated
= $v;
218 $this->mIsarticle
= false;
221 public function setArticleFlag( $v ) {
222 $this->mIsarticle
= $v;
224 $this->mIsArticleRelated
= $v;
228 public function isArticleRelated() { return $this->mIsArticleRelated
; }
230 public function getLanguageLinks() { return $this->mLanguageLinks
; }
231 public function addLanguageLinks($newLinkArray) {
232 $this->mLanguageLinks +
= $newLinkArray;
234 public function setLanguageLinks($newLinkArray) {
235 $this->mLanguageLinks
= $newLinkArray;
238 public function getCategoryLinks() {
239 return $this->mCategoryLinks
;
243 * Add an array of categories, with names in the keys
245 public function addCategoryLinks($categories) {
246 global $wgUser, $wgContLang;
248 if ( !is_array( $categories ) ) {
251 # Add the links to the link cache in a batch
252 $arr = array( NS_CATEGORY
=> $categories );
254 $lb->setArray( $arr );
257 $sk =& $wgUser->getSkin();
258 foreach ( $categories as $category => $unused ) {
259 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
260 $text = $wgContLang->convertHtml( $title->getText() );
261 $this->mCategoryLinks
[] = $sk->makeLinkObj( $title, $text );
265 public function setCategoryLinks($categories) {
266 $this->mCategoryLinks
= array();
267 $this->addCategoryLinks($categories);
270 public function suppressQuickbar() { $this->mSuppressQuickbar
= true; }
271 public function isQuickbarSuppressed() { return $this->mSuppressQuickbar
; }
273 public function addHTML( $text ) { $this->mBodytext
.= $text; }
274 public function clearHTML() { $this->mBodytext
= ''; }
275 public function getHTML() { return $this->mBodytext
; }
276 public function debug( $text ) { $this->mDebugtext
.= $text; }
279 public function setParserOptions( $options ) {
280 return $this->parserOptions( $options );
283 public function parserOptions( $options = null ) {
284 if ( !$this->mParserOptions
) {
285 $this->mParserOptions
= new ParserOptions
;
287 return wfSetVar( $this->mParserOptions
, $options );
291 * Set the revision ID which will be seen by the wiki text parser
292 * for things such as embedded {{REVISIONID}} variable use.
293 * @param mixed $revid an integer, or NULL
294 * @return mixed previous value
296 public function setRevisionId( $revid ) {
297 $val = is_null( $revid ) ?
null : intval( $revid );
298 return wfSetVar( $this->mRevisionId
, $val );
302 * Convert wikitext to HTML and add it to the buffer
303 * Default assumes that the current page title will
306 * @param string $text
307 * @param bool $linestart
309 public function addWikiText( $text, $linestart = true ) {
311 $this->addWikiTextTitle($text, $wgTitle, $linestart);
314 public function addWikiTextWithTitle($text, &$title, $linestart = true) {
315 $this->addWikiTextTitle($text, $title, $linestart);
318 private function addWikiTextTitle($text, &$title, $linestart) {
320 $fname = 'OutputPage:addWikiTextTitle';
322 wfIncrStats('pcache_not_possible');
323 $parserOutput = $wgParser->parse( $text, $title, $this->parserOptions(),
324 $linestart, true, $this->mRevisionId
);
325 $this->addParserOutput( $parserOutput );
326 wfProfileOut($fname);
331 * @param ParserOutput object &$parserOutput
333 public function addParserOutputNoText( &$parserOutput ) {
334 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
335 $this->addCategoryLinks( $parserOutput->getCategories() );
336 $this->mNewSectionLink
= $parserOutput->getNewSection();
337 $this->addKeywords( $parserOutput );
338 if ( $parserOutput->getCacheTime() == -1 ) {
339 $this->enableClientCache( false );
341 if ( $parserOutput->mHTMLtitle
!= "" ) {
342 $this->mPagetitle
= $parserOutput->mHTMLtitle
;
344 if ( $parserOutput->mSubtitle
!= '' ) {
345 $this->mSubtitle
.= $parserOutput->mSubtitle
;
347 $this->mNoGallery
= $parserOutput->getNoGallery();
348 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
353 * @param ParserOutput &$parserOutput
355 function addParserOutput( &$parserOutput ) {
356 $this->addParserOutputNoText( $parserOutput );
357 $text = $parserOutput->getText();
358 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
359 $this->addHTML( $text );
363 * Add wikitext to the buffer, assuming that this is the primary text for a page view
364 * Saves the text into the parser cache if possible.
366 * @param string $text
367 * @param Article $article
370 public function addPrimaryWikiText( $text, $article, $cache = true ) {
371 global $wgParser, $wgUser;
373 $popts = $this->parserOptions();
374 $popts->setTidy(true);
375 $parserOutput = $wgParser->parse( $text, $article->mTitle
,
376 $popts, true, true, $this->mRevisionId
);
377 $popts->setTidy(false);
378 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
379 $parserCache =& ParserCache
::singleton();
380 $parserCache->save( $parserOutput, $article, $wgUser );
383 $this->addParserOutput( $parserOutput );
387 * For anything that isn't primary text or interface message
389 * @param string $text
390 * @param bool $linestart Is this the start of a line?
392 public function addSecondaryWikiText( $text, $linestart = true ) {
394 $popts = $this->parserOptions();
395 $popts->setTidy(true);
396 $this->addWikiTextTitle($text, $wgTitle, $linestart);
397 $popts->setTidy(false);
402 * Add the output of a QuickTemplate to the output buffer
404 * @param QuickTemplate $template
406 public function addTemplate( &$template ) {
408 $template->execute();
409 $this->addHTML( ob_get_contents() );
414 * Parse wikitext and return the HTML.
416 * @param string $text
417 * @param bool $linestart Is this the start of a line?
418 * @param bool $interface ??
420 public function parse( $text, $linestart = true, $interface = false ) {
421 global $wgParser, $wgTitle;
422 $popts = $this->parserOptions();
423 if ( $interface) { $popts->setInterfaceMessage(true); }
424 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
425 $linestart, true, $this->mRevisionId
);
426 if ( $interface) { $popts->setInterfaceMessage(false); }
427 return $parserOutput->getText();
431 * @param Article $article
434 * @return bool True if successful, else false.
436 public function tryParserCache( &$article, $user ) {
437 $parserCache =& ParserCache
::singleton();
438 $parserOutput = $parserCache->get( $article, $user );
439 if ( $parserOutput !== false ) {
440 $this->addParserOutput( $parserOutput );
448 * @param int $maxage Maximum cache time on the Squid, in seconds.
450 public function setSquidMaxage( $maxage ) {
451 $this->mSquidMaxage
= $maxage;
455 * Use enableClientCache(false) to force it to send nocache headers
458 public function enableClientCache( $state ) {
459 return wfSetVar( $this->mEnableClientCache
, $state );
462 function uncacheableBecauseRequestvars() {
464 return $wgRequest->getText('useskin', false) === false
465 && $wgRequest->getText('uselang', false) === false;
468 public function sendCacheControl() {
469 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
470 $fname = 'OutputPage::sendCacheControl';
472 if ($wgUseETag && $this->mETag
)
473 $wgRequest->response()->header("ETag: $this->mETag");
475 # don't serve compressed data to clients who can't handle it
476 # maintain different caches for logged-in users and non-logged in ones
477 $wgRequest->response()->header( 'Vary: Accept-Encoding, Cookie' );
478 if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache
) {
479 if( $wgUseSquid && ! isset( $_COOKIE[ini_get( 'session.name') ] ) &&
480 ! $this->isPrintable() && $this->mSquidMaxage
!= 0 )
483 # We'll purge the proxy cache explicitly, but require end user agents
484 # to revalidate against the proxy on each visit.
485 # Surrogate-Control controls our Squid, Cache-Control downstream caches
486 wfDebug( "$fname: proxy caching with ESI; {$this->mLastModified} **\n", false );
487 # start with a shorter timeout for initial testing
488 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
489 $wgRequest->response()->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage
.', content="ESI/1.0"');
490 $wgRequest->response()->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
492 # We'll purge the proxy cache for anons explicitly, but require end user agents
493 # to revalidate against the proxy on each visit.
494 # IMPORTANT! The Squid needs to replace the Cache-Control header with
495 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
496 wfDebug( "$fname: local proxy caching; {$this->mLastModified} **\n", false );
497 # start with a shorter timeout for initial testing
498 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
499 $wgRequest->response()->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage
.', must-revalidate, max-age=0' );
502 # We do want clients to cache if they can, but they *must* check for updates
503 # on revisiting the page.
504 wfDebug( "$fname: private caching; {$this->mLastModified} **\n", false );
505 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
506 $wgRequest->response()->header( "Cache-Control: private, must-revalidate, max-age=0" );
508 if($this->mLastModified
) $wgRequest->response()->header( "Last-modified: {$this->mLastModified}" );
510 wfDebug( "$fname: no caching **\n", false );
512 # In general, the absence of a last modified header should be enough to prevent
513 # the client from using its cache. We send a few other things just to make sure.
514 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
515 $wgRequest->response()->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
516 $wgRequest->response()->header( 'Pragma: no-cache' );
521 * Finally, all the text has been munged and accumulated into
522 * the object, let's actually output it:
524 public function output() {
525 global $wgUser, $wgOutputEncoding, $wgRequest;
526 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
527 global $wgJsMimeType, $wgStylePath, $wgUseAjax, $wgAjaxSearch, $wgServer;
528 global $wgStyleVersion;
530 if( $this->mDoNothing
){
533 $fname = 'OutputPage::output';
534 wfProfileIn( $fname );
535 $sk = $wgUser->getSkin();
538 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajax.js?$wgStyleVersion\"></script>\n" );
541 if ( $wgUseAjax && $wgAjaxSearch ) {
542 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxsearch.js?$wgStyleVersion\"></script>\n" );
543 $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" );
546 if ( '' != $this->mRedirect
) {
547 if( substr( $this->mRedirect
, 0, 4 ) != 'http' ) {
548 # Standards require redirect URLs to be absolute
550 $this->mRedirect
= $wgServer . $this->mRedirect
;
552 if( $this->mRedirectCode
== '301') {
553 if( !$wgDebugRedirects ) {
554 $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
556 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
559 $this->sendCacheControl();
561 if( $wgDebugRedirects ) {
562 $url = htmlspecialchars( $this->mRedirect
);
563 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
564 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
565 print "</body>\n</html>\n";
567 $wgRequest->response()->header( 'Location: '.$this->mRedirect
);
569 wfProfileOut( $fname );
572 elseif ( $this->mStatusCode
)
574 $statusMessage = array(
576 101 => 'Switching Protocols',
581 203 => 'Non-Authoritative Information',
583 205 => 'Reset Content',
584 206 => 'Partial Content',
585 207 => 'Multi-Status',
586 300 => 'Multiple Choices',
587 301 => 'Moved Permanently',
590 304 => 'Not Modified',
592 307 => 'Temporary Redirect',
593 400 => 'Bad Request',
594 401 => 'Unauthorized',
595 402 => 'Payment Required',
598 405 => 'Method Not Allowed',
599 406 => 'Not Acceptable',
600 407 => 'Proxy Authentication Required',
601 408 => 'Request Timeout',
604 411 => 'Length Required',
605 412 => 'Precondition Failed',
606 413 => 'Request Entity Too Large',
607 414 => 'Request-URI Too Large',
608 415 => 'Unsupported Media Type',
609 416 => 'Request Range Not Satisfiable',
610 417 => 'Expectation Failed',
611 422 => 'Unprocessable Entity',
613 424 => 'Failed Dependency',
614 500 => 'Internal Server Error',
615 501 => 'Not Implemented',
616 502 => 'Bad Gateway',
617 503 => 'Service Unavailable',
618 504 => 'Gateway Timeout',
619 505 => 'HTTP Version Not Supported',
620 507 => 'Insufficient Storage'
623 if ( $statusMessage[$this->mStatusCode
] )
624 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode
. ' ' . $statusMessage[$this->mStatusCode
] );
627 # Buffer output; final headers may depend on later processing
630 # Disable temporary placeholders, so that the skin produces HTML
631 $sk->postParseLinkColour( false );
633 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
634 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
636 if ($this->mArticleBodyOnly
) {
637 $this->out($this->mBodytext
);
639 wfProfileIn( 'Output-skin' );
640 $sk->outputPage( $this );
641 wfProfileOut( 'Output-skin' );
644 $this->sendCacheControl();
646 wfProfileOut( $fname );
653 public function out( $ins ) {
654 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
655 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
658 $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
659 if ( false === $outs ) { $outs = $ins; }
667 public static function setEncodings() {
668 global $wgInputEncoding, $wgOutputEncoding;
669 global $wgUser, $wgContLang;
671 $wgInputEncoding = strtolower( $wgInputEncoding );
673 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
674 $wgOutputEncoding = strtolower( $wgOutputEncoding );
677 $wgOutputEncoding = $wgInputEncoding;
681 * Deprecated, use wfReportTime() instead.
685 public function reportTime() {
686 $time = wfReportTime();
691 * Produce a "user is blocked" page.
693 * @param bool $return Whether to have a "return to $wgTitle" message or not.
696 function blockedPage( $return = true ) {
697 global $wgUser, $wgContLang, $wgTitle;
699 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
700 $this->setRobotpolicy( 'noindex,nofollow' );
701 $this->setArticleRelated( false );
703 $id = $wgUser->blockedBy();
704 $reason = $wgUser->blockedFor();
707 if ( is_numeric( $id ) ) {
708 $name = User
::whoIs( $id );
712 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
714 $this->addWikiText( wfMsg( 'blockedtext', $link, $reason, $ip, $name ) );
716 # Don't auto-return to special pages
718 $return = $wgTitle->getNamespace() > -1 ?
$wgTitle->getPrefixedText() : NULL;
719 $this->returnToMain( false, $return );
724 * Outputs a pretty page to explain why the request exploded.
726 * @param string $title Message key for page title.
727 * @param string $msg Message key for page text.
730 public function showErrorPage( $title, $msg ) {
733 $this->mDebugtext
.= 'Original title: ' .
734 $wgTitle->getPrefixedText() . "\n";
735 $this->setPageTitle( wfMsg( $title ) );
736 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
737 $this->setRobotpolicy( 'noindex,nofollow' );
738 $this->setArticleRelated( false );
739 $this->enableClientCache( false );
740 $this->mRedirect
= '';
742 $this->mBodytext
= '';
743 $this->addWikiText( wfMsg( $msg ) );
744 $this->returnToMain( false );
748 public function errorpage( $title, $msg ) {
749 throw new ErrorPageError( $title, $msg );
753 * Display an error page indicating that a given version of MediaWiki is
756 * @param mixed $version The version of MediaWiki needed to use the page
758 public function versionRequired( $version ) {
759 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
760 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
761 $this->setRobotpolicy( 'noindex,nofollow' );
762 $this->setArticleRelated( false );
763 $this->mBodytext
= '';
765 $this->addWikiText( wfMsg( 'versionrequiredtext', $version ) );
766 $this->returnToMain();
770 * Display an error page noting that a given permission bit is required.
772 * @param string $permission key required
774 public function permissionRequired( $permission ) {
775 global $wgGroupPermissions, $wgUser;
777 $this->setPageTitle( wfMsg( 'badaccess' ) );
778 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
779 $this->setRobotpolicy( 'noindex,nofollow' );
780 $this->setArticleRelated( false );
781 $this->mBodytext
= '';
784 foreach( $wgGroupPermissions as $key => $value ) {
785 if( isset( $value[$permission] ) && $value[$permission] == true ) {
786 $groupName = User
::getGroupName( $key );
787 $groupPage = User
::getGroupPage( $key );
789 $skin =& $wgUser->getSkin();
790 $groups[] = '"'.$skin->makeLinkObj( $groupPage, $groupName ).'"';
792 $groups[] = '"'.$groupName.'"';
796 $n = count( $groups );
797 $groups = implode( ', ', $groups );
802 $message = wfMsgHtml( "badaccess-group$n", $groups );
805 $message = wfMsgHtml( 'badaccess-groups', $groups );
807 $this->addHtml( $message );
808 $this->returnToMain( false );
812 * Use permissionRequired.
815 public function sysopRequired() {
816 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
820 * Use permissionRequired.
823 public function developerRequired() {
824 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
828 * Produce the stock "please login to use the wiki" page
830 public function loginToUse() {
831 global $wgUser, $wgTitle, $wgContLang;
833 if( $wgUser->isLoggedIn() ) {
834 $this->permissionRequired( 'read' );
838 $skin = $wgUser->getSkin();
840 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
841 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
842 $this->setRobotPolicy( 'noindex,nofollow' );
843 $this->setArticleFlag( false );
845 $loginTitle = SpecialPage
::getTitleFor( 'Userlogin' );
846 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
847 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
848 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
850 # Don't return to the main page if the user can't read it
851 # otherwise we'll end up in a pointless loop
852 $mainPage = Title
::newMainPage();
853 if( $mainPage->userCanRead() )
854 $this->returnToMain( true, $mainPage );
858 public function databaseError( $fname, $sql, $error, $errno ) {
859 throw new MWException( "OutputPage::databaseError is obsolete\n" );
864 * @param bool $protected Is the reason the page can't be reached because it's protected?
865 * @param mixed $source
867 public function readOnlyPage( $source = null, $protected = false ) {
868 global $wgUser, $wgReadOnlyFile, $wgReadOnly, $wgTitle;
869 $skin = $wgUser->getSkin();
871 $this->setRobotpolicy( 'noindex,nofollow' );
872 $this->setArticleRelated( false );
875 $this->setPageTitle( wfMsg( 'viewsource' ) );
876 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
878 # Determine if protection is due to the page being a system message
879 # and show an appropriate explanation
880 if( $wgTitle->getNamespace() == NS_MEDIAWIKI
&& !$wgUser->isAllowed( 'editinterface' ) ) {
881 $this->addWikiText( wfMsg( 'protectedinterface' ) );
883 $this->addWikiText( wfMsg( 'protectedtext' ) );
886 $this->setPageTitle( wfMsg( 'readonly' ) );
888 $reason = $wgReadOnly;
890 $reason = file_get_contents( $wgReadOnlyFile );
892 $this->addWikiText( wfMsg( 'readonlytext', $reason ) );
895 if( is_string( $source ) ) {
896 if( $source === '' ) {
898 if ( $wgTitle->getNamespace() == NS_MEDIAWIKI
) {
899 $source = wfMsgWeirdKey ( $wgTitle->getText() );
904 $rows = $wgUser->getIntOption( 'rows' );
905 $cols = $wgUser->getIntOption( 'cols' );
907 $text = "\n<textarea name='wpTextbox1' id='wpTextbox1' cols='$cols' rows='$rows' readonly='readonly'>" .
908 htmlspecialchars( $source ) . "\n</textarea>";
909 $this->addHTML( $text );
911 $article = new Article($wgTitle);
912 $this->addHTML( $skin->formatTemplates($article->getUsedTemplates()) );
914 $this->returnToMain( false );
918 public function fatalError( $message ) {
919 throw new FatalError( $message );
923 public function unexpectedValueError( $name, $val ) {
924 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
928 public function fileCopyError( $old, $new ) {
929 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
933 public function fileRenameError( $old, $new ) {
934 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
938 public function fileDeleteError( $name ) {
939 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
943 public function fileNotFoundError( $name ) {
944 throw new FatalError( wfMsg( 'filenotfound', $name ) );
947 public function showFatalError( $message ) {
948 $this->setPageTitle( wfMsg( "internalerror" ) );
949 $this->setRobotpolicy( "noindex,nofollow" );
950 $this->setArticleRelated( false );
951 $this->enableClientCache( false );
952 $this->mRedirect
= '';
953 $this->mBodytext
= $message;
956 public function showUnexpectedValueError( $name, $val ) {
957 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
960 public function showFileCopyError( $old, $new ) {
961 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
964 public function showFileRenameError( $old, $new ) {
965 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
968 public function showFileDeleteError( $name ) {
969 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
972 public function showFileNotFoundError( $name ) {
973 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
977 * return from error messages or notes
978 * @param $auto automatically redirect the user after 10 seconds
979 * @param $returnto page title to return to. Default is Main Page.
981 public function returnToMain( $auto = true, $returnto = NULL ) {
982 global $wgUser, $wgOut, $wgRequest;
984 if ( $returnto == NULL ) {
985 $returnto = $wgRequest->getText( 'returnto' );
988 if ( '' === $returnto ) {
989 $returnto = Title
::newMainPage();
992 if ( is_object( $returnto ) ) {
993 $titleObj = $returnto;
995 $titleObj = Title
::newFromText( $returnto );
997 if ( !is_object( $titleObj ) ) {
998 $titleObj = Title
::newMainPage();
1001 $sk = $wgUser->getSkin();
1002 $link = $sk->makeLinkObj( $titleObj, '' );
1004 $r = wfMsg( 'returnto', $link );
1006 $wgOut->addMeta( 'http:Refresh', '10;url=' . $titleObj->escapeFullURL() );
1008 $wgOut->addHTML( "\n<p>$r</p>\n" );
1012 * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1013 * and uses the first 10 of them for META keywords
1015 * @param ParserOutput &$parserOutput
1017 private function addKeywords( &$parserOutput ) {
1019 $this->addKeyword( $wgTitle->getPrefixedText() );
1021 $links2d =& $parserOutput->getLinks();
1022 if ( !is_array( $links2d ) ) {
1025 foreach ( $links2d as $dbkeys ) {
1026 foreach( $dbkeys as $dbkey => $unused ) {
1027 $this->addKeyword( $dbkey );
1028 if ( ++
$count > 10 ) {
1036 * @return string The doctype, opening <html>, and head element.
1038 public function headElement() {
1039 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1040 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1042 if( $wgMimeType == 'text/xml' ||
$wgMimeType == 'application/xhtml+xml' ||
$wgMimeType == 'application/xml' ) {
1043 $ret = "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1048 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n \"$wgDTD\">\n";
1050 if ( '' == $this->getHTMLTitle() ) {
1051 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ));
1054 $rtl = $wgContLang->isRTL() ?
" dir='RTL'" : '';
1055 $ret .= "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1056 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n";
1057 array_push( $this->mMetatags
, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) );
1059 $ret .= $this->getHeadLinks();
1060 global $wgStylePath;
1061 if( $this->isPrintable() ) {
1064 $media = "media='print'";
1066 $printsheet = htmlspecialchars( "$wgStylePath/common/wikiprintable.css?$wgStyleVersion" );
1067 $ret .= "<link rel='stylesheet' type='text/css' $media href='$printsheet' />\n";
1069 $sk = $wgUser->getSkin();
1070 $ret .= $sk->getHeadScripts();
1071 $ret .= $this->mScripts
;
1072 $ret .= $sk->getUserStyles();
1074 if ($wgUseTrackbacks && $this->isArticleRelated())
1075 $ret .= $wgTitle->trackbackRDF();
1077 $ret .= "</head>\n";
1082 * @return string HTML tag links to be put in the header.
1084 public function getHeadLinks() {
1087 foreach ( $this->mMetatags
as $tag ) {
1088 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1090 $tag[0] = substr( $tag[0], 5 );
1094 $ret .= "<meta $a=\"{$tag[0]}\" content=\"{$tag[1]}\" />\n";
1097 $p = $this->mRobotpolicy
;
1098 if( $p !== '' && $p != 'index,follow' ) {
1099 // http://www.robotstxt.org/wc/meta-user.html
1100 // Only show if it's different from the default robots policy
1101 $ret .= "<meta name=\"robots\" content=\"$p\" />\n";
1104 if ( count( $this->mKeywords
) > 0 ) {
1109 $ret .= "<meta name=\"keywords\" content=\"" .
1110 htmlspecialchars(preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords
))) . "\" />\n";
1112 foreach ( $this->mLinktags
as $tag ) {
1114 foreach( $tag as $attr => $val ) {
1115 $ret .= " $attr=\"" . htmlspecialchars( $val ) . "\"";
1119 if( $this->isSyndicated() ) {
1120 # FIXME: centralize the mime-type and name information in Feed.php
1121 $link = $wgRequest->escapeAppendQuery( 'feed=rss' );
1122 $ret .= "<link rel='alternate' type='application/rss+xml' title='RSS 2.0' href='$link' />\n";
1123 $link = $wgRequest->escapeAppendQuery( 'feed=atom' );
1124 $ret .= "<link rel='alternate' type='application/atom+xml' title='Atom 1.0' href='$link' />\n";
1131 * Turn off regular page output and return an error reponse
1132 * for when rate limiting has triggered.
1135 public function rateLimited() {
1138 wfHttpError( 500, 'Internal Server Error',
1139 'Sorry, the server has encountered an internal error. ' .
1140 'Please wait a moment and hit "refresh" to submit the request again.' );
1144 * Show an "add new section" link?
1146 * @return bool True if the parser output instructs us to add one
1148 public function showNewSectionLink() {
1149 return $this->mNewSectionLink
;