feat(scheme-handler): Improve memory usage & Range support (apache#1481)

sonlichao · dodahoho · sonlichao · commit af6130e695a1 · 2025-10-21T12:56:56.000+09:00
* refactor(schemes): Read files on a background thread Closes apacheGH-909. * feat(schemes): Support range requests Based on code from ionic-team/cordova-plugin-ionic-webview#692 Closes apacheGH-1033. Co-Authored-By: David Holmgren <dodahoho@users.noreply.github.com> --------- Co-authored-by: David Holmgren <dodahoho@users.noreply.github.com>
diff --git a/CordovaLib/Classes/Private/Plugins/CDVWebViewEngine/CDVWebViewEngine.m b/CordovaLib/Classes/Private/Plugins/CDVWebViewEngine/CDVWebViewEngine.m
@@ -217,7 +217,7 @@ - (void)pluginInitialize
 
     // Do not configure the scheme handler if the scheme is default (file)
     if(!self.cdvIsFileScheme) {
-        self.schemeHandler = [[CDVURLSchemeHandler alloc] initWithVC:vc];
+        self.schemeHandler = [[CDVURLSchemeHandler alloc] initWithViewController:self.viewController];
         [configuration setURLSchemeHandler:self.schemeHandler forURLScheme:scheme];
     }
 
diff --git a/CordovaLib/Classes/Public/CDVURLSchemeHandler.m b/CordovaLib/Classes/Public/CDVURLSchemeHandler.m
@@ -19,119 +19,277 @@ Licensed to the Apache Software Foundation (ASF) under one
 
 
 #import <Cordova/CDVURLSchemeHandler.h>
+#import <Cordova/CDVViewController.h>
+#import <Cordova/CDVPlugin.h>
+#import <Foundation/Foundation.h>
 #import <MobileCoreServices/MobileCoreServices.h>
 
 #import <objc/message.h>
 
-@implementation CDVURLSchemeHandler
+#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 140000
+#import <UniformTypeIdentifiers/UniformTypeIdentifiers.h>
+#endif
+
+static const NSUInteger FILE_BUFFER_SIZE = 1024 * 1024 * 4; // 4 MiB
+
+@interface CDVURLSchemeHandler ()
+
+@end
 
+@implementation CDVURLSchemeHandler
 
-- (instancetype)initWithVC:(CDVViewController *)controller
+- (instancetype)initWithViewController:(CDVViewController *)controller
 {
     self = [super init];
     if (self) {
         _viewController = controller;
+        _handlerMap = [NSMapTable weakToWeakObjectsMapTable];
     }
     return self;
 }
 
 - (void)webView:(WKWebView *)webView startURLSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask
 {
-    NSString * startPath = [[NSBundle mainBundle] pathForResource:self.viewController.wwwFolderName ofType: nil];
-    NSURL * url = urlSchemeTask.request.URL;
-    NSString * stringToLoad = url.path;
-    NSString * scheme = url.scheme;
-    
-    CDVViewController* vc = (CDVViewController*)self.viewController;
-
-    /*
-     * Give plugins the chance to handle the url
-     */
-    BOOL anyPluginsResponded = NO;
-    BOOL handledRequest = NO;
-
-    NSDictionary *pluginObjects = [[vc pluginObjects] copy];
+    // Give plugins the chance to handle the url
+    NSDictionary *pluginObjects = [[self.viewController pluginObjects] copy];
     for (NSString* pluginName in pluginObjects) {
-        self.schemePlugin = [vc.pluginObjects objectForKey:pluginName];
+        CDVPlugin *plugin = [self.viewController.pluginObjects objectForKey:pluginName];
         SEL selector = NSSelectorFromString(@"overrideSchemeTask:");
-        if ([self.schemePlugin respondsToSelector:selector]) {
-            handledRequest = (((BOOL (*)(id, SEL, id <WKURLSchemeTask>))objc_msgSend)(self.schemePlugin, selector, urlSchemeTask));
+        if ([plugin respondsToSelector:selector]) {
+            BOOL handledRequest = (((BOOL (*)(id, SEL, id <WKURLSchemeTask>))objc_msgSend)(plugin, selector, urlSchemeTask));
             if (handledRequest) {
-                anyPluginsResponded = YES;
-                break;
+                // Store the plugin that is handling this particular request
+                [self.handlerMap setObject:plugin forKey:urlSchemeTask];
+                return;
             }
         }
     }
 
-    if (!anyPluginsResponded) {
-        if ([scheme isEqualToString:self.viewController.appScheme]) {
-            if ([stringToLoad hasPrefix:@"/_app_file_"]) {
-                startPath = [stringToLoad stringByReplacingOccurrencesOfString:@"/_app_file_" withString:@""];
-            } else {
-                if ([stringToLoad isEqualToString:@""] || [url.pathExtension isEqualToString:@""]) {
-                    startPath = [startPath stringByAppendingPathComponent:self.viewController.startPage];
-                } else {
-                    startPath = [startPath stringByAppendingPathComponent:stringToLoad];
-                }
+    NSURLRequest *req = urlSchemeTask.request;
+    if (![req.URL.scheme isEqualToString:self.viewController.appScheme]) {
+        return;
+    }
+
+    // Indicate that we are handling this task, by adding an entry with a null plugin
+    // We do this so that we can (in future) detect if the task is cancelled before we finished feeding it response data
+    [self.handlerMap setObject:(id)[NSNull null] forKey:urlSchemeTask];
+
+    [self.viewController.commandDelegate runInBackground:^{
+        NSURL *fileURL = [self fileURLForRequestURL:req.URL];
+        NSError *error;
+
+        NSFileHandle *fileHandle = [NSFileHandle fileHandleForReadingFromURL:fileURL error:&error];
+        if (!fileHandle || error) {
+            if ([self taskActive:urlSchemeTask]) {
+                [urlSchemeTask didFailWithError:error];
             }
-        }
 
-        NSError * fileError = nil;
-        NSData * data = nil;
-        if ([self isMediaExtension:url.pathExtension]) {
-            data = [NSData dataWithContentsOfFile:startPath options:NSDataReadingMappedIfSafe error:&fileError];
+            @synchronized(self.handlerMap) {
+                [self.handlerMap removeObjectForKey:urlSchemeTask];
+            }
+            return;
         }
-        if (!data || fileError) {
-            data =  [[NSData alloc] initWithContentsOfFile:startPath];
+
+        NSInteger statusCode = 200; // Default to 200 OK status
+        NSString *mimeType = [self getMimeType:fileURL] ?: @"application/octet-stream";
+        NSNumber *fileLength;
+        [fileURL getResourceValue:&fileLength forKey:NSURLFileSizeKey error:nil];
+
+        NSNumber *responseSize = fileLength;
+        NSUInteger responseSent = 0;
+
+        NSMutableDictionary *headers = [NSMutableDictionary dictionaryWithCapacity:5];
+        headers[@"Content-Type"] = mimeType;
+        headers[@"Cache-Control"] = @"no-cache";
+        headers[@"Content-Length"] = [responseSize stringValue];
+
+        // Check for Range header - only for media files
+        NSString *rangeHeader = [urlSchemeTask.request valueForHTTPHeaderField:@"Range"];
+        if (rangeHeader && [self isMediaFile:fileURL mimeType:mimeType]) {
+            NSRange range = NSMakeRange(NSNotFound, 0);
+
+            if ([rangeHeader hasPrefix:@"bytes="]) {
+                NSString *byteRange = [rangeHeader substringFromIndex:6];
+                NSArray<NSString *> *rangeParts = [byteRange componentsSeparatedByString:@"-"];
+                NSUInteger start = (NSUInteger)[rangeParts[0] integerValue];
+                NSUInteger end = rangeParts.count > 1 && ![rangeParts[1] isEqualToString:@""] ? (NSUInteger)[rangeParts[1] integerValue] : [fileLength unsignedIntegerValue] - 1;
+                range = NSMakeRange(start, end - start + 1);
+            }
+
+            if (range.location != NSNotFound) {
+                // Ensure range is valid
+                if (range.location >= [fileLength unsignedIntegerValue] && [self taskActive:urlSchemeTask]) {
+                    headers[@"Content-Range"] = [NSString stringWithFormat:@"bytes */%@", fileLength];
+                    NSHTTPURLResponse *response = [[NSHTTPURLResponse alloc] initWithURL:req.URL statusCode:416 HTTPVersion:@"HTTP/1.1" headerFields:headers];
+                    [urlSchemeTask didReceiveResponse:response];
+                    [urlSchemeTask didFinish];
+
+                    @synchronized(self.handlerMap) {
+                        [self.handlerMap removeObjectForKey:urlSchemeTask];
+                    }
+                    return;
+                }
+
+                [fileHandle seekToFileOffset:range.location];
+                responseSize = [NSNumber numberWithUnsignedInteger:range.length];
+                statusCode = 206; // Partial Content
+                headers[@"Content-Range"] = [NSString stringWithFormat:@"bytes %lu-%lu/%@", (unsigned long)range.location, (unsigned long)(range.location + range.length - 1), fileLength];
+                headers[@"Content-Length"] = [NSString stringWithFormat:@"%lu", (unsigned long)range.length];
+            }
         }
-        NSInteger statusCode = 200;
-        if (!data) {
-            statusCode = 404;
+
+        NSHTTPURLResponse *response = [[NSHTTPURLResponse alloc] initWithURL:req.URL statusCode:statusCode HTTPVersion:@"HTTP/1.1" headerFields:headers];
+        if ([self taskActive:urlSchemeTask]) {
+            [urlSchemeTask didReceiveResponse:response];
         }
-        NSURL * localUrl = [NSURL URLWithString:url.absoluteString];
-        NSString * mimeType = [self getMimeType:url.pathExtension];
-        id response = nil;
-        if (data && [self isMediaExtension:url.pathExtension]) {
-            response = [[NSURLResponse alloc] initWithURL:localUrl MIMEType:mimeType expectedContentLength:data.length textEncodingName:nil];
+
+        // Use chunked reading only for media files, otherwise read entire file
+        if ([self isMediaFile:fileURL mimeType:mimeType]) {
+            while ([self taskActive:urlSchemeTask] && responseSent < [responseSize unsignedIntegerValue]) {
+                @autoreleasepool {
+                    NSData *data = [self readFromFileHandle:fileHandle upTo:FILE_BUFFER_SIZE error:&error];
+                    if (!data || error) {
+                        if ([self taskActive:urlSchemeTask]) {
+                            [urlSchemeTask didFailWithError:error];
+                        }
+                        break;
+                    }
+
+                    if ([self taskActive:urlSchemeTask]) {
+                        [urlSchemeTask didReceiveData:data];
+                    }
+
+                    responseSent += data.length;
+                }
+            }
         } else {
-            NSDictionary * headers = @{ @"Content-Type" : mimeType, @"Cache-Control": @"no-cache"};
-            response = [[NSHTTPURLResponse alloc] initWithURL:localUrl statusCode:statusCode HTTPVersion:nil headerFields:headers];
+            // For non-media files, read entire file at once (original behavior)
+            NSData *data = [self readFromFileHandle:fileHandle upTo:[responseSize unsignedIntegerValue] error:&error];
+            if (data && [self taskActive:urlSchemeTask]) {
+                [urlSchemeTask didReceiveData:data];
+            } else if (error && [self taskActive:urlSchemeTask]) {
+                [urlSchemeTask didFailWithError:error];
+            }
         }
 
-        [urlSchemeTask didReceiveResponse:response];
-        if (data) {
-            [urlSchemeTask didReceiveData:data];
+        [fileHandle closeFile];
+
+        if ([self taskActive:urlSchemeTask]) {
+            [urlSchemeTask didFinish];
         }
-        [urlSchemeTask didFinish];
-    }
+
+        @synchronized(self.handlerMap) {
+            [self.handlerMap removeObjectForKey:urlSchemeTask];
+        }
+    }];
 }
 
 - (void)webView:(nonnull WKWebView *)webView stopURLSchemeTask:(nonnull id<WKURLSchemeTask>)urlSchemeTask
 {
+    CDVPlugin *plugin;
+    @synchronized(self.handlerMap) {
+        plugin = [self.handlerMap objectForKey:urlSchemeTask];
+    }
+
+    if (![plugin isEqual:[NSNull null]] && [plugin respondsToSelector:@selector(stopSchemeTask:)]) {
     SEL selector = NSSelectorFromString(@"stopSchemeTask:");
-    if (self.schemePlugin != nil && [self.schemePlugin respondsToSelector:selector]) {
-        (((void (*)(id, SEL, id <WKURLSchemeTask>))objc_msgSend)(self.schemePlugin, selector, urlSchemeTask));
+        (((void (*)(id, SEL, id <WKURLSchemeTask>))objc_msgSend)(plugin, selector, urlSchemeTask));
+    }
+
+    @synchronized(self.handlerMap) {
+        [self.handlerMap removeObjectForKey:urlSchemeTask];
     }
 }
 
--(NSString *) getMimeType:(NSString *)fileExtension {
-    if (fileExtension && ![fileExtension isEqualToString:@""]) {
-        NSString *UTI = (__bridge_transfer NSString *)UTTypeCreatePreferredIdentifierForTag(kUTTagClassFilenameExtension, (__bridge CFStringRef)fileExtension, NULL);
-        NSString *contentType = (__bridge_transfer NSString *)UTTypeCopyPreferredTagWithClass((__bridge CFStringRef)UTI, kUTTagClassMIMEType);
-        return contentType ? contentType : @"application/octet-stream";
+#pragma mark - Utility methods
+
+- (NSURL *)fileURLForRequestURL:(NSURL *)url
+{
+    NSURL *resDir = [[NSBundle mainBundle] URLForResource:self.viewController.wwwFolderName withExtension:nil];
+    NSURL *filePath;
+
+    if ([url.path hasPrefix:@"/_app_file_"]) {
+        NSString *path = [url.path stringByReplacingOccurrencesOfString:@"/_app_file_" withString:@""];
+        filePath = [resDir URLByAppendingPathComponent:path];
     } else {
-        return @"text/html";
+        if ([url.path isEqualToString:@""] || [url.pathExtension isEqualToString:@""]) {
+            filePath = [resDir URLByAppendingPathComponent:self.viewController.startPage];
+        } else {
+            filePath = [resDir URLByAppendingPathComponent:url.path];
+        }
+    }
+
+    return filePath.URLByStandardizingPath;
+}
+
+-(NSString *)getMimeType:(NSURL *)url
+{
+#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 140000
+    if (@available(iOS 14.0, *)) {
+        UTType *uti;
+        [url getResourceValue:&uti forKey:NSURLContentTypeKey error:nil];
+        return [uti preferredMIMEType];
+    }
+#endif
+
+    NSString *type;
+    [url getResourceValue:&type forKey:NSURLTypeIdentifierKey error:nil];
+    return (NSString *)UTTypeCopyPreferredTagWithClass((CFStringRef)type, kUTTagClassMIMEType);
+}
+
+- (nullable NSData *)readFromFileHandle:(NSFileHandle *)handle upTo:(NSUInteger)length error:(NSError **)err
+{
+#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 140000
+    if (@available(iOS 14.0, *)) {
+        return [handle readDataUpToLength:length error:err];
+    }
+#endif
+
+    @try {
+        return [handle readDataOfLength:length];
+    }
+    @catch (NSError *error) {
+        if (err != nil) {
+            *err = error;
+        }
+        return nil;
+    }
+}
+
+- (BOOL)taskActive:(id <WKURLSchemeTask>)task
+{
+    @synchronized(self.handlerMap) {
+        return [self.handlerMap objectForKey:task] != nil;
     }
 }
 
--(BOOL) isMediaExtension:(NSString *) pathExtension {
-    NSArray * mediaExtensions = @[@"m4v", @"mov", @"mp4",
-                           @"aac", @"ac3", @"aiff", @"au", @"flac", @"m4a", @"mp3", @"wav"];
+- (BOOL)isMediaExtension:(NSString *)pathExtension
+{
+    NSArray *mediaExtensions = @[@"m4v", @"mov", @"mp4", @"mpeg",
+                           @"aac", @"ac3", @"aiff", @"au", @"flac", @"m4a", @"mp3", @"wav", @"wave"];
     if ([mediaExtensions containsObject:pathExtension.lowercaseString]) {
         return YES;
     }
     return NO;
 }
 
+- (BOOL)isMediaFile:(NSURL *)fileURL mimeType:(NSString *)mimeType
+{
+    // Check by file extension
+    if ([self isMediaExtension:fileURL.pathExtension]) {
+        return YES;
+    }
+    
+    // Check by MIME type
+    NSArray *audioMimeTypes = @[@"audio/m4a", @"audio/mp3", @"audio/mp4", @"audio/mpeg", @"audio/vnd.wave", @"audio/wav"];
+    NSArray *videoMimeTypes = @[@"video/mp4", @"video/quicktime"];
+    
+    if ([audioMimeTypes containsObject:mimeType.lowercaseString] || 
+        [videoMimeTypes containsObject:mimeType.lowercaseString]) {
+        return YES;
+    }
+    
+    return NO;
+}
 
 @end
diff --git a/CordovaLib/Classes/Public/CDVViewController.m b/CordovaLib/Classes/Public/CDVViewController.m
@@ -164,6 +164,8 @@ - (void)loadSettings
         self.startPage = @"index.html";
     }
 
+    self.appScheme = [self.settings cordovaSettingForKey:@"Scheme"] ?: @"app";
+
     // Initialize the plugin objects dict.
     self.pluginObjects = [[NSMutableDictionary alloc] initWithCapacity:20];
 }
diff --git a/CordovaLib/include/Cordova/CDVURLSchemeHandler.h b/CordovaLib/include/Cordova/CDVURLSchemeHandler.h
@@ -24,11 +24,11 @@
 
 @interface CDVURLSchemeHandler : NSObject <WKURLSchemeHandler>
 
-@property (nonatomic, weak) CDVViewController* viewController;
+@property (nonatomic, assign) CDVViewController* viewController;
 
-@property (nonatomic) CDVPlugin* schemePlugin;
+@property (nonatomic, strong) NSMapTable <id <WKURLSchemeTask>, CDVPlugin *> *handlerMap;
 
-- (instancetype)initWithVC:(CDVViewController *)controller;
+- (instancetype)initWithViewController:(CDVViewController *)controller;
 
 
 @end
diff --git a/CordovaLib/include/Cordova/CDVViewController.h b/CordovaLib/include/Cordova/CDVViewController.h
@@ -65,7 +65,20 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, readonly, strong) NSMutableDictionary* settings;
 @property (nonatomic, readonly, strong) NSXMLParser* configParser;
 
-@property (nonatomic, readwrite, copy) NSString* appScheme;
+/*
+ The scheme being used to load web content from the app bundle into the Cordova
+ web view.
+
+ The default value is `app` but can be customized via the `Scheme` preference
+ in the Cordova XML configuration file. Setting this to `file` will results in
+ web content being loaded using the File URL protocol, which has inherent
+ security limitations. It is encouraged that you use a custom scheme to load
+ your app content.
+
+ It is not valid to set this to an existing protocol scheme such as `http` or
+ `https`.
+ */
+@property (nonatomic, nullable, readwrite, copy) NSString* appScheme;
 @property (nonatomic, readwrite, copy) NSString* configFile;
 @property (nonatomic, readwrite, copy) NSString* wwwFolderName;
 @property (nonatomic, readwrite, copy) NSString* startPage;
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ - (void)pluginInitialize`
`217`	`217`
`218`	`218`	`// Do not configure the scheme handler if the scheme is default (file)`
`219`	`219`	`if(!self.cdvIsFileScheme) {`
`220`		`- self.schemeHandler = [[CDVURLSchemeHandler alloc] initWithVC:vc];`
	`220`	`+ self.schemeHandler = [[CDVURLSchemeHandler alloc] initWithViewController:self.viewController];`
`221`	`221`	`[configuration setURLSchemeHandler:self.schemeHandler forURLScheme:scheme];`
`222`	`222`	`}`
`223`	`223`
Original file line number	Diff line number	Diff line change
`@@ -164,6 +164,8 @@ - (void)loadSettings`
`164`	`164`	`self.startPage = @"index.html";`
`165`	`165`	`}`
`166`	`166`
	`167`	`+ self.appScheme = [self.settings cordovaSettingForKey:@"Scheme"] ?: @"app";`
	`168`	`+`
`167`	`169`	`// Initialize the plugin objects dict.`
`168`	`170`	`self.pluginObjects = [[NSMutableDictionary alloc] initWithCapacity:20];`
`169`	`171`	`}`