From 3b822116ed8b89da82d5b90cd0fdca070def6377 Mon Sep 17 00:00:00 2001
From: Fernando Fernández <ferferga@hotmail.com>
Date: Wed, 12 May 2021 01:18:42 +0200
Subject: Create scheduled task for database optimization

---
 .../ScheduledTasks/Tasks/OptimizeDatabaseTask.cs   | 101 +++++++++++++++++++++
 1 file changed, 101 insertions(+)
 create mode 100644 Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs

(limited to 'Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs')

diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs
new file mode 100644
index 000000000..1ad1d0f50
--- /dev/null
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs
@@ -0,0 +1,101 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Jellyfin.Server.Implementations;
+using MediaBrowser.Model.Globalization;
+using MediaBrowser.Model.Tasks;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Logging;
+
+namespace Emby.Server.Implementations.ScheduledTasks.Tasks
+{
+    /// <summary>
+    /// Optimizes Jellyfin's database by issuing a VACUUM command.
+    /// </summary>
+    public class OptimizeDatabaseTask : IScheduledTask, IConfigurableScheduledTask
+    {
+        private readonly ILogger<OptimizeDatabaseTask> _logger;
+        private readonly ILocalizationManager _localization;
+        private readonly JellyfinDbProvider _provider;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OptimizeDatabaseTask" /> class.
+        /// </summary>
+        public OptimizeDatabaseTask(
+            ILogger<OptimizeDatabaseTask> logger,
+            ILocalizationManager localization,
+            JellyfinDbProvider provider)
+        {
+            _logger = logger;
+            _localization = localization;
+            _provider = provider;
+        }
+
+        /// <inheritdoc />
+        public string Name => _localization.GetLocalizedString("TaskOptimizeDatabase");
+
+        /// <inheritdoc />
+        public string Description => _localization.GetLocalizedString("TaskOptimizeDatabaseDescription");
+
+        /// <inheritdoc />
+        public string Category => _localization.GetLocalizedString("TasksMaintenanceCategory");
+
+        /// <inheritdoc />
+        public string Key => "OptimizeDatabaseTask";
+
+        /// <inheritdoc />
+        public bool IsHidden => false;
+
+        /// <inheritdoc />
+        public bool IsEnabled => true;
+
+        /// <inheritdoc />
+        public bool IsLogged => true;
+
+        /// <summary>
+        /// Creates the triggers that define when the task will run.
+        /// </summary>
+        /// <returns>IEnumerable{BaseTaskTrigger}.</returns>
+        public IEnumerable<TaskTriggerInfo> GetDefaultTriggers()
+        {
+            return new[]
+            {
+                // Every so often
+                new TaskTriggerInfo { Type = TaskTriggerInfo.TriggerInterval, IntervalTicks = TimeSpan.FromHours(24).Ticks }
+            };
+        }
+
+        /// <summary>
+        /// Returns the task to be executed.
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <param name="progress">The progress.</param>
+        /// <returns>Task.</returns>
+        public Task Execute(CancellationToken cancellationToken, IProgress<double> progress)
+        {
+            _logger.LogInformation("Optimizing and vacuuming jellyfin.db...");
+
+            try
+            {
+                using var context = _provider.CreateContext();
+                if (context.Database.IsSqlite())
+                {
+                    context.Database.ExecuteSqlRaw("PRAGMA optimize");
+                    context.Database.ExecuteSqlRaw("VACUUM");
+                    _logger.LogInformation("jellyfin.db optimized successfully!");
+                }
+                else
+                {
+                    _logger.LogInformation("This database doesn't support optimization");
+                }
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "Error while optimizing jellyfin.db");
+            }
+
+            return Task.CompletedTask;
+        }
+    }
+}
-- 
cgit v1.2.3


From 4ba9b6c30568c239ab9070734746c03765faac8f Mon Sep 17 00:00:00 2001
From: Patrick Barron <barronpm@gmail.com>
Date: Sat, 2 Oct 2021 12:53:51 -0400
Subject: Fix warnings in ScheduledTasks

---
 .../ScheduledTasks/ScheduledTaskWorker.cs          | 14 ++++-----
 .../ScheduledTasks/TaskManager.cs                  | 26 ++++++++---------
 .../ScheduledTasks/Tasks/ChapterImagesTask.cs      |  6 ++++
 .../ScheduledTasks/Tasks/OptimizeDatabaseTask.cs   |  3 ++
 .../ScheduledTasks/Tasks/PeopleValidationTask.cs   | 29 ++++++++++---------
 .../Tasks/RefreshMediaLibraryTask.cs               | 33 ++++++++--------------
 6 files changed, 56 insertions(+), 55 deletions(-)

