LegacyAndroidCalendar: add getEvent() for event retrieval

Author: rfc2822

lib/src/androidTest/kotlin/at/bitfire/ical4android/AndroidEventTest.kt

@@ -44,15 +44,17 @@ class AndroidEventTest {
 
     private val testAccount = Account(javaClass.name, ACCOUNT_TYPE_LOCAL)
 
-    private lateinit var calendar: AndroidCalendar
     lateinit var client: ContentProviderClient
+    private lateinit var calendar: AndroidCalendar
+    private lateinit var legacyCalendar: LegacyAndroidCalendar
 
     @Before
     fun prepare() {
         val context = getInstrumentation().targetContext
         client = context.contentResolver.acquireContentProviderClient(AUTHORITY)!!
 
         calendar = TestCalendar.findOrCreate(testAccount, client, withColors = true)
+        legacyCalendar = LegacyAndroidCalendar(calendar)
     }
 
     @After
@@ -90,11 +92,11 @@ class AndroidEventTest {
         event.dtStart = DtStart("20150502T120000Z")
         event.dtEnd = DtEnd("20150502T130000Z")
         event.organizer = Organizer(URI("mailto:organizer@example.com"))
-        val uri = LegacyAndroidCalendar(calendar).add(event)
+        val uri = legacyCalendar.add(event)
 
         // update test event in calendar
         val testEvent = calendar.getLegacyEvent(ContentUris.parseId(uri))!!
-        val event2 = testEvent.event!!
+        val event2 = legacyCalendar.getEvent(testEvent.id)!!
         event2.summary = "Updated event"
         // add data rows
         event2.alarms += VAlarm(Duration.parse("-P1DT2H3M4S"))
@@ -107,7 +109,7 @@ class AndroidEventTest {
         // read again and verify result
         val updatedEvent = calendar.getLegacyEvent(ContentUris.parseId(uri2))!!
         try {
-            val event3 = updatedEvent.event!!
+            val event3 = legacyCalendar.getEvent(updatedEvent.id)!!
             assertEquals(event2.summary, event3.summary)
             assertEquals(1, event3.alarms.size)
             assertEquals(1, event3.attendees.size)
@@ -124,20 +126,20 @@ class AndroidEventTest {
             dtStart = DtStart(DateTime())
             color = Css3Color.silver
         }
-        val uri = LegacyAndroidCalendar(calendar).add(event)
+        val uri = legacyCalendar.add(event)
         val id = ContentUris.parseId(uri)
 
         // verify that it has color
         val beforeUpdate = calendar.getLegacyEvent(id)!!
-        assertNotNull(beforeUpdate.event?.color)
+        assertNotNull(legacyCalendar.getEvent(beforeUpdate.id)!!.color)
 
         // update: reset color
         event.color = null
         beforeUpdate.update(event)
 
         // verify that it doesn't have color anymore
         val afterUpdate = calendar.getLegacyEvent(id)!!
-        assertNull(afterUpdate.event!!.color)
+        assertNull(legacyCalendar.getEvent(afterUpdate.id)!!.color)
     }
 
     @Test
@@ -147,11 +149,11 @@ class AndroidEventTest {
         event.summary = "Sample event with STATUS"
         event.dtStart = DtStart("20150502T120000Z")
         event.dtEnd = DtEnd("20150502T130000Z")
-        val uri = LegacyAndroidCalendar(calendar).add(event)
+        val uri = legacyCalendar.add(event)
 
         // update test event in calendar
         val testEvent = calendar.getLegacyEvent(ContentUris.parseId(uri))!!
-        val event2 = testEvent.event!!
+        val event2 = legacyCalendar.getEvent(testEvent.id)!!
         event2.summary = "Sample event without STATUS"
         event2.status = Status.VEVENT_CONFIRMED
         val uri2 = testEvent.update(event2)
@@ -162,7 +164,7 @@ class AndroidEventTest {
         // read again and verify result
         val updatedEvent = calendar.getLegacyEvent(ContentUris.parseId(uri2))!!
         try {
-            val event3 = updatedEvent.event!!
+            val event3 = legacyCalendar.getEvent(updatedEvent.id)!!
             assertEquals(Status.VEVENT_CONFIRMED, event3.status)
         } finally {
             updatedEvent.delete()
@@ -177,11 +179,11 @@ class AndroidEventTest {
         event.dtStart = DtStart("20150502T120000Z")
         event.dtEnd = DtEnd("20150502T130000Z")
         event.status = Status.VEVENT_CONFIRMED
-        val uri = LegacyAndroidCalendar(calendar).add(event)
+        val uri = legacyCalendar.add(event)
 
         // update test event in calendar
         val testEvent = calendar.getLegacyEvent(ContentUris.parseId(uri))!!
-        val event2 = testEvent.event!!
+        val event2 = legacyCalendar.getEvent(testEvent.id)!!
         event2.summary = "Sample event without STATUS"
         event2.status = null
         val uri2 = testEvent.update(event2)
@@ -192,7 +194,7 @@ class AndroidEventTest {
         // read again and verify result
         val updatedEvent = calendar.getLegacyEvent(ContentUris.parseId(uri2))!!
         try {
-            val event3 = updatedEvent.event!!
+            val event3 = legacyCalendar.getEvent(updatedEvent.id)!!
             assertNull(event3.status)
         } finally {
             updatedEvent.delete()
@@ -209,11 +211,11 @@ class AndroidEventTest {
         event.dtEnd = DtEnd("20150502T130000Z")
         for (i in 0 until 20)
             event.attendees += Attendee(URI("mailto:att$i@example.com"))
-        val uri = LegacyAndroidCalendar(calendar).add(event)
+        val uri = legacyCalendar.add(event)
 
         val testEvent = calendar.getLegacyEvent(ContentUris.parseId(uri))!!
         try {
-            assertEquals(20, testEvent.event!!.attendees.size)
+            assertEquals(20, legacyCalendar.getEvent(testEvent.id)!!.attendees.size)
         } finally {
             testEvent.delete()
         }

lib/src/androidTest/kotlin/at/bitfire/synctools/mapping/calendar/LegacyAndroidEventProcessorTest.kt

@@ -22,6 +22,7 @@ import androidx.core.content.contentValuesOf
 import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
 import at.bitfire.ical4android.AndroidEvent
 import at.bitfire.ical4android.Event
+import at.bitfire.ical4android.LegacyAndroidCalendar
 import at.bitfire.ical4android.UnknownProperty
 import at.bitfire.ical4android.impl.TestCalendar
 import at.bitfire.ical4android.util.AndroidTimeUtils
@@ -85,7 +86,6 @@ class LegacyAndroidEventProcessorTest {
         client = context.contentResolver.acquireContentProviderClient(AUTHORITY)!!
 
         calendar = TestCalendar.findOrCreate(testAccount, client)
-        assertNotNull(calendar)
         calendarUri = ContentUris.withAppendedId(Calendars.CONTENT_URI, calendar.id)
     }
 
@@ -145,14 +145,15 @@ class LegacyAndroidEventProcessorTest {
         extendedProperties: Map<String, String> = emptyMap(),
         valuesBuilder: ContentValues.() -> Unit = {}
     ): Event {
-        return populateAndroidEvent(
+        val androidEvent = populateAndroidEvent(
             automaticDates,
             destinationCalendar,
             asSyncAdapter,
             insertCallback,
             extendedProperties,
             valuesBuilder
-        ).event!!
+        )
+        return LegacyAndroidCalendar(destinationCalendar).getEvent(androidEvent.id)!!
     }
 
     @Test

lib/src/androidTest/kotlin/at/bitfire/synctools/storage/calendar/ProviderTest.kt

@@ -9,23 +9,19 @@ package at.bitfire.ical4android
 import android.content.ContentResolver
 import android.content.ContentUris
 import android.content.ContentValues
-import android.content.EntityIterator
 import android.net.Uri
 import android.os.RemoteException
 import android.provider.CalendarContract.Attendees
 import android.provider.CalendarContract.Events
-import android.provider.CalendarContract.EventsEntity
 import android.provider.CalendarContract.ExtendedProperties
 import android.provider.CalendarContract.Reminders
 import at.bitfire.ical4android.AndroidEvent.Companion.CATEGORIES_SEPARATOR
 import at.bitfire.ical4android.util.MiscUtils.asSyncAdapter
 import at.bitfire.synctools.mapping.calendar.LegacyAndroidEventBuilder
-import at.bitfire.synctools.mapping.calendar.LegacyAndroidEventProcessor
 import at.bitfire.synctools.storage.BatchOperation.CpoBuilder
 import at.bitfire.synctools.storage.LocalStorageException
 import at.bitfire.synctools.storage.calendar.AndroidCalendar
 import at.bitfire.synctools.storage.calendar.CalendarBatchOperation
-import java.io.FileNotFoundException
 
 /**
  * Stores and retrieves VEVENT iCalendar objects (represented as [Event]s) to/from the
@@ -52,64 +48,15 @@ class AndroidEvent(
     var scheduleTag: String? = values.getAsString(COLUMN_SCHEDULE_TAG)
     var flags: Int = values.getAsInteger(COLUMN_FLAGS) ?: 0
 
-    private var _event: Event? = null
-
-    /**
-     * Returns the full event data, either from [event] or, if [event] is null, by reading event
-     * number [id] from the Android calendar storage.
-     *
-     * @throws IllegalArgumentException if event has not been saved yet
-     * @throws FileNotFoundException if there's no event with [id] in the calendar storage
-     * @throws RemoteException on calendar provider errors
-     */
-    var event: Event?
-        private set(value) {
-            _event = value
-        }
-        get() {
-            if (_event != null)
-                return _event
-            val id = requireNotNull(id)
-
-            var iterEvents: EntityIterator? = null
-            try {
-                iterEvents = EventsEntity.newEntityIterator(
-                        calendar.client.query(
-                                ContentUris.withAppendedId(EventsEntity.CONTENT_URI, id).asSyncAdapter(calendar.account),
-                                null, null, null, null),
-                        calendar.client
-                )
-
-                if (iterEvents.hasNext()) {
-                    val entity = iterEvents.next()
-                    return Event().also { newEvent ->
-                        val processor = LegacyAndroidEventProcessor(calendar, id, entity)
-                        processor.populate(to = newEvent)
-
-                        _event = newEvent
-                    }
-                }
-            } catch (e: Exception) {
-                /* Populating event has been interrupted by an exception, so we reset the event to
-                avoid an inconsistent state. This also ensures that the exception will be thrown
-                again on the next get() call. */
-                _event = null
-                throw e
-            } finally {
-                iterEvents?.close()
-            }
-
-            throw FileNotFoundException("Couldn't find event $id")
-        }
-
     /**
      * Updates an already existing event in the calendar storage with the values
      * from the instance.
+     *
      * @throws LocalStorageException when the calendar provider doesn't return a result row
      * @throws RemoteException on calendar provider errors
      */
     fun update(event: Event): Uri {
-        this.event = event
+        //this.event = event
         val existingId = requireNotNull(id)
 
         // There are cases where the event cannot be updated, but must be completely re-created.
@@ -194,7 +141,7 @@ class AndroidEvent(
         return ContentUris.withAppendedId(Events.CONTENT_URI, id).asSyncAdapter(calendar.account)
     }
 
-    override fun toString(): String = "AndroidEvent(calendar=$calendar, id=$id, event=$_event)"
+    override fun toString(): String = "AndroidEvent(calendar=$calendar, id=$id)"
 
 
     companion object {

lib/src/main/kotlin/at/bitfire/ical4android/AndroidEvent.kt

@@ -9,6 +9,7 @@ package at.bitfire.ical4android
 import android.net.Uri
 import android.os.RemoteException
 import at.bitfire.synctools.mapping.calendar.LegacyAndroidEventBuilder
+import at.bitfire.synctools.mapping.calendar.LegacyAndroidEventProcessor
 import at.bitfire.synctools.storage.LocalStorageException
 import at.bitfire.synctools.storage.calendar.AndroidCalendar
 import at.bitfire.synctools.storage.calendar.CalendarBatchOperation
@@ -48,4 +49,20 @@ class LegacyAndroidCalendar(
         return resultUri
     }
 
+    /**
+     * Gets an [Event] data object from an Android event with a specific ID.
+     *
+     * @param id    event ID
+     *
+     * @return event data object
+     */
+    fun getEvent(id: Long): Event? {
+        val entity = calendar.getEventEntity(id) ?: return null
+        return Event().also { event ->
+            val processor = LegacyAndroidEventProcessor(calendar, id, entity)
+            processor.populate(to = event)
+        }
+
+    }
+
 }