PowerLumber.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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
Write-Verbose 'Importing from [C:\projects\powerlumber\PowerLumber\private]'
# .\PowerLumber\private\Compare-Weekday.ps1
function Compare-Weekday
{
    <#
 .DESCRIPTION
  Determine if the day of the week has changed since the last check.
    .PARAMETER Weekday
        A valid Day of the week is required.
 .EXAMPLE
        Compare-Weekday -Weekday Tuesday
 .NOTES
        It will return boolean
    #>

    [CmdletBinding()]
    [OutputType([boolean])]
    param(
        $Weekday = $null
    )
    if ($null -eq $Weekday)
    {
        # No day was passed in (This is acceptable.)
        Return $false
    }
    else
    {
        $CurrentDay = (Get-Date).DayOfWeek
        if ($CurrentDay -eq $Weekday)
        {
            # The days match.
            $true
        }
        else
        {
            # The days do not match.
            $false
        }
    }
}
# .\PowerLumber\private\Get-Timestamp.ps1
#=============================================================================================
# ____ _ _
#| _ \ _____ _____ _ __| | _ _ _ __ ___ | |__ ___ _ __
#| |_) / _ \ \ /\ / / _ \ '__| | | | | | '_ ` _ \| '_ \ / _ \ '__|
#| __/ (_) \ V V / __/ | | |__| |_| | | | | | | |_) | __/ |
#|_| \___/ \_/\_/ \___|_| |_____\__,_|_| |_| |_|_.__/ \___|_|
#=============================================================================================
function Get-Timestamp
{
    <#
 .SYNOPSIS
  Function to create timestamp.
 .DESCRIPTION
  Returns the current timestamp.
 .EXAMPLE
  $datenow = Get-Timestamp
 .NOTES
  No Additional information about the function or script.
 #>
  
    try
    {
        return $(get-date).ToString("yyyy-MM-dd HH:mm:ss")
    } 
    Catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName        
        Throw "Get-Timestamp: $ErrorMessage $FailedItem"
    }
}
#=============================================================================================
# ___ _ _ _ _ _
# |_ _|_ ____ _____ | | _____ / \ _ _| |_ ___ _ __ ___ __ _| |_(_) ___ _ __
# | || '_ \ \ / / _ \| |/ / _ \_____ / _ \| | | | __/ _ \| '_ ` _ \ / _` | __| |/ _ \| '_ \
# | || | | \ V / (_) | < __/_____/ ___ \ |_| | || (_) | | | | | | (_| | |_| | (_) | | | |
# |___|_| |_|\_/ \___/|_|\_\___| /_/ \_\__,_|\__\___/|_| |_| |_|\__,_|\__|_|\___/|_| |_|
#=============================================================================================

Write-Verbose 'Importing from [C:\projects\powerlumber\PowerLumber\public]'
# .\PowerLumber\public\Clear-LogDirectory.ps1
#=============================================================================================
# ____ _ _
#| _ \ _____ _____ _ __| | _ _ _ __ ___ | |__ ___ _ __
#| |_) / _ \ \ /\ / / _ \ '__| | | | | | '_ ` _ \| '_ \ / _ \ '__|
#| __/ (_) \ V V / __/ | | |__| |_| | | | | | | |_) | __/ |
#|_| \___/ \_/\_/ \___|_| |_____\__,_|_| |_| |_|_.__/ \___|_|
#=============================================================================================
function Clear-LogDirectory
{
    <#
 .SYNOPSIS
  Clears logs in a directory older than the specified number of days.
 .DESCRIPTION
  Clears logs in a directory older than the specified number of days.
 .PARAMETER Path
  Please Specify a valid path.
 .PARAMETER Daysback
  Please Specify a number of daysback.
 .EXAMPLE
  Clear-LogDirectory -Path "c:\temp" -DaysBack 3
 .NOTES
  No Additional information about the function or script.
 #>
    
    param(    
        [cmdletbinding()]
        [Parameter(Mandatory = $true)]
        [ValidateScript( {Test-Path $_ })]
        [string]$Path,
        [Parameter(Mandatory = $true)]
        [int]$DaysBack
    )
    try
    {
        $DatetoDelete = (Get-Date).AddDays( - $Daysback)
        if (! (Get-ChildItem $Path))
        {
            Write-Log -Message "Path is not valid" -OutputStyle consoleOnly
        }
        else
        {
            Get-ChildItem $Path -Recurse  | Where-Object { $_.LastWriteTime -lt $DatetoDelete } | Remove-Item -Recurse -Confirm:$false
            Write-Log -Message "Logs older than $DaysBack have been cleared!" -OutputStyle consoleOnly
        }
    }
    Catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName        
        Throw "Clear-LogDirectory: $ErrorMessage $FailedItem"        
    }
}
#=============================================================================================
# ___ _ _ _ _ _
# |_ _|_ ____ _____ | | _____ / \ _ _| |_ ___ _ __ ___ __ _| |_(_) ___ _ __
# | || '_ \ \ / / _ \| |/ / _ \_____ / _ \| | | | __/ _ \| '_ ` _ \ / _` | __| |/ _ \| '_ \
# | || | | \ V / (_) | < __/_____/ ___ \ |_| | || (_) | | | | | | (_| | |_| | (_) | | | |
# |___|_| |_|\_/ \___/|_|\_\___| /_/ \_\__,_|\__\___/|_| |_| |_|\__,_|\__|_|\___/|_| |_|
#=============================================================================================

