Skip to content

Commit b8a5c16

Browse files
CDRussellCDRussell
committed
Add webflow for importing bookmarks from Google
1 parent f20b17e commit b8a5c16

29 files changed

+2600
-396
lines changed

‎autofill/autofill-impl/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ dependencies {
4848
implementation project(path: ':settings-api') // temporary until we release new settings
4949
implementation project(':library-loader-api')
5050
implementation project(':saved-sites-api')
51+
implementation project(':cookies-api')
5152

5253
anvil project(path: ':anvil-compiler')
5354
implementation project(path: ':anvil-annotations')

‎autofill/autofill-impl/src/main/AndroidManifest.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
android:name=".importing.gpm.webflow.ImportGooglePasswordsWebFlowActivity"
2222
android:configChanges="keyboardHidden|orientation|screenSize|smallestScreenSize|screenLayout|navigation|keyboard"
2323
android:exported="false" />
24+
<activity
25+
android:name=".importing.takeout.webflow.ImportGoogleBookmarksWebFlowActivity"
26+
android:configChanges="keyboardHidden|orientation|screenSize|smallestScreenSize|screenLayout|navigation|keyboard"
27+
android:exported="false" />
2428
<activity
2529
android:name=".ui.credential.management.AutofillManagementActivity"
2630
android:configChanges="orientation|screenSize"

‎autofill/autofill-impl/src/main/java/com/duckduckgo/autofill/impl/importing/gpm/webflow/PasswordImporterCssScriptLoader.kt‎ renamed to ‎autofill/autofill-impl/src/main/java/com/duckduckgo/autofill/impl/importing/gpm/webflow/GoogleImporterScriptLoader.kt‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,40 @@
1717
package com.duckduckgo.autofill.impl.importing.gpm.webflow
1818

1919
import com.duckduckgo.autofill.impl.importing.gpm.feature.AutofillImportPasswordConfigStore
20+
import com.duckduckgo.autofill.impl.importing.takeout.store.BookmarkImportConfigStore
2021
import com.duckduckgo.common.utils.DispatcherProvider
2122
import com.duckduckgo.di.scopes.FragmentScope
2223
import com.squareup.anvil.annotations.ContributesBinding
2324
import kotlinx.coroutines.withContext
2425
import java.io.BufferedReader
2526
import javax.inject.Inject
2627

27-
interface PasswordImporterScriptLoader {
28-
suspend fun getScript(): String
28+
interface GoogleImporterScriptLoader {
29+
suspend fun getScriptForPasswordImport(): String
30+
31+
suspend fun getScriptForBookmarkImport(): String
2932
}
3033

3134
@ContributesBinding(FragmentScope::class)
32-
class PasswordImporterCssScriptLoader @Inject constructor(
35+
class GoogleImporterScriptLoaderImpl @Inject constructor(
3336
private val dispatchers: DispatcherProvider,
34-
private val configStore: AutofillImportPasswordConfigStore,
35-
) : PasswordImporterScriptLoader {
37+
private val passwordConfigStore: AutofillImportPasswordConfigStore,
38+
private val bookmarkConfigStore: BookmarkImportConfigStore,
39+
) : GoogleImporterScriptLoader {
3640
private lateinit var contentScopeJS: String
3741

38-
override suspend fun getScript(): String =
42+
override suspend fun getScriptForPasswordImport(): String =
43+
withContext(dispatchers.io()) {
44+
getContentScopeJS()
45+
.replace(CONTENT_SCOPE_PLACEHOLDER, getContentScopeScriptJson(loadSettingsJsonPassword()))
46+
.replace(USER_UNPROTECTED_DOMAINS_PLACEHOLDER, getUnprotectedDomainsJson())
47+
.replace(USER_PREFERENCES_PLACEHOLDER, getUserPreferencesJson())
48+
}
49+
50+
override suspend fun getScriptForBookmarkImport(): String =
3951
withContext(dispatchers.io()) {
4052
getContentScopeJS()
41-
.replace(CONTENT_SCOPE_PLACEHOLDER, getContentScopeJson(loadSettingsJson()))
53+
.replace(CONTENT_SCOPE_PLACEHOLDER, getContentScopeScriptJson(loadSettingsJsonBookmark()))
4254
.replace(USER_UNPROTECTED_DOMAINS_PLACEHOLDER, getUnprotectedDomainsJson())
4355
.replace(USER_PREFERENCES_PLACEHOLDER, getUserPreferencesJson())
4456
}
@@ -47,7 +59,7 @@ class PasswordImporterCssScriptLoader @Inject constructor(
4759
* This enables the password import hints feature in C-S-S.
4860
* These settings are for enabling it; the check for whether it should be enabled or not is done elsewhere.
4961
*/
50-
private fun getContentScopeJson(settingsJson: String): String =
62+
private fun getContentScopeScriptJson(settingsJson: String): String =
5163
"""{
5264
"features":{
5365
"autofillImport" : {
@@ -61,7 +73,9 @@ class PasswordImporterCssScriptLoader @Inject constructor(
6173
6274
""".trimMargin()
6375

64-
private suspend fun loadSettingsJson(): String = configStore.getConfig().javascriptConfigGooglePasswords
76+
private suspend fun loadSettingsJsonPassword(): String = passwordConfigStore.getConfig().javascriptConfigGooglePasswords
77+
78+
private suspend fun loadSettingsJsonBookmark(): String = bookmarkConfigStore.getConfig().javascriptConfigGoogleTakeout
6579

6680
private fun getUserPreferencesJson(): String =
6781
"""

‎autofill/autofill-impl/src/main/java/com/duckduckgo/autofill/impl/importing/gpm/webflow/ImportGooglePasswordsWebFlowFragment.kt‎

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ import androidx.lifecycle.flowWithLifecycle
3333
import androidx.lifecycle.lifecycleScope
3434
import androidx.webkit.WebViewCompat
3535
import com.duckduckgo.anvil.annotations.InjectWith
36-
import com.duckduckgo.autofill.api.AutofillCapabilityChecker
3736
import com.duckduckgo.autofill.api.AutofillFragmentResultsPlugin
3837
import com.duckduckgo.autofill.api.BrowserAutofill
3938
import com.duckduckgo.autofill.api.CredentialAutofillDialogFactory
@@ -72,13 +71,13 @@ import com.duckduckgo.common.utils.FragmentViewModelFactory
7271
import com.duckduckgo.common.utils.plugins.PluginPoint
7372
import com.duckduckgo.di.scopes.FragmentScope
7473
import com.duckduckgo.user.agent.api.UserAgentProvider
75-
import javax.inject.Inject
7674
import kotlinx.coroutines.flow.launchIn
7775
import kotlinx.coroutines.flow.onEach
7876
import kotlinx.coroutines.launch
7977
import kotlinx.coroutines.withContext
8078
import logcat.LogPriority.WARN
8179
import logcat.logcat
80+
import javax.inject.Inject
8281

8382
@InjectWith(FragmentScope::class)
8483
class ImportGooglePasswordsWebFlowFragment :
@@ -89,7 +88,6 @@ class ImportGooglePasswordsWebFlowFragment :
8988
NoOpEmailProtectionUserPromptListener,
9089
NoOpAutofillEventListener,
9190
GooglePasswordBlobConsumer.Callback {
92-
9391
@Inject
9492
lateinit var userAgentProvider: UserAgentProvider
9593

@@ -99,9 +97,6 @@ class ImportGooglePasswordsWebFlowFragment :
9997
@Inject
10098
lateinit var viewModelFactory: FragmentViewModelFactory
10199

102-
@Inject
103-
lateinit var autofillCapabilityChecker: AutofillCapabilityChecker
104-
105100
@Inject
106101
lateinit var credentialAutofillDialogFactory: CredentialAutofillDialogFactory
107102

@@ -115,7 +110,7 @@ class ImportGooglePasswordsWebFlowFragment :
115110
lateinit var passwordBlobConsumer: GooglePasswordBlobConsumer
116111

117112
@Inject
118-
lateinit var passwordImporterScriptLoader: PasswordImporterScriptLoader
113+
lateinit var googleImporterScriptLoader: GoogleImporterScriptLoader
119114

120115
@Inject
121116
lateinit var browserAutofillConfigurator: InternalBrowserAutofillConfigurator
@@ -179,8 +174,7 @@ class ImportGooglePasswordsWebFlowFragment :
179174
// no-op
180175
}
181176
}
182-
}
183-
.launchIn(lifecycleScope)
177+
}.launchIn(lifecycleScope)
184178
}
185179

186180
private fun observeCommands() {
@@ -201,8 +195,7 @@ class ImportGooglePasswordsWebFlowFragment :
201195
showCredentialChooserDialog(command.originalUrl, command.credentials, command.triggerType)
202196
}
203197
}
204-
}
205-
.launchIn(lifecycleScope)
198+
}.launchIn(lifecycleScope)
206199
}
207200

208201
private suspend fun injectReauthenticationCredentials(
@@ -217,11 +210,12 @@ class ImportGooglePasswordsWebFlowFragment :
217210
return@withContext
218211
}
219212

220-
val credentials = LoginCredentials(
221-
domain = url,
222-
username = username,
223-
password = password,
224-
)
213+
val credentials =
214+
LoginCredentials(
215+
domain = url,
216+
username = username,
217+
password = password,
218+
)
225219

226220
logcat { "Injecting re-authentication credentials" }
227221
browserAutofill.injectCredentials(credentials)
@@ -234,16 +228,18 @@ class ImportGooglePasswordsWebFlowFragment :
234228
}
235229

236230
private fun exitFlowAsSuccess() {
237-
val resultBundle = Bundle().also {
238-
it.putParcelable(RESULT_KEY_DETAILS, ImportGooglePasswordResult.Success)
239-
}
231+
val resultBundle =
232+
Bundle().also {
233+
it.putParcelable(RESULT_KEY_DETAILS, ImportGooglePasswordResult.Success)
234+
}
240235
setFragmentResult(RESULT_KEY, resultBundle)
241236
}
242237

243238
private fun exitFlowAsImpossibleToImport(reason: UserCannotImportReason) {
244-
val resultBundle = Bundle().also {
245-
it.putParcelable(RESULT_KEY_DETAILS, ImportGooglePasswordResult.Error(reason))
246-
}
239+
val resultBundle =
240+
Bundle().also {
241+
it.putParcelable(RESULT_KEY_DETAILS, ImportGooglePasswordResult.Error(reason))
242+
}
247243
setFragmentResult(RESULT_KEY, resultBundle)
248244
}
249245

@@ -343,7 +339,7 @@ class ImportGooglePasswordsWebFlowFragment :
343339
@SuppressLint("RequiresFeature", "AddDocumentStartJavaScriptUsage")
344340
private suspend fun configurePasswordImportJavascript(webView: WebView) {
345341
if (importPasswordConfig.getConfig().canInjectJavascript) {
346-
val script = passwordImporterScriptLoader.getScript()
342+
val script = googleImporterScriptLoader.getScriptForPasswordImport()
347343
WebViewCompat.addDocumentStartJavaScript(webView, script, setOf("*"))
348344
}
349345
}
@@ -371,12 +367,13 @@ class ImportGooglePasswordsWebFlowFragment :
371367
return@withContext
372368
}
373369

374-
val dialog = credentialAutofillDialogFactory.autofillSelectCredentialsDialog(
375-
url,
376-
credentials,
377-
triggerType,
378-
CUSTOM_FLOW_TAB_ID,
379-
)
370+
val dialog =
371+
credentialAutofillDialogFactory.autofillSelectCredentialsDialog(
372+
url,
373+
credentials,
374+
triggerType,
375+
CUSTOM_FLOW_TAB_ID,
376+
)
380377
dialog.show(childFragmentManager, SELECT_CREDENTIALS_FRAGMENT_TAG)
381378
}
382379
}

‎autofill/autofill-impl/src/main/java/com/duckduckgo/autofill/impl/importing/takeout/processor/BookmarkImportProcessor.kt‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
/*
2+
* Copyright (c) 2025 DuckDuckGo
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.duckduckgo.autofill.impl.importing.takeout.processor
18+
19+
import android.net.Uri
20+
import com.duckduckgo.autofill.impl.importing.takeout.processor.BookmarkImportProcessor.*
21+
import com.duckduckgo.autofill.impl.importing.takeout.processor.BookmarkImportProcessor.ImportResult.Error
22+
import com.duckduckgo.autofill.impl.importing.takeout.processor.BookmarkImportProcessor.ImportResult.Error.ParseError
23+
import com.duckduckgo.autofill.impl.importing.takeout.zip.TakeoutBookmarkExtractor
24+
import com.duckduckgo.autofill.impl.importing.takeout.zip.TakeoutBookmarkExtractor.ExtractionResult
25+
import com.duckduckgo.autofill.impl.importing.takeout.zip.TakeoutZipDownloader
26+
import com.duckduckgo.common.utils.DispatcherProvider
27+
import com.duckduckgo.di.scopes.AppScope
28+
import com.duckduckgo.savedsites.api.service.ImportSavedSitesResult
29+
import com.duckduckgo.savedsites.api.service.SavedSitesImporter.ImportFolder
30+
import com.squareup.anvil.annotations.ContributesBinding
31+
import kotlinx.coroutines.withContext
32+
import logcat.LogPriority.WARN
33+
import logcat.asLog
34+
import logcat.logcat
35+
import java.io.File
36+
import javax.inject.Inject
37+
38+
interface BookmarkImportProcessor {
39+
sealed class ImportResult {
40+
data class Success(
41+
val importedCount: Int,
42+
) : ImportResult()
43+
44+
sealed class Error : ImportResult() {
45+
data object DownloadError : Error()
46+
47+
data object ParseError : Error()
48+
49+
data object ImportError : Error()
50+
}
51+
}
52+
53+
suspend fun downloadAndImportFromTakeoutZipUrl(
54+
url: String,
55+
userAgent: String,
56+
folderName: String,
57+
): ImportResult
58+
}
59+
60+
@ContributesBinding(AppScope::class)
61+
class TakeoutBookmarkImportProcessor @Inject constructor(
62+
private val dispatchers: DispatcherProvider,
63+
private val takeoutZipDownloader: TakeoutZipDownloader,
64+
private val bookmarkExtractor: TakeoutBookmarkExtractor,
65+
private val takeoutBookmarkImporter: TakeoutBookmarkImporter,
66+
) : BookmarkImportProcessor {
67+
override suspend fun downloadAndImportFromTakeoutZipUrl(
68+
url: String,
69+
userAgent: String,
70+
folderName: String,
71+
): ImportResult =
72+
withContext(dispatchers.io()) {
73+
runCatching {
74+
val zipUri = takeoutZipDownloader.downloadZip(url, userAgent)
75+
processBookmarkZip(zipUri, folderName)
76+
}.getOrElse { e ->
77+
logcat(WARN) { "Bookmark zip download failed: ${e.asLog()}" }
78+
Error.DownloadError
79+
}
80+
}
81+
82+
private suspend fun processBookmarkZip(
83+
zipUri: Uri,
84+
folderName: String,
85+
): ImportResult =
86+
runCatching {
87+
val extractionResult = bookmarkExtractor.extractBookmarksFromFile(zipUri)
88+
handleExtractionResult(extractionResult, folderName)
89+
}.getOrElse { e ->
90+
logcat(WARN) { "Error processing bookmark zip: ${e.asLog()}" }
91+
ParseError
92+
}.also {
93+
cleanupZipFile(zipUri)
94+
}
95+
96+
private suspend fun handleExtractionResult(
97+
extractionResult: ExtractionResult,
98+
folderName: String,
99+
): ImportResult =
100+
when (extractionResult) {
101+
is ExtractionResult.Success -> {
102+
val importResult =
103+
takeoutBookmarkImporter.importBookmarks(
104+
extractionResult.tempFileUri,
105+
ImportFolder.Folder(folderName),
106+
)
107+
handleImportResult(importResult)
108+
}
109+
110+
is ExtractionResult.Error -> {
111+
logcat(WARN) { "Error extracting bookmarks from zip" }
112+
ParseError
113+
}
114+
}
115+
116+
private fun handleImportResult(importResult: ImportSavedSitesResult): ImportResult =
117+
when (importResult) {
118+
is ImportSavedSitesResult.Success -> {
119+
val importedCount = importResult.savedSites.size
120+
logcat { "Successfully imported $importedCount bookmarks" }
121+
ImportResult.Success(importedCount)
122+
}
123+
124+
is ImportSavedSitesResult.Error -> {
125+
logcat(WARN) { "Error importing bookmarks: ${importResult.exception.message}" }
126+
Error.ImportError
127+
}
128+
}
129+
130+
private fun cleanupZipFile(zipUri: Uri) {
131+
runCatching {
132+
val zipFile = File(zipUri.path ?: return)
133+
if (zipFile.exists() && zipFile.delete()) {
134+
logcat { "Cleaned up downloaded zip file: ${zipFile.absolutePath}" }
135+
}
136+
}.onFailure { logcat(WARN) { "Failed to cleanup downloaded zip file: ${it.asLog()}" } }
137+
}
138+
}

0 commit comments

Comments
 (0)