Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
78.46% covered (warning)
78.46%
51 / 65
57.14% covered (warning)
57.14%
4 / 7
CRAP
0.00% covered (danger)
0.00%
0 / 1
LanguageCode
78.46% covered (warning)
78.46%
51 / 65
57.14% covered (warning)
57.14%
4 / 7
29.76
0.00% covered (danger)
0.00%
0 / 1
 getDeprecatedCodeMapping
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getNonstandardLanguageCodeMapping
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
20
 replaceDeprecatedCodes
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 bcp47
100.00% covered (success)
100.00%
14 / 14
100.00% covered (success)
100.00%
1 / 1
9
 bcp47ToInternal
80.00% covered (warning)
80.00%
8 / 10
0.00% covered (danger)
0.00%
0 / 1
5.20
 normalizeNonstandardCodeAndWarn
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 isWellFormedLanguageTag
100.00% covered (success)
100.00%
27 / 27
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21use Wikimedia\Bcp47Code\Bcp47Code;
22use Wikimedia\Bcp47Code\Bcp47CodeValue;
23
24/**
25 * Methods for dealing with language codes.
26 *
27 * @since 1.29
28 * @ingroup Language
29 */
30class LanguageCode {
31    /**
32     * Mapping of deprecated language codes that were used in previous
33     * versions of MediaWiki to up-to-date, current language codes.
34     * These may or may not be valid BCP 47 codes; they are included here
35     * because MediaWiki renamed these particular codes at some point.
36     *
37     * @var array Mapping from deprecated MediaWiki-internal language code
38     *   to replacement MediaWiki-internal language code.
39     *
40     * @see https://meta.wikimedia.org/wiki/Special_language_codes
41     */
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
55    /**
56     * Mapping of non-standard language codes used in MediaWiki to
57     * standardized BCP 47 codes. These are not deprecated (yet?):
58     * IANA may eventually recognize the subtag, in which case the `-x-`
59     * infix could be removed, or else we could rename the code in
60     * MediaWiki, in which case they'd move up to the above mapping
61     * of deprecated codes.
62     *
63     * As a rule, we preserve all distinctions made by MediaWiki
64     * internally. For example, `de-formal` becomes `de-x-formal`
65     * instead of just `de` because MediaWiki distinguishes `de-formal`
66     * from `de` (for example, for interface translations). Similarly,
67     * BCP 47 indicates that `kk-Cyrl` SHOULD not be used because it
68     * "typically does not add information", but in our case MediaWiki
69     * LanguageConverter distinguishes `kk` (render content in a mix of
70     * Kurdish variants) from `kk-Cyrl` (convert content to be uniformly
71     * Cyrillic). As the BCP 47 requirement is a SHOULD not a MUST,
72     * `kk-Cyrl` is a valid code, although some validators may emit
73     * a warning note.
74     *
75     * @var array Mapping from nonstandard MediaWiki-internal codes to
76     *   BCP 47 codes
77     *
78     * @see https://meta.wikimedia.org/wiki/Special_language_codes
79     * @see https://phabricator.wikimedia.org/T125073
80     */
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        'crh-ro' => 'crh-Latn-RO',
112        'kk-cn' => 'kk-Arab-CN',
113        'kk-tr' => 'kk-Latn-TR',
114        'zh-cn' => 'zh-Hans-CN',
115        'zh-sg' => 'zh-Hans-SG',
116        'zh-my' => 'zh-Hans-MY',
117        'zh-tw' => 'zh-Hant-TW',
118        'zh-hk' => 'zh-Hant-HK',
119        'zh-mo' => 'zh-Hant-MO',
120    ];
121
122    /**
123     * Returns a mapping of deprecated language codes that were used in previous
124     * versions of MediaWiki to up-to-date, current language codes.
125     *
126     * This array is merged into $wgDummyLanguageCodes in
127     * SetupDynamicConfig.php, along with the fake language codes
128     * 'qqq' and 'qqx', which are used internally by MediaWiki's
129     * localisation system.
130     *
131     * @return string[]
132     *
133     * @since 1.29
134     */
135    public static function getDeprecatedCodeMapping() {
136        return self::DEPRECATED_LANGUAGE_CODE_MAPPING;
137    }
138
139    /**
140     * Returns a mapping of non-standard language codes used by
141     * (current and previous version of) MediaWiki, mapped to standard
142     * BCP 47 names.
143     *
144     * This array is exported to JavaScript to ensure
145     * mediawiki.language.bcp47 stays in sync with LanguageCode::bcp47().
146     *
147     * @return string[]
148     *
149     * @since 1.32
150     */
151    public static function getNonstandardLanguageCodeMapping() {
152        static $result = [];
153        if ( $result ) {
154            return $result;
155        }
156        foreach ( self::DEPRECATED_LANGUAGE_CODE_MAPPING as $code => $ignore ) {
157            $result[$code] = self::bcp47( $code );
158        }
159        foreach ( self::NON_STANDARD_LANGUAGE_CODE_MAPPING as $code => $ignore ) {
160            $result[$code] = self::bcp47( $code );
161        }
162        return $result;
163    }
164
165    /**
166     * Replace deprecated language codes that were used in previous
167     * versions of MediaWiki to up-to-date, current language codes.
168     * Other values will be returned unchanged.
169     *
170     * @param string $code Old language code
171     * @return string New language code
172     *
173     * @since 1.30
174     */
175    public static function replaceDeprecatedCodes( $code ) {
176        return self::DEPRECATED_LANGUAGE_CODE_MAPPING[$code] ?? $code;
177    }
178
179    /**
180     * Get the normalised IANA language tag
181     * See unit test for examples.
182     * See mediawiki.language.bcp47 for the JavaScript implementation.
183     *
184     * @param string $code The language code.
185     * @return string A language code complying with BCP 47 standards.
186     *
187     * @since 1.31
188     */
189    public static function bcp47( $code ) {
190        $code = self::replaceDeprecatedCodes( strtolower( $code ) );
191        if ( isset( self::NON_STANDARD_LANGUAGE_CODE_MAPPING[$code] ) ) {
192            $code = self::NON_STANDARD_LANGUAGE_CODE_MAPPING[$code];
193        }
194        $codeSegment = explode( '-', $code );
195        $codeBCP = [];
196        foreach ( $codeSegment as $segNo => $seg ) {
197            // when the previous segment is x, it is a private segment and should be lc
198            if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
199                $codeBCP[$segNo] = strtolower( $seg );
200            // ISO 3166 country code
201            } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
202                $codeBCP[$segNo] = strtoupper( $seg );
203            // ISO 15924 script code
204            } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
205                $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
206            // Use lowercase for other cases
207            } else {
208                $codeBCP[$segNo] = strtolower( $seg );
209            }
210        }
211        return implode( '-', $codeBCP );
212    }
213
214    /**
215     * Convert standardized BCP 47 codes to the internal names used
216     * by MediaWiki and returned by Language::getCode(). This function
217     * should be the inverse of LanguageCode::bcp47(). Note that BCP 47
218     * explicitly states that language codes are case-insensitive.
219     *
220     * Since LanguageFactory::getLanguage() is pretty generous about
221     * accepting aliases (as long as they are lowercased), this function
222     * should be equivalent to:
223     *   LanguageFactory::getLanguage(strtolower($code))->getCode()
224     * but (a) better describes the caller's intention, and (b) should
225     * be much more efficient in practice.
226     *
227     * @param string|Bcp47Code $code The standard BCP-47 language code
228     * @return string A MediaWiki-internal code, as returned, for example, by
229     *    Language::getCode()
230     * @since 1.40
231     */
232    public static function bcp47ToInternal( $code ): string {
233        if ( $code instanceof Language ) {
234            return $code->getCode();
235        }