NaiNiu/Assets/HandDriver/_3rd/TouchSocket/Http/Extensions/HttpExtensions.cs

//------------------------------------------------------------------------------
//  此代码版权（除特别声明或在XREF结尾的命名空间的代码）归作者本人若汝棋茗所有
//  源代码使用协议遵循本仓库的开源协议及附加协议，若本仓库没有设置，则按MIT开源协议授权
//  CSDN博客：https://blog.csdn.net/qq_40374647
//  哔哩哔哩视频：https://space.bilibili.com/94253567
//  Gitee源代码仓库：https://gitee.com/RRQM_Home
//  Github源代码仓库：https://github.com/RRQM
//  API首页：https://www.yuque.com/rrqm/touchsocket/index
//  交流QQ群：234762506
//  感谢您的下载和使用
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
using System;
using System.IO;
using System.Text;
using TouchSocket.Core;
using TouchSocket.Sockets;

namespace TouchSocket.Http
{
    /// <summary>
    /// Http扩展辅助
    /// </summary>
    public static class HttpExtensions
    {
        /// <summary>
        /// 根据字符串获取枚举
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="str"></param>
        /// <param name="result"></param>
        /// <returns></returns>
        public static bool GetEnum<T>(string str, out T result) where T : struct
        {
            return Enum.TryParse<T>(str, out result);
        }

        #region HttpBase

        #region 设置内容

        /// <summary>
        /// 从Json
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public static T FromJson<T>(this T httpRequest, string value) where T : HttpBase
        {
            httpRequest.SetContent(Encoding.UTF8.GetBytes(value));
            httpRequest.SetHeader(HttpHeaders.ContentType, "application/json;charset=UTF-8");
            return httpRequest;
        }

        /// <summary>
        /// 从文本
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public static T FromText<T>(this T httpRequest, string value) where T : HttpBase
        {
            httpRequest.SetContent(Encoding.UTF8.GetBytes(value));
            httpRequest.SetHeader(HttpHeaders.ContentType, "text/plain;charset=UTF-8");
            return httpRequest;
        }

        /// <summary>
        /// 从Xml格式
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public static T FromXML<T>(this T httpRequest, string value) where T : HttpBase
        {
            httpRequest.SetContent(Encoding.UTF8.GetBytes(value));
            httpRequest.SetHeader(HttpHeaders.ContentType, "application/xml;charset=UTF-8");
            return httpRequest;
        }

        #endregion 设置内容

        /// <summary>
        /// 获取Body的字符串
        /// </summary>
        /// <param name="httpBase"></param>
        /// <returns></returns>
        public static string GetBody(this HttpBase httpBase)
        {
            if (httpBase.TryGetContent(out byte[] data))
            {
                return Encoding.UTF8.GetString(data);
            }
            throw new Exception("获取数据体错误。");
        }

        /// <summary>
        /// 当数据类型为multipart/form-data时，获取boundary
        /// </summary>
        /// <param name="httpBase"></param>
        /// <returns></returns>
        /// <exception cref="Exception"></exception>
        public static string GetBoundary(this HttpBase httpBase)
        {
            if (httpBase.ContentType.IsNullOrEmpty())
            {
                return string.Empty;
            }
            string[] strs = httpBase.ContentType.Split(';');
            if (strs.Length == 2)
            {
                strs = strs[1].Split('=');
                if (strs.Length == 2)
                {
                    return strs[1].Trim();
                }
            }
            return string.Empty;
        }

        /// <summary>
        /// 设置内容
        /// </summary>
        /// <param name="httpBase"></param>
        /// <param name="content"></param>
        /// <param name="encoding"></param>
        /// <returns></returns>
        public static T SetContent<T>(this T httpBase, string content, Encoding encoding = null) where T : HttpBase
        {
            httpBase.SetContent(Encoding.UTF8.GetBytes(content));
            return httpBase;
        }

