think\middleware\Throttle

Complexity

Total Complexity

17

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	parseRate()	0	6	1
A	getCacheKey()	0	19	6
A	wait()	0	7	3
A	allowRequest()	0	24	3
A	__construct()	0	4	1
A	setRate()	0	2	1
A	handle()	0	8	2

<?php

Missing file doc comment

declare (strict_types = 1);

namespace think\middleware;

use Closure;
use think\Cache;
use think\Config;
use think\Request;
use think\Response;

/**
 * 访问频率限制
 * Class Throttle
 * @package think\middleware

Package name "think\middleware" is not valid; consider "Thinkmiddleware" instead

 */
class Throttle
{
    /**
     * 缓存对象
     * @var Cache
     */
    protected $cache;

    /**
     * 配置参数
     * @var array
     */
    protected $config = [
        // 节流规则 true为自动规则
        'key'    => true,
        // 节流频率 null 表示不限制 eg: 10/m  20/h  300/d
        'visit_rate' => null,
        'visit_fail_text' => '访问频率受到限制，请稍等 %s秒 再试',

    ];

    protected $wait_seconds = 0;

    protected $duration = [
        's' => 1,
        'm' => 60,
        'h' => 3600,
        'd' => 86400,
    ];

    public function __construct(Cache $cache, Config $config)

Missing doc comment for function __construct()

    {
        $this->cache  = $cache;
        $this->config = array_merge($this->config, $config->get('middleware.throttle', []));
    }

    /**
     * 生成缓存的 key
     * @param Request $request

Missing parameter comment

     * @return null|string
     */
    protected function getCacheKey($request)
    {
        $key = $this->config['key'];
        if ($key instanceof \Closure) {
            $key = call_user_func($key, $this, $request);
        }

        if (false === $key || null === $this->config['visit_rate']) {
            // 关闭当前限制
            return;
        }

        if (true === $key) {
            $key = $request->ip();
        } elseif (false !== strpos($key, '__IP__')) {
            $key = str_replace('__IP__', $request->ip(), $key);
        }

        return md5($key);
    }

    /**

Parameter $rate should have a doc-comment as per coding-style.

     * 解析频率配置项
     * @param $rate

Missing parameter name

     * @return array
     */
    protected function parseRate($rate)
    {
        list($num, $period) = explode("/", $rate);
        $num_requests = intval($num);
        $duration = $this->duration[$period];
        return [$num_requests, $duration];
    }

    /**

Parameter $history should have a doc-comment as per coding-style.

Parameter $now should have a doc-comment as per coding-style.

Parameter $num_requests should have a doc-comment as per coding-style.

Parameter $duration should have a doc-comment as per coding-style.

     * 计算距离下次合法请求还有多少秒
     * @param $history

Missing parameter name

     * @param $now

Missing parameter name

     * @param $num_requests

Missing parameter name

     * @param $duration

Missing parameter name

     * @return void
     */
    protected function wait($history, $now, $num_requests, $duration)

The parameter $num_requests is not used and could be removed.

    {
        $wait_seconds = $history ? $duration - ($now - $history[0]) : $duration;
        if ($wait_seconds <= 0) {
            $wait_seconds = 0;
        }
        $this->wait_seconds = $wait_seconds;
    }

    /**

Parameter $request should have a doc-comment as per coding-style.

     * 请求是否允许
     * @param $request

Missing parameter name

     * @return bool
     */
    protected function allowRequest($request)
    {
        $key = $this->getCacheKey($request);
        if (null === $key) {
            return true;
        }
        list($num_requests, $duration) = $this->parseRate($this->config['visit_rate']);
        $history = $this->cache->get($key, []);
        $now = time();

        // 移除过期的请求的记录
        $history = array_values(array_filter($history, function($val) use ($now, $duration) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            return $val >= $now - $duration;
        }));

For multi-line function calls, the closing parenthesis should be on a new line.

        if (count($history) <= $num_requests) {
            // 允许访问
            $history[] = $now;
            $this->cache->set($key, $history, $now + $duration);
            return true;
        }

        $this->wait($history, $now, $num_requests, $duration);
        return false;
    }

    /**
     * 处理限制访问
     * @param Request $request

Missing parameter comment

     * @param Closure $next

Missing parameter comment

     * @return Response
     */
    public function handle($request, Closure $next)
    {
        $allow = $this->allowRequest($request);
        if (!$allow) {
            return Response::create(sprintf($this->config['visit_fail_text'], $this->wait_seconds))->code(403);
        }
        $response = $next($request);
        return $response;
    }

    public function setRate($rate) {

Missing doc comment for function setRate()

Opening brace should be on a new line

        $this->config['visit_rate'] = $rate;
    }
}