jellyfin-server/MediaBrowser.Common.Implementations/ScheduledTasks/Tasks/DeleteLogFileTask.cs

132 lines
4.1 KiB
C#
Raw Normal View History

2013-03-04 05:43:06 +00:00
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.IO;
2013-02-24 21:53:54 +00:00
using MediaBrowser.Common.ScheduledTasks;
2013-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
2015-10-04 04:23:11 +00:00
using CommonIO;
2013-02-21 01:33:05 +00:00
2013-02-24 21:53:54 +00:00
namespace MediaBrowser.Common.Implementations.ScheduledTasks.Tasks
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Deletes old log files
/// </summary>
2013-12-26 14:20:45 +00:00
public class DeleteLogFileTask : IScheduledTask, IConfigurableScheduledTask
2013-02-21 01:33:05 +00:00
{
/// <summary>
2013-03-04 05:43:06 +00:00
/// Gets or sets the configuration manager.
/// </summary>
2013-03-04 05:43:06 +00:00
/// <value>The configuration manager.</value>
private IConfigurationManager ConfigurationManager { get; set; }
private readonly IFileSystem _fileSystem;
2013-02-23 07:57:11 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="DeleteLogFileTask" /> class.
/// </summary>
2013-03-04 05:43:06 +00:00
/// <param name="configurationManager">The configuration manager.</param>
public DeleteLogFileTask(IConfigurationManager configurationManager, IFileSystem fileSystem)
2013-02-23 07:57:11 +00:00
{
2013-03-04 05:43:06 +00:00
ConfigurationManager = configurationManager;
_fileSystem = fileSystem;
2013-02-23 07:57:11 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Creates the triggers that define when the task will run
/// </summary>
/// <returns>IEnumerable{BaseTaskTrigger}.</returns>
public IEnumerable<ITaskTrigger> GetDefaultTriggers()
2013-02-21 01:33:05 +00:00
{
2013-08-28 02:31:39 +00:00
// Until we can vary these default triggers per server and MBT, we need something that makes sense for both
return new ITaskTrigger[] {
// Every so often
new IntervalTrigger { Interval = TimeSpan.FromHours(24)}
};
2013-02-21 01:33:05 +00:00
}
/// <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)
2013-02-21 01:33:05 +00:00
{
// Delete log files more than n days old
var minDateModified = DateTime.UtcNow.AddDays(-(ConfigurationManager.CommonConfiguration.LogFileRetentionDays));
2015-09-13 21:32:02 +00:00
var filesToDelete = _fileSystem.GetFiles(ConfigurationManager.CommonApplicationPaths.LogDirectoryPath, true)
.Where(f => _fileSystem.GetLastWriteTimeUtc(f) < minDateModified)
.ToList();
2013-02-21 01:33:05 +00:00
var index = 0;
2013-02-21 01:33:05 +00:00
foreach (var file in filesToDelete)
{
double percent = index;
percent /= filesToDelete.Count;
2013-02-21 01:33:05 +00:00
progress.Report(100 * percent);
2013-02-21 01:33:05 +00:00
cancellationToken.ThrowIfCancellationRequested();
2013-02-21 01:33:05 +00:00
_fileSystem.DeleteFile(file.FullName);
2013-02-21 01:33:05 +00:00
index++;
}
2013-02-21 01:33:05 +00:00
progress.Report(100);
2013-02-21 01:33:05 +00:00
return Task.FromResult(true);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the name of the task
/// </summary>
/// <value>The name.</value>
public string Name
2013-02-21 01:33:05 +00:00
{
get { return "Log file cleanup"; }
}
/// <summary>
/// Gets the description.
/// </summary>
/// <value>The description.</value>
public string Description
2013-02-21 01:33:05 +00:00
{
2013-03-04 05:43:06 +00:00
get { return string.Format("Deletes log files that are more than {0} days old.", ConfigurationManager.CommonConfiguration.LogFileRetentionDays); }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the category.
/// </summary>
/// <value>The category.</value>
public string Category
2013-02-21 01:33:05 +00:00
{
get
{
return "Maintenance";
}
}
2013-12-26 14:20:45 +00:00
/// <summary>
/// Gets a value indicating whether this instance is hidden.
/// </summary>
/// <value><c>true</c> if this instance is hidden; otherwise, <c>false</c>.</value>
public bool IsHidden
{
get { return true; }
}
public bool IsEnabled
{
get { return true; }
}
2013-02-21 01:33:05 +00:00
}
}