Merge pull request #670 from OneSignal/fix/file-type-detection

emawby · web-flow · commit 1ea798f67903 · 2020-05-27T09:54:15.000-07:00
Improving file type detection for attachments
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp.xcodeproj/xcshareddata/xcschemes/OneSignalDevApp.xcscheme b/iOS_SDK/OneSignalDevApp/OneSignalDevApp.xcodeproj/xcshareddata/xcschemes/OneSignalDevApp.xcscheme
@@ -26,10 +26,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
-      <Testables>
-      </Testables>
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -46,12 +43,23 @@
             isEnabled = "YES">
          </AdditionalOption>
       </AdditionalOptions>
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "911E2CB91E398AB3003112A4"
+               BuildableName = "UnitTests.xctest"
+               BlueprintName = "UnitTests"
+               ReferencedContainer = "container:../OneSignalSDK/OneSignal.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
diff --git a/iOS_SDK/OneSignalSDK/Source/NSURL+OneSignal.h b/iOS_SDK/OneSignalSDK/Source/NSURL+OneSignal.h
@@ -31,4 +31,6 @@
 
 - (NSString *)valueFromQueryParameter:(NSString *)parameter;
 
+- (NSString *)supportedFileExtensionFromQueryItems;
+
 @end
diff --git a/iOS_SDK/OneSignalSDK/Source/NSURL+OneSignal.m b/iOS_SDK/OneSignalSDK/Source/NSURL+OneSignal.m
@@ -26,15 +26,38 @@
  */
 
 #import "NSURL+OneSignal.h"
+#import "OneSignalCommonDefines.h"
 
 @implementation NSURL (OneSignal)
 - (NSString *)valueFromQueryParameter:(NSString *)parameter {
     NSURLComponents *components = [NSURLComponents componentsWithURL:self resolvingAgainstBaseURL:false];
     
-    for(NSURLQueryItem *item in components.queryItems)
+    for (NSURLQueryItem *item in components.queryItems)
         if([item.name isEqualToString:parameter])
             return item.value;
     
     return nil;
 }
+
+- (NSString *)supportedFileExtensionFromQueryItems {
+    NSURLComponents *components = [NSURLComponents componentsWithURL:self resolvingAgainstBaseURL:false];
+    
+    for (NSURLQueryItem *item in [components.queryItems reverseObjectEnumerator]) {
+        NSString *value = item.value;
+        NSString *extension = [self findExtensionInParam:value];
+        if (extension)
+            return extension;
+    }
+    return nil;
+}
+
+- (NSString*)findExtensionInParam:(NSString *)parameter {
+    NSArray *paramComponents = [parameter componentsSeparatedByString:@"."];
+    for (NSString *component in [paramComponents reverseObjectEnumerator]) {
+        if ([ONESIGNAL_SUPPORTED_ATTACHMENT_TYPES containsObject:component])
+            return component;
+    }
+    return nil;
+}
+
 @end
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignalCommonDefines.h b/iOS_SDK/OneSignalSDK/Source/OneSignalCommonDefines.h
@@ -238,4 +238,6 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE} HTTPMethod;
 // variance and floating-point error.
 #define OS_ROUGHLY_EQUAL(left, right) (fabs(left - right) < 0.03)
 
+#define MAX_NOTIFICATION_MEDIA_SIZE_BYTES 50000000
+
 #endif /* OneSignalCommonDefines_h */
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignalHelper.m b/iOS_SDK/OneSignalSDK/Source/OneSignalHelper.m
@@ -79,8 +79,13 @@ -(void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataT
     [outputHandle writeData:data];
 }
 
--(void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)aResponse completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
+- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)aResponse completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
     response = aResponse;
+    long long expectedLength = response.expectedContentLength;
+    if (expectedLength > MAX_NOTIFICATION_MEDIA_SIZE_BYTES) { //Enforcing 50 mb limit on media before downloading
+        completionHandler(NSURLSessionResponseCancel);
+        return;
+    }
     completionHandler(NSURLSessionResponseAllow);
 }
 
@@ -777,29 +782,14 @@ + (void)addNotificationRequest:(OSNotificationPayload*)payload
 /*
  Synchroneously downloads an attachment
  On success returns bundle resource name, otherwise returns nil
- The preference order for file type determination is as follows:
-    1. File extension in the actual URL
-    2. MIME type
-    3. URL Query parameter called 'filename', such as test.jpg. The SDK will extract the file extension from it
 */
