CCPackageManager's API changed.

An instance of a package can now be added to the manager to actually get managed without starting the whole installation life cycle.
Leading to a new method to start the download of a CCPackage instance which has already been added before.
The unzip delegate methods will return on the main thread now.
Some refactoring to attach installData with a method instead of code duplication.

Author: NickyWeber

cocos2d/CCPackageManager.h

@@ -82,6 +82,17 @@
  */
 - (CCPackage *)downloadPackageWithName:(NSString *)name resolution:(NSString *)resolution remoteURL:(NSURL *)remoteURL enableAfterDownload:(BOOL)enableAfterDownload;
 
+/**
+ * Downloads a package. This is supposed to work in conjunction with addPackage where a package is created without the package manager
+ * and should become managed.
+ * A download will only start if the status is CCPackageStatusInitial, CCPackageStatusDownloadFailed.
+ * A package with status CCPackageStatusDownloadPaused will be resumed if possible.
+ *
+ * @param name The package to be manager by the package manager
+ * @param enableAfterDownload If the package should be enabled in cocos2d after download. You can enable it with the enablePackage: method later on.
+ */
+- (BOOL)downloadPackage:(CCPackage *)package enableAfterDownload:(BOOL)enableAfterDownload;
+
 /**
  * Disables a package. Only packages with state CCPackageStatusInstalledEnabled can be disabled.
  * The package is removed from cocos2d's search, sprite sheets and filename lookups are reloaded.
@@ -105,6 +116,13 @@
  */
 - (BOOL)enablePackage:(CCPackage *)package error:(NSError **)error;
 
