Crossjoin\Browscap\Parser\Sqlite\Reader

Complexity

Total Complexity

58

Size/Duplication

Total Lines	500
Duplicated Lines	2 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	1
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getAdapter()	10	10	2
A	getDatabasePath()	0	19	4
A	getDatabaseFileName()	0	16	3
A	isFileReadable()	0	4	1
A	setAdapter()	0	4	1
A	isUpdateRequired()	0	17	4
A	getReleaseTime()	0	11	2
A	getVersion()	0	11	2
A	getType()	0	11	2
C	getBrowser()	0	94	9
A	getSqliteVersion()	0	19	4
A	getBrowserId()	0	8	2
A	getBrowserParentId()	0	8	2
A	findBrowser()	0	18	3
D	findBrowserInKeywordTables()	0	41	10
A	findBrowserInDefaultTable()	0	14	2
A	getPatternKeywords()	0	12	3
A	sortProperties()	0	6	1

<?php
declare(strict_types=1);

namespace Crossjoin\Browscap\Parser\Sqlite;

use Crossjoin\Browscap\Exception\ParserConditionNotSatisfiedException;
use Crossjoin\Browscap\Exception\ParserRuntimeException;
use Crossjoin\Browscap\Exception\UnexpectedValueException;
use Crossjoin\Browscap\Parser\ReaderInterface;
use Crossjoin\Browscap\Parser\Sqlite\Adapter\AdapterFactory;
use Crossjoin\Browscap\Parser\Sqlite\Adapter\AdapterInterface;
use Crossjoin\Browscap\PropertyFilter\PropertyFilterTrait;
use Crossjoin\Browscap\Source\Ini\GetRegExpForPatternTrait;
use Crossjoin\Browscap\Type;

/**
 * Class Reader
 *
 * @package Crossjoin\Browscap\Parser\Sqlite
 * @author Christoph Ziegenberg <ziegenberg@crossjoin.com>
 * @link https://github.com/crossjoin/browscap
 */
class Reader implements ReaderInterface
{
    use DataDirectoryTrait;
    use DataVersionHashTrait;
    use PropertyFilterTrait;
    use GetRegExpForPatternTrait;
    
    /**
     * @var AdapterInterface
     */
    protected $adapter;

    /**
     * @var string
     */
    protected $databaseFile;

    /**
     * @var int
     */
    protected $browserId;

    /**
     * @var int
     */
    protected $browserParentId;

    /**
     * @var array
     */
    protected $browserPatternKeywords;

    /**
     * @var string
     */
    protected $sqliteVersion;
    
    /**
     * Writer constructor.
     *
     * @param string $dataDirectory
     *
     * @throws ParserConditionNotSatisfiedException
     */
    public function __construct(string $dataDirectory)
    {
        $this->setDataDirectory($dataDirectory);
    }

    /**
     * @inheritdoc
     *
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    protected function getAdapter() : AdapterInterface
    {
        if ($this->adapter === null) {
            $databaseFile = $this->getDatabasePath();
            $adapter = AdapterFactory::getInstance($databaseFile);
            $this->setAdapter($adapter);
        }

        return $this->adapter;
    }

    /**
     * @return string
     *
     * @throws ParserRuntimeException
     */
    protected function getDatabasePath() : string
    {
        $databasePath = $this->getDataDirectory() . DIRECTORY_SEPARATOR . $this->getDatabaseFileName();

        if (!$this->isFileReadable($databasePath)) {
            if (!file_exists($databasePath)) {
                throw new ParserRuntimeException(
                    "Linked database file '$databasePath' not found. Parser data need to be generated.",

As per coding-style, please use concatenation or sprintf for the variable $databasePath instead of interpolation.

                    1458898365
                );
            } else {
                throw new ParserRuntimeException("Linked database file '$databasePath' is not readable.", 1458898366);

As per coding-style, please use concatenation or sprintf for the variable $databasePath instead of interpolation.

            }
        } elseif (!is_file($databasePath)) {
            throw new ParserRuntimeException("Invalid database file name '$databasePath' in link file.", 1458898367);

As per coding-style, please use concatenation or sprintf for the variable $databasePath instead of interpolation.

        }

        return $databasePath;
    }

