HttpClient.php
9 months ago
HttpClientCache.php
5 years ago
HttpClientInterface.php
9 months ago
OembedClient.php
9 months ago
HttpClient.php
151 lines
| 1 | <?php |
| 2 | /** |
| 3 | * HttpClient.php |
| 4 | * |
| 5 | * @package Embera |
| 6 | * @author Michael Pratt <yo@michael-pratt.com> |
| 7 | * @link http://www.michael-pratt.com/ |
| 8 | * |
| 9 | * For the full copyright and license information, please view the LICENSE |
| 10 | * file that was distributed with this source code. |
| 11 | */ |
| 12 | |
| 13 | namespace Embera\Http; |
| 14 | |
| 15 | use Exception; |
| 16 | use InvalidArgumentException; |
| 17 | |
| 18 | /** |
| 19 | * This class is in charge of doing http requests. Its a very minimal |
| 20 | * wrapper for curl or file_get_contents |
| 21 | */ |
| 22 | class HttpClient implements HttpClientInterface |
| 23 | { |
| 24 | /** @var array Array with custom curl/fopen options */ |
| 25 | protected $config = []; |
| 26 | |
| 27 | /** |
| 28 | * Alias for the setConfig method |
| 29 | * @param array $config |
| 30 | */ |
| 31 | public function __construct(array $config = []) |
| 32 | { |
| 33 | $this->setConfig($config); |
| 34 | } |
| 35 | |
| 36 | /** inline {@inheritdoc} */ |
| 37 | public function setConfig(array $config = []) |
| 38 | { |
| 39 | $this->config = array_merge([ |
| 40 | 'use_curl' => true, |
| 41 | 'user_agent' => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36', |
| 42 | 'referer' => '', |
| 43 | 'curl_params' => [], |
| 44 | 'file_get_contents_params' => [] |
| 45 | ], $config); |
| 46 | } |
| 47 | |
| 48 | /** inline {@inheritdoc} */ |
| 49 | public function fetch($url, array $params = []) |
| 50 | { |
| 51 | if (!filter_var($url, \FILTER_VALIDATE_URL)) { |
| 52 | throw new InvalidArgumentException(sprintf('Invalid url %s', $url)); |
| 53 | } |
| 54 | |
| 55 | if (function_exists('curl_init') && $this->config['use_curl']) { |
| 56 | return $this->fetchWithCurl($url, $this->config['curl_params']); |
| 57 | } |
| 58 | |
| 59 | return $this->fetchWithFileGetContents($url, $this->config['file_get_contents_params']); |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Uses Curl to fetch data from an url |
| 64 | * |
| 65 | * @param string $url |
| 66 | * @param array $params Additional parameters for the respective part |
| 67 | * @return string |
| 68 | * |
| 69 | * @throws Exception when the returned status code is not 200 or no data was found |
| 70 | */ |
| 71 | protected function fetchWithCurl($url, array $params = []) |
| 72 | { |
| 73 | // Not using array_merge here because that function reindexes numeric keys |
| 74 | $options = $params + array( |
| 75 | CURLOPT_USERAGENT => $this->config['user_agent'], |
| 76 | CURLOPT_ENCODING => '', |
| 77 | CURLOPT_FOLLOWLOCATION => true, |
| 78 | CURLOPT_SSL_VERIFYHOST => 0, |
| 79 | CURLOPT_SSL_VERIFYPEER => 0, |
| 80 | CURLINFO_HEADER_OUT => true, |
| 81 | ); |
| 82 | |
| 83 | if (!empty($this->config['referer'])) { |
| 84 | $options[CURLOPT_REFERER] = $this->config['referer']; |
| 85 | } |
| 86 | |
| 87 | $options[CURLOPT_URL] = $url; |
| 88 | $options[CURLOPT_HEADER] = true; |
| 89 | $options[CURLOPT_RETURNTRANSFER] = 1; |
| 90 | |
| 91 | $handler = curl_init(); |
| 92 | curl_setopt_array($handler, $options); |
| 93 | |
| 94 | $response = curl_exec($handler); |
| 95 | |
| 96 | $status = curl_getinfo($handler, CURLINFO_HTTP_CODE); |
| 97 | $headerSize = curl_getinfo($handler, CURLINFO_HEADER_SIZE); |
| 98 | //$headerOut = curl_getinfo($handler, CURLINFO_HEADER_OUT); |
| 99 | |
| 100 | $body = substr($response, $headerSize); |
| 101 | curl_close($handler); |
| 102 | |
| 103 | if (empty($body) || $status != '200') { |
| 104 | throw new Exception($status . ': Invalid response for ' . $url); |
| 105 | } |
| 106 | |
| 107 | return $body; |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * Uses file_get_contents to fetch data from an url |
| 112 | * |
| 113 | * @param string $url |
| 114 | * @param array $params Additional parameters for the respective part |
| 115 | * @return string |
| 116 | * |
| 117 | * @throws Exception when allow_url_fopen is disabled or when no data was returned |
| 118 | */ |
| 119 | protected function fetchWithFileGetContents($url, array $params = []) |
| 120 | { |
| 121 | if (!ini_get('allow_url_fopen')) { |
| 122 | throw new Exception('Could not execute http request - allow_url_fopen is disabled.'); |
| 123 | } |
| 124 | |
| 125 | $params = array_merge([ |
| 126 | 'method' => 'GET', |
| 127 | 'user_agent' => $this->config['user_agent'], |
| 128 | 'follow_location' => 1, |
| 129 | 'max_redirects' => 20, |
| 130 | 'timeout' => 40 |
| 131 | ], $params); |
| 132 | |
| 133 | if (!empty($this->config['referer'])) { |
| 134 | $referer = 'Referer: ' . $this->config['referer'] . "\r\n"; |
| 135 | if (!empty($params['header'])) { |
| 136 | $params['header'] = [ $referer ]; |
| 137 | } else { |
| 138 | $params['header'][] = $referer; |
| 139 | } |
| 140 | } |
| 141 | |
| 142 | $context = array('http' => $params); |
| 143 | if ($data = file_get_contents($url, false, stream_context_create($context))) { |
| 144 | return $data; |
| 145 | } |
| 146 | |
| 147 | throw new Exception('Invalid Server Response from ' . $url); |
| 148 | } |
| 149 | |
| 150 | } |
| 151 |