You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

269 lines
8.2 KiB

using System;
using System.IO;
namespace Apewer.Web
{
/// <summary>Response 模型。</summary>
public abstract class ApiModel
{
#region
private int _expires = 0;
internal ApiRequest _request;
internal ApiResponse _response;
internal ApiOptions _options;
internal ApiProvider _provider;
static int SafeExpires(int seconds)
{
var s = seconds;
if (s < 0) s = 0;
if (s > 2592000) s = 2592000;
return s;
}
#endregion
#region 内部属性和方法。
/// <summary>处理当前模型的 API 请求。</summary>
protected ApiRequest Request { get => _request; }
/// <summary>处理当前模型的 API 响应。</summary>
protected ApiResponse Response { get => Response; }
/// <summary>处理当前模型的 API 选项。</summary>
protected ApiOptions Options { get => _options; }
/// <summary>处理当前模型的服务程序实例。</summary>
protected ApiProvider Provider { get => _provider; }
/// <summary>在 Response 头中添加用于设置文件名的属性。</summary>
protected void SetAttachment()
{
if (Provider == null) return;
var name = Attachment;
if (string.IsNullOrEmpty(name)) return;
var encoded = TextUtility.EncodeUrl(name);
Provider.SetHeader("Content-Disposition", $"attachment; filename={encoded}");
}
/// <summary>以指定参数输出。</summary>
protected void Output(byte[] bytes)
{
if (Provider == null) return;
try
{
SetAttachment();
Provider.SetCache(Expires);
Provider.SetContentType(ContentType);
var length = bytes == null ? 0 : bytes.Length;
Provider.SetContentLength(length);
if (length > 0) Provider.ResponseBody().Write(bytes);
}
catch { }
}
/// <summary>以指定参数输出。</summary>
protected void Output(Stream stream, bool dispose)
{
if (Provider == null) return;
try
{
SetAttachment();
Provider.SetCache(Expires);
Provider.SetContentType(ContentType);
Provider.SetContentLength(stream.Length - stream.Position);
Provider.ResponseBody().Write(stream);
}
catch { }
if (dispose) RuntimeUtility.Dispose(stream);
}
#endregion
/// <summary>内容类型。</summary>
public virtual string ContentType { get; set; }
/// <summary>响应缓存的过期时间,以秒为单位。</summary>
public virtual int Expires { get => _expires; set => _expires = SafeExpires(value); }
/// <summary>设置文件名,告知客户端此附件处理此响应。</summary>
public virtual string Attachment { get; set; }
/// <summary>执行输出。</summary>
/// <remarks>此方法由 API 调用器发起调用,用户程序不应主动调用。</remarks>
/// <exception cref="InvalidOperationException"></exception>
public abstract void Output();
/// <summary>创建对象实例,并设置默认属性。</summary>
public ApiModel()
{
ContentType = "application/octet-stream";
Expires = 0;
Attachment = null;
}
}
/// <summary>输出二进制的 Response 模型。</summary>
public class ApiBytesModel : ApiModel
{
/// <summary>向 Body 写入的字节数组。</summary>
public byte[] Bytes { get; set; }
/// <summary>输出字节数组。</summary>
public override void Output() => Output(Bytes);
}
/// <summary>输出二进制的 Response 模型。</summary>
public class ApiStreamModel : ApiModel, IDisposable
{
/// <summary>将要读取的流,用于向 Body 写入。</summary>
public Stream Stream { get; set; }
/// <summary>执行输出后释放流。</summary>
/// <remarks>默认值:TRUE。</remarks>
public bool AutoDispose { get; set; }
/// <summary>输出流。</summary>
public override void Output() => Output(Stream, AutoDispose);
/// <summary>当指定 AutoDispose 属性时释放流。</summary>
public void Dispose()
{
if (AutoDispose) RuntimeUtility.Dispose(Stream);
}
/// <summary>创建对象实例,并设置默认属性。</summary>
public ApiStreamModel() => AutoDispose = true;
}
/// <summary>输出二进制的 Response 模型。</summary>
public class ApiFileModel : ApiModel
{
/// <summary>将要读取的文件所在路径,用于向 Body 写入。</summary>
public string Path { get; set; }
/// <summary>输出指定路径的文件。</summary>
public override void Output()
{
try
{
if (!File.Exists(Path)) return;
var info = new FileInfo(Path);
if (string.IsNullOrEmpty(Attachment)) Attachment = info.Name;
var stream = new FileStream(Path, FileMode.Open, FileAccess.Read, FileShare.Read);
Output(stream, true);
}
catch { }
}
}
/// <summary>输出文本的 Response 模型。</summary>
public class ApiTextModel : ApiModel
{
/// <summary>自定义文本。</summary>
public string Text { get; set; }
/// <summary>输出文本。</summary>
public override void Output() => Output(TextUtility.Bytes(Text));
/// <summary>创建对象实例,并设置默认属性。</summary>
public ApiTextModel() => ContentType = "text/plain; charset=utf-8";
}
/// <summary>输出文本的 Response 模型。</summary>
public class ApiJsonModel : ApiModel
{
/// <summary>Json 对象。</summary>
public Json Json { get; set; }
/// <summary>缩进排版。</summary>
/// <remarks>默认值:TRUE</remarks>
public bool Indented { get; set; }
/// <summary>转为属性名为驼峰形式。</summary>
/// <remarks>默认值:FALSE</remarks>
public bool Camel { get; set; }
/// <summary>输出文本。</summary>
public override void Output()
{
var json = (Json != null && Json.Available) ? Json : Json.NewObject();
if (Camel) Json.Camel(json);
Output(TextUtility.Bytes(json.ToString(Indented)));
}
/// <summary>创建对象实例,并设置默认属性。</summary>
public ApiJsonModel()
{
ContentType = "text/plain; charset=utf-8";
Indented = true;
}
}
/// <summary>输出重定向的 Response 模型。</summary>
public class ApiRedirectModel : ApiModel
{
/// <summary>将要重定向的位置。</summary>
public string Location { get; set; }
/// <summary>执行重定向。</summary>
public override void Output()
{
var location = Location;
if (string.IsNullOrEmpty(location)) return;
if (Provider == null) return;
Provider.SetRedirect(Location);
}
}
/// <summary>输出带有指定 Status 的 Response 模型。</summary>
public class ApiStatusModel : ApiModel
{
/// <summary>状态。</summary>
/// <remarks>默认值:200。</remarks>
public int Status { get; set; } = 200;
/// <summary>向 Body 写入的字节数组。</summary>
public byte[] Bytes { get; set; }
/// <summary>执行重定向。</summary>
public override void Output()
{
var status = Status > 0 ? Status : 200;
Provider.SetStatus(status.ToString());
Output(Bytes);
}
/// <summary></summary>
public ApiStatusModel() { }
/// <summary></summary>
public ApiStatusModel(int status)
{
Status = status;
}
}
}