|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace PiHole; |
|
4
|
|
|
|
|
5
|
|
|
use ErrorException; |
|
6
|
|
|
use GuzzleHttp\RequestOptions; |
|
7
|
|
|
use Psr\Http\Message\ResponseInterface; |
|
8
|
|
|
use PiHole\Exceptions\EmptyResults; |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* @author Paul Rock <[email protected]> |
|
12
|
|
|
* @link https://drteam.rocks |
|
13
|
|
|
* @license MIT |
|
14
|
|
|
* @package PiHole |
|
15
|
|
|
*/ |
|
16
|
|
|
trait HttpTrait |
|
17
|
|
|
{ |
|
18
|
|
|
/** |
|
19
|
|
|
* Initial state of some variables |
|
20
|
|
|
* |
|
21
|
|
|
* @var \GuzzleHttp\Client |
|
22
|
|
|
*/ |
|
23
|
|
|
private $client; |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* Object of main config |
|
27
|
|
|
* |
|
28
|
|
|
* @var \PiHole\Config |
|
29
|
|
|
*/ |
|
30
|
|
|
protected $config; |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* Request executor with timeout and repeat tries |
|
34
|
|
|
* |
|
35
|
|
|
* @param string $type Request method |
|
36
|
|
|
* @param array $params List of parameters |
|
37
|
|
|
* @param array|null $endpoint endpoint url |
|
38
|
|
|
* @param bool $auth |
|
39
|
|
|
* |
|
40
|
|
|
* @return null|\Psr\Http\Message\ResponseInterface |
|
41
|
|
|
* @throws \GuzzleHttp\Exception\GuzzleException |
|
42
|
|
|
* @throws \ErrorException |
|
43
|
|
|
*/ |
|
44
|
|
|
private function repeatRequest(string $type, array $endpoint = null, array $params = null, bool $auth = false): ?ResponseInterface |
|
45
|
|
|
{ |
|
46
|
|
|
$type = strtoupper($type); |
|
47
|
|
|
|
|
48
|
|
|
for ($i = 1; $i < $this->config->get('tries'); $i++) { |
|
49
|
|
|
|
|
50
|
|
|
if ($params === null) { |
|
51
|
|
|
// Execute the request to server |
|
52
|
|
|
$result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth)); |
|
53
|
|
|
} else { |
|
54
|
|
|
// Execute the request to server |
|
55
|
|
|
$result = $this->client->request($type, $this->config->getBaseUrl($endpoint, $auth), [RequestOptions::FORM_PARAMS => $params]); |
|
56
|
|
|
} |
|
57
|
|
|
|
|
58
|
|
|
// Check the code status |
|
59
|
|
|
$code = $result->getStatusCode(); |
|
60
|
|
|
$reason = $result->getReasonPhrase(); |
|
61
|
|
|
|
|
62
|
|
|
// If success response from server |
|
63
|
|
|
if ($code === 200 || $code === 201) { |
|
64
|
|
|
return $result; |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
// If not "too many requests", then probably some bug on remote or our side |
|
68
|
|
|
if ($code !== 429) { |
|
69
|
|
|
throw new ErrorException($code . ' ' . $reason); |
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
|
|
// Waiting in seconds |
|
73
|
|
|
sleep($this->config->get('seconds')); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
// Return false if loop is done but no answer from server |
|
77
|
|
|
return null; |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
/** |
|
81
|
|
|
* Execute request and return response |
|
82
|
|
|
* |
|
83
|
|
|
* @return null|object Array with data or NULL if error |
|
84
|
|
|
* @throws \GuzzleHttp\Exception\GuzzleException |
|
85
|
|
|
* @throws \ErrorException |
|
86
|
|
|
* @throws \PiHole\Exceptions\EmptyResults |
|
87
|
|
|
*/ |
|
88
|
|
|
public function exec() |
|
89
|
|
|
{ |
|
90
|
|
|
return $this->doRequest($this->type, $this->endpoint, $this->params, false, $this->auth); |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
|
/** |
|
94
|
|
|
* Execute query and return RAW response from remote API |
|
95
|
|
|
* |
|
96
|
|
|
* @return null|\Psr\Http\Message\ResponseInterface RAW response or NULL if error |
|
97
|
|
|
* @throws \GuzzleHttp\Exception\GuzzleException |
|
98
|
|
|
* @throws \ErrorException |
|
99
|
|
|
* @throws \PiHole\Exceptions\EmptyResults |
|
100
|
|
|
*/ |
|
101
|
|
|
public function raw(): ?ResponseInterface |
|
102
|
|
|
{ |
|
103
|
|
|
return $this->doRequest($this->type, $this->endpoint, $this->params, true, $this->auth); |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
/** |
|
107
|
|
|
* Make the request and analyze the result |
|
108
|
|
|
* |
|
109
|
|
|
* @param string $type Request method |
|
110
|
|
|
* @param array $endpoint Api request endpoint |
|
111
|
|
|
* @param array $params List of parameters |
|
112
|
|
|
* @param bool $raw Return data in raw format |
|
113
|
|
|
* @param bool $auth |
|
114
|
|
|
* |
|
115
|
|
|
* @return null|object|ResponseInterface Array with data, RAW response or NULL if error |
|
116
|
|
|
* @throws \GuzzleHttp\Exception\GuzzleException |
|
117
|
|
|
* @throws \ErrorException |
|
118
|
|
|
* @throws \PiHole\Exceptions\EmptyResults |
|
119
|
|
|
*/ |
|
120
|
|
|
private function doRequest(string $type, array $endpoint = null, array $params = null, bool $raw = false, bool $auth = false) |
|
121
|
|
|
{ |
|
122
|
|
|
// Null by default |
|
123
|
|
|
$response = null; |
|
|
|
|
|
|
124
|
|
|
|
|
125
|
|
|
// Execute the request to server |
|
126
|
|
|
$result = $this->repeatRequest($type, $endpoint, $params, $auth); |
|
127
|
|
|
|
|
128
|
|
|
if (null === $result) { |
|
129
|
|
|
throw new EmptyResults('Empty results returned from Pi-Hole API'); |
|
130
|
|
|
} |
|
131
|
|
|
|
|
132
|
|
|
// Return RAW result if required |
|
133
|
|
|
return $raw ? $result : json_decode($result->getBody(), false); |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
|
|
} |
|
137
|
|
|
|
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVarassignment in line 1 and the$higherassignment in line 2 are dead. The first because$myVaris never used and the second because$higheris always overwritten for every possible time line.