raven/server/AyaNova/Controllers/ServerStateController.cs

using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Authorization;
using Microsoft.Extensions.Logging;
using AyaNova.Api.ControllerHelpers;
using AyaNova.Biz;
using AyaNova.Models;
using System.ComponentModel.DataAnnotations;
using Microsoft.Extensions.Hosting;
using AyaNova.Util;


namespace AyaNova.Api.Controllers
{

    /// <summary>
    /// Server state controller
    /// </summary>
    [ApiController]
    [ApiVersion("8.0")]
    [Route("api/v{version:apiVersion}/server-state")]
    [Produces("application/json")]
    [Authorize]
    public class ServerStateController : ControllerBase
    {
        private readonly AyContext ct;
        private readonly ILogger<ServerStateController> log;
        private readonly ApiServerState serverState;
        private readonly IHostApplicationLifetime _appLifetime;


        public ServerStateController(ILogger<ServerStateController> logger, ApiServerState apiServerState, AyContext dbcontext, IHostApplicationLifetime appLifetime)
        {
            ct = dbcontext;
            log = logger;
            serverState = apiServerState;
            _appLifetime = appLifetime;
        }


        /// <summary>
        /// Get server state 
        /// </summary>
        /// <returns>Current server state (Closed, MigrateMode, OpsOnly, Open)</returns>
        [HttpGet]
        public ActionResult Get()
        {
            //any logged in user can get the state
            return Ok(ApiOkResponse.Response(new ServerStateModel() { ServerState = serverState.GetState().ToString(), Reason = serverState.Reason }));
        }


        /// <summary>
        /// Set server state
        /// Valid parameters:
        /// One of "OpsOnly", "MigrateMode" or "Open"
        /// </summary>
        /// <param name="state">{"serverState":"Open"}</param>
        /// <returns>New server state</returns>
        [HttpPost]
        public async Task<IActionResult> PostServerState([FromBody] ServerStateModel state)
        {
            if (serverState.IsClosed)//no state change allowed when closed
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

            if (!Authorized.HasModifyRole(HttpContext.Items, AyaType.ServerState))
                return StatusCode(403, new ApiNotAuthorizedResponse());

            if (!ModelState.IsValid)
                return BadRequest(new ApiErrorResponse(ModelState));

            ApiServerState.ServerState desiredState;
            if (!Enum.TryParse<ApiServerState.ServerState>(state.ServerState, true, out desiredState))
                return BadRequest(new ApiErrorResponse(ApiErrorCode.VALIDATION_INVALID_VALUE, null, "Invalid state -  must be one of \"OpsOnly\", \"MigrateMode\" or \"Open\""));

            //don't allow a server to be set to closed, that's for internal ops only
            if (desiredState == ApiServerState.ServerState.Closed)
                return BadRequest(new ApiErrorResponse(ApiErrorCode.VALIDATION_INVALID_VALUE, null, "Invalid state -  must be one of \"OpsOnly\", \"MigrateMode\" or \"Open\""));

            var TransId = UserTranslationIdFromContext.Id(HttpContext.Items);

            log.LogInformation($"ServerState change request by user {UserNameFromContext.Name(HttpContext.Items)} from current state of \"{serverState.GetState().ToString()}\" to \"{desiredState.ToString()} {state.Reason}\"");

            if (desiredState == ApiServerState.ServerState.MigrateMode)
                ServerBootConfig.MIGRATING = true;
            else
                ServerBootConfig.MIGRATING = false;

            //Add a message if user didn't enter one so other users know why they can't login
            if (string.IsNullOrWhiteSpace(state.Reason))
            {
                switch (desiredState)
                {
                    case ApiServerState.ServerState.Open:
                        break;
                    case ApiServerState.ServerState.MigrateMode:
                        state.Reason += await TranslationBiz.GetTranslationStaticAsync("ServerStateLoginRestricted", TransId, ct) + ":\n" + await TranslationBiz.GetTranslationStaticAsync("ServerStateMigrateMode", TransId, ct);
                        break;
                    case ApiServerState.ServerState.OpsOnly:
                        state.Reason += await TranslationBiz.GetTranslationStaticAsync("ServerStateLoginRestricted", TransId, ct) + ":\n" + await TranslationBiz.GetTranslationStaticAsync("ServerStateOps", TransId, ct);
                        break;
                    case ApiServerState.ServerState.Closed:
                        state.Reason += await TranslationBiz.GetTranslationStaticAsync("ServerStateLoginRestricted", TransId, ct) + ":\n" + await TranslationBiz.GetTranslationStaticAsync("ErrorAPI2000", TransId, ct);
                        break;
                }
            }
            else
            {
                if (desiredState != ApiServerState.ServerState.OpsOnly)
                    state.Reason = await TranslationBiz.GetTranslationStaticAsync("ServerStateLoginRestricted", TransId, ct) + ":\n" + state.Reason;
            }

            serverState.SetState(desiredState, state.Reason);

            //Log
            await EventLogProcessor.LogEventToDatabaseAsync(new Event(UserIdFromContext.Id(HttpContext.Items), 0, AyaType.ServerState, AyaEvent.ServerStateChange, $"{state.ServerState}-{state.Reason}"), ct);

            return Ok(ApiOkResponse.Response(new ServerStateModel() { ServerState = serverState.GetState().ToString(), Reason = serverState.Reason }));

        }


