TrackingTest.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Tests;

use DateTimeImmutable;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\ConfigStorage\RelationParameters;
use PhpMyAdmin\SqlQueryForm;
use PhpMyAdmin\Template;
use PhpMyAdmin\Tracking;
use PhpMyAdmin\Url;

use function __;
use function _pgettext;
use function htmlspecialchars;
use function sprintf;

/**
 * @covers \PhpMyAdmin\Tracking
 */
class TrackingTest extends AbstractTestCase
{
    /** @var Tracking $tracking */
    private $tracking;

    /**
     * Setup function for test cases
     */
    protected function setUp(): void
    {
        parent::setUp();
        parent::setTheme();
        $GLOBALS['dbi'] = $this->createDatabaseInterface();

        $GLOBALS['server'] = 1;
        $GLOBALS['db'] = 'PMA_db';
        $GLOBALS['table'] = 'PMA_table';
        $GLOBALS['lang'] = 'en';
        $GLOBALS['text_dir'] = 'ltr';
        $GLOBALS['PMA_PHP_SELF'] = 'index.php';
        $GLOBALS['cfg']['Server']['DisableIS'] = true;
        $GLOBALS['cfg']['Server']['tracking_default_statements'] = 'DELETE';

        $_SESSION['relation'] = [];
        $_SESSION['relation'][$GLOBALS['server']] = RelationParameters::fromArray([
            'db' => 'pmadb',
            'tracking' => 'tracking',
            'trackingwork' => true,
        ])->toArray();

        $template = new Template();
        $this->tracking = new Tracking(
            new SqlQueryForm($template, $GLOBALS['dbi']),
            $template,
            new Relation($GLOBALS['dbi']),
            $GLOBALS['dbi']
        );
    }

    /**
     * Tests for filter() method.
     */
    public function testFilter(): void
    {
        $data = [
            [
                'date' => '2012-01-01 12:34:56',
                'username' => 'username1',
                'statement' => 'statement1',
            ],
            [
                'date' => '2013-01-01 12:34:56',
                'username' => 'username2',
                'statement' => 'statement2',
            ],
        ];
        $filter_users = ['username1'];

        $ret = $this->tracking->filter(
            $data,
            $filter_users,
            new DateTimeImmutable('2010-01-01 12:34:56'),
            new DateTimeImmutable('2020-01-01 12:34:56')
        );

        $this->assertEquals('username1', $ret[0]['username']);
        $this->assertEquals('statement1', $ret[0]['statement']);
    }

    /**
     * Tests for extractTableNames() method from nested table_list.
     */
    public function testExtractTableNames(): void
    {
        $GLOBALS['cfg']['NavigationTreeTableSeparator'] = '_';

        $table_list = [
            'hello_' => [
                'is_group' => 1,
                'lovely_' => [
                    'is_group' => 1,
                    'hello_lovely_world' => ['Name' => 'hello_lovely_world'],
                    'hello_lovely_world2' => ['Name' => 'hello_lovely_world2'],
                ],
                'hello_world' => ['Name' => 'hello_world'],
            ],
        ];
        $untracked_tables = $this->tracking->extractTableNames($table_list, 'db', true);
        $this->assertContains('hello_world', $untracked_tables);
        $this->assertContains('hello_lovely_world', $untracked_tables);
        $this->assertContains('hello_lovely_world2', $untracked_tables);
    }

    public function testGetHtmlForMain(): void
    {
        $html = $this->tracking->getHtmlForMainPage('PMA_db', 'PMA_table', [], 'ltr');

        $this->assertStringContainsString('PMA_db.PMA_table', $html);
        $this->assertStringContainsString('<td>date_created</td>', $html);
        $this->assertStringContainsString(__('Delete version'), $html);
        $this->assertStringContainsString('<div class="card mt-3">', $html);
        $this->assertStringContainsString('<div class="card-header">', $html);
        $this->assertStringContainsString('<div class="card-body">', $html);
        $this->assertStringContainsString('<div class="card-footer">', $html);
        $this->assertStringContainsString(Url::getHiddenInputs($GLOBALS['db']), $html);
        $this->assertStringContainsString(
            sprintf(
                __('Create version %1$s of %2$s'),
                2,
                htmlspecialchars($GLOBALS['db'] . '.' . $GLOBALS['table'])
            ),
            $html
        );
        $this->assertStringContainsString(
            '<input type="checkbox" name="delete" value="true"'
                . ' checked="checked">' . "\n" . '            DELETE<br>',
            $html
        );
        $this->assertStringContainsString(__('Create version'), $html);
        $this->assertStringContainsString('Deactivate now', $html);
    }

    /**
     * Tests for getTableLastVersionNumber() method.
     */
    public function testGetTableLastVersionNumber(): void
    {
        $sql_result = $this->tracking->getSqlResultForSelectableTables('PMA_db');
        $this->assertNotFalse($sql_result);

        $last_version = $this->tracking->getTableLastVersionNumber($sql_result);
        $this->assertSame(10, $last_version);
    }

