ControlPanelController.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Net.Mime;
using System.Threading.Tasks;
 
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.Primitives;
using Microsoft.Net.Http.Headers;
 
using Tgstation.Server.Api;
using Tgstation.Server.Host.Configuration;
using Tgstation.Server.Host.Extensions;
 
namespace Tgstation.Server.Host.Controllers
{
    [Route(ControlPanelRoute)]
    [ApiExplorerSettings(IgnoreApi = true)]
    public class ControlPanelController : Controller
    {
        public const string ControlPanelRoute = "/app";
 
        public const string ChannelJsonRoute = "channel.json";
 
        const string FetchChannelVaryHeader = "X-Webpanel-Fetch-Channel";
 
        readonly IWebHostEnvironment hostEnvironment;
 
        readonly IOptionsSnapshot<ControlPanelConfiguration> controlPanelConfigurationOptions;
 
        readonly ILogger<ControlPanelController> logger;
 
        public ControlPanelController(
            IWebHostEnvironment hostEnvironment,
            IOptionsSnapshot<ControlPanelConfiguration> controlPanelConfigurationOptions,
            ILogger<ControlPanelController> logger)
        {
            this.hostEnvironment = hostEnvironment ?? throw new ArgumentNullException(nameof(hostEnvironment));
            this.controlPanelConfigurationOptions = controlPanelConfigurationOptions ?? throw new ArgumentNullException(nameof(controlPanelConfigurationOptions));
            this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
        }
 
        [Route(ChannelJsonRoute)]
        [HttpGet]
        public IActionResult GetChannelJson()
        {
            if (!controlPanelConfigurationOptions.Value.Enable)
            {
                logger.LogDebug("Not serving channel.json as control panel is disabled.");
                return NotFound();
            }
 
            var controlPanelChannel = controlPanelConfigurationOptions.Value.Channel;
            logger.LogTrace("Generating channel.json for channel \"{channel}\"...", controlPanelChannel);
 
            if (controlPanelChannel == "local")
                controlPanelChannel = ControlPanelRoute;
            else if (String.IsNullOrWhiteSpace(controlPanelChannel))
                controlPanelChannel = null;
            else
                controlPanelChannel = controlPanelChannel
                    .Replace("${Major}", ApiHeaders.Version.Major.ToString(CultureInfo.InvariantCulture), StringComparison.Ordinal)
                    .Replace("${Minor}", ApiHeaders.Version.Minor.ToString(CultureInfo.InvariantCulture), StringComparison.Ordinal)
                    .Replace("${Patch}", ApiHeaders.Version.Build.ToString(CultureInfo.InvariantCulture), StringComparison.Ordinal);
 
            return Json(new
            {
                FormatVersion = 1,
                Channel = controlPanelChannel,
                controlPanelConfigurationOptions.Value.PublicPath,
            });
        }
 
        public override Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
        {
            ArgumentNullException.ThrowIfNull(context);
 
            var newValues = new List<string> { FetchChannelVaryHeader };
            var headers = context.HttpContext.Response.Headers;
            if (headers.TryGetValue(HeaderNames.Vary, out var oldValues))
                headers.Remove(HeaderNames.Vary);
 
            newValues.AddRange(oldValues);
 
            headers.Add(HeaderNames.Vary, new StringValues(newValues.ToArray()));
 
            return base.OnActionExecutionAsync(context, next);
        }
 
        [Route("{**appRoute}")]
        [HttpGet]
        public IActionResult Get([FromRoute] string appRoute)
        {
            if (!controlPanelConfigurationOptions.Value.Enable)
            {
                logger.LogDebug("Not serving static files as control panel is disabled.");
                return NotFound();
            }
 
            if (Request.Headers.ContainsKey(FetchChannelVaryHeader))
                return GetChannelJson();
 
            var foundFile = this.TryServeFile(hostEnvironment, logger, appRoute);
            if (foundFile != null)
                return foundFile;
 
            logger.LogTrace("Requested static file \"{filename}\" does not exist! Redirecting to index...", appRoute);
 
            return File("index.html", MediaTypeNames.Text.Html);
        }
    }
}