ControllerBaseExtensions.cs

Go to the documentation of this file.

using System;
using System.Net;
using System.Net.Mime;
 
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.StaticFiles;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Primitives;
using Microsoft.Net.Http.Headers;
 
using Tgstation.Server.Api.Models;
using Tgstation.Server.Api.Models.Response;
 
namespace Tgstation.Server.Host.Extensions
{
    static class ControllerBaseExtensions
    {
        public static ObjectResult Created(this ControllerBase controller, object payload) => controller.StatusCode(HttpStatusCode.Created, payload);
 
        public static ObjectResult Unauthorized(this ControllerBase controller) => controller.StatusCode(HttpStatusCode.Unauthorized, null);
 
        public static ObjectResult Gone(this ControllerBase controller)
            => controller?.StatusCode(HttpStatusCode.Gone, new ErrorMessageResponse(ErrorCode.ResourceNotPresent)) ?? throw new ArgumentNullException(nameof(controller));
 
        public static ObjectResult StatusCode(this ControllerBase controller, HttpStatusCode statusCode, object? errorMessage)
            => controller?.StatusCode((int)statusCode, errorMessage) ?? throw new ArgumentNullException(nameof(controller));
 
        public static VirtualFileResult? TryServeFile(this ControllerBase controller, IWebHostEnvironment hostEnvironment, ILogger logger, string path)
        {
            ArgumentNullException.ThrowIfNull(controller);
            ArgumentNullException.ThrowIfNull(hostEnvironment);
            ArgumentNullException.ThrowIfNull(logger);
            ArgumentNullException.ThrowIfNull(path);
 
            var fileInfo = hostEnvironment.WebRootFileProvider.GetFileInfo(path);
            if (fileInfo.Exists)
            {
                logger.LogTrace("Serving static file \"{filename}\"...", path);
                var contentTypeProvider = new FileExtensionContentTypeProvider();
                if (!contentTypeProvider.TryGetContentType(fileInfo.Name, out var contentType))
                    contentType = MediaTypeNames.Application.Octet;
                else if (contentType == MediaTypeNames.Application.Json)
                    controller.Response.Headers.Add(
                        HeaderNames.CacheControl,
                        new StringValues(new[] { "public", "max-age=31536000", "immutable" }));
 
                return controller.File(path, contentType);
            }
 
            return null;
        }
    }
}