    /**
     * @return string
     *
     * @throws ParserRuntimeException
     */
    protected function getDatabaseFileName() : string
    {
        // Get database to use, saved in the link file (as symlinks are not available or only
        // with admin permissions on Windows).
        $linkFile = $this->getDataDirectory() . DIRECTORY_SEPARATOR . Parser::LINK_FILENAME;
        if ($this->isFileReadable($linkFile)) {
            return (string)file_get_contents($linkFile);
        } elseif (!file_exists($linkFile)) {
            throw new ParserRuntimeException(
                "Database link file '$linkFile' not found. Parser data need to be generated.",

As per coding-style, please use concatenation or sprintf for the variable $linkFile instead of interpolation.

                1458898368
            );
        } else {
            throw new ParserRuntimeException("Database link file '$linkFile' is not readable.", 1458898369);

As per coding-style, please use concatenation or sprintf for the variable $linkFile instead of interpolation.

        }
    }

    /**
     * @param $file
     *
     * @return bool
     */
    protected function isFileReadable(string $file) : bool
    {
        return is_readable($file);
    }

    /**
     * @param AdapterInterface $adapter
     */
    protected function setAdapter(AdapterInterface $adapter)
    {
        $this->adapter = $adapter;
    }

    /**
     * @inheritdoc
     *
     * @throws UnexpectedValueException
     */
    public function isUpdateRequired() : bool
    {
        try {
            $query = 'SELECT data_hash FROM info LIMIT 1';
            $dataHash = '';
            foreach ($this->getAdapter()->query($query) as $row) {
                $dataHash = $row['data_hash'];
            }
            $return = ($dataHash !== $this->getDataVersionHash());
        } catch (ParserConditionNotSatisfiedException $e) {
            $return = true;
        } catch (ParserRuntimeException $e) {
            $return = true;
        }

        return $return;
    }

