@capacitor/android 9.0.0-alpha.6 → 9.0.0-alpha.8

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

@@ -53,18 +53,6 @@ public class Plugin {
     // Reference to the PluginHandle wrapper for this Plugin
     protected PluginHandle handle;
 
-    /**
-     * A way for plugins to quickly save a call that they will need to reference
-     * between activity/permissions starts/requests
-     *
-     * @deprecated store calls on the bridge using the methods
-     * {@link com.getcapacitor.Bridge#saveCall(PluginCall)},
-     * {@link com.getcapacitor.Bridge#getSavedCall(String)} and
-     * {@link com.getcapacitor.Bridge#releaseCall(PluginCall)}
-     */
-    @Deprecated
-    protected PluginCall savedLastCall;
-
     // Stored event listeners
     private final Map<String, List<PluginCall>> eventListeners;
 
@@ -253,39 +241,6 @@ public class Plugin {
         return getContext().getPackageName();
     }
 
-    /**
-     * Called to save a {@link PluginCall} in order to reference it
-     * later, such as in an activity or permissions result handler
-     * @deprecated use {@link Bridge#saveCall(PluginCall)}
-     *
-     * @param lastCall
-     */
-    @Deprecated
-    public void saveCall(PluginCall lastCall) {
-        this.savedLastCall = lastCall;
-    }
-
-    /**
-     * Set the last saved call to null to free memory
-     * @deprecated use {@link PluginCall#release(Bridge)}
-     */
-    @Deprecated
-    public void freeSavedCall() {
-        this.savedLastCall.release(bridge);
-        this.savedLastCall = null;
-    }
-
-    /**
-     * Get the last saved call, if any
-     * @deprecated use {@link Bridge#getSavedCall(String)}
-     *
-     * @return
-     */
-    @Deprecated
-    public PluginCall getSavedCall() {
-        return this.savedLastCall;
-    }
-
     /**
      * Get the config options for this plugin.
      *
@@ -296,41 +251,6 @@ public class Plugin {
         return bridge.getConfig().getPluginConfiguration(handle.getId());
     }
 
-    /**
-     * Get the value for a key on the config for this plugin.
-     * @deprecated use {@link #getConfig()} and access config values using the methods available
-     * depending on the type.
-     *
-     * @param key the key for the config value
-     * @return some object containing the value from the config
-     */
-    @Deprecated
-    public Object getConfigValue(String key) {
-        try {
-            PluginConfig pluginConfig = getConfig();
-            return pluginConfig.getConfigJSON().get(key);
-        } catch (JSONException ex) {
-            return null;
-        }
-    }
-
-    /**
-     * Check whether any of the given permissions has been defined in the AndroidManifest.xml
-     * @deprecated use {@link #isPermissionDeclared(String)}
-     *
-     * @param permissions
-     * @return
-     */
-    @Deprecated
-    public boolean hasDefinedPermissions(String[] permissions) {
-        for (String permission : permissions) {
-            if (!PermissionHelper.hasDefinedPermission(getContext(), permission)) {
-                return false;
-            }
-        }
-        return true;
-    }
-
     /**
      * Check if all annotated permissions have been defined in the AndroidManifest.xml
      * @deprecated use {@link #isPermissionDeclared(String)}
@@ -341,19 +261,15 @@ public class Plugin {
     public boolean hasDefinedRequiredPermissions() {
         CapacitorPlugin annotation = handle.getPluginAnnotation();
         if (annotation == null) {
-            // Check for legacy plugin annotation, @NativePlugin
-            NativePlugin legacyAnnotation = handle.getLegacyPluginAnnotation();
-            return hasDefinedPermissions(legacyAnnotation.permissions());
-        } else {
-            for (Permission perm : annotation.permissions()) {
-                for (String permString : perm.strings()) {
-                    if (!PermissionHelper.hasDefinedPermission(getContext(), permString)) {
-                        return false;
-                    }
+            return true;
+        }
+        for (Permission perm : annotation.permissions()) {
+            for (String permString : perm.strings()) {
+                if (!PermissionHelper.hasDefinedPermission(getContext(), permString)) {
+                    return false;
                 }
             }
         }
-
         return true;
     }
 
@@ -381,21 +297,6 @@ public class Plugin {
         return false;
     }
 
-    /**
-     * Check whether the given permission has been granted by the user
-     * @deprecated use {@link #getPermissionState(String)} and {@link #getPermissionStates()} to get
-     * the states of permissions defined on the Plugin in conjunction with the @CapacitorPlugin
-     * annotation. Use the Android API {@link ActivityCompat#checkSelfPermission(Context, String)}
-     * methods to check permissions with Android permission strings
-     *
-     * @param permission
-     * @return
-     */
-    @Deprecated
-    public boolean hasPermission(String permission) {
-        return ActivityCompat.checkSelfPermission(this.getContext(), permission) == PackageManager.PERMISSION_GRANTED;
-    }
-
     /**
      * If the plugin annotation specified a set of permissions, this method checks if each is
      * granted
@@ -408,17 +309,8 @@ public class Plugin {
     public boolean hasRequiredPermissions() {
         CapacitorPlugin annotation = handle.getPluginAnnotation();
         if (annotation == null) {
-            // Check for legacy plugin annotation, @NativePlugin
-            NativePlugin legacyAnnotation = handle.getLegacyPluginAnnotation();
-            for (String perm : legacyAnnotation.permissions()) {
-                if (ActivityCompat.checkSelfPermission(this.getContext(), perm) != PackageManager.PERMISSION_GRANTED) {
-                    return false;
-                }
-            }
-
             return true;
         }
-
         for (Permission perm : annotation.permissions()) {
             for (String permString : perm.strings()) {
                 if (ActivityCompat.checkSelfPermission(this.getContext(), permString) != PackageManager.PERMISSION_GRANTED) {
@@ -426,7 +318,6 @@ public class Plugin {
                 }
             }
         }
-
         return true;
     }
 
@@ -502,10 +393,14 @@ public class Plugin {
     private String[] getPermissionStringsForAliases(@NonNull String[] aliases) {
         CapacitorPlugin annotation = handle.getPluginAnnotation();
         HashSet<String> perms = new HashSet<>();
-        for (Permission perm : annotation.permissions()) {
-            if (Arrays.asList(aliases).contains(perm.alias())) {
-                perms.addAll(Arrays.asList(perm.strings()));
+        if (annotation != null) {
+            for (Permission perm : annotation.permissions()) {
+                if (Arrays.asList(aliases).contains(perm.alias())) {
+                    perms.addAll(Arrays.asList(perm.strings()));
+                }
             }
+        } else {
+            Logger.warn(String.format("getPermissionStringsForAliases: missing @CapacitorPlugin annotation for plugin %s", handle.getId()));
         }
 
         return perms.toArray(new String[0]);
@@ -563,42 +458,6 @@ public class Plugin {
         return permissionLauncher;
     }
 
-    /**
-     * Request all of the specified permissions in the CapacitorPlugin annotation (if any)
-     *
-     * @deprecated use {@link #requestAllPermissions(PluginCall, String)} in conjunction with @CapacitorPlugin
-     */
-    @Deprecated
-    public void pluginRequestAllPermissions() {
-        NativePlugin legacyAnnotation = handle.getLegacyPluginAnnotation();
-        ActivityCompat.requestPermissions(getActivity(), legacyAnnotation.permissions(), legacyAnnotation.permissionRequestCode());
-    }
-
-    /**
-     * Helper for requesting a specific permission
-     *
-     * @param permission  the permission to request
-     * @param requestCode the requestCode to use to associate the result with the plugin
-     * @deprecated use {@link #requestPermissionForAlias(String, PluginCall, String)} in conjunction with @CapacitorPlugin
-     */
-    @Deprecated
-    public void pluginRequestPermission(String permission, int requestCode) {
-        ActivityCompat.requestPermissions(getActivity(), new String[] { permission }, requestCode);
-    }
-
-    /**
-     * Helper for requesting specific permissions
-     * @deprecated use {@link #requestPermissionForAliases(String[], PluginCall, String)} in conjunction
-     * with @CapacitorPlugin
-     *
-     * @param permissions the set of permissions to request
-     * @param requestCode the requestCode to use to associate the result with the plugin
-     */
-    @Deprecated
-    public void pluginRequestPermissions(String[] permissions, int requestCode) {
-        ActivityCompat.requestPermissions(getActivity(), permissions, requestCode);
-    }
-
     /**
      * Get the permission state for the provided permission alias.
      *
@@ -803,92 +662,72 @@ public class Plugin {
     @PluginMethod
     public void requestPermissions(PluginCall call) {
         CapacitorPlugin annotation = handle.getPluginAnnotation();
-        if (annotation == null) {
-            handleLegacyPermission(call);
-        } else {
-            // handle permission requests for plugins defined with @CapacitorPlugin (since 3.0.0)
-            String[] permAliases = null;
-            Set<String> autoGrantPerms = new HashSet<>();
-
-            // If call was made with a list of specific permission aliases to request, save them
-            // to be requested
-            JSArray providedPerms = call.getArray("permissions");
-            List<String> providedPermsList = null;
-
-            if (providedPerms != null) {
-                try {
-                    providedPermsList = providedPerms.toList();
-                } catch (JSONException ignore) {
-                    // do nothing
-                }
-            }
+        String[] permAliases = null;
+        Set<String> autoGrantPerms = new HashSet<>();
 
-            // If call was made without any custom permissions, request all from plugin annotation
-            Set<String> aliasSet = new HashSet<>();
-            if (providedPermsList == null || providedPermsList.isEmpty()) {
-                for (Permission perm : annotation.permissions()) {
-                    // If a permission is defined with no permission strings, separate it for auto-granting.
-                    // Otherwise, the alias is added to the list to be requested.
-                    if (perm.strings().length == 0 || (perm.strings().length == 1 && perm.strings()[0].isEmpty())) {
-                        if (!perm.alias().isEmpty()) {
-                            autoGrantPerms.add(perm.alias());
-                        }
-                    } else {
-                        aliasSet.add(perm.alias());
-                    }
-                }
+        // If call was made with a list of specific permission aliases to request, save them
+        // to be requested
+        JSArray providedPerms = call.getArray("permissions");
+        List<String> providedPermsList = null;
 
-                permAliases = aliasSet.toArray(new String[0]);
-            } else {
-                for (Permission perm : annotation.permissions()) {
-                    if (providedPermsList.contains(perm.alias())) {
-                        aliasSet.add(perm.alias());
-                    }
-                }
+        if (providedPerms != null) {
+            try {
+                providedPermsList = providedPerms.toList();
+            } catch (JSONException ignore) {
+                // do nothing
+            }
+        }
 
-                if (aliasSet.isEmpty()) {
-                    call.reject("No valid permission alias was requested of this plugin.");
+        // If call was made without any custom permissions, request all from plugin annotation
+        Set<String> aliasSet = new HashSet<>();
+        if (providedPermsList == null || providedPermsList.isEmpty()) {
+            for (Permission perm : annotation.permissions()) {
+                // If a permission is defined with no permission strings, separate it for auto-granting.
+                // Otherwise, the alias is added to the list to be requested.
+                if (perm.strings().length == 0 || (perm.strings().length == 1 && perm.strings()[0].isEmpty())) {
+                    if (!perm.alias().isEmpty()) {
+                        autoGrantPerms.add(perm.alias());
+                    }
                 } else {
-                    permAliases = aliasSet.toArray(new String[0]);
+                    aliasSet.add(perm.alias());
                 }
             }
 
-            if (permAliases != null && permAliases.length > 0) {
-                // request permissions using provided aliases or all defined on the plugin
-                requestPermissionForAliases(permAliases, call, "checkPermissions");
-            } else if (!autoGrantPerms.isEmpty()) {
-                // if the plugin only has auto-grant permissions, return all as GRANTED
-                JSObject permissionsResults = new JSObject();
-
-                for (String perm : autoGrantPerms) {
-                    permissionsResults.put(perm, PermissionState.GRANTED.toString());
+            permAliases = aliasSet.toArray(new String[0]);
+        } else {
+            for (Permission perm : annotation.permissions()) {
+                if (providedPermsList.contains(perm.alias())) {
+                    aliasSet.add(perm.alias());
                 }
+            }
 
-                call.resolve(permissionsResults);
+            if (aliasSet.isEmpty()) {
+                call.reject("No valid permission alias was requested of this plugin.");
             } else {
-                // no permissions are defined on the plugin, resolve undefined
-                call.resolve();
+                permAliases = aliasSet.toArray(new String[0]);
             }
         }
-    }
 
-    @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());
+        if (permAliases != null && permAliases.length > 0) {
+            // request permissions using provided aliases or all defined on the plugin
+            requestPermissionForAliases(permAliases, call, "checkPermissions");
+        } else if (!autoGrantPerms.isEmpty()) {
+            // if the plugin only has auto-grant permissions, return all as GRANTED
+            JSObject permissionsResults = new JSObject();
+
+            for (String perm : autoGrantPerms) {
+                permissionsResults.put(perm, PermissionState.GRANTED.toString());
+            }
+
+            call.resolve(permissionsResults);
         } else {
+            // no permissions are defined on the plugin, resolve undefined
             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
-     * for our convenient requestPermissions call.
+     * Handle request permissions result. Subclasses may override this to handle the result.
      * @deprecated in favor of using callbacks in conjunction with {@link CapacitorPlugin}
      *
      * @param requestCode
@@ -896,18 +735,7 @@ public class Plugin {
      * @param grantResults
      */
     @Deprecated
-    protected void handleRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
-        if (!hasDefinedPermissions(permissions)) {
-            StringBuilder builder = new StringBuilder();
-            builder.append("Missing the following permissions in AndroidManifest.xml:\n");
-            String[] missing = PermissionHelper.getUndefinedPermissions(getContext(), permissions);
-            for (String perm : missing) {
-                builder.append(perm + "\n");
-            }
-            savedLastCall.reject(builder.toString());
-            savedLastCall = null;
-        }
-    }
+    protected void handleRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {}
 
     /**
      * Called before the app is destroyed to give a plugin the chance to
@@ -1003,28 +831,14 @@ public class Plugin {
      * Give the plugins a chance to take control when a URL is about to be loaded in the WebView.
      * Returning true causes the WebView to abort loading the URL.
      * Returning false causes the WebView to continue loading the URL.
-     * Returning null will defer to the default Capacitor policy
+     * Returning null will defer to the default Capacitor policy.
+     * Not called for Capacitor's internal HTTP proxy path, which is always blocked.
      */
     @SuppressWarnings("unused")
     public Boolean shouldOverrideLoad(Uri url) {
         return null;
     }
 
