238 lines
13 KiB
C++
238 lines
13 KiB
C++
#pragma once
|
|
#include <set>
|
|
#include <memory>
|
|
#include "Export.h"
|
|
#include <filesystem>
|
|
#include "HTTPObjects.h"
|
|
|
|
namespace Json
|
|
{
|
|
class Value;
|
|
}
|
|
|
|
namespace uns
|
|
{
|
|
class UNSWSC_DLL_EXPORT ResponseBuilder
|
|
{
|
|
private:
|
|
class Impl;
|
|
|
|
std::unique_ptr<Impl> impl;
|
|
|
|
private:
|
|
bool FileExist(std::string file);
|
|
|
|
public:
|
|
static void SetGlobalAllowFraming(bool allow);
|
|
|
|
public:
|
|
ResponseBuilder();
|
|
virtual ~ResponseBuilder();
|
|
ResponseBuilder(uns::RequestPtr req);
|
|
ResponseBuilder(const ResponseBuilder&) = delete;
|
|
ResponseBuilder& operator=(const ResponseBuilder&) = delete;
|
|
|
|
public:
|
|
uns::ResponsePtr operator()();
|
|
|
|
public: //Standard Return Code 1xx
|
|
//100 - 此临时响应表明客户端应继续请求，或者如果请求已完成，则忽略此响应。
|
|
ResponseBuilder& Continue();
|
|
//101 - 此代码是在响应客户端的 Upgrade 请求标头时发送的，用于指示服务器即将切换到的协议。
|
|
ResponseBuilder& SwitchingProtocols();
|
|
//102 - 此代码曾在 WebDAV 上下文中使用，表示服务器已收到请求，但在响应时无法提供状态。
|
|
ResponseBuilder& Processing();
|
|
//103 - 此状态码主要与 Link 标头一起使用，允许用户代理在服务器准备响应时开始预加载资源，或预连接到页面需要资源的源站。
|
|
ResponseBuilder& EarlyHints();
|
|
|
|
public: //Standard Return Code 2xx
|
|
//200 - 请求成功。
|
|
ResponseBuilder& OK();
|
|
//201 - 请求成功，并因此创建了一个新资源。
|
|
ResponseBuilder& Created();
|
|
//202 - 请求已被接收但尚未处理。
|
|
ResponseBuilder& Accepted();
|
|
//203 - 此响应代码表示返回的元数据与原始服务器上可用的不完全相同，而是从本地或第三方副本收集的。这主要用于另一个资源的镜像或备份。
|
|
ResponseBuilder& NonAuthoritativeInformation();
|
|
//204 - 对于此请求，没有内容可发送，但响应头可能有用。
|
|
ResponseBuilder& NoContent();
|
|
//205 - 告知用户代理重置发送此请求的文档。
|
|
ResponseBuilder& ResetContent();
|
|
//206 - 当客户端请求了资源的一部分时，使用此响应代码进行响应。
|
|
ResponseBuilder& PartialContent();
|
|
//207 - 在可能需要多个状态码的情况下，传递关于多个资源的信息。
|
|
ResponseBuilder& MultiStatus();
|
|
//208 - 在 <dav:propstat> 响应元素内部使用，以避免重复枚举同一集合的多个绑定的内部成员。
|
|
ResponseBuilder& AlreadyReported();
|
|
//226 - 服务器已完成了对资源的 GET 请求，并且响应是对当前实例应用了一个或多个实例操作后的结果表示。
|
|
ResponseBuilder& IMUsed();
|
|
|
|
public: //Standard Return Code 3xx
|
|
//300 - 在代理驱动（agent-driven）的内容协商中，请求有多个可能的响应，用户代理或用户应选择其中之一。
|
|
ResponseBuilder& MultipleChoices();
|
|
//301 - 请求资源的 URL 已永久更改。新 URL 在响应中给出。
|
|
ResponseBuilder& MovedPermanently(const std::string& new_url);
|
|
//302 - 此响应代码意味着请求资源的 URI 已暂时更改。未来可能还会对 URI 进行进一步更改，因此客户端在未来的请求中应使用相同的 URI。
|
|
ResponseBuilder& Found(const std::string& new_url);
|
|
//303 - 服务器发送此响应以指示客户端使用 GET 请求在另一个 URI 获取请求的资源。
|
|
ResponseBuilder& SeeOther(const std::string& new_url);
|
|
//304 - 用于缓存目的。它告知客户端响应未被修改，因此客户端可以继续使用相同的缓存响应版本。
|
|
ResponseBuilder& NotModified();
|
|
//305 - 在 HTTP 规范的前一版本中定义，表示请求的响应必须通过代理访问。由于涉及代理带内配置的安全问题，此状态码已被弃用。
|
|
ResponseBuilder& UseProxy();
|
|
//306 - 此响应代码不再使用，但被保留。它曾在 HTTP/1.1 规范的先前版本中使用。
|
|
ResponseBuilder& __Unused();
|
|
//307 - 服务器发送此响应以指示客户端使用与先前请求相同的方法在另一个 URI 获取请求的资源。其语义与 302 Found 响应代码相同，但用户代理不得更改使用的 HTTP 方法。
|
|
ResponseBuilder& TemporaryRedirect(const std::string& new_url);
|
|
//308 - 表示资源现在永久位于另一个 URI，由 Location 响应头指定。其语义与 301 Moved Permanently HTTP 响应代码相同，但用户代理不得更改使用的 HTTP 方法。
|
|
ResponseBuilder& PermanentRedirect(const std::string& new_url);
|
|
|
|
public: //Recode Code 4xx
|
|
//400 - 由于被认为是客户端错误的原因（例如，格式错误的请求语法、无效的请求消息结构或欺骗性的请求路由），服务器无法或不会处理该请求。
|
|
ResponseBuilder& BadRequest();
|
|
//401 - 尽管 HTTP 标准指定为 "unauthorized"，但从语义上讲，此响应的意思是 "unauthenticated"。即，客户端必须进行身份验证才能获得请求的响应。
|
|
ResponseBuilder& Unauthorized();
|
|
//402 - 此代码最初用于数字支付系统，但此状态码很少使用，且不存在标准约定。
|
|
ResponseBuilder& PaymentRequired();
|
|
//403 - 客户端没有访问内容的权利；也就是说，它是未授权的，因此服务器拒绝提供请求的资源。与 401 Unauthorized 不同，服务器知道客户端的身份。
|
|
ResponseBuilder& Forbidden();
|
|
//404 - 服务器找不到请求的资源。
|
|
ResponseBuilder& NotFound();
|
|
//405 - 服务器知道请求方法，但目标资源不支持该方法。
|
|
ResponseBuilder& MethodNotAllowed();
|
|
//406 - 当 Web 服务器执行服务器驱动的内容协商后，找不到任何符合用户代理给定条件的内容时，会发送此响应。
|
|
ResponseBuilder& NotAcceptable();
|
|
//407 - 类似于 401 Unauthorized，但需要通过代理进行身份验证。
|
|
ResponseBuilder& ProxyAuthenticationRequired();
|
|
//408 - 某些服务器会在空闲连接上发送此响应，即使客户端之前没有任何请求。这意味着服务器希望关闭此未使用的连接。
|
|
ResponseBuilder& RequestTimeout();
|
|
//409 - 当请求与服务器的当前状态冲突时，发送此响应。
|
|
ResponseBuilder& Conflict();
|
|
//410 - 当请求的内容已从服务器永久删除，且没有转发地址时，发送此响应。
|
|
ResponseBuilder& Gone();
|
|
//411 - 服务器拒绝了请求，因为未定义 Content-Length 标头字段，而服务器需要它。
|
|
ResponseBuilder& LengthRequired();
|
|
//412 - 在条件请求中，客户端在其标头中指明了服务器不满足的前提条件。
|
|
ResponseBuilder& PreconditionFailed();
|
|
//413 - 请求体大于服务器定义的限制。
|
|
ResponseBuilder& ContentTooLarge();
|
|
//414 - 客户端请求的 URI 长度超过了服务器愿意解释的长度。
|
|
ResponseBuilder& URITooLong();
|
|
//415 - 服务器不支持请求数据的媒体格式，因此服务器拒绝该请求。
|
|
ResponseBuilder& UnsupportedMediaType();
|
|
//416 - 无法满足请求中 Range 标头字段指定的范围。可能范围超出了目标资源数据的大小。
|
|
ResponseBuilder& RangeNotSatisfiable();
|
|
//417 - 此响应代码表示服务器无法满足 Expect 请求标头字段指示的期望。
|
|
ResponseBuilder& ExpectationFailed();
|
|
//418 - 服务器拒绝尝试用茶壶煮咖啡。
|
|
ResponseBuilder& IamATeapot();
|
|
//421 - 请求被发送到了一个无法产生响应的服务器。
|
|
ResponseBuilder& MisdirectedRequest();
|
|
//422 - 请求格式正确，但由于语义错误而无法被遵循。
|
|
ResponseBuilder& UnprocessableContent();
|
|
//423 - 正在访问的资源已被锁定。
|
|
ResponseBuilder& Locked();
|
|
//424 - 由于先前的请求失败，导致当前请求失败。
|
|
ResponseBuilder& FailedDependency();
|
|
//425 - 表示服务器不愿意冒险处理一个可能被重放的请求。
|
|
ResponseBuilder& TooEarly();
|
|
//426 - 服务器拒绝使用当前协议执行请求，但可能在客户端升级到其他协议后愿意执行。服务器在 426 响应中发送 Upgrade 标头以指示所需的协议。
|
|
ResponseBuilder& UpgradeRequired(const std::string& protocol);
|
|
//428 - 原始服务器要求请求是有条件的。此响应旨在防止"丢失更新"问题，即客户端 GET 资源状态，修改后 PUT 回服务器，而同时第三方已修改了服务器上的状态，导致冲突。
|
|
ResponseBuilder& PreconditionRequired();
|
|
//429 - 用户在给定的时间内发送了太多请求（速率限制）。
|
|
ResponseBuilder& TooManyRequests();
|
|
//431 - 服务器因请求头字段太大而不愿意处理该请求。
|
|
ResponseBuilder& RequestHeaderFieldsTooLarge();
|
|
//451 - 用户代理请求了一个无法合法提供的资源，例如被政府审查的网页。
|
|
ResponseBuilder& UnavailableForLegalReasons();
|
|
|
|
public: //Standard Return Code 5xx
|
|
//500 - 服务器遇到了不知道如何处理的情况。此错误是通用性的，表示服务器找不到更合适的 5XX 状态码来响应。
|
|
ResponseBuilder& InternalServerError();
|
|
//501 - 服务器不支持请求方法，无法处理。
|
|
ResponseBuilder& NotImplemented();
|
|
//502 - 此错误响应意味着服务器作为网关或代理时，收到了一个无效的响应。
|
|
ResponseBuilder& BadGateway();
|
|
//503 - 服务器尚未准备好处理请求。
|
|
ResponseBuilder& ServiceUnavailable();
|
|
//504 - 当服务器作为网关或代理，无法及时获得响应时，会给出此错误响应。
|
|
ResponseBuilder& GatewayTimeout();
|
|
//505 - 服务器不支持请求中使用的 HTTP 版本。
|
|
ResponseBuilder& HTTPVersionNotSupported();
|
|
//506 - 服务器存在内部配置错误：在内容协商过程中，被选中的变体被配置为自身参与内容协商，这导致在创建响应时出现循环引用。
|
|
ResponseBuilder& VariantAlsoNegotiates();
|
|
//507 - 由于服务器无法存储成功完成请求所需的表示，因此无法对资源执行该方法。
|
|
ResponseBuilder& InsufficientStorage();
|
|
//508 - 服务器在处理请求时检测到无限循环。
|
|
ResponseBuilder& LoopDetected();
|
|
//510 - 客户端请求声明了一个应使用 HTTP 扩展（RFC 2774）来处理请求，但该扩展不受支持。
|
|
ResponseBuilder& NotExtended();
|
|
//511 - 表示客户端需要进行身份验证才能获得网络访问权限。
|
|
ResponseBuilder& NetworkAuthenticationRequired();
|
|
|
|
public: //Non-Standard Return Code 4xx
|
|
//489 - 请求载体的格式错误，如：无法解析的JSON等。
|
|
ResponseBuilder& RequestFormatError();
|
|
//490 - 请求无效。可能是由于未正确携带数据等必要信息。
|
|
ResponseBuilder& RequestInvalid();
|
|
//492 - 请求URL超范围。此响应表示请求的URL是错误的。
|
|
ResponseBuilder& URLOutOfRange();
|
|
//493 - 无效的请求主机。指示请求时使用了错误的域名/IP。
|
|
ResponseBuilder& InvalidRequestHost();
|
|
//494 - IP地址被封禁。
|
|
ResponseBuilder& IPBlocked();
|
|
//495 -非法上传请求。指示本次上传请求不符合服务器规定。
|
|
ResponseBuilder& IllegalUpload();
|
|
//496 - 文件格式错误。指示上传的文件格式不符合服务器规定。
|
|
ResponseBuilder& FileFormatError();
|
|
//497 - 无效文件。处理请求所需的文件已过期/无法访问。
|
|
ResponseBuilder& InvalidFile();
|
|
//498 - 上传的文件过大。非文件上传时应使用 413 Content Too Large。
|
|
ResponseBuilder& FileTooLarge();
|
|
//499 - 每秒请求数过多。仅在一些特殊API中使用，常规情况需使用 429 Too Many Requests。
|
|
ResponseBuilder& RPSLimited();
|
|
|
|
public: //Non-Standard Code 5xx
|
|
//533 - 子过程失败。服务器在处理请求的某个步骤中遇到无法恢复的错误。
|
|
ResponseBuilder& SubProcessFalied();
|
|
//540 - 服务器检测到漏洞利用/可执行文件上传等网络攻击行为。
|
|
ResponseBuilder& ServerHateYou();
|
|
//550 - 检测到拒绝服务漏洞攻击。
|
|
ResponseBuilder& DoSFound();
|
|
//551 - 检测到分布式拒绝服务漏洞攻击。
|
|
ResponseBuilder& DDoSFound();
|
|
//560 - 未知的服务器错误。当服务器无法定位错误来源时返回。否则应使用 500 Internal Server Error。
|
|
ResponseBuilder& UnknownServerError();
|
|
|
|
public: //Header Functions
|
|
ResponseBuilder& Utf8();
|
|
ResponseBuilder& Json();
|
|
ResponseBuilder& Date();
|
|
ResponseBuilder& GZip();
|
|
ResponseBuilder& DenyFraming();
|
|
ResponseBuilder& AllowFraming();
|
|
ResponseBuilder& Code(int code);
|
|
ResponseBuilder& Charset(std::string_view charset);
|
|
ResponseBuilder& SetCookie(std::string_view cookie);
|
|
ResponseBuilder& MediaType(std::string_view media_type);
|
|
ResponseBuilder& Header(std::string_view key, std::string_view value);
|
|
|
|
public: //Body Functions
|
|
ResponseBuilder& EmptyBody();
|
|
ResponseBuilder& Body(int data);
|
|
ResponseBuilder& Body(std::string&& data);
|
|
ResponseBuilder& Body(const Json::Value& data);
|
|
ResponseBuilder& Body(const std::string& data);
|
|
ResponseBuilder& ErrorPage();
|
|
ResponseBuilder& ErrorPage(std::string_view error_page);
|
|
ResponseBuilder& File(const std::filesystem::path& path, bool infer_media_type = true, std::size_t chunk_size = 1024);
|
|
ResponseBuilder& FileForDownload(const std::filesystem::path& path, bool infer_media_type = true, std::size_t chunk_size = 1024);
|
|
|
|
public: //CORS Functions
|
|
//Perform CORS Check and Return CORS Headers, Must be the last function called
|
|
ResponseBuilder& AutoCORS(uns::RequestPtr req);
|
|
ResponseBuilder& CORS(const std::string& origin);
|
|
ResponseBuilder& CORS_Full(const std::string& origin, const std::set<std::string>& headers);
|
|
};
|
|
}; |