PierInfor\GeoLite\Ip

Complexity

Total Complexity

43

Size/Duplication

Total Lines	413
Duplicated Lines	0 %

Test Coverage

Coverage

99.3%

Importance

Changes	2
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	update()	0	5	3
A	setAdapter()	0	7	2
A	__destruct()	0	7	1
A	__construct()	0	7	1
A	addIp()	0	5	1
A	process()	0	12	2
A	getIpList()	0	3	1
A	reset()	0	5	1
A	fromFile()	0	14	4
A	getHeaders()	0	15	4
A	cityAdapter()	0	17	4
A	toJson()	0	9	2
A	toArray()	0	3	1
A	compareArray()	0	3	1
A	countryAdapter()	0	10	3
A	asnAdapter()	0	15	3
A	getUpdater()	0	3	1
A	sort()	0	5	1
A	toCsv()	0	8	2
A	getReader()	0	16	4
A	setReaders()	0	15	1

<?php

namespace PierInfor\GeoLite;

use PierInfor\GeoLite\Updater;
use GeoIp2\Exception\AddressNotFoundException;
use GeoIp2\Database\Reader;

/**
 * Ip class to use free maxmind dbs in mmdb format
 */
class Ip implements Interfaces\IpInterface
{

    /**
     * locales in use
     *
     * @var Array
     */
    private $readerLocales;

    /**
     * Reader instance for cities
     *
     * @var Reader
     */
    private $readerCity;

    /**
     * Reader instance for countries
     *
     * @var Reader
     */
    private $readerCountry;

    /**
     * Reader instance for Asn
     *
     * @var Reader
     */
    private $readerAsn;

    /**
     * updater instance
     *
     * @var Updater
     */
    private $updater;

    /**
     * Results
     *
     * @var Array
     */
    private $results;

    /**
     * Ip collection
     *
     * @var Array
     */
    private $ipList;

    /**
     * Current adapter
     *
     * @var String
     */
    private $adapter;

    /**
     * Sort column
     *
     * @var Integer
     */
    private $sortCol;

    /**
     * Instanciate with given locales
     *
     * @param array $locales
     */
    public function __construct($locales = ['fr'])
    {
        $this->readerLocales = $locales;
        $this->reset();
        $this->setReaders();
        $this->setAdapter();
        $this->updater = new Updater();
    }

    /**
     * free when unset instance
     *
     * @return void
     */
    public function __destruct()
    {
        $this->adapter = null;
        $this->readerCity->close();
        $this->readerCountry->close();
        $this->readerAsn->close();
        $this->reset();
    }

    /**
     * reset ip list and result
     *
     * @return void
     */
    public function reset()
    {
        $this->ipList = [];
        $this->results = [];
        $this->sortCol = 1;
    }

    /**
     * set adapter
     *
     * @param string $adapter
     * @return Ip
     * @throws \Exception
     */
    public function setAdapter(string $adapter = self::ADAPTER_COUNTRY): Ip
    {
        if (!in_array($adapter, self::ADAPTERS)) {
            throw new \Exception('Error: Unkown adapter ' . $adapter);
        }
        $this->adapter = $adapter;
        return $this;
    }

    /**
     * update current db if required or forced
     *
     * @param boolean $force
     * @return Updater
     */
    public function update(bool $force = false): Updater
    {
        return ($this->getUpdater()->updateRequired() || $force)
            ? $this->updater->update()
            : $this->updater;
    }

    /**
     * addIp
     *
     * @param string $ip
     * @return Ip
     */
    public function addIp(string $ip): Ip
    {
        $this->ipList[] = trim($ip);
        $this->ipList = array_unique($this->ipList);
        return $this;
    }

    /**
     * load ip list from a file
     *
     * @param string $filename
     * @return Ip
     * @throws \Exception
     */
    public function fromFile(string $filename): Ip
    {
        $this->reset();
        $handle = @fopen($filename, 'r');
        if (false === is_resource($handle)) {
            throw new \Exception('Error: File open issue');
        }
        if (false !== $handle) {
            while (($ip = fgets($handle, self::BUFFER)) !== false) {
                $this->addIp($ip);
            }
            fclose($handle);
        }
        return $this;
    }

    /**
     * returns ip list
     *
     * @return array
     */
    public function getIpList(): array
    {
        return $this->ipList;
    }

    /**
     * geo process ip list
     *
     * @return Ip
     */
    public function process(): Ip
    {
        $this->results = [];
        $reader = $this->getReader();
        $li = count($this->ipList);
        for ($c = 0; $c < $li; $c++) {
            $this->results[] = call_user_func_array(
                [$this, $this->adapter],
                [$reader, $this->ipList[$c]]
            );
        }
        return $this;
    }

