Merge pull request #319 from bitfireAT/ical4j-3to4

Merge ical4j-3to4 into main branch

Author: rfc2822

gradle/libs.versions.toml

@@ -8,8 +8,7 @@ androidx-test-runner = "1.7.0"
 dokka = "2.2.0"
 ezvcard = "0.12.2"
 guava = "33.5.0-android"
-# noinspection NewerVersionAvailable
-ical4j = "3.2.19"   # final version; update to 4.x will require much work
+ical4j = "4.2.5"
 junit = "4.13.2"
 kotlin = "2.3.20"
 kotlinx-coroutines-test = "1.10.2"

lib/build.gradle.kts

@@ -148,4 +148,12 @@ dependencies {
     testImplementation(libs.kotlin.coroutines.test)
     testImplementation(libs.mockk)
     testImplementation(libs.roboelectric)
-}
+}
+
+tasks.withType<Test>().configureEach {
+    options {
+        // Prevent Robolectric from instrumenting ical4j classes to avoid problems with registering
+        // ical4j's ZoneRulesProviderImpl more than once with Java's ZoneRulesProvider.
+        systemProperty("org.robolectric.packagesToNotAcquire", "net.fortuna.ical4j")
+    }
+}

lib/consumer-rules.pro

@@ -10,10 +10,6 @@
 -dontwarn org.codehaus.groovy.**
 -dontwarn org.jparsec.**
 
-# keep to be used by ical4j
--keep class at.bitfire.ical4android.AndroidCompatTimeZoneRegistry { *; }
--keep class at.bitfire.ical4android.AndroidCompatTimeZoneRegistry$Factory { *; }
-
 # keep all vCard properties/parameters (used via reflection)
 -keep class ezvcard.io.scribe.** { *; }
 -keep class ezvcard.property.** { *; }

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

@@ -9,6 +9,7 @@ package at.bitfire.ical4android
 import net.fortuna.ical4j.model.TimeZoneRegistryFactory
 import org.junit.Assert
 import org.junit.Assert.assertNotNull
+import org.junit.Ignore
 import org.junit.Test
 import java.time.ZoneId
 import java.time.format.TextStyle

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

@@ -6,6 +6,7 @@
 
 package at.bitfire.ical4android
 
+import android.os.Build
 import androidx.test.platform.app.InstrumentationRegistry
 import at.bitfire.synctools.test.GrantPermissionOrSkipRule
 import org.junit.After
@@ -25,7 +26,13 @@ abstract class DmfsStyleProvidersTaskTest(
     companion object {
         @Parameterized.Parameters(name="{0}")
         @JvmStatic
-        fun taskProviders() = listOf(TaskProvider.ProviderName.OpenTasks,TaskProvider.ProviderName.TasksOrg)
+        fun taskProviders() = buildList {
+            add(TaskProvider.ProviderName.OpenTasks)
+
+            // tasks.org requires Android 8
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O)
+                add(TaskProvider.ProviderName.TasksOrg)
+        }
     }
 
     @get:Rule

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

@@ -13,7 +13,6 @@ import androidx.core.content.contentValuesOf
 import at.bitfire.ical4android.impl.TestTaskList
 import at.bitfire.synctools.storage.LocalStorageException
 import at.bitfire.synctools.storage.tasks.DmfsTaskList
-import net.fortuna.ical4j.model.Date
 import net.fortuna.ical4j.model.TimeZoneRegistryFactory
 import net.fortuna.ical4j.model.component.VAlarm
 import net.fortuna.ical4j.model.parameter.RelType
@@ -31,6 +30,8 @@ import org.junit.Assert.assertFalse
 import org.junit.Assert.assertNotNull
 import org.junit.Before
 import org.junit.Test