# .\PowerLumber\public\Invoke-RollLog.ps1
function Invoke-RollLog
{
    <#
 .DESCRIPTION
  This function will Roll the log file if it is a new week day.
    .PARAMETER LogFile
        A valid file path is required.
    .PARAMETER Weekday
        A valid Weekday in datetime format is required.
 .EXAMPLE
        Invoke-RollLogs -LogFile "c:\temp\test.log" -Weekday Tuesday
 .NOTES
        It's pretty simple.
    #>

    [CmdletBinding()]
    [OutputType([boolean])]
    param(
        [Parameter(Mandatory = $true)][string]$Logfile,
        [Parameter(Mandatory = $true)][string]$Weekday

    )
    try
    {
        if (!(Test-Path -Path $Logfile))
        {
            Write-log -Message "#################### New Log created #####################" -Logfile $logfile -OutputStyle both
            Throw "LogFile path: $Logfile does not exist."
        }
        else
        {
            # Determine if its a new day
            if (Compare-Weekday -Weekday $Script:Weekday)
            {
                # The Day of the week has not changed.
                Return $true
            }
            else
            {
                # The day of the week has changed.
                $CurrentTime = Get-Date -Format MMddHHmm
                $OldLogName = "$currentTime.log"
                Rename-Item -Path $logfile -NewName $OldLogName -Force -Confirm:$false
                # Create a new log.
                write-log -Message "#################### New Log created #####################" -Logfile $logfile
            }
        }
    }
    catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName        
        Throw "Invoke-RollLog: $ErrorMessage $FailedItem"
    }
}
# .\PowerLumber\public\New-Log.ps1
#=============================================================================================
# ____ _ _
#| _ \ _____ _____ _ __| | _ _ _ __ ___ | |__ ___ _ __
#| |_) / _ \ \ /\ / / _ \ '__| | | | | | '_ ` _ \| '_ \ / _ \ '__|
#| __/ (_) \ V V / __/ | | |__| |_| | | | | | | |_) | __/ |
#|_| \___/ \_/\_/ \___|_| |_____\__,_|_| |_| |_|_.__/ \___|_|
#=============================================================================================
function New-Log
{
    <#
 .SYNOPSIS
  Clears logs in a directory older than the specified number of days.
 .DESCRIPTION
  Clears logs in a directory older than the specified number of days.
 .PARAMETER Logfile
  Please Specify a valid path and file name.
 .EXAMPLE
  New-Log -Logfile c:\temp\new.log
 .NOTES
  No Additional information about the function or script.
 #>

    [CmdletBinding(
        SupportsShouldProcess = $true
    )]
    param(    
        [Parameter(Mandatory = $true)]
        [string]$Logfile
    ) 
    try
    {
        if ( !(Split-Path -Path $Logfile -ErrorAction SilentlyContinue))
        {
            write-Log -Message "Creating new Directory." -OutputStyle consoleOnly
            if ($PSCmdlet.ShouldProcess("Creating new Directory")) {New-Item (Split-Path -Path $Logfile) -ItemType Directory -Force}
        }
        write-Log -Message "Creating new file." -OutputStyle consoleOnly
        if ($PSCmdlet.ShouldProcess("Creating new File")) {New-Item $logfile -type file -force -value "New file created."}
    }
    Catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName        
        Throw "New-Log: $ErrorMessage $FailedItem"        
    }
}
#=============================================================================================
# ___ _ _ _ _ _
# |_ _|_ ____ _____ | | _____ / \ _ _| |_ ___ _ __ ___ __ _| |_(_) ___ _ __
# | || '_ \ \ / / _ \| |/ / _ \_____ / _ \| | | | __/ _ \| '_ ` _ \ / _` | __| |/ _ \| '_ \
# | || | | \ V / (_) | < __/_____/ ___ \ |_| | || (_) | | | | | | (_| | |_| | (_) | | | |
# |___|_| |_|\_/ \___/|_|\_\___| /_/ \_\__,_|\__\___/|_| |_| |_|\__,_|\__|_|\___/|_| |_|
#=============================================================================================