    /**
     * @inheritdoc
     *
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    public function getReleaseTime() : int
    {
        $query = 'SELECT release_time FROM info LIMIT 1';

        $releaseTime = 0;
        foreach ($this->getAdapter()->query($query) as $row) {
            $releaseTime = (int)$row['release_time'];
        }

        return $releaseTime;
    }

    /**
     * @inheritdoc
     *
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    public function getVersion() : int
    {
        $query = 'SELECT version_id FROM info LIMIT 1';

        $versionId = 0;
        foreach ($this->getAdapter()->query($query) as $row) {
            $versionId = (int)$row['version_id'];
        }

        return $versionId;
    }

    /**
     * @inheritdoc
     *
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    public function getType() : int
    {
        $query = 'SELECT type_id FROM info LIMIT 1';

        $typeId = Type::UNKNOWN;
        foreach ($this->getAdapter()->query($query) as $row) {
            $typeId = (int)$row['type_id'];
        }

        return $typeId;
    }

    /**
     * @inheritdoc
     *
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    public function getBrowser(string $userAgent) : array
    {
        // Init variables
        $browserId = $this->getBrowserId($userAgent);
        $browserParentId = $this->getBrowserParentId($userAgent);

        // Get all settings for the found browser
        //
        // It's best to use a recursive query here, but some linux distributions like CentOS and RHEL
        // use old sqlite library versions (like 3.6.20 or 3.7.17), so that we have to check the
        // version here and fall back to multiple single queries in case of older versions.
        if (version_compare($this->getSqliteVersion(), '3.8.3', '>=')) {
            $query  = 'SELECT t3.property_key, t4.property_value FROM (';
            $query .= 'WITH RECURSIVE browser_recursive(browser_id,browser_parent_id) AS (';
            $query .= 'SELECT browser_id, browser_parent_id FROM browser WHERE browser_id = :id';
            $query .= ' UNION ALL ';
            $query .= 'SELECT browser.browser_id, browser.browser_parent_id FROM browser, browser_recursive ';
            $query .= 'WHERE browser_recursive.browser_parent_id IS NOT NULL ';
            $query .= 'AND browser.browser_id = browser_recursive.browser_parent_id';
            $query .= ') ';
            $query .= 'SELECT MAX(t2.browser_id) AS browser_id, t2.property_key_id FROM browser_recursive t1 ';
            $query .= 'JOIN browser_property t2 ON t2.browser_id = t1.browser_id ';
            $query .= 'GROUP BY t2.property_key_id';
            $query .= ') t1 ';
            $query .= 'JOIN browser_property t2 ON t2.browser_id = t1.browser_id ';
            $query .= 'AND t2.property_key_id = t1.property_key_id ';
            $query .= 'JOIN browser_property_key t3 ON t3.property_key_id = t2.property_key_id ';
            $query .= 'JOIN browser_property_value t4 ON t4.property_value_id = t2.property_value_id';
            $query .= ' UNION ALL ';
            $query .= 'SELECT \'browser_name_pattern\' AS property_key, browser_pattern AS property_value ';
            $query .= 'FROM browser WHERE browser_id = :id';
            $query .= ' UNION ALL ';
            $query .= 'SELECT \'Parent\' AS property_key, browser_pattern AS property_value ';
            $query .= 'FROM browser WHERE browser_id = :parent';
            $statement = $this->getAdapter()->prepare($query);
        } else {
            $query = 'SELECT browser_id, browser_parent_id FROM browser WHERE browser_id = :id';
            $statement = $this->getAdapter()->prepare($query);
            $browserIds = [];
            $lastBrowserId = $browserId;
            while ($lastBrowserId !== null) {
                $result = $statement->execute(['id' => $lastBrowserId]);

                $lastBrowserId = null;
                if (count($result) > 0) {
                    $browserIds[] = (int)$result[0]['browser_id'];
                    if ($result[0]['browser_parent_id'] !== null) {
                        $lastBrowserId = (int)$result[0]['browser_parent_id'];
                    }
                }
            }

            $query  = 'SELECT t3.property_key, t4.property_value FROM (';
            $query .= 'SELECT MAX(browser_id) AS browser_id, property_key_id ';
            $query .= 'FROM browser_property WHERE browser_id IN (' . implode(', ', $browserIds) . ') ';
            $query .= 'GROUP BY property_key_id';
            $query .= ') t1 ';
            $query .= 'JOIN browser_property t2 ON t2.browser_id = t1.browser_id ';
            $query .= 'AND t2.property_key_id = t1.property_key_id ';
            $query .= 'JOIN browser_property_key t3 ON t3.property_key_id = t2.property_key_id ';
            $query .= 'JOIN browser_property_value t4 ON t4.property_value_id = t2.property_value_id';
            $query .= ' UNION ALL ';
            $query .= 'SELECT \'browser_name_pattern\' AS property_key, browser_pattern AS property_value ';
            $query .= 'FROM browser WHERE browser_id = :id';
            $query .= ' UNION ALL ';
            $query .= 'SELECT \'Parent\' AS property_key, browser_pattern AS property_value ';
            $query .= 'FROM browser WHERE browser_id = :parent';
            $statement = $this->getAdapter()->prepare($query);
        }

        $properties = [];
        foreach ($statement->execute(['id' => $browserId, 'parent' => $browserParentId]) as $row) {
            $properties[$row['property_key']] = $row['property_value'];
        }

        // Set regular expression properties
        $propertyFilter = $this->getPropertyFilter();
        if (!$propertyFilter->isFiltered('browser_name_regex')) {
            $properties['browser_name_regex'] = $this->getRegExpForPattern($properties['browser_name_pattern']);
        }
        if ($propertyFilter->isFiltered('browser_name_pattern')) {
            unset($properties['browser_name_pattern']);
        }
        if ($propertyFilter->isFiltered('Parent')) {
            unset($properties['Parent']);
        }

        // IMPORTANT: Reset browserId and browserParentId for next call
        $this->browserId = null;
        $this->browserParentId = null;

        // The settings are in random order, so sort them
        return $this->sortProperties($properties);
    }

    /**
     * @return string
     * @throws \Crossjoin\Browscap\Exception\UnexpectedValueException
     * @throws \Crossjoin\Browscap\Exception\ParserConditionNotSatisfiedException
     */
    protected function getSqliteVersion(): string
    {
        if ($this->sqliteVersion === null) {

            $this->sqliteVersion = '0.0.0';

            // Try to get the version number
            $query = 'SELECT sqlite_version() AS version';
            try {
                $result = $this->getAdapter()->query($query);
                if (count($result) > 0) {
                    $this->sqliteVersion = $result[0]['version'];
                }
            } catch (ParserRuntimeException $exception) {

Consider adding a comment why this CATCH block is empty.

            }
        }

        return $this->sqliteVersion;
    }

