country-block.inc.php

<?php
/**
 *
 * @author Matt Gross <contact@mattgross.net>
 * @link https://github.com/MatthewGross/PHP-Country-Block
 * @license MIT - http://mattgross.mit-license.org/
 *
 * A basic PHP IP Address blocker for certain countries provided by the user.
 * Uses IP Info DB <http://ipinfodb.com/>
 * Uses IP Info DB PHP Wrapper <http://github.com/beingtomgreen/IP-User-Location>
 *
 */

class countryBlock
{
    
    // Store Country
    private $countries = null;
    
    // Store Visitors IP Address
    private $ip_address = null;
    
    // Store ipInfo object
    private $ipInfo = null;
    
    // Returning line. Sets to true if user is blocked.
    public $isBlocked = false;
    
    /**
     * __construct
     *
     * @param array $countries - All countries provided in an array
     * @param string $apiKey - Your API key
     * @param string $path_to_script - Directory path before the Uses IP Info DB PHP Wrapper
     *
     * @return true/false - true if ip has been blocked, false if ip has not been blocked and is permitted.
     * 
     */
    public function __construct($countries, $api_key, $path_to_script = '')
    {
        // Include ipInfo.inc.php with or without path
        include($path_to_script . 'ipInfo.inc.php');
        
        // new ipInfo class with api_key from parameters
        $this->ipInfo = new ipInfo($api_key);
        
        // Save Countries to $countries
        $this->countries = $countries;
        
        // Save IP Address $ip_address
        $this->ip_address = $this->ipInfo->getIPAddress();
        
        // Check if cookie exists
        if ($this->cookieCheck()) {
            // returned true... cookie does not exist
            foreach ($this->countries as $country) {
                // return true or false
                $blockable = $this->countryCheck($country);
                
                // check
                if ($blockable) {
                    // block
                    $this->setCookie("true");
                    // Change the return line.
                    $this->isBlocked = true;
                    // Break the loop if already blocked.
                    break;
                }
            }
        } else {
            // Block again. If the cookie is set, it means the user has been blocked before due to country and should be blocked again.
            $this->isBlocked = true;
        }
    }
    
    /**
     * getCountry()
     *
     * Returns true or false based off if the country from the ip is in the $countries array
     *
     * @param string $country - country code of one country!
     *
     * @return true/false - true if same, false if not
     *
     */
    protected function countryCheck($country)
    {
        // Get Country from ipInfo API
        $userCountry = $this->ipInfo->getCountry($this->ip_address);
        
        // Using regex, take specific info out of returned string at $userCountry
        $regex = ".*?((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))(?![\\d]).*?((?:[a-z][a-z]+)).*?((?:[a-z][a-z]+))";
        
        if ($c = preg_match_all("/" . $regex . "/is", $userCountry, $matches)) {
            $ipAddress   = $matches[1][0];
            $countryCode = $matches[2][0];
            $countryName = $matches[3][0];
            
            // Compare...
            if ($country == $countryCode) {
                // Should block
                return true;
            } else {
                // Shouldn't block
                return false;
            }
        }
        return false;
        
    }
    
    /**
     * cookieCheck()
     *
     * Returns true or false depending if the cookie ('ip_not_allowed') is set or not
     *
     * @return true/false - true if not set, false if is set
     *
     */
    protected function cookieCheck()
    {
        if (!isset($_COOKIE['ip_not_allowed'])) {
            return true;
        } else {
            return false;
        }
    }
    
    /**
     * setCookie()
     *
     * Sets cookie and returns true
     *
     * @param string $value - Value to set the cookie. "true/false"
     *
     * @return true
     *
     */
    protected function setCookie($value)
    {
        setcookie('ip_not_allowed', $value);
        $_COOKIE['ip_not_allowed'] = $value;
        return true;
    }
    
}