languages/Language.php

   1 <?php
   2 /**
   3  * Internationalisation code.
   4  * See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Language
  23  */
  24
  25 /**
  26  * @defgroup Language Language
  27  */
  28
  29 use CLDRPluralRuleParser\Evaluator;
  30 use MediaWiki\MediaWikiServices;
  31 use Wikimedia\Assert\Assert;
  32
  33 /**
  34  * Internationalisation code
  35  * @ingroup Language
  36  */
  37 class Language {
  38         /**
  39          * Return autonyms in fetchLanguageName(s).
  40          * @since 1.32
  41          */
  42         const AS_AUTONYMS = null;
  43
  44         /**
  45          * Return all known languages in fetchLanguageName(s).
  46          * @since 1.32
  47          */
  48         const ALL = 'all';
  49
  50         /**
  51          * Return in fetchLanguageName(s) only the languages for which we have at
  52          * least some localisation.
  53          * @since 1.32
  54          */
  55         const SUPPORTED = 'mwfile';
  56
  57         /**
  58          * @var LanguageConverter|FakeConverter
  59          */
  60         public $mConverter;
  61
  62         public $mVariants, $mCode, $mLoaded = false;
  63         public $mMagicExtensions = [];
  64         private $mHtmlCode = null;
  65         /** @var Language|false */
  66         private $mParentLanguage = false;
  67
  68         public $dateFormatStrings = [];
  69         public $mExtendedSpecialPageAliases;
  70
  71         /** @var array|null */
  72         protected $namespaceNames;
  73         protected $mNamespaceIds, $namespaceAliases;
  74
  75         /**
  76          * ReplacementArray object caches
  77          */
  78         public $transformData = [];
  79
  80         /** @var LocalisationCache */
  81         private $localisationCache;
  82
  83         public static $mLangObjCache = [];
  84
  85         /**
  86          * Return a fallback chain for messages in getFallbacksFor
  87          * @since 1.32
  88          */
  89         const MESSAGES_FALLBACKS = 0;
  90
  91         /**
  92          * Return a strict fallback chain in getFallbacksFor
  93          * @since 1.32
  94          */
  95         const STRICT_FALLBACKS = 1;
  96
  97         public static $mWeekdayMsgs = [
  98                 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
  99                 'friday', 'saturday'
 100         ];
 101
 102         public static $mWeekdayAbbrevMsgs = [
 103                 'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
 104         ];
 105
 106         public static $mMonthMsgs = [
 107                 'january', 'february', 'march', 'april', 'may_long', 'june',
 108                 'july', 'august', 'september', 'october', 'november',
 109                 'december'
 110         ];
 111         public static $mMonthGenMsgs = [
 112                 'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
 113                 'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
 114                 'december-gen'
 115         ];
 116         public static $mMonthAbbrevMsgs = [
 117                 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
 118                 'sep', 'oct', 'nov', 'dec'
 119         ];
 120
 121         public static $mIranianCalendarMonthMsgs = [
 122                 'iranian-calendar-m1', 'iranian-calendar-m2', 'iranian-calendar-m3',
 123                 'iranian-calendar-m4', 'iranian-calendar-m5', 'iranian-calendar-m6',
 124                 'iranian-calendar-m7', 'iranian-calendar-m8', 'iranian-calendar-m9',
 125                 'iranian-calendar-m10', 'iranian-calendar-m11', 'iranian-calendar-m12'
 126         ];
 127
 128         public static $mHebrewCalendarMonthMsgs = [
 129                 'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
 130                 'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
 131                 'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
 132                 'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
 133                 'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
 134         ];
 135
 136         public static $mHebrewCalendarMonthGenMsgs = [
 137                 'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
 138                 'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
 139                 'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
 140                 'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
 141                 'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
 142         ];
 143
 144         public static $mHijriCalendarMonthMsgs = [
 145                 'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
 146                 'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
 147                 'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
 148                 'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
 149         ];
 150
 151         /**
 152          * @since 1.20
 153          * @var array
 154          */
 155         public static $durationIntervals = [
 156                 'millennia' => 31556952000,
 157                 'centuries' => 3155695200,
 158                 'decades' => 315569520,
 159                 'years' => 31556952, // 86400 * ( 365 + ( 24 * 3 + 25 ) / 400 )
 160                 'weeks' => 604800,
 161                 'days' => 86400,
 162                 'hours' => 3600,
 163                 'minutes' => 60,
 164                 'seconds' => 1,
 165         ];
 166
 167         /**
 168          * Cache for language fallbacks.
 169          * @see Language::getFallbacksIncludingSiteLanguage
 170          * @since 1.21
 171          * @var array
 172          */
 173         private static $fallbackLanguageCache = [];
 174
 175         /**
 176          * Cache for grammar rules data
 177          * @var MapCacheLRU|null
 178          */
 179         private static $grammarTransformations;
 180
 181         /**
 182          * Cache for language names
 183          * @var HashBagOStuff|null
 184          */
 185         private static $languageNameCache;
 186
 187         /**
 188          * Unicode directional formatting characters, for embedBidi()
 189          */
 190         private static $lre = "\u{202A}"; // U+202A LEFT-TO-RIGHT EMBEDDING
 191         private static $rle = "\u{202B}"; // U+202B RIGHT-TO-LEFT EMBEDDING
 192         private static $pdf = "\u{202C}"; // U+202C POP DIRECTIONAL FORMATTING
 193
 194         /**
 195          * Directionality test regex for embedBidi(). Matches the first strong directionality codepoint:
 196          * - in group 1 if it is LTR
 197          * - in group 2 if it is RTL
 198          * Does not match if there is no strong directionality codepoint.
 199          *
 200          * The form is '/(?:([strong ltr codepoint])|([strong rtl codepoint]))/u' .
 201          *
 202          * Generated by UnicodeJS (see tools/strongDir) from the UCD; see
 203          * https://phabricator.wikimedia.org/diffusion/GUJS/ .
 204          */
 205         // @codeCoverageIgnoreStart
 206         // phpcs:ignore Generic.Files.LineLength
 207         private static $strongDirRegex = '/(?:([\x{41}-\x{5a}\x{61}-\x{7a}\x{aa}\x{b5}\x{ba}\x{c0}-\x{d6}\x{d8}-\x{f6}\x{f8}-\x{2b8}\x{2bb}-\x{2c1}\x{2d0}\x{2d1}\x{2e0}-\x{2e4}\x{2ee}\x{370}-\x{373}\x{376}\x{377}\x{37a}-\x{37d}\x{37f}\x{386}\x{388}-\x{38a}\x{38c}\x{38e}-\x{3a1}\x{3a3}-\x{3f5}\x{3f7}-\x{482}\x{48a}-\x{52f}\x{531}-\x{556}\x{559}-\x{55f}\x{561}-\x{587}\x{589}\x{903}-\x{939}\x{93b}\x{93d}-\x{940}\x{949}-\x{94c}\x{94e}-\x{950}\x{958}-\x{961}\x{964}-\x{980}\x{982}\x{983}\x{985}-\x{98c}\x{98f}\x{990}\x{993}-\x{9a8}\x{9aa}-\x{9b0}\x{9b2}\x{9b6}-\x{9b9}\x{9bd}-\x{9c0}\x{9c7}\x{9c8}\x{9cb}\x{9cc}\x{9ce}\x{9d7}\x{9dc}\x{9dd}\x{9df}-\x{9e1}\x{9e6}-\x{9f1}\x{9f4}-\x{9fa}\x{a03}\x{a05}-\x{a0a}\x{a0f}\x{a10}\x{a13}-\x{a28}\x{a2a}-\x{a30}\x{a32}\x{a33}\x{a35}\x{a36}\x{a38}\x{a39}\x{a3e}-\x{a40}\x{a59}-\x{a5c}\x{a5e}\x{a66}-\x{a6f}\x{a72}-\x{a74}\x{a83}\x{a85}-\x{a8d}\x{a8f}-\x{a91}\x{a93}-\x{aa8}\x{aaa}-\x{ab0}\x{ab2}\x{ab3}\x{ab5}-\x{ab9}\x{abd}-\x{ac0}\x{ac9}\x{acb}\x{acc}\x{ad0}\x{ae0}\x{ae1}\x{ae6}-\x{af0}\x{af9}\x{b02}\x{b03}\x{b05}-\x{b0c}\x{b0f}\x{b10}\x{b13}-\x{b28}\x{b2a}-\x{b30}\x{b32}\x{b33}\x{b35}-\x{b39}\x{b3d}\x{b3e}\x{b40}\x{b47}\x{b48}\x{b4b}\x{b4c}\x{b57}\x{b5c}\x{b5d}\x{b5f}-\x{b61}\x{b66}-\x{b77}\x{b83}\x{b85}-\x{b8a}\x{b8e}-\x{b90}\x{b92}-\x{b95}\x{b99}\x{b9a}\x{b9c}\x{b9e}\x{b9f}\x{ba3}\x{ba4}\x{ba8}-\x{baa}\x{bae}-\x{bb9}\x{bbe}\x{bbf}\x{bc1}\x{bc2}\x{bc6}-\x{bc8}\x{bca}-\x{bcc}\x{bd0}\x{bd7}\x{be6}-\x{bf2}\x{c01}-\x{c03}\x{c05}-\x{c0c}\x{c0e}-\x{c10}\x{c12}-\x{c28}\x{c2a}-\x{c39}\x{c3d}\x{c41}-\x{c44}\x{c58}-\x{c5a}\x{c60}\x{c61}\x{c66}-\x{c6f}\x{c7f}\x{c82}\x{c83}\x{c85}-\x{c8c}\x{c8e}-\x{c90}\x{c92}-\x{ca8}\x{caa}-\x{cb3}\x{cb5}-\x{cb9}\x{cbd}-\x{cc4}\x{cc6}-\x{cc8}\x{cca}\x{ccb}\x{cd5}\x{cd6}\x{cde}\x{ce0}\x{ce1}\x{ce6}-\x{cef}\x{cf1}\x{cf2}\x{d02}\x{d03}\x{d05}-\x{d0c}\x{d0e}-\x{d10}\x{d12}-\x{d3a}\x{d3d}-\x{d40}\x{d46}-\x{d48}\x{d4a}-\x{d4c}\x{d4e}\x{d57}\x{d5f}-\x{d61}\x{d66}-\x{d75}\x{d79}-\x{d7f}\x{d82}\x{d83}\x{d85}-\x{d96}\x{d9a}-\x{db1}\x{db3}-\x{dbb}\x{dbd}\x{dc0}-\x{dc6}\x{dcf}-\x{dd1}\x{dd8}-\x{ddf}\x{de6}-\x{def}\x{df2}-\x{df4}\x{e01}-\x{e30}\x{e32}\x{e33}\x{e40}-\x{e46}\x{e4f}-\x{e5b}\x{e81}\x{e82}\x{e84}\x{e87}\x{e88}\x{e8a}\x{e8d}\x{e94}-\x{e97}\x{e99}-\x{e9f}\x{ea1}-\x{ea3}\x{ea5}\x{ea7}\x{eaa}\x{eab}\x{ead}-\x{eb0}\x{eb2}\x{eb3}\x{ebd}\x{ec0}-\x{ec4}\x{ec6}\x{ed0}-\x{ed9}\x{edc}-\x{edf}\x{f00}-\x{f17}\x{f1a}-\x{f34}\x{f36}\x{f38}\x{f3e}-\x{f47}\x{f49}-\x{f6c}\x{f7f}\x{f85}\x{f88}-\x{f8c}\x{fbe}-\x{fc5}\x{fc7}-\x{fcc}\x{fce}-\x{fda}\x{1000}-\x{102c}\x{1031}\x{1038}\x{103b}\x{103c}\x{103f}-\x{1057}\x{105a}-\x{105d}\x{1061}-\x{1070}\x{1075}-\x{1081}\x{1083}\x{1084}\x{1087}-\x{108c}\x{108e}-\x{109c}\x{109e}-\x{10c5}\x{10c7}\x{10cd}\x{10d0}-\x{1248}\x{124a}-\x{124d}\x{1250}-\x{1256}\x{1258}\x{125a}-\x{125d}\x{1260}-\x{1288}\x{128a}-\x{128d}\x{1290}-\x{12b0}\x{12b2}-\x{12b5}\x{12b8}-\x{12be}\x{12c0}\x{12c2}-\x{12c5}\x{12c8}-\x{12d6}\x{12d8}-\x{1310}\x{1312}-\x{1315}\x{1318}-\x{135a}\x{1360}-\x{137c}\x{1380}-\x{138f}\x{13a0}-\x{13f5}\x{13f8}-\x{13fd}\x{1401}-\x{167f}\x{1681}-\x{169a}\x{16a0}-\x{16f8}\x{1700}-\x{170c}\x{170e}-\x{1711}\x{1720}-\x{1731}\x{1735}\x{1736}\x{1740}-\x{1751}\x{1760}-\x{176c}\x{176e}-\x{1770}\x{1780}-\x{17b3}\x{17b6}\x{17be}-\x{17c5}\x{17c7}\x{17c8}\x{17d4}-\x{17da}\x{17dc}\x{17e0}-\x{17e9}\x{1810}-\x{1819}\x{1820}-\x{1877}\x{1880}-\x{18a8}\x{18aa}\x{18b0}-\x{18f5}\x{1900}-\x{191e}\x{1923}-\x{1926}\x{1929}-\x{192b}\x{1930}\x{1931}\x{1933}-\x{1938}\x{1946}-\x{196d}\x{1970}-\x{1974}\x{1980}-\x{19ab}\x{19b0}-\x{19c9}\x{19d0}-\x{19da}\x{1a00}-\x{1a16}\x{1a19}\x{1a1a}\x{1a1e}-\x{1a55}\x{1a57}\x{1a61}\x{1a63}\x{1a64}\x{1a6d}-\x{1a72}\x{1a80}-\x{1a89}\x{1a90}-\x{1a99}\x{1aa0}-\x{1aad}\x{1b04}-\x{1b33}\x{1b35}\x{1b3b}\x{1b3d}-\x{1b41}\x{1b43}-\x{1b4b}\x{1b50}-\x{1b6a}\x{1b74}-\x{1b7c}\x{1b82}-\x{1ba1}\x{1ba6}\x{1ba7}\x{1baa}\x{1bae}-\x{1be5}\x{1be7}\x{1bea}-\x{1bec}\x{1bee}\x{1bf2}\x{1bf3}\x{1bfc}-\x{1c2b}\x{1c34}\x{1c35}\x{1c3b}-\x{1c49}\x{1c4d}-\x{1c7f}\x{1cc0}-\x{1cc7}\x{1cd3}\x{1ce1}\x{1ce9}-\x{1cec}\x{1cee}-\x{1cf3}\x{1cf5}\x{1cf6}\x{1d00}-\x{1dbf}\x{1e00}-\x{1f15}\x{1f18}-\x{1f1d}\x{1f20}-\x{1f45}\x{1f48}-\x{1f4d}\x{1f50}-\x{1f57}\x{1f59}\x{1f5b}\x{1f5d}\x{1f5f}-\x{1f7d}\x{1f80}-\x{1fb4}\x{1fb6}-\x{1fbc}\x{1fbe}\x{1fc2}-\x{1fc4}\x{1fc6}-\x{1fcc}\x{1fd0}-\x{1fd3}\x{1fd6}-\x{1fdb}\x{1fe0}-\x{1fec}\x{1ff2}-\x{1ff4}\x{1ff6}-\x{1ffc}\x{200e}\x{2071}\x{207f}\x{2090}-\x{209c}\x{2102}\x{2107}\x{210a}-\x{2113}\x{2115}\x{2119}-\x{211d}\x{2124}\x{2126}\x{2128}\x{212a}-\x{212d}\x{212f}-\x{2139}\x{213c}-\x{213f}\x{2145}-\x{2149}\x{214e}\x{214f}\x{2160}-\x{2188}\x{2336}-\x{237a}\x{2395}\x{249c}-\x{24e9}\x{26ac}\x{2800}-\x{28ff}\x{2c00}-\x{2c2e}\x{2c30}-\x{2c5e}\x{2c60}-\x{2ce4}\x{2ceb}-\x{2cee}\x{2cf2}\x{2cf3}\x{2d00}-\x{2d25}\x{2d27}\x{2d2d}\x{2d30}-\x{2d67}\x{2d6f}\x{2d70}\x{2d80}-\x{2d96}\x{2da0}-\x{2da6}\x{2da8}-\x{2dae}\x{2db0}-\x{2db6}\x{2db8}-\x{2dbe}\x{2dc0}-\x{2dc6}\x{2dc8}-\x{2dce}\x{2dd0}-\x{2dd6}\x{2dd8}-\x{2dde}\x{3005}-\x{3007}\x{3021}-\x{3029}\x{302e}\x{302f}\x{3031}-\x{3035}\x{3038}-\x{303c}\x{3041}-\x{3096}\x{309d}-\x{309f}\x{30a1}-\x{30fa}\x{30fc}-\x{30ff}\x{3105}-\x{312d}\x{3131}-\x{318e}\x{3190}-\x{31ba}\x{31f0}-\x{321c}\x{3220}-\x{324f}\x{3260}-\x{327b}\x{327f}-\x{32b0}\x{32c0}-\x{32cb}\x{32d0}-\x{32fe}\x{3300}-\x{3376}\x{337b}-\x{33dd}\x{33e0}-\x{33fe}\x{3400}-\x{4db5}\x{4e00}-\x{9fd5}\x{a000}-\x{a48c}\x{a4d0}-\x{a60c}\x{a610}-\x{a62b}\x{a640}-\x{a66e}\x{a680}-\x{a69d}\x{a6a0}-\x{a6ef}\x{a6f2}-\x{a6f7}\x{a722}-\x{a787}\x{a789}-\x{a7ad}\x{a7b0}-\x{a7b7}\x{a7f7}-\x{a801}\x{a803}-\x{a805}\x{a807}-\x{a80a}\x{a80c}-\x{a824}\x{a827}\x{a830}-\x{a837}\x{a840}-\x{a873}\x{a880}-\x{a8c3}\x{a8ce}-\x{a8d9}\x{a8f2}-\x{a8fd}\x{a900}-\x{a925}\x{a92e}-\x{a946}\x{a952}\x{a953}\x{a95f}-\x{a97c}\x{a983}-\x{a9b2}\x{a9b4}\x{a9b5}\x{a9ba}\x{a9bb}\x{a9bd}-\x{a9cd}\x{a9cf}-\x{a9d9}\x{a9de}-\x{a9e4}\x{a9e6}-\x{a9fe}\x{aa00}-\x{aa28}\x{aa2f}\x{aa30}\x{aa33}\x{aa34}\x{aa40}-\x{aa42}\x{aa44}-\x{aa4b}\x{aa4d}\x{aa50}-\x{aa59}\x{aa5c}-\x{aa7b}\x{aa7d}-\x{aaaf}\x{aab1}\x{aab5}\x{aab6}\x{aab9}-\x{aabd}\x{aac0}\x{aac2}\x{aadb}-\x{aaeb}\x{aaee}-\x{aaf5}\x{ab01}-\x{ab06}\x{ab09}-\x{ab0e}\x{ab11}-\x{ab16}\x{ab20}-\x{ab26}\x{ab28}-\x{ab2e}\x{ab30}-\x{ab65}\x{ab70}-\x{abe4}\x{abe6}\x{abe7}\x{abe9}-\x{abec}\x{abf0}-\x{abf9}\x{ac00}-\x{d7a3}\x{d7b0}-\x{d7c6}\x{d7cb}-\x{d7fb}\x{e000}-\x{fa6d}\x{fa70}-\x{fad9}\x{fb00}-\x{fb06}\x{fb13}-\x{fb17}\x{ff21}-\x{ff3a}\x{ff41}-\x{ff5a}\x{ff66}-\x{ffbe}\x{ffc2}-\x{ffc7}\x{ffca}-\x{ffcf}\x{ffd2}-\x{ffd7}\x{ffda}-\x{ffdc}\x{10000}-\x{1000b}\x{1000d}-\x{10026}\x{10028}-\x{1003a}\x{1003c}\x{1003d}\x{1003f}-\x{1004d}\x{10050}-\x{1005d}\x{10080}-\x{100fa}\x{10100}\x{10102}\x{10107}-\x{10133}\x{10137}-\x{1013f}\x{101d0}-\x{101fc}\x{10280}-\x{1029c}\x{102a0}-\x{102d0}\x{10300}-\x{10323}\x{10330}-\x{1034a}\x{10350}-\x{10375}\x{10380}-\x{1039d}\x{1039f}-\x{103c3}\x{103c8}-\x{103d5}\x{10400}-\x{1049d}\x{104a0}-\x{104a9}\x{10500}-\x{10527}\x{10530}-\x{10563}\x{1056f}\x{10600}-\x{10736}\x{10740}-\x{10755}\x{10760}-\x{10767}\x{11000}\x{11002}-\x{11037}\x{11047}-\x{1104d}\x{11066}-\x{1106f}\x{11082}-\x{110b2}\x{110b7}\x{110b8}\x{110bb}-\x{110c1}\x{110d0}-\x{110e8}\x{110f0}-\x{110f9}\x{11103}-\x{11126}\x{1112c}\x{11136}-\x{11143}\x{11150}-\x{11172}\x{11174}-\x{11176}\x{11182}-\x{111b5}\x{111bf}-\x{111c9}\x{111cd}\x{111d0}-\x{111df}\x{111e1}-\x{111f4}\x{11200}-\x{11211}\x{11213}-\x{1122e}\x{11232}\x{11233}\x{11235}\x{11238}-\x{1123d}\x{11280}-\x{11286}\x{11288}\x{1128a}-\x{1128d}\x{1128f}-\x{1129d}\x{1129f}-\x{112a9}\x{112b0}-\x{112de}\x{112e0}-\x{112e2}\x{112f0}-\x{112f9}\x{11302}\x{11303}\x{11305}-\x{1130c}\x{1130f}\x{11310}\x{11313}-\x{11328}\x{1132a}-\x{11330}\x{11332}\x{11333}\x{11335}-\x{11339}\x{1133d}-\x{1133f}\x{11341}-\x{11344}\x{11347}\x{11348}\x{1134b}-\x{1134d}\x{11350}\x{11357}\x{1135d}-\x{11363}\x{11480}-\x{114b2}\x{114b9}\x{114bb}-\x{114be}\x{114c1}\x{114c4}-\x{114c7}\x{114d0}-\x{114d9}\x{11580}-\x{115b1}\x{115b8}-\x{115bb}\x{115be}\x{115c1}-\x{115db}\x{11600}-\x{11632}\x{1163b}\x{1163c}\x{1163e}\x{11641}-\x{11644}\x{11650}-\x{11659}\x{11680}-\x{116aa}\x{116ac}\x{116ae}\x{116af}\x{116b6}\x{116c0}-\x{116c9}\x{11700}-\x{11719}\x{11720}\x{11721}\x{11726}\x{11730}-\x{1173f}\x{118a0}-\x{118f2}\x{118ff}\x{11ac0}-\x{11af8}\x{12000}-\x{12399}\x{12400}-\x{1246e}\x{12470}-\x{12474}\x{12480}-\x{12543}\x{13000}-\x{1342e}\x{14400}-\x{14646}\x{16800}-\x{16a38}\x{16a40}-\x{16a5e}\x{16a60}-\x{16a69}\x{16a6e}\x{16a6f}\x{16ad0}-\x{16aed}\x{16af5}\x{16b00}-\x{16b2f}\x{16b37}-\x{16b45}\x{16b50}-\x{16b59}\x{16b5b}-\x{16b61}\x{16b63}-\x{16b77}\x{16b7d}-\x{16b8f}\x{16f00}-\x{16f44}\x{16f50}-\x{16f7e}\x{16f93}-\x{16f9f}\x{1b000}\x{1b001}\x{1bc00}-\x{1bc6a}\x{1bc70}-\x{1bc7c}\x{1bc80}-\x{1bc88}\x{1bc90}-\x{1bc99}\x{1bc9c}\x{1bc9f}\x{1d000}-\x{1d0f5}\x{1d100}-\x{1d126}\x{1d129}-\x{1d166}\x{1d16a}-\x{1d172}\x{1d183}\x{1d184}\x{1d18c}-\x{1d1a9}\x{1d1ae}-\x{1d1e8}\x{1d360}-\x{1d371}\x{1d400}-\x{1d454}\x{1d456}-\x{1d49c}\x{1d49e}\x{1d49f}\x{1d4a2}\x{1d4a5}\x{1d4a6}\x{1d4a9}-\x{1d4ac}\x{1d4ae}-\x{1d4b9}\x{1d4bb}\x{1d4bd}-\x{1d4c3}\x{1d4c5}-\x{1d505}\x{1d507}-\x{1d50a}\x{1d50d}-\x{1d514}\x{1d516}-\x{1d51c}\x{1d51e}-\x{1d539}\x{1d53b}-\x{1d53e}\x{1d540}-\x{1d544}\x{1d546}\x{1d54a}-\x{1d550}\x{1d552}-\x{1d6a5}\x{1d6a8}-\x{1d6da}\x{1d6dc}-\x{1d714}\x{1d716}-\x{1d74e}\x{1d750}-\x{1d788}\x{1d78a}-\x{1d7c2}\x{1d7c4}-\x{1d7cb}\x{1d800}-\x{1d9ff}\x{1da37}-\x{1da3a}\x{1da6d}-\x{1da74}\x{1da76}-\x{1da83}\x{1da85}-\x{1da8b}\x{1f110}-\x{1f12e}\x{1f130}-\x{1f169}\x{1f170}-\x{1f19a}\x{1f1e6}-\x{1f202}\x{1f210}-\x{1f23a}\x{1f240}-\x{1f248}\x{1f250}\x{1f251}\x{20000}-\x{2a6d6}\x{2a700}-\x{2b734}\x{2b740}-\x{2b81d}\x{2b820}-\x{2cea1}\x{2f800}-\x{2fa1d}\x{f0000}-\x{ffffd}\x{100000}-\x{10fffd}])|([\x{590}\x{5be}\x{5c0}\x{5c3}\x{5c6}\x{5c8}-\x{5ff}\x{7c0}-\x{7ea}\x{7f4}\x{7f5}\x{7fa}-\x{815}\x{81a}\x{824}\x{828}\x{82e}-\x{858}\x{85c}-\x{89f}\x{200f}\x{fb1d}\x{fb1f}-\x{fb28}\x{fb2a}-\x{fb4f}\x{10800}-\x{1091e}\x{10920}-\x{10a00}\x{10a04}\x{10a07}-\x{10a0b}\x{10a10}-\x{10a37}\x{10a3b}-\x{10a3e}\x{10a40}-\x{10ae4}\x{10ae7}-\x{10b38}\x{10b40}-\x{10e5f}\x{10e7f}-\x{10fff}\x{1e800}-\x{1e8cf}\x{1e8d7}-\x{1edff}\x{1ef00}-\x{1efff}\x{608}\x{60b}\x{60d}\x{61b}-\x{64a}\x{66d}-\x{66f}\x{671}-\x{6d5}\x{6e5}\x{6e6}\x{6ee}\x{6ef}\x{6fa}-\x{710}\x{712}-\x{72f}\x{74b}-\x{7a5}\x{7b1}-\x{7bf}\x{8a0}-\x{8e2}\x{fb50}-\x{fd3d}\x{fd40}-\x{fdcf}\x{fdf0}-\x{fdfc}\x{fdfe}\x{fdff}\x{fe70}-\x{fefe}\x{1ee00}-\x{1eeef}\x{1eef2}-\x{1eeff}]))/u';
 208         // @codeCoverageIgnoreEnd
 209
 210         /**
 211          * Get a cached or new language object for a given language code
 212          * @param string $code
 213          * @throws MWException
 214          * @return Language
 215          */
 216         static function factory( $code ) {
 217                 global $wgDummyLanguageCodes, $wgLangObjCacheSize;
 218
 219                 if ( isset( $wgDummyLanguageCodes[$code] ) ) {
 220                         $code = $wgDummyLanguageCodes[$code];
 221                 }
 222
 223                 // get the language object to process
 224                 $langObj = self::$mLangObjCache[$code] ?? self::newFromCode( $code );
 225
 226                 // merge the language object in to get it up front in the cache
 227                 self::$mLangObjCache = array_merge( [ $code => $langObj ], self::$mLangObjCache );
 228                 // get rid of the oldest ones in case we have an overflow
 229                 self::$mLangObjCache = array_slice( self::$mLangObjCache, 0, $wgLangObjCacheSize, true );
 230
 231                 return $langObj;
 232         }
 233
 234         /**
 235          * Create a language object for a given language code
 236          * @param string $code
 237          * @param bool $fallback Whether we're going through language fallback chain
 238          * @throws MWException
 239          * @return Language
 240          */
 241         protected static function newFromCode( $code, $fallback = false ) {
 242                 if ( !self::isValidCode( $code ) ) {
 243                         throw new MWException( "Invalid language code \"$code\"" );
 244                 }
 245
 246                 if ( !self::isValidBuiltInCode( $code ) ) {
 247                         // It's not possible to customise this code with class files, so
 248                         // just return a Language object. This is to support uselang= hacks.
 249                         $lang = new Language;
 250                         $lang->mCode = $code;
 251                         return $lang;
 252                 }
 253
 254                 // Check if there is a language class for the code
 255                 $class = self::classFromCode( $code, $fallback );
 256                 // LanguageCode does not inherit Language
 257                 if ( class_exists( $class ) && is_a( $class, 'Language', true ) ) {
 258                         $lang = new $class;
 259                         return $lang;
 260                 }
 261
 262                 // Keep trying the fallback list until we find an existing class
 263                 $fallbacks = self::getFallbacksFor( $code );
 264                 foreach ( $fallbacks as $fallbackCode ) {
 265                         if ( !self::isValidBuiltInCode( $fallbackCode ) ) {
 266                                 throw new MWException( "Invalid fallback '$fallbackCode' in fallback sequence for '$code'" );
 267                         }
 268
 269                         $class = self::classFromCode( $fallbackCode );
 270                         if ( class_exists( $class ) ) {
 271                                 $lang = new $class;
 272                                 $lang->mCode = $code;
 273                                 return $lang;
 274                         }
 275                 }
 276
 277                 throw new MWException( "Invalid fallback sequence for language '$code'" );
 278         }
 279
 280         /**
 281          * Intended for tests that may change configuration in a way that invalidates caches.
 282          *
 283          * @since 1.32
 284          */
 285         public static function clearCaches() {
 286                 if ( !defined( 'MW_PHPUNIT_TEST' ) && !defined( 'MEDIAWIKI_INSTALL' ) ) {
 287                         throw new MWException( __METHOD__ . ' must not be used outside tests/installer' );
 288                 }
 289                 if ( defined( 'MW_PHPUNIT_TEST' ) ) {
 290                         MediaWikiServices::getInstance()->resetServiceForTesting( 'LocalisationCache' );
 291                 }
 292                 self::$mLangObjCache = [];
 293                 self::$fallbackLanguageCache = [];
 294                 self::$grammarTransformations = null;
 295                 self::$languageNameCache = null;
 296         }
 297
 298         /**
 299          * Checks whether any localisation is available for that language tag
 300          * in MediaWiki (MessagesXx.php exists).
 301          *
 302          * @param string $code Language tag (in lower case)
 303          * @return bool Whether language is supported
 304          * @since 1.21
 305          */
 306         public static function isSupportedLanguage( $code ) {
 307                 if ( !self::isValidBuiltInCode( $code ) ) {
 308                         return false;
 309                 }
 310
 311                 if ( $code === 'qqq' ) {
 312                         return false;
 313                 }
 314
 315                 return is_readable( self::getMessagesFileName( $code ) ) ||
 316                         is_readable( self::getJsonMessagesFileName( $code ) );
 317         }
 318
 319         /**
 320          * Returns true if a language code string is a well-formed language tag
 321          * according to RFC 5646.
 322          * This function only checks well-formedness; it doesn't check that
 323          * language, script or variant codes actually exist in the repositories.
 324          *
 325          * Based on regexes by Mark Davis of the Unicode Consortium:
 326          * https://www.unicode.org/repos/cldr/trunk/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
 327          *
 328          * @param string $code
 329          * @param bool $lenient Whether to allow '_' as separator. The default is only '-'.
 330          *
 331          * @return bool
 332          * @since 1.21
 333          */
 334         public static function isWellFormedLanguageTag( $code, $lenient = false ) {
 335                 $alpha = '[a-z]';
 336                 $digit = '[0-9]';
 337                 $alphanum = '[a-z0-9]';
 338                 $x = 'x'; # private use singleton
 339                 $singleton = '[a-wy-z]'; # other singleton
 340                 $s = $lenient ? '[-_]' : '-';
 341
 342                 $language = "$alpha{2,8}|$alpha{2,3}$s$alpha{3}";
 343                 $script = "$alpha{4}"; # ISO 15924
 344                 $region = "(?:$alpha{2}|$digit{3})"; # ISO 3166-1 alpha-2 or UN M.49
 345                 $variant = "(?:$alphanum{5,8}|$digit$alphanum{3})";
 346                 $extension = "$singleton(?:$s$alphanum{2,8})+";
 347                 $privateUse = "$x(?:$s$alphanum{1,8})+";
 348
 349                 # Define certain grandfathered codes, since otherwise the regex is pretty useless.
 350                 # Since these are limited, this is safe even later changes to the registry --
 351                 # the only oddity is that it might change the type of the tag, and thus
 352                 # the results from the capturing groups.
 353                 # https://www.iana.org/assignments/language-subtag-registry
 354
 355                 $grandfathered = "en{$s}GB{$s}oed"
 356                         . "|i{$s}(?:ami|bnn|default|enochian|hak|klingon|lux|mingo|navajo|pwn|tao|tay|tsu)"
 357                         . "|no{$s}(?:bok|nyn)"
 358                         . "|sgn{$s}(?:BE{$s}(?:fr|nl)|CH{$s}de)"
 359                         . "|zh{$s}min{$s}nan";
 360
 361                 $variantList = "$variant(?:$s$variant)*";
 362                 $extensionList = "$extension(?:$s$extension)*";
 363
 364                 $langtag = "(?:($language)"
 365                         . "(?:$s$script)?"
 366                         . "(?:$s$region)?"
 367                         . "(?:$s$variantList)?"
 368                         . "(?:$s$extensionList)?"
 369                         . "(?:$s$privateUse)?)";
 370
 371                 # The final breakdown, with capturing groups for each of these components
 372                 # The variants, extensions, grandfathered, and private-use may have interior '-'
 373
 374                 $root = "^(?:$langtag|$privateUse|$grandfathered)$";
 375
 376                 return (bool)preg_match( "/$root/", strtolower( $code ) );
 377         }
 378
 379         /**
 380          * Returns true if a language code string is of a valid form, whether or
 381          * not it exists. This includes codes which are used solely for
 382          * customisation via the MediaWiki namespace.
 383          *
 384          * @param string $code
 385          *
 386          * @return bool
 387          */
 388         public static function isValidCode( $code ) {
 389                 static $cache = [];
 390                 Assert::parameterType( 'string', $code, '$code' );
 391                 if ( !isset( $cache[$code] ) ) {
 392                         // People think language codes are html safe, so enforce it.
 393                         // Ideally we should only allow a-zA-Z0-9-
 394                         // but, .+ and other chars are often used for {{int:}} hacks
 395                         // see bugs T39564, T39587, T38938
 396                         $cache[$code] =
 397                                 // Protect against path traversal
 398                                 strcspn( $code, ":/\\\000&<>'\"" ) === strlen( $code )
 399                                 && !preg_match( MediaWikiTitleCodec::getTitleInvalidRegex(), $code );
 400                 }
 401                 return $cache[$code];
 402         }
 403
 404         /**
 405          * Returns true if a language code is of a valid form for the purposes of
 406          * internal customisation of MediaWiki, via Messages*.php or *.json.
 407          *
 408          * @param string $code
 409          *
 410          * @since 1.18
 411          * @return bool
 412          */
 413         public static function isValidBuiltInCode( $code ) {
 414                 Assert::parameterType( 'string', $code, '$code' );
 415
 416                 return (bool)preg_match( '/^[a-z0-9-]{2,}$/', $code );
 417         }
 418
 419         /**
 420          * Returns true if a language code is an IETF tag known to MediaWiki.
 421          *
 422          * @param string $tag
 423          *
 424          * @since 1.21
 425          * @return bool
 426          */
 427         public static function isKnownLanguageTag( $tag ) {
 428                 // Quick escape for invalid input to avoid exceptions down the line
 429                 // when code tries to process tags which are not valid at all.
 430                 if ( !self::isValidBuiltInCode( $tag ) ) {
 431                         return false;
 432                 }
 433
 434                 if ( isset( MediaWiki\Languages\Data\Names::$names[$tag] )
 435                         || self::fetchLanguageName( $tag, $tag ) !== ''
 436                 ) {
 437                         return true;
 438                 }
 439
 440                 return false;
 441         }
 442
 443         /**
 444          * Get the LocalisationCache instance
 445          *
 446          * @deprecated since 1.34, use MediaWikiServices
 447          * @return LocalisationCache
 448          */
 449         public static function getLocalisationCache() {
 450                 return MediaWikiServices::getInstance()->getLocalisationCache();
 451         }
 452
 453         function __construct() {
 454                 $this->mConverter = new FakeConverter( $this );
 455                 // Set the code to the name of the descendant
 456                 if ( static::class === 'Language' ) {
 457                         $this->mCode = 'en';
 458                 } else {
 459                         $this->mCode = str_replace( '_', '-', strtolower( substr( static::class, 8 ) ) );
 460                 }
 461                 $this->localisationCache = MediaWikiServices::getInstance()->getLocalisationCache();
 462         }
 463
 464         /**
 465          * Reduce memory usage
 466          * @suppress PhanTypeSuspiciousNonTraversableForeach
 467          */
 468         function __destruct() {
 469                 foreach ( $this as $name => $value ) {
 470                         unset( $this->$name );
 471                 }
 472         }
 473
 474         /**
 475          * Hook which will be called if this is the content language.
 476          * Descendants can use this to register hook functions or modify globals
 477          */
 478         function initContLang() {
 479         }
 480
 481         /**
 482          * @return array
 483          * @since 1.19
 484          */
 485         public function getFallbackLanguages() {
 486                 return self::getFallbacksFor( $this->mCode );
 487         }
 488
 489         /**
 490          * Exports $wgBookstoreListEn
 491          * @return array
 492          */
 493         public function getBookstoreList() {
 494                 return $this->localisationCache->getItem( $this->mCode, 'bookstoreList' );
 495         }
 496
 497         /**
 498          * Returns an array of localised namespaces indexed by their numbers. If the namespace is not
 499          * available in localised form, it will be included in English.
 500          *
 501          * @return string[] List of localized namespace names, indexed by numeric namespace ID.
 502          */
 503         public function getNamespaces() {
 504                 if ( is_null( $this->namespaceNames ) ) {
 505                         global $wgMetaNamespace, $wgMetaNamespaceTalk, $wgExtraNamespaces;
 506
 507                         $validNamespaces = MediaWikiServices::getInstance()->getNamespaceInfo()->
 508                                 getCanonicalNamespaces();
 509
 510                         $this->namespaceNames = $wgExtraNamespaces +
 511                                 $this->localisationCache->getItem( $this->mCode, 'namespaceNames' );
 512                         $this->namespaceNames += $validNamespaces;
 513
 514                         $this->namespaceNames[NS_PROJECT] = $wgMetaNamespace;
 515                         if ( $wgMetaNamespaceTalk ) {
 516                                 $this->namespaceNames[NS_PROJECT_TALK] = $wgMetaNamespaceTalk;
 517                         } else {
 518                                 $talk = $this->namespaceNames[NS_PROJECT_TALK];
 519                                 $this->namespaceNames[NS_PROJECT_TALK] =
 520                                         $this->fixVariableInNamespace( $talk );
 521                         }
 522
 523                         # Sometimes a language will be localised but not actually exist on this wiki.
 524                         foreach ( $this->namespaceNames as $key => $text ) {
 525                                 if ( !isset( $validNamespaces[$key] ) ) {
 526                                         unset( $this->namespaceNames[$key] );
 527                                 }
 528                         }
 529
 530                         # The above mixing may leave namespaces out of canonical order.
 531                         # Re-order by namespace ID number...
 532                         ksort( $this->namespaceNames );
 533
 534                         Hooks::run( 'LanguageGetNamespaces', [ &$this->namespaceNames ] );
 535                 }
 536
 537                 return $this->namespaceNames;
 538         }
 539
 540         /**
 541          * Arbitrarily set all of the namespace names at once. Mainly used for testing
 542          * @param array $namespaces Array of namespaces (id => name)
 543          */
 544         public function setNamespaces( array $namespaces ) {
 545                 $this->namespaceNames = $namespaces;
 546                 $this->mNamespaceIds = null;
 547         }
 548
 549         /**
 550          * Resets all of the namespace caches. Mainly used for testing
 551          */
 552         public function resetNamespaces() {
 553                 $this->namespaceNames = null;
 554                 $this->mNamespaceIds = null;
 555                 $this->namespaceAliases = null;
 556         }
 557
 558         /**
 559          * A convenience function that returns getNamespaces() with spaces instead of underscores
 560          * in values. Useful for producing output to be displayed e.g. in `<select>` forms.
 561          *
 562          * @return array
 563          */
 564         public function getFormattedNamespaces() {
 565                 $ns = $this->getNamespaces();
 566                 foreach ( $ns as $k => $v ) {
 567                         $ns[$k] = strtr( $v, '_', ' ' );
 568                 }
 569                 return $ns;
 570         }
 571
 572         /**
 573          * Get a namespace value by key
 574          *
 575          * <code>
 576          * $mw_ns = $lang->getNsText( NS_MEDIAWIKI );
 577          * echo $mw_ns; // prints 'MediaWiki'
 578          * </code>
 579          *
 580          * @param int $index The array key of the namespace to return
 581          * @return string|bool String if the namespace value exists, otherwise false
 582          */
 583         public function getNsText( $index ) {
 584                 $ns = $this->getNamespaces();
 585                 return $ns[$index] ?? false;
 586         }
 587
 588         /**
 589          * A convenience function that returns the same thing as
 590          * getNsText() except with '_' changed to ' ', useful for
 591          * producing output.
 592          *
 593          * <code>
 594          * $mw_ns = $lang->getFormattedNsText( NS_MEDIAWIKI_TALK );
 595          * echo $mw_ns; // prints 'MediaWiki talk'
 596          * </code>
 597          *
 598          * @param int $index The array key of the namespace to return
 599          * @return string Namespace name without underscores (empty string if namespace does not exist)
 600          */
 601         public function getFormattedNsText( $index ) {
 602                 $ns = $this->getNsText( $index );
 603                 return strtr( $ns, '_', ' ' );
 604         }
 605
 606         /**
 607          * Returns gender-dependent namespace alias if available.
 608          * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
 609          * @param int $index Namespace index
 610          * @param string $gender Gender key (male, female... )
 611          * @return string
 612          * @since 1.18
 613          */
 614         public function getGenderNsText( $index, $gender ) {
 615                 global $wgExtraGenderNamespaces;
 616
 617                 $ns = $wgExtraGenderNamespaces +
 618                         (array)$this->localisationCache->getItem( $this->mCode, 'namespaceGenderAliases' );
 619
 620                 return $ns[$index][$gender] ?? $this->getNsText( $index );
 621         }
 622
 623         /**
 624          * Whether this language uses gender-dependent namespace aliases.
 625          * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
 626          * @return bool
 627          * @since 1.18
 628          */
 629         public function needsGenderDistinction() {
 630                 global $wgExtraGenderNamespaces, $wgExtraNamespaces;
 631                 if ( count( $wgExtraGenderNamespaces ) > 0 ) {
 632                         // $wgExtraGenderNamespaces overrides everything
 633                         return true;
 634                 } elseif ( isset( $wgExtraNamespaces[NS_USER] ) && isset( $wgExtraNamespaces[NS_USER_TALK] ) ) {
 635                         /// @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
 636                         // $wgExtraNamespaces overrides any gender aliases specified in i18n files
 637                         return false;
 638                 } else {
 639                         // Check what is in i18n files
 640                         $aliases = $this->localisationCache->getItem( $this->mCode, 'namespaceGenderAliases' );
 641                         return count( $aliases ) > 0;
 642                 }
 643         }
 644
 645         /**
 646          * Get a namespace key by value, case insensitive.
 647          * Only matches namespace names for the current language, not the
 648          * canonical ones defined in Namespace.php.
 649          *
 650          * @param string $text
 651          * @return int|bool An integer if $text is a valid value otherwise false
 652          */
 653         function getLocalNsIndex( $text ) {
 654                 $lctext = $this->lc( $text );
 655                 $ids = $this->getNamespaceIds();
 656                 return $ids[$lctext] ?? false;
 657         }
 658
 659         /**
 660          * @return array
 661          */
 662         public function getNamespaceAliases() {
 663                 if ( is_null( $this->namespaceAliases ) ) {
 664                         $aliases = $this->localisationCache->getItem( $this->mCode, 'namespaceAliases' );
 665                         if ( !$aliases ) {
 666                                 $aliases = [];
 667                         } else {
 668                                 foreach ( $aliases as $name => $index ) {
 669                                         if ( $index === NS_PROJECT_TALK ) {
 670                                                 unset( $aliases[$name] );
 671                                                 $name = $this->fixVariableInNamespace( $name );
 672                                                 $aliases[$name] = $index;
 673                                         }
 674                                 }
 675                         }
 676
 677                         global $wgExtraGenderNamespaces;
 678                         $genders = $wgExtraGenderNamespaces + (array)$this->localisationCache
 679                                 ->getItem( $this->mCode, 'namespaceGenderAliases' );
 680                         foreach ( $genders as $index => $forms ) {
 681                                 foreach ( $forms as $alias ) {
 682                                         $aliases[$alias] = $index;
 683                                 }
 684                         }
 685
 686                         # Also add converted namespace names as aliases, to avoid confusion.
 687                         $convertedNames = [];
 688                         foreach ( $this->getVariants() as $variant ) {
 689                                 if ( $variant === $this->mCode ) {
 690                                         continue;
 691                                 }
 692                                 foreach ( $this->getNamespaces() as $ns => $_ ) {
 693                                         $convertedNames[$this->getConverter()->convertNamespace( $ns, $variant )] = $ns;
 694                                 }
 695                         }
 696
 697                         $this->namespaceAliases = $aliases + $convertedNames;
 698
 699                         # Filter out aliases to namespaces that don't exist, e.g. from extensions
 700                         # that aren't loaded here but are included in the l10n cache.
 701                         # (array_intersect preserves keys from its first argument)
 702                         $this->namespaceAliases = array_intersect(
 703                                 $this->namespaceAliases,
 704                                 array_keys( $this->getNamespaces() )
 705                         );
 706                 }
 707
 708                 return $this->namespaceAliases;
 709         }
 710
 711         /**
 712          * @return array
 713          */
 714         public function getNamespaceIds() {
 715                 if ( is_null( $this->mNamespaceIds ) ) {
 716                         global $wgNamespaceAliases;
 717                         # Put namespace names and aliases into a hashtable.
 718                         # If this is too slow, then we should arrange it so that it is done
 719                         # before caching. The catch is that at pre-cache time, the above
 720                         # class-specific fixup hasn't been done.
 721                         $this->mNamespaceIds = [];
 722                         foreach ( $this->getNamespaces() as $index => $name ) {
 723                                 $this->mNamespaceIds[$this->lc( $name )] = $index;
 724                         }
 725                         foreach ( $this->getNamespaceAliases() as $name => $index ) {
 726                                 $this->mNamespaceIds[$this->lc( $name )] = $index;
 727                         }
 728                         if ( $wgNamespaceAliases ) {
 729                                 foreach ( $wgNamespaceAliases as $name => $index ) {
 730                                         $this->mNamespaceIds[$this->lc( $name )] = $index;
 731                                 }
 732                         }
 733                 }
 734                 return $this->mNamespaceIds;
 735         }
 736
 737         /**
 738          * Get a namespace key by value, case insensitive.  Canonical namespace
 739          * names override custom ones defined for the current language.
 740          *
 741          * @param string $text
 742          * @return int|bool An integer if $text is a valid value otherwise false
 743          */
 744         public function getNsIndex( $text ) {
 745                 $lctext = $this->lc( $text );
 746                 $ns = MediaWikiServices::getInstance()->getNamespaceInfo()->
 747                         getCanonicalIndex( $lctext );
 748                 if ( $ns !== null ) {
 749                         return $ns;
 750                 }
 751                 $ids = $this->getNamespaceIds();
 752                 return $ids[$lctext] ?? false;
 753         }
 754
 755         /**
 756          * short names for language variants used for language conversion links.
 757          *
 758          * @param string $code
 759          * @param bool $usemsg Use the "variantname-xyz" message if it exists
 760          * @return string
 761          */
 762         public function getVariantname( $code, $usemsg = true ) {
 763                 $msg = "variantname-$code";
 764                 if ( $usemsg && wfMessage( $msg )->exists() ) {
 765                         return $this->getMessageFromDB( $msg );
 766                 }
 767                 $name = self::fetchLanguageName( $code );
 768                 if ( $name ) {
 769                         return $name; # if it's defined as a language name, show that
 770                 } else {
 771                         # otherwise, output the language code
 772                         return $code;
 773                 }
 774         }
 775
 776         /**
 777          * @return string[]|bool List of date format preference keys, or false if disabled.
 778          */
 779         public function getDatePreferences() {
 780                 return $this->localisationCache->getItem( $this->mCode, 'datePreferences' );
 781         }
 782
 783         /**
 784          * @return array
 785          */
 786         function getDateFormats() {
 787                 return $this->localisationCache->getItem( $this->mCode, 'dateFormats' );
 788         }
 789
 790         /**
 791          * @return array|string
 792          */
 793         public function getDefaultDateFormat() {
 794                 $df = $this->localisationCache->getItem( $this->mCode, 'defaultDateFormat' );
 795                 if ( $df === 'dmy or mdy' ) {
 796                         global $wgAmericanDates;
 797                         return $wgAmericanDates ? 'mdy' : 'dmy';
 798                 } else {
 799                         return $df;
 800                 }
 801         }
 802
 803         /**
 804          * @return array
 805          */
 806         public function getDatePreferenceMigrationMap() {
 807                 return $this->localisationCache->getItem( $this->mCode, 'datePreferenceMigrationMap' );
 808         }
 809
 810         /**
 811          * @return array
 812          */
 813         public function getExtraUserToggles() {
 814                 wfDeprecated( __METHOD__, '1.34' );
 815                 return [];
 816         }
 817
 818         /**
 819          * @param string $tog
 820          * @return string
 821          */
 822         function getUserToggle( $tog ) {
 823                 return $this->getMessageFromDB( "tog-$tog" );
 824         }
 825
 826         /**
 827          * Get an array of language names, indexed by code.
 828          * @param null|string $inLanguage Code of language in which to return the names
 829          *              Use self::AS_AUTONYMS for autonyms (native names)
 830          * @param string $include One of:
 831          *              self::ALL all available languages
 832          *              'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
 833          *              self::SUPPORTED only if the language is in 'mw' *and* has a message file
 834          * @return array Language code => language name (sorted by key)
 835          * @since 1.20
 836          */
 837         public static function fetchLanguageNames( $inLanguage = self::AS_AUTONYMS, $include = 'mw' ) {
 838                 $cacheKey = $inLanguage === self::AS_AUTONYMS ? 'null' : $inLanguage;
 839                 $cacheKey .= ":$include";
 840                 if ( self::$languageNameCache === null ) {
 841                         self::$languageNameCache = new HashBagOStuff( [ 'maxKeys' => 20 ] );
 842                 }
 843
 844                 $ret = self::$languageNameCache->get( $cacheKey );
 845                 if ( !$ret ) {
 846                         $ret = self::fetchLanguageNamesUncached( $inLanguage, $include );
 847                         self::$languageNameCache->set( $cacheKey, $ret );
 848                 }
 849                 return $ret;
 850         }
 851
 852         /**
 853          * Uncached helper for fetchLanguageNames
 854          * @param null|string $inLanguage Code of language in which to return the names
 855          *              Use self::AS_AUTONYMS for autonyms (native names)
 856          * @param string $include One of:
 857          *              self::ALL all available languages
 858          *              'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
 859          *              self::SUPPORTED only if the language is in 'mw' *and* has a message file
 860          * @return array Language code => language name (sorted by key)
 861          */
 862         private static function fetchLanguageNamesUncached(
 863                 $inLanguage = self::AS_AUTONYMS,
 864                 $include = 'mw'
 865         ) {
 866                 global $wgExtraLanguageNames, $wgUsePigLatinVariant;
 867
 868                 // If passed an invalid language code to use, fallback to en
 869                 if ( $inLanguage !== self::AS_AUTONYMS && !self::isValidCode( $inLanguage ) ) {
 870                         $inLanguage = 'en';
 871                 }
 872
 873                 $names = [];
 874
 875                 if ( $inLanguage ) {
 876                         # TODO: also include when $inLanguage is null, when this code is more efficient
 877                         Hooks::run( 'LanguageGetTranslatedLanguageNames', [ &$names, $inLanguage ] );
 878                 }
 879
 880                 $mwNames = $wgExtraLanguageNames + MediaWiki\Languages\Data\Names::$names;
 881                 if ( $wgUsePigLatinVariant ) {
 882                         // Pig Latin (for variant development)
 883                         $mwNames['en-x-piglatin'] = 'Igpay Atinlay';
 884                 }
 885
 886                 foreach ( $mwNames as $mwCode => $mwName ) {
 887                         # - Prefer own MediaWiki native name when not using the hook
 888                         # - For other names just add if not added through the hook
 889                         if ( $mwCode === $inLanguage || !isset( $names[$mwCode] ) ) {
 890                                 $names[$mwCode] = $mwName;
 891                         }
 892                 }
 893
 894                 if ( $include === self::ALL ) {
 895                         ksort( $names );
 896                         return $names;
 897                 }
 898
 899                 $returnMw = [];
 900                 $coreCodes = array_keys( $mwNames );
 901                 foreach ( $coreCodes as $coreCode ) {
 902                         $returnMw[$coreCode] = $names[$coreCode];
 903                 }
 904
 905                 if ( $include === self::SUPPORTED ) {
 906                         $namesMwFile = [];
 907                         # We do this using a foreach over the codes instead of a directory
 908                         # loop so that messages files in extensions will work correctly.
 909                         foreach ( $returnMw as $code => $value ) {
 910                                 if ( is_readable( self::getMessagesFileName( $code ) )
 911                                         || is_readable( self::getJsonMessagesFileName( $code ) )
 912                                 ) {
 913                                         $namesMwFile[$code] = $names[$code];
 914                                 }
 915                         }
 916
 917                         ksort( $namesMwFile );
 918                         return $namesMwFile;
 919                 }
 920
 921                 ksort( $returnMw );
 922                 # 'mw' option; default if it's not one of the other two options (all/mwfile)
 923                 return $returnMw;
 924         }
 925
 926         /**
 927          * @param string $code The code of the language for which to get the name
 928          * @param null|string $inLanguage Code of language in which to return the name
 929          *   (SELF::AS_AUTONYMS for autonyms)
 930          * @param string $include See fetchLanguageNames()
 931          * @return string Language name or empty
 932          * @since 1.20
 933          */
 934         public static function fetchLanguageName(
 935                 $code,
 936                 $inLanguage = self::AS_AUTONYMS,
 937                 $include = self::ALL
 938         ) {
 939                 $code = strtolower( $code );
 940                 $array = self::fetchLanguageNames( $inLanguage, $include );
 941                 return !array_key_exists( $code, $array ) ? '' : $array[$code];
 942         }
 943
 944         /**
 945          * Get a message from the MediaWiki namespace.
 946          *
 947          * @param string $msg Message name
 948          * @return string
 949          */
 950         public function getMessageFromDB( $msg ) {
 951                 return $this->msg( $msg )->text();
 952         }
 953
 954         /**
 955          * Get message object in this language. Only for use inside this class.
 956          *
 957          * @param string $msg Message name
 958          * @return Message
 959          */
 960         protected function msg( $msg ) {
 961                 return wfMessage( $msg )->inLanguage( $this );
 962         }
 963
 964         /**
 965          * @param string $key
 966          * @return string
 967          */
 968         public function getMonthName( $key ) {
 969                 return $this->getMessageFromDB( self::$mMonthMsgs[$key - 1] );
 970         }
 971
 972         /**
 973          * @return array
 974          */
 975         public function getMonthNamesArray() {
 976                 $monthNames = [ '' ];
 977                 for ( $i = 1; $i < 13; $i++ ) {
 978                         $monthNames[] = $this->getMonthName( $i );
 979                 }
 980                 return $monthNames;
 981         }
 982
 983         /**
 984          * @param string $key
 985          * @return string
 986          */
 987         public function getMonthNameGen( $key ) {
 988                 return $this->getMessageFromDB( self::$mMonthGenMsgs[$key - 1] );
 989         }
 990
 991         /**
 992          * @param string $key
 993          * @return string
 994          */
 995         public function getMonthAbbreviation( $key ) {
 996                 return $this->getMessageFromDB( self::$mMonthAbbrevMsgs[$key - 1] );
 997         }
 998
 999         /**
1000          * @return array
1001          */
1002         public function getMonthAbbreviationsArray() {
1003                 $monthNames = [ '' ];
1004                 for ( $i = 1; $i < 13; $i++ ) {
1005                         $monthNames[] = $this->getMonthAbbreviation( $i );
1006                 }
1007                 return $monthNames;
1008         }
1009
1010         /**
1011          * @param string $key
1012          * @return string
1013          */
1014         public function getWeekdayName( $key ) {
1015                 return $this->getMessageFromDB( self::$mWeekdayMsgs[$key - 1] );
1016         }
1017
1018         /**
1019          * @param string $key
1020          * @return string
1021          */
1022         function getWeekdayAbbreviation( $key ) {
1023                 return $this->getMessageFromDB( self::$mWeekdayAbbrevMsgs[$key - 1] );
1024         }
1025
1026         /**
1027          * @param string $key
1028          * @return string
1029          */
1030         function getIranianCalendarMonthName( $key ) {
1031                 return $this->getMessageFromDB( self::$mIranianCalendarMonthMsgs[$key - 1] );
1032         }
1033
1034         /**
1035          * @param string $key
1036          * @return string
1037          */
1038         function getHebrewCalendarMonthName( $key ) {
1039                 return $this->getMessageFromDB( self::$mHebrewCalendarMonthMsgs[$key - 1] );
1040         }
1041
1042         /**
1043          * @param string $key
1044          * @return string
1045          */
1046         function getHebrewCalendarMonthNameGen( $key ) {
1047                 return $this->getMessageFromDB( self::$mHebrewCalendarMonthGenMsgs[$key - 1] );
1048         }
1049
1050         /**
1051          * @param string $key
1052          * @return string
1053          */
1054         function getHijriCalendarMonthName( $key ) {
1055                 return $this->getMessageFromDB( self::$mHijriCalendarMonthMsgs[$key - 1] );
1056         }
1057
1058         /**
1059          * Pass through result from $dateTimeObj->format()
1060          * @param DateTime|bool|null &$dateTimeObj
1061          * @param string $ts
1062          * @param DateTimeZone|bool|null $zone
1063          * @param string $code
1064          * @return string
1065          */
1066         private static function dateTimeObjFormat( &$dateTimeObj, $ts, $zone, $code ) {
1067                 if ( !$dateTimeObj ) {
1068                         $dateTimeObj = DateTime::createFromFormat(
1069                                 'YmdHis', $ts, $zone ?: new DateTimeZone( 'UTC' )
1070                         );
1071                 }
1072                 return $dateTimeObj->format( $code );
1073         }
1074
1075         /**
1076          * This is a workalike of PHP's date() function, but with better
1077          * internationalisation, a reduced set of format characters, and a better
1078          * escaping format.
1079          *
1080          * Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrUeIOPTZ. See
1081          * the PHP manual for definitions. There are a number of extensions, which
1082          * start with "x":
1083          *
1084          *    xn   Do not translate digits of the next numeric format character
1085          *    xN   Toggle raw digit (xn) flag, stays set until explicitly unset
1086          *    xr   Use roman numerals for the next numeric format character
1087          *    xh   Use hebrew numerals for the next numeric format character
1088          *    xx   Literal x
1089          *    xg   Genitive month name
1090          *
1091          *    xij  j (day number) in Iranian calendar
1092          *    xiF  F (month name) in Iranian calendar
1093          *    xin  n (month number) in Iranian calendar
1094          *    xiy  y (two digit year) in Iranian calendar
1095          *    xiY  Y (full year) in Iranian calendar
1096          *    xit  t (days in month) in Iranian calendar
1097          *    xiz  z (day of the year) in Iranian calendar
1098          *
1099          *    xjj  j (day number) in Hebrew calendar
1100          *    xjF  F (month name) in Hebrew calendar
1101          *    xjt  t (days in month) in Hebrew calendar
1102          *    xjx  xg (genitive month name) in Hebrew calendar
1103          *    xjn  n (month number) in Hebrew calendar
1104          *    xjY  Y (full year) in Hebrew calendar
1105          *
1106          *    xmj  j (day number) in Hijri calendar
1107          *    xmF  F (month name) in Hijri calendar
1108          *    xmn  n (month number) in Hijri calendar
1109          *    xmY  Y (full year) in Hijri calendar
1110          *
1111          *    xkY  Y (full year) in Thai solar calendar. Months and days are
1112          *                       identical to the Gregorian calendar
1113          *    xoY  Y (full year) in Minguo calendar or Juche year.
1114          *                       Months and days are identical to the
1115          *                       Gregorian calendar
1116          *    xtY  Y (full year) in Japanese nengo. Months and days are
1117          *                       identical to the Gregorian calendar
1118          *
1119          * Characters enclosed in double quotes will be considered literal (with
1120          * the quotes themselves removed). Unmatched quotes will be considered
1121          * literal quotes. Example:
1122          *
1123          * "The month is" F       => The month is January
1124          * i's"                   => 20'11"
1125          *
1126          * Backslash escaping is also supported.
1127          *
1128          * Input timestamp is assumed to be pre-normalized to the desired local
1129          * time zone, if any. Note that the format characters crUeIOPTZ will assume
1130          * $ts is UTC if $zone is not given.
1131          *
1132          * @param string $format
1133          * @param string $ts 14-character timestamp
1134          *      YYYYMMDDHHMMSS
1135          *      01234567890123
1136          * @param DateTimeZone|null $zone Timezone of $ts
1137          * @param int &$ttl The amount of time (in seconds) the output may be cached for.
1138          * Only makes sense if $ts is the current time.
1139          * @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
1140          *
1141          * @throws MWException
1142          * @return string
1143          */
1144         public function sprintfDate( $format, $ts, DateTimeZone $zone = null, &$ttl = 'unused' ) {
1145                 $s = '';
1146                 $raw = false;
1147                 $roman = false;
1148                 $hebrewNum = false;
1149                 $dateTimeObj = false;
1150                 $rawToggle = false;
1151                 $iranian = false;
1152                 $hebrew = false;
1153                 $hijri = false;
1154                 $thai = false;
1155                 $minguo = false;
1156                 $tenno = false;
1157
1158                 $usedSecond = false;
1159                 $usedMinute = false;
1160                 $usedHour = false;
1161                 $usedAMPM = false;
1162                 $usedDay = false;
1163                 $usedWeek = false;
1164                 $usedMonth = false;
1165                 $usedYear = false;
1166                 $usedISOYear = false;
1167                 $usedIsLeapYear = false;
1168
1169                 $usedHebrewMonth = false;
1170                 $usedIranianMonth = false;
1171                 $usedHijriMonth = false;
1172                 $usedHebrewYear = false;
1173                 $usedIranianYear = false;
1174                 $usedHijriYear = false;
1175                 $usedTennoYear = false;
1176
1177                 if ( strlen( $ts ) !== 14 ) {
1178                         throw new MWException( __METHOD__ . ": The timestamp $ts should have 14 characters" );
1179                 }
1180
1181                 if ( !ctype_digit( $ts ) ) {
1182                         throw new MWException( __METHOD__ . ": The timestamp $ts should be a number" );
1183                 }
1184
1185                 $formatLength = strlen( $format );
1186                 for ( $p = 0; $p < $formatLength; $p++ ) {
1187                         $num = false;
1188                         $code = $format[$p];
1189                         if ( $code == 'x' && $p < $formatLength - 1 ) {
1190                                 $code .= $format[++$p];
1191                         }
1192
1193                         if ( ( $code === 'xi'
1194                                         || $code === 'xj'
1195                                         || $code === 'xk'
1196                                         || $code === 'xm'
1197                                         || $code === 'xo'
1198                                         || $code === 'xt' )
1199                                 && $p < $formatLength - 1 ) {
1200                                 $code .= $format[++$p];
1201                         }
1202
1203                         switch ( $code ) {
1204                                 case 'xx':
1205                                         $s .= 'x';
1206                                         break;
1207                                 case 'xn':
1208                                         $raw = true;
1209                                         break;
1210                                 case 'xN':
1211                                         $rawToggle = !$rawToggle;
1212                                         break;
1213                                 case 'xr':
1214                                         $roman = true;
1215                                         break;
1216                                 case 'xh':
1217                                         $hebrewNum = true;
1218                                         break;
1219                                 case 'xg':
1220                                         $usedMonth = true;
1221                                         $s .= $this->getMonthNameGen( substr( $ts, 4, 2 ) );
1222                                         break;
1223                                 case 'xjx':
1224                                         $usedHebrewMonth = true;
1225                                         if ( !$hebrew ) {
1226                                                 $hebrew = self::tsToHebrew( $ts );
1227                                         }
1228                                         $s .= $this->getHebrewCalendarMonthNameGen( $hebrew[1] );
1229                                         break;
1230                                 case 'd':
1231                                         $usedDay = true;
1232                                         $num = substr( $ts, 6, 2 );
1233                                         break;
1234                                 case 'D':
1235                                         $usedDay = true;
1236                                         $s .= $this->getWeekdayAbbreviation(
1237                                                 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
1238                                         );
1239                                         break;
1240                                 case 'j':
1241                                         $usedDay = true;
1242                                         $num = intval( substr( $ts, 6, 2 ) );
1243                                         break;
1244                                 case 'xij':
1245                                         $usedDay = true;
1246                                         if ( !$iranian ) {
1247                                                 $iranian = self::tsToIranian( $ts );
1248                                         }
1249                                         $num = $iranian[2];
1250                                         break;
1251                                 case 'xmj':
1252                                         $usedDay = true;
1253                                         if ( !$hijri ) {
1254                                                 $hijri = self::tsToHijri( $ts );
1255                                         }
1256                                         $num = $hijri[2];
1257                                         break;
1258                                 case 'xjj':
1259                                         $usedDay = true;
1260                                         if ( !$hebrew ) {
1261                                                 $hebrew = self::tsToHebrew( $ts );
1262                                         }
1263                                         $num = $hebrew[2];
1264                                         break;
1265                                 case 'l':
1266                                         $usedDay = true;
1267                                         $s .= $this->getWeekdayName(
1268                                                 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
1269                                         );
1270                                         break;
1271                                 case 'F':
1272                                         $usedMonth = true;
1273                                         $s .= $this->getMonthName( substr( $ts, 4, 2 ) );
1274                                         break;
1275                                 case 'xiF':
1276                                         $usedIranianMonth = true;
1277                                         if ( !$iranian ) {
1278                                                 $iranian = self::tsToIranian( $ts );
1279                                         }
1280                                         $s .= $this->getIranianCalendarMonthName( $iranian[1] );
1281                                         break;
1282                                 case 'xmF':
1283                                         $usedHijriMonth = true;
1284                                         if ( !$hijri ) {
1285                                                 $hijri = self::tsToHijri( $ts );
1286                                         }
1287                                         $s .= $this->getHijriCalendarMonthName( $hijri[1] );
1288                                         break;
1289                                 case 'xjF':
1290                                         $usedHebrewMonth = true;
1291                                         if ( !$hebrew ) {
1292                                                 $hebrew = self::tsToHebrew( $ts );
1293                                         }
1294                                         $s .= $this->getHebrewCalendarMonthName( $hebrew[1] );
1295                                         break;
1296                                 case 'm':
1297                                         $usedMonth = true;
1298                                         $num = substr( $ts, 4, 2 );
1299                                         break;
1300                                 case 'M':
1301                                         $usedMonth = true;
1302                                         $s .= $this->getMonthAbbreviation( substr( $ts, 4, 2 ) );
1303                                         break;
1304                                 case 'n':
1305                                         $usedMonth = true;
1306                                         $num = intval( substr( $ts, 4, 2 ) );
1307                                         break;
1308                                 case 'xin':
1309                                         $usedIranianMonth = true;
1310                                         if ( !$iranian ) {
1311                                                 $iranian = self::tsToIranian( $ts );
1312                                         }
1313                                         $num = $iranian[1];
1314                                         break;
1315                                 case 'xmn':
1316                                         $usedHijriMonth = true;
1317                                         if ( !$hijri ) {
1318                                                 $hijri = self::tsToHijri( $ts );
1319                                         }
1320                                         $num = $hijri[1];
1321                                         break;
1322                                 case 'xjn':
1323                                         $usedHebrewMonth = true;
1324                                         if ( !$hebrew ) {
1325                                                 $hebrew = self::tsToHebrew( $ts );
1326                                         }
1327                                         $num = $hebrew[1];
1328                                         break;
1329                                 case 'xjt':
1330                                         $usedHebrewMonth = true;
1331                                         if ( !$hebrew ) {
1332                                                 $hebrew = self::tsToHebrew( $ts );
1333                                         }
1334                                         $num = $hebrew[3];
1335                                         break;
1336                                 case 'Y':
1337                                         $usedYear = true;
1338                                         $num = substr( $ts, 0, 4 );
1339                                         break;
1340                                 case 'xiY':
1341                                         $usedIranianYear = true;
1342                                         if ( !$iranian ) {
1343                                                 $iranian = self::tsToIranian( $ts );
1344                                         }
1345                                         $num = $iranian[0];
1346                                         break;
1347                                 case 'xmY':
1348                                         $usedHijriYear = true;
1349                                         if ( !$hijri ) {
1350                                                 $hijri = self::tsToHijri( $ts );
1351                                         }
1352                                         $num = $hijri[0];
1353                                         break;
1354                                 case 'xjY':
1355                                         $usedHebrewYear = true;
1356                                         if ( !$hebrew ) {
1357                                                 $hebrew = self::tsToHebrew( $ts );
1358                                         }
1359                                         $num = $hebrew[0];
1360                                         break;
1361                                 case 'xkY':
1362                                         $usedYear = true;
1363                                         if ( !$thai ) {
1364                                                 $thai = self::tsToYear( $ts, 'thai' );
1365                                         }
1366                                         $num = $thai[0];
1367                                         break;
1368                                 case 'xoY':
1369                                         $usedYear = true;
1370                                         if ( !$minguo ) {
1371                                                 $minguo = self::tsToYear( $ts, 'minguo' );
1372                                         }
1373                                         $num = $minguo[0];
1374                                         break;
1375                                 case 'xtY':
1376                                         $usedTennoYear = true;
1377                                         if ( !$tenno ) {
1378                                                 $tenno = self::tsToYear( $ts, 'tenno' );
1379                                         }
1380                                         $num = $tenno[0];
1381                                         break;
1382                                 case 'y':
1383                                         $usedYear = true;
1384                                         $num = substr( $ts, 2, 2 );
1385                                         break;
1386                                 case 'xiy':
1387                                         $usedIranianYear = true;
1388                                         if ( !$iranian ) {
1389                                                 $iranian = self::tsToIranian( $ts );
1390                                         }
1391                                         $num = substr( $iranian[0], -2 );
1392                                         break;
1393                                 case 'xit':
1394                                         $usedIranianYear = true;
1395                                         if ( !$iranian ) {
1396                                                 $iranian = self::tsToIranian( $ts );
1397                                         }
1398                                         $num = self::$IRANIAN_DAYS[$iranian[1] - 1];
1399                                         break;
1400                                 case 'xiz':
1401                                         $usedIranianYear = true;
1402                                         if ( !$iranian ) {
1403                                                 $iranian = self::tsToIranian( $ts );
1404                                         }
1405                                         $num = $iranian[3];
1406                                         break;
1407                                 case 'a':
1408                                         $usedAMPM = true;
1409                                         $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'am' : 'pm';
1410                                         break;
1411                                 case 'A':
1412                                         $usedAMPM = true;
1413                                         $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'AM' : 'PM';
1414                                         break;
1415                                 case 'g':
1416                                         $usedHour = true;
1417                                         $h = substr( $ts, 8, 2 );
1418                                         $num = $h % 12 ?: 12;
1419                                         break;
1420                                 case 'G':
1421                                         $usedHour = true;
1422                                         $num = intval( substr( $ts, 8, 2 ) );
1423                                         break;
1424                                 case 'h':
1425                                         $usedHour = true;
1426                                         $h = substr( $ts, 8, 2 );
1427                                         $num = sprintf( '%02d', $h % 12 ?: 12 );
1428                                         break;
1429                                 case 'H':
1430                                         $usedHour = true;
1431                                         $num = substr( $ts, 8, 2 );
1432                                         break;
1433                                 case 'i':
1434                                         $usedMinute = true;
1435                                         $num = substr( $ts, 10, 2 );
1436                                         break;
1437                                 case 's':
1438                                         $usedSecond = true;
1439                                         $num = substr( $ts, 12, 2 );
1440                                         break;
1441                                 case 'c':
1442                                 case 'r':
1443                                         $usedSecond = true;
1444                                         // fall through
1445                                 case 'e':
1446                                 case 'O':
1447                                 case 'P':
1448                                 case 'T':
1449                                         $s .= self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1450                                         break;
1451                                 case 'w':
1452                                 case 'N':
1453                                 case 'z':
1454                                         $usedDay = true;
1455                                         $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1456                                         break;
1457                                 case 'W':
1458                                         $usedWeek = true;
1459                                         $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1460                                         break;
1461                                 case 't':
1462                                         $usedMonth = true;
1463                                         $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1464                                         break;
1465                                 case 'L':
1466                                         $usedIsLeapYear = true;
1467                                         $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1468                                         break;
1469                                 case 'o':
1470                                         $usedISOYear = true;
1471                                         $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1472                                         break;
1473                                 case 'U':
1474                                         $usedSecond = true;
1475                                         // fall through
1476                                 case 'I':
1477                                 case 'Z':
1478                                         $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1479                                         break;
1480                                 case '\\':
1481                                         # Backslash escaping
1482                                         if ( $p < $formatLength - 1 ) {
1483                                                 $s .= $format[++$p];
1484                                         } else {
1485                                                 $s .= '\\';
1486                                         }
1487                                         break;
1488                                 case '"':
1489                                         # Quoted literal
1490                                         if ( $p < $formatLength - 1 ) {
1491                                                 $endQuote = strpos( $format, '"', $p + 1 );
1492                                                 if ( $endQuote === false ) {
1493                                                         # No terminating quote, assume literal "
1494                                                         $s .= '"';
1495                                                 } else {
1496                                                         $s .= substr( $format, $p + 1, $endQuote - $p - 1 );
1497                                                         $p = $endQuote;
1498                                                 }
1499                                         } else {
1500                                                 # Quote at end of string, assume literal "
1501                                                 $s .= '"';
1502                                         }
1503                                         break;
1504                                 default:
1505                                         $s .= $format[$p];
1506                         }
1507                         if ( $num !== false ) {
1508                                 if ( $rawToggle || $raw ) {
1509                                         $s .= $num;
1510                                         $raw = false;
1511                                 } elseif ( $roman ) {
1512                                         $s .= self::romanNumeral( $num );
1513                                         $roman = false;
1514                                 } elseif ( $hebrewNum ) {
1515                                         $s .= self::hebrewNumeral( $num );
1516                                         $hebrewNum = false;
1517                                 } else {
1518                                         $s .= $this->formatNum( $num, true );
1519                                 }
1520                         }
1521                 }
1522
1523                 if ( $ttl === 'unused' ) {
1524                         // No need to calculate the TTL, the caller wont use it anyway.
1525                 } elseif ( $usedSecond ) {
1526                         $ttl = 1;
1527                 } elseif ( $usedMinute ) {
1528                         $ttl = 60 - substr( $ts, 12, 2 );
1529                 } elseif ( $usedHour ) {
1530                         $ttl = 3600 - substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1531                 } elseif ( $usedAMPM ) {
1532                         $ttl = 43200 - ( substr( $ts, 8, 2 ) % 12 ) * 3600 -
1533                                 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1534                 } elseif (
1535                         $usedDay ||
1536                         $usedHebrewMonth ||
1537                         $usedIranianMonth ||
1538                         $usedHijriMonth ||
1539                         $usedHebrewYear ||
1540                         $usedIranianYear ||
1541                         $usedHijriYear ||
1542                         $usedTennoYear
1543                 ) {
1544                         // @todo Someone who understands the non-Gregorian calendars
1545                         // should write proper logic for them so that they don't need purged every day.
1546                         $ttl = 86400 - substr( $ts, 8, 2 ) * 3600 -
1547                                 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1548                 } else {
1549                         $possibleTtls = [];
1550                         $timeRemainingInDay = 86400 - substr( $ts, 8, 2 ) * 3600 -
1551                                 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1552                         if ( $usedWeek ) {
1553                                 $possibleTtls[] =
1554                                         ( 7 - self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400 +
1555                                         $timeRemainingInDay;
1556                         } elseif ( $usedISOYear ) {
1557                                 // December 28th falls on the last ISO week of the year, every year.
1558                                 // The last ISO week of a year can be 52 or 53.
1559                                 $lastWeekOfISOYear = DateTime::createFromFormat(
1560                                         'Ymd',
1561                                         substr( $ts, 0, 4 ) . '1228',
1562                                         $zone ?: new DateTimeZone( 'UTC' )
1563                                 )->format( 'W' );
1564                                 $currentISOWeek = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'W' );
1565                                 $weeksRemaining = $lastWeekOfISOYear - $currentISOWeek;
1566                                 $timeRemainingInWeek =
1567                                         ( 7 - self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400
1568                                         + $timeRemainingInDay;
1569                                 $possibleTtls[] = $weeksRemaining * 604800 + $timeRemainingInWeek;
1570                         }
1571
1572                         if ( $usedMonth ) {
1573                                 $possibleTtls[] =
1574                                         ( self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 't' ) -
1575                                                 substr( $ts, 6, 2 ) ) * 86400
1576                                         + $timeRemainingInDay;
1577                         } elseif ( $usedYear ) {
1578                                 $possibleTtls[] =
1579                                         ( self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) + 364 -
1580                                                 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
1581                                         + $timeRemainingInDay;
1582                         } elseif ( $usedIsLeapYear ) {
1583                                 $year = substr( $ts, 0, 4 );
1584                                 $timeRemainingInYear =
1585                                         ( self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) + 364 -
1586                                                 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
1587                                         + $timeRemainingInDay;
1588                                 $mod = $year % 4;
1589                                 if ( $mod || ( !( $year % 100 ) && $year % 400 ) ) {
1590                                         // this isn't a leap year. see when the next one starts
1591                                         $nextCandidate = $year - $mod + 4;
1592                                         if ( $nextCandidate % 100 || !( $nextCandidate % 400 ) ) {
1593                                                 $possibleTtls[] = ( $nextCandidate - $year - 1 ) * 365 * 86400 +
1594                                                         $timeRemainingInYear;
1595                                         } else {
1596                                                 $possibleTtls[] = ( $nextCandidate - $year + 3 ) * 365 * 86400 +
1597                                                         $timeRemainingInYear;
1598                                         }
1599                                 } else {
1600                                         // this is a leap year, so the next year isn't
1601                                         $possibleTtls[] = $timeRemainingInYear;
1602                                 }
1603                         }
1604
1605                         if ( $possibleTtls ) {
1606                                 $ttl = min( $possibleTtls );
1607                         }
1608                 }
1609
1610                 return $s;
1611         }
1612
1613         private static $GREG_DAYS = [ 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 ];
1614         private static $IRANIAN_DAYS = [ 31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29 ];
1615
1616         /**
1617          * Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
1618          * Gregorian dates to Iranian dates. Originally written in C, it
1619          * is released under the terms of GNU Lesser General Public
1620          * License. Conversion to PHP was performed by Niklas Laxström.
1621          *
1622          * Link: http://www.farsiweb.info/jalali/jalali.c
1623          *
1624          * @param string $ts
1625          *
1626          * @return int[]
1627          */
1628         private static function tsToIranian( $ts ) {
1629                 $gy = substr( $ts, 0, 4 ) - 1600;
1630                 $gm = substr( $ts, 4, 2 ) - 1;
1631                 $gd = substr( $ts, 6, 2 ) - 1;
1632
1633                 # Days passed from the beginning (including leap years)
1634                 $gDayNo = 365 * $gy
1635                         + floor( ( $gy + 3 ) / 4 )
1636                         - floor( ( $gy + 99 ) / 100 )
1637                         + floor( ( $gy + 399 ) / 400 );
1638
1639                 // Add days of the past months of this year
1640                 for ( $i = 0; $i < $gm; $i++ ) {
1641                         $gDayNo += self::$GREG_DAYS[$i];
1642                 }
1643
1644                 // Leap years
1645                 if ( $gm > 1 && ( ( $gy % 4 === 0 && $gy % 100 !== 0 || ( $gy % 400 == 0 ) ) ) ) {
1646                         $gDayNo++;
1647                 }
1648
1649                 // Days passed in current month
1650                 $gDayNo += (int)$gd;
1651
1652                 $jDayNo = $gDayNo - 79;
1653
1654                 $jNp = floor( $jDayNo / 12053 );
1655                 $jDayNo %= 12053;
1656
1657                 $jy = 979 + 33 * $jNp + 4 * floor( $jDayNo / 1461 );
1658                 $jDayNo %= 1461;
1659
1660                 if ( $jDayNo >= 366 ) {
1661                         $jy += floor( ( $jDayNo - 1 ) / 365 );
1662                         $jDayNo = floor( ( $jDayNo - 1 ) % 365 );
1663                 }
1664
1665                 $jz = $jDayNo;
1666
1667                 for ( $i = 0; $i < 11 && $jDayNo >= self::$IRANIAN_DAYS[$i]; $i++ ) {
1668                         $jDayNo -= self::$IRANIAN_DAYS[$i];
1669                 }
1670
1671                 $jm = $i + 1;
1672                 $jd = $jDayNo + 1;
1673
1674                 return [ $jy, $jm, $jd, $jz ];
1675         }
1676
1677         /**
1678          * Converting Gregorian dates to Hijri dates.
1679          *
1680          * Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
1681          *
1682          * @see https://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
1683          *
1684          * @param string $ts
1685          *
1686          * @return int[]
1687          */
1688         private static function tsToHijri( $ts ) {
1689                 $year = substr( $ts, 0, 4 );
1690                 $month = substr( $ts, 4, 2 );
1691                 $day = substr( $ts, 6, 2 );
1692
1693                 $zyr = $year;
1694                 $zd = $day;
1695                 $zm = $month;
1696                 $zy = $zyr;
1697
1698                 if (
1699                         ( $zy > 1582 ) || ( ( $zy == 1582 ) && ( $zm > 10 ) ) ||
1700                         ( ( $zy == 1582 ) && ( $zm == 10 ) && ( $zd > 14 ) )
1701                 ) {
1702                         $zjd = (int)( ( 1461 * ( $zy + 4800 + (int)( ( $zm - 14 ) / 12 ) ) ) / 4 ) +
1703                                         (int)( ( 367 * ( $zm - 2 - 12 * ( (int)( ( $zm - 14 ) / 12 ) ) ) ) / 12 ) -
1704                                         (int)( ( 3 * (int)( ( ( $zy + 4900 + (int)( ( $zm - 14 ) / 12 ) ) / 100 ) ) ) / 4 ) +
1705                                         $zd - 32075;
1706                 } else {
1707                         $zjd = 367 * $zy - (int)( ( 7 * ( $zy + 5001 + (int)( ( $zm - 9 ) / 7 ) ) ) / 4 ) +
1708                                                                 (int)( ( 275 * $zm ) / 9 ) + $zd + 1729777;
1709                 }
1710
1711                 $zl = $zjd - 1948440 + 10632;
1712                 $zn = (int)( ( $zl - 1 ) / 10631 );
1713                 $zl = $zl - 10631 * $zn + 354;
1714                 $zj = ( (int)( ( 10985 - $zl ) / 5316 ) ) * ( (int)( ( 50 * $zl ) / 17719 ) ) +
1715                         ( (int)( $zl / 5670 ) ) * ( (int)( ( 43 * $zl ) / 15238 ) );
1716                 $zl = $zl - ( (int)( ( 30 - $zj ) / 15 ) ) * ( (int)( ( 17719 * $zj ) / 50 ) ) -
1717                         ( (int)( $zj / 16 ) ) * ( (int)( ( 15238 * $zj ) / 43 ) ) + 29;
1718                 $zm = (int)( ( 24 * $zl ) / 709 );
1719                 $zd = $zl - (int)( ( 709 * $zm ) / 24 );
1720                 $zy = 30 * $zn + $zj - 30;
1721
1722                 return [ $zy, $zm, $zd ];
1723         }
1724
1725         /**
1726          * Converting Gregorian dates to Hebrew dates.
1727          *
1728          * Based on a JavaScript code by Abu Mami and Yisrael Hersch
1729          * (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
1730          * to translate the relevant functions into PHP and release them under
1731          * GNU GPL.
1732          *
1733          * The months are counted from Tishrei = 1. In a leap year, Adar I is 13
1734          * and Adar II is 14. In a non-leap year, Adar is 6.
1735          *
1736          * @param string $ts
1737          *
1738          * @return int[]
1739          */
1740         private static function tsToHebrew( $ts ) {
1741                 # Parse date
1742                 $year = substr( $ts, 0, 4 );
1743                 $month = substr( $ts, 4, 2 );
1744                 $day = substr( $ts, 6, 2 );
1745
1746                 # Calculate Hebrew year
1747                 $hebrewYear = $year + 3760;
1748
1749                 # Month number when September = 1, August = 12
1750                 $month += 4;
1751                 if ( $month > 12 ) {
1752                         # Next year
1753                         $month -= 12;
1754                         $year++;
1755                         $hebrewYear++;
1756                 }
1757
1758                 # Calculate day of year from 1 September
1759                 $dayOfYear = $day;
1760                 for ( $i = 1; $i < $month; $i++ ) {
1761                         if ( $i == 6 ) {
1762                                 # February
1763                                 $dayOfYear += 28;
1764                                 # Check if the year is leap
1765                                 if ( $year % 400 == 0 || ( $year % 4 == 0 && $year % 100 > 0 ) ) {
1766                                         $dayOfYear++;
1767                                 }
1768                         } elseif ( $i == 8 || $i == 10 || $i == 1 || $i == 3 ) {
1769                                 $dayOfYear += 30;
1770                         } else {
1771                                 $dayOfYear += 31;
1772                         }
1773                 }
1774
1775                 # Calculate the start of the Hebrew year
1776                 $start = self::hebrewYearStart( $hebrewYear );
1777
1778                 # Calculate next year's start
1779                 if ( $dayOfYear <= $start ) {
1780                         # Day is before the start of the year - it is the previous year
1781                         # Next year's start
1782                         $nextStart = $start;
1783                         # Previous year
1784                         $year--;
1785                         $hebrewYear--;
1786                         # Add days since previous year's 1 September
1787                         $dayOfYear += 365;
1788                         if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
1789                                 # Leap year
1790                                 $dayOfYear++;
1791                         }
1792                         # Start of the new (previous) year
1793                         $start = self::hebrewYearStart( $hebrewYear );
1794                 } else {
1795                         # Next year's start
1796                         $nextStart = self::hebrewYearStart( $hebrewYear + 1 );
1797                 }
1798
1799                 # Calculate Hebrew day of year
1800                 $hebrewDayOfYear = $dayOfYear - $start;
1801
1802                 # Difference between year's days
1803                 $diff = $nextStart - $start;
1804                 # Add 12 (or 13 for leap years) days to ignore the difference between
1805                 # Hebrew and Gregorian year (353 at least vs. 365/6) - now the
1806                 # difference is only about the year type
1807                 if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
1808                         $diff += 13;
1809                 } else {
1810                         $diff += 12;
1811                 }
1812
1813                 # Check the year pattern, and is leap year
1814                 # 0 means an incomplete year, 1 means a regular year, 2 means a complete year
1815                 # This is mod 30, to work on both leap years (which add 30 days of Adar I)
1816                 # and non-leap years
1817                 $yearPattern = $diff % 30;
1818                 # Check if leap year
1819                 $isLeap = $diff >= 30;
1820
1821                 # Calculate day in the month from number of day in the Hebrew year
1822                 # Don't check Adar - if the day is not in Adar, we will stop before;
1823                 # if it is in Adar, we will use it to check if it is Adar I or Adar II
1824                 $hebrewDay = $hebrewDayOfYear;
1825                 $hebrewMonth = 1;
1826                 $days = 0;
1827                 while ( $hebrewMonth <= 12 ) {
1828                         # Calculate days in this month
1829                         if ( $isLeap && $hebrewMonth == 6 ) {
1830                                 # Leap year - has Adar I, with 30 days, and Adar II, with 29 days
1831                                 $days = 30;
1832                                 if ( $hebrewDay <= $days ) {
1833                                         # Day in Adar I
1834                                         $hebrewMonth = 13;
1835                                 } else {
1836                                         # Subtract the days of Adar I
1837                                         $hebrewDay -= $days;
1838                                         # Try Adar II
1839                                         $days = 29;
1840                                         if ( $hebrewDay <= $days ) {
1841                                                 # Day in Adar II
1842                                                 $hebrewMonth = 14;
1843                                         }
1844                                 }
1845                         } elseif ( $hebrewMonth == 2 && $yearPattern == 2 ) {
1846                                 # Cheshvan in a complete year (otherwise as the rule below)
1847                                 $days = 30;
1848                         } elseif ( $hebrewMonth == 3 && $yearPattern == 0 ) {
1849                                 # Kislev in an incomplete year (otherwise as the rule below)
1850                                 $days = 29;
1851                         } else {
1852                                 # Odd months have 30 days, even have 29
1853                                 $days = 30 - ( $hebrewMonth - 1 ) % 2;
1854                         }
1855                         if ( $hebrewDay <= $days ) {
1856                                 # In the current month
1857                                 break;
1858                         } else {
1859                                 # Subtract the days of the current month
1860                                 $hebrewDay -= $days;
1861                                 # Try in the next month
1862                                 $hebrewMonth++;
1863                         }
1864                 }
1865
1866                 return [ $hebrewYear, $hebrewMonth, $hebrewDay, $days ];
1867         }
1868
1869         /**
1870          * This calculates the Hebrew year start, as days since 1 September.
1871          * Based on Carl Friedrich Gauss algorithm for finding Easter date.
1872          * Used for Hebrew date.
1873          *
1874          * @param int $year
1875          *
1876          * @return string
1877          */
1878         private static function hebrewYearStart( $year ) {
1879                 $a = intval( ( 12 * ( $year - 1 ) + 17 ) % 19 );
1880                 $b = intval( ( $year - 1 ) % 4 );
1881                 $m = 32.044093161144 + 1.5542417966212 * $a + $b / 4.0 - 0.0031777940220923 * ( $year - 1 );
1882                 if ( $m < 0 ) {
1883                         $m--;
1884                 }
1885                 $Mar = intval( $m );
1886                 if ( $m < 0 ) {
1887                         $m++;
1888                 }
1889                 $m -= $Mar;
1890
1891                 $c = intval( ( $Mar + 3 * ( $year - 1 ) + 5 * $b + 5 ) % 7 );
1892                 if ( $c == 0 && $a > 11 && $m >= 0.89772376543210 ) {
1893                         $Mar++;
1894                 } elseif ( $c == 1 && $a > 6 && $m >= 0.63287037037037 ) {
1895                         $Mar += 2;
1896                 } elseif ( $c == 2 || $c == 4 || $c == 6 ) {
1897                         $Mar++;
1898                 }
1899
1900                 $Mar += intval( ( $year - 3761 ) / 100 ) - intval( ( $year - 3761 ) / 400 ) - 24;
1901                 return $Mar;
1902         }
1903
1904         /**
1905          * Algorithm to convert Gregorian dates to Thai solar dates,
1906          * Minguo dates or Minguo dates.
1907          *
1908          * Link: https://en.wikipedia.org/wiki/Thai_solar_calendar
1909          *       https://en.wikipedia.org/wiki/Minguo_calendar
1910          *       https://en.wikipedia.org/wiki/Japanese_era_name
1911          *
1912          * @param string $ts 14-character timestamp
1913          * @param string $cName Calender name
1914          * @return array Converted year, month, day
1915          */
1916         private static function tsToYear( $ts, $cName ) {
1917                 $gy = substr( $ts, 0, 4 );
1918                 $gm = substr( $ts, 4, 2 );
1919                 $gd = substr( $ts, 6, 2 );
1920
1921                 if ( !strcmp( $cName, 'thai' ) ) {
1922                         # Thai solar dates
1923                         # Add 543 years to the Gregorian calendar
1924                         # Months and days are identical
1925                         $gy_offset = $gy + 543;
1926                         # fix for dates between 1912 and 1941
1927                         # https://en.wikipedia.org/?oldid=836596673#New_year
1928                         if ( $gy >= 1912 && $gy <= 1940 ) {
1929                                 if ( $gm <= 3 ) {
1930                                         $gy_offset--;
1931                                 }
1932                                 $gm = ( $gm - 3 ) % 12;
1933                         }
1934                 } elseif ( ( !strcmp( $cName, 'minguo' ) ) || !strcmp( $cName, 'juche' ) ) {
1935                         # Minguo dates
1936                         # Deduct 1911 years from the Gregorian calendar
1937                         # Months and days are identical
1938                         $gy_offset = $gy - 1911;
1939                 } elseif ( !strcmp( $cName, 'tenno' ) ) {
1940                         # Nengō dates up to Meiji period
1941                         # Deduct years from the Gregorian calendar
1942                         # depending on the nengo periods
1943                         # Months and days are identical
1944                         if ( ( $gy < 1912 )
1945                                 || ( ( $gy == 1912 ) && ( $gm < 7 ) )
1946                                 || ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd < 31 ) )
1947                         ) {
1948                                 # Meiji period
1949                                 $gy_gannen = $gy - 1868 + 1;
1950                                 $gy_offset = $gy_gannen;
1951                                 if ( $gy_gannen == 1 ) {
1952                                         $gy_offset = '元';
1953                                 }
1954                                 $gy_offset = '明治' . $gy_offset;
1955                         } elseif (
1956                                 ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd == 31 ) ) ||
1957                                 ( ( $gy == 1912 ) && ( $gm >= 8 ) ) ||
1958                                 ( ( $gy > 1912 ) && ( $gy < 1926 ) ) ||
1959                                 ( ( $gy == 1926 ) && ( $gm < 12 ) ) ||
1960                                 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd < 26 ) )
1961                         ) {
1962                                 # Taishō period
1963                                 $gy_gannen = $gy - 1912 + 1;
1964                                 $gy_offset = $gy_gannen;
1965                                 if ( $gy_gannen == 1 ) {
1966                                         $gy_offset = '元';
1967                                 }
1968                                 $gy_offset = '大正' . $gy_offset;
1969                         } elseif (
1970                                 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd >= 26 ) ) ||
1971                                 ( ( $gy > 1926 ) && ( $gy < 1989 ) ) ||
1972                                 ( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd < 8 ) )
1973                         ) {
1974                                 # Shōwa period
1975                                 $gy_gannen = $gy - 1926 + 1;
1976                                 $gy_offset = $gy_gannen;
1977                                 if ( $gy_gannen == 1 ) {
1978                                         $gy_offset = '元';
1979                                 }
1980                                 $gy_offset = '昭和' . $gy_offset;
1981                         } elseif (
1982                                 ( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd >= 8 ) ) ||
1983                                 ( ( $gy > 1989 ) && ( $gy < 2019 ) ) ||
1984                                 ( ( $gy == 2019 ) && ( $gm < 5 ) )
1985                         ) {
1986                                 # Heisei period
1987                                 $gy_gannen = $gy - 1989 + 1;
1988                                 $gy_offset = $gy_gannen;
1989                                 if ( $gy_gannen == 1 ) {
1990                                         $gy_offset = '元';
1991                                 }
1992                                 $gy_offset = '平成' . $gy_offset;
1993                         } else {
1994                                 # Reiwa period
1995                                 $gy_gannen = $gy - 2019 + 1;
1996                                 $gy_offset = $gy_gannen;
1997                                 if ( $gy_gannen == 1 ) {
1998                                         $gy_offset = '元';
1999                                 }
2000                                 $gy_offset = '令和' . $gy_offset;
2001                         }
2002                 } else {
2003                         $gy_offset = $gy;
2004                 }
2005
2006                 return [ $gy_offset, $gm, $gd ];
2007         }
2008
2009         /**
2010          * Gets directionality of the first strongly directional codepoint, for embedBidi()
2011          *
2012          * This is the rule the BIDI algorithm uses to determine the directionality of
2013          * paragraphs ( https://www.unicode.org/reports/tr9/#The_Paragraph_Level ) and
2014          * FSI isolates ( https://www.unicode.org/reports/tr9/#Explicit_Directional_Isolates ).
2015          *
2016          * TODO: Does not handle BIDI control characters inside the text.
2017          * TODO: Does not handle unallocated characters.
2018          *
2019          * @param string $text Text to test
2020          * @return null|string Directionality ('ltr' or 'rtl') or null
2021          */
2022         private static function strongDirFromContent( $text = '' ) {
2023                 if ( !preg_match( self::$strongDirRegex, $text, $matches ) ) {
2024                         return null;
2025                 }
2026                 if ( $matches[1] === '' ) {
2027                         return 'rtl';
2028                 }
2029                 return 'ltr';
2030         }
2031
2032         /**
2033          * Roman number formatting up to 10000
2034          *
2035          * @param int $num
2036          *
2037          * @return string
2038          */
2039         static function romanNumeral( $num ) {
2040                 static $table = [
2041                         [ '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X' ],
2042                         [ '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC', 'C' ],
2043                         [ '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM', 'M' ],
2044                         [ '', 'M', 'MM', 'MMM', 'MMMM', 'MMMMM', 'MMMMMM', 'MMMMMMM',
2045                                 'MMMMMMMM', 'MMMMMMMMM', 'MMMMMMMMMM' ]
2046                 ];
2047
2048                 $num = intval( $num );
2049                 if ( $num > 10000 || $num <= 0 ) {
2050                         return $num;
2051                 }
2052
2053                 $s = '';
2054                 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
2055                         if ( $num >= $pow10 ) {
2056                                 $s .= $table[$i][(int)floor( $num / $pow10 )];
2057                         }
2058                         $num = $num % $pow10;
2059                 }
2060                 return $s;
2061         }
2062
2063         /**
2064          * Hebrew Gematria number formatting up to 9999
2065          *
2066          * @param int $num
2067          *
2068          * @return string
2069          */
2070         static function hebrewNumeral( $num ) {
2071                 static $table = [
2072                         [ '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ],
2073                         [ '', 'י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ', 'ק' ],
2074                         [ '',
2075                                 [ 'ק' ],
2076                                 [ 'ר' ],
2077                                 [ 'ש' ],
2078                                 [ 'ת' ],
2079                                 [ 'ת', 'ק' ],
2080                                 [ 'ת', 'ר' ],
2081                                 [ 'ת', 'ש' ],
2082                                 [ 'ת', 'ת' ],
2083                                 [ 'ת', 'ת', 'ק' ],
2084                                 [ 'ת', 'ת', 'ר' ],
2085                         ],
2086                         [ '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ]
2087                 ];
2088
2089                 $num = intval( $num );
2090                 if ( $num > 9999 || $num <= 0 ) {
2091                         return $num;
2092                 }
2093
2094                 // Round thousands have special notations
2095                 if ( $num === 1000 ) {
2096                         return "א' אלף";
2097                 } elseif ( $num % 1000 === 0 ) {
2098                         return $table[0][$num / 1000] . "' אלפים";
2099                 }
2100
2101                 $letters = [];
2102
2103                 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
2104                         if ( $num >= $pow10 ) {
2105                                 if ( $num === 15 || $num === 16 ) {
2106                                         $letters[] = $table[0][9];
2107                                         $letters[] = $table[0][$num - 9];
2108                                         $num = 0;
2109                                 } else {
2110                                         $letters = array_merge(
2111                                                 $letters,
2112                                                 (array)$table[$i][intval( $num / $pow10 )]
2113                                         );
2114
2115                                         if ( $pow10 === 1000 ) {
2116                                                 $letters[] = "'";
2117                                         }
2118                                 }
2119                         }
2120
2121                         $num = $num % $pow10;
2122                 }
2123
2124                 $preTransformLength = count( $letters );
2125                 if ( $preTransformLength === 1 ) {
2126                         // Add geresh (single quote) to one-letter numbers
2127                         $letters[] = "'";
2128                 } else {
2129                         $lastIndex = $preTransformLength - 1;
2130                         $letters[$lastIndex] = str_replace(
2131                                 [ 'כ', 'מ', 'נ', 'פ', 'צ' ],
2132                                 [ 'ך', 'ם', 'ן', 'ף', 'ץ' ],
2133                                 $letters[$lastIndex]
2134                         );
2135
2136                         // Add gershayim (double quote) to multiple-letter numbers,
2137                         // but exclude numbers with only one letter after the thousands
2138                         // (1001-1009, 1020, 1030, 2001-2009, etc.)
2139                         if ( $letters[1] === "'" && $preTransformLength === 3 ) {
2140                                 $letters[] = "'";
2141                         } else {
2142                                 array_splice( $letters, -1, 0, '"' );
2143                         }
2144                 }
2145
2146                 return implode( $letters );
2147         }
2148
2149         /**
2150          * Used by date() and time() to adjust the time output.
2151          *
2152          * @param string $ts The time in date('YmdHis') format
2153          * @param mixed $tz Adjust the time by this amount (default false, mean we
2154          *   get user timecorrection setting)
2155          * @return int
2156          */
2157         public function userAdjust( $ts, $tz = false ) {
2158                 global $wgUser, $wgLocalTZoffset;
2159
2160                 if ( $tz === false ) {
2161                         $tz = $wgUser->getOption( 'timecorrection' );
2162                 }
2163
2164                 $data = explode( '|', $tz, 3 );
2165
2166                 if ( $data[0] == 'ZoneInfo' ) {
2167                         try {
2168                                 $userTZ = new DateTimeZone( $data[2] );
2169                                 $date = new DateTime( $ts, new DateTimeZone( 'UTC' ) );
2170                                 $date->setTimezone( $userTZ );
2171                                 return $date->format( 'YmdHis' );
2172                         } catch ( Exception $e ) {
2173                                 // Unrecognized timezone, default to 'Offset' with the stored offset.
2174                                 $data[0] = 'Offset';
2175                         }
2176                 }
2177
2178                 if ( $data[0] == 'System' || $tz == '' ) {
2179                         # Global offset in minutes.
2180                         $minDiff = $wgLocalTZoffset;
2181                 } elseif ( $data[0] == 'Offset' ) {
2182                         $minDiff = intval( $data[1] );
2183                 } else {
2184                         $data = explode( ':', $tz );
2185                         if ( count( $data ) == 2 ) {
2186                                 $data[0] = intval( $data[0] );
2187                                 $data[1] = intval( $data[1] );
2188                                 $minDiff = abs( $data[0] ) * 60 + $data[1];
2189                                 if ( $data[0] < 0 ) {
2190                                         $minDiff = -$minDiff;
2191                                 }
2192                         } else {
2193                                 $minDiff = intval( $data[0] ) * 60;
2194                         }
2195                 }
2196
2197                 # No difference ? Return time unchanged
2198                 if ( $minDiff == 0 ) {
2199                         return $ts;
2200                 }
2201
2202                 Wikimedia\suppressWarnings(); // E_STRICT system time bitching
2203                 # Generate an adjusted date; take advantage of the fact that mktime
2204                 # will normalize out-of-range values so we don't have to split $minDiff
2205                 # into hours and minutes.
2206                 $t = mktime( (
2207                         (int)substr( $ts, 8, 2 ) ), # Hours
2208                         (int)substr( $ts, 10, 2 ) + $minDiff, # Minutes
2209                         (int)substr( $ts, 12, 2 ), # Seconds
2210                         (int)substr( $ts, 4, 2 ), # Month
2211                         (int)substr( $ts, 6, 2 ), # Day
2212                         (int)substr( $ts, 0, 4 ) ); # Year
2213
2214                 $date = date( 'YmdHis', $t );
2215                 Wikimedia\restoreWarnings();
2216
2217                 return $date;
2218         }
2219
2220         /**
2221          * This is meant to be used by time(), date(), and timeanddate() to get
2222          * the date preference they're supposed to use, it should be used in
2223          * all children.
2224          *
2225          *     function timeanddate([...], $format = true) {
2226          *       $datePreference = $this->dateFormat($format);
2227          *       [...]
2228          *     }
2229          *
2230          * @param int|string|bool $usePrefs If true, the user's preference is used
2231          *   if false, the site/language default is used
2232          *   if int/string, assumed to be a format.
2233          * @return string
2234          */
2235         function dateFormat( $usePrefs = true ) {
2236                 global $wgUser;
2237
2238                 if ( is_bool( $usePrefs ) ) {
2239                         if ( $usePrefs ) {
2240                                 $datePreference = $wgUser->getDatePreference();
2241                         } else {
2242                                 $datePreference = (string)User::getDefaultOption( 'date' );
2243                         }
2244                 } else {
2245                         $datePreference = (string)$usePrefs;
2246                 }
2247
2248                 // return int
2249                 if ( $datePreference == '' ) {
2250                         return 'default';
2251                 }
2252
2253                 return $datePreference;
2254         }
2255
2256         /**
2257          * Get a format string for a given type and preference
2258          * @param string $type May be 'date', 'time', 'both', or 'pretty'.
2259          * @param string $pref The format name as it appears in Messages*.php under
2260          *  $datePreferences.
2261          *
2262          * @since 1.22 New type 'pretty' that provides a more readable timestamp format
2263          *
2264          * @return string
2265          */
2266         function getDateFormatString( $type, $pref ) {
2267                 $wasDefault = false;
2268                 if ( $pref == 'default' ) {
2269                         $wasDefault = true;
2270                         $pref = $this->getDefaultDateFormat();
2271                 }
2272
2273                 if ( !isset( $this->dateFormatStrings[$type][$pref] ) ) {
2274                         $df =
2275                                 $this->localisationCache->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
2276
2277                         if ( $type === 'pretty' && $df === null ) {
2278                                 $df = $this->getDateFormatString( 'date', $pref );
2279                         }
2280
2281                         if ( !$wasDefault && $df === null ) {
2282                                 $pref = $this->getDefaultDateFormat();
2283                                 $df = $this->getLocalisationCache()
2284                                         ->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
2285                         }
2286
2287                         $this->dateFormatStrings[$type][$pref] = $df;
2288                 }
2289                 return $this->dateFormatStrings[$type][$pref];
2290         }
2291
2292         /**
2293          * @param string $ts The time format which needs to be turned into a
2294          *   date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2295          * @param bool $adj Whether to adjust the time output according to the
2296          *   user configured offset ($timecorrection)
2297          * @param mixed $format True to use user's date format preference
2298          * @param string|bool $timecorrection The time offset as returned by
2299          *   validateTimeZone() in Special:Preferences
2300          * @return string
2301          */
2302         public function date( $ts, $adj = false, $format = true, $timecorrection = false ) {
2303                 $ts = wfTimestamp( TS_MW, $ts );
2304                 if ( $adj ) {
2305                         $ts = $this->userAdjust( $ts, $timecorrection );
2306                 }
2307                 $df = $this->getDateFormatString( 'date', $this->dateFormat( $format ) );
2308                 return $this->sprintfDate( $df, $ts );
2309         }
2310
2311         /**
2312          * @param string $ts The time format which needs to be turned into a
2313          *   date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2314          * @param bool $adj Whether to adjust the time output according to the
2315          *   user configured offset ($timecorrection)
2316          * @param mixed $format True to use user's date format preference
2317          * @param string|bool $timecorrection The time offset as returned by
2318          *   validateTimeZone() in Special:Preferences
2319          * @return string
2320          */
2321         public function time( $ts, $adj = false, $format = true, $timecorrection = false ) {
2322                 $ts = wfTimestamp( TS_MW, $ts );
2323                 if ( $adj ) {
2324                         $ts = $this->userAdjust( $ts, $timecorrection );
2325                 }
2326                 $df = $this->getDateFormatString( 'time', $this->dateFormat( $format ) );
2327                 return $this->sprintfDate( $df, $ts );
2328         }
2329
2330         /**
2331          * @param string $ts The time format which needs to be turned into a
2332          *   date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2333          * @param bool $adj Whether to adjust the time output according to the
2334          *   user configured offset ($timecorrection)
2335          * @param mixed $format What format to return, if it's false output the
2336          *   default one (default true)
2337          * @param string|bool $timecorrection The time offset as returned by
2338          *   validateTimeZone() in Special:Preferences
2339          * @return string
2340          */
2341         public function timeanddate( $ts, $adj = false, $format = true, $timecorrection = false ) {
2342                 $ts = wfTimestamp( TS_MW, $ts );
2343                 if ( $adj ) {
2344                         $ts = $this->userAdjust( $ts, $timecorrection );
2345                 }
2346                 $df = $this->getDateFormatString( 'both', $this->dateFormat( $format ) );
2347                 return $this->sprintfDate( $df, $ts );
2348         }
2349
2350         /**
2351          * Takes a number of seconds and turns it into a text using values such as hours and minutes.
2352          *
2353          * @since 1.20
2354          *
2355          * @param int $seconds The amount of seconds.
2356          * @param array $chosenIntervals The intervals to enable.
2357          *
2358          * @return string
2359          */
2360         public function formatDuration( $seconds, array $chosenIntervals = [] ) {
2361                 $intervals = $this->getDurationIntervals( $seconds, $chosenIntervals );
2362
2363                 $segments = [];
2364
2365                 foreach ( $intervals as $intervalName => $intervalValue ) {
2366                         // Messages: duration-seconds, duration-minutes, duration-hours, duration-days, duration-weeks,
2367                         // duration-years, duration-decades, duration-centuries, duration-millennia
2368                         $message = wfMessage( 'duration-' . $intervalName )->numParams( $intervalValue );
2369                         $segments[] = $message->inLanguage( $this )->escaped();
2370                 }
2371
2372                 return $this->listToText( $segments );
2373         }
2374
2375         /**
2376          * Takes a number of seconds and returns an array with a set of corresponding intervals.
2377          * For example 65 will be turned into [ minutes => 1, seconds => 5 ].
2378          *
2379          * @since 1.20
2380          *
2381          * @param int $seconds The amount of seconds.
2382          * @param array $chosenIntervals The intervals to enable.
2383          *
2384          * @return array
2385          */
2386         public function getDurationIntervals( $seconds, array $chosenIntervals = [] ) {
2387                 if ( empty( $chosenIntervals ) ) {
2388                         $chosenIntervals = [
2389                                 'millennia',
2390                                 'centuries',
2391                                 'decades',
2392                                 'years',
2393                                 'days',
2394                                 'hours',
2395                                 'minutes',
2396                                 'seconds'
2397                         ];
2398                 }
2399
2400                 $intervals = array_intersect_key( self::$durationIntervals, array_flip( $chosenIntervals ) );
2401                 $sortedNames = array_keys( $intervals );
2402                 $smallestInterval = array_pop( $sortedNames );
2403
2404                 $segments = [];
2405
2406                 foreach ( $intervals as $name => $length ) {
2407                         $value = floor( $seconds / $length );
2408
2409                         if ( $value > 0 || ( $name == $smallestInterval && empty( $segments ) ) ) {
2410                                 $seconds -= $value * $length;
2411                                 $segments[$name] = $value;
2412                         }
2413                 }
2414
2415                 return $segments;
2416         }
2417
2418         /**
2419          * Internal helper function for userDate(), userTime() and userTimeAndDate()
2420          *
2421          * @param string $type Can be 'date', 'time' or 'both'
2422          * @param string $ts The time format which needs to be turned into a
2423          *   date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2424          * @param User $user User object used to get preferences for timezone and format
2425          * @param array $options Array, can contain the following keys:
2426          *   - 'timecorrection': time correction, can have the following values:
2427          *     - true: use user's preference
2428          *     - false: don't use time correction
2429          *     - int: value of time correction in minutes
2430          *   - 'format': format to use, can have the following values:
2431          *     - true: use user's preference
2432          *     - false: use default preference
2433          *     - string: format to use
2434          * @since 1.19
2435          * @return string
2436          */
2437         private function internalUserTimeAndDate( $type, $ts, User $user, array $options ) {
2438                 $ts = wfTimestamp( TS_MW, $ts );
2439                 $options += [ 'timecorrection' => true, 'format' => true ];
2440                 if ( $options['timecorrection'] !== false ) {
2441                         if ( $options['timecorrection'] === true ) {
2442                                 $offset = $user->getOption( 'timecorrection' );
2443                         } else {
2444                                 $offset = $options['timecorrection'];
2445                         }
2446                         $ts = $this->userAdjust( $ts, $offset );
2447                 }
2448                 if ( $options['format'] === true ) {
2449                         $format = $user->getDatePreference();
2450                 } else {
2451                         $format = $options['format'];
2452                 }
2453                 $df = $this->getDateFormatString( $type, $this->dateFormat( $format ) );
2454                 return $this->sprintfDate( $df, $ts );
2455         }
2456
2457         /**
2458          * Get the formatted date for the given timestamp and formatted for
2459          * the given user.
2460          *
2461          * @param mixed $ts Mixed: the time format which needs to be turned into a
2462          *   date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2463          * @param User $user User object used to get preferences for timezone and format
2464          * @param array $options Array, can contain the following keys:
2465          *   - 'timecorrection': time correction, can have the following values:
2466          *     - true: use user's preference
2467          *     - false: don't use time correction
2468          *     - int: value of time correction in minutes
2469          *   - 'format': format to use, can have the following values:
2470          *     - true: use user's preference
2471          *     - false: use default preference
2472          *     - string: format to use
2473          * @since 1.19
2474          * @return string
2475          */
2476         public function userDate( $ts, User $user, array $options = [] ) {
2477                 return $this->internalUserTimeAndDate( 'date', $ts, $user, $options );
2478         }
2479
2480         /**
2481          * Get the formatted time for the given timestamp and formatted for
2482          * the given user.
2483          *
2484          * @param mixed $ts The time format which needs to be turned into a
2485          *   date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2486          * @param User $user User object used to get preferences for timezone and format
2487          * @param array $options Array, can contain the following keys:
2488          *   - 'timecorrection': time correction, can have the following values:
2489          *     - true: use user's preference
2490          *     - false: don't use time correction
2491          *     - int: value of time correction in minutes
2492          *   - 'format': format to use, can have the following values:
2493          *     - true: use user's preference
2494          *     - false: use default preference
2495          *     - string: format to use
2496          * @since 1.19
2497          * @return string
2498          */
2499         public function userTime( $ts, User $user, array $options = [] ) {
2500                 return $this->internalUserTimeAndDate( 'time', $ts, $user, $options );
2501         }
2502
2503         /**
2504          * Get the formatted date and time for the given timestamp and formatted for
2505          * the given user.
2506          *
2507          * @param mixed $ts The time format which needs to be turned into a
2508          *   date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2509          * @param User $user User object used to get preferences for timezone and format
2510          * @param array $options Array, can contain the following keys:
2511          *   - 'timecorrection': time correction, can have the following values:
2512          *     - true: use user's preference
2513          *     - false: don't use time correction
2514          *     - int: value of time correction in minutes
2515          *   - 'format': format to use, can have the following values:
2516          *     - true: use user's preference
2517          *     - false: use default preference
2518          *     - string: format to use
2519          * @since 1.19
2520          * @return string
2521          */
2522         public function userTimeAndDate( $ts, User $user, array $options = [] ) {
2523                 return $this->internalUserTimeAndDate( 'both', $ts, $user, $options );
2524         }
2525
2526         /**
2527          * Get the timestamp in a human-friendly relative format, e.g., "3 days ago".
2528          *
2529          * Determine the difference between the timestamp and the current time, and
2530          * generate a readable timestamp by returning "<N> <units> ago", where the
2531          * largest possible unit is used.
2532          *
2533          * @since 1.26 (Prior to 1.26 method existed but was not meant to be used directly)
2534          *
2535          * @param MWTimestamp $time
2536          * @param MWTimestamp|null $relativeTo The base timestamp to compare to (defaults to now)
2537          * @param User|null $user User the timestamp is being generated for
2538          *  (or null to use main context's user)
2539          * @return string Formatted timestamp
2540          */
2541         public function getHumanTimestamp(
2542                 MWTimestamp $time, MWTimestamp $relativeTo = null, User $user = null
2543         ) {
2544                 if ( $relativeTo === null ) {
2545                         $relativeTo = new MWTimestamp();
2546                 }
2547                 if ( $user === null ) {
2548                         $user = RequestContext::getMain()->getUser();
2549                 }
2550
2551                 // Adjust for the user's timezone.
2552                 $offsetThis = $time->offsetForUser( $user );
2553                 $offsetRel = $relativeTo->offsetForUser( $user );
2554
2555                 $ts = '';
2556                 if ( Hooks::run( 'GetHumanTimestamp', [ &$ts, $time, $relativeTo, $user, $this ] ) ) {
2557                         $ts = $this->getHumanTimestampInternal( $time, $relativeTo, $user );
2558                 }
2559
2560                 // Reset the timezone on the objects.
2561                 $time->timestamp->sub( $offsetThis );
2562                 $relativeTo->timestamp->sub( $offsetRel );
2563
2564                 return $ts;
2565         }
2566
2567         /**
2568          * Convert an MWTimestamp into a pretty human-readable timestamp using
2569          * the given user preferences and relative base time.
2570          *
2571          * @see Language::getHumanTimestamp
2572          * @param MWTimestamp $ts Timestamp to prettify
2573          * @param MWTimestamp $relativeTo Base timestamp
2574          * @param User $user User preferences to use
2575          * @return string Human timestamp
2576          * @since 1.26
2577          */
2578         private function getHumanTimestampInternal(
2579                 MWTimestamp $ts, MWTimestamp $relativeTo, User $user
2580         ) {
2581                 $diff = $ts->diff( $relativeTo );
2582                 $diffDay = (bool)( (int)$ts->timestamp->format( 'w' ) -
2583                         (int)$relativeTo->timestamp->format( 'w' ) );
2584                 $days = $diff->days ?: (int)$diffDay;
2585                 if ( $diff->invert || $days > 5
2586                         && $ts->timestamp->format( 'Y' ) !== $relativeTo->timestamp->format( 'Y' )
2587                 ) {
2588                         // Timestamps are in different years: use full timestamp
2589                         // Also do full timestamp for future dates
2590                         /**
2591                          * @todo FIXME: Add better handling of future timestamps.
2592                          */
2593                         $format = $this->getDateFormatString( 'both', $user->getDatePreference() ?: 'default' );
2594                         $ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) );
2595                 } elseif ( $days > 5 ) {
2596                         // Timestamps are in same year,  but more than 5 days ago: show day and month only.
2597                         $format = $this->getDateFormatString( 'pretty', $user->getDatePreference() ?: 'default' );
2598                         $ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) );
2599                 } elseif ( $days > 1 ) {
2600                         // Timestamp within the past week: show the day of the week and time
2601                         $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
2602                         $weekday = self::$mWeekdayMsgs[$ts->timestamp->format( 'w' )];
2603                         // Messages:
2604                         // sunday-at, monday-at, tuesday-at, wednesday-at, thursday-at, friday-at, saturday-at
2605                         $ts = wfMessage( "$weekday-at" )
2606                                 ->inLanguage( $this )
2607                                 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
2608                                 ->text();
2609                 } elseif ( $days == 1 ) {
2610                         // Timestamp was yesterday: say 'yesterday' and the time.
2611                         $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
2612                         $ts = wfMessage( 'yesterday-at' )
2613                                 ->inLanguage( $this )
2614                                 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
2615                                 ->text();
2616                 } elseif ( $diff->h > 1 || $diff->h == 1 && $diff->i > 30 ) {
2617                         // Timestamp was today, but more than 90 minutes ago: say 'today' and the time.
2618                         $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
2619                         $ts = wfMessage( 'today-at' )
2620                                 ->inLanguage( $this )
2621                                 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
2622                                 ->text();
2623
2624                 // From here on in, the timestamp was soon enough ago so that we can simply say
2625                 // XX units ago, e.g., "2 hours ago" or "5 minutes ago"
2626                 } elseif ( $diff->h == 1 ) {
2627                         // Less than 90 minutes, but more than an hour ago.
2628                         $ts = wfMessage( 'hours-ago' )->inLanguage( $this )->numParams( 1 )->text();
2629                 } elseif ( $diff->i >= 1 ) {
2630                         // A few minutes ago.
2631                         $ts = wfMessage( 'minutes-ago' )->inLanguage( $this )->numParams( $diff->i )->text();
2632                 } elseif ( $diff->s >= 30 ) {
2633                         // Less than a minute, but more than 30 sec ago.
2634                         $ts = wfMessage( 'seconds-ago' )->inLanguage( $this )->numParams( $diff->s )->text();
2635                 } else {
2636                         // Less than 30 seconds ago.
2637                         $ts = wfMessage( 'just-now' )->text();
2638                 }
2639
2640                 return $ts;
2641         }
2642
2643         /**
2644          * @param string $key
2645          * @return string|null
2646          */
2647         public function getMessage( $key ) {
2648                 return $this->localisationCache->getSubitem( $this->mCode, 'messages', $key );
2649         }
2650
2651         /**
2652          * @return array
2653          */
2654         function getAllMessages() {
2655                 return $this->localisationCache->getItem( $this->mCode, 'messages' );
2656         }
2657
2658         /**
2659          * @param string $in
2660          * @param string $out
2661          * @param string $string
2662          * @return string
2663          */
2664         public function iconv( $in, $out, $string ) {
2665                 # Even with //IGNORE iconv can whine about illegal characters in
2666                 # *input* string. We just ignore those too.
2667                 # REF: https://bugs.php.net/bug.php?id=37166
2668                 # REF: https://phabricator.wikimedia.org/T18885
2669                 Wikimedia\suppressWarnings();
2670                 $text = iconv( $in, $out . '//IGNORE', $string );
2671                 Wikimedia\restoreWarnings();
2672                 return $text;
2673         }
2674
2675         // callback functions for ucwords(), ucwordbreaks()
2676
2677         /**
2678          * @param array $matches
2679          * @return mixed|string
2680          */
2681         function ucwordbreaksCallbackAscii( $matches ) {
2682                 return $this->ucfirst( $matches[1] );
2683         }
2684
2685         /**
2686          * @param array $matches
2687          * @return string
2688          */
2689         function ucwordbreaksCallbackMB( $matches ) {
2690                 return mb_strtoupper( $matches[0] );
2691         }
2692
2693         /**
2694          * @param array $matches
2695          * @return string
2696          */
2697         function ucwordsCallbackMB( $matches ) {
2698                 return mb_strtoupper( $matches[0] );
2699         }
2700
2701         /**
2702          * Make a string's first character uppercase
2703          *
2704          * @param string $str
2705          *
2706          * @return string
2707          */
2708         public function ucfirst( $str ) {
2709                 $o = ord( $str );
2710                 if ( $o < 96 ) { // if already uppercase...
2711                         return $str;
2712                 } elseif ( $o < 128 ) {
2713                         return ucfirst( $str ); // use PHP's ucfirst()
2714                 } else {
2715                         // fall back to more complex logic in case of multibyte strings
2716                         return $this->uc( $str, true );
2717                 }
2718         }
2719
2720         /**
2721          * Convert a string to uppercase
2722          *
2723          * @param string $str
2724          * @param bool $first
2725          *
2726          * @return string
2727          */
2728         public function uc( $str, $first = false ) {
2729                 if ( $first ) {
2730                         if ( $this->isMultibyte( $str ) ) {
2731                                 return $this->mbUpperChar( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
2732                         } else {
2733                                 return ucfirst( $str );
2734                         }
2735                 } else {
2736                         return $this->isMultibyte( $str ) ? mb_strtoupper( $str ) : strtoupper( $str );
2737                 }
2738         }
2739
2740         /**
2741          * Convert character to uppercase, allowing overrides of the default mb_upper
2742          * behaviour, which is buggy in many ways. Having a conversion table can be
2743          * useful during transitions between PHP versions where unicode changes happen.
2744          * This can make some resources unreachable on-wiki, see discussion at T219279.
2745          * Providing such a conversion table can allow to manage the transition period.
2746          *
2747          * @since 1.34
2748          *
2749          * @param string $char
2750          *
2751          * @return string
2752          */
2753         protected function mbUpperChar( $char ) {
2754                 global $wgOverrideUcfirstCharacters;
2755                 if ( array_key_exists( $char, $wgOverrideUcfirstCharacters ) ) {
2756                         return $wgOverrideUcfirstCharacters[$char];
2757                 } else {
2758                         return mb_strtoupper( $char );
2759                 }
2760         }
2761
2762         /**
2763          * @param string $str
2764          * @return mixed|string
2765          */
2766         function lcfirst( $str ) {
2767                 $o = ord( $str );
2768                 if ( !$o ) {
2769                         return strval( $str );
2770                 } elseif ( $o >= 128 ) {
2771                         return $this->lc( $str, true );
2772                 } elseif ( $o > 96 ) {
2773                         return $str;
2774                 } else {
2775                         $str[0] = strtolower( $str[0] );
2776                         return $str;
2777                 }
2778         }
2779
2780         /**
2781          * @param string $str
2782          * @param bool $first
2783          * @return mixed|string
2784          */
2785         function lc( $str, $first = false ) {
2786                 if ( $first ) {
2787                         if ( $this->isMultibyte( $str ) ) {
2788                                 return mb_strtolower( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
2789                         } else {
2790                                 return strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 );
2791                         }
2792                 } else {
2793                         return $this->isMultibyte( $str ) ? mb_strtolower( $str ) : strtolower( $str );
2794                 }
2795         }
2796
2797         /**
2798          * @param string $str
2799          * @return bool
2800          */
2801         function isMultibyte( $str ) {
2802                 return strlen( $str ) !== mb_strlen( $str );
2803         }
2804
2805         /**
2806          * @param string $str
2807          * @return mixed|string
2808          */
2809         function ucwords( $str ) {
2810                 if ( $this->isMultibyte( $str ) ) {
2811                         $str = $this->lc( $str );
2812
2813                         // regexp to find first letter in each word (i.e. after each space)
2814                         $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)| ([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2815
2816                         // function to use to capitalize a single char
2817                         return preg_replace_callback(
2818                                 $replaceRegexp,
2819                                 [ $this, 'ucwordsCallbackMB' ],
2820                                 $str
2821                         );
2822                 } else {
2823                         return ucwords( strtolower( $str ) );
2824                 }
2825         }
2826
2827         /**
2828          * capitalize words at word breaks
2829          *
2830          * @param string $str
2831          * @return mixed
2832          */
2833         function ucwordbreaks( $str ) {
2834                 if ( $this->isMultibyte( $str ) ) {
2835                         $str = $this->lc( $str );
2836
2837                         // since \b doesn't work for UTF-8, we explicitely define word break chars
2838                         $breaks = "[ \-\(\)\}\{\.,\?!]";
2839
2840                         // find first letter after word break
2841                         $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)|" .
2842                                 "$breaks([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2843
2844                         return preg_replace_callback(
2845                                 $replaceRegexp,
2846                                 [ $this, 'ucwordbreaksCallbackMB' ],
2847                                 $str
2848                         );
2849                 } else {
2850                         return preg_replace_callback(
2851                                 '/\b([\w\x80-\xff]+)\b/',
2852                                 [ $this, 'ucwordbreaksCallbackAscii' ],
2853                                 $str
2854                         );
2855                 }
2856         }
2857
2858         /**
2859          * Return a case-folded representation of $s
2860          *
2861          * This is a representation such that caseFold($s1)==caseFold($s2) if $s1
2862          * and $s2 are the same except for the case of their characters. It is not
2863          * necessary for the value returned to make sense when displayed.
2864          *
2865          * Do *not* perform any other normalisation in this function. If a caller
2866          * uses this function when it should be using a more general normalisation
2867          * function, then fix the caller.
2868          *
2869          * @param string $s
2870          *
2871          * @return string
2872          */
2873         function caseFold( $s ) {
2874                 return $this->uc( $s );
2875         }
2876
2877         /**
2878          * TODO: $s is not always a string per T218883
2879          * @param string $s
2880          * @return string
2881          */
2882         function checkTitleEncoding( $s ) {
2883                 if ( is_array( $s ) ) {
2884                         throw new MWException( 'Given array to checkTitleEncoding.' );
2885                 }
2886                 if ( StringUtils::isUtf8( $s ) ) {
2887                         return $s;
2888                 }
2889
2890                 return $this->iconv( $this->fallback8bitEncoding(), 'utf-8', $s );
2891         }
2892
2893         /**
2894          * @return string
2895          */
2896         function fallback8bitEncoding() {
2897                 return $this->localisationCache->getItem( $this->mCode, 'fallback8bitEncoding' );
2898         }
2899
2900         /**
2901          * Most writing systems use whitespace to break up words.
2902          * Some languages such as Chinese don't conventionally do this,
2903          * which requires special handling when breaking up words for
2904          * searching etc.
2905          *
2906          * @return bool
2907          */
2908         function hasWordBreaks() {
2909                 return true;
2910         }
2911
2912         /**
2913          * Some languages such as Chinese require word segmentation,
2914          * Specify such segmentation when overridden in derived class.
2915          *
2916          * @param string $string
2917          * @return string
2918          */
2919         function segmentByWord( $string ) {
2920                 return $string;
2921         }
2922
2923         /**
2924          * Some languages have special punctuation need to be normalized.
2925          * Make such changes here.
2926          *
2927          * @param string $string
2928          * @return string
2929          */
2930         function normalizeForSearch( $string ) {
2931                 return self::convertDoubleWidth( $string );
2932         }
2933
2934         /**
2935          * convert double-width roman characters to single-width.
2936          * range: ff00-ff5f ~= 0020-007f
2937          *
2938          * @param string $string
2939          *
2940          * @return string
2941          */
2942         protected static function convertDoubleWidth( $string ) {
2943                 static $full = null;
2944                 static $half = null;
2945
2946                 if ( $full === null ) {
2947                         $fullWidth = "０１２３４５６７８９ＡＢＣＤＥＦＧＨＩＪＫＬＭＮＯＰＱＲＳＴＵＶＷＸＹＺａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ";
2948                         $halfWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2949                         $full = str_split( $fullWidth, 3 );
2950                         $half = str_split( $halfWidth );
2951                 }
2952
2953                 $string = str_replace( $full, $half, $string );
2954                 return $string;
2955         }
2956
2957         /**
2958          * @param string $string
2959          * @param string $pattern
2960          * @return string
2961          */
2962         protected static function insertSpace( $string, $pattern ) {
2963                 $string = preg_replace( $pattern, " $1 ", $string );
2964                 $string = preg_replace( '/ +/', ' ', $string );
2965                 return $string;
2966         }
2967
2968         /**
2969          * @param string[] $termsArray
2970          * @return string[]
2971          */
2972         function convertForSearchResult( $termsArray ) {
2973                 # some languages, e.g. Chinese, need to do a conversion
2974                 # in order for search results to be displayed correctly
2975                 return $termsArray;
2976         }
2977
2978         /**
2979          * Get the first character of a string.
2980          *
2981          * @param string $s
2982          * @return string
2983          */
2984         function firstChar( $s ) {
2985                 $matches = [];
2986                 preg_match(
2987                         '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2988                                 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})/',
2989                         $s,
2990                         $matches
2991                 );
2992
2993                 if ( isset( $matches[1] ) ) {
2994                         if ( strlen( $matches[1] ) != 3 ) {
2995                                 return $matches[1];
2996                         }
2997
2998                         // Break down Hangul syllables to grab the first jamo
2999                         $code = UtfNormal\Utils::utf8ToCodepoint( $matches[1] );
3000                         if ( $code < 0xac00 || 0xd7a4 <= $code ) {
3001                                 return $matches[1];
3002                         } elseif ( $code < 0xb098 ) {
3003                                 return "\u{3131}";
3004                         } elseif ( $code < 0xb2e4 ) {
3005                                 return "\u{3134}";
3006                         } elseif ( $code < 0xb77c ) {
3007                                 return "\u{3137}";
3008                         } elseif ( $code < 0xb9c8 ) {
3009                                 return "\u{3139}";
3010                         } elseif ( $code < 0xbc14 ) {
3011                                 return "\u{3141}";
3012                         } elseif ( $code < 0xc0ac ) {
3013                                 return "\u{3142}";
3014                         } elseif ( $code < 0xc544 ) {
3015                                 return "\u{3145}";
3016                         } elseif ( $code < 0xc790 ) {
3017                                 return "\u{3147}";
3018                         } elseif ( $code < 0xcc28 ) {
3019                                 return "\u{3148}";
3020                         } elseif ( $code < 0xce74 ) {
3021                                 return "\u{314A}";
3022                         } elseif ( $code < 0xd0c0 ) {
3023                                 return "\u{314B}";
3024                         } elseif ( $code < 0xd30c ) {
3025                                 return "\u{314C}";
3026                         } elseif ( $code < 0xd558 ) {
3027                                 return "\u{314D}";
3028                         } else {
3029                                 return "\u{314E}";
3030                         }
3031                 } else {
3032                         return '';
3033                 }
3034         }
3035
3036         /**
3037          * Convert a UTF-8 string to normal form C. In Malayalam and Arabic, this
3038          * also cleans up certain backwards-compatible sequences, converting them
3039          * to the modern Unicode equivalent.
3040          *
3041          * This is language-specific for performance reasons only.
3042          *
3043          * @param string $s
3044          *
3045          * @return string
3046          */
3047         public function normalize( $s ) {
3048                 global $wgAllUnicodeFixes;
3049                 $s = UtfNormal\Validator::cleanUp( $s );
3050                 if ( $wgAllUnicodeFixes ) {
3051                         $s = $this->transformUsingPairFile( 'normalize-ar.php', $s );
3052                         $s = $this->transformUsingPairFile( 'normalize-ml.php', $s );
3053                 }
3054
3055                 return $s;
3056         }
3057
3058         /**
3059          * Transform a string using serialized data stored in the given file (which
3060          * must be in the serialized subdirectory of $IP). The file contains pairs
3061          * mapping source characters to destination characters.
3062          *
3063          * The data is cached in process memory. This will go faster if you have the
3064          * FastStringSearch extension.
3065          *
3066          * @param string $file
3067          * @param string $string
3068          *
3069          * @throws MWException
3070          * @return string
3071          */
3072         protected function transformUsingPairFile( $file, $string ) {
3073                 if ( !isset( $this->transformData[$file] ) ) {
3074                         global $IP;
3075                         $data = require "$IP/languages/data/{$file}";
3076                         $this->transformData[$file] = new ReplacementArray( $data );
3077                 }
3078                 return $this->transformData[$file]->replace( $string );
3079         }
3080
3081         /**
3082          * For right-to-left language support
3083          *
3084          * @return bool
3085          */
3086         function isRTL() {
3087                 return $this->localisationCache->getItem( $this->mCode, 'rtl' );
3088         }
3089
3090         /**
3091          * Return the correct HTML 'dir' attribute value for this language.
3092          * @return string
3093          */
3094         function getDir() {
3095                 return $this->isRTL() ? 'rtl' : 'ltr';
3096         }
3097
3098         /**
3099          * Return 'left' or 'right' as appropriate alignment for line-start
3100          * for this language's text direction.
3101          *
3102          * Should be equivalent to CSS3 'start' text-align value....
3103          *
3104          * @return string
3105          */
3106         function alignStart() {
3107                 return $this->isRTL() ? 'right' : 'left';
3108         }
3109
3110         /**
3111          * Return 'right' or 'left' as appropriate alignment for line-end
3112          * for this language's text direction.
3113          *
3114          * Should be equivalent to CSS3 'end' text-align value....
3115          *
3116          * @return string
3117          */
3118         function alignEnd() {
3119                 return $this->isRTL() ? 'left' : 'right';
3120         }
3121
3122         /**
3123          * A hidden direction mark (LRM or RLM), depending on the language direction.
3124          * Unlike getDirMark(), this function returns the character as an HTML entity.
3125          * This function should be used when the output is guaranteed to be HTML,
3126          * because it makes the output HTML source code more readable. When
3127          * the output is plain text or can be escaped, getDirMark() should be used.
3128          *
3129          * @param bool $opposite Get the direction mark opposite to your language
3130          * @return string
3131          * @since 1.20
3132          */
3133         function getDirMarkEntity( $opposite = false ) {
3134                 if ( $opposite ) {
3135                         return $this->isRTL() ? '&lrm;' : '&rlm;';
3136                 }
3137                 return $this->isRTL() ? '&rlm;' : '&lrm;';
3138         }
3139
3140         /**
3141          * A hidden direction mark (LRM or RLM), depending on the language direction.
3142          * This function produces them as invisible Unicode characters and
3143          * the output may be hard to read and debug, so it should only be used
3144          * when the output is plain text or can be escaped. When the output is
3145          * HTML, use getDirMarkEntity() instead.
3146          *
3147          * @param bool $opposite Get the direction mark opposite to your language
3148          * @return string
3149          */
3150         function getDirMark( $opposite = false ) {
3151                 $lrm = "\u{200E}"; # LEFT-TO-RIGHT MARK, commonly abbreviated LRM
3152                 $rlm = "\u{200F}"; # RIGHT-TO-LEFT MARK, commonly abbreviated RLM
3153                 if ( $opposite ) {
3154                         return $this->isRTL() ? $lrm : $rlm;
3155                 }
3156                 return $this->isRTL() ? $rlm : $lrm;
3157         }
3158
3159         /**
3160          * @return array
3161          */
3162         function capitalizeAllNouns() {
3163                 return $this->localisationCache->getItem( $this->mCode, 'capitalizeAllNouns' );
3164         }
3165
3166         /**
3167          * An arrow, depending on the language direction.
3168          *
3169          * @param string $direction The direction of the arrow: forwards (default),
3170          *   backwards, left, right, up, down.
3171          * @return string
3172          */
3173         function getArrow( $direction = 'forwards' ) {
3174                 switch ( $direction ) {
3175                         case 'forwards':
3176                                 return $this->isRTL() ? '←' : '→';
3177                         case 'backwards':
3178                                 return $this->isRTL() ? '→' : '←';
3179                         case 'left':
3180                                 return '←';
3181                         case 'right':
3182                                 return '→';
3183                         case 'up':
3184                                 return '↑';
3185                         case 'down':
3186                                 return '↓';
3187                 }
3188         }
3189
3190         /**
3191          * To allow "foo[[bar]]" to extend the link over the whole word "foobar"
3192          *
3193          * @return bool
3194          */
3195         function linkPrefixExtension() {
3196                 return $this->localisationCache->getItem( $this->mCode, 'linkPrefixExtension' );
3197         }
3198
3199         /**
3200          * Get all magic words from cache.
3201          * @return array
3202          */
3203         function getMagicWords() {
3204                 return $this->localisationCache->getItem( $this->mCode, 'magicWords' );
3205         }
3206
3207         /**
3208          * Fill a MagicWord object with data from here
3209          *
3210          * @param MagicWord $mw
3211          */
3212         function getMagic( $mw ) {
3213                 $rawEntry = $this->mMagicExtensions[$mw->mId] ??
3214                         $this->localisationCache->getSubitem( $this->mCode, 'magicWords', $mw->mId );
3215
3216                 if ( !is_array( $rawEntry ) ) {
3217                         wfWarn( "\"$rawEntry\" is not a valid magic word for \"$mw->mId\"" );
3218                 } else {
3219                         $mw->mCaseSensitive = $rawEntry[0];
3220                         $mw->mSynonyms = array_slice( $rawEntry, 1 );
3221                 }
3222         }
3223
3224         /**
3225          * Add magic words to the extension array
3226          *
3227          * @param array $newWords
3228          */
3229         function addMagicWordsByLang( $newWords ) {
3230                 $fallbackChain = $this->getFallbackLanguages();
3231                 $fallbackChain = array_reverse( $fallbackChain );
3232                 foreach ( $fallbackChain as $code ) {
3233                         if ( isset( $newWords[$code] ) ) {
3234                                 $this->mMagicExtensions = $newWords[$code] + $this->mMagicExtensions;
3235                         }
3236                 }
3237         }
3238
3239         /**
3240          * Get special page names, as an associative array
3241          *   canonical name => array of valid names, including aliases
3242          * @return array
3243          */
3244         function getSpecialPageAliases() {
3245                 // Cache aliases because it may be slow to load them
3246                 if ( is_null( $this->mExtendedSpecialPageAliases ) ) {
3247                         // Initialise array
3248                         $this->mExtendedSpecialPageAliases =
3249                                 $this->localisationCache->getItem( $this->mCode, 'specialPageAliases' );
3250                 }
3251
3252                 return $this->mExtendedSpecialPageAliases;
3253         }
3254
3255         /**
3256          * Italic is unsuitable for some languages
3257          *
3258          * @param string $text The text to be emphasized.
3259          * @return string
3260          */
3261         function emphasize( $text ) {
3262                 return "<em>$text</em>";
3263         }
3264
3265         /**
3266          * Normally we output all numbers in plain en_US style, that is
3267          * 293,291.235 for twohundredninetythreethousand-twohundredninetyone
3268          * point twohundredthirtyfive. However this is not suitable for all
3269          * languages, some such as Bengali (bn) want ২,৯৩,২৯১.২৩৫ and others such as
3270          * Icelandic just want to use commas instead of dots, and dots instead
3271          * of commas like "293.291,235".
3272          *
3273          * An example of this function being called:
3274          * <code>
3275          * wfMessage( 'message' )->numParams( $num )->text()
3276          * </code>
3277          *
3278          * See $separatorTransformTable on MessageIs.php for
3279          * the , => . and . => , implementation.
3280          *
3281          * @todo check if it's viable to use localeconv() for the decimal separator thing.
3282          * @param int|float $number The string to be formatted, should be an integer
3283          *   or a floating point number.
3284          * @param bool $nocommafy Set to true for special numbers like dates
3285          * @return string
3286          */
3287         public function formatNum( $number, $nocommafy = false ) {
3288                 global $wgTranslateNumerals;
3289                 if ( !$nocommafy ) {
3290                         $number = $this->commafy( $number );
3291                         $s = $this->separatorTransformTable();
3292                         if ( $s ) {
3293                                 $number = strtr( $number, $s );
3294                         }
3295                 }
3296
3297                 if ( $wgTranslateNumerals ) {
3298                         $s = $this->digitTransformTable();
3299                         if ( $s ) {
3300                                 $number = strtr( $number, $s );
3301                         }
3302                 }
3303
3304                 return (string)$number;
3305         }
3306
3307         /**
3308          * Front-end for non-commafied formatNum
3309          *
3310          * @param int|float $number The string to be formatted, should be an integer
3311          *        or a floating point number.
3312          * @since 1.21
3313          * @return string
3314          */
3315         public function formatNumNoSeparators( $number ) {
3316                 return $this->formatNum( $number, true );
3317         }
3318
3319         /**
3320          * @param string $number
3321          * @return string
3322          */
3323         public function parseFormattedNumber( $number ) {
3324                 $s = $this->digitTransformTable();
3325                 if ( $s ) {
3326                         // eliminate empty array values such as ''. (T66347)
3327                         $s = array_filter( $s );
3328                         $number = strtr( $number, array_flip( $s ) );
3329                 }
3330
3331                 $s = $this->separatorTransformTable();
3332                 if ( $s ) {
3333                         // eliminate empty array values such as ''. (T66347)
3334                         $s = array_filter( $s );
3335                         $number = strtr( $number, array_flip( $s ) );
3336                 }
3337
3338                 $number = strtr( $number, [ ',' => '' ] );
3339                 return $number;
3340         }
3341
3342         /**
3343          * Adds commas to a given number
3344          * @since 1.19
3345          * @param mixed $number
3346          * @return string
3347          */
3348         function commafy( $number ) {
3349                 $digitGroupingPattern = $this->digitGroupingPattern();
3350                 $minimumGroupingDigits = $this->minimumGroupingDigits();
3351                 if ( $number === null ) {
3352                         return '';
3353                 }
3354
3355                 if ( !$digitGroupingPattern || $digitGroupingPattern === "###,###,###" ) {
3356                         // Default grouping is at thousands, use the same for ###,###,### pattern too.
3357                         // In some languages it's conventional not to insert a thousands separator
3358                         // in numbers that are four digits long (1000-9999).
3359                         if ( $minimumGroupingDigits ) {
3360                                 // Number of '#' characters after last comma in the grouping pattern.
3361                                 // The pattern is hardcoded here, but this would vary for different patterns.
3362                                 $primaryGroupingSize = 3;
3363                                 // Maximum length of a number to suppress digit grouping for.
3364                                 $maximumLength = $minimumGroupingDigits + $primaryGroupingSize - 1;
3365                                 if ( preg_match( '/^\-?\d{1,' . $maximumLength . '}(\.\d+)?$/', $number ) ) {
3366                                         return $number;
3367                                 }
3368                         }
3369                         return strrev( (string)preg_replace( '/(\d{3})(?=\d)(?!\d*\.)/', '$1,', strrev( $number ) ) );
3370                 } else {
3371                         // Ref: http://cldr.unicode.org/translation/number-patterns
3372                         $sign = "";
3373                         if ( intval( $number ) < 0 ) {
3374                                 // For negative numbers apply the algorithm like positive number and add sign.
3375                                 $sign = "-";
3376                                 $number = substr( $number, 1 );
3377                         }
3378                         $integerPart = [];
3379                         $decimalPart = [];
3380                         $numMatches = preg_match_all( "/(#+)/", $digitGroupingPattern, $matches );
3381                         preg_match( "/\d+/", $number, $integerPart );
3382                         preg_match( "/\.\d*/", $number, $decimalPart );
3383                         $groupedNumber = ( count( $decimalPart ) > 0 ) ? $decimalPart[0] : "";
3384                         if ( $groupedNumber === $number ) {
3385                                 // the string does not have any number part. Eg: .12345
3386                                 return $sign . $groupedNumber;
3387                         }
3388                         $start = $end = ( $integerPart ) ? strlen( $integerPart[0] ) : 0;
3389                         while ( $start > 0 ) {
3390                                 $match = $matches[0][$numMatches - 1];
3391                                 $matchLen = strlen( $match );
3392                                 $start = $end - $matchLen;
3393                                 if ( $start < 0 ) {
3394                                         $start = 0;
3395                                 }
3396                                 $groupedNumber = substr( $number, $start, $end - $start ) . $groupedNumber;
3397                                 $end = $start;
3398                                 if ( $numMatches > 1 ) {
3399                                         // use the last pattern for the rest of the number
3400                                         $numMatches--;
3401                                 }
3402                                 if ( $start > 0 ) {
3403                                         $groupedNumber = "," . $groupedNumber;
3404                                 }
3405                         }
3406                         return $sign . $groupedNumber;
3407                 }
3408         }
3409
3410         /**
3411          * @return string
3412          */
3413         function digitGroupingPattern() {
3414                 return $this->localisationCache->getItem( $this->mCode, 'digitGroupingPattern' );
3415         }
3416
3417         /**
3418          * @return array
3419          */
3420         function digitTransformTable() {
3421                 return $this->localisationCache->getItem( $this->mCode, 'digitTransformTable' );
3422         }
3423
3424         /**
3425          * @return array
3426          */
3427         function separatorTransformTable() {
3428                 return $this->localisationCache->getItem( $this->mCode, 'separatorTransformTable' );
3429         }
3430
3431         /**
3432          * @return int|null
3433          */
3434         function minimumGroupingDigits() {
3435                 return $this->localisationCache->getItem( $this->mCode, 'minimumGroupingDigits' );
3436         }
3437
3438         /**
3439          * Take a list of strings and build a locale-friendly comma-separated
3440          * list, using the local comma-separator message.
3441          * The last two strings are chained with an "and".
3442          *
3443          * @param string[] $list
3444          * @return string
3445          */
3446         public function listToText( array $list ) {
3447                 $itemCount = count( $list );
3448                 if ( $itemCount < 1 ) {
3449                         return '';
3450                 }
3451                 $text = array_pop( $list );
3452                 if ( $itemCount > 1 ) {
3453                         $and = $this->msg( 'and' )->escaped();
3454                         $space = $this->msg( 'word-separator' )->escaped();
3455                         $comma = '';
3456                         if ( $itemCount > 2 ) {
3457                                 $comma = $this->msg( 'comma-separator' )->escaped();
3458                         }
3459                         $text = implode( $comma, $list ) . $and . $space . $text;
3460                 }
3461                 return $text;
3462         }
3463
3464         /**
3465          * Take a list of strings and build a locale-friendly comma-separated
3466          * list, using the local comma-separator message.
3467          * @param string[] $list Array of strings to put in a comma list
3468          * @return string
3469          */
3470         function commaList( array $list ) {
3471                 return implode(
3472                         wfMessage( 'comma-separator' )->inLanguage( $this )->escaped(),
3473                         $list
3474                 );
3475         }
3476
3477         /**
3478          * Take a list of strings and build a locale-friendly semicolon-separated
3479          * list, using the local semicolon-separator message.
3480          * @param string[] $list Array of strings to put in a semicolon list
3481          * @return string
3482          */
3483         function semicolonList( array $list ) {
3484                 return implode(
3485                         wfMessage( 'semicolon-separator' )->inLanguage( $this )->escaped(),
3486                         $list
3487                 );
3488         }
3489
3490         /**
3491          * Same as commaList, but separate it with the pipe instead.
3492          * @param string[] $list Array of strings to put in a pipe list
3493          * @return string
3494          */
3495         function pipeList( array $list ) {
3496                 return implode(
3497                         wfMessage( 'pipe-separator' )->inLanguage( $this )->escaped(),
3498                         $list
3499                 );
3500         }
3501
3502         /**
3503          * Truncate a string to a specified length in bytes, appending an optional
3504          * string (e.g. for ellipsis)
3505          *
3506          * If $length is negative, the string will be truncated from the beginning
3507          *
3508          * @since 1.31
3509          *
3510          * @param string $string String to truncate
3511          * @param int $length Maximum length in bytes
3512          * @param string $ellipsis String to append to the end of truncated text
3513          * @param bool $adjustLength Subtract length of ellipsis from $length
3514          *
3515          * @return string
3516          */
3517         function truncateForDatabase( $string, $length, $ellipsis = '...', $adjustLength = true ) {
3518                 return $this->truncateInternal(
3519                         $string, $length, $ellipsis, $adjustLength, 'strlen', 'substr'
3520                 );
3521         }
3522
3523         /**
3524          * Truncate a string to a specified number of characters, appending an optional
3525          * string (e.g. for ellipsis).
3526          *
3527          * This provides multibyte version of truncateForDatabase() method of this class,
3528          * suitable for truncation based on number of characters, instead of number of bytes.
3529          *
3530          * If $length is negative, the string will be truncated from the beginning.
3531          *
3532          * @since 1.31
3533          *
3534          * @param string $string String to truncate
3535          * @param int $length Maximum number of characters
3536          * @param string $ellipsis String to append to the end of truncated text
3537          * @param bool $adjustLength Subtract length of ellipsis from $length
3538          *
3539          * @return string
3540          */
3541         function truncateForVisual( $string, $length, $ellipsis = '...', $adjustLength = true ) {
3542                 // Passing encoding to mb_strlen and mb_substr is optional.
3543                 // Encoding defaults to mb_internal_encoding(), which is set to UTF-8 in Setup.php, so
3544                 // explicit specification of encoding is skipped.
3545                 // Note: Both multibyte methods are callables invoked in truncateInternal.
3546                 return $this->truncateInternal(
3547                         $string, $length, $ellipsis, $adjustLength, 'mb_strlen', 'mb_substr'
3548                 );
3549         }
3550
3551         /**
3552          * Internal method used for truncation. This method abstracts text truncation into
3553          * one common method, allowing users to provide length measurement function and
3554          * function for finding substring.
3555          *
3556          * For usages, see truncateForDatabase and truncateForVisual.
3557          *
3558          * @param string $string String to truncate
3559          * @param int $length Maximum length of final text
3560          * @param string $ellipsis String to append to the end of truncated text
3561          * @param bool $adjustLength Subtract length of ellipsis from $length
3562          * @param callable $measureLength Callable function used for determining the length of text
3563          * @param callable $getSubstring Callable function used for getting the substrings
3564          *
3565          * @return string
3566          */
3567         private function truncateInternal(
3568                 $string, $length, $ellipsis, $adjustLength, callable $measureLength, callable $getSubstring
3569         ) {
3570                 # Check if there is no need to truncate
3571                 if ( $measureLength( $string ) <= abs( $length ) ) {
3572                         return $string; // no need to truncate
3573                 }
3574
3575                 # Use the localized ellipsis character
3576                 if ( $ellipsis == '...' ) {
3577                         $ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
3578                 }
3579                 if ( $length == 0 ) {
3580                         return $ellipsis; // convention
3581                 }
3582
3583                 $stringOriginal = $string;
3584                 # If ellipsis length is >= $length then we can't apply $adjustLength
3585                 if ( $adjustLength && $measureLength( $ellipsis ) >= abs( $length ) ) {
3586                         $string = $ellipsis; // this can be slightly unexpected
3587                 # Otherwise, truncate and add ellipsis...
3588                 } else {
3589                         $ellipsisLength = $adjustLength ? $measureLength( $ellipsis ) : 0;
3590                         if ( $length > 0 ) {
3591                                 $length -= $ellipsisLength;
3592                                 $string = $getSubstring( $string, 0, $length ); // xyz...
3593                                 $string = $this->removeBadCharLast( $string );
3594                                 $string = rtrim( $string ) . $ellipsis;
3595                         } else {
3596                                 $length += $ellipsisLength;
3597                                 $string = $getSubstring( $string, $length ); // ...xyz
3598                                 $string = $this->removeBadCharFirst( $string );
3599                                 $string = $ellipsis . ltrim( $string );
3600                         }
3601                 }
3602
3603                 # Do not truncate if the ellipsis makes the string longer/equal (T24181).
3604                 # This check is *not* redundant if $adjustLength, due to the single case where
3605                 # LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
3606                 if ( $measureLength( $string ) < $measureLength( $stringOriginal ) ) {
3607                         return $string;
3608                 } else {
3609                         return $stringOriginal;
3610                 }
3611         }
3612
3613         /**
3614          * Remove bytes that represent an incomplete Unicode character
3615          * at the end of string (e.g. bytes of the char are missing)
3616          *
3617          * @param string $string
3618          * @return string
3619          */
3620         protected function removeBadCharLast( $string ) {
3621                 if ( $string != '' ) {
3622                         $char = ord( $string[strlen( $string ) - 1] );
3623                         $m = [];
3624                         if ( $char >= 0xc0 ) {
3625                                 # We got the first byte only of a multibyte char; remove it.
3626                                 $string = substr( $string, 0, -1 );
3627                         } elseif ( $char >= 0x80 &&
3628                                 // Use the /s modifier (PCRE_DOTALL) so (.*) also matches newlines
3629                                 preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
3630                                         '[\xf0-\xf7][\x80-\xbf]{1,2})$/s', $string, $m )
3631                         ) {
3632                                 # We chopped in the middle of a character; remove it
3633                                 $string = $m[1];
3634                         }
3635                 }
3636                 return $string;
3637         }
3638
3639         /**
3640          * Remove bytes that represent an incomplete Unicode character
3641          * at the start of string (e.g. bytes of the char are missing)
3642          *
3643          * @param string $string
3644          * @return string
3645          */
3646         protected function removeBadCharFirst( $string ) {
3647                 if ( $string != '' ) {
3648                         $char = ord( $string[0] );
3649                         if ( $char >= 0x80 && $char < 0xc0 ) {
3650                                 # We chopped in the middle of a character; remove the whole thing
3651                                 $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
3652                         }
3653                 }
3654                 return $string;
3655         }
3656
3657         /**
3658          * Truncate a string of valid HTML to a specified length in bytes,
3659          * appending an optional string (e.g. for ellipses), and return valid HTML
3660          *
3661          * This is only intended for styled/linked text, such as HTML with
3662          * tags like <span> and <a>, were the tags are self-contained (valid HTML).
3663          * Also, this will not detect things like "display:none" CSS.
3664          *
3665          * Note: since 1.18 you do not need to leave extra room in $length for ellipses.
3666          *
3667          * @param string $text HTML string to truncate
3668          * @param int $length (zero/positive) Maximum length (including ellipses)
3669          * @param string $ellipsis String to append to the truncated text
3670          * @return string
3671          */
3672         function truncateHtml( $text, $length, $ellipsis = '...' ) {
3673                 # Use the localized ellipsis character
3674                 if ( $ellipsis == '...' ) {
3675                         $ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
3676                 }
3677                 # Check if there is clearly no need to truncate
3678                 if ( $length <= 0 ) {
3679                         return $ellipsis; // no text shown, nothing to format (convention)
3680                 } elseif ( strlen( $text ) <= $length ) {
3681                         return $text; // string short enough even *with* HTML (short-circuit)
3682                 }
3683
3684                 $dispLen = 0; // innerHTML legth so far
3685                 $testingEllipsis = false; // checking if ellipses will make string longer/equal?
3686                 $tagType = 0; // 0-open, 1-close
3687                 $bracketState = 0; // 1-tag start, 2-tag name, 0-neither
3688                 $entityState = 0; // 0-not entity, 1-entity
3689                 $tag = $ret = ''; // accumulated tag name, accumulated result string
3690                 $openTags = []; // open tag stack
3691                 $maybeState = null; // possible truncation state
3692
3693                 $textLen = strlen( $text );
3694                 $neLength = max( 0, $length - strlen( $ellipsis ) ); // non-ellipsis len if truncated
3695                 for ( $pos = 0; true; ++$pos ) {
3696                         # Consider truncation once the display length has reached the maximim.
3697                         # We check if $dispLen > 0 to grab tags for the $neLength = 0 case.
3698                         # Check that we're not in the middle of a bracket/entity...
3699                         if ( $dispLen && $dispLen >= $neLength && $bracketState == 0 && !$entityState ) {
3700                                 if ( !$testingEllipsis ) {
3701                                         $testingEllipsis = true;
3702                                         # Save where we are; we will truncate here unless there turn out to
3703                                         # be so few remaining characters that truncation is not necessary.
3704                                         if ( !$maybeState ) { // already saved? ($neLength = 0 case)
3705                                                 $maybeState = [ $ret, $openTags ]; // save state
3706                                         }
3707                                 } elseif ( $dispLen > $length && $dispLen > strlen( $ellipsis ) ) {
3708                                         # String in fact does need truncation, the truncation point was OK.
3709                                         // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
3710                                         list( $ret, $openTags ) = $maybeState; // reload state
3711                                         $ret = $this->removeBadCharLast( $ret ); // multi-byte char fix
3712                                         $ret .= $ellipsis; // add ellipsis
3713                                         break;
3714                                 }
3715                         }
3716                         if ( $pos >= $textLen ) {
3717                                 break; // extra iteration just for above checks
3718                         }
3719
3720                         # Read the next char...
3721                         $ch = $text[$pos];
3722                         $lastCh = $pos ? $text[$pos - 1] : '';
3723                         $ret .= $ch; // add to result string
3724                         if ( $ch == '<' ) {
3725                                 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags ); // for bad HTML
3726                                 $entityState = 0; // for bad HTML
3727                                 $bracketState = 1; // tag started (checking for backslash)
3728                         } elseif ( $ch == '>' ) {
3729                                 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags );
3730                                 $entityState = 0; // for bad HTML
3731                                 $bracketState = 0; // out of brackets
3732                         } elseif ( $bracketState == 1 ) {
3733                                 if ( $ch == '/' ) {
3734                                         $tagType = 1; // close tag (e.g. "</span>")
3735                                 } else {
3736                                         $tagType = 0; // open tag (e.g. "<span>")
3737                                         $tag .= $ch;
3738                                 }
3739                                 $bracketState = 2; // building tag name
3740                         } elseif ( $bracketState == 2 ) {
3741                                 if ( $ch != ' ' ) {
3742                                         $tag .= $ch;
3743                                 } else {
3744                                         // Name found (e.g. "<a href=..."), add on tag attributes...
3745                                         $pos += $this->truncate_skip( $ret, $text, "<>", $pos + 1 );
3746                                 }
3747                         } elseif ( $bracketState == 0 ) {
3748                                 if ( $entityState ) {
3749                                         if ( $ch == ';' ) {
3750                                                 $entityState = 0;
3751                                                 $dispLen++; // entity is one displayed char
3752                                         }
3753                                 } else {
3754                                         if ( $neLength == 0 && !$maybeState ) {
3755                                                 // Save state without $ch. We want to *hit* the first
3756                                                 // display char (to get tags) but not *use* it if truncating.
3757                                                 $maybeState = [ substr( $ret, 0, -1 ), $openTags ];
3758                                         }
3759                                         if ( $ch == '&' ) {
3760                                                 $entityState = 1; // entity found, (e.g. "&#160;")
3761                                         } else {
3762                                                 $dispLen++; // this char is displayed
3763                                                 // Add the next $max display text chars after this in one swoop...
3764                                                 $max = ( $testingEllipsis ? $length : $neLength ) - $dispLen;
3765                                                 $skipped = $this->truncate_skip( $ret, $text, "<>&", $pos + 1, $max );
3766                                                 $dispLen += $skipped;
3767                                                 $pos += $skipped;
3768                                         }
3769                                 }
3770                         }
3771                 }
3772                 // Close the last tag if left unclosed by bad HTML
3773                 $this->truncate_endBracket( $tag, $text[$textLen - 1], $tagType, $openTags );
3774                 while ( count( $openTags ) > 0 ) {
3775                         $ret .= '</' . array_pop( $openTags ) . '>'; // close open tags
3776                 }
3777                 return $ret;
3778         }
3779
3780         /**
3781          * truncateHtml() helper function
3782          * like strcspn() but adds the skipped chars to $ret
3783          *
3784          * @param string $ret
3785          * @param string $text
3786          * @param string $search
3787          * @param int $start
3788          * @param null|int $len
3789          * @return int
3790          */
3791         private function truncate_skip( &$ret, $text, $search, $start, $len = null ) {
3792                 if ( $len === null ) {
3793                         $len = -1; // -1 means "no limit" for strcspn
3794                 } elseif ( $len < 0 ) {
3795                         $len = 0; // sanity
3796                 }
3797                 $skipCount = 0;
3798                 if ( $start < strlen( $text ) ) {
3799                         $skipCount = strcspn( $text, $search, $start, $len );
3800                         $ret .= substr( $text, $start, $skipCount );
3801                 }
3802                 return $skipCount;
3803         }
3804
3805         /**
3806          * truncateHtml() helper function
3807          * (a) push or pop $tag from $openTags as needed
3808          * (b) clear $tag value
3809          * @param string &$tag Current HTML tag name we are looking at
3810          * @param int $tagType (0-open tag, 1-close tag)
3811          * @param string $lastCh Character before the '>' that ended this tag
3812          * @param array &$openTags Open tag stack (not accounting for $tag)
3813          */
3814         private function truncate_endBracket( &$tag, $tagType, $lastCh, &$openTags ) {
3815                 $tag = ltrim( $tag );
3816                 if ( $tag != '' ) {
3817                         if ( $tagType == 0 && $lastCh != '/' ) {
3818                                 $openTags[] = $tag; // tag opened (didn't close itself)
3819                         } elseif ( $tagType == 1 ) {
3820                                 if ( $openTags && $tag == $openTags[count( $openTags ) - 1] ) {
3821                                         array_pop( $openTags ); // tag closed
3822                                 }
3823                         }
3824                         $tag = '';
3825                 }
3826         }
3827
3828         /**
3829          * Grammatical transformations, needed for inflected languages
3830          * Invoked by putting {{grammar:case|word}} in a message
3831          *
3832          * @param string $word
3833          * @param string $case
3834          * @return string
3835          */
3836         function convertGrammar( $word, $case ) {
3837                 global $wgGrammarForms;
3838                 if ( isset( $wgGrammarForms[$this->getCode()][$case][$word] ) ) {
3839                         return $wgGrammarForms[$this->getCode()][$case][$word];
3840                 }
3841
3842                 $grammarTransformations = $this->getGrammarTransformations();
3843
3844                 if ( isset( $grammarTransformations[$case] ) ) {
3845                         $forms = $grammarTransformations[$case];
3846
3847                         // Some names of grammar rules are aliases for other rules.
3848                         // In such cases the value is a string rather than object,
3849                         // so load the actual rules.
3850                         if ( is_string( $forms ) ) {
3851                                 $forms = $grammarTransformations[$forms];
3852                         }
3853
3854                         foreach ( array_values( $forms ) as $rule ) {
3855                                 $form = $rule[0];
3856
3857                                 if ( $form === '@metadata' ) {
3858                                         continue;
3859                                 }
3860
3861                                 $replacement = $rule[1];
3862
3863                                 $regex = '/' . addcslashes( $form, '/' ) . '/u';
3864                                 $patternMatches = preg_match( $regex, $word );
3865
3866                                 if ( $patternMatches === false ) {
3867                                         wfLogWarning(
3868                                                 'An error occurred while processing grammar. ' .
3869                                                 "Word: '$word'. Regex: /$form/."
3870                                         );
3871                                 } elseif ( $patternMatches === 1 ) {
3872                                         $word = preg_replace( $regex, $replacement, $word );
3873
3874                                         break;
3875                                 }
3876                         }
3877                 }
3878
3879                 return $word;
3880         }
3881
3882         /**
3883          * Get the grammar forms for the content language
3884          * @return array Array of grammar forms
3885          * @since 1.20
3886          */
3887         function getGrammarForms() {
3888                 global $wgGrammarForms;
3889                 if ( isset( $wgGrammarForms[$this->getCode()] )
3890                         && is_array( $wgGrammarForms[$this->getCode()] )
3891                 ) {
3892                         return $wgGrammarForms[$this->getCode()];
3893                 }
3894
3895                 return [];
3896         }
3897
3898         /**
3899          * Get the grammar transformations data for the language.
3900          * Used like grammar forms, with {{GRAMMAR}} and cases,
3901          * but uses pairs of regexes and replacements instead of code.
3902          *
3903          * @return array[] Array of grammar transformations.
3904          * @throws MWException
3905          * @since 1.28
3906          */
3907         public function getGrammarTransformations() {
3908                 $languageCode = $this->getCode();
3909
3910                 if ( self::$grammarTransformations === null ) {
3911                         self::$grammarTransformations = new MapCacheLRU( 10 );
3912                 }
3913
3914                 if ( self::$grammarTransformations->has( $languageCode ) ) {
3915                         return self::$grammarTransformations->get( $languageCode );
3916                 }
3917
3918                 $data = [];
3919
3920                 $grammarDataFile = __DIR__ . "/data/grammarTransformations/$languageCode.json";
3921                 if ( is_readable( $grammarDataFile ) ) {
3922                         $data = FormatJson::decode(
3923                                 file_get_contents( $grammarDataFile ),
3924                                 true
3925                         );
3926
3927                         if ( $data === null ) {
3928                                 throw new MWException( "Invalid grammar data for \"$languageCode\"." );
3929                         }
3930
3931                         self::$grammarTransformations->set( $languageCode, $data );
3932                 }
3933
3934                 return $data;
3935         }
3936
3937         /**
3938          * Provides an alternative text depending on specified gender.
3939          * Usage {{gender:username|masculine|feminine|unknown}}.
3940          * username is optional, in which case the gender of current user is used,
3941          * but only in (some) interface messages; otherwise default gender is used.
3942          *
3943          * If no forms are given, an empty string is returned. If only one form is
3944          * given, it will be returned unconditionally. These details are implied by
3945          * the caller and cannot be overridden in subclasses.
3946          *
3947          * If three forms are given, the default is to use the third (unknown) form.
3948          * If fewer than three forms are given, the default is to use the first (masculine) form.
3949          * These details can be overridden in subclasses.
3950          *
3951          * @param string $gender
3952          * @param array $forms
3953          *
3954          * @return string
3955          */
3956         function gender( $gender, $forms ) {
3957                 if ( !count( $forms ) ) {
3958                         return '';
3959                 }
3960                 $forms = $this->preConvertPlural( $forms, 2 );
3961                 if ( $gender === 'male' ) {
3962                         return $forms[0];
3963                 }
3964                 if ( $gender === 'female' ) {
3965                         return $forms[1];
3966                 }
3967                 return $forms[2] ?? $forms[0];
3968         }
3969
3970         /**
3971          * Plural form transformations, needed for some languages.
3972          * For example, there are 3 form of plural in Russian and Polish,
3973          * depending on "count mod 10". See [[w:Plural]]
3974          * For English it is pretty simple.
3975          *
3976          * Invoked by putting {{plural:count|wordform1|wordform2}}
3977          * or {{plural:count|wordform1|wordform2|wordform3}}
3978          *
3979          * Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
3980          *
3981          * @param int $count Non-localized number
3982          * @param array $forms Different plural forms
3983          * @return string Correct form of plural for $count in this language
3984          */
3985         function convertPlural( $count, $forms ) {
3986                 // Handle explicit n=pluralform cases
3987                 $forms = $this->handleExplicitPluralForms( $count, $forms );
3988                 if ( is_string( $forms ) ) {
3989                         return $forms;
3990                 }
3991                 if ( !count( $forms ) ) {
3992                         return '';
3993                 }
3994
3995                 $pluralForm = $this->getPluralRuleIndexNumber( $count );
3996                 $pluralForm = min( $pluralForm, count( $forms ) - 1 );
3997                 return $forms[$pluralForm];
3998         }
3999
4000         /**
4001          * Handles explicit plural forms for Language::convertPlural()
4002          *
4003          * In {{PLURAL:$1|0=nothing|one|many}}, 0=nothing will be returned if $1 equals zero.
4004          * If an explicitly defined plural form matches the $count, then
4005          * string value returned, otherwise array returned for further consideration
4006          * by CLDR rules or overridden convertPlural().
4007          *
4008          * @since 1.23
4009          *
4010          * @param int $count Non-localized number
4011          * @param array $forms Different plural forms
4012          *
4013          * @return array|string
4014          */
4015         protected function handleExplicitPluralForms( $count, array $forms ) {
4016                 foreach ( $forms as $index => $form ) {
4017                         if ( preg_match( '/\d+=/i', $form ) ) {
4018                                 $pos = strpos( $form, '=' );
4019                                 if ( substr( $form, 0, $pos ) === (string)$count ) {
4020                                         return substr( $form, $pos + 1 );
4021                                 }
4022                                 unset( $forms[$index] );
4023                         }
4024                 }
4025                 return array_values( $forms );
4026         }
4027
4028         /**
4029          * Checks that convertPlural was given an array and pads it to requested
4030          * amount of forms by copying the last one.
4031          *
4032          * @param array $forms
4033          * @param int $count How many forms should there be at least
4034          * @return array Padded array of forms
4035          */
4036         protected function preConvertPlural( /* Array */ $forms, $count ) {
4037                 return array_pad( $forms, $count, end( $forms ) );
4038         }
4039
4040         /**
4041          * Wraps argument with unicode control characters for directionality safety
4042          *
4043          * This solves the problem where directionality-neutral characters at the edge of
4044          * the argument string get interpreted with the wrong directionality from the
4045          * enclosing context, giving renderings that look corrupted like "(Ben_(WMF".
4046          *
4047          * The wrapping is LRE...PDF or RLE...PDF, depending on the detected
4048          * directionality of the argument string, using the BIDI algorithm's own "First
4049          * strong directional codepoint" rule. Essentially, this works round the fact that
4050          * there is no embedding equivalent of U+2068 FSI (isolation with heuristic
4051          * direction inference). The latter is cleaner but still not widely supported.
4052          *
4053          * @param string $text Text to wrap
4054          * @return string Text, wrapped in LRE...PDF or RLE...PDF or nothing
4055          */
4056         public function embedBidi( $text = '' ) {
4057                 $dir = self::strongDirFromContent( $text );
4058                 if ( $dir === 'ltr' ) {
4059                         // Wrap in LEFT-TO-RIGHT EMBEDDING ... POP DIRECTIONAL FORMATTING
4060                         return self::$lre . $text . self::$pdf;
4061                 }
4062                 if ( $dir === 'rtl' ) {
4063                         // Wrap in RIGHT-TO-LEFT EMBEDDING ... POP DIRECTIONAL FORMATTING
4064                         return self::$rle . $text . self::$pdf;
4065                 }
4066                 // No strong directionality: do not wrap
4067                 return $text;
4068         }
4069
4070         /**
4071          * @todo Maybe translate block durations.  Note that this function is somewhat misnamed: it
4072          * deals with translating the *duration* ("1 week", "4 days", etc), not the expiry time
4073          * (which is an absolute timestamp). Please note: do NOT add this blindly, as it is used
4074          * on old expiry lengths recorded in log entries. You'd need to provide the start date to
4075          * match up with it.
4076          *
4077          * @param string $str The validated block duration in English
4078          * @param User|null $user User object to use timezone from or null for $wgUser
4079          * @param int $now Current timestamp, for formatting relative block durations
4080          * @return string Somehow translated block duration
4081          * @see LanguageFi.php for example implementation
4082          */
4083         function translateBlockExpiry( $str, User $user = null, $now = 0 ) {
4084                 $duration = SpecialBlock::getSuggestedDurations( $this );
4085                 foreach ( $duration as $show => $value ) {
4086                         if ( strcmp( $str, $value ) == 0 ) {
4087                                 return htmlspecialchars( trim( $show ) );
4088                         }
4089                 }
4090
4091                 if ( wfIsInfinity( $str ) ) {
4092                         foreach ( $duration as $show => $value ) {
4093                                 if ( wfIsInfinity( $value ) ) {
4094                                         return htmlspecialchars( trim( $show ) );
4095                                 }
4096                         }
4097                 }
4098
4099                 // If all else fails, return a standard duration or timestamp description.
4100                 $time = strtotime( $str, $now );
4101                 if ( $time === false ) { // Unknown format. Return it as-is in case.
4102                         return $str;
4103                 } elseif ( $time !== strtotime( $str, $now + 1 ) ) { // It's a relative timestamp.
4104                         // The result differs based on current time, so the difference
4105                         // is a fixed duration length.
4106                         return $this->formatDuration( $time - $now );
4107                 } else { // It's an absolute timestamp.
4108                         if ( $time === 0 ) {
4109                                 // wfTimestamp() handles 0 as current time instead of epoch.
4110                                 $time = '19700101000000';
4111                         }
4112                         if ( $user ) {
4113                                 return $this->userTimeAndDate( $time, $user );
4114                         }
4115                         return $this->timeanddate( $time );
4116                 }
4117         }
4118
4119         /**
4120          * languages like Chinese need to be segmented in order for the diff
4121          * to be of any use
4122          *
4123          * @param string $text
4124          * @return string
4125          */
4126         public function segmentForDiff( $text ) {
4127                 return $text;
4128         }
4129
4130         /**
4131          * and unsegment to show the result
4132          *
4133          * @param string $text
4134          * @return string
4135          */
4136         public function unsegmentForDiff( $text ) {
4137                 return $text;
4138         }
4139
4140         /**
4141          * Return the LanguageConverter used in the Language
4142          *
4143          * @since 1.19
4144          * @return LanguageConverter
4145          */
4146         public function getConverter() {
4147                 return $this->mConverter;
4148         }
4149
4150         /**
4151          * convert text to a variant
4152          *
4153          * @param string $text text to convert
4154          * @param string|bool $variant variant to convert to, or false to use the user's preferred
4155          *      variant (if logged in), or the project default variant
4156          * @return string the converted string
4157          */
4158         public function autoConvert( $text, $variant = false ) {
4159                 return $this->mConverter->autoConvert( $text, $variant );
4160         }
4161
4162         /**
4163          * convert text to all supported variants
4164          *
4165          * @param string $text
4166          * @return array
4167          */
4168         public function autoConvertToAllVariants( $text ) {
4169                 return $this->mConverter->autoConvertToAllVariants( $text );
4170         }
4171
4172         /**
4173          * convert text to different variants of a language.
4174          *
4175          * @warning Glossary state is maintained between calls. This means
4176          *  if you pass unescaped text to this method it can cause an XSS
4177          *  in later calls to this method, even if the later calls have properly
4178          *  escaped the input. Never feed this method user controlled text that
4179          *  is not properly escaped!
4180          * @param string $text Content that has been already escaped for use in HTML
4181          * @return string HTML
4182          */
4183         public function convert( $text ) {
4184                 return $this->mConverter->convert( $text );
4185         }
4186
4187         /**
4188          * Convert a Title object to a string in the preferred variant
4189          *
4190          * @param Title $title
4191          * @return string
4192          */
4193         public function convertTitle( $title ) {
4194                 return $this->mConverter->convertTitle( $title );
4195         }
4196
4197         /**
4198          * Convert a namespace index to a string in the preferred variant
4199          *
4200          * @param int $ns namespace index (https://www.mediawiki.org/wiki/Manual:Namespace)
4201          * @param string|null $variant variant to convert to, or null to use the user's preferred
4202          *      variant (if logged in), or the project default variant
4203          * @return string a string representation of the namespace
4204          */
4205         public function convertNamespace( $ns, $variant = null ) {
4206                 return $this->mConverter->convertNamespace( $ns, $variant );
4207         }
4208
4209         /**
4210          * Check if this is a language with variants
4211          *
4212          * @return bool
4213          */
4214         public function hasVariants() {
4215                 return count( $this->getVariants() ) > 1;
4216         }
4217
4218         /**
4219          * Strict check if the language has the specific variant.
4220          *
4221          * Compare to LanguageConverter::validateVariant() which does a more
4222          * lenient check and attempts to coerce the given code to a valid one.
4223          *
4224          * @since 1.19
4225          * @param string $variant
4226          * @return bool
4227          */
4228         public function hasVariant( $variant ) {
4229                 return $variant && ( $variant === $this->mConverter->validateVariant( $variant ) );
4230         }
4231
4232         /**
4233          * Perform output conversion on a string, and encode for safe HTML output.
4234          * @param string $text Text to be converted
4235          * @return string
4236          * @todo this should get integrated somewhere sane
4237          */
4238         public function convertHtml( $text ) {
4239                 return htmlspecialchars( $this->convert( $text ) );
4240         }
4241
4242         /**
4243          * @param string $key
4244          * @return string
4245          */
4246         public function convertCategoryKey( $key ) {
4247                 return $this->mConverter->convertCategoryKey( $key );
4248         }
4249
4250         /**
4251          * Get the list of variants supported by this language
4252          * see sample implementation in LanguageZh.php
4253          *
4254          * @return string[] An array of language codes
4255          */
4256         public function getVariants() {
4257                 return $this->mConverter->getVariants();
4258         }
4259
4260         /**
4261          * @return string
4262          */
4263         public function getPreferredVariant() {
4264                 return $this->mConverter->getPreferredVariant();
4265         }
4266
4267         /**
4268          * @return string
4269          */
4270         public function getDefaultVariant() {
4271                 return $this->mConverter->getDefaultVariant();
4272         }
4273
4274         /**
4275          * @return string
4276          */
4277         public function getURLVariant() {
4278                 return $this->mConverter->getURLVariant();
4279         }
4280
4281         /**
4282          * If a language supports multiple variants, it is
4283          * possible that non-existing link in one variant
4284          * actually exists in another variant. this function
4285          * tries to find it. See e.g. LanguageZh.php
4286          * The input parameters may be modified upon return
4287          *
4288          * @param string &$link The name of the link
4289          * @param Title &$nt The title object of the link
4290          * @param bool $ignoreOtherCond To disable other conditions when
4291          *   we need to transclude a template or update a category's link
4292          */
4293         public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
4294                 $this->mConverter->findVariantLink( $link, $nt, $ignoreOtherCond );
4295         }
4296
4297         /**
4298          * returns language specific options used by User::getPageRenderHash()
4299          * for example, the preferred language variant
4300          *
4301          * @return string
4302          */
4303         function getExtraHashOptions() {
4304                 return $this->mConverter->getExtraHashOptions();
4305         }
4306
4307         /**
4308          * For languages that support multiple variants, the title of an
4309          * article may be displayed differently in different variants. this
4310          * function returns the apporiate title defined in the body of the article.
4311          *
4312          * @return string
4313          */
4314         public function getParsedTitle() {
4315                 return $this->mConverter->getParsedTitle();
4316         }
4317
4318         /**
4319          * Refresh the cache of conversion tables when
4320          * MediaWiki:Conversiontable* is updated.
4321          *
4322          * @param Title $title The Title of the page being updated
4323          */
4324         public function updateConversionTable( Title $title ) {
4325                 $this->mConverter->updateConversionTable( $title );
4326         }
4327
4328         /**
4329          * A regular expression to match legal word-trailing characters
4330          * which should be merged onto a link of the form [[foo]]bar.
4331          *
4332          * @return string
4333          */
4334         public function linkTrail() {
4335                 return $this->localisationCache->getItem( $this->mCode, 'linkTrail' );
4336         }
4337
4338         /**
4339          * A regular expression character set to match legal word-prefixing
4340          * characters which should be merged onto a link of the form foo[[bar]].
4341          *
4342          * @return string
4343          */
4344         public function linkPrefixCharset() {
4345                 return $this->localisationCache->getItem( $this->mCode, 'linkPrefixCharset' );
4346         }
4347
4348         /**
4349          * Get the "parent" language which has a converter to convert a "compatible" language
4350          * (in another variant) to this language (eg. zh for zh-cn, but not en for en-gb).
4351          *
4352          * @return Language|null
4353          * @since 1.22
4354          */
4355         public function getParentLanguage() {
4356                 if ( $this->mParentLanguage !== false ) {
4357                         return $this->mParentLanguage;
4358                 }
4359
4360                 $code = explode( '-', $this->getCode() )[0];
4361                 if ( !in_array( $code, LanguageConverter::$languagesWithVariants ) ) {
4362                         $this->mParentLanguage = null;
4363                         return null;
4364                 }
4365                 $lang = self::factory( $code );
4366                 if ( !$lang->hasVariant( $this->getCode() ) ) {
4367                         $this->mParentLanguage = null;
4368                         return null;
4369                 }
4370
4371                 $this->mParentLanguage = $lang;
4372                 return $lang;
4373         }
4374
4375         /**
4376          * Compare with an other language object
4377          *
4378          * @since 1.28
4379          * @param Language $lang
4380          * @return bool
4381          */
4382         public function equals( Language $lang ) {
4383                 return $lang === $this || $lang->getCode() === $this->mCode;
4384         }
4385
4386         /**
4387          * Get the internal language code for this language object
4388          *
4389          * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4390          * htmlspecialchars() or similar
4391          *
4392          * @return string
4393          */
4394         public function getCode() {
4395                 return $this->mCode;
4396         }
4397
4398         /**
4399          * Get the code in BCP 47 format which we can use
4400          * inside of html lang="" tags.
4401          *
4402          * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4403          * htmlspecialchars() or similar.
4404          *
4405          * @since 1.19
4406          * @return string
4407          */
4408         public function getHtmlCode() {
4409                 if ( is_null( $this->mHtmlCode ) ) {
4410                         $this->mHtmlCode = LanguageCode::bcp47( $this->getCode() );
4411                 }
4412                 return $this->mHtmlCode;
4413         }
4414
4415         /**
4416          * Get the language code from a file name. Inverse of getFileName()
4417          * @param string $filename $prefix . $languageCode . $suffix
4418          * @param string $prefix Prefix before the language code
4419          * @param string $suffix Suffix after the language code
4420          * @return string Language code, or false if $prefix or $suffix isn't found
4421          */
4422         public static function getCodeFromFileName( $filename, $prefix = 'Language', $suffix = '.php' ) {
4423                 $m = null;
4424                 preg_match( '/' . preg_quote( $prefix, '/' ) . '([A-Z][a-z_]+)' .
4425                         preg_quote( $suffix, '/' ) . '/', $filename, $m );
4426                 if ( !count( $m ) ) {
4427                         return false;
4428                 }
4429                 return str_replace( '_', '-', strtolower( $m[1] ) );
4430         }
4431
4432         /**
4433          * @param string $code
4434          * @param bool $fallback Whether we're going through language fallback chain
4435          * @return string Name of the language class
4436          */
4437         public static function classFromCode( $code, $fallback = true ) {
4438                 if ( $fallback && $code == 'en' ) {
4439                         return 'Language';
4440                 } else {
4441                         return 'Language' . str_replace( '-', '_', ucfirst( $code ) );
4442                 }
4443         }
4444
4445         /**
4446          * Get the name of a file for a certain language code
4447          * @param string $prefix Prepend this to the filename
4448          * @param string $code Language code
4449          * @param string $suffix Append this to the filename
4450          * @throws MWException
4451          * @return string $prefix . $mangledCode . $suffix
4452          */
4453         public static function getFileName( $prefix, $code, $suffix = '.php' ) {
4454                 if ( !self::isValidBuiltInCode( $code ) ) {
4455                         throw new MWException( "Invalid language code \"$code\"" );
4456                 }
4457
4458                 return $prefix . str_replace( '-', '_', ucfirst( $code ) ) . $suffix;
4459         }
4460
4461         /**
4462          * @param string $code
4463          * @return string
4464          */
4465         public static function getMessagesFileName( $code ) {
4466                 global $IP;
4467                 $file = self::getFileName( "$IP/languages/messages/Messages", $code, '.php' );
4468                 Hooks::run( 'Language::getMessagesFileName', [ $code, &$file ] );
4469                 return $file;
4470         }
4471
4472         /**
4473          * @param string $code
4474          * @return string
4475          * @throws MWException
4476          * @since 1.23
4477          */
4478         public static function getJsonMessagesFileName( $code ) {
4479                 global $IP;
4480
4481                 if ( !self::isValidBuiltInCode( $code ) ) {
4482                         throw new MWException( "Invalid language code \"$code\"" );
4483                 }
4484
4485                 return "$IP/languages/i18n/$code.json";
4486         }
4487
4488         /**
4489          * Get the first fallback for a given language.
4490          *
4491          * @param string $code
4492          *
4493          * @return bool|string
4494          */
4495         public static function getFallbackFor( $code ) {
4496                 $fallbacks = self::getFallbacksFor( $code );
4497                 if ( $fallbacks ) {
4498                         return $fallbacks[0];
4499                 }
4500                 return false;
4501         }
4502
4503         /**
4504          * Get the ordered list of fallback languages.
4505          *
4506          * @since 1.19
4507          * @param string $code Language code
4508          * @param int $mode Fallback mode, either MESSAGES_FALLBACKS (which always falls back to 'en'),
4509          * or STRICT_FALLBACKS (whic honly falls back to 'en' when explicitly defined)
4510          * @throws MWException
4511          * @return array List of language codes
4512          */
4513         public static function getFallbacksFor( $code, $mode = self::MESSAGES_FALLBACKS ) {
4514                 if ( $code === 'en' || !self::isValidBuiltInCode( $code ) ) {
4515                         return [];
4516                 }
4517                 switch ( $mode ) {
4518                         case self::MESSAGES_FALLBACKS:
4519                                 // For unknown languages, fallbackSequence returns an empty array,
4520                                 // hardcode fallback to 'en' in that case as English messages are
4521                                 // always defined.
4522                                 return self::getLocalisationCache()->getItem( $code, 'fallbackSequence' ) ?: [ 'en' ];
4523                         case self::STRICT_FALLBACKS:
4524                                 // Use this mode when you don't want to fallback to English unless
4525                                 // explicitly defined, for example when you have language-variant icons
4526                                 // and an international language-independent fallback.
4527                                 return self::getLocalisationCache()->getItem( $code, 'originalFallbackSequence' );
4528                         default:
4529                                 throw new MWException( "Invalid fallback mode \"$mode\"" );
4530                 }
4531         }
4532
4533         /**
4534          * Get the ordered list of fallback languages, ending with the fallback
4535          * language chain for the site language.
4536          *
4537          * @since 1.22
4538          * @param string $code Language code
4539          * @return array [ fallbacks, site fallbacks ]
4540          */
4541         public static function getFallbacksIncludingSiteLanguage( $code ) {
4542                 global $wgLanguageCode;
4543
4544                 // Usually, we will only store a tiny number of fallback chains, so we
4545                 // keep them in static memory.
4546                 $cacheKey = "{$code}-{$wgLanguageCode}";
4547
4548                 if ( !array_key_exists( $cacheKey, self::$fallbackLanguageCache ) ) {
4549                         $fallbacks = self::getFallbacksFor( $code );
4550
4551                         // Append the site's fallback chain, including the site language itself
4552                         $siteFallbacks = self::getFallbacksFor( $wgLanguageCode );
4553                         array_unshift( $siteFallbacks, $wgLanguageCode );
4554
4555                         // Eliminate any languages already included in the chain
4556                         $siteFallbacks = array_diff( $siteFallbacks, $fallbacks );
4557
4558                         self::$fallbackLanguageCache[$cacheKey] = [ $fallbacks, $siteFallbacks ];
4559                 }
4560                 return self::$fallbackLanguageCache[$cacheKey];
4561         }
4562
4563         /**
4564          * Get all messages for a given language
4565          * WARNING: this may take a long time. If you just need all message *keys*
4566          * but need the *contents* of only a few messages, consider using getMessageKeysFor().
4567          *
4568          * @param string $code
4569          *
4570          * @return array
4571          */
4572         public static function getMessagesFor( $code ) {
4573                 return self::getLocalisationCache()->getItem( $code, 'messages' );
4574         }
4575
4576         /**
4577          * Get a message for a given language
4578          *
4579          * @param string $key
4580          * @param string $code
4581          *
4582          * @return string
4583          */
4584         public static function getMessageFor( $key, $code ) {
4585                 return self::getLocalisationCache()->getSubitem( $code, 'messages', $key );
4586         }
4587
4588         /**
4589          * Get all message keys for a given language. This is a faster alternative to
4590          * array_keys( Language::getMessagesFor( $code ) )
4591          *
4592          * @since 1.19
4593          * @param string $code Language code
4594          * @return array Array of message keys (strings)
4595          */
4596         public static function getMessageKeysFor( $code ) {
4597                 return self::getLocalisationCache()->getSubitemList( $code, 'messages' );
4598         }
4599
4600         /**
4601          * @param string $talk
4602          * @return string
4603          */
4604         function fixVariableInNamespace( $talk ) {
4605                 if ( strpos( $talk, '$1' ) === false ) {
4606                         return $talk;
4607                 }
4608
4609                 global $wgMetaNamespace;
4610                 $talk = str_replace( '$1', $wgMetaNamespace, $talk );
4611
4612                 # Allow grammar transformations
4613                 # Allowing full message-style parsing would make simple requests
4614                 # such as action=raw much more expensive than they need to be.
4615                 # This will hopefully cover most cases.
4616                 $talk = preg_replace_callback( '/{{grammar:(.*?)\|(.*?)}}/i',
4617                         [ $this, 'replaceGrammarInNamespace' ], $talk );
4618                 return str_replace( ' ', '_', $talk );
4619         }
4620
4621         /**
4622          * @param string $m
4623          * @return string
4624          */
4625         function replaceGrammarInNamespace( $m ) {
4626                 return $this->convertGrammar( trim( $m[2] ), trim( $m[1] ) );
4627         }
4628
4629         /**
4630          * Decode an expiry (block, protection, etc) which has come from the DB
4631          *
4632          * @param string $expiry Database expiry String
4633          * @param bool|int $format True to process using language functions, or TS_ constant
4634          *     to return the expiry in a given timestamp
4635          * @param string $infinity If $format is not true, use this string for infinite expiry
4636          * @return string
4637          * @since 1.18
4638          */
4639         public function formatExpiry( $expiry, $format = true, $infinity = 'infinity' ) {
4640                 static $dbInfinity;
4641                 if ( $dbInfinity === null ) {
4642                         $dbInfinity = wfGetDB( DB_REPLICA )->getInfinity();
4643                 }
4644
4645                 if ( $expiry == '' || $expiry === 'infinity' || $expiry == $dbInfinity ) {
4646                         return $format === true
4647                                 ? $this->getMessageFromDB( 'infiniteblock' )
4648                                 : $infinity;
4649                 } else {
4650                         return $format === true
4651                                 ? $this->timeanddate( $expiry, /* User preference timezone */ true )
4652                                 : wfTimestamp( $format, $expiry );
4653                 }
4654         }
4655
4656         /**
4657          * Formats a time given in seconds into a string representation of that time.
4658          *
4659          * @param int|float $seconds
4660          * @param array $format An optional argument that formats the returned string in different ways:
4661          *   If $format['avoid'] === 'avoidhours': don't show hours, just show days
4662          *   If $format['avoid'] === 'avoidseconds': don't show seconds if $seconds >= 1 hour,
4663          *   If $format['avoid'] === 'avoidminutes': don't show seconds/minutes if $seconds > 48 hours,
4664          *   If $format['noabbrevs'] is true: use 'seconds' and friends instead of 'seconds-abbrev'
4665          *     and friends.
4666          * @note For backwards compatibility, $format may also be one of the strings 'avoidseconds'
4667          *     or 'avoidminutes'.
4668          * @return string
4669          */
4670         function formatTimePeriod( $seconds, $format = [] ) {
4671                 if ( !is_array( $format ) ) {
4672                         $format = [ 'avoid' => $format ]; // For backwards compatibility
4673                 }
4674                 if ( !isset( $format['avoid'] ) ) {
4675                         $format['avoid'] = false;
4676                 }
4677                 if ( !isset( $format['noabbrevs'] ) ) {
4678                         $format['noabbrevs'] = false;
4679                 }
4680                 $secondsMsg = wfMessage(
4681                         $format['noabbrevs'] ? 'seconds' : 'seconds-abbrev' )->inLanguage( $this );
4682                 $minutesMsg = wfMessage(
4683                         $format['noabbrevs'] ? 'minutes' : 'minutes-abbrev' )->inLanguage( $this );
4684                 $hoursMsg = wfMessage(
4685                         $format['noabbrevs'] ? 'hours' : 'hours-abbrev' )->inLanguage( $this );
4686                 $daysMsg = wfMessage(
4687                         $format['noabbrevs'] ? 'days' : 'days-abbrev' )->inLanguage( $this );
4688
4689                 if ( round( $seconds * 10 ) < 100 ) {
4690                         $s = $this->formatNum( sprintf( "%.1f", round( $seconds * 10 ) / 10 ) );
4691                         $s = $secondsMsg->params( $s )->text();
4692                 } elseif ( round( $seconds ) < 60 ) {
4693                         $s = $this->formatNum( round( $seconds ) );
4694                         $s = $secondsMsg->params( $s )->text();
4695                 } elseif ( round( $seconds ) < 3600 ) {
4696                         $minutes = floor( $seconds / 60 );
4697                         $secondsPart = round( fmod( $seconds, 60 ) );
4698                         if ( $secondsPart == 60 ) {
4699                                 $secondsPart = 0;
4700                                 $minutes++;
4701                         }
4702                         $s = $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4703                         $s .= ' ';
4704                         $s .= $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
4705                 } elseif ( round( $seconds ) <= 2 * 86400 ) {
4706                         $hours = floor( $seconds / 3600 );
4707                         $minutes = floor( ( $seconds - $hours * 3600 ) / 60 );
4708                         $secondsPart = round( $seconds - $hours * 3600 - $minutes * 60 );
4709                         if ( $secondsPart == 60 ) {
4710                                 $secondsPart = 0;
4711                                 $minutes++;
4712                         }
4713                         if ( $minutes == 60 ) {
4714                                 $minutes = 0;
4715                                 $hours++;
4716                         }
4717                         $s = $hoursMsg->params( $this->formatNum( $hours ) )->text();
4718                         $s .= ' ';
4719                         $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4720                         if ( !in_array( $format['avoid'], [ 'avoidseconds', 'avoidminutes', 'avoidhours' ] ) ) {
4721                                 $s .= ' ' . $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
4722                         }
4723                 } else {
4724                         $days = floor( $seconds / 86400 );
4725                         if ( $format['avoid'] === 'avoidhours' ) {
4726                                 $hours = round( ( $seconds - $days * 86400 ) / 3600 );
4727                                 if ( $hours == 24 ) {
4728                                         $hours = 0;
4729                                         $days++;
4730                                 }
4731                                 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4732                         } elseif ( $format['avoid'] === 'avoidminutes' ) {
4733                                 $hours = round( ( $seconds - $days * 86400 ) / 3600 );
4734                                 if ( $hours == 24 ) {
4735                                         $hours = 0;
4736                                         $days++;
4737                                 }
4738                                 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4739                                 $s .= ' ';
4740                                 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
4741                         } elseif ( $format['avoid'] === 'avoidseconds' ) {
4742                                 $hours = floor( ( $seconds - $days * 86400 ) / 3600 );
4743                                 $minutes = round( ( $seconds - $days * 86400 - $hours * 3600 ) / 60 );
4744                                 if ( $minutes == 60 ) {
4745                                         $minutes = 0;
4746                                         $hours++;
4747                                 }
4748                                 if ( $hours == 24 ) {
4749                                         $hours = 0;
4750                                         $days++;
4751                                 }
4752                                 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4753                                 $s .= ' ';
4754                                 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
4755                                 $s .= ' ';
4756                                 $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4757                         } else {
4758                                 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4759                                 $s .= ' ';
4760                                 $s .= $this->formatTimePeriod( $seconds - $days * 86400, $format );
4761                         }
4762                 }
4763                 return $s;
4764         }
4765
4766         /**
4767          * Format a bitrate for output, using an appropriate
4768          * unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps or Ybps) according to
4769          *   the magnitude in question.
4770          *
4771          * This use base 1000. For base 1024 use formatSize(), for another base
4772          * see formatComputingNumbers().
4773          *
4774          * @param int $bps
4775          * @return string
4776          */
4777         function formatBitrate( $bps ) {
4778                 return $this->formatComputingNumbers( $bps, 1000, "bitrate-$1bits" );
4779         }
4780
4781         /**
4782          * @param int $size Size of the unit
4783          * @param int $boundary Size boundary (1000, or 1024 in most cases)
4784          * @param string $messageKey Message key to be uesd
4785          * @return string
4786          */
4787         function formatComputingNumbers( $size, $boundary, $messageKey ) {
4788                 if ( $size <= 0 ) {
4789                         return str_replace( '$1', $this->formatNum( $size ),
4790                                 $this->getMessageFromDB( str_replace( '$1', '', $messageKey ) )
4791                         );
4792                 }
4793                 $sizes = [ '', 'kilo', 'mega', 'giga', 'tera', 'peta', 'exa', 'zeta', 'yotta' ];
4794                 $index = 0;
4795
4796                 $maxIndex = count( $sizes ) - 1;
4797                 while ( $size >= $boundary && $index < $maxIndex ) {
4798                         $index++;
4799                         $size /= $boundary;
4800                 }
4801
4802                 // For small sizes no decimal places necessary
4803                 $round = 0;
4804                 if ( $index > 1 ) {
4805                         // For MB and bigger two decimal places are smarter
4806                         $round = 2;
4807                 }
4808                 $msg = str_replace( '$1', $sizes[$index], $messageKey );
4809
4810                 $size = round( $size, $round );
4811                 $text = $this->getMessageFromDB( $msg );
4812                 return str_replace( '$1', $this->formatNum( $size ), $text );
4813         }
4814
4815         /**
4816          * Format a size in bytes for output, using an appropriate
4817          * unit (B, KB, MB, GB, TB, PB, EB, ZB or YB) according to the magnitude in question
4818          *
4819          * This method use base 1024. For base 1000 use formatBitrate(), for
4820          * another base see formatComputingNumbers()
4821          *
4822          * @param int $size Size to format
4823          * @return string Plain text (not HTML)
4824          */
4825         function formatSize( $size ) {
4826                 return $this->formatComputingNumbers( $size, 1024, "size-$1bytes" );
4827         }
4828
4829         /**
4830          * Make a list item, used by various special pages
4831          *
4832          * @param string $page Page link
4833          * @param string $details HTML safe text between brackets
4834          * @param bool $oppositedm Add the direction mark opposite to your
4835          *   language, to display text properly
4836          * @return string HTML escaped
4837          */
4838         function specialList( $page, $details, $oppositedm = true ) {
4839                 if ( !$details ) {
4840                         return $page;
4841                 }
4842
4843                 $dirmark = ( $oppositedm ? $this->getDirMark( true ) : '' ) . $this->getDirMark();
4844                 return $page .
4845                         $dirmark .
4846                         $this->msg( 'word-separator' )->escaped() .
4847                         $this->msg( 'parentheses' )->rawParams( $details )->escaped();
4848         }
4849
4850         /**
4851          * Generate (prev x| next x) (20|50|100...) type links for paging
4852          *
4853          * @param Title $title Title object to link
4854          * @param int $offset
4855          * @param int $limit
4856          * @param array $query Optional URL query parameter string
4857          * @param bool $atend Optional param for specified if this is the last page
4858          * @return string
4859          * @deprecated since 1.34, use PrevNextNavigationRenderer::buildPrevNextNavigation()
4860          *  instead.
4861          */
4862         public function viewPrevNext( Title $title, $offset, $limit,
4863                 array $query = [], $atend = false
4864         ) {
4865                 wfDeprecated( __METHOD__, '1.34' );
4866                 // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
4867
4868                 # Make 'previous' link
4869                 $prev = wfMessage( 'prevn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4870                 if ( $offset > 0 ) {
4871                         $plink = $this->numLink( $title, max( $offset - $limit, 0 ), $limit,
4872                                 $query, $prev, 'prevn-title', 'mw-prevlink' );
4873                 } else {
4874                         $plink = htmlspecialchars( $prev );
4875                 }
4876
4877                 # Make 'next' link
4878                 $next = wfMessage( 'nextn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4879                 if ( $atend ) {
4880                         $nlink = htmlspecialchars( $next );
4881                 } else {
4882                         $nlink = $this->numLink( $title, $offset + $limit, $limit,
4883                                 $query, $next, 'nextn-title', 'mw-nextlink' );
4884                 }
4885
4886                 # Make links to set number of items per page
4887                 $numLinks = [];
4888                 foreach ( [ 20, 50, 100, 250, 500 ] as $num ) {
4889                         $numLinks[] = $this->numLink( $title, $offset, $num,
4890                                 $query, $this->formatNum( $num ), 'shown-title', 'mw-numlink' );
4891                 }
4892
4893                 return wfMessage( 'viewprevnext' )->inLanguage( $this )->title( $title
4894                         )->rawParams( $plink, $nlink, $this->pipeList( $numLinks ) )->escaped();
4895         }
4896
4897         /**
4898          * Helper function for viewPrevNext() that generates links
4899          *
4900          * @param Title $title Title object to link
4901          * @param int $offset
4902          * @param int $limit
4903          * @param array $query Extra query parameters
4904          * @param string $link Text to use for the link; will be escaped
4905          * @param string $tooltipMsg Name of the message to use as tooltip
4906          * @param string $class Value of the "class" attribute of the link
4907          * @return string HTML fragment
4908          */
4909         private function numLink( Title $title, $offset, $limit, array $query, $link,
4910                 $tooltipMsg, $class
4911         ) {
4912                 $query = [ 'limit' => $limit, 'offset' => $offset ] + $query;
4913                 $tooltip = wfMessage( $tooltipMsg )->inLanguage( $this )->title( $title )
4914                         ->numParams( $limit )->text();
4915
4916                 return Html::element( 'a', [ 'href' => $title->getLocalURL( $query ),
4917                         'title' => $tooltip, 'class' => $class ], $link );
4918         }
4919
4920         /**
4921          * Get the conversion rule title, if any.
4922          *
4923          * @return string
4924          */
4925         public function getConvRuleTitle() {
4926                 return $this->mConverter->getConvRuleTitle();
4927         }
4928
4929         /**
4930          * Get the compiled plural rules for the language
4931          * @since 1.20
4932          * @return array Associative array with plural form, and plural rule as key-value pairs
4933          */
4934         public function getCompiledPluralRules() {
4935                 $pluralRules =
4936                         $this->localisationCache->getItem( strtolower( $this->mCode ), 'compiledPluralRules' );
4937                 $fallbacks = self::getFallbacksFor( $this->mCode );
4938                 if ( !$pluralRules ) {
4939                         foreach ( $fallbacks as $fallbackCode ) {
4940                                 $pluralRules = $this->localisationCache
4941                                         ->getItem( strtolower( $fallbackCode ), 'compiledPluralRules' );
4942                                 if ( $pluralRules ) {
4943                                         break;
4944                                 }
4945                         }
4946                 }
4947                 return $pluralRules;
4948         }
4949
4950         /**
4951          * Get the plural rules for the language
4952          * @since 1.20
4953          * @return array Associative array with plural form number and plural rule as key-value pairs
4954          */
4955         public function getPluralRules() {
4956                 $pluralRules =
4957                         $this->localisationCache->getItem( strtolower( $this->mCode ), 'pluralRules' );
4958                 $fallbacks = self::getFallbacksFor( $this->mCode );
4959                 if ( !$pluralRules ) {
4960                         foreach ( $fallbacks as $fallbackCode ) {
4961                                 $pluralRules = $this->localisationCache
4962                                         ->getItem( strtolower( $fallbackCode ), 'pluralRules' );
4963                                 if ( $pluralRules ) {
4964                                         break;
4965                                 }
4966                         }
4967                 }
4968                 return $pluralRules;
4969         }
4970
4971         /**
4972          * Get the plural rule types for the language
4973          * @since 1.22
4974          * @return array Associative array with plural form number and plural rule type as key-value pairs
4975          */
4976         public function getPluralRuleTypes() {
4977                 $pluralRuleTypes =
4978                         $this->localisationCache->getItem( strtolower( $this->mCode ), 'pluralRuleTypes' );
4979                 $fallbacks = self::getFallbacksFor( $this->mCode );
4980                 if ( !$pluralRuleTypes ) {
4981                         foreach ( $fallbacks as $fallbackCode ) {
4982                                 $pluralRuleTypes = $this->localisationCache
4983                                         ->getItem( strtolower( $fallbackCode ), 'pluralRuleTypes' );
4984                                 if ( $pluralRuleTypes ) {
4985                                         break;
4986                                 }
4987                         }
4988                 }
4989                 return $pluralRuleTypes;
4990         }
4991
4992         /**
4993          * Find the index number of the plural rule appropriate for the given number
4994          * @param int $number
4995          * @return int The index number of the plural rule
4996          */
4997         public function getPluralRuleIndexNumber( $number ) {
4998                 $pluralRules = $this->getCompiledPluralRules();
4999                 $form = Evaluator::evaluateCompiled( $number, $pluralRules );
5000                 return $form;
5001         }
5002
5003         /**
5004          * Find the plural rule type appropriate for the given number
5005          * For example, if the language is set to Arabic, getPluralType(5) should
5006          * return 'few'.
5007          * @since 1.22
5008          * @param int $number
5009          * @return string The name of the plural rule type, e.g. one, two, few, many
5010          */
5011         public function getPluralRuleType( $number ) {
5012                 $index = $this->getPluralRuleIndexNumber( $number );
5013                 $pluralRuleTypes = $this->getPluralRuleTypes();
5014                 return $pluralRuleTypes[$index] ?? 'other';
5015         }
5016 }