add external event for goal completed

Author: Razeeman

core/src/main/java/com/example/util/simpletimetracker/core/utils/CoreConsts.kt

@@ -18,8 +18,10 @@ const val ACTION_EXTERNAL_CHANGE_RECORD = "com.razeeman.util.simpletimetracker.A
 
 const val EVENT_STARTED_ACTIVITY = "com.razeeman.util.simpletimetracker.EVENT_STARTED_ACTIVITY"
 const val EVENT_STOPPED_ACTIVITY = "com.razeeman.util.simpletimetracker.EVENT_STOPPED_ACTIVITY"
+const val EVENT_COMPLETED_GOAL = "com.razeeman.util.simpletimetracker.EVENT_COMPLETED_GOAL"
 
 const val EXTRA_ACTIVITY_NAME = "extra_activity_name"
+const val EXTRA_CATEGORY_NAME = "extra_category_name"
 const val EXTRA_RECORD_COMMENT = "extra_record_comment"
 const val EXTRA_RECORD_TAG_NAME = "extra_record_tag"
 const val EXTRA_RECORD_TYPE_NOTE = "extra_record_type_note"
@@ -28,4 +30,6 @@ const val EXTRA_RECORD_TIME_STARTED = "extra_record_time_started"
 const val EXTRA_RECORD_TIME_ENDED = "extra_record_time_ended"
 const val EXTRA_RECORD_COMMENT_MODE = "extra_record_comment_mode" // set, append, prefix
 const val EXTRA_FIND_RECORD_MODE = "extra_find_record_mode" // current_or_last, current, last
-const val EXTRA_FIND_RECORD_WITH_ACTIVITY_NAME = "extra_find_record_with_activity_name"
+const val EXTRA_FIND_RECORD_WITH_ACTIVITY_NAME = "extra_find_record_with_activity_name"
+const val EXTRA_GOAL_TYPE = "extra_goal_type" // duration, count
+const val EXTRA_GOAL_VALUE = "extra_goal_value"

domain/src/main/java/com/example/util/simpletimetracker/domain/notifications/interactor/ActivityStartedStoppedBroadcastInteractor.kt

@@ -1,5 +1,7 @@
 package com.example.util.simpletimetracker.domain.notifications.interactor
 
+import com.example.util.simpletimetracker.domain.recordType.model.RecordTypeGoal
+
 interface ActivityStartedStoppedBroadcastInteractor {
 
     suspend fun onActionActivityStarted(
@@ -13,4 +15,9 @@ interface ActivityStartedStoppedBroadcastInteractor {
         tagIds: List<Long>,
         comment: String,
     )
+
+    suspend fun onGoalReached(
+        idData: RecordTypeGoal.IdData,
+        goalType: RecordTypeGoal.Type?,
+    )
 }

domain/src/main/java/com/example/util/simpletimetracker/domain/notifications/model/ExternalEventGoalType.kt

@@ -0,0 +1,6 @@
+package com.example.util.simpletimetracker.domain.notifications.model
+
+enum class ExternalEventGoalType(val dataValue: String) {
+    DURATION("duration"),
+    COUNT("count"),
+}

features/feature_notification/src/main/java/com/example/util/simpletimetracker/feature_notification/external/ActivityStartedStoppedBroadcastInteractorImpl.kt

@@ -2,25 +2,35 @@ package com.example.util.simpletimetracker.feature_notification.external
 
 import android.content.Context
 import android.content.Intent
+import com.example.util.simpletimetracker.core.utils.EVENT_COMPLETED_GOAL
 import com.example.util.simpletimetracker.core.utils.EVENT_STARTED_ACTIVITY
 import com.example.util.simpletimetracker.core.utils.EVENT_STOPPED_ACTIVITY
 import com.example.util.simpletimetracker.core.utils.EXTRA_ACTIVITY_NAME
+import com.example.util.simpletimetracker.core.utils.EXTRA_CATEGORY_NAME
+import com.example.util.simpletimetracker.core.utils.EXTRA_GOAL_TYPE
+import com.example.util.simpletimetracker.core.utils.EXTRA_GOAL_VALUE
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_COMMENT
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TAG_NAME
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TYPE_ICON
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TYPE_NOTE
+import com.example.util.simpletimetracker.domain.category.interactor.CategoryInteractor
+import com.example.util.simpletimetracker.domain.category.model.Category
+import com.example.util.simpletimetracker.domain.extension.orZero
 import com.example.util.simpletimetracker.domain.notifications.interactor.ActivityStartedStoppedBroadcastInteractor
+import com.example.util.simpletimetracker.domain.notifications.model.ExternalEventGoalType
 import com.example.util.simpletimetracker.domain.prefs.interactor.PrefsInteractor
 import com.example.util.simpletimetracker.domain.recordTag.interactor.RecordTagInteractor
-import com.example.util.simpletimetracker.domain.recordType.interactor.RecordTypeInteractor
 import com.example.util.simpletimetracker.domain.recordTag.model.RecordTag
+import com.example.util.simpletimetracker.domain.recordType.interactor.RecordTypeInteractor
 import com.example.util.simpletimetracker.domain.recordType.model.RecordType
+import com.example.util.simpletimetracker.domain.recordType.model.RecordTypeGoal
 import dagger.hilt.android.qualifiers.ApplicationContext
 import javax.inject.Inject
 
 class ActivityStartedStoppedBroadcastInteractorImpl @Inject constructor(
     @ApplicationContext private val context: Context,
     private val recordTypeInteractor: RecordTypeInteractor,
+    private val categoryInteractor: CategoryInteractor,
     private val recordTagInteractor: RecordTagInteractor,
     private val prefsInteractor: PrefsInteractor,
 ) : ActivityStartedStoppedBroadcastInteractor {
@@ -61,6 +71,27 @@ class ActivityStartedStoppedBroadcastInteractorImpl @Inject constructor(
         )
     }
 
+    override suspend fun onGoalReached(
+        idData: RecordTypeGoal.IdData,
+        goalType: RecordTypeGoal.Type?,
+    ) {
+        if (!prefsInteractor.getAutomatedTrackingSendEvents()) return
+
+        val type = (idData as? RecordTypeGoal.IdData.Type)?.value
+            ?.let { getActivity(it) }
+        val category = (idData as? RecordTypeGoal.IdData.Category)?.value
+            ?.let { getCategory(it) }
+        if (type == null && category == null) return
+
+        sendGoalBroadcast(
+            activityName = type?.name.orEmpty(),
+            categoryName = category?.name.orEmpty(),
+            goalType = goalType,
+            note = type?.note.orEmpty(),
+            icon = type?.icon.orEmpty(),
+        )
+    }
+
     private fun sendBroadcast(
         actionString: String,
         activityName: String,
@@ -80,12 +111,43 @@ class ActivityStartedStoppedBroadcastInteractorImpl @Inject constructor(
         }.let(context::sendBroadcast)
     }
 
+    private fun sendGoalBroadcast(
+        activityName: String,
+        categoryName: String,
+        goalType: RecordTypeGoal.Type?,
+        note: String,
+        icon: String,
+    ) {
+        val extraGoalType = when (goalType) {
+            is RecordTypeGoal.Type.Duration -> ExternalEventGoalType.DURATION.dataValue
+            is RecordTypeGoal.Type.Count -> ExternalEventGoalType.COUNT.dataValue
+            null -> ""
+        }
+        val goalValue = goalType?.value.orZero()
+
+        Intent().apply {
+            action = EVENT_COMPLETED_GOAL
+            if (activityName.isNotEmpty()) putExtra(EXTRA_ACTIVITY_NAME, activityName)
+            if (categoryName.isNotEmpty()) putExtra(EXTRA_CATEGORY_NAME, categoryName)
+            if (extraGoalType.isNotEmpty()) putExtra(EXTRA_GOAL_TYPE, extraGoalType)
+            if (goalValue != 0L) putExtra(EXTRA_GOAL_VALUE, goalValue)
+            if (note.isNotEmpty()) putExtra(EXTRA_RECORD_TYPE_NOTE, note)
+            if (icon.isNotEmpty()) putExtra(EXTRA_RECORD_TYPE_ICON, icon)
+        }.let(context::sendBroadcast)
+    }
+
     private suspend fun getActivity(
         typeId: Long,
     ): RecordType? {
         return recordTypeInteractor.get(typeId)
     }
 
+    private suspend fun getCategory(
+        categoryId: Long,
+    ): Category? {
+        return categoryInteractor.get(categoryId)
+    }
+
     private suspend fun getTagNames(
         tagIds: List<Long>,
     ): List<String> {

features/feature_notification/src/main/java/com/example/util/simpletimetracker/feature_notification/goalTime/interactor/NotificationGoalCountInteractorImpl.kt

@@ -10,6 +10,7 @@ import com.example.util.simpletimetracker.domain.recordType.interactor.RecordTyp
 import com.example.util.simpletimetracker.domain.record.interactor.RunningRecordInteractor
 import com.example.util.simpletimetracker.domain.statistics.model.RangeLength
 import com.example.util.simpletimetracker.domain.category.model.RecordTypeCategory
+import com.example.util.simpletimetracker.domain.notifications.interactor.ActivityStartedStoppedBroadcastInteractor
 import com.example.util.simpletimetracker.domain.recordType.model.RecordTypeGoal
 import com.example.util.simpletimetracker.domain.recordType.model.RecordTypeGoal.Range
 import com.example.util.simpletimetracker.domain.recordType.model.RecordTypeGoal.Type
@@ -25,6 +26,7 @@ class NotificationGoalCountInteractorImpl @Inject constructor(
     private val notificationGoalParamsInteractor: NotificationGoalParamsInteractor,
     private val recordTypeCategoryInteractor: RecordTypeCategoryInteractor,
     private val filterGoalsByDayOfWeekInteractor: FilterGoalsByDayOfWeekInteractor,
+    private val activityStartedStoppedBroadcastInteractor: ActivityStartedStoppedBroadcastInteractor,
 ) : NotificationGoalCountInteractor {
 
     override suspend fun checkAndShow(typeId: Long) {
@@ -211,10 +213,17 @@ class NotificationGoalCountInteractorImpl @Inject constructor(
     }
 
     private suspend fun show(idData: RecordTypeGoal.IdData, goalRange: Range) {
-        notificationGoalParamsInteractor.execute(
+        val params = notificationGoalParamsInteractor.execute(
             idData = idData,
             range = goalRange,
             type = NotificationGoalParamsInteractor.Type.Count,
-        )?.let(manager::show)
+        )
+        params?.let(manager::show)
+        params?.let {
+            activityStartedStoppedBroadcastInteractor.onGoalReached(
+                idData = idData,
+                goalType = it.goalType,
+            )
+        }
     }
 }

features/feature_notification/src/main/java/com/example/util/simpletimetracker/feature_notification/goalTime/interactor/NotificationGoalParamsInteractor.kt

@@ -120,6 +120,7 @@ class NotificationGoalParamsInteractor @Inject constructor(
         return NotificationGoalTimeParams(
             idData = idData,
             goalRange = range,
+            goalType = goal?.type,
             icon = recordType?.icon
                 ?.let(iconMapper::mapIcon)
                 ?: RecordTypeIcon.Text(""),

features/feature_notification/src/main/java/com/example/util/simpletimetracker/feature_notification/goalTime/interactor/NotificationGoalTimeInteractorImpl.kt

@@ -11,6 +11,7 @@ import com.example.util.simpletimetracker.domain.recordType.interactor.RecordTyp
 import com.example.util.simpletimetracker.domain.record.interactor.RunningRecordInteractor
 import com.example.util.simpletimetracker.domain.statistics.model.RangeLength
 import com.example.util.simpletimetracker.domain.category.model.RecordTypeCategory
+import com.example.util.simpletimetracker.domain.notifications.interactor.ActivityStartedStoppedBroadcastInteractor
 import com.example.util.simpletimetracker.domain.recordType.model.RecordTypeGoal
 import com.example.util.simpletimetracker.domain.recordType.model.RecordTypeGoal.Range
 import com.example.util.simpletimetracker.domain.record.model.RunningRecord
@@ -43,6 +44,7 @@ class NotificationGoalTimeInteractorImpl @Inject constructor(
     private val notificationGoalParamsInteractor: NotificationGoalParamsInteractor,
     private val recordTypeCategoryInteractor: RecordTypeCategoryInteractor,
     private val filterGoalsByDayOfWeekInteractor: FilterGoalsByDayOfWeekInteractor,
+    private val activityStartedStoppedBroadcastInteractor: ActivityStartedStoppedBroadcastInteractor,
 ) : NotificationGoalTimeInteractor {
 
     override suspend fun checkAndReschedule(typeIds: List<Long>) {
@@ -71,11 +73,18 @@ class NotificationGoalTimeInteractorImpl @Inject constructor(
         idData: RecordTypeGoal.IdData,
         goalRange: Range,
     ) {
-        notificationGoalParamsInteractor.execute(
+        val params = notificationGoalParamsInteractor.execute(
             idData = idData,
             range = goalRange,
             type = NotificationGoalParamsInteractor.Type.Duration,
-        )?.let(manager::show)
+        )
+        params?.let(manager::show)
+        params?.let {
+            activityStartedStoppedBroadcastInteractor.onGoalReached(
+                idData = idData,
+                goalType = it.goalType,
+            )
+        }
     }
 
     private suspend fun checkAndRescheduleType(typeId: Long) {

features/feature_notification/src/main/java/com/example/util/simpletimetracker/feature_notification/goalTime/manager/NotificationGoalTimeParams.kt

@@ -7,6 +7,7 @@ import com.example.util.simpletimetracker.feature_views.viewData.RecordTypeIcon
 data class NotificationGoalTimeParams(
     val idData: RecordTypeGoal.IdData,
     val goalRange: RecordTypeGoal.Range,
+    val goalType: RecordTypeGoal.Type?,
     val icon: RecordTypeIcon,
     val color: Int,
     val text: String,

features/feature_settings/src/main/java/com/example/util/simpletimetracker/feature_settings/mapper/SettingsAutomatedTrackingMapper.kt

@@ -1,9 +1,14 @@
 package com.example.util.simpletimetracker.feature_settings.mapper
 
+import android.graphics.Typeface
 import android.text.SpannableString
 import android.text.SpannableStringBuilder
+import android.text.Spanned
+import android.text.style.ForegroundColorSpan
+import android.text.style.StyleSpan
 import com.example.util.simpletimetracker.core.extension.fromHtml
 import com.example.util.simpletimetracker.core.manager.ClipboardManager
+import com.example.util.simpletimetracker.core.mapper.ColorMapper
 import com.example.util.simpletimetracker.core.provider.ApplicationDataProvider
 import com.example.util.simpletimetracker.core.repo.ResourceRepo
 import com.example.util.simpletimetracker.core.utils.ACTION_EXTERNAL_ADD_RECORD
@@ -14,22 +19,29 @@ import com.example.util.simpletimetracker.core.utils.ACTION_EXTERNAL_STOP_ACTIVI
 import com.example.util.simpletimetracker.core.utils.ACTION_EXTERNAL_STOP_ALL_ACTIVITIES
 import com.example.util.simpletimetracker.core.utils.ACTION_EXTERNAL_STOP_LONGEST_ACTIVITY
 import com.example.util.simpletimetracker.core.utils.ACTION_EXTERNAL_STOP_SHORTEST_ACTIVITY
+import com.example.util.simpletimetracker.core.utils.EVENT_COMPLETED_GOAL
 import com.example.util.simpletimetracker.core.utils.EVENT_STARTED_ACTIVITY
 import com.example.util.simpletimetracker.core.utils.EVENT_STOPPED_ACTIVITY
 import com.example.util.simpletimetracker.core.utils.EXTRA_ACTIVITY_NAME
+import com.example.util.simpletimetracker.core.utils.EXTRA_CATEGORY_NAME
 import com.example.util.simpletimetracker.core.utils.EXTRA_FIND_RECORD_MODE
 import com.example.util.simpletimetracker.core.utils.EXTRA_FIND_RECORD_WITH_ACTIVITY_NAME
+import com.example.util.simpletimetracker.core.utils.EXTRA_GOAL_TYPE
+import com.example.util.simpletimetracker.core.utils.EXTRA_GOAL_VALUE
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_COMMENT
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_COMMENT_MODE
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TAG_NAME
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TIME_ENDED
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TIME_STARTED
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TYPE_ICON
 import com.example.util.simpletimetracker.core.utils.EXTRA_RECORD_TYPE_NOTE
+import com.example.util.simpletimetracker.domain.color.model.AppColor
 import com.example.util.simpletimetracker.domain.extension.indexesOf
 import com.example.util.simpletimetracker.domain.notifications.model.ExternalActionCommentMode
 import com.example.util.simpletimetracker.domain.notifications.model.ExternalActionFindRecordMode
+import com.example.util.simpletimetracker.domain.notifications.model.ExternalEventGoalType
 import com.example.util.simpletimetracker.feature_settings.R
+import com.example.util.simpletimetracker.feature_views.TextViewRoundedSpans
 import com.example.util.simpletimetracker.feature_views.extension.setClickableSpan
 import com.example.util.simpletimetracker.feature_views.extension.setImageSpan
 import com.example.util.simpletimetracker.feature_views.extension.toSpannableString
@@ -41,6 +53,7 @@ import javax.inject.Inject
 class SettingsAutomatedTrackingMapper @Inject constructor(
     private val resourceRepo: ResourceRepo,
     private val router: Router,
+    private val colorMapper: ColorMapper,
     private val clipboardManager: ClipboardManager,
     private val applicationDataProvider: ApplicationDataProvider,
 ) {
@@ -154,6 +167,18 @@ class SettingsAutomatedTrackingMapper @Inject constructor(
                     ),
                     optional = emptyList(),
                 ),
+                AvailableAction(
+                    action = EVENT_COMPLETED_GOAL,
+                    extras = listOf(
+                        EXTRA_ACTIVITY_NAME,
+                        EXTRA_CATEGORY_NAME,
+                        EXTRA_GOAL_TYPE,
+                        EXTRA_GOAL_VALUE,
+                        EXTRA_RECORD_TYPE_NOTE,
+                        EXTRA_RECORD_TYPE_ICON,
+                    ),
+                    optional = emptyList(),
+                ),
             ),
             isDarkTheme = isDarkTheme,
         )
@@ -195,18 +220,31 @@ class SettingsAutomatedTrackingMapper @Inject constructor(
                     description = resourceRepo.getString(R.string.settings_automated_tracking_find_with_activity),
                     values = emptyList(),
                 ),
+                ExtraDescription(
+                    extra = EXTRA_GOAL_TYPE,
+                    description = resourceRepo.getString(R.string.settings_automated_tracking_goal_type),
+                    values = ExternalEventGoalType.entries.map { it.dataValue },
+                ),
+                ExtraDescription(
+                    extra = EXTRA_GOAL_VALUE,
+                    description = resourceRepo.getString(R.string.settings_automated_tracking_goal_value),
+                    values = emptyList(),
+                )
             ),
         )
 
         val availableActionsHint = resourceRepo.getString(
             R.string.settings_automated_tracking_available_actions,
         ).uppercase()
+            .let { setHintSpans(it, isDarkTheme) }
         val availableEventsHint = resourceRepo.getString(
             R.string.settings_automated_tracking_available_events,
         ).uppercase()
+            .let { setHintSpans(it, isDarkTheme) }
         val extrasDescriptionsHint = resourceRepo.getString(
             R.string.settings_automated_tracking_extras_description,
         ).uppercase()
+            .let { setHintSpans(it, isDarkTheme) }
 
         val finalText = SpannableStringBuilder()
             .append(mainText).append("\n")
@@ -375,6 +413,30 @@ class SettingsAutomatedTrackingMapper @Inject constructor(
             .toSpannableString()
     }.getOrNull() ?: SpannableString("")
 
+    private fun setHintSpans(
+        text: String,
+        isDarkTheme: Boolean,
+    ): CharSequence {
+        val textColor = resourceRepo.getThemedAttr(
+            attrId = R.attr.appLightTextColor,
+            isDarkTheme = isDarkTheme,
+        )
+        val backgroundColor = resourceRepo.getThemedAttr(
+            attrId = R.attr.appInactiveColor,
+            isDarkTheme = isDarkTheme,
+        )
+        val spans = listOf(
+            ForegroundColorSpan(textColor),
+            StyleSpan(Typeface.BOLD),
+            TextViewRoundedSpans.MarkerSpan(backgroundColor),
+        )
+        return text.toSpannableString().apply {
+            for (span in spans) {
+                setSpan(span, 0, text.length, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE)
+            }
+        }
+    }
+
     private fun copyToClipboard(text: String) {
         clipboardManager.send(text)
         val message = resourceRepo.getString(R.string.copied_to_clipboard)

resources/src/main/res/values-ar/strings.xml

@@ -405,6 +405,8 @@
     <string name="settings_automated_tracking_find_record_mode">يختار السجل الذي تريد تغييره.</string>
     <string name="settings_automated_tracking_comment_mode">يختار كيفية تغيير تعليق السجل المحدد.</string>
     <string name="settings_automated_tracking_find_with_activity">بالإضافة إلى ذلك، يقوم بتحديد السجل حسب اسم النشاط، إذا كان هناك العديد من السجلات الحالية أو الأخيرة.</string>
+    <string name="settings_automated_tracking_goal_type">نوع الهدف.</string>
+    <string name="settings_automated_tracking_goal_value">قيمة الهدف، المدة بالثواني أو عدد السجلات.</string>
 
     <string name="settings_save_backup">حفظ نسخة احتياطية</string>
     <string name="settings_save_description">قبل الحفظ، تأكد من تثبيت أحدث إصدار من التطبيق لتجنب التعارضات.</string>