using System.IO; using System.Diagnostics; using System.Threading; namespace winsw { public interface EventLogger { void LogEvent(string message); void LogEvent(string message, EventLogEntryType type); } /// /// Abstraction for handling log. /// public abstract class LogHandler { private EventLogger eventLogger; public abstract void log(Stream outputStream, Stream errorStream); /// /// Error and information about logging should be reported here. /// public EventLogger EventLogger { set { this.eventLogger = value; } get { return this.eventLogger; } } /// /// Convenience method to copy stuff from StreamReader to StreamWriter /// protected void CopyStream(Stream i, Stream o) { byte[] buf = new byte[1024]; while (true) { int sz = i.Read(buf, 0, buf.Length); if (sz == 0) break; o.Write(buf, 0, sz); o.Flush(); } i.Close(); o.Close(); } /// /// File replacement. /// protected void CopyFile(string sourceFileName, string destFileName) { try { File.Delete(destFileName); File.Move(sourceFileName, destFileName); } catch (IOException e) { EventLogger.LogEvent("Failed to copy :" + sourceFileName + " to " + destFileName + " because " + e.Message); } } } /// /// Base class for file-based loggers /// public abstract class AbstractFileLogAppender : LogHandler { private string baseLogFileName; public AbstractFileLogAppender(string logDirectory, string baseName) { this.baseLogFileName = Path.Combine(logDirectory, baseName); } protected string BaseLogFileName { get { return this.baseLogFileName; } } } public abstract class SimpleLogAppender : AbstractFileLogAppender { private FileMode fileMode; private string outputLogFileName; private string errorLogFileName; public SimpleLogAppender(string logDirectory, string baseName, FileMode fileMode) : base(logDirectory, baseName) { this.fileMode = fileMode; this.outputLogFileName = BaseLogFileName + ".out.log"; this.errorLogFileName = BaseLogFileName + ".err.log"; } public string OutputLogFileName { get { return this.outputLogFileName; } } public string ErrorLogFileName { get { return this.errorLogFileName; } } public override void log(Stream outputStream, Stream errorStream) { new Thread(delegate() { CopyStream(outputStream, new FileStream(outputLogFileName, fileMode)); }).Start(); new Thread(delegate() { CopyStream(errorStream, new FileStream(errorLogFileName, fileMode)); }).Start(); } } public class DefaultLogAppender : SimpleLogAppender { public DefaultLogAppender(string logDirectory, string baseName) : base(logDirectory, baseName, FileMode.Append) { } } public class ResetLogAppender : SimpleLogAppender { public ResetLogAppender(string logDirectory, string baseName) : base(logDirectory, baseName, FileMode.Create) { } } /// /// LogHandler that throws away output /// public class IgnoreLogAppender : LogHandler { public override void log(Stream outputStream, Stream errorStream) { new Thread(delegate() { CopyStream(outputStream, Stream.Null); }).Start(); new Thread(delegate() { CopyStream(errorStream, Stream.Null); }).Start(); } } public class TimeBasedRollingLogAppender : AbstractFileLogAppender { private string pattern; private int period; public TimeBasedRollingLogAppender(string logDirectory, string baseName, string pattern, int period) : base(logDirectory, baseName) { this.pattern = pattern; this.period = period; } public override void log(Stream outputStream, Stream errorStream) { new Thread(delegate() { CopyStreamWithDateRotation(outputStream, ".out.log"); }).Start(); new Thread(delegate() { CopyStreamWithDateRotation(errorStream, ".err.log"); }).Start(); } /// /// Works like the CopyStream method but does a log rotation based on time. /// private void CopyStreamWithDateRotation(Stream data, string ext) { PeriodicRollingCalendar periodicRollingCalendar = new PeriodicRollingCalendar(pattern, period); periodicRollingCalendar.init(); byte[] buf = new byte[1024]; FileStream w = new FileStream(BaseLogFileName + "_" + periodicRollingCalendar.format + ext, FileMode.Append); while (true) { int len = data.Read(buf, 0, buf.Length); if (len == 0) break; // EOF if (periodicRollingCalendar.shouldRoll) {// rotate at the line boundary int offset = 0; bool rolled = false; for (int i = 0; i < len; i++) { if (buf[i] == 0x0A) {// at the line boundary. // time to rotate. w.Write(buf, offset, i + 1); w.Close(); offset = i + 1; // create a new file. w = new FileStream(BaseLogFileName + "_" + periodicRollingCalendar.format + ext, FileMode.Create); rolled = true; } } if (!rolled) {// we didn't roll - most likely as we didnt find a line boundary, so we should log what we read and roll anyway. w.Write(buf, 0, len); w.Close(); w = new FileStream(BaseLogFileName + "_" + periodicRollingCalendar.format + ext, FileMode.Create); } } else {// typical case. write the whole thing into the current file w.Write(buf, 0, len); } w.Flush(); } data.Close(); w.Close(); } } public class SizeBasedRollingLogAppender : AbstractFileLogAppender { public static int BYTES_PER_KB = 1024; public static int BYTES_PER_MB = 1024 * BYTES_PER_KB; public static int DEFAULT_SIZE_THRESHOLD = 10 * BYTES_PER_MB; // rotate every 10MB. public static int DEFAULT_FILES_TO_KEEP = 8; private int sizeThreshold; private int filesToKeep; public SizeBasedRollingLogAppender(string logDirectory, string baseName, int sizeThreshold, int filesToKeep) : base(logDirectory, baseName) { this.sizeThreshold = sizeThreshold; this.filesToKeep = filesToKeep; } public SizeBasedRollingLogAppender(string logDirectory, string baseName) : this(logDirectory, baseName, DEFAULT_SIZE_THRESHOLD, DEFAULT_FILES_TO_KEEP) { } public override void log(Stream outputStream, Stream errorStream) { new Thread(delegate() { CopyStreamWithRotation(outputStream, ".out.log"); }).Start(); new Thread(delegate() { CopyStreamWithRotation(errorStream, ".err.log"); }).Start(); } /// /// Works like the CopyStream method but does a log rotation. /// private void CopyStreamWithRotation(Stream data, string ext) { byte[] buf = new byte[1024]; FileStream w = new FileStream(BaseLogFileName + ext, FileMode.Append); long sz = new FileInfo(BaseLogFileName + ext).Length; while (true) { int len = data.Read(buf, 0, buf.Length); if (len == 0) break; // EOF if (sz + len < sizeThreshold) {// typical case. write the whole thing into the current file w.Write(buf, 0, len); sz += len; } else { // rotate at the line boundary int s = 0; for (int i = 0; i < len; i++) { if (buf[i] != 0x0A) continue; if (sz + i < sizeThreshold) continue; // at the line boundary and exceeded the rotation unit. // time to rotate. w.Write(buf, s, i + 1); w.Close(); s = i + 1; try { for (int j = filesToKeep; j >= 1; j--) { string dst = BaseLogFileName + "." + (j - 1) + ext; string src = BaseLogFileName + "." + (j - 2) + ext; if (File.Exists(dst)) File.Delete(dst); if (File.Exists(src)) File.Move(src, dst); } File.Move(BaseLogFileName + ext, BaseLogFileName + ".0" + ext); } catch (IOException e) { EventLogger.LogEvent("Failed to rotate log: " + e.Message); } // even if the log rotation fails, create a new one, or else // we'll infinitely try to rotate. w = new FileStream(BaseLogFileName + ext, FileMode.Create); sz = new FileInfo(BaseLogFileName + ext).Length; } } w.Flush(); } data.Close(); w.Close(); } } /// /// Rotate log when a service is newly started. /// public class RollingLogAppender : SimpleLogAppender { public RollingLogAppender(string logDirectory, string baseName) : base(logDirectory, baseName, FileMode.Append) { } public override void log(Stream outputStream, Stream errorStream) { CopyFile(OutputLogFileName, OutputLogFileName + ".old"); CopyFile(ErrorLogFileName, ErrorLogFileName + ".old"); base.log(outputStream, errorStream); } } }