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