    /**
     * Tests for getSqlResultForSelectableTables() method.
     */
    public function testGetSQLResultForSelectableTables(): void
    {
        $ret = $this->tracking->getSqlResultForSelectableTables('PMA_db');

        $this->assertNotFalse($ret);
    }

    /**
     * Tests for getHtmlForColumns() method.
     */
    public function testGetHtmlForColumns(): void
    {
        $columns = [
            [
                'Field' => 'Field1',
                'Type' => 'Type1',
                'Collation' => 'Collation1',
                'Null' => 'YES',
                'Extra' => 'Extra1',
                'Key' => 'PRI',
                'Comment' => 'Comment1',
            ],
            [
                'Field' => 'Field2',
                'Type' => 'Type2',
                'Collation' => 'Collation2',
                'Null' => 'No',
                'Extra' => 'Extra2',
                'Key' => 'Key2',
                'Comment' => 'Comment2',
            ],
        ];

        $html = $this->tracking->getHtmlForColumns($columns);

        $this->assertStringContainsString(
            __('Column'),
            $html
        );
        $this->assertStringContainsString(
            __('Type'),
            $html
        );
        $this->assertStringContainsString(
            __('Collation'),
            $html
        );
        $this->assertStringContainsString(
            __('Default'),
            $html
        );
        $this->assertStringContainsString(
            __('Comment'),
            $html
        );

        //column1
        $item1 = $columns[0];
        $this->assertStringContainsString(
            htmlspecialchars($item1['Field']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($item1['Type']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($item1['Collation']),
            $html
        );
        $this->assertStringContainsString('<em>NULL</em>', $html);
        $this->assertStringContainsString(
            htmlspecialchars($item1['Comment']),
            $html
        );

        //column2
        $item1 = $columns[1];
        $this->assertStringContainsString(
            htmlspecialchars($item1['Field']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($item1['Type']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($item1['Collation']),
            $html
        );
        $this->assertStringContainsString(
            _pgettext('None for default', 'None'),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($item1['Comment']),
            $html
        );
    }

    /**
     * Tests for getListOfVersionsOfTable() method.
     */
    public function testGetListOfVersionsOfTable(): void
    {
        $ret = $this->tracking->getListOfVersionsOfTable('PMA_db', 'PMA_table');

        $this->assertNotFalse($ret);
    }

    /**
     * Tests for getHtmlForTrackingReport() method.
     */
    public function testGetHtmlForTrackingReportr(): void
    {
        $data = [
            'tracking' => 'tracking',
            'ddlog' => [['date' => '2022-11-02 22:15:24']],
            'dmlog' => [['date' => '2022-11-02 22:15:24']],
        ];
        $url_params = [];
        $filter_users = [];

        $html = $this->tracking->getHtmlForTrackingReport(
            $data,
            $url_params,
            'schema_and_data',
            $filter_users,
            '10',
            new DateTimeImmutable('2022-11-03 22:15:24'),
            new DateTimeImmutable('2022-11-04 22:15:24'),
            'users'
        );

        $this->assertStringContainsString(
            __('Tracking report'),
            $html
        );

        $this->assertStringContainsString(
            __('Tracking statements'),
            $html
        );

        $this->assertStringContainsString($data['tracking'], $html);

        $version = Url::getHiddenInputs($url_params + [
            'report' => 'true',
            'version' => '10',
        ]);

        $this->assertStringContainsString($version, $html);

        $this->assertStringContainsString($version, $html);

        $this->assertStringContainsString(
            __('Structure only'),
            $html
        );

        $this->assertStringContainsString(
            __('Data only'),
            $html
        );

        $this->assertStringContainsString(
            __('Structure and data'),
            $html
        );

        $this->assertStringContainsString('2022-11-03 22:15:24', $html);
        $this->assertStringContainsString('2022-11-04 22:15:24', $html);
        $this->assertStringContainsString('users', $html);
    }

    /**
     * Tests for getHtmlForDataManipulationStatements() method.
     */
    public function testGetHtmlForDataManipulationStatements(): void
    {
        $data = [
            'tracking' => 'tracking',
            'dmlog' => [
                [
                    'statement' => 'statement',
                    'date' => '2013-01-01 12:34:56',
                    'username' => 'username',
                ],
            ],
            'ddlog' => ['ddlog'],
        ];
        $url_params = [];
        $ddlog_count = 10;
        $drop_image_or_text = 'text';
        $filter_users = ['*'];

        $html = $this->tracking->getHtmlForDataManipulationStatements(
            $data,
            $filter_users,
            $url_params,
            $ddlog_count,
            $drop_image_or_text,
            '10',
            new DateTimeImmutable('2010-01-01 12:34:56'),
            new DateTimeImmutable('2020-01-01 12:34:56')
        );

        $this->assertStringContainsString(
            __('Date'),
            $html
        );

        $this->assertStringContainsString(
            __('Username'),
            $html
        );

        $this->assertStringContainsString(
            __('Data manipulation statement'),
            $html
        );

        $this->assertStringContainsString($data['dmlog'][0]['date'], $html);

        $this->assertStringContainsString($data['dmlog'][0]['username'], $html);
    }

    /**
     * Tests for getHtmlForDataDefinitionStatements() method.
     */
    public function testGetHtmlForDataDefinitionStatements(): void
    {
        $data = [
            'tracking' => 'tracking',
            'ddlog' => [
                [
                    'statement' => 'statement',
                    'date' => '2013-01-01 12:34:56',
                    'username' => 'username',
                ],
            ],
            'dmlog' => ['dmlog'],
        ];
        $filter_users = ['*'];
        $url_params = [];
        $drop_image_or_text = 'text';

        [$html, $count] = $this->tracking->getHtmlForDataDefinitionStatements(
            $data,
            $filter_users,
            $url_params,
            $drop_image_or_text,
            '10',
            new DateTimeImmutable('2010-01-01 12:34:56'),
            new DateTimeImmutable('2020-01-01 12:34:56')
        );

        $this->assertStringContainsString(
            __('Date'),
            $html
        );

        $this->assertStringContainsString(
            __('Username'),
            $html
        );

        $this->assertStringContainsString(
            __('Data definition statement'),
            $html
        );

        $this->assertStringContainsString(
            __('Action'),
            $html
        );

        //PMA_getHtmlForDataDefinitionStatement
        $this->assertStringContainsString(
            htmlspecialchars($data['ddlog'][0]['username']),
            $html
        );

        $this->assertEquals(2, $count);
    }

    /**
     * Tests for getHtmlForIndexes() method.
     */
    public function testGetHtmlForIndexes(): void
    {
        $indexs = [
            [
                'Non_unique' => 0,
                'Packed' => '',
                'Key_name' => 'Key_name1',
                'Index_type' => 'BTREE',
                'Column_name' => 'Column_name',
                'Cardinality' => 'Cardinality',
                'Collation' => 'Collation',
                'Null' => 'Null',
                'Comment' => 'Comment',
            ],
        ];

        $html = $this->tracking->getHtmlForIndexes($indexs);

        $this->assertStringContainsString(
            __('Indexes'),
            $html
        );
        $this->assertStringContainsString(
            __('Keyname'),
            $html
        );
        $this->assertStringContainsString(
            __('Type'),
            $html
        );
        $this->assertStringContainsString(
            __('Unique'),
            $html
        );
        $this->assertStringContainsString(
            __('Packed'),
            $html
        );
        $this->assertStringContainsString(
            __('Column'),
            $html
        );
        $this->assertStringContainsString(
            __('Cardinality'),
            $html
        );
        // items
        $this->assertStringContainsString(
            htmlspecialchars($indexs[0]['Key_name']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($indexs[0]['Index_type']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($indexs[0]['Column_name']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($indexs[0]['Cardinality']),
            $html
        );
        $this->assertStringContainsString(
            htmlspecialchars($indexs[0]['Collation']),
            $html
        );
    }

    /**
     * Tests for getTrackingSet() method.
     */
    public function testGetTrackingSet(): void
    {
        $_POST['alter_table'] = false;
        $_POST['rename_table'] = true;
        $_POST['create_table'] = true;
        $_POST['drop_table'] = true;
        $_POST['create_index'] = false;
        $_POST['drop_index'] = true;
        $_POST['insert'] = true;
        $_POST['update'] = false;
        $_POST['delete'] = true;
        $_POST['truncate'] = true;

        $tracking_set = $this->tracking->getTrackingSet();
        $this->assertEquals('RENAME TABLE,CREATE TABLE,DROP TABLE,DROP INDEX,INSERT,DELETE,TRUNCATE', $tracking_set);

        //other set to true
        $_POST['alter_table'] = true;
        $_POST['rename_table'] = false;
        $_POST['create_table'] = false;
        $_POST['drop_table'] = false;
        $_POST['create_index'] = true;
        $_POST['drop_index'] = false;
        $_POST['insert'] = false;
        $_POST['update'] = true;
        $_POST['delete'] = false;
        $_POST['truncate'] = false;

        $tracking_set = $this->tracking->getTrackingSet();
        $this->assertEquals('ALTER TABLE,CREATE INDEX,UPDATE', $tracking_set);
    }

    /**
     * Tests for getEntries() method.
     */
    public function testGetEntries(): void
    {
        $data = [
            'tracking' => 'tracking',
            'ddlog' => [
                [
                    'statement' => 'statement1',
                    'date' => '2012-01-01 12:34:56',
                    'username' => 'username3',
                ],
            ],
            'dmlog' => [
                [
                    'statement' => 'statement1',
                    'date' => '2013-01-01 12:34:56',
                    'username' => 'username3',
                ],
            ],
        ];
        $filter_users = ['*'];

        $entries = $this->tracking->getEntries(
            $data,
            $filter_users,
            'schema',
            new DateTimeImmutable('2010-01-01 12:34:56'),
            new DateTimeImmutable('2020-01-01 12:34:56')
        );
        $this->assertEquals('username3', $entries[0]['username']);
        $this->assertEquals('statement1', $entries[0]['statement']);
    }
}