    /**
     * @param string $userAgent
     *
     * @return int
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    protected function getBrowserId(string $userAgent) : int
    {
        if ($this->browserId === null) {
            $this->findBrowser($userAgent);
        }

        return $this->browserId;
    }

    /**
     * @param string $userAgent
     *
     * @return int
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    protected function getBrowserParentId(string $userAgent) : int
    {
        if ($this->browserParentId === null) {
            $this->findBrowser($userAgent);
        }

        return $this->browserParentId;
    }

    /**
     * @param string $userAgent
     *
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    protected function findBrowser(string $userAgent)
    {
        // Check each keyword table for the browser pattern
        $this->findBrowserInKeywordTables($userAgent);

        // If no match found in keyword tables, check the default table
        // (this also includes the '*' pattern for the default match).
        if ($this->browserId === null) {
            $this->findBrowserInDefaultTable($userAgent);
        }

        // Check if data found (the last step should always find the default settings)
        if ($this->browserId === null) {
            throw new ParserRuntimeException(
                "No result found for user agent '$userAgent'. There seems to be something wrong with the data."

As per coding-style, please use concatenation or sprintf for the variable $userAgent instead of interpolation.

            );
        }
    }

    /**
     * @param string $userAgent
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    protected function findBrowserInKeywordTables(string $userAgent)
    {
        $query  = 'SELECT browser_id, browser_pattern_length FROM "search_[keyword]" ';
        $query .= 'WHERE browser_pattern_length >= :length AND :agent GLOB browser_pattern';

        $userAgentLowered = strtolower($userAgent);
        $maxLength = 0;
        $browserId = null;
        foreach ($this->getPatternKeywords() as $patternKeyword) {
            if (strpos($userAgentLowered, $patternKeyword) !== false) {
                $statement = $this->getAdapter()->prepare(str_replace('[keyword]', $patternKeyword, $query));

                /** @noinspection PdoApiUsageInspection */
                foreach ($statement->execute(['length' => $maxLength, 'agent' => $userAgentLowered]) as $row) {
                    $tmpLength = (int)$row['browser_pattern_length'];
                    $tmpBrowserId = (int)$row['browser_id'];

                    if ($tmpLength < $maxLength) {
                        continue; // @codeCoverageIgnore
                    }
                    if ($tmpLength === $maxLength && $browserId !== null && $tmpBrowserId < $browserId) {
                        continue; // @codeCoverageIgnore
                    }

                    $browserId = (int)$row['browser_id'];
                    $maxLength = $tmpLength;
                }
            }
        }

        if ($browserId !== null) {
            $this->browserId = $browserId;

            $query = 'SELECT browser_parent_id FROM browser WHERE browser_id = :id';
            $statement = $this->getAdapter()->prepare($query);
            /** @noinspection PdoApiUsageInspection */
            foreach ($statement->execute(['id' => $browserId]) as $row) {
                $this->browserParentId = (int)$row['browser_parent_id'];
            }
        }
    }

    /**
     * @param string $userAgent
     *
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    protected function findBrowserInDefaultTable(string $userAgent)
    {
        // Build query with default table
        $query  = 'SELECT t2.browser_id, t2.browser_parent_id FROM ';
        $query .= '(SELECT MIN(browser_id) AS browser_id FROM search WHERE :agent GLOB browser_pattern) t1 ';
        $query .= 'JOIN browser t2 ON t2.browser_id = t1.browser_id';
        $statement = $this->getAdapter()->prepare($query);

        /** @noinspection PdoApiUsageInspection */
        foreach ($statement->execute(['agent' => strtolower($userAgent)]) as $row) {
            $this->browserId = (int)$row['browser_id'];
            $this->browserParentId = (int)$row['browser_parent_id'];
        }
    }

    /**
     * @return array
     * @throws ParserConditionNotSatisfiedException
     * @throws ParserRuntimeException
     * @throws UnexpectedValueException
     */
    protected function getPatternKeywords() : array
    {
        if ($this->browserPatternKeywords === null) {
            $this->browserPatternKeywords = [];
            $query = 'SELECT keyword_value FROM keyword ORDER BY keyword_id';
            foreach ($this->getAdapter()->query($query) as $row) {
                $this->browserPatternKeywords[] = $row['keyword_value'];
            }
        }

        return $this->browserPatternKeywords;
    }

    /**
     * @param array $properties
     *
     * @return array
     */
    protected function sortProperties(array $properties) : array
    {
        ksort($properties);

        return $properties;
    }
}