From 2d06095447b972c8c7239277428e2c67c8b7ca86 Mon Sep 17 00:00:00 2001
From: LukePulverenti <luke.pulverenti@gmail.com>
Date: Mon, 25 Feb 2013 22:43:04 -0500
Subject: plugin security fixes and other abstractions

---
 .../ScheduledTasks/Tasks/ChapterImagesTask.cs      | 122 ++++++++++++
 .../ScheduledTasks/Tasks/ImageCleanupTask.cs       | 220 +++++++++++++++++++++
 .../ScheduledTasks/Tasks/PluginUpdateTask.cs       | 136 +++++++++++++
 3 files changed, 478 insertions(+)
 create mode 100644 MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs
 create mode 100644 MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ImageCleanupTask.cs
 create mode 100644 MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/PluginUpdateTask.cs

(limited to 'MediaBrowser.Server.Implementations/ScheduledTasks/Tasks')

diff --git a/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs b/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs
new file mode 100644
index 0000000000..d3854f9d79
--- /dev/null
+++ b/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ChapterImagesTask.cs
@@ -0,0 +1,122 @@
+using MediaBrowser.Common.ScheduledTasks;
+using MediaBrowser.Controller;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Model.Logging;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MediaBrowser.Server.Implementations.ScheduledTasks.Tasks
+{
+    /// <summary>
+    /// Class ChapterImagesTask
+    /// </summary>
+    class ChapterImagesTask : IScheduledTask
+    {
+        /// <summary>
+        /// The _kernel
+        /// </summary>
+        private readonly Kernel _kernel;
+        /// <summary>
+        /// The _logger
+        /// </summary>
+        private readonly ILogger _logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChapterImagesTask" /> class.
+        /// </summary>
+        /// <param name="kernel">The kernel.</param>
+        /// <param name="logger">The logger.</param>
+        public ChapterImagesTask(Kernel kernel, ILogger logger)
+        {
+            _kernel = kernel;
+            _logger = logger;
+        }
+
+        /// <summary>
+        /// Creates the triggers that define when the task will run
+        /// </summary>
+        /// <returns>IEnumerable{BaseTaskTrigger}.</returns>
+        public IEnumerable<ITaskTrigger> GetDefaultTriggers()
+        {
+            return new ITaskTrigger[]
+                {
+                    new DailyTrigger { TimeOfDay = TimeSpan.FromHours(4) }
+                };
+        }
+
+        /// <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)
+        {
+            var videos = _kernel.RootFolder.RecursiveChildren.OfType<Video>().Where(v => v.Chapters != null).ToList();
+
+            var numComplete = 0;
+
+            var tasks = videos.Select(v => Task.Run(async () =>
+            {
+                try
+                {
+                    await _kernel.FFMpegManager.PopulateChapterImages(v, cancellationToken, true, true);
+                }
+                catch (OperationCanceledException)
+                {
+                    throw;
+                }
+                catch (Exception ex)
+                {
+                    _logger.ErrorException("Error creating chapter images for {0}", ex, v.Name);
+                }
+                finally
+                {
+                    lock (progress)
+                    {
+                        numComplete++;
+                        double percent = numComplete;
+                        percent /= videos.Count;
+
+                        progress.Report(100 * percent);
+                    }
+                }
+            }));
+
+            return Task.WhenAll(tasks);
+        }
+
+        /// <summary>
+        /// Gets the name of the task
+        /// </summary>
+        /// <value>The name.</value>
+        public string Name
+        {
+            get { return "Create video chapter thumbnails"; }
+        }
+
+        /// <summary>
+        /// Gets the description.
+        /// </summary>
+        /// <value>The description.</value>
+        public string Description
+        {
+            get { return "Creates thumbnails for videos that have chapters."; }
+        }
+
+        /// <summary>
+        /// Gets the category.
+        /// </summary>
+        /// <value>The category.</value>
+        public string Category
+        {
+            get
+            {
+                return "Library";
+            }
+        }
+    }
+}
diff --git a/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ImageCleanupTask.cs b/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ImageCleanupTask.cs
new file mode 100644
index 0000000000..57f69e2e3f
--- /dev/null
+++ b/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/ImageCleanupTask.cs
@@ -0,0 +1,220 @@
+using MediaBrowser.Common.ScheduledTasks;
+using MediaBrowser.Controller;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Controller.Entities.Movies;
+using MediaBrowser.Model.Logging;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MediaBrowser.Server.Implementations.ScheduledTasks.Tasks
+{
+    /// <summary>
+    /// Class ImageCleanupTask
+    /// </summary>
+    public class ImageCleanupTask : IScheduledTask
+    {
+        /// <summary>
+        /// The _kernel
+        /// </summary>
+        private readonly Kernel _kernel;
+        /// <summary>
+        /// The _logger
+        /// </summary>
+        private readonly ILogger _logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ImageCleanupTask" /> class.
+        /// </summary>
+        /// <param name="kernel">The kernel.</param>
+        /// <param name="logger">The logger.</param>
+        public ImageCleanupTask(Kernel kernel, ILogger logger)
+        {
+            _kernel = kernel;
+            _logger = logger;
+        }
+
+        /// <summary>
+        /// Creates the triggers that define when the task will run
+        /// </summary>
+        /// <returns>IEnumerable{BaseTaskTrigger}.</returns>
+        public IEnumerable<ITaskTrigger> GetDefaultTriggers()
+        {
+            return new ITaskTrigger[]
+                {
+                    new DailyTrigger { TimeOfDay = TimeSpan.FromHours(2) }
+                };
+        }
+
+        /// <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 async Task Execute(CancellationToken cancellationToken, IProgress<double> progress)
+        {
+            await EnsureChapterImages(cancellationToken).ConfigureAwait(false);
+
+            // First gather all image files
+            var files = GetFiles(_kernel.FFMpegManager.AudioImagesDataPath)
+                .Concat(GetFiles(_kernel.FFMpegManager.VideoImagesDataPath))
+                .Concat(GetFiles(_kernel.ProviderManager.ImagesDataPath))
+                .ToList();
+
+            // Now gather all items
+            var items = _kernel.RootFolder.RecursiveChildren.ToList();
+            items.Add(_kernel.RootFolder);
+
+            // Determine all possible image paths
+            var pathsInUse = items.SelectMany(GetPathsInUse)
+                .Distinct(StringComparer.OrdinalIgnoreCase)
+                .ToDictionary(p => p, StringComparer.OrdinalIgnoreCase);
+
+            var numComplete = 0;
+
+            var tasks = files.Select(file => Task.Run(() =>
+            {
+                cancellationToken.ThrowIfCancellationRequested();
+
+                if (!pathsInUse.ContainsKey(file))
+                {
+                    cancellationToken.ThrowIfCancellationRequested();
+                    
+                    try
+                    {
+                        File.Delete(file);
+                    }
+                    catch (IOException ex)
+                    {
+                        _logger.ErrorException("Error deleting {0}", ex, file);
+                    }
+                }
+
+                // Update progress
+                lock (progress)
+                {
+                    numComplete++;
+                    double percent = numComplete;
+                    percent /= files.Count;
+
+                    progress.Report(100 * percent);
+                }
+            }));
+
+            await Task.WhenAll(tasks).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Ensures the chapter images.
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>Task.</returns>
+        private Task EnsureChapterImages(CancellationToken cancellationToken)
+        {
+            var videos = _kernel.RootFolder.RecursiveChildren.OfType<Video>().Where(v => v.Chapters != null).ToList();
+
+            var tasks = videos.Select(v => Task.Run(async () =>
+            {
+                await _kernel.FFMpegManager.PopulateChapterImages(v, cancellationToken, false, true);
+            }));
+
+            return Task.WhenAll(tasks);
+        }
+
+        /// <summary>
+        /// Gets the paths in use.
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <returns>IEnumerable{System.String}.</returns>
+        private IEnumerable<string> GetPathsInUse(BaseItem item)
+        {
+            IEnumerable<string> images = new List<string> { };
+
+            if (item.Images != null)
+            {
+                images = images.Concat(item.Images.Values);
+            }
+
+            if (item.BackdropImagePaths != null)
+            {
+                images = images.Concat(item.BackdropImagePaths);
+            }
+
+            if (item.ScreenshotImagePaths != null)
+            {
+                images = images.Concat(item.ScreenshotImagePaths);
+            }
+
+            var video = item as Video;
+
+            if (video != null && video.Chapters != null)
+            {
+                images = images.Concat(video.Chapters.Where(i => !string.IsNullOrEmpty(i.ImagePath)).Select(i => i.ImagePath));
+            }
+
+            if (item.LocalTrailers != null)
+            {
+                foreach (var subItem in item.LocalTrailers)
+                {
+                    images = images.Concat(GetPathsInUse(subItem));
+                }
+            }
+
+            var movie = item as Movie;
+
+            if (movie != null && movie.SpecialFeatures != null)
+            {
+                foreach (var subItem in movie.SpecialFeatures)
+                {
+                    images = images.Concat(GetPathsInUse(subItem));
+                }
+            }
+            
+            return images;
+        }
+
+        /// <summary>
+        /// Gets the files.
+        /// </summary>
+        /// <param name="path">The path.</param>
+        /// <returns>IEnumerable{System.String}.</returns>
+        private IEnumerable<string> GetFiles(string path)
+        {
+            return Directory.EnumerateFiles(path, "*.jpg", SearchOption.AllDirectories).Concat(Directory.EnumerateFiles(path, "*.png", SearchOption.AllDirectories));
+        }
+
+        /// <summary>
+        /// Gets the name of the task
+        /// </summary>
+        /// <value>The name.</value>
+        public string Name
+        {
+            get { return "Images cleanup"; }
+        }
+
+        /// <summary>
+        /// Gets the description.
+        /// </summary>
+        /// <value>The description.</value>
+        public string Description
+        {
+            get { return "Deletes downloaded and extracted images that are no longer being used."; }
+        }
+
+        /// <summary>
+        /// Gets the category.
+        /// </summary>
+        /// <value>The category.</value>
+        public string Category
+        {
+            get
+            {
+                return "Maintenance";
+            }
+        }
+    }
+}
diff --git a/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/PluginUpdateTask.cs b/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/PluginUpdateTask.cs
new file mode 100644
index 0000000000..01a0458535
--- /dev/null
+++ b/MediaBrowser.Server.Implementations/ScheduledTasks/Tasks/PluginUpdateTask.cs
@@ -0,0 +1,136 @@
+using MediaBrowser.Common.ScheduledTasks;
+using MediaBrowser.Model.Logging;
+using MediaBrowser.Model.Net;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MediaBrowser.Controller.ScheduledTasks
+{
+    /// <summary>
+    /// Plugin Update Task
+    /// </summary>
+    public class PluginUpdateTask : IScheduledTask
+    {
+        /// <summary>
+        /// The _kernel
+        /// </summary>
+        private readonly Kernel _kernel;
+        /// <summary>
+        /// The _logger
+        /// </summary>
+        private readonly ILogger _logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PluginUpdateTask" /> class.
+        /// </summary>
+        /// <param name="kernel">The kernel.</param>
+        /// <param name="logger">The logger.</param>
+        public PluginUpdateTask(Kernel kernel, ILogger logger)
+        {
+            _kernel = kernel;
+            _logger = logger;
+        }
+
+        /// <summary>
+        /// Creates the triggers that define when the task will run
+        /// </summary>
+        /// <returns>IEnumerable{BaseTaskTrigger}.</returns>
+        public IEnumerable<ITaskTrigger> GetDefaultTriggers()
+        {
+            return new ITaskTrigger[] { 
+            
+                // 1:30am
+                new DailyTrigger { TimeOfDay = TimeSpan.FromHours(1.5) },
+
+                new IntervalTrigger { Interval = TimeSpan.FromHours(2)}
+            };
+        }
+
+        /// <summary>
+        /// Update installed plugins
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <param name="progress">The progress.</param>
+        /// <returns>Task.</returns>
+        public async Task Execute(CancellationToken cancellationToken, IProgress<double> progress)
+        {
+            progress.Report(0);
+
+            var packagesToInstall = (await _kernel.InstallationManager.GetAvailablePluginUpdates(true, cancellationToken).ConfigureAwait(false)).ToList();
+
+            progress.Report(10);
+
+            var numComplete = 0;
+
+            // Create tasks for each one
+            var tasks = packagesToInstall.Select(i => Task.Run(async () =>
+            {
+                cancellationToken.ThrowIfCancellationRequested();
+
+                try
+                {
+                    await _kernel.InstallationManager.InstallPackage(i, new Progress<double> { }, cancellationToken).ConfigureAwait(false);
+                }
+                catch (OperationCanceledException)
+                {
+                    // InstallPackage has it's own inner cancellation token, so only throw this if it's ours
+                    if (cancellationToken.IsCancellationRequested)
+                    {
+                        throw;
+                    }
+                }
+                catch (HttpException ex)
+                {
+                    _logger.ErrorException("Error downloading {0}", ex, i.name);
+                }
+                catch (IOException ex)
+                {
+                    _logger.ErrorException("Error updating {0}", ex, i.name);
+                }
+
+                // Update progress
+                lock (progress)
+                {
+                    numComplete++;
+                    double percent = numComplete;
+                    percent /= packagesToInstall.Count;
+
+                    progress.Report((90 * percent) + 10);
+                }
+            }));
+
+            cancellationToken.ThrowIfCancellationRequested();
+
+            await Task.WhenAll(tasks).ConfigureAwait(false);
+
+            progress.Report(100);
+        }
+
+        /// <summary>
+        /// Gets the name of the task
+        /// </summary>
+        /// <value>The name.</value>
+        public string Name
+        {
+            get { return "Check for plugin updates"; }
+        }
+
+        /// <summary>
+        /// Gets the description.
+        /// </summary>
+        /// <value>The description.</value>
+        public string Description
+        {
+            get { return "Downloads and installs updates for plugins that are configured to update automatically."; }
+        }
+
+        public string Category
+        {
+            get { return "Application"; }
+        }
+    }
+}
\ No newline at end of file
-- 
cgit v1.2.3