DeCaptchaAbstract::run() - Code Metrics - Inspection of "rucaptcha" - jumper423/decaptcha - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 570f1a...76d1b8 )

by Владислав

created 2016-12-19 00:40 UTC

DeCaptchaAbstract::run() A

↳ Parent: DeCaptchaAbstract::decodeResponse()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php

namespace jumper423\decaptcha\core;

use Exception;

/**
 * Class DeCaptchaAbstract.
 */
abstract class DeCaptchaAbstract implements DeCaptchaInterface
{
    const RESPONSE_TYPE_STRING = 0;
    const RESPONSE_TYPE_JSON = 1;

    const ACTION_FIELDS = 0;
    const ACTION_URI = 1;
    const ACTION_METHOD = 2;

    const ACTION_METHOD_POST = 0;
    const ACTION_METHOD_GET = 1;

    const DECODE_FORMAT = 0;
    const DECODE_ACTION = 1;
    const DECODE_SEPARATOR = 2;
    const DECODE_PARAMS = 3;
    const DECODE_PARAM_SETTING_MARKER = 4;

    const PARAM_FIELD_TYPE_STRING = 0;
    const PARAM_FIELD_TYPE_INTEGER = 1;

    const PARAM_SLUG_DEFAULT = 0;
    const PARAM_SLUG_TYPE = 1;
    const PARAM_SLUG_REQUIRE = 2;
    const PARAM_SLUG_SPEC = 3;
    const PARAM_SLUG_VARIABLE = 4;

    const PARAM_SPEC_KEY = 0;
    const PARAM_SPEC_FILE = 1;
    const PARAM_SPEC_CAPTCHA = 2;
    const PARAM_SPEC_CODE = 3;

    /**
     * Сервис на который будем загружать капчу.
     *
     * @var string
     */
    protected $domain;
    protected $errorLang = DeCaptchaErrors::LANG_EN;
    protected $lastRunTime = null;
    /** @var DeCaptchaErrors */
    protected $errorObject;
    protected $causeAnError = false;

    protected $limit = [];
    protected $paramsSpec = [];
    protected $params = [];
    protected $limitSettings = [];
    protected $decodeSettings = [];
    protected $actions = [];
    protected $paramsNames = [];

    protected function resetLimits()
    {
        foreach ($this->limitSettings as $action => $value) {
            $this->limit[$action] = $value;
        }
    }

    protected function limitHasNotYetEnded($action)
    {
        return $this->limit[$action]-- > 0;
    }

    /**
     * Не верно распознана.
     */
    public function notTrue()
    {
        $this->getResponse('reportbad');
    }

    protected function decodeResponse($action, $data)
    {
        if (!array_key_exists($action, $this->decodeSettings[static::DECODE_ACTION])) {
            throw new DeCaptchaErrors('нет action');
        }
        $decodeSetting = $this->decodeSettings[static::DECODE_ACTION][$action];
        $decodeFormat = array_key_exists(static::DECODE_FORMAT, $decodeSetting) ?
            $decodeSetting[static::DECODE_FORMAT] :
            $this->decodeSettings[static::DECODE_FORMAT];
        $values = [];
        switch ($decodeFormat) {
            case static::RESPONSE_TYPE_STRING:
                foreach (explode($decodeFormat[static::DECODE_SEPARATOR], $data) as $key => $value) {
                    foreach ($decodeFormat[static::DECODE_PARAMS] as $param => $paramKey) {
                        if ($key === $paramKey) {
                            $values[$param] = $value;
                        }
                    }
                }
                break;
        }

        return $values;
    }

    public function setErrorLang($errorLang)
    {
        $this->errorLang = $errorLang;
    }

