Merge "EditPage::newSectionSummary should return a value in all code paths"
[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 Variable 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( array $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( array $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( array $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|Message $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 String or Message 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 String or Message 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 * @param array $query Array of additional parameters to include in the link
1006 */
1007 public function addBacklinkSubtitle( Title $title, $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( array $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( array $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( array $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'.
1270 $categories = array_fill_keys( array_keys( $categories ), 'normal' );
1271
1272 # Mark hidden categories
1273 foreach ( $res as $row ) {
1274 if ( isset( $row->pp_value ) ) {
1275 $categories[$row->page_title] = 'hidden';
1276 }
1277 }
1278
1279 # Add the remaining categories to the skin
1280 if ( wfRunHooks(
1281 'OutputPageMakeCategoryLinks',
1282 array( &$this, $categories, &$this->mCategoryLinks ) )
1283 ) {
1284 foreach ( $categories as $category => $type ) {
1285 $origcategory = $category;
1286 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
1287 if ( !$title ) {
1288 continue;
1289 }
1290 $wgContLang->findVariantLink( $category, $title, true );
1291 if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
1292 continue;
1293 }
1294 $text = $wgContLang->convertHtml( $title->getText() );
1295 $this->mCategories[] = $title->getText();
1296 $this->mCategoryLinks[$type][] = Linker::link( $title, $text );
1297 }
1298 }
1299 }
1300
1301 /**
1302 * Reset the category links (but not the category list) and add $categories
1303 *
1304 * @param array $categories Mapping category name => sort key
1305 */
1306 public function setCategoryLinks( array $categories ) {
1307 $this->mCategoryLinks = array();
1308 $this->addCategoryLinks( $categories );
1309 }
1310
1311 /**
1312 * Get the list of category links, in a 2-D array with the following format:
1313 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1314 * hidden categories) and $link a HTML fragment with a link to the category
1315 * page
1316 *
1317 * @return array
1318 */
1319 public function getCategoryLinks() {
1320 return $this->mCategoryLinks;
1321 }
1322
1323 /**
1324 * Get the list of category names this page belongs to
1325 *
1326 * @return array Array of strings
1327 */
1328 public function getCategories() {
1329 return $this->mCategories;
1330 }
1331
1332 /**
1333 * Do not allow scripts which can be modified by wiki users to load on this page;
1334 * only allow scripts bundled with, or generated by, the software.
1335 */
1336 public function disallowUserJs() {
1337 $this->reduceAllowedModules(
1338 ResourceLoaderModule::TYPE_SCRIPTS,
1339 ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
1340 );
1341 }
1342
1343 /**
1344 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1345 * @see ResourceLoaderModule::$origin
1346 * @param string $type ResourceLoaderModule TYPE_ constant
1347 * @return int ResourceLoaderModule ORIGIN_ class constant
1348 */
1349 public function getAllowedModules( $type ) {
1350 if ( $type == ResourceLoaderModule::TYPE_COMBINED ) {
1351 return min( array_values( $this->mAllowedModules ) );
1352 } else {
1353 return isset( $this->mAllowedModules[$type] )
1354 ? $this->mAllowedModules[$type]
1355 : ResourceLoaderModule::ORIGIN_ALL;
1356 }
1357 }
1358
1359 /**
1360 * Set the highest level of CSS/JS untrustworthiness allowed
1361 * @param string $type ResourceLoaderModule TYPE_ constant
1362 * @param int $level ResourceLoaderModule class constant
1363 */
1364 public function setAllowedModules( $type, $level ) {
1365 $this->mAllowedModules[$type] = $level;
1366 }
1367
1368 /**
1369 * As for setAllowedModules(), but don't inadvertently make the page more accessible
1370 * @param string $type
1371 * @param int $level ResourceLoaderModule class constant
1372 */
1373 public function reduceAllowedModules( $type, $level ) {
1374 $this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
1375 }
1376
1377 /**
1378 * Prepend $text to the body HTML
1379 *
1380 * @param string $text HTML
1381 */
1382 public function prependHTML( $text ) {
1383 $this->mBodytext = $text . $this->mBodytext;
1384 }
1385
1386 /**
1387 * Append $text to the body HTML
1388 *
1389 * @param string $text HTML
1390 */
1391 public function addHTML( $text ) {
1392 $this->mBodytext .= $text;
1393 }
1394
1395 /**
1396 * Shortcut for adding an Html::element via addHTML.
1397 *
1398 * @since 1.19
1399 *
1400 * @param string $element
1401 * @param array $attribs
1402 * @param string $contents
1403 */
1404 public function addElement( $element, array $attribs = array(), $contents = '' ) {
1405 $this->addHTML( Html::element( $element, $attribs, $contents ) );
1406 }
1407
1408 /**
1409 * Clear the body HTML
1410 */
1411 public function clearHTML() {
1412 $this->mBodytext = '';
1413 }
1414
1415 /**
1416 * Get the body HTML
1417 *
1418 * @return string HTML
1419 */
1420 public function getHTML() {
1421 return $this->mBodytext;
1422 }
1423
1424 /**
1425 * Get/set the ParserOptions object to use for wikitext parsing
1426 *
1427 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1428 * current ParserOption object
1429 * @return ParserOptions
1430 */
1431 public function parserOptions( $options = null ) {
1432 if ( !$this->mParserOptions ) {
1433 $this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
1434 $this->mParserOptions->setEditSection( false );
1435 }
1436 return wfSetVar( $this->mParserOptions, $options );
1437 }
1438
1439 /**
1440 * Set the revision ID which will be seen by the wiki text parser
1441 * for things such as embedded {{REVISIONID}} variable use.
1442 *
1443 * @param int|null $revid An positive integer, or null
1444 * @return mixed Previous value
1445 */
1446 public function setRevisionId( $revid ) {
1447 $val = is_null( $revid ) ? null : intval( $revid );
1448 return wfSetVar( $this->mRevisionId, $val );
1449 }
1450
1451 /**
1452 * Get the displayed revision ID
1453 *
1454 * @return int
1455 */
1456 public function getRevisionId() {
1457 return $this->mRevisionId;
1458 }
1459
1460 /**
1461 * Set the timestamp of the revision which will be displayed. This is used
1462 * to avoid a extra DB call in Skin::lastModified().
1463 *
1464 * @param string|null $timestamp
1465 * @return mixed Previous value
1466 */
1467 public function setRevisionTimestamp( $timestamp ) {
1468 return wfSetVar( $this->mRevisionTimestamp, $timestamp );
1469 }
1470
1471 /**
1472 * Get the timestamp of displayed revision.
1473 * This will be null if not filled by setRevisionTimestamp().
1474 *
1475 * @return string|null
1476 */
1477 public function getRevisionTimestamp() {
1478 return $this->mRevisionTimestamp;
1479 }
1480
1481 /**
1482 * Set the displayed file version
1483 *
1484 * @param File|bool $file
1485 * @return mixed Previous value
1486 */
1487 public function setFileVersion( $file ) {
1488 $val = null;
1489 if ( $file instanceof File && $file->exists() ) {
1490 $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1491 }
1492 return wfSetVar( $this->mFileVersion, $val, true );
1493 }
1494
1495 /**
1496 * Get the displayed file version
1497 *
1498 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1499 */
1500 public function getFileVersion() {
1501 return $this->mFileVersion;
1502 }
1503
1504 /**
1505 * Get the templates used on this page
1506 *
1507 * @return array (namespace => dbKey => revId)
1508 * @since 1.18
1509 */
1510 public function getTemplateIds() {
1511 return $this->mTemplateIds;
1512 }
1513
1514 /**
1515 * Get the files used on this page
1516 *
1517 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1518 * @since 1.18
1519 */
1520 public function getFileSearchOptions() {
1521 return $this->mImageTimeKeys;
1522 }
1523
1524 /**
1525 * Convert wikitext to HTML and add it to the buffer
1526 * Default assumes that the current page title will be used.
1527 *
1528 * @param string $text
1529 * @param bool $linestart Is this the start of a line?
1530 * @param bool $interface Is this text in the user interface language?
1531 */
1532 public function addWikiText( $text, $linestart = true, $interface = true ) {
1533 $title = $this->getTitle(); // Work around E_STRICT
1534 if ( !$title ) {
1535 throw new MWException( 'Title is null' );
1536 }
1537 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1538 }
1539
1540 /**
1541 * Add wikitext with a custom Title object
1542 *
1543 * @param string $text Wikitext
1544 * @param Title $title
1545 * @param bool $linestart Is this the start of a line?
1546 */
1547 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1548 $this->addWikiTextTitle( $text, $title, $linestart );
1549 }
1550
1551 /**
1552 * Add wikitext with a custom Title object and tidy enabled.
1553 *
1554 * @param string $text Wikitext
1555 * @param Title $title
1556 * @param bool $linestart Is this the start of a line?
1557 */
1558 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1559 $this->addWikiTextTitle( $text, $title, $linestart, true );
1560 }
1561
1562 /**
1563 * Add wikitext with tidy enabled
1564 *
1565 * @param string $text Wikitext
1566 * @param bool $linestart Is this the start of a line?
1567 */
1568 public function addWikiTextTidy( $text, $linestart = true ) {
1569 $title = $this->getTitle();
1570 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1571 }
1572
1573 /**
1574 * Add wikitext with a custom Title object
1575 *
1576 * @param string $text Wikitext
1577 * @param Title $title
1578 * @param bool $linestart Is this the start of a line?
1579 * @param bool $tidy Whether to use tidy
1580 * @param bool $interface Whether it is an interface message
1581 * (for example disables conversion)
1582 */
1583 public function addWikiTextTitle( $text, Title $title, $linestart,
1584 $tidy = false, $interface = false
1585 ) {
1586 global $wgParser;
1587
1588 wfProfileIn( __METHOD__ );
1589
1590 $popts = $this->parserOptions();
1591 $oldTidy = $popts->setTidy( $tidy );
1592 $popts->setInterfaceMessage( (bool)$interface );
1593
1594 $parserOutput = $wgParser->getFreshParser()->parse(
1595 $text, $title, $popts,
1596 $linestart, true, $this->mRevisionId
1597 );
1598
1599 $popts->setTidy( $oldTidy );
1600
1601 $this->addParserOutput( $parserOutput );
1602
1603 wfProfileOut( __METHOD__ );
1604 }
1605
1606 /**
1607 * Add a ParserOutput object, but without Html.
1608 *
1609 * @deprecated since 1.24, use addParserOutputMetadata() instead.
1610 * @param ParserOutput $parserOutput
1611 */
1612 public function addParserOutputNoText( &$parserOutput ) {
1613 $this->addParserOutputMetadata( $parserOutput );
1614 }
1615
1616 /**
1617 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1618 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1619 * and so on.
1620 *
1621 * @since 1.24
1622 * @param ParserOutput $parserOutput
1623 */
1624 public function addParserOutputMetadata( &$parserOutput ) {
1625 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1626 $this->addCategoryLinks( $parserOutput->getCategories() );
1627 $this->mNewSectionLink = $parserOutput->getNewSection();
1628 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1629
1630 $this->mParseWarnings = $parserOutput->getWarnings();
1631 if ( !$parserOutput->isCacheable() ) {
1632 $this->enableClientCache( false );
1633 }
1634 $this->mNoGallery = $parserOutput->getNoGallery();
1635 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1636 $this->addModules( $parserOutput->getModules() );
1637 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1638 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1639 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1640 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1641 $this->mPreventClickjacking = $this->mPreventClickjacking
1642 || $parserOutput->preventClickjacking();
1643
1644 // Template versioning...
1645 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1646 if ( isset( $this->mTemplateIds[$ns] ) ) {
1647 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1648 } else {
1649 $this->mTemplateIds[$ns] = $dbks;
1650 }
1651 }
1652 // File versioning...
1653 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1654 $this->mImageTimeKeys[$dbk] = $data;
1655 }
1656
1657 // Hooks registered in the object
1658 global $wgParserOutputHooks;
1659 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1660 list( $hookName, $data ) = $hookInfo;
1661 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1662 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1663 }
1664 }
1665
1666 // Link flags are ignored for now, but may in the future be
1667 // used to mark individual language links.
1668 $linkFlags = array();
1669 wfRunHooks( 'LanguageLinks', array( $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ) );
1670 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1671 }
1672
1673 /**
1674 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1675 * ParserOutput object, without any other metadata.
1676 *
1677 * @since 1.24
1678 * @param ParserOutput $parserOutput
1679 */
1680 public function addParserOutputContent( &$parserOutput ) {
1681 $this->addParserOutputText( $parserOutput );
1682
1683 $this->addModules( $parserOutput->getModules() );
1684 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1685 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1686 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1687
1688 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1689 }
1690
1691 /**
1692 * Add the HTML associated with a ParserOutput object, without any metadata.
1693 *
1694 * @since 1.24
1695 * @param ParserOutput $parserOutput
1696 */
1697 public function addParserOutputText( &$parserOutput ) {
1698 $text = $parserOutput->getText();
1699 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1700 $this->addHTML( $text );
1701 }
1702
1703 /**
1704 * Add everything from a ParserOutput object.
1705 *
1706 * @param ParserOutput $parserOutput
1707 */
1708 function addParserOutput( &$parserOutput ) {
1709 $this->addParserOutputMetadata( $parserOutput );
1710 $parserOutput->setTOCEnabled( $this->mEnableTOC );
1711
1712 // Touch section edit links only if not previously disabled
1713 if ( $parserOutput->getEditSectionTokens() ) {
1714 $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks );
1715 }
1716
1717 $this->addParserOutputText( $parserOutput );
1718 }
1719
1720 /**
1721 * Add the output of a QuickTemplate to the output buffer
1722 *
1723 * @param QuickTemplate $template
1724 */
1725 public function addTemplate( &$template ) {
1726 $this->addHTML( $template->getHTML() );
1727 }
1728
1729 /**
1730 * Parse wikitext and return the HTML.
1731 *
1732 * @param string $text
1733 * @param bool $linestart Is this the start of a line?
1734 * @param bool $interface Use interface language ($wgLang instead of
1735 * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1736 * This also disables LanguageConverter.
1737 * @param Language $language Target language object, will override $interface
1738 * @throws MWException
1739 * @return string HTML
1740 */
1741 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1742 global $wgParser;
1743
1744 if ( is_null( $this->getTitle() ) ) {
1745 throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1746 }
1747
1748 $popts = $this->parserOptions();
1749 if ( $interface ) {
1750 $popts->setInterfaceMessage( true );
1751 }
1752 if ( $language !== null ) {
1753 $oldLang = $popts->setTargetLanguage( $language );
1754 }
1755
1756 $parserOutput = $wgParser->getFreshParser()->parse(
1757 $text, $this->getTitle(), $popts,
1758 $linestart, true, $this->mRevisionId
1759 );
1760
1761 if ( $interface ) {
1762 $popts->setInterfaceMessage( false );
1763 }
1764 if ( $language !== null ) {
1765 $popts->setTargetLanguage( $oldLang );
1766 }
1767
1768 return $parserOutput->getText();
1769 }
1770
1771 /**
1772 * Parse wikitext, strip paragraphs, and return the HTML.
1773 *
1774 * @param string $text
1775 * @param bool $linestart Is this the start of a line?
1776 * @param bool $interface Use interface language ($wgLang instead of
1777 * $wgContLang) while parsing language sensitive magic
1778 * words like GRAMMAR and PLURAL
1779 * @return string HTML
1780 */
1781 public function parseInline( $text, $linestart = true, $interface = false ) {
1782 $parsed = $this->parse( $text, $linestart, $interface );
1783 return Parser::stripOuterParagraph( $parsed );
1784 }
1785
1786 /**
1787 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1788 *
1789 * @param int $maxage Maximum cache time on the Squid, in seconds.
1790 */
1791 public function setSquidMaxage( $maxage ) {
1792 $this->mSquidMaxage = $maxage;
1793 }
1794
1795 /**
1796 * Use enableClientCache(false) to force it to send nocache headers
1797 *
1798 * @param bool $state
1799 *
1800 * @return bool
1801 */
1802 public function enableClientCache( $state ) {
1803 return wfSetVar( $this->mEnableClientCache, $state );
1804 }
1805
1806 /**
1807 * Get the list of cookies that will influence on the cache
1808 *
1809 * @return array
1810 */
1811 function getCacheVaryCookies() {
1812 global $wgCookiePrefix, $wgCacheVaryCookies;
1813 static $cookies;
1814 if ( $cookies === null ) {
1815 $cookies = array_merge(
1816 array(
1817 "{$wgCookiePrefix}Token",
1818 "{$wgCookiePrefix}LoggedOut",
1819 "forceHTTPS",
1820 session_name()
1821 ),
1822 $wgCacheVaryCookies
1823 );
1824 wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1825 }
1826 return $cookies;
1827 }
1828
1829 /**
1830 * Check if the request has a cache-varying cookie header
1831 * If it does, it's very important that we don't allow public caching
1832 *
1833 * @return bool
1834 */
1835 function haveCacheVaryCookies() {
1836 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1837 if ( $cookieHeader === false ) {
1838 return false;
1839 }
1840 $cvCookies = $this->getCacheVaryCookies();
1841 foreach ( $cvCookies as $cookieName ) {
1842 # Check for a simple string match, like the way squid does it
1843 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1844 wfDebug( __METHOD__ . ": found $cookieName\n" );
1845 return true;
1846 }
1847 }
1848 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1849 return false;
1850 }
1851
1852 /**
1853 * Add an HTTP header that will influence on the cache
1854 *
1855 * @param string $header Header name
1856 * @param array|null $option
1857 * @todo FIXME: Document the $option parameter; it appears to be for
1858 * X-Vary-Options but what format is acceptable?
1859 */
1860 public function addVaryHeader( $header, $option = null ) {
1861 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1862 $this->mVaryHeader[$header] = (array)$option;
1863 } elseif ( is_array( $option ) ) {
1864 if ( is_array( $this->mVaryHeader[$header] ) ) {
1865 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1866 } else {
1867 $this->mVaryHeader[$header] = $option;
1868 }
1869 }
1870 $this->mVaryHeader[$header] = array_unique( (array)$this->mVaryHeader[$header] );
1871 }
1872
1873 /**
1874 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
1875 * such as Accept-Encoding or Cookie
1876 *
1877 * @return string
1878 */
1879 public function getVaryHeader() {
1880 return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) );
1881 }
1882
1883 /**
1884 * Get a complete X-Vary-Options header
1885 *
1886 * @return string
1887 */
1888 public function getXVO() {
1889 $cvCookies = $this->getCacheVaryCookies();
1890
1891 $cookiesOption = array();
1892 foreach ( $cvCookies as $cookieName ) {
1893 $cookiesOption[] = 'string-contains=' . $cookieName;
1894 }
1895 $this->addVaryHeader( 'Cookie', $cookiesOption );
1896
1897 $headers = array();
1898 foreach ( $this->mVaryHeader as $header => $option ) {
1899 $newheader = $header;
1900 if ( is_array( $option ) && count( $option ) > 0 ) {
1901 $newheader .= ';' . implode( ';', $option );
1902 }
1903 $headers[] = $newheader;
1904 }
1905 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1906
1907 return $xvo;
1908 }
1909
1910 /**
1911 * bug 21672: Add Accept-Language to Vary and XVO headers
1912 * if there's no 'variant' parameter existed in GET.
1913 *
1914 * For example:
1915 * /w/index.php?title=Main_page should always be served; but
1916 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
1917 */
1918 function addAcceptLanguage() {
1919 $title = $this->getTitle();
1920 if ( !$title instanceof Title ) {
1921 return;
1922 }
1923
1924 $lang = $title->getPageLanguage();
1925 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
1926 $variants = $lang->getVariants();
1927 $aloption = array();
1928 foreach ( $variants as $variant ) {
1929 if ( $variant === $lang->getCode() ) {
1930 continue;
1931 } else {
1932 $aloption[] = 'string-contains=' . $variant;
1933
1934 // IE and some other browsers use BCP 47 standards in
1935 // their Accept-Language header, like "zh-CN" or "zh-Hant".
1936 // We should handle these too.
1937 $variantBCP47 = wfBCP47( $variant );
1938 if ( $variantBCP47 !== $variant ) {
1939 $aloption[] = 'string-contains=' . $variantBCP47;
1940 }
1941 }
1942 }
1943 $this->addVaryHeader( 'Accept-Language', $aloption );
1944 }
1945 }
1946
1947 /**
1948 * Set a flag which will cause an X-Frame-Options header appropriate for
1949 * edit pages to be sent. The header value is controlled by
1950 * $wgEditPageFrameOptions.
1951 *
1952 * This is the default for special pages. If you display a CSRF-protected
1953 * form on an ordinary view page, then you need to call this function.
1954 *
1955 * @param bool $enable
1956 */
1957 public function preventClickjacking( $enable = true ) {
1958 $this->mPreventClickjacking = $enable;
1959 }
1960
1961 /**
1962 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1963 * This can be called from pages which do not contain any CSRF-protected
1964 * HTML form.
1965 */
1966 public function allowClickjacking() {
1967 $this->mPreventClickjacking = false;
1968 }
1969
1970 /**
1971 * Get the prevent-clickjacking flag
1972 *
1973 * @since 1.24
1974 * @return bool
1975 */
1976 public function getPreventClickjacking() {
1977 return $this->mPreventClickjacking;
1978 }
1979
1980 /**
1981 * Get the X-Frame-Options header value (without the name part), or false
1982 * if there isn't one. This is used by Skin to determine whether to enable
1983 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1984 *
1985 * @return string
1986 */
1987 public function getFrameOptions() {
1988 global $wgBreakFrames, $wgEditPageFrameOptions;
1989 if ( $wgBreakFrames ) {
1990 return 'DENY';
1991 } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
1992 return $wgEditPageFrameOptions;
1993 }
1994 return false;
1995 }
1996
1997 /**
1998 * Send cache control HTTP headers
1999 */
2000 public function sendCacheControl() {
2001 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
2002
2003 $response = $this->getRequest()->response();
2004 if ( $wgUseETag && $this->mETag ) {
2005 $response->header( "ETag: $this->mETag" );
2006 }
2007
2008 $this->addVaryHeader( 'Cookie' );
2009 $this->addAcceptLanguage();
2010
2011 # don't serve compressed data to clients who can't handle it
2012 # maintain different caches for logged-in users and non-logged in ones
2013 $response->header( $this->getVaryHeader() );
2014
2015 if ( $wgUseXVO ) {
2016 # Add an X-Vary-Options header for Squid with Wikimedia patches
2017 $response->header( $this->getXVO() );
2018 }
2019
2020 if ( $this->mEnableClientCache ) {
2021 if (
2022 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
2023 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
2024 ) {
2025 if ( $wgUseESI ) {
2026 # We'll purge the proxy cache explicitly, but require end user agents
2027 # to revalidate against the proxy on each visit.
2028 # Surrogate-Control controls our Squid, Cache-Control downstream caches
2029 wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", 'log' );
2030 # start with a shorter timeout for initial testing
2031 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2032 $response->header( 'Surrogate-Control: max-age=' . $wgSquidMaxage
2033 . '+' . $this->mSquidMaxage . ', content="ESI/1.0"' );
2034 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2035 } else {
2036 # We'll purge the proxy cache for anons explicitly, but require end user agents
2037 # to revalidate against the proxy on each visit.
2038 # IMPORTANT! The Squid needs to replace the Cache-Control header with
2039 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2040 wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", 'log' );
2041 # start with a shorter timeout for initial testing
2042 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2043 $response->header( 'Cache-Control: s-maxage=' . $this->mSquidMaxage
2044 . ', must-revalidate, max-age=0' );
2045 }
2046 } else {
2047 # We do want clients to cache if they can, but they *must* check for updates
2048 # on revisiting the page.
2049 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", 'log' );
2050 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2051 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2052 }
2053 if ( $this->mLastModified ) {
2054 $response->header( "Last-Modified: {$this->mLastModified}" );
2055 }
2056 } else {
2057 wfDebug( __METHOD__ . ": no caching **\n", 'log' );
2058
2059 # In general, the absence of a last modified header should be enough to prevent
2060 # the client from using its cache. We send a few other things just to make sure.
2061 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2062 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2063 $response->header( 'Pragma: no-cache' );
2064 }
2065 }
2066
2067 /**
2068 * Finally, all the text has been munged and accumulated into
2069 * the object, let's actually output it:
2070 */
2071 public function output() {
2072 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType, $wgVaryOnXFP,
2073 $wgResponsiveImages;
2074
2075 if ( $this->mDoNothing ) {
2076 return;
2077 }
2078
2079 wfProfileIn( __METHOD__ );
2080
2081 $response = $this->getRequest()->response();
2082
2083 if ( $this->mRedirect != '' ) {
2084 # Standards require redirect URLs to be absolute
2085 $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
2086
2087 $redirect = $this->mRedirect;
2088 $code = $this->mRedirectCode;
2089
2090 if ( wfRunHooks( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
2091 if ( $code == '301' || $code == '303' ) {
2092 if ( !$wgDebugRedirects ) {
2093 $message = HttpStatus::getMessage( $code );
2094 $response->header( "HTTP/1.1 $code $message" );
2095 }
2096 $this->mLastModified = wfTimestamp( TS_RFC2822 );
2097 }
2098 if ( $wgVaryOnXFP ) {
2099 $this->addVaryHeader( 'X-Forwarded-Proto' );
2100 }
2101 $this->sendCacheControl();
2102
2103 $response->header( "Content-Type: text/html; charset=utf-8" );
2104 if ( $wgDebugRedirects ) {
2105 $url = htmlspecialchars( $redirect );
2106 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2107 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2108 print "</body>\n</html>\n";
2109 } else {
2110 $response->header( 'Location: ' . $redirect );
2111 }
2112 }
2113
2114 wfProfileOut( __METHOD__ );
2115 return;
2116 } elseif ( $this->mStatusCode ) {
2117 $message = HttpStatus::getMessage( $this->mStatusCode );
2118 if ( $message ) {
2119 $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
2120 }
2121 }
2122
2123 # Buffer output; final headers may depend on later processing
2124 ob_start();
2125
2126 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
2127 $response->header( 'Content-language: ' . $wgLanguageCode );
2128
2129 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2130 // jQuery etc. can work correctly.
2131 $response->header( 'X-UA-Compatible: IE=Edge' );
2132
2133 // Prevent framing, if requested
2134 $frameOptions = $this->getFrameOptions();
2135 if ( $frameOptions ) {
2136 $response->header( "X-Frame-Options: $frameOptions" );
2137 }
2138
2139 if ( $this->mArticleBodyOnly ) {
2140 echo $this->mBodytext;
2141 } else {
2142
2143 $sk = $this->getSkin();
2144 // add skin specific modules
2145 $modules = $sk->getDefaultModules();
2146
2147 // enforce various default modules for all skins
2148 $coreModules = array(
2149 // keep this list as small as possible
2150 'mediawiki.page.startup',
2151 'mediawiki.user',
2152 );
2153
2154 // Support for high-density display images if enabled
2155 if ( $wgResponsiveImages ) {
2156 $coreModules[] = 'mediawiki.hidpi';
2157 }
2158
2159 $this->addModules( $coreModules );
2160 foreach ( $modules as $group ) {
2161 $this->addModules( $group );
2162 }
2163 MWDebug::addModules( $this );
2164
2165 // Hook that allows last minute changes to the output page, e.g.
2166 // adding of CSS or Javascript by extensions.
2167 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
2168
2169 wfProfileIn( 'Output-skin' );
2170 $sk->outputPage();
2171 wfProfileOut( 'Output-skin' );
2172 }
2173
2174 // This hook allows last minute changes to final overall output by modifying output buffer
2175 wfRunHooks( 'AfterFinalPageOutput', array( $this ) );
2176
2177 $this->sendCacheControl();
2178
2179 ob_end_flush();
2180
2181 wfProfileOut( __METHOD__ );
2182 }
2183
2184 /**
2185 * Actually output something with print.
2186 *
2187 * @param string $ins The string to output
2188 * @deprecated since 1.22 Use echo yourself.
2189 */
2190 public function out( $ins ) {
2191 wfDeprecated( __METHOD__, '1.22' );
2192 print $ins;
2193 }
2194
2195 /**
2196 * Produce a "user is blocked" page.
2197 * @deprecated since 1.18
2198 */
2199 function blockedPage() {
2200 throw new UserBlockedError( $this->getUser()->mBlock );
2201 }
2202
2203 /**
2204 * Prepare this object to display an error page; disable caching and
2205 * indexing, clear the current text and redirect, set the page's title
2206 * and optionally an custom HTML title (content of the "<title>" tag).
2207 *
2208 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
2209 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
2210 * optional, if not passed the "<title>" attribute will be
2211 * based on $pageTitle
2212 */
2213 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2214 $this->setPageTitle( $pageTitle );
2215 if ( $htmlTitle !== false ) {
2216 $this->setHTMLTitle( $htmlTitle );
2217 }
2218 $this->setRobotPolicy( 'noindex,nofollow' );
2219 $this->setArticleRelated( false );
2220 $this->enableClientCache( false );
2221 $this->mRedirect = '';
2222 $this->clearSubtitle();
2223 $this->clearHTML();
2224 }
2225
2226 /**
2227 * Output a standard error page
2228 *
2229 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2230 * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2231 * showErrorPage( 'titlemsg', $messageObject );
2232 * showErrorPage( $titleMessageObject, $messageObject );
2233 *
2234 * @param string|Message $title Message key (string) for page title, or a Message object
2235 * @param string|Message $msg Message key (string) for page text, or a Message object
2236 * @param array $params Message parameters; ignored if $msg is a Message object
2237 */
2238 public function showErrorPage( $title, $msg, $params = array() ) {
2239 if ( !$title instanceof Message ) {
2240 $title = $this->msg( $title );
2241 }
2242
2243 $this->prepareErrorPage( $title );
2244
2245 if ( $msg instanceof Message ) {
2246 if ( $params !== array() ) {
2247 trigger_error( 'Argument ignored: $params. The message parameters argument '
2248 . 'is discarded when the $msg argument is a Message object instead of '
2249 . 'a string.', E_USER_NOTICE );
2250 }
2251 $this->addHTML( $msg->parseAsBlock() );
2252 } else {
2253 $this->addWikiMsgArray( $msg, $params );
2254 }
2255
2256 $this->returnToMain();
2257 }
2258
2259 /**
2260 * Output a standard permission error page
2261 *
2262 * @param array $errors Error message keys
2263 * @param string $action Action that was denied or null if unknown
2264 */
2265 public function showPermissionsErrorPage( array $errors, $action = null ) {
2266 // For some action (read, edit, create and upload), display a "login to do this action"
2267 // error if all of the following conditions are met:
2268 // 1. the user is not logged in
2269 // 2. the only error is insufficient permissions (i.e. no block or something else)
2270 // 3. the error can be avoided simply by logging in
2271 if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
2272 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2273 && ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
2274 && ( User::groupHasPermission( 'user', $action )
2275 || User::groupHasPermission( 'autoconfirmed', $action ) )
2276 ) {
2277 $displayReturnto = null;
2278
2279 # Due to bug 32276, if a user does not have read permissions,
2280 # $this->getTitle() will just give Special:Badtitle, which is
2281 # not especially useful as a returnto parameter. Use the title
2282 # from the request instead, if there was one.
2283 $request = $this->getRequest();
2284 $returnto = Title::newFromURL( $request->getVal( 'title', '' ) );
2285 if ( $action == 'edit' ) {
2286 $msg = 'whitelistedittext';
2287 $displayReturnto = $returnto;
2288 } elseif ( $action == 'createpage' || $action == 'createtalk' ) {
2289 $msg = 'nocreatetext';
2290 } elseif ( $action == 'upload' ) {
2291 $msg = 'uploadnologintext';
2292 } else { # Read
2293 $msg = 'loginreqpagetext';
2294 $displayReturnto = Title::newMainPage();
2295 }
2296
2297 $query = array();
2298
2299 if ( $returnto ) {
2300 $query['returnto'] = $returnto->getPrefixedText();
2301
2302 if ( !$request->wasPosted() ) {
2303 $returntoquery = $request->getValues();
2304 unset( $returntoquery['title'] );
2305 unset( $returntoquery['returnto'] );
2306 unset( $returntoquery['returntoquery'] );
2307 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2308 }
2309 }
2310 $loginLink = Linker::linkKnown(
2311 SpecialPage::getTitleFor( 'Userlogin' ),
2312 $this->msg( 'loginreqlink' )->escaped(),
2313 array(),
2314 $query
2315 );
2316
2317 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2318 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2319
2320 # Don't return to a page the user can't read otherwise
2321 # we'll end up in a pointless loop
2322 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2323 $this->returnToMain( null, $displayReturnto );
2324 }
2325 } else {
2326 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2327 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2328 }
2329 }
2330
2331 /**
2332 * Display an error page indicating that a given version of MediaWiki is
2333 * required to use it
2334 *
2335 * @param mixed $version The version of MediaWiki needed to use the page
2336 */
2337 public function versionRequired( $version ) {
2338 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2339
2340 $this->addWikiMsg( 'versionrequiredtext', $version );
2341 $this->returnToMain();
2342 }
2343
2344 /**
2345 * Display an error page noting that a given permission bit is required.
2346 * @deprecated since 1.18, just throw the exception directly
2347 * @param string $permission Key required
2348 * @throws PermissionsError
2349 */
2350 public function permissionRequired( $permission ) {
2351 throw new PermissionsError( $permission );
2352 }
2353
2354 /**
2355 * Produce the stock "please login to use the wiki" page
2356 *
2357 * @deprecated since 1.19; throw the exception directly
2358 */
2359 public function loginToUse() {
2360 throw new PermissionsError( 'read' );
2361 }
2362
2363 /**
2364 * Format a list of error messages
2365 *
2366 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2367 * @param string $action Action that was denied or null if unknown
2368 * @return string The wikitext error-messages, formatted into a list.
2369 */
2370 public function formatPermissionsErrorMessage( array $errors, $action = null ) {
2371 if ( $action == null ) {
2372 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2373 } else {
2374 $action_desc = $this->msg( "action-$action" )->plain();
2375 $text = $this->msg(
2376 'permissionserrorstext-withaction',
2377 count( $errors ),
2378 $action_desc
2379 )->plain() . "\n\n";
2380 }
2381
2382 if ( count( $errors ) > 1 ) {
2383 $text .= '<ul class="permissions-errors">' . "\n";
2384
2385 foreach ( $errors as $error ) {
2386 $text .= '<li>';
2387 $text .= call_user_func_array( array( $this, 'msg' ), $error )->plain();
2388 $text .= "</li>\n";
2389 }
2390 $text .= '</ul>';
2391 } else {
2392 $text .= "<div class=\"permissions-errors\">\n" .
2393 call_user_func_array( array( $this, 'msg' ), reset( $errors ) )->plain() .
2394 "\n</div>";
2395 }
2396
2397 return $text;
2398 }
2399
2400 /**
2401 * Display a page stating that the Wiki is in read-only mode,
2402 * and optionally show the source of the page that the user
2403 * was trying to edit. Should only be called (for this
2404 * purpose) after wfReadOnly() has returned true.
2405 *
2406 * For historical reasons, this function is _also_ used to
2407 * show the error message when a user tries to edit a page
2408 * they are not allowed to edit. (Unless it's because they're
2409 * blocked, then we show blockedPage() instead.) In this
2410 * case, the second parameter should be set to true and a list
2411 * of reasons supplied as the third parameter.
2412 *
2413 * @todo Needs to be split into multiple functions.
2414 *
2415 * @param string $source Source code to show (or null).
2416 * @param bool $protected Is this a permissions error?
2417 * @param array $reasons List of reasons for this error, as returned by
2418 * Title::getUserPermissionsErrors().
2419 * @param string $action Action that was denied or null if unknown
2420 * @throws ReadOnlyError
2421 */
2422 public function readOnlyPage( $source = null, $protected = false,
2423 array $reasons = array(), $action = null
2424 ) {
2425 $this->setRobotPolicy( 'noindex,nofollow' );
2426 $this->setArticleRelated( false );
2427
2428 // If no reason is given, just supply a default "I can't let you do
2429 // that, Dave" message. Should only occur if called by legacy code.
2430 if ( $protected && empty( $reasons ) ) {
2431 $reasons[] = array( 'badaccess-group0' );
2432 }
2433
2434 if ( !empty( $reasons ) ) {
2435 // Permissions error
2436 if ( $source ) {
2437 $this->setPageTitle( $this->msg( 'viewsource-title', $this->getTitle()->getPrefixedText() ) );
2438 $this->addBacklinkSubtitle( $this->getTitle() );
2439 } else {
2440 $this->setPageTitle( $this->msg( 'badaccess' ) );
2441 }
2442 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2443 } else {
2444 // Wiki is read only
2445 throw new ReadOnlyError;
2446 }
2447
2448 // Show source, if supplied
2449 if ( is_string( $source ) ) {
2450 $this->addWikiMsg( 'viewsourcetext' );
2451
2452 $pageLang = $this->getTitle()->getPageLanguage();
2453 $params = array(
2454 'id' => 'wpTextbox1',
2455 'name' => 'wpTextbox1',
2456 'cols' => $this->getUser()->getOption( 'cols' ),
2457 'rows' => $this->getUser()->getOption( 'rows' ),
2458 'readonly' => 'readonly',
2459 'lang' => $pageLang->getHtmlCode(),
2460 'dir' => $pageLang->getDir(),
2461 );
2462 $this->addHTML( Html::element( 'textarea', $params, $source ) );
2463
2464 // Show templates used by this article
2465 $templates = Linker::formatTemplates( $this->getTitle()->getTemplateLinksFrom() );
2466 $this->addHTML( "<div class='templatesUsed'>
2467 $templates
2468 </div>
2469 " );
2470 }
2471
2472 # If the title doesn't exist, it's fairly pointless to print a return
2473 # link to it. After all, you just tried editing it and couldn't, so
2474 # what's there to do there?
2475 if ( $this->getTitle()->exists() ) {
2476 $this->returnToMain( null, $this->getTitle() );
2477 }
2478 }
2479
2480 /**
2481 * Turn off regular page output and return an error response
2482 * for when rate limiting has triggered.
2483 */
2484 public function rateLimited() {
2485 throw new ThrottledError;
2486 }
2487
2488 /**
2489 * Show a warning about slave lag
2490 *
2491 * If the lag is higher than $wgSlaveLagCritical seconds,
2492 * then the warning is a bit more obvious. If the lag is
2493 * lower than $wgSlaveLagWarning, then no warning is shown.
2494 *
2495 * @param int $lag Slave lag
2496 */
2497 public function showLagWarning( $lag ) {
2498 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2499 if ( $lag >= $wgSlaveLagWarning ) {
2500 $message = $lag < $wgSlaveLagCritical
2501 ? 'lag-warn-normal'
2502 : 'lag-warn-high';
2503 $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2504 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
2505 }
2506 }
2507
2508 public function showFatalError( $message ) {
2509 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2510
2511 $this->addHTML( $message );
2512 }
2513
2514 public function showUnexpectedValueError( $name, $val ) {
2515 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2516 }
2517
2518 public function showFileCopyError( $old, $new ) {
2519 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2520 }
2521
2522 public function showFileRenameError( $old, $new ) {
2523 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2524 }
2525
2526 public function showFileDeleteError( $name ) {
2527 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2528 }
2529
2530 public function showFileNotFoundError( $name ) {
2531 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2532 }
2533
2534 /**
2535 * Add a "return to" link pointing to a specified title
2536 *
2537 * @param Title $title Title to link
2538 * @param array $query Query string parameters
2539 * @param string $text Text of the link (input is not escaped)
2540 * @param array $options Options array to pass to Linker
2541 */
2542 public function addReturnTo( $title, array $query = array(), $text = null, $options = array() ) {
2543 $link = $this->msg( 'returnto' )->rawParams(
2544 Linker::link( $title, $text, array(), $query, $options ) )->escaped();
2545 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2546 }
2547
2548 /**
2549 * Add a "return to" link pointing to a specified title,
2550 * or the title indicated in the request, or else the main page
2551 *
2552 * @param mixed $unused
2553 * @param Title|string $returnto Title or String to return to
2554 * @param string $returntoquery Query string for the return to link
2555 */
2556 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2557 if ( $returnto == null ) {
2558 $returnto = $this->getRequest()->getText( 'returnto' );
2559 }
2560
2561 if ( $returntoquery == null ) {
2562 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2563 }
2564
2565 if ( $returnto === '' ) {
2566 $returnto = Title::newMainPage();
2567 }
2568
2569 if ( is_object( $returnto ) ) {
2570 $titleObj = $returnto;
2571 } else {
2572 $titleObj = Title::newFromText( $returnto );
2573 }
2574 if ( !is_object( $titleObj ) ) {
2575 $titleObj = Title::newMainPage();
2576 }
2577
2578 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2579 }
2580
2581 /**
2582 * @param Skin $sk The given Skin
2583 * @param bool $includeStyle Unused
2584 * @return string The doctype, opening "<html>", and head element.
2585 */
2586 public function headElement( Skin $sk, $includeStyle = true ) {
2587 global $wgContLang, $wgMimeType;
2588
2589 $userdir = $this->getLanguage()->getDir();
2590 $sitedir = $wgContLang->getDir();
2591
2592 $ret = Html::htmlHeader( $sk->getHtmlElementAttributes() );
2593
2594 if ( $this->getHTMLTitle() == '' ) {
2595 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2596 }
2597
2598 $openHead = Html::openElement( 'head' );
2599 if ( $openHead ) {
2600 # Don't bother with the newline if $head == ''
2601 $ret .= "$openHead\n";
2602 }
2603
2604 if ( !Html::isXmlMimeType( $wgMimeType ) ) {
2605 // Add <meta charset="UTF-8">
2606 // This should be before <title> since it defines the charset used by
2607 // text including the text inside <title>.
2608 // The spec recommends defining XHTML5's charset using the XML declaration
2609 // instead of meta.
2610 // Our XML declaration is output by Html::htmlHeader.
2611 // http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
2612 // http://www.whatwg.org/html/semantics.html#charset
2613 $ret .= Html::element( 'meta', array( 'charset' => 'UTF-8' ) ) . "\n";
2614 }
2615
2616 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2617
2618 foreach ( $this->getHeadLinksArray() as $item ) {
2619 $ret .= $item . "\n";
2620 }
2621
2622 // No newline after buildCssLinks since makeResourceLoaderLink did that already
2623 $ret .= $this->buildCssLinks();
2624
2625 $ret .= $this->getHeadScripts() . "\n";
2626
2627 foreach ( $this->mHeadItems as $item ) {
2628 $ret .= $item . "\n";
2629 }
2630
2631 $closeHead = Html::closeElement( 'head' );
2632 if ( $closeHead ) {
2633 $ret .= "$closeHead\n";
2634 }
2635
2636 $bodyClasses = array();
2637 $bodyClasses[] = 'mediawiki';
2638
2639 # Classes for LTR/RTL directionality support
2640 $bodyClasses[] = $userdir;
2641 $bodyClasses[] = "sitedir-$sitedir";
2642
2643 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2644 # A <body> class is probably not the best way to do this . . .
2645 $bodyClasses[] = 'capitalize-all-nouns';
2646 }
2647
2648 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2649 $bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2650 $bodyClasses[] =
2651 'action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
2652
2653 $bodyAttrs = array();
2654 // While the implode() is not strictly needed, it's used for backwards compatibility
2655 // (this used to be built as a string and hooks likely still expect that).
2656 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2657
2658 // Allow skins and extensions to add body attributes they need
2659 $sk->addToBodyAttributes( $this, $bodyAttrs );
2660 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2661
2662 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2663
2664 return $ret;
2665 }
2666
2667 /**
2668 * Get a ResourceLoader object associated with this OutputPage
2669 *
2670 * @return ResourceLoader
2671 */
2672 public function getResourceLoader() {
2673 if ( is_null( $this->mResourceLoader ) ) {
2674 $this->mResourceLoader = new ResourceLoader();
2675 }
2676 return $this->mResourceLoader;
2677 }
2678
2679 /**
2680 * @todo Document
2681 * @param array|string $modules One or more module names
2682 * @param string $only ResourceLoaderModule TYPE_ class constant
2683 * @param bool $useESI
2684 * @param array $extraQuery Array with extra query parameters to add to each
2685 * request. array( param => value ).
2686 * @param bool $loadCall If true, output an (asynchronous) mw.loader.load()
2687 * call rather than a "<script src='...'>" tag.
2688 * @return string The html "<script>", "<link>" and "<style>" tags
2689 */
2690 protected function makeResourceLoaderLink( $modules, $only, $useESI = false,
2691 array $extraQuery = array(), $loadCall = false
2692 ) {
2693 global $wgResourceLoaderUseESI;
2694
2695 $modules = (array)$modules;
2696
2697 $links = array(
2698 'html' => '',
2699 'states' => array(),
2700 );
2701
2702 if ( !count( $modules ) ) {
2703 return $links;
2704 }
2705
2706 if ( count( $modules ) > 1 ) {
2707 // Remove duplicate module requests
2708 $modules = array_unique( $modules );
2709 // Sort module names so requests are more uniform
2710 sort( $modules );
2711
2712 if ( ResourceLoader::inDebugMode() ) {
2713 // Recursively call us for every item
2714 foreach ( $modules as $name ) {
2715 $link = $this->makeResourceLoaderLink( $name, $only, $useESI );
2716 $links['html'] .= $link['html'];
2717 $links['states'] += $link['states'];
2718 }
2719 return $links;
2720 }
2721 }
2722
2723 if ( !is_null( $this->mTarget ) ) {
2724 $extraQuery['target'] = $this->mTarget;
2725 }
2726
2727 // Create keyed-by-source and then keyed-by-group list of module objects from modules list
2728 $sortedModules = array();
2729 $resourceLoader = $this->getResourceLoader();
2730 foreach ( $modules as $name ) {
2731 $module = $resourceLoader->getModule( $name );
2732 # Check that we're allowed to include this module on this page
2733 if ( !$module
2734 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS )
2735 && $only == ResourceLoaderModule::TYPE_SCRIPTS )
2736 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES )
2737 && $only == ResourceLoaderModule::TYPE_STYLES )
2738 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_COMBINED )
2739 && $only == ResourceLoaderModule::TYPE_COMBINED )
2740 || ( $this->mTarget && !in_array( $this->mTarget, $module->getTargets() ) )
2741 ) {
2742 continue;
2743 }
2744
2745 $sortedModules[$module->getSource()][$module->getGroup()][$name] = $module;
2746 }
2747
2748 foreach ( $sortedModules as $source => $groups ) {
2749 foreach ( $groups as $group => $grpModules ) {
2750 // Special handling for user-specific groups
2751 $user = null;
2752 if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2753 $user = $this->getUser()->getName();
2754 }
2755
2756 // Create a fake request based on the one we are about to make so modules return
2757 // correct timestamp and emptiness data
2758 $query = ResourceLoader::makeLoaderQuery(
2759 array(), // modules; not determined yet
2760 $this->getLanguage()->getCode(),
2761 $this->getSkin()->getSkinName(),
2762 $user,
2763 null, // version; not determined yet
2764 ResourceLoader::inDebugMode(),
2765 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2766 $this->isPrintable(),
2767 $this->getRequest()->getBool( 'handheld' ),
2768 $extraQuery
2769 );
2770 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2771
2772 // Extract modules that know they're empty
2773 foreach ( $grpModules as $key => $module ) {
2774 // Inline empty modules: since they're empty, just mark them as 'ready' (bug 46857)
2775 // If we're only getting the styles, we don't need to do anything for empty modules.
2776 if ( $module->isKnownEmpty( $context ) ) {
2777 unset( $grpModules[$key] );
2778 if ( $only !== ResourceLoaderModule::TYPE_STYLES ) {
2779 $links['states'][$key] = 'ready';
2780 }
2781 }
2782 }
2783
2784 // If there are no non-empty modules, skip this group
2785 if ( count( $grpModules ) === 0 ) {
2786 continue;
2787 }
2788
2789 // Inline private modules. These can't be loaded through load.php for security
2790 // reasons, see bug 34907. Note that these modules should be loaded from
2791 // getHeadScripts() before the first loader call. Otherwise other modules can't
2792 // properly use them as dependencies (bug 30914)
2793 if ( $group === 'private' ) {
2794 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2795 $links['html'] .= Html::inlineStyle(
2796 $resourceLoader->makeModuleResponse( $context, $grpModules )
2797 );
2798 } else {
2799 $links['html'] .= Html::inlineScript(
2800 $resourceLoader->makeModuleResponse( $context, $grpModules )
2801 );
2802 }
2803 $links['html'] .= "\n";
2804 continue;
2805 }
2806
2807 // Special handling for the user group; because users might change their stuff
2808 // on-wiki like user pages, or user preferences; we need to find the highest
2809 // timestamp of these user-changeable modules so we can ensure cache misses on change
2810 // This should NOT be done for the site group (bug 27564) because anons get that too
2811 // and we shouldn't be putting timestamps in Squid-cached HTML
2812 $version = null;
2813 if ( $group === 'user' ) {
2814 // Get the maximum timestamp
2815 $timestamp = 1;
2816 foreach ( $grpModules as $module ) {
2817 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2818 }
2819 // Add a version parameter so cache will break when things change
2820 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2821 }
2822
2823 $query['modules'] = ResourceLoader::makePackedModulesString( array_keys( $grpModules ) );
2824 $moduleContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2825 $url = $resourceLoader->createLoaderURL( $source, $moduleContext, $extraQuery );
2826
2827 if ( $useESI && $wgResourceLoaderUseESI ) {
2828 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2829 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2830 $link = Html::inlineStyle( $esi );
2831 } else {
2832 $link = Html::inlineScript( $esi );
2833 }
2834 } else {
2835 // Automatically select style/script elements
2836 if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
2837 $link = Html::linkedStyle( $url );
2838 } elseif ( $loadCall ) {
2839 $link = Html::inlineScript(
2840 ResourceLoader::makeLoaderConditionalScript(
2841 Xml::encodeJsCall( 'mw.loader.load', array( $url, 'text/javascript', true ) )
2842 )
2843 );
2844 } else {
2845 $link = Html::linkedScript( $url );
2846
2847 // For modules requested directly in the html via <link> or <script>,
2848 // tell mw.loader they are being loading to prevent duplicate requests.
2849 foreach ( $grpModules as $key => $module ) {
2850 // Don't output state=loading for the startup module..
2851 if ( $key !== 'startup' ) {
2852 $links['states'][$key] = 'loading';
2853 }
2854 }
2855 }
2856 }
2857
2858 if ( $group == 'noscript' ) {
2859 $links['html'] .= Html::rawElement( 'noscript', array(), $link ) . "\n";
2860 } else {
2861 $links['html'] .= $link . "\n";
2862 }
2863 }
2864 }
2865
2866 return $links;
2867 }
2868
2869 /**
2870 * Build html output from an array of links from makeResourceLoaderLink.
2871 * @param array $links
2872 * @return string HTML
2873 */
2874 protected static function getHtmlFromLoaderLinks( array $links ) {
2875 $html = '';
2876 $states = array();
2877 foreach ( $links as $link ) {
2878 if ( !is_array( $link ) ) {
2879 $html .= $link;
2880 } else {
2881 $html .= $link['html'];
2882 $states += $link['states'];
2883 }
2884 }
2885
2886 if ( count( $states ) ) {
2887 $html = Html::inlineScript(
2888 ResourceLoader::makeLoaderConditionalScript(
2889 ResourceLoader::makeLoaderStateScript( $states )
2890 )
2891 ) . "\n" . $html;
2892 }
2893
2894 return $html;
2895 }
2896
2897 /**
2898 * JS stuff to put in the "<head>". This is the startup module, config
2899 * vars and modules marked with position 'top'
2900 *
2901 * @return string HTML fragment
2902 */
2903 function getHeadScripts() {
2904 global $wgResourceLoaderExperimentalAsyncLoading;
2905
2906 // Startup - this will immediately load jquery and mediawiki modules
2907 $links = array();
2908 $links[] = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
2909
2910 // Load config before anything else
2911 $links[] = Html::inlineScript(
2912 ResourceLoader::makeLoaderConditionalScript(
2913 ResourceLoader::makeConfigSetScript( $this->getJSVars() )
2914 )
2915 );
2916
2917 // Load embeddable private modules before any loader links
2918 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2919 // in mw.loader.implement() calls and deferred until mw.user is available
2920 $embedScripts = array( 'user.options', 'user.tokens' );
2921 $links[] = $this->makeResourceLoaderLink( $embedScripts, ResourceLoaderModule::TYPE_COMBINED );
2922
2923 // Scripts and messages "only" requests marked for top inclusion
2924 // Messages should go first
2925 $links[] = $this->makeResourceLoaderLink(
2926 $this->getModuleMessages( true, 'top' ),
2927 ResourceLoaderModule::TYPE_MESSAGES
2928 );
2929 $links[] = $this->makeResourceLoaderLink(
2930 $this->getModuleScripts( true, 'top' ),
2931 ResourceLoaderModule::TYPE_SCRIPTS
2932 );
2933
2934 // Modules requests - let the client calculate dependencies and batch requests as it likes
2935 // Only load modules that have marked themselves for loading at the top
2936 $modules = $this->getModules( true, 'top' );
2937 if ( $modules ) {
2938 $links[] = Html::inlineScript(
2939 ResourceLoader::makeLoaderConditionalScript(
2940 Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2941 )
2942 );
2943 }
2944
2945 if ( $wgResourceLoaderExperimentalAsyncLoading ) {
2946 $links[] = $this->getScriptsForBottomQueue( true );
2947 }
2948
2949 return self::getHtmlFromLoaderLinks( $links );
2950 }
2951
2952 /**
2953 * JS stuff to put at the 'bottom', which can either be the bottom of the
2954 * "<body>" or the bottom of the "<head>" depending on
2955 * $wgResourceLoaderExperimentalAsyncLoading: modules marked with position
2956 * 'bottom', legacy scripts ($this->mScripts), user preferences, site JS
2957 * and user JS.
2958 *
2959 * @param bool $inHead If true, this HTML goes into the "<head>",
2960 * if false it goes into the "<body>".
2961 * @return string
2962 */
2963 function getScriptsForBottomQueue( $inHead ) {
2964 global $wgAllowUserJs;
2965
2966 // Scripts and messages "only" requests marked for bottom inclusion
2967 // If we're in the <head>, use load() calls rather than <script src="..."> tags
2968 // Messages should go first
2969 $links = array();
2970 $links[] = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ),
2971 ResourceLoaderModule::TYPE_MESSAGES, /* $useESI = */ false, /* $extraQuery = */ array(),
2972 /* $loadCall = */ $inHead
2973 );
2974 $links[] = $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
2975 ResourceLoaderModule::TYPE_SCRIPTS, /* $useESI = */ false, /* $extraQuery = */ array(),
2976 /* $loadCall = */ $inHead
2977 );
2978
2979 // Modules requests - let the client calculate dependencies and batch requests as it likes
2980 // Only load modules that have marked themselves for loading at the bottom
2981 $modules = $this->getModules( true, 'bottom' );
2982 if ( $modules ) {
2983 $links[] = Html::inlineScript(
2984 ResourceLoader::makeLoaderConditionalScript(
2985 Xml::encodeJsCall( 'mw.loader.load', array( $modules, null, true ) )
2986 )
2987 );
2988 }
2989
2990 // Legacy Scripts
2991 $links[] = "\n" . $this->mScripts;
2992
2993 // Add site JS if enabled
2994 $links[] = $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS,
2995 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
2996 );
2997
2998 // Add user JS if enabled
2999 if ( $wgAllowUserJs
3000 && $this->getUser()->isLoggedIn()
3001 && $this->getTitle()
3002 && $this->getTitle()->isJsSubpage()
3003 && $this->userCanPreview()
3004 ) {
3005 # XXX: additional security check/prompt?
3006 // We're on a preview of a JS subpage
3007 // Exclude this page from the user module in case it's in there (bug 26283)
3008 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
3009 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() ), $inHead
3010 );
3011 // Load the previewed JS
3012 $links[] = Html::inlineScript( "\n"
3013 . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
3014
3015 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3016 // asynchronously and may arrive *after* the inline script here. So the previewed code
3017 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js...
3018 } else {
3019 // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
3020 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS,
3021 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3022 );
3023 }
3024
3025 // Group JS is only enabled if site JS is enabled.
3026 $links[] = $this->makeResourceLoaderLink( 'user.groups', ResourceLoaderModule::TYPE_COMBINED,
3027 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3028 );
3029
3030 return self::getHtmlFromLoaderLinks( $links );
3031 }
3032
3033 /**
3034 * JS stuff to put at the bottom of the "<body>"
3035 * @return string
3036 */
3037 function getBottomScripts() {
3038 global $wgResourceLoaderExperimentalAsyncLoading;
3039
3040 // Optimise jQuery ready event cross-browser.
3041 // This also enforces $.isReady to be true at </body> which fixes the
3042 // mw.loader bug in Firefox with using document.write between </body>
3043 // and the DOMContentReady event (bug 47457).
3044 $html = Html::inlineScript( 'window.jQuery && jQuery.ready();' );
3045
3046 if ( !$wgResourceLoaderExperimentalAsyncLoading ) {
3047 $html .= $this->getScriptsForBottomQueue( false );
3048 }
3049
3050 return $html;
3051 }
3052
3053 /**
3054 * Get the javascript config vars to include on this page
3055 *
3056 * @return array Array of javascript config vars
3057 * @since 1.23
3058 */
3059 public function getJsConfigVars() {
3060 return $this->mJsConfigVars;
3061 }
3062
3063 /**
3064 * Add one or more variables to be set in mw.config in JavaScript
3065 *
3066 * @param string|array $keys Key or array of key/value pairs
3067 * @param mixed $value [optional] Value of the configuration variable
3068 */
3069 public function addJsConfigVars( $keys, $value = null ) {
3070 if ( is_array( $keys ) ) {
3071 foreach ( $keys as $key => $value ) {
3072 $this->mJsConfigVars[$key] = $value;
3073 }
3074 return;
3075 }
3076
3077 $this->mJsConfigVars[$keys] = $value;
3078 }
3079
3080 /**
3081 * Get an array containing the variables to be set in mw.config in JavaScript.
3082 *
3083 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3084 * - in other words, page-independent/site-wide variables (without state).
3085 * You will only be adding bloat to the html page and causing page caches to
3086 * have to be purged on configuration changes.
3087 * @return array
3088 */
3089 private function getJSVars() {
3090 global $wgContLang;
3091
3092 $curRevisionId = 0;
3093 $articleId = 0;
3094 $canonicalSpecialPageName = false; # bug 21115
3095
3096 $title = $this->getTitle();
3097 $ns = $title->getNamespace();
3098 $canonicalNamespace = MWNamespace::exists( $ns )
3099 ? MWNamespace::getCanonicalName( $ns )
3100 : $title->getNsText();
3101
3102 $sk = $this->getSkin();
3103 // Get the relevant title so that AJAX features can use the correct page name
3104 // when making API requests from certain special pages (bug 34972).
3105 $relevantTitle = $sk->getRelevantTitle();
3106 $relevantUser = $sk->getRelevantUser();
3107
3108 if ( $ns == NS_SPECIAL ) {
3109 list( $canonicalSpecialPageName, /*...*/ ) =
3110 SpecialPageFactory::resolveAlias( $title->getDBkey() );
3111 } elseif ( $this->canUseWikiPage() ) {
3112 $wikiPage = $this->getWikiPage();
3113 $curRevisionId = $wikiPage->getLatest();
3114 $articleId = $wikiPage->getId();
3115 }
3116
3117 $lang = $title->getPageLanguage();
3118
3119 // Pre-process information
3120 $separatorTransTable = $lang->separatorTransformTable();
3121 $separatorTransTable = $separatorTransTable ? $separatorTransTable : array();
3122 $compactSeparatorTransTable = array(
3123 implode( "\t", array_keys( $separatorTransTable ) ),
3124 implode( "\t", $separatorTransTable ),
3125 );
3126 $digitTransTable = $lang->digitTransformTable();
3127 $digitTransTable = $digitTransTable ? $digitTransTable : array();
3128 $compactDigitTransTable = array(
3129 implode( "\t", array_keys( $digitTransTable ) ),
3130 implode( "\t", $digitTransTable ),
3131 );
3132
3133 $user = $this->getUser();
3134
3135 $vars = array(
3136 'wgCanonicalNamespace' => $canonicalNamespace,
3137 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3138 'wgNamespaceNumber' => $title->getNamespace(),
3139 'wgPageName' => $title->getPrefixedDBkey(),
3140 'wgTitle' => $title->getText(),
3141 'wgCurRevisionId' => $curRevisionId,
3142 'wgRevisionId' => (int)$this->getRevisionId(),
3143 'wgArticleId' => $articleId,
3144 'wgIsArticle' => $this->isArticle(),
3145 'wgIsRedirect' => $title->isRedirect(),
3146 'wgAction' => Action::getActionName( $this->getContext() ),
3147 'wgUserName' => $user->isAnon() ? null : $user->getName(),
3148 'wgUserGroups' => $user->getEffectiveGroups(),
3149 'wgCategories' => $this->getCategories(),
3150 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3151 'wgPageContentLanguage' => $lang->getCode(),
3152 'wgPageContentModel' => $title->getContentModel(),
3153 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3154 'wgDigitTransformTable' => $compactDigitTransTable,
3155 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3156 'wgMonthNames' => $lang->getMonthNamesArray(),
3157 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3158 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3159 );
3160
3161 if ( $user->isLoggedIn() ) {
3162 $vars['wgUserId'] = $user->getId();
3163 $vars['wgUserEditCount'] = $user->getEditCount();
3164 $userReg = wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
3165 $vars['wgUserRegistration'] = $userReg !== null ? ( $userReg * 1000 ) : null;
3166 // Get the revision ID of the oldest new message on the user's talk
3167 // page. This can be used for constructing new message alerts on
3168 // the client side.
3169 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3170 }
3171
3172 if ( $wgContLang->hasVariants() ) {
3173 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3174 }
3175 // Same test as SkinTemplate
3176 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3177 && ( $title->exists() || $title->quickUserCan( 'create', $user ) );
3178
3179 foreach ( $title->getRestrictionTypes() as $type ) {
3180 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3181 }
3182
3183 if ( $title->isMainPage() ) {
3184 $vars['wgIsMainPage'] = true;
3185 }
3186
3187 if ( $this->mRedirectedFrom ) {
3188 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom->getPrefixedDBkey();
3189 }
3190
3191 if ( $relevantUser ) {
3192 $vars['wgRelevantUserName'] = $relevantUser->getName();
3193 }
3194
3195 // Allow extensions to add their custom variables to the mw.config map.
3196 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3197 // page-dependant but site-wide (without state).
3198 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3199 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars, $this ) );
3200
3201 // Merge in variables from addJsConfigVars last
3202 return array_merge( $vars, $this->getJsConfigVars() );
3203 }
3204
3205 /**
3206 * To make it harder for someone to slip a user a fake
3207 * user-JavaScript or user-CSS preview, a random token
3208 * is associated with the login session. If it's not
3209 * passed back with the preview request, we won't render
3210 * the code.
3211 *
3212 * @return bool
3213 */
3214 public function userCanPreview() {
3215 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
3216 || !$this->getRequest()->wasPosted()
3217 || !$this->getUser()->matchEditToken(
3218 $this->getRequest()->getVal( 'wpEditToken' ) )
3219 ) {
3220 return false;
3221 }
3222 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
3223 return false;
3224 }
3225
3226 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
3227 }
3228
3229 /**
3230 * @return array Array in format "link name or number => 'link html'".
3231 */
3232 public function getHeadLinksArray() {
3233 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
3234 $wgSitename, $wgVersion,
3235 $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
3236 $wgDisableLangConversion, $wgCanonicalLanguageLinks,
3237 $wgRightsPage, $wgRightsUrl;
3238
3239 $tags = array();
3240
3241 $canonicalUrl = $this->mCanonicalUrl;
3242
3243 $tags['meta-generator'] = Html::element( 'meta', array(
3244 'name' => 'generator',
3245 'content' => "MediaWiki $wgVersion",
3246 ) );
3247
3248 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3249 if ( $p !== 'index,follow' ) {
3250 // http://www.robotstxt.org/wc/meta-user.html
3251 // Only show if it's different from the default robots policy
3252 $tags['meta-robots'] = Html::element( 'meta', array(
3253 'name' => 'robots',
3254 'content' => $p,
3255 ) );
3256 }
3257
3258 foreach ( $this->mMetatags as $tag ) {
3259 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
3260 $a = 'http-equiv';
3261 $tag[0] = substr( $tag[0], 5 );
3262 } else {
3263 $a = 'name';
3264 }
3265 $tagName = "meta-{$tag[0]}";
3266 if ( isset( $tags[$tagName] ) ) {
3267 $tagName .= $tag[1];
3268 }
3269 $tags[$tagName] = Html::element( 'meta',
3270 array(
3271 $a => $tag[0],
3272 'content' => $tag[1]
3273 )
3274 );
3275 }
3276
3277 foreach ( $this->mLinktags as $tag ) {
3278 $tags[] = Html::element( 'link', $tag );
3279 }
3280
3281 # Universal edit button
3282 if ( $wgUniversalEditButton && $this->isArticleRelated() ) {
3283 $user = $this->getUser();
3284 if ( $this->getTitle()->quickUserCan( 'edit', $user )
3285 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create', $user ) ) ) {
3286 // Original UniversalEditButton
3287 $msg = $this->msg( 'edit' )->text();
3288 $tags['universal-edit-button'] = Html::element( 'link', array(
3289 'rel' => 'alternate',
3290 'type' => 'application/x-wiki',
3291 'title' => $msg,
3292 'href' => $this->getTitle()->getEditURL(),
3293 ) );
3294 // Alternate edit link
3295 $tags['alternative-edit'] = Html::element( 'link', array(
3296 'rel' => 'edit',
3297 'title' => $msg,
3298 'href' => $this->getTitle()->getEditURL(),
3299 ) );
3300 }
3301 }
3302
3303 # Generally the order of the favicon and apple-touch-icon links
3304 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3305 # uses whichever one appears later in the HTML source. Make sure
3306 # apple-touch-icon is specified first to avoid this.
3307 if ( $wgAppleTouchIcon !== false ) {
3308 $tags['apple-touch-icon'] = Html::element( 'link', array(
3309 'rel' => 'apple-touch-icon',
3310 'href' => $wgAppleTouchIcon
3311 ) );
3312 }
3313
3314 if ( $wgFavicon !== false ) {
3315 $tags['favicon'] = Html::element( 'link', array(
3316 'rel' => 'shortcut icon',
3317 'href' => $wgFavicon
3318 ) );
3319 }
3320
3321 # OpenSearch description link
3322 $tags['opensearch'] = Html::element( 'link', array(
3323 'rel' => 'search',
3324 'type' => 'application/opensearchdescription+xml',
3325 'href' => wfScript( 'opensearch_desc' ),
3326 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3327 ) );
3328
3329 if ( $wgEnableAPI ) {
3330 # Real Simple Discovery link, provides auto-discovery information
3331 # for the MediaWiki API (and potentially additional custom API
3332 # support such as WordPress or Twitter-compatible APIs for a
3333 # blogging extension, etc)
3334 $tags['rsd'] = Html::element( 'link', array(
3335 'rel' => 'EditURI',
3336 'type' => 'application/rsd+xml',
3337 // Output a protocol-relative URL here if $wgServer is protocol-relative
3338 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
3339 'href' => wfExpandUrl( wfAppendQuery(
3340 wfScript( 'api' ),
3341 array( 'action' => 'rsd' ) ),
3342 PROTO_RELATIVE
3343 ),
3344 ) );
3345 }
3346
3347 # Language variants
3348 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks ) {
3349 $lang = $this->getTitle()->getPageLanguage();
3350 if ( $lang->hasVariants() ) {
3351
3352 $urlvar = $lang->getURLVariant();
3353
3354 if ( !$urlvar ) {
3355 $variants = $lang->getVariants();
3356 foreach ( $variants as $_v ) {
3357 $tags["variant-$_v"] = Html::element( 'link', array(
3358 'rel' => 'alternate',
3359 'hreflang' => wfBCP47( $_v ),
3360 'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
3361 );
3362 }
3363 } else {
3364 $canonicalUrl = $this->getTitle()->getLocalURL();
3365 }
3366 }
3367 }
3368
3369 # Copyright
3370 $copyright = '';
3371 if ( $wgRightsPage ) {
3372 $copy = Title::newFromText( $wgRightsPage );
3373
3374 if ( $copy ) {
3375 $copyright = $copy->getLocalURL();
3376 }
3377 }
3378
3379 if ( !$copyright && $wgRightsUrl ) {
3380 $copyright = $wgRightsUrl;
3381 }
3382
3383 if ( $copyright ) {
3384 $tags['copyright'] = Html::element( 'link', array(
3385 'rel' => 'copyright',
3386 'href' => $copyright )
3387 );
3388 }
3389
3390 # Feeds
3391 if ( $wgFeed ) {
3392 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3393 # Use the page name for the title. In principle, this could
3394 # lead to issues with having the same name for different feeds
3395 # corresponding to the same page, but we can't avoid that at
3396 # this low a level.
3397
3398 $tags[] = $this->feedLink(
3399 $format,
3400 $link,
3401 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3402 $this->msg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )->text()
3403 );
3404 }
3405
3406 # Recent changes feed should appear on every page (except recentchanges,
3407 # that would be redundant). Put it after the per-page feed to avoid
3408 # changing existing behavior. It's still available, probably via a
3409 # menu in your browser. Some sites might have a different feed they'd
3410 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3411 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3412 # If so, use it instead.
3413 if ( $wgOverrideSiteFeed ) {
3414 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
3415 // Note, this->feedLink escapes the url.
3416 $tags[] = $this->feedLink(
3417 $type,
3418 $feedUrl,
3419 $this->msg( "site-{$type}-feed", $wgSitename )->text()
3420 );
3421 }
3422 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3423 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
3424 foreach ( $wgAdvertisedFeedTypes as $format ) {
3425 $tags[] = $this->feedLink(
3426 $format,
3427 $rctitle->getLocalURL( array( 'feed' => $format ) ),
3428 # For grep: 'site-rss-feed', 'site-atom-feed'
3429 $this->msg( "site-{$format}-feed", $wgSitename )->text()
3430 );
3431 }
3432 }
3433 }
3434
3435 # Canonical URL
3436 global $wgEnableCanonicalServerLink;
3437 if ( $wgEnableCanonicalServerLink ) {
3438 if ( $canonicalUrl !== false ) {
3439 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL );
3440 } else {
3441 $reqUrl = $this->getRequest()->getRequestURL();
3442 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL );
3443 }
3444 }
3445 if ( $canonicalUrl !== false ) {
3446 $tags[] = Html::element( 'link', array(
3447 'rel' => 'canonical',
3448 'href' => $canonicalUrl
3449 ) );
3450 }
3451
3452 return $tags;
3453 }
3454
3455 /**
3456 * @return string HTML tag links to be put in the header.
3457 * @deprecated since 1.24 Use OutputPage::headElement or if you have to,
3458 * OutputPage::getHeadLinksArray directly.
3459 */
3460 public function getHeadLinks() {
3461 wfDeprecated( __METHOD__, '1.24' );
3462 return implode( "\n", $this->getHeadLinksArray() );
3463 }
3464
3465 /**
3466 * Generate a "<link rel/>" for a feed.
3467 *
3468 * @param string $type Feed type
3469 * @param string $url URL to the feed
3470 * @param string $text Value of the "title" attribute
3471 * @return string HTML fragment
3472 */
3473 private function feedLink( $type, $url, $text ) {
3474 return Html::element( 'link', array(
3475 'rel' => 'alternate',
3476 'type' => "application/$type+xml",
3477 'title' => $text,
3478 'href' => $url )
3479 );
3480 }
3481
3482 /**
3483 * Add a local or specified stylesheet, with the given media options.
3484 * Meant primarily for internal use...
3485 *
3486 * @param string $style URL to the file
3487 * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
3488 * @param string $condition For IE conditional comments, specifying an IE version
3489 * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
3490 */
3491 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3492 $options = array();
3493 // Even though we expect the media type to be lowercase, but here we
3494 // force it to lowercase to be safe.
3495 if ( $media ) {
3496 $options['media'] = $media;
3497 }
3498 if ( $condition ) {
3499 $options['condition'] = $condition;
3500 }
3501 if ( $dir ) {
3502 $options['dir'] = $dir;
3503 }
3504 $this->styles[$style] = $options;
3505 }
3506
3507 /**
3508 * Adds inline CSS styles
3509 * @param mixed $style_css Inline CSS
3510 * @param string $flip Set to 'flip' to flip the CSS if needed
3511 */
3512 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3513 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3514 # If wanted, and the interface is right-to-left, flip the CSS
3515 $style_css = CSSJanus::transform( $style_css, true, false );
3516 }
3517 $this->mInlineStyles .= Html::inlineStyle( $style_css ) . "\n";
3518 }
3519
3520 /**
3521 * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.
3522 * These will be applied to various media & IE conditionals.
3523 *
3524 * @return string
3525 */
3526 public function buildCssLinks() {
3527 global $wgAllowUserCss, $wgContLang;
3528
3529 $this->getSkin()->setupSkinUserCss( $this );
3530
3531 // Add ResourceLoader styles
3532 // Split the styles into these groups
3533 $styles = array(
3534 'other' => array(),
3535 'user' => array(),
3536 'site' => array(),
3537 'private' => array(),
3538 'noscript' => array()
3539 );
3540 $links = array();
3541 $otherTags = ''; // Tags to append after the normal <link> tags
3542 $resourceLoader = $this->getResourceLoader();
3543
3544 $moduleStyles = $this->getModuleStyles();
3545
3546 // Per-site custom styles
3547 $moduleStyles[] = 'site';
3548 $moduleStyles[] = 'noscript';
3549 $moduleStyles[] = 'user.groups';
3550
3551 // Per-user custom styles
3552 if ( $wgAllowUserCss && $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
3553 // We're on a preview of a CSS subpage
3554 // Exclude this page from the user module in case it's in there (bug 26283)
3555 $link = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
3556 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3557 );
3558 $otherTags .= $link['html'];
3559
3560 // Load the previewed CSS
3561 // If needed, Janus it first. This is user-supplied CSS, so it's
3562 // assumed to be right for the content language directionality.
3563 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3564 if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3565 $previewedCSS = CSSJanus::transform( $previewedCSS, true, false );
3566 }
3567 $otherTags .= Html::inlineStyle( $previewedCSS ) . "\n";
3568 } else {
3569 // Load the user styles normally
3570 $moduleStyles[] = 'user';
3571 }
3572
3573 // Per-user preference styles
3574 $moduleStyles[] = 'user.cssprefs';
3575
3576 foreach ( $moduleStyles as $name ) {
3577 $module = $resourceLoader->getModule( $name );
3578 if ( !$module ) {
3579 continue;
3580 }
3581 $group = $module->getGroup();
3582 // Modules in groups different than the ones listed on top (see $styles assignment)
3583 // will be placed in the "other" group
3584 $styles[isset( $styles[$group] ) ? $group : 'other'][] = $name;
3585 }
3586
3587 // We want site, private and user styles to override dynamically added
3588 // styles from modules, but we want dynamically added styles to override
3589 // statically added styles from other modules. So the order has to be
3590 // other, dynamic, site, private, user. Add statically added styles for
3591 // other modules
3592 $links[] = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
3593 // Add normal styles added through addStyle()/addInlineStyle() here
3594 $links[] = implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
3595 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3596 // We use a <meta> tag with a made-up name for this because that's valid HTML
3597 $links[] = Html::element(
3598 'meta',
3599 array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' )
3600 ) . "\n";
3601
3602 // Add site, private and user styles
3603 // 'private' at present only contains user.options, so put that before 'user'
3604 // Any future private modules will likely have a similar user-specific character
3605 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3606 $links[] = $this->makeResourceLoaderLink( $styles[$group],
3607 ResourceLoaderModule::TYPE_STYLES
3608 );
3609 }
3610
3611 // Add stuff in $otherTags (previewed user CSS if applicable)
3612 return self::getHtmlFromLoaderLinks( $links ) . $otherTags;
3613 }
3614
3615 /**
3616 * @return array
3617 */
3618 public function buildCssLinksArray() {
3619 $links = array();
3620
3621 // Add any extension CSS
3622 foreach ( $this->mExtStyles as $url ) {
3623 $this->addStyle( $url );
3624 }
3625 $this->mExtStyles = array();
3626
3627 foreach ( $this->styles as $file => $options ) {
3628 $link = $this->styleLink( $file, $options );
3629 if ( $link ) {
3630 $links[$file] = $link;
3631 }
3632 }
3633 return $links;
3634 }
3635
3636 /**
3637 * Generate \<link\> tags for stylesheets
3638 *
3639 * @param string $style URL to the file
3640 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3641 * @return string HTML fragment
3642 */
3643 protected function styleLink( $style, array $options ) {
3644 if ( isset( $options['dir'] ) ) {
3645 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3646 return '';
3647 }
3648 }
3649
3650 if ( isset( $options['media'] ) ) {
3651 $media = self::transformCssMedia( $options['media'] );
3652 if ( is_null( $media ) ) {
3653 return '';
3654 }
3655 } else {
3656 $media = 'all';
3657 }
3658
3659 if ( substr( $style, 0, 1 ) == '/' ||
3660 substr( $style, 0, 5 ) == 'http:' ||
3661 substr( $style, 0, 6 ) == 'https:' ) {
3662 $url = $style;
3663 } else {
3664 global $wgStylePath, $wgStyleVersion;
3665 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3666 }
3667
3668 $link = Html::linkedStyle( $url, $media );
3669
3670 if ( isset( $options['condition'] ) ) {
3671 $condition = htmlspecialchars( $options['condition'] );
3672 $link = "<!--[if $condition]>$link<![endif]-->";
3673 }
3674 return $link;
3675 }
3676
3677 /**
3678 * Transform "media" attribute based on request parameters
3679 *
3680 * @param string $media Current value of the "media" attribute
3681 * @return string Modified value of the "media" attribute, or null to skip
3682 * this stylesheet
3683 */
3684 public static function transformCssMedia( $media ) {
3685 global $wgRequest;
3686
3687 // http://www.w3.org/TR/css3-mediaqueries/#syntax
3688 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3689
3690 // Switch in on-screen display for media testing
3691 $switches = array(
3692 'printable' => 'print',
3693 'handheld' => 'handheld',
3694 );
3695 foreach ( $switches as $switch => $targetMedia ) {
3696 if ( $wgRequest->getBool( $switch ) ) {
3697 if ( $media == $targetMedia ) {
3698 $media = '';
3699 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3700 // This regex will not attempt to understand a comma-separated media_query_list
3701 //
3702 // Example supported values for $media:
3703 // 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3704 // Example NOT supported value for $media:
3705 // '3d-glasses, screen, print and resolution > 90dpi'
3706 //
3707 // If it's a print request, we never want any kind of screen stylesheets
3708 // If it's a handheld request (currently the only other choice with a switch),
3709 // we don't want simple 'screen' but we might want screen queries that
3710 // have a max-width or something, so we'll pass all others on and let the
3711 // client do the query.
3712 if ( $targetMedia == 'print' || $media == 'screen' ) {
3713 return null;
3714 }
3715 }
3716 }
3717 }
3718
3719 return $media;
3720 }
3721
3722 /**
3723 * Add a wikitext-formatted message to the output.
3724 * This is equivalent to:
3725 *
3726 * $wgOut->addWikiText( wfMessage( ... )->plain() )
3727 */
3728 public function addWikiMsg( /*...*/ ) {
3729 $args = func_get_args();
3730 $name = array_shift( $args );
3731 $this->addWikiMsgArray( $name, $args );
3732 }
3733
3734 /**
3735 * Add a wikitext-formatted message to the output.
3736 * Like addWikiMsg() except the parameters are taken as an array
3737 * instead of a variable argument list.
3738 *
3739 * @param string $name
3740 * @param array $args
3741 */
3742 public function addWikiMsgArray( $name, $args ) {
3743 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3744 }
3745
3746 /**
3747 * This function takes a number of message/argument specifications, wraps them in
3748 * some overall structure, and then parses the result and adds it to the output.
3749 *
3750 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3751 * on. The subsequent arguments may either be strings, in which case they are the
3752 * message names, or arrays, in which case the first element is the message name,
3753 * and subsequent elements are the parameters to that message.
3754 *
3755 * Don't use this for messages that are not in users interface language.
3756 *
3757 * For example:
3758 *
3759 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3760 *
3761 * Is equivalent to:
3762 *
3763 * $wgOut->addWikiText( "<div class='error'>\n"
3764 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
3765 *
3766 * The newline after opening div is needed in some wikitext. See bug 19226.
3767 *
3768 * @param string $wrap
3769 */
3770 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3771 $msgSpecs = func_get_args();
3772 array_shift( $msgSpecs );
3773 $msgSpecs = array_values( $msgSpecs );
3774 $s = $wrap;
3775 foreach ( $msgSpecs as $n => $spec ) {
3776 if ( is_array( $spec ) ) {
3777 $args = $spec;
3778 $name = array_shift( $args );
3779 if ( isset( $args['options'] ) ) {
3780 unset( $args['options'] );
3781 wfDeprecated(
3782 'Adding "options" to ' . __METHOD__ . ' is no longer supported',
3783 '1.20'
3784 );
3785 }
3786 } else {
3787 $args = array();
3788 $name = $spec;
3789 }
3790 $s = str_replace( '$' . ( $n + 1 ), $this->msg( $name, $args )->plain(), $s );
3791 }
3792 $this->addWikiText( $s );
3793 }
3794
3795 /**
3796 * Include jQuery core. Use this to avoid loading it multiple times
3797 * before we get a usable script loader.
3798 *
3799 * @param array $modules List of jQuery modules which should be loaded
3800 * @return array The list of modules which were not loaded.
3801 * @since 1.16
3802 * @deprecated since 1.17
3803 */
3804 public function includeJQuery( array $modules = array() ) {
3805 return array();
3806 }
3807
3808 /**
3809 * Enables/disables TOC, doesn't override __NOTOC__
3810 * @param bool $flag
3811 * @since 1.22
3812 */
3813 public function enableTOC( $flag = true ) {
3814 $this->mEnableTOC = $flag;
3815 }
3816
3817 /**
3818 * @return bool
3819 * @since 1.22
3820 */
3821 public function isTOCEnabled() {
3822 return $this->mEnableTOC;
3823 }
3824
3825 /**
3826 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3827 * @param bool $flag
3828 * @since 1.23
3829 */
3830 public function enableSectionEditLinks( $flag = true ) {
3831 $this->mEnableSectionEditLinks = $flag;
3832 }
3833
3834 /**
3835 * @return bool
3836 * @since 1.23
3837 */
3838 public function sectionEditLinksEnabled() {
3839 return $this->mEnableSectionEditLinks;
3840 }
3841 }