Skip to content

Commit

Permalink
Made logging Linux compatible and added Get-TUNLoggingVersion function
Browse files Browse the repository at this point in the history
  • Loading branch information
@echalone
echalone committed Aug 19, 2020
1 parent dc7e887 commit 5897380
Show file tree
Hide file tree
Showing 2 changed files with 169 additions and 20 deletions.
18 changes: 10 additions & 8 deletions PowerShell/Modules/TUN.Logging/TUN.Logging.psd1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Markus Szumovski
#
# Generated on: 13.08.2020
# Generated on: 19.08.2020
#

@{
Expand All @@ -12,7 +12,7 @@
RootModule = 'TUN.Logging.psm1'

# Version number of this module.
ModuleVersion = '1.0.5'
ModuleVersion = '1.1.0'

# Supported PSEditions
# CompatiblePSEditions = @()
Expand Down Expand Up @@ -74,10 +74,11 @@ FunctionsToExport = 'Get-HasLogDebug', 'Get-HasLogError', 'Get-HasLogHost',
'Get-HasLogWarning', 'Get-HasMailLogDebug', 'Get-HasMailLogError',
'Get-HasMailLogHost', 'Get-HasMailLogInformation',
'Get-HasMailLogOutput', 'Get-HasMailLogVerbose',
'Get-HasMailLogWarning', 'Send-Log', 'Set-ForceLogSend', 'Start-Log',
'Start-MailLog', 'Stop-Log', 'Write-DebugLog', 'Write-ErrorLog',
'Write-HostLog', 'Write-InformationLog', 'Write-OutputLog',
'Write-VerboseLog', 'Write-WarningLog'
'Get-HasMailLogWarning', 'Get-TUNLoggingVersion', 'Send-Log',
'Set-ForceLogSend', 'Start-Log', 'Start-MailLog', 'Stop-Log',
'Write-DebugLog', 'Write-ErrorLog', 'Write-HostLog',
'Write-InformationLog', 'Write-OutputLog', 'Write-VerboseLog',
'Write-WarningLog'

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()
Expand All @@ -103,7 +104,7 @@ PrivateData = @{
PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
Tags = 'Logging','Logs','Log-File','Log-Files','Mailing','Mails','Log-Mail','Log-Mails'
Tags = 'Logging','Logs','LogFile','LogFiles','Log-File','Log-Files','Mailing','Mails','Log-Mail','LogMails','LogMail','Log-Mails','Linux','Windows','Core','PowershellCore','Powershell-Core','PS3','PS4','PS5','PS6','PS7'

# A URL to the license for this module.
LicenseUri = 'https://github.com/echalone/TUN/blob/master/PowerShell/Modules/LICENSE'
Expand All @@ -120,7 +121,8 @@ V 1.0.1: Updated module information
V 1.0.2: Moved markdown link from HelpInfoUri to description
V 1.0.3: Fixed icon link
V 1.0.4: Bumped required module version
V 1.0.5: Bugfixes for logging from console or function, added logging of user'
V 1.0.5: Bugfixes for logging from console or function, added logging of user
V 1.1.0: Bugfixes for Linux, now compatible with Linux Powershell Core'

# Prerelease string of this module
# Prerelease = ''
Expand Down
171 changes: 159 additions & 12 deletions PowerShell/Modules/TUN.Logging/TUN.Logging.psm1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ $script:LogMailRunning = $false # Is logging to
$script:LogPreference_NoTimestamp = $false # Should timestamps for the log-file be omitted?
$script:LogPreference_AsOutput = $false # Should the log file contain whatever the output contains (or everything=$false)?
$script:LogPreference_MailAsOutput = $false # Should the mail log contain whatever the output contains (or everything=$false)?
$script:LogPreference_FallbackForegroundColor = ` # Fallback color for foreground color if it is not possible to retrieve the information from the console
[ConsoleColor]::Gray
$script:LogPreference_FallbackBackgroundColor = ` # Fallback color for background color if it is not possible to retrieve the information from the console
[ConsoleColor]::Black

[Nullable[bool]] $script:LogPreference_MailError = $null # Should errors be sent in the log mail? ($null...either always or as output if -AsOutput switch is set)
[Nullable[bool]] $script:LogPreference_MailHost = $null # Should host messages be sent in the log mail? ($null...either always or as output if -AsOutput switch is set)
Expand Down Expand Up @@ -64,6 +68,7 @@ $script:ScriptInfo_File = $null # The filename o
$script:ScriptInfo_Name = $null # The filename without extension of the executing main scriptfile
$script:ScriptInfo_Version = $null # The version of the executing main scriptfile
$script:ScriptInfo_CurrentUser = $null # The user context at the start of logging
$script:ScriptInfo_ComputerName = $null # The machine name at the start of logging

function Coalesce
{
Expand Down Expand Up @@ -181,7 +186,21 @@ function RetrieveScriptInfo {
#>

if(!$script:ScriptInfo_Retrieved) {
$script:ScriptInfo_CurrentUser = $Env:UserDomain + "\" + $Env:UserName
$script:ScriptInfo_ComputerName = Coalesce -IfNull $Env:COMPUTERNAME -InsteadOfNull $Env:NAME
if([string]::IsNullOrWhiteSpace($script:ScriptInfo_ComputerName)) {
$script:ScriptInfo_ComputerName = "local"
}

$UserName = Coalesce -IfNull $Env:UserName -InsteadOfNull $Env:USER

if($UserName) {
if($Env:UserDomain) {
$script:ScriptInfo_CurrentUser = $Env:UserDomain + "\" + $UserName
}
else {
$script:ScriptInfo_CurrentUser = $UserName
}
}

$arr = @(Get-PSCallStack)

Expand Down Expand Up @@ -289,6 +308,58 @@ function RetrieveScriptInfo {
}
}

function Get-ConsoleForegroundColor {
<#
.SYNOPSIS
Gets current console foreground color,
or its fallback color if the console
color could not be determined
.OUTPUTS
Foreground color for console as type [ConsoleColor]
#>

try {
$Color = $Host.UI.RawUI.ForegroundColor
if([System.Enum]::IsDefined([System.Console] , $Color)) {
[ConsoleColor] $RetVal = [ConsoleColor]$Color

return [ConsoleColor] $RetVal
}
else {
return [ConsoleColor] $script:LogPreference_FallbackForegroundColor
}
}
catch {
return [ConsoleColor] $script:LogPreference_FallbackForegroundColor
}
}

function Get-ConsoleBackgroundColor {
<#
.SYNOPSIS
Gets current console background color,
or its fallback color if the console
color could not be determined
.OUTPUTS
Background color for console as type [ConsoleColor]
#>

try {
$Color = $Host.UI.RawUI.BackgroundColor
if([System.Enum]::IsDefined([System.Console] , $Color)) {
[ConsoleColor] $RetVal = [ConsoleColor]$Color

return [ConsoleColor] $RetVal
}
else {
return [ConsoleColor] $script:LogPreference_FallbackBackgroundColor
}
}
catch {
return [ConsoleColor] $script:LogPreference_FallbackBackgroundColor
}
}

function Get-ScriptPath {
<#
.SYNOPSIS
Expand Down Expand Up @@ -342,7 +413,7 @@ function Get-ScriptVersion {
.SYNOPSIS
Retrieves the version of the executing main script (if this hasn't happened yet) and returns it
.OUTPUTS
Path of executing main script
Version of executing main script
#>

RetrieveScriptInfo
Expand All @@ -354,13 +425,57 @@ function Get-ScriptUser {
.SYNOPSIS
Retrieves the user context (if this hasn't happened yet) and returns it
.OUTPUTS
Path of executing main script
Name of current user during log start
#>

RetrieveScriptInfo
return $script:ScriptInfo_CurrentUser
}

function Get-ScriptMachine {
<#
.SYNOPSIS
Retrieves the machine name (if this hasn't happened yet) and returns it
.OUTPUTS
Machine name during log start
#>

RetrieveScriptInfo
return $script:ScriptInfo_ComputerName
}

function Get-TUNLoggingVersion {
<#
.SYNOPSIS
Returns version of current TUN.Logging module
.PARAMETER AsString
True/Present...will return a version string
False/Absent...will return a version object
.OUTPUTS
Version of TUN.Logging module
#>

[CmdletBinding()]
PARAM (
[Parameter(Position=0)]
[switch] $AsString
)

$Version = $MyInvocation.MyCommand.Module.Version

if($null -ne $Version) {
if($AsString.IsPresent) {
return $Version.ToString()
}
else {
return $Version
}
}
else {
return $null
}
}

function Test-VerboseOutput {
<#
.SYNOPSIS
Expand Down Expand Up @@ -811,6 +926,12 @@ function Start-MailLog {
null or not specified...The adding of information messages depends on the AsOutput switch. If the AsOutput switch is present,
then information messages will only be added if they are displayed, if the AsOutput switch is absent, they will
always be added.
.PARAMETER LogPreference_FallbackForegroundColor
The fallback foreground color for the console if none was provided and the current foreground color could not be determined from the console.
The default is Gray.
.PARAMETER LogPreference_FallbackBackgroundColor
The fallback background color for the console if none was provided and the current background color could not be determined from the console.
The default is Black.
.PARAMETER AsOutput
True/Present...For all message types for which no LogPreference was set (or for which the LogPreference is null) the
message will only be added if it is displayed to the user (or would be displayed to the user if
Expand Down Expand Up @@ -849,6 +970,10 @@ function Start-MailLog {
[Nullable[bool]] $LogPreference_MailDebug,
[Parameter(Position=7)]
[Nullable[bool]] $LogPreference_MailInformation,
[Parameter(Position=8)]
[ConsoleColor] $LogPreference_FallbackForegroundColor = [ConsoleColor]::Gray,
[Parameter(Position=9)]
[ConsoleColor] $LogPreference_FallbackBackgroundColor = [ConsoleColor]::Black,
[switch] $AsOutput,
[switch] $InitCredentials,
[switch] $Force
Expand All @@ -872,15 +997,21 @@ function Start-MailLog {
$script:LogPreference_MailWarning = $LogPreference_MailWarning
$script:LogPreference_MailDebug = $LogPreference_MailDebug
$script:LogPreference_MailInformation = $LogPreference_MailInformation
$script:LogPreference_FallbackForegroundColor = $LogPreference_FallbackForegroundColor
$script:LogPreference_FallbackBackgroundColor = $LogPreference_FallbackBackgroundColor

$script:ForceLogSend = $false
$script:ForceLogReason = ""

$UserName = Get-ScriptUser

$UTCDateTime = (Get-Date).ToUniversalTime()
Write-MailLog -Message "***************************************************************************************************"
Write-MailLog -Message "`tPowerShell Version $($PSVersionTable.PSVersion.ToString())"
Write-MailLog -Message "`tLogging by module $($MyInvocation.MyCommand.Module.Name) Version $($MyInvocation.MyCommand.Module.Version)"
Write-MailLog -Message "`tUser at start of logging: ""$(Get-ScriptUser)"""
Write-MailLog -Message "`tLogging by module $($MyInvocation.MyCommand.Module.Name) Version $((Get-TUNLoggingVersion -AsString))"
if($UserName) {
Write-MailLog -Message "`tUser at start of logging: ""$UserName"""
}
Write-MailLog -Message "`tStarted script ""$(Get-ScriptPath)"""
Write-MailLog -Message "`tCalling command ""$(Get-ScriptCall)"""

Expand Down Expand Up @@ -1003,7 +1134,7 @@ function Send-Log {
if(!$Subject) {
$Subject = $("Notification from `$(COMPUTERNAME)/`$(SCRIPTNAME)")
}
$Subject = $Subject.Replace("`$(COMPUTERNAME)", $env:COMPUTERNAME).Replace("`$(SCRIPTNAME)", $(Get-ScriptName))
$Subject = $Subject.Replace("`$(COMPUTERNAME)", (Get-ScriptMachine)).Replace("`$(SCRIPTNAME)", $(Get-ScriptName))
$Subject += ", Reason: $strSendReason"

$strTo = $To -Join ","
Expand Down Expand Up @@ -1176,6 +1307,12 @@ function Start-Log {
null or not specified...The adding of information messages depends on the AsOutput switch. If the AsOutput switch is present,
then information messages will only be added if they are displayed, if the AsOutput switch is absent, they will
always be added.
.PARAMETER LogPreference_FallbackForegroundColor
The fallback foreground color for the console if none was provided and the current foreground color could not be determined from the console.
The default is Gray.
.PARAMETER LogPreference_FallbackBackgroundColor
The fallback background color for the console if none was provided and the current background color could not be determined from the console.
The default is Black.
.PARAMETER NoTimestamp
True/Present...Will not automatically add a timestamp to the beginning of each line in the log file.
If this switch is set, use the -AddTimestamp switch on individual log calls to add a timestamp if needed.
Expand Down Expand Up @@ -1226,6 +1363,10 @@ function Start-Log {
[Nullable[bool]] $LogPreference_LogDebug,
[Parameter(Position=9)]
[Nullable[bool]] $LogPreference_LogInformation,
[Parameter(Position=10)]
[ConsoleColor] $LogPreference_FallbackForegroundColor = [ConsoleColor]::Gray,
[Parameter(Position=11)]
[ConsoleColor] $LogPreference_FallbackBackgroundColor = [ConsoleColor]::Black,
[switch] $NoTimestamp,
[switch] $UseComputerPrefix,
[switch] $UseScriptPrefix,
Expand All @@ -1250,7 +1391,7 @@ function Start-Log {
$LogName = "yyyy-MM-dd\THHmmss"
}

$LogPath = $LogPath.Replace("`$(COMPUTERNAME)", $env:COMPUTERNAME).Replace("`$(SCRIPTNAME)", $(Get-ScriptName))
$LogPath = $LogPath.Replace("`$(COMPUTERNAME)", (Get-ScriptMachine)).Replace("`$(SCRIPTNAME)", $(Get-ScriptName))

if($UseScriptPrefix.IsPresent -or $UseDefaultName.IsPresent) {
$LogName = "`$(SCRIPTNAME)_" + $LogName
Expand All @@ -1272,7 +1413,7 @@ function Start-Log {
}

#the datetime format function has removed all previously added escape backslashes from our variable names, so we can now replace the normal variable name with our values
$LogName = $LogName.Replace("`$(COMPUTERNAME)", $env:COMPUTERNAME).Replace("`$(SCRIPTNAME)", $(Get-ScriptName))
$LogName = $LogName.Replace("`$(COMPUTERNAME)", (Get-ScriptMachine)).Replace("`$(SCRIPTNAME)", $(Get-ScriptName))

$LogName = $LogName + "." + $LogExtension

Expand All @@ -1294,13 +1435,17 @@ function Start-Log {
Remove-Item -Path $script:LogFile -Force
}

$UserName = Get-ScriptUser

$script:WhatIfLog = !$PSCmdlet.ShouldProcess("$script:LogFile", "Logging")

if(!$script:WhatIfLog -and $null -ne $script:LogFile) {
Add-Content -Path $script:LogFile -Value "***************************************************************************************************"
Add-Content -Path $script:LogFile -Value "`tPowerShell Version $($PSVersionTable.PSVersion.ToString())"
Add-Content -Path $script:LogFile -Value "`tLogging by module $($MyInvocation.MyCommand.Module.Name) Version $($MyInvocation.MyCommand.Module.Version)"
Add-Content -Path $script:LogFile -Value "`tUser at start of logging: ""$(Get-ScriptUser)"""
Add-Content -Path $script:LogFile -Value "`tLogging by module $($MyInvocation.MyCommand.Module.Name) Version $((Get-TUNLoggingVersion -AsString))"
if($UserName) {
Add-Content -Path $script:LogFile -Value "`tUser at start of logging: ""$UserName"""
}
Add-Content -Path $script:LogFile -Value "`tStarted script ""$(Get-ScriptPath)"""
Add-Content -Path $script:LogFile -Value "`tCalling command ""$(Get-ScriptCall)"""
if(Get-ScriptVersion) {
Expand All @@ -1324,6 +1469,8 @@ function Start-Log {
$script:LogPreference_LogWarning = $LogPreference_LogWarning
$script:LogPreference_LogDebug = $LogPreference_LogDebug
$script:LogPreference_LogInformation = $LogPreference_LogInformation
$script:LogPreference_FallbackForegroundColor = $LogPreference_FallbackForegroundColor
$script:LogPreference_FallbackBackgroundColor = $LogPreference_FallbackBackgroundColor

$script:ErrorLogCount = 0
$script:HostLogCount = 0
Expand Down Expand Up @@ -1710,8 +1857,8 @@ function Write-HostLog {
[Parameter(Mandatory, ValueFromPipeline)]
[object] $Message,
[switch] $NoNewline,
[ConsoleColor] $ForegroundColor = $host.UI.RawUI.ForegroundColor,
[ConsoleColor] $BackgroundColor = $host.UI.RawUI.BackgroundColor,
[ConsoleColor] $ForegroundColor = (Get-ConsoleForegroundColor),
[ConsoleColor] $BackgroundColor = (Get-ConsoleBackgroundColor),
[switch] $NoOut,
[switch] $NoLog,
[switch] $NoMail,
Expand Down

0 comments on commit 5897380

Please sign in to comment.