< Summary - Jellyfin

Information
Class: Jellyfin.Server.Migrations.Routines.MigrateDisplayPreferencesDb
Assembly: jellyfin
File(s): /srv/git/jellyfin/Jellyfin.Server/Migrations/Routines/MigrateDisplayPreferencesDb.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 116
Coverable lines: 116
Total lines: 224
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 50
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
Perform()0%2550500%

File(s)

/srv/git/jellyfin/Jellyfin.Server/Migrations/Routines/MigrateDisplayPreferencesDb.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.IO;
 4using System.Linq;
 5using System.Text.Json;
 6using System.Text.Json.Serialization;
 7using Emby.Server.Implementations.Data;
 8using Jellyfin.Database.Implementations;
 9using Jellyfin.Database.Implementations.Entities;
 10using Jellyfin.Database.Implementations.Enums;
 11using MediaBrowser.Controller;
 12using MediaBrowser.Controller.Library;
 13using MediaBrowser.Model.Dto;
 14using Microsoft.Data.Sqlite;
 15using Microsoft.EntityFrameworkCore;
 16using Microsoft.Extensions.Logging;
 17
 18namespace Jellyfin.Server.Migrations.Routines
 19{
 20    /// <summary>
 21    /// The migration routine for migrating the display preferences database to EF Core.
 22    /// </summary>
 23#pragma warning disable CS0618 // Type or member is obsolete
 24    [JellyfinMigration("2025-04-20T12:00:00", nameof(MigrateDisplayPreferencesDb), "06387815-C3CC-421F-A888-FB5F9992BEA8
 25    public class MigrateDisplayPreferencesDb : IMigrationRoutine
 26#pragma warning restore CS0618 // Type or member is obsolete
 27    {
 28        private const string DbFilename = "displaypreferences.db";
 29
 30        private readonly ILogger<MigrateDisplayPreferencesDb> _logger;
 31        private readonly IServerApplicationPaths _paths;
 32        private readonly IDbContextFactory<JellyfinDbContext> _provider;
 33        private readonly JsonSerializerOptions _jsonOptions;
 34        private readonly IUserManager _userManager;
 35
 36        /// <summary>
 37        /// Initializes a new instance of the <see cref="MigrateDisplayPreferencesDb"/> class.
 38        /// </summary>
 39        /// <param name="logger">The logger.</param>
 40        /// <param name="paths">The server application paths.</param>
 41        /// <param name="provider">The database provider.</param>
 42        /// <param name="userManager">The user manager.</param>
 43        public MigrateDisplayPreferencesDb(
 44            ILogger<MigrateDisplayPreferencesDb> logger,
 45            IServerApplicationPaths paths,
 46            IDbContextFactory<JellyfinDbContext> provider,
 47            IUserManager userManager)
 48        {
 049            _logger = logger;
 050            _paths = paths;
 051            _provider = provider;
 052            _userManager = userManager;
 053            _jsonOptions = new JsonSerializerOptions();
 054            _jsonOptions.Converters.Add(new JsonStringEnumConverter());
 055        }
 56
 57        /// <inheritdoc />
 58        public void Perform()
 59        {
 060            HomeSectionType[] defaults =
 061            {
 062                HomeSectionType.SmallLibraryTiles,
 063                HomeSectionType.Resume,
 064                HomeSectionType.ResumeAudio,
 065                HomeSectionType.LiveTv,
 066                HomeSectionType.NextUp,
 067                HomeSectionType.LatestMedia,
 068                HomeSectionType.None,
 069            };
 70
 071            var chromecastDict = new Dictionary<string, ChromecastVersion>(StringComparer.OrdinalIgnoreCase)
 072            {
 073                { "stable", ChromecastVersion.Stable },
 074                { "nightly", ChromecastVersion.Unstable },
 075                { "unstable", ChromecastVersion.Unstable }
 076            };
 77
 078            var displayPrefs = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 079            var customDisplayPrefs = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 080            var dbFilePath = Path.Combine(_paths.DataPath, DbFilename);
 081            using (var connection = new SqliteConnection($"Filename={dbFilePath}"))
 82            {
 083                connection.Open();
 084                using var dbContext = _provider.CreateDbContext();
 85
 086                var results = connection.Query("SELECT * FROM userdisplaypreferences");
 087                foreach (var result in results)
 88                {
 089                    var dto = JsonSerializer.Deserialize<DisplayPreferencesDto>(result.GetStream(3), _jsonOptions);
 090                    if (dto is null)
 91                    {
 92                        continue;
 93                    }
 94
 095                    var itemId = result.GetGuid(1);
 096                    var dtoUserId = itemId;
 097                    var client = result.GetString(2);
 098                    var displayPreferencesKey = $"{dtoUserId}|{itemId}|{client}";
 099                    if (displayPrefs.Contains(displayPreferencesKey))
 100                    {
 101                        // Duplicate display preference.
 102                        continue;
 103                    }
 104
 0105                    displayPrefs.Add(displayPreferencesKey);
 0106                    var existingUser = _userManager.GetUserById(dtoUserId);
 0107                    if (existingUser is null)
 108                    {
 0109                        _logger.LogWarning("User with ID {UserId} does not exist in the database, skipping migration.", 
 0110                        continue;
 111                    }
 112
 0113                    var chromecastVersion = dto.CustomPrefs.TryGetValue("chromecastVersion", out var version)
 0114                                            && !string.IsNullOrEmpty(version)
 0115                        ? chromecastDict[version]
 0116                        : ChromecastVersion.Stable;
 0117                    dto.CustomPrefs.Remove("chromecastVersion");
 118
 0119                    var displayPreferences = new DisplayPreferences(dtoUserId, itemId, client)
 0120                    {
 0121                        IndexBy = Enum.TryParse<IndexingKind>(dto.IndexBy, true, out var indexBy) ? indexBy : null,
 0122                        ShowBackdrop = dto.ShowBackdrop,
 0123                        ShowSidebar = dto.ShowSidebar,
 0124                        ScrollDirection = dto.ScrollDirection,
 0125                        ChromecastVersion = chromecastVersion,
 0126                        SkipForwardLength = dto.CustomPrefs.TryGetValue("skipForwardLength", out var length) && int.TryP
 0127                            ? skipForwardLength
 0128                            : 30000,
 0129                        SkipBackwardLength = dto.CustomPrefs.TryGetValue("skipBackLength", out length) && int.TryParse(l
 0130                            ? skipBackwardLength
 0131                            : 10000,
 0132                        EnableNextVideoInfoOverlay = !dto.CustomPrefs.TryGetValue("enableNextVideoInfoOverlay", out var 
 0133                        DashboardTheme = dto.CustomPrefs.TryGetValue("dashboardtheme", out var theme) ? theme : string.E
 0134                        TvHome = dto.CustomPrefs.TryGetValue("tvhome", out var home) ? home : string.Empty
 0135                    };
 136
 0137                    dto.CustomPrefs.Remove("skipForwardLength");
 0138                    dto.CustomPrefs.Remove("skipBackLength");
 0139                    dto.CustomPrefs.Remove("enableNextVideoInfoOverlay");
 0140                    dto.CustomPrefs.Remove("dashboardtheme");
 0141                    dto.CustomPrefs.Remove("tvhome");
 142
 0143                    for (int i = 0; i < 7; i++)
 144                    {
 0145                        var key = "homesection" + i;
 0146                        dto.CustomPrefs.TryGetValue(key, out var homeSection);
 147
 0148                        displayPreferences.HomeSections.Add(new HomeSection
 0149                        {
 0150                            Order = i,
 0151                            Type = Enum.TryParse<HomeSectionType>(homeSection, true, out var type) ? type : defaults[i]
 0152                        });
 153
 0154                        dto.CustomPrefs.Remove(key);
 155                    }
 156
 0157                    var defaultLibraryPrefs = new ItemDisplayPreferences(displayPreferences.UserId, Guid.Empty, displayP
 0158                    {
 0159                        SortBy = dto.SortBy ?? "SortName",
 0160                        SortOrder = dto.SortOrder,
 0161                        RememberIndexing = dto.RememberIndexing,
 0162                        RememberSorting = dto.RememberSorting,
 0163                    };
 164
 0165                    dbContext.Add(defaultLibraryPrefs);
 166
 0167                    foreach (var key in dto.CustomPrefs.Keys.Where(key => key.StartsWith("landing-", StringComparison.Or
 168                    {
 0169                        if (!Guid.TryParse(key.AsSpan().Slice("landing-".Length), out var landingItemId))
 170                        {
 171                            continue;
 172                        }
 173
 0174                        var libraryDisplayPreferences = new ItemDisplayPreferences(displayPreferences.UserId, landingIte
 0175                        {
 0176                            SortBy = dto.SortBy ?? "SortName",
 0177                            SortOrder = dto.SortOrder,
 0178                            RememberIndexing = dto.RememberIndexing,
 0179                            RememberSorting = dto.RememberSorting,
 0180                        };
 181
 0182                        if (Enum.TryParse<ViewType>(dto.ViewType, true, out var viewType))
 183                        {
 0184                            libraryDisplayPreferences.ViewType = viewType;
 185                        }
 186
 0187                        dto.CustomPrefs.Remove(key);
 0188                        dbContext.ItemDisplayPreferences.Add(libraryDisplayPreferences);
 189                    }
 190
 0191                    foreach (var (key, value) in dto.CustomPrefs)
 192                    {
 193                        // Custom display preferences can have a key collision.
 0194                        var indexKey = $"{displayPreferences.UserId}|{itemId}|{displayPreferences.Client}|{key}";
 0195                        if (!customDisplayPrefs.Contains(indexKey))
 196                        {
 0197                            dbContext.Add(new CustomItemDisplayPreferences(displayPreferences.UserId, itemId, displayPre
 0198                            customDisplayPrefs.Add(indexKey);
 199                        }
 200                    }
 201
 0202                    dbContext.Add(displayPreferences);
 203                }
 204
 0205                dbContext.SaveChanges();
 206            }
 207
 208            try
 209            {
 0210                File.Move(dbFilePath, dbFilePath + ".old");
 211
 0212                var journalPath = dbFilePath + "-journal";
 0213                if (File.Exists(journalPath))
 214                {
 0215                    File.Move(journalPath, dbFilePath + ".old-journal");
 216                }
 0217            }
 0218            catch (IOException e)
 219            {
 0220                _logger.LogError(e, "Error renaming legacy display preferences database to 'displaypreferences.db.old'")
 0221            }
 0222        }
 223    }
 224}
Generated by: ReportGenerator 5.4.7.0
5/17/2025 - 12:09:39 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(Microsoft.Extensions.Logging.ILogger`1<Jellyfin.Server.Migrations.Routines.MigrateDisplayPreferencesDb>,MediaBrowser.Controller.IServerApplicationPaths,Microsoft.EntityFrameworkCore.IDbContextFactory`1<Jellyfin.Database.Implementations.JellyfinDbContext>,MediaBrowser.Controller.Library.IUserManager)
Perform()