Cutlery/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2025-09-29 15:31:04 -04:00
Code Issues Packages Projects Releases Wiki Activity

Refactor Display preference manager (#14056)

Browse Source
This commit is contained in:
JPVenson 2025-09-05 22:39:15 +02:00 committed by GitHub
parent 4849486fa0
commit 20f7ddbf8f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 102 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Jellyfin.Api/Controllers/DisplayPreferencesController.cs
View File

@ -96,9 +96,6 @@ public class DisplayPreferencesController : BaseJellyfinApiController
dto.CustomPrefs.TryAdd(key, value); dto.CustomPrefs.TryAdd(key, value);
} }
// This will essentially be a noop if no changes have been made, but new prefs must be saved at least.
_displayPreferencesManager.SaveChanges();
return dto; return dto;
} }
@ -210,8 +207,8 @@ public class DisplayPreferencesController : BaseJellyfinApiController
// Set all remaining custom preferences. // Set all remaining custom preferences.
_displayPreferencesManager.SetCustomItemDisplayPreferences(userId.Value, itemId, existingDisplayPreferences.Client, displayPreferences.CustomPrefs); _displayPreferencesManager.SetCustomItemDisplayPreferences(userId.Value, itemId, existingDisplayPreferences.Client, displayPreferences.CustomPrefs);
_displayPreferencesManager.SaveChanges(); _displayPreferencesManager.UpdateItemDisplayPreferences(itemPrefs);
_displayPreferencesManager.UpdateDisplayPreferences(existingDisplayPreferences);
return NoContent(); return NoContent();
} }
} }

173
Jellyfin.Server.Implementations/Users/DisplayPreferencesManager.cs
View File

