(Lianja) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loSsh = createobject("CkSsh")

// For the sake of the example, pretend the remote shell prompt
// will be any of the following:
loSaPrompts = createobject("CkStringArray")

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

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

llSuccess = loSsh.Connect(lcHostname,lnPort)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

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

// Authenticate using login/password:
llSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// Open a session channel.  (It is possible to have multiple
// session channels open simultaneously.)
lnChannelNum = loSsh.OpenSessionChannel()
if (lnChannelNum < 0) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

lcTermType = "dumb"
lnWidthInChars = 120
lnHeightInChars = 40
// Use 0 for pixWidth and pixHeight when the dimensions
// are set in number-of-chars.
lnPixWidth = 0
lnPixHeight = 0
llSuccess = loSsh.SendReqPty(lnChannelNum,lcTermType,lnWidthInChars,lnHeightInChars,lnPixWidth,lnPixHeight)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// Start a shell on the channel:
llSuccess = loSsh.SendReqShell(lnChannelNum)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

//  Run the 1st command in the remote shell, which will be to
//  "cd" to a subdirectory.
llSuccess = loSsh.ChannelSendString(lnChannelNum,"cd workspace" + Chr(10),"utf-8")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// Retrieve the output to the next prompt:
llCaseSensitiveMatch = .T.
llSuccess = loSsh.ChannelReceiveUntilMatchN(lnChannelNum,loSaPrompts,"utf-8",llCaseSensitiveMatch)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

//  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...
lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
if (loSsh.LastMethodSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

? lcCmdOutput

//  Run the 2nd command in the remote shell, which will be
//  to "ls" the directory.
llSuccess = loSsh.ChannelSendString(lnChannelNum,"ls" + Chr(10),"utf-8")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// Retrieve and display the output.
llSuccess = loSsh.ChannelReceiveUntilMatchN(lnChannelNum,loSaPrompts,"utf-8",llCaseSensitiveMatch)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
if (loSsh.LastMethodSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

? lcCmdOutput

//  Start the final command in the remote shell.  This example
//  will send a "ls -l" command to retrieve the long format directory listing.
llSuccess = loSsh.ChannelSendString(lnChannelNum,"ls -l" + Chr(10),"utf-8")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// 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.
llSuccess = loSsh.ChannelSendEof(lnChannelNum)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// 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.
lnPollTimeoutMs = 2000
n = loSsh.ChannelReadAndPoll(lnChannelNum,lnPollTimeoutMs)
if (n < 0) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// Close the channel:
llSuccess = loSsh.ChannelSendClose(lnChannelNum)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

// 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.
llSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
if (loSsh.LastMethodSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSaPrompts
    return
endif

? lcCmdOutput

// Disconnect
loSsh.Disconnect()


release loSsh
release loSaPrompts