cmdlets/CommonUtils/CommonUtils.ps1

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
#01.2018©willynilly

#----------------------------------------------------------------------------------------
# Получает согласие пользователя на продолжение
function Get-Permission {
<#
    .Synopsis
        Получить разрешение от пользователя.
    .Description
        Задает вопрос пользователю и ожидает ответа Да/Нет клавишами Enter/Esc.
    .Parameter TextQuestion
        Текст однозначного вопроса (без знака вопроса) на который можно ответить Да/Нет.
        По умолчанию: "Продолжить?"
        Псевдонимы: t, q
    .Example
        if (Get-Permision "Очистить экран") {Clear-Host}
#>

    [CmdletBinding()]
    param(
        [Alias("t", "q", "Question")][string]$TextQuestion="Продолжить" # текст вопроса
    )
    # в ISE есть глобальная переменная psISE, а в VS Code есть psEditor
    # в ISE параметр $host.ui.RawUi.KeyAvailable равен NULL
    $ispsISE = (Test-path variable:psISE)
    $ispsEditor = (Test-path variable:psEditor)
    $isNullKeyAvailable = ($host.ui.RawUi.KeyAvailable -eq $null)
    Write-Verbose "psISE = $ispsISE"
    Write-Verbose "psEditor = $ispsEditor"
    Write-Verbose "isNullKeyAvailable = $isNullKeyAvailable"
    Write-Verbose ('host.ui.RawUi.KeyAvailable = {0}' -f $host.ui.RawUi.KeyAvailable)
    $Result = $true
    Write-Host ("`n{0}? (Enter\Esc)" -f $TextQuestion) -ForegroundColor White
    while($True)
    {
        try {
            $Key = $host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown") # !!!НЕ РАБОТАЕТ в ISE и VS CODE!!!
            if ($key.VirtualKeyCode -eq 27) {$Result = $false; Break} # нажали Esc - выходим из скрипта
            if ($key.VirtualKeyCode -eq 13) {Break} # нажали Enter - выходим из цикла и идем удалять
        }
        catch {
            $InputUser = Read-Host ('Да <Enter>\Нет <любой символ>')
            if($InputUser.Length -gt 0) {$Result = $false}
            Break
        }
    }
    if (-not $Result){Write-Host "Отказ" -ForegroundColor Red}
    $Result
        
}# end Get-Permission

#----------------------------------------------------------------------------------------
# проверяет параметр скрипта WaitPressAnyKey и ждет нажатия любой клавиши если надо
function Wait-PressAnyKey {
<#
    .Synopsis
        Ждет нажатия любой клавиши.
    .Description
        Выводит сообщение "Для выхода нажмите любую клавишу..." и ждет.
    .Example
        if ($Wait) {Wait-PressAnyKey}
#>

    [CmdletBinding()]
    param()
    # в ISE есть глобальная переменная psISE, а в VS Code есть psEditor
    # в ISE параметр $host.ui.RawUi.KeyAvailable равен NULL
    $ispsISE = (Test-path variable:psISE)
    $ispsEditor = (Test-path variable:psEditor)
    $isNullKeyAvailable = ($host.ui.RawUi.KeyAvailable -eq $null)
    Write-Verbose "psISE = $ispsISE"
    Write-Verbose "psEditor = $ispsEditor"
    Write-Verbose "isNullKeyAvailable = $isNullKeyAvailable"
    Write-Verbose ('host.ui.RawUi.KeyAvailable = {0}' -f $host.ui.RawUi.KeyAvailable)
    if (-not($ispsISE -or $ispsEditor -or $isNullKeyAvailable))
    {
        #Остановка скрипта БЕЗ возможности отмены !!!НЕ РАБОТАЕТ В ISE и VS Code!!!
        Write-host "`nДля выхода нажмите любую клавишу..." -ForegroundColor White
        $host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown,AllowCtrlC") | Out-Null
    }
}# end Wait-PressAnyKey

