HTTPClient.hpp

# pragma once
# define SIV3D_CONCURRENT
# include <Siv3D.hpp>

# if SIV3D_BUILD_TYPE(DEBUG)
#	pragma comment (lib, "libcurl-d")
# else 
#	pragma comment (lib, "libcurl")
# endif
# pragma comment (lib, "crypt32")

namespace s3d
{
	using URL = String;
	using URLView = StringView;
	using HTTPHeader = HashTable<String, String>;

	class HTTPResponse;
	struct HTTPProgress;
	class AsyncHTTPTask;

	/// <summary>
	/// ダウンロードの進行状況
	/// </summary>
	enum class HTTPAsyncStatus
	{
		/// <summary>
		/// ダウンロードするものが無い
		/// </summary>
		None,

		/// <summary>
		/// ダウンロード中
		/// </summary>
		Working,

		/// <summary>
		/// ダウンロード失敗
		/// </summary>
		Failed,

		/// <summary>
		/// ダウンロードがキャンセルされた
		/// </summary>
		Canceled,

		/// <summary>
		/// ダウンロード完了
		/// </summary>
		Succeeded,
	};

	/// <summary>
	/// https://tools.ietf.org/html/rfc7231#section-6
	/// </summary>
	enum class HTTPResponseStatusCode : uint32
	{
		Invalid = 0,

		// Informational 1xx
		Continue = 100,
		SwitchingProtocols = 101,

		// Successful 2xx
		OK = 200,
		Created = 201,
		Accepted = 202,
		NonAuthoritativeInformation = 203,
		NoContent = 204,
		ResetContent = 205,
		PartialContent = 206,

		// Redirection 3xx
		MultipleChoices = 300,
		movedPermanently = 301,
		Found = 302,
		SeeOther = 303,
		NotModified = 304,
		UseProxy = 305,
		TemporaryRedirect = 307,

		// Client Error 4xx
		BadRequest = 400,
		Unauthorized = 401,
		PaymentRequied = 402,
		Forbidden = 403,
		NotFound = 404,
		MethodNotAllowed = 405,
		NotAcceptable = 406,
		ProxyAuthenticationRequied = 407,
		RequestTimeout = 408,
		Conflict = 409,
		Gone = 410,
		LengthRequied = 411,
		Preconditionfailed = 412,
		PayloadTooLarge = 413,
		URITooLong = 414,
		UnsupportedMediaType = 415,
		RangeNotSatisfiable = 416,
		ExpectationFailed = 417,
		UpgradeRequied = 426,

		// Server Error 5xx
		InternalServerError = 500,
		NotImplemented = 501,
		BadGateway = 502,
		ServiceUnavailable = 503,
		GatewayTimeout = 504,
		HTTPVersionNotSupported = 505

	};

	enum class HTTPResponseStatusType : uint32 {
		Invalid = 0,
		Informational = 1,
		Successful = 2,
		Redirection = 3,
		ClientError = 4,
		ServerError = 5
	};

	namespace SimpleHTTP
	{
		/// <summary>
		/// HTTPClient を使うアプリケーションで、最初に 1 回だけ呼び出します。([Siv3D ToDo]: エンジン内に組み込み)
		/// </summary>
		bool InitCURL();

		/// <summary>
		/// HTTPClient を使うアプリケーションで、最後に 1 回だけ呼び出します。([Siv3D ToDo]: エンジン内に組み込み)
		/// </summary>
		void CleanupCURL();

		/// <summary>
		/// ファイルをダウンロードします。
		/// </summary>
		/// <param name="url">
		/// URL
		/// </param>
		/// <param name="saveFilePath">
		/// 取得したファイルの保存先のファイルパス
		/// </param>
		HTTPResponse DownloadFile(URLView url, FilePathView saveFilePath, bool autoFollowLocation = true);

		[[nodiscard]] AsyncHTTPTask DownloadFileAsync(URLView url, FilePathView saveFilePath, bool autoFollowLocation = true);

		/// <summary>
		/// HTTP-GETリクエストを送ります
		/// </summary>
		/// <param name="url">
		/// URL
		/// </param>
		/// <param name="header">
		/// ヘッダ
		/// </param>
		/// <param name="saveFilePath">
		/// 取得したファイルの保存先のファイルパス
		/// </param>
		HTTPResponse Get(const URLView url, const HTTPHeader& header, const FilePathView saveFilePath, bool autoFollowLocation = true);

