xFileService/Controllers/XFileServiceControllerBase.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using xCommons.Configurations;
using xCommons.Extensions;
using xCommons.Providers;
using xFileService.Interfaces;
using xIdentityService.Controllers;
using xIdentityService.Interfaces;
using xModels.Dtos;
using XFileDto = xFileService.Models.Dtos.XFileDto;

namespace xFileService.Controllers
{
    /// <summary>
    /// a Controller base Class which implement based Actions to Provides File Provider Access ...
    /// </summary>
    public abstract class XFileServiceControllerBase : XIBaseProviderController, IXFileServiceControllerActions
    {
        //
        #region Props ...
        public IXFileProvider FileProvider { get; }
        #endregion

        //
        #region Constructor ...
        protected XFileServiceControllerBase(
            ILogger logger,
            IXFileProvider fileProvider,
            XAppConfiguration appConfiguration,
            IXIdentityProvider identityProvider,
            XValidationProvider validationProvider
        ) : base(
            logger,
            appConfiguration,
            identityProvider,
            validationProvider
        )
        {
            //
            FileProvider = fileProvider;
        }
        #endregion

        //
        #region Tags ...
        /// <summary>
        /// Attach Tag to Specified Model ...
        /// </summary>
        /// <param name="id"></param>
        /// <param name="tag"></param>
        /// <returns></returns>
        [HttpPost("{id}/Tags/Attach")]
        public virtual async Task<ActionResult> AttachTag(
            [FromRoute] Guid id,
            [FromQuery] string tag
        )
        {
            //
            // Do ...
            try
            {
                //
                // Retrieve User Info ...
                var userInfo = await GetUserInfo();
                var connectionId = GetConnectionId();
                bool isAdmin = userInfo.Roles.Any(r => r.ToNormalString() == "admin");
                var userId = userInfo.UserId;

                //
                await FileProvider.AttachTag(
                    id: id,
                    tag: tag,
                    userInfo: userInfo,
                    connectionId: connectionId
                );

                //
                return Ok();
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// Detach Tag From Specified Model ...
        /// </summary>
        /// <param name="tag"></param>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpDelete("{id}/Tags/Detach")]
        public virtual async Task<ActionResult> DetachTag(
            [FromRoute] Guid id,
            [FromQuery] string tag
        )
        {
            //
            // Do ...
            try
            {
                //
                // Retrieve User Info ...
                var userInfo = await GetUserInfo();
                var connectionId = GetConnectionId();
                bool isAdmin = userInfo.Roles.Any(r => r.ToNormalString() == "admin");
                var userId = userInfo.UserId;

                //
                await FileProvider.DetachTag(
                    id: id,
                    tag: tag,
                    userInfo: userInfo,
                    connectionId: connectionId
                );

                //
                return Ok();
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// Attach Tags to Specified Model ...
        /// </summary>
        /// <param name="tags"></param>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpPost("{id}/Tags/AttachMany")]
        public virtual async Task<ActionResult> AttachTags(
            [FromRoute] Guid id,
            [FromQuery] string tags
        )
        {
            //
            // Do ...
            try
            {
                //
                var tagsList = tags.ParseListString<string>();

                //
                // Retrieve User Info ...
                var userInfo = await GetUserInfo();
                var connectionId = GetConnectionId();
                bool isAdmin = userInfo.Roles.Any(r => r.ToNormalString() == "admin");
                var userId = userInfo.UserId;

                //
                await FileProvider.AttachTags(
                    id: id,
                    tags: tagsList,
                    userInfo: userInfo,
                    connectionId: connectionId
                );

                //
                return Ok();
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// Detach Tags From Specified Model ...
        /// </summary>
        /// <param name="tags"></param>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpDelete("{id}/Tags/DetachMany")]
        public virtual async Task<ActionResult> DetachTags(
            [FromRoute] Guid id,
            [FromQuery] string tags
        )
        {
            //
            // Do ...
            try
            {
                //
                var tagsList = tags.ParseListString<string>();

                //
                // Retrieve User Info ...
                var userInfo = await GetUserInfo();
                var connectionId = GetConnectionId();
                bool isAdmin = userInfo.Roles.Any(r => r.ToNormalString() == "admin");
                var userId = userInfo.UserId;

                //
                await FileProvider.DetachTags(
                    id: id,
                    tags: tagsList,
                    userInfo: userInfo,
                    connectionId: connectionId
                );

                //
                return Ok();
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }
        
        /// <summary>
        /// Retrieve Tags of Specified File ...
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet("{id}/Tags")]
        public virtual async Task<ActionResult<IEnumerable<string>>> GetTags(
            [FromRoute] Guid id
        )
        {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.GetTags(id);

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }            
        }        
        #endregion

        //
        #region Tools ...
        /// <summary>
        /// Stream Specified File ...
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet("{id}/Stream/ById")]
        public virtual async Task<ActionResult> Stream(
            [FromRoute] Guid id
        )
        {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.Stream(id);

                //
                return result;
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// Stream Specified File ...
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet("{name}/Stream/ByName")]
        public virtual async Task<ActionResult> Stream(
            [FromRoute] string name
        )
        {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.Stream(name);

                //
                return result;
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// Download Specified File ...
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet("{id}/Download/ById")]
        public virtual async Task<ActionResult> Download(
            [FromRoute] Guid id
        )
        {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.Download(id);

                //
                return result;
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// Download Specified File ...
        /// </summary>
        /// <param name="fileName"></param>
        /// <returns></returns>
        [HttpGet("{name}/Download/ByName")]
        public virtual async Task<ActionResult> Download(
            [FromRoute] string name
        )
        {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.Download(name);

                //
                return result;
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }
        
        /// <summary>
        /// Upload Files ...
        /// </summary>
        /// <param name="files"></param>
        /// <returns></returns>
        [HttpPost("")]
        [RequestSizeLimit(966_367_641)]
        public virtual async Task<ActionResult<IEnumerable<XFileDto>>> Upload(
            [FromForm] IFormFileCollection files
        )
        {
            //
            // Do ...
            try
            {
                //
                // Retrieve User Info ...
                var userInfo = await GetUserInfo();
                var connectionId = GetConnectionId();
                bool isAdmin = userInfo.Roles.Any(r => r.ToNormalString() == "admin");
                var userId = userInfo.UserId;

                //
                var result = await FileProvider.Upload(
                    files: files,
                    userInfo: userInfo,
                    connectionId: connectionId
                );

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }            
        }
                
        /// <summary>
        /// Remove Specified Files ...
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>
        /// [HttpDelete("Remove")]
        [HttpDelete("")]
        public virtual async Task<ActionResult<IEnumerable<Guid>>> Remove(
            [FromQuery] string ids
        ) {
            //
            // Do ...
            try
            {
                //
                // Retrieve User Info ...
                var userInfo = await GetUserInfo();
                var connectionId = GetConnectionId();
                bool isAdmin = userInfo.Roles.Any(r => r.ToNormalString() == "admin");
                var userId = userInfo.UserId;

                //
                var result = await FileProvider.Remove(
                    ids: ids,
                    userInfo: userInfo,
                    connectionId: connectionId
                );

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }            
        }
        #endregion
        
        //
        #region Model ...
        /// <summary>
        /// Get Specified File Model ...
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet("{id}")]
        public virtual async Task<ActionResult<XFileDto>> Get(
            [FromRoute] Guid id
        ) {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.Get(id);

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }        

        /// <summary>
        /// Get All Exists File Models ...
        /// </summary>
        /// <returns></returns>
        [HttpGet("All")]
        public virtual async Task<ActionResult<IEnumerable<XFileDto>>> GetAll() {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.GetAll();

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// retrieve Entities based on XQuery Pagination structure ...
        /// </summary>
        /// <param name="query"></param>
        /// <returns></returns>
        [HttpGet("Query")]
        public virtual async Task<ActionResult<XQueryResult<XFileDto>>> Query(
            [FromQuery] XQuery query
        ) {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.Query(query);

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// retrieve Owned Entities based on XQuery Pagination structure ...
        /// </summary>
        /// <param name="query"></param>
        /// <returns></returns>
        [HttpGet("Query/Owned")]
        public virtual async Task<ActionResult<XQueryResult<XFileDto>>> QueryOwned(
            [FromQuery] XQuery query
        ) {
            //
            // Do ...
            try
            {
                //
                // Retrieve User Info ...
                var userInfo = await GetUserInfo();
                
                                //
                var result = await FileProvider.QueryOwned(
                    query: query,
                    userInfo: userInfo
                );

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// count all exists Entities ...
        /// </summary>
        /// <returns></returns>
        [HttpGet("Count")]
        public virtual async Task<ActionResult<int>> Count() {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.Count();

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }

        /// <summary>
        /// Check an Entity exists or not ...
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet("{id}/IsExists")]
        public virtual async Task<ActionResult<bool>> IsExists(
            [FromRoute] Guid id
        ) {
            //
            // Do ...
            try
            {
                //
                var result = await FileProvider.IsExists(id);

                //
                return Ok(result
                    .ToDynamicObject());
            }
            catch (Exception ex)
            {
                //
                var result = GetExceptionActionResult(ex);
                return result;
            }
        }        
        #endregion
    }
}