< Summary - Jellyfin

Information
Class: Jellyfin.Server.Migrations.Routines.MigrateUserDb
Assembly: jellyfin
File(s): /srv/git/jellyfin/Jellyfin.Server/Migrations/Routines/MigrateUserDb.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 115
Coverable lines: 115
Total lines: 223
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 26
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%
get_Id()100%210%
get_Name()100%210%
get_PerformOnNewInstall()100%210%
Perform()0%702260%

File(s)

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

#LineLine coverage
 1using System;
 2using System.IO;
 3using Emby.Server.Implementations.Data;
 4using Jellyfin.Data;
 5using Jellyfin.Database.Implementations;
 6using Jellyfin.Database.Implementations.Entities;
 7using Jellyfin.Database.Implementations.Enums;
 8using Jellyfin.Extensions.Json;
 9using Jellyfin.Server.Implementations.Users;
 10using MediaBrowser.Controller;
 11using MediaBrowser.Controller.Entities;
 12using MediaBrowser.Model.Configuration;
 13using MediaBrowser.Model.Serialization;
 14using MediaBrowser.Model.Users;
 15using Microsoft.Data.Sqlite;
 16using Microsoft.EntityFrameworkCore;
 17using Microsoft.Extensions.Logging;
 18using JsonSerializer = System.Text.Json.JsonSerializer;
 19
 20namespace Jellyfin.Server.Migrations.Routines
 21{
 22    /// <summary>
 23    /// The migration routine for migrating the user database to EF Core.
 24    /// </summary>
 25    public class MigrateUserDb : IMigrationRoutine
 26    {
 27        private const string DbFilename = "users.db";
 28
 29        private readonly ILogger<MigrateUserDb> _logger;
 30        private readonly IServerApplicationPaths _paths;
 31        private readonly IDbContextFactory<JellyfinDbContext> _provider;
 32        private readonly IXmlSerializer _xmlSerializer;
 33
 34        /// <summary>
 35        /// Initializes a new instance of the <see cref="MigrateUserDb"/> class.
 36        /// </summary>
 37        /// <param name="logger">The logger.</param>
 38        /// <param name="paths">The server application paths.</param>
 39        /// <param name="provider">The database provider.</param>
 40        /// <param name="xmlSerializer">The xml serializer.</param>
 41        public MigrateUserDb(
 42            ILogger<MigrateUserDb> logger,
 43            IServerApplicationPaths paths,
 44            IDbContextFactory<JellyfinDbContext> provider,
 45            IXmlSerializer xmlSerializer)
 46        {
 047            _logger = logger;
 048            _paths = paths;
 049            _provider = provider;
 050            _xmlSerializer = xmlSerializer;
 051        }
 52
 53        /// <inheritdoc/>
 054        public Guid Id => Guid.Parse("5C4B82A2-F053-4009-BD05-B6FCAD82F14C");
 55
 56        /// <inheritdoc/>
 057        public string Name => "MigrateUserDatabase";
 58
 59        /// <inheritdoc/>
 060        public bool PerformOnNewInstall => false;
 61
 62        /// <inheritdoc/>
 63        public void Perform()
 64        {
 065            var dataPath = _paths.DataPath;
 066            _logger.LogInformation("Migrating the user database may take a while, do not stop Jellyfin.");
 67
 068            using (var connection = new SqliteConnection($"Filename={Path.Combine(dataPath, DbFilename)}"))
 69            {
 070                connection.Open();
 071                using var dbContext = _provider.CreateDbContext();
 72
 073                var queryResult = connection.Query("SELECT * FROM LocalUsersv2");
 74
 075                dbContext.RemoveRange(dbContext.Users);
 076                dbContext.SaveChanges();
 77
 078                foreach (var entry in queryResult)
 79                {
 080                    UserMockup? mockup = JsonSerializer.Deserialize<UserMockup>(entry.GetStream(2), JsonDefaults.Options
 081                    if (mockup is null)
 82                    {
 83                        continue;
 84                    }
 85
 086                    var userDataDir = Path.Combine(_paths.UserConfigurationDirectoryPath, mockup.Name);
 87
 088                    var configPath = Path.Combine(userDataDir, "config.xml");
 089                    var config = File.Exists(configPath)
 090                        ? (UserConfiguration?)_xmlSerializer.DeserializeFromFile(typeof(UserConfiguration), configPath) 
 091                        : new UserConfiguration();
 92
 093                    var policyPath = Path.Combine(userDataDir, "policy.xml");
 094                    var policy = File.Exists(policyPath)
 095                        ? (UserPolicy?)_xmlSerializer.DeserializeFromFile(typeof(UserPolicy), policyPath) ?? new UserPol
 096                        : new UserPolicy();
 097                    policy.AuthenticationProviderId = policy.AuthenticationProviderId?.Replace(
 098                        "Emby.Server.Implementations.Library",
 099                        "Jellyfin.Server.Implementations.Users",
 0100                        StringComparison.Ordinal)
 0101                        ?? typeof(DefaultAuthenticationProvider).FullName;
 102
 0103                    policy.PasswordResetProviderId = typeof(DefaultPasswordResetProvider).FullName;
 0104                    int? maxLoginAttempts = policy.LoginAttemptsBeforeLockout switch
 0105                    {
 0106                        -1 => null,
 0107                        0 => 3,
 0108                        _ => policy.LoginAttemptsBeforeLockout
 0109                    };
 110
 0111                    var user = new User(mockup.Name, policy.AuthenticationProviderId!, policy.PasswordResetProviderId!)
 0112                    {
 0113                        Id = entry.GetGuid(1),
 0114                        InternalId = entry.GetInt64(0),
 0115                        MaxParentalRatingScore = policy.MaxParentalRating,
 0116                        MaxParentalRatingSubScore = null,
 0117                        EnableUserPreferenceAccess = policy.EnableUserPreferenceAccess,
 0118                        RemoteClientBitrateLimit = policy.RemoteClientBitrateLimit,
 0119                        InvalidLoginAttemptCount = policy.InvalidLoginAttemptCount,
 0120                        LoginAttemptsBeforeLockout = maxLoginAttempts,
 0121                        SubtitleMode = config.SubtitleMode,
 0122                        HidePlayedInLatest = config.HidePlayedInLatest,
 0123                        EnableLocalPassword = config.EnableLocalPassword,
 0124                        PlayDefaultAudioTrack = config.PlayDefaultAudioTrack,
 0125                        DisplayCollectionsView = config.DisplayCollectionsView,
 0126                        DisplayMissingEpisodes = config.DisplayMissingEpisodes,
 0127                        AudioLanguagePreference = config.AudioLanguagePreference,
 0128                        RememberAudioSelections = config.RememberAudioSelections,
 0129                        EnableNextEpisodeAutoPlay = config.EnableNextEpisodeAutoPlay,
 0130                        RememberSubtitleSelections = config.RememberSubtitleSelections,
 0131                        SubtitleLanguagePreference = config.SubtitleLanguagePreference,
 0132                        Password = mockup.Password,
 0133                        LastLoginDate = mockup.LastLoginDate,
 0134                        LastActivityDate = mockup.LastActivityDate
 0135                    };
 136
 0137                    if (mockup.ImageInfos.Length > 0)
 138                    {
 0139                        ItemImageInfo info = mockup.ImageInfos[0];
 140
 0141                        user.ProfileImage = new ImageInfo(info.Path)
 0142                        {
 0143                            LastModified = info.DateModified
 0144                        };
 145                    }
 146
 0147                    user.SetPermission(PermissionKind.IsAdministrator, policy.IsAdministrator);
 0148                    user.SetPermission(PermissionKind.IsHidden, policy.IsHidden);
 0149                    user.SetPermission(PermissionKind.IsDisabled, policy.IsDisabled);
 0150                    user.SetPermission(PermissionKind.EnableSharedDeviceControl, policy.EnableSharedDeviceControl);
 0151                    user.SetPermission(PermissionKind.EnableRemoteAccess, policy.EnableRemoteAccess);
 0152                    user.SetPermission(PermissionKind.EnableLiveTvManagement, policy.EnableLiveTvManagement);
 0153                    user.SetPermission(PermissionKind.EnableLiveTvAccess, policy.EnableLiveTvAccess);
 0154                    user.SetPermission(PermissionKind.EnableMediaPlayback, policy.EnableMediaPlayback);
 0155                    user.SetPermission(PermissionKind.EnableAudioPlaybackTranscoding, policy.EnableAudioPlaybackTranscod
 0156                    user.SetPermission(PermissionKind.EnableVideoPlaybackTranscoding, policy.EnableVideoPlaybackTranscod
 0157                    user.SetPermission(PermissionKind.EnableContentDeletion, policy.EnableContentDeletion);
 0158                    user.SetPermission(PermissionKind.EnableContentDownloading, policy.EnableContentDownloading);
 0159                    user.SetPermission(PermissionKind.EnableSyncTranscoding, policy.EnableSyncTranscoding);
 0160                    user.SetPermission(PermissionKind.EnableMediaConversion, policy.EnableMediaConversion);
 0161                    user.SetPermission(PermissionKind.EnableAllChannels, policy.EnableAllChannels);
 0162                    user.SetPermission(PermissionKind.EnableAllDevices, policy.EnableAllDevices);
 0163                    user.SetPermission(PermissionKind.EnableAllFolders, policy.EnableAllFolders);
 0164                    user.SetPermission(PermissionKind.EnableRemoteControlOfOtherUsers, policy.EnableRemoteControlOfOther
 0165                    user.SetPermission(PermissionKind.EnablePlaybackRemuxing, policy.EnablePlaybackRemuxing);
 0166                    user.SetPermission(PermissionKind.ForceRemoteSourceTranscoding, policy.ForceRemoteSourceTranscoding)
 0167                    user.SetPermission(PermissionKind.EnablePublicSharing, policy.EnablePublicSharing);
 0168                    user.SetPermission(PermissionKind.EnableCollectionManagement, policy.EnableCollectionManagement);
 169
 0170                    foreach (var policyAccessSchedule in policy.AccessSchedules)
 171                    {
 0172                        user.AccessSchedules.Add(policyAccessSchedule);
 173                    }
 174
 0175                    user.SetPreference(PreferenceKind.BlockedTags, policy.BlockedTags);
 0176                    user.SetPreference(PreferenceKind.EnabledChannels, policy.EnabledChannels);
 0177                    user.SetPreference(PreferenceKind.EnabledDevices, policy.EnabledDevices);
 0178                    user.SetPreference(PreferenceKind.EnabledFolders, policy.EnabledFolders);
 0179                    user.SetPreference(PreferenceKind.EnableContentDeletionFromFolders, policy.EnableContentDeletionFrom
 0180                    user.SetPreference(PreferenceKind.OrderedViews, config.OrderedViews);
 0181                    user.SetPreference(PreferenceKind.GroupedFolders, config.GroupedFolders);
 0182                    user.SetPreference(PreferenceKind.MyMediaExcludes, config.MyMediaExcludes);
 0183                    user.SetPreference(PreferenceKind.LatestItemExcludes, config.LatestItemsExcludes);
 184
 0185                    dbContext.Users.Add(user);
 186                }
 187
 0188                dbContext.SaveChanges();
 189            }
 190
 191            try
 192            {
 0193                File.Move(Path.Combine(dataPath, DbFilename), Path.Combine(dataPath, DbFilename + ".old"));
 194
 0195                var journalPath = Path.Combine(dataPath, DbFilename + "-journal");
 0196                if (File.Exists(journalPath))
 197                {
 0198                    File.Move(journalPath, Path.Combine(dataPath, DbFilename + ".old-journal"));
 199                }
 0200            }
 0201            catch (IOException e)
 202            {
 0203                _logger.LogError(e, "Error renaming legacy user database to 'users.db.old'");
 0204            }
 0205        }
 206
 207#nullable disable
 208        internal class UserMockup
 209        {
 210            public string Password { get; set; }
 211
 212            public string EasyPassword { get; set; }
 213
 214            public DateTime? LastLoginDate { get; set; }
 215
 216            public DateTime? LastActivityDate { get; set; }
 217
 218            public string Name { get; set; }
 219
 220            public ItemImageInfo[] ImageInfos { get; set; }
 221        }
 222    }
 223}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:20 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(Microsoft.Extensions.Logging.ILogger`1<Jellyfin.Server.Migrations.Routines.MigrateUserDb>,MediaBrowser.Controller.IServerApplicationPaths,Microsoft.EntityFrameworkCore.IDbContextFactory`1<Jellyfin.Database.Implementations.JellyfinDbContext>,MediaBrowser.Model.Serialization.IXmlSerializer)
get_Id()
get_Name()
get_PerformOnNewInstall()
Perform()