request.h (9417B)
1 #ifndef HEADER_CURL_REQUEST_H 2 #define HEADER_CURL_REQUEST_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 11 * 12 * This software is licensed as described in the file COPYING, which 13 * you should have received as part of this distribution. The terms 14 * are also available at https://curl.se/docs/copyright.html. 15 * 16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 17 * copies of the Software, and permit persons to whom the Software is 18 * furnished to do so, under the terms of the COPYING file. 19 * 20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21 * KIND, either express or implied. 22 * 23 * SPDX-License-Identifier: curl 24 * 25 ***************************************************************************/ 26 27 /* This file is for lib internal stuff */ 28 29 #include "curl_setup.h" 30 31 #include "bufq.h" 32 33 /* forward declarations */ 34 struct UserDefined; 35 36 enum expect100 { 37 EXP100_SEND_DATA, /* enough waiting, just send the body now */ 38 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */ 39 EXP100_SENDING_REQUEST, /* still sending the request but will wait for 40 the 100 header once done with the request */ 41 EXP100_FAILED /* used on 417 Expectation Failed */ 42 }; 43 44 enum upgrade101 { 45 UPGR101_INIT, /* default state */ 46 UPGR101_WS, /* upgrade to WebSockets requested */ 47 UPGR101_H2, /* upgrade to HTTP/2 requested */ 48 UPGR101_RECEIVED, /* 101 response received */ 49 UPGR101_WORKING /* talking upgraded protocol */ 50 }; 51 52 53 /* 54 * Request specific data in the easy handle (Curl_easy). Previously, 55 * these members were on the connectdata struct but since a conn struct may 56 * now be shared between different Curl_easys, we store connection-specific 57 * data here. This struct only keeps stuff that is interesting for *this* 58 * request, as it will be cleared between multiple ones 59 */ 60 struct SingleRequest { 61 curl_off_t size; /* -1 if unknown at this point */ 62 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch, 63 -1 means unlimited */ 64 curl_off_t bytecount; /* total number of bytes read */ 65 curl_off_t writebytecount; /* number of bytes written */ 66 67 struct curltime start; /* transfer started at this time */ 68 unsigned int headerbytecount; /* received server headers (not CONNECT 69 headers) */ 70 unsigned int allheadercount; /* all received headers (server + CONNECT) */ 71 unsigned int deductheadercount; /* this amount of bytes does not count when 72 we check if anything has been transferred 73 at the end of a connection. We use this 74 counter to make only a 100 reply (without 75 a following second response code) result 76 in a CURLE_GOT_NOTHING error code */ 77 int headerline; /* counts header lines to better track the 78 first one */ 79 curl_off_t offset; /* possible resume offset read from the 80 Content-Range: header */ 81 int httpcode; /* error code from the 'HTTP/1.? XXX' or 82 'RTSP/1.? XXX' line */ 83 int keepon; 84 unsigned char httpversion_sent; /* Version in request (09, 10, 11, etc.) */ 85 unsigned char httpversion; /* Version in response (09, 10, 11, etc.) */ 86 enum upgrade101 upgr101; /* 101 upgrade state */ 87 88 /* Client Writer stack, handles transfer- and content-encodings, protocol 89 * checks, pausing by client callbacks. */ 90 struct Curl_cwriter *writer_stack; 91 /* Client Reader stack, handles transfer- and content-encodings, protocol 92 * checks, pausing by client callbacks. */ 93 struct Curl_creader *reader_stack; 94 struct bufq sendbuf; /* data which needs to be send to the server */ 95 size_t sendbuf_hds_len; /* amount of header bytes in sendbuf */ 96 time_t timeofdoc; 97 char *location; /* This points to an allocated version of the Location: 98 header data */ 99 char *newurl; /* Set to the new URL to use when a redirect or a retry is 100 wanted */ 101 102 #ifndef CURL_DISABLE_COOKIES 103 unsigned char setcookies; 104 #endif 105 BIT(header); /* incoming data has HTTP header */ 106 BIT(done); /* request is done, e.g. no more send/recv should 107 * happen. This can be TRUE before `upload_done` or 108 * `download_done` is TRUE. */ 109 BIT(content_range); /* set TRUE if Content-Range: was found */ 110 BIT(download_done); /* set to TRUE when download is complete */ 111 BIT(eos_written); /* iff EOS has been written to client */ 112 BIT(eos_read); /* iff EOS has been read from the client */ 113 BIT(eos_sent); /* iff EOS has been sent to the server */ 114 BIT(rewind_read); /* iff reader needs rewind at next start */ 115 BIT(upload_done); /* set to TRUE when all request data has been sent */ 116 BIT(upload_aborted); /* set to TRUE when upload was aborted. Will also 117 * show `upload_done` as TRUE. */ 118 BIT(ignorebody); /* we read a response-body but we ignore it! */ 119 BIT(http_bodyless); /* HTTP response status code is between 100 and 199, 120 204 or 304 */ 121 BIT(chunk); /* if set, this is a chunked transfer-encoding */ 122 BIT(resp_trailer); /* response carried 'Trailer:' header field */ 123 BIT(ignore_cl); /* ignore content-length */ 124 BIT(upload_chunky); /* set TRUE if we are doing chunked transfer-encoding 125 on upload */ 126 BIT(getheader); /* TRUE if header parsing is wanted */ 127 BIT(no_body); /* the response has no body */ 128 BIT(authneg); /* TRUE when the auth phase has started, which means 129 that we are creating a request with an auth header, 130 but it is not the final request in the auth 131 negotiation. */ 132 BIT(sendbuf_init); /* sendbuf is initialized */ 133 BIT(shutdown); /* request end will shutdown connection */ 134 BIT(shutdown_err_ignore); /* errors in shutdown will not fail request */ 135 }; 136 137 /** 138 * Initialize the state of the request for first use. 139 */ 140 void Curl_req_init(struct SingleRequest *req); 141 142 /** 143 * The request is about to start. Record time and do a soft reset. 144 */ 145 CURLcode Curl_req_start(struct SingleRequest *req, 146 struct Curl_easy *data); 147 148 /** 149 * The request may continue with a follow up. Reset 150 * members, but keep start time for overall duration calc. 151 */ 152 CURLcode Curl_req_soft_reset(struct SingleRequest *req, 153 struct Curl_easy *data); 154 155 /** 156 * The request is done. If not aborted, make sure that buffers are 157 * flushed to the client. 158 * @param req the request 159 * @param data the transfer 160 * @param aborted TRUE iff the request was aborted/errored 161 */ 162 CURLcode Curl_req_done(struct SingleRequest *req, 163 struct Curl_easy *data, bool aborted); 164 165 /** 166 * Free the state of the request, not usable afterwards. 167 */ 168 void Curl_req_free(struct SingleRequest *req, struct Curl_easy *data); 169 170 /** 171 * Hard reset the state of the request to virgin state base on 172 * transfer settings. 173 */ 174 void Curl_req_hard_reset(struct SingleRequest *req, struct Curl_easy *data); 175 176 /** 177 * Send request headers. If not all could be sent 178 * they will be buffered. Use `Curl_req_flush()` to make sure 179 * bytes are really send. 180 * @param data the transfer making the request 181 * @param buf the complete header bytes, no body 182 * @param httpversion version used in request (09, 10, 11, etc.) 183 * @return CURLE_OK (on blocking with *pnwritten == 0) or error. 184 */ 185 CURLcode Curl_req_send(struct Curl_easy *data, struct dynbuf *buf, 186 unsigned char httpversion); 187 188 /** 189 * TRUE iff the request has sent all request headers and data. 190 */ 191 bool Curl_req_done_sending(struct Curl_easy *data); 192 193 /* 194 * Read more from client and flush all buffered request bytes. 195 * @return CURLE_OK on success or the error on the sending. 196 * Never returns CURLE_AGAIN. 197 */ 198 CURLcode Curl_req_send_more(struct Curl_easy *data); 199 200 /** 201 * TRUE iff the request wants to send, e.g. has buffered bytes. 202 */ 203 bool Curl_req_want_send(struct Curl_easy *data); 204 205 /** 206 * TRUE iff the request has no buffered bytes yet to send. 207 */ 208 bool Curl_req_sendbuf_empty(struct Curl_easy *data); 209 210 /** 211 * Stop sending any more request data to the server. 212 * Will clear the send buffer and mark request sending as done. 213 */ 214 CURLcode Curl_req_abort_sending(struct Curl_easy *data); 215 216 /** 217 * Stop sending and receiving any more request data. 218 * Will abort sending if not done. 219 */ 220 CURLcode Curl_req_stop_send_recv(struct Curl_easy *data); 221 222 /** 223 * Invoked when all request data has been uploaded. 224 */ 225 CURLcode Curl_req_set_upload_done(struct Curl_easy *data); 226 227 #endif /* HEADER_CURL_REQUEST_H */