aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Server/Migrations/Routines/20260113230000_CleanupOrphanedExtras.cs
blob: e8eeb2da20264139c6f80ca643cd82224206b814 (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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Jellyfin.Database.Implementations;
using Jellyfin.Server.Implementations.Item;
using Jellyfin.Server.Migrations.Stages;
using Jellyfin.Server.ServerSetupApp;
using MediaBrowser.Controller.Channels;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.LiveTv;
using MediaBrowser.Controller.MediaSegments;
using MediaBrowser.Controller.Persistence;
using MediaBrowser.Model.IO;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Logging;

namespace Jellyfin.Server.Migrations.Routines;

/// <summary>
/// Removes orphaned extras (items with OwnerId pointing to non-existent items).
/// Must run before EF migrations that add FK constraints on OwnerId.
/// </summary>
[JellyfinMigration("2026-01-13T23:00:00", nameof(CleanupOrphanedExtras), Stage = JellyfinMigrationStageTypes.AppInitialisation)]
[JellyfinMigrationBackup(JellyfinDb = true)]
public class CleanupOrphanedExtras : IAsyncMigrationRoutine
{
    private readonly IStartupLogger<CleanupOrphanedExtras> _logger;
    private readonly IDbContextFactory<JellyfinDbContext> _dbContextFactory;
    private readonly ILibraryManager _libraryManager;

    /// <summary>
    /// Initializes a new instance of the <see cref="CleanupOrphanedExtras"/> class.
    /// </summary>
    /// <param name="logger">The startup logger.</param>
    /// <param name="dbContextFactory">The database context factory.</param>
    /// <param name="libraryManager">The library manager.</param>
    public CleanupOrphanedExtras(
        IStartupLogger<CleanupOrphanedExtras> logger,
        IDbContextFactory<JellyfinDbContext> dbContextFactory,
        ILibraryManager libraryManager)
    {
        _logger = logger;
        _dbContextFactory = dbContextFactory;
        _libraryManager = libraryManager;
    }

    /// <inheritdoc/>
    public async Task PerformAsync(CancellationToken cancellationToken)
    {
        var context = await _dbContextFactory.CreateDbContextAsync(cancellationToken).ConfigureAwait(false);
        await using (context.ConfigureAwait(false))
        {
            var placeholderOwner = Guid.Parse("00000000-0000-0000-0000-000000000001");
#pragma warning disable RS0030 // Do not use banned APIs
            var orphanedItemIds = await context.BaseItems
                .Where(b => b.OwnerId.HasValue && b.OwnerId == placeholderOwner)
                .Select(b => new
                {
                    b.Id,
                    b.Path,
                    b.Type
                })
                .ToListAsync(cancellationToken)
                .ConfigureAwait(false);
#pragma warning restore RS0030 // Do not use banned APIs

            if (orphanedItemIds.Count == 0)
            {
                _logger.LogInformation("No orphaned extras found, skipping migration.");
                return;
            }

            _logger.LogInformation("Found {Count} orphaned extras to remove", orphanedItemIds.Count);

            // Resolve items for metadata path cleanup, then delete in batches so we never issue one
            // massive delete transaction and progress stays visible on large libraries.
            _logger.LogInformation("Deleting {Count} orphaned extras...", orphanedItemIds.Count);
            const int deleteBatchSize = 500;
            var deletedSoFar = 0;
            for (var offset = 0; offset < orphanedItemIds.Count; offset += deleteBatchSize)
            {
                cancellationToken.ThrowIfCancellationRequested();

                var batch = orphanedItemIds.GetRange(offset, Math.Min(deleteBatchSize, orphanedItemIds.Count - offset));
                var itemsToDelete = batch
                    .Select(itemId => BaseItemMapper.DeserializeBaseItem(
                        new Database.Implementations.Entities.BaseItemEntity()
                        {
                            Id = itemId.Id,
                            Path = itemId.Path,
                            Type = itemId.Type
                        },
                        _logger,
                        null,
                        true)!)
                    .ToList();

                _libraryManager.DeleteItemsUnsafeFast(itemsToDelete);

                deletedSoFar += batch.Count;
                _logger.LogInformation("Deleting orphaned extras: {Deleted}/{Total}", deletedSoFar, orphanedItemIds.Count);
            }

            _logger.LogInformation("Successfully removed {Count} orphaned extras", orphanedItemIds.Count);
        }
    }
}