    /**
     * Узнаём путь до файла
     * Если передана ссылка, то скачиваем и кладём во временную директорию.
     *
     * @param string $fileName
     *
     * @throws Exception
     *
     * @return string
     */
    protected function getFilePath($fileName)
    {
        if (strpos($fileName, 'http://') !== false || strpos($fileName, 'https://') !== false) {
            try {
                $current = file_get_contents($fileName);
            } catch (\Exception $e) {
                throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_FILE_IS_NOT_LOADED, $fileName, $this->errorLang);
            }
            $path = tempnam(sys_get_temp_dir(), 'captcha');
            file_put_contents($path, $current);

            return $path;
        }
        if (file_exists($fileName)) {
            return $fileName;
        }
        throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_FILE_NOT_FOUND, $fileName, $this->errorLang);
    }

    /**
     * @param $action
     *
     * @return string
     */
    protected function getActionUrl($action)
    {
        return $this->getBaseUrl().$this->actions[$action][static::ACTION_URI];
    }

    /**
     * @return string
     */
    protected function getBaseUrl()
    {
        return "http://{$this->domain}/";
    }

    public function setParams($params)
    {
        if (is_array($params)) {
            foreach ($params as $param => $value) {
                $this->params[$param] = $value;
            }
        }
    }

    public function setParamSpec($param, $value)
    {
        $this->paramsSpec[$param] = $value;
    }

    public function getParamSpec($param)
    {
        if (!array_key_exists($param, $this->paramsSpec) || is_null($this->paramsSpec[$param])) {
            return null;
        }
        switch ($param) {
            case static::PARAM_SPEC_FILE:
                return (version_compare(PHP_VERSION, '5.5.0') >= 0) ? new \CURLFile($this->paramsSpec[$param]) : '@'.$this->paramsSpec[$param];
            case static::PARAM_SPEC_KEY:
                return is_callable($this->paramsSpec[$param]) ? $this->paramsSpec[$param]() : $this->paramsSpec[$param];
            case static::PARAM_SPEC_CAPTCHA:
            case static::PARAM_SPEC_CODE:
                return $this->paramsSpec[$param];
        }

        return null;
    }

    protected function getParams($action)
    {
        if (empty($this->actions[$action])) {
            return [];
        }
        $params = [];
        foreach ($this->actions[$action][static::ACTION_FIELDS] as $field => $settings) {
            $value = null;
            if (array_key_exists($field, $this->params) && (!array_key_exists(self::PARAM_SLUG_VARIABLE, $settings) ^ (array_key_exists(self::PARAM_SLUG_VARIABLE, $settings) && $settings[self::PARAM_SLUG_VARIABLE] === false))) {
                $value = $this->params[$field];
            }
            if (array_key_exists(self::PARAM_SLUG_DEFAULT, $settings)) {
                $value = $settings[self::PARAM_SLUG_DEFAULT];
            }
            if (array_key_exists(self::PARAM_SLUG_SPEC, $settings) && array_key_exists($settings[self::PARAM_SLUG_SPEC], $this->paramsSpec)) {
                $value = $this->getParamSpec($settings[self::PARAM_SLUG_SPEC]);
            }
            if (array_key_exists(self::PARAM_SLUG_REQUIRE, $settings) && $settings[self::PARAM_SLUG_REQUIRE] === true && is_null($value)) {
                throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_PARAM_REQUIRE, array_key_exists($field, $this->paramsNames) ? $this->paramsNames[$field] : $field, $this->errorLang);
            }
            if (array_key_exists($field, $this->paramsNames)) {
                switch ($settings[self::PARAM_SLUG_TYPE]) {
                    case self::PARAM_FIELD_TYPE_INTEGER:
                        $params[$this->paramsNames[$field]] = (int) $value;
                        break;
                    case self::PARAM_FIELD_TYPE_STRING:
                        $params[$this->paramsNames[$field]] = (string) $value;
                        break;
                }
            }
        }

        return $params;
    }

    /**
     * @param string $action
     *
     * @return string
     */
    protected function getResponse($action)
    {
        return $this->getCurlResponse($this->getActionUrl($action), $this->getParams($action), $this->actions[$action][static::ACTION_METHOD] === static::ACTION_METHOD_POST);
    }

    /**
     * Задержка выполнения.
     *
     * @param int           $delay    Количество секунд
     * @param \Closure|null $callback
     *
     * @return mixed
     */
    protected function executionDelayed($delay = 0, $callback = null)
    {
        $time = microtime(true);
        $timePassed = $time - $this->lastRunTime;
        if ($timePassed < $delay) {
            usleep(($delay - $timePassed) * 1000000);
        }
        $this->lastRunTime = microtime(true);

        return $callback instanceof \Closure ? $callback($this) : $callback;
    }

    /**
     * @param string $url
     * @param $data
     * @param $isPost
     *
     * @throws DeCaptchaErrors
     *
     * @return mixed
     */
    protected function getCurlResponse($url, $data, $isPost = true)
    {
        $ch = curl_init();
        if ($isPost) {
            curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        } else {
            $uri = [];
            foreach ($data as $key => $value) {
                $uri[] = "$key=$value";
            }
            $url .= '?'.implode('&', $uri);
        }
        curl_setopt($ch, CURLOPT_URL, $url);
        if (version_compare(PHP_VERSION, '5.5.0') >= 0 && version_compare(PHP_VERSION, '7.0') < 0 && defined('CURLOPT_SAFE_UPLOAD')) {
            curl_setopt($ch, CURLOPT_SAFE_UPLOAD, false);
        }
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_TIMEOUT, 60);
        curl_setopt($ch, CURLOPT_POST, $isPost);
        $result = curl_exec($ch);
        if (curl_errno($ch)) {
            throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_CURL, curl_error($ch), $this->errorLang);
        }
        curl_close($ch);

        return $result;
    }

    abstract public function getCode();

    abstract public function getError();
}


