Remove unnecessary conditional
[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 # Buffer output; final headers may depend on later processing
905 ob_start();
906
907 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
908 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
909
910 if ($this->mArticleBodyOnly) {
911 $this->out($this->mBodytext);
912 } else {
913 // Hook that allows last minute changes to the output page, e.g.
914 // adding of CSS or Javascript by extensions.
915 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
916
917 wfProfileIn( 'Output-skin' );
918 $sk->outputPage( $this );
919 wfProfileOut( 'Output-skin' );
920 }
921
922 $this->sendCacheControl();
923 ob_end_flush();
924 wfProfileOut( __METHOD__ );
925 }
926
927 /**
928 * @todo document
929 * @param string $ins
930 */
931 public function out( $ins ) {
932 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
933 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
934 $outs = $ins;
935 } else {
936 $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
937 if ( false === $outs ) { $outs = $ins; }
938 }
939 print $outs;
940 }
941
942 /**
943 * @todo document
944 */
945 public static function setEncodings() {
946 global $wgInputEncoding, $wgOutputEncoding;
947 global $wgUser, $wgContLang;
948
949 $wgInputEncoding = strtolower( $wgInputEncoding );
950
951 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
952 $wgOutputEncoding = strtolower( $wgOutputEncoding );
953 return;
954 }
955 $wgOutputEncoding = $wgInputEncoding;
956 }
957
958 /**
959 * Deprecated, use wfReportTime() instead.
960 * @return string
961 * @deprecated
962 */
963 public function reportTime() {
964 wfDeprecated( __METHOD__ );
965 $time = wfReportTime();
966 return $time;
967 }
968
969 /**
970 * Produce a "user is blocked" page.
971 *
972 * @param bool $return Whether to have a "return to $wgTitle" message or not.
973 * @return nothing
974 */
975 function blockedPage( $return = true ) {
976 global $wgUser, $wgContLang, $wgTitle, $wgLang;
977
978 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
979 $this->setRobotPolicy( 'noindex,nofollow' );
980 $this->setArticleRelated( false );
981
982 $name = User::whoIs( $wgUser->blockedBy() );
983 $reason = $wgUser->blockedFor();
984 if( $reason == '' ) {
985 $reason = wfMsg( 'blockednoreason' );
986 }
987 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true );
988 $ip = wfGetIP();
989
990 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
991
992 $blockid = $wgUser->mBlock->mId;
993
994 $blockExpiry = $wgUser->mBlock->mExpiry;
995 if ( $blockExpiry == 'infinity' ) {
996 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
997 // Search for localization in 'ipboptions'
998 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
999 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1000 if ( strpos( $option, ":" ) === false )
1001 continue;
1002 list( $show, $value ) = explode( ":", $option );
1003 if ( $value == 'infinite' || $value == 'indefinite' ) {
1004 $blockExpiry = $show;
1005 break;
1006 }
1007 }
1008 } else {
1009 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
1010 }
1011
1012 if ( $wgUser->mBlock->mAuto ) {
1013 $msg = 'autoblockedtext';
1014 } else {
1015 $msg = 'blockedtext';
1016 }
1017
1018 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
1019 * This could be a username, an ip range, or a single ip. */
1020 $intended = $wgUser->mBlock->mAddress;
1021
1022 $this->addWikiMsg( $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp );
1023
1024 # Don't auto-return to special pages
1025 if( $return ) {
1026 $return = $wgTitle->getNamespace() > -1 ? $wgTitle : NULL;
1027 $this->returnToMain( null, $return );
1028 }
1029 }
1030
1031 /**
1032 * Output a standard error page
1033 *
1034 * @param string $title Message key for page title
1035 * @param string $msg Message key for page text
1036 * @param array $params Message parameters
1037 */
1038 public function showErrorPage( $title, $msg, $params = array() ) {
1039 global $wgTitle;
1040 if ( isset($wgTitle) ) {
1041 $this->mDebugtext .= 'Original title: ' . $wgTitle->getPrefixedText() . "\n";
1042 }
1043 $this->setPageTitle( wfMsg( $title ) );
1044 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1045 $this->setRobotPolicy( 'noindex,nofollow' );
1046 $this->setArticleRelated( false );
1047 $this->enableClientCache( false );
1048 $this->mRedirect = '';
1049 $this->mBodytext = '';
1050
1051 array_unshift( $params, 'parse' );
1052 array_unshift( $params, $msg );
1053 $this->addHtml( call_user_func_array( 'wfMsgExt', $params ) );
1054
1055 $this->returnToMain();
1056 }
1057
1058 /**
1059 * Output a standard permission error page
1060 *
1061 * @param array $errors Error message keys
1062 */
1063 public function showPermissionsErrorPage( $errors, $action = null )
1064 {
1065 global $wgTitle;
1066
1067 $this->mDebugtext .= 'Original title: ' .
1068 $wgTitle->getPrefixedText() . "\n";
1069 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1070 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1071 $this->setRobotPolicy( 'noindex,nofollow' );
1072 $this->setArticleRelated( false );
1073 $this->enableClientCache( false );
1074 $this->mRedirect = '';
1075 $this->mBodytext = '';
1076 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1077 }
1078
1079 /** @deprecated */
1080 public function errorpage( $title, $msg ) {
1081 wfDeprecated( __METHOD__ );
1082 throw new ErrorPageError( $title, $msg );
1083 }
1084
1085 /**
1086 * Display an error page indicating that a given version of MediaWiki is
1087 * required to use it
1088 *
1089 * @param mixed $version The version of MediaWiki needed to use the page
1090 */
1091 public function versionRequired( $version ) {
1092 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1093 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1094 $this->setRobotPolicy( 'noindex,nofollow' );
1095 $this->setArticleRelated( false );
1096 $this->mBodytext = '';
1097
1098 $this->addWikiMsg( 'versionrequiredtext', $version );
1099 $this->returnToMain();
1100 }
1101
1102 /**
1103 * Display an error page noting that a given permission bit is required.
1104 *
1105 * @param string $permission key required
1106 */
1107 public function permissionRequired( $permission ) {
1108 global $wgUser;
1109
1110 $this->setPageTitle( wfMsg( 'badaccess' ) );
1111 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1112 $this->setRobotPolicy( 'noindex,nofollow' );
1113 $this->setArticleRelated( false );
1114 $this->mBodytext = '';
1115
1116 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1117 User::getGroupsWithPermission( $permission ) );
1118 if( $groups ) {
1119 $this->addWikiMsg( 'badaccess-groups',
1120 implode( ', ', $groups ),
1121 count( $groups) );
1122 } else {
1123 $this->addWikiMsg( 'badaccess-group0' );
1124 }
1125 $this->returnToMain();
1126 }
1127
1128 /**
1129 * Use permissionRequired.
1130 * @deprecated
1131 */
1132 public function sysopRequired() {
1133 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
1134 }
1135
1136 /**
1137 * Use permissionRequired.
1138 * @deprecated
1139 */
1140 public function developerRequired() {
1141 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
1142 }
1143
1144 /**
1145 * Produce the stock "please login to use the wiki" page
1146 */
1147 public function loginToUse() {
1148 global $wgUser, $wgTitle, $wgContLang;
1149
1150 if( $wgUser->isLoggedIn() ) {
1151 $this->permissionRequired( 'read' );
1152 return;
1153 }
1154
1155 $skin = $wgUser->getSkin();
1156
1157 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
1158 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
1159 $this->setRobotPolicy( 'noindex,nofollow' );
1160 $this->setArticleFlag( false );
1161
1162 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
1163 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
1164 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
1165 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
1166
1167 # Don't return to the main page if the user can't read it
1168 # otherwise we'll end up in a pointless loop
1169 $mainPage = Title::newMainPage();
1170 if( $mainPage->userCanRead() )
1171 $this->returnToMain( null, $mainPage );
1172 }
1173
1174 /** @deprecated */
1175 public function databaseError( $fname, $sql, $error, $errno ) {
1176 throw new MWException( "OutputPage::databaseError is obsolete\n" );
1177 }
1178
1179 /**
1180 * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors
1181 * @return string The wikitext error-messages, formatted into a list.
1182 */
1183 public function formatPermissionsErrorMessage( $errors, $action = null ) {
1184 if ($action == null) {
1185 $text = wfMsgNoTrans( 'permissionserrorstext', count($errors)). "\n\n";
1186 } else {
1187 global $wgLang;
1188 $action_desc = wfMsg( "right-$action" );
1189 $action_desc = $wgLang->lcfirst( $action_desc ); // FIXME: TERRIBLE HACK
1190 $text = wfMsgNoTrans( 'permissionserrorstext-withaction', count($errors), $action_desc ) . "\n\n";
1191 }
1192
1193 if (count( $errors ) > 1) {
1194 $text .= '<ul class="permissions-errors">' . "\n";
1195
1196 foreach( $errors as $error )
1197 {
1198 $text .= '<li>';
1199 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
1200 $text .= "</li>\n";
1201 }
1202 $text .= '</ul>';
1203 } else {
1204 $text .= '<div class="permissions-errors">' . call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) . '</div>';
1205 }
1206
1207 return $text;
1208 }
1209
1210 /**
1211 * Display a page stating that the Wiki is in read-only mode,
1212 * and optionally show the source of the page that the user
1213 * was trying to edit. Should only be called (for this
1214 * purpose) after wfReadOnly() has returned true.
1215 *
1216 * For historical reasons, this function is _also_ used to
1217 * show the error message when a user tries to edit a page
1218 * they are not allowed to edit. (Unless it's because they're
1219 * blocked, then we show blockedPage() instead.) In this
1220 * case, the second parameter should be set to true and a list
1221 * of reasons supplied as the third parameter.
1222 *
1223 * @todo Needs to be split into multiple functions.
1224 *
1225 * @param string $source Source code to show (or null).
1226 * @param bool $protected Is this a permissions error?
1227 * @param array $reasons List of reasons for this error, as returned by Title::getUserPermissionsErrors().
1228 */
1229 public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
1230 global $wgUser, $wgTitle;
1231 $skin = $wgUser->getSkin();
1232
1233 $this->setRobotPolicy( 'noindex,nofollow' );
1234 $this->setArticleRelated( false );
1235
1236 // If no reason is given, just supply a default "I can't let you do
1237 // that, Dave" message. Should only occur if called by legacy code.
1238 if ( $protected && empty($reasons) ) {
1239 $reasons[] = array( 'badaccess-group0' );
1240 }
1241
1242 if ( !empty($reasons) ) {
1243 // Permissions error
1244 if( $source ) {
1245 $this->setPageTitle( wfMsg( 'viewsource' ) );
1246 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
1247 } else {
1248 $this->setPageTitle( wfMsg( 'badaccess' ) );
1249 }
1250 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
1251 } else {
1252 // Wiki is read only
1253 $this->setPageTitle( wfMsg( 'readonly' ) );
1254 $reason = wfReadOnlyReason();
1255 $this->wrapWikiMsg( '<div class="mw-readonly-error">$1</div>', array( 'readonlytext', $reason ) );
1256 }
1257
1258 // Show source, if supplied
1259 if( is_string( $source ) ) {
1260 $this->addWikiMsg( 'viewsourcetext' );
1261 $text = Xml::openElement( 'textarea',
1262 array( 'id' => 'wpTextbox1',
1263 'name' => 'wpTextbox1',
1264 'cols' => $wgUser->getOption( 'cols' ),
1265 'rows' => $wgUser->getOption( 'rows' ),
1266 'readonly' => 'readonly' ) );
1267 $text .= htmlspecialchars( $source );
1268 $text .= Xml::closeElement( 'textarea' );
1269 $this->addHTML( $text );
1270
1271 // Show templates used by this article
1272 $skin = $wgUser->getSkin();
1273 $article = new Article( $wgTitle );
1274 $this->addHTML( "<div class='templatesUsed'>
1275 {$skin->formatTemplates( $article->getUsedTemplates() )}
1276 </div>
1277 " );
1278 }
1279
1280 # If the title doesn't exist, it's fairly pointless to print a return
1281 # link to it. After all, you just tried editing it and couldn't, so
1282 # what's there to do there?
1283 if( $wgTitle->exists() ) {
1284 $this->returnToMain( null, $wgTitle );
1285 }
1286 }
1287
1288 /** @deprecated */
1289 public function fatalError( $message ) {
1290 wfDeprecated( __METHOD__ );
1291 throw new FatalError( $message );
1292 }
1293
1294 /** @deprecated */
1295 public function unexpectedValueError( $name, $val ) {
1296 wfDeprecated( __METHOD__ );
1297 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
1298 }
1299
1300 /** @deprecated */
1301 public function fileCopyError( $old, $new ) {
1302 wfDeprecated( __METHOD__ );
1303 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
1304 }
1305
1306 /** @deprecated */
1307 public function fileRenameError( $old, $new ) {
1308 wfDeprecated( __METHOD__ );
1309 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
1310 }
1311
1312 /** @deprecated */
1313 public function fileDeleteError( $name ) {
1314 wfDeprecated( __METHOD__ );
1315 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
1316 }
1317
1318 /** @deprecated */
1319 public function fileNotFoundError( $name ) {
1320 wfDeprecated( __METHOD__ );
1321 throw new FatalError( wfMsg( 'filenotfound', $name ) );
1322 }
1323
1324 public function showFatalError( $message ) {
1325 $this->setPageTitle( wfMsg( "internalerror" ) );
1326 $this->setRobotPolicy( "noindex,nofollow" );
1327 $this->setArticleRelated( false );
1328 $this->enableClientCache( false );
1329 $this->mRedirect = '';
1330 $this->mBodytext = $message;
1331 }
1332
1333 public function showUnexpectedValueError( $name, $val ) {
1334 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
1335 }
1336
1337 public function showFileCopyError( $old, $new ) {
1338 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
1339 }
1340
1341 public function showFileRenameError( $old, $new ) {
1342 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
1343 }
1344
1345 public function showFileDeleteError( $name ) {
1346 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
1347 }
1348
1349 public function showFileNotFoundError( $name ) {
1350 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
1351 }
1352
1353 /**
1354 * Add a "return to" link pointing to a specified title
1355 *
1356 * @param Title $title Title to link
1357 */
1358 public function addReturnTo( $title ) {
1359 global $wgUser;
1360 $link = wfMsg( 'returnto', $wgUser->getSkin()->makeLinkObj( $title ) );
1361 $this->addHtml( "<p>{$link}</p>\n" );
1362 }
1363
1364 /**
1365 * Add a "return to" link pointing to a specified title,
1366 * or the title indicated in the request, or else the main page
1367 *
1368 * @param null $unused No longer used
1369 * @param Title $returnto Title to return to
1370 */
1371 public function returnToMain( $unused = null, $returnto = NULL ) {
1372 global $wgRequest;
1373
1374 if ( $returnto == NULL ) {
1375 $returnto = $wgRequest->getText( 'returnto' );
1376 }
1377
1378 if ( '' === $returnto ) {
1379 $returnto = Title::newMainPage();
1380 }
1381
1382 if ( is_object( $returnto ) ) {
1383 $titleObj = $returnto;
1384 } else {
1385 $titleObj = Title::newFromText( $returnto );
1386 }
1387 if ( !is_object( $titleObj ) ) {
1388 $titleObj = Title::newMainPage();
1389 }
1390
1391 $this->addReturnTo( $titleObj );
1392 }
1393
1394 /**
1395 * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1396 * and uses the first 10 of them for META keywords
1397 *
1398 * @param ParserOutput &$parserOutput
1399 */
1400 private function addKeywords( &$parserOutput ) {
1401 global $wgTitle;
1402 $this->addKeyword( $wgTitle->getPrefixedText() );
1403 $count = 1;
1404 $links2d =& $parserOutput->getLinks();
1405 if ( !is_array( $links2d ) ) {
1406 return;
1407 }
1408 foreach ( $links2d as $dbkeys ) {
1409 foreach( $dbkeys as $dbkey => $unused ) {
1410 $this->addKeyword( $dbkey );
1411 if ( ++$count > 10 ) {
1412 break 2;
1413 }
1414 }
1415 }
1416 }
1417
1418 /**
1419 * @return string The doctype, opening <html>, and head element.
1420 */
1421 public function headElement( Skin $sk ) {
1422 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1423 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1424 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1425
1426 $this->addMeta( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" );
1427 $this->addStyle( 'common/wikiprintable.css', 'print' );
1428 $sk->setupUserCss( $this );
1429
1430 $ret = '';
1431
1432 if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
1433 $ret .= "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1434 }
1435
1436 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n \"$wgDTD\">\n";
1437
1438 if ( '' == $this->getHTMLTitle() ) {
1439 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ));
1440 }
1441
1442 $rtl = $wgContLang->isRTL() ? " dir='RTL'" : '';
1443 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1444 foreach($wgXhtmlNamespaces as $tag => $ns) {
1445 $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1446 }
1447 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1448 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n\t\t";
1449 $ret .= implode( "\t\t", array(
1450 $this->getHeadLinks(),
1451 $this->buildCssLinks(),
1452 $sk->getHeadScripts( $this->mAllowUserJs ),
1453 $this->mScripts,
1454 $this->getHeadItems(),
1455 ));
1456 if( $sk->usercss ){
1457 $ret .= "<style type='text/css'>{$sk->usercss}</style>";
1458 }
1459
1460 if ($wgUseTrackbacks && $this->isArticleRelated())
1461 $ret .= $wgTitle->trackbackRDF();
1462
1463 $ret .= "</head>\n";
1464 return $ret;
1465 }
1466
1467 protected function addDefaultMeta() {
1468 global $wgVersion;
1469 $this->addMeta( "generator", "MediaWiki $wgVersion" );
1470
1471 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
1472 if( $p !== 'index,follow' ) {
1473 // http://www.robotstxt.org/wc/meta-user.html
1474 // Only show if it's different from the default robots policy
1475 $this->addMeta( 'robots', $p );
1476 }
1477
1478 if ( count( $this->mKeywords ) > 0 ) {
1479 $strip = array(
1480 "/<.*?>/" => '',
1481 "/_/" => ' '
1482 );
1483 $this->addMeta( 'keywords', preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ) ) );
1484 }
1485 }
1486
1487 /**
1488 * @return string HTML tag links to be put in the header.
1489 */
1490 public function getHeadLinks() {
1491 global $wgRequest, $wgFeed;
1492
1493 // Ideally this should happen earlier, somewhere. :P
1494 $this->addDefaultMeta();
1495
1496 $tags = array();
1497
1498 foreach ( $this->mMetatags as $tag ) {
1499 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1500 $a = 'http-equiv';
1501 $tag[0] = substr( $tag[0], 5 );
1502 } else {
1503 $a = 'name';
1504 }
1505 $tags[] = Xml::element( 'meta',
1506 array(
1507 $a => $tag[0],
1508 'content' => $tag[1] ) );
1509 }
1510 foreach ( $this->mLinktags as $tag ) {
1511 $tags[] = Xml::element( 'link', $tag );
1512 }
1513
1514 if( $wgFeed ) {
1515 global $wgTitle;
1516 foreach( $this->getSyndicationLinks() as $format => $link ) {
1517 # Use the page name for the title (accessed through $wgTitle since
1518 # there's no other way). In principle, this could lead to issues
1519 # with having the same name for different feeds corresponding to
1520 # the same page, but we can't avoid that at this low a level.
1521
1522 $tags[] = $this->feedLink(
1523 $format,
1524 $link,
1525 wfMsg( "page-{$format}-feed", $wgTitle->getPrefixedText() ) ); # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
1526 }
1527
1528 # Recent changes feed should appear on every page (except recentchanges,
1529 # that would be redundant). Put it after the per-page feed to avoid
1530 # changing existing behavior. It's still available, probably via a
1531 # menu in your browser. Some sites might have a different feed they'd
1532 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
1533 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
1534 # If so, use it instead.
1535
1536 global $wgOverrideSiteFeed, $wgSitename, $wgFeedClasses;
1537 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
1538
1539 if ( $wgOverrideSiteFeed ) {
1540 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
1541 $tags[] = $this->feedLink (
1542 $type,
1543 htmlspecialchars( $feedUrl ),
1544 wfMsg( "site-{$type}-feed", $wgSitename ) );
1545 }
1546 }
1547 else if ( $wgTitle->getPrefixedText() != $rctitle->getPrefixedText() ) {
1548 foreach( $wgFeedClasses as $format => $class ) {
1549 $tags[] = $this->feedLink(
1550 $format,
1551 $rctitle->getFullURL( "feed={$format}" ),
1552 wfMsg( "site-{$format}-feed", $wgSitename ) ); # For grep: 'site-rss-feed', 'site-atom-feed'.
1553 }
1554 }
1555 }
1556
1557 return implode( "\n\t\t", $tags ) . "\n";
1558 }
1559
1560 /**
1561 * Return URLs for each supported syndication format for this page.
1562 * @return array associating format keys with URLs
1563 */
1564 public function getSyndicationLinks() {
1565 global $wgTitle, $wgFeedClasses;
1566 $links = array();
1567
1568 if( $this->isSyndicated() ) {
1569 if( is_string( $this->getFeedAppendQuery() ) ) {
1570 $appendQuery = "&" . $this->getFeedAppendQuery();
1571 } else {
1572 $appendQuery = "";
1573 }
1574
1575 foreach( $wgFeedClasses as $format => $class ) {
1576 $links[$format] = $wgTitle->getLocalUrl( "feed=$format{$appendQuery}" );
1577 }
1578 }
1579 return $links;
1580 }
1581
1582 /**
1583 * Generate a <link rel/> for an RSS feed.
1584 */
1585 private function feedLink( $type, $url, $text ) {
1586 return Xml::element( 'link', array(
1587 'rel' => 'alternate',
1588 'type' => "application/$type+xml",
1589 'title' => $text,
1590 'href' => $url ) );
1591 }
1592
1593 /**
1594 * Add a local or specified stylesheet, with the given media options.
1595 * Meant primarily for internal use...
1596 *
1597 * @param $media -- to specify a media type, 'screen', 'printable', 'handheld' or any.
1598 * @param $conditional -- for IE conditional comments, specifying an IE version
1599 * @param $dir -- set to 'rtl' or 'ltr' for direction-specific sheets
1600 */
1601 public function addStyle( $style, $media='', $condition='', $dir='' ) {
1602 $options = array();
1603 if( $media )
1604 $options['media'] = $media;
1605 if( $condition )
1606 $options['condition'] = $condition;
1607 if( $dir )
1608 $options['dir'] = $dir;
1609 $this->styles[$style] = $options;
1610 }
1611
1612 /**
1613 * Build a set of <link>s for the stylesheets specified in the $this->styles array.
1614 * These will be applied to various media & IE conditionals.
1615 */
1616 public function buildCssLinks() {
1617 $links = array();
1618 foreach( $this->styles as $file => $options ) {
1619 $link = $this->styleLink( $file, $options );
1620 if( $link )
1621 $links[] = $link;
1622 }
1623
1624 return implode( "\n\t\t", $links );
1625 }
1626
1627 protected function styleLink( $style, $options ) {
1628 global $wgRequest;
1629
1630 if( isset( $options['dir'] ) ) {
1631 global $wgContLang;
1632 $siteDir = $wgContLang->isRTL() ? 'rtl' : 'ltr';
1633 if( $siteDir != $options['dir'] )
1634 return '';
1635 }
1636
1637 if( isset( $options['media'] ) ) {
1638 $media = $this->transformCssMedia( $options['media'] );
1639 if( is_null( $media ) ) {
1640 return '';
1641 }
1642 } else {
1643 $media = '';
1644 }
1645
1646 if( substr( $style, 0, 1 ) == '/' ||
1647 substr( $style, 0, 5 ) == 'http:' ||
1648 substr( $style, 0, 6 ) == 'https:' ) {
1649 $url = $style;
1650 } else {
1651 global $wgStylePath, $wgStyleVersion;
1652 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
1653 }
1654
1655 $attribs = array(
1656 'rel' => 'stylesheet',
1657 'href' => $url,
1658 'type' => 'text/css' );
1659 if( $media ) {
1660 $attribs['media'] = $media;
1661 }
1662
1663 $link = Xml::element( 'link', $attribs );
1664
1665 if( isset( $options['condition'] ) ) {
1666 $condition = htmlspecialchars( $options['condition'] );
1667 $link = "<!--[if $condition]>$link<![endif]-->";
1668 }
1669 return $link;
1670 }
1671
1672 function transformCssMedia( $media ) {
1673 global $wgRequest, $wgHandheldForIPhone;
1674
1675 // Switch in on-screen display for media testing
1676 $switches = array(
1677 'printable' => 'print',
1678 'handheld' => 'handheld',
1679 );
1680 foreach( $switches as $switch => $targetMedia ) {
1681 if( $wgRequest->getBool( $switch ) ) {
1682 if( $media == $targetMedia ) {
1683 $media = '';
1684 } elseif( $media == 'screen' ) {
1685 return null;
1686 }
1687 }
1688 }
1689
1690 // Expand longer media queries as iPhone doesn't grok 'handheld'
1691 if( $wgHandheldForIPhone ) {
1692 $mediaAliases = array(
1693 'screen' => 'screen and (min-device-width: 481px)',
1694 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
1695 );
1696
1697 if( isset( $mediaAliases[$media] ) ) {
1698 $media = $mediaAliases[$media];
1699 }
1700 }
1701
1702 return $media;
1703 }
1704
1705 /**
1706 * Turn off regular page output and return an error reponse
1707 * for when rate limiting has triggered.
1708 */
1709 public function rateLimited() {
1710 global $wgTitle;
1711
1712 $this->setPageTitle(wfMsg('actionthrottled'));
1713 $this->setRobotPolicy( 'noindex,follow' );
1714 $this->setArticleRelated( false );
1715 $this->enableClientCache( false );
1716 $this->mRedirect = '';
1717 $this->clearHTML();
1718 $this->setStatusCode(503);
1719 $this->addWikiMsg( 'actionthrottledtext' );
1720
1721 $this->returnToMain( null, $wgTitle );
1722 }
1723
1724 /**
1725 * Show an "add new section" link?
1726 *
1727 * @return bool
1728 */
1729 public function showNewSectionLink() {
1730 return $this->mNewSectionLink;
1731 }
1732
1733 /**
1734 * Show a warning about slave lag
1735 *
1736 * If the lag is higher than $wgSlaveLagCritical seconds,
1737 * then the warning is a bit more obvious. If the lag is
1738 * lower than $wgSlaveLagWarning, then no warning is shown.
1739 *
1740 * @param int $lag Slave lag
1741 */
1742 public function showLagWarning( $lag ) {
1743 global $wgSlaveLagWarning, $wgSlaveLagCritical;
1744 if( $lag >= $wgSlaveLagWarning ) {
1745 $message = $lag < $wgSlaveLagCritical
1746 ? 'lag-warn-normal'
1747 : 'lag-warn-high';
1748 $warning = wfMsgExt( $message, 'parse', $lag );
1749 $this->addHtml( "<div class=\"mw-{$message}\">\n{$warning}\n</div>\n" );
1750 }
1751 }
1752
1753 /**
1754 * Add a wikitext-formatted message to the output.
1755 * This is equivalent to:
1756 *
1757 * $wgOut->addWikiText( wfMsgNoTrans( ... ) )
1758 */
1759 public function addWikiMsg( /*...*/ ) {
1760 $args = func_get_args();
1761 $name = array_shift( $args );
1762 $this->addWikiMsgArray( $name, $args );
1763 }
1764
1765 /**
1766 * Add a wikitext-formatted message to the output.
1767 * Like addWikiMsg() except the parameters are taken as an array
1768 * instead of a variable argument list.
1769 *
1770 * $options is passed through to wfMsgExt(), see that function for details.
1771 */
1772 public function addWikiMsgArray( $name, $args, $options = array() ) {
1773 $options[] = 'parse';
1774 $text = wfMsgExt( $name, $options, $args );
1775 $this->addHTML( $text );
1776 }
1777
1778 /**
1779 * This function takes a number of message/argument specifications, wraps them in
1780 * some overall structure, and then parses the result and adds it to the output.
1781 *
1782 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
1783 * on. The subsequent arguments may either be strings, in which case they are the
1784 * message names, or an arrays, in which case the first element is the message name,
1785 * and subsequent elements are the parameters to that message.
1786 *
1787 * The special named parameter 'options' in a message specification array is passed
1788 * through to the $options parameter of wfMsgExt().
1789 *
1790 * Don't use this for messages that are not in users interface language.
1791 *
1792 * For example:
1793 *
1794 * $wgOut->wrapWikiMsg( '<div class="error">$1</div>', 'some-error' );
1795 *
1796 * Is equivalent to:
1797 *
1798 * $wgOut->addWikiText( '<div class="error">' . wfMsgNoTrans( 'some-error' ) . '</div>' );
1799 */
1800 public function wrapWikiMsg( $wrap /*, ...*/ ) {
1801 $msgSpecs = func_get_args();
1802 array_shift( $msgSpecs );
1803 $msgSpecs = array_values( $msgSpecs );
1804 $s = $wrap;
1805 foreach ( $msgSpecs as $n => $spec ) {
1806 $options = array();
1807 if ( is_array( $spec ) ) {
1808 $args = $spec;
1809 $name = array_shift( $args );
1810 if ( isset( $args['options'] ) ) {
1811 $options = $args['options'];
1812 unset( $args['options'] );
1813 }
1814 } else {
1815 $args = array();
1816 $name = $spec;
1817 }
1818 $s = str_replace( '$' . ($n+1), wfMsgExt( $name, $options, $args ), $s );
1819 }
1820 $this->addHTML( $this->parse( $s, /*linestart*/true, /*uilang*/true ) );
1821 }
1822 }