        /// <summary>
        /// 设置数据体长度
        /// </summary>
        /// <param name="httpBase"></param>
        /// <param name="value"></param>
        public static T SetContentLength<T>(this T httpBase, long value) where T : HttpBase
        {
            httpBase.ContentLength = value;
            return httpBase;
        }

        /// <summary>
        /// 从扩展名设置内容类型，必须以“.”开头
        /// </summary>
        /// <param name="httpBase"></param>
        /// <param name="extension"></param>
        /// <returns></returns>
        public static T SetContentTypeByExtension<T>(this T httpBase, string extension) where T : HttpBase
        {
            string type = HttpTools.GetContentTypeFromExtension(extension);
            httpBase.SetHeader(HttpHeaders.ContentType.GetDescription(), type);
            httpBase.ContentType = type;
            return httpBase;
        }

        /// <summary>
        /// 设置头值
        /// </summary>
        /// <param name="httpBase"></param>
        /// <param name="header"></param>
        /// <param name="value"></param>
        public static T SetHeader<T>(this T httpBase, HttpHeaders header, string value) where T : HttpBase
        {
            httpBase.SetHeaderByKey(header.GetDescription(), value);
            return httpBase;
        }

        /// <summary>
        /// 设置头值
        /// </summary>
        /// <param name="httpBase"></param>
        /// <param name="fieldName"></param>
        /// <param name="value"></param>
        public static T SetHeader<T>(this T httpBase, string fieldName, string value) where T : HttpBase
        {
            httpBase.SetHeaderByKey(fieldName.ToLower(), value);
            return httpBase;
        }

        /// <summary>
        /// 写入
        /// </summary>
        /// <param name="httpBase"></param>
        /// <param name="buffer"></param>
        public static T WriteContent<T>(this T httpBase, byte[] buffer) where T : HttpBase
        {
            httpBase.WriteContent(buffer, 0, buffer.Length);
            return httpBase;
        }

        #endregion HttpBase

        #region HttpRequest

        /// <summary>
        /// 获取多文件集合。如果不存在，则返回null。
        /// </summary>
        /// <typeparam name="TRequest"></typeparam>
        /// <param name="request"></param>
        /// <returns></returns>
        public static MultifileCollection GetMultifileCollection<TRequest>(this TRequest request) where TRequest : HttpRequest
        {
            if (request.GetBoundary().IsNullOrEmpty())
            {
                return null;
            }
            else
            {
                return new MultifileCollection(request);
            }
        }

        /// <summary>
        /// 初始化常规的请求头。
        /// <para>包含：</para>
        /// <list type="number">
        /// <item>Connection:keep-alive</item>
        /// <item>Pragma:no-cache</item>
        /// <item>UserAgent:TouchSocket.Http</item>
        /// <item>Accept:*/*</item>
        /// <item>AcceptEncoding:deflate, br</item>
        /// </list>
        /// </summary>
        /// <param name="request"></param>
        /// <returns></returns>
        public static TRequest InitHeaders<TRequest>(this TRequest request) where TRequest : HttpRequest
        {
            request.SetHeader(HttpHeaders.Connection, "keep-alive");
            request.SetHeader(HttpHeaders.Pragma, "no-cache");
            request.SetHeader(HttpHeaders.UserAgent, "TouchSocket.Http");
            request.SetHeader(HttpHeaders.Accept, "*/*");
            request.SetHeader(HttpHeaders.AcceptEncoding, "deflate, br");
            return request;
        }

        /// <summary>
        /// 添加Host请求头
        /// </summary>
        /// <param name="request"></param>
        /// <param name="host"></param>
        /// <returns></returns>
        public static TRequest SetHost<TRequest>(this TRequest request, string host) where TRequest : HttpRequest
        {
            request.SetHeader(HttpHeaders.Host, host);
            return request;
        }

