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