FilesExpand file tree

 master

/

php_http_parser.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

180 lines (151 loc) · 5.28 KB

 master

/

php_http_parser.h

Copy path

Top

File metadata and controls

• Code
• Blame

180 lines (151 loc) · 5.28 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

/* Copyright 2009,2010 Ryan Dahl <ry@tinyclouds.org>

*

* 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.

*/

/* modified by Moriyoshi Koizumi <moriyoshi@php.net> to make it fit to PHP source tree. */

#ifndef php_http_parser_h

#define php_http_parser_h

#ifdef __cplusplus

extern "C" {

#endif

#include <sys/types.h>

#if defined(_WIN32) && !defined(__MINGW32__)

# include <windows.h>

# include "win32/php_stdint.h"

# include "config.w32.h"

#else

# include "php_config.h"

# ifdef HAVE_STDINT_H

# include <stdint.h>

# endif

#endif

/* Compile with -DPHP_HTTP_PARSER_STRICT=0 to make less checks, but run

* faster

*/

#ifndef PHP_HTTP_PARSER_STRICT

# define PHP_HTTP_PARSER_STRICT 1

#else

# define PHP_HTTP_PARSER_STRICT 0

#endif

/* Maximium header size allowed */

#define PHP_HTTP_MAX_HEADER_SIZE (80*1024)

typedef struct php_http_parser php_http_parser;

typedef struct php_http_parser_settings php_http_parser_settings;

/* Callbacks should return non-zero to indicate an error. The parser will

* then halt execution.

*

* The one exception is on_headers_complete. In a PHP_HTTP_RESPONSE parser

* returning '1' from on_headers_complete will tell the parser that it

* should not expect a body. This is used when receiving a response to a

* HEAD request which may contain 'Content-Length' or 'Transfer-Encoding:

* chunked' headers that indicate the presence of a body.

*

* http_data_cb does not return data chunks. It will be call arbitrarally

* many times for each string. E.G. you might get 10 callbacks for "on_path"

* each providing just a few characters more data.

*/

typedef int (*php_http_data_cb) (php_http_parser*, const char *at, size_t length);

typedef int (*php_http_cb) (php_http_parser*);

/* Request Methods */

enum php_http_method

{ PHP_HTTP_DELETE = 0

, PHP_HTTP_GET

, PHP_HTTP_HEAD

, PHP_HTTP_POST

, PHP_HTTP_PUT

, PHP_HTTP_PATCH

/* pathological */

, PHP_HTTP_CONNECT

, PHP_HTTP_OPTIONS

, PHP_HTTP_TRACE

/* webdav */

, PHP_HTTP_COPY

, PHP_HTTP_LOCK

, PHP_HTTP_MKCOL

, PHP_HTTP_MOVE

, PHP_HTTP_PROPFIND

, PHP_HTTP_PROPPATCH

, PHP_HTTP_UNLOCK

/* subversion */

, PHP_HTTP_REPORT

, PHP_HTTP_MKACTIVITY

, PHP_HTTP_CHECKOUT

, PHP_HTTP_MERGE

/* upnp */

, PHP_HTTP_MSEARCH

, PHP_HTTP_NOTIFY

, PHP_HTTP_SUBSCRIBE

, PHP_HTTP_UNSUBSCRIBE

/* unknown, not implemented */

, PHP_HTTP_NOT_IMPLEMENTED

};

enum php_http_parser_type { PHP_HTTP_REQUEST, PHP_HTTP_RESPONSE, PHP_HTTP_BOTH };

struct php_http_parser {

/** PRIVATE **/

unsigned char type : 2;

unsigned char flags : 6;

unsigned char state;

unsigned char header_state;

unsigned char index;

uint32_t nread;

ssize_t content_length;

/** READ-ONLY **/

unsigned short http_major;

unsigned short http_minor;

unsigned short status_code; /* responses only */

unsigned char method; /* requests only */

/* 1 = Upgrade header was present and the parser has exited because of that.

* 0 = No upgrade header present.

* Should be checked when http_parser_execute() returns in addition to

* error checking.

*/

char upgrade;

/** PUBLIC **/

void *data; /* A pointer to get hook to the "connection" or "socket" object */

};

struct php_http_parser_settings {

php_http_cb on_message_begin;

php_http_data_cb on_path;

php_http_data_cb on_query_string;

php_http_data_cb on_url;

php_http_data_cb on_fragment;

php_http_data_cb on_header_field;

php_http_data_cb on_header_value;

php_http_cb on_headers_complete;

php_http_data_cb on_body;

php_http_cb on_message_complete;

};

void php_http_parser_init(php_http_parser *parser, enum php_http_parser_type type);

size_t php_http_parser_execute(php_http_parser *parser,

const php_http_parser_settings *settings,

const char *data,

size_t len);

/* If php_http_should_keep_alive() in the on_headers_complete or

* on_message_complete callback returns true, then this will be should be

* the last message on the connection.

* If you are the server, respond with the "Connection: close" header.

* If you are the client, close the connection.

*/

int php_http_should_keep_alive(php_http_parser *parser);

/* Returns a string version of the HTTP method. */

const char *php_http_method_str(enum php_http_method);

#ifdef __cplusplus

}

#endif

#endif