PragmaRX\Firewall\Firewall::getListingByCountry()

Complexity

Conditions	6
Paths	7

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	Firewall::whitelist()	0	3	1

<?php

namespace PragmaRX\Firewall;

use Illuminate\Http\Request;
use PragmaRX\Firewall\Repositories\DataRepository;
use PragmaRX\Firewall\Repositories\Message;
use PragmaRX\Firewall\Support\AttackBlocker;
use PragmaRX\Firewall\Support\Redirectable;
use PragmaRX\Firewall\Support\Responder;
use PragmaRX\Support\CacheManager;
use PragmaRX\Support\Config;
use PragmaRX\Support\FileSystem;
use PragmaRX\Support\GeoIp\Updater as GeoIpUpdater;

class Firewall
{
    use Redirectable;

    /**
     * The IP adress.
     *
     * @var
     */
    private $ip;

    /**
     * The config object.
     *
     * @var Config
     */
    private $config;

    /**
     * The cache manager objetc.
     *
     * @var CacheManager
     */
    private $cache;

    /**
     * The file system object.
     *
     * @var FileSystem
     */
    private $fileSystem;

    /**
     * The data repository object.
     *
     * @var DataRepository
     */
    private $dataRepository;

    /**
     * The request.
     *
     * @var Request
     */
    private $request;

    /**
     * The geop ip object.
     *
     * @var GeoIp

The type PragmaRX\Firewall\GeoIp was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public $geoIp;

    /**
     * The attack blocker.
     *
     * @var AttackBlocker
     */
    private $attackBlocker;
    /**
     * @var Message
     */
    private $messageRepository;

    /**
     * Initialize Firewall object.
     *
     * @param Config $config
     * @param DataRepository $dataRepository
     * @param CacheManager $cache
     * @param FileSystem $fileSystem
     * @param Request $request
     * @param AttackBlocker $attackBlocker
     * @param Message $messageRepository
     */
    public function __construct(
        Config $config,
        DataRepository $dataRepository,
        CacheManager $cache,
        FileSystem $fileSystem,
        Request $request,
        AttackBlocker $attackBlocker,
        Message $messageRepository
    ) {
        $this->config = $config;

        $this->dataRepository = $dataRepository;

        $this->cache = $cache;

        $this->fileSystem = $fileSystem;

        $this->request = $request;

        $this->attackBlocker = $attackBlocker;

        $this->messageRepository = $messageRepository;

        $this->setIp(null);
    }

    /**
     * Get all IP addresses.
     *
     */
    public function all()
    {
        return $this->dataRepository->all();
    }

    /**
     * Get all IP addresses by country.
     *
     * @param $country
     * @return static
     */
    public function allByCountry($country)
    {
        return $this->dataRepository->allByCountry($country);

The expression return $this->dataRepository->allByCountry($country) returns the type PragmaRX\Firewall\Repositories\DataRepository which is incompatible with the documented return type PragmaRX\Firewall\Firewall.

    }

    /**
     * Blacklist an IP adress.
     *
     * @param $ip
     * @param bool $force
     *
     * @return bool
     */
    public function blacklist($ip, $force = false)
    {
        return $this->dataRepository->addToList(false, $ip, $force);
    }

    /**
     * Create a blocked access response.
     *
     * @return \Illuminate\Http\Response|void
     *
     * @internal param null $content
     * @internal param null $status
     */
    public function blockAccess()
    {
        return (new Responder())->respond(

The expression return new PragmaRX\Firewall\Support\Responder()->respond($this->config->get('response')) also could return the type Illuminate\Http\RedirectResponse which is incompatible with the documented return type Illuminate\Http\Response.

            $this->config->get('response')
        );
    }

    /**
     * Clear firewall table.
     *
     * @return mixed
     */
    public function clear()
    {
        return $this->dataRepository->clear();
    }

    /**
     * Find an IP address.
     *
     * @param string $ip
     *
     * @return object|array|null
     */
    public function find($ip)
    {
        return $this->dataRepository->find($ip);
    }