    /**
     * return reader belongs to current adapter
     *
     * @return Reader
     */
    public function getReader(): Reader
    {
        switch ($this->adapter) {
            case self::ADAPTER_CITY:
                $reader = $this->readerCity;
                break;
            case self::ADAPTER_COUNTRY:
                $reader = $this->readerCountry;
                break;
            case self::ADAPTER_ASN:
                $reader = $this->readerAsn;
                break;
            default:
                $reader = $this->readerCity;
        }
        return $reader;
    }

    /**
     * returns Updater instance
     *
     * @return Updater
     */
    public function getUpdater(): Updater
    {
        return $this->updater->setAdapter($this->adapter);
    }

    /**
     * sort result by column number
     *
     * @param integer $col
     * @return Ip
     */
    public function sort(int $col = 1): Ip
    {
        $this->sortCol = $col;
        usort($this->results, [$this, 'compareArray']);
        return $this;
    }

    /**
     * compare two array for a given column
     *
     * @param array $a
     * @param array $b
     * @return integer
     */
    protected function compareArray(array $a, array $b): int
    {
        return strcmp($a[$this->sortCol], $b[$this->sortCol]);
    }

    /**
     * returns result as array
     *
     * @return array
     */
    public function toArray(): array
    {
        return $this->results;
    }

    /**
     * returns result as csv
     *
     * @param string $sep
     * @return void
     */
    public function toCsv(string $sep = ';'): string
    {
        $lc = count($this->results);
        $csv = '';
        for ($c = 0; $c < $lc; $c++) {
            $csv .= implode($sep, $this->results[$c]) . "\n";
        }
        return $csv;
    }

    /**
     * returns result as json
     *
     * @return string
     */
    public function toJson(): string
    {
        $lc = count($this->results);
        $json = [];
        $headers = $this->getHeaders();
        for ($c = 0; $c < $lc; $c++) {
            $json[] = array_combine($headers, $this->results[$c]);
        }
        return json_encode($json, JSON_PRETTY_PRINT);
    }

    /**
     * set readers, one per db file
     *
     * @return Ip
     */
    protected function setReaders(): Ip
    {
        $this->readerCity = new Reader(
            __DIR__ . self::DB_PATH . self::DB_CITY_FILENAME,
            $this->readerLocales
        );
        $this->readerCountry = new Reader(
            __DIR__ . self::DB_PATH . self::DB_COUNTRY_FILENAME,
            $this->readerLocales
        );
        $this->readerAsn = new Reader(
            __DIR__ . self::DB_PATH . self::DB_ASN_FILENAME,
            $this->readerLocales
        );
        return $this;
    }

    /**
     * returns headers
     *
     * @return array
     */
    protected function getHeaders(): array
    {
        $headers = [];
        switch ($this->adapter) {
            case self::ADAPTER_CITY:
                $headers = self::HEADERS_COMMON;
                break;
            case self::ADAPTER_COUNTRY:
                $headers = array_slice(self::HEADERS_COMMON, 0, 2);
                break;
            case self::ADAPTER_ASN:
                $headers = self::HEADERS_ASN;
                break;
        }
        return $headers;
    }

    /**
     * adapter to use city reader, returns record chosen fields
     *
     * @param Reader $reader
     * @param string $ip
     * @return array
     */
    protected function cityAdapter(Reader $reader, string $ip): array
    {
        $ip = trim($ip);
        try {
            $record = $reader->city($ip);
            return [
                $ip,
                $record->country->isoCode,
                $record->city->name ?: '?',
                $record->location->latitude,
                $record->location->longitude,
                $record->location->accuracyRadius,
            ];
        } catch (AddressNotFoundException $e) {
            return array_fill(0, 6, '?');
        } catch (\InvalidArgumentException $e) {
            return array_fill(0, 6, '?');
        }
    }

    /**
     * adapter to use country reader, returns record chosen fields
     *
     * @param Reader $reader
     * @param string $ip
     * @return array
     */
    protected function countryAdapter(Reader $reader, string $ip): array
    {
        $ip = trim($ip);
        try {
            $record = $reader->country($ip);
            return [$ip, $record->country->isoCode];
        } catch (AddressNotFoundException $e) {
            return array_fill(0, 2, '?');
        } catch (\InvalidArgumentException $e) {
            return array_fill(0, 2, '?');
        }
    }

    /**
     * adapter to use asn reader, returns record chosen fields
     *
     * @param Reader $reader
     * @param string $ip
     * @return array
     */
    protected function asnAdapter(Reader $reader, string $ip): array
    {
        $ip = trim($ip);
        $badRes = array_fill(0, 3, '?');
        try {
            $record = $reader->asn($ip);
            return [
                $ip,
                $record->autonomousSystemNumber,
                $record->autonomousSystemOrganization
            ];
        } catch (AddressNotFoundException $e) {
            return $badRes;
        } catch (\InvalidArgumentException $e) {
            return $badRes;
        }
    }
}