+/**
+ * Adds a package to the package manager. Only packages with status initial can be added.
+ *
+ * @param package The package to be added to the package manager
+ */
+- (void)addPackage:(CCPackage *)package;
+
 /**
  * Deletes a package.
  * Will disable the package first and delete it from disk. Temp download and unzip files will be removed as well.

cocos2d/CCPackageManager.m

@@ -188,18 +188,35 @@ - (CCPackage *)downloadPackageWithName:(NSString *)name resolution:(NSString *)r
     return [self downloadPackageWithName:name resolution:resolution remoteURL:remoteURL enableAfterDownload:enableAfterDownload];
 }
 
-- (NSString *)currentOS
+- (BOOL)downloadPackage:(CCPackage *)package enableAfterDownload:(BOOL)enableAfterDownload
 {
-#ifdef __CC_PLATFORM_IOS
-    return @"iOS";
+    if (![_packages containsObject:package])
+    {
+        return NO;
+    }
 
-#elif defined(__CC_PLATFORM_MAC)
-    return @"Mac";
+    NSAssert(package, @"package must not be nil");
+    NSAssert(package.name, @"package.name must not be nil");
+    NSAssert(package.resolution, @"package.resolution must not be nil");
 
-#elif defined(__CC_PLATFORM_ANDROID)
-    return @"Android";
+    if (!package.remoteURL && !_baseURL)
+    {
+        return NO;
+    }
+    else if (!package.remoteURL)
+    {
+        NSString *packageName = [NSString stringWithFormat:@"%@-%@-%@.zip", package.name, package.os, package.resolution];
+        NSURL *remoteURL = [_baseURL URLByAppendingPathComponent:packageName];
+        [package setValue:remoteURL forKey:@"remoteURL"];
+    }
+
+    [self attachNewInstallDataToPackage:package enableAfterDownload:enableAfterDownload];
+
+    CCLOGINFO(@"[PACKAGE][INFO]: adding package to download queue: %@", package);
 
-#endif
+    [_downloadManager enqueuePackageForDownload:package];
+
+    return YES;
 }
 
 - (CCPackage *)downloadPackageWithName:(NSString *)name resolution:(NSString *)resolution remoteURL:(NSURL *)remoteURL enableAfterDownload:(BOOL)enableAfterDownload
@@ -210,10 +227,8 @@ - (CCPackage *)downloadPackageWithName:(NSString *)name resolution:(NSString *)r
         return aPackage;
     }
 
-    CCPackageInstallData *installData = [[CCPackageInstallData alloc] initWithPackage:package];
-    installData.enableOnDownload = enableAfterDownload;
-    [package setInstallData:installData];
     CCPackage *package = [[CCPackage alloc] initWithName:name resolution:resolution remoteURL:remoteURL];
+    [self attachNewInstallDataToPackage:package enableAfterDownload:enableAfterDownload];
 
     [_packages addObject:package];
 
@@ -224,6 +239,13 @@ - (CCPackage *)downloadPackageWithName:(NSString *)name resolution:(NSString *)r
     return package;
 }
 
+- (void)attachNewInstallDataToPackage:(CCPackage *)package enableAfterDownload:(BOOL)enableAfterDownload
+{
+    CCPackageInstallData *installData = [[CCPackageInstallData alloc] initWithPackage:package];
+    installData.enableOnDownload = enableAfterDownload;
+    [package setInstallData:installData];
+}
+
 - (CCPackage *)packageWithName:(NSString *)name resolution:(NSString *)resolution
 {
     for (CCPackage *aPackage in _packages)
@@ -266,38 +288,47 @@ - (void)downloadProgressOfPackage:(CCPackage *)package downloadedBytes:(NSUInteg
 
 - (void)unzipFinished:(CCPackageUnzipper *)packageUnzipper
 {
-    [self removeDownloadFile:packageUnzipper.package];
+    [self runOnMainQueue:^
+    {
+        [self removeDownloadFile:packageUnzipper.package];
 
-    [_unzipTasks removeObject:packageUnzipper];
+        [_unzipTasks removeObject:packageUnzipper];
 
-    [packageUnzipper.package setValue:@(CCPackageStatusUnzipped) forKey:@"status"];
+        [packageUnzipper.package setValue:@(CCPackageStatusUnzipped) forKey:@"status"];
 
-    if ([_delegate respondsToSelector:@selector(packageUnzippingFinished:)])
-    {
-        [_delegate packageUnzippingFinished:packageUnzipper.package];
-    }
+        if ([_delegate respondsToSelector:@selector(packageUnzippingFinished:)])
+        {
+            [_delegate packageUnzippingFinished:packageUnzipper.package];
+        }
 
-    if (![self installPackage:packageUnzipper.package])
-    {
-        return;
-    }
+        if (![self installPackage:packageUnzipper.package])
+        {
+            return;
+        }
 
-    [self tidyUpAfterInstallation:packageUnzipper.package];
+        [self tidyUpAfterInstallation:packageUnzipper.package];
+    }];
 }
 
 - (void)unzipFailed:(CCPackageUnzipper *)packageUnzipper error:(NSError *)error
 {
-    [_unzipTasks removeObject:packageUnzipper];
+    [self runOnMainQueue:^
+    {
+        [_unzipTasks removeObject:packageUnzipper];
 
-    [_delegate packageUnzippingFailed:packageUnzipper.package error:error];
+        [_delegate packageUnzippingFailed:packageUnzipper.package error:error];
+    }];
 }
 
 - (void)unzipProgress:(CCPackageUnzipper *)packageUnzipper unzippedBytes:(NSUInteger)unzippedBytes totalBytes:(NSUInteger)totalBytes
 {
-    if ([_delegate respondsToSelector:@selector(packageUnzippingProgress:unzippedBytes:totalBytes:)])
+    [self runOnMainQueue:^
     {
-        [_delegate packageUnzippingProgress:packageUnzipper.package unzippedBytes:unzippedBytes totalBytes:totalBytes];
-    }
+        if ([_delegate respondsToSelector:@selector(packageUnzippingProgress:unzippedBytes:totalBytes:)])
+        {
+            [_delegate packageUnzippingProgress:packageUnzipper.package unzippedBytes:unzippedBytes totalBytes:totalBytes];
+        }
+    }];
 }
 
 
@@ -383,6 +414,7 @@ - (BOOL)installPackage:(CCPackage *)package
     {
         CCLOG(@"[PACKAGE][ERROR] Installation failed: %@", error);
 
+        [package setValue:@(CCPackageStatusInstallationFailed) forKey:NSStringFromSelector(@selector(status))];
         [_delegate packageInstallationFailed:package error:error];
         return NO;
     }
@@ -551,13 +583,27 @@ - (BOOL)enablePackage:(CCPackage *)package error:(NSError **)error
     return YES;
 }
 
+- (void)addPackage:(CCPackage *)package;
+{
+    NSAssert(package, @"package must not be nil");
+    NSAssert(package.status == CCPackageStatusInitial, @"package status must be CCPackageStatusInitial");
+
+    if ([_packages containsObject:package]
+        || [self packageWithName:package.name resolution:package.resolution])
+    {
+        return;
+    }
+
+    [_packages addObject:package];
+}
+
 - (BOOL)deletePackage:(CCPackage *)package error:(NSError **)error
 {
     CCPackageCocos2dEnabler *packageCocos2dEnabler = [[CCPackageCocos2dEnabler alloc] init];
     [packageCocos2dEnabler disablePackages:@[package]];
 
     [_packages removeObject:package];
-    [self storePackages];
+    [self savePackages];
 
     [_downloadManager cancelDownloadOfPackage:package];
 
@@ -599,7 +645,7 @@ - (void)cancelDownloadOfPackage:(CCPackage *)package
 
     [_downloadManager cancelDownloadOfPackage:package];
 
-    [self storePackages];
+    [self savePackages];
 }
 
 - (void)pauseDownloadOfPackage:(CCPackage *)package
@@ -630,4 +676,16 @@ - (void)request:(NSMutableURLRequest *)request ofPackage:(CCPackage *)package
     }
 }
 
+- (void)runOnMainQueue:(dispatch_block_t)block
+{
+    if ([NSThread isMainThread])
+    {
+        block();
+    }
+    else
+    {
+        dispatch_sync(dispatch_get_main_queue(), block);
+    }
+}
+
 @end

cocos2d/CCPackageManagerDelegate.h

@@ -53,15 +53,13 @@
 
 /**
  *  Only called when the process of unzipping finished successfully
- *  Note: This method will most likely return on a different thread than the main thread depending on the queue set for unzipping.
  *
  *  @param package The package for which the unzip process finished
  */
 - (void)packageUnzippingFinished:(CCPackage *)package;
 
 /**
  *  Only called when the process of unzipping failed
- *  Note: This method will most likely return on a different thread than the main thread depending on the queue set for unzipping.
  *
  *  @param package The package for which the unzip process failed
  *  @param error Pointer to an error object
@@ -71,8 +69,6 @@
 @optional
 /**
  *  Called whenever the process of unzipping reports a progress in bytes
- *  Note: This method will most likely return on a different thread than the main thread depending on the queue set for unzipping.
- *
  *
  *  @param package The package for which the unzip progress occured
  *  @param unzippedBytes Unzip progress in bytes