MediaWiki  master
LanguageCode.php
Go to the documentation of this file.
1 <?php
21 use Wikimedia\Bcp47Code\Bcp47Code;
22 use Wikimedia\Bcp47Code\Bcp47CodeValue;
23 
30 class LanguageCode {
42  private const DEPRECATED_LANGUAGE_CODE_MAPPING = [
43  // Note that als is actually a valid ISO 639 code (Tosk Albanian), but it
44  // was previously used in MediaWiki for Alsatian, which comes under gsw
45  'als' => 'gsw', // T25215
46  'bat-smg' => 'sgs', // T27522
47  'be-x-old' => 'be-tarask', // T11823
48  'fiu-vro' => 'vro', // T31186
49  'roa-rup' => 'rup', // T17988
50  'zh-classical' => 'lzh', // T30443
51  'zh-min-nan' => 'nan', // T30442
52  'zh-yue' => 'yue', // T30441
53  ];
54 
81  private const NON_STANDARD_LANGUAGE_CODE_MAPPING = [
82  // All codes returned by LanguageNameUtils::getLanguageNames() validated
83  // against IANA registry at
84  // https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
85  // with help of validator at
86  // http://schneegans.de/lv/
87  'cbk-zam' => 'cbk', // T124657
88  'de-formal' => 'de-x-formal',
89  'eml' => 'egl', // T36217
90  'en-rtl' => 'en-x-rtl',
91  'es-formal' => 'es-x-formal',
92  'hu-formal' => 'hu-x-formal',
93  'map-bms' => 'jv-x-bms', // [[en:Banyumasan_dialect]] T125073
94  'mo' => 'ro-Cyrl-MD', // T125073
95  'nrm' => 'nrf', // [[en:Norman_language]] T25216
96  'nl-informal' => 'nl-x-informal',
97  'roa-tara' => 'nap-x-tara', // [[en:Tarantino_dialect]]
98  'simple' => 'en-simple',
99  'sr-ec' => 'sr-Cyrl', // T117845
100  'sr-el' => 'sr-Latn', // T117845
101 
102  // Although these next codes aren't *wrong* per se, including
103  // both the script and the country code helps compatibility with
104  // other BCP 47 users. Note that MW also uses
105  // `kk-Arab`/`kk-Cyrl`/`kk-Latn`, `zh-Hans`/`zh-Hant`,
106  // without a country code, and those should be left alone.
107  // `kk` has the Suppress-Script: Cyrl field, so `kk-KZ` won't be mapped
108  // to `kk-Cyrl-KZ`.
109  // (See getVariantsFallbacks() in KkConverter.php for Arab/Cyrl/Latn id.)
110  // (See getVariantsFallbacks() in ZhConverter.php for Hans/Hant id.)
111  'kk-cn' => 'kk-Arab-CN',
112  'kk-tr' => 'kk-Latn-TR',
113  'zh-cn' => 'zh-Hans-CN',
114  'zh-sg' => 'zh-Hans-SG',
115  'zh-my' => 'zh-Hans-MY',
116  'zh-tw' => 'zh-Hant-TW',
117  'zh-hk' => 'zh-Hant-HK',
118  'zh-mo' => 'zh-Hant-MO',
119  ];
120 
133  public static function getDeprecatedCodeMapping() {
134  return self::DEPRECATED_LANGUAGE_CODE_MAPPING;
135  }
136 
149  public static function getNonstandardLanguageCodeMapping() {
150  static $result = [];
151  if ( $result ) {
152  return $result;
153  }
154  foreach ( self::DEPRECATED_LANGUAGE_CODE_MAPPING as $code => $ignore ) {
155  $result[$code] = self::bcp47( $code );
156  }
157  foreach ( self::NON_STANDARD_LANGUAGE_CODE_MAPPING as $code => $ignore ) {
158  $result[$code] = self::bcp47( $code );
159  }
160  return $result;
161  }
162 
173  public static function replaceDeprecatedCodes( $code ) {
174  return self::DEPRECATED_LANGUAGE_CODE_MAPPING[$code] ?? $code;
175  }
176 
187  public static function bcp47( $code ) {
188  $code = self::replaceDeprecatedCodes( strtolower( $code ) );
189  if ( isset( self::NON_STANDARD_LANGUAGE_CODE_MAPPING[$code] ) ) {
190  $code = self::NON_STANDARD_LANGUAGE_CODE_MAPPING[$code];
191  }
192  $codeSegment = explode( '-', $code );
193  $codeBCP = [];
194  foreach ( $codeSegment as $segNo => $seg ) {
195  // when previous segment is x, it is a private segment and should be lc
196  if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
197  $codeBCP[$segNo] = strtolower( $seg );
198  // ISO 3166 country code
199  } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
200  $codeBCP[$segNo] = strtoupper( $seg );
201  // ISO 15924 script code
202  } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
203  $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
204  // Use lowercase for other cases
205  } else {
206  $codeBCP[$segNo] = strtolower( $seg );
207  }
208  }
209  $langCode = implode( '-', $codeBCP );
210  return $langCode;
211  }
212 
231  public static function bcp47ToInternal( string $code ): string {
232  static $invertedLookup = [];
233  if ( !$invertedLookup ) {
234  // There should never be two different entries in
235  // NON_STANDARD_LANGUAGE_CODE_MAPPING which map *different*
236  // internal codes to the same external BCP-47 code. That is,
237  // BCP-47 should preserve all the information from the internal
238  // code (discussed further above)[*]. But note the converse isn't
239  // true: multiple BCP-47 codes can alias to the same internal code:
240  // BCP-47 internal
241  // zh-Hans-CN => zh-cn (in NON_STANDARD_LANGUAGE_CODE_MAPPING)
242  // zh-Hans => zh-hans (not in " )
243  // zh-CN => zh-cn (not in " )
244  //
245  // [*] eml/egl are the "exception that proves the rule": `egl` *is*
246  // (prematurely?) defined as an internal code, but only
247  // eml.wikipedia.org exists, and it defines its language as `eml`;
248  // for internal purposes `egl` should map back into `eml` until
249  // `eml` is deprecated (aka an `eml => egl` entry is added to
250  // DEPRECATED_LANGUAGE_CODE_MAPPING): T36217.
251  foreach ( self::NON_STANDARD_LANGUAGE_CODE_MAPPING as $internal => $bcp47 ) {
252  $invertedLookup[strtolower( $bcp47 )] = $internal;
253  }
254  // We deliberately do *not* use DEPRECATED_LANGUAGE_CODE_MAPPING
255  // here: deprecated codes are no longer valid mediawiki internal
256  // codes and we should never return them.
257  }
258  // Internal codes are all lowercase. This also achieves
259  // case-insensitivity in the lookup.
260  $code = strtolower( $code );
261  return $invertedLookup[$code] ?? $code;
262  }
263 
276  public static function normalizeNonstandardCodeAndWarn( string $code ): Bcp47Code {
277  $compatMap = self::getNonstandardLanguageCodeMapping();
278  if ( isset( $compatMap[strtolower( $code )] ) ) {
279  // Backward compatibility, since clients may have been
280  // sending us non-standards-compliant
281  // "mediawiki internal language codes"; eventually we'll
282  // emit a logged warning here.
283  $code = $compatMap[strtolower( $code )];
284  }
285  return new Bcp47CodeValue( $code );
286  }
287 
303  public static function isWellFormedLanguageTag( string $code, bool $lenient = false ): bool {
304  $alpha = '[a-z]';
305  $digit = '[0-9]';
306  $alphanum = '[a-z0-9]';
307  $x = 'x'; # private use singleton
308  $singleton = '[a-wy-z]'; # other singleton
309  $s = $lenient ? '[-_]' : '-';
310 
311  $language = "$alpha{2,8}|$alpha{2,3}$s$alpha{3}";
312  $script = "$alpha{4}"; # ISO 15924
313  $region = "(?:$alpha{2}|$digit{3})"; # ISO 3166-1 alpha-2 or UN M.49
314  $variant = "(?:$alphanum{5,8}|$digit$alphanum{3})";
315  $extension = "$singleton(?:$s$alphanum{2,8})+";
316  $privateUse = "$x(?:$s$alphanum{1,8})+";
317 
318  # Define certain legacy language tags (marked as “Type: grandfathered” in BCP 47),
319  # since otherwise the regex is pretty useless.
320  # Since these are limited, this is safe even later changes to the registry --
321  # the only oddity is that it might change the type of the tag, and thus
322  # the results from the capturing groups.
323  # https://www.iana.org/assignments/language-subtag-registry
324 
325  $legacy = "en{$s}GB{$s}oed"
326  . "|i{$s}(?:ami|bnn|default|enochian|hak|klingon|lux|mingo|navajo|pwn|tao|tay|tsu)"
327  . "|no{$s}(?:bok|nyn)"
328  . "|sgn{$s}(?:BE{$s}(?:fr|nl)|CH{$s}de)"
329  . "|zh{$s}min{$s}nan";
330 
331  $variantList = "$variant(?:$s$variant)*";
332  $extensionList = "$extension(?:$s$extension)*";
333 
334  $langtag = "(?:($language)"
335  . "(?:$s$script)?"
336  . "(?:$s$region)?"
337  . "(?:$s$variantList)?"
338  . "(?:$s$extensionList)?"
339  . "(?:$s$privateUse)?)";
340 
341  # Here is the final breakdown, with capturing groups for each of these components
342  # The variants, extensions, legacy, and private-use may have interior '-'
343 
344  $root = "^(?:$langtag|$privateUse|$legacy)$";
345 
346  return preg_match( "/$root/", strtolower( $code ) );
347  }
348 }
Methods for dealing with language codes.
static getNonstandardLanguageCodeMapping()
Returns a mapping of non-standard language codes used by (current and previous version of) MediaWiki,...
static normalizeNonstandardCodeAndWarn(string $code)
We want to eventually require valid BCP-47 codes on HTTP and HTML APIs (where the standards require i...
static replaceDeprecatedCodes( $code)
Replace deprecated language codes that were used in previous versions of MediaWiki to up-to-date,...
static getDeprecatedCodeMapping()
Returns a mapping of deprecated language codes that were used in previous versions of MediaWiki to up...
static bcp47( $code)
Get the normalised IANA language tag See unit test for examples.
static bcp47ToInternal(string $code)
Convert standardized BCP 47 codes to the internal names used by MediaWiki and returned by Language::g...
static isWellFormedLanguageTag(string $code, bool $lenient=false)
Returns true if a language code string is a well-formed language tag according to RFC 5646.
foreach( $mmfl['setupFiles'] as $fileName) if( $queue) if(empty( $mmfl['quiet'])) $s