[webview_flutter][webview_flutter_android] Add android support for handling geolocation permissions

packages/webview_flutter/webview_flutter_android/AUTHORS

@@ -66,4 +66,5 @@ Alex Li <[email protected]>
 Rahul Raj <[email protected]>
 Maurits van Beusekom <[email protected]>
 Nick Bradshaw <[email protected]>
+Kai Yu <[email protected]>
 

packages/webview_flutter/webview_flutter_android/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.8.0
+
+* Adds support for handling geolocation permissions. See
+  `AndroidWebViewController.setGeolocationPermissionsPromptCallbacks`.
+
 ## 3.7.1
 
 * Removes obsolete null checks on non-nullable values.

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

@@ -2589,6 +2589,33 @@ public void onPermissionRequest(
           new ArrayList<Object>(Arrays.asList(instanceIdArg, requestInstanceIdArg)),
           channelReply -> callback.reply(null));
     }
+    /** Callback to Dart function `WebChromeClient.onGeolocationPermissionsShowPrompt`. */
+    public void onGeolocationPermissionsShowPrompt(
+        @NonNull Long instanceIdArg,
+        @NonNull Long paramsInstanceIdArg,
+        @NonNull String originArg,
+        @NonNull Reply<Void> callback) {
+      BasicMessageChannel<Object> channel =
+          new BasicMessageChannel<>(
+              binaryMessenger,
+              "dev.flutter.pigeon.WebChromeClientFlutterApi.onGeolocationPermissionsShowPrompt",
+              getCodec());
+      channel.send(
+          new ArrayList<Object>(Arrays.asList(instanceIdArg, paramsInstanceIdArg, originArg)),
+          channelReply -> callback.reply(null));
+    }
+    /** Callback to Dart function `WebChromeClient.onGeolocationPermissionsHidePrompt`. */
+    public void onGeolocationPermissionsHidePrompt(
+        @NonNull Long identifierArg, @NonNull Reply<Void> callback) {
+      BasicMessageChannel<Object> channel =
+          new BasicMessageChannel<>(
+              binaryMessenger,
+              "dev.flutter.pigeon.WebChromeClientFlutterApi.onGeolocationPermissionsHidePrompt",
+              getCodec());
+      channel.send(
+          new ArrayList<Object>(Collections.singletonList(identifierArg)),
+          channelReply -> callback.reply(null));
+    }
   }
   /** Generated interface from Pigeon that represents a handler of messages from Flutter. */
   public interface WebStorageHostApi {
@@ -2839,4 +2866,106 @@ public void create(
           channelReply -> callback.reply(null));
     }
   }
+  /**
+   * Host API for `GeolocationPermissionsCallback`.
+   *
+   * <p>This class may handle instantiating and adding native object instances that are attached to
+   * a Dart instance or handle method calls on the associated native class or an instance of the
+   * class.
+   *
+   * <p>See https://developer.android.com/reference/android/webkit/GeolocationPermissions.Callback.
+   *
+   * <p>Generated interface from Pigeon that represents a handler of messages from Flutter.
+   */
+  public interface GeolocationPermissionsCallbackHostApi {
+    /** Handles Dart method `GeolocationPermissionsCallback.invoke`. */
+    void invoke(
+        @NonNull Long instanceId,
+        @NonNull String origin,
+        @NonNull Boolean allow,
+        @NonNull Boolean retain);
+
+    /** The codec used by GeolocationPermissionsCallbackHostApi. */
+    static @NonNull MessageCodec<Object> getCodec() {
+      return new StandardMessageCodec();
+    }
+    /**
+     * Sets up an instance of `GeolocationPermissionsCallbackHostApi` to handle messages through the
+     * `binaryMessenger`.
+     */
+    static void setup(
+        @NonNull BinaryMessenger binaryMessenger,
+        @Nullable GeolocationPermissionsCallbackHostApi api) {
+      {
+        BasicMessageChannel<Object> channel =
+            new BasicMessageChannel<>(
+                binaryMessenger,
+                "dev.flutter.pigeon.GeolocationPermissionsCallbackHostApi.invoke",
+                getCodec());
+        if (api != null) {
+          channel.setMessageHandler(
+              (message, reply) -> {
+                ArrayList<Object> wrapped = new ArrayList<Object>();
+                ArrayList<Object> args = (ArrayList<Object>) message;
+                Number instanceIdArg = (Number) args.get(0);
+                String originArg = (String) args.get(1);
+                Boolean allowArg = (Boolean) args.get(2);
+                Boolean retainArg = (Boolean) args.get(3);
+                try {
+                  api.invoke(
+                      (instanceIdArg == null) ? null : instanceIdArg.longValue(),
+                      originArg,
+                      allowArg,
+                      retainArg);
+                  wrapped.add(0, null);
+                } catch (Throwable exception) {
+                  ArrayList<Object> wrappedError = wrapError(exception);
+                  wrapped = wrappedError;
+                }
+                reply.reply(wrapped);
+              });
+        } else {
+          channel.setMessageHandler(null);
+        }
+      }
+    }
+  }
+  /**
+   * Flutter API for `GeolocationPermissionsCallback`.
+   *
+   * <p>This class may handle instantiating and adding Dart instances that are attached to a native
+   * instance or receiving callback methods from an overridden native class.
+   *
+   * <p>See https://developer.android.com/reference/android/webkit/GeolocationPermissions.Callback.
+   *
+   * <p>Generated class from Pigeon that represents Flutter messages that can be called from Java.
+   */
+  public static class GeolocationPermissionsCallbackFlutterApi {
+    private final @NonNull BinaryMessenger binaryMessenger;
+
+    public GeolocationPermissionsCallbackFlutterApi(@NonNull BinaryMessenger argBinaryMessenger) {
+      this.binaryMessenger = argBinaryMessenger;
+    }
+
+    /** Public interface for sending reply. */
+    @SuppressWarnings("UnknownNullness")
+    public interface Reply<T> {
+      void reply(T reply);
+    }
+    /** The codec used by GeolocationPermissionsCallbackFlutterApi. */
+    static @NonNull MessageCodec<Object> getCodec() {
+      return new StandardMessageCodec();
+    }
+    /** Create a new Dart instance and add it to the `InstanceManager`. */
+    public void create(@NonNull Long instanceIdArg, @NonNull Reply<Void> callback) {
+      BasicMessageChannel<Object> channel =
+          new BasicMessageChannel<>(
+              binaryMessenger,
+              "dev.flutter.pigeon.GeolocationPermissionsCallbackFlutterApi.create",
+              getCodec());
+      channel.send(
+          new ArrayList<Object>(Collections.singletonList(instanceIdArg)),
+          channelReply -> callback.reply(null));
+    }
+  }
 }

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

@@ -0,0 +1,62 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.webviewflutter;
+
+import android.webkit.GeolocationPermissions;
+import androidx.annotation.NonNull;
+import androidx.annotation.VisibleForTesting;
+import io.flutter.plugin.common.BinaryMessenger;
+import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.GeolocationPermissionsCallbackFlutterApi;
+
+/**
+ * Flutter API implementation for `GeolocationPermissionsCallback`.
+ *
+ * <p>This class may handle adding native instances that are attached to a Dart instance or passing
+ * arguments of callbacks methods to a Dart instance.
+ */
+public class GeolocationPermissionsCallbackFlutterApiImpl {
+  // To ease adding additional methods, this value is added prematurely.
+  @SuppressWarnings({"unused", "FieldCanBeLocal"})
+  private final BinaryMessenger binaryMessenger;
+
+  private final InstanceManager instanceManager;
+  private GeolocationPermissionsCallbackFlutterApi api;
+
+  /**
+   * Constructs a {@link GeolocationPermissionsCallbackFlutterApiImpl}.
+   *
+   * @param binaryMessenger used to communicate with Dart over asynchronous messages
+   * @param instanceManager maintains instances stored to communicate with attached Dart objects
+   */
+  public GeolocationPermissionsCallbackFlutterApiImpl(
+      @NonNull BinaryMessenger binaryMessenger, @NonNull InstanceManager instanceManager) {
+    this.binaryMessenger = binaryMessenger;
+    this.instanceManager = instanceManager;
+    api = new GeolocationPermissionsCallbackFlutterApi(binaryMessenger);
+  }
+
+  /**
+   * Stores the `GeolocationPermissionsCallback` instance and notifies Dart to create and store a
+   * new `GeolocationPermissionsCallback` instance that is attached to this one. If `instance` has
+   * already been added, this method does nothing.
+   */
+  public void create(
+      @NonNull GeolocationPermissions.Callback instance,
+      @NonNull GeolocationPermissionsCallbackFlutterApi.Reply<Void> callback) {
+    if (!instanceManager.containsInstance(instance)) {
+      api.create(instanceManager.addHostCreatedInstance(instance), callback);
+    }
+  }
+
+  /**
+   * Sets the Flutter API used to send messages to Dart.
+   *
+   * <p>This is only visible for testing.
+   */
+  @VisibleForTesting
+  void setApi(@NonNull GeolocationPermissionsCallbackFlutterApi api) {
+    this.api = api;
+  }
+}

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

@@ -0,0 +1,52 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.webviewflutter;
+
+import android.webkit.GeolocationPermissions;
+import androidx.annotation.NonNull;
+import io.flutter.plugin.common.BinaryMessenger;
+import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.GeolocationPermissionsCallbackHostApi;
+import java.util.Objects;
+
+/**
+ * Host API implementation for `GeolocationPermissionsCallback`.
+ *
+ * <p>This class may handle instantiating and adding native object instances that are attached to a
+ * Dart instance or handle method calls on the associated native class or an instance of the class.
+ */
+public class GeolocationPermissionsCallbackHostApiImpl
+    implements GeolocationPermissionsCallbackHostApi {
+  // To ease adding additional methods, this value is added prematurely.
+  @SuppressWarnings({"unused", "FieldCanBeLocal"})
+  private final BinaryMessenger binaryMessenger;
+
+  private final InstanceManager instanceManager;
+
+  /**
+   * Constructs a {@link GeolocationPermissionsCallbackHostApiImpl}.
+   *
+   * @param binaryMessenger used to communicate with Dart over asynchronous messages
+   * @param instanceManager maintains instances stored to communicate with attached Dart objects
+   */
+  public GeolocationPermissionsCallbackHostApiImpl(
+      @NonNull BinaryMessenger binaryMessenger, @NonNull InstanceManager instanceManager) {
+    this.binaryMessenger = binaryMessenger;
+    this.instanceManager = instanceManager;
+  }
+
+  @Override
+  public void invoke(
+      @NonNull Long instanceId,
+      @NonNull String origin,
+      @NonNull Boolean allow,
+      @NonNull Boolean retain) {
+    getGeolocationPermissionsCallbackInstance(instanceId).invoke(origin, allow, retain);
+  }
+
+  private GeolocationPermissions.Callback getGeolocationPermissionsCallbackInstance(
+      @NonNull Long identifier) {
+    return Objects.requireNonNull(instanceManager.getInstance(identifier));
+  }
+}

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

@@ -5,6 +5,7 @@
 package io.flutter.plugins.webviewflutter;
 
 import android.os.Build;
+import android.webkit.GeolocationPermissions;
 import android.webkit.PermissionRequest;
 import android.webkit.WebChromeClient;
 import android.webkit.WebView;
@@ -72,6 +73,32 @@ public void onShowFileChooser(
         callback);
   }
 
+  /** Passes arguments from {@link WebChromeClient#onGeolocationPermissionsShowPrompt} to Dart. */
+  public void onGeolocationPermissionsShowPrompt(
+      @NonNull WebChromeClient webChromeClient,
+      @NonNull String origin,
+      @NonNull GeolocationPermissions.Callback callback,
+      @NonNull WebChromeClientFlutterApi.Reply<Void> replyCallback) {
+    new GeolocationPermissionsCallbackFlutterApiImpl(binaryMessenger, instanceManager)
+        .create(callback, reply -> {});
+    onGeolocationPermissionsShowPrompt(
+        Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(webChromeClient)),
+        Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(callback)),
+        origin,
+        replyCallback);
+  }
+
+  /**
+   * Sends a message to Dart to call `WebChromeClient.onGeolocationPermissionsHidePrompt` on the
+   * Dart object representing `instance`.
+   */
+  public void onGeolocationPermissionsHidePrompt(
+      @NonNull WebChromeClient instance, @NonNull WebChromeClientFlutterApi.Reply<Void> callback) {
+    super.onGeolocationPermissionsHidePrompt(
+        Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(instance)),
+        callback);
+  }
+
   /**
    * Sends a message to Dart to call `WebChromeClient.onPermissionRequest` on the Dart object
    * representing `instance`.

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

@@ -7,6 +7,7 @@
 import android.net.Uri;
 import android.os.Build;
 import android.os.Message;
+import android.webkit.GeolocationPermissions;
 import android.webkit.PermissionRequest;
 import android.webkit.ValueCallback;
 import android.webkit.WebChromeClient;
@@ -51,6 +52,17 @@ public void onProgressChanged(@NonNull WebView view, int progress) {
       flutterApi.onProgressChanged(this, view, (long) progress, reply -> {});
     }
 
+    @Override
+    public void onGeolocationPermissionsShowPrompt(
+        @NonNull String origin, @NonNull GeolocationPermissions.Callback callback) {
+      flutterApi.onGeolocationPermissionsShowPrompt(this, origin, callback, reply -> {});
+    }
+
+    @Override
+    public void onGeolocationPermissionsHidePrompt() {
+      flutterApi.onGeolocationPermissionsHidePrompt(this, reply -> {});
+    }
+
     @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
     @SuppressWarnings("LambdaLast")
     @Override

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

@@ -17,6 +17,7 @@
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.CookieManagerHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.DownloadListenerHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.FlutterAssetManagerHostApi;
+import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.GeolocationPermissionsCallbackHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.InstanceManagerHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.JavaObjectHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.JavaScriptChannelHostApi;
@@ -137,6 +138,9 @@ private void setUp(
       PermissionRequestHostApi.setup(
           binaryMessenger, new PermissionRequestHostApiImpl(binaryMessenger, instanceManager));
     }
+    GeolocationPermissionsCallbackHostApi.setup(
+        binaryMessenger,
+        new GeolocationPermissionsCallbackHostApiImpl(binaryMessenger, instanceManager));
   }
 
   @Override