2 if ( ! defined( 'MEDIAWIKI' ) )
11 var $mMetatags, $mKeywords;
12 var $mLinktags, $mPagetitle, $mBodytext, $mDebugtext;
13 var $mHTMLtitle, $mRobotpolicy, $mIsarticle, $mPrintable;
14 var $mSubtitle, $mRedirect, $mStatusCode;
15 var $mLastModified, $mETag, $mCategoryLinks;
16 var $mScripts, $mLinkColours, $mPageLinkTitle;
19 var $mSuppressQuickbar;
22 var $mContainsOldMagic, $mContainsNewMagic;
23 var $mIsArticleRelated;
24 protected $mParserOptions; // lazy initialised, use parserOptions()
25 var $mShowFeedLinks = false;
26 var $mFeedLinksAppendQuery = false;
27 var $mEnableClientCache = true;
28 var $mArticleBodyOnly = false;
30 var $mNewSectionLink = false;
31 var $mNoGallery = false;
32 var $mPageTitleActionText = '';
33 var $mParseWarnings = array();
37 * Initialise private variables
39 function __construct() {
40 global $wgAllowUserJs;
41 $this->mAllowUserJs
= $wgAllowUserJs;
42 $this->mMetatags
= $this->mKeywords
= $this->mLinktags
= array();
43 $this->mHTMLtitle
= $this->mPagetitle
= $this->mBodytext
=
44 $this->mRedirect
= $this->mLastModified
=
45 $this->mSubtitle
= $this->mDebugtext
= $this->mRobotpolicy
=
46 $this->mOnloadHandler
= $this->mPageLinkTitle
= '';
47 $this->mIsArticleRelated
= $this->mIsarticle
= $this->mPrintable
= true;
48 $this->mSuppressQuickbar
= $this->mPrintable
= false;
49 $this->mLanguageLinks
= array();
50 $this->mCategoryLinks
= array();
51 $this->mDoNothing
= false;
52 $this->mContainsOldMagic
= $this->mContainsNewMagic
= 0;
53 $this->mParserOptions
= null;
54 $this->mSquidMaxage
= 0;
56 $this->mHeadItems
= array();
58 $this->mRevisionId
= null;
59 $this->mNewSectionLink
= false;
60 $this->mTemplateIds
= array();
63 public function redirect( $url, $responsecode = '302' ) {
64 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
65 $this->mRedirect
= str_replace( "\n", '', $url );
66 $this->mRedirectCode
= $responsecode;
69 public function getRedirect() {
70 return $this->mRedirect
;
74 * Set the HTTP status code to send with the output.
76 * @param int $statusCode
79 function setStatusCode( $statusCode ) { $this->mStatusCode
= $statusCode; }
81 # To add an http-equiv meta tag, precede the name with "http:"
82 function addMeta( $name, $val ) { array_push( $this->mMetatags
, array( $name, $val ) ); }
83 function addKeyword( $text ) { array_push( $this->mKeywords
, $text ); }
84 function addScript( $script ) { $this->mScripts
.= "\t\t".$script; }
85 function addStyle( $style ) {
86 global $wgStylePath, $wgStyleVersion;
89 'rel' => 'stylesheet',
90 'href' => $wgStylePath . '/' . $style . '?' . $wgStyleVersion ) );
94 * Add a self-contained script tag with the given contents
95 * @param string $script JavaScript text, no <script> tags
97 function addInlineScript( $script ) {
99 $this->mScripts
.= "<script type=\"$wgJsMimeType\">/*<![CDATA[*/\n$script\n/*]]>*/</script>";
102 function getScript() {
103 return $this->mScripts
. $this->getHeadItems();
106 function getHeadItems() {
108 foreach ( $this->mHeadItems
as $item ) {
114 function addHeadItem( $name, $value ) {
115 $this->mHeadItems
[$name] = $value;
118 function hasHeadItem( $name ) {
119 return isset( $this->mHeadItems
[$name] );
122 function setETag($tag) { $this->mETag
= $tag; }
123 function setArticleBodyOnly($only) { $this->mArticleBodyOnly
= $only; }
124 function getArticleBodyOnly($only) { return $this->mArticleBodyOnly
; }
126 function addLink( $linkarr ) {
127 # $linkarr should be an associative array of attributes. We'll escape on output.
128 array_push( $this->mLinktags
, $linkarr );
131 function addMetadataLink( $linkarr ) {
132 # note: buggy CC software only reads first "meta" link
133 static $haveMeta = false;
134 $linkarr['rel'] = ($haveMeta) ?
'alternate meta' : 'meta';
135 $this->addLink( $linkarr );
140 * checkLastModified tells the client to use the client-cached page if
141 * possible. If sucessful, the OutputPage is disabled so that
142 * any future call to OutputPage->output() have no effect.
144 * @return bool True iff cache-ok headers was sent.
146 function checkLastModified ( $timestamp ) {
147 global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
148 $fname = 'OutputPage::checkLastModified';
150 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
151 wfDebug( "$fname: CACHE DISABLED, NO TIMESTAMP\n" );
154 if( !$wgCachePages ) {
155 wfDebug( "$fname: CACHE DISABLED\n", false );
158 if( $wgUser->getOption( 'nocache' ) ) {
159 wfDebug( "$fname: USER DISABLED CACHE\n", false );
163 $timestamp=wfTimestamp(TS_MW
,$timestamp);
164 $lastmod = wfTimestamp( TS_RFC2822
, max( $timestamp, $wgUser->mTouched
, $wgCacheEpoch ) );
166 if( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
167 # IE sends sizes after the date like this:
168 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
169 # this breaks strtotime().
170 $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
172 wfSuppressWarnings(); // E_STRICT system time bitching
173 $modsinceTime = strtotime( $modsince );
176 $ismodsince = wfTimestamp( TS_MW
, $modsinceTime ?
$modsinceTime : 1 );
177 wfDebug( "$fname: -- client send If-Modified-Since: " . $modsince . "\n", false );
178 wfDebug( "$fname: -- we might send Last-Modified : $lastmod\n", false );
179 if( ($ismodsince >= $timestamp ) && $wgUser->validateCache( $ismodsince ) && $ismodsince >= $wgCacheEpoch ) {
180 # Make sure you're in a place you can leave when you call us!
181 $wgRequest->response()->header( "HTTP/1.0 304 Not Modified" );
182 $this->mLastModified
= $lastmod;
183 $this->sendCacheControl();
184 wfDebug( "$fname: CACHED client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
187 // Don't output a compressed blob when using ob_gzhandler;
188 // it's technically against HTTP spec and seems to confuse
189 // Firefox when the response gets split over two packets.
190 wfClearOutputBuffers();
194 wfDebug( "$fname: READY client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
195 $this->mLastModified
= $lastmod;
198 wfDebug( "$fname: client did not send If-Modified-Since header\n", false );
199 $this->mLastModified
= $lastmod;
203 function setPageTitleActionText( $text ) {
204 $this->mPageTitleActionText
= $text;
207 function getPageTitleActionText () {
208 if ( isset( $this->mPageTitleActionText
) ) {
209 return $this->mPageTitleActionText
;
213 public function setRobotpolicy( $str ) { $this->mRobotpolicy
= $str; }
214 public function setHTMLTitle( $name ) {$this->mHTMLtitle
= $name; }
215 public function setPageTitle( $name ) {
216 global $action, $wgContLang;
217 $name = $wgContLang->convert($name, true);
218 $this->mPagetitle
= $name;
219 if(!empty($action)) {
220 $taction = $this->getPageTitleActionText();
221 if( !empty( $taction ) ) {
222 $name .= ' - '.$taction;
226 $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
228 public function getHTMLTitle() { return $this->mHTMLtitle
; }
229 public function getPageTitle() { return $this->mPagetitle
; }
230 public function setSubtitle( $str ) { $this->mSubtitle
= /*$this->parse(*/$str/*)*/; } // @bug 2514
231 public function getSubtitle() { return $this->mSubtitle
; }
232 public function isArticle() { return $this->mIsarticle
; }
233 public function setPrintable() { $this->mPrintable
= true; }
234 public function isPrintable() { return $this->mPrintable
; }
235 public function setSyndicated( $show = true ) { $this->mShowFeedLinks
= $show; }
236 public function isSyndicated() { return $this->mShowFeedLinks
; }
237 public function setFeedAppendQuery( $val ) { $this->mFeedLinksAppendQuery
= $val; }
238 public function getFeedAppendQuery() { return $this->mFeedLinksAppendQuery
; }
239 public function setOnloadHandler( $js ) { $this->mOnloadHandler
= $js; }
240 public function getOnloadHandler() { return $this->mOnloadHandler
; }
241 public function disable() { $this->mDoNothing
= true; }
243 public function setArticleRelated( $v ) {
244 $this->mIsArticleRelated
= $v;
246 $this->mIsarticle
= false;
249 public function setArticleFlag( $v ) {
250 $this->mIsarticle
= $v;
252 $this->mIsArticleRelated
= $v;
256 public function isArticleRelated() { return $this->mIsArticleRelated
; }
258 public function getLanguageLinks() { return $this->mLanguageLinks
; }
259 public function addLanguageLinks($newLinkArray) {
260 $this->mLanguageLinks +
= $newLinkArray;
262 public function setLanguageLinks($newLinkArray) {
263 $this->mLanguageLinks
= $newLinkArray;
266 public function getCategoryLinks() {
267 return $this->mCategoryLinks
;
271 * Add an array of categories, with names in the keys
273 public function addCategoryLinks($categories) {
274 global $wgUser, $wgContLang;
276 if ( !is_array( $categories ) ) {
279 # Add the links to the link cache in a batch
280 $arr = array( NS_CATEGORY
=> $categories );
282 $lb->setArray( $arr );
285 $sk = $wgUser->getSkin();
286 foreach ( $categories as $category => $unused ) {
287 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
288 $text = $wgContLang->convertHtml( $title->getText() );
289 $this->mCategoryLinks
[] = $sk->makeLinkObj( $title, $text );
293 public function setCategoryLinks($categories) {
294 $this->mCategoryLinks
= array();
295 $this->addCategoryLinks($categories);
298 public function suppressQuickbar() { $this->mSuppressQuickbar
= true; }
299 public function isQuickbarSuppressed() { return $this->mSuppressQuickbar
; }
301 public function disallowUserJs() { $this->mAllowUserJs
= false; }
302 public function isUserJsAllowed() { return $this->mAllowUserJs
; }
304 public function addHTML( $text ) { $this->mBodytext
.= $text; }
305 public function clearHTML() { $this->mBodytext
= ''; }
306 public function getHTML() { return $this->mBodytext
; }
307 public function debug( $text ) { $this->mDebugtext
.= $text; }
310 public function setParserOptions( $options ) {
311 return $this->parserOptions( $options );
314 public function parserOptions( $options = null ) {
315 if ( !$this->mParserOptions
) {
316 $this->mParserOptions
= new ParserOptions
;
318 return wfSetVar( $this->mParserOptions
, $options );
322 * Set the revision ID which will be seen by the wiki text parser
323 * for things such as embedded {{REVISIONID}} variable use.
324 * @param mixed $revid an integer, or NULL
325 * @return mixed previous value
327 public function setRevisionId( $revid ) {
328 $val = is_null( $revid ) ?
null : intval( $revid );
329 return wfSetVar( $this->mRevisionId
, $val );
333 * Convert wikitext to HTML and add it to the buffer
334 * Default assumes that the current page title will
337 * @param string $text
338 * @param bool $linestart
340 public function addWikiText( $text, $linestart = true ) {
342 $this->addWikiTextTitle($text, $wgTitle, $linestart);
345 public function addWikiTextWithTitle($text, &$title, $linestart = true) {
346 $this->addWikiTextTitle($text, $title, $linestart);
349 function addWikiTextTitleTidy($text, &$title, $linestart = true) {
350 $this->addWikiTextTitle( $text, $title, $linestart, true );
353 public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) {
356 $fname = 'OutputPage:addWikiTextTitle';
359 wfIncrStats('pcache_not_possible');
361 $popts = $this->parserOptions();
362 $oldTidy = $popts->setTidy($tidy);
364 $parserOutput = $wgParser->parse( $text, $title, $popts,
365 $linestart, true, $this->mRevisionId
);
367 $popts->setTidy( $oldTidy );
369 $this->addParserOutput( $parserOutput );
371 wfProfileOut($fname);
376 * @param ParserOutput object &$parserOutput
378 public function addParserOutputNoText( &$parserOutput ) {
379 $this->mLanguageLinks +
= $parserOutput->getLanguageLinks();
380 $this->addCategoryLinks( $parserOutput->getCategories() );
381 $this->mNewSectionLink
= $parserOutput->getNewSection();
382 $this->addKeywords( $parserOutput );
383 $this->mParseWarnings
= $parserOutput->getWarnings();
384 if ( $parserOutput->getCacheTime() == -1 ) {
385 $this->enableClientCache( false );
387 $this->mNoGallery
= $parserOutput->getNoGallery();
388 $this->mHeadItems
= array_merge( $this->mHeadItems
, (array)$parserOutput->mHeadItems
);
390 $this->mTemplateIds +
= (array)$parserOutput->mTemplateIds
;
393 if( ( $dt = $parserOutput->getDisplayTitle() ) !== false )
394 $this->setPageTitle( $dt );
396 # Hooks registered in the object
397 global $wgParserOutputHooks;
398 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
399 list( $hookName, $data ) = $hookInfo;
400 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
401 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
405 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
410 * @param ParserOutput &$parserOutput
412 function addParserOutput( &$parserOutput ) {
413 $this->addParserOutputNoText( $parserOutput );
414 $text = $parserOutput->getText();
415 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
416 $this->addHTML( $text );
420 * Add wikitext to the buffer, assuming that this is the primary text for a page view
421 * Saves the text into the parser cache if possible.
423 * @param string $text
424 * @param Article $article
426 * @deprecated Use Article::outputWikitext
428 public function addPrimaryWikiText( $text, $article, $cache = true ) {
429 global $wgParser, $wgUser;
431 $popts = $this->parserOptions();
432 $popts->setTidy(true);
433 $parserOutput = $wgParser->parse( $text, $article->mTitle
,
434 $popts, true, true, $this->mRevisionId
);
435 $popts->setTidy(false);
436 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
437 $parserCache =& ParserCache
::singleton();
438 $parserCache->save( $parserOutput, $article, $wgUser );
441 $this->addParserOutput( $parserOutput );
445 * @deprecated use addWikiTextTidy()
447 public function addSecondaryWikiText( $text, $linestart = true ) {
449 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
453 * Add wikitext with tidy enabled
455 public function addWikiTextTidy( $text, $linestart = true ) {
457 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
462 * Add the output of a QuickTemplate to the output buffer
464 * @param QuickTemplate $template
466 public function addTemplate( &$template ) {
468 $template->execute();
469 $this->addHTML( ob_get_contents() );
474 * Parse wikitext and return the HTML.
476 * @param string $text
477 * @param bool $linestart Is this the start of a line?
478 * @param bool $interface ??
480 public function parse( $text, $linestart = true, $interface = false ) {
481 global $wgParser, $wgTitle;
482 $popts = $this->parserOptions();
483 if ( $interface) { $popts->setInterfaceMessage(true); }
484 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
485 $linestart, true, $this->mRevisionId
);
486 if ( $interface) { $popts->setInterfaceMessage(false); }
487 return $parserOutput->getText();
491 * @param Article $article
494 * @return bool True if successful, else false.
496 public function tryParserCache( &$article, $user ) {
497 $parserCache =& ParserCache
::singleton();
498 $parserOutput = $parserCache->get( $article, $user );
499 if ( $parserOutput !== false ) {
500 $this->addParserOutput( $parserOutput );
508 * @param int $maxage Maximum cache time on the Squid, in seconds.
510 public function setSquidMaxage( $maxage ) {
511 $this->mSquidMaxage
= $maxage;
515 * Use enableClientCache(false) to force it to send nocache headers
518 public function enableClientCache( $state ) {
519 return wfSetVar( $this->mEnableClientCache
, $state );
522 function uncacheableBecauseRequestvars() {
524 return $wgRequest->getText('useskin', false) === false
525 && $wgRequest->getText('uselang', false) === false;
528 public function sendCacheControl() {
529 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
530 $fname = 'OutputPage::sendCacheControl';
532 if ($wgUseETag && $this->mETag
)
533 $wgRequest->response()->header("ETag: $this->mETag");
535 # don't serve compressed data to clients who can't handle it
536 # maintain different caches for logged-in users and non-logged in ones
537 $wgRequest->response()->header( 'Vary: Accept-Encoding, Cookie' );
538 if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache
) {
539 if( $wgUseSquid && session_id() == '' &&
540 ! $this->isPrintable() && $this->mSquidMaxage
!= 0 )
543 # We'll purge the proxy cache explicitly, but require end user agents
544 # to revalidate against the proxy on each visit.
545 # Surrogate-Control controls our Squid, Cache-Control downstream caches
546 wfDebug( "$fname: proxy caching with ESI; {$this->mLastModified} **\n", false );
547 # start with a shorter timeout for initial testing
548 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
549 $wgRequest->response()->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage
.', content="ESI/1.0"');
550 $wgRequest->response()->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
552 # We'll purge the proxy cache for anons explicitly, but require end user agents
553 # to revalidate against the proxy on each visit.
554 # IMPORTANT! The Squid needs to replace the Cache-Control header with
555 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
556 wfDebug( "$fname: local proxy caching; {$this->mLastModified} **\n", false );
557 # start with a shorter timeout for initial testing
558 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
559 $wgRequest->response()->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage
.', must-revalidate, max-age=0' );
562 # We do want clients to cache if they can, but they *must* check for updates
563 # on revisiting the page.
564 wfDebug( "$fname: private caching; {$this->mLastModified} **\n", false );
565 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
566 $wgRequest->response()->header( "Cache-Control: private, must-revalidate, max-age=0" );
568 if($this->mLastModified
) $wgRequest->response()->header( "Last-modified: {$this->mLastModified}" );
570 wfDebug( "$fname: no caching **\n", false );
572 # In general, the absence of a last modified header should be enough to prevent
573 # the client from using its cache. We send a few other things just to make sure.
574 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
575 $wgRequest->response()->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
576 $wgRequest->response()->header( 'Pragma: no-cache' );
581 * Finally, all the text has been munged and accumulated into
582 * the object, let's actually output it:
584 public function output() {
585 global $wgUser, $wgOutputEncoding, $wgRequest;
586 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
587 global $wgJsMimeType, $wgStylePath, $wgUseAjax, $wgAjaxSearch, $wgAjaxWatch;
588 global $wgServer, $wgStyleVersion;
590 if( $this->mDoNothing
){
593 $fname = 'OutputPage::output';
594 wfProfileIn( $fname );
596 if ( '' != $this->mRedirect
) {
597 if( substr( $this->mRedirect
, 0, 4 ) != 'http' ) {
598 # Standards require redirect URLs to be absolute
600 $this->mRedirect
= $wgServer . $this->mRedirect
;
602 if( $this->mRedirectCode
== '301') {
603 if( !$wgDebugRedirects ) {
604 $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
606 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
609 $this->sendCacheControl();
611 $wgRequest->response()->header("Content-Type: text/html; charset=utf-8");
612 if( $wgDebugRedirects ) {
613 $url = htmlspecialchars( $this->mRedirect
);
614 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
615 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
616 print "</body>\n</html>\n";
618 $wgRequest->response()->header( 'Location: '.$this->mRedirect
);
620 wfProfileOut( $fname );
623 elseif ( $this->mStatusCode
)
625 $statusMessage = array(
627 101 => 'Switching Protocols',
632 203 => 'Non-Authoritative Information',
634 205 => 'Reset Content',
635 206 => 'Partial Content',
636 207 => 'Multi-Status',
637 300 => 'Multiple Choices',
638 301 => 'Moved Permanently',
641 304 => 'Not Modified',
643 307 => 'Temporary Redirect',
644 400 => 'Bad Request',
645 401 => 'Unauthorized',
646 402 => 'Payment Required',
649 405 => 'Method Not Allowed',
650 406 => 'Not Acceptable',
651 407 => 'Proxy Authentication Required',
652 408 => 'Request Timeout',
655 411 => 'Length Required',
656 412 => 'Precondition Failed',
657 413 => 'Request Entity Too Large',
658 414 => 'Request-URI Too Large',
659 415 => 'Unsupported Media Type',
660 416 => 'Request Range Not Satisfiable',
661 417 => 'Expectation Failed',
662 422 => 'Unprocessable Entity',
664 424 => 'Failed Dependency',
665 500 => 'Internal Server Error',
666 501 => 'Not Implemented',
667 502 => 'Bad Gateway',
668 503 => 'Service Unavailable',
669 504 => 'Gateway Timeout',
670 505 => 'HTTP Version Not Supported',
671 507 => 'Insufficient Storage'
674 if ( $statusMessage[$this->mStatusCode
] )
675 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode
. ' ' . $statusMessage[$this->mStatusCode
] );
678 $sk = $wgUser->getSkin();
681 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajax.js?$wgStyleVersion\"></script>\n" );
683 wfRunHooks( 'AjaxAddScript', array( &$this ) );
685 if( $wgAjaxSearch && $wgUser->getBoolOption( 'ajaxsearch' ) ) {
686 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxsearch.js?$wgStyleVersion\"></script>\n" );
687 $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" );
690 if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
691 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxwatch.js?$wgStyleVersion\"></script>\n" );
697 # Buffer output; final headers may depend on later processing
700 # Disable temporary placeholders, so that the skin produces HTML
701 $sk->postParseLinkColour( false );
703 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
704 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
706 if ($this->mArticleBodyOnly
) {
707 $this->out($this->mBodytext
);
709 wfProfileIn( 'Output-skin' );
710 $sk->outputPage( $this );
711 wfProfileOut( 'Output-skin' );
714 $this->sendCacheControl();
716 wfProfileOut( $fname );
723 public function out( $ins ) {
724 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
725 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
728 $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
729 if ( false === $outs ) { $outs = $ins; }
737 public static function setEncodings() {
738 global $wgInputEncoding, $wgOutputEncoding;
739 global $wgUser, $wgContLang;
741 $wgInputEncoding = strtolower( $wgInputEncoding );
743 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
744 $wgOutputEncoding = strtolower( $wgOutputEncoding );
747 $wgOutputEncoding = $wgInputEncoding;
751 * Deprecated, use wfReportTime() instead.
755 public function reportTime() {
756 $time = wfReportTime();
761 * Produce a "user is blocked" page.
763 * @param bool $return Whether to have a "return to $wgTitle" message or not.
766 function blockedPage( $return = true ) {
767 global $wgUser, $wgContLang, $wgTitle, $wgLang;
769 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
770 $this->setRobotpolicy( 'noindex,nofollow' );
771 $this->setArticleRelated( false );
773 $name = User
::whoIs( $wgUser->blockedBy() );
774 $reason = $wgUser->blockedFor();
775 if( $reason == '' ) {
776 $reason = wfMsg( 'blockednoreason' );
778 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $wgUser->mBlock
->mTimestamp
), true );
781 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
783 $blockid = $wgUser->mBlock
->mId
;
785 $blockExpiry = $wgUser->mBlock
->mExpiry
;
786 if ( $blockExpiry == 'infinity' ) {
787 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
788 // Search for localization in 'ipboptions'
789 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
790 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
791 if ( strpos( $option, ":" ) === false )
793 list( $show, $value ) = explode( ":", $option );
794 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
795 $blockExpiry = $show;
800 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
803 if ( $wgUser->mBlock
->mAuto
) {
804 $msg = 'autoblockedtext';
806 $msg = 'blockedtext';
809 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
810 * This could be a username, an ip range, or a single ip. */
811 $intended = $wgUser->mBlock
->mAddress
;
813 $this->addWikiText( wfMsg( $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp ) );
815 # Don't auto-return to special pages
817 $return = $wgTitle->getNamespace() > -1 ?
$wgTitle->getPrefixedText() : NULL;
818 $this->returnToMain( false, $return );
823 * Output a standard error page
825 * @param string $title Message key for page title
826 * @param string $msg Message key for page text
827 * @param array $params Message parameters
829 public function showErrorPage( $title, $msg, $params = array() ) {
831 if ( isset($wgTitle) ) {
832 $this->mDebugtext
.= 'Original title: ' . $wgTitle->getPrefixedText() . "\n";
834 $this->setPageTitle( wfMsg( $title ) );
835 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
836 $this->setRobotpolicy( 'noindex,nofollow' );
837 $this->setArticleRelated( false );
838 $this->enableClientCache( false );
839 $this->mRedirect
= '';
840 $this->mBodytext
= '';
842 array_unshift( $params, 'parse' );
843 array_unshift( $params, $msg );
844 $this->addHtml( call_user_func_array( 'wfMsgExt', $params ) );
846 $this->returnToMain( false );
850 * Output a standard permission error page
852 * @param array $errors Error message keys
854 public function showPermissionsErrorPage( $errors )
858 $this->mDebugtext
.= 'Original title: ' .
859 $wgTitle->getPrefixedText() . "\n";
860 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
861 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
862 $this->setRobotpolicy( 'noindex,nofollow' );
863 $this->setArticleRelated( false );
864 $this->enableClientCache( false );
865 $this->mRedirect
= '';
866 $this->mBodytext
= '';
867 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors ) );
871 public function errorpage( $title, $msg ) {
872 throw new ErrorPageError( $title, $msg );
876 * Display an error page indicating that a given version of MediaWiki is
879 * @param mixed $version The version of MediaWiki needed to use the page
881 public function versionRequired( $version ) {
882 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
883 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
884 $this->setRobotpolicy( 'noindex,nofollow' );
885 $this->setArticleRelated( false );
886 $this->mBodytext
= '';
888 $this->addWikiText( wfMsg( 'versionrequiredtext', $version ) );
889 $this->returnToMain();
893 * Display an error page noting that a given permission bit is required.
895 * @param string $permission key required
897 public function permissionRequired( $permission ) {
898 global $wgGroupPermissions, $wgUser;
900 $this->setPageTitle( wfMsg( 'badaccess' ) );
901 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
902 $this->setRobotpolicy( 'noindex,nofollow' );
903 $this->setArticleRelated( false );
904 $this->mBodytext
= '';
907 foreach( $wgGroupPermissions as $key => $value ) {
908 if( isset( $value[$permission] ) && $value[$permission] == true ) {
909 $groupName = User
::getGroupName( $key );
910 $groupPage = User
::getGroupPage( $key );
912 $skin = $wgUser->getSkin();
913 $groups[] = $skin->makeLinkObj( $groupPage, $groupName );
915 $groups[] = $groupName;
919 $n = count( $groups );
920 $groups = implode( ', ', $groups );
925 $message = wfMsgHtml( "badaccess-group$n", $groups );
928 $message = wfMsgHtml( 'badaccess-groups', $groups );
930 $this->addHtml( $message );
931 $this->returnToMain( false );
935 * Use permissionRequired.
938 public function sysopRequired() {
939 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
943 * Use permissionRequired.
946 public function developerRequired() {
947 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
951 * Produce the stock "please login to use the wiki" page
953 public function loginToUse() {
954 global $wgUser, $wgTitle, $wgContLang;
956 if( $wgUser->isLoggedIn() ) {
957 $this->permissionRequired( 'read' );
961 $skin = $wgUser->getSkin();
963 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
964 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
965 $this->setRobotPolicy( 'noindex,nofollow' );
966 $this->setArticleFlag( false );
968 $loginTitle = SpecialPage
::getTitleFor( 'Userlogin' );
969 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
970 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
971 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
973 # Don't return to the main page if the user can't read it
974 # otherwise we'll end up in a pointless loop
975 $mainPage = Title
::newMainPage();
976 if( $mainPage->userCanRead() )
977 $this->returnToMain( true, $mainPage );
981 public function databaseError( $fname, $sql, $error, $errno ) {
982 throw new MWException( "OutputPage::databaseError is obsolete\n" );
986 * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors
987 * @return string The wikitext error-messages, formatted into a list.
989 public function formatPermissionsErrorMessage( $errors ) {
990 $text = wfMsgExt( 'permissionserrorstext', array( 'parsemag' ), count( $errors ) ) . "\n\n";
992 if (count( $errors ) > 1) {
993 $text .= '<ul class="permissions-errors">' . "\n";
995 foreach( $errors as $error )
998 $text .= call_user_func_array( 'wfMsg', $error );
1003 $text .= '<div class="permissions-errors">' . call_user_func_array( 'wfMsg', $errors[0]) . '</div>';
1010 * Display a page stating that the Wiki is in read-only mode,
1011 * and optionally show the source of the page that the user
1012 * was trying to edit. Should only be called (for this
1013 * purpose) after wfReadOnly() has returned true.
1015 * For historical reasons, this function is _also_ used to
1016 * show the error message when a user tries to edit a page
1017 * they are not allowed to edit. (Unless it's because they're
1018 * blocked, then we show blockedPage() instead.) In this
1019 * case, the second parameter should be set to true and a list
1020 * of reasons supplied as the third parameter.
1022 * @todo Needs to be split into multiple functions.
1024 * @param string $source Source code to show (or null).
1025 * @param bool $protected Is this a permissions error?
1026 * @param array $reasons List of reasons for this error, as returned by Title::getUserPermissionsErrors().
1028 public function readOnlyPage( $source = null, $protected = false, $reasons = array() ) {
1029 global $wgUser, $wgReadOnlyFile, $wgReadOnly, $wgTitle;
1030 $skin = $wgUser->getSkin();
1032 $this->setRobotpolicy( 'noindex,nofollow' );
1033 $this->setArticleRelated( false );
1035 // If no reason is given, just supply a default "I can't let you do
1036 // that, Dave" message. Should only occur if called by legacy code.
1037 if ( $protected && empty($reasons) ) {
1038 $reasons[] = array( 'badaccess-group0' );
1041 if ( !empty($reasons) ) {
1042 // Permissions error
1044 $this->setPageTitle( wfMsg( 'viewsource' ) );
1045 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
1047 $this->setPageTitle( wfMsg( 'badaccess' ) );
1049 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons ) );
1051 // Wiki is read only
1052 $this->setPageTitle( wfMsg( 'readonly' ) );
1053 if ( $wgReadOnly ) {
1054 $reason = $wgReadOnly;
1056 // Should not happen, user should have called wfReadOnly() first
1057 $reason = file_get_contents( $wgReadOnlyFile );
1059 $this->addWikiText( wfMsg( 'readonlytext', $reason ) );
1062 // Show source, if supplied
1063 if( is_string( $source ) ) {
1064 $this->addWikiText( wfMsg( 'viewsourcetext' ) );
1065 $text = wfOpenElement( 'textarea',
1066 array( 'id' => 'wpTextbox1',
1067 'name' => 'wpTextbox1',
1068 'cols' => $wgUser->getOption( 'cols' ),
1069 'rows' => $wgUser->getOption( 'rows' ),
1070 'readonly' => 'readonly' ) );
1071 $text .= htmlspecialchars( $source );
1072 $text .= wfCloseElement( 'textarea' );
1073 $this->addHTML( $text );
1075 // Show templates used by this article
1076 $skin = $wgUser->getSkin();
1077 $article = new Article( $wgTitle );
1078 $this->addHTML( $skin->formatTemplates( $article->getUsedTemplates() ) );
1081 # If the title doesn't exist, it's fairly pointless to print a return
1082 # link to it. After all, you just tried editing it and couldn't, so
1083 # what's there to do there?
1084 if( $wgTitle->exists() ) {
1085 $this->returnToMain( false, $wgTitle );
1090 public function fatalError( $message ) {
1091 throw new FatalError( $message );
1095 public function unexpectedValueError( $name, $val ) {
1096 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
1100 public function fileCopyError( $old, $new ) {
1101 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
1105 public function fileRenameError( $old, $new ) {
1106 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
1110 public function fileDeleteError( $name ) {
1111 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
1115 public function fileNotFoundError( $name ) {
1116 throw new FatalError( wfMsg( 'filenotfound', $name ) );
1119 public function showFatalError( $message ) {
1120 $this->setPageTitle( wfMsg( "internalerror" ) );
1121 $this->setRobotpolicy( "noindex,nofollow" );
1122 $this->setArticleRelated( false );
1123 $this->enableClientCache( false );
1124 $this->mRedirect
= '';
1125 $this->mBodytext
= $message;
1128 public function showUnexpectedValueError( $name, $val ) {
1129 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
1132 public function showFileCopyError( $old, $new ) {
1133 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
1136 public function showFileRenameError( $old, $new ) {
1137 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
1140 public function showFileDeleteError( $name ) {
1141 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
1144 public function showFileNotFoundError( $name ) {
1145 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
1149 * Add a "return to" link pointing to a specified title
1151 * @param Title $title Title to link
1153 public function addReturnTo( $title ) {
1155 $link = wfMsg( 'returnto', $wgUser->getSkin()->makeLinkObj( $title ) );
1156 $this->addHtml( "<p>{$link}</p>\n" );
1160 * Add a "return to" link pointing to a specified title,
1161 * or the title indicated in the request, or else the main page
1163 * @param null $unused No longer used
1164 * @param Title $returnto Title to return to
1166 public function returnToMain( $unused = null, $returnto = NULL ) {
1169 if ( $returnto == NULL ) {
1170 $returnto = $wgRequest->getText( 'returnto' );
1173 if ( '' === $returnto ) {
1174 $returnto = Title
::newMainPage();
1177 if ( is_object( $returnto ) ) {
1178 $titleObj = $returnto;
1180 $titleObj = Title
::newFromText( $returnto );
1182 if ( !is_object( $titleObj ) ) {
1183 $titleObj = Title
::newMainPage();
1186 $this->addReturnTo( $titleObj );
1190 * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1191 * and uses the first 10 of them for META keywords
1193 * @param ParserOutput &$parserOutput
1195 private function addKeywords( &$parserOutput ) {
1197 $this->addKeyword( $wgTitle->getPrefixedText() );
1199 $links2d =& $parserOutput->getLinks();
1200 if ( !is_array( $links2d ) ) {
1203 foreach ( $links2d as $dbkeys ) {
1204 foreach( $dbkeys as $dbkey => $unused ) {
1205 $this->addKeyword( $dbkey );
1206 if ( ++
$count > 10 ) {
1214 * @return string The doctype, opening <html>, and head element.
1216 public function headElement() {
1217 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1218 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1219 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1221 if( $wgMimeType == 'text/xml' ||
$wgMimeType == 'application/xhtml+xml' ||
$wgMimeType == 'application/xml' ) {
1222 $ret = "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1227 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n \"$wgDTD\">\n";
1229 if ( '' == $this->getHTMLTitle() ) {
1230 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ));
1233 $rtl = $wgContLang->isRTL() ?
" dir='RTL'" : '';
1234 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1235 foreach($wgXhtmlNamespaces as $tag => $ns) {
1236 $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1238 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1239 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n";
1240 array_push( $this->mMetatags
, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) );
1242 $ret .= $this->getHeadLinks();
1243 global $wgStylePath;
1244 if( $this->isPrintable() ) {
1247 $media = "media='print'";
1249 $printsheet = htmlspecialchars( "$wgStylePath/common/wikiprintable.css?$wgStyleVersion" );
1250 $ret .= "<link rel='stylesheet' type='text/css' $media href='$printsheet' />\n";
1252 $sk = $wgUser->getSkin();
1253 $ret .= $sk->getHeadScripts( $this->mAllowUserJs
);
1254 $ret .= $this->mScripts
;
1255 $ret .= $sk->getUserStyles();
1256 $ret .= $this->getHeadItems();
1258 if ($wgUseTrackbacks && $this->isArticleRelated())
1259 $ret .= $wgTitle->trackbackRDF();
1261 $ret .= "</head>\n";
1266 * @return string HTML tag links to be put in the header.
1268 public function getHeadLinks() {
1271 foreach ( $this->mMetatags
as $tag ) {
1272 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1274 $tag[0] = substr( $tag[0], 5 );
1278 $ret .= "<meta $a=\"{$tag[0]}\" content=\"{$tag[1]}\" />\n";
1281 $p = $this->mRobotpolicy
;
1282 if( $p !== '' && $p != 'index,follow' ) {
1283 // http://www.robotstxt.org/wc/meta-user.html
1284 // Only show if it's different from the default robots policy
1285 $ret .= "<meta name=\"robots\" content=\"$p\" />\n";
1288 if ( count( $this->mKeywords
) > 0 ) {
1293 $ret .= "\t\t<meta name=\"keywords\" content=\"" .
1294 htmlspecialchars(preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords
))) . "\" />\n";
1296 foreach ( $this->mLinktags
as $tag ) {
1297 $ret .= "\t\t<link";
1298 foreach( $tag as $attr => $val ) {
1299 $ret .= " $attr=\"" . htmlspecialchars( $val ) . "\"";
1304 foreach( $this->getSyndicationLinks() as $format => $link ) {
1305 # Use the page name for the title (accessed through $wgTitle since
1306 # there's no other way). In principle, this could lead to issues
1307 # with having the same name for different feeds corresponding to
1308 # the same page, but we can't avoid that at this low a level.
1311 $ret .= $this->feedLink(
1314 wfMsg( "page-{$format}-feed", $wgTitle->getPrefixedText() ) ); # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
1317 # Recent changes feed should appear on every page
1318 # Put it after the per-page feed to avoid changing existing behavior.
1319 # It's still available, probably via a menu in your browser.
1321 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
1322 $ret .= $this->feedLink(
1324 $rctitle->getFullURL( 'feed=rss' ),
1325 wfMsg( 'site-rss-feed', $wgSitename ) );
1326 $ret .= $this->feedLink(
1328 $rctitle->getFullURL( 'feed=atom' ),
1329 wfMsg( 'site-atom-feed', $wgSitename ) );
1335 * Return URLs for each supported syndication format for this page.
1336 * @return array associating format keys with URLs
1338 public function getSyndicationLinks() {
1339 global $wgTitle, $wgFeedClasses;
1342 if( $this->isSyndicated() ) {
1343 if( is_string( $this->getFeedAppendQuery() ) ) {
1344 $appendQuery = "&" . $this->getFeedAppendQuery();
1349 foreach( $wgFeedClasses as $format => $class ) {
1350 $links[$format] = $wgTitle->getLocalUrl( "feed=$format{$appendQuery}" );
1357 * Generate a <link rel/> for an RSS feed.
1359 private function feedLink( $type, $url, $text ) {
1360 return Xml
::element( 'link', array(
1361 'rel' => 'alternate',
1362 'type' => "application/$type+xml",
1364 'href' => $url ) ) . "\n";
1368 * Turn off regular page output and return an error reponse
1369 * for when rate limiting has triggered.
1371 public function rateLimited() {
1372 global $wgOut, $wgTitle;
1374 $this->setPageTitle(wfMsg('actionthrottled'));
1375 $this->setRobotPolicy( 'noindex,follow' );
1376 $this->setArticleRelated( false );
1377 $this->enableClientCache( false );
1378 $this->mRedirect
= '';
1380 $this->setStatusCode(503);
1381 $this->addWikiText( wfMsg('actionthrottledtext') );
1383 $this->returnToMain( false, $wgTitle );
1387 * Show an "add new section" link?
1391 public function showNewSectionLink() {
1392 return $this->mNewSectionLink
;
1396 * Show a warning about slave lag
1398 * If the lag is higher than $wgSlaveLagCritical seconds,
1399 * then the warning is a bit more obvious. If the lag is
1400 * lower than $wgSlaveLagWarning, then no warning is shown.
1402 * @param int $lag Slave lag
1404 public function showLagWarning( $lag ) {
1405 global $wgSlaveLagWarning, $wgSlaveLagCritical;
1406 if( $lag >= $wgSlaveLagWarning ) {
1407 $message = $lag < $wgSlaveLagCritical
1410 $warning = wfMsgExt( $message, 'parse', $lag );
1411 $this->addHtml( "<div class=\"mw-{$message}\">\n{$warning}\n</div>\n" );