Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve error handling for writing (ref #9)
* Replace writeable entries with -[ZZMutableArchive updateEntries:error:] method. * Stream, data and data consumer blocks now should report errors. * Revise error codes to be consistent with write errors. * Internal API now report file manager, POSIX and stream errors. * Unit tests for creating or inserting erroneous entries.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Original file line | Diff line number | Diff line change |
|---|---|---|---|
|
|
@@ -94,7 +94,7 @@ - (BOOL)load:(NSError**)error | ||
| NSError* __autoreleasing readError; | NSError* __autoreleasing readError; | ||
| NSData* contents = [_channel openInput:&readError]; | NSData* contents = [_channel openInput:&readError]; | ||
| if (!contents) | if (!contents) | ||
| return ZZRaiseError(error, ZZOpenReadErrorCode, @{NSUnderlyingErrorKey : readError}); | |||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. 
pixelglow
Author
Owner
|
|||
|
|
|
||
| // search for the end of directory signature in last 64K of file | // search for the end of directory signature in last 64K of file | ||
| const uint8_t* beginContent = (const uint8_t*)contents.bytes; | const uint8_t* beginContent = (const uint8_t*)contents.bytes; | ||
|
|
@@ -125,7 +125,7 @@ - (BOOL)load:(NSError**)error | ||
| // end of central directory occurs at actual end of the zip | // end of central directory occurs at actual end of the zip | ||
| || endContent | || endContent | ||
| != endOfCentralDirectory + sizeof(ZZEndOfCentralDirectory) + endOfCentralDirectoryRecord->zipFileCommentLength) | != endOfCentralDirectory + sizeof(ZZEndOfCentralDirectory) + endOfCentralDirectoryRecord->zipFileCommentLength) | ||
| return ZZRaiseError(error, ZZEndOfCentralDirectoryReadErrorCode, nil); | |||
|
|
|
||
| // add an entry for each central header in the sequence | // add an entry for each central header in the sequence | ||
| ZZCentralFileHeader* nextCentralFileHeader = (ZZCentralFileHeader*)(beginContent | ZZCentralFileHeader* nextCentralFileHeader = (ZZCentralFileHeader*)(beginContent | ||
|
|
@@ -142,7 +142,7 @@ - (BOOL)load:(NSError**)error | ||
| // local file occurs before first central file header, and has enough minimal space for at least local file | // local file occurs before first central file header, and has enough minimal space for at least local file | ||
| || nextCentralFileHeader->relativeOffsetOfLocalHeader + sizeof(ZZLocalFileHeader) | || nextCentralFileHeader->relativeOffsetOfLocalHeader + sizeof(ZZLocalFileHeader) | ||
| > endOfCentralDirectoryRecord->offsetOfStartOfCentralDirectoryWithRespectToTheStartingDiskNumber) | > endOfCentralDirectoryRecord->offsetOfStartOfCentralDirectoryWithRespectToTheStartingDiskNumber) | ||
| return ZZRaiseError(error, ZZCentralFileHeaderReadErrorCode, @{ZZEntryIndexKey : @(index)}); | |||
|
|
|
||
| ZZLocalFileHeader* nextLocalFileHeader = (ZZLocalFileHeader*)(beginContent | ZZLocalFileHeader* nextLocalFileHeader = (ZZLocalFileHeader*)(beginContent | ||
| + nextCentralFileHeader->relativeOffsetOfLocalHeader); | + nextCentralFileHeader->relativeOffsetOfLocalHeader); | ||
|
|
@@ -164,7 +164,8 @@ - (BOOL)load:(NSError**)error | ||
|
|
|
||
| @implementation ZZMutableArchive | @implementation ZZMutableArchive | ||
|
|
|
||
| - (BOOL)updateEntries:(NSArray*)newEntries | |||
| error:(NSError**)error | |||
| { | { | ||
| // NOTE: we want to avoid loading at all when entries are being overwritten, even in the face of lazy loading: | // NOTE: we want to avoid loading at all when entries are being overwritten, even in the face of lazy loading: | ||
| // consider that nil _contents implies that no valid entries have been loaded, and newEntries cannot possibly contain any of our old entries | // consider that nil _contents implies that no valid entries have been loaded, and newEntries cannot possibly contain any of our old entries | ||
|
|
@@ -182,10 +183,9 @@ - (void)setEntries:(NSArray*)newEntries | ||
| // get an entry writer for each new entry | // get an entry writer for each new entry | ||
| NSMutableArray* newEntryWriters = [NSMutableArray array]; | NSMutableArray* newEntryWriters = [NSMutableArray array]; | ||
|
|
|
||
| [newEntries enumerateObjectsUsingBlock:^(ZZArchiveEntry *anEntry, NSUInteger index, BOOL* stop) | |||
| { | { | ||
| [newEntryWriters addObject:[anEntry writerCanSkipLocalFile:index < skipIndex]]; | |||
| }]; | }]; | ||
|
|
|
||
| // clear entries + content | // clear entries + content | ||
|
|
@@ -195,59 +195,98 @@ - (void)setEntries:(NSArray*)newEntries | ||
| // skip the initial matching entries | // skip the initial matching entries | ||
| uint32_t initialSkip = skipIndex > 0 ? [[newEntryWriters objectAtIndex:skipIndex - 1] offsetToLocalFileEnd] : 0; | uint32_t initialSkip = skipIndex > 0 ? [[newEntryWriters objectAtIndex:skipIndex - 1] offsetToLocalFileEnd] : 0; | ||
|
|
|
||
| NSError* __autoreleasing underlyingError; | |||
|
|
|||
| // create a temp channel for all output | // create a temp channel for all output | ||
| id<ZZChannel> temporaryChannel = [_channel temporaryChannel:&underlyingError]; | |||
| if (!temporaryChannel) | |||
| return ZZRaiseError(error, ZZOpenWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError}); | |||
|
|
|
||
| @try | |||
| { | { | ||
| // open the channel | |||
| id<ZZChannelOutput> temporaryChannelOutput = [temporaryChannel openOutputWithOffsetBias:initialSkip | |||
| error:&underlyingError]; | |||
| if (!temporaryChannelOutput) | |||
| return ZZRaiseError(error, ZZOpenWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError}); | |||
|
|
|||
| @try | |||
| { | |||
| // write out local files | |||
| for (NSUInteger index = skipIndex; index < newEntriesCount; ++index) | |||
| if (![[newEntryWriters objectAtIndex:index] writeLocalFileToChannelOutput:temporaryChannelOutput | |||
| error:&underlyingError]) | |||
| return ZZRaiseError(error, ZZLocalFileWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError, ZZEntryIndexKey : @(index)}); | |||
|
|
|||
| ZZEndOfCentralDirectory endOfCentralDirectory; | |||
| endOfCentralDirectory.signature = ZZEndOfCentralDirectory::sign; | |||
| endOfCentralDirectory.numberOfThisDisk | |||
| = endOfCentralDirectory.numberOfTheDiskWithTheStartOfTheCentralDirectory | |||
| = 0; | |||
| endOfCentralDirectory.totalNumberOfEntriesInTheCentralDirectoryOnThisDisk | |||
| = endOfCentralDirectory.totalNumberOfEntriesInTheCentralDirectory | |||
| = newEntriesCount; | |||
| endOfCentralDirectory.offsetOfStartOfCentralDirectoryWithRespectToTheStartingDiskNumber = [temporaryChannelOutput offset]; | |||
|
|
|||
| // write out central file headers | |||
| for (NSUInteger index = 0; index < newEntriesCount; ++index) | |||
| if (![[newEntryWriters objectAtIndex:index] writeCentralFileHeaderToChannelOutput:temporaryChannelOutput | |||
| error:&underlyingError]) | |||
| return ZZRaiseError(error, ZZCentralFileHeaderWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError, ZZEntryIndexKey : @(index)}); | |||
|
|
|||
| endOfCentralDirectory.sizeOfTheCentralDirectory = [temporaryChannelOutput offset] | |||
| - endOfCentralDirectory.offsetOfStartOfCentralDirectoryWithRespectToTheStartingDiskNumber; | |||
| endOfCentralDirectory.zipFileCommentLength = 0; | |||
|
|
|||
| // write out the end of central directory | |||
| if (![temporaryChannelOutput writeData:[NSData dataWithBytesNoCopy:&endOfCentralDirectory | |||
| length:sizeof(endOfCentralDirectory) | |||
| freeWhenDone:NO] | |||
| error:&underlyingError]) | |||
| return ZZRaiseError(error, ZZEndOfCentralDirectoryWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError}); | |||
| } | |||
| @finally | |||
| { | |||
| [temporaryChannelOutput close]; | |||
| } | |||
|
|
|||
| if (initialSkip) | |||
| { | |||
| // something skipped, append the temporary channel contents at the skipped offset | |||
| id<ZZChannelOutput> channelOutput = [_channel openOutputWithOffsetBias:0 | |||
| error:&underlyingError]; | |||
| if (!channelOutput) | |||
| return ZZRaiseError(error, ZZReplaceWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError}); | |||
|
|
|||
| @try | |||
| { | |||
| NSData* channelInput = [temporaryChannel openInput:&underlyingError]; | |||
| if (!channelInput | |||
| || ![channelOutput seekToOffset:initialSkip | |||
| error:&underlyingError] | |||
| || ![channelOutput writeData:channelInput | |||
| error:&underlyingError] | |||
| || ![channelOutput truncateAtOffset:[channelOutput offset] | |||
| error:&underlyingError]) | |||
| return ZZRaiseError(error, ZZReplaceWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError}); | |||
| } | |||
| @finally | |||
| { | |||
| [channelOutput close]; | |||
| } | |||
| } | |||
| else | |||
| // nothing skipped, temporary channel is entire contents: simply replace the original | |||
| if (![_channel replaceWithChannel:temporaryChannel | |||
| error:&underlyingError]) | |||
| return ZZRaiseError(error, ZZReplaceWriteErrorCode, @{NSUnderlyingErrorKey : underlyingError}); | |||
| } | |||
| @finally | |||
| { | |||
| [_channel removeTemporaries]; | |||
| } | } | ||
|
|
|
||
| return YES; | |||
| } | } | ||
|
|
|
||
| @end | @end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Is there any advantage to reporting your own error code here? Cocoa provides perfectly decent errors itself