UserAgentParser\Provider\AbstractProvider

Complexity

Total Complexity

29

Size/Duplication

Total Lines	263
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Test Coverage

Coverage

91.53%

Importance

Changes	7
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	4	1
A	getHomepage()	0	4	1
A	getPackageName()	0	4	1
B	getVersion()	0	26	6
B	getUpdateDate()	0	28	6
A	getPackages()	0	15	4
A	getDetectionCapabilities()	0	4	1
C	isRealResult()	0	23	7
A	getRealResult()	0	8	2
	parse()	0	1	?

<?php
namespace UserAgentParser\Provider;

use DateTime;
use DateTimeZone;
use UserAgentParser\Exception;
use UserAgentParser\Model;

/**
 * Abstraction for all providers
 *
 * @author Martin Keckeis <martin.keckeis1@gmail.com>
 * @license MIT
 */
abstract class AbstractProvider
{
    /**
     * Name of the provider
     *
     * @var string
     */
    protected $name;

    /**
     * Homepage of the provider
     *
     * @var string
     */
    protected $homepage;

    /**
     * Composer package name
     *
     * @var string
     */
    protected $packageName;

    /**
     * Version string for caching
     *
     * @var string
     */
    private $version;

    /**
     * Last update date
     *
     * @var DateTime
     */
    private $updateDate;

    /**
     * Per default the provider cannot detect anything
     * Activate them in $detectionCapabilities
     *
     * @var array
     */
    protected $allDetectionCapabilities = [
        'browser' => [
            'name'    => false,
            'version' => false,
        ],

        'renderingEngine' => [
            'name'    => false,
            'version' => false,
        ],

        'operatingSystem' => [
            'name'    => false,
            'version' => false,
        ],

        'device' => [
            'model'    => false,
            'brand'    => false,
            'type'     => false,
            'isMobile' => false,
            'isTouch'  => false,
        ],

        'bot' => [
            'isBot' => false,
            'name'  => false,
            'type'  => false,
        ],
    ];

    /**
     * Set this in each Provider implementation
     *
     * @var array
     */
    protected $detectionCapabilities = [];

    protected $defaultValues = [
        'general' => [],
    ];

    /**
     * Return the name of the provider
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get the homepage
     *
     * @return string
     */
    public function getHomepage()
    {
        return $this->homepage;
    }

    /**
     * Get the package name
     *
     * @return string null
     */
    public function getPackageName()
    {
        return $this->packageName;
    }

    /**
     * Return the version of the provider
     *
     * @return string null
     */
    public function getVersion()
    {
        if ($this->version !== null) {
            return $this->version;
        }

        if ($this->getPackageName() === null) {
            return;
        }

        $packages = $this->getPackages();

        if ($packages === null) {
            return;
        }

        foreach ($packages as $package) {
            if ($package->name === $this->getPackageName()) {
                $this->version = $package->version;

                break;
            }
        }

        return $this->version;
    }

    /**
     * Get the last change date of the provider
     *
     * @return DateTime null
     */
    public function getUpdateDate()
    {
        if ($this->updateDate !== null) {
            return $this->updateDate;
        }

        if ($this->getPackageName() === null) {
            return;
        }

        $packages = $this->getPackages();

        if ($packages === null) {
            return;
        }

        foreach ($packages as $package) {
            if ($package->name === $this->getPackageName()) {
                $updateDate = new DateTime($package->time, new DateTimeZone('UTC'));

                $this->updateDate = $updateDate;

                break;
            }
        }

        return $this->updateDate;
    }

    /**
     *
     * @return array null
     */
    private function getPackages()
    {
        if (! file_exists('composer.lock')) {
            return;
        }

        $content = file_get_contents('composer.lock');
        if ($content === false || $content === '') {
            return;
        }

        $content = json_decode($content);

        return array_merge($content->packages, $content->{'packages-dev'});
    }

    /**
     * What kind of capabilities this provider can detect
     *
     * @return array
     */
    public function getDetectionCapabilities()
    {
        return array_merge($this->allDetectionCapabilities, $this->detectionCapabilities);
    }

    /**
     *
     * @param  mixed   $value
     * @param  string  $group
     * @param  string  $part
     * @return boolean
     */
    protected function isRealResult($value, $group = null, $part = null)
    {
        $value = (string) $value;
        $value = trim($value);

        if ($value === '') {
            return false;
        }

        $regexes = $this->defaultValues['general'];

        if ($group !== null && $part !== null && isset($this->defaultValues[$group][$part])) {
            $regexes = array_merge($regexes, $this->defaultValues[$group][$part]);
        }

        foreach ($regexes as $regex) {
            if (preg_match($regex, $value) === 1) {
                return false;
            }
        }

        return true;
    }

    protected function getRealResult($value, $group = null, $part = null)
    {
        if ($this->isRealResult($value, $group, $part) === true) {
            return $value;
        }

        return;
    }

    /**
     * Parse the given user agent and return a result if possible
     *
     * @param string $userAgent
     * @param array  $headers
     *
     * @throws Exception\NoResultFoundException
     *
     * @return Model\UserAgent
     */
    abstract public function parse($userAgent, array $headers = []);
}