use WKWebview instead (#20103)

UIWebView is removed in iOS 13.

Author: minggo

cmake/Modules/CocosConfigDepend.cmake

@@ -69,6 +69,7 @@ macro(cocos2dx_depend)
             find_library(CORE_GRAPHICS_LIBRARY CoreGraphics)
             find_library(AV_FOUNDATION_LIBRARY AVFoundation)
             find_library(Z_LIBRARY z)
+            find_library(WEBKIT_LIBRARY WebKit)
             list(APPEND PLATFORM_SPECIFIC_LIBS
                  ${UIKIT_LIBRARY}
                  ${OPENGLES_LIBRARY}
@@ -80,6 +81,7 @@ macro(cocos2dx_depend)
                  ${CORE_GRAPHICS_LIBRARY}
                  ${AV_FOUNDATION_LIBRARY}
                  ${Z_LIBRARY}
+                 ${WEBKIT_LIBRARY}
                  ${COCOS_APPLE_LIBS}
                  )
         endif()

cocos/ui/UIWebView/UIWebViewImpl-ios.mm

@@ -28,37 +28,17 @@ of this software and associated documentation files (the "Software"), to deal
 // Webview not available on tvOS
 #if (CC_TARGET_PLATFORM == CC_PLATFORM_IOS) && !defined(CC_TARGET_OS_TVOS)
 
+#import <WebKit/WKWebView.h>
+#import <WebKit/WKUIDelegate.h>
+#import <WebKit/WKNavigationDelegate.h>
+
 #include "ui/UIWebView/UIWebViewImpl-ios.h"
+#include "ui/UIWebView/UIWebView.h"
 #include "renderer/CCRenderer.h"
 #include "base/CCDirector.h"
 #include "platform/CCGLView.h"
 #include "platform/ios/CCEAGLView-ios.h"
 #include "platform/CCFileUtils.h"
-#include "ui/UIWebView/UIWebView.h"
-
-static std::string getFixedBaseUrl(const std::string& baseUrl)
-{
-    std::string fixedBaseUrl;
-    if (baseUrl.empty() || baseUrl.at(0) != '/') {
-        fixedBaseUrl = [[[NSBundle mainBundle] resourcePath] UTF8String];
-        fixedBaseUrl += "/";
-        fixedBaseUrl += baseUrl;
-    }
-    else {
-        fixedBaseUrl = baseUrl;
-    }
-    
-    size_t pos = 0;
-    while ((pos = fixedBaseUrl.find(" ")) != std::string::npos) {
-        fixedBaseUrl.replace(pos, 1, "%20");
-    }
-    
-    if (fixedBaseUrl.at(fixedBaseUrl.length() - 1) != '/') {
-        fixedBaseUrl += "/";
-    }
-    
-    return fixedBaseUrl;
-}
 
 @interface UIWebViewWrapper : NSObject
 @property (nonatomic) std::function<bool(std::string url)> shouldStartLoading;
@@ -107,8 +87,9 @@ - (void)setScalesPageToFit:(const bool)scalesPageToFit;
 @end
 
 
-@interface UIWebViewWrapper () <UIWebViewDelegate>
-@property(nonatomic, retain) UIWebView *uiWebView;
+@interface UIWebViewWrapper () <WKUIDelegate, WKNavigationDelegate>
+@property(nonatomic, retain) WKWebView *wkWebView;
+
 @property(nonatomic, copy) NSString *jsScheme;
 @end
 
@@ -123,7 +104,7 @@ + (instancetype) newWebViewWrapper {
 - (instancetype)init {
     self = [super init];
     if (self) {
-        self.uiWebView = nil;
+        self.wkWebView = nil;
         self.shouldStartLoading = nullptr;
         self.didFinishLoading = nullptr;
         self.didFailLoading = nullptr;
@@ -132,56 +113,58 @@ - (instancetype)init {
 }
 
 - (void)dealloc {
-    self.uiWebView.delegate = nil;
-    [self.uiWebView removeFromSuperview];
-    [self.uiWebView release];
-    self.uiWebView = nil;
+    self.wkWebView.UIDelegate = nil;
+    self.wkWebView.navigationDelegate = nil;
+    [self.wkWebView removeFromSuperview];
+    [self.wkWebView release];
+    self.wkWebView = nil;
     self.jsScheme = nil;
     [super dealloc];
 }
 
 - (void)setupWebView {
-    if (!self.uiWebView) {
-        self.uiWebView = [[UIWebView alloc] init];
-        self.uiWebView.delegate = self;
+    if (!self.wkWebView) {
+        self.wkWebView = [[WKWebView alloc] init];
+        self.wkWebView.UIDelegate = self;
+        self.wkWebView.navigationDelegate = self;
     }
-    if (!self.uiWebView.superview) {
+    if (!self.wkWebView.superview) {
         auto view = cocos2d::Director::getInstance()->getOpenGLView();
         auto eaglview = (CCEAGLView *) view->getEAGLView();
-        [eaglview addSubview:self.uiWebView];
+        [eaglview addSubview:self.wkWebView];
     }
 }
 
 - (void)setVisible:(bool)visible {
-    if (!self.uiWebView) {[self setupWebView];}
-    self.uiWebView.hidden = !visible;
+    if (!self.wkWebView) {[self setupWebView];}
+    self.wkWebView.hidden = !visible;
 }
 
 - (void)setBounces:(bool)bounces {
-  self.uiWebView.scrollView.bounces = bounces;
+  self.wkWebView.scrollView.bounces = bounces;
 }
 
 - (void)setOpacityWebView:(float)opacity {
-    if (!self.uiWebView) {[self setupWebView];}
-    self.uiWebView.alpha=opacity;
-    [self.uiWebView setOpaque:NO];
+    if (!self.wkWebView) { [self setupWebView]; }
+    self.wkWebView.alpha = opacity;
+    [self.wkWebView setOpaque:YES];
 }
 
 -(float) getOpacityWebView{
-    return self.uiWebView.alpha;
+    return self.wkWebView.alpha;
 }
 
 -(void) setBackgroundTransparent{
-    if (!self.uiWebView) {[self setupWebView];}
-    [self.uiWebView setOpaque:NO];
-    [self.uiWebView setBackgroundColor:[UIColor clearColor]];
+    if (!self.wkWebView) {[self setupWebView];}
+    [self.wkWebView setOpaque:NO];
+    [self.wkWebView setBackgroundColor:[UIColor clearColor]];
 }
 
 - (void)setFrameWithX:(float)x y:(float)y width:(float)width height:(float)height {
-    if (!self.uiWebView) {[self setupWebView];}
+    if (!self.wkWebView) {[self setupWebView];}
     CGRect newFrame = CGRectMake(x, y, width, height);
-    if (!CGRectEqualToRect(self.uiWebView.frame, newFrame)) {
-        self.uiWebView.frame = CGRectMake(x, y, width, height);
+    if (!CGRectEqualToRect(self.wkWebView.frame, newFrame)) {
+        self.wkWebView.frame = CGRectMake(x, y, width, height);
     }
 }
 
@@ -190,19 +173,26 @@ - (void)setJavascriptInterfaceScheme:(const std::string &)scheme {
 }
 
 - (void)loadData:(const std::string &)data MIMEType:(const std::string &)MIMEType textEncodingName:(const std::string &)encodingName baseURL:(const std::string &)baseURL {
-    [self.uiWebView loadData:[NSData dataWithBytes:data.c_str() length:data.length()]
+    auto path = [[NSBundle mainBundle] resourcePath];
+    path = [path stringByAppendingPathComponent:@(baseURL.c_str() )];
+    auto url = [NSURL fileURLWithPath:path];
+
+    [self.wkWebView loadData:[NSData dataWithBytes:data.c_str() length:data.length()]
                     MIMEType:@(MIMEType.c_str())
-            textEncodingName:@(encodingName.c_str())
-                     baseURL:[NSURL URLWithString:@(getFixedBaseUrl(baseURL).c_str())]];
+       characterEncodingName:@(encodingName.c_str())
+                     baseURL:url];
 }
 
 - (void)loadHTMLString:(const std::string &)string baseURL:(const std::string &)baseURL {
-    if (!self.uiWebView) {[self setupWebView];}
-    [self.uiWebView loadHTMLString:@(string.c_str()) baseURL:[NSURL URLWithString:@(getFixedBaseUrl(baseURL).c_str())]];
+    if (!self.wkWebView) {[self setupWebView];}
+    auto path = [[NSBundle mainBundle] resourcePath];
+    path = [path stringByAppendingPathComponent:@(baseURL.c_str() )];
+    auto url = [NSURL fileURLWithPath:path];
+    [self.wkWebView loadHTMLString:@(string.c_str()) baseURL:url];
 }
 
 - (void)loadUrl:(const std::string &)urlString cleanCachedData:(BOOL) needCleanCachedData {
-    if (!self.uiWebView) {[self setupWebView];}
+    if (!self.wkWebView) {[self setupWebView];}
     NSURL *url = [NSURL URLWithString:@(urlString.c_str())];
 
     NSURLRequest *request = nil;
@@ -211,83 +201,107 @@ - (void)loadUrl:(const std::string &)urlString cleanCachedData:(BOOL) needCleanC
     else
         request = [NSURLRequest requestWithURL:url];
 
-    [self.uiWebView loadRequest:request];
+    [self.wkWebView loadRequest:request];
 }
 
-
-
 - (void)loadFile:(const std::string &)filePath {
-    if (!self.uiWebView) {[self setupWebView];}
+    if (!self.wkWebView) {[self setupWebView];}
     NSURL *url = [NSURL fileURLWithPath:@(filePath.c_str())];
     NSURLRequest *request = [NSURLRequest requestWithURL:url];
-    [self.uiWebView loadRequest:request];
+    [self.wkWebView loadRequest:request];
 }
 
 - (void)stopLoading {
-    [self.uiWebView stopLoading];
+    [self.wkWebView stopLoading];
 }
 
 - (void)reload {
-    [self.uiWebView reload];
+    [self.wkWebView reload];
 }
 
 - (BOOL)canGoForward {
-    return self.uiWebView.canGoForward;
+    return self.wkWebView.canGoForward;
 }
 
 - (BOOL)canGoBack {
-    return self.uiWebView.canGoBack;
+    return self.wkWebView.canGoBack;
 }
 
 - (void)goBack {
-    [self.uiWebView goBack];
+    [self.wkWebView goBack];
 }
 
 - (void)goForward {
-    [self.uiWebView goForward];
+    [self.wkWebView goForward];
 }
 
 - (void)evaluateJS:(const std::string &)js {
-    if (!self.uiWebView) {[self setupWebView];}
-    [self.uiWebView stringByEvaluatingJavaScriptFromString:@(js.c_str())];
+    if (!self.wkWebView) {[self setupWebView];}
+    [self.wkWebView evaluateJavaScript:@(js.c_str()) completionHandler:nil];
 }
 
 - (void)setScalesPageToFit:(const bool)scalesPageToFit {
-    if (!self.uiWebView) {[self setupWebView];}
-    self.uiWebView.scalesPageToFit = scalesPageToFit;
+// TODO: there is not corresponding API in WK.
+// https://stackoverflow.com/questions/26295277/wkwebview-equivalent-for-uiwebviews-scalespagetofit/43048514 seems has a solution,
+// but it doesn't support setting it dynamically. If we want to set this feature dynamically, then it will be too complex.
 }
 
 
 
-#pragma mark - UIWebViewDelegate
-- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
-    NSString *url = [[request URL] absoluteString];
-    if ([[[request URL] scheme] isEqualToString:self.jsScheme]) {
+#pragma mark - WKNavigationDelegate
+- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
+    NSString *url = [webView.URL absoluteString];
+    if ([[webView.URL scheme] isEqualToString:self.jsScheme]) {
         self.onJsCallback([url UTF8String]);
-        return NO;
+        decisionHandler(WKNavigationActionPolicyCancel);
+        return;
     }
     if (self.shouldStartLoading && url) {
-        return self.shouldStartLoading([url UTF8String]);
+        if (self.shouldStartLoading([url UTF8String]) )
+            decisionHandler(WKNavigationActionPolicyAllow);
+        else
+            decisionHandler(WKNavigationActionPolicyCancel);
+
+        return;
     }
-    return YES;
+
+    decisionHandler(WKNavigationActionPolicyAllow);
 }
 
-- (void)webViewDidFinishLoad:(UIWebView *)webView {
+- (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigation {
     if (self.didFinishLoading) {
-        NSString *url = [[webView.request URL] absoluteString];
+        NSString *url = [webView.URL absoluteString];
         self.didFinishLoading([url UTF8String]);
     }
 }
 
-- (void)webView:(UIWebView *)webView didFailLoadWithError:(NSError *)error {
+- (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(WKNavigation *)navigation withError:(NSError *)error {
     if (self.didFailLoading) {
-        NSString *url = error.userInfo[NSURLErrorFailingURLStringErrorKey];
-        if (url) {
-            self.didFailLoading([url UTF8String]);
+        NSString *errorInfo = error.userInfo[NSURLErrorFailingURLStringErrorKey];
+        if (errorInfo) {
+            self.didFailLoading([errorInfo UTF8String]);
         }
     }
 }
 
+#pragma WKUIDelegate
+
+// Implement js alert function.
+- (void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)())completionHandler
+{
+    UIAlertController *alertController = [UIAlertController alertControllerWithTitle:message
+                                                                             message:nil
+                                                                      preferredStyle:UIAlertControllerStyleAlert];
+    [alertController addAction:[UIAlertAction actionWithTitle:@"Ok"
+                                                        style:UIAlertActionStyleCancel
+                                                      handler:^(UIAlertAction *action) {
+                                                          completionHandler();
+                                                      }]];
+
+    auto rootViewController = [UIApplication sharedApplication].keyWindow.rootViewController;
+    [rootViewController presentViewController:alertController animated:YES completion:^{}];
+}
+
 @end
 
 

tests/cpp-empty-test/proj.android/gradle.properties

@@ -31,7 +31,7 @@ PROP_TARGET_SDK_VERSION=28
 # Available architextures (armeabi-v7a | arm64-v8a | x86)
 # To build for multiple architexture, use the `:` between them
 # Example - PROP_APP_ABI=armeabi-v7a:arm64-v8a:x86
-PROP_APP_ABI=armeabi-v7a
+PROP_APP_ABI=x86
 
 # uncomment it and fill in sign information for release mode
 #RELEASE_STORE_FILE=file path of keystore