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

Switch from LogLevel in favour of TraceLevel

Browse source
This commit is contained in:
White 2015-03-19 14:38:37 +10:30
parent cb46221409
commit c7ce6f3f78
5 changed files with 70 additions and 121 deletions
Download patch file Download diff file Expand all files Collapse all files

49
TShockAPI/ILog.cs
View file

@ -17,51 +17,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
using System.Diagnostics;
namespace TShockAPI
{
/// <summary>
/// Flags to define which types of message are logged
/// </summary>
[Flags]
public enum LogLevel
{
/// <summary>
/// No messages will be logged
/// </summary>
None = 0,
/// <summary>
/// Debug messages will be logged
/// </summary>
Debug = 1,
/// <summary>
/// Informative messages will be logged
/// </summary>
Info = 2,
/// <summary>
/// Warning message will be logged
/// </summary>
Warning = 4,
/// <summary>
/// Error messages will be logged
/// </summary>
Error = 8,
/// <summary>
/// Data messages will be logged
/// </summary>
Data = 16,
/// <summary>
/// All messages will be logged
/// </summary>
All = 31
}
/// <summary>
/// Logging interface
/// </summary>
@ -76,7 +35,7 @@ namespace TShockAPI
/// Checks whether the log level contains the specified flag.
/// </summary>
/// <param name="type">The <see cref="LogLevel" /> value to check.</param>
bool MayWriteType(LogLevel type);
bool MayWriteType(TraceLevel type);
/// <summary>
/// Writes an informative string to the log and to the console.
@ -161,13 +120,13 @@ namespace TShockAPI
/// </summary>
/// <param name="message">Message to write</param>
/// <param name="level">LogLevel assosciated with the message</param>
void Write(string message, LogLevel level);
void Write(string message, TraceLevel level);
/// <summary>
/// Writes a debug string to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
void Debug(String message);
void Debug(string message);
/// <summary>
/// Writes a debug string to the log file.

45
TShockAPI/Log.cs
View file

@ -17,6 +17,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
using System.Diagnostics;
namespace TShockAPI
{
@ -27,9 +28,9 @@ namespace TShockAPI
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Data")]
public static void Data(String message)
public static void Data(string message)
{
Write(message, LogLevel.Data);
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -40,7 +41,7 @@ namespace TShockAPI
[Obsolete("Please use TShock.Log.Data")]
public static void Data(string format, params object[] args)
{
Data(String.Format(format, args));
Data(string.Format(format, args));
}
/// <summary>
@ -48,9 +49,9 @@ namespace TShockAPI
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Error")]
public static void Error(String message)
public static void Error(string message)
{
Write(message, LogLevel.Error);
Write(message, TraceLevel.Error);
}
/// <summary>
@ -61,7 +62,7 @@ namespace TShockAPI
[Obsolete("Please use TShock.Log.Error")]
public static void Error(string format, params object[] args)
{
Error(String.Format(format, args));
Error(string.Format(format, args));
}
/// <summary>
@ -69,12 +70,12 @@ namespace TShockAPI
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.ConsoleError")]
public static void ConsoleError(String message)
public static void ConsoleError(string message)
{
Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine(message);
Console.ForegroundColor = ConsoleColor.Gray;
Write(message, LogLevel.Error);
Write(message, TraceLevel.Error);
}
/// <summary>
@ -85,7 +86,7 @@ namespace TShockAPI
[Obsolete("Please use TShock.Log.ConsoleError")]
public static void ConsoleError(string format, params object[] args)
{
ConsoleError(String.Format(format, args));
ConsoleError(string.Format(format, args));
}
/// <summary>
@ -93,9 +94,9 @@ namespace TShockAPI
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Warn")]
public static void Warn(String message)
public static void Warn(string message)
{
Write(message, LogLevel.Warning);
Write(message, TraceLevel.Warning);
}
/// <summary>
@ -106,7 +107,7 @@ namespace TShockAPI
[Obsolete("Please use TShock.Log.Warn")]
public static void Warn(string format, params object[] args)
{
Warn(String.Format(format, args));
Warn(string.Format(format, args));
}
/// <summary>
@ -114,9 +115,9 @@ namespace TShockAPI
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Info")]
public static void Info(String message)
public static void Info(string message)
{
Write(message, LogLevel.Info);
Write(message, TraceLevel.Info);
}
/// <summary>
@ -127,7 +128,7 @@ namespace TShockAPI
[Obsolete("Please use TShock.Log.Info")]
public static void Info(string format, params object[] args)
{
Info(String.Format(format, args));
Info(string.Format(format, args));
}
/// <summary>
@ -135,12 +136,12 @@ namespace TShockAPI
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.ConsoleInfo")]
public static void ConsoleInfo(String message)
public static void ConsoleInfo(string message)
{
Console.ForegroundColor = ConsoleColor.Yellow;
Console.WriteLine(message);
Console.ForegroundColor = ConsoleColor.Gray;
Write(message, LogLevel.Info);
Write(message, TraceLevel.Info);
}
/// <summary>
@ -151,7 +152,7 @@ namespace TShockAPI
[Obsolete("Please use TShock.Log.ConsoleInfo")]
public static void ConsoleInfo(string format, params object[] args)
{
ConsoleInfo(String.Format(format, args));
ConsoleInfo(string.Format(format, args));
}
/// <summary>
@ -159,9 +160,9 @@ namespace TShockAPI
/// </summary>
/// <param name="message">The message to be written.</param>
[Obsolete("Please use TShock.Log.Debug")]
public static void Debug(String message)
public static void Debug(string message)
{
Write(message, LogLevel.Debug);
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -172,13 +173,13 @@ namespace TShockAPI
[Obsolete("Please use TShock.Log.Debug")]
public static void Debug(string format, params object[] args)
{
Debug(String.Format(format, args));
Debug(string.Format(format, args));
}
/// <summary>
/// Internal method which writes a message directly to the log file.
/// </summary>
private static void Write(String message, LogLevel level)
private static void Write(string message, TraceLevel level)
{
TShock.Log.Write(message, level);
}

33
TShockAPI/SqlLog.cs
View file

@ -31,7 +31,7 @@ namespace TShockAPI
public string timestamp;
public string message;
public string caller;
public LogLevel logLevel;
public TraceLevel logLevel;
public override string ToString()
{
@ -45,7 +45,6 @@ namespace TShockAPI
/// </summary>
public class SqlLog : ILog, IDisposable
{
private readonly LogLevel _logLevel;
private readonly IDbConnection _database;
private readonly TextLog _backupLog;
private readonly List<LogInfo> _failures = new List<LogInfo>(TShock.Config.RevertToTextLogsOnSqlFailures);
@ -56,21 +55,19 @@ namespace TShockAPI
/// <summary>
/// Sets the database connection and the initial log level.
/// </summary>
/// <param name="logLevel"></param>
/// <param name="db"></param>
/// <param name="textlogFilepath">File path to a backup text log in case the SQL log fails</param>
/// <param name="clearTextLog"></param>
public SqlLog(LogLevel logLevel, IDbConnection db, string textlogFilepath, bool clearTextLog)
public SqlLog(IDbConnection db, string textlogFilepath, bool clearTextLog)
{
FileName = string.Format("{0}://database", db.GetSqlType());
_logLevel = logLevel;
_database = db;
_backupLog = new TextLog(textlogFilepath, logLevel, clearTextLog);
_backupLog = new TextLog(textlogFilepath, clearTextLog);
}
public bool MayWriteType(LogLevel type)
public bool MayWriteType(TraceLevel type)
{
return ((_logLevel & type) == type);
return type != TraceLevel.Off;
}
/// <summary>
@ -79,7 +76,7 @@ namespace TShockAPI
/// <param name="message">The message to be written.</param>
public void Data(string message)
{
Write(message, LogLevel.Data);
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -98,7 +95,7 @@ namespace TShockAPI
/// <param name="message">The message to be written.</param>
public void Error(string message)
{
Write(message, LogLevel.Error);
Write(message, TraceLevel.Error);
}
/// <summary>
@ -120,7 +117,7 @@ namespace TShockAPI
Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine(message);
Console.ForegroundColor = ConsoleColor.Gray;
Write(message, LogLevel.Error);
Write(message, TraceLevel.Error);
}
/// <summary>
@ -139,7 +136,7 @@ namespace TShockAPI
/// <param name="message">The message to be written.</param>
public void Warn(string message)
{
Write(message, LogLevel.Warning);
Write(message, TraceLevel.Warning);
}
/// <summary>
@ -158,7 +155,7 @@ namespace TShockAPI
/// <param name="message">The message to be written.</param>
public void Info(string message)
{
Write(message, LogLevel.Info);
Write(message, TraceLevel.Info);
}
/// <summary>
@ -180,7 +177,7 @@ namespace TShockAPI
Console.ForegroundColor = ConsoleColor.Yellow;
Console.WriteLine(message);
Console.ForegroundColor = ConsoleColor.Gray;
Write(message, LogLevel.Info);
Write(message, TraceLevel.Info);
}
/// <summary>
@ -199,7 +196,7 @@ namespace TShockAPI
/// <param name="message">The message to be written.</param>
public void Debug(string message)
{
Write(message, LogLevel.Debug);
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -212,7 +209,7 @@ namespace TShockAPI
Debug(string.Format(format, args));
}
public void Write(string message, LogLevel level)
public void Write(string message, TraceLevel level)
{
if (!MayWriteType(level))
return;
@ -255,7 +252,7 @@ namespace TShockAPI
_failures.Add(new LogInfo
{
caller = "TShock",
logLevel = LogLevel.Error,
logLevel = TraceLevel.Error,
message = string.Format("SQL Log insert query failed: {0}", ex),
timestamp = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss", CultureInfo.InvariantCulture)
});
@ -286,7 +283,7 @@ namespace TShockAPI
foreach (var logInfo in _failures)
{
_backupLog.Write(string.Format("SQL log failed at: {0}. {1}", logInfo.timestamp, logInfo),
LogLevel.Error);
TraceLevel.Error);
}
_failures.Clear();
}

9
TShockAPI/TShock.cs
View file

@ -202,15 +202,10 @@ namespace TShockAPI
throw new Exception("Invalid storage type");
}
#if DEBUG
var level = LogLevel.All;
#else
var level = LogLevel.All & ~LogLevel.Debug;
#endif
if (Config.UseSqlLogs)
Log = new SqlLog(level, DB, logFilename, LogClear);
Log = new SqlLog(DB, logFilename, LogClear);
else
Log = new TextLog(logFilename, level, LogClear);
Log = new TextLog(logFilename, LogClear);
if (File.Exists(Path.Combine(SavePath, "tshock.pid")))
{

55
TShockAPI/TextLog.cs
View file

@ -30,7 +30,6 @@ namespace TShockAPI
public class TextLog : ILog, IDisposable
{
private readonly StreamWriter _logWriter;
private readonly LogLevel _logLevel;
/// <summary>
/// File name of the Text log
@ -41,27 +40,25 @@ namespace TShockAPI
/// 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 TextLog(string filename, LogLevel logLevel, bool clear)
public TextLog(string filename, bool clear)
{
FileName = filename;
_logLevel = logLevel;
_logWriter = new StreamWriter(filename, !clear);
}
public bool MayWriteType(LogLevel type)
public bool MayWriteType(TraceLevel type)
{
return ((_logLevel & type) == type);
return type != TraceLevel.Off;
}
/// <summary>
/// Writes data to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void Data(String message)
public void Data(string message)
{
Write(message, LogLevel.Data);
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -71,16 +68,16 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void Data(string format, params object[] args)
{
Data(String.Format(format, args));
Data(string.Format(format, args));
}
/// <summary>
/// Writes an error to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void Error(String message)
public void Error(string message)
{
Write(message, LogLevel.Error);
Write(message, TraceLevel.Error);
}
/// <summary>
@ -90,19 +87,19 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void Error(string format, params object[] args)
{
Error(String.Format(format, args));
Error(string.Format(format, args));
}
/// <summary>
/// Writes an error to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void ConsoleError(String message)
public void ConsoleError(string message)
{
Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine(message);
Console.ForegroundColor = ConsoleColor.Gray;
Write(message, LogLevel.Error);
Write(message, TraceLevel.Error);
}
/// <summary>
@ -112,16 +109,16 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void ConsoleError(string format, params object[] args)
{
ConsoleError(String.Format(format, args));
ConsoleError(string.Format(format, args));
}
/// <summary>
/// Writes a warning to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void Warn(String message)
public void Warn(string message)
{
Write(message, LogLevel.Warning);
Write(message, TraceLevel.Warning);
}
/// <summary>
@ -131,16 +128,16 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void Warn(string format, params object[] args)
{
Warn(String.Format(format, args));
Warn(string.Format(format, args));
}
/// <summary>
/// Writes an informative string to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void Info(String message)
public void Info(string message)
{
Write(message, LogLevel.Info);
Write(message, TraceLevel.Info);
}
/// <summary>
@ -150,19 +147,19 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void Info(string format, params object[] args)
{
Info(String.Format(format, args));
Info(string.Format(format, args));
}
/// <summary>
/// Writes an informative string to the log file. Also outputs to the console.
/// </summary>
/// <param name="message">The message to be written.</param>
public void ConsoleInfo(String message)
public void ConsoleInfo(string message)
{
Console.ForegroundColor = ConsoleColor.Yellow;
Console.WriteLine(message);
Console.ForegroundColor = ConsoleColor.Gray;
Write(message, LogLevel.Info);
Write(message, TraceLevel.Info);
}
/// <summary>
@ -172,16 +169,16 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void ConsoleInfo(string format, params object[] args)
{
ConsoleInfo(String.Format(format, args));
ConsoleInfo(string.Format(format, args));
}
/// <summary>
/// Writes a debug string to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void Debug(String message)
public void Debug(string message)
{
Write(message, LogLevel.Debug);
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -191,7 +188,7 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void Debug(string format, params object[] args)
{
Debug(String.Format(format, args));
Debug(string.Format(format, args));
}
/// <summary>
@ -199,7 +196,7 @@ namespace TShockAPI
/// </summary>
/// <param name="message"></param>
/// <param name="level"></param>
public void Write(string message, LogLevel level)
public void Write(string message, TraceLevel level)
{
if (!MayWriteType(level))
return;
@ -214,7 +211,7 @@ namespace TShockAPI
caller = meth.DeclaringType.Name;
}
var logEntry = String.Format("{0} - {1}: {2}: {3}",
var logEntry = string.Format("{0} - {1}: {2}: {3}",
DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss", CultureInfo.InvariantCulture),
caller, level.ToString().ToUpper(), message);
try