31c7236000b4ec9079e8ceffbfb50056376dfd5e
[lhc/web/wiklou.git] / includes / OutputPage.php
1 <?php
2 if ( ! defined( 'MEDIAWIKI' ) )
3 die( 1 );
4 /**
5 */
6
7 /**
8 * @todo document
9 */
10 class OutputPage {
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;
17
18 var $mSuppressQuickbar;
19 var $mOnloadHandler;
20 var $mDoNothing;
21 var $mContainsOldMagic, $mContainsNewMagic;
22 var $mIsArticleRelated;
23 protected $mParserOptions; // lazy initialised, use parserOptions()
24 var $mShowFeedLinks = false;
25 var $mEnableClientCache = true;
26 var $mArticleBodyOnly = false;
27
28 var $mNewSectionLink = false;
29 var $mNoGallery = false;
30
31 /**
32 * Constructor
33 * Initialise private variables
34 */
35 function __construct() {
36 $this->mMetatags = $this->mKeywords = $this->mLinktags = array();
37 $this->mHTMLtitle = $this->mPagetitle = $this->mBodytext =
38 $this->mRedirect = $this->mLastModified =
39 $this->mSubtitle = $this->mDebugtext = $this->mRobotpolicy =
40 $this->mOnloadHandler = $this->mPageLinkTitle = '';
41 $this->mIsArticleRelated = $this->mIsarticle = $this->mPrintable = true;
42 $this->mSuppressQuickbar = $this->mPrintable = false;
43 $this->mLanguageLinks = array();
44 $this->mCategoryLinks = array();
45 $this->mDoNothing = false;
46 $this->mContainsOldMagic = $this->mContainsNewMagic = 0;
47 $this->mParserOptions = null;
48 $this->mSquidMaxage = 0;
49 $this->mScripts = '';
50 $this->mETag = false;
51 $this->mRevisionId = null;
52 $this->mNewSectionLink = false;
53 }
54
55 public function redirect( $url, $responsecode = '302' ) {
56 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
57 $this->mRedirect = str_replace( "\n", '', $url );
58 $this->mRedirectCode = $responsecode;
59 }
60
61 /**
62 * Set the HTTP status code to send with the output.
63 *
64 * @param int $statusCode
65 * @return nothing
66 */
67 function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; }
68
69 # To add an http-equiv meta tag, precede the name with "http:"
70 function addMeta( $name, $val ) { array_push( $this->mMetatags, array( $name, $val ) ); }
71 function addKeyword( $text ) { array_push( $this->mKeywords, $text ); }
72 function addScript( $script ) { $this->mScripts .= "\t\t".$script; }
73
74 /**
75 * Add a self-contained script tag with the given contents
76 * @param string $script JavaScript text, no <script> tags
77 */
78 function addInlineScript( $script ) {
79 global $wgJsMimeType;
80 $this->mScripts .= "<script type=\"$wgJsMimeType\"><!--\n$script\n--></script>";
81 }
82
83 function getScript() { return $this->mScripts; }
84
85 function setETag($tag) { $this->mETag = $tag; }
86 function setArticleBodyOnly($only) { $this->mArticleBodyOnly = $only; }
87 function getArticleBodyOnly($only) { return $this->mArticleBodyOnly; }
88
89 function addLink( $linkarr ) {
90 # $linkarr should be an associative array of attributes. We'll escape on output.
91 array_push( $this->mLinktags, $linkarr );
92 }
93
94 function addMetadataLink( $linkarr ) {
95 # note: buggy CC software only reads first "meta" link
96 static $haveMeta = false;
97 $linkarr['rel'] = ($haveMeta) ? 'alternate meta' : 'meta';
98 $this->addLink( $linkarr );
99 $haveMeta = true;
100 }
101
102 /**
103 * checkLastModified tells the client to use the client-cached page if
104 * possible. If sucessful, the OutputPage is disabled so that
105 * any future call to OutputPage->output() have no effect.
106 *
107 * @return bool True iff cache-ok headers was sent.
108 */
109 function checkLastModified ( $timestamp ) {
110 global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
111 $fname = 'OutputPage::checkLastModified';
112
113 if ( !$timestamp || $timestamp == '19700101000000' ) {
114 wfDebug( "$fname: CACHE DISABLED, NO TIMESTAMP\n" );
115 return;
116 }
117 if( !$wgCachePages ) {
118 wfDebug( "$fname: CACHE DISABLED\n", false );
119 return;
120 }
121 if( $wgUser->getOption( 'nocache' ) ) {
122 wfDebug( "$fname: USER DISABLED CACHE\n", false );
123 return;
124 }
125
126 $timestamp=wfTimestamp(TS_MW,$timestamp);
127 $lastmod = wfTimestamp( TS_RFC2822, max( $timestamp, $wgUser->mTouched, $wgCacheEpoch ) );
128
129 if( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
130 # IE sends sizes after the date like this:
131 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
132 # this breaks strtotime().
133 $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
134 $modsinceTime = strtotime( $modsince );
135 $ismodsince = wfTimestamp( TS_MW, $modsinceTime ? $modsinceTime : 1 );
136 wfDebug( "$fname: -- client send If-Modified-Since: " . $modsince . "\n", false );
137 wfDebug( "$fname: -- we might send Last-Modified : $lastmod\n", false );
138 if( ($ismodsince >= $timestamp ) && $wgUser->validateCache( $ismodsince ) && $ismodsince >= $wgCacheEpoch ) {
139 # Make sure you're in a place you can leave when you call us!
140 $wgRequest->response()->header( "HTTP/1.0 304 Not Modified" );
141 $this->mLastModified = $lastmod;
142 $this->sendCacheControl();
143 wfDebug( "$fname: CACHED client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
144 $this->disable();
145
146 // Don't output a compressed blob when using ob_gzhandler;
147 // it's technically against HTTP spec and seems to confuse
148 // Firefox when the response gets split over two packets.
149 wfClearOutputBuffers();
150
151 return true;
152 } else {
153 wfDebug( "$fname: READY client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
154 $this->mLastModified = $lastmod;
155 }
156 } else {
157 wfDebug( "$fname: client did not send If-Modified-Since header\n", false );
158 $this->mLastModified = $lastmod;
159 }
160 }
161
162 function getPageTitleActionText () {
163 global $action;
164 switch($action) {
165 case 'edit':
166 case 'delete':
167 case 'protect':
168 case 'unprotect':
169 case 'watch':
170 case 'unwatch':
171 // Display title is already customized
172 return '';
173 case 'history':
174 return wfMsg('history_short');
175 case 'submit':
176 // FIXME: bug 2735; not correct for special pages etc
177 return wfMsg('preview');
178 case 'info':
179 return wfMsg('info_short');
180 default:
181 return '';
182 }
183 }
184
185 public function setRobotpolicy( $str ) { $this->mRobotpolicy = $str; }
186 public function setHTMLTitle( $name ) {$this->mHTMLtitle = $name; }
187 public function setPageTitle( $name ) {
188 global $action, $wgContLang;
189 $name = $wgContLang->convert($name, true);
190 $this->mPagetitle = $name;
191 if(!empty($action)) {
192 $taction = $this->getPageTitleActionText();
193 if( !empty( $taction ) ) {
194 $name .= ' - '.$taction;
195 }
196 }
197
198 $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
199 }
200 public function getHTMLTitle() { return $this->mHTMLtitle; }
201 public function getPageTitle() { return $this->mPagetitle; }
202 public function setSubtitle( $str ) { $this->mSubtitle = /*$this->parse(*/$str/*)*/; } // @bug 2514
203 public function getSubtitle() { return $this->mSubtitle; }
204 public function isArticle() { return $this->mIsarticle; }
205 public function setPrintable() { $this->mPrintable = true; }
206 public function isPrintable() { return $this->mPrintable; }
207 public function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; }
208 public function isSyndicated() { return $this->mShowFeedLinks; }
209 public function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; }
210 public function getOnloadHandler() { return $this->mOnloadHandler; }
211 public function disable() { $this->mDoNothing = true; }
212
213 public function setArticleRelated( $v ) {
214 $this->mIsArticleRelated = $v;
215 if ( !$v ) {
216 $this->mIsarticle = false;
217 }
218 }
219 public function setArticleFlag( $v ) {
220 $this->mIsarticle = $v;
221 if ( $v ) {
222 $this->mIsArticleRelated = $v;
223 }
224 }
225
226 public function isArticleRelated() { return $this->mIsArticleRelated; }
227
228 public function getLanguageLinks() { return $this->mLanguageLinks; }
229 public function addLanguageLinks($newLinkArray) {
230 $this->mLanguageLinks += $newLinkArray;
231 }
232 public function setLanguageLinks($newLinkArray) {
233 $this->mLanguageLinks = $newLinkArray;
234 }
235
236 public function getCategoryLinks() {
237 return $this->mCategoryLinks;
238 }
239
240 /**
241 * Add an array of categories, with names in the keys
242 */
243 public function addCategoryLinks($categories) {
244 global $wgUser, $wgContLang;
245
246 if ( !is_array( $categories ) ) {
247 return;
248 }
249 # Add the links to the link cache in a batch
250 $arr = array( NS_CATEGORY => $categories );
251 $lb = new LinkBatch;
252 $lb->setArray( $arr );
253 $lb->execute();
254
255 $sk = $wgUser->getSkin();
256 foreach ( $categories as $category => $unused ) {
257 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
258 $text = $wgContLang->convertHtml( $title->getText() );
259 $this->mCategoryLinks[] = $sk->makeLinkObj( $title, $text );
260 }
261 }
262
263 public function setCategoryLinks($categories) {
264 $this->mCategoryLinks = array();
265 $this->addCategoryLinks($categories);
266 }
267
268 public function suppressQuickbar() { $this->mSuppressQuickbar = true; }
269 public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; }
270
271 public function addHTML( $text ) { $this->mBodytext .= $text; }
272 public function clearHTML() { $this->mBodytext = ''; }
273 public function getHTML() { return $this->mBodytext; }
274 public function debug( $text ) { $this->mDebugtext .= $text; }
275
276 /* @deprecated */
277 public function setParserOptions( $options ) {
278 return $this->parserOptions( $options );
279 }
280
281 public function parserOptions( $options = null ) {
282 if ( !$this->mParserOptions ) {
283 $this->mParserOptions = new ParserOptions;
284 }
285 return wfSetVar( $this->mParserOptions, $options );
286 }
287
288 /**
289 * Set the revision ID which will be seen by the wiki text parser
290 * for things such as embedded {{REVISIONID}} variable use.
291 * @param mixed $revid an integer, or NULL
292 * @return mixed previous value
293 */
294 public function setRevisionId( $revid ) {
295 $val = is_null( $revid ) ? null : intval( $revid );
296 return wfSetVar( $this->mRevisionId, $val );
297 }
298
299 /**
300 * Convert wikitext to HTML and add it to the buffer
301 * Default assumes that the current page title will
302 * be used.
303 *
304 * @param string $text
305 * @param bool $linestart
306 */
307 public function addWikiText( $text, $linestart = true ) {
308 global $wgTitle;
309 $this->addWikiTextTitle($text, $wgTitle, $linestart);
310 }
311
312 public function addWikiTextWithTitle($text, &$title, $linestart = true) {
313 $this->addWikiTextTitle($text, $title, $linestart);
314 }
315
316 function addWikiTextTitleTidy($text, &$title, $linestart = true) {
317 $this->addWikiTextTitle( $text, $title, $linestart, true );
318 }
319
320 public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) {
321 global $wgParser;
322
323 $fname = 'OutputPage:addWikiTextTitle';
324 wfProfileIn($fname);
325
326 wfIncrStats('pcache_not_possible');
327
328 $popts = $this->parserOptions();
329 $popts->setTidy($tidy);
330
331 $parserOutput = $wgParser->parse( $text, $title, $popts,
332 $linestart, true, $this->mRevisionId );
333
334 $this->addParserOutput( $parserOutput );
335
336 wfProfileOut($fname);
337 }
338
339 /**
340 * @todo document
341 * @param ParserOutput object &$parserOutput
342 */
343 public function addParserOutputNoText( &$parserOutput ) {
344 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
345 $this->addCategoryLinks( $parserOutput->getCategories() );
346 $this->mNewSectionLink = $parserOutput->getNewSection();
347 $this->addKeywords( $parserOutput );
348 if ( $parserOutput->getCacheTime() == -1 ) {
349 $this->enableClientCache( false );
350 }
351 if ( $parserOutput->mHTMLtitle != "" ) {
352 $this->mPagetitle = $parserOutput->mHTMLtitle ;
353 }
354 if ( $parserOutput->mSubtitle != '' ) {
355 $this->mSubtitle .= $parserOutput->mSubtitle ;
356 }
357 $this->mNoGallery = $parserOutput->getNoGallery();
358 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
359 }
360
361 /**
362 * @todo document
363 * @param ParserOutput &$parserOutput
364 */
365 function addParserOutput( &$parserOutput ) {
366 $this->addParserOutputNoText( $parserOutput );
367 $text = $parserOutput->getText();
368 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
369 $this->addHTML( $text );
370 }
371
372 /**
373 * Add wikitext to the buffer, assuming that this is the primary text for a page view
374 * Saves the text into the parser cache if possible.
375 *
376 * @param string $text
377 * @param Article $article
378 * @param bool $cache
379 * @deprecated Use Article::outputWikitext
380 */
381 public function addPrimaryWikiText( $text, $article, $cache = true ) {
382 global $wgParser, $wgUser;
383
384 $popts = $this->parserOptions();
385 $popts->setTidy(true);
386 $parserOutput = $wgParser->parse( $text, $article->mTitle,
387 $popts, true, true, $this->mRevisionId );
388 $popts->setTidy(false);
389 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
390 $parserCache =& ParserCache::singleton();
391 $parserCache->save( $parserOutput, $article, $wgUser );
392 }
393
394 $this->addParserOutput( $parserOutput );
395 }
396
397 /**
398 * @deprecated use addWikiTextTidy()
399 */
400 public function addSecondaryWikiText( $text, $linestart = true ) {
401 global $wgTitle;
402 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
403 }
404
405 /**
406 * Add wikitext with tidy enabled
407 */
408 public function addWikiTextTidy( $text, $linestart = true ) {
409 global $wgTitle;
410 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
411 }
412
413
414 /**
415 * Add the output of a QuickTemplate to the output buffer
416 *
417 * @param QuickTemplate $template
418 */
419 public function addTemplate( &$template ) {
420 ob_start();
421 $template->execute();
422 $this->addHTML( ob_get_contents() );
423 ob_end_clean();
424 }
425
426 /**
427 * Parse wikitext and return the HTML.
428 *
429 * @param string $text
430 * @param bool $linestart Is this the start of a line?
431 * @param bool $interface ??
432 */
433 public function parse( $text, $linestart = true, $interface = false ) {
434 global $wgParser, $wgTitle;
435 $popts = $this->parserOptions();
436 if ( $interface) { $popts->setInterfaceMessage(true); }
437 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
438 $linestart, true, $this->mRevisionId );
439 if ( $interface) { $popts->setInterfaceMessage(false); }
440 return $parserOutput->getText();
441 }
442
443 /**
444 * @param Article $article
445 * @param User $user
446 *
447 * @return bool True if successful, else false.
448 */
449 public function tryParserCache( &$article, $user ) {
450 $parserCache =& ParserCache::singleton();
451 $parserOutput = $parserCache->get( $article, $user );
452 if ( $parserOutput !== false ) {
453 $this->addParserOutput( $parserOutput );
454 return true;
455 } else {
456 return false;
457 }
458 }
459
460 /**
461 * @param int $maxage Maximum cache time on the Squid, in seconds.
462 */
463 public function setSquidMaxage( $maxage ) {
464 $this->mSquidMaxage = $maxage;
465 }
466
467 /**
468 * Use enableClientCache(false) to force it to send nocache headers
469 * @param $state ??
470 */
471 public function enableClientCache( $state ) {
472 return wfSetVar( $this->mEnableClientCache, $state );
473 }
474
475 function uncacheableBecauseRequestvars() {
476 global $wgRequest;
477 return $wgRequest->getText('useskin', false) === false
478 && $wgRequest->getText('uselang', false) === false;
479 }
480
481 public function sendCacheControl() {
482 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
483 $fname = 'OutputPage::sendCacheControl';
484
485 if ($wgUseETag && $this->mETag)
486 $wgRequest->response()->header("ETag: $this->mETag");
487
488 # don't serve compressed data to clients who can't handle it
489 # maintain different caches for logged-in users and non-logged in ones
490 $wgRequest->response()->header( 'Vary: Accept-Encoding, Cookie' );
491 if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache ) {
492 if( $wgUseSquid && ! isset( $_COOKIE[ini_get( 'session.name') ] ) &&
493 ! $this->isPrintable() && $this->mSquidMaxage != 0 )
494 {
495 if ( $wgUseESI ) {
496 # We'll purge the proxy cache explicitly, but require end user agents
497 # to revalidate against the proxy on each visit.
498 # Surrogate-Control controls our Squid, Cache-Control downstream caches
499 wfDebug( "$fname: proxy caching with ESI; {$this->mLastModified} **\n", false );
500 # start with a shorter timeout for initial testing
501 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
502 $wgRequest->response()->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
503 $wgRequest->response()->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
504 } else {
505 # We'll purge the proxy cache for anons explicitly, but require end user agents
506 # to revalidate against the proxy on each visit.
507 # IMPORTANT! The Squid needs to replace the Cache-Control header with
508 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
509 wfDebug( "$fname: local proxy caching; {$this->mLastModified} **\n", false );
510 # start with a shorter timeout for initial testing
511 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
512 $wgRequest->response()->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
513 }
514 } else {
515 # We do want clients to cache if they can, but they *must* check for updates
516 # on revisiting the page.
517 wfDebug( "$fname: private caching; {$this->mLastModified} **\n", false );
518 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
519 $wgRequest->response()->header( "Cache-Control: private, must-revalidate, max-age=0" );
520 }
521 if($this->mLastModified) $wgRequest->response()->header( "Last-modified: {$this->mLastModified}" );
522 } else {
523 wfDebug( "$fname: no caching **\n", false );
524
525 # In general, the absence of a last modified header should be enough to prevent
526 # the client from using its cache. We send a few other things just to make sure.
527 $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
528 $wgRequest->response()->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
529 $wgRequest->response()->header( 'Pragma: no-cache' );
530 }
531 }
532
533 /**
534 * Finally, all the text has been munged and accumulated into
535 * the object, let's actually output it:
536 */
537 public function output() {
538 global $wgUser, $wgOutputEncoding, $wgRequest;
539 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
540 global $wgJsMimeType, $wgStylePath, $wgUseAjax, $wgAjaxSearch, $wgAjaxWatch;
541 global $wgServer, $wgStyleVersion;
542
543 if( $this->mDoNothing ){
544 return;
545 }
546 $fname = 'OutputPage::output';
547 wfProfileIn( $fname );
548 $sk = $wgUser->getSkin();
549
550 if ( $wgUseAjax ) {
551 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajax.js?$wgStyleVersion\"></script>\n" );
552
553 wfRunHooks( 'AjaxAddScript', array( &$this ) );
554
555 if( $wgAjaxSearch ) {
556 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxsearch.js\"></script>\n" );
557 $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" );
558 }
559
560 if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
561 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxwatch.js\"></script>\n" );
562 }
563 }
564
565 if ( '' != $this->mRedirect ) {
566 if( substr( $this->mRedirect, 0, 4 ) != 'http' ) {
567 # Standards require redirect URLs to be absolute
568 global $wgServer;
569 $this->mRedirect = $wgServer . $this->mRedirect;
570 }
571 if( $this->mRedirectCode == '301') {
572 if( !$wgDebugRedirects ) {
573 $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
574 }
575 $this->mLastModified = wfTimestamp( TS_RFC2822 );
576 }
577
578 $this->sendCacheControl();
579
580 if( $wgDebugRedirects ) {
581 $url = htmlspecialchars( $this->mRedirect );
582 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
583 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
584 print "</body>\n</html>\n";
585 } else {
586 $wgRequest->response()->header( 'Location: '.$this->mRedirect );
587 }
588 wfProfileOut( $fname );
589 return;
590 }
591 elseif ( $this->mStatusCode )
592 {
593 $statusMessage = array(
594 100 => 'Continue',
595 101 => 'Switching Protocols',
596 102 => 'Processing',
597 200 => 'OK',
598 201 => 'Created',
599 202 => 'Accepted',
600 203 => 'Non-Authoritative Information',
601 204 => 'No Content',
602 205 => 'Reset Content',
603 206 => 'Partial Content',
604 207 => 'Multi-Status',
605 300 => 'Multiple Choices',
606 301 => 'Moved Permanently',
607 302 => 'Found',
608 303 => 'See Other',
609 304 => 'Not Modified',
610 305 => 'Use Proxy',
611 307 => 'Temporary Redirect',
612 400 => 'Bad Request',
613 401 => 'Unauthorized',
614 402 => 'Payment Required',
615 403 => 'Forbidden',
616 404 => 'Not Found',
617 405 => 'Method Not Allowed',
618 406 => 'Not Acceptable',
619 407 => 'Proxy Authentication Required',
620 408 => 'Request Timeout',
621 409 => 'Conflict',
622 410 => 'Gone',
623 411 => 'Length Required',
624 412 => 'Precondition Failed',
625 413 => 'Request Entity Too Large',
626 414 => 'Request-URI Too Large',
627 415 => 'Unsupported Media Type',
628 416 => 'Request Range Not Satisfiable',
629 417 => 'Expectation Failed',
630 422 => 'Unprocessable Entity',
631 423 => 'Locked',
632 424 => 'Failed Dependency',
633 500 => 'Internal Server Error',
634 501 => 'Not Implemented',
635 502 => 'Bad Gateway',
636 503 => 'Service Unavailable',
637 504 => 'Gateway Timeout',
638 505 => 'HTTP Version Not Supported',
639 507 => 'Insufficient Storage'
640 );
641
642 if ( $statusMessage[$this->mStatusCode] )
643 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] );
644 }
645
646 # Buffer output; final headers may depend on later processing
647 ob_start();
648
649 # Disable temporary placeholders, so that the skin produces HTML
650 $sk->postParseLinkColour( false );
651
652 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
653 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
654
655 if ($this->mArticleBodyOnly) {
656 $this->out($this->mBodytext);
657 } else {
658 wfProfileIn( 'Output-skin' );
659 $sk->outputPage( $this );
660 wfProfileOut( 'Output-skin' );
661 }
662
663 $this->sendCacheControl();
664 ob_end_flush();
665 wfProfileOut( $fname );
666 }
667
668 /**
669 * @todo document
670 * @param string $ins
671 */
672 public function out( $ins ) {
673 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
674 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
675 $outs = $ins;
676 } else {
677 $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
678 if ( false === $outs ) { $outs = $ins; }
679 }
680 print $outs;
681 }
682
683 /**
684 * @todo document
685 */
686 public static function setEncodings() {
687 global $wgInputEncoding, $wgOutputEncoding;
688 global $wgUser, $wgContLang;
689
690 $wgInputEncoding = strtolower( $wgInputEncoding );
691
692 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
693 $wgOutputEncoding = strtolower( $wgOutputEncoding );
694 return;
695 }
696 $wgOutputEncoding = $wgInputEncoding;
697 }
698
699 /**
700 * Deprecated, use wfReportTime() instead.
701 * @return string
702 * @deprecated
703 */
704 public function reportTime() {
705 $time = wfReportTime();
706 return $time;
707 }
708
709 /**
710 * Produce a "user is blocked" page.
711 *
712 * @param bool $return Whether to have a "return to $wgTitle" message or not.
713 * @return nothing
714 */
715 function blockedPage( $return = true ) {
716 global $wgUser, $wgContLang, $wgTitle;
717
718 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
719 $this->setRobotpolicy( 'noindex,nofollow' );
720 $this->setArticleRelated( false );
721
722 $id = $wgUser->blockedBy();
723 $reason = $wgUser->blockedFor();
724 $ip = wfGetIP();
725
726 if ( is_numeric( $id ) ) {
727 $name = User::whoIs( $id );
728 } else {
729 $name = $id;
730 }
731 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
732
733 $blockid = $wgUser->mBlock->mId;
734
735 $this->addWikiText( wfMsg( 'blockedtext', $link, $reason, $ip, $name, $blockid ) );
736
737 # Don't auto-return to special pages
738 if( $return ) {
739 $return = $wgTitle->getNamespace() > -1 ? $wgTitle->getPrefixedText() : NULL;
740 $this->returnToMain( false, $return );
741 }
742 }
743
744 /**
745 * Outputs a pretty page to explain why the request exploded.
746 *
747 * @param string $title Message key for page title.
748 * @param string $msg Message key for page text.
749 * @return nothing
750 */
751 public function showErrorPage( $title, $msg ) {
752 global $wgTitle;
753
754 $this->mDebugtext .= 'Original title: ' .
755 $wgTitle->getPrefixedText() . "\n";
756 $this->setPageTitle( wfMsg( $title ) );
757 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
758 $this->setRobotpolicy( 'noindex,nofollow' );
759 $this->setArticleRelated( false );
760 $this->enableClientCache( false );
761 $this->mRedirect = '';
762
763 $this->mBodytext = '';
764 $this->addWikiText( wfMsg( $msg ) );
765 $this->returnToMain( false );
766 }
767
768 /** @obsolete */
769 public function errorpage( $title, $msg ) {
770 throw new ErrorPageError( $title, $msg );
771 }
772
773 /**
774 * Display an error page indicating that a given version of MediaWiki is
775 * required to use it
776 *
777 * @param mixed $version The version of MediaWiki needed to use the page
778 */
779 public function versionRequired( $version ) {
780 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
781 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
782 $this->setRobotpolicy( 'noindex,nofollow' );
783 $this->setArticleRelated( false );
784 $this->mBodytext = '';
785
786 $this->addWikiText( wfMsg( 'versionrequiredtext', $version ) );
787 $this->returnToMain();
788 }
789
790 /**
791 * Display an error page noting that a given permission bit is required.
792 *
793 * @param string $permission key required
794 */
795 public function permissionRequired( $permission ) {
796 global $wgGroupPermissions, $wgUser;
797
798 $this->setPageTitle( wfMsg( 'badaccess' ) );
799 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
800 $this->setRobotpolicy( 'noindex,nofollow' );
801 $this->setArticleRelated( false );
802 $this->mBodytext = '';
803
804 $groups = array();
805 foreach( $wgGroupPermissions as $key => $value ) {
806 if( isset( $value[$permission] ) && $value[$permission] == true ) {
807 $groupName = User::getGroupName( $key );
808 $groupPage = User::getGroupPage( $key );
809 if( $groupPage ) {
810 $skin = $wgUser->getSkin();
811 $groups[] = '"'.$skin->makeLinkObj( $groupPage, $groupName ).'"';
812 } else {
813 $groups[] = '"'.$groupName.'"';
814 }
815 }
816 }
817 $n = count( $groups );
818 $groups = implode( ', ', $groups );
819 switch( $n ) {
820 case 0:
821 case 1:
822 case 2:
823 $message = wfMsgHtml( "badaccess-group$n", $groups );
824 break;
825 default:
826 $message = wfMsgHtml( 'badaccess-groups', $groups );
827 }
828 $this->addHtml( $message );
829 $this->returnToMain( false );
830 }
831
832 /**
833 * Use permissionRequired.
834 * @deprecated
835 */
836 public function sysopRequired() {
837 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
838 }
839
840 /**
841 * Use permissionRequired.
842 * @deprecated
843 */
844 public function developerRequired() {
845 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
846 }
847
848 /**
849 * Produce the stock "please login to use the wiki" page
850 */
851 public function loginToUse() {
852 global $wgUser, $wgTitle, $wgContLang;
853
854 if( $wgUser->isLoggedIn() ) {
855 $this->permissionRequired( 'read' );
856 return;
857 }
858
859 $skin = $wgUser->getSkin();
860
861 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
862 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
863 $this->setRobotPolicy( 'noindex,nofollow' );
864 $this->setArticleFlag( false );
865
866 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
867 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
868 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
869 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
870
871 # Don't return to the main page if the user can't read it
872 # otherwise we'll end up in a pointless loop
873 $mainPage = Title::newMainPage();
874 if( $mainPage->userCanRead() )
875 $this->returnToMain( true, $mainPage );
876 }
877
878 /** @obsolete */
879 public function databaseError( $fname, $sql, $error, $errno ) {
880 throw new MWException( "OutputPage::databaseError is obsolete\n" );
881 }
882
883 /**
884 * @todo document
885 * @param bool $protected Is the reason the page can't be reached because it's protected?
886 * @param mixed $source
887 */
888 public function readOnlyPage( $source = null, $protected = false ) {
889 global $wgUser, $wgReadOnlyFile, $wgReadOnly, $wgTitle;
890 $skin = $wgUser->getSkin();
891
892 $this->setRobotpolicy( 'noindex,nofollow' );
893 $this->setArticleRelated( false );
894
895 if( $protected ) {
896 $this->setPageTitle( wfMsg( 'viewsource' ) );
897 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
898
899 $cascadeSources = $wgTitle->getCascadeProtectionSources();
900
901 # Determine if protection is due to the page being a system message
902 # and show an appropriate explanation
903 if( $wgTitle->getNamespace() == NS_MEDIAWIKI ) {
904 $this->addWikiText( wfMsg( 'protectedinterface' ) );
905 } if ( $cascadeSources && count($cascadeSources) > 0 ) {
906 $titles = '';
907
908 foreach ( $cascadeSources as $title ) {
909 $titles .= '* [[:' . $title->getPrefixedText() . "]]\n";
910 }
911
912 $notice = wfMsg( 'cascadeprotected' ) . "\n$titles";
913
914 $this->addWikiText( $notice );
915 } else {
916 $this->addWikiText( wfMsg( 'protectedpagetext' ) );
917 }
918 } else {
919 $this->setPageTitle( wfMsg( 'readonly' ) );
920 if ( $wgReadOnly ) {
921 $reason = $wgReadOnly;
922 } else {
923 $reason = file_get_contents( $wgReadOnlyFile );
924 }
925 $this->addWikiText( wfMsg( 'readonlytext', $reason ) );
926 }
927
928 if( is_string( $source ) ) {
929 $this->addWikiText( wfMsg( 'viewsourcetext' ) );
930 $rows = $wgUser->getIntOption( 'rows' );
931 $cols = $wgUser->getIntOption( 'cols' );
932 $text = "\n<textarea name='wpTextbox1' id='wpTextbox1' cols='$cols' rows='$rows' readonly='readonly'>" .
933 htmlspecialchars( $source ) . "\n</textarea>";
934 $this->addHTML( $text );
935 }
936 $article = new Article($wgTitle);
937 $this->addHTML( $skin->formatTemplates($article->getUsedTemplates()) );
938
939 $this->returnToMain( false );
940 }
941
942 /** @obsolete */
943 public function fatalError( $message ) {
944 throw new FatalError( $message );
945 }
946
947 /** @obsolete */
948 public function unexpectedValueError( $name, $val ) {
949 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
950 }
951
952 /** @obsolete */
953 public function fileCopyError( $old, $new ) {
954 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
955 }
956
957 /** @obsolete */
958 public function fileRenameError( $old, $new ) {
959 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
960 }
961
962 /** @obsolete */
963 public function fileDeleteError( $name ) {
964 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
965 }
966
967 /** @obsolete */
968 public function fileNotFoundError( $name ) {
969 throw new FatalError( wfMsg( 'filenotfound', $name ) );
970 }
971
972 public function showFatalError( $message ) {
973 $this->setPageTitle( wfMsg( "internalerror" ) );
974 $this->setRobotpolicy( "noindex,nofollow" );
975 $this->setArticleRelated( false );
976 $this->enableClientCache( false );
977 $this->mRedirect = '';
978 $this->mBodytext = $message;
979 }
980
981 public function showUnexpectedValueError( $name, $val ) {
982 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
983 }
984
985 public function showFileCopyError( $old, $new ) {
986 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
987 }
988
989 public function showFileRenameError( $old, $new ) {
990 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
991 }
992
993 public function showFileDeleteError( $name ) {
994 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
995 }
996
997 public function showFileNotFoundError( $name ) {
998 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
999 }
1000
1001 /**
1002 * return from error messages or notes
1003 * @param $auto automatically redirect the user after 10 seconds
1004 * @param $returnto page title to return to. Default is Main Page.
1005 */
1006 public function returnToMain( $auto = true, $returnto = NULL ) {
1007 global $wgUser, $wgOut, $wgRequest;
1008
1009 if ( $returnto == NULL ) {
1010 $returnto = $wgRequest->getText( 'returnto' );
1011 }
1012
1013 if ( '' === $returnto ) {
1014 $returnto = Title::newMainPage();
1015 }
1016
1017 if ( is_object( $returnto ) ) {
1018 $titleObj = $returnto;
1019 } else {
1020 $titleObj = Title::newFromText( $returnto );
1021 }
1022 if ( !is_object( $titleObj ) ) {
1023 $titleObj = Title::newMainPage();
1024 }
1025
1026 $sk = $wgUser->getSkin();
1027 $link = $sk->makeLinkObj( $titleObj, '' );
1028
1029 $r = wfMsg( 'returnto', $link );
1030 if ( $auto ) {
1031 $wgOut->addMeta( 'http:Refresh', '10;url=' . $titleObj->escapeFullURL() );
1032 }
1033 $wgOut->addHTML( "\n<p>$r</p>\n" );
1034 }
1035
1036 /**
1037 * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1038 * and uses the first 10 of them for META keywords
1039 *
1040 * @param ParserOutput &$parserOutput
1041 */
1042 private function addKeywords( &$parserOutput ) {
1043 global $wgTitle;
1044 $this->addKeyword( $wgTitle->getPrefixedText() );
1045 $count = 1;
1046 $links2d =& $parserOutput->getLinks();
1047 if ( !is_array( $links2d ) ) {
1048 return;
1049 }
1050 foreach ( $links2d as $dbkeys ) {
1051 foreach( $dbkeys as $dbkey => $unused ) {
1052 $this->addKeyword( $dbkey );
1053 if ( ++$count > 10 ) {
1054 break 2;
1055 }
1056 }
1057 }
1058 }
1059
1060 /**
1061 * @return string The doctype, opening <html>, and head element.
1062 */
1063 public function headElement() {
1064 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1065 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1066 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1067
1068 if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
1069 $ret = "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1070 } else {
1071 $ret = '';
1072 }
1073
1074 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n \"$wgDTD\">\n";
1075
1076 if ( '' == $this->getHTMLTitle() ) {
1077 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ));
1078 }
1079
1080 $rtl = $wgContLang->isRTL() ? " dir='RTL'" : '';
1081 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1082 foreach($wgXhtmlNamespaces as $tag => $ns) {
1083 $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1084 }
1085 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1086 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n";
1087 array_push( $this->mMetatags, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) );
1088
1089 $ret .= $this->getHeadLinks();
1090 global $wgStylePath;
1091 if( $this->isPrintable() ) {
1092 $media = '';
1093 } else {
1094 $media = "media='print'";
1095 }
1096 $printsheet = htmlspecialchars( "$wgStylePath/common/wikiprintable.css?$wgStyleVersion" );
1097 $ret .= "<link rel='stylesheet' type='text/css' $media href='$printsheet' />\n";
1098
1099 $sk = $wgUser->getSkin();
1100 $ret .= $sk->getHeadScripts();
1101 $ret .= $this->mScripts;
1102 $ret .= $sk->getUserStyles();
1103
1104 if ($wgUseTrackbacks && $this->isArticleRelated())
1105 $ret .= $wgTitle->trackbackRDF();
1106
1107 $ret .= "</head>\n";
1108 return $ret;
1109 }
1110
1111 /**
1112 * @return string HTML tag links to be put in the header.
1113 */
1114 public function getHeadLinks() {
1115 global $wgRequest;
1116 $ret = '';
1117 foreach ( $this->mMetatags as $tag ) {
1118 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1119 $a = 'http-equiv';
1120 $tag[0] = substr( $tag[0], 5 );
1121 } else {
1122 $a = 'name';
1123 }
1124 $ret .= "<meta $a=\"{$tag[0]}\" content=\"{$tag[1]}\" />\n";
1125 }
1126
1127 $p = $this->mRobotpolicy;
1128 if( $p !== '' && $p != 'index,follow' ) {
1129 // http://www.robotstxt.org/wc/meta-user.html
1130 // Only show if it's different from the default robots policy
1131 $ret .= "<meta name=\"robots\" content=\"$p\" />\n";
1132 }
1133
1134 if ( count( $this->mKeywords ) > 0 ) {
1135 $strip = array(
1136 "/<.*?>/" => '',
1137 "/_/" => ' '
1138 );
1139 $ret .= "\t\t<meta name=\"keywords\" content=\"" .
1140 htmlspecialchars(preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ))) . "\" />\n";
1141 }
1142 foreach ( $this->mLinktags as $tag ) {
1143 $ret .= "\t\t<link";
1144 foreach( $tag as $attr => $val ) {
1145 $ret .= " $attr=\"" . htmlspecialchars( $val ) . "\"";
1146 }
1147 $ret .= " />\n";
1148 }
1149 if( $this->isSyndicated() ) {
1150 # FIXME: centralize the mime-type and name information in Feed.php
1151 $link = $wgRequest->escapeAppendQuery( 'feed=rss' );
1152 $ret .= "<link rel='alternate' type='application/rss+xml' title='RSS 2.0' href='$link' />\n";
1153 $link = $wgRequest->escapeAppendQuery( 'feed=atom' );
1154 $ret .= "<link rel='alternate' type='application/atom+xml' title='Atom 1.0' href='$link' />\n";
1155 }
1156
1157 return $ret;
1158 }
1159
1160 /**
1161 * Turn off regular page output and return an error reponse
1162 * for when rate limiting has triggered.
1163 * @todo i18n
1164 */
1165 public function rateLimited() {
1166 global $wgOut;
1167 $wgOut->disable();
1168 wfHttpError( 500, 'Internal Server Error',
1169 'Sorry, the server has encountered an internal error. ' .
1170 'Please wait a moment and hit "refresh" to submit the request again.' );
1171 }
1172
1173 /**
1174 * Show an "add new section" link?
1175 *
1176 * @return bool True if the parser output instructs us to add one
1177 */
1178 public function showNewSectionLink() {
1179 return $this->mNewSectionLink;
1180 }
1181 }
1182 ?>