@capacitor/android 4.0.1-alpha.0 → 4.0.1

package/capacitor/src/main/java/com/getcapacitor/BridgeActivity.java

@@ -12,11 +12,11 @@ public class BridgeActivity extends AppCompatActivity {
 
     protected Bridge bridge;
     protected boolean keepRunning = true;
-    private CapConfig config;
+    protected CapConfig config;
 
-    private int activityDepth = 0;
-    private List<Class<? extends Plugin>> initialPlugins = new ArrayList<>();
-    private final Bridge.Builder bridgeBuilder = new Bridge.Builder(this);
+    protected int activityDepth = 0;
+    protected List<Class<? extends Plugin>> initialPlugins = new ArrayList<>();
+    protected final Bridge.Builder bridgeBuilder = new Bridge.Builder(this);
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
@@ -26,47 +26,18 @@ public class BridgeActivity extends AppCompatActivity {
         setTheme(getResources().getIdentifier("AppTheme_NoActionBar", "style", getPackageName()));
         setTheme(R.style.AppTheme_NoActionBar);
         setContentView(R.layout.bridge_layout_main);
-    }
-
-    /**
-     * Initializes the Capacitor Bridge with the Activity.
-     * @deprecated It is preferred not to call this method. If it is not called, the bridge is
-     * initialized automatically. If you need to add additional plugins during initialization,
-     * use {@link #registerPlugin(Class)} or {@link #registerPlugins(List)}.
-     *
-     * @param plugins A list of plugins to initialize with Capacitor
-     */
-    @Deprecated
-    protected void init(Bundle savedInstanceState, List<Class<? extends Plugin>> plugins) {
-        this.init(savedInstanceState, plugins, null);
-    }
-
-    /**
-     * Initializes the Capacitor Bridge with the Activity.
-     * @deprecated It is preferred not to call this method. If it is not called, the bridge is
-     * initialized automatically. If you need to add additional plugins during initialization,
-     * use {@link #registerPlugin(Class)} or {@link #registerPlugins(List)}.
-     *
-     * @param plugins A list of plugins to initialize with Capacitor
-     * @param config An instance of a Capacitor Configuration to use. If null, will load from file
-     */
-    @Deprecated
-    protected void init(Bundle savedInstanceState, List<Class<? extends Plugin>> plugins, CapConfig config) {
-        this.initialPlugins = plugins;
-        this.config = config;
+        PluginManager loader = new PluginManager(getAssets());
 
-        this.load();
-    }
+        try {
+            bridgeBuilder.addPlugins(loader.loadPluginClasses());
+        } catch (PluginLoadException ex) {
+            Logger.error("Error loading plugins.", ex);
+        }
 
-    /**
-     * @deprecated This method should not be called manually.
-     */
-    @Deprecated
-    protected void load(Bundle savedInstanceState) {
         this.load();
     }
 
-    private void load() {
+    protected void load() {
         Logger.debug("Starting BridgeActivity");
 
         bridge = bridgeBuilder.addPlugins(initialPlugins).setConfig(config).create();
@@ -96,20 +67,6 @@ public class BridgeActivity extends AppCompatActivity {
     @Override
     public void onStart() {
         super.onStart();
-
-        // Preferred behavior: init() was not called, so we construct the bridge with auto-loaded plugins.
-        if (bridge == null) {
-            PluginManager loader = new PluginManager(getAssets());
-
-            try {
-                bridgeBuilder.addPlugins(loader.loadPluginClasses());
-            } catch (PluginLoadException ex) {
-                Logger.error("Error loading plugins.", ex);
-            }
-
-            this.load();
-        }
-
         activityDepth++;
         this.bridge.onStart();
         Logger.debug("App started");

package/capacitor/src/main/java/com/getcapacitor/BridgeWebChromeClient.java

@@ -147,7 +147,6 @@ public class BridgeWebChromeClient extends WebChromeClient {
         AlertDialog.Builder builder = new AlertDialog.Builder(view.getContext());
         builder
             .setMessage(message)
-            .setTitle("Alert")
             .setPositiveButton(
                 "OK",
                 (dialog, buttonIndex) -> {
@@ -187,7 +186,6 @@ public class BridgeWebChromeClient extends WebChromeClient {
 
         builder
             .setMessage(message)
-            .setTitle("Confirm")
             .setPositiveButton(
                 "OK",
                 (dialog, buttonIndex) -> {
@@ -236,7 +234,6 @@ public class BridgeWebChromeClient extends WebChromeClient {
 
         builder
             .setMessage(message)
-            .setTitle("Prompt")
             .setView(input)
             .setPositiveButton(
                 "OK",
@@ -286,8 +283,10 @@ public class BridgeWebChromeClient extends WebChromeClient {
                         callback.invoke(origin, true, false);
                     } else {
                         final String[] coarsePermission = { Manifest.permission.ACCESS_COARSE_LOCATION };
-                        // TODO replace with Build.VERSION_CODES.S once we target SDK 31
-                        if (Build.VERSION.SDK_INT >= 31 && PermissionHelper.hasPermissions(bridge.getContext(), coarsePermission)) {
+                        if (
+                            Build.VERSION.SDK_INT >= Build.VERSION_CODES.S &&
+                            PermissionHelper.hasPermissions(bridge.getContext(), coarsePermission)
+                        ) {
                             callback.invoke(origin, true, false);
                         } else {
                             callback.invoke(origin, false, false);

package/capacitor/src/main/java/com/getcapacitor/BridgeWebViewClient.java

@@ -28,6 +28,7 @@ public class BridgeWebViewClient extends WebViewClient {
         return bridge.launchIntent(url);
     }
 
+    @Deprecated
     @Override
     public boolean shouldOverrideUrlLoading(WebView view, String url) {
         return bridge.launchIntent(Uri.parse(url));
@@ -55,6 +56,11 @@ public class BridgeWebViewClient extends WebViewClient {
                 listener.onReceivedError(view);
             }
         }
+
+        String errorPath = bridge.getErrorUrl();
+        if (errorPath != null && request.isForMainFrame()) {
+            view.loadUrl(errorPath);
+        }
     }
 
     @Override
@@ -80,5 +86,10 @@ public class BridgeWebViewClient extends WebViewClient {
                 listener.onReceivedHttpError(view);
             }
         }
+
+        String errorPath = bridge.getErrorUrl();
+        if (errorPath != null && request.isForMainFrame()) {
+            view.loadUrl(errorPath);
+        }
     }
 }

package/capacitor/src/main/java/com/getcapacitor/CapConfig.java

@@ -1,6 +1,8 @@
 package com.getcapacitor;
 
 import static com.getcapacitor.Bridge.CAPACITOR_HTTP_SCHEME;
+import static com.getcapacitor.Bridge.DEFAULT_ANDROID_WEBVIEW_VERSION;
+import static com.getcapacitor.Bridge.MINIMUM_ANDROID_WEBVIEW_VERSION;
 import static com.getcapacitor.FileUtils.readFile;
 
 import android.content.Context;
@@ -9,8 +11,10 @@ import android.content.res.AssetManager;
 import androidx.annotation.Nullable;
 import com.getcapacitor.util.JSONUtils;
 import java.io.IOException;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Iterator;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import org.json.JSONException;
@@ -40,6 +44,9 @@ public class CapConfig {
     private boolean captureInput = false;
     private boolean webContentsDebuggingEnabled = false;
     private boolean loggingEnabled = true;
+    private boolean initialFocus = true;
+    private int minWebViewVersion = DEFAULT_ANDROID_WEBVIEW_VERSION;
+    private String errorPath;
 
     // Embedded
     private String startPath;
@@ -105,7 +112,11 @@ public class CapConfig {
         this.html5mode = builder.html5mode;
         this.serverUrl = builder.serverUrl;
         this.hostname = builder.hostname;
-        this.androidScheme = builder.androidScheme;
+
+        if (this.validateScheme(builder.androidScheme)) {
+            this.androidScheme = builder.androidScheme;
+        }
+
         this.allowNavigation = builder.allowNavigation;
 
         // Android Config
@@ -116,6 +127,9 @@ public class CapConfig {
         this.captureInput = builder.captureInput;
         this.webContentsDebuggingEnabled = builder.webContentsDebuggingEnabled;
         this.loggingEnabled = builder.loggingEnabled;
+        this.initialFocus = builder.initialFocus;
+        this.minWebViewVersion = builder.minWebViewVersion;
+        this.errorPath = builder.errorPath;
 
         // Embedded
         this.startPath = builder.startPath;
@@ -148,7 +162,13 @@ public class CapConfig {
         html5mode = JSONUtils.getBoolean(configJSON, "server.html5mode", html5mode);
         serverUrl = JSONUtils.getString(configJSON, "server.url", null);
         hostname = JSONUtils.getString(configJSON, "server.hostname", hostname);
-        androidScheme = JSONUtils.getString(configJSON, "server.androidScheme", androidScheme);
+        errorPath = JSONUtils.getString(configJSON, "server.errorPath", null);
+
+        String configSchema = JSONUtils.getString(configJSON, "server.androidScheme", androidScheme);
+        if (this.validateScheme(configSchema)) {
+            androidScheme = configSchema;
+        }
+
         allowNavigation = JSONUtils.getArray(configJSON, "server.allowNavigation", null);
 
         // Android
@@ -164,6 +184,7 @@ public class CapConfig {
                 "android.allowMixedContent",
                 JSONUtils.getBoolean(configJSON, "allowMixedContent", allowMixedContent)
             );
+        minWebViewVersion = JSONUtils.getInt(configJSON, "android.minWebViewVersion", DEFAULT_ANDROID_WEBVIEW_VERSION);
         captureInput = JSONUtils.getBoolean(configJSON, "android.captureInput", captureInput);
         webContentsDebuggingEnabled = JSONUtils.getBoolean(configJSON, "android.webContentsDebuggingEnabled", isDebug);
 
@@ -187,10 +208,22 @@ public class CapConfig {
                 loggingEnabled = isDebug;
         }
 
+        initialFocus = JSONUtils.getBoolean(configJSON, "android.initialFocus", initialFocus);
+
         // Plugins
         pluginsConfiguration = deserializePluginsConfig(JSONUtils.getObject(configJSON, "plugins"));
     }
 
+    private boolean validateScheme(String scheme) {
+        List<String> invalidSchemes = Arrays.asList("file", "ftp", "ftps", "ws", "wss", "about", "blob", "data");
+        if (invalidSchemes.contains(scheme)) {
+            Logger.warn(scheme + " is not an allowed scheme.  Defaulting to http.");
+            return false;
+        }
+
+        return true;
+    }
+
     public boolean isHTML5Mode() {
         return html5mode;
     }
@@ -199,6 +232,10 @@ public class CapConfig {
         return serverUrl;
     }
 
+    public String getErrorPath() {
+        return errorPath;
+    }
+
     public String getHostname() {
         return hostname;
     }
@@ -243,6 +280,19 @@ public class CapConfig {
         return loggingEnabled;
     }
 
+    public boolean isInitialFocus() {
+        return initialFocus;
+    }
+
+    public int getMinWebViewVersion() {
+        if (minWebViewVersion < MINIMUM_ANDROID_WEBVIEW_VERSION) {
+            Logger.warn("Specified minimum webview version is too low, defaulting to " + MINIMUM_ANDROID_WEBVIEW_VERSION);
+            return MINIMUM_ANDROID_WEBVIEW_VERSION;
+        }
+
+        return minWebViewVersion;
+    }
+
     public PluginConfig getPluginConfiguration(String pluginId) {
         PluginConfig pluginConfig = pluginsConfiguration.get(pluginId);
         if (pluginConfig == null) {
@@ -386,6 +436,7 @@ public class CapConfig {
         // Server Config Values
         private boolean html5mode = true;
         private String serverUrl;
+        private String errorPath;
         private String hostname = "localhost";
         private String androidScheme = CAPACITOR_HTTP_SCHEME;
         private String[] allowNavigation;
@@ -398,6 +449,8 @@ public class CapConfig {
         private boolean captureInput = false;
         private Boolean webContentsDebuggingEnabled = null;
         private boolean loggingEnabled = true;
+        private boolean initialFocus = false;
+        private int minWebViewVersion = DEFAULT_ANDROID_WEBVIEW_VERSION;
 
         // Embedded
         private String startPath = null;
@@ -442,6 +495,11 @@ public class CapConfig {
             return this;
         }
 
+        public Builder setErrorPath(String errorPath) {
+            this.errorPath = errorPath;
+            return this;
+        }
+
         public Builder setHostname(String hostname) {
             this.hostname = hostname;
             return this;
@@ -496,5 +554,10 @@ public class CapConfig {
             this.loggingEnabled = enabled;
             return this;
         }
+
+        public Builder setInitialFocus(boolean focus) {
+            this.initialFocus = focus;
+            return this;
+        }
     }
 }

package/capacitor/src/main/java/com/getcapacitor/CapacitorWebView.java

@@ -30,6 +30,7 @@ public class CapacitorWebView extends WebView {
     }
 
     @Override
+    @SuppressWarnings("deprecation")
     public boolean dispatchKeyEvent(KeyEvent event) {
         if (event.getAction() == KeyEvent.ACTION_MULTIPLE) {
             evaluateJavascript("document.activeElement.value = document.activeElement.value + '" + event.getCharacters() + "';", null);

package/capacitor/src/main/java/com/getcapacitor/FileUtils.java

@@ -77,7 +77,7 @@ public class FileUtils {
                 final String type = split[0];
 
                 if ("primary".equalsIgnoreCase(type)) {
-                    return Environment.getExternalStorageDirectory() + "/" + split[1];
+                    return legacyPrimaryPath(split[1]);
                 } else {
                     final int splitIndex = docId.indexOf(':', 1);
                     final String tag = docId.substring(0, splitIndex);
@@ -136,6 +136,11 @@ public class FileUtils {
         return null;
     }
 
+    @SuppressWarnings("deprecation")
+    private static String legacyPrimaryPath(String pathPart) {
+        return Environment.getExternalStorageDirectory() + "/" + pathPart;
+    }
+
     /**
      * Read a plaintext file.
      *

package/capacitor/src/main/java/com/getcapacitor/JSExport.java

@@ -94,7 +94,7 @@ public class JSExport {
                 return readFile(context.getAssets(), path);
             }
         } catch (IOException ex) {
-            Logger.error("Unable to read file at path " + path);
+            Logger.warn("Unable to read file at path " + path);
         }
         return builder.toString();
     }

package/capacitor/src/main/java/com/getcapacitor/MessageHandler.java

@@ -1,7 +1,12 @@
 package com.getcapacitor;
 
+import android.net.Uri;
 import android.webkit.JavascriptInterface;
 import android.webkit.WebView;
+import androidx.webkit.JavaScriptReplyProxy;
+import androidx.webkit.WebMessageCompat;
+import androidx.webkit.WebViewCompat;
+import androidx.webkit.WebViewFeature;
 import org.apache.cordova.PluginManager;
 
 /**
@@ -13,13 +18,31 @@ public class MessageHandler {
     private Bridge bridge;
     private WebView webView;
     private PluginManager cordovaPluginManager;
+    private JavaScriptReplyProxy javaScriptReplyProxy;
 
     public MessageHandler(Bridge bridge, WebView webView, PluginManager cordovaPluginManager) {
         this.bridge = bridge;
         this.webView = webView;
         this.cordovaPluginManager = cordovaPluginManager;
 
-        webView.addJavascriptInterface(this, "androidBridge");
+        WebViewCompat.WebMessageListener capListener = (view, message, sourceOrigin, isMainFrame, replyProxy) -> {
+            if (isMainFrame) {
+                postMessage(message.getData());
+                javaScriptReplyProxy = replyProxy;
+            } else {
+                Logger.warn("Plugin execution is allowed in Main Frame only");
+            }
+        };
+
+        if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) {
+            try {
+                WebViewCompat.addWebMessageListener(webView, "androidBridge", bridge.getAllowedOriginRules(), capListener);
+            } catch (Exception ex) {
+                webView.addJavascriptInterface(this, "androidBridge");
+            }
+        } else {
+            webView.addJavascriptInterface(this, "androidBridge");
+        }
     }
 
     /**
@@ -100,9 +123,13 @@ public class MessageHandler {
 
             boolean isValidCallbackId = !call.getCallbackId().equals(PluginCall.CALLBACK_ID_DANGLING);
             if (isValidCallbackId) {
-                final String runScript = "window.Capacitor.fromNative(" + data.toString() + ")";
-                final WebView webView = this.webView;
-                webView.post(() -> webView.evaluateJavascript(runScript, null));
+                if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER) && javaScriptReplyProxy != null) {
+                    javaScriptReplyProxy.postMessage(data.toString());
+                } else {
+                    final String runScript = "window.Capacitor.fromNative(" + data.toString() + ")";
+                    final WebView webView = this.webView;
+                    webView.post(() -> webView.evaluateJavascript(runScript, null));
+                }
             } else {
                 bridge.getApp().fireRestoredResult(data);
             }

package/capacitor/src/main/java/com/getcapacitor/Plugin.java

@@ -745,9 +745,10 @@ public class Plugin {
      * @param call
      */
     @SuppressWarnings("unused")
-    @PluginMethod(returnType = PluginMethod.RETURN_NONE)
+    @PluginMethod(returnType = PluginMethod.RETURN_PROMISE)
     public void removeAllListeners(PluginCall call) {
         eventListeners.clear();
+        call.resolve();
     }
 
     /**
@@ -788,15 +789,7 @@ public class Plugin {
     public void requestPermissions(PluginCall call) {
         CapacitorPlugin annotation = handle.getPluginAnnotation();
         if (annotation == null) {
-            // handle permission requests for plugins defined with @NativePlugin (prior to 3.0.0)
-            NativePlugin legacyAnnotation = this.handle.getLegacyPluginAnnotation();
-            String[] perms = legacyAnnotation.permissions();
-            if (perms.length > 0) {
-                saveCall(call);
-                pluginRequestPermissions(perms, legacyAnnotation.permissionRequestCode());
-            } else {
-                call.resolve();
-            }
+            handleLegacyPermission(call);
         } else {
             // handle permission requests for plugins defined with @CapacitorPlugin (since 3.0.0)
             String[] permAliases = null;
@@ -862,6 +855,19 @@ public class Plugin {
         }
     }
 
+    @SuppressWarnings("deprecation")
+    private void handleLegacyPermission(PluginCall call) {
+        // handle permission requests for plugins defined with @NativePlugin (prior to 3.0.0)
+        NativePlugin legacyAnnotation = this.handle.getLegacyPluginAnnotation();
+        String[] perms = legacyAnnotation.permissions();
+        if (perms.length > 0) {
+            saveCall(call);
+            pluginRequestPermissions(perms, legacyAnnotation.permissionRequestCode());
+        } else {
+            call.resolve();
+        }
+    }
+
     /**
      * Handle request permissions result. A plugin using the deprecated {@link NativePlugin}
      * should override this to handle the result, or this method will handle the result

package/capacitor/src/main/java/com/getcapacitor/PluginCall.java

@@ -96,7 +96,7 @@ public class PluginCall {
      */
     @Deprecated
     public void error(String msg, Exception ex) {
-        reject(msg, null, ex);
+        reject(msg, ex);
     }
 
     /**
@@ -114,10 +114,10 @@ public class PluginCall {
      */
     @Deprecated
     public void error(String msg) {
-        reject(msg, null, null);
+        reject(msg);
     }
 
-    public void reject(String msg, String code, Exception ex) {
+    public void reject(String msg, String code, Exception ex, JSObject data) {
         PluginResult errorResult = new PluginResult();
 
         if (ex != null) {
@@ -127,23 +127,42 @@ public class PluginCall {
         try {
             errorResult.put("message", msg);
             errorResult.put("code", code);
+            if (null != data) {
+                errorResult.put("data", data);
+            }
         } catch (Exception jsonEx) {
-            Logger.error(Logger.tags("Plugin"), jsonEx.getMessage(), null);
+            Logger.error(Logger.tags("Plugin"), jsonEx.getMessage(), jsonEx);
         }
 
         this.msgHandler.sendResponseMessage(this, null, errorResult);
     }
 
+    public void reject(String msg, Exception ex, JSObject data) {
+        reject(msg, null, ex, data);
+    }
+
+    public void reject(String msg, String code, JSObject data) {
+        reject(msg, code, null, data);
+    }
+
+    public void reject(String msg, String code, Exception ex) {
+        reject(msg, code, ex, null);
+    }
+
+    public void reject(String msg, JSObject data) {
+        reject(msg, null, null, data);
+    }
+
     public void reject(String msg, Exception ex) {
-        reject(msg, null, ex);
+        reject(msg, null, ex, null);
     }
 
     public void reject(String msg, String code) {
-        reject(msg, code, null);
+        reject(msg, code, null, null);
     }
 
     public void reject(String msg) {
-        reject(msg, null, null);
+        reject(msg, null, null, null);
     }
 
     public void unimplemented() {
@@ -151,7 +170,7 @@ public class PluginCall {
     }
 
     public void unimplemented(String msg) {
-        reject(msg, "UNIMPLEMENTED", null);
+        reject(msg, "UNIMPLEMENTED", null, null);
     }
 
     public void unavailable() {
@@ -159,7 +178,7 @@ public class PluginCall {
     }
 
     public void unavailable(String msg) {
-        reject(msg, "UNAVAILABLE", null);
+        reject(msg, "UNAVAILABLE", null, null);
     }
 
     public String getPluginId() {

package/capacitor/src/main/java/com/getcapacitor/PluginHandle.java

@@ -20,11 +20,14 @@ public class PluginHandle {
 
     private final String pluginId;
 
+    @SuppressWarnings("deprecation")
     private NativePlugin legacyPluginAnnotation;
+
     private CapacitorPlugin pluginAnnotation;
 
     private Plugin instance;
 
+    @SuppressWarnings("deprecation")
     public PluginHandle(Bridge bridge, Class<? extends Plugin> pluginClass) throws InvalidPluginException, PluginLoadException {
         this.bridge = bridge;
         this.pluginClass = pluginClass;
@@ -67,6 +70,7 @@ public class PluginHandle {
         return this.pluginId;
     }
 
+    @SuppressWarnings("deprecation")
     public NativePlugin getLegacyPluginAnnotation() {
         return this.legacyPluginAnnotation;
     }

package/capacitor/src/main/java/com/getcapacitor/ProcessedRoute.java

@@ -0,0 +1,28 @@
+package com.getcapacitor;
+
+/**
+ * An data class used in conjunction with RouteProcessor.
+ *
+ * @see com.getcapacitor.RouteProcessor
+ */
+public class ProcessedRoute {
+
+    private String path;
+    private boolean isAsset;
+
+    public String getPath() {
+        return path;
+    }
+
+    public void setPath(String path) {
+        this.path = path;
+    }
+
+    public boolean isAsset() {
+        return isAsset;
+    }
+
+    public void setAsset(boolean asset) {
+        isAsset = asset;
+    }
+}

package/capacitor/src/main/java/com/getcapacitor/RouteProcessor.java

@@ -0,0 +1,8 @@
+package com.getcapacitor;
+
+/**
+ * An interface used in the processing of routes
+ */
+public interface RouteProcessor {
+    ProcessedRoute process(String basePath, String path);
+}