src/Language.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin;
   6
   7 use function __;
   8 use function _bindtextdomain;
   9 use function _setlocale;
  10 use function _textdomain;
  11 use function addcslashes;
  12 use function function_exists;
  13 use function in_array;
  14 use function preg_match;
  15 use function setlocale;
  16 use function str_contains;
  17 use function str_replace;
  18 use function strcmp;
  19
  20 /**
  21  * Language object
  22  */
  23 class Language
  24 {
  25     protected string $regex;
  26
  27     /**
  28      * Constructs the Language object
  29      *
  30      * @param string $code   Language code
  31      * @param string $name   English name
  32      * @param string $native Native name
  33      * @param string $regex  Match regular expression
  34      * @param string $mysql  MySQL locale code
  35      */
  36     public function __construct(
  37         protected string $code,
  38         protected string $name,
  39         protected string $native,
  40         string $regex,
  41         protected string $mysql,
  42     ) {
  43         if (! str_contains($regex, '[-_]')) {
  44             $regex = str_replace('|', '([-_][[:alpha:]]{2,3})?|', $regex);
  45         }
  46
  47         $this->regex = $regex;
  48     }
  49
  50     /**
  51      * Returns native name for language
  52      */
  53     public function getNativeName(): string
  54     {
  55         return $this->native;
  56     }
  57
  58     /**
  59      * Returns English name for language
  60      */
  61     public function getEnglishName(): string
  62     {
  63         return $this->name;
  64     }
  65
  66     /**
  67      * Returns verbose name for language
  68      */
  69     public function getName(): string
  70     {
  71         if ($this->native !== '') {
  72             return $this->native . ' - ' . $this->name;
  73         }
  74
  75         return $this->name;
  76     }
  77
  78     /**
  79      * Returns language code
  80      */
  81     public function getCode(): string
  82     {
  83         return $this->code;
  84     }
  85
  86     /**
  87      * Returns MySQL locale code, can be empty
  88      */
  89     public function getMySQLLocale(): string
  90     {
  91         return $this->mysql;
  92     }
  93
  94     /**
  95      * Compare function used for sorting
  96      *
  97      * @param Language $other Other object to compare
  98      *
  99      * @return int same as strcmp
 100      */
 101     public function cmp(Language $other): int
 102     {
 103         return strcmp($this->name, $other->name);
 104     }
 105
 106     /**
 107      * Checks whether language is currently active.
 108      */
 109     public function isActive(): bool
 110     {
 111         return $GLOBALS['lang'] == $this->code;
 112     }
 113
 114     /**
 115      * Checks whether language matches HTTP header Accept-Language.
 116      *
 117      * @param string $header Header content
 118      */
 119     public function matchesAcceptLanguage(string $header): bool
 120     {
 121         $pattern = '/^('
 122             . addcslashes($this->regex, '/')
 123             . ')(;q=[0-9]\\.[0-9])?$/i';
 124
 125         return (bool) preg_match($pattern, $header);
 126     }
 127
 128     /**
 129      * Checks whether language matches HTTP header User-Agent
 130      *
 131      * @param string $header Header content
 132      */
 133     public function matchesUserAgent(string $header): bool
 134     {
 135         $pattern = '/(\(|\[|;[[:space:]])('
 136             . addcslashes($this->regex, '/')
 137             . ')(;|\]|\))/i';
 138
 139         return (bool) preg_match($pattern, $header);
 140     }
 141
 142     /**
 143      * Checks whether language is RTL
 144      */
 145     public function isRTL(): bool
 146     {
 147         return in_array($this->code, ['ar', 'fa', 'he', 'ur'], true);
 148     }
 149
 150     /**
 151      * Activates given translation
 152      */
 153     public function activate(): void
 154     {
 155         $GLOBALS['lang'] = $this->code;
 156
 157         // Set locale
 158         _setlocale(0, $this->code);
 159         _bindtextdomain('phpmyadmin', LOCALE_PATH);
 160         _textdomain('phpmyadmin');
 161         // Set PHP locale as well
 162         if (function_exists('setlocale')) {
 163             setlocale(0, $this->code);
 164         }
 165
 166         /* Text direction for language */
 167         LanguageManager::$textDir = $this->isRTL() ? 'rtl' : 'ltr';
 168
 169         /* TCPDF */
 170         $GLOBALS['l'] = [];
 171
 172         /* TCPDF settings */
 173         $GLOBALS['l']['a_meta_charset'] = 'UTF-8';
 174         $GLOBALS['l']['a_meta_dir'] = LanguageManager::$textDir;
 175         $GLOBALS['l']['a_meta_language'] = $this->code;
 176
 177         /* TCPDF translations */
 178         $GLOBALS['l']['w_page'] = __('Page number:');
 179
 180         /* Show possible warnings from language selection */
 181         LanguageManager::getInstance()->showWarnings();
 182     }
 183 }