test/classes/LanguageTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Tests;
   6
   7 use PhpMyAdmin\LanguageManager;
   8
   9 use function _ngettext;
  10 use function count;
  11 use function is_readable;
  12 use function strtolower;
  13
  14 /**
  15  * @covers \PhpMyAdmin\Language
  16  * @covers \PhpMyAdmin\LanguageManager
  17  */
  18 class LanguageTest extends AbstractTestCase
  19 {
  20     /** @var LanguageManager */
  21     private $manager;
  22
  23     /**
  24      * Setup for Language tests.
  25      */
  26     protected function setUp(): void
  27     {
  28         parent::setUp();
  29         $loc = LOCALE_PATH . '/cs/LC_MESSAGES/phpmyadmin.mo';
  30         if (! is_readable($loc)) {
  31             $this->markTestSkipped('Missing compiled locales.');
  32         }
  33
  34         $this->manager = new LanguageManager();
  35     }
  36
  37     protected function tearDown(): void
  38     {
  39         parent::tearDown();
  40         // Ensure we have English locale after tests
  41         $lang = $this->manager->getLanguage('en');
  42         if ($lang === false) {
  43             return;
  44         }
  45
  46         $lang->activate();
  47     }
  48
  49     /**
  50      * Test language filtering
  51      */
  52     public function testAvailable(): void
  53     {
  54         $GLOBALS['config']->set('FilterLanguages', 'cs|en$');
  55
  56         $langs = $this->manager->availableLocales();
  57
  58         $this->assertCount(2, $langs);
  59         $this->assertContains('cs', $langs);
  60         $GLOBALS['config']->set('FilterLanguages', '');
  61     }
  62
  63     /**
  64      * Test no language filtering
  65      */
  66     public function testAllAvailable(): void
  67     {
  68         $GLOBALS['config']->set('FilterLanguages', '');
  69
  70         $langs = $this->manager->availableLocales();
  71
  72         $this->assertContains('cs', $langs);
  73         $this->assertContains('en', $langs);
  74     }
  75
  76     /**
  77      * Test whether listing locales works
  78      */
  79     public function testList(): void
  80     {
  81         $langs = $this->manager->listLocaleDir();
  82         $this->assertContains('cs', $langs);
  83         $this->assertContains('en', $langs);
  84     }
  85
  86     /**
  87      * Test for getting available languages
  88      */
  89     public function testLanguages(): void
  90     {
  91         $langs = $this->manager->availableLanguages();
  92         $this->assertGreaterThan(1, count($langs));
  93
  94         /* Ensure we have name for every language */
  95         foreach ($langs as $lang) {
  96             $this->assertNotEquals(
  97                 $lang->getCode(),
  98                 strtolower($lang->getEnglishName()),
  99                 'Maybe this language does not exist in LanguageManager class'
 100                 . ', see: https://github.com/phpmyadmin/phpmyadmin/issues/16300.'
 101             );
 102         }
 103     }
 104
 105     /**
 106      * Test for MySQL locales
 107      */
 108     public function testMySQLLocale(): void
 109     {
 110         $GLOBALS['config']->set('FilterLanguages', '');
 111         $czech = $this->manager->getLanguage('cs');
 112         $this->assertNotFalse($czech);
 113         $this->assertEquals('cs_CZ', $czech->getMySQLLocale());
 114
 115         $azerbaijani = $this->manager->getLanguage('az');
 116         $this->assertNotFalse($azerbaijani);
 117         $this->assertEquals('', $azerbaijani->getMySQLLocale());
 118     }
 119
 120     /**
 121      * Test for getting available sorted languages
 122      */
 123     public function testSortedLanguages(): void
 124     {
 125         $langs = $this->manager->sortedLanguages();
 126         $this->assertGreaterThan(1, count($langs));
 127     }
 128
 129     /**
 130      * Test getting language by code
 131      */
 132     public function testGet(): void
 133     {
 134         $GLOBALS['config']->set('FilterLanguages', '');
 135         $lang = $this->manager->getLanguage('cs');
 136         $this->assertNotFalse($lang);
 137         $this->assertEquals('Czech', $lang->getEnglishName());
 138         $this->assertEquals('Čeština', $lang->getNativeName());
 139         $lang = $this->manager->getLanguage('nonexisting');
 140         $this->assertFalse($lang);
 141     }
 142
 143     /**
 144      * Test language selection
 145      *
 146      * @param string $lang    Value for forced language
 147      * @param string $post    Value for language in POST
 148      * @param string $get     Value for language in GET
 149      * @param string $cookie  Value for language in COOKIE
 150      * @param string $accept  Value for HTTP Accept-Language header
 151      * @param string $agent   Value for HTTP User-Agent header
 152      * @param string $default Value for default language
 153      * @param string $expect  Expected language name
 154      *
 155      * @dataProvider selectDataProvider
 156      */
 157     public function testSelect(
 158         string $lang,
 159         string $post,
 160         string $get,
 161         string $cookie,
 162         string $accept,
 163         string $agent,
 164         string $default,
 165         string $expect
 166     ): void {
 167         $GLOBALS['config']->set('FilterLanguages', '');
 168         $GLOBALS['config']->set('Lang', $lang);
 169         $GLOBALS['config']->set('is_https', false);
 170         $_POST['lang'] = $post;
 171         $_GET['lang'] = $get;
 172         $_COOKIE['pma_lang'] = $cookie;
 173         $_SERVER['HTTP_ACCEPT_LANGUAGE'] = $accept;
 174         $_SERVER['HTTP_USER_AGENT'] = $agent;
 175         $GLOBALS['config']->set('DefaultLang', $default);
 176
 177         $lang = $this->manager->selectLanguage();
 178
 179         $this->assertEquals($expect, $lang->getEnglishName());
 180
 181         $GLOBALS['config']->set('Lang', '');
 182         $_POST['lang'] = '';
 183         $_GET['lang'] = '';
 184         $_COOKIE['pma_lang'] = '';
 185         $_SERVER['HTTP_ACCEPT_LANGUAGE'] = '';
 186         $_SERVER['HTTP_USER_AGENT'] = '';
 187         $GLOBALS['config']->set('DefaultLang', 'en');
 188     }
 189
 190     /**
 191      * Data provider for language selection test.
 192      *
 193      * @return array Test parameters.
 194      */
 195     public function selectDataProvider(): array
 196     {
 197         return [
 198             [
 199                 'cs',
 200                 'en',
 201                 '',
 202                 '',
 203                 '',
 204                 '',
 205                 '',
 206                 'Czech',
 207             ],
 208             [
 209                 '',
 210                 'cs',
 211                 '',
 212                 '',
 213                 '',
 214                 '',
 215                 '',
 216                 'Czech',
 217             ],
 218             [
 219                 '',
 220                 'cs',
 221                 'en',
 222                 '',
 223                 '',
 224                 '',
 225                 '',
 226                 'Czech',
 227             ],
 228             [
 229                 '',
 230                 '',
 231                 'cs',
 232                 '',
 233                 '',
 234                 '',
 235                 '',
 236                 'Czech',
 237             ],
 238             [
 239                 '',
 240                 '',
 241                 '',
 242                 'cs',
 243                 '',
 244                 '',
 245                 '',
 246                 'Czech',
 247             ],
 248             [
 249                 '',
 250                 '',
 251                 '',
 252                 '',
 253                 'cs,en-US;q=0.7,en;q=0.3',
 254                 '',
 255                 '',
 256                 'Czech',
 257             ],
 258             [
 259                 '',
 260                 '',
 261                 '',
 262                 '',
 263                 '',
 264                 'Mozilla/5.0 (Linux; U; Android 2.2.2; tr-tr; GM FOX)',
 265                 '',
 266                 'Turkish',
 267             ],
 268             [
 269                 '',
 270                 '',
 271                 '',
 272                 '',
 273                 '',
 274                 '',
 275                 'cs',
 276                 'Czech',
 277             ],
 278             [
 279                 '',
 280                 '',
 281                 '',
 282                 '',
 283                 '',
 284                 '',
 285                 '',
 286                 'English',
 287             ],
 288         ];
 289     }
 290
 291     /**
 292      * Test for setting and parsing locales
 293      *
 294      * @param string $locale locale name
 295      *
 296      * @group large
 297      * @dataProvider listLocales
 298      */
 299     public function testGettext(string $locale): void
 300     {
 301         $GLOBALS['config']->set('FilterLanguages', '');
 302         /* We should be able to set the language */
 303         $lang = $this->manager->getLanguage($locale);
 304         $this->assertNotFalse($lang);
 305         $lang->activate();
 306
 307         /* Grab some texts */
 308         $this->assertStringContainsString('%s', _ngettext('%s table', '%s tables', 10));
 309         $this->assertStringContainsString('%s', _ngettext('%s table', '%s tables', 1));
 310
 311         $this->assertEquals(
 312             $locale,
 313             $this->manager->getCurrentLanguage()->getCode()
 314         );
 315     }
 316
 317     /**
 318      * Data provider to generate list of available locales.
 319      *
 320      * @return array with arrays of available locales
 321      */
 322     public function listLocales(): array
 323     {
 324         $ret = [];
 325         foreach (LanguageManager::getInstance()->availableLanguages() as $language) {
 326             $ret[] = [$language->getCode()];
 327         }
 328
 329         return $ret;
 330     }
 331 }