Захват экрана с цветовой разметкой в HTML и RTF

  • Article

В предыдущем сообщении мы показали, как использовать API хоста консоли для захвата содержимого буфера экрана в текстовом виде. А что, если нам потребуются цвета? Не будет ли здорово опубликовать цветную копию консоли в HTML или вставить ее в документ Microsoft Word? Для этого нам надо внести некоторые изменения в оригинальный сценарий. Цвет каждого символа является свойством объекта System.Management.Automation.Host.BufferCell:

 PS E:\MyScripts> $bufferWidth = $host.ui.rawui.BufferSize.Width                                                         
PS E:\MyScripts> $bufferHeight = $host.ui.rawui.CursorPosition.Y                                                        
PS E:\MyScripts> $rec = new-object System.Management.Automation.Host.Rectangle 0,0,($bufferWidth - 1),$bufferHeight     
PS E:\MyScripts> $buffer = $host.ui.rawui.GetBufferContents($rec)                                                       
PS E:\MyScripts> $buffer[1,1]                                                                                           
                                                                                                                        
                    Character               ForegroundColor               BackgroundColor                BufferCellType 
                    ---------               ---------------               ---------------                -------------- 
                            o                    DarkYellow                   DarkMagenta                      Complete 
                                                                                                                        
                                                                                                                        
PS E:\MyScripts>

 

Все, что нам надо сделать – это производить итерации по массиву буфера экрана, отслеживая цвет ячеек, и генерировать последовательности HTML или блоки RTF с разными атрибутами цвета, когда цвета меняются.

Почему реализованы оба формата? Хотя HTML достаточно для Web-приложений, мы получим плохие результаты, если попытаемся использовать его в приложениях для обработки текстов. MS Word разбирает и отображает RTF гораздо лучше, чем HTML. Редактор сообщений электронной почты в Microsoft Outlook также дает лучшие результаты в RTF. Реализуя захват консоли в обоих форматах мы покрываем гораздо более широкий диапазон задач.

Использовать этот сценарий довольно легко. Следующий пример демонстрирует, как просто протестировать оба сценария:

 Windows PowerShell V2 (Community Technology Preview - Features Subject to Change)                                       
Copyright (C) 2008 Microsoft Corporation. All rights reserved.                                                          
                                                                                                                        
PS C:\Users\Vladimir> cd E:\MyScripts                                                                                   
PS E:\MyScripts> $htmlFileName = "$env:temp\ConsoleBuffer.html"                                                         
PS E:\MyScripts> .\Get-ConsoleAsHtml | out-file $htmlFileName -encoding UTF8                                            
PS E:\MyScripts> $null = [System.Diagnostics.Process]::Start("$htmlFileName")                                           
PS E:\MyScripts>                                                                                                        
PS E:\MyScripts>                                                                                                        
PS E:\MyScripts> $rtfFileName = "$env:temp\test.rtf"                                                                    
PS E:\MyScripts> .\Get-ConsoleAsRTF | out-file $rtfFileName -encoding ascii                                             
PS E:\MyScripts> $null = [System.Diagnostics.Process]::Start("$rtfFileName")                                            
PS E:\MyScripts>

Нет необходимости говорить, что сценарии можно дополнительно модифицировать, включив в них настраиваемые параметры, такие как имя и размер шрифта. Основной целью данного примера было продемонстрировать базовые техники автоматической генерации простых документов HTML и RTF.

 

Надеюсь, это будет вам полезно,
Владимир Аверкин (Vladimir Averkin)
Windows PowerShell Team 

############################################################################################################
# Get-ConsoleAsHtml.ps1
#
# The script captures console screen buffer up to the current cursor position and returns it in HTML format.
#
# Returns: UTF8-encoded string.
#
# Example:
#
# $htmlFileName = "$env:temp\ConsoleBuffer.html"
# .\Get-ConsoleAsHtml | out-file $htmlFileName -encoding UTF8
# $null = [System.Diagnostics.Process]::Start("$htmlFileName")
#

# Check the host name and exit if the host is not the Windows PowerShell console host.
if ($host.Name -ne 'ConsoleHost')
{
  write-host -ForegroundColor Red "This script runs only in the console host. You cannot run this script in $($host.Name)."
  exit -1
}