1		<?php
2
3		namespace jumper423\decaptcha\core;
4
5		use Exception;
6
7		/**
8		* Class DeCaptchaAbstract.
9		*/
10		abstract class DeCaptchaAbstract implements DeCaptchaInterface
11		{
12		const RESPONSE_TYPE_STRING = 0;
13		const RESPONSE_TYPE_JSON = 1;
14
15		const ACTION_FIELDS = 0;
16		const ACTION_URI = 1;
17		const ACTION_METHOD = 2;
18
19		const ACTION_METHOD_POST = 0;
20		const ACTION_METHOD_GET = 1;
21
22		const DECODE_FORMAT = 0;
23		const DECODE_ACTION = 1;
24		const DECODE_SEPARATOR = 2;
25		const DECODE_PARAMS = 3;
26		const DECODE_PARAM_SETTING_MARKER = 4;
27
28		const PARAM_FIELD_TYPE_STRING = 0;
29		const PARAM_FIELD_TYPE_INTEGER = 1;
30
31		const PARAM_SLUG_DEFAULT = 0;
32		const PARAM_SLUG_TYPE = 1;
33		const PARAM_SLUG_REQUIRE = 2;
34		const PARAM_SLUG_SPEC = 3;
35		const PARAM_SLUG_VARIABLE = 4;
36
37		const PARAM_SPEC_KEY = 0;
38		const PARAM_SPEC_FILE = 1;
39		const PARAM_SPEC_CAPTCHA = 2;
40		const PARAM_SPEC_CODE = 3;
41
42		/**
43		* Сервис на который будем загружать капчу.
44		*
45		* @var string
46		*/
47		protected $domain;
48		protected $errorLang = DeCaptchaErrors::LANG_EN;
49		protected $lastRunTime = null;
50		/** @var DeCaptchaErrors */
51		protected $errorObject;
52		protected $causeAnError = false;
53
54		protected $limit = [];
55		protected $paramsSpec = [];
56		protected $params = [];
57		protected $limitSettings = [];
58		protected $decodeSettings = [];
59		protected $actions = [];
60		protected $paramsNames = [];
61
62		protected function resetLimits()
63		{
64		foreach ($this->limitSettings as $action => $value) {
65		$this->limit[$action] = $value;
66		}
67		}
68
69		protected function limitHasNotYetEnded($action)
70		{
71		return $this->limit[$action]-- > 0;
72		}
73
74		/**
75		* Не верно распознана.
76		*/
77		public function notTrue()
78		{
79		$this->getResponse('reportbad');
80		}
81
82		protected function decodeResponse($action, $data)
83		{
84		if (!array_key_exists($action, $this->decodeSettings[static::DECODE_ACTION])) {
85		throw new DeCaptchaErrors('нет action');
86		}
87		$decodeSetting = $this->decodeSettings[static::DECODE_ACTION][$action];
88		$decodeFormat = array_key_exists(static::DECODE_FORMAT, $decodeSetting) ?
89		$decodeSetting[static::DECODE_FORMAT] :
90		$this->decodeSettings[static::DECODE_FORMAT];
91		$values = [];
92	3	switch ($decodeFormat) {
93		case static::RESPONSE_TYPE_STRING:
94	3	foreach (explode($decodeFormat[static::DECODE_SEPARATOR], $data) as $key => $value) {
95	1	foreach ($decodeFormat[static::DECODE_PARAMS] as $param => $paramKey) {
96	1	if ($key === $paramKey) {
97	3	$values[$param] = $value;
98		}
99	3	}
100		}
101		break;
102		}
103
104		return $values;
105		}
106
107		public function setErrorLang($errorLang)
108		{
109		$this->errorLang = $errorLang;
110		}
111
112		/**
113		* Узнаём путь до файла
114	3	* Если передана ссылка, то скачиваем и кладём во временную директорию.
115	3	*
116	2	* @param string $fileName
117	2	*
118	1	* @throws Exception
119	1	*
120	1	* @return string
121	1	*/
122		protected function getFilePath($fileName)
123		{
124	1	if (strpos($fileName, 'http://') !== false \|\| strpos($fileName, 'https://') !== false) {
125	1	try {
126		$current = file_get_contents($fileName);
127	2	} catch (\Exception $e) {
128	1	throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_FILE_IS_NOT_LOADED, $fileName, $this->errorLang);
129		}
130	1	$path = tempnam(sys_get_temp_dir(), 'captcha');
131		file_put_contents($path, $current);
132
133		return $path;
134		}
135		if (file_exists($fileName)) {
136	4	return $fileName;
137	4	}
138		throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_FILE_NOT_FOUND, $fileName, $this->errorLang);
139		}
140
141		/**
142		* @param $action
143		*
144	2	* @return string
145	2	*/
146		protected function getActionUrl($action)
147		{
148		return $this->getBaseUrl().$this->actions[$action][static::ACTION_URI];
149		}
150
151		/**
152	1	* @return string
153	1	*/
154		protected function getBaseUrl()
155		{
156		return "http://{$this->domain}/";
157		}
158
159	1	public function setParams($params)
160	1	{
161		if (is_array($params)) {
162		foreach ($params as $param => $value) {
163		$this->params[$param] = $value;
164		}
165		}
166		}
167
168		public function setParamSpec($param, $value)
169	2	{
170		$this->paramsSpec[$param] = $value;
171	2	}
172	1
173		public function getParamSpec($param)
174	1	{
175		if (!array_key_exists($param, $this->paramsSpec) \|\| is_null($this->paramsSpec[$param])) {
176		return null;
177		}
178		switch ($param) {
179		case static::PARAM_SPEC_FILE:
180		return (version_compare(PHP_VERSION, '5.5.0') >= 0) ? new \CURLFile($this->paramsSpec[$param]) : '@'.$this->paramsSpec[$param];
181		case static::PARAM_SPEC_KEY:
182		return is_callable($this->paramsSpec[$param]) ? $this->paramsSpec[$param]() : $this->paramsSpec[$param];
183		case static::PARAM_SPEC_CAPTCHA:
184		case static::PARAM_SPEC_CODE:
185	1	return $this->paramsSpec[$param];
186	1	}
187	1
188	1	return null;
189	1	}
190	1
191	1	protected function getParams($action)
192	1	{
193		if (empty($this->actions[$action])) {
194		return [];
195		}
196		$params = [];
197		foreach ($this->actions[$action][static::ACTION_FIELDS] as $field => $settings) {
198		$value = null;
199		if (array_key_exists($field, $this->params) && (!array_key_exists(self::PARAM_SLUG_VARIABLE, $settings) ^ (array_key_exists(self::PARAM_SLUG_VARIABLE, $settings) && $settings[self::PARAM_SLUG_VARIABLE] === false))) {
200		$value = $this->params[$field];
201		}
202		if (array_key_exists(self::PARAM_SLUG_DEFAULT, $settings)) {
203		$value = $settings[self::PARAM_SLUG_DEFAULT];
204		}
205		if (array_key_exists(self::PARAM_SLUG_SPEC, $settings) && array_key_exists($settings[self::PARAM_SLUG_SPEC], $this->paramsSpec)) {
206		$value = $this->getParamSpec($settings[self::PARAM_SLUG_SPEC]);
207		}
208		if (array_key_exists(self::PARAM_SLUG_REQUIRE, $settings) && $settings[self::PARAM_SLUG_REQUIRE] === true && is_null($value)) {
209		throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_PARAM_REQUIRE, array_key_exists($field, $this->paramsNames) ? $this->paramsNames[$field] : $field, $this->errorLang);
210		}
211		if (array_key_exists($field, $this->paramsNames)) {
212		switch ($settings[self::PARAM_SLUG_TYPE]) {
213		case self::PARAM_FIELD_TYPE_INTEGER:
214		$params[$this->paramsNames[$field]] = (int) $value;
215		break;
216		case self::PARAM_FIELD_TYPE_STRING:
217		$params[$this->paramsNames[$field]] = (string) $value;
218		break;
219		}
220		}
221		}
222
223		return $params;
224		}
225
226		/**
227		* @param string $action
228		*
229		* @return string
230		*/
231		protected function getResponse($action)
232		{
233		return $this->getCurlResponse($this->getActionUrl($action), $this->getParams($action), $this->actions[$action][static::ACTION_METHOD] === static::ACTION_METHOD_POST);
234		}
235
236		/**
237		* Задержка выполнения.
238		*
239		* @param int $delay Количество секунд
240		* @param \Closure\|null $callback
241		*
242		* @return mixed
243		*/
244		protected function executionDelayed($delay = 0, $callback = null)
245		{
246		$time = microtime(true);
247		$timePassed = $time - $this->lastRunTime;
248		if ($timePassed < $delay) {
249		usleep(($delay - $timePassed) * 1000000);
250		}
251		$this->lastRunTime = microtime(true);
252
253		return $callback instanceof \Closure ? $callback($this) : $callback;
254		}
255
256		/**
257		* @param string $url
258		* @param $data
259		* @param $isPost
260		*
261		* @throws DeCaptchaErrors
262		*
263		* @return mixed
264		*/
265		protected function getCurlResponse($url, $data, $isPost = true)
266		{
267		$ch = curl_init();
268		if ($isPost) {
269		curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
270		} else {
271		$uri = [];
272		foreach ($data as $key => $value) {
273		$uri[] = "$key=$value";
274		}
275		$url .= '?'.implode('&', $uri);
276		}
277		curl_setopt($ch, CURLOPT_URL, $url);
278		if (version_compare(PHP_VERSION, '5.5.0') >= 0 && version_compare(PHP_VERSION, '7.0') < 0 && defined('CURLOPT_SAFE_UPLOAD')) {
279		curl_setopt($ch, CURLOPT_SAFE_UPLOAD, false);
280		}
281		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
282		curl_setopt($ch, CURLOPT_TIMEOUT, 60);
283		curl_setopt($ch, CURLOPT_POST, $isPost);
284		$result = curl_exec($ch);
285		if (curl_errno($ch)) {
286		throw new DeCaptchaErrors(DeCaptchaErrors::ERROR_CURL, curl_error($ch), $this->errorLang);
287		}
288		curl_close($ch);
289
290		return $result;
291		}
292
293		abstract public function getCode();
294
295		abstract public function getError();
296		}
297

jumper423 / decaptcha

Push — master ( 570f1a...76d1b8 )

DeCaptchaAbstract::run() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like