(PowerBuilder) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Ssh
integer li_Success
oleobject loo_SaPrompts
string ls_CmdOutput
string ls_Hostname
integer li_Port
integer li_ChannelNum
string ls_TermType
integer li_WidthInChars
integer li_HeightInChars
integer li_PixWidth
integer li_PixHeight
integer li_CaseSensitiveMatch
integer li_PollTimeoutMs
integer n

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

loo_Ssh = create oleobject
// Use "Chilkat_9_5_0.Ssh" for versions of Chilkat < 10.0.0
li_rc = loo_Ssh.ConnectToNewObject("Chilkat.Ssh")
if li_rc < 0 then
    destroy loo_Ssh
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// For the sake of the example, pretend the remote shell prompt
// will be any of the following:
loo_SaPrompts = create oleobject
// Use "Chilkat_9_5_0.StringArray" for versions of Chilkat < 10.0.0
li_rc = loo_SaPrompts.ConnectToNewObject("Chilkat.StringArray")

loo_SaPrompts.Append("~~$")
loo_SaPrompts.Append("mars#")
loo_SaPrompts.Append("jupiter%")
loo_SaPrompts.Append("chilkat$")
loo_SaPrompts.Append("admin>")

// Connect to an SSH server:
// Hostname may be an IP address or hostname:
ls_Hostname = "www.some-ssh-server.com"
li_Port = 22

li_Success = loo_Ssh.Connect(ls_Hostname,li_Port)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// Wait a max of 10 seconds when reading responses..
loo_Ssh.IdleTimeoutMs = 10000

// Authenticate using login/password:
li_Success = loo_Ssh.AuthenticatePw("myLogin","myPassword")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// Open a session channel.  (It is possible to have multiple
// session channels open simultaneously.)
li_ChannelNum = loo_Ssh.OpenSessionChannel()
if li_ChannelNum < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

ls_TermType = "dumb"
li_WidthInChars = 120
li_HeightInChars = 40
// Use 0 for pixWidth and pixHeight when the dimensions
// are set in number-of-chars.
li_PixWidth = 0
li_PixHeight = 0
li_Success = loo_Ssh.SendReqPty(li_ChannelNum,ls_TermType,li_WidthInChars,li_HeightInChars,li_PixWidth,li_PixHeight)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// Start a shell on the channel:
li_Success = loo_Ssh.SendReqShell(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

//  Run the 1st command in the remote shell, which will be to
//  "cd" to a subdirectory.
li_Success = loo_Ssh.ChannelSendString(li_ChannelNum,"cd workspace~n","utf-8")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// Retrieve the output to the next prompt:
li_CaseSensitiveMatch = 1
li_Success = loo_Ssh.ChannelReceiveUntilMatchN(li_ChannelNum,loo_SaPrompts,"utf-8",li_CaseSensitiveMatch)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

//  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...
ls_CmdOutput = loo_Ssh.GetReceivedText(li_ChannelNum,"utf-8")
if loo_Ssh.LastMethodSuccess <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

Write-Debug ls_CmdOutput

//  Run the 2nd command in the remote shell, which will be
//  to "ls" the directory.
li_Success = loo_Ssh.ChannelSendString(li_ChannelNum,"ls~n","utf-8")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// Retrieve and display the output.
li_Success = loo_Ssh.ChannelReceiveUntilMatchN(li_ChannelNum,loo_SaPrompts,"utf-8",li_CaseSensitiveMatch)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

ls_CmdOutput = loo_Ssh.GetReceivedText(li_ChannelNum,"utf-8")
if loo_Ssh.LastMethodSuccess <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

Write-Debug ls_CmdOutput

//  Start the final command in the remote shell.  This example
//  will send a "ls -l" command to retrieve the long format directory listing.
li_Success = loo_Ssh.ChannelSendString(li_ChannelNum,"ls -l~n","utf-8")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// 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.
li_Success = loo_Ssh.ChannelSendEof(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// 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.
li_PollTimeoutMs = 2000
n = loo_Ssh.ChannelReadAndPoll(li_ChannelNum,li_PollTimeoutMs)
if n < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// Close the channel:
li_Success = loo_Ssh.ChannelSendClose(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

// 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.
li_Success = loo_Ssh.ChannelReceiveToClose(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

ls_CmdOutput = loo_Ssh.GetReceivedText(li_ChannelNum,"utf-8")
if loo_Ssh.LastMethodSuccess <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SaPrompts
    return
end if

Write-Debug ls_CmdOutput

// Disconnect
loo_Ssh.Disconnect()


destroy loo_Ssh
destroy loo_SaPrompts