LogFileModule.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<#
BSD 3-Clause License
 
Copyright (c) 2018, FB Pro GmbH
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
 
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
 
* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#>


#region Author(s)
#
# Author(s): Dennis Esly
# Date: 05/01/2017
# Last change: 05/02/2017
# Version: 1.0
#
#endregion

function Set-LogFile
{
    [CmdletBinding(SupportsShouldProcess)]
    Param(
        [Parameter(Mandatory=$true)]
        [Alias('LogPath')]
        [string]$Path,
        [Parameter(Mandatory=$true)]
        [Alias('Logname')]
        [string]$Name
    )


    $FullPath = get-FullPath $Path $Name

    # Create file if it does not already exists
    if (!(Test-Path -Path $FullPath)){
        # WhatIf parameter
        if ($PSCmdlet.ShouldProcess("$FullPath", "Overwrite")) {
            # Create file and start logging
            New-Item -Path $FullPath -ItemType File -Force | Out-Null

            Add-Content -Path $FullPath -Value "***************************************************************************************************"
            Add-Content -Path $FullPath -Value " Logfile created at [$([DateTime]::Now)]"
            Add-Content -Path $FullPath -Value "***************************************************************************************************"
            Add-Content -Path $FullPath -Value ""
            Add-Content -Path $FullPath -Value ""
        }
    }
}


function Write-LogFile
{
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory=$true)]
        [Alias('LogMessage')]
        [string]$Message,

        [Parameter(Mandatory=$true)]
        [Alias('LogPath')]
        [string]$Path,

        [Parameter(Mandatory=$true)]
        [Alias('Logname')]
        [string]$Name,

        [ValidateSet("Error","Warning","Info")]
        [string]$Level = "Info"
    )


    set-LogFile $Path $Name
    $FullPath = get-FullPath $Path $Name



    # Format date for log file
    $FormattedDate = Get-Date -Format "yyyy-MM-dd HH:mm:ss"

    switch($Level)
    {
        'Error' {
            Write-Error $Message
            $LevelText = '[ERROR]:'
            }
        'Warning' {
            Write-Warning $Message
            $LevelText = '[WARNING]:'
            }
        'Info' {
            Write-Verbose $Message
            $LevelText = '[INFO]:'
            }
    }
    Add-Content $FullPath "$FormattedDate $LevelText"
    Add-Content $FullPath "$Message"
    Add-Content $FullPath "--------------------------"
    Add-Content $FullPath ""
}


function Get-FullPath
{
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory=$true)]
        [string]$Path,
        [Parameter(Mandatory=$true)]
        [string]$File
    )

    if ($Path.Length -gt 0)
    {
        if ($Path[$Path.Length-1] -ne "\")
        {
            $FullPath = $Path + "\" + $File
        }
        else
        {
            $FullPath = $Path + $File
        }
    }

    return $FullPath
}