# The Windows PowerShell console host redefines DarkYellow and DarkMagenta colors and uses them as defaults.
# The redefined colors do not correspond to the color names used in HTML, so they need to be mapped to digital color codes.
#
function Normalize-HtmlColor ($color)
{
  if ($color -eq "DarkYellow") { $color = "#eeedf0" }
  if ($color -eq "DarkMagenta") { $color = "#012456" }
  return $color
}

# Create an HTML span from text using the named console colors.
#
function Make-HtmlSpan ($text, $forecolor = "DarkYellow", $backcolor = "DarkMagenta")
{
  $forecolor = Normalize-HtmlColor $forecolor
  $backcolor = Normalize-HtmlColor $backcolor

  # You can also add font-weight:bold tag here if you want a bold font in output.
  return "<span style='font-family:Courier New;color:$forecolor;background:$backcolor'>$text</span>"
}

# Generate an HTML span and append it to HTML string builder
#
function Append-HtmlSpan
{
  $spanText = $spanBuilder.ToString()
  $spanHtml = Make-HtmlSpan $spanText $currentForegroundColor $currentBackgroundColor
  $null = $htmlBuilder.Append($spanHtml)
}

# Append line break to HTML builder
#
function Append-HtmlBreak
{
  $null = $htmlBuilder.Append("<br>")
}

# Initialize the HTML string builder.
$htmlBuilder = new-object system.text.stringbuilder
$null = $htmlBuilder.Append("<pre style='MARGIN: 0in 10pt 0in;line-height:normal';font-size:10pt>")

# Grab the console screen buffer contents using the Host console API.
$bufferWidth = $host.ui.rawui.BufferSize.Width
$bufferHeight = $host.ui.rawui.CursorPosition.Y
$rec = new-object System.Management.Automation.Host.Rectangle 0,0,($bufferWidth - 1),$bufferHeight
$buffer = $host.ui.rawui.GetBufferContents($rec)

# Iterate through the lines in the console buffer.
for($i = 0; $i -lt $bufferHeight; $i++)
{
  $spanBuilder = new-object system.text.stringbuilder

  # Track the colors to identify spans of text with the same formatting.
  $currentForegroundColor = $buffer[$i, 0].Foregroundcolor
  $currentBackgroundColor = $buffer[$i, 0].Backgroundcolor

  for($j = 0; $j -lt $bufferWidth; $j++)
  {
    $cell = $buffer[$i,$j]

    # If the colors change, generate an HTML span and append it to the HTML string builder.
    if (($cell.ForegroundColor -ne $currentForegroundColor) -or ($cell.BackgroundColor -ne $currentBackgroundColor))
    {
      Append-HtmlSpan

      # Reset the span builder and colors.
      $spanBuilder = new-object system.text.stringbuilder
      $currentForegroundColor = $cell.Foregroundcolor
      $currentBackgroundColor = $cell.Backgroundcolor
    }

    # Substitute characters which have special meaning in HTML.
    switch ($cell.Character)
    {
      '>' { $htmlChar = '&gt;' }
      '<' { $htmlChar = '&lt;' }
      '&' { $htmlChar = '&amp;' }
      default
      {
        $htmlChar = $cell.Character
      }
    }

    $null = $spanBuilder.Append($htmlChar)
  }

  Append-HtmlSpan
  Append-HtmlBreak
}

# Append HTML ending tag.
$null = $htmlBuilder.Append("</pre>")

return $htmlBuilder.ToString()

###########################################################################################################
# Get-ConsoleAsRtf.ps1
#
# The script captures console screen buffer up to the current cursor position and returns it in RTF format.
#
# Returns: ASCII-encoded string.
#
# Example:
#
# $rtfFileName = "$env:temp\ConsoleBuffer.rtf"
# .\Get-ConsoleAsRtf | out-file $rtfFileName -encoding ascii
# $null = [System.Diagnostics.Process]::Start("$rtfFileName")
#

# Check the host name and exit if the host is not the Windows PowerShell console host.
if ($host.Name -ne 'ConsoleHost')
{
write-host -ForegroundColor Red "This script runs only in the console host. You cannot run this script in $($host.Name)."
exit -1
}

