(Delphi DLL) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, StringArray, Ssh;

...

procedure TForm1.Button1Click(Sender: TObject);
var
ssh: HCkSsh;
success: Boolean;
saPrompts: HCkStringArray;
cmdOutput: PWideChar;
hostname: PWideChar;
port: Integer;
channelNum: Integer;
termType: PWideChar;
widthInChars: Integer;
heightInChars: Integer;
pixWidth: Integer;
pixHeight: Integer;
caseSensitiveMatch: Boolean;
pollTimeoutMs: Integer;
n: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

ssh := CkSsh_Create();

// For the sake of the example, pretend the remote shell prompt
// will be any of the following:
saPrompts := CkStringArray_Create();

CkStringArray_Append(saPrompts,'~$');
CkStringArray_Append(saPrompts,'mars#');
CkStringArray_Append(saPrompts,'jupiter%');
CkStringArray_Append(saPrompts,'chilkat$');
CkStringArray_Append(saPrompts,'admin>');

// Connect to an SSH server:
// Hostname may be an IP address or hostname:
hostname := 'www.some-ssh-server.com';
port := 22;

success := CkSsh_Connect(ssh,hostname,port);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Wait a max of 10 seconds when reading responses..
CkSsh_putIdleTimeoutMs(ssh,10000);

// Authenticate using login/password:
success := CkSsh_AuthenticatePw(ssh,'myLogin','myPassword');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Open a session channel.  (It is possible to have multiple
// session channels open simultaneously.)
channelNum := CkSsh_OpenSessionChannel(ssh);
if (channelNum < 0) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

termType := 'dumb';
widthInChars := 120;
heightInChars := 40;
// Use 0 for pixWidth and pixHeight when the dimensions
// are set in number-of-chars.
pixWidth := 0;
pixHeight := 0;
success := CkSsh_SendReqPty(ssh,channelNum,termType,widthInChars,heightInChars,pixWidth,pixHeight);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Start a shell on the channel:
success := CkSsh_SendReqShell(ssh,channelNum);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  Run the 1st command in the remote shell, which will be to
//  "cd" to a subdirectory.
success := CkSsh_ChannelSendString(ssh,channelNum,'cd workspace' + #10,'utf-8');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Retrieve the output to the next prompt:
caseSensitiveMatch := True;
success := CkSsh_ChannelReceiveUntilMatchN(ssh,channelNum,saPrompts,'utf-8',caseSensitiveMatch);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  Display what we've received so far.  This clears
//  the internal receive buffer, which is important.
//  After we send the command, we'll be reading until
//  the next command prompt.  If the command prompt
//  is already in the internal receive buffer, it'll think it's
//  already finished...
cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'utf-8');
if (CkSsh_getLastMethodSuccess(ssh) <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;
Memo1.Lines.Add(cmdOutput);

//  Run the 2nd command in the remote shell, which will be
//  to "ls" the directory.
success := CkSsh_ChannelSendString(ssh,channelNum,'ls' + #10,'utf-8');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Retrieve and display the output.
success := CkSsh_ChannelReceiveUntilMatchN(ssh,channelNum,saPrompts,'utf-8',caseSensitiveMatch);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'utf-8');
if (CkSsh_getLastMethodSuccess(ssh) <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;
Memo1.Lines.Add(cmdOutput);

//  Start the final command in the remote shell.  This example
//  will send a "ls -l" command to retrieve the long format directory listing.
success := CkSsh_ChannelSendString(ssh,channelNum,'ls -l' + #10,'utf-8');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Send an EOF.  This tells the server that no more data will 
// be sent on this channel.  The channel remains open, and
// the SSH client may still receive output on this channel.
success := CkSsh_ChannelSendEof(ssh,channelNum);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Read whatever output may already be available on the
// SSH connection.  ChannelReadAndPoll returns the number of bytes
// that are available in the channel's internal buffer that
// are ready to be "picked up" by calling GetReceivedText
// or GetReceivedData.
// A return value of -1 indicates failure.
// A return value of -2 indicates a failure via timeout.

// The ChannelReadAndPoll method waits
// for data to arrive on the connection usingi the IdleTimeoutMs
// property setting.  Once the first data arrives, it continues
// reading but instead uses the pollTimeoutMs passed in the 2nd argument:
// A return value of -2 indicates a timeout where no data is received.
pollTimeoutMs := 2000;
n := CkSsh_ChannelReadAndPoll(ssh,channelNum,pollTimeoutMs);
if (n < 0) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Close the channel:
success := CkSsh_ChannelSendClose(ssh,channelNum);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Perhaps we did not receive all of the commands output.
// To make sure,  call ChannelReceiveToClose to accumulate any remaining
// output until the server's corresponding "channel close" is received.
success := CkSsh_ChannelReceiveToClose(ssh,channelNum);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'utf-8');
if (CkSsh_getLastMethodSuccess(ssh) <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;
Memo1.Lines.Add(cmdOutput);

// Disconnect
CkSsh_Disconnect(ssh);

CkSsh_Dispose(ssh);
CkStringArray_Dispose(saPrompts);

end;