-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added example projects. Added documentation. Minor tweaks and renamings.
- Loading branch information
1 parent
ae33644
commit 6b8bd9e
Showing
42 changed files
with
692 additions
and
143 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| using System; | ||
| using System.Diagnostics; | ||
| using System.IO; | ||
| using System.Reflection; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Serilog; | ||
| using Serilog.Configuration; | ||
| using Serilog.Events; | ||
|
|
||
| namespace J4JSoftware.Logging | ||
| { | ||
| public partial class FileChannel : LogChannel | ||
| { | ||
| public static string DefineLocalAppDataLogPath( string fileStub, string folder = null ) | ||
| { | ||
| fileStub = IsFileNameValid( fileStub ) ? fileStub : "log.txt"; | ||
|
|
||
| if( string.IsNullOrEmpty( folder ) ) | ||
| folder = GetProgramName(); | ||
|
|
||
| DirectoryInfo logDir = null; | ||
|
|
||
| if( ( logDir = CreateLogFileDirectory( folder ) ) == null ) | ||
| { | ||
| if( ( logDir = CreateLogFileDirectory( "LogFiles" ) ) == null ) | ||
| throw new ApplicationException( | ||
| $"Couldn't create log file directory {folder} or the backup/default directory 'LogFiles'" ); | ||
| } | ||
|
|
||
| return Path.Combine( logDir.FullName, fileStub ); | ||
| } | ||
|
|
||
| public static string DefineExeLogPath( string fileStub, string folder = null ) | ||
| { | ||
| fileStub = IsFileNameValid( fileStub ) ? fileStub : "log.txt"; | ||
|
|
||
| if( folder != null && !IsFileNameValid( folder ) ) | ||
| folder = null; | ||
|
|
||
| return string.IsNullOrEmpty( folder ) | ||
| ? Path.Combine( Environment.CurrentDirectory, fileStub ) | ||
| : Path.Combine( Environment.CurrentDirectory, folder, fileStub ); | ||
| } | ||
|
|
||
| private static bool IsFileNameValid( string fileName ) | ||
| { | ||
| return !string.IsNullOrEmpty( fileName ) | ||
| && fileName.IndexOfAny( Path.GetInvalidFileNameChars() ) >= 0 | ||
| && fileName.IndexOfAny( Path.GetInvalidPathChars() ) >= 0; | ||
| } | ||
|
|
||
| private static DirectoryInfo CreateLogFileDirectory( string folder ) | ||
| { | ||
| var appDataFolder = Environment.GetFolderPath( Environment.SpecialFolder.LocalApplicationData ); | ||
| var fullPath = Path.Combine( appDataFolder, folder ); | ||
|
|
||
| try | ||
| { | ||
| return Directory.CreateDirectory( fullPath ); | ||
| } | ||
| #pragma warning disable 168 | ||
| catch( IOException ioException ) | ||
| #pragma warning restore 168 | ||
| { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private static string GetProgramName() | ||
| { | ||
| var defaultName = | ||
| Path.GetFileNameWithoutExtension( Assembly.GetExecutingAssembly().GetType().Assembly.Location ); | ||
|
|
||
| var trace = new StackTrace(); | ||
|
|
||
| // we want the last frame | ||
| return trace.GetFrame( trace.FrameCount - 1 )? | ||
| .GetMethod()? | ||
| .DeclaringType? | ||
| .Assembly? | ||
| .GetName()? | ||
| .Name | ||
| ?? defaultName; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,12 @@ | ||
| namespace J4JSoftware.Logging | ||
| { | ||
| // distinguishes between allowable locations for log files | ||
| public enum LogFileLocation | ||
| { | ||
| // store the log file in the user's AppData folder | ||
| AppData, | ||
|
|
||
| // store the log file in the application's exe folder | ||
| ExeFolder | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.