Skip to content

DmfsTaskList/DmfsTask: provide all fields for DAVx5 #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sunkup merged 15 commits into from
Nov 27, 2025
Merged

DmfsTaskList/DmfsTask: provide all fields for DAVx5 #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
9cd300d
Move companion object to end of class
sunkup Nov 11, 2025
523174e
Update DmfsTask constructor signature
sunkup Nov 11, 2025
51f421e
Add access level to DmfsTaskList and make it open
sunkup Nov 11, 2025
781a29a
Add methods to read and write sync state
sunkup Nov 11, 2025
b67f1f6
Make populateTask final
sunkup Nov 13, 2025
3f7e4ae
Make buildTask final
sunkup Nov 13, 2025
5242e50
Make remaining methods final
sunkup Nov 13, 2025
63ac7fe
Fix tests
sunkup Nov 13, 2025
28f0ff6
Add test
sunkup Nov 13, 2025
a910207
Add flags default value on null
sunkup Nov 18, 2025
d6263a3
Remove state to conversion
sunkup Nov 18, 2025
cb2126c
Hardcode UUID in TestTask
sunkup Nov 18, 2025
0edf623
Align constructor type
sunkup Nov 18, 2025
1df8405
Optimize imports
sunkup Nov 18, 2025
99102c6
Remove scheduleTag for tasks
sunkup Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions lib/src/androidTest/kotlin/at/bitfire/ical4android/DmfsTaskTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import android.content.ContentValues
import android.database.DatabaseUtils
import android.net.Uri
import android.provider.CalendarContract
import androidx.core.content.contentValuesOf
import at.bitfire.ical4android.impl.TestTask
import at.bitfire.ical4android.impl.TestTaskList
import at.bitfire.synctools.storage.LocalStorageException
Expand Down Expand Up @@ -100,6 +101,22 @@ class DmfsTaskTest(
}
}

@Test
fun testConstructor_ContentValues() {
val dmfsTask = DmfsTask(
taskList!!, contentValuesOf(
Tasks._ID to 123,
Tasks._SYNC_ID to "some-ical.ics",
DmfsTask.COLUMN_ETAG to "some-etag",
DmfsTask.COLUMN_FLAGS to 45
)
)
assertEquals(123L, dmfsTask.id)
assertEquals("some-ical.ics", dmfsTask.syncId)
assertEquals("some-etag", dmfsTask.eTag)
assertEquals(45, dmfsTask.flags)
}

