200 lines
8.2 KiB
C#
200 lines
8.2 KiB
C#
/*
|
|
* Copyright (c) 2006-2016, openmetaverse.co
|
|
* All rights reserved.
|
|
*
|
|
* - Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* - Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
* - Neither the name of the openmetaverse.co nor the names
|
|
* of its contributors may be used to endorse or promote products derived from
|
|
* this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
using System;
|
|
using System.Reflection;
|
|
using log4net;
|
|
using log4net.Appender;
|
|
using log4net.Config;
|
|
using log4net.Layout;
|
|
|
|
[assembly: XmlConfigurator(Watch = true)]
|
|
|
|
namespace OpenMetaverse
|
|
{
|
|
/// <summary>
|
|
/// Singleton logging class for the entire library
|
|
/// </summary>
|
|
public static class Logger
|
|
{
|
|
/// <summary>
|
|
/// Callback used for client apps to receive log messages from
|
|
/// the library
|
|
/// </summary>
|
|
/// <param name="message">Data being logged</param>
|
|
/// <param name="level">The severity of the log entry from <see cref="Helpers.LogLevel"/></param>
|
|
public delegate void LogCallback(object message, Helpers.LogLevel level);
|
|
|
|
/// <summary>Triggered whenever a message is logged. If this is left
|
|
/// null, log messages will go to the console</summary>
|
|
public static event LogCallback OnLogMessage;
|
|
|
|
/// <summary>log4net logging engine</summary>
|
|
public static ILog LogInstance;
|
|
|
|
/// <summary>
|
|
/// Default constructor
|
|
/// </summary>
|
|
static Logger()
|
|
{
|
|
LogInstance = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
|
|
|
|
// If error level reporting isn't enabled we assume no logger is configured and initialize a default
|
|
// ConsoleAppender
|
|
if (!LogInstance.Logger.IsEnabledFor(log4net.Core.Level.Error))
|
|
{
|
|
IAppender appender = new ConsoleAppender()
|
|
{
|
|
Layout = new log4net.Layout.PatternLayout("%date{HH:mm:ss,fff} [%thread] %-5level - %message%newline")
|
|
};
|
|
|
|
BasicConfigurator.Configure(LogManager.GetRepository(Assembly.GetCallingAssembly()), appender);
|
|
|
|
if(Settings.LOG_LEVEL != Helpers.LogLevel.None)
|
|
LogInstance.Info("No log configuration found, defaulting to console logging");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Send a log message to the logging engine
|
|
/// </summary>
|
|
/// <param name="message">The log message</param>
|
|
/// <param name="level">The severity of the log entry</param>
|
|
public static void Log(object message, Helpers.LogLevel level)
|
|
{
|
|
Log(message, level, null, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Send a log message to the logging engine
|
|
/// </summary>
|
|
/// <param name="message">The log message</param>
|
|
/// <param name="level">The severity of the log entry</param>
|
|
/// <param name="client">Instance of the client</param>
|
|
public static void Log(object message, Helpers.LogLevel level, GridClient client)
|
|
{
|
|
Log(message, level, client, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Send a log message to the logging engine
|
|
/// </summary>
|
|
/// <param name="message">The log message</param>
|
|
/// <param name="level">The severity of the log entry</param>
|
|
/// <param name="exception">Exception that was raised</param>
|
|
public static void Log(object message, Helpers.LogLevel level, Exception exception)
|
|
{
|
|
Log(message, level, null, exception);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Send a log message to the logging engine
|
|
/// </summary>
|
|
/// <param name="message">The log message</param>
|
|
/// <param name="level">The severity of the log entry</param>
|
|
/// <param name="client">Instance of the client</param>
|
|
/// <param name="exception">Exception that was raised</param>
|
|
public static void Log(object message, Helpers.LogLevel level, GridClient client, Exception exception)
|
|
{
|
|
if (client != null && client.Settings.LOG_NAMES)
|
|
message = $"<{client.Self.Name}>: {message}";
|
|
|
|
OnLogMessage?.Invoke(message, level);
|
|
|
|
switch (level)
|
|
{
|
|
case Helpers.LogLevel.Debug:
|
|
if (Settings.LOG_LEVEL == Helpers.LogLevel.Debug)
|
|
LogInstance.Debug(message, exception);
|
|
break;
|
|
case Helpers.LogLevel.Info:
|
|
if (Settings.LOG_LEVEL == Helpers.LogLevel.Debug
|
|
|| Settings.LOG_LEVEL == Helpers.LogLevel.Info)
|
|
{
|
|
LogInstance.Info(message, exception);
|
|
}
|
|
|
|
break;
|
|
case Helpers.LogLevel.Warning:
|
|
if (Settings.LOG_LEVEL == Helpers.LogLevel.Debug
|
|
|| Settings.LOG_LEVEL == Helpers.LogLevel.Info
|
|
|| Settings.LOG_LEVEL == Helpers.LogLevel.Warning)
|
|
{
|
|
LogInstance.Warn(message, exception);
|
|
}
|
|
|
|
break;
|
|
case Helpers.LogLevel.Error:
|
|
if (Settings.LOG_LEVEL == Helpers.LogLevel.Debug
|
|
|| Settings.LOG_LEVEL == Helpers.LogLevel.Info
|
|
|| Settings.LOG_LEVEL == Helpers.LogLevel.Warning
|
|
|| Settings.LOG_LEVEL == Helpers.LogLevel.Error)
|
|
{
|
|
LogInstance.Error(message, exception);
|
|
}
|
|
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// If the library is compiled with DEBUG defined, an event will be
|
|
/// fired if a <see cref="OnLogMessage" /> handler is registered and the
|
|
/// message will be sent to the logging engine
|
|
/// </summary>
|
|
/// <param name="message">The message to log at the DEBUG level to the
|
|
/// current logging engine</param>
|
|
public static void DebugLog(object message)
|
|
{
|
|
DebugLog(message, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// If the library is compiled with DEBUG defined and
|
|
/// <see cref="GridClient.Settings.DEBUG" /> is true, an event will be
|
|
/// fired if a <see cref="OnLogMessage" /> handler is registered and the
|
|
/// message will be sent to the logging engine
|
|
/// </summary>
|
|
/// <param name="message">The message to log at the DEBUG level to the
|
|
/// current logging engine</param>
|
|
/// <param name="client">Instance of the client</param>
|
|
[System.Diagnostics.Conditional("DEBUG")]
|
|
public static void DebugLog(object message, GridClient client)
|
|
{
|
|
if (Settings.LOG_LEVEL != Helpers.LogLevel.Debug) return;
|
|
|
|
if (client != null && client.Settings.LOG_NAMES)
|
|
message = $"<{client.Self.Name}>: {message}";
|
|
|
|
OnLogMessage?.Invoke(message, Helpers.LogLevel.Debug);
|
|
|
|
LogInstance.Debug(message);
|
|
}
|
|
}
|
|
}
|