        /// <summary>
        /// 对比不包含参数的Url。其中有任意一方为null，则均返回False。
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <param name="url"></param>
        /// <returns></returns>
        public static bool UrlEquals<TRequest>(this TRequest httpRequest, string url) where TRequest : HttpRequest
        {
            if (string.IsNullOrEmpty(httpRequest.RelativeURL) || string.IsNullOrEmpty(url))
            {
                return false;
            }
            if (httpRequest.RelativeURL.Equals(url, StringComparison.CurrentCultureIgnoreCase))
            {
                return true;
            }
            return false;
        }

        #region 设置函数

        /// <summary>
        /// 作为Delete访问
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <returns></returns>
        public static TRequest AsDelete<TRequest>(this TRequest httpRequest) where TRequest : HttpRequest
        {
            httpRequest.Method = TouchSocketHttpUtility.Delete;
            return httpRequest;
        }

        /// <summary>
        /// 作为Get访问
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <returns></returns>
        public static TRequest AsGet<TRequest>(this TRequest httpRequest) where TRequest : HttpRequest
        {
            httpRequest.Method = TouchSocketHttpUtility.Get;
            return httpRequest;
        }

        /// <summary>
        /// 作为指定函数
        /// </summary>
        /// <param name="request"></param>
        /// <param name="method"></param>
        /// <returns></returns>
        public static TRequest AsMethod<TRequest>(this TRequest request, string method) where TRequest : HttpRequest
        {
            request.Method = method;
            return request;
        }

        /// <summary>
        /// 作为Post访问
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <returns></returns>
        public static TRequest AsPost<TRequest>(this TRequest httpRequest) where TRequest : HttpRequest
        {
            httpRequest.Method = TouchSocketHttpUtility.Post;
            return httpRequest;
        }

        /// <summary>
        /// 作为Put访问
        /// </summary>
        /// <param name="httpRequest"></param>
        /// <returns></returns>
        public static TRequest AsPut<TRequest>(this TRequest httpRequest) where TRequest : HttpRequest
        {
            httpRequest.Method = TouchSocketHttpUtility.Put;
            return httpRequest;
        }

        #endregion 设置函数

        #endregion HttpRequest

        #region HttpResponse

        /// <summary>
        /// 路径文件没找到
        /// </summary>
        /// <param name="response"></param>
        /// <returns></returns>
        public static TResponse UrlNotFind<TResponse>(this TResponse response) where TResponse : HttpResponse
        {
            response.SetContent("<html><body><h1>404 -RRQM Not Found</h1></body></html>");
            response.StatusCode = "404";
            response.ContentType = "text/html;charset=utf-8";
            return response;
        }

