Tgstation.Server.Host.Controllers.ControlPanelController Class Reference

Controller for the web control panel. More...

Inheritance diagram for Tgstation.Server.Host.Controllers.ControlPanelController:

Collaboration diagram for Tgstation.Server.Host.Controllers.ControlPanelController:

Public Member Functions
	ControlPanelController (IWebHostEnvironment hostEnvironment, IOptionsSnapshot< ControlPanelConfiguration > controlPanelConfigurationOptions, ILogger< ControlPanelController > logger)
	Initializes a new instance of the ControlPanelController class.
IActionResult	GetChannelJson ()
	Returns the ControlPanelConfiguration.Channel.
override Task	OnActionExecutionAsync (ActionExecutingContext context, ActionExecutionDelegate next)
IActionResult	Get ([FromRoute] string appRoute)
	Handle a GET request to the control panel route. Route to static files if they exist, otherwise index.html.

Static Public Attributes
const string	ControlPanelRoute = "/app"
	Route to the ControlPanelController.
const string	ChannelJsonRoute = "channel.json"
	The route to the control panel channel .json.

Private Attributes
readonly IWebHostEnvironment	hostEnvironment
	The IWebHostEnvironment for the ControlPanelController.
readonly IOptionsSnapshot< ControlPanelConfiguration >	controlPanelConfigurationOptions
	The ControlPanelConfiguration for the ControlPanelController.
readonly ILogger< ControlPanelController >	logger
	The ILogger for the ControlPanelController.

Static Private Attributes
const string	FetchChannelVaryHeader = "X-Webpanel-Fetch-Channel"
	Header for forcing channel.json to be fetched.

Detailed Description

Controller for the web control panel.

Definition at line 26 of file ControlPanelController.cs.

Constructor & Destructor Documentation

ControlPanelController()

Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelController	(	IWebHostEnvironment	hostEnvironment,
		IOptionsSnapshot< ControlPanelConfiguration >	controlPanelConfigurationOptions,
		ILogger< ControlPanelController >	logger
	)

Initializes a new instance of the ControlPanelController class.

Parameters

hostEnvironment	The value of hostEnvironment.
controlPanelConfigurationOptions	The value of controlPanelConfigurationOptions.
logger	The value of logger.

Definition at line 64 of file ControlPanelController.cs.

        {
            this.hostEnvironment = hostEnvironment ?? throw new ArgumentNullException(nameof(hostEnvironment));
            this.controlPanelConfigurationOptions = controlPanelConfigurationOptions ?? throw new ArgumentNullException(nameof(controlPanelConfigurationOptions));
            this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
        }

References Tgstation.Server.Host.Controllers.ControlPanelController.controlPanelConfigurationOptions, Tgstation.Server.Host.Controllers.ControlPanelController.hostEnvironment, and Tgstation.Server.Host.Controllers.ControlPanelController.logger.

Member Function Documentation

Get()

IActionResult Tgstation.Server.Host.Controllers.ControlPanelController.Get

(

[FromRoute] string

appRoute

)

Handle a GET request to the control panel route. Route to static files if they exist, otherwise index.html.

Parameters

appRoute

The value of the route.

Returns

The VirtualFileResult to use.

Definition at line 133 of file ControlPanelController.cs.

        {
            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);
        }

References Tgstation.Server.Host.Controllers.ControlPanelController.controlPanelConfigurationOptions, Tgstation.Server.Host.Controllers.ControlPanelController.FetchChannelVaryHeader, Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson(), Tgstation.Server.Host.Controllers.ControlPanelController.hostEnvironment, and Tgstation.Server.Host.Controllers.ControlPanelController.logger.

Here is the call graph for this function:

GetChannelJson()

IActionResult Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson

(

)

Returns the ControlPanelConfiguration.Channel.

Returns

A JsonResult with the ControlPanelConfiguration.Channel.

Definition at line 80 of file ControlPanelController.cs.

        {
            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,
            });
        }

References Tgstation.Server.Host.Controllers.ControlPanelController.controlPanelConfigurationOptions, Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelRoute, Tgstation.Server.Host.Controllers.ControlPanelController.logger, and Tgstation.Server.Api.ApiHeaders.Version.

Referenced by Tgstation.Server.Host.Controllers.ControlPanelController.Get().

Here is the caller graph for this function:

OnActionExecutionAsync()

override Task Tgstation.Server.Host.Controllers.ControlPanelController.OnActionExecutionAsync	(	ActionExecutingContext	context,
		ActionExecutionDelegate	next
	)

Definition at line 110 of file ControlPanelController.cs.

        {
            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);
        }

References Tgstation.Server.Host.Controllers.ControlPanelController.FetchChannelVaryHeader.

Member Data Documentation

ChannelJsonRoute

const string Tgstation.Server.Host.Controllers.ControlPanelController.ChannelJsonRoute = "channel.json"

static

The route to the control panel channel .json.

Definition at line 36 of file ControlPanelController.cs.

controlPanelConfigurationOptions

readonly IOptionsSnapshot<ControlPanelConfiguration> Tgstation.Server.Host.Controllers.ControlPanelController.controlPanelConfigurationOptions

private

The ControlPanelConfiguration for the ControlPanelController.

Definition at line 51 of file ControlPanelController.cs.

Referenced by Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelController(), Tgstation.Server.Host.Controllers.ControlPanelController.Get(), and Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson().

ControlPanelRoute

const string Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelRoute = "/app"

static

Route to the ControlPanelController.

Definition at line 31 of file ControlPanelController.cs.

Referenced by Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson().

FetchChannelVaryHeader

const string Tgstation.Server.Host.Controllers.ControlPanelController.FetchChannelVaryHeader = "X-Webpanel-Fetch-Channel"

staticprivate

Header for forcing channel.json to be fetched.

Definition at line 41 of file ControlPanelController.cs.

Referenced by Tgstation.Server.Host.Controllers.ControlPanelController.Get(), and Tgstation.Server.Host.Controllers.ControlPanelController.OnActionExecutionAsync().

hostEnvironment

readonly IWebHostEnvironment Tgstation.Server.Host.Controllers.ControlPanelController.hostEnvironment

private

The IWebHostEnvironment for the ControlPanelController.

Definition at line 46 of file ControlPanelController.cs.

Referenced by Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelController(), and Tgstation.Server.Host.Controllers.ControlPanelController.Get().

logger

readonly ILogger<ControlPanelController> Tgstation.Server.Host.Controllers.ControlPanelController.logger

private

The ILogger for the ControlPanelController.

Definition at line 56 of file ControlPanelController.cs.

Referenced by Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelController(), Tgstation.Server.Host.Controllers.ControlPanelController.Get(), and Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson().

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Host/Controllers/ControlPanelController.cs