@ -1,109 +1,116 @@
#pragma warning disable CA1307
#pragma warning disable CA1309
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Threading.Tasks;
using Jellyfin.Database.Implementations; using Jellyfin.Database.Implementations;
using Jellyfin.Database.Implementations.Entities; using Jellyfin.Database.Implementations.Entities;
using MediaBrowser.Controller; using MediaBrowser.Controller;
using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore;
namespace Jellyfin.Server.Implementations.Users namespace Jellyfin.Server.Implementations.Users;
/// <summary>
/// Manages the storage and retrieval of display preferences through Entity Framework.
/// </summary>
public sealed class DisplayPreferencesManager : IDisplayPreferencesManager
{ {
private readonly IDbContextFactory<JellyfinDbContext> _dbContextFactory;
/// <summary> /// <summary>
/// Manages the storage and retrieval of display preferences through Entity Framework. /// Initializes a new instance of the <see cref="DisplayPreferencesManager"/> class.
/// </summary> /// </summary>
public sealed class DisplayPreferencesManager : IDisplayPreferencesManager, IAsyncDisposable /// <param name="dbContextFactory">The database context factory.</param>
public DisplayPreferencesManager(IDbContextFactory<JellyfinDbContext> dbContextFactory)
{ {
private readonly JellyfinDbContext _dbContext; _dbContextFactory = dbContextFactory;
}
/// <summary> /// <inheritdoc />
/// Initializes a new instance of the <see cref="DisplayPreferencesManager"/> class. public DisplayPreferences GetDisplayPreferences(Guid userId, Guid itemId, string client)
/// </summary> {
/// <param name="dbContextFactory">The database context factory.</param> using var dbContext = _dbContextFactory.CreateDbContext();
public DisplayPreferencesManager(IDbContextFactory<JellyfinDbContext> dbContextFactory) var prefs = dbContext.DisplayPreferences
.Include(pref => pref.HomeSections)
.FirstOrDefault(pref =>
pref.UserId.Equals(userId) && pref.Client == client && pref.ItemId.Equals(itemId));
if (prefs is null)
{ {
_dbContext = dbContextFactory.CreateDbContext(); prefs = new DisplayPreferences(userId, itemId, client);
dbContext.DisplayPreferences.Add(prefs);
dbContext.SaveChanges();
} }
/// <inheritdoc /> return prefs;
public DisplayPreferences GetDisplayPreferences(Guid userId, Guid itemId, string client) }
/// <inheritdoc />
public ItemDisplayPreferences GetItemDisplayPreferences(Guid userId, Guid itemId, string client)
{
using var dbContext = _dbContextFactory.CreateDbContext();
var prefs = dbContext.ItemDisplayPreferences
.FirstOrDefault(pref => pref.UserId.Equals(userId) && pref.ItemId.Equals(itemId) && pref.Client == client);
if (prefs is null)
{ {
var prefs = _dbContext.DisplayPreferences prefs = new ItemDisplayPreferences(userId, Guid.Empty, client);
.Include(pref => pref.HomeSections) dbContext.ItemDisplayPreferences.Add(prefs);
.FirstOrDefault(pref => dbContext.SaveChanges();
pref.UserId.Equals(userId) && string.Equals(pref.Client, client) && pref.ItemId.Equals(itemId));
if (prefs is null)
{
prefs = new DisplayPreferences(userId, itemId, client);
_dbContext.DisplayPreferences.Add(prefs);
}
return prefs;
} }
/// <inheritdoc /> return prefs;
public ItemDisplayPreferences GetItemDisplayPreferences(Guid userId, Guid itemId, string client) }
/// <inheritdoc />
public IList<ItemDisplayPreferences> ListItemDisplayPreferences(Guid userId, string client)
{
using var dbContext = _dbContextFactory.CreateDbContext();
return dbContext.ItemDisplayPreferences
.Where(prefs => prefs.UserId.Equals(userId) && !prefs.ItemId.Equals(default) && prefs.Client == client)
.ToList();
}
/// <inheritdoc />
public Dictionary<string, string?> ListCustomItemDisplayPreferences(Guid userId, Guid itemId, string client)
{
using var dbContext = _dbContextFactory.CreateDbContext();
return dbContext.CustomItemDisplayPreferences
.Where(prefs => prefs.UserId.Equals(userId)
&& prefs.ItemId.Equals(itemId)
&& prefs.Client == client)
.ToDictionary(prefs => prefs.Key, prefs => prefs.Value);
}
/// <inheritdoc />
public void SetCustomItemDisplayPreferences(Guid userId, Guid itemId, string client, Dictionary<string, string?> customPreferences)
{
using var dbContext = _dbContextFactory.CreateDbContext();
dbContext.CustomItemDisplayPreferences.Where(prefs => prefs.UserId.Equals(userId)
&& prefs.ItemId.Equals(itemId)
&& prefs.Client == client)
.ExecuteDelete();
foreach (var (key, value) in customPreferences)
{ {
var prefs = _dbContext.ItemDisplayPreferences dbContext.CustomItemDisplayPreferences
.FirstOrDefault(pref => pref.UserId.Equals(userId) && pref.ItemId.Equals(itemId) && string.Equals(pref.Client, client)); .Add(new CustomItemDisplayPreferences(userId, itemId, client, key, value));
if (prefs is null)
{
prefs = new ItemDisplayPreferences(userId, Guid.Empty, client);
_dbContext.ItemDisplayPreferences.Add(prefs);
}
return prefs;
} }
/// <inheritdoc /> dbContext.SaveChanges();
public IList<ItemDisplayPreferences> ListItemDisplayPreferences(Guid userId, string client) }
{
return _dbContext.ItemDisplayPreferences
.Where(prefs => prefs.UserId.Equals(userId) && !prefs.ItemId.Equals(default) && string.Equals(prefs.Client, client))
.ToList();
}
/// <inheritdoc /> /// <inheritdoc/>
public Dictionary<string, string?> ListCustomItemDisplayPreferences(Guid userId, Guid itemId, string client) public void UpdateDisplayPreferences(DisplayPreferences displayPreferences)
{ {
return _dbContext.CustomItemDisplayPreferences using var dbContext = _dbContextFactory.CreateDbContext();
.Where(prefs => prefs.UserId.Equals(userId) dbContext.DisplayPreferences.Attach(displayPreferences).State = EntityState.Modified;
&& prefs.ItemId.Equals(itemId) dbContext.SaveChanges();
&& string.Equals(prefs.Client, client)) }
.ToDictionary(prefs => prefs.Key, prefs => prefs.Value);
}
/// <inheritdoc /> /// <inheritdoc/>
public void SetCustomItemDisplayPreferences(Guid userId, Guid itemId, string client, Dictionary<string, string?> customPreferences) public void UpdateItemDisplayPreferences(ItemDisplayPreferences itemDisplayPreferences)
{ {
var existingPrefs = _dbContext.CustomItemDisplayPreferences using var dbContext = _dbContextFactory.CreateDbContext();
.Where(prefs => prefs.UserId.Equals(userId) dbContext.ItemDisplayPreferences.Attach(itemDisplayPreferences).State = EntityState.Modified;
&& prefs.ItemId.Equals(itemId) dbContext.SaveChanges();
&& string.Equals(prefs.Client, client));
_dbContext.CustomItemDisplayPreferences.RemoveRange(existingPrefs);
foreach (var (key, value) in customPreferences)
{
_dbContext.CustomItemDisplayPreferences
.Add(new CustomItemDisplayPreferences(userId, itemId, client, key, value));
}
}
/// <inheritdoc />
public void SaveChanges()
{
_dbContext.SaveChanges();
}
/// <inheritdoc />
public async ValueTask DisposeAsync()
{
await _dbContext.DisposeAsync().ConfigureAwait(false);
}
} }
} }

