Add prop + event for blacklisting URL-schemes in WebView

Libraries/Components/WebView/WebView.android.js

@@ -136,6 +136,16 @@ class WebView extends React.Component {
      */
     scalesPageToFit: PropTypes.bool,
 
+    /**
+     * Function that is invoked when a defined URL-scheme has been rejected.
+     */
+    onUrlSchemeRejected: PropTypes.func,
+
+    /**
+     * An array defining rejected URL-schemes.
+     */
+    rejectedUrlSchemes: PropTypes.array,
+
     /**
      * Sets the user-agent for this WebView. The user-agent can also be set in native using
      * WebViewConfig. This prop will overwrite that config.
@@ -213,6 +223,7 @@ class WebView extends React.Component {
         style={webViewStyles}
         source={resolveAssetSource(source)}
         scalesPageToFit={this.props.scalesPageToFit}
+        rejectedUrlSchemes={this.props.rejectedUrlSchemes}
         injectedJavaScript={this.props.injectedJavaScript}
         userAgent={this.props.userAgent}
         javaScriptEnabled={this.props.javaScriptEnabled}
@@ -225,6 +236,7 @@ class WebView extends React.Component {
         onLoadingStart={this.onLoadingStart}
         onLoadingFinish={this.onLoadingFinish}
         onLoadingError={this.onLoadingError}
+        onUrlSchemeRejected={this.onUrlSchemeRejected}
         testID={this.props.testID}
         mediaPlaybackRequiresUserAction={this.props.mediaPlaybackRequiresUserAction}
       />;
@@ -324,6 +336,11 @@ class WebView extends React.Component {
     var {onMessage} = this.props;
     onMessage && onMessage(event);
   }
+
+  onUrlSchemeRejected = (event: Event) => {
+    var onUrlSchemeRejected = this.props.onUrlSchemeRejected;
+    onUrlSchemeRejected && onUrlSchemeRejected(event);
+  };
 }
 
 var RCTWebView = requireNativeComponent('RCTWebView', WebView, {

Libraries/Components/WebView/WebView.ios.js

@@ -310,6 +310,16 @@ class WebView extends React.Component {
      */
     scalesPageToFit: PropTypes.bool,
 
+    /**
+     * Function that is invoked when a defined URL-scheme has been rejected.
+     */
+    onUrlSchemeRejected: PropTypes.func,
+
+    /**
+     * An array defining rejected URL-schemes.
+     */
+    rejectedUrlSchemes: PropTypes.array,
+
     /**
      * Function that allows custom handling of any web view requests. Return
      * `true` from the function to continue loading the request and `false`
@@ -400,6 +410,7 @@ class WebView extends React.Component {
         key="webViewKey"
         style={webViewStyles}
         source={resolveAssetSource(source)}
+        rejectedUrlSchemes={this.props.rejectedUrlSchemes}
         injectedJavaScript={this.props.injectedJavaScript}
         bounces={this.props.bounces}
         scrollEnabled={this.props.scrollEnabled}
@@ -409,6 +420,7 @@ class WebView extends React.Component {
         onLoadingStart={this._onLoadingStart}
         onLoadingFinish={this._onLoadingFinish}
         onLoadingError={this._onLoadingError}
+        onUrlSchemeRejected={this._onUrlSchemeRejected}
         messagingEnabled={messagingEnabled}
         onMessage={this._onMessage}
         onShouldStartLoadWithRequest={onShouldStartLoadWithRequest}
@@ -539,13 +551,19 @@ class WebView extends React.Component {
     var {onMessage} = this.props;
     onMessage && onMessage(event);
   }
+
+  _onUrlSchemeRejected = (event: Event) => {
+    var onUrlSchemeRejected = this.props.onUrlSchemeRejected;
+    onUrlSchemeRejected && onUrlSchemeRejected(event);
+  };
 }
 
 var RCTWebView = requireNativeComponent('RCTWebView', WebView, {
   nativeOnly: {
     onLoadingStart: true,
     onLoadingError: true,
     onLoadingFinish: true,
+    onUrlSchemeRejected: true,
     onMessage: true,
     messagingEnabled: PropTypes.bool,
   },

React/Views/RCTWebView.h

@@ -32,6 +32,7 @@ shouldStartLoadForRequest:(NSMutableDictionary<NSString *, id> *)request
 @property (nonatomic, weak) id<RCTWebViewDelegate> delegate;
 
 @property (nonatomic, copy) NSDictionary *source;
+@property (nonatomic, copy) NSArray *rejectedUrlSchemes;
 @property (nonatomic, assign) UIEdgeInsets contentInset;
 @property (nonatomic, assign) BOOL automaticallyAdjustContentInsets;
 @property (nonatomic, assign) BOOL messagingEnabled;

React/Views/RCTWebView.m

@@ -29,6 +29,7 @@ @interface RCTWebView () <UIWebViewDelegate, RCTAutoInsetsProtocol>
 @property (nonatomic, copy) RCTDirectEventBlock onLoadingError;
 @property (nonatomic, copy) RCTDirectEventBlock onShouldStartLoadWithRequest;
 @property (nonatomic, copy) RCTDirectEventBlock onMessage;
+@property (nonatomic, copy) RCTDirectEventBlock onUrlSchemeRejected;
 
 @end
 
@@ -207,6 +208,22 @@ - (BOOL)webView:(__unused UIWebView *)webView shouldStartLoadWithRequest:(NSURLR
       @(UIWebViewNavigationTypeOther): @"other",
     };
   });
+
+  if (!isJSNavigation && _rejectedUrlSchemes) {
+    if ([_rejectedUrlSchemes containsObject:request.URL.scheme]) {
+      if (_onUrlSchemeRejected) {
+        NSMutableDictionary<NSString *, id> *event = [self baseEvent];
+        [event addEntriesFromDictionary: @{
+                                           @"scheme": request.URL.scheme,
+                                           @"url": (request.URL).absoluteString,
+                                           @"navigationType": navigationTypes[@(navigationType)]
+                                           }];
+        _onUrlSchemeRejected(event);
+      }
+
+      return NO;
+    }
+  }
 
   // skip this for the JS Navigation handler
   if (!isJSNavigation && _onShouldStartLoadWithRequest) {

React/Views/RCTWebViewManager.m

@@ -34,6 +34,7 @@ - (UIView *)view
 }
 
 RCT_EXPORT_VIEW_PROPERTY(source, NSDictionary)
+RCT_EXPORT_VIEW_PROPERTY(rejectedUrlSchemes, NSArray)
 RCT_REMAP_VIEW_PROPERTY(bounces, _webView.scrollView.bounces, BOOL)
 RCT_REMAP_VIEW_PROPERTY(scrollEnabled, _webView.scrollView.scrollEnabled, BOOL)
 RCT_REMAP_VIEW_PROPERTY(decelerationRate, _webView.scrollView.decelerationRate, CGFloat)
@@ -47,6 +48,7 @@ - (UIView *)view
 RCT_EXPORT_VIEW_PROPERTY(onLoadingError, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onMessage, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onShouldStartLoadWithRequest, RCTDirectEventBlock)
+RCT_EXPORT_VIEW_PROPERTY(onUrlSchemeRejected, RCTDirectEventBlock)
 RCT_REMAP_VIEW_PROPERTY(allowsInlineMediaPlayback, _webView.allowsInlineMediaPlayback, BOOL)
 RCT_REMAP_VIEW_PROPERTY(mediaPlaybackRequiresUserAction, _webView.mediaPlaybackRequiresUserAction, BOOL)
 RCT_REMAP_VIEW_PROPERTY(dataDetectorTypes, _webView.dataDetectorTypes, UIDataDetectorTypes)

ReactAndroid/src/main/java/com/facebook/react/views/webview/ReactWebViewManager.java

@@ -12,6 +12,7 @@
 import javax.annotation.Nullable;
 
 import java.io.UnsupportedEncodingException;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Locale;
 import java.util.Map;
@@ -53,6 +54,7 @@
 import com.facebook.react.views.webview.events.TopLoadingFinishEvent;
 import com.facebook.react.views.webview.events.TopLoadingStartEvent;
 import com.facebook.react.views.webview.events.TopMessageEvent;
+import com.facebook.react.views.webview.events.UrlSchemeRejectedEvent;
 
 import org.json.JSONObject;
 import org.json.JSONException;
@@ -69,6 +71,7 @@
  *  - topLoadingFinish
  *  - topLoadingStart
  *  - topLoadingError
+ *  - urlSchemeRejected
  *
  * Each event will carry the following properties:
  *  - target - view's react tag
@@ -132,6 +135,11 @@ public void onPageStarted(WebView webView, String url, Bitmap favicon) {
 
     @Override
     public boolean shouldOverrideUrlLoading(WebView view, String url) {
+        if (((ReactWebView)view).isUrlSchemeRejected(url)) {
+          dispatchUrlSchemeRejectedEvent(view, url);
+          return true;
+        }
+
         if (url.startsWith("http://") || url.startsWith("https://") ||
             url.startsWith("file://")) {
           return false;
@@ -205,6 +213,8 @@ private WritableMap createWebViewEvent(WebView webView, String url) {
   private static class ReactWebView extends WebView implements LifecycleEventListener {
     private @Nullable String injectedJS;
     private boolean messagingEnabled = false;
+    private @Nullable ArrayList<String> rejectedUrlSchemes;
+
 
     private class ReactWebViewBridge {
       ReactWebView mContext;
@@ -271,6 +281,19 @@ public void callInjectedJavaScript() {
       }
     }
 
+    public void setRejectedUrlSchemes(@Nullable ArrayList<String> rejectedUrlSchemes) {
+      this.rejectedUrlSchemes = rejectedUrlSchemes;
+    }
+
+    public ArrayList<String> getRejectedUrlSchemes() {
+      return rejectedUrlSchemes;
+    }
+
+    public Boolean isUrlSchemeRejected(String url) {
+      String scheme = getUrlScheme(url);
+      return scheme != null && rejectedUrlSchemes != null && rejectedUrlSchemes.contains(scheme);
+    }
+
     public void linkBridge() {
       if (messagingEnabled) {
         if (ReactBuildConfig.DEBUG && Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
@@ -404,6 +427,10 @@ public void setSource(WebView view, @Nullable ReadableMap source) {
         if (previousUrl != null && previousUrl.equals(url)) {
           return;
         }
+        if (((ReactWebView)view).isUrlSchemeRejected(url)) {
+          dispatchUrlSchemeRejectedEvent(view, url);
+          return;
+        }
         if (source.hasKey("method")) {
           String method = source.getString("method");
           if (method.equals(HTTP_METHOD_POST)) {
@@ -445,6 +472,35 @@ public void setSource(WebView view, @Nullable ReadableMap source) {
     view.loadUrl(BLANK_URL);
   }
 
+  @ReactProp(name = "rejectedUrlSchemes")
+  public void setRejectedUrlSchemes(WebView view, @Nullable ReadableArray rejectedUrlSchemesArray) {
+    if (rejectedUrlSchemesArray != null) {
+      ArrayList<String> rejectedUrlSchemes = new ArrayList<String>();
+
+      for (int i = 0; i < rejectedUrlSchemesArray.size(); i++) {
+        rejectedUrlSchemes.add(rejectedUrlSchemesArray.getString(i));
+      }
+
+      ((ReactWebView) view).setRejectedUrlSchemes(rejectedUrlSchemes);
+    } else {
+      ((ReactWebView) view).setRejectedUrlSchemes(null);
+    }
+  }
+
+  private static void dispatchUrlSchemeRejectedEvent(WebView view, String url) {
+    final WritableMap params = Arguments.createMap();
+    params.putString("scheme", getUrlScheme(url));
+    params.putString("url", url);
+    dispatchEvent(view, new UrlSchemeRejectedEvent(view.getId(), params));
+  }
+
+  private static String getUrlScheme(String url) {
+    if (url.contains("://"))
+      return url.split("://")[0];
+
+    return null;
+  }
+
   @ReactProp(name = "onContentSizeChange")
   public void setOnContentSizeChange(WebView view, boolean sendContentSizeChangeEvents) {
     if (sendContentSizeChangeEvents) {
@@ -527,4 +583,9 @@ private static void dispatchEvent(WebView webView, Event event) {
       reactContext.getNativeModule(UIManagerModule.class).getEventDispatcher();
     eventDispatcher.dispatchEvent(event);
   }
+
+  @Override
+  public @Nullable Map getExportedCustomDirectEventTypeConstants() {
+    return MapBuilder.of(UrlSchemeRejectedEvent.EVENT_NAME, MapBuilder.of("registrationName", "onUrlSchemeRejected"));
+  }
 }

ReactAndroid/src/main/java/com/facebook/react/views/webview/events/UrlSchemeRejectedEvent.java

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+package com.facebook.react.views.webview.events;
+
+import com.facebook.react.bridge.WritableMap;
+import com.facebook.react.uimanager.events.Event;
+import com.facebook.react.uimanager.events.RCTEventEmitter;
+
+/**
+ * Event emitted when url scheme has been blocked from loading
+ */
+public class UrlSchemeRejectedEvent extends Event<UrlSchemeRejectedEvent> {
+
+  public static final String EVENT_NAME = "urlSchemeRejected";
+  private WritableMap mEventData;
+
+  public UrlSchemeRejectedEvent(int viewId, WritableMap eventData) {
+    super(viewId);
+    mEventData = eventData;
+  }
+
+  @Override
+  public String getEventName() {
+    return EVENT_NAME;
+  }
+
+  @Override
+  public boolean canCoalesce() {
+    return false;
+  }
+
+  @Override
+  public short getCoalescingKey() {
+    // All events for a given view can be coalesced.
+    return 0;
+  }
+
+  @Override
+  public void dispatch(RCTEventEmitter rctEventEmitter) {
+    rctEventEmitter.receiveEvent(getViewTag(), getEventName(), mEventData);
+  }
+}