(limited to 'Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs')

diff --git a/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs b/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs
index fb93c375d..f2cdfeb16 100644
--- a/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs
@@ -10,9 +10,9 @@ using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 using Jellyfin.Data.Events;
+using Jellyfin.Extensions.Json;
 using MediaBrowser.Common.Configuration;
 using MediaBrowser.Common.Extensions;
-using Jellyfin.Extensions.Json;
 using MediaBrowser.Common.Progress;
 using MediaBrowser.Model.Tasks;
 using Microsoft.Extensions.Logging;
@@ -24,6 +24,11 @@ namespace Emby.Server.Implementations.ScheduledTasks
     /// </summary>
     public class ScheduledTaskWorker : IScheduledTaskWorker
     {
+        /// <summary>
+        /// The options for the json Serializer.
+        /// </summary>
+        private readonly JsonSerializerOptions _jsonOptions = JsonDefaults.Options;
+
         /// <summary>
         /// Gets or sets the application paths.
         /// </summary>
@@ -66,11 +71,6 @@ namespace Emby.Server.Implementations.ScheduledTasks
         /// </summary>
         private string _id;
 
-        /// <summary>
-        /// The options for the json Serializer.
-        /// </summary>
-        private readonly JsonSerializerOptions _jsonOptions = JsonDefaults.Options;
-
         /// <summary>
         /// Initializes a new instance of the <see cref="ScheduledTaskWorker" /> class.
         /// </summary>
@@ -365,7 +365,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
         /// </summary>
         /// <param name="options">Task options.</param>
         /// <returns>Task.</returns>
-        /// <exception cref="InvalidOperationException">Cannot execute a Task that is already running</exception>
+        /// <exception cref="InvalidOperationException">Cannot execute a Task that is already running.</exception>
         public async Task Execute(TaskOptions options)
         {
             var task = Task.Run(async () => await ExecuteInternal(options).ConfigureAwait(false));
diff --git a/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs b/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs
index 4f0df75bf..0431858fc 100644
--- a/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs
@@ -19,16 +19,6 @@ namespace Emby.Server.Implementations.ScheduledTasks
     /// </summary>
     public class TaskManager : ITaskManager
     {
-        public event EventHandler<GenericEventArgs<IScheduledTaskWorker>> TaskExecuting;
-
-        public event EventHandler<TaskCompletionEventArgs> TaskCompleted;
-
-        /// <summary>
-        /// Gets the list of Scheduled Tasks.
-        /// </summary>
-        /// <value>The scheduled tasks.</value>
-        public IScheduledTaskWorker[] ScheduledTasks { get; private set; }
-
         /// <summary>
         /// The _task queue.
         /// </summary>
@@ -53,10 +43,20 @@ namespace Emby.Server.Implementations.ScheduledTasks
             ScheduledTasks = Array.Empty<IScheduledTaskWorker>();
         }
 
+        public event EventHandler<GenericEventArgs<IScheduledTaskWorker>> TaskExecuting;
+
+        public event EventHandler<TaskCompletionEventArgs> TaskCompleted;
+
+        /// <summary>
+        /// Gets the list of Scheduled Tasks.
+        /// </summary>
+        /// <value>The scheduled tasks.</value>
+        public IScheduledTaskWorker[] ScheduledTasks { get; private set; }
+
         /// <summary>
         /// Cancels if running and queue.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
+        /// <typeparam name="T">The task type.</typeparam>
         /// <param name="options">Task options.</param>
         public void CancelIfRunningAndQueue<T>(TaskOptions options)
             where T : IScheduledTask
@@ -76,7 +76,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
         /// <summary>
         /// Cancels if running.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
+        /// <typeparam name="T">The task type.</typeparam>
         public void CancelIfRunning<T>()
                  where T : IScheduledTask
         {
@@ -87,7 +87,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
         /// <summary>
         /// Queues the scheduled task.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
+        /// <typeparam name="T">The task type.</typeparam>
         /// <param name="options">Task options.</param>
         public void QueueScheduledTask<T>(TaskOptions options)
             where T : IScheduledTask
diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs
index b764a139c..09ea6271d 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs
@@ -39,6 +39,12 @@ namespace Emby.Server.Implementations.ScheduledTasks
         /// <summary>
         /// Initializes a new instance of the <see cref="ChapterImagesTask" /> class.
         /// </summary>
+        /// <param name="libraryManager">The library manager.</param>.
+        /// <param name="itemRepo">The item repository.</param>
+        /// <param name="appPaths">The application paths.</param>
+        /// <param name="encodingManager">The encoding manager.</param>
+        /// <param name="fileSystem">The filesystem.</param>
+        /// <param name="localization">The localization manager.</param>
         public ChapterImagesTask(
             ILibraryManager libraryManager,
             IItemRepository itemRepo,
diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs
index 1ad1d0f50..35a4aeef6 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/OptimizeDatabaseTask.cs
@@ -22,6 +22,9 @@ namespace Emby.Server.Implementations.ScheduledTasks.Tasks
         /// <summary>
         /// Initializes a new instance of the <see cref="OptimizeDatabaseTask" /> class.
         /// </summary>
+        /// <param name="logger">The logger.</param>
+        /// <param name="localization">The localization manager.</param>
+        /// <param name="provider">The jellyfin DB context provider.</param>
         public OptimizeDatabaseTask(
             ILogger<OptimizeDatabaseTask> logger,
             ILocalizationManager localization,
diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/PeopleValidationTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/PeopleValidationTask.cs
index 57d294a40..53c692a46 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Tasks/PeopleValidationTask.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/PeopleValidationTask.cs
@@ -32,9 +32,24 @@ namespace Emby.Server.Implementations.ScheduledTasks
             _localization = localization;
         }
 
+        public string Name => _localization.GetLocalizedString("TaskRefreshPeople");
+
+        public string Description => _localization.GetLocalizedString("TaskRefreshPeopleDescription");
+
+        public string Category => _localization.GetLocalizedString("TasksLibraryCategory");
+
+        public string Key => "RefreshPeople";
+
+        public bool IsHidden => false;
+
+        public bool IsEnabled => true;
+
+        public bool IsLogged => true;
+
         /// <summary>
         /// Creates the triggers that define when the task will run.
         /// </summary>
+        /// <returns>An <see cref="IEnumerable{TaskTriggerInfo}"/> containing the default trigger infos for this task.</returns>
         public IEnumerable<TaskTriggerInfo> GetDefaultTriggers()
         {
             return new[]
@@ -57,19 +72,5 @@ namespace Emby.Server.Implementations.ScheduledTasks
         {
             return _libraryManager.ValidatePeople(cancellationToken, progress);
         }
-
-        public string Name => _localization.GetLocalizedString("TaskRefreshPeople");
-
-        public string Description => _localization.GetLocalizedString("TaskRefreshPeopleDescription");
-
-        public string Category => _localization.GetLocalizedString("TasksLibraryCategory");
-
-        public string Key => "RefreshPeople";
-
-        public bool IsHidden => false;
-
-        public bool IsEnabled => true;
-
-        public bool IsLogged => true;
     }
 }
diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/RefreshMediaLibraryTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/RefreshMediaLibraryTask.cs
index 51b620404..2184b3d03 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Tasks/RefreshMediaLibraryTask.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/RefreshMediaLibraryTask.cs
@@ -33,6 +33,18 @@ namespace Emby.Server.Implementations.ScheduledTasks
             _localization = localization;
         }
 
+        /// <inheritdoc />
+        public string Name => _localization.GetLocalizedString("TaskRefreshLibrary");
+
+        /// <inheritdoc />
+        public string Description => _localization.GetLocalizedString("TaskRefreshLibraryDescription");
+
+        /// <inheritdoc />
+        public string Category => _localization.GetLocalizedString("TasksLibraryCategory");
+
+        /// <inheritdoc />
+        public string Key => "RefreshLibrary";
+
         /// <summary>
         /// Creates the triggers that define when the task will run.
         /// </summary>
@@ -60,26 +72,5 @@ namespace Emby.Server.Implementations.ScheduledTasks
 
             return ((LibraryManager)_libraryManager).ValidateMediaLibraryInternal(progress, cancellationToken);
         }
-
-        /// <inheritdoc />
-        public string Name => _localization.GetLocalizedString("TaskRefreshLibrary");
-
-        /// <inheritdoc />
-        public string Description => _localization.GetLocalizedString("TaskRefreshLibraryDescription");
-
-        /// <inheritdoc />
-        public string Category => _localization.GetLocalizedString("TasksLibraryCategory");
-
-        /// <inheritdoc />
-        public string Key => "RefreshLibrary";
-
-        /// <inheritdoc />
-        public bool IsHidden => false;
-
-        /// <inheritdoc />
-        public bool IsEnabled => true;
-
-        /// <inheritdoc />
-        public bool IsLogged => true;
     }
 }
-- 
cgit v1.2.3