(Objective-C) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoSsh.h>
#import <CkoStringArray.h>
#import <NSString.h>

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

CkoSsh *ssh = [[CkoSsh alloc] init];
BOOL success;

// For the sake of the example, pretend the remote shell prompt
// will be any of the following:
CkoStringArray *saPrompts = [[CkoStringArray alloc] init];

[saPrompts Append: @"~$"];
[saPrompts Append: @"mars#"];
[saPrompts Append: @"jupiter%"];
[saPrompts Append: @"chilkat$"];
[saPrompts Append: @"admin>"];

NSString *cmdOutput = 0;

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

success = [ssh Connect: hostname port: [NSNumber numberWithInt: port]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Wait a max of 10 seconds when reading responses..
ssh.IdleTimeoutMs = [NSNumber numberWithInt:10000];

// Authenticate using login/password:
success = [ssh AuthenticatePw: @"myLogin" password: @"myPassword"];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Open a session channel.  (It is possible to have multiple
// session channels open simultaneously.)
int channelNum = [[ssh OpenSessionChannel] intValue];
if (channelNum < 0) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

NSString *termType = @"dumb";
int widthInChars = 120;
int heightInChars = 40;
// Use 0 for pixWidth and pixHeight when the dimensions
// are set in number-of-chars.
int pixWidth = 0;
int pixHeight = 0;
success = [ssh SendReqPty: [NSNumber numberWithInt: channelNum] xTermEnvVar: termType widthInChars: [NSNumber numberWithInt: widthInChars] heightInRows: [NSNumber numberWithInt: heightInChars] pixWidth: [NSNumber numberWithInt: pixWidth] pixHeight: [NSNumber numberWithInt: pixHeight]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Start a shell on the channel:
success = [ssh SendReqShell: [NSNumber numberWithInt: channelNum]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

//  Run the 1st command in the remote shell, which will be to
//  "cd" to a subdirectory.
success = [ssh ChannelSendString: [NSNumber numberWithInt: channelNum] strData: @"cd workspace\n" charset: @"utf-8"];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Retrieve the output to the next prompt:
BOOL caseSensitiveMatch = YES;
success = [ssh ChannelReceiveUntilMatchN: [NSNumber numberWithInt: channelNum] matchPatterns: saPrompts charset: @"utf-8" caseSensitive: caseSensitiveMatch];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

//  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 = [ssh GetReceivedText: [NSNumber numberWithInt: channelNum] charset: @"utf-8"];
if (ssh.LastMethodSuccess != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

NSLog(@"%@",cmdOutput);

//  Run the 2nd command in the remote shell, which will be
//  to "ls" the directory.
success = [ssh ChannelSendString: [NSNumber numberWithInt: channelNum] strData: @"ls\n" charset: @"utf-8"];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Retrieve and display the output.
success = [ssh ChannelReceiveUntilMatchN: [NSNumber numberWithInt: channelNum] matchPatterns: saPrompts charset: @"utf-8" caseSensitive: caseSensitiveMatch];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

cmdOutput = [ssh GetReceivedText: [NSNumber numberWithInt: channelNum] charset: @"utf-8"];
if (ssh.LastMethodSuccess != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

NSLog(@"%@",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 = [ssh ChannelSendString: [NSNumber numberWithInt: channelNum] strData: @"ls -l\n" charset: @"utf-8"];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// 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 = [ssh ChannelSendEof: [NSNumber numberWithInt: channelNum]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// 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.
int pollTimeoutMs = 2000;
int n = [[ssh ChannelReadAndPoll: [NSNumber numberWithInt: channelNum] pollTimeoutMs: [NSNumber numberWithInt: pollTimeoutMs]] intValue];
if (n < 0) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Close the channel:
success = [ssh ChannelSendClose: [NSNumber numberWithInt: channelNum]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// 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 = [ssh ChannelReceiveToClose: [NSNumber numberWithInt: channelNum]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

cmdOutput = [ssh GetReceivedText: [NSNumber numberWithInt: channelNum] charset: @"utf-8"];
if (ssh.LastMethodSuccess != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

NSLog(@"%@",cmdOutput);

// Disconnect
[ssh Disconnect];