Preview: php_swoole_http.h
Size: 16.25 KB
/proc/self/root/proc/thread-self/root/opt/alt/php83/usr/include/php/ext/swoole/ext-src/php_swoole_http.h
/*
+----------------------------------------------------------------------+
| Swoole |
+----------------------------------------------------------------------+
| Copyright (c) 2012-2015 The Swoole Group |
+----------------------------------------------------------------------+
| This source file is subject to version 2.0 of the Apache license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.apache.org/licenses/LICENSE-2.0.html |
| If you did not receive a copy of the Apache2.0 license and are unable|
| to obtain it through the world-wide-web, please send a note to |
| license@swoole.com so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Author: Tianfeng Han <rango@swoole.com> |
+----------------------------------------------------------------------+
*/
#pragma once
#include "swoole_http.h"
#include "swoole_http2.h"
#include "swoole_llhttp.h"
#include "swoole_websocket.h"
#include "thirdparty/multipart_parser.h"
#include <unordered_map>
#include <unordered_set>
#ifdef SW_HAVE_ZLIB
#include <zlib.h>
#define SW_ZLIB_ENCODING_RAW -0xf
#define SW_ZLIB_ENCODING_GZIP 0x1f
#define SW_ZLIB_ENCODING_DEFLATE 0x0f
#define SW_ZLIB_ENCODING_ANY 0x2f
#if MAX_MEM_LEVEL >= 8
#define SW_ZLIB_DEF_MEM_LEVEL 8
#else
#define SW_ZLIB_DEF_MEM_LEVEL MAX_MEM_LEVEL
#endif
#endif
#ifdef SW_HAVE_BROTLI
#include <brotli/encode.h>
#include <brotli/decode.h>
#endif
#ifdef SW_HAVE_ZSTD
#include <zstd.h>
#endif
#define HTTP_API
#include <nghttp2/nghttp2.h>
enum swHttpHeaderFlag {
HTTP_HEADER_SERVER = 1u << 1,
HTTP_HEADER_CONNECTION = 1u << 2,
HTTP_HEADER_CONTENT_LENGTH = 1u << 3,
HTTP_HEADER_DATE = 1u << 4,
HTTP_HEADER_CONTENT_TYPE = 1u << 5,
HTTP_HEADER_TRANSFER_ENCODING = 1u << 6,
HTTP_HEADER_ACCEPT_ENCODING = 1u << 7,
HTTP_HEADER_CONTENT_ENCODING = 1u << 8,
};
enum swHttpCompressMethod {
HTTP_COMPRESS_NONE,
HTTP_COMPRESS_GZIP,
HTTP_COMPRESS_DEFLATE,
HTTP_COMPRESS_BR,
HTTP_COMPRESS_ZSTD,
};
enum swHttpErrorStatusCode {
HTTP_ESTATUS_CONNECT_FAILED = -1,
HTTP_ESTATUS_REQUEST_TIMEOUT = -2,
HTTP_ESTATUS_SERVER_RESET = -3,
HTTP_ESTATUS_SEND_FAILED = -4,
};
namespace swoole {
class Server;
class Coroutine;
namespace http2 {
class Stream;
class Session;
} // namespace http2
namespace http {
struct Request {
int version;
char *path;
uint32_t path_len;
const char *ext;
uint32_t ext_len;
uint8_t post_form_urlencoded;
zval zdata;
const char *body_at;
size_t body_length;
String *chunked_body;
String *h2_data_buffer;
// Notice: Do not change the order
zval *zobject;
zval _zobject;
zval *zserver;
zval _zserver;
zval *zheader;
zval _zheader;
zval *zget;
zval _zget;
zval *zpost;
zval _zpost;
zval *zcookie;
zval _zcookie;
zval *zfiles;
zval _zfiles;
zval *ztmpfiles;
zval _ztmpfiles;
};
struct Response {
enum llhttp_method method;
int version;
int status;
char *reason;
// Notice: Do not change the order
zval *zobject;
zval _zobject;
zval *zheader;
zval _zheader;
zval *zcookie;
zval _zcookie;
zval *ztrailer;
zval _ztrailer;
};
struct Context {
SessionId fd;
uchar completed : 1;
uchar end_ : 1;
uchar send_header_ : 1;
#ifdef SW_HAVE_COMPRESSION
uchar enable_compression : 1;
uchar accept_compression : 1;
uchar content_compressed : 1;
#endif
uchar send_chunked : 1;
uchar recv_chunked : 1;
uchar send_trailer_ : 1;
uchar keepalive : 1;
uchar websocket : 1;
uchar websocket_compression : 1;
uchar upgrade : 1;
uchar detached : 1;
uchar parse_cookie : 1;
uchar parse_body : 1;
uchar parse_files : 1;
uchar http2 : 1;
zval zsocket;
uint32_t stream_id;
String *write_buffer;
#ifdef SW_HAVE_COMPRESSION
int8_t compression_level;
int8_t compression_method;
uint32_t compression_min_length;
std::shared_ptr<std::unordered_set<std::string>> compression_types;
std::shared_ptr<String> zlib_buffer;
#endif
std::shared_ptr<String> continue_frame_buffer;
WebSocketSettings websocket_settings;
Request request;
Response response;
llhttp_t parser;
multipart_parser *mt_parser;
uint16_t input_var_num;
const char *current_header_name;
size_t current_header_name_len;
char *current_input_name;
size_t current_input_name_len;
char *current_form_data_name;
size_t current_form_data_name_len;
zval *current_multipart_header;
const char *tmp_content_type;
size_t tmp_content_type_len;
String *form_data_buffer;
std::string upload_tmp_dir;
// The `private_data` pointer is used to store Server or CoSocket object
void *private_data;
// The `private_data_2` pointer is used to save callback function
void *private_data_2;
bool (*send)(Context *ctx, const char *data, size_t length);
bool (*sendfile)(Context *ctx, zend_string *file, off_t offset, size_t length);
bool (*close)(Context *ctx);
bool (*onBeforeRequest)(Context *ctx);
void (*onAfterResponse)(Context *ctx);
void init(Server *server);
void init(zval *zsock);
void bind(Server *server);
void bind(zval *zsock);
void copy(const Context *ctx);
bool init_multipart_parser(const char *boundary_str, int boundary_len);
bool get_multipart_boundary(
const char *at, size_t length, size_t offset, char **out_boundary_str, int *out_boundary_len);
size_t parse(const char *data, size_t length);
bool parse_multipart_data(const char *at, size_t length) const;
HTTP_API bool set_header(const char *, size_t, zval *, bool);
HTTP_API bool set_header(const char *, size_t, const char *, size_t, bool);
HTTP_API bool set_header(const char *, size_t, const std::string &, bool);
HTTP_API void end(zend_string *sdata, zval *return_value);
HTTP_API void write(zend_string *sdata, zval *return_value);
HTTP_API bool send_file(zend_string *file, off_t offset, size_t length);
String *get_write_buffer();
String *get_http2_data_buffer() {
String *buffer = request.h2_data_buffer;
if (!buffer) {
buffer = new String(SW_HTTP2_DATA_BUFFER_SIZE);
request.h2_data_buffer = buffer;
}
return buffer;
}
size_t get_http2_data_length() {
if (request.h2_data_buffer) {
return request.h2_data_buffer->length;
} else {
return 0;
}
}
size_t get_content_length() const {
return parser.content_length;
}
bool is_co_socket() const {
return !ZVAL_IS_NULL(&zsocket);
}
Server *get_async_server() const {
return static_cast<Server *>(private_data);
}
SocketImpl *get_co_socket() const {
return static_cast<SocketImpl *>(private_data);
}
#ifdef SW_HAVE_COMPRESSION
void set_compression_method(const char *accept_encoding, size_t length);
const char *get_content_encoding() const;
bool compress(const char *data, size_t length);
#endif
bool is_available() const;
void free();
private:
void build_header(String *http_buffer, const char *body, size_t length);
ssize_t build_trailer(String *http_buffer) const;
void send_trailer(zval *return_value);
};
class Cookie {
bool encode_;
smart_str buffer_ = {};
protected:
zend_string *name = nullptr;
zend_string *value = nullptr;
zend_string *path = nullptr;
zend_string *domain = nullptr;
zend_string *sameSite = nullptr;
zend_string *priority = nullptr;
zend_long expires = 0;
zend_bool secure = false;
zend_bool httpOnly = false;
zend_bool partitioned = false;
public:
explicit Cookie(bool _encode = true) {
encode_ = _encode;
}
Cookie *withName(zend_string *);
Cookie *withExpires(zend_long);
Cookie *withSecure(zend_bool);
Cookie *withHttpOnly(zend_bool);
Cookie *withPartitioned(zend_bool);
Cookie *withValue(zend_string *);
Cookie *withPath(zend_string *);
Cookie *withDomain(zend_string *);
Cookie *withSameSite(zend_string *);
Cookie *withPriority(zend_string *);
void reset();
void toArray(zval *return_value) const;
zend_string *toString();
~Cookie();
};
} // namespace http
namespace http2 {
class Stream {
public:
http::Context *ctx;
// uint8_t priority; // useless now
uint32_t id;
// flow control
uint32_t remote_window_size;
uint32_t local_window_size;
Coroutine *waiting_coroutine = nullptr;
Stream(const Session *client, uint32_t _id);
~Stream();
bool send_header(const String *body, bool end_stream) const;
bool send_body(const String *body,
bool end_stream,
const std::shared_ptr<Session> &session,
off_t offset = 0,
size_t length = 0);
bool send_end_stream_data_frame() const;
bool send_trailer() const;
void reset(uint32_t error_code) const;
};
class Session {
public:
SessionId fd;
std::unordered_map<uint32_t, std::shared_ptr<Stream>> streams;
nghttp2_hd_inflater *inflater = nullptr;
nghttp2_hd_deflater *deflater = nullptr;
Settings local_settings = {};
Settings remote_settings = {};
// flow control
uint32_t remote_window_size;
uint32_t local_window_size;
uint32_t max_body_size;
uint32_t last_stream_id;
bool shutting_down;
bool is_coro;
http::Context *default_ctx = nullptr;
void *private_data = nullptr;
void (*handle)(const std::shared_ptr<Session> &, const std::shared_ptr<Stream> &) = nullptr;
explicit Session(SessionId _fd);
~Session();
std::shared_ptr<Stream> create_stream(uint32_t stream_id);
std::shared_ptr<Stream> get_stream(uint32_t stream_id);
bool remove_stream(uint32_t stream_id);
};
} // namespace http2
} // namespace swoole
extern zend_class_entry *swoole_http_request_ce;
extern zend_class_entry *swoole_http_response_ce;
extern zend_class_entry *swoole_http_cookie_ce;
swoole::http::Context *swoole_http_context_new(swoole::SessionId fd);
swoole::http::Cookie *php_swoole_http_get_cooke_safety(const zval *zobject);
/**
* These class properties cannot be modified by the user before assignment, such as Swoole\\Http\\Request.
* So we can use this function to init property.
*/
static sw_inline zval *swoole_http_init_and_read_property(const zend_class_entry *ce,
const zval *zobject,
zval **zproperty_store_pp,
zend_string *name,
int size = HT_MIN_SIZE) {
if (UNEXPECTED(!*zproperty_store_pp)) {
zval *zv = zend_hash_find(&ce->properties_info, name);
auto *property_info = (zend_property_info *) Z_PTR_P(zv);
zval *property = OBJ_PROP(SW_Z8_OBJ_P(zobject), property_info->offset);
array_init_size(property, size);
*zproperty_store_pp = (zval *) (zproperty_store_pp + 1);
**zproperty_store_pp = *property;
}
return *zproperty_store_pp;
}
static sw_inline zval *swoole_http_init_and_read_property(
zend_class_entry *ce, const zval *zobject, zval **zproperty_store_pp, const char *name, size_t name_len) {
if (UNEXPECTED(!*zproperty_store_pp)) {
// Notice: swoole http server properties can not be unset anymore, so we can read it without checking
zval rv, *property = zend_read_property(ce, SW_Z8_OBJ_P(zobject), name, name_len, false, &rv);
array_init(property);
*zproperty_store_pp = (zval *) (zproperty_store_pp + 1);
**zproperty_store_pp = *property;
}
return *zproperty_store_pp;
}
static sw_inline bool swoole_http_has_crlf(const char *value, size_t length) {
/* new line/NUL character safety check */
for (size_t i = 0; i < length; i++) {
/* RFC 7230 ch. 3.2.4 deprecates folding support */
if (value[i] == '\n' || value[i] == '\r') {
php_swoole_error(E_WARNING, "Header may not contain more than a single header, new line detected");
return true;
}
if (value[i] == '\0') {
php_swoole_error(E_WARNING, "Header may not contain NUL bytes");
return true;
}
}
return false;
}
void swoole_http_parse_cookie(zval *array, const char *at, size_t length);
bool swoole_http_token_list_contains_value(const char *at, size_t length, const char *value);
swoole::http::Context *php_swoole_http_request_get_context(const zval *zobject);
void php_swoole_http_request_set_context(const zval *zobject, swoole::http::Context *ctx);
swoole::http::Context *php_swoole_http_response_get_context(const zval *zobject);
void php_swoole_http_response_set_context(const zval *zobject, swoole::http::Context *ctx);
zend_string *php_swoole_http_get_date();
#ifdef SW_HAVE_ZLIB
voidpf php_zlib_alloc(voidpf opaque, uInt items, uInt size);
void php_zlib_free(voidpf opaque, voidpf address);
#endif
#ifdef SW_HAVE_BROTLI
void *php_brotli_alloc(void *opaque, size_t size);
void php_brotli_free(void *opaque, void *address);
#endif
static sw_inline nghttp2_mem *php_nghttp2_mem() {
static nghttp2_mem mem = {nullptr,
[](size_t size, void *mem_user_data) { return emalloc(size); },
[](void *ptr, void *mem_user_data) { return efree(ptr); },
[](size_t nmemb, size_t size, void *mem_user_data) { return ecalloc(nmemb, size); },
[](void *ptr, size_t size, void *mem_user_data) { return erealloc(ptr, size); }};
return &mem;
}
namespace swoole {
namespace http2 {
//-----------------------------------namespace begin--------------------------------------------
class HeaderSet {
public:
explicit HeaderSet(size_t size) : size(size), index(0) {
nvs = (nghttp2_nv *) ecalloc(size, sizeof(nghttp2_nv));
}
nghttp2_nv *get() const {
return nvs;
}
size_t len() const {
return index;
}
void reserve_one() {
index++;
}
void add(size_t index,
const char *name,
size_t name_len,
const char *value,
size_t value_len,
const uint8_t flags = NGHTTP2_NV_FLAG_NONE) const {
if (sw_likely(index < size || nvs[index].name == nullptr)) {
nghttp2_nv *nv = &nvs[index];
name = zend_str_tolower_dup(name, name_len); // auto to lower
nv->name = (uchar *) name;
nv->namelen = name_len;
nv->value = (uchar *) emalloc(value_len);
memcpy(nv->value, value, value_len);
nv->valuelen = value_len;
nv->flags = flags | NGHTTP2_NV_FLAG_NO_COPY_NAME | NGHTTP2_NV_FLAG_NO_COPY_VALUE;
swoole_trace_log(SW_TRACE_HTTP2,
"name=(%zu)[" SW_ECHO_LEN_BLUE "], value=(%zu)[" SW_ECHO_LEN_CYAN "]",
name_len,
(int) name_len,
name,
value_len,
(int) value_len,
value);
} else {
php_swoole_fatal_error(
E_WARNING, "unexpect http2 header [%.*s] (duplicated or overflow)", (int) name_len, name);
}
}
void add(const char *name,
size_t name_len,
const char *value,
size_t value_len,
const uint8_t flags = NGHTTP2_NV_FLAG_NONE) {
add(index++, name, name_len, value, value_len, flags);
}
~HeaderSet() {
for (size_t i = 0; i < size; ++i) {
if (sw_likely(nvs[i].name /* && nvs[i].value */)) {
efree((void *) nvs[i].name);
efree((void *) nvs[i].value);
}
}
efree(nvs);
}
private:
nghttp2_nv *nvs;
size_t size;
size_t index;
};
//-----------------------------------namespace end--------------------------------------------
} // namespace http2
} // namespace swoole
Directory Contents
Dirs: 0 × Files: 25