Kabompo

1.1.0.126

Kabompo.Logging.ps1

                                #

# Kabompo.Logging.ps1

#

function Register-KabompoLogging

{

    <#

    .SYNOPSIS

        Starts logging of KABOMPO module.

    .DESCRIPTION

        Initializes the logging to the KABOMPO logfile in the subdirectory "log". Please be sure, that the executing user has write access to this folder.

    .EXAMPLE

        Register-Logging -Name "MyLog" -Extension "log" -MaxSize 5000000 -MaxAge 60

    .EXAMPLE

        Register-Logging

    .NOTES

    .LINK

        https://marketplace.matrix42.com

    #>

    Param

    (

        [Parameter(Mandatory=$false)]

        [string]$Name="kabompo",

        [Parameter(Mandatory=$false)]

        [string]$Extension="log",

        [Parameter(Mandatory=$false)]

        [int]$MaxSize=5000000,

        [Parameter(Mandatory=$false)]

        [int]$MaxAge=60

    )

    $logCount = 1

    try

    {

        $global:kabompoLog = $null

        # Check if path exist

        if(!(Test-Path "$($PSScriptRoot)\log"))

        {

            try

                { $logPath = (New-Item -Path "$($PSScriptRoot)" -Name "log" -ItemType directory).FullName }

            catch

                { $logPath = (New-Item -Path "$($env:TEMP)" -Name "KABOMPO" -ItemType directory).FullName }

        }

        else

            { $logPath = "$($PSScriptRoot)\log" }

        # define the absolute path of the logfile 

        $logFile = "{0}\{1}.{2}" -f $logPath, $Name, $Extension

        # get files based on lastwrite filter and specified folder

        $Files = @(Get-ChildItem $logPath -Filter "*.$Extension" | where { $_.LastWriteTime -le ((Get-Date).AddDays(-$MaxAge))})

        # Delete all files older than X days and bigger that Y size

        foreach ($File in $Files) 

            { Remove-Item $File.FullName | Out-Null }

        # Is logfile size more than size X

        $log = @(Get-ChildItem $logPath -Filter "$Name.$Extension" | where { $_.Length -ge $MaxSize })

        if($log -ne $null)

        {

            # Find the next free logfile-name

            while ($targetLogName -eq $null) 

            { 

                $testLogName = "{0}_{1}.{2}" -f $Name, $logCount, $Extension

                if(!(Test-Path "$logPath\$testLogName"))

                    { $targetLogName = $testLogName } 

                else 

                    { $logCount++ }

            }

            # Rename logfile

            Rename-Item -Path $logFile -NewName $targetLogName

        }

        # Define logfile-name

        $global:kabompoLog = $logFile

        # Set LogLevel 

        if($global:LogDetailLevel -eq $null)

            { $global:LogDetailLevel = 1 }

        Add-KabompoLogLine -Message "----------------- New logfile worker initialized. Start logging ----------------- " -Component Register-KabompoLogging -Type 1

    }

    catch

    {

        throw $_.Exception

    }

}

function Add-KabompoLogLine

