From 2481c5d9f89be22d9e15c89a05763f167f51797f Mon Sep 17 00:00:00 2001 From: Luke Pulverenti Date: Sat, 17 Dec 2016 15:52:05 -0500 Subject: [PATCH] fix boxset socket events --- .../IO/ManagedFileSystem.cs | 5 +- .../Logging/NlogManager.cs | 514 ++++++++++++++---- .../EntryPoints/ExternalPortForwarding.cs | 2 +- .../Updates/InstallationManager.cs | 9 +- MediaBrowser.Controller/Entities/Folder.cs | 10 + 5 files changed, 415 insertions(+), 125 deletions(-) diff --git a/Emby.Common.Implementations/IO/ManagedFileSystem.cs b/Emby.Common.Implementations/IO/ManagedFileSystem.cs index b5943e17b..62d285072 100644 --- a/Emby.Common.Implementations/IO/ManagedFileSystem.cs +++ b/Emby.Common.Implementations/IO/ManagedFileSystem.cs @@ -488,20 +488,17 @@ namespace Emby.Common.Implementations.IO } var temp1 = Path.GetTempFileName(); - var temp2 = Path.GetTempFileName(); // Copying over will fail against hidden files RemoveHiddenAttribute(file1); RemoveHiddenAttribute(file2); CopyFile(file1, temp1, true); - CopyFile(file2, temp2, true); + CopyFile(file2, file1, true); CopyFile(temp1, file2, true); - CopyFile(temp2, file1, true); DeleteFile(temp1); - DeleteFile(temp2); } /// diff --git a/Emby.Common.Implementations/Logging/NlogManager.cs b/Emby.Common.Implementations/Logging/NlogManager.cs index e38b87bd1..f7b723e8b 100644 --- a/Emby.Common.Implementations/Logging/NlogManager.cs +++ b/Emby.Common.Implementations/Logging/NlogManager.cs @@ -1,8 +1,10 @@ using System; using System.IO; using System.Linq; +using System.Xml; using NLog; using NLog.Config; +using NLog.Filters; using NLog.Targets; using NLog.Targets.Wrappers; using MediaBrowser.Model.Logging; @@ -14,20 +16,35 @@ namespace Emby.Common.Implementations.Logging /// public class NlogManager : ILogManager { - /// - /// Occurs when [logger loaded]. - /// - public event EventHandler LoggerLoaded; + #region Private Fields + + private LogSeverity _severity = LogSeverity.Debug; + /// /// Gets or sets the log directory. /// /// The log directory. - private string LogDirectory { get; set; } + private readonly string LogDirectory; + /// /// Gets or sets the log file prefix. /// /// The log file prefix. - private string LogFilePrefix { get; set; } + private readonly string LogFilePrefix; + + #endregion + + #region Event Declarations + + /// + /// Occurs when [logger loaded]. + /// + public event EventHandler LoggerLoaded; + + #endregion + + #region Public Properties + /// /// Gets the log file path. /// @@ -40,28 +57,25 @@ namespace Emby.Common.Implementations.Logging /// The exception message prefix. public string ExceptionMessagePrefix { get; set; } - /// - /// Initializes a new instance of the class. - /// - /// The log directory. - /// The log file name prefix. - public NlogManager(string logDirectory, string logFileNamePrefix) - { - LogDirectory = logDirectory; - LogFilePrefix = logFileNamePrefix; + public string NLogConfigurationFilePath { get; set; } - LogManager.Configuration = new LoggingConfiguration (); - } - - private LogSeverity _severity = LogSeverity.Debug; public LogSeverity LogSeverity { + get { return _severity; } + set { + DebugFileWriter( + LogDirectory, String.Format( + "SET LogSeverity, _severity = [{0}], value = [{1}]", + _severity.ToString(), + value.ToString() + )); + var changed = _severity != value; _severity = value; @@ -70,31 +84,57 @@ namespace Emby.Common.Implementations.Logging { UpdateLogLevel(value); } + } } - private void UpdateLogLevel(LogSeverity newLevel) + #endregion + + #region Constructor(s) + + /// + /// Initializes a new instance of the class. + /// + /// The log directory. + /// The log file name prefix. + public NlogManager(string logDirectory, string logFileNamePrefix) { - var level = GetLogLevel(newLevel); + DebugFileWriter( + logDirectory, String.Format( + "NlogManager constructor called, logDirectory is [{0}], logFileNamePrefix is [{1}], _severity is [{2}].", + logDirectory, + logFileNamePrefix, + _severity.ToString() + )); - var rules = LogManager.Configuration.LoggingRules; + LogDirectory = logDirectory; + LogFilePrefix = logFileNamePrefix; - foreach (var rule in rules) - { - if (!rule.IsLoggingEnabledForLevel(level)) - { - rule.EnableLoggingForLevel(level); - } - foreach (var lev in rule.Levels.ToArray()) - { - if (lev < level) - { - rule.DisableLoggingForLevel(lev); - } - } - } + LogManager.Configuration = new LoggingConfiguration(); } + /// + /// Initializes a new instance of the class. + /// + /// The log directory. + /// The log file name prefix. + public NlogManager(string logDirectory, string logFileNamePrefix, LogSeverity initialSeverity) : this(logDirectory, logFileNamePrefix) + { + _severity = initialSeverity; + + DebugFileWriter( + logDirectory, String.Format( + "NlogManager constructor called, logDirectory is [{0}], logFileNamePrefix is [{1}], _severity is [{2}].", + logDirectory, + logFileNamePrefix, + _severity.ToString() + )); + } + + #endregion + + #region Private Methods + /// /// Adds the file target. /// @@ -102,12 +142,20 @@ namespace Emby.Common.Implementations.Logging /// The level. private void AddFileTarget(string path, LogSeverity level) { - RemoveTarget("ApplicationLogFileWrapper"); - var wrapper = new AsyncTargetWrapper (); - wrapper.Name = "ApplicationLogFileWrapper"; + DebugFileWriter( + LogDirectory, String.Format( + "AddFileTarget called, path = [{0}], level = [{1}].", + path, + level.ToString() + )); - var logFile = new FileTarget + RemoveTarget("ApplicationLogFileWrapper"); + + var wrapper = new AsyncTargetWrapper(); + wrapper.Name = "ApplicationLogFileWrapper"; + + var logFile = new FileTarget { FileName = path, Layout = "${longdate} ${level} ${logger}: ${message}" @@ -115,64 +163,10 @@ namespace Emby.Common.Implementations.Logging logFile.Name = "ApplicationLogFile"; - wrapper.WrappedTarget = logFile; + wrapper.WrappedTarget = logFile; AddLogTarget(wrapper, level); - } - /// - /// Adds the log target. - /// - /// The target. - /// The level. - public void AddLogTarget(Target target, LogSeverity level) - { - var config = LogManager.Configuration; - config.AddTarget(target.Name, target); - - var rule = new LoggingRule("*", GetLogLevel(level), target); - config.LoggingRules.Add(rule); - - LogManager.Configuration = config; - } - - /// - /// Removes the target. - /// - /// The name. - public void RemoveTarget(string name) - { - var config = LogManager.Configuration; - - var target = config.FindTargetByName(name); - - if (target != null) - { - foreach (var rule in config.LoggingRules.ToList()) - { - var contains = rule.Targets.Contains(target); - - rule.Targets.Remove(target); - - if (contains) - { - config.LoggingRules.Remove(rule); - } - } - - config.RemoveTarget(name); - LogManager.Configuration = config; - } - } - - /// - /// Gets the logger. - /// - /// The name. - /// ILogger. - public MediaBrowser.Model.Logging.ILogger GetLogger(string name) - { - return new NLogger(name, this); } /// @@ -200,15 +194,276 @@ namespace Emby.Common.Implementations.Logging } } + private void UpdateLogLevel(LogSeverity newLevel) + { + DebugFileWriter( + LogDirectory, String.Format( + "UpdateLogLevel called, newLevel = [{0}].", + newLevel.ToString() + )); + + var level = GetLogLevel(newLevel); + + var rules = LogManager.Configuration.LoggingRules; + + foreach (var rule in rules) + { + if (!rule.IsLoggingEnabledForLevel(level)) + { + rule.EnableLoggingForLevel(level); + } + foreach (var lev in rule.Levels.ToArray()) + { + if (lev < level) + { + rule.DisableLoggingForLevel(lev); + } + } + } + } + + private void AddCustomFilters(string defaultLoggerNamePattern, LoggingRule defaultRule) + { + DebugFileWriter( + LogDirectory, String.Format( + "AddCustomFilters called, defaultLoggerNamePattern = [{0}], defaultRule.LoggerNamePattern = [{1}].", + defaultLoggerNamePattern, + defaultRule.LoggerNamePattern + )); + + try + { + var customConfig = new NLog.Config.XmlLoggingConfiguration(NLogConfigurationFilePath); + + DebugFileWriter( + LogDirectory, String.Format( + "Custom Configuration Loaded, Rule Count = [{0}].", + customConfig.LoggingRules.Count.ToString() + )); + + foreach (var customRule in customConfig.LoggingRules) + { + + DebugFileWriter( + LogDirectory, String.Format( + "Read Custom Rule, LoggerNamePattern = [{0}], Targets = [{1}].", + customRule.LoggerNamePattern, + string.Join(",", customRule.Targets.Select(x => x.Name).ToList()) + )); + + if (customRule.LoggerNamePattern.Equals(defaultLoggerNamePattern)) + { + + if (customRule.Targets.Any((arg) => arg.Name.Equals(defaultRule.Targets.First().Name))) + { + + DebugFileWriter( + LogDirectory, String.Format( + "Custom rule filters can be applied to this target, Filter Count = [{0}].", + customRule.Filters.Count.ToString() + )); + + foreach (ConditionBasedFilter customFilter in customRule.Filters) + { + + DebugFileWriter( + LogDirectory, String.Format( + "Read Custom Filter, Filter = [{0}], Action = [{1}], Type = [{2}].", + customFilter.Condition.ToString(), + customFilter.Action.ToString(), + customFilter.GetType().ToString() + )); + + defaultRule.Filters.Add(customFilter); + + } + } + else + { + + DebugFileWriter( + LogDirectory, String.Format( + "Ignoring custom rule as [Target] does not match." + )); + + } + + } + else + { + + DebugFileWriter( + LogDirectory, String.Format( + "Ignoring custom rule as [LoggerNamePattern] does not match." + )); + + } + } + } + catch (Exception ex) + { + // Intentionally do nothing, prevent issues affecting normal execution. + DebugFileWriter( + LogDirectory, String.Format( + "Exception in AddCustomFilters, ex.Message = [{0}].", + ex.Message + ) + ); + + } + } + + #endregion + + #region Public Methods + /// - /// Reloads the logger. + /// Gets the logger. + /// + /// The name. + /// ILogger. + public MediaBrowser.Model.Logging.ILogger GetLogger(string name) + { + + DebugFileWriter( + LogDirectory, String.Format( + "GetLogger called, name = [{0}].", + name + )); + + return new NLogger(name, this); + + } + + /// + /// Adds the log target. + /// + /// The target. + /// The level. + public void AddLogTarget(Target target, LogSeverity level) + { + + DebugFileWriter( + LogDirectory, String.Format( + "AddLogTarget called, target.Name = [{0}], level = [{1}].", + target.Name, + level.ToString() + )); + + string loggerNamePattern = "*"; + var config = LogManager.Configuration; + var rule = new LoggingRule(loggerNamePattern, GetLogLevel(level), target); + + config.AddTarget(target.Name, target); + + AddCustomFilters(loggerNamePattern, rule); + + config.LoggingRules.Add(rule); + + LogManager.Configuration = config; + + } + + /// + /// Removes the target. + /// + /// The name. + public void RemoveTarget(string name) + { + + DebugFileWriter( + LogDirectory, String.Format( + "RemoveTarget called, name = [{0}].", + name + )); + + var config = LogManager.Configuration; + + var target = config.FindTargetByName(name); + + if (target != null) + { + foreach (var rule in config.LoggingRules.ToList()) + { + var contains = rule.Targets.Contains(target); + + rule.Targets.Remove(target); + + if (contains) + { + config.LoggingRules.Remove(rule); + } + } + + config.RemoveTarget(name); + LogManager.Configuration = config; + } + } + + public void AddConsoleOutput() + { + + DebugFileWriter( + LogDirectory, String.Format( + "AddConsoleOutput called." + )); + + RemoveTarget("ConsoleTargetWrapper"); + + var wrapper = new AsyncTargetWrapper(); + wrapper.Name = "ConsoleTargetWrapper"; + + var target = new ConsoleTarget() + { + Layout = "${level}, ${logger}, ${message}", + Error = false + }; + + target.Name = "ConsoleTarget"; + + wrapper.WrappedTarget = target; + + AddLogTarget(wrapper, LogSeverity); + + } + + public void RemoveConsoleOutput() + { + + DebugFileWriter( + LogDirectory, String.Format( + "RemoveConsoleOutput called." + )); + + RemoveTarget("ConsoleTargetWrapper"); + + } + + /// + /// Reloads the logger, maintaining the current log level. + /// + public void ReloadLogger() + { + ReloadLogger(LogSeverity); + } + + /// + /// Reloads the logger, using the specified logging level. /// /// The level. public void ReloadLogger(LogSeverity level) { + + DebugFileWriter( + LogDirectory, String.Format( + "ReloadLogger called, level = [{0}], LogFilePath (existing) = [{1}].", + level.ToString(), + LogFilePath + )); + LogFilePath = Path.Combine(LogDirectory, LogFilePrefix + "-" + decimal.Floor(DateTime.Now.Ticks / 10000000) + ".txt"); - Directory.CreateDirectory(Path.GetDirectoryName(LogFilePath)); + Directory.CreateDirectory(Path.GetDirectoryName(LogFilePath)); AddFileTarget(LogFilePath, level); @@ -218,7 +473,14 @@ namespace Emby.Common.Implementations.Logging { try { + + DebugFileWriter( + LogDirectory, String.Format( + "ReloadLogger called, raised event LoggerLoaded." + )); + LoggerLoaded(this, EventArgs.Empty); + } catch (Exception ex) { @@ -232,33 +494,51 @@ namespace Emby.Common.Implementations.Logging /// public void Flush() { + + DebugFileWriter( + LogDirectory, String.Format( + "Flush called." + )); + LogManager.Flush(); + } + #endregion - public void AddConsoleOutput() + #region Conditional Debug Methods + + /// + /// DEBUG: Standalone method to write out debug to assist with logger development/troubleshooting. + /// + /// The output file will be written to the server's log directory. + /// Calls to the method are safe and will never throw any exceptions. + /// Method calls will be omitted unless the library is compiled with DEBUG defined. + /// + /// + private static void DebugFileWriter(string logDirectory, string message) { - RemoveTarget("ConsoleTargetWrapper"); - - var wrapper = new AsyncTargetWrapper (); - wrapper.Name = "ConsoleTargetWrapper"; - - var target = new ConsoleTarget() +#if DEBUG + try { - Layout = "${level}, ${logger}, ${message}", - Error = false - }; - target.Name = "ConsoleTarget"; + System.IO.File.AppendAllText( + Path.Combine(logDirectory, "NlogManager.txt"), + String.Format( + "{0} : {1}{2}", + System.DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ"), + message, + System.Environment.NewLine + ) + ); - wrapper.WrappedTarget = target; - - AddLogTarget(wrapper, LogSeverity); - } - - public void RemoveConsoleOutput() - { - RemoveTarget("ConsoleTargetWrapper"); + } + catch (Exception ex) + { + // Intentionally do nothing, prevent issues affecting normal execution. + } +#endif } + #endregion } -} +} \ No newline at end of file diff --git a/Emby.Server.Core/EntryPoints/ExternalPortForwarding.cs b/Emby.Server.Core/EntryPoints/ExternalPortForwarding.cs index 11e275940..b75de2ff4 100644 --- a/Emby.Server.Core/EntryPoints/ExternalPortForwarding.cs +++ b/Emby.Server.Core/EntryPoints/ExternalPortForwarding.cs @@ -238,7 +238,7 @@ namespace Emby.Server.Core.EntryPoints } catch (Exception ex) { - _logger.ErrorException("Error creating port map", ex); + _logger.Error("Error creating port map: " + ex.Message); } } diff --git a/Emby.Server.Implementations/Updates/InstallationManager.cs b/Emby.Server.Implementations/Updates/InstallationManager.cs index 52bf09284..0420900c5 100644 --- a/Emby.Server.Implementations/Updates/InstallationManager.cs +++ b/Emby.Server.Implementations/Updates/InstallationManager.cs @@ -42,7 +42,8 @@ namespace Emby.Server.Implementations.Updates /// private ConcurrentBag CompletedInstallationsInternal { get; set; } - public IEnumerable CompletedInstallations { + public IEnumerable CompletedInstallations + { get { return CompletedInstallationsInternal; } } @@ -163,8 +164,8 @@ namespace Emby.Server.Implementations.Updates { var data = new Dictionary { - { "key", _securityManager.SupporterKey }, - { "mac", _applicationHost.SystemId }, + { "key", _securityManager.SupporterKey }, + { "mac", _applicationHost.SystemId }, { "systemid", _applicationHost.SystemId } }; @@ -656,6 +657,8 @@ namespace Emby.Server.Implementations.Updates // Remove it the quick way for now _applicationHost.RemovePlugin(plugin); + _logger.Info("Deleting plugin file {0}", plugin.AssemblyFilePath); + _fileSystem.DeleteFile(plugin.AssemblyFilePath); OnPluginUninstalled(plugin); diff --git a/MediaBrowser.Controller/Entities/Folder.cs b/MediaBrowser.Controller/Entities/Folder.cs index a84e9a5d2..943c9d882 100644 --- a/MediaBrowser.Controller/Entities/Folder.cs +++ b/MediaBrowser.Controller/Entities/Folder.cs @@ -103,6 +103,16 @@ namespace MediaBrowser.Controller.Entities } } + public override bool CanDelete() + { + if (IsRoot) + { + return false; + } + + return base.CanDelete(); + } + public override bool RequiresRefresh() { var baseResult = base.RequiresRefresh();