Skip to content

Commit

Permalink
Extract blob download in iframes logic to make it reusable
Browse files Browse the repository at this point in the history
  • Loading branch information
CDRussell committed Oct 29, 2024
1 parent 3768977 commit 51429eb
Show file tree
Hide file tree
Showing 16 changed files with 471 additions and 352 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ import com.duckduckgo.app.browser.api.WebViewCapabilityChecker.WebViewCapability
import com.duckduckgo.browser.api.WebViewVersionProvider
import com.duckduckgo.common.utils.DispatcherProvider
import com.duckduckgo.common.utils.extensions.compareSemanticVersion
import com.duckduckgo.di.scopes.FragmentScope
import com.duckduckgo.di.scopes.AppScope
import com.squareup.anvil.annotations.ContributesBinding
import javax.inject.Inject
import kotlinx.coroutines.withContext

@ContributesBinding(FragmentScope::class)
@ContributesBinding(AppScope::class)
class RealWebViewCapabilityChecker @Inject constructor(
private val dispatchers: DispatcherProvider,
private val webViewVersionProvider: WebViewVersionProvider,
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,8 @@

package com.duckduckgo.autofill.api

import android.os.Parcelable
import com.duckduckgo.autofill.api.domain.app.LoginCredentials
import com.duckduckgo.navigation.api.GlobalActivityStarter.ActivityParams
import kotlinx.parcelize.Parcelize

sealed interface AutofillScreens {

Expand Down Expand Up @@ -50,29 +48,6 @@ sealed interface AutofillScreens {
val loginCredentials: LoginCredentials,
val source: AutofillSettingsLaunchSource,
) : ActivityParams

object ImportGooglePassword {
data object AutofillImportViaGooglePasswordManagerScreen : ActivityParams {
private fun readResolve(): Any = AutofillImportViaGooglePasswordManagerScreen
}

sealed interface Result : Parcelable {

companion object {
const val RESULT_KEY = "importResult"
const val RESULT_KEY_DETAILS = "importResultDetails"
}

@Parcelize
data class Success(val importedCount: Int) : Result

@Parcelize
data class UserCancelled(val stage: String) : Result

@Parcelize
data object Error : Result
}
}
}

enum class AutofillSettingsLaunchSource {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
/*
* Copyright (c) 2024 DuckDuckGo
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.duckduckgo.autofill.impl.importing.blob

import android.annotation.SuppressLint
import android.net.Uri
import android.webkit.WebView
import androidx.webkit.JavaScriptReplyProxy
import androidx.webkit.WebViewCompat
import com.duckduckgo.app.browser.api.WebViewCapabilityChecker
import com.duckduckgo.app.browser.api.WebViewCapabilityChecker.WebViewCapability
import com.duckduckgo.di.scopes.AppScope
import com.squareup.anvil.annotations.ContributesBinding
import javax.inject.Inject

/**
* This interface provides the ability to add modern blob download support to a WebView.
*/
interface WebViewBlobDownloader {

/**
* Configures a web view to support blob downloads, including in iframes.
*/
suspend fun addBlobDownloadSupport(webView: WebView)

/**
* Requests the WebView to convert a blob URL to a data URI.
*/
suspend fun convertBlobToDataUri(blobUrl: String)

/**
* Stores a reply proxy for a given location.
*/
suspend fun storeReplyProxy(
originUrl: String,
replyProxy: JavaScriptReplyProxy,
locationHref: String?,
)

/**
* Clears any stored JavaScript reply proxies.
*/
fun clearReplyProxies()
}

@ContributesBinding(AppScope::class)
class WebViewBlobDownloaderModernImpl @Inject constructor(
private val webViewCapabilityChecker: WebViewCapabilityChecker,
) : WebViewBlobDownloader {

// Map<String, Map<String, JavaScriptReplyProxy>>() = Map<Origin, Map<location.href, JavaScriptReplyProxy>>()
private val fixedReplyProxyMap = mutableMapOf<String, Map<String, JavaScriptReplyProxy>>()

@SuppressLint("RequiresFeature")
override suspend fun addBlobDownloadSupport(webView: WebView) {
if (isBlobDownloadWebViewFeatureEnabled()) {
WebViewCompat.addDocumentStartJavaScript(webView, script, setOf("*"))
}
}

@SuppressLint("RequiresFeature")
override suspend fun convertBlobToDataUri(blobUrl: String) {
for ((key, proxies) in fixedReplyProxyMap) {
if (sameOrigin(blobUrl.removePrefix("blob:"), key)) {
for (replyProxy in proxies.values) {
replyProxy.postMessage(blobUrl)
}
return
}
}
}

override suspend fun storeReplyProxy(
originUrl: String,
replyProxy: JavaScriptReplyProxy,
locationHref: String?,
) {
val frameProxies = fixedReplyProxyMap[originUrl]?.toMutableMap() ?: mutableMapOf()
// if location.href is not passed, we fall back to origin
val safeLocationHref = locationHref ?: originUrl
frameProxies[safeLocationHref] = replyProxy
fixedReplyProxyMap[originUrl] = frameProxies
}

private fun sameOrigin(
firstUrl: String,
secondUrl: String,
): Boolean {
return kotlin.runCatching {
val firstUri = Uri.parse(firstUrl)
val secondUri = Uri.parse(secondUrl)

firstUri.host == secondUri.host && firstUri.scheme == secondUri.scheme && firstUri.port == secondUri.port
}.getOrNull() ?: return false
}

override fun clearReplyProxies() {
fixedReplyProxyMap.clear()
}

private suspend fun isBlobDownloadWebViewFeatureEnabled(): Boolean {
return webViewCapabilityChecker.isSupported(WebViewCapability.WebMessageListener) &&
webViewCapabilityChecker.isSupported(WebViewCapability.DocumentStartJavaScript)
}

companion object {
private val script = """
window.__url_to_blob_collection = {};
const original_createObjectURL = URL.createObjectURL;
URL.createObjectURL = function () {
const blob = arguments[0];
const url = original_createObjectURL.call(this, ...arguments);
if (blob instanceof Blob) {
__url_to_blob_collection[url] = blob;
}
return url;
}
function blobToBase64DataUrl(blob) {
return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onloadend = function() {
resolve(reader.result);
}
reader.onerror = function() {
reject(new Error('Failed to read Blob object'));
}
reader.readAsDataURL(blob);
});
}
const pingMessage = 'Ping:' + window.location.href
ddgBlobDownloadObj.postMessage(pingMessage)
ddgBlobDownloadObj.onmessage = function(event) {
if (event.data.startsWith('blob:')) {
const blob = window.__url_to_blob_collection[event.data];
if (blob) {
blobToBase64DataUrl(blob).then((dataUrl) => {
ddgBlobDownloadObj.postMessage(dataUrl);
});
}
}
}
""".trimIndent()
}
}
Loading

0 comments on commit 51429eb

Please sign in to comment.