Skip to content

Commit 7b4b31a

Browse files
yk3372yk3372
authored
[webview_flutter][webview_flutter_android] Add android support for handling geolocation permissions (flutter#3795)
This PR Add android support for handling geolocation permissions. [(WebChromeClient.onGeolocationPermissionsShowPrompt)](https://developer.android.com/reference/android/webkit/WebChromeClient#onGeolocationPermissionsShowPrompt(java.lang.String,%20android.webkit.GeolocationPermissions.Callback)) api as a platform callback that notify the host application that web content from the specified origin is attempting to use the Geolocation API. The host application should invoke the specified callback with the desired permission state. Fixes flutter#27472
1 parent c0cba0b commit 7b4b31a

24 files changed

Lines changed: 1227 additions & 50 deletions

‎packages/webview_flutter/webview_flutter_android/AUTHORS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,5 @@ Alex Li <google@alexv525.com>
6666
Rahul Raj <64.rahulraj@gmail.com>
6767
Maurits van Beusekom <maurits@baseflow.com>
6868
Nick Bradshaw <nickalasb@gmail.com>
69+
Kai Yu <yk3372@gmail.com>
6970

‎packages/webview_flutter/webview_flutter_android/CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 3.8.0
2+
3+
* Adds support for handling geolocation permissions. See
4+
`AndroidWebViewController.setGeolocationPermissionsPromptCallbacks`.
5+
16
## 3.7.1
27

38
* Removes obsolete null checks on non-nullable values.

‎packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/GeneratedAndroidWebView.java‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2589,6 +2589,33 @@ public void onPermissionRequest(
25892589
new ArrayList<Object>(Arrays.asList(instanceIdArg, requestInstanceIdArg)),
25902590
channelReply -> callback.reply(null));
25912591
}
2592+
/** Callback to Dart function `WebChromeClient.onGeolocationPermissionsShowPrompt`. */
2593+
public void onGeolocationPermissionsShowPrompt(
2594+
@NonNull Long instanceIdArg,
2595+
@NonNull Long paramsInstanceIdArg,
2596+
@NonNull String originArg,
2597+
@NonNull Reply<Void> callback) {
2598+
BasicMessageChannel<Object> channel =
2599+
new BasicMessageChannel<>(
2600+
binaryMessenger,
2601+
"dev.flutter.pigeon.WebChromeClientFlutterApi.onGeolocationPermissionsShowPrompt",
2602+
getCodec());
2603+
channel.send(
2604+
new ArrayList<Object>(Arrays.asList(instanceIdArg, paramsInstanceIdArg, originArg)),
2605+
channelReply -> callback.reply(null));
2606+
}
2607+
/** Callback to Dart function `WebChromeClient.onGeolocationPermissionsHidePrompt`. */
2608+
public void onGeolocationPermissionsHidePrompt(
2609+
@NonNull Long identifierArg, @NonNull Reply<Void> callback) {
2610+
BasicMessageChannel<Object> channel =
2611+
new BasicMessageChannel<>(
2612+
binaryMessenger,
2613+
"dev.flutter.pigeon.WebChromeClientFlutterApi.onGeolocationPermissionsHidePrompt",
2614+
getCodec());
2615+
channel.send(
2616+
new ArrayList<Object>(Collections.singletonList(identifierArg)),
2617+
channelReply -> callback.reply(null));
2618+
}
25922619
}
25932620
/** Generated interface from Pigeon that represents a handler of messages from Flutter. */
25942621
public interface WebStorageHostApi {
@@ -2839,4 +2866,106 @@ public void create(
28392866
channelReply -> callback.reply(null));
28402867
}
28412868
}
2869+
/**
2870+
* Host API for `GeolocationPermissionsCallback`.
2871+
*
2872+
* <p>This class may handle instantiating and adding native object instances that are attached to
2873+
* a Dart instance or handle method calls on the associated native class or an instance of the
2874+
* class.
2875+
*
2876+
* <p>See https://developer.android.com/reference/android/webkit/GeolocationPermissions.Callback.
2877+
*
2878+
* <p>Generated interface from Pigeon that represents a handler of messages from Flutter.
2879+
*/
2880+
public interface GeolocationPermissionsCallbackHostApi {
2881+
/** Handles Dart method `GeolocationPermissionsCallback.invoke`. */
2882+
void invoke(
2883+
@NonNull Long instanceId,
2884+
@NonNull String origin,
2885+
@NonNull Boolean allow,
2886+
@NonNull Boolean retain);
2887+
2888+
/** The codec used by GeolocationPermissionsCallbackHostApi. */
2889+
static @NonNull MessageCodec<Object> getCodec() {
2890+
return new StandardMessageCodec();
2891+
}
2892+
/**
2893+
* Sets up an instance of `GeolocationPermissionsCallbackHostApi` to handle messages through the
2894+
* `binaryMessenger`.
2895+
*/
2896+
static void setup(
2897+
@NonNull BinaryMessenger binaryMessenger,
2898+
@Nullable GeolocationPermissionsCallbackHostApi api) {
2899+
{
2900+
BasicMessageChannel<Object> channel =
2901+
new BasicMessageChannel<>(
2902+
binaryMessenger,
2903+
"dev.flutter.pigeon.GeolocationPermissionsCallbackHostApi.invoke",
2904+
getCodec());
2905+
if (api != null) {
2906+
channel.setMessageHandler(
2907+
(message, reply) -> {
2908+
ArrayList<Object> wrapped = new ArrayList<Object>();
2909+
ArrayList<Object> args = (ArrayList<Object>) message;
2910+
Number instanceIdArg = (Number) args.get(0);
2911+
String originArg = (String) args.get(1);
2912+
Boolean allowArg = (Boolean) args.get(2);
2913+
Boolean retainArg = (Boolean) args.get(3);
2914+
try {
2915+
api.invoke(
2916+
(instanceIdArg == null) ? null : instanceIdArg.longValue(),
2917+
originArg,
2918+
allowArg,
2919+
retainArg);
2920+
wrapped.add(0, null);
2921+
} catch (Throwable exception) {
2922+
ArrayList<Object> wrappedError = wrapError(exception);
2923+
wrapped = wrappedError;
2924+
}
2925+
reply.reply(wrapped);
2926+
});
2927+
} else {
2928+
channel.setMessageHandler(null);
2929+
}
2930+
}
2931+
}
2932+
}
2933+
/**
2934+
* Flutter API for `GeolocationPermissionsCallback`.
2935+
*
2936+
* <p>This class may handle instantiating and adding Dart instances that are attached to a native
2937+
* instance or receiving callback methods from an overridden native class.
2938+
*
2939+
* <p>See https://developer.android.com/reference/android/webkit/GeolocationPermissions.Callback.
2940+
*
2941+
* <p>Generated class from Pigeon that represents Flutter messages that can be called from Java.
2942+
*/
2943+
public static class GeolocationPermissionsCallbackFlutterApi {
2944+
private final @NonNull BinaryMessenger binaryMessenger;
2945+
2946+
public GeolocationPermissionsCallbackFlutterApi(@NonNull BinaryMessenger argBinaryMessenger) {
2947+
this.binaryMessenger = argBinaryMessenger;
2948+
}
2949+
2950+
/** Public interface for sending reply. */
2951+
@SuppressWarnings("UnknownNullness")
2952+
public interface Reply<T> {
2953+
void reply(T reply);
2954+
}
2955+
/** The codec used by GeolocationPermissionsCallbackFlutterApi. */
2956+
static @NonNull MessageCodec<Object> getCodec() {
2957+
return new StandardMessageCodec();
2958+
}
2959+
/** Create a new Dart instance and add it to the `InstanceManager`. */
2960+
public void create(@NonNull Long instanceIdArg, @NonNull Reply<Void> callback) {
2961+
BasicMessageChannel<Object> channel =
2962+
new BasicMessageChannel<>(
2963+
binaryMessenger,
2964+
"dev.flutter.pigeon.GeolocationPermissionsCallbackFlutterApi.create",
2965+
getCodec());
2966+
channel.send(
2967+
new ArrayList<Object>(Collections.singletonList(instanceIdArg)),
2968+
channelReply -> callback.reply(null));
2969+
}
2970+
}
28422971
}