        /// <summary>
        /// 从文件响应。
        /// <para>当response支持持续写入时，会直接回复响应。并阻塞执行，直到完成。所以在执行该方法之前，请确保已设置完成所有状态字</para>
        /// <para>当response不支持持续写入时，会填充Content，且不会响应，需要自己执行Build，并发送。</para>
        /// </summary>
        /// <param name="response">响应</param>
        /// <param name="request">请求头，用于尝试续传，为null时则不续传。</param>
        /// <param name="filePath">文件路径</param>
        /// <param name="fileName">文件名，不设置时会获取路径文件名</param>
        /// <param name="maxSpeed">最大速度（仅企业版有效）。</param>
        /// <param name="bufferLen">读取长度。</param>
        /// <exception cref="Exception"></exception>
        /// <exception cref="Exception"></exception>
        /// <returns></returns>
        public static TResponse FromFile<TResponse>(this TResponse response, string filePath, HttpRequest request, string fileName = null, int maxSpeed = 1024 * 1024 * 10, int bufferLen = 1024 * 64) where TResponse : HttpResponse
        {
            using (var reader = FilePool.GetReader(filePath))
            {
                response.SetContentTypeByExtension(Path.GetExtension(filePath));
                var contentDisposition = "attachment;" + "filename=" /*+ System.Web.HttpUtility.UrlEncode(fileName == null ? Path.GetFileName(filePath) : fileName)*/;
                response.SetHeader(HttpHeaders.ContentDisposition, contentDisposition)
                    .SetHeader(HttpHeaders.AcceptRanges, "bytes");

                if (response.CanWrite)
                {
                    HttpRange httpRange;
                    string range = request?.GetHeader(HttpHeaders.Range);
                    if (string.IsNullOrEmpty(range))
                    {
                        response.SetStatus();
                        response.ContentLength = reader.FileStorage.FileInfo.Length;
                        httpRange = new HttpRange() { Start = 0, Length = reader.FileStorage.FileInfo.Length };
                    }
                    else
                    {
                        httpRange = HttpRange.GetRange(range, reader.FileStorage.FileInfo.Length);
                        if (httpRange == null)
                        {
                            response.ContentLength = reader.FileStorage.FileInfo.Length;
                            httpRange = new HttpRange() { Start = 0, Length = reader.FileStorage.FileInfo.Length };
                        }
                        else
                        {
                            response.SetContentLength(httpRange.Length)
                                .SetStatus("206", "Partial Content")
                                   .SetHeader(HttpHeaders.ContentRange, string.Format("bytes {0}-{1}/{2}", httpRange.Start, httpRange.Length + httpRange.Start - 1, reader.FileStorage.FileInfo.Length));
                        }
                    }
                    reader.Position = httpRange.Start;
                    long surLen = httpRange.Length;
                    FlowGate flowGate = new FlowGate();
                    flowGate.Maximum = maxSpeed;

                    using (ByteBlock block = new ByteBlock(bufferLen))
                    {
                        while (surLen > 0)
                        {
                            int r = reader.Read(block.Buffer, 0, (int)Math.Min(bufferLen, surLen));
                            if (r == 0)
                            {
                                break;
                            }
                            flowGate.AddCheckWait(r);
                            response.WriteContent(block.Buffer, 0, r);
                            surLen -= r;
                        }
                    }
                }
                else
                {
                    if (reader.FileStorage.FileInfo.Length > 1024 * 1024)
                    {
                        throw new OverlengthException("当该对象不支持写入时，仅支持1Mb以内的文件。");
                    }

                    using (ByteBlock byteBlock = new ByteBlock((int)reader.FileStorage.FileInfo.Length))
                    {
                        using (ByteBlock block = new ByteBlock(bufferLen))
                        {
                            while (true)
                            {
                                int r = reader.Read(block.Buffer, 0, bufferLen);
                                if (r == 0)
                                {
                                    break;
                                }
                                byteBlock.Write(block.Buffer, 0, r);
                            }
                            response.SetContent(byteBlock.ToArray());
                        }
                    }
                }
            }
            return response;
        }

        /// <summary>
        /// 设置文件类型。
        /// </summary>
        /// <param name="response"></param>
        /// <param name="fileName"></param>
        /// <returns></returns>
        public static TResponse SetContentTypeFromFileName<TResponse>(this TResponse response, string fileName) where TResponse : HttpResponse
        {
            var contentDisposition = "attachment;" + "filename=" /*+ System.Web.HttpUtility.UrlEncode(fileName)*/;
            response.SetHeader(HttpHeaders.ContentDisposition, contentDisposition);
            return response;
        }

        /// <summary>
        /// 设置状态，并且附带时间戳。
        /// </summary>
        /// <param name="response"></param>
        /// <param name="status"></param>
        /// <param name="msg"></param>
        /// <returns></returns>
        public static TResponse SetStatus<TResponse>(this TResponse response, string status = "200", string msg = "Success") where TResponse : HttpResponse
        {
            response.StatusCode = status;
            response.StatusMessage = msg;
            response.SetHeader(HttpHeaders.Server, $"TouchSocket.Http {HttpBase.ServerVersion}");
            response.SetHeader(HttpHeaders.Date, DateTime.Now.ToGMTString("r"));
            return response;
        }

        #endregion HttpResponse
    }
}