Use WebdavScoped for in-memory cookie store "singleton" that is cleared when DavDocumentsProvider is shut down

Author: rfc2822

.idea/codeStyles/Project.xml

@@ -0,0 +1,11 @@
+/*
+ * Copyright © All Contributors. See LICENSE and AUTHORS in the root directory for details.
+ */
+
+package at.bitfire.davdroid.di
+
+import javax.inject.Qualifier
+
+@Qualifier
+@Retention(AnnotationRetention.RUNTIME)
+annotation class Bridged

app/src/main/kotlin/at/bitfire/davdroid/di/Bridged.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright © All Contributors. See LICENSE and AUTHORS in the root directory for details.
+ */
+
+package at.bitfire.davdroid.webdav
+
+import android.util.Log
+import at.bitfire.davdroid.network.MemoryCookieStore
+import okhttp3.CookieJar
+
+class CookieStoreManager {
+
+    init {
+        Log.i("CookieStoreManager", "CookieStoreManager.init()")
+    }
+
+    private val cookieStores = mutableMapOf<Long, CookieJar>()
+
+    fun forMount(mountId: Long) =
+        cookieStores.getOrPut(mountId) {
+            MemoryCookieStore()
+        }
+
+}

app/src/main/kotlin/at/bitfire/davdroid/webdav/CookieStoreManager.kt

@@ -4,21 +4,11 @@
 
 package at.bitfire.davdroid.webdav
 
-import android.content.Context
 import android.graphics.Point
 import android.os.CancellationSignal
-import android.provider.DocumentsContract.buildRootsUri
 import android.provider.DocumentsProvider
-import at.bitfire.dav4jvm.property.webdav.CurrentUserPrivilegeSet
-import at.bitfire.dav4jvm.property.webdav.DisplayName
-import at.bitfire.dav4jvm.property.webdav.GetContentLength
-import at.bitfire.dav4jvm.property.webdav.GetContentType
-import at.bitfire.dav4jvm.property.webdav.GetETag
-import at.bitfire.dav4jvm.property.webdav.GetLastModified
-import at.bitfire.dav4jvm.property.webdav.QuotaAvailableBytes
-import at.bitfire.dav4jvm.property.webdav.QuotaUsedBytes
-import at.bitfire.dav4jvm.property.webdav.ResourceType
-import at.bitfire.davdroid.R
+import android.util.Log
+import at.bitfire.davdroid.webdav.di.WebdavComponentManager
 import at.bitfire.davdroid.webdav.operation.CopyDocumentOperation
 import at.bitfire.davdroid.webdav.operation.CreateDocumentOperation
 import at.bitfire.davdroid.webdav.operation.DeleteDocumentOperation
