Merge pull request #2956 from crobibero/api-dlna

Move Emby.Dlna DlnaService.cs to Jellyfin.Api

Emby.Dlna/Api/DlnaService.cs

@@ -1,88 +0,0 @@
-#pragma warning disable CS1591
-
-using System.Diagnostics.CodeAnalysis;
-using System.Linq;
-using MediaBrowser.Controller.Dlna;
-using MediaBrowser.Controller.Net;
-using MediaBrowser.Model.Dlna;
-using MediaBrowser.Model.Services;
-
-namespace Emby.Dlna.Api
-{
-    [Route("/Dlna/ProfileInfos", "GET", Summary = "Gets a list of profiles")]
-    public class GetProfileInfos : IReturn<DeviceProfileInfo[]>
-    {
-    }
-
-    [Route("/Dlna/Profiles/{Id}", "DELETE", Summary = "Deletes a profile")]
-    public class DeleteProfile : IReturnVoid
-    {
-        [ApiMember(Name = "Id", Description = "Profile Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
-        public string Id { get; set; }
-    }
-
-    [Route("/Dlna/Profiles/Default", "GET", Summary = "Gets the default profile")]
-    public class GetDefaultProfile : IReturn<DeviceProfile>
-    {
-    }
-
-    [Route("/Dlna/Profiles/{Id}", "GET", Summary = "Gets a single profile")]
-    public class GetProfile : IReturn<DeviceProfile>
-    {
-        [ApiMember(Name = "Id", Description = "Profile Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string Id { get; set; }
-    }
-
-    [Route("/Dlna/Profiles/{Id}", "POST", Summary = "Updates a profile")]
-    public class UpdateProfile : DeviceProfile, IReturnVoid
-    {
-    }
-
-    [Route("/Dlna/Profiles", "POST", Summary = "Creates a profile")]
-    public class CreateProfile : DeviceProfile, IReturnVoid
-    {
-    }
-
-    [Authenticated(Roles = "Admin")]
-    public class DlnaService : IService
-    {
-        private readonly IDlnaManager _dlnaManager;
-
-        public DlnaService(IDlnaManager dlnaManager)
-        {
-            _dlnaManager = dlnaManager;
-        }
-
-        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "request", Justification = "Required for ServiceStack")]
-        public object Get(GetProfileInfos request)
-        {
-            return _dlnaManager.GetProfileInfos().ToArray();
-        }
-
-        public object Get(GetProfile request)
-        {
-            return _dlnaManager.GetProfile(request.Id);
-        }
-
-        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "request", Justification = "Required for ServiceStack")]
-        public object Get(GetDefaultProfile request)
-        {
-            return _dlnaManager.GetDefaultProfile();
-        }
-
-        public void Delete(DeleteProfile request)
-        {
-            _dlnaManager.DeleteProfile(request.Id);
-        }
-
-        public void Post(UpdateProfile request)
-        {
-            _dlnaManager.UpdateProfile(request);
-        }
-
-        public void Post(CreateProfile request)
-        {
-            _dlnaManager.CreateProfile(request);
-        }
-    }
-}

Jellyfin.Api/Controllers/DlnaController.cs

@@ -0,0 +1,132 @@
+using System.Collections.Generic;
+using Jellyfin.Api.Constants;
+using MediaBrowser.Controller.Dlna;
+using MediaBrowser.Model.Dlna;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Jellyfin.Api.Controllers
+{
+    /// <summary>
+    /// Dlna Controller.
+    /// </summary>
+    [Authorize(Policy = Policies.RequiresElevation)]
+    public class DlnaController : BaseJellyfinApiController
+    {
+        private readonly IDlnaManager _dlnaManager;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DlnaController"/> class.
+        /// </summary>
+        /// <param name="dlnaManager">Instance of the <see cref="IDlnaManager"/> interface.</param>
+        public DlnaController(IDlnaManager dlnaManager)
+        {
+            _dlnaManager = dlnaManager;
+        }
+
+        /// <summary>
+        /// Get profile infos.
+        /// </summary>
+        /// <response code="200">Device profile infos returned.</response>
+        /// <returns>An <see cref="OkResult"/> containing the device profile infos.</returns>
+        [HttpGet("ProfileInfos")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        public ActionResult<IEnumerable<DeviceProfileInfo>> GetProfileInfos()
+        {
+            return Ok(_dlnaManager.GetProfileInfos());
+        }
+
+        /// <summary>
+        /// Gets the default profile.
+        /// </summary>
+        /// <response code="200">Default device profile returned.</response>
+        /// <returns>An <see cref="OkResult"/> containing the default profile.</returns>
+        [HttpGet("Profiles/Default")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        public ActionResult<DeviceProfile> GetDefaultProfile()
+        {
+            return _dlnaManager.GetDefaultProfile();
+        }
+
+        /// <summary>
+        /// Gets a single profile.
+        /// </summary>
+        /// <param name="profileId">Profile Id.</param>
+        /// <response code="200">Device profile returned.</response>
+        /// <response code="404">Device profile not found.</response>
+        /// <returns>An <see cref="OkResult"/> containing the profile on success, or a <see cref="NotFoundResult"/> if device profile not found.</returns>
+        [HttpGet("Profiles/{profileId}")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public ActionResult<DeviceProfile> GetProfile([FromRoute] string profileId)
+        {
+            var profile = _dlnaManager.GetProfile(profileId);
+            if (profile == null)
+            {
+                return NotFound();
+            }
+
+            return profile;
+        }
+
+        /// <summary>
+        /// Deletes a profile.
+        /// </summary>
+        /// <param name="profileId">Profile id.</param>
+        /// <response code="204">Device profile deleted.</response>
+        /// <response code="404">Device profile not found.</response>
+        /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if profile not found.</returns>
+        [HttpDelete("Profiles/{profileId}")]
+        [ProducesResponseType(StatusCodes.Status204NoContent)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public ActionResult DeleteProfile([FromRoute] string profileId)
+        {
+            var existingDeviceProfile = _dlnaManager.GetProfile(profileId);
+            if (existingDeviceProfile == null)
+            {
+                return NotFound();
+            }
+
+            _dlnaManager.DeleteProfile(profileId);
+            return NoContent();
+        }
+
+        /// <summary>
+        /// Creates a profile.
+        /// </summary>
+        /// <param name="deviceProfile">Device profile.</param>
+        /// <response code="204">Device profile created.</response>
+        /// <returns>A <see cref="NoContentResult"/>.</returns>
+        [HttpPost("Profiles")]
+        [ProducesResponseType(StatusCodes.Status204NoContent)]
+        public ActionResult CreateProfile([FromBody] DeviceProfile deviceProfile)
+        {
+            _dlnaManager.CreateProfile(deviceProfile);
+            return NoContent();
+        }
+
+        /// <summary>
+        /// Updates a profile.
+        /// </summary>
+        /// <param name="profileId">Profile id.</param>
+        /// <param name="deviceProfile">Device profile.</param>
+        /// <response code="204">Device profile updated.</response>
+        /// <response code="404">Device profile not found.</response>
+        /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if profile not found.</returns>
+        [HttpPost("Profiles/{profileId}")]
+        [ProducesResponseType(StatusCodes.Status204NoContent)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public ActionResult UpdateProfile([FromRoute] string profileId, [FromBody] DeviceProfile deviceProfile)
+        {
+            var existingDeviceProfile = _dlnaManager.GetProfile(profileId);
+            if (existingDeviceProfile == null)
+            {
+                return NotFound();
+            }
+
+            _dlnaManager.UpdateProfile(deviceProfile);
+            return NoContent();
+        }
+    }
+}