2
Jellyfin.Server/CoreAppHost.cs
View File

@ -84,7 +84,7 @@ namespace Jellyfin.Server
serviceCollection.AddSingleton<IAuthenticationProvider, DefaultAuthenticationProvider>(); serviceCollection.AddSingleton<IAuthenticationProvider, DefaultAuthenticationProvider>();
serviceCollection.AddSingleton<IAuthenticationProvider, InvalidAuthProvider>(); serviceCollection.AddSingleton<IAuthenticationProvider, InvalidAuthProvider>();
serviceCollection.AddSingleton<IPasswordResetProvider, DefaultPasswordResetProvider>(); serviceCollection.AddSingleton<IPasswordResetProvider, DefaultPasswordResetProvider>();
serviceCollection.AddScoped<IDisplayPreferencesManager, DisplayPreferencesManager>(); serviceCollection.AddSingleton<IDisplayPreferencesManager, DisplayPreferencesManager>();
serviceCollection.AddSingleton<IDeviceManager, DeviceManager>(); serviceCollection.AddSingleton<IDeviceManager, DeviceManager>();
serviceCollection.AddSingleton<ITrickplayManager, TrickplayManager>(); serviceCollection.AddSingleton<ITrickplayManager, TrickplayManager>();

11
MediaBrowser.Controller/IDisplayPreferencesManager.cs
View File

@ -60,8 +60,15 @@ namespace MediaBrowser.Controller
void SetCustomItemDisplayPreferences(Guid userId, Guid itemId, string client, Dictionary<string, string?> customPreferences); void SetCustomItemDisplayPreferences(Guid userId, Guid itemId, string client, Dictionary<string, string?> customPreferences);
/// <summary> /// <summary>
/// Saves changes made to the database. /// Updates or Creates the display preferences.
/// </summary> /// </summary>
void SaveChanges(); /// <param name="displayPreferences">The entity to update or create.</param>
void UpdateDisplayPreferences(DisplayPreferences displayPreferences);
/// <summary>
/// Updates or Creates the display preferences for the given item.
/// </summary>
/// <param name="itemDisplayPreferences">The entity to update or create.</param>
void UpdateItemDisplayPreferences(ItemDisplayPreferences itemDisplayPreferences);
} }
} }