aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/curl/lib/http_chunks.h
blob: 08dce5c1ad1907d52d5455f75939b5fd0d8ea8a4 (plain) (blame)
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
#ifndef HEADER_CURL_HTTP_CHUNKS_H 
#define HEADER_CURL_HTTP_CHUNKS_H 
/*************************************************************************** 
 *                                  _   _ ____  _ 
 *  Project                     ___| | | |  _ \| | 
 *                             / __| | | | |_) | | 
 *                            | (__| |_| |  _ <| |___ 
 *                             \___|\___/|_| \_\_____| 
 * 
 * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
 * 
 * This software is licensed as described in the file COPYING, which 
 * you should have received as part of this distribution. The terms 
 * are also available at https://curl.se/docs/copyright.html.
 * 
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 
 * copies of the Software, and permit persons to whom the Software is 
 * furnished to do so, under the terms of the COPYING file. 
 * 
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 
 * KIND, either express or implied. 
 * 
 ***************************************************************************/ 

struct connectdata;

/* 
 * The longest possible hexadecimal number we support in a chunked transfer. 
 * Weird enough, RFC2616 doesn't set a maximum size! Since we use strtoul() 
 * to convert it, we "only" support 2^32 bytes chunk data. 
 */ 
#define MAXNUM_SIZE 16 
 
typedef enum { 
  /* await and buffer all hexadecimal digits until we get one that isn't a
     hexadecimal digit. When done, we go CHUNK_LF */
  CHUNK_HEX, 
 
  /* wait for LF, ignore all else */
  CHUNK_LF,
 
  /* We eat the amount of data specified. When done, we move on to the 
     POST_CR state. */ 
  CHUNK_DATA, 
 
  /* POSTLF should get a CR and then a LF and nothing else, then move back to
     HEX as the CRLF combination marks the end of a chunk. A missing CR is no
     big deal. */
  CHUNK_POSTLF, 
 
  /* Used to mark that we're out of the game.  NOTE: that there's a 'dataleft'
     field in the struct that will tell how many bytes that were not passed to
     the client in the end of the last buffer! */
  CHUNK_STOP, 
 
  /* At this point optional trailer headers can be found, unless the next line 
     is CRLF */ 
  CHUNK_TRAILER, 
 
  /* A trailer CR has been found - next state is CHUNK_TRAILER_POSTCR. 
     Next char must be a LF */ 
  CHUNK_TRAILER_CR, 
 
  /* A trailer LF must be found now, otherwise CHUNKE_BAD_CHUNK will be 
     signalled If this is an empty trailer CHUNKE_STOP will be signalled. 
     Otherwise the trailer will be broadcasted via Curl_client_write() and the 
     next state will be CHUNK_TRAILER */ 
  CHUNK_TRAILER_POSTCR
} ChunkyState; 
 
typedef enum { 
  CHUNKE_STOP = -1, 
  CHUNKE_OK = 0, 
  CHUNKE_TOO_LONG_HEX = 1, 
  CHUNKE_ILLEGAL_HEX, 
  CHUNKE_BAD_CHUNK, 
  CHUNKE_BAD_ENCODING, 
  CHUNKE_OUT_OF_MEMORY, 
  CHUNKE_PASSTHRU_ERROR, /* Curl_httpchunk_read() returns a CURLcode to use */
  CHUNKE_LAST 
} CHUNKcode; 
 
const char *Curl_chunked_strerror(CHUNKcode code);

struct Curl_chunker { 
  char hexbuffer[ MAXNUM_SIZE + 1]; 
  int hexindex; 
  ChunkyState state; 
  curl_off_t datasize;
  size_t dataleft; /* untouched data amount at the end of the last buffer */ 
}; 
 
/* The following functions are defined in http_chunks.c */
void Curl_httpchunk_init(struct connectdata *conn);
CHUNKcode Curl_httpchunk_read(struct connectdata *conn, char *datap,
                              ssize_t length, ssize_t *wrote,
                              CURLcode *passthru);

#endif /* HEADER_CURL_HTTP_CHUNKS_H */