‎packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/GeolocationPermissionsCallbackFlutterApiImpl.java‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// Copyright 2013 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
package io.flutter.plugins.webviewflutter;
6+
7+
import android.webkit.GeolocationPermissions;
8+
import androidx.annotation.NonNull;
9+
import androidx.annotation.VisibleForTesting;
10+
import io.flutter.plugin.common.BinaryMessenger;
11+
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.GeolocationPermissionsCallbackFlutterApi;
12+
13+
/**
14+
* Flutter API implementation for `GeolocationPermissionsCallback`.
15+
*
16+
* <p>This class may handle adding native instances that are attached to a Dart instance or passing
17+
* arguments of callbacks methods to a Dart instance.
18+
*/
19+
public class GeolocationPermissionsCallbackFlutterApiImpl {
20+
// To ease adding additional methods, this value is added prematurely.
21+
@SuppressWarnings({"unused", "FieldCanBeLocal"})
22+
private final BinaryMessenger binaryMessenger;
23+
24+
private final InstanceManager instanceManager;
25+
private GeolocationPermissionsCallbackFlutterApi api;
26+
27+
/**
28+
* Constructs a {@link GeolocationPermissionsCallbackFlutterApiImpl}.
29+
*
30+
* @param binaryMessenger used to communicate with Dart over asynchronous messages
31+
* @param instanceManager maintains instances stored to communicate with attached Dart objects
32+
*/
33+
public GeolocationPermissionsCallbackFlutterApiImpl(
34+
@NonNull BinaryMessenger binaryMessenger, @NonNull InstanceManager instanceManager) {
35+
this.binaryMessenger = binaryMessenger;
36+
this.instanceManager = instanceManager;
37+
api = new GeolocationPermissionsCallbackFlutterApi(binaryMessenger);
38+
}
39+
40+
/**
41+
* Stores the `GeolocationPermissionsCallback` instance and notifies Dart to create and store a
42+
* new `GeolocationPermissionsCallback` instance that is attached to this one. If `instance` has
43+
* already been added, this method does nothing.
44+
*/
45+
public void create(
46+
@NonNull GeolocationPermissions.Callback instance,
47+
@NonNull GeolocationPermissionsCallbackFlutterApi.Reply<Void> callback) {
48+
if (!instanceManager.containsInstance(instance)) {
49+
api.create(instanceManager.addHostCreatedInstance(instance), callback);
50+
}
51+
}
52+
53+
/**
54+
* Sets the Flutter API used to send messages to Dart.
55+
*
56+
* <p>This is only visible for testing.
57+
*/
58+
@VisibleForTesting
59+
void setApi(@NonNull GeolocationPermissionsCallbackFlutterApi api) {
60+
this.api = api;
61+
}
62+
}

