test/classes/UserPreferencesTest.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * tests for methods under PhpMyAdmin\UserPreferences class
   5  *
   6  * @package PhpMyAdmin-test
   7  */
   8 declare(strict_types=1);
   9
  10 namespace PhpMyAdmin\Tests;
  11
  12 use PhpMyAdmin\Config\ConfigFile;
  13 use PhpMyAdmin\DatabaseInterface;
  14 use PhpMyAdmin\Tests\PmaTestCase;
  15 use PhpMyAdmin\UserPreferences;
  16
  17 /**
  18  * tests for methods under PhpMyAdmin\UserPreferences class
  19  *
  20  * @package PhpMyAdmin-test
  21  */
  22 class UserPreferencesTest extends PmaTestCase
  23 {
  24     /**
  25      * @var UserPreferences
  26      */
  27     private $userPreferences;
  28
  29     /**
  30      * Setup various pre conditions
  31      *
  32      * @return void
  33      */
  34     protected function setUp(): void
  35     {
  36         global $cfg;
  37         include ROOT_PATH . 'libraries/config.default.php';
  38         $GLOBALS['server'] = 0;
  39         $GLOBALS['PMA_PHP_SELF'] = '/phpmyadmin/';
  40
  41         $this->userPreferences = new UserPreferences();
  42     }
  43
  44     /**
  45      * Test for pageInit
  46      *
  47      * @return void
  48      */
  49     public function testPageInit()
  50     {
  51         $GLOBALS['cfg'] = [
  52             'Server/hide_db' => 'testval123',
  53             'Server/port' => '213',
  54         ];
  55         $GLOBALS['cfg']['AvailableCharsets'] = [];
  56         $GLOBALS['cfg']['UserprefsDeveloperTab'] = null;
  57
  58         $this->userPreferences->pageInit(new ConfigFile());
  59
  60         $this->assertEquals(
  61             [
  62                 'Servers' => [
  63                     1 => [
  64                         'hide_db' => 'testval123',
  65                     ],
  66                 ],
  67             ],
  68             $_SESSION['ConfigFile' . $GLOBALS['server']]
  69         );
  70     }
  71
  72     /**
  73      * Test for load
  74      *
  75      * @return void
  76      */
  77     public function testLoad()
  78     {
  79         $_SESSION['relation'][$GLOBALS['server']]['PMA_VERSION'] = PMA_VERSION;
  80
  81         $_SESSION['relation'][$GLOBALS['server']]['userconfigwork'] = null;
  82         unset($_SESSION['userconfig']);
  83
  84         $result = $this->userPreferences->load();
  85
  86         $this->assertCount(
  87             3,
  88             $result
  89         );
  90
  91         $this->assertEquals(
  92             [],
  93             $result['config_data']
  94         );
  95
  96         $this->assertEqualsWithDelta(
  97             time(),
  98             $result['mtime'],
  99             2,
 100             ''
 101         );
 102
 103         $this->assertEquals(
 104             'session',
 105             $result['type']
 106         );
 107
 108         // case 2
 109         $_SESSION['relation'][$GLOBALS['server']]['userconfigwork'] = 1;
 110         $_SESSION['relation'][$GLOBALS['server']]['db'] = "pma'db";
 111         $_SESSION['relation'][$GLOBALS['server']]['userconfig'] = "testconf";
 112         $_SESSION['relation'][$GLOBALS['server']]['user'] = "user";
 113
 114         $dbi = $this->getMockBuilder('PhpMyAdmin\DatabaseInterface')
 115             ->disableOriginalConstructor()
 116             ->getMock();
 117
 118         $query = 'SELECT `config_data`, UNIX_TIMESTAMP(`timevalue`) ts '
 119             . 'FROM `pma\'db`.`testconf` WHERE `username` = \'user\'';
 120
 121         $dbi->expects($this->once())
 122             ->method('fetchSingleRow')
 123             ->with($query, 'ASSOC', DatabaseInterface::CONNECT_CONTROL)
 124             ->will(
 125                 $this->returnValue(
 126                     [
 127                         'ts' => '123',
 128                         'config_data' => json_encode([1, 2]),
 129                     ]
 130                 )
 131             );
 132         $dbi->expects($this->any())
 133             ->method('escapeString')
 134             ->will($this->returnArgument(0));
 135
 136         $GLOBALS['dbi'] = $dbi;
 137
 138         $result = $this->userPreferences->load();
 139
 140         $this->assertEquals(
 141             [
 142                 'config_data' => [
 143                     1,
 144                     2,
 145                 ],
 146                 'mtime' => 123,
 147                 'type' => 'db',
 148             ],
 149             $result
 150         );
 151     }
 152
 153     /**
 154      * Test for save
 155      *
 156      * @return void
 157      */
 158     public function testSave()
 159     {
 160         $GLOBALS['server'] = 2;
 161         $_SESSION['relation'][2]['PMA_VERSION'] = PMA_VERSION;
 162         $_SESSION['relation'][2]['userconfigwork'] = null;
 163         unset($_SESSION['userconfig']);
 164
 165         $result = $this->userPreferences->save([1]);
 166
 167         $this->assertTrue(
 168             $result
 169         );
 170
 171         $this->assertCount(
 172             2,
 173             $_SESSION['userconfig']
 174         );
 175
 176         $this->assertEquals(
 177             [1],
 178             $_SESSION['userconfig']['db']
 179         );
 180
 181         /* TODO: This breaks sometimes as there might be time difference! */
 182         $this->assertEqualsWithDelta(
 183             time(),
 184             $_SESSION['userconfig']['ts'],
 185             2,
 186             ''
 187         );
 188
 189         $assert = true;
 190
 191         if (isset($_SESSION['cache']['server_2']['userprefs'])) {
 192             $assert = false;
 193         }
 194
 195         $this->assertTrue(
 196             $assert
 197         );
 198
 199         // case 2
 200         $_SESSION['relation'][$GLOBALS['server']]['userconfigwork'] = 1;
 201         $_SESSION['relation'][$GLOBALS['server']]['db'] = "pmadb";
 202         $_SESSION['relation'][$GLOBALS['server']]['userconfig'] = "testconf";
 203         $_SESSION['relation'][$GLOBALS['server']]['user'] = "user";
 204
 205         $query1 = 'SELECT `username` FROM `pmadb`.`testconf` '
 206             . 'WHERE `username` = \'user\'';
 207
 208         $query2 = 'UPDATE `pmadb`.`testconf` SET `timevalue` = NOW(), `config_data` = \''
 209             . json_encode([1]) . '\' WHERE `username` = \'user\'';
 210
 211         $dbi = $this->getMockBuilder('PhpMyAdmin\DatabaseInterface')
 212             ->disableOriginalConstructor()
 213             ->getMock();
 214
 215         $dbi->expects($this->once())
 216             ->method('fetchValue')
 217             ->with($query1, 0, 0, DatabaseInterface::CONNECT_CONTROL)
 218             ->will($this->returnValue(true));
 219
 220         $dbi->expects($this->once())
 221             ->method('tryQuery')
 222             ->with($query2, DatabaseInterface::CONNECT_CONTROL)
 223             ->will($this->returnValue(true));
 224
 225         $dbi->expects($this->any())
 226             ->method('escapeString')
 227             ->will($this->returnArgument(0));
 228
 229         $GLOBALS['dbi'] = $dbi;
 230         $this->assertTrue(
 231             $this->userPreferences->save([1])
 232         );
 233
 234         // case 3
 235
 236         $query1 = 'SELECT `username` FROM `pmadb`.`testconf` '
 237             . 'WHERE `username` = \'user\'';
 238
 239         $query2 = 'INSERT INTO `pmadb`.`testconf` (`username`, `timevalue`,`config_data`) '
 240             . 'VALUES (\'user\', NOW(), \'' . json_encode([1]) . '\')';
 241
 242         $dbi = $this->getMockBuilder('PhpMyAdmin\DatabaseInterface')
 243             ->disableOriginalConstructor()
 244             ->getMock();
 245
 246         $dbi->expects($this->once())
 247             ->method('fetchValue')
 248             ->with($query1, 0, 0, DatabaseInterface::CONNECT_CONTROL)
 249             ->will($this->returnValue(false));
 250
 251         $dbi->expects($this->once())
 252             ->method('tryQuery')
 253             ->with($query2, DatabaseInterface::CONNECT_CONTROL)
 254             ->will($this->returnValue(false));
 255
 256         $dbi->expects($this->once())
 257             ->method('getError')
 258             ->with(DatabaseInterface::CONNECT_CONTROL)
 259             ->will($this->returnValue("err1"));
 260         $dbi->expects($this->any())
 261             ->method('escapeString')
 262             ->will($this->returnArgument(0));
 263
 264         $GLOBALS['dbi'] = $dbi;
 265
 266         $result = $this->userPreferences->save([1]);
 267
 268         $this->assertIsObject($result);
 269         $this->assertEquals(
 270             'Could not save configuration<br><br>err1',
 271             $result->getMessage()
 272         );
 273     }
 274
 275     /**
 276      * Test for apply
 277      *
 278      * @return void
 279      */
 280     public function testApply()
 281     {
 282         $GLOBALS['cfg']['UserprefsDisallow'] = [
 283             'test' => 'val',
 284             'foo' => 'bar',
 285         ];
 286         $GLOBALS['cfg']['UserprefsDeveloperTab'] = null;
 287         $result = $this->userPreferences->apply(
 288             [
 289                 'DBG/sql' => true,
 290                 'ErrorHandler/display' => true,
 291                 'ErrorHandler/gather' => false,
 292                 'Servers/foobar' => '123',
 293                 'Server/hide_db' => true,
 294             ]
 295         );
 296
 297         $this->assertEquals(
 298             [
 299                 'Server' => [
 300                     'hide_db' => 1,
 301                 ],
 302             ],
 303             $result
 304         );
 305     }
 306
 307     /**
 308      * Test for apply
 309      *
 310      * @return void
 311      */
 312     public function testApplyDevel()
 313     {
 314         $GLOBALS['cfg']['UserprefsDeveloperTab'] = true;
 315         $result = $this->userPreferences->apply(
 316             [
 317                 'DBG/sql' => true,
 318             ]
 319         );
 320
 321         $this->assertEquals(
 322             [
 323                 'DBG' => ['sql' => true],
 324             ],
 325             $result
 326         );
 327     }
 328
 329     /**
 330      * Test for persistOption
 331      *
 332      * @return void
 333      */
 334     public function testPersistOption()
 335     {
 336         $_SESSION['relation'][$GLOBALS['server']]['PMA_VERSION'] = PMA_VERSION;
 337         $_SESSION['relation'][$GLOBALS['server']]['userconfigwork'] = null;
 338         $_SESSION['userconfig'] = [];
 339         $_SESSION['userconfig']['ts'] = "123";
 340         $_SESSION['userconfig']['db'] = [
 341             'Server/hide_db' => true,
 342             'Server/only_db' => true,
 343         ];
 344
 345         $GLOBALS['server'] = 2;
 346         $_SESSION['relation'][2]['userconfigwork'] = null;
 347
 348         $this->assertTrue(
 349             $this->userPreferences->persistOption('Server/hide_db', 'val', 'val')
 350         );
 351
 352         $this->assertTrue(
 353             $this->userPreferences->persistOption('Server/hide_db', 'val2', 'val')
 354         );
 355
 356         $this->assertTrue(
 357             $this->userPreferences->persistOption('Server/hide_db2', 'val', 'val')
 358         );
 359     }
 360
 361     /**
 362      * Test for redirect
 363      *
 364      * @return void
 365      */
 366     public function testRedirect()
 367     {
 368         $GLOBALS['lang'] = '';
 369         $GLOBALS['db'] = 'db';
 370         $GLOBALS['table'] = 'table';
 371
 372         $this->mockResponse('Location: /phpmyadmin/file.html?a=b&saved=1&server=0#h+ash');
 373
 374         $GLOBALS['PMA_Config']->set('PmaAbsoluteUri', '');
 375         $GLOBALS['PMA_Config']->set('PMA_IS_IIS', false);
 376
 377         $this->userPreferences->redirect(
 378             'file.html',
 379             ['a' => 'b'],
 380             'h ash'
 381         );
 382     }
 383
 384     /**
 385      * Test for autoloadGetHeader
 386      *
 387      * @return void
 388      */
 389     public function testAutoloadGetHeader()
 390     {
 391         $_SESSION['userprefs_autoload'] = false;
 392         $_REQUEST['prefs_autoload'] = 'hide';
 393
 394         $this->assertEquals(
 395             '',
 396             $this->userPreferences->autoloadGetHeader()
 397         );
 398
 399         $this->assertTrue(
 400             $_SESSION['userprefs_autoload']
 401         );
 402
 403         $_REQUEST['prefs_autoload'] = 'nohide';
 404         $GLOBALS['cfg']['ServerDefault'] = 1;
 405         $GLOBALS['PMA_PHP_SELF'] = 'phpunit';
 406         $result = $this->userPreferences->autoloadGetHeader();
 407
 408         $this->assertStringContainsString(
 409             '<form action="prefs_manage.php" method="post" class="disableAjax">',
 410             $result
 411         );
 412
 413         $this->assertStringContainsString(
 414             '<input type="hidden" name="token" value="token"',
 415             $result
 416         );
 417
 418         $this->assertStringContainsString(
 419             '<input type="hidden" name="json" value="">',
 420             $result
 421         );
 422
 423         $this->assertStringContainsString(
 424             '<input type="hidden" name="submit_import" value="1">',
 425             $result
 426         );
 427
 428         $this->assertStringContainsString(
 429             '<input type="hidden" name="return_url" value="phpunit?">',
 430             $result
 431         );
 432     }
 433 }