# Maps console color name to RTF color index.
# The index of \cf is referencing the color definition in RTF color table.
#
function Get-RtfColorIndex ([string]$color)
{
switch ($color)
{
'Black' { $index = 17 }
'DarkBlue' { $index = 2 }
'DarkGreen' { $index = 3 }
'DarkCyan' { $index = 4 }
'DarkRed' { $index = 5 }
'DarkMagenta' { $index = 6 }
'DarkYellow' { $index = 7 }
'Gray' { $index = 8 }
'DarkGray' { $index = 9 }
'Blue' { $index = 10 }
'Green' { $index = 11 }
'Cyan' { $index = 12 }
'Red' { $index = 13 }
'Magenta' { $index = 14 }
'Yellow' { $index = 15 }
'White' { $index = 16 }
default
{
$index = 0
}
}
return $index
}

# Create RTF block from text using named console colors.
#
function Append-RtfBlock ($text)
{
$foreColorIndex = Get-RtfColorIndex $currentForegroundColor
$null = $rtfBuilder.Append("{\cf$foreColorIndex")

# You can also add \ab* tag here if you want a bold font in the output.

$backColorIndex = Get-RtfColorIndex $currentBackgroundColor
$null = $rtfBuilder.Append("\chshdng0\chcbpat$backColorIndex")

$text = $blockBuilder.ToString()
$null = $rtfBuilder.Append(" $text}")
}

# Append line break to RTF builder
#
function Append-Break
{
$backColorIndex = Get-RtfColorIndex $currentBackgroundColor
$null = $rtfBuilder.Append("\shading0\cbpat$backColorIndex\par`r`n")
}

# Initialize the RTF string builder.
$rtfBuilder = new-object system.text.stringbuilder

# Set the desired font
$fontName = 'Lucida Console'
# Append RTF header
$null = $rtfBuilder.Append("{\rtf1\fbidis\ansi\ansicpg1252\deff0\deflang1033{\fonttbl{\f0\fnil\fcharset0 $fontName;}}")
$null = $rtfBuilder.Append("`r`n")
# Append RTF color table which will contain all Powershell console colors.
$null = $rtfBuilder.Append('{\colortbl;red0\green0\blue128;\red0\green128\blue0;\red0\green128\blue128;\red128\green0\blue0;\red1\green36\blue86;\red238\green237\blue240;\red192\green192\blue192;\red128\green128\blue128;\red0\green0\blue255;\red0\green255\blue0;\red0\green255\blue255;\red255\green0\blue0;\red255\green0\blue255;\red255\green255\blue0;\red255\green255\blue255;\red0\green0\blue0;}')
$null = $rtfBuilder.Append("`r`n")
# Append RTF document settings.
$null = $rtfBuilder.Append('\viewkind4\uc1\pard\ltrpar\f0\fs23 ')

# Grab the console screen buffer contents using the Host console API.
$bufferWidth = $host.ui.rawui.BufferSize.Width
$bufferHeight = $host.ui.rawui.CursorPosition.Y
$rec = new-object System.Management.Automation.Host.Rectangle 0,0,($bufferWidth - 1),$bufferHeight
$buffer = $host.ui.rawui.GetBufferContents($rec)

# Iterate through the lines in the console buffer.
for($i = 0; $i -lt $bufferHeight; $i++)
{
$blockBuilder = new-object system.text.stringbuilder

# Track the colors to identify spans of text with the same formatting.
$currentForegroundColor = $buffer[$i, 0].Foregroundcolor
$currentBackgroundColor = $buffer[$i, 0].Backgroundcolor

for($j = 0; $j -lt $bufferWidth; $j++)
{
$cell = $buffer[$i,$j]

# If the colors change, generate an RTF span and append it to the RTF string builder.
if (($cell.ForegroundColor -ne $currentForegroundColor) -or ($cell.BackgroundColor -ne $currentBackgroundColor))
{
Append-RtfBlock

# Reset the block builder and colors.
$blockBuilder = new-object system.text.stringbuilder
$currentForegroundColor = $cell.Foregroundcolor
$currentBackgroundColor = $cell.Backgroundcolor
}

# Substitute characters which have special meaning in RTF.
switch ($cell.Character)
{
"`t" { $rtfChar = '\tab' }
'\' { $rtfChar = '\\' }
'{' { $rtfChar = '\{' }
'}' { $rtfChar = '\}' }
default
{
$rtfChar = $cell.Character
}
}

$null = $blockBuilder.Append($rtfChar)
}

Append-RtfBlock
Append-Break
}

# Append RTF ending brace.
$null = $rtfBuilder.Append('}')

return $rtfBuilder.ToString()

Перевод: Виктор Горбунков