1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
|
<?php
/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */
namespace Icinga\Module\Monitoring\Web\Rest;
use Exception;
use Icinga\Application\Logger;
use Icinga\Util\Json;
use Icinga\Module\Monitoring\Exception\CurlException;
/**
* REST Request
*/
class RestRequest
{
/**
* Request URI
*
* @var string
*/
protected $uri;
/**
* Request method
*
* @var string
*/
protected $method;
/**
* Request content type
*
* @var string
*/
protected $contentType;
/**
* Whether to authenticate with basic auth
*
* @var bool
*/
protected $hasBasicAuth;
/**
* Auth username
*
* @var string
*/
protected $username;
/**
* Auth password
*
* @var string
*/
protected $password;
/**
* Request payload
*
* @var mixed
*/
protected $payload;
/**
* Whether strict SSL is enabled
*
* @var bool
*/
protected $strictSsl = true;
/**
* Request timeout
*
* @var int
*/
protected $timeout = 30;
/**
* Create a GET REST request
*
* @param string $uri
*
* @return static
*/
public static function get($uri)
{
$request = new static;
$request->uri = $uri;
$request->method = 'GET';
return $request;
}
/**
* Create a POST REST request
*
* @param string $uri
*
* @return static
*/
public static function post($uri)
{
$request = new static;
$request->uri = $uri;
$request->method = 'POST';
return $request;
}
/**
* Send content type JSON
*
* @return $this
*/
public function sendJson()
{
$this->contentType = 'application/json';
return $this;
}
/**
* Set basic auth credentials
*
* @param string $username
* @param string $password
*
* @return $this
*/
public function authenticateWith($username, $password)
{
$this->hasBasicAuth = true;
$this->username = $username;
$this->password = $password;
return $this;
}
/**
* Set request payload
*
* @param mixed $payload
*
* @return $this
*/
public function setPayload($payload)
{
$this->payload = $payload;
return $this;
}
/**
* Disable strict SSL
*
* @return $this
*/
public function noStrictSsl()
{
$this->strictSsl = false;
return $this;
}
/**
* Serialize payload according to content type
*
* @param mixed $payload
* @param string $contentType
*
* @return string
*/
public function serializePayload($payload, $contentType)
{
switch ($contentType) {
case 'application/json':
$payload = Json::encode($payload);
break;
}
return $payload;
}
/**
* Send the request
*
* @return mixed
*
* @throws Exception
*/
public function send()
{
$defaults = array(
'host' => 'localhost',
'path' => '/'
);
$url = array_merge($defaults, parse_url($this->uri));
if (isset($url['port'])) {
$url['host'] .= sprintf(':%u', $url['port']);
}
if (isset($url['query'])) {
$url['path'] .= sprintf('?%s', $url['query']);
}
$headers = array(
"{$this->method} {$url['path']} HTTP/1.1",
"Host: {$url['host']}",
"Content-Type: {$this->contentType}",
'Accept: application/json',
// Bypass "Expect: 100-continue" timeouts
'Expect:'
);
$options = array(
CURLOPT_URL => $this->uri,
CURLOPT_TIMEOUT => $this->timeout,
// Ignore proxy settings
CURLOPT_PROXY => '',
CURLOPT_CUSTOMREQUEST => $this->method
);
// Record cURL command line for debugging
$curlCmd = array('curl', '-s', '-X', $this->method, '-H', escapeshellarg('Accept: application/json'));
if ($this->strictSsl) {
$options[CURLOPT_SSL_VERIFYHOST] = 2;
$options[CURLOPT_SSL_VERIFYPEER] = true;
} else {
$options[CURLOPT_SSL_VERIFYHOST] = false;
$options[CURLOPT_SSL_VERIFYPEER] = false;
$curlCmd[] = '-k';
}
if ($this->hasBasicAuth) {
$options[CURLOPT_USERPWD] = sprintf('%s:%s', $this->username, $this->password);
$curlCmd[] = sprintf('-u %s:%s', escapeshellarg($this->username), escapeshellarg($this->password));
}
if (! empty($this->payload)) {
$payload = $this->serializePayload($this->payload, $this->contentType);
$options[CURLOPT_POSTFIELDS] = $payload;
$curlCmd[] = sprintf('-d %s', escapeshellarg($payload));
}
$options[CURLOPT_HTTPHEADER] = $headers;
$stream = null;
$logger = Logger::getInstance();
if ($logger !== null && $logger->getLevel() === Logger::DEBUG) {
$stream = fopen('php://temp', 'w');
$options[CURLOPT_VERBOSE] = true;
$options[CURLOPT_STDERR] = $stream;
}
Logger::debug(
'Executing %s %s',
implode(' ', $curlCmd),
escapeshellarg($this->uri)
);
$result = $this->curlExec($options);
if (is_resource($stream)) {
rewind($stream);
Logger::debug(stream_get_contents($stream));
fclose($stream);
}
return Json::decode($result, true);
}
/**
* Set up a new cURL handle with the given options and call {@link curl_exec()}
*
* @param array $options
*
* @return string The response
*
* @throws CurlException
*/
protected function curlExec(array $options)
{
$ch = curl_init();
$options[CURLOPT_RETURNTRANSFER] = true;
curl_setopt_array($ch, $options);
$result = curl_exec($ch);
if ($result === false) {
throw new CurlException('%s', curl_error($ch));
}
curl_close($ch);
return $result;
}
}
|