Extract `refreshPrincipals()` to `PrincipalsRefresher` (#1607) (10f6356a) · Commits · e / os / AccountManager

app/src/androidTest/kotlin/at/bitfire/davdroid/servicedetection/CollectionListRefresherTest.kt

+0 −88

Original line number	Diff line number	Diff line
		@@ -8,7 +8,6 @@ import android.security.NetworkSecurityPolicy
		import at.bitfire.davdroid.db.AppDatabase
		import at.bitfire.davdroid.db.Collection
		import at.bitfire.davdroid.db.HomeSet
		import at.bitfire.davdroid.db.Principal
		import at.bitfire.davdroid.db.Service
		import at.bitfire.davdroid.network.HttpClient
		import at.bitfire.davdroid.settings.Settings
		@@ -341,93 +340,6 @@ class CollectionListRefresherTest {
		}


		// refreshPrincipals

		@Test
		fun refreshPrincipals_inaccessiblePrincipal() {
		// place principal without display name in db
		val principalId = db.principalDao().insert(
		Principal(
		0,
		service.id,
		mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL_INACCESSIBLE"), // no trailing slash
		null // no display name for now
		)
		)
		// add an associated collection - as the principal is rightfully removed otherwise
		db.collectionDao().insertOrUpdateByUrl(
		Collection(
		0,
		service.id,
		null,
		principalId, // create association with principal
		Collection.TYPE_ADDRESSBOOK,
		mockServer.url("$PATH_CARDDAV$SUBPATH_ADDRESSBOOK/"), // with trailing slash
		)
		)

		// Refresh principals
		refresherFactory.create(service, client.okHttpClient).refreshPrincipals()

		// Check principal was not updated
		val principals = db.principalDao().getByService(service.id)
		assertEquals(1, principals.size)
		assertEquals(mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL_INACCESSIBLE"), principals[0].url)
		assertEquals(null, principals[0].displayName)
		}

		@Test
		fun refreshPrincipals_updatesPrincipal() {
		// place principal without display name in db
		val principalId = db.principalDao().insert(
		Principal(
		0,
		service.id,
		mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL"), // no trailing slash
		null // no display name for now
		)
		)
		// add an associated collection - as the principal is rightfully removed otherwise
		db.collectionDao().insertOrUpdateByUrl(
		Collection(
		0,
		service.id,
		null,
		principalId, // create association with principal
		Collection.TYPE_ADDRESSBOOK,
		mockServer.url("$PATH_CARDDAV$SUBPATH_ADDRESSBOOK/"), // with trailing slash
		)
		)

		// Refresh principals
		refresherFactory.create(service, client.okHttpClient).refreshPrincipals()

		// Check principal now got a display name
		val principals = db.principalDao().getByService(service.id)
		assertEquals(1, principals.size)
		assertEquals(mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL"), principals[0].url)
		assertEquals("Mr. Wobbles", principals[0].displayName)
		}

		@Test
		fun refreshPrincipals_deletesPrincipalsWithoutCollections() {
		// place principal without collections in DB
		db.principalDao().insert(
		Principal(
		0,
		service.id,
		mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL_WITHOUT_COLLECTIONS/")
		)
		)

		// Refresh principals - detecting it does not own collections
		refresherFactory.create(service, client.okHttpClient).refreshPrincipals()

		// Check principal was deleted
		val principals = db.principalDao().getByService(service.id)
		assertEquals(0, principals.size)
		}

		// Others

		@Test

app/src/androidTest/kotlin/at/bitfire/davdroid/servicedetection/PrincipalsRefresherTest.kt

0 → 100644

+236 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright © All Contributors. See LICENSE and AUTHORS in the root directory for details.
		*/

		package at.bitfire.davdroid.servicedetection

		import android.security.NetworkSecurityPolicy
		import at.bitfire.davdroid.db.AppDatabase
		import at.bitfire.davdroid.db.Collection
		import at.bitfire.davdroid.db.Principal
		import at.bitfire.davdroid.db.Service
		import at.bitfire.davdroid.network.HttpClient
		import at.bitfire.davdroid.settings.SettingsManager
		import dagger.hilt.android.testing.BindValue
		import dagger.hilt.android.testing.HiltAndroidRule
		import dagger.hilt.android.testing.HiltAndroidTest
		import io.mockk.impl.annotations.MockK
		import io.mockk.junit4.MockKRule
		import junit.framework.TestCase.assertEquals
		import okhttp3.mockwebserver.Dispatcher
		import okhttp3.mockwebserver.MockResponse
		import okhttp3.mockwebserver.MockWebServer
		import okhttp3.mockwebserver.RecordedRequest
		import org.junit.After
		import org.junit.Assume
		import org.junit.Before
		import org.junit.Rule
		import org.junit.Test
		import java.util.logging.Logger
		import javax.inject.Inject

		@HiltAndroidTest
		class PrincipalsRefresherTest {

		@Inject
		lateinit var db: AppDatabase

		@Inject
		lateinit var httpClientBuilder: HttpClient.Builder

		@Inject
		lateinit var logger: Logger

		@Inject
		lateinit var principalsRefresher: PrincipalsRefresher.Factory

		@BindValue
		@MockK(relaxed = true)
		lateinit var settings: SettingsManager

		@get:Rule
		val hiltRule = HiltAndroidRule(this)

		@get:Rule
		val mockKRule = MockKRule(this)

		private lateinit var client: HttpClient
		private lateinit var mockServer: MockWebServer
		private lateinit var service: Service

		@Before
		fun setUp() {
		hiltRule.inject()

		// Start mock web server
		mockServer = MockWebServer().apply {
		dispatcher = TestDispatcher(logger)
		start()
		}

		// build HTTP client
		client = httpClientBuilder.build()
		Assume.assumeTrue(NetworkSecurityPolicy.getInstance().isCleartextTrafficPermitted)

		// insert test service
		val serviceId = db.serviceDao().insertOrReplace(
		Service(id = 0, accountName = "test", type = Service.TYPE_CARDDAV, principal = null)
		)
		service = db.serviceDao().get(serviceId)!!
		}

		@After
		fun tearDown() {
		client.close()
		mockServer.shutdown()
		}


		@Test
		fun refreshPrincipals_inaccessiblePrincipal() {
		// place principal without display name in db
		val principalId = db.principalDao().insert(
		Principal(
		0,
		service.id,
		mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL_INACCESSIBLE"), // no trailing slash
		null // no display name for now
		)
		)
		// add an associated collection - as the principal is rightfully removed otherwise
		db.collectionDao().insertOrUpdateByUrl(
		Collection(
		0,
		service.id,
		null,
		principalId, // create association with principal
		Collection.TYPE_ADDRESSBOOK,
		mockServer.url("$PATH_CARDDAV$SUBPATH_ADDRESSBOOK/"), // with trailing slash
		)
		)

		// Refresh principals
		principalsRefresher.create(service, client.okHttpClient).refreshPrincipals()

		// Check principal was not updated
		val principals = db.principalDao().getByService(service.id)
		assertEquals(1, principals.size)
		assertEquals(mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL_INACCESSIBLE"), principals[0].url)
		assertEquals(null, principals[0].displayName)
		}

		@Test
		fun refreshPrincipals_updatesPrincipal() {
		// place principal without display name in db
		val principalId = db.principalDao().insert(
		Principal(
		0,
		service.id,
		mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL"), // no trailing slash
		null // no display name for now
		)
		)
		// add an associated collection - as the principal is rightfully removed otherwise
		db.collectionDao().insertOrUpdateByUrl(
		Collection(
		0,
		service.id,
		null,
		principalId, // create association with principal
		Collection.TYPE_ADDRESSBOOK,
		mockServer.url("$PATH_CARDDAV$SUBPATH_ADDRESSBOOK/"), // with trailing slash
		)
		)

		// Refresh principals
		principalsRefresher.create(service, client.okHttpClient).refreshPrincipals()

		// Check principal now got a display name
		val principals = db.principalDao().getByService(service.id)
		assertEquals(1, principals.size)
		assertEquals(mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL"), principals[0].url)
		assertEquals("Mr. Wobbles", principals[0].displayName)
		}

		@Test
		fun refreshPrincipals_deletesPrincipalsWithoutCollections() {
		// place principal without collections in DB
		db.principalDao().insert(
		Principal(
		0,
		service.id,
		mockServer.url("$PATH_CARDDAV$SUBPATH_PRINCIPAL_WITHOUT_COLLECTIONS/")
		)
		)

		// Refresh principals - detecting it does not own collections
		principalsRefresher.create(service, client.okHttpClient).refreshPrincipals()

		// Check principal was deleted
		val principals = db.principalDao().getByService(service.id)
		assertEquals(0, principals.size)
		}


		companion object {

		private const val PATH_CARDDAV = "/carddav"

		private const val SUBPATH_PRINCIPAL = "/principal"
		private const val SUBPATH_PRINCIPAL_INACCESSIBLE = "/inaccessible-principal"
		private const val SUBPATH_PRINCIPAL_WITHOUT_COLLECTIONS = "/principal2"
		private const val SUBPATH_GROUPPRINCIPAL_0 = "/groups/0"
		private const val SUBPATH_ADDRESSBOOK_HOMESET_PERSONAL = "/addressbooks-homeset"
		private const val SUBPATH_ADDRESSBOOK_HOMESET_EMPTY = "/addressbooks-homeset-empty"
		private const val SUBPATH_ADDRESSBOOK = "/addressbooks/my-contacts"

		}

		class TestDispatcher(
		private val logger: Logger
		) : Dispatcher() {

		override fun dispatch(request: RecordedRequest): MockResponse {
		val path = request.path!!.trimEnd('/')

		if (request.method.equals("PROPFIND", true)) {
		val properties = when (path) {

		PATH_CARDDAV + SUBPATH_PRINCIPAL ->
		"<resourcetype><principal/></resourcetype>" +
		"<displayname>Mr. Wobbles</displayname>" + "<CARD:addressbook-home-set>" + " <href>${PATH_CARDDAV}${SUBPATH_ADDRESSBOOK_HOMESET_PERSONAL}</href>" + "</CARD:addressbook-home-set>" + "<group-membership>" + " <href>${PATH_CARDDAV}${SUBPATH_GROUPPRINCIPAL_0}</href>" +
		"</group-membership>"

		PATH_CARDDAV + SUBPATH_PRINCIPAL_WITHOUT_COLLECTIONS ->
		"<CARD:addressbook-home-set>" +
		" <href>${PATH_CARDDAV}${SUBPATH_ADDRESSBOOK_HOMESET_EMPTY}</href>" +
		"</CARD:addressbook-home-set>" +
		"<displayname>Mr. Wobbles Jr.</displayname>"


		SUBPATH_ADDRESSBOOK_HOMESET_EMPTY -> ""

		else -> ""
		}

		logger.info("Queried: $path")
		return MockResponse()
		.setResponseCode(207)
		.setBody(
		"<multistatus xmlns='DAV:' xmlns:CARD='urn:ietf:params:xml:ns:carddav' xmlns:CAL='urn:ietf:params:xml:ns:caldav'>" +
		"<response>" +
		" <href>$path</href>" +
		" <propstat><prop>" +
		properties +
		" </prop></propstat>" +
		"</response>" +
		"</multistatus>"
		)
		}

		return MockResponse().setResponseCode(404)
		}

		}

		}
		No newline at end of file

app/src/main/kotlin/at/bitfire/davdroid/servicedetection/CollectionListRefresher.kt

+0 −38

Original line number	Diff line number	Diff line
		@@ -55,14 +55,6 @@ class CollectionListRefresher @AssistedInject constructor(
		fun create(service: Service, httpClient: OkHttpClient): CollectionListRefresher
		}

		/**
		* Principal properties to ask the server for.
		*/
		private val principalProperties = arrayOf(
		DisplayName.NAME,
		ResourceType.NAME
		)

		/**
		* Collection properties to ask for in a PROPFIND request on a collection.
		*/
		@@ -195,36 +187,6 @@ class CollectionListRefresher @AssistedInject constructor(

		}

		/**
		* Refreshes the principals (get their current display names).
		* Also removes principals which do not own any collections anymore.
		*/
		internal fun refreshPrincipals() {
		// Refresh principals (collection owner urls)
		val principals = db.principalDao().getByService(service.id)
		for (oldPrincipal in principals) {
		val principalUrl = oldPrincipal.url
		logger.fine("Querying principal $principalUrl")
		try {
		DavResource(httpClient, principalUrl).propfind(0, *principalProperties) { response, _ ->
		if (!response.isSuccess())
		return@propfind
		Principal.fromDavResponse(service.id, response)?.let { principal ->
		logger.fine("Got principal: $principal")
		db.principalDao().insertOrUpdate(service.id, principal)
		}
		}
		} catch (e: HttpException) {
		logger.info("Principal update failed with response code ${e.code}. principalUrl=$principalUrl")
		}
		}

		// Delete principals which don't own any collections
		db.principalDao().getAllWithoutCollections().forEach {principal ->
		db.principalDao().delete(principal)
		}
		}

		/**
		* Finds out whether given collection is usable, by checking that either
		* - CalDAV/CardDAV: service and collection type match, or

app/src/main/kotlin/at/bitfire/davdroid/servicedetection/PrincipalsRefresher.kt

0 → 100644

+73 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright © All Contributors. See LICENSE and AUTHORS in the root directory for details.
		*/

		package at.bitfire.davdroid.servicedetection

		import at.bitfire.dav4jvm.DavResource
		import at.bitfire.dav4jvm.exception.HttpException
		import at.bitfire.dav4jvm.property.webdav.DisplayName
		import at.bitfire.dav4jvm.property.webdav.ResourceType
		import at.bitfire.davdroid.db.AppDatabase
		import at.bitfire.davdroid.db.Principal
		import at.bitfire.davdroid.db.Service
		import dagger.assisted.Assisted
		import dagger.assisted.AssistedFactory
		import dagger.assisted.AssistedInject
		import okhttp3.OkHttpClient
		import java.util.logging.Logger

		/**
		* Used to update the principals (their current display names) and delete those without collections.
		*/
		class PrincipalsRefresher @AssistedInject constructor(
		@Assisted private val service: Service,
		@Assisted private val httpClient: OkHttpClient,
		private val db: AppDatabase,
		private val logger: Logger
		) {

		@AssistedFactory
		interface Factory {
		fun create(service: Service, httpClient: OkHttpClient): PrincipalsRefresher
		}

		/**
		* Principal properties to ask the server for.
		*/
		private val principalProperties = arrayOf(
		DisplayName.NAME,
		ResourceType.NAME
		)

		/**
		* Refreshes the principals (get their current display names).
		* Also removes principals which do not own any collections anymore.
		*/
		fun refreshPrincipals() {
		// Refresh principals (collection owner urls)
		val principals = db.principalDao().getByService(service.id)
		for (oldPrincipal in principals) {
		val principalUrl = oldPrincipal.url
		logger.fine("Querying principal $principalUrl")
		try {
		DavResource(httpClient, principalUrl).propfind(0, *principalProperties) { response, _ ->
		if (!response.isSuccess())
		return@propfind
		Principal.fromDavResponse(service.id, response)?.let { principal ->
		logger.fine("Got principal: $principal")
		db.principalDao().insertOrUpdate(service.id, principal)
		}
		}
		} catch (e: HttpException) {
		logger.info("Principal update failed with response code ${e.code}. principalUrl=$principalUrl")
		}
		}

		// Delete principals which don't own any collections
		db.principalDao().getAllWithoutCollections().forEach { principal ->
		db.principalDao().delete(principal)
		}
		}

		}
		No newline at end of file

app/src/main/kotlin/at/bitfire/davdroid/servicedetection/RefreshCollectionsWorker.kt

+3 −1

Original line number	Diff line number	Diff line
		@@ -66,6 +66,7 @@ class RefreshCollectionsWorker @AssistedInject constructor(
		private val httpClientBuilder: HttpClient.Builder,
		private val logger: Logger,
		private val notificationRegistry: NotificationRegistry,
		private val principalsRefresherFactory: PrincipalsRefresher.Factory,
		private val pushRegistrationManager: PushRegistrationManager,
		private val serviceRefresherFactory: ServiceRefresher.Factory,
		serviceRepository: DavServiceRepository
		@@ -173,7 +174,8 @@ class RefreshCollectionsWorker @AssistedInject constructor(
		refresher.refreshHomelessCollections()

		// Lastly, refresh the principals (collection owners)
		refresher.refreshPrincipals()
		val principalsRefresher = principalsRefresherFactory.create(service, httpClient)
		principalsRefresher.refreshPrincipals()
		}
		}