		/// <summary>
		/// HTTP-POSTリクエストを送ります
		/// </summary>
		/// <param name="url">
		/// URL
		/// </param>
		/// <param name="header">
		/// ヘッダ
		/// </param>
		/// <param name="src">
		/// 送信するデータの先頭ポインタ
		/// </param>
		/// <param name="size">
		/// 送信するデータのサイズ（バイト）
		/// </param>
		/// <param name="saveFilePath">
		/// 取得したファイルの保存先のファイルパス
		/// </param>
		HTTPResponse Post(URLView url, const HTTPHeader& header, const void* src, size_t size, FilePathView saveFilePath, bool autoFollowLocation = true);
	
		inline bool IsStatusCodeTypeOf(HTTPResponseStatusCode code, HTTPResponseStatusType type) {
			return static_cast<uint32>(code) / 100 == static_cast<uint32>(type);
		}
	};

	class HTTPResponse
	{
	private:

		String m_header;

		HTTPResponseStatusCode m_statusCode = HTTPResponseStatusCode::Invalid;

	public:

		HTTPResponse() = default;

		explicit HTTPResponse(const String& header);

		/// <summary>
		/// レスポンスヘッダーのステータスコードが有効であるかを返します。
		/// </summary>
		[[nodiscard]] bool isValid() const;

		/// <summary>
		/// isVaild()
		/// </summary>
		[[nodiscard]] explicit operator bool() const;

		/// <summary>
		/// レスポンスヘッダーを返します。
		/// </summary>
		[[nodiscard]] const String& getHeader() const;

		/// <summary>
		/// ステータスコードを返します。
		/// </summary>
		[[nodiscard]] HTTPResponseStatusCode getStatusCode() const;
	};

	struct HTTPProgress
	{
		HTTPProgress() = default;

		explicit HTTPProgress(URLView url);

		/// <summary>
		/// ダウンロードするファイルの合計サイズ。不明の場合 none
		/// </summary>
		Optional<int64> downloadTotalSize;

		/// <summary>
		/// アップロードするファイルの合計サイズ。不明の場合 none
		/// </summary>
		Optional<int64> uploadTotalSize;

		/// <summary>
		/// ダウンロードしたファイルのサイズ。
		/// </summary>
		int64 downloadNowSize = 0;

		/// <summary>
		/// アップロードしたファイルのサイズ。
		/// </summary>
		int64 uploadNowSize = 0;

		/// <summary>
		/// ダウンロードの進行状況の割合。不明の場合 none
		/// </summary>
		[[nodiscard]] Optional<double> getDownloadProgress() const;

		/// <summary>
		/// アップロードの進行状況の割合。不明の場合 none
		/// </summary>
		[[nodiscard]] Optional<double> getUploadProgress() const;

		/// <summary>
		/// 通信先のURL
		/// </summary>
		URL url;

		HTTPAsyncStatus status = HTTPAsyncStatus::None;

		/// <summary>
		/// 通信中にtrueにすると通信をキャンセルします
		/// </summary>
		bool cancelCommunication = false;
	};

	class AsyncHTTPTask
	{
	private:

		friend AsyncHTTPTask SimpleHTTP::DownloadFileAsync(URLView url, FilePathView saveFilePath, bool autoFollowLocation);

		class AsyncHTTPTaskImpl;

		std::shared_ptr<AsyncHTTPTaskImpl> pImpl;

		explicit AsyncHTTPTask(URLView url, FilePathView path, bool autoFollowLocation = true);

	public:

		AsyncHTTPTask();

		~AsyncHTTPTask();

		/// <summary>
		/// 通信の進行状況クラスを返します
		/// </summary>
		[[nodiscard]] const HTTPProgress& getProgress() const;

		/// <summary>
		/// Tips: isDoneを実行しないと無効なレスポンスしか返ってきません
		/// </summary>
		[[nodiscard]] const HTTPResponse& getResponse() const;

		/// <summary>
		/// 現在のステータスを返します
		/// </summary>
		[[nodiscard]] const HTTPAsyncStatus& currentStatus() const;

		/// <summary>
		/// 実行中の通信をキャンセルします
		/// </summary>
		void cancelTask();

		/// <summary>
		/// 通信が完了したかを返します
		/// 1回の通信で1度しかtrueを返しません
		/// </summary>
		[[nodiscard]] bool isDone();
	};

}

//////////////////////////////////////////////////
//
//	Format
//
//////////////////////////////////////////////////

namespace s3d 
{
	void Formatter(FormatData& formatData, const HTTPResponseStatusCode& value);

	template <class CharType>
	inline std::basic_ostream<CharType>& operator <<(std::basic_ostream<CharType>& output, const HTTPResponseStatusCode& value)
	{
		return output << static_cast<uint32>(value);
	}
}