sunnysideup / silverstripe-cloud-flare-geoip

src/Api/CloudFlareGeoIP.php

<?php

namespace Sunnysideup\CloudFlare\Api;

use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use Sunnysideup\Geoip\Geoip;

class CloudFlareGeoIP extends Geoip
{
    private static $debug_email = '';

    /**
     * Find the country for an IP address.
     *
     * Always returns a string (parent method may return array)
     *
     * To return the code only, pass in true for the
     * $codeOnly parameter.
     *
     * @param string $address  The IP address to get the country of
     * @param bool   $codeOnly Returns just the country code
     *
     * @return string
     */
    public static function ip2country($address, $codeOnly = false)
    {
        $results1 = null;
        $results2 = null;
        if (isset($_SERVER['HTTP_CF_IPCOUNTRY'])) {
            $results2 = $_SERVER['HTTP_CF_IPCOUNTRY'];
        } else {
            $results1 = parent::ip2country($address);
        }
        $returnValue = $results2 ?: $results1;
        if ($codeOnly) {
            if (is_array($returnValue)) {
                return $returnValue['code'];
            }

            return $returnValue;

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

        }
        $name = parent::countryCode2name($returnValue);

It seems like $returnValue can also be of type boolean and null; however, parameter $code of Sunnysideup\Geoip\Geoip::countryCode2name() does only seem to accept string, maybe add an additional type check?

        return [
            'code' => $returnValue,
            'name' => $name,
        ];
    }

    /**
     * Returns the country code, for the current visitor.
     *
     * @return bool|string
     */
    public static function visitor_country()
    {
        $code = null;
        if (Director::isDev()) {
            if (isset($_GET['countryfortestingonly'])) {
                $code = $_GET['countryfortestingonly'];
                Controller::curr()->getRequest()->getSession()->set('countryfortestingonly', $code);
            }
            if ($code = Controller::curr()->getRequest()->getSession()->get('countryfortestingonly')) {
                Controller::curr()->getRequest()->getSession()->set('MyCloudFlareCountry', $code);
            }
        }
        if (! $code) {
            if (isset($_SERVER['HTTP_CF_IPCOUNTRY']) && $_SERVER['HTTP_CF_IPCOUNTRY']) {
                return $_SERVER['HTTP_CF_IPCOUNTRY'];
            }
            $code = Controller::curr()->getRequest()->getSession()->get('MyCloudFlareCountry');
            if (! $code) {
                $address = self::get_remote_address();
                if (strlen($address) > 3) {
                    $code = CloudFlareGeoIP::ip2country($address, true);
                }
                if (! $code) {
                    $code = self::get_default_country_code();
                }
                if ('' === $code) {
                    $code = Config::inst()->get('CloudFlareGeoip', 'default_country_code');
                }
                Controller::curr()->getRequest()->getSession()->set('MyCloudFlareCountry', $code);
            }
        }

        return $code;
    }

    /**
     * @see: http://stackoverflow.com/questions/14985518/cloudflare-and-logging-visitor-ip-addresses-via-in-php
     *
     * @return string
     */
    public static function get_remote_address()
    {
        $ip = null;
        if (isset($_GET['ipfortestingonly']) && Director::isDev()) {
            $ip = $_GET['ipfortestingonly'];
        } elseif (isset($_SERVER['HTTP_CF_CONNECTING_IP'])) {
            $ip = $_SERVER['HTTP_CF_CONNECTING_IP'];
        }
        if (! $ip ||
            ! filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE)
        ) {
            $ip = Controller::curr()->getRequest()->getIP();
        }

        return $ip;
    }
}