‎packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/GeolocationPermissionsCallbackHostApiImpl.java‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Copyright 2013 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
package io.flutter.plugins.webviewflutter;
6+
7+
import android.webkit.GeolocationPermissions;
8+
import androidx.annotation.NonNull;
9+
import io.flutter.plugin.common.BinaryMessenger;
10+
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.GeolocationPermissionsCallbackHostApi;
11+
import java.util.Objects;
12+
13+
/**
14+
* Host API implementation for `GeolocationPermissionsCallback`.
15+
*
16+
* <p>This class may handle instantiating and adding native object instances that are attached to a
17+
* Dart instance or handle method calls on the associated native class or an instance of the class.
18+
*/
19+
public class GeolocationPermissionsCallbackHostApiImpl
20+
implements GeolocationPermissionsCallbackHostApi {
21+
// To ease adding additional methods, this value is added prematurely.
22+
@SuppressWarnings({"unused", "FieldCanBeLocal"})
23+
private final BinaryMessenger binaryMessenger;
24+
25+
private final InstanceManager instanceManager;
26+
27+
/**
28+
* Constructs a {@link GeolocationPermissionsCallbackHostApiImpl}.
29+
*
30+
* @param binaryMessenger used to communicate with Dart over asynchronous messages
31+
* @param instanceManager maintains instances stored to communicate with attached Dart objects
32+
*/
33+
public GeolocationPermissionsCallbackHostApiImpl(
34+
@NonNull BinaryMessenger binaryMessenger, @NonNull InstanceManager instanceManager) {
35+
this.binaryMessenger = binaryMessenger;
36+
this.instanceManager = instanceManager;
37+
}
38+
39+
@Override
40+
public void invoke(
41+
@NonNull Long instanceId,
42+
@NonNull String origin,
43+
@NonNull Boolean allow,
44+
@NonNull Boolean retain) {
45+
getGeolocationPermissionsCallbackInstance(instanceId).invoke(origin, allow, retain);
46+
}
47+
48+
private GeolocationPermissions.Callback getGeolocationPermissionsCallbackInstance(
49+
@NonNull Long identifier) {
50+
return Objects.requireNonNull(instanceManager.getInstance(identifier));
51+
}
52+
}