@@ -60,6 +50,7 @@ class DavDocumentsProvider: DocumentsProvider() {
         fun queryDocumentOperation(): QueryDocumentOperation
         fun queryRootsOperation(): QueryRootsOperation
         fun renameDocumentOperation(): RenameDocumentOperation
+        fun webdavComponentManager(): WebdavComponentManager
     }
 
     /**
@@ -72,10 +63,15 @@ class DavDocumentsProvider: DocumentsProvider() {
     }
 
 
-    override fun onCreate() = true
+    override fun onCreate(): Boolean {
+        Log.v("DavDocumentsProvider", "onCreate()")
+        return true
+    }
 
     override fun shutdown() {
+        Log.v("DavDocumentsProvider", "onDestroy()")
         providerScope.cancel()
+        entryPoint.webdavComponentManager().resetComponent()
     }
 
 
@@ -120,26 +116,4 @@ class DavDocumentsProvider: DocumentsProvider() {
     override fun openDocumentThumbnail(documentId: String, sizeHint: Point, signal: CancellationSignal?) =
         entryPoint.openDocumentThumbnailOperation().invoke(documentId, sizeHint, signal)
 
-
-    companion object {
-
-        val DAV_FILE_FIELDS = arrayOf(
-            ResourceType.NAME,
-            CurrentUserPrivilegeSet.NAME,
-            DisplayName.NAME,
-            GetETag.NAME,
-            GetContentType.NAME,
-            GetContentLength.NAME,
-            GetLastModified.NAME,
-            QuotaAvailableBytes.NAME,
-            QuotaUsedBytes.NAME,
-        )
-
-        const val MAX_NAME_ATTEMPTS = 5
-
-        fun notifyMountsChanged(context: Context) {
-            context.contentResolver.notifyChange(buildRootsUri(context.getString(R.string.webdav_authority)), null)
-        }
-
-    }
 }

app/src/main/kotlin/at/bitfire/davdroid/webdav/DavDocumentsProvider.kt

@@ -5,15 +5,14 @@
 package at.bitfire.davdroid.webdav
 
 import at.bitfire.davdroid.network.HttpClient
-import at.bitfire.davdroid.network.MemoryCookieStore
-import okhttp3.CookieJar
 import okhttp3.logging.HttpLoggingInterceptor
 import javax.inject.Inject
 import javax.inject.Provider
 
 class DavHttpClientBuilder @Inject constructor(
+    private val cookieStoreManager: CookieStoreManager,
     private val credentialsStore: CredentialsStore,
-    private val httpClientBuilder: Provider<HttpClient.Builder>
+    private val httpClientBuilder: Provider<HttpClient.Builder>,
 ) {
 
     /**
@@ -25,9 +24,7 @@ class DavHttpClientBuilder @Inject constructor(
     fun build(mountId: Long, logBody: Boolean = true): HttpClient {
         val builder = httpClientBuilder.get()
             .loggerInterceptorLevel(if (logBody) HttpLoggingInterceptor.Level.BODY else HttpLoggingInterceptor.Level.HEADERS)
-            .setCookieStore(
-                cookieStores.getOrPut(mountId) { MemoryCookieStore() }
-            )
+            .setCookieStore(cookieStoreManager.forMount(mountId))
 
         credentialsStore.getCredentials(mountId)?.let { credentials ->
             builder.authenticate(host = null, getCredentials = { credentials })
@@ -36,12 +33,4 @@ class DavHttpClientBuilder @Inject constructor(
         return builder.build()
     }
 
-
-    companion object {
-
-        // TODO global leak
-        private val cookieStores = mutableMapOf<Long, CookieJar>()
-
-    }
-
 }

app/src/main/kotlin/at/bitfire/davdroid/webdav/DavHttpClientBuilder.kt

@@ -10,6 +10,7 @@ import android.content.Context
 import android.content.Intent
 import android.os.Build
 import android.provider.DocumentsContract.buildChildDocumentsUri
+import android.provider.DocumentsContract.buildRootsUri
 import android.webkit.MimeTypeMap
 import androidx.core.app.TaskStackBuilder
 import at.bitfire.dav4jvm.exception.HttpException
@@ -20,6 +21,8 @@ import java.net.HttpURLConnection
 
 object DocumentProviderUtils  {
 
+    const val MAX_DISPLAYNAME_TO_MEMBERNAME_ATTEMPTS = 5
+
     internal fun displayNameToMemberName(displayName: String, appendNumber: Int = 0): String {
         val safeName = displayName.filterNot { it.isISOControl() }
 
@@ -55,13 +58,18 @@ object DocumentProviderUtils  {
         )
     }
 
+    internal fun notifyMountsChanged(context: Context) {
+        context.contentResolver.notifyChange(
+            buildRootsUri(context.getString(R.string.webdav_authority)),
+            null)
+    }
+
 }
 
 internal fun HttpException.throwForDocumentProvider(context: Context, ignorePreconditionFailed: Boolean = false) {
     when (code) {
         HttpURLConnection.HTTP_UNAUTHORIZED -> {
             if (Build.VERSION.SDK_INT >= 26) {
-                // TODO edit mount
                 val intent = Intent(context, WebdavMountsActivity::class.java)
                 throw AuthenticationRequiredException(
                     this,

app/src/main/kotlin/at/bitfire/davdroid/webdav/DocumentProviderUtils.kt

@@ -4,7 +4,6 @@
 
 package at.bitfire.davdroid.webdav
 
-import android.os.Build
 import android.os.Handler
 import android.os.HandlerThread
 import android.os.ProxyFileDescriptorCallback
@@ -49,7 +48,7 @@ import kotlin.concurrent.schedule
  *
  * @param httpClient    HTTP client – [RandomAccessCallbackWrapper] is responsible to close it
  */
-@RequiresApi(Build.VERSION_CODES.O)
+@RequiresApi(26)
 class RandomAccessCallbackWrapper @AssistedInject constructor(
     @Assisted private val httpClient: HttpClient,
     @Assisted private val url: HttpUrl,

app/src/main/kotlin/at/bitfire/davdroid/webdav/RandomAccessCallbackWrapper.kt

@@ -66,7 +66,7 @@ class WebDavMountRepository @Inject constructor(
         credentialsStore.setCredentials(id, credentials)
 
         // notify content URI listeners
-        DavDocumentsProvider.notifyMountsChanged(context)
+        DocumentProviderUtils.notifyMountsChanged(context)
 
         return true
     }
@@ -79,7 +79,7 @@ class WebDavMountRepository @Inject constructor(
         CredentialsStore(context).setCredentials(mount.id, null)
 
         // notify content URI listeners
-        DavDocumentsProvider.notifyMountsChanged(context)
+        DocumentProviderUtils.notifyMountsChanged(context)
     }
 
     fun getAllFlow() = mountDao.getAllFlow()

app/src/main/kotlin/at/bitfire/davdroid/webdav/WebDavMountRepository.kt

@@ -0,0 +1,19 @@
+/*
+ * Copyright © All Contributors. See LICENSE and AUTHORS in the root directory for details.
+ */
+
+package at.bitfire.davdroid.webdav.di
+
+import at.bitfire.davdroid.di.Bridged
+import at.bitfire.davdroid.webdav.CookieStoreManager
+import dagger.hilt.EntryPoint
+import dagger.hilt.InstallIn
+
+@EntryPoint
+@InstallIn(WebdavComponent::class)
+internal interface WebDavEntryPoint {
+
+    @Bridged    // without this qualifier, the CookieStoreManager from CookieStoreManagerBridgedModule would be used
+    fun cookieStoreManager(): CookieStoreManager
+
+}

app/src/main/kotlin/at/bitfire/davdroid/webdav/di/WebDavEntryPoint.kt

@@ -0,0 +1,19 @@
+/*
+ * Copyright © All Contributors. See LICENSE and AUTHORS in the root directory for details.
+ */
+
+package at.bitfire.davdroid.webdav.di
+
+import dagger.hilt.DefineComponent
+import dagger.hilt.components.SingletonComponent
+
+@WebdavScoped
+@DefineComponent(parent = SingletonComponent::class)
+interface WebdavComponent {
+
+    @DefineComponent.Builder
+    interface Builder {
+        fun build(): WebdavComponent
+    }
+
+}