# .\PowerLumber\public\Write-Log.ps1
#=============================================================================================
# ____ _ _
#| _ \ _____ _____ _ __| | _ _ _ __ ___ | |__ ___ _ __
#| |_) / _ \ \ /\ / / _ \ '__| | | | | | '_ ` _ \| '_ \ / _ \ '__|
#| __/ (_) \ V V / __/ | | |__| |_| | | | | | | |_) | __/ |
#|_| \___/ \_/\_/ \___|_| |_____\__,_|_| |_| |_|_.__/ \___|_|
#=============================================================================================
function Write-Log
{
    <#
 .SYNOPSIS
  Function to write log files, option to print to console.
 .DESCRIPTION
  Writes messages to log file and optional console.
 .PARAMETER Message
  Please Specify a message.
 .PARAMETER Logfile
  Please Specify a valid logfile.
 .PARAMETER OutputStyle
  Please specify an output OutputStyle.
 .EXAMPLE
  Write-Log -Message "I love lamp" -Logfile "C:\temp\mylog.log" -OutputStyle noConsole
 .EXAMPLE
  Write-Log -Message "I love lamp" -Logfile "C:\temp\mylog.log" -OutputStyle both
 .EXAMPLE
  Write-Log -Message "I love lamp" -Logfile "C:\temp\mylog.log" -OutputStyle consoleOnly
 .EXAMPLE
  Write-Log -Message "I love lamp" -Logfile "C:\temp\mylog.log"
 .EXAMPLE
  Write-Log -Message "I love lamp" -OutputStyle ConsoleOnly
 .NOTES
  No Additional information about the function or script.
 #>

    [CmdletBinding(DefaultParameterSetName = 'LogFileFalse')]
    param(
        [Parameter(Mandatory = $true, Position = 1, ParameterSetName = 'LogFileTrue')]
        [Parameter(Mandatory = $true, ParameterSetName = 'LogFileFalse')]
        [string]$Message,
        [Parameter(Mandatory = $true, ParameterSetName = 'LogFileTrue')]
        [string]$Logfile,
        [Parameter(Mandatory = $false, ParameterSetName = 'LogFileTrue')]
        [Parameter(Mandatory = $true, ParameterSetName = 'LogFileFalse')]
        [validateset('ConsoleOnly', 'Both', 'noConsole', IgnoreCase = $true)]
        [string]$OutputStyle
    )
    try
    {
        $dateNow = Get-Timestamp
        switch ($OutputStyle)
        {
            ConsoleOnly
            {
                Write-Output ""
                Write-Output "$dateNow $Message"
            }
            Both
            {
                Write-Output ""
                Write-Output "$dateNow $Message"
                if (!(Test-Path $logfile -ErrorAction SilentlyContinue))
                {
                    Write-Warning "Logfile does not exist."
                    New-Log -Logfile $Logfile
                }
                Write-Output "$dateNow $Message" | Out-File $Logfile -append -encoding ASCII                    
            }
            noConsole
            {
                Write-Output "$dateNow $Message" | Out-File $Logfile -append -encoding ASCII
            }
            default
            {
                Write-Output ""
                Write-Output "$dateNow $Message"
                if (!(Test-Path $logfile -ErrorAction SilentlyContinue))
                {
                    Write-Warning "Logfile does not exist."
                    New-Log -Logfile $Logfile
                }            
                Write-Output "$dateNow $Message" | Out-File $Logfile -append -encoding ASCII
            }
        }
    }
    Catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName        
        Throw "Write-Log: $ErrorMessage $FailedItem"        
    }
}
#=============================================================================================
# ___ _ _ _ _ _
# |_ _|_ ____ _____ | | _____ / \ _ _| |_ ___ _ __ ___ __ _| |_(_) ___ _ __
# | || '_ \ \ / / _ \| |/ / _ \_____ / _ \| | | | __/ _ \| '_ ` _ \ / _` | __| |/ _ \| '_ \
# | || | | \ V / (_) | < __/_____/ ___ \ |_| | || (_) | | | | | | (_| | |_| | (_) | | | |
# |___|_| |_|\_/ \___/|_|\_\___| /_/ \_\__,_|\__\___/|_| |_| |_|\__,_|\__|_|\___/|_| |_|
#=============================================================================================

