pgleadershipbook
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
pgleadershipbook / trunk / system / HTTP / CURLRequest.php
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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\HTTP; use CodeIgniter\HTTP\Exceptions\HTTPException; use Config\App; /** * Class OutgoingRequest * * A lightweight HTTP client for sending synchronous HTTP requests * via cURL. * * @package CodeIgniter\HTTP */ class CURLRequest extends Request { /** * The response object associated with this request * * @var \CodeIgniter\HTTP\Response */ protected $response; /** * The URI associated with this request * * @var URI */ protected $baseURI; /** * The setting values * * @var array */ protected $config = [ 'timeout' => 0.0, 'connect_timeout' => 150, 'debug' => false, 'verify' => true, ]; /** * Default values for when 'allow_redirects' * option is true. * * @var array */ protected $redirectDefaults = [ 'max' => 5, 'strict' => true, 'protocols' => [ 'http', 'https', ], ]; /** * The number of milliseconds to delay before * sending the request. * * @var float */ protected $delay = 0.0; //-------------------------------------------------------------------- /** * Takes an array of options to set the following possible class properties: * * - baseURI * - timeout * - any other request options to use as defaults. * * @param App $config * @param URI $uri * @param ResponseInterface $response * @param array $options */ public function __construct(App $config, URI $uri, ResponseInterface $response = null, array $options = []) { if (! function_exists('curl_version')) { // we won't see this during travis-CI // @codeCoverageIgnoreStart throw HTTPException::forMissingCurl(); // @codeCoverageIgnoreEnd } parent::__construct($config); $this->response = $response; $this->baseURI = $uri; $this->parseOptions($options); } //-------------------------------------------------------------------- /** * Sends an HTTP request to the specified $url. If this is a relative * URL, it will be merged with $this->baseURI to form a complete URL. * * @param $method * @param string $url * @param array $options * * @return \CodeIgniter\HTTP\ResponseInterface */ public function request($method, string $url, array $options = []): ResponseInterface { $this->parseOptions($options); $url = $this->prepareURL($url); $method = filter_var($method, FILTER_SANITIZE_STRING); $this->send($method, $url); return $this->response; } //-------------------------------------------------------------------- /** * Convenience method for sending a GET request. * * @param string $url * @param array $options * * @return \CodeIgniter\HTTP\ResponseInterface */ public function get(string $url, array $options = []): ResponseInterface { return $this->request('get', $url, $options); } //-------------------------------------------------------------------- /** * Convenience method for sending a DELETE request. * * @param string $url * @param array $options * * @return \CodeIgniter\HTTP\ResponseInterface */ public function delete(string $url, array $options = []): ResponseInterface { return $this->request('delete', $url, $options); } //-------------------------------------------------------------------- /** * Convenience method for sending a HEAD request. * * @param string $url * @param array $options * * @return ResponseInterface */ public function head(string $url, array $options = []): ResponseInterface { return $this->request('head', $url, $options); } //-------------------------------------------------------------------- /** * Convenience method for sending an OPTIONS request. * * @param string $url * @param array $options * * @return \CodeIgniter\HTTP\ResponseInterface */ public function options(string $url, array $options = []): ResponseInterface { return $this->request('options', $url, $options); } //-------------------------------------------------------------------- /** * Convenience method for sending a PATCH request. * * @param string $url * @param array $options * * @return \CodeIgniter\HTTP\ResponseInterface */ public function patch(string $url, array $options = []): ResponseInterface { return $this->request('patch', $url, $options); } //-------------------------------------------------------------------- /** * Convenience method for sending a POST request. * * @param string $url * @param array $options * * @return \CodeIgniter\HTTP\ResponseInterface */ public function post(string $url, array $options = []): ResponseInterface { return $this->request('post', $url, $options); } //-------------------------------------------------------------------- /** * Convenience method for sending a PUT request. * * @param string $url * @param array $options * * @return \CodeIgniter\HTTP\ResponseInterface */ public function put(string $url, array $options = []): ResponseInterface { return $this->request('put', $url, $options); } //-------------------------------------------------------------------- /** * Set the HTTP Authentication. * * @param string $username * @param string $password * @param string $type basic or digest * * @return $this */ public function setAuth(string $username, string $password, string $type = 'basic') { $this->config['auth'] = [ $username, $password, $type, ]; return $this; } //-------------------------------------------------------------------- /** * Set form data to be sent. * * @param array $params * @param boolean $multipart Set TRUE if you are sending CURLFiles * * @return $this */ public function setForm(array $params, bool $multipart = false) { if ($multipart) { $this->config['multipart'] = $params; } else { $this->config['form_params'] = $params; } return $this; } //-------------------------------------------------------------------- /** * Set JSON data to be sent. * * @param mixed $data * * @return $this */ public function setJSON($data) { $this->config['json'] = $data; return $this; } //-------------------------------------------------------------------- /** * Sets the correct settings based on the options array * passed in. * * @param array $options */ protected function parseOptions(array $options) { if (array_key_exists('baseURI', $options)) { $this->baseURI = $this->baseURI->setURI($options['baseURI']); unset($options['baseURI']); } if (array_key_exists('headers', $options) && is_array($options['headers'])) { foreach ($options['headers'] as $name => $value) { $this->setHeader($name, $value); } unset($options['headers']); } if (array_key_exists('delay', $options)) { // Convert from the milliseconds passed in // to the seconds that sleep requires. $this->delay = (float) $options['delay'] / 1000; unset($options['delay']); } foreach ($options as $key => $value) { $this->config[$key] = $value; } } //-------------------------------------------------------------------- /** * If the $url is a relative URL, will attempt to create * a full URL by prepending $this->baseURI to it. * * @param string $url * * @return string */ protected function prepareURL(string $url): string { // If it's a full URI, then we have nothing to do here... if (strpos($url, '://') !== false) { return $url; } $uri = $this->baseURI->resolveRelativeURI($url); return (string) $uri; } //-------------------------------------------------------------------- /** * Get the request method. Overrides the Request class' method * since users expect a different answer here. * * @param boolean|false $upper Whether to return in upper or lower case. * * @return string */ public function getMethod(bool $upper = false): string { return ($upper) ? strtoupper($this->method) : strtolower($this->method); } //-------------------------------------------------------------------- /** * Fires the actual cURL request. * * @param string $method * @param string $url * * @return \CodeIgniter\HTTP\ResponseInterface */ public function send(string $method, string $url) { // Reset our curl options so we're on a fresh slate. $curl_options = []; if (! empty($this->config['query']) && is_array($this->config['query'])) { // This is likely too naive a solution. // Should look into handling when $url already // has query vars on it. $url .= '?' . http_build_query($this->config['query']); unset($this->config['query']); } $curl_options[CURLOPT_URL] = $url; $curl_options[CURLOPT_RETURNTRANSFER] = true; $curl_options[CURLOPT_HEADER] = true; $curl_options[CURLOPT_FRESH_CONNECT] = true; // Disable @file uploads in post data. $curl_options[CURLOPT_SAFE_UPLOAD] = true; $curl_options = $this->setCURLOptions($curl_options, $this->config); $curl_options = $this->applyMethod($method, $curl_options); $curl_options = $this->applyRequestHeaders($curl_options); // Do we need to delay this request? if ($this->delay > 0) { sleep($this->delay); } $output = $this->sendRequest($curl_options); if (strpos($output, 'HTTP/1.1 100 Continue') === 0) { $output = substr($output, strpos($output, "\r\n\r\n") + 4); } // Split out our headers and body $break = strpos($output, "\r\n\r\n"); if ($break !== false) { // Our headers $headers = explode("\n", substr($output, 0, $break)); $this->setResponseHeaders($headers); // Our body $body = substr($output, $break + 4); $this->response->setBody($body); } else { $this->response->setBody($output); } return $this->response; } //-------------------------------------------------------------------- /** * Takes all headers current part of this request and adds them * to the cURL request. * * @param array $curl_options * * @return array */ protected function applyRequestHeaders(array $curl_options = []): array { if (empty($this->headers)) { $this->populateHeaders(); // Otherwise, it will corrupt the request $this->removeHeader('Host'); $this->removeHeader('Accept-Encoding'); } $headers = $this->getHeaders(); if (empty($headers)) { return $curl_options; } $set = []; foreach ($headers as $name => $value) { $set[] = $name . ': ' . $this->getHeaderLine($name); } $curl_options[CURLOPT_HTTPHEADER] = $set; return $curl_options; } //-------------------------------------------------------------------- /** * Apply method * * @param string $method * @param array $curl_options * * @return array */ protected function applyMethod(string $method, array $curl_options): array { $method = strtoupper($method); $this->method = $method; $curl_options[CURLOPT_CUSTOMREQUEST] = $method; $size = strlen($this->body); // Have content? if ($size === null || $size > 0) { return $this->applyBody($curl_options); } if ($method === 'PUT' || $method === 'POST') { // See http://tools.ietf.org/html/rfc7230#section-3.3.2 if (is_null($this->getHeader('content-length')) && ! isset($this->config['multipart'])) { $this->setHeader('Content-Length', '0'); } } else if ($method === 'HEAD') { $curl_options[CURLOPT_NOBODY] = 1; } return $curl_options; } //-------------------------------------------------------------------- /** * Apply body * * @param array $curl_options * * @return array */ protected function applyBody(array $curl_options = []): array { if (! empty($this->body)) { $curl_options[CURLOPT_POSTFIELDS] = (string) $this->getBody(); } return $curl_options; } //-------------------------------------------------------------------- /** * Parses the header retrieved from the cURL response into * our Response object. * * @param array $headers */ protected function setResponseHeaders(array $headers = []) { foreach ($headers as $header) { if (($pos = strpos($header, ':')) !== false) { $title = substr($header, 0, $pos); $value = substr($header, $pos + 1); $this->response->setHeader($title, $value); } else if (strpos($header, 'HTTP') === 0) { preg_match('#^HTTP\/([12]\.[01]) ([0-9]+) (.+)#', $header, $matches); if (isset($matches[1])) { $this->response->setProtocolVersion($matches[1]); } if (isset($matches[2])) { $this->response->setStatusCode($matches[2], $matches[3] ?? null); } } } } //-------------------------------------------------------------------- /** * Set CURL options * * @param array $curl_options * @param array $config * @return array * @throws \InvalidArgumentException */ protected function setCURLOptions(array $curl_options = [], array $config = []) { // Auth Headers if (! empty($config['auth'])) { $curl_options[CURLOPT_USERPWD] = $config['auth'][0] . ':' . $config['auth'][1]; if (! empty($config['auth'][2]) && strtolower($config['auth'][2]) === 'digest') { $curl_options[CURLOPT_HTTPAUTH] = CURLAUTH_DIGEST; } else { $curl_options[CURLOPT_HTTPAUTH] = CURLAUTH_BASIC; } } // Certificate if (! empty($config['cert'])) { $cert = $config['cert']; if (is_array($cert)) { $curl_options[CURLOPT_SSLCERTPASSWD] = $cert[1]; $cert = $cert[0]; } if (! is_file($cert)) { throw HTTPException::forSSLCertNotFound($cert); } $curl_options[CURLOPT_SSLCERT] = $cert; } // SSL Verification if (isset($config['verify'])) { if (is_string($config['verify'])) { $file = realpath($config['ssl_key']); if (! $file) { throw HTTPException::forInvalidSSLKey($config['ssl_key']); } $curl_options[CURLOPT_CAINFO] = $file; $curl_options[CURLOPT_SSL_VERIFYPEER] = 1; } else if (is_bool($config['verify'])) { $curl_options[CURLOPT_SSL_VERIFYPEER] = $config['verify']; } } // Debug if ($config['debug']) { $curl_options[CURLOPT_VERBOSE] = 1; $curl_options[CURLOPT_STDERR] = is_string($config['debug']) ? fopen($config['debug'], 'a+') : fopen('php://stderr', 'w'); } // Decode Content if (! empty($config['decode_content'])) { $accept = $this->getHeaderLine('Accept-Encoding'); if ($accept) { $curl_options[CURLOPT_ENCODING] = $accept; } else { $curl_options[CURLOPT_ENCODING] = ''; $curl_options[CURLOPT_HTTPHEADER] = 'Accept-Encoding'; } } // Allow Redirects if (array_key_exists('allow_redirects', $config)) { $settings = $this->redirectDefaults; if (is_array($config['allow_redirects'])) { $settings = array_merge($settings, $config['allow_redirects']); } if ($config['allow_redirects'] === false) { $curl_options[CURLOPT_FOLLOWLOCATION] = 0; } else { $curl_options[CURLOPT_FOLLOWLOCATION] = 1; $curl_options[CURLOPT_MAXREDIRS] = $settings['max']; if ($settings['strict'] === true) { $curl_options[CURLOPT_POSTREDIR] = 1 | 2 | 4; } $protocols = 0; foreach ($settings['protocols'] as $proto) { $protocols += constant('CURLPROTO_' . strtoupper($proto)); } $curl_options[CURLOPT_REDIR_PROTOCOLS] = $protocols; } } // Timeout $curl_options[CURLOPT_TIMEOUT_MS] = (float) $config['timeout'] * 1000; // Connection Timeout $curl_options[CURLOPT_CONNECTTIMEOUT_MS] = (float) $config['connect_timeout'] * 1000; // Post Data - application/x-www-form-urlencoded if (! empty($config['form_params']) && is_array($config['form_params'])) { $postFields = http_build_query($config['form_params']); $curl_options[CURLOPT_POSTFIELDS] = $postFields; // Ensure content-length is set, since CURL doesn't seem to // calculate it when HTTPHEADER is set. $this->setHeader('Content-Length', (string) strlen($postFields)); $this->setHeader('Content-Type', 'application/x-www-form-urlencoded'); } // Post Data - multipart/form-data if (! empty($config['multipart']) && is_array($config['multipart'])) { // setting the POSTFIELDS option automatically sets multipart $curl_options[CURLOPT_POSTFIELDS] = $config['multipart']; } // HTTP Errors $curl_options[CURLOPT_FAILONERROR] = array_key_exists('http_errors', $config) ? (bool) $config['http_errors'] : true; // JSON if (isset($config['json'])) { // Will be set as the body in `applyBody()` $json = json_encode($config['json']); $this->setBody($json); $this->setHeader('Content-Type', 'application/json'); $this->setHeader('Content-Length', (string) strlen($json)); } // version if (! empty($config['version'])) { if ($config['version'] === 1.0) { $curl_options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_0; } else if ($config['version'] === 1.1) { $curl_options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1; } } // Cookie if (isset($config['cookie'])) { $curl_options[CURLOPT_COOKIEJAR] = $config['cookie']; $curl_options[CURLOPT_COOKIEFILE] = $config['cookie']; } return $curl_options; } //-------------------------------------------------------------------- /** * Does the actual work of initializing cURL, setting the options, * and grabbing the output. * * @codeCoverageIgnore * * @param array $curl_options * * @return string */ protected function sendRequest(array $curl_options = []): string { $ch = curl_init(); curl_setopt_array($ch, $curl_options); // Send the request and wait for a response. $output = curl_exec($ch); if ($output === false) { throw HTTPException::forCurlError(curl_errno($ch), curl_error($ch)); } curl_close($ch); return $output; } //-------------------------------------------------------------------- } |
Commits for pgleadershipbook/trunk/system/HTTP/CURLRequest.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Thu 04 Feb, 2021 09:33:04 +0000 | PG Leadership book initial commit |