{

    <#

    .SYNOPSIS

        Add a line to the KABOMPO logfile.

    .DESCRIPTION

        Add a line to the KABOMPO logfile in the subdirectory "log". Please be sure, that the executing user has write access to this folder.

    .EXAMPLE

        Add-KabompoLogLine -Message "Some message" -Component My-CurrentFunction -Type 1 

    .EXAMPLE

        Add-KabompoLogLine -Message "Some message" -ErrorMessage "My detailed error message" -Component My-CurrentFunction -Type 3

    .NOTES

    .LINK

        https://marketplace.matrix42.com

    #>

    Param 

    (

        [Parameter(Mandatory=$true)]

        $Message,

        [Parameter(Mandatory=$false)]

        $ErrorMessage,

        [Parameter(Mandatory=$false)]

        $Component,

        [Parameter(Mandatory=$true)]

        [ValidateSet(1,2,3)] #Type: 1 = Normal, 2 = Warning (yellow), 3 = Error (red)

        [int]$Type,

        [Parameter(Mandatory=$false)]

        [ValidateSet(0,1,2)] #Log Level: 0 = Debug, 1 = Normal, 2 = Minimalistic

        [int]$LogLevel = 1

    )

    # Exit when logging is disabled for unit testing

    if($global:LogDetailLevel -eq 99)

        { return }

    # Exit function when given loglevel is less than configured loglevel

    if($LogLevel -lt $global:LogDetailLevel -and  $Type -eq 1)

        { return }

    # Exit function if idention level is too high for minimalistic loglevel

    if($global:logIndention -ge 1 -and $global:LogDetailLevel -eq 2 -and $Type -eq 1)

        { return }

    # Exit function if idention level is too high for normal loglevel

    if($global:logIndention -ge 2 -and $global:LogDetailLevel -eq 1 -and $Type -eq 1)

        { return }

    # exit function if logging is switched off

    if($LogLevel -eq 3)

        { return }

    # Exit function if no message is given

    if([string]::IsNullOrEmpty($Message) -and [string]::IsNullOrEmpty($ErrorMessage))

        { return }

    # Use Errormessage as message when message is empty

    elseif([string]::IsNullOrEmpty($Message) -and ![string]::IsNullOrEmpty($ErrorMessage))

        { $Message = $ErrorMessage }

    # Combine Errormessage and Message when both are given

    elseif(![string]::IsNullOrEmpty($Message) -and ![string]::IsNullOrEmpty($ErrorMessage))

        { $Message = "{0}. Details: {1}" -f $Message, $ErrorMessage }

    # Generate Date and Time string for CMTrace and Console Log

    $TimeString = Get-Date -Format "HH:mm:ss.ffffff"

    $DateString = Get-Date -Format "MM-dd-yyyy"

    # If errormessage is given, set message type to error

    if (![string]::IsNullOrEmpty($ErrorMessage)) 

        {$Type = 3}

    # Set default comonent string when not given

    if ([string]::IsNullOrEmpty($Component)) 

        {$Component = "KABOMPO"}

    # Configure Log Message output string

    $LogMessage = "<![LOG[{0}]LOG]!><time=""{1}"" date=""{2}"" component=""{3}"" context="""" type=""{4}"" thread="""" file="""">" -f $Message, $TimeString, $DateString, $Component, $Type

    #2016-05-06 OLD: $LogMessage = "<![LOG[$Message $ErrorMessage" + "]LOG]!><time=`"$Time`" date=`"$Date`" component=`"$Component`" context=`"`" type=`"$Type`" thread=`"`" file=`"`">"

    $LogMessage | Out-File -Append -Encoding UTF8 -FilePath $global:kabompoLog

    # Write output also to host when enabled and PS-Host is Console or ISE

    if($global:LogToConsole -eq $true -and ((get-host).Name -eq "ConsoleHost" -or (get-host).Name -eq "Windows PowerShell ISE Host"))

        { Write-KabompoLogToHost -Message $Message -Component $Component -Type $Type -DateString $DateString -TimeString $TimeString }

}

function Write-KabompoLogToHost

{

    <#

    .SYNOPSIS

        Output a line to the Powershell console.

    .DESCRIPTION

        Output a line to the Powershell console. This function is just for internal use and not published in the module.

    .EXAMPLE

        Write-EMLogToHost -Message "Some message" -Component My-CurrentFunction -Type 1 -DateString 2016-05-06 -TimeString 12:39:33.698623

    .NOTES

    .LINK

        https://marketplace.matrix42.com

    #>

    Param 

    (

        [Parameter(Mandatory=$true)]

        [string]$Message,

        [Parameter(Mandatory=$true)]

        [string]$Component,

        [Parameter(Mandatory=$true)]

        [ValidateSet(1,2,3)] #Type: 1 = Normal, 2 = Warning (yellow), 3 = Error (red)

        [int]$Type,

        [Parameter(Mandatory=$true)]

        [string]$DateString,

        [Parameter(Mandatory=$true)]

        [string]$TimeString

    )

    $indent = (37 - $Component.Length) + ($global:logIndention * 2)

    # Output information line to the console with the normal powershell console colors

    $indentMessage = $Message.PadLeft($Message.Length + $indent, " ")

    if($Type -eq 1)

    { 

        $HostMessage = "{0}_{1} I [{2}] {3}" -f $DateString, $TimeString, $Component, $indentMessage

        Write-Host -Object $HostMessage

    }

    # Output warning line to the console in yellow

    elseif($Type -eq 2)

    { 

        $HostMessage = "{0}_{1} W [{2}] {3}" -f $DateString, $TimeString, $Component, $indentMessage

        Write-Host -Object $HostMessage -ForegroundColor Yellow

    }

    # Output error line to the console in red

    elseif($Type -eq 3)

    { 

        $HostMessage = "{0}_{1} E [{2}] {3}" -f $DateString, $TimeString, $Component, $indentMessage

        Write-Host -Object $HostMessage -ForegroundColor Red

    }

}

# SIG # Begin signature block

# MIINJAYJKoZIhvcNAQcCoIINFTCCDRECAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB

# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR

# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUn7y2CHzuG0BRKoejJmEHc4Qy

# 7KKgggpZMIIE+DCCA+CgAwIBAgIQXWihGXfS4Od7/8YeI88pIDANBgkqhkiG9w0B

# AQsFADB/MQswCQYDVQQGEwJVUzEdMBsGA1UEChMUU3ltYW50ZWMgQ29ycG9yYXRp

# b24xHzAdBgNVBAsTFlN5bWFudGVjIFRydXN0IE5ldHdvcmsxMDAuBgNVBAMTJ1N5

# bWFudGVjIENsYXNzIDMgU0hBMjU2IENvZGUgU2lnbmluZyBDQTAeFw0xNTAyMDMw

# MDAwMDBaFw0xODA0MDMyMzU5NTlaMGAxCzAJBgNVBAYTAkRFMQ8wDQYDVQQIEwZI

# ZXNzZW4xEjAQBgNVBAcTCUZyYW5rZnVydDEVMBMGA1UEChQMTWF0cml4IDQyIEFH

# MRUwEwYDVQQDFAxNYXRyaXggNDIgQUcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw

# ggEKAoIBAQDHZNuFnBatHdyRnMUJ2Y1P6k49MjD04t9S7ukWj8upP/B6wPRYzzQf

# 6QVMPKzMhNTPfIXaIEzi/jhT0jjwnXC0O9hF2rwTpDRnVOnVJemaqd2XsSDVEBUY

# yhH7QZ82Zwi1nnSgo69WL694L3f74ge6bRiRIJ/IoZawj+74NL/9B93kGKH89sew

# VtqPoDwSklJmzc86Qlgw6X/WXenHw8n6k/htEIjkHpiE6iGkDZp1gAPBERIV/qi/

# HyIZpvsO3g9RvcWEDvRvq6ZsIPfAvtlOnVWPrvik96pEDugHKPtvyjuAQtJtxw42

# zsYbB7lQxCo7khjhuZKYrzjv/l79BnC1AgMBAAGjggGNMIIBiTAJBgNVHRMEAjAA

# MA4GA1UdDwEB/wQEAwIHgDArBgNVHR8EJDAiMCCgHqAchhpodHRwOi8vc3Yuc3lt

# Y2IuY29tL3N2LmNybDBmBgNVHSAEXzBdMFsGC2CGSAGG+EUBBxcDMEwwIwYIKwYB

# BQUHAgEWF2h0dHBzOi8vZC5zeW1jYi5jb20vY3BzMCUGCCsGAQUFBwICMBkMF2h0

# dHBzOi8vZC5zeW1jYi5jb20vcnBhMBMGA1UdJQQMMAoGCCsGAQUFBwMDMFcGCCsG

# AQUFBwEBBEswSTAfBggrBgEFBQcwAYYTaHR0cDovL3N2LnN5bWNkLmNvbTAmBggr

# BgEFBQcwAoYaaHR0cDovL3N2LnN5bWNiLmNvbS9zdi5jcnQwHwYDVR0jBBgwFoAU

# ljtT8Hkzl699g+8uK8zKt4YecmYwHQYDVR0OBBYEFAAbz15M7iRhPipVPcQDgb2D

# MWA5MBEGCWCGSAGG+EIBAQQEAwIEEDAWBgorBgEEAYI3AgEbBAgwBgEBAAEB/zAN

# BgkqhkiG9w0BAQsFAAOCAQEAScMz5dR4/qoFzikf7Dj15lRfGWNY1IZ50GPxhhqo

# aMM8Vb8oyO3Z0J9bRuX/gwV80NaaKuC1MX2b/5yVLqTpZXvVAO4uwxNq5/BXywi5

# 7Wb6V2ld9Fey9TsSQHZLwbyYua1+yPGAnI7hcc/I9TAsHXIjx0kclwJm8FYMUh8+

# NnEnt7PTV3Z0ytUsR/oS7Kq5TYNhxKUpTP2vZfdYnM7yf4oglandpdsA0tJATc2r

# Gw/tdUEqOyynzPG5OI49SDkypSdFTdEnN70CwrHUcIplwY3Ro7hWWtHA4drT2bgh

# 1KsFyPjq3rDQD6xWAIuiFlBAwnr1DzdGFi2jMZfKLWNpXTCCBVkwggRBoAMCAQIC

# ED141/l2SWCyYX308B7KhiowDQYJKoZIhvcNAQELBQAwgcoxCzAJBgNVBAYTAlVT

# MRcwFQYDVQQKEw5WZXJpU2lnbiwgSW5jLjEfMB0GA1UECxMWVmVyaVNpZ24gVHJ1

# c3QgTmV0d29yazE6MDgGA1UECxMxKGMpIDIwMDYgVmVyaVNpZ24sIEluYy4gLSBG

# b3IgYXV0aG9yaXplZCB1c2Ugb25seTFFMEMGA1UEAxM8VmVyaVNpZ24gQ2xhc3Mg

# MyBQdWJsaWMgUHJpbWFyeSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eSAtIEc1MB4X

# DTEzMTIxMDAwMDAwMFoXDTIzMTIwOTIzNTk1OVowfzELMAkGA1UEBhMCVVMxHTAb

# BgNVBAoTFFN5bWFudGVjIENvcnBvcmF0aW9uMR8wHQYDVQQLExZTeW1hbnRlYyBU

# cnVzdCBOZXR3b3JrMTAwLgYDVQQDEydTeW1hbnRlYyBDbGFzcyAzIFNIQTI1NiBD

# b2RlIFNpZ25pbmcgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX

# gx4AFq8ssdIIxNdok1FgHnH24ke021hNI2JqtL9aG1H3ow0Yd2i72DarLyFQ2p7z

# 518nTgvCl8gJcJOp2lwNTqQNkaC07BTOkXJULs6j20TpUhs/QTzKSuSqwOg5q1PM

# IdDMz3+b5sLMWGqCFe49Ns8cxZcHJI7xe74xLT1u3LWZQp9LYZVfHHDuF33bi+Vh

# iXjHaBuvEXgamK7EVUdT2bMy1qEORkDFl5KK0VOnmVuFNVfT6pNiYSAKxzB3JBFN

# YoO2untogjHuZcrf+dWNsjXcjCtvanJcYISc8gyUXsBWUgBIzNP4pX3eL9cT5Dio

# hNVGuBOGwhud6lo43ZvbAgMBAAGjggGDMIIBfzAvBggrBgEFBQcBAQQjMCEwHwYI

# KwYBBQUHMAGGE2h0dHA6Ly9zMi5zeW1jYi5jb20wEgYDVR0TAQH/BAgwBgEB/wIB

# ADBsBgNVHSAEZTBjMGEGC2CGSAGG+EUBBxcDMFIwJgYIKwYBBQUHAgEWGmh0dHA6

# Ly93d3cuc3ltYXV0aC5jb20vY3BzMCgGCCsGAQUFBwICMBwaGmh0dHA6Ly93d3cu

# c3ltYXV0aC5jb20vcnBhMDAGA1UdHwQpMCcwJaAjoCGGH2h0dHA6Ly9zMS5zeW1j

# Yi5jb20vcGNhMy1nNS5jcmwwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMD

# MA4GA1UdDwEB/wQEAwIBBjApBgNVHREEIjAgpB4wHDEaMBgGA1UEAxMRU3ltYW50

# ZWNQS0ktMS01NjcwHQYDVR0OBBYEFJY7U/B5M5evfYPvLivMyreGHnJmMB8GA1Ud

# IwQYMBaAFH/TZafC3ey78DAJ80M5+gKvMzEzMA0GCSqGSIb3DQEBCwUAA4IBAQAT

# hRoeaak396C9pK9+HWFT/p2MXgymdR54FyPd/ewaA1U5+3GVx2Vap44w0kRaYdtw

# b9ohBcIuc7pJ8dGT/l3JzV4D4ImeP3Qe1/c4i6nWz7s1LzNYqJJW0chNO4LmeYQW

# /CiwsUfzHaI+7ofZpn+kVqU/rYQuKd58vKiqoz0EAeq6k6IOUCIpF0yH5DoRX9ak

# JYmbBWsvtMkBTCd7C6wZBSKgYBU/2sn7TUyP+3Jnd/0nlMe6NQ6ISf6N/SivShK9

# DbOXBd5EDBX6NisD3MFQAfGhEV0U5eK9J0tUviuEXg+mw3QFCu+Xw4kisR93873N

# Q9TxTKk/tYuEr2Ty0BQhMYICNTCCAjECAQEwgZMwfzELMAkGA1UEBhMCVVMxHTAb

# BgNVBAoTFFN5bWFudGVjIENvcnBvcmF0aW9uMR8wHQYDVQQLExZTeW1hbnRlYyBU

# cnVzdCBOZXR3b3JrMTAwLgYDVQQDEydTeW1hbnRlYyBDbGFzcyAzIFNIQTI1NiBD

# b2RlIFNpZ25pbmcgQ0ECEF1ooRl30uDne//GHiPPKSAwCQYFKw4DAhoFAKB4MBgG

# CisGAQQBgjcCAQwxCjAIoAKAAKECgAAwGQYJKoZIhvcNAQkDMQwGCisGAQQBgjcC

# AQQwHAYKKwYBBAGCNwIBCzEOMAwGCisGAQQBgjcCARUwIwYJKoZIhvcNAQkEMRYE

# FCry0HBbwZ1++nCG/t5PcC6f4UurMA0GCSqGSIb3DQEBAQUABIIBAF6zDPPsmUt8

# SYsAzshPyt80Tf9Lxo8saF+ZZbzPJacPRemSRrZoyo83WpTf2vHT76nlMaruuIOt

# pf1mhnPbewpf8d6t+3T5LjrCzRG/GyeCLrjyNTjMeLxdXptZugbJCfptwgDE2CLy

# w3lHEPgzhEJUs/Jq+rvIZVLAduT680ZK4aa7N9S5Vs4ugHBFwxQlGpE49JBoL44Q

# 5U7J5AAxgo9cQ3BGNwavij6erRtivFDtF8q/v8+BdUeasxmaMvhN/DwGMrCNKcik

# NY+v0qClPtOycVD/SnU0eyWUIbBBuhD67r6oZDIZkVbwW+5M5eiXRgY7tCdgwXFg

# /TttCinhLbE=

# SIG # End signature block