# .\PowerLumber\public\Write-LogLevel.ps1
#=============================================================================================
# ____ _ _
#| _ \ _____ _____ _ __| | _ _ _ __ ___ | |__ ___ _ __
#| |_) / _ \ \ /\ / / _ \ '__| | | | | | '_ ` _ \| '_ \ / _ \ '__|
#| __/ (_) \ V V / __/ | | |__| |_| | | | | | | |_) | __/ |
#|_| \___/ \_/\_/ \___|_| |_____\__,_|_| |_| |_|_.__/ \___|_|
#=============================================================================================
function Write-LogLevel
{
    <#
 .SYNOPSIS
  Function to write log files, based on a set LogLevel.
 .DESCRIPTION
        Writes messages to log file based on a set LogLevel.
        -RunLogLevel is the System Wide setting.
        -MsgLevel is specific to a message.
 .PARAMETER Message
  Please Specify a message.
 .PARAMETER Logfile
  Please Specify a valid logfile.
 .PARAMETER RunLogLevel
  Please specify a Running Log Level.
 .PARAMETER MsgLevel
  Please specify a Message Log Level.
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel All -MsgLevel TRACE
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel TRACE -MsgLevel TRACE
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel DEBUG -MsgLevel DEBUG
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel INFO -MsgLevel INFO
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel WARN -MsgLevel WARN
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel ERROR -MsgLevel ERROR
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel FATAL -MsgLevel FATAL
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel CONSOLEONLY -MsgLevel CONSOLEONLY
 .EXAMPLE
  Write-LogLevel -Message "I love lamp" -Logfile "C:\temp\mylog.log" -RunLogLevel OFF -MsgLevel OFF
 .NOTES
  No Additional information about the function or script.
 #>

    [CmdletBinding()]
    param(
        [Parameter(Mandatory = $true)]
        [string]$Message,
        [Parameter(Mandatory = $true)]
        [string]$Logfile,
        [Parameter(Mandatory = $true)][ValidateSet("ALL", "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "CONSOLEONLY", "OFF")]
        [string]$RunLogLevel,
        [Parameter(Mandatory = $true)][ValidateSet("TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "CONSOLEONLY")]
        [string]$MsgLevel
    )
    try
    {
        switch ($RunLogLevel)
        {
            ALL
            {
                $OutPutStyle = "both"
            }
            TRACE
            {
                $OutPutStyle = "both"
            }
            OFF
            {
                Break                   
            }
            CONSOLEONLY
            {
                $OutPutStyle = "consoleOnly"
            }
            default
            {
                if (($RunLogLevel -eq "DEBUG") -and ($MsgLevel -ne "TRACE") -and ($MsgLevel -ne "CONSOLEONLY"))
                {
                    $OutPutStyle = "both"
                }
                elseif (($RunLogLevel -eq "INFO") -and ($MsgLevel -ne "TRACE") -and ($MsgLevel -ne "DEBUG") -and ($MsgLevel -ne "CONSOLEONLY"))
                {
                    $OutPutStyle = "both"
                }
                elseif (($RunLogLevel -eq "WARN") -and ($MsgLevel -ne "TRACE") -and ($MsgLevel -ne "DEBUG") -and ($MsgLevel -ne "INFO") -and ($MsgLevel -ne "CONSOLEONLY"))
                {
                    $OutPutStyle = "both"
                }
                elseif (($RunLogLevel -eq "ERROR") -and ($MsgLevel -ne "TRACE") -and ($MsgLevel -ne "DEBUG") -and ($MsgLevel -ne "INFO") -and ($MsgLevel -ne "WARN") -and ($MsgLevel -ne "CONSOLEONLY"))
                {
                    $OutPutStyle = "both"
                }
                elseif (($RunLogLevel -eq "FATAL") -and ($MsgLevel -ne "TRACE") -and ($MsgLevel -ne "DEBUG") -and ($MsgLevel -ne "INFO") -and ($MsgLevel -ne "WARN") -and ($MsgLevel -ne "ERROR") -and ($MsgLevel -ne "CONSOLEONLY"))
                {
                    $OutPutStyle = "both"
                }
                else
                {
                    $OutPutStyle = "consoleOnly"
                }
            }
        }
        $Message = $MsgLevel + ": " + $Message
        Write-Log -Message $Message -Logfile $Logfile -OutputStyle $OutPutStyle
    }
    Catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName        
        Throw "Write-LogLevel: $ErrorMessage $FailedItem"
    }
}
#=============================================================================================
# ___ _ _ _ _ _
# |_ _|_ ____ _____ | | _____ / \ _ _| |_ ___ _ __ ___ __ _| |_(_) ___ _ __
# | || '_ \ \ / / _ \| |/ / _ \_____ / _ \| | | | __/ _ \| '_ ` _ \ / _` | __| |/ _ \| '_ \
# | || | | \ V / (_) | < __/_____/ ___ \ |_| | || (_) | | | | | | (_| | |_| | (_) | | | |
# |___|_| |_|\_/ \___/|_|\_\___| /_/ \_\__,_|\__\___/|_| |_| |_|\__,_|\__|_|\___/|_| |_|
#=============================================================================================

Write-Verbose 'Importing from [C:\projects\powerlumber\PowerLumber\classes]'