SabreTools/SabreTools.Helper/Logger.cs

using System;
using System.IO;

namespace SabreTools.Helper
{
	/// <summary>
	/// Log either to file or to the console
	/// </summary>
	/// <remarks>
	/// Things to do:
	/// - Allow for "triggerable" logging done on an interval (async)
	/// - Log filtering? (#if debug?)
	/// </remarks>
	public class Logger
	{
		/// <summary>
		/// Severity of the logging statement
		/// </summary>
		private enum LogLevel
		{
			VERBOSE = 0,
			USER,
			WARNING,
			ERROR,
		}

		// Private instance variables
		private bool _tofile;
		private bool _warnings;
		private bool _errors;
		private string _filename;
		private DateTime _start;
		private StreamWriter _log;

		// Private required variables
		private string _basepath = "logs" + Path.DirectorySeparatorChar;

		/// <summary>
		/// Initialize a console-only logger object
		/// </summary>
		public Logger()
		{
			_tofile = false;
			_warnings = false;
			_errors = false;
			_filename = null;

			Start();
		}

		/// <summary>
		/// Initialize a Logger object with the given information
		/// </summary>
		/// <param name="tofile">True if file should be written to instead of console</param>
		/// <param name="filename">Filename representing log location</param>
		public Logger(bool tofile, string filename)
		{
			_tofile = tofile;
			_warnings = false;
			_errors = false;
			_filename = Path.GetFileNameWithoutExtension(filename) + " (" + DateTime.Now.ToString("yyyy-MM-dd HHmmss") + ")" + Path.GetExtension(filename);

			if (!Directory.Exists(_basepath))
			{
				Directory.CreateDirectory(_basepath);
			}

			Start();
		}

		/// <summary>
		/// Start logging by opening output file (if necessary)
		/// </summary>
		/// <returns>True if the logging was started correctly, false otherwise</returns>
		public bool Start()
		{
			_start = DateTime.Now;
			if (!_tofile)
			{
				return true;
			}

			try
			{
				_log = new StreamWriter(File.Open(_basepath + _filename, FileMode.OpenOrCreate | FileMode.Append));
				_log.WriteLine("Logging started " + DateTime.Now);
				_log.WriteLine(Environment.CommandLine);
				_log.Flush();
			}
			catch
			{
				return false;
			}

			return true;
		}

		/// <summary>
		/// End logging by closing output file (if necessary)
		/// </summary>
		/// <param name="suppress">True if all ending output is to be suppressed, false otherwise (default)</param>
		/// <returns>True if the logging was ended correctly, false otherwise</returns>
		public bool Close(bool suppress = false)
		{
			if (!suppress)
			{
				if (_warnings)
				{
					Console.WriteLine("There were warnings in the last run! Check the log for more details");
				}
				if (_errors)
				{
					Console.WriteLine("There were errors in the last run! Check the log for more details");
				}

				TimeSpan span = DateTime.Now.Subtract(_start);
				string total = span.ToString(@"hh\:mm\:ss");
				if (!_tofile)
				{
					Console.WriteLine("Total runtime: " + total);
					return true;
				}

				try
				{
					_log.WriteLine("Logging ended " + DateTime.Now);
					_log.WriteLine("Total runtime: " + total);
					Console.WriteLine("Total runtime: " + total);
					_log.Close();
				}
				catch
				{
					return false;
				}
			}
			else
			{
				try
				{
					_log.Close();
				}
				catch
				{
					return false;
				}
			}

			return true;
		}

