arq_restore/cocoastack/io/BufferedInputStream.m

/*
 Copyright (c) 2009-2017, Haystack Software LLC https://www.arqbackup.com
 
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 
 * Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 
 * Neither the names of PhotoMinds LLC or Haystack Software, nor the names of
 their contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */



#import "BufferedInputStream.h"
#import "InputStream.h"

#import "InputStreams.h"


#define MY_BUF_SIZE (4096)

@implementation BufferedInputStream
+ (NSString *)errorDomain {
    return @"BufferedInputStreamErrorDomain";
}
- (id)initWithUnderlyingStream:(id <InputStream>)theUnderlyingStream {
    if (self = [super init]) {
        underlyingStream = [theUnderlyingStream retain];
        buf = (unsigned char *)malloc(MY_BUF_SIZE);
        pos = 0;
        len = 0;
    }
    return self;
}
- (void)dealloc {
    [underlyingStream release];
    free(buf);
    [super dealloc];
}
- (int)readByte:(NSError **)error {
    if ((len - pos) == 0) {
        NSInteger myRet = [underlyingStream read:buf bufferLength:MY_BUF_SIZE error:error];
        if (myRet < 0) {
            return -1;
        }
        pos = 0;
        len = myRet;
    }
    if ((len - pos) == 0) {
        SETNSERROR([BufferedInputStream errorDomain], ERROR_EOF, @"%@ EOF", self);
        return -1;
    }
    int ret = buf[pos++];
    totalBytesReceived++;
    return ret;
}
- (NSData *)readExactly:(NSUInteger)exactLength error:(NSError **)error {
    NSMutableData *data = [NSMutableData data];
    if (![self readExactly:exactLength intoBuffer:data error:error]) {
        return nil;
    }
    return data;
}
- (BOOL)readExactly:(NSUInteger)exactLength intoBuffer:(NSMutableData *)theOutBuffer error:(NSError **)error {
    [theOutBuffer setLength:exactLength];
    unsigned char *dataBuf = [theOutBuffer mutableBytes];
    if (![self readExactly:exactLength into:dataBuf error:error]) {
        return NO;
    }
    return YES;
}
- (BOOL)readExactly:(NSUInteger)exactLength into:(unsigned char *)outBuf error:(NSError **)error {
    if (exactLength > 2147483648) {
        NSString *err = [NSString stringWithFormat:@"absurd length %lu requested", (unsigned long)exactLength];
        SETNSERROR(@"InputStreamErrorDomain", -1, @"%@", err);
        return NO;
    }
    NSUInteger received = 0;
    while (received < exactLength) {
        NSInteger ret = [self read:(outBuf + received) bufferLength:(exactLength - received) error:error];
        if (ret == -1) {
            return NO;
        }
        if (ret == 0) {
            SETNSERROR([BufferedInputStream errorDomain], ERROR_EOF, @"%@ EOF after %lu of %lu bytes received", self, (unsigned long)received, (unsigned long)exactLength);
            return NO;
        }
        received += ret;
    }
    return YES;
}
- (NSString *)readLineWithCRLFWithMaxLength:(NSUInteger)maxLength error:(NSError **)error {
    unsigned char *lineBuf = (unsigned char *)malloc(maxLength);
    NSUInteger received = 0;
    for (;;) {
        if (received > maxLength) {
            SETNSERROR(@"InputStreamErrorDomain", -1, @"exceeded maxLength %lu before finding CRLF", (unsigned long)maxLength);
            free(lineBuf);
            return nil;
        }
        if (![self readExactly:1 into:(lineBuf + received) error:error]) {
            free(lineBuf);
            return nil;
        }
        received++;
        if (received >= 2 && lineBuf[received - 1] == '\n' && lineBuf[received - 2] == '\r') {
            break;
        }
    }
    NSString *ret = [[[NSString alloc] initWithBytes:lineBuf length:received encoding:NSUTF8StringEncoding] autorelease];
    free(lineBuf);
    return ret;
}
- (NSString *)readLine:(NSError **)error {
    NSMutableData *data = [NSMutableData data];
    unsigned char charBuf[1];
    NSUInteger received = 0;
    for (;;) {
        if (![self readExactly:1 into:charBuf error:error]) {
            return nil;
        }
        if (*charBuf == '\n') {
            break;
        }
        [data appendBytes:charBuf length:1];
        received++;
    }
    NSString *ret = [[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease];
    return ret;
}
- (uint64_t)bytesReceived {
    return totalBytesReceived;
}

#pragma mark InputStream
- (NSInteger)read:(unsigned char *)outBuf bufferLength:(NSUInteger)outBufLen error:(NSError **)error {
    NSInteger ret = 0;
    NSUInteger remaining = len - pos;
    if (remaining > 0) {
        // Return bytes from my buf:
        ret = remaining > outBufLen ? outBufLen : remaining;
        memcpy(outBuf, buf + pos, ret);
        pos += ret;
    } else if (outBufLen > MY_BUF_SIZE) {
        // Read direct into outBuf:
        ret = [underlyingStream read:outBuf bufferLength:outBufLen error:error];
    } else {
        // Read into my buf and return only what's asked for.
        NSInteger myRet = [underlyingStream read:buf bufferLength:MY_BUF_SIZE error:error];
        if (myRet < 0) {
            return myRet;
        }
        pos = 0;
        len = myRet;
        if (len > 0) {
            ret = len > outBufLen ? outBufLen : len;
            memcpy(outBuf, buf, ret);
            pos += ret;
       } else {
           ret = 0;
       }
    }
    if (ret > 0) {
        totalBytesReceived += ret;
    }
    return ret;
}
- (NSData *)slurp:(NSError **)error {
    return [InputStreams slurp:self error:error];
}
- (BOOL)slurpIntoBuffer:(NSMutableData *)theBuffer error:(NSError **)error {
    return [InputStreams slurp:self intoBuffer:theBuffer error:error];
}


#pragma mark NSObject
- (NSString *)description {
    return [NSString stringWithFormat:@"<BufferedInputStream %@>", underlyingStream];
}
@end