/*
* Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
*
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3.0 only,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* version 3.0 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* version 3.0 along with this program. If not, see
* <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#import "OFZooArchiveEntry.h"
#import "OFZooArchiveEntry+Private.h"
#import "OFData.h"
#import "OFDate.h"
#import "OFNumber.h"
#import "OFSeekableStream.h"
#import "OFString.h"
#import "OFInvalidFormatException.h"
#import "OFOutOfRangeException.h"
#import "OFUnsupportedVersionException.h"
@implementation OFZooArchiveEntry
/*
* The following properties are not implemented, but old Apple GCC requries
* @dynamic for @optional properties.
*/
@dynamic ownerAccountID, groupOwnerAccountID, ownerAccountName;
@dynamic groupOwnerAccountName;
- (instancetype)init
{
OF_INVALID_INIT_METHOD
}
- (instancetype)of_init
{
self = [super init];
@try {
_headerType = 2;
_minVersionNeeded = 0x100;
} @catch (id e) {
[self release];
@throw e;
}
return self;
}
- (instancetype)of_initWithStream: (OFSeekableStream *)stream
encoding: (OFStringEncoding)encoding
{
self = [super init];
@try {
void *pool = objc_autoreleasePoolPush();
char fileNameBuffer[13];
uint32_t commentOffset;
uint16_t commentLength;
if ([stream readLittleEndianInt32] != 0xFDC4A7DC)
@throw [OFInvalidFormatException exception];
if ((_headerType = [stream readInt8]) > 2)
@throw [OFUnsupportedVersionException
exceptionWithVersion: [OFString
stringWithFormat: @"%" PRIu8, _headerType]];
_compressionMethod = [stream readInt8];
_nextHeaderOffset = [stream readLittleEndianInt32];
if (_nextHeaderOffset == 0) {
[self release];
return nil;
}
_dataOffset = [stream readLittleEndianInt32];
_lastModifiedFileDate = [stream readLittleEndianInt16];
_lastModifiedFileTime = [stream readLittleEndianInt16];
_CRC16 = [stream readLittleEndianInt16];
_uncompressedSize = [stream readLittleEndianInt32];
_compressedSize = [stream readLittleEndianInt32];
if ((_minVersionNeeded = [stream readBigEndianInt16]) > 0x201)
@throw [OFUnsupportedVersionException
exceptionWithVersion: [OFString stringWithFormat:
@"%" PRIu8 @".%" PRIu8,
_minVersionNeeded >> 8, _minVersionNeeded & 0xFF]];
_deleted = [stream readInt8];
/*
* File structure, whatever that is meant to be. Seems to
* always be 0.
*/
[stream readInt8];
commentOffset = [stream readLittleEndianInt32];
commentLength = [stream readLittleEndianInt16];
[stream readIntoBuffer: fileNameBuffer exactLength: 13];
if (fileNameBuffer[12] != '\0')
fileNameBuffer[12] = '\0';
if (_headerType >= 2) {
uint16_t extraLength = [stream readLittleEndianInt16];
uint8_t fileNameLength = 0, directoryNameLength = 0;
_timeZone = [stream readInt8];
/* CRC16 of the header */
[stream readLittleEndianInt16];
if (extraLength >= 2) {
fileNameLength = [stream readInt8];
directoryNameLength = [stream readInt8];
extraLength -= 2;
}
if (fileNameLength > 0) {
if (extraLength < fileNameLength)
@throw [OFInvalidFormatException
exception];
_fileName = [[stream
readStringWithLength: fileNameLength
encoding: encoding] copy];
extraLength -= fileNameLength;
} else
_fileName = [[OFString alloc]
initWithCString: fileNameBuffer
encoding: encoding];
if (directoryNameLength > 0) {
if (extraLength < directoryNameLength)
@throw [OFInvalidFormatException
exception];
_directoryName = [[stream
readStringWithLength: directoryNameLength
encoding: encoding] copy];
extraLength -= directoryNameLength;
}
if (extraLength >= 2) {
_operatingSystemIdentifier =
[stream readLittleEndianInt16];
extraLength -= 2;
}
if (extraLength >= 3) {
uint8_t attributes[3];
[stream readIntoBuffer: attributes
exactLength: 3];
if (attributes[2] & (1 << 6)) {
uint16_t mode = (attributes[0] |
(attributes[1] << 8)) & 0777;
_POSIXPermissions = [[OFNumber alloc]
initWithUnsignedShort: mode];
}
extraLength -= 3;
}
} else {
_fileName = [[OFString alloc]
initWithCString: fileNameBuffer
encoding: encoding];
_timeZone = 0x7F;
}
if (commentOffset != 0) {
[stream seekToOffset: commentOffset whence: OFSeekSet];
_fileComment = [[stream
readStringWithLength: commentLength
encoding: encoding] retain];
}
objc_autoreleasePoolPop(pool);
} @catch (id e) {
[self release];
@throw e;
}
return self;
}
- (void)dealloc
{
[_fileComment release];
[_fileName release];
[_directoryName release];
[_POSIXPermissions release];
[super dealloc];
}
- (id)copy
{
return [self retain];
}
- (id)mutableCopy
{
OFZooArchiveEntry *copy = [[OFMutableZooArchiveEntry alloc]
initWithFileName: self.fileName];
@try {
copy->_headerType = _headerType;
copy->_compressionMethod = _compressionMethod;
copy->_nextHeaderOffset = _nextHeaderOffset;
copy->_dataOffset = _dataOffset;
copy->_lastModifiedFileDate = _lastModifiedFileDate;
copy->_lastModifiedFileTime = _lastModifiedFileTime;
copy->_CRC16 = _CRC16;
copy->_uncompressedSize = _uncompressedSize;
copy->_compressedSize = _compressedSize;
copy->_minVersionNeeded = _minVersionNeeded;
copy->_deleted = _deleted;
copy->_fileComment = [_fileComment copy];
copy->_operatingSystemIdentifier = _operatingSystemIdentifier;
copy->_POSIXPermissions = [_POSIXPermissions retain];
copy->_timeZone = _timeZone;
} @catch (id e) {
[self release];
@throw e;
}
return copy;
}
- (uint8_t)headerType
{
return _headerType;
}
- (uint8_t)compressionMethod
{
return _compressionMethod;
}
- (OFDate *)modificationDate
{
void *pool = objc_autoreleasePoolPush();
uint16_t year = ((_lastModifiedFileDate & 0xFE00) >> 9) + 1980;
uint8_t month = (_lastModifiedFileDate & 0x1E0) >> 5;
uint8_t day = (_lastModifiedFileDate & 0x1F);
uint8_t hour = (_lastModifiedFileTime & 0xF800) >> 11;
uint8_t minute = (_lastModifiedFileTime & 0x7E0) >> 5;
uint8_t second = (_lastModifiedFileTime & 0x1F) << 1;
OFDate *date;
OFString *dateString;
dateString = [OFString
stringWithFormat: @"%04u-%02u-%02u %02u:%02u:%02u",
year, month, day, hour, minute, second];
if (_timeZone == 0x7F)
date = [[OFDate alloc]
initWithLocalDateString: dateString
format: @"%Y-%m-%d %H:%M:%S"];
else {
date = [OFDate dateWithDateString: dateString
format: @"%Y-%m-%d %H:%M:%S"];
date = [[date dateByAddingTimeInterval:
(OFTimeInterval)_timeZone * 900] retain];
}
objc_autoreleasePoolPop(pool);
return [date autorelease];
}
- (uint16_t)CRC16
{
return _CRC16;
}
- (unsigned long long)uncompressedSize
{
return _uncompressedSize;
}
- (unsigned long long)compressedSize
{
return _compressedSize;
}
- (uint16_t)minVersionNeeded
{
return _minVersionNeeded;
}
- (bool)isDeleted
{
return _deleted;
}
- (OFString *)fileComment
{
return _fileComment;
}
- (OFString *)fileName
{
if (_directoryName == nil)
return _fileName;
return [OFString stringWithFormat: @"%@/%@", _directoryName, _fileName];
}
- (uint16_t)operatingSystemIdentifier
{
return _operatingSystemIdentifier;
}
- (OFNumber *)POSIXPermissions
{
return _POSIXPermissions;
}
- (OFNumber *)timeZone
{
if (_timeZone == 0x7F)
return nil;
return [OFNumber numberWithFloat: -(float)_timeZone / 4];
}
- (size_t)of_writeToStream: (OFSeekableStream *)stream
encoding: (OFStringEncoding)encoding
{
void *pool = objc_autoreleasePoolPush();
OFMutableData *data = [OFMutableData dataWithCapacity: 56];
OFStreamOffset offset = [stream seekToOffset: 0 whence: OFSeekCurrent];
size_t dataOffsetIndex, commentOffsetIndex;
char fileNameBuffer[13] = { 0 };
uint8_t tmp8;
uint16_t tmp16;
uint32_t tmp32;
size_t commentLength, fileNameLength, directoryNameLength, length;
if (_uncompressedSize > UINT32_MAX || _compressedSize > UINT32_MAX)
@throw [OFOutOfRangeException exception];
commentLength = [_fileComment cStringLengthWithEncoding: encoding];
if (commentLength > UINT16_MAX)
@throw [OFOutOfRangeException exception];
fileNameLength = [_fileName cStringLengthWithEncoding: encoding];
if (fileNameLength > UINT8_MAX - 1)
@throw [OFOutOfRangeException exception];
directoryNameLength =
[_directoryName cStringLengthWithEncoding: encoding];
if (directoryNameLength > UINT8_MAX - 1)
@throw [OFOutOfRangeException exception];
[data addItems: "\xDC\xA7\xC4\xFD" count: 4];
/* Header type */
[data addItem: "\x02"];
[data addItem: &_compressionMethod];
/* Next header offset filled when writing the next header */
[data increaseCountBy: 4];
/* Data offset is filled after generating the header */
dataOffsetIndex = data.count;
[data increaseCountBy: 4];
tmp16 = OFToLittleEndian16(_lastModifiedFileDate);
[data addItems: &tmp16 count: 2];
tmp16 = OFToLittleEndian16(_lastModifiedFileTime);
[data addItems: &tmp16 count: 2];
tmp16 = OFToLittleEndian16(_CRC16);
[data addItems: &tmp16 count: 2];
tmp32 = OFToLittleEndian32((uint32_t)_uncompressedSize);
[data addItems: &tmp32 count: 4];
tmp32 = OFToLittleEndian32((uint32_t)_compressedSize);
[data addItems: &tmp32 count: 4];
/* Min version needed */
/* TODO: Increase to 2.1 once we add compression. */
[data addItems: "\x02\x00" count: 2];
[data addItem: (_deleted ? "\x01" : "")];
/*
* File structure, whatever that is meant to be.
* Seems to always be 0.
*/
[data addItem: ""];
/* Comment offset is filled after generating the header */
commentOffsetIndex = data.count;
[data increaseCountBy: 4];
tmp16 = OFToLittleEndian16((uint16_t)commentLength);
[data addItems: &tmp16 count: 2];
strncpy(fileNameBuffer, [_fileName cStringWithEncoding: encoding], 12);
[data addItems: fileNameBuffer count: 13];
/* Variable length. */
tmp16 = OFToLittleEndian16(fileNameLength + directoryNameLength + 4 +
(_POSIXPermissions != nil ? 3 : 0));
[data addItems: &tmp16 count: 2];
[data addItem: &_timeZone];
/*
* CRC16 is filled when writing the next header, as the CRC needs to
* include the next header offset.
*/
[data increaseCountBy: 2];
/* Include \0 */
if (fileNameLength > 0)
fileNameLength++;
if (directoryNameLength > 0)
directoryNameLength++;
tmp8 = (uint8_t)fileNameLength;
[data addItem: &tmp8];
tmp8 = (uint8_t)directoryNameLength;
[data addItem: &tmp8];
[data addItems: [_fileName cStringWithEncoding: encoding]
count: fileNameLength];
[data addItems: [_directoryName cStringWithEncoding: encoding]
count: directoryNameLength];
tmp16 = OFToLittleEndian16((uint16_t)_operatingSystemIdentifier);
[data addItems: &tmp16 count: 2];
if (_POSIXPermissions != nil) {
unsigned short mode = _POSIXPermissions.unsignedShortValue;
uint8_t attributes[3];
attributes[0] = mode & 0xFF;
attributes[1] = mode >> 8;
attributes[2] = (1 << 6);
[data addItems: attributes count: sizeof(attributes)];
}
/* Now that we have the entire header, we know where the data starts. */
if (SIZE_MAX - data.count < commentLength)
@throw [OFOutOfRangeException exception];
if (offset < 0 || UINT32_MAX - (unsigned long long)offset <
data.count + commentLength)
@throw [OFOutOfRangeException exception];
tmp32 = OFToLittleEndian32(
(uint32_t)offset + (uint32_t)data.count + (uint32_t)commentLength);
memcpy([data mutableItemAtIndex: dataOffsetIndex], &tmp32, 4);
tmp32 = OFToLittleEndian32((uint32_t)offset + (uint32_t)data.count);
memcpy([data mutableItemAtIndex: commentOffsetIndex], &tmp32, 4);
[stream writeData: data];
length = data.count;
if (commentLength > 0)
[stream writeString: _fileComment encoding: encoding];
objc_autoreleasePoolPop(pool);
return length;
}
- (OFString *)description
{
void *pool = objc_autoreleasePoolPush();
OFString *ret = [OFString stringWithFormat:
@"<%@:\n"
@"\tFile name = %@\n"
@"\tFile comment = %@\n"
@"\tCompressed size = %llu\n"
@"\tUncompressed size = %llu\n"
@"\tCompression method = %u\n"
@"\tModification date = %@\n"
@"\tCRC16 = %04" @PRIX16 @"\n"
@"\tDeleted = %u\n"
@">",
self.class, _fileName, _fileComment, _compressedSize,
_uncompressedSize, _compressionMethod, self.modificationDate,
_CRC16, _deleted];
[ret retain];
objc_autoreleasePoolPop(pool);
return [ret autorelease];
}
@end