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