feat(android): add WebViewAssetLoader proxy handler for cdvfile #513

erisu · 2022-02-09T08:13:10Z

Motivation and Context

Fetching files from the persistent and temporary file systen while using custom scheme+hostname.

Description

This PR adds a proxy handler for the WebViewAssetLoader.

Since cdvfile://localhost no longer works, this PR implements a new URL pattern that works with custom scheme+hostname. It will fetch and return a WebResponse of the file located in the native file system.

E.g.:

Old cdvfile URL:

cdvfile://localhost/persistent/image.png

will become:

https://localhost/__cdvfile_persistent__/image.png

and continue to map to the native file:

file:///data/user/0/<APP ID>/files/files/image.png

If you configure the app to use http or with a different hostname, other then localhost, it will change as such.

Resolves:

Need confirmation:

fixes Download file (write) problem in API 30 - Android 11 #511 (I suspect it is trying to load a the file scheme file path when using custom scheme+host.)
fixes Unable to read from external storage using 'readAsBinaryString' method in Android 11 #499 (I think this PR might resolve this PR as well)
closes Storage updates in Android 11 #426

Depending on use case and app configuration, it appears that many the file url was being used when the app is served though the custom scheme+hostname setup. Only with AndroidInsecureFileModeEnabled will the file path work. This PR will introduce changes which will make it possible to load files with the custom scheme+hostname setup but with a different URL structure.

fixes Not allowed to load local resource: - cordova.file.dataDirectory #509
fixes Cannot read PDF, .Docx from Internal Storage using cordova.file.externalRootDirectory for Android 11 #508 (Another ticket might be needed regarding to listing...)

Usage:

Use toURL, NOT toInternalURL.

The toURL method will call the toInternalURL when necessary.

IF AndroidInsecureFileModeEnabled is set to false or not defined, the toURL method will call and return the results from toInternalURL.

Example result: https://localhost/__cdvfile_persistent__/image.png.

The scheme and hostname may vary depending on its configurations.
IF AndroidInsecureFileModeEnabled is set to true, the toURL method will return the native URL.

Example Result: file:///data/user/0/<APP ID>/files/files/image.png.

What happens if `toInternalURL` is called directly?

IF AndroidInsecureFileModeEnabled is set to false or not defined, calling the toInternalURL method will not have any negative effect. The correct URL pattern will be returned.
IF AndroidInsecureFileModeEnabled is set to true, calling the toInternalURL method will return a URL pattern that does not exist and is reachable. This will cause issues in fetching and loading of resources.

Testing

