Addendum to r40837: only validate/clean the body text, as we can assume the rest...
[lhc/web/wiklou.git] / includes / OutputPage.php
1 <?php
2 if ( ! defined( 'MEDIAWIKI' ) )
3 die( 1 );
4
5 /**
6 * @todo document
7 */
8 class OutputPage {
9 var $mMetatags = array(), $mKeywords = array(), $mLinktags = array();
10 var $mExtStyles = array();
11 var $mPagetitle = '', $mBodytext = '', $mDebugtext = '';
12 var $mHTMLtitle = '', $mIsarticle = true, $mPrintable = false;
13 var $mSubtitle = '', $mRedirect = '', $mStatusCode;
14 var $mLastModified = '', $mETag = false;
15 var $mCategoryLinks = array(), $mLanguageLinks = array();
16 var $mScripts = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array();
17 var $mTemplateIds = array();
18
19 var $mAllowUserJs;
20 var $mSuppressQuickbar = false;
21 var $mOnloadHandler = '';
22 var $mDoNothing = false;
23 var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
24 var $mIsArticleRelated = true;
25 protected $mParserOptions = null; // lazy initialised, use parserOptions()
26 var $mShowFeedLinks = false;
27 var $mFeedLinksAppendQuery = false;
28 var $mEnableClientCache = true;
29 var $mArticleBodyOnly = false;
30
31 var $mNewSectionLink = false;
32 var $mNoGallery = false;
33 var $mPageTitleActionText = '';
34 var $mParseWarnings = array();
35 var $mSquidMaxage = 0;
36 var $mRevisionId = null;
37
38 /**
39 * An array of stylesheet filenames (relative from skins path), with options
40 * for CSS media, IE conditions, and RTL/LTR direction.
41 * For internal use; add settings in the skin via $this->addStyle()
42 */
43 var $styles = array();
44
45 private $mIndexPolicy = 'index';
46 private $mFollowPolicy = 'follow';
47
48 /**
49 * Constructor
50 * Initialise private variables
51 */
52 function __construct() {
53 global $wgAllowUserJs;
54 $this->mAllowUserJs = $wgAllowUserJs;
55 }
56
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;
61 }
62
63 public function getRedirect() {
64 return $this->mRedirect;
65 }
66
67 /**
68 * Set the HTTP status code to send with the output.
69 *
70 * @param int $statusCode
71 * @return nothing
72 */
73 function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; }
74
75 /**
76 * Add a new <meta> tag
77 * To add an http-equiv meta tag, precede the name with "http:"
78 *
79 * @param $name tag name
80 * @param $val tag value
81 */
82 function addMeta( $name, $val ) {
83 array_push( $this->mMetatags, array( $name, $val ) );
84 }
85
86 function addKeyword( $text ) { array_push( $this->mKeywords, $text ); }
87 function addScript( $script ) { $this->mScripts .= "\t\t".$script; }
88
89 function addExtensionStyle( $url ) {
90 $linkarr = array( 'rel' => 'stylesheet', 'href' => $url, 'type' => 'text/css' );
91 array_push( $this->mExtStyles, $linkarr );
92 }
93
94 /**
95 * Add a JavaScript file out of skins/common, or a given relative path.
96 * @param string $file filename in skins/common or complete on-server path (/foo/bar.js)
97 */
98 function addScriptFile( $file ) {
99 global $wgStylePath, $wgStyleVersion, $wgJsMimeType;
100 if( substr( $file, 0, 1 ) == '/' ) {
101 $path = $file;
102 } else {
103 $path = "{$wgStylePath}/common/{$file}";
104 }
105 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"$path?$wgStyleVersion\"></script>\n" );
106 }
107
108 /**
109 * Add a self-contained script tag with the given contents
110 * @param string $script JavaScript text, no <script> tags
111 */
112 function addInlineScript( $script ) {
113 global $wgJsMimeType;
114 $this->mScripts .= "<script type=\"$wgJsMimeType\">/*<![CDATA[*/\n$script\n/*]]>*/</script>";
115 }
116
117 function getScript() {
118 return $this->mScripts . $this->getHeadItems();
119 }
120
121 function getHeadItems() {
122 $s = '';
123 foreach ( $this->mHeadItems as $item ) {
124 $s .= $item;
125 }
126 return $s;
127 }
128
129 function addHeadItem( $name, $value ) {
130 $this->mHeadItems[$name] = $value;
131 }
132
133 function hasHeadItem( $name ) {
134 return isset( $this->mHeadItems[$name] );
135 }
136
137 function setETag($tag) { $this->mETag = $tag; }
138 function setArticleBodyOnly($only) { $this->mArticleBodyOnly = $only; }
139 function getArticleBodyOnly($only) { return $this->mArticleBodyOnly; }
140
141 function addLink( $linkarr ) {
142 # $linkarr should be an associative array of attributes. We'll escape on output.
143 array_push( $this->mLinktags, $linkarr );
144 }
145
146 # Get all links added by extensions
147 function getExtStyle() {
148 return $this->mExtStyles;
149 }
150
151 function addMetadataLink( $linkarr ) {
152 # note: buggy CC software only reads first "meta" link
153 static $haveMeta = false;
154 $linkarr['rel'] = ($haveMeta) ? 'alternate meta' : 'meta';
155 $this->addLink( $linkarr );
156 $haveMeta = true;
157 }
158
159 /**
160 * checkLastModified tells the client to use the client-cached page if
161 * possible. If sucessful, the OutputPage is disabled so that
162 * any future call to OutputPage->output() have no effect.
163 *
164 * Side effect: sets mLastModified for Last-Modified header
165 *
166 * @return bool True iff cache-ok headers was sent.
167 */
168 function checkLastModified ( $timestamp ) {
169 global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
170
171 if ( !$timestamp || $timestamp == '19700101000000' ) {
172 wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
173 return false;
174 }
175 if( !$wgCachePages ) {
176 wfDebug( __METHOD__ . ": CACHE DISABLED\n", false );
177 return false;
178 }
179 if( $wgUser->getOption( 'nocache' ) ) {
180 wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false );
181 return false;
182 }
183
184 $timestamp = wfTimestamp( TS_MW, $timestamp );
185 $modifiedTimes = array(
186 'page' => $timestamp,
187 'user' => $wgUser->getTouched(),
188 'epoch' => $wgCacheEpoch
189 );
190 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
191
192 $maxModified = max( $modifiedTimes );
193 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
194
195 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
196 wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
197 return false;
198 }
199
200 # Make debug info
201 $info = '';
202 foreach ( $modifiedTimes as $name => $value ) {
203 if ( $info !== '' ) {
204 $info .= ', ';
205 }
206 $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
207 }
208
209 # IE sends sizes after the date like this:
210 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
211 # this breaks strtotime().
212 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
213
214 wfSuppressWarnings(); // E_STRICT system time bitching
215 $clientHeaderTime = strtotime( $clientHeader );
216 wfRestoreWarnings();
217 if ( !$clientHeaderTime ) {
218 wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
219 return false;
220 }
221 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
222
223 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
224 wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
225 wfDebug( __METHOD__ . ": effective Last-Modified: " .
226 wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
227 if( $clientHeaderTime < $maxModified ) {
228 wfDebug( __METHOD__ . ": STALE, $info\n", false );
229 return false;
230 }
231
232 # Not modified
233 # Give a 304 response code and disable body output
234 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
235 $wgRequest->response()->header( "HTTP/1.1 304 Not Modified" );
236 $this->sendCacheControl();
237 $this->disable();
238
239 // Don't output a compressed blob when using ob_gzhandler;
240 // it's technically against HTTP spec and seems to confuse
241 // Firefox when the response gets split over two packets.
242 wfClearOutputBuffers();
243
244 return true;
245 }
246
247 function setPageTitleActionText( $text ) {
248 $this->mPageTitleActionText = $text;
249 }
250
251 function getPageTitleActionText () {
252 if ( isset( $this->mPageTitleActionText ) ) {
253 return $this->mPageTitleActionText;
254 }
255 }
256
257 /**
258 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
259 *
260 * @param $policy string The literal string to output as the contents of
261 * the meta tag. Will be parsed according to the spec and output in
262 * standardized form.
263 * @return null
264 */
265 public function setRobotPolicy( $policy ) {
266 $policy = explode( ',', $policy );
267 $policy = array_map( 'trim', $policy );
268
269 # The default policy is follow, so if nothing is said explicitly, we
270 # do that.
271 if( in_array( 'nofollow', $policy ) ) {
272 $this->mFollowPolicy = 'nofollow';
273 } else {
274 $this->mFollowPolicy = 'follow';
275 }
276
277 if( in_array( 'noindex', $policy ) ) {
278 $this->mIndexPolicy = 'noindex';
279 } else {
280 $this->mIndexPolicy = 'index';
281 }
282 }
283
284 /**
285 * Set the index policy for the page, but leave the follow policy un-
286 * touched.
287 *
288 * @param $policy string Either 'index' or 'noindex'.
289 * @return null
290 */
291 public function setIndexPolicy( $policy ) {
292 $policy = trim( $policy );
293 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
294 $this->mIndexPolicy = $policy;
295 }
296 }
297
298 /**
299 * Set the follow policy for the page, but leave the index policy un-
300 * touched.
301 *
302 * @param $policy string Either 'follow' or 'nofollow'.
303 * @return null
304 */
305 public function setFollowPolicy( $policy ) {
306 $policy = trim( $policy );
307 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
308 $this->mFollowPolicy = $policy;
309 }
310 }
311
312 public function setHTMLTitle( $name ) {$this->mHTMLtitle = $name; }
313 public function setPageTitle( $name ) {
314 global $action, $wgContLang;
315 $name = $wgContLang->convert($name, true);
316 $this->mPagetitle = $name;
317 if(!empty($action)) {
318 $taction = $this->getPageTitleActionText();
319 if( !empty( $taction ) ) {
320 $name .= ' - '.$taction;
321 }
322 }
323
324 $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
325 }
326 public function getHTMLTitle() { return $this->mHTMLtitle; }
327 public function getPageTitle() { return $this->mPagetitle; }
328 public function setSubtitle( $str ) { $this->mSubtitle = /*$this->parse(*/$str/*)*/; } // @bug 2514
329 public function appendSubtitle( $str ) { $this->mSubtitle .= /*$this->parse(*/$str/*)*/; } // @bug 2514
330 public function getSubtitle() { return $this->mSubtitle; }
331 public function isArticle() { return $this->mIsarticle; }
332 public function setPrintable() { $this->mPrintable = true; }
333 public function isPrintable() { return $this->mPrintable; }
334 public function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; }
335 public function isSyndicated() { return $this->mShowFeedLinks; }
336 public function setFeedAppendQuery( $val ) { $this->mFeedLinksAppendQuery = $val; }
337 public function getFeedAppendQuery() { return $this->mFeedLinksAppendQuery; }
338 public function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; }
339 public function getOnloadHandler() { return $this->mOnloadHandler; }
340 public function disable() { $this->mDoNothing = true; }
341
342 public function setArticleRelated( $v ) {
343 $this->mIsArticleRelated = $v;
344 if ( !$v ) {
345 $this->mIsarticle = false;
346 }
347 }
348 public function setArticleFlag( $v ) {
349 $this->mIsarticle = $v;
350 if ( $v ) {
351 $this->mIsArticleRelated = $v;
352 }
353 }
354
355 public function isArticleRelated() { return $this->mIsArticleRelated; }
356
357 public function getLanguageLinks() { return $this->mLanguageLinks; }
358 public function addLanguageLinks($newLinkArray) {
359 $this->mLanguageLinks += $newLinkArray;
360 }
361 public function setLanguageLinks($newLinkArray) {
362 $this->mLanguageLinks = $newLinkArray;
363 }
364
365 public function getCategoryLinks() {
366 return $this->mCategoryLinks;
367 }
368
369 /**
370 * Add an array of categories, with names in the keys
371 */
372 public function addCategoryLinks( $categories ) {
373 global $wgUser, $wgContLang;
374
375 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
376 return;
377 }
378
379 # Add the links to a LinkBatch
380 $arr = array( NS_CATEGORY => $categories );
381 $lb = new LinkBatch;
382 $lb->setArray( $arr );
383
384 # Fetch existence plus the hiddencat property
385 $dbr = wfGetDB( DB_SLAVE );
386 $pageTable = $dbr->tableName( 'page' );
387 $where = $lb->constructSet( 'page', $dbr );
388 $propsTable = $dbr->tableName( 'page_props' );
389 $sql = "SELECT page_id, page_namespace, page_title, page_len, page_is_redirect, pp_value
390 FROM $pageTable LEFT JOIN $propsTable ON pp_propname='hiddencat' AND pp_page=page_id WHERE $where";
391 $res = $dbr->query( $sql, __METHOD__ );
392
393 # Add the results to the link cache
394 $lb->addResultToCache( LinkCache::singleton(), $res );
395
396 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
397 $categories = array_combine( array_keys( $categories ),
398 array_fill( 0, count( $categories ), 'normal' ) );
399
400 # Mark hidden categories
401 foreach ( $res as $row ) {
402 if ( isset( $row->pp_value ) ) {
403 $categories[$row->page_title] = 'hidden';
404 }
405 }
406
407 # Add the remaining categories to the skin
408 if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks ) ) ) {
409 $sk = $wgUser->getSkin();
410 foreach ( $categories as $category => $type ) {
411 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
412 $text = $wgContLang->convertHtml( $title->getText() );
413 $this->mCategoryLinks[$type][] = $sk->makeLinkObj( $title, $text );
414 }
415 }
416 }
417
418 public function setCategoryLinks($categories) {
419 $this->mCategoryLinks = array();
420 $this->addCategoryLinks($categories);
421 }
422
423 public function suppressQuickbar() { $this->mSuppressQuickbar = true; }
424 public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; }
425
426 public function disallowUserJs() { $this->mAllowUserJs = false; }
427 public function isUserJsAllowed() { return $this->mAllowUserJs; }
428
429 public function prependHTML( $text ) { $this->mBodytext = $text . $this->mBodytext; }
430 public function addHTML( $text ) { $this->mBodytext .= $text; }
431 public function clearHTML() { $this->mBodytext = ''; }
432 public function getHTML() { return $this->mBodytext; }
433 public function debug( $text ) { $this->mDebugtext .= $text; }
434
435 /* @deprecated */
436 public function setParserOptions( $options ) {
437 wfDeprecated( __METHOD__ );
438 return $this->parserOptions( $options );
439 }
440
441 public function parserOptions( $options = null ) {
442 if ( !$this->mParserOptions ) {
443 $this->mParserOptions = new ParserOptions;
444 }
445 return wfSetVar( $this->mParserOptions, $options );
446 }
447
448 /**
449 * Set the revision ID which will be seen by the wiki text parser
450 * for things such as embedded {{REVISIONID}} variable use.
451 * @param mixed $revid an integer, or NULL
452 * @return mixed previous value
453 */
454 public function setRevisionId( $revid ) {
455 $val = is_null( $revid ) ? null : intval( $revid );
456 return wfSetVar( $this->mRevisionId, $val );
457 }
458
459 public function getRevisionId() {
460 return $this->mRevisionId;
461 }
462
463 /**
464 * Convert wikitext to HTML and add it to the buffer
465 * Default assumes that the current page title will
466 * be used.
467 *
468 * @param string $text
469 * @param bool $linestart
470 */
471 public function addWikiText( $text, $linestart = true ) {
472 global $wgTitle;
473 $this->addWikiTextTitle($text, $wgTitle, $linestart);
474 }
475
476 public function addWikiTextWithTitle($text, &$title, $linestart = true) {
477 $this->addWikiTextTitle($text, $title, $linestart);
478 }
479
480 function addWikiTextTitleTidy($text, &$title, $linestart = true) {
481 $this->addWikiTextTitle( $text, $title, $linestart, true );
482 }
483
484 public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) {
485 global $wgParser;
486
487 wfProfileIn( __METHOD__ );
488
489 wfIncrStats( 'pcache_not_possible' );
490
491 $popts = $this->parserOptions();
492 $oldTidy = $popts->setTidy( $tidy );
493
494 $parserOutput = $wgParser->parse( $text, $title, $popts,
495 $linestart, true, $this->mRevisionId );
496
497 $popts->setTidy( $oldTidy );
498
499 $this->addParserOutput( $parserOutput );
500
501 wfProfileOut( __METHOD__ );
502 }
503
504 /**
505 * @todo document
506 * @param ParserOutput object &$parserOutput
507 */
508 public function addParserOutputNoText( &$parserOutput ) {
509 global $wgTitle, $wgExemptFromUserRobotsControl, $wgContentNamespaces;
510
511 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
512 $this->addCategoryLinks( $parserOutput->getCategories() );
513 $this->mNewSectionLink = $parserOutput->getNewSection();
514
515 if( is_null( $wgExemptFromUserRobotsControl ) ) {
516 $bannedNamespaces = $wgContentNamespaces;
517 } else {
518 $bannedNamespaces = $wgExemptFromUserRobotsControl;
519 }
520 if( !in_array( $wgTitle->getNamespace(), $bannedNamespaces ) ) {
521 # FIXME (bug 14900): This overrides $wgArticleRobotPolicies, and it
522 # shouldn't
523 $this->setIndexPolicy( $parserOutput->getIndexPolicy() );
524 }
525
526 $this->addKeywords( $parserOutput );
527 $this->mParseWarnings = $parserOutput->getWarnings();
528 if ( $parserOutput->getCacheTime() == -1 ) {
529 $this->enableClientCache( false );
530 }
531 $this->mNoGallery = $parserOutput->getNoGallery();
532 $this->mHeadItems = array_merge( $this->mHeadItems, (array)$parserOutput->mHeadItems );
533 // Versioning...
534 $this->mTemplateIds = wfArrayMerge( $this->mTemplateIds, (array)$parserOutput->mTemplateIds );
535
536 // Display title
537 if( ( $dt = $parserOutput->getDisplayTitle() ) !== false )
538 $this->setPageTitle( $dt );
539
540 // Hooks registered in the object
541 global $wgParserOutputHooks;
542 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
543 list( $hookName, $data ) = $hookInfo;
544 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
545 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
546 }
547 }
548
549 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
550 }
551
552 /**
553 * @todo document
554 * @param ParserOutput &$parserOutput
555 */
556 function addParserOutput( &$parserOutput ) {
557 $this->addParserOutputNoText( $parserOutput );
558 $text = $parserOutput->getText();
559 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
560 $this->addHTML( $text );
561 }
562
563 /**
564 * Add wikitext to the buffer, assuming that this is the primary text for a page view
565 * Saves the text into the parser cache if possible.
566 *
567 * @param string $text
568 * @param Article $article
569 * @param bool $cache
570 * @deprecated Use Article::outputWikitext
571 */
572 public function addPrimaryWikiText( $text, $article, $cache = true ) {
573 global $wgParser, $wgUser;
574
575 wfDeprecated( __METHOD__ );
576
577 $popts = $this->parserOptions();
578 $popts->setTidy(true);
579 $parserOutput = $wgParser->parse( $text, $article->mTitle,
580 $popts, true, true, $this->mRevisionId );
581 $popts->setTidy(false);
582 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
583 $parserCache = ParserCache::singleton();
584 $parserCache->save( $parserOutput, $article, $wgUser );
585 }
586
587 $this->addParserOutput( $parserOutput );
588 }
589
590 /**
591 * @deprecated use addWikiTextTidy()
592 */
593 public function addSecondaryWikiText( $text, $linestart = true ) {
594 global $wgTitle;
595 wfDeprecated( __METHOD__ );
596 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
597 }
598
599 /**
600 * Add wikitext with tidy enabled
601 */
602 public function addWikiTextTidy( $text, $linestart = true ) {
603 global $wgTitle;
604 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
605 }
606
607
608 /**
609 * Add the output of a QuickTemplate to the output buffer
610 *
611 * @param QuickTemplate $template
612 */
613 public function addTemplate( &$template ) {
614 ob_start();
615 $template->execute();
616 $this->addHTML( ob_get_contents() );
617 ob_end_clean();
618 }
619
620 /**
621 * Parse wikitext and return the HTML.
622 *
623 * @param string $text
624 * @param bool $linestart Is this the start of a line?
625 * @param bool $interface ??
626 */
627 public function parse( $text, $linestart = true, $interface = false ) {
628 global $wgParser, $wgTitle;
629 $popts = $this->parserOptions();
630 if ( $interface) { $popts->setInterfaceMessage(true); }
631 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
632 $linestart, true, $this->mRevisionId );
633 if ( $interface) { $popts->setInterfaceMessage(false); }
634 return $parserOutput->getText();
635 }
636
637 /**
638 * @param Article $article
639 * @param User $user
640 *
641 * @return bool True if successful, else false.
642 */
643 public function tryParserCache( &$article, $user ) {
644 $parserCache = ParserCache::singleton();
645 $parserOutput = $parserCache->get( $article, $user );
646 if ( $parserOutput !== false ) {
647 $this->addParserOutput( $parserOutput );
648 return true;
649 } else {
650 return false;
651 }
652 }
653
654 /**
655 * @param int $maxage Maximum cache time on the Squid, in seconds.
656 */
657 public function setSquidMaxage( $maxage ) {
658 $this->mSquidMaxage = $maxage;
659 }
660
661 /**
662 * Use enableClientCache(false) to force it to send nocache headers
663 * @param $state ??
664 */
665 public function enableClientCache( $state ) {
666 return wfSetVar( $this->mEnableClientCache, $state );
667 }
668
669 function getCacheVaryCookies() {
670 global $wgCookiePrefix, $wgCacheVaryCookies;
671 static $cookies;
672 if ( $cookies === null ) {
673 $cookies = array_merge(
674 array(
675 "{$wgCookiePrefix}Token",
676 "{$wgCookiePrefix}LoggedOut",
677 session_name()
678 ),
679 $wgCacheVaryCookies
680 );
681 wfRunHooks('GetCacheVaryCookies', array( $this, &$cookies ) );
682 }
683 return $cookies;
684 }
685
686 function uncacheableBecauseRequestVars() {
687 global $wgRequest;
688 return $wgRequest->getText('useskin', false) === false
689 && $wgRequest->getText('uselang', false) === false;
690 }
691
692 /**
693 * Check if the request has a cache-varying cookie header
694 * If it does, it's very important that we don't allow public caching
695 */
696 function haveCacheVaryCookies() {
697 global $wgRequest, $wgCookiePrefix;
698 $cookieHeader = $wgRequest->getHeader( 'cookie' );
699 if ( $cookieHeader === false ) {
700 return false;
701 }
702 $cvCookies = $this->getCacheVaryCookies();
703 foreach ( $cvCookies as $cookieName ) {
704 # Check for a simple string match, like the way squid does it
705 if ( strpos( $cookieHeader, $cookieName ) ) {
706 wfDebug( __METHOD__.": found $cookieName\n" );
707 return true;
708 }
709 }
710 wfDebug( __METHOD__.": no cache-varying cookies found\n" );
711 return false;
712 }
713
714 /** Get a complete X-Vary-Options header */
715 public function getXVO() {
716 global $wgCookiePrefix;
717 $cvCookies = $this->getCacheVaryCookies();
718 $xvo = 'X-Vary-Options: Accept-Encoding;list-contains=gzip,Cookie;';
719 $first = true;
720 foreach ( $cvCookies as $cookieName ) {
721 if ( $first ) {
722 $first = false;
723 } else {
724 $xvo .= ';';
725 }
726 $xvo .= 'string-contains=' . $cookieName;
727 }
728 return $xvo;
729 }
730
731 public function sendCacheControl() {
732 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
733
734 $response = $wgRequest->response();
735 if ($wgUseETag && $this->mETag)
736 $response->header("ETag: $this->mETag");
737
738 # don't serve compressed data to clients who can't handle it
739 # maintain different caches for logged-in users and non-logged in ones
740 $response->header( 'Vary: Accept-Encoding, Cookie' );
741
742 # Add an X-Vary-Options header for Squid with Wikimedia patches
743 $response->header( $this->getXVO() );
744
745 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) {
746 if( $wgUseSquid && session_id() == '' &&
747 ! $this->isPrintable() && $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies() )
748 {
749 if ( $wgUseESI ) {
750 # We'll purge the proxy cache explicitly, but require end user agents
751 # to revalidate against the proxy on each visit.
752 # Surrogate-Control controls our Squid, Cache-Control downstream caches
753 wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
754 # start with a shorter timeout for initial testing
755 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
756 $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
757 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
758 } else {
759 # We'll purge the proxy cache for anons explicitly, but require end user agents
760 # to revalidate against the proxy on each visit.
761 # IMPORTANT! The Squid needs to replace the Cache-Control header with
762 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
763 wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
764 # start with a shorter timeout for initial testing
765 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
766 $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
767 }
768 } else {
769 # We do want clients to cache if they can, but they *must* check for updates
770 # on revisiting the page.
771 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
772 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
773 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
774 }
775 if($this->mLastModified) {
776 $response->header( "Last-Modified: {$this->mLastModified}" );
777 }
778 } else {
779 wfDebug( __METHOD__ . ": no caching **\n", false );
780
781 # In general, the absence of a last modified header should be enough to prevent
782 # the client from using its cache. We send a few other things just to make sure.
783 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
784 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
785 $response->header( 'Pragma: no-cache' );
786 }
787 }
788
789 /**
790 * Finally, all the text has been munged and accumulated into
791 * the object, let's actually output it:
792 */
793 public function output() {
794 global $wgUser, $wgOutputEncoding, $wgRequest;
795 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
796 global $wgJsMimeType, $wgUseAjax, $wgAjaxWatch;
797 global $wgEnableMWSuggest;
798
799 if( $this->mDoNothing ){
800 return;
801 }
802
803 wfProfileIn( __METHOD__ );
804
805 if ( '' != $this->mRedirect ) {
806 # Standards require redirect URLs to be absolute
807 $this->mRedirect = wfExpandUrl( $this->mRedirect );
808 if( $this->mRedirectCode == '301') {
809 if( !$wgDebugRedirects ) {
810 $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
811 }
812 $this->mLastModified = wfTimestamp( TS_RFC2822 );
813 }
814
815 $this->sendCacheControl();
816
817 $wgRequest->response()->header("Content-Type: text/html; charset=utf-8");
818 if( $wgDebugRedirects ) {
819 $url = htmlspecialchars( $this->mRedirect );
820 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
821 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
822 print "</body>\n</html>\n";
823 } else {
824 $wgRequest->response()->header( 'Location: '.$this->mRedirect );
825 }
826 wfProfileOut( __METHOD__ );
827 return;
828 }
829 elseif ( $this->mStatusCode )
830 {
831 $statusMessage = array(
832 100 => 'Continue',
833 101 => 'Switching Protocols',
834 102 => 'Processing',
835 200 => 'OK',
836 201 => 'Created',
837 202 => 'Accepted',
838 203 => 'Non-Authoritative Information',
839 204 => 'No Content',
840 205 => 'Reset Content',
841 206 => 'Partial Content',
842 207 => 'Multi-Status',
843 300 => 'Multiple Choices',
844 301 => 'Moved Permanently',
845 302 => 'Found',
846 303 => 'See Other',
847 304 => 'Not Modified',
848 305 => 'Use Proxy',
849 307 => 'Temporary Redirect',
850 400 => 'Bad Request',
851 401 => 'Unauthorized',
852 402 => 'Payment Required',
853 403 => 'Forbidden',
854 404 => 'Not Found',
855 405 => 'Method Not Allowed',
856 406 => 'Not Acceptable',
857 407 => 'Proxy Authentication Required',
858 408 => 'Request Timeout',
859 409 => 'Conflict',
860 410 => 'Gone',
861 411 => 'Length Required',
862 412 => 'Precondition Failed',
863 413 => 'Request Entity Too Large',
864 414 => 'Request-URI Too Large',
865 415 => 'Unsupported Media Type',
866 416 => 'Request Range Not Satisfiable',
867 417 => 'Expectation Failed',
868 422 => 'Unprocessable Entity',
869 423 => 'Locked',
870 424 => 'Failed Dependency',
871 500 => 'Internal Server Error',
872 501 => 'Not Implemented',
873 502 => 'Bad Gateway',
874 503 => 'Service Unavailable',
875 504 => 'Gateway Timeout',
876 505 => 'HTTP Version Not Supported',
877 507 => 'Insufficient Storage'
878 );
879
880 if ( $statusMessage[$this->mStatusCode] )
881 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] );
882 }
883
884 $sk = $wgUser->getSkin();
885
886 if ( $wgUseAjax ) {
887 $this->addScriptFile( 'ajax.js' );
888
889 wfRunHooks( 'AjaxAddScript', array( &$this ) );
890
891 if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
892 $this->addScriptFile( 'ajaxwatch.js' );
893 }
894
895 if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ){
896 $this->addScriptFile( 'mwsuggest.js' );
897 }
898 }
899
900 if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) {
901 $this->addScriptFile( 'rightclickedit.js' );
902 }
903
904 $this->mBodytext = StringUtils::cleanForCharset( $this->mBodytext, $wgOutputEncoding );
905
906 # Buffer output; final headers may depend on later processing
907 ob_start();
908
909 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
910 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
911
912 if ($this->mArticleBodyOnly) {
913 $this->out($this->mBodytext);
914 } else {
915 // Hook that allows last minute changes to the output page, e.g.
916 // adding of CSS or Javascript by extensions.
917 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
918
919 wfProfileIn( 'Output-skin' );
920 $sk->outputPage( $this );
921 wfProfileOut( 'Output-skin' );
922 }
923
924 $this->sendCacheControl();
925 ob_end_flush();
926 wfProfileOut( __METHOD__ );
927 }
928
929 /**
930 * @todo document
931 * @param string $ins
932 */
933 public function out( $ins ) {
934 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
935 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
936 $outs = $ins;
937 } else {
938 $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
939 if ( false === $outs ) { $outs = $ins; }
940 }
941 print $outs;
942 }
943
944 /**
945 * @todo document
946 */
947 public static function setEncodings() {
948 global $wgInputEncoding, $wgOutputEncoding;
949 global $wgUser, $wgContLang;
950
951 $wgInputEncoding = strtolower( $wgInputEncoding );
952
953 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
954 $wgOutputEncoding = strtolower( $wgOutputEncoding );
955 return;
956 }
957 $wgOutputEncoding = $wgInputEncoding;
958 }
959
960 /**
961 * Deprecated, use wfReportTime() instead.
962 * @return string
963 * @deprecated
964 */
965 public function reportTime() {
966 wfDeprecated( __METHOD__ );
967 $time = wfReportTime();
968 return $time;
969 }
970
971 /**
972 * Produce a "user is blocked" page.
973 *
974 * @param bool $return Whether to have a "return to $wgTitle" message or not.
975 * @return nothing
976 */
977 function blockedPage( $return = true ) {
978 global $wgUser, $wgContLang, $wgTitle, $wgLang;
979
980 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
981 $this->setRobotPolicy( 'noindex,nofollow' );
982 $this->setArticleRelated( false );
983
984 $name = User::whoIs( $wgUser->blockedBy() );
985 $reason = $wgUser->blockedFor();
986 if( $reason == '' ) {
987 $reason = wfMsg( 'blockednoreason' );
988 }
989 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true );
990 $ip = wfGetIP();
991
992 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
993
994 $blockid = $wgUser->mBlock->mId;
995
996 $blockExpiry = $wgUser->mBlock->mExpiry;
997 if ( $blockExpiry == 'infinity' ) {
998 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
999 // Search for localization in 'ipboptions'
1000 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1001 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1002 if ( strpos( $option, ":" ) === false )
1003 continue;
1004 list( $show, $value ) = explode( ":", $option );
1005 if ( $value == 'infinite' || $value == 'indefinite' ) {
1006 $blockExpiry = $show;
1007 break;
1008 }
1009 }
1010 } else {
1011 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
1012 }
1013
1014 if ( $wgUser->mBlock->mAuto ) {
1015 $msg = 'autoblockedtext';
1016 } else {
1017 $msg = 'blockedtext';
1018 }
1019
1020 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
1021 * This could be a username, an ip range, or a single ip. */
1022 $intended = $wgUser->mBlock->mAddress;
1023
1024 $this->addWikiMsg( $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp );
1025
1026 # Don't auto-return to special pages
1027 if( $return ) {
1028 $return = $wgTitle->getNamespace() > -1 ? $wgTitle : NULL;
1029 $this->returnToMain( null, $return );
1030 }
1031 }
1032
1033 /**
1034 * Output a standard error page
1035 *
1036 * @param string $title Message key for page title
1037 * @param string $msg Message key for page text
1038 * @param array $params Message parameters
1039 */
1040 public function showErrorPage( $title, $msg, $params = array() ) {
1041 global $wgTitle;
1042 if ( isset($wgTitle) ) {
1043 $this->mDebugtext .= 'Original title: ' . $wgTitle->getPrefixedText() . "\n";
1044 }
1045 $this->setPageTitle( wfMsg( $title ) );
1046 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1047 $this->setRobotPolicy( 'noindex,nofollow' );
1048 $this->setArticleRelated( false );
1049 $this->enableClientCache( false );
1050 $this->mRedirect = '';
1051 $this->mBodytext = '';
1052
1053 array_unshift( $params, 'parse' );
1054 array_unshift( $params, $msg );
1055 $this->addHtml( call_user_func_array( 'wfMsgExt', $params ) );
1056
1057 $this->returnToMain();
1058 }
1059
1060 /**
1061 * Output a standard permission error page
1062 *
1063 * @param array $errors Error message keys
1064 */
1065 public function showPermissionsErrorPage( $errors, $action = null )
1066 {
1067 global $wgTitle;
1068
1069 $this->mDebugtext .= 'Original title: ' .
1070 $wgTitle->getPrefixedText() . "\n";
1071 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1072 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1073 $this->setRobotPolicy( 'noindex,nofollow' );
1074 $this->setArticleRelated( false );
1075 $this->enableClientCache( false );
1076 $this->mRedirect = '';
1077 $this->mBodytext = '';
1078 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1079 }
1080
1081 /** @deprecated */
1082 public function errorpage( $title, $msg ) {
1083 wfDeprecated( __METHOD__ );
1084 throw new ErrorPageError( $title, $msg );
1085 }
1086
1087 /**
1088 * Display an error page indicating that a given version of MediaWiki is
1089 * required to use it
1090 *
1091 * @param mixed $version The version of MediaWiki needed to use the page
1092 */
1093 public function versionRequired( $version ) {
1094 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1095 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1096 $this->setRobotPolicy( 'noindex,nofollow' );
1097 $this->setArticleRelated( false );
1098 $this->mBodytext = '';
1099
1100 $this->addWikiMsg( 'versionrequiredtext', $version );
1101 $this->returnToMain();
1102 }
1103
1104 /**
1105 * Display an error page noting that a given permission bit is required.
1106 *
1107 * @param string $permission key required
1108 */
1109 public function permissionRequired( $permission ) {
1110 global $wgUser;
1111
1112 $this->setPageTitle( wfMsg( 'badaccess' ) );
1113 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1114 $this->setRobotPolicy( 'noindex,nofollow' );
1115 $this->setArticleRelated( false );
1116 $this->mBodytext = '';
1117
1118 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1119 User::getGroupsWithPermission( $permission ) );
1120 if( $groups ) {
1121 $this->addWikiMsg( 'badaccess-groups',
1122 implode( ', ', $groups ),
1123 count( $groups) );
1124 } else {
1125 $this->addWikiMsg( 'badaccess-group0' );
1126 }
1127 $this->returnToMain();
1128 }
1129
1130 /**
1131 * Use permissionRequired.
1132 * @deprecated
1133 */
1134 public function sysopRequired() {
1135 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
1136 }
1137
1138 /**
1139 * Use permissionRequired.
1140 * @deprecated
1141 */
1142 public function developerRequired() {
1143 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
1144 }
1145
1146 /**
1147 * Produce the stock "please login to use the wiki" page
1148 */
1149 public function loginToUse() {
1150 global $wgUser, $wgTitle, $wgContLang;
1151
1152 if( $wgUser->isLoggedIn() ) {
1153 $this->permissionRequired( 'read' );
1154 return;
1155 }
1156
1157 $skin = $wgUser->getSkin();
1158
1159 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
1160 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
1161 $this->setRobotPolicy( 'noindex,nofollow' );
1162 $this->setArticleFlag( false );
1163
1164 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
1165 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
1166 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
1167 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
1168
1169 # Don't return to the main page if the user can't read it
1170 # otherwise we'll end up in a pointless loop
1171 $mainPage = Title::newMainPage();
1172 if( $mainPage->userCanRead() )
1173 $this->returnToMain( null, $mainPage );
1174 }
1175
1176 /** @deprecated */
1177 public function databaseError( $fname, $sql, $error, $errno ) {
1178 throw new MWException( "OutputPage::databaseError is obsolete\n" );
1179 }
1180
1181 /**
1182 * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors
1183 * @return string The wikitext error-messages, formatted into a list.
1184 */
1185 public function formatPermissionsErrorMessage( $errors, $action = null ) {
1186 if ($action == null) {
1187 $text = wfMsgNoTrans( 'permissionserrorstext', count($errors)). "\n\n";
1188 } else {
1189 global $wgLang;
1190 $action_desc = wfMsg( "right-$action" );
1191 $action_desc = $wgLang->lcfirst( $action_desc ); // FIXME: TERRIBLE HACK
1192 $text = wfMsgNoTrans( 'permissionserrorstext-withaction', count($errors), $action_desc ) . "\n\n";
1193 }
1194
1195 if (count( $errors ) > 1) {
1196 $text .= '<ul class="permissions-errors">' . "\n";
1197
1198 foreach( $errors as $error )
1199 {
1200 $text .= '<li>';
1201 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
1202 $text .= "</li>\n";
1203 }
1204 $text .= '</ul>';
1205 } else {
1206 $text .= '<div class="permissions-errors">' . call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) . '</div>';
1207 }
1208
1209 return $text;
1210 }
1211
1212 /**
1213 * Display a page stating that the Wiki is in read-only mode,
1214 * and optionally show the source of the page that the user
1215 * was trying to edit. Should only be called (for this
1216 * purpose) after wfReadOnly() has returned true.
1217 *
1218 * For historical reasons, this function is _also_ used to
1219 * show the error message when a user tries to edit a page
1220 * they are not allowed to edit. (Unless it's because they're
1221 * blocked, then we show blockedPage() instead.) In this
1222 * case, the second parameter should be set to true and a list
1223 * of reasons supplied as the third parameter.
1224 *
1225 * @todo Needs to be split into multiple functions.
1226 *
1227 * @param string $source Source code to show (or null).
1228 * @param bool $protected Is this a permissions error?
1229 * @param array $reasons List of reasons for this error, as returned by Title::getUserPermissionsErrors().
1230 */
1231 public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
1232 global $wgUser, $wgTitle;
1233 $skin = $wgUser->getSkin();
1234
1235 $this->setRobotPolicy( 'noindex,nofollow' );
1236 $this->setArticleRelated( false );
1237
1238 // If no reason is given, just supply a default "I can't let you do
1239 // that, Dave" message. Should only occur if called by legacy code.
1240 if ( $protected && empty($reasons) ) {
1241 $reasons[] = array( 'badaccess-group0' );
1242 }
1243
1244 if ( !empty($reasons) ) {
1245 // Permissions error
1246 if( $source ) {
1247 $this->setPageTitle( wfMsg( 'viewsource' ) );
1248 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
1249 } else {
1250 $this->setPageTitle( wfMsg( 'badaccess' ) );
1251 }
1252 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
1253 } else {
1254 // Wiki is read only
1255 $this->setPageTitle( wfMsg( 'readonly' ) );
1256 $reason = wfReadOnlyReason();
1257 $this->wrapWikiMsg( '<div class="mw-readonly-error">$1</div>', array( 'readonlytext', $reason ) );
1258 }
1259
1260 // Show source, if supplied
1261 if( is_string( $source ) ) {
1262 $this->addWikiMsg( 'viewsourcetext' );
1263 $text = Xml::openElement( 'textarea',
1264 array( 'id' => 'wpTextbox1',
1265 'name' => 'wpTextbox1',
1266 'cols' => $wgUser->getOption( 'cols' ),
1267 'rows' => $wgUser->getOption( 'rows' ),
1268 'readonly' => 'readonly' ) );
1269 $text .= htmlspecialchars( $source );
1270 $text .= Xml::closeElement( 'textarea' );
1271 $this->addHTML( $text );
1272
1273 // Show templates used by this article
1274 $skin = $wgUser->getSkin();
1275 $article = new Article( $wgTitle );
1276 $this->addHTML( "<div class='templatesUsed'>
1277 {$skin->formatTemplates( $article->getUsedTemplates() )}
1278 </div>
1279 " );
1280 }
1281
1282 # If the title doesn't exist, it's fairly pointless to print a return
1283 # link to it. After all, you just tried editing it and couldn't, so
1284 # what's there to do there?
1285 if( $wgTitle->exists() ) {
1286 $this->returnToMain( null, $wgTitle );
1287 }
1288 }
1289
1290 /** @deprecated */
1291 public function fatalError( $message ) {
1292 wfDeprecated( __METHOD__ );
1293 throw new FatalError( $message );
1294 }
1295
1296 /** @deprecated */
1297 public function unexpectedValueError( $name, $val ) {
1298 wfDeprecated( __METHOD__ );
1299 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
1300 }
1301
1302 /** @deprecated */
1303 public function fileCopyError( $old, $new ) {
1304 wfDeprecated( __METHOD__ );
1305 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
1306 }
1307
1308 /** @deprecated */
1309 public function fileRenameError( $old, $new ) {
1310 wfDeprecated( __METHOD__ );
1311 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
1312 }
1313
1314 /** @deprecated */
1315 public function fileDeleteError( $name ) {
1316 wfDeprecated( __METHOD__ );
1317 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
1318 }
1319
1320 /** @deprecated */
1321 public function fileNotFoundError( $name ) {
1322 wfDeprecated( __METHOD__ );
1323 throw new FatalError( wfMsg( 'filenotfound', $name ) );
1324 }
1325
1326 public function showFatalError( $message ) {
1327 $this->setPageTitle( wfMsg( "internalerror" ) );
1328 $this->setRobotPolicy( "noindex,nofollow" );
1329 $this->setArticleRelated( false );
1330 $this->enableClientCache( false );
1331 $this->mRedirect = '';
1332 $this->mBodytext = $message;
1333 }
1334
1335 public function showUnexpectedValueError( $name, $val ) {
1336 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
1337 }
1338
1339 public function showFileCopyError( $old, $new ) {
1340 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
1341 }
1342
1343 public function showFileRenameError( $old, $new ) {
1344 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
1345 }
1346
1347 public function showFileDeleteError( $name ) {
1348 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
1349 }
1350
1351 public function showFileNotFoundError( $name ) {
1352 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
1353 }
1354
1355 /**
1356 * Add a "return to" link pointing to a specified title
1357 *
1358 * @param Title $title Title to link
1359 */
1360 public function addReturnTo( $title ) {
1361 global $wgUser;
1362 $link = wfMsg( 'returnto', $wgUser->getSkin()->makeLinkObj( $title ) );
1363 $this->addHtml( "<p>{$link}</p>\n" );
1364 }
1365
1366 /**
1367 * Add a "return to" link pointing to a specified title,
1368 * or the title indicated in the request, or else the main page
1369 *
1370 * @param null $unused No longer used
1371 * @param Title $returnto Title to return to
1372 */
1373 public function returnToMain( $unused = null, $returnto = NULL ) {
1374 global $wgRequest;
1375
1376 if ( $returnto == NULL ) {
1377 $returnto = $wgRequest->getText( 'returnto' );
1378 }
1379
1380 if ( '' === $returnto ) {
1381 $returnto = Title::newMainPage();
1382 }
1383
1384 if ( is_object( $returnto ) ) {
1385 $titleObj = $returnto;
1386 } else {
1387 $titleObj = Title::newFromText( $returnto );
1388 }
1389 if ( !is_object( $titleObj ) ) {
1390 $titleObj = Title::newMainPage();
1391 }
1392
1393 $this->addReturnTo( $titleObj );
1394 }
1395
1396 /**
1397 * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1398 * and uses the first 10 of them for META keywords
1399 *
1400 * @param ParserOutput &$parserOutput
1401 */
1402 private function addKeywords( &$parserOutput ) {
1403 global $wgTitle;
1404 $this->addKeyword( $wgTitle->getPrefixedText() );
1405 $count = 1;
1406 $links2d =& $parserOutput->getLinks();
1407 if ( !is_array( $links2d ) ) {
1408 return;
1409 }
1410 foreach ( $links2d as $dbkeys ) {
1411 foreach( $dbkeys as $dbkey => $unused ) {
1412 $this->addKeyword( $dbkey );
1413 if ( ++$count > 10 ) {
1414 break 2;
1415 }
1416 }
1417 }
1418 }
1419
1420 /**
1421 * @return string The doctype, opening <html>, and head element.
1422 */
1423 public function headElement( Skin $sk ) {
1424 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1425 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1426 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1427
1428 $this->addMeta( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" );
1429 $this->addStyle( 'common/wikiprintable.css', 'print' );
1430 $sk->setupUserCss( $this );
1431
1432 $ret = '';
1433
1434 if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
1435 $ret .= "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1436 }
1437
1438 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n \"$wgDTD\">\n";
1439
1440 if ( '' == $this->getHTMLTitle() ) {
1441 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ));
1442 }
1443
1444 $rtl = $wgContLang->isRTL() ? " dir='RTL'" : '';
1445 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1446 foreach($wgXhtmlNamespaces as $tag => $ns) {
1447 $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1448 }
1449 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1450 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n\t\t";
1451 $ret .= implode( "\t\t", array(
1452 $this->getHeadLinks(),
1453 $this->buildCssLinks(),
1454 $sk->getHeadScripts( $this->mAllowUserJs ),
1455 $this->mScripts,
1456 $this->getHeadItems(),
1457 ));
1458 if( $sk->usercss ){
1459 $ret .= "<style type='text/css'>{$sk->usercss}</style>";
1460 }
1461
1462 if ($wgUseTrackbacks && $this->isArticleRelated())
1463 $ret .= $wgTitle->trackbackRDF();
1464
1465 $ret .= "</head>\n";
1466 return $ret;
1467 }
1468
1469 protected function addDefaultMeta() {
1470 global $wgVersion;
1471 $this->addMeta( "generator", "MediaWiki $wgVersion" );
1472
1473 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
1474 if( $p !== 'index,follow' ) {
1475 // http://www.robotstxt.org/wc/meta-user.html
1476 // Only show if it's different from the default robots policy
1477 $this->addMeta( 'robots', $p );
1478 }
1479
1480 if ( count( $this->mKeywords ) > 0 ) {
1481 $strip = array(
1482 "/<.*?>/" => '',
1483 "/_/" => ' '
1484 );
1485 $this->addMeta( 'keywords', preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ) ) );
1486 }
1487 }
1488
1489 /**
1490 * @return string HTML tag links to be put in the header.
1491 */
1492 public function getHeadLinks() {
1493 global $wgRequest, $wgFeed;
1494
1495 // Ideally this should happen earlier, somewhere. :P
1496 $this->addDefaultMeta();
1497
1498 $tags = array();
1499
1500 foreach ( $this->mMetatags as $tag ) {
1501 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1502 $a = 'http-equiv';
1503 $tag[0] = substr( $tag[0], 5 );
1504 } else {
1505 $a = 'name';
1506 }
1507 $tags[] = Xml::element( 'meta',
1508 array(
1509 $a => $tag[0],
1510 'content' => $tag[1] ) );
1511 }
1512 foreach ( $this->mLinktags as $tag ) {
1513 $tags[] = Xml::element( 'link', $tag );
1514 }
1515
1516 if( $wgFeed ) {
1517 global $wgTitle;
1518 foreach( $this->getSyndicationLinks() as $format => $link ) {
1519 # Use the page name for the title (accessed through $wgTitle since
1520 # there's no other way). In principle, this could lead to issues
1521 # with having the same name for different feeds corresponding to
1522 # the same page, but we can't avoid that at this low a level.
1523
1524 $tags[] = $this->feedLink(
1525 $format,
1526 $link,
1527 wfMsg( "page-{$format}-feed", $wgTitle->getPrefixedText() ) ); # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
1528 }
1529
1530 # Recent changes feed should appear on every page (except recentchanges,
1531 # that would be redundant). Put it after the per-page feed to avoid
1532 # changing existing behavior. It's still available, probably via a
1533 # menu in your browser. Some sites might have a different feed they'd
1534 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
1535 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
1536 # If so, use it instead.
1537
1538 global $wgOverrideSiteFeed, $wgSitename;
1539 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
1540
1541 if ( $wgOverrideSiteFeed ) {
1542 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
1543 $tags[] = $this->feedLink (
1544 $type,
1545 htmlspecialchars( $feedUrl ),
1546 wfMsg( "site-{$type}-feed", $wgSitename ) );
1547 }
1548 }
1549 else if ( $wgTitle->getPrefixedText() != $rctitle->getPrefixedText() ) {
1550 $tags[] = $this->feedLink(
1551 'rss',
1552 $rctitle->getFullURL( 'feed=rss' ),
1553 wfMsg( 'site-rss-feed', $wgSitename ) );
1554 $tags[] = $this->feedLink(
1555 'atom',
1556 $rctitle->getFullURL( 'feed=atom' ),
1557 wfMsg( 'site-atom-feed', $wgSitename ) );
1558 }
1559 }
1560
1561 return implode( "\n\t\t", $tags ) . "\n";
1562 }
1563
1564 /**
1565 * Return URLs for each supported syndication format for this page.
1566 * @return array associating format keys with URLs
1567 */
1568 public function getSyndicationLinks() {
1569 global $wgTitle, $wgFeedClasses;
1570 $links = array();
1571
1572 if( $this->isSyndicated() ) {
1573 if( is_string( $this->getFeedAppendQuery() ) ) {
1574 $appendQuery = "&" . $this->getFeedAppendQuery();
1575 } else {
1576 $appendQuery = "";
1577 }
1578
1579 foreach( $wgFeedClasses as $format => $class ) {
1580 $links[$format] = $wgTitle->getLocalUrl( "feed=$format{$appendQuery}" );
1581 }
1582 }
1583 return $links;
1584 }
1585
1586 /**
1587 * Generate a <link rel/> for an RSS feed.
1588 */
1589 private function feedLink( $type, $url, $text ) {
1590 return Xml::element( 'link', array(
1591 'rel' => 'alternate',
1592 'type' => "application/$type+xml",
1593 'title' => $text,
1594 'href' => $url ) );
1595 }
1596
1597 /**
1598 * Add a local or specified stylesheet, with the given media options.
1599 * Meant primarily for internal use...
1600 *
1601 * @param $media -- to specify a media type, 'screen', 'printable', 'handheld' or any.
1602 * @param $conditional -- for IE conditional comments, specifying an IE version
1603 * @param $dir -- set to 'rtl' or 'ltr' for direction-specific sheets
1604 */
1605 public function addStyle( $style, $media='', $condition='', $dir='' ) {
1606 $options = array();
1607 if( $media )
1608 $options['media'] = $media;
1609 if( $condition )
1610 $options['condition'] = $condition;
1611 if( $dir )
1612 $options['dir'] = $dir;
1613 $this->styles[$style] = $options;
1614 }
1615
1616 /**
1617 * Build a set of <link>s for the stylesheets specified in the $this->styles array.
1618 * These will be applied to various media & IE conditionals.
1619 */
1620 public function buildCssLinks() {
1621 $links = array();
1622 foreach( $this->styles as $file => $options ) {
1623 $link = $this->styleLink( $file, $options );
1624 if( $link )
1625 $links[] = $link;
1626 }
1627
1628 return implode( "\n\t\t", $links );
1629 }
1630
1631 protected function styleLink( $style, $options ) {
1632 global $wgRequest;
1633
1634 if( isset( $options['dir'] ) ) {
1635 global $wgContLang;
1636 $siteDir = $wgContLang->isRTL() ? 'rtl' : 'ltr';
1637 if( $siteDir != $options['dir'] )
1638 return '';
1639 }
1640
1641 if( isset( $options['media'] ) ) {
1642 $media = $this->transformCssMedia( $options['media'] );
1643 if( is_null( $media ) ) {
1644 return '';
1645 }
1646 } else {
1647 $media = '';
1648 }
1649
1650 if( substr( $style, 0, 1 ) == '/' ||
1651 substr( $style, 0, 5 ) == 'http:' ||
1652 substr( $style, 0, 6 ) == 'https:' ) {
1653 $url = $style;
1654 } else {
1655 global $wgStylePath, $wgStyleVersion;
1656 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
1657 }
1658
1659 $attribs = array(
1660 'rel' => 'stylesheet',
1661 'href' => $url,
1662 'type' => 'text/css' );
1663 if( $media ) {
1664 $attribs['media'] = $media;
1665 }
1666
1667 $link = Xml::element( 'link', $attribs );
1668
1669 if( isset( $options['condition'] ) ) {
1670 $condition = htmlspecialchars( $options['condition'] );
1671 $link = "<!--[if $condition]>$link<![endif]-->";
1672 }
1673 return $link;
1674 }
1675
1676 function transformCssMedia( $media ) {
1677 global $wgRequest, $wgHandheldForIPhone;
1678
1679 // Switch in on-screen display for media testing
1680 $switches = array(
1681 'printable' => 'print',
1682 'handheld' => 'handheld',
1683 );
1684 foreach( $switches as $switch => $targetMedia ) {
1685 if( $wgRequest->getBool( $switch ) ) {
1686 if( $media == $targetMedia ) {
1687 $media = '';
1688 } elseif( $media == 'screen' ) {
1689 return null;
1690 }
1691 }
1692 }
1693
1694 // Expand longer media queries as iPhone doesn't grok 'handheld'
1695 if( $wgHandheldForIPhone ) {
1696 $mediaAliases = array(
1697 'screen' => 'screen and (min-device-width: 481px)',
1698 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
1699 );
1700
1701 if( isset( $mediaAliases[$media] ) ) {
1702 $media = $mediaAliases[$media];
1703 }
1704 }
1705
1706 return $media;
1707 }
1708
1709 /**
1710 * Turn off regular page output and return an error reponse
1711 * for when rate limiting has triggered.
1712 */
1713 public function rateLimited() {
1714 global $wgTitle;
1715
1716 $this->setPageTitle(wfMsg('actionthrottled'));
1717 $this->setRobotPolicy( 'noindex,follow' );
1718 $this->setArticleRelated( false );
1719 $this->enableClientCache( false );
1720 $this->mRedirect = '';
1721 $this->clearHTML();
1722 $this->setStatusCode(503);
1723 $this->addWikiMsg( 'actionthrottledtext' );
1724
1725 $this->returnToMain( null, $wgTitle );
1726 }
1727
1728 /**
1729 * Show an "add new section" link?
1730 *
1731 * @return bool
1732 */
1733 public function showNewSectionLink() {
1734 return $this->mNewSectionLink;
1735 }
1736
1737 /**
1738 * Show a warning about slave lag
1739 *
1740 * If the lag is higher than $wgSlaveLagCritical seconds,
1741 * then the warning is a bit more obvious. If the lag is
1742 * lower than $wgSlaveLagWarning, then no warning is shown.
1743 *
1744 * @param int $lag Slave lag
1745 */
1746 public function showLagWarning( $lag ) {
1747 global $wgSlaveLagWarning, $wgSlaveLagCritical;
1748 if( $lag >= $wgSlaveLagWarning ) {
1749 $message = $lag < $wgSlaveLagCritical
1750 ? 'lag-warn-normal'
1751 : 'lag-warn-high';
1752 $warning = wfMsgExt( $message, 'parse', $lag );
1753 $this->addHtml( "<div class=\"mw-{$message}\">\n{$warning}\n</div>\n" );
1754 }
1755 }
1756
1757 /**
1758 * Add a wikitext-formatted message to the output.
1759 * This is equivalent to:
1760 *
1761 * $wgOut->addWikiText( wfMsgNoTrans( ... ) )
1762 */
1763 public function addWikiMsg( /*...*/ ) {
1764 $args = func_get_args();
1765 $name = array_shift( $args );
1766 $this->addWikiMsgArray( $name, $args );
1767 }
1768
1769 /**
1770 * Add a wikitext-formatted message to the output.
1771 * Like addWikiMsg() except the parameters are taken as an array
1772 * instead of a variable argument list.
1773 *
1774 * $options is passed through to wfMsgExt(), see that function for details.
1775 */
1776 public function addWikiMsgArray( $name, $args, $options = array() ) {
1777 $options[] = 'parse';
1778 $text = wfMsgExt( $name, $options, $args );
1779 $this->addHTML( $text );
1780 }
1781
1782 /**
1783 * This function takes a number of message/argument specifications, wraps them in
1784 * some overall structure, and then parses the result and adds it to the output.
1785 *
1786 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
1787 * on. The subsequent arguments may either be strings, in which case they are the
1788 * message names, or an arrays, in which case the first element is the message name,
1789 * and subsequent elements are the parameters to that message.
1790 *
1791 * The special named parameter 'options' in a message specification array is passed
1792 * through to the $options parameter of wfMsgExt().
1793 *
1794 * Don't use this for messages that are not in users interface language.
1795 *
1796 * For example:
1797 *
1798 * $wgOut->wrapWikiMsg( '<div class="error">$1</div>', 'some-error' );
1799 *
1800 * Is equivalent to:
1801 *
1802 * $wgOut->addWikiText( '<div class="error">' . wfMsgNoTrans( 'some-error' ) . '</div>' );
1803 */
1804 public function wrapWikiMsg( $wrap /*, ...*/ ) {
1805 $msgSpecs = func_get_args();
1806 array_shift( $msgSpecs );
1807 $msgSpecs = array_values( $msgSpecs );
1808 $s = $wrap;
1809 foreach ( $msgSpecs as $n => $spec ) {
1810 $options = array();
1811 if ( is_array( $spec ) ) {
1812 $args = $spec;
1813 $name = array_shift( $args );
1814 if ( isset( $args['options'] ) ) {
1815 $options = $args['options'];
1816 unset( $args['options'] );
1817 }
1818 } else {
1819 $args = array();
1820 $name = $spec;
1821 }
1822 $s = str_replace( '$' . ($n+1), wfMsgExt( $name, $options, $args ), $s );
1823 }
1824 $this->addHTML( $this->parse( $s, /*linestart*/true, /*uilang*/true ) );
1825 }
1826 }