+import java.time.LocalDate
+import java.time.ZonedDateTime
 
 class DmfsTaskTest(
     providerName: TaskProvider.ProviderName
@@ -87,18 +88,27 @@ class DmfsTaskTest(
         task.summary = "Sample event"
         task.description = "Sample event with date/time"
         task.location = "Sample location"
-        task.dtStart = DtStart("20150501T120000", tzVienna)
-        task.due = Due("20150501T140000", tzVienna)
+        task.dtStart = DtStart(ZonedDateTime.of(
+            2015, 5, 1,
+            12, 0, 0, 0,
+            tzVienna.toZoneId()
+        ))
+        task.due = Due(ZonedDateTime.of(
+            2015, 5, 1,
+            14, 0, 0, 0,
+            tzVienna.toZoneId()
+        ))
         task.organizer = Organizer("mailto:organizer@example.com")
         assertFalse(task.isAllDay())
 
         // extended properties
         task.categories.addAll(arrayOf("Cat1", "Cat2"))
         task.comment = "A comment"
 
-        val sibling = RelatedTo("most-fields2@example.com")
-        sibling.parameters.add(RelType.SIBLING)
-        task.relatedTo.add(sibling)
+        task.relatedTo.add(
+            RelatedTo("most-fields2@example.com")
+                .add(RelType.SIBLING)
+        )
 
         task.unknownProperties += XProperty("X-UNKNOWN-PROP", "Unknown Value")
 
@@ -133,9 +143,9 @@ class DmfsTaskTest(
         val task = Task()
         task.uid = "invalidDUE@ical4android.tests"
         task.summary = "Task with invalid DUE"
-        task.dtStart = DtStart(Date("20150102"))
+        task.dtStart = DtStart(LocalDate.of(2015, 1, 2))
 
-        task.due = Due(Date("20150101"))
+        task.due = Due(LocalDate.of(2015, 1, 1))
         DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
     }
 
@@ -144,7 +154,7 @@ class DmfsTaskTest(
         val task = Task()
         task.uid = "TaskWithManyAlarms"
         task.summary = "Task with many alarms"
-        task.dtStart = DtStart(Date("20150102"))
+        task.dtStart = DtStart(LocalDate.of(2015, 1, 2))
 
         for (i in 1..1050)
             task.alarms += VAlarm(java.time.Duration.ofMinutes(i.toLong()))
@@ -162,7 +172,11 @@ class DmfsTaskTest(
         task.summary = "Sample event"
         task.description = "Sample event with date/time"
         task.location = "Sample location"
-        task.dtStart = DtStart("20150501T120000", tzVienna)
+        task.dtStart = DtStart(ZonedDateTime.of(
+            2015, 5, 1,
+            12, 0, 0, 0,
+            tzVienna.toZoneId()
+        ))
         assertFalse(task.isAllDay())
         val uri = DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
         assertNotNull(uri)

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

@@ -15,7 +15,7 @@ import androidx.core.content.pm.PackageInfoCompat
 import androidx.test.platform.app.InstrumentationRegistry
 import at.bitfire.ical4android.impl.TestJtxCollection
 import at.bitfire.ical4android.impl.testProdId
-
+import at.bitfire.synctools.icalendar.ICalendarParser
 import at.bitfire.synctools.test.GrantPermissionOrSkipRule
 import at.techbee.jtx.JtxContract
 import at.techbee.jtx.JtxContract.JtxICalObject
@@ -35,6 +35,8 @@ import org.junit.Rule
 import org.junit.Test
 import java.io.ByteArrayOutputStream
 import java.io.InputStreamReader
+import java.io.StringReader
+import kotlin.jvm.optionals.getOrNull
 
 class JtxICalObjectTest {
 
@@ -809,6 +811,7 @@ class JtxICalObjectTest {
     @Test fun check_input_equals_output_vtodo_rfc5545_sample() = compare_properties("jtx/vtodo/rfc5545-sample1.ics", null)
     @Test fun check_input_equals_output_vtodo_empty_priority() = compare_properties("jtx/vtodo/empty-priority.ics", null)
     @Test fun check_input_equals_output_vtodo_latin1() = compare_properties("jtx/vtodo/latin1.ics", null)
+    @Test fun check_input_equals_output_vtodo_attach() = compare_properties("jtx/vtodo/attach.ics", null)
 
     // VJOURNAL
     @Test fun check_input_equals_output_vjournal_default_example() = compare_properties("jtx/vjournal/default-example.ics", null)
@@ -824,6 +827,32 @@ class JtxICalObjectTest {
     //@Test fun check_input_equals_output_vjournal_dst_only_vtimezone() = compare_properties("jtx/vjournal/dst-only-vtimezone.ics", null)    // includes custom timezones, ignored for now
     @Test fun check_input_equals_output_vjournal_all_day() = compare_properties("jtx/vjournal/all-day.ics", null)
 
+
+    @Test
+    fun fromReader_should_set_recurid_values() {
+        val ical = """
+            BEGIN:VCALENDAR
+            PRODID:irrelevant
+            VERSION:2.0
+            BEGIN:VTODO
+            SUMMARY:Test Task (Exception)
+            DTSTAMP:20250228T032800Z
+            DUE;TZID=America/New_York:20250228T130000
+            RECURRENCE-ID;TZID=America/New_York:20250228T130000
+            UID:47a23c66-8c1a-4b44-bbe8-ebf33f8cf80f
+            END:VTODO
+            END:VCALENDAR
+        """.trimIndent()
+        val reader = StringReader(ical)
+
+        val iCalObjects = at.bitfire.ical4android.JtxICalObject.fromReader(reader, collection!!)
+
+        assertEquals(1, iCalObjects.size)
+        assertEquals("20250228T130000", iCalObjects.first().recurid)
+        assertEquals("America/New_York", iCalObjects.first().recuridTimezone)
+    }
+
+
     /**
      * This function takes a file asserts if the ICalendar is the same before and after processing with getIncomingIcal and getOutgoingIcal
      * @param filename the filename to be processed
@@ -837,13 +866,13 @@ class JtxICalObjectTest {
         //assertEquals(iCalIn.components[0].getProperty(Component.VTODO), iCalOut.components[0].getProperty(Component.VTODO))
 
         // there should only be one component for VJOURNAL and VTODO!
-        for(i in 0 until iCalIn.components.size)  {
+        for(i in 0 until iCalIn.componentList.all.size)  {
 
-            iCalIn.components[i].properties.forEach { inProp ->
+            iCalIn.componentList.all[i].propertyList.all.forEach { inProp ->
 
                 if(inProp.name == "DTSTAMP" || exceptions?.contains(inProp.name) == true)
                     return@forEach
-                val outProp = iCalOut.components[i].properties.getProperty<Property>(inProp.name)
+                val outProp = iCalOut.componentList.all[i].propertyList.getFirst<Property>(inProp.name)?.getOrNull()
                 assertEquals(inProp, outProp)
             }
         }
@@ -860,7 +889,7 @@ class JtxICalObjectTest {
         val stream = javaClass.classLoader!!.getResourceAsStream(filename)
         val reader = InputStreamReader(stream, Charsets.UTF_8)
 
-        val iCalIn = ICalendar.fromReader(reader)
+        val iCalIn = ICalendarParser().parse(reader)
 
         stream.close()
         reader.close()
@@ -884,7 +913,7 @@ class JtxICalObjectTest {
 
         iCalObject[0].write(os, testProdId)
 
-        val iCalOut = ICalendar.fromReader(os.toByteArray().inputStream().reader())
+        val iCalOut = ICalendarParser().parse(os.toByteArray().inputStream().reader())
 
         stream.close()
         reader.close()