/*
* Copyright (c) 2008-2021 Jonathan Schleifer <js@nil.im>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#include "config.h"
#include <stdlib.h>
#include <string.h>
#include <limits.h>
#import "OFData.h"
#import "OFBase64.h"
#import "OFDictionary.h"
#ifdef OF_HAVE_FILES
# import "OFFile.h"
# import "OFFileManager.h"
#endif
#import "OFStream.h"
#import "OFString.h"
#import "OFSystemInfo.h"
#import "OFURL.h"
#import "OFURLHandler.h"
#import "OFXMLElement.h"
#import "OFInvalidArgumentException.h"
#import "OFInvalidFormatException.h"
#import "OFInvalidServerReplyException.h"
#import "OFOutOfMemoryException.h"
#import "OFOutOfRangeException.h"
#import "OFTruncatedDataException.h"
#import "OFUnsupportedProtocolException.h"
/* References for static linking */
void
_references_to_categories_of_OFData(void)
{
_OFData_CryptographicHashing_reference = 1;
_OFData_MessagePackParsing_reference = 1;
}
@implementation OFData
@synthesize itemSize = _itemSize;
+ (instancetype)dataWithItems: (const void *)items count: (size_t)count
{
return [[[self alloc] initWithItems: items count: count] autorelease];
}
+ (instancetype)dataWithItems: (const void *)items
count: (size_t)count
itemSize: (size_t)itemSize
{
return [[[self alloc] initWithItems: items
count: count
itemSize: itemSize] autorelease];
}
+ (instancetype)dataWithItemsNoCopy: (void *)items
count: (size_t)count
freeWhenDone: (bool)freeWhenDone
{
return [[[self alloc] initWithItemsNoCopy: items
count: count
freeWhenDone: freeWhenDone] autorelease];
}
+ (instancetype)dataWithItemsNoCopy: (void *)items
count: (size_t)count
itemSize: (size_t)itemSize
freeWhenDone: (bool)freeWhenDone
{
return [[[self alloc] initWithItemsNoCopy: items
count: count
itemSize: itemSize
freeWhenDone: freeWhenDone] autorelease];
}
#ifdef OF_HAVE_FILES
+ (instancetype)dataWithContentsOfFile: (OFString *)path
{
return [[[self alloc] initWithContentsOfFile: path] autorelease];
}
#endif
+ (instancetype)dataWithContentsOfURL: (OFURL *)URL
{
return [[[self alloc] initWithContentsOfURL: URL] autorelease];
}
+ (instancetype)dataWithStringRepresentation: (OFString *)string
{
return [[[self alloc]
initWithStringRepresentation: string] autorelease];
}
+ (instancetype)dataWithBase64EncodedString: (OFString *)string
{
return [[[self alloc] initWithBase64EncodedString: string] autorelease];
}
- (instancetype)initWithItems: (const void *)items count: (size_t)count
{
return [self initWithItems: items count: count itemSize: 1];
}
- (instancetype)initWithItems: (const void *)items
count: (size_t)count
itemSize: (size_t)itemSize
{
self = [super init];
@try {
if (itemSize == 0)
@throw [OFInvalidArgumentException exception];
_items = OFAllocMemory(count, itemSize);
_count = count;
_itemSize = itemSize;
_freeWhenDone = true;
memcpy(_items, items, count * itemSize);
} @catch (id e) {
[self release];
@throw e;
}
return self;
}
- (instancetype)initWithItemsNoCopy: (void *)items
count: (size_t)count
freeWhenDone: (bool)freeWhenDone
{
return [self initWithItemsNoCopy: items
count: count
itemSize: 1
freeWhenDone: freeWhenDone];
}
- (instancetype)initWithItemsNoCopy: (void *)items
count: (size_t)count
itemSize: (size_t)itemSize
freeWhenDone: (bool)freeWhenDone
{
self = [super init];
@try {
if (itemSize == 0)
@throw [OFInvalidArgumentException exception];
_items = (unsigned char *)items;
_count = count;
_itemSize = itemSize;
_freeWhenDone = freeWhenDone;
} @catch (id e) {
[self release];
@throw e;
}
return self;
}
#ifdef OF_HAVE_FILES
- (instancetype)initWithContentsOfFile: (OFString *)path
{
char *buffer = NULL;
unsigned long long size;
@try {
OFFile *file;
size = [[OFFileManager defaultManager]
attributesOfItemAtPath: path].fileSize;
# if ULLONG_MAX > SIZE_MAX
if (size > SIZE_MAX)
@throw [OFOutOfRangeException exception];
# endif
buffer = OFAllocMemory((size_t)size, 1);
file = [[OFFile alloc] initWithPath: path mode: @"r"];
@try {
[file readIntoBuffer: buffer exactLength: (size_t)size];
} @finally {
[file release];
}
} @catch (id e) {
OFFreeMemory(buffer);
[self release];
@throw e;
}
@try {
self = [self initWithItemsNoCopy: buffer
count: (size_t)size
freeWhenDone: true];
} @catch (id e) {
OFFreeMemory(buffer);
@throw e;
}
return self;
}
#endif
- (instancetype)initWithContentsOfURL: (OFURL *)URL
{
self = [super init];
@try {
void *pool = objc_autoreleasePoolPush();
OFURLHandler *URLHandler;
OFStream *stream;
size_t pageSize;
unsigned char *buffer;
if ((URLHandler = [OFURLHandler handlerForURL: URL]) == nil)
@throw [OFUnsupportedProtocolException
exceptionWithURL: URL];
stream = [URLHandler openItemAtURL: URL mode: @"r"];
_count = 0;
_itemSize = 1;
_freeWhenDone = true;
pageSize = [OFSystemInfo pageSize];
buffer = OFAllocMemory(1, pageSize);
@try {
while (!stream.atEndOfStream) {
size_t length = [stream
readIntoBuffer: buffer
length: pageSize];
if (SIZE_MAX - _count < length)
@throw [OFOutOfRangeException
exception];
_items = OFResizeMemory(_items,
_count + length, 1);
memcpy(_items + _count, buffer, length);
_count += length;
}
} @finally {
OFFreeMemory(buffer);
}
objc_autoreleasePoolPop(pool);
} @catch (id e) {
[self release];
@throw e;
}
return self;
}
- (instancetype)initWithStringRepresentation: (OFString *)string
{
self = [super init];
@try {
size_t count = [string
cStringLengthWithEncoding: OFStringEncodingASCII];
const char *cString;
if (count % 2 != 0)
@throw [OFInvalidFormatException exception];
count /= 2;
_items = OFAllocMemory(count, 1);
_count = count;
_itemSize = 1;
_freeWhenDone = true;
cString = [string cStringWithEncoding: OFStringEncodingASCII];
for (size_t i = 0; i < count; i++) {
uint8_t c1 = cString[2 * i];
uint8_t c2 = cString[2 * i + 1];
uint8_t byte;
if (c1 >= '0' && c1 <= '9')
byte = (c1 - '0') << 4;
else if (c1 >= 'a' && c1 <= 'f')
byte = (c1 - 'a' + 10) << 4;
else if (c1 >= 'A' && c1 <= 'F')
byte = (c1 - 'A' + 10) << 4;
else
@throw [OFInvalidFormatException exception];
if (c2 >= '0' && c2 <= '9')
byte |= c2 - '0';
else if (c2 >= 'a' && c2 <= 'f')
byte |= c2 - 'a' + 10;
else if (c2 >= 'A' && c2 <= 'F')
byte |= c2 - 'A' + 10;
else
@throw [OFInvalidFormatException exception];
_items[i] = byte;
}
} @catch (id e) {
[self release];
@throw e;
}
return self;
}
- (instancetype)initWithBase64EncodedString: (OFString *)string
{
bool mutable = [self isKindOfClass: [OFMutableData class]];
if (!mutable) {
[self release];
self = [OFMutableData alloc];
}
self = [(OFMutableData *)self initWithCapacity: string.length / 3];
@try {
if (!OFBase64Decode((OFMutableData *)self,
[string cStringWithEncoding: OFStringEncodingASCII],
[string cStringLengthWithEncoding: OFStringEncodingASCII]))
@throw [OFInvalidFormatException exception];
} @catch (id e) {
[self release];
@throw e;
}
if (!mutable)
[(OFMutableData *)self makeImmutable];
return self;
}
- (instancetype)initWithSerialization: (OFXMLElement *)element
{
void *pool = objc_autoreleasePoolPush();
OFString *stringValue;
@try {
if (![element.name isEqual: self.className] ||
![element.namespace isEqual: OFSerializationNS])
@throw [OFInvalidArgumentException exception];
stringValue = element.stringValue;
} @catch (id e) {
[self release];
@throw e;
}
self = [self initWithBase64EncodedString: stringValue];
objc_autoreleasePoolPop(pool);
return self;
}
- (void)dealloc
{
if (_freeWhenDone)
OFFreeMemory(_items);
[_parentData release];
[super dealloc];
}
- (size_t)count
{
return _count;
}
- (const void *)items
{
return _items;
}
- (const void *)itemAtIndex: (size_t)idx
{
if (idx >= _count)
@throw [OFOutOfRangeException exception];
return _items + idx * _itemSize;
}
- (const void *)firstItem
{
if (_items == NULL || _count == 0)
return NULL;
return _items;
}
- (const void *)lastItem
{
if (_items == NULL || _count == 0)
return NULL;
return _items + (_count - 1) * _itemSize;
}
- (id)copy
{
return [self retain];
}
- (id)mutableCopy
{
return [[OFMutableData alloc] initWithItems: _items
count: _count
itemSize: _itemSize];
}
- (bool)isEqual: (id)object
{
OFData *data;
if (object == self)
return true;
if (![object isKindOfClass: [OFData class]])
return false;
data = object;
if (data.count != _count || data.itemSize != _itemSize)
return false;
if (memcmp(data.items, _items, _count * _itemSize) != 0)
return false;
return true;
}
- (OFComparisonResult)compare: (OFData *)data
{
int comparison;
size_t count, minCount;
if (![data isKindOfClass: [OFData class]])
@throw [OFInvalidArgumentException exception];
if (data.itemSize != _itemSize)
@throw [OFInvalidArgumentException exception];
count = data.count;
minCount = (_count > count ? count : _count);
if ((comparison = memcmp(_items, data.items,
minCount * _itemSize)) == 0) {
if (_count > count)
return OFOrderedDescending;
if (_count < count)
return OFOrderedAscending;
return OFOrderedSame;
}
if (comparison > 0)
return OFOrderedDescending;
else
return OFOrderedAscending;
}
- (unsigned long)hash
{
unsigned long hash;
OFHashInit(&hash);
for (size_t i = 0; i < _count * _itemSize; i++)
OFHashAdd(&hash, ((uint8_t *)_items)[i]);
OFHashFinalize(&hash);
return hash;
}
- (OFData *)subdataWithRange: (OFRange)range
{
OFData *ret;
if (range.length > SIZE_MAX - range.location ||
range.location + range.length > _count)
@throw [OFOutOfRangeException exception];
ret = [OFData dataWithItemsNoCopy: _items + (range.location * _itemSize)
count: range.length
itemSize: _itemSize
freeWhenDone: false];
ret->_parentData = [(_parentData != nil ? _parentData : self) copy];
return ret;
}
- (OFString *)description
{
OFMutableString *ret = [OFMutableString stringWithString: @"<"];
for (size_t i = 0; i < _count; i++) {
if (i > 0)
[ret appendString: @" "];
for (size_t j = 0; j < _itemSize; j++)
[ret appendFormat: @"%02x", _items[i * _itemSize + j]];
}
[ret appendString: @">"];
[ret makeImmutable];
return ret;
}
- (OFString *)stringRepresentation
{
OFMutableString *ret = [OFMutableString string];
for (size_t i = 0; i < _count; i++)
for (size_t j = 0; j < _itemSize; j++)
[ret appendFormat: @"%02x", _items[i * _itemSize + j]];
[ret makeImmutable];
return ret;
}
- (OFString *)stringByBase64Encoding
{
return OFBase64Encode(_items, _count * _itemSize);
}
- (OFRange)rangeOfData: (OFData *)data
options: (OFDataSearchOptions)options
range: (OFRange)range
{
const char *search;
size_t searchLength;
if (range.length > SIZE_MAX - range.location ||
range.location + range.length > _count)
@throw [OFOutOfRangeException exception];
if (data == nil || data.itemSize != _itemSize)
@throw [OFInvalidArgumentException exception];
if ((searchLength = data.count) == 0)
return OFRangeMake(0, 0);
if (searchLength > range.length)
return OFRangeMake(OFNotFound, 0);
search = data.items;
if (options & OFDataSearchBackwards) {
for (size_t i = range.length - searchLength;; i--) {
if (memcmp(_items + i * _itemSize, search,
searchLength * _itemSize) == 0)
return OFRangeMake(i, searchLength);
/* No match and we're at the last item */
if (i == 0)
break;
}
} else {
for (size_t i = range.location;
i <= range.length - searchLength; i++)
if (memcmp(_items + i * _itemSize, search,
searchLength * _itemSize) == 0)
return OFRangeMake(i, searchLength);
}
return OFRangeMake(OFNotFound, 0);
}
#ifdef OF_HAVE_FILES
- (void)writeToFile: (OFString *)path
{
OFFile *file = [[OFFile alloc] initWithPath: path mode: @"w"];
@try {
[file writeBuffer: _items length: _count * _itemSize];
} @finally {
[file release];
}
}
#endif
- (void)writeToURL: (OFURL *)URL
{
void *pool = objc_autoreleasePoolPush();
OFURLHandler *URLHandler;
if ((URLHandler = [OFURLHandler handlerForURL: URL]) == nil)
@throw [OFUnsupportedProtocolException exceptionWithURL: URL];
[[URLHandler openItemAtURL: URL mode: @"w"] writeData: self];
objc_autoreleasePoolPop(pool);
}
- (OFXMLElement *)XMLElementBySerializing
{
void *pool;
OFXMLElement *element;
if (_itemSize != 1)
@throw [OFInvalidArgumentException exception];
pool = objc_autoreleasePoolPush();
element = [OFXMLElement
elementWithName: self.className
namespace: OFSerializationNS
stringValue: OFBase64Encode(_items, _count * _itemSize)];
[element retain];
objc_autoreleasePoolPop(pool);
return [element autorelease];
}
- (OFData *)messagePackRepresentation
{
OFMutableData *data;
if (_itemSize != 1)
@throw [OFInvalidArgumentException exception];
if (_count <= UINT8_MAX) {
uint8_t type = 0xC4;
uint8_t tmp = (uint8_t)_count;
data = [OFMutableData dataWithCapacity: _count + 2];
[data addItem: &type];
[data addItem: &tmp];
} else if (_count <= UINT16_MAX) {
uint8_t type = 0xC5;
uint16_t tmp = OFToBigEndian16((uint16_t)_count);
data = [OFMutableData dataWithCapacity: _count + 3];
[data addItem: &type];
[data addItems: &tmp count: sizeof(tmp)];
} else if (_count <= UINT32_MAX) {
uint8_t type = 0xC6;
uint32_t tmp = OFToBigEndian32((uint32_t)_count);
data = [OFMutableData dataWithCapacity: _count + 5];
[data addItem: &type];
[data addItems: &tmp count: sizeof(tmp)];
} else
@throw [OFOutOfRangeException exception];
[data addItems: _items count: _count];
[data makeImmutable];
return data;
}
@end