‎packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebChromeClientFlutterApiImpl.java‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
package io.flutter.plugins.webviewflutter;
66

77
import android.os.Build;
8+
import android.webkit.GeolocationPermissions;
89
import android.webkit.PermissionRequest;
910
import android.webkit.WebChromeClient;
1011
import android.webkit.WebView;
@@ -72,6 +73,32 @@ public void onShowFileChooser(
7273
callback);
7374
}
7475

76+
/** Passes arguments from {@link WebChromeClient#onGeolocationPermissionsShowPrompt} to Dart. */
77+
public void onGeolocationPermissionsShowPrompt(
78+
@NonNull WebChromeClient webChromeClient,
79+
@NonNull String origin,
80+
@NonNull GeolocationPermissions.Callback callback,
81+
@NonNull WebChromeClientFlutterApi.Reply<Void> replyCallback) {
82+
new GeolocationPermissionsCallbackFlutterApiImpl(binaryMessenger, instanceManager)
83+
.create(callback, reply -> {});
84+
onGeolocationPermissionsShowPrompt(
85+
Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(webChromeClient)),
86+
Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(callback)),
87+
origin,
88+
replyCallback);
89+
}
90+
91+
/**
92+
* Sends a message to Dart to call `WebChromeClient.onGeolocationPermissionsHidePrompt` on the
93+
* Dart object representing `instance`.
94+
*/
95+
public void onGeolocationPermissionsHidePrompt(
96+
@NonNull WebChromeClient instance, @NonNull WebChromeClientFlutterApi.Reply<Void> callback) {
97+
super.onGeolocationPermissionsHidePrompt(
98+
Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(instance)),
99+
callback);
100+
}
101+
75102
/**
76103
* Sends a message to Dart to call `WebChromeClient.onPermissionRequest` on the Dart object
77104
* representing `instance`.

‎packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebChromeClientHostApiImpl.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import android.net.Uri;
88
import android.os.Build;
99
import android.os.Message;
10+
import android.webkit.GeolocationPermissions;
1011
import android.webkit.PermissionRequest;
1112
import android.webkit.ValueCallback;
1213
import android.webkit.WebChromeClient;
@@ -51,6 +52,17 @@ public void onProgressChanged(@NonNull WebView view, int progress) {
5152
flutterApi.onProgressChanged(this, view, (long) progress, reply -> {});
5253
}
5354

55+
@Override
56+
public void onGeolocationPermissionsShowPrompt(
57+
@NonNull String origin, @NonNull GeolocationPermissions.Callback callback) {
58+
flutterApi.onGeolocationPermissionsShowPrompt(this, origin, callback, reply -> {});
59+
}
60+
61+
@Override
62+
public void onGeolocationPermissionsHidePrompt() {
63+
flutterApi.onGeolocationPermissionsHidePrompt(this, reply -> {});
64+
}
65+
5466
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
5567
@SuppressWarnings("LambdaLast")
5668
@Override

‎packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebViewFlutterPlugin.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.CookieManagerHostApi;
1818
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.DownloadListenerHostApi;
1919
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.FlutterAssetManagerHostApi;
20+
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.GeolocationPermissionsCallbackHostApi;
2021
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.InstanceManagerHostApi;
2122
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.JavaObjectHostApi;
2223
import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.JavaScriptChannelHostApi;
@@ -137,6 +138,9 @@ private void setUp(
137138
PermissionRequestHostApi.setup(
138139
binaryMessenger, new PermissionRequestHostApiImpl(binaryMessenger, instanceManager));
139140
}
141+
GeolocationPermissionsCallbackHostApi.setup(
142+
binaryMessenger,
143+
new GeolocationPermissionsCallbackHostApiImpl(binaryMessenger, instanceManager));
140144
}
141145

142146
@Override

0 commit comments

Comments
 (0)