{"id":2261,"date":"2012-04-27T10:05:56","date_gmt":"2012-04-27T14:05:56","guid":{"rendered":"http:\/\/jdhitsolutions.com\/blog\/?p=2261"},"modified":"2012-04-27T10:05:56","modified_gmt":"2012-04-27T14:05:56","slug":"friday-fun-powershell-countdown","status":"publish","type":"post","link":"https:\/\/jdhitsolutions.com\/blog\/powershell\/2261\/friday-fun-powershell-countdown\/","title":{"rendered":"Friday Fun: PowerShell Countdown"},"content":{"rendered":"

\"\"<\/a>Recently, Josh Atwell<\/a> posted a PowerShell script <\/a>that performed a countdown. Naturally, I was inspired and did the whole \"embrace and extend\" thing. Don't get me wrong: Josh's script is perfectly fine. I saw some opportunities to try some things and use it as a teaching device. If nothing else, let's have a little fun.<\/p>\n

First off, here's my version, then I'll go over a few highlights.<\/p>\n


\nFunction Start-Countdown {
\n<#\n comment based help is in the download version\n#><\/p>\n

Param(
\n[Parameter(Position=0,HelpMessage=\"Enter seconds to countdown from\")]
\n[Int]$Seconds = 10,
\n[Parameter(Position=1,Mandatory=$False,
\nHelpMessage=\"Enter a scriptblock to execute at the end of the countdown\")]
\n[scriptblock]$Scriptblock,
\n[Switch]$ProgressBar,
\n[Switch]$Clear,
\n[String]$Message = \"Blast Off!\"
\n)<\/p>\n

#save beginning value for total seconds
\n$TotalSeconds=$Seconds<\/p>\n

#get current cursor position
\n$Coordinate = New-Object System.Management.Automation.Host.Coordinates
\n$Coordinate.X=$host.ui.rawui.CursorPosition.X
\n$Coordinate.Y=$host.ui.rawui.CursorPosition.Y<\/p>\n

If ($clear) {
\n Clear-Host
\n #find the middle of the current window
\n $Coordinate.X=[int]($host.ui.rawui.WindowSize.Width\/2)
\n $Coordinate.Y=[int]($host.ui.rawui.WindowSize.Height\/2)
\n}<\/p>\n

#define the Escape key
\n$ESCKey = 27<\/p>\n

#define a variable indicating if the user aborted the countdown
\n$Abort=$False<\/p>\n

while ($seconds -ge 1) {<\/p>\n

if ($host.ui.RawUi.KeyAvailable)
\n \t\t{
\n \t\t$key = $host.ui.RawUI.ReadKey(\"NoEcho,IncludeKeyUp,IncludeKeyDown\")<\/p>\n

\t\tif ($key.VirtualKeyCode -eq $ESCkey)
\n \t\t\t{
\n #ESC was pressed so quit the countdown and set abort flag to True
\n \t\t\t$Seconds = 0
\n $Abort=$True
\n \t\t\t}
\n \t\t}<\/p>\n

If($ProgressBar){
\n #calculate percent time remaining, but in reverse so the progress bar
\n #moves from left to right
\n $percent=100 - ($seconds\/$TotalSeconds)*100
\n \tWrite-Progress -Activity \"Countdown\" -SecondsRemaining $Seconds -Status \"Time Remaining\" -PercentComplete $percent
\n \tStart-Sleep -Seconds 1
\n } Else {
\n if ($Clear) {
\n Clear-Host
\n }
\n $host.ui.rawui.CursorPosition=$Coordinate
\n #write the seconds with padded trailing spaces to overwrite any extra digits such
\n #as moving from 10 to 9
\n $pad=($TotalSeconds -as [string]).Length
\n if ($seconds -le 10) {
\n $color=\"Red\"
\n }
\n else {
\n $color=\"Green\"
\n }
\n Write-Host \"$(([string]$Seconds).Padright($pad))\" -foregroundcolor $color
\n \tStart-Sleep -Seconds 1
\n }
\n #decrement $Seconds
\n $Seconds--
\n} #while<\/p>\n

if (-Not $Abort) {
\n if ($clear) {
\n #if $Clear was used, center the message in the console
\n $Coordinate.X=$Coordinate.X - ([int]($message.Length)\/2)
\n }<\/p>\n

$host.ui.rawui.CursorPosition=$Coordinate<\/p>\n

Write-Host $Message -ForegroundColor Green
\n #run the scriptblock if specified
\n if ($scriptblock) {
\n Invoke-Command -ScriptBlock $Scriptblock
\n }
\n}
\nelse {
\n Write-Warning \"Countdown aborted\"
\n}
\n} #end function
\n<\/code><\/p>\n

The basic premise hasn't really changed. Run the function specifying the number of seconds to count down and at the end of the countdown display a message. I thought why not really do something? So I added an optional Scriptblock parameter. At the end of the countdown, it will be executed using Invoke-Command.<\/p>\n


\nif ($scriptblock) {
\n Invoke-Command -ScriptBlock $Scriptblock
\n}
\n<\/code><\/p>\n

Next, I decided to add a way to abort the countdown. If you run the function in the ISE and use the Progress bar parameter, you can click the Stop button. In the console, you could press Ctrl+C but that seemed a little heavy handed to me so I inserted code to watch for a key press, specifically the ESC key. If the key press is detected, I set a flag variable to False and the seconds to 0 to break out of the While loop.<\/p>\n


\n#define the Escape key
\n$ESCKey = 27<\/p>\n

#define a variable indicating if the user aborted the countdown
\n$Abort=$False<\/p>\n

while ($seconds -ge 1) {<\/p>\n

if ($host.ui.RawUi.KeyAvailable)
\n \t\t{
\n \t\t$key = $host.ui.RawUI.ReadKey(\"NoEcho,IncludeKeyUp,IncludeKeyDown\")<\/p>\n

\t\tif ($key.VirtualKeyCode -eq $ESCkey)
\n \t\t\t{
\n #ESC was pressed so quit the countdown and set abort flag to True
\n \t\t\t$Seconds = 0
\n $Abort=$True
\n \t\t\t}
\n \t\t}
\n...
\n<\/code><\/p>\n

After the loop I inserted commands to check if the countdown was aborted or not. If not, then I display the message and run the scriptblock, if supplied.<\/p>\n


\nif (-Not $Abort) {
\n if ($clear) {
\n #if $Clear was used, center the message in the console
\n $Coordinate.X=$Coordinate.X - ([int]($message.Length)\/2)
\n }<\/p>\n

$host.ui.rawui.CursorPosition=$Coordinate<\/p>\n

Write-Host $Message -ForegroundColor Green
\n #run the scriptblock if specified
\n if ($scriptblock) {
\n Invoke-Command -ScriptBlock $Scriptblock
\n }
\n}
\nelse {
\n Write-Warning \"Countdown aborted\"
\n}
\n<\/code><\/p>\n

I like the use of Write-Progress. I don't think it gets enough attention. I decided to add in the progress bar which is incremented based on a percentage of how much time is to go. <\/p>\n


\n$percent=100 - ($seconds\/$TotalSeconds)*100
\nWrite-Progress -Activity \"Countdown\" -SecondsRemaining $Seconds -Status \"Time Remaining\" -PercentComplete $percent
\n<\/code><\/p>\n

I'm subtracting the percent value from 100 so that the progress bar moves from left to right. It looked odd to me to move from \"Full\" to \"Empty\", although I suppose for a countdown that is more accurate. You can switch this back.<\/p>\n

My last change is how the countdown is handled in the console, if you don't use the progress bar. In Josh's version he cleared the screen and then wrote the current time, clearing the screen each time. The effect is you see the number change in the upper left corner of the console. But what if you don't want to clear the screen? Writing the number will use a new line for each value. Using Write-Host with -NoNewLine will simply append to the current line and look ugly. So I decided to have some fun with raw host data.<\/p>\n

First, I grab the coordinates of the cursor's current position using the RawUI property from $host.<\/p>\n


\n#get current cursor position
\n$Coordinate = New-Object System.Management.Automation.Host.Coordinates
\n$Coordinate.X=$host.ui.rawui.CursorPosition.X
\n$Coordinate.Y=$host.ui.rawui.CursorPosition.Y
\n<\/code><\/p>\n

I want this because I can use the coordinates to put the cursor to a specific location in the console.<\/p>\n


\n #write the seconds with padded trailing spaces to overwrite any extra digits such
\n #as moving from 10 to 9
\n $pad=($TotalSeconds -as [string]).Length
\n if ($seconds -le 10) {
\n $color=\"Red\"
\n }
\n else {
\n $color=\"Green\"
\n }
\n Write-Host \"$(([string]$Seconds).Padright($pad))\" -foregroundcolor $color
\n \tStart-Sleep -Seconds 1
\n }
\n<\/code><\/p>\n

I also added code and logic so that the number is displayed in Green using Write-Host until it reaches 10, at which point it is written to the console in red.<\/p>\n

I also use the coordinates for some fun if you use -Clear. I put the countdown timer in the center of the console window. In order to do that I had to find the dimensions of the window and divide by 2, treating each value as an [INT].<\/p>\n


\n#find the middle of the current window
\n$Coordinate.X=[int]($host.ui.rawui.WindowSize.Width\/2)
\n$Coordinate.Y=[int]($host.ui.rawui.WindowSize.Height\/2)
\n<\/code><\/p>\n

Finally, I decided to also center the message. This meant figuring out the message length and then adjusting the X coordinate.<\/p>\n


\nif ($clear) {
\n #if $Clear was used, center the message in the console
\n $Coordinate.X=$Coordinate.X - ([int]($message.Length)\/2)
\n}
\n$host.ui.rawui.CursorPosition=$Coordinate
\n<\/code><\/p>\n

Curious to see what this looks like? (the clip has no audio)<\/p>\n