        /// <summary>
        /// Parameter object
        /// </summary>
        public class ServerStateModel
        {
            /// <summary>
            /// "OpsOnly", "MigrateMode"  or "Open"
            /// </summary>
            /// <returns></returns>
            [Required]
            public string ServerState { get; set; }

            /// <summary>
            /// Reason for server state
            /// </summary>
            /// <returns></returns>
            public string Reason { get; set; }
        }



        /// <summary>
        /// Controlled server shut down
        /// </summary>
        /// <returns>Accepted</returns>
        [HttpPost("shutdown")]
        public ActionResult PostShutdown()
        {
            if (serverState.IsClosed)//no state change allowed when closed
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

            if (!Authorized.HasModifyRole(HttpContext.Items, AyaType.ServerState))
                return StatusCode(403, new ApiNotAuthorizedResponse());

            log.LogInformation($"### Server shut down requested by user {UserNameFromContext.Name(HttpContext.Items)}, triggering shut down event now...");

            _appLifetime.StopApplication();
            return Accepted();

        }




        /// <summary>
        /// Get server configuration 
        /// </summary>
        /// <returns>Active server configuration</returns>
        [HttpGet("active-configuration")]
        public ActionResult GetActiveConfiguration()
        {
            if (!Authorized.HasReadFullRole(HttpContext.Items, AyaType.ServerState))
                return StatusCode(403, new ApiNotAuthorizedResponse());


            return Ok(ApiOkResponse.Response(
                new
                {
                    AYANOVA_DEFAULT_TRANSLATION = ServerBootConfig.AYANOVA_DEFAULT_TRANSLATION,
                    AYANOVA_USE_URLS = ServerBootConfig.AYANOVA_USE_URLS,
                    AYANOVA_DB_CONNECTION = DbUtil.PasswordRedactedConnectionString(ServerBootConfig.AYANOVA_DB_CONNECTION),
                    AYANOVA_FOLDER_USER_FILES = ServerBootConfig.AYANOVA_FOLDER_USER_FILES,
                    AYANOVA_FOLDER_BACKUP_FILES = ServerBootConfig.AYANOVA_FOLDER_BACKUP_FILES,
                    AYANOVA_FOLDER_TEMPORARY_SERVER_FILES = ServerBootConfig.AYANOVA_FOLDER_TEMPORARY_SERVER_FILES,
                    AYANOVA_BACKUP_PG_DUMP_PATH = ServerBootConfig.AYANOVA_BACKUP_PG_DUMP_PATH,
                    AYANOVA_LOG_PATH = ServerBootConfig.AYANOVA_LOG_PATH,
                    AYANOVA_LOG_LEVEL = ServerBootConfig.AYANOVA_LOG_LEVEL,
                    AYANOVA_LOG_ENABLE_LOGGER_DIAGNOSTIC_LOG = ServerBootConfig.AYANOVA_LOG_ENABLE_LOGGER_DIAGNOSTIC_LOG,
                    BOOT_DIAGNOSTIC_INFO = ServerBootConfig.BOOT_DIAGNOSTIC_INFO
                }));
        }


        //------------

    }
}