    /**
     * Get the IP address.
     *
     * @return mixed
     */
    public function getIp()
    {
        return $this->ip;
    }

    /**
     * Get the messages.
     *
     * @return array
     */
    public function getMessages()
    {
        return $this->messageRepository->getMessages();
    }

    /**
     * Check if IP address is valid.
     *
     * @param $ip
     *
     * @return bool
     */
    public function ipIsValid($ip)
    {
        return $this->dataRepository->ipIsValid($ip);
    }

    /**
     * Check if IP is blacklisted.
     *
     * @param null $ip

Are you sure the doc-type for parameter $ip is correct as it would always require null to be passed?

     *
     * @return bool
     */
    public function isBlacklisted($ip = null)
    {
        $list = $this->whichList($ip);

        return !($list == 'whitelist') &&
                $list == 'blacklist';
    }

    /**
     * Check if IP address is whitelisted.
     *
     * @param null $ip

Are you sure the doc-type for parameter $ip is correct as it would always require null to be passed?

     *
     * @return bool
     */
    public function isWhitelisted($ip = null)
    {
        return $this->whichList($ip) == 'whitelist';
    }

    /**
     * Register messages in log.
     *
     * @param $message
     * @return void
     */
    public function log($message)
    {
        if ($this->config->get('enable_log')) {
            app()->log->info("FIREWALL: $message");
        }
    }

    /**
     * Remove IP from all lists.
     *
     * @param $ip
     *
     * @return bool
     */
    public function remove($ip)
    {
        return $this->dataRepository->remove($ip);
    }

    /**
     * Get the list of all IP addresses stored.
     *
     * @return mixed
     */
    public function report()
    {
        return $this->dataRepository->all();
    }

    /**
     * Set the current IP address.
     *
     * @param $ip
     */
    public function setIp($ip)
    {
        $this->ip = $ip
            ?: ($this->ip
                ?: $this->request->getClientIp());
    }

    /**
     * Check if a string is a valid country info.
     *
     * @param $country
     *
     * @return bool
     */
    public function validCountry($country)
    {
        return $this->dataRepository->validCountry($country);
    }

    /**
     * Tell in which list (black/white) an IP address is.
     *
     * @param $ip_address
     *
     * @return bool|string
     */
    public function whichList($ip_address)
    {
        return $this->dataRepository->whichList($ip_address);
    }

    /**
     * Whitelist an IP address.
     *
     * @param $ip
     * @param bool $force
     *
     * @return bool
     */
    public function whitelist($ip, $force = false)
    {
        return $this->dataRepository->addToList(true, $ip, $force);
    }

    /**
     * Update the GeoIp2 database.
     *
     * @return bool
     */
    public function updateGeoIp()
    {
        $updater = new GeoIpUpdater();

        $success = $updater->updateGeoIpFiles($this->config->get('geoip_database_path'));

        $this->messageRepository->addMessage($updater->getMessages());

        return $success;
    }

    /**
     * Check if the application is receiving some sort of attack.
     *
     * @return bool
     */
    public function isBeingAttacked($ipAddress = null)
    {
        return $this->attackBlocker->isBeingAttacked($ipAddress ?: $this->ip);
    }

    /**
     * Get a response to the attack.
     *
     * @return bool
     */
    public function responseToAttack()
    {
        return $this->attackBlocker->responseToAttack();

The expression return $this->attackBlocker->responseToAttack() also could return the type Illuminate\Http\RedirectResponse which is incompatible with the documented return type boolean.

    }

    /**
     * Get country code from an IP address.
     *
     * @param $ip_address
     *
     * @return bool|string
     */
    public function getCountryFromIp($ip_address)
    {
        return $this->dataRepository->getCountryFromIp($ip_address);
    }

    /**
     * Make a country info from a string.
     *
     * @param $country
     * @return bool|string
     */
    public function makeCountryFromString($country)
    {
        return $this->dataRepository->makeCountryFromString($country);
    }

    /**
     * Get the GeoIP instance.
     *
     * @return object
     */
    public function getGeoIp()
    {
        return $this->dataRepository->getGeoIp();
    }
}