		/// <summary>
		/// Write the given string to the log output
		/// </summary>
		/// <param name="output">String to be written log</param>
		/// <param name="loglevel">Severity of the information being logged</param>
		/// <param name="appendPrefix">True if the level and datetime should be prepended to each statement, false otherwise</param>
		/// <returns>True if the output could be written, false otherwise</returns>
		private bool Log(string output, LogLevel loglevel, bool appendPrefix)
		{
			// USER and ERROR writes to console
			if (loglevel == LogLevel.USER || loglevel == LogLevel.ERROR)
			{
				Console.WriteLine((loglevel == LogLevel.ERROR && appendPrefix ? loglevel.ToString() + " " : "") + output);
			}

			// If we're writing to file, use the existing stream
			if (_tofile)
			{
				try
				{
					_log.WriteLine((appendPrefix ? loglevel.ToString() + " - " + DateTime.Now + " - " : "" ) + output);
					_log.Flush();
				}
				catch
				{
					Console.WriteLine("Could not write to log file!");
					return false;
				}
			}

			return true;
		}

		/// <summary>
		/// Write the given exact string to the log output
		/// </summary>
		/// <param name="output">String to be written log</param>
		/// <param name="line">Line number to write out to</param>
		/// <param name="column">Column number to write out to</param>
		/// <returns>True if the output could be written, false otherwise</returns>
		public bool WriteExact(string output, int line, int column)
		{
			// Set the cursor position (if not being redirected)
			if (!Console.IsOutputRedirected)
			{
				Console.CursorTop = line;
				Console.CursorLeft = column;
			}

			// Write out to the console
			Console.Write(output);

			// If we're writing to file, use the existing stream
			if (_tofile)
			{
				try
				{
					_log.Write(DateTime.Now + " - " + output);
					_log.Flush();
				}
				catch
				{
					Console.WriteLine("Could not write to log file!");
					return false;
				}
			}

			return true;
		}

		/// <summary>
		/// Write the given string as a verbose message to the log output
		/// </summary>
		/// <param name="output">String to be written log</param>
		/// <param name="appendPrefix">True if the level and datetime should be prepended to each statement (default), false otherwise</param>
		/// <returns>True if the output could be written, false otherwise</returns>s
		public bool Verbose(string output, bool appendPrefix = true)
		{
			return Log(output, LogLevel.VERBOSE, appendPrefix);
		}

		/// <summary>
		/// Write the given string as a user message to the log output
		/// </summary>
		/// <param name="output">String to be written log</param>
		/// <param name="appendPrefix">True if the level and datetime should be prepended to each statement (default), false otherwise</param>
		/// <returns>True if the output could be written, false otherwise</returns>
		public bool User(string output, bool appendPrefix = true)
		{
			return Log(output, LogLevel.USER, appendPrefix);
		}

		/// <summary>
		/// Write the given string as a warning to the log output
		/// </summary>
		/// <param name="output">String to be written log</param>
		/// <param name="appendPrefix">True if the level and datetime should be prepended to each statement (default), false otherwise</param>
		/// <returns>True if the output could be written, false otherwise</returns>
		public bool Warning(string output, bool appendPrefix = true)
		{
			_warnings = true;
			return Log(output, LogLevel.WARNING, appendPrefix);
		}

		/// <summary>
		/// Writes the given string as an error in the log
		/// </summary>
		/// <param name="output">String to be written log</param>
		/// <param name="appendPrefix">True if the level and datetime should be prepended to each statement (default), false otherwise</param>
		/// <returns>True if the output could be written, false otherwise</returns>
		public bool Error(string output, bool appendPrefix = true)
		{
			_errors = true;
			return Log(output, LogLevel.ERROR, appendPrefix);
		}

		/// <summary>
		/// Clear lines beneath the given line in the console
		/// </summary>
		/// <param name="line">Line number to clear beneath</param>
		/// <returns>True</returns>
		public bool ClearBeneath(int line)
		{
			if (!Console.IsOutputRedirected)
			{
				for (int i = line; i < Console.WindowHeight; i++)
				{
					// http://stackoverflow.com/questions/8946808/can-console-clear-be-used-to-only-clear-a-line-instead-of-whole-console
					Console.SetCursorPosition(0, Console.CursorTop);
					Console.Write(new string(' ', Console.WindowWidth));
					Console.SetCursorPosition(0, i);
				}
			}
			return true;
		}
	}
}