Merge pull request #59 from abbeycode/multivolume

Add enhanced support for multi-volume archives

Author: abbeycode

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 2.9
 
 * Added support for `NSProgress` and `NSProgressReporting` in all extraction and iteration methods (Issue #34)
+* Added enhanced support for multivolume archives (PRs #59, #38 - Thanks to [@aonez](https://github.com/aonez) for the idea and implementation!)
 * Switched to Travis Build Stages instead of the unofficial Travis-After-All (Issue #42)
 * Added detailed logging using new unified logging framework. See [the readme](README.md) for more details (Issue #35)
 * Added localized details to returned `NSError` objects (Issue #45)

Classes/URKArchive.h

@@ -153,6 +153,11 @@ extern NSString *URKErrorDomain;
  */
 @property(nullable, readonly) NSNumber *compressedSize;
 
+/**
+ *  True if the file is one volume of a multi-part archive
+ */
+@property(readonly) BOOL hasMultipleVolumes;
+
 /**
  *  Can be used for progress reporting, but it's not necessary. You can also use
  *  implicit progress reporting. If you don't use it, one will still be created,
@@ -281,6 +286,15 @@ extern NSString *URKErrorDomain;
  */
 - (nullable NSArray<URKFileInfo*> *)listFileInfo:(NSError **)error;
 
+/**
+ *  Lists the URLs of volumes in a single- or multi-volume archive
+ *
+ *  @param error Contains an NSError object when there was an error reading the archive
+ *
+ *  @return Returns the list of URLs of all volumes of the archive
+ */
+- (nullable NSArray<NSURL*> *)listVolumeURLs:(NSError **)error;
+
 /**
  *  Writes all files in the archive to the given path. Supports NSProgress for progress reporting, which also
  *  allows cancellation in the middle of extraction. Use the progress property (as explained in the README) to

Classes/URKArchive.mm

@@ -134,7 +134,13 @@ - (instancetype)initWithFile:(NSURL *)fileURL password:(NSString*)password error
         if (error) {
             *error = nil;
         }
-
+        
+        NSURL *firstVolumeURL = [URKArchive firstVolumeURL:fileURL];
+        if (firstVolumeURL && ![firstVolumeURL.absoluteString isEqualToString:fileURL.absoluteString]) {
+            URKLogDebug("Overriding fileURL with first volume URL: %{public}@", firstVolumeURL);
+            fileURL = firstVolumeURL;
+        }
+        
         URKLogDebug("Initializing private fields");
 
         NSError *bookmarkError = nil;
@@ -253,6 +259,21 @@ - (NSNumber *)compressedSize
     return [NSNumber numberWithUnsignedLongLong:attributes.fileSize];
 }
 
+- (BOOL)hasMultipleVolumes
+{
+    URKCreateActivity("Check If Multi-Volume Archive");
+    
+    NSError *listError = nil;
+    NSArray<NSURL*> *volumeURLs = [self listVolumeURLs:&listError];
+    
+    if (!volumeURLs) {
+        URKLogError("Error getting file volumes list: %{public}@", listError);
+        return false;
+    }
+    
+    return volumeURLs.count > 1;
+}
+
 
 
 #pragma mark - Zip file detection
@@ -380,6 +401,33 @@ + (BOOL)urlIsARAR:(NSURL *)fileURL
     return [NSArray arrayWithArray:fileInfos];
 }
 
+- (nullable NSArray<NSURL*> *)listVolumeURLs:(NSError **)error
+{
+    URKCreateActivity("Listing Volume URLs");
+
+    NSArray<URKFileInfo*> *listFileInfo = [self listFileInfo:error];
+    
+    if (listFileInfo == nil) {
+        return nil;
+    }
+    
+    NSMutableSet<NSURL*> *volumeURLs = [[NSMutableSet alloc] init];
+    
+    for (URKFileInfo* info in listFileInfo) {
+        NSURL *archiveURL = [NSURL fileURLWithPath:info.archiveName];
+        
+        if (archiveURL) {
+            [volumeURLs addObject:archiveURL];
+        }
+    }
+
+    SEL sortBySelector = @selector(path);
+    NSSortDescriptor *sortDescriptor = [NSSortDescriptor sortDescriptorWithKey:NSStringFromSelector(sortBySelector) ascending:YES];
+    NSArray<NSURL*> *sortedVolumes = [volumeURLs sortedArrayUsingDescriptors:@[sortDescriptor]];
+    
+    return sortedVolumes;
+}
+
 - (BOOL)extractFilesTo:(NSString *)filePath
              overwrite:(BOOL)overwrite
                  error:(NSError **)error
@@ -1262,6 +1310,8 @@ - (BOOL)headerContainsErrors:(NSError **)error
 
 - (NSProgress *)beginProgressOperation:(NSUInteger)totalUnitCount
 {
+    URKCreateActivity("-beginProgressOperation:");
+    
     NSProgress *progress;
     progress = self.progress;
     if (!progress) {
@@ -1279,4 +1329,79 @@ - (NSProgress *)beginProgressOperation:(NSUInteger)totalUnitCount
     return progress;
 }
 
++ (NSURL *)firstVolumeURL:(NSURL *)volumeURL {
+    URKCreateActivity("+firstVolumeURL:");
+
+    URKLogDebug("Checking if the file is part of a multi-volume archive...");
+    
+    if (!volumeURL) {
+        URKLogError("+firstVolumeURL: nil volumeURL passed")
+    }
+    
+    NSString *volumePath = volumeURL.path;
+
+    NSError *regexError = nil;
+    NSRegularExpression *regex = [NSRegularExpression regularExpressionWithPattern:@"(.part)([0-9]+)(.rar)$"
+                                                                           options:NSRegularExpressionCaseInsensitive
+                                                                             error:&regexError];
+    if (!regex) {
+        URKLogError("Error constructing filename regex")
+        return nil;
+    }
+    
+    NSString *firstVolumePath = nil;
+    
+    // Check if it's following the current convention, like "Archive.part03.rar"
+    NSTextCheckingResult *match = [regex firstMatchInString:volumePath options:0 range:NSMakeRange(0, volumePath.length)];
+    if (match) {
+        URKLogDebug("The file is part of a multi-volume archive");
+        
+        NSRange numberRange = [match rangeAtIndex:2];
+        NSString * partOne = [[@"" stringByPaddingToLength:numberRange.length - 1
+                                                withString:@"0"
+                                           startingAtIndex:0]
+                              stringByAppendingString:@"1"];
+        
+        NSString * regexTemplate = [NSString stringWithFormat:@"$1%@$3", partOne];
+        firstVolumePath = [regex stringByReplacingMatchesInString:volumePath
+                                                          options:0
+                                                            range:NSMakeRange(0, volumePath.length)
+                                                     withTemplate:regexTemplate];
+    }
+
+    // It still might be a multivolume archive. Check for the legacy naming convention, like "Archive.r03"
+    else {
+        // After rXX, rar uses r-z and symbols like {}|~... so accepting anything but a number
+        NSError *legacyRegexError = nil;
+        regex = [NSRegularExpression regularExpressionWithPattern:@"(\\.[^0-9])([0-9]+)$"
+                                                          options:NSRegularExpressionCaseInsensitive
+                                                            error:&legacyRegexError];
+        
+        if (!regex) {
+            URKLogError("Error constructing legacy filename regex")
+            return nil;
+        }
+        
+        match = [regex firstMatchInString:volumePath options:0 range:NSMakeRange(0, volumePath.length)];
+        if (match) {
+            URKLogDebug("The archive is part of a legacy volume");
+            firstVolumePath = [[volumePath stringByDeletingPathExtension] stringByAppendingPathExtension:@"rar"];
+        }
+    }
+    
+    // If it's a volume of either naming convention, use it
+    if (firstVolumePath) {
+        if ([[NSFileManager defaultManager] fileExistsAtPath:firstVolumePath]) {
+            URKLogDebug("First volume part %{public}@ found. Using as the main archive", firstVolumePath);
+            return [NSURL fileURLWithPath:firstVolumePath];
+        }
+        else {
+            URKLogInfo("First volume part not found: %{public}@. Skipping first volume selection", firstVolumePath);
+            return nil;
+        }
+    }
+    
+    return volumeURL;
+}
+
 @end

Tests/FirstVolumeTests.m

@@ -0,0 +1,109 @@
+//
+//  FirstVolumeTests.m
+//  UnrarKit
+//
+//  Created by Dov Frankel on 2/9/17.
+//
+//
+
+#import "URKArchiveTestCase.h"
+
+@interface FirstVolumeTests : URKArchiveTestCase @end
+
+@interface URKArchive (Tests)
+
+// It's a private class method
++ (NSURL *)firstVolumeURL:(NSURL *)volumeURL;
+
+@end
+
+@implementation FirstVolumeTests
+
+- (void)testSingleVolume {
+    NSURL *onlyVolumeArchiveURL = self.testFileURLs[@"Test Archive.rar"];
+    NSURL *returnedFirstVolumeURL = [URKArchive firstVolumeURL:onlyVolumeArchiveURL];
+    
+    XCTAssertNotNil(returnedFirstVolumeURL, @"No URL returned");
+    XCTAssertEqualObjects(returnedFirstVolumeURL, onlyVolumeArchiveURL, @"URL changed even though it's a single volume archive");
+}
+
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseFirstVolume {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveWithName:@"FirstVolumeTests-testMultipleVolume_UseFirstVolume.rar"];
+    NSURL *firstVolumeURL = volumeURLs.firstObject;
+    NSURL *returnedFirstVolumeURL = [URKArchive firstVolumeURL:firstVolumeURL];
+
+    XCTAssertNotNil(returnedFirstVolumeURL, @"No URL returned");
+    XCTAssertEqualObjects(returnedFirstVolumeURL, firstVolumeURL, @"URL changed even though it was initialized with the first volume");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseMiddleVolume {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveWithName:@"ListVolumesTests-testMultipleVolume_UseFirstVolume.rar"];
+    NSURL *firstVolumeURL = volumeURLs.firstObject;
+    NSURL *thirdVolumeURL = volumeURLs[2];
+
+    NSURL *returnedFirstVolumeURL = [URKArchive firstVolumeURL:thirdVolumeURL];
+    
+    XCTAssertNotNil(returnedFirstVolumeURL, @"No URL returned");
+    XCTAssertEqualObjects(returnedFirstVolumeURL.absoluteString, firstVolumeURL.absoluteString, @"Incorrect URL returned as first volume");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseMiddleVolume_OneHundredParts {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveWithName:@"ListVolumesTests-testMultipleVolume_UseFirstVolume.rar" fileSize:2500000];
+    
+    NSURL *firstVolumeURL = volumeURLs.firstObject;
+    NSURL *hundredthVolumeURL = volumeURLs[100];
+    
+    NSURL *returnedFirstVolumeURL = [URKArchive firstVolumeURL:hundredthVolumeURL];
+    
+    XCTAssertNotNil(returnedFirstVolumeURL, @"No URL returned");
+    XCTAssertEqualObjects(returnedFirstVolumeURL.absoluteString, firstVolumeURL.absoluteString, @"Incorrect URL returned as first volume");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseFirstVolume_OldNamingScheme {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveOldSchemeWithName:@"FirstVolumeTests-testMultipleVolume_UseFirstVolume_OldNamingScheme.rar"];
+    NSURL *firstVolumeURL = volumeURLs.firstObject;
+    NSURL *returnedFirstVolumeURL = [URKArchive firstVolumeURL:firstVolumeURL];
+    
+    XCTAssertNotNil(returnedFirstVolumeURL, @"No URL returned");
+    XCTAssertEqualObjects(returnedFirstVolumeURL, firstVolumeURL, @"URL changed even though it was initialized with the first volume");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseMiddleVolume_OldNamingScheme {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveOldSchemeWithName:@"FirstVolumeTests-testMultipleVolume_UseMiddleVolume_OldNamingScheme.rar"];
+    NSURL *firstVolumeURL = volumeURLs.firstObject;
+    NSURL *thirdVolumeURL = volumeURLs[2];
+    
+    NSURL *returnedFirstVolumeURL = [URKArchive firstVolumeURL:thirdVolumeURL];
+    
+    XCTAssertNotNil(returnedFirstVolumeURL, @"No URL returned");
+    XCTAssertEqualObjects(returnedFirstVolumeURL.absoluteString, firstVolumeURL.absoluteString, @"Incorrect URL returned as first volume");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_FirstVolumeMissing {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveWithName:@"ListVolumesTests-testMultipleVolume_FirstVolumeMissing.rar"];
+    
+    NSError *deleteError = nil;
+    [[NSFileManager defaultManager] removeItemAtURL:volumeURLs.firstObject
+                                              error:&deleteError];
+    XCTAssertNil(deleteError, @"Error deleting first volume of archive");
+    
+    NSURL *firstVolumeURL = volumeURLs.firstObject;
+    NSURL *returnedFirstVolumeURL = [URKArchive firstVolumeURL:firstVolumeURL];
+    
+    XCTAssertNil(returnedFirstVolumeURL, @"First volume URL returned when it does not exist");
+}
+#endif
+
+@end

Tests/HasMultipleVolumesTests.m

@@ -0,0 +1,73 @@
+//
+//  HasMultipleVolumesTests.m
+//  UnrarKit
+//
+//  Created by Dov Frankel on 2/9/17.
+//
+//
+
+#import "URKArchiveTestCase.h"
+
+@interface HasMultipleVolumesTests : URKArchiveTestCase
+
+@end
+
+@implementation HasMultipleVolumesTests
+
+- (void)testSingleVolume {
+    NSURL *testArchiveURL = self.testFileURLs[@"Test Archive.rar"];
+    URKArchive *archive = [[URKArchive alloc] initWithURL:testArchiveURL error:nil];
+    
+    BOOL hasMultipleParts = archive.hasMultipleVolumes;
+    
+    XCTAssertFalse(hasMultipleParts, @"Single-volume archive reported to have multiple parts");
+}
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseFirstVolume {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveWithName:@"HasMultipleVolumesTests-testMultipleVolume_UseFirstVolume.rar"];
+    URKArchive *archive = [[URKArchive alloc] initWithURL:volumeURLs.firstObject error:nil];
+    
+    BOOL hasMultipleParts = archive.hasMultipleVolumes;
+    XCTAssertTrue(hasMultipleParts, @"Multi-volume archive's first part not reported to have multiple volumes");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseMiddleVolume {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveWithName:@"HasMultipleVolumesTests-testMultipleVolume_UseMiddleVolume.rar"];
+    URKArchive *archive = [[URKArchive alloc] initWithURL:volumeURLs[2] error:nil];
+    
+    BOOL hasMultipleParts = archive.hasMultipleVolumes;
+    XCTAssertTrue(hasMultipleParts, @"Multi-volume archive's middle part not reported to have multiple volumes");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseFirstVolume_OldNamingScheme {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveOldSchemeWithName:@"HasMultipleVolumesTests-testMultipleVolume_UseFirstVolume_OldNamingScheme.rar"];
+    URKArchive *archive = [[URKArchive alloc] initWithURL:volumeURLs.firstObject error:nil];
+    
+    BOOL hasMultipleParts = archive.hasMultipleVolumes;
+    XCTAssertTrue(hasMultipleParts, @"Multi-volume archive's first part not reported to have multiple volumes");
+}
+#endif
+
+#if !TARGET_OS_IPHONE
+- (void)testMultipleVolume_UseMiddleVolume_OldNamingScheme {
+    NSArray<NSURL*> *volumeURLs = [self multiPartArchiveOldSchemeWithName:@"HasMultipleVolumesTests-testMultipleVolume_UseMiddleVolume_OldNamingScheme.rar"];
+    URKArchive *archive = [[URKArchive alloc] initWithURL:volumeURLs[2] error:nil];
+    
+    BOOL hasMultipleParts = archive.hasMultipleVolumes;
+    XCTAssertTrue(hasMultipleParts, @"Multi-volume archive's middle part not reported to have multiple volumes");
+}
+#endif
+
+- (void)testInvalidArchive {
+    URKArchive *archive = [[URKArchive alloc] initWithURL:self.testFileURLs[@"Test File A.txt"] error:nil];
+    
+    BOOL hasMultipleParts = archive.hasMultipleVolumes;
+    XCTAssertFalse(hasMultipleParts, @"Invalid archive reported to have multiple volumes");
+}
+
+@end