aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Server/Migrations/Routines/MigrateUserDb.cs
blob: e5584fb947d54acfeb9ad454ea6ee269d955976e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
using System;
using System.IO;
using Emby.Server.Implementations.Data;
using Jellyfin.Data;
using Jellyfin.Database.Implementations;
using Jellyfin.Database.Implementations.Entities;
using Jellyfin.Database.Implementations.Enums;
using Jellyfin.Extensions.Json;
using Jellyfin.Server.Implementations.Users;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Configuration;
using MediaBrowser.Model.Serialization;
using MediaBrowser.Model.Users;
using Microsoft.Data.Sqlite;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Logging;
using JsonSerializer = System.Text.Json.JsonSerializer;

namespace Jellyfin.Server.Migrations.Routines;

/// <summary>
/// The migration routine for migrating the user database to EF Core.
/// </summary>
#pragma warning disable CS0618 // Type or member is obsolete
[JellyfinMigration("2025-04-20T10:00:00", nameof(MigrateUserDb), "5C4B82A2-F053-4009-BD05-B6FCAD82F14C")]
public class MigrateUserDb : IMigrationRoutine
#pragma warning restore CS0618 // Type or member is obsolete
{
    private const string DbFilename = "users.db";

    private readonly ILogger<MigrateUserDb> _logger;
    private readonly IServerApplicationPaths _paths;
    private readonly IDbContextFactory<JellyfinDbContext> _provider;
    private readonly IXmlSerializer _xmlSerializer;

    /// <summary>
    /// Initializes a new instance of the <see cref="MigrateUserDb"/> class.
    /// </summary>
    /// <param name="logger">The logger.</param>
    /// <param name="paths">The server application paths.</param>
    /// <param name="provider">The database provider.</param>
    /// <param name="xmlSerializer">The xml serializer.</param>
    public MigrateUserDb(
        ILogger<MigrateUserDb> logger,
        IServerApplicationPaths paths,
        IDbContextFactory<JellyfinDbContext> provider,
        IXmlSerializer xmlSerializer)
    {
        _logger = logger;
        _paths = paths;
        _provider = provider;
        _xmlSerializer = xmlSerializer;
    }

    /// <inheritdoc/>
    public void Perform()
    {
        var dataPath = _paths.DataPath;
        _logger.LogInformation("Migrating the user database may take a while, do not stop Jellyfin.");

        using (var connection = new SqliteConnection($"Filename={Path.Combine(dataPath, DbFilename)}"))
        {
            connection.Open();
            using var dbContext = _provider.CreateDbContext();

            var queryResult = connection.Query("SELECT * FROM LocalUsersv2");

            dbContext.RemoveRange(dbContext.Users);
            dbContext.SaveChanges();

            foreach (var entry in queryResult)
            {
                UserMockup? mockup = JsonSerializer.Deserialize<UserMockup>(entry.GetStream(2), JsonDefaults.Options);
                if (mockup is null)
                {
                    continue;
                }

                var userDataDir = Path.Combine(_paths.UserConfigurationDirectoryPath, mockup.Name);

                var configPath = Path.Combine(userDataDir, "config.xml");
                var config = File.Exists(configPath)
                    ? (UserConfiguration?)_xmlSerializer.DeserializeFromFile(typeof(UserConfiguration), configPath) ?? new UserConfiguration()
                    : new UserConfiguration();

                var policyPath = Path.Combine(userDataDir, "policy.xml");
                var policy = File.Exists(policyPath)
                    ? (UserPolicy?)_xmlSerializer.DeserializeFromFile(typeof(UserPolicy), policyPath) ?? new UserPolicy()
                    : new UserPolicy();
                policy.AuthenticationProviderId = policy.AuthenticationProviderId?.Replace(
                    "Emby.Server.Implementations.Library",
                    "Jellyfin.Server.Implementations.Users",
                    StringComparison.Ordinal)
                    ?? typeof(DefaultAuthenticationProvider).FullName;

                policy.PasswordResetProviderId = typeof(DefaultPasswordResetProvider).FullName;
                int? maxLoginAttempts = policy.LoginAttemptsBeforeLockout switch
                {
                    -1 => null,
                    0 => 3,
                    _ => policy.LoginAttemptsBeforeLockout
                };

                var user = new User(mockup.Name, policy.AuthenticationProviderId!, policy.PasswordResetProviderId!)
                {
                    Id = entry.GetGuid(1),
                    InternalId = entry.GetInt64(0),
                    MaxParentalRatingScore = policy.MaxParentalRating,
                    MaxParentalRatingSubScore = null,
                    EnableUserPreferenceAccess = policy.EnableUserPreferenceAccess,
                    RemoteClientBitrateLimit = policy.RemoteClientBitrateLimit,
                    InvalidLoginAttemptCount = policy.InvalidLoginAttemptCount,
                    LoginAttemptsBeforeLockout = maxLoginAttempts,
                    SubtitleMode = config.SubtitleMode,
                    HidePlayedInLatest = config.HidePlayedInLatest,
                    EnableLocalPassword = config.EnableLocalPassword,
                    PlayDefaultAudioTrack = config.PlayDefaultAudioTrack,
                    DisplayCollectionsView = config.DisplayCollectionsView,
                    DisplayMissingEpisodes = config.DisplayMissingEpisodes,
                    AudioLanguagePreference = config.AudioLanguagePreference,
                    RememberAudioSelections = config.RememberAudioSelections,
                    EnableNextEpisodeAutoPlay = config.EnableNextEpisodeAutoPlay,
                    RememberSubtitleSelections = config.RememberSubtitleSelections,
                    SubtitleLanguagePreference = config.SubtitleLanguagePreference,
                    Password = mockup.Password,
                    LastLoginDate = mockup.LastLoginDate,
                    LastActivityDate = mockup.LastActivityDate
                };

                if (mockup.ImageInfos.Length > 0)
                {
                    ItemImageInfo info = mockup.ImageInfos[0];

                    user.ProfileImage = new ImageInfo(info.Path)
                    {
                        LastModified = info.DateModified
                    };
                }

                user.SetPermission(PermissionKind.IsAdministrator, policy.IsAdministrator);
                user.SetPermission(PermissionKind.IsHidden, policy.IsHidden);
                user.SetPermission(PermissionKind.IsDisabled, policy.IsDisabled);
                user.SetPermission(PermissionKind.EnableSharedDeviceControl, policy.EnableSharedDeviceControl);
                user.SetPermission(PermissionKind.EnableRemoteAccess, policy.EnableRemoteAccess);
                user.SetPermission(PermissionKind.EnableLiveTvManagement, policy.EnableLiveTvManagement);
                user.SetPermission(PermissionKind.EnableLiveTvAccess, policy.EnableLiveTvAccess);
                user.SetPermission(PermissionKind.EnableMediaPlayback, policy.EnableMediaPlayback);
                user.SetPermission(PermissionKind.EnableAudioPlaybackTranscoding, policy.EnableAudioPlaybackTranscoding);
                user.SetPermission(PermissionKind.EnableVideoPlaybackTranscoding, policy.EnableVideoPlaybackTranscoding);
                user.SetPermission(PermissionKind.EnableContentDeletion, policy.EnableContentDeletion);
                user.SetPermission(PermissionKind.EnableContentDownloading, policy.EnableContentDownloading);
                user.SetPermission(PermissionKind.EnableSyncTranscoding, policy.EnableSyncTranscoding);
                user.SetPermission(PermissionKind.EnableMediaConversion, policy.EnableMediaConversion);
                user.SetPermission(PermissionKind.EnableAllChannels, policy.EnableAllChannels);
                user.SetPermission(PermissionKind.EnableAllDevices, policy.EnableAllDevices);
                user.SetPermission(PermissionKind.EnableAllFolders, policy.EnableAllFolders);
                user.SetPermission(PermissionKind.EnableRemoteControlOfOtherUsers, policy.EnableRemoteControlOfOtherUsers);
                user.SetPermission(PermissionKind.EnablePlaybackRemuxing, policy.EnablePlaybackRemuxing);
                user.SetPermission(PermissionKind.ForceRemoteSourceTranscoding, policy.ForceRemoteSourceTranscoding);
                user.SetPermission(PermissionKind.EnablePublicSharing, policy.EnablePublicSharing);
                user.SetPermission(PermissionKind.EnableCollectionManagement, policy.EnableCollectionManagement);

                foreach (var policyAccessSchedule in policy.AccessSchedules)
                {
                    user.AccessSchedules.Add(policyAccessSchedule);
                }

                user.SetPreference(PreferenceKind.BlockedTags, policy.BlockedTags);
                user.SetPreference(PreferenceKind.EnabledChannels, policy.EnabledChannels);
                user.SetPreference(PreferenceKind.EnabledDevices, policy.EnabledDevices);
                user.SetPreference(PreferenceKind.EnabledFolders, policy.EnabledFolders);
                user.SetPreference(PreferenceKind.EnableContentDeletionFromFolders, policy.EnableContentDeletionFromFolders);
                user.SetPreference(PreferenceKind.OrderedViews, config.OrderedViews);
                user.SetPreference(PreferenceKind.GroupedFolders, config.GroupedFolders);
                user.SetPreference(PreferenceKind.MyMediaExcludes, config.MyMediaExcludes);
                user.SetPreference(PreferenceKind.LatestItemExcludes, config.LatestItemsExcludes);

                dbContext.Users.Add(user);
            }

            dbContext.SaveChanges();
        }

        try
        {
            File.Move(Path.Combine(dataPath, DbFilename), Path.Combine(dataPath, DbFilename + ".old"));

            var journalPath = Path.Combine(dataPath, DbFilename + "-journal");
            if (File.Exists(journalPath))
            {
                File.Move(journalPath, Path.Combine(dataPath, DbFilename + ".old-journal"));
            }
        }
        catch (IOException e)
        {
            _logger.LogError(e, "Error renaming legacy user database to 'users.db.old'");
        }
    }

#nullable disable
    internal class UserMockup
    {
        public string Password { get; set; }

        public string EasyPassword { get; set; }

        public DateTime? LastLoginDate { get; set; }

        public DateTime? LastActivityDate { get; set; }

        public string Name { get; set; }

        public ItemImageInfo[] ImageInfos { get; set; }
    }
}