ByteStream
6 days ago
Middleware
6 days ago
Transport
6 days ago
examples
6 days ago
LICENSE.md
6 days ago
README.md
6 days ago
class-client.php
6 days ago
class-clientstate.php
6 days ago
class-connection.php
6 days ago
class-crawler.php
6 days ago
class-httpclientexception.php
6 days ago
class-httperror.php
6 days ago
class-request.php
6 days ago
class-response.php
6 days ago
composer.json
6 days ago
class-clientstate.php
209 lines
| 1 | <?php |
| 2 | |
| 3 | namespace WordPress\HttpClient; |
| 4 | |
| 5 | class ClientState { |
| 6 | |
| 7 | /** |
| 8 | * Microsecond is 1 millionth of a second. |
| 9 | * |
| 10 | * @var int |
| 11 | */ |
| 12 | const MICROSECONDS_TO_SECONDS = 1000000; |
| 13 | |
| 14 | /** |
| 15 | * 5/100th of a second |
| 16 | */ |
| 17 | const NONBLOCKING_TIMEOUT_MICROSECONDS = 0.05 * self::MICROSECONDS_TO_SECONDS; |
| 18 | |
| 19 | /** |
| 20 | * The maximum number of concurrent connections allowed. |
| 21 | * |
| 22 | * This is as a safeguard against: |
| 23 | * * Spreading our network bandwidth too thin and not making any real progress on any |
| 24 | * request. |
| 25 | * * Overwhelming the server with too many requests. |
| 26 | * |
| 27 | * @var int |
| 28 | */ |
| 29 | public $concurrency; |
| 30 | |
| 31 | /** |
| 32 | * All the HTTP requests ever enqueued with this Client. |
| 33 | * |
| 34 | * Each Request may have a different state, and this Client will manage them |
| 35 | * asynchronously, moving them through the various states as the network |
| 36 | * operations progress. |
| 37 | * |
| 38 | * @since Next Release |
| 39 | * @var Request[] |
| 40 | */ |
| 41 | public $requests = array(); |
| 42 | |
| 43 | /** |
| 44 | * Network connection details managed privately by this Client. |
| 45 | * |
| 46 | * Each Request has a corresponding Connection object that contains |
| 47 | * the connection handle, response buffer, and other details. |
| 48 | * |
| 49 | * These are internal, will change without warning, and should not be |
| 50 | * exposed to the outside world. |
| 51 | * |
| 52 | * @var array |
| 53 | */ |
| 54 | public $connections = array(); |
| 55 | public $events = array(); |
| 56 | public $event = null; |
| 57 | public $request = null; |
| 58 | public $response_body_chunk = null; |
| 59 | public $request_timeout_ms = null; |
| 60 | |
| 61 | public function __construct( $options = array() ) { |
| 62 | $this->concurrency = $options['concurrency'] ?? 10; |
| 63 | $this->request_timeout_ms = $options['timeout_ms'] ?? 30000; |
| 64 | } |
| 65 | |
| 66 | public function has_pending_event( $request, $event_type ) { |
| 67 | return $this->events[ $request->id ][ $event_type ] ?? false; |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Returns the next event found by await_next_event(). |
| 72 | * |
| 73 | * @return string|bool The next event, or false if no event is set. |
| 74 | */ |
| 75 | public function get_event() { |
| 76 | if ( null === $this->event ) { |
| 77 | return false; |
| 78 | } |
| 79 | |
| 80 | return $this->event; |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Returns the request associated with the last event found |
| 85 | * by await_next_event(). |
| 86 | * |
| 87 | * @return Request |
| 88 | */ |
| 89 | public function get_request() { |
| 90 | if ( null === $this->request ) { |
| 91 | return false; |
| 92 | } |
| 93 | |
| 94 | return $this->request; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Returns the response body chunk associated with the EVENT_BODY_CHUNK_AVAILABLE |
| 99 | * event found by await_next_event(). |
| 100 | * |
| 101 | * @return string|false |
| 102 | */ |
| 103 | public function get_response_body_chunk() { |
| 104 | if ( null === $this->response_body_chunk ) { |
| 105 | return false; |
| 106 | } |
| 107 | |
| 108 | return $this->response_body_chunk; |
| 109 | } |
| 110 | |
| 111 | public function get_active_requests( $states = null ) { |
| 112 | $processed_requests = $this->get_requests( |
| 113 | array( |
| 114 | Request::STATE_WILL_ENABLE_CRYPTO, |
| 115 | Request::STATE_WILL_SEND_HEADERS, |
| 116 | Request::STATE_WILL_SEND_BODY, |
| 117 | Request::STATE_SENT, |
| 118 | Request::STATE_RECEIVING_HEADERS, |
| 119 | Request::STATE_RECEIVING_BODY, |
| 120 | Request::STATE_RECEIVED, |
| 121 | ) |
| 122 | ); |
| 123 | $available_slots = $this->concurrency - count( $processed_requests ); |
| 124 | $enqueued_requests = $this->get_requests( Request::STATE_ENQUEUED ); |
| 125 | for ( $i = 0; $i < $available_slots; $i++ ) { |
| 126 | if ( ! isset( $enqueued_requests[ $i ] ) ) { |
| 127 | break; |
| 128 | } |
| 129 | $processed_requests[] = $enqueued_requests[ $i ]; |
| 130 | } |
| 131 | if ( null !== $states ) { |
| 132 | $processed_requests = static::filter_requests_by_state( $processed_requests, $states ); |
| 133 | } |
| 134 | |
| 135 | return $processed_requests; |
| 136 | } |
| 137 | |
| 138 | public function get_requests( $states ) { |
| 139 | if ( ! is_array( $states ) ) { |
| 140 | $states = array( $states ); |
| 141 | } |
| 142 | |
| 143 | return static::filter_requests_by_state( $this->requests, $states ); |
| 144 | } |
| 145 | |
| 146 | public static function filter_requests_by_state( array $requests, $states ) { |
| 147 | if ( ! is_array( $states ) ) { |
| 148 | $states = array( $states ); |
| 149 | } |
| 150 | $results = array(); |
| 151 | foreach ( $requests as $request ) { |
| 152 | if ( in_array( $request->state, $states, true ) ) { |
| 153 | $results[] = $request; |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | return $results; |
| 158 | } |
| 159 | |
| 160 | public function get_request_by_id( $request_id ) { |
| 161 | foreach ( $this->requests as $request ) { |
| 162 | if ( $request->id === $request_id ) { |
| 163 | return $request; |
| 164 | } |
| 165 | } |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Consumes $length bytes received in response to a given request. |
| 170 | * |
| 171 | * @return string |
| 172 | */ |
| 173 | public function consume_buffered_response_body( $request_id ) { |
| 174 | $request = $this->get_request_by_id( $request_id ); |
| 175 | if ( null === $request ) { |
| 176 | return false; |
| 177 | } |
| 178 | $connection = $this->connections[ $request->id ]; |
| 179 | if ( |
| 180 | Request::STATE_RECEIVING_BODY === $request->state || |
| 181 | Request::STATE_RECEIVED === $request->state || |
| 182 | Request::STATE_FINISHED === $request->state |
| 183 | ) { |
| 184 | return $connection->consume_buffer(); |
| 185 | } |
| 186 | |
| 187 | $end_of_data = Request::STATE_FINISHED === $request->state && ( |
| 188 | ! is_resource( $this->connections[ $request->id ]->http_socket ) || |
| 189 | $this->connections[ $request->id ]->decoded_response_stream->reached_end_of_data() |
| 190 | ); |
| 191 | if ( $end_of_data ) { |
| 192 | return false; |
| 193 | } |
| 194 | |
| 195 | return ''; |
| 196 | } |
| 197 | |
| 198 | public function set_request_error( Request $request, $error ) { |
| 199 | $request->error = $error; |
| 200 | $request->state = Request::STATE_FAILED; |
| 201 | $this->events[ $request->id ][ Client::EVENT_FAILED ] = true; |
| 202 | } |
| 203 | |
| 204 | public function set_request_finished( Request $request ) { |
| 205 | $request->state = Request::STATE_FINISHED; |
| 206 | $this->events[ $request->id ][ Client::EVENT_FINISHED ] = true; |
| 207 | } |
| 208 | } |
| 209 |