-+ (NSString*)downloadMediaAndSaveInBundle:(NSString*)urlString {
++ (NSString *)downloadMediaAndSaveInBundle:(NSString *)urlString {
     
     let url = [NSURL URLWithString:urlString];
-    
-    NSString* extension = url.pathExtension;
-    
-    if ([extension isEqualToString:@""])
-        extension = nil;
-    
-    // Unrecognized extention
-    if (extension != nil && ![ONESIGNAL_SUPPORTED_ATTACHMENT_TYPES containsObject:extension])
-        return nil;
-    
+     
+    //Download the file
     var name = [self randomStringWithLength:10];
-    
-    if (extension)
-        name = [name stringByAppendingString:[NSString stringWithFormat:@".%@", extension]];
-    
+        
     NSArray* paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
     NSString* filePath = [paths[0] stringByAppendingPathComponent:name];
     
@@ -813,33 +803,24 @@ + (NSString*)downloadMediaAndSaveInBundle:(NSString*)urlString {
             [OneSignal onesignal_Log:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"Encountered an error while attempting to download file with URL: %@", error]];
             return nil;
         }
+
+        NSString *extension = [OneSignalHelper getSupportedFileExtensionFromURL:url mimeType:mimeType];
+        if (!extension || [extension isEqualToString:@""])
+            return nil;
         
-        if (!extension) {
-            NSString *newExtension;
-            
-            if (mimeType != nil && ![mimeType isEqualToString:@""]) {
-                newExtension = mimeType.fileExtensionForMimeType;
-            } else {
-                newExtension = [[[NSURL URLWithString:urlString] valueFromQueryParameter:@"filename"] supportedFileExtension];
-            }
-            
-            if (!newExtension || ![ONESIGNAL_SUPPORTED_ATTACHMENT_TYPES containsObject:newExtension])
-                return nil;
-            
-            name = [NSString stringWithFormat:@"%@.%@", name, newExtension];
-            
-            let newPath = [paths[0] stringByAppendingPathComponent:[NSString stringWithFormat:@"%@", name]];
-            
-            [[NSFileManager defaultManager] moveItemAtPath:filePath toPath:newPath error:&error];
-        }
+        name = [NSString stringWithFormat:@"%@.%@", name, extension];
+        
+        let newPath = [paths[0] stringByAppendingPathComponent:[NSString stringWithFormat:@"%@", name]];
+        
+        [[NSFileManager defaultManager] moveItemAtPath:filePath toPath:newPath error:&error];
         
         if (error) {
             [OneSignal onesignal_Log:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"Encountered an error while attempting to download file with URL: %@", error]];
             return nil;
         }
-        
+         
         let standardUserDefaults = OneSignalUserDefaults.initStandard;
-        
+         
         NSArray* cachedFiles = [standardUserDefaults getSavedObjectForKey:OSUD_TEMP_CACHED_NOTIFICATION_MEDIA defaultValue:nil];
         NSMutableArray* appendedCache;
         if (cachedFiles) {
@@ -848,15 +829,49 @@ + (NSString*)downloadMediaAndSaveInBundle:(NSString*)urlString {
         }
         else
             appendedCache = [[NSMutableArray alloc] initWithObjects:name, nil];
-        
+         
         [standardUserDefaults saveObjectForKey:OSUD_TEMP_CACHED_NOTIFICATION_MEDIA withValue:appendedCache];
         return name;
     } @catch (NSException *exception) {
         [OneSignal onesignal_Log:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"OneSignal encountered an exception while downloading file (%@), exception: %@", url, exception.description]];
         
         return nil;
     }
+}
+
 
+/*
+ The preference order for file type determination is as follows:
+    1. URL Query parameter called 'filename', such as test.jpg. The SDK will extract the file extension from it
+    2. MIME type
+    3. File extension in the actual URL
+    4. A file extension extracted by searching through all URL Query parameters
+ */
++ (NSString *)getSupportedFileExtensionFromURL:(NSURL *)url mimeType:(NSString *)mimeType {
+    //Try to get extension from the filename parameter
+    NSString* extension = [[url valueFromQueryParameter:@"filename"]
+                            supportedFileExtension];
+    if (extension && [ONESIGNAL_SUPPORTED_ATTACHMENT_TYPES containsObject:extension]) {
+        return extension;
+    }
+    //Use the MIME type for the extension
+    if (mimeType != nil && ![mimeType isEqualToString:@""]) {
+        extension = mimeType.fileExtensionForMimeType;
+        if (extension && [ONESIGNAL_SUPPORTED_ATTACHMENT_TYPES containsObject:extension]) {
+            return extension;
+        }
+    }
+    //Try using url.pathExtension
+    extension =  url.pathExtension;
+    if (extension && [ONESIGNAL_SUPPORTED_ATTACHMENT_TYPES containsObject:extension]) {
+        return extension;
+    }
+    //Try getting an extension from the query
+    extension = url.supportedFileExtensionFromQueryItems;
+    if (extension && [ONESIGNAL_SUPPORTED_ATTACHMENT_TYPES containsObject:extension]) {
+        return extension;
+    }
+    return nil;
 }
 
 // TODO: Add back after testing
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/Shadows/NSURLSessionOverrider.m b/iOS_SDK/OneSignalSDK/UnitTests/Shadows/NSURLSessionOverrider.m
@@ -50,8 +50,8 @@ + (NSString *)overrideDownloadItemAtURL:(NSURL*)url toFile:(NSString*)localPath
     
     if ([url.absoluteString isEqualToString:@"http://domain.com/file"])
         return @"image/png";