#----------------------------------------------------------------------------------------
# получает кодировку файла
function Get-Encoding {
<#
    .Synopsis
        Получает кодировку текстового файла.
    .Description
        Определяет кодировку переданного текстового файла.
    .Parameter filePath
        Полный путь к текстовому файлу.
    .Outputs
        [System.Text.Encoding]
    .Example
        Get-Encoding C:\Names.txt
#>

    [CmdletBinding()]
    param(
        [Parameter(Mandatory=$True)][string]$filePath
    )
    Try {
        $sr = New-Object System.IO.StreamReader($filePath, $true)
        [char[]] $buffer = new-object char[] 3
        $sr.Read($buffer, 0, 3) | Out-Null # задавим вывод, иначе попадет в результат функции
        $encoding = $sr.CurrentEncoding
        $sr.Close()
    } catch {
        #ничего делать не надо
    }
    #вернем полученную кодировку
    $encoding

}# end Get-Encoding

#----------------------------------------------------------------------------------------
#Открывает диалог выбора файла
function Select-FileDialog {
<#
    .Synopsis
        Выбор файла в диалоговом окне.
    .Description
        Открывает стандартное диалоговое окно выбора файла и возвращает полный путь выбранного файла.
    .Parameter Title
        Заголовок окна выбора файла.
    .Parameter Directory
        Начальный каталог выбора файла.
    .Parameter Filter
        Фильтр расширений файлов. По умолчанию все файлы.
    .Outputs
        [System.String]
    .Example
        $FileConfig = Select-FileDialog "Укажите файл настроек" "C:\Settings" "Файлы настроек (*.cfg)|*.cfg|Все файлы (*.*)|*.*"
#>

    param(
        [string]$Title,
        [string]$Directory,
        [string]$Filter="Все файлы (*.*)|*.*"
    )

    [System.Reflection.Assembly]::LoadWithPartialName("System.Windows.Forms") | Out-Null
    $objForm = New-Object System.Windows.Forms.OpenFileDialog
    $objForm.InitialDirectory = $Directory
    $objForm.Filter = $Filter
    $objForm.Title = $Title
    $objForm.ShowDialog() | Out-Null
    $objForm.FileName
}

#----------------------------------------------------------------------------------------
# Конвертирует PSObject полученный после Convert-FromJSON в обычный Hastable
function Convert-PSObjectToHashtable
{
    <#
        .Synopsis
            Конвертирует PSObject в Hashtable.
        .Description
            Рекурсивно конвертирует PSObject полученный после Convert-FromJSON в полноценный Hashtable.
        .Parameter InputObject
            Входной объект (может быть передан по конвейеру).
        .Outputs
            [System.Hastable]
        .Example
            $Config = Get-Content C:\Config.json | ConvertFrom-Json | Convert-PSObjectToHashtable
    #>

    param (
        [Parameter(ValueFromPipeline)]
        $InputObject
    )

    process
    {
        if ($null -eq $InputObject) { return $null }

        if ($InputObject -is [System.Collections.IEnumerable] -and $InputObject -isnot [string]) {
            $collection = @(
                foreach ($object in $InputObject) { Convert-PSObjectToHashtable $object }
            )
            Write-Output -NoEnumerate $collection
        }
        elseif ($InputObject -is [psobject]) {
            $hash = @{}
            foreach ($property in $InputObject.PSObject.Properties) {
                $hash[$property.Name] = Convert-PSObjectToHashtable $property.Value
            }
            $hash
        }
        else {
            $InputObject
        }
    }
}# end Convert-PSObjectToHashtable

#----------------------------------------------------------------------------------------
# Выполняет перекодировку строки
function ConvertTo-Encoding ([string]$From, [string]$To)
{
    Begin
    {
        $encFrom = [System.Text.Encoding]::GetEncoding($from)
        $encTo = [System.Text.Encoding]::GetEncoding($to)
    }
    Process
    {
        $bytes = $encTo.GetBytes($_)
        $bytes = [System.Text.Encoding]::Convert($encFrom, $encTo, $bytes)
        $encTo.GetString($bytes)
    }
}# end ConvertTo-Encoding

#----------------------------------------------------------------------------------------
# Выводит результат теста
function Write-Test($Name, $Result, $Count=25, $Sym='.'){

    $Test = $Name.PadRight($Count, $Sym)
    if ($Result -is [bool]){
        if ($Result) {
            Write-Host ($Test + "Ok")
        } else {
            Write-Host ($Test + "No") -ForegroundColor DarkYellow
        }
    } else {
        Write-Host ($Test + $Result)
    }
}# end Write-Test