< Summary - Jellyfin

Information
Class: Jellyfin.Server.Migrations.Routines.MigrateUserDb
Assembly: jellyfin
File(s): /srv/git/jellyfin/Jellyfin.Server/Migrations/Routines/20250420100000_MigrateUserDb.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 123
Coverable lines: 123
Total lines: 240
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 32
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 5/31/2026 - 12:15:44 AM Line coverage: 0% (0/121) Branch coverage: 0% (0/32) Total lines: 23311/13/2026 - 12:19:51 AM Line coverage: 0% (0/123) Branch coverage: 0% (0/32) Total lines: 240 5/31/2026 - 12:15:44 AM Line coverage: 0% (0/121) Branch coverage: 0% (0/32) Total lines: 23311/13/2026 - 12:19:51 AM Line coverage: 0% (0/123) Branch coverage: 0% (0/32) Total lines: 240

Coverage delta

Coverage delta 1 -1

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
PerformAsync(...)100%210%
PerformCore()0%1056320%

File(s)

/srv/git/jellyfin/Jellyfin.Server/Migrations/Routines/20250420100000_MigrateUserDb.cs

#LineLine coverage
 1using System;
 2using System.IO;
 3using System.Threading;
 4using System.Threading.Tasks;
 5using Emby.Server.Implementations.Data;
 6using Jellyfin.Data;
 7using Jellyfin.Database.Implementations;
 8using Jellyfin.Database.Implementations.Entities;
 9using Jellyfin.Database.Implementations.Enums;
 10using Jellyfin.Extensions.Json;
 11using Jellyfin.Server.Implementations.Users;
 12using MediaBrowser.Controller;
 13using MediaBrowser.Controller.Entities;
 14using MediaBrowser.Model.Configuration;
 15using MediaBrowser.Model.Serialization;
 16using MediaBrowser.Model.Users;
 17using Microsoft.Data.Sqlite;
 18using Microsoft.EntityFrameworkCore;
 19using Microsoft.Extensions.Logging;
 20using JsonSerializer = System.Text.Json.JsonSerializer;
 21
 22namespace Jellyfin.Server.Migrations.Routines;
 23
 24/// <summary>
 25/// The migration routine for migrating the user database to EF Core.
 26/// </summary>
 27[JellyfinMigration("2025-04-20T10:00:00", nameof(MigrateUserDb), "5C4B82A2-F053-4009-BD05-B6FCAD82F14C")]
 28public class MigrateUserDb : IAsyncMigrationRoutine
 29{
 30    private const string DbFilename = "users.db";
 31
 32    private readonly ILogger<MigrateUserDb> _logger;
 33    private readonly IServerApplicationPaths _paths;
 34    private readonly IDbContextFactory<JellyfinDbContext> _provider;
 35    private readonly IXmlSerializer _xmlSerializer;
 36
 37    /// <summary>
 38    /// Initializes a new instance of the <see cref="MigrateUserDb"/> class.
 39    /// </summary>
 40    /// <param name="logger">The logger.</param>
 41    /// <param name="paths">The server application paths.</param>
 42    /// <param name="provider">The database provider.</param>
 43    /// <param name="xmlSerializer">The xml serializer.</param>
 44    public MigrateUserDb(
 45        ILogger<MigrateUserDb> logger,
 46        IServerApplicationPaths paths,
 47        IDbContextFactory<JellyfinDbContext> provider,
 48        IXmlSerializer xmlSerializer)
 49    {
 050        _logger = logger;
 051        _paths = paths;
 052        _provider = provider;
 053        _xmlSerializer = xmlSerializer;
 054    }
 55
 56    /// <inheritdoc />
 57    public Task PerformAsync(CancellationToken cancellationToken)
 58    {
 59        // This routine predates the async interface and has not been ported to async database access yet.
 060        PerformCore();
 061        return Task.CompletedTask;
 62    }
 63
 64    private void PerformCore()
 65    {
 066        var dataPath = _paths.DataPath;
 067        var userDbPath = Path.Combine(dataPath, DbFilename);
 068        if (!File.Exists(userDbPath))
 69        {
 070            _logger.LogWarning("{UserDbPath} doesn't exist, nothing to migrate", userDbPath);
 071            return;
 72        }
 73
 074        _logger.LogInformation("Migrating the user database may take a while, do not stop Jellyfin.");
 75
 076        using (var connection = new SqliteConnection($"Filename={userDbPath}"))
 77        {
 078            connection.Open();
 079            var tableQuery = connection.Query("SELECT count(*) FROM sqlite_master WHERE type='table' AND name='LocalUser
 080            foreach (var row in tableQuery)
 81            {
 082                if (row.GetInt32(0) == 0)
 83                {
 084                    _logger.LogWarning("Table 'LocalUsersv2' doesn't exist in {UserDbPath}, nothing to migrate", userDbP
 085                    return;
 86                }
 87            }
 88
 089            using var dbContext = _provider.CreateDbContext();
 90
 091            var queryResult = connection.Query("SELECT * FROM LocalUsersv2");
 92
 093            dbContext.RemoveRange(dbContext.Users);
 094            dbContext.SaveChanges();
 95
 096            foreach (var entry in queryResult)
 97            {
 098                UserMockup? mockup = JsonSerializer.Deserialize<UserMockup>(entry.GetStream(2), JsonDefaults.Options);
 099                if (mockup is null)
 100                {
 101                    continue;
 102                }
 103
 0104                var userDataDir = Path.Combine(_paths.UserConfigurationDirectoryPath, mockup.Name);
 105
 0106                var configPath = Path.Combine(userDataDir, "config.xml");
 0107                var config = File.Exists(configPath)
 0108                    ? (UserConfiguration?)_xmlSerializer.DeserializeFromFile(typeof(UserConfiguration), configPath) ?? n
 0109                    : new UserConfiguration();
 110
 0111                var policyPath = Path.Combine(userDataDir, "policy.xml");
 0112                var policy = File.Exists(policyPath)
 0113                    ? (UserPolicy?)_xmlSerializer.DeserializeFromFile(typeof(UserPolicy), policyPath) ?? new UserPolicy(
 0114                    : new UserPolicy();
 0115                policy.AuthenticationProviderId = policy.AuthenticationProviderId?.Replace(
 0116                    "Emby.Server.Implementations.Library",
 0117                    "Jellyfin.Server.Implementations.Users",
 0118                    StringComparison.Ordinal)
 0119                    ?? typeof(DefaultAuthenticationProvider).FullName;
 120
 0121                policy.PasswordResetProviderId = typeof(DefaultPasswordResetProvider).FullName;
 0122                int? maxLoginAttempts = policy.LoginAttemptsBeforeLockout switch
 0123                {
 0124                    -1 => null,
 0125                    0 => 3,
 0126                    _ => policy.LoginAttemptsBeforeLockout
 0127                };
 128
 0129                var user = new User(mockup.Name, policy.AuthenticationProviderId!, policy.PasswordResetProviderId!)
 0130                {
 0131                    Id = entry.GetGuid(1),
 0132                    InternalId = entry.GetInt64(0),
 0133                    MaxParentalRatingScore = policy.MaxParentalRating,
 0134                    MaxParentalRatingSubScore = null,
 0135                    EnableUserPreferenceAccess = policy.EnableUserPreferenceAccess,
 0136                    RemoteClientBitrateLimit = policy.RemoteClientBitrateLimit,
 0137                    InvalidLoginAttemptCount = policy.InvalidLoginAttemptCount,
 0138                    LoginAttemptsBeforeLockout = maxLoginAttempts,
 0139                    SubtitleMode = config.SubtitleMode,
 0140                    HidePlayedInLatest = config.HidePlayedInLatest,
 0141                    EnableLocalPassword = config.EnableLocalPassword,
 0142                    PlayDefaultAudioTrack = config.PlayDefaultAudioTrack,
 0143                    DisplayCollectionsView = config.DisplayCollectionsView,
 0144                    DisplayMissingEpisodes = config.DisplayMissingEpisodes,
 0145                    AudioLanguagePreference = config.AudioLanguagePreference,
 0146                    RememberAudioSelections = config.RememberAudioSelections,
 0147                    EnableNextEpisodeAutoPlay = config.EnableNextEpisodeAutoPlay,
 0148                    RememberSubtitleSelections = config.RememberSubtitleSelections,
 0149                    SubtitleLanguagePreference = config.SubtitleLanguagePreference,
 0150                    Password = mockup.Password,
 0151                    LastLoginDate = mockup.LastLoginDate,
 0152                    LastActivityDate = mockup.LastActivityDate
 0153                };
 154
 0155                if (mockup.ImageInfos.Length > 0)
 156                {
 0157                    ItemImageInfo info = mockup.ImageInfos[0];
 158
 0159                    user.ProfileImage = new ImageInfo(info.Path)
 0160                    {
 0161                        LastModified = info.DateModified
 0162                    };
 163                }
 164
 0165                user.SetPermission(PermissionKind.IsAdministrator, policy.IsAdministrator);
 0166                user.SetPermission(PermissionKind.IsHidden, policy.IsHidden);
 0167                user.SetPermission(PermissionKind.IsDisabled, policy.IsDisabled);
 0168                user.SetPermission(PermissionKind.EnableSharedDeviceControl, policy.EnableSharedDeviceControl);
 0169                user.SetPermission(PermissionKind.EnableRemoteAccess, policy.EnableRemoteAccess);
 0170                user.SetPermission(PermissionKind.EnableLiveTvManagement, policy.EnableLiveTvManagement);
 0171                user.SetPermission(PermissionKind.EnableLiveTvAccess, policy.EnableLiveTvAccess);
 0172                user.SetPermission(PermissionKind.EnableMediaPlayback, policy.EnableMediaPlayback);
 0173                user.SetPermission(PermissionKind.EnableAudioPlaybackTranscoding, policy.EnableAudioPlaybackTranscoding)
 0174                user.SetPermission(PermissionKind.EnableVideoPlaybackTranscoding, policy.EnableVideoPlaybackTranscoding)
 0175                user.SetPermission(PermissionKind.EnableContentDeletion, policy.EnableContentDeletion);
 0176                user.SetPermission(PermissionKind.EnableContentDownloading, policy.EnableContentDownloading);
 0177                user.SetPermission(PermissionKind.EnableSyncTranscoding, policy.EnableSyncTranscoding);
 0178                user.SetPermission(PermissionKind.EnableMediaConversion, policy.EnableMediaConversion);
 0179                user.SetPermission(PermissionKind.EnableAllChannels, policy.EnableAllChannels);
 0180                user.SetPermission(PermissionKind.EnableAllDevices, policy.EnableAllDevices);
 0181                user.SetPermission(PermissionKind.EnableAllFolders, policy.EnableAllFolders);
 0182                user.SetPermission(PermissionKind.EnableRemoteControlOfOtherUsers, policy.EnableRemoteControlOfOtherUser
 0183                user.SetPermission(PermissionKind.EnablePlaybackRemuxing, policy.EnablePlaybackRemuxing);
 0184                user.SetPermission(PermissionKind.ForceRemoteSourceTranscoding, policy.ForceRemoteSourceTranscoding);
 0185                user.SetPermission(PermissionKind.EnablePublicSharing, policy.EnablePublicSharing);
 0186                user.SetPermission(PermissionKind.EnableCollectionManagement, policy.EnableCollectionManagement);
 187
 0188                foreach (var policyAccessSchedule in policy.AccessSchedules)
 189                {
 0190                    user.AccessSchedules.Add(policyAccessSchedule);
 191                }
 192
 0193                user.SetPreference(PreferenceKind.BlockedTags, policy.BlockedTags);
 0194                user.SetPreference(PreferenceKind.EnabledChannels, policy.EnabledChannels);
 0195                user.SetPreference(PreferenceKind.EnabledDevices, policy.EnabledDevices);
 0196                user.SetPreference(PreferenceKind.EnabledFolders, policy.EnabledFolders);
 0197                user.SetPreference(PreferenceKind.EnableContentDeletionFromFolders, policy.EnableContentDeletionFromFold
 0198                user.SetPreference(PreferenceKind.OrderedViews, config.OrderedViews);
 0199                user.SetPreference(PreferenceKind.GroupedFolders, config.GroupedFolders);
 0200                user.SetPreference(PreferenceKind.MyMediaExcludes, config.MyMediaExcludes);
 0201                user.SetPreference(PreferenceKind.LatestItemExcludes, config.LatestItemsExcludes);
 202
 0203                dbContext.Users.Add(user);
 204            }
 205
 0206            dbContext.SaveChanges();
 207        }
 208
 209        try
 210        {
 0211            File.Move(Path.Combine(dataPath, DbFilename), Path.Combine(dataPath, DbFilename + ".old"));
 212
 0213            var journalPath = Path.Combine(dataPath, DbFilename + "-journal");
 0214            if (File.Exists(journalPath))
 215            {
 0216                File.Move(journalPath, Path.Combine(dataPath, DbFilename + ".old-journal"));
 217            }
 0218        }
 0219        catch (IOException e)
 220        {
 0221            _logger.LogError(e, "Error renaming legacy user database to 'users.db.old'");
 0222        }
 0223    }
 224
 225#nullable disable
 226    internal class UserMockup
 227    {
 228        public string Password { get; set; }
 229
 230        public string EasyPassword { get; set; }
 231
 232        public DateTime? LastLoginDate { get; set; }
 233
 234        public DateTime? LastActivityDate { get; set; }
 235
 236        public string Name { get; set; }
 237
 238        public ItemImageInfo[] ImageInfos { get; set; }
 239    }
 240}