/*
Kooboo is a content management system based on ASP.NET MVC framework. Copyright 2009 Yardi Technology Limited.
This program is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License version 3 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program.
If not, see http://www.kooboo.com/gpl3/.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Diagnostics;
using System.Messaging;
namespace Everest.Library.Providers.Logging{
public static class Logger
{
private const MessagePriority DefaultPriority = MessagePriority.Normal;
private const TraceEventType DefaultSeverity = TraceEventType.Information;
private const int DefaultEventId = 1;
private const string DefaultTitle = "";
private static readonly ICollection<string> emptyCategoriesList = new List<string>(0);
/// <summary>
///
/// </summary>
static volatile ILogProvider logProvider = null;
static object lockHelper = new object();
/// <summary>
/// Gets the log provider.
/// </summary>
/// <value>The log provider.</value>
public static ILogProvider LogProvider
{
get
{
if (logProvider == null)
{
lock (lockHelper)
{
if (logProvider == null)
{
logProvider = UnityManager.Resolve<ILogProvider>();
}
}
}
return logProvider;
}
}
/// <overloads>
/// Write a new log entry to the default category.
/// </overloads>
/// <summary>
/// Write a new log entry to the default category.
/// </summary>
/// <example>The following example demonstrates use of the Write method with
/// one required parameter, message.
/// <code>Logger.Write("My message body");</code></example>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
public static void Write(object message)
{
Write(message, emptyCategoriesList, DefaultPriority,
DefaultEventId, DefaultSeverity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry to a specific category.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
public static void Write(object message, string category)
{
Write(message, category, DefaultPriority, DefaultEventId, DefaultSeverity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific category and priority.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
public static void Write(object message, string category, MessagePriority priority)
{
Write(message, category, priority, DefaultEventId, DefaultSeverity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific category, priority and event id.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
public static void Write(object message, string category, MessagePriority priority, int eventId)
{
Write(message, category, priority, eventId, DefaultSeverity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific category, priority, event id and severity.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
/// <param name="severity">Log entry severity as a <see cref="TraceEventType"/> enumeration. (Unspecified, Information, Warning or Error).</param>
public static void Write(object message, string category, MessagePriority priority, int eventId, TraceEventType severity)
{
Write(message, category, priority, eventId, severity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific category, priority, event id, severity
/// and title.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
/// <param name="severity">Log message severity as a <see cref="TraceEventType"/> enumeration. (Unspecified, Information, Warning or Error).</param>
/// <param name="title">Additional description of the log entry message</param>
public static void Write(object message, string category, MessagePriority priority, int eventId,
TraceEventType severity, string title)
{
Write(message, category, priority, eventId, severity, title, null);
}
/// <summary>
/// Write a new log entry and a dictionary of extended properties.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="properties">Dictionary of key/value pairs to log.</param>
public static void Write(object message, IDictionary<string, object> properties)
{
Write(message, emptyCategoriesList, DefaultPriority,
DefaultEventId, DefaultSeverity, DefaultTitle, properties);
}
/// <summary>
/// Write a new log entry to a specific category with a dictionary
/// of extended properties.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
/// <param name="properties">Dictionary of key/value pairs to log.</param>
public static void Write(object message, string category, IDictionary<string, object> properties)
{
Write(message, category, DefaultPriority, DefaultEventId, DefaultSeverity,
DefaultTitle, properties);
}
/// <summary>
/// Write a new log entry to with a specific category, priority and a dictionary
/// of extended properties.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="properties">Dictionary of key/value pairs to log.</param>
public static void Write(object message, string category, MessagePriority priority, IDictionary<string, object> properties)
{
Write(message, category, priority, DefaultEventId, DefaultSeverity, DefaultTitle, properties);
}
/// <summary>
/// Write a new log entry with a specific category, priority, event Id, severity
/// title and dictionary of extended properties.
/// </summary>
/// <example>The following example demonstrates use of the Write method with
/// a full set of parameters.
/// <code></code></example>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="category">Category name used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
/// <param name="severity">Log message severity as a <see cref="TraceEventType"/> enumeration. (Unspecified, Information, Warning or Error).</param>
/// <param name="title">Additional description of the log entry message.</param>
/// <param name="properties">Dictionary of key/value pairs to log.</param>
public static void Write(object message, string category, MessagePriority priority, int eventId,
TraceEventType severity, string title, IDictionary<string, object> properties)
{
Write(message, new string[] { category }, priority, eventId, severity, title, properties);
}
/// <summary>
/// Write a new log entry to a specific collection of categories.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
public static void Write(object message, ICollection<string> categories)
{
Write(message, categories, DefaultPriority, DefaultEventId, DefaultSeverity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific collection of categories and priority.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
public static void Write(object message, ICollection<string> categories, MessagePriority priority)
{
Write(message, categories,priority, DefaultEventId, DefaultSeverity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific collection of categories, priority and event id.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
public static void Write(object message, ICollection<string> categories, MessagePriority priority, int eventId)
{
Write(message, categories, priority, eventId, DefaultSeverity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific collection of categories, priority, event id and severity.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
/// <param name="severity">Log entry severity as a <see cref="TraceEventType"/> enumeration. (Unspecified, Information, Warning or Error).</param>
public static void Write(object message, ICollection<string> categories, MessagePriority priority, int eventId, TraceEventType severity)
{
Write(message, categories, priority, eventId, severity, DefaultTitle, null);
}
/// <summary>
/// Write a new log entry with a specific collection of categories, priority, event id, severity
/// and title.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
/// <param name="severity">Log message severity as a <see cref="TraceEventType"/> enumeration. (Unspecified, Information, Warning or Error).</param>
/// <param name="title">Additional description of the log entry message</param>
public static void Write(object message, ICollection<string> categories, MessagePriority priority, int eventId,
TraceEventType severity, string title)
{
Write(message, categories, priority, eventId, severity, title, null);
}
/// <summary>
/// Write a new log entry to a specific collection of categories with a dictionary of extended properties.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
/// <param name="properties">Dictionary of key/value pairs to log.</param>
public static void Write(object message, ICollection<string> categories, IDictionary<string, object> properties)
{
Write(message, categories, DefaultPriority, DefaultEventId, DefaultSeverity,
DefaultTitle, properties);
}
/// <summary>
/// Write a new log entry to with a specific collection of categories, priority and a dictionary
/// of extended properties.
/// </summary>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="properties">Dictionary of key/value pairs to log.</param>
public static void Write(object message, ICollection<string> categories, MessagePriority priority, IDictionary<string, object> properties)
{
Write(message, categories, priority, DefaultEventId, DefaultSeverity, DefaultTitle, properties);
}
/// <summary>
/// Write a new log entry with a specific category, priority, event Id, severity
/// title and dictionary of extended properties.
/// </summary>
/// <example>The following example demonstrates use of the Write method with
/// a full set of parameters.
/// <code></code></example>
/// <param name="message">Message body to log. Value from ToString() method from message object.</param>
/// <param name="categories">Category names used to route the log entry to a one or more trace listeners.</param>
/// <param name="priority">Only messages must be above the minimum priority are processed.</param>
/// <param name="eventId">Event number or identifier.</param>
/// <param name="severity">Log message severity as a <see cref="TraceEventType"/> enumeration. (Unspecified, Information, Warning or Error).</param>
/// <param name="title">Additional description of the log entry message.</param>
/// <param name="properties">Dictionary of key/value pairs to log.</param>
public static void Write(object message, ICollection<string> categories, MessagePriority priority, int eventId,
TraceEventType severity, string title, IDictionary<string, object> properties)
{
LogProvider.Write(message, categories, (int)priority, eventId, severity, title, properties);
}
/// <summary>
/// Logs the error.
/// </summary>
/// <param name="e">The e.</param>
public static void LogError(Exception e)
{
IDictionary<string, object> properties = new Dictionary<string, object>();
//properties.Add("Exception Message", e.Message);
////properties.Add("Data", e.Data);
//properties.Add("HelpLink", e.HelpLink);
//properties.Add("Source", e.Source);
properties.Add("StackTrace", e.StackTrace);
Write(e.Message, "", MessagePriority.Highest, 3000, TraceEventType.Error, "", properties);
}
/// <summary>
/// Warnings
/// </summary>
/// <param name="msg">The MSG.</param>
public static void Warning(string msg)
{
Write(msg, "", MessagePriority.High, 2000, TraceEventType.Warning);
}
/// <summary>
/// Infoes
/// </summary>
/// <param name="msg">The MSG.</param>
public static void Info(string msg)
{
Write(msg, "", MessagePriority.Normal, 1000, TraceEventType.Information);
}
}
}
|