@Test
fun testBuildTask_Sequence() {
buildTask {
Expand Down
3 changes: 1 addition & 2 deletions lib/src/androidTest/kotlin/at/bitfire/ical4android/impl/TestTask.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
package at.bitfire.ical4android.impl

import android.content.ContentValues

import at.bitfire.ical4android.DmfsTask
import at.bitfire.ical4android.DmfsTaskFactory
import at.bitfire.ical4android.DmfsTaskList
Expand All @@ -19,7 +18,7 @@ class TestTask: DmfsTask {
: super(taskList, values)

constructor(taskList: TestTaskList, task: Task)
: super(taskList, task)
: super(taskList, task, "6c2710c3-f82c-4dfa-8738-186b82c35c08", null, 0)

object Factory: DmfsTaskFactory<TestTask> {
override fun fromProvider(taskList: DmfsTaskList<DmfsTask>, values: ContentValues) =
Expand Down
82 changes: 50 additions & 32 deletions lib/src/main/kotlin/at/bitfire/ical4android/DmfsTask.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import android.content.ContentUris
import android.content.ContentValues
import android.net.Uri
import android.os.RemoteException
import androidx.annotation.CallSuper
import at.bitfire.synctools.storage.BatchOperation.CpoBuilder
import at.bitfire.synctools.storage.LocalStorageException
import at.bitfire.synctools.storage.TasksBatchOperation
Expand Down Expand Up @@ -65,26 +64,31 @@ import java.util.logging.Logger
* The SEQUENCE field is stored in [Tasks.SYNC_VERSION], so don't use [Tasks.SYNC_VERSION]
* for anything else.
*/
abstract class DmfsTask(
val taskList: DmfsTaskList<DmfsTask>
open class DmfsTask(
val taskList: DmfsTaskList<*>
) {

companion object {
const val UNKNOWN_PROPERTY_DATA = Properties.DATA0
}

protected val logger = Logger.getLogger(javaClass.name)
protected val tzRegistry by lazy { TimeZoneRegistryFactory.getInstance().createRegistry() }

var id: Long? = null
var syncId: String? = null
var eTag: String? = null
var flags: Int = 0


constructor(taskList: DmfsTaskList<DmfsTask>, values: ContentValues): this(taskList) {
constructor(taskList: DmfsTaskList<*>, values: ContentValues): this(taskList) {
id = values.getAsLong(Tasks._ID)
syncId = values.getAsString(Tasks._SYNC_ID)
eTag = values.getAsString(COLUMN_ETAG)
flags = values.getAsInteger(COLUMN_FLAGS) ?: 0
}

constructor(taskList: DmfsTaskList<DmfsTask>, task: Task): this(taskList) {
constructor(taskList: DmfsTaskList<*>, task: Task, syncId: String?, eTag: String?, flags: Int): this(taskList) {
this.task = task
this.syncId = syncId
this.eTag = eTag
this.flags = flags
}


Expand Down Expand Up @@ -156,8 +160,7 @@ abstract class DmfsTask(
throw FileNotFoundException("Couldn't find task #$id")
}

@CallSuper
protected open fun populateTask(values: ContentValues) {
protected fun populateTask(values: ContentValues) {
val task = requireNotNull(task)

task.uid = values.getAsString(Tasks._UID)
Expand Down Expand Up @@ -264,7 +267,7 @@ abstract class DmfsTask(
values.getAsString(Tasks.RRULE)?.let { task.rRule = RRule(it) }
}

protected open fun populateProperty(row: ContentValues) {
protected fun populateProperty(row: ContentValues) {
logger.log(Level.FINER, "Found property", row)

val task = requireNotNull(task)
Expand All @@ -284,7 +287,7 @@ abstract class DmfsTask(
}
}

protected open fun populateAlarm(row: ContentValues) {
protected fun populateAlarm(row: ContentValues) {
val task = requireNotNull(task)
val props = PropertyList<Property>()

Expand Down Expand Up @@ -312,7 +315,7 @@ abstract class DmfsTask(
task.alarms += VAlarm(props)
}

protected open fun populateRelatedTo(row: ContentValues) {
protected fun populateRelatedTo(row: ContentValues) {
val uid = row.getAsString(Relation.RELATED_UID)
if (uid == null) {
logger.warning("Task relation doesn't refer to same task list; can't be synchronized")
Expand Down Expand Up @@ -361,8 +364,8 @@ abstract class DmfsTask(

// remove associated rows which are added later again
batch += CpoBuilder
.newDelete(taskList.tasksPropertiesSyncUri())
.withSelection("${Properties.TASK_ID}=?", arrayOf(existingId.toString()))
.newDelete(taskList.tasksPropertiesSyncUri())
.withSelection("${Properties.TASK_ID}=?", arrayOf(existingId.toString()))

// update task
val uri = taskSyncURI()
Expand All @@ -377,15 +380,15 @@ abstract class DmfsTask(
return ContentUris.withAppendedId(Tasks.getContentUri(taskList.providerName.authority), existingId)
}

protected open fun insertProperties(batch: TasksBatchOperation, idxTask: Int?) {
protected fun insertProperties(batch: TasksBatchOperation, idxTask: Int?) {
insertAlarms(batch, idxTask)
insertCategories(batch, idxTask)
insertComment(batch, idxTask)
insertRelatedTo(batch, idxTask)
insertUnknownProperties(batch, idxTask)
}

protected open fun insertAlarms(batch: TasksBatchOperation, idxTask: Int?) {
protected fun insertAlarms(batch: TasksBatchOperation, idxTask: Int?) {
val task = requireNotNull(task)
for (alarm in task.alarms) {
val (alarmRef, minutes) = ICalendar.vAlarmToMin(
Expand Down Expand Up @@ -414,20 +417,20 @@ abstract class DmfsTask(
}

val builder = CpoBuilder
.newInsert(taskList.tasksPropertiesSyncUri())
.withTaskId(Alarm.TASK_ID, idxTask)
.withValue(Alarm.MIMETYPE, Alarm.CONTENT_ITEM_TYPE)
.withValue(Alarm.MINUTES_BEFORE, minutes)
.withValue(Alarm.REFERENCE, ref)
.withValue(Alarm.MESSAGE, alarm.description?.value ?: alarm.summary)
.withValue(Alarm.ALARM_TYPE, alarmType)
.newInsert(taskList.tasksPropertiesSyncUri())
.withTaskId(Alarm.TASK_ID, idxTask)
.withValue(Alarm.MIMETYPE, Alarm.CONTENT_ITEM_TYPE)
.withValue(Alarm.MINUTES_BEFORE, minutes)
.withValue(Alarm.REFERENCE, ref)
.withValue(Alarm.MESSAGE, alarm.description?.value ?: alarm.summary)
.withValue(Alarm.ALARM_TYPE, alarmType)

logger.log(Level.FINE, "Inserting alarm", builder.build())
batch += builder
}
}

protected open fun insertCategories(batch: TasksBatchOperation, idxTask: Int?) {
protected fun insertCategories(batch: TasksBatchOperation, idxTask: Int?) {
for (category in requireNotNull(task).categories) {
val builder = CpoBuilder.newInsert(taskList.tasksPropertiesSyncUri())
.withTaskId(Category.TASK_ID, idxTask)
Expand All @@ -438,7 +441,7 @@ abstract class DmfsTask(
}
}

protected open fun insertComment(batch: TasksBatchOperation, idxTask: Int?) {
protected fun insertComment(batch: TasksBatchOperation, idxTask: Int?) {
val comment = requireNotNull(task).comment ?: return
val builder = CpoBuilder.newInsert(taskList.tasksPropertiesSyncUri())
.withTaskId(Comment.TASK_ID, idxTask)
Expand All @@ -448,7 +451,7 @@ abstract class DmfsTask(
batch += builder
}

protected open fun insertRelatedTo(batch: TasksBatchOperation, idxTask: Int?) {
protected fun insertRelatedTo(batch: TasksBatchOperation, idxTask: Int?) {
for (relatedTo in requireNotNull(task).relatedTo) {
val relType = when ((relatedTo.getParameter(Parameter.RELTYPE) as RelType?)) {
RelType.CHILD ->
Expand All @@ -468,7 +471,7 @@ abstract class DmfsTask(
}
}

protected open fun insertUnknownProperties(batch: TasksBatchOperation, idxTask: Int?) {
protected fun insertUnknownProperties(batch: TasksBatchOperation, idxTask: Int?) {
for (property in requireNotNull(task).unknownProperties) {
if (property.value.length > UnknownProperty.MAX_UNKNOWN_PROPERTY_SIZE) {
logger.warning("Ignoring unknown property with ${property.value.length} octets (too long)")
Expand All @@ -488,8 +491,7 @@ abstract class DmfsTask(
return taskList.provider.delete(taskSyncURI(), null, null)
}

@CallSuper
protected open fun buildTask(builder: CpoBuilder, update: Boolean) {
protected fun buildTask(builder: CpoBuilder, update: Boolean) {
if (!update)
builder .withValue(Tasks.LIST_ID, taskList.id)

Expand All @@ -504,9 +506,14 @@ abstract class DmfsTask(
.withValue(Tasks.TASK_COLOR, task.color)
.withValue(Tasks.URL, task.url)

.withValue(Tasks._SYNC_ID, syncId)
.withValue(COLUMN_FLAGS, flags)
.withValue(COLUMN_ETAG, eTag)

// parent_id will be re-calculated when the relation row is inserted (if there is any)
.withValue(Tasks.PARENT_ID, null)

// organizer
task.organizer?.let { organizer ->
val uri = organizer.calAddress
val email = if (uri.scheme.equals("mailto", true))
Expand All @@ -519,6 +526,7 @@ abstract class DmfsTask(
logger.warning("Ignoring ORGANIZER without email address (not supported by Android)")
}

// Priority, classification
builder .withValue(Tasks.PRIORITY, task.priority)
.withValue(Tasks.CLASSIFICATION, when (task.classification) {
Clazz.PUBLIC -> Tasks.CLASSIFICATION_PUBLIC
Expand All @@ -532,6 +540,7 @@ abstract class DmfsTask(
.withValue(Tasks.COMPLETED_IS_ALLDAY, 0)
.withValue(Tasks.PERCENT_COMPLETE, task.percentComplete)

// Status
val status = when (task.status) {
Status.VTODO_IN_PROCESS -> Tasks.STATUS_IN_PROCESS
Status.VTODO_COMPLETED -> Tasks.STATUS_COMPLETED
Expand All @@ -540,6 +549,7 @@ abstract class DmfsTask(
}
builder.withValue(Tasks.STATUS, status)

// Time related
val allDay = task.isAllDay()
if (allDay) {
builder .withValue(Tasks.IS_ALLDAY, 1)
Expand All @@ -550,7 +560,6 @@ abstract class DmfsTask(
builder .withValue(Tasks.IS_ALLDAY, 0)
.withValue(Tasks.TZ, getTimeZone().id)
}

builder .withValue(Tasks.CREATED, task.createdAt)
.withValue(Tasks.LAST_MODIFIED, task.lastModified)

Expand All @@ -570,6 +579,7 @@ abstract class DmfsTask(
null
else
AndroidTimeUtils.recurrenceSetsToOpenTasksString(task.exDates, if (allDay) null else getTimeZone()))

logger.log(Level.FINE, "Built task object", builder.build())
}

Expand Down Expand Up @@ -606,4 +616,12 @@ abstract class DmfsTask(
return ContentUris.withAppendedId(taskList.tasksSyncUri(loadProperties), id)
}

companion object {
const val UNKNOWN_PROPERTY_DATA = Properties.DATA0

const val COLUMN_ETAG = Tasks.SYNC1

const val COLUMN_FLAGS = Tasks.SYNC2
}

}
Loading