slistrom / bth-ram-module

src/Model/IPValidator.php

<?php

namespace Lii\Model;

use Anax\Commons\ContainerInjectableInterface;
use Anax\Commons\ContainerInjectableTrait;

/**
 * Validate an IP-address in different ways.
 *
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 * @SuppressWarnings(PHPMD.UnusedPrivateField)
 * @SuppressWarnings(PHPMD.StaticAccess)
*/
class IPValidator
{
    // Global variables
    public $accessKey = '';

    public function __construct($apiKey)
    {
        $this->accessKey = $apiKey;
    }

//     /**
//      * Load API access key from private file.
//      */
//     private function fetchApiKey()
//     {
//         if (file_exists(ANAX_INSTALL_PATH."/PRIVATE_TOKEN")) {
//             $myfile = fopen(ANAX_INSTALL_PATH."/PRIVATE_TOKEN", "r");
//             $this->accessKey = fread($myfile, filesize(ANAX_INSTALL_PATH."/PRIVATE_TOKEN"));
//             fclose($myfile);
//         } else {
//             $this->accessKey = getenv('API_KEY');
//         }
//     }


    /**
     * Validate an IPv4 IP-address.
     *
     * @param string $inputIP   The IP-address to validate.
     *
     * @return boolean based on if IP-address is valid or not.
     */
    public function validateIPv4($inputIP)
    {
        $valid = false;

        if (filter_var($inputIP, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
            $valid = true;
        }

        return $valid;
    }

    /**
     * Validate an IPv6 IP-address.
     *
     * @param string $inputIP   The IP-address to validate.
     *
     * @return boolean based on if IP-address is valid or not.
     */

    public function validateIPv6($inputIP)
    {
        $valid = false;

        if (filter_var($inputIP, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
            $valid = true;
        }

        return $valid;
    }

    /**
     * Validate an IP-address and return location.
     *
     * @param string $inputIP   The IP-address to validate.
     *
     * @return string with information about the IP-address.
     */

    public function locateIP($inputIP)
    {
        $result = "Not valid IP-address.";

        if ($this->validateIPv4($inputIP) || $this->validateIPv6($inputIP)) {
//             $this->fetchApiKey();

            // Initialize CURL:
            $cRes = curl_init('http://api.ipstack.com/'.$inputIP.'?access_key='.$this->accessKey.'');
            curl_setopt($cRes, CURLOPT_RETURNTRANSFER, true);

It seems like $cRes can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

            // Store the data:
            $json = curl_exec($cRes);

It seems like $cRes can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

            curl_close($cRes);

It seems like $cRes can also be of type false; however, parameter $ch of curl_close() does only seem to accept resource, maybe add an additional type check?

            // Decode JSON response:
            $result = json_decode($json, true);
        }

        return $result;
    }

    /**
     * Check if an IP-address has a registered domain name in DNS.
     *
     * @param string $inputIP   The IP-address to check for a domain name.
     *
     * @return boolean based on if IP-address has an domain name or not.
     */
    public function checkDomain($inputIP)
    {
        $result = false;
        $domain = null;

        $validIP = $this->validateIPv4($inputIP);
        if ($validIP) {
            $domain = gethostbyaddr($inputIP);
        }
        if ($domain != $inputIP) {
            $result = $domain;
        }

        return $result;

The expression return $result also could return the type string which is incompatible with the documented return type boolean.

    }

    /**
     * Validate an IP-address and return a JSON object with information about the address
     *
     * @return json object

The type Lii\Model\json was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function validateIPJSON($inputIP)
    {
        $validationResultIPv4 = $this->validateIPv4($inputIP);
        $validationResultIPv6 = $this->validateIPv6($inputIP);
        $domain = $this->checkDomain($inputIP);

        if ($validationResultIPv4) {
            $ipv4msg = "Valid IPv4 address.";
        } else {
            $ipv4msg = "Not valid IPv4 address.";
        }

        if ($validationResultIPv6) {
            $ipv6msg = "Valid IPv6 address.";
        } else {
            $ipv6msg = "Not valid IPv6 address.";
        }

        if (!$domain) {
            $domain = "No domain name found.";
        }

        $json = [
            "ip" => "{$inputIP}",
            "ipv4" => "{$ipv4msg}",
            "ipv6" => "{$ipv6msg}",
            "domain" => "{$domain}",
        ];
        return [$json];

The expression return array($json) returns the type array<integer,array<string,string>> which is incompatible with the documented return type Lii\Model\json.

    }

    /**
     * Validate an IP-address and return a JSON object with information about the address
     *
     * @return json object
     */
    public function locateIPJSON($inputIP)
    {
        $result = [
            "error" => "Not valid IP-address.",
        ];

        if ($this->validateIPv4($inputIP) || $this->validateIPv6($inputIP)) {
//             $this->fetchApiKey();
            $domain = $this->checkDomain($inputIP);
            $location = $this->locateIP($inputIP);
//             var_dump($location);
            $maplink = "https://www.google.com/maps/search/?api=1&query=".$location['latitude'].",".$location['longitude'];

            if ($this->validateIPv4($inputIP)) {
                $ipv4msg = "Valid IPv4 address.";
            } else {
                $ipv4msg = "Not valid IPv4 address.";
            }

            if ($this->validateIPv6($inputIP)) {
                $ipv6msg = "Valid IPv6 address.";
            } else {
                $ipv6msg = "Not valid IPv6 address.";
            }

            if (!$domain) {
                $domain = "No domain name found.";
            }

            $result = [
                "ip" => "{$inputIP}",
                "ipv4" => "{$ipv4msg}",
                "ipv6" => "{$ipv6msg}",
                "domain" => "{$domain}",
                "country" => "{$location['country_name']}",
                "city" => "{$location['city']}",
                "latitude" => "{$location['latitude']}",
                "longitude" => "{$location['longitude']}",
                "maplink" => "{$maplink}",
            ];
        }

        return [$result];

The expression return array($result) returns the type array<integer,array<string,string>> which is incompatible with the documented return type Lii\Model\json.

    }
}