Someshwer\Firewall\src\Repo\FirewallRepository

Complexity

Total Complexity

28

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	6
Bugs	1	Features	4

9 Methods

Rating	Name	Duplication	Size	Complexity
A	addPagination()	0	14	4
B	prepareList()	0	29	6
A	getUniqueIpAddresses()	0	11	1
A	getLogInstance()	0	10	3
A	initializeIpStatusList()	0	11	1
A	getIpStatus()	0	17	5
A	getList()	0	18	6
A	addWhereBetweenClause()	0	5	1
A	validateDates()	0	11	1

<?php

namespace Someshwer\Firewall\src\Repo;

use Carbon\Carbon;

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

use Illuminate\Support\Facades\Validator;

The type Illuminate\Support\Facades\Validator was not found. Maybe you did not declare it correctly or list all dependencies?

use Someshwer\Firewall\src\Entities\ExceptionLog;
use Someshwer\Firewall\src\Entities\FirewallLog;
use Someshwer\Firewall\src\Entities\FirewallRequestsLogModel;

/**
 * @author Someshwer
 * Date: 15-08-2018
 */
class FirewallRepository
{
    /**
     * Prepares list with white, black, accept, and reject ips.
     *
     * @param $item
     * @param $list_type
     *
     * @return array
     */
    private function prepareList($item, $list_type)
    {
        $record = [
            'ip_address'     => $item,
            'in_whitelist'   => false,
            'in_blacklist'   => false,
            'in_accept_list' => false,
            'in_reject_list' => false,
        ];
        if ($list_type == 'white') {
            $record['in_whitelist'] = true;
        }
        if ($list_type == 'black') {
            $record['in_blacklist'] = true;
        }
        if ($list_type == 'accept') {
            $record['in_accept_list'] = true;
        }
        if ($list_type == 'reject') {
            $record['in_reject_list'] = true;
        }
        if ($list_type == 'common') {
            $record['in_whitelist'] = true;
            $record['in_blacklist'] = true;
            $record['in_accept_list'] = true;
            $record['in_reject_list'] = true;
        }

        return $record;
    }

    /**
     * Fetches list with white, black, accept, and reject ips.
     *
     * @param $list
     * @param $flag
     * @param $list_type
     *
     * @return array
     */
    public function getList($list, $flag, $list_type)
    {
        $result_list = [];
        foreach ($list as $item) {
            if ($flag == 2) {
                $set = $this->prepareList($item, $list_type);
                if (($list_type == 'white') || $list_type == 'black') {
                    $result_list[] = array_except($set, ['in_accept_list', 'in_reject_list']);

The function array_except was not found. Maybe you did not declare it correctly or list all dependencies?

                } else {
                    $result_list[] = array_except($set, ['in_whitelist', 'in_blacklist']);
                }
            }
            if ($flag == 4) {
                $result_list[] = $this->prepareList($item, $list_type);
            }
        }

        return $result_list;
    }

    /**
     * Get log instance based on type.
     *
     * @param null $log_type

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

     *
     * @return ExceptionLog|FirewallLog|FirewallRequestsLogModel
     */
    public function getLogInstance($log_type = null)
    {
        if ($log_type == 'request_log') {
            return $request_log = new FirewallRequestsLogModel();

The assignment to $request_log is dead and can be removed.

        }
        if ($log_type == 'exception_log') {
            return $request_log = new ExceptionLog();
        }

        return $log = new FirewallLog();

The assignment to $log is dead and can be removed.

    }

    /**
     * Validating dates and dates must be in Y-m-d format.
     *
     * @param $from_date
     * @param $to_date
     *
     * @return bool
     */
    public function validateDates($from_date, $to_date)
    {
        $validation = Validator::make([
            'from_date' => $from_date,
            'to_date'   => $to_date,
        ], [
            'from_date' => 'date_format:Y-m-d',
            'to_date'   => 'date_format:Y-m-d|after:from_date',
        ]);

        return $validation->fails();
    }

    /**
     * Add where clause to a query if dates are present
     * in specified format i.e.; Y-m-d.
     *
     * @param $log
     * @param $from_date
     * @param $to_date
     *
     * @return mixed
     */
    public function addWhereBetweenClause($log, $from_date, $to_date)
    {
        // $from = Carbon::createFromFormat('Y-m-d', $from_date)->format('Y-m-d');
        // $to = Carbon::createFromFormat('Y-m-d', $to_date)->format('Y-m-d');
        return $log->whereDate('created_at', '>=', $from_date)->whereDate('created_at', '<=', $to_date);
    }

    /**
     * Adding pagination if config option for pagination is enabled.
     *
     * @param $log
     * @param null $log_type

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

     *
     * @return mixed
     */
    public function addPagination($log, $log_type = null)
    {
        if ($log_type == 'request_log') {
            $is_pagination = config('firewall.firewall_requests_log_pagination.enabled');

The function config was not found. Maybe you did not declare it correctly or list all dependencies?

            $records_per_page = config('firewall.firewall_requests_log_pagination.per_page');
        } elseif ($log_type == 'exception_log') {
            $is_pagination = config('firewall.exception_log_pagination.enabled');
            $records_per_page = config('firewall.exception_log_pagination.per_page');
        } else {
            $is_pagination = config('firewall.firewall_log_pagination.enabled');
            $records_per_page = config('firewall.firewall_log_pagination.per_page');
        }

        return $is_pagination ? $log->paginate($records_per_page) : $log->get();
    }

    /**
     * Fetches unique ip addresses.
     *
     * @return array
     */
    public function getUniqueIpAddresses()
    {
        $ip_addresses = array_merge_recursive(
            config('firewall.whitelist'),

The function config was not found. Maybe you did not declare it correctly or list all dependencies?

            config('firewall.blacklist'),
            config('firewall.accept'),
            config('firewall.reject')
        );
        $unique_ip_addresses = array_unique($ip_addresses);

        return $unique_ip_addresses;
    }

    /**
     * Initializes ip status list with default values.
     *
     * @param $ip_address
     *
     * @return array
     */
    private function initializeIpStatusList($ip_address)
    {
        $ip_statuses = [
            'ip_address'     => $ip_address,
            'in_whitelist'   => false,
            'in_blacklist'   => false,
            'in_accept_list' => false,
            'in_reject_list' => false,
        ];

        return $ip_statuses;
    }

    /**
     * Fetches the statuses for ip addresses.
     *
     * @param $ip_address
     *
     * @return array
     */
    public function getIpStatus($ip_address)
    {
        $initialized_list = $this->initializeIpStatusList($ip_address);
        if (in_array($ip_address, config('firewall.whitelist'))) {

The function config was not found. Maybe you did not declare it correctly or list all dependencies?

            $initialized_list['in_whitelist'] = true;
        }
        if (in_array($ip_address, config('firewall.blacklist'))) {
            $initialized_list['in_blacklist'] = true;
        }
        if (in_array($ip_address, config('firewall.accept'))) {
            $initialized_list['in_accept_list'] = true;
        }
        if (in_array($ip_address, config('firewall.reject'))) {
            $initialized_list['in_reject_list'] = true;
        }

        return $initialized_list;
    }
}