/* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import "CDVWebViewEngine.h" #import "CDVWebViewUIDelegate.h" #import "CDVWebViewProcessPoolFactory.h" #import #import "CDVURLSchemeHandler.h" #import #define CDV_BRIDGE_NAME @"cordova" #define CDV_WKWEBVIEW_FILE_URL_LOAD_SELECTOR @"loadFileURL:allowingReadAccessToURL:" @interface CDVWebViewWeakScriptMessageHandler : NSObject @property (nonatomic, weak, readonly) idscriptMessageHandler; - (instancetype)initWithScriptMessageHandler:(id)scriptMessageHandler; @end @interface CDVWebViewEngine () @property (nonatomic, strong, readwrite) UIView* engineWebView; @property (nonatomic, strong, readwrite) id uiDelegate; @property (nonatomic, weak) id weakScriptMessageHandler; @property (nonatomic, strong) CDVURLSchemeHandler * schemeHandler; @property (nonatomic, readwrite) NSString *CDV_ASSETS_URL; @property (nonatomic, readwrite) Boolean cdvIsFileScheme; @end // see forwardingTargetForSelector: selector comment for the reason for this pragma #pragma clang diagnostic ignored "-Wprotocol" @implementation CDVWebViewEngine @synthesize engineWebView = _engineWebView; - (instancetype)initWithFrame:(CGRect)frame { self = [super init]; if (self) { if (NSClassFromString(@"WKWebView") == nil) { return nil; } self.engineWebView = [[WKWebView alloc] initWithFrame:frame]; } return self; } - (WKWebViewConfiguration*) createConfigurationFromSettings:(NSDictionary*)settings { WKWebViewConfiguration* configuration = [[WKWebViewConfiguration alloc] init]; configuration.processPool = [[CDVWebViewProcessPoolFactory sharedFactory] sharedProcessPool]; if (settings == nil) { return configuration; } configuration.allowsInlineMediaPlayback = [settings cordovaBoolSettingForKey:@"AllowInlineMediaPlayback" defaultValue:NO]; // Set the media types that are required for user action for playback WKAudiovisualMediaTypes mediaType = WKAudiovisualMediaTypeAll; // default // targetMediaType will always exist, either from user's "config.xml" or default ("defaults.xml"). id targetMediaType = [settings cordovaSettingForKey:@"MediaTypesRequiringUserActionForPlayback"]; if ([targetMediaType isEqualToString:@"none"]) { mediaType = WKAudiovisualMediaTypeNone; } else if ([targetMediaType isEqualToString:@"audio"]) { mediaType = WKAudiovisualMediaTypeAudio; } else if ([targetMediaType isEqualToString:@"video"]) { mediaType = WKAudiovisualMediaTypeVideo; } else if ([targetMediaType isEqualToString:@"all"]) { mediaType = WKAudiovisualMediaTypeAll; } else { NSLog(@"Invalid \"MediaTypesRequiringUserActionForPlayback\" was detected. Fallback to default value of \"all\" types."); } configuration.mediaTypesRequiringUserActionForPlayback = mediaType; configuration.suppressesIncrementalRendering = [settings cordovaBoolSettingForKey:@"SuppressesIncrementalRendering" defaultValue:NO]; /* * If the old preference key "MediaPlaybackAllowsAirPlay" exists, use it or default to "YES". * Check if the new preference key "AllowsAirPlayForMediaPlayback" exists and overwrite the "MediaPlaybackAllowsAirPlay" value. */ BOOL allowsAirPlayForMediaPlayback = [settings cordovaBoolSettingForKey:@"MediaPlaybackAllowsAirPlay" defaultValue:YES]; if([settings cordovaSettingForKey:@"AllowsAirPlayForMediaPlayback"] != nil) { allowsAirPlayForMediaPlayback = [settings cordovaBoolSettingForKey:@"AllowsAirPlayForMediaPlayback" defaultValue:YES]; } configuration.allowsAirPlayForMediaPlayback = allowsAirPlayForMediaPlayback; /* * Sets Custom User Agents * - (Default) "userAgent" is set the the clean user agent. * E.g. * UserAgent = "Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148" * * - If "OverrideUserAgent" is set, it will overwrite the entire "userAgent" value. The "AppendUserAgent" will be iggnored if set. * Notice: The override logic is handled in the "pluginInitialize" method. * E.g. * OverrideUserAgent = "foobar" * UserAgent = "foobar" * * - If "AppendUserAgent" is set and "OverrideUserAgent" is not set, the user defined "AppendUserAgent" will be appended to the "userAgent" * E.g. * AppendUserAgent = "foobar" * UserAgent = "Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148 foobar" */ NSString *userAgent = configuration.applicationNameForUserAgent; if ( [settings cordovaSettingForKey:@"OverrideUserAgent"] == nil && [settings cordovaSettingForKey:@"AppendUserAgent"] != nil ) { userAgent = [NSString stringWithFormat:@"%@ %@", userAgent, [settings cordovaSettingForKey:@"AppendUserAgent"]]; } configuration.applicationNameForUserAgent = userAgent; if (@available(iOS 13.0, *)) { NSString *contentMode = [settings cordovaSettingForKey:@"PreferredContentMode"]; if ([contentMode isEqual: @"mobile"]) { configuration.defaultWebpagePreferences.preferredContentMode = WKContentModeMobile; } else if ([contentMode isEqual: @"desktop"]) { configuration.defaultWebpagePreferences.preferredContentMode = WKContentModeDesktop; } } return configuration; } - (void)pluginInitialize { // viewController would be available now. we attempt to set all possible delegates to it, by default CDVViewController* vc = (CDVViewController*)self.viewController; NSDictionary* settings = self.commandDelegate.settings; NSString *scheme = [settings cordovaSettingForKey:@"scheme"]; // If scheme is file or nil, then default to file scheme self.cdvIsFileScheme = [scheme isEqualToString: @"file"] || scheme == nil; NSString *hostname = @""; if(!self.cdvIsFileScheme) { if(scheme == nil || [WKWebView handlesURLScheme:scheme]){ scheme = @"app"; } vc.appScheme = scheme; hostname = [settings cordovaSettingForKey:@"hostname"]; if(hostname == nil){ hostname = @"localhost"; } self.CDV_ASSETS_URL = [NSString stringWithFormat:@"%@://%@", scheme, hostname]; } CDVWebViewUIDelegate* uiDelegate = [[CDVWebViewUIDelegate alloc] initWithTitle:[[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleDisplayName"]]; uiDelegate.allowNewWindows = [settings cordovaBoolSettingForKey:@"AllowNewWindows" defaultValue:NO]; self.uiDelegate = uiDelegate; CDVWebViewWeakScriptMessageHandler *weakScriptMessageHandler = [[CDVWebViewWeakScriptMessageHandler alloc] initWithScriptMessageHandler:self]; WKUserContentController* userContentController = [[WKUserContentController alloc] init]; [userContentController addScriptMessageHandler:weakScriptMessageHandler name:CDV_BRIDGE_NAME]; if(self.CDV_ASSETS_URL) { NSString *scriptCode = [NSString stringWithFormat:@"window.CDV_ASSETS_URL = '%@';", self.CDV_ASSETS_URL]; WKUserScript *wkScript = [[WKUserScript alloc] initWithSource:scriptCode injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:YES]; if (wkScript) { [userContentController addUserScript:wkScript]; } } WKWebViewConfiguration* configuration = [self createConfigurationFromSettings:settings]; configuration.userContentController = userContentController; // Do not configure the scheme handler if the scheme is default (file) if(!self.cdvIsFileScheme) { self.schemeHandler = [[CDVURLSchemeHandler alloc] initWithVC:vc]; [configuration setURLSchemeHandler:self.schemeHandler forURLScheme:scheme]; } // re-create WKWebView, since we need to update configuration WKWebView* wkWebView = [[WKWebView alloc] initWithFrame:self.engineWebView.frame configuration:configuration]; wkWebView.UIDelegate = self.uiDelegate; /* * This is where the "OverrideUserAgent" is handled. This will replace the entire UserAgent * with the user defined custom UserAgent. */ if ([settings cordovaSettingForKey:@"OverrideUserAgent"] != nil) { wkWebView.customUserAgent = [settings cordovaSettingForKey:@"OverrideUserAgent"]; } self.engineWebView = wkWebView; if ([self.viewController conformsToProtocol:@protocol(WKUIDelegate)]) { wkWebView.UIDelegate = (id )self.viewController; } if ([self.viewController conformsToProtocol:@protocol(WKNavigationDelegate)]) { wkWebView.navigationDelegate = (id )self.viewController; } else { wkWebView.navigationDelegate = (id )self; } if ([self.viewController conformsToProtocol:@protocol(WKScriptMessageHandler)]) { [wkWebView.configuration.userContentController addScriptMessageHandler:(id < WKScriptMessageHandler >)self.viewController name:CDV_BRIDGE_NAME]; } [self updateSettings:settings]; // check if content thread has died on resume NSLog(@"%@", @"CDVWebViewEngine will reload WKWebView if required on resume"); [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(onAppWillEnterForeground:) name:UIApplicationWillEnterForegroundNotification object:nil]; NSLog(@"Using WKWebView"); [self addURLObserver]; } - (void)onReset { [self addURLObserver]; } static void * KVOContext = &KVOContext; - (void)addURLObserver { if(!IsAtLeastiOSVersion(@"9.0")){ [self.webView addObserver:self forKeyPath:@"URL" options:0 context:KVOContext]; } } - (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context { if (context == KVOContext) { if (object == [self webView] && [keyPath isEqualToString: @"URL"] && [object valueForKeyPath:keyPath] == nil){ NSLog(@"URL is nil. Reloading WKWebView"); [(WKWebView*)_engineWebView reload]; } } else { [super observeValueForKeyPath:keyPath ofObject:object change:change context:context]; } } - (void) onAppWillEnterForeground:(NSNotification*)notification { if ([self shouldReloadWebView]) { NSLog(@"%@", @"CDVWebViewEngine reloading!"); [(WKWebView*)_engineWebView reload]; } } - (BOOL)shouldReloadWebView { WKWebView* wkWebView = (WKWebView*)_engineWebView; return [self shouldReloadWebView:wkWebView.URL title:wkWebView.title]; } - (BOOL)shouldReloadWebView:(NSURL*)location title:(NSString*)title { BOOL title_is_nil = (title == nil); BOOL location_is_blank = [[location absoluteString] isEqualToString:@"about:blank"]; BOOL reload = (title_is_nil || location_is_blank); #ifdef DEBUG NSLog(@"%@", @"CDVWebViewEngine shouldReloadWebView::"); NSLog(@"CDVWebViewEngine shouldReloadWebView title: %@", title); NSLog(@"CDVWebViewEngine shouldReloadWebView location: %@", [location absoluteString]); NSLog(@"CDVWebViewEngine shouldReloadWebView reload: %u", reload); #endif return reload; } - (id)loadRequest:(NSURLRequest*)request { if ([self canLoadRequest:request]) { // can load, differentiate between file urls and other schemes if(request.URL.fileURL && self.cdvIsFileScheme) { NSURL* readAccessUrl = [request.URL URLByDeletingLastPathComponent]; return [(WKWebView*)_engineWebView loadFileURL:request.URL allowingReadAccessToURL:readAccessUrl]; } else if (request.URL.fileURL) { NSURL* startURL = [NSURL URLWithString:((CDVViewController *)self.viewController).startPage]; NSString* startFilePath = [self.commandDelegate pathForResource:[startURL path]]; NSURL *url = [[NSURL URLWithString:self.CDV_ASSETS_URL] URLByAppendingPathComponent:request.URL.path]; if ([request.URL.path isEqualToString:startFilePath]) { url = [NSURL URLWithString:[NSString stringWithFormat:@"%@/%@", self.CDV_ASSETS_URL, startURL]]; } if(request.URL.query) { url = [NSURL URLWithString:[@"?" stringByAppendingString:request.URL.query] relativeToURL:url]; } if(request.URL.fragment) { url = [NSURL URLWithString:[@"#" stringByAppendingString:request.URL.fragment] relativeToURL:url]; } request = [NSURLRequest requestWithURL:url]; } return [(WKWebView*)_engineWebView loadRequest:request]; } else { // can't load, print out error NSString* errorHtml = [NSString stringWithFormat: @"" @"Error" @"
" @"

The WebView engine '%@' is unable to load the request: %@

" @"

Most likely the cause of the error is that the loading of file urls is not supported in iOS %@.

" @"
", NSStringFromClass([self class]), [request.URL description], [[UIDevice currentDevice] systemVersion] ]; return [self loadHTMLString:errorHtml baseURL:nil]; } } - (id)loadHTMLString:(NSString*)string baseURL:(NSURL*)baseURL { return [(WKWebView*)_engineWebView loadHTMLString:string baseURL:baseURL]; } - (NSURL*) URL { return [(WKWebView*)_engineWebView URL]; } - (BOOL) canLoadRequest:(NSURLRequest*)request { // See: https://issues.apache.org/jira/browse/CB-9636 SEL wk_sel = NSSelectorFromString(CDV_WKWEBVIEW_FILE_URL_LOAD_SELECTOR); // if it's a file URL, check whether WKWebView has the selector (which is in iOS 9 and up only) if (request.URL.fileURL) { return [_engineWebView respondsToSelector:wk_sel]; } else { return YES; } } - (void)updateSettings:(NSDictionary*)settings { WKWebView* wkWebView = (WKWebView*)_engineWebView; wkWebView.configuration.preferences.minimumFontSize = [settings cordovaFloatSettingForKey:@"MinimumFontSize" defaultValue:0.0]; /* wkWebView.configuration.preferences.javaScriptEnabled = [settings cordovaBoolSettingForKey:@"JavaScriptEnabled" default:YES]; wkWebView.configuration.preferences.javaScriptCanOpenWindowsAutomatically = [settings cordovaBoolSettingForKey:@"JavaScriptCanOpenWindowsAutomatically" default:NO]; */ // By default, DisallowOverscroll is false (thus bounce is allowed) BOOL bounceAllowed = !([settings cordovaBoolSettingForKey:@"DisallowOverscroll" defaultValue:NO]); // prevent webView from bouncing if (!bounceAllowed) { if ([wkWebView respondsToSelector:@selector(scrollView)]) { ((UIScrollView*)[wkWebView scrollView]).bounces = NO; } else { for (id subview in wkWebView.subviews) { if ([[subview class] isSubclassOfClass:[UIScrollView class]]) { ((UIScrollView*)subview).bounces = NO; } } } } NSString* decelerationSetting = [settings cordovaSettingForKey:@"WKWebViewDecelerationSpeed"]; if (![@"fast" isEqualToString:decelerationSetting]) { [wkWebView.scrollView setDecelerationRate:UIScrollViewDecelerationRateNormal]; } else { [wkWebView.scrollView setDecelerationRate:UIScrollViewDecelerationRateFast]; } wkWebView.allowsBackForwardNavigationGestures = [settings cordovaBoolSettingForKey:@"AllowBackForwardNavigationGestures" defaultValue:NO]; wkWebView.allowsLinkPreview = [settings cordovaBoolSettingForKey:@"Allow3DTouchLinkPreview" defaultValue:YES]; } - (void)updateWithInfo:(NSDictionary*)info { NSDictionary* scriptMessageHandlers = [info objectForKey:kCDVWebViewEngineScriptMessageHandlers]; NSDictionary* settings = [info objectForKey:kCDVWebViewEngineWebViewPreferences]; id navigationDelegate = [info objectForKey:kCDVWebViewEngineWKNavigationDelegate]; id uiDelegate = [info objectForKey:kCDVWebViewEngineWKUIDelegate]; WKWebView* wkWebView = (WKWebView*)_engineWebView; if (scriptMessageHandlers && [scriptMessageHandlers isKindOfClass:[NSDictionary class]]) { NSArray* allKeys = [scriptMessageHandlers allKeys]; for (NSString* key in allKeys) { id object = [scriptMessageHandlers objectForKey:key]; if ([object conformsToProtocol:@protocol(WKScriptMessageHandler)]) { [wkWebView.configuration.userContentController addScriptMessageHandler:object name:key]; } } } if (navigationDelegate && [navigationDelegate conformsToProtocol:@protocol(WKNavigationDelegate)]) { wkWebView.navigationDelegate = navigationDelegate; } if (uiDelegate && [uiDelegate conformsToProtocol:@protocol(WKUIDelegate)]) { wkWebView.UIDelegate = uiDelegate; } if (settings && [settings isKindOfClass:[NSDictionary class]]) { [self updateSettings:settings]; } } // This forwards the methods that are in the header that are not implemented here. // Both WKWebView implement the below: // loadHTMLString:baseURL: // loadRequest: - (id)forwardingTargetForSelector:(SEL)aSelector { return _engineWebView; } - (UIView*)webView { return self.engineWebView; } #pragma mark WKScriptMessageHandler implementation - (void)userContentController:(WKUserContentController*)userContentController didReceiveScriptMessage:(WKScriptMessage*)message { if (![message.name isEqualToString:CDV_BRIDGE_NAME]) { return; } CDVViewController* vc = (CDVViewController*)self.viewController; NSArray* jsonEntry = message.body; // NSString:callbackId, NSString:service, NSString:action, NSArray:args CDVInvokedUrlCommand* command = [CDVInvokedUrlCommand commandFromJson:jsonEntry]; CDV_EXEC_LOG(@"Exec(%@): Calling %@.%@", command.callbackId, command.className, command.methodName); if (![vc.commandQueue execute:command]) { #ifdef DEBUG NSError* error = nil; NSString* commandJson = nil; NSData* jsonData = [NSJSONSerialization dataWithJSONObject:jsonEntry options:0 error:&error]; if (error == nil) { commandJson = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]; } static NSUInteger maxLogLength = 1024; NSString* commandString = ([commandJson length] > maxLogLength) ? [NSString stringWithFormat : @"%@[...]", [commandJson substringToIndex:maxLogLength]] : commandJson; NSLog(@"FAILED pluginJSON = %@", commandString); #endif } } #pragma mark WKNavigationDelegate implementation - (void)webView:(WKWebView*)webView didStartProvisionalNavigation:(WKNavigation*)navigation { [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:CDVPluginResetNotification object:webView]]; } - (void)webView:(WKWebView*)webView didFinishNavigation:(WKNavigation*)navigation { [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:CDVPageDidLoadNotification object:webView]]; } - (void)webView:(WKWebView*)theWebView didFailProvisionalNavigation:(WKNavigation*)navigation withError:(NSError*)error { [self webView:theWebView didFailNavigation:navigation withError:error]; } - (void)webView:(WKWebView*)theWebView didFailNavigation:(WKNavigation*)navigation withError:(NSError*)error { CDVViewController* vc = (CDVViewController*)self.viewController; NSString* message = [NSString stringWithFormat:@"Failed to load webpage with error: %@", [error localizedDescription]]; NSLog(@"%@", message); NSURL* errorUrl = vc.errorURL; if (errorUrl) { NSCharacterSet *charSet = [NSCharacterSet URLFragmentAllowedCharacterSet]; errorUrl = [NSURL URLWithString:[NSString stringWithFormat:@"?error=%@", [message stringByAddingPercentEncodingWithAllowedCharacters:charSet]] relativeToURL:errorUrl]; NSLog(@"%@", [errorUrl absoluteString]); [theWebView loadRequest:[NSURLRequest requestWithURL:errorUrl]]; } } - (void)webViewWebContentProcessDidTerminate:(WKWebView *)webView { [webView reload]; } - (BOOL)defaultResourcePolicyForURL:(NSURL*)url { // all file:// urls are allowed if ([url isFileURL]) { return YES; } return NO; } - (void) webView: (WKWebView *) webView decidePolicyForNavigationAction: (WKNavigationAction*) navigationAction decisionHandler: (void (^)(WKNavigationActionPolicy)) decisionHandler { NSURL* url = [navigationAction.request URL]; CDVViewController* vc = (CDVViewController*)self.viewController; /* * Give plugins the chance to handle the url */ BOOL anyPluginsResponded = NO; BOOL shouldAllowRequest = NO; for (NSString* pluginName in vc.pluginObjects) { CDVPlugin* plugin = [vc.pluginObjects objectForKey:pluginName]; SEL selector = NSSelectorFromString(@"shouldOverrideLoadWithRequest:navigationType:"); if ([plugin respondsToSelector:selector]) { anyPluginsResponded = YES; // https://issues.apache.org/jira/browse/CB-12497 int navType = (int)navigationAction.navigationType; shouldAllowRequest = (((BOOL (*)(id, SEL, id, int))objc_msgSend)(plugin, selector, navigationAction.request, navType)); if (!shouldAllowRequest) { break; } } } if (anyPluginsResponded) { return decisionHandler(shouldAllowRequest); } /* * Handle all other types of urls (tel:, sms:), and requests to load a url in the main webview. */ BOOL shouldAllowNavigation = [self defaultResourcePolicyForURL:url]; if (shouldAllowNavigation) { return decisionHandler(YES); } else { [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:CDVPluginHandleOpenURLNotification object:url]]; } return decisionHandler(NO); } #pragma mark - Plugin interface - (void)allowsBackForwardNavigationGestures:(CDVInvokedUrlCommand*)command; { id value = [command argumentAtIndex:0]; if (!([value isKindOfClass:[NSNumber class]])) { value = [NSNumber numberWithBool:NO]; } WKWebView* wkWebView = (WKWebView*)_engineWebView; wkWebView.allowsBackForwardNavigationGestures = [value boolValue]; } @end #pragma mark - CDVWebViewWeakScriptMessageHandler @implementation CDVWebViewWeakScriptMessageHandler - (instancetype)initWithScriptMessageHandler:(id)scriptMessageHandler { self = [super init]; if (self) { _scriptMessageHandler = scriptMessageHandler; } return self; } - (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message { [self.scriptMessageHandler userContentController:userContentController didReceiveScriptMessage:message]; } @end