ITGSerialTerminalTools.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
Function Invoke-RemoteCommand
{

    <#
    .Synopsis
        Выполняет в удалённой консоли команду и возвращает результат.
        Генерирует исключение в случае таймаута.
    .Description
        Выполняет в удалённой консоли команду Command и возвращает результат.
        Генерирует исключение в случае таймаута.
        Следует использовать для подачи команды на удалённую консоль.
        С ключом PassThru возвращает в качестве результата вывод удалённой консоли
        до строки, соответствующей PromptPattern.
    #>


    [CmdletBinding()]

    Param(
        # Шаблон строки, ожидаемой в выводе удалённой консоли
        [Parameter(
            Mandatory = $true,
            ValueFromPipeLine = $true,
            Position = 0
        )]
        [AllowEmptyString()]
        [String] $Command,

        # Шаблон строки, ожидаемой в выводе удалённой консоли
        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [string] $PromptPattern = '\[.+?\] >',

        # Читатель потока удалённой консоли
        [Parameter(
            Mandatory = $true
        )]
        [ValidateNotNull()]
        [System.IO.TextReader] $ConsoleStreamReader,

        # Писатель потока удалённой консоли
        [Parameter(
            Mandatory = $true
        )]
        [ValidateNotNull()]
        [System.IO.TextWriter] $ConsoleStreamWriter,

        # Ключ, определяющий необходимость возврата вывода удалённой консоли
        [Switch] $PassThru,

        # Таймаут
        [Parameter()]
        [System.TimeSpan] $Timeout = 0
    )

    try
    {

        $ConsoleStreamWriter.WriteLine( $Command );
        Write-Verbose ">>>> $Command";

        $EscapedCommand = [System.Text.RegularExpressions.Regex]::Escape( $Command );
        Wait-ExpectedMessage `
            -ConsoleStreamReader $ConsoleStreamReader `
            -PromptPattern "$PromptPattern\s*$EscapedCommand" `
            -Timeout $Timeout `
            -ErrorAction 'Stop';
        Wait-ExpectedMessage `
            -ConsoleStreamReader $ConsoleStreamReader `
            -PromptPattern "$PromptPattern\s*$EscapedCommand" `
            -Timeout $Timeout `
            -ErrorAction 'Stop';

        return Wait-ExpectedMessage `
            -ConsoleStreamReader $ConsoleStreamReader `
            -PromptPattern $PromptPattern `
            -PassThru:$PassThru `
            -Timeout $Timeout `
            -ErrorAction 'Stop';

    }
    catch
    {
        Write-Error -ErrorRecord $_;
    };

}


Function Wait-ExpectedMessage
{

    <#
    .Synopsis
        Ожидает появления в потоке строки, соответствующей шаблону PromptPattern.
        Генерирует исключение в случае таймаута.
    .Description
        Ожидает появления в потоке строки, соответствующей шаблону PromptPattern.
        Генерирует исключение в случае таймаута.
        Следует использовать до подачи команды на удалённую консоль, чтобы убедиться,
        что консоль готова принимать команды.
        С ключом PassThru возвращает в качестве результата вывод удалённой консоли
        до строки, соответствующей PromptPattern.
    #>


    [CmdletBinding()]

    Param(
        # Шаблон строки, ожидаемой в выводе удалённой консоли
        [Parameter(
            Position = 0
        )]
        [ValidateNotNullOrEmpty()]
        [string] $PromptPattern = '\[.+?\] >',

        # Читатель потока удалённой консоли
        [Parameter(
            Mandatory = $true
        )]
        [ValidateNotNull()]
        [System.IO.TextReader] $ConsoleStreamReader,

        # Ключ, определяющий необходимость возврата вывода удалённой консоли
        [Switch] $PassThru,

        # Таймаут
        [Parameter()]
        [System.TimeSpan] $Timeout = 0
    )

    try
    {

        $Buffer = '';
        $VerboseBuffer = '';

        $Timer = New-Object Diagnostics.StopWatch;
        if ( $Timeout -ne 0 )
        {
            $Timer.Start();
        };

        $RegExp = New-Object System.Text.RegularExpressions.Regex( $PromptPattern );

        do
        {
            $StreamData = $ConsoleStreamReader.Read();
            while ( ( $StreamData -eq -1 ) -and ( $Timer.Elapsed -le $Timeout ) )
            {
                Start-Sleep -Milliseconds 50;
                $StreamData = $ConsoleStreamReader.Read();
            };
            if ( $Timer.Elapsed -gt $Timeout )
            {
                throw ( New-Object System.TimeoutException );
            };
            switch ( [char]$StreamData )
            {
                "`r"
                {
                    if ( $VerboseBuffer )
                    {
                        Write-Verbose $VerboseBuffer;
                        $VerboseBuffer = "";
                    };
                }
                "`n"
                {
                }
                Default
                {
                    $VerboseBuffer += [char] $StreamData;
                }
            }
            $Buffer += [char] $StreamData;
            $SearchResults = $RegExp.Match( $Buffer );
        } while ( -not $SearchResults.Success );

        if ( $VerboseBuffer )
        {
            Write-Verbose $VerboseBuffer;
            $VerboseBuffer = "";
        };

        $Result = $Buffer.Substring( 0, $SearchResults.Index );
        $Buffer = $Buffer.Remove( 0, $SearchResults.Index + $SearchResults.Length );
        if ( $PassThru )
        {
            return $Result;
        };

    }
    catch
    {
        Write-Error -ErrorRecord $_;
    };

}


Export-ModuleMember -Function Invoke-RemoteCommand, Wait-ExpectedMessage