use Wikimedia\WrappedStringList;
/**
- * This class should be covered by a general architecture document which does
- * not exist as of January 2011. This is one of the Core classes and should
- * be read at least once by any new developers.
+ * This is one of the Core classes and should
+ * be read at least once by any new developers. Also documented at
+ * https://www.mediawiki.org/wiki/Manual:Architectural_modules/OutputPage
*
* This class is used to prepare the final rendering. A skin is then
* applied to the output parameters (links, javascript, html, categories ...).
private $mFollowPolicy = 'follow';
/**
- * @var array Headers that cause the cache to vary. Key is header name, value is an array of
- * options for the Key header.
+ * @var array Headers that cause the cache to vary. Key is header name,
+ * value should always be null. (Value was an array of options for
+ * the `Key` header, which was deprecated in 1.32 and removed in 1.34.)
*/
private $mVaryHeader = [
- 'Accept-Encoding' => [ 'match=gzip' ],
+ 'Accept-Encoding' => null,
];
/**
* @param string|null $unused Previously used to change the cache-busting query parameter
*/
public function addScriptFile( $file, $unused = null ) {
- if ( substr( $file, 0, 1 ) !== '/' && !preg_match( '#^[a-z]*://#i', $file ) ) {
- // This is not an absolute path, protocol-relative url, or full scheme url,
- // presumed to be an old call intended to include a file from /w/skins/common,
- // which doesn't exist anymore as of MediaWiki 1.24 per T71277. Ignore.
- wfDeprecated( __METHOD__, '1.24' );
- return;
- }
$this->addScript( Html::linkedScript( $file, $this->getCSPNonce() ) );
}
return $this->mImageTimeKeys;
}
- /**
- * Convert wikitext to HTML and add it to the buffer
- * Default assumes that the current page title will be used.
- *
- * @param string $text
- * @param bool $linestart Is this the start of a line?
- * @param bool $interface Is this text in the user interface language?
- * @throws MWException
- * @deprecated since 1.32 due to untidy output; use
- * addWikiTextAsInterface() if $interface is default value or true,
- * or else addWikiTextAsContent() if $interface is false.
- */
- public function addWikiText( $text, $linestart = true, $interface = true ) {
- wfDeprecated( __METHOD__, '1.32' );
- $title = $this->getTitle();
- if ( !$title ) {
- throw new MWException( 'Title is null' );
- }
- $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/false, $interface );
- }
-
/**
* Convert wikitext *in the user interface language* to HTML and
* add it to the buffer. The result will not be
if ( !$title ) {
throw new MWException( 'Title is null' );
}
- $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/true );
+ $this->addWikiTextTitleInternal( $text, $title, $linestart, /*interface*/true );
}
/**
) {
$this->addWikiTextTitleInternal(
$text, $this->getTitle(),
- /*linestart*/true, /*tidy*/true, /*interface*/true,
+ /*linestart*/true, /*interface*/true,
$wrapperClass
);
}
if ( !$title ) {
throw new MWException( 'Title is null' );
}
- $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/false );
- }
-
- /**
- * Add wikitext with a custom Title object
- *
- * @param string $text Wikitext
- * @param Title $title
- * @param bool $linestart Is this the start of a line?
- * @deprecated since 1.32 due to untidy output; use
- * addWikiTextAsInterface()
- */
- public function addWikiTextWithTitle( $text, Title $title, $linestart = true ) {
- wfDeprecated( __METHOD__, '1.32' );
- $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/false, /*interface*/false );
- }
-
- /**
- * Add wikitext *in content language* with a custom Title object.
- * Output will be tidy.
- *
- * @param string $text Wikitext in content language
- * @param Title $title
- * @param bool $linestart Is this the start of a line?
- * @deprecated since 1.32 to rename methods consistently; use
- * addWikiTextAsContent()
- */
- function addWikiTextTitleTidy( $text, Title $title, $linestart = true ) {
- wfDeprecated( __METHOD__, '1.32' );
- $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/false );
- }
-
- /**
- * Add wikitext *in content language*. Output will be tidy.
- *
- * @param string $text Wikitext in content language
- * @param bool $linestart Is this the start of a line?
- * @deprecated since 1.32 to rename methods consistently; use
- * addWikiTextAsContent()
- */
- public function addWikiTextTidy( $text, $linestart = true ) {
- wfDeprecated( __METHOD__, '1.32' );
- $title = $this->getTitle();
- if ( !$title ) {
- throw new MWException( 'Title is null' );
- }
- $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/false );
- }
-
- /**
- * Add wikitext with a custom Title object.
- * Output is unwrapped.
- *
- * @param string $text Wikitext
- * @param Title $title
- * @param bool $linestart Is this the start of a line?
- * @param bool $tidy Whether to use tidy.
- * Setting this to false (or omitting it) is deprecated
- * since 1.32; all wikitext should be tidied.
- * For backwards-compatibility with prior MW releases,
- * you may wish to invoke this method but set $tidy=true;
- * this will result in equivalent output to the non-deprecated
- * addWikiTextAsContent()/addWikiTextAsInterface() methods.
- * @param bool $interface Whether it is an interface message
- * (for example disables conversion)
- * @deprecated since 1.32, use addWikiTextAsContent() or
- * addWikiTextAsInterface() (depending on $interface)
- */
- public function addWikiTextTitle( $text, Title $title, $linestart,
- $tidy = false, $interface = false
- ) {
- wfDeprecated( __METHOD__, '1.32' );
- return $this->addWikiTextTitleInternal( $text, $title, $linestart, $tidy, $interface );
+ $this->addWikiTextTitleInternal( $text, $title, $linestart, /*interface*/false );
}
/**
* @private
*/
private function addWikiTextTitleInternal(
- $text, Title $title, $linestart, $tidy, $interface, $wrapperClass = null
+ $text, Title $title, $linestart, $interface, $wrapperClass = null
) {
- if ( !$tidy ) {
- wfDeprecated( 'disabling tidy', '1.32' );
- }
-
$parserOutput = $this->parseInternal(
- $text, $title, $linestart, $tidy, $interface, /*language*/null
+ $text, $title, $linestart, true, $interface, /*language*/null
);
$this->addParserOutput( $parserOutput, [
* Add an HTTP header that will influence on the cache
*
* @param string $header Header name
- * @param string[]|null $option Options for the Key header. See
- * https://datatracker.ietf.org/doc/draft-fielding-http-key/
- * for the list of valid options.
+ * @param string[]|null $option Deprecated; formerly options for the
+ * Key header, deprecated in 1.32 and removed in 1.34. See
+ * https://datatracker.ietf.org/doc/draft-fielding-http-key/
+ * for the list of formerly-valid options.
*/
public function addVaryHeader( $header, array $option = null ) {
- if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
- $this->mVaryHeader[$header] = [];
+ if ( $option !== null && count( $option ) > 0 ) {
+ wfDeprecated( 'addVaryHeader $option is ignored', '1.34' );
}
- if ( !is_array( $option ) ) {
- $option = [];
+ if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
+ $this->mVaryHeader[$header] = null;
}
- $this->mVaryHeader[$header] =
- array_unique( array_merge( $this->mVaryHeader[$header], $option ) );
}
/**
}
/**
- * Get a complete Key header
- *
- * @return string
- * @deprecated in 1.32; the IETF spec for this header expired w/o becoming
- * a standard.
- */
- public function getKeyHeader() {
- wfDeprecated( '$wgUseKeyHeader', '1.32' );
-
- $cvCookies = $this->getCacheVaryCookies();
-
- $cookiesOption = [];
- foreach ( $cvCookies as $cookieName ) {
- $cookiesOption[] = 'param=' . $cookieName;
- }
- $this->addVaryHeader( 'Cookie', $cookiesOption );
-
- foreach ( SessionManager::singleton()->getVaryHeaders() as $header => $options ) {
- $this->addVaryHeader( $header, $options );
- }
-
- $headers = [];
- foreach ( $this->mVaryHeader as $header => $option ) {
- $newheader = $header;
- if ( is_array( $option ) && count( $option ) > 0 ) {
- $newheader .= ';' . implode( ';', $option );
- }
- $headers[] = $newheader;
- }
- $key = 'Key: ' . implode( ',', $headers );
-
- return $key;
- }
-
- /**
- * T23672: Add Accept-Language to Vary and Key headers if there's no 'variant' parameter in GET.
+ * T23672: Add Accept-Language to Vary header if there's no 'variant' parameter in GET.
*
* For example:
* /w/index.php?title=Main_page will vary based on Accept-Language; but
$lang = $title->getPageLanguage();
if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
- $variants = $lang->getVariants();
- $aloption = [];
- foreach ( $variants as $variant ) {
- if ( $variant === $lang->getCode() ) {
- continue;
- }
-
- // XXX Note that this code is not strictly correct: we
- // do a case-insensitive match in
- // LanguageConverter::getHeaderVariant() while the
- // (abandoned, draft) spec for the `Key` header only
- // allows case-sensitive matches. To match the logic
- // in LanguageConverter::getHeaderVariant() we should
- // also be looking at fallback variants and deprecated
- // mediawiki-internal codes, as well as BCP 47
- // normalized forms.
-
- $aloption[] = "substr=$variant";
-
- // IE and some other browsers use BCP 47 standards in their Accept-Language header,
- // like "zh-CN" or "zh-Hant". We should handle these too.
- $variantBCP47 = LanguageCode::bcp47( $variant );
- if ( $variantBCP47 !== $variant ) {
- $aloption[] = "substr=$variantBCP47";
- }
- }
- $this->addVaryHeader( 'Accept-Language', $aloption );
+ $this->addVaryHeader( 'Accept-Language' );
}
}
# maintain different caches for logged-in users and non-logged in ones
$response->header( $this->getVaryHeader() );
- if ( $config->get( 'UseKeyHeader' ) ) {
- $response->header( $this->getKeyHeader() );
- }
-
if ( $this->mEnableClientCache ) {
if (
$config->get( 'UseCdn' ) &&
* @return string The doctype, opening "<html>", and head element.
*/
public function headElement( Skin $sk, $includeStyle = true ) {
+ $config = $this->getConfig();
$userdir = $this->getLanguage()->getDir();
$sitedir = MediaWikiServices::getInstance()->getContentLanguage()->getDir();
$this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
}
- if ( !Html::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
+ if ( !Html::isXmlMimeType( $config->get( 'MimeType' ) ) ) {
// Add <meta charset="UTF-8">
// This should be before <title> since it defines the charset used by
// text including the text inside <title>.
$pieces = array_merge( $pieces, array_values( $this->getHeadLinksArray() ) );
$pieces = array_merge( $pieces, array_values( $this->mHeadItems ) );
+ // This library is intended to run on older browsers that MediaWiki no longer
+ // supports as Grade A. For these Grade C browsers, we provide an experience
+ // using only HTML and CSS. Where standards-compliant browsers are able to style
+ // unknown HTML elements without issue, old IE ignores these styles.
+ // The html5shiv library fixes that.
// Use an IE conditional comment to serve the script only to old IE
+ $shivUrl = $config->get( 'ResourceBasePath' ) . '/resources/lib/html5shiv/html5shiv.js';
$pieces[] = '<!--[if lt IE 9]>' .
- ResourceLoaderClientHtml::makeLoad(
- new ResourceLoaderContext(
- $this->getResourceLoader(),
- new FauxRequest( [] )
- ),
- [ 'html5shiv' ],
- ResourceLoaderModule::TYPE_SCRIPTS,
- [ 'raw' => '1', 'sync' => '1' ],
- $this->getCSPNonce()
- ) .
+ Html::linkedScript( $shivUrl, $this->getCSPNonce() ) .
'<![endif]-->';
$pieces[] = Html::closeElement( 'head' );
*/
protected function buildExemptModules() {
$chunks = [];
- // Things that go after the ResourceLoaderDynamicStyles marker
- $append = [];
- // We want site, private and user styles to override dynamically added styles from
- // general modules, but we want dynamically added styles to override statically added
- // style modules. So the order has to be:
- // - page style modules (formatted by ResourceLoaderClientHtml::getHeadHtml())
- // - dynamically loaded styles (added by mw.loader before ResourceLoaderDynamicStyles)
- // - ResourceLoaderDynamicStyles marker
- // - site/private/user styles
+ // Requirements:
+ // - Within modules provided by the software (core, skin, extensions),
+ // styles from skin stylesheets should be overridden by styles
+ // from modules dynamically loaded with JavaScript.
+ // - Styles from site-specific, private, and user modules should override
+ // both of the above.
+ //
+ // The effective order for stylesheets must thus be:
+ // 1. Page style modules, formatted server-side by ResourceLoaderClientHtml.
+ // 2. Dynamically-loaded styles, inserted client-side by mw.loader.
+ // 3. Styles that are site-specific, private or from the user, formatted
+ // server-side by this function.
+ //
+ // The 'ResourceLoaderDynamicStyles' marker helps JavaScript know where
+ // point #2 is.
// Add legacy styles added through addStyle()/addInlineStyle() here
$chunks[] = implode( '', $this->buildCssLinksArray() ) . $this->mInlineStyles;
- $chunks[] = Html::element(
- 'meta',
- [ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
- );
-
+ // Things that go after the ResourceLoaderDynamicStyles marker
+ $append = [];
$separateReq = [ 'site.styles', 'user.styles' ];
foreach ( $this->rlExemptStyleModules as $group => $moduleNames ) {
- // Combinable modules
- $chunks[] = $this->makeResourceLoaderLink(
- array_diff( $moduleNames, $separateReq ),
- ResourceLoaderModule::TYPE_STYLES
- );
-
- foreach ( array_intersect( $moduleNames, $separateReq ) as $name ) {
- // These require their own dedicated request in order to support "@import"
- // syntax, which is incompatible with concatenation. (T147667, T37562)
- $chunks[] = $this->makeResourceLoaderLink( $name,
+ if ( $moduleNames ) {
+ $append[] = $this->makeResourceLoaderLink(
+ array_diff( $moduleNames, $separateReq ),
ResourceLoaderModule::TYPE_STYLES
);
+
+ foreach ( array_intersect( $moduleNames, $separateReq ) as $name ) {
+ // These require their own dedicated request in order to support "@import"
+ // syntax, which is incompatible with concatenation. (T147667, T37562)
+ $append[] = $this->makeResourceLoaderLink( $name,
+ ResourceLoaderModule::TYPE_STYLES
+ );
+ }
}
}
+ if ( $append ) {
+ $chunks[] = Html::element(
+ 'meta',
+ [ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
+ );
+ $chunks = array_merge( $chunks, $append );
+ }
- return self::combineWrappedStrings( array_merge( $chunks, $append ) );
+ return self::combineWrappedStrings( $chunks );
}
/**
if ( is_array( $spec ) ) {
$args = $spec;
$name = array_shift( $args );
- if ( isset( $args['options'] ) ) {
- unset( $args['options'] );
- wfDeprecated(
- 'Adding "options" to ' . __METHOD__ . ' is no longer supported',
- '1.20'
- );
- }
} else {
$args = [];
$name = $spec;
return $this->mEnableTOC;
}
- /**
- * Enables/disables section edit links, doesn't override __NOEDITSECTION__
- * @param bool $flag
- * @since 1.23
- * @deprecated since 1.31, use $poOptions to addParserOutput() instead.
- */
- public function enableSectionEditLinks( $flag = true ) {
- wfDeprecated( __METHOD__, '1.31' );
- }
-
/**
* Helper function to setup the PHP implementation of OOUI to use in this request.
*
$this->addModuleStyles( [
'oojs-ui-core.styles',
'oojs-ui.styles.indicators',
- 'oojs-ui.styles.textures',
'mediawiki.widgets.styles',
'oojs-ui-core.icons',
] );
dépôts / lhc / web / wiklou.git / blobdiff