npm t
`cordova build

Checklist

I've run the tests to see all new and existing tests pass
I added automated test coverage as appropriate for this change
Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
I've updated the documentation if necessary

NiklasMerz

Code LGTM

plugin.xml

JustTestCode · 2022-02-19T04:51:37Z

helpful

plugin.xml

skmbr · 2022-02-25T22:44:20Z

Sorry if this is the wrong place to ask, but as the current latest version is from 2019, once this gets merged how long is it likely to be for a new release to be available?

Or will I need to build the plugin myself somehow rather than using cordova plugin add... ?

erisu · 2022-02-26T03:57:43Z

Sorry if this is the wrong place to ask, but as the current latest version is from 2019, once this gets merged how long is it likely to be for a new release to be available?

Or will I need to build the plugin myself somehow rather than using cordova plugin add... ?

@skmbr I can not give you an exact answer, but hoping to prepare a release shortly after.

This PR fixes a lot of the issues but I am trying to investigate one alternative solution. (This explains why I have the PR in draft.)

I am hoping with the alternative solution I will not need to introduce new front-end JS code (E.g. getCdvURL()). I am hoping to reuse the toInternalURL() method instead.

My vision of the alternative solution's use cases is:

If AndroidInsecureFileModeEnabled = true, toInternalURL()/toURL() will continue to return the file:// URL.
If AndroidInsecureFileModeEnabled is not defined (false), toInternalURL() will return the scheme + hostname combination URL. This URL is created from the native side.

Because toURL already calls toInternalURL, this alternative change would mean that app developers do not need to update or change their front-end code. Simply updating the plugin would be all that is needed.

As a side note, the alternative solution would still use all of the native changes I made in this PR.

skmbr · 2022-02-26T17:25:07Z

I can not give you an exact answer, but hoping to prepare a release shortly after.

@erisu That's good to hear! Thank you!

That alternative solution sounds great too.

If AndroidInsecureFileModeEnabled = true, toInternalURL()/toURL() will continue to return the file:// URL.

One thing I will say is that toInternalURL was returning a cdvfile url for me after enabling AndroidInsecureFileModeEnabled so I had to switch to toURL to get a file:// url.

Looking forward to this being solved so I can do a proper release of my app again. Luckily I have codepush so have still been able to get fixes and small updates out, but getting to the point where I need a full release targeting > SDK 30 to keep up with new features in the iOS version.

Thanks again for all your work on this!

xtof974 · 2022-03-02T08:48:02Z

Facing the same issue. Any updates about this PR ?
Thx for your work !

LongTimeNoTea · 2022-03-04T08:31:44Z

Thanks for your work! I'm waiting for this to update my app!

erisu · 2022-03-07T03:58:35Z

I updated the PR description to reflect the latest changes. Read the sections Usage: and What happens if toInternalURL is called directly? to understand about the use case and changes.

NiklasMerz · 2022-03-07T08:49:19Z

We could add the Usage part to the README of this plugin.

breautek

Tested via using camera plugin to snap a picture and then passing the provided URL to the file plugin to resolve to a FileEntry, then use .toURL() to display in the DOM.

…le (apache#513)" This reverts commit 3366ea6.

skmbr · 2022-04-02T19:51:52Z

@erisu Great that this is merged in now. Thanks for all your hard work!

Any news on when there might be a release? Or is the only option to install it via the github url?

kalandher · 2022-04-26T07:07:40Z

> Task :app:compileDebugJavaWithJavac FAILED platforms\android\app\src\main\java\com\silkimen\cordovahttp\CordovaHttpDownload.java:12: error: package org.apache.cordova.file does not exist import org.apache.cordova.file.FileUtils; ^ platforms\android\app\src\main\java\com\silkimen\cordovahttp\CordovaHttpDownload.java:33: error: cannot find symbol JSONObject fileEntry = FileUtils.getFilePlugin().getEntryForFile(file); ^ symbol: variable FileUtils location: class CordovaHttpDownload Note: Some input files use or override a deprecated API. Note: Recompile with -Xlint:deprecation for details. Note: Some input files use unchecked or unsafe operations. Note: Recompile with -Xlint:unchecked for details. 2 errors FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ':app:compileDebugJavaWithJavac'. > Compilation failed; see the compiler error output for details. * Try: Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights. * Get more help at https://help.gradle.org Deprecated Gradle features were used in this build, making it incompatible with Gradle 7.0. Use '--warning-mode all' to show the individual deprecation warnings. See https://docs.gradle.org/6.5/userguide/command_line_interface.html#sec:command_line_warnings

@erisu Its working fine when i'm installing latest plugin for the the first time, when i uninstall and try to reinstall its throwing me error in 'cordova-plugin-advanced-http' code

…he#513) * feat: add WebAssetLoader proxy handler for cdvfile * fix: update the fileTarget replace string * chore: make androidx.webkit:webkit configurable & default to 1.4.0 * feat: toURL to return file or custom scheme based on window location * chore: remove unused variable * chore: add other file systems to check * chore: remove comment * feat: bump cordova-android requirement to >=10.0.0 for AndroidX usage * doc: updated readme to include the Android changes

terryjiang2020 · 2023-02-23T00:53:19Z

Hi there, this one is creating the URL that my Android app is not able to recognize. The URL constantly returns "not found" on the device, although it exists when I check file system. Can anyone help on this?

mirko77 · 2023-03-16T15:36:02Z

So while this URL was resolved correctly with version 6.0.2

content://com.android.providers.downloads.documents/document/raw%3A%2Fstorage%2Femulated%2F0%2FDownload%2F00052123047880195188.pdf

on 7.0.0 I get error 1 (not found)

erisu added 2 commits February 5, 2022 00:08

feat: add WebAssetLoader proxy handler for cdvfile

2ae223a

feat: append cdvURL to the resolveLocalFileSystemURI return FileEntity

8a941a0

erisu requested review from jcesarmobile, NiklasMerz and breautek February 9, 2022 08:13

fix: update the fileTarget replace string

01036fc

NiklasMerz approved these changes Feb 9, 2022

View reviewed changes

breautek reviewed Feb 9, 2022

View reviewed changes

plugin.xml Outdated Show resolved Hide resolved

breautek approved these changes Feb 9, 2022

View reviewed changes

jcesarmobile reviewed Feb 20, 2022

View reviewed changes

plugin.xml Outdated Show resolved Hide resolved

chore: make androidx.webkit:webkit configurable & default to 1.4.0

d11fe94

feat: toURL to return file or custom scheme based on window location

58298a4

erisu requested review from jcesarmobile, breautek and NiklasMerz March 7, 2022 03:59

erisu added 3 commits March 7, 2022 23:54

chore: remove unused variable

b0bae49

chore: add other file systems to check

4685790

chore: remove comment

cc5d468

breautek approved these changes Mar 7, 2022

View reviewed changes

erisu marked this pull request as ready for review March 7, 2022 16:04

erisu added 2 commits March 8, 2022 10:43

feat: bump cordova-android requirement to >=10.0.0 for AndroidX usage

228fe54

doc: updated readme to include the Android changes

01d7852

NiklasMerz approved these changes Mar 15, 2022

View reviewed changes

erisu merged commit 3366ea6 into apache:master Mar 15, 2022

erisu deleted the feat/android-webassetloader-cdvfile branch March 15, 2022 07:21

tmrkk added a commit to tinymobilerobots/cordova-plugin-file that referenced this pull request Mar 25, 2022

Revert "feat(android): add WebViewAssetLoader proxy handler for cdvfi…

8f4fb46

…le (apache#513)" This reverts commit 3366ea6.

Abaddon-88 added a commit to webfactor/cordova-plugin-file that referenced this pull request Mar 28, 2022

Revert "feat(android): add WebViewAssetLoader proxy handler for cdvfi…

ab99f56

…le (apache#513)" This reverts commit 3366ea6.

kalandher mentioned this pull request May 4, 2022

To support v7 do we need to upgrade cordova-android to 10? #522

Closed

breautek mentioned this pull request Jul 22, 2022

Android 10 - How can I assign the root path? apache/cordova-android#1458

Closed

breautek mentioned this pull request Aug 7, 2022

@7.0.0 resolveLocalFileSystemURL a content uri get a FileError #525

Closed

3 tasks

clarklight mentioned this pull request Sep 8, 2022

Not allowed to load local resource apache/cordova-plugin-camera#761

Closed

breautek mentioned this pull request Oct 16, 2022

hostname is set via preference, webView is still launched over file:// protocol apache/cordova-android#1509

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(android): add WebViewAssetLoader proxy handler for cdvfile #513

feat(android): add WebViewAssetLoader proxy handler for cdvfile #513

erisu commented Feb 9, 2022 •

edited

Loading

NiklasMerz left a comment

JustTestCode commented Feb 19, 2022

skmbr commented Feb 25, 2022

erisu commented Feb 26, 2022 •

edited

Loading

skmbr commented Feb 26, 2022

xtof974 commented Mar 2, 2022

LongTimeNoTea commented Mar 4, 2022

erisu commented Mar 7, 2022

NiklasMerz commented Mar 7, 2022

breautek left a comment •

edited

Loading

skmbr commented Apr 2, 2022

kalandher commented Apr 26, 2022 •

edited

Loading

terryjiang2020 commented Feb 23, 2023

mirko77 commented Mar 16, 2023 •

edited

Loading

feat(android): add WebViewAssetLoader proxy handler for cdvfile #513

feat(android): add WebViewAssetLoader proxy handler for cdvfile #513

Conversation

erisu commented Feb 9, 2022 • edited Loading

Motivation and Context

Description

Usage:

What happens if toInternalURL is called directly?

Testing

Checklist

NiklasMerz left a comment

Choose a reason for hiding this comment

JustTestCode commented Feb 19, 2022

skmbr commented Feb 25, 2022

erisu commented Feb 26, 2022 • edited Loading

skmbr commented Feb 26, 2022

xtof974 commented Mar 2, 2022

LongTimeNoTea commented Mar 4, 2022

erisu commented Mar 7, 2022

NiklasMerz commented Mar 7, 2022

breautek left a comment • edited Loading

Choose a reason for hiding this comment

skmbr commented Apr 2, 2022

kalandher commented Apr 26, 2022 • edited Loading

terryjiang2020 commented Feb 23, 2023

mirko77 commented Mar 16, 2023 • edited Loading

erisu commented Feb 9, 2022 •

edited

Loading

What happens if `toInternalURL` is called directly?

erisu commented Feb 26, 2022 •

edited

Loading

breautek left a comment •

edited

Loading

kalandher commented Apr 26, 2022 •

edited

Loading

mirko77 commented Mar 16, 2023 •

edited

Loading