Digitalisation_EPA_Serveur/EPAServeur/Controllers/EngagementsApi.cs

/*
 * API du serveur de l'application de digitalisation des EP
 *
 * API qui sra utilisée afin de faire communiquer le client et le serveur ainsi que le serveur et la boîte noire.
 *
 * OpenAPI spec version: 1.3.6
 *
 * Generated by: https://github.com/swagger-api/swagger-codegen.git
 */
using System;
using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
using Swashbuckle.AspNetCore.Annotations;
using Swashbuckle.AspNetCore.SwaggerGen;
using Newtonsoft.Json;
using System.ComponentModel.DataAnnotations;
using IO.Swagger.Attributes;
using IO.Swagger.Security;
using Microsoft.AspNetCore.Authorization;
using IO.Swagger.DTO;
using IO.Swagger.Enum;
using EPAServeur.Attributes;
using EPAServeur.IServices;
using Microsoft.Extensions.Logging;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
using EPAServeur.Exceptions;
using Microsoft.EntityFrameworkCore;
using Microsoft.AspNetCore.Authentication.JwtBearer;

namespace IO.Swagger.Controllers
{
    /// <summary>
    ///
    /// </summary>
    [ApiController]
    public class EngagementsApiController : ControllerBase
    {
        private readonly IEngagementService engagementService;
        private readonly ILogger<EngagementsApiController> logger;
        private readonly IWebHostEnvironment env;

        public EngagementsApiController(IEngagementService _engagementService, ILogger<EngagementsApiController> _logger, IWebHostEnvironment _env)
        {
            engagementService = _engagementService;
            logger = _logger;
            env = _env;
        }

