themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Adds SQL logging from WhiteX's fork; closes #869

Browse source
This commit is contained in:
Lucas Nicodemus 2015-02-25 14:52:28 -07:00
parent c215ff8e10
commit 0459dfca11
10 changed files with 743 additions and 144 deletions
Download patch file Download diff file Expand all files Collapse all files

88
TShockAPI/Log.cs
View file

@ -17,57 +17,16 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
using System.Diagnostics;
using System.Globalization;
using System.IO;
namespace TShockAPI
{
[Flags]
public enum LogLevel
{
None = 0,
Debug = 1,
Info = 2,
Warning = 4,
Error = 8,
Data = 16,
All = 31
}
public static class Log
{
public static string _filename { get; private set; }
private static LogLevel _logLevel;
private static StreamWriter _logWriter;
/// <summary>
/// Creates the log file stream and sets the initial log level.
/// </summary>
/// <param name="filename">The output filename. This file will be overwritten if 'clear' is set.</param>
/// <param name="logLevel">The <see cref="LogLevel" /> value which sets the type of messages to output.</param>
/// <param name="clear">Whether or not to clear the log file on initialization.</param>
public static void Initialize(string filename, LogLevel logLevel, bool clear)
{
_filename = filename;
_logLevel = logLevel;
_logWriter = new StreamWriter(filename, !clear);
}
/// <summary>
/// Checks whether the log level contains the specified flag.
/// </summary>
/// <param name="type">The <see cref="LogLevel" /> value to check.</param>
private static bool MayWriteType(LogLevel type)
{
return ((_logLevel & type) == type);
}
/// <summary>
/// Writes data to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Data")]
public static void Data(String message)
{
Write(message, LogLevel.Data);
@ -78,6 +37,7 @@ namespace TShockAPI
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
[Obsolete("Please use TShock.Log.Data")]
public static void Data(string format, params object[] args)
{
Data(String.Format(format, args));
@ -87,6 +47,7 @@ namespace TShockAPI
/// Writes an error to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Error")]
public static void Error(String message)
{
Write(message, LogLevel.Error);
@ -97,6 +58,7 @@ namespace TShockAPI
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
[Obsolete("Please use TShock.Log.Error")]
public static void Error(string format, params object[] args)
{
Error(String.Format(format, args));
@ -106,6 +68,7 @@ namespace TShockAPI
/// Writes an error to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.ConsoleError")]
public static void ConsoleError(String message)
{
Console.ForegroundColor = ConsoleColor.Red;
@ -119,6 +82,7 @@ namespace TShockAPI
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
[Obsolete("Please use TShock.Log.ConsoleError")]
public static void ConsoleError(string format, params object[] args)
{
ConsoleError(String.Format(format, args));
@ -128,6 +92,7 @@ namespace TShockAPI
/// Writes a warning to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Warn")]
public static void Warn(String message)
{
Write(message, LogLevel.Warning);
@ -138,6 +103,7 @@ namespace TShockAPI
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
[Obsolete("Please use TShock.Log.Warn")]
public static void Warn(string format, params object[] args)
{
Warn(String.Format(format, args));
@ -147,6 +113,7 @@ namespace TShockAPI
/// Writes an informative string to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Info")]
public static void Info(String message)
{
Write(message, LogLevel.Info);
@ -157,6 +124,7 @@ namespace TShockAPI
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
[Obsolete("Please use TShock.Log.Info")]
public static void Info(string format, params object[] args)
{
Info(String.Format(format, args));
@ -166,6 +134,7 @@ namespace TShockAPI
/// Writes an informative string to the log file. Also outputs to the console.
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.ConsoleInfo")]
public static void ConsoleInfo(String message)
{
Console.ForegroundColor = ConsoleColor.Yellow;
@ -179,6 +148,7 @@ namespace TShockAPI
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
[Obsolete("Please use TShock.Log.ConsoleInfo")]
public static void ConsoleInfo(string format, params object[] args)
{
ConsoleInfo(String.Format(format, args));
@ -188,6 +158,7 @@ namespace TShockAPI
/// Writes a debug string to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Debug")]
public static void Debug(String message)
{
Write(message, LogLevel.Debug);
@ -198,6 +169,7 @@ namespace TShockAPI
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
[Obsolete("Please use TShock.Log.Debug")]
public static void Debug(string format, params object[] args)
{
Debug(String.Format(format, args));
@ -208,7 +180,7 @@ namespace TShockAPI
/// </summary>
public static void Dispose()
{
_logWriter.Dispose();
TShock.Log.Dispose();
}
/// <summary>
@ -216,35 +188,7 @@ namespace TShockAPI
/// </summary>
private static void Write(String message, LogLevel level)
{
if (!MayWriteType(level))
{
return;
}
string caller = "TShock";
StackFrame frame = new StackTrace().GetFrame(2);
if (frame != null)
{
var meth = frame.GetMethod();
if (meth != null)
caller = meth.DeclaringType.Name;
}
try
{
_logWriter.WriteLine(string.Format("{0} - {1}: {2}: {3}",
DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss", CultureInfo.InvariantCulture),
caller, level.ToString().ToUpper(), message));
_logWriter.Flush();
}
catch (ObjectDisposedException)
{
Console.WriteLine("Unable to write to log as log has been disposed.");
Console.WriteLine("{0} - {1}: {2}: {3}",
DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss", CultureInfo.InvariantCulture),
caller, level.ToString().ToUpper(), message);
}
TShock.Log.Write(message, level);
}
}
}