mirror of
https://gitee.com/acl-dev/acl.git
synced 2024-12-02 03:47:53 +08:00
445 lines
13 KiB
C++
445 lines
13 KiB
C++
#pragma once
|
||
#include "../acl_cpp_define.hpp"
|
||
#include <vector>
|
||
#include "../stdlib/string.hpp"
|
||
#include "../stdlib/noncopyable.hpp"
|
||
#include "../http/http_header.hpp"
|
||
#include "http_ctype.hpp"
|
||
#include "http_type.hpp"
|
||
|
||
#ifndef ACL_CLIENT_ONLY
|
||
|
||
namespace acl {
|
||
|
||
class dbuf_guard;
|
||
class istream;
|
||
class ostream;
|
||
class socket_stream;
|
||
class http_client;
|
||
class http_mime;
|
||
class json;
|
||
class xml;
|
||
class session;
|
||
class HttpSession;
|
||
class HttpCookie;
|
||
class HttpServletResponse;
|
||
|
||
/**
|
||
* 与 HTTP 客户端请求相关的类，该类不应被继承，用户也不需要
|
||
* 定义或创建该类对象
|
||
*/
|
||
class ACL_CPP_API HttpServletRequest : public noncopyable {
|
||
public:
|
||
/**
|
||
* 构造函数
|
||
* @param res {HttpServletResponse&}
|
||
* @param sess {session*} 存储会话数据的对象
|
||
* @param stream {socket_stream&} 数据流，内部不会主动关闭流
|
||
* @param charset {const char*} 本地字符集，该值非空时，
|
||
* 内部会自动将 HTTP 请求的数据转换为本地字符集，否则不转换
|
||
* @param body_limit {int} 针对 POST 方法，当数据体为文本参数
|
||
* 类型时，此参数限制数据体的长度；当数据体为数据流或 MIME
|
||
* 格式或 on 为 false，此参数无效
|
||
*/
|
||
HttpServletRequest(HttpServletResponse& res, session* sess,
|
||
socket_stream& stream, const char* charset = NULL,
|
||
int body_limit = 102400);
|
||
~HttpServletRequest();
|
||
|
||
/**
|
||
* 针对 POST 方法，该方法设置是否需要解析 Form 数据体数据，默认为解析，
|
||
* 该函数必须在 doRun 之前调用才有效；当数据体为数据流或 MIME 格式，
|
||
* 即使调用本方法设置了解析数据，也不会对数据体进行解析
|
||
* @param yes {bool} 是否需要解析
|
||
*/
|
||
void setParseBody(bool yes);
|
||
|
||
/**
|
||
* 获得 HTTP 客户端请求方法：GET, POST, PUT, CONNECT, PURGE
|
||
* @param method_s {string*} 非空时存储字符串方式的请求方法
|
||
* @return {http_method_t}
|
||
*/
|
||
http_method_t getMethod(string* method_s = NULL) const;
|
||
|
||
/**
|
||
* 将 HTTP 请求方法类型转换为可描述性字符串
|
||
* @param type {http_method_t}
|
||
* @param buf {string&} 存放结果字符串
|
||
*/
|
||
static void methodString(http_method_t type, string& buf);
|
||
|
||
/**
|
||
* 获得 HTTP 客户端请求的所有 cookie 对象集合
|
||
* @return {const std::vector<HttpCookie*>&}
|
||
*/
|
||
const std::vector<HttpCookie*>& getCookies() const;
|
||
|
||
/**
|
||
* 获得 HTTP 客户端请求的某个 cookie 值
|
||
* @param name {const char*} cookie 名称，必须非空
|
||
* @return {const char*} cookie 值，若返回 NULL 则表示该 cookie
|
||
* 不存在
|
||
*/
|
||
const char* getCookieValue(const char* name) const;
|
||
|
||
/**
|
||
* 给 HTTP 请求对象添加 cookie 对象
|
||
* @param name {const char*} cookie 名，非空字符串
|
||
* @param value {const char*} cookie 值，非空字符串
|
||
*/
|
||
void setCookie(const char* name, const char* value);
|
||
|
||
/**
|
||
* 获得 HTTP 请求头中的某个字段值
|
||
* @param name {const char*} HTTP 请求头中的字段名，非空
|
||
* @return {const char*} HTTP 请求头中的字段值，返回 NULL
|
||
* 时表示不存在
|
||
*/
|
||
const char* getHeader(const char* name) const;
|
||
|
||
/**
|
||
* 获得 HTTP GET 请求方式 URL 中的参数部分，即 ? 后面的部分
|
||
* @return {const char*} 没有进行URL 解码的请求参数部分，
|
||
* 返回空串则表示 URL 中没有参数
|
||
*/
|
||
const char* getQueryString() const;
|
||
|
||
/**
|
||
* 获得 http://test.com.cn/cgi-bin/test?name=value 中的
|
||
* /cgi-bin/test 路径部分
|
||
* @return {const char*} 返回空串表示不存在
|
||
*/
|
||
const char* getPathInfo() const;
|
||
|
||
/**
|
||
* 获得 http://test.com.cn/cgi-bin/test?name=value 中的
|
||
* /cgi-bin/test?name=value 路径部分
|
||
* @return {const char*} 返回空串表示不存在
|
||
*/
|
||
const char* getRequestUri() const;
|
||
|
||
/**
|
||
* 获得与该 HTTP 会话相关的 HttpSession 对象引用
|
||
* @param create {bool} 当 session 不存在时是否在缓存服务器自动创建；
|
||
* 当某客户端的 session 不存在且该参数为 false 时，则该函数返
|
||
* 回的 session 对象会因没有被真正创建而无法进行读写操作
|
||
* @param sid {const char*} 当 session 不存在，且 create 参数非空时，
|
||
* 如果 sid 非空，则使用此值设置用户的唯一会话，同时添加进客户端的
|
||
* cookie 中
|
||
* @return {HttpSession&}
|
||
* 注：优先级，浏览器 COOKIE > create = true > sid != NULL
|
||
*/
|
||
HttpSession& getSession(bool create = true, const char* sid = NULL);
|
||
|
||
/**
|
||
* 获得与 HTTP 客户端连接关联的输入流对象引用
|
||
* @return {istream&}
|
||
*/
|
||
istream& getInputStream() const;
|
||
|
||
/**
|
||
* 获得 HTTP 双向流对象，由构造函数的参数输入
|
||
* @return {socket_stream&}
|
||
*/
|
||
socket_stream& getSocketStream() const;
|
||
|
||
/**
|
||
* 获得 HTTP 请求数据的数据长度
|
||
* @return {acl_int64} 返回 -1 表示可能为 GET 方法，
|
||
* 或 HTTP 请求头中没有 Content-Length 字段
|
||
*/
|
||
#if defined(_WIN32) || defined(_WIN64)
|
||
__int64 getContentLength() const;
|
||
#else
|
||
long long int getContentLength() const;
|
||
#endif
|
||
|
||
/**
|
||
* 如果客户端的请求是分段数据，则该函数将获得请求头中的长度起始地址
|
||
* 及结束地址
|
||
* @param range_from {long long int&} 偏移起始位置
|
||
* @param range_to {long long int&} 偏移结束位置
|
||
* @return {bool} 若出错或非分段请求则返回false，若是分段请求则返回true
|
||
* 注：range_from/range_to 下标从 0 开始
|
||
*/
|
||
#if defined(_WIN32) || defined(_WIN64)
|
||
bool getRange(__int64& range_from, __int64& range_to);
|
||
#else
|
||
bool getRange(long long int& range_from, long long int& range_to);
|
||
#endif
|
||
/**
|
||
* 获得 HTTP 请求头中 Content-Type: text/html; charset=gb2312
|
||
* Content-Type 的字段值
|
||
* @param part {bool} 如果为 true 则返回 text，否则返回完整的
|
||
* 值，如：text/html; charset=gb2312
|
||
* @param ctype {http_ctype*} 为非空指针时，将存储完整的 http_ctype 信息
|
||
* @return {const char*} 返回 NULL 表示 Content-Type 字段不存在
|
||
*/
|
||
const char* getContentType(bool part = true, http_ctype* ctype = NULL) const;
|
||
|
||
/**
|
||
* 获得 HTTP 请求头中的 Content-Type: text/html; charset=gb2312
|
||
* 中的 charset 字段值 gb2312
|
||
* @return {const char*} 返回 NULL 表示 Content-Type 字段 或
|
||
* charset=xxx 不存在
|
||
*/
|
||
const char* getCharacterEncoding() const;
|
||
|
||
/**
|
||
* 返回本地的字段字符集
|
||
* @ return {const char*} 返回 NULL 表示没有设置本地字符集
|
||
*/
|
||
const char* getLocalCharset() const;
|
||
|
||
/**
|
||
* 返回 HTTP 连接的本地 IP 地址
|
||
* @return {const char*} 返回空，表示无法获得
|
||
*/
|
||
const char* getLocalAddr() const;
|
||
|
||
/**
|
||
* 返回 HTTP 连接的本地 PORT 号
|
||
* @return {unsigned short} 返回 0 表示无法获得
|
||
*/
|
||
unsigned short getLocalPort() const;
|
||
|
||
/**
|
||
* 返回 HTTP 连接的远程客户端 IP 地址
|
||
* @return {const char*} 返回空，表示无法获得
|
||
*/
|
||
const char* getRemoteAddr() const;
|
||
|
||
/**
|
||
* 返回 HTTP 连接的远程客户端 PORT 号
|
||
* @return {unsigned short} 返回 0 表示无法获得
|
||
*/
|
||
unsigned short getRemotePort() const;
|
||
|
||
/**
|
||
* 获得 HTTP 请求头中设置的 Host 字段
|
||
* @return {const char*} 如果为空，则表示不存在
|
||
*/
|
||
const char* getRemoteHost() const;
|
||
|
||
/**
|
||
* 获得 HTTP 请求头中设置的 User-Agent 字段
|
||
* @return {const char*} 如果为空，则表示不存在
|
||
*/
|
||
const char* getUserAgent() const;
|
||
|
||
/**
|
||
* 获得 HTTP 请求中的参数值，该值已经被 URL 解码且
|
||
* 转换成本地要求的字符集；针对 GET 方法，则是获得
|
||
* URL 中 ? 后面的参数值；针对 POST 方法，则可以获得
|
||
* URL 中 ? 后面的参数值或请求体中的参数值
|
||
* @param name {const char*} 参数名
|
||
* @param case_sensitive {bool} 比较时针对参数名是否区分大小写
|
||
* @return {const char*} 返回参数值，当参数不存在时返回 NULL
|
||
*/
|
||
const char* getParameter(const char* name,
|
||
bool case_sensitive = false) const;
|
||
|
||
/**
|
||
* 当 HTTP 请求头中的 Content-Type 为
|
||
* multipart/form-data; boundary=xxx 格式时，说明为文件上传数据类型，
|
||
* 则可以通过此函数获得 http_mime 对象
|
||
* @return {const http_mime*} 返回 NULL 则说明没有 MIME 对象，
|
||
* 返回的值用户不能手工释放，因为在 HttpServletRequest 的析
|
||
* 构中会自动释放
|
||
*/
|
||
http_mime* getHttpMime();
|
||
|
||
/**
|
||
* 数据类型为 text/json 或 application/json 格式时可调用此方法读取 json
|
||
* 数据体并进行解析，成功后返回 json 对象，该对象由内部产生并管理，当
|
||
* 本 HttpServletRequest 对象释放时该 json 对象一起被释放
|
||
* @param body_limit {size_t} 限定数据体长度以防止内存溢出，若请求数据
|
||
* 体超过此值，则返回错误；如果此值设为 0，则不限制长度
|
||
* @return {json*} 返回解析好的 json 对象，若返回 NULL 则有以下几个原因：
|
||
* 1、读数据出错
|
||
* 2、非 json 数据格式
|
||
* 3、数据体过长
|
||
*/
|
||
json* getJson(size_t body_limit = 1024000);
|
||
|
||
/**
|
||
* 该功能与上面方法类似，唯一区别是将解析结果存入用户传入的对象中
|
||
* @param out {json&}
|
||
* @param body_limit {size_t} 限定数据体长度以防止内存溢出，若请求数据
|
||
* 体超过此值，则返回错误；如果此值设为 0，则不限制长度
|
||
* @return {bool} 返回 false 原因如下：
|
||
* 1、读数据出错
|
||
* 2、非 json 数据格式
|
||
* 3、数据体过长
|
||
*/
|
||
bool getJson(json& out, size_t body_limit = 1024000);
|
||
|
||
/**
|
||
* 数据类型为 text/xml 或 application/xml 格式时可调用此方法读取 xml
|
||
* 数据体并进行解析，成功后返回 mxl 对象，该对象由内部产生并管理，当
|
||
* 本 HttpServletRequest 对象释放时该 xml 对象一起被释放
|
||
* @param body_limit {size_t} 限定数据体长度以防止内存溢出，若请求数据
|
||
* 体超过此值，则返回错误；如果此值设为 0，则不限制长度
|
||
* @return {xml*} 返回解析好的 xml 对象，若返回 NULL 则有以下几个原因：
|
||
* 1、读数据出错
|
||
* 2、非 xml 数据格式
|
||
*/
|
||
xml* getXml(size_t body_limit = 1024000);
|
||
|
||
/**
|
||
* 该功能与上面方法类似，唯一区别是将解析结果存入用户传入的对象中
|
||
* @param out {xml&}
|
||
* @param body_limit {size_t} 限定数据体长度以防止内存溢出，若请求数据
|
||
* 体超过此值，则返回错误；如果此值设为 0，则不限制长度
|
||
* @return {bool} 返回 false 原因如下：
|
||
* 1、读数据出错
|
||
* 2、非 xml 数据格式
|
||
* 3、数据体过长
|
||
*/
|
||
bool getXml(xml& out, size_t body_limit = 1024000);
|
||
|
||
/**
|
||
* 针对 POST 类方法（即有数据请求体情形），可以直接调用此方法获得请求
|
||
* 数据体的内容
|
||
* @param body_limit {size_t} 限定数据体长度以防止内存溢出，若请求数据
|
||
* 体超过此值，则返回错误；如果此值设为 0，则不限制长度
|
||
* @return {string*} 返回存放数据体的对象，返回 NULL 有以下原因：
|
||
* 1、读数据出错
|
||
* 2、没有数据体
|
||
* 3、数据体过长
|
||
*/
|
||
string* getBody(size_t body_limit = 1024000);
|
||
|
||
/**
|
||
* 该功能与上面方法类似，唯一区别是将结果存入用户传入的对象中
|
||
* @param out {string&}
|
||
* @param body_limit {size_t}
|
||
* @return {bool} 返回 false 原因如下：
|
||
* 1、读数据出错
|
||
* 2、没有数据体
|
||
* 3、数据体过长
|
||
*/
|
||
bool getBody(string& out, size_t body_limit = 1024000);
|
||
|
||
/**
|
||
* 获得 HTTP 请求数据的类型
|
||
* @return {http_request_t}，一般对 POST 方法中的上传文件应用，需要调用
|
||
* 该函数获得是否是上传数据类型，当该函数返回 HTTP_REQUEST_OTHER 时，
|
||
* 用户可以通过调用 getContentType 获得具体的类型字符串
|
||
*/
|
||
http_request_t getRequestType() const;
|
||
|
||
/**
|
||
* 获得 HTTP 请求页面的 referer URL
|
||
* @return {const char*} 为 NULL 则说明用户直接访问本 URL
|
||
*/
|
||
const char* getRequestReferer() const;
|
||
|
||
/**
|
||
* 获得根据 HTTP 请求头获得的 http_ctype 对象
|
||
* @return {const http_ctype&}
|
||
*/
|
||
const http_ctype& getHttpCtype() const;
|
||
|
||
/**
|
||
* 判断 HTTP 客户端是否要求保持长连接
|
||
* @return {bool}
|
||
*/
|
||
bool isKeepAlive() const;
|
||
|
||
/**
|
||
* 当客户端要求保持长连接时，从 HTTP 请求头中获得保持的时间
|
||
* @return {int} 返回值 < 0 表示不存在 Keep-Alive 字段
|
||
*/
|
||
int getKeepAlive() const;
|
||
|
||
/**
|
||
* 获得 HTTP 客户端请求的版本号
|
||
* @param major {unsigned&} 将存放主版本号
|
||
* @param minor {unsigned&} 将存放次版本号
|
||
* @return {bool} 是否成功取得了客户端请求的版本号
|
||
*/
|
||
bool getVersion(unsigned& major, unsigned& minor) const;
|
||
|
||
/**
|
||
* 获得 HTTP 客户端支持的数据压缩算法集合
|
||
* @param out {std::vector<string>&} 存储结果集
|
||
*/
|
||
void getAcceptEncoding(std::vector<string>& out) const;
|
||
|
||
/*
|
||
* 当 HTTP 请求为 POST 方法，通过本函数设置读 HTTP 数据体的
|
||
* IO 超时时间值(秒)
|
||
* @param rw_timeout {int} 读数据体时的超时时间(秒)
|
||
*/
|
||
void setRwTimeout(int rw_timeout);
|
||
|
||
/**
|
||
* 获得上次出错的错误号
|
||
* @return {http_request_error_t}
|
||
*/
|
||
http_request_error_t getLastError() const;
|
||
|
||
/**
|
||
* 当 HttpServlet 类以服务模式(即非 CGI 方式)运行时，可以调用此
|
||
* 方法获得客户端连接的 HTTP 类对象，从而获得更多的参数
|
||
* @return {http_client*} 当以服务模式运行时，此函数返回 HTTP 客户端
|
||
* 连接非空对象；当以 CGI 方式运行时，则返回空指针
|
||
*/
|
||
http_client* getClient() const;
|
||
|
||
/**
|
||
* 将 HTTP 请求头输出至流中（文件流或网络流）
|
||
* @param out {ostream&}
|
||
* @param prompt {const char*} 提示内容
|
||
*/
|
||
void fprint_header(ostream& out, const char* prompt);
|
||
|
||
/**
|
||
* 将 HTTP 请求头输出至给定缓冲区中
|
||
* @param out {string&}
|
||
* @param prompt {const char*} 提示内容
|
||
*/
|
||
void sprint_header(string& out, const char* prompt);
|
||
|
||
private:
|
||
dbuf_guard* dbuf_internal_;
|
||
dbuf_guard* dbuf_;
|
||
http_request_error_t req_error_;
|
||
char* cookie_name_;
|
||
HttpServletResponse& res_;
|
||
session* sess_;
|
||
HttpSession* http_session_;
|
||
socket_stream& stream_;
|
||
int body_limit_;
|
||
bool body_parsed_;
|
||
|
||
std::vector<HttpCookie*> cookies_;
|
||
bool cookies_inited_;
|
||
http_client* client_;
|
||
http_method_t method_;
|
||
bool cgi_mode_;
|
||
http_ctype content_type_;
|
||
char* localAddr_;
|
||
char* remoteAddr_;
|
||
char* localCharset_;
|
||
int rw_timeout_;
|
||
std::vector<HTTP_PARAM*> params_;
|
||
http_request_t request_type_;
|
||
bool parse_body_;
|
||
http_mime* mime_;
|
||
string* body_;
|
||
json* json_;
|
||
xml* xml_;
|
||
|
||
bool readHeaderCalled_;
|
||
bool readHeader(string* method_s);
|
||
|
||
void add_cookie(char* data);
|
||
void parseParameters(const char* str);
|
||
};
|
||
|
||
} // namespace acl
|
||
|
||
#endif // ACL_CLIENT_ONLY
|