-    else if ([url.absoluteString isEqualToString:@"http://domain.com/secondFile"])
-        return nil;
+    else if ([url.path isEqualToString:@"/secondFile"])
+        return @"image/heic";
     else
         return @"image/jpg";
 }
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/UnitTests.m b/iOS_SDK/OneSignalSDK/UnitTests/UnitTests.m
@@ -2136,16 +2136,7 @@ - (id)exampleNotificationJSONWithMediaURL:(NSString *)urlString {
                      }};
 }
 
-- (void)testExtractFileExtensionFromMimeType {
-    //test to make sure the MIME type parsing works correctly
-    //NSURLSessionOverrider returns image/png for this URL
-    id pngFormat = [self exampleNotificationJSONWithMediaURL:@"http://domain.com/file"];
-    
-    let downloadedPngFilename = [self deliverNotificationWithJSON:pngFormat].URL.lastPathComponent;
-    XCTAssertTrue([downloadedPngFilename.supportedFileExtension isEqualToString:@"png"]);
-}
-
-- (void)testExtractFileExtensionFromQueryParameter {
+- (void)testExtractFileExtensionFromFileNameQueryParameter {
     // we allow developers to add ?filename=test.jpg (for example) to attachment URL's in cases where there is no extension & no mime type
     // tests to make sure the SDK correctly extracts the file extension from the `filename` URL query parameter
     // NSURLSessionOverrider returns nil for this URL
@@ -2155,14 +2146,32 @@ - (void)testExtractFileExtensionFromQueryParameter {
     XCTAssertTrue([downloadedJpgFilename.supportedFileExtension isEqualToString:@"jpg"]);
 }
 
-- (void)testFileExtensionPrioritizesURLFileExtension {
-    //tests to make sure that the URL's file extension is prioritized above the MIME type and URL query param
-    //this attachment URL will have a file extension, a MIME type, and a filename query parameter. It should prioritize the URL file extension (gif)
+- (void)testExtractFileExtensionFromMimeType {
+    //test to make sure the MIME type parsing works correctly
+    //NSURLSessionOverrider returns image/png for this URL
+    id pngFormat = [self exampleNotificationJSONWithMediaURL:@"http://domain.com/file"];
+    
+    let downloadedPngFilename = [self deliverNotificationWithJSON:pngFormat].URL.lastPathComponent;
+    XCTAssertTrue([downloadedPngFilename.supportedFileExtension isEqualToString:@"png"]);
+}
+
+- (void)testFileExtensionPrioritizesFileNameParameter {
+    //tests to make sure that the filename query parameter is prioritized above the MIME type and URL extension
+    //this attachment URL will have a file extension, a MIME type, and a filename query parameter. It should prioritize the filename query parameter (png)
     //NSURLSessionOverrider returns image/png for this URL
     id gifFormat = [self exampleNotificationJSONWithMediaURL:@"http://domain.com/file.gif?filename=test.png"];
     
     let downloadedGifFilename = [self deliverNotificationWithJSON:gifFormat].URL.lastPathComponent;
-    XCTAssertTrue([downloadedGifFilename.supportedFileExtension isEqualToString:@"gif"]);
+    XCTAssertTrue([downloadedGifFilename.supportedFileExtension isEqualToString:@"png"]);
+}
+
+- (void)testExtractFileExtensionFromAnyParameter {
+    //test to make sure the fallback of parsing all parameters for a file type works correctly
+    //NSURLSessionOverrider returns an unallowed extension (heic) for this URL to test the fallback
+    id pngFormat = [self exampleNotificationJSONWithMediaURL:@"http://domain.com/secondFile?file=test.png&media=image&type=.fakeextension"];
+    
+    let downloadedPngFilename = [self deliverNotificationWithJSON:pngFormat].URL.lastPathComponent;
+    XCTAssertTrue([downloadedPngFilename.supportedFileExtension isEqualToString:@"png"]);
 }
 
 /*
