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