From 8b7effd6ff1694688e93d03a48c5dcddb4efe4f0 Mon Sep 17 00:00:00 2001 From: LukePulverenti Luke Pulverenti luke pulverenti Date: Tue, 18 Sep 2012 15:33:57 -0400 Subject: [PATCH] Moved discovery of loggers and weather providers to MEF. Also added support for third-party image processors, also discovered through MEF. --- MediaBrowser.Api/HttpHandlers/ImageHandler.cs | 110 +++++++++++------- MediaBrowser.Api/HttpHandlers/VideoHandler.cs | 5 +- .../HttpHandlers/WeatherHandler.cs | 3 +- MediaBrowser.Api/MediaBrowser.Api.csproj | 1 - MediaBrowser.Api/Plugin.cs | 1 - MediaBrowser.Common/Kernel/BaseKernel.cs | 106 ++++++----------- MediaBrowser.Common/Logging/BaseLogger.cs | 86 +------------- MediaBrowser.Common/Logging/LogSeverity.cs | 4 +- MediaBrowser.Common/Logging/Logger.cs | 66 ++++++++++- MediaBrowser.Common/Logging/StreamLogger.cs | 37 ------ .../Logging/TraceFileLogger.cs | 38 ++++++ MediaBrowser.Common/Logging/TraceLogger.cs | 12 -- .../MediaBrowser.Common.csproj | 8 +- MediaBrowser.Common/Plugins/BasePlugin.cs | 3 + MediaBrowser.Common/UI/BaseApplication.cs | 5 +- .../Drawing/BaseImageProcessor.cs | 33 ++++++ .../Drawing/DrawingUtils.cs | 2 +- .../Drawing}/ImageProcessor.cs | 68 +++++++++-- MediaBrowser.Controller/Kernel.cs | 46 +++----- .../MediaBrowser.Controller.csproj | 7 +- .../Weather/BaseWeatherProvider.cs | 34 ++++++ .../{WeatherClient.cs => WeatherProvider.cs} | 26 +---- MediaBrowser.sln | 3 + 23 files changed, 370 insertions(+), 334 deletions(-) delete mode 100644 MediaBrowser.Common/Logging/StreamLogger.cs create mode 100644 MediaBrowser.Common/Logging/TraceFileLogger.cs delete mode 100644 MediaBrowser.Common/Logging/TraceLogger.cs create mode 100644 MediaBrowser.Controller/Drawing/BaseImageProcessor.cs rename {MediaBrowser.Common => MediaBrowser.Controller}/Drawing/DrawingUtils.cs (95%) rename {MediaBrowser.Api => MediaBrowser.Controller/Drawing}/ImageProcessor.cs (52%) create mode 100644 MediaBrowser.Controller/Weather/BaseWeatherProvider.cs rename MediaBrowser.Controller/Weather/{WeatherClient.cs => WeatherProvider.cs} (87%) diff --git a/MediaBrowser.Api/HttpHandlers/ImageHandler.cs b/MediaBrowser.Api/HttpHandlers/ImageHandler.cs index f73f783afb..73098c71b5 100644 --- a/MediaBrowser.Api/HttpHandlers/ImageHandler.cs +++ b/MediaBrowser.Api/HttpHandlers/ImageHandler.cs @@ -2,6 +2,7 @@ using MediaBrowser.Common.Net; using MediaBrowser.Common.Net.Handlers; using MediaBrowser.Controller; +using MediaBrowser.Controller.Drawing; using MediaBrowser.Controller.Entities; using MediaBrowser.Model.Entities; using System; @@ -20,7 +21,7 @@ namespace MediaBrowser.Api.HttpHandlers { return ApiService.IsApiUrlMatch("image", request); } - + private string _imagePath; private async Task GetImagePath() { @@ -29,49 +30,57 @@ namespace MediaBrowser.Api.HttpHandlers return _imagePath; } + private BaseEntity _sourceEntity; + private async Task GetSourceEntity() + { + if (_sourceEntity == null) + { + if (!string.IsNullOrEmpty(QueryString["personname"])) + { + _sourceEntity = await Kernel.Instance.ItemController.GetPerson(QueryString["personname"]).ConfigureAwait(false); + } + + else if (!string.IsNullOrEmpty(QueryString["genre"])) + { + _sourceEntity = await Kernel.Instance.ItemController.GetGenre(QueryString["genre"]).ConfigureAwait(false); + } + + else if (!string.IsNullOrEmpty(QueryString["year"])) + { + _sourceEntity = await Kernel.Instance.ItemController.GetYear(int.Parse(QueryString["year"])).ConfigureAwait(false); + } + + else if (!string.IsNullOrEmpty(QueryString["studio"])) + { + _sourceEntity = await Kernel.Instance.ItemController.GetStudio(QueryString["studio"]).ConfigureAwait(false); + } + + else if (!string.IsNullOrEmpty(QueryString["userid"])) + { + _sourceEntity = ApiService.GetUserById(QueryString["userid"], false); + } + + else + { + _sourceEntity = ApiService.GetItemById(QueryString["id"]); + } + } + + return _sourceEntity; + } + private async Task DiscoverImagePath() { - string personName = QueryString["personname"]; + var entity = await GetSourceEntity().ConfigureAwait(false); - if (!string.IsNullOrEmpty(personName)) + var item = entity as BaseItem; + + if (item != null) { - return (await Kernel.Instance.ItemController.GetPerson(personName).ConfigureAwait(false)).PrimaryImagePath; + return GetImagePathFromTypes(item, ImageType, ImageIndex); } - string genreName = QueryString["genre"]; - - if (!string.IsNullOrEmpty(genreName)) - { - return (await Kernel.Instance.ItemController.GetGenre(genreName).ConfigureAwait(false)).PrimaryImagePath; - } - - string year = QueryString["year"]; - - if (!string.IsNullOrEmpty(year)) - { - return (await Kernel.Instance.ItemController.GetYear(int.Parse(year)).ConfigureAwait(false)).PrimaryImagePath; - } - - string studio = QueryString["studio"]; - - if (!string.IsNullOrEmpty(studio)) - { - return (await Kernel.Instance.ItemController.GetStudio(studio).ConfigureAwait(false)).PrimaryImagePath; - } - - string userId = QueryString["userid"]; - - if (!string.IsNullOrEmpty(userId)) - { - return ApiService.GetUserById(userId, false).PrimaryImagePath; - } - - BaseItem item = ApiService.GetItemById(QueryString["id"]); - - string imageIndex = QueryString["index"]; - int index = string.IsNullOrEmpty(imageIndex) ? 0 : int.Parse(imageIndex); - - return GetImagePathFromTypes(item, ImageType, index); + return entity.PrimaryImagePath; } private Stream _sourceStream; @@ -114,8 +123,6 @@ namespace MediaBrowser.Api.HttpHandlers public async override Task GetContentType() { - await EnsureSourceStream().ConfigureAwait(false); - if (await GetSourceStream().ConfigureAwait(false) == null) { return null; @@ -134,8 +141,6 @@ namespace MediaBrowser.Api.HttpHandlers protected async override Task GetLastDateModified() { - await EnsureSourceStream().ConfigureAwait(false); - if (await GetSourceStream().ConfigureAwait(false) == null) { return null; @@ -144,6 +149,21 @@ namespace MediaBrowser.Api.HttpHandlers return File.GetLastWriteTimeUtc(await GetImagePath().ConfigureAwait(false)); } + private int ImageIndex + { + get + { + string val = QueryString["index"]; + + if (string.IsNullOrEmpty(val)) + { + return 0; + } + + return int.Parse(val); + } + } + private int? Height { get @@ -236,7 +256,11 @@ namespace MediaBrowser.Api.HttpHandlers protected override async Task WriteResponseToOutputStream(Stream stream) { - ImageProcessor.ProcessImage(await GetSourceStream().ConfigureAwait(false), stream, Width, Height, MaxWidth, MaxHeight, Quality); + Stream sourceStream = await GetSourceStream().ConfigureAwait(false); + + var entity = await GetSourceEntity().ConfigureAwait(false); + + ImageProcessor.ProcessImage(sourceStream, stream, Width, Height, MaxWidth, MaxHeight, Quality, entity, ImageType, ImageIndex); } private string GetImagePathFromTypes(BaseItem item, ImageType imageType, int imageIndex) diff --git a/MediaBrowser.Api/HttpHandlers/VideoHandler.cs b/MediaBrowser.Api/HttpHandlers/VideoHandler.cs index 9d52136f0a..e34a1b41f7 100644 --- a/MediaBrowser.Api/HttpHandlers/VideoHandler.cs +++ b/MediaBrowser.Api/HttpHandlers/VideoHandler.cs @@ -1,5 +1,5 @@ -using MediaBrowser.Common.Drawing; -using MediaBrowser.Common.Net.Handlers; +using MediaBrowser.Common.Net.Handlers; +using MediaBrowser.Controller.Drawing; using MediaBrowser.Controller.Entities; using MediaBrowser.Model.DTO; using MediaBrowser.Model.Entities; @@ -7,7 +7,6 @@ using System; using System.Collections.Generic; using System.ComponentModel.Composition; using System.Drawing; -using System.IO; using System.Linq; using System.Net; diff --git a/MediaBrowser.Api/HttpHandlers/WeatherHandler.cs b/MediaBrowser.Api/HttpHandlers/WeatherHandler.cs index 93d4c8877e..90ecae1222 100644 --- a/MediaBrowser.Api/HttpHandlers/WeatherHandler.cs +++ b/MediaBrowser.Api/HttpHandlers/WeatherHandler.cs @@ -3,6 +3,7 @@ using MediaBrowser.Controller; using MediaBrowser.Model.Weather; using System; using System.ComponentModel.Composition; +using System.Linq; using System.Net; using System.Threading.Tasks; @@ -27,7 +28,7 @@ namespace MediaBrowser.Api.HttpHandlers zipCode = Kernel.Instance.Configuration.WeatherZipCode; } - return Kernel.Instance.WeatherClient.GetWeatherInfoAsync(zipCode); + return Kernel.Instance.WeatherProviders.First().GetWeatherInfoAsync(zipCode); } /// diff --git a/MediaBrowser.Api/MediaBrowser.Api.csproj b/MediaBrowser.Api/MediaBrowser.Api.csproj index 858717e6ed..44b58852b8 100644 --- a/MediaBrowser.Api/MediaBrowser.Api.csproj +++ b/MediaBrowser.Api/MediaBrowser.Api.csproj @@ -83,7 +83,6 @@ - diff --git a/MediaBrowser.Api/Plugin.cs b/MediaBrowser.Api/Plugin.cs index b2bcefd1f7..8def96da8d 100644 --- a/MediaBrowser.Api/Plugin.cs +++ b/MediaBrowser.Api/Plugin.cs @@ -1,5 +1,4 @@ using MediaBrowser.Common.Plugins; -using MediaBrowser.Model.Plugins; using System.ComponentModel.Composition; namespace MediaBrowser.Api diff --git a/MediaBrowser.Common/Kernel/BaseKernel.cs b/MediaBrowser.Common/Kernel/BaseKernel.cs index 0eebc863c7..5a0e1c5e5d 100644 --- a/MediaBrowser.Common/Kernel/BaseKernel.cs +++ b/MediaBrowser.Common/Kernel/BaseKernel.cs @@ -10,7 +10,6 @@ using System; using System.Collections.Generic; using System.ComponentModel.Composition; using System.ComponentModel.Composition.Hosting; -using System.Diagnostics; using System.IO; using System.Linq; using System.Reflection; @@ -72,6 +71,12 @@ namespace MediaBrowser.Common.Kernel [ImportMany(typeof(BaseHandler))] private IEnumerable HttpHandlers { get; set; } + /// + /// Gets the list of currently registered Loggers + /// + [ImportMany(typeof(BaseLogger))] + public IEnumerable Loggers { get; set; } + /// /// Both the Ui and server will have a built-in HttpServer. /// People will inevitably want remote control apps so it's needed in the Ui too. @@ -83,6 +88,8 @@ namespace MediaBrowser.Common.Kernel /// private IDisposable HttpListener { get; set; } + private CompositionContainer CompositionContainer { get; set; } + protected virtual string HttpServerUrlPrefix { get @@ -101,13 +108,13 @@ namespace MediaBrowser.Common.Kernel /// public async Task Init(IProgress progress) { + Logger.Kernel = this; + // Performs initializations that only occur once InitializeInternal(progress); // Performs initializations that can be reloaded at anytime await Reload(progress).ConfigureAwait(false); - - ReportProgress(progress, "Loading Complete"); } /// @@ -117,8 +124,6 @@ namespace MediaBrowser.Common.Kernel { ApplicationPaths = new TApplicationPathsType(); - ReloadLogger(); - ReportProgress(progress, "Loading Configuration"); ReloadConfiguration(); @@ -136,6 +141,8 @@ namespace MediaBrowser.Common.Kernel await ReloadInternal(progress).ConfigureAwait(false); OnReloadCompleted(progress); + + ReportProgress(progress, "Kernel.Reload Complete"); } /// @@ -151,23 +158,6 @@ namespace MediaBrowser.Common.Kernel }).ConfigureAwait(false); } - /// - /// Disposes the current logger and creates a new one - /// - private void ReloadLogger() - { - DisposeLogger(); - - DateTime now = DateTime.Now; - - string logFilePath = Path.Combine(ApplicationPaths.LogDirectoryPath, "log-" + now.ToString("dMyyyy") + "-" + now.Ticks + ".log"); - - Trace.Listeners.Add(new TextWriterTraceListener(logFilePath)); - Trace.AutoFlush = true; - - Logger.LoggerInstance = new TraceLogger(); - } - /// /// Uses MEF to locate plugins /// Subclasses can use this to locate types within plugins @@ -176,14 +166,13 @@ namespace MediaBrowser.Common.Kernel { DisposeComposableParts(); - var container = GetCompositionContainer(includeCurrentAssembly: true); + CompositionContainer = GetCompositionContainer(includeCurrentAssembly: true); - container.ComposeParts(this); + CompositionContainer.ComposeParts(this); OnComposablePartsLoaded(); - container.Catalog.Dispose(); - container.Dispose(); + CompositionContainer.Catalog.Dispose(); } /// @@ -198,8 +187,7 @@ namespace MediaBrowser.Common.Kernel var catalog = new AggregateCatalog(pluginAssemblies.Select(a => new AssemblyCatalog(a))); // Include composable parts in the Common assembly - // Uncomment this if it's ever needed - //catalog.Catalogs.Add(new AssemblyCatalog(Assembly.GetExecutingAssembly())); + catalog.Catalogs.Add(new AssemblyCatalog(Assembly.GetExecutingAssembly())); if (includeCurrentAssembly) { @@ -215,8 +203,13 @@ namespace MediaBrowser.Common.Kernel /// protected virtual void OnComposablePartsLoaded() { + foreach (var logger in Loggers) + { + logger.Initialize(this); + } + // Start-up each plugin - foreach (BasePlugin plugin in Plugins) + foreach (var plugin in Plugins) { plugin.Initialize(this); } @@ -230,17 +223,16 @@ namespace MediaBrowser.Common.Kernel //Configuration information for anything other than server-specific configuration will have to come via the API... -ebr // Deserialize config - if (!File.Exists(ApplicationPaths.SystemConfigurationFilePath)) + // Use try/catch to avoid the extra file system lookup using File.Exists + try + { + Configuration = XmlSerializer.DeserializeFromFile(ApplicationPaths.SystemConfigurationFilePath); + } + catch (FileNotFoundException) { Configuration = new TConfigurationType(); XmlSerializer.SerializeToFile(Configuration, ApplicationPaths.SystemConfigurationFilePath); } - else - { - Configuration = XmlSerializer.DeserializeFromFile(ApplicationPaths.SystemConfigurationFilePath); - } - - Logger.LoggerInstance.LogSeverity = Configuration.EnableDebugLevelLogging ? LogSeverity.Debug : LogSeverity.Info; } /// @@ -275,11 +267,9 @@ namespace MediaBrowser.Common.Kernel { Logger.LogInfo("Beginning Kernel.Dispose"); - DisposeComposableParts(); - DisposeHttpServer(); - DisposeLogger(); + DisposeComposableParts(); } /// @@ -287,22 +277,9 @@ namespace MediaBrowser.Common.Kernel /// protected virtual void DisposeComposableParts() { - DisposePlugins(); - } - - /// - /// Disposes all plugins - /// - private void DisposePlugins() - { - if (Plugins != null) + if (CompositionContainer != null) { - Logger.LogInfo("Disposing Plugins"); - - foreach (BasePlugin plugin in Plugins) - { - plugin.Dispose(); - } + CompositionContainer.Dispose(); } } @@ -324,21 +301,6 @@ namespace MediaBrowser.Common.Kernel } } - /// - /// Disposes the current Logger instance - /// - private void DisposeLogger() - { - Trace.Listeners.Clear(); - - if (Logger.LoggerInstance != null) - { - Logger.LogInfo("Disposing Logger"); - - Logger.LoggerInstance.Dispose(); - } - } - /// /// Gets the current application version /// @@ -354,10 +316,7 @@ namespace MediaBrowser.Common.Kernel { progress.Report(new TaskProgress { Description = message }); - if (Logger.LoggerInstance != null) - { - Logger.LogInfo(message); - } + Logger.LogInfo(message); } BaseApplicationPaths IKernel.ApplicationPaths @@ -373,6 +332,7 @@ namespace MediaBrowser.Common.Kernel Task Init(IProgress progress); Task Reload(IProgress progress); + IEnumerable Loggers { get; } void Dispose(); } } diff --git a/MediaBrowser.Common/Logging/BaseLogger.cs b/MediaBrowser.Common/Logging/BaseLogger.cs index 572ce36b2d..a97bc201f2 100644 --- a/MediaBrowser.Common/Logging/BaseLogger.cs +++ b/MediaBrowser.Common/Logging/BaseLogger.cs @@ -1,92 +1,16 @@ -using System; -using System.Text; -using System.Threading; +using MediaBrowser.Common.Kernel; +using System; namespace MediaBrowser.Common.Logging { public abstract class BaseLogger : IDisposable { - public LogSeverity LogSeverity { get; set; } - - public void LogInfo(string message, params object[] paramList) - { - LogEntry(message, LogSeverity.Info, paramList); - } - - public void LogDebugInfo(string message, params object[] paramList) - { - LogEntry(message, LogSeverity.Debug, paramList); - } - - public void LogError(string message, params object[] paramList) - { - LogEntry(message, LogSeverity.Error, paramList); - } - - public void LogException(string message, Exception exception, params object[] paramList) - { - var builder = new StringBuilder(); - - if (exception != null) - { - builder.AppendFormat("Exception. Type={0} Msg={1} StackTrace={3}{2}", - exception.GetType().FullName, - exception.Message, - exception.StackTrace, - Environment.NewLine); - } - - message = FormatMessage(message, paramList); - - LogError(string.Format("{0} ( {1} )", message, builder)); - } - - public void LogWarning(string message, params object[] paramList) - { - LogEntry(message, LogSeverity.Warning, paramList); - } - - private string FormatMessage(string message, params object[] paramList) - { - if (paramList != null) - { - for (int i = 0; i < paramList.Length; i++) - { - message = message.Replace("{" + i + "}", paramList[i].ToString()); - } - } - - return message; - } - - private void LogEntry(string message, LogSeverity severity, params object[] paramList) - { - if (severity < LogSeverity) return; - - message = FormatMessage(message, paramList); - - Thread currentThread = Thread.CurrentThread; - - var row = new LogRow - { - Severity = severity, - Message = message, - ThreadId = currentThread.ManagedThreadId, - ThreadName = currentThread.Name, - Time = DateTime.Now - }; - - LogEntry(row); - } - - protected virtual void Flush() - { - } + public abstract void Initialize(IKernel kernel); + public abstract void LogEntry(LogRow row); public virtual void Dispose() { + Logger.LogInfo("Disposing " + GetType().Name); } - - protected abstract void LogEntry(LogRow row); } } diff --git a/MediaBrowser.Common/Logging/LogSeverity.cs b/MediaBrowser.Common/Logging/LogSeverity.cs index 2abab1a448..97abfe7b58 100644 --- a/MediaBrowser.Common/Logging/LogSeverity.cs +++ b/MediaBrowser.Common/Logging/LogSeverity.cs @@ -1,4 +1,4 @@ -using System; +using System; namespace MediaBrowser.Common.Logging { @@ -11,4 +11,4 @@ namespace MediaBrowser.Common.Logging Warning = 4, Error = 8 } -} +} \ No newline at end of file diff --git a/MediaBrowser.Common/Logging/Logger.cs b/MediaBrowser.Common/Logging/Logger.cs index e66c1d8444..9ac02fe3ea 100644 --- a/MediaBrowser.Common/Logging/Logger.cs +++ b/MediaBrowser.Common/Logging/Logger.cs @@ -1,24 +1,28 @@ using System; +using System.Diagnostics; +using System.Text; +using System.Threading; +using MediaBrowser.Common.Kernel; namespace MediaBrowser.Common.Logging { public static class Logger { - public static BaseLogger LoggerInstance { get; set; } + internal static IKernel Kernel { get; set; } public static void LogInfo(string message, params object[] paramList) { - LoggerInstance.LogInfo(message, paramList); + LogEntry(message, LogSeverity.Info, paramList); } public static void LogDebugInfo(string message, params object[] paramList) { - LoggerInstance.LogDebugInfo(message, paramList); + LogEntry(message, LogSeverity.Debug, paramList); } public static void LogError(string message, params object[] paramList) { - LoggerInstance.LogError(message, paramList); + LogEntry(message, LogSeverity.Error, paramList); } public static void LogException(Exception ex, params object[] paramList) @@ -28,12 +32,62 @@ namespace MediaBrowser.Common.Logging public static void LogException(string message, Exception ex, params object[] paramList) { - LoggerInstance.LogException(message, ex, paramList); + var builder = new StringBuilder(); + + if (ex != null) + { + builder.AppendFormat("Exception. Type={0} Msg={1} StackTrace={3}{2}", + ex.GetType().FullName, + ex.Message, + ex.StackTrace, + Environment.NewLine); + } + + message = FormatMessage(message, paramList); + + LogError(string.Format("{0} ( {1} )", message, builder)); } public static void LogWarning(string message, params object[] paramList) { - LoggerInstance.LogWarning(message, paramList); + LogEntry(message, LogSeverity.Warning, paramList); + } + + private static void LogEntry(string message, LogSeverity severity, params object[] paramList) + { + message = FormatMessage(message, paramList); + + Thread currentThread = Thread.CurrentThread; + + var row = new LogRow + { + Severity = severity, + Message = message, + ThreadId = currentThread.ManagedThreadId, + ThreadName = currentThread.Name, + Time = DateTime.Now + }; + + if (Kernel.Loggers != null) + { + foreach (var logger in Kernel.Loggers) + { + logger.LogEntry(row); + } + } + } + + private static string FormatMessage(string message, params object[] paramList) + { + if (paramList != null) + { + for (int i = 0; i < paramList.Length; i++) + { + message = message.Replace("{" + i + "}", paramList[i].ToString()); + } + } + + return message; } } } diff --git a/MediaBrowser.Common/Logging/StreamLogger.cs b/MediaBrowser.Common/Logging/StreamLogger.cs deleted file mode 100644 index 03b9bd6d26..0000000000 --- a/MediaBrowser.Common/Logging/StreamLogger.cs +++ /dev/null @@ -1,37 +0,0 @@ -using System; -using System.IO; -using System.Text; - -namespace MediaBrowser.Common.Logging -{ - /// - /// Provides a Logger that can write to any Stream - /// - public class StreamLogger : BaseLogger - { - private Stream Stream { get; set; } - - public StreamLogger(Stream stream) - : base() - { - Stream = stream; - } - - protected override void LogEntry(LogRow row) - { - byte[] bytes = new UTF8Encoding().GetBytes(row.ToString() + Environment.NewLine); - - lock (Stream) - { - Stream.Write(bytes, 0, bytes.Length); - Stream.Flush(); - } - } - - public override void Dispose() - { - base.Dispose(); - Stream.Dispose(); - } - } -} diff --git a/MediaBrowser.Common/Logging/TraceFileLogger.cs b/MediaBrowser.Common/Logging/TraceFileLogger.cs new file mode 100644 index 0000000000..7ab67a137e --- /dev/null +++ b/MediaBrowser.Common/Logging/TraceFileLogger.cs @@ -0,0 +1,38 @@ +using MediaBrowser.Common.Kernel; +using System; +using System.ComponentModel.Composition; +using System.Diagnostics; +using System.IO; + +namespace MediaBrowser.Common.Logging +{ + [Export(typeof(BaseLogger))] + public class TraceFileLogger : BaseLogger + { + private TraceListener Listener { get; set; } + + public override void Initialize(IKernel kernel) + { + DateTime now = DateTime.Now; + + string logFilePath = Path.Combine(kernel.ApplicationPaths.LogDirectoryPath, "log-" + now.ToString("dMyyyy") + "-" + now.Ticks + ".log"); + + Listener = new TextWriterTraceListener(logFilePath); + Trace.Listeners.Add(Listener); + Trace.AutoFlush = true; + } + + public override void Dispose() + { + base.Dispose(); + + Trace.Listeners.Remove(Listener); + Listener.Dispose(); + } + + public override void LogEntry(LogRow row) + { + Trace.WriteLine(row.ToString()); + } + } +} diff --git a/MediaBrowser.Common/Logging/TraceLogger.cs b/MediaBrowser.Common/Logging/TraceLogger.cs deleted file mode 100644 index d152f97806..0000000000 --- a/MediaBrowser.Common/Logging/TraceLogger.cs +++ /dev/null @@ -1,12 +0,0 @@ -using System.Diagnostics; - -namespace MediaBrowser.Common.Logging -{ - public class TraceLogger : BaseLogger - { - protected override void LogEntry(LogRow row) - { - Trace.WriteLine(row.ToString()); - } - } -} diff --git a/MediaBrowser.Common/MediaBrowser.Common.csproj b/MediaBrowser.Common/MediaBrowser.Common.csproj index 16b4f236ca..ce5f4e34ea 100644 --- a/MediaBrowser.Common/MediaBrowser.Common.csproj +++ b/MediaBrowser.Common/MediaBrowser.Common.csproj @@ -83,8 +83,9 @@ - - + + + @@ -96,11 +97,8 @@ - - - diff --git a/MediaBrowser.Common/Plugins/BasePlugin.cs b/MediaBrowser.Common/Plugins/BasePlugin.cs index 23825db045..a764c5eab6 100644 --- a/MediaBrowser.Common/Plugins/BasePlugin.cs +++ b/MediaBrowser.Common/Plugins/BasePlugin.cs @@ -1,4 +1,5 @@ using MediaBrowser.Common.Kernel; +using MediaBrowser.Common.Logging; using MediaBrowser.Common.Serialization; using MediaBrowser.Model.Plugins; using System; @@ -200,6 +201,8 @@ namespace MediaBrowser.Common.Plugins /// public void Dispose() { + Logger.LogInfo("Disposing {0} Plugin", Name); + if (Context == KernelContext.Server) { DisposeOnServer(); diff --git a/MediaBrowser.Common/UI/BaseApplication.cs b/MediaBrowser.Common/UI/BaseApplication.cs index 90583da4d0..c3792c714a 100644 --- a/MediaBrowser.Common/UI/BaseApplication.cs +++ b/MediaBrowser.Common/UI/BaseApplication.cs @@ -64,10 +64,7 @@ namespace MediaBrowser.Common.UI } catch (Exception ex) { - if (Logger.LoggerInstance != null) - { - Logger.LogException(ex); - } + Logger.LogException(ex); MessageBox.Show("There was an error launching Media Browser: " + ex.Message); splash.Close(); diff --git a/MediaBrowser.Controller/Drawing/BaseImageProcessor.cs b/MediaBrowser.Controller/Drawing/BaseImageProcessor.cs new file mode 100644 index 0000000000..a2b223a707 --- /dev/null +++ b/MediaBrowser.Controller/Drawing/BaseImageProcessor.cs @@ -0,0 +1,33 @@ +using MediaBrowser.Controller.Entities; +using MediaBrowser.Model.Entities; +using System.Drawing; + +namespace MediaBrowser.Controller.Drawing +{ + /// + /// Provides a base image processor class that plugins can use to process images as they are being writen to http responses + /// Since this is completely modular with MEF, a plugin only needs to have a subclass in their assembly with the following attribute on the class: + /// [Export(typeof(BaseImageProcessor))] + /// This will require a reference to System.ComponentModel.Composition + /// + public abstract class BaseImageProcessor + { + /// + /// Processes the primary image for a BaseEntity (Person, Studio, User, etc) + /// + /// The bitmap holding the original image, after re-sizing + /// The graphics surface on which the output is drawn + /// The entity that owns the image + public abstract void ProcessImage(Bitmap bitmap, Graphics graphics, BaseEntity entity); + + /// + /// Processes an image for a BaseItem + /// + /// The bitmap holding the original image, after re-sizing + /// The graphics surface on which the output is drawn + /// The entity that owns the image + /// The image type + /// The image index (currently only used with backdrops) + public abstract void ProcessImage(Bitmap bitmap, Graphics graphics, BaseItem entity, ImageType imageType, int imageIndex); + } +} diff --git a/MediaBrowser.Common/Drawing/DrawingUtils.cs b/MediaBrowser.Controller/Drawing/DrawingUtils.cs similarity index 95% rename from MediaBrowser.Common/Drawing/DrawingUtils.cs rename to MediaBrowser.Controller/Drawing/DrawingUtils.cs index 4c0b5c207d..8e2f829b98 100644 --- a/MediaBrowser.Common/Drawing/DrawingUtils.cs +++ b/MediaBrowser.Controller/Drawing/DrawingUtils.cs @@ -1,7 +1,7 @@ using System; using System.Drawing; -namespace MediaBrowser.Common.Drawing +namespace MediaBrowser.Controller.Drawing { public static class DrawingUtils { diff --git a/MediaBrowser.Api/ImageProcessor.cs b/MediaBrowser.Controller/Drawing/ImageProcessor.cs similarity index 52% rename from MediaBrowser.Api/ImageProcessor.cs rename to MediaBrowser.Controller/Drawing/ImageProcessor.cs index f02b90c220..b7815750b5 100644 --- a/MediaBrowser.Api/ImageProcessor.cs +++ b/MediaBrowser.Controller/Drawing/ImageProcessor.cs @@ -1,26 +1,34 @@ -using MediaBrowser.Common.Drawing; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Model.Entities; using System; using System.Drawing; using System.Drawing.Drawing2D; using System.Drawing.Imaging; using System.IO; +using System.Linq; -namespace MediaBrowser.Api +namespace MediaBrowser.Controller.Drawing { public static class ImageProcessor { /// - /// Resizes an image from a source stream and saves the result to an output stream + /// Processes an image by resizing to target dimensions /// + /// The stream containing the source image + /// The stream to save the new image to /// Use if a fixed width is required. Aspect ratio will be preserved. /// Use if a fixed height is required. Aspect ratio will be preserved. /// Use if a max width is required. Aspect ratio will be preserved. /// Use if a max height is required. Aspect ratio will be preserved. /// Quality level, from 0-100. Currently only applies to JPG. The default value should suffice. - public static void ProcessImage(Stream sourceImageStream, Stream toStream, int? width, int? height, int? maxWidth, int? maxHeight, int? quality) + /// The entity that owns the image + /// The image type + /// The image index (currently only used with backdrops) + public static void ProcessImage(Stream sourceImageStream, Stream toStream, int? width, int? height, int? maxWidth, int? maxHeight, int? quality, BaseEntity entity, ImageType imageType, int imageIndex) { Image originalImage = Image.FromStream(sourceImageStream); + // Determine the output size based on incoming parameters Size newSize = DrawingUtils.Resize(originalImage.Size, width, height, maxWidth, maxHeight); Bitmap thumbnail; @@ -35,6 +43,7 @@ namespace MediaBrowser.Api thumbnail = new Bitmap(newSize.Width, newSize.Height, originalImage.PixelFormat); } + // Preserve the original resolution thumbnail.SetResolution(originalImage.HorizontalResolution, originalImage.VerticalResolution); Graphics thumbnailGraph = Graphics.FromImage(thumbnail); @@ -47,32 +56,67 @@ namespace MediaBrowser.Api thumbnailGraph.DrawImage(originalImage, 0, 0, newSize.Width, newSize.Height); - Write(originalImage, thumbnail, toStream, quality); + // Run Kernel image processors + if (Kernel.Instance.ImageProcessors.Any()) + { + ExecuteAdditionalImageProcessors(thumbnail, thumbnailGraph, entity, imageType, imageIndex); + } + + // Write to the output stream + SaveImage(originalImage.RawFormat, thumbnail, toStream, quality); thumbnailGraph.Dispose(); thumbnail.Dispose(); originalImage.Dispose(); } - private static void Write(Image originalImage, Image newImage, Stream toStream, int? quality) + /// + /// Executes additional image processors that are registered with the Kernel + /// + /// The bitmap holding the original image, after re-sizing + /// The graphics surface on which the output is drawn + /// The entity that owns the image + /// The image type + /// The image index (currently only used with backdrops) + private static void ExecuteAdditionalImageProcessors(Bitmap bitmap, Graphics graphics, BaseEntity entity, ImageType imageType, int imageIndex) + { + var baseItem = entity as BaseItem; + + if (baseItem != null) + { + foreach (var processor in Kernel.Instance.ImageProcessors) + { + processor.ProcessImage(bitmap, graphics, baseItem, imageType, imageIndex); + } + } + else + { + foreach (var processor in Kernel.Instance.ImageProcessors) + { + processor.ProcessImage(bitmap, graphics, entity); + } + } + } + + public static void SaveImage(ImageFormat originalImageRawFormat, Image newImage, Stream toStream, int? quality) { // Use special save methods for jpeg and png that will result in a much higher quality image // All other formats use the generic Image.Save - if (ImageFormat.Jpeg.Equals(originalImage.RawFormat)) + if (ImageFormat.Jpeg.Equals(originalImageRawFormat)) { SaveJpeg(newImage, toStream, quality); } - else if (ImageFormat.Png.Equals(originalImage.RawFormat)) + else if (ImageFormat.Png.Equals(originalImageRawFormat)) { newImage.Save(toStream, ImageFormat.Png); } else { - newImage.Save(toStream, originalImage.RawFormat); + newImage.Save(toStream, originalImageRawFormat); } } - private static void SaveJpeg(Image newImage, Stream target, int? quality) + public static void SaveJpeg(Image image, Stream target, int? quality) { if (!quality.HasValue) { @@ -82,11 +126,11 @@ namespace MediaBrowser.Api using (var encoderParameters = new EncoderParameters(1)) { encoderParameters.Param[0] = new EncoderParameter(Encoder.Quality, quality.Value); - newImage.Save(target, GetImageCodeInfo("image/jpeg"), encoderParameters); + image.Save(target, GetImageCodecInfo("image/jpeg"), encoderParameters); } } - private static ImageCodecInfo GetImageCodeInfo(string mimeType) + public static ImageCodecInfo GetImageCodecInfo(string mimeType) { ImageCodecInfo[] info = ImageCodecInfo.GetImageEncoders(); diff --git a/MediaBrowser.Controller/Kernel.cs b/MediaBrowser.Controller/Kernel.cs index 682abb6322..4c0dc6965e 100644 --- a/MediaBrowser.Controller/Kernel.cs +++ b/MediaBrowser.Controller/Kernel.cs @@ -1,5 +1,6 @@ using MediaBrowser.Common.Kernel; using MediaBrowser.Common.Logging; +using MediaBrowser.Controller.Drawing; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.IO; @@ -27,7 +28,6 @@ namespace MediaBrowser.Controller public static Kernel Instance { get; private set; } public ItemController ItemController { get; private set; } - public WeatherClient WeatherClient { get; private set; } public IEnumerable Users { get; private set; } public Folder RootFolder { get; private set; } @@ -47,6 +47,12 @@ namespace MediaBrowser.Controller get { return KernelContext.Server; } } + /// + /// Gets the list of currently registered weather prvoiders + /// + [ImportMany(typeof(BaseWeatherProvider))] + public IEnumerable WeatherProviders { get; private set; } + /// /// Gets the list of currently registered metadata prvoiders /// @@ -71,6 +77,12 @@ namespace MediaBrowser.Controller /// internal IBaseItemResolver[] EntityResolvers { get; private set; } + /// + /// Gets the list of currently registered entity resolvers + /// + [ImportMany(typeof(BaseImageProcessor))] + internal IEnumerable ImageProcessors { get; private set; } + /// /// Creates a kernel based on a Data path, which is akin to our current programdata path /// @@ -85,13 +97,15 @@ namespace MediaBrowser.Controller /// protected override void InitializeInternal(IProgress progress) { + base.InitializeInternal(progress); + ItemController = new ItemController(); DirectoryWatchers = new DirectoryWatchers(); ItemController.PreBeginResolvePath += ItemController_PreBeginResolvePath; ItemController.BeginResolvePath += ItemController_BeginResolvePath; - base.InitializeInternal(progress); + ExtractFFMpeg(); } /// @@ -101,14 +115,11 @@ namespace MediaBrowser.Controller { await base.ReloadInternal(progress).ConfigureAwait(false); - ReloadWeatherClient(); - - ExtractFFMpeg(); - ReportProgress(progress, "Loading Users"); ReloadUsers(); ReportProgress(progress, "Loading Media Library"); + await ReloadRoot(allowInternetProviders: false).ConfigureAwait(false); } @@ -121,8 +132,6 @@ namespace MediaBrowser.Controller DirectoryWatchers.Stop(); - DisposeWeatherClient(); - ItemController.PreBeginResolvePath -= ItemController_PreBeginResolvePath; ItemController.BeginResolvePath -= ItemController_BeginResolvePath; } @@ -413,26 +422,5 @@ namespace MediaBrowser.Controller } } } - - /// - /// Disposes the current WeatherClient - /// - private void DisposeWeatherClient() - { - if (WeatherClient != null) - { - WeatherClient.Dispose(); - } - } - - /// - /// Disposes the current WeatherClient and creates a new one - /// - private void ReloadWeatherClient() - { - DisposeWeatherClient(); - - WeatherClient = new WeatherClient(); - } } } diff --git a/MediaBrowser.Controller/MediaBrowser.Controller.csproj b/MediaBrowser.Controller/MediaBrowser.Controller.csproj index 8d1f4965a0..131825af35 100644 --- a/MediaBrowser.Controller/MediaBrowser.Controller.csproj +++ b/MediaBrowser.Controller/MediaBrowser.Controller.csproj @@ -36,6 +36,7 @@ + @@ -58,6 +59,9 @@ + + + @@ -107,7 +111,8 @@ - + + diff --git a/MediaBrowser.Controller/Weather/BaseWeatherProvider.cs b/MediaBrowser.Controller/Weather/BaseWeatherProvider.cs new file mode 100644 index 0000000000..c3d436e667 --- /dev/null +++ b/MediaBrowser.Controller/Weather/BaseWeatherProvider.cs @@ -0,0 +1,34 @@ +using MediaBrowser.Common.Logging; +using MediaBrowser.Model.Weather; +using System; +using System.Net; +using System.Net.Cache; +using System.Net.Http; +using System.Threading.Tasks; + +namespace MediaBrowser.Controller.Weather +{ + public abstract class BaseWeatherProvider : IDisposable + { + protected HttpClient HttpClient { get; private set; } + + protected BaseWeatherProvider() + { + var handler = new WebRequestHandler { }; + + handler.AutomaticDecompression = DecompressionMethods.Deflate; + handler.CachePolicy = new RequestCachePolicy(RequestCacheLevel.Revalidate); + + HttpClient = new HttpClient(handler); + } + + public virtual void Dispose() + { + Logger.LogInfo("Disposing " + GetType().Name); + + HttpClient.Dispose(); + } + + public abstract Task GetWeatherInfoAsync(string zipCode); + } +} diff --git a/MediaBrowser.Controller/Weather/WeatherClient.cs b/MediaBrowser.Controller/Weather/WeatherProvider.cs similarity index 87% rename from MediaBrowser.Controller/Weather/WeatherClient.cs rename to MediaBrowser.Controller/Weather/WeatherProvider.cs index 7226dccf04..0fc7288790 100644 --- a/MediaBrowser.Controller/Weather/WeatherClient.cs +++ b/MediaBrowser.Controller/Weather/WeatherProvider.cs @@ -2,11 +2,9 @@ using MediaBrowser.Common.Serialization; using MediaBrowser.Model.Weather; using System; +using System.ComponentModel.Composition; using System.IO; using System.Linq; -using System.Net; -using System.Net.Cache; -using System.Net.Http; using System.Threading.Tasks; namespace MediaBrowser.Controller.Weather @@ -15,21 +13,10 @@ namespace MediaBrowser.Controller.Weather /// Based on http://www.worldweatheronline.com/free-weather-feed.aspx /// The classes in this file are a reproduction of the json output, which will then be converted to our weather model classes /// - public class WeatherClient : IDisposable + [Export(typeof(BaseWeatherProvider))] + public class WeatherProvider : BaseWeatherProvider { - private HttpClient HttpClient { get; set; } - - public WeatherClient() - { - var handler = new WebRequestHandler { }; - - handler.AutomaticDecompression = DecompressionMethods.Deflate; - handler.CachePolicy = new RequestCachePolicy(RequestCacheLevel.Revalidate); - - HttpClient = new HttpClient(handler); - } - - public async Task GetWeatherInfoAsync(string zipCode) + public override async Task GetWeatherInfoAsync(string zipCode) { if (string.IsNullOrWhiteSpace(zipCode)) { @@ -73,11 +60,6 @@ namespace MediaBrowser.Controller.Weather return info; } - - public void Dispose() - { - HttpClient.Dispose(); - } } class WeatherResult diff --git a/MediaBrowser.sln b/MediaBrowser.sln index 17b3a62908..b3f1b78359 100644 --- a/MediaBrowser.sln +++ b/MediaBrowser.sln @@ -52,4 +52,7 @@ Global GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(Performance) = preSolution + HasPerformanceSessions = true + EndGlobalSection EndGlobal