        /// <summary>
        ///
        /// </summary>
        /// <remarks>Récupérer la liste des engagements.</remarks>
        /// <param name="idBUs">liste des ids des BU auxquelles les données sont rattachées</param>
        /// <param name="etatsEngagement">Etats de l&#x27;engagement</param>
        /// <param name="asc">Indique si les données sont récupérées dans l&#x27;ordre croissant ou non</param>
        /// <param name="numPage">Numéro de la page du tableau à afficher</param>
        /// <param name="parPAge">Nombre d’élément maximum à afficher dans le tableau</param>
        /// <param name="texte">Texte permettant de filtrer les données</param>
        /// <param name="tri">Colonne du tableau sur lequel le tri devra être effectué</param>
        /// <response code="200">OK</response>
        /// <response code="401">L&#x27;utilisateur souhaitant accéder à la ressource n&#x27;est pas authentifié</response>
        /// <response code="403">L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants</response>
        /// <response code="500">Une erreur est survenue sur le serveur</response>
        [HttpGet]
        [Route("/api/engagements")]
        [Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "RH")]
        [ValidateModelState]
        [SwaggerOperation("GetEngagements")]
        [SwaggerResponse(statusCode: 200, type: typeof(List<EngagementDTO>), description: "OK")]
        [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L&#x27;utilisateur souhaitant accéder à la ressource n&#x27;est pas authentifié")]
        [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")]
        [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")]
        public virtual async Task<IActionResult> GetEngagements([FromQuery][CannotBeEmpty] List<long> idBUs, [FromQuery]List<EtatEngagement> etatsEngagement, [FromQuery]bool? asc, [FromQuery]int? numPage, [FromQuery][Range(5, 100)]int? parPAge, [FromQuery]string texte, [FromQuery]string tri)
        {
            if (env.IsDevelopment())
                logger.LogInformation("Récupération de la liste des engagements.");

            IEnumerable<EngagementDTO> engagements;

            try
            {
                engagements = await engagementService.GetEngagementsAsync(idBUs, etatsEngagement, asc, numPage, parPAge, texte, tri);
            }
            catch (Exception e)
            {
                logger.LogError(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status500InternalServerError,
                    Message = "Une erreur inconnue est survenue sur le serveur."
                };

                return StatusCode(erreur.Code.Value, erreur);
            }

            if (env.IsDevelopment())
                logger.LogInformation("Liste des engagements récupérée.");

            return Ok(engagements);
        }

        /// <summary>
        ///
        /// </summary>
        /// <remarks>Récupérer le nombre total d’engagements.</remarks>
        /// <param name="idBUs">liste des ids des BU auxquelles les données sont rattachées</param>
        /// <param name="etatsEngagement">Etats de l&#x27;engagement</param>
        /// <param name="asc">Indique si les données sont récupérées dans l&#x27;ordre croissant ou non</param>
        /// <param name="numPage">Numéro de la page du tableau à afficher</param>
        /// <param name="parPAge">Nombre d’élément maximum à afficher dans le tableau</param>
        /// <param name="texte">Texte permettant de filtrer les données</param>
        /// <param name="tri">Colonne du tableau sur lequel le tri devra être effectué</param>
        /// <response code="200">OK</response>
        /// <response code="401">L&#x27;utilisateur souhaitant accéder à la ressource n&#x27;est pas authentifié</response>
        /// <response code="403">L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants</response>
        /// <response code="500">Une erreur est survenue sur le serveur</response>
        [HttpGet]
        [Route("/api/engagements/count")]
        [Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "RH")]
        [ValidateModelState]
        [SwaggerOperation("GetEngagementsCount")]
        [SwaggerResponse(statusCode: 200, type: typeof(long?), description: "OK")]
        [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L&#x27;utilisateur souhaitant accéder à la ressource n&#x27;est pas authentifié")]
        [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")]
        [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")]
        public virtual async Task<IActionResult> GetEngagementsCount([FromQuery][CannotBeEmpty]List<long> idBUs, [FromQuery]List<EtatEngagement> etatsEngagement, [FromQuery]bool? asc, [FromQuery]int? numPage, [FromQuery][Range(5, 100)]int? parPAge, [FromQuery]string texte, [FromQuery]string tri)
        {
            if (env.IsDevelopment())
                logger.LogInformation("Récupération du nombre total d'engagements.");

            long count;

            try
            {
                count = await engagementService.GetEngagementsCountAsync(idBUs, etatsEngagement, asc, numPage, parPAge, texte, tri);
            }
            catch (Exception e)
            {
                logger.LogError(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status500InternalServerError,
                    Message = "Une erreur inconnue est survenue sur le serveur."
                };

                return StatusCode(erreur.Code.Value, erreur);
            }

            if (env.IsDevelopment())
                logger.LogInformation("Nombre total d'engagement récupéré.");

            return Ok(count);
        }

        /// <summary>
        ///
        /// </summary>
        /// <remarks>Répondre à un engagement.</remarks>
        /// <param name="body"></param>
        /// <param name="idEngagement">Id d&#x27;un engagement</param>
        /// <response code="200">Engagement modifié avec succès</response>
        /// <response code="401">L&#x27;utilisateur souhaitant accéder à la ressource n&#x27;est pas authentifié</response>
        /// <response code="403">L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants</response>
        /// <response code="404">La ressource n&#x27;a pas été trouvée</response>
        /// <response code="415">L’opération ne peut pas être effectuée car certaines données sont manquantes</response>
        /// <response code="500">Une erreur est survenue sur le serveur</response>
        [HttpPut]
        [Route("/api/engagements/{idEngagement}")]
        [Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme, Roles = "RH")]
        [ValidateModelState]
        [SwaggerOperation("UpdateEngagement")]
        [SwaggerResponse(statusCode: 200, type: typeof(EngagementDTO), description: "Engagement modifié avec succès")]
        [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L&#x27;utilisateur souhaitant accéder à la ressource n&#x27;est pas authentifié")]
        [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")]
        [SwaggerResponse(statusCode: 404, type: typeof(ErreurDTO), description: "La ressource n&#x27;a pas été trouvée")]
        [SwaggerResponse(statusCode: 415, type: typeof(ErreurDTO), description: "L’opération ne peut pas être effectuée car certaines données sont manquantes")]
        [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")]
        public virtual async Task<IActionResult> UpdateEngagement([FromBody]EngagementDTO body, [FromRoute][Required]long idEngagement)
        {
            if (env.IsDevelopment())
                logger.LogInformation("Mise à jour de l'engagement d'id {idEngagement}.", idEngagement);

            try
            {
                body = await engagementService.RepondreEngagementAsync(body, idEngagement);
            }
            catch (EngagementInvalidException e)
            {
                if (env.IsDevelopment())
                    logger.LogInformation(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status415UnsupportedMediaType,
                    Message = e.Message,
                };

                return StatusCode(erreur.Code.Value, erreur.Message);
            }
            catch (EngagementIncompatibleIdException e)
            {
                if (env.IsDevelopment())
                    logger.LogInformation(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status415UnsupportedMediaType,
                    Message = e.Message,
                };

                return StatusCode(erreur.Code.Value, erreur.Message);
            }         
            catch (EngagementNotFoundException e)
            {
                if (env.IsDevelopment())
                    logger.LogInformation(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status404NotFound,
                    Message = e.Message
                };

                return NotFound(erreur);
            }
            catch (DbUpdateConcurrencyException e)
            {
                logger.LogError(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status500InternalServerError,
                    Message = string.Format("L'engagement {0} n'a pas pu être supprimé car il est pris par une autre ressource.", idEngagement)
                };

                return StatusCode(erreur.Code.Value, erreur);
            }
            catch (DbUpdateException e)
            {
                logger.LogError(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status500InternalServerError,
                    Message = "Une erreur est survenue sur le serveur lors de la suppression de l'engagement."
                };

                return StatusCode(erreur.Code.Value, erreur);
            }
            catch (Exception e)
            {
                logger.LogError(e.Message);

                ErreurDTO erreur = new ErreurDTO()
                {
                    Code = StatusCodes.Status500InternalServerError,
                    Message = "Une erreur inconnue est survenue sur le serveur."
                };

                return StatusCode(erreur.Code.Value, erreur);
            }

            if (env.IsDevelopment())
                logger.LogInformation("Update effectué avec succès.");

            return Ok(body);
        }
    }
}