Wrap redirectpagesub in a <span>
[lhc/web/wiklou.git] / includes / OutputPage.php
1 <?php
2 /**
3 * Preparation for the final page rendering.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 /**
24 * This class should be covered by a general architecture document which does
25 * not exist as of January 2011. This is one of the Core classes and should
26 * be read at least once by any new developers.
27 *
28 * This class is used to prepare the final rendering. A skin is then
29 * applied to the output parameters (links, javascript, html, categories ...).
30 *
31 * @todo FIXME: Another class handles sending the whole page to the client.
32 *
33 * Some comments comes from a pairing session between Zak Greant and Antoine Musso
34 * in November 2010.
35 *
36 * @todo document
37 */
38 class OutputPage extends ContextSource {
39 /** @var array Should be private. Used with addMeta() which adds "<meta>" */
40 protected $mMetatags = array();
41
42 /** @var array */
43 protected $mLinktags = array();
44
45 /** @var bool */
46 protected $mCanonicalUrl = false;
47
48 /**
49 * @var array Additional stylesheets. Looks like this is for extensions.
50 * Might be replaced by resource loader.
51 */
52 protected $mExtStyles = array();
53
54 /**
55 * @var string Should be private - has getter and setter. Contains
56 * the HTML title */
57 public $mPagetitle = '';
58
59 /**
60 * @var string Contains all of the "<body>" content. Should be private we
61 * got set/get accessors and the append() method.
62 */
63 public $mBodytext = '';
64
65 /**
66 * Holds the debug lines that will be output as comments in page source if
67 * $wgDebugComments is enabled. See also $wgShowDebug.
68 * @deprecated since 1.20; use MWDebug class instead.
69 */
70 public $mDebugtext = '';
71
72 /** @var string Stores contents of "<title>" tag */
73 private $mHTMLtitle = '';
74
75 /**
76 * @var bool Is the displayed content related to the source of the
77 * corresponding wiki article.
78 */
79 private $mIsarticle = false;
80
81 /** @var bool Stores "article flag" toggle. */
82 private $mIsArticleRelated = true;
83
84 /**
85 * @var bool We have to set isPrintable(). Some pages should
86 * never be printed (ex: redirections).
87 */
88 private $mPrintable = false;
89
90 /**
91 * @var array Contains the page subtitle. Special pages usually have some
92 * links here. Don't confuse with site subtitle added by skins.
93 */
94 private $mSubtitle = array();
95
96 /** @var string */
97 public $mRedirect = '';
98
99 /** @var int */
100 protected $mStatusCode;
101
102 /**
103 * @ var string mLastModified and mEtag are used for sending cache control.
104 * The whole caching system should probably be moved into its own class.
105 */
106 protected $mLastModified = '';
107
108 /**
109 * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used
110 * as a unique identifier for the content. It is later used by the client
111 * to compare its cached version with the server version. Client sends
112 * headers If-Match and If-None-Match containing its locally cached ETAG value.
113 *
114 * To get more information, you will have to look at HTTP/1.1 protocol which
115 * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616
116 */
117 private $mETag = false;
118
119 /** @var array */
120 protected $mCategoryLinks = array();
121
122 /** @var array */
123 protected $mCategories = array();
124
125 /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
126 private $mLanguageLinks = array();
127
128 /**
129 * Used for JavaScript (pre resource loader)
130 * @todo We should split JS / CSS.
131 * mScripts content is inserted as is in "<head>" by Skin. This might
132 * contain either a link to a stylesheet or inline CSS.
133 */
134 private $mScripts = '';
135
136 /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
137 protected $mInlineStyles = '';
138
139 /** @todo Unused? */
140 private $mLinkColours;
141
142 /**
143 * @var string Used by skin template.
144 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
145 */
146 public $mPageLinkTitle = '';
147
148 /** @var array Array of elements in "<head>". Parser might add its own headers! */
149 protected $mHeadItems = array();
150
151 // @todo FIXME: Next 5 variables probably come from the resource loader
152
153 /** @var array */
154 protected $mModules = array();
155
156 /** @var array */
157 protected $mModuleScripts = array();
158
159 /** @var array */
160 protected $mModuleStyles = array();
161
162 /** @var array */
163 protected $mModuleMessages = array();
164
165 /** @var ResourceLoader */
166 protected $mResourceLoader;
167
168 /** @var array */
169 protected $mJsConfigVars = array();
170
171 /** @var array */
172 protected $mTemplateIds = array();
173
174 /** @var array */
175 protected $mImageTimeKeys = array();
176
177 /** @var string */
178 public $mRedirectCode = '';
179
180 protected $mFeedLinksAppendQuery = null;
181
182 /** @var array
183 * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
184 * @see ResourceLoaderModule::$origin
185 * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
186 */
187 protected $mAllowedModules = array(
188 ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
189 );
190
191 /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
192 protected $mDoNothing = false;
193
194 // Parser related.
195
196 /**
197 * @var int
198 * @todo Unused?
199 */
200 private $mContainsOldMagic = 0;
201
202 /** @var int */
203 protected $mContainsNewMagic = 0;
204
205 /**
206 * lazy initialised, use parserOptions()
207 * @var ParserOptions
208 */
209 protected $mParserOptions = null;
210
211 /**
212 * Handles the Atom / RSS links.
213 * We probably only support Atom in 2011.
214 * @see $wgAdvertisedFeedTypes
215 */
216 private $mFeedLinks = array();
217
218 // Gwicke work on squid caching? Roughly from 2003.
219 protected $mEnableClientCache = true;
220
221 /** @var bool Flag if output should only contain the body of the article. */
222 private $mArticleBodyOnly = false;
223
224 /** @var bool */
225 protected $mNewSectionLink = false;
226
227 /** @var bool */
228 protected $mHideNewSectionLink = false;
229
230 /**
231 * @var bool Comes from the parser. This was probably made to load CSS/JS
232 * only if we had "<gallery>". Used directly in CategoryPage.php.
233 * Looks like resource loader can replace this.
234 */
235 public $mNoGallery = false;
236
237 /** @var string */
238 private $mPageTitleActionText = '';
239
240 /** @var array */
241 private $mParseWarnings = array();
242
243 /** @var int Cache stuff. Looks like mEnableClientCache */
244 protected $mSquidMaxage = 0;
245
246 /**
247 * @var bool
248 * @todo Document
249 */
250 protected $mPreventClickjacking = true;
251
252 /** @var int To include the variable {{REVISIONID}} */
253 private $mRevisionId = null;
254
255 /** @var string */
256 private $mRevisionTimestamp = null;
257
258 /** @var array */
259 protected $mFileVersion = null;
260
261 /**
262 * @var array An array of stylesheet filenames (relative from skins path),
263 * with options for CSS media, IE conditions, and RTL/LTR direction.
264 * For internal use; add settings in the skin via $this->addStyle()
265 *
266 * Style again! This seems like a code duplication since we already have
267 * mStyles. This is what makes Open Source amazing.
268 */
269 protected $styles = array();
270
271 /**
272 * Whether jQuery is already handled.
273 */
274 protected $mJQueryDone = false;
275
276 private $mIndexPolicy = 'index';
277 private $mFollowPolicy = 'follow';
278 private $mVaryHeader = array(
279 'Accept-Encoding' => array( 'list-contains=gzip' ),
280 );
281
282 /**
283 * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
284 * of the redirect.
285 *
286 * @var Title
287 */
288 private $mRedirectedFrom = null;
289
290 /**
291 * Additional key => value data
292 */
293 private $mProperties = array();
294
295 /**
296 * @var string|null ResourceLoader target for load.php links. If null, will be omitted
297 */
298 private $mTarget = null;
299
300 /**
301 * @var bool Whether parser output should contain table of contents
302 */
303 private $mEnableTOC = true;
304
305 /**
306 * @var bool Whether parser output should contain section edit links
307 */
308 private $mEnableSectionEditLinks = true;
309
310 /**
311 * Constructor for OutputPage. This should not be called directly.
312 * Instead a new RequestContext should be created and it will implicitly create
313 * a OutputPage tied to that context.
314 */
315 function __construct( IContextSource $context = null ) {
316 if ( $context === null ) {
317 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
318 wfDeprecated( __METHOD__, '1.18' );
319 } else {
320 $this->setContext( $context );
321 }
322 }
323
324 /**
325 * Redirect to $url rather than displaying the normal page
326 *
327 * @param string $url URL
328 * @param string $responsecode HTTP status code
329 */
330 public function redirect( $url, $responsecode = '302' ) {
331 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
332 $this->mRedirect = str_replace( "\n", '', $url );
333 $this->mRedirectCode = $responsecode;
334 }
335
336 /**
337 * Get the URL to redirect to, or an empty string if not redirect URL set
338 *
339 * @return string
340 */
341 public function getRedirect() {
342 return $this->mRedirect;
343 }
344
345 /**
346 * Set the HTTP status code to send with the output.
347 *
348 * @param int $statusCode
349 */
350 public function setStatusCode( $statusCode ) {
351 $this->mStatusCode = $statusCode;
352 }
353
354 /**
355 * Add a new "<meta>" tag
356 * To add an http-equiv meta tag, precede the name with "http:"
357 *
358 * @param string $name tag name
359 * @param string $val tag value
360 */
361 function addMeta( $name, $val ) {
362 array_push( $this->mMetatags, array( $name, $val ) );
363 }
364
365 /**
366 * Add a new \<link\> tag to the page header.
367 *
368 * Note: use setCanonicalUrl() for rel=canonical.
369 *
370 * @param array $linkarr associative array of attributes.
371 */
372 function addLink( $linkarr ) {
373 array_push( $this->mLinktags, $linkarr );
374 }
375
376 /**
377 * Add a new \<link\> with "rel" attribute set to "meta"
378 *
379 * @param array $linkarr associative array mapping attribute names to their
380 * values, both keys and values will be escaped, and the
381 * "rel" attribute will be automatically added
382 */
383 function addMetadataLink( $linkarr ) {
384 $linkarr['rel'] = $this->getMetadataAttribute();
385 $this->addLink( $linkarr );
386 }
387
388 /**
389 * Set the URL to be used for the <link rel=canonical>. This should be used
390 * in preference to addLink(), to avoid duplicate link tags.
391 */
392 function setCanonicalUrl( $url ) {
393 $this->mCanonicalUrl = $url;
394 }
395
396 /**
397 * Get the value of the "rel" attribute for metadata links
398 *
399 * @return string
400 */
401 public function getMetadataAttribute() {
402 # note: buggy CC software only reads first "meta" link
403 static $haveMeta = false;
404 if ( $haveMeta ) {
405 return 'alternate meta';
406 } else {
407 $haveMeta = true;
408 return 'meta';
409 }
410 }
411
412 /**
413 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
414 *
415 * @param string $script raw HTML
416 */
417 function addScript( $script ) {
418 $this->mScripts .= $script . "\n";
419 }
420
421 /**
422 * Register and add a stylesheet from an extension directory.
423 *
424 * @param string $url path to sheet. Provide either a full url (beginning
425 * with 'http', etc) or a relative path from the document root
426 * (beginning with '/'). Otherwise it behaves identically to
427 * addStyle() and draws from the /skins folder.
428 */
429 public function addExtensionStyle( $url ) {
430 array_push( $this->mExtStyles, $url );
431 }
432
433 /**
434 * Get all styles added by extensions
435 *
436 * @return array
437 */
438 function getExtStyle() {
439 return $this->mExtStyles;
440 }
441
442 /**
443 * Add a JavaScript file out of skins/common, or a given relative path.
444 *
445 * @param string $file filename in skins/common or complete on-server path
446 * (/foo/bar.js)
447 * @param string $version style version of the file. Defaults to $wgStyleVersion
448 */
449 public function addScriptFile( $file, $version = null ) {
450 global $wgStylePath, $wgStyleVersion;
451 // See if $file parameter is an absolute URL or begins with a slash
452 if ( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
453 $path = $file;
454 } else {
455 $path = "{$wgStylePath}/common/{$file}";
456 }
457 if ( is_null( $version ) ) {
458 $version = $wgStyleVersion;
459 }
460 $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
461 }
462
463 /**
464 * Add a self-contained script tag with the given contents
465 *
466 * @param string $script JavaScript text, no "<script>" tags
467 */
468 public function addInlineScript( $script ) {
469 $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n";
470 }
471
472 /**
473 * Get all registered JS and CSS tags for the header.
474 *
475 * @return string
476 * @deprecated since 1.24 Use OutputPage::headElement to build the full header.
477 */
478 function getScript() {
479 wfDeprecated( __METHOD__, '1.24' );
480 return $this->mScripts . $this->getHeadItems();
481 }
482
483 /**
484 * Filter an array of modules to remove insufficiently trustworthy members, and modules
485 * which are no longer registered (eg a page is cached before an extension is disabled)
486 * @param array $modules
487 * @param string|null $position if not null, only return modules with this position
488 * @param string $type
489 * @return array
490 */
491 protected function filterModules( $modules, $position = null,
492 $type = ResourceLoaderModule::TYPE_COMBINED
493 ) {
494 $resourceLoader = $this->getResourceLoader();
495 $filteredModules = array();
496 foreach ( $modules as $val ) {
497 $module = $resourceLoader->getModule( $val );
498 if ( $module instanceof ResourceLoaderModule
499 && $module->getOrigin() <= $this->getAllowedModules( $type )
500 && ( is_null( $position ) || $module->getPosition() == $position )
501 && ( !$this->mTarget || in_array( $this->mTarget, $module->getTargets() ) )
502 ) {
503 $filteredModules[] = $val;
504 }
505 }
506 return $filteredModules;
507 }
508
509 /**
510 * Get the list of modules to include on this page
511 *
512 * @param bool $filter Whether to filter out insufficiently trustworthy modules
513 * @param string|null $position If not null, only return modules with this position
514 * @param string $param
515 * @return array Array of module names
516 */
517 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
518 $modules = array_values( array_unique( $this->$param ) );
519 return $filter
520 ? $this->filterModules( $modules, $position )
521 : $modules;
522 }
523
524 /**
525 * Add one or more modules recognized by the resource loader. Modules added
526 * through this function will be loaded by the resource loader when the
527 * page loads.
528 *
529 * @param string|array $modules Module name (string) or array of module names
530 */
531 public function addModules( $modules ) {
532 $this->mModules = array_merge( $this->mModules, (array)$modules );
533 }
534
535 /**
536 * Get the list of module JS to include on this page
537 *
538 * @param bool $filter
539 * @param string|null $position
540 *
541 * @return array Array of module names
542 */
543 public function getModuleScripts( $filter = false, $position = null ) {
544 return $this->getModules( $filter, $position, 'mModuleScripts' );
545 }
546
547 /**
548 * Add only JS of one or more modules recognized by the resource loader. Module
549 * scripts added through this function will be loaded by the resource loader when
550 * the page loads.
551 *
552 * @param string|array $modules Module name (string) or array of module names
553 */
554 public function addModuleScripts( $modules ) {
555 $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
556 }
557
558 /**
559 * Get the list of module CSS to include on this page
560 *
561 * @param bool $filter
562 * @param string|null $position
563 *
564 * @return array Array of module names
565 */
566 public function getModuleStyles( $filter = false, $position = null ) {
567 return $this->getModules( $filter, $position, 'mModuleStyles' );
568 }
569
570 /**
571 * Add only CSS of one or more modules recognized by the resource loader.
572 *
573 * Module styles added through this function will be added using standard link CSS
574 * tags, rather than as a combined Javascript and CSS package. Thus, they will
575 * load when JavaScript is disabled (unless CSS also happens to be disabled).
576 *
577 * @param string|array $modules Module name (string) or array of module names
578 */
579 public function addModuleStyles( $modules ) {
580 $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
581 }
582
583 /**
584 * Get the list of module messages to include on this page
585 *
586 * @param bool $filter
587 * @param string|null $position
588 *
589 * @return array Array of module names
590 */
591 public function getModuleMessages( $filter = false, $position = null ) {
592 return $this->getModules( $filter, $position, 'mModuleMessages' );
593 }
594
595 /**
596 * Add only messages of one or more modules recognized by the resource loader.
597 * Module messages added through this function will be loaded by the resource
598 * loader when the page loads.
599 *
600 * @param string|array $modules Module name (string) or array of module names
601 */
602 public function addModuleMessages( $modules ) {
603 $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
604 }
605
606 /**
607 * @return null|string ResourceLoader target
608 */
609 public function getTarget() {
610 return $this->mTarget;
611 }
612
613 /**
614 * Sets ResourceLoader target for load.php links. If null, will be omitted
615 *
616 * @param string|null $target
617 */
618 public function setTarget( $target ) {
619 $this->mTarget = $target;
620 }
621
622 /**
623 * Get an array of head items
624 *
625 * @return array
626 */
627 function getHeadItemsArray() {
628 return $this->mHeadItems;
629 }
630
631 /**
632 * Get all header items in a string
633 *
634 * @return string
635 * @deprecated since 1.24 Use OutputPage::headElement or
636 * if absolutely necessary use OutputPage::getHeadItemsArray
637 */
638 function getHeadItems() {
639 wfDeprecated( __METHOD__, '1.24' );
640 $s = '';
641 foreach ( $this->mHeadItems as $item ) {
642 $s .= $item;
643 }
644 return $s;
645 }
646
647 /**
648 * Add or replace an header item to the output
649 *
650 * @param string $name item name
651 * @param string $value raw HTML
652 */
653 public function addHeadItem( $name, $value ) {
654 $this->mHeadItems[$name] = $value;
655 }
656
657 /**
658 * Check if the header item $name is already set
659 *
660 * @param string $name Item name
661 * @return bool
662 */
663 public function hasHeadItem( $name ) {
664 return isset( $this->mHeadItems[$name] );
665 }
666
667 /**
668 * Set the value of the ETag HTTP header, only used if $wgUseETag is true
669 *
670 * @param string $tag value of "ETag" header
671 */
672 function setETag( $tag ) {
673 $this->mETag = $tag;
674 }
675
676 /**
677 * Set whether the output should only contain the body of the article,
678 * without any skin, sidebar, etc.
679 * Used e.g. when calling with "action=render".
680 *
681 * @param bool $only Whether to output only the body of the article
682 */
683 public function setArticleBodyOnly( $only ) {
684 $this->mArticleBodyOnly = $only;
685 }
686
687 /**
688 * Return whether the output will contain only the body of the article
689 *
690 * @return bool
691 */
692 public function getArticleBodyOnly() {
693 return $this->mArticleBodyOnly;
694 }
695
696 /**
697 * Set an additional output property
698 * @since 1.21
699 *
700 * @param string $name
701 * @param mixed $value
702 */
703 public function setProperty( $name, $value ) {
704 $this->mProperties[$name] = $value;
705 }
706
707 /**
708 * Get an additional output property
709 * @since 1.21
710 *
711 * @param string $name
712 * @return mixed Property value or null if not found
713 */
714 public function getProperty( $name ) {
715 if ( isset( $this->mProperties[$name] ) ) {
716 return $this->mProperties[$name];
717 } else {
718 return null;
719 }
720 }
721
722 /**
723 * checkLastModified tells the client to use the client-cached page if
724 * possible. If successful, the OutputPage is disabled so that
725 * any future call to OutputPage->output() have no effect.
726 *
727 * Side effect: sets mLastModified for Last-Modified header
728 *
729 * @param string $timestamp
730 *
731 * @return bool True if cache-ok headers was sent.
732 */
733 public function checkLastModified( $timestamp ) {
734 global $wgCachePages, $wgCacheEpoch, $wgUseSquid, $wgSquidMaxage;
735
736 if ( !$timestamp || $timestamp == '19700101000000' ) {
737 wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
738 return false;
739 }
740 if ( !$wgCachePages ) {
741 wfDebug( __METHOD__ . ": CACHE DISABLED\n" );
742 return false;
743 }
744
745 $timestamp = wfTimestamp( TS_MW, $timestamp );
746 $modifiedTimes = array(
747 'page' => $timestamp,
748 'user' => $this->getUser()->getTouched(),
749 'epoch' => $wgCacheEpoch
750 );
751 if ( $wgUseSquid ) {
752 // bug 44570: the core page itself may not change, but resources might
753 $modifiedTimes['sepoch'] = wfTimestamp( TS_MW, time() - $wgSquidMaxage );
754 }
755 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
756
757 $maxModified = max( $modifiedTimes );
758 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
759
760 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
761 if ( $clientHeader === false ) {
762 wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", 'log' );
763 return false;
764 }
765
766 # IE sends sizes after the date like this:
767 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
768 # this breaks strtotime().
769 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
770
771 wfSuppressWarnings(); // E_STRICT system time bitching
772 $clientHeaderTime = strtotime( $clientHeader );
773 wfRestoreWarnings();
774 if ( !$clientHeaderTime ) {
775 wfDebug( __METHOD__
776 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
777 return false;
778 }
779 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
780
781 # Make debug info
782 $info = '';
783 foreach ( $modifiedTimes as $name => $value ) {
784 if ( $info !== '' ) {
785 $info .= ', ';
786 }
787 $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
788 }
789
790 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
791 wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", 'log' );
792 wfDebug( __METHOD__ . ": effective Last-Modified: " .
793 wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", 'log' );
794 if ( $clientHeaderTime < $maxModified ) {
795 wfDebug( __METHOD__ . ": STALE, $info\n", 'log' );
796 return false;
797 }
798
799 # Not modified
800 # Give a 304 response code and disable body output
801 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", 'log' );
802 ini_set( 'zlib.output_compression', 0 );
803 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
804 $this->sendCacheControl();
805 $this->disable();
806
807 // Don't output a compressed blob when using ob_gzhandler;
808 // it's technically against HTTP spec and seems to confuse
809 // Firefox when the response gets split over two packets.
810 wfClearOutputBuffers();
811
812 return true;
813 }
814
815 /**
816 * Override the last modified timestamp
817 *
818 * @param string $timestamp new timestamp, in a format readable by
819 * wfTimestamp()
820 */
821 public function setLastModified( $timestamp ) {
822 $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
823 }
824
825 /**
826 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
827 *
828 * @param string $policy the literal string to output as the contents of
829 * the meta tag. Will be parsed according to the spec and output in
830 * standardized form.
831 * @return null
832 */
833 public function setRobotPolicy( $policy ) {
834 $policy = Article::formatRobotPolicy( $policy );
835
836 if ( isset( $policy['index'] ) ) {
837 $this->setIndexPolicy( $policy['index'] );
838 }
839 if ( isset( $policy['follow'] ) ) {
840 $this->setFollowPolicy( $policy['follow'] );
841 }
842 }
843
844 /**
845 * Set the index policy for the page, but leave the follow policy un-
846 * touched.
847 *
848 * @param string $policy Either 'index' or 'noindex'.
849 * @return null
850 */
851 public function setIndexPolicy( $policy ) {
852 $policy = trim( $policy );
853 if ( in_array( $policy, array( 'index', 'noindex' ) ) ) {
854 $this->mIndexPolicy = $policy;
855 }
856 }
857
858 /**
859 * Set the follow policy for the page, but leave the index policy un-
860 * touched.
861 *
862 * @param string $policy either 'follow' or 'nofollow'.
863 * @return null
864 */
865 public function setFollowPolicy( $policy ) {
866 $policy = trim( $policy );
867 if ( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
868 $this->mFollowPolicy = $policy;
869 }
870 }
871
872 /**
873 * Set the new value of the "action text", this will be added to the
874 * "HTML title", separated from it with " - ".
875 *
876 * @param string $text new value of the "action text"
877 */
878 public function setPageTitleActionText( $text ) {
879 $this->mPageTitleActionText = $text;
880 }
881
882 /**
883 * Get the value of the "action text"
884 *
885 * @return string
886 */
887 public function getPageTitleActionText() {
888 return $this->mPageTitleActionText;
889 }
890
891 /**
892 * "HTML title" means the contents of "<title>".
893 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
894 *
895 * @param string $name
896 */
897 public function setHTMLTitle( $name ) {
898 if ( $name instanceof Message ) {
899 $this->mHTMLtitle = $name->setContext( $this->getContext() )->text();
900 } else {
901 $this->mHTMLtitle = $name;
902 }
903 }
904
905 /**
906 * Return the "HTML title", i.e. the content of the "<title>" tag.
907 *
908 * @return string
909 */
910 public function getHTMLTitle() {
911 return $this->mHTMLtitle;
912 }
913
914 /**
915 * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
916 *
917 * @param Title $t
918 */
919 public function setRedirectedFrom( $t ) {
920 $this->mRedirectedFrom = $t;
921 }
922
923 /**
924 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
925 * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
926 * but not bad tags like \<script\>. This function automatically sets
927 * \<title\> to the same content as \<h1\> but with all tags removed. Bad
928 * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
929 * good tags like \<i\> will be dropped entirely.
930 *
931 * @param string|Message $name
932 */
933 public function setPageTitle( $name ) {
934 if ( $name instanceof Message ) {
935 $name = $name->setContext( $this->getContext() )->text();
936 }
937
938 # change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"
939 # but leave "<i>foobar</i>" alone
940 $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
941 $this->mPagetitle = $nameWithTags;
942
943 # change "<i>foo&amp;bar</i>" to "foo&bar"
944 $this->setHTMLTitle(
945 $this->msg( 'pagetitle' )->rawParams( Sanitizer::stripAllTags( $nameWithTags ) )
946 ->inContentLanguage()
947 );
948 }
949
950 /**
951 * Return the "page title", i.e. the content of the \<h1\> tag.
952 *
953 * @return string
954 */
955 public function getPageTitle() {
956 return $this->mPagetitle;
957 }
958
959 /**
960 * Set the Title object to use
961 *
962 * @param Title $t
963 */
964 public function setTitle( Title $t ) {
965 $this->getContext()->setTitle( $t );
966 }
967
968 /**
969 * Replace the subtitle with $str
970 *
971 * @param string|Message $str new value of the subtitle. String should be safe HTML.
972 */
973 public function setSubtitle( $str ) {
974 $this->clearSubtitle();
975 $this->addSubtitle( $str );
976 }
977
978 /**
979 * Add $str to the subtitle
980 *
981 * @deprecated since 1.19; use addSubtitle() instead
982 * @param string|Message $str to add to the subtitle
983 */
984 public function appendSubtitle( $str ) {
985 $this->addSubtitle( $str );
986 }
987
988 /**
989 * Add $str to the subtitle
990 *
991 * @param string|Message $str to add to the subtitle. String should be safe HTML.
992 */
993 public function addSubtitle( $str ) {
994 if ( $str instanceof Message ) {
995 $this->mSubtitle[] = $str->setContext( $this->getContext() )->parse();
996 } else {
997 $this->mSubtitle[] = $str;
998 }
999 }
1000
1001 /**
1002 * Add a subtitle containing a backlink to a page
1003 *
1004 * @param Title $title Title to link to
1005 */
1006 public function addBacklinkSubtitle( Title $title ) {
1007 $query = array();
1008 if ( $title->isRedirect() ) {
1009 $query['redirect'] = 'no';
1010 }
1011 $this->addSubtitle( $this->msg( 'backlinksubtitle' )
1012 ->rawParams( Linker::link( $title, null, array(), $query ) ) );
1013 }
1014
1015 /**
1016 * Clear the subtitles
1017 */
1018 public function clearSubtitle() {
1019 $this->mSubtitle = array();
1020 }
1021
1022 /**
1023 * Get the subtitle
1024 *
1025 * @return string
1026 */
1027 public function getSubtitle() {
1028 return implode( "<br />\n\t\t\t\t", $this->mSubtitle );
1029 }
1030
1031 /**
1032 * Set the page as printable, i.e. it'll be displayed with with all
1033 * print styles included
1034 */
1035 public function setPrintable() {
1036 $this->mPrintable = true;
1037 }
1038
1039 /**
1040 * Return whether the page is "printable"
1041 *
1042 * @return bool
1043 */
1044 public function isPrintable() {
1045 return $this->mPrintable;
1046 }
1047
1048 /**
1049 * Disable output completely, i.e. calling output() will have no effect
1050 */
1051 public function disable() {
1052 $this->mDoNothing = true;
1053 }
1054
1055 /**
1056 * Return whether the output will be completely disabled
1057 *
1058 * @return bool
1059 */
1060 public function isDisabled() {
1061 return $this->mDoNothing;
1062 }
1063
1064 /**
1065 * Show an "add new section" link?
1066 *
1067 * @return bool
1068 */
1069 public function showNewSectionLink() {
1070 return $this->mNewSectionLink;
1071 }
1072
1073 /**
1074 * Forcibly hide the new section link?
1075 *
1076 * @return bool
1077 */
1078 public function forceHideNewSectionLink() {
1079 return $this->mHideNewSectionLink;
1080 }
1081
1082 /**
1083 * Add or remove feed links in the page header
1084 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1085 * for the new version
1086 * @see addFeedLink()
1087 *
1088 * @param bool $show true: add default feeds, false: remove all feeds
1089 */
1090 public function setSyndicated( $show = true ) {
1091 if ( $show ) {
1092 $this->setFeedAppendQuery( false );
1093 } else {
1094 $this->mFeedLinks = array();
1095 }
1096 }
1097
1098 /**
1099 * Add default feeds to the page header
1100 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1101 * for the new version
1102 * @see addFeedLink()
1103 *
1104 * @param string $val query to append to feed links or false to output
1105 * default links
1106 */
1107 public function setFeedAppendQuery( $val ) {
1108 global $wgAdvertisedFeedTypes;
1109
1110 $this->mFeedLinks = array();
1111
1112 foreach ( $wgAdvertisedFeedTypes as $type ) {
1113 $query = "feed=$type";
1114 if ( is_string( $val ) ) {
1115 $query .= '&' . $val;
1116 }
1117 $this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
1118 }
1119 }
1120
1121 /**
1122 * Add a feed link to the page header
1123 *
1124 * @param string $format feed type, should be a key of $wgFeedClasses
1125 * @param string $href URL
1126 */
1127 public function addFeedLink( $format, $href ) {
1128 global $wgAdvertisedFeedTypes;
1129
1130 if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
1131 $this->mFeedLinks[$format] = $href;
1132 }
1133 }
1134
1135 /**
1136 * Should we output feed links for this page?
1137 * @return bool
1138 */
1139 public function isSyndicated() {
1140 return count( $this->mFeedLinks ) > 0;
1141 }
1142
1143 /**
1144 * Return URLs for each supported syndication format for this page.
1145 * @return array associating format keys with URLs
1146 */
1147 public function getSyndicationLinks() {
1148 return $this->mFeedLinks;
1149 }
1150
1151 /**
1152 * Will currently always return null
1153 *
1154 * @return null
1155 */
1156 public function getFeedAppendQuery() {
1157 return $this->mFeedLinksAppendQuery;
1158 }
1159
1160 /**
1161 * Set whether the displayed content is related to the source of the
1162 * corresponding article on the wiki
1163 * Setting true will cause the change "article related" toggle to true
1164 *
1165 * @param bool $v
1166 */
1167 public function setArticleFlag( $v ) {
1168 $this->mIsarticle = $v;
1169 if ( $v ) {
1170 $this->mIsArticleRelated = $v;
1171 }
1172 }
1173
1174 /**
1175 * Return whether the content displayed page is related to the source of
1176 * the corresponding article on the wiki
1177 *
1178 * @return bool
1179 */
1180 public function isArticle() {
1181 return $this->mIsarticle;
1182 }
1183
1184 /**
1185 * Set whether this page is related an article on the wiki
1186 * Setting false will cause the change of "article flag" toggle to false
1187 *
1188 * @param bool $v
1189 */
1190 public function setArticleRelated( $v ) {
1191 $this->mIsArticleRelated = $v;
1192 if ( !$v ) {
1193 $this->mIsarticle = false;
1194 }
1195 }
1196
1197 /**
1198 * Return whether this page is related an article on the wiki
1199 *
1200 * @return bool
1201 */
1202 public function isArticleRelated() {
1203 return $this->mIsArticleRelated;
1204 }
1205
1206 /**
1207 * Add new language links
1208 *
1209 * @param array $newLinkArray Associative array mapping language code to the page
1210 * name
1211 */
1212 public function addLanguageLinks( $newLinkArray ) {
1213 $this->mLanguageLinks += $newLinkArray;
1214 }
1215
1216 /**
1217 * Reset the language links and add new language links
1218 *
1219 * @param array $newLinkArray Associative array mapping language code to the page
1220 * name
1221 */
1222 public function setLanguageLinks( $newLinkArray ) {
1223 $this->mLanguageLinks = $newLinkArray;
1224 }
1225
1226 /**
1227 * Get the list of language links
1228 *
1229 * @return array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1230 */
1231 public function getLanguageLinks() {
1232 return $this->mLanguageLinks;
1233 }
1234
1235 /**
1236 * Add an array of categories, with names in the keys
1237 *
1238 * @param array $categories mapping category name => sort key
1239 */
1240 public function addCategoryLinks( $categories ) {
1241 global $wgContLang;
1242
1243 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
1244 return;
1245 }
1246
1247 # Add the links to a LinkBatch
1248 $arr = array( NS_CATEGORY => $categories );
1249 $lb = new LinkBatch;
1250 $lb->setArray( $arr );
1251
1252 # Fetch existence plus the hiddencat property
1253 $dbr = wfGetDB( DB_SLAVE );
1254 $res = $dbr->select( array( 'page', 'page_props' ),
1255 array( 'page_id', 'page_namespace', 'page_title', 'page_len',
1256 'page_is_redirect', 'page_latest', 'pp_value' ),
1257 $lb->constructSet( 'page', $dbr ),
1258 __METHOD__,
1259 array(),
1260 array( 'page_props' => array( 'LEFT JOIN', array(
1261 'pp_propname' => 'hiddencat',
1262 'pp_page = page_id'
1263 ) ) )
1264 );
1265
1266 # Add the results to the link cache
1267 $lb->addResultToCache( LinkCache::singleton(), $res );
1268
1269 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
1270 $categories = array_combine(
1271 array_keys( $categories ),
1272 array_fill( 0, count( $categories ), 'normal' )
1273 );
1274
1275 # Mark hidden categories
1276 foreach ( $res as $row ) {
1277 if ( isset( $row->pp_value ) ) {
1278 $categories[$row->page_title] = 'hidden';
1279 }
1280 }
1281
1282 # Add the remaining categories to the skin
1283 if ( wfRunHooks(
1284 'OutputPageMakeCategoryLinks',
1285 array( &$this, $categories, &$this->mCategoryLinks ) )
1286 ) {
1287 foreach ( $categories as $category => $type ) {
1288 $origcategory = $category;
1289 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
1290 if ( !$title ) {
1291 continue;
1292 }
1293 $wgContLang->findVariantLink( $category, $title, true );
1294 if ( $category != $origcategory ) {
1295 if ( array_key_exists( $category, $categories ) ) {
1296 continue;
1297 }
1298 }
1299 $text = $wgContLang->convertHtml( $title->getText() );
1300 $this->mCategories[] = $title->getText();
1301 $this->mCategoryLinks[$type][] = Linker::link( $title, $text );
1302 }
1303 }
1304 }
1305
1306 /**
1307 * Reset the category links (but not the category list) and add $categories
1308 *
1309 * @param array $categories mapping category name => sort key
1310 */
1311 public function setCategoryLinks( $categories ) {
1312 $this->mCategoryLinks = array();
1313 $this->addCategoryLinks( $categories );
1314 }
1315
1316 /**
1317 * Get the list of category links, in a 2-D array with the following format:
1318 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1319 * hidden categories) and $link a HTML fragment with a link to the category
1320 * page
1321 *
1322 * @return array
1323 */
1324 public function getCategoryLinks() {
1325 return $this->mCategoryLinks;
1326 }
1327
1328 /**
1329 * Get the list of category names this page belongs to
1330 *
1331 * @return array Array of strings
1332 */
1333 public function getCategories() {
1334 return $this->mCategories;
1335 }
1336
1337 /**
1338 * Do not allow scripts which can be modified by wiki users to load on this page;
1339 * only allow scripts bundled with, or generated by, the software.
1340 */
1341 public function disallowUserJs() {
1342 $this->reduceAllowedModules(
1343 ResourceLoaderModule::TYPE_SCRIPTS,
1344 ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
1345 );
1346 }
1347
1348 /**
1349 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1350 * @see ResourceLoaderModule::$origin
1351 * @param string $type ResourceLoaderModule TYPE_ constant
1352 * @return int ResourceLoaderModule ORIGIN_ class constant
1353 */
1354 public function getAllowedModules( $type ) {
1355 if ( $type == ResourceLoaderModule::TYPE_COMBINED ) {
1356 return min( array_values( $this->mAllowedModules ) );
1357 } else {
1358 return isset( $this->mAllowedModules[$type] )
1359 ? $this->mAllowedModules[$type]
1360 : ResourceLoaderModule::ORIGIN_ALL;
1361 }
1362 }
1363
1364 /**
1365 * Set the highest level of CSS/JS untrustworthiness allowed
1366 * @param string $type ResourceLoaderModule TYPE_ constant
1367 * @param int $level ResourceLoaderModule class constant
1368 */
1369 public function setAllowedModules( $type, $level ) {
1370 $this->mAllowedModules[$type] = $level;
1371 }
1372
1373 /**
1374 * As for setAllowedModules(), but don't inadvertently make the page more accessible
1375 * @param string $type
1376 * @param int $level ResourceLoaderModule class constant
1377 */
1378 public function reduceAllowedModules( $type, $level ) {
1379 $this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
1380 }
1381
1382 /**
1383 * Prepend $text to the body HTML
1384 *
1385 * @param string $text HTML
1386 */
1387 public function prependHTML( $text ) {
1388 $this->mBodytext = $text . $this->mBodytext;
1389 }
1390
1391 /**
1392 * Append $text to the body HTML
1393 *
1394 * @param string $text HTML
1395 */
1396 public function addHTML( $text ) {
1397 $this->mBodytext .= $text;
1398 }
1399
1400 /**
1401 * Shortcut for adding an Html::element via addHTML.
1402 *
1403 * @since 1.19
1404 *
1405 * @param string $element
1406 * @param array $attribs
1407 * @param string $contents
1408 */
1409 public function addElement( $element, $attribs = array(), $contents = '' ) {
1410 $this->addHTML( Html::element( $element, $attribs, $contents ) );
1411 }
1412
1413 /**
1414 * Clear the body HTML
1415 */
1416 public function clearHTML() {
1417 $this->mBodytext = '';
1418 }
1419
1420 /**
1421 * Get the body HTML
1422 *
1423 * @return string HTML
1424 */
1425 public function getHTML() {
1426 return $this->mBodytext;
1427 }
1428
1429 /**
1430 * Get/set the ParserOptions object to use for wikitext parsing
1431 *
1432 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1433 * current ParserOption object
1434 * @return ParserOptions
1435 */
1436 public function parserOptions( $options = null ) {
1437 if ( !$this->mParserOptions ) {
1438 $this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
1439 $this->mParserOptions->setEditSection( false );
1440 }
1441 return wfSetVar( $this->mParserOptions, $options );
1442 }
1443
1444 /**
1445 * Set the revision ID which will be seen by the wiki text parser
1446 * for things such as embedded {{REVISIONID}} variable use.
1447 *
1448 * @param int|null $revid An positive integer, or null
1449 * @return mixed Previous value
1450 */
1451 public function setRevisionId( $revid ) {
1452 $val = is_null( $revid ) ? null : intval( $revid );
1453 return wfSetVar( $this->mRevisionId, $val );
1454 }
1455
1456 /**
1457 * Get the displayed revision ID
1458 *
1459 * @return int
1460 */
1461 public function getRevisionId() {
1462 return $this->mRevisionId;
1463 }
1464
1465 /**
1466 * Set the timestamp of the revision which will be displayed. This is used
1467 * to avoid a extra DB call in Skin::lastModified().
1468 *
1469 * @param string|null $timestamp
1470 * @return mixed Previous value
1471 */
1472 public function setRevisionTimestamp( $timestamp ) {
1473 return wfSetVar( $this->mRevisionTimestamp, $timestamp );
1474 }
1475
1476 /**
1477 * Get the timestamp of displayed revision.
1478 * This will be null if not filled by setRevisionTimestamp().
1479 *
1480 * @return string|null
1481 */
1482 public function getRevisionTimestamp() {
1483 return $this->mRevisionTimestamp;
1484 }
1485
1486 /**
1487 * Set the displayed file version
1488 *
1489 * @param File|bool $file
1490 * @return mixed Previous value
1491 */
1492 public function setFileVersion( $file ) {
1493 $val = null;
1494 if ( $file instanceof File && $file->exists() ) {
1495 $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1496 }
1497 return wfSetVar( $this->mFileVersion, $val, true );
1498 }
1499
1500 /**
1501 * Get the displayed file version
1502 *
1503 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1504 */
1505 public function getFileVersion() {
1506 return $this->mFileVersion;
1507 }
1508
1509 /**
1510 * Get the templates used on this page
1511 *
1512 * @return array (namespace => dbKey => revId)
1513 * @since 1.18
1514 */
1515 public function getTemplateIds() {
1516 return $this->mTemplateIds;
1517 }
1518
1519 /**
1520 * Get the files used on this page
1521 *
1522 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1523 * @since 1.18
1524 */
1525 public function getFileSearchOptions() {
1526 return $this->mImageTimeKeys;
1527 }
1528
1529 /**
1530 * Convert wikitext to HTML and add it to the buffer
1531 * Default assumes that the current page title will be used.
1532 *
1533 * @param string $text
1534 * @param bool $linestart Is this the start of a line?
1535 * @param bool $interface Is this text in the user interface language?
1536 */
1537 public function addWikiText( $text, $linestart = true, $interface = true ) {
1538 $title = $this->getTitle(); // Work around E_STRICT
1539 if ( !$title ) {
1540 throw new MWException( 'Title is null' );
1541 }
1542 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1543 }
1544
1545 /**
1546 * Add wikitext with a custom Title object
1547 *
1548 * @param string $text Wikitext
1549 * @param Title $title
1550 * @param bool $linestart Is this the start of a line?
1551 */
1552 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1553 $this->addWikiTextTitle( $text, $title, $linestart );
1554 }
1555
1556 /**
1557 * Add wikitext with a custom Title object and tidy enabled.
1558 *
1559 * @param string $text Wikitext
1560 * @param Title $title
1561 * @param bool $linestart Is this the start of a line?
1562 */
1563 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1564 $this->addWikiTextTitle( $text, $title, $linestart, true );
1565 }
1566
1567 /**
1568 * Add wikitext with tidy enabled
1569 *
1570 * @param string $text Wikitext
1571 * @param bool $linestart Is this the start of a line?
1572 */
1573 public function addWikiTextTidy( $text, $linestart = true ) {
1574 $title = $this->getTitle();
1575 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1576 }
1577
1578 /**
1579 * Add wikitext with a custom Title object
1580 *
1581 * @param string $text Wikitext
1582 * @param Title $title
1583 * @param bool $linestart Is this the start of a line?
1584 * @param bool $tidy Whether to use tidy
1585 * @param bool $interface Whether it is an interface message
1586 * (for example disables conversion)
1587 */
1588 public function addWikiTextTitle( $text, Title $title, $linestart,
1589 $tidy = false, $interface = false
1590 ) {
1591 global $wgParser;
1592
1593 wfProfileIn( __METHOD__ );
1594
1595 $popts = $this->parserOptions();
1596 $oldTidy = $popts->setTidy( $tidy );
1597 $popts->setInterfaceMessage( (bool)$interface );
1598
1599 $parserOutput = $wgParser->getFreshParser()->parse(
1600 $text, $title, $popts,
1601 $linestart, true, $this->mRevisionId
1602 );
1603
1604 $popts->setTidy( $oldTidy );
1605
1606 $this->addParserOutput( $parserOutput );
1607
1608 wfProfileOut( __METHOD__ );
1609 }
1610
1611 /**
1612 * Add a ParserOutput object, but without Html.
1613 *
1614 * @deprecated since 1.24, use addParserOutputMetadata() instead.
1615 * @param ParserOutput $parserOutput
1616 */
1617 public function addParserOutputNoText( &$parserOutput ) {
1618 $this->addParserOutputMetadata( $parserOutput );
1619 }
1620
1621 /**
1622 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1623 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1624 * and so on.
1625 *
1626 * @since 1.24
1627 * @param ParserOutput $parserOutput
1628 */
1629 public function addParserOutputMetadata( &$parserOutput ) {
1630 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1631 $this->addCategoryLinks( $parserOutput->getCategories() );
1632 $this->mNewSectionLink = $parserOutput->getNewSection();
1633 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1634
1635 $this->mParseWarnings = $parserOutput->getWarnings();
1636 if ( !$parserOutput->isCacheable() ) {
1637 $this->enableClientCache( false );
1638 }
1639 $this->mNoGallery = $parserOutput->getNoGallery();
1640 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1641 $this->addModules( $parserOutput->getModules() );
1642 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1643 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1644 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1645 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1646
1647 // Template versioning...
1648 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1649 if ( isset( $this->mTemplateIds[$ns] ) ) {
1650 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1651 } else {
1652 $this->mTemplateIds[$ns] = $dbks;
1653 }
1654 }
1655 // File versioning...
1656 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1657 $this->mImageTimeKeys[$dbk] = $data;
1658 }
1659
1660 // Hooks registered in the object
1661 global $wgParserOutputHooks;
1662 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1663 list( $hookName, $data ) = $hookInfo;
1664 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1665 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1666 }
1667 }
1668
1669 // Link flags are ignored for now, but may in the future be
1670 // used to mark individual language links.
1671 $linkFlags = array();
1672 wfRunHooks( 'LanguageLinks', array( $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ) );
1673 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1674 }
1675
1676 /**
1677 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1678 * ParserOutput object, without any other metadata.
1679 *
1680 * @since 1.24
1681 * @param ParserOutput $parserOutput
1682 */
1683 public function addParserOutputContent( &$parserOutput ) {
1684 $this->addParserOutputText( $parserOutput );
1685
1686 $this->addModules( $parserOutput->getModules() );
1687 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1688 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1689 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1690
1691 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1692 }
1693
1694 /**
1695 * Add the HTML associated with a ParserOutput object, without any metadata.
1696 *
1697 * @since 1.24
1698 * @param ParserOutput $parserOutput
1699 */
1700 public function addParserOutputText( &$parserOutput ) {
1701 $text = $parserOutput->getText();
1702 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1703 $this->addHTML( $text );
1704 }
1705
1706 /**
1707 * Add everything from a ParserOutput object.
1708 *
1709 * @param ParserOutput $parserOutput
1710 */
1711 function addParserOutput( &$parserOutput ) {
1712 $this->addParserOutputMetadata( $parserOutput );
1713 $parserOutput->setTOCEnabled( $this->mEnableTOC );
1714
1715 // Touch section edit links only if not previously disabled
1716 if ( $parserOutput->getEditSectionTokens() ) {
1717 $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks );
1718 }
1719
1720 $this->addParserOutputText( $parserOutput );
1721 }
1722
1723 /**
1724 * Add the output of a QuickTemplate to the output buffer
1725 *
1726 * @param QuickTemplate $template
1727 */
1728 public function addTemplate( &$template ) {
1729 $this->addHTML( $template->getHTML() );
1730 }
1731
1732 /**
1733 * Parse wikitext and return the HTML.
1734 *
1735 * @param string $text
1736 * @param bool $linestart Is this the start of a line?
1737 * @param bool $interface Use interface language ($wgLang instead of
1738 * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1739 * This also disables LanguageConverter.
1740 * @param Language $language Target language object, will override $interface
1741 * @throws MWException
1742 * @return string HTML
1743 */
1744 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1745 global $wgParser;
1746
1747 if ( is_null( $this->getTitle() ) ) {
1748 throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1749 }
1750
1751 $popts = $this->parserOptions();
1752 if ( $interface ) {
1753 $popts->setInterfaceMessage( true );
1754 }
1755 if ( $language !== null ) {
1756 $oldLang = $popts->setTargetLanguage( $language );
1757 }
1758
1759 $parserOutput = $wgParser->getFreshParser()->parse(
1760 $text, $this->getTitle(), $popts,
1761 $linestart, true, $this->mRevisionId
1762 );
1763
1764 if ( $interface ) {
1765 $popts->setInterfaceMessage( false );
1766 }
1767 if ( $language !== null ) {
1768 $popts->setTargetLanguage( $oldLang );
1769 }
1770
1771 return $parserOutput->getText();
1772 }
1773
1774 /**
1775 * Parse wikitext, strip paragraphs, and return the HTML.
1776 *
1777 * @param string $text
1778 * @param bool $linestart Is this the start of a line?
1779 * @param bool $interface Use interface language ($wgLang instead of
1780 * $wgContLang) while parsing language sensitive magic
1781 * words like GRAMMAR and PLURAL
1782 * @return string HTML
1783 */
1784 public function parseInline( $text, $linestart = true, $interface = false ) {
1785 $parsed = $this->parse( $text, $linestart, $interface );
1786 return Parser::stripOuterParagraph( $parsed );
1787 }
1788
1789 /**
1790 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1791 *
1792 * @param int $maxage Maximum cache time on the Squid, in seconds.
1793 */
1794 public function setSquidMaxage( $maxage ) {
1795 $this->mSquidMaxage = $maxage;
1796 }
1797
1798 /**
1799 * Use enableClientCache(false) to force it to send nocache headers
1800 *
1801 * @param bool $state
1802 *
1803 * @return bool
1804 */
1805 public function enableClientCache( $state ) {
1806 return wfSetVar( $this->mEnableClientCache, $state );
1807 }
1808
1809 /**
1810 * Get the list of cookies that will influence on the cache
1811 *
1812 * @return array
1813 */
1814 function getCacheVaryCookies() {
1815 global $wgCookiePrefix, $wgCacheVaryCookies;
1816 static $cookies;
1817 if ( $cookies === null ) {
1818 $cookies = array_merge(
1819 array(
1820 "{$wgCookiePrefix}Token",
1821 "{$wgCookiePrefix}LoggedOut",
1822 "forceHTTPS",
1823 session_name()
1824 ),
1825 $wgCacheVaryCookies
1826 );
1827 wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1828 }
1829 return $cookies;
1830 }
1831
1832 /**
1833 * Check if the request has a cache-varying cookie header
1834 * If it does, it's very important that we don't allow public caching
1835 *
1836 * @return bool
1837 */
1838 function haveCacheVaryCookies() {
1839 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1840 if ( $cookieHeader === false ) {
1841 return false;
1842 }
1843 $cvCookies = $this->getCacheVaryCookies();
1844 foreach ( $cvCookies as $cookieName ) {
1845 # Check for a simple string match, like the way squid does it
1846 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1847 wfDebug( __METHOD__ . ": found $cookieName\n" );
1848 return true;
1849 }
1850 }
1851 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1852 return false;
1853 }
1854
1855 /**
1856 * Add an HTTP header that will influence on the cache
1857 *
1858 * @param string $header header name
1859 * @param array|null $option
1860 * @todo FIXME: Document the $option parameter; it appears to be for
1861 * X-Vary-Options but what format is acceptable?
1862 */
1863 public function addVaryHeader( $header, $option = null ) {
1864 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1865 $this->mVaryHeader[$header] = (array)$option;
1866 } elseif ( is_array( $option ) ) {
1867 if ( is_array( $this->mVaryHeader[$header] ) ) {
1868 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1869 } else {
1870 $this->mVaryHeader[$header] = $option;
1871 }
1872 }
1873 $this->mVaryHeader[$header] = array_unique( (array)$this->mVaryHeader[$header] );
1874 }
1875
1876 /**
1877 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
1878 * such as Accept-Encoding or Cookie
1879 *
1880 * @return string
1881 */
1882 public function getVaryHeader() {
1883 return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) );
1884 }
1885
1886 /**
1887 * Get a complete X-Vary-Options header
1888 *
1889 * @return string
1890 */
1891 public function getXVO() {
1892 $cvCookies = $this->getCacheVaryCookies();
1893
1894 $cookiesOption = array();
1895 foreach ( $cvCookies as $cookieName ) {
1896 $cookiesOption[] = 'string-contains=' . $cookieName;
1897 }
1898 $this->addVaryHeader( 'Cookie', $cookiesOption );
1899
1900 $headers = array();
1901 foreach ( $this->mVaryHeader as $header => $option ) {
1902 $newheader = $header;
1903 if ( is_array( $option ) && count( $option ) > 0 ) {
1904 $newheader .= ';' . implode( ';', $option );
1905 }
1906 $headers[] = $newheader;
1907 }
1908 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1909
1910 return $xvo;
1911 }
1912
1913 /**
1914 * bug 21672: Add Accept-Language to Vary and XVO headers
1915 * if there's no 'variant' parameter existed in GET.
1916 *
1917 * For example:
1918 * /w/index.php?title=Main_page should always be served; but
1919 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
1920 */
1921 function addAcceptLanguage() {
1922 $title = $this->getTitle();
1923 if ( !$title instanceof Title ) {
1924 return;
1925 }
1926
1927 $lang = $title->getPageLanguage();
1928 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
1929 $variants = $lang->getVariants();
1930 $aloption = array();
1931 foreach ( $variants as $variant ) {
1932 if ( $variant === $lang->getCode() ) {
1933 continue;
1934 } else {
1935 $aloption[] = 'string-contains=' . $variant;
1936
1937 // IE and some other browsers use BCP 47 standards in
1938 // their Accept-Language header, like "zh-CN" or "zh-Hant".
1939 // We should handle these too.
1940 $variantBCP47 = wfBCP47( $variant );
1941 if ( $variantBCP47 !== $variant ) {
1942 $aloption[] = 'string-contains=' . $variantBCP47;
1943 }
1944 }
1945 }
1946 $this->addVaryHeader( 'Accept-Language', $aloption );
1947 }
1948 }
1949
1950 /**
1951 * Set a flag which will cause an X-Frame-Options header appropriate for
1952 * edit pages to be sent. The header value is controlled by
1953 * $wgEditPageFrameOptions.
1954 *
1955 * This is the default for special pages. If you display a CSRF-protected
1956 * form on an ordinary view page, then you need to call this function.
1957 *
1958 * @param bool $enable
1959 */
1960 public function preventClickjacking( $enable = true ) {
1961 $this->mPreventClickjacking = $enable;
1962 }
1963
1964 /**
1965 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1966 * This can be called from pages which do not contain any CSRF-protected
1967 * HTML form.
1968 */
1969 public function allowClickjacking() {
1970 $this->mPreventClickjacking = false;
1971 }
1972
1973 /**
1974 * Get the X-Frame-Options header value (without the name part), or false
1975 * if there isn't one. This is used by Skin to determine whether to enable
1976 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1977 *
1978 * @return string
1979 */
1980 public function getFrameOptions() {
1981 global $wgBreakFrames, $wgEditPageFrameOptions;
1982 if ( $wgBreakFrames ) {
1983 return 'DENY';
1984 } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
1985 return $wgEditPageFrameOptions;
1986 }
1987 return false;
1988 }
1989
1990 /**
1991 * Send cache control HTTP headers
1992 */
1993 public function sendCacheControl() {
1994 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
1995
1996 $response = $this->getRequest()->response();
1997 if ( $wgUseETag && $this->mETag ) {
1998 $response->header( "ETag: $this->mETag" );
1999 }
2000
2001 $this->addVaryHeader( 'Cookie' );
2002 $this->addAcceptLanguage();
2003
2004 # don't serve compressed data to clients who can't handle it
2005 # maintain different caches for logged-in users and non-logged in ones
2006 $response->header( $this->getVaryHeader() );
2007
2008 if ( $wgUseXVO ) {
2009 # Add an X-Vary-Options header for Squid with Wikimedia patches
2010 $response->header( $this->getXVO() );
2011 }
2012
2013 if ( $this->mEnableClientCache ) {
2014 if (
2015 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
2016 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
2017 ) {
2018 if ( $wgUseESI ) {
2019 # We'll purge the proxy cache explicitly, but require end user agents
2020 # to revalidate against the proxy on each visit.
2021 # Surrogate-Control controls our Squid, Cache-Control downstream caches
2022 wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", 'log' );
2023 # start with a shorter timeout for initial testing
2024 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2025 $response->header( 'Surrogate-Control: max-age=' . $wgSquidMaxage
2026 . '+' . $this->mSquidMaxage . ', content="ESI/1.0"' );
2027 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2028 } else {
2029 # We'll purge the proxy cache for anons explicitly, but require end user agents
2030 # to revalidate against the proxy on each visit.
2031 # IMPORTANT! The Squid needs to replace the Cache-Control header with
2032 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2033 wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", 'log' );
2034 # start with a shorter timeout for initial testing
2035 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2036 $response->header( 'Cache-Control: s-maxage=' . $this->mSquidMaxage
2037 . ', must-revalidate, max-age=0' );
2038 }
2039 } else {
2040 # We do want clients to cache if they can, but they *must* check for updates
2041 # on revisiting the page.
2042 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", 'log' );
2043 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2044 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2045 }
2046 if ( $this->mLastModified ) {
2047 $response->header( "Last-Modified: {$this->mLastModified}" );
2048 }
2049 } else {
2050 wfDebug( __METHOD__ . ": no caching **\n", 'log' );
2051
2052 # In general, the absence of a last modified header should be enough to prevent
2053 # the client from using its cache. We send a few other things just to make sure.
2054 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2055 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2056 $response->header( 'Pragma: no-cache' );
2057 }
2058 }
2059
2060 /**
2061 * Finally, all the text has been munged and accumulated into
2062 * the object, let's actually output it:
2063 */
2064 public function output() {
2065 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType, $wgVaryOnXFP,
2066 $wgResponsiveImages;
2067
2068 if ( $this->mDoNothing ) {
2069 return;
2070 }
2071
2072 wfProfileIn( __METHOD__ );
2073
2074 $response = $this->getRequest()->response();
2075
2076 if ( $this->mRedirect != '' ) {
2077 # Standards require redirect URLs to be absolute
2078 $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
2079
2080 $redirect = $this->mRedirect;
2081 $code = $this->mRedirectCode;
2082
2083 if ( wfRunHooks( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
2084 if ( $code == '301' || $code == '303' ) {
2085 if ( !$wgDebugRedirects ) {
2086 $message = HttpStatus::getMessage( $code );
2087 $response->header( "HTTP/1.1 $code $message" );
2088 }
2089 $this->mLastModified = wfTimestamp( TS_RFC2822 );
2090 }
2091 if ( $wgVaryOnXFP ) {
2092 $this->addVaryHeader( 'X-Forwarded-Proto' );
2093 }
2094 $this->sendCacheControl();
2095
2096 $response->header( "Content-Type: text/html; charset=utf-8" );
2097 if ( $wgDebugRedirects ) {
2098 $url = htmlspecialchars( $redirect );
2099 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2100 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2101 print "</body>\n</html>\n";
2102 } else {
2103 $response->header( 'Location: ' . $redirect );
2104 }
2105 }
2106
2107 wfProfileOut( __METHOD__ );
2108 return;
2109 } elseif ( $this->mStatusCode ) {
2110 $message = HttpStatus::getMessage( $this->mStatusCode );
2111 if ( $message ) {
2112 $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
2113 }
2114 }
2115
2116 # Buffer output; final headers may depend on later processing
2117 ob_start();
2118
2119 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
2120 $response->header( 'Content-language: ' . $wgLanguageCode );
2121
2122 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2123 // jQuery etc. can work correctly.
2124 $response->header( 'X-UA-Compatible: IE=Edge' );
2125
2126 // Prevent framing, if requested
2127 $frameOptions = $this->getFrameOptions();
2128 if ( $frameOptions ) {
2129 $response->header( "X-Frame-Options: $frameOptions" );
2130 }
2131
2132 if ( $this->mArticleBodyOnly ) {
2133 echo $this->mBodytext;
2134 } else {
2135
2136 $sk = $this->getSkin();
2137 // add skin specific modules
2138 $modules = $sk->getDefaultModules();
2139
2140 // enforce various default modules for all skins
2141 $coreModules = array(
2142 // keep this list as small as possible
2143 'mediawiki.page.startup',
2144 'mediawiki.user',
2145 );
2146
2147 // Support for high-density display images if enabled
2148 if ( $wgResponsiveImages ) {
2149 $coreModules[] = 'mediawiki.hidpi';
2150 }
2151
2152 $this->addModules( $coreModules );
2153 foreach ( $modules as $group ) {
2154 $this->addModules( $group );
2155 }
2156 MWDebug::addModules( $this );
2157
2158 // Hook that allows last minute changes to the output page, e.g.
2159 // adding of CSS or Javascript by extensions.
2160 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
2161
2162 wfProfileIn( 'Output-skin' );
2163 $sk->outputPage();
2164 wfProfileOut( 'Output-skin' );
2165 }
2166
2167 // This hook allows last minute changes to final overall output by modifying output buffer
2168 wfRunHooks( 'AfterFinalPageOutput', array( $this ) );
2169
2170 $this->sendCacheControl();
2171
2172 ob_end_flush();
2173
2174 wfProfileOut( __METHOD__ );
2175 }
2176
2177 /**
2178 * Actually output something with print.
2179 *
2180 * @param string $ins the string to output
2181 * @deprecated since 1.22 Use echo yourself.
2182 */
2183 public function out( $ins ) {
2184 wfDeprecated( __METHOD__, '1.22' );
2185 print $ins;
2186 }
2187
2188 /**
2189 * Produce a "user is blocked" page.
2190 * @deprecated since 1.18
2191 */
2192 function blockedPage() {
2193 throw new UserBlockedError( $this->getUser()->mBlock );
2194 }
2195
2196 /**
2197 * Prepare this object to display an error page; disable caching and
2198 * indexing, clear the current text and redirect, set the page's title
2199 * and optionally an custom HTML title (content of the "<title>" tag).
2200 *
2201 * @param string|Message $pageTitle will be passed directly to setPageTitle()
2202 * @param string|Message $htmlTitle will be passed directly to setHTMLTitle();
2203 * optional, if not passed the "<title>" attribute will be
2204 * based on $pageTitle
2205 */
2206 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2207 $this->setPageTitle( $pageTitle );
2208 if ( $htmlTitle !== false ) {
2209 $this->setHTMLTitle( $htmlTitle );
2210 }
2211 $this->setRobotPolicy( 'noindex,nofollow' );
2212 $this->setArticleRelated( false );
2213 $this->enableClientCache( false );
2214 $this->mRedirect = '';
2215 $this->clearSubtitle();
2216 $this->clearHTML();
2217 }
2218
2219 /**
2220 * Output a standard error page
2221 *
2222 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2223 * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2224 * showErrorPage( 'titlemsg', $messageObject );
2225 * showErrorPage( $titleMessageObject, $messageObject );
2226 *
2227 * @param string|Message $title Message key (string) for page title, or a Message object
2228 * @param string|Message $msg Message key (string) for page text, or a Message object
2229 * @param array $params Message parameters; ignored if $msg is a Message object
2230 */
2231 public function showErrorPage( $title, $msg, $params = array() ) {
2232 if ( !$title instanceof Message ) {
2233 $title = $this->msg( $title );
2234 }
2235
2236 $this->prepareErrorPage( $title );
2237
2238 if ( $msg instanceof Message ) {
2239 if ( $params !== array() ) {
2240 trigger_error( 'Argument ignored: $params. The message parameters argument '
2241 . 'is discarded when the $msg argument is a Message object instead of '
2242 . 'a string.', E_USER_NOTICE );
2243 }
2244 $this->addHTML( $msg->parseAsBlock() );
2245 } else {
2246 $this->addWikiMsgArray( $msg, $params );
2247 }
2248
2249 $this->returnToMain();
2250 }
2251
2252 /**
2253 * Output a standard permission error page
2254 *
2255 * @param array $errors error message keys
2256 * @param string $action action that was denied or null if unknown
2257 */
2258 public function showPermissionsErrorPage( $errors, $action = null ) {
2259 // For some action (read, edit, create and upload), display a "login to do this action"
2260 // error if all of the following conditions are met:
2261 // 1. the user is not logged in
2262 // 2. the only error is insufficient permissions (i.e. no block or something else)
2263 // 3. the error can be avoided simply by logging in
2264 if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
2265 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2266 && ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
2267 && ( User::groupHasPermission( 'user', $action )
2268 || User::groupHasPermission( 'autoconfirmed', $action ) )
2269 ) {
2270 $displayReturnto = null;
2271
2272 # Due to bug 32276, if a user does not have read permissions,
2273 # $this->getTitle() will just give Special:Badtitle, which is
2274 # not especially useful as a returnto parameter. Use the title
2275 # from the request instead, if there was one.
2276 $request = $this->getRequest();
2277 $returnto = Title::newFromURL( $request->getVal( 'title', '' ) );
2278 if ( $action == 'edit' ) {
2279 $msg = 'whitelistedittext';
2280 $displayReturnto = $returnto;
2281 } elseif ( $action == 'createpage' || $action == 'createtalk' ) {
2282 $msg = 'nocreatetext';
2283 } elseif ( $action == 'upload' ) {
2284 $msg = 'uploadnologintext';
2285 } else { # Read
2286 $msg = 'loginreqpagetext';
2287 $displayReturnto = Title::newMainPage();
2288 }
2289
2290 $query = array();
2291
2292 if ( $returnto ) {
2293 $query['returnto'] = $returnto->getPrefixedText();
2294
2295 if ( !$request->wasPosted() ) {
2296 $returntoquery = $request->getValues();
2297 unset( $returntoquery['title'] );
2298 unset( $returntoquery['returnto'] );
2299 unset( $returntoquery['returntoquery'] );
2300 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2301 }
2302 }
2303 $loginLink = Linker::linkKnown(
2304 SpecialPage::getTitleFor( 'Userlogin' ),
2305 $this->msg( 'loginreqlink' )->escaped(),
2306 array(),
2307 $query
2308 );
2309
2310 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2311 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2312
2313 # Don't return to a page the user can't read otherwise
2314 # we'll end up in a pointless loop
2315 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2316 $this->returnToMain( null, $displayReturnto );
2317 }
2318 } else {
2319 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2320 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2321 }
2322 }
2323
2324 /**
2325 * Display an error page indicating that a given version of MediaWiki is
2326 * required to use it
2327 *
2328 * @param mixed $version The version of MediaWiki needed to use the page
2329 */
2330 public function versionRequired( $version ) {
2331 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2332
2333 $this->addWikiMsg( 'versionrequiredtext', $version );
2334 $this->returnToMain();
2335 }
2336
2337 /**
2338 * Display an error page noting that a given permission bit is required.
2339 * @deprecated since 1.18, just throw the exception directly
2340 * @param string $permission key required
2341 * @throws PermissionsError
2342 */
2343 public function permissionRequired( $permission ) {
2344 throw new PermissionsError( $permission );
2345 }
2346
2347 /**
2348 * Produce the stock "please login to use the wiki" page
2349 *
2350 * @deprecated since 1.19; throw the exception directly
2351 */
2352 public function loginToUse() {
2353 throw new PermissionsError( 'read' );
2354 }
2355
2356 /**
2357 * Format a list of error messages
2358 *
2359 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2360 * @param string $action Action that was denied or null if unknown
2361 * @return string The wikitext error-messages, formatted into a list.
2362 */
2363 public function formatPermissionsErrorMessage( $errors, $action = null ) {
2364 if ( $action == null ) {
2365 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2366 } else {
2367 $action_desc = $this->msg( "action-$action" )->plain();
2368 $text = $this->msg(
2369 'permissionserrorstext-withaction',
2370 count( $errors ),
2371 $action_desc
2372 )->plain() . "\n\n";
2373 }
2374
2375 if ( count( $errors ) > 1 ) {
2376 $text .= '<ul class="permissions-errors">' . "\n";
2377
2378 foreach ( $errors as $error ) {
2379 $text .= '<li>';
2380 $text .= call_user_func_array( array( $this, 'msg' ), $error )->plain();
2381 $text .= "</li>\n";
2382 }
2383 $text .= '</ul>';
2384 } else {
2385 $text .= "<div class=\"permissions-errors\">\n" .
2386 call_user_func_array( array( $this, 'msg' ), reset( $errors ) )->plain() .
2387 "\n</div>";
2388 }
2389
2390 return $text;
2391 }
2392
2393 /**
2394 * Display a page stating that the Wiki is in read-only mode,
2395 * and optionally show the source of the page that the user
2396 * was trying to edit. Should only be called (for this
2397 * purpose) after wfReadOnly() has returned true.
2398 *
2399 * For historical reasons, this function is _also_ used to
2400 * show the error message when a user tries to edit a page
2401 * they are not allowed to edit. (Unless it's because they're
2402 * blocked, then we show blockedPage() instead.) In this
2403 * case, the second parameter should be set to true and a list
2404 * of reasons supplied as the third parameter.
2405 *
2406 * @todo Needs to be split into multiple functions.
2407 *
2408 * @param string $source Source code to show (or null).
2409 * @param bool $protected Is this a permissions error?
2410 * @param array $reasons List of reasons for this error, as returned by
2411 * Title::getUserPermissionsErrors().
2412 * @param string $action Action that was denied or null if unknown
2413 * @throws ReadOnlyError
2414 */
2415 public function readOnlyPage( $source = null, $protected = false,
2416 $reasons = array(), $action = null
2417 ) {
2418 $this->setRobotPolicy( 'noindex,nofollow' );
2419 $this->setArticleRelated( false );
2420
2421 // If no reason is given, just supply a default "I can't let you do
2422 // that, Dave" message. Should only occur if called by legacy code.
2423 if ( $protected && empty( $reasons ) ) {
2424 $reasons[] = array( 'badaccess-group0' );
2425 }
2426
2427 if ( !empty( $reasons ) ) {
2428 // Permissions error
2429 if ( $source ) {
2430 $this->setPageTitle( $this->msg( 'viewsource-title', $this->getTitle()->getPrefixedText() ) );
2431 $this->addBacklinkSubtitle( $this->getTitle() );
2432 } else {
2433 $this->setPageTitle( $this->msg( 'badaccess' ) );
2434 }
2435 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2436 } else {
2437 // Wiki is read only
2438 throw new ReadOnlyError;
2439 }
2440
2441 // Show source, if supplied
2442 if ( is_string( $source ) ) {
2443 $this->addWikiMsg( 'viewsourcetext' );
2444
2445 $pageLang = $this->getTitle()->getPageLanguage();
2446 $params = array(
2447 'id' => 'wpTextbox1',
2448 'name' => 'wpTextbox1',
2449 'cols' => $this->getUser()->getOption( 'cols' ),
2450 'rows' => $this->getUser()->getOption( 'rows' ),
2451 'readonly' => 'readonly',
2452 'lang' => $pageLang->getHtmlCode(),
2453 'dir' => $pageLang->getDir(),
2454 );
2455 $this->addHTML( Html::element( 'textarea', $params, $source ) );
2456
2457 // Show templates used by this article
2458 $templates = Linker::formatTemplates( $this->getTitle()->getTemplateLinksFrom() );
2459 $this->addHTML( "<div class='templatesUsed'>
2460 $templates
2461 </div>
2462 " );
2463 }
2464
2465 # If the title doesn't exist, it's fairly pointless to print a return
2466 # link to it. After all, you just tried editing it and couldn't, so
2467 # what's there to do there?
2468 if ( $this->getTitle()->exists() ) {
2469 $this->returnToMain( null, $this->getTitle() );
2470 }
2471 }
2472
2473 /**
2474 * Turn off regular page output and return an error response
2475 * for when rate limiting has triggered.
2476 */
2477 public function rateLimited() {
2478 throw new ThrottledError;
2479 }
2480
2481 /**
2482 * Show a warning about slave lag
2483 *
2484 * If the lag is higher than $wgSlaveLagCritical seconds,
2485 * then the warning is a bit more obvious. If the lag is
2486 * lower than $wgSlaveLagWarning, then no warning is shown.
2487 *
2488 * @param int $lag Slave lag
2489 */
2490 public function showLagWarning( $lag ) {
2491 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2492 if ( $lag >= $wgSlaveLagWarning ) {
2493 $message = $lag < $wgSlaveLagCritical
2494 ? 'lag-warn-normal'
2495 : 'lag-warn-high';
2496 $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2497 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
2498 }
2499 }
2500
2501 public function showFatalError( $message ) {
2502 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2503
2504 $this->addHTML( $message );
2505 }
2506
2507 public function showUnexpectedValueError( $name, $val ) {
2508 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2509 }
2510
2511 public function showFileCopyError( $old, $new ) {
2512 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2513 }
2514
2515 public function showFileRenameError( $old, $new ) {
2516 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2517 }
2518
2519 public function showFileDeleteError( $name ) {
2520 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2521 }
2522
2523 public function showFileNotFoundError( $name ) {
2524 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2525 }
2526
2527 /**
2528 * Add a "return to" link pointing to a specified title
2529 *
2530 * @param Title $title Title to link
2531 * @param array $query Query string parameters
2532 * @param string $text Text of the link (input is not escaped)
2533 * @param array $options Options array to pass to Linker
2534 */
2535 public function addReturnTo( $title, $query = array(), $text = null, $options = array() ) {
2536 $link = $this->msg( 'returnto' )->rawParams(
2537 Linker::link( $title, $text, array(), $query, $options ) )->escaped();
2538 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2539 }
2540
2541 /**
2542 * Add a "return to" link pointing to a specified title,
2543 * or the title indicated in the request, or else the main page
2544 *
2545 * @param mixed $unused
2546 * @param Title|string $returnto Title or String to return to
2547 * @param string $returntoquery Query string for the return to link
2548 */
2549 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2550 if ( $returnto == null ) {
2551 $returnto = $this->getRequest()->getText( 'returnto' );
2552 }
2553
2554 if ( $returntoquery == null ) {
2555 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2556 }
2557
2558 if ( $returnto === '' ) {
2559 $returnto = Title::newMainPage();
2560 }
2561
2562 if ( is_object( $returnto ) ) {
2563 $titleObj = $returnto;
2564 } else {
2565 $titleObj = Title::newFromText( $returnto );
2566 }
2567 if ( !is_object( $titleObj ) ) {
2568 $titleObj = Title::newMainPage();
2569 }
2570
2571 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2572 }
2573
2574 /**
2575 * @param Skin $sk The given Skin
2576 * @param bool $includeStyle Unused
2577 * @return string The doctype, opening "<html>", and head element.
2578 */
2579 public function headElement( Skin $sk, $includeStyle = true ) {
2580 global $wgContLang, $wgMimeType;
2581
2582 $userdir = $this->getLanguage()->getDir();
2583 $sitedir = $wgContLang->getDir();
2584
2585 $ret = Html::htmlHeader( $sk->getHtmlElementAttributes() );
2586
2587 if ( $this->getHTMLTitle() == '' ) {
2588 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2589 }
2590
2591 $openHead = Html::openElement( 'head' );
2592 if ( $openHead ) {
2593 # Don't bother with the newline if $head == ''
2594 $ret .= "$openHead\n";
2595 }
2596
2597 if ( !Html::isXmlMimeType( $wgMimeType ) ) {
2598 // Add <meta charset="UTF-8">
2599 // This should be before <title> since it defines the charset used by
2600 // text including the text inside <title>.
2601 // The spec recommends defining XHTML5's charset using the XML declaration
2602 // instead of meta.
2603 // Our XML declaration is output by Html::htmlHeader.
2604 // http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
2605 // http://www.whatwg.org/html/semantics.html#charset
2606 $ret .= Html::element( 'meta', array( 'charset' => 'UTF-8' ) ) . "\n";
2607 }
2608
2609 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2610
2611 foreach ( $this->getHeadLinksArray() as $item ) {
2612 $ret .= $item . "\n";
2613 }
2614
2615 // No newline after buildCssLinks since makeResourceLoaderLink did that already
2616 $ret .= $this->buildCssLinks();
2617
2618 $ret .= $this->getHeadScripts() . "\n";
2619
2620 foreach ( $this->mHeadItems as $item ) {
2621 $ret .= $item . "\n";
2622 }
2623
2624 $closeHead = Html::closeElement( 'head' );
2625 if ( $closeHead ) {
2626 $ret .= "$closeHead\n";
2627 }
2628
2629 $bodyClasses = array();
2630 $bodyClasses[] = 'mediawiki';
2631
2632 # Classes for LTR/RTL directionality support
2633 $bodyClasses[] = $userdir;
2634 $bodyClasses[] = "sitedir-$sitedir";
2635
2636 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2637 # A <body> class is probably not the best way to do this . . .
2638 $bodyClasses[] = 'capitalize-all-nouns';
2639 }
2640
2641 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2642 $bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2643 $bodyClasses[] =
2644 'action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
2645
2646 $bodyAttrs = array();
2647 // While the implode() is not strictly needed, it's used for backwards compatibility
2648 // (this used to be built as a string and hooks likely still expect that).
2649 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2650
2651 // Allow skins and extensions to add body attributes they need
2652 $sk->addToBodyAttributes( $this, $bodyAttrs );
2653 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2654
2655 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2656
2657 return $ret;
2658 }
2659
2660 /**
2661 * Get a ResourceLoader object associated with this OutputPage
2662 *
2663 * @return ResourceLoader
2664 */
2665 public function getResourceLoader() {
2666 if ( is_null( $this->mResourceLoader ) ) {
2667 $this->mResourceLoader = new ResourceLoader();
2668 }
2669 return $this->mResourceLoader;
2670 }
2671
2672 /**
2673 * @todo Document
2674 * @param array|string $modules One or more module names
2675 * @param string $only ResourceLoaderModule TYPE_ class constant
2676 * @param bool $useESI
2677 * @param array $extraQuery Array with extra query parameters to add to each
2678 * request. array( param => value ).
2679 * @param bool $loadCall If true, output an (asynchronous) mw.loader.load()
2680 * call rather than a "<script src='...'>" tag.
2681 * @return string The html "<script>", "<link>" and "<style>" tags
2682 */
2683 protected function makeResourceLoaderLink( $modules, $only, $useESI = false,
2684 array $extraQuery = array(), $loadCall = false
2685 ) {
2686 global $wgResourceLoaderUseESI;
2687
2688 $modules = (array)$modules;
2689
2690 $links = array(
2691 'html' => '',
2692 'states' => array(),
2693 );
2694
2695 if ( !count( $modules ) ) {
2696 return $links;
2697 }
2698
2699 if ( count( $modules ) > 1 ) {
2700 // Remove duplicate module requests
2701 $modules = array_unique( $modules );
2702 // Sort module names so requests are more uniform
2703 sort( $modules );
2704
2705 if ( ResourceLoader::inDebugMode() ) {
2706 // Recursively call us for every item
2707 foreach ( $modules as $name ) {
2708 $link = $this->makeResourceLoaderLink( $name, $only, $useESI );
2709 $links['html'] .= $link['html'];
2710 $links['states'] += $link['states'];
2711 }
2712 return $links;
2713 }
2714 }
2715
2716 if ( !is_null( $this->mTarget ) ) {
2717 $extraQuery['target'] = $this->mTarget;
2718 }
2719
2720 // Create keyed-by-source and then keyed-by-group list of module objects from modules list
2721 $sortedModules = array();
2722 $resourceLoader = $this->getResourceLoader();
2723 foreach ( $modules as $name ) {
2724 $module = $resourceLoader->getModule( $name );
2725 # Check that we're allowed to include this module on this page
2726 if ( !$module
2727 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS )
2728 && $only == ResourceLoaderModule::TYPE_SCRIPTS )
2729 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES )
2730 && $only == ResourceLoaderModule::TYPE_STYLES )
2731 || ( $this->mTarget && !in_array( $this->mTarget, $module->getTargets() ) )
2732 ) {
2733 continue;
2734 }
2735
2736 $sortedModules[$module->getSource()][$module->getGroup()][$name] = $module;
2737 }
2738
2739 foreach ( $sortedModules as $source => $groups ) {
2740 foreach ( $groups as $group => $grpModules ) {
2741 // Special handling for user-specific groups
2742 $user = null;
2743 if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2744 $user = $this->getUser()->getName();
2745 }
2746
2747 // Create a fake request based on the one we are about to make so modules return
2748 // correct timestamp and emptiness data
2749 $query = ResourceLoader::makeLoaderQuery(
2750 array(), // modules; not determined yet
2751 $this->getLanguage()->getCode(),
2752 $this->getSkin()->getSkinName(),
2753 $user,
2754 null, // version; not determined yet
2755 ResourceLoader::inDebugMode(),
2756 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2757 $this->isPrintable(),
2758 $this->getRequest()->getBool( 'handheld' ),
2759 $extraQuery
2760 );
2761 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2762
2763 // Extract modules that know they're empty
2764 foreach ( $grpModules as $key => $module ) {
2765 // Inline empty modules: since they're empty, just mark them as 'ready' (bug 46857)
2766 // If we're only getting the styles, we don't need to do anything for empty modules.
2767 if ( $module->isKnownEmpty( $context ) ) {
2768 unset( $grpModules[$key] );
2769 if ( $only !== ResourceLoaderModule::TYPE_STYLES ) {
2770 $links['states'][$key] = 'ready';
2771 }
2772 }
2773 }
2774
2775 // If there are no non-empty modules, skip this group
2776 if ( count( $grpModules ) === 0 ) {
2777 continue;
2778 }
2779
2780 // Inline private modules. These can't be loaded through load.php for security
2781 // reasons, see bug 34907. Note that these modules should be loaded from
2782 // getHeadScripts() before the first loader call. Otherwise other modules can't
2783 // properly use them as dependencies (bug 30914)
2784 if ( $group === 'private' ) {
2785 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2786 $links['html'] .= Html::inlineStyle(
2787 $resourceLoader->makeModuleResponse( $context, $grpModules )
2788 );
2789 } else {
2790 $links['html'] .= Html::inlineScript(
2791 ResourceLoader::makeLoaderConditionalScript(
2792 $resourceLoader->makeModuleResponse( $context, $grpModules )
2793 )
2794 );
2795 }
2796 $links['html'] .= "\n";
2797 continue;
2798 }
2799
2800 // Special handling for the user group; because users might change their stuff
2801 // on-wiki like user pages, or user preferences; we need to find the highest
2802 // timestamp of these user-changeable modules so we can ensure cache misses on change
2803 // This should NOT be done for the site group (bug 27564) because anons get that too
2804 // and we shouldn't be putting timestamps in Squid-cached HTML
2805 $version = null;
2806 if ( $group === 'user' ) {
2807 // Get the maximum timestamp
2808 $timestamp = 1;
2809 foreach ( $grpModules as $module ) {
2810 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2811 }
2812 // Add a version parameter so cache will break when things change
2813 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2814 }
2815
2816 $query['modules'] = ResourceLoader::makePackedModulesString( array_keys( $grpModules ) );
2817 $moduleContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2818 $url = $resourceLoader->createLoaderURL( $source, $moduleContext, $extraQuery );
2819
2820 if ( $useESI && $wgResourceLoaderUseESI ) {
2821 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2822 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2823 $link = Html::inlineStyle( $esi );
2824 } else {
2825 $link = Html::inlineScript( $esi );
2826 }
2827 } else {
2828 // Automatically select style/script elements
2829 if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
2830 $link = Html::linkedStyle( $url );
2831 } elseif ( $loadCall ) {
2832 $link = Html::inlineScript(
2833 ResourceLoader::makeLoaderConditionalScript(
2834 Xml::encodeJsCall( 'mw.loader.load', array( $url, 'text/javascript', true ) )
2835 )
2836 );
2837 } else {
2838 $link = Html::linkedScript( $url );
2839
2840 // For modules requested directly in the html via <link> or <script>,
2841 // tell mw.loader they are being loading to prevent duplicate requests.
2842 foreach ( $grpModules as $key => $module ) {
2843 // Don't output state=loading for the startup module..
2844 if ( $key !== 'startup' ) {
2845 $links['states'][$key] = 'loading';
2846 }
2847 }
2848 }
2849 }
2850
2851 if ( $group == 'noscript' ) {
2852 $links['html'] .= Html::rawElement( 'noscript', array(), $link ) . "\n";
2853 } else {
2854 $links['html'] .= $link . "\n";
2855 }
2856 }
2857 }
2858
2859 return $links;
2860 }
2861
2862 /**
2863 * Build html output from an array of links from makeResourceLoaderLink.
2864 * @param array $links
2865 * @return string HTML
2866 */
2867 protected static function getHtmlFromLoaderLinks( Array $links ) {
2868 $html = '';
2869 $states = array();
2870 foreach ( $links as $link ) {
2871 if ( !is_array( $link ) ) {
2872 $html .= $link;
2873 } else {
2874 $html .= $link['html'];
2875 $states += $link['states'];
2876 }
2877 }
2878
2879 if ( count( $states ) ) {
2880 $html = Html::inlineScript(
2881 ResourceLoader::makeLoaderConditionalScript(
2882 ResourceLoader::makeLoaderStateScript( $states )
2883 )
2884 ) . "\n" . $html;
2885 }
2886
2887 return $html;
2888 }
2889
2890 /**
2891 * JS stuff to put in the "<head>". This is the startup module, config
2892 * vars and modules marked with position 'top'
2893 *
2894 * @return string HTML fragment
2895 */
2896 function getHeadScripts() {
2897 global $wgResourceLoaderExperimentalAsyncLoading;
2898
2899 // Startup - this will immediately load jquery and mediawiki modules
2900 $links = array();
2901 $links[] = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, /* $useESI = */ true );
2902
2903 // Load config before anything else
2904 $links[] = Html::inlineScript(
2905 ResourceLoader::makeLoaderConditionalScript(
2906 ResourceLoader::makeConfigSetScript( $this->getJSVars() )
2907 )
2908 );
2909
2910 // Load embeddable private modules before any loader links
2911 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2912 // in mw.loader.implement() calls and deferred until mw.user is available
2913 $embedScripts = array( 'user.options', 'user.tokens' );
2914 $links[] = $this->makeResourceLoaderLink( $embedScripts, ResourceLoaderModule::TYPE_COMBINED );
2915
2916 // Scripts and messages "only" requests marked for top inclusion
2917 // Messages should go first
2918 $links[] = $this->makeResourceLoaderLink(
2919 $this->getModuleMessages( true, 'top' ),
2920 ResourceLoaderModule::TYPE_MESSAGES
2921 );
2922 $links[] = $this->makeResourceLoaderLink(
2923 $this->getModuleScripts( true, 'top' ),
2924 ResourceLoaderModule::TYPE_SCRIPTS
2925 );
2926
2927 // Modules requests - let the client calculate dependencies and batch requests as it likes
2928 // Only load modules that have marked themselves for loading at the top
2929 $modules = $this->getModules( true, 'top' );
2930 if ( $modules ) {
2931 $links[] = Html::inlineScript(
2932 ResourceLoader::makeLoaderConditionalScript(
2933 Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2934 )
2935 );
2936 }
2937
2938 if ( $wgResourceLoaderExperimentalAsyncLoading ) {
2939 $links[] = $this->getScriptsForBottomQueue( true );
2940 }
2941
2942 return self::getHtmlFromLoaderLinks( $links );
2943 }
2944
2945 /**
2946 * JS stuff to put at the 'bottom', which can either be the bottom of the
2947 * "<body>" or the bottom of the "<head>" depending on
2948 * $wgResourceLoaderExperimentalAsyncLoading: modules marked with position
2949 * 'bottom', legacy scripts ($this->mScripts), user preferences, site JS
2950 * and user JS.
2951 *
2952 * @param bool $inHead If true, this HTML goes into the "<head>",
2953 * if false it goes into the "<body>".
2954 * @return string
2955 */
2956 function getScriptsForBottomQueue( $inHead ) {
2957 global $wgAllowUserJs;
2958
2959 // Scripts and messages "only" requests marked for bottom inclusion
2960 // If we're in the <head>, use load() calls rather than <script src="..."> tags
2961 // Messages should go first
2962 $links = array();
2963 $links[] = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ),
2964 ResourceLoaderModule::TYPE_MESSAGES, /* $useESI = */ false, /* $extraQuery = */ array(),
2965 /* $loadCall = */ $inHead
2966 );
2967 $links[] = $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
2968 ResourceLoaderModule::TYPE_SCRIPTS, /* $useESI = */ false, /* $extraQuery = */ array(),
2969 /* $loadCall = */ $inHead
2970 );
2971
2972 // Modules requests - let the client calculate dependencies and batch requests as it likes
2973 // Only load modules that have marked themselves for loading at the bottom
2974 $modules = $this->getModules( true, 'bottom' );
2975 if ( $modules ) {
2976 $links[] = Html::inlineScript(
2977 ResourceLoader::makeLoaderConditionalScript(
2978 Xml::encodeJsCall( 'mw.loader.load', array( $modules, null, true ) )
2979 )
2980 );
2981 }
2982
2983 // Legacy Scripts
2984 $links[] = "\n" . $this->mScripts;
2985
2986 // Add site JS if enabled
2987 $links[] = $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS,
2988 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
2989 );
2990
2991 // Add user JS if enabled
2992 if ( $wgAllowUserJs
2993 && $this->getUser()->isLoggedIn()
2994 && $this->getTitle()
2995 && $this->getTitle()->isJsSubpage()
2996 && $this->userCanPreview()
2997 ) {
2998 # XXX: additional security check/prompt?
2999 // We're on a preview of a JS subpage
3000 // Exclude this page from the user module in case it's in there (bug 26283)
3001 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
3002 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() ), $inHead
3003 );
3004 // Load the previewed JS
3005 $links[] = Html::inlineScript( "\n"
3006 . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
3007
3008 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3009 // asynchronously and may arrive *after* the inline script here. So the previewed code
3010 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js...
3011 } else {
3012 // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
3013 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS,
3014 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3015 );
3016 }
3017
3018 // Group JS is only enabled if site JS is enabled.
3019 $links[] = $this->makeResourceLoaderLink( 'user.groups', ResourceLoaderModule::TYPE_COMBINED,
3020 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3021 );
3022
3023 $modules = array();
3024 wfRunHooks( 'OutputPageScriptsForBottomQueue', array( $this, &$modules ) );
3025 if ( $modules ) {
3026 $links[] = $this->makeResourceLoaderLink( $modules, ResourceLoaderModule::TYPE_COMBINED,
3027 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3028 );
3029 }
3030
3031 return self::getHtmlFromLoaderLinks( $links );
3032 }
3033
3034 /**
3035 * JS stuff to put at the bottom of the "<body>"
3036 * @return string
3037 */
3038 function getBottomScripts() {
3039 global $wgResourceLoaderExperimentalAsyncLoading;
3040
3041 // Optimise jQuery ready event cross-browser.
3042 // This also enforces $.isReady to be true at </body> which fixes the
3043 // mw.loader bug in Firefox with using document.write between </body>
3044 // and the DOMContentReady event (bug 47457).
3045 $html = Html::inlineScript( 'window.jQuery && jQuery.ready();' );
3046
3047 if ( !$wgResourceLoaderExperimentalAsyncLoading ) {
3048 $html .= $this->getScriptsForBottomQueue( false );
3049 }
3050
3051 return $html;
3052 }
3053
3054 /**
3055 * Get the javascript config vars to include on this page
3056 *
3057 * @return array Array of javascript config vars
3058 * @since 1.23
3059 */
3060 public function getJsConfigVars() {
3061 return $this->mJsConfigVars;
3062 }
3063
3064 /**
3065 * Add one or more variables to be set in mw.config in JavaScript
3066 *
3067 * @param string|array $keys Key or array of key/value pairs
3068 * @param mixed $value [optional] Value of the configuration variable
3069 */
3070 public function addJsConfigVars( $keys, $value = null ) {
3071 if ( is_array( $keys ) ) {
3072 foreach ( $keys as $key => $value ) {
3073 $this->mJsConfigVars[$key] = $value;
3074 }
3075 return;
3076 }
3077
3078 $this->mJsConfigVars[$keys] = $value;
3079 }
3080
3081 /**
3082 * Get an array containing the variables to be set in mw.config in JavaScript.
3083 *
3084 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3085 * - in other words, page-independent/site-wide variables (without state).
3086 * You will only be adding bloat to the html page and causing page caches to
3087 * have to be purged on configuration changes.
3088 * @return array
3089 */
3090 private function getJSVars() {
3091 global $wgContLang;
3092
3093 $curRevisionId = 0;
3094 $articleId = 0;
3095 $canonicalSpecialPageName = false; # bug 21115
3096
3097 $title = $this->getTitle();
3098 $ns = $title->getNamespace();
3099 $canonicalNamespace = MWNamespace::exists( $ns )
3100 ? MWNamespace::getCanonicalName( $ns )
3101 : $title->getNsText();
3102
3103 $sk = $this->getSkin();
3104 // Get the relevant title so that AJAX features can use the correct page name
3105 // when making API requests from certain special pages (bug 34972).
3106 $relevantTitle = $sk->getRelevantTitle();
3107 $relevantUser = $sk->getRelevantUser();
3108
3109 if ( $ns == NS_SPECIAL ) {
3110 list( $canonicalSpecialPageName, /*...*/ ) =
3111 SpecialPageFactory::resolveAlias( $title->getDBkey() );
3112 } elseif ( $this->canUseWikiPage() ) {
3113 $wikiPage = $this->getWikiPage();
3114 $curRevisionId = $wikiPage->getLatest();
3115 $articleId = $wikiPage->getId();
3116 }
3117
3118 $lang = $title->getPageLanguage();
3119
3120 // Pre-process information
3121 $separatorTransTable = $lang->separatorTransformTable();
3122 $separatorTransTable = $separatorTransTable ? $separatorTransTable : array();
3123 $compactSeparatorTransTable = array(
3124 implode( "\t", array_keys( $separatorTransTable ) ),
3125 implode( "\t", $separatorTransTable ),
3126 );
3127 $digitTransTable = $lang->digitTransformTable();
3128 $digitTransTable = $digitTransTable ? $digitTransTable : array();
3129 $compactDigitTransTable = array(
3130 implode( "\t", array_keys( $digitTransTable ) ),
3131 implode( "\t", $digitTransTable ),
3132 );
3133
3134 $user = $this->getUser();
3135
3136 $vars = array(
3137 'wgCanonicalNamespace' => $canonicalNamespace,
3138 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3139 'wgNamespaceNumber' => $title->getNamespace(),
3140 'wgPageName' => $title->getPrefixedDBkey(),
3141 'wgTitle' => $title->getText(),
3142 'wgCurRevisionId' => $curRevisionId,
3143 'wgRevisionId' => (int)$this->getRevisionId(),
3144 'wgArticleId' => $articleId,
3145 'wgIsArticle' => $this->isArticle(),
3146 'wgIsRedirect' => $title->isRedirect(),
3147 'wgAction' => Action::getActionName( $this->getContext() ),
3148 'wgUserName' => $user->isAnon() ? null : $user->getName(),
3149 'wgUserGroups' => $user->getEffectiveGroups(),
3150 'wgCategories' => $this->getCategories(),
3151 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3152 'wgPageContentLanguage' => $lang->getCode(),
3153 'wgPageContentModel' => $title->getContentModel(),
3154 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3155 'wgDigitTransformTable' => $compactDigitTransTable,
3156 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3157 'wgMonthNames' => $lang->getMonthNamesArray(),
3158 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3159 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3160 );
3161
3162 if ( $user->isLoggedIn() ) {
3163 $vars['wgUserId'] = $user->getId();
3164 $vars['wgUserEditCount'] = $user->getEditCount();
3165 $userReg = wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
3166 $vars['wgUserRegistration'] = $userReg !== null ? ( $userReg * 1000 ) : null;
3167 // Get the revision ID of the oldest new message on the user's talk
3168 // page. This can be used for constructing new message alerts on
3169 // the client side.
3170 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3171 }
3172
3173 if ( $wgContLang->hasVariants() ) {
3174 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3175 }
3176 // Same test as SkinTemplate
3177 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3178 && ( $title->exists() || $title->quickUserCan( 'create', $user ) );
3179
3180 foreach ( $title->getRestrictionTypes() as $type ) {
3181 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3182 }
3183
3184 if ( $title->isMainPage() ) {
3185 $vars['wgIsMainPage'] = true;
3186 }
3187
3188 if ( $this->mRedirectedFrom ) {
3189 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom->getPrefixedDBkey();
3190 }
3191
3192 if ( $relevantUser ) {
3193 $vars['wgRelevantUserName'] = $relevantUser->getName();
3194 }
3195
3196 // Allow extensions to add their custom variables to the mw.config map.
3197 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3198 // page-dependant but site-wide (without state).
3199 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3200 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars, $this ) );
3201
3202 // Merge in variables from addJsConfigVars last
3203 return array_merge( $vars, $this->getJsConfigVars() );
3204 }
3205
3206 /**
3207 * To make it harder for someone to slip a user a fake
3208 * user-JavaScript or user-CSS preview, a random token
3209 * is associated with the login session. If it's not
3210 * passed back with the preview request, we won't render
3211 * the code.
3212 *
3213 * @return bool
3214 */
3215 public function userCanPreview() {
3216 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
3217 || !$this->getRequest()->wasPosted()
3218 || !$this->getUser()->matchEditToken(
3219 $this->getRequest()->getVal( 'wpEditToken' ) )
3220 ) {
3221 return false;
3222 }
3223 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
3224 return false;
3225 }
3226
3227 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
3228 }
3229
3230 /**
3231 * @return array in format "link name or number => 'link html'".
3232 */
3233 public function getHeadLinksArray() {
3234 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
3235 $wgSitename, $wgVersion,
3236 $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
3237 $wgDisableLangConversion, $wgCanonicalLanguageLinks,
3238 $wgRightsPage, $wgRightsUrl;
3239
3240 $tags = array();
3241
3242 $canonicalUrl = $this->mCanonicalUrl;
3243
3244 $tags['meta-generator'] = Html::element( 'meta', array(
3245 'name' => 'generator',
3246 'content' => "MediaWiki $wgVersion",
3247 ) );
3248
3249 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3250 if ( $p !== 'index,follow' ) {
3251 // http://www.robotstxt.org/wc/meta-user.html
3252 // Only show if it's different from the default robots policy
3253 $tags['meta-robots'] = Html::element( 'meta', array(
3254 'name' => 'robots',
3255 'content' => $p,
3256 ) );
3257 }
3258
3259 foreach ( $this->mMetatags as $tag ) {
3260 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
3261 $a = 'http-equiv';
3262 $tag[0] = substr( $tag[0], 5 );
3263 } else {
3264 $a = 'name';
3265 }
3266 $tagName = "meta-{$tag[0]}";
3267 if ( isset( $tags[$tagName] ) ) {
3268 $tagName .= $tag[1];
3269 }
3270 $tags[$tagName] = Html::element( 'meta',
3271 array(
3272 $a => $tag[0],
3273 'content' => $tag[1]
3274 )
3275 );
3276 }
3277
3278 foreach ( $this->mLinktags as $tag ) {
3279 $tags[] = Html::element( 'link', $tag );
3280 }
3281
3282 # Universal edit button
3283 if ( $wgUniversalEditButton && $this->isArticleRelated() ) {
3284 $user = $this->getUser();
3285 if ( $this->getTitle()->quickUserCan( 'edit', $user )
3286 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create', $user ) ) ) {
3287 // Original UniversalEditButton
3288 $msg = $this->msg( 'edit' )->text();
3289 $tags['universal-edit-button'] = Html::element( 'link', array(
3290 'rel' => 'alternate',
3291 'type' => 'application/x-wiki',
3292 'title' => $msg,
3293 'href' => $this->getTitle()->getEditURL(),
3294 ) );
3295 // Alternate edit link
3296 $tags['alternative-edit'] = Html::element( 'link', array(
3297 'rel' => 'edit',
3298 'title' => $msg,
3299 'href' => $this->getTitle()->getEditURL(),
3300 ) );
3301 }
3302 }
3303
3304 # Generally the order of the favicon and apple-touch-icon links
3305 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3306 # uses whichever one appears later in the HTML source. Make sure
3307 # apple-touch-icon is specified first to avoid this.
3308 if ( $wgAppleTouchIcon !== false ) {
3309 $tags['apple-touch-icon'] = Html::element( 'link', array(
3310 'rel' => 'apple-touch-icon',
3311 'href' => $wgAppleTouchIcon
3312 ) );
3313 }
3314
3315 if ( $wgFavicon !== false ) {
3316 $tags['favicon'] = Html::element( 'link', array(
3317 'rel' => 'shortcut icon',
3318 'href' => $wgFavicon
3319 ) );
3320 }
3321
3322 # OpenSearch description link
3323 $tags['opensearch'] = Html::element( 'link', array(
3324 'rel' => 'search',
3325 'type' => 'application/opensearchdescription+xml',
3326 'href' => wfScript( 'opensearch_desc' ),
3327 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3328 ) );
3329
3330 if ( $wgEnableAPI ) {
3331 # Real Simple Discovery link, provides auto-discovery information
3332 # for the MediaWiki API (and potentially additional custom API
3333 # support such as WordPress or Twitter-compatible APIs for a
3334 # blogging extension, etc)
3335 $tags['rsd'] = Html::element( 'link', array(
3336 'rel' => 'EditURI',
3337 'type' => 'application/rsd+xml',
3338 // Output a protocol-relative URL here if $wgServer is protocol-relative
3339 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
3340 'href' => wfExpandUrl( wfAppendQuery(
3341 wfScript( 'api' ),
3342 array( 'action' => 'rsd' ) ),
3343 PROTO_RELATIVE
3344 ),
3345 ) );
3346 }
3347
3348 # Language variants
3349 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks ) {
3350 $lang = $this->getTitle()->getPageLanguage();
3351 if ( $lang->hasVariants() ) {
3352
3353 $urlvar = $lang->getURLVariant();
3354
3355 if ( !$urlvar ) {
3356 $variants = $lang->getVariants();
3357 foreach ( $variants as $_v ) {
3358 $tags["variant-$_v"] = Html::element( 'link', array(
3359 'rel' => 'alternate',
3360 'hreflang' => wfBCP47( $_v ),
3361 'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
3362 );
3363 }
3364 } else {
3365 $canonicalUrl = $this->getTitle()->getLocalURL();
3366 }
3367 }
3368 }
3369
3370 # Copyright
3371 $copyright = '';
3372 if ( $wgRightsPage ) {
3373 $copy = Title::newFromText( $wgRightsPage );
3374
3375 if ( $copy ) {
3376 $copyright = $copy->getLocalURL();
3377 }
3378 }
3379
3380 if ( !$copyright && $wgRightsUrl ) {
3381 $copyright = $wgRightsUrl;
3382 }
3383
3384 if ( $copyright ) {
3385 $tags['copyright'] = Html::element( 'link', array(
3386 'rel' => 'copyright',
3387 'href' => $copyright )
3388 );
3389 }
3390
3391 # Feeds
3392 if ( $wgFeed ) {
3393 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3394 # Use the page name for the title. In principle, this could
3395 # lead to issues with having the same name for different feeds
3396 # corresponding to the same page, but we can't avoid that at
3397 # this low a level.
3398
3399 $tags[] = $this->feedLink(
3400 $format,
3401 $link,
3402 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3403 $this->msg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )->text()
3404 );
3405 }
3406
3407 # Recent changes feed should appear on every page (except recentchanges,
3408 # that would be redundant). Put it after the per-page feed to avoid
3409 # changing existing behavior. It's still available, probably via a
3410 # menu in your browser. Some sites might have a different feed they'd
3411 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3412 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3413 # If so, use it instead.
3414 if ( $wgOverrideSiteFeed ) {
3415 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
3416 // Note, this->feedLink escapes the url.
3417 $tags[] = $this->feedLink(
3418 $type,
3419 $feedUrl,
3420 $this->msg( "site-{$type}-feed", $wgSitename )->text()
3421 );
3422 }
3423 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3424 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
3425 foreach ( $wgAdvertisedFeedTypes as $format ) {
3426 $tags[] = $this->feedLink(
3427 $format,
3428 $rctitle->getLocalURL( array( 'feed' => $format ) ),
3429 # For grep: 'site-rss-feed', 'site-atom-feed'
3430 $this->msg( "site-{$format}-feed", $wgSitename )->text()
3431 );
3432 }
3433 }
3434 }
3435
3436 # Canonical URL
3437 global $wgEnableCanonicalServerLink;
3438 if ( $wgEnableCanonicalServerLink ) {
3439 if ( $canonicalUrl !== false ) {
3440 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL );
3441 } else {
3442 $reqUrl = $this->getRequest()->getRequestURL();
3443 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL );
3444 }
3445 }
3446 if ( $canonicalUrl !== false ) {
3447 $tags[] = Html::element( 'link', array(
3448 'rel' => 'canonical',
3449 'href' => $canonicalUrl
3450 ) );
3451 }
3452
3453 return $tags;
3454 }
3455
3456 /**
3457 * @return string HTML tag links to be put in the header.
3458 * @deprecated since 1.24 Use OutputPage::headElement or if you have to,
3459 * OutputPage::getHeadLinksArray directly.
3460 */
3461 public function getHeadLinks() {
3462 wfDeprecated( __METHOD__, '1.24' );
3463 return implode( "\n", $this->getHeadLinksArray() );
3464 }
3465
3466 /**
3467 * Generate a "<link rel/>" for a feed.
3468 *
3469 * @param string $type Feed type
3470 * @param string $url URL to the feed
3471 * @param string $text Value of the "title" attribute
3472 * @return string HTML fragment
3473 */
3474 private function feedLink( $type, $url, $text ) {
3475 return Html::element( 'link', array(
3476 'rel' => 'alternate',
3477 'type' => "application/$type+xml",
3478 'title' => $text,
3479 'href' => $url )
3480 );
3481 }
3482
3483 /**
3484 * Add a local or specified stylesheet, with the given media options.
3485 * Meant primarily for internal use...
3486 *
3487 * @param string $style URL to the file
3488 * @param string $media to specify a media type, 'screen', 'printable', 'handheld' or any.
3489 * @param string $condition for IE conditional comments, specifying an IE version
3490 * @param string $dir set to 'rtl' or 'ltr' for direction-specific sheets
3491 */
3492 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3493 $options = array();
3494 // Even though we expect the media type to be lowercase, but here we
3495 // force it to lowercase to be safe.
3496 if ( $media ) {
3497 $options['media'] = $media;
3498 }
3499 if ( $condition ) {
3500 $options['condition'] = $condition;
3501 }
3502 if ( $dir ) {
3503 $options['dir'] = $dir;
3504 }
3505 $this->styles[$style] = $options;
3506 }
3507
3508 /**
3509 * Adds inline CSS styles
3510 * @param mixed $style_css Inline CSS
3511 * @param string $flip Set to 'flip' to flip the CSS if needed
3512 */
3513 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3514 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3515 # If wanted, and the interface is right-to-left, flip the CSS
3516 $style_css = CSSJanus::transform( $style_css, true, false );
3517 }
3518 $this->mInlineStyles .= Html::inlineStyle( $style_css ) . "\n";
3519 }
3520
3521 /**
3522 * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.
3523 * These will be applied to various media & IE conditionals.
3524 *
3525 * @return string
3526 */
3527 public function buildCssLinks() {
3528 global $wgAllowUserCss, $wgContLang;
3529
3530 $this->getSkin()->setupSkinUserCss( $this );
3531
3532 // Add ResourceLoader styles
3533 // Split the styles into these groups
3534 $styles = array(
3535 'other' => array(),
3536 'user' => array(),
3537 'site' => array(),
3538 'private' => array(),
3539 'noscript' => array()
3540 );
3541 $links = array();
3542 $otherTags = ''; // Tags to append after the normal <link> tags
3543 $resourceLoader = $this->getResourceLoader();
3544
3545 $moduleStyles = $this->getModuleStyles();
3546
3547 // Per-site custom styles
3548 $moduleStyles[] = 'site';
3549 $moduleStyles[] = 'noscript';
3550 $moduleStyles[] = 'user.groups';
3551
3552 // Per-user custom styles
3553 if ( $wgAllowUserCss && $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
3554 // We're on a preview of a CSS subpage
3555 // Exclude this page from the user module in case it's in there (bug 26283)
3556 $link = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
3557 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3558 );
3559 $otherTags .= $link['html'];
3560
3561 // Load the previewed CSS
3562 // If needed, Janus it first. This is user-supplied CSS, so it's
3563 // assumed to be right for the content language directionality.
3564 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3565 if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3566 $previewedCSS = CSSJanus::transform( $previewedCSS, true, false );
3567 }
3568 $otherTags .= Html::inlineStyle( $previewedCSS ) . "\n";
3569 } else {
3570 // Load the user styles normally
3571 $moduleStyles[] = 'user';
3572 }
3573
3574 // Per-user preference styles
3575 $moduleStyles[] = 'user.cssprefs';
3576
3577 foreach ( $moduleStyles as $name ) {
3578 $module = $resourceLoader->getModule( $name );
3579 if ( !$module ) {
3580 continue;
3581 }
3582 $group = $module->getGroup();
3583 // Modules in groups different than the ones listed on top (see $styles assignment)
3584 // will be placed in the "other" group
3585 $styles[ isset( $styles[$group] ) ? $group : 'other' ][] = $name;
3586 }
3587
3588 // We want site, private and user styles to override dynamically added
3589 // styles from modules, but we want dynamically added styles to override
3590 // statically added styles from other modules. So the order has to be
3591 // other, dynamic, site, private, user. Add statically added styles for
3592 // other modules
3593 $links[] = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
3594 // Add normal styles added through addStyle()/addInlineStyle() here
3595 $links[] = implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
3596 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3597 // We use a <meta> tag with a made-up name for this because that's valid HTML
3598 $links[] = Html::element(
3599 'meta',
3600 array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' )
3601 ) . "\n";
3602
3603 // Add site, private and user styles
3604 // 'private' at present only contains user.options, so put that before 'user'
3605 // Any future private modules will likely have a similar user-specific character
3606 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3607 $links[] = $this->makeResourceLoaderLink( $styles[$group],
3608 ResourceLoaderModule::TYPE_STYLES
3609 );
3610 }
3611
3612 // Add stuff in $otherTags (previewed user CSS if applicable)
3613 return self::getHtmlFromLoaderLinks( $links ) . $otherTags;
3614 }
3615
3616 /**
3617 * @return array
3618 */
3619 public function buildCssLinksArray() {
3620 $links = array();
3621
3622 // Add any extension CSS
3623 foreach ( $this->mExtStyles as $url ) {
3624 $this->addStyle( $url );
3625 }
3626 $this->mExtStyles = array();
3627
3628 foreach ( $this->styles as $file => $options ) {
3629 $link = $this->styleLink( $file, $options );
3630 if ( $link ) {
3631 $links[$file] = $link;
3632 }
3633 }
3634 return $links;
3635 }
3636
3637 /**
3638 * Generate \<link\> tags for stylesheets
3639 *
3640 * @param string $style URL to the file
3641 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3642 * @return string HTML fragment
3643 */
3644 protected function styleLink( $style, $options ) {
3645 if ( isset( $options['dir'] ) ) {
3646 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3647 return '';
3648 }
3649 }
3650
3651 if ( isset( $options['media'] ) ) {
3652 $media = self::transformCssMedia( $options['media'] );
3653 if ( is_null( $media ) ) {
3654 return '';
3655 }
3656 } else {
3657 $media = 'all';
3658 }
3659
3660 if ( substr( $style, 0, 1 ) == '/' ||
3661 substr( $style, 0, 5 ) == 'http:' ||
3662 substr( $style, 0, 6 ) == 'https:' ) {
3663 $url = $style;
3664 } else {
3665 global $wgStylePath, $wgStyleVersion;
3666 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3667 }
3668
3669 $link = Html::linkedStyle( $url, $media );
3670
3671 if ( isset( $options['condition'] ) ) {
3672 $condition = htmlspecialchars( $options['condition'] );
3673 $link = "<!--[if $condition]>$link<![endif]-->";
3674 }
3675 return $link;
3676 }
3677
3678 /**
3679 * Transform "media" attribute based on request parameters
3680 *
3681 * @param string $media Current value of the "media" attribute
3682 * @return string Modified value of the "media" attribute, or null to skip
3683 * this stylesheet
3684 */
3685 public static function transformCssMedia( $media ) {
3686 global $wgRequest;
3687
3688 // http://www.w3.org/TR/css3-mediaqueries/#syntax
3689 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3690
3691 // Switch in on-screen display for media testing
3692 $switches = array(
3693 'printable' => 'print',
3694 'handheld' => 'handheld',
3695 );
3696 foreach ( $switches as $switch => $targetMedia ) {
3697 if ( $wgRequest->getBool( $switch ) ) {
3698 if ( $media == $targetMedia ) {
3699 $media = '';
3700 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3701 // This regex will not attempt to understand a comma-separated media_query_list
3702 //
3703 // Example supported values for $media:
3704 // 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3705 // Example NOT supported value for $media:
3706 // '3d-glasses, screen, print and resolution > 90dpi'
3707 //
3708 // If it's a print request, we never want any kind of screen stylesheets
3709 // If it's a handheld request (currently the only other choice with a switch),
3710 // we don't want simple 'screen' but we might want screen queries that
3711 // have a max-width or something, so we'll pass all others on and let the
3712 // client do the query.
3713 if ( $targetMedia == 'print' || $media == 'screen' ) {
3714 return null;
3715 }
3716 }
3717 }
3718 }
3719
3720 return $media;
3721 }
3722
3723 /**
3724 * Add a wikitext-formatted message to the output.
3725 * This is equivalent to:
3726 *
3727 * $wgOut->addWikiText( wfMessage( ... )->plain() )
3728 */
3729 public function addWikiMsg( /*...*/ ) {
3730 $args = func_get_args();
3731 $name = array_shift( $args );
3732 $this->addWikiMsgArray( $name, $args );
3733 }
3734
3735 /**
3736 * Add a wikitext-formatted message to the output.
3737 * Like addWikiMsg() except the parameters are taken as an array
3738 * instead of a variable argument list.
3739 *
3740 * @param string $name
3741 * @param array $args
3742 */
3743 public function addWikiMsgArray( $name, $args ) {
3744 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3745 }
3746
3747 /**
3748 * This function takes a number of message/argument specifications, wraps them in
3749 * some overall structure, and then parses the result and adds it to the output.
3750 *
3751 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3752 * on. The subsequent arguments may either be strings, in which case they are the
3753 * message names, or arrays, in which case the first element is the message name,
3754 * and subsequent elements are the parameters to that message.
3755 *
3756 * Don't use this for messages that are not in users interface language.
3757 *
3758 * For example:
3759 *
3760 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3761 *
3762 * Is equivalent to:
3763 *
3764 * $wgOut->addWikiText( "<div class='error'>\n"
3765 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
3766 *
3767 * The newline after opening div is needed in some wikitext. See bug 19226.
3768 *
3769 * @param string $wrap
3770 */
3771 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3772 $msgSpecs = func_get_args();
3773 array_shift( $msgSpecs );
3774 $msgSpecs = array_values( $msgSpecs );
3775 $s = $wrap;
3776 foreach ( $msgSpecs as $n => $spec ) {
3777 if ( is_array( $spec ) ) {
3778 $args = $spec;
3779 $name = array_shift( $args );
3780 if ( isset( $args['options'] ) ) {
3781 unset( $args['options'] );
3782 wfDeprecated(
3783 'Adding "options" to ' . __METHOD__ . ' is no longer supported',
3784 '1.20'
3785 );
3786 }
3787 } else {
3788 $args = array();
3789 $name = $spec;
3790 }
3791 $s = str_replace( '$' . ( $n + 1 ), $this->msg( $name, $args )->plain(), $s );
3792 }
3793 $this->addWikiText( $s );
3794 }
3795
3796 /**
3797 * Include jQuery core. Use this to avoid loading it multiple times
3798 * before we get a usable script loader.
3799 *
3800 * @param array $modules List of jQuery modules which should be loaded
3801 * @return array The list of modules which were not loaded.
3802 * @since 1.16
3803 * @deprecated since 1.17
3804 */
3805 public function includeJQuery( $modules = array() ) {
3806 return array();
3807 }
3808
3809 /**
3810 * Enables/disables TOC, doesn't override __NOTOC__
3811 * @param bool $flag
3812 * @since 1.22
3813 */
3814 public function enableTOC( $flag = true ) {
3815 $this->mEnableTOC = $flag;
3816 }
3817
3818 /**
3819 * @return bool
3820 * @since 1.22
3821 */
3822 public function isTOCEnabled() {
3823 return $this->mEnableTOC;
3824 }
3825
3826 /**
3827 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3828 * @param bool $flag
3829 * @since 1.23
3830 */
3831 public function enableSectionEditLinks( $flag = true ) {
3832 $this->mEnableSectionEditLinks = $flag;
3833 }
3834
3835 /**
3836 * @return bool
3837 * @since 1.23
3838 */
3839 public function sectionEditLinksEnabled() {
3840 return $this->mEnableSectionEditLinks;
3841 }
3842 }