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 function addWikiTextTitleTidy($text, &$title, $linestart = true) {
319 $this->addWikiTextTitle( $text, $title, $linestart, true );
322 public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) {
325 $fname = 'OutputPage:addWikiTextTitle';
328 wfIncrStats('pcache_not_possible');
330 $popts = $this->parserOptions();
331 $popts->setTidy($tidy);
333 $parserOutput = $wgParser->parse( $text, $title, $popts,
334 $linestart, true, $this->mRevisionId
);
336 $this->addParserOutput( $parserOutput );
338 wfProfileOut($fname);
343 * @param ParserOutput object &$parserOutput
345 public function addParserOutputNoText( &$parserOutput ) {
346 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
347 $this->addCategoryLinks( $parserOutput->getCategories() );
348 $this->mNewSectionLink
= $parserOutput->getNewSection();
349 $this->addKeywords( $parserOutput );
350 if ( $parserOutput->getCacheTime() == -1 ) {
351 $this->enableClientCache( false );
353 if ( $parserOutput->mHTMLtitle
!= "" ) {
354 $this->mPagetitle
= $parserOutput->mHTMLtitle
;
356 if ( $parserOutput->mSubtitle
!= '' ) {
357 $this->mSubtitle
.= $parserOutput->mSubtitle
;
359 $this->mNoGallery
= $parserOutput->getNoGallery();
360 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
365 * @param ParserOutput &$parserOutput
367 function addParserOutput( &$parserOutput ) {
368 $this->addParserOutputNoText( $parserOutput );
369 $text = $parserOutput->getText();
370 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
371 $this->addHTML( $text );
375 * Add wikitext to the buffer, assuming that this is the primary text for a page view
376 * Saves the text into the parser cache if possible.
378 * @param string $text
379 * @param Article $article
381 * @deprecated Use Article::outputWikitext
383 public function addPrimaryWikiText( $text, $article, $cache = true ) {
384 global $wgParser, $wgUser;
386 $popts = $this->parserOptions();
387 $popts->setTidy(true);
388 $parserOutput = $wgParser->parse( $text, $article->mTitle
,
389 $popts, true, true, $this->mRevisionId
);
390 $popts->setTidy(false);
391 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
392 $parserCache =& ParserCache
::singleton();
393 $parserCache->save( $parserOutput, $article, $wgUser );
396 $this->addParserOutput( $parserOutput );
400 * @deprecated use addWikiTextTidy()
402 public function addSecondaryWikiText( $text, $linestart = true ) {
404 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
408 * Add wikitext with tidy enabled
410 public function addWikiTextTidy( $text, $linestart = true ) {
412 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
417 * Add the output of a QuickTemplate to the output buffer
419 * @param QuickTemplate $template
421 public function addTemplate( &$template ) {
423 $template->execute();
424 $this->addHTML( ob_get_contents() );
429 * Parse wikitext and return the HTML.
431 * @param string $text
432 * @param bool $linestart Is this the start of a line?
433 * @param bool $interface ??
435 public function parse( $text, $linestart = true, $interface = false ) {
436 global $wgParser, $wgTitle;
437 $popts = $this->parserOptions();
438 if ( $interface) { $popts->setInterfaceMessage(true); }
439 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
440 $linestart, true, $this->mRevisionId
);
441 if ( $interface) { $popts->setInterfaceMessage(false); }
442 return $parserOutput->getText();
446 * @param Article $article
449 * @return bool True if successful, else false.
451 public function tryParserCache( &$article, $user ) {
452 $parserCache =& ParserCache
::singleton();
453 $parserOutput = $parserCache->get( $article, $user );
454 if ( $parserOutput !== false ) {
455 $this->addParserOutput( $parserOutput );
463 * @param int $maxage Maximum cache time on the Squid, in seconds.
465 public function setSquidMaxage( $maxage ) {
466 $this->mSquidMaxage
= $maxage;
470 * Use enableClientCache(false) to force it to send nocache headers
473 public function enableClientCache( $state ) {
474 return wfSetVar( $this->mEnableClientCache
, $state );
477 function uncacheableBecauseRequestvars() {
479 return $wgRequest->getText('useskin', false) === false
480 && $wgRequest->getText('uselang', false) === false;
483 public function sendCacheControl() {
484 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
485 $fname = 'OutputPage::sendCacheControl';
487 if ($wgUseETag && $this->mETag
)
488 $wgRequest->response()->header("ETag: $this->mETag");
490 # don't serve compressed data to clients who can't handle it
491 # maintain different caches for logged-in users and non-logged in ones
492 $wgRequest->response()->header( 'Vary: Accept-Encoding, Cookie' );
493 if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache
) {
494 if( $wgUseSquid && ! isset( $_COOKIE[ini_get( 'session.name') ] ) &&
495 ! $this->isPrintable() && $this->mSquidMaxage
!= 0 )
498 # We'll purge the proxy cache explicitly, but require end user agents
499 # to revalidate against the proxy on each visit.
500 # Surrogate-Control controls our Squid, Cache-Control downstream caches
501 wfDebug( "$fname: proxy caching with ESI; {$this->mLastModified} **\n", false );
502 # start with a shorter timeout for initial testing
503 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
504 $wgRequest->response()->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage
.', content="ESI/1.0"');
505 $wgRequest->response()->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
507 # We'll purge the proxy cache for anons explicitly, but require end user agents
508 # to revalidate against the proxy on each visit.
509 # IMPORTANT! The Squid needs to replace the Cache-Control header with
510 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
511 wfDebug( "$fname: local proxy caching; {$this->mLastModified} **\n", false );
512 # start with a shorter timeout for initial testing
513 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
514 $wgRequest->response()->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage
.', must-revalidate, max-age=0' );
517 # We do want clients to cache if they can, but they *must* check for updates
518 # on revisiting the page.
519 wfDebug( "$fname: private caching; {$this->mLastModified} **\n", false );
520 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
521 $wgRequest->response()->header( "Cache-Control: private, must-revalidate, max-age=0" );
523 if($this->mLastModified
) $wgRequest->response()->header( "Last-modified: {$this->mLastModified}" );
525 wfDebug( "$fname: no caching **\n", false );
527 # In general, the absence of a last modified header should be enough to prevent
528 # the client from using its cache. We send a few other things just to make sure.
529 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
530 $wgRequest->response()->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
531 $wgRequest->response()->header( 'Pragma: no-cache' );
536 * Finally, all the text has been munged and accumulated into
537 * the object, let's actually output it:
539 public function output() {
540 global $wgUser, $wgOutputEncoding, $wgRequest;
541 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
542 global $wgJsMimeType, $wgStylePath, $wgUseAjax, $wgAjaxSearch, $wgAjaxWatch;
543 global $wgServer, $wgStyleVersion;
545 if( $this->mDoNothing
){
548 $fname = 'OutputPage::output';
549 wfProfileIn( $fname );
550 $sk = $wgUser->getSkin();
553 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajax.js?$wgStyleVersion\"></script>\n" );
554 if( $wgAjaxSearch ) {
555 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxsearch.js\"></script>\n" );
556 $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" );
559 if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
560 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxwatch.js\"></script>\n" );
564 if ( '' != $this->mRedirect
) {
565 if( substr( $this->mRedirect
, 0, 4 ) != 'http' ) {
566 # Standards require redirect URLs to be absolute
568 $this->mRedirect
= $wgServer . $this->mRedirect
;
570 if( $this->mRedirectCode
== '301') {
571 if( !$wgDebugRedirects ) {
572 $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
574 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
577 $this->sendCacheControl();
579 if( $wgDebugRedirects ) {
580 $url = htmlspecialchars( $this->mRedirect
);
581 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
582 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
583 print "</body>\n</html>\n";
585 $wgRequest->response()->header( 'Location: '.$this->mRedirect
);
587 wfProfileOut( $fname );
590 elseif ( $this->mStatusCode
)
592 $statusMessage = array(
594 101 => 'Switching Protocols',
599 203 => 'Non-Authoritative Information',
601 205 => 'Reset Content',
602 206 => 'Partial Content',
603 207 => 'Multi-Status',
604 300 => 'Multiple Choices',
605 301 => 'Moved Permanently',
608 304 => 'Not Modified',
610 307 => 'Temporary Redirect',
611 400 => 'Bad Request',
612 401 => 'Unauthorized',
613 402 => 'Payment Required',
616 405 => 'Method Not Allowed',
617 406 => 'Not Acceptable',
618 407 => 'Proxy Authentication Required',
619 408 => 'Request Timeout',
622 411 => 'Length Required',
623 412 => 'Precondition Failed',
624 413 => 'Request Entity Too Large',
625 414 => 'Request-URI Too Large',
626 415 => 'Unsupported Media Type',
627 416 => 'Request Range Not Satisfiable',
628 417 => 'Expectation Failed',
629 422 => 'Unprocessable Entity',
631 424 => 'Failed Dependency',
632 500 => 'Internal Server Error',
633 501 => 'Not Implemented',
634 502 => 'Bad Gateway',
635 503 => 'Service Unavailable',
636 504 => 'Gateway Timeout',
637 505 => 'HTTP Version Not Supported',
638 507 => 'Insufficient Storage'
641 if ( $statusMessage[$this->mStatusCode
] )
642 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode
. ' ' . $statusMessage[$this->mStatusCode
] );
645 # Buffer output; final headers may depend on later processing
648 # Disable temporary placeholders, so that the skin produces HTML
649 $sk->postParseLinkColour( false );
651 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
652 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
654 if ($this->mArticleBodyOnly
) {
655 $this->out($this->mBodytext
);
657 wfProfileIn( 'Output-skin' );
658 $sk->outputPage( $this );
659 wfProfileOut( 'Output-skin' );
662 $this->sendCacheControl();
664 wfProfileOut( $fname );
671 public function out( $ins ) {
672 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
673 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
676 $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
677 if ( false === $outs ) { $outs = $ins; }
685 public static function setEncodings() {
686 global $wgInputEncoding, $wgOutputEncoding;
687 global $wgUser, $wgContLang;
689 $wgInputEncoding = strtolower( $wgInputEncoding );
691 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
692 $wgOutputEncoding = strtolower( $wgOutputEncoding );
695 $wgOutputEncoding = $wgInputEncoding;
699 * Deprecated, use wfReportTime() instead.
703 public function reportTime() {
704 $time = wfReportTime();
709 * Produce a "user is blocked" page.
711 * @param bool $return Whether to have a "return to $wgTitle" message or not.
714 function blockedPage( $return = true ) {
715 global $wgUser, $wgContLang, $wgTitle;
717 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
718 $this->setRobotpolicy( 'noindex,nofollow' );
719 $this->setArticleRelated( false );
721 $id = $wgUser->blockedBy();
722 $reason = $wgUser->blockedFor();
725 if ( is_numeric( $id ) ) {
726 $name = User
::whoIs( $id );
730 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
732 $blockid = $wgUser->mBlock
->mId
;
734 $this->addWikiText( wfMsg( 'blockedtext', $link, $reason, $ip, $name, $blockid ) );
736 # Don't auto-return to special pages
738 $return = $wgTitle->getNamespace() > -1 ?
$wgTitle->getPrefixedText() : NULL;
739 $this->returnToMain( false, $return );
744 * Outputs a pretty page to explain why the request exploded.
746 * @param string $title Message key for page title.
747 * @param string $msg Message key for page text.
750 public function showErrorPage( $title, $msg ) {
753 $this->mDebugtext
.= 'Original title: ' .
754 $wgTitle->getPrefixedText() . "\n";
755 $this->setPageTitle( wfMsg( $title ) );
756 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
757 $this->setRobotpolicy( 'noindex,nofollow' );
758 $this->setArticleRelated( false );
759 $this->enableClientCache( false );
760 $this->mRedirect
= '';
762 $this->mBodytext
= '';
763 $this->addWikiText( wfMsg( $msg ) );
764 $this->returnToMain( false );
768 public function errorpage( $title, $msg ) {
769 throw new ErrorPageError( $title, $msg );
773 * Display an error page indicating that a given version of MediaWiki is
776 * @param mixed $version The version of MediaWiki needed to use the page
778 public function versionRequired( $version ) {
779 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
780 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
781 $this->setRobotpolicy( 'noindex,nofollow' );
782 $this->setArticleRelated( false );
783 $this->mBodytext
= '';
785 $this->addWikiText( wfMsg( 'versionrequiredtext', $version ) );
786 $this->returnToMain();
790 * Display an error page noting that a given permission bit is required.
792 * @param string $permission key required
794 public function permissionRequired( $permission ) {
795 global $wgGroupPermissions, $wgUser;
797 $this->setPageTitle( wfMsg( 'badaccess' ) );
798 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
799 $this->setRobotpolicy( 'noindex,nofollow' );
800 $this->setArticleRelated( false );
801 $this->mBodytext
= '';
804 foreach( $wgGroupPermissions as $key => $value ) {
805 if( isset( $value[$permission] ) && $value[$permission] == true ) {
806 $groupName = User
::getGroupName( $key );
807 $groupPage = User
::getGroupPage( $key );
809 $skin =& $wgUser->getSkin();
810 $groups[] = '"'.$skin->makeLinkObj( $groupPage, $groupName ).'"';
812 $groups[] = '"'.$groupName.'"';
816 $n = count( $groups );
817 $groups = implode( ', ', $groups );
822 $message = wfMsgHtml( "badaccess-group$n", $groups );
825 $message = wfMsgHtml( 'badaccess-groups', $groups );
827 $this->addHtml( $message );
828 $this->returnToMain( false );
832 * Use permissionRequired.
835 public function sysopRequired() {
836 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
840 * Use permissionRequired.
843 public function developerRequired() {
844 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
848 * Produce the stock "please login to use the wiki" page
850 public function loginToUse() {
851 global $wgUser, $wgTitle, $wgContLang;
853 if( $wgUser->isLoggedIn() ) {
854 $this->permissionRequired( 'read' );
858 $skin = $wgUser->getSkin();
860 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
861 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
862 $this->setRobotPolicy( 'noindex,nofollow' );
863 $this->setArticleFlag( false );
865 $loginTitle = SpecialPage
::getTitleFor( 'Userlogin' );
866 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
867 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
868 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
870 # Don't return to the main page if the user can't read it
871 # otherwise we'll end up in a pointless loop
872 $mainPage = Title
::newMainPage();
873 if( $mainPage->userCanRead() )
874 $this->returnToMain( true, $mainPage );
878 public function databaseError( $fname, $sql, $error, $errno ) {
879 throw new MWException( "OutputPage::databaseError is obsolete\n" );
884 * @param bool $protected Is the reason the page can't be reached because it's protected?
885 * @param mixed $source
887 public function readOnlyPage( $source = null, $protected = false ) {
888 global $wgUser, $wgReadOnlyFile, $wgReadOnly, $wgTitle;
889 $skin = $wgUser->getSkin();
891 $this->setRobotpolicy( 'noindex,nofollow' );
892 $this->setArticleRelated( false );
895 $this->setPageTitle( wfMsg( 'viewsource' ) );
896 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
898 $cascadeSources = $wgTitle->getCascadeProtectionSources();
900 # Determine if protection is due to the page being a system message
901 # and show an appropriate explanation
902 if( $wgTitle->getNamespace() == NS_MEDIAWIKI
) {
903 $this->addWikiText( wfMsg( 'protectedinterface' ) );
904 } if ( $cascadeSources && count($cascadeSources) > 0 ) {
907 foreach ( $cascadeSources as $title ) {
908 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
911 $notice = wfMsg( 'cascadeprotected' ) . "\n$titles";
913 $this->addWikiText( $notice );
915 $this->addWikiText( wfMsg( 'protectedpagetext' ) );
918 $this->setPageTitle( wfMsg( 'readonly' ) );
920 $reason = $wgReadOnly;
922 $reason = file_get_contents( $wgReadOnlyFile );
924 $this->addWikiText( wfMsg( 'readonlytext', $reason ) );
927 if( is_string( $source ) ) {
928 $this->addWikiText( wfMsg( 'viewsourcetext' ) );
929 $rows = $wgUser->getIntOption( 'rows' );
930 $cols = $wgUser->getIntOption( 'cols' );
931 $text = "\n<textarea name='wpTextbox1' id='wpTextbox1' cols='$cols' rows='$rows' readonly='readonly'>" .
932 htmlspecialchars( $source ) . "\n</textarea>";
933 $this->addHTML( $text );
935 $article = new Article($wgTitle);
936 $this->addHTML( $skin->formatTemplates($article->getUsedTemplates()) );
938 $this->returnToMain( false );
942 public function fatalError( $message ) {
943 throw new FatalError( $message );
947 public function unexpectedValueError( $name, $val ) {
948 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
952 public function fileCopyError( $old, $new ) {
953 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
957 public function fileRenameError( $old, $new ) {
958 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
962 public function fileDeleteError( $name ) {
963 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
967 public function fileNotFoundError( $name ) {
968 throw new FatalError( wfMsg( 'filenotfound', $name ) );
971 public function showFatalError( $message ) {
972 $this->setPageTitle( wfMsg( "internalerror" ) );
973 $this->setRobotpolicy( "noindex,nofollow" );
974 $this->setArticleRelated( false );
975 $this->enableClientCache( false );
976 $this->mRedirect
= '';
977 $this->mBodytext
= $message;
980 public function showUnexpectedValueError( $name, $val ) {
981 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
984 public function showFileCopyError( $old, $new ) {
985 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
988 public function showFileRenameError( $old, $new ) {
989 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
992 public function showFileDeleteError( $name ) {
993 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
996 public function showFileNotFoundError( $name ) {
997 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
1001 * return from error messages or notes
1002 * @param $auto automatically redirect the user after 10 seconds
1003 * @param $returnto page title to return to. Default is Main Page.
1005 public function returnToMain( $auto = true, $returnto = NULL ) {
1006 global $wgUser, $wgOut, $wgRequest;
1008 if ( $returnto == NULL ) {
1009 $returnto = $wgRequest->getText( 'returnto' );
1012 if ( '' === $returnto ) {
1013 $returnto = Title
::newMainPage();
1016 if ( is_object( $returnto ) ) {
1017 $titleObj = $returnto;
1019 $titleObj = Title
::newFromText( $returnto );
1021 if ( !is_object( $titleObj ) ) {
1022 $titleObj = Title
::newMainPage();
1025 $sk = $wgUser->getSkin();
1026 $link = $sk->makeLinkObj( $titleObj, '' );
1028 $r = wfMsg( 'returnto', $link );
1030 $wgOut->addMeta( 'http:Refresh', '10;url=' . $titleObj->escapeFullURL() );
1032 $wgOut->addHTML( "\n<p>$r</p>\n" );
1036 * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1037 * and uses the first 10 of them for META keywords
1039 * @param ParserOutput &$parserOutput
1041 private function addKeywords( &$parserOutput ) {
1043 $this->addKeyword( $wgTitle->getPrefixedText() );
1045 $links2d =& $parserOutput->getLinks();
1046 if ( !is_array( $links2d ) ) {
1049 foreach ( $links2d as $dbkeys ) {
1050 foreach( $dbkeys as $dbkey => $unused ) {
1051 $this->addKeyword( $dbkey );
1052 if ( ++
$count > 10 ) {
1060 * @return string The doctype, opening <html>, and head element.
1062 public function headElement() {
1063 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1064 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1065 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1067 if( $wgMimeType == 'text/xml' ||
$wgMimeType == 'application/xhtml+xml' ||
$wgMimeType == 'application/xml' ) {
1068 $ret = "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1073 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n \"$wgDTD\">\n";
1075 if ( '' == $this->getHTMLTitle() ) {
1076 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ));
1079 $rtl = $wgContLang->isRTL() ?
" dir='RTL'" : '';
1080 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1081 foreach($wgXhtmlNamespaces as $tag => $ns) {
1082 $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1084 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1085 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n";
1086 array_push( $this->mMetatags
, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) );
1088 $ret .= $this->getHeadLinks();
1089 global $wgStylePath;
1090 if( $this->isPrintable() ) {
1093 $media = "media='print'";
1095 $printsheet = htmlspecialchars( "$wgStylePath/common/wikiprintable.css?$wgStyleVersion" );
1096 $ret .= "<link rel='stylesheet' type='text/css' $media href='$printsheet' />\n";
1098 $sk = $wgUser->getSkin();
1099 $ret .= $sk->getHeadScripts();
1100 $ret .= $this->mScripts
;
1101 $ret .= $sk->getUserStyles();
1103 if ($wgUseTrackbacks && $this->isArticleRelated())
1104 $ret .= $wgTitle->trackbackRDF();
1106 $ret .= "</head>\n";
1111 * @return string HTML tag links to be put in the header.
1113 public function getHeadLinks() {
1116 foreach ( $this->mMetatags
as $tag ) {
1117 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1119 $tag[0] = substr( $tag[0], 5 );
1123 $ret .= "<meta $a=\"{$tag[0]}\" content=\"{$tag[1]}\" />\n";
1126 $p = $this->mRobotpolicy
;
1127 if( $p !== '' && $p != 'index,follow' ) {
1128 // http://www.robotstxt.org/wc/meta-user.html
1129 // Only show if it's different from the default robots policy
1130 $ret .= "<meta name=\"robots\" content=\"$p\" />\n";
1133 if ( count( $this->mKeywords
) > 0 ) {
1138 $ret .= "<meta name=\"keywords\" content=\"" .
1139 htmlspecialchars(preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords
))) . "\" />\n";
1141 foreach ( $this->mLinktags
as $tag ) {
1143 foreach( $tag as $attr => $val ) {
1144 $ret .= " $attr=\"" . htmlspecialchars( $val ) . "\"";
1148 if( $this->isSyndicated() ) {
1149 # FIXME: centralize the mime-type and name information in Feed.php
1150 $link = $wgRequest->escapeAppendQuery( 'feed=rss' );
1151 $ret .= "<link rel='alternate' type='application/rss+xml' title='RSS 2.0' href='$link' />\n";
1152 $link = $wgRequest->escapeAppendQuery( 'feed=atom' );
1153 $ret .= "<link rel='alternate' type='application/atom+xml' title='Atom 1.0' href='$link' />\n";
1160 * Turn off regular page output and return an error reponse
1161 * for when rate limiting has triggered.
1164 public function rateLimited() {
1167 wfHttpError( 500, 'Internal Server Error',
1168 'Sorry, the server has encountered an internal error. ' .
1169 'Please wait a moment and hit "refresh" to submit the request again.' );
1173 * Show an "add new section" link?
1175 * @return bool True if the parser output instructs us to add one
1177 public function showNewSectionLink() {
1178 return $this->mNewSectionLink
;