Java tutorial
/** * Copyright (c) 2015-present, Facebook, Inc. * All rights reserved. * <p> * 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.blockablewebview; import javax.annotation.Nullable; import java.io.UnsupportedEncodingException; import java.util.HashMap; import java.util.Map; import android.content.Intent; import android.graphics.Bitmap; import android.graphics.Picture; import android.net.Uri; import android.os.Build; import android.text.TextUtils; import android.view.ViewGroup.LayoutParams; import android.webkit.GeolocationPermissions; import android.webkit.WebChromeClient; import android.webkit.WebView; import android.webkit.WebViewClient; import com.facebook.react.bridge.Arguments; import com.facebook.react.bridge.LifecycleEventListener; import com.facebook.react.bridge.ReactContext; import com.facebook.react.bridge.ReadableArray; import com.facebook.react.bridge.ReadableMap; import com.facebook.react.bridge.ReadableMapKeySetIterator; import com.facebook.react.bridge.WritableMap; import com.facebook.react.common.MapBuilder; import com.facebook.react.common.build.ReactBuildConfig; import com.facebook.react.uimanager.SimpleViewManager; import com.facebook.react.uimanager.ThemedReactContext; import com.facebook.react.uimanager.UIManagerModule; import com.facebook.react.uimanager.annotations.ReactProp; import com.facebook.react.uimanager.events.ContentSizeChangeEvent; import com.facebook.react.uimanager.events.Event; import com.facebook.react.uimanager.events.EventDispatcher; import com.facebook.react.views.webview.WebViewConfig; import com.facebook.react.views.webview.events.TopLoadingErrorEvent; import com.facebook.react.views.webview.events.TopLoadingFinishEvent; import com.facebook.react.views.webview.events.TopLoadingStartEvent; /** * Manages instances of {@link WebView} * * Can accept following commands: * - GO_BACK * - GO_FORWARD * - RELOAD * * {@link WebView} instances could emit following direct events: * - topLoadingFinish * - topLoadingStart * - topLoadingError * * Each event will carry the following properties: * - target - view's react tag * - url - url set for the webview * - loading - whether webview is in a loading state * - title - title of the current page * - canGoBack - boolean, whether there is anything on a history stack to go back * - canGoForward - boolean, whether it is possible to request GO_FORWARD command */ public class BlockableWebViewManager extends SimpleViewManager<WebView> { private static final String REACT_CLASS = "BlockableWebView"; private static final String HTML_ENCODING = "UTF-8"; private static final String HTML_MIME_TYPE = "text/html; charset=utf-8"; private static final String HTTP_METHOD_POST = "POST"; public static final int COMMAND_GO_BACK = 1; public static final int COMMAND_GO_FORWARD = 2; public static final int COMMAND_RELOAD = 3; public static final int COMMAND_STOP_LOADING = 4; // Use `webView.loadUrl("about:blank")` to reliably reset the view // state and release page resources (including any running JavaScript). private static final String BLANK_URL = "about:blank"; private WebViewConfig mWebViewConfig; private @Nullable WebView.PictureListener mPictureListener; private static class ReactWebViewClient extends WebViewClient { private boolean mLastLoadFailed = false; @Override public void onPageFinished(WebView webView, String url) { super.onPageFinished(webView, url); if (!mLastLoadFailed) { BlockableWebView reactWebView = (BlockableWebView) webView; reactWebView.callInjectedJavaScript(); emitFinishEvent(webView, url); } } @Override public void onPageStarted(WebView webView, String url, Bitmap favicon) { super.onPageStarted(webView, url, favicon); mLastLoadFailed = false; dispatchEvent(webView, new TopLoadingStartEvent(webView.getId(), createWebViewEvent(webView, url))); } @Override public boolean shouldOverrideUrlLoading(WebView webView, String url) { String[] hosts = ((BlockableWebView) webView).getAvailableHosts(); String host; boolean openIntent = false; for (int h = 0; h < hosts.length; h++) { host = hosts[h]; if (url.startsWith(host)) { openIntent = false; boolean shouldBlock = false; ReadableMap[] policies = ((BlockableWebView) webView).getNavigationBlockingPolicies(); ReadableMap policy; boolean policyFulfilled = false; if (policies != null) { WritableMap currentValues = createWebViewEvent(webView, url); currentValues.putString("currentURL", webView.getUrl()); for (int i = 0; i < policies.length; i++) { policy = policies[i]; ReadableMapKeySetIterator it = policy.keySetIterator(); String policyKey; // has at least one rule if (it != null && it.hasNextKey()) { policyFulfilled = true; // loop until there are no more rules or one has been rejected already while (it.hasNextKey() && policyFulfilled) { policyKey = it.nextKey(); if (!currentValues.hasKey(policyKey)) { policyFulfilled = false; continue; } policyFulfilled = currentValues.getString(policyKey) .matches(policy.getString(policyKey)); } } if (policyFulfilled) { shouldBlock = !shouldBlock; break; } } } if (shouldBlock) { dispatchEvent(webView, new BlockableWebViewEvent(webView.getId(), createWebViewEvent(webView, url))); } return shouldBlock; } else { openIntent = true; continue; } } if (openIntent) { try { Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(url)); intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK); webView.getContext().startActivity(intent); } catch (ActivityNotFoundException e) { } return true; } return false; } @Override public void onReceivedError(WebView webView, int errorCode, String description, String failingUrl) { super.onReceivedError(webView, errorCode, description, failingUrl); mLastLoadFailed = true; // In case of an error JS side expect to get a finish event first, and then get an error event // Android WebView does it in the opposite way, so we need to simulate that behavior emitFinishEvent(webView, failingUrl); WritableMap eventData = createWebViewEvent(webView, failingUrl); eventData.putDouble("code", errorCode); eventData.putString("description", description); dispatchEvent(webView, new TopLoadingErrorEvent(webView.getId(), eventData)); } @Override public void doUpdateVisitedHistory(WebView webView, String url, boolean isReload) { super.doUpdateVisitedHistory(webView, url, isReload); dispatchEvent(webView, new TopLoadingStartEvent(webView.getId(), createWebViewEvent(webView, url))); } private void emitFinishEvent(WebView webView, String url) { dispatchEvent(webView, new TopLoadingFinishEvent(webView.getId(), createWebViewEvent(webView, url))); } private WritableMap createWebViewEvent(WebView webView, String url) { WritableMap event = Arguments.createMap(); event.putDouble("target", webView.getId()); // Don't use webView.getUrl() here, the URL isn't updated to the new value yet in callbacks // like onPageFinished event.putString("url", url); event.putBoolean("loading", !mLastLoadFailed && webView.getProgress() != 100); event.putString("title", webView.getTitle()); event.putBoolean("canGoBack", webView.canGoBack()); event.putBoolean("canGoForward", webView.canGoForward()); return event; } } /** * Subclass of {@link WebView} that implements {@link LifecycleEventListener} interface in order * to call {@link WebView#destroy} on activty destroy event and also to clear the client */ private static class BlockableWebView extends WebView implements LifecycleEventListener { private @Nullable String injectedJS; private @Nullable ReadableMap[] navigationBlockingPolicies; private @Nullable String[] availableHosts; /** * WebView must be created with an context of the current activity * * Activity Context is required for creation of dialogs internally by WebView * Reactive Native needed for access to ReactNative internal system functionality * */ public BlockableWebView(ThemedReactContext reactContext) { super(reactContext); } @Override public void onHostResume() { // do nothing } @Override public void onHostPause() { // do nothing } @Override public void onHostDestroy() { cleanupCallbacksAndDestroy(); } public void setInjectedJavaScript(@Nullable String js) { injectedJS = js; } public void callInjectedJavaScript() { if (getSettings().getJavaScriptEnabled() && injectedJS != null && !TextUtils.isEmpty(injectedJS)) { loadUrl("javascript:(function() {\n" + injectedJS + ";\n})();"); } } private void cleanupCallbacksAndDestroy() { setWebViewClient(null); destroy(); } public ReadableMap[] getNavigationBlockingPolicies() { return navigationBlockingPolicies; } public void setNavigationBlockingPolicies(@Nullable ReadableArray policies) { if (policies == null || policies.size() == 0) { navigationBlockingPolicies = null; return; } navigationBlockingPolicies = new ReadableMap[policies.size()]; for (int i = 0; i < policies.size(); i++) { navigationBlockingPolicies[i] = policies.getMap(i); } } public String[] getAvailableHosts() { return availableHosts; } public void setAvailableHosts(@Nullable ReadableArray hosts) { String[] _hosts = new String[hosts.size()]; for (int i = 0; i < _hosts.length; i++) { _hosts[i] = hosts.getString(i); } availableHosts = _hosts; } } public BlockableWebViewManager() { mWebViewConfig = new WebViewConfig() { public void configWebView(WebView webView) { } }; } public BlockableWebViewManager(WebViewConfig webViewConfig) { mWebViewConfig = webViewConfig; } @Override public String getName() { return REACT_CLASS; } @Override protected WebView createViewInstance(ThemedReactContext reactContext) { BlockableWebView webView = new BlockableWebView(reactContext); webView.setWebChromeClient(new WebChromeClient() { @Override public void onGeolocationPermissionsShowPrompt(String origin, GeolocationPermissions.Callback callback) { callback.invoke(origin, true, false); } }); reactContext.addLifecycleEventListener(webView); mWebViewConfig.configWebView(webView); webView.getSettings().setBuiltInZoomControls(true); webView.getSettings().setDisplayZoomControls(false); // Fixes broken full-screen modals/galleries due to body height being 0. webView.setLayoutParams(new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT)); if (ReactBuildConfig.DEBUG && Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) { WebView.setWebContentsDebuggingEnabled(true); } return webView; } @ReactProp(name = "javaScriptEnabled") public void setJavaScriptEnabled(WebView view, boolean enabled) { view.getSettings().setJavaScriptEnabled(enabled); } @ReactProp(name = "scalesPageToFit") public void setScalesPageToFit(WebView view, boolean enabled) { view.getSettings().setUseWideViewPort(!enabled); } @ReactProp(name = "domStorageEnabled") public void setDomStorageEnabled(WebView view, boolean enabled) { view.getSettings().setDomStorageEnabled(enabled); } @ReactProp(name = "userAgent") public void setUserAgent(WebView view, @Nullable String userAgent) { if (userAgent != null) { // TODO(8496850): Fix incorrect behavior when property is unset (uA == null) view.getSettings().setUserAgentString(userAgent); } } @ReactProp(name = "mediaPlaybackRequiresUserAction") public void setMediaPlaybackRequiresUserAction(WebView view, boolean requires) { view.getSettings().setMediaPlaybackRequiresUserGesture(requires); } @ReactProp(name = "injectedJavaScript") public void setInjectedJavaScript(WebView view, @Nullable String injectedJavaScript) { ((BlockableWebView) view).setInjectedJavaScript(injectedJavaScript); } @ReactProp(name = "source") public void setSource(WebView view, @Nullable ReadableMap source) { if (source != null) { if (source.hasKey("html")) { String html = source.getString("html"); if (source.hasKey("baseUrl")) { view.loadDataWithBaseURL(source.getString("baseUrl"), html, HTML_MIME_TYPE, HTML_ENCODING, null); } else { view.loadData(html, HTML_MIME_TYPE, HTML_ENCODING); } return; } if (source.hasKey("uri")) { String url = source.getString("uri"); String previousUrl = view.getUrl(); if (previousUrl != null && previousUrl.equals(url)) { return; } if (source.hasKey("method")) { String method = source.getString("method"); if (method.equals(HTTP_METHOD_POST)) { byte[] postData = null; if (source.hasKey("body")) { String body = source.getString("body"); try { postData = body.getBytes("UTF-8"); } catch (UnsupportedEncodingException e) { postData = body.getBytes(); } } if (postData == null) { postData = new byte[0]; } view.postUrl(url, postData); return; } } HashMap<String, String> headerMap = new HashMap<>(); if (source.hasKey("headers")) { ReadableMap headers = source.getMap("headers"); ReadableMapKeySetIterator iter = headers.keySetIterator(); while (iter.hasNextKey()) { String key = iter.nextKey(); headerMap.put(key, headers.getString(key)); } } view.loadUrl(url, headerMap); return; } } view.loadUrl(BLANK_URL); } @ReactProp(name = "onContentSizeChange") public void setOnContentSizeChange(WebView view, boolean sendContentSizeChangeEvents) { if (sendContentSizeChangeEvents) { view.setPictureListener(getPictureListener()); } else { view.setPictureListener(null); } } @ReactProp(name = "navigationBlockingPolicies") public void setNavigationBlockingPolicies(WebView view, @Nullable ReadableArray policies) { ((BlockableWebView) view).setNavigationBlockingPolicies(policies); } @ReactProp(name = "availableHosts") public void setAvailableHosts(WebView view, @Nullable ReadableArray host) { ((BlockableWebView) view).setAvailableHosts(host); } @Override protected void addEventEmitters(ThemedReactContext reactContext, WebView view) { // Do not register default touch emitter and let WebView implementation handle touches view.setWebViewClient(new ReactWebViewClient()); } @Override public @Nullable Map<String, Integer> getCommandsMap() { return MapBuilder.of("goBack", COMMAND_GO_BACK, "goForward", COMMAND_GO_FORWARD, "reload", COMMAND_RELOAD, "stopLoading", COMMAND_STOP_LOADING); } @Nullable @Override public Map getExportedCustomDirectEventTypeConstants() { HashMap<String, Object> constants = new HashMap<String, Object>(); constants.put("navigationBlocked", MapBuilder.of("registrationName", "onNavigationBlocked")); return constants; } @Override public void receiveCommand(WebView root, int commandId, @Nullable ReadableArray args) { switch (commandId) { case COMMAND_GO_BACK: root.goBack(); break; case COMMAND_GO_FORWARD: root.goForward(); break; case COMMAND_RELOAD: root.reload(); break; case COMMAND_STOP_LOADING: root.stopLoading(); break; } } @Override public void onDropViewInstance(WebView webView) { super.onDropViewInstance(webView); ((ThemedReactContext) webView.getContext()).removeLifecycleEventListener((BlockableWebView) webView); ((BlockableWebView) webView).cleanupCallbacksAndDestroy(); } private WebView.PictureListener getPictureListener() { if (mPictureListener == null) { mPictureListener = new WebView.PictureListener() { @Override public void onNewPicture(WebView webView, Picture picture) { dispatchEvent(webView, new ContentSizeChangeEvent(webView.getId(), webView.getWidth(), webView.getContentHeight())); } }; } return mPictureListener; } private static void dispatchEvent(WebView webView, Event event) { ReactContext reactContext = (ReactContext) webView.getContext(); EventDispatcher eventDispatcher = reactContext.getNativeModule(UIManagerModule.class).getEventDispatcher(); eventDispatcher.dispatchEvent(event); } }