Rewrite device manager using EF Core

This commit is contained in:
Patrick Barron 2021-04-10 16:17:36 -04:00
parent f47fe308b1
commit 44e71774b1
9 changed files with 89 additions and 80 deletions

View File

@ -644,8 +644,6 @@ namespace Emby.Server.Implementations
ServiceCollection.AddSingleton<ITVSeriesManager, TVSeriesManager>(); ServiceCollection.AddSingleton<ITVSeriesManager, TVSeriesManager>();
ServiceCollection.AddSingleton<IDeviceManager, DeviceManager>();
ServiceCollection.AddSingleton<IMediaSourceManager, MediaSourceManager>(); ServiceCollection.AddSingleton<IMediaSourceManager, MediaSourceManager>();
ServiceCollection.AddSingleton<ISubtitleManager, SubtitleManager>(); ServiceCollection.AddSingleton<ISubtitleManager, SubtitleManager>();

View File

@ -6,9 +6,9 @@ using System.Globalization;
using System.IO; using System.IO;
using System.Linq; using System.Linq;
using Emby.Server.Implementations.Data; using Emby.Server.Implementations.Data;
using Jellyfin.Data.Entities.Security;
using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Security; using MediaBrowser.Controller.Security;
using MediaBrowser.Model.Devices;
using MediaBrowser.Model.Querying; using MediaBrowser.Model.Querying;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using SQLitePCL.pretty; using SQLitePCL.pretty;
@ -357,7 +357,7 @@ namespace Emby.Server.Implementations.Security
{ {
statement.TryBind("@DeviceId", deviceId); statement.TryBind("@DeviceId", deviceId);
var result = new DeviceOptions(); var result = new DeviceOptions(deviceId);
foreach (var row in statement.ExecuteQuery()) foreach (var row in statement.ExecuteQuery())
{ {

View File

@ -8,6 +8,7 @@ using System.Linq;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using Jellyfin.Data.Entities; using Jellyfin.Data.Entities;
using Jellyfin.Data.Entities.Security;
using Jellyfin.Data.Enums; using Jellyfin.Data.Enums;
using Jellyfin.Data.Events; using Jellyfin.Data.Events;
using MediaBrowser.Common.Events; using MediaBrowser.Common.Events;
@ -24,7 +25,6 @@ using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Net; using MediaBrowser.Controller.Net;
using MediaBrowser.Controller.Security; using MediaBrowser.Controller.Security;
using MediaBrowser.Controller.Session; using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Devices;
using MediaBrowser.Model.Dto; using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Entities; using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Library; using MediaBrowser.Model.Library;

View File

@ -1,6 +1,8 @@
using System; using System;
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
using System.Threading.Tasks;
using Jellyfin.Api.Constants; using Jellyfin.Api.Constants;
using Jellyfin.Data.Entities.Security;
using MediaBrowser.Controller.Devices; using MediaBrowser.Controller.Devices;
using MediaBrowser.Controller.Security; using MediaBrowser.Controller.Security;
using MediaBrowser.Controller.Session; using MediaBrowser.Controller.Session;
@ -47,10 +49,10 @@ namespace Jellyfin.Api.Controllers
/// <returns>An <see cref="OkResult"/> containing the list of devices.</returns> /// <returns>An <see cref="OkResult"/> containing the list of devices.</returns>
[HttpGet] [HttpGet]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
public ActionResult<QueryResult<DeviceInfo>> GetDevices([FromQuery] bool? supportsSync, [FromQuery] Guid? userId) public async Task<ActionResult<QueryResult<DeviceInfo>>> GetDevices([FromQuery] bool? supportsSync, [FromQuery] Guid? userId)
{ {
var deviceQuery = new DeviceQuery { SupportsSync = supportsSync, UserId = userId ?? Guid.Empty }; var deviceQuery = new DeviceQuery { SupportsSync = supportsSync, UserId = userId ?? Guid.Empty };
return _deviceManager.GetDevices(deviceQuery); return await _deviceManager.GetDevices(deviceQuery);
} }
/// <summary> /// <summary>
@ -63,9 +65,9 @@ namespace Jellyfin.Api.Controllers
[HttpGet("Info")] [HttpGet("Info")]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status404NotFound)]
public ActionResult<DeviceInfo> GetDeviceInfo([FromQuery, Required] string id) public async Task<ActionResult<DeviceInfo>> GetDeviceInfo([FromQuery, Required] string id)
{ {
var deviceInfo = _deviceManager.GetDevice(id); var deviceInfo = await _deviceManager.GetDevice(id).ConfigureAwait(false);
if (deviceInfo == null) if (deviceInfo == null)
{ {
return NotFound(); return NotFound();
@ -106,7 +108,7 @@ namespace Jellyfin.Api.Controllers
[HttpPost("Options")] [HttpPost("Options")]
[ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status404NotFound)]
public ActionResult UpdateDeviceOptions( public async Task<ActionResult> UpdateDeviceOptions(
[FromQuery, Required] string id, [FromQuery, Required] string id,
[FromBody, Required] DeviceOptions deviceOptions) [FromBody, Required] DeviceOptions deviceOptions)
{ {
@ -116,7 +118,7 @@ namespace Jellyfin.Api.Controllers
return NotFound(); return NotFound();
} }
_deviceManager.UpdateDeviceOptions(id, deviceOptions); await _deviceManager.UpdateDeviceOptions(id, deviceOptions).ConfigureAwait(false);
return NoContent(); return NoContent();
} }

View File

@ -1,78 +1,100 @@
#pragma warning disable CS1591
using System; using System;
using System.Collections.Concurrent; using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Threading.Tasks;
using Jellyfin.Data.Entities; using Jellyfin.Data.Entities;
using Jellyfin.Data.Entities.Security;
using Jellyfin.Data.Enums; using Jellyfin.Data.Enums;
using Jellyfin.Data.Events; using Jellyfin.Data.Events;
using MediaBrowser.Controller.Devices; using MediaBrowser.Controller.Devices;
using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Security;
using MediaBrowser.Model.Devices; using MediaBrowser.Model.Devices;
using MediaBrowser.Model.Querying; using MediaBrowser.Model.Querying;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
using Microsoft.EntityFrameworkCore;
namespace Emby.Server.Implementations.Devices namespace Jellyfin.Server.Implementations.Devices
{ {
public class DeviceManager : IDeviceManager public class DeviceManager : IDeviceManager
{ {
private readonly JellyfinDbProvider _dbProvider;
private readonly IUserManager _userManager; private readonly IUserManager _userManager;
private readonly IAuthenticationRepository _authRepo;
private readonly ConcurrentDictionary<string, ClientCapabilities> _capabilitiesMap = new (); private readonly ConcurrentDictionary<string, ClientCapabilities> _capabilitiesMap = new ();
public DeviceManager(IAuthenticationRepository authRepo, IUserManager userManager) /// <summary>
/// Initializes a new instance of the <see cref="DeviceManager"/> class.
/// </summary>
/// <param name="dbProvider">The database provider.</param>
/// <param name="userManager">The user manager.</param>
public DeviceManager(JellyfinDbProvider dbProvider, IUserManager userManager)
{ {
_dbProvider = dbProvider;
_userManager = userManager; _userManager = userManager;
_authRepo = authRepo;
} }
public event EventHandler<GenericEventArgs<Tuple<string, DeviceOptions>>> DeviceOptionsUpdated; /// <inheritdoc />
public event EventHandler<GenericEventArgs<Tuple<string, DeviceOptions>>>? DeviceOptionsUpdated;
/// <inheritdoc />
public void SaveCapabilities(string deviceId, ClientCapabilities capabilities) public void SaveCapabilities(string deviceId, ClientCapabilities capabilities)
{ {
_capabilitiesMap[deviceId] = capabilities; _capabilitiesMap[deviceId] = capabilities;
} }
public void UpdateDeviceOptions(string deviceId, DeviceOptions options) /// <inheritdoc />
public async Task UpdateDeviceOptions(string deviceId, DeviceOptions options)
{ {
_authRepo.UpdateDeviceOptions(deviceId, options); await using var dbContext = _dbProvider.CreateContext();
await dbContext.Database
.ExecuteSqlRawAsync($"UPDATE [DeviceOptions] SET [CustomName] = ${options.CustomName}")
.ConfigureAwait(false);
DeviceOptionsUpdated?.Invoke(this, new GenericEventArgs<Tuple<string, DeviceOptions>>(new Tuple<string, DeviceOptions>(deviceId, options))); DeviceOptionsUpdated?.Invoke(this, new GenericEventArgs<Tuple<string, DeviceOptions>>(new Tuple<string, DeviceOptions>(deviceId, options)));
} }
public DeviceOptions GetDeviceOptions(string deviceId) /// <inheritdoc />
public DeviceOptions? GetDeviceOptions(string deviceId)
{ {
return _authRepo.GetDeviceOptions(deviceId); using var dbContext = _dbProvider.CreateContext();
return dbContext.DeviceOptions
.AsQueryable()
.FirstOrDefault(d => d.DeviceId == deviceId);
} }
/// <inheritdoc />
public ClientCapabilities GetCapabilities(string id) public ClientCapabilities GetCapabilities(string id)
{ {
return _capabilitiesMap.TryGetValue(id, out ClientCapabilities result) return _capabilitiesMap.TryGetValue(id, out ClientCapabilities? result)
? result ? result
: new ClientCapabilities(); : new ClientCapabilities();
} }
public DeviceInfo GetDevice(string id) /// <inheritdoc />
public async Task<DeviceInfo?> GetDevice(string id)
{ {
var session = _authRepo.Get(new AuthenticationInfoQuery await using var dbContext = _dbProvider.CreateContext();
{ var device = await dbContext.Devices
DeviceId = id .AsQueryable()
}).Items.FirstOrDefault(); .Where(d => d.DeviceId == id)
.OrderByDescending(d => d.DateLastActivity)
.Include(d => d.User)
.FirstOrDefaultAsync()
.ConfigureAwait(false);
var device = session == null ? null : ToDeviceInfo(session); var deviceInfo = device == null ? null : ToDeviceInfo(device);
return device; return deviceInfo;
} }
public QueryResult<DeviceInfo> GetDevices(DeviceQuery query) /// <inheritdoc />
public async Task<QueryResult<DeviceInfo>> GetDevices(DeviceQuery query)
{ {
IEnumerable<AuthenticationInfo> sessions = _authRepo.Get(new AuthenticationInfoQuery await using var dbContext = _dbProvider.CreateContext();
{ var sessions = dbContext.Devices
// UserId = query.UserId .AsQueryable()
HasUser = true .OrderBy(d => d.DeviceId)
}).Items; .ThenByDescending(d => d.DateLastActivity)
.AsAsyncEnumerable();
// TODO: DeviceQuery doesn't seem to be used from client. Not even Swagger. // TODO: DeviceQuery doesn't seem to be used from client. Not even Swagger.
if (query.SupportsSync.HasValue) if (query.SupportsSync.HasValue)
@ -89,28 +111,12 @@ namespace Emby.Server.Implementations.Devices
sessions = sessions.Where(i => CanAccessDevice(user, i.DeviceId)); sessions = sessions.Where(i => CanAccessDevice(user, i.DeviceId));
} }
var array = sessions.Select(ToDeviceInfo).ToArray(); var array = await sessions.Select(ToDeviceInfo).ToArrayAsync();
return new QueryResult<DeviceInfo>(array); return new QueryResult<DeviceInfo>(array);
} }
private DeviceInfo ToDeviceInfo(AuthenticationInfo authInfo) /// <inheritdoc />
{
var caps = GetCapabilities(authInfo.DeviceId);
return new DeviceInfo
{
AppName = authInfo.AppName,
AppVersion = authInfo.AppVersion,
Id = authInfo.DeviceId,
LastUserId = authInfo.UserId,
LastUserName = authInfo.UserName,
Name = authInfo.DeviceName,
DateLastActivity = authInfo.DateLastActivity,
IconUrl = caps?.IconUrl
};
}
public bool CanAccessDevice(User user, string deviceId) public bool CanAccessDevice(User user, string deviceId)
{ {
if (user == null) if (user == null)
@ -128,17 +134,25 @@ namespace Emby.Server.Implementations.Devices
return true; return true;
} }
if (!user.GetPreference(PreferenceKind.EnabledDevices).Contains(deviceId, StringComparer.OrdinalIgnoreCase)) return user.GetPreference(PreferenceKind.EnabledDevices).Contains(deviceId, StringComparer.OrdinalIgnoreCase)
|| !GetCapabilities(deviceId).SupportsPersistentIdentifier;
}
private DeviceInfo ToDeviceInfo(Device authInfo)
{
var caps = GetCapabilities(authInfo.DeviceId);
return new DeviceInfo
{ {
var capabilities = GetCapabilities(deviceId); AppName = authInfo.AppName,
AppVersion = authInfo.AppVersion,
if (capabilities != null && capabilities.SupportsPersistentIdentifier) Id = authInfo.DeviceId,
{ LastUserId = authInfo.UserId,
return false; LastUserName = authInfo.User.Username,
} Name = authInfo.DeviceName,
} DateLastActivity = authInfo.DateLastActivity,
IconUrl = caps.IconUrl
return true; };
} }
} }
} }

View File

@ -9,10 +9,12 @@ using Jellyfin.Api.WebSocketListeners;
using Jellyfin.Drawing.Skia; using Jellyfin.Drawing.Skia;
using Jellyfin.Server.Implementations; using Jellyfin.Server.Implementations;
using Jellyfin.Server.Implementations.Activity; using Jellyfin.Server.Implementations.Activity;
using Jellyfin.Server.Implementations.Devices;
using Jellyfin.Server.Implementations.Events; using Jellyfin.Server.Implementations.Events;
using Jellyfin.Server.Implementations.Users; using Jellyfin.Server.Implementations.Users;
using MediaBrowser.Controller; using MediaBrowser.Controller;
using MediaBrowser.Controller.BaseItemManager; using MediaBrowser.Controller.BaseItemManager;
using MediaBrowser.Controller.Devices;
using MediaBrowser.Controller.Drawing; using MediaBrowser.Controller.Drawing;
using MediaBrowser.Controller.Events; using MediaBrowser.Controller.Events;
using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Library;
@ -84,6 +86,7 @@ namespace Jellyfin.Server
ServiceCollection.AddSingleton<IActivityManager, ActivityManager>(); ServiceCollection.AddSingleton<IActivityManager, ActivityManager>();
ServiceCollection.AddSingleton<IUserManager, UserManager>(); ServiceCollection.AddSingleton<IUserManager, UserManager>();
ServiceCollection.AddSingleton<IDisplayPreferencesManager, DisplayPreferencesManager>(); ServiceCollection.AddSingleton<IDisplayPreferencesManager, DisplayPreferencesManager>();
ServiceCollection.AddSingleton<IDeviceManager, DeviceManager>();
// TODO search the assemblies instead of adding them manually? // TODO search the assemblies instead of adding them manually?
ServiceCollection.AddSingleton<IWebSocketListener, SessionWebSocketListener>(); ServiceCollection.AddSingleton<IWebSocketListener, SessionWebSocketListener>();

View File

@ -1,7 +1,9 @@
#pragma warning disable CS1591 #pragma warning disable CS1591
using System; using System;
using System.Threading.Tasks;
using Jellyfin.Data.Entities; using Jellyfin.Data.Entities;
using Jellyfin.Data.Entities.Security;
using Jellyfin.Data.Events; using Jellyfin.Data.Events;
using MediaBrowser.Model.Devices; using MediaBrowser.Model.Devices;
using MediaBrowser.Model.Querying; using MediaBrowser.Model.Querying;
@ -18,7 +20,6 @@ namespace MediaBrowser.Controller.Devices
/// </summary> /// </summary>
/// <param name="reportedId">The reported identifier.</param> /// <param name="reportedId">The reported identifier.</param>
/// <param name="capabilities">The capabilities.</param> /// <param name="capabilities">The capabilities.</param>
/// <returns>Task.</returns>
void SaveCapabilities(string reportedId, ClientCapabilities capabilities); void SaveCapabilities(string reportedId, ClientCapabilities capabilities);
/// <summary> /// <summary>
@ -33,21 +34,21 @@ namespace MediaBrowser.Controller.Devices
/// </summary> /// </summary>
/// <param name="id">The identifier.</param> /// <param name="id">The identifier.</param>
/// <returns>DeviceInfo.</returns> /// <returns>DeviceInfo.</returns>
DeviceInfo GetDevice(string id); Task<DeviceInfo> GetDevice(string id);
/// <summary> /// <summary>
/// Gets the devices. /// Gets the devices.
/// </summary> /// </summary>
/// <param name="query">The query.</param> /// <param name="query">The query.</param>
/// <returns>IEnumerable&lt;DeviceInfo&gt;.</returns> /// <returns>IEnumerable&lt;DeviceInfo&gt;.</returns>
QueryResult<DeviceInfo> GetDevices(DeviceQuery query); Task<QueryResult<DeviceInfo>> GetDevices(DeviceQuery query);
/// <summary> /// <summary>
/// Determines whether this instance [can access device] the specified user identifier. /// Determines whether this instance [can access device] the specified user identifier.
/// </summary> /// </summary>
bool CanAccessDevice(User user, string deviceId); bool CanAccessDevice(User user, string deviceId);
void UpdateDeviceOptions(string deviceId, DeviceOptions options); Task UpdateDeviceOptions(string deviceId, DeviceOptions options);
DeviceOptions GetDeviceOptions(string deviceId); DeviceOptions GetDeviceOptions(string deviceId);
} }

View File

@ -1,6 +1,6 @@
#pragma warning disable CS1591 #pragma warning disable CS1591
using MediaBrowser.Model.Devices; using Jellyfin.Data.Entities.Security;
using MediaBrowser.Model.Querying; using MediaBrowser.Model.Querying;
namespace MediaBrowser.Controller.Security namespace MediaBrowser.Controller.Security

View File

@ -1,9 +0,0 @@
#pragma warning disable CS1591
namespace MediaBrowser.Model.Devices
{
public class DeviceOptions
{
public string? CustomName { get; set; }
}
}