-    /**
-     * Start a new Activity.
-     *
-     * Note: This method must be used by all plugins instead of calling
-     * {@link Activity#startActivityForResult} as it associates the plugin with
-     * any resulting data from the new Activity even if this app
-     * is destroyed by the OS (to free up memory, for example).
-     * @param intent
-     * @param resultCode
-     */
-    @Deprecated
-    protected void startActivityForResult(PluginCall call, Intent intent, int resultCode) {
-        bridge.startActivityForPluginWithResult(call, intent, resultCode);
-    }
-
     /**
      * Execute the given runnable on the Bridge's task handler
      * @param runnable

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

@@ -27,12 +27,6 @@ public class PluginCall {
 
     private boolean keepAlive = false;
 
-    /**
-     * Indicates that this PluginCall was released, and should no longer be used
-     */
-    @Deprecated
-    private boolean isReleased = false;
-
     public PluginCall(MessageHandler msgHandler, String pluginId, String callbackId, String methodName, JSObject data) {
         this.msgHandler = msgHandler;
         this.pluginId = pluginId;
@@ -324,28 +318,6 @@ public class PluginCall {
         return defaultValue;
     }
 
-    /**
-     * @param name of the option to check
-     * @return boolean indicating if the plugin call has an option for the provided name.
-     * @deprecated Presence of a key should not be considered significant.
-     * Use typed accessors to check the value instead.
-     */
-    @Deprecated
-    public boolean hasOption(String name) {
-        return this.data.has(name);
-    }
-
-    /**
-     * Indicate that the Bridge should cache this call in order to call
-     * it again later. For example, the addListener system uses this to
-     * continuously call the call's callback (😆).
-     * @deprecated use {@link #setKeepAlive(Boolean)} instead
-     */
-    @Deprecated
-    public void save() {
-        setKeepAlive(true);
-    }
-
     /**
      * Indicate that the Bridge should cache this call in order to call
      * it again later. For example, the addListener system uses this to
@@ -360,16 +332,6 @@ public class PluginCall {
     public void release(Bridge bridge) {
         this.keepAlive = false;
         bridge.releaseCall(this);
-        this.isReleased = true;
-    }
-
-    /**
-     * @deprecated use {@link #isKeptAlive()}
-     * @return true if the plugin call is kept alive
-     */
-    @Deprecated
-    public boolean isSaved() {
-        return isKeptAlive();
     }
 
     /**
@@ -380,11 +342,6 @@ public class PluginCall {
         return keepAlive;
     }
 
-    @Deprecated
-    public boolean isReleased() {
-        return isReleased;
-    }
-
     class PluginCallDataTypeException extends Exception {
 
         PluginCallDataTypeException(String m) {

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

@@ -20,43 +20,27 @@ public class PluginHandle {
 
     private final String pluginId;
 
-    @SuppressWarnings("deprecation")
-    private NativePlugin legacyPluginAnnotation;
-
     private CapacitorPlugin pluginAnnotation;
 
     private Plugin instance;
 
-    @SuppressWarnings("deprecation")
     private PluginHandle(Class<? extends Plugin> clazz, Bridge bridge) throws InvalidPluginException {
         this.bridge = bridge;
         this.pluginClass = clazz;
 
         CapacitorPlugin pluginAnnotation = pluginClass.getAnnotation(CapacitorPlugin.class);
         if (pluginAnnotation == null) {
-            // Check for legacy plugin annotation, @NativePlugin
-            NativePlugin legacyPluginAnnotation = pluginClass.getAnnotation(NativePlugin.class);
-            if (legacyPluginAnnotation == null) {
-                throw new InvalidPluginException("No @CapacitorPlugin annotation found for plugin " + pluginClass.getName());
-            }
-
-            if (!legacyPluginAnnotation.name().equals("")) {
-                this.pluginId = legacyPluginAnnotation.name();
-            } else {
-                this.pluginId = pluginClass.getSimpleName();
-            }
+            throw new InvalidPluginException("No @CapacitorPlugin annotation found for plugin " + pluginClass.getName());
+        }
 
-            this.legacyPluginAnnotation = legacyPluginAnnotation;
+        if (!pluginAnnotation.name().equals("")) {
+            this.pluginId = pluginAnnotation.name();
         } else {
-            if (!pluginAnnotation.name().equals("")) {
-                this.pluginId = pluginAnnotation.name();
-            } else {
-                this.pluginId = pluginClass.getSimpleName();
-            }
-
-            this.pluginAnnotation = pluginAnnotation;
+            this.pluginId = pluginClass.getSimpleName();
         }
 
+        this.pluginAnnotation = pluginAnnotation;
+
         this.indexMethods(clazz);
     }
 
@@ -78,11 +62,6 @@ public class PluginHandle {
         return this.pluginId;
     }
 
-    @SuppressWarnings("deprecation")
-    public NativePlugin getLegacyPluginAnnotation() {
-        return this.legacyPluginAnnotation;
-    }
-
     public CapacitorPlugin getPluginAnnotation() {
         return this.pluginAnnotation;
     }

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

@@ -172,6 +172,11 @@ public class WebViewLocalServer {
         Uri loadingUrl = request.getUrl();
 
         if (null != loadingUrl.getPath() && loadingUrl.getPath().startsWith(Bridge.CAPACITOR_HTTP_INTERCEPTOR_START)) {
+            // Only fetch/XHR should reach the proxy; a document would run remote content at the app origin.
+            boolean httpEnabled = bridge.getConfig().getPluginConfiguration("CapacitorHttp").getBoolean("enabled", false);
+            if (!httpEnabled || isDocumentRequest(request)) {
+                return null;
+            }
             Logger.debug("Handling CapacitorHttp request: " + loadingUrl);
             try {
                 return handleCapacitorHttpRequest(request);
@@ -197,6 +202,24 @@ public class WebViewLocalServer {
         }
     }
 
+    /** isForMainFrame() is false for an iframe and a fetch alike; only navigations send this header. */
+    private boolean isDocumentRequest(WebResourceRequest request) {
+        if (request.isForMainFrame()) {
+            return true;
+        }
+        Map<String, String> headers = request.getRequestHeaders();
+        if (headers == null) {
+            // The proxy needs the headers too, so the request fails there anyway.
+            return false;
+        }
+        for (String header : headers.keySet()) {
+            if ("Upgrade-Insecure-Requests".equalsIgnoreCase(header)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     private boolean isLocalFile(Uri uri) {
         String path = uri.getPath();
         return path.startsWith(capacitorContentStart) || path.startsWith(capacitorFileStart);
@@ -320,6 +343,9 @@ public class WebViewLocalServer {
         int responseCode = connection.getResponseCode();
         String reasonPhrase = getReasonPhraseFromResponseCode(responseCode);
 
+        // Nothing should render this. If anything does, sandbox keeps it inert and off the app origin.
+        responseHeaders.put("Content-Security-Policy", "sandbox; frame-ancestors 'none'");
+
         return new WebResourceResponse(mimeType, encoding